@endora-commerce/contracts 0.100.0

package/dist/quick-order.js

@@ -0,0 +1,177 @@
+import { z } from 'zod';
+import { uuidSchema } from './common.js';
+import { nextActionSchema } from './orders.js';
+/**
+ * Quick-order contracts (feature 039). The quick-order page lets buyers
+ * build a Cart or a Quote Request from a CSV / Excel file (`sku,quantity`
+ * plus optional variant-attribute columns), search the catalog by SKU /
+ * name / `quick_searchable` attribute, reorder a past order, manage their
+ * default ordering preferences, and place a one-click order.
+ *
+ * The importer is lenient on whitespace + quoting; the import response is a
+ * partition of the rows into recognised + rejected, with line numbers
+ * preserved so the UI can highlight problem rows.
+ */
+// --- Shared ----------------------------------------------------------------
+/**
+ * Admin / sales-rep "act on behalf of" context. When present, the resulting
+ * Cart / Quote Request is owned by this customer + organization and priced
+ * under that organization's price list (FR-008).
+ */
+export const quickOrderOnBehalfSchema = z.object({
+    customerAccountId: uuidSchema,
+    organizationId: uuidSchema,
+});
+/** An uploaded file (CSV or .xlsx), sent as base64 so the API owns parsing. */
+export const quickOrderUploadFileSchema = z.object({
+    filename: z.string().min(1).max(255),
+    contentBase64: z.string().min(1).max(20_000_000),
+});
+export const quickOrderRejectionReasonSchema = z.enum([
+    'sku_missing',
+    'quantity_invalid',
+    'product_not_found',
+    'product_archived',
+    'malformed_row',
+    'variant_not_resolved',
+    'variant_ambiguous',
+    'row_limit_exceeded',
+]);
+// --- Import (CSV / Excel → preview) ---------------------------------------
+/**
+ * Either `csv` (legacy back-compat path) or `file` (CSV or .xlsx upload).
+ * `onBehalfOf` is honoured only on the admin endpoint.
+ */
+export const quickOrderImportRequestSchema = z
+    .object({
+    csv: z.string().min(1).max(2_000_000).optional(),
+    file: quickOrderUploadFileSchema.optional(),
+    onBehalfOf: quickOrderOnBehalfSchema.optional(),
+})
+    .refine((v) => Boolean(v.csv) || Boolean(v.file), {
+    message: 'Either csv or file must be provided.',
+});
+export const recognizedQuickOrderItemSchema = z.object({
+    line: z.number().int().positive(),
+    sku: z.string().min(1).max(255),
+    productId: uuidSchema,
+    variantId: uuidSchema.nullable(),
+    /** Resolved variant SKU when a variant was matched from attribute columns. */
+    resolvedVariantSku: z.string().max(255).nullable().optional(),
+    quantity: z.number().int().positive(),
+    /** Other source lines merged into this one (duplicate SKU, summed qty). */
+    mergedFromLines: z.array(z.number().int().positive()).optional(),
+});
+export const rejectedQuickOrderItemSchema = z.object({
+    line: z.number().int().positive(),
+    raw: z.string(),
+    reason: quickOrderRejectionReasonSchema,
+});
+export const quickOrderImportSummarySchema = z.object({
+    recognizedCount: z.number().int().nonnegative(),
+    rejectedCount: z.number().int().nonnegative(),
+    mergedCount: z.number().int().nonnegative(),
+    truncated: z.boolean(),
+});
+export const quickOrderImportResponseSchema = z.object({
+    recognized: z.array(recognizedQuickOrderItemSchema),
+    rejected: z.array(rejectedQuickOrderItemSchema),
+    summary: quickOrderImportSummarySchema,
+});
+// --- Build (confirmed import → Cart or Quote Request) ----------------------
+export const quickOrderTargetSchema = z.enum(['cart', 'quote_request']);
+export const quickOrderBuildLineSchema = z.object({
+    productId: uuidSchema,
+    variantId: uuidSchema.nullable().optional(),
+    quantity: z.number().int().positive(),
+});
+export const quickOrderBuildRequestSchema = z.object({
+    target: quickOrderTargetSchema,
+    items: z.array(quickOrderBuildLineSchema).min(1),
+    onBehalfOf: quickOrderOnBehalfSchema.optional(),
+});
+export const quickOrderBuildResponseSchema = z.object({
+    target: quickOrderTargetSchema,
+    cartId: uuidSchema.optional(),
+    checkoutUrl: z.string().optional(),
+    quoteRequestId: uuidSchema.optional(),
+    /** Customer-facing business Quote Request ID (shown in confirmations). */
+    quoteRequestBusinessId: z.string().optional(),
+});
+// --- Quick search ----------------------------------------------------------
+/** Type-ahead search for SKU / name / quick_searchable attributes. */
+export const quickOrderSearchQuerySchema = z.object({
+    q: z.string().min(1).max(120),
+    limit: z.coerce.number().int().positive().max(50).default(20),
+});
+export const quickOrderSearchMatchSchema = z.enum(['sku', 'name', 'attribute']);
+export const quickOrderSearchResultSchema = z.object({
+    productId: uuidSchema,
+    sku: z.string(),
+    name: z.string(),
+    slug: z.string(),
+    status: z.enum(['draft', 'active', 'inactive']),
+    matchedOn: z.array(quickOrderSearchMatchSchema).optional(),
+});
+// --- Default ordering preferences -----------------------------------------
+export const quickOrderPreferenceScopeSchema = z.enum(['organization', 'customer']);
+/**
+ * Upsert a scope's defaults. Each field: omitted = leave unchanged;
+ * explicit `null` = clear. Authorization is enforced per FR-018.
+ */
+export const quickOrderPreferenceUpsertSchema = z.object({
+    scope: quickOrderPreferenceScopeSchema,
+    scopeId: uuidSchema,
+    defaultPaymentMethodId: uuidSchema.nullable().optional(),
+    defaultDeliveryMethodId: uuidSchema.nullable().optional(),
+    defaultBillingAddressId: uuidSchema.nullable().optional(),
+    defaultShippingAddressId: uuidSchema.nullable().optional(),
+});
+/** Raw stored row for a scope (null fields = unset). */
+export const quickOrderPreferenceSchema = z.object({
+    scope: quickOrderPreferenceScopeSchema,
+    scopeId: uuidSchema,
+    defaultPaymentMethodId: uuidSchema.nullable(),
+    defaultDeliveryMethodId: uuidSchema.nullable(),
+    defaultBillingAddressId: uuidSchema.nullable(),
+    defaultShippingAddressId: uuidSchema.nullable(),
+});
+const preferenceSourceSchema = z.enum(['customer', 'organization']).nullable();
+/** Effective defaults for a customer after inheritance + eligibility check. */
+export const quickOrderResolvedDefaultsSchema = z.object({
+    paymentMethodId: uuidSchema.nullable(),
+    deliveryMethodId: uuidSchema.nullable(),
+    billingAddressId: uuidSchema.nullable(),
+    shippingAddressId: uuidSchema.nullable(),
+    source: z.object({
+        payment: preferenceSourceSchema,
+        delivery: preferenceSourceSchema,
+        billing: preferenceSourceSchema,
+        shipping: preferenceSourceSchema,
+    }),
+});
+// --- One-click buy ---------------------------------------------------------
+export const quickOrderOneClickEligibilitySchema = z.object({
+    enabled: z.boolean(),
+    reason: z
+        .enum(['setting_disabled', 'missing_defaults', 'ineligible_default'])
+        .nullable()
+        .optional(),
+});
+export const quickOrderOneClickRequestSchema = z.object({
+    productId: uuidSchema,
+    variantId: uuidSchema.nullable().optional(),
+    quantity: z.number().int().positive().optional(),
+    idempotencyKey: z.string().max(200).optional(),
+});
+export const quickOrderOneClickResponseSchema = z.object({
+    order: z.object({
+        id: uuidSchema,
+        businessId: z.string(),
+        status: z.string(),
+        total: z.number().finite().nonnegative(),
+        currency: z.string().length(3),
+    }),
+    nextAction: nextActionSchema.nullable(),
+});
+//# sourceMappingURL=quick-order.js.map

