@merchi/sdk 1.42.14 → 1.42.16

package/dist/uuid.d.ts

@@ -0,0 +1 @@
+export declare function generateUUID(): string;

package/dist/uuid.test.d.ts

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

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@merchi/sdk",
-  "version": "1.42.14",
+  "version": "1.42.16",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "type": "module",
   "repository": {
     "type": "git",

package/src/constants/field_types.ts

@@ -14,4 +14,5 @@ export enum FieldType {
   COLOUR_EXTRACT = 13,
   AREA = 14,
   PANTONE_COLOUR_SELECT = 15,
+  EMBROIDERY = 16,
 }

package/src/entities/draft_template.ts

@@ -41,6 +41,12 @@ export class DraftTemplate extends Entity {
   @DraftTemplate.property()
   public width?: number;
 
+  @DraftTemplate.property({type: Number})
+  public widthMm?: number | null;
+
+  @DraftTemplate.property({type: Number})
+  public heightMm?: number | null;
+
   @DraftTemplate.property({type: MerchiFile})
   public file?: MerchiFile;
 

package/src/entities/variation_field.ts

@@ -192,6 +192,27 @@ export class VariationField extends Entity {
   @VariationField.property({type: Number})
   public aspectRatio?: number | null;
 
+  @VariationField.property()
+  public embroideryInputMode?: string;
+
+  @VariationField.property({type: Number})
+  public stitchDensity?: number;
+
+  @VariationField.property({type: Number})
+  public averageStitchLengthMm?: number;
+
+  @VariationField.property()
+  public stitchVariationCost?: number;
+
+  @VariationField.property({type: 'DiscountGroup'})
+  public stitchVariationCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationField.property()
+  public stitchVariationUnitCost?: number;
+
+  @VariationField.property({type: 'DiscountGroup'})
+  public stitchVariationUnitCostDiscountGroup?: DiscountGroup | null;
+
   @VariationField.property()
   public product?: Product;
 
@@ -252,6 +273,10 @@ export class VariationField extends Entity {
     } else if (this.fieldType === FieldType.AREA) {
       result.value = this.defaultValue;
       result.onceOffCost = 0;
+    } else if (this.fieldType === FieldType.EMBROIDERY) {
+      result.value = '';
+      result.onceOffCost = 0;
+      result.variationFiles = [];
     } else if (this.isSelectable()) {
       let onceOffCost = 0;
       const value = [];

package/src/entities/variation_fields_option.ts

@@ -67,6 +67,9 @@ export class VariationFieldsOption extends Entity {
   @VariationFieldsOption.property({type: MerchiFile})
   public linkedFile?: MerchiFile | null;
 
+  @VariationFieldsOption.property({type: MerchiFile})
+  public linkedProductImage?: MerchiFile | null;
+
   @VariationFieldsOption.property({arrayType: 'Variation'})
   public selectedByVariations?: Variation[];
 

package/src/entity.ts

@@ -45,7 +45,7 @@ interface FromJsonOptions {
   makeDirty?: boolean;
 }
 
-interface CreateOptions {
+export interface CreateOptions {
   withRights?: boolean;
   embed?: EmbedDescriptor;
 }
@@ -862,10 +862,11 @@ export class Entity {
           });
           propertyInfo.currentValue = newValue;
         } else if (this.isSingleEntityProperty(propertyInfo)) {
-          // if property already have a entity as relationship, try to merge
-          // with json first, this behavior may need to be configurable in the
-          // future.
-          if (propertyInfo.currentValue) {
+          // null clears the link. An empty entity would omit the clear
+          // sentinel from toFormData, so the saved photo would stick.
+          if (value === null) {
+            propertyInfo.currentValue = null;
+          } else if (propertyInfo.currentValue) {
             propertyInfo.currentValue.fromJson(value, options);
           } else {
             const nested = new (propertyInfo.type as any)(this.merchi);

package/src/pricing/estimate.test.ts

@@ -555,3 +555,98 @@ test('group field visibility is scoped per group (no cross-group leak)', () => {
   expect(r.groupCosts).toEqual([0, 5]);
   expect(r.cost).toBe(5);
 });
+
+test('embroidery prices stitches and colours from the saved size', () => {
+  const rules: PricingRules = {
+    ...base,
+    fields: [{
+      id: 16, originalId: 16, position: 0, fieldType: 16, independent: true,
+      isSelectable: false, selectedBy: [],
+      variationCost: 15, variationUnitCost: 0,
+      variationCostDiscountGroup: null, variationUnitCostDiscountGroup: null,
+      stitchDensity: 2.5,
+      stitchVariationCost: 12, stitchVariationUnitCost: 0.8,
+      stitchVariationCostDiscountGroup: null, stitchVariationUnitCostDiscountGroup: null,
+      colourVariationCost: 5, colourVariationUnitCost: 0.4,
+      colourVariationCostDiscountGroup: null, colourVariationUnitCostDiscountGroup: null,
+      options: [],
+    }],
+  };
+  const value = JSON.stringify({
+    text: 'ACME', widthMm: 80, heightMm: 40, colours: ['#111111', '#CC0000'], coverage: 0.5,
+  });
+  const r = estimateQuote(rules, {
+    quantity: 1,
+    fieldValues: { 16: { value, colourCount: 2, coverage: 0.5 } },
+  }) as QuoteResult;
+  expect(r.cost).toBe(87);
+});
+
+test('embroidery counts colours on the saved value when colourCount is omitted', () => {
+  const rules: PricingRules = {
+    ...base,
+    fields: [{
+      id: 16, originalId: 16, position: 0, fieldType: 16, independent: true,
+      isSelectable: false, selectedBy: [],
+      variationCost: 15, variationUnitCost: 0,
+      variationCostDiscountGroup: null, variationUnitCostDiscountGroup: null,
+      stitchDensity: 2.5,
+      stitchVariationCost: 12, stitchVariationUnitCost: 0.8,
+      stitchVariationCostDiscountGroup: null, stitchVariationUnitCostDiscountGroup: null,
+      colourVariationCost: 5, colourVariationUnitCost: 0.4,
+      colourVariationCostDiscountGroup: null, colourVariationUnitCostDiscountGroup: null,
+      options: [],
+    }],
+  };
+  const value = JSON.stringify({
+    text: 'ACME', widthMm: 80, heightMm: 40, colours: ['#111111', '#CC0000'], coverage: 0.5,
+  });
+  const r = estimateQuote(rules, {
+    quantity: 1,
+    fieldValues: { 16: { value, coverage: 0.5 } },
+  }) as QuoteResult;
+  expect(r.cost).toBe(87);
+});
+
+test('embroidery ignores a null or non-array colour list', () => {
+  const rules: PricingRules = {
+    ...base,
+    fields: [{
+      id: 16, originalId: 16, position: 0, fieldType: 16, independent: true,
+      isSelectable: false, selectedBy: [],
+      variationCost: 15, variationUnitCost: 0,
+      variationCostDiscountGroup: null, variationUnitCostDiscountGroup: null,
+      stitchDensity: 2.5,
+      stitchVariationCost: 12, stitchVariationUnitCost: 0.8,
+      stitchVariationCostDiscountGroup: null, stitchVariationUnitCostDiscountGroup: null,
+      colourVariationCost: 5, colourVariationUnitCost: 0.4,
+      colourVariationCostDiscountGroup: null, colourVariationUnitCostDiscountGroup: null,
+      options: [],
+    }],
+  };
+  const missing = estimateQuote(rules, {
+    quantity: 1,
+    fieldValues: { 16: { value: null, colourCount: 2, coverage: 0.5 } },
+  }) as QuoteResult;
+  // No saved size, so the stitch price cannot be calculated.
+  expect(missing.cost).toBe(10);
+
+  const notColours = JSON.stringify({
+    text: 'ACME', widthMm: 80, heightMm: 40, colours: 'red', coverage: 0.5,
+  });
+  const uncounted = estimateQuote(rules, {
+    quantity: 1,
+    fieldValues: { 16: { value: notColours, coverage: 0.5 } },
+  }) as QuoteResult;
+  // 10 + 15 + 12*4 + 0.8*4 = 76.2; a non-array colour list adds no colour fee.
+  expect(uncounted.cost).toBe(76.2);
+
+  const explicitZero = JSON.stringify({
+    text: 'ACME', widthMm: 80, heightMm: 40, colours: ['#111111', '#CC0000'], coverage: 0.5,
+  });
+  const zero = estimateQuote(rules, {
+    quantity: 1,
+    fieldValues: { 16: { value: explicitZero, colourCount: 0, coverage: 0.5 } },
+  }) as QuoteResult;
+  expect(zero.cost).toBe(76.2);
+});

package/src/pricing/estimate.ts

@@ -183,6 +183,76 @@ function colourExtractCostFactor(
   return { setup, unitList };
 }
 
+function parseEmbroidery(value: string | number | null | undefined): Record<string, any> | null {
+  if (value === undefined || value === null || value === '') return null;
+  try {
+    const parsed = JSON.parse(String(value));
+    return parsed && typeof parsed === 'object' ? parsed : null;
+  } catch {
+    return null;
+  }
+}
+
+function embroideryCostFactor(
+  field: PricingField,
+  sel: FieldSelection | undefined,
+  groupQuantities: number[]
+): { setup: number; unitList: number[] } {
+  const n = groupQuantities.length;
+  const zeros = { setup: 0, unitList: new Array(n).fill(0) };
+  const parsed = parseEmbroidery(sel?.value ?? null);
+  const width = Number(parsed?.widthMm);
+  const height = Number(parsed?.heightMm);
+  const coverage = Number(sel?.coverage ?? parsed?.coverage);
+  // An explicit colourCount, including 0, wins. Otherwise count the saved
+  // colour list. A null value or a non-array list contributes no colours.
+  const savedColours = parsed?.colours;
+  const colourCount = Number(
+    sel?.colourCount ?? (Array.isArray(savedColours) ? savedColours.length : 0)
+  );
+  const hasDesign = Boolean(String(parsed?.text || '').trim()) || Boolean(sel?.hasFiles) || colourCount > 0;
+  if (!(width > 0) || !(height > 0) || !(coverage > 0) || !hasDesign) return zeros;
+
+  const density = Number(field.stitchDensity) > 0 ? Number(field.stitchDensity) : 2.5;
+  const thousands = Math.round(width * height * coverage * density) / 1000;
+  const totalQty = groupQuantities.reduce((a, b) => a + b, 0);
+  let setup = variationSetupCost(field, totalQty);
+  const unitList = variationUnitCosts(field, groupQuantities);
+  const stitchSetup = variationSetupCost(
+    {
+      variationCost: field.stitchVariationCost || 0,
+      variationCostDiscountGroup: field.stitchVariationCostDiscountGroup ?? null,
+    },
+    totalQty
+  );
+  const stitchUnits = variationUnitCosts(
+    {
+      variationUnitCost: field.stitchVariationUnitCost || 0,
+      variationUnitCostDiscountGroup: field.stitchVariationUnitCostDiscountGroup ?? null,
+    },
+    groupQuantities
+  );
+  const colourSetup = variationSetupCost(
+    {
+      variationCost: field.colourVariationCost || 0,
+      variationCostDiscountGroup: field.colourVariationCostDiscountGroup ?? null,
+    },
+    totalQty
+  );
+  const colourUnits = variationUnitCosts(
+    {
+      variationUnitCost: field.colourVariationUnitCost || 0,
+      variationUnitCostDiscountGroup: field.colourVariationUnitCostDiscountGroup ?? null,
+    },
+    groupQuantities
+  );
+  setup += stitchSetup * thousands + colourSetup * colourCount;
+  for (let i = 0; i < n; i++) {
+    unitList[i] += stitchUnits[i] * thousands + colourUnits[i] * colourCount;
+  }
+  return { setup, unitList };
+}
+
 function costFactor(
   field: PricingField,
   sel: FieldSelection | undefined,
@@ -196,6 +266,9 @@ function costFactor(
   if (Number(field.fieldType) === FieldType.COLOUR_EXTRACT) {
     return colourExtractCostFactor(field, sel, groupQuantities);
   }
+  if (Number(field.fieldType) === FieldType.EMBROIDERY) {
+    return embroideryCostFactor(field, sel, groupQuantities);
+  }
   if (isEmpty(field, sel)) {
     return { setup: 0, unitList: new Array(n).fill(0) };
   }

package/src/pricing/types.ts

@@ -50,6 +50,14 @@ export interface PricingField {
   colourVariationUnitCost?: number;
   colourVariationCostDiscountGroup?: DiscountGroup | null;
   colourVariationUnitCostDiscountGroup?: DiscountGroup | null;
+  /** Embroidery (fieldType 16): per 1,000 stitches, plus the per-colour rates. */
+  embroideryInputMode?: 'text' | 'file' | string;
+  stitchDensity?: number;
+  averageStitchLengthMm?: number;
+  stitchVariationCost?: number;
+  stitchVariationUnitCost?: number;
+  stitchVariationCostDiscountGroup?: DiscountGroup | null;
+  stitchVariationUnitCostDiscountGroup?: DiscountGroup | null;
   options: PricingOption[];
 }
 
@@ -91,6 +99,8 @@ export interface FieldSelection {
   colourCount?: number;
   /** Colour extract: an artwork file is attached, even if no colour was kept. */
   hasFiles?: boolean;
+  /** Embroidery: fraction of the size box that is ink. */
+  coverage?: number;
 }
 
 export interface GroupSelection {

package/tsconfig.json

@@ -8,6 +8,7 @@
     "moduleResolution": "node",
     "rootDir": "./src",
     "outDir": "dist",
+    "declaration": true,
     "module": "ES6",
     "types": ["node", "jest"],
     "baseUrl": ".",