@hamak/filesystem-server-spi 0.4.19 → 0.5.0

package/dist/es2015/index.js

@@ -23,5 +23,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./spi/IFileSystemMiddleware"), exports);
 __exportStar(require("./spi/IPathResolver"), exports);
 __exportStar(require("./spi/IAccessControl"), exports);
+__exportStar(require("./spi/IFileInfoEnricher"), exports);
 // Export SPI tokens
 __exportStar(require("./spi/tokens"), exports);

package/dist/es2015/spi/IFileInfoEnricher.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * File Info Enricher Interface
+ *
+ * SPI for plugins that enrich FileInfo responses with additional data.
+ * Enrichers are called when specific query parameters are present.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es2015/spi/tokens.js

@@ -5,7 +5,7 @@
  * Tokens for registering and resolving extension points
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ACCESS_CONTROL_TOKEN = exports.PATH_RESOLVER_TOKEN = exports.FILESYSTEM_MIDDLEWARE_TOKEN = void 0;
+exports.FILE_INFO_ENRICHER_TOKEN = exports.FILE_INFO_ENRICHER_REGISTRY_TOKEN = exports.ACCESS_CONTROL_TOKEN = exports.PATH_RESOLVER_TOKEN = exports.FILESYSTEM_MIDDLEWARE_TOKEN = void 0;
 /**
  * Token for custom FileSystem middleware
  * Can be registered multiple times for multiple middleware instances
@@ -21,3 +21,13 @@ exports.PATH_RESOLVER_TOKEN = Symbol('PathResolver');
  * Only one access control should be registered (replaces default)
  */
 exports.ACCESS_CONTROL_TOKEN = Symbol('AccessControl');
+/**
+ * Token for FileInfo enricher registry
+ * Used to register enrichers that add extension data to FileInfo responses
+ */
+exports.FILE_INFO_ENRICHER_REGISTRY_TOKEN = Symbol('FileInfoEnricherRegistry');
+/**
+ * Token for individual FileInfo enrichers
+ * Can be registered multiple times for multiple enricher instances
+ */
+exports.FILE_INFO_ENRICHER_TOKEN = Symbol('FileInfoEnricher');

package/dist/index.d.ts

@@ -6,5 +6,6 @@
 export * from './spi/IFileSystemMiddleware';
 export * from './spi/IPathResolver';
 export * from './spi/IAccessControl';
+export * from './spi/IFileInfoEnricher';
 export * from './spi/tokens';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AAGrC,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AAGxC,cAAc,cAAc,CAAC"}

package/dist/index.js

@@ -7,5 +7,6 @@
 export * from './spi/IFileSystemMiddleware';
 export * from './spi/IPathResolver';
 export * from './spi/IAccessControl';
+export * from './spi/IFileInfoEnricher';
 // Export SPI tokens
 export * from './spi/tokens';

package/dist/spi/IFileInfoEnricher.d.ts

