merchi_sdk_ts 0.0.1-a

package/src/constants/product_types.ts

@@ -0,0 +1,25 @@
+export enum ProductType {
+  SUPPLIER_MOD = 0,
+  SUPPLIER = 1,
+  SELLER = 2,
+  SELLER_MOD = 3,
+  CLONED_SUPPLIER_MOD = 4,
+  CLONED_SELLER_MOD = 5,
+  PRODUCTION_MOD = 6,
+  CLONED_SUPPLIER = 7,
+  INVENTORY_SELLER = 8,
+  INVENTORY_SUPPLIER = 9,
+  SELLER_GROUP_BUY = 10,
+  SUPPLIER_RESELL_MOD = 11,
+  SUPPLIER_RESELL = 12,
+  SUPPLIER_GROUP_BUY_INVENTORY = 13,
+  CLONED_INVENTORY_SELLER = 14,
+  CLONED_SELLER_GROUP_BUY_INVENTORY = 15,
+  CLONED_SUPPLIER_RESELL_MOD = 16,
+  SUPPLIER_TO_SUPPLIER_RESELL_MOD = 17,
+  CLONED_SUPPLIER_RESELL = 18,
+  SUPPLY_DOMAIN_REFERENCE = 19,
+  SELLER_FILE_DOWNLOAD = 20,
+  SUPPLIER_MOD_SUPPLY_CHAIN_REQUEST = 21,
+  SUPPLIER_SUPPLY_CHAIN_REQUEST = 22,
+}

package/src/constants/rights.test.ts

@@ -0,0 +1,5 @@
+import { Right } from './rights';
+
+test('access right exists', () => {
+  expect(Right.ACCESS).toBe(1);
+});

package/src/constants/rights.ts

@@ -0,0 +1,5 @@
+export enum Right {
+  ACCESS = 1,
+  EDIT = 2,
+  DELETE = 3,
+}

package/src/constants/robots_meta_directives.test.ts

@@ -0,0 +1,5 @@
+import { robotsMetaDirectives } from './robots_meta_directives';
+
+test('robot meta directive exists', () => {
+  expect(robotsMetaDirectives[0]).toBe('noindex');
+});

package/src/constants/robots_meta_directives.ts

@@ -0,0 +1,11 @@
+export const robotsMetaDirectives = [
+  'noindex',
+  'index',
+  'follow',
+  'nofollow',
+  'noimageindex',
+  'none',
+  'noarchive',
+  'nocache',
+  'nosnippet',
+];

package/src/constants/roles.test.ts

@@ -0,0 +1,5 @@
+import { Role } from './roles';
+
+test('admin role exists', () => {
+  expect(Role.ADMIN).toBe(1);
+});

package/src/constants/roles.ts

@@ -0,0 +1,38 @@
+export enum Role {
+  PUBLIC = 0,
+  ADMIN = 1,
+  SALES = 2,
+  DESIGNER = 3,
+  SUPPLIER = 4,
+  CLIENT = 5,
+  MANAGER = 6,
+  ACCOUNTANT = 7,
+  THEME_EDITOR = 8,
+}
+
+export const DOMAIN_MANAGERS = [Role.ADMIN, Role.MANAGER];
+
+export const MANAGEMENT_TEAM = [
+  ...DOMAIN_MANAGERS,
+  Role.SALES,
+  Role.DESIGNER,
+  Role.ACCOUNTANT,
+];
+
+export const BUSINESS_ACCOUNTS = [...MANAGEMENT_TEAM, Role.SUPPLIER];
+
+export const MANAGEMENT_ROLES = [Role.ADMIN, Role.MANAGER];
+
+export const THEME_ROLES = [...MANAGEMENT_ROLES, Role.THEME_EDITOR];
+export const ROLES_RANK = [
+  Role.PUBLIC,
+  Role.CLIENT,
+  Role.ACCOUNTANT,
+  Role.SALES,
+  Role.DESIGNER,
+  Role.SUPPLIER,
+  Role.MANAGER,
+  Role.ADMIN,
+];
+
+export const ALL_ROLES = ROLES_RANK;

package/src/constants/shipment_companies.test.ts

