@merchi/sdk 1.40.2

package/src/entities/variation_field.ts

@@ -0,0 +1,268 @@
+import { cloneDeepWith } from 'lodash';
+import { DiscountGroup } from './discount_group.js';
+import { Entity } from '../entity.js';
+import { InventoryGroup } from './inventory_group.js';
+import { Product } from './product.js';
+import { Variation } from './variation.js';
+import { VariationFieldsOption } from './variation_fields_option.js';
+import { FieldType } from '../constants/field_types.js';
+
+export class VariationField extends Entity {
+  protected static resourceName = 'variation_fields';
+  protected static singularName = 'variationField';
+  protected static pluralName = 'variationFields';
+
+  @VariationField.property({type: Date})
+  public archived?: Date | null;
+
+  @VariationField.property()
+  public id?: number;
+
+  @VariationField.property()
+  public position?: number;
+
+  @VariationField.property()
+  public required?: boolean;
+
+  @VariationField.property()
+  public independent?: boolean;
+
+  @VariationField.property()
+  public name?: string;
+
+  @VariationField.property()
+  public instructions?: string;
+
+  @VariationField.property({type: String})
+  public placeholder?: string | null;
+
+  @VariationField.property()
+  public defaultValue?: string;
+
+  @VariationField.property()
+  public currency?: string;
+
+  @VariationField.property()
+  public fieldType?: FieldType;
+
+  @VariationField.property()
+  public margin?: number;
+
+  @VariationField.property()
+  public variationCost?: number;
+
+  @VariationField.property({type: 'DiscountGroup'})
+  public variationCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationField.property()
+  public variationUnitCost?: number;
+
+  @VariationField.property({embeddedByDefault: false})
+  public buyUnitCost?: number;
+
+  @VariationField.property({embeddedByDefault: false})
+  public buyCost?: number;
+
+  @VariationField.property({type: 'DiscountGroup'})
+  public variationUnitCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationField.property()
+  public rows?: number;
+
+  @VariationField.property({type: Number})
+  public fieldMin?: number | null;
+
+  @VariationField.property({type: Number})
+  public fieldMax?: number | null;
+
+  @VariationField.property()
+  public allowDecimal?: boolean;
+
+  @VariationField.property()
+  public isHtml?: boolean;
+
+  @VariationField.property()
+  public considerBusinessHours?: boolean;
+
+  @VariationField.property()
+  public shippingTimeIncluded?: boolean;
+
+  @VariationField.property()
+  public sellerProductEditable?: boolean;
+
+  @VariationField.property()
+  public multipleSelect?: boolean;
+
+  @VariationField.property()
+  public showFilePreview?: boolean;
+
+  @VariationField.property()
+  public allowFileMultiple?: boolean;
+
+  @VariationField.property()
+  public allowFileJpeg?: boolean;
+
+  @VariationField.property()
+  public allowFileGif?: boolean;
+
+  @VariationField.property()
+  public allowFilePdf?: boolean;
+
+  @VariationField.property()
+  public allowFilePng?: boolean;
+
+  @VariationField.property()
+  public allowFileAi?: boolean;
+
+  @VariationField.property()
+  public maxColours?: number;
+
+  @VariationField.property()
+  public simplifyColours?: boolean;
+
+  @VariationField.property()
+  public colourVariationCost?: number;
+
+  @VariationField.property({type: 'DiscountGroup'})
+  public colourVariationCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationField.property()
+  public colourVariationUnitCost?: number;
+
+  @VariationField.property({type: 'DiscountGroup'})
+  public colourVariationUnitCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationField.property()
+  public heightVariationCost?: number;
+
+  @VariationField.property({type: 'DiscountGroup'})
+  public heightVariationCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationField.property()
+  public heightVariationUnitCost?: number;
+
+  @VariationField.property({type: 'DiscountGroup'})
+  public heightVariationUnitCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationField.property()
+  public widthVariationCost?: number;
+
+  @VariationField.property({type: 'DiscountGroup'})
+  public widthVariationCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationField.property()
+  public widthVariationUnitCost?: number;
+
+  @VariationField.property({type: 'DiscountGroup'})
+  public widthVariationUnitCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationField.property({type: Number})
+  public heightFieldMin?: number | null;
+
+  @VariationField.property({type: Number})
+  public heightFieldMax?: number | null;
+
+  @VariationField.property({type: Number})
+  public widthFieldMin?: number | null;
+
+  @VariationField.property({type: Number})
+  public widthFieldMax?: number | null;
+
+  @VariationField.property()
+  public areaUnit?: string;
+
+  @VariationField.property()
+  public areaInputType?: string;
+
+  @VariationField.property({type: Number})
+  public areaStep?: number | null;
+
+  @VariationField.property()
+  public aspectRatioLock?: boolean;
+
+  @VariationField.property({type: Number})
+  public aspectRatio?: number | null;
+
+  @VariationField.property()
+  public product?: Product;
+
+  @VariationField.property({arrayType: 'VariationFieldsOption'})
+  public selectedBy?: VariationFieldsOption[];
+
+  @VariationField.property({type: 'InventoryGroup'})
+  public inventoryGroup?: InventoryGroup;
+
+  @VariationField.property({type: 'InventoryGroup'})
+  public linkedInventoryGroup?: InventoryGroup;
+
+  @VariationField.property({arrayType: 'Variation'})
+  public variations?: Variation[];
+
+  @VariationField.property({arrayType: 'VariationFieldsOption'})
+  public options?: VariationFieldsOption[];
+
+  public isSelectable = () => {
+    if (this.fieldType === undefined) {
+      throw new Error('fieldType is undefined, did you forget to embed it?');
+    }
+    const selectable = new Set([FieldType.SELECT,
+      FieldType.CHECKBOX,
+      FieldType.RADIO,
+      FieldType.IMAGE_SELECT,
+      FieldType.COLOUR_SELECT,
+      FieldType.COLOUR_EXTRACT]);
+    return selectable.has(this.fieldType);
+  };
+
+  public buildEmptyVariation = () => {
+    if (this.defaultValue === undefined) {
+      throw new Error('defaultValue is undefined, did you forget to embed it?');
+    }
+    if (this.variationCost === undefined) {
+      const err = 'variationCost is undefined, did you forget to embed it?';
+      throw new Error(err);
+    }
+    if (this.options === undefined) {
+      throw new Error('options is undefined, did you forget to embed it?');
+    }
+    const result = new this.merchi.Variation(this.merchi);
+    result.selectableOptions = [];
+    if (this.fieldType === FieldType.COLOUR_EXTRACT) {
+      result.value = this.defaultValue;
+      result.onceOffCost = 0;
+      result.variationFiles = [];
+    } else if (this.fieldType === FieldType.AREA) {
+      result.value = this.defaultValue;
+      result.onceOffCost = 0;
+    } else if (this.isSelectable()) {
+      let onceOffCost = 0;
+      const value = [];
+      for (const option of this.options) {
+        if ((this.sellerProductEditable && option.include) ||
+          (!this.sellerProductEditable && option.default)) {
+          if (option.variationCost === undefined) {
+            throw new Error('option.variationCost is undefined, did you ' +
+                            'forget to embed it?');
+          }
+          value.push(option.id);
+          onceOffCost += option.variationCost;
+        }
+        result.selectableOptions.push(option.buildVariationOption());
+      }
+      result.value = value.join();
+      result.onceOffCost = onceOffCost;
+    } else {
+      result.value = this.defaultValue;
+      result.onceOffCost = this.variationCost;
+    }
+    result.unitCostTotal = 0;
+    result.cost = result.onceOffCost;
+    function customiser(value: any, index: any) {
+      if (index === 'merchi') {
+        return value;
+      }
+    }
+    result.variationField = cloneDeepWith(this, customiser);
+    return result;
+  };
+}