package/dist/quick-order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"quick-order.js","sourceRoot":"","sources":["../src/quick-order.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C;;;;;;;;;;GAUG;AAEH,8EAA8E;AAE9E;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,iBAAiB,EAAE,UAAU;IAC7B,cAAc,EAAE,UAAU;CAC3B,CAAC,CAAC;AAGH,+EAA+E;AAC/E,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACpC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC;CACjD,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,IAAI,CAAC;IACpD,aAAa;IACb,kBAAkB;IAClB,mBAAmB;IACnB,kBAAkB;IAClB,eAAe;IACf,sBAAsB;IACtB,mBAAmB;IACnB,oBAAoB;CACrB,CAAC,CAAC;AAGH,6EAA6E;AAE7E;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC;KAC3C,MAAM,CAAC;IACN,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;IAChD,IAAI,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IAC3C,UAAU,EAAE,wBAAwB,CAAC,QAAQ,EAAE;CAChD,CAAC;KACD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;IAChD,OAAO,EAAE,sCAAsC;CAChD,CAAC,CAAC;AAGL,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACjC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAC/B,SAAS,EAAE,UAAU;IACrB,SAAS,EAAE,UAAU,CAAC,QAAQ,EAAE;IAChC,8EAA8E;IAC9E,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC7D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACrC,2EAA2E;IAC3E,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE;CACjE,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACjC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,+BAA+B;CACxC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC/C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC7C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IAC3C,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;CACvB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC;IACnD,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,4BAA4B,CAAC;IAC/C,OAAO,EAAE,6BAA6B;CACvC,CAAC,CAAC;AAGH,8EAA8E;AAE9E,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;AAGxE,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,SAAS,EAAE,UAAU;IACrB,SAAS,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC3C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,MAAM,EAAE,sBAAsB;IAC9B,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,UAAU,EAAE,wBAAwB,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,MAAM,EAAE,sBAAsB;IAC9B,MAAM,EAAE,UAAU,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,cAAc,EAAE,UAAU,CAAC,QAAQ,EAAE;IACrC,0EAA0E;IAC1E,sBAAsB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9C,CAAC,CAAC;AAGH,8EAA8E;AAE9E,sEAAsE;AACtE,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CAC9D,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;AAGhF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,SAAS,EAAE,UAAU;IACrB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC/C,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,QAAQ,EAAE;CAC3D,CAAC,CAAC;AAGH,6EAA6E;AAE7E,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC,CAAC;AAGpF;;;GAGG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,KAAK,EAAE,+BAA+B;IACtC,OAAO,EAAE,UAAU;IACnB,sBAAsB,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACxD,uBAAuB,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACzD,uBAAuB,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACzD,wBAAwB,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC3D,CAAC,CAAC;AAGH,wDAAwD;AACxD,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,KAAK,EAAE,+BAA+B;IACtC,OAAO,EAAE,UAAU;IACnB,sBAAsB,EAAE,UAAU,CAAC,QAAQ,EAAE;IAC7C,uBAAuB,EAAE,UAAU,CAAC,QAAQ,EAAE;IAC9C,uBAAuB,EAAE,UAAU,CAAC,QAAQ,EAAE;IAC9C,wBAAwB,EAAE,UAAU,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC;AAGH,MAAM,sBAAsB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;AAE/E,+EAA+E;AAC/E,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,eAAe,EAAE,UAAU,CAAC,QAAQ,EAAE;IACtC,gBAAgB,EAAE,UAAU,CAAC,QAAQ,EAAE;IACvC,gBAAgB,EAAE,UAAU,CAAC,QAAQ,EAAE;IACvC,iBAAiB,EAAE,UAAU,CAAC,QAAQ,EAAE;IACxC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,OAAO,EAAE,sBAAsB;QAC/B,QAAQ,EAAE,sBAAsB;QAChC,OAAO,EAAE,sBAAsB;QAC/B,QAAQ,EAAE,sBAAsB;KACjC,CAAC;CACH,CAAC,CAAC;AAGH,8EAA8E;AAE9E,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1D,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,kBAAkB,EAAE,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;SACpE,QAAQ,EAAE;SACV,QAAQ,EAAE;CACd,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IACtD,SAAS,EAAE,UAAU;IACrB,SAAS,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC3C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAChD,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;QACd,EAAE,EAAE,UAAU;QACd,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;QAClB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE;QACxC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;KAC/B,CAAC;IACF,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC"}