@@ -0,0 +1,5 @@
+import { ShipmentCompany } from './shipment_companies';
+
+test('dhl exists', () => {
+  expect(ShipmentCompany.DHL).toBe(0);
+});

package/src/constants/shipment_companies.ts

@@ -0,0 +1,18 @@
+export enum ShipmentCompany {
+  DHL = 0,
+  UPS = 1,
+  EMS = 2,
+  FED_EX = 3,
+  AUSTRALIA_POST = 4,
+  STAR_TRACK = 5,
+  TOLL = 6,
+  TNT = 7,
+  CUSTOM_TRACK_LINK = 8,
+  ARAMEX = 9,
+  REALTIME_EXPRESS = 10,
+  UBER = 11,
+  CIVIC_TRANSPORT_COURIERS = 12,
+  NZ_POST = 13,
+  SENDLE = 14,
+  USPS = 15,
+}

package/src/constants/shipment_services.test.ts

@@ -0,0 +1,5 @@
+import { ShipmentService } from './shipment_services';
+
+test('dhl exists', () => {
+  expect(ShipmentService.SENDLE).toBe(1);
+});

package/src/constants/shipment_services.ts

@@ -0,0 +1,3 @@
+export enum ShipmentService {
+  SENDLE = 1
+}

package/src/constants/system_roles.test.ts

@@ -0,0 +1,5 @@
+import { SystemRoles } from './system_roles';
+
+test('system component builder role exists', () => {
+  expect(SystemRoles.SYSTEM_COMPONENT_BUILDER).toBe(1);
+});

package/src/constants/system_roles.ts

@@ -0,0 +1,3 @@
+export enum SystemRoles {
+  SYSTEM_COMPONENT_BUILDER = 1
+}

package/src/constants/theme_foundations.test.ts

@@ -0,0 +1,5 @@
+import { ThemeFoundations } from './theme_foundations';
+
+test('not valid status exists', () => {
+  expect(ThemeFoundations.BOOTSTRAP_3).toBe(1);
+});

package/src/constants/theme_foundations.ts

@@ -0,0 +1,6 @@
+export enum ThemeFoundations {
+  NO_FOUNDATION = 0,
+  BOOTSTRAP_3 = 1,
+  BOOTSTRAP_4 = 2,
+  BOOTSTRAP_5 = 3,
+}

package/src/constants/theme_status.test.ts

@@ -0,0 +1,5 @@
+import { ThemeStatus } from './theme_status';
+
+test('not valid status exists', () => {
+  expect(ThemeStatus.NOT_VALID).toBe(1);
+});

package/src/constants/theme_status.ts

@@ -0,0 +1,5 @@
+export enum ThemeStatus {
+  NOT_VALID = 1,
+  VALID_BUT_NOT_UPDATED = 2,
+  VALID_AND_UPDATED = 3
+}

package/src/constants/user_types.test.ts

@@ -0,0 +1,5 @@
+import { UserType } from './user_types';
+
+test('not valid status exists', () => {
+  expect(UserType.CLIENT_GUEST).toBe(1);
+});

package/src/constants/user_types.ts

@@ -0,0 +1,17 @@
+export enum UserType {
+  PUBLIC = 0,
+  CLIENT_GUEST = 1, // A user who has not oppted in for a user account
+  CLIENT_DOMAIN = 2, // A user who is a client of one domain
+  CLIENT_MULTIPLE_DOMAINS = 3,  // A user who is a client of multiple domains
+  CLIENT_MERCHI = 4, // A user has a client profile with Merchi
+  SELLER_FREE_MERCHI = 5, // A user who has opened a seller store through Merchi
+  SELLER_FREE_DOMAIN = 6, // A user who has opened a seller store through a domain/supplier
+  SELLER_PAID = 7, // A user who is paying for a seller store
+  SELLER_PAID_MULTIPLE_DOMAINS = 8, // A user who is paying for multiple seller stores
+  SUPPLIER_THIRD_PARTY = 9, // A user who has a "domain supplier" domain
+  SUPPLIER_RESTRICTED = 10, // A user who has a restricted supply domain
+  SUPPLIER_MERCHI = 11, // A user who has a supply domain which has been verified by Merchi
+  UNRESTRICTED = 12, // A user who has a domain which is unrestricted
+  SHOPIFY_REFERENCE = 13, // A user who makes order from shopify and linked to our system
+  RESERVED_FROM_SOCIAL = 14, // A user crawled from Social network
+}

