@instockng/api-client 1.0.3 → 1.0.4

package/dist/apps/backend/src/validators/delivery-zone.js

@@ -0,0 +1,51 @@
+import { z } from 'zod';
+export const createStateSchema = z.object({
+    name: z.string().min(1),
+    isActive: z.boolean().optional(),
+});
+export const updateStateSchema = z.object({
+    name: z.string().min(1).optional(),
+    isActive: z.boolean().optional(),
+});
+export const createDeliveryZoneSchema = z
+    .object({
+    stateId: z.uuid(),
+    brandId: z.uuid().nullable().optional(),
+    name: z.string().min(1),
+    deliveryCost: z.number().nonnegative(),
+    freeShippingThreshold: z.number().nonnegative().nullable().optional(),
+    allowCOD: z.boolean().optional(),
+    allowOnline: z.boolean().optional(),
+    waybillOnly: z.boolean().optional(),
+    estimatedDays: z.number().int().positive().nullable().optional(),
+    isActive: z.boolean().optional(),
+})
+    .refine((data) => {
+    // If waybillOnly is true, allowCOD must be false
+    if (data.waybillOnly && data.allowCOD !== false) {
+        return false;
+    }
+    return true;
+}, {
+    message: 'When waybillOnly is true, allowCOD must be false',
+});
+export const updateDeliveryZoneSchema = z
+    .object({
+    name: z.string().min(1).optional(),
+    deliveryCost: z.number().nonnegative().optional(),
+    freeShippingThreshold: z.number().nonnegative().nullable().optional(),
+    allowCOD: z.boolean().optional(),
+    allowOnline: z.boolean().optional(),
+    waybillOnly: z.boolean().optional(),
+    estimatedDays: z.number().int().positive().nullable().optional(),
+    isActive: z.boolean().optional(),
+})
+    .refine((data) => {
+    // If waybillOnly is being set to true, allowCOD must be false
+    if (data.waybillOnly && data.allowCOD !== false && data.allowCOD !== undefined) {
+        return false;
+    }
+    return true;
+}, {
+    message: 'When waybillOnly is true, allowCOD must be false',
+});

package/dist/apps/backend/src/validators/discount-code.d.ts

