@nestm/storage 0.1.0-alpha.8 → 0.1.0-alpha.9

package/dist/workspace/storage-workspace.types.d.ts

@@ -1,13 +1,13 @@
 import type { StorageBody, StorageOperationOptions } from '../storage.types.js';
 import type { StorageWorkspaceCursorConfiguration } from './storage-workspace.cursor.js';
-export declare const STORAGE_WORKSPACE_PERMISSIONS: readonly ['list', 'read', 'search', 'create', 'replace', 'copy', 'move', 'delete'];
+export declare const STORAGE_WORKSPACE_PERMISSIONS: readonly ['list', 'read', 'search', 'write', 'create', 'replace', 'copy', 'move', 'delete'];
 export type StorageWorkspacePermission = (typeof STORAGE_WORKSPACE_PERMISSIONS)[number];
 export interface StorageWorkspaceLimits {
     /** Maximum UTF-8 byte length of an opaque continuation cursor. */
     maxCursorBytes: number;
     /** Maximum UTF-8 byte length of a workspace-relative path. */
     maxPathBytes: number;
-    /** Maximum bytes returned by a buffered text read. */
+    /** Maximum bytes returned by one buffered text or binary read. */
     maxReadBytes: number;
     /** Maximum bytes accepted by one write. */
     maxWriteBytes: number;
@@ -42,6 +42,9 @@ export type StorageWorkspaceEntry = StorageWorkspaceFile | StorageWorkspaceDirec
 export interface StorageWorkspaceTextFile extends StorageWorkspaceFile {
     text: string;
 }
+export interface StorageWorkspaceByteFile extends StorageWorkspaceFile {
+    bytes: Uint8Array;
+}
 export interface StorageWorkspacePage {
     entries: StorageWorkspaceEntry[];
     cursor?: string;
@@ -79,6 +82,10 @@ interface StorageWorkspaceWriteCommon extends StorageOperationOptions {
 }
 export type StorageWorkspaceWriteOptions = StorageWorkspaceWriteCommon & ({
     mode: 'create';
+}
+/** Unconditionally writes the destination through the ordinary Files path. */
+ | {
+    mode: 'overwrite';
 } | {
     mode: 'replace';
     etag: string;
@@ -86,6 +93,16 @@ export type StorageWorkspaceWriteOptions = StorageWorkspaceWriteCommon & ({
 export interface StorageWorkspaceMutationOptions extends StorageOperationOptions {
     etag: string;
 }
+export interface StorageWorkspaceOverwriteOptions extends StorageOperationOptions {
+    /** Unconditionally overwrites the destination through the ordinary Files path. */
+    mode: 'overwrite';
+}
+export interface StorageWorkspaceUnconditionalDeleteOptions extends StorageOperationOptions {
+    /** Deletes the current destination without an ETag precondition. */
+    mode: 'unconditional';
+}
+export type StorageWorkspaceCopyOptions = StorageWorkspaceMutationOptions | StorageWorkspaceOverwriteOptions;
+export type StorageWorkspaceDeleteOptions = StorageWorkspaceMutationOptions | StorageWorkspaceUnconditionalDeleteOptions;
 export type StorageWorkspaceBody = Extract<StorageBody, string | Uint8Array>;
 export interface StorageWorkspace {
     readonly permissions: ReadonlySet<StorageWorkspacePermission>;
@@ -93,12 +110,13 @@ export interface StorageWorkspace {
     allows(permission: StorageWorkspacePermission): boolean;
     stat(path: string, options?: StorageOperationOptions): Promise<StorageWorkspaceFile>;
     readText(path: string, options?: StorageWorkspaceReadOptions): Promise<StorageWorkspaceTextFile>;
+    readBytes(path: string, options?: StorageWorkspaceReadOptions): Promise<StorageWorkspaceByteFile>;
     list(options?: StorageWorkspaceListOptions): Promise<StorageWorkspacePage>;
     search(query: string, options?: StorageWorkspaceSearchOptions): Promise<StorageWorkspacePage>;
     writeFile(path: string, body: StorageWorkspaceBody, options: StorageWorkspaceWriteOptions): Promise<StorageWorkspaceFile>;
-    copyFile(source: string, destination: string, options: StorageWorkspaceMutationOptions): Promise<StorageWorkspaceFile>;
+    copyFile(source: string, destination: string, options: StorageWorkspaceCopyOptions): Promise<StorageWorkspaceFile>;
     moveFile(source: string, destination: string, options: StorageWorkspaceMutationOptions): Promise<StorageWorkspaceFile>;
-    deleteFile(path: string, options: StorageWorkspaceMutationOptions): Promise<void>;
+    deleteFile(path: string, options: StorageWorkspaceDeleteOptions): Promise<void>;
     mount(directory: string, options?: StorageWorkspaceMountOptions): StorageWorkspace;
 }
 export {};

package/dist/workspace/storage-workspace.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-workspace.types.d.ts","sourceRoot":"","sources":["../../src/workspace/storage-workspace.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAEhF,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,+BAA+B,CAAC;AAEzF,eAAO,MAAM,6BAA6B,YACxC,MAAM,EACN,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,MAAM,EACN,MAAM,EACN,QAAQ,CACA,CAAC;AAEX,MAAM,MAAM,0BAA0B,GACpC,CAAC,OAAO,6BAA6B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD,MAAM,WAAW,sBAAsB;IACrC,kEAAkE;IAClE,cAAc,EAAE,MAAM,CAAC;IACvB,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,gBAAgB,EAAE,MAAM,CAAC;IACzB,sEAAsE;IACtE,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,eAAO,MAAM,gCAAgC,EAAE,QAAQ,CAAC,sBAAsB,CAU1E,CAAC;AAEL,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,qBAAqB,GAC/B,oBAAoB,GAAG,yBAAyB,CAAC;AAEnD,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,4BAA4B;IAC3C,WAAW,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IACnD,MAAM,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,4BAA6B,SAAQ,4BAA4B;IAChF,4EAA4E;IAC5E,MAAM,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,MAAM,CAAC,EAAE,mCAAmC,CAAC;CAC9C;AAED,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC1E,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED,MAAM,MAAM,2BAA2B,GAAG,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC;AAEzE,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,KAAK,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;IAChD,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED,UAAU,2BAA4B,SAAQ,uBAAuB;IACnE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,MAAM,4BAA4B,GAAG,2BAA2B,GACpE,CACI;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd,CACJ,CAAC;AAEJ,MAAM,WAAW,+BAAgC,SAAQ,uBAAuB;IAC9E,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC;AAE7E,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,0BAA0B,CAAC,CAAC;IAC9D,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IAClD,MAAM,CAAC,UAAU,EAAE,0BAA0B,GAAG,OAAO,CAAC;IACxD,IAAI,CACF,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,2BAA2B,GACpC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACrC,IAAI,CAAC,OAAO,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC3E,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,6BAA6B,GACtC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,oBAAoB,EAC1B,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC,UAAU,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,4BAA4B,GACrC,gBAAgB,CAAC;CACrB"}
+{"version":3,"file":"storage-workspace.types.d.ts","sourceRoot":"","sources":["../../src/workspace/storage-workspace.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAEhF,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,+BAA+B,CAAC;AAEzF,eAAO,MAAM,6BAA6B,YACxC,MAAM,EACN,MAAM,EACN,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,SAAS,EACT,MAAM,EACN,MAAM,EACN,QAAQ,CACA,CAAC;AAEX,MAAM,MAAM,0BAA0B,GACpC,CAAC,OAAO,6BAA6B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD,MAAM,WAAW,sBAAsB;IACrC,kEAAkE;IAClE,cAAc,EAAE,MAAM,CAAC;IACvB,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAC;IACrB,kEAAkE;IAClE,YAAY,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,gBAAgB,EAAE,MAAM,CAAC;IACzB,sEAAsE;IACtE,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,eAAO,MAAM,gCAAgC,EAAE,QAAQ,CAAC,sBAAsB,CAU1E,CAAC;AAEL,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,qBAAqB,GAC/B,oBAAoB,GAAG,yBAAyB,CAAC;AAEnD,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,KAAK,EAAE,UAAU,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,4BAA4B;IAC3C,WAAW,CAAC,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IACnD,MAAM,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,4BAA6B,SAAQ,4BAA4B;IAChF,4EAA4E;IAC5E,MAAM,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,MAAM,CAAC,EAAE,mCAAmC,CAAC;CAC9C;AAED,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC1E,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED,MAAM,MAAM,2BAA2B,GAAG,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC;AAEzE,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,KAAK,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;IAChD,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED,UAAU,2BAA4B,SAAQ,uBAAuB;IACnE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,MAAM,4BAA4B,GAAG,2BAA2B,GACpE,CACI;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE;AACpB,8EAA8E;GAC5E;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd,CACJ,CAAC;AAEJ,MAAM,WAAW,+BAAgC,SAAQ,uBAAuB;IAC9E,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,gCAAiC,SAAQ,uBAAuB;IAC/E,kFAAkF;IAClF,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,MAAM,WAAW,0CAA2C,SAAQ,uBAAuB;IACzF,oEAAoE;IACpE,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,MAAM,2BAA2B,GACrC,+BAA+B,GAAG,gCAAgC,CAAC;AAErE,MAAM,MAAM,6BAA6B,GACvC,+BAA+B,GAAG,0CAA0C,CAAC;AAE/E,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC;AAE7E,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,0BAA0B,CAAC,CAAC;IAC9D,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IAClD,MAAM,CAAC,UAAU,EAAE,0BAA0B,GAAG,OAAO,CAAC;IACxD,IAAI,CACF,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,2BAA2B,GACpC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACrC,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,2BAA2B,GACpC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACrC,IAAI,CAAC,OAAO,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC3E,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,6BAA6B,GACtC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,oBAAoB,EAC1B,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC,UAAU,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,4BAA4B,GACrC,gBAAgB,CAAC;CACrB"}

package/dist/workspace/storage-workspace.types.js

@@ -2,6 +2,7 @@ export const STORAGE_WORKSPACE_PERMISSIONS = [
     'list',
     'read',
     'search',
+    'write',
     'create',
     'replace',
     'copy',

package/dist/workspace/storage-workspace.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage-workspace.types.js","sourceRoot":"","sources":["../../src/workspace/storage-workspace.types.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,MAAM;IACN,MAAM;IACN,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,MAAM;IACN,MAAM;IACN,QAAQ;CACA,CAAC;AA2BX,MAAM,CAAC,MAAM,gCAAgC,GAC3C,MAAM,CAAC,MAAM,CAAC;IACZ,WAAW,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI;IAC1B,cAAc,EAAE,KAAK;IACrB,WAAW,EAAE,GAAG;IAChB,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,IAAI,GAAG,IAAI;IACzB,gBAAgB,EAAE,GAAG;IACrB,aAAa,EAAE,IAAI;IACnB,aAAa,EAAE,IAAI,GAAG,IAAI;CAC3B,CAAC,CAAC","sourcesContent":["import type { StorageBody, StorageOperationOptions } from '../storage.types.js';\n\nimport type { StorageWorkspaceCursorConfiguration } from './storage-workspace.cursor.js';\n\nexport const STORAGE_WORKSPACE_PERMISSIONS = [\n  'list',\n  'read',\n  'search',\n  'create',\n  'replace',\n  'copy',\n  'move',\n  'delete',\n] as const;\n\nexport type StorageWorkspacePermission =\n  (typeof STORAGE_WORKSPACE_PERMISSIONS)[number];\n\nexport interface StorageWorkspaceLimits {\n  /** Maximum UTF-8 byte length of an opaque continuation cursor. */\n  maxCursorBytes: number;\n  /** Maximum UTF-8 byte length of a workspace-relative path. */\n  maxPathBytes: number;\n  /** Maximum bytes returned by a buffered text read. */\n  maxReadBytes: number;\n  /** Maximum bytes accepted by one write. */\n  maxWriteBytes: number;\n  /** Maximum entries returned by one list page. */\n  maxPageSize: number;\n  /** Maximum entries returned by one search page. */\n  maxSearchResults: number;\n  /** Maximum objects inspected by one search query across all pages. */\n  maxSearchScan: number;\n  /**\n   * Authorization ceiling for an opaque continuation cursor. It does not\n   * extend the lifetime or availability of an embedded provider cursor.\n   */\n  cursorTtlMs: number;\n}\n\nexport const DEFAULT_STORAGE_WORKSPACE_LIMITS: Readonly<StorageWorkspaceLimits> =\n  Object.freeze({\n    cursorTtlMs: 5 * 60 * 1000,\n    maxCursorBytes: 4_096,\n    maxPageSize: 100,\n    maxPathBytes: 1024,\n    maxReadBytes: 1024 * 1024,\n    maxSearchResults: 100,\n    maxSearchScan: 1000,\n    maxWriteBytes: 1024 * 1024,\n  });\n\nexport interface StorageWorkspaceFile {\n  kind: 'file';\n  path: string;\n  name: string;\n  size: number;\n  contentType: string;\n  etag?: string;\n  lastModified?: Date;\n}\n\nexport interface StorageWorkspaceDirectory {\n  kind: 'directory';\n  path: string;\n  name: string;\n}\n\nexport type StorageWorkspaceEntry =\n  StorageWorkspaceFile | StorageWorkspaceDirectory;\n\nexport interface StorageWorkspaceTextFile extends StorageWorkspaceFile {\n  text: string;\n}\n\nexport interface StorageWorkspacePage {\n  entries: StorageWorkspaceEntry[];\n  cursor?: string;\n}\n\nexport interface StorageWorkspaceMountOptions {\n  permissions?: Iterable<StorageWorkspacePermission>;\n  limits?: Partial<StorageWorkspaceLimits>;\n}\n\nexport interface MountStorageWorkspaceOptions extends StorageWorkspaceMountOptions {\n  /** Trusted backend namespace. It is never exposed through the workspace. */\n  prefix: string;\n  /** Stable server-owned cursor configuration shared across serving replicas. */\n  cursor?: StorageWorkspaceCursorConfiguration;\n}\n\nexport interface StorageWorkspaceReadOptions extends StorageOperationOptions {\n  maxBytes?: number;\n}\n\nexport interface StorageWorkspaceListOptions extends StorageOperationOptions {\n  directory?: string | undefined;\n  recursive?: boolean | undefined;\n  limit?: number | undefined;\n  cursor?: string | undefined;\n}\n\nexport type StorageWorkspaceSearchMatch = 'glob' | 'substring' | 'exact';\n\nexport interface StorageWorkspaceSearchOptions extends StorageOperationOptions {\n  directory?: string | undefined;\n  match?: StorageWorkspaceSearchMatch | undefined;\n  caseInsensitive?: boolean | undefined;\n  limit?: number | undefined;\n  cursor?: string | undefined;\n}\n\ninterface StorageWorkspaceWriteCommon extends StorageOperationOptions {\n  contentType?: string;\n  metadata?: Record<string, string>;\n}\n\nexport type StorageWorkspaceWriteOptions = StorageWorkspaceWriteCommon &\n  (\n    | { mode: 'create' }\n    | {\n        mode: 'replace';\n        etag: string;\n      }\n  );\n\nexport interface StorageWorkspaceMutationOptions extends StorageOperationOptions {\n  etag: string;\n}\n\nexport type StorageWorkspaceBody = Extract<StorageBody, string | Uint8Array>;\n\nexport interface StorageWorkspace {\n  readonly permissions: ReadonlySet<StorageWorkspacePermission>;\n  readonly limits: Readonly<StorageWorkspaceLimits>;\n  allows(permission: StorageWorkspacePermission): boolean;\n  stat(\n    path: string,\n    options?: StorageOperationOptions,\n  ): Promise<StorageWorkspaceFile>;\n  readText(\n    path: string,\n    options?: StorageWorkspaceReadOptions,\n  ): Promise<StorageWorkspaceTextFile>;\n  list(options?: StorageWorkspaceListOptions): Promise<StorageWorkspacePage>;\n  search(\n    query: string,\n    options?: StorageWorkspaceSearchOptions,\n  ): Promise<StorageWorkspacePage>;\n  writeFile(\n    path: string,\n    body: StorageWorkspaceBody,\n    options: StorageWorkspaceWriteOptions,\n  ): Promise<StorageWorkspaceFile>;\n  copyFile(\n    source: string,\n    destination: string,\n    options: StorageWorkspaceMutationOptions,\n  ): Promise<StorageWorkspaceFile>;\n  moveFile(\n    source: string,\n    destination: string,\n    options: StorageWorkspaceMutationOptions,\n  ): Promise<StorageWorkspaceFile>;\n  deleteFile(\n    path: string,\n    options: StorageWorkspaceMutationOptions,\n  ): Promise<void>;\n  mount(\n    directory: string,\n    options?: StorageWorkspaceMountOptions,\n  ): StorageWorkspace;\n}\n"]}
+{"version":3,"file":"storage-workspace.types.js","sourceRoot":"","sources":["../../src/workspace/storage-workspace.types.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,MAAM;IACN,MAAM;IACN,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,SAAS;IACT,MAAM;IACN,MAAM;IACN,QAAQ;CACA,CAAC;AA2BX,MAAM,CAAC,MAAM,gCAAgC,GAC3C,MAAM,CAAC,MAAM,CAAC;IACZ,WAAW,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI;IAC1B,cAAc,EAAE,KAAK;IACrB,WAAW,EAAE,GAAG;IAChB,YAAY,EAAE,IAAI;IAClB,YAAY,EAAE,IAAI,GAAG,IAAI;IACzB,gBAAgB,EAAE,GAAG;IACrB,aAAa,EAAE,IAAI;IACnB,aAAa,EAAE,IAAI,GAAG,IAAI;CAC3B,CAAC,CAAC","sourcesContent":["import type { StorageBody, StorageOperationOptions } from '../storage.types.js';\n\nimport type { StorageWorkspaceCursorConfiguration } from './storage-workspace.cursor.js';\n\nexport const STORAGE_WORKSPACE_PERMISSIONS = [\n  'list',\n  'read',\n  'search',\n  'write',\n  'create',\n  'replace',\n  'copy',\n  'move',\n  'delete',\n] as const;\n\nexport type StorageWorkspacePermission =\n  (typeof STORAGE_WORKSPACE_PERMISSIONS)[number];\n\nexport interface StorageWorkspaceLimits {\n  /** Maximum UTF-8 byte length of an opaque continuation cursor. */\n  maxCursorBytes: number;\n  /** Maximum UTF-8 byte length of a workspace-relative path. */\n  maxPathBytes: number;\n  /** Maximum bytes returned by one buffered text or binary read. */\n  maxReadBytes: number;\n  /** Maximum bytes accepted by one write. */\n  maxWriteBytes: number;\n  /** Maximum entries returned by one list page. */\n  maxPageSize: number;\n  /** Maximum entries returned by one search page. */\n  maxSearchResults: number;\n  /** Maximum objects inspected by one search query across all pages. */\n  maxSearchScan: number;\n  /**\n   * Authorization ceiling for an opaque continuation cursor. It does not\n   * extend the lifetime or availability of an embedded provider cursor.\n   */\n  cursorTtlMs: number;\n}\n\nexport const DEFAULT_STORAGE_WORKSPACE_LIMITS: Readonly<StorageWorkspaceLimits> =\n  Object.freeze({\n    cursorTtlMs: 5 * 60 * 1000,\n    maxCursorBytes: 4_096,\n    maxPageSize: 100,\n    maxPathBytes: 1024,\n    maxReadBytes: 1024 * 1024,\n    maxSearchResults: 100,\n    maxSearchScan: 1000,\n    maxWriteBytes: 1024 * 1024,\n  });\n\nexport interface StorageWorkspaceFile {\n  kind: 'file';\n  path: string;\n  name: string;\n  size: number;\n  contentType: string;\n  etag?: string;\n  lastModified?: Date;\n}\n\nexport interface StorageWorkspaceDirectory {\n  kind: 'directory';\n  path: string;\n  name: string;\n}\n\nexport type StorageWorkspaceEntry =\n  StorageWorkspaceFile | StorageWorkspaceDirectory;\n\nexport interface StorageWorkspaceTextFile extends StorageWorkspaceFile {\n  text: string;\n}\n\nexport interface StorageWorkspaceByteFile extends StorageWorkspaceFile {\n  bytes: Uint8Array;\n}\n\nexport interface StorageWorkspacePage {\n  entries: StorageWorkspaceEntry[];\n  cursor?: string;\n}\n\nexport interface StorageWorkspaceMountOptions {\n  permissions?: Iterable<StorageWorkspacePermission>;\n  limits?: Partial<StorageWorkspaceLimits>;\n}\n\nexport interface MountStorageWorkspaceOptions extends StorageWorkspaceMountOptions {\n  /** Trusted backend namespace. It is never exposed through the workspace. */\n  prefix: string;\n  /** Stable server-owned cursor configuration shared across serving replicas. */\n  cursor?: StorageWorkspaceCursorConfiguration;\n}\n\nexport interface StorageWorkspaceReadOptions extends StorageOperationOptions {\n  maxBytes?: number;\n}\n\nexport interface StorageWorkspaceListOptions extends StorageOperationOptions {\n  directory?: string | undefined;\n  recursive?: boolean | undefined;\n  limit?: number | undefined;\n  cursor?: string | undefined;\n}\n\nexport type StorageWorkspaceSearchMatch = 'glob' | 'substring' | 'exact';\n\nexport interface StorageWorkspaceSearchOptions extends StorageOperationOptions {\n  directory?: string | undefined;\n  match?: StorageWorkspaceSearchMatch | undefined;\n  caseInsensitive?: boolean | undefined;\n  limit?: number | undefined;\n  cursor?: string | undefined;\n}\n\ninterface StorageWorkspaceWriteCommon extends StorageOperationOptions {\n  contentType?: string;\n  metadata?: Record<string, string>;\n}\n\nexport type StorageWorkspaceWriteOptions = StorageWorkspaceWriteCommon &\n  (\n    | { mode: 'create' }\n    /** Unconditionally writes the destination through the ordinary Files path. */\n    | { mode: 'overwrite' }\n    | {\n        mode: 'replace';\n        etag: string;\n      }\n  );\n\nexport interface StorageWorkspaceMutationOptions extends StorageOperationOptions {\n  etag: string;\n}\n\nexport interface StorageWorkspaceOverwriteOptions extends StorageOperationOptions {\n  /** Unconditionally overwrites the destination through the ordinary Files path. */\n  mode: 'overwrite';\n}\n\nexport interface StorageWorkspaceUnconditionalDeleteOptions extends StorageOperationOptions {\n  /** Deletes the current destination without an ETag precondition. */\n  mode: 'unconditional';\n}\n\nexport type StorageWorkspaceCopyOptions =\n  StorageWorkspaceMutationOptions | StorageWorkspaceOverwriteOptions;\n\nexport type StorageWorkspaceDeleteOptions =\n  StorageWorkspaceMutationOptions | StorageWorkspaceUnconditionalDeleteOptions;\n\nexport type StorageWorkspaceBody = Extract<StorageBody, string | Uint8Array>;\n\nexport interface StorageWorkspace {\n  readonly permissions: ReadonlySet<StorageWorkspacePermission>;\n  readonly limits: Readonly<StorageWorkspaceLimits>;\n  allows(permission: StorageWorkspacePermission): boolean;\n  stat(\n    path: string,\n    options?: StorageOperationOptions,\n  ): Promise<StorageWorkspaceFile>;\n  readText(\n    path: string,\n    options?: StorageWorkspaceReadOptions,\n  ): Promise<StorageWorkspaceTextFile>;\n  readBytes(\n    path: string,\n    options?: StorageWorkspaceReadOptions,\n  ): Promise<StorageWorkspaceByteFile>;\n  list(options?: StorageWorkspaceListOptions): Promise<StorageWorkspacePage>;\n  search(\n    query: string,\n    options?: StorageWorkspaceSearchOptions,\n  ): Promise<StorageWorkspacePage>;\n  writeFile(\n    path: string,\n    body: StorageWorkspaceBody,\n    options: StorageWorkspaceWriteOptions,\n  ): Promise<StorageWorkspaceFile>;\n  copyFile(\n    source: string,\n    destination: string,\n    options: StorageWorkspaceCopyOptions,\n  ): Promise<StorageWorkspaceFile>;\n  moveFile(\n    source: string,\n    destination: string,\n    options: StorageWorkspaceMutationOptions,\n  ): Promise<StorageWorkspaceFile>;\n  deleteFile(\n    path: string,\n    options: StorageWorkspaceDeleteOptions,\n  ): Promise<void>;\n  mount(\n    directory: string,\n    options?: StorageWorkspaceMountOptions,\n  ): StorageWorkspace;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestm/storage",
-  "version": "0.1.0-alpha.8",
+  "version": "0.1.0-alpha.9",
   "description": "Framework-neutral storage clients, capability-scoped agent workspaces, NestJS 12 integration, and guarded HTTP access.",
   "license": "MIT",
   "author": "Kauan Guesser",