package/src/constants/white_label_accessibilities.test.ts

@@ -0,0 +1,5 @@
+import { WhiteLabelAccessibility } from './white_label_accessibilities';
+
+test('not reachable exists', () => {
+  expect(WhiteLabelAccessibility.UNREACHABLE).toBe(0);
+});

package/src/constants/white_label_accessibilities.ts

@@ -0,0 +1,6 @@
+export enum WhiteLabelAccessibility {
+  UNREACHABLE = 0,
+  NO_CERTIFICATE = 1,
+  REACHABLE = 2,
+}
+

package/src/cookie.test.ts

@@ -0,0 +1,11 @@
+import { getCookie } from './cookie';
+
+test('can get cookie', () => {
+  const token = 'IMiF7rpT$5ciUJ38QY';
+  const cookie = `session_token=${token}`;
+  Object.defineProperty(document, 'cookie', {
+    get: jest.fn().mockImplementation(() => { return cookie; }),
+    set: jest.fn().mockImplementation(() => {}),
+  });
+  expect(getCookie('session_token')).toBe('IMiF7rpT$5ciUJ38QY');
+});

package/src/cookie.ts

@@ -0,0 +1,16 @@
+export function getCookie(name: string) {
+  // code might be executed during SSR
+  // istanbul ignore next
+  if (typeof document !== 'undefined') {
+    const searchPrefix = name + '=',
+      cookies = document.cookie.split(';');
+    for (let i = 0; i < cookies.length; ++i) {
+      let cookie = cookies[i];
+      cookie = cookie.replace(/^\s*/, '');
+      if (cookie.indexOf(searchPrefix) === 0) {
+        return cookie.substring(searchPrefix.length, cookie.length);
+      }
+    }
+  }
+  return undefined;
+}

package/src/entities/address.test.ts

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

package/src/entities/address.ts

@@ -0,0 +1,65 @@
+import { Bank } from './bank';
+import { Company } from './company';
+import { Entity } from '../entity';
+import { Inventory } from './inventory';
+import { Invoice } from './invoice';
+import { Job } from './job';
+import { Shipment } from './shipment';
+import { User } from './user';
+
+export class Address extends Entity {
+  protected static resourceName = 'addresses';
+  protected static singularName = 'address';
+  protected static pluralName = 'addresses';
+
+  @Address.property({type: Date})
+  public archived?: Date | null;
+
+  @Address.property()
+  public id?: number;
+
+  @Address.property({type: String})
+  public lineOne?: string | null;
+
+  @Address.property({type: String})
+  public lineTwo?: string | null;
+
+  @Address.property({type: String})
+  public city?: string | null;
+
+  @Address.property({type: String})
+  public state?: string | null;
+
+  @Address.property({type: String})
+  public country?: string | null;
+
+  @Address.property({type: String})
+  public postcode?: string | null;
+
+  @Address.property({arrayType: 'Shipment'})
+  public shipmentAsSenderAddress?: Shipment[];
+
+  @Address.property({arrayType: 'Shipment'})
+  public shipmentsAsReceiverAddress?: Shipment[];
+
+  @Address.property({arrayType: 'Bank'})
+  public banks?: Bank[];
+
+  @Address.property({arrayType: 'User'})
+  public users?: User[];
+
+  @Address.property({arrayType: 'Inventory'})
+  public inventories?: Inventory[];
+
+  @Address.property({arrayType: 'Job'})
+  public jobs?: Job[];
+
+  @Address.property({arrayType: 'Job'})
+  public productedJobs?: Job[];
+
+  @Address.property({arrayType: 'Invoice'})
+  public shippingTo?: Invoice[];
+
+  @Address.property({arrayType: 'Company'})
+  public companies?: Company[];
+}

package/src/entities/assignment.test.ts

