@merchi/product-form-sdk 1.0.9

package/dist/types/form.d.ts

@@ -0,0 +1,26 @@
+import { ComponentType } from 'react';
+import { ProductJson } from './product';
+import { JobJson } from './job';
+import { Pricing } from '../runtime/pricing';
+import { Actions, Helpers } from '../runtime/runtime';
+import type { FooterAction } from '../components/footerActions';
+/** Props every custom product form receives. This is the ONLY surface a form
+ * may rely on; the static-analysis gate (Plan 3) rejects anything else. */
+export interface ProductFormProps {
+    /** The product being ordered. */
+    product: ProductJson;
+    /** Request a quote for an arbitrary job (for live pricing as the user edits). */
+    pricing: Pricing;
+    /** Submit the order. The form builds + serializes the job, then calls one of
+     * these. Actions not enabled for the product/embed are undefined. */
+    actions: Actions;
+    /** Stateless helpers: serialize a job, filter qty>0 groups, format currency,
+     * build merchi urls. */
+    helpers: Helpers;
+}
+/** A custom product form is a default-exported React component of this type. */
+export type ProductFormComponent = ComponentType<ProductFormProps> & {
+    /** Optional host-footer config (Get quote / Buy now / Add to cart). */
+    footerActions?: FooterAction[];
+};
+export type { JobJson, ProductJson };

package/dist/types/form.js

@@ -0,0 +1 @@
+export {};

package/dist/types/job.d.ts

@@ -0,0 +1,26 @@
+import { VariationJson, VariationsGroupJson } from './variation';
+/** Pricing fields populated on a job by a quote (server or client-side). */
+export interface QuoteFields {
+    cost?: number;
+    costPerUnit?: number;
+    taxAmount?: number;
+    totalCost?: number;
+    currency?: string;
+}
+/** The job (order) a form builds, serializes, and submits. Mirrors the JSON
+ * wire format used by @merchi/product-form: top-level variations for
+ * whole-order fields, variationsGroups for grouped line items. */
+export interface JobJson extends QuoteFields {
+    quantity?: number;
+    variations?: VariationJson[];
+    variationsGroups?: VariationsGroupJson[];
+    product?: {
+        id?: number;
+    };
+    client?: {
+        id?: number;
+    };
+    tags?: Array<{
+        id: number;
+    }>;
+}

package/dist/types/job.js

@@ -0,0 +1 @@
+export {};

package/dist/types/product.d.ts

@@ -0,0 +1,30 @@
+import { VariationFieldJson } from './variation';
+/** The product JSON a custom form receives. Fields are optional because the
+ * shape varies by product type; the commonly-used fields are documented here. */
+export interface ProductJson {
+    id?: number;
+    name?: string;
+    productType?: number;
+    currency?: string;
+    unitPrice?: number;
+    bestPrice?: number;
+    minimum?: number;
+    minOrderQuantity?: number;
+    groupsFirst?: boolean;
+    needsInventory?: boolean;
+    allowAddToCart?: boolean;
+    allowPaymentUpfront?: boolean;
+    allowQuotation?: boolean;
+    clientSideCalculation?: boolean;
+    defaultJob?: Record<string, unknown>;
+    independentVariationFields?: VariationFieldJson[];
+    groupVariationFields?: VariationFieldJson[];
+    images?: Array<{
+        id?: string;
+        viewUrl?: string;
+    }>;
+    domain?: {
+        id?: number;
+        domain?: string;
+    };
+}

package/dist/types/product.js

@@ -0,0 +1 @@
+export {};

package/dist/types/variation.d.ts

@@ -0,0 +1,46 @@
+/** A selectable option within a variation field (e.g. a colour swatch). */
+export interface OptionJson {
+    id?: number;
+    value?: string;
+    colour?: string;
+    isExtracted?: boolean;
+    isVisible?: boolean;
+    available?: boolean;
+    linkedFile?: {
+        id?: string;
+        viewUrl?: string;
+    };
+}
+/** A single variation field definition on a product. */
+export interface VariationFieldJson {
+    id?: number;
+    name?: string;
+    fieldType?: number;
+    required?: boolean;
+    currency?: string;
+    options?: OptionJson[];
+    maxColours?: number;
+    simplifyColours?: boolean;
+    colourVariationCost?: number;
+    colourVariationUnitCost?: number;
+}
+/** A variation selection within a job (one chosen field value). */
+export interface VariationJson {
+    id?: number;
+    variationField?: number | VariationFieldJson;
+    value?: string | number | null;
+    selectedOptions?: OptionJson[];
+    variationFiles?: Array<{
+        id?: string;
+    }>;
+    isVisible?: boolean;
+}
+/** A grouped line item: a set of variations with its own quantity. */
+export interface VariationsGroupJson {
+    id?: number;
+    quantity?: number;
+    groupCost?: number | null;
+    variations?: VariationJson[];
+    inventoryCount?: number;
+    inventorySufficient?: boolean;
+}

package/dist/types/variation.js

@@ -0,0 +1 @@
+export {};

package/dist/version.d.ts

@@ -0,0 +1,4 @@
+/** Auto-synced from package.json — do not edit; run `npm run build`. */
+export declare function getProductFormSdkVersion(): string;
+/** @deprecated Prefer getProductFormSdkVersion(); kept for gate/export compatibility. */
+export declare const SDK_VERSION: string;

package/dist/version.js

@@ -0,0 +1,6 @@
+/** Auto-synced from package.json — do not edit; run `npm run build`. */
+export function getProductFormSdkVersion() {
+    return '1.0.9';
+}
+/** @deprecated Prefer getProductFormSdkVersion(); kept for gate/export compatibility. */
+export const SDK_VERSION = getProductFormSdkVersion();

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@merchi/product-form-sdk",
+  "version": "1.0.9",
+  "description": "Contract SDK for AI-built Merchi custom product forms.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/merchisdk/merchi_ts.git",
+    "directory": "packages/product-form-sdk"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "James Campton <james@merchi.co>",
+  "license": "GPL-3.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prebuild": "node scripts/sync-version.mjs",
+    "build": "tsc",
+    "test": "jest",
+    "lint": "eslint src --ext .ts,.tsx",
+    "prepublishOnly": "node scripts/sync-version.mjs && npm run build && npm test"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "dependencies": {
+    "@merchi/sdk": "^1.40.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.0.0",
+    "@types/node": "^20.0.0",
+    "@types/react": "^19.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.47.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "jest": "^29.0.0",
+    "jest-environment-jsdom": "^29.0.0",
+    "react": "^19.0.0",
+    "ts-jest": "^29.0.0",
+    "typescript": "^5.1.6"
+  }
+}