ab-ecosystem-cpass 0.1.0

package/README.md

@@ -0,0 +1,88 @@
+# CRM SDK
+
+JavaScript/TypeScript client for the CRM gateway.
+
+## Install
+
+```bash
+npm install ab-ecosystem-cpass
+```
+
+## Usage
+
+```ts
+import { CrmClient } from 'ab-ecosystem-cpass';
+
+const crm = new CrmClient({
+  gatewayUrl: 'https://api.example.com',
+  clientId: 'tpc_xxxxxxxxxxxxxxxx',
+  authToken: '<ecosystem bearer token>',
+});
+
+const { data, nextCursor } = await crm.channels.list({ limit: 20 });
+const channel = await crm.channels.get('64ba85075f89cb9bbe30d749');
+```
+
+Every request carries `authorization: Bearer <authToken>`, `client-id` and `origin`.
+
+| Option | Required | Description |
+| --- | --- | --- |
+| `gatewayUrl` | yes | Base URL of the gateway. |
+| `clientId` | yes | Sent as the `client-id` header. |
+| `authToken` | yes | String, or a function returning one per request. |
+| `origin` | on Node | Sent as the `origin` header. Browsers set this themselves; on Node the gateway rejects the call without it. |
+| `fetch` | no | Custom fetch implementation. |
+| `timeoutMs` | no | Request timeout, default 30000. |
+
+### Node
+
+Browsers attach `Origin` automatically and ignore any override, so `origin` only
+needs setting outside the browser:
+
+```ts
+const crm = new CrmClient({
+  gatewayUrl: 'https://api.example.com',
+  clientId: 'tpc_xxxxxxxxxxxxxxxx',
+  authToken: process.env.CRM_TOKEN!,
+  origin: 'https://app.example.com', // must match the token's referer claim
+});
+```
+
+### Refreshing tokens
+
+Pass a function to resolve the token per request:
+
+```ts
+const crm = new CrmClient({
+  gatewayUrl: 'https://api.example.com',
+  clientId: 'tpc_xxxxxxxxxxxxxxxx',
+  authToken: () => auth.getAccessToken(),
+});
+```
+
+## Errors
+
+| Error | When |
+| --- | --- |
+| `CrmConfigError` | Thrown client-side, before any request, when `gatewayUrl`, `clientId` or `authToken` is missing or empty. |
+| `CrmApiError` | The gateway returned a non-2xx status. Carries `status`, `code`, `message` and `details`. |
+
+```ts
+import { CrmApiError, CrmConfigError } from 'ab-ecosystem-cpass';
+
+try {
+  await crm.channels.list();
+} catch (err) {
+  if (err instanceof CrmConfigError) console.error('bad SDK setup:', err.message);
+  else if (err instanceof CrmApiError) console.error(err.status, err.code, err.message);
+}
+```
+
+## API
+
+Only the channel module ships in this release.
+
+| Method | Endpoint |
+| --- | --- |
+| `crm.channels.list(query?)` | `GET /v1/channels` |
+| `crm.channels.get(id)` | `GET /v1/channels/:id` |

package/dist/client.d.ts

@@ -0,0 +1,6 @@
+import { type ClientOptions } from './http';
+import { Channels } from './resources/channels';
+export declare class CrmClient {
+    readonly channels: Channels;
+    constructor(options: ClientOptions);
+}

