goods-exporter 0.5.1 → 0.5.3

package/README.md

@@ -17,6 +17,7 @@ export tasks with ease.
 - Easily integrate into your JavaScript projects.
 - Compatible with Node.js version 16 and above.
 - Comprehensive TypeScript type definitions included.
+- Supports streams.
 
 ## Supported formats
 
@@ -41,7 +42,8 @@ yarn add goods-exporter
 ## Quick start
 
 ```typescript
-import { GoodsExporter, Product, Category, Formatters } from '../src'
+import { GoodsExporter, Product, Category, Formatters } from '../src';
+import { PassThrough } from "stream";
 
 // Create an instance of the GoodsExporter class.
 const exporter = new GoodsExporter()
@@ -50,7 +52,19 @@ const products: Product[] = [] // Put your products;
 const categories: Category[] = [{ id: 1, name: 'Обувь' }]
 
 // Call the data export method.
-exporter.export(products, categories)
+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
@@ -80,16 +94,8 @@ exporter.setFormatter(new Formatters.YMLFormatter()) // or your own Formatter;
 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.
-    });
+exporter.setExporter(fs.createWriteStream("output.yml"));
+await exporter.export(products, categories);
 ```
 
 # Supported by [PoizonAPI](https://t.me/PoizonAPI) 

package/dist/bundle.d.ts

@@ -87,6 +87,12 @@ interface Product {
      * Пример: 01.01.2000
      */
     saleDate?: string;
+    /**
+     * **Вендор в магазине**
+     *
+     * Содержит номер вендора, а не ее название.
+     */
+    vendorId?: number;
     /**
      * **Категория в магазине**
      *
@@ -622,6 +628,12 @@ declare class JSONFormatter implements FormatterAbstract {
     format(products: Product[], categories?: Category[], brands?: Brand[], _?: FormatterOptions): Promise<Stream>;
 }
 
+declare class SimpleJSONFormatter implements FormatterAbstract {
+    formatterName: string;
+    fileExtension: Extension;
+    format(products: Product[], categories?: Category[], brands?: Brand[], _?: FormatterOptions): Promise<Stream>;
+}
+
 declare class TgShopFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
@@ -640,7 +652,7 @@ declare class YMLFormatter implements FormatterAbstract {
     format(products: Product[], categories?: Category[], brands?: Brand[], options?: FormatterOptions): Promise<Stream>;
     private getBrands;
     private getCategories;
-    private getOffers;
+    private getOffer;
 }
 
 declare const Formatters: {
@@ -651,6 +663,7 @@ declare const Formatters: {
     TgShopFormatter: typeof TgShopFormatter;
     ExcelFormatter: typeof ExcelFormatter;
     JSONFormatter: typeof JSONFormatter;
+    SimpleJSONFormatter: typeof SimpleJSONFormatter;
 };
 
 type Transformer = (products: Product[]) => Product[] | Promise<Product[]>;

package/dist/cjs/index.cjs

@@ -1,25 +1,25 @@
 'use strict';
 
-var stream = require('stream');
-var exceljs = require('exceljs');
+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$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);
   return value;
 };
 class CSVStream {
   constructor({ delimiter, lineSeparator, emptyFieldValue }) {
-    __publicField$8(this, "stream", new stream.PassThrough());
-    __publicField$8(this, "delimiter", ";");
-    __publicField$8(this, "lineSeparator", "\n");
-    __publicField$8(this, "emptyFieldValue", "");
-    __publicField$8(this, "columns", /* @__PURE__ */ new Set());
+    __publicField$9(this, "stream", new stream$3.PassThrough());
+    __publicField$9(this, "delimiter", ";");
+    __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)
@@ -55,16 +55,16 @@ var Extension = /* @__PURE__ */ ((Extension2) => {
   return Extension2;
 })(Extension || {});
 
-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);
   return value;
 };
 class CSVFormatter {
   constructor() {
-    __publicField$7(this, "formatterName", "CSV");
-    __publicField$7(this, "fileExtension", Extension.CSV);
+    __publicField$8(this, "formatterName", "CSV");
+    __publicField$8(this, "fileExtension", Extension.CSV);
   }
   async format(products, categories, _, __) {
     const mappedCategories = {};
@@ -127,16 +127,17 @@ class CSVFormatter {
   }
 }
 
-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);
+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;
 };
+const { stream: stream$2 } = pkg;
 class ExcelFormatter {
   constructor() {
-    __publicField$6(this, "formatterName", "Excel");
-    __publicField$6(this, "fileExtension", Extension.XLSX);
+    __publicField$7(this, "formatterName", "Excel");
+    __publicField$7(this, "fileExtension", Extension.XLSX);
   }
   async format(products, categories, _, __) {
     const mappedCategories = {};
@@ -173,7 +174,7 @@ class ExcelFormatter {
           columns.add(key);
       });
     });
-    const workbook = new exceljs.stream.xlsx.WorkbookWriter({});
+    const workbook = new stream$2.xlsx.WorkbookWriter({});
     const worksheet = workbook.addWorksheet("products");
     worksheet.columns = Array.from(columns).map((column) => ({
       key: column,
@@ -201,16 +202,17 @@ class ExcelFormatter {
   }
 }
 
-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);
+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;
 };
