@hamak/filesystem-server-api 0.4.8

package/dist/api/IFileSystemService.d.ts

@@ -0,0 +1,26 @@
+/**
+ * FileSystem Service Interface
+ *
+ * Main service interface for filesystem server operations
+ */
+import { Router } from 'express';
+import { IWorkspaceManager } from './IWorkspaceManager';
+export interface IFileSystemService {
+    /**
+     * Get the workspace manager instance
+     */
+    getWorkspaceManager(): IWorkspaceManager;
+    /**
+     * Get the Express router for mounting in application
+     */
+    getRouter(): Router;
+    /**
+     * Initialize the service
+     */
+    initialize(): Promise<void>;
+    /**
+     * Cleanup and shutdown
+     */
+    shutdown(): Promise<void>;
+}
+//# sourceMappingURL=IFileSystemService.d.ts.map

package/dist/api/IFileSystemService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileSystemService.d.ts","sourceRoot":"","sources":["../../src/api/IFileSystemService.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,mBAAmB,IAAI,iBAAiB,CAAC;IAEzC;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B"}

package/dist/api/IFileSystemService.js

@@ -0,0 +1,6 @@
+/**
+ * FileSystem Service Interface
+ *
+ * Main service interface for filesystem server operations
+ */
+export {};

package/dist/api/IWorkspaceManager.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Workspace Manager Interface
+ *
+ * Provides filesystem operations for a workspace (directory-based storage)
+ */
+import { FileInfo } from '@hamak/shared-utils';
+export interface IWorkspaceManager {
+    /**
+     * List files and directories at the given path
+     * @param workspace - Workspace ID
+     * @param path - Path segments relative to workspace root
+     * @returns Array of FileInfo objects
+     */
+    listFiles(workspace: string, path: string[]): Promise<FileInfo[]>;
+    /**
+     * Read file metadata and content
+     * @param workspace - Workspace ID
+     * @param path - Path segments to the file
+     * @returns FileInfo with content
+     */
+    readFile(workspace: string, path: string[]): Promise<FileInfo>;
+    /**
+     * Write content to a file
+     * @param workspace - Workspace ID
+     * @param path - Path segments to the file
+     * @param content - File content as string
+     * @returns FileInfo of the written file
+     */
+    writeFile(workspace: string, path: string[], content: string): Promise<FileInfo>;
+    /**
+     * Delete a file or directory
+     * @param workspace - Workspace ID
+     * @param path - Path segments to the file/directory
+     * @returns FileInfo of the deleted item
+     */
+    deleteFile(workspace: string, path: string[]): Promise<FileInfo>;
+    /**
+     * Create a directory
+     * @param workspace - Workspace ID
+     * @param path - Path segments to the new directory
+     * @returns FileInfo of the created directory
+     */
+    createDirectory(workspace: string, path: string[]): Promise<FileInfo>;
+    /**
+     * Get file metadata without content
+     * @param workspace - Workspace ID
+     * @param path - Path segments to the file
+     * @returns FileInfo without content
+     */
+    getFile(workspace: string, path: string[]): Promise<FileInfo>;
+}
+//# sourceMappingURL=IWorkspaceManager.d.ts.map

package/dist/api/IWorkspaceManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IWorkspaceManager.d.ts","sourceRoot":"","sources":["../../src/api/IWorkspaceManager.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAElE;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE/D;;;;;;OAMG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEjF;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEtE;;;;;OAKG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC/D"}

package/dist/api/IWorkspaceManager.js

@@ -0,0 +1,6 @@
+/**
+ * Workspace Manager Interface
+ *
+ * Provides filesystem operations for a workspace (directory-based storage)
+ */
+export {};

