@fgv/ts-http-storage 5.1.0-19 → 5.1.0-20

package/config/api-extractor.json

@@ -1,36 +0,0 @@
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "projectFolder": "..",
-  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
-  "bundledPackages": [],
-  "apiReport": {
-    "enabled": true
-  },
-  "docModel": {
-    "enabled": true
-  },
-  "dtsRollup": {
-    "enabled": true
-  },
-  "messages": {
-    "compilerMessageReporting": {
-      "default": {
-        "logLevel": "warning"
-      }
-    },
-    "extractorMessageReporting": {
-      "default": {
-        "logLevel": "warning"
-      },
-      "ae-unresolved-link": {
-        "logLevel": "none",
-        "addToApiReportFile": true
-      }
-    },
-    "tsdocMessageReporting": {
-      "default": {
-        "logLevel": "warning"
-      }
-    }
-  }
-}

package/config/rig.json

@@ -1,10 +0,0 @@
-// The "rig.json" file directs tools to look for their config files in an external package.
-// Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
-  /**
-   * (Required) The name of the rig package to inherit from.
-   * It should be an NPM package name with the "-rig" suffix.
-   */
-  "rigPackageName": "@rushstack/heft-node-rig"
-}

package/config/typedoc.json

@@ -1,7 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "extends": ["@fgv/heft-dual-rig/profiles/default/config/typedoc.compact-base.json"],
-  "plugin": ["../../../plugins/typedoc-compact-theme/lib/index.js"],
-  "entryPoints": ["../src/index.ts"],
-  "out": "../docs"
-}

package/docs/README.md

@@ -1,298 +0,0 @@
-# @fgv/ts-http-storage
-
-Reusable HTTP storage services for FileTree-style backends.
-
-## Classes
-
-<table><thead><tr><th>
-
-Name
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[FsStorageProvider](./classes/FsStorageProvider.md)
-
-</td><td>
-
-Filesystem-backed implementation of IHttpStorageProvider.
-
-</td></tr>
-<tr><td>
-
-[FsStorageProviderFactory](./classes/FsStorageProviderFactory.md)
-
-</td><td>
-
-Namespace-aware provider factory backed by filesystem directories.
-
-</td></tr>
-<tr><td>
-
-[HttpStorageService](./classes/HttpStorageService.md)
-
-</td><td>
-
-Service layer for storage API operations.
-
-</td></tr>
-</tbody></table>
-
-## Interfaces
-
-<table><thead><tr><th>
-
-Name
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[IStorageTreeItem](./interfaces/IStorageTreeItem.md)
-
-</td><td>
-
-Storage tree item metadata.
-
-</td></tr>
-<tr><td>
-
-[IStorageTreeChildrenResponse](./interfaces/IStorageTreeChildrenResponse.md)
-
-</td><td>
-
-Response for listing children.
-
-</td></tr>
-<tr><td>
-
-[IStorageFileResponse](./interfaces/IStorageFileResponse.md)
-
-</td><td>
-
-Response for reading a file.
-
-</td></tr>
-<tr><td>
-
-[IStoragePathRequest](./interfaces/IStoragePathRequest.md)
-
-</td><td>
-
-Request for path-based operations.
-
-</td></tr>
-<tr><td>
-
-[IStorageWriteFileRequest](./interfaces/IStorageWriteFileRequest.md)
-
-</td><td>
-
-Request for writing file contents.
-
-</td></tr>
-<tr><td>
-
-[IStorageSyncRequest](./interfaces/IStorageSyncRequest.md)
-
-</td><td>
-
-Request for sync operation.
-
-</td></tr>
-<tr><td>
-
-[IStorageSyncResponse](./interfaces/IStorageSyncResponse.md)
-
-</td><td>
-
-Sync response metadata.
-
-</td></tr>
-<tr><td>
-
-[IHttpStorageProvider](./interfaces/IHttpStorageProvider.md)
-
-</td><td>
-
-Provider contract for storage backends.
-
-</td></tr>
-<tr><td>
-
-[IHttpStorageProviderFactory](./interfaces/IHttpStorageProviderFactory.md)
-
-</td><td>
-
-Factory for creating namespace-scoped storage providers.
-
-</td></tr>
-<tr><td>
-
-[IFsStorageProviderFactoryOptions](./interfaces/IFsStorageProviderFactoryOptions.md)
-
-</td><td>
-
-Options for creating filesystem-backed storage providers.
-
-</td></tr>
-<tr><td>
-
-[ICreateStorageRoutesOptions](./interfaces/ICreateStorageRoutesOptions.md)
-
-</td><td>
-
-Options for creating storage routes.
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Name
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[StorageNamespace](./type-aliases/StorageNamespace.md)
-
-</td><td>
-
-Namespace identifier for scoped storage.
-
-</td></tr>
-<tr><td>
-
-[StorageItemType](./type-aliases/StorageItemType.md)
-
-</td><td>
-
-Storage item type.
-
-</td></tr>
-</tbody></table>
-
-## Functions
-
-<table><thead><tr><th>
-
-Name
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[normalizeRequestPath](./functions/normalizeRequestPath.md)
-
-</td><td>
-
-Normalizes a request path to a consistent POSIX format.
-
-</td></tr>
-<tr><td>
-
-[sanitizeNamespace](./functions/sanitizeNamespace.md)
-
-</td><td>
-
-Sanitize namespace path segment.
-
-</td></tr>
-<tr><td>
-
-[createStorageRoutes](./functions/createStorageRoutes.md)
-
-</td><td>
-
-Builds storage routes for a Hono app.
-
-</td></tr>
-</tbody></table>
-
-## Variables
-
-<table><thead><tr><th>
-
-Name
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[storageTreeItem](./variables/storageTreeItem.md)
-
-</td><td>
-
-Converter for IStorageTreeItem.
-
-</td></tr>
-<tr><td>
-
-[storagePathRequest](./variables/storagePathRequest.md)
-
-</td><td>
-
-Converter for path-based requests.
-
-</td></tr>
-<tr><td>
-
-[storageWriteFileRequest](./variables/storageWriteFileRequest.md)
-
-</td><td>
-
-Converter for write-file requests.
-
-</td></tr>
-<tr><td>
-
-[storageSyncRequest](./variables/storageSyncRequest.md)
-
-</td><td>
-
-Converter for sync requests.
-
-</td></tr>
-<tr><td>
-
-[storageFileResponse](./variables/storageFileResponse.md)
-
-</td><td>
-
-Converter for file responses.
-
-</td></tr>
-<tr><td>
-
-[storageTreeChildrenResponse](./variables/storageTreeChildrenResponse.md)
-
-</td><td>
-
-Converter for children list responses.
-
-</td></tr>
-</tbody></table>

