@uniforge/testing 0.1.0-alpha.2

package/dist/webhooks/index.d.cts

@@ -0,0 +1,127 @@
+import * as vitest from 'vitest';
+import { WebhookPayload, WebhookJob, WebhookHandlerResult, WebhookHandler } from '@uniforge/platform-core/webhooks';
+
+declare function createMockWebhookPayload(overrides?: Partial<WebhookPayload>): WebhookPayload;
+declare function createMockWebhookJob(overrides?: Partial<WebhookJob>): WebhookJob;
+declare function createMockWebhookHandler(result?: Partial<WebhookHandlerResult>): WebhookHandler;
+declare function createMockWebhookQueue(): {
+    enqueue: vitest.Mock<(...args: any[]) => any>;
+    getJob: vitest.Mock<(...args: any[]) => any>;
+    acknowledgeJob: vitest.Mock<(...args: any[]) => any>;
+    requeueJob: vitest.Mock<(...args: any[]) => any>;
+    dequeueNext: vitest.Mock<(...args: any[]) => any>;
+    getDeadLetterJobs: vitest.Mock<(...args: any[]) => any>;
+};
+
+/**
+ * Webhook delivery simulator for testing.
+ *
+ * Simulates Shopify webhook delivery via HTTP with proper HMAC signatures,
+ * headers, retry logic, and delivery history tracking.
+ */
+interface WebhookSimulatorConfig {
+    targetUrl: string;
+    secret: string;
+    apiVersion?: string;
+    defaultShopDomain?: string;
+}
+interface WebhookDeliveryInput {
+    topic: string;
+    payload: unknown;
+    shopDomain?: string;
+}
+interface WebhookDeliveryResult {
+    topic: string;
+    shopDomain: string;
+    statusCode: number;
+    success: boolean;
+    responseBody: string;
+    deliveredAt: Date;
+    attempt: number;
+    hmac: string;
+    webhookId: string;
+}
+interface RetryOptions {
+    maxAttempts?: number;
+    delayMs?: number;
+    backoffMultiplier?: number;
+}
+declare class WebhookSimulator {
+    private readonly targetUrl;
+    private readonly secret;
+    private readonly apiVersion;
+    private readonly defaultShopDomain;
+    private readonly history;
+    constructor(config: WebhookSimulatorConfig);
+    deliver(topic: string, payload: unknown, shopDomain?: string): Promise<WebhookDeliveryResult>;
+    deliverBatch(webhooks: WebhookDeliveryInput[]): Promise<WebhookDeliveryResult[]>;
+    deliverWithRetries(topic: string, payload: unknown, options?: RetryOptions): Promise<WebhookDeliveryResult[]>;
+    getDeliveryHistory(): WebhookDeliveryResult[];
+    clearHistory(): void;
+    private sendRequest;
+}
+
+/**
+ * Webhook payload generators for testing.
+ *
+ * Generates realistic Shopify webhook payloads with sensible defaults.
+ * All generators accept optional overrides to customize the output.
+ */
+interface OrderPayloadData {
+    id?: number;
+    orderNumber?: number;
+    email?: string;
+    totalPrice?: string;
+    currency?: string;
+    financialStatus?: string;
+    fulfillmentStatus?: string | null;
+    lineItems?: Array<{
+        id?: number;
+        title?: string;
+        quantity?: number;
+        price?: string;
+        sku?: string;
+    }>;
+}
+interface ProductPayloadData {
+    id?: number;
+    title?: string;
+    vendor?: string;
+    productType?: string;
+    status?: string;
+    handle?: string;
+    variants?: Array<{
+        id?: number;
+        title?: string;
+        price?: string;
+        sku?: string;
+        inventoryQuantity?: number;
+    }>;
+}
+interface CustomerPayloadData {
+    id?: number;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    ordersCount?: number;
+    totalSpent?: string;
+}
+interface SubscriptionPayloadData {
+    id?: number;
+    adminGraphqlApiId?: string;
+    name?: string;
+    status?: string;
+}
+declare function generateAppUninstalledPayload(shopDomain?: string): Record<string, unknown>;
+declare function generateOrderCreatedPayload(overrides?: OrderPayloadData): Record<string, unknown>;
+declare function generateOrderPaidPayload(overrides?: OrderPayloadData): Record<string, unknown>;
+declare function generateProductCreatedPayload(overrides?: ProductPayloadData): Record<string, unknown>;
+declare function generateProductUpdatedPayload(overrides?: ProductPayloadData): Record<string, unknown>;
+declare function generateProductDeletedPayload(productId?: number): Record<string, unknown>;
+declare function generateCustomerCreatedPayload(overrides?: CustomerPayloadData): Record<string, unknown>;
+declare function generateCustomerUpdatedPayload(overrides?: CustomerPayloadData): Record<string, unknown>;
+declare function generateSubscriptionUpdatePayload(overrides?: SubscriptionPayloadData): Record<string, unknown>;
+declare function generatePayload(_topic: string, data?: Record<string, unknown>): Record<string, unknown>;
+
+export { type CustomerPayloadData, type OrderPayloadData, type ProductPayloadData, type RetryOptions, type SubscriptionPayloadData, type WebhookDeliveryInput, type WebhookDeliveryResult, WebhookSimulator, type WebhookSimulatorConfig, createMockWebhookHandler, createMockWebhookJob, createMockWebhookPayload, createMockWebhookQueue, generateAppUninstalledPayload, generateCustomerCreatedPayload, generateCustomerUpdatedPayload, generateOrderCreatedPayload, generateOrderPaidPayload, generatePayload, generateProductCreatedPayload, generateProductDeletedPayload, generateProductUpdatedPayload, generateSubscriptionUpdatePayload };

