@codematic/opencdp 5.0.13

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export { CDPClient } from './client';
+export { CDPConfig, SendEmailRequestOptions, SendEmailRequestWithTemplate, SendEmailRequestWithoutTemplate, SendEmailRequest, SendPushRequest, SendSmsRequest, Identifiers } from './types';

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export { CDPClient } from './client';
+export { SendEmailRequest } from './types';

package/dist/esm/types.d.ts

@@ -0,0 +1,122 @@
+export interface CDPConfig {
+    /**
+     * API key for the CDP.
+     * This is required for authentication.
+     */
+    cdpApiKey: string;
+    /**
+     * Base URL for the OpenCDP API.
+     * If not provided, defaults to cdp server.
+     */
+    cdpEndpoint?: string;
+    /**
+     * Logger for OpenCDP operations.
+     * If not provided, defaults to console logging.
+     */
+    cdpLogger?: Logger;
+    /**
+     * Maximum number of concurrent OpenCDP requests.
+     * Default: 10. Hard-capped internally at 30.
+     */
+    maxConcurrentRequests?: number;
+    /**
+     * Request timeout in milliseconds.
+     * Default: 10000 (10 seconds).
+     */
+    timeout?: number;
+    /**
+     * Customer.io config for dual-write
+     */
+    customerIo?: {
+        siteId: string;
+        apiKey: string;
+        region?: 'us' | 'eu';
+    };
+    /**
+     * Optional: If true, sends events to both OpenCDP and Customer.io.
+     * This is useful for dual-write scenarios.
+     */
+    sendToCustomerIo?: boolean;
+    debug?: boolean;
+    /**
+     * Optional: Opt-in to throwing errors from the SDK.
+     * Default: false. When false, the SDK logs errors and resolves without throwing.
+     * When true, validation and request failures will throw so callers can catch them.
+     */
+    failOnException?: boolean;
+}
+export interface Logger {
+    debug(message: string): void;
+    error(message: string, context?: Record<string, any>): void;
+    warn(message: string): void;
+}
+export type Identifiers = {
+    id: string | number;
+} | {
+    email: string;
+};
+export type SendEmailRequestRequiredOptions = {
+    to: string;
+    identifiers: Identifiers;
+};
+export type SendEmailRequestOptionalOptions = Partial<{
+    message_data: Record<string, any>;
+    headers: Record<string, any>;
+    preheader: string;
+    reply_to: string;
+    bcc: string[];
+    cc: string[];
+    plaintext_body: string;
+    amp_body: string;
+    fake_bcc: boolean;
+    disable_message_retention: boolean;
+    send_to_unsubscribed: boolean;
+    tracked: boolean;
+    queue_draft: boolean;
+    send_at: number;
+    disable_css_preprocessing: boolean;
+    language: string;
+    attachments: Record<string, string>;
+}>;
+export type SendEmailRequestWithTemplate = SendEmailRequestRequiredOptions & SendEmailRequestOptionalOptions & {
+    transactional_message_id: string | number;
+};
+export type SendEmailRequestWithoutTemplate = SendEmailRequestRequiredOptions & SendEmailRequestOptionalOptions & {
+    body: string;
+    subject: string;
+    from: string;
+};
+export type SendEmailRequestOptions = SendEmailRequestWithTemplate | SendEmailRequestWithoutTemplate;
+export type Message = Partial<SendEmailRequestWithTemplate & SendEmailRequestWithoutTemplate> & {
+    attachments?: Record<string, string>;
+};
+export declare class SendEmailRequest {
+    message: Message;
+    constructor(opts: SendEmailRequestOptions);
+    attach(name: string, data: any, options?: {
+        encode?: boolean | undefined;
+    }): void;
+}
+export interface SendPushRequest {
+    identifiers: {
+        id?: string;
+        email?: string;
+        cdp_id?: string;
+    };
+    transactional_message_id: string | number;
+    title?: string;
+    body?: string;
+    message_data?: Record<string, any>;
+}
+export interface SendSmsRequest {
+    identifiers: {
+        id?: string;
+        email?: string;
+        cdp_id?: string;
+    };
+    transactional_message_id?: string | number;
+    to?: string;
+    from?: string;
+    body?: string;
+    message_data?: Record<string, any>;
+}

package/dist/esm/types.js

@@ -0,0 +1,36 @@
+export class SendEmailRequest {
+    constructor(opts) {
+        this.message = {
+            to: opts.to,
+            identifiers: opts.identifiers,
+            message_data: opts.message_data,
+            send_at: opts.send_at,
+            disable_message_retention: opts.disable_message_retention,
+            send_to_unsubscribed: opts.send_to_unsubscribed,
+            queue_draft: opts.queue_draft,
+            bcc: opts.bcc,
+            cc: opts.cc,
+            fake_bcc: opts.fake_bcc,
+            reply_to: opts.reply_to,
+            preheader: opts.preheader,
+            headers: opts.headers,
+            disable_css_preprocessing: opts.disable_css_preprocessing,
+            tracked: opts.tracked,
+            language: opts.language,
+            attachments: opts.attachments,
+            // Template-based fields
+            transactional_message_id: 'transactional_message_id' in opts ? opts.transactional_message_id : undefined,
+            body: 'body' in opts ? opts.body : undefined,
+            amp_body: opts.amp_body,
+            plaintext_body: opts.plaintext_body,
+            subject: 'subject' in opts ? opts.subject : undefined,
+            from: 'from' in opts ? opts.from : undefined
+        };
+    }
+    attach(name, data, options) {
+        if (!this.message.attachments) {
+            this.message.attachments = {};
+        }
+        this.message.attachments[name] = data;
+    }
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@codematic/opencdp",
+  "version": "5.0.13",
+  "description": "Codematic OpenCDP Node.js SDK",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/cjs/index.d.ts",
+  "homepage": "https://docs.opencdp.io/",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "axios": "^1.8.2",
+    "customerio-node": "^4.1.1",
+    "p-limit": "^3.1.0"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.2"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json",
+    "prepublishOnly": "npm run build && npm test",
+    "test": "jest"
+  }
+}
+