@dotdirfm/extension-api 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,119 @@
+export interface ViewerProps {
+    filePath: string;
+    fileName: string;
+    fileSize: number;
+    inline?: boolean;
+    extensionScriptBaseUrl?: string;
+}
+export interface EditorGrammarPayload {
+    contribution: {
+        language: string;
+        scopeName: string;
+        path: string;
+        embeddedLanguages?: Record<string, string>;
+    };
+    path?: string;
+    content?: object;
+}
+export interface EditorLanguagePayload {
+    id: string;
+    aliases?: string[];
+    extensions?: string[];
+    filenames?: string[];
+}
+export interface EditorProps {
+    filePath: string;
+    fileName: string;
+    langId: string;
+    extensionDirPath?: string;
+    languages?: EditorLanguagePayload[];
+    grammars?: EditorGrammarPayload[];
+    inline?: boolean;
+    extensionScriptBaseUrl?: string;
+}
+export interface ColorThemeData {
+    kind: "dark" | "light";
+    colors?: Record<string, string>;
+    tokenColors?: unknown[];
+}
+export interface HostApi {
+    readFile(path: string): Promise<ArrayBuffer>;
+    readFileText(path: string): Promise<string>;
+    readFileRange?(path: string, offset: number, length: number): Promise<ArrayBuffer>;
+    statFile?(path: string): Promise<{
+        size: number;
+        mtimeMs: number;
+    }>;
+    onFileChange?(callback: () => void): () => void;
+    writeFile(path: string, content: string): Promise<void>;
+    getTheme(): Promise<string>;
+    getColorTheme?(): ColorThemeData | null;
+    onThemeChange?(callback: (theme: ColorThemeData) => void): () => void;
+    onClose(): void;
+    executeCommand?<T = unknown>(command: string, args?: unknown): Promise<T>;
+    registerCommand?(commandId: string, handler: (...args: unknown[]) => void | Promise<void>): () => void;
+    registerKeybinding?(binding: {
+        command: string;
+        key: string;
+        mac?: string;
+        when?: string;
+    }): () => void;
+    getOnigurumaWasm?(): Promise<ArrayBuffer>;
+    getExtensionResourceUrl?(relativePath: string): Promise<string>;
+}
+export interface ViewerExtensionApi {
+    mount(root: HTMLElement, props: ViewerProps): Promise<void>;
+    unmount(): Promise<void>;
+}
+export interface EditorExtensionApi {
+    mount(root: HTMLElement, props: EditorProps): Promise<void>;
+    unmount(): Promise<void>;
+    setDirty?(dirty: boolean): void;
+    setLanguage?(langId: string): void | Promise<void>;
+}
+export interface FsProviderEntry {
+    name: string;
+    type: "file" | "directory";
+    size?: number;
+    mtimeMs?: number;
+}
+export interface FsProviderHostApi {
+    readFile(realPath: string): Promise<ArrayBuffer>;
+    readFileRange(realPath: string, offset: number, length: number): Promise<ArrayBuffer>;
+}
+export interface FsProviderExtensionApi {
+    listEntries(containerPath: string, innerPath: string): Promise<FsProviderEntry[]>;
+    readFileRange?(containerPath: string, innerPath: string, offset: number, length: number): Promise<ArrayBuffer>;
+}
+export type DotDirHostReadyCallback = (api: ViewerExtensionApi | EditorExtensionApi) => void;
+export type FsProviderFactory = (hostApi: FsProviderHostApi) => FsProviderExtensionApi;
+export interface DotDirCommandsApi {
+    registerCommand: (commandId: string, handler: (...args: unknown[]) => void | Promise<void>, options?: {
+        title?: string;
+        category?: string;
+        icon?: string;
+        when?: string;
+    }) => {
+        dispose: () => void;
+    };
+    registerKeybinding: (binding: {
+        command: string;
+        key: string;
+        mac?: string;
+        when?: string;
+    }) => {
+        dispose: () => void;
+    };
+}
+export type DotDirGlobalApi = HostApi & {
+    commands?: DotDirCommandsApi;
+};
+declare global {
+    interface Window {
+        __dotdirHostReady?: DotDirHostReadyCallback;
+        __dotdirProviderReady?: FsProviderFactory;
+        dotdir?: DotDirGlobalApi;
+    }
+    var dotdir: DotDirGlobalApi;
+}
+export {};

package/dist/index.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@dotdirfm/extension-api",
+  "version": "0.1.0",
+  "description": "Shared host and extension API types for DotDir viewer/editor/fs provider extensions.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "keywords": [
+    "dotdir",
+    "extensions",
+    "api",
+    "types"
+  ],
+  "author": "Mikhail Isupov",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dotdirfm/dotdir.git"
+  },
+  "homepage": "https://github.com/dotdirfm/dotdir#readme",
+  "bugs": {
+    "url": "https://github.com/dotdirfm/dotdir/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}