@fgv/ts-http-storage 5.1.0-2 → 5.1.0-21

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 (116) hide show
  1. package/dist/tsdoc-metadata.json +1 -1
  2. package/package.json +21 -21
  3. package/.rush/temp/2a9b81b5aa00c0f868f72c1458e40e12863c5047.tar.log +0 -61
  4. package/.rush/temp/2a9b81b5aa00c0f868f72c1458e40e12863c5047.untar.log +0 -10
  5. package/.rush/temp/5f9717376d57cea06ce184ce1ad4be928dc96116.tar.log +0 -61
  6. package/.rush/temp/6dc57b26d5a4e0d9901b7ec5f070db373bfdde8d.tar.log +0 -63
  7. package/.rush/temp/chunked-rush-logs/ts-http-storage.build.chunks.jsonl +0 -10
  8. package/.rush/temp/chunked-rush-logs/ts-http-storage.test.chunks.jsonl +0 -26
  9. package/.rush/temp/fbfcc9487d290993ba47f1d36e9383196e7b12ac.tar.log +0 -61
  10. package/.rush/temp/operation/build/all.log +0 -10
  11. package/.rush/temp/operation/build/log-chunks.jsonl +0 -10
  12. package/.rush/temp/operation/build/state.json +0 -3
  13. package/.rush/temp/operation/test/all.log +0 -26
  14. package/.rush/temp/operation/test/log-chunks.jsonl +0 -26
  15. package/.rush/temp/operation/test/state.json +0 -3
  16. package/.rush/temp/shrinkwrap-deps.json +0 -647
  17. package/config/api-extractor.json +0 -36
  18. package/config/rig.json +0 -10
  19. package/config/typedoc.json +0 -7
  20. package/docs/README.md +0 -298
  21. package/docs/classes/FsStorageProvider.createDirectory.md +0 -20
  22. package/docs/classes/FsStorageProvider.getChildren.md +0 -20
  23. package/docs/classes/FsStorageProvider.getFile.md +0 -20
  24. package/docs/classes/FsStorageProvider.getItem.md +0 -20
  25. package/docs/classes/FsStorageProvider.md +0 -134
  26. package/docs/classes/FsStorageProvider.saveFile.md +0 -22
  27. package/docs/classes/FsStorageProvider.sync.md +0 -13
  28. package/docs/classes/FsStorageProviderFactory.forNamespace.md +0 -20
  29. package/docs/classes/FsStorageProviderFactory.md +0 -69
  30. package/docs/classes/HttpStorageService.createDirectory.md +0 -20
  31. package/docs/classes/HttpStorageService.getChildren.md +0 -20
  32. package/docs/classes/HttpStorageService.getFile.md +0 -20
  33. package/docs/classes/HttpStorageService.getItem.md +0 -20
  34. package/docs/classes/HttpStorageService.md +0 -132
  35. package/docs/classes/HttpStorageService.saveFile.md +0 -20
  36. package/docs/classes/HttpStorageService.sync.md +0 -20
  37. package/docs/functions/createStorageRoutes.md +0 -11
  38. package/docs/functions/normalizeRequestPath.md +0 -11
  39. package/docs/functions/sanitizeNamespace.md +0 -11
  40. package/docs/interfaces/ICreateStorageRoutesOptions.logger.md +0 -9
  41. package/docs/interfaces/ICreateStorageRoutesOptions.md +0 -61
  42. package/docs/interfaces/ICreateStorageRoutesOptions.providers.md +0 -9
  43. package/docs/interfaces/IFsStorageProviderFactoryOptions.md +0 -44
  44. package/docs/interfaces/IFsStorageProviderFactoryOptions.rootPath.md +0 -9
  45. package/docs/interfaces/IHttpStorageProvider.createDirectory.md +0 -20
  46. package/docs/interfaces/IHttpStorageProvider.getChildren.md +0 -20
  47. package/docs/interfaces/IHttpStorageProvider.getFile.md +0 -20
  48. package/docs/interfaces/IHttpStorageProvider.getItem.md +0 -20
  49. package/docs/interfaces/IHttpStorageProvider.md +0 -102
  50. package/docs/interfaces/IHttpStorageProvider.saveFile.md +0 -22
  51. package/docs/interfaces/IHttpStorageProvider.sync.md +0 -13
  52. package/docs/interfaces/IHttpStorageProviderFactory.forNamespace.md +0 -20
  53. package/docs/interfaces/IHttpStorageProviderFactory.md +0 -36
  54. package/docs/interfaces/IStorageFileResponse.contentType.md +0 -9
  55. package/docs/interfaces/IStorageFileResponse.contents.md +0 -9
  56. package/docs/interfaces/IStorageFileResponse.md +0 -78
  57. package/docs/interfaces/IStorageFileResponse.path.md +0 -9
  58. package/docs/interfaces/IStoragePathRequest.md +0 -61
  59. package/docs/interfaces/IStoragePathRequest.namespace.md +0 -9
  60. package/docs/interfaces/IStoragePathRequest.path.md +0 -9
  61. package/docs/interfaces/IStorageSyncRequest.md +0 -44
  62. package/docs/interfaces/IStorageSyncRequest.namespace.md +0 -9
  63. package/docs/interfaces/IStorageSyncResponse.md +0 -44
  64. package/docs/interfaces/IStorageSyncResponse.synced.md +0 -9
  65. package/docs/interfaces/IStorageTreeChildrenResponse.children.md +0 -9
  66. package/docs/interfaces/IStorageTreeChildrenResponse.md +0 -61
  67. package/docs/interfaces/IStorageTreeChildrenResponse.path.md +0 -9
  68. package/docs/interfaces/IStorageTreeItem.md +0 -78
  69. package/docs/interfaces/IStorageTreeItem.name.md +0 -9
  70. package/docs/interfaces/IStorageTreeItem.path.md +0 -9
  71. package/docs/interfaces/IStorageTreeItem.type.md +0 -9
  72. package/docs/interfaces/IStorageWriteFileRequest.contentType.md +0 -9
  73. package/docs/interfaces/IStorageWriteFileRequest.contents.md +0 -9
  74. package/docs/interfaces/IStorageWriteFileRequest.md +0 -97
  75. package/docs/type-aliases/StorageItemType.md +0 -11
  76. package/docs/type-aliases/StorageNamespace.md +0 -11
  77. package/docs/variables/storageFileResponse.md +0 -9
  78. package/docs/variables/storagePathRequest.md +0 -9
  79. package/docs/variables/storageSyncRequest.md +0 -9
  80. package/docs/variables/storageTreeChildrenResponse.md +0 -9
  81. package/docs/variables/storageTreeItem.md +0 -9
  82. package/docs/variables/storageWriteFileRequest.md +0 -9
  83. package/etc/ts-http-storage.api.md +0 -184
  84. package/lib/test/unit/storage/fsProvider.test.d.ts +0 -2
  85. package/lib/test/unit/storage/fsProvider.test.d.ts.map +0 -1
  86. package/lib/test/unit/storage/fsProvider.test.js +0 -106
  87. package/lib/test/unit/storage/fsProvider.test.js.map +0 -1
  88. package/lib/test/unit/storage/routes.test.d.ts +0 -2
  89. package/lib/test/unit/storage/routes.test.d.ts.map +0 -1
  90. package/lib/test/unit/storage/routes.test.js +0 -124
  91. package/lib/test/unit/storage/routes.test.js.map +0 -1
  92. package/lib/test/unit/storage/service.test.d.ts +0 -2
  93. package/lib/test/unit/storage/service.test.d.ts.map +0 -1
  94. package/lib/test/unit/storage/service.test.js +0 -67
  95. package/lib/test/unit/storage/service.test.js.map +0 -1
  96. package/rush-logs/ts-http-storage.build.cache.log +0 -3
  97. package/rush-logs/ts-http-storage.build.log +0 -10
  98. package/rush-logs/ts-http-storage.test.cache.log +0 -1
  99. package/rush-logs/ts-http-storage.test.log +0 -26
  100. package/src/index.ts +0 -28
  101. package/src/packlets/storage/converters.ts +0 -100
  102. package/src/packlets/storage/fsProvider.ts +0 -263
  103. package/src/packlets/storage/index.ts +0 -33
  104. package/src/packlets/storage/model.ts +0 -113
  105. package/src/packlets/storage/provider.ts +0 -33
  106. package/src/packlets/storage/routes.ts +0 -215
  107. package/src/packlets/storage/service.ts +0 -114
  108. package/src/test/unit/storage/fsProvider.test.ts +0 -129
  109. package/src/test/unit/storage/routes.test.ts +0 -165
  110. package/src/test/unit/storage/service.test.ts +0 -95
  111. package/temp/build/typescript/ts_l9Fw4VUO.json +0 -1
  112. package/temp/test/jest/haste-map-8c99f7c94db8a3bcd2cd59242978c7c2-2b6695b6f6f938dfd4bbd5c487f7012f-ba9beffc5d763ea8f7407ec52e16ae8f +0 -0
  113. package/temp/test/jest/perf-cache-8c99f7c94db8a3bcd2cd59242978c7c2-da39a3ee5e6b4b0d3255bfef95601890 +0 -1
  114. package/temp/ts-http-storage.api.json +0 -3103
  115. package/temp/ts-http-storage.api.md +0 -184
  116. package/tsconfig.json +0 -7
