@fgv/ts-web-extras 5.1.0-3 → 5.1.0-31

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 (275) hide show
  1. package/dist/packlets/crypto-utils/browserCryptoProvider.js +330 -18
  2. package/dist/packlets/crypto-utils/browserCryptoProvider.js.map +1 -1
  3. package/dist/packlets/crypto-utils/index.js +12 -0
  4. package/dist/packlets/crypto-utils/index.js.map +1 -1
  5. package/dist/packlets/file-tree/directoryHandleStore.js.map +1 -1
  6. package/dist/packlets/file-tree/fileApiTreeAccessors.js +1 -1
  7. package/dist/packlets/file-tree/fileApiTreeAccessors.js.map +1 -1
  8. package/dist/packlets/file-tree/fileSystemAccessTreeAccessors.js +2 -2
  9. package/dist/packlets/file-tree/fileSystemAccessTreeAccessors.js.map +1 -1
  10. package/dist/packlets/file-tree/httpTreeAccessors.js +74 -44
  11. package/dist/packlets/file-tree/httpTreeAccessors.js.map +1 -1
  12. package/dist/packlets/file-tree/localStorageTreeAccessors.js.map +1 -1
  13. package/dist/packlets/helpers/fileTreeHelpers.js +1 -1
  14. package/dist/packlets/helpers/fileTreeHelpers.js.map +1 -1
  15. package/dist/ts-web-extras.d.ts +141 -10
  16. package/dist/tsdoc-metadata.json +1 -1
  17. package/eslint.config.js +32 -0
  18. package/lib/packlets/crypto-utils/browserCryptoProvider.d.ts +115 -6
  19. package/lib/packlets/crypto-utils/browserCryptoProvider.d.ts.map +1 -1
  20. package/lib/packlets/crypto-utils/browserCryptoProvider.js +329 -17
  21. package/lib/packlets/crypto-utils/browserCryptoProvider.js.map +1 -1
  22. package/lib/packlets/crypto-utils/index.d.ts +13 -0
  23. package/lib/packlets/crypto-utils/index.d.ts.map +1 -1
  24. package/lib/packlets/crypto-utils/index.js +13 -0
  25. package/lib/packlets/crypto-utils/index.js.map +1 -1
  26. package/lib/packlets/file-tree/directoryHandleStore.d.ts +2 -2
  27. package/lib/packlets/file-tree/directoryHandleStore.d.ts.map +1 -1
  28. package/lib/packlets/file-tree/directoryHandleStore.js.map +1 -1
  29. package/lib/packlets/file-tree/fileApiTreeAccessors.d.ts +2 -2
  30. package/lib/packlets/file-tree/fileApiTreeAccessors.d.ts.map +1 -1
  31. package/lib/packlets/file-tree/fileApiTreeAccessors.js +1 -1
  32. package/lib/packlets/file-tree/fileApiTreeAccessors.js.map +1 -1
  33. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.d.ts.map +1 -1
  34. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.js +2 -2
  35. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.js.map +1 -1
  36. package/lib/packlets/file-tree/httpTreeAccessors.d.ts +6 -0
  37. package/lib/packlets/file-tree/httpTreeAccessors.d.ts.map +1 -1
  38. package/lib/packlets/file-tree/httpTreeAccessors.js +74 -44
  39. package/lib/packlets/file-tree/httpTreeAccessors.js.map +1 -1
  40. package/lib/packlets/file-tree/localStorageTreeAccessors.js.map +1 -1
  41. package/lib/packlets/helpers/fileTreeHelpers.d.ts +1 -1
  42. package/lib/packlets/helpers/fileTreeHelpers.d.ts.map +1 -1
  43. package/lib/packlets/helpers/fileTreeHelpers.js +6 -6
  44. package/lib/packlets/helpers/fileTreeHelpers.js.map +1 -1
  45. package/package.json +16 -15
  46. package/.rush/temp/61c1d4a91d98f048b475a5bb3e6541c5d27819de.tar.log +0 -237
  47. package/.rush/temp/chunked-rush-logs/ts-web-extras.build.chunks.jsonl +0 -55
  48. package/.rush/temp/operation/build/all.log +0 -55
  49. package/.rush/temp/operation/build/log-chunks.jsonl +0 -55
  50. package/.rush/temp/operation/build/state.json +0 -3
  51. package/.rush/temp/shrinkwrap-deps.json +0 -635
  52. package/CHANGELOG.md +0 -23
  53. package/config/api-extractor.json +0 -343
  54. package/config/jest.config.json +0 -19
  55. package/config/rig.json +0 -16
  56. package/config/typedoc.json +0 -6
  57. package/dist/test/mocks/idb-keyval.js +0 -6
  58. package/dist/test/mocks/idb-keyval.js.map +0 -1
  59. package/dist/test/setupTests.js +0 -74
  60. package/dist/test/setupTests.js.map +0 -1
  61. package/dist/test/unit/browserHashProvider.test.js +0 -140
  62. package/dist/test/unit/browserHashProvider.test.js.map +0 -1
  63. package/dist/test/unit/directoryHandleStore.test.js +0 -190
  64. package/dist/test/unit/directoryHandleStore.test.js.map +0 -1
  65. package/dist/test/unit/fileApiTreeAccessors.test.js +0 -1188
  66. package/dist/test/unit/fileApiTreeAccessors.test.js.map +0 -1
  67. package/dist/test/unit/fileApiTypes.test.js +0 -472
  68. package/dist/test/unit/fileApiTypes.test.js.map +0 -1
  69. package/dist/test/unit/fileSystemAccessTreeAccessors.test.js +0 -622
  70. package/dist/test/unit/fileSystemAccessTreeAccessors.test.js.map +0 -1
  71. package/dist/test/unit/fileTreeHelpers.test.js +0 -590
  72. package/dist/test/unit/fileTreeHelpers.test.js.map +0 -1
  73. package/dist/test/unit/httpTreeAccessors.test.js +0 -1229
  74. package/dist/test/unit/httpTreeAccessors.test.js.map +0 -1
  75. package/dist/test/unit/localStorageTreeAccessors.test.js +0 -812
  76. package/dist/test/unit/localStorageTreeAccessors.test.js.map +0 -1
  77. package/dist/test/unit/urlParams.test.js +0 -393
  78. package/dist/test/unit/urlParams.test.js.map +0 -1
  79. package/dist/test/utils/fileSystemAccessMocks.js +0 -271
  80. package/dist/test/utils/fileSystemAccessMocks.js.map +0 -1
  81. package/dist/test/utils/testHelpers.js +0 -124
  82. package/dist/test/utils/testHelpers.js.map +0 -1
  83. package/docs/@fgv/namespaces/CryptoUtils/README.md +0 -18
  84. package/docs/@fgv/namespaces/CryptoUtils/classes/BrowserCryptoProvider.md +0 -203
  85. package/docs/@fgv/namespaces/CryptoUtils/classes/BrowserHashProvider.md +0 -63
  86. package/docs/@fgv/namespaces/CryptoUtils/functions/createBrowserCryptoProvider.md +0 -18
  87. package/docs/@fgv/namespaces/FileTreeHelpers/README.md +0 -19
  88. package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileListMetadata.md +0 -23
  89. package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileMetadata.md +0 -23
  90. package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromDirectoryUpload.md +0 -33
  91. package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromFileList.md +0 -33
  92. package/docs/@fgv/namespaces/FileTreeHelpers/functions/getOriginalFile.md +0 -25
  93. package/docs/@fgv/namespaces/FileTreeHelpers/variables/defaultFileApiTreeInitParams.md +0 -11
  94. package/docs/README.md +0 -78
  95. package/docs/classes/DirectoryHandleStore.md +0 -116
  96. package/docs/classes/FileApiTreeAccessors.md +0 -286
  97. package/docs/classes/FileSystemAccessTreeAccessors.md +0 -557
  98. package/docs/classes/HttpTreeAccessors.md +0 -508
  99. package/docs/classes/LocalStorageTreeAccessors.md +0 -520
  100. package/docs/functions/exportAsJson.md +0 -23
  101. package/docs/functions/exportUsingFileSystemAPI.md +0 -26
  102. package/docs/functions/extractDirectoryPath.md +0 -23
  103. package/docs/functions/isDirectoryHandle.md +0 -23
  104. package/docs/functions/isFileHandle.md +0 -23
  105. package/docs/functions/isFilePath.md +0 -21
  106. package/docs/functions/parseContextFilter.md +0 -22
  107. package/docs/functions/parseQualifierDefaults.md +0 -22
  108. package/docs/functions/parseResourceTypes.md +0 -22
  109. package/docs/functions/parseUrlParameters.md +0 -15
  110. package/docs/functions/safeShowDirectoryPicker.md +0 -24
  111. package/docs/functions/safeShowOpenFilePicker.md +0 -24
  112. package/docs/functions/safeShowSaveFilePicker.md +0 -24
  113. package/docs/functions/supportsFileSystemAccess.md +0 -23
  114. package/docs/interfaces/FilePickerAcceptType.md +0 -16
  115. package/docs/interfaces/FileSystemCreateWritableOptions.md +0 -15
  116. package/docs/interfaces/FileSystemDirectoryHandle.md +0 -187
  117. package/docs/interfaces/FileSystemFileHandle.md +0 -106
  118. package/docs/interfaces/FileSystemGetDirectoryOptions.md +0 -15
  119. package/docs/interfaces/FileSystemGetFileOptions.md +0 -15
  120. package/docs/interfaces/FileSystemHandle.md +0 -69
  121. package/docs/interfaces/FileSystemHandlePermissionDescriptor.md +0 -15
  122. package/docs/interfaces/FileSystemRemoveOptions.md +0 -15
  123. package/docs/interfaces/FileSystemWritableFileStream.md +0 -127
  124. package/docs/interfaces/IDirectoryHandleTreeInitializer.md +0 -17
  125. package/docs/interfaces/IFileHandleTreeInitializer.md +0 -16
  126. package/docs/interfaces/IFileListTreeInitializer.md +0 -15
  127. package/docs/interfaces/IFileMetadata.md +0 -19
  128. package/docs/interfaces/IFileSystemAccessTreeParams.md +0 -30
  129. package/docs/interfaces/IFsAccessApis.md +0 -57
  130. package/docs/interfaces/IHttpTreeParams.md +0 -32
  131. package/docs/interfaces/ILocalStorageTreeParams.md +0 -30
  132. package/docs/interfaces/IUrlConfigOptions.md +0 -27
  133. package/docs/interfaces/ShowDirectoryPickerOptions.md +0 -17
  134. package/docs/interfaces/ShowOpenFilePickerOptions.md +0 -19
  135. package/docs/interfaces/ShowSaveFilePickerOptions.md +0 -19
  136. package/docs/type-aliases/TreeInitializer.md +0 -11
  137. package/docs/type-aliases/WellKnownDirectory.md +0 -11
  138. package/docs/type-aliases/WindowWithFsAccess.md +0 -11
  139. package/docs/variables/DEFAULT_DIRECTORY_HANDLE_DB.md +0 -11
  140. package/docs/variables/DEFAULT_DIRECTORY_HANDLE_STORE.md +0 -11
  141. package/etc/ts-web-extras.api.md +0 -433
  142. package/lib/test/mocks/idb-keyval.d.ts +0 -6
  143. package/lib/test/mocks/idb-keyval.d.ts.map +0 -1
  144. package/lib/test/mocks/idb-keyval.js +0 -9
  145. package/lib/test/mocks/idb-keyval.js.map +0 -1
  146. package/lib/test/setupTests.d.ts +0 -2
  147. package/lib/test/setupTests.d.ts.map +0 -1
  148. package/lib/test/setupTests.js +0 -76
  149. package/lib/test/setupTests.js.map +0 -1
  150. package/lib/test/unit/browserHashProvider.test.d.ts +0 -2
  151. package/lib/test/unit/browserHashProvider.test.d.ts.map +0 -1
  152. package/lib/test/unit/browserHashProvider.test.js +0 -142
  153. package/lib/test/unit/browserHashProvider.test.js.map +0 -1
  154. package/lib/test/unit/directoryHandleStore.test.d.ts +0 -2
  155. package/lib/test/unit/directoryHandleStore.test.d.ts.map +0 -1
  156. package/lib/test/unit/directoryHandleStore.test.js +0 -192
  157. package/lib/test/unit/directoryHandleStore.test.js.map +0 -1
  158. package/lib/test/unit/fileApiTreeAccessors.test.d.ts +0 -2
  159. package/lib/test/unit/fileApiTreeAccessors.test.d.ts.map +0 -1
  160. package/lib/test/unit/fileApiTreeAccessors.test.js +0 -1190
  161. package/lib/test/unit/fileApiTreeAccessors.test.js.map +0 -1
  162. package/lib/test/unit/fileApiTypes.test.d.ts +0 -2
  163. package/lib/test/unit/fileApiTypes.test.d.ts.map +0 -1
  164. package/lib/test/unit/fileApiTypes.test.js +0 -474
  165. package/lib/test/unit/fileApiTypes.test.js.map +0 -1
  166. package/lib/test/unit/fileSystemAccessTreeAccessors.test.d.ts +0 -2
  167. package/lib/test/unit/fileSystemAccessTreeAccessors.test.d.ts.map +0 -1
  168. package/lib/test/unit/fileSystemAccessTreeAccessors.test.js +0 -624
  169. package/lib/test/unit/fileSystemAccessTreeAccessors.test.js.map +0 -1
  170. package/lib/test/unit/fileTreeHelpers.test.d.ts +0 -2
  171. package/lib/test/unit/fileTreeHelpers.test.d.ts.map +0 -1
  172. package/lib/test/unit/fileTreeHelpers.test.js +0 -592
  173. package/lib/test/unit/fileTreeHelpers.test.js.map +0 -1
  174. package/lib/test/unit/httpTreeAccessors.test.d.ts +0 -2
  175. package/lib/test/unit/httpTreeAccessors.test.d.ts.map +0 -1
  176. package/lib/test/unit/httpTreeAccessors.test.js +0 -1231
  177. package/lib/test/unit/httpTreeAccessors.test.js.map +0 -1
  178. package/lib/test/unit/localStorageTreeAccessors.test.d.ts +0 -2
  179. package/lib/test/unit/localStorageTreeAccessors.test.d.ts.map +0 -1
  180. package/lib/test/unit/localStorageTreeAccessors.test.js +0 -814
  181. package/lib/test/unit/localStorageTreeAccessors.test.js.map +0 -1
  182. package/lib/test/unit/urlParams.test.d.ts +0 -2
  183. package/lib/test/unit/urlParams.test.d.ts.map +0 -1
  184. package/lib/test/unit/urlParams.test.js +0 -395
  185. package/lib/test/unit/urlParams.test.js.map +0 -1
  186. package/lib/test/utils/fileSystemAccessMocks.d.ts +0 -53
  187. package/lib/test/utils/fileSystemAccessMocks.d.ts.map +0 -1
  188. package/lib/test/utils/fileSystemAccessMocks.js +0 -277
  189. package/lib/test/utils/fileSystemAccessMocks.js.map +0 -1
  190. package/lib/test/utils/testHelpers.d.ts +0 -51
  191. package/lib/test/utils/testHelpers.d.ts.map +0 -1
  192. package/lib/test/utils/testHelpers.js +0 -133
  193. package/lib/test/utils/testHelpers.js.map +0 -1
  194. package/rush-logs/ts-web-extras.build.cache.log +0 -3
  195. package/rush-logs/ts-web-extras.build.log +0 -55
  196. package/src/index.browser.ts +0 -24
  197. package/src/index.ts +0 -47
  198. package/src/packlets/crypto-utils/browserCryptoProvider.ts +0 -311
  199. package/src/packlets/crypto-utils/browserHashProvider.ts +0 -73
  200. package/src/packlets/crypto-utils/index.ts +0 -29
  201. package/src/packlets/file-api-types/index.ts +0 -366
  202. package/src/packlets/file-tree/directoryHandleStore.ts +0 -136
  203. package/src/packlets/file-tree/fileApiTreeAccessors.ts +0 -528
  204. package/src/packlets/file-tree/fileSystemAccessTreeAccessors.ts +0 -519
  205. package/src/packlets/file-tree/httpTreeAccessors.ts +0 -448
  206. package/src/packlets/file-tree/index.ts +0 -32
  207. package/src/packlets/file-tree/localStorageTreeAccessors.ts +0 -430
  208. package/src/packlets/helpers/fileTreeHelpers.ts +0 -107
  209. package/src/packlets/helpers/index.ts +0 -28
  210. package/src/packlets/url-utils/index.ts +0 -28
  211. package/src/packlets/url-utils/urlParams.ts +0 -245
  212. package/src/test/mocks/idb-keyval.ts +0 -5
  213. package/src/test/setupTests.ts +0 -87
  214. package/src/test/unit/browserHashProvider.test.ts +0 -155
  215. package/src/test/unit/browserHashProvider.test.ts.bak +0 -376
  216. package/src/test/unit/directoryHandleStore.test.ts +0 -251
  217. package/src/test/unit/fileApiTreeAccessors.test.ts +0 -1387
  218. package/src/test/unit/fileApiTypes.test.ts +0 -587
  219. package/src/test/unit/fileSystemAccessTreeAccessors.test.ts +0 -885
  220. package/src/test/unit/fileTreeHelpers.test.ts +0 -694
  221. package/src/test/unit/httpTreeAccessors.test.ts +0 -1571
  222. package/src/test/unit/localStorageTreeAccessors.test.ts +0 -1014
  223. package/src/test/unit/urlParams.test.ts +0 -464
  224. package/src/test/utils/fileSystemAccessMocks.ts +0 -353
  225. package/src/test/utils/testHelpers.ts +0 -155
  226. package/temp/build/typescript/ts_8nwakTlr.json +0 -1
  227. package/temp/coverage/base.css +0 -224
  228. package/temp/coverage/block-navigation.js +0 -87
  229. package/temp/coverage/crypto-utils/browserCryptoProvider.ts.html +0 -1018
  230. package/temp/coverage/crypto-utils/browserHashProvider.ts.html +0 -304
  231. package/temp/coverage/crypto-utils/index.html +0 -131
  232. package/temp/coverage/favicon.png +0 -0
  233. package/temp/coverage/file-tree/directoryHandleStore.ts.html +0 -493
  234. package/temp/coverage/file-tree/fileApiTreeAccessors.ts.html +0 -1669
  235. package/temp/coverage/file-tree/fileSystemAccessTreeAccessors.ts.html +0 -1642
  236. package/temp/coverage/file-tree/httpTreeAccessors.ts.html +0 -1429
  237. package/temp/coverage/file-tree/index.html +0 -176
  238. package/temp/coverage/file-tree/localStorageTreeAccessors.ts.html +0 -1375
  239. package/temp/coverage/helpers/fileTreeHelpers.ts.html +0 -406
  240. package/temp/coverage/helpers/index.html +0 -116
  241. package/temp/coverage/index.html +0 -161
  242. package/temp/coverage/lcov-report/base.css +0 -224
  243. package/temp/coverage/lcov-report/block-navigation.js +0 -87
  244. package/temp/coverage/lcov-report/crypto-utils/browserCryptoProvider.ts.html +0 -1018
  245. package/temp/coverage/lcov-report/crypto-utils/browserHashProvider.ts.html +0 -304
  246. package/temp/coverage/lcov-report/crypto-utils/index.html +0 -131
  247. package/temp/coverage/lcov-report/favicon.png +0 -0
  248. package/temp/coverage/lcov-report/file-tree/directoryHandleStore.ts.html +0 -493
  249. package/temp/coverage/lcov-report/file-tree/fileApiTreeAccessors.ts.html +0 -1669
  250. package/temp/coverage/lcov-report/file-tree/fileSystemAccessTreeAccessors.ts.html +0 -1642
  251. package/temp/coverage/lcov-report/file-tree/httpTreeAccessors.ts.html +0 -1429
  252. package/temp/coverage/lcov-report/file-tree/index.html +0 -176
  253. package/temp/coverage/lcov-report/file-tree/localStorageTreeAccessors.ts.html +0 -1375
  254. package/temp/coverage/lcov-report/helpers/fileTreeHelpers.ts.html +0 -406
  255. package/temp/coverage/lcov-report/helpers/index.html +0 -116
  256. package/temp/coverage/lcov-report/index.html +0 -161
  257. package/temp/coverage/lcov-report/prettify.css +0 -1
  258. package/temp/coverage/lcov-report/prettify.js +0 -2
  259. package/temp/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  260. package/temp/coverage/lcov-report/sorter.js +0 -210
  261. package/temp/coverage/lcov-report/url-utils/index.html +0 -116
  262. package/temp/coverage/lcov-report/url-utils/urlParams.ts.html +0 -820
  263. package/temp/coverage/lcov.info +0 -3597
  264. package/temp/coverage/prettify.css +0 -1
  265. package/temp/coverage/prettify.js +0 -2
  266. package/temp/coverage/sort-arrow-sprite.png +0 -0
  267. package/temp/coverage/sorter.js +0 -210
  268. package/temp/coverage/url-utils/index.html +0 -116
  269. package/temp/coverage/url-utils/urlParams.ts.html +0 -820
  270. package/temp/test/jest/haste-map-7492f1b44480e0cdd1f220078fb3afd8-c8dd6c3430605adeb2f1cadf4f75e791-8c9336785555d572065b28c111982ba4 +0 -0
  271. package/temp/test/jest/jest-transform-cache-7492f1b44480e0cdd1f220078fb3afd8-79ef2876fae7ca75eedb2aa53dc48338/d6/package_d6e3b0fa94752e16b0b2a2777739b973 +0 -53
  272. package/temp/test/jest/perf-cache-7492f1b44480e0cdd1f220078fb3afd8-da39a3ee5e6b4b0d3255bfef95601890 +0 -1
  273. package/temp/ts-web-extras.api.json +0 -8850
  274. package/temp/ts-web-extras.api.md +0 -433
  275. package/tsconfig.json +0 -7
