@timbenniks/contentstack-platform-sdk 0.1.0

package/dist/server/webhooks/index.d.cts

@@ -0,0 +1,230 @@
+/**
+ * Webhook event type system for Contentstack.
+ *
+ * The raw payload has `module` and `event` as separate fields.
+ * We compute a `type` field as `"${module}.${event}"` for discriminated union dispatch.
+ */
+interface WebhookHandlerConfig {
+    secret: string;
+}
+interface BaseWebhookEvent {
+    type: string;
+    module: string;
+    event: string;
+    api_key: string;
+    data: Record<string, unknown>;
+    triggered_at: string;
+}
+interface EntryPublishEvent {
+    type: "entry.publish";
+    module: "entry";
+    event: "publish";
+    api_key: string;
+    data: {
+        entry: {
+            uid: string;
+            title: string;
+        };
+        content_type: {
+            uid: string;
+        };
+        environment: {
+            name: string;
+        };
+        locale: string;
+    };
+    triggered_at: string;
+}
+interface EntryUnpublishEvent {
+    type: "entry.unpublish";
+    module: "entry";
+    event: "unpublish";
+    api_key: string;
+    data: {
+        entry: {
+            uid: string;
+            title: string;
+        };
+        content_type: {
+            uid: string;
+        };
+        environment: {
+            name: string;
+        };
+        locale: string;
+    };
+    triggered_at: string;
+}
+interface EntryUpdateEvent {
+    type: "entry.update";
+    module: "entry";
+    event: "update";
+    api_key: string;
+    data: {
+        entry: {
+            uid: string;
+            title: string;
+        };
+        content_type: {
+            uid: string;
+        };
+    };
+    triggered_at: string;
+}
+interface EntryCreateEvent {
+    type: "entry.create";
+    module: "entry";
+    event: "create";
+    api_key: string;
+    data: {
+        entry: {
+            uid: string;
+            title: string;
+        };
+        content_type: {
+            uid: string;
+        };
+    };
+    triggered_at: string;
+}
+interface EntryDeleteEvent {
+    type: "entry.delete";
+    module: "entry";
+    event: "delete";
+    api_key: string;
+    data: {
+        entry: {
+            uid: string;
+        };
+        content_type: {
+            uid: string;
+        };
+    };
+    triggered_at: string;
+}
+interface AssetPublishEvent {
+    type: "asset.publish";
+    module: "asset";
+    event: "publish";
+    api_key: string;
+    data: {
+        asset: {
+            uid: string;
+            filename: string;
+        };
+        environment: {
+            name: string;
+        };
+    };
+    triggered_at: string;
+}
+interface AssetUnpublishEvent {
+    type: "asset.unpublish";
+    module: "asset";
+    event: "unpublish";
+    api_key: string;
+    data: {
+        asset: {
+            uid: string;
+            filename: string;
+        };
+        environment: {
+            name: string;
+        };
+    };
+    triggered_at: string;
+}
+interface AssetDeleteEvent {
+    type: "asset.delete";
+    module: "asset";
+    event: "delete";
+    api_key: string;
+    data: {
+        asset: {
+            uid: string;
+        };
+    };
+    triggered_at: string;
+}
+interface ContentTypeCreateEvent {
+    type: "content_type.create";
+    module: "content_type";
+    event: "create";
+    api_key: string;
+    data: {
+        content_type: {
+            uid: string;
+            title: string;
+        };
+    };
+    triggered_at: string;
+}
+interface ContentTypeUpdateEvent {
+    type: "content_type.update";
+    module: "content_type";
+    event: "update";
+    api_key: string;
+    data: {
+        content_type: {
+            uid: string;
+            title: string;
+        };
+    };
+    triggered_at: string;
+}
+interface ContentTypeDeleteEvent {
+    type: "content_type.delete";
+    module: "content_type";
+    event: "delete";
+    api_key: string;
+    data: {
+        content_type: {
+            uid: string;
+            title: string;
+        };
+    };
+    triggered_at: string;
+}
+type WebhookEvent = EntryPublishEvent | EntryUnpublishEvent | EntryUpdateEvent | EntryCreateEvent | EntryDeleteEvent | AssetPublishEvent | AssetUnpublishEvent | AssetDeleteEvent | ContentTypeCreateEvent | ContentTypeUpdateEvent | ContentTypeDeleteEvent | BaseWebhookEvent;
+
+/**
+ * Webhook signature verification using HMAC-SHA256.
+ * Uses the Web Crypto API for cross-runtime compatibility (Node 18+, Deno, Bun, edge).
+ */
+/**
+ * Verify a Contentstack webhook signature using HMAC-SHA256.
+ *
+ * @param body - The raw request body string
+ * @param signature - The hex-encoded signature from the `X-Contentstack-Request-Signature` header
+ * @param secret - The webhook secret configured in Contentstack
+ * @returns `true` if the signature is valid
+ */
+declare function verifyWebhookSignature(body: string, signature: string, secret: string): Promise<boolean>;
+
+/**
+ * Create a webhook handler with signature verification and typed event parsing.
+ *
+ * @example
+ * ```ts
+ * const handler = createWebhookHandler({ secret: process.env.WEBHOOK_SECRET })
+ *
+ * // In a route handler:
+ * const event = await handler.verify(request)
+ * if (event.type === "entry.publish") {
+ *   console.log(event.data.entry.uid)
+ * }
+ * ```
+ */
+declare function createWebhookHandler(config: WebhookHandlerConfig): {
+    /**
+     * Read the request body, verify the signature, and return a typed event.
+     * Throws `ContentstackAuthError` if the signature is missing or invalid.
+     */
+    verify(request: Request): Promise<WebhookEvent>;
+    /**
+     * Read the request body and return a typed event without verifying the signature.
+     */
+    parse(request: Request): Promise<WebhookEvent>;
+};
+
+export { type AssetDeleteEvent, type AssetPublishEvent, type AssetUnpublishEvent, type BaseWebhookEvent, type ContentTypeCreateEvent, type ContentTypeDeleteEvent, type ContentTypeUpdateEvent, type EntryCreateEvent, type EntryDeleteEvent, type EntryPublishEvent, type EntryUnpublishEvent, type EntryUpdateEvent, type WebhookEvent, type WebhookHandlerConfig, createWebhookHandler, verifyWebhookSignature };

