@fgv/ts-http-storage 5.1.0-1

package/docs/classes/FsStorageProvider.md

@@ -0,0 +1,134 @@
+[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>
+
+[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

@@ -0,0 +1,22 @@
+[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

@@ -0,0 +1,13 @@
+[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

@@ -0,0 +1,20 @@
+[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;

package/docs/classes/FsStorageProviderFactory.md

@@ -0,0 +1,69 @@
+[Home](../README.md) > FsStorageProviderFactory
+
+# Class: FsStorageProviderFactory
+
+Namespace-aware provider factory backed by filesystem directories.
+
+**Implements:** [`IHttpStorageProviderFactory`](../interfaces/IHttpStorageProviderFactory.md)
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+`constructor(options)`
+
+</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>
+
+[forNamespace(namespace)](./FsStorageProviderFactory.forNamespace.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/classes/HttpStorageService.createDirectory.md

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

package/docs/classes/HttpStorageService.getChildren.md

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

package/docs/classes/HttpStorageService.getFile.md

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

package/docs/classes/HttpStorageService.getItem.md

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

package/docs/classes/HttpStorageService.md

@@ -0,0 +1,132 @@
+[Home](../README.md) > HttpStorageService
+
+# Class: HttpStorageService
+
+Service layer for storage API operations.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+`constructor(providers)`
+
+</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(request)](./HttpStorageService.getItem.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[getChildren(request)](./HttpStorageService.getChildren.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[getFile(request)](./HttpStorageService.getFile.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[saveFile(request)](./HttpStorageService.saveFile.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[createDirectory(request)](./HttpStorageService.createDirectory.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[sync(request)](./HttpStorageService.sync.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/classes/HttpStorageService.saveFile.md

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

package/docs/classes/HttpStorageService.sync.md

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

package/docs/functions/createStorageRoutes.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > createStorageRoutes
+
+# Function: createStorageRoutes
+
+Builds storage routes for a Hono app.
+
+## Signature
+
+```typescript
+function createStorageRoutes(options: ICreateStorageRoutesOptions): Hono
+```

package/docs/functions/normalizeRequestPath.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > normalizeRequestPath
+
+# Function: normalizeRequestPath
+
+Normalizes a request path to a consistent POSIX format.
+
+## Signature
+
+```typescript
+function normalizeRequestPath(requestPath: string): string
+```

package/docs/functions/sanitizeNamespace.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > sanitizeNamespace
+
+# Function: sanitizeNamespace
+
+Sanitize namespace path segment.
+
+## Signature
+
+```typescript
+function sanitizeNamespace(namespace: string): Result<string>
+```

package/docs/interfaces/ICreateStorageRoutesOptions.logger.md

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

package/docs/interfaces/ICreateStorageRoutesOptions.md

@@ -0,0 +1,61 @@
+[Home](../README.md) > ICreateStorageRoutesOptions
+
+# Interface: ICreateStorageRoutesOptions
+
+Options for creating storage routes.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[providers](./ICreateStorageRoutesOptions.providers.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+[IHttpStorageProviderFactory](IHttpStorageProviderFactory.md)
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[logger](./ICreateStorageRoutesOptions.logger.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+ILogger
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/ICreateStorageRoutesOptions.providers.md

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

package/docs/interfaces/IFsStorageProviderFactoryOptions.md

@@ -0,0 +1,44 @@
+[Home](../README.md) > IFsStorageProviderFactoryOptions
+
+# Interface: IFsStorageProviderFactoryOptions
+
+Options for creating filesystem-backed storage providers.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[rootPath](./IFsStorageProviderFactoryOptions.rootPath.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IFsStorageProviderFactoryOptions.rootPath.md

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