@unifiedcommerce/core 0.4.4 → 0.5.0

package/dist/interfaces/rest/schemas/promotions.d.ts

@@ -0,0 +1,374 @@
+import { z } from "@hono/zod-openapi";
+import { CreatePromotionBodySchema } from "../../../modules/promotions/schemas.js";
+export { CreatePromotionBodySchema };
+export declare const ValidatePromotionBodySchema: z.ZodObject<{
+    code: z.ZodString;
+    currency: z.ZodString;
+    subtotal: z.ZodNumber;
+    lineItems: z.ZodArray<z.ZodObject<{
+        entityId: z.ZodString;
+        entityType: z.ZodString;
+        quantity: z.ZodNumber;
+        unitPrice: z.ZodNumber;
+        totalPrice: z.ZodNumber;
+    }, z.core.$strip>>;
+    customerId: z.ZodOptional<z.ZodString>;
+    customerGroupIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export declare const PromotionResponseSchema: z.ZodObject<{
+    data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strip>;
+export declare const listPromotionsRoute: {
+    method: "get";
+    path: "/";
+    tags: string[];
+    summary: string;
+    description: string;
+    request: {
+        query: z.ZodObject<{
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                scheduled: "scheduled";
+                inactive: "inactive";
+                expired: "expired";
+            }>>;
+        }, z.core.$strip>;
+    };
+    responses: {
+        200: {
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                    }, z.core.$strip>;
+                };
+            };
+            description: string;
+        };
+    };
+} & {
+    getRoutingPath(): "/";
+};
+export declare const createPromotionRoute: {
+    method: "post";
+    path: "/";
+    tags: string[];
+    summary: string;
+    request: {
+        body: {
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        name: z.ZodString;
+                        type: z.ZodEnum<{
+                            percentage_off_order: "percentage_off_order";
+                            fixed_off_order: "fixed_off_order";
+                            percentage_off_item: "percentage_off_item";
+                            fixed_off_item: "fixed_off_item";
+                            free_shipping: "free_shipping";
+                            buy_x_get_y: "buy_x_get_y";
+                        }>;
+                        value: z.ZodNumber;
+                        code: z.ZodOptional<z.ZodString>;
+                        buyQuantity: z.ZodOptional<z.ZodNumber>;
+                        getQuantity: z.ZodOptional<z.ZodNumber>;
+                        isAutomatic: z.ZodOptional<z.ZodBoolean>;
+                        isActive: z.ZodOptional<z.ZodBoolean>;
+                        priority: z.ZodOptional<z.ZodNumber>;
+                        conditions: z.ZodOptional<z.ZodObject<{
+                            minimumOrderValue: z.ZodOptional<z.ZodNumber>;
+                            minimumQuantity: z.ZodOptional<z.ZodNumber>;
+                            entityTypes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                            categories: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                            customerGroups: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                        }, z.core.$strip>>;
+                        usageLimitTotal: z.ZodOptional<z.ZodNumber>;
+                        usageLimitPerCustomer: z.ZodOptional<z.ZodNumber>;
+                        validFrom: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+                        validUntil: z.ZodOptional<z.ZodCoercedDate<unknown>>;
+                        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                    }, z.core.$strip>;
+                };
+            };
+            required: true;
+        };
+    };
+    responses: {
+        400: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Business logic error.";
+        };
+        401: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Authentication required.";
+        };
+        403: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Insufficient permissions.";
+        };
+        404: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Resource not found.";
+        };
+        422: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Validation error.";
+        };
+        201: {
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+                    }, z.core.$strip>;
+                };
+            };
+            description: string;
+        };
+    };
+} & {
+    getRoutingPath(): "/";
+};
+export declare const validatePromotionRoute: {
+    method: "post";
+    path: "/validate";
+    tags: string[];
+    summary: string;
+    request: {
+        body: {
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        code: z.ZodString;
+                        currency: z.ZodString;
+                        subtotal: z.ZodNumber;
+                        lineItems: z.ZodArray<z.ZodObject<{
+                            entityId: z.ZodString;
+                            entityType: z.ZodString;
+                            quantity: z.ZodNumber;
+                            unitPrice: z.ZodNumber;
+                            totalPrice: z.ZodNumber;
+                        }, z.core.$strip>>;
+                        customerId: z.ZodOptional<z.ZodString>;
+                        customerGroupIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                    }, z.core.$strip>;
+                };
+            };
+            required: true;
+        };
+    };
+    responses: {
+        400: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Business logic error.";
+        };
+        401: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Authentication required.";
+        };
+        403: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Insufficient permissions.";
+        };
+        404: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Resource not found.";
+        };
+        422: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Validation error.";
+        };
+        200: {
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+                    }, z.core.$strip>;
+                };
+            };
+            description: string;
+        };
+    };
+} & {
+    getRoutingPath(): "/validate";
+};
+export declare const deactivatePromotionRoute: {
+    method: "post";
+    path: "/{id}/deactivate";
+    tags: string[];
+    summary: string;
+    request: {
+        params: z.ZodObject<{
+            id: z.ZodUUID;
+        }, z.core.$strip>;
+    };
+    responses: {
+        400: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Business logic error.";
+        };
+        401: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Authentication required.";
+        };
+        403: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Insufficient permissions.";
+        };
+        404: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Resource not found.";
+        };
+        422: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Validation error.";
+        };
+        200: {
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+                    }, z.core.$strip>;
+                };
+            };
+            description: string;
+        };
+    };
+} & {
+    getRoutingPath(): "/:id/deactivate";
+};
+//# sourceMappingURL=promotions.d.ts.map

