npm - @fgv/ts-http-storage - Versions diffs - 5.1.0-4 → 5.1.0-40 - Mend

@fgv/ts-http-storage 5.1.0-4 → 5.1.0-40

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 (108) hide show

package/dist/tsdoc-metadata.json +1 -1
package/eslint.config.js +16 -0
package/package.json +5 -5
package/.rush/temp/6ab9195b15cc32c9f5e7e6f55bce0a88fab1fac6.tar.log +0 -61
package/.rush/temp/chunked-rush-logs/ts-http-storage.build.chunks.jsonl +0 -9
package/.rush/temp/operation/build/all.log +0 -9
package/.rush/temp/operation/build/log-chunks.jsonl +0 -9
package/.rush/temp/operation/build/state.json +0 -3
package/.rush/temp/shrinkwrap-deps.json +0 -656
package/config/api-extractor.json +0 -36
package/config/rig.json +0 -10
package/config/typedoc.json +0 -7
package/docs/README.md +0 -298
package/docs/classes/FsStorageProvider.createDirectory.md +0 -20
package/docs/classes/FsStorageProvider.deleteFile.md +0 -20
package/docs/classes/FsStorageProvider.getChildren.md +0 -20
package/docs/classes/FsStorageProvider.getFile.md +0 -20
package/docs/classes/FsStorageProvider.getItem.md +0 -20
package/docs/classes/FsStorageProvider.md +0 -147
package/docs/classes/FsStorageProvider.saveFile.md +0 -22
package/docs/classes/FsStorageProvider.sync.md +0 -13
package/docs/classes/FsStorageProviderFactory.forNamespace.md +0 -20
package/docs/classes/FsStorageProviderFactory.md +0 -69
package/docs/classes/HttpStorageService.createDirectory.md +0 -20
package/docs/classes/HttpStorageService.deleteFile.md +0 -20
package/docs/classes/HttpStorageService.getChildren.md +0 -20
package/docs/classes/HttpStorageService.getFile.md +0 -20
package/docs/classes/HttpStorageService.getItem.md +0 -20
package/docs/classes/HttpStorageService.md +0 -145
package/docs/classes/HttpStorageService.saveFile.md +0 -20
package/docs/classes/HttpStorageService.sync.md +0 -20
package/docs/functions/createStorageRoutes.md +0 -11
package/docs/functions/normalizeRequestPath.md +0 -11
package/docs/functions/sanitizeNamespace.md +0 -11
package/docs/interfaces/ICreateStorageRoutesOptions.logger.md +0 -9
package/docs/interfaces/ICreateStorageRoutesOptions.md +0 -61
package/docs/interfaces/ICreateStorageRoutesOptions.providers.md +0 -9
package/docs/interfaces/IFsStorageProviderFactoryOptions.md +0 -44
package/docs/interfaces/IFsStorageProviderFactoryOptions.rootPath.md +0 -9
package/docs/interfaces/IHttpStorageProvider.createDirectory.md +0 -20
package/docs/interfaces/IHttpStorageProvider.deleteFile.md +0 -20
package/docs/interfaces/IHttpStorageProvider.getChildren.md +0 -20
package/docs/interfaces/IHttpStorageProvider.getFile.md +0 -20
package/docs/interfaces/IHttpStorageProvider.getItem.md +0 -20
package/docs/interfaces/IHttpStorageProvider.md +0 -115
package/docs/interfaces/IHttpStorageProvider.saveFile.md +0 -22
package/docs/interfaces/IHttpStorageProvider.sync.md +0 -13
package/docs/interfaces/IHttpStorageProviderFactory.forNamespace.md +0 -20
package/docs/interfaces/IHttpStorageProviderFactory.md +0 -36
package/docs/interfaces/IStorageFileResponse.contentType.md +0 -9
package/docs/interfaces/IStorageFileResponse.contents.md +0 -9
package/docs/interfaces/IStorageFileResponse.md +0 -78
package/docs/interfaces/IStorageFileResponse.path.md +0 -9
package/docs/interfaces/IStoragePathRequest.md +0 -61
package/docs/interfaces/IStoragePathRequest.namespace.md +0 -9
package/docs/interfaces/IStoragePathRequest.path.md +0 -9
package/docs/interfaces/IStorageSyncRequest.md +0 -44
package/docs/interfaces/IStorageSyncRequest.namespace.md +0 -9
package/docs/interfaces/IStorageSyncResponse.md +0 -44
package/docs/interfaces/IStorageSyncResponse.synced.md +0 -9
package/docs/interfaces/IStorageTreeChildrenResponse.children.md +0 -9
package/docs/interfaces/IStorageTreeChildrenResponse.md +0 -61
package/docs/interfaces/IStorageTreeChildrenResponse.path.md +0 -9
package/docs/interfaces/IStorageTreeItem.md +0 -78
package/docs/interfaces/IStorageTreeItem.name.md +0 -9
package/docs/interfaces/IStorageTreeItem.path.md +0 -9
package/docs/interfaces/IStorageTreeItem.type.md +0 -9
package/docs/interfaces/IStorageWriteFileRequest.contentType.md +0 -9
package/docs/interfaces/IStorageWriteFileRequest.contents.md +0 -9
package/docs/interfaces/IStorageWriteFileRequest.md +0 -97
package/docs/type-aliases/StorageItemType.md +0 -11
package/docs/type-aliases/StorageNamespace.md +0 -11
package/docs/variables/storageFileResponse.md +0 -9
package/docs/variables/storagePathRequest.md +0 -9
package/docs/variables/storageSyncRequest.md +0 -9
package/docs/variables/storageTreeChildrenResponse.md +0 -9
package/docs/variables/storageTreeItem.md +0 -9
package/docs/variables/storageWriteFileRequest.md +0 -9
package/etc/ts-http-storage.api.md +0 -184
package/lib/test/unit/storage/fsProvider.test.d.ts +0 -2
package/lib/test/unit/storage/fsProvider.test.d.ts.map +0 -1
package/lib/test/unit/storage/fsProvider.test.js +0 -106
package/lib/test/unit/storage/fsProvider.test.js.map +0 -1
package/lib/test/unit/storage/routes.test.d.ts +0 -2
package/lib/test/unit/storage/routes.test.d.ts.map +0 -1
package/lib/test/unit/storage/routes.test.js +0 -124
package/lib/test/unit/storage/routes.test.js.map +0 -1
package/lib/test/unit/storage/service.test.d.ts +0 -2
package/lib/test/unit/storage/service.test.d.ts.map +0 -1
package/lib/test/unit/storage/service.test.js +0 -67
package/lib/test/unit/storage/service.test.js.map +0 -1
package/rush-logs/ts-http-storage.build.cache.log +0 -3
package/rush-logs/ts-http-storage.build.log +0 -9
package/src/index.ts +0 -28
package/src/packlets/storage/converters.ts +0 -100
package/src/packlets/storage/fsProvider.ts +0 -263
package/src/packlets/storage/index.ts +0 -33
package/src/packlets/storage/model.ts +0 -113
package/src/packlets/storage/provider.ts +0 -33
package/src/packlets/storage/routes.ts +0 -215
package/src/packlets/storage/service.ts +0 -114
package/src/test/unit/storage/fsProvider.test.ts +0 -129
package/src/test/unit/storage/routes.test.ts +0 -165
package/src/test/unit/storage/service.test.ts +0 -95
package/temp/build/typescript/ts_l9Fw4VUO.json +0 -1
package/temp/ts-http-storage.api.json +0 -3103
package/temp/ts-http-storage.api.md +0 -184
package/tsconfig.json +0 -7