@@ -1 +0,0 @@
1
- {"version":3,"file":"testHelpers.js","sourceRoot":"","sources":["../../../src/test/utils/testHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;AAoBH,wCA0BC;AAMD,gDAUC;AAMD,kEAWC;AAMD,sBAEC;AAMD,sCAYC;AAMD,4CAaC;AAKD,4CAKC;AArHD;;GAEG;AACH,SAAgB,cAAc,CAAC,IAAkB;IAC/C,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,YAAY,EAAE,CAAC,CAAC;IAC3E,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE;QACvC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,YAAY;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,GAAG,EAAE;KAC9C,CAAC,CAAC;IAEH,6DAA6D;IAC7D,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC5B,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,oBAAoB,EAAE;YAChD,KAAK,EAAE,IAAI,CAAC,kBAAkB;YAC9B,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;IAED,sCAAsC;IACtC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAClD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;YAClC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1C,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,KAAqB;IACtD,+CAA+C;IAC/C,MAAM,EAAE,GAAG,IAAI,YAAY,EAAE,CAAC;IAE9B,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACzB,MAAM,IAAI,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;QACtC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,OAAO,EAAE,CAAC,KAAK,CAAC;AAClB,CAAC;AAED;;;GAGG;AACH,SAAgB,2BAA2B,CACzC,kBAA2E;IAE3E,MAAM,KAAK,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC9C,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE;QACtC,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,kBAAkB,EAAE,IAAI,CAAC,IAAI;KAC9B,CAAC,CAAC,CAAC;IAEJ,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,EAAU;IAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,aAAa,CAAC,IAAU;IAC5C,IAAI,CAAC;QACH,0CAA0C;QAC1C,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAC/B,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC;IAClC,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,KAAa,EAAE,YAAoB,SAAS;IAC3E,2DAA2D;IAC3D,sDAAsD;IACtD,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACxF,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,UAAU,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAEpC,gDAAgD;IAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;IAC3D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,MAAmB;IAClD,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACpC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;SACpB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;SAC3C,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\n/**\n * Test utilities for mocking browser APIs\n */\n\n/**\n * Mock file data structure\n */\nexport interface MockFileData {\n name: string;\n content: string;\n type?: string;\n lastModified?: number;\n webkitRelativePath?: string;\n}\n\n/**\n * Create a mock File object with all necessary properties and methods\n */\nexport function createMockFile(data: MockFileData): File {\n const blob = new Blob([data.content], { type: data.type || 'text/plain' });\n const file = new File([blob], data.name, {\n type: data.type || 'text/plain',\n lastModified: data.lastModified || Date.now()\n });\n\n // Add webkitRelativePath if provided (for directory uploads)\n if (data.webkitRelativePath) {\n Object.defineProperty(file, 'webkitRelativePath', {\n value: data.webkitRelativePath,\n writable: false,\n configurable: true\n });\n }\n\n // Ensure text() method works properly\n if (!file.text || typeof file.text !== 'function') {\n Object.defineProperty(file, 'text', {\n value: () => Promise.resolve(data.content),\n writable: false,\n configurable: true\n });\n }\n\n return file;\n}\n\n/**\n * Create a mock FileList using DataTransfer API\n * This is the most reliable method for creating FileList objects in tests\n */\nexport function createMockFileList(files: MockFileData[]): FileList {\n // Use DataTransfer to create a proper FileList\n const dt = new DataTransfer();\n\n files.forEach((fileData) => {\n const file = createMockFile(fileData);\n dt.items.add(file);\n });\n\n return dt.files;\n}\n\n/**\n * Create a mock FileList for directory upload simulation\n * Includes webkitRelativePath for each file\n */\nexport function createMockDirectoryFileList(\n directoryStructure: Array<{ path: string; content: string; type?: string }>\n): FileList {\n const files = directoryStructure.map((item) => ({\n name: item.path.split('/').pop() || '',\n content: item.content,\n type: item.type,\n webkitRelativePath: item.path\n }));\n\n return createMockFileList(files);\n}\n\n/**\n * Helper to create a promise that resolves after a delay\n * Useful for testing async operations\n */\nexport function delay(ms: number): Promise<void> {\n return new Promise((resolve) => setTimeout(resolve, ms));\n}\n\n/**\n * Helper to verify File API text() method works correctly\n * Since we're using Blob/File polyfills, this ensures they have the right methods\n */\nexport async function verifyFileAPI(file: File): Promise<boolean> {\n try {\n // Check if text() method exists and works\n if (typeof file.text !== 'function') {\n throw new Error('File.text() method not available');\n }\n\n const text = await file.text();\n return typeof text === 'string';\n } catch {\n return false;\n }\n}\n\n/**\n * Mock Web Crypto digest result for testing\n * Creates a deterministic hash-like ArrayBuffer\n */\nexport function createMockDigest(input: string, algorithm: string = 'SHA-256'): ArrayBuffer {\n // Create a deterministic \"hash\" based on input for testing\n // This is not a real hash but good enough for testing\n const hashLength = algorithm.includes('256') ? 32 : algorithm.includes('512') ? 64 : 20;\n const buffer = new ArrayBuffer(hashLength);\n const view = new Uint8Array(buffer);\n\n // Fill with deterministic values based on input\n for (let i = 0; i < hashLength; i++) {\n view[i] = (input.charCodeAt(i % input.length) + i) % 256;\n }\n\n return buffer;\n}\n\n/**\n * Convert ArrayBuffer to hex string for comparison in tests\n */\nexport function arrayBufferToHex(buffer: ArrayBuffer): string {\n const view = new Uint8Array(buffer);\n return Array.from(view)\n .map((b) => b.toString(16).padStart(2, '0'))\n .join('');\n}\n"]}
@@ -1,3 +0,0 @@
1
- Caching build output folders: dist, lib, temp, .rush/temp/operation/build
2
- Successfully set cache entry.
3
- Cache key: 61c1d4a91d98f048b475a5bb3e6541c5d27819de
@@ -1,55 +0,0 @@
1
- Invoking: heft test --clean
2
- ---- build started ----
3
- [build:typescript] The TypeScript compiler version 5.9.3 is newer than the latest version that was tested with Heft (5.8); it may not work correctly.
4
- [build:typescript] Using TypeScript version 5.9.3
5
- [build:api-extractor] Using API Extractor version 7.57.6
6
- [build:api-extractor] Analysis will use the bundled TypeScript version 5.8.2
7
- [build:api-extractor] *** The target project appears to use TypeScript 5.9.3 which is newer than the bundled compiler engine; consider upgrading API Extractor.
8
- ---- build finished (24.830s) ----
9
- ---- test started ----
10
- [test:jest] Using Jest version 29.5.0
11
- [test:jest]
12
- [test:jest] Run start. 9 test suites
13
- [test:jest] START lib/test/unit/fileApiTreeAccessors.test.js
14
- [test:jest] START lib/test/unit/httpTreeAccessors.test.js
15
- [test:jest] START lib/test/unit/localStorageTreeAccessors.test.js
16
- [test:jest] START lib/test/unit/fileSystemAccessTreeAccessors.test.js
17
- [test:jest] PASS lib/test/unit/localStorageTreeAccessors.test.js (duration: 1.749s, 44 passed, 0 failed)
18
- [test:jest] START lib/test/unit/fileTreeHelpers.test.js
19
- [test:jest] PASS lib/test/unit/fileApiTreeAccessors.test.js (duration: 2.021s, 65 passed, 0 failed)
20
- [test:jest] START lib/test/unit/fileApiTypes.test.js
21
- [test:jest] PASS lib/test/unit/httpTreeAccessors.test.js (duration: 2.316s, 57 passed, 0 failed)
22
- [test:jest] START lib/test/unit/urlParams.test.js
23
- [test:jest] PASS lib/test/unit/fileSystemAccessTreeAccessors.test.js (duration: 1.352s, 44 passed, 0 failed)
24
- [test:jest] START lib/test/unit/directoryHandleStore.test.js
25
- [test:jest] PASS lib/test/unit/fileTreeHelpers.test.js (duration: 1.538s, 35 passed, 0 failed)
26
- [test:jest] START lib/test/unit/browserHashProvider.test.js
27
- [test:jest] PASS lib/test/unit/fileApiTypes.test.js (duration: 1.440s, 36 passed, 0 failed)
28
- [test:jest] PASS lib/test/unit/urlParams.test.js (duration: 1.637s, 60 passed, 0 failed)
29
- [test:jest] PASS lib/test/unit/directoryHandleStore.test.js (duration: 1.412s, 19 passed, 0 failed)
30
- [test:jest] PASS lib/test/unit/browserHashProvider.test.js (duration: 1.586s, 15 passed, 0 failed)
31
- [test:jest]
32
- [test:jest] Tests finished:
33
- [test:jest] Successes: 375
34
- [test:jest] Failures: 0
35
- [test:jest] Total: 376
36
- -----------------------------------|---------|----------|---------|---------|-------------------
37
- File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
38
- -----------------------------------|---------|----------|---------|---------|-------------------
39
- All files | 100 | 99.62 | 100 | 100 |
40
- crypto-utils | 100 | 100 | 100 | 100 |
41
- browserCryptoProvider.ts | 100 | 100 | 100 | 100 |
42
- browserHashProvider.ts | 100 | 100 | 100 | 100 |
43
- file-tree | 100 | 99.57 | 100 | 100 |
44
- directoryHandleStore.ts | 100 | 100 | 100 | 100 |
45
- fileApiTreeAccessors.ts | 100 | 100 | 100 | 100 |
46
- fileSystemAccessTreeAccessors.ts | 100 | 100 | 100 | 100 |
47
- httpTreeAccessors.ts | 100 | 98.41 | 100 | 100 | 339
48
- localStorageTreeAccessors.ts | 100 | 100 | 100 | 100 |
49
- helpers | 100 | 100 | 100 | 100 |
50
- fileTreeHelpers.ts | 100 | 100 | 100 | 100 |
51
- url-utils | 100 | 100 | 100 | 100 |
52
- urlParams.ts | 100 | 100 | 100 | 100 |
53
- -----------------------------------|---------|----------|---------|---------|-------------------
54
- ---- test finished (8.132s) ----
55
- -------------------- Finished (32.975s) --------------------
@@ -1,24 +0,0 @@
1
- /*
2
- * Copyright (c) 2025 Erik Fortune
3
- *
4
- * Permission is hereby granted, free of charge, to any person obtaining a copy
5
- * of this software and associated documentation files (the "Software"), to deal
6
- * in the Software without restriction, including without limitation the rights
7
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
- * copies of the Software, and to permit persons to whom the Software is
9
- * furnished to do so, subject to the following conditions:
10
- *
11
- * The above copyright notice and this permission notice shall be included in all
12
- * copies or substantial portions of the Software.
13
- *
14
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
- * SOFTWARE.
21
- */
22
-
23
- // Browser entry point - re-exports everything from main index
24
- export * from './index';
package/src/index.ts DELETED
@@ -1,47 +0,0 @@
1
- /*
2
- * Copyright (c) 2025 Erik Fortune
3
- *
4
- * Permission is hereby granted, free of charge, to any person obtaining a copy
5
- * of this software and associated documentation files (the "Software"), to deal
6
- * in the Software without restriction, including without limitation the rights
7
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
- * copies of the Software, and to permit persons to whom the Software is
9
- * furnished to do so, subject to the following conditions:
10
- *
11
- * The above copyright notice and this permission notice shall be included in all
12
- * copies or substantial portions of the Software.
13
- *
14
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
- * SOFTWARE.
21
- */
22
-
23
- /**
24
- * Browser-compatible utilities and FileTree implementations.
25
- *
26
- * This library provides browser-compatible alternatives to Node.js-specific functionality,
27
- * including Web Crypto API-based hashing, File API-based file tree implementations,
28
- * and URL parameter parsing utilities.
29
- * All exports are designed to be tree-shakeable for optimal bundle size.
30
- *
31
- * @packageDocumentation
32
- */
33
-
34
- import * as CryptoUtils from './packlets/crypto-utils';
35
- export { CryptoUtils };
36
-
37
- // Export file tree functionality
38
- export * from './packlets/file-tree';
39
-
40
- // Export helper functions
41
- export * from './packlets/helpers';
42
-
43
- // Export File System Access API types
44
- export * from './packlets/file-api-types';
45
-
46
- // Export URL utilities
47
- export * from './packlets/url-utils';
@@ -1,311 +0,0 @@
1
- // Copyright (c) 2024 Erik Fortune
2
- //
3
- // Permission is hereby granted, free of charge, to any person obtaining a copy
4
- // of this software and associated documentation files (the "Software"), to deal
5
- // in the Software without restriction, including without limitation the rights
6
- // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
- // copies of the Software, and to permit persons to whom the Software is
8
- // furnished to do so, subject to the following conditions:
9
- //
10
- // The above copyright notice and this permission notice shall be included in all
11
- // copies or substantial portions of the Software.
12
- //
13
- // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
- // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
- // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
- // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
- // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
- // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
- // SOFTWARE.
20
-
21
- /* c8 ignore start - Browser-only implementation cannot be tested in Node.js environment */
22
- import { captureResult, Failure, Result, Success } from '@fgv/ts-utils';
23
- import { CryptoUtils } from '@fgv/ts-extras';
24
-
25
- type ICryptoProvider = CryptoUtils.ICryptoProvider;
26
- type IEncryptionResult = CryptoUtils.IEncryptionResult;
27
- const CryptoConstants = CryptoUtils.Constants;
28
-
29
- /**
30
- * Extracts an `ArrayBuffer` from a Uint8Array, handling the potential SharedArrayBuffer case.
31
- * @param arr - The Uint8Array to extract from
32
- * @returns An `ArrayBuffer` containing a copy of the data.
33
- */
34
- function toArrayBuffer(arr: Uint8Array): ArrayBuffer {
35
- // Create a new ArrayBuffer and copy the data - this handles both ArrayBuffer and SharedArrayBuffer
36
- const buffer = new ArrayBuffer(arr.byteLength);
37
- new Uint8Array(buffer).set(arr);
38
- return buffer;
39
- }
40
-
41
- /**
42
- * Browser implementation of `ICryptoProvider` using the Web Crypto API.
43
- * Uses AES-256-GCM for authenticated encryption.
44
- *
45
- * Note: This provider requires a browser environment with Web Crypto API support.
46
- * In Node.js 15+, Web Crypto is available via globalThis.crypto or require('crypto').webcrypto.
47
- *
48
- * @public
49
- */
50
- export class BrowserCryptoProvider implements ICryptoProvider {
51
- private readonly _crypto: Crypto;
52
-
53
- /**
54
- * Creates a new {@link CryptoUtils.BrowserCryptoProvider | BrowserCryptoProvider}.
55
- * @param cryptoApi - Optional Crypto instance (defaults to globalThis.crypto)
56
- */
57
- public constructor(cryptoApi?: Crypto) {
58
- if (cryptoApi) {
59
- this._crypto = cryptoApi;
60
- } else if (typeof globalThis !== 'undefined' && globalThis.crypto) {
61
- this._crypto = globalThis.crypto;
62
- } else if (typeof window !== 'undefined' && window.crypto) {
63
- this._crypto = window.crypto;
64
- } else {
65
- throw new Error('Web Crypto API not available');
66
- }
67
- }
68
-
69
- /**
70
- * Encrypts plaintext using AES-256-GCM.
71
- * @param plaintext - UTF-8 string to encrypt
72
- * @param key - 32-byte encryption key
73
- * @returns `Success` with encryption result, or `Failure` with an error.
74
- */
75
- public async encrypt(plaintext: string, key: Uint8Array): Promise<Result<IEncryptionResult>> {
76
- if (key.length !== CryptoConstants.AES_256_KEY_SIZE) {
77
- return Failure.with(`Key must be ${CryptoConstants.AES_256_KEY_SIZE} bytes, got ${key.length}`);
78
- }
79
-
80
- try {
81
- // Generate random IV
82
- const iv = this._crypto.getRandomValues(new Uint8Array(CryptoConstants.GCM_IV_SIZE));
83
-
84
- // Import the key
85
- const cryptoKey = await this._crypto.subtle.importKey(
86
- 'raw',
87
- toArrayBuffer(key),
88
- { name: 'AES-GCM' },
89
- false,
90
- ['encrypt']
91
- );
92
-
93
- // Encode plaintext to bytes
94
- const encoder = new TextEncoder();
95
- const plaintextBytes = encoder.encode(plaintext);
96
-
97
- // Encrypt (Web Crypto appends auth tag to ciphertext)
98
- const encryptedWithTag = await this._crypto.subtle.encrypt(
99
- {
100
- name: 'AES-GCM',
101
- iv: iv,
102
- tagLength: CryptoConstants.GCM_AUTH_TAG_SIZE * 8 // bits
103
- },
104
- cryptoKey,
105
- plaintextBytes
106
- );
107
-
108
- // Split ciphertext and auth tag (auth tag is last 16 bytes)
109
- const encryptedArray = new Uint8Array(encryptedWithTag);
110
- const encryptedData = encryptedArray.slice(
111
- 0,
112
- encryptedArray.length - CryptoConstants.GCM_AUTH_TAG_SIZE
113
- );
114
- const authTag = encryptedArray.slice(encryptedArray.length - CryptoConstants.GCM_AUTH_TAG_SIZE);
115
- return Success.with({
116
- iv,
117
- authTag,
118
- encryptedData
119
- });
120
- } catch (e) {
121
- const message = e instanceof Error ? e.message : String(e);
122
- return Failure.with(`Encryption failed: ${message}`);
123
- }
124
- }
125
-
126
- /**
127
- * Decrypts ciphertext using AES-256-GCM.
128
- * @param encryptedData - Encrypted bytes
129
- * @param key - 32-byte decryption key
130
- * @param iv - Initialization vector (12 bytes)
131
- * @param authTag - GCM authentication tag (16 bytes)
132
- * @returns `Success` with decrypted UTF-8 string, or `Failure` with an error.
133
- */
134
- public async decrypt(
135
- encryptedData: Uint8Array,
136
- key: Uint8Array,
137
- iv: Uint8Array,
138
- authTag: Uint8Array
139
- ): Promise<Result<string>> {
140
- if (key.length !== CryptoConstants.AES_256_KEY_SIZE) {
141
- return Failure.with(`Key must be ${CryptoConstants.AES_256_KEY_SIZE} bytes, got ${key.length}`);
142
- }
143
- if (iv.length !== CryptoConstants.GCM_IV_SIZE) {
144
- return Failure.with(`IV must be ${CryptoConstants.GCM_IV_SIZE} bytes, got ${iv.length}`);
145
- }
146
- if (authTag.length !== CryptoConstants.GCM_AUTH_TAG_SIZE) {
147
- return Failure.with(
148
- `Auth tag must be ${CryptoConstants.GCM_AUTH_TAG_SIZE} bytes, got ${authTag.length}`
149
- );
150
- }
151
-
152
- try {
153
- // Import the key
154
- const cryptoKey = await this._crypto.subtle.importKey(
155
- 'raw',
156
- toArrayBuffer(key),
157
- { name: 'AES-GCM' },
158
- false,
159
- ['decrypt']
160
- );
161
-
162
- // Web Crypto expects ciphertext + auth tag concatenated
163
- const encryptedWithTag = new Uint8Array(encryptedData.length + authTag.length);
164
- encryptedWithTag.set(encryptedData);
165
- encryptedWithTag.set(authTag, encryptedData.length);
166
-
167
- // Decrypt
168
- const decrypted = await this._crypto.subtle.decrypt(
169
- {
170
- name: 'AES-GCM',
171
- iv: toArrayBuffer(iv),
172
- tagLength: CryptoConstants.GCM_AUTH_TAG_SIZE * 8 // bits
173
- },
174
- cryptoKey,
175
- encryptedWithTag
176
- );
177
-
178
- // Decode to string
179
- const decoder = new TextDecoder();
180
- return Success.with(decoder.decode(decrypted));
181
- } catch (e) {
182
- const message = e instanceof Error ? e.message : String(e);
183
- return Failure.with(`Decryption failed: ${message}`);
184
- }
185
- }
186
-
187
- /**
188
- * Generates a random 32-byte key suitable for AES-256.
189
- * @returns Success with generated key, or Failure with error
190
- */
191
- public async generateKey(): Promise<Result<Uint8Array>> {
192
- try {
193
- return Success.with(this._crypto.getRandomValues(new Uint8Array(CryptoConstants.AES_256_KEY_SIZE)));
194
- } catch (e) {
195
- const message = e instanceof Error ? e.message : String(e);
196
- return Failure.with(`Key generation failed: ${message}`);
197
- }
198
- }
199
-
200
- /**
201
- * Derives a key from a password using PBKDF2.
202
- * @param password - Password string
203
- * @param salt - Salt bytes (should be at least 16 bytes)
204
- * @param iterations - Number of iterations (recommend 100000+)
205
- * @returns Success with derived 32-byte key, or Failure with error
206
- */
207
- public async deriveKey(
208
- password: string,
209
- salt: Uint8Array,
210
- iterations: number
211
- ): Promise<Result<Uint8Array>> {
212
- if (iterations < 1) {
213
- return Failure.with('Iterations must be at least 1');
214
- }
215
- if (salt.length < 8) {
216
- return Failure.with('Salt should be at least 8 bytes');
217
- }
218
-
219
- try {
220
- // Encode password
221
- const encoder = new TextEncoder();
222
- const passwordBytes = encoder.encode(password);
223
-
224
- // Import password as key material
225
- const keyMaterial = await this._crypto.subtle.importKey('raw', passwordBytes, 'PBKDF2', false, [
226
- 'deriveBits'
227
- ]);
228
-
229
- // Derive key bits
230
- const derivedBits = await this._crypto.subtle.deriveBits(
231
- {
232
- name: 'PBKDF2',
233
- salt: toArrayBuffer(salt),
234
- iterations: iterations,
235
- hash: 'SHA-256'
236
- },
237
- keyMaterial,
238
- CryptoConstants.AES_256_KEY_SIZE * 8 // bits
239
- );
240
-
241
- return Success.with(new Uint8Array(derivedBits));
242
- } catch (e) {
243
- const message = e instanceof Error ? e.message : String(e);
244
- return Failure.with(`Key derivation failed: ${message}`);
245
- }
246
- }
247
-
248
- // ============================================================================
249
- // Platform Utility Methods
250
- // ============================================================================
251
-
252
- /**
253
- * Generates cryptographically secure random bytes.
254
- * @param length - Number of bytes to generate
255
- * @returns Success with random bytes, or Failure with error
256
- */
257
- public generateRandomBytes(length: number): Result<Uint8Array> {
258
- if (length < 1) {
259
- return Failure.with('Length must be at least 1');
260
- }
261
- try {
262
- return Success.with(this._crypto.getRandomValues(new Uint8Array(length)));
263
- } catch (e) {
264
- const message = e instanceof Error ? e.message : String(e);
265
- return Failure.with(`Random bytes generation failed: ${message}`);
266
- }
267
- }
268
-
269
- /**
270
- * Encodes binary data to base64 string.
271
- * @param data - Binary data to encode
272
- * @returns Base64-encoded string
273
- */
274
- public toBase64(data: Uint8Array): string {
275
- // Convert Uint8Array to binary string, then to base64
276
- let binary = '';
277
- for (let i = 0; i < data.length; i++) {
278
- binary += String.fromCharCode(data[i]);
279
- }
280
- return btoa(binary);
281
- }
282
-
283
- /**
284
- * Decodes base64 string to binary data.
285
- * @param base64 - Base64-encoded string
286
- * @returns Success with decoded bytes, or Failure if invalid base64
287
- */
288
- public fromBase64(base64: string): Result<Uint8Array> {
289
- try {
290
- const binary = atob(base64);
291
- const bytes = new Uint8Array(binary.length);
292
- for (let i = 0; i < binary.length; i++) {
293
- bytes[i] = binary.charCodeAt(i);
294
- }
295
- return Success.with(bytes);
296
- } catch (e) {
297
- return Failure.with('Invalid base64 string');
298
- }
299
- }
300
- }
301
-
302
- /**
303
- * Creates a {@link CryptoUtils.BrowserCryptoProvider | BrowserCryptoProvider} if Web
304
- * Crypto API is available.
305
- * @returns `Success` with provider, or `Failure` if not available
306
- * @public
307
- */
308
- export function createBrowserCryptoProvider(): Result<BrowserCryptoProvider> {
309
- return captureResult(() => new BrowserCryptoProvider());
310
- }
311
- /* c8 ignore stop */
@@ -1,73 +0,0 @@
1
- /*
2
- * Copyright (c) 2025 Erik Fortune
3
- *
4
- * Permission is hereby granted, free of charge, to any person obtaining a copy
5
- * of this software and associated documentation files (the "Software"), to deal
6
- * in the Software without restriction, including without limitation the rights
7
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
- * copies of the Software, and to permit persons to whom the Software is
9
- * furnished to do so, subject to the following conditions:
10
- *
11
- * The above copyright notice and this permission notice shall be included in all
12
- * copies or substantial portions of the Software.
13
- *
14
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
- * SOFTWARE.
21
- */
22
-
23
- import { Result, succeed, fail } from '@fgv/ts-utils';
24
-
25
- /**
26
- * Browser-compatible hash provider using the Web Crypto API.
27
- * Supports common hash algorithms available in browsers.
28
- * @public
29
- */
30
- export class BrowserHashProvider {
31
- /**
32
- * Hash a string using the specified algorithm.
33
- * @param data - The string to hash
34
- * @param algorithm - The hash algorithm to use
35
- * @returns Promise resolving to the hex-encoded hash
36
- */
37
- public static async hashString(data: string, algorithm: string = 'SHA-256'): Promise<Result<string>> {
38
- try {
39
- /* c8 ignore next 3 - defense in depth */
40
- if (!crypto.subtle) {
41
- return fail('Web Crypto API not available in this environment');
42
- }
43
-
44
- const encoder = new TextEncoder();
45
- const dataBuffer = encoder.encode(data);
46
- const hashBuffer = await crypto.subtle.digest(algorithm, dataBuffer);
47
- const hashArray = new Uint8Array(hashBuffer);
48
- const hashHex = Array.from(hashArray)
49
- .map((b) => b.toString(16).padStart(2, '0'))
50
- .join('');
51
-
52
- return succeed(hashHex);
53
- } catch (error) {
54
- return fail(`Hash computation failed: ${error instanceof Error ? error.message : String(error)}`);
55
- }
56
- }
57
-
58
- /**
59
- * Hash multiple strings concatenated with a separator.
60
- * @param parts - Array of strings to concatenate and hash
61
- * @param algorithm - The hash algorithm to use
62
- * @param separator - Separator to use between parts (default: '|')
63
- * @returns Promise resolving to the hex-encoded hash
64
- */
65
- public static async hashParts(
66
- parts: string[],
67
- algorithm: string = 'SHA-256',
68
- separator: string = '|'
69
- ): Promise<Result<string>> {
70
- const combined = parts.join(separator);
71
- return this.hashString(combined, algorithm);
72
- }
73
- }
@@ -1,29 +0,0 @@
1
- /*
2
- * Copyright (c) 2025 Erik Fortune
3
- *
4
- * Permission is hereby granted, free of charge, to any person obtaining a copy
5
- * of this software and associated documentation files (the "Software"), to deal
6
- * in the Software without restriction, including without limitation the rights
7
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
- * copies of the Software, and to permit persons to whom the Software is
9
- * furnished to do so, subject to the following conditions:
10
- *
11
- * The above copyright notice and this permission notice shall be included in all
12
- * copies or substantial portions of the Software.
13
- *
14
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
- * SOFTWARE.
21
- */
22
-
23
- /**
24
- * Browser-compatible cryptographic utilities using the Web Crypto API.
25
- * @packageDocumentation
26
- */
27
-
28
- export * from './browserHashProvider';
29
- export * from './browserCryptoProvider';