@laioutr/webhook-types 0.1.0

package/dist/byos/events.d.ts

@@ -0,0 +1,2 @@
+import { a as ByosDeploymentPromoteEvent, c as ByosDisconnectedEvent, i as ByosDeploymentDeleteEvent, l as ByosEvent, n as ByosDeploymentCancelEvent, o as ByosDeploymentRollbackEvent, r as ByosDeploymentCreatedEvent, s as ByosDescribeEvent, t as ByosConnectedEvent, u as ByosEventBase } from "../events-BTJDYtyR.js";
+export { ByosConnectedEvent, ByosDeploymentCancelEvent, ByosDeploymentCreatedEvent, ByosDeploymentDeleteEvent, ByosDeploymentPromoteEvent, ByosDeploymentRollbackEvent, ByosDescribeEvent, ByosDisconnectedEvent, ByosEvent, ByosEventBase };

package/dist/byos/index.d.ts

@@ -0,0 +1,3 @@
+import { a as ByosDeploymentPromoteEvent, c as ByosDisconnectedEvent, i as ByosDeploymentDeleteEvent, l as ByosEvent, n as ByosDeploymentCancelEvent, o as ByosDeploymentRollbackEvent, r as ByosDeploymentCreatedEvent, s as ByosDescribeEvent, t as ByosConnectedEvent, u as ByosEventBase } from "../events-BTJDYtyR.js";
+import { i as ByosDescribeResponseData, n as ByosDeploymentStatusEvent, r as ByosDeploymentStatusValue, t as ByosCapabilities } from "../responses-DOwOY64C.js";
+export { type ByosCapabilities, type ByosConnectedEvent, type ByosDeploymentCancelEvent, type ByosDeploymentCreatedEvent, type ByosDeploymentDeleteEvent, type ByosDeploymentPromoteEvent, type ByosDeploymentRollbackEvent, type ByosDeploymentStatusEvent, type ByosDeploymentStatusValue, type ByosDescribeEvent, type ByosDescribeResponseData, type ByosDisconnectedEvent, type ByosEvent, type ByosEventBase };

package/dist/byos/responses.d.ts

@@ -0,0 +1,2 @@
+import { i as ByosDescribeResponseData, n as ByosDeploymentStatusEvent, r as ByosDeploymentStatusValue, t as ByosCapabilities } from "../responses-DOwOY64C.js";
+export { ByosCapabilities, ByosDeploymentStatusEvent, ByosDeploymentStatusValue, ByosDescribeResponseData };

package/dist/common/index.d.ts

@@ -0,0 +1,2 @@
+import { a as WebhookSuccessResponse, i as WebhookResponse, n as WebhookErrorResponse, r as WebhookEventBase, t as StandardWebhookHeaders } from "../types-CCIq_Zlj.js";
+export { StandardWebhookHeaders, WebhookErrorResponse, WebhookEventBase, WebhookResponse, WebhookSuccessResponse };

package/dist/common/types.d.ts

@@ -0,0 +1,2 @@
+import { a as WebhookSuccessResponse, i as WebhookResponse, n as WebhookErrorResponse, r as WebhookEventBase, t as StandardWebhookHeaders } from "../types-CCIq_Zlj.js";
+export { StandardWebhookHeaders, WebhookErrorResponse, WebhookEventBase, WebhookResponse, WebhookSuccessResponse };

package/dist/events-BTJDYtyR.d.ts

@@ -0,0 +1,94 @@
+import { r as WebhookEventBase } from "./types-CCIq_Zlj.js";
+
+//#region src/byos/events.d.ts
+
+/**
+ * Base for all BYOS events - includes project identifier.
+ */
+interface ByosEventBase extends WebhookEventBase {
+  /** Project identifier in format "org-slug/project-slug" */
+  project: string;
+}
+/**
+ * Capability discovery event.
+ * Sent to fetch hosting capabilities and validate endpoint.
+ */
+interface ByosDescribeEvent extends ByosEventBase {
+  event: 'hosting.describe';
+}
+/**
+ * Connection established notification.
+ * Sent after successful setup.
+ */
+interface ByosConnectedEvent extends ByosEventBase {
+  event: 'hosting.connected';
+}
+/**
+ * Disconnection notification.
+ * Sent when hosting is disconnected.
+ */
+interface ByosDisconnectedEvent extends ByosEventBase {
+  event: 'hosting.disconnected';
+}
+/**
+ * Deployment created event.
+ * Contains files and callback URL for status updates.
+ */
+interface ByosDeploymentCreatedEvent extends ByosEventBase {
+  event: 'hosting.deployment.created';
+  data: {
+    /** Internal deployment ID */
+    deploymentId: string;
+    /** Target environment */
+    environment: 'production' | 'staging';
+    /** URL to POST status updates to */
+    callbackUrl: string;
+    /** Map of filename to file content */
+    files: Record<string, string>;
+  };
+}
+/**
+ * Deployment cancel request.
+ */
+interface ByosDeploymentCancelEvent extends ByosEventBase {
+  event: 'hosting.deployment.cancel';
+  data: {
+    deploymentId: string;
+  };
+}
+/**
+ * Deployment promote request.
+ */
+interface ByosDeploymentPromoteEvent extends ByosEventBase {
+  event: 'hosting.deployment.promote';
+  data: {
+    deploymentId: string;
+  };
+}
+/**
+ * Deployment rollback request.
+ */
+interface ByosDeploymentRollbackEvent extends ByosEventBase {
+  event: 'hosting.deployment.rollback';
+  data: {
+    /** Deployment to roll back TO */
+    deploymentId: string;
+    /** Currently active deployment being replaced (optional) */
+    fromDeploymentId?: string;
+  };
+}
+/**
+ * Deployment delete request.
+ */
+interface ByosDeploymentDeleteEvent extends ByosEventBase {
+  event: 'hosting.deployment.delete';
+  data: {
+    deploymentId: string;
+  };
+}
+/**
+ * Union of all BYOS outbound events.
+ */
+type ByosEvent = ByosDescribeEvent | ByosConnectedEvent | ByosDisconnectedEvent | ByosDeploymentCreatedEvent | ByosDeploymentCancelEvent | ByosDeploymentPromoteEvent | ByosDeploymentRollbackEvent | ByosDeploymentDeleteEvent;
+//#endregion
+export { ByosDeploymentPromoteEvent as a, ByosDisconnectedEvent as c, ByosDeploymentDeleteEvent as i, ByosEvent as l, ByosDeploymentCancelEvent as n, ByosDeploymentRollbackEvent as o, ByosDeploymentCreatedEvent as r, ByosDescribeEvent as s, ByosConnectedEvent as t, ByosEventBase as u };