package/docs/classes/FsStorageProvider.createDirectory.md

@@ -1,20 +0,0 @@
-[Home](../README.md) > [FsStorageProvider](./FsStorageProvider.md) > createDirectory
-
-## FsStorageProvider.createDirectory() method
-
-**Signature:**
-
-```typescript
-createDirectory(itemPath: string): Promise<Result<IStorageTreeItem>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>itemPath</td><td>string</td><td></td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;[IStorageTreeItem](../interfaces/IStorageTreeItem.md)&gt;&gt;

package/docs/classes/FsStorageProvider.deleteFile.md

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

package/docs/classes/FsStorageProvider.getChildren.md

@@ -1,20 +0,0 @@
-[Home](../README.md) > [FsStorageProvider](./FsStorageProvider.md) > getChildren
-
-## FsStorageProvider.getChildren() method
-
-**Signature:**
-
-```typescript
-getChildren(itemPath: string): Promise<Result<readonly IStorageTreeItem[]>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>itemPath</td><td>string</td><td></td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;readonly [IStorageTreeItem](../interfaces/IStorageTreeItem.md)[]&gt;&gt;

package/docs/classes/FsStorageProvider.getFile.md

@@ -1,20 +0,0 @@
-[Home](../README.md) > [FsStorageProvider](./FsStorageProvider.md) > getFile
-
-## FsStorageProvider.getFile() method
-
-**Signature:**
-
-```typescript
-getFile(itemPath: string): Promise<Result<IStorageFileResponse>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>itemPath</td><td>string</td><td></td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;[IStorageFileResponse](../interfaces/IStorageFileResponse.md)&gt;&gt;

package/docs/classes/FsStorageProvider.getItem.md

@@ -1,20 +0,0 @@
-[Home](../README.md) > [FsStorageProvider](./FsStorageProvider.md) > getItem
-
-## FsStorageProvider.getItem() method
-
-**Signature:**
-
-```typescript
-getItem(itemPath: string): Promise<Result<IStorageTreeItem>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>itemPath</td><td>string</td><td></td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;[IStorageTreeItem](../interfaces/IStorageTreeItem.md)&gt;&gt;

package/docs/classes/FsStorageProvider.md

@@ -1,147 +0,0 @@
-[Home](../README.md) > FsStorageProvider
-
-# Class: FsStorageProvider
-
-Filesystem-backed implementation of IHttpStorageProvider.
-
-**Implements:** [`IHttpStorageProvider`](../interfaces/IHttpStorageProvider.md)
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-`constructor(rootPath)`
-
-</td><td>
-
-
-
-</td><td>
-
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[getItem(itemPath)](./FsStorageProvider.getItem.md)
-
-</td><td>
-
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[getChildren(itemPath)](./FsStorageProvider.getChildren.md)
-
-</td><td>
-
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[getFile(itemPath)](./FsStorageProvider.getFile.md)
-
-</td><td>
-
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[saveFile(itemPath, contents, contentType)](./FsStorageProvider.saveFile.md)
-
-</td><td>
-
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[deleteFile(itemPath)](./FsStorageProvider.deleteFile.md)
-
-</td><td>
-
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[createDirectory(itemPath)](./FsStorageProvider.createDirectory.md)
-
-</td><td>
-
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[sync()](./FsStorageProvider.sync.md)
-
-</td><td>
-
-
-
-</td><td>
-
-
-
-</td></tr>
-</tbody></table>

package/docs/classes/FsStorageProvider.saveFile.md

@@ -1,22 +0,0 @@
-[Home](../README.md) > [FsStorageProvider](./FsStorageProvider.md) > saveFile
-
-## FsStorageProvider.saveFile() method
-
-**Signature:**
-
-```typescript
-saveFile(itemPath: 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>itemPath</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](../interfaces/IStorageFileResponse.md)&gt;&gt;

package/docs/classes/FsStorageProvider.sync.md

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

package/docs/classes/FsStorageProviderFactory.forNamespace.md

@@ -1,20 +0,0 @@
-[Home](../README.md) > [FsStorageProviderFactory](./FsStorageProviderFactory.md) > forNamespace
-
-## FsStorageProviderFactory.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](../interfaces/IHttpStorageProvider.md)&gt;