@merchi/sdk 1.40.2

package/src/entities/enrolled_domain.ts

@@ -0,0 +1,40 @@
+import { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import { User } from './user.js';
+import { Role } from '../constants/roles.js';
+import { DomainType } from '../constants/domain_types.js';
+
+export class EnrolledDomain extends Entity {
+  protected static resourceName = 'enrolled_domains';
+  protected static singularName = 'enrolledDomain';
+  protected static pluralName = 'enrolledDomains';
+
+  @EnrolledDomain.property({type: Date})
+  public archived?: Date | null;
+
+  @EnrolledDomain.property()
+  public id?: number;
+
+  @EnrolledDomain.property()
+  public isJobsAssignee?: boolean;
+
+  @EnrolledDomain.property()
+  public role?: Role;
+
+  @EnrolledDomain.property()
+  public user?: User;
+
+  @EnrolledDomain.property()
+  public domain?: Domain;
+
+  public getRole(): Role {
+    if (this.domain === undefined) {
+      const err = 'domain is undefined, did you forget to embed it?';
+      throw new Error(err);
+    }
+    if (this.domain.domainType === DomainType.DOMAIN_SUPPLIER) {
+      return Role.SUPPLIER;
+    }
+    return this.role ? this.role : Role.PUBLIC;
+  }
+}

package/src/entities/exchange_rate.test.ts

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

package/src/entities/exchange_rate.ts

@@ -0,0 +1,22 @@
+import { Entity } from '../entity.js';
+
+export class ExchangeRate extends Entity {
+  protected static resourceName = 'exchange_rates';
+  protected static singularName = 'exchangeRate';
+  protected static pluralName = 'exchangeRates';
+
+  @ExchangeRate.property()
+  public id?: number;
+
+  @ExchangeRate.property()
+  public fromCurrency?: string;
+
+  @ExchangeRate.property()
+  public toCurrency?: string;
+
+  @ExchangeRate.property()
+  public rate?: number;
+
+  @ExchangeRate.property()
+  public lastUpdated?: Date;
+}

package/src/entities/file.test.ts

@@ -0,0 +1,43 @@
+import { Merchi } from '../merchi.js';
+import { setup, mockFetch } from '../test_util.js';
+
+setup();
+
+test('can make file', () => {
+  const merchi = new Merchi();
+  const file = new merchi.MerchiFile();
+  expect(file).toBeTruthy();
+});
+
+test('can get and set id', () => {
+  const merchi = new Merchi();
+  const file = new merchi.MerchiFile();
+  file.id = 2;
+  expect(file.id).toBe(2);
+});
+
+test('can upload file', () => {
+  const merchi = new Merchi();
+  const file = new merchi.MerchiFile();
+  const jsFile = new File([''], 'name');
+  file.fromFormFile(jsFile);
+  const fetch = mockFetch(true, {}, 200);
+  file.create();
+  const sentToServer = fetch.mock.calls[0][1];
+  expect(sentToServer.method).toBe('POST');
+  const data: any = Array.from(sentToServer.body.entries());
+  expect(data[0][1]).toBe(jsFile);
+  expect(data[1]).toEqual(['fileDataIndex', '0']);
+});
+
+test('isImage', () => {
+  const merchi = new Merchi();
+  const file = new merchi.MerchiFile();
+  expect(file.isImage).toThrow();
+  file.mimetype = null;
+  expect(file.isImage()).toEqual(false);
+  file.mimetype = 'application/pdf';
+  expect(file.isImage()).toEqual(false);
+  file.mimetype = 'image/png';
+  expect(file.isImage()).toEqual(true);
+});

package/src/entities/file.ts

@@ -0,0 +1,165 @@
+import { Company } from './company.js';
+import { Domain } from './domain.js';
+import { Draft } from './draft.js';
+import { DraftComment } from './draft_comment.js';
+import { Entity } from '../entity.js';
+import { Invoice } from './invoice.js';
+import { Job } from './job.js';
+import { JobComment } from './job_comment.js';
+import { JobNote } from './job_note.js';
+import { Notification } from './notification.js';
+import { Product } from './product.js';
+import { ProductionComment } from './production_comment.js';
+import { Theme } from './theme.js';
+import { User } from './user.js';
+import { Variation } from './variation.js';
+import { VariationFieldsOption } from './variation_fields_option.js';
+
+export class MerchiFile extends Entity {
+  protected static resourceName = 'files';
+  protected static singularName = 'file';
+  protected static pluralName = 'files';
+
+  public fileData?: File;
+
+  public fromFormFile = (file: File) => {
+    this.fileData = file;
+    this.mimetype = file.type || 'application/octet-stream';
+    this.name = file.name;
+    this.size = file.size;
+  };
+
+  @MerchiFile.property({type: Date})
+  public archived?: Date | null;
+
+  @MerchiFile.property()
+  public id?: number;
+
+  @MerchiFile.property()
+  public uploadId?: string;
+
+  @MerchiFile.property({type: String})
+  public name?: string | null;
+
+  @MerchiFile.property({type: String})
+  public mimetype?: string | null;
+
+  @MerchiFile.property()
+  public size?: number;
+
+  @MerchiFile.property({type: Date})
+  public creationDate?: Date | null;
+
+  @MerchiFile.property({type: String})
+  public cachedViewUrl?: string | null;
+
+  @MerchiFile.property({type: Date})
+  public viewUrlExpires?: Date | null;
+
+  @MerchiFile.property({type: String})
+  public cachedDownloadUrl?: string | null;
+
+  @MerchiFile.property({type: Date})
+  public downloadUrlExpires?: Date | null;
+
+  @MerchiFile.property({type: User})
+  public uploader?: User | null;
+
+  @MerchiFile.property()
+  public viewUrl?: string;
+
+  @MerchiFile.property()
+  public downloadUrl?: string;
+
+  @MerchiFile.property({arrayType: 'DraftComment'})
+  public draftComments?: DraftComment[];
+
+  @MerchiFile.property({arrayType: 'Variation'})
+  public variations?: Variation[];
+
+  @MerchiFile.property({arrayType: 'Notification'})
+  public notification?: Notification[];
+
+  @MerchiFile.property({arrayType: 'Company'})
+  public companyLogos?: Company[];
+
+  @MerchiFile.property({arrayType: 'Product'})
+  public products?: Product[];
+
+  @MerchiFile.property({arrayType: 'Product'})
+  public featuredProducts?: Product[];
+
+  @MerchiFile.property({arrayType: 'Draft'})
+  public drafts?: Draft[];
+
+  @MerchiFile.property({arrayType: 'VariationFieldsOption'})
+  public options?: VariationFieldsOption[];
+
+  @MerchiFile.property({arrayType: 'JobComment'})
+  public jobComments?: JobComment[];
+
+  @MerchiFile.property({arrayType: 'JobNote'})
+  public jobNotes?: JobNote[];
+
+  @MerchiFile.property({arrayType: 'Job'})
+  public jobs?: Job[];
+
+  @MerchiFile.property({arrayType: 'Job'})
+  public clientJobs?: Job[];
+
+  @MerchiFile.property({arrayType: 'Domain'})
+  public domainLogos?: Domain[];
+
+  @MerchiFile.property({arrayType: 'Domain'})
+  public domainFavicons?: Domain[];
+
+  @MerchiFile.property({arrayType: 'User'})
+  public userProfilePictures?: User[];
+
+  @MerchiFile.property({arrayType: 'Invoice'})
+  public invoices?: Invoice[];
+
+  @MerchiFile.property({arrayType: 'Invoice'})
+  public invoicesPaid?: Invoice[];
+
+  @MerchiFile.property({arrayType: 'Theme'})
+  public themeMainCss?: Theme[];
+
+  @MerchiFile.property({arrayType: 'Theme'})
+  public themeMainCssUsing?: Theme[];
+
+  @MerchiFile.property({arrayType: 'Theme'})
+  public themeMainCssEditing?: Theme[];
+
+  @MerchiFile.property({arrayType: 'Theme'})
+  public themeEmailCss?: Theme[];
+
+  @MerchiFile.property({arrayType: 'Theme'})
+  public themeEmailCssUsing?: Theme[];
+
+  @MerchiFile.property({arrayType: 'Theme'})
+  public themeEmailCssEditing?: Theme[];
+
+  @MerchiFile.property({arrayType: 'Theme'})
+  public themes?: Theme[];
+
+  @MerchiFile.property({arrayType: 'Theme'})
+  public themeFeatureImages?: Theme[];
+
+  @MerchiFile.property({arrayType: 'Theme'})
+  public themeImages?: Theme[];
+
+  @MerchiFile.property({arrayType: 'ProductionComment'})
+  public productionComments?: ProductionComment[];
+
+  public isImage = () => {
+    if (this.mimetype === undefined) {
+      const err = 'mimetype is undefined, did you forget to embed it?';
+      throw new Error(err);
+    }
+    if (this.mimetype === null) {
+      return false;
+    }
+    return this.mimetype.split('/')[0] === 'image';
+  };
+}

package/src/entities/internal_tag.test.ts

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

package/src/entities/internal_tag.ts

@@ -0,0 +1,51 @@
+import { Company } from './company.js';
+import { Domain } from './domain.js';
+import { Entity } from '../entity.js';
+import { Invoice } from './invoice.js';
+import { Job } from './job.js';
+import { Product } from './product.js';
+import { Shipment } from './shipment.js';
+import { Theme } from './theme.js';
+import { User } from './user.js';
+
+export class InternalTag extends Entity {
+  protected static resourceName = 'internal_tags';
+  protected static singularName = 'internalTag';
+  protected static pluralName = 'internalTags';
+
+  @InternalTag.property()
+  public id?: number;
+
+  @InternalTag.property()
+  public colour?: number;
+
+  @InternalTag.property()
+  public name?: string;
+
+  @InternalTag.property()
+  public description?: string;
+
+  @InternalTag.property({arrayType: 'Company'})
+  public companies?: Company[];
+
+  @InternalTag.property({arrayType: 'Domain'})
+  public domains?: Domain[];
+
+  @InternalTag.property({arrayType: 'Job'})
+  public jobs?: Job[];
+
+  @InternalTag.property({arrayType: 'Product'})
+  public products?: Product[];
+
+  @InternalTag.property({arrayType: 'Invoice'})
+  public invoices?: Invoice[];
+
+  @InternalTag.property({arrayType: 'Shipment'})
+  public shipments?: Shipment[];
+
+  @InternalTag.property({arrayType: 'Theme'})
+  public themes?: Theme[];
+
+  @InternalTag.property({arrayType: 'User'})
+  public users?: User[];
+}

package/src/entities/inventory.test.ts

@@ -0,0 +1,28 @@
+import { Merchi } from '../merchi.js';
+
+test('can make Inventory', () => {
+  const merchi = new Merchi();
+  const inventory = new merchi.Inventory();
+  expect(inventory).toBeTruthy();
+});
+
+test('isVariationFieldOptionSelected function', () => {
+  const merchi = new Merchi();
+  const inventory = new merchi.Inventory();
+  const option1 = new merchi.VariationFieldsOption();
+  option1.id = 1;
+  const option2 = new merchi.VariationFieldsOption();
+  option2.id = 2;
+  expect(() => inventory.isVariationFieldOptionSelected(option1)).toThrow();
+
+  const inventoryUnitVariation = new merchi.InventoryUnitVariation();
+  inventory.inventoryUnitVariations = [inventoryUnitVariation];
+
+  expect(() => inventory.isVariationFieldOptionSelected(option1)).toThrow();
+
+  inventoryUnitVariation.variationFieldsOption = option2;
+  expect(inventory.isVariationFieldOptionSelected(option1)).toBe(false);
+
+  inventoryUnitVariation.variationFieldsOption = option1;
+  expect(inventory.isVariationFieldOptionSelected(option1)).toBe(true);
+});

package/src/entities/inventory.ts

@@ -0,0 +1,63 @@
+import { Address } from './address.js';
+import { Entity } from '../entity.js';
+import { InventoryGroup } from './inventory_group.js';
+import { InventoryUnitVariation } from './inventory_unit_variation.js';
+import { Job } from './job.js';
+import { Product } from './product.js';
+import { VariationsGroup } from './variations_group.js';
+import { VariationFieldsOption } from './variation_fields_option.js';
+import { some } from 'lodash';
+
+export class Inventory extends Entity {
+  protected static resourceName = 'inventories';
+  protected static singularName = 'inventory';
+  protected static pluralName = 'inventories';
+
+  @Inventory.property({type: Date})
+  public archived?: Date | null;
+
+  @Inventory.property()
+  public id?: number;
+
+  @Inventory.property()
+  public quantity?: number;
+
+  @Inventory.property()
+  public name?: string;
+
+  @Inventory.property()
+  public position?: number;
+
+  @Inventory.property()
+  public notes?: string;
+
+  @Inventory.property()
+  public isOrphan?: boolean;
+
+  @Inventory.property({arrayType: 'Product'})
+  public products?: Product[];
+
+  @Inventory.property({arrayType: 'InventoryGroup'})
+  public inventoryGroups?: InventoryGroup[];
+
+  @Inventory.property({type: Address})
+  public address?: Address | null;
+
+  @Inventory.property({arrayType: 'VariationsGroup'})
+  public variationsGroups?: VariationsGroup[];
+
+  @Inventory.property({arrayType: 'Job'})
+  public jobs?: Job[];
+
+  @Inventory.property({arrayType: 'InventoryUnitVariation'})
+  public inventoryUnitVariations?: InventoryUnitVariation[];
+
+  public isVariationFieldOptionSelected = (option: VariationFieldsOption) => {
+    if (this.inventoryUnitVariations === undefined) {
+      throw new Error(
+        'inventoryUnitVariations is undefined, did you forget to embed it?');
+    }
+    return some(this.inventoryUnitVariations.map(
+      (v: InventoryUnitVariation) => v.optionId() === option.id));
+  };
+}

package/src/entities/inventory_group.test.ts

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

package/src/entities/inventory_group.ts

@@ -0,0 +1,36 @@
+import { Entity } from '../entity.js';
+import { Company } from './company.js';
+import { Inventory } from './inventory.js';
+import { Job } from './job.js';
+import { Product } from './product.js';
+import { VariationField } from './variation_field.js';
+
+export class InventoryGroup extends Entity {
+  protected static resourceName = 'inventory_groups';
+  protected static singularName = 'inventoryGroup';
+  protected static pluralName = 'inventoryGroups';
+
+  @InventoryGroup.property({type: Date})
+  public archived?: Date | null;
+
+  @InventoryGroup.property()
+  public id?: number;
+
+  @InventoryGroup.property({type: 'Company'})
+  public company?: Company;
+
+  @InventoryGroup.property({arrayType: 'Inventory'})
+  public inventories?: Inventory[];
+
+  @InventoryGroup.property()
+  public name?: string;
+
+  @InventoryGroup.property({arrayType: 'Product'})
+  public products?: Product[];
+
+  @InventoryGroup.property({arrayType: 'Job'})
+  public jobs?: Job[];
+
+  @InventoryGroup.property({arrayType: 'VariationField'})
+  public variationFields?: VariationField[];
+}

package/src/entities/inventory_unit_variation.test.ts

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

package/src/entities/inventory_unit_variation.ts

@@ -0,0 +1,29 @@
+import { Entity } from '../entity.js';
+import { Inventory } from './inventory.js';
+import { VariationFieldsOption } from './variation_fields_option.js';
+
+export class InventoryUnitVariation extends Entity {
+  protected static resourceName = 'inventory_unit_variations';
+  protected static singularName = 'inventoryUnitVariation';
+  protected static pluralName = 'inventoryUnitVariations';
+
+  @InventoryUnitVariation.property({type: Date})
+  public archived?: Date | null;
+
+  @InventoryUnitVariation.property()
+  public id?: number;
+
+  @InventoryUnitVariation.property()
+  public inventory?: Inventory;
+
+  @InventoryUnitVariation.property()
+  public variationFieldsOption?: VariationFieldsOption;
+
+  public optionId = () => {
+    if (this.variationFieldsOption === undefined) {
+      throw new Error(
+        'variationFieldsOption is undefined, did you forget to embed it?');
+    }
+    return this.variationFieldsOption.id;
+  };
+}

package/src/entities/invoice.test.ts

@@ -0,0 +1,50 @@
+import { setup, mockFetch } from '../test_util.js';
+import { Merchi } from '../merchi.js';
+
+setup();
+
+test('can make Invoice', () => {
+  const merchi = new Merchi();
+  const invoice = new merchi.Invoice();
+  expect(invoice).toBeTruthy();
+});
+
+test('pass cookie tokens to query string', () => {
+  const cookie = 'session_token=s; client_token=c; invoice_token=i';
+  Object.defineProperty(document, 'cookie', {
+    get: jest.fn().mockImplementation(() => { return cookie; }),
+    set: jest.fn().mockImplementation(() => {}),
+  });
+  const correct = [
+    ['skip_rights', 'y'],
+    ['session_token', 's'],
+    ['client_token', 'c'],
+    ['invoice_token', 'i'],
+  ];
+  const fetch = mockFetch(true, {'invoice': {'id': 1}}, 200);
+  const merchi = new Merchi();
+  const invocation = merchi.Invoice.get(1);
+  expect(fetch.mock.calls[0][1]['query']).toEqual(correct);
+  return invocation;
+});
+
+test('client and invoice tokens supported by merchi', () => {
+  const merchi = new Merchi('s', 'c', 'i');
+  const correct = [
+    ['skip_rights', 'y'],
+    ['session_token', 's'],
+    ['client_token', 'c'],
+    ['invoice_token', 'i'],
+  ];
+  const fetch = mockFetch(true, {'invoice': {'id': 1}}, 200);
+  const invocation = merchi.Invoice.get(1);
+  expect(fetch.mock.calls[0][1]['query']).toEqual(correct);
+  return invocation;
+});
+
+test('preserves server payment engine hint', () => {
+  const merchi = new Merchi();
+  const entity = new merchi.Invoice();
+  entity.fromJson({ id: 1, stripePaymentEngine: 'wallet' });
+  expect(entity.toJson()).toMatchObject({ stripePaymentEngine: 'wallet' });
+});