goods-exporter 1.4.1 → 1.4.3

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,106 +1,106 @@
-# 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 JSON, YML, CSV, and Excel formats.
-- Easily integrate into your JavaScript projects.
-- Compatible with Node.js version 16 and above.
-- Comprehensive TypeScript type definitions included.
-- Supports streams.
-
-## Supported formats
-
-- YML (Yandex Market Language)
-- JSON
-- SimpleJSON (grouped)
-- CSV
-- Excel
-- TgShop
-- Insales
-- Tilda
-- WooCommerce
-
-## 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";
-import { PassThrough } from "stream";
-
-// 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.
-const stream = new PassThrough();
-exporter.setExporter(() => stream);
-exporter.setFormatter(new Formatters.YMLFormatter());
-exporter.setTransformers([
-  (products) => {
-    return products.map((product) => ({
-      ...product,
-      price: product.price + 10000,
-      images: product.images?.map((image) => image.replace("image", "pic")),
-    }));
-  },
-]);
-await 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[] = [
-  (products) =>
-    products.map((product) => ({
-      ...product,
-      price: product.price + 10000,
-    })),
-  (products) =>
-    products.map((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(fs.createWriteStream("output.yml"));
-await exporter.export(products, categories);
-```
-
-# 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 JSON, YML, CSV, and Excel formats.
+- Easily integrate into your JavaScript projects.
+- Compatible with Node.js version 16 and above.
+- Comprehensive TypeScript type definitions included.
+- Supports streams.
+
+## Supported formats
+
+- YML (Yandex Market Language)
+- JSON
+- SimpleJSON (grouped)
+- CSV
+- Excel
+- TgShop
+- Insales
+- Tilda
+- WooCommerce
+
+## 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";
+import { PassThrough } from "stream";
+
+// 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.
+const stream = new PassThrough();
+exporter.setExporter(() => stream);
+exporter.setFormatter(new Formatters.YMLFormatter());
+exporter.setTransformers([
+  (products) => {
+    return products.map((product) => ({
+      ...product,
+      price: product.price + 10000,
+      images: product.images?.map((image) => image.replace("image", "pic")),
+    }));
+  },
+]);
+await 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[] = [
+  (products) =>
+    products.map((product) => ({
+      ...product,
+      price: product.price + 10000,
+    })),
+  (products) =>
+    products.map((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(fs.createWriteStream("output.yml"));
+await exporter.export(products, categories);
+```
+
+# 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

@@ -648,6 +648,12 @@ declare class JSONFormatter implements FormatterAbstract {
     format(writableStream: Writable, products: Product[], categories?: Category[], brands?: Brand[], _?: FormatterOptions): Promise<void>;
 }
 
+declare class PriceFormatter implements FormatterAbstract {
+    formatterName: string;
+    fileExtension: Extension;
+    format(writableStream: Writable, products: Product[], _categories?: Category[], _brands?: Brand[], _?: FormatterOptions): Promise<void>;
+}
+
 declare class SimpleJSONFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
@@ -704,6 +710,7 @@ declare const Formatters: {
     SimpleJSONFormatter: typeof SimpleJSONFormatter;
     XMLFormatter: typeof XMLFormatter;
     WooCommerceFormatter: typeof WooCommerceFormatter;
+    PriceFormatter: typeof PriceFormatter;
 };
 
 type Transformer<Context> = (products: Product[], context: Context) => Product[] | Promise<Product[]>;

package/dist/cjs/index.cjs

@@ -66,17 +66,17 @@ const urlQueryEncode = (inputUrl) => {
   }
 };
 
-var __defProp$b = Object.defineProperty;
-var __defNormalProp$b = (obj, key, value) => key in obj ? __defProp$b(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$b = (obj, key, value) => __defNormalProp$b(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$c = Object.defineProperty;
+var __defNormalProp$c = (obj, key, value) => key in obj ? __defProp$c(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$c = (obj, key, value) => __defNormalProp$c(obj, typeof key !== "symbol" ? key + "" : key, value);
 class CSVStream {
   constructor({ delimiter, lineSeparator, emptyFieldValue }) {
-    __publicField$b(this, "stream", new stream$3.PassThrough());
-    __publicField$b(this, "delimiter", ";");
-    __publicField$b(this, "lineSeparator", "\n");
-    __publicField$b(this, "emptyFieldValue", "");
-    __publicField$b(this, "columns", /* @__PURE__ */ new Set());
-    __publicField$b(this, "writer", writeWithDrain(this.stream));
+    __publicField$c(this, "stream", new stream$3.PassThrough());
+    __publicField$c(this, "delimiter", ";");
+    __publicField$c(this, "lineSeparator", "\n");
+    __publicField$c(this, "emptyFieldValue", "");
+    __publicField$c(this, "columns", /* @__PURE__ */ new Set());
+    __publicField$c(this, "writer", writeWithDrain(this.stream));
     if (delimiter !== void 0) this.delimiter = delimiter;
     if (lineSeparator !== void 0) this.lineSeparator = lineSeparator;
     if (emptyFieldValue !== void 0) this.emptyFieldValue = emptyFieldValue;
@@ -109,13 +109,13 @@ var Extension = /* @__PURE__ */ ((Extension2) => {
   return Extension2;
 })(Extension || {});
 
-var __defProp$a = Object.defineProperty;
-var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$a = (obj, key, value) => __defNormalProp$a(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$b = Object.defineProperty;
+var __defNormalProp$b = (obj, key, value) => key in obj ? __defProp$b(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$b = (obj, key, value) => __defNormalProp$b(obj, typeof key !== "symbol" ? key + "" : key, value);
 class CSVFormatter {
   constructor() {
-    __publicField$a(this, "formatterName", "CSV");
-    __publicField$a(this, "fileExtension", Extension.CSV);
+    __publicField$b(this, "formatterName", "CSV");
+    __publicField$b(this, "fileExtension", Extension.CSV);
   }
   async format(writableStream, products, categories, _, __) {
     const mappedCategories = {};
@@ -182,14 +182,14 @@ class CSVFormatter {
   }
 }
 
-var __defProp$9 = Object.defineProperty;
-var __defNormalProp$9 = (obj, key, value) => key in obj ? __defProp$9(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$9 = (obj, key, value) => __defNormalProp$9(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$a = Object.defineProperty;
+var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$a = (obj, key, value) => __defNormalProp$a(obj, typeof key !== "symbol" ? key + "" : key, value);
 const { stream: stream$2 } = pkg;
 class ExcelFormatter {
   constructor() {
-    __publicField$9(this, "formatterName", "Excel");
-    __publicField$9(this, "fileExtension", Extension.XLSX);
+    __publicField$a(this, "formatterName", "Excel");
+    __publicField$a(this, "fileExtension", Extension.XLSX);
   }
   async format(writableStream, products, categories, _, __) {
     const mappedCategories = {};
@@ -258,14 +258,14 @@ class ExcelFormatter {
   }
 }
 
-var __defProp$8 = Object.defineProperty;
-var __defNormalProp$8 = (obj, key, value) => key in obj ? __defProp$8(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$8 = (obj, key, value) => __defNormalProp$8(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$9 = Object.defineProperty;
+var __defNormalProp$9 = (obj, key, value) => key in obj ? __defProp$9(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$9 = (obj, key, value) => __defNormalProp$9(obj, typeof key !== "symbol" ? key + "" : key, value);
 const { stream: stream$1 } = pkg;
 class InsalesFormatter {
   constructor() {
-    __publicField$8(this, "formatterName", "Insales");
-    __publicField$8(this, "fileExtension", Extension.XLSX);
+    __publicField$9(this, "formatterName", "Insales");
+    __publicField$9(this, "fileExtension", Extension.XLSX);
   }
   async format(writableStream, products, categories, _, __) {
     const mappedCategories = {};
@@ -395,13 +395,13 @@ class InsalesFormatter {
   }
 }
 
-var __defProp$7 = Object.defineProperty;
-var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$7 = (obj, key, value) => __defNormalProp$7(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$8 = Object.defineProperty;
+var __defNormalProp$8 = (obj, key, value) => key in obj ? __defProp$8(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$8 = (obj, key, value) => __defNormalProp$8(obj, typeof key !== "symbol" ? key + "" : key, value);
 class JSONFormatter {
   constructor() {
-    __publicField$7(this, "formatterName", "JSON");
-    __publicField$7(this, "fileExtension", Extension.JSON);
+    __publicField$8(this, "formatterName", "JSON");
+    __publicField$8(this, "fileExtension", Extension.JSON);
   }
   async format(writableStream, products, categories, brands, _) {
     const stream = new jsonStreamStringify.JsonStreamStringify({
@@ -413,6 +413,44 @@ class JSONFormatter {
   }
 }
 
+var __defProp$7 = Object.defineProperty;
+var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$7 = (obj, key, value) => __defNormalProp$7(obj, typeof key !== "symbol" ? key + "" : key, value);
+class PriceFormatter {
+  constructor() {
+    __publicField$7(this, "formatterName", "Price");
+    __publicField$7(this, "fileExtension", Extension.JSON);
+  }
+  async format(writableStream, products, _categories, _brands, _) {
+    const priceMap = /* @__PURE__ */ new Map();
+    products.forEach((product) => {
+      const existing = priceMap.get(product.productId);
+      const sku = {
+        skuId: String(product.variantId),
+        price: product.price,
+        currency: product.currency
+      };
+      if (product.timeDelivery?.min !== void 0 || product.timeDelivery?.max !== void 0) {
+        sku.timeDelivery = {
+          min: product.timeDelivery.min ?? 0,
+          max: product.timeDelivery.max ?? 0
+        };
+      }
+      if (existing) {
+        existing.skus.push(sku);
+      } else {
+        priceMap.set(product.productId, {
+          productId: product.productId,
+          skus: [sku]
+        });
+      }
+    });
+    const result = Array.from(priceMap.values());
+    const stream = new jsonStreamStringify.JsonStreamStringify(result);
+    stream.pipe(writableStream);
+  }
+}
+
 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) => __defNormalProp$6(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -535,7 +573,7 @@ class TildaFormatter {
     const mappedCategories = {};
     categories?.forEach(({ id, name }) => mappedCategories[id] = name);
     const csvStream = new CSVStream({
-      delimiter: ";",
+      delimiter: "	",
       emptyFieldValue: "",
       lineSeparator: "\n"
     });
@@ -554,6 +592,15 @@ class TildaFormatter {
       "External ID",
       "Parent UID"
     ]);
+    const characteristics = /* @__PURE__ */ new Set();
+    products.forEach((product) => {
+      product.properties?.forEach(({ key }) => {
+        characteristics.add(key);
+      });
+    });
+    characteristics.forEach((charKey) => {
+      columns.add(`Characteristics:${charKey}`);
+    });
     csvStream.setColumns(columns);
     for (const product of products) {
       const row = {
@@ -562,7 +609,7 @@ class TildaFormatter {
         Category: mappedCategories[product.categoryId],
         Title: product.title,
         Text: product.description,
-        Photo: product.images?.join(";"),
+        Photo: product.images?.map(urlQueryEncode).join(","),
         Price: product.price,
         "Price Old": product.oldPrice,
         Quantity: product.count,
@@ -570,6 +617,9 @@ class TildaFormatter {
         "External ID": product.variantId,
         "Parent UID": product.parentId
       };
+      product.properties?.forEach(({ key, value }) => {
+        row[`Characteristics:${key}`] = value;
+      });
       await csvStream.addRow(row);
     }
     csvStream.writableStream.end();
@@ -998,7 +1048,8 @@ const Formatters = {
   JSONFormatter,
   SimpleJSONFormatter,
   XMLFormatter,
-  WooCommerceFormatter
+  WooCommerceFormatter,
+  PriceFormatter
 };
 
 var __defProp = Object.defineProperty;