@corsair-dev/abyssale 0.1.0 → 0.1.1

package/dist/webhooks/index.d.ts

@@ -0,0 +1,196 @@
+export declare const BannerWebhooks: {
+    created: {
+        match: import("corsair/core").CorsairWebhookMatcher;
+        handler: import("corsair/core").CorsairWebhookHandler<import("..").AbyssaleContext, {
+            [x: string]: unknown;
+            id: string;
+            event_type: "NEW_BANNER";
+            version?: number | undefined;
+            sharing_id?: string | undefined;
+            file?: {
+                [x: string]: unknown;
+                type?: string | undefined;
+                url?: string | undefined;
+                cdn_url?: string | undefined;
+                fallback_image_url?: string | undefined;
+                filename?: string | undefined;
+            } | undefined;
+            format?: {
+                [x: string]: unknown;
+                id?: string | undefined;
+                width?: number | undefined;
+                height?: number | undefined;
+                unit?: string | undefined;
+            } | undefined;
+            template?: {
+                [x: string]: unknown;
+                id?: string | undefined;
+                name?: string | undefined;
+                created_at?: number | undefined;
+                updated_at?: number | undefined;
+            } | undefined;
+        }, {
+            [x: string]: unknown;
+            id: string;
+            event_type: "NEW_BANNER";
+            version?: number | undefined;
+            sharing_id?: string | undefined;
+            file?: {
+                [x: string]: unknown;
+                type?: string | undefined;
+                url?: string | undefined;
+                cdn_url?: string | undefined;
+                fallback_image_url?: string | undefined;
+                filename?: string | undefined;
+            } | undefined;
+            format?: {
+                [x: string]: unknown;
+                id?: string | undefined;
+                width?: number | undefined;
+                height?: number | undefined;
+                unit?: string | undefined;
+            } | undefined;
+            template?: {
+                [x: string]: unknown;
+                id?: string | undefined;
+                name?: string | undefined;
+                created_at?: number | undefined;
+                updated_at?: number | undefined;
+            } | undefined;
+        }>;
+    };
+    batchCompleted: {
+        match: import("corsair/core").CorsairWebhookMatcher;
+        handler: import("corsair/core").CorsairWebhookHandler<import("..").AbyssaleContext, {
+            [x: string]: unknown;
+            event_type: "NEW_BANNER_BATCH";
+            generation_request_id: string;
+            banners: {
+                [x: string]: unknown;
+                id: string;
+                version?: number | undefined;
+                sharing_id?: string | undefined;
+                file?: {
+                    [x: string]: unknown;
+                    type?: string | undefined;
+                    url?: string | undefined;
+                    cdn_url?: string | undefined;
+                    fallback_image_url?: string | undefined;
+                    filename?: string | undefined;
+                } | undefined;
+                format?: {
+                    [x: string]: unknown;
+                    id?: string | undefined;
+                    width?: number | undefined;
+                    height?: number | undefined;
+                    unit?: string | undefined;
+                } | undefined;
+                template?: {
+                    [x: string]: unknown;
+                    id?: string | undefined;
+                    name?: string | undefined;
+                    created_at?: number | undefined;
+                    updated_at?: number | undefined;
+                } | undefined;
+                project?: {
+                    [x: string]: unknown;
+                    id?: string | undefined;
+                    name?: string | undefined;
+                } | undefined;
+            }[];
+            errors: {
+                [x: string]: unknown;
+                template_format_name: string;
+                reason: string;
+            }[];
+        }, {
+            [x: string]: unknown;
+            event_type: "NEW_BANNER_BATCH";
+            generation_request_id: string;
+            banners: {
+                [x: string]: unknown;
+                id: string;
+                version?: number | undefined;
+                sharing_id?: string | undefined;
+                file?: {
+                    [x: string]: unknown;
+                    type?: string | undefined;
+                    url?: string | undefined;
+                    cdn_url?: string | undefined;
+                    fallback_image_url?: string | undefined;
+                    filename?: string | undefined;
+                } | undefined;
+                format?: {
+                    [x: string]: unknown;
+                    id?: string | undefined;
+                    width?: number | undefined;
+                    height?: number | undefined;
+                    unit?: string | undefined;
+                } | undefined;
+                template?: {
+                    [x: string]: unknown;
+                    id?: string | undefined;
+                    name?: string | undefined;
+                    created_at?: number | undefined;
+                    updated_at?: number | undefined;
+                } | undefined;
+                project?: {
+                    [x: string]: unknown;
+                    id?: string | undefined;
+                    name?: string | undefined;
+                } | undefined;
+            }[];
+            errors: {
+                [x: string]: unknown;
+                template_format_name: string;
+                reason: string;
+            }[];
+        }>;
+    };
+};
+export declare const DesignWebhooks: {
+    statusChanged: {
+        match: import("corsair/core").CorsairWebhookMatcher;
+        handler: import("corsair/core").CorsairWebhookHandler<import("..").AbyssaleContext, {
+            [x: string]: unknown;
+            event_type: "TEMPLATE_STATUS";
+            id: string;
+            status: string;
+            name?: string | undefined;
+            created_at?: number | undefined;
+            updated_at?: number | undefined;
+            status_updated_at?: number | undefined;
+        }, {
+            [x: string]: unknown;
+            event_type: "TEMPLATE_STATUS";
+            id: string;
+            status: string;
+            name?: string | undefined;
+            created_at?: number | undefined;
+            updated_at?: number | undefined;
+            status_updated_at?: number | undefined;
+        }>;
+    };
+};
+export declare const ExportWebhooks: {
+    completed: {
+        match: import("corsair/core").CorsairWebhookMatcher;
+        handler: import("corsair/core").CorsairWebhookHandler<import("..").AbyssaleContext, {
+            [x: string]: unknown;
+            event_type: "NEW_EXPORT";
+            export_id: string;
+            archive_url: string;
+            requested_at?: number | undefined;
+            generated_at?: number | undefined;
+        }, {
+            [x: string]: unknown;
+            event_type: "NEW_EXPORT";
+            export_id: string;
+            archive_url: string;
+            requested_at?: number | undefined;
+            generated_at?: number | undefined;
+        }>;
+    };
+};
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../webhooks/index.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAG1B,CAAC;AAEF,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;CAE1B,CAAC;AAEF,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;CAE1B,CAAC;AAEF,cAAc,SAAS,CAAC"}