package/dist/index-Cf8zm5QQ.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/responses-DOwOY64C.d.ts

@@ -0,0 +1,54 @@
+import { r as WebhookEventBase } from "./types-CCIq_Zlj.js";
+
+//#region src/byos/responses.d.ts
+
+/**
+ * Hosting adapter capabilities.
+ */
+interface ByosCapabilities {
+  /** Can call back with deployment status updates */
+  statusUpdates: boolean;
+  /** Can cancel a running deployment */
+  cancelDeployment: boolean;
+  /** Can promote a deployment to live */
+  promoteDeployment: boolean;
+  /** Can rollback to a previous deployment */
+  rollbackDeployment: boolean;
+  /** Can delete a deployment */
+  deleteDeployment: boolean;
+}
+/**
+ * Response data for hosting.describe event.
+ */
+interface ByosDescribeResponseData {
+  /** Display name for the hosting provider */
+  name: string;
+  /** Supported capabilities */
+  capabilities: ByosCapabilities;
+}
+/**
+ * Deployment status values.
+ */
+type ByosDeploymentStatusValue = 'running' | 'success' | 'error' | 'canceled' | 'promoted';
+/**
+ * Status update callback event (inbound from customer).
+ */
+interface ByosDeploymentStatusEvent extends WebhookEventBase {
+  event: 'hosting.deployment.status';
+  data: {
+    status: 'running';
+  } | {
+    status: 'success';
+    url: string;
+  } | {
+    status: 'error';
+    error: string;
+  } | {
+    status: 'canceled';
+  } | {
+    status: 'promoted';
+    url?: string;
+  };
+}
+//#endregion
+export { ByosDescribeResponseData as i, ByosDeploymentStatusEvent as n, ByosDeploymentStatusValue as r, ByosCapabilities as t };

package/dist/types-CCIq_Zlj.d.ts

@@ -0,0 +1,42 @@
+//#region src/common/types.d.ts
+/**
+ * Base structure for all webhook events.
+ */
+interface WebhookEventBase {
+  /** Event type identifier */
+  event: string;
+  /** ISO 8601 timestamp */
+  timestamp: string;
+}
+/**
+ * Successful webhook response.
+ */
+interface WebhookSuccessResponse<T = Record<string, unknown>> {
+  ok: true;
+  data: T;
+}
+/**
+ * Error webhook response.
+ */
+interface WebhookErrorResponse {
+  ok: false;
+  error: string;
+}
+/**
+ * Union of success and error responses.
+ */
+type WebhookResponse<T = Record<string, unknown>> = WebhookSuccessResponse<T> | WebhookErrorResponse;
+/**
+ * Standard Webhooks headers for signature verification.
+ * @see https://www.standardwebhooks.com/
+ */
+interface StandardWebhookHeaders {
+  /** Unique event ID (same across retries for idempotency) */
+  'webhook-id': string;
+  /** Unix timestamp of when the event was sent */
+  'webhook-timestamp': string;
+  /** HMAC-SHA256 signature for verification */
+  'webhook-signature': string;
+}
+//#endregion
+export { WebhookSuccessResponse as a, WebhookResponse as i, WebhookErrorResponse as n, WebhookEventBase as r, StandardWebhookHeaders as t };

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@laioutr/webhook-types",
+  "version": "0.1.0",
+  "description": "Webhook type definitions for Laioutr integrations",
+  "license": "UNLICENSED",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/common/index.d.ts",
+      "import": "./dist/common/index.js"
+    },
+    "./byos": {
+      "types": "./dist/byos/index.d.ts",
+      "import": "./dist/byos/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "lint-staged": {
+    "*.{js,mjs,jsx,ts,tsx,vue}": [
+      "pnpm lint --fix",
+      "prettier --cache --write"
+    ],
+    "*.{css,scss,md,html,json}": "prettier --cache --write"
+  },
+  "devDependencies": {
+    "@laioutr/eslint-config": "^1.8.8",
+    "@tsconfig/recommended": "^1.0.8",
+    "@types/node": "latest",
+    "tsdown": "^0.17.0",
+    "typescript": "^5.7.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch src",
+    "lint": "eslint --cache --cache-location ../../.eslintcache",
+    "release": "pnpm build && pnpm publish",
+    "stub": "tsdown",
+    "typecheck": "tsc --pretty --noEmit"
+  }
+}