@uniforge/platform-core 0.1.0-alpha.2

package/dist/webhooks/index.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Core webhook types and interfaces.
+ *
+ * Platform-agnostic types for webhook handling including
+ * payloads, handlers, and registration.
+ */
+/** Common Shopify webhook topics. */
+type WebhookTopic = 'APP_UNINSTALLED' | 'APP_SUBSCRIPTIONS_UPDATE' | 'PRODUCTS_CREATE' | 'PRODUCTS_UPDATE' | 'PRODUCTS_DELETE' | 'ORDERS_CREATE' | 'ORDERS_UPDATED' | 'ORDERS_PAID' | 'ORDERS_FULFILLED' | 'CUSTOMERS_CREATE' | 'CUSTOMERS_UPDATE' | 'CUSTOMERS_DELETE' | 'SHOP_UPDATE' | string;
+interface WebhookPayload {
+    topic: string;
+    shopDomain: string;
+    apiVersion: string;
+    payload: unknown;
+    webhookId: string;
+    timestamp: Date;
+}
+interface WebhookHandler {
+    handle(payload: WebhookPayload): Promise<WebhookHandlerResult>;
+}
+interface WebhookHandlerResult {
+    success: boolean;
+    error?: string;
+}
+interface WebhookRegistration {
+    topic: string;
+    address: string;
+    format?: 'json' | 'xml';
+}
+
+/**
+ * Webhook HMAC validation interfaces.
+ *
+ * Defines the contract for validating incoming webhook requests
+ * using HMAC-SHA256 signatures (base64-encoded for Shopify webhooks).
+ */
+interface WebhookValidator {
+    validate(request: WebhookValidationRequest): boolean;
+}
+interface WebhookValidationRequest {
+    rawBody: Buffer;
+    hmac: string;
+    secret: string;
+}
+
+/**
+ * Webhook queue interfaces.
+ *
+ * Defines the contract for a Redis-backed webhook processing queue
+ * with retry support and dead letter handling.
+ */
+
+type WebhookJobStatus = 'pending' | 'processing' | 'completed' | 'failed' | 'dead';
+interface WebhookQueue {
+    enqueue(payload: WebhookPayload): Promise<string>;
+    dequeueNext(): Promise<WebhookJob | undefined>;
+    getJob(jobId: string): Promise<WebhookJob | undefined>;
+    acknowledgeJob(jobId: string, result: WebhookHandlerResult): Promise<void>;
+    requeueJob(jobId: string, error: string): Promise<void>;
+    getDeadLetterJobs(limit?: number): Promise<WebhookJob[]>;
+}
+interface WebhookJob {
+    id: string;
+    payload: WebhookPayload;
+    status: WebhookJobStatus;
+    attempts: number;
+    maxAttempts: number;
+    lastError?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    nextRetryAt?: Date;
+}
+interface WebhookQueueConfig {
+    maxAttempts?: number;
+    baseRetryDelayMs?: number;
+    maxRetryDelayMs?: number;
+    keyPrefix?: string;
+}
+
+/**
+ * GDPR webhook types.
+ *
+ * Defines the Shopify mandatory GDPR webhook payload shapes
+ * and the handler interface for processing them.
+ */
+interface CustomersDataRequest {
+    shop_domain: string;
+    customer: {
+        id: number;
+        email: string;
+        phone?: string;
+    };
+    orders_requested: number[];
+}
+interface CustomersRedact {
+    shop_domain: string;
+    customer: {
+        id: number;
+        email: string;
+        phone?: string;
+    };
+    orders_to_redact: number[];
+}
+interface ShopRedact {
+    shop_domain: string;
+    shop_id: number;
+}
+type GdprWebhookType = 'customers/data_request' | 'customers/redact' | 'shop/redact';
+interface GdprHandler {
+    handleDataRequest(payload: CustomersDataRequest): Promise<void>;
+    handleCustomerRedact(payload: CustomersRedact): Promise<void>;
+    handleShopRedact(payload: ShopRedact): Promise<void>;
+}
+
+export type { CustomersDataRequest, CustomersRedact, GdprHandler, GdprWebhookType, ShopRedact, WebhookHandler, WebhookHandlerResult, WebhookJob, WebhookJobStatus, WebhookPayload, WebhookQueue, WebhookQueueConfig, WebhookRegistration, WebhookTopic, WebhookValidationRequest, WebhookValidator };

