@fgv/ts-web-extras 5.0.2 → 5.1.0-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (383) hide show
  1. package/.rush/temp/chunked-rush-logs/ts-web-extras.build.chunks.jsonl +58 -25
  2. package/.rush/temp/chunked-rush-logs/ts-web-extras.test.chunks.jsonl +70 -0
  3. package/.rush/temp/operation/build/all.log +58 -25
  4. package/.rush/temp/operation/build/error.log +18 -0
  5. package/.rush/temp/operation/build/log-chunks.jsonl +58 -25
  6. package/.rush/temp/operation/build/state.json +1 -1
  7. package/.rush/temp/operation/test/all.log +70 -0
  8. package/.rush/temp/operation/test/error.log +16 -0
  9. package/.rush/temp/operation/test/log-chunks.jsonl +70 -0
  10. package/.rush/temp/operation/test/state.json +3 -0
  11. package/.rush/temp/shrinkwrap-deps.json +175 -163
  12. package/config/jest.config.json +4 -1
  13. package/config/typedoc.json +6 -0
  14. package/dist/index.js +2 -2
  15. package/dist/index.js.map +1 -1
  16. package/dist/packlets/crypto-utils/browserCryptoProvider.js +254 -0
  17. package/dist/packlets/crypto-utils/browserCryptoProvider.js.map +1 -0
  18. package/dist/packlets/crypto-utils/browserHashProvider.js.map +1 -0
  19. package/dist/packlets/{crypto → crypto-utils}/index.js +1 -0
  20. package/dist/packlets/crypto-utils/index.js.map +1 -0
  21. package/dist/packlets/file-api-types/index.js +27 -3
  22. package/dist/packlets/file-api-types/index.js.map +1 -1
  23. package/dist/packlets/file-tree/directoryHandleStore.js +124 -0
  24. package/dist/packlets/file-tree/directoryHandleStore.js.map +1 -0
  25. package/dist/packlets/file-tree/fileApiTreeAccessors.js +91 -0
  26. package/dist/packlets/file-tree/fileApiTreeAccessors.js.map +1 -1
  27. package/dist/packlets/file-tree/fileSystemAccessTreeAccessors.js +414 -0
  28. package/dist/packlets/file-tree/fileSystemAccessTreeAccessors.js.map +1 -0
  29. package/dist/packlets/file-tree/httpTreeAccessors.js +279 -0
  30. package/dist/packlets/file-tree/httpTreeAccessors.js.map +1 -0
  31. package/dist/packlets/file-tree/index.js +4 -0
  32. package/dist/packlets/file-tree/index.js.map +1 -1
  33. package/dist/packlets/file-tree/localStorageTreeAccessors.js +359 -0
  34. package/dist/packlets/file-tree/localStorageTreeAccessors.js.map +1 -0
  35. package/dist/test/mocks/idb-keyval.js +6 -0
  36. package/dist/test/mocks/idb-keyval.js.map +1 -0
  37. package/dist/test/unit/browserHashProvider.test.js +1 -1
  38. package/dist/test/unit/browserHashProvider.test.js.map +1 -1
  39. package/dist/test/unit/directoryHandleStore.test.js +190 -0
  40. package/dist/test/unit/directoryHandleStore.test.js.map +1 -0
  41. package/dist/test/unit/fileApiTreeAccessors.test.js +51 -0
  42. package/dist/test/unit/fileApiTreeAccessors.test.js.map +1 -1
  43. package/dist/test/unit/fileApiTypes.test.js +30 -0
  44. package/dist/test/unit/fileApiTypes.test.js.map +1 -1
  45. package/dist/test/unit/fileSystemAccessTreeAccessors.test.js +622 -0
  46. package/dist/test/unit/fileSystemAccessTreeAccessors.test.js.map +1 -0
  47. package/dist/test/unit/httpTreeAccessors.test.js +1000 -0
  48. package/dist/test/unit/httpTreeAccessors.test.js.map +1 -0
  49. package/dist/test/unit/localStorageTreeAccessors.test.js +812 -0
  50. package/dist/test/unit/localStorageTreeAccessors.test.js.map +1 -0
  51. package/dist/test/utils/fileSystemAccessMocks.js +271 -0
  52. package/dist/test/utils/fileSystemAccessMocks.js.map +1 -0
  53. package/dist/ts-web-extras.d.ts +584 -1
  54. package/dist/tsdoc-metadata.json +1 -1
  55. package/docs/@fgv/namespaces/CryptoUtils/README.md +18 -0
  56. package/docs/@fgv/namespaces/CryptoUtils/classes/BrowserCryptoProvider.md +203 -0
  57. package/docs/@fgv/namespaces/CryptoUtils/classes/BrowserHashProvider.md +63 -0
  58. package/docs/@fgv/namespaces/CryptoUtils/functions/createBrowserCryptoProvider.md +18 -0
  59. package/docs/@fgv/namespaces/FileTreeHelpers/README.md +19 -0
  60. package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileListMetadata.md +23 -0
  61. package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileMetadata.md +23 -0
  62. package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromDirectoryUpload.md +33 -0
  63. package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromFileList.md +33 -0
  64. package/docs/@fgv/namespaces/FileTreeHelpers/functions/getOriginalFile.md +25 -0
  65. package/docs/@fgv/namespaces/FileTreeHelpers/variables/defaultFileApiTreeInitParams.md +11 -0
  66. package/docs/README.md +78 -0
  67. package/docs/classes/DirectoryHandleStore.md +116 -0
  68. package/docs/classes/FileApiTreeAccessors.md +286 -0
  69. package/docs/classes/FileSystemAccessTreeAccessors.md +557 -0
  70. package/docs/classes/HttpTreeAccessors.md +508 -0
  71. package/docs/classes/LocalStorageTreeAccessors.md +520 -0
  72. package/docs/functions/exportAsJson.md +23 -0
  73. package/docs/functions/exportUsingFileSystemAPI.md +26 -0
  74. package/docs/functions/extractDirectoryPath.md +23 -0
  75. package/docs/functions/isDirectoryHandle.md +23 -0
  76. package/docs/functions/isFileHandle.md +23 -0
  77. package/docs/functions/isFilePath.md +21 -0
  78. package/docs/functions/parseContextFilter.md +22 -0
  79. package/docs/functions/parseQualifierDefaults.md +22 -0
  80. package/docs/functions/parseResourceTypes.md +22 -0
  81. package/docs/functions/parseUrlParameters.md +15 -0
  82. package/docs/functions/safeShowDirectoryPicker.md +24 -0
  83. package/docs/functions/safeShowOpenFilePicker.md +24 -0
  84. package/docs/functions/safeShowSaveFilePicker.md +24 -0
  85. package/docs/functions/supportsFileSystemAccess.md +23 -0
  86. package/docs/interfaces/FilePickerAcceptType.md +16 -0
  87. package/docs/interfaces/FileSystemCreateWritableOptions.md +15 -0
  88. package/docs/interfaces/FileSystemDirectoryHandle.md +187 -0
  89. package/docs/interfaces/FileSystemFileHandle.md +106 -0
  90. package/docs/interfaces/FileSystemGetDirectoryOptions.md +15 -0
  91. package/docs/interfaces/FileSystemGetFileOptions.md +15 -0
  92. package/docs/interfaces/FileSystemHandle.md +69 -0
  93. package/docs/interfaces/FileSystemHandlePermissionDescriptor.md +15 -0
  94. package/docs/interfaces/FileSystemRemoveOptions.md +15 -0
  95. package/docs/interfaces/FileSystemWritableFileStream.md +127 -0
  96. package/docs/interfaces/IDirectoryHandleTreeInitializer.md +17 -0
  97. package/docs/interfaces/IFileHandleTreeInitializer.md +16 -0
  98. package/docs/interfaces/IFileListTreeInitializer.md +15 -0
  99. package/docs/interfaces/IFileMetadata.md +19 -0
  100. package/docs/interfaces/IFileSystemAccessTreeParams.md +30 -0
  101. package/docs/interfaces/IFsAccessApis.md +57 -0
  102. package/docs/interfaces/IHttpTreeParams.md +32 -0
  103. package/docs/interfaces/ILocalStorageTreeParams.md +30 -0
  104. package/docs/interfaces/IUrlConfigOptions.md +27 -0
  105. package/docs/interfaces/ShowDirectoryPickerOptions.md +17 -0
  106. package/docs/interfaces/ShowOpenFilePickerOptions.md +19 -0
  107. package/docs/interfaces/ShowSaveFilePickerOptions.md +19 -0
  108. package/docs/type-aliases/TreeInitializer.md +11 -0
  109. package/docs/type-aliases/WellKnownDirectory.md +11 -0
  110. package/docs/type-aliases/WindowWithFsAccess.md +11 -0
  111. package/docs/variables/DEFAULT_DIRECTORY_HANDLE_DB.md +11 -0
  112. package/docs/variables/DEFAULT_DIRECTORY_HANDLE_STORE.md +11 -0
  113. package/etc/ts-web-extras.api.md +124 -1
  114. package/lib/index.d.ts +2 -1
  115. package/lib/index.d.ts.map +1 -1
  116. package/lib/index.js +25 -2
  117. package/lib/index.js.map +1 -1
  118. package/lib/packlets/crypto-utils/browserCryptoProvider.d.ts +77 -0
  119. package/lib/packlets/crypto-utils/browserCryptoProvider.d.ts.map +1 -0
  120. package/lib/packlets/crypto-utils/browserCryptoProvider.js +259 -0
  121. package/lib/packlets/crypto-utils/browserCryptoProvider.js.map +1 -0
  122. package/lib/packlets/crypto-utils/browserHashProvider.d.ts.map +1 -0
  123. package/lib/packlets/crypto-utils/browserHashProvider.js.map +1 -0
  124. package/lib/packlets/{crypto → crypto-utils}/index.d.ts +1 -0
  125. package/lib/packlets/crypto-utils/index.d.ts.map +1 -0
  126. package/lib/packlets/{crypto → crypto-utils}/index.js +1 -0
  127. package/lib/packlets/crypto-utils/index.js.map +1 -0
  128. package/lib/packlets/file-api-types/index.d.ts.map +1 -1
  129. package/lib/packlets/file-api-types/index.js +27 -3
  130. package/lib/packlets/file-api-types/index.js.map +1 -1
  131. package/lib/packlets/file-tree/directoryHandleStore.d.ts +59 -0
  132. package/lib/packlets/file-tree/directoryHandleStore.d.ts.map +1 -0
  133. package/lib/packlets/file-tree/directoryHandleStore.js +128 -0
  134. package/lib/packlets/file-tree/directoryHandleStore.js.map +1 -0
  135. package/lib/packlets/file-tree/fileApiTreeAccessors.d.ts +66 -0
  136. package/lib/packlets/file-tree/fileApiTreeAccessors.d.ts.map +1 -1
  137. package/lib/packlets/file-tree/fileApiTreeAccessors.js +91 -0
  138. package/lib/packlets/file-tree/fileApiTreeAccessors.js.map +1 -1
  139. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.d.ts +152 -0
  140. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.d.ts.map +1 -0
  141. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.js +418 -0
  142. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.js.map +1 -0
  143. package/lib/packlets/file-tree/httpTreeAccessors.d.ts +88 -0
  144. package/lib/packlets/file-tree/httpTreeAccessors.d.ts.map +1 -0
  145. package/lib/packlets/file-tree/httpTreeAccessors.js +283 -0
  146. package/lib/packlets/file-tree/httpTreeAccessors.js.map +1 -0
  147. package/lib/packlets/file-tree/index.d.ts +4 -0
  148. package/lib/packlets/file-tree/index.d.ts.map +1 -1
  149. package/lib/packlets/file-tree/index.js +4 -0
  150. package/lib/packlets/file-tree/index.js.map +1 -1
  151. package/lib/packlets/file-tree/localStorageTreeAccessors.d.ts +141 -0
  152. package/lib/packlets/file-tree/localStorageTreeAccessors.d.ts.map +1 -0
  153. package/lib/packlets/file-tree/localStorageTreeAccessors.js +363 -0
  154. package/lib/packlets/file-tree/localStorageTreeAccessors.js.map +1 -0
  155. package/lib/test/mocks/idb-keyval.d.ts +6 -0
  156. package/lib/test/mocks/idb-keyval.d.ts.map +1 -0
  157. package/lib/test/mocks/idb-keyval.js +9 -0
  158. package/lib/test/mocks/idb-keyval.js.map +1 -0
  159. package/lib/test/unit/browserHashProvider.test.js +21 -21
  160. package/lib/test/unit/browserHashProvider.test.js.map +1 -1
  161. package/lib/test/unit/directoryHandleStore.test.d.ts +2 -0
  162. package/lib/test/unit/directoryHandleStore.test.d.ts.map +1 -0
  163. package/lib/test/unit/directoryHandleStore.test.js +192 -0
  164. package/lib/test/unit/directoryHandleStore.test.js.map +1 -0
  165. package/lib/test/unit/fileApiTreeAccessors.test.js +51 -0
  166. package/lib/test/unit/fileApiTreeAccessors.test.js.map +1 -1
  167. package/lib/test/unit/fileApiTypes.test.js +30 -0
  168. package/lib/test/unit/fileApiTypes.test.js.map +1 -1
  169. package/lib/test/unit/fileSystemAccessTreeAccessors.test.d.ts +2 -0
  170. package/lib/test/unit/fileSystemAccessTreeAccessors.test.d.ts.map +1 -0
  171. package/lib/test/unit/fileSystemAccessTreeAccessors.test.js +624 -0
  172. package/lib/test/unit/fileSystemAccessTreeAccessors.test.js.map +1 -0
  173. package/lib/test/unit/httpTreeAccessors.test.d.ts +2 -0
  174. package/lib/test/unit/httpTreeAccessors.test.d.ts.map +1 -0
  175. package/lib/test/unit/httpTreeAccessors.test.js +1002 -0
  176. package/lib/test/unit/httpTreeAccessors.test.js.map +1 -0
  177. package/lib/test/unit/localStorageTreeAccessors.test.d.ts +2 -0
  178. package/lib/test/unit/localStorageTreeAccessors.test.d.ts.map +1 -0
  179. package/lib/test/unit/localStorageTreeAccessors.test.js +814 -0
  180. package/lib/test/unit/localStorageTreeAccessors.test.js.map +1 -0
  181. package/lib/test/utils/fileSystemAccessMocks.d.ts +53 -0
  182. package/lib/test/utils/fileSystemAccessMocks.d.ts.map +1 -0
  183. package/lib/test/utils/fileSystemAccessMocks.js +277 -0
  184. package/lib/test/utils/fileSystemAccessMocks.js.map +1 -0
  185. package/package.json +41 -34
  186. package/rush-logs/ts-web-extras.build.cache.log +0 -1
  187. package/rush-logs/ts-web-extras.build.error.log +18 -0
  188. package/rush-logs/ts-web-extras.build.log +58 -25
  189. package/rush-logs/ts-web-extras.test.cache.log +1 -0
  190. package/rush-logs/ts-web-extras.test.error.log +16 -0
  191. package/rush-logs/ts-web-extras.test.log +70 -0
  192. package/src/index.ts +2 -2
  193. package/src/packlets/crypto-utils/browserCryptoProvider.ts +311 -0
  194. package/src/packlets/{crypto → crypto-utils}/index.ts +1 -0
  195. package/src/packlets/file-api-types/index.ts +24 -3
  196. package/src/packlets/file-tree/directoryHandleStore.ts +136 -0
  197. package/src/packlets/file-tree/fileApiTreeAccessors.ts +108 -0
  198. package/src/packlets/file-tree/fileSystemAccessTreeAccessors.ts +519 -0
  199. package/src/packlets/file-tree/httpTreeAccessors.ts +381 -0
  200. package/src/packlets/file-tree/index.ts +4 -0
  201. package/src/packlets/file-tree/localStorageTreeAccessors.ts +430 -0
  202. package/src/test/mocks/idb-keyval.ts +5 -0
  203. package/src/test/unit/browserHashProvider.test.ts +1 -1
  204. package/src/test/unit/directoryHandleStore.test.ts +251 -0
  205. package/src/test/unit/fileApiTreeAccessors.test.ts +69 -0
  206. package/src/test/unit/fileApiTypes.test.ts +36 -0
  207. package/src/test/unit/fileSystemAccessTreeAccessors.test.ts +885 -0
  208. package/src/test/unit/httpTreeAccessors.test.ts +1278 -0
  209. package/src/test/unit/localStorageTreeAccessors.test.ts +1014 -0
  210. package/src/test/utils/fileSystemAccessMocks.ts +353 -0
  211. package/temp/build/typescript/ts_8nwakTlr.json +1 -0
  212. package/temp/coverage/crypto/browserHashProvider.ts.html +1 -1
  213. package/temp/coverage/crypto/index.html +1 -1
  214. package/temp/coverage/crypto-utils/browserCryptoProvider.ts.html +1018 -0
  215. package/temp/coverage/crypto-utils/browserHashProvider.ts.html +304 -0
  216. package/temp/coverage/crypto-utils/index.html +131 -0
  217. package/temp/coverage/file-tree/directoryHandleStore.ts.html +493 -0
  218. package/temp/coverage/file-tree/fileApiTreeAccessors.ts.html +330 -6
  219. package/temp/coverage/file-tree/fileSystemAccessTreeAccessors.ts.html +1642 -0
  220. package/temp/coverage/file-tree/httpTreeAccessors.ts.html +1228 -0
  221. package/temp/coverage/file-tree/index.html +69 -9
  222. package/temp/coverage/file-tree/localStorageTreeAccessors.ts.html +1375 -0
  223. package/temp/coverage/helpers/fileTreeHelpers.ts.html +1 -1
  224. package/temp/coverage/helpers/index.html +1 -1
  225. package/temp/coverage/index.html +13 -13
  226. package/temp/coverage/lcov-report/crypto/browserHashProvider.ts.html +1 -1
  227. package/temp/coverage/lcov-report/crypto/index.html +1 -1
  228. package/temp/coverage/lcov-report/crypto-utils/browserCryptoProvider.ts.html +1018 -0
  229. package/temp/coverage/lcov-report/crypto-utils/browserHashProvider.ts.html +304 -0
  230. package/temp/coverage/lcov-report/crypto-utils/index.html +131 -0
  231. package/temp/coverage/lcov-report/file-tree/directoryHandleStore.ts.html +493 -0
  232. package/temp/coverage/lcov-report/file-tree/fileApiTreeAccessors.ts.html +330 -6
  233. package/temp/coverage/lcov-report/file-tree/fileSystemAccessTreeAccessors.ts.html +1642 -0
  234. package/temp/coverage/lcov-report/file-tree/httpTreeAccessors.ts.html +1228 -0
  235. package/temp/coverage/lcov-report/file-tree/index.html +69 -9
  236. package/temp/coverage/lcov-report/file-tree/localStorageTreeAccessors.ts.html +1375 -0
  237. package/temp/coverage/lcov-report/helpers/fileTreeHelpers.ts.html +1 -1
  238. package/temp/coverage/lcov-report/helpers/index.html +1 -1
  239. package/temp/coverage/lcov-report/index.html +13 -13
  240. package/temp/coverage/lcov-report/url-utils/index.html +1 -1
  241. package/temp/coverage/lcov-report/url-utils/urlParams.ts.html +1 -1
  242. package/temp/coverage/lcov.info +2829 -428
  243. package/temp/coverage/url-utils/index.html +1 -1
  244. package/temp/coverage/url-utils/urlParams.ts.html +1 -1
  245. package/temp/test/jest/haste-map-b931e4e63102f86c5bd4949f7dced44f-9d713eb41149188b4e5c0ae3d86d0a57-2ad8e16b24e391b8cdbe50b55c137169 +0 -0
  246. package/temp/test/jest/perf-cache-b931e4e63102f86c5bd4949f7dced44f-da39a3ee5e6b4b0d3255bfef95601890 +1 -0
  247. package/temp/ts-web-extras.api.json +5282 -1472
  248. package/temp/ts-web-extras.api.md +124 -1
  249. package/dist/packlets/crypto/browserHashProvider.js.map +0 -1
  250. package/dist/packlets/crypto/index.js.map +0 -1
  251. package/docs/index.md +0 -34
  252. package/docs/ts-web-extras.browserhashprovider.hashparts.md +0 -88
  253. package/docs/ts-web-extras.browserhashprovider.hashstring.md +0 -72
  254. package/docs/ts-web-extras.browserhashprovider.md +0 -66
  255. package/docs/ts-web-extras.exportasjson.md +0 -70
  256. package/docs/ts-web-extras.exportusingfilesystemapi.md +0 -104
  257. package/docs/ts-web-extras.extractdirectorypath.md +0 -52
  258. package/docs/ts-web-extras.fileapitreeaccessors.create.md +0 -72
  259. package/docs/ts-web-extras.fileapitreeaccessors.extractfilemetadata.md +0 -54
  260. package/docs/ts-web-extras.fileapitreeaccessors.fromdirectoryupload.md +0 -72
  261. package/docs/ts-web-extras.fileapitreeaccessors.fromfilelist.md +0 -72
  262. package/docs/ts-web-extras.fileapitreeaccessors.getoriginalfile.md +0 -72
  263. package/docs/ts-web-extras.fileapitreeaccessors.md +0 -114
  264. package/docs/ts-web-extras.filepickeraccepttype.accept.md +0 -11
  265. package/docs/ts-web-extras.filepickeraccepttype.description.md +0 -11
  266. package/docs/ts-web-extras.filepickeraccepttype.md +0 -75
  267. package/docs/ts-web-extras.filesystemcreatewritableoptions_2.keepexistingdata.md +0 -11
  268. package/docs/ts-web-extras.filesystemcreatewritableoptions_2.md +0 -58
  269. package/docs/ts-web-extras.filesystemdirectoryhandle_2._symbol.asynciterator_.md +0 -15
  270. package/docs/ts-web-extras.filesystemdirectoryhandle_2.entries.md +0 -15
  271. package/docs/ts-web-extras.filesystemdirectoryhandle_2.getdirectoryhandle.md +0 -66
  272. package/docs/ts-web-extras.filesystemdirectoryhandle_2.getfilehandle.md +0 -66
  273. package/docs/ts-web-extras.filesystemdirectoryhandle_2.keys.md +0 -15
  274. package/docs/ts-web-extras.filesystemdirectoryhandle_2.kind.md +0 -11
  275. package/docs/ts-web-extras.filesystemdirectoryhandle_2.md +0 -146
  276. package/docs/ts-web-extras.filesystemdirectoryhandle_2.removeentry.md +0 -66
  277. package/docs/ts-web-extras.filesystemdirectoryhandle_2.resolve.md +0 -50
  278. package/docs/ts-web-extras.filesystemdirectoryhandle_2.values.md +0 -15
  279. package/docs/ts-web-extras.filesystemfilehandle_2.createwritable.md +0 -52
  280. package/docs/ts-web-extras.filesystemfilehandle_2.getfile.md +0 -15
  281. package/docs/ts-web-extras.filesystemfilehandle_2.kind.md +0 -11
  282. package/docs/ts-web-extras.filesystemfilehandle_2.md +0 -92
  283. package/docs/ts-web-extras.filesystemgetdirectoryoptions_2.create.md +0 -11
  284. package/docs/ts-web-extras.filesystemgetdirectoryoptions_2.md +0 -58
  285. package/docs/ts-web-extras.filesystemgetfileoptions_2.create.md +0 -11
  286. package/docs/ts-web-extras.filesystemgetfileoptions_2.md +0 -58
  287. package/docs/ts-web-extras.filesystemhandle_2.issameentry.md +0 -50
  288. package/docs/ts-web-extras.filesystemhandle_2.kind.md +0 -11
  289. package/docs/ts-web-extras.filesystemhandle_2.md +0 -119
  290. package/docs/ts-web-extras.filesystemhandle_2.name.md +0 -11
  291. package/docs/ts-web-extras.filesystemhandle_2.querypermission.md +0 -52
  292. package/docs/ts-web-extras.filesystemhandle_2.requestpermission.md +0 -52
  293. package/docs/ts-web-extras.filesystemhandlepermissiondescriptor.md +0 -58
  294. package/docs/ts-web-extras.filesystemhandlepermissiondescriptor.mode.md +0 -11
  295. package/docs/ts-web-extras.filesystemremoveoptions_2.md +0 -58
  296. package/docs/ts-web-extras.filesystemremoveoptions_2.recursive.md +0 -11
  297. package/docs/ts-web-extras.filesystemwritablefilestream_2.md +0 -57
  298. package/docs/ts-web-extras.filesystemwritablefilestream_2.seek.md +0 -50
  299. package/docs/ts-web-extras.filesystemwritablefilestream_2.truncate.md +0 -50
  300. package/docs/ts-web-extras.filesystemwritablefilestream_2.write.md +0 -50
  301. package/docs/ts-web-extras.filetreehelpers.defaultfileapitreeinitparams.md +0 -13
  302. package/docs/ts-web-extras.filetreehelpers.extractfilelistmetadata.md +0 -56
  303. package/docs/ts-web-extras.filetreehelpers.extractfilemetadata.md +0 -56
  304. package/docs/ts-web-extras.filetreehelpers.fromdirectoryupload.md +0 -76
  305. package/docs/ts-web-extras.filetreehelpers.fromfilelist.md +0 -76
  306. package/docs/ts-web-extras.filetreehelpers.getoriginalfile.md +0 -72
  307. package/docs/ts-web-extras.filetreehelpers.md +0 -102
  308. package/docs/ts-web-extras.idirectoryhandletreeinitializer.dirhandles.md +0 -11
  309. package/docs/ts-web-extras.idirectoryhandletreeinitializer.md +0 -100
  310. package/docs/ts-web-extras.idirectoryhandletreeinitializer.nonrecursive.md +0 -11
  311. package/docs/ts-web-extras.idirectoryhandletreeinitializer.prefix.md +0 -11
  312. package/docs/ts-web-extras.ifilehandletreeinitializer.filehandles.md +0 -11
  313. package/docs/ts-web-extras.ifilehandletreeinitializer.md +0 -79
  314. package/docs/ts-web-extras.ifilehandletreeinitializer.prefix.md +0 -11
  315. package/docs/ts-web-extras.ifilelisttreeinitializer.filelist.md +0 -11
  316. package/docs/ts-web-extras.ifilelisttreeinitializer.md +0 -58
  317. package/docs/ts-web-extras.ifilemetadata.lastmodified.md +0 -11
  318. package/docs/ts-web-extras.ifilemetadata.md +0 -124
  319. package/docs/ts-web-extras.ifilemetadata.name.md +0 -11
  320. package/docs/ts-web-extras.ifilemetadata.path.md +0 -11
  321. package/docs/ts-web-extras.ifilemetadata.size.md +0 -11
  322. package/docs/ts-web-extras.ifilemetadata.type.md +0 -11
  323. package/docs/ts-web-extras.ifsaccessapis.md +0 -56
  324. package/docs/ts-web-extras.ifsaccessapis.showdirectorypicker.md +0 -52
  325. package/docs/ts-web-extras.ifsaccessapis.showopenfilepicker.md +0 -52
  326. package/docs/ts-web-extras.ifsaccessapis.showsavefilepicker.md +0 -52
  327. package/docs/ts-web-extras.isdirectoryhandle.md +0 -56
  328. package/docs/ts-web-extras.isfilehandle.md +0 -56
  329. package/docs/ts-web-extras.isfilepath.md +0 -52
  330. package/docs/ts-web-extras.iurlconfigoptions.config.md +0 -13
  331. package/docs/ts-web-extras.iurlconfigoptions.configstartdir.md +0 -13
  332. package/docs/ts-web-extras.iurlconfigoptions.contextfilter.md +0 -13
  333. package/docs/ts-web-extras.iurlconfigoptions.input.md +0 -13
  334. package/docs/ts-web-extras.iurlconfigoptions.inputstartdir.md +0 -13
  335. package/docs/ts-web-extras.iurlconfigoptions.interactive.md +0 -13
  336. package/docs/ts-web-extras.iurlconfigoptions.loadzip.md +0 -13
  337. package/docs/ts-web-extras.iurlconfigoptions.maxdistance.md +0 -13
  338. package/docs/ts-web-extras.iurlconfigoptions.md +0 -286
  339. package/docs/ts-web-extras.iurlconfigoptions.qualifierdefaults.md +0 -13
  340. package/docs/ts-web-extras.iurlconfigoptions.reducequalifiers.md +0 -13
  341. package/docs/ts-web-extras.iurlconfigoptions.resourcetypes.md +0 -13
  342. package/docs/ts-web-extras.iurlconfigoptions.zipfile.md +0 -13
  343. package/docs/ts-web-extras.iurlconfigoptions.zippath.md +0 -13
  344. package/docs/ts-web-extras.md +0 -512
  345. package/docs/ts-web-extras.parsecontextfilter.md +0 -52
  346. package/docs/ts-web-extras.parsequalifierdefaults.md +0 -52
  347. package/docs/ts-web-extras.parseresourcetypes.md +0 -52
  348. package/docs/ts-web-extras.parseurlparameters.md +0 -17
  349. package/docs/ts-web-extras.safeshowdirectorypicker.md +0 -72
  350. package/docs/ts-web-extras.safeshowopenfilepicker.md +0 -72
  351. package/docs/ts-web-extras.safeshowsavefilepicker.md +0 -72
  352. package/docs/ts-web-extras.showdirectorypickeroptions.id.md +0 -11
  353. package/docs/ts-web-extras.showdirectorypickeroptions.md +0 -96
  354. package/docs/ts-web-extras.showdirectorypickeroptions.mode.md +0 -11
  355. package/docs/ts-web-extras.showdirectorypickeroptions.startin.md +0 -11
  356. package/docs/ts-web-extras.showopenfilepickeroptions.excludeacceptalloption.md +0 -11
  357. package/docs/ts-web-extras.showopenfilepickeroptions.id.md +0 -11
  358. package/docs/ts-web-extras.showopenfilepickeroptions.md +0 -134
  359. package/docs/ts-web-extras.showopenfilepickeroptions.multiple.md +0 -11
  360. package/docs/ts-web-extras.showopenfilepickeroptions.startin.md +0 -11
  361. package/docs/ts-web-extras.showopenfilepickeroptions.types.md +0 -11
  362. package/docs/ts-web-extras.showsavefilepickeroptions.excludeacceptalloption.md +0 -11
  363. package/docs/ts-web-extras.showsavefilepickeroptions.id.md +0 -11
  364. package/docs/ts-web-extras.showsavefilepickeroptions.md +0 -134
  365. package/docs/ts-web-extras.showsavefilepickeroptions.startin.md +0 -11
  366. package/docs/ts-web-extras.showsavefilepickeroptions.suggestedname.md +0 -11
  367. package/docs/ts-web-extras.showsavefilepickeroptions.types.md +0 -11
  368. package/docs/ts-web-extras.supportsfilesystemaccess.md +0 -56
  369. package/docs/ts-web-extras.treeinitializer.md +0 -15
  370. package/docs/ts-web-extras.wellknowndirectory.md +0 -13
  371. package/docs/ts-web-extras.windowwithfsaccess.md +0 -15
  372. package/lib/packlets/crypto/browserHashProvider.d.ts.map +0 -1
  373. package/lib/packlets/crypto/browserHashProvider.js.map +0 -1
  374. package/lib/packlets/crypto/index.d.ts.map +0 -1
  375. package/lib/packlets/crypto/index.js.map +0 -1
  376. package/temp/build/typescript/ts_vnCx6LlY.json +0 -1
  377. package/temp/test/jest/haste-map-7492f1b44480e0cdd1f220078fb3afd8-c8dd6c3430605adeb2f1cadf4f75e791-8c9336785555d572065b28c111982ba4 +0 -0
  378. package/temp/test/jest/perf-cache-7492f1b44480e0cdd1f220078fb3afd8-da39a3ee5e6b4b0d3255bfef95601890 +0 -1
  379. /package/dist/packlets/{crypto → crypto-utils}/browserHashProvider.js +0 -0
  380. /package/lib/packlets/{crypto → crypto-utils}/browserHashProvider.d.ts +0 -0
  381. /package/lib/packlets/{crypto → crypto-utils}/browserHashProvider.js +0 -0
  382. /package/src/packlets/{crypto → crypto-utils}/browserHashProvider.ts +0 -0
  383. /package/temp/test/jest/{jest-transform-cache-7492f1b44480e0cdd1f220078fb3afd8-79ef2876fae7ca75eedb2aa53dc48338/0e/package_0eb6535f5987849d93ea51ef33a14cf6 → jest-transform-cache-b931e4e63102f86c5bd4949f7dced44f-79ef2876fae7ca75eedb2aa53dc48338/b5/package_b5f57afc9ec2c011239b1608ee5bdfa5} +0 -0