package/dist/client.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrmClient = void 0;
+const http_1 = require("./http");
+const channels_1 = require("./resources/channels");
+// Only the channel module ships in the MVP. The rest stay commented out until
+// their services are live behind the gateway.
+// import { Contacts } from './resources/contacts';
+// import { CustomFields } from './resources/custom-fields';
+// import { Segments } from './resources/segments';
+// import { CrmTriggers } from './resources/crm-triggers';
+// import { ContactImports } from './resources/contact-imports';
+// import { ContactExports } from './resources/contact-exports';
+// import { Webhooks } from './resources/webhooks';
+// import { Campaigns } from './resources/campaigns';
+// import { CampaignReports } from './resources/campaign-reports';
+// import { CampaignReportExports } from './resources/campaign-report-exports';
+class CrmClient {
+    channels;
+    // readonly contacts: Contacts;
+    // readonly customFields: CustomFields;
+    // readonly segments: Segments;
+    // readonly crmTriggers: CrmTriggers;
+    // readonly contactImports: ContactImports;
+    // readonly contactExports: ContactExports;
+    // readonly webhooks: Webhooks;
+    // readonly campaigns: Campaigns;
+    // readonly campaignReports: CampaignReports;
+    // readonly campaignReportExports: CampaignReportExports;
+    constructor(options) {
+        const http = new http_1.HttpClient(options);
+        this.channels = new channels_1.Channels(http);
+        // this.contacts = new Contacts(http);
+        // this.customFields = new CustomFields(http);
+        // this.segments = new Segments(http);
+        // this.crmTriggers = new CrmTriggers(http);
+        // this.contactImports = new ContactImports(http);
+        // this.contactExports = new ContactExports(http);
+        // this.webhooks = new Webhooks(http);
+        // this.campaigns = new Campaigns(http);
+        // this.campaignReports = new CampaignReports(http);
+        // this.campaignReportExports = new CampaignReportExports(http);
+    }
+}
+exports.CrmClient = CrmClient;
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAAA,iCAAwD;AACxD,mDAAgD;AAEhD,8EAA8E;AAC9E,8CAA8C;AAC9C,mDAAmD;AACnD,4DAA4D;AAC5D,mDAAmD;AACnD,0DAA0D;AAC1D,gEAAgE;AAChE,gEAAgE;AAChE,mDAAmD;AACnD,qDAAqD;AACrD,kEAAkE;AAClE,+EAA+E;AAE/E,MAAa,SAAS;IACX,QAAQ,CAAW;IAE5B,+BAA+B;IAC/B,uCAAuC;IACvC,+BAA+B;IAC/B,qCAAqC;IACrC,2CAA2C;IAC3C,2CAA2C;IAC3C,+BAA+B;IAC/B,iCAAiC;IACjC,6CAA6C;IAC7C,yDAAyD;IAEzD,YAAY,OAAsB;QAChC,MAAM,IAAI,GAAG,IAAI,iBAAU,CAAC,OAAO,CAAC,CAAC;QAErC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,CAAC;QAEnC,sCAAsC;QACtC,8CAA8C;QAC9C,sCAAsC;QACtC,4CAA4C;QAC5C,kDAAkD;QAClD,kDAAkD;QAClD,sCAAsC;QACtC,wCAAwC;QACxC,oDAAoD;QACpD,gEAAgE;IAClE,CAAC;CACF;AA9BD,8BA8BC"}

package/dist/errors.d.ts

@@ -0,0 +1,12 @@
+/** Thrown before a request leaves the client, for invalid or missing configuration. */
+export declare class CrmConfigError extends Error {
+    constructor(message: string);
+}
+/** Thrown when the gateway responds with a non-2xx status. */
+export declare class CrmApiError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly details?: unknown | undefined;
+    constructor(status: number, code: string, message: string, details?: unknown | undefined);
+    static fromResponse(response: Response): Promise<CrmApiError>;
+}