package/docs/interfaces/IHttpStorageProvider.md DELETED Viewed

@@ -1,115 +0,0 @@
-[Home](../README.md) > IHttpStorageProvider
-# Interface: IHttpStorageProvider
-Provider contract for storage backends.
-All methods are async to support both filesystem and database backends.
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[getItem(path)](./IHttpStorageProvider.getItem.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[getChildren(path)](./IHttpStorageProvider.getChildren.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[getFile(path)](./IHttpStorageProvider.getFile.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[saveFile(path, contents, contentType)](./IHttpStorageProvider.saveFile.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[deleteFile(path)](./IHttpStorageProvider.deleteFile.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[createDirectory(path)](./IHttpStorageProvider.createDirectory.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[sync()](./IHttpStorageProvider.sync.md)
-</td><td>
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/interfaces/IHttpStorageProvider.saveFile.md DELETED Viewed

@@ -1,22 +0,0 @@
-[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > saveFile
-## IHttpStorageProvider.saveFile() method
-**Signature:**
-```typescript
-saveFile(path: string, contents: string, contentType?: string): Promise<Result<IStorageFileResponse>>;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>path</td><td>string</td><td></td></tr>
-<tr><td>contents</td><td>string</td><td></td></tr>
-<tr><td>contentType</td><td>string</td><td></td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;Result&lt;[IStorageFileResponse](IStorageFileResponse.md)&gt;&gt;

package/docs/interfaces/IHttpStorageProvider.sync.md DELETED Viewed

@@ -1,13 +0,0 @@
-[Home](../README.md) > [IHttpStorageProvider](./IHttpStorageProvider.md) > sync
-## IHttpStorageProvider.sync() method
-**Signature:**
-```typescript
-sync(): Promise<Result<IStorageSyncResponse>>;
-```
-**Returns:**
-Promise&lt;Result&lt;[IStorageSyncResponse](IStorageSyncResponse.md)&gt;&gt;

package/docs/interfaces/IHttpStorageProviderFactory.forNamespace.md DELETED Viewed

@@ -1,20 +0,0 @@
-[Home](../README.md) > [IHttpStorageProviderFactory](./IHttpStorageProviderFactory.md) > forNamespace
-## IHttpStorageProviderFactory.forNamespace() method
-**Signature:**
-```typescript
-forNamespace(namespace?: string): Result<IHttpStorageProvider>;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>namespace</td><td>string</td><td></td></tr>
-</tbody></table>
-**Returns:**
-Result&lt;[IHttpStorageProvider](IHttpStorageProvider.md)&gt;

package/docs/interfaces/IHttpStorageProviderFactory.md DELETED Viewed

@@ -1,36 +0,0 @@
-[Home](../README.md) > IHttpStorageProviderFactory
-# Interface: IHttpStorageProviderFactory
-Factory for creating namespace-scoped storage providers.
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[forNamespace(namespace)](./IHttpStorageProviderFactory.forNamespace.md)
-</td><td>
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/interfaces/IStorageFileResponse.contentType.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStorageFileResponse](./IStorageFileResponse.md) > contentType
-## IStorageFileResponse.contentType property
-**Signature:**
-```typescript
-readonly contentType: string;
-```

package/docs/interfaces/IStorageFileResponse.contents.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStorageFileResponse](./IStorageFileResponse.md) > contents
-## IStorageFileResponse.contents property
-**Signature:**
-```typescript
-readonly contents: string;
-```

package/docs/interfaces/IStorageFileResponse.md DELETED Viewed

@@ -1,78 +0,0 @@
-[Home](../README.md) > IStorageFileResponse
-# Interface: IStorageFileResponse
-Response for reading a file.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[path](./IStorageFileResponse.path.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[contents](./IStorageFileResponse.contents.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[contentType](./IStorageFileResponse.contentType.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/interfaces/IStorageFileResponse.path.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStorageFileResponse](./IStorageFileResponse.md) > path
-## IStorageFileResponse.path property
-**Signature:**
-```typescript
-readonly path: string;
-```

package/docs/interfaces/IStoragePathRequest.md DELETED Viewed

@@ -1,61 +0,0 @@
-[Home](../README.md) > IStoragePathRequest
-# Interface: IStoragePathRequest
-Request for path-based operations.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[path](./IStoragePathRequest.path.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[namespace](./IStoragePathRequest.namespace.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/interfaces/IStoragePathRequest.namespace.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStoragePathRequest](./IStoragePathRequest.md) > namespace
-## IStoragePathRequest.namespace property
-**Signature:**
-```typescript
-readonly namespace: string;
-```

package/docs/interfaces/IStoragePathRequest.path.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStoragePathRequest](./IStoragePathRequest.md) > path
-## IStoragePathRequest.path property
-**Signature:**
-```typescript
-readonly path: string;
-```

package/docs/interfaces/IStorageSyncRequest.md DELETED Viewed

@@ -1,44 +0,0 @@
-[Home](../README.md) > IStorageSyncRequest
-# Interface: IStorageSyncRequest
-Request for sync operation.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[namespace](./IStorageSyncRequest.namespace.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/interfaces/IStorageSyncRequest.namespace.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStorageSyncRequest](./IStorageSyncRequest.md) > namespace
-## IStorageSyncRequest.namespace property
-**Signature:**
-```typescript
-readonly namespace: string;
-```

package/docs/interfaces/IStorageSyncResponse.md DELETED Viewed

@@ -1,44 +0,0 @@
-[Home](../README.md) > IStorageSyncResponse
-# Interface: IStorageSyncResponse
-Sync response metadata.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[synced](./IStorageSyncResponse.synced.md)
-</td><td>
-`readonly`
-</td><td>
-number
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/interfaces/IStorageSyncResponse.synced.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStorageSyncResponse](./IStorageSyncResponse.md) > synced
-## IStorageSyncResponse.synced property
-**Signature:**
-```typescript
-readonly synced: number;
-```

package/docs/interfaces/IStorageTreeChildrenResponse.children.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStorageTreeChildrenResponse](./IStorageTreeChildrenResponse.md) > children
-## IStorageTreeChildrenResponse.children property
-**Signature:**
-```typescript
-readonly children: readonly IStorageTreeItem[];
-```

package/docs/interfaces/IStorageTreeChildrenResponse.md DELETED Viewed

@@ -1,61 +0,0 @@
-[Home](../README.md) > IStorageTreeChildrenResponse
-# Interface: IStorageTreeChildrenResponse
-Response for listing children.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[path](./IStorageTreeChildrenResponse.path.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[children](./IStorageTreeChildrenResponse.children.md)
-</td><td>
-`readonly`
-</td><td>
-readonly [IStorageTreeItem](IStorageTreeItem.md)[]
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/interfaces/IStorageTreeChildrenResponse.path.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStorageTreeChildrenResponse](./IStorageTreeChildrenResponse.md) > path
-## IStorageTreeChildrenResponse.path property
-**Signature:**
-```typescript
-readonly path: string;
-```

package/docs/interfaces/IStorageTreeItem.md DELETED Viewed

@@ -1,78 +0,0 @@
-[Home](../README.md) > IStorageTreeItem
-# Interface: IStorageTreeItem
-Storage tree item metadata.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[path](./IStorageTreeItem.path.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[name](./IStorageTreeItem.name.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[type](./IStorageTreeItem.type.md)
-</td><td>
-`readonly`
-</td><td>
-[StorageItemType](../type-aliases/StorageItemType.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/interfaces/IStorageTreeItem.name.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStorageTreeItem](./IStorageTreeItem.md) > name
-## IStorageTreeItem.name property
-**Signature:**
-```typescript
-readonly name: string;
-```

package/docs/interfaces/IStorageTreeItem.path.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStorageTreeItem](./IStorageTreeItem.md) > path
-## IStorageTreeItem.path property
-**Signature:**
-```typescript
-readonly path: string;
-```

package/docs/interfaces/IStorageTreeItem.type.md DELETED Viewed

@@ -1,9 +0,0 @@
-[Home](../README.md) > [IStorageTreeItem](./IStorageTreeItem.md) > type
-## IStorageTreeItem.type property
-**Signature:**
-```typescript
-readonly type: StorageItemType;
-```