+const { stream: stream$1 } = pkg;
 class InsalesFormatter {
   constructor() {
-    __publicField$5(this, "formatterName", "Insales");
-    __publicField$5(this, "fileExtension", Extension.XLSX);
+    __publicField$6(this, "formatterName", "Insales");
+    __publicField$6(this, "fileExtension", Extension.XLSX);
   }
   async format(products, categories, _, __) {
     const mappedCategories = {};
@@ -251,7 +253,7 @@ class InsalesFormatter {
       });
       return categories2;
     };
-    const workbook = new exceljs.stream.xlsx.WorkbookWriter({});
+    const workbook = new stream$1.xlsx.WorkbookWriter({});
     const worksheet = workbook.addWorksheet("products");
     const columns = /* @__PURE__ */ new Set([
       "\u0412\u043D\u0435\u0448\u043D\u0438\u0439 ID",
@@ -339,22 +341,59 @@ class InsalesFormatter {
   }
 }
 
+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;
+};
+class JSONFormatter {
+  constructor() {
+    __publicField$5(this, "formatterName", "JSON");
+    __publicField$5(this, "fileExtension", Extension.JSON);
+  }
+  async format(products, categories, brands, _) {
+    return new jsonStreamStringify.JsonStreamStringify({
+      categories,
+      brands,
+      products
+    });
+  }
+}
+
 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;
 };
-class JSONFormatter {
+class SimpleJSONFormatter {
   constructor() {
     __publicField$4(this, "formatterName", "JSON");
     __publicField$4(this, "fileExtension", Extension.JSON);
   }
   async format(products, categories, brands, _) {
+    const groupedProduct = /* @__PURE__ */ new Map();
+    products.forEach((product) => {
+      if (product.parentId !== void 0)
+        return;
+      groupedProduct.set(product.variantId, {
+        ...product,
+        children: []
+      });
+    });
+    products.forEach((product) => {
+      if (product.parentId === void 0)
+        return;
+      const parent = groupedProduct.get(product.parentId);
+      if (!parent)
+        return;
+      parent.children.push(product);
+    });
     return new jsonStreamStringify.JsonStreamStringify({
       categories,
       brands,
-      products
+      products: Array.from(groupedProduct.values())
     });
   }
 }
@@ -365,6 +404,7 @@ var __publicField$3 = (obj, key, value) => {
   __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
+const { stream } = pkg;
 class TgShopFormatter {
   constructor() {
     __publicField$3(this, "formatterName", "TgShop");
@@ -388,7 +428,7 @@ class TgShopFormatter {
       size: getParameter(product, "size")?.value,
       priority: void 0
     });
-    const workbook = new exceljs.stream.xlsx.WorkbookWriter({});
+    const workbook = new stream.xlsx.WorkbookWriter({});
     const categoryWorksheet = workbook.addWorksheet("categories");
     const productsWorksheet = workbook.addWorksheet("offers");
     categoryWorksheet.columns = [
@@ -505,7 +545,7 @@ class YMLFormatter {
     __publicField$1(this, "fileExtension", Extension.YML);
   }
   async format(products, categories, brands, options) {
-    const result = new stream.PassThrough();
+    const result = new stream$3.PassThrough();
     const builder = new fastXmlParser.XMLBuilder({
       ignoreAttributes: false,
       cdataPropName: "__cdata"
@@ -513,13 +553,14 @@ class YMLFormatter {
     const ymlCatalog = xml.element({
       _attr: { date: (/* @__PURE__ */ new Date()).toISOString().replace(/.\d+Z/, "") }
     });
-    const stream$1 = xml(
+    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 });
@@ -528,12 +569,13 @@ class YMLFormatter {
     shop.push({ brands: this.getBrands(brands) });
     streamShop.pipe(result, { end: false });
     const offers = xml.element();
-    const streamOffers = xml({ offers }, { stream: true });
-    streamOffers.pipe(result, { end: false });
+    const streamOffersTag = xml({ offers }, { stream: true });
+    streamOffersTag.pipe(result, { end: false });
+    const streamOffers = new stream$3.PassThrough();
     products.forEach((product) => {
-      result.write(builder.build({ offer: this.getOffers(product) }));
+      streamOffers.write(builder.build({ offer: this.getOffer(product) }));
     });
-    stream$1.pipe(result, { end: false });
+    streamOffers.pipe(result, { end: false });
     offers.close();
     shop.close();
     ymlCatalog.close();
@@ -555,7 +597,7 @@ class YMLFormatter {
       ]
     }));
   }
-  getOffers(product) {
+  getOffer(product) {
     const result = {
       "@_id": product.variantId,
       name: product.title,
@@ -566,6 +608,7 @@ class YMLFormatter {
       cofinance_price: product.cofinancePrice,
       currencyId: product.currency,
       categoryId: product.categoryId,
+      vendorId: product.vendorId,
       vendor: product.vendor,
       vendorCode: product.vendorCode,
       picture: product.images,
@@ -639,7 +682,8 @@ const Formatters = {
   YMLFormatter,
   TgShopFormatter,
   ExcelFormatter,
-  JSONFormatter
+  JSONFormatter,
+  SimpleJSONFormatter
 };
 
 var __defProp = Object.defineProperty;