package/dist/errors.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrmApiError = exports.CrmConfigError = void 0;
+/** Thrown before a request leaves the client, for invalid or missing configuration. */
+class CrmConfigError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'CrmConfigError';
+    }
+}
+exports.CrmConfigError = CrmConfigError;
+/** Thrown when the gateway responds with a non-2xx status. */
+class CrmApiError extends Error {
+    status;
+    code;
+    details;
+    constructor(status, code, message, details) {
+        super(message);
+        this.status = status;
+        this.code = code;
+        this.details = details;
+        this.name = 'CrmApiError';
+    }
+    static async fromResponse(response) {
+        const body = (await response.json().catch(() => ({})));
+        return new CrmApiError(response.status, body.error?.code ?? 'unknown_error', body.error?.message ?? response.statusText, body.error?.details);
+    }
+}
+exports.CrmApiError = CrmApiError;
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA,uFAAuF;AACvF,MAAa,cAAe,SAAQ,KAAK;IACvC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;IAC/B,CAAC;CACF;AALD,wCAKC;AAED,8DAA8D;AAC9D,MAAa,WAAY,SAAQ,KAAK;IAEzB;IACA;IAEA;IAJX,YACW,MAAc,EACd,IAAY,EACrB,OAAe,EACN,OAAiB;QAE1B,KAAK,CAAC,OAAO,CAAC,CAAC;QALN,WAAM,GAAN,MAAM,CAAQ;QACd,SAAI,GAAJ,IAAI,CAAQ;QAEZ,YAAO,GAAP,OAAO,CAAU;QAG1B,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,QAAkB;QAC1C,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAEpD,CAAC;QAEF,OAAO,IAAI,WAAW,CACpB,QAAQ,CAAC,MAAM,EACf,IAAI,CAAC,KAAK,EAAE,IAAI,IAAI,eAAe,EACnC,IAAI,CAAC,KAAK,EAAE,OAAO,IAAI,QAAQ,CAAC,UAAU,EAC1C,IAAI,CAAC,KAAK,EAAE,OAAO,CACpB,CAAC;IACJ,CAAC;CACF;AAvBD,kCAuBC"}

package/dist/http.d.ts

@@ -0,0 +1,30 @@
+export interface ClientOptions {
+    /** Base URL of the CRM gateway, e.g. `https://api.example.com`. */
+    gatewayUrl: string;
+    /** Ecosystem client id; sent as the `client-id` header on every call. */
+    clientId: string;
+    /** Ecosystem bearer token, or a function resolving one per request. */
+    authToken: string | (() => string | Promise<string>);
+    /**
+     * Value for the `origin` header. Browsers set this themselves and ignore any
+     * override, so it is only needed on Node — where the gateway rejects the call
+     * without it. Defaults to the page origin when running in a browser.
+     */
+    origin?: string;
+    /** Custom fetch implementation; defaults to the global one. */
+    fetch?: typeof fetch;
+    /** Request timeout in milliseconds. Defaults to 30s. */
+    timeoutMs?: number;
+}
+export interface RequestInitOptions {
+    body?: unknown;
+    query?: Record<string, unknown>;
+}
+export declare class HttpClient {
+    private readonly options;
+    private readonly gatewayUrl;
+    constructor(options: ClientOptions);
+    /** Resolves the bearer token, failing here rather than sending an unauthenticated call. */
+    private token;
+    request<T>(method: string, path: string, init?: RequestInitOptions): Promise<T>;
+}