package/dist/server/webhooks/index.d.ts

@@ -0,0 +1,230 @@
+/**
+ * Webhook event type system for Contentstack.
+ *
+ * The raw payload has `module` and `event` as separate fields.
+ * We compute a `type` field as `"${module}.${event}"` for discriminated union dispatch.
+ */
+interface WebhookHandlerConfig {
+    secret: string;
+}
+interface BaseWebhookEvent {
+    type: string;
+    module: string;
+    event: string;
+    api_key: string;
+    data: Record<string, unknown>;
+    triggered_at: string;
+}
+interface EntryPublishEvent {
+    type: "entry.publish";
+    module: "entry";
+    event: "publish";
+    api_key: string;
+    data: {
+        entry: {
+            uid: string;
+            title: string;
+        };
+        content_type: {
+            uid: string;
+        };
+        environment: {
+            name: string;
+        };
+        locale: string;
+    };
+    triggered_at: string;
+}
+interface EntryUnpublishEvent {
+    type: "entry.unpublish";
+    module: "entry";
+    event: "unpublish";
+    api_key: string;
+    data: {
+        entry: {
+            uid: string;
+            title: string;
+        };
+        content_type: {
+            uid: string;
+        };
+        environment: {
+            name: string;
+        };
+        locale: string;
+    };
+    triggered_at: string;
+}
+interface EntryUpdateEvent {
+    type: "entry.update";
+    module: "entry";
+    event: "update";
+    api_key: string;
+    data: {
+        entry: {
+            uid: string;
+            title: string;
+        };
+        content_type: {
+            uid: string;
+        };
+    };
+    triggered_at: string;
+}
+interface EntryCreateEvent {
+    type: "entry.create";
+    module: "entry";
+    event: "create";
+    api_key: string;
+    data: {
+        entry: {
+            uid: string;
+            title: string;
+        };
+        content_type: {
+            uid: string;
+        };
+    };
+    triggered_at: string;
+}
+interface EntryDeleteEvent {
+    type: "entry.delete";
+    module: "entry";
+    event: "delete";
+    api_key: string;
+    data: {
+        entry: {
+            uid: string;
+        };
+        content_type: {
+            uid: string;
+        };
+    };
+    triggered_at: string;
+}
+interface AssetPublishEvent {
+    type: "asset.publish";
+    module: "asset";
+    event: "publish";
+    api_key: string;
+    data: {
+        asset: {
+            uid: string;
+            filename: string;
+        };
+        environment: {
+            name: string;
+        };
+    };
+    triggered_at: string;
+}
+interface AssetUnpublishEvent {
+    type: "asset.unpublish";
+    module: "asset";
+    event: "unpublish";
+    api_key: string;
+    data: {
+        asset: {
+            uid: string;
+            filename: string;
+        };
+        environment: {
+            name: string;
+        };
+    };
+    triggered_at: string;
+}
+interface AssetDeleteEvent {
+    type: "asset.delete";
+    module: "asset";
+    event: "delete";
+    api_key: string;
+    data: {
+        asset: {
+            uid: string;
+        };
+    };
+    triggered_at: string;
+}
+interface ContentTypeCreateEvent {
+    type: "content_type.create";
+    module: "content_type";
+    event: "create";
+    api_key: string;
+    data: {
+        content_type: {
+            uid: string;
+            title: string;
+        };
+    };
+    triggered_at: string;
+}
+interface ContentTypeUpdateEvent {
+    type: "content_type.update";
+    module: "content_type";
+    event: "update";
+    api_key: string;
+    data: {
+        content_type: {
+            uid: string;
+            title: string;
+        };
+    };
+    triggered_at: string;
+}
+interface ContentTypeDeleteEvent {
+    type: "content_type.delete";
+    module: "content_type";
+    event: "delete";
+    api_key: string;
+    data: {
+        content_type: {
+            uid: string;
+            title: string;
+        };
+    };
+    triggered_at: string;
+}
+type WebhookEvent = EntryPublishEvent | EntryUnpublishEvent | EntryUpdateEvent | EntryCreateEvent | EntryDeleteEvent | AssetPublishEvent | AssetUnpublishEvent | AssetDeleteEvent | ContentTypeCreateEvent | ContentTypeUpdateEvent | ContentTypeDeleteEvent | BaseWebhookEvent;
+
+/**
+ * Webhook signature verification using HMAC-SHA256.
+ * Uses the Web Crypto API for cross-runtime compatibility (Node 18+, Deno, Bun, edge).
+ */
+/**
+ * Verify a Contentstack webhook signature using HMAC-SHA256.
+ *
+ * @param body - The raw request body string
+ * @param signature - The hex-encoded signature from the `X-Contentstack-Request-Signature` header
+ * @param secret - The webhook secret configured in Contentstack
+ * @returns `true` if the signature is valid
+ */
+declare function verifyWebhookSignature(body: string, signature: string, secret: string): Promise<boolean>;
+
+/**
+ * Create a webhook handler with signature verification and typed event parsing.
+ *
+ * @example
+ * ```ts
+ * const handler = createWebhookHandler({ secret: process.env.WEBHOOK_SECRET })
+ *
+ * // In a route handler:
+ * const event = await handler.verify(request)
+ * if (event.type === "entry.publish") {
+ *   console.log(event.data.entry.uid)
+ * }
+ * ```
+ */
+declare function createWebhookHandler(config: WebhookHandlerConfig): {
+    /**
+     * Read the request body, verify the signature, and return a typed event.
+     * Throws `ContentstackAuthError` if the signature is missing or invalid.
+     */
+    verify(request: Request): Promise<WebhookEvent>;
+    /**
+     * Read the request body and return a typed event without verifying the signature.
+     */
+    parse(request: Request): Promise<WebhookEvent>;
+};
+
+export { type AssetDeleteEvent, type AssetPublishEvent, type AssetUnpublishEvent, type BaseWebhookEvent, type ContentTypeCreateEvent, type ContentTypeDeleteEvent, type ContentTypeUpdateEvent, type EntryCreateEvent, type EntryDeleteEvent, type EntryPublishEvent, type EntryUnpublishEvent, type EntryUpdateEvent, type WebhookEvent, type WebhookHandlerConfig, createWebhookHandler, verifyWebhookSignature };

