idosell 0.1.5 → 0.1.7

package/dist/gates.def.js

@@ -1569,6 +1569,7 @@
  * @property {(resultsPage: Integer) => GetProductsAuctionsRequest} resultsPage Page with results number. Numeration starts from 0
  * @property {(resultsLimit: Integer) => GetProductsAuctionsRequest} resultsLimit Number of results on page. Value from 1 to 100
  * @property {(ids: Array<Integer>) => GetProductsAuctionsRequest} ids Define products by passing array of values
+ * @property {() => GetProductsAuctionsRequest} fromAllegro Get auction data on products
  * @property {(page: Integer, limit: Integer) => GetProductsAuctionsRequest} page Define page number and maximum results per page
  * @property {() => Integer} count Returns total numer of results
  * @property {function} exec Excecute request
@@ -1808,7 +1809,7 @@
  * @property {(groups: Array<Object>) => PutProductsGroupsOrderRequest} groups 
  * @property {(productsInOrder: Array<Object>) => PutProductsGroupsOrderRequest} productsInOrder 
  * @property {function} append Append current data to array and start modifying next row
- * @property {() => PutProductsGroupsOrderRequest} productIdsInOrder Defines order of products within group by automatically setting proprities in order of appearance
+ * @property {(Array<Integer>) => PutProductsGroupsOrderRequest} productIdsInOrder Defines order of products within group by automatically setting proprities in order of appearance
  * @property {function} exec Excecute request
  */
 
@@ -2224,6 +2225,9 @@
  * @property {(minQuantityPerOrder: Object) => PostProductsRequest} minQuantityPerOrder Minimal number of products in an order
  * @property {(productDimensions: Object) => PostProductsRequest} productDimensions Dimensions and overall weight
  * @property {function} append Append current data to array and start modifying next row
+ * @property {(text: String, type: "name"|"short"|"long"|"metatitle"|"metadescription"|"metakeywords"|"acutionname"|"auctiondescription", language: String, shopId: Integer) => PostProductsRequest} setText Set various types of names or descriptions to the product
+ * @property {(value: Float, type: 'retail'|'wholesale'|'pos'|'minimal'|'strikethroughRetail'|'strikethroughWholesale'|'suggested'|'automaticCalculation') => PostProductsRequest} addPrice Increases product price by amount
+ * @property {(value: Float, type: 'retail'|'wholesale'|'pos'|'minimal'|'strikethroughRetail'|'strikethroughWholesale'|'suggested'|'automaticCalculation') => PostProductsRequest} setPrice Sets product price by amount
  * @property {function} exec Excecute request
  */
 
@@ -2363,6 +2367,12 @@
  * @property {(productDimensions: Object) => PutProductsRequest} productDimensions Dimensions and overall weight
  * @property {function} append Append current data to array and start modifying next row
  * @property {(text: String, type: "name"|"short"|"long"|"metatitle"|"metadescription"|"metakeywords"|"acutionname"|"auctiondescription", language: String, shopId: Integer) => PutProductsRequest} setText Set various types of names or descriptions to the product
+ * @property {() => PutProductsRequest} editMode Set edit mode - disables adding new product
+ * @property {() => PutProductsRequest} addMode Set add mode - Api is allowed to create new products
+ * @property {(value: Float, type: 'retail'|'wholesale'|'pos'|'minimal'|'strikethroughRetail'|'strikethroughWholesale'|'suggested'|'automaticCalculation') => PutProductsRequest} addPrice Increases product price by amount
+ * @property {(value: Float, type: 'retail'|'wholesale'|'pos'|'minimal'|'strikethroughRetail'|'strikethroughWholesale'|'suggested'|'automaticCalculation') => PutProductsRequest} setPrice Sets product price by amount
+ * @property {(shopId: Integer, menuIds: Integer) => PutProductsRequest} setMenu Sets product selected IDs
+ * @property {(picturesArray: Array<String>) => PutProductsRequest} pictures Sets list of pictures attached to product
  * @property {function} exec Excecute request
  */
 

package/dist/helpers.js