package/dist/http.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpClient = void 0;
+const errors_1 = require("./errors");
+const browserOrigin = () => typeof globalThis !== 'undefined' &&
+    typeof globalThis.location?.origin === 'string'
+    ? globalThis.location.origin
+    : undefined;
+class HttpClient {
+    options;
+    gatewayUrl;
+    constructor(options) {
+        this.options = options;
+        if (!options?.gatewayUrl?.trim())
+            throw new errors_1.CrmConfigError('gatewayUrl is required');
+        if (!options.clientId?.trim())
+            throw new errors_1.CrmConfigError('clientId is required');
+        if (typeof options.authToken === 'string' && !options.authToken.trim()) {
+            throw new errors_1.CrmConfigError('authToken is required');
+        }
+        if (options.authToken === undefined || options.authToken === null) {
+            throw new errors_1.CrmConfigError('authToken is required');
+        }
+        this.gatewayUrl = options.gatewayUrl.trim().replace(/\/+$/, '');
+    }
+    /** Resolves the bearer token, failing here rather than sending an unauthenticated call. */
+    async token() {
+        const token = typeof this.options.authToken === 'function'
+            ? await this.options.authToken()
+            : this.options.authToken;
+        if (typeof token !== 'string' || !token.trim()) {
+            throw new errors_1.CrmConfigError('authToken is required');
+        }
+        return token.trim();
+    }
+    async request(method, path, init = {}) {
+        const token = await this.token();
+        const url = new URL(`${this.gatewayUrl}${path}`);
+        for (const [key, value] of Object.entries(init.query ?? {})) {
+            if (value !== undefined && value !== null)
+                url.searchParams.set(key, String(value));
+        }
+        const origin = this.options.origin ?? browserOrigin();
+        const send = this.options.fetch ?? fetch;
+        const response = await send(url.toString(), {
+            method,
+            headers: {
+                'content-type': 'application/json',
+                authorization: `Bearer ${token}`,
+                'client-id': this.options.clientId.trim(),
+                ...(origin ? { origin } : {}),
+            },
+            body: init.body === undefined ? undefined : JSON.stringify(init.body),
+            signal: AbortSignal.timeout(this.options.timeoutMs ?? 30_000),
+        });
+        if (!response.ok)
+            throw await errors_1.CrmApiError.fromResponse(response);
+        return (response.status === 204 ? undefined : await response.json());
+    }
+}
+exports.HttpClient = HttpClient;
+//# sourceMappingURL=http.js.map

