@lssm/lib.exporter 1.7.4 → 1.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -0
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# @lssm/lib.exporter
|
|
2
|
+
|
|
3
|
+
Platform-agnostic utilities for exporting data to CSV and XML formats.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
To provide a lightweight, dependency-free way to generate CSV and XML files on both the server (Node.js/Bun) and client (Browser/React Native).
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @lssm/lib.exporter
|
|
13
|
+
# or
|
|
14
|
+
bun add @lssm/lib.exporter
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Key Concepts
|
|
18
|
+
|
|
19
|
+
- **Universal**: Works in any JS environment.
|
|
20
|
+
- **Streaming-friendly**: Designed to handle data chunks (conceptually), though current implementation might be synchronous.
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
import { toCSV, toXML } from '@lssm/lib.exporter';
|
|
26
|
+
|
|
27
|
+
const data = [
|
|
28
|
+
{ id: 1, name: 'Alice' },
|
|
29
|
+
{ id: 2, name: 'Bob' },
|
|
30
|
+
];
|
|
31
|
+
|
|
32
|
+
// Generate CSV string
|
|
33
|
+
const csv = toCSV(data);
|
|
34
|
+
|
|
35
|
+
// Generate XML string
|
|
36
|
+
const xml = toXML(data, { rootName: 'Users', itemName: 'User' });
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":["lines: string[]"],"sources":["../src/index.ts"],"sourcesContent":["export interface CsvXmlExportItem {\n id?: string;\n name: string;\n qty: number;\n unitPrice?: number;\n currency?: string;\n [key: string]: unknown;\n}\n\nexport type CsvXmlExportMeta = Record<\n string,\n string | number | boolean | null | undefined\n>;\n\nexport interface CsvXmlExportPayload<\n TMeta extends CsvXmlExportMeta = CsvXmlExportMeta,\n> {\n meta: TMeta;\n items: CsvXmlExportItem[];\n}\n\nexport function toCsvGeneric<TMeta extends CsvXmlExportMeta>(\n payload: CsvXmlExportPayload<TMeta>,\n options?: { metaColumns?: string[]; itemColumns?: string[] }\n): string {\n const metaCols = options?.metaColumns ?? Object.keys(payload.meta);\n const itemCols = options?.itemColumns ?? [\n 'id',\n 'name',\n 'qty',\n 'unitPrice',\n 'currency',\n ];\n const header = [...metaCols, ...itemCols];\n const lines: string[] = [];\n lines.push(header.join(','));\n for (const it of payload.items) {\n const row = [\n ...metaCols.map((k) => escapeCsv(String(payload.meta[k] ?? ''))),\n ...itemCols.map((k) => escapeCsv(String(
|
|
1
|
+
{"version":3,"file":"index.js","names":["lines: string[]"],"sources":["../src/index.ts"],"sourcesContent":["export interface CsvXmlExportItem {\n id?: string;\n name: string;\n qty: number;\n unitPrice?: number;\n currency?: string;\n [key: string]: unknown;\n}\n\nexport type CsvXmlExportMeta = Record<\n string,\n string | number | boolean | null | undefined\n>;\n\nexport interface CsvXmlExportPayload<\n TMeta extends CsvXmlExportMeta = CsvXmlExportMeta,\n> {\n meta: TMeta;\n items: CsvXmlExportItem[];\n}\n\nexport function toCsvGeneric<TMeta extends CsvXmlExportMeta>(\n payload: CsvXmlExportPayload<TMeta>,\n options?: { metaColumns?: string[]; itemColumns?: string[] }\n): string {\n const metaCols = options?.metaColumns ?? Object.keys(payload.meta);\n const itemCols = options?.itemColumns ?? [\n 'id',\n 'name',\n 'qty',\n 'unitPrice',\n 'currency',\n ];\n const header = [...metaCols, ...itemCols];\n const lines: string[] = [];\n lines.push(header.join(','));\n for (const it of payload.items) {\n const row = [\n ...metaCols.map((k) => escapeCsv(String(payload.meta[k] ?? ''))),\n ...itemCols.map((k) => escapeCsv(String(it[k] ?? ''))),\n ];\n lines.push(row.join(','));\n }\n return lines.join('\\n');\n}\n\nexport function toXmlGeneric<TMeta extends CsvXmlExportMeta>(\n payload: CsvXmlExportPayload<TMeta>,\n options?: { root?: string; itemTag?: string }\n): string {\n const root = options?.root ?? 'export';\n const itemTag = options?.itemTag ?? 'item';\n const metaEntries = Object.entries(payload.meta)\n .map(([k, v]) => ` <${k}>${xml(String(v ?? ''))}</${k}>`)\n .join('\\n');\n const items = payload.items\n .map((it) => {\n const attrs = it.id ? ` id=\"${xml(String(it.id))}\"` : '';\n const fields = Object.entries(it)\n .filter(([k]) => k !== 'id')\n .map(([k, v]) => ` <${k}>${xml(String(v ?? ''))}</${k}>`)\n .join('\\n');\n return ` <${itemTag}${attrs}>\\n${fields}\\n </${itemTag}>`;\n })\n .join('\\n');\n return `<?xml version=\"1.0\" encoding=\"UTF-8\"?>\\n<${root}>\\n <meta>\\n${metaEntries}\\n </meta>\\n <items>\\n${items}\\n </items>\\n</${root}>`;\n}\n\nfunction escapeCsv(val: string): string {\n if (val.includes(',') || val.includes('\"') || val.includes('\\n')) {\n return '\"' + val.replace(/\"/g, '\"\"') + '\"';\n }\n return val;\n}\n\nfunction xml(val: string): string {\n return val\n .replace(/&/g, '&')\n .replace(/</g, '<')\n .replace(/>/g, '>')\n .replace(/\"/g, '"')\n .replace(/'/g, ''');\n}\n"],"mappings":"AAqBA,SAAgB,EACd,EACA,EACQ,CACR,IAAM,EAAW,GAAS,aAAe,OAAO,KAAK,EAAQ,KAAK,CAC5D,EAAW,GAAS,aAAe,CACvC,KACA,OACA,MACA,YACA,WACD,CACK,EAAS,CAAC,GAAG,EAAU,GAAG,EAAS,CACnCA,EAAkB,EAAE,CAC1B,EAAM,KAAK,EAAO,KAAK,IAAI,CAAC,CAC5B,IAAK,IAAM,KAAM,EAAQ,MAAO,CAC9B,IAAM,EAAM,CACV,GAAG,EAAS,IAAK,GAAM,EAAU,OAAO,EAAQ,KAAK,IAAM,GAAG,CAAC,CAAC,CAChE,GAAG,EAAS,IAAK,GAAM,EAAU,OAAO,EAAG,IAAM,GAAG,CAAC,CAAC,CACvD,CACD,EAAM,KAAK,EAAI,KAAK,IAAI,CAAC,CAE3B,OAAO,EAAM,KAAK;EAAK,CAGzB,SAAgB,EACd,EACA,EACQ,CACR,IAAM,EAAO,GAAS,MAAQ,SACxB,EAAU,GAAS,SAAW,OAcpC,MAAO,4CAA4C,EAAK,eAbpC,OAAO,QAAQ,EAAQ,KAAK,CAC7C,KAAK,CAAC,EAAG,KAAO,QAAQ,EAAE,GAAG,EAAI,OAAO,GAAK,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,CAC3D,KAAK;EAAK,CAWsE,0BAVrE,EAAQ,MACnB,IAAK,GAMG,MAAM,IALC,EAAG,GAAK,QAAQ,EAAI,OAAO,EAAG,GAAG,CAAC,CAAC,GAAK,GAKzB,KAJd,OAAO,QAAQ,EAAG,CAC9B,QAAQ,CAAC,KAAO,IAAM,KAAK,CAC3B,KAAK,CAAC,EAAG,KAAO,QAAQ,EAAE,GAAG,EAAI,OAAO,GAAK,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,CAC3D,KAAK;EAAK,CAC4B,QAAQ,EAAQ,GACzD,CACD,KAAK;EAAK,CACsG,kBAAkB,EAAK,GAG5I,SAAS,EAAU,EAAqB,CAItC,OAHI,EAAI,SAAS,IAAI,EAAI,EAAI,SAAS,IAAI,EAAI,EAAI,SAAS;EAAK,CACvD,IAAM,EAAI,QAAQ,KAAM,KAAK,CAAG,IAElC,EAGT,SAAS,EAAI,EAAqB,CAChC,OAAO,EACJ,QAAQ,KAAM,QAAQ,CACtB,QAAQ,KAAM,OAAO,CACrB,QAAQ,KAAM,OAAO,CACrB,QAAQ,KAAM,SAAS,CACvB,QAAQ,KAAM,SAAS"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lssm/lib.exporter",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.9.1",
|
|
4
4
|
"description": "Generic CSV and XML exporters usable across web and mobile.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"scripts": {
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
17
|
"@lssm/tool.typescript": "*",
|
|
18
|
-
"tsdown": "^0.
|
|
18
|
+
"tsdown": "^0.16.6",
|
|
19
19
|
"typescript": "^5.9.3"
|
|
20
20
|
},
|
|
21
21
|
"main": "./dist/index.js",
|