@atribu/node 0.1.0

package/dist/test/index.d.cts

@@ -0,0 +1,321 @@
+import { HttpHandler } from 'msw';
+import { A as AtribuWebhookEvent, h as WhatsAppMessageReceivedEvent, g as WhatsAppMessageDeliveryEvent, e as InstagramMessageReceivedEvent, c as InstagramMessageDeliveryEvent } from '../types-Dc6tIN_V.cjs';
+
+/**
+ * Drop-in MSW v2 handlers for testing against `@atribu/sdk`.
+ *
+ * Consumers add these to their MSW server setup:
+ *
+ *   import { setupServer } from "msw/node";
+ *   import { atribuMockHandlers } from "@atribu/sdk/test";
+ *
+ *   const server = setupServer(...atribuMockHandlers());
+ *
+ * Per-endpoint defaults reflect the wire shape the real Atribu API returns.
+ * Override any response by passing `MockOverrides` — the handler returns
+ * the override directly if `body` is provided; otherwise the default
+ * envelope from `responseFixtures`.
+ *
+ * MSW v2 is a peer dependency. Consumers must install it.
+ */
+
+interface EndpointOverride {
+    status?: number;
+    body?: unknown;
+}
+interface MockOverrides {
+    baseUrl?: string;
+    messages?: {
+        send?: EndpointOverride;
+    };
+    comments?: {
+        reply?: EndpointOverride;
+        privateReply?: EndpointOverride;
+    };
+    webhooks?: {
+        subscriptions?: {
+            list?: EndpointOverride;
+            create?: EndpointOverride;
+            update?: EndpointOverride;
+            delete?: EndpointOverride;
+            rotateSecret?: EndpointOverride;
+            test?: EndpointOverride;
+        };
+        deliveries?: {
+            replay?: EndpointOverride;
+        };
+    };
+    oauth?: {
+        token?: EndpointOverride;
+        revoke?: EndpointOverride;
+    };
+    admin?: {
+        create?: EndpointOverride;
+        update?: EndpointOverride;
+        suspend?: EndpointOverride;
+        rotateClientSecret?: EndpointOverride;
+        rotateJwtSecret?: EndpointOverride;
+    };
+}
+declare function atribuMockHandlers(overrides?: MockOverrides): HttpHandler[];
+
+/**
+ * Canned fixtures for testing against the Atribu SDK.
+ *
+ * Use these to drive your test cases with realistic event shapes, or pass
+ * `body` overrides into `atribuMockHandlers({...})` to customize responses.
+ */
+
+type DeepPartial<T> = T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+declare const sampleIds: {
+    readonly appId: "00000000-0000-0000-0000-000000000aaa";
+    readonly connectionId: "00000000-0000-0000-0000-000000000bbb";
+    readonly profileId: "00000000-0000-0000-0000-000000000ccc";
+    readonly workspaceId: "00000000-0000-0000-0000-000000000ddd";
+    readonly subscriptionId: "00000000-0000-0000-0000-000000000eee";
+};
+/** Canned webhook event fixtures — deep-merge any field you care about. */
+declare const eventFixtures: {
+    whatsappMessageReceived(overrides?: DeepPartial<WhatsAppMessageReceivedEvent>): WhatsAppMessageReceivedEvent;
+    whatsappMessageDelivery(overrides?: DeepPartial<WhatsAppMessageDeliveryEvent>): WhatsAppMessageDeliveryEvent;
+    instagramFbLoginMessage(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+    instagramPostback(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+    instagramIgLoginChange(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+    instagramMessageDelivery(overrides?: DeepPartial<InstagramMessageDeliveryEvent>): InstagramMessageDeliveryEvent;
+};
+/** Canned API response envelopes (matches what the server returns on 200). */
+declare const responseFixtures: {
+    messageSent(overrides?: {
+        provider_message_id?: string;
+        sent_at?: string;
+    }): {
+        data: {
+            connection_id: string;
+            channel: "whatsapp";
+            to: string;
+            provider_message_id: string;
+            sent_at: string;
+        };
+    };
+    commentReply(overrides?: {
+        provider_message_id?: string;
+    }): {
+        data: {
+            comment_id: string;
+            kind: "private_reply";
+            connection_id: string;
+            provider_message_id: string;
+            sent_at: string;
+        };
+        meta: {
+            profile_id: string;
+        };
+    };
+    subscriptionCreated(overrides?: {
+        secret?: string;
+        url?: string;
+    }): {
+        data: {
+            id: string;
+            app_id: string;
+            profile_id: string;
+            url: string;
+            events: string[];
+            providers: string[];
+            status: "active";
+            last_delivery_at: null;
+            consecutive_failures: number;
+            previous_secret_expires_at: null;
+            created_at: string;
+            updated_at: string;
+            secret: string;
+        };
+    };
+    subscriptionList(overrides?: {
+        items?: number;
+    }): {
+        data: {
+            id: string;
+            app_id: string;
+            profile_id: string;
+            url: string;
+            events: string[];
+            providers: string[];
+            status: "active";
+            last_delivery_at: null;
+            consecutive_failures: number;
+            previous_secret_expires_at: null;
+            created_at: string;
+            updated_at: string;
+        }[];
+        meta: {
+            profile_id: string;
+        };
+    };
+    rotatedSecret(overrides?: {
+        secret?: string;
+        graceDays?: number;
+    }): {
+        data: {
+            subscription_id: string;
+            secret: string;
+            grace_days: number;
+            previous_secret_expires_at: string;
+        };
+        meta: {
+            profile_id: string;
+        };
+    };
+    oauthTokenResponse(overrides?: {
+        accessToken?: string;
+        scope?: string;
+    }): {
+        access_token: string;
+        token_type: "bearer";
+        scope: string;
+        connection_id: string;
+        profile_id: string;
+        workspace_id: string;
+    };
+    oauthError(error?: string, description?: string): {
+        error: string;
+        error_description: string;
+    };
+    apiError(code: string, message: string, status: number): {
+        error: {
+            code: string;
+            message: string;
+            status: number;
+            request_id: string;
+        };
+    };
+};
+/** Combined export so consumers can `import { fixtures } from "@atribu/sdk/test"`. */
+declare const fixtures: {
+    ids: {
+        readonly appId: "00000000-0000-0000-0000-000000000aaa";
+        readonly connectionId: "00000000-0000-0000-0000-000000000bbb";
+        readonly profileId: "00000000-0000-0000-0000-000000000ccc";
+        readonly workspaceId: "00000000-0000-0000-0000-000000000ddd";
+        readonly subscriptionId: "00000000-0000-0000-0000-000000000eee";
+    };
+    events: {
+        whatsappMessageReceived(overrides?: DeepPartial<WhatsAppMessageReceivedEvent>): WhatsAppMessageReceivedEvent;
+        whatsappMessageDelivery(overrides?: DeepPartial<WhatsAppMessageDeliveryEvent>): WhatsAppMessageDeliveryEvent;
+        instagramFbLoginMessage(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+        instagramPostback(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+        instagramIgLoginChange(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+        instagramMessageDelivery(overrides?: DeepPartial<InstagramMessageDeliveryEvent>): InstagramMessageDeliveryEvent;
+    };
+    responses: {
+        messageSent(overrides?: {
+            provider_message_id?: string;
+            sent_at?: string;
+        }): {
+            data: {
+                connection_id: string;
+                channel: "whatsapp";
+                to: string;
+                provider_message_id: string;
+                sent_at: string;
+            };
+        };
+        commentReply(overrides?: {
+            provider_message_id?: string;
+        }): {
+            data: {
+                comment_id: string;
+                kind: "private_reply";
+                connection_id: string;
+                provider_message_id: string;
+                sent_at: string;
+            };
+            meta: {
+                profile_id: string;
+            };
+        };
+        subscriptionCreated(overrides?: {
+            secret?: string;
+            url?: string;
+        }): {
+            data: {
+                id: string;
+                app_id: string;
+                profile_id: string;
+                url: string;
+                events: string[];
+                providers: string[];
+                status: "active";
+                last_delivery_at: null;
+                consecutive_failures: number;
+                previous_secret_expires_at: null;
+                created_at: string;
+                updated_at: string;
+                secret: string;
+            };
+        };
+        subscriptionList(overrides?: {
+            items?: number;
+        }): {
+            data: {
+                id: string;
+                app_id: string;
+                profile_id: string;
+                url: string;
+                events: string[];
+                providers: string[];
+                status: "active";
+                last_delivery_at: null;
+                consecutive_failures: number;
+                previous_secret_expires_at: null;
+                created_at: string;
+                updated_at: string;
+            }[];
+            meta: {
+                profile_id: string;
+            };
+        };
+        rotatedSecret(overrides?: {
+            secret?: string;
+            graceDays?: number;
+        }): {
+            data: {
+                subscription_id: string;
+                secret: string;
+                grace_days: number;
+                previous_secret_expires_at: string;
+            };
+            meta: {
+                profile_id: string;
+            };
+        };
+        oauthTokenResponse(overrides?: {
+            accessToken?: string;
+            scope?: string;
+        }): {
+            access_token: string;
+            token_type: "bearer";
+            scope: string;
+            connection_id: string;
+            profile_id: string;
+            workspace_id: string;
+        };
+        oauthError(error?: string, description?: string): {
+            error: string;
+            error_description: string;
+        };
+        apiError(code: string, message: string, status: number): {
+            error: {
+                code: string;
+                message: string;
+                status: number;
+                request_id: string;
+            };
+        };
+    };
+};
+type FixtureWebhookEvent = AtribuWebhookEvent;
+
+export { type FixtureWebhookEvent, type MockOverrides, atribuMockHandlers, eventFixtures, fixtures, responseFixtures, sampleIds };

package/dist/test/index.d.ts

@@ -0,0 +1,321 @@
+import { HttpHandler } from 'msw';
+import { A as AtribuWebhookEvent, h as WhatsAppMessageReceivedEvent, g as WhatsAppMessageDeliveryEvent, e as InstagramMessageReceivedEvent, c as InstagramMessageDeliveryEvent } from '../types-Dc6tIN_V.js';
+
+/**
+ * Drop-in MSW v2 handlers for testing against `@atribu/sdk`.
+ *
+ * Consumers add these to their MSW server setup:
+ *
+ *   import { setupServer } from "msw/node";
+ *   import { atribuMockHandlers } from "@atribu/sdk/test";
+ *
+ *   const server = setupServer(...atribuMockHandlers());
+ *
+ * Per-endpoint defaults reflect the wire shape the real Atribu API returns.
+ * Override any response by passing `MockOverrides` — the handler returns
+ * the override directly if `body` is provided; otherwise the default
+ * envelope from `responseFixtures`.
+ *
+ * MSW v2 is a peer dependency. Consumers must install it.
+ */
+
+interface EndpointOverride {
+    status?: number;
+    body?: unknown;
+}
+interface MockOverrides {
+    baseUrl?: string;
+    messages?: {
+        send?: EndpointOverride;
+    };
+    comments?: {
+        reply?: EndpointOverride;
+        privateReply?: EndpointOverride;
+    };
+    webhooks?: {
+        subscriptions?: {
+            list?: EndpointOverride;
+            create?: EndpointOverride;
+            update?: EndpointOverride;
+            delete?: EndpointOverride;
+            rotateSecret?: EndpointOverride;
+            test?: EndpointOverride;
+        };
+        deliveries?: {
+            replay?: EndpointOverride;
+        };
+    };
+    oauth?: {
+        token?: EndpointOverride;
+        revoke?: EndpointOverride;
+    };
+    admin?: {
+        create?: EndpointOverride;
+        update?: EndpointOverride;
+        suspend?: EndpointOverride;
+        rotateClientSecret?: EndpointOverride;
+        rotateJwtSecret?: EndpointOverride;
+    };
+}
+declare function atribuMockHandlers(overrides?: MockOverrides): HttpHandler[];
+
+/**
+ * Canned fixtures for testing against the Atribu SDK.
+ *
+ * Use these to drive your test cases with realistic event shapes, or pass
+ * `body` overrides into `atribuMockHandlers({...})` to customize responses.
+ */
+
+type DeepPartial<T> = T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+declare const sampleIds: {
+    readonly appId: "00000000-0000-0000-0000-000000000aaa";
+    readonly connectionId: "00000000-0000-0000-0000-000000000bbb";
+    readonly profileId: "00000000-0000-0000-0000-000000000ccc";
+    readonly workspaceId: "00000000-0000-0000-0000-000000000ddd";
+    readonly subscriptionId: "00000000-0000-0000-0000-000000000eee";
+};
+/** Canned webhook event fixtures — deep-merge any field you care about. */
+declare const eventFixtures: {
+    whatsappMessageReceived(overrides?: DeepPartial<WhatsAppMessageReceivedEvent>): WhatsAppMessageReceivedEvent;
+    whatsappMessageDelivery(overrides?: DeepPartial<WhatsAppMessageDeliveryEvent>): WhatsAppMessageDeliveryEvent;
+    instagramFbLoginMessage(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+    instagramPostback(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+    instagramIgLoginChange(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+    instagramMessageDelivery(overrides?: DeepPartial<InstagramMessageDeliveryEvent>): InstagramMessageDeliveryEvent;
+};
+/** Canned API response envelopes (matches what the server returns on 200). */
+declare const responseFixtures: {
+    messageSent(overrides?: {
+        provider_message_id?: string;
+        sent_at?: string;
+    }): {
+        data: {
+            connection_id: string;
+            channel: "whatsapp";
+            to: string;
+            provider_message_id: string;
+            sent_at: string;
+        };
+    };
+    commentReply(overrides?: {
+        provider_message_id?: string;
+    }): {
+        data: {
+            comment_id: string;
+            kind: "private_reply";
+            connection_id: string;
+            provider_message_id: string;
+            sent_at: string;
+        };
+        meta: {
+            profile_id: string;
+        };
+    };
+    subscriptionCreated(overrides?: {
+        secret?: string;
+        url?: string;
+    }): {
+        data: {
+            id: string;
+            app_id: string;
+            profile_id: string;
+            url: string;
+            events: string[];
+            providers: string[];
+            status: "active";
+            last_delivery_at: null;
+            consecutive_failures: number;
+            previous_secret_expires_at: null;
+            created_at: string;
+            updated_at: string;
+            secret: string;
+        };
+    };
+    subscriptionList(overrides?: {
+        items?: number;
+    }): {
+        data: {
+            id: string;
+            app_id: string;
+            profile_id: string;
+            url: string;
+            events: string[];
+            providers: string[];
+            status: "active";
+            last_delivery_at: null;
+            consecutive_failures: number;
+            previous_secret_expires_at: null;
+            created_at: string;
+            updated_at: string;
+        }[];
+        meta: {
+            profile_id: string;
+        };
+    };
+    rotatedSecret(overrides?: {
+        secret?: string;
+        graceDays?: number;
+    }): {
+        data: {
+            subscription_id: string;
+            secret: string;
+            grace_days: number;
+            previous_secret_expires_at: string;
+        };
+        meta: {
+            profile_id: string;
+        };
+    };
+    oauthTokenResponse(overrides?: {
+        accessToken?: string;
+        scope?: string;
+    }): {
+        access_token: string;
+        token_type: "bearer";
+        scope: string;
+        connection_id: string;
+        profile_id: string;
+        workspace_id: string;
+    };
+    oauthError(error?: string, description?: string): {
+        error: string;
+        error_description: string;
+    };
+    apiError(code: string, message: string, status: number): {
+        error: {
+            code: string;
+            message: string;
+            status: number;
+            request_id: string;
+        };
+    };
+};
+/** Combined export so consumers can `import { fixtures } from "@atribu/sdk/test"`. */
+declare const fixtures: {
+    ids: {
+        readonly appId: "00000000-0000-0000-0000-000000000aaa";
+        readonly connectionId: "00000000-0000-0000-0000-000000000bbb";
+        readonly profileId: "00000000-0000-0000-0000-000000000ccc";
+        readonly workspaceId: "00000000-0000-0000-0000-000000000ddd";
+        readonly subscriptionId: "00000000-0000-0000-0000-000000000eee";
+    };
+    events: {
+        whatsappMessageReceived(overrides?: DeepPartial<WhatsAppMessageReceivedEvent>): WhatsAppMessageReceivedEvent;
+        whatsappMessageDelivery(overrides?: DeepPartial<WhatsAppMessageDeliveryEvent>): WhatsAppMessageDeliveryEvent;
+        instagramFbLoginMessage(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+        instagramPostback(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+        instagramIgLoginChange(overrides?: DeepPartial<InstagramMessageReceivedEvent>): InstagramMessageReceivedEvent;
+        instagramMessageDelivery(overrides?: DeepPartial<InstagramMessageDeliveryEvent>): InstagramMessageDeliveryEvent;
+    };
+    responses: {
+        messageSent(overrides?: {
+            provider_message_id?: string;
+            sent_at?: string;
+        }): {
+            data: {
+                connection_id: string;
+                channel: "whatsapp";
+                to: string;
+                provider_message_id: string;
+                sent_at: string;
+            };
+        };
+        commentReply(overrides?: {
+            provider_message_id?: string;
+        }): {
+            data: {
+                comment_id: string;
+                kind: "private_reply";
+                connection_id: string;
+                provider_message_id: string;
+                sent_at: string;
+            };
+            meta: {
+                profile_id: string;
+            };
+        };
+        subscriptionCreated(overrides?: {
+            secret?: string;
+            url?: string;
+        }): {
+            data: {
+                id: string;
+                app_id: string;
+                profile_id: string;
+                url: string;
+                events: string[];
+                providers: string[];
+                status: "active";
+                last_delivery_at: null;
+                consecutive_failures: number;
+                previous_secret_expires_at: null;
+                created_at: string;
+                updated_at: string;
+                secret: string;
+            };
+        };
+        subscriptionList(overrides?: {
+            items?: number;
+        }): {
+            data: {
+                id: string;
+                app_id: string;
+                profile_id: string;
+                url: string;
+                events: string[];
+                providers: string[];
+                status: "active";
+                last_delivery_at: null;
+                consecutive_failures: number;
+                previous_secret_expires_at: null;
+                created_at: string;
+                updated_at: string;
+            }[];
+            meta: {
+                profile_id: string;
+            };
+        };
+        rotatedSecret(overrides?: {
+            secret?: string;
+            graceDays?: number;
+        }): {
+            data: {
+                subscription_id: string;
+                secret: string;
+                grace_days: number;
+                previous_secret_expires_at: string;
+            };
+            meta: {
+                profile_id: string;
+            };
+        };
+        oauthTokenResponse(overrides?: {
+            accessToken?: string;
+            scope?: string;
+        }): {
+            access_token: string;
+            token_type: "bearer";
+            scope: string;
+            connection_id: string;
+            profile_id: string;
+            workspace_id: string;
+        };
+        oauthError(error?: string, description?: string): {
+            error: string;
+            error_description: string;
+        };
+        apiError(code: string, message: string, status: number): {
+            error: {
+                code: string;
+                message: string;
+                status: number;
+                request_id: string;
+            };
+        };
+    };
+};
+type FixtureWebhookEvent = AtribuWebhookEvent;
+
+export { type FixtureWebhookEvent, type MockOverrides, atribuMockHandlers, eventFixtures, fixtures, responseFixtures, sampleIds };