{"_id":"@adizen/events-hub-sdk","_rev":"5-68139c878d9f0363a6960c84ba81a789","name":"@adizen/events-hub-sdk","dist-tags":{"latest":"0.1.4"},"versions":{"0.1.1":{"name":"@adizen/events-hub-sdk","version":"0.1.1","keywords":["events","sdk","nestjs","event-driven","queues"],"license":"MIT","_id":"@adizen/events-hub-sdk@0.1.1","maintainers":[{"name":"tushar_","email":"tj@adizen.ai"}],"dist":{"shasum":"377be131cebc74fc5ea7e9d124e0f2e72526bbbd","tarball":"https://registry.npmjs.org/@adizen/events-hub-sdk/-/events-hub-sdk-0.1.1.tgz","fileCount":6,"integrity":"sha512-3GOsyEDz8KVsjQ3IX4rQdpsc9MRvi98IgYtOTFwUIlSn3WDPnoqTNuf8DTerAhT5qQ17fpKwlRmZxQODnqFSiQ==","signatures":[{"sig":"MEQCIE6OBgUsAXmwxoJTVZWmS/DROWva6WbP++Sk+B8tqTMaAiAhaY4TUABoh17MLFp77PRROFTL3qX5TRHZSNiCkIn94g==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":15639},"main":"dist/index.cjs","types":"dist/index.d.ts","module":"dist/index.mjs","gitHead":"d95a4aa42675ea1a9dad451c455a6d35389278be","scripts":{"build":"tsup src/index.ts --format cjs,esm --dts","clean":"rimraf dist","prepublishOnly":"npm run clean && npm run build"},"_npmUser":{"name":"tushar_","email":"tj@adizen.ai"},"_npmVersion":"10.9.2","description":"Official client SDK for triggering Events Hub workflows from any app","directories":{},"_nodeVersion":"22.16.0","dependencies":{"axios":"^1.6.7","@adizen/events-hub-types":"^0.1.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.1","rimraf":"^5.0.5","typescript":"^5.4.0"},"peerDependencies":{"typescript":">=5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/events-hub-sdk_0.1.1_1763286883485_0.26664387586881144","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@adizen/events-hub-sdk","version":"0.1.2","keywords":["events","sdk","nestjs","event-driven","queues"],"license":"MIT","_id":"@adizen/events-hub-sdk@0.1.2","maintainers":[{"name":"tushar_","email":"tj@adizen.ai"},{"name":"praharshsharma","email":"praharsh@adizen.ai"}],"dist":{"shasum":"ad160400c7e2b24dfb00254feeb0f02cd0231166","tarball":"https://registry.npmjs.org/@adizen/events-hub-sdk/-/events-hub-sdk-0.1.2.tgz","fileCount":6,"integrity":"sha512-ilqrLcVBSvAhwXYiuX33x6mfdwBbrQjfFigXqB9EkHbP71fcxCrczjwZ/xxvOcp1Abi2AHIaUKnKEL0FQWNpZQ==","signatures":[{"sig":"MEQCIEjqQ+19c5aIREWnZacSc1jLvVypqYvGrB6L/rsoFhtqAiAjzWdJdHe9I26MMEAX4dnoBmt5EiUMX7Dd8yj55PV19Q==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":15638},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/index.mjs","gitHead":"4b2fd602eb719a5c439217537ad4c580bf6160f3","scripts":{"build":"tsup src/index.ts --format cjs,esm --dts","clean":"rimraf dist","prepublishOnly":"npm run clean && npm run build"},"_npmUser":{"name":"tushar_","email":"tj@adizen.ai"},"_npmVersion":"10.9.2","description":"Official client SDK for triggering Events Hub workflows from any app","directories":{},"_nodeVersion":"22.16.0","dependencies":{"axios":"^1.6.7","@adizen/events-hub-types":"^0.1.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.1","rimraf":"^5.0.5","typescript":"^5.4.0"},"peerDependencies":{"typescript":">=5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/events-hub-sdk_0.1.2_1763373655883_0.21861123794435144","host":"s3://npm-registry-packages-npm-production"}},"0.1.3":{"name":"@adizen/events-hub-sdk","version":"0.1.3","keywords":["events","sdk","nestjs","event-driven","queues"],"license":"MIT","_id":"@adizen/events-hub-sdk@0.1.3","maintainers":[{"name":"tushar_","email":"tj@adizen.ai"},{"name":"praharshsharma","email":"praharsh@adizen.ai"}],"dist":{"shasum":"50c4457155601fce6b1b7cca03b1e73b5e76667b","tarball":"https://registry.npmjs.org/@adizen/events-hub-sdk/-/events-hub-sdk-0.1.3.tgz","fileCount":6,"integrity":"sha512-X676mL+NeNwPnW8YwHYTX+rbfSZxuquOfXNlGIMR0hXbeBkN3iFzIqoudbD9guUue51sPy8LHPYQ1SrzxcGrPg==","signatures":[{"sig":"MEQCIGwIPB/WdiIrLKYL7hSoeEPHv/ARUJ/UOAB1HT43SBFGAiA0PAcI7mckk66KyGTxXvKKB06rvayY9Uybm776yG9iDA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":13376},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/index.mjs","gitHead":"8759392234567df7738b015909f23c5ef6b7f9d0","scripts":{"build":"tsup src/index.ts --format cjs,esm --dts","clean":"rimraf dist","prepublishOnly":"npm run clean && npm run build"},"_npmUser":{"name":"tushar_","email":"tj@adizen.ai"},"_npmVersion":"10.9.2","description":"Official client SDK for triggering Events Hub workflows from any app","directories":{},"_nodeVersion":"22.16.0","dependencies":{"axios":"^1.6.7","@adizen/events-hub-types":"^0.1.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.1","rimraf":"^5.0.5","typescript":"^5.4.0"},"peerDependencies":{"typescript":">=5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/events-hub-sdk_0.1.3_1764242421412_0.18075011151675446","host":"s3://npm-registry-packages-npm-production"}},"0.1.4":{"name":"@adizen/events-hub-sdk","version":"0.1.4","description":"Official client SDK for triggering Events Hub workflows from any app","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","scripts":{"build":"tsup src/index.ts --format cjs,esm --dts","clean":"rimraf dist","prepublishOnly":"npm run clean && npm run build"},"keywords":["events","sdk","nestjs","event-driven","queues"],"license":"MIT","dependencies":{"@adizen/events-hub-types":"^0.1.1","axios":"^1.6.7"},"devDependencies":{"rimraf":"^5.0.5","tsup":"^8.0.1","typescript":"^5.4.0"},"peerDependencies":{"typescript":">=5.0.0"},"publishConfig":{"access":"public"},"_id":"@adizen/events-hub-sdk@0.1.4","gitHead":"8759392234567df7738b015909f23c5ef6b7f9d0","_nodeVersion":"22.16.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-UVcM+JzXVYcgZmpDjgd/+aWkakHX4l470IInIrGVfvRlb3Sj1QcYYRTCs3ePJ6nFt/GiNzIqx18hQKeKkgaI2Q==","shasum":"781deb4658502075e325e6e24214dbc76c2aaa9e","tarball":"https://registry.npmjs.org/@adizen/events-hub-sdk/-/events-hub-sdk-0.1.4.tgz","fileCount":6,"unpackedSize":13376,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCICTZyGCnlRZLymdUn1ZROV31K6nWHJkbMNUkxy9LISUJAiASSIVDipLwGaVQ+67+P+0G/+skVqbqMXTYCeAvMc7VGw=="}]},"_npmUser":{"name":"tushar_","email":"tj@adizen.ai"},"directories":{},"maintainers":[{"name":"tushar_","email":"tj@adizen.ai"},{"name":"praharshsharma","email":"praharsh@adizen.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/events-hub-sdk_0.1.4_1764249490897_0.4800531637553751"},"_hasShrinkwrap":false}},"time":{"created":"2025-11-16T09:54:43.345Z","modified":"2025-11-27T13:18:11.297Z","0.1.1":"2025-11-16T09:54:43.703Z","0.1.2":"2025-11-17T10:00:56.063Z","0.1.3":"2025-11-27T11:20:21.595Z","0.1.4":"2025-11-27T13:18:11.101Z"},"license":"MIT","keywords":["events","sdk","nestjs","event-driven","queues"],"description":"Official client SDK for triggering Events Hub workflows from any app","maintainers":[{"name":"tushar_","email":"tj@adizen.ai"},{"name":"praharshsharma","email":"praharsh@adizen.ai"}],"readme":"# @events-hub/sdk\n\nOfficial TypeScript/JavaScript client for sending events to an Events Hub deployment. It wraps the HTTP API exposed by the NestJS backend so any application can trigger events with type safety and consistent headers.\n\n## Installation\n\n```bash\nnpm install @events-hub/sdk\n# or\nyarn add @events-hub/sdk\n```\n\n## Quick start\n\n```ts\nimport { EventsHubClient } from \"@events-hub/sdk\";\n\nconst client = new EventsHubClient({\n  baseUrl: \"https://events.mycompany.com\",\n  apiKey: process.env.EVENTS_HUB_KEY,\n});\n\nawait client.trigger(\"user.signed_up\", {\n  userId: \"123\",\n  email: \"dev@example.com\",\n});\n```\n\n### Options\n\n```ts\nawait client.trigger(\"order.created\", orderPayload, {\n  userId: \"user-42\",\n  metadata: { source: \"checkout\" },\n});\n\nawait client.triggerDelayed(\"invoice.send\", invoicePayload, 10_000);\n\nawait client.triggerScheduled(\n  \"reports.daily\",\n  { workspaceId: \"acme\" },\n  \"0 8 * * *\",\n);\n\nawait client.triggerBatch([\n  { name: \"user.signup\", data: { email: \"a@b.com\" } },\n  { name: \"user.signup\", data: { email: \"c@d.com\" } },\n]);\n```\n\n### Handler metadata\n\nNeed to introspect a handler’s schema? Fetch it through the admin API:\n\n```ts\nconst handler = await client.getHandler(\"user-signup\");\nconsole.log(handler.expectedPayloadSchema);\n```\n\n## Configuration\n\n| Option          | Description                                                     |\n| --------------- | --------------------------------------------------------------- |\n| `baseUrl`       | Base URL to your deployed backend (required).                   |\n| `apiKey`        | Optional API key. Sent using the `x-api-key` header by default. |\n| `apiKeyHeader`  | Override header name if your backend expects a custom header.   |\n| `timeoutMs`     | Axios request timeout (defaults to 10s).                         |\n| `defaultHeaders`| Any extra headers to include in every request.                  |\n\n## Publishing\n\nUse the provided script:\n\n```bash\nnpm run build --workspace=@events-hub/sdk\nnpm publish --workspace=@events-hub/sdk --access public\n```\n\nRemember to update the version in `package.json` before publishing. Since this package depends on `@events-hub/types`, publish the types package first if you make changes to shared definitions.\n\n","readmeFilename":"README.md"}