package/dist/interfaces/rest/schemas/promotions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promotions.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/rest/schemas/promotions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAe,MAAM,mBAAmB,CAAC;AAKnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnF,OAAO,EAAE,yBAAyB,EAAE,CAAC;AAErC,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;iBAaF,CAAC;AAIvC,eAAO,MAAM,uBAAuB;;iBAEL,CAAC;AAUhC,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiB9B,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoB/B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoBjC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAenC,CAAC"}

package/dist/interfaces/rest/schemas/promotions.js

@@ -0,0 +1,104 @@
+import { z, createRoute } from "@hono/zod-openapi";
+import { errorResponses } from "./shared.js";
+// ─── Request Schemas ────────────────────────────────────────────────────────
+import { CreatePromotionBodySchema } from "../../../modules/promotions/schemas.js";
+export { CreatePromotionBodySchema };
+export const ValidatePromotionBodySchema = z.object({
+    code: z.string().openapi({ example: "SUMMER10" }),
+    currency: z.string().length(3).openapi({ example: "USD" }),
+    subtotal: z.number().openapi({ example: 100 }),
+    lineItems: z.array(z.object({
+        entityId: z.string(),
+        entityType: z.string(),
+        quantity: z.number().int(),
+        unitPrice: z.number(),
+        totalPrice: z.number(),
+    })),
+    customerId: z.string().optional(),
+    customerGroupIds: z.array(z.string()).optional(),
+}).openapi("ValidatePromotionRequest");
+// ─── Response Schemas ───────────────────────────────────────────────────────
+export const PromotionResponseSchema = z.object({
+    data: z.record(z.string(), z.unknown()),
+}).openapi("PromotionResponse");
+// ─── Path Params ────────────────────────────────────────────────────────────
+const PromotionIdParam = z.object({
+    id: z.uuid().openapi({ example: "550e8400-e29b-41d4-a716-446655440000" }),
+});
+// ─── Route Definitions ──────────────────────────────────────────────────────
+export const listPromotionsRoute = createRoute({
+    method: "get",
+    path: "/",
+    tags: ["Promotions"],
+    summary: "List promotions",
+    description: "Lists promotions. Filter by status: active (currently valid), inactive (deactivated), expired (past validUntil), scheduled (future validFrom). Omit status to return all.",
+    request: {
+        query: z.object({
+            status: z.enum(["active", "inactive", "expired", "scheduled"]).optional().openapi({ example: "active" }),
+        }),
+    },
+    responses: {
+        200: {
+            content: { "application/json": { schema: z.object({ data: z.array(z.record(z.string(), z.unknown())) }) } },
+            description: "Promotions list",
+        },
+    },
+});
+export const createPromotionRoute = createRoute({
+    method: "post",
+    path: "/",
+    tags: ["Promotions"],
+    summary: "Create a new promotion",
+    request: {
+        body: {
+            content: {
+                "application/json": { schema: CreatePromotionBodySchema },
+            },
+            required: true,
+        },
+    },
+    responses: {
+        201: {
+            content: { "application/json": { schema: PromotionResponseSchema } },
+            description: "Promotion created successfully.",
+        },
+        ...errorResponses,
+    },
+});
+export const validatePromotionRoute = createRoute({
+    method: "post",
+    path: "/validate",
+    tags: ["Promotions"],
+    summary: "Validate a promotion code against a cart",
+    request: {
+        body: {
+            content: {
+                "application/json": { schema: ValidatePromotionBodySchema },
+            },
+            required: true,
+        },
+    },
+    responses: {
+        200: {
+            content: { "application/json": { schema: PromotionResponseSchema } },
+            description: "Promotion validation result.",
+        },
+        ...errorResponses,
+    },
+});
+export const deactivatePromotionRoute = createRoute({
+    method: "post",
+    path: "/{id}/deactivate",
+    tags: ["Promotions"],
+    summary: "Deactivate a promotion",
+    request: {
+        params: PromotionIdParam,
+    },
+    responses: {
+        200: {
+            content: { "application/json": { schema: PromotionResponseSchema } },
+            description: "Promotion deactivated.",
+        },
+        ...errorResponses,
+    },
+});