@@ -0,0 +1,39 @@
+import { Merchi } from '../merchi';
+import { setup, mockFetch } from '../test_util';
+
+setup();
+
+test('can make Assignment', () => {
+  const merchi = new Merchi();
+  const assignment = new merchi.Assignment();
+  expect(assignment).toBeTruthy();
+});
+
+test('can generate new invoice', () => {
+  mockFetch(true, {'id': 1, 'totalCost': 100}, 200);
+
+  const merchi = new Merchi();
+  const assignment = new merchi.Assignment();
+  assignment.id = 1;
+  assignment.generateInvoice().then(invoice => {
+    expect(invoice.totalCost).toEqual(100);
+    expect(invoice.id).toEqual(1);
+  });
+});
+
+test('can add to invoice', () => {
+  const fetch = mockFetch(true, {'id': 2, 'totalCost': 100}, 200);
+  const merchi = new Merchi();
+  const assignment = new merchi.Assignment();
+  assignment.id = 1;
+  assignment.generateInvoice({addToInvoice: 2}).then(invoice => {
+    expect(invoice.totalCost).toEqual(100);
+    expect(invoice.id).toEqual(2);
+  });
+
+  const correct = [['add_to_invoice', '2']];
+  expect(
+    Array.from(fetch.mock.calls[0][1]['query'])
+  ).toEqual(correct);
+});
+

package/src/entities/assignment.ts

@@ -0,0 +1,92 @@
+import { Entity } from '../entity';
+import { Quote } from './quote';
+import { MerchiFile } from './file';
+import { Job } from './job';
+import { Notification } from './notification';
+import { ProductionComment } from './production_comment';
+import { Shipment } from './shipment';
+import { SupplyDomain } from './supply_domain';
+import { User } from './user';
+import { RequestOptions } from '../request';
+
+interface GenerateInvoiceProps {
+  addToInvoice? : number;
+}
+
+export class Assignment extends Entity {
+  protected static resourceName = 'assignments';
+  protected static singularName = 'assignment';
+  protected static pluralName = 'assignments';
+
+  @Assignment.property({type: Date})
+  public archived?: Date | null;
+
+  @Assignment.property()
+  public id?: number;
+
+  @Assignment.property({type: Date})
+  public managerAccepts?: Date | null;
+
+  @Assignment.property({type: Date})
+  public supplierRefused?: Date | null;
+
+  @Assignment.property()
+  public needsDrafting?: boolean;
+
+  @Assignment.property()
+  public needsShipping?: boolean;
+
+  @Assignment.property()
+  public productionDeadline?: Date;
+
+  @Assignment.property()
+  public assignmentDeadline?: Date;
+
+  @Assignment.property({type: String})
+  public notes?: string | null;
+
+  @Assignment.property({type: 'Job'})
+  public job?: Job | null;
+
+  @Assignment.property({type: 'Job'})
+  public supplyJob?: Job | null;
+
+  @Assignment.property({type: User})
+  public supplier?: User | null;
+
+  @Assignment.property({type: Quote})
+  public quote?: Quote | null;
+
+  @Assignment.property({arrayType: 'ProductionComment'})
+  public comments?: ProductionComment[];
+
+  @Assignment.property({type: Shipment})
+  public shipment?: Shipment | null;
+
+  @Assignment.property({type: SupplyDomain})
+  public supplyDomain?: SupplyDomain | null;
+
+  @Assignment.property({arrayType: 'Notification'})
+  public notifications?: Notification[];
+
+  @Assignment.property({arrayType: 'MerchiFile'})
+  public productionFiles?: MerchiFile[];
+
+  public generateInvoice = (props?: GenerateInvoiceProps) => {
+    const resource = `/generate-invoice-for-assignment/${this.id}/`;
+    const fetchOptions: RequestOptions = {method: 'POST'};
+    fetchOptions.query = [];
+
+    if (props && props.addToInvoice) {
+      fetchOptions.query.push(['add_to_invoice', String(props.addToInvoice!)]);
+    }
+
+    return this.merchi.authenticatedFetch(resource, fetchOptions).
+      then((data: any) => {
+        const invoice = new this.merchi.Invoice();
+        invoice.fromJson(data);
+        return invoice;
+      });
+  };
+
+}

package/src/entities/automatic_payment_relationship.test.ts

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

package/src/entities/automatic_payment_relationship.ts