package/src/entities/variation_fields_option.test.ts

@@ -0,0 +1,46 @@
+import { Merchi } from '../merchi.js';
+
+test('can make VariationFieldsOption', () => {
+  const merchi = new Merchi();
+  const variationFieldsOption = new merchi.VariationFieldsOption();
+  expect(variationFieldsOption).toBeTruthy();
+});
+
+test('totalCost', () => {
+  const merchi = new Merchi();
+  const vfo = new merchi.VariationFieldsOption();
+  expect(() => vfo.totalCost(33)).toThrow();
+  vfo.variationCost = 12.4;
+  expect(() => vfo.totalCost(33)).toThrow();
+  vfo.variationUnitCost = 9.98;
+  expect(vfo.totalCost(33)).toEqual(341.74);
+});
+
+test('buildVariationOption', () => {
+  const merchi = new Merchi();
+  const option = new merchi.VariationFieldsOption();
+  const file = new merchi.MerchiFile();
+  file.id = 1;
+  option.id = 1;
+  option.value = 'aa';
+  option.position = 3;
+  option.default = true;
+  option.colour = '#AAAAAA';
+  option.linkedFile = file;
+  option.currency = 'AUD';
+  option.variationCost = 100;
+  option.variationUnitCost = 1;
+  const variationOption = option.buildVariationOption();
+  expect(variationOption.optionId).toEqual(option.id);
+  expect(variationOption.value).toEqual(option.value);
+  expect(variationOption.position).toEqual(option.position);
+  expect(variationOption.default).toEqual(option.default);
+  expect(variationOption.colour).toEqual(option.colour);
+  expect(variationOption.linkedFile!.id).toEqual(1);
+  expect(variationOption.quantity).toEqual(0);
+  expect(variationOption.currency).toEqual(option.currency);
+  expect(variationOption.onceOffCost).toEqual(option.variationCost);
+  expect(variationOption.unitCost).toEqual(option.variationUnitCost);
+  expect(variationOption.unitCostTotal).toEqual(0);
+  expect(variationOption.totalCost).toEqual(option.variationCost);
+});

