merchi_sdk_ts 0.0.1

package/src/entities/domain_invitation.ts

@@ -0,0 +1,36 @@
+import { Domain } from './domain';
+import { Entity } from '../entity';
+import { User } from './user';
+
+export class DomainInvitation extends Entity {
+  protected static resourceName = 'domain_invitations';
+  protected static singularName = 'domainInvitation';
+  protected static pluralName = 'domainInvitations';
+
+  @DomainInvitation.property({type: Date})
+  public archived?: Date | null;
+
+  @DomainInvitation.property()
+  public id?: number;
+
+  @DomainInvitation.property()
+  public userName?: string;
+
+  @DomainInvitation.property()
+  public userEmail?: string;
+
+  @DomainInvitation.property()
+  public role?: number;
+
+  @DomainInvitation.property()
+  public token?: string;
+
+  @DomainInvitation.property()
+  public domain?: Domain;
+
+  @DomainInvitation.property()
+  public sender?: User;
+
+  @DomainInvitation.property({type: Date})
+  public user?: User | null;
+}

package/src/entities/domain_tag.test.ts

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

package/src/entities/domain_tag.ts

@@ -0,0 +1,42 @@
+import { Domain } from './domain';
+import { Entity } from '../entity';
+import { Invoice } from './invoice';
+import { Job } from './job';
+import { Product } from './product';
+import { Shipment } from './shipment';
+
+export class DomainTag extends Entity {
+  protected static resourceName = 'domain_tags';
+  protected static singularName = 'domainTag';
+  protected static pluralName = 'domainTags';
+
+  @DomainTag.property()
+  public id?: number;
+
+  @DomainTag.property()
+  public colour?: number;
+
+  @DomainTag.property()
+  public name?: string;
+
+  @DomainTag.property()
+  public description?: string;
+
+  @DomainTag.property()
+  public showPublic?: boolean;
+
+  @DomainTag.property()
+  public domain?: Domain;
+
+  @DomainTag.property({arrayType: 'Job'})
+  public jobs?: Job[];
+
+  @DomainTag.property({arrayType: 'Product'})
+  public products?: Product[];
+
+  @DomainTag.property({arrayType: 'Invoice'})
+  public invoices?: Invoice[];
+
+  @DomainTag.property({arrayType: 'Shipment'})
+  public shipments?: Shipment[];
+}

package/src/entities/draft.test.ts

@@ -0,0 +1,43 @@
+import { Merchi } from '../merchi';
+
+test('can make Draft', () => {
+  const merchi = new Merchi();
+  const draft = new merchi.Draft();
+  expect(draft).toBeTruthy();
+});
+
+test('wereChangesRequested', () => {
+  const merchi = new Merchi();
+  const draft = new merchi.Draft();
+  expect(draft.wereChangesRequested).toThrow();
+  draft.comments = [];
+  expect(draft.wereChangesRequested()).toBe(false);
+  draft.comments = [new merchi.DraftComment()]; 
+  expect(draft.wereChangesRequested).toThrow();
+  draft.comments[0].changeRequest = false;
+  expect(draft.wereChangesRequested()).toBe(false);
+  draft.comments[0].changeRequest = true;
+  expect(draft.wereChangesRequested()).toBe(true);
+});
+
+test('commentsYoungestToEldest', () => {
+  const merchi = new Merchi();
+  const draft = new merchi.Draft();
+  expect(draft.commentsYoungestToEldest).toThrow();
+  draft.comments = [];
+  expect(draft.commentsYoungestToEldest()).toEqual([]);
+  draft.comments = [new merchi.DraftComment(), new merchi.DraftComment()];
+  expect(draft.commentsYoungestToEldest).toThrow();
+  draft.comments[0].id = 2;
+  draft.comments[1].id = 1;
+  expect(draft.commentsYoungestToEldest()[0].id).toEqual(1);
+});
+
+test('draft accepted serialised to milliseconds', () => {
+  const merchi = new Merchi();
+  const draft = new merchi.Draft();
+  draft.accepted = new Date('Feb 28 2013 19:00:00 GMT-0500');
+  const correct = [['accepted', '1362096000']];
+  const backData = Array.from((draft.toFormData() as any).entries());
+  expect(backData).toEqual(correct);
+});

