merchi_sdk_js 0.0.1

package/src/product.js

@@ -0,0 +1,309 @@
+import { generateUUID } from './uuid.js';
+import { notEmptyArray, isUndefinedOrNull,
+    removeObjectFromArrayWithIntegerValue } from './helpers.js';
+import { addPropertyTo, getList, fromJsonList, deleteOne, patchOne, fromJson,
+    serialise, getOne, create, enumerateFiles, Request } from './model.js';
+import { productTypesInts } from './product_types.js';
+import { Category } from './category.js';
+import { Component } from './component.js';
+import { Company } from './company.js';
+import { CountryTax } from './country_tax.js';
+import { DraftTemplate } from './draft_template.js';
+import { DomainTag } from './domain_tag.js';
+import { DiscountGroup } from './discount_group.js';
+import { Domain } from './domain.js';
+import { Inventory } from './inventory.js';
+import { ShipmentMethod } from './shipment_method.js';
+import { VariationField } from './variation_field.js';
+import { VariationsGroup } from './variations_group.js';
+import { MerchiFile } from './merchi_file.js';
+import { SupplyDomain } from './supply_domain.js';
+import { User } from './user.js';
+import { Job } from './job.js';
+import { SeoDomainPage } from './seo_domain_page.js';
+import { InternalTag } from './internal_tag.js';
+
+export function Product() {
+    this.resource = '/products';
+    this.json = 'product';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'name');
+    addPropertyTo(this, 'created');
+    addPropertyTo(this, 'updated');
+    addPropertyTo(this, 'country');
+    addPropertyTo(this, 'currency');
+    addPropertyTo(this, 'createdBy', User);
+    addPropertyTo(this, 'updatedBy', User);
+    addPropertyTo(this, 'independent');
+    addPropertyTo(this, 'productType');
+    addPropertyTo(this, 'description');
+    addPropertyTo(this, 'notes');
+    addPropertyTo(this, 'shopifyProductId');
+    addPropertyTo(this, 'minimum');
+    addPropertyTo(this, 'minimumPerGroup');
+    addPropertyTo(this, 'deliveryDaysNormal');
+    addPropertyTo(this, 'unitPrice');
+    addPropertyTo(this, 'unitPriceDiscountGroup', DiscountGroup);
+    addPropertyTo(this, 'bestPrice');
+    addPropertyTo(this, 'unitWeight');
+    addPropertyTo(this, 'unitHeight');
+    addPropertyTo(this, 'unitWidth');
+    addPropertyTo(this, 'unitDepth');
+    addPropertyTo(this, 'unitVolume');
+    addPropertyTo(this, 'showGroupBuyStatus');
+    addPropertyTo(this, 'groupBuyStatus');
+    addPropertyTo(this, 'needsDrafting');
+    addPropertyTo(this, 'needsProduction');
+    addPropertyTo(this, 'needsShipping');
+    addPropertyTo(this, 'needsInvoicing');
+    addPropertyTo(this, 'needsInventory');
+    addPropertyTo(this, 'showFeatureDeadline');
+    addPropertyTo(this, 'featureDeadline');
+    addPropertyTo(this, 'suppliers', User);
+    addPropertyTo(this, 'groupVariationFields', VariationField);
+    addPropertyTo(this, 'independentVariationFields', VariationField);
+    addPropertyTo(this, 'originalProduct', Product);
+    addPropertyTo(this, 'clonedFromProduct', Product);
+    addPropertyTo(this, 'chainedSupplierProduct', Product);
+    addPropertyTo(this, 'chainedSellerProducts', Product);
+    addPropertyTo(this, 'chainedInventorySupplierProduct', Product);
+    addPropertyTo(this, 'chainedInventorySellerProducts', Product);
+    addPropertyTo(this, 'component', Component);
+    addPropertyTo(this, 'domain', Domain);
+    addPropertyTo(this, 'suppliedByDomains', SupplyDomain);
+    addPropertyTo(this, 'autoAssignProductionOnAction');
+    addPropertyTo(this, 'supplyDomains', SupplyDomain);
+    addPropertyTo(this, 'images', MerchiFile);
+    addPropertyTo(this, 'featureImage', MerchiFile);
+    addPropertyTo(this, 'publicFiles', MerchiFile);
+    addPropertyTo(this, 'productionFiles', MerchiFile);
+    addPropertyTo(this, 'showPublic');
+    addPropertyTo(this, 'acceptSquare');
+    addPropertyTo(this, 'acceptStripe');
+    addPropertyTo(this, 'acceptPaypal');
+    addPropertyTo(this, 'acceptUtrust');
+    addPropertyTo(this, 'acceptBankTransfer');
+    addPropertyTo(this, 'acceptPhonePayment');
+    addPropertyTo(this, 'supplyChainDisabled');
+    addPropertyTo(this, 'allowAutomaticPaymentSupply');
+    addPropertyTo(this, 'allowGroupBuy');
+    addPropertyTo(this, 'allowPaymentUpfront');
+    addPropertyTo(this, 'allowQuotation');
+    addPropertyTo(this, 'allowChainedInventoryCreation');
+    addPropertyTo(this, 'allowClientDraftContribution');
+    addPropertyTo(this, 'chainedInventoryHandlingUnitPrice');
+    addPropertyTo(this, 'savedByUsers', User);
+    addPropertyTo(this, 'savedByCompanies', Company);
+    addPropertyTo(this, 'tags', DomainTag);
+    addPropertyTo(this, 'inventories', Inventory);
+    addPropertyTo(this, 'inventoriesOpen');
+    addPropertyTo(this, 'discountGroups', DiscountGroup);
+    addPropertyTo(this, 'categories', Category);
+    addPropertyTo(this, 'taxType', CountryTax);
+    addPropertyTo(this, 'defaultJob', Job);
+    addPropertyTo(this, 'supplyChainRequestJobs', Job);
+    addPropertyTo(this, 'draftTemplates', DraftTemplate);
+    addPropertyTo(this, 'shipmentMethods', ShipmentMethod);
+    addPropertyTo(this, 'seoDomainPages', SeoDomainPage);
+    addPropertyTo(this, 'aiContext');
+    addPropertyTo(this, 'internalUseNotes');
+    addPropertyTo(this, 'internalUseAiContext');
+    addPropertyTo(this, 'internalTags', InternalTag);
+
+    this.create = function (success, error, embed, asDomain) {
+        var data = serialise(this),
+            self = this,
+            domain = self.domain() ? self.domain().id() : null,
+            domainId = isUndefinedOrNull(asDomain) ? domain : asDomain;
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json]));
+        }
+        create({resource: this.resource,
+                parameters: data[0],
+                as_domain: domainId,
+                files: enumerateFiles(data[1]),
+                success: handleResponse,
+                error: error,
+                embed: 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});
+    };
+
+    this.patch = function (success, error, embed) {
+        var self = this,
+            data = serialise(this, undefined, undefined, undefined,
+                             {excludeOld: true})[0];
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json],
+                             {makesDirty: false}));
+        }
+        patchOne({resource: this.resource,
+                  id: this.id(),
+                  success: handleResponse,
+                  error: error,
+                  data: data,
+                  embed: embed});
+    };
+
+    this.destroy = function (success, error) {
+        deleteOne(this.resource + '/' + this.id(), success, error);
+    };
+
+    this.duplicate = function (success, error) {
+        var self = this,
+            request = new Request();
+        request.resource('/products/' + self.id() + '/copy/');
+        request.method('POST');
+        function handleResponse(status, data) {
+            if (status === 201) {
+                success(fromJson(self, data[self.json]));
+            } else {
+                error(null, data);
+            }
+        }
+        request.responseHandler(handleResponse).errorHandler(error);
+        request.send();
+    };
+
+   this.company = function () {
+        return this.domain() ? this.domain().company() : null;
+    }
+    this.variationFields = function () {
+        var variationFields = [];
+        if (notEmptyArray(this.groupVariationFields())) {
+            variationFields = variationFields.
+                concat(this.groupVariationFields());
+        }
+
+        if (notEmptyArray(this.independentVariationFields())) {
+            variationFields = variationFields.
+                concat(this.independentVariationFields());
+        }
+        return variationFields;
+    };
+
+    this.removeVariation = function (variation) {
+        var variations = !variation.independent() ?
+            this.groupVariationFields() : this.independentVariationFields();
+        return removeObjectFromArrayWithIntegerValue(
+            variations, 'id', variation.id());
+    };
+
+    this.primaryImage = function () {
+        var feature = this.featureImage(),
+            images = this.images(),
+            firstImage = images && images[0] ? images[0] : null;
+        return feature ? feature : firstImage;
+    };
+
+    this.productPrimaryImage = function () {
+        return this.primaryImage() ? this.primaryImage().viewUrl() : null;
+    };
+
+    this.productCurrency = function () {
+        var domain = this.domain();
+        return domain && domain.company() ?
+            domain.company().defaultCurrency() : null;
+    };
+
+    this.hasGroupVariationFields = function () {
+        return notEmptyArray(this.groupVariationFields());
+    };
+
+    this.hasIndependentVariationFields = function () {
+        return notEmptyArray(this.independentVariationFields());
+    };
+
+    this.buildEmptyVariationGroup = function () {
+        var variationsGroupBuilt = new VariationsGroup(),
+            groupVariationFields = this.groupVariationFields(),
+            emptyGroupCost = 0,
+            variations = [],
+            i,
+            emptyVariation;
+        variationsGroupBuilt.quantity('0');
+
+        for (i = 0; i < groupVariationFields.length; i++) {
+            emptyVariation =
+                groupVariationFields[i].buildEmptyVariation();
+            variations.push(emptyVariation);
+            emptyGroupCost += parseFloat(emptyVariation.cost(), 10);
+        }
+
+        variationsGroupBuilt.groupCost(emptyGroupCost.toString());
+        variationsGroupBuilt.variations(variations);
+        return variationsGroupBuilt;
+    };
+
+    this.buildEmptyVariations = function () {
+        var emptyVariations = [],
+            emptyVariation,
+            independentVariationFields = this.independentVariationFields(),
+            i;
+
+        for (i = 0; i < independentVariationFields.length; i++) {
+            emptyVariation =
+                independentVariationFields[i].buildEmptyVariation();
+            emptyVariations.push(emptyVariation);
+        }
+        return emptyVariations;
+    };
+
+    this.tax = function () {
+        return this.taxType();
+    };
+
+    this.previewImages = function (maxImages) {
+        var files = this.images();
+        if (Boolean(files)) {
+            return files.slice(0, maxImages);
+        }
+        return [];
+    };
+
+    this.stripePublishableKey = function () {
+        return this.domain().company() ?
+            this.domain().company().stripePublishableKey() : null;
+    };
+
+    this.stripeIsValidAndActive = function () {
+        const company = this.domain().company();
+        return this.stripePublishableKey() && company &&
+            company.acceptStripe();
+    };
+
+    this.isSupplierMOD = function () {
+        return this.productType() ===
+            productTypesInts.get('Supplier MOD (made on demand)');
+    };
+
+    this.isResell = function () {
+        return this.isSupplierMOD();
+    };
+}
+
+export function Products() {
+    this.resource = '/products';
+    this.json = 'products';
+    this.single = Product;
+
+    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/product_types.js

@@ -0,0 +1,28 @@
+import { Dictionary } from './dictionary.js';
+
+export const productTypes = new Dictionary();
+productTypes.add(0, 'supplier MOD (made on demand)');
+productTypes.add(1, 'supplier');
+productTypes.add(2, 'seller');
+productTypes.add(3, 'seller MOD (made on demand)');
+productTypes.add(4, 'cloned MOD (made on demand)');
+productTypes.add(5, 'seller cloned MOD (made on demand)');
+productTypes.add(6, 'production MOD (made on demand)');
+productTypes.add(7, 'cloned supplier');
+productTypes.add(8, 'seller inventory');
+productTypes.add(9, 'supplir inventory');
+productTypes.add(10, 'seller group buy');
+productTypes.add(11, 'supplier resell MOD (made on demand)');
+productTypes.add(12, 'supplier resell');
+productTypes.add(14, 'supplier group buy inventory');
+productTypes.add(14, 'seller inventory cloned');
+productTypes.add(15, 'seller group buy inventory cloned');
+productTypes.add(16, 'supply seller MOD(made on demand) cloned');
+productTypes.add(17, 'supplier to supplier resell MOD(made on demand)');
+productTypes.add(18, 'supplier resell cloned');
+productTypes.add(19, 'supply domain reference');
+
+export const productTypesInts = new Dictionary();
+productTypes.each(function (key, value) {
+    productTypesInts.add(value, parseInt(key, 10));
+});

package/src/production_comment.js

@@ -0,0 +1,40 @@
+import { addPropertyTo, enumerateFiles, create, serialise,
+    fromJson } from './model.js';
+import { Assignment } from './assignment.js';
+import { User } from './user.js';
+import { MerchiFile } from './merchi_file.js';
+import { Notification } from './notification.js';
+
+export function ProductionComment() {
+    this.resource = '/production_comments';
+    this.json = 'productionComment';
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'user', User);
+    addPropertyTo(this, 'file', MerchiFile);
+    addPropertyTo(this, 'notifications', Notification);
+    addPropertyTo(this, 'assignment', Assignment);
+    addPropertyTo(this, 'date');
+    addPropertyTo(this, 'text');
+    addPropertyTo(this, 'urgency');
+    addPropertyTo(this, 'subject');
+    addPropertyTo(this, 'sendSms');
+    addPropertyTo(this, 'sendEmail');
+    addPropertyTo(this, 'isUrgentQuestion');
+
+    this.create = function (options) {
+        var data = serialise(this),
+            self = this,
+            embed = options.embed ? options.embed : {};
+        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.asDomain,
+                error: options.error,
+                embed: embed});
+    };
+}

