merchi_sdk_js 0.6.0 → 0.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "merchi_sdk_js",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "type": "module",
   "main": "src/merchi.js",
   "module": "src/merchi.js",
@@ -8,6 +8,9 @@
   "files": [
     "src/"
   ],
+  "scripts": {
+    "test": "node --test"
+  },
   "dependencies": {
     "axios": "^0.27.2",
     "browser-or-node": "^2.1.1",

package/src/job.js

@@ -30,6 +30,7 @@ import { VariationsGroup } from './variations_group.js';
 import { Item } from './item.js';
 import { JobComment } from './job_comment.js';
 import { JobNote } from './job_note.js';
+import { JobOperationLog } from './job_operation_log.js';
 import { Reminder } from './reminder.js';
 import { InternalTag } from './internal_tag.js';
 
@@ -43,6 +44,7 @@ export function Job() {
     addPropertyTo(this, 'currency');
     addPropertyTo(this, 'quantity');
     addPropertyTo(this, 'jobNotes', JobNote);
+    addPropertyTo(this, 'operationLogs', JobOperationLog);
     addPropertyTo(this, 'jobType');
     addPropertyTo(this, 'product', Product);
     addPropertyTo(this, 'supplyChainRequestProduct', Product);

package/src/job_note.js

@@ -1,5 +1,6 @@
 import { generateUUID } from './uuid.js';
-import { addPropertyTo, enumerateFiles, fromJson, create, serialise } from './model.js';
+import { addPropertyTo, enumerateFiles, fromJson, create, serialise,
+    patchOne, deleteOne } from './model.js';
 import { Job } from './job.js';
 import { User } from './user.js';
 import { MerchiFile } from './merchi_file.js';
@@ -33,4 +34,26 @@ export function JobNote() {
                 error: options.error,
                 embed: options.embed});
     };
+
+    this.save = function (options) {
+        var data = serialise(this),
+            self = this;
+        function handleResponse(result) {
+            options.success(fromJson(self, result[self.json]));
+        }
+        patchOne({resource: this.resource,
+                  id: this.id(),
+                  parameters: data[0],
+                  files: enumerateFiles(data[1]),
+                  success: handleResponse,
+                  error: options.error,
+                  embed: options.embed});
+    };
+
+    this.delete = function (options) {
+        options = options || {};
+        var success = options.success || function () {},
+            error = options.error || function () {};
+        deleteOne(this.resource + '/' + this.id(), success, error);
+    };
 }

package/src/job_operation_log.js

@@ -0,0 +1,65 @@
+import { generateUUID } from './uuid.js';
+import {
+    addPropertyTo,
+    fromJson,
+    getOne,
+    getList,
+    fromJsonList,
+    deleteOne,
+} from './model.js';
+import { Job } from './job.js';
+import { User } from './user.js';
+
+export function JobOperationLog() {
+    this.resource = '/job_operation_logs';
+    this.json = 'jobOperationLog';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'job', Job);
+    addPropertyTo(this, 'user', User);
+    addPropertyTo(this, 'sourceType');
+    addPropertyTo(this, 'aiInvolved');
+    addPropertyTo(this, 'action');
+    addPropertyTo(this, 'payloadJson');
+    addPropertyTo(this, 'changesJson');
+    addPropertyTo(this, 'operationJson');
+    addPropertyTo(this, 'createdAt');
+
+    this.get = function (success, error, embed) {
+        var self = this;
+        function handleResponse(result) {
+            success(
+                fromJson(self, result[self.json], { makesDirty: false })
+            );
+        }
+        getOne({
+            resource: this.resource,
+            id: this.id(),
+            success: handleResponse,
+            error: error,
+            embed: embed,
+        });
+    };
+
+    this.delete = function (options) {
+        options = options || {};
+        var success = options.success || function () {},
+            error = options.error || function () {};
+        deleteOne(this.resource + '/' + this.id(), success, error);
+    };
+}
+
+export function JobOperationLogs() {
+    this.resource = '/job_operation_logs';
+    this.json = 'jobOperationLogs';
+    this.single = JobOperationLog;
+
+    this.get = function (success, error, parameters) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, { makesDirty: false }));
+        }
+        getList(this.resource, handleResponse, error, parameters || {});
+    };
+}

