merchi_sdk_ts 0.0.1

package/src/entities/product.ts

@@ -0,0 +1,427 @@
+import * as _ from 'lodash';
+import { CartItem } from './cart_item';
+import { Category } from './category';
+import { Company } from './company';
+import { Component } from './component';
+import { CountryTax } from './country_tax';
+import { DiscountGroup } from './discount_group';
+import { Domain } from './domain';
+import { DomainTag } from './domain_tag';
+import { DraftTemplate } from './draft_template';
+import { Entity } from '../entity';
+import { MerchiFile } from './file';
+import { InternalTag } from './internal_tag';
+import { Inventory } from './inventory';
+import { Job } from './job';
+import { SupplyDomain } from './supply_domain';
+import { User } from './user';
+import { VariationField } from './variation_field';
+import { SeoDomainPage } from './seo_domain_page';
+import { ShipmentMethod } from './shipment_method';
+import {
+  AutoAssignProductionOnAction
+} from '../constants/auto_assign_production_on_actions';
+
+export class Product extends Entity {
+  protected static resourceName = 'products';
+  protected static singularName = 'product';
+  protected static pluralName = 'products';
+
+  @Product.property({type: Date})
+  public archived?: Date | null;
+
+  @Product.property()
+  public id?: number;
+
+  @Component.property({type: Date})
+  public created?: Date;
+
+  @Component.property({type: Date})
+  public updated?: Date;
+
+  @Component.property({type: 'User'})
+  public createdBy?: User | null;
+
+  @Component.property({type: 'User'})
+  public updatedBy?: User | null;
+
+  @Product.property()
+  public productType?: number;
+
+  @Product.property()
+  public minimum?: number;
+
+  @Product.property()
+  public minimumPerGroup?: boolean;
+
+  @Product.property()
+  public deliveryDaysNormal?: number;
+
+  @Product.property()
+  public unitPrice?: number;
+
+  @Product.property({embeddedByDefault: false})
+  public buyUnitPrice?: number;
+
+  @Product.property({type: 'DiscountGroup'})
+  public unitPriceDiscountGroup?: DiscountGroup | null;
+
+  @Product.property({arrayType: 'ShipmentMethod'})
+  public shipmentMethods?: ShipmentMethod[];
+
+  @Product.property()
+  public margin?: number;
+
+  @Product.property({type: Number})
+  public unitWeight?: number | null;
+
+  @Product.property({type: Number})
+  public unitHeight?: number | null;
+
+  @Product.property({type: Number})
+  public unitWidth?: number | null;
+
+  @Product.property({type: Number})
+  public unitDepth?: number | null;
+
+  @Product.property()
+  public name?: string;
+
+  @Product.property()
+  public country?: string;
+
+  @Product.property()
+  public currency?: string;
+
+  @Product.property({type: String})
+  public description?: string | null;
+
+  @Product.property({type: String})
+  public notes?: string | null;
+
+  @Product.property({type: String})
+  public internalUseNotes?: string;
+
+  @Product.property({type: String})
+  public internalUseAiContext?: string;
+
+  @Product.property({type: String})
+  public aiContext?: string;
+
+  @Product.property({type: String})
+  public shopifyProductId?: string | null;
+
+  @Product.property()
+  public useCompanyShipmentMethods?: boolean;
+
+  @Product.property()
+  public dropShipment?: boolean;
+
+  @Product.property()
+  public needsDrafting?: boolean;
+
+  @Product.property()
+  public needsProduction?: boolean;
+
+  @Product.property()
+  public needsShipping?: boolean;
+
+  @Product.property()
+  public needsInvoicing?: boolean;
+
+  @Product.property()
+  public needsInventory?: boolean;
+
+  @Product.property({type: Date})
+  public featureDeadline?: Date;
+
+  @Product.property()
+  public showFeatureDeadline?: boolean;
+
+  @Product.property()
+  public showPublic?: boolean;
+
+  @Product.property()
+  public showGroupBuyStatus?: boolean;
+
+  @Product.property({type: Number})
+  public groupBuyStatus?: number | null;
+
+  @Product.property()
+  public acceptSquare?: boolean;
+
+  @Product.property()
+  public acceptStripe?: boolean;
+
+  @Product.property()
+  public acceptPaypal?: boolean;
+
+  @Product.property()
+  public acceptUtrust?: boolean;
+
+  @Product.property()
+  public acceptBankTransfer?: boolean;
+
+  @Product.property()
+  public acceptPhonePayment?: boolean;
+
+  @Product.property()
+  public allowAutomaticPaymentSupply?: boolean;
+
+  @Product.property()
+  public allowGroupBuy?: boolean;
+
+  @Product.property()
+  public allowPaymentUpfront?: boolean;
+
+  @Product.property()
+  public allowQuotation?: boolean;
+
+  @Product.property()
+  public allowChainedInventoryCreation?: boolean;
+
+  @Product.property()
+  public allowClientDraftContribution?: boolean;
+
+  @Product.property()
+  public chainedInventoryHandlingUnitPrice?: number;
+
+  @Product.property()
+  public bestPrice?: number;
+
+  @Product.property()
+  public unitVolume?: number;
+
+  @Product.property({arrayType: 'Category'})
+  public categories?: Category[];
+
+  @Product.property({arrayType: 'Category'})
+  public platformCategories?: Category[];
+
+  @Product.property({arrayType: 'DiscountGroup'})
+  public discountGroups?: DiscountGroup[];
+
+  @Product.property()
+  public domain?: Domain;
+
+  @Product.property({type: CountryTax})
+  public taxType?: CountryTax | null;
+
+  @Product.property({type: Product})
+  public originalProduct?: Product | null;
+
+  @Product.property({type: Product})
+  public clonedFromProduct?: Product | null;
+
+  @Product.property({type: Product})
+  public chainedSupplierProduct?: Product | null;
+
+  @Product.property({arrayType: 'Product'})
+  public chainedSellerProducts?: Product[];
+
+  @Product.property({type: Product})
+  public chainedInventorySupplierProduct?: Product | null;
+
+  @Product.property({arrayType: 'Product'})
+  public chainedInventorySellerProducts?: Product[];
+
+  @Product.property({type: Component})
+  public component?: Component | null;
+
+  @Product.property({arrayType: 'MerchiFile'})
+  public images?: MerchiFile[];
+
+  @Product.property({arrayType: 'MerchiFile'})
+  public publicFiles?: MerchiFile[];
+
+  @Product.property({arrayType: 'MerchiFile'})
+  public productionFiles?: MerchiFile[];
+
+  @Product.property({arrayType: 'VariationField'})
+  public groupVariationFields?: VariationField[];
+
+  @Product.property({arrayType: 'VariationField'})
+  public independentVariationFields?: VariationField[];
+
+  @Product.property({arrayType: 'DomainTag'})
+  public tags?: DomainTag[];
+
+  @Product.property({arrayType: 'InternalTag'})
+  public internalTags?: InternalTag[];
+
+  @Product.property({arrayType: 'SeoDomainPage'})
+  public seoDomainPages?: SeoDomainPage[];
+
+  @Product.property({type: MerchiFile})
+  public featureImage?: MerchiFile | null;
+
+  @Product.property({type: 'Job'})
+  public createdByJob?: Job | null;
+
+  @Product.property({type: 'Job'})
+  public defaultJob?: Job;
+
+  @Product.property({arrayType: 'Company', jsonName: 'saved_by_companies'})
+  public savedByCompanies?: Company[];
+
+  @Product.property({arrayType: 'SupplyDomain'})
+  public suppliedByDomains?: SupplyDomain[];
+
+  @Product.property()
+  public autoAssignProductionOnAction?: AutoAssignProductionOnAction;
+
+  @Product.property({arrayType: 'SupplyDomain'})
+  public supplyDomains?: SupplyDomain[];
+
+  @Product.property()
+  public inventoriesOpen?: boolean;
+
+  @Product.property()
+  public supplyChainDisabled?: boolean;
+
+  @Product.property({arrayType: 'Inventory'})
+  public inventories?: Inventory[];
+
+  @Product.property({arrayType: 'CartItem'})
+  public cartItems?: CartItem[];
+
+  @Product.property({arrayType: 'Job'})
+  public jobs?: Job[];
+
+  @Product.property({arrayType: 'Job'})
+  public supplyChainRequestJobs?: Job[];
+
+  @Product.property({arrayType: 'User', jsonName: 'saved_by_users'})
+  public savedByUsers?: User[];
+
+  @Product.property({arrayType: 'User'})
+  public suppliers?: User[];
+
+  @Product.property({arrayType: 'DraftTemplate'})
+  public draftTemplates?: DraftTemplate[];
+
+  public duplicate = () => {
+    /* create a clone of this product on the backend, returning it. */
+    const constructor = this.constructor as typeof Product;
+    const resourceName = constructor.resourceName;
+    const singularName = constructor.singularName;
+    const resource = `/${resourceName}/${String(this.id)}/copy/`;
+    const fetchOptions = {method: 'POST'};
+    return this.merchi.authenticatedFetch(resource, fetchOptions).
+      then((data: any) => {
+        const product = new this.merchi.Product();
+        product.fromJson(data[singularName]);
+        return product;
+      });
+  };
+
+  public primaryImage = () => {
+    if (this.featureImage === undefined) {
+      throw new Error('featureImage is undefined, did you forget to embed it?');
+    }
+    if (this.images === undefined) {
+      throw new Error('images is undefined, did you forget to embed it?');
+    }
+    if (this.featureImage !== null) {
+      return this.featureImage;
+    }
+    if (this.images.length > 0) {
+      return this.images[0];
+    }
+    return null;
+  };
+
+  public hasGroupVariationFields = () => {
+    if (this.groupVariationFields === undefined) {
+      const err = 'groupVariationFields is undefined, did you forget to embed' +
+        ' it?';
+      throw new Error(err);
+    }
+    return this.groupVariationFields.length > 0;
+  };
+
+  public hasIndependentVariationFields = () => {
+    if (this.independentVariationFields === undefined) {
+      const err = 'independentVariationFields is undefined, did you forget to' +
+        ' embed it?';
+      throw new Error(err);
+    }
+    return this.independentVariationFields.length > 0;
+  };
+
+  public allVariationFields = () => {
+    if (this.groupVariationFields === undefined) {
+      const err = 'groupVariationFields is undefined, did you forget to embed' +
+        ' it?';
+      throw new Error(err);
+    }
+    if (this.independentVariationFields === undefined) {
+      const err = 'independentVariationFields is undefined, did you forget to' +
+        ' embed it?';
+      throw new Error(err);
+    }
+    const result: VariationField[] = [];
+    return result.concat(this.groupVariationFields,
+      this.independentVariationFields);
+  };
+
+  public buildEmptyVariations = () => {
+    if (this.independentVariationFields === undefined) {
+      const err = 'independentVariationFields is undefined, did you forget to' +
+        ' embed it?';
+      throw new Error(err);
+    }
+    const iVF: VariationField[] =
+      _.orderBy(this.independentVariationFields, ['position'], ['asc']);
+    return iVF.map(field => field.buildEmptyVariation());
+  };
+
+  public buildEmptyVariationGroup = () => {
+    if (this.groupVariationFields === undefined) {
+      const err = 'groupVariationFields is undefined, did you forget to embed' +
+        ' it?';
+      throw new Error(err);
+    }
+    const result = new this.merchi.VariationsGroup();
+    const variations = [];
+    let cost = 0;
+    const sortedFields = _.orderBy(
+      this.groupVariationFields, ['position'], ['asc']);
+    result.quantity = 0;
+    for (const variationField of sortedFields) {
+      const empty = variationField.buildEmptyVariation();
+      variations.push(empty);
+      cost += empty.cost as number;
+    }
+    result.groupCost = cost;
+    result.variations = variations;
+    return result;
+  };
+
+  public removeVariationField = (variationField: VariationField) => {
+    if (variationField.independent === undefined) {
+      throw new Error('variation.independent is undefined, did you ' +
+                      'forget to embed it?');
+    }
+    if (this.independentVariationFields === undefined) {
+      const err = 'independentVariationFields is undefined, did you forget to' +
+        ' embed it?';
+      throw new Error(err);
+    }
+    if (this.groupVariationFields === undefined) {
+      const err = 'groupVariationFields is undefined, did you forget to embed' +
+        ' it?';
+      throw new Error(err);
+    }
+    const variationFields = variationField.independent ?
+      this.independentVariationFields : this.groupVariationFields;
+    const index = variationFields.findIndex(v => {
+      if (v.id === undefined) {
+        throw new Error('variation id is undefined, did you forget to ' +
+          'embed it?');
+      }
+      return v.id === variationField.id;
+    });
+    return variationFields.splice(index, 1);
+  };
+}