package/dist/http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":";;;AAAA,qCAAuD;AA0BvD,MAAM,aAAa,GAAG,GAAuB,EAAE,CAC7C,OAAO,UAAU,KAAK,WAAW;IACjC,OAAQ,UAAiD,CAAC,QAAQ,EAAE,MAAM,KAAK,QAAQ;IACrF,CAAC,CAAE,UAA0D,CAAC,QAAQ,CAAC,MAAM;IAC7E,CAAC,CAAC,SAAS,CAAC;AAEhB,MAAa,UAAU;IAGQ;IAFZ,UAAU,CAAS;IAEpC,YAA6B,OAAsB;QAAtB,YAAO,GAAP,OAAO,CAAe;QACjD,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE;YAAE,MAAM,IAAI,uBAAc,CAAC,wBAAwB,CAAC,CAAC;QACrF,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE;YAAE,MAAM,IAAI,uBAAc,CAAC,sBAAsB,CAAC,CAAC;QAChF,IAAI,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC;YACvE,MAAM,IAAI,uBAAc,CAAC,uBAAuB,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;YAClE,MAAM,IAAI,uBAAc,CAAC,uBAAuB,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,2FAA2F;IACnF,KAAK,CAAC,KAAK;QACjB,MAAM,KAAK,GACT,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,KAAK,UAAU;YAC1C,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YAChC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QAE7B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/C,MAAM,IAAI,uBAAc,CAAC,uBAAuB,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,OAAO,CAAI,MAAc,EAAE,IAAY,EAAE,OAA2B,EAAE;QAC1E,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAEjC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,GAAG,IAAI,EAAE,CAAC,CAAC;QACjD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;YAC5D,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;gBAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACtF,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,aAAa,EAAE,CAAC;QAEtD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YAC1C,MAAM;YACN,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,KAAK,EAAE;gBAChC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;gBACzC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC9B;YACD,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YACrE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,MAAM,CAAC;SAC9D,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,MAAM,oBAAW,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;IAC5E,CAAC;CACF;AAvDD,gCAuDC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './client';
+export * from './http';
+export * from './errors';
+export * from './types';
+export { Channels } from './resources/channels';

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Channels = void 0;
+__exportStar(require("./client"), exports);
+__exportStar(require("./http"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./types"), exports);
+var channels_1 = require("./resources/channels");
+Object.defineProperty(exports, "Channels", { enumerable: true, get: function () { return channels_1.Channels; } });
+//# 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,2CAAyB;AACzB,yCAAuB;AACvB,2CAAyB;AACzB,0CAAwB;AACxB,iDAAgD;AAAvC,oGAAA,QAAQ,OAAA"}

package/dist/resources/channels.d.ts

@@ -0,0 +1,10 @@
+import type { Channel, ChannelResponse, Page, PageQuery } from '../types';
+import type { HttpClient } from '../http';
+export declare class Channels {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** `GET /v1/channels` */
+    list(query?: Partial<PageQuery>): Promise<Page<Channel>>;
+    /** `GET /v1/channels/:id` */
+    get(id: string): Promise<ChannelResponse>;
+}

package/dist/resources/channels.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Channels = void 0;
+class Channels {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /** `GET /v1/channels` */
+    list(query = {}) {
+        return this.http.request('GET', '/v1/channels', { query });
+    }
+    /** `GET /v1/channels/:id` */
+    get(id) {
+        return this.http.request('GET', `/v1/channels/${encodeURIComponent(id)}`);
+    }
+}
+exports.Channels = Channels;
+//# sourceMappingURL=channels.js.map

package/dist/resources/channels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"channels.js","sourceRoot":"","sources":["../../src/resources/channels.ts"],"names":[],"mappings":";;;AAGA,MAAa,QAAQ;IACU;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD,yBAAyB;IACzB,IAAI,CAAC,QAA4B,EAAE;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgB,KAAK,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,6BAA6B;IAC7B,GAAG,CAAC,EAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAkB,KAAK,EAAE,gBAAgB,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC7F,CAAC;CAsBF;AAjCD,4BAiCC"}

package/dist/types.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Response shapes returned by the gateway. Declared here rather than imported
+ * from `@crm/contracts` so the published package has no private dependencies.
+ */
+export interface Page<T> {
+    data: T[];
+    nextCursor: string | null;
+}
+export interface PageQuery {
+    limit: number;
+    cursor?: string;
+}
+export interface ChannelMeta {
+    category: string;
+    provider: string;
+    support_template: boolean;
+    show_template: boolean;
+    bypass_webhook_verification: boolean;
+}
+export interface ChannelCloud {
+    instagram_id: string;
+    is_instagram_business_login: boolean;
+    waba_id: string;
+    business: string;
+    phone_number_id: string;
+    is_on_biz_app: boolean;
+    version: string;
+    auto_read_receipt: number;
+    upgrade_eligibility: boolean;
+    wa_biz_registration: 'pending' | 'completed';
+}
+export interface ChannelWallet {
+    free_tier?: number;
+    free_usage?: number;
+    /** `'NULL'` when the wallet is not visible to the caller. */
+    balance: number | 'NULL';
+    visible?: boolean;
+}
+export interface Channel {
+    id: string;
+    active: boolean;
+    ecom?: {
+        store_status: boolean;
+        store?: string;
+    };
+    basic_details: {
+        name: string;
+        color_code: string;
+        channel_identity: string;
+    };
+    meta: ChannelMeta;
+    billing: {
+        status: boolean;
+        currency: string;
+        visible: boolean;
+    };
+    wallet: ChannelWallet;
+    campaign_tps: number;
+    upgraded_webhook_listener: boolean;
+    cloud: ChannelCloud;
+    api_only: boolean;
+    crm_only: boolean;
+    mm_lite_enabled: boolean;
+    access_token: string;
+    [key: string]: unknown;
+}
+/** `GET /v1/channels/:id` wraps its payload, and returns `{}` when nothing matches. */
+export interface ChannelResponse {
+    data: Channel | Record<string, never>;
+}

package/dist/types.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Response shapes returned by the gateway. Declared here rather than imported
+ * from `@crm/contracts` so the published package has no private dependencies.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

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

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "ab-ecosystem-cpass",
+  "version": "0.1.0",
+  "description": "JavaScript/TypeScript SDK for the CPaaS CRM gateway",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "crm",
+    "cpaas",
+    "sdk",
+    "channels"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "prepublishOnly": "tsc -b"
+  }
+}