@omnistreams/sdk 0.1.0

package/dist/generated/openapi.js

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};
+//# sourceMappingURL=openapi.js.map

package/dist/generated/openapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.js","sourceRoot":"","sources":["../../src/generated/openapi.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Official TypeScript SDK for the OmniStream API.
+ *
+ * @example
+ * ```ts
+ * import { OmnistreamClient } from "@omnistreams/sdk";
+ *
+ * const client = new OmnistreamClient({
+ *   apiKey: process.env.OMNISTREAM_API_KEY!,
+ *   baseUrl: "https://your-omnistream-host",
+ * });
+ *
+ * const open = await client.conversations.list({ status: "open" });
+ * for await (const contact of client.paginate<Contact>("/api/contacts")) {
+ *   console.log(contact.name);
+ * }
+ * ```
+ */
+export { OmnistreamClient, buildQueryString, generateIdempotencyKey, } from "./client.js";
+export type { OmnistreamClientOptions, RequestOptions, Query, Conversation, Contact, Message, MessageListResponse, WaTemplate, ApiKey, SendMessageRequest, CreateApiKeyRequest, ApiKeyCreateResponse, ConversationStatus, } from "./client.js";
+export { OmnistreamError, OmnistreamApiError, OmnistreamNetworkError, } from "./errors.js";
+export { verifyWebhookSignature, verifyWebhookSignatureWithRotation, } from "./webhooks.js";
+/** The full generated OpenAPI type tree (paths, components, schemas). */
+export type { paths, components } from "./generated/openapi.js";

package/dist/index.js

@@ -0,0 +1,22 @@
+/**
+ * Official TypeScript SDK for the OmniStream API.
+ *
+ * @example
+ * ```ts
+ * import { OmnistreamClient } from "@omnistreams/sdk";
+ *
+ * const client = new OmnistreamClient({
+ *   apiKey: process.env.OMNISTREAM_API_KEY!,
+ *   baseUrl: "https://your-omnistream-host",
+ * });
+ *
+ * const open = await client.conversations.list({ status: "open" });
+ * for await (const contact of client.paginate<Contact>("/api/contacts")) {
+ *   console.log(contact.name);
+ * }
+ * ```
+ */
+export { OmnistreamClient, buildQueryString, generateIdempotencyKey, } from "./client.js";
+export { OmnistreamError, OmnistreamApiError, OmnistreamNetworkError, } from "./errors.js";
+export { verifyWebhookSignature, verifyWebhookSignatureWithRotation, } from "./webhooks.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAiBrB,OAAO,EACL,eAAe,EACf,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,sBAAsB,EACtB,kCAAkC,GACnC,MAAM,eAAe,CAAC"}

package/dist/webhooks.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Helpers for verifying OmniStream outgoing-webhook signatures.
+ *
+ * The gateway signs each webhook payload with HMAC-SHA256 over the raw JSON
+ * body and sends the hex digest in the `X-Omnistream-Signature` header. During
+ * a secret rotation it may also send `X-Omnistream-Signature-Previous` signed
+ * with the old secret — verify against either.
+ *
+ * Implemented with Web Crypto so it runs unchanged on Node 18+, browsers and
+ * edge runtimes.
+ */
+/**
+ * Verify that `signatureHex` is a valid HMAC-SHA256 signature of `payload`
+ * under `secret`. Comparison is constant-time.
+ *
+ * @param payload - the exact raw request body bytes as received (do not re-serialize).
+ * @param signatureHex - hex digest from the `X-Omnistream-Signature` header.
+ * @param secret - the webhook signing secret.
+ */
+export declare function verifyWebhookSignature(payload: string, signatureHex: string, secret: string): Promise<boolean>;
+/**
+ * Verify a payload against the current signature and, optionally, a previous
+ * one sent during secret rotation. Returns true if either matches.
+ */
+export declare function verifyWebhookSignatureWithRotation(payload: string, secret: string, signatures: {
+    current?: string | null;
+    previous?: string | null;
+}): Promise<boolean>;

