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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (208) hide show
  1. package/.rush/temp/81e0881271ff236956b2f52e8ca99da6574c6e1e.tar.log +223 -0
  2. package/.rush/temp/chunked-rush-logs/ts-web-extras.build.chunks.jsonl +35 -25
  3. package/.rush/temp/operation/build/all.log +35 -25
  4. package/.rush/temp/operation/build/log-chunks.jsonl +35 -25
  5. package/.rush/temp/operation/build/state.json +1 -1
  6. package/.rush/temp/shrinkwrap-deps.json +175 -163
  7. package/config/jest.config.json +4 -1
  8. package/config/typedoc.json +6 -0
  9. package/dist/index.js +2 -2
  10. package/dist/index.js.map +1 -1
  11. package/dist/packlets/crypto-utils/browserCryptoProvider.js +254 -0
  12. package/dist/packlets/crypto-utils/browserCryptoProvider.js.map +1 -0
  13. package/dist/packlets/crypto-utils/browserHashProvider.js.map +1 -0
  14. package/dist/packlets/{crypto → crypto-utils}/index.js +1 -0
  15. package/dist/packlets/crypto-utils/index.js.map +1 -0
  16. package/dist/packlets/file-api-types/index.js +27 -3
  17. package/dist/packlets/file-api-types/index.js.map +1 -1
  18. package/dist/packlets/file-tree/directoryHandleStore.js +124 -0
  19. package/dist/packlets/file-tree/directoryHandleStore.js.map +1 -0
  20. package/dist/packlets/file-tree/fileApiTreeAccessors.js +76 -0
  21. package/dist/packlets/file-tree/fileApiTreeAccessors.js.map +1 -1
  22. package/dist/packlets/file-tree/fileSystemAccessTreeAccessors.js +345 -0
  23. package/dist/packlets/file-tree/fileSystemAccessTreeAccessors.js.map +1 -0
  24. package/dist/packlets/file-tree/index.js +3 -0
  25. package/dist/packlets/file-tree/index.js.map +1 -1
  26. package/dist/packlets/file-tree/localStorageTreeAccessors.js +308 -0
  27. package/dist/packlets/file-tree/localStorageTreeAccessors.js.map +1 -0
  28. package/dist/test/mocks/idb-keyval.js +6 -0
  29. package/dist/test/mocks/idb-keyval.js.map +1 -0
  30. package/dist/test/unit/browserHashProvider.test.js +1 -1
  31. package/dist/test/unit/browserHashProvider.test.js.map +1 -1
  32. package/dist/test/unit/directoryHandleStore.test.js +190 -0
  33. package/dist/test/unit/directoryHandleStore.test.js.map +1 -0
  34. package/dist/test/unit/fileApiTypes.test.js +30 -0
  35. package/dist/test/unit/fileApiTypes.test.js.map +1 -1
  36. package/dist/test/unit/fileSystemAccessTreeAccessors.test.js +517 -0
  37. package/dist/test/unit/fileSystemAccessTreeAccessors.test.js.map +1 -0
  38. package/dist/test/unit/localStorageTreeAccessors.test.js +595 -0
  39. package/dist/test/unit/localStorageTreeAccessors.test.js.map +1 -0
  40. package/dist/test/utils/fileSystemAccessMocks.js +271 -0
  41. package/dist/test/utils/fileSystemAccessMocks.js.map +1 -0
  42. package/dist/ts-web-extras.d.ts +460 -1
  43. package/dist/tsdoc-metadata.json +1 -1
  44. package/docs/ts-web-extras.cryptoutils.browsercryptoprovider._constructor_.md +50 -0
  45. package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.decrypt.md +104 -0
  46. package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.derivekey.md +88 -0
  47. package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.encrypt.md +72 -0
  48. package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.frombase64.md +56 -0
  49. package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.generatekey.md +19 -0
  50. package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.generaterandombytes.md +56 -0
  51. package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.md +169 -0
  52. package/docs/ts-web-extras.cryptoutils.browsercryptoprovider.tobase64.md +56 -0
  53. package/docs/{ts-web-extras.browserhashprovider.hashparts.md → ts-web-extras.cryptoutils.browserhashprovider.hashparts.md} +2 -2
  54. package/docs/{ts-web-extras.browserhashprovider.hashstring.md → ts-web-extras.cryptoutils.browserhashprovider.hashstring.md} +2 -2
  55. package/docs/{ts-web-extras.browserhashprovider.md → ts-web-extras.cryptoutils.browserhashprovider.md} +4 -4
  56. package/docs/ts-web-extras.cryptoutils.createbrowsercryptoprovider.md +19 -0
  57. package/docs/ts-web-extras.cryptoutils.md +71 -0
  58. package/docs/ts-web-extras.fileapitreeaccessors.createfromlocalstorage.md +74 -0
  59. package/docs/ts-web-extras.fileapitreeaccessors.createpersistent.md +76 -0
  60. package/docs/ts-web-extras.fileapitreeaccessors.md +32 -0
  61. package/docs/ts-web-extras.filesystemaccesstreeaccessors._constructor_.md +114 -0
  62. package/docs/ts-web-extras.filesystemaccesstreeaccessors.fileismutable.md +52 -0
  63. package/docs/ts-web-extras.filesystemaccesstreeaccessors.fromdirectoryhandle.md +72 -0
  64. package/docs/ts-web-extras.filesystemaccesstreeaccessors.getdirtypaths.md +17 -0
  65. package/docs/ts-web-extras.filesystemaccesstreeaccessors.isdirty.md +17 -0
  66. package/docs/ts-web-extras.filesystemaccesstreeaccessors.md +159 -0
  67. package/docs/ts-web-extras.filesystemaccesstreeaccessors.savefilecontents.md +66 -0
  68. package/docs/ts-web-extras.filesystemaccesstreeaccessors.synctodisk.md +17 -0
  69. package/docs/ts-web-extras.ifilesystemaccesstreeparams.autosync.md +13 -0
  70. package/docs/ts-web-extras.ifilesystemaccesstreeparams.md +78 -0
  71. package/docs/ts-web-extras.ifilesystemaccesstreeparams.requirewritepermission.md +13 -0
  72. package/docs/ts-web-extras.ilocalstoragetreeparams.autosync.md +13 -0
  73. package/docs/ts-web-extras.ilocalstoragetreeparams.md +97 -0
  74. package/docs/ts-web-extras.ilocalstoragetreeparams.pathtokeymap.md +13 -0
  75. package/docs/ts-web-extras.ilocalstoragetreeparams.storage.md +13 -0
  76. package/docs/ts-web-extras.localstoragetreeaccessors.fileismutable.md +56 -0
  77. package/docs/ts-web-extras.localstoragetreeaccessors.fromstorage.md +56 -0
  78. package/docs/ts-web-extras.localstoragetreeaccessors.getdirtypaths.md +19 -0
  79. package/docs/ts-web-extras.localstoragetreeaccessors.isdirty.md +19 -0
  80. package/docs/ts-web-extras.localstoragetreeaccessors.md +131 -0
  81. package/docs/ts-web-extras.localstoragetreeaccessors.savefilecontents.md +72 -0
  82. package/docs/ts-web-extras.localstoragetreeaccessors.synctodisk.md +19 -0
  83. package/docs/ts-web-extras.md +50 -4
  84. package/etc/ts-web-extras.api.md +91 -1
  85. package/lib/index.d.ts +2 -1
  86. package/lib/index.d.ts.map +1 -1
  87. package/lib/index.js +25 -2
  88. package/lib/index.js.map +1 -1
  89. package/lib/packlets/crypto-utils/browserCryptoProvider.d.ts +77 -0
  90. package/lib/packlets/crypto-utils/browserCryptoProvider.d.ts.map +1 -0
  91. package/lib/packlets/crypto-utils/browserCryptoProvider.js +259 -0
  92. package/lib/packlets/crypto-utils/browserCryptoProvider.js.map +1 -0
  93. package/lib/packlets/crypto-utils/browserHashProvider.d.ts.map +1 -0
  94. package/lib/packlets/crypto-utils/browserHashProvider.js.map +1 -0
  95. package/lib/packlets/{crypto → crypto-utils}/index.d.ts +1 -0
  96. package/lib/packlets/crypto-utils/index.d.ts.map +1 -0
  97. package/lib/packlets/{crypto → crypto-utils}/index.js +1 -0
  98. package/lib/packlets/crypto-utils/index.js.map +1 -0
  99. package/lib/packlets/file-api-types/index.d.ts.map +1 -1
  100. package/lib/packlets/file-api-types/index.js +27 -3
  101. package/lib/packlets/file-api-types/index.js.map +1 -1
  102. package/lib/packlets/file-tree/directoryHandleStore.d.ts +59 -0
  103. package/lib/packlets/file-tree/directoryHandleStore.d.ts.map +1 -0
  104. package/lib/packlets/file-tree/directoryHandleStore.js +128 -0
  105. package/lib/packlets/file-tree/directoryHandleStore.js.map +1 -0
  106. package/lib/packlets/file-tree/fileApiTreeAccessors.d.ts +57 -0
  107. package/lib/packlets/file-tree/fileApiTreeAccessors.d.ts.map +1 -1
  108. package/lib/packlets/file-tree/fileApiTreeAccessors.js +76 -0
  109. package/lib/packlets/file-tree/fileApiTreeAccessors.js.map +1 -1
  110. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.d.ts +136 -0
  111. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.d.ts.map +1 -0
  112. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.js +349 -0
  113. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.js.map +1 -0
  114. package/lib/packlets/file-tree/index.d.ts +3 -0
  115. package/lib/packlets/file-tree/index.d.ts.map +1 -1
  116. package/lib/packlets/file-tree/index.js +3 -0
  117. package/lib/packlets/file-tree/index.js.map +1 -1
  118. package/lib/packlets/file-tree/localStorageTreeAccessors.d.ts +129 -0
  119. package/lib/packlets/file-tree/localStorageTreeAccessors.d.ts.map +1 -0
  120. package/lib/packlets/file-tree/localStorageTreeAccessors.js +312 -0
  121. package/lib/packlets/file-tree/localStorageTreeAccessors.js.map +1 -0
  122. package/lib/test/mocks/idb-keyval.d.ts +6 -0
  123. package/lib/test/mocks/idb-keyval.d.ts.map +1 -0
  124. package/lib/test/mocks/idb-keyval.js +9 -0
  125. package/lib/test/mocks/idb-keyval.js.map +1 -0
  126. package/lib/test/unit/browserHashProvider.test.js +21 -21
  127. package/lib/test/unit/browserHashProvider.test.js.map +1 -1
  128. package/lib/test/unit/directoryHandleStore.test.d.ts +2 -0
  129. package/lib/test/unit/directoryHandleStore.test.d.ts.map +1 -0
  130. package/lib/test/unit/directoryHandleStore.test.js +192 -0
  131. package/lib/test/unit/directoryHandleStore.test.js.map +1 -0
  132. package/lib/test/unit/fileApiTypes.test.js +30 -0
  133. package/lib/test/unit/fileApiTypes.test.js.map +1 -1
  134. package/lib/test/unit/fileSystemAccessTreeAccessors.test.d.ts +2 -0
  135. package/lib/test/unit/fileSystemAccessTreeAccessors.test.d.ts.map +1 -0
  136. package/lib/test/unit/fileSystemAccessTreeAccessors.test.js +519 -0
  137. package/lib/test/unit/fileSystemAccessTreeAccessors.test.js.map +1 -0
  138. package/lib/test/unit/localStorageTreeAccessors.test.d.ts +2 -0
  139. package/lib/test/unit/localStorageTreeAccessors.test.d.ts.map +1 -0
  140. package/lib/test/unit/localStorageTreeAccessors.test.js +597 -0
  141. package/lib/test/unit/localStorageTreeAccessors.test.js.map +1 -0
  142. package/lib/test/utils/fileSystemAccessMocks.d.ts +53 -0
  143. package/lib/test/utils/fileSystemAccessMocks.d.ts.map +1 -0
  144. package/lib/test/utils/fileSystemAccessMocks.js +277 -0
  145. package/lib/test/utils/fileSystemAccessMocks.js.map +1 -0
  146. package/package.json +27 -20
  147. package/rush-logs/ts-web-extras.build.cache.log +3 -1
  148. package/rush-logs/ts-web-extras.build.log +35 -25
  149. package/src/index.ts +2 -2
  150. package/src/packlets/crypto-utils/browserCryptoProvider.ts +311 -0
  151. package/src/packlets/{crypto → crypto-utils}/index.ts +1 -0
  152. package/src/packlets/file-api-types/index.ts +24 -3
  153. package/src/packlets/file-tree/directoryHandleStore.ts +136 -0
  154. package/src/packlets/file-tree/fileApiTreeAccessors.ts +90 -0
  155. package/src/packlets/file-tree/fileSystemAccessTreeAccessors.ts +427 -0
  156. package/src/packlets/file-tree/index.ts +3 -0
  157. package/src/packlets/file-tree/localStorageTreeAccessors.ts +377 -0
  158. package/src/test/mocks/idb-keyval.ts +5 -0
  159. package/src/test/unit/browserHashProvider.test.ts +1 -1
  160. package/src/test/unit/directoryHandleStore.test.ts +251 -0
  161. package/src/test/unit/fileApiTypes.test.ts +36 -0
  162. package/src/test/unit/fileSystemAccessTreeAccessors.test.ts +732 -0
  163. package/src/test/unit/localStorageTreeAccessors.test.ts +746 -0
  164. package/src/test/utils/fileSystemAccessMocks.ts +353 -0
  165. package/temp/build/typescript/ts_8nwakTlr.json +1 -0
  166. package/temp/coverage/crypto-utils/browserCryptoProvider.ts.html +1018 -0
  167. package/temp/coverage/{crypto → crypto-utils}/browserHashProvider.ts.html +3 -3
  168. package/temp/coverage/{lcov-report/crypto → crypto-utils}/index.html +21 -6
  169. package/temp/coverage/file-tree/directoryHandleStore.ts.html +493 -0
  170. package/temp/coverage/file-tree/fileApiTreeAccessors.ts.html +276 -6
  171. package/temp/coverage/file-tree/fileSystemAccessTreeAccessors.ts.html +1366 -0
  172. package/temp/coverage/file-tree/index.html +55 -10
  173. package/temp/coverage/file-tree/localStorageTreeAccessors.ts.html +1216 -0
  174. package/temp/coverage/helpers/fileTreeHelpers.ts.html +1 -1
  175. package/temp/coverage/helpers/index.html +1 -1
  176. package/temp/coverage/index.html +15 -15
  177. package/temp/coverage/lcov-report/crypto-utils/browserCryptoProvider.ts.html +1018 -0
  178. package/temp/coverage/lcov-report/{crypto → crypto-utils}/browserHashProvider.ts.html +3 -3
  179. package/temp/coverage/{crypto → lcov-report/crypto-utils}/index.html +21 -6
  180. package/temp/coverage/lcov-report/file-tree/directoryHandleStore.ts.html +493 -0
  181. package/temp/coverage/lcov-report/file-tree/fileApiTreeAccessors.ts.html +276 -6
  182. package/temp/coverage/lcov-report/file-tree/fileSystemAccessTreeAccessors.ts.html +1366 -0
  183. package/temp/coverage/lcov-report/file-tree/index.html +55 -10
  184. package/temp/coverage/lcov-report/file-tree/localStorageTreeAccessors.ts.html +1216 -0
  185. package/temp/coverage/lcov-report/helpers/fileTreeHelpers.ts.html +1 -1
  186. package/temp/coverage/lcov-report/helpers/index.html +1 -1
  187. package/temp/coverage/lcov-report/index.html +15 -15
  188. package/temp/coverage/lcov-report/url-utils/index.html +1 -1
  189. package/temp/coverage/lcov-report/url-utils/urlParams.ts.html +1 -1
  190. package/temp/coverage/lcov.info +2128 -451
  191. package/temp/coverage/url-utils/index.html +1 -1
  192. package/temp/coverage/url-utils/urlParams.ts.html +1 -1
  193. package/temp/test/jest/haste-map-7492f1b44480e0cdd1f220078fb3afd8-c8dd6c3430605adeb2f1cadf4f75e791-8c9336785555d572065b28c111982ba4 +0 -0
  194. package/temp/test/jest/perf-cache-7492f1b44480e0cdd1f220078fb3afd8-da39a3ee5e6b4b0d3255bfef95601890 +1 -1
  195. package/temp/ts-web-extras.api.json +3236 -385
  196. package/temp/ts-web-extras.api.md +91 -1
  197. package/dist/packlets/crypto/browserHashProvider.js.map +0 -1
  198. package/dist/packlets/crypto/index.js.map +0 -1
  199. package/lib/packlets/crypto/browserHashProvider.d.ts.map +0 -1
  200. package/lib/packlets/crypto/browserHashProvider.js.map +0 -1
  201. package/lib/packlets/crypto/index.d.ts.map +0 -1
  202. package/lib/packlets/crypto/index.js.map +0 -1
  203. package/temp/build/typescript/ts_vnCx6LlY.json +0 -1
  204. /package/dist/packlets/{crypto → crypto-utils}/browserHashProvider.js +0 -0
  205. /package/lib/packlets/{crypto → crypto-utils}/browserHashProvider.d.ts +0 -0
  206. /package/lib/packlets/{crypto → crypto-utils}/browserHashProvider.js +0 -0
  207. /package/src/packlets/{crypto → crypto-utils}/browserHashProvider.ts +0 -0
  208. /package/temp/test/jest/jest-transform-cache-7492f1b44480e0cdd1f220078fb3afd8-79ef2876fae7ca75eedb2aa53dc48338/{0e/package_0eb6535f5987849d93ea51ef33a14cf6 → 8d/package_8dcbedef69e4299f0f51fcda8f4f1c8e} +0 -0
