goods-exporter 0.5.3 → 0.5.5

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,102 +1,103 @@
-# 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
-- 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';
-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
+
+## 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/cjs/index.cjs

@@ -4,15 +4,11 @@ var stream$3 = require('stream');
 var pkg = require('exceljs');
 var jsonStreamStringify = require('json-stream-stringify');
 var fastXmlParser = require('fast-xml-parser');
-var xml = require('xml');
 var fs = require('fs');
 
 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);
-  return value;
-};
+var __publicField$9 = (obj, key, value) => __defNormalProp$9(obj, typeof key !== "symbol" ? key + "" : key, value);
 class CSVStream {
   constructor({ delimiter, lineSeparator, emptyFieldValue }) {
     __publicField$9(this, "stream", new stream$3.PassThrough());
@@ -20,12 +16,9 @@ class CSVStream {
     __publicField$9(this, "lineSeparator", "\n");
     __publicField$9(this, "emptyFieldValue", "");
     __publicField$9(this, "columns", /* @__PURE__ */ new Set());
-    if (delimiter !== void 0)
-      this.delimiter = delimiter;
-    if (lineSeparator !== void 0)
-      this.lineSeparator = lineSeparator;
-    if (emptyFieldValue !== void 0)
-      this.emptyFieldValue = emptyFieldValue;
+    if (delimiter !== void 0) this.delimiter = delimiter;
+    if (lineSeparator !== void 0) this.lineSeparator = lineSeparator;
+    if (emptyFieldValue !== void 0) this.emptyFieldValue = emptyFieldValue;
   }
   getWritableStream() {
     return this.stream;
@@ -57,10 +50,7 @@ var Extension = /* @__PURE__ */ ((Extension2) => {
 
 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);
-  return value;
-};
+var __publicField$8 = (obj, key, value) => __defNormalProp$8(obj, typeof key !== "symbol" ? key + "" : key, value);
 class CSVFormatter {
   constructor() {
     __publicField$8(this, "formatterName", "CSV");
@@ -102,8 +92,7 @@ class CSVFormatter {
     ]);
     products.forEach((product) => {
       Object.entries(product).forEach(([key, value]) => {
-        if (value)
-          columns.add(key);
+        if (value) columns.add(key);
       });
     });
     csvStream.setColumns(columns);
@@ -123,16 +112,14 @@ class CSVFormatter {
       };
       csvStream.addRow(row);
     });
+    csvStream.getWritableStream().end();
     return csvStream.getWritableStream();
   }
 }
 
 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);
-  return value;
-};
+var __publicField$7 = (obj, key, value) => __defNormalProp$7(obj, typeof key !== "symbol" ? key + "" : key, value);
 const { stream: stream$2 } = pkg;
 class ExcelFormatter {
   constructor() {
@@ -170,11 +157,13 @@ class ExcelFormatter {
     ]);
     products.forEach((product) => {
       Object.entries(product).forEach(([key, value]) => {
-        if (value)
-          columns.add(key);
+        if (value) columns.add(key);
       });
     });
-    const workbook = new stream$2.xlsx.WorkbookWriter({});
+    const passThroughStream = new stream$3.PassThrough();
+    const workbook = new stream$2.xlsx.WorkbookWriter({
+      stream: passThroughStream
+    });
     const worksheet = workbook.addWorksheet("products");
     worksheet.columns = Array.from(columns).map((column) => ({
       key: column,
@@ -198,16 +187,14 @@ class ExcelFormatter {
     });
     worksheet.commit();
     await workbook.commit();
-    return workbook.stream;
+    passThroughStream.end();
+    return passThroughStream;
   }
 }
 
 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);
