goods-exporter 0.4.7 → 0.5.2

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

@@ -1,3 +1,5 @@
+import { Stream, Writable } from 'stream';
+
 interface Product {
     /**
      * **ID товара**
@@ -582,7 +584,7 @@ interface Brand {
 declare abstract class FormatterAbstract {
     abstract formatterName: string;
     abstract fileExtension: Extension;
-    abstract format(products: Product[], categories?: Category[], brands?: Brand[], option?: FormatterOptions): Promise<Buffer | string>;
+    abstract format(products: Product[], categories?: Category[], brands?: Brand[], option?: FormatterOptions): Promise<Stream>;
 }
 interface FormatterOptions {
     shopName?: string;
@@ -599,44 +601,43 @@ declare enum Extension {
 declare class CSVFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
-    format(products: Product[], categories?: Category[], _?: Brand[], options?: FormatterOptions): Promise<string>;
+    format(products: Product[], categories?: Category[], _?: Brand[], __?: FormatterOptions): Promise<Stream>;
 }
 
 declare class ExcelFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
-    format(products: Product[], categories?: Category[], _?: Brand[], options?: FormatterOptions): Promise<Buffer>;
+    format(products: Product[], categories?: Category[], _?: Brand[], __?: FormatterOptions): Promise<Stream>;
 }
 
 declare class InsalesFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
-    format(products: Product[], categories?: Category[], _?: Brand[], __?: FormatterOptions): Promise<Buffer>;
+    format(products: Product[], categories?: Category[], _?: Brand[], __?: FormatterOptions): Promise<Stream>;
 }
 
 declare class JSONFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
-    format(products: Product[], categories?: Category[], brands?: Brand[], _?: FormatterOptions): Promise<string>;
+    format(products: Product[], categories?: Category[], brands?: Brand[], _?: FormatterOptions): Promise<Stream>;
 }
 
 declare class TgShopFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
-    format(products: Product[], categories?: Category[], _?: Brand[], __?: FormatterOptions): Promise<Buffer>;
+    format(products: Product[], categories?: Category[], _?: Brand[], __?: FormatterOptions): Promise<Stream>;
 }
 
 declare class TildaFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
-    format(products: Product[], categories?: Category[], _?: Brand[], __?: FormatterOptions): Promise<string>;
+    format(products: Product[], categories?: Category[], _?: Brand[], __?: FormatterOptions): Promise<Stream>;
 }
 
 declare class YMLFormatter implements FormatterAbstract {
     formatterName: string;
     fileExtension: Extension;
-    private readonly builder;
-    format(products: Product[], categories?: Category[], brands?: Brand[], options?: FormatterOptions): Promise<string>;
+    format(products: Product[], categories?: Category[], brands?: Brand[], options?: FormatterOptions): Promise<Stream>;
     private getBrands;
     private getCategories;
     private getOffers;
@@ -653,7 +654,7 @@ declare const Formatters: {
 };
 
 type Transformer = (products: Product[]) => Product[] | Promise<Product[]>;
-type Exporter = (data: Buffer) => Buffer | Promise<Buffer>;
+type Exporter = () => Writable;
 
 declare class GoodsExporter {
     private formatter;
@@ -662,7 +663,7 @@ declare class GoodsExporter {
     setTransformers(transformers: Transformer[]): void;
     setFormatter(formatter: FormatterAbstract): void;
     setExporter(exporter: Exporter): void;
-    export(products: Product[], categories?: Category[], brands?: Brand[], option?: FormatterOptions): Promise<Buffer>;
+    export(products: Product[], categories?: Category[], brands?: Brand[], option?: FormatterOptions): Promise<void>;
 }
 
 export { type Brand, type Category, Currency, type Exporter, Extension, FormatterAbstract, type FormatterOptions, Formatters, GoodsExporter, type IParam, type ISize, type Product, type Transformer, Vat };