@dotdirfm/ui 0.1.4 → 0.1.5

package/dist/lib/features/extensions/extensionApi.d.ts

@@ -1,196 +1 @@
-/**
- * Shared types for the host ↔ extension iframe communication (postMessage RPC).
- *
- * Host exposes HostApi to the iframe.
- * Viewer extensions expose ViewerExtensionApi; editor extensions expose EditorExtensionApi.
- */
-export interface ViewerProps {
-    filePath: string;
-    fileName: string;
-    fileSize: number;
-    inline?: boolean;
-    /** When set (e.g. Web VFS), extension can load scripts/workers from this base URL. */
-    extensionScriptBaseUrl?: string;
-}
-/** Grammar contribution + loaded content (from host, for custom syntax highlighting). */
-export interface EditorGrammarPayload {
-    contribution: {
-        language: string;
-        scopeName: string;
-        path: string;
-        embeddedLanguages?: Record<string, string>;
-    };
-    /** Absolute path to grammar JSON file (used for lazy loading). */
-    path?: string;
-    /** Parsed TextMate grammar JSON (optional; host may lazy-load and fill it). */
-    content?: object;
-}
-export interface EditorLanguagePayload {
-    id: string;
-    aliases?: string[];
-    extensions?: string[];
-    filenames?: string[];
-}
-export interface EditorProps {
-    filePath: string;
-    fileName: string;
-    langId: string;
-    /** Extension root path (for reading package.json / grammars). */
-    extensionDirPath?: string;
-    /** All languages from loaded extensions (for Monaco registration). */
-    languages?: EditorLanguagePayload[];
-    /** All grammars with content from loaded extensions (for TextMate tokenization). */
-    grammars?: EditorGrammarPayload[];
-    /** True when shown inline (e.g. preview tab). Extensions should not steal focus when inline. */
-    inline?: boolean;
-    /** When set (e.g. Web VFS), extension can load scripts/workers from this base URL for lazy loading. */
-    extensionScriptBaseUrl?: string;
-}
-export interface ColorThemeData {
-    /** Theme kind: 'dark' or 'light'. */
-    kind: "dark" | "light";
-    /** VS Code color theme colors (e.g. 'editor.background' → '#1e1e2e'). Undefined when no VS Code theme active. */
-    colors?: Record<string, string>;
-    /** VS Code tokenColors for syntax highlighting. Undefined when no VS Code theme active. */
-    tokenColors?: unknown[];
-}
-export interface HostApi {
-    readFile(path: string): Promise<ArrayBuffer>;
-    readFileText(path: string): Promise<string>;
-    /** Read a byte range (for chunked viewing). */
-    readFileRange?(path: string, offset: number, length: number): Promise<ArrayBuffer>;
-    /** Lightweight stat for the currently viewed file. */
-    statFile?(path: string): Promise<{
-        size: number;
-        mtimeMs: number;
-    }>;
-    /** Subscribe to external changes of the currently viewed file. */
-    onFileChange?(callback: () => void): () => void;
-    writeFile(path: string, content: string): Promise<void>;
-    getTheme(): Promise<string>;
-    /** Get the active color theme data (colors + tokenColors). Returns null if no VS Code theme is active. */
-    getColorTheme?(): ColorThemeData | null;
-    /** Subscribe to theme changes. Callback fires when the color theme changes. Returns unsubscribe function. */
-    onThemeChange?(callback: (theme: ColorThemeData) => void): () => void;
-    onClose(): void;
-    /** Execute a host command (e.g. navigatePrev, navigateNext, getFileIndex). */
-    executeCommand?<T = unknown>(command: string, args?: unknown): Promise<T>;
-    /**
-     * Commands API exposed to extensions running inside the iframe.
-     * Implemented to mimic VS Code: `registerCommand(id, callback) -> Disposable`.
-     */
-    registerCommand?(commandId: string, handler: (...args: unknown[]) => void | Promise<void>): () => void;
-    /** Contribute a keybinding (extension layer). */
-    registerKeybinding?(binding: {
-        command: string;
-        key: string;
-        mac?: string;
-        when?: string;
-    }): () => void;
-    /** Oniguruma WASM binary for TextMate grammars (optional). */
-    getOnigurumaWasm?(): Promise<ArrayBuffer>;
-    /** URL to a file inside the extension dir (for lazy-loading workers). Returns blob URL. */
-    getExtensionResourceUrl?(relativePath: string): Promise<string>;
-}
-export interface ViewerExtensionApi {
-    /** Render viewer UI into the provided root. */
-    mount(root: HTMLElement, props: ViewerProps): Promise<void>;
-    unmount(): Promise<void>;
-}
-export interface EditorExtensionApi {
-    /** Render editor UI into the provided root. */
-    mount(root: HTMLElement, props: EditorProps): Promise<void>;
-    unmount(): Promise<void>;
-    setDirty?(dirty: boolean): void;
-    /** Change the editor language (e.g. for syntax highlighting). */
-    setLanguage?(langId: string): void | Promise<void>;
-}
-/** A single entry returned by an fsProvider. */
-export interface FsProviderEntry {
-    name: string;
-    type: "file" | "directory";
-    size?: number;
-    mtimeMs?: number;
-}
-/**
- * Host API available to fsProvider extensions (injected as `window.__dotdirProviderHostApi`
- * before the provider bundle is evaluated).
- */
-export interface FsProviderHostApi {
-    /** Read the entire container file from the real filesystem. */
-    readFile(realPath: string): Promise<ArrayBuffer>;
-    /** Read a byte range from the real filesystem. */
-    readFileRange(realPath: string, offset: number, length: number): Promise<ArrayBuffer>;
-}
-/**
- * API that an fsProvider extension bundle must expose.
- *
- * Protocol: the bundle assigns a factory to `window.__dotdirProviderReady`.
- * The host evaluates the bundle, then calls `window.__dotdirProviderReady(hostApi)`
- * and stores the returned object.
- *
- * Example bundle (CommonJS):
- * ```js
- * window.__dotdirProviderReady = function(hostApi) {
- *   return {
- *     async listEntries(containerPath, innerPath) {
- *       const bytes = await hostApi.readFile(containerPath);
- *       // ... parse format, return entries
- *       return [{ name: 'README.md', type: 'file', size: 1234 }];
- *     }
- *   };
- * };
- * ```
- */
-export interface FsProviderExtensionApi {
-    /**
-     * List the entries at `innerPath` inside the container at `containerPath`.
-     * `containerPath` is always a real filesystem path.
-     * `innerPath` is always absolute, e.g. '/' for the root.
-     */
-    listEntries(containerPath: string, innerPath: string): Promise<FsProviderEntry[]>;
-    /**
-     * Read a byte range of a file inside the container.
-     * Optional — only needed if the host should be able to open files inside containers.
-     */
-    readFileRange?(containerPath: string, innerPath: string, offset: number, length: number): Promise<ArrayBuffer>;
-}
-/** Extension calls this when loaded; host sets it before injecting the script. */
-export type DotDirHostReadyCallback = (api: ViewerExtensionApi | EditorExtensionApi) => void;
-/** Factory signature for fsProvider bundles. */
-export type FsProviderFactory = (hostApi: FsProviderHostApi) => FsProviderExtensionApi;
-declare global {
-    interface Window {
-        __dotdirHostReady?: DotDirHostReadyCallback;
-        /**
-         * Set by the fsProvider bundle. The host calls it after the bundle loads,
-         * passing the HostApi, and stores the returned FsProviderExtensionApi.
-         */
-        __dotdirProviderReady?: FsProviderFactory;
-        /**
-         * Host API exposed to isolated extensions (iframe) as a global.
-         * Extensions can call `window.dotdir.readFile(...)`, etc.
-         *
-         * We'll later publish these typings via an npm package (`dotdir`).
-         */
-        dotdir?: HostApi & {
-            commands?: {
-                registerCommand: (commandId: string, handler: (...args: unknown[]) => void | Promise<void>, options?: {
-                    title?: string;
-                    category?: string;
-                    icon?: string;
-                }) => {
-                    dispose: () => void;
-                };
-                registerKeybinding: (binding: {
-                    command: string;
-                    key: string;
-                    mac?: string;
-                    when?: string;
-                }) => {
-                    dispose: () => void;
-                };
-            };
-        };
-    }
-}
+export type { ColorThemeData, DotDirCommandsApi, DotDirGlobalApi, DotDirHostReadyCallback, EditorExtensionApi, EditorGrammarPayload, EditorLanguagePayload, EditorProps, FsProviderEntry, FsProviderExtensionApi, FsProviderFactory, FsProviderHostApi, HostApi, ViewerExtensionApi, ViewerProps, } from '../../../../../extension-api/dist/index.d.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotdirfm/ui",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Reusable DotDir file manager UI component for React apps.",
   "main": "./dist/dotdir.js",
   "module": "./dist/dotdir.mjs",
@@ -51,7 +51,8 @@
     "fss-lang": "^0.0.5",
     "jotai": "^2.19.0",
     "jsonc-parser": "^3.3.1",
-    "marked": "^17.0.5"
+    "marked": "^17.0.5",
+    "@dotdirfm/extension-api": "0.1.0"
   },
   "devDependencies": {
     "vite": "^8.0.0",
@@ -60,7 +61,7 @@
   "scripts": {
     "dev": "vite",
     "watch": "vite build --watch",
-    "build": "tsc && vite build",
+    "build": "pnpm --filter @dotdirfm/extension-api build && tsc && vite build",
     "test": "echo \"Error: no test specified\" && exit 1"
   }
 }