package/src/quote.js

@@ -0,0 +1,89 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, fromJson, getOne, fromJsonList,
+    getList } from './model.js';
+import { QuoteItem } from './quote_item.js';
+import { Assignment } from './assignment.js';
+import { Invoice } from './invoice.js';
+
+export function Quote() {
+    this.resource = '/quotes';
+    this.json = 'quote';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'agreedDeadline');
+    addPropertyTo(this, 'quoteItems', QuoteItem);
+    addPropertyTo(this, 'assignments', Assignment);
+    addPropertyTo(this, 'currency');
+    addPropertyTo(this, 'invoice', Invoice);
+
+    this.get = function (success, error) {
+        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});
+    };
+
+    this.quoteTotal = function () {
+        var self = this,
+            items = Boolean(self.quoteItems()) ? self.quoteItems() : [],
+            total = parseFloat(0.000), i;
+        for (i = 0; i < items.length; i++) {
+            total += parseFloat(items[i].total());
+        }
+        return total;
+    };
+
+    this.deadlineTimeDifference = function () {
+        var self = this,
+            proposedDeadline = Boolean(self.agreedDeadline()) ?
+                self.agreedDeadline() : null,
+            assignments = Boolean(self.assignments()) ?
+                self.assignments() : null,
+            assignment = Boolean(assignments) && assignments.length > 0 ?
+                assignments[0] : null,
+            productionDeadline = Boolean(assignment) ?
+                assignment.productionDeadline() : null;
+        if (Boolean(proposedDeadline) && Boolean(productionDeadline)) {
+            return productionDeadline - proposedDeadline;
+        }
+        return null;
+    };
+
+    this.findQuoteItemIndex = function (quoteItemId) {
+        var self = this,
+            quoteItems = Boolean(self.quoteItems()) ? self.quoteItems() : [];
+        return quoteItems.findIndex(function (arrayElement) {
+                return String(arrayElement.id()) === String(quoteItemId);
+            });
+    };
+
+    this.removeQuoteItem = function (quoteItem) {
+        var self = this,
+            itemIndex = self.findQuoteItemIndex(quoteItem.id()),
+            quoteItems = self.quoteItems();
+        if (Boolean(quoteItems) && itemIndex >= 0) {
+            quoteItems.splice(itemIndex, 1);
+        }
+    };
+}
+
+export function Quotes() {
+    this.resource = '/quotes';
+    this.json = 'quotes';
+    this.single = Quote;
+
+    this.get = function (success, error, offset, limit, q) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error,
+                {offset: offset, limit: limit, q: q});
+    };
+}