@@ -0,0 +1,597 @@
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) 2026 Erik Fortune
4
+ *
5
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ * of this software and associated documentation files (the "Software"), to deal
7
+ * in the Software without restriction, including without limitation the rights
8
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ * copies of the Software, and to permit persons to whom the Software is
10
+ * furnished to do so, subject to the following conditions:
11
+ *
12
+ * The above copyright notice and this permission notice shall be included in all
13
+ * copies or substantial portions of the Software.
14
+ *
15
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ * SOFTWARE.
22
+ */
23
+ Object.defineProperty(exports, "__esModule", { value: true });
24
+ require("@fgv/ts-utils-jest");
25
+ const ts_json_base_1 = require("@fgv/ts-json-base");
26
+ const file_tree_1 = require("../../packlets/file-tree");
27
+ /**
28
+ * Mock Storage implementation for testing
29
+ */
30
+ class MockStorage {
31
+ constructor() {
32
+ this._data = new Map();
33
+ }
34
+ get length() {
35
+ return this._data.size;
36
+ }
37
+ clear() {
38
+ this._data.clear();
39
+ }
40
+ getItem(key) {
41
+ var _a;
42
+ return (_a = this._data.get(key)) !== null && _a !== void 0 ? _a : null;
43
+ }
44
+ key(index) {
45
+ var _a;
46
+ const keys = Array.from(this._data.keys());
47
+ return (_a = keys[index]) !== null && _a !== void 0 ? _a : null;
48
+ }
49
+ removeItem(key) {
50
+ this._data.delete(key);
51
+ }
52
+ setItem(key, value) {
53
+ this._data.set(key, value);
54
+ }
55
+ }
56
+ describe('LocalStorageTreeAccessors', () => {
57
+ let mockStorage;
58
+ beforeEach(() => {
59
+ mockStorage = new MockStorage();
60
+ });
61
+ describe('fromStorage', () => {
62
+ test('creates accessors from empty storage', () => {
63
+ const result = file_tree_1.LocalStorageTreeAccessors.fromStorage({
64
+ pathToKeyMap: {
65
+ '/data/ingredients': 'test:ingredients:v1'
66
+ },
67
+ storage: mockStorage
68
+ });
69
+ expect(result).toSucceedAndSatisfy((accessors) => {
70
+ expect(accessors).toBeInstanceOf(file_tree_1.LocalStorageTreeAccessors);
71
+ expect(accessors.isDirty()).toBe(false);
72
+ });
73
+ });
74
+ test('loads collections from storage', () => {
75
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
76
+ collection1: { items: { item1: {} } },
77
+ collection2: { items: { item2: {} } }
78
+ }));
79
+ const result = file_tree_1.LocalStorageTreeAccessors.fromStorage({
80
+ pathToKeyMap: {
81
+ '/data/ingredients': 'test:ingredients:v1'
82
+ },
83
+ storage: mockStorage
84
+ });
85
+ expect(result).toSucceedAndSatisfy((accessors) => {
86
+ expect(accessors.getFileContents('/data/ingredients/collection1.json')).toSucceed();
87
+ expect(accessors.getFileContents('/data/ingredients/collection2.json')).toSucceed();
88
+ });
89
+ });
90
+ test('loads from multiple storage keys', () => {
91
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ ing1: { items: {} } }));
92
+ mockStorage.setItem('test:fillings:v1', JSON.stringify({ fill1: { items: {} } }));
93
+ const result = file_tree_1.LocalStorageTreeAccessors.fromStorage({
94
+ pathToKeyMap: {
95
+ '/data/ingredients': 'test:ingredients:v1',
96
+ '/data/fillings': 'test:fillings:v1'
97
+ },
98
+ storage: mockStorage
99
+ });
100
+ expect(result).toSucceedAndSatisfy((accessors) => {
101
+ expect(accessors.getFileContents('/data/ingredients/ing1.json')).toSucceed();
102
+ expect(accessors.getFileContents('/data/fillings/fill1.json')).toSucceed();
103
+ });
104
+ });
105
+ test('skips corrupted JSON data', () => {
106
+ mockStorage.setItem('test:ingredients:v1', 'not valid json');
107
+ const result = file_tree_1.LocalStorageTreeAccessors.fromStorage({
108
+ pathToKeyMap: {
109
+ '/data/ingredients': 'test:ingredients:v1'
110
+ },
111
+ storage: mockStorage
112
+ });
113
+ expect(result).toSucceedAndSatisfy((accessors) => {
114
+ expect(accessors).toBeInstanceOf(file_tree_1.LocalStorageTreeAccessors);
115
+ });
116
+ });
117
+ test('skips non-object JSON', () => {
118
+ mockStorage.setItem('test:ingredients:v1', '"string value"');
119
+ const result = file_tree_1.LocalStorageTreeAccessors.fromStorage({
120
+ pathToKeyMap: {
121
+ '/data/ingredients': 'test:ingredients:v1'
122
+ },
123
+ storage: mockStorage
124
+ });
125
+ expect(result).toSucceedAndSatisfy((accessors) => {
126
+ expect(accessors).toBeInstanceOf(file_tree_1.LocalStorageTreeAccessors);
127
+ });
128
+ });
129
+ test('loads string values (new format) with inferred extension', () => {
130
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
131
+ jsonCollection: '{"items":{}}',
132
+ yamlCollection: 'metadata:\n name: test\nitems: {}'
133
+ }));
134
+ const result = file_tree_1.LocalStorageTreeAccessors.fromStorage({
135
+ pathToKeyMap: {
136
+ '/data/ingredients': 'test:ingredients:v1'
137
+ },
138
+ storage: mockStorage
139
+ });
140
+ expect(result).toSucceedAndSatisfy((accessors) => {
141
+ expect(accessors.getFileContents('/data/ingredients/jsonCollection.json')).toSucceedWith('{"items":{}}');
142
+ expect(accessors.getFileContents('/data/ingredients/yamlCollection.yaml')).toSucceedWith('metadata:\n name: test\nitems: {}');
143
+ });
144
+ });
145
+ test('skips non-object non-string collection values', () => {
146
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
147
+ good: { items: {} },
148
+ bad: 42
149
+ }));
150
+ const result = file_tree_1.LocalStorageTreeAccessors.fromStorage({
151
+ pathToKeyMap: {
152
+ '/data/ingredients': 'test:ingredients:v1'
153
+ },
154
+ storage: mockStorage
155
+ });
156
+ expect(result).toSucceedAndSatisfy((accessors) => {
157
+ expect(accessors.getFileContents('/data/ingredients/good.json')).toSucceed();
158
+ });
159
+ });
160
+ test('applies prefix parameter', () => {
161
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
162
+ const result = file_tree_1.LocalStorageTreeAccessors.fromStorage({
163
+ pathToKeyMap: {
164
+ '/data/ingredients': 'test:ingredients:v1'
165
+ },
166
+ storage: mockStorage,
167
+ prefix: '/myapp'
168
+ });
169
+ expect(result).toSucceedAndSatisfy((accessors) => {
170
+ expect(accessors.getFileContents('/myapp/data/ingredients/collection1.json')).toSucceed();
171
+ });
172
+ });
173
+ test('succeeds with empty storage when no data present', () => {
174
+ const result = file_tree_1.LocalStorageTreeAccessors.fromStorage({
175
+ pathToKeyMap: {
176
+ '/data/ingredients': 'test:ingredients:v1'
177
+ },
178
+ storage: mockStorage
179
+ });
180
+ expect(result).toSucceedAndSatisfy((accessors) => {
181
+ expect(accessors).toBeInstanceOf(file_tree_1.LocalStorageTreeAccessors);
182
+ });
183
+ });
184
+ });
185
+ describe('dirty tracking', () => {
186
+ test('starts with no dirty files', () => {
187
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
188
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
189
+ pathToKeyMap: {
190
+ '/data/ingredients': 'test:ingredients:v1'
191
+ },
192
+ storage: mockStorage,
193
+ mutable: true
194
+ }).orThrow();
195
+ expect(accessors.isDirty()).toBe(false);
196
+ expect(accessors.getDirtyPaths()).toEqual([]);
197
+ });
198
+ test('marks files as dirty after modification', () => {
199
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
200
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
201
+ pathToKeyMap: {
202
+ '/data/ingredients': 'test:ingredients:v1'
203
+ },
204
+ storage: mockStorage,
205
+ mutable: true
206
+ }).orThrow();
207
+ const newContent = JSON.stringify({ items: { modified: true } });
208
+ accessors.saveFileContents('/data/ingredients/collection1.json', newContent).orThrow();
209
+ expect(accessors.isDirty()).toBe(true);
210
+ expect(accessors.getDirtyPaths()).toContain('/data/ingredients/collection1.json');
211
+ });
212
+ test('tracks multiple dirty files', () => {
213
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
214
+ collection1: { items: {} },
215
+ collection2: { items: {} }
216
+ }));
217
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
218
+ pathToKeyMap: {
219
+ '/data/ingredients': 'test:ingredients:v1'
220
+ },
221
+ storage: mockStorage,
222
+ mutable: true
223
+ }).orThrow();
224
+ accessors
225
+ .saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ items: { a: 1 } }))
226
+ .orThrow();
227
+ accessors
228
+ .saveFileContents('/data/ingredients/collection2.json', JSON.stringify({ items: { b: 2 } }))
229
+ .orThrow();
230
+ expect(accessors.isDirty()).toBe(true);
231
+ expect(accessors.getDirtyPaths()).toHaveLength(2);
232
+ });
233
+ });
234
+ describe('syncToDisk', () => {
235
+ test('syncs modified files to storage', async () => {
236
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: { original: true } } }));
237
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
238
+ pathToKeyMap: {
239
+ '/data/ingredients': 'test:ingredients:v1'
240
+ },
241
+ storage: mockStorage,
242
+ mutable: true
243
+ }).orThrow();
244
+ const newContent = JSON.stringify({ items: { modified: true } });
245
+ accessors.saveFileContents('/data/ingredients/collection1.json', newContent).orThrow();
246
+ const syncResult = await accessors.syncToDisk();
247
+ expect(syncResult).toSucceed();
248
+ const stored = mockStorage.getItem('test:ingredients:v1');
249
+ expect(stored).toBeTruthy();
250
+ const parsed = JSON.parse(stored);
251
+ // New format: values are raw content strings
252
+ expect(parsed.collection1).toBe(newContent);
253
+ });
254
+ test('clears dirty state after successful sync', async () => {
255
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
256
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
257
+ pathToKeyMap: {
258
+ '/data/ingredients': 'test:ingredients:v1'
259
+ },
260
+ storage: mockStorage,
261
+ mutable: true
262
+ }).orThrow();
263
+ accessors
264
+ .saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ items: { a: 1 } }))
265
+ .orThrow();
266
+ expect(accessors.isDirty()).toBe(true);
267
+ await accessors.syncToDisk();
268
+ expect(accessors.isDirty()).toBe(false);
269
+ expect(accessors.getDirtyPaths()).toEqual([]);
270
+ });
271
+ test('syncs multiple files to same storage key', async () => {
272
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
273
+ collection1: { items: {} },
274
+ collection2: { items: {} }
275
+ }));
276
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
277
+ pathToKeyMap: {
278
+ '/data/ingredients': 'test:ingredients:v1'
279
+ },
280
+ storage: mockStorage,
281
+ mutable: true
282
+ }).orThrow();
283
+ const content1 = JSON.stringify({ items: { a: 1 } });
284
+ const content2 = JSON.stringify({ items: { b: 2 } });
285
+ accessors.saveFileContents('/data/ingredients/collection1.json', content1).orThrow();
286
+ accessors.saveFileContents('/data/ingredients/collection2.json', content2).orThrow();
287
+ await accessors.syncToDisk();
288
+ const stored = mockStorage.getItem('test:ingredients:v1');
289
+ const parsed = JSON.parse(stored);
290
+ // New format: values are raw content strings
291
+ expect(parsed.collection1).toBe(content1);
292
+ expect(parsed.collection2).toBe(content2);
293
+ });
294
+ test('syncs files to different storage keys', async () => {
295
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ ing1: { items: {} } }));
296
+ mockStorage.setItem('test:fillings:v1', JSON.stringify({ fill1: { items: {} } }));
297
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
298
+ pathToKeyMap: {
299
+ '/data/ingredients': 'test:ingredients:v1',
300
+ '/data/fillings': 'test:fillings:v1'
301
+ },
302
+ storage: mockStorage,
303
+ mutable: true
304
+ }).orThrow();
305
+ accessors
306
+ .saveFileContents('/data/ingredients/ing1.json', JSON.stringify({ items: { a: 1 } }))
307
+ .orThrow();
308
+ accessors.saveFileContents('/data/fillings/fill1.json', JSON.stringify({ items: { b: 2 } })).orThrow();
309
+ await accessors.syncToDisk();
310
+ const ingContent = JSON.stringify({ items: { a: 1 } });
311
+ const fillContent = JSON.stringify({ items: { b: 2 } });
312
+ const ingStored = JSON.parse(mockStorage.getItem('test:ingredients:v1'));
313
+ const fillStored = JSON.parse(mockStorage.getItem('test:fillings:v1'));
314
+ // New format: values are raw content strings
315
+ expect(ingStored.ing1).toBe(ingContent);
316
+ expect(fillStored.fill1).toBe(fillContent);
317
+ });
318
+ test('succeeds with no dirty files', async () => {
319
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
320
+ pathToKeyMap: {
321
+ '/data/ingredients': 'test:ingredients:v1'
322
+ },
323
+ storage: mockStorage
324
+ }).orThrow();
325
+ const result = await accessors.syncToDisk();
326
+ expect(result).toSucceed();
327
+ });
328
+ test('preserves existing collections when syncing', async () => {
329
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({
330
+ existing: { items: { keep: true } },
331
+ toModify: { items: { original: true } }
332
+ }));
333
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
334
+ pathToKeyMap: {
335
+ '/data/ingredients': 'test:ingredients:v1'
336
+ },
337
+ storage: mockStorage,
338
+ mutable: true
339
+ }).orThrow();
340
+ const modifiedContent = JSON.stringify({ items: { modified: true } });
341
+ accessors.saveFileContents('/data/ingredients/toModify.json', modifiedContent).orThrow();
342
+ await accessors.syncToDisk();
343
+ const stored = JSON.parse(mockStorage.getItem('test:ingredients:v1'));
344
+ // existing was loaded from legacy format and not modified, so it stays as legacy object
345
+ // toModify was saved with new content, so it's now a raw string
346
+ expect(stored.toModify).toBe(modifiedContent);
347
+ });
348
+ });
349
+ describe('autoSync mode', () => {
350
+ test('automatically syncs on save when enabled', () => {
351
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
352
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
353
+ pathToKeyMap: {
354
+ '/data/ingredients': 'test:ingredients:v1'
355
+ },
356
+ storage: mockStorage,
357
+ mutable: true,
358
+ autoSync: true
359
+ }).orThrow();
360
+ accessors
361
+ .saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ items: { auto: true } }))
362
+ .orThrow();
363
+ expect(accessors.isDirty()).toBe(false);
364
+ const autoContent = JSON.stringify({ items: { auto: true } });
365
+ const stored = JSON.parse(mockStorage.getItem('test:ingredients:v1'));
366
+ // New format: values are raw content strings
367
+ expect(stored.collection1).toBe(autoContent);
368
+ });
369
+ test('does not auto-sync when disabled', () => {
370
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
371
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
372
+ pathToKeyMap: {
373
+ '/data/ingredients': 'test:ingredients:v1'
374
+ },
375
+ storage: mockStorage,
376
+ mutable: true,
377
+ autoSync: false
378
+ }).orThrow();
379
+ accessors
380
+ .saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ items: { manual: true } }))
381
+ .orThrow();
382
+ expect(accessors.isDirty()).toBe(true);
383
+ // Storage should still have the original legacy format (not yet synced)
384
+ const stored = JSON.parse(mockStorage.getItem('test:ingredients:v1'));
385
+ expect(stored.collection1).toEqual({ items: {} });
386
+ });
387
+ });
388
+ describe('fileIsMutable', () => {
389
+ test('returns persistent detail when mutable', () => {
390
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
391
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
392
+ pathToKeyMap: {
393
+ '/data/ingredients': 'test:ingredients:v1'
394
+ },
395
+ storage: mockStorage,
396
+ mutable: true
397
+ }).orThrow();
398
+ expect(accessors.fileIsMutable('/data/ingredients/collection1.json')).toSucceedWithDetail(true, 'persistent');
399
+ });
400
+ test('returns not-mutable when not mutable', () => {
401
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
402
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
403
+ pathToKeyMap: {
404
+ '/data/ingredients': 'test:ingredients:v1'
405
+ },
406
+ storage: mockStorage,
407
+ mutable: false
408
+ }).orThrow();
409
+ const result = accessors.fileIsMutable('/data/ingredients/collection1.json');
410
+ expect(result.isFailure()).toBe(true);
411
+ if (result.isFailure()) {
412
+ expect(result.detail).toBe('not-mutable');
413
+ }
414
+ });
415
+ });
416
+ describe('integration with FileApiTreeAccessors', () => {
417
+ test('createFromLocalStorage creates FileTree with persistent accessors', () => {
418
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
419
+ const result = file_tree_1.FileApiTreeAccessors.createFromLocalStorage({
420
+ pathToKeyMap: {
421
+ '/data/ingredients': 'test:ingredients:v1'
422
+ },
423
+ storage: mockStorage,
424
+ mutable: true
425
+ });
426
+ expect(result).toSucceed();
427
+ const tree = result.orThrow();
428
+ expect(tree).toBeInstanceOf(ts_json_base_1.FileTree.FileTree);
429
+ expect(ts_json_base_1.FileTree.isPersistentAccessors(tree.hal)).toBe(true);
430
+ const file = tree.getFile('/data/ingredients/collection1.json').orThrow();
431
+ expect(file.getIsMutable()).toSucceedWithDetail(true, 'persistent');
432
+ });
433
+ test('createFromLocalStorage with multiple paths', () => {
434
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ ing1: { items: {} } }));
435
+ mockStorage.setItem('test:fillings:v1', JSON.stringify({ fill1: { items: {} } }));
436
+ const result = file_tree_1.FileApiTreeAccessors.createFromLocalStorage({
437
+ pathToKeyMap: {
438
+ '/data/ingredients': 'test:ingredients:v1',
439
+ '/data/fillings': 'test:fillings:v1'
440
+ },
441
+ storage: mockStorage,
442
+ mutable: true
443
+ });
444
+ expect(result).toSucceedAndSatisfy((tree) => {
445
+ expect(tree.getFile('/data/ingredients/ing1.json')).toSucceed();
446
+ expect(tree.getFile('/data/fillings/fill1.json')).toSucceed();
447
+ });
448
+ });
449
+ test('createFromLocalStorage with empty storage', () => {
450
+ const result = file_tree_1.FileApiTreeAccessors.createFromLocalStorage({
451
+ pathToKeyMap: {
452
+ '/data/ingredients': 'test:ingredients:v1'
453
+ },
454
+ storage: mockStorage
455
+ });
456
+ expect(result).toSucceedAndSatisfy((tree) => {
457
+ expect(tree).toBeInstanceOf(ts_json_base_1.FileTree.FileTree);
458
+ });
459
+ });
460
+ test('createFromLocalStorage fails when localStorage is not available', () => {
461
+ // Remove the global window object to ensure no fallback
462
+ const originalWindow = global.window;
463
+ delete global.window;
464
+ const result = file_tree_1.FileApiTreeAccessors.createFromLocalStorage({
465
+ pathToKeyMap: {
466
+ '/data/ingredients': 'test:ingredients:v1'
467
+ },
468
+ storage: undefined
469
+ });
470
+ // Restore window
471
+ global.window = originalWindow;
472
+ expect(result).toFailWith(/localStorage is not available/i);
473
+ });
474
+ });
475
+ describe('path matching and error handling', () => {
476
+ test('handles files outside configured paths', async () => {
477
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
478
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
479
+ pathToKeyMap: {
480
+ '/data/ingredients': 'test:ingredients:v1'
481
+ },
482
+ storage: mockStorage,
483
+ mutable: true
484
+ }).orThrow();
485
+ // Try to save a file outside the configured path
486
+ const saveResult = accessors.saveFileContents('/other/path/file.json', JSON.stringify({ test: 1 }));
487
+ expect(saveResult).toSucceed();
488
+ // But syncing should fail because no storage key is configured
489
+ const syncResult = await accessors.syncToDisk();
490
+ expect(syncResult).toFailWith(/No storage key configured for path/i);
491
+ });
492
+ test('handles files inside configured paths', async () => {
493
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
494
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
495
+ pathToKeyMap: {
496
+ '/data/ingredients': 'test:ingredients:v1'
497
+ },
498
+ storage: mockStorage,
499
+ mutable: true
500
+ }).orThrow();
501
+ // Save a file inside the configured path
502
+ accessors.saveFileContents('/data/ingredients/newfile.json', JSON.stringify({ test: 1 })).orThrow();
503
+ // Syncing should succeed
504
+ const syncResult = await accessors.syncToDisk();
505
+ expect(syncResult).toSucceed();
506
+ });
507
+ test('handles failed content retrieval during sync', async () => {
508
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
509
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
510
+ pathToKeyMap: {
511
+ '/data/ingredients': 'test:ingredients:v1'
512
+ },
513
+ storage: mockStorage,
514
+ mutable: true
515
+ }).orThrow();
516
+ // Modify a file
517
+ accessors.saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ test: 1 })).orThrow();
518
+ // Override getFileContents to fail
519
+ const originalGetFileContents = accessors.getFileContents.bind(accessors);
520
+ accessors.getFileContents = jest.fn((path) => {
521
+ if (path === '/data/ingredients/collection1.json') {
522
+ return { isSuccess: () => false, isFailure: () => true, message: 'File not found' };
523
+ }
524
+ return originalGetFileContents(path);
525
+ });
526
+ const syncResult = await accessors.syncToDisk();
527
+ expect(syncResult).toFailWith(/Failed to get file contents.*File not found/i);
528
+ });
529
+ test('handles corrupted JSON in localStorage during sync', async () => {
530
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
531
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
532
+ pathToKeyMap: {
533
+ '/data/ingredients': 'test:ingredients:v1'
534
+ },
535
+ storage: mockStorage,
536
+ mutable: true
537
+ }).orThrow();
538
+ // Modify a file
539
+ accessors.saveFileContents('/data/ingredients/collection1.json', JSON.stringify({ test: 1 })).orThrow();
540
+ // Corrupt the existing storage data
541
+ mockStorage.setItem('test:ingredients:v1', 'not valid json');
542
+ // Sync should still succeed by starting fresh
543
+ const syncResult = await accessors.syncToDisk();
544
+ expect(syncResult).toSucceed();
545
+ // Verify the data was written correctly despite corrupted previous data
546
+ const stored = mockStorage.getItem('test:ingredients:v1');
547
+ const parsed = JSON.parse(stored);
548
+ // New format: values are raw content strings
549
+ expect(parsed.collection1).toBe(JSON.stringify({ test: 1 }));
550
+ });
551
+ test('syncs non-JSON content (YAML) without error', async () => {
552
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
553
+ pathToKeyMap: {
554
+ '/data/ingredients': 'test:ingredients:v1'
555
+ },
556
+ storage: mockStorage,
557
+ mutable: true
558
+ }).orThrow();
559
+ // Create and save a YAML file
560
+ const yamlContent = 'metadata:\n name: test\nitems: {}';
561
+ accessors.saveFileContents('/data/ingredients/my-collection.yaml', yamlContent).orThrow();
562
+ const syncResult = await accessors.syncToDisk();
563
+ expect(syncResult).toSucceed();
564
+ const stored = JSON.parse(mockStorage.getItem('test:ingredients:v1'));
565
+ expect(stored['my-collection']).toBe(yamlContent);
566
+ });
567
+ test('handles multiple sync failures with aggregated errors', async () => {
568
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
569
+ pathToKeyMap: {
570
+ '/data/ingredients': 'test:ingredients:v1'
571
+ },
572
+ storage: mockStorage,
573
+ mutable: true
574
+ }).orThrow();
575
+ // Add files outside configured paths
576
+ accessors.saveFileContents('/other1/file1.json', JSON.stringify({ test: 1 })).orThrow();
577
+ accessors.saveFileContents('/other2/file2.json', JSON.stringify({ test: 2 })).orThrow();
578
+ const syncResult = await accessors.syncToDisk();
579
+ expect(syncResult).toFailWith(/Failed to sync 2 file\(s\)/i);
580
+ });
581
+ test('handles auto-sync failure', () => {
582
+ mockStorage.setItem('test:ingredients:v1', JSON.stringify({ collection1: { items: {} } }));
583
+ const accessors = file_tree_1.LocalStorageTreeAccessors.fromStorage({
584
+ pathToKeyMap: {
585
+ '/data/ingredients': 'test:ingredients:v1'
586
+ },
587
+ storage: mockStorage,
588
+ mutable: true,
589
+ autoSync: true
590
+ }).orThrow();
591
+ // Try to save a file outside configured path with autoSync enabled
592
+ const saveResult = accessors.saveFileContents('/other/path/file.json', JSON.stringify({ test: 1 }));
593
+ expect(saveResult).toFailWith(/No storage key configured for path/i);
594
+ });
595
+ });
596
+ });
597
+ //# sourceMappingURL=localStorageTreeAccessors.test.js.map