@fgv/ts-http-storage 5.1.0-1

package/docs/interfaces/IStorageTreeItem.md

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

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

package/docs/interfaces/IStorageTreeItem.path.md

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

package/docs/interfaces/IStorageTreeItem.type.md

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

package/docs/interfaces/IStorageWriteFileRequest.contentType.md

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

package/docs/interfaces/IStorageWriteFileRequest.contents.md

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

package/docs/interfaces/IStorageWriteFileRequest.md

@@ -0,0 +1,97 @@
+[Home](../README.md) > IStorageWriteFileRequest
+
+# Interface: IStorageWriteFileRequest
+
+Request for writing file contents.
+
+**Extends:** [`IStoragePathRequest`](IStoragePathRequest.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[contents](./IStorageWriteFileRequest.contents.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[contentType](./IStorageWriteFileRequest.contentType.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<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/type-aliases/StorageItemType.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > StorageItemType
+
+# Type Alias: StorageItemType
+
+Storage item type.
+
+## Type
+
+```typescript
+type StorageItemType = "file" | "directory"
+```

package/docs/type-aliases/StorageNamespace.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > StorageNamespace
+
+# Type Alias: StorageNamespace
+
+Namespace identifier for scoped storage.
+
+## Type
+
+```typescript
+type StorageNamespace = string
+```

package/docs/variables/storageFileResponse.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > storageFileResponse
+
+# Variable: storageFileResponse
+
+Converter for file responses.
+
+## Type
+
+`Converter<IStorageFileResponse>`

package/docs/variables/storagePathRequest.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > storagePathRequest
+
+# Variable: storagePathRequest
+
+Converter for path-based requests.
+
+## Type
+
+`Converter<IStoragePathRequest>`

package/docs/variables/storageSyncRequest.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > storageSyncRequest
+
+# Variable: storageSyncRequest
+
+Converter for sync requests.
+
+## Type
+
+`Converter<IStorageSyncRequest>`

package/docs/variables/storageTreeChildrenResponse.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > storageTreeChildrenResponse
+
+# Variable: storageTreeChildrenResponse
+
+Converter for children list responses.
+
+## Type
+
+`Converter<IStorageTreeChildrenResponse>`

package/docs/variables/storageTreeItem.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > storageTreeItem
+
+# Variable: storageTreeItem
+
+Converter for IStorageTreeItem.
+
+## Type
+
+`Converter<IStorageTreeItem>`

package/docs/variables/storageWriteFileRequest.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > storageWriteFileRequest
+
+# Variable: storageWriteFileRequest
+
+Converter for write-file requests.
+
+## Type
+
+`Converter<IStorageWriteFileRequest>`

package/etc/ts-http-storage.api.md

@@ -0,0 +1,184 @@
+## API Report File for "@fgv/ts-http-storage"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Converter } from '@fgv/ts-utils';
+import { Hono } from 'hono';
+import type { Logging } from '@fgv/ts-utils';
+import { Result } from '@fgv/ts-utils';
+
+// @public
+export function createStorageRoutes(options: ICreateStorageRoutesOptions): Hono;
+
+// @public
+export class FsStorageProvider implements IHttpStorageProvider {
+    constructor(rootPath: string);
+    // (undocumented)
+    createDirectory(itemPath: string): Promise<Result<IStorageTreeItem>>;
+    // (undocumented)
+    deleteFile(itemPath: string): Promise<Result<boolean>>;
+    // (undocumented)
+    getChildren(itemPath: string): Promise<Result<ReadonlyArray<IStorageTreeItem>>>;
+    // (undocumented)
+    getFile(itemPath: string): Promise<Result<IStorageFileResponse>>;
+    // (undocumented)
+    getItem(itemPath: string): Promise<Result<IStorageTreeItem>>;
+    // (undocumented)
+    saveFile(itemPath: string, contents: string, contentType?: string): Promise<Result<IStorageFileResponse>>;
+    // (undocumented)
+    sync(): Promise<Result<IStorageSyncResponse>>;
+}
+
+// @public
+export class FsStorageProviderFactory implements IHttpStorageProviderFactory {
+    constructor(options: IFsStorageProviderFactoryOptions);
+    // (undocumented)
+    forNamespace(namespace?: string): Result<IHttpStorageProvider>;
+}
+
+// @public
+export class HttpStorageService {
+    constructor(providers: IHttpStorageProviderFactory);
+    // (undocumented)
+    createDirectory(request: IStoragePathRequest): Promise<Result<IStorageTreeItem>>;
+    // (undocumented)
+    deleteFile(request: IStoragePathRequest): Promise<Result<boolean>>;
+    // (undocumented)
+    getChildren(request: IStoragePathRequest): Promise<Result<IStorageTreeChildrenResponse>>;
+    // (undocumented)
+    getFile(request: IStoragePathRequest): Promise<Result<IStorageFileResponse>>;
+    // (undocumented)
+    getItem(request: IStoragePathRequest): Promise<Result<IStorageTreeItem>>;
+    // (undocumented)
+    saveFile(request: IStorageWriteFileRequest): Promise<Result<IStorageFileResponse>>;
+    // (undocumented)
+    sync(request: IStorageSyncRequest): Promise<Result<IStorageSyncResponse>>;
+}
+
+// @public
+export interface ICreateStorageRoutesOptions {
+    // (undocumented)
+    readonly logger?: Logging.ILogger;
+    // (undocumented)
+    readonly providers: IHttpStorageProviderFactory;
+}
+
+// @public
+export interface IFsStorageProviderFactoryOptions {
+    // (undocumented)
+    readonly rootPath: string;
+}
+
+// @public
+export interface IHttpStorageProvider {
+    // (undocumented)
+    createDirectory(path: string): Promise<Result<IStorageTreeItem>>;
+    // (undocumented)
+    deleteFile(path: string): Promise<Result<boolean>>;
+    // (undocumented)
+    getChildren(path: string): Promise<Result<ReadonlyArray<IStorageTreeItem>>>;
+    // (undocumented)
+    getFile(path: string): Promise<Result<IStorageFileResponse>>;
+    // (undocumented)
+    getItem(path: string): Promise<Result<IStorageTreeItem>>;
+    // (undocumented)
+    saveFile(path: string, contents: string, contentType?: string): Promise<Result<IStorageFileResponse>>;
+    // (undocumented)
+    sync(): Promise<Result<IStorageSyncResponse>>;
+}
+
+// @public
+export interface IHttpStorageProviderFactory {
+    // (undocumented)
+    forNamespace(namespace?: StorageNamespace): Result<IHttpStorageProvider>;
+}
+
+// @public
+export interface IStorageFileResponse {
+    // (undocumented)
+    readonly contents: string;
+    // (undocumented)
+    readonly contentType?: string;
+    // (undocumented)
+    readonly path: string;
+}
+
+// @public
+export interface IStoragePathRequest {
+    // (undocumented)
+    readonly namespace?: StorageNamespace;
+    // (undocumented)
+    readonly path: string;
+}
+
+// @public
+export interface IStorageSyncRequest {
+    // (undocumented)
+    readonly namespace?: StorageNamespace;
+}
+
+// @public
+export interface IStorageSyncResponse {
+    // (undocumented)
+    readonly synced: number;
+}
+
+// @public
+export interface IStorageTreeChildrenResponse {
+    // (undocumented)
+    readonly children: ReadonlyArray<IStorageTreeItem>;
+    // (undocumented)
+    readonly path: string;
+}
+
+// @public
+export interface IStorageTreeItem {
+    // (undocumented)
+    readonly name: string;
+    // (undocumented)
+    readonly path: string;
+    // (undocumented)
+    readonly type: StorageItemType;
+}
+
+// @public
+export interface IStorageWriteFileRequest extends IStoragePathRequest {
+    // (undocumented)
+    readonly contents: string;
+    // (undocumented)
+    readonly contentType?: string;
+}
+
+// @public
+export function normalizeRequestPath(requestPath: string): string;
+
+// @public
+export function sanitizeNamespace(namespace?: string): Result<string>;
+
+// @public
+export const storageFileResponse: Converter<IStorageFileResponse>;
+
+// @public
+export type StorageItemType = 'file' | 'directory';
+
+// @public
+export type StorageNamespace = string;
+
+// @public
+export const storagePathRequest: Converter<IStoragePathRequest>;
+
+// @public
+export const storageSyncRequest: Converter<IStorageSyncRequest>;
+
+// @public
+export const storageTreeChildrenResponse: Converter<IStorageTreeChildrenResponse>;
+
+// @public
+export const storageTreeItem: Converter<IStorageTreeItem>;
+
+// @public
+export const storageWriteFileRequest: Converter<IStorageWriteFileRequest>;
+
+```

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Reusable HTTP storage services for FileTree-style backends.
+ * @packageDocumentation
+ */
+export * from './packlets/storage';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA;;;GAGG;AAEH,cAAc,oBAAoB,CAAC"}

package/lib/index.js

@@ -0,0 +1,43 @@
+"use strict";
+/*
+ * Copyright (c) 2026 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Reusable HTTP storage services for FileTree-style backends.
+ * @packageDocumentation
+ */
+__exportStar(require("./packlets/storage"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH;;;GAGG;AAEH,qDAAmC","sourcesContent":["/*\n * Copyright (c) 2026 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\n/**\n * Reusable HTTP storage services for FileTree-style backends.\n * @packageDocumentation\n */\n\nexport * from './packlets/storage';\n"]}

package/lib/packlets/storage/converters.d.ts

@@ -0,0 +1,33 @@
+import { type Converter } from '@fgv/ts-utils';
+import type { IStorageFileResponse, IStoragePathRequest, IStorageSyncRequest, IStorageTreeChildrenResponse, IStorageTreeItem, IStorageWriteFileRequest } from './model';
+/**
+ * Converter for {@link IStorageTreeItem}.
+ * @public
+ */
+export declare const storageTreeItem: Converter<IStorageTreeItem>;
+/**
+ * Converter for path-based requests.
+ * @public
+ */
+export declare const storagePathRequest: Converter<IStoragePathRequest>;
+/**
+ * Converter for write-file requests.
+ * @public
+ */
+export declare const storageWriteFileRequest: Converter<IStorageWriteFileRequest>;
+/**
+ * Converter for sync requests.
+ * @public
+ */
+export declare const storageSyncRequest: Converter<IStorageSyncRequest>;
+/**
+ * Converter for file responses.
+ * @public
+ */
+export declare const storageFileResponse: Converter<IStorageFileResponse>;
+/**
+ * Converter for children list responses.
+ * @public
+ */
+export declare const storageTreeChildrenResponse: Converter<IStorageTreeChildrenResponse>;
+//# sourceMappingURL=converters.d.ts.map

package/lib/packlets/storage/converters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"converters.d.ts","sourceRoot":"","sources":["../../../src/packlets/storage/converters.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,KAAK,SAAS,EAAc,MAAM,eAAe,CAAC;AAE3D,OAAO,KAAK,EACV,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,4BAA4B,EAC5B,gBAAgB,EAChB,wBAAwB,EAEzB,MAAM,SAAS,CAAC;AAOjB;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,SAAS,CAAC,gBAAgB,CAItD,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,SAAS,CAAC,mBAAmB,CAI1D,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,SAAS,CAAC,wBAAwB,CAMpE,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,SAAS,CAAC,mBAAmB,CAG1D,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,SAAS,CAAC,oBAAoB,CAK5D,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,2BAA2B,EAAE,SAAS,CAAC,4BAA4B,CAI5E,CAAC"}

package/lib/packlets/storage/converters.js

@@ -0,0 +1,81 @@
+"use strict";
+/*
+ * Copyright (c) 2026 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.storageTreeChildrenResponse = exports.storageFileResponse = exports.storageSyncRequest = exports.storageWriteFileRequest = exports.storagePathRequest = exports.storageTreeItem = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const storageItemType = ts_utils_1.Converters.enumeratedValue([
+    'file',
+    'directory'
+]);
+/**
+ * Converter for {@link IStorageTreeItem}.
+ * @public
+ */
+exports.storageTreeItem = ts_utils_1.Converters.strictObject({
+    path: ts_utils_1.Converters.string,
+    name: ts_utils_1.Converters.string,
+    type: storageItemType
+});
+/**
+ * Converter for path-based requests.
+ * @public
+ */
+exports.storagePathRequest = ts_utils_1.Converters.strictObject({
+    path: ts_utils_1.Converters.string,
+    namespace: ts_utils_1.Converters.string.optional()
+});
+/**
+ * Converter for write-file requests.
+ * @public
+ */
+exports.storageWriteFileRequest = ts_utils_1.Converters.strictObject({
+    path: ts_utils_1.Converters.string,
+    contents: ts_utils_1.Converters.string,
+    contentType: ts_utils_1.Converters.string.optional(),
+    namespace: ts_utils_1.Converters.string.optional()
+});
+/**
+ * Converter for sync requests.
+ * @public
+ */
+exports.storageSyncRequest = ts_utils_1.Converters.strictObject({
+    namespace: ts_utils_1.Converters.string.optional()
+});
+/**
+ * Converter for file responses.
+ * @public
+ */
+exports.storageFileResponse = ts_utils_1.Converters.strictObject({
+    path: ts_utils_1.Converters.string,
+    contents: ts_utils_1.Converters.string,
+    contentType: ts_utils_1.Converters.string.optional()
+});
+/**
+ * Converter for children list responses.
+ * @public
+ */
+exports.storageTreeChildrenResponse = ts_utils_1.Converters.strictObject({
+    path: ts_utils_1.Converters.string,
+    children: ts_utils_1.Converters.arrayOf(exports.storageTreeItem)
+});
+//# sourceMappingURL=converters.js.map