package/src/entities/draft.ts

@@ -0,0 +1,88 @@
+import { DraftComment } from './draft_comment';
+import { Entity } from '../entity';
+import { MerchiFile } from './file';
+import { Job } from './job';
+import { Notification } from './notification';
+import { User } from './user';
+
+export class Draft extends Entity {
+  protected static resourceName = 'drafts';
+  protected static singularName = 'draft';
+  protected static pluralName = 'drafts';
+
+  @Draft.property({type: Date})
+  public archived?: Date | null;
+
+  @Draft.property()
+  public id?: number;
+
+  @Draft.property({type: Date})
+  public date?: Date | null;
+
+  @Draft.property({type: Date})
+  public accepted?: Date | null;
+
+  @Draft.property({type: Date})
+  public resendDate?: Date | null;
+
+  @Draft.property()
+  public viewed?: boolean;
+
+  @Draft.property()
+  public sendSms?: boolean;
+
+  @Draft.property()
+  public sendEmail?: boolean;
+
+  @Draft.property({arrayType: 'DraftComment'})
+  public comments?: DraftComment[];
+
+  @Draft.property()
+  public commentsCount?: number;
+
+  @Draft.property()
+  public changesRequested?: boolean;
+
+  @Draft.property()
+  public designer?: User;
+
+  @Draft.property({arrayType: 'MerchiFile'})
+  public images?: MerchiFile[];
+
+  @Draft.property({arrayType: 'Notification'})
+  public notification?: Notification[];
+
+  @Draft.property()
+  public job?: Job;
+
+  @Draft.property()
+  public sharedWithJob?: Job;
+
+  public wereChangesRequested = () => {
+    /* true if any comment is/was a change request comment. */
+    if (this.comments === undefined) {
+      throw 'comments is undefined. did you forget to embed it?';
+    }
+    for (const comment of this.comments) {
+      if (comment.changeRequest === undefined) {
+        throw 'changeRequest is undefined.';
+      }
+      if (comment.changeRequest) {
+        return true;
+      }
+    }
+    return false;
+  };
+
+  public commentsYoungestToEldest = () => {
+    if (this.comments === undefined) {
+      throw 'comments is undefined. did you forget to embed it?';
+    }
+    return this.comments.sort((a, b) => {
+      if (a.id === undefined || b.id === undefined) {
+        throw 'comment id is undefined. did you forget to embed it?';
+      }
+      return a.id - b.id;
+    });
+  };
+}

package/src/entities/draft_comment.test.ts

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

package/src/entities/draft_comment.ts

@@ -0,0 +1,54 @@
+import { Draft } from './draft';
+import { Entity } from '../entity';
+import { MerchiFile } from './file';
+import { Job } from './job';
+import { Notification } from './notification';
+import { User } from './user';
+
+export class DraftComment extends Entity {
+  protected static resourceName = 'draft_comments';
+  protected static singularName = 'draftComment';
+  protected static pluralName = 'draftComments';
+
+  @DraftComment.property({type: Date})
+  public archived?: Date | null;
+
+  @DraftComment.property()
+  public id?: number;
+
+  @DraftComment.property({type: Date})
+  public date?: Date | null;
+
+  @DraftComment.property()
+  public urgency?: number;
+
+  @DraftComment.property()
+  public text?: string;
+
+  @DraftComment.property()
+  public changeRequest?: boolean;
+
+  @DraftComment.property()
+  public sendSms?: boolean;
+
+  @DraftComment.property()
+  public sendEmail?: boolean;
+
+  @DraftComment.property()
+  public user?: User;
+
+  @DraftComment.property({arrayType: "MerchiFile"})
+  public files?: MerchiFile[];
+
+  @DraftComment.property({arrayType: 'User'})
+  public forwards?: User[];
+
+  @DraftComment.property({arrayType: 'Notification'})
+  public notifications?: Notification[];
+
+  @DraftComment.property({type: Draft})
+  public draft?: Draft | null;
+
+  @DraftComment.property({type: Job})
+  public job?: Job | null;
+}

package/src/entities/draft_template.test.ts

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

package/src/entities/draft_template.ts