package/src/entities/production_comment.test.ts

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

package/src/entities/production_comment.ts

@@ -0,0 +1,50 @@
+import { Assignment } from './assignment';
+import { Entity } from '../entity';
+import { MerchiFile } from './file';
+import { Notification } from './notification';
+import { User } from './user';
+
+export class ProductionComment extends Entity {
+  protected static resourceName = 'production_comments';
+  protected static singularName = 'productionComment';
+  protected static pluralName = 'productionComments';
+
+  @ProductionComment.property({type: Date})
+  public archived?: Date | null;
+
+  @ProductionComment.property()
+  public id?: number;
+
+  @ProductionComment.property({type: Date})
+  public date?: Date | null;
+
+  @ProductionComment.property()
+  public urgency?: number;
+
+  @ProductionComment.property()
+  public text?: string;
+
+  @ProductionComment.property()
+  public isUrgentQuestion?: boolean;
+
+  @ProductionComment.property()
+  public sendSms?: boolean;
+
+  @ProductionComment.property()
+  public sendEmail?: boolean;
+
+  @ProductionComment.property({arrayType: "MerchiFile"})
+  public files?: MerchiFile[];
+
+  @ProductionComment.property()
+  public user?: User;
+
+  @ProductionComment.property({arrayType: 'User'})
+  public forwards?: User[];
+
+  @ProductionComment.property({arrayType: 'Notification'})
+  public notifications?: Notification[];
+
+  @ProductionComment.property()
+  public assignment?: Assignment;
+}

