@aveliya/contracts 1.0.0

package/dist/checkout-config.js

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export const bankInstructionsSchema = z.object({
+    bankName: z.string().trim().min(1), accountTitle: z.string().trim().min(1),
+    accountNumber: z.string().trim().min(1), instructions: z.string().trim().min(1),
+});
+export const checkoutConfigSchema = z.object({
+    paymentMethods: z.array(z.enum(['cod', 'bank-transfer'])).min(1),
+    bankTransfer: bankInstructionsSchema.nullable(),
+}).refine(value => !value.paymentMethods.includes('bank-transfer') || value.bankTransfer !== null, 'Enabled bank transfer requires public instructions');

package/dist/checkout.d.ts

@@ -0,0 +1,100 @@
+import { z } from 'zod';
+export declare const checkoutQuoteSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        productId: z.ZodString;
+        variantId: z.ZodString;
+        name: z.ZodString;
+        slug: z.ZodString;
+        imageUrl: z.ZodString;
+        colorName: z.ZodString;
+        sizeLabel: z.ZodString;
+        unitPrice: z.ZodNumber;
+        quantity: z.ZodNumber;
+        lineSubtotal: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        quantity: number;
+        imageUrl: string;
+        slug: string;
+        name: string;
+        variantId: string;
+        productId: string;
+        colorName: string;
+        sizeLabel: string;
+        unitPrice: number;
+        lineSubtotal: number;
+    }, {
+        quantity: number;
+        imageUrl: string;
+        slug: string;
+        name: string;
+        variantId: string;
+        productId: string;
+        colorName: string;
+        sizeLabel: string;
+        unitPrice: number;
+        lineSubtotal: number;
+    }>, "many">;
+    totals: z.ZodObject<{
+        subtotal: z.ZodNumber;
+        discount: z.ZodNumber;
+        shipping: z.ZodNumber;
+        tax: z.ZodOptional<z.ZodNumber>;
+        total: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        total: number;
+        subtotal: number;
+        discount: number;
+        shipping: number;
+        tax?: number | undefined;
+    }, {
+        total: number;
+        subtotal: number;
+        discount: number;
+        shipping: number;
+        tax?: number | undefined;
+    }>;
+    quoteFingerprint: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    items: {
+        quantity: number;
+        imageUrl: string;
+        slug: string;
+        name: string;
+        variantId: string;
+        productId: string;
+        colorName: string;
+        sizeLabel: string;
+        unitPrice: number;
+        lineSubtotal: number;
+    }[];
+    totals: {
+        total: number;
+        subtotal: number;
+        discount: number;
+        shipping: number;
+        tax?: number | undefined;
+    };
+    quoteFingerprint: string;
+}, {
+    items: {
+        quantity: number;
+        imageUrl: string;
+        slug: string;
+        name: string;
+        variantId: string;
+        productId: string;
+        colorName: string;
+        sizeLabel: string;
+        unitPrice: number;
+        lineSubtotal: number;
+    }[];
+    totals: {
+        total: number;
+        subtotal: number;
+        discount: number;
+        shipping: number;
+        tax?: number | undefined;
+    };
+    quoteFingerprint: string;
+}>;
+export type CheckoutQuote = z.infer<typeof checkoutQuoteSchema>;

package/dist/checkout.js

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+const amount = z.number().int().nonnegative();
+export const checkoutQuoteSchema = z.object({
+    items: z.array(z.object({
+        productId: z.string(), variantId: z.string(), name: z.string(), slug: z.string(),
+        imageUrl: z.string(), colorName: z.string(), sizeLabel: z.string(),
+        unitPrice: amount, quantity: z.number().int().positive(), lineSubtotal: amount,
+    })).min(1),
+    totals: z.object({
+        subtotal: amount, discount: amount, shipping: amount,
+        tax: amount.optional(), total: amount,
+    }),
+    quoteFingerprint: z.string().regex(/^[a-f0-9]{64}$/),
+});

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './admin-products.js';
+export * from './catalog-facets.js';
+export * from './categories.js';
+export * from './checkout-config.js';
+export * from './checkout.js';
+export * from './product-input.js';