package/src/merchi.js

@@ -54,6 +54,7 @@ import { Invoice, Invoices } from './invoice.js';
 import { Job, Jobs } from './job.js';
 import { JobComment } from './job_comment.js';
 import { JobNote } from './job_note.js';
+import { JobOperationLog, JobOperationLogs } from './job_operation_log.js';
 import { MerchiFile, MerchiFiles } from './merchi_file.js';
 import { Menu } from './menu.js';
 import { MenuItem } from './menu_item.js';
@@ -96,6 +97,12 @@ import {
     normalizeProductReviewApiJson,
     wireProductReviewCreateBody,
 } from './product_review.js';
+import * as pricing from './pricing/index.js';
+
+// Pure client-side pricing calculator (mirrors merchi_sdk_ts `pricing`):
+// estimateQuote, resolveVisibleFields, resolveVisibleOptionIds,
+// resolveUnavailableOptionIds, applyDiscount, roundHalfEven.
+export { pricing };
 
 export function merchi(backendUri, websocketUri) {
     getGlobal().merchiJsonpHandlers = {};
@@ -1067,6 +1074,8 @@ export function merchi(backendUri, websocketUri) {
             'jobs': new Jobs(),
             'JobComment': JobComment,
             'JobNote': JobNote,
+            'JobOperationLog': JobOperationLog,
+            'jobOperationLogs': new JobOperationLogs(),
             'Cart': Cart,
             'CartItem': CartItem,
             'Bank': Bank,

package/src/notification.js

@@ -26,6 +26,7 @@ export function Notification() {
     addPropertyTo(this, 'relatedJob', Job);
     addPropertyTo(this, 'attachment', MerchiFile);
     addPropertyTo(this, 'seen');
+    addPropertyTo(this, 'emailOpenedAt');
     addPropertyTo(this, 'htmlMessage');
     addPropertyTo(this, 'description');
     addPropertyTo(this, 'urgency');

package/src/pricing/__fixtures__/conditional_field_hidden.json

@@ -0,0 +1,112 @@
+{
+  "bundle": {
+    "currency": "AUD",
+    "fields": [
+      {
+        "fieldType": 2,
+        "id": 13,
+        "independent": true,
+        "isSelectable": true,
+        "options": [
+          {
+            "default": true,
+            "id": 9,
+            "originalId": null,
+            "position": 1,
+            "selectedBy": [],
+            "variationCost": 0.0,
+            "variationCostDiscountGroup": null,
+            "variationUnitCost": 0.0,
+            "variationUnitCostDiscountGroup": null
+          },
+          {
+            "default": false,
+            "id": 10,
+            "originalId": null,
+            "position": 2,
+            "selectedBy": [],
+            "variationCost": 0.0,
+            "variationCostDiscountGroup": null,
+            "variationUnitCost": 13.0,
+            "variationUnitCostDiscountGroup": null
+          }
+        ],
+        "originalId": null,
+        "position": 1,
+        "selectedBy": [],
+        "variationCost": 0.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      },
+      {
+        "fieldType": 1,
+        "id": 15,
+        "independent": true,
+        "isSelectable": false,
+        "options": [],
+        "originalId": null,
+        "position": 1,
+        "selectedBy": [
+          10
+        ],
+        "variationCost": 0.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      }
+    ],
+    "groupFields": [
+      {
+        "fieldType": 3,
+        "id": 14,
+        "independent": false,
+        "isSelectable": false,
+        "options": [],
+        "originalId": null,
+        "position": 2,
+        "selectedBy": [],
+        "variationCost": 0.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      }
+    ],
+    "hasGroups": true,
+    "product": {
+      "discountGroup": {
+        "discounts": [
+          {
+            "amount": 10.0,
+            "lowerLimit": 400.0
+          }
+        ],
+        "groupRestricted": false
+      },
+      "minimumPrice": 0.0,
+      "unitPrice": 30.0
+    },
+    "taxPercent": 10.0
+  },
+  "expected": {
+    "cost": 150.0,
+    "costPerUnit": 30.0,
+    "groupCosts": [],
+    "taxAmount": 15.0,
+    "totalCost": 165.0,
+    "visibleFieldIds": [
+      13
+    ]
+  },
+  "name": "conditional_field_hidden",
+  "selections": {
+    "fieldValues": {
+      "13": {
+        "selectedOptionIds": [
+          9
+        ]
+      }
+    },
+    "quantity": 5
+  }
+}

package/src/pricing/__fixtures__/conditional_field_visible.json

@@ -0,0 +1,113 @@
+{
+  "bundle": {
+    "currency": "AUD",
+    "fields": [
+      {
+        "fieldType": 2,
+        "id": 13,
+        "independent": true,
+        "isSelectable": true,
+        "options": [
+          {
+            "default": true,
+            "id": 9,
+            "originalId": null,
+            "position": 1,
+            "selectedBy": [],
+            "variationCost": 0.0,
+            "variationCostDiscountGroup": null,
+            "variationUnitCost": 0.0,
+            "variationUnitCostDiscountGroup": null
+          },
+          {
+            "default": false,
+            "id": 10,
+            "originalId": null,
+            "position": 2,
+            "selectedBy": [],
+            "variationCost": 0.0,
+            "variationCostDiscountGroup": null,
+            "variationUnitCost": 13.0,
+            "variationUnitCostDiscountGroup": null
+          }
+        ],
+        "originalId": null,
+        "position": 1,
+        "selectedBy": [],
+        "variationCost": 0.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      },
+      {
+        "fieldType": 1,
+        "id": 15,
+        "independent": true,
+        "isSelectable": false,
+        "options": [],
+        "originalId": null,
+        "position": 1,
+        "selectedBy": [
+          10
+        ],
+        "variationCost": 0.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      }
+    ],
+    "groupFields": [
+      {
+        "fieldType": 3,
+        "id": 14,
+        "independent": false,
+        "isSelectable": false,
+        "options": [],
+        "originalId": null,
+        "position": 2,
+        "selectedBy": [],
+        "variationCost": 0.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      }
+    ],
+    "hasGroups": true,
+    "product": {
+      "discountGroup": {
+        "discounts": [
+          {
+            "amount": 10.0,
+            "lowerLimit": 400.0
+          }
+        ],
+        "groupRestricted": false
+      },
+      "minimumPrice": 0.0,
+      "unitPrice": 30.0
+    },
+    "taxPercent": 10.0
+  },
+  "expected": {
+    "cost": 215.0,
+    "costPerUnit": 30.0,
+    "groupCosts": [],
+    "taxAmount": 21.5,
+    "totalCost": 236.5,
+    "visibleFieldIds": [
+      13,
+      15
+    ]
+  },
+  "name": "conditional_field_visible",
+  "selections": {
+    "fieldValues": {
+      "13": {
+        "selectedOptionIds": [
+          10
+        ]
+      }
+    },
+    "quantity": 5
+  }
+}

package/src/pricing/__fixtures__/group_product.json

@@ -0,0 +1,130 @@
+{
+  "bundle": {
+    "currency": "AUD",
+    "fields": [
+      {
+        "fieldType": 1,
+        "id": 12,
+        "independent": true,
+        "isSelectable": false,
+        "options": [],
+        "originalId": null,
+        "position": 1,
+        "selectedBy": [],
+        "variationCost": 11.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      }
+    ],
+    "groupFields": [
+      {
+        "fieldType": 2,
+        "id": 10,
+        "independent": false,
+        "isSelectable": true,
+        "options": [
+          {
+            "default": true,
+            "id": 7,
+            "originalId": null,
+            "position": 1,
+            "selectedBy": [],
+            "variationCost": 0.0,
+            "variationCostDiscountGroup": null,
+            "variationUnitCost": 0.0,
+            "variationUnitCostDiscountGroup": null
+          },
+          {
+            "default": false,
+            "id": 8,
+            "originalId": null,
+            "position": 2,
+            "selectedBy": [],
+            "variationCost": 0.0,
+            "variationCostDiscountGroup": null,
+            "variationUnitCost": 13.0,
+            "variationUnitCostDiscountGroup": null
+          }
+        ],
+        "originalId": null,
+        "position": 1,
+        "selectedBy": [],
+        "variationCost": 0.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      },
+      {
+        "fieldType": 3,
+        "id": 11,
+        "independent": false,
+        "isSelectable": false,
+        "options": [],
+        "originalId": null,
+        "position": 2,
+        "selectedBy": [],
+        "variationCost": 0.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      }
+    ],
+    "hasGroups": true,
+    "product": {
+      "discountGroup": {
+        "discounts": [
+          {
+            "amount": 10.0,
+            "lowerLimit": 400.0
+          }
+        ],
+        "groupRestricted": false
+      },
+      "minimumPrice": 0.0,
+      "unitPrice": 30.0
+    },
+    "taxPercent": 10.0
+  },
+  "expected": {
+    "cost": 645.0,
+    "costPerUnit": 30.0,
+    "groupCosts": [
+      215.0,
+      430.0
+    ],
+    "taxAmount": 64.5,
+    "totalCost": 709.5,
+    "visibleFieldIds": [
+      10,
+      11,
+      12
+    ]
+  },
+  "name": "group_product",
+  "selections": {
+    "fieldValues": {},
+    "groups": [
+      {
+        "fieldValues": {
+          "10": {
+            "selectedOptionIds": [
+              8
+            ]
+          }
+        },
+        "quantity": 5
+      },
+      {
+        "fieldValues": {
+          "10": {
+            "selectedOptionIds": [
+              8
+            ]
+          }
+        },
+        "quantity": 10
+      }
+    ]
+  }
+}

package/src/pricing/__fixtures__/non_selectable_number_field.json

@@ -0,0 +1,108 @@
+{
+  "bundle": {
+    "currency": "AUD",
+    "fields": [
+      {
+        "fieldType": 5,
+        "id": 9,
+        "independent": true,
+        "isSelectable": false,
+        "options": [],
+        "originalId": null,
+        "position": 1,
+        "selectedBy": [],
+        "variationCost": 25.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 5.0,
+        "variationUnitCostDiscountGroup": null
+      }
+    ],
+    "groupFields": [
+      {
+        "fieldType": 2,
+        "id": 7,
+        "independent": false,
+        "isSelectable": true,
+        "options": [
+          {
+            "default": true,
+            "id": 5,
+            "originalId": null,
+            "position": 1,
+            "selectedBy": [],
+            "variationCost": 0.0,
+            "variationCostDiscountGroup": null,
+            "variationUnitCost": 0.0,
+            "variationUnitCostDiscountGroup": null
+          },
+          {
+            "default": false,
+            "id": 6,
+            "originalId": null,
+            "position": 2,
+            "selectedBy": [],
+            "variationCost": 0.0,
+            "variationCostDiscountGroup": null,
+            "variationUnitCost": 13.0,
+            "variationUnitCostDiscountGroup": null
+          }
+        ],
+        "originalId": null,
+        "position": 1,
+        "selectedBy": [],
+        "variationCost": 0.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      },
+      {
+        "fieldType": 3,
+        "id": 8,
+        "independent": false,
+        "isSelectable": false,
+        "options": [],
+        "originalId": null,
+        "position": 2,
+        "selectedBy": [],
+        "variationCost": 0.0,
+        "variationCostDiscountGroup": null,
+        "variationUnitCost": 0.0,
+        "variationUnitCostDiscountGroup": null
+      }
+    ],
+    "hasGroups": true,
+    "product": {
+      "discountGroup": {
+        "discounts": [
+          {
+            "amount": 10.0,
+            "lowerLimit": 400.0
+          }
+        ],
+        "groupRestricted": false
+      },
+      "minimumPrice": 0.0,
+      "unitPrice": 30.0
+    },
+    "taxPercent": 10.0
+  },
+  "expected": {
+    "cost": 375.0,
+    "costPerUnit": 30.0,
+    "groupCosts": [],
+    "taxAmount": 37.5,
+    "totalCost": 412.5,
+    "visibleFieldIds": [
+      9
+    ]
+  },
+  "name": "non_selectable_number_field",
+  "selections": {
+    "fieldValues": {
+      "9": {
+        "value": "7"
+      }
+    },
+    "quantity": 10
+  }
+}