@@ -0,0 +1,74 @@
+import { z } from 'zod';
+export declare const createDiscountCodeSchema: z.ZodObject<{
+    code: z.ZodString;
+    brandId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    type: z.ZodEnum<{
+        fixed: "fixed";
+        percentage: "percentage";
+    }>;
+    value: z.ZodNumber;
+    description: z.ZodOptional<z.ZodString>;
+    category: z.ZodDefault<z.ZodEnum<{
+        recovery: "recovery";
+        manual: "manual";
+        influencer: "influencer";
+        seasonal: "seasonal";
+        referral: "referral";
+    }>>;
+    minPurchase: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    maxDiscount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    usageLimit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    perCustomerLimit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    validFrom: z.ZodOptional<z.ZodString>;
+    validUntil: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    isActive: z.ZodDefault<z.ZodBoolean>;
+    isAutoApply: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const updateDiscountCodeSchema: z.ZodObject<{
+    code: z.ZodOptional<z.ZodString>;
+    type: z.ZodOptional<z.ZodEnum<{
+        fixed: "fixed";
+        percentage: "percentage";
+    }>>;
+    value: z.ZodOptional<z.ZodNumber>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    category: z.ZodOptional<z.ZodEnum<{
+        recovery: "recovery";
+        manual: "manual";
+        influencer: "influencer";
+        seasonal: "seasonal";
+        referral: "referral";
+    }>>;
+    minPurchase: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    maxDiscount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    usageLimit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    perCustomerLimit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    validFrom: z.ZodOptional<z.ZodString>;
+    validUntil: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    isActive: z.ZodOptional<z.ZodBoolean>;
+    isAutoApply: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const bulkGenerateCodesSchema: z.ZodObject<{
+    prefix: z.ZodString;
+    count: z.ZodNumber;
+    brandId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    type: z.ZodEnum<{
+        fixed: "fixed";
+        percentage: "percentage";
+    }>;
+    value: z.ZodNumber;
+    description: z.ZodOptional<z.ZodString>;
+    category: z.ZodDefault<z.ZodEnum<{
+        recovery: "recovery";
+        manual: "manual";
+        influencer: "influencer";
+        seasonal: "seasonal";
+        referral: "referral";
+    }>>;
+    minPurchase: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    maxDiscount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    perCustomerLimit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    validFrom: z.ZodOptional<z.ZodString>;
+    validUntil: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    isActive: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;

package/dist/apps/backend/src/validators/discount-code.js

@@ -0,0 +1,50 @@
+import { z } from 'zod';
+// Create discount code schema
+export const createDiscountCodeSchema = z.object({
+    code: z.string().min(1).max(50).regex(/^[A-Z0-9-]+$/, 'Code must contain only uppercase letters, numbers, and hyphens'),
+    brandId: z.string().uuid().nullable().optional(),
+    type: z.enum(['percentage', 'fixed']),
+    value: z.number().positive(), // Percentage (e.g., 10.00 for 10%) or fixed amount in Naira
+    description: z.string().min(1).max(500).optional(),
+    category: z.enum(['manual', 'recovery', 'influencer', 'seasonal', 'referral']).default('manual'),
+    minPurchase: z.number().nonnegative().nullable().optional(), // Minimum purchase in Naira
+    maxDiscount: z.number().positive().nullable().optional(), // Max discount in Naira
+    usageLimit: z.number().int().positive().nullable().optional(),
+    perCustomerLimit: z.number().int().positive().nullable().optional(),
+    validFrom: z.string().datetime().optional(),
+    validUntil: z.string().datetime().nullable().optional(),
+    isActive: z.boolean().default(true),
+    isAutoApply: z.boolean().default(false),
+});
+// Update discount code schema (all fields optional)
+export const updateDiscountCodeSchema = z.object({
+    code: z.string().min(1).max(50).regex(/^[A-Z0-9-]+$/).optional(),
+    type: z.enum(['percentage', 'fixed']).optional(),
+    value: z.number().positive().optional(), // Percentage or fixed amount in Naira
+    description: z.string().min(1).max(500).nullable().optional(),
+    category: z.enum(['manual', 'recovery', 'influencer', 'seasonal', 'referral']).optional(),
+    minPurchase: z.number().nonnegative().nullable().optional(), // Minimum purchase in Naira
+    maxDiscount: z.number().positive().nullable().optional(), // Max discount in Naira
+    usageLimit: z.number().int().positive().nullable().optional(),
+    perCustomerLimit: z.number().int().positive().nullable().optional(),
+    validFrom: z.string().datetime().optional(),
+    validUntil: z.string().datetime().nullable().optional(),
+    isActive: z.boolean().optional(),
+    isAutoApply: z.boolean().optional(),
+});
+// Bulk generate discount codes schema
+export const bulkGenerateCodesSchema = z.object({
+    prefix: z.string().min(1).max(20).regex(/^[A-Z0-9-]+$/),
+    count: z.number().int().positive().max(1000), // Max 1000 codes at once
+    brandId: z.string().uuid().nullable().optional(),
+    type: z.enum(['percentage', 'fixed']),
+    value: z.number().positive(), // Percentage or fixed amount in Naira
+    description: z.string().min(1).max(500).optional(),
+    category: z.enum(['manual', 'recovery', 'influencer', 'seasonal', 'referral']).default('manual'),
+    minPurchase: z.number().nonnegative().nullable().optional(), // Minimum purchase in Naira
+    maxDiscount: z.number().positive().nullable().optional(), // Max discount in Naira
+    perCustomerLimit: z.number().int().positive().nullable().optional(),
+    validFrom: z.string().datetime().optional(),
+    validUntil: z.string().datetime().nullable().optional(),
+    isActive: z.boolean().default(true),
+});

package/dist/apps/backend/src/validators/inventory.d.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+export declare const adjustInventorySchema: z.ZodObject<{
+    variantId: z.ZodUUID;
+    warehouseId: z.ZodUUID;
+    quantity: z.ZodNumber;
+    type: z.ZodEnum<{
+        restock: "restock";
+        adjustment: "adjustment";
+        damaged: "damaged";
+        initial: "initial";
+    }>;
+    reason: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const transferInventorySchema: z.ZodObject<{
+    variantId: z.ZodUUID;
+    fromWarehouseId: z.ZodUUID;
+    toWarehouseId: z.ZodUUID;
+    quantity: z.ZodNumber;
+    reason: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;

package/dist/apps/backend/src/validators/inventory.js

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export const adjustInventorySchema = z.object({
+    variantId: z.uuid(),
+    warehouseId: z.uuid(),
+    quantity: z.number().int(),
+    type: z.enum(['restock', 'adjustment', 'damaged', 'initial']),
+    reason: z.string().optional(),
+});
+export const transferInventorySchema = z.object({
+    variantId: z.uuid(),
+    fromWarehouseId: z.uuid(),
+    toWarehouseId: z.uuid(),
+    quantity: z.number().int().positive(),
+    reason: z.string().optional(),
+});

package/dist/apps/backend/src/validators/order.d.ts

@@ -0,0 +1,87 @@
+import { z } from 'zod';
+export declare const createOrderSchema: z.ZodObject<{
+    brandSlug: z.ZodString;
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    phone: z.ZodString;
+    address: z.ZodString;
+    city: z.ZodString;
+    deliveryZoneId: z.ZodString;
+    deliveryCharge: z.ZodNumber;
+    items: z.ZodArray<z.ZodObject<{
+        sku: z.ZodString;
+        quantity: z.ZodNumber;
+    }, z.core.$strip>>;
+    discount: z.ZodOptional<z.ZodNumber>;
+    paymentMethod: z.ZodEnum<{
+        cod: "cod";
+        online: "online";
+    }>;
+    paystackReference: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const updateOrderSchema: z.ZodObject<{
+    brandSlug: z.ZodOptional<z.ZodString>;
+    firstName: z.ZodOptional<z.ZodString>;
+    lastName: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    address: z.ZodOptional<z.ZodString>;
+    city: z.ZodOptional<z.ZodString>;
+    deliveryZoneId: z.ZodOptional<z.ZodString>;
+    deliveryCharge: z.ZodOptional<z.ZodNumber>;
+    discount: z.ZodOptional<z.ZodNumber>;
+    paymentMethod: z.ZodOptional<z.ZodEnum<{
+        cod: "cod";
+        online: "online";
+    }>>;
+    paystackReference: z.ZodOptional<z.ZodString>;
+    items: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        sku: z.ZodString;
+        quantity: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export declare const updateOrderStatusSchema: z.ZodObject<{
+    status: z.ZodEnum<{
+        pending: "pending";
+        shipped: "shipped";
+        delivered: "delivered";
+        cancelled: "cancelled";
+        returned: "returned";
+        prospect: "prospect";
+    }>;
+    cancellationReason: z.ZodOptional<z.ZodString>;
+    prospectReason: z.ZodOptional<z.ZodEnum<{
+        other: "other";
+        no_answer: "no_answer";
+        thinking: "thinking";
+        price_concern: "price_concern";
+        will_call_back: "will_call_back";
+        unclear_commitment: "unclear_commitment";
+        payment_issue: "payment_issue";
+    }>>;
+    prospectNote: z.ZodOptional<z.ZodString>;
+    warehouses: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        orderItemId: z.ZodUUID;
+        warehouseId: z.ZodUUID;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export declare const orderFiltersSchema: z.ZodObject<{
+    brandId: z.ZodOptional<z.ZodUUID>;
+    status: z.ZodOptional<z.ZodEnum<{
+        pending: "pending";
+        shipped: "shipped";
+        delivered: "delivered";
+        cancelled: "cancelled";
+        returned: "returned";
+        prospect: "prospect";
+    }>>;
+    paymentMethod: z.ZodOptional<z.ZodEnum<{
+        cod: "cod";
+        online: "online";
+    }>>;
+    warehouseId: z.ZodOptional<z.ZodUUID>;
+    search: z.ZodOptional<z.ZodString>;
+    startDate: z.ZodOptional<z.ZodString>;
+    endDate: z.ZodOptional<z.ZodString>;
+    page: z.ZodOptional<z.ZodNumber>;
+    limit: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;

package/dist/apps/backend/src/validators/order.js

@@ -0,0 +1,61 @@
+import { z } from 'zod';
+import { OrderStatusSchema, ProspectReasonSchema, PaymentMethodSchema } from '../generated/zod';
+// Order creation schema (public API)
+export const createOrderSchema = z.object({
+    brandSlug: z.string().min(1),
+    firstName: z.string().min(1),
+    lastName: z.string().min(1),
+    phone: z.string().min(1),
+    address: z.string().min(1),
+    city: z.string().min(1),
+    deliveryZoneId: z.string().uuid(),
+    deliveryCharge: z.number().nonnegative(),
+    items: z.array(z.object({
+        sku: z.string().min(1),
+        quantity: z.number().int().positive(),
+    })).min(1),
+    discount: z.number().nonnegative().optional(),
+    paymentMethod: PaymentMethodSchema,
+    paystackReference: z.string().optional(),
+});
+// Update order schema (admin API)
+export const updateOrderSchema = z.object({
+    brandSlug: z.string().min(1).optional(),
+    firstName: z.string().min(1).optional(),
+    lastName: z.string().min(1).optional(),
+    phone: z.string().min(1).optional(),
+    address: z.string().min(1).optional(),
+    city: z.string().min(1).optional(),
+    deliveryZoneId: z.string().uuid().optional(),
+    deliveryCharge: z.number().nonnegative().optional(),
+    discount: z.number().nonnegative().optional(),
+    paymentMethod: PaymentMethodSchema.optional(),
+    paystackReference: z.string().optional(),
+    items: z.array(z.object({
+        sku: z.string().min(1),
+        quantity: z.number().int().positive(),
+    })).optional(),
+});
+// Update order status schema
+export const updateOrderStatusSchema = z.object({
+    status: OrderStatusSchema,
+    cancellationReason: z.string().optional(),
+    prospectReason: ProspectReasonSchema.optional(),
+    prospectNote: z.string().optional(),
+    warehouses: z.array(z.object({
+        orderItemId: z.uuid(),
+        warehouseId: z.uuid(),
+    })).optional(), // Required when status is 'shipped'
+});
+// Order filter schema
+export const orderFiltersSchema = z.object({
+    brandId: z.uuid().optional(),
+    status: OrderStatusSchema.optional(),
+    paymentMethod: PaymentMethodSchema.optional(),
+    warehouseId: z.uuid().optional(),
+    search: z.string().optional(), // Search by order number, customer name, phone
+    startDate: z.string().optional(),
+    endDate: z.string().optional(),
+    page: z.number().int().positive().optional(),
+    limit: z.number().int().positive().max(100).optional(),
+});

package/dist/apps/backend/src/validators/product.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+export declare const createProductSchema: z.ZodObject<{
+    brandId: z.ZodString;
+    name: z.ZodString;
+    slug: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    thumbnailUrl: z.ZodOptional<z.ZodString>;
+    quantityDiscounts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    isActive: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const updateProductSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    slug: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    thumbnailUrl: z.ZodOptional<z.ZodString>;
+    quantityDiscounts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    isActive: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;

package/dist/apps/backend/src/validators/product.js

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+const quantityDiscountsSchema = z.record(z.string().regex(/^\d+$/, 'Quantity must be a number'), z.number().int().min(0).max(100, 'Discount must be between 0 and 100')).optional();
+export const createProductSchema = z.object({
+    brandId: z.string().uuid(),
+    name: z.string().min(1),
+    slug: z.string().min(1).regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, 'Slug must be lowercase letters, numbers, and hyphens only'),
+    description: z.string().optional(),
+    thumbnailUrl: z.string().url().optional(),
+    quantityDiscounts: quantityDiscountsSchema,
+    isActive: z.boolean().optional(),
+});
+export const updateProductSchema = z.object({
+    name: z.string().min(1).optional(),
+    slug: z.string().min(1).regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, 'Slug must be lowercase letters, numbers, and hyphens only').optional(),
+    description: z.string().optional(),
+    thumbnailUrl: z.string().url().optional(),
+    quantityDiscounts: quantityDiscountsSchema,
+    isActive: z.boolean().optional(),
+});

package/dist/apps/backend/src/validators/variant.d.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+export declare const createVariantSchema: z.ZodObject<{
+    sku: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    thumbnailUrl: z.ZodOptional<z.ZodURL>;
+    price: z.ZodNumber;
+    trackInventory: z.ZodOptional<z.ZodBoolean>;
+    lowStockThreshold: z.ZodOptional<z.ZodNumber>;
+    isActive: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const updateVariantSchema: z.ZodObject<{
+    sku: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    thumbnailUrl: z.ZodOptional<z.ZodString>;
+    price: z.ZodOptional<z.ZodNumber>;
+    trackInventory: z.ZodOptional<z.ZodBoolean>;
+    lowStockThreshold: z.ZodOptional<z.ZodNumber>;
+    isActive: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;

package/dist/apps/backend/src/validators/variant.js

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+export const createVariantSchema = z.object({
+    sku: z.string().min(1),
+    name: z.string().optional(),
+    thumbnailUrl: z.url().optional(),
+    price: z.number().positive(), // Price in Naira
+    trackInventory: z.boolean().optional(),
+    lowStockThreshold: z.number().int().nonnegative().optional(),
+    isActive: z.boolean().optional(),
+});
+export const updateVariantSchema = z.object({
+    sku: z.string().min(1).optional(),
+    name: z.string().optional(),
+    thumbnailUrl: z.string().url().optional(),
+    price: z.number().positive().optional(), // Price in Naira
+    trackInventory: z.boolean().optional(),
+    lowStockThreshold: z.number().int().nonnegative().optional(),
+    isActive: z.boolean().optional(),
+});

package/dist/apps/backend/src/validators/warehouse.d.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export declare const createWarehouseSchema: z.ZodObject<{
+    name: z.ZodString;
+    address: z.ZodOptional<z.ZodString>;
+    city: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodString>;
+    isActive: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const updateWarehouseSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    address: z.ZodOptional<z.ZodString>;
+    city: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodString>;
+    isActive: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;

package/dist/apps/backend/src/validators/warehouse.js

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export const createWarehouseSchema = z.object({
+    name: z.string().min(1),
+    address: z.string().optional(),
+    city: z.string().optional(),
+    state: z.string().optional(),
+    isActive: z.boolean().optional(),
+});
+export const updateWarehouseSchema = z.object({
+    name: z.string().min(1).optional(),
+    address: z.string().optional(),
+    city: z.string().optional(),
+    state: z.string().optional(),
+    isActive: z.boolean().optional(),
+});