wiil-core-js 0.0.82

package/dist/core/business-mgt/product-management/product-pricing-rule.schema.d.ts

@@ -0,0 +1,167 @@
+import { z } from "zod";
+import { PricingChannel } from "../pricing-rule.shared.schema";
+/**
+ * @fileoverview Product pricing rule schema definitions for promotions and discounts.
+ * @module business-mgt/product-pricing-rule
+ */
+/**
+ * Product pricing rule condition schema.
+ * Extends common pricing conditions with product set targeting.
+ */
+export declare const ProductPricingRuleConditionSchema: z.ZodObject<{
+    daysOfWeek: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+    startMinute: z.ZodOptional<z.ZodNumber>;
+    endMinute: z.ZodOptional<z.ZodNumber>;
+    customerSegmentIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    channel: z.ZodDefault<z.ZodEnum<typeof PricingChannel>>;
+    productSetId: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Product pricing rule schema.
+ * Defines promotional pricing logic applied to product orders.
+ */
+export declare const ProductPricingRuleSchema: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodOptional<z.ZodNumber>;
+    updatedAt: z.ZodOptional<z.ZodNumber>;
+    locationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodString;
+    channelMappings: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        channelId: z.ZodString;
+        externalPricingRuleId: z.ZodString;
+    }, z.core.$strip>>>>;
+    discountId: z.ZodString;
+    productSetRevisionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    condition: z.ZodObject<{
+        daysOfWeek: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+        startMinute: z.ZodOptional<z.ZodNumber>;
+        endMinute: z.ZodOptional<z.ZodNumber>;
+        customerSegmentIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        channel: z.ZodDefault<z.ZodEnum<typeof PricingChannel>>;
+        productSetId: z.ZodString;
+    }, z.core.$strip>;
+    effectiveFrom: z.ZodOptional<z.ZodNumber>;
+    effectiveTo: z.ZodOptional<z.ZodNumber>;
+    isActive: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Schema for creating a new product pricing rule.
+ * Omits auto-generated fields.
+ */
+export declare const CreateProductPricingRuleSchema: z.ZodObject<{
+    name: z.ZodString;
+    isActive: z.ZodDefault<z.ZodBoolean>;
+    locationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    effectiveFrom: z.ZodOptional<z.ZodNumber>;
+    effectiveTo: z.ZodOptional<z.ZodNumber>;
+    channelMappings: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        channelId: z.ZodString;
+        externalPricingRuleId: z.ZodString;
+    }, z.core.$strip>>>>;
+    discountId: z.ZodString;
+    condition: z.ZodObject<{
+        daysOfWeek: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+        startMinute: z.ZodOptional<z.ZodNumber>;
+        endMinute: z.ZodOptional<z.ZodNumber>;
+        customerSegmentIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        channel: z.ZodDefault<z.ZodEnum<typeof PricingChannel>>;
+        productSetId: z.ZodString;
+    }, z.core.$strip>;
+    productSetRevisionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    placement: z.ZodOptional<z.ZodObject<{
+        placementIntent: z.ZodObject<{
+            mode: z.ZodEnum<{
+                BEGINNING: "BEGINNING";
+                END: "END";
+                KEEP_CURRENT: "KEEP_CURRENT";
+                BEFORE_ITEM: "BEFORE_ITEM";
+                AFTER_ITEM: "AFTER_ITEM";
+                ABSOLUTE_INDEX: "ABSOLUTE_INDEX";
+            }>;
+        }, z.core.$strip>;
+        anchorItemId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        absoluteIndex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Schema for updating an existing product pricing rule.
+ * All fields optional except id (required).
+ */
+export declare const UpdateProductPricingRuleSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    isActive: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    locationId: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    effectiveFrom: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+    effectiveTo: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+    channelMappings: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        channelId: z.ZodString;
+        externalPricingRuleId: z.ZodString;
+    }, z.core.$strip>>>>>;
+    discountId: z.ZodOptional<z.ZodString>;
+    condition: z.ZodOptional<z.ZodObject<{
+        daysOfWeek: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+        startMinute: z.ZodOptional<z.ZodNumber>;
+        endMinute: z.ZodOptional<z.ZodNumber>;
+        customerSegmentIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        channel: z.ZodDefault<z.ZodEnum<typeof PricingChannel>>;
+        productSetId: z.ZodString;
+    }, z.core.$strip>>;
+    productSetRevisionId: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    placement: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+        placementIntent: z.ZodObject<{
+            mode: z.ZodEnum<{
+                BEGINNING: "BEGINNING";
+                END: "END";
+                KEEP_CURRENT: "KEEP_CURRENT";
+                BEFORE_ITEM: "BEFORE_ITEM";
+                AFTER_ITEM: "AFTER_ITEM";
+                ABSOLUTE_INDEX: "ABSOLUTE_INDEX";
+            }>;
+        }, z.core.$strip>;
+        anchorItemId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        absoluteIndex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+    id: z.ZodString;
+}, z.core.$strip>;
+export type ProductPricingRuleCondition = z.infer<typeof ProductPricingRuleConditionSchema>;
+export type ProductPricingRule = z.infer<typeof ProductPricingRuleSchema>;
+export type CreateProductPricingRule = z.infer<typeof CreateProductPricingRuleSchema>;
+export type UpdateProductPricingRule = z.infer<typeof UpdateProductPricingRuleSchema>;
+/**
+ * Product pricing rule filter options.
+ * @interface ProductPricingRuleFilters
+ */
+export interface ProductPricingRuleFilters {
+    /** Text search across rule name */
+    search?: string;
+    /** Filter by location ID */
+    locationId?: string;
+    /** Filter by pricing channel */
+    channel?: PricingChannel;
+    /** Filter by active status */
+    isActive?: boolean;
+}
+/**
+ * Product pricing rule sorting options.
+ * @interface ProductPricingRuleSorting
+ */
+export interface ProductPricingRuleSorting {
+    /** Field to sort by */
+    field: "name" | "createdAt";
+    /** Sort direction */
+    direction: "asc" | "desc";
+}
+/**
+ * Product pricing rule query options.
+ * @interface ProductPricingRuleQueryOptions
+ */
+export interface ProductPricingRuleQueryOptions {
+    /** Page number (1-indexed) */
+    page: number;
+    /** Items per page */
+    pageSize: number;
+    /** Optional filters */
+    filters?: ProductPricingRuleFilters;
+    /** Optional sorting */
+    sorting?: ProductPricingRuleSorting;
+}

