@nhtio/adk 0.1.0-master-e6c58205 → 0.1.0-master-89b47bec

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.
Files changed (290) hide show
  1. package/CHANGELOG.md +94 -0
  2. package/__vite-browser-external-CU7uua8b.mjs +9 -0
  3. package/__vite-browser-external-CU7uua8b.mjs.map +1 -0
  4. package/__vite-browser-external-DAHxjh-D.js +13 -0
  5. package/__vite-browser-external-DAHxjh-D.js.map +1 -0
  6. package/batteries/embeddings/openai/adapter.cjs +1 -1
  7. package/batteries/embeddings/openai/adapter.mjs +1 -1
  8. package/batteries/embeddings/webllm/adapter.cjs +1 -1
  9. package/batteries/embeddings/webllm/adapter.mjs +1 -1
  10. package/batteries/llm/ollama/adapter.cjs +5 -5
  11. package/batteries/llm/ollama/adapter.mjs +5 -5
  12. package/batteries/llm/ollama/helpers.cjs +2 -2
  13. package/batteries/llm/ollama/helpers.mjs +2 -2
  14. package/batteries/llm/ollama/validation.cjs +1 -1
  15. package/batteries/llm/ollama/validation.mjs +1 -1
  16. package/batteries/llm/openai_chat_completions/adapter.cjs +5 -5
  17. package/batteries/llm/openai_chat_completions/adapter.mjs +5 -5
  18. package/batteries/llm/openai_chat_completions/helpers.cjs +2 -2
  19. package/batteries/llm/openai_chat_completions/helpers.mjs +2 -2
  20. package/batteries/llm/openai_chat_completions/validation.cjs +1 -1
  21. package/batteries/llm/openai_chat_completions/validation.mjs +1 -1
  22. package/batteries/llm/webllm_chat_completions/adapter.cjs +5 -5
  23. package/batteries/llm/webllm_chat_completions/adapter.mjs +5 -5
  24. package/batteries/llm/webllm_chat_completions/validation.cjs +1 -1
  25. package/batteries/llm/webllm_chat_completions/validation.mjs +1 -1
  26. package/batteries/media/contracts.cjs +38 -8
  27. package/batteries/media/contracts.cjs.map +1 -1
  28. package/batteries/media/contracts.d.ts +86 -6
  29. package/batteries/media/contracts.mjs +37 -9
  30. package/batteries/media/contracts.mjs.map +1 -1
  31. package/batteries/media/engines/audio_decode.cjs +46 -6
  32. package/batteries/media/engines/audio_decode.cjs.map +1 -1
  33. package/batteries/media/engines/audio_decode.d.ts +9 -5
  34. package/batteries/media/engines/audio_decode.mjs +47 -7
  35. package/batteries/media/engines/audio_decode.mjs.map +1 -1
  36. package/batteries/media/engines/data.cjs +159 -0
  37. package/batteries/media/engines/data.cjs.map +1 -0
  38. package/batteries/media/engines/data.d.ts +36 -0
  39. package/batteries/media/engines/data.mjs +157 -0
  40. package/batteries/media/engines/data.mjs.map +1 -0
  41. package/batteries/media/engines/exceljs.cjs +290 -0
  42. package/batteries/media/engines/exceljs.cjs.map +1 -0
  43. package/batteries/media/engines/exceljs.d.ts +41 -0
  44. package/batteries/media/engines/exceljs.mjs +288 -0
  45. package/batteries/media/engines/exceljs.mjs.map +1 -0
  46. package/batteries/media/engines/execa_executor.cjs +1 -1
  47. package/batteries/media/engines/execa_executor.mjs +1 -1
  48. package/batteries/media/engines/fs_workspace.cjs +1 -1
  49. package/batteries/media/engines/fs_workspace.mjs +1 -1
  50. package/batteries/media/engines/jimp.cjs +24 -2
  51. package/batteries/media/engines/jimp.cjs.map +1 -1
  52. package/batteries/media/engines/jimp.d.ts +3 -1
  53. package/batteries/media/engines/jimp.mjs +24 -2
  54. package/batteries/media/engines/jimp.mjs.map +1 -1
  55. package/batteries/media/engines/sharp.cjs +37 -4
  56. package/batteries/media/engines/sharp.cjs.map +1 -1
  57. package/batteries/media/engines/sharp.d.ts +5 -3
  58. package/batteries/media/engines/sharp.mjs +37 -4
  59. package/batteries/media/engines/sharp.mjs.map +1 -1
  60. package/batteries/media/engines/sheetjs.cjs +438 -0
  61. package/batteries/media/engines/sheetjs.cjs.map +1 -0
  62. package/batteries/media/engines/sheetjs.d.ts +51 -0
  63. package/batteries/media/engines/sheetjs.mjs +436 -0
  64. package/batteries/media/engines/sheetjs.mjs.map +1 -0
  65. package/batteries/media/engines/soffice.cjs +37 -3
  66. package/batteries/media/engines/soffice.cjs.map +1 -1
  67. package/batteries/media/engines/soffice.mjs +38 -4
  68. package/batteries/media/engines/soffice.mjs.map +1 -1
  69. package/batteries/media/engines/tesseract_js.cjs +1 -1
  70. package/batteries/media/engines/tesseract_js.mjs +1 -1
  71. package/batteries/media/engines/transformers_asr.cjs +1 -1
  72. package/batteries/media/engines/transformers_asr.mjs +1 -1
  73. package/batteries/media/forge.cjs +89 -20
  74. package/batteries/media/forge.cjs.map +1 -1
  75. package/batteries/media/forge.mjs +89 -20
  76. package/batteries/media/forge.mjs.map +1 -1
  77. package/batteries/media/formats.d.ts +9 -0
  78. package/batteries/media/index.d.ts +8 -6
  79. package/batteries/media/lint.cjs +270 -58
  80. package/batteries/media/lint.cjs.map +1 -1
  81. package/batteries/media/lint.d.ts +45 -0
  82. package/batteries/media/lint.mjs +267 -58
  83. package/batteries/media/lint.mjs.map +1 -1
  84. package/batteries/media/registry.d.ts +11 -2
  85. package/batteries/media/steps/data.d.ts +26 -0
  86. package/batteries/media/steps/doc.d.ts +17 -7
  87. package/batteries/media/steps/patch.d.ts +90 -0
  88. package/batteries/media/steps/sheet.d.ts +10 -6
  89. package/batteries/media/steps/text.d.ts +4 -1
  90. package/batteries/media/validate.d.ts +5 -0
  91. package/batteries/media/verbs.d.ts +12 -1
  92. package/batteries/media.cjs +869 -448
  93. package/batteries/media.cjs.map +1 -1
  94. package/batteries/media.mjs +829 -409
  95. package/batteries/media.mjs.map +1 -1
  96. package/batteries/storage/flydrive.cjs +3 -6
  97. package/batteries/storage/flydrive.cjs.map +1 -1
  98. package/batteries/storage/flydrive.mjs +3 -6
  99. package/batteries/storage/flydrive.mjs.map +1 -1
  100. package/batteries/storage/in_memory.cjs +1 -1
  101. package/batteries/storage/in_memory.mjs +1 -1
  102. package/batteries/storage/opfs.cjs +1 -1
  103. package/batteries/storage/opfs.mjs +1 -1
  104. package/batteries/tools/_shared.cjs +2 -2
  105. package/batteries/tools/_shared.mjs +2 -2
  106. package/batteries/tools/color.cjs +2 -2
  107. package/batteries/tools/color.mjs +2 -2
  108. package/batteries/tools/comparison.cjs +3 -3
  109. package/batteries/tools/comparison.mjs +3 -3
  110. package/batteries/tools/data_structure.cjs +3 -3
  111. package/batteries/tools/data_structure.mjs +3 -3
  112. package/batteries/tools/datetime_extended.cjs +3 -3
  113. package/batteries/tools/datetime_extended.mjs +3 -3
  114. package/batteries/tools/datetime_math.cjs +3 -3
  115. package/batteries/tools/datetime_math.mjs +3 -3
  116. package/batteries/tools/encoding.cjs +3 -3
  117. package/batteries/tools/encoding.mjs +3 -3
  118. package/batteries/tools/formatting.cjs +3 -3
  119. package/batteries/tools/formatting.mjs +3 -3
  120. package/batteries/tools/geo_basics.cjs +2 -2
  121. package/batteries/tools/geo_basics.mjs +2 -2
  122. package/batteries/tools/math.cjs +3 -3
  123. package/batteries/tools/math.mjs +3 -3
  124. package/batteries/tools/memory.cjs +6 -6
  125. package/batteries/tools/memory.mjs +6 -6
  126. package/batteries/tools/parsing.cjs +4 -4
  127. package/batteries/tools/parsing.mjs +4 -4
  128. package/batteries/tools/retrievables.cjs +5 -5
  129. package/batteries/tools/retrievables.mjs +5 -5
  130. package/batteries/tools/scrapper.cjs +1 -1
  131. package/batteries/tools/scrapper.mjs +1 -1
  132. package/batteries/tools/searxng.cjs +1 -1
  133. package/batteries/tools/searxng.mjs +1 -1
  134. package/batteries/tools/standing_instructions.cjs +4 -4
  135. package/batteries/tools/standing_instructions.mjs +4 -4
  136. package/batteries/tools/statistics.cjs +4 -4
  137. package/batteries/tools/statistics.mjs +4 -4
  138. package/batteries/tools/string_processing.cjs +3 -3
  139. package/batteries/tools/string_processing.mjs +3 -3
  140. package/batteries/tools/structured_data.cjs +3 -3
  141. package/batteries/tools/structured_data.mjs +3 -3
  142. package/batteries/tools/text_analysis.cjs +3 -3
  143. package/batteries/tools/text_analysis.mjs +3 -3
  144. package/batteries/tools/text_comparison.cjs +2 -2
  145. package/batteries/tools/text_comparison.mjs +2 -2
  146. package/batteries/tools/time.cjs +3 -3
  147. package/batteries/tools/time.mjs +3 -3
  148. package/batteries/tools/unit_conversion.cjs +2 -2
  149. package/batteries/tools/unit_conversion.mjs +2 -2
  150. package/batteries/tools/web_retrieval.cjs +1 -1
  151. package/batteries/tools/web_retrieval.mjs +1 -1
  152. package/batteries/tools.cjs +2 -2
  153. package/batteries/tools.mjs +2 -2
  154. package/batteries/vector/arangodb.cjs +1 -1
  155. package/batteries/vector/arangodb.mjs +1 -1
  156. package/batteries/vector/clickhouse.cjs +1 -1
  157. package/batteries/vector/clickhouse.mjs +1 -1
  158. package/batteries/vector/cloudflare.cjs +1 -1
  159. package/batteries/vector/cloudflare.mjs +1 -1
  160. package/batteries/vector/couchbase.cjs +1 -1
  161. package/batteries/vector/couchbase.mjs +1 -1
  162. package/batteries/vector/duckdb.cjs +1 -1
  163. package/batteries/vector/duckdb.mjs +1 -1
  164. package/batteries/vector/elasticsearch.cjs +1 -1
  165. package/batteries/vector/elasticsearch.mjs +1 -1
  166. package/batteries/vector/filters.cjs +1 -1
  167. package/batteries/vector/filters.mjs +1 -1
  168. package/batteries/vector/hnswlib.cjs +1 -1
  169. package/batteries/vector/hnswlib.mjs +1 -1
  170. package/batteries/vector/lancedb.cjs +1 -1
  171. package/batteries/vector/lancedb.mjs +1 -1
  172. package/batteries/vector/mariadb.cjs +1 -1
  173. package/batteries/vector/mariadb.mjs +1 -1
  174. package/batteries/vector/meilisearch.cjs +1 -1
  175. package/batteries/vector/meilisearch.mjs +1 -1
  176. package/batteries/vector/migrate.cjs +1 -1
  177. package/batteries/vector/migrate.mjs +1 -1
  178. package/batteries/vector/mongodb.cjs +1 -1
  179. package/batteries/vector/mongodb.mjs +1 -1
  180. package/batteries/vector/neo4j.cjs +1 -1
  181. package/batteries/vector/neo4j.mjs +1 -1
  182. package/batteries/vector/opensearch.cjs +1 -1
  183. package/batteries/vector/opensearch.mjs +1 -1
  184. package/batteries/vector/oracle23ai.cjs +1 -1
  185. package/batteries/vector/oracle23ai.mjs +1 -1
  186. package/batteries/vector/pinecone.cjs +1 -1
  187. package/batteries/vector/pinecone.mjs +1 -1
  188. package/batteries/vector/redis.cjs +1 -1
  189. package/batteries/vector/redis.mjs +1 -1
  190. package/batteries/vector/retrievable.cjs +1 -1
  191. package/batteries/vector/retrievable.mjs +1 -1
  192. package/batteries/vector/s3vectors.cjs +1 -1
  193. package/batteries/vector/s3vectors.mjs +1 -1
  194. package/batteries/vector/solr.cjs +1 -1
  195. package/batteries/vector/solr.mjs +1 -1
  196. package/batteries/vector/surrealdb.cjs +1 -1
  197. package/batteries/vector/surrealdb.mjs +1 -1
  198. package/batteries/vector/typesense.cjs +1 -1
  199. package/batteries/vector/typesense.mjs +1 -1
  200. package/batteries/vector/vespa.cjs +1 -1
  201. package/batteries/vector/vespa.mjs +1 -1
  202. package/batteries/vector/weaviate.cjs +1 -1
  203. package/batteries/vector/weaviate.mjs +1 -1
  204. package/batteries.cjs +2 -2
  205. package/batteries.mjs +2 -2
  206. package/bundled_xlsx.d.ts +1075 -0
  207. package/{common-BxoznqbX.mjs → common-BQoFv108.mjs} +7 -7
  208. package/{common-BxoznqbX.mjs.map → common-BQoFv108.mjs.map} +1 -1
  209. package/{common-BBK2e5ro.js → common-DmDn4Gfl.js} +7 -7
  210. package/{common-BBK2e5ro.js.map → common-DmDn4Gfl.js.map} +1 -1
  211. package/common.cjs +7 -7
  212. package/common.mjs +7 -7
  213. package/{dispatch_runner-Hn5idJYx.js → dispatch_runner-BwplbCPr.js} +3 -3
  214. package/{dispatch_runner-Hn5idJYx.js.map → dispatch_runner-BwplbCPr.js.map} +1 -1
  215. package/{dispatch_runner-DUrpj0xR.mjs → dispatch_runner-C1ar_D7W.mjs} +3 -3
  216. package/{dispatch_runner-DUrpj0xR.mjs.map → dispatch_runner-C1ar_D7W.mjs.map} +1 -1
  217. package/dispatch_runner.cjs +1 -1
  218. package/dispatch_runner.mjs +1 -1
  219. package/eslint.cjs +1 -1
  220. package/eslint.mjs +1 -1
  221. package/forge.cjs +4 -4
  222. package/forge.mjs +4 -4
  223. package/formats-CCylUHZw.mjs +161 -0
  224. package/formats-CCylUHZw.mjs.map +1 -0
  225. package/formats-DZVuqZUN.js +196 -0
  226. package/formats-DZVuqZUN.js.map +1 -0
  227. package/guards.cjs +8 -8
  228. package/guards.mjs +8 -8
  229. package/index.cjs +11 -11
  230. package/index.mjs +11 -11
  231. package/mcp/adk-docs-corpus.json +1 -1
  232. package/package.json +198 -182
  233. package/{scrapper-DLj_KkxK.mjs → scrapper-Dn2wXu0Y.mjs} +5 -5
  234. package/{scrapper-DLj_KkxK.mjs.map → scrapper-Dn2wXu0Y.mjs.map} +1 -1
  235. package/{scrapper-Cmf1CSA-.js → scrapper-mBZ0Odq7.js} +5 -5
  236. package/{scrapper-Cmf1CSA-.js.map → scrapper-mBZ0Odq7.js.map} +1 -1
  237. package/{searxng-BKs5s8Su.js → searxng-Dj-iP_Vz.js} +5 -5
  238. package/{searxng-BKs5s8Su.js.map → searxng-Dj-iP_Vz.js.map} +1 -1
  239. package/{searxng-BJ-aZcMz.mjs → searxng-DjFxtFf6.mjs} +5 -5
  240. package/{searxng-BJ-aZcMz.mjs.map → searxng-DjFxtFf6.mjs.map} +1 -1
  241. package/server.json +21 -0
  242. package/skills/adk-assembly/SKILL.md +2 -2
  243. package/{spooled_artifact-BR0IhU9y.js → spooled_artifact-BCmPrxZS.js} +3 -3
  244. package/{spooled_artifact-BR0IhU9y.js.map → spooled_artifact-BCmPrxZS.js.map} +1 -1
  245. package/{spooled_artifact-nTE6ujM8.mjs → spooled_artifact-DL36jnqA.mjs} +3 -3
  246. package/{spooled_artifact-nTE6ujM8.mjs.map → spooled_artifact-DL36jnqA.mjs.map} +1 -1
  247. package/spooled_artifact.cjs +2 -2
  248. package/spooled_artifact.mjs +2 -2
  249. package/{spooled_markdown_artifact-Dj3fNowz.js → spooled_markdown_artifact-CD4PrrpV.js} +3 -3
  250. package/{spooled_markdown_artifact-Dj3fNowz.js.map → spooled_markdown_artifact-CD4PrrpV.js.map} +1 -1
  251. package/{spooled_markdown_artifact-DIYzbQv8.mjs → spooled_markdown_artifact-Da-Xnebh.mjs} +3 -3
  252. package/{spooled_markdown_artifact-DIYzbQv8.mjs.map → spooled_markdown_artifact-Da-Xnebh.mjs.map} +1 -1
  253. package/{thought-Cde2Y_GK.mjs → thought-CtOoZUSE.mjs} +3 -3
  254. package/{thought-Cde2Y_GK.mjs.map → thought-CtOoZUSE.mjs.map} +1 -1
  255. package/{thought-BFtsnUTU.js → thought-eka4iUHa.js} +3 -3
  256. package/{thought-BFtsnUTU.js.map → thought-eka4iUHa.js.map} +1 -1
  257. package/{tool-CcxYxA5X.mjs → tool-CITF20yJ.mjs} +3 -3
  258. package/{tool-CcxYxA5X.mjs.map → tool-CITF20yJ.mjs.map} +1 -1
  259. package/{tool-B2nnkwNU.js → tool-Dhjca7rC.js} +3 -3
  260. package/{tool-B2nnkwNU.js.map → tool-Dhjca7rC.js.map} +1 -1
  261. package/{tool_call-BxL3eU1k.js → tool_call-Cyi0hUUc.js} +4 -4
  262. package/{tool_call-BxL3eU1k.js.map → tool_call-Cyi0hUUc.js.map} +1 -1
  263. package/{tool_call-B3MOog2R.mjs → tool_call-D_k36aI4.mjs} +4 -4
  264. package/{tool_call-B3MOog2R.mjs.map → tool_call-D_k36aI4.mjs.map} +1 -1
  265. package/{tool_registry-BaLUIzWz.mjs → tool_registry-CZ55mIti.mjs} +152 -143
  266. package/tool_registry-CZ55mIti.mjs.map +1 -0
  267. package/{tool_registry-BdKlPuHS.js → tool_registry-DwZ6pzN4.js} +151 -142
  268. package/tool_registry-DwZ6pzN4.js.map +1 -0
  269. package/{turn_runner-M2I8G2ok.js → turn_runner-CCZcsoDU.js} +5 -5
  270. package/{turn_runner-M2I8G2ok.js.map → turn_runner-CCZcsoDU.js.map} +1 -1
  271. package/{turn_runner-BV4BaZK9.mjs → turn_runner-DRPpVvsd.mjs} +5 -5
  272. package/{turn_runner-BV4BaZK9.mjs.map → turn_runner-DRPpVvsd.mjs.map} +1 -1
  273. package/turn_runner.cjs +1 -1
  274. package/turn_runner.mjs +1 -1
  275. package/{validate-JOHfh-BB.mjs → validate-C_hTnDBE.mjs} +95 -8
  276. package/validate-C_hTnDBE.mjs.map +1 -0
  277. package/{validate-DgDZkUKs.js → validate-gaSa9bsk.js} +95 -8
  278. package/validate-gaSa9bsk.js.map +1 -0
  279. package/xlsx-B0sTpEC2.js +30615 -0
  280. package/xlsx-B0sTpEC2.js.map +1 -0
  281. package/xlsx-DiMpn_Xv.mjs +30596 -0
  282. package/xlsx-DiMpn_Xv.mjs.map +1 -0
  283. package/xlsx.zahl-D2_Q-Xs4.mjs +6 -0
  284. package/xlsx.zahl-D2_Q-Xs4.mjs.map +1 -0
  285. package/xlsx.zahl-ZIcUQVv8.js +7 -0
  286. package/xlsx.zahl-ZIcUQVv8.js.map +1 -0
  287. package/tool_registry-BaLUIzWz.mjs.map +0 -1
  288. package/tool_registry-BdKlPuHS.js.map +0 -1
  289. package/validate-DgDZkUKs.js.map +0 -1
  290. package/validate-JOHfh-BB.mjs.map +0 -1