@@ -0,0 +1,40 @@
+import { Entity } from '../entity';
+import { MerchiFile } from './file';
+import { Job } from './job';
+import { Product } from './product';
+
+export class DraftTemplate extends Entity {
+  protected static resourceName = 'draft_templates';
+  protected static singularName = 'draftTemplate';
+  protected static pluralName = 'draftTemplates';
+
+  @DraftTemplate.property({type: Date})
+  public archived?: Date | null;
+
+  @DraftTemplate.property()
+  public id?: number;
+
+  @DraftTemplate.property({type: Date})
+  public date?: Date | null;
+
+  @DraftTemplate.property()
+  public description?: string;
+
+  @DraftTemplate.property()
+  public name?: string;
+
+  @DraftTemplate.property()
+  public height?: number;
+
+  @DraftTemplate.property()
+  public width?: number;
+
+  @DraftTemplate.property({type: MerchiFile})
+  public file?: MerchiFile;
+
+  @DraftTemplate.property({type: Product})
+  public product?: Product | null;
+
+  @DraftTemplate.property({type: Job})
+  public job?: Job | null;
+}

package/src/entities/email_address.test.ts

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

package/src/entities/email_address.ts

@@ -0,0 +1,24 @@
+import { Company } from './company';
+import { Entity } from '../entity';
+import { User } from './user';
+
+export class EmailAddress extends Entity {
+  protected static resourceName = 'email_addresses';
+  protected static singularName = 'emailAddress';
+  protected static pluralName = 'emailAddresses';
+
+  @EmailAddress.property({type: Date})
+  public archived?: Date | null;
+
+  @EmailAddress.property()
+  public id?: number;
+
+  @EmailAddress.property()
+  public emailAddress?: string;
+
+  @EmailAddress.property({arrayType: 'User'})
+  public users?: User[];
+
+  @EmailAddress.property({arrayType: 'Company'})
+  public companies?: Company[];
+}

package/src/entities/email_counter.test.ts

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

package/src/entities/email_counter.ts

@@ -0,0 +1,20 @@
+import { Entity } from '../entity';
+
+export class EmailCounter extends Entity {
+  protected static resourceName = 'email_counters';
+  protected static singularName = 'emailCounter';
+  protected static pluralName = 'emailCounters';
+  protected static primaryKey = 'emailAddress';
+
+  @EmailCounter.property()
+  public emailAddress?: string;
+
+  @EmailCounter.property()
+  public unsubscribed?: boolean;
+
+  @EmailCounter.property()
+  public silenced?: boolean;
+
+  @EmailCounter.property()
+  public tokens?: number;
+}

package/src/entities/enrolled_domain.test.ts

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

package/src/entities/enrolled_domain.ts

@@ -0,0 +1,40 @@
+import { Domain } from './domain';
+import { Entity } from '../entity';
+import { User } from './user';
+import { Role } from '../constants/roles';
+import { DomainType } from '../constants/domain_types';
+
+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';
+
+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';
+
+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';
+import { setup, mockFetch } from '../test_util';
+
+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,172 @@
+import { Backup } from './backup';
+import { Company } from './company';
+import { Component } from './component';
+import { Domain } from './domain';
+import { Draft } from './draft';
+import { DraftComment } from './draft_comment';
+import { Entity } from '../entity';
+import { Invoice } from './invoice';
+import { Job } from './job';
+import { JobComment } from './job_comment';
+import { Notification } from './notification';
+import { Product } from './product';
+import { ProductionComment } from './production_comment';
+import { Theme } from './theme';
+import { User } from './user';
+import { Variation } from './variation';
+import { VariationFieldsOption } from './variation_fields_option';
+
+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: 'Component'})
+  public components?: Component[];
+
+  @MerchiFile.property({arrayType: 'Component'})
+  public componentFeatureImages?: Component[];
+
+  @MerchiFile.property({arrayType: 'DraftComment'})
+  public draftComments?: DraftComment[];
+
+  @MerchiFile.property({arrayType: 'Variation'})
+  public variations?: Variation[];
+
+  @MerchiFile.property({arrayType: 'Backup'})
+  public backups?: Backup[];
+
+  @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: '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';
+  };
+}