package/dist/index.js

@@ -0,0 +1,6 @@
+export * from './admin-products.js';
+export * from './catalog-facets.js';
+export * from './categories.js';
+export * from './checkout-config.js';
+export * from './checkout.js';
+export * from './product-input.js';

package/dist/product-input.d.ts

@@ -0,0 +1,384 @@
+import { z } from 'zod';
+export declare const variantSchema: z.ZodObject<{
+    id: z.ZodString;
+    sku: z.ZodString;
+    colorId: z.ZodString;
+    sizeId: z.ZodString;
+    quantity: z.ZodNumber;
+    imageUrl: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    mediaId: z.ZodOptional<z.ZodString>;
+    active: z.ZodOptional<z.ZodBoolean>;
+}, "strict", z.ZodTypeAny, {
+    id: string;
+    sku: string;
+    colorId: string;
+    sizeId: string;
+    quantity: number;
+    imageUrl?: string | undefined;
+    mediaId?: string | undefined;
+    active?: boolean | undefined;
+}, {
+    id: string;
+    sku: string;
+    colorId: string;
+    sizeId: string;
+    quantity: number;
+    imageUrl?: string | undefined;
+    mediaId?: string | undefined;
+    active?: boolean | undefined;
+}>;
+export declare const productSchema: z.ZodEffects<z.ZodObject<{
+    primaryCategoryId: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodOptional<z.ZodString>;
+    updatedAt: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    slug: z.ZodString;
+    name: z.ZodString;
+    sku: z.ZodString;
+    description: z.ZodString;
+    shortDescription: z.ZodString;
+    category: z.ZodString;
+    subcategory: z.ZodString;
+    collection: z.ZodString;
+    audience: z.ZodString;
+    basePrice: z.ZodNumber;
+    salePrice: z.ZodOptional<z.ZodNumber>;
+    collections: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    active: z.ZodOptional<z.ZodBoolean>;
+    seoTitle: z.ZodOptional<z.ZodString>;
+    seoDescription: z.ZodOptional<z.ZodString>;
+    images: z.ZodArray<z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        primary: z.ZodOptional<z.ZodBoolean>;
+        order: z.ZodOptional<z.ZodNumber>;
+        colorId: z.ZodOptional<z.ZodString>;
+        variantId: z.ZodOptional<z.ZodString>;
+        type: z.ZodOptional<z.ZodLiteral<"image">>;
+        url: z.ZodEffects<z.ZodString, string, string>;
+        alt: z.ZodString;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, "strict", z.ZodTypeAny, {
+        url: string;
+        alt: string;
+        width: number;
+        height: number;
+        id?: string | undefined;
+        colorId?: string | undefined;
+        type?: "image" | undefined;
+        primary?: boolean | undefined;
+        order?: number | undefined;
+        variantId?: string | undefined;
+    }, {
+        url: string;
+        alt: string;
+        width: number;
+        height: number;
+        id?: string | undefined;
+        colorId?: string | undefined;
+        type?: "image" | undefined;
+        primary?: boolean | undefined;
+        order?: number | undefined;
+        variantId?: string | undefined;
+    }>, "many">;
+    videos: z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">;
+    colors: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        hex: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        hex: string;
+    }, {
+        id: string;
+        name: string;
+        hex: string;
+    }>, "many">;
+    sizes: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        id: string;
+        label: string;
+    }, {
+        id: string;
+        label: string;
+    }>, "many">;
+    variants: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        sku: z.ZodString;
+        colorId: z.ZodString;
+        sizeId: z.ZodString;
+        quantity: z.ZodNumber;
+        imageUrl: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+        mediaId: z.ZodOptional<z.ZodString>;
+        active: z.ZodOptional<z.ZodBoolean>;
+    }, "strict", z.ZodTypeAny, {
+        id: string;
+        sku: string;
+        colorId: string;
+        sizeId: string;
+        quantity: number;
+        imageUrl?: string | undefined;
+        mediaId?: string | undefined;
+        active?: boolean | undefined;
+    }, {
+        id: string;
+        sku: string;
+        colorId: string;
+        sizeId: string;
+        quantity: number;
+        imageUrl?: string | undefined;
+        mediaId?: string | undefined;
+        active?: boolean | undefined;
+    }>, "many">;
+    material: z.ZodString;
+    careInstructions: z.ZodArray<z.ZodString, "many">;
+    sizeAndFit: z.ZodArray<z.ZodString, "many">;
+    tags: z.ZodArray<z.ZodString, "many">;
+    badges: z.ZodArray<z.ZodEnum<["new", "bestseller", "limited", "sale"]>, "many">;
+    isFeatured: z.ZodBoolean;
+    isNew: z.ZodBoolean;
+    isBestseller: z.ZodBoolean;
+}, "strict", z.ZodTypeAny, {
+    id: string;
+    sku: string;
+    slug: string;
+    name: string;
+    description: string;
+    shortDescription: string;
+    category: string;
+    subcategory: string;
+    collection: string;
+    audience: string;
+    basePrice: number;
+    images: {
+        url: string;
+        alt: string;
+        width: number;
+        height: number;
+        id?: string | undefined;
+        colorId?: string | undefined;
+        type?: "image" | undefined;
+        primary?: boolean | undefined;
+        order?: number | undefined;
+        variantId?: string | undefined;
+    }[];
+    videos: string[];
+    colors: {
+        id: string;
+        name: string;
+        hex: string;
+    }[];
+    sizes: {
+        id: string;
+        label: string;
+    }[];
+    variants: {
+        id: string;
+        sku: string;
+        colorId: string;
+        sizeId: string;
+        quantity: number;
+        imageUrl?: string | undefined;
+        mediaId?: string | undefined;
+        active?: boolean | undefined;
+    }[];
+    material: string;
+    careInstructions: string[];
+    sizeAndFit: string[];
+    tags: string[];
+    badges: ("new" | "bestseller" | "limited" | "sale")[];
+    isFeatured: boolean;
+    isNew: boolean;
+    isBestseller: boolean;
+    active?: boolean | undefined;
+    primaryCategoryId?: string | undefined;
+    collections?: string[] | undefined;
+    seoTitle?: string | undefined;
+    seoDescription?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    salePrice?: number | undefined;
+}, {
+    id: string;
+    sku: string;
+    slug: string;
+    name: string;
+    description: string;
+    shortDescription: string;
+    category: string;
+    subcategory: string;
+    collection: string;
+    audience: string;
+    basePrice: number;
+    images: {
+        url: string;
+        alt: string;
+        width: number;
+        height: number;
+        id?: string | undefined;
+        colorId?: string | undefined;
+        type?: "image" | undefined;
+        primary?: boolean | undefined;
+        order?: number | undefined;
+        variantId?: string | undefined;
+    }[];
+    videos: string[];
+    colors: {
+        id: string;
+        name: string;
+        hex: string;
+    }[];
+    sizes: {
+        id: string;
+        label: string;
+    }[];
+    variants: {
+        id: string;
+        sku: string;
+        colorId: string;
+        sizeId: string;
+        quantity: number;
+        imageUrl?: string | undefined;
+        mediaId?: string | undefined;
+        active?: boolean | undefined;
+    }[];
+    material: string;
+    careInstructions: string[];
+    sizeAndFit: string[];
+    tags: string[];
+    badges: ("new" | "bestseller" | "limited" | "sale")[];
+    isFeatured: boolean;
+    isNew: boolean;
+    isBestseller: boolean;
+    active?: boolean | undefined;
+    primaryCategoryId?: string | undefined;
+    collections?: string[] | undefined;
+    seoTitle?: string | undefined;
+    seoDescription?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    salePrice?: number | undefined;
+}>, {
+    id: string;
+    sku: string;
+    slug: string;
+    name: string;
+    description: string;
+    shortDescription: string;
+    category: string;
+    subcategory: string;
+    collection: string;
+    audience: string;
+    basePrice: number;
+    images: {
+        url: string;
+        alt: string;
+        width: number;
+        height: number;
+        id?: string | undefined;
+        colorId?: string | undefined;
+        type?: "image" | undefined;
+        primary?: boolean | undefined;
+        order?: number | undefined;
+        variantId?: string | undefined;
+    }[];
+    videos: string[];
+    colors: {
+        id: string;
+        name: string;
+        hex: string;
+    }[];
+    sizes: {
+        id: string;
+        label: string;
+    }[];
+    variants: {
+        id: string;
+        sku: string;
+        colorId: string;
+        sizeId: string;
+        quantity: number;
+        imageUrl?: string | undefined;
+        mediaId?: string | undefined;
+        active?: boolean | undefined;
+    }[];
+    material: string;
+    careInstructions: string[];
+    sizeAndFit: string[];
+    tags: string[];
+    badges: ("new" | "bestseller" | "limited" | "sale")[];
+    isFeatured: boolean;
+    isNew: boolean;
+    isBestseller: boolean;
+    active?: boolean | undefined;
+    primaryCategoryId?: string | undefined;
+    collections?: string[] | undefined;
+    seoTitle?: string | undefined;
+    seoDescription?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    salePrice?: number | undefined;
+}, {
+    id: string;
+    sku: string;
+    slug: string;
+    name: string;
+    description: string;
+    shortDescription: string;
+    category: string;
+    subcategory: string;
+    collection: string;
+    audience: string;
+    basePrice: number;
+    images: {
+        url: string;
+        alt: string;
+        width: number;
+        height: number;
+        id?: string | undefined;
+        colorId?: string | undefined;
+        type?: "image" | undefined;
+        primary?: boolean | undefined;
+        order?: number | undefined;
+        variantId?: string | undefined;
+    }[];
+    videos: string[];
+    colors: {
+        id: string;
+        name: string;
+        hex: string;
+    }[];
+    sizes: {
+        id: string;
+        label: string;
+    }[];
+    variants: {
+        id: string;
+        sku: string;
+        colorId: string;
+        sizeId: string;
+        quantity: number;
+        imageUrl?: string | undefined;
+        mediaId?: string | undefined;
+        active?: boolean | undefined;
+    }[];
+    material: string;
+    careInstructions: string[];
+    sizeAndFit: string[];
+    tags: string[];
+    badges: ("new" | "bestseller" | "limited" | "sale")[];
+    isFeatured: boolean;
+    isNew: boolean;
+    isBestseller: boolean;
+    active?: boolean | undefined;
+    primaryCategoryId?: string | undefined;
+    collections?: string[] | undefined;
+    seoTitle?: string | undefined;
+    seoDescription?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    salePrice?: number | undefined;
+}>;