-  return value;
-};
+var __publicField$6 = (obj, key, value) => __defNormalProp$6(obj, typeof key !== "symbol" ? key + "" : key, value);
 const { stream: stream$1 } = pkg;
 class InsalesFormatter {
   constructor() {
@@ -237,8 +224,7 @@ class InsalesFormatter {
       const categories2 = {};
       const categoryList = new Array();
       function addCategory(categoryId) {
-        if (categoryId === void 0)
-          return;
+        if (categoryId === void 0) return;
         const category = mappedCategories[categoryId];
         if (category) {
           categoryList.push(category.name);
@@ -253,7 +239,10 @@ class InsalesFormatter {
       });
       return categories2;
     };
-    const workbook = new stream$1.xlsx.WorkbookWriter({});
+    const passThroughStream = new stream$3.PassThrough();
+    const workbook = new stream$1.xlsx.WorkbookWriter({
+      stream: passThroughStream
+    });
     const worksheet = workbook.addWorksheet("products");
     const columns = /* @__PURE__ */ new Set([
       "\u0412\u043D\u0435\u0448\u043D\u0438\u0439 ID",
@@ -337,16 +326,14 @@ class InsalesFormatter {
     });
     worksheet.commit();
     await workbook.commit();
-    return workbook.stream;
+    passThroughStream.end();
+    return passThroughStream;
   }
 }
 
 var __defProp$5 = Object.defineProperty;
 var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$5 = (obj, key, value) => {
-  __defNormalProp$5(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
+var __publicField$5 = (obj, key, value) => __defNormalProp$5(obj, typeof key !== "symbol" ? key + "" : key, value);
 class JSONFormatter {
   constructor() {
     __publicField$5(this, "formatterName", "JSON");
@@ -363,10 +350,7 @@ class JSONFormatter {
 
 var __defProp$4 = Object.defineProperty;
 var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$4 = (obj, key, value) => {
-  __defNormalProp$4(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
+var __publicField$4 = (obj, key, value) => __defNormalProp$4(obj, typeof key !== "symbol" ? key + "" : key, value);
 class SimpleJSONFormatter {
   constructor() {
     __publicField$4(this, "formatterName", "JSON");
@@ -375,19 +359,16 @@ class SimpleJSONFormatter {
   async format(products, categories, brands, _) {
     const groupedProduct = /* @__PURE__ */ new Map();
     products.forEach((product) => {
-      if (product.parentId !== void 0)
-        return;
+      if (product.parentId !== void 0) return;
       groupedProduct.set(product.variantId, {
         ...product,
         children: []
       });
     });
     products.forEach((product) => {
-      if (product.parentId === void 0)
-        return;
+      if (product.parentId === void 0) return;
       const parent = groupedProduct.get(product.parentId);
-      if (!parent)
-        return;
+      if (!parent) return;
       parent.children.push(product);
     });
     return new jsonStreamStringify.JsonStreamStringify({
@@ -400,10 +381,7 @@ class SimpleJSONFormatter {
 
 var __defProp$3 = Object.defineProperty;
 var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$3 = (obj, key, value) => {
-  __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
+var __publicField$3 = (obj, key, value) => __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
 const { stream } = pkg;
 class TgShopFormatter {
   constructor() {
@@ -428,7 +406,10 @@ class TgShopFormatter {
       size: getParameter(product, "size")?.value,
       priority: void 0
     });
-    const workbook = new stream.xlsx.WorkbookWriter({});
+    const passThroughStream = new stream$3.PassThrough();
+    const workbook = new stream.xlsx.WorkbookWriter({
+      stream: passThroughStream
+    });
     const categoryWorksheet = workbook.addWorksheet("categories");
     const productsWorksheet = workbook.addWorksheet("offers");
     categoryWorksheet.columns = [
@@ -474,16 +455,13 @@ class TgShopFormatter {
     categoryWorksheet.commit();
     productsWorksheet.commit();
     await workbook.commit();
-    return workbook.stream;
+    return passThroughStream;
   }
 }
 
 var __defProp$2 = Object.defineProperty;
 var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$2 = (obj, key, value) => {
-  __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
+var __publicField$2 = (obj, key, value) => __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
 class TildaFormatter {
   constructor() {
     __publicField$2(this, "formatterName", "Tilda");
@@ -529,16 +507,14 @@ class TildaFormatter {
       };
       csvStream.addRow(row);
     });
+    csvStream.getWritableStream().end();
     return csvStream.getWritableStream();
   }
 }
 
 var __defProp$1 = Object.defineProperty;
 var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$1 = (obj, key, value) => {
-  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
+var __publicField$1 = (obj, key, value) => __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
 class YMLFormatter {
   constructor() {
     __publicField$1(this, "formatterName", "YMl");
@@ -548,53 +524,67 @@ class YMLFormatter {
     const result = new stream$3.PassThrough();
     const builder = new fastXmlParser.XMLBuilder({
       ignoreAttributes: false,
-      cdataPropName: "__cdata"
+      cdataPropName: "__cdata",
+      format: true,
+      indentBy: "  "
     });
-    const ymlCatalog = xml.element({
-      _attr: { date: (/* @__PURE__ */ new Date()).toISOString().replace(/.\d+Z/, "") }
-    });
-    const stream = xml(
-      { yml_catalog: ymlCatalog },
-      {
-        stream: true,
-        declaration: { standalone: "yes", encoding: "UTF-8" }
-      }
-    );
-    stream.pipe(result, { end: false });
-    const shop = xml.element();
-    const streamShop = xml({ shop }, { stream: true });
-    shop.push({ name: options?.shopName });
-    shop.push({ company: options?.companyName });
-    shop.push({ categories: this.getCategories(categories) });
-    shop.push({ brands: this.getBrands(brands) });
-    streamShop.pipe(result, { end: false });
-    const offers = xml.element();
-    const streamOffersTag = xml({ offers }, { stream: true });
-    streamOffersTag.pipe(result, { end: false });
-    const streamOffers = new stream$3.PassThrough();
+    const date = (/* @__PURE__ */ new Date()).toISOString().replace(/.\d+Z/, "");
+    result.write('<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n');
+    result.write('<yml_catalog date="' + date + '">\n');
+    result.write("<shop>\n");
+    if (options?.shopName) {
+      result.write(builder.build({ name: options.shopName }));
+      result.write("\n");
+    }
+    if (options?.companyName) {
+      result.write(builder.build({ company: options.companyName }));
+      result.write("\n");
+    }
+    if (categories) {
+      result.write(
+        builder.build({
+          // tagname: "categories",
+          categories: { category: this.getCategories(categories) }
+        })
+      );
+      result.write("\n");
+    }
+    if (brands) {
+      result.write(
+        builder.build({ brands: { brand: this.getBrands(brands) } })
+      );
+      result.write("\n");
+    }
+    result.write("<offers>\n");
+    const offerStream = new stream$3.PassThrough();
+    offerStream.pipe(result, { end: false });
     products.forEach((product) => {
-      streamOffers.write(builder.build({ offer: this.getOffer(product) }));
+      const offer = builder.build({ offer: this.getOffer(product) });
+      offerStream.write(offer + "\n");
+    });
+    offerStream.end();
+    offerStream.on("end", () => {
+      result.write("</offers>\n");
+      result.write("</shop>\n");
+      result.write("</yml_catalog>\n");
+      result.end();
     });
-    streamOffers.pipe(result, { end: false });
-    offers.close();
-    shop.close();
-    ymlCatalog.close();
     return result;
   }
   getBrands(brands) {
-    return brands?.map((brand) => ({
-      brand: [
-        { _attr: { id: brand.id, url: brand.coverURL ?? "" } },
-        brand.name
-      ]
+    if (!brands) return [];
+    return brands.map((brand) => ({
+      "@_id": brand.id,
+      "@_url": brand.coverURL ?? "",
+      "#text": brand.name
     }));
   }
   getCategories(categories) {
-    return categories?.map((cat) => ({
-      category: [
-        { _attr: { id: cat.id, parentId: cat.parentId ?? "" } },
-        cat.name
-      ]
+    if (!categories) return [];
+    return categories.map((cat) => ({
+      "@_id": cat.id,
+      "@_parentId": cat.parentId ?? "",
+      "#text": cat.name
     }));
   }
   getOffer(product) {
@@ -688,10 +678,7 @@ const Formatters = {
 
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 class GoodsExporter {
   constructor() {
     __publicField(this, "formatter", new Formatters.YMLFormatter());