@flyingrobots/bijou-i18n-tools-xlsx 4.1.0
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/LICENSE +17 -0
- package/README.md +15 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/xlsx.d.ts +4 -0
- package/dist/xlsx.d.ts.map +1 -0
- package/dist/xlsx.js +105 -0
- package/dist/xlsx.js.map +1 -0
- package/package.json +59 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
Copyright 2026 James Ross
|
|
6
|
+
|
|
7
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
8
|
+
you may not use this file except in compliance with the License.
|
|
9
|
+
You may obtain a copy of the License at
|
|
10
|
+
|
|
11
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
+
|
|
13
|
+
Unless required by applicable law or agreed to in writing, software
|
|
14
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
15
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
16
|
+
See the License for the specific language governing permissions and
|
|
17
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# @flyingrobots/bijou-i18n-tools-xlsx
|
|
2
|
+
|
|
3
|
+
XLSX workbook adapters for Bijou localization exchange workflows.
|
|
4
|
+
|
|
5
|
+
`@flyingrobots/bijou-i18n-tools-xlsx` builds on `@flyingrobots/bijou-i18n-tools` and provides:
|
|
6
|
+
|
|
7
|
+
- `ExchangeWorkbook` -> XLSX byte serialization
|
|
8
|
+
- XLSX byte parsing back into `ExchangeWorkbook`
|
|
9
|
+
- explicit translation-workbook header validation
|
|
10
|
+
- deterministic workbook sheet ordering
|
|
11
|
+
|
|
12
|
+
This package intentionally keeps spreadsheet-provider logic out of the pure `@flyingrobots/bijou-i18n-tools` package.
|
|
13
|
+
|
|
14
|
+
Dependency note:
|
|
15
|
+
As of 2026-04-02, `xlsx` is installed from the official SheetJS CDN tarball rather than the npm registry release, which is stale and carries known security advisories. See https://docs.sheetjs.com/docs/getting-started/installation/nodejs/ for the current upstream installation guidance.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,6BAA6B,GAC9B,MAAM,WAAW,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,6BAA6B,GAC9B,MAAM,WAAW,CAAC"}
|
package/dist/xlsx.d.ts
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { ExchangeWorkbook } from '@flyingrobots/bijou-i18n-tools';
|
|
2
|
+
export declare function serializeExchangeWorkbookXlsx(workbook: ExchangeWorkbook): Uint8Array;
|
|
3
|
+
export declare function parseExchangeWorkbookXlsx(input: Uint8Array | ArrayBuffer): ExchangeWorkbook;
|
|
4
|
+
//# sourceMappingURL=xlsx.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"xlsx.d.ts","sourceRoot":"","sources":["../src/xlsx.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAA0B,MAAM,gCAAgC,CAAC;AA+D/F,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,gBAAgB,GAAG,UAAU,CAgBpF;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,UAAU,GAAG,WAAW,GAAG,gBAAgB,CA4C3F"}
|
package/dist/xlsx.js
ADDED
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import * as XLSX from 'xlsx';
|
|
2
|
+
const REQUIRED_TRANSLATION_COLUMNS = [
|
|
3
|
+
'namespace',
|
|
4
|
+
'id',
|
|
5
|
+
'kind',
|
|
6
|
+
'sourceLocale',
|
|
7
|
+
'targetLocale',
|
|
8
|
+
'status',
|
|
9
|
+
'sourceHash',
|
|
10
|
+
'description',
|
|
11
|
+
'sourceValueKind',
|
|
12
|
+
'sourceValue',
|
|
13
|
+
'translatedValueKind',
|
|
14
|
+
'translatedValue',
|
|
15
|
+
];
|
|
16
|
+
function normalizeCell(value) {
|
|
17
|
+
if (value === undefined || value === null) {
|
|
18
|
+
return '';
|
|
19
|
+
}
|
|
20
|
+
return String(value);
|
|
21
|
+
}
|
|
22
|
+
function toWorkbookInput(input) {
|
|
23
|
+
return input instanceof Uint8Array ? input : new Uint8Array(input);
|
|
24
|
+
}
|
|
25
|
+
function assertWorkbookHeaders(columns, sheetName) {
|
|
26
|
+
if (columns.length === 0) {
|
|
27
|
+
throw new Error(`Invalid XLSX workbook sheet: missing header row in ${sheetName}`);
|
|
28
|
+
}
|
|
29
|
+
const seen = new Set();
|
|
30
|
+
for (const [index, column] of columns.entries()) {
|
|
31
|
+
if (column.trim() === '') {
|
|
32
|
+
throw new Error(`Invalid XLSX workbook sheet: missing required header at column ${index + 1} in ${sheetName}`);
|
|
33
|
+
}
|
|
34
|
+
if (seen.has(column)) {
|
|
35
|
+
throw new Error(`Invalid XLSX workbook sheet: duplicate header ${column} in ${sheetName}`);
|
|
36
|
+
}
|
|
37
|
+
seen.add(column);
|
|
38
|
+
}
|
|
39
|
+
for (const required of REQUIRED_TRANSLATION_COLUMNS) {
|
|
40
|
+
if (!seen.has(required)) {
|
|
41
|
+
throw new Error(`Invalid XLSX workbook sheet: missing required header ${required} in ${sheetName}`);
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
function assertWorkbookRow(row, context) {
|
|
46
|
+
for (const key of REQUIRED_TRANSLATION_COLUMNS) {
|
|
47
|
+
if (typeof row[key] !== 'string') {
|
|
48
|
+
throw new Error(`Invalid XLSX workbook sheet: missing ${key} in ${context}`);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
return row;
|
|
52
|
+
}
|
|
53
|
+
export function serializeExchangeWorkbookXlsx(workbook) {
|
|
54
|
+
const book = XLSX.utils.book_new();
|
|
55
|
+
for (const sheet of workbook.sheets) {
|
|
56
|
+
const rows = [
|
|
57
|
+
[...sheet.columns],
|
|
58
|
+
...sheet.rows.map((row) => sheet.columns.map((column) => {
|
|
59
|
+
const value = row[column];
|
|
60
|
+
return typeof value === 'string' ? value : '';
|
|
61
|
+
})),
|
|
62
|
+
];
|
|
63
|
+
const worksheet = XLSX.utils.aoa_to_sheet(rows);
|
|
64
|
+
XLSX.utils.book_append_sheet(book, worksheet, sheet.name);
|
|
65
|
+
}
|
|
66
|
+
return new Uint8Array(XLSX.write(book, { bookType: 'xlsx', type: 'array' }));
|
|
67
|
+
}
|
|
68
|
+
export function parseExchangeWorkbookXlsx(input) {
|
|
69
|
+
const workbook = XLSX.read(toWorkbookInput(input), { type: 'array' });
|
|
70
|
+
const sheets = workbook.SheetNames.map((sheetName) => {
|
|
71
|
+
const worksheet = workbook.Sheets[sheetName];
|
|
72
|
+
if (worksheet === undefined) {
|
|
73
|
+
throw new Error(`Invalid XLSX workbook: missing sheet ${sheetName}`);
|
|
74
|
+
}
|
|
75
|
+
const matrix = XLSX.utils.sheet_to_json(worksheet, {
|
|
76
|
+
header: 1,
|
|
77
|
+
raw: false,
|
|
78
|
+
defval: '',
|
|
79
|
+
});
|
|
80
|
+
if (matrix.length === 0) {
|
|
81
|
+
throw new Error(`Invalid XLSX workbook sheet: missing header row in ${sheetName}`);
|
|
82
|
+
}
|
|
83
|
+
const header = matrix[0];
|
|
84
|
+
if (!Array.isArray(header)) {
|
|
85
|
+
throw new Error(`Invalid XLSX workbook sheet: malformed header row in ${sheetName}`);
|
|
86
|
+
}
|
|
87
|
+
const columns = header.map((value) => normalizeCell(value));
|
|
88
|
+
assertWorkbookHeaders(columns, sheetName);
|
|
89
|
+
const rows = matrix.slice(1).map((entry, rowIndex) => {
|
|
90
|
+
const cells = Array.isArray(entry) ? entry : [];
|
|
91
|
+
const record = Object.fromEntries(columns.map((column, index) => [column, normalizeCell(cells[index])]));
|
|
92
|
+
return assertWorkbookRow(record, `${sheetName}:${rowIndex + 2}`);
|
|
93
|
+
});
|
|
94
|
+
return {
|
|
95
|
+
name: sheetName,
|
|
96
|
+
columns,
|
|
97
|
+
rows,
|
|
98
|
+
};
|
|
99
|
+
});
|
|
100
|
+
return {
|
|
101
|
+
version: 1,
|
|
102
|
+
sheets,
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
//# sourceMappingURL=xlsx.js.map
|
package/dist/xlsx.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"xlsx.js","sourceRoot":"","sources":["../src/xlsx.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAG7B,MAAM,4BAA4B,GAAG;IACnC,WAAW;IACX,IAAI;IACJ,MAAM;IACN,cAAc;IACd,cAAc;IACd,QAAQ;IACR,YAAY;IACZ,aAAa;IACb,iBAAiB;IACjB,aAAa;IACb,qBAAqB;IACrB,iBAAiB;CACT,CAAC;AAEX,SAAS,aAAa,CAAC,KAAc;IACnC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,eAAe,CAAC,KAA+B;IACtD,OAAO,KAAK,YAAY,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,qBAAqB,CAAC,OAA0B,EAAE,SAAiB;IAC1E,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,sDAAsD,SAAS,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QAChD,IAAI,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,kEAAkE,KAAK,GAAG,CAAC,OAAO,SAAS,EAAE,CAAC,CAAC;QACjH,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,iDAAiD,MAAM,OAAO,SAAS,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACnB,CAAC;IAED,KAAK,MAAM,QAAQ,IAAI,4BAA4B,EAAE,CAAC;QACpD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,wDAAwD,QAAQ,OAAO,SAAS,EAAE,CAAC,CAAC;QACtG,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CACxB,GAA2B,EAC3B,OAAe;IAEf,KAAK,MAAM,GAAG,IAAI,4BAA4B,EAAE,CAAC;QAC/C,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,wCAAwC,GAAG,OAAO,OAAO,EAAE,CAAC,CAAC;QAC/E,CAAC;IACH,CAAC;IACD,OAAO,GAAwC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,QAA0B;IACtE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IAEnC,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG;YACX,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;YAClB,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;gBACtD,MAAM,KAAK,GAAG,GAAG,CAAC,MAAsC,CAAC,CAAC;gBAC1D,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YAChD,CAAC,CAAC,CAAC;SACJ,CAAC;QACF,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAA+B;IACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IACtE,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QACnD,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,wCAAwC,SAAS,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,EAAE;YACjD,MAAM,EAAE,CAAC;YACT,GAAG,EAAE,KAAK;YACV,MAAM,EAAE,EAAE;SACX,CAAc,CAAC;QAEhB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,SAAS,EAAE,CAAC,CAAC;QACrF,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,wDAAwD,SAAS,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5D,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAE1C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACnD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YAChD,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAC/B,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAC5C,CAAC;YAC5B,OAAO,iBAAiB,CAAC,MAAM,EAAE,GAAG,SAAS,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,SAAS;YACf,OAAO;YACP,IAAI;SACL,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,CAAC;QACV,MAAM;KACP,CAAC;AACJ,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@flyingrobots/bijou-i18n-tools-xlsx",
|
|
3
|
+
"version": "4.1.0",
|
|
4
|
+
"description": "XLSX workbook adapters for Bijou localization exchange workflows.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"sideEffects": false,
|
|
7
|
+
"main": "./dist/index.js",
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"types": "./dist/index.d.ts",
|
|
12
|
+
"default": "./dist/index.js"
|
|
13
|
+
},
|
|
14
|
+
"./package.json": "./package.json"
|
|
15
|
+
},
|
|
16
|
+
"files": [
|
|
17
|
+
"dist",
|
|
18
|
+
"README.md",
|
|
19
|
+
"LICENSE"
|
|
20
|
+
],
|
|
21
|
+
"scripts": {
|
|
22
|
+
"build": "tsc -b",
|
|
23
|
+
"prepack": "tsc -b",
|
|
24
|
+
"lint": "tsc --noEmit"
|
|
25
|
+
},
|
|
26
|
+
"dependencies": {
|
|
27
|
+
"@flyingrobots/bijou-i18n-tools": "4.1.0",
|
|
28
|
+
"xlsx": "https://cdn.sheetjs.com/xlsx-0.20.3/xlsx-0.20.3.tgz"
|
|
29
|
+
},
|
|
30
|
+
"devDependencies": {
|
|
31
|
+
"@types/node": "^22.0.0",
|
|
32
|
+
"typescript": "^5.9.3",
|
|
33
|
+
"vitest": "^4.0.18"
|
|
34
|
+
},
|
|
35
|
+
"keywords": [
|
|
36
|
+
"i18n",
|
|
37
|
+
"localization",
|
|
38
|
+
"translation",
|
|
39
|
+
"xlsx",
|
|
40
|
+
"spreadsheet",
|
|
41
|
+
"bijou"
|
|
42
|
+
],
|
|
43
|
+
"author": "James Ross <james@flyingrobots.dev>",
|
|
44
|
+
"license": "Apache-2.0",
|
|
45
|
+
"repository": {
|
|
46
|
+
"type": "git",
|
|
47
|
+
"url": "git+https://github.com/flyingrobots/bijou.git",
|
|
48
|
+
"directory": "packages/bijou-i18n-tools-xlsx"
|
|
49
|
+
},
|
|
50
|
+
"homepage": "https://github.com/flyingrobots/bijou",
|
|
51
|
+
"bugs": "https://github.com/flyingrobots/bijou/issues",
|
|
52
|
+
"engines": {
|
|
53
|
+
"node": ">=18"
|
|
54
|
+
},
|
|
55
|
+
"publishConfig": {
|
|
56
|
+
"access": "public",
|
|
57
|
+
"provenance": true
|
|
58
|
+
}
|
|
59
|
+
}
|