@hamak/filesystem-server-spi 0.4.8

package/dist/es2015/index.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * @hamak/filesystem-server-spi
+ *
+ * Backend filesystem server SPI - Extension points
+ */
+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 });
+// Export SPI interfaces
+__exportStar(require("./spi/IFileSystemMiddleware"), exports);
+__exportStar(require("./spi/IPathResolver"), exports);
+__exportStar(require("./spi/IAccessControl"), exports);
+// Export SPI tokens
+__exportStar(require("./spi/tokens"), exports);

package/dist/es2015/spi/IAccessControl.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Access Control Extension Point
+ *
+ * Allows custom access control policies for filesystem operations
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es2015/spi/IFileSystemMiddleware.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * FileSystem Middleware Extension Point
+ *
+ * Allows plugins to inject custom middleware into the filesystem request pipeline
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es2015/spi/IPathResolver.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Path Resolver Extension Point
+ *
+ * Allows custom path resolution strategies (e.g., virtual paths, symlinks, etc.)
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es2015/spi/tokens.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * SPI Dependency Injection Tokens
+ *
+ * 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;
+/**
+ * Token for custom FileSystem middleware
+ * Can be registered multiple times for multiple middleware instances
+ */
+exports.FILESYSTEM_MIDDLEWARE_TOKEN = Symbol('FileSystemMiddleware');
+/**
+ * Token for custom path resolver
+ * Only one resolver should be registered (replaces default)
+ */
+exports.PATH_RESOLVER_TOKEN = Symbol('PathResolver');
+/**
+ * Token for custom access control
+ * Only one access control should be registered (replaces default)
+ */
+exports.ACCESS_CONTROL_TOKEN = Symbol('AccessControl');

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @hamak/filesystem-server-spi
+ *
+ * Backend filesystem server SPI - Extension points
+ */
+export * from './spi/IFileSystemMiddleware';
+export * from './spi/IPathResolver';
+export * from './spi/IAccessControl';
+export * from './spi/tokens';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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"}

package/dist/index.js

@@ -0,0 +1,11 @@
+/**
+ * @hamak/filesystem-server-spi
+ *
+ * Backend filesystem server SPI - Extension points
+ */
+// Export SPI interfaces
+export * from './spi/IFileSystemMiddleware';
+export * from './spi/IPathResolver';
+export * from './spi/IAccessControl';
+// Export SPI tokens
+export * from './spi/tokens';

package/dist/spi/IAccessControl.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Access Control Extension Point
+ *
+ * Allows custom access control policies for filesystem operations
+ */
+import { Request } from 'express';
+/**
+ * Access control context
+ */
+export interface AccessContext {
+    /**
+     * Express request object
+     */
+    request: Request;
+    /**
+     * Workspace ID
+     */
+    workspace: string;
+    /**
+     * File path segments
+     */
+    path: string[];
+    /**
+     * User information (if available from authentication middleware)
+     */
+    user?: {
+        id: string;
+        name?: string;
+        roles?: string[];
+        [key: string]: any;
+    };
+}
+/**
+ * Custom access control interface
+ */
+export interface IAccessControl {
+    /**
+     * Check if the current user can read the specified file/directory
+     *
+     * @param context - Access control context
+     * @returns true if read access is allowed
+     */
+    canRead(context: AccessContext): Promise<boolean>;
+    /**
+     * Check if the current user can write to the specified file/directory
+     *
+     * @param context - Access control context
+     * @returns true if write access is allowed
+     */
+    canWrite(context: AccessContext): Promise<boolean>;
+    /**
+     * Check if the current user can delete the specified file/directory
+     *
+     * @param context - Access control context
+     * @returns true if delete access is allowed
+     */
+    canDelete(context: AccessContext): Promise<boolean>;
+    /**
+     * Check if the current user can list the contents of a directory
+     *
+     * @param context - Access control context
+     * @returns true if list access is allowed
+     */
+    canList(context: AccessContext): Promise<boolean>;
+}
+//# sourceMappingURL=IAccessControl.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IAccessControl.d.ts","sourceRoot":"","sources":["../../src/spi/IAccessControl.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE;QACL,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAElD;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnD;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpD;;;;;OAKG;IACH,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACnD"}

package/dist/spi/IAccessControl.js

@@ -0,0 +1,6 @@
+/**
+ * Access Control Extension Point
+ *
+ * Allows custom access control policies for filesystem operations
+ */
+export {};

package/dist/spi/IFileSystemMiddleware.d.ts