@@ -0,0 +1,124 @@
+/**
+ * File Info Enricher Interface
+ *
+ * SPI for plugins that enrich FileInfo responses with additional data.
+ * Enrichers are called when specific query parameters are present.
+ */
+import { FileInfo } from '@hamak/shared-utils';
+import { Request } from 'express';
+/**
+ * Context provided to enrichers during file info enrichment
+ */
+export interface EnricherContext {
+    /**
+     * The workspace identifier
+     */
+    workspace: string;
+    /**
+     * The path segments of the file/directory
+     */
+    pathSegments: string[];
+    /**
+     * The full resolved path on the filesystem
+     */
+    resolvedPath: string;
+    /**
+     * The Express request object (for accessing query params, headers, etc.)
+     */
+    request: Request;
+    /**
+     * The operation type
+     */
+    operation: 'list' | 'read' | 'get' | 'mkdir' | 'write' | 'delete';
+}
+/**
+ * Interface for file info enrichers
+ *
+ * Enrichers add extension data to FileInfo objects based on query parameters.
+ * For example, a git enricher might add git status when `?extensions=git` is present.
+ *
+ * @example
+ * ```typescript
+ * class GitEnricher implements IFileInfoEnricher {
+ *   extensionKey = 'git';
+ *
+ *   shouldEnrich(context: EnricherContext): boolean {
+ *     const extensions = context.request.query.extensions;
+ *     return extensions?.includes('git') ?? false;
+ *   }
+ *
+ *   async enrich(fileInfo: FileInfo, context: EnricherContext): Promise<FileInfo> {
+ *     const gitStatus = await getGitStatus(context.resolvedPath);
+ *     return {
+ *       ...fileInfo,
+ *       extensions: {
+ *         ...fileInfo.extensions,
+ *         [this.extensionKey]: gitStatus
+ *       }
+ *     };
+ *   }
+ * }
+ * ```
+ */
+export interface IFileInfoEnricher {
+    /**
+     * Unique key for this enricher (e.g., 'git', 'permissions')
+     * Used as the key in FileInfo.extensions
+     */
+    readonly extensionKey: string;
+    /**
+     * Priority for enricher execution order (lower = earlier)
+     * Default should be 100.
+     */
+    readonly priority?: number;
+    /**
+     * Determine if this enricher should process the request
+     *
+     * @param context The enricher context
+     * @returns true if this enricher should enrich the response
+     */
+    shouldEnrich(context: EnricherContext): boolean;
+    /**
+     * Enrich a single FileInfo with extension data
+     *
+     * @param fileInfo The FileInfo to enrich
+     * @param context The enricher context
+     * @returns The enriched FileInfo
+     */
+    enrich(fileInfo: FileInfo, context: EnricherContext): Promise<FileInfo>;
+    /**
+     * Enrich multiple FileInfo objects (for list operations)
+     * Default implementation calls enrich() for each item.
+     *
+     * @param fileInfos The FileInfo array to enrich
+     * @param context The enricher context
+     * @returns The enriched FileInfo array
+     */
+    enrichMany?(fileInfos: FileInfo[], context: EnricherContext): Promise<FileInfo[]>;
+}
+/**
+ * Registry for file info enrichers
+ */
+export interface IFileInfoEnricherRegistry {
+    /**
+     * Register an enricher
+     */
+    register(enricher: IFileInfoEnricher): void;
+    /**
+     * Unregister an enricher by its extension key
+     */
+    unregister(extensionKey: string): void;
+    /**
+     * Get all registered enrichers sorted by priority
+     */
+    getEnrichers(): IFileInfoEnricher[];
+    /**
+     * Apply all applicable enrichers to a FileInfo
+     */
+    applyEnrichers(fileInfo: FileInfo, context: EnricherContext): Promise<FileInfo>;
+    /**
+     * Apply all applicable enrichers to multiple FileInfo objects
+     */
+    applyEnrichersMany(fileInfos: FileInfo[], context: EnricherContext): Promise<FileInfo[]>;
+}
+//# sourceMappingURL=IFileInfoEnricher.d.ts.map

package/dist/spi/IFileInfoEnricher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileInfoEnricher.d.ts","sourceRoot":"","sources":["../../src/spi/IFileInfoEnricher.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;CACnE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC;IAEhD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAExE;;;;;;;OAOG;IACH,UAAU,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;CACnF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,YAAY,IAAI,iBAAiB,EAAE,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEhF;;OAEG;IACH,kBAAkB,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;CAC1F"}

package/dist/spi/IFileInfoEnricher.js

@@ -0,0 +1,7 @@
+/**
+ * File Info Enricher Interface
+ *
+ * SPI for plugins that enrich FileInfo responses with additional data.
+ * Enrichers are called when specific query parameters are present.
+ */
+export {};

package/dist/spi/tokens.d.ts

@@ -18,4 +18,14 @@ export declare const PATH_RESOLVER_TOKEN: unique symbol;
  * Only one access control should be registered (replaces default)
  */
 export declare const ACCESS_CONTROL_TOKEN: unique symbol;
+/**
+ * Token for FileInfo enricher registry
+ * Used to register enrichers that add extension data to FileInfo responses
+ */
+export declare const FILE_INFO_ENRICHER_REGISTRY_TOKEN: unique symbol;
+/**
+ * Token for individual FileInfo enrichers
+ * Can be registered multiple times for multiple enricher instances
+ */
+export declare const FILE_INFO_ENRICHER_TOKEN: unique symbol;
 //# sourceMappingURL=tokens.d.ts.map

package/dist/spi/tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/spi/tokens.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,eAAO,MAAM,2BAA2B,eAAiC,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,mBAAmB,eAAyB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,eAA0B,CAAC"}
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/spi/tokens.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,eAAO,MAAM,2BAA2B,eAAiC,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,mBAAmB,eAAyB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,eAA0B,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,iCAAiC,eAAqC,CAAC;AAEpF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,eAA6B,CAAC"}

package/dist/spi/tokens.js

@@ -18,3 +18,13 @@ export const PATH_RESOLVER_TOKEN = Symbol('PathResolver');
  * Only one access control should be registered (replaces default)
  */
 export const ACCESS_CONTROL_TOKEN = Symbol('AccessControl');
+/**
+ * Token for FileInfo enricher registry
+ * Used to register enrichers that add extension data to FileInfo responses
+ */
+export const FILE_INFO_ENRICHER_REGISTRY_TOKEN = Symbol('FileInfoEnricherRegistry');
+/**
+ * Token for individual FileInfo enrichers
+ * Can be registered multiple times for multiple enricher instances
+ */
+export const FILE_INFO_ENRICHER_TOKEN = Symbol('FileInfoEnricher');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hamak/filesystem-server-spi",
-  "version": "0.4.19",
+  "version": "0.5.0",
   "private": false,
   "type": "module",
   "description": "FileSystem Server SPI - Backend filesystem server extension points",