package/dist/webhooks/index.d.ts

@@ -0,0 +1,127 @@
+import * as vitest from 'vitest';
+import { WebhookPayload, WebhookJob, WebhookHandlerResult, WebhookHandler } from '@uniforge/platform-core/webhooks';
+
+declare function createMockWebhookPayload(overrides?: Partial<WebhookPayload>): WebhookPayload;
+declare function createMockWebhookJob(overrides?: Partial<WebhookJob>): WebhookJob;
+declare function createMockWebhookHandler(result?: Partial<WebhookHandlerResult>): WebhookHandler;
+declare function createMockWebhookQueue(): {
+    enqueue: vitest.Mock<(...args: any[]) => any>;
+    getJob: vitest.Mock<(...args: any[]) => any>;
+    acknowledgeJob: vitest.Mock<(...args: any[]) => any>;
+    requeueJob: vitest.Mock<(...args: any[]) => any>;
+    dequeueNext: vitest.Mock<(...args: any[]) => any>;
+    getDeadLetterJobs: vitest.Mock<(...args: any[]) => any>;
+};
+
+/**
+ * Webhook delivery simulator for testing.
+ *
+ * Simulates Shopify webhook delivery via HTTP with proper HMAC signatures,
+ * headers, retry logic, and delivery history tracking.
+ */
+interface WebhookSimulatorConfig {
+    targetUrl: string;
+    secret: string;
+    apiVersion?: string;
+    defaultShopDomain?: string;
+}
+interface WebhookDeliveryInput {
+    topic: string;
+    payload: unknown;
+    shopDomain?: string;
+}
+interface WebhookDeliveryResult {
+    topic: string;
+    shopDomain: string;
+    statusCode: number;
+    success: boolean;
+    responseBody: string;
+    deliveredAt: Date;
+    attempt: number;
+    hmac: string;
+    webhookId: string;
+}
+interface RetryOptions {
+    maxAttempts?: number;
+    delayMs?: number;
+    backoffMultiplier?: number;
+}
+declare class WebhookSimulator {
+    private readonly targetUrl;
+    private readonly secret;
+    private readonly apiVersion;
+    private readonly defaultShopDomain;
+    private readonly history;
+    constructor(config: WebhookSimulatorConfig);
+    deliver(topic: string, payload: unknown, shopDomain?: string): Promise<WebhookDeliveryResult>;
+    deliverBatch(webhooks: WebhookDeliveryInput[]): Promise<WebhookDeliveryResult[]>;
+    deliverWithRetries(topic: string, payload: unknown, options?: RetryOptions): Promise<WebhookDeliveryResult[]>;
+    getDeliveryHistory(): WebhookDeliveryResult[];
+    clearHistory(): void;
+    private sendRequest;
+}
+
+/**
+ * Webhook payload generators for testing.
+ *
+ * Generates realistic Shopify webhook payloads with sensible defaults.
+ * All generators accept optional overrides to customize the output.
+ */
+interface OrderPayloadData {
+    id?: number;
+    orderNumber?: number;
+    email?: string;
+    totalPrice?: string;
+    currency?: string;
+    financialStatus?: string;
+    fulfillmentStatus?: string | null;
+    lineItems?: Array<{
+        id?: number;
+        title?: string;
+        quantity?: number;
+        price?: string;
+        sku?: string;
+    }>;
+}
+interface ProductPayloadData {
+    id?: number;
+    title?: string;
+    vendor?: string;
+    productType?: string;
+    status?: string;
+    handle?: string;
+    variants?: Array<{
+        id?: number;
+        title?: string;
+        price?: string;
+        sku?: string;
+        inventoryQuantity?: number;
+    }>;
+}
+interface CustomerPayloadData {
+    id?: number;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    ordersCount?: number;
+    totalSpent?: string;
+}
+interface SubscriptionPayloadData {
+    id?: number;
+    adminGraphqlApiId?: string;
+    name?: string;
+    status?: string;
+}
+declare function generateAppUninstalledPayload(shopDomain?: string): Record<string, unknown>;
+declare function generateOrderCreatedPayload(overrides?: OrderPayloadData): Record<string, unknown>;
+declare function generateOrderPaidPayload(overrides?: OrderPayloadData): Record<string, unknown>;
+declare function generateProductCreatedPayload(overrides?: ProductPayloadData): Record<string, unknown>;
+declare function generateProductUpdatedPayload(overrides?: ProductPayloadData): Record<string, unknown>;
+declare function generateProductDeletedPayload(productId?: number): Record<string, unknown>;
+declare function generateCustomerCreatedPayload(overrides?: CustomerPayloadData): Record<string, unknown>;
+declare function generateCustomerUpdatedPayload(overrides?: CustomerPayloadData): Record<string, unknown>;
+declare function generateSubscriptionUpdatePayload(overrides?: SubscriptionPayloadData): Record<string, unknown>;
+declare function generatePayload(_topic: string, data?: Record<string, unknown>): Record<string, unknown>;
+
+export { type CustomerPayloadData, type OrderPayloadData, type ProductPayloadData, type RetryOptions, type SubscriptionPayloadData, type WebhookDeliveryInput, type WebhookDeliveryResult, WebhookSimulator, type WebhookSimulatorConfig, createMockWebhookHandler, createMockWebhookJob, createMockWebhookPayload, createMockWebhookQueue, generateAppUninstalledPayload, generateCustomerCreatedPayload, generateCustomerUpdatedPayload, generateOrderCreatedPayload, generateOrderPaidPayload, generatePayload, generateProductCreatedPayload, generateProductDeletedPayload, generateProductUpdatedPayload, generateSubscriptionUpdatePayload };