package/dist/webhooks/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/webhooks/index.ts
+var webhooks_exports = {};
+module.exports = __toCommonJS(webhooks_exports);
+//# sourceMappingURL=index.js.map

package/dist/webhooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/webhooks/index.ts"],"sourcesContent":["/**\n * @uniforge/platform-core - Webhooks\n *\n * Platform-agnostic webhook interfaces and types.\n */\n\n// Types\nexport type {\n  WebhookTopic,\n  WebhookPayload,\n  WebhookHandler,\n  WebhookHandlerResult,\n  WebhookRegistration,\n} from './types';\n\n// Validation\nexport type { WebhookValidator, WebhookValidationRequest } from './validation';\n\n// Queue\nexport type {\n  WebhookJobStatus,\n  WebhookQueue,\n  WebhookJob,\n  WebhookQueueConfig,\n} from './queue';\n\n// GDPR\nexport type {\n  CustomersDataRequest,\n  CustomersRedact,\n  ShopRedact,\n  GdprWebhookType,\n  GdprHandler,\n} from './gdpr';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/webhooks/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/webhooks/index.mjs.map

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

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@uniforge/platform-core",
+  "version": "0.1.0-alpha.2",
+  "description": "Platform abstraction interfaces for e-commerce platform integrations",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./auth": {
+      "types": "./dist/auth/index.d.ts",
+      "import": "./dist/auth/index.mjs",
+      "require": "./dist/auth/index.js"
+    },
+    "./multi-tenant": {
+      "types": "./dist/multi-tenant/index.d.ts",
+      "import": "./dist/multi-tenant/index.mjs",
+      "require": "./dist/multi-tenant/index.js"
+    },
+    "./graphql": {
+      "types": "./dist/graphql/index.d.ts",
+      "import": "./dist/graphql/index.mjs",
+      "require": "./dist/graphql/index.js"
+    },
+    "./webhooks": {
+      "types": "./dist/webhooks/index.d.ts",
+      "import": "./dist/webhooks/index.mjs",
+      "require": "./dist/webhooks/index.js"
+    },
+    "./multi-store": {
+      "types": "./dist/multi-store/index.d.ts",
+      "import": "./dist/multi-store/index.mjs",
+      "require": "./dist/multi-store/index.js"
+    },
+    "./rbac": {
+      "types": "./dist/rbac/index.d.ts",
+      "import": "./dist/rbac/index.mjs",
+      "require": "./dist/rbac/index.js"
+    },
+    "./billing": {
+      "types": "./dist/billing/index.d.ts",
+      "import": "./dist/billing/index.mjs",
+      "require": "./dist/billing/index.js"
+    },
+    "./platform": {
+      "types": "./dist/platform/index.d.ts",
+      "import": "./dist/platform/index.mjs",
+      "require": "./dist/platform/index.js"
+    },
+    "./security": {
+      "types": "./dist/security/index.d.ts",
+      "import": "./dist/security/index.mjs",
+      "require": "./dist/security/index.js"
+    },
+    "./performance": {
+      "types": "./dist/performance/index.d.ts",
+      "import": "./dist/performance/index.mjs",
+      "require": "./dist/performance/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "tsup": "^8.3.0",
+    "vitest": "^2.1.0"
+  },
+  "keywords": [
+    "uniforge",
+    "platform",
+    "e-commerce",
+    "shopify"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/uniprocessing/uniforge.git",
+    "directory": "packages/platform-core"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest",
+    "lint": "eslint src/",
+    "typecheck": "tsc --noEmit"
+  }
+}