package/dist/webhooks.js

@@ -0,0 +1,54 @@
+/**
+ * Helpers for verifying OmniStream outgoing-webhook signatures.
+ *
+ * The gateway signs each webhook payload with HMAC-SHA256 over the raw JSON
+ * body and sends the hex digest in the `X-Omnistream-Signature` header. During
+ * a secret rotation it may also send `X-Omnistream-Signature-Previous` signed
+ * with the old secret — verify against either.
+ *
+ * Implemented with Web Crypto so it runs unchanged on Node 18+, browsers and
+ * edge runtimes.
+ */
+/**
+ * Verify that `signatureHex` is a valid HMAC-SHA256 signature of `payload`
+ * under `secret`. Comparison is constant-time.
+ *
+ * @param payload - the exact raw request body bytes as received (do not re-serialize).
+ * @param signatureHex - hex digest from the `X-Omnistream-Signature` header.
+ * @param secret - the webhook signing secret.
+ */
+export async function verifyWebhookSignature(payload, signatureHex, secret) {
+    const encoder = new TextEncoder();
+    const key = await crypto.subtle.importKey("raw", encoder.encode(secret), { name: "HMAC", hash: "SHA-256" }, false, ["sign"]);
+    const digest = await crypto.subtle.sign("HMAC", key, encoder.encode(payload));
+    const expected = bufferToHex(digest);
+    return timingSafeEqualHex(expected, signatureHex.trim().toLowerCase());
+}
+/**
+ * Verify a payload against the current signature and, optionally, a previous
+ * one sent during secret rotation. Returns true if either matches.
+ */
+export async function verifyWebhookSignatureWithRotation(payload, secret, signatures) {
+    const candidates = [signatures.current, signatures.previous].filter((s) => typeof s === "string" && s.length > 0);
+    for (const sig of candidates) {
+        if (await verifyWebhookSignature(payload, sig, secret))
+            return true;
+    }
+    return false;
+}
+function bufferToHex(buffer) {
+    return Array.from(new Uint8Array(buffer))
+        .map((b) => b.toString(16).padStart(2, "0"))
+        .join("");
+}
+/** Constant-time comparison of two equal-purpose hex strings. */
+function timingSafeEqualHex(a, b) {
+    if (a.length !== b.length)
+        return false;
+    let mismatch = 0;
+    for (let i = 0; i < a.length; i++) {
+        mismatch |= a.charCodeAt(i) ^ b.charCodeAt(i);
+    }
+    return mismatch === 0;
+}
+//# sourceMappingURL=webhooks.js.map

package/dist/webhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../src/webhooks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAe,EACf,YAAoB,EACpB,MAAc;IAEd,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CACvC,KAAK,EACL,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EACtB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,EACjC,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;IACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9E,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IACrC,OAAO,kBAAkB,CAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;AACzE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kCAAkC,CACtD,OAAe,EACf,MAAc,EACd,UAAiE;IAEjE,MAAM,UAAU,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CACjE,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAC1D,CAAC;IACF,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC7B,IAAI,MAAM,sBAAsB,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC;YAAE,OAAO,IAAI,CAAC;IACtE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,WAAW,CAAC,MAAmB;IACtC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;SACtC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;SAC3C,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,iEAAiE;AACjE,SAAS,kBAAkB,CAAC,CAAS,EAAE,CAAS;IAC9C,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACxC,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,QAAQ,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,QAAQ,KAAK,CAAC,CAAC;AACxB,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@omnistreams/sdk",
+  "version": "0.1.0",
+  "description": "Official TypeScript SDK for the OmniStream omnichannel CRM API — typed client with auth, pagination, retries, idempotency and webhook signature verification.",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "generate": "openapi-typescript ../../docs/openapi.yaml -o src/generated/openapi.ts",
+    "build": "tsc -p tsconfig.json",
+    "prepublishOnly": "npm run build",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "openapi-typescript": "^7.9.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.6.0",
+    "vitest": "^3.2.0"
+  }
+}