@@ -0,0 +1,1075 @@
1
+ export declare interface AOA2SheetOpts extends CommonOptions, UTCDateOption, DateNFOption, DenseOption {
2
+ /**
3
+ * Create cell objects for stub cells
4
+ * @default false
5
+ */
6
+ sheetStubs?: boolean;
7
+ }
8
+
9
+ /** AutoFilter properties */
10
+ export declare interface AutoFilterInfo {
11
+ /** Range of the AutoFilter table */
12
+ ref: string;
13
+ }
14
+
15
+ /**
16
+ * Type of generated workbook
17
+ * @default 'xlsx'
18
+ */
19
+ export declare type BookType = 'xlsx' | 'xlsm' | 'xlsb' | 'xls' | 'xla' | 'biff8' | 'biff5' | 'biff2' | 'xlml' | 'ods' | 'fods' | 'csv' | 'txt' | 'sylk' | 'slk' | 'html' | 'dif' | 'rtf' | 'prn' | 'eth' | 'dbf' | 'numbers';
20
+
21
+ /** Attempts to write or download workbook data to file asynchronously */
22
+ export declare type CBFunc = () => void;
23
+
24
+ /** Simple Cell Address */
25
+ export declare interface CellAddress {
26
+ /** Column number */
27
+ c: number;
28
+ /** Row number */
29
+ r: number;
30
+ }
31
+
32
+ /** Worksheet Cell Object */
33
+ export declare interface CellObject {
34
+ /** The raw value of the cell. Can be omitted if a formula is specified */
35
+ v?: string | number | boolean | Date;
36
+
37
+ /** Formatted text (if applicable) */
38
+ w?: string;
39
+
40
+ /**
41
+ * The Excel Data Type of the cell.
42
+ * b Boolean, n Number, e Error, s String, d Date, z Empty
43
+ */
44
+ t: ExcelDataType;
45
+
46
+ /** Cell formula (if applicable) */
47
+ f?: string;
48
+
49
+ /** Range of enclosing array if formula is array formula (if applicable) */
50
+ F?: string;
51
+
52
+ /** If true, cell is a dynamic array formula (for supported file formats) */
53
+ D?: boolean;
54
+
55
+ /** Rich text encoding (if applicable) */
56
+ r?: any;
57
+
58
+ /** HTML rendering of the rich text (if applicable) */
59
+ h?: string;
60
+
61
+ /** Comments associated with the cell */
62
+ c?: Comments;
63
+
64
+ /** Number format string associated with the cell (if requested) */
65
+ z?: NumberFormat;
66
+
67
+ /** Cell hyperlink object (.Target holds link, .tooltip is tooltip) */
68
+ l?: Hyperlink;
69
+
70
+ /** The style/theme of the cell (if applicable) */
71
+ s?: any;
72
+ }
73
+
74
+ /** CFB Library */
75
+ export declare const CFB: any;
76
+
77
+ /** Column Properties Object */
78
+ export declare interface ColInfo {
79
+ /* --- visibility --- */
80
+
81
+ /** if true, the column is hidden */
82
+ hidden?: boolean;
83
+
84
+ /* --- column width --- */
85
+
86
+ /** width in Excel's "Max Digit Width", width*256 is integral */
87
+ width?: number;
88
+
89
+ /** width in screen pixels */
90
+ wpx?: number;
91
+
92
+ /** width in "characters" */
93
+ wch?: number;
94
+
95
+ /** outline / group level */
96
+ level?: number;
97
+
98
+ /** Excel's "Max Digit Width" unit, always integral */
99
+ MDW?: number;
100
+
101
+ /** DBF Field Header */
102
+ DBF?: DBFField;
103
+ }
104
+
105
+ /** Comment element */
106
+ declare interface Comment_2 {
107
+ /** Author of the comment block */
108
+ a?: string;
109
+
110
+ /** Plaintext of the comment */
111
+ t: string;
112
+
113
+ /** If true, mark the comment as a part of a thread */
114
+ T?: boolean;
115
+ }
116
+ export { Comment_2 as Comment }
117
+
118
+ /** Cell comments */
119
+ export declare interface Comments extends Array<Comment_2> {
120
+ /** Hide comment by default */
121
+ hidden?: boolean;
122
+ }
123
+
124
+ export declare interface CommonOptions {
125
+ /**
126
+ * If true, throw errors when features are not understood
127
+ * @default false
128
+ */
129
+ WTF?: boolean;
130
+
131
+ /**
132
+ * When reading a file with VBA macros, expose CFB blob to `vbaraw` field
133
+ * When writing BIFF8/XLSB/XLSM, reseat `vbaraw` and export to file
134
+ * @default false
135
+ */
136
+ bookVBA?: boolean;
137
+
138
+ /**
139
+ * When reading a file, store dates as type d (default is n)
140
+ * When writing XLSX/XLSM file, use native date (default uses date codes)
141
+ * @default false
142
+ */
143
+ cellDates?: boolean;
144
+
145
+ /**
146
+ * Create cell objects for stub cells
147
+ * @default false
148
+ */
149
+ sheetStubs?: boolean;
150
+
151
+ /**
152
+ * When reading a file, save style/theme info to the .s field
153
+ * When writing a file, export style/theme info
154
+ * @default false
155
+ */
156
+ cellStyles?: boolean;
157
+
158
+ /**
159
+ * If defined and file is encrypted, use password
160
+ * @default ''
161
+ */
162
+ password?: string;
163
+ }
164
+
165
+ export declare interface DateNFOption {
166
+ /** Use specified date format */
167
+ dateNF?: NumberFormat;
168
+ }
169
+
170
+ /** DBF Field Header */
171
+ export declare interface DBFField {
172
+ /** Original Field Name */
173
+ name?: string;
174
+
175
+ /** Field Type */
176
+ type?: string;
177
+
178
+ /** Field Length */
179
+ len?: number;
180
+
181
+ /** Field Decimal Count */
182
+ dec?: number;
183
+ }
184
+
185
+ /** Defined Name Object */
186
+ export declare interface DefinedName {
187
+ /** Name */
188
+ Name: string;
189
+
190
+ /** Reference */
191
+ Ref: string;
192
+
193
+ /** Scope (undefined for workbook scope) */
194
+ Sheet?: number;
195
+
196
+ /** Name comment */
197
+ Comment?: string;
198
+ }
199
+
200
+ export declare interface DenseOption {
201
+ /** If true, generate dense-mode worksheets */
202
+ dense?: boolean;
203
+ }
204
+
205
+ /** General object representing a dense Sheet (worksheet or chartsheet) */
206
+ export declare interface DenseSheet extends Sheet {
207
+ /**
208
+ * Special keys start with '!'
209
+ * Dense-mode worksheets store data in the '!data' key
210
+ */
211
+ [cell: string]: CellObject[][] | SheetKeys | any;
212
+
213
+ /**
214
+ * Dense-mode worksheets store data in an array of arrays
215
+ *
216
+ * Cells are accessed with sheet['!data'][R][C] (where R and C are 0-indexed)
217
+ */
218
+ '!data': CellObject[][];
219
+ }
220
+
221
+ /** Dense Worksheet Object */
222
+ export declare interface DenseWorkSheet extends DenseSheet {
223
+ /**
224
+ * Dense-mode worksheets store data in an array of arrays
225
+ *
226
+ * Cells are accessed with sheet['!data'][R][C] (where R and C are 0-indexed)
227
+ */
228
+ '!data': CellObject[][];
229
+ }
230
+
231
+ /**
232
+ * The Excel data type for a cell.
233
+ * b Boolean, n Number, e error, s String, d Date, z Stub
234
+ */
235
+ export declare type ExcelDataType = 'b' | 'n' | 'e' | 's' | 'd' | 'z';
236
+
237
+ /** Other supported properties */
238
+ export declare interface FullProperties extends Properties {
239
+ ModifiedDate?: Date;
240
+ Application?: string;
241
+ AppVersion?: string;
242
+ DocSecurity?: string;
243
+ HyperlinksChanged?: boolean;
244
+ SharedDoc?: boolean;
245
+ LinksUpToDate?: boolean;
246
+ ScaleCrop?: boolean;
247
+ Worksheets?: number;
248
+ SheetNames?: string[];
249
+ ContentStatus?: string;
250
+ LastPrinted?: string;
251
+ Revision?: string | number;
252
+ Version?: string;
253
+ Identifier?: string;
254
+ Language?: string;
255
+ }
256
+
257
+ /** Link object */
258
+ export declare interface Hyperlink {
259
+ /** Target of the link (HREF) */
260
+ Target: string;
261
+
262
+ /** Plaintext tooltip to display when mouse is over cell */
263
+ Tooltip?: string;
264
+ }
265
+
266
+ export declare interface JSON2SheetOpts extends CommonOptions, UTCDateOption, DateNFOption, OriginOption, DenseOption {
267
+ /** Use specified column order */
268
+ header?: string[];
269
+
270
+ /** Skip header row in generated sheet */
271
+ skipHeader?: boolean;
272
+ }
273
+
274
+ /** Page Margins -- see Excel Page Setup .. Margins diagram for explanation */
275
+ export declare interface MarginInfo {
276
+ /** Left side margin (inches) */
277
+ left?: number;
278
+ /** Right side margin (inches) */
279
+ right?: number;
280
+ /** Top side margin (inches) */
281
+ top?: number;
282
+ /** Bottom side margin (inches) */
283
+ bottom?: number;
284
+ /** Header top margin (inches) */
285
+ header?: number;
286
+ /** Footer bottom height (inches) */
287
+ footer?: number;
288
+ }
289
+
290
+ /** Number Format (either a string or an index to the format table) */
291
+ export declare type NumberFormat = string | number;
292
+
293
+ export declare interface OriginOption {
294
+ /** Top-Left cell for operation (CellAddress or A1 string or row) */
295
+ origin?: number | string | CellAddress;
296
+ }
297
+
298
+ /** Options for read and readFile */
299
+ export declare interface ParsingOptions extends UTCOption, CommonOptions, DenseOption {
300
+ /** Input data encoding */
301
+ type?: 'base64' | 'binary' | 'buffer' | 'file' | 'array' | 'string';
302
+
303
+ /**
304
+ * Default codepage for legacy files
305
+ *
306
+ * This requires encoding support to be loaded. It is automatically loaded
307
+ * in `xlsx.full.min.js` and in CommonJS / Extendscript, but an extra step
308
+ * is required in React / Angular / Webpack ESM deployments.
309
+ *
310
+ * Check the relevant guide https://docs.sheetjs.com/docs/getting-started/
311
+ */
312
+ codepage?: number;
313
+
314
+ /**
315
+ * Save formulae to the .f field
316
+ * @default true
317
+ */
318
+ cellFormula?: boolean;
319
+
320
+ /**
321
+ * Parse rich text and save HTML to the .h field
322
+ * @default true
323
+ */
324
+ cellHTML?: boolean;
325
+
326
+ /**
327
+ * Save number format string to the .z field
328
+ * @default false
329
+ */
330
+ cellNF?: boolean;
331
+
332
+ /**
333
+ * Generate formatted text to the .w field
334
+ * @default true
335
+ */
336
+ cellText?: boolean;
337
+
338
+ /** Override default date format (code 14) */
339
+ dateNF?: string;
340
+
341
+ /** Field Separator ("Delimiter" override) */
342
+ FS?: string;
343
+
344
+ /**
345
+ * If >0, read the first sheetRows rows
346
+ * @default 0
347
+ */
348
+ sheetRows?: number;
349
+
350
+ /**
351
+ * If true, parse calculation chains
352
+ * @default false
353
+ */
354
+ bookDeps?: boolean;
355
+
356
+ /**
357
+ * If true, add raw files to book object
358
+ * @default false
359
+ */
360
+ bookFiles?: boolean;
361
+
362
+ /**
363
+ * If true, only parse enough to get book metadata
364
+ * @default false
365
+ */
366
+ bookProps?: boolean;
367
+
368
+ /**
369
+ * If true, only parse enough to get the sheet names
370
+ * @default false
371
+ */
372
+ bookSheets?: boolean;
373
+
374
+ /** If specified, only parse the specified sheets or sheet names */
375
+ sheets?: number | string | Array<number | string>;
376
+
377
+ /** If true, plaintext parsing will not parse values */
378
+ raw?: boolean;
379
+
380
+ /** If true, ignore "dimensions" records and guess range using every cell */
381
+ nodim?: boolean;
382
+
383
+ /** If true, preserve _xlfn. prefixes in formula function names */
384
+ xlfn?: boolean;
385
+
386
+ /**
387
+ * For single-sheet formats (including CSV), override the worksheet name
388
+ * @default "Sheet1"
389
+ */
390
+ sheet?: string;
391
+
392
+ PRN?: boolean;
393
+ }
394
+
395
+ /** Basic File Properties */
396
+ export declare interface Properties {
397
+ /** Summary tab "Title" */
398
+ Title?: string;
399
+ /** Summary tab "Subject" */
400
+ Subject?: string;
401
+ /** Summary tab "Author" */
402
+ Author?: string;
403
+ /** Summary tab "Manager" */
404
+ Manager?: string;
405
+ /** Summary tab "Company" */
406
+ Company?: string;
407
+ /** Summary tab "Category" */
408
+ Category?: string;
409
+ /** Summary tab "Keywords" */
410
+ Keywords?: string;
411
+ /** Summary tab "Comments" */
412
+ Comments?: string;
413
+ /** Statistics tab "Last saved by" */
414
+ LastAuthor?: string;
415
+ /** Statistics tab "Created" */
416
+ CreatedDate?: Date;
417
+ }
418
+
419
+ /**
420
+ * Write sheet protection properties.
421
+ */
422
+ export declare interface ProtectInfo {
423
+ /**
424
+ * The password for formats that support password-protected sheets
425
+ * (XLSX/XLSB/XLS). The writer uses the XOR obfuscation method.
426
+ */
427
+ password?: string;
428
+ /**
429
+ * Select locked cells
430
+ * @default: true
431
+ */
432
+ selectLockedCells?: boolean;
433
+ /**
434
+ * Select unlocked cells
435
+ * @default: true
436
+ */
437
+ selectUnlockedCells?: boolean;
438
+ /**
439
+ * Format cells
440
+ * @default: false
441
+ */
442
+ formatCells?: boolean;
443
+ /**
444
+ * Format columns
445
+ * @default: false
446
+ */
447
+ formatColumns?: boolean;
448
+ /**
449
+ * Format rows
450
+ * @default: false
451
+ */
452
+ formatRows?: boolean;
453
+ /**
454
+ * Insert columns
455
+ * @default: false
456
+ */
457
+ insertColumns?: boolean;
458
+ /**
459
+ * Insert rows
460
+ * @default: false
461
+ */
462
+ insertRows?: boolean;
463
+ /**
464
+ * Insert hyperlinks
465
+ * @default: false
466
+ */
467
+ insertHyperlinks?: boolean;
468
+ /**
469
+ * Delete columns
470
+ * @default: false
471
+ */
472
+ deleteColumns?: boolean;
473
+ /**
474
+ * Delete rows
475
+ * @default: false
476
+ */
477
+ deleteRows?: boolean;
478
+ /**
479
+ * Sort
480
+ * @default: false
481
+ */
482
+ sort?: boolean;
483
+ /**
484
+ * Filter
485
+ * @default: false
486
+ */
487
+ autoFilter?: boolean;
488
+ /**
489
+ * Use PivotTable reports
490
+ * @default: false
491
+ */
492
+ pivotTables?: boolean;
493
+ /**
494
+ * Edit objects
495
+ * @default: true
496
+ */
497
+ objects?: boolean;
498
+ /**
499
+ * Edit scenarios
500
+ * @default: true
501
+ */
502
+ scenarios?: boolean;
503
+ }
504
+
505
+ /** Range object (representing ranges like "A1:B2") */
506
+ declare interface Range_2 {
507
+ /** Starting cell */
508
+ s: CellAddress;
509
+ /** Ending cell */
510
+ e: CellAddress;
511
+ }
512
+ export { Range_2 as Range }
513
+
514
+ /** Range specifier (string or range or cell), single-cell lifted to range */
515
+ export declare type RangeSpec = string | Range_2 | CellAddress;
516
+
517
+ /** Attempts to parse data */
518
+ export declare function read(data: any, opts?: ParsingOptions): WorkBook;
519
+
520
+ /** NODE ONLY! Attempts to read filename and parse */
521
+ export declare function readFile(filename: string, opts?: ParsingOptions): WorkBook;
522
+
523
+ /** Row Properties Object */
524
+ export declare interface RowInfo {
525
+ /* --- visibility --- */
526
+
527
+ /** if true, the column is hidden */
528
+ hidden?: boolean;
529
+
530
+ /* --- row height --- */
531
+
532
+ /** height in screen pixels */
533
+ hpx?: number;
534
+
535
+ /** height in points */
536
+ hpt?: number;
537
+
538
+ /** outline / group level */
539
+ level?: number;
540
+ }
541
+
542
+ /** Set internal codepage tables */
543
+ export declare function set_cptable(cptable: any): void;
544
+
545
+ /** Set internal `fs` instance */
546
+ export declare function set_fs(fs: any): void;
547
+
548
+ /** General object representing a Sheet (worksheet or chartsheet) */
549
+ export declare interface Sheet {
550
+ /**
551
+ * Sparse-mode store cells with keys corresponding to A1-style address
552
+ * Dense-mode store cells in the '!data' key
553
+ * Special keys start with '!'
554
+ */
555
+ [cell: string]: CellObject | CellObject[][] | SheetKeys | any;
556
+
557
+ /**
558
+ * Dense-mode worksheets store data in an array of arrays
559
+ *
560
+ * Cells are accessed with sheet['!data'][R][C] (where R and C are 0-indexed)
561
+ */
562
+ '!data'?: CellObject[][];
563
+
564
+ /** Sheet type */
565
+ '!type'?: SheetType;
566
+
567
+ /** Sheet Range (A1-style) */
568
+ '!ref'?: string;
569
+
570
+ /** Page Margins */
571
+ '!margins'?: MarginInfo;
572
+ }
573
+
574
+ export declare interface Sheet2CSVOpts extends DateNFOption {
575
+ /** Field Separator ("delimiter") */
576
+ FS?: string;
577
+
578
+ /** Record Separator ("row separator") */
579
+ RS?: string;
580
+
581
+ /** Remove trailing field separators in each record */
582
+ strip?: boolean;
583
+
584
+ /** Include blank lines in the CSV output */
585
+ blankrows?: boolean;
586
+
587
+ /** Skip hidden rows and columns in the CSV output */
588
+ skipHidden?: boolean;
589
+
590
+ /** Force quotes around fields */
591
+ forceQuotes?: boolean;
592
+
593
+ /** if true, return raw numbers; if false, return formatted numbers */
594
+ rawNumbers?: boolean;
595
+ }
596
+
597
+ export declare interface Sheet2FormulaOpts {
598
+ /**
599
+ * If false, only export cells with formulae.
600
+ * By default, synthetic formulae are generated for each cell.
601
+ */
602
+ values?: boolean;
603
+ }
604
+
605
+ export declare interface Sheet2HTMLOpts {
606
+ /** TABLE element id attribute */
607
+ id?: string;
608
+
609
+ /** Add contenteditable to every cell */
610
+ editable?: boolean;
611
+
612
+ /** Header HTML */
613
+ header?: string;
614
+
615
+ /** Footer HTML */
616
+ footer?: string;
617
+ }
618
+
619
+ export declare interface Sheet2JSONOpts extends DateNFOption {
620
+ /** Output format */
621
+ header?: "A"|number|string[];
622
+
623
+ /** Override worksheet range */
624
+ range?: any;
625
+
626
+ /** Include or omit blank lines in the output */
627
+ blankrows?: boolean;
628
+
629
+ /** Default value for null/undefined values */
630
+ defval?: any;
631
+
632
+ /** if true, return raw data; if false, return formatted text */
633
+ raw?: boolean;
634
+
635
+ /** if true, skip hidden rows and columns */
636
+ skipHidden?: boolean;
637
+
638
+ /** if true, return raw numbers; if false, return formatted numbers */
639
+ rawNumbers?: boolean;
640
+
641
+ /**
642
+ * If true, return dates whose UTC interpretation is correct
643
+ * By default, return dates whose local interpretation is correct
644
+ *
645
+ * @default false
646
+ */
647
+ UTC?: boolean;
648
+ }
649
+
650
+ export declare interface SheetAOAOpts extends AOA2SheetOpts, OriginOption {}
651
+
652
+ export declare type SheetKeys = string | MarginInfo | SheetType;
653
+
654
+ export declare interface SheetProps {
655
+ /** Name of Sheet */
656
+ name?: string;
657
+
658
+ /** Sheet Visibility (0=Visible 1=Hidden 2=VeryHidden) */
659
+ Hidden?: 0 | 1 | 2;
660
+
661
+ /** Name of Document Module in associated VBA Project */
662
+ CodeName?: string;
663
+ }
664
+
665
+ export declare type SheetType = 'sheet' | 'chart';
666
+
667
+ /** General object representing a sparse Sheet (worksheet or chartsheet) */
668
+ export declare interface SparseSheet extends Sheet {
669
+ /**
670
+ * Sparse-mode store cells with keys corresponding to A1-style address
671
+ * Cells are accessed with sheet[addr]
672
+ */
673
+ '!data': never;
674
+ }
675
+
676
+ /** SSF Formatter Library */
677
+ export declare const SSF: any;
678
+
679
+ /** Stream Utility Functions */
680
+ export declare const stream: StreamUtils;
681
+
682
+ /**
683
+ * Streaming write methods
684
+ *
685
+ * These methods are directly compatible with NodeJS `stream.Readable` API
686
+ *
687
+ * Web Streams (modern browsers) can play nice with NodeJS streams. See the Web
688
+ * Demo at https://docs.sheetjs.com/docs/demos/bigdata/worker#streaming-write
689
+ *
690
+ * NOTE: These methods are not included in the `xlsx.mini.min.js` build!
691
+ */
692
+ export declare interface StreamUtils {
693
+ /** Set `Readable` (for environments that do not support NodeJS Streams) */
694
+ set_readable(Readable: any): void;
695
+
696
+ /* --- Worksheet writers --- */
697
+
698
+ /** CSV output stream, generate one line at a time */
699
+ to_csv(sheet: WorkSheet, opts?: Sheet2CSVOpts): any;
700
+ /** HTML output stream, generate one line at a time */
701
+ to_html(sheet: WorkSheet, opts?: Sheet2HTMLOpts): any;
702
+ /** JSON object stream, generate one row at a time */
703
+ to_json(sheet: WorkSheet, opts?: Sheet2JSONOpts): any;
704
+
705
+ /* --- Workbook writers --- */
706
+
707
+ /** XLML output string stream (bookType `xlml`) */
708
+ to_xlml(data: WorkBook, opts?: XLMLStreamOpts): any;
709
+ }
710
+
711
+ /**
712
+ * Worksheet Object with CellObject type
713
+ *
714
+ * The normal Worksheet type uses indexer of type `any` -- this enforces CellObject
715
+ */
716
+ export declare interface StrictWS { [addr: string]: CellObject; }
717
+
718
+ export declare interface StrideOption {
719
+ /** Number of rows to write per step */
720
+ stride?: number;
721
+ }
722
+
723
+ export declare interface Table2BookOpts extends Table2SheetOpts {
724
+ /**
725
+ * Override the worksheet name
726
+ * @default "Sheet1"
727
+ */
728
+ sheet?: string;
729
+ }
730
+
731
+ export declare interface Table2SheetOpts extends CommonOptions, DateNFOption, OriginOption {
732
+ /** If true, plaintext parsing will not parse values */
733
+ raw?: boolean;
734
+
735
+ /**
736
+ * If >0, read the first sheetRows rows
737
+ * @default 0
738
+ */
739
+ sheetRows?: number;
740
+
741
+ /** If true, hidden rows and cells will not be parsed */
742
+ display?: boolean;
743
+
744
+ /**
745
+ * Override the worksheet name
746
+ * @default "Sheet1"
747
+ */
748
+ sheet?: string;
749
+
750
+ /**
751
+ * If true, interpret date strings as if they are UTC.
752
+ * By default, date strings are interpreted in the local timezone.
753
+ *
754
+ * @default false
755
+ */
756
+ UTC?: boolean;
757
+ }
758
+
759
+ export declare interface UTCDateOption {
760
+ /**
761
+ * If true, dates are interpreted using the UTC methods
762
+ * By default, dates are interpreted in the local timezone
763
+ *
764
+ * @default false
765
+ */
766
+ UTC?: boolean;
767
+ }
768
+
769
+ export declare interface UTCOption {
770
+ /**
771
+ * For plaintext formats, interpret ambiguous datetimes in UTC
772
+ * If explicitly set to `false`, dates will be parsed in local time.
773
+ *
774
+ * The `true` option is consistent with spreadsheet application export.
775
+ *
776
+ * @default true
777
+ */
778
+ UTC?: boolean;
779
+ }
780
+
781
+ /** Utility Functions */
782
+ export declare const utils: XLSX$Utils;
783
+
784
+ /** Version string */
785
+ export declare const version: string;
786
+
787
+ /** Workbook-Level Attributes */
788
+ export declare interface WBProps {
789
+ /** Sheet Properties */
790
+ Sheets?: SheetProps[];
791
+
792
+ /** Defined Names */
793
+ Names?: DefinedName[];
794
+
795
+ /** Workbook Views */
796
+ Views?: WBView[];
797
+
798
+ /** Other Workbook Properties */
799
+ WBProps?: WorkbookProperties;
800
+ }
801
+
802
+ /** Workbook View */
803
+ export declare interface WBView {
804
+ /** Right-to-left mode */
805
+ RTL?: boolean;
806
+ }
807
+
808
+ /** Workbook Object */
809
+ export declare interface WorkBook {
810
+ /**
811
+ * A dictionary of the worksheets in the workbook.
812
+ * Use SheetNames to reference these.
813
+ */
814
+ Sheets: { [sheet: string]: WorkSheet };
815
+
816
+ /** Ordered list of the sheet names in the workbook */
817
+ SheetNames: string[];
818
+
819
+ /** Standard workbook Properties */
820
+ Props?: FullProperties;
821
+
822
+ /** Custom workbook Properties */
823
+ Custprops?: object;
824
+
825
+ Workbook?: WBProps;
826
+
827
+ vbaraw?: any;
828
+
829
+ /** Original file type (when parsed with `read` or `readFile`) */
830
+ bookType?: BookType;
831
+ }
832
+
833
+ /** Other Workbook Properties */
834
+ export declare interface WorkbookProperties {
835
+ /** Worksheet Epoch (1904 if true, 1900 if false) */
836
+ date1904?: boolean;
837
+
838
+ /** Warn or strip personally identifying info on save */
839
+ filterPrivacy?: boolean;
840
+
841
+ /** Name of Document Module in associated VBA Project */
842
+ CodeName?: string;
843
+ }
844
+
845
+ /** Worksheet Object */
846
+ export declare interface WorkSheet extends Sheet {
847
+ /**
848
+ * Indexing with a cell address string maps to a cell object
849
+ * Special keys start with '!'
850
+ */
851
+ [cell: string]: CellObject | WSKeys | any;
852
+
853
+ /** Column Info */
854
+ '!cols'?: ColInfo[];
855
+
856
+ /** Row Info */
857
+ '!rows'?: RowInfo[];
858
+
859
+ /** Merge Ranges */
860
+ '!merges'?: Range_2[];
861
+
862
+ /** Worksheet Protection info */
863
+ '!protect'?: ProtectInfo;
864
+
865
+ /** AutoFilter info */
866
+ '!autofilter'?: AutoFilterInfo;
867
+ }
868
+
869
+ /** Attempts to write the workbook data */
870
+ export declare function write(data: WorkBook, opts: WritingOptions): any;
871
+
872
+ /** Attempts to write or download workbook data to file */
873
+ export declare function writeFile(data: WorkBook, filename: string, opts?: WritingOptions): void;
874
+
875
+ export declare function writeFileAsync(filename: string, data: WorkBook, opts: WritingOptions | CBFunc, cb?: CBFunc): void;
876
+
877
+ /** Attempts to write or download workbook data to XLSX file */
878
+ export declare function writeFileXLSX(data: WorkBook, filename: string, opts?: WritingOptions): void;
879
+
880
+ /** Attempts to write the workbook data as XLSX */
881
+ export declare function writeXLSX(data: WorkBook, opts: WritingOptions): any;
882
+
883
+ /** Options for write and writeFile */
884
+ export declare interface WritingOptions extends CommonOptions {
885
+ /** Output data encoding */
886
+ type?: 'base64' | 'binary' | 'buffer' | 'file' | 'array' | 'string';
887
+
888
+ /**
889
+ * Generate Shared String Table
890
+ * @default false
891
+ */
892
+ bookSST?: boolean;
893
+
894
+ /**
895
+ * File format of generated workbook
896
+ * @default 'xlsx'
897
+ */
898
+ bookType?: BookType;
899
+
900
+ /**
901
+ * Use ZIP compression for ZIP-based formats
902
+ * @default false
903
+ */
904
+ compression?: boolean;
905
+
906
+ /** Override theme XML when exporting to XLSX/XLSM/XLSB */
907
+ themeXLSX?: string;
908
+
909
+ /**
910
+ * Suppress "number stored as text" errors in generated files
911
+ * @default true
912
+ */
913
+ ignoreEC?: boolean;
914
+
915
+ /** Override workbook properties on save */
916
+ Props?: Properties;
917
+
918
+ /**
919
+ * Desired codepage for legacy file formats
920
+ *
921
+ * This requires encoding support to be loaded. It is automatically loaded
922
+ * in `xlsx.full.min.js` and in CommonJS / Extendscript, but an extra step
923
+ * is required in React / Angular / Webpack / ESM deployments.
924
+ *
925
+ * Check the relevant guide https://docs.sheetjs.com/docs/getting-started/
926
+ */
927
+ codepage?: number;
928
+
929
+ /** Base64 encoding of NUMBERS base for exports */
930
+ numbers?: string;
931
+
932
+ /**
933
+ * For single-sheet formats, export the specified worksheet.
934
+ *
935
+ * The property must be a string (sheet name) or number (`SheetNames` index).
936
+ *
937
+ * If this option is omitted, the first worksheet will be exported.
938
+ */
939
+ sheet?: string | number;
940
+
941
+ /** Field Separator ("delimiter") for CSV / Text output */
942
+ FS?: string;
943
+
944
+ /** Record Separator ("row separator") for CSV / Text output */
945
+ RS?: string;
946
+ }
947
+
948
+ export declare type WSKeys = SheetKeys | ColInfo[] | RowInfo[] | Range_2[] | ProtectInfo | AutoFilterInfo;
949
+
950
+ /** Worksheet specifier (string, number, worksheet) */
951
+ export declare type WSSpec = string | number | WorkSheet;
952
+
953
+ export declare interface XLMLStreamOpts extends WritingOptions, StrideOption {}
954
+
955
+ export declare interface XLSX$Consts {
956
+ /* --- Sheet Visibility --- */
957
+
958
+ /** Visibility: Visible */
959
+ SHEET_VISIBLE: 0;
960
+
961
+ /** Visibility: Hidden */
962
+ SHEET_HIDDEN: 1;
963
+
964
+ /** Visibility: Very Hidden */
965
+ SHEET_VERYHIDDEN: 2;
966
+ }
967
+
968
+ /** General utilities */
969
+ export declare interface XLSX$Utils {
970
+ /* --- Import Functions --- */
971
+
972
+ /** Converts an array of arrays of JS data to a worksheet. */
973
+ aoa_to_sheet<T>(data: T[][], opts?: AOA2SheetOpts): WorkSheet;
974
+ aoa_to_sheet(data: any[][], opts?: AOA2SheetOpts): WorkSheet;
975
+
976
+ /** Converts an array of JS objects to a worksheet. */
977
+ json_to_sheet<T>(data: T[], opts?: JSON2SheetOpts): WorkSheet;
978
+ json_to_sheet(data: any[], opts?: JSON2SheetOpts): WorkSheet;
979
+
980
+ /** BROWSER ONLY! Converts a TABLE DOM element to a worksheet. */
981
+ table_to_sheet(data: any, opts?: Table2SheetOpts): WorkSheet;
982
+ table_to_book(data: any, opts?: Table2BookOpts): WorkBook;
983
+ sheet_add_dom(ws: WorkSheet, data: any, opts?: Table2SheetOpts): WorkSheet;
984
+
985
+ /* --- Export Functions --- */
986
+
987
+ /** Converts a worksheet object to an array of JSON objects */
988
+ sheet_to_json<T>(worksheet: WorkSheet, opts?: Sheet2JSONOpts): T[];
989
+ sheet_to_json(worksheet: WorkSheet, opts?: Sheet2JSONOpts): any[][];
990
+ sheet_to_json(worksheet: WorkSheet, opts?: Sheet2JSONOpts): any[];
991
+
992
+ /** Generates delimiter-separated-values output */
993
+ sheet_to_csv(worksheet: WorkSheet, options?: Sheet2CSVOpts): string;
994
+
995
+ /** Generates UTF16 Formatted Text */
996
+ sheet_to_txt(worksheet: WorkSheet, options?: Sheet2CSVOpts): string;
997
+
998
+ /** Generates HTML */
999
+ sheet_to_html(worksheet: WorkSheet, options?: Sheet2HTMLOpts): string;
1000
+
1001
+ /** Generates a list of the formulae (with value fallbacks) */
1002
+ sheet_to_formulae(worksheet: WorkSheet, options?: Sheet2FormulaOpts): string[];
1003
+
1004
+ /* --- Cell Address Utilities --- */
1005
+
1006
+ /** Converts 0-indexed cell address to A1 form */
1007
+ encode_cell(cell: CellAddress): string;
1008
+
1009
+ /** Converts 0-indexed row to A1 form */
1010
+ encode_row(row: number): string;
1011
+
1012
+ /** Converts 0-indexed column to A1 form */
1013
+ encode_col(col: number): string;
1014
+
1015
+ /** Converts 0-indexed range to A1 form */
1016
+ encode_range(s: CellAddress, e: CellAddress): string;
1017
+ encode_range(r: Range_2): string;
1018
+
1019
+ /** Converts A1 cell address to 0-indexed form */
1020
+ decode_cell(address: string): CellAddress;
1021
+
1022
+ /** Converts A1 row to 0-indexed form */
1023
+ decode_row(row: string): number;
1024
+
1025
+ /** Converts A1 column to 0-indexed form */
1026
+ decode_col(col: string): number;
1027
+
1028
+ /** Converts A1 range to 0-indexed form */
1029
+ decode_range(range: string): Range_2;
1030
+
1031
+ /** Format cell */
1032
+ format_cell(cell: CellObject, v?: any, opts?: any): string;
1033
+
1034
+ /* --- General Utilities --- */
1035
+
1036
+ /** Create a new workbook */
1037
+ book_new(ws?: WorkSheet, wsname?: string): WorkBook;
1038
+
1039
+ /** Create a new worksheet */
1040
+ sheet_new(opts?: DenseOption): WorkSheet;
1041
+
1042
+ /** Append a worksheet to a workbook, returns new worksheet name */
1043
+ book_append_sheet(workbook: WorkBook, worksheet: WorkSheet, name?: string, roll?: boolean): string;
1044
+
1045
+ /** Set sheet visibility (visible/hidden/very hidden) */
1046
+ book_set_sheet_visibility(workbook: WorkBook, sheet: number|string, visibility: number): void;
1047
+
1048
+ /** Set number format for a cell */
1049
+ cell_set_number_format(cell: CellObject, fmt: string|number): CellObject;
1050
+
1051
+ /** Set hyperlink for a cell */
1052
+ cell_set_hyperlink(cell: CellObject, target: string, tooltip?: string): CellObject;
1053
+
1054
+ /** Set internal link for a cell */
1055
+ cell_set_internal_link(cell: CellObject, target: string, tooltip?: string): CellObject;
1056
+
1057
+ /** Add comment to a cell */
1058
+ cell_add_comment(cell: CellObject, text: string, author?: string): void;
1059
+
1060
+ /** Assign an Array Formula to a range */
1061
+ sheet_set_array_formula(ws: WorkSheet, range: Range_2|string, formula: string, dynamic?: boolean): WorkSheet;
1062
+
1063
+ /** Add an array of arrays of JS data to a worksheet */
1064
+ sheet_add_aoa<T>(ws: WorkSheet, data: T[][], opts?: SheetAOAOpts): WorkSheet;
1065
+ sheet_add_aoa(ws: WorkSheet, data: any[][], opts?: SheetAOAOpts): WorkSheet;
1066
+
1067
+ /** Add an array of JS objects to a worksheet */
1068
+ sheet_add_json(ws: WorkSheet, data: any[], opts?: JSON2SheetOpts): WorkSheet;
1069
+ sheet_add_json<T>(ws: WorkSheet, data: T[], opts?: JSON2SheetOpts): WorkSheet;
1070
+
1071
+
1072
+ consts: XLSX$Consts;
1073
+ }
1074
+
1075
+ export { }