@merchi/sdk 1.40.2 → 1.42.1

package/dist/entities/cart.js

@@ -136,6 +136,46 @@ var Cart = /** @class */ (function (_super) {
         Cart.property(),
         __metadata("design:type", Boolean)
     ], Cart.prototype, "sendWhatsapp", void 0);
+    __decorate([
+        Cart.property(),
+        __metadata("design:type", Boolean)
+    ], Cart.prototype, "isTest", void 0);
+    __decorate([
+        Cart.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Cart.prototype, "sourceChannel", void 0);
+    __decorate([
+        Cart.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Cart.prototype, "utmSource", void 0);
+    __decorate([
+        Cart.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Cart.prototype, "utmMedium", void 0);
+    __decorate([
+        Cart.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Cart.prototype, "utmCampaign", void 0);
+    __decorate([
+        Cart.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Cart.prototype, "utmContent", void 0);
+    __decorate([
+        Cart.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Cart.prototype, "utmTerm", void 0);
+    __decorate([
+        Cart.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Cart.prototype, "sourceClickId", void 0);
+    __decorate([
+        Cart.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Cart.prototype, "sourceLanding", void 0);
+    __decorate([
+        Cart.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Cart.prototype, "sourceReferrer", void 0);
     __decorate([
         Cart.property({ type: 'User' }),
         __metadata("design:type", Object)

package/dist/entities/cart.test.js

@@ -49,3 +49,24 @@ test('preserves server payment engine hint', function () {
     entity.fromJson({ id: 1, stripePaymentEngine: 'wallet' });
     expect(entity.toJson()).toMatchObject({ stripePaymentEngine: 'wallet' });
 });
+test('preserves isTest', function () {
+    var merchi = new Merchi();
+    var entity = new merchi.Cart();
+    entity.fromJson({ id: 1, isTest: true });
+    expect(entity.toJson()).toMatchObject({ isTest: true });
+});
+test('preserves source attribution', function () {
+    var merchi = new Merchi();
+    var entity = new merchi.Cart();
+    entity.fromJson({
+        id: 1,
+        sourceChannel: 'meta',
+        utmSource: 'facebook',
+        sourceClickId: 'IwAR',
+    });
+    expect(entity.toJson()).toMatchObject({
+        sourceChannel: 'meta',
+        utmSource: 'facebook',
+        sourceClickId: 'IwAR',
+    });
+});

package/dist/entities/domain.js

@@ -362,6 +362,10 @@ var Domain = /** @class */ (function (_super) {
         Domain.property({ type: String }),
         __metadata("design:type", Object)
     ], Domain.prototype, "apiSecret", void 0);
+    __decorate([
+        Domain.property({ type: jsonPropertyType }),
+        __metadata("design:type", Object)
+    ], Domain.prototype, "apiAllowedOrigins", void 0);
     __decorate([
         Domain.property({ type: String }),
         __metadata("design:type", Object)

package/dist/entities/domain.test.js

@@ -28,6 +28,16 @@ test('can create domain on server', function () {
     var sentToServer = Array.from(fetch.mock.calls[0][1]['body'].entries());
     expect(sentToServer).toEqual(data);
 });
+test('serialises apiAllowedOrigins JSON for form data', function () {
+    var merchi = new Merchi();
+    var domain = new merchi.Domain();
+    domain.id = 7;
+    domain.apiAllowedOrigins = ['https://shop.example.com', 'https://preview.example.com'];
+    var entries = Array.from(domain.toFormData().entries());
+    var data = Object.fromEntries(entries);
+    expect(data.apiAllowedOrigins).toBe(JSON.stringify(['https://shop.example.com', 'https://preview.example.com']));
+    expect(data.apiAllowedOrigins).not.toBe('[object Object]');
+});
 test('serialises jobAgentPolicy JSON for form data', function () {
     var merchi = new Merchi();
     var domain = new merchi.Domain();

package/dist/entities/invoice.js

@@ -119,6 +119,10 @@ var Invoice = /** @class */ (function (_super) {
         Invoice.property({ type: Boolean }),
         __metadata("design:type", Object)
     ], Invoice.prototype, "unpaid", void 0);
+    __decorate([
+        Invoice.property({ type: Boolean }),
+        __metadata("design:type", Object)
+    ], Invoice.prototype, "isTest", void 0);
     __decorate([
         Invoice.property(),
         __metadata("design:type", String)

package/dist/entities/job.js

@@ -374,6 +374,42 @@ var Job = /** @class */ (function (_super) {
         Job.property(),
         __metadata("design:type", String)
     ], Job.prototype, "clientOrigin", void 0);
+    __decorate([
+        Job.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Job.prototype, "sourceChannel", void 0);
+    __decorate([
+        Job.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Job.prototype, "utmSource", void 0);
+    __decorate([
+        Job.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Job.prototype, "utmMedium", void 0);
+    __decorate([
+        Job.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Job.prototype, "utmCampaign", void 0);
+    __decorate([
+        Job.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Job.prototype, "utmContent", void 0);
+    __decorate([
+        Job.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Job.prototype, "utmTerm", void 0);
+    __decorate([
+        Job.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Job.prototype, "sourceClickId", void 0);
+    __decorate([
+        Job.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Job.prototype, "sourceLanding", void 0);
+    __decorate([
+        Job.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Job.prototype, "sourceReferrer", void 0);
     __decorate([
         Job.property({ type: User }),
         __metadata("design:type", Object)
@@ -514,6 +550,10 @@ var Job = /** @class */ (function (_super) {
         Job.property(),
         __metadata("design:type", Boolean)
     ], Job.prototype, "isNewClient", void 0);
+    __decorate([
+        Job.property(),
+        __metadata("design:type", Boolean)
+    ], Job.prototype, "isTest", void 0);
     return Job;
 }(Entity));
 export { Job };

package/dist/entities/job.test.js

@@ -7,6 +7,31 @@ test('can make Job', function () {
     var job = new merchi.Job();
     expect(job).toBeTruthy();
 });
+test('preserves isTest', function () {
+    var merchi = new Merchi();
+    var job = new merchi.Job();
+    job.fromJson({ id: 1, isTest: true });
+    expect(job.toJson()).toMatchObject({ isTest: true });
+});
+test('preserves source attribution', function () {
+    var merchi = new Merchi();
+    var job = new merchi.Job();
+    job.fromJson({
+        id: 1,
+        sourceChannel: 'google_ads',
+        utmSource: 'google',
+        utmMedium: 'cpc',
+        utmCampaign: 'wristbands',
+        sourceClickId: 'EAIa',
+    });
+    expect(job.toJson()).toMatchObject({
+        sourceChannel: 'google_ads',
+        utmSource: 'google',
+        utmMedium: 'cpc',
+        utmCampaign: 'wristbands',
+        sourceClickId: 'EAIa',
+    });
+});
 test('Job deadline serialised to milliseconds in form data', function () {
     var merchi = new Merchi();
     var job = new merchi.Job();

package/dist/entity.js

@@ -688,6 +688,12 @@ var Entity = /** @class */ (function () {
             if (options.isDraft !== undefined) {
                 fetchOptions.query.push(['is_draft', options.isDraft.toString()]);
             }
+            if (options.isTest !== undefined) {
+                fetchOptions.query.push(['is_test', options.isTest.toString()]);
+            }
+            if (options.sourceChannel !== undefined) {
+                fetchOptions.query.push(['source_channel', options.sourceChannel.toString()]);
+            }
             if (options.managedOnly !== undefined) {
                 fetchOptions.query.push(['managed_only',
                     options.managedOnly.toString()]);

package/dist/request.js

@@ -26,17 +26,25 @@ var __values = (this && this.__values) || function(o) {
 };
 // eslint-disable-next-line no-unused-vars
 import { getErrorFromCode } from './constants/errors.js';
+function resolveApiErrorMessage(err) {
+    if (err && typeof err === 'object' && typeof err.message === 'string' && err.message) {
+        return err.message;
+    }
+    if (typeof err === 'string' && err) {
+        return err;
+    }
+    return 'No error message';
+}
 var ApiError = /** @class */ (function (_super) {
     __extends(ApiError, _super);
     function ApiError(err) {
         var _this = this;
-        var message = JSON.stringify(err);
+        var message = resolveApiErrorMessage(err);
         /* istanbul ignore next */
         _this = _super.call(this, message) || this;
         _this.statusCode = err.statusCode;
         _this.errorCode = getErrorFromCode(err.errorCode);
-        _this.errorMessage = err.message ?
-            err.message : 'No error message';
+        _this.errorMessage = message;
         _this.details = err.details;
         _this.name = 'ApiError';
         _this.original = err;

package/dist/request.test.js

@@ -1,4 +1,4 @@
-import { apiFetch } from './request.js';
+import { apiFetch, ApiError } from './request.js';
 import { ErrorType } from './constants/errors.js';
 import { setup, mockFetch } from './test_util.js';
 setup();
@@ -28,11 +28,30 @@ test('will get default errorCode', function () {
     mockFetch(false, { 'statusCode': 404,
         'errorCode': -1,
         'message': 'just a test' }, 404);
-    apiFetch('https://api.merchi.co/', '/test').catch(function (e) {
+    return apiFetch('https://api.merchi.co/', '/test').catch(function (e) {
         expect(e.statusCode).toBe(404);
         expect(e.name).toBe('ApiError');
         expect(e.errorCode).toBe(ErrorType.UNKNOWN_ERROR);
         expect(e.errorMessage).toBe('just a test');
+        expect(e.message).toBe('just a test');
+    });
+});
+test('ApiError keeps plain string messages', function () {
+    var e = new ApiError('empty response');
+    expect(e.message).toBe('empty response');
+    expect(e.errorMessage).toBe('empty response');
+});
+test('ApiError.message is the human-readable text, not serialized JSON', function () {
+    mockFetch(false, {
+        'statusCode': 403,
+        'errorCode': ErrorType.UNKNOWN_ERROR,
+        'message': 'cannot set referrer',
+    }, 403);
+    return apiFetch('https://api.merchi.co/', '/test').catch(function (e) {
+        expect(e.message).toBe('cannot set referrer');
+        expect(e.errorMessage).toBe('cannot set referrer');
+        expect(e.message).not.toContain('errorCode');
+        expect(e.message).not.toContain('statusCode');
     });
 });
 test('ApiError exposes details when the server supplies them', function () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@merchi/sdk",
-  "version": "1.40.2",
+  "version": "1.42.1",
   "main": "dist/index.js",
   "type": "module",
   "repository": {

package/src/entities/cart.test.ts

@@ -55,3 +55,26 @@ test('preserves server payment engine hint', () => {
   entity.fromJson({ id: 1, stripePaymentEngine: 'wallet' });
   expect(entity.toJson()).toMatchObject({ stripePaymentEngine: 'wallet' });
 });
+
+test('preserves isTest', () => {
+  const merchi = new Merchi();
+  const entity = new merchi.Cart();
+  entity.fromJson({ id: 1, isTest: true });
+  expect(entity.toJson()).toMatchObject({ isTest: true });
+});
+
+test('preserves source attribution', () => {
+  const merchi = new Merchi();
+  const entity = new merchi.Cart();
+  entity.fromJson({
+    id: 1,
+    sourceChannel: 'meta',
+    utmSource: 'facebook',
+    sourceClickId: 'IwAR',
+  });
+  expect(entity.toJson()).toMatchObject({
+    sourceChannel: 'meta',
+    utmSource: 'facebook',
+    sourceClickId: 'IwAR',
+  });
+});

package/src/entities/cart.ts

@@ -64,6 +64,36 @@ export class Cart extends Entity {
   @Cart.property()
   public sendWhatsapp?: boolean;
 
+  @Cart.property()
+  public isTest?: boolean;
+
+  @Cart.property({type: String})
+  public sourceChannel?: string | null;
+
+  @Cart.property({type: String})
+  public utmSource?: string | null;
+
+  @Cart.property({type: String})
+  public utmMedium?: string | null;
+
+  @Cart.property({type: String})
+  public utmCampaign?: string | null;
+
+  @Cart.property({type: String})
+  public utmContent?: string | null;
+
+  @Cart.property({type: String})
+  public utmTerm?: string | null;
+
+  @Cart.property({type: String})
+  public sourceClickId?: string | null;
+
+  @Cart.property({type: String})
+  public sourceLanding?: string | null;
+
+  @Cart.property({type: String})
+  public sourceReferrer?: string | null;
+
   @Cart.property({type: 'User'})
   public client?: User | null;
 

package/src/entities/domain.test.ts

@@ -34,6 +34,20 @@ test('can create domain on server', () => {
   expect(sentToServer).toEqual(data);
 });
 
+test('serialises apiAllowedOrigins JSON for form data', () => {
+  const merchi = new Merchi();
+  const domain = new merchi.Domain();
+  domain.id = 7;
+  domain.apiAllowedOrigins = ['https://shop.example.com', 'https://preview.example.com'];
+  const entries = Array.from((domain.toFormData() as any).entries()) as
+    Array<[string, string]>;
+  const data = Object.fromEntries(entries);
+  expect(data.apiAllowedOrigins).toBe(
+    JSON.stringify(['https://shop.example.com', 'https://preview.example.com'])
+  );
+  expect(data.apiAllowedOrigins).not.toBe('[object Object]');
+});
+
 test('serialises jobAgentPolicy JSON for form data', () => {
   const merchi = new Merchi();
   const domain = new merchi.Domain();

package/src/entities/domain.ts

@@ -558,6 +558,9 @@ export class Domain extends Entity {
   @Domain.property({type: String})
   public apiSecret?: string | null;
 
+  @Domain.property({type: jsonPropertyType})
+  public apiAllowedOrigins?: string[] | null;
+
   @Domain.property({type: String})
   public webflowApiKey?: string | null;
 

package/src/entities/invoice.ts

@@ -82,6 +82,9 @@ export class Invoice extends Entity {
   @Invoice.property({type: Boolean})
   public unpaid?: boolean | null;
 
+  @Invoice.property({type: Boolean})
+  public isTest?: boolean | null;
+
   @Invoice.property()
   public currency?: string;
 

package/src/entities/job.test.ts

@@ -10,6 +10,33 @@ test('can make Job', () => {
   expect(job).toBeTruthy();
 });
 
+test('preserves isTest', () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job();
+  job.fromJson({ id: 1, isTest: true });
+  expect(job.toJson()).toMatchObject({ isTest: true });
+});
+
+test('preserves source attribution', () => {
+  const merchi = new Merchi();
+  const job = new merchi.Job();
+  job.fromJson({
+    id: 1,
+    sourceChannel: 'google_ads',
+    utmSource: 'google',
+    utmMedium: 'cpc',
+    utmCampaign: 'wristbands',
+    sourceClickId: 'EAIa',
+  });
+  expect(job.toJson()).toMatchObject({
+    sourceChannel: 'google_ads',
+    utmSource: 'google',
+    utmMedium: 'cpc',
+    utmCampaign: 'wristbands',
+    sourceClickId: 'EAIa',
+  });
+});
+
 test('Job deadline serialised to milliseconds in form data', () => {
   const merchi = new Merchi();
   const job = new merchi.Job();

package/src/entities/job.ts

@@ -249,6 +249,33 @@ export class Job extends Entity {
   @Job.property()
   public clientOrigin?: string;
 
+  @Job.property({type: String})
+  public sourceChannel?: string | null;
+
+  @Job.property({type: String})
+  public utmSource?: string | null;
+
+  @Job.property({type: String})
+  public utmMedium?: string | null;
+
+  @Job.property({type: String})
+  public utmCampaign?: string | null;
+
+  @Job.property({type: String})
+  public utmContent?: string | null;
+
+  @Job.property({type: String})
+  public utmTerm?: string | null;
+
+  @Job.property({type: String})
+  public sourceClickId?: string | null;
+
+  @Job.property({type: String})
+  public sourceLanding?: string | null;
+
+  @Job.property({type: String})
+  public sourceReferrer?: string | null;
+
   @Job.property({type: User})
   public manager?: User | null;
 
@@ -354,6 +381,9 @@ export class Job extends Entity {
   @Job.property()
   public isNewClient?: boolean;
 
+  @Job.property()
+  public isTest?: boolean;
+
   public getQuote = () => {
     const resource = '/specialised-order-estimate/';
     const data = this.toFormData({excludeOld: false});

package/src/entity.ts

@@ -130,6 +130,8 @@ interface ListOptions {
   productTypes?: ProductType[];
   publicOnly?: boolean;
   isDraft?: boolean;
+  isTest?: boolean;
+  sourceChannel?: string;
   q?: string;
   receiverId?: number;
   userAsReceiver?: number;
@@ -498,6 +500,12 @@ export class Entity {
       if (options.isDraft !== undefined) {
         fetchOptions.query.push(['is_draft', options.isDraft.toString()]);
       }
+      if (options.isTest !== undefined) {
+        fetchOptions.query.push(['is_test', options.isTest.toString()]);
+      }
+      if (options.sourceChannel !== undefined) {
+        fetchOptions.query.push(['source_channel', options.sourceChannel.toString()]);
+      }
       if (options.managedOnly !== undefined) {
         fetchOptions.query.push(['managed_only',
           options.managedOnly.toString()]);

package/src/request.test.ts

@@ -1,4 +1,4 @@
-import { apiFetch } from './request.js';
+import { apiFetch, ApiError } from './request.js';
 import { ErrorType } from './constants/errors.js';
 import { setup, mockFetch } from './test_util.js';
 
@@ -34,11 +34,32 @@ test('will get default errorCode', () => {
     {'statusCode': 404,
       'errorCode': -1,
       'message': 'just a test'}, 404);
-  apiFetch('https://api.merchi.co/', '/test').catch(e => {
+  return apiFetch('https://api.merchi.co/', '/test').catch(e => {
     expect(e.statusCode).toBe(404);
     expect(e.name).toBe('ApiError');
     expect(e.errorCode).toBe(ErrorType.UNKNOWN_ERROR);
     expect(e.errorMessage).toBe('just a test');
+    expect(e.message).toBe('just a test');
+  });
+});
+
+test('ApiError keeps plain string messages', () => {
+  const e = new ApiError('empty response');
+  expect(e.message).toBe('empty response');
+  expect(e.errorMessage).toBe('empty response');
+});
+
+test('ApiError.message is the human-readable text, not serialized JSON', () => {
+  mockFetch(false, {
+    'statusCode': 403,
+    'errorCode': ErrorType.UNKNOWN_ERROR,
+    'message': 'cannot set referrer',
+  }, 403);
+  return apiFetch('https://api.merchi.co/', '/test').catch(e => {
+    expect(e.message).toBe('cannot set referrer');
+    expect(e.errorMessage).toBe('cannot set referrer');
+    expect(e.message).not.toContain('errorCode');
+    expect(e.message).not.toContain('statusCode');
   });
 });
 

package/src/request.ts

@@ -38,6 +38,16 @@ export interface ApiErrorDetails {
   [key: string]: any;
 }
 
+function resolveApiErrorMessage(err: any): string {
+  if (err && typeof err === 'object' && typeof err.message === 'string' && err.message) {
+    return err.message;
+  }
+  if (typeof err === 'string' && err) {
+    return err;
+  }
+  return 'No error message';
+}
+
 export class ApiError extends Error {
   public statusCode?: number;
   public errorCode?: ErrorType;
@@ -52,13 +62,12 @@ export class ApiError extends Error {
   public details?: ApiErrorDetails;
   public original: any;
   public constructor(err: any) {
-    const message = JSON.stringify(err);
+    const message = resolveApiErrorMessage(err);
     /* istanbul ignore next */
     super(message);
     this.statusCode = err.statusCode;
     this.errorCode = getErrorFromCode(err.errorCode);
-    this.errorMessage = err.message ?
-      err.message : 'No error message';
+    this.errorMessage = message;
     this.details = err.details;
     this.name = 'ApiError';
     this.original = err;