merchi_sdk_js 0.5.2 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "merchi_sdk_js",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "type": "module",
   "main": "src/merchi.js",
   "module": "src/merchi.js",

package/src/job.js

@@ -29,6 +29,7 @@ import { Variation } from './variation.js';
 import { VariationsGroup } from './variations_group.js';
 import { Item } from './item.js';
 import { JobComment } from './job_comment.js';
+import { JobNote } from './job_note.js';
 import { Reminder } from './reminder.js';
 import { InternalTag } from './internal_tag.js';
 
@@ -41,7 +42,7 @@ export function Job() {
     addPropertyTo(this, 'id');
     addPropertyTo(this, 'currency');
     addPropertyTo(this, 'quantity');
-    addPropertyTo(this, 'notes');
+    addPropertyTo(this, 'jobNotes', JobNote);
     addPropertyTo(this, 'jobType');
     addPropertyTo(this, 'product', Product);
     addPropertyTo(this, 'supplyChainRequestProduct', Product);
@@ -51,6 +52,7 @@ export function Job() {
     addPropertyTo(this, 'deadline');
     addPropertyTo(this, 'updated');
     addPropertyTo(this, 'dateLastActioned');
+    addPropertyTo(this, 'dateFirstActioned');
     addPropertyTo(this, 'deductionDate');
     addPropertyTo(this, 'preDraftCommentsCount');
     addPropertyTo(this, 'clientFiles', MerchiFile);
@@ -105,7 +107,6 @@ export function Job() {
     addPropertyTo(this, 'limitedStock');
     addPropertyTo(this, 'canDeduct');
 
-    addPropertyTo(this, 'productionNotes');
     addPropertyTo(this, "needsDrafting");
     addPropertyTo(this, "needsGroupBuy");
     addPropertyTo(this, "needsProduction");

package/src/job_note.js

@@ -0,0 +1,36 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, enumerateFiles, fromJson, create, serialise } from './model.js';
+import { Job } from './job.js';
+import { User } from './user.js';
+import { MerchiFile } from './merchi_file.js';
+
+export function JobNote() {
+    this.resource = '/job_notes';
+    this.json = 'jobNote';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'job', Job);
+    addPropertyTo(this, 'createdBy', User);
+    addPropertyTo(this, 'lastEditedBy', User);
+    addPropertyTo(this, 'files', MerchiFile);
+    addPropertyTo(this, 'noteType');
+    addPropertyTo(this, 'richText');
+    addPropertyTo(this, 'creationDate');
+    addPropertyTo(this, 'lastEditedTime');
+
+    this.create = function (options) {
+        var data = serialise(this),
+            self = this;
+        function handleResponse(result) {
+            options.success(fromJson(self, result[self.json]));
+        }
+        create({resource: this.resource,
+                parameters: data[0],
+                files: enumerateFiles(data[1]),
+                success: handleResponse,
+                as_domain: options.as_domain,
+                error: options.error,
+                embed: options.embed});
+    };
+}

package/src/merchi.js

@@ -1,3 +1,4 @@
+import axios from 'axios';
 import { isBrowser } from 'browser-or-node';
 import { generateUUID } from './uuid.js';
 import { isNull, isUndefined, isUndefinedOrNull, id,
@@ -52,6 +53,7 @@ import { Notification, Notifications } from './notification.js';
 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 { MerchiFile, MerchiFiles } from './merchi_file.js';
 import { Menu } from './menu.js';
 import { MenuItem } from './menu_item.js';
@@ -88,6 +90,12 @@ import { AgentSkillApproval, AgentSkillApprovals } from './agent_skill_approval.
 import { DomainChatSettings, DomainChatSettingsList } from './domain_chat_settings.js';
 import { SupportConversation, SupportConversations } from './support_conversation.js';
 import { SupportMessage, SupportMessages } from './support_message.js';
+import {
+    ProductReview,
+    ProductReviews,
+    normalizeProductReviewApiJson,
+    wireProductReviewCreateBody,
+} from './product_review.js';
 
 export function merchi(backendUri, websocketUri) {
     getGlobal().merchiJsonpHandlers = {};
@@ -866,6 +874,98 @@ export function merchi(backendUri, websocketUri) {
         request.send();
     }
 
+    function productReviewsApiRoot() {
+        var base = getGlobal().merchiBackendUri;
+        if (!base.endsWith('/')) {
+            base += '/';
+        }
+        return base + 'v6';
+    }
+
+    function productReviewsSessionSuffix() {
+        if (getGlobal().currentSession &&
+                getGlobal().currentSession.token()) {
+            return '?session_token=' + encodeURIComponent(
+                getGlobal().currentSession.token());
+        }
+        return '';
+    }
+
+    /**
+     * List product reviews (domain manager/admin). ``success`` receives
+     * ``{ productReviews: ... }`` — same keys as the API, but each row is a
+     * ``ProductReview`` model instance with ``job`` / ``product`` / ``domain``.
+     */
+    function listProductReviews(productId, success, error) {
+        var url = productReviewsApiRoot() + '/products/' + productId +
+            '/reviews/' + productReviewsSessionSuffix();
+        axios.get(url)
+            .then(function (res) {
+                var reviews = new ProductReviews().fromProductListResponse(
+                    res.data);
+                success(Object.assign({}, res.data, {productReviews: reviews}));
+            })
+            .catch(function (err) {
+                error(err.response ? err.response.data : err);
+            });
+    }
+
+    /**
+     * Create a product review (buyer, JSON body). Send ``jobId`` or ``job: { id }``
+     * (completed job whose catalog product matches ``productId`` after clone
+     * resolution), plus ``rating`` and optional ``title`` / ``content``.
+     * ``success`` receives ``{ productReview }`` as a ``ProductReview`` model.
+     */
+    function createProductReview(productId, data, success, error) {
+        var url = productReviewsApiRoot() + '/products/' + productId +
+            '/reviews/' + productReviewsSessionSuffix();
+        axios.post(url, wireProductReviewCreateBody(data), {
+            headers: {'Content-Type': 'application/json'},
+        })
+            .then(function (res) {
+                var pr = fromJson(
+                    new ProductReview(),
+                    normalizeProductReviewApiJson(res.data.productReview),
+                    {makesDirty: false});
+                success(Object.assign({}, res.data, {productReview: pr}));
+            })
+            .catch(function (err) {
+                error(err.response ? err.response.data : err);
+            });
+    }
+
+    /**
+     * Patch a review (``formFields`` plain object: status, rejectionReason,
+     * rating, title, content — sent as multipart form data).
+     * ``success`` receives ``{ productReview }`` as a model when present.
+     */
+    function patchProductReview(reviewId, formFields, success, error) {
+        var url = productReviewsApiRoot() + '/product-reviews/' + reviewId +
+            '/' + productReviewsSessionSuffix();
+        var fd = new FormData();
+        Object.keys(formFields || {}).forEach(function (k) {
+            var v = formFields[k];
+            if (v !== undefined && v !== null) {
+                fd.append(k, String(v));
+            }
+        });
+        axios.patch(url, fd)
+            .then(function (res) {
+                if (!res.data || !res.data.productReview) {
+                    success(res.data);
+                    return;
+                }
+                var pr = fromJson(
+                    new ProductReview(),
+                    normalizeProductReviewApiJson(res.data.productReview),
+                    {makesDirty: false});
+                success(Object.assign({}, res.data, {productReview: pr}));
+            })
+            .catch(function (err) {
+                error(err.response ? err.response.data : err);
+            });
+    }
+
     function getProductShipmentOptions(
         productId, quantity, address, success, error) {
         var request = new Request(),
@@ -966,6 +1066,7 @@ export function merchi(backendUri, websocketUri) {
             'Job': Job,
             'jobs': new Jobs(),
             'JobComment': JobComment,
+            'JobNote': JobNote,
             'Cart': Cart,
             'CartItem': CartItem,
             'Bank': Bank,
@@ -1025,6 +1126,10 @@ export function merchi(backendUri, websocketUri) {
             'supportConversations': new SupportConversations(),
             'SupportMessage': SupportMessage,
             'supportMessages': new SupportMessages(),
+            'ProductReview': ProductReview,
+            'productReviews': new ProductReviews(),
+            'normalizeProductReviewApiJson': normalizeProductReviewApiJson,
+            'wireProductReviewCreateBody': wireProductReviewCreateBody,
             'SubscriptionPlan': SubscriptionPlan,
             'subscriptionPlans': new SubscriptionPlans(),
             'VariationField': VariationField,
@@ -1103,5 +1208,8 @@ export function merchi(backendUri, websocketUri) {
             'productTypes': productTypes,
             'productTypesInts': productTypesInts,
             'productTypesSeller': productTypesSeller,
-            'getProductShipmentOptions': getProductShipmentOptions};
+            'getProductShipmentOptions': getProductShipmentOptions,
+            'listProductReviews': listProductReviews,
+            'createProductReview': createProductReview,
+            'patchProductReview': patchProductReview};
 }

package/src/model.js

@@ -335,6 +335,10 @@ export function getList(resource, success, error, parameters, withUpdates) {
     if (parameters.asRole) {
         request.query().add('as_role', JSON.stringify(parameters.asRole));
     }
+    if (notEmpty(parameters.isJobManager)) {
+        request.query().add('is_job_manager',
+                            JSON.stringify(parameters.isJobManager));
+    }
     if (parameters.groupBuyOnly) {
         request.query().add('group_buy_only',
                             JSON.stringify(parameters.groupBuyOnly));

package/src/product_review.js

@@ -0,0 +1,96 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, fromJson } from './model.js';
+import { Domain } from './domain.js';
+import { Job } from './job.js';
+import { Product } from './product.js';
+
+/**
+ * Map flat API fields (jobId, productId, domainId) onto job / product / domain
+ * before ``fromJson``.
+ */
+export function normalizeProductReviewApiJson(json) {
+    if (json === null || json === undefined || typeof json !== 'object') {
+        return json;
+    }
+    var row = Object.assign({}, json);
+    if (row.jobId !== undefined && row.job === undefined) {
+        if (row.jobId != null) {
+            row.job = {id: row.jobId};
+        }
+        delete row.jobId;
+    }
+    if (row.productId !== undefined && row.product === undefined) {
+        if (row.productId != null) {
+            row.product = {id: row.productId};
+        }
+        delete row.productId;
+    }
+    if (row.domainId !== undefined && row.domain === undefined) {
+        if (row.domainId != null) {
+            row.domain = {id: row.domainId};
+        }
+        delete row.domainId;
+    }
+    return row;
+}
+
+/**
+ * Turn create payload ``{ job: { id }, rating, ... }`` into API JSON with ``jobId``.
+ * Pass-through if ``jobId`` is already set.
+ */
+export function wireProductReviewCreateBody(data) {
+    if (!data || typeof data !== 'object') {
+        return data;
+    }
+    var body = Object.assign({}, data);
+    if (body.job && body.job.id != null && body.jobId === undefined) {
+        body.jobId = body.job.id;
+        delete body.job;
+    }
+    return body;
+}
+
+export function ProductReview() {
+    this.resource = '/product-reviews';
+    this.json = 'productReview';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'product', Product);
+    addPropertyTo(this, 'domain', Domain);
+    addPropertyTo(this, 'authorUserId');
+    addPropertyTo(this, 'authorName');
+    addPropertyTo(this, 'job', Job);
+    addPropertyTo(this, 'rating');
+    addPropertyTo(this, 'title');
+    addPropertyTo(this, 'content');
+    addPropertyTo(this, 'status');
+    addPropertyTo(this, 'purchaseInvoiceId');
+    addPropertyTo(this, 'submittedAt');
+    addPropertyTo(this, 'updatedAt');
+    addPropertyTo(this, 'rejectionReason');
+}
+
+export function ProductReviews() {
+    this.json = 'productReviews';
+    this.single = ProductReview;
+
+    /**
+     * @param {object} data - API body with ``productReviews`` array
+     * @param {object} [options] - passed to ``fromJson`` (e.g. ``{makesDirty: false}``)
+     * @returns {ProductReview[]}
+     */
+    this.fromProductListResponse = function (data, options) {
+        var raw = (data && data.productReviews) ? data.productReviews : [];
+        var self = this;
+        var defaults = {makesDirty: false};
+        var opts = Object.assign({}, defaults, options);
+        return raw.map(function (row) {
+            return fromJson(
+                new self.single(),
+                normalizeProductReviewApiJson(row),
+                opts
+            );
+        });
+    };
+}