@hamak/ui-remote-fs 0.5.1

package/dist/spi/providers/i-workspace-client.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Workspace Client Interface
+ *
+ * Abstraction for remote filesystem communication.
+ * Implementations can use HTTP, WebSocket, or any other protocol.
+ */
+import { FileInfo } from '@hamak/shared-utils';
+/**
+ * Request options for workspace client operations.
+ * Allows extensions to add query parameters to requests.
+ */
+export interface RequestOptions {
+    /**
+     * Query parameters to append to the request URL.
+     * Extensions can use this to request additional data (e.g., git info).
+     *
+     * @example
+     * ```typescript
+     * { extensions: ['git'], gitBranch: 'main' }
+     * ```
+     */
+    queryParams?: Record<string, string | string[] | boolean | number | undefined>;
+}
+/**
+ * Interface for workspace client implementations
+ *
+ * This interface abstracts the communication layer for remote filesystem operations.
+ * Different implementations can use different protocols (HTTP REST, WebSocket, gRPC, etc.)
+ * or even mock implementations for testing.
+ *
+ * @example
+ * ```typescript
+ * // HTTP implementation
+ * class HttpWorkspaceClient implements IWorkspaceClient {
+ *   constructor(private baseUrl: string, private workspaceId: string) {}
+ *   // ... implement methods using axios or fetch
+ * }
+ *
+ * // Mock implementation for testing
+ * class MockWorkspaceClient implements IWorkspaceClient {
+ *   // ... implement methods with in-memory storage
+ * }
+ * ```
+ */
+export interface IWorkspaceClient {
+    /**
+     * List files and directories at the specified path
+     *
+     * @param path - Array of path segments (e.g., ['folder', 'subfolder'])
+     * @param options - Optional request options (query params, etc.)
+     * @returns Promise resolving to array of FileInfo objects
+     * @throws Error if the operation fails
+     */
+    listFiles(path: string[], options?: RequestOptions): Promise<FileInfo[]>;
+    /**
+     * Create a directory at the specified path
+     *
+     * @param path - Array of path segments for the new directory
+     * @param options - Optional request options (query params, etc.)
+     * @returns Promise resolving to FileInfo of the created directory
+     * @throws Error if the directory already exists or operation fails
+     */
+    createDirectory(path: string[], options?: RequestOptions): Promise<FileInfo>;
+    /**
+     * Read a file's metadata and content
+     *
+     * @param path - Array of path segments to the file
+     * @param options - Optional request options (query params, etc.)
+     * @returns Promise resolving to FileInfo with content populated
+     * @throws Error if the file doesn't exist or operation fails
+     */
+    readFile(path: string[], options?: RequestOptions): Promise<FileInfo>;
+    /**
+     * Write or update a file's content (uses PUT method)
+     *
+     * @param path - Array of path segments to the file
+     * @param content - Content to write (will be JSON.stringify'd if not a string)
+     * @param options - Optional request options (query params, etc.)
+     * @returns Promise resolving to FileInfo of the written file
+     * @throws Error if the operation fails
+     */
+    putFile(path: string[], content: any, options?: RequestOptions): Promise<FileInfo>;
+    /**
+     * Delete a file or directory
+     *
+     * @param path - Array of path segments to delete
+     * @param options - Optional request options (query params, etc.)
+     * @returns Promise resolving to FileInfo of the deleted item
+     * @throws Error if the item doesn't exist or operation fails
+     */
+    deleteFile(path: string[], options?: RequestOptions): Promise<FileInfo>;
+}
+/**
+ * Factory function type for creating workspace clients
+ */
+export type WorkspaceClientFactory = (workspaceId: string, config?: any) => IWorkspaceClient;
+//# sourceMappingURL=i-workspace-client.d.ts.map

package/dist/spi/providers/i-workspace-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-workspace-client.d.ts","sourceRoot":"","sources":["../../../src/spi/providers/i-workspace-client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC,CAAC;CAChF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;OAOG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEzE;;;;;;;OAOG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE7E;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEtE;;;;;;;;OAQG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEnF;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACzE;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,KAAK,gBAAgB,CAAC"}

package/dist/spi/providers/i-workspace-client.js

@@ -0,0 +1,7 @@
+/**
+ * Workspace Client Interface
+ *
+ * Abstraction for remote filesystem communication.
+ * Implementations can use HTTP, WebSocket, or any other protocol.
+ */
+export {};

package/dist/spi/providers/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Remote FS Provider Interfaces
+ */
+export * from './i-workspace-client';
+export * from './i-remote-fs-provider';
+export * from './i-path-translator';
+//# sourceMappingURL=index.d.ts.map

package/dist/spi/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/spi/providers/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC"}

package/dist/spi/providers/index.js

@@ -0,0 +1,6 @@
+/**
+ * Remote FS Provider Interfaces
+ */
+export * from './i-workspace-client';
+export * from './i-remote-fs-provider';
+export * from './i-path-translator';

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@hamak/ui-remote-fs",
+  "version": "0.5.1",
+  "private": false,
+  "type": "module",
+  "description": "Remote filesystem synchronization for microkernel-based applications",
+  "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/ui-remote-fs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.lib.json",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./api": {
+      "types": "./dist/api/index.d.ts",
+      "import": "./dist/api/index.js",
+      "default": "./dist/api/index.js"
+    },
+    "./spi": {
+      "types": "./dist/spi/index.d.ts",
+      "import": "./dist/spi/index.js",
+      "default": "./dist/spi/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "api": [
+        "./dist/api/index.d.ts"
+      ],
+      "spi": [
+        "./dist/spi/index.d.ts"
+      ]
+    }
+  },
+  "dependencies": {
+    "@hamak/shared-utils": "*",
+    "@hamak/ui-store-api": "*",
+    "@hamak/ui-store-impl": "*",
+    "@hamak/microkernel-api": "*",
+    "@hamak/microkernel-spi": "*",
+    "@reduxjs/toolkit": "^2.0.0",
+    "axios": "^1.6.0",
+    "redux": "^5.0.1"
+  },
+  "devDependencies": {
+    "typescript": "~5.4.0",
+    "vitest": "^2.0.0",
+    "@types/node": "^20.0.0"
+  }
+}