package/dist/api/tokens.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Dependency Injection Tokens
+ *
+ * Tokens for registering and resolving services in the DI container
+ */
+/**
+ * Token for FileSystemServerConfig
+ */
+export declare const FILESYSTEM_SERVER_CONFIG_TOKEN: unique symbol;
+/**
+ * Token for WorkspaceManager service
+ */
+export declare const WORKSPACE_MANAGER_TOKEN: unique symbol;
+/**
+ * Token for FileRouter (Express router)
+ */
+export declare const FILE_ROUTER_TOKEN: unique symbol;
+/**
+ * Token for main FileSystemService
+ */
+export declare const FILESYSTEM_SERVICE_TOKEN: unique symbol;
+//# sourceMappingURL=tokens.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/api/tokens.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,8BAA8B,eAAmC,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,uBAAuB,eAA6B,CAAC;AAElE;;GAEG;AACH,eAAO,MAAM,iBAAiB,eAAuB,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,wBAAwB,eAA8B,CAAC"}

package/dist/api/tokens.js

@@ -0,0 +1,21 @@
+/**
+ * Dependency Injection Tokens
+ *
+ * Tokens for registering and resolving services in the DI container
+ */
+/**
+ * Token for FileSystemServerConfig
+ */
+export const FILESYSTEM_SERVER_CONFIG_TOKEN = Symbol('FileSystemServerConfig');
+/**
+ * Token for WorkspaceManager service
+ */
+export const WORKSPACE_MANAGER_TOKEN = Symbol('WorkspaceManager');
+/**
+ * Token for FileRouter (Express router)
+ */
+export const FILE_ROUTER_TOKEN = Symbol('FileRouter');
+/**
+ * Token for main FileSystemService
+ */
+export const FILESYSTEM_SERVICE_TOKEN = Symbol('FileSystemService');

package/dist/es2015/api/IFileSystemService.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * FileSystem Service Interface
+ *
+ * Main service interface for filesystem server operations
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es2015/api/IWorkspaceManager.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Workspace Manager Interface
+ *
+ * Provides filesystem operations for a workspace (directory-based storage)
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es2015/api/tokens.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * Dependency Injection Tokens
+ *
+ * Tokens for registering and resolving services in the DI container
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FILESYSTEM_SERVICE_TOKEN = exports.FILE_ROUTER_TOKEN = exports.WORKSPACE_MANAGER_TOKEN = exports.FILESYSTEM_SERVER_CONFIG_TOKEN = void 0;
+/**
+ * Token for FileSystemServerConfig
+ */
+exports.FILESYSTEM_SERVER_CONFIG_TOKEN = Symbol('FileSystemServerConfig');
+/**
+ * Token for WorkspaceManager service
+ */
+exports.WORKSPACE_MANAGER_TOKEN = Symbol('WorkspaceManager');
+/**
+ * Token for FileRouter (Express router)
+ */
+exports.FILE_ROUTER_TOKEN = Symbol('FileRouter');
+/**
+ * Token for main FileSystemService
+ */
+exports.FILESYSTEM_SERVICE_TOKEN = Symbol('FileSystemService');

package/dist/es2015/index.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * @hamak/filesystem-server-api
+ *
+ * Backend filesystem server API - Public interfaces and types
+ */
+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 API interfaces
+__exportStar(require("./api/IWorkspaceManager"), exports);
+__exportStar(require("./api/IFileSystemService"), exports);
+__exportStar(require("./api/tokens"), exports);
+// Export types
+__exportStar(require("./types"), exports);

package/dist/es2015/types/index.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Types barrel export
+ */
+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 });
+__exportStar(require("./workspace-config"), exports);
+__exportStar(require("./server-config"), exports);

package/dist/es2015/types/server-config.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * FileSystem Server Configuration Types
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_FILESYSTEM_SERVER_CONFIG = void 0;
+/**
+ * Default configuration values
+ */
+exports.DEFAULT_FILESYSTEM_SERVER_CONFIG = {
+    enableCors: true,
+    enableFileUpload: false,
+    maxFileSize: 10 * 1024 * 1024, // 10MB
+    mountPath: '/api/workspaces',
+};

package/dist/es2015/types/workspace-config.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Workspace Configuration Types
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @hamak/filesystem-server-api
+ *
+ * Backend filesystem server API - Public interfaces and types
+ */
+export * from './api/IWorkspaceManager';
+export * from './api/IFileSystemService';
+export * from './api/tokens';
+export * from './types';
+//# 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,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAG7B,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,11 @@
+/**
+ * @hamak/filesystem-server-api
+ *
+ * Backend filesystem server API - Public interfaces and types
+ */
+// Export API interfaces
+export * from './api/IWorkspaceManager';
+export * from './api/IFileSystemService';
+export * from './api/tokens';
+// Export types
+export * from './types';

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Types barrel export
+ */
+export * from './workspace-config';
+export * from './server-config';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

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