package/src/quote_item.js

@@ -0,0 +1,51 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, fromJson, getOne, fromJsonList,
+    getList } from './model.js';
+
+export function QuoteItem() {
+    this.resource = '/quote_items';
+    this.json = 'quoteItem';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'type');
+    addPropertyTo(this, 'quantity');
+    addPropertyTo(this, 'description');
+    addPropertyTo(this, 'unitPrice');
+
+    this.get = function (success, error) {
+        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});
+    };
+
+    this.total = function () {
+        var self = this,
+            quantity = Boolean(self.quantity()) ? self.quantity() : 0,
+            unitPrice = Boolean(self.unitPrice()) ? self.unitPrice() : 0,
+            total;
+        total = quantity * unitPrice;
+        return total.toFixed(3);
+    };
+}
+
+export function QuoteItems() {
+    this.resource = '/quote_items';
+    this.json = 'quoteItems';
+    this.single = QuoteItem;
+
+    this.get = function (success, error, offset, limit, q) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error,
+                {offset: offset, limit: limit, q: q});
+    };
+}

package/src/roles.js

@@ -0,0 +1,27 @@
+import { Dictionary } from './dictionary.js';
+import { Set } from './set.js';
+
+export const roles = new Dictionary();
+roles.add('public', 0);
+roles.add('admin', 1);
+roles.add('sales', 2);
+roles.add('designer', 3);
+roles.add('supplier', 4);
+roles.add('client', 5);
+roles.add('manager', 6);
+roles.add('accountant', 7);
+roles.add('theme editor', 8);
+
+export const systemRoles = new Dictionary();
+systemRoles.add("Component builder", 1);
+
+export const allRoles = new Set();
+roles.each(function (key, value) {
+    allRoles.add(value);
+});
+
+export const COMPONENT_BUILDER = 'Component builder';
+export const SELLER = 'Seller';
+export const SELLER_PLUS = 'Seller plus';
+export const SUPPLIER = 'Supplier';
+export const RESTRICTED_SUPPLIER = 'Restricted supplier';