@@ -0,0 +1,812 @@
1
+ /*
2
+ * Copyright (c) 2026 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
+ import '@fgv/ts-utils-jest';
23
+ import { FileTree } from '@fgv/ts-json-base';
24
+ import { LocalStorageTreeAccessors, FileApiTreeAccessors } from '../../packlets/file-tree';
25
+ /**
26
+ * Mock Storage implementation for testing
27
+ */
28
+ class MockStorage {
29
+ constructor() {
30
+ this._data = new Map();
31
+ }
32
+ get length() {
33
+ return this._data.size;
34
+ }
35
+ clear() {
36
+ this._data.clear();
37
+ }
38
+ getItem(key) {
39
+ var _a;
40
+ return (_a = this._data.get(key)) !== null && _a !== void 0 ? _a : null;
41
+ }
42
+ key(index) {
43
+ var _a;
44
+ const keys = Array.from(this._data.keys());
45
+ return (_a = keys[index]) !== null && _a !== void 0 ? _a : null;
46
+ }
47
+ removeItem(key) {
48
+ this._data.delete(key);
49
+ }
50
+ setItem(key, value) {
51
+ this._data.set(key, value);
52
+ }
53
+ }
54
+ describe('LocalStorageTreeAccessors', () => {
55
+ let mockStorage;
56
+ beforeEach(() => {
57
+ mockStorage = new MockStorage();
58
+ });
59
+ describe('fromStorage', () => {
60
+ test('creates accessors from empty storage', () => {
61
+ const result = LocalStorageTreeAccessors.fromStorage({
62
+ pathToKeyMap: {
63
+ '/data/ingredients': 'test:ingredients:v1'
64
+ },
65
+ storage: mockStorage
66
+ });
67
+ expect(result).toSucceedAndSatisfy((accessors) => {
68
+ expect(accessors).toBeInstanceOf(LocalStorageTreeAccessors);
69
+ expect(accessors.isDirty()).toBe(false);
70
+ });
71
+ });
72
+ test('loads collections from storage', () => {
73
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
74
+ collection1: { items: { item1: {} } },
75
+ collection2: { items: { item2: {} } }
76
+ }));
77
+ const result = LocalStorageTreeAccessors.fromStorage({
78
+ pathToKeyMap: {
79
+ '/data/ingredients': 'test:ingredients:v1'
80
+ },
81
+ storage: mockStorage
82
+ });
83
+ expect(result).toSucceedAndSatisfy((accessors) => {
84
+ expect(accessors.getFileContents('/data/ingredients/collection1.json')).toSucceed();
85
+ expect(accessors.getFileContents('/data/ingredients/collection2.json')).toSucceed();
86
+ });
87
+ });
88
+ test('loads from multiple storage keys', () => {
89
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ ing1: { items: {} } }));
90
+ mockStorage.setItem('test:fillings:v1', JSON.stringify({ fill1: { items: {} } }));
91
+ const result = LocalStorageTreeAccessors.fromStorage({
92
+ pathToKeyMap: {
93
+ '/data/ingredients': 'test:ingredients:v1',
94
+ '/data/fillings': 'test:fillings:v1'
95
+ },
96
+ storage: mockStorage
97
+ });
98
+ expect(result).toSucceedAndSatisfy((accessors) => {
99
+ expect(accessors.getFileContents('/data/ingredients/ing1.json')).toSucceed();
100
+ expect(accessors.getFileContents('/data/fillings/fill1.json')).toSucceed();
101
+ });
102
+ });
103
+ test('skips corrupted JSON data', () => {
104
+ mockStorage.setItem('test:ingredients:v1', 'not valid json');
105
+ const result = LocalStorageTreeAccessors.fromStorage({
106
+ pathToKeyMap: {
107
+ '/data/ingredients': 'test:ingredients:v1'
108
+ },
109
+ storage: mockStorage
110
+ });
111
+ expect(result).toSucceedAndSatisfy((accessors) => {
112
+ expect(accessors).toBeInstanceOf(LocalStorageTreeAccessors);
113
+ });
114
+ });
115
+ test('skips non-object JSON', () => {
116
+ mockStorage.setItem('test:ingredients:v1', '"string value"');
117
+ const result = LocalStorageTreeAccessors.fromStorage({
118
+ pathToKeyMap: {
119
+ '/data/ingredients': 'test:ingredients:v1'
120
+ },
121
+ storage: mockStorage
122
+ });
123
+ expect(result).toSucceedAndSatisfy((accessors) => {
124
+ expect(accessors).toBeInstanceOf(LocalStorageTreeAccessors);
125
+ });
126
+ });
127
+ test('loads string values (new format) with inferred extension', () => {
128
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
129
+ jsonCollection: '{"items":{}}',
130
+ yamlCollection: 'metadata:\n name: test\nitems: {}'
131
+ }));
132
+ const result = LocalStorageTreeAccessors.fromStorage({
133
+ pathToKeyMap: {
134
+ '/data/ingredients': 'test:ingredients:v1'
135
+ },
136
+ storage: mockStorage
137
+ });
138
+ expect(result).toSucceedAndSatisfy((accessors) => {
139
+ expect(accessors.getFileContents('/data/ingredients/jsonCollection.json')).toSucceedWith('{"items":{}}');
140
+ expect(accessors.getFileContents('/data/ingredients/yamlCollection.yaml')).toSucceedWith('metadata:\n name: test\nitems: {}');
141
+ });
142
+ });
143
+ test('skips non-object non-string collection values', () => {
144
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
145
+ good: { items: {} },
146
+ bad: 42
147
+ }));
148
+ const result = LocalStorageTreeAccessors.fromStorage({
149
+ pathToKeyMap: {
150
+ '/data/ingredients': 'test:ingredients:v1'
151
+ },
152
+ storage: mockStorage
153
+ });
154
+ expect(result).toSucceedAndSatisfy((accessors) => {
155
+ expect(accessors.getFileContents('/data/ingredients/good.json')).toSucceed();
156
+ });
157
+ });
158
+ test('applies prefix parameter', () => {
159
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
160
+ const result = LocalStorageTreeAccessors.fromStorage({
161
+ pathToKeyMap: {
162
+ '/data/ingredients': 'test:ingredients:v1'
163
+ },
164
+ storage: mockStorage,
165
+ prefix: '/myapp'
166
+ });
167
+ expect(result).toSucceedAndSatisfy((accessors) => {
168
+ expect(accessors.getFileContents('/myapp/data/ingredients/collection1.json')).toSucceed();
169
+ });
170
+ });
171
+ test('succeeds with empty storage when no data present', () => {
172
+ const result = LocalStorageTreeAccessors.fromStorage({
173
+ pathToKeyMap: {
174
+ '/data/ingredients': 'test:ingredients:v1'
175
+ },
176
+ storage: mockStorage
177
+ });
178
+ expect(result).toSucceedAndSatisfy((accessors) => {
179
+ expect(accessors).toBeInstanceOf(LocalStorageTreeAccessors);
180
+ });
181
+ });
182
+ });
183
+ describe('dirty tracking', () => {
184
+ test('starts with no dirty files', () => {
185
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
186
+ const accessors = LocalStorageTreeAccessors.fromStorage({
187
+ pathToKeyMap: {
188
+ '/data/ingredients': 'test:ingredients:v1'
189
+ },
190
+ storage: mockStorage,
191
+ mutable: true
192
+ }).orThrow();
193
+ expect(accessors.isDirty()).toBe(false);
194
+ expect(accessors.getDirtyPaths()).toEqual([]);
195
+ });
196
+ test('marks files as dirty after modification', () => {
197
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
198
+ const accessors = LocalStorageTreeAccessors.fromStorage({
199
+ pathToKeyMap: {
200
+ '/data/ingredients': 'test:ingredients:v1'
201
+ },
202
+ storage: mockStorage,
203
+ mutable: true
204
+ }).orThrow();
205
+ const newContent = JSON.stringify({ items: { modified: true } });
206
+ accessors.saveFileContents('/data/ingredients/collection1.json', newContent).orThrow();
207
+ expect(accessors.isDirty()).toBe(true);
208
+ expect(accessors.getDirtyPaths()).toContain('/data/ingredients/collection1.json');
209
+ });
210
+ test('tracks multiple dirty files', () => {
211
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
212
+ collection1: { items: {} },
213
+ collection2: { items: {} }
214
+ }));
215
+ const accessors = LocalStorageTreeAccessors.fromStorage({
216
+ pathToKeyMap: {
217
+ '/data/ingredients': 'test:ingredients:v1'
218
+ },
219
+ storage: mockStorage,
220
+ mutable: true
221
+ }).orThrow();
222
+ accessors
223
+ .saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ items: { a: 1 } }))
224
+ .orThrow();
225
+ accessors
226
+ .saveFileContents('/data/ingredients/collection2.json', JSON.stringify({ items: { b: 2 } }))
227
+ .orThrow();
228
+ expect(accessors.isDirty()).toBe(true);
229
+ expect(accessors.getDirtyPaths()).toHaveLength(2);
230
+ });
231
+ });
232
+ describe('syncToDisk', () => {
233
+ test('syncs modified files to storage', async () => {
234
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: { original: true } } }));
235
+ const accessors = LocalStorageTreeAccessors.fromStorage({
236
+ pathToKeyMap: {
237
+ '/data/ingredients': 'test:ingredients:v1'
238
+ },
239
+ storage: mockStorage,
240
+ mutable: true
241
+ }).orThrow();
242
+ const newContent = JSON.stringify({ items: { modified: true } });
243
+ accessors.saveFileContents('/data/ingredients/collection1.json', newContent).orThrow();
244
+ const syncResult = await accessors.syncToDisk();
245
+ expect(syncResult).toSucceed();
246
+ const stored = mockStorage.getItem('test:ingredients:v1');
247
+ expect(stored).toBeTruthy();
248
+ const parsed = JSON.parse(stored);
249
+ // New format: values are raw content strings
250
+ expect(parsed.collection1).toBe(newContent);
251
+ });
252
+ test('clears dirty state after successful sync', async () => {
253
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
254
+ const accessors = LocalStorageTreeAccessors.fromStorage({
255
+ pathToKeyMap: {
256
+ '/data/ingredients': 'test:ingredients:v1'
257
+ },
258
+ storage: mockStorage,
259
+ mutable: true
260
+ }).orThrow();
261
+ accessors
262
+ .saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ items: { a: 1 } }))
263
+ .orThrow();
264
+ expect(accessors.isDirty()).toBe(true);
265
+ await accessors.syncToDisk();
266
+ expect(accessors.isDirty()).toBe(false);
267
+ expect(accessors.getDirtyPaths()).toEqual([]);
268
+ });
269
+ test('syncs multiple files to same storage key', async () => {
270
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
271
+ collection1: { items: {} },
272
+ collection2: { items: {} }
273
+ }));
274
+ const accessors = LocalStorageTreeAccessors.fromStorage({
275
+ pathToKeyMap: {
276
+ '/data/ingredients': 'test:ingredients:v1'
277
+ },
278
+ storage: mockStorage,
279
+ mutable: true
280
+ }).orThrow();
281
+ const content1 = JSON.stringify({ items: { a: 1 } });
282
+ const content2 = JSON.stringify({ items: { b: 2 } });
283
+ accessors.saveFileContents('/data/ingredients/collection1.json', content1).orThrow();
284
+ accessors.saveFileContents('/data/ingredients/collection2.json', content2).orThrow();
285
+ await accessors.syncToDisk();
286
+ const stored = mockStorage.getItem('test:ingredients:v1');
287
+ const parsed = JSON.parse(stored);
288
+ // New format: values are raw content strings
289
+ expect(parsed.collection1).toBe(content1);
290
+ expect(parsed.collection2).toBe(content2);
291
+ });
292
+ test('syncs files to different storage keys', async () => {
293
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ ing1: { items: {} } }));
294
+ mockStorage.setItem('test:fillings:v1', JSON.stringify({ fill1: { items: {} } }));
295
+ const accessors = LocalStorageTreeAccessors.fromStorage({
296
+ pathToKeyMap: {
297
+ '/data/ingredients': 'test:ingredients:v1',
298
+ '/data/fillings': 'test:fillings:v1'
299
+ },
300
+ storage: mockStorage,
301
+ mutable: true
302
+ }).orThrow();
303
+ accessors
304
+ .saveFileContents('/data/ingredients/ing1.json', JSON.stringify({ items: { a: 1 } }))
305
+ .orThrow();
306
+ accessors.saveFileContents('/data/fillings/fill1.json', JSON.stringify({ items: { b: 2 } })).orThrow();
307
+ await accessors.syncToDisk();
308
+ const ingContent = JSON.stringify({ items: { a: 1 } });
309
+ const fillContent = JSON.stringify({ items: { b: 2 } });
310
+ const ingStored = JSON.parse(mockStorage.getItem('test:ingredients:v1'));
311
+ const fillStored = JSON.parse(mockStorage.getItem('test:fillings:v1'));
312
+ // New format: values are raw content strings
313
+ expect(ingStored.ing1).toBe(ingContent);
314
+ expect(fillStored.fill1).toBe(fillContent);
315
+ });
316
+ test('succeeds with no dirty files', async () => {
317
+ const accessors = LocalStorageTreeAccessors.fromStorage({
318
+ pathToKeyMap: {
319
+ '/data/ingredients': 'test:ingredients:v1'
320
+ },
321
+ storage: mockStorage
322
+ }).orThrow();
323
+ const result = await accessors.syncToDisk();
324
+ expect(result).toSucceed();
325
+ });
326
+ test('preserves existing collections when syncing', async () => {
327
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
328
+ existing: { items: { keep: true } },
329
+ toModify: { items: { original: true } }
330
+ }));
331
+ const accessors = LocalStorageTreeAccessors.fromStorage({
332
+ pathToKeyMap: {
333
+ '/data/ingredients': 'test:ingredients:v1'
334
+ },
335
+ storage: mockStorage,
336
+ mutable: true
337
+ }).orThrow();
338
+ const modifiedContent = JSON.stringify({ items: { modified: true } });
339
+ accessors.saveFileContents('/data/ingredients/toModify.json', modifiedContent).orThrow();
340
+ await accessors.syncToDisk();
341
+ const stored = JSON.parse(mockStorage.getItem('test:ingredients:v1'));
342
+ // existing was loaded from legacy format and not modified, so it stays as legacy object
343
+ // toModify was saved with new content, so it's now a raw string
344
+ expect(stored.toModify).toBe(modifiedContent);
345
+ });
346
+ });
347
+ describe('autoSync mode', () => {
348
+ test('automatically syncs on save when enabled', () => {
349
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
350
+ const accessors = LocalStorageTreeAccessors.fromStorage({
351
+ pathToKeyMap: {
352
+ '/data/ingredients': 'test:ingredients:v1'
353
+ },
354
+ storage: mockStorage,
355
+ mutable: true,
356
+ autoSync: true
357
+ }).orThrow();
358
+ accessors
359
+ .saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ items: { auto: true } }))
360
+ .orThrow();
361
+ expect(accessors.isDirty()).toBe(false);
362
+ const autoContent = JSON.stringify({ items: { auto: true } });
363
+ const stored = JSON.parse(mockStorage.getItem('test:ingredients:v1'));
364
+ // New format: values are raw content strings
365
+ expect(stored.collection1).toBe(autoContent);
366
+ });
367
+ test('does not auto-sync when disabled', () => {
368
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
369
+ const accessors = LocalStorageTreeAccessors.fromStorage({
370
+ pathToKeyMap: {
371
+ '/data/ingredients': 'test:ingredients:v1'
372
+ },
373
+ storage: mockStorage,
374
+ mutable: true,
375
+ autoSync: false
376
+ }).orThrow();
377
+ accessors
378
+ .saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ items: { manual: true } }))
379
+ .orThrow();
380
+ expect(accessors.isDirty()).toBe(true);
381
+ // Storage should still have the original legacy format (not yet synced)
382
+ const stored = JSON.parse(mockStorage.getItem('test:ingredients:v1'));
383
+ expect(stored.collection1).toEqual({ items: {} });
384
+ });
385
+ });
386
+ describe('fileIsMutable', () => {
387
+ test('returns persistent detail when mutable', () => {
388
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
389
+ const accessors = LocalStorageTreeAccessors.fromStorage({
390
+ pathToKeyMap: {
391
+ '/data/ingredients': 'test:ingredients:v1'
392
+ },
393
+ storage: mockStorage,
394
+ mutable: true
395
+ }).orThrow();
396
+ expect(accessors.fileIsMutable('/data/ingredients/collection1.json')).toSucceedWithDetail(true, 'persistent');
397
+ });
398
+ test('returns not-mutable when not mutable', () => {
399
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
400
+ const accessors = LocalStorageTreeAccessors.fromStorage({
401
+ pathToKeyMap: {
402
+ '/data/ingredients': 'test:ingredients:v1'
403
+ },
404
+ storage: mockStorage,
405
+ mutable: false
406
+ }).orThrow();
407
+ const result = accessors.fileIsMutable('/data/ingredients/collection1.json');
408
+ expect(result.isFailure()).toBe(true);
409
+ if (result.isFailure()) {
410
+ expect(result.detail).toBe('not-mutable');
411
+ }
412
+ });
413
+ });
414
+ describe('integration with FileApiTreeAccessors', () => {
415
+ test('createFromLocalStorage creates FileTree with persistent accessors', () => {
416
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
417
+ const result = FileApiTreeAccessors.createFromLocalStorage({
418
+ pathToKeyMap: {
419
+ '/data/ingredients': 'test:ingredients:v1'
420
+ },
421
+ storage: mockStorage,
422
+ mutable: true
423
+ });
424
+ expect(result).toSucceed();
425
+ const tree = result.orThrow();
426
+ expect(tree).toBeInstanceOf(FileTree.FileTree);
427
+ expect(FileTree.isPersistentAccessors(tree.hal)).toBe(true);
428
+ const file = tree.getFile('/data/ingredients/collection1.json').orThrow();
429
+ expect(FileTree.isMutableFileItem(file)).toBe(true);
430
+ if (FileTree.isMutableFileItem(file)) {
431
+ expect(file.getIsMutable()).toSucceedWithDetail(true, 'persistent');
432
+ }
433
+ });
434
+ test('createFromLocalStorage with multiple paths', () => {
435
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ ing1: { items: {} } }));
436
+ mockStorage.setItem('test:fillings:v1', JSON.stringify({ fill1: { items: {} } }));
437
+ const result = FileApiTreeAccessors.createFromLocalStorage({
438
+ pathToKeyMap: {
439
+ '/data/ingredients': 'test:ingredients:v1',
440
+ '/data/fillings': 'test:fillings:v1'
441
+ },
442
+ storage: mockStorage,
443
+ mutable: true
444
+ });
445
+ expect(result).toSucceedAndSatisfy((tree) => {
446
+ expect(tree.getFile('/data/ingredients/ing1.json')).toSucceed();
447
+ expect(tree.getFile('/data/fillings/fill1.json')).toSucceed();
448
+ });
449
+ });
450
+ test('createFromLocalStorage with empty storage', () => {
451
+ const result = FileApiTreeAccessors.createFromLocalStorage({
452
+ pathToKeyMap: {
453
+ '/data/ingredients': 'test:ingredients:v1'
454
+ },
455
+ storage: mockStorage
456
+ });
457
+ expect(result).toSucceedAndSatisfy((tree) => {
458
+ expect(tree).toBeInstanceOf(FileTree.FileTree);
459
+ });
460
+ });
461
+ test('createFromLocalStorage fails when localStorage is not available', () => {
462
+ // Remove the global window object to ensure no fallback
463
+ const originalWindow = global.window;
464
+ delete global.window;
465
+ const result = FileApiTreeAccessors.createFromLocalStorage({
466
+ pathToKeyMap: {
467
+ '/data/ingredients': 'test:ingredients:v1'
468
+ },
469
+ storage: undefined
470
+ });
471
+ // Restore window
472
+ global.window = originalWindow;
473
+ expect(result).toFailWith(/localStorage is not available/i);
474
+ });
475
+ });
476
+ describe('path matching and error handling', () => {
477
+ test('handles files outside configured paths', async () => {
478
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
479
+ const accessors = LocalStorageTreeAccessors.fromStorage({
480
+ pathToKeyMap: {
481
+ '/data/ingredients': 'test:ingredients:v1'
482
+ },
483
+ storage: mockStorage,
484
+ mutable: true
485
+ }).orThrow();
486
+ // Try to save a file outside the configured path
487
+ const saveResult = accessors.saveFileContents('/other/path/file.json', JSON.stringify({ test: 1 }));
488
+ expect(saveResult).toSucceed();
489
+ // But syncing should fail because no storage key is configured
490
+ const syncResult = await accessors.syncToDisk();
491
+ expect(syncResult).toFailWith(/No storage key configured for path/i);
492
+ });
493
+ test('handles files inside configured paths', async () => {
494
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
495
+ const accessors = LocalStorageTreeAccessors.fromStorage({
496
+ pathToKeyMap: {
497
+ '/data/ingredients': 'test:ingredients:v1'
498
+ },
499
+ storage: mockStorage,
500
+ mutable: true
501
+ }).orThrow();
502
+ // Save a file inside the configured path
503
+ accessors.saveFileContents('/data/ingredients/newfile.json', JSON.stringify({ test: 1 })).orThrow();
504
+ // Syncing should succeed
505
+ const syncResult = await accessors.syncToDisk();
506
+ expect(syncResult).toSucceed();
507
+ });
508
+ test('handles failed content retrieval during sync', async () => {
509
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
510
+ const accessors = LocalStorageTreeAccessors.fromStorage({
511
+ pathToKeyMap: {
512
+ '/data/ingredients': 'test:ingredients:v1'
513
+ },
514
+ storage: mockStorage,
515
+ mutable: true
516
+ }).orThrow();
517
+ // Modify a file
518
+ accessors.saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ test: 1 })).orThrow();
519
+ // Override getFileContents to fail
520
+ const originalGetFileContents = accessors.getFileContents.bind(accessors);
521
+ accessors.getFileContents = jest.fn((path) => {
522
+ if (path === '/data/ingredients/collection1.json') {
523
+ return { isSuccess: () => false, isFailure: () => true, message: 'File not found' };
524
+ }
525
+ return originalGetFileContents(path);
526
+ });
527
+ const syncResult = await accessors.syncToDisk();
528
+ expect(syncResult).toFailWith(/Failed to get file contents.*File not found/i);
529
+ });
530
+ test('handles corrupted JSON in localStorage during sync', async () => {
531
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
532
+ const accessors = LocalStorageTreeAccessors.fromStorage({
533
+ pathToKeyMap: {
534
+ '/data/ingredients': 'test:ingredients:v1'
535
+ },
536
+ storage: mockStorage,
537
+ mutable: true
538
+ }).orThrow();
539
+ // Modify a file
540
+ accessors.saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ test: 1 })).orThrow();
541
+ // Corrupt the existing storage data
542
+ mockStorage.setItem('test:ingredients:v1', 'not valid json');
543
+ // Sync should still succeed by starting fresh
544
+ const syncResult = await accessors.syncToDisk();
545
+ expect(syncResult).toSucceed();
546
+ // Verify the data was written correctly despite corrupted previous data
547
+ const stored = mockStorage.getItem('test:ingredients:v1');
548
+ const parsed = JSON.parse(stored);
549
+ // New format: values are raw content strings
550
+ expect(parsed.collection1).toBe(JSON.stringify({ test: 1 }));
551
+ });
552
+ test('syncs non-JSON content (YAML) without error', async () => {
553
+ const accessors = LocalStorageTreeAccessors.fromStorage({
554
+ pathToKeyMap: {
555
+ '/data/ingredients': 'test:ingredients:v1'
556
+ },
557
+ storage: mockStorage,
558
+ mutable: true
559
+ }).orThrow();
560
+ // Create and save a YAML file
561
+ const yamlContent = 'metadata:\n name: test\nitems: {}';
562
+ accessors.saveFileContents('/data/ingredients/my-collection.yaml', yamlContent).orThrow();
563
+ const syncResult = await accessors.syncToDisk();
564
+ expect(syncResult).toSucceed();
565
+ const stored = JSON.parse(mockStorage.getItem('test:ingredients:v1'));
566
+ expect(stored['my-collection']).toBe(yamlContent);
567
+ });
568
+ test('handles multiple sync failures with aggregated errors', async () => {
569
+ const accessors = LocalStorageTreeAccessors.fromStorage({
570
+ pathToKeyMap: {
571
+ '/data/ingredients': 'test:ingredients:v1'
572
+ },
573
+ storage: mockStorage,
574
+ mutable: true
575
+ }).orThrow();
576
+ // Add files outside configured paths
577
+ accessors.saveFileContents('/other1/file1.json', JSON.stringify({ test: 1 })).orThrow();
578
+ accessors.saveFileContents('/other2/file2.json', JSON.stringify({ test: 2 })).orThrow();
579
+ const syncResult = await accessors.syncToDisk();
580
+ expect(syncResult).toFailWith(/Failed to sync 2 file\(s\)/i);
581
+ });
582
+ test('handles auto-sync failure', () => {
583
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
584
+ const accessors = LocalStorageTreeAccessors.fromStorage({
585
+ pathToKeyMap: {
586
+ '/data/ingredients': 'test:ingredients:v1'
587
+ },
588
+ storage: mockStorage,
589
+ mutable: true,
590
+ autoSync: true
591
+ }).orThrow();
592
+ // Try to save a file outside configured path with autoSync enabled
593
+ const saveResult = accessors.saveFileContents('/other/path/file.json', JSON.stringify({ test: 1 }));
594
+ expect(saveResult).toFailWith(/No storage key configured for path/i);
595
+ });
596
+ });
597
+ describe('deleteFile', () => {
598
+ test('deletes a file from in-memory storage and from localStorage', () => {
599
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
600
+ collection1: '{"items":{}}',
601
+ collection2: '{"items":{}}'
602
+ }));
603
+ const accessors = LocalStorageTreeAccessors.fromStorage({
604
+ pathToKeyMap: {
605
+ '/data/ingredients': 'test:ingredients:v1'
606
+ },
607
+ storage: mockStorage,
608
+ mutable: true
609
+ }).orThrow();
610
+ const result = accessors.deleteFile('/data/ingredients/collection1.json');
611
+ expect(result).toSucceedWith(true);
612
+ // File should no longer be accessible in-memory
613
+ expect(accessors.getFileContents('/data/ingredients/collection1.json')).toFail();
614
+ // The deleted collection should be removed from localStorage; collection2 remains
615
+ const stored = mockStorage.getItem('test:ingredients:v1');
616
+ expect(stored).toBeTruthy();
617
+ const parsed = JSON.parse(stored);
618
+ expect(parsed).not.toHaveProperty('collection1');
619
+ expect(parsed).toHaveProperty('collection2');
620
+ });
621
+ test('removes the storage key entirely when last entry is deleted', () => {
622
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ onlyCollection: '{"items":{}}' }));
623
+ const accessors = LocalStorageTreeAccessors.fromStorage({
624
+ pathToKeyMap: {
625
+ '/data/ingredients': 'test:ingredients:v1'
626
+ },
627
+ storage: mockStorage,
628
+ mutable: true
629
+ }).orThrow();
630
+ const result = accessors.deleteFile('/data/ingredients/onlyCollection.json');
631
+ expect(result).toSucceedWith(true);
632
+ // Storage key should be removed entirely since no more entries remain
633
+ expect(mockStorage.getItem('test:ingredients:v1')).toBeNull();
634
+ });
635
+ test('removes path from dirty set when deleting a dirty file', () => {
636
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: '{"items":{}}' }));
637
+ const accessors = LocalStorageTreeAccessors.fromStorage({
638
+ pathToKeyMap: {
639
+ '/data/ingredients': 'test:ingredients:v1'
640
+ },
641
+ storage: mockStorage,
642
+ mutable: true
643
+ }).orThrow();
644
+ // Mark file as dirty first
645
+ accessors
646
+ .saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ items: { modified: true } }))
647
+ .orThrow();
648
+ expect(accessors.isDirty()).toBe(true);
649
+ // Deleting the file should clean it from the dirty set
650
+ const result = accessors.deleteFile('/data/ingredients/collection1.json');
651
+ expect(result).toSucceedWith(true);
652
+ expect(accessors.isDirty()).toBe(false);
653
+ expect(accessors.getDirtyPaths()).not.toContain('/data/ingredients/collection1.json');
654
+ });
655
+ test('fails when deleting a non-existent file', () => {
656
+ const accessors = LocalStorageTreeAccessors.fromStorage({
657
+ pathToKeyMap: {
658
+ '/data/ingredients': 'test:ingredients:v1'
659
+ },
660
+ storage: mockStorage,
661
+ mutable: true
662
+ }).orThrow();
663
+ const result = accessors.deleteFile('/data/ingredients/nonexistent.json');
664
+ expect(result).toFail();
665
+ });
666
+ test('does not modify storage when file has no matching storage key', () => {
667
+ // Create accessors with one path, but a file that will be stored outside that path
668
+ const accessors = LocalStorageTreeAccessors.fromStorage({
669
+ pathToKeyMap: {
670
+ '/data/ingredients': 'test:ingredients:v1'
671
+ },
672
+ storage: mockStorage,
673
+ mutable: true
674
+ }).orThrow();
675
+ // Add and delete a file inside the configured path but with no existing storage entry
676
+ accessors.saveFileContents('/data/ingredients/newfile.json', '{"items":{}}').orThrow();
677
+ // Sync so it exists in storage
678
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ newfile: '{"items":{}}' }));
679
+ // Now re-load and delete — the file should be removed from storage
680
+ const accessors2 = LocalStorageTreeAccessors.fromStorage({
681
+ pathToKeyMap: {
682
+ '/data/ingredients': 'test:ingredients:v1'
683
+ },
684
+ storage: mockStorage,
685
+ mutable: true
686
+ }).orThrow();
687
+ const result = accessors2.deleteFile('/data/ingredients/newfile.json');
688
+ expect(result).toSucceedWith(true);
689
+ expect(mockStorage.getItem('test:ingredients:v1')).toBeNull();
690
+ });
691
+ test('handles deletion when localStorage key has no entry for the file', () => {
692
+ // Storage key exists but does not contain an entry for the file being deleted
693
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ other: '{"items":{}}' }));
694
+ // Manually add a file to in-memory without it being in the storage JSON
695
+ const accessors = LocalStorageTreeAccessors.fromStorage({
696
+ pathToKeyMap: {
697
+ '/data/ingredients': 'test:ingredients:v1'
698
+ },
699
+ storage: mockStorage,
700
+ mutable: true
701
+ }).orThrow();
702
+ // Save a new file (marks dirty but does not update storage yet)
703
+ accessors.saveFileContents('/data/ingredients/newfile.json', '{"items":{}}').orThrow();
704
+ // Clear the dirty flag by directly removing from storage (simulate storage mismatch)
705
+ // Then delete the file — _deleteFileFromStorage gets the existing JSON which lacks 'newfile'
706
+ // This exercises the path where the collection is not in the existing JSON
707
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ other: '{"items":{}}' }));
708
+ const result = accessors.deleteFile('/data/ingredients/newfile.json');
709
+ expect(result).toSucceedWith(true);
710
+ // 'other' should still remain in storage since only 'newfile' was deleted (which wasn't there)
711
+ const stored = mockStorage.getItem('test:ingredients:v1');
712
+ expect(stored).toBeTruthy();
713
+ const parsed = JSON.parse(stored);
714
+ expect(parsed).toHaveProperty('other');
715
+ });
716
+ test('handles deletion when storage entry for key is missing entirely', () => {
717
+ // No storage key at all — _deleteFileFromStorage should return early
718
+ const accessors = LocalStorageTreeAccessors.fromStorage({
719
+ pathToKeyMap: {
720
+ '/data/ingredients': 'test:ingredients:v1'
721
+ },
722
+ storage: mockStorage,
723
+ mutable: true
724
+ }).orThrow();
725
+ // Manually put a file in memory by saving it
726
+ accessors.saveFileContents('/data/ingredients/newfile.json', '{"items":{}}').orThrow();
727
+ // Delete the storage key so getItem returns null
728
+ mockStorage.removeItem('test:ingredients:v1');
729
+ // deleteFile should still succeed (in-memory deletion succeeds; storage cleanup is a no-op)
730
+ const result = accessors.deleteFile('/data/ingredients/newfile.json');
731
+ expect(result).toSucceedWith(true);
732
+ });
733
+ test('handles deletion when storage contains corrupted JSON', () => {
734
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: '{"items":{}}' }));
735
+ const accessors = LocalStorageTreeAccessors.fromStorage({
736
+ pathToKeyMap: {
737
+ '/data/ingredients': 'test:ingredients:v1'
738
+ },
739
+ storage: mockStorage,
740
+ mutable: true
741
+ }).orThrow();
742
+ // Corrupt the storage so JSON.parse fails in _deleteFileFromStorage
743
+ mockStorage.setItem('test:ingredients:v1', 'not valid json {{{');
744
+ // deleteFile should still succeed — corrupted JSON is silently ignored
745
+ const result = accessors.deleteFile('/data/ingredients/collection1.json');
746
+ expect(result).toSucceedWith(true);
747
+ });
748
+ test('deletes a file at a path outside all configured storage keys', () => {
749
+ // A file can be saved in-memory at a path that has no matching storage key.
750
+ // When deleted, _deleteFileFromStorage should return early without touching storage.
751
+ const accessors = LocalStorageTreeAccessors.fromStorage({
752
+ pathToKeyMap: {
753
+ '/data/ingredients': 'test:ingredients:v1'
754
+ },
755
+ storage: mockStorage,
756
+ mutable: true
757
+ }).orThrow();
758
+ // Save a file outside the configured path (succeeds in-memory, marks dirty)
759
+ accessors.saveFileContents('/untracked/file.json', '{"items":{}}').orThrow();
760
+ // Delete it — should succeed even though there is no storage key for this path
761
+ const result = accessors.deleteFile('/untracked/file.json');
762
+ expect(result).toSucceedWith(true);
763
+ // Storage should be untouched
764
+ expect(mockStorage.getItem('test:ingredients:v1')).toBeNull();
765
+ });
766
+ });
767
+ describe('inferContentType callback in _loadFromStorage', () => {
768
+ test('calls inferContentType when loading files from storage', () => {
769
+ // Covers lines 163-164: the params.inferContentType branch in _loadFromStorage
770
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
771
+ myCollection: '{"items":{}}'
772
+ }));
773
+ const inferContentType = jest.fn((filePath, _provided) => {
774
+ const { succeed: s } = require('@fgv/ts-utils');
775
+ return s('application/json');
776
+ });
777
+ const result = LocalStorageTreeAccessors.fromStorage({
778
+ pathToKeyMap: {
779
+ '/data/ingredients': 'test:ingredients:v1'
780
+ },
781
+ storage: mockStorage,
782
+ inferContentType
783
+ });
784
+ expect(result).toSucceed();
785
+ expect(inferContentType).toHaveBeenCalledWith('/data/ingredients/myCollection.json', undefined);
786
+ });
787
+ });
788
+ describe('extension-less file path handling', () => {
789
+ test('syncs a file whose path has no extension (collection ID has no dot)', async () => {
790
+ // Covers line 249: dotIndex <= 0 case in _getCollectionIdFromPath, returning cleanPath as-is
791
+ // We save a file at a path with no file extension; the collection ID extracted
792
+ // will be the entire basename (no dot to strip).
793
+ const accessors = LocalStorageTreeAccessors.fromStorage({
794
+ pathToKeyMap: {
795
+ '/data/ingredients': 'test:ingredients:v1'
796
+ },
797
+ storage: mockStorage,
798
+ mutable: true
799
+ }).orThrow();
800
+ // Save a file at a path with no extension
801
+ accessors.saveFileContents('/data/ingredients/nodot', '{"items":{}}').orThrow();
802
+ const syncResult = await accessors.syncToDisk();
803
+ expect(syncResult).toSucceed();
804
+ // The collection ID stored in localStorage should be 'nodot' (no extension stripped)
805
+ const stored = mockStorage.getItem('test:ingredients:v1');
806
+ expect(stored).toBeTruthy();
807
+ const parsed = JSON.parse(stored);
808
+ expect(parsed.nodot).toBe('{"items":{}}');
809
+ });
810
+ });
811
+ });
812
+ //# sourceMappingURL=localStorageTreeAccessors.test.js.map