@@ -0,0 +1,26 @@
+import { Company } from './company';
+import { Entity } from '../entity';
+
+export class AutomaticPaymentRelationship extends Entity {
+  protected static resourceName = 'automatic_payment_relationships';
+  protected static singularName = 'automaticPaymentRelationship';
+  protected static pluralName = 'automaticPaymentRelationships';
+
+  @AutomaticPaymentRelationship.property({type: Date})
+  public archived?: Date | null;
+
+  @AutomaticPaymentRelationship.property()
+  public id?: number;
+
+  @AutomaticPaymentRelationship.property()
+  public creationDate?: Date;
+
+  @AutomaticPaymentRelationship.property({type: Company})
+  public companyCustomer?: Company;
+
+  @AutomaticPaymentRelationship.property({type: Company})
+  public companySupplier?: Company;
+
+  @AutomaticPaymentRelationship.property({type: String})
+  public stripeCustomerId?: string;
+}

package/src/entities/backup.test.ts

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

package/src/entities/backup.ts

@@ -0,0 +1,14 @@
+import { Entity } from '../entity';
+import { MerchiFile } from './file';
+
+export class Backup extends Entity {
+  protected static resourceName = 'backups';
+  protected static singularName = 'backup';
+  protected static pluralName = 'backups';
+
+  @Backup.property()
+  public id?: number;
+
+  @Backup.property()
+  public file?: MerchiFile;
+}

package/src/entities/bank.test.ts

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

package/src/entities/bank.ts

@@ -0,0 +1,45 @@
+import { Address } from './address';
+import { Company } from './company';
+import { Entity } from '../entity';
+
+export class Bank extends Entity {
+  protected static resourceName = 'banks';
+  protected static singularName = 'bank';
+  protected static pluralName = 'banks';
+
+  @Bank.property({type: Date})
+  public archived?: Date | null;
+
+  @Bank.property()
+  public id?: number;
+
+  @Bank.property()
+  public default?: boolean;
+
+  @Bank.property()
+  public bankName?: string;
+
+  @Bank.property()
+  public accountNumber?: string;
+
+  @Bank.property()
+  public accountName?: string;
+
+  @Bank.property({type: String})
+  public bsb?: string | null;
+
+  @Bank.property({type: String})
+  public swiftCode?: string | null;
+
+  @Bank.property({type: String})
+  public iban?: string | null;
+
+  @Bank.property({type: String})
+  public bankCode?: string | null;
+
+  @Bank.property({type: 'Address'})
+  public bankAddress?: Address | null;
+
+  @Bank.property()
+  public company?: Company;
+}

package/src/entities/cart.test.ts

@@ -0,0 +1,50 @@
+import { Merchi } from '../merchi';
+import { setup, mockFetch } from '../test_util';
+
+setup();
+
+test('can make Cart', () => {
+  const merchi = new Merchi();
+  const cart = new merchi.Cart();
+  expect(cart).toBeTruthy();
+});
+
+test('cart token supported by merchi', () => {
+  const merchi = new Merchi(undefined, undefined, undefined, 'c');
+  const correct = [['skip_rights', 'y'], ['cart_token', 'c']];
+  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('requiresShipment', () => {
+  const merchi = new Merchi();
+  const cart = new merchi.Cart();
+  expect(cart.requiresShipment).toThrow();
+  cart.cartItems = [];
+  expect(cart.requiresShipment()).toBe(false);
+  cart.cartItems = [new merchi.CartItem()];
+  cart.cartItems[0].product = new merchi.Product();
+  cart.cartItems[0].product.needsShipping = true;
+  expect(cart.requiresShipment()).toBe(true);
+  cart.cartItems[0].product.needsShipping = false;
+  expect(cart.requiresShipment()).toBe(false);
+});
+
+test('pass cookie tokens to query string', () => {
+  const cookie = 'cart_token=c;';
+  Object.defineProperty(document, 'cookie', {
+    get: jest.fn().mockImplementation(() => { return cookie; }),
+    set: jest.fn().mockImplementation(() => {}),
+  });
+  const correct = [
+    ['skip_rights', 'y'],
+    ['cart_token', 'c'],
+  ];
+  const fetch = mockFetch(true, {'cart': {'id': 1}}, 200);
+  const merchi = new Merchi();
+  const invocation = merchi.Cart.get(1);
+  expect(fetch.mock.calls[0][1]['query']).toEqual(correct);
+  return invocation;
+});