goods-exporter 0.5.2 → 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/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[]>;