@@ -0,0 +1,43 @@
+/**
+ * FileSystem Middleware Extension Point
+ *
+ * Allows plugins to inject custom middleware into the filesystem request pipeline
+ */
+import { Request, Response, NextFunction } from 'express';
+/**
+ * Middleware context passed to handlers
+ */
+export interface MiddlewareContext {
+    /**
+     * Workspace ID from the request
+     */
+    workspace?: string;
+    /**
+     * File path segments from the request
+     */
+    path?: string[];
+    /**
+     * Operation type (list, read, write, delete, mkdir)
+     */
+    operation?: string;
+}
+/**
+ * Custom filesystem middleware interface
+ */
+export interface IFileSystemMiddleware {
+    /**
+     * Priority for middleware execution order
+     * Lower numbers execute first
+     * @default 100
+     */
+    priority: number;
+    /**
+     * Middleware handler function
+     * @param req - Express request
+     * @param res - Express response
+     * @param next - Express next function
+     * @param context - Middleware context with workspace and path info
+     */
+    handle(req: Request, res: Response, next: NextFunction, context?: MiddlewareContext): void | Promise<void>;
+}
+//# sourceMappingURL=IFileSystemMiddleware.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IFileSystemMiddleware.d.ts","sourceRoot":"","sources":["../../src/spi/IFileSystemMiddleware.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,MAAM,CACJ,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,QAAQ,EACb,IAAI,EAAE,YAAY,EAClB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB"}

package/dist/spi/IFileSystemMiddleware.js

@@ -0,0 +1,6 @@
+/**
+ * FileSystem Middleware Extension Point
+ *
+ * Allows plugins to inject custom middleware into the filesystem request pipeline
+ */
+export {};

package/dist/spi/IPathResolver.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Path Resolver Extension Point
+ *
+ * Allows custom path resolution strategies (e.g., virtual paths, symlinks, etc.)
+ */
+/**
+ * Custom path resolver interface
+ */
+export interface IPathResolver {
+    /**
+     * Resolve a workspace-relative path to an absolute filesystem path
+     *
+     * @param workspace - Workspace ID
+     * @param filePath - Path segments relative to workspace
+     * @returns Absolute filesystem path
+     * @throws Error if path is invalid or workspace not found
+     */
+    resolvePath(workspace: string, filePath: string[]): string;
+    /**
+     * Validate that a resolved path is safe and within workspace bounds
+     *
+     * @param resolvedPath - Absolute path to validate
+     * @param workspace - Workspace ID for context
+     * @returns true if path is valid and safe
+     */
+    validatePath(resolvedPath: string, workspace: string): boolean;
+    /**
+     * Normalize path segments (handle '.', '..', etc.)
+     *
+     * @param pathSegments - Raw path segments
+     * @returns Normalized path segments
+     */
+    normalizePath(pathSegments: string[]): string[];
+}
+//# sourceMappingURL=IPathResolver.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IPathResolver.d.ts","sourceRoot":"","sources":["../../src/spi/IPathResolver.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;OAOG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAE3D;;;;;;OAMG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;IAE/D;;;;;OAKG;IACH,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;CACjD"}

package/dist/spi/IPathResolver.js

@@ -0,0 +1,6 @@
+/**
+ * Path Resolver Extension Point
+ *
+ * Allows custom path resolution strategies (e.g., virtual paths, symlinks, etc.)
+ */
+export {};

package/dist/spi/tokens.d.ts

@@ -0,0 +1,21 @@
+/**
+ * SPI Dependency Injection Tokens
+ *
+ * Tokens for registering and resolving extension points
+ */
+/**
+ * Token for custom FileSystem middleware
+ * Can be registered multiple times for multiple middleware instances
+ */
+export declare const FILESYSTEM_MIDDLEWARE_TOKEN: unique symbol;
+/**
+ * Token for custom path resolver
+ * Only one resolver should be registered (replaces default)
+ */
+export declare const PATH_RESOLVER_TOKEN: unique symbol;
+/**
+ * Token for custom access control
+ * Only one access control should be registered (replaces default)
+ */
+export declare const ACCESS_CONTROL_TOKEN: unique symbol;
+//# sourceMappingURL=tokens.d.ts.map

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

@@ -0,0 +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"}

package/dist/spi/tokens.js

@@ -0,0 +1,20 @@
+/**
+ * SPI Dependency Injection Tokens
+ *
+ * Tokens for registering and resolving extension points
+ */
+/**
+ * Token for custom FileSystem middleware
+ * Can be registered multiple times for multiple middleware instances
+ */
+export const FILESYSTEM_MIDDLEWARE_TOKEN = Symbol('FileSystemMiddleware');
+/**
+ * Token for custom path resolver
+ * Only one resolver should be registered (replaces default)
+ */
+export const PATH_RESOLVER_TOKEN = Symbol('PathResolver');
+/**
+ * Token for custom access control
+ * Only one access control should be registered (replaces default)
+ */
+export const ACCESS_CONTROL_TOKEN = Symbol('AccessControl');

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@hamak/filesystem-server-spi",
+  "version": "0.4.8",
+  "private": false,
+  "type": "module",
+  "description": "FileSystem Server SPI - Backend filesystem server extension points",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/amah/app-framework.git",
+    "directory": "packages/backend/filesystem-server/filesystem-server-spi"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.es2015.json",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/es2015/index.js",
+      "default": "./dist/index.js"
+    },
+    "./es2015": {
+      "require": "./dist/es2015/index.js",
+      "default": "./dist/es2015/index.js"
+    }
+  },
+  "dependencies": {
+    "@hamak/filesystem-server-api": "0.4.7",
+    "@hamak/shared-utils": "0.4.7"
+  },
+  "peerDependencies": {
+    "express": "^4.18.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.0",
+    "typescript": "~5.4.0",
+    "vitest": "^2.0.0"
+  }
+}