package/dist/webhooks/types.d.ts

@@ -0,0 +1,131 @@
+import type { CorsairWebhookMatcher, RawWebhookRequest, WebhookRequest } from 'corsair/core';
+import { z } from 'zod';
+/**
+ * Abyssale webhook payloads all carry a top-level `event_type`; dispatch on it
+ * and ignore unknown values rather than failing, so a new provider event never
+ * breaks the receiver.
+ */
+declare const AbyssaleWebhookPayloadSchema: z.ZodObject<{
+    event_type: z.ZodString;
+}, z.core.$loose>;
+export type AbyssaleWebhookPayload = z.infer<typeof AbyssaleWebhookPayloadSchema>;
+/** `NEW_BANNER` — a single visual was generated or saved (never for sync API renders). */
+export declare const NewBannerEventSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    version: z.ZodOptional<z.ZodNumber>;
+    sharing_id: z.ZodOptional<z.ZodUUID>;
+    file: z.ZodOptional<z.ZodObject<{
+        type: z.ZodOptional<z.ZodString>;
+        url: z.ZodOptional<z.ZodString>;
+        cdn_url: z.ZodOptional<z.ZodString>;
+        fallback_image_url: z.ZodOptional<z.ZodString>;
+        filename: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>;
+    format: z.ZodOptional<z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>;
+    template: z.ZodOptional<z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        created_at: z.ZodOptional<z.ZodNumber>;
+        updated_at: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+    event_type: z.ZodLiteral<"NEW_BANNER">;
+}, z.core.$loose>;
+export type NewBannerEvent = z.infer<typeof NewBannerEventSchema>;
+/** `NEW_BANNER_BATCH` — an asynchronous batch generation request completed. */
+export declare const NewBannerBatchEventSchema: z.ZodObject<{
+    event_type: z.ZodLiteral<"NEW_BANNER_BATCH">;
+    generation_request_id: z.ZodUUID;
+    banners: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodOptional<z.ZodNumber>;
+        sharing_id: z.ZodOptional<z.ZodString>;
+        file: z.ZodOptional<z.ZodObject<{
+            type: z.ZodOptional<z.ZodString>;
+            url: z.ZodOptional<z.ZodString>;
+            cdn_url: z.ZodOptional<z.ZodString>;
+            fallback_image_url: z.ZodOptional<z.ZodString>;
+            filename: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
+        format: z.ZodOptional<z.ZodObject<{
+            id: z.ZodOptional<z.ZodString>;
+            width: z.ZodOptional<z.ZodNumber>;
+            height: z.ZodOptional<z.ZodNumber>;
+            unit: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
+        template: z.ZodOptional<z.ZodObject<{
+            id: z.ZodOptional<z.ZodString>;
+            name: z.ZodOptional<z.ZodString>;
+            created_at: z.ZodOptional<z.ZodNumber>;
+            updated_at: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$loose>>;
+        project: z.ZodOptional<z.ZodObject<{
+            id: z.ZodOptional<z.ZodString>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>;
+    errors: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        template_format_name: z.ZodString;
+        reason: z.ZodString;
+    }, z.core.$loose>>>>;
+}, z.core.$loose>;
+export type NewBannerBatchEvent = z.infer<typeof NewBannerBatchEventSchema>;
+/** `NEW_EXPORT` — a workspace-wide export (ZIP) finished processing. */
+export declare const NewExportEventSchema: z.ZodObject<{
+    event_type: z.ZodLiteral<"NEW_EXPORT">;
+    export_id: z.ZodUUID;
+    archive_url: z.ZodURL;
+    requested_at: z.ZodOptional<z.ZodNumber>;
+    generated_at: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;
+export type NewExportEvent = z.infer<typeof NewExportEventSchema>;
+/**
+ * `TEMPLATE_STATUS` — a design moved through its review workflow. The status
+ * stays an open string: Abyssale may introduce workflow states beyond the six
+ * documented values, and rejecting those deliveries would drop real updates.
+ */
+export declare const TemplateStatusEventSchema: z.ZodObject<{
+    event_type: z.ZodLiteral<"TEMPLATE_STATUS">;
+    id: z.ZodUUID;
+    name: z.ZodOptional<z.ZodString>;
+    status: z.ZodString;
+    created_at: z.ZodOptional<z.ZodNumber>;
+    updated_at: z.ZodOptional<z.ZodNumber>;
+    status_updated_at: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;
+export type TemplateStatusEvent = z.infer<typeof TemplateStatusEventSchema>;
+export type AbyssaleWebhookOutputs = {
+    newBanner: NewBannerEvent;
+    newBannerBatch: NewBannerBatchEvent;
+    newExport: NewExportEvent;
+    templateStatus: TemplateStatusEvent;
+};
+/** Event types this plugin handles; anything else is ignored by the matcher. */
+export declare const HANDLED_EVENT_TYPES: readonly ["NEW_BANNER", "NEW_BANNER_BATCH", "NEW_EXPORT", "TEMPLATE_STATUS"];
+export declare function parseBody(body: unknown): Record<string, unknown> | null;
+export declare function createAbyssaleMatch(eventType: string): CorsairWebhookMatcher;
+/** Plugin-level matcher: an Abyssale event payload with a handled `event_type`. */
+export declare function matchAbyssalePluginWebhook(request: RawWebhookRequest): boolean;
+export declare function verifyAbyssaleWebhookSignature(request: WebhookRequest<unknown>, secret?: string): {
+    valid: boolean;
+    error?: string;
+};
+/**
+ * Shared webhook guard: verifies the delivery signature, then validates the
+ * payload against the event schema. Keeps the 401/400 semantics identical
+ * across every handler.
+ */
+export declare function verifyAndParseEvent<S extends z.ZodType>(request: WebhookRequest<unknown>, secret: string | undefined, schema: S, eventName: string): {
+    ok: true;
+    event: z.output<S>;
+} | {
+    ok: false;
+    statusCode: number;
+    error: string;
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/webhooks/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../webhooks/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,qBAAqB,EACrB,iBAAiB,EACjB,cAAc,EACd,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB;;;;GAIG;AACH,QAAA,MAAM,4BAA4B;;iBAIzB,CAAC;AAEV,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,4BAA4B,CACnC,CAAC;AAWF,0FAA0F;AAC1F,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;iBAG/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,+EAA+E;AAC/E,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAepC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,wEAAwE;AACxE,eAAO,MAAM,oBAAoB;;;;;;iBAM/B,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;iBAQpC,CAAC;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,MAAM,MAAM,sBAAsB,GAAG;IACpC,SAAS,EAAE,cAAc,CAAC;IAC1B,cAAc,EAAE,mBAAmB,CAAC;IACpC,SAAS,EAAE,cAAc,CAAC;IAC1B,cAAc,EAAE,mBAAmB,CAAC;CACpC,CAAC;AAEF,gFAAgF;AAChF,eAAO,MAAM,mBAAmB,8EAKtB,CAAC;AAIX,wBAAgB,SAAS,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAoBvE;AAED,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,qBAAqB,CAS5E;AAED,mFAAmF;AACnF,wBAAgB,0BAA0B,CACzC,OAAO,EAAE,iBAAiB,GACxB,OAAO,CAMT;AAyCD,wBAAgB,8BAA8B,CAC7C,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,EAChC,MAAM,CAAC,EAAE,MAAM,GACb;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAyEpC;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EACtD,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,EAChC,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,MAAM,EAAE,CAAC,EACT,SAAS,EAAE,MAAM,GAEf;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAAE,GAChC;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAoBlD"}

package/dist/webhooks.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=webhooks.test.d.ts.map

package/dist/webhooks.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.test.d.ts","sourceRoot":"","sources":["../webhooks.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@corsair-dev/abyssale",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Abyssale plugin for Corsair",
   "type": "module",
   "main": "./dist/index.js",
@@ -24,18 +24,24 @@
     "tsup": "^8.0.1",
     "typescript": "^5.9.3",
     "zod": "^4.1.13",
-    "corsair": "0.1.119"
+    "corsair": "0.1.129"
   },
   "keywords": [
     "corsair",
     "abyssale",
     "plugin"
   ],
-  "author": "",
+  "author": "Corsair (https://corsair.dev)",
   "license": "Apache-2.0",
   "files": [
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/corsairdev/corsair.git",
+    "directory": "packages/abyssale"
+  },
+  "homepage": "https://docs.corsair.dev/plugins/abyssale",
   "scripts": {
     "build": "rm -rf dist && tsc --build --force && tsup",
     "typecheck": "tsc --noEmit",