package/dist/server/webhooks/index.mjs

@@ -0,0 +1,23 @@
+import {
+  createWebhookHandler,
+  verifyWebhookSignature
+} from "../../chunk-FQP4PB5X.mjs";
+import "../../chunk-7VFGD32I.mjs";
+import "../../chunk-T5A2E2RI.mjs";
+import "../../chunk-VW7DD6HV.mjs";
+import "../../chunk-DJQLN4TR.mjs";
+import "../../chunk-XH7NLHGW.mjs";
+import "../../chunk-AVJHCFRK.mjs";
+import "../../chunk-EREPKWTW.mjs";
+import "../../chunk-GNPQJBFX.mjs";
+import "../../chunk-KLVIROVU.mjs";
+import "../../chunk-JZE2W7VW.mjs";
+import "../../chunk-3KE63N3I.mjs";
+import "../../chunk-4CJ4IVPJ.mjs";
+import "../../chunk-BK2IBTQS.mjs";
+import "../../chunk-DMERADWM.mjs";
+export {
+  createWebhookHandler,
+  verifyWebhookSignature
+};
+//# sourceMappingURL=index.mjs.map

package/dist/server/webhooks/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types-6D9VR7pT.d.cts

@@ -0,0 +1,26 @@
+import { ContentstackRegion } from './regions/index.cjs';
+
+interface OAuthConfig {
+    region: ContentstackRegion;
+    appId: string;
+    clientId: string;
+    clientSecret: string;
+    scopes: string[];
+    redirectUri: string;
+}
+interface OAuthTokens {
+    accessToken: string;
+    refreshToken: string;
+    expiresIn: number;
+    tokenType: string;
+}
+interface ContentstackUser {
+    uid: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    username?: string;
+    profileImage?: string;
+}
+
+export type { ContentstackUser as C, OAuthConfig as O, OAuthTokens as a };