package/dist/types/index.js

@@ -0,0 +1,5 @@
+/**
+ * Types barrel export
+ */
+export * from './workspace-config';
+export * from './server-config';

package/dist/types/server-config.d.ts

@@ -0,0 +1,45 @@
+/**
+ * FileSystem Server Configuration Types
+ */
+import { WorkspacesMap } from './workspace-config';
+/**
+ * Configuration for the FileSystem Server
+ */
+export interface FileSystemServerConfig {
+    /**
+     * Base directory for all workspaces
+     * All workspace paths are resolved relative to this directory
+     */
+    baseDirectory: string;
+    /**
+     * Map of workspace IDs to their relative directory paths
+     * Example: { "0": "workspace1-directory", "1": "workspace2-directory" }
+     */
+    workspaces: WorkspacesMap;
+    /**
+     * Enable CORS for cross-origin requests
+     * @default true
+     */
+    enableCors?: boolean;
+    /**
+     * Enable file upload functionality
+     * @default false
+     */
+    enableFileUpload?: boolean;
+    /**
+     * Maximum file size for uploads (in bytes)
+     * Only applies if enableFileUpload is true
+     * @default 10MB
+     */
+    maxFileSize?: number;
+    /**
+     * Mount path for the filesystem API routes
+     * @default "/api/workspaces"
+     */
+    mountPath?: string;
+}
+/**
+ * Default configuration values
+ */
+export declare const DEFAULT_FILESYSTEM_SERVER_CONFIG: Partial<FileSystemServerConfig>;
+//# sourceMappingURL=server-config.d.ts.map

package/dist/types/server-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-config.d.ts","sourceRoot":"","sources":["../../src/types/server-config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,UAAU,EAAE,aAAa,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,gCAAgC,EAAE,OAAO,CAAC,sBAAsB,CAK5E,CAAC"}

package/dist/types/server-config.js

@@ -0,0 +1,12 @@
+/**
+ * FileSystem Server Configuration Types
+ */
+/**
+ * Default configuration values
+ */
+export const DEFAULT_FILESYSTEM_SERVER_CONFIG = {
+    enableCors: true,
+    enableFileUpload: false,
+    maxFileSize: 10 * 1024 * 1024, // 10MB
+    mountPath: '/api/workspaces',
+};

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

@@ -0,0 +1,34 @@
+/**
+ * Workspace Configuration Types
+ */
+/**
+ * Configuration for a single workspace
+ */
+export interface WorkspaceConfig {
+    /**
+     * Unique identifier for the workspace
+     */
+    id: string;
+    /**
+     * Relative path from base directory
+     */
+    relativePath: string;
+    /**
+     * Display name (optional)
+     */
+    name?: string;
+    /**
+     * Description (optional)
+     */
+    description?: string;
+    /**
+     * Whether this workspace is read-only
+     */
+    readOnly?: boolean;
+}
+/**
+ * Map of workspace IDs to their relative paths
+ * Example: { "0": "workspace1-directory", "1": "workspace2-directory" }
+ */
+export type WorkspacesMap = Record<string, string>;
+//# sourceMappingURL=workspace-config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-config.d.ts","sourceRoot":"","sources":["../../src/types/workspace-config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC"}

package/dist/types/workspace-config.js

@@ -0,0 +1,4 @@
+/**
+ * Workspace Configuration Types
+ */
+export {};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@hamak/filesystem-server-api",
+  "version": "0.4.8",
+  "private": false,
+  "type": "module",
+  "description": "FileSystem Server API - Backend filesystem server interfaces and contracts",
+  "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-api"
+  },
+  "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/shared-utils": "0.4.7"
+  },
+  "peerDependencies": {
+    "express": "^4.18.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.0",
+    "typescript": "~5.4.0",
+    "vitest": "^2.0.0"
+  }
+}