goods-exporter 0.3.10 → 0.3.12

package/LICENSE

@@ -1,22 +1,22 @@
-The MIT License (MIT)
-
-Copyright © 2023 German Bagdasaryan
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-“Software”), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+The MIT License (MIT)
+
+Copyright © 2023 German Bagdasaryan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+“Software”), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,95 +1,95 @@
-# goods-exporter
-
-[![npm version](https://img.shields.io/npm/v/goods-exporter)](https://www.npmjs.com/package/goods-exporter)
-![npm](https://img.shields.io/npm/dm/goods-exporter)
-![GitHub issues](https://img.shields.io/github/issues/Bagi4-source/goods-converter)
-[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/Bagi4-source/goods-converter/blob/main/LICENSE)
-
-
-A versatile JavaScript library for exporting goods data to various formats such as YML, CSV, and Excel. Simplify data
-export tasks with ease.
-
-[![Telegram](https://img.shields.io/badge/Telegram-%40goods_exporter-blue?logo=telegram)](https://t.me/+gGHmBC8VZ4BjYjZi)
-
-## Features
-
-- Export goods data to YML, CSV, and Excel formats.
-- Easily integrate into your JavaScript projects.
-- Compatible with Node.js version 16 and above.
-- Comprehensive TypeScript type definitions included.
-
-## Supported formats
-
-- YML (Yandex Market Language)
-- CSV
-- Excel
-- TgShop
-- Insales
-- Tilda
-
-## Installation
-
-To use `goods-exporter` in your project, simply add it to your dependencies using npm or yarn:
-
-```bash
-npm install goods-exporter --save
-# or
-yarn add goods-exporter
-```
-
-## Quick start
-
-```typescript
-import { GoodsExporter, Product, Category, Formatters } from '../src'
-
-// Create an instance of the GoodsExporter class.
-const exporter = new GoodsExporter()
-
-const products: Product[] = [] // Put your products;
-const categories: Category[] = [{ id: 1, name: 'Обувь' }]
-
-// Call the data export method.
-exporter.export(products, categories)
-```
-
-## Example
-
-```typescript
-import fs from "fs"; // Import the 'fs' module for file writing.
-
-// Create an instance of the GoodsExporter class.
-const exporter = new GoodsExporter()
-
-// Define an object 'transformers' that contains data transformation functions.
-const transformers: Transformer[] = [
-    (product) => ({
-        ...product,
-        price: product.price + 10000
-    }),
-    (product) => ({
-        ...product,
-        images: product.images?.map(image => image.replace("image", "pic"))
-    })
-]
-
-// Set the formatter for exporting data to YML.
-exporter.setFormatter(new Formatters.YMLFormatter()) // or your own Formatter;
-
-// Set transformers based on the specified keys.
-exporter.setTransformers(transformers);
-
-// Set an exporter that saves the data to the "output.yml" file.
-exporter.setExporter((data: Buffer) => {
-    fs.writeFileSync("output.yml", data); // Write data to the "output.yml" file.
-    return data; // Return the data (you can return any type).
-});
-
-// Call the data export method specifying the data type (Buffer) and expect the result as a promise.
-exporter.export<Buffer>(products, categories)
-    .then(data => {
-        // Here, you can add additional handling for the export result if needed.
-    });
-```
-
-# Supported by [PoizonAPI](https://t.me/PoizonAPI) 
-[![PoizonAPI](https://i.ibb.co/HBbTpp0/Group-1.png)](https://t.me/PoizonAPI)
+# goods-exporter
+
+[![npm version](https://img.shields.io/npm/v/goods-exporter)](https://www.npmjs.com/package/goods-exporter)
+![npm](https://img.shields.io/npm/dm/goods-exporter)
+![GitHub issues](https://img.shields.io/github/issues/Bagi4-source/goods-converter)
+[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/Bagi4-source/goods-converter/blob/main/LICENSE)
+
+
+A versatile JavaScript library for exporting goods data to various formats such as YML, CSV, and Excel. Simplify data
+export tasks with ease.
+
+[![Telegram](https://img.shields.io/badge/Telegram-%40goods_exporter-blue?logo=telegram)](https://t.me/+gGHmBC8VZ4BjYjZi)
+
+## Features
+
+- Export goods data to YML, CSV, and Excel formats.
+- Easily integrate into your JavaScript projects.
+- Compatible with Node.js version 16 and above.
+- Comprehensive TypeScript type definitions included.
+
+## Supported formats
+
+- YML (Yandex Market Language)
+- CSV
+- Excel
+- TgShop
+- Insales
+- Tilda
+
+## Installation
+
+To use `goods-exporter` in your project, simply add it to your dependencies using npm or yarn:
+
+```bash
+npm install goods-exporter --save
+# or
+yarn add goods-exporter
+```
+
+## Quick start
+
+```typescript
+import { GoodsExporter, Product, Category, Formatters } from '../src'
+
+// Create an instance of the GoodsExporter class.
+const exporter = new GoodsExporter()
+
+const products: Product[] = [] // Put your products;
+const categories: Category[] = [{ id: 1, name: 'Обувь' }]
+
+// Call the data export method.
+exporter.export(products, categories)
+```
+
+## Example
+
+```typescript
+import fs from "fs"; // Import the 'fs' module for file writing.
+
+// Create an instance of the GoodsExporter class.
+const exporter = new GoodsExporter()
+
+// Define an object 'transformers' that contains data transformation functions.
+const transformers: Transformer[] = [
+    (product) => ({
+        ...product,
+        price: product.price + 10000
+    }),
+    (product) => ({
+        ...product,
+        images: product.images?.map(image => image.replace("image", "pic"))
+    })
+]
+
+// Set the formatter for exporting data to YML.
+exporter.setFormatter(new Formatters.YMLFormatter()) // or your own Formatter;
+
+// Set transformers based on the specified keys.
+exporter.setTransformers(transformers);
+
+// Set an exporter that saves the data to the "output.yml" file.
+exporter.setExporter((data: Buffer) => {
+    fs.writeFileSync("output.yml", data); // Write data to the "output.yml" file.
+    return data; // Return the data (you can return any type).
+});
+
+// Call the data export method specifying the data type (Buffer) and expect the result as a promise.
+exporter.export<Buffer>(products, categories)
+    .then(data => {
+        // Here, you can add additional handling for the export result if needed.
+    });
+```
+
+# Supported by [PoizonAPI](https://t.me/PoizonAPI) 
+[![PoizonAPI](https://i.ibb.co/HBbTpp0/Group-1.png)](https://t.me/PoizonAPI)

package/dist/bundle.d.ts

@@ -471,6 +471,24 @@ interface Product {
      * Пример: 6241421
      */
     certificate?: string;
+    /**
+     * **Ключевые слова**
+     *
+     * Пример: Кроссовки, высокая подошва
+     */
+    keywords?: string[];
+    /**
+     * **Размерная сетка**
+     */
+    sizes?: ISize[];
+    /**
+     * **Связанные товары**
+     *
+     * Указываются id товаров
+     *
+     * Пример: 1234
+     */
+    relatedProducts?: number[];
 }
 declare enum Vat {
     NO_VAT = "NO_VAT",
@@ -496,6 +514,22 @@ interface IParam {
      */
     value: string;
 }
+interface ISize {
+    /**
+     * **Название единицы измерения**
+     */
+    name: string;
+    /**
+     * **Разделитель**
+     */
+    delimiter: string;
+    /**
+     * **Значения размерного ряда**
+     *
+     * Размеры указываются через разделитель
+     */
+    value: string;
+}
 
 interface Category {
     /**
@@ -535,13 +569,13 @@ declare enum Extension {
 declare class CSVFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
-    format(products: Product[], categories?: Category[], option?: FormatterOptions): Promise<string>;
+    format(products: Product[], categories?: Category[], options?: FormatterOptions): Promise<string>;
 }
 
 declare class ExcelFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
-    format(products: Product[], categories?: Category[], _?: FormatterOptions): Promise<Buffer>;
+    format(products: Product[], categories?: Category[], options?: FormatterOptions): Promise<Buffer>;
 }
 
 declare class InsalesFormatter implements FormatterAbstract {
@@ -592,4 +626,4 @@ declare class GoodsExporter {
     export(products: Product[], categories?: Category[], option?: FormatterOptions): Promise<Buffer>;
 }
 
-export { type Category, Currency, type Exporter, Extension, FormatterAbstract, type FormatterOptions, Formatters, GoodsExporter, type IParam, type Product, type Transformer, Vat };
+export { type Category, Currency, type Exporter, Extension, FormatterAbstract, type FormatterOptions, Formatters, GoodsExporter, type IParam, type ISize, type Product, type Transformer, Vat };

package/dist/cjs/index.cjs

@@ -34,6 +34,39 @@ var Extension = /* @__PURE__ */ ((Extension2) => {
   return Extension2;
 })(Extension || {});
 
+const getParams = (product, option) => {
+  const params = {};
+  if (option?.splitParams === false) {
+    return params;
+  }
+  product.params?.forEach(
+    ({ key, value }) => params[`Param [${key}]`] = value
+  );
+  return params;
+};
+const getProperties = (product, option) => {
+  const properties = {};
+  if (option?.splitParams === false) {
+    return properties;
+  }
+  product.properties?.forEach(
+    ({ key, value }) => properties[`Property [${key}]`] = value
+  );
+  return properties;
+};
+const getSizes = (product, option) => {
+  const sizes = {};
+  product.sizes?.forEach(
+    ({ name, value }) => sizes[`Size [${name}]`] = value
+  );
+  return sizes;
+};
+const UTILS = {
+  getSizes,
+  getParams,
+  getProperties
+};
+
 var __defProp$6 = Object.defineProperty;
 var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$6 = (obj, key, value) => {
@@ -45,29 +78,9 @@ class CSVFormatter {
     __publicField$6(this, "formatterName", "CSV");
     __publicField$6(this, "fileExtension", Extension.CSV);
   }
-  async format(products, categories, option) {
+  async format(products, categories, options) {
     const mappedCategories = {};
     categories?.forEach(({ id, name }) => mappedCategories[id] = name);
-    const getParams = (product) => {
-      const params = {};
-      if (option?.splitParams === false) {
-        return params;
-      }
-      product.params?.forEach(
-        ({ key, value }) => params[`Param [${key}]`] = value
-      );
-      return params;
-    };
-    const getProperties = (product) => {
-      const properties = {};
-      if (option?.splitParams === false) {
-        return properties;
-      }
-      product.properties?.forEach(
-        ({ key, value }) => properties[`Property [${key}]`] = value
-      );
-      return properties;
-    };
     const data = products.map((product) => ({
       ...product,
       category: mappedCategories[product.categoryId],
@@ -76,8 +89,12 @@ class CSVFormatter {
       tags: product.tags?.join(","),
       codesTN: product.codesTN?.join(", "),
       params: product.params?.map(({ key, value }) => `${key}=${value}`).join(","),
-      ...getParams(product),
-      ...getProperties(product)
+      ...UTILS.getParams(product, options),
+      ...UTILS.getProperties(product, options),
+      ...UTILS.getSizes(product, options),
+      sizes: void 0,
+      keywords: product.keywords?.join(","),
+      relatedProducts: product.relatedProducts?.join(",")
     }));
     return json2Csv.json2csv(data, { emptyFieldValue: "" });
   }
@@ -94,33 +111,23 @@ class ExcelFormatter {
     __publicField$5(this, "formatterName", "Excel");
     __publicField$5(this, "fileExtension", Extension.XLSX);
   }
-  async format(products, categories, _) {
+  async format(products, categories, options) {
     const mappedCategories = {};
     categories?.forEach(({ id, name }) => mappedCategories[id] = name);
-    const getParams = (product) => {
-      const params = {};
-      product.params?.forEach(
-        ({ key, value }) => params[`Param [${key}]`] = value
-      );
-      return params;
-    };
-    const getProperties = (product) => {
-      const properties = {};
-      product.properties?.forEach(
-        ({ key, value }) => properties[`Property [${key}]`] = value
-      );
-      return properties;
-    };
     const data = products.map((product) => ({
       ...product,
       category: mappedCategories[product.categoryId],
       images: product.images?.join(","),
       videos: product.videos?.join(","),
       tags: product.tags?.join(","),
+      keywords: product.keywords?.join(","),
+      relatedProducts: product.relatedProducts?.join(","),
       codesTN: product.codesTN?.join(", "),
       params: product.params?.map(({ key, value }) => `${key}=${value}`).join(","),
-      ...getParams(product),
-      ...getProperties(product)
+      sizes: void 0,
+      ...UTILS.getParams(product, options),
+      ...UTILS.getProperties(product, options),
+      ...UTILS.getSizes(product, options)
     }));
     const workBook = xlsx.utils.book_new();
     const productsWorkSheet = xlsx.utils.json_to_sheet(data);
@@ -159,6 +166,13 @@ class InsalesFormatter {
       );
       return properties;
     };
+    const getSizes = (product) => {
+      const sizes = {};
+      product.sizes?.forEach(
+        ({ name, value }) => sizes[`\u0420\u0430\u0437\u043C\u0435\u0440\u044B [${name}]:`] = value
+      );
+      return sizes;
+    };
     const getCategories = (product) => {
       const categories2 = {};
       const categoryList = new Array();
@@ -202,7 +216,9 @@ class InsalesFormatter {
       "\u041F\u0430\u0440\u0430\u043C\u0435\u0442\u0440: \u0411\u0440\u0435\u043D\u0434": product.vendor,
       \u0410\u0440\u0442\u0438\u043A\u0443\u043B: product.vendorCode,
       ...getParams(product),
-      ...getProperties(product)
+      ...getProperties(product),
+      ...getSizes(product),
+      "\u0421\u0432\u044F\u0437\u0430\u043D\u043D\u044B\u0435 \u0442\u043E\u0432\u0430\u0440\u044B": product.relatedProducts?.join(",")
     }));
     const workBook = xlsx.utils.book_new();
     const productsWorkSheet = xlsx.utils.json_to_sheet(data);
@@ -344,6 +360,12 @@ class YMLFormatter {
       available: product.available,
       "min-quantity": product.minQuantity,
       "step-quantity": product.stepQuantity,
+      size: product.sizes?.map((size) => ({
+        "#text": size.value,
+        "@_name": size.name,
+        "@_delimiter": size.delimiter
+      })),
+      keyword: product.keywords,
       property: product.properties?.map((property) => ({
         "#text": property.value,
         "@_name": property.key
@@ -381,7 +403,8 @@ class YMLFormatter {
       },
       "tn-ved-codes": product.codesTN?.length != null && {
         "tn-ved-code": product.codesTN
-      }
+      },
+      relatedProduct: product.relatedProducts
     };
     if (product.parentId !== void 0) {
       return {