@@ -119,11 +119,15 @@ export const nest = (valueName, nodeName, obj = {}, forceArray = false) => (valu
     return params;
 }
 
+export const getCurrentAppendableArray = (object, nodeName) => {
+    const arr = object.params[object.appendable.arrayNode];
+    return arr[object.appendable.index][nodeName] ?? [];
+}
+
 export const nestArray = (object, valueName, nodeName, obj = {}) => (value) => {
     const node = { ...obj }, params = {};
     if (object.appendable) {
-        const arr = object.params[object.appendable.arrayNode];
-        params[nodeName] = arr[arr.length - 1][nodeName] ?? [];
+        params[nodeName] = getCurrentAppendableArray(object, nodeName)
     } else {
         params[nodeName] = object.params[nodeName] ?? [];
     }
@@ -138,6 +142,28 @@ export const orderSource = (sourceName) => (accountName = null) => {
     return params;
 }
 
+const PRICE_TYPES = {
+    'advance': 'Advance',
+    'retail': 'Retail',
+    'wholesale': 'Wholesale',
+    'minimal': 'Minimal',
+    'automaticalculation': 'AutomaticCalculation',
+    'pos': "Pos",
+    'suggested': 'Suggested',
+    'strikethroughretail': 'StrikethroughRetail',
+    'strikethroughwholesale': 'StrikethroughWholesale'
+}
+
+export const modifyPrice = (value, type, net, priceChangeMode = 'amount_set') => {
+    const typeName = PRICE_TYPES[type.toLowerCase()];
+    if (!typeName) throw new Error(`Invalid price type: ${type}. Availible types: ${Object.values(PRICE_TYPES)}`);
+    const node = ["product", typeName, "Price"];
+    if (net) node.push("Net");
+    const params = { priceChangeMode }
+    params[node.join('')] = value;
+    return params;
+}
+
 const TEXT_NODES = {
     name: {
         main: 'productNames',

package/dist/methods/getProductsAuctions.js

@@ -5,6 +5,7 @@ export default (object) => {
     object.gate = { method: 'get', node: '/products/auctions' };
     object.custom = {
         ids: arrayOfObjects("products", "identValue", {"identType":"id"}),
+        fromAllegro: () => { const auctionSites = object.params.auctionSites ?? []; auctionSites.push("allegro"); return { auctionSites }},
         page
     };
     return new Proxy(object, paramsProxy);

package/dist/methods/postProducts.js

@@ -1,7 +1,13 @@
 import { paramsProxy } from "../params.js";
+import { setProductText, modifyPrice } from "../helpers.js";
 
 export default (object) => {
     object.gate = { method: 'post', node: '/products/products' };
+    object.custom = {
+        setText: setProductText(object),
+        addPrice: (value, type = "retail", net = false) => modifyPrice(value, type, net, "amount_diff"),
+        setPrice: (value, type = "retail", net = false) => modifyPrice(value, type, net, "amount_set")
+    };
     object.appendable = {
         except: ["settings","picturesSettings"],
         arrayNode: "products",

package/dist/methods/putProducts.js

@@ -1,13 +1,19 @@
 import { paramsProxy } from "../params.js";
-import { setProductText } from "../helpers.js";
+import { setProductText, getCurrentAppendableArray, modifyPrice, arrayOfObjects } from "../helpers.js";
 
 export default (object) => {
     object.gate = { method: 'put', node: '/products/products' };
     object.custom = {
-        setText: setProductText(object)
+        setText: setProductText(object),
+        editMode: () => { const settings = object.params.settings ?? {}; settings.settingModificationType = "edit"; return { settings } },
+        addMode: () => { const settings = object.params.settings ?? {}; settings.settingModificationType = "edit"; return { settings } },
+        addPrice: (value, type = "retail", net = false) => modifyPrice(value, type, net, "amount_diff"),
+        setPrice: (value, type = "retail", net = false) => modifyPrice(value, type, net, "amount_set"),
+        setMenu: (shopId, menuIds) => { if (!Array.isArray(menuIds)) menuIds = [menuIds]; const productMenuItems = getCurrentAppendableArray(object, "productMenuItems"); for (const menuItemId of menuIds) { productMenuItems.push({ productMenuOperation: "add_product", shopId, menuItemId }) } return { productMenuItems}; },
+        pictures: (picturesArray) => { if (picturesArray.length) { if (!object.params.picturesSettings) object.params.picturesSettings = {}; object.params.picturesSettings.picturesSettingInputType = picturesArray[0].indexOf("http") === 0 ? "url" : "base64" }; return arrayOfObjects("productPictures", "productPictureSource")(picturesArray)}
     };
     object.appendable = {
-        except: ["settings","picturesSettings"],
+        except: ["settings","picturesSettings","editMode","addMode"],
         arrayNode: "products",
         index: 0
     }

package/dist/request.js

@@ -57,9 +57,9 @@ export const sendRequest = async (request, options = {}) => {
     let url = `${request.auth.url}/api/admin/v${request.auth.version}${node}`;
     if (options.log || options.dump) {
         console.log(util.inspect({ params: request.params, method, url }, {showHidden: false, depth: null, colors: true}))
+        if (options.dump) return;
     }
 
-    if (options.dump) return;
     
     if (method === 'get') {
         url += '?' + queryfy(request.params);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idosell",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Idosell 3 REST connector",
   "main": "dist/index.js",
   "scripts": {

package/tests/getClients.test.js

@@ -11,8 +11,8 @@ test("getClientsClientHasTradeCredit", () => {
     expect(params).toEqual({"clientHasTradeCredit":"nonzero"});
 })
 
-test("getClientsLastPurchase", () => {
-    const params = idosell().getClients.lastPurchase("2023-01-01", 1672704000000).getParams();
+test("getClientsLastPurchased", () => {
+    const params = idosell().getClients.lastPurchased("2023-01-01", 1672704000000).getParams();
     expect(params).toEqual({"clientLastPurchaseDate":{"clientLastPurchaseDateBegin":"2023-01-01","clientLastPurchaseDateEnd":"2023-01-03"}});
 })
 

package/tests/getProductsAuctions.test.js

@@ -4,4 +4,9 @@ import { expect, test } from "vitest"
 test("getProductsAuctionsPage", () => {
     const params = idosell().getProductsAuctions.page(2,10).getParams();
     expect(params).toEqual({"resultsPage":2,"resultsLimit":10});
+})
+
+test("getProductsAuctionsFromAllegro", () => {
+    const params = idosell().getProductsAuctions.ids(33).fromAllegro().getParams();
+    expect(params).toEqual({"products":[{"identType":"id","identValue":33}],"auctionSites":["allegro"]});
 })

package/tests/postProducts.test.js

@@ -9,4 +9,14 @@ test("postProductsProductSizes", () => {
 test("postProductsShopsMask", () => {
     const params = idosell().postProducts.shopsMask(1).getParams();
     expect(params).toEqual({"products":[{"shopsMask":1}]});
+})
+
+test("postProductsSetPrice", () => {
+    const params = idosell().postProducts.shopsMask(1).setPrice(199).getParams();
+    expect(params).toEqual({"products":[{"shopsMask":1,"priceChangeMode":"amount_set","productRetailPrice":199}]});
+})
+
+test("postProductsSetText", () => {
+    const params = idosell().postProducts.shopsMask(1).setText("Awesome199","name").getParams();
+    expect(params).toEqual({"products":[{"shopsMask":1,"productNames":{"productNamesLangData":[{"langId":"pol","productName":"Awesome199"}]}}]});
 })

package/tests/putProducts.test.js

@@ -1,12 +1,37 @@
 import idosell from "./dist/index.js"
 import { expect, test } from "vitest"
 
+test("putProductsCountryOfOrigin", () => {
+    const params = idosell().putProducts.productId(33).countryOfOrigin("PL").getParams();
+    expect(params).toEqual({"products":[{"productId":33,"countryOfOrigin":"PL"}]});
+})
+
 test("putProductsSetText", () => {
     const params = idosell().putProducts.productId(33).setText("Krzesło Pavon", "name").getParams();
     expect(params).toEqual({"products":[{"productId":33,"productNames":{"productNamesLangData":[{"langId":"pol","productName":"Krzesło Pavon"}]}}]});
 })
 
-test("putProductsCountryOfOrigin", () => {
-    const params = idosell().putProducts.productId(33).countryOfOrigin("PL").getParams();
-    expect(params).toEqual({"products":[{"productId":33,"countryOfOrigin":"PL"}]});
+test("putProductsEditMode", () => {
+    const params = idosell().putProducts.editMode().productId(33).productDisplayedCode("PD01").getParams();
+    expect(params).toEqual({"settings":{"settingModificationType":"edit"},"products":[{"productId":33,"productDisplayedCode":"PD01"}]});
+})
+
+test("putProductsSetRetailPrice", () => {
+    const params = idosell().putProducts.productId(33).setPrice(219).getParams();
+    expect(params).toEqual({"products":[{"productId":33,"priceChangeMode":"amount_set","productRetailPrice":219}]});
+})
+
+test("putProductsSetWholesaleNetPrice", () => {
+    const params = idosell().putProducts.productId(33).setPrice(169, "wholesale", true).getParams();
+    expect(params).toEqual({"products":[{"productId":33,"priceChangeMode":"amount_set","productWholesalePriceNet":169}]});
+})
+
+test("putProductsSetMenu", () => {
+    const params = idosell().putProducts.productId(33).setMenu(1,252).getParams();
+    expect(params).toEqual({"products":[{"productId":33,"productMenuItems":[{"productMenuOperation":"add_product","shopId":1,"menuItemId":252}]}]});
+})
+
+test("putProductsPictures", () => {
+    const params = idosell().putProducts.productId(77).pictures(["https://www.wikipedia.org/portal/wikipedia.org/assets/img/Wikipedia-logo-v2.png"]).getParams();
+    expect(params).toEqual({"products":[{"productId":77,"productPictures":[{"productPictureSource":"https://www.wikipedia.org/portal/wikipedia.org/assets/img/Wikipedia-logo-v2.png"}]}],"picturesSettings":{"picturesSettingInputType":"url"}});
 })

package/tests/putProductsImages.test.js

@@ -8,7 +8,7 @@ test("putProductsImagesProductImages", () => {
 
 test("putProductsImagesAddSingleImage", () => {
     const params = idosell().putProductsImages.productId(31).addImage("https://www.idosell.com/panel/file-gate.php?id=279794&ext=.webp").getParams();
-    expect(params).toEqual({"productsImagesSettings":{"productsImagesSourceType":"url","productsImagesApplyMacro":true},"productsImages":[{"productIdent":{"productIdentType":"id","identValue":31},"productImages":[{"productImageNumber":1,"productImageSource":"https://www.idosell.com/panel/file-gate.php?id=279794&ext=.webp"},{"productImageNumber":2,"productImageSource":"https://bit.ly/fcc-relaxing-cat"}]}]});
+    expect(params).toEqual({"productsImagesSettings":{"productsImagesSourceType":"url","productsImagesApplyMacro":true},"productsImages":[{"productIdent":{"productIdentType":"id","identValue":31},"productImages":[{"productImageNumber":1,"productImageSource":"https://www.idosell.com/panel/file-gate.php?id=279794&ext=.webp"}]}]});
 })
 
 test("putProductsImagesAddMultipleImage", () => {

package/tests/url.test.js

@@ -4,8 +4,8 @@ import { queryfy } from "../dist/request";
 import idosell from "./dist/index.js"
 import { expect, test } from "vitest"
 
-test("putWmsSuppliersName", () => {
-    const params = idosell().getClients.clientsIds([123,456,789]).lastPurchase("2023-01-01", 1672704000000).getParams();
+test("getClientsLastPurchased", () => {
+    const params = idosell().getClients.clientsIds([123,456,789]).lastPurchased("2023-01-01", 1672704000000).getParams();
     const search = queryfy(params);
     expect(search).toEqual("clientsIds=123%2C456%2C789&clientLastPurchaseDate%5BclientLastPurchaseDateBegin%5D=2023-01-01&clientLastPurchaseDate%5BclientLastPurchaseDateEnd%5D=2023-01-03")
 })