merchi_sdk_js 0.4.10 → 0.4.12

package/package.json

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

package/src/draft_template.js

@@ -24,6 +24,9 @@ export function DraftTemplate() {
     addPropertyTo(this, 'height');
     addPropertyTo(this, 'width');
     addPropertyTo(this, 'draftPreviewLayer', DraftPreviewLayer);
+    addPropertyTo(this, 'customisationMap');
+    addPropertyTo(this, 'customisationMapSource');
+    addPropertyTo(this, 'customisationMapFileId');
 
     this.create = function (options) {
         var data = serialise(this),

package/src/job.js

@@ -50,6 +50,7 @@ export function Job() {
     addPropertyTo(this, 'received');
     addPropertyTo(this, 'deadline');
     addPropertyTo(this, 'updated');
+    addPropertyTo(this, 'dateLastActioned');
     addPropertyTo(this, 'deductionDate');
     addPropertyTo(this, 'preDraftCommentsCount');
     addPropertyTo(this, 'clientFiles', MerchiFile);

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,
@@ -62,6 +63,7 @@ import { ProductionComment } from './production_comment.js';
 import { PhoneNumber, PhoneNumbers } from './phone_number.js';
 import { Session, Sessions } from './session.js';
 import { Shipment, Shipments } from './shipment.js';
+import { ShipmentLog, ShipmentLogs } from './shipment_log.js';
 import { ShipmentMethod, ShipmentMethods } from './shipment_method.js';
 import { ShipmentMethodVariation, ShipmentMethodVariations } from
     './shipment_method_variation.js';
@@ -87,6 +89,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 = {};
@@ -865,6 +873,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(),
@@ -981,6 +1081,8 @@ export function merchi(backendUri, websocketUri) {
             'removeUnstoredFiles': removeUnstoredFiles,
             'Shipment': Shipment,
             'shipments': new Shipments(),
+            'ShipmentLog': ShipmentLog,
+            'shipmentLogs': new ShipmentLogs(),
             'ShipmentMethod': ShipmentMethod,
             'shipmentMethods': new ShipmentMethods(),
             'ShipmentMethodVariation': ShipmentMethodVariation,
@@ -1022,6 +1124,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,
@@ -1100,5 +1206,8 @@ export function merchi(backendUri, websocketUri) {
             'productTypes': productTypes,
             'productTypesInts': productTypesInts,
             'productTypesSeller': productTypesSeller,
-            'getProductShipmentOptions': getProductShipmentOptions};
+            'getProductShipmentOptions': getProductShipmentOptions,
+            'listProductReviews': listProductReviews,
+            'createProductReview': createProductReview,
+            'patchProductReview': patchProductReview};
 }

package/src/product.js

@@ -42,10 +42,12 @@ export function Product() {
     addPropertyTo(this, 'independent');
     addPropertyTo(this, 'productType');
     addPropertyTo(this, 'description');
+    addPropertyTo(this, 'aiContextDrafting');
     addPropertyTo(this, 'notes');
     addPropertyTo(this, 'spProductId');
     addPropertyTo(this, 'shopifyProductId');
     addPropertyTo(this, 'minimum');
+    addPropertyTo(this, 'defaultQuantity')
     addPropertyTo(this, 'minimumPrice')
     addPropertyTo(this, 'minimumPerGroup');
     addPropertyTo(this, 'deliveryDaysNormal');
@@ -116,6 +118,7 @@ export function Product() {
     addPropertyTo(this, 'shipmentMethods', ShipmentMethod);
     addPropertyTo(this, 'seoDomainPages', SeoDomainPage);
     addPropertyTo(this, 'aiContext');
+    addPropertyTo(this, 'aiContextDrafting');
     addPropertyTo(this, 'internalUseNotes');
     addPropertyTo(this, 'internalUseAiContext');
     addPropertyTo(this, 'groupsFirst');

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
+            );
+        });
+    };
+}

package/src/shipment.js

@@ -12,6 +12,7 @@ import { Invoice } from './invoice.js';
 import { Job } from './job.js';
 import { MerchiFile } from './merchi_file.js';
 import { ShipmentItem } from './shipment_item.js';
+import { ShipmentLog } from './shipment_log.js';
 import { ShipmentMethod } from './shipment_method.js';
 import { Reminder } from './reminder.js';
 import { InternalTag } from './internal_tag.js';
@@ -60,6 +61,7 @@ export function Shipment() {
     addPropertyTo(this, 'shipmentMethod', ShipmentMethod);
     addPropertyTo(this, 'internalTags', InternalTag);
     addPropertyTo(this, 'reminders', Reminder);
+    addPropertyTo(this, 'logs', ShipmentLog);
 
     this.get = function (success, error, embed) {
         var self = this;

package/src/shipment_log.js

@@ -0,0 +1,74 @@
+import { generateUUID } from './uuid.js';
+import {
+    addPropertyTo,
+    serialise,
+    create,
+    enumerateFiles,
+    fromJson,
+    getOne,
+    getList,
+    fromJsonList,
+} from './model.js';
+import { Shipment } from './shipment.js';
+import { User } from './user.js';
+
+export function ShipmentLog() {
+    this.resource = '/shipment_logs';
+    this.json = 'shipmentLog';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'shipment', Shipment);
+    addPropertyTo(this, 'user', User);
+    addPropertyTo(this, 'sourceType');
+    addPropertyTo(this, 'message');
+    addPropertyTo(this, 'detailJson');
+    addPropertyTo(this, 'createdAt');
+
+    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,
+        });
+    };
+
+    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,
+        });
+    };
+}
+
+export function ShipmentLogs() {
+    this.resource = '/shipment_logs';
+    this.json = 'shipmentLogs';
+    this.single = ShipmentLog;
+
+    this.get = function (success, error, parameters) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, { makesDirty: false }));
+        }
+        getList(this.resource, handleResponse, error, parameters || {});
+    };
+}