@niicojs/excel 0.3.4 → 0.3.6

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.
@@ -1,449 +0,0 @@
1
- import type { PivotCacheField, CellValue } from './types';
2
- import type { Styles } from './styles';
3
- import { createElement, stringifyXml, XmlNode } from './utils/xml';
4
-
5
- /**
6
- * Manages the pivot cache (definition and records) for a pivot table.
7
- * The cache stores source data metadata and cached values.
8
- */
9
- export class PivotCache {
10
- private _cacheId: number;
11
- private _fileIndex: number;
12
- private _sourceSheet: string;
13
- private _sourceRange: string;
14
- private _fields: PivotCacheField[] = [];
15
- private _records: CellValue[][] = [];
16
- private _recordCount = 0;
17
- private _saveData = true;
18
- private _refreshOnLoad = true; // Default to true
19
- // Optimized lookup: Map<fieldIndex, Map<stringValue, sharedItemsIndex>>
20
- private _sharedItemsIndexMap: Map<number, Map<string, number>> = new Map();
21
- private _blankItemIndexMap: Map<number, number> = new Map();
22
- private _styles: Styles | null = null;
23
-
24
- constructor(cacheId: number, sourceSheet: string, sourceRange: string, fileIndex: number) {
25
- this._cacheId = cacheId;
26
- this._fileIndex = fileIndex;
27
- this._sourceSheet = sourceSheet;
28
- this._sourceRange = sourceRange;
29
- }
30
-
31
- /**
32
- * Set styles reference for number format resolution.
33
- * @internal
34
- */
35
- setStyles(styles: Styles): void {
36
- this._styles = styles;
37
- }
38
-
39
-
40
- /**
41
- * Get the cache ID
42
- */
43
- get cacheId(): number {
44
- return this._cacheId;
45
- }
46
-
47
- /**
48
- * Get the file index for this cache (used for file naming).
49
- */
50
- get fileIndex(): number {
51
- return this._fileIndex;
52
- }
53
-
54
- /**
55
- * Set refreshOnLoad option
56
- */
57
- set refreshOnLoad(value: boolean) {
58
- this._refreshOnLoad = value;
59
- }
60
-
61
- /**
62
- * Set saveData option
63
- */
64
- set saveData(value: boolean) {
65
- this._saveData = value;
66
- }
67
-
68
- /**
69
- * Get refreshOnLoad option
70
- */
71
- get refreshOnLoad(): boolean {
72
- return this._refreshOnLoad;
73
- }
74
-
75
- /**
76
- * Get saveData option
77
- */
78
- get saveData(): boolean {
79
- return this._saveData;
80
- }
81
-
82
- /**
83
- * Get the source sheet name
84
- */
85
- get sourceSheet(): string {
86
- return this._sourceSheet;
87
- }
88
-
89
- /**
90
- * Get the source range
91
- */
92
- get sourceRange(): string {
93
- return this._sourceRange;
94
- }
95
-
96
- /**
97
- * Get the full source reference (Sheet!Range)
98
- */
99
- get sourceRef(): string {
100
- return `${this._sourceSheet}!${this._sourceRange}`;
101
- }
102
-
103
- /**
104
- * Get the fields in this cache
105
- */
106
- get fields(): PivotCacheField[] {
107
- return this._fields;
108
- }
109
-
110
- /**
111
- * Get the number of data records
112
- */
113
- get recordCount(): number {
114
- return this._recordCount;
115
- }
116
-
117
- /**
118
- * Build the cache from source data.
119
- * @param headers - Array of column header names
120
- * @param data - 2D array of data rows (excluding headers)
121
- */
122
- buildFromData(headers: string[], data: CellValue[][]): void {
123
- this._recordCount = data.length;
124
-
125
- // Initialize fields from headers
126
- this._fields = headers.map((name, index) => ({
127
- name,
128
- index,
129
- isNumeric: true,
130
- isDate: false,
131
- hasBoolean: false,
132
- hasBlank: false,
133
- numFmtId: undefined,
134
- sharedItems: [],
135
- minValue: undefined,
136
- maxValue: undefined,
137
- minDate: undefined,
138
- maxDate: undefined,
139
- }));
140
-
141
- // Use Maps for unique value collection during analysis
142
- const sharedItemsMaps: Map<string, string>[] = this._fields.map(() => new Map<string, string>());
143
-
144
- // Analyze data to determine field types and collect unique values
145
- for (const row of data) {
146
- for (let colIdx = 0; colIdx < row.length && colIdx < this._fields.length; colIdx++) {
147
- const value = row[colIdx];
148
- const field = this._fields[colIdx];
149
-
150
- if (value === null || value === undefined) {
151
- field.hasBlank = true;
152
- continue;
153
- }
154
-
155
- if (typeof value === 'string') {
156
- field.isNumeric = false;
157
- const map = sharedItemsMaps[colIdx];
158
- if (!map.has(value)) {
159
- map.set(value, value);
160
- }
161
- } else if (typeof value === 'number') {
162
- if (field.isDate) {
163
- const d = this._excelSerialToDate(value);
164
- if (!field.minDate || d < field.minDate) {
165
- field.minDate = d;
166
- }
167
- if (!field.maxDate || d > field.maxDate) {
168
- field.maxDate = d;
169
- }
170
- } else {
171
- if (field.minValue === undefined || value < field.minValue) {
172
- field.minValue = value;
173
- }
174
- if (field.maxValue === undefined || value > field.maxValue) {
175
- field.maxValue = value;
176
- }
177
- }
178
- } else if (value instanceof Date) {
179
- field.isDate = true;
180
- field.isNumeric = false;
181
- if (!field.minDate || value < field.minDate) {
182
- field.minDate = value;
183
- }
184
- if (!field.maxDate || value > field.maxDate) {
185
- field.maxDate = value;
186
- }
187
- } else if (typeof value === 'boolean') {
188
- field.isNumeric = false;
189
- field.hasBoolean = true;
190
- }
191
- }
192
- }
193
-
194
- // Resolve number formats if styles are available
195
- if (this._styles) {
196
- const dateFmtId = this._styles.getOrCreateNumFmtId('mm-dd-yy');
197
- for (const field of this._fields) {
198
- if (field.isDate) {
199
- field.numFmtId = dateFmtId;
200
- }
201
- }
202
- }
203
-
204
- // Convert Sets to arrays and build reverse index Maps for O(1) lookup during XML generation
205
- this._sharedItemsIndexMap.clear();
206
- this._blankItemIndexMap.clear();
207
- for (let colIdx = 0; colIdx < this._fields.length; colIdx++) {
208
- const field = this._fields[colIdx];
209
- const map = sharedItemsMaps[colIdx];
210
-
211
- // Convert Map values to array (maintains insertion order in ES6+)
212
- field.sharedItems = Array.from(map.values());
213
-
214
- // Build reverse lookup Map: value -> index
215
- if (field.sharedItems.length > 0) {
216
- const indexMap = new Map<string, number>();
217
- for (let i = 0; i < field.sharedItems.length; i++) {
218
- indexMap.set(field.sharedItems[i], i);
219
- }
220
- this._sharedItemsIndexMap.set(colIdx, indexMap);
221
-
222
- if (field.hasBlank) {
223
- const blankIndex = field.sharedItems.length;
224
- this._blankItemIndexMap.set(colIdx, blankIndex);
225
- }
226
- }
227
- }
228
-
229
- // Store records
230
- this._records = data;
231
- }
232
-
233
- /**
234
- * Get field by name
235
- */
236
- getField(name: string): PivotCacheField | undefined {
237
- return this._fields.find((f) => f.name === name);
238
- }
239
-
240
- /**
241
- * Get field index by name
242
- */
243
- getFieldIndex(name: string): number {
244
- const field = this._fields.find((f) => f.name === name);
245
- return field ? field.index : -1;
246
- }
247
-
248
- /**
249
- * Generate the pivotCacheDefinition XML
250
- */
251
- toDefinitionXml(recordsRelId: string): string {
252
- const cacheFieldNodes: XmlNode[] = this._fields.map((field) => {
253
- const sharedItemsAttrs: Record<string, string> = {};
254
- const sharedItemChildren: XmlNode[] = [];
255
-
256
- if (field.sharedItems.length > 0) {
257
- // String field with shared items
258
- const total = field.hasBlank ? field.sharedItems.length + 1 : field.sharedItems.length;
259
- sharedItemsAttrs.count = String(total);
260
- sharedItemsAttrs.containsString = '1';
261
-
262
- if (field.hasBlank) {
263
- sharedItemsAttrs.containsBlank = '1';
264
- }
265
-
266
- for (const item of field.sharedItems) {
267
- sharedItemChildren.push(createElement('s', { v: item }, []));
268
- }
269
- if (field.hasBlank) {
270
- sharedItemChildren.push(createElement('m', {}, []));
271
- }
272
- } else if (field.isDate) {
273
- sharedItemsAttrs.containsSemiMixedTypes = '0';
274
- sharedItemsAttrs.containsString = '0';
275
- sharedItemsAttrs.containsDate = '1';
276
- sharedItemsAttrs.containsNonDate = '0';
277
- if (field.hasBlank) {
278
- sharedItemsAttrs.containsBlank = '1';
279
- }
280
- if (field.minDate) {
281
- sharedItemsAttrs.minDate = this._formatDate(field.minDate);
282
- }
283
- if (field.maxDate) {
284
- const maxDate = new Date(field.maxDate.getTime() + 24 * 60 * 60 * 1000);
285
- sharedItemsAttrs.maxDate = this._formatDate(maxDate);
286
- }
287
- } else if (field.isNumeric) {
288
- // Numeric field - use "0"/"1" for boolean attributes as Excel expects
289
- sharedItemsAttrs.containsSemiMixedTypes = '0';
290
- sharedItemsAttrs.containsString = '0';
291
- sharedItemsAttrs.containsNumber = '1';
292
- if (field.hasBlank) {
293
- sharedItemsAttrs.containsBlank = '1';
294
- }
295
- // Check if all values are integers
296
- if (field.minValue !== undefined && field.maxValue !== undefined) {
297
- const isInteger = Number.isInteger(field.minValue) && Number.isInteger(field.maxValue);
298
- if (isInteger) {
299
- sharedItemsAttrs.containsInteger = '1';
300
- }
301
- sharedItemsAttrs.minValue = this._formatNumber(field.minValue);
302
- sharedItemsAttrs.maxValue = this._formatNumber(field.maxValue);
303
- }
304
- } else if (field.hasBoolean) {
305
- // Boolean-only field (no strings, no numbers)
306
- if (field.hasBlank) {
307
- sharedItemsAttrs.containsBlank = '1';
308
- }
309
- sharedItemsAttrs.count = field.hasBlank ? '3' : '2';
310
- sharedItemChildren.push(createElement('b', { v: '0' }, []));
311
- sharedItemChildren.push(createElement('b', { v: '1' }, []));
312
- if (field.hasBlank) {
313
- sharedItemChildren.push(createElement('m', {}, []));
314
- }
315
- } else if (field.hasBlank) {
316
- // Field that only contains blanks
317
- sharedItemsAttrs.containsBlank = '1';
318
- }
319
-
320
- const sharedItemsNode = createElement('sharedItems', sharedItemsAttrs, sharedItemChildren);
321
- const cacheFieldAttrs: Record<string, string> = { name: field.name, numFmtId: String(field.numFmtId ?? 0) };
322
- return createElement('cacheField', cacheFieldAttrs, [sharedItemsNode]);
323
- });
324
-
325
- const cacheFieldsNode = createElement('cacheFields', { count: String(this._fields.length) }, cacheFieldNodes);
326
-
327
- const worksheetSourceNode = createElement(
328
- 'worksheetSource',
329
- { ref: this._sourceRange, sheet: this._sourceSheet },
330
- [],
331
- );
332
- const cacheSourceNode = createElement('cacheSource', { type: 'worksheet' }, [worksheetSourceNode]);
333
-
334
- // Build attributes - align with Excel expectations
335
- const definitionAttrs: Record<string, string> = {
336
- xmlns: 'http://schemas.openxmlformats.org/spreadsheetml/2006/main',
337
- 'xmlns:r': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
338
- 'r:id': recordsRelId,
339
- };
340
-
341
- if (this._refreshOnLoad) {
342
- definitionAttrs.refreshOnLoad = '1';
343
- }
344
-
345
- definitionAttrs.refreshedBy = 'User';
346
- definitionAttrs.refreshedVersion = '8';
347
- definitionAttrs.minRefreshableVersion = '3';
348
- definitionAttrs.createdVersion = '8';
349
- if (!this._saveData) {
350
- definitionAttrs.saveData = '0';
351
- definitionAttrs.recordCount = '0';
352
- } else {
353
- definitionAttrs.recordCount = String(this._recordCount);
354
- }
355
-
356
- const definitionNode = createElement('pivotCacheDefinition', definitionAttrs, [cacheSourceNode, cacheFieldsNode]);
357
-
358
- return `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n${stringifyXml([definitionNode])}`;
359
- }
360
-
361
- /**
362
- * Generate the pivotCacheRecords XML
363
- */
364
- toRecordsXml(): string {
365
- const recordNodes: XmlNode[] = [];
366
-
367
- for (const row of this._records) {
368
- const fieldNodes: XmlNode[] = [];
369
-
370
- for (let colIdx = 0; colIdx < this._fields.length; colIdx++) {
371
- const value = colIdx < row.length ? row[colIdx] : null;
372
-
373
- if (value === null || value === undefined) {
374
- // Missing value
375
- const blankIndex = this._blankItemIndexMap.get(colIdx);
376
- if (blankIndex !== undefined) {
377
- fieldNodes.push(createElement('x', { v: String(blankIndex) }, []));
378
- } else {
379
- fieldNodes.push(createElement('m', {}, []));
380
- }
381
- } else if (typeof value === 'string') {
382
- // String value - use index into sharedItems via O(1) Map lookup
383
- const indexMap = this._sharedItemsIndexMap.get(colIdx);
384
- const idx = indexMap?.get(value);
385
- if (idx !== undefined) {
386
- fieldNodes.push(createElement('x', { v: String(idx) }, []));
387
- } else {
388
- // Direct string value (shouldn't happen if cache is built correctly)
389
- fieldNodes.push(createElement('s', { v: value }, []));
390
- }
391
- } else if (typeof value === 'number') {
392
- if (this._fields[colIdx]?.isDate) {
393
- const d = this._excelSerialToDate(value);
394
- fieldNodes.push(createElement('d', { v: this._formatDate(d) }, []));
395
- } else {
396
- fieldNodes.push(createElement('n', { v: String(value) }, []));
397
- }
398
- } else if (typeof value === 'boolean') {
399
- fieldNodes.push(createElement('b', { v: value ? '1' : '0' }, []));
400
- } else if (value instanceof Date) {
401
- fieldNodes.push(createElement('d', { v: this._formatDate(value) }, []));
402
- } else {
403
- // Unknown type, treat as missing
404
- fieldNodes.push(createElement('m', {}, []));
405
- }
406
- }
407
-
408
- recordNodes.push(createElement('r', {}, fieldNodes));
409
- }
410
-
411
- const recordsNode = createElement(
412
- 'pivotCacheRecords',
413
- {
414
- xmlns: 'http://schemas.openxmlformats.org/spreadsheetml/2006/main',
415
- 'xmlns:r': 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
416
- count: String(this._recordCount),
417
- },
418
- recordNodes,
419
- );
420
-
421
- return `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n${stringifyXml([recordsNode])}`;
422
- }
423
-
424
- private _formatDate(value: Date): string {
425
- return value.toISOString().replace(/\.\d{3}Z$/, '');
426
- }
427
-
428
- private _formatNumber(value: number): string {
429
- if (Number.isInteger(value)) {
430
- return String(value);
431
- }
432
- if (Math.abs(value) >= 1000000) {
433
- return value.toFixed(16).replace(/0+$/, '').replace(/\.$/, '');
434
- }
435
- return String(value);
436
- }
437
-
438
-
439
- private _excelSerialToDate(serial: number): Date {
440
- // Excel epoch: December 31, 1899
441
- const EXCEL_EPOCH = Date.UTC(1899, 11, 31);
442
- const MS_PER_DAY = 24 * 60 * 60 * 1000;
443
- const adjusted = serial >= 60 ? serial - 1 : serial;
444
- const ms = Math.round(adjusted * MS_PER_DAY);
445
- return new Date(EXCEL_EPOCH + ms);
446
- }
447
-
448
-
449
- }