package/src/entities/quote.test.ts

@@ -0,0 +1,98 @@
+import { Merchi } from '../merchi';
+
+test('can make Quote', () => {
+  const merchi = new Merchi();
+  const quote = new merchi.Quote();
+  expect(quote).toBeTruthy();
+});
+
+test('calculation', () => {
+  const merchi = new Merchi();
+  const quote = new merchi.Quote();
+  const gst = new merchi.CountryTax();
+  gst.taxName = 'GST';
+  gst.taxPercent = 10;
+  const noTax = merchi.CountryTax.getNoTax();
+
+  // quote items did not filled before calculation seems like a embed issue
+  expect(quote.quoteTotal).toThrow();
+  expect(quote.calculateSubTotal).toThrow();
+  expect(quote.calculateTaxAmount).toThrow();
+
+  quote.quoteItems = [new merchi.QuoteItem(), new merchi.QuoteItem()];
+  quote.quoteItems[0].unitPrice = 400;
+  quote.quoteItems[0].quantity = 2;
+  quote.quoteItems[0].taxType = gst;
+  quote.quoteItems[1].unitPrice = 25;
+  quote.quoteItems[1].quantity = 2;
+  quote.quoteItems[1].taxType = noTax;
+
+  // shipments did not filled before calculation seems like a embed issue
+  expect(quote.quoteTotal).toThrow();
+  expect(quote.calculateSubTotal).toThrow();
+  expect(quote.calculateTaxAmount).toThrow();
+
+  quote.shipments = [new merchi.Shipment()];
+  quote.shipments[0].cost = 100;
+  quote.shipments[0].taxType = gst;
+
+  // 800 * 1.1 + 25 * 2 + 100 * 1.1 = 1040
+  expect(quote.quoteTotal()).toBe('1040.000');
+  expect(quote.quoteTotal({'strictEmbed': false})).toBe('1040.000');
+  expect(quote.calculateTotal()).toBe('1040.000');
+  expect(quote.calculateTotal({'strictEmbed': false})).toBe('1040.000');
+
+  // 800 + 25 * 2 + 100
+  expect(quote.calculateSubTotal()).toBe('950.000');
+  expect(quote.calculateSubTotal({'strictEmbed': false})).toBe('950.000');
+
+  // 800 * 0.1 + 100 * 0.1
+  expect(quote.calculateTaxAmount()).toBe('90.000');
+  expect(quote.calculateTaxAmount({'strictEmbed': false})).toBe('90.000');
+});
+
+test('findQuoteItemIndex', () => {
+  const merchi = new Merchi();
+  const quote = new merchi.Quote();
+  expect(() => quote.findQuoteItemIndex(43)).toThrow();
+  quote.quoteItems = [];
+  expect(quote.findQuoteItemIndex(43)).toEqual(-1);
+  quote.quoteItems = [new merchi.QuoteItem()];
+  quote.quoteItems[0].id = 43;
+  expect(quote.findQuoteItemIndex(43)).toEqual(0);
+});
+
+test('removeQuoteItem', () => {
+  const merchi = new Merchi();
+  const quote = new merchi.Quote();
+  const quoteItem = new merchi.QuoteItem();
+  quoteItem.id = 43;
+  expect(() => quote.removeQuoteItem(quoteItem)).toThrow();
+  quoteItem.id = undefined;
+  expect(() => quote.removeQuoteItem(quoteItem)).toThrow();
+  quoteItem.id = 43;
+  quote.quoteItems = [];
+  expect(quote.removeQuoteItem(quoteItem)).toBe(undefined);
+  expect(quote.quoteItems).toEqual([]);
+  quote.quoteItems = [quoteItem];
+  expect(quote.removeQuoteItem(quoteItem)).toBe(undefined);
+  expect(quote.quoteItems).toEqual([]);
+  quoteItem.id = undefined;
+  expect(() => quote.removeQuoteItem(quoteItem)).toThrow();
+});
+
+test('deadlineTimeDifference', () => {
+  const merchi = new Merchi();
+  const quote = new merchi.Quote();
+  expect(quote.deadlineTimeDifference).toThrow();
+  quote.agreedDeadline = null;
+  expect(quote.deadlineTimeDifference).toThrow();
+  quote.assignments = [];
+  expect(quote.deadlineTimeDifference()).toBe(null);
+  quote.assignments = [new merchi.Assignment()];
+  expect(quote.deadlineTimeDifference()).toBe(null);
+  quote.agreedDeadline = new Date(1);
+  expect(quote.deadlineTimeDifference).toThrow();
+  quote.assignments[0].productionDeadline = new Date(2);
+  expect(quote.deadlineTimeDifference()).toEqual(1);
+});