package/src/seo_domain_page.js

@@ -0,0 +1,35 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, getList, fromJsonList } from './model.js';
+import { Domain } from './domain.js';
+import { Product } from './product.js';
+
+export function SeoDomainPage() {
+    this.resource = '/seo_domain_pages';
+    this.json = 'seoDomainPage';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'archived');
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'metaDescription');
+    addPropertyTo(this, 'metaRobots');
+    addPropertyTo(this, 'metaTitle');
+    addPropertyTo(this, 'pageKey');
+    addPropertyTo(this, 'domain', Domain);
+    addPropertyTo(this, 'product', Product);
+}
+
+export function SeoDomainPages() {
+    this.resource = '/seo_domain_pages';
+    this.json = 'seoDomainPage';
+    this.single = SeoDomainPage;
+
+    this.get = function (success, error, offset, limit, q) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result,
+                                 {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error,
+                {offset: offset, limit: limit, q: q});
+    };
+}

package/src/session.js

@@ -0,0 +1,102 @@
+import { Dictionary } from './dictionary.js';
+import { addPropertyTo, create, fromJson, getOne, deleteOne, fromJsonList,
+    getList, Request } from './model.js';
+import { User } from './user.js';
+import { Domain } from './domain.js';
+
+export function Session() {
+    this.resource = '/sessions';
+    this.json = 'session';
+
+    addPropertyTo(this, 'ip');
+    addPropertyTo(this, 'user', User);
+    addPropertyTo(this, 'domain', Domain);
+    addPropertyTo(this, 'token');
+    addPropertyTo(this, 'remember');
+
+    this.create = function (success, error, embed, username, password) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json]));
+        }
+        create({resource: this.resource,
+                success: handleResponse,
+                error: error,
+                embed: embed,
+                username: username,
+                password: password});
+    };
+
+    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.token(),
+                success: handleResponse,
+                error: error,
+                embed: embed});
+    };
+
+    this.remove = function (success, error) {
+        deleteOne(this.resource, success, error);
+    };
+
+    this.storeCreate = function (success, error, parameters) {
+        var request = new Request(),
+            query = new Dictionary(),
+            password = parameters.password,
+            remember = parameters.remember,
+            storeName = parameters.storeName,
+            username = parameters.email;
+            self = this;
+
+        if (password) {
+            request.password(password);
+        }
+
+        if (remember) {
+            query.add('remember', remember);
+        }
+
+        if (storeName) {
+            query.add('storeName', storeName);
+        }
+
+        if (username) {
+            request.username(username);
+        }
+        request.resource('/store-session/');
+        request.method('POST');
+        request.query().merge(query);
+        function handleResponse(status, data) {
+            success(fromJson(self, data[self.json]));
+        }
+        function handleError(status, data) {
+            var statusCode = status ? status : 400,
+                errorObject = data ? data :
+                    {message: 'could not connect to server',
+                     errorCode: 0};
+            error(statusCode, errorObject);
+        }
+        request.responseHandler(handleResponse).errorHandler(handleError);
+        request.send();
+    }
+}
+
+export function Sessions() {
+    this.resource = '/sessions';
+    this.json = 'sessions';
+    this.single = Session;
+
+    this.get = function (success, error, parameters) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error,
+                parameters);
+    };
+}