package/dist/types-AelT0rFJ.d.cts

@@ -0,0 +1,21 @@
+interface RTENode {
+    type: string;
+    uid: string;
+    attrs?: Record<string, unknown>;
+    children?: Array<RTENode | RTETextNode>;
+}
+interface RTETextNode {
+    text: string;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strikethrough?: boolean;
+    code?: boolean;
+    superscript?: boolean;
+    subscript?: boolean;
+}
+interface RTEDocNode extends RTENode {
+    type: "doc";
+}
+
+export type { RTEDocNode as R, RTENode as a, RTETextNode as b };

package/dist/types-AelT0rFJ.d.ts

@@ -0,0 +1,21 @@
+interface RTENode {
+    type: string;
+    uid: string;
+    attrs?: Record<string, unknown>;
+    children?: Array<RTENode | RTETextNode>;
+}
+interface RTETextNode {
+    text: string;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strikethrough?: boolean;
+    code?: boolean;
+    superscript?: boolean;
+    subscript?: boolean;
+}
+interface RTEDocNode extends RTENode {
+    type: "doc";
+}
+
+export type { RTEDocNode as R, RTENode as a, RTETextNode as b };

package/dist/types-Bu5yCgmw.d.ts

@@ -0,0 +1,26 @@
+import { ContentstackRegion } from './regions/index.js';
+
+interface OAuthConfig {
+    region: ContentstackRegion;
+    appId: string;
+    clientId: string;
+    clientSecret: string;
+    scopes: string[];
+    redirectUri: string;
+}
+interface OAuthTokens {
+    accessToken: string;
+    refreshToken: string;
+    expiresIn: number;
+    tokenType: string;
+}
+interface ContentstackUser {
+    uid: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    username?: string;
+    profileImage?: string;
+}
+
+export type { ContentstackUser as C, OAuthConfig as O, OAuthTokens as a };

package/dist/types-DgixK-ll.d.cts

@@ -0,0 +1,23 @@
+interface HttpClientConfig {
+    /** Base URL for all requests */
+    baseUrl: string;
+    /** Default headers applied to every request */
+    headers?: Record<string, string>;
+    /** Request timeout in ms (default: 30000) */
+    timeout?: number;
+    /** Enable automatic retry on 429 and 5xx (default: true) */
+    retryOnError?: boolean;
+    /** Maximum retry attempts (default: 5) */
+    retryLimit?: number;
+    /** Initial delay between retries in ms (default: 300) */
+    retryDelay?: number;
+    /** Custom fetch implementation (for testing) */
+    fetch?: typeof globalThis.fetch;
+}
+interface HttpResponse<T> {
+    data: T;
+    status: number;
+    headers: Headers;
+}
+
+export type { HttpClientConfig as H, HttpResponse as a };

package/dist/types-DgixK-ll.d.ts

@@ -0,0 +1,23 @@
+interface HttpClientConfig {
+    /** Base URL for all requests */
+    baseUrl: string;
+    /** Default headers applied to every request */
+    headers?: Record<string, string>;
+    /** Request timeout in ms (default: 30000) */
+    timeout?: number;
+    /** Enable automatic retry on 429 and 5xx (default: true) */
+    retryOnError?: boolean;
+    /** Maximum retry attempts (default: 5) */
+    retryLimit?: number;
+    /** Initial delay between retries in ms (default: 300) */
+    retryDelay?: number;
+    /** Custom fetch implementation (for testing) */
+    fetch?: typeof globalThis.fetch;
+}
+interface HttpResponse<T> {
+    data: T;
+    status: number;
+    headers: Headers;
+}
+
+export type { HttpClientConfig as H, HttpResponse as a };