package/dist/core/business-mgt/product-management/product-pricing-rule.schema.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateProductPricingRuleSchema = exports.CreateProductPricingRuleSchema = exports.ProductPricingRuleSchema = exports.ProductPricingRuleConditionSchema = void 0;
+const zod_1 = require("zod");
+const base_schema_1 = require("../../base.schema");
+const display_order_1 = require("../../type-definitions/display-order");
+const pricing_rule_shared_schema_1 = require("../pricing-rule.shared.schema");
+/**
+ * @fileoverview Product pricing rule schema definitions for promotions and discounts.
+ * @module business-mgt/product-pricing-rule
+ */
+// ============================================================================
+// CONDITION SCHEMA
+// ============================================================================
+/**
+ * Product pricing rule condition schema.
+ * Extends common pricing conditions with product set targeting.
+ */
+exports.ProductPricingRuleConditionSchema = pricing_rule_shared_schema_1.PricingRuleCommonConditionSchema.safeExtend({
+    productSetId: zod_1.z.string().min(1).describe("References ProductSet that defines which products this pricing rule applies to. The rule activates when cart contents match the set criteria."),
+});
+// ============================================================================
+// PRICING RULE SCHEMA
+// ============================================================================
+/**
+ * Product pricing rule schema.
+ * Defines promotional pricing logic applied to product orders.
+ */
+exports.ProductPricingRuleSchema = base_schema_1.BaseModelSchema.safeExtend({
+    locationId: zod_1.z.string().nullable().optional().describe("Business location ID for location-specific pricing rules. Null applies to all locations."),
+    name: zod_1.z.string().min(1).max(120).describe("Display name for this pricing rule (e.g., 'Summer Sale 20% Off', 'Buy 2 Get 1 Free'). Shown to staff and in reports."),
+    channelMappings: zod_1.z.array(pricing_rule_shared_schema_1.PricingRuleChannelMappingSchema).nullable().optional().describe("Per-channel pricing rule ID mappings for external platform synchronization."),
+    discountId: zod_1.z.string().min(1).describe("References DiscountRule that defines the discount type and value to apply when this rule matches."),
+    productSetRevisionId: zod_1.z.string().nullable().optional().describe("Optional product set revision ID for version-scoped rule targeting. Ensures rule applies to specific catalog version."),
+    condition: exports.ProductPricingRuleConditionSchema.describe("Condition criteria that must be met for this pricing rule to apply. Includes product set targeting and quantity requirements."),
+    effectiveFrom: zod_1.z.number().int().nonnegative().optional().describe("Unix timestamp when this pricing rule becomes active. Rule is inactive before this time."),
+    effectiveTo: zod_1.z.number().int().nonnegative().optional().describe("Unix timestamp when this pricing rule expires. Rule is inactive after this time."),
+    isActive: zod_1.z.boolean().default(true).describe("Whether this pricing rule is currently active. Inactive rules are not applied even if conditions match. Defaults to true."),
+}).superRefine((data, ctx) => {
+    if (data.effectiveFrom !== undefined && data.effectiveTo !== undefined && data.effectiveTo < data.effectiveFrom) {
+        ctx.addIssue({
+            code: "custom",
+            path: ["effectiveTo"],
+            message: "effectiveTo must be greater than or equal to effectiveFrom",
+        });
+    }
+});
+// ============================================================================
+// CREATE/UPDATE SCHEMAS
+// ============================================================================
+/**
+ * Schema for creating a new product pricing rule.
+ * Omits auto-generated fields.
+ */
+exports.CreateProductPricingRuleSchema = exports.ProductPricingRuleSchema.omit({
+    id: true,
+    createdAt: true,
+    updatedAt: true,
+}).safeExtend({
+    placement: display_order_1.CreateDisplayOrderPlacementSchema.optional().describe("Optional placement for display ordering"),
+});
+/**
+ * Schema for updating an existing product pricing rule.
+ * All fields optional except id (required).
+ */
+exports.UpdateProductPricingRuleSchema = exports.CreateProductPricingRuleSchema.partial().safeExtend({
+    id: zod_1.z.string().describe("Unique identifier of the ProductPricingRule to update"),
+});