@@ -1,36 +0,0 @@
1
- [Home](../README.md) > IHttpStorageProviderFactory
2
-
3
- # Interface: IHttpStorageProviderFactory
4
-
5
- Factory for creating namespace-scoped storage providers.
6
-
7
- ## Methods
8
-
9
- <table><thead><tr><th>
10
-
11
- Method
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Description
20
-
21
- </th></tr></thead>
22
- <tbody>
23
- <tr><td>
24
-
25
- [forNamespace(namespace)](./IHttpStorageProviderFactory.forNamespace.md)
26
-
27
- </td><td>
28
-
29
-
30
-
31
- </td><td>
32
-
33
-
34
-
35
- </td></tr>
36
- </tbody></table>
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageFileResponse](./IStorageFileResponse.md) > contentType
2
-
3
- ## IStorageFileResponse.contentType property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly contentType: string;
9
- ```
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageFileResponse](./IStorageFileResponse.md) > contents
2
-
3
- ## IStorageFileResponse.contents property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly contents: string;
9
- ```
@@ -1,78 +0,0 @@
1
- [Home](../README.md) > IStorageFileResponse
2
-
3
- # Interface: IStorageFileResponse
4
-
5
- Response for reading a file.
6
-
7
- ## Properties
8
-
9
- <table><thead><tr><th>
10
-
11
- Property
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Type
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody>
27
- <tr><td>
28
-
29
- [path](./IStorageFileResponse.path.md)
30
-
31
- </td><td>
32
-
33
- `readonly`
34
-
35
- </td><td>
36
-
37
- string
38
-
39
- </td><td>
40
-
41
-
42
-
43
- </td></tr>
44
- <tr><td>
45
-
46
- [contents](./IStorageFileResponse.contents.md)
47
-
48
- </td><td>
49
-
50
- `readonly`
51
-
52
- </td><td>
53
-
54
- string
55
-
56
- </td><td>
57
-
58
-
59
-
60
- </td></tr>
61
- <tr><td>
62
-
63
- [contentType](./IStorageFileResponse.contentType.md)
64
-
65
- </td><td>
66
-
67
- `readonly`
68
-
69
- </td><td>
70
-
71
- string
72
-
73
- </td><td>
74
-
75
-
76
-
77
- </td></tr>
78
- </tbody></table>
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageFileResponse](./IStorageFileResponse.md) > path
2
-
3
- ## IStorageFileResponse.path property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly path: string;
9
- ```
@@ -1,61 +0,0 @@
1
- [Home](../README.md) > IStoragePathRequest
2
-
3
- # Interface: IStoragePathRequest
4
-
5
- Request for path-based operations.
6
-
7
- ## Properties
8
-
9
- <table><thead><tr><th>
10
-
11
- Property
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Type
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody>
27
- <tr><td>
28
-
29
- [path](./IStoragePathRequest.path.md)
30
-
31
- </td><td>
32
-
33
- `readonly`
34
-
35
- </td><td>
36
-
37
- string
38
-
39
- </td><td>
40
-
41
-
42
-
43
- </td></tr>
44
- <tr><td>
45
-
46
- [namespace](./IStoragePathRequest.namespace.md)
47
-
48
- </td><td>
49
-
50
- `readonly`
51
-
52
- </td><td>
53
-
54
- string
55
-
56
- </td><td>
57
-
58
-
59
-
60
- </td></tr>
61
- </tbody></table>
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStoragePathRequest](./IStoragePathRequest.md) > namespace
2
-
3
- ## IStoragePathRequest.namespace property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly namespace: string;
9
- ```
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStoragePathRequest](./IStoragePathRequest.md) > path
2
-
3
- ## IStoragePathRequest.path property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly path: string;
9
- ```
@@ -1,44 +0,0 @@
1
- [Home](../README.md) > IStorageSyncRequest
2
-
3
- # Interface: IStorageSyncRequest
4
-
5
- Request for sync operation.
6
-
7
- ## Properties
8
-
9
- <table><thead><tr><th>
10
-
11
- Property
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Type
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody>
27
- <tr><td>
28
-
29
- [namespace](./IStorageSyncRequest.namespace.md)
30
-
31
- </td><td>
32
-
33
- `readonly`
34
-
35
- </td><td>
36
-
37
- string
38
-
39
- </td><td>
40
-
41
-
42
-
43
- </td></tr>
44
- </tbody></table>
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageSyncRequest](./IStorageSyncRequest.md) > namespace
2
-
3
- ## IStorageSyncRequest.namespace property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly namespace: string;
9
- ```
@@ -1,44 +0,0 @@
1
- [Home](../README.md) > IStorageSyncResponse
2
-
3
- # Interface: IStorageSyncResponse
4
-
5
- Sync response metadata.
6
-
7
- ## Properties
8
-
9
- <table><thead><tr><th>
10
-
11
- Property
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Type
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody>
27
- <tr><td>
28
-
29
- [synced](./IStorageSyncResponse.synced.md)
30
-
31
- </td><td>
32
-
33
- `readonly`
34
-
35
- </td><td>
36
-
37
- number
38
-
39
- </td><td>
40
-
41
-
42
-
43
- </td></tr>
44
- </tbody></table>
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageSyncResponse](./IStorageSyncResponse.md) > synced
2
-
3
- ## IStorageSyncResponse.synced property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly synced: number;
9
- ```
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageTreeChildrenResponse](./IStorageTreeChildrenResponse.md) > children
2
-
3
- ## IStorageTreeChildrenResponse.children property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly children: readonly IStorageTreeItem[];
9
- ```
@@ -1,61 +0,0 @@
1
- [Home](../README.md) > IStorageTreeChildrenResponse
2
-
3
- # Interface: IStorageTreeChildrenResponse
4
-
5
- Response for listing children.
6
-
7
- ## Properties
8
-
9
- <table><thead><tr><th>
10
-
11
- Property
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Type
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody>
27
- <tr><td>
28
-
29
- [path](./IStorageTreeChildrenResponse.path.md)
30
-
31
- </td><td>
32
-
33
- `readonly`
34
-
35
- </td><td>
36
-
37
- string
38
-
39
- </td><td>
40
-
41
-
42
-
43
- </td></tr>
44
- <tr><td>
45
-
46
- [children](./IStorageTreeChildrenResponse.children.md)
47
-
48
- </td><td>
49
-
50
- `readonly`
51
-
52
- </td><td>
53
-
54
- readonly [IStorageTreeItem](IStorageTreeItem.md)[]
55
-
56
- </td><td>
57
-
58
-
59
-
60
- </td></tr>
61
- </tbody></table>
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageTreeChildrenResponse](./IStorageTreeChildrenResponse.md) > path
2
-
3
- ## IStorageTreeChildrenResponse.path property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly path: string;
9
- ```
@@ -1,78 +0,0 @@
1
- [Home](../README.md) > IStorageTreeItem
2
-
3
- # Interface: IStorageTreeItem
4
-
5
- Storage tree item metadata.
6
-
7
- ## Properties
8
-
9
- <table><thead><tr><th>
10
-
11
- Property
12
-
13
- </th><th>
14
-
15
- Modifiers
16
-
17
- </th><th>
18
-
19
- Type
20
-
21
- </th><th>
22
-
23
- Description
24
-
25
- </th></tr></thead>
26
- <tbody>
27
- <tr><td>
28
-
29
- [path](./IStorageTreeItem.path.md)
30
-
31
- </td><td>
32
-
33
- `readonly`
34
-
35
- </td><td>
36
-
37
- string
38
-
39
- </td><td>
40
-
41
-
42
-
43
- </td></tr>
44
- <tr><td>
45
-
46
- [name](./IStorageTreeItem.name.md)
47
-
48
- </td><td>
49
-
50
- `readonly`
51
-
52
- </td><td>
53
-
54
- string
55
-
56
- </td><td>
57
-
58
-
59
-
60
- </td></tr>
61
- <tr><td>
62
-
63
- [type](./IStorageTreeItem.type.md)
64
-
65
- </td><td>
66
-
67
- `readonly`
68
-
69
- </td><td>
70
-
71
- [StorageItemType](../type-aliases/StorageItemType.md)
72
-
73
- </td><td>
74
-
75
-
76
-
77
- </td></tr>
78
- </tbody></table>
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageTreeItem](./IStorageTreeItem.md) > name
2
-
3
- ## IStorageTreeItem.name property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly name: string;
9
- ```
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageTreeItem](./IStorageTreeItem.md) > path
2
-
3
- ## IStorageTreeItem.path property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly path: string;
9
- ```
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageTreeItem](./IStorageTreeItem.md) > type
2
-
3
- ## IStorageTreeItem.type property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly type: StorageItemType;
9
- ```
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageWriteFileRequest](./IStorageWriteFileRequest.md) > contentType
2
-
3
- ## IStorageWriteFileRequest.contentType property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly contentType: string;
9
- ```
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > [IStorageWriteFileRequest](./IStorageWriteFileRequest.md) > contents
2
-
3
- ## IStorageWriteFileRequest.contents property
4
-
5
- **Signature:**
6
-
7
- ```typescript
8
- readonly contents: string;
9
- ```
@@ -1,97 +0,0 @@
1
- [Home](../README.md) > IStorageWriteFileRequest
2
-
3
- # Interface: IStorageWriteFileRequest
4
-
5
- Request for writing file contents.
6
-
7
- **Extends:** [`IStoragePathRequest`](IStoragePathRequest.md)
8
-
9
- ## Properties
10
-
11
- <table><thead><tr><th>
12
-
13
- Property
14
-
15
- </th><th>
16
-
17
- Modifiers
18
-
19
- </th><th>
20
-
21
- Type
22
-
23
- </th><th>
24
-
25
- Description
26
-
27
- </th></tr></thead>
28
- <tbody>
29
- <tr><td>
30
-
31
- [contents](./IStorageWriteFileRequest.contents.md)
32
-
33
- </td><td>
34
-
35
- `readonly`
36
-
37
- </td><td>
38
-
39
- string
40
-
41
- </td><td>
42
-
43
-
44
-
45
- </td></tr>
46
- <tr><td>
47
-
48
- [contentType](./IStorageWriteFileRequest.contentType.md)
49
-
50
- </td><td>
51
-
52
- `readonly`
53
-
54
- </td><td>
55
-
56
- string
57
-
58
- </td><td>
59
-
60
-
61
-
62
- </td></tr>
63
- <tr><td>
64
-
65
- [path](./IStoragePathRequest.path.md)
66
-
67
- </td><td>
68
-
69
- `readonly`
70
-
71
- </td><td>
72
-
73
- string
74
-
75
- </td><td>
76
-
77
-
78
-
79
- </td></tr>
80
- <tr><td>
81
-
82
- [namespace](./IStoragePathRequest.namespace.md)
83
-
84
- </td><td>
85
-
86
- `readonly`
87
-
88
- </td><td>
89
-
90
- string
91
-
92
- </td><td>
93
-
94
-
95
-
96
- </td></tr>
97
- </tbody></table>
@@ -1,11 +0,0 @@
1
- [Home](../README.md) > StorageItemType
2
-
3
- # Type Alias: StorageItemType
4
-
5
- Storage item type.
6
-
7
- ## Type
8
-
9
- ```typescript
10
- type StorageItemType = "file" | "directory"
11
- ```
@@ -1,11 +0,0 @@
1
- [Home](../README.md) > StorageNamespace
2
-
3
- # Type Alias: StorageNamespace
4
-
5
- Namespace identifier for scoped storage.
6
-
7
- ## Type
8
-
9
- ```typescript
10
- type StorageNamespace = string
11
- ```
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > storageFileResponse
2
-
3
- # Variable: storageFileResponse
4
-
5
- Converter for file responses.
6
-
7
- ## Type
8
-
9
- `Converter<IStorageFileResponse>`
@@ -1,9 +0,0 @@
1
- [Home](../README.md) > storagePathRequest
2
-
3
- # Variable: storagePathRequest
4
-
5
- Converter for path-based requests.
6
-
7
- ## Type
8
-
9
- `Converter<IStoragePathRequest>`