goods-exporter 0.2.5 → 0.2.7

package/README.md

@@ -20,6 +20,9 @@ export tasks with ease.
 - YML (Yandex Market Language)
 - CSV
 - Excel
+- TgShop
+- Insales
+- Tilda
 
 ## Installation
 
@@ -31,35 +34,46 @@ npm install goods-exporter --save
 yarn add goods-exporter
 ```
 
-## Usage
+## Quick start
+
+```typescript
+import { GoodsExporter, Product, Category, YMLFormatter } 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 {GoodsExporter, Formatters, Transformer, Category, Currency, Product, Vat} from "goods-exporter";
 import fs from "fs"; // Import the 'fs' module for file writing.
 
 // Create an instance of the GoodsExporter class.
-const exporter = new GoodsExporter();
+const exporter = new GoodsExporter()
 
 // Define an object 'transformers' that contains data transformation functions.
-const transformers: Record<string, Transformer> = {
-    PRICE: (product) => ({
+const transformers: Transformer[] = [
+    (product) => ({
         ...product,
         price: product.price + 10000
     }),
-    IMAGE: (product) => ({
+    (product) => ({
         ...product,
         images: product.images?.map(image => image.replace("image", "pic"))
     })
-}
-
-// Define an array 'keys' that contains the transformation keys you want to apply.
-const keys = ["PRICE"];
+]
 
 // Set the formatter for exporting data to YML.
-exporter.setFormatter(Formatters.YML);
+exporter.setFormatter(new YMLFormatter()) // or your own Formatter;
 
 // Set transformers based on the specified keys.
-exporter.setTransformers(keys.map(key => transformers[key]));
+exporter.setTransformers(transformers);
 
 // Set an exporter that saves the data to the "output.yml" file.
 exporter.setExporter((data: Buffer) => {

package/package.json

@@ -11,7 +11,7 @@
     "url": "https://github.com/Bagi4-source/goods-converter/issues"
   },
   "name": "goods-exporter",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "A versatile JavaScript library for exporting goods data to various formats such as YML, CSV, and Excel. Simplify data export tasks with ease.",
   "main": "./dist/cjs/index.cjs",
   "exports": {
@@ -49,7 +49,8 @@
   "dependencies": {
     "deepcopy": "^2.1.0",
     "fast-xml-parser": "^4.3.2",
-    "json-2-csv": "^5.0.1"
+    "json-2-csv": "^5.0.1",
+    "xlsx": "^0.18.5"
   },
   "devDependencies": {
     "@rollup/plugin-multi-entry": "^6.0.1",