@hamak/ui-store-spi 0.4.16 → 0.5.0

package/dist/autosave/i-autosave-provider.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Autosave Provider Interface
+ *
+ * Each filesystem plugin (remote-fs, remote-resource, git) implements this interface
+ * to handle actual save operations. The core autosave middleware handles debouncing
+ * and orchestration, then delegates to the appropriate provider for execution.
+ */
+import type { FileSystemNode } from '@hamak/shared-utils';
+import type { Dispatch, AnyAction } from 'redux';
+/**
+ * Result of a save operation
+ */
+export interface AutosaveResult {
+    /** Whether the save succeeded */
+    success: boolean;
+    /** Error information if failed */
+    error?: {
+        code: string;
+        message: string;
+    };
+    /** Timestamp of the save */
+    timestamp?: number;
+    /** Additional metadata from the save operation */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Autosave provider interface
+ *
+ * Implement this interface to add autosave support for a filesystem plugin.
+ *
+ * @example
+ * ```typescript
+ * class RemoteFsAutosaveProvider implements IAutosaveProvider {
+ *   readonly id = 'remote-fs';
+ *   readonly priority = 10;
+ *
+ *   supports(path: string[], node: FileSystemNode): boolean {
+ *     return node.state?.extensionStates?.['remoteFs'] !== undefined;
+ *   }
+ *
+ *   async save(path, content, node, dispatch): Promise<AutosaveResult> {
+ *     dispatch(rfsActions.ofPutRequest(path, content));
+ *     return { success: true, timestamp: Date.now() };
+ *   }
+ * }
+ * ```
+ */
+export interface IAutosaveProvider {
+    /**
+     * Unique provider identifier
+     * Examples: 'remote-fs', 'remote-resource', 'git'
+     */
+    readonly id: string;
+    /**
+     * Priority for provider selection when multiple providers support a path.
+     * Higher priority = preferred. Default: 0
+     */
+    readonly priority?: number;
+    /**
+     * Check if this provider can handle autosave for a given path.
+     *
+     * Provider should check if the node has the required extension state.
+     * For example, remote-fs checks for 'remoteFs' extension state,
+     * remote-resource checks for 'ui-remote-resource' extension state.
+     *
+     * @param path - File path segments
+     * @param node - The filesystem node
+     * @returns true if this provider can handle the path
+     */
+    supports(path: string[], node: FileSystemNode): boolean;
+    /**
+     * Execute the save operation.
+     *
+     * Provider should dispatch its own save actions (e.g., PUT_REQUEST, UPDATE_ENTITY)
+     * and return the result. The autosave middleware will track the save status.
+     *
+     * @param path - File path segments
+     * @param content - File content to save
+     * @param node - The filesystem node
+     * @param dispatch - Redux dispatch function
+     * @returns Promise resolving to the save result
+     */
+    save(path: string[], content: unknown, node: FileSystemNode, dispatch: Dispatch<AnyAction>): Promise<AutosaveResult>;
+    /**
+     * Cancel any in-progress save for a path (optional).
+     *
+     * @param path - File path segments
+     */
+    cancel?(path: string[]): void;
+    /**
+     * Clean up resources for a path (optional).
+     * Called when autosave is disabled or node is removed.
+     *
+     * @param path - File path segments
+     */
+    cleanup?(path: string[]): void;
+}
+//# sourceMappingURL=i-autosave-provider.d.ts.map

package/dist/autosave/i-autosave-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-autosave-provider.d.ts","sourceRoot":"","sources":["../../src/autosave/i-autosave-provider.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,iCAAiC;IACjC,OAAO,EAAE,OAAO,CAAC;IAEjB,kCAAkC;IAClC,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IAEF,4BAA4B;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC;IAExD;;;;;;;;;;;OAWG;IACH,IAAI,CACF,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,cAAc,EACpB,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,GAC5B,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE9B;;;;;OAKG;IACH,OAAO,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC"}

package/dist/autosave/i-autosave-provider.js

@@ -0,0 +1,8 @@
+/**
+ * Autosave Provider Interface
+ *
+ * Each filesystem plugin (remote-fs, remote-resource, git) implements this interface
+ * to handle actual save operations. The core autosave middleware handles debouncing
+ * and orchestration, then delegates to the appropriate provider for execution.
+ */
+export {};

package/dist/autosave/i-autosave-registry.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Autosave Provider Registry Interface
+ *
+ * Registry for managing autosave providers. Plugins register their providers
+ * during activation, and the autosave middleware uses the registry to find
+ * the appropriate provider for each file.
+ */
+import type { FileSystemNode } from '@hamak/shared-utils';
+import type { IAutosaveProvider } from './i-autosave-provider';
+/**
+ * Registry for autosave providers
+ */
+export interface IAutosaveProviderRegistry {
+    /**
+     * Register an autosave provider
+     *
+     * @param provider - The provider to register
+     * @throws Error if a provider with the same ID is already registered
+     */
+    register(provider: IAutosaveProvider): void;
+    /**
+     * Unregister an autosave provider
+     *
+     * @param providerId - The ID of the provider to unregister
+     */
+    unregister(providerId: string): void;
+    /**
+     * Get a provider by ID
+     *
+     * @param providerId - The provider ID
+     * @returns The provider or undefined if not found
+     */
+    get(providerId: string): IAutosaveProvider | undefined;
+    /**
+     * Find the best provider for a path
+     *
+     * Checks all registered providers and returns the one with the highest
+     * priority that supports the given path.
+     *
+     * @param path - File path segments
+     * @param node - The filesystem node
+     * @returns The best matching provider or undefined if none found
+     */
+    findProvider(path: string[], node: FileSystemNode): IAutosaveProvider | undefined;
+    /**
+     * Get all registered providers
+     *
+     * @returns Array of all registered providers
+     */
+    getAll(): IAutosaveProvider[];
+    /**
+     * Check if a provider is registered
+     *
+     * @param providerId - The provider ID
+     * @returns true if the provider is registered
+     */
+    has(providerId: string): boolean;
+}
+//# sourceMappingURL=i-autosave-registry.d.ts.map

package/dist/autosave/i-autosave-registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-autosave-registry.d.ts","sourceRoot":"","sources":["../../src/autosave/i-autosave-registry.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAE5C;;;;OAIG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;;;OAKG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAEvD;;;;;;;;;OASG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,cAAc,GAAG,iBAAiB,GAAG,SAAS,CAAC;IAElF;;;;OAIG;IACH,MAAM,IAAI,iBAAiB,EAAE,CAAC;IAE9B;;;;;OAKG;IACH,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;CAClC"}

package/dist/autosave/i-autosave-registry.js

@@ -0,0 +1,8 @@
+/**
+ * Autosave Provider Registry Interface
+ *
+ * Registry for managing autosave providers. Plugins register their providers
+ * during activation, and the autosave middleware uses the registry to find
+ * the appropriate provider for each file.
+ */
+export {};

package/dist/autosave/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Autosave SPI
+ *
+ * Service Provider Interfaces for autosave functionality.
+ */
+export * from './i-autosave-provider';
+export * from './i-autosave-registry';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/autosave/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC"}

package/dist/autosave/index.js

@@ -0,0 +1,7 @@
+/**
+ * Autosave SPI
+ *
+ * Service Provider Interfaces for autosave functionality.
+ */
+export * from './i-autosave-provider';
+export * from './i-autosave-registry';

package/dist/es2015/autosave/i-autosave-provider.js

@@ -0,0 +1,8 @@
+/**
+ * Autosave Provider Interface
+ *
+ * Each filesystem plugin (remote-fs, remote-resource, git) implements this interface
+ * to handle actual save operations. The core autosave middleware handles debouncing
+ * and orchestration, then delegates to the appropriate provider for execution.
+ */
+export {};

package/dist/es2015/autosave/i-autosave-registry.js

@@ -0,0 +1,8 @@
+/**
+ * Autosave Provider Registry Interface
+ *
+ * Registry for managing autosave providers. Plugins register their providers
+ * during activation, and the autosave middleware uses the registry to find
+ * the appropriate provider for each file.
+ */
+export {};

package/dist/es2015/autosave/index.js

@@ -0,0 +1,7 @@
+/**
+ * Autosave SPI
+ *
+ * Service Provider Interfaces for autosave functionality.
+ */
+export * from './i-autosave-provider';
+export * from './i-autosave-registry';

package/dist/es2015/index.js

@@ -1,2 +1,3 @@
 export * from './middleware';
 export * from './persistence';
+export * from './autosave';

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './middleware';
 export * from './persistence';
+export * from './autosave';
 //# 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,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -1,2 +1,3 @@
 export * from './middleware';
 export * from './persistence';
+export * from './autosave';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hamak/ui-store-spi",
-  "version": "0.4.16",
+  "version": "0.5.0",
   "private": false,
   "type": "module",
   "description": "UI Store SPI - Service Provider Interfaces for Redux store",