package/dist/product-input.js

@@ -0,0 +1,150 @@
+import { z } from 'zod';
+const id = z
+    .string()
+    .trim()
+    .min(1)
+    .max(120)
+    .regex(/^[a-zA-Z0-9_-]+$/);
+const classification = z
+    .string()
+    .trim()
+    .min(1)
+    .max(180)
+    .regex(/^[a-zA-Z0-9_-]+$/);
+const money = z.number().int().min(0).max(10000000);
+const url = z
+    .string()
+    .url()
+    .max(2048)
+    .refine((v) => /^https?:\/\//.test(v), 'HTTP(S) URL required');
+const list = z.array(z.string().trim().min(1).max(100)).max(50);
+export const variantSchema = z
+    .object({
+    id,
+    sku: id,
+    colorId: id,
+    sizeId: id,
+    quantity: z.number().int().min(0).max(1000000),
+    imageUrl: url.optional(),
+    mediaId: id.optional(),
+    active: z.boolean().optional(),
+})
+    .strict();
+export const productSchema = z
+    .object({
+    primaryCategoryId: id.optional(),
+    createdAt: z.string().datetime().optional(),
+    updatedAt: z.string().datetime().optional(),
+    id,
+    slug: z
+        .string()
+        .max(120)
+        .regex(/^[a-z0-9]+(-[a-z0-9]+)*$/),
+    name: z.string().trim().min(1).max(200),
+    sku: id,
+    description: z.string().max(20000),
+    shortDescription: z.string().max(1000),
+    category: classification,
+    subcategory: classification,
+    collection: id,
+    audience: classification,
+    basePrice: money.positive(),
+    salePrice: money.optional(),
+    collections: z.array(id).min(1).max(50).optional(),
+    active: z.boolean().optional(),
+    seoTitle: z.string().max(200).optional(),
+    seoDescription: z.string().max(500).optional(),
+    images: z
+        .array(z
+        .object({
+        id: id.optional(),
+        primary: z.boolean().optional(),
+        order: z.number().int().min(0).max(29).optional(),
+        colorId: id.optional(),
+        variantId: id.optional(),
+        type: z.literal('image').optional(),
+        url,
+        alt: z.string().max(500),
+        width: z.number().int().positive(),
+        height: z.number().int().positive(),
+    })
+        .strict())
+        .min(1)
+        .max(30),
+    videos: z.array(url).max(10),
+    colors: z
+        .array(z
+        .object({
+        id,
+        name: z.string().min(1).max(100),
+        hex: z.string().regex(/^#[0-9a-fA-F]{6}$/),
+    })
+        .strict())
+        .min(1)
+        .max(30),
+    sizes: z
+        .array(z.object({ id, label: z.string().min(1).max(50) }).strict())
+        .min(1)
+        .max(30),
+    variants: z.array(variantSchema).min(1).max(900),
+    material: z.string().min(1).max(100),
+    careInstructions: list,
+    sizeAndFit: list,
+    tags: list,
+    badges: z.array(z.enum(['new', 'bestseller', 'limited', 'sale'])).max(4),
+    isFeatured: z.boolean(),
+    isNew: z.boolean(),
+    isBestseller: z.boolean(),
+})
+    .strict()
+    .superRefine((p, ctx) => {
+    if (p.salePrice !== undefined && p.salePrice >= p.basePrice)
+        ctx.addIssue({
+            code: 'custom',
+            path: ['salePrice'],
+            message: 'Sale price must be below base price',
+        });
+    const issue = (path, message) => ctx.addIssue({ code: 'custom', path, message });
+    if (p.images.filter((image) => image.primary).length > 1)
+        issue(['images'], 'Only one primary image is allowed');
+    const mediaIds = p.images.flatMap((image) => (image.id ? [image.id] : []));
+    if (new Set(mediaIds).size !== mediaIds.length)
+        issue(['images'], 'Duplicate media IDs');
+    const orders = p.images.flatMap((image) => (image.order === undefined ? [] : [image.order]));
+    if (new Set(orders).size !== orders.length)
+        issue(['images'], 'Duplicate media ordering');
+    p.images.forEach((image, index) => {
+        if (image.colorId && !p.colors.some((color) => color.id === image.colorId))
+            issue(['images', index, 'colorId'], 'Unknown color');
+        const variant = p.variants.find((v) => v.id === image.variantId);
+        if (image.variantId && !variant)
+            issue(['images', index, 'variantId'], 'Unknown variant');
+        if (variant && image.colorId && variant.colorId !== image.colorId)
+            issue(['images', index], 'Media color does not match variant');
+    });
+    p.variants.forEach((variant, index) => {
+        const media = p.images.find((image) => image.id === variant.mediaId);
+        if (variant.mediaId &&
+            (!media ||
+                (media.variantId && media.variantId !== variant.id) ||
+                (media.colorId && media.colorId !== variant.colorId)))
+            issue(['variants', index, 'mediaId'], 'Invalid media association');
+    });
+    const unique = (values) => new Set(values).size === values.length;
+    if (!unique(p.colors.map((v) => v.id)) ||
+        !unique(p.sizes.map((v) => v.id)) ||
+        !unique(p.variants.map((v) => v.id)) ||
+        !unique(p.variants.map((v) => v.sku)) ||
+        !unique(p.variants.map((v) => `${v.colorId}:${v.sizeId}`)))
+        ctx.addIssue({
+            code: 'custom',
+            path: ['variants'],
+            message: 'Duplicate color, size or variant',
+        });
+    if (p.variants.some((v) => !p.colors.some((c) => c.id === v.colorId) || !p.sizes.some((s) => s.id === v.sizeId)))
+        ctx.addIssue({
+            code: 'custom',
+            path: ['variants'],
+            message: 'Variant references an unknown color or size',
+        });
+});