{"_id":"@axacraft-global/zeitcore-sdk","_rev":"6-ff44ae393b1c407a21541332bb4b907c","name":"@axacraft-global/zeitcore-sdk","dist-tags":{"latest":"1.4.0"},"versions":{"1.0.0":{"name":"@axacraft-global/zeitcore-sdk","version":"1.0.0","license":"ISC","_id":"@axacraft-global/zeitcore-sdk@1.0.0","maintainers":[{"name":"axacraft-global","email":"kelly@axacraft.com"}],"dist":{"shasum":"e3125694f7c30cacbe55d42ba62eb8cb4345fb47","tarball":"https://registry.npmjs.org/@axacraft-global/zeitcore-sdk/-/zeitcore-sdk-1.0.0.tgz","fileCount":20,"integrity":"sha512-rzn38qEmZuRRczQB6VXZ4l+veSniM0RVhUmDfsR/vI70Odn6DZ8k3jA3FmEPNtpDMmZIWQy5lOzBiBxRiWIJJw==","signatures":[{"sig":"MEYCIQCh+ZyO1LZdHmwxxEB8KQYXtNgAzPE7gm1/EEs/5CxYLgIhAL2qgBGZtkv1wvWtXgj3izpp6pCCPlkZWAVtc6C0KiKY","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26824},"main":"dist/index.js","types":"dist/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"exports":{".":{"import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"333662a58361f56791a4a95a45c86b447a328375","scripts":{"build":"rimraf -rf dist && tsc -p tsconfig.json"},"_npmUser":{"name":"axacraft-global","email":"kelly@axacraft.com"},"_npmVersion":"10.2.3","description":"Zeitcore SDK is a lightweight JavaScript/TypeScript library designed to interact with Zeitcore's API. It provides an easy-to-use interface for managing rulesets and handling API requests.","directories":{},"_nodeVersion":"20.10.0","dependencies":{"rimraf":"5.0.5"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"commitizen":"4.3.1","typescript":"4.7.4","@types/node":"22.7.8","cz-conventional-changelog":"3.3.0"},"_npmOperationalInternal":{"tmp":"tmp/zeitcore-sdk_1.0.0_1729870935048_0.9053983082694366","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"@axacraft-global/zeitcore-sdk","version":"1.1.0","license":"ISC","_id":"@axacraft-global/zeitcore-sdk@1.1.0","maintainers":[{"name":"axacraft-global","email":"kelly@axacraft.com"}],"dist":{"shasum":"ccfc51dc3fa8e5eaa9713eae3ff6ab0a4635bcb4","tarball":"https://registry.npmjs.org/@axacraft-global/zeitcore-sdk/-/zeitcore-sdk-1.1.0.tgz","fileCount":20,"integrity":"sha512-1UKhqF105ZqFGeVB8vvP+blI3htwpjoSmy6KuRs4LASnb5JhQjBPPXxeOvNUGNLgP/kHM5aUThisx0hQU/Hwfg==","signatures":[{"sig":"MEQCIAKAN5CpSWgFCEvG/DDD8mzAt/j7vuhwRPM0DWy8zODOAiBhUFC6zmHcMgPTktq53O1rCxSOKUd/e6gljjojjPVabQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26824},"main":"dist/index.js","types":"dist/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"exports":{".":{"import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"595c568b04475bed168495f7ccdf7e666469fe9c","scripts":{"build":"rimraf -rf dist && tsc -p tsconfig.json"},"_npmUser":{"name":"axacraft-global","email":"kelly@axacraft.com"},"_npmVersion":"10.2.3","description":"Zeitcore SDK is a lightweight JavaScript/TypeScript library designed to interact with Zeitcore's API. It provides an easy-to-use interface for managing rulesets and handling API requests.","directories":{},"_nodeVersion":"20.10.0","dependencies":{"rimraf":"5.0.5"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"commitizen":"4.3.1","typescript":"4.7.4","@types/node":"22.7.8","cz-conventional-changelog":"3.3.0"},"_npmOperationalInternal":{"tmp":"tmp/zeitcore-sdk_1.1.0_1730137434532_0.2503534108893277","host":"s3://npm-registry-packages"}},"1.2.0":{"name":"@axacraft-global/zeitcore-sdk","version":"1.2.0","license":"ISC","_id":"@axacraft-global/zeitcore-sdk@1.2.0","maintainers":[{"name":"axacraft-global","email":"kelly@axacraft.com"}],"dist":{"shasum":"d67795fa0aac221c12172f6c9ec6a857e53431f9","tarball":"https://registry.npmjs.org/@axacraft-global/zeitcore-sdk/-/zeitcore-sdk-1.2.0.tgz","fileCount":20,"integrity":"sha512-OoKAcSW94+tkXSWlLiBwgqEGHtBdMFmfJY1zTk3ddY9GJB85zYakzgd488QBOVRrqZw5GNyQyHBN3BVeGkcpbA==","signatures":[{"sig":"MEYCIQDCIxmLDY6OX8ZBmiR7+vzfudl111o5M8nQT+PqICMNXQIhAJwqlLeWf6YjGm6G3BgdBIK79CDPs4dSUcpC9EsX6dvK","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26370},"main":"dist/index.js","types":"dist/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"exports":{".":{"import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"595c568b04475bed168495f7ccdf7e666469fe9c","scripts":{"build":"rimraf -rf dist && tsc -p tsconfig.json"},"_npmUser":{"name":"axacraft-global","email":"kelly@axacraft.com"},"_npmVersion":"10.2.3","description":"Zeitcore SDK is a lightweight JavaScript/TypeScript library designed to interact with Zeitcore's API. It provides an easy-to-use interface for managing rulesets and handling API requests.","directories":{},"_nodeVersion":"20.10.0","dependencies":{"rimraf":"5.0.5"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"commitizen":"4.3.1","typescript":"4.7.4","@types/node":"22.7.8","cz-conventional-changelog":"3.3.0"},"_npmOperationalInternal":{"tmp":"tmp/zeitcore-sdk_1.2.0_1730196512341_0.9992796387642926","host":"s3://npm-registry-packages"}},"1.3.0":{"name":"@axacraft-global/zeitcore-sdk","version":"1.3.0","license":"ISC","_id":"@axacraft-global/zeitcore-sdk@1.3.0","maintainers":[{"name":"axacraft-global","email":"kelly@axacraft.com"}],"dist":{"shasum":"df8f1a76580c01b61ec5022b11ac02eb5369232f","tarball":"https://registry.npmjs.org/@axacraft-global/zeitcore-sdk/-/zeitcore-sdk-1.3.0.tgz","fileCount":20,"integrity":"sha512-GBrd/usCtS67vfTCQPbuPM96EFTLhVR21Q57r7+5JAb6dmoA4p9+wXOadqkwPNOkkfwS0kucT6DNtX9JNGdxJQ==","signatures":[{"sig":"MEQCIE47rh0qpM49ZIquBCUq155yIh5ecDcdFuJuv7/z2VNSAiA+rlCWITsH3LZnnm/E8hZ3OLnofb9Dk/zxSKyorreChA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26370},"main":"dist/index.js","types":"dist/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"exports":{".":{"import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"c5ca1e2738d894a0380090d731c92c61ce6d9164","scripts":{"build":"rimraf -rf dist && tsc -p tsconfig.json"},"_npmUser":{"name":"axacraft-global","email":"kelly@axacraft.com"},"_npmVersion":"10.2.3","description":"Zeitcore SDK is a lightweight JavaScript/TypeScript library designed to interact with Zeitcore's API. It provides an easy-to-use interface for managing rulesets and handling API requests.","directories":{},"_nodeVersion":"20.10.0","dependencies":{"rimraf":"5.0.5"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"commitizen":"4.3.1","typescript":"4.7.4","@types/node":"22.7.8","cz-conventional-changelog":"3.3.0"},"_npmOperationalInternal":{"tmp":"tmp/zeitcore-sdk_1.3.0_1730731638232_0.8500142358985174","host":"s3://npm-registry-packages"}},"1.3.1":{"name":"@axacraft-global/zeitcore-sdk","version":"1.3.1","license":"ISC","_id":"@axacraft-global/zeitcore-sdk@1.3.1","maintainers":[{"name":"axacraft-global","email":"kelly@axacraft.com"}],"dist":{"shasum":"17f2a3697e68ea796bfff5e214e571ac0a0983e4","tarball":"https://registry.npmjs.org/@axacraft-global/zeitcore-sdk/-/zeitcore-sdk-1.3.1.tgz","fileCount":20,"integrity":"sha512-P/yqHtNXmBe/Mz3mkOQ2GSMLn2CMhsivAUivaHpptofJX9sZLQpd65jxlsr8chcFnjmyGdH7+MpqThQ5aMt5WA==","signatures":[{"sig":"MEUCIFKw/87GtUhBENVjeCsHPyUyYVtkspHz1E3PdWGyvHSsAiEAkpyDVvK97RiYhqGj/vu42uX0ozYgkRVcm88IkekUP1g=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26370},"main":"dist/index.js","types":"dist/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"exports":{".":{"import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"bb9ef6e2cb03631f1e0a64d59a180ba2f2326482","scripts":{"build":"rimraf -rf dist && tsc -p tsconfig.json"},"_npmUser":{"name":"axacraft-global","email":"kelly@axacraft.com"},"_npmVersion":"10.2.3","description":"Zeitcore SDK is a lightweight JavaScript/TypeScript library designed to interact with Zeitcore's API. It provides an easy-to-use interface for managing rulesets and handling API requests.","directories":{},"_nodeVersion":"20.10.0","dependencies":{"rimraf":"5.0.5"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"commitizen":"4.3.1","typescript":"4.7.4","@types/node":"22.7.8","cz-conventional-changelog":"3.3.0"},"_npmOperationalInternal":{"tmp":"tmp/zeitcore-sdk_1.3.1_1730798234551_0.7472173658156951","host":"s3://npm-registry-packages"}},"1.3.2":{"name":"@axacraft-global/zeitcore-sdk","version":"1.3.2","license":"ISC","_id":"@axacraft-global/zeitcore-sdk@1.3.2","maintainers":[{"name":"axacraft-global","email":"kelly@axacraft.com"}],"dist":{"shasum":"580d98e2de96b46f0bc686f593f96b6a186e3868","tarball":"https://registry.npmjs.org/@axacraft-global/zeitcore-sdk/-/zeitcore-sdk-1.3.2.tgz","fileCount":20,"integrity":"sha512-WEuNcD9vhpH9hvVlcFV9QfTb6SkkkwzZfhRhye35a4aqmPRvZ2C9uvOSw5HCFyPUt+aeL95vwk1xai4y2xTatw==","signatures":[{"sig":"MEUCIDzikmWzdqFsLiTzKliwPOuL155ZzSdAbc8ux7EN3uowAiEAzCfCSvKSBDdCJVNJGelV5iH+pLolZdTejI41ow+oY5Q=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26372},"main":"dist/index.js","types":"dist/index.d.ts","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"exports":{".":{"import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"bb9ef6e2cb03631f1e0a64d59a180ba2f2326482","scripts":{"build":"rimraf -rf dist && tsc -p tsconfig.json"},"_npmUser":{"name":"axacraft-global","email":"kelly@axacraft.com"},"_npmVersion":"10.2.3","description":"Zeitcore SDK is a lightweight JavaScript/TypeScript library designed to interact with Zeitcore's API. It provides an easy-to-use interface for managing rulesets and handling API requests.","directories":{},"_nodeVersion":"20.10.0","dependencies":{"rimraf":"5.0.5"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"commitizen":"4.3.1","typescript":"4.7.4","@types/node":"22.7.8","cz-conventional-changelog":"3.3.0"},"_npmOperationalInternal":{"tmp":"tmp/zeitcore-sdk_1.3.2_1730798360961_0.2639077039443607","host":"s3://npm-registry-packages"}},"1.4.0":{"name":"@axacraft-global/zeitcore-sdk","description":"Zeitcore SDK is a lightweight JavaScript/TypeScript library designed to interact with Zeitcore's API. It provides an easy-to-use interface for managing rulesets and handling API requests.","version":"1.4.0","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"rimraf -rf dist && tsc -p tsconfig.json","package":"npm run build && npm publish"},"devDependencies":{"@types/node":"22.7.8","commitizen":"4.3.1","cz-conventional-changelog":"3.3.0","typescript":"4.7.4"},"license":"ISC","config":{"commitizen":{"path":"./node_modules/cz-conventional-changelog"}},"dependencies":{"rimraf":"5.0.5"},"publishConfig":{"access":"public"},"exports":{".":{"import":"./dist/index.js","require":"./dist/index.js"}},"_id":"@axacraft-global/zeitcore-sdk@1.4.0","gitHead":"97233fb91065038a5da6ecb3e210b524fe068bda","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-f34B2v6CZnrQZD+tJ9P3T4PQUXriHOuIAHzsuLu+z9vtA85tjL1QOX//yBBmYICOd2tnNaxX+6CCQVH364V7TA==","shasum":"994d98de8ffb0de72bbfa5d24094a3fbb2a9324e","tarball":"https://registry.npmjs.org/@axacraft-global/zeitcore-sdk/-/zeitcore-sdk-1.4.0.tgz","fileCount":20,"unpackedSize":26800,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD1/tgFnfF3dvN7YT3oZJbFuz/vx4HZrdNK/sBMKFNb5wIgHS+t1jhDQ6V0P7Bi6T0c4JxbkiDzLSaz0Fe4PN6yUHw="}]},"_npmUser":{"name":"axacraft-global","email":"kelly@axacraft.com"},"directories":{},"maintainers":[{"name":"axacraft-global","email":"kelly@axacraft.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zeitcore-sdk_1.4.0_1732278513416_0.4249415326466257"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-25T15:42:14.920Z","modified":"2024-11-22T12:28:33.778Z","1.0.0":"2024-10-25T15:42:15.235Z","1.1.0":"2024-10-28T17:43:54.724Z","1.2.0":"2024-10-29T10:08:32.526Z","1.3.0":"2024-11-04T14:47:18.415Z","1.3.1":"2024-11-05T09:17:14.958Z","1.3.2":"2024-11-05T09:19:21.135Z","1.4.0":"2024-11-22T12:28:33.583Z"},"license":"ISC","description":"Zeitcore SDK is a lightweight JavaScript/TypeScript library designed to interact with Zeitcore's API. It provides an easy-to-use interface for managing rulesets and handling API requests.","maintainers":[{"name":"axacraft-global","email":"kelly@axacraft.com"}],"readme":"\n# Zeitcore SDK\n\nZeitcore SDK is a lightweight JavaScript/TypeScript library designed to interact with Zeitcore's API. It provides an easy-to-use interface for managing rulesets and handling API requests.\n\n## Installation\n\nTo install the SDK, you can use npm:\n\n```bash\nnpm install @axacraft-global/zeitcore-sdk\n```\n\n## Usage\n\n### Initialization\n\nTo start using the SDK, you need to initialize it with your configuration options:\n\n```ts\nimport { ZeitcoreSdk } from '@axacraft-global/zeitcore-sdk';\n\nconst sdk = ZeitcoreSdk.init({\n    url: 'https://your-api-url.com',\n    apiKey: 'your-api-key'\n});\n```\n\n### Rulesets\n\nThe `Rulesets` module allows you to retrieve and list rulesets from the Zeitcore API.\n\n#### Retrieve a Ruleset\n\n```ts\nconst ruleset = await sdk.rulesets.retrieve(123, {\n    ip: '192.168.1.1',\n    customerId: 'customer123',\n    clientId: 'client456'\n});\n```\n\n#### List Rulesets\n\n```ts\nconst rulesets = await sdk.rulesets.list([123, 456, 789], {\n    ip: '192.168.1.1',\n    customerId: 'customer123',\n    clientId: 'client456'\n});\n```\n\n## API Reference\n\n### `ZeitcoreSdk`\n\n#### `init(options: IMainConfig): ZeitcoreSdk`\n\nInitializes the SDK with the provided configuration.\n\n- `options` (required): Configuration object.\n  - `url`: API base URL.\n  - `apiKey`: Your API key.\n  - `analyticsUrl`: (https://analytics.yourservice.com).\n  - `trackerId`: Your Tracker id.\n\n### `Rulesets`\n\nThe `Rulesets` class handles operations related to rulesets.\n\n#### `retrieve(id: number | string, options: IGetRulesetConfig): Promise<any>`\n\nRetrieves a specific ruleset by ID.\n\n- `id`: Ruleset ID (number or string).\n- `options`: Optional configuration.\n  - `ip`: Customer IP address.\n  - `customerId`: Customer ID.\n  - `clientId`: Client ID.\n\n#### `list(ids: number[] | string[], options: IGetRulesetConfig): Promise<any>`\n\nLists multiple rulesets by their IDs.\n\n- `ids`: Array of ruleset IDs (number or string).\n- `options`: Optional configuration.\n  - `ip`: Customer IP address.\n  - `customerId`: Customer ID.\n  - `clientId`: Client ID.\n\n### `Rulesets Analytics`\n\nThe `Ruleset Analytics` class provides various methods to collect analytics events, such as when a recommendation is viewed, clicked, added to the cart, or purchased.\n\n### `Collecting Analytics`\nTo track analytics events, use the following methods:\n\n#### `Viewed Recommendation`\n  ```ts\n  await sdk.rulesets.analytics.viewed({\n      rulesetId: 123,\n      customerId: 'customer-id',\n      sessionId: 'session-id',\n  });\n  ```\n\n#### `Clicked Recommendation`\n  ```ts\n  await sdk.rulesets.analytics.viewed({\n      rulesetId: 123,\n      customerId: 'customer-id',\n  });\n  ```\n\n#### `Added to Cart`\n  ```ts\n  await sdk.rulesets.analytics.addedToCart({\n      rulesetId: 123,\n      productId: 'product-id',\n      variantId: 'variant-id',\n  });\n  ```","readmeFilename":"README.md"}