package/src/entities/variation_fields_option.ts

@@ -0,0 +1,107 @@
+import { DiscountGroup } from './discount_group.js';
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+import { InventoryUnitVariation } from './inventory_unit_variation.js';
+import { Variation } from './variation.js';
+import { VariationField } from './variation_field.js';
+
+export class VariationFieldsOption extends Entity {
+  protected static resourceName = 'variation_fields_options';
+  protected static singularName = 'variationFieldsOption';
+  protected static pluralName = 'variationFieldsOptions';
+
+  @VariationFieldsOption.property({type: Date})
+  public archived?: Date | null;
+
+  @VariationFieldsOption.property()
+  public id?: number;
+
+  @VariationFieldsOption.property({type: String})
+  public value?: string | null;
+
+  @VariationFieldsOption.property({type: String})
+  public colour?: string | null;
+
+  @VariationFieldsOption.property()
+  public isExtracted?: boolean;
+
+  @VariationFieldsOption.property()
+  public currency?: string;
+
+  @VariationFieldsOption.property()
+  public default?: boolean;
+
+  @VariationFieldsOption.property()
+  public include?: boolean;
+
+  @VariationFieldsOption.property()
+  public noInventory?: boolean;
+
+  @VariationFieldsOption.property()
+  public position?: number;
+
+  @VariationFieldsOption.property()
+  public deliveryDays?: number;
+
+  @VariationFieldsOption.property()
+  public variationCost?: number;
+
+  @VariationFieldsOption.property({type: 'DiscountGroup'})
+  public variationCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationFieldsOption.property()
+  public variationUnitCost?: number;
+
+  @VariationFieldsOption.property({embeddedByDefault: false})
+  public buyUnitCost?: number;
+
+  @VariationFieldsOption.property({embeddedByDefault: false})
+  public buyCost?: number;
+
+  @VariationFieldsOption.property({type: 'DiscountGroup'})
+  public variationUnitCostDiscountGroup?: DiscountGroup | null;
+
+  @VariationFieldsOption.property({type: VariationField})
+  public variationField?: VariationField | null;
+
+  @VariationFieldsOption.property({type: MerchiFile})
+  public linkedFile?: MerchiFile | null;
+
+  @VariationFieldsOption.property({arrayType: 'Variation'})
+  public selectedByVariations?: Variation[];
+
+  @VariationFieldsOption.property({arrayType: 'InventoryUnitVariation'})
+  public inventoryUnitVariations?: InventoryUnitVariation[];
+
+  @VariationFieldsOption.property({arrayType: 'VariationFieldsOption'})
+  public selectedBy?: VariationFieldsOption[];
+
+  public totalCost = (quantity: number) => {
+    if (this.variationCost === undefined) {
+      throw new Error('variationCost is unknown');
+    }
+    if (this.variationUnitCost === undefined) {
+      throw new Error('variationUnitCost is unknown');
+    }
+    return this.variationCost + this.variationUnitCost * quantity;
+  };
+
+  public buildVariationOption = () => {
+    const result = new this.merchi.VariationOption(this.merchi);
+    result.optionId = this.id;
+    result.include = this.include;
+    result.value = this.value;
+    result.position = this.position;
+    result.default = this.default;
+    result.colour = this.colour;
+    result.linkedFile = this.linkedFile;
+    result.quantity = 0;
+
+    result.currency = this.currency;
+    result.unitCost = this.variationUnitCost;
+    result.unitCostTotal = 0;
+    result.onceOffCost = this.variationCost;
+    result.totalCost = this.variationCost;
+    return result;
+  };
+}

package/src/entities/variation_option.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make Variation', () => {
+  const merchi = new Merchi();
+  const option = new merchi.VariationOption();
+  expect(option).toBeTruthy();
+});

package/src/entities/variation_option.ts

@@ -0,0 +1,58 @@
+import { Entity } from '../entity.js';
+import { MerchiFile } from './file.js';
+
+export class VariationOption extends Entity {
+  protected static singularName = 'variationOption';
+  protected static pluralName = 'variationOptions';
+
+  @VariationOption.property()
+  public optionId?: number;
+
+  @VariationOption.property({type: String})
+  public value?: string | null;
+
+  @VariationOption.property({type: String})
+  public colour?: string | null;
+
+  @VariationOption.property()
+  public position?: number;
+
+  @VariationOption.property()
+  public available?: boolean;
+
+  @VariationOption.property()
+  public default?: boolean;
+
+  @VariationOption.property()
+  public include?: boolean;
+
+  @VariationOption.property()
+  public isVisible?: boolean;
+
+  @VariationOption.property({type: MerchiFile})
+  public linkedFile?: MerchiFile | null;
+
+  @VariationOption.property()
+  public fieldName?: string;
+
+  @VariationOption.property()
+  public userDeadline?: Date;
+
+  @VariationOption.property()
+  public quantity?: number;
+
+  @VariationOption.property()
+  public currency?: string;
+
+  @VariationOption.property()
+  public onceOffCost?: number;
+
+  @VariationOption.property()
+  public unitCost?: number;
+
+  @VariationOption.property()
+  public unitCostTotal?: number;
+
+  @VariationOption.property()
+  public totalCost?: number;
+}

package/src/entities/variations_group.test.ts

@@ -0,0 +1,7 @@
+import { Merchi } from '../merchi.js';
+
+test('can make VariationsGroup', () => {
+  const merchi = new Merchi();
+  const variationsGroup = new merchi.VariationsGroup();
+  expect(variationsGroup).toBeTruthy();
+});

package/src/entities/variations_group.ts

@@ -0,0 +1,41 @@
+import { CartItem } from './cart_item.js';
+import { Entity } from '../entity.js';
+import { Job } from './job.js';
+import { Variation } from './variation.js';
+import { MatchingInventory } from './matching_inventory.js';
+
+export class VariationsGroup extends Entity {
+  protected static resourceName = 'variations_groups';
+  protected static singularName = 'variationsGroup';
+  protected static pluralName = 'variationsGroups';
+
+  @VariationsGroup.property({type: Date})
+  public archived?: Date | null;
+
+  @VariationsGroup.property()
+  public id?: number;
+
+  @VariationsGroup.property()
+  public quantity?: number;
+
+  @VariationsGroup.property({type: Number})
+  public groupCost?: number | null;
+
+  @VariationsGroup.property({type: Job})
+  public job?: Job | null;
+
+  @VariationsGroup.property({type: CartItem})
+  public cartItem?: CartItem | null;
+
+  @VariationsGroup.property({type: MatchingInventory})
+  public matchingInventory?: MatchingInventory | null;
+
+  @VariationsGroup.property({arrayType: 'Variation'})
+  public variations?: Variation[];
+
+  @VariationsGroup.property({embeddedByDefault: false})
+  public inventoryCount?: number;
+
+  @VariationsGroup.property({embeddedByDefault: false})
+  public inventorySufficient?: boolean;
+}