@celljs/ta-web 0.0.0-stage → 4.6.0

package/lib/browser/extension/web-extensions.d.ts

@@ -0,0 +1,119 @@
+import type { TaEvent, TaWebExtensionInfo } from '@celljs/ta-protocol';
+import * as React from 'react';
+import { TaNotices } from '../notices/notices-protocol';
+import { TaSettings } from '../settings/settings-protocol';
+import { type StateSpec, TaState } from '../state/state-protocol';
+import { TaWorkbench } from '../workbench-protocol';
+import type { CodeEditorProps, DiffEditorProps, WebComposerProps, WebEditor, WebExtensionAPI, WebExtensionFactory, WebFolderPickerProps, WebOpener, WebStorage, WebTool, WebView, WidgetOptions } from './web-extension-api';
+import { BuiltinWebExtension, type LoadedWebExtension, TaWebExtensions, type WebEditorEntry, type WebExtensionConversation, type WebExtensionsState, type WorkbenchTabs } from './web-extension-protocol';
+/** One web extension that runs, and what it registered. */
+interface Running {
+    loaded: LoadedWebExtension;
+    /** Of the file it runs; a change loads it again. */
+    hash?: string;
+    /** Its function has returned: what it registers from now on shows at once. */
+    started: boolean;
+    stopped: boolean;
+    views: Map<string, WebView>;
+    widgets: Map<string, {
+        component: React.ComponentType;
+        options: WidgetOptions;
+    }>;
+    renderers: Map<string, WebExtensionsState['renderers'][string]>;
+    avatar?: WebExtensionsState['avatars'][string];
+    tools: WebTool[];
+    openers: WebOpener[];
+    handlers: {
+        type: string;
+        handler: (event: TaEvent) => void;
+    }[];
+    /** Undo what it subscribed to outside this class (the terminals of the workbench). */
+    unsubscribes: (() => void)[];
+    dispose?: () => void;
+}
+export declare namespace WebExtensionUtil {
+    function builtinId(name: string): string;
+    /** The default export of a module of source code. */
+    function load(code: string): Promise<WebExtensionFactory>;
+    function message(error: unknown): string;
+}
+export declare namespace WebViewUtil {
+    /** The tab a `panel` view opens as. */
+    function editorId(viewId: string): string;
+    /** The page shown last in this tab of the browser: another tab may show another. */
+    const PAGE: StateSpec<string>;
+    /** The tools open in the workbench, for the user in any browser: the workbench is one for the whole page. */
+    const TABS: StateSpec<WorkbenchTabs>;
+    /** What to keep of the tabs: the views open, and the one shown, or the one still to open again. */
+    function tabs(editors: readonly {
+        id: string;
+    }[], active: string | undefined): WorkbenchTabs;
+}
+export declare class TaWebExtensionsImpl implements TaWebExtensions {
+    protected readonly workbench: TaWorkbench;
+    protected readonly settings: TaSettings;
+    protected readonly notices: TaNotices;
+    protected readonly persisted: TaState;
+    readonly builtins: BuiltinWebExtension[];
+    protected current: WebExtensionsState;
+    protected readonly running: Map<string, Running>;
+    protected readonly listeners: Set<(state: WebExtensionsState) => void>;
+    protected conversation?: WebExtensionConversation;
+    protected switcher?: (sessionId: string) => Promise<void>;
+    protected refreshing: Promise<boolean>;
+    /** The tabs of before are open again: from now on, what is open is kept. */
+    protected restored: boolean;
+    /** The tab shown before the page loaded, until it opens again or the user shows another. */
+    protected pendingActive?: string;
+    get state(): WebExtensionsState;
+    protected init(): void;
+    subscribe(listener: (state: WebExtensionsState) => void): () => void;
+    /** One at a time: a refresh while one runs follows it. */
+    refresh(): Promise<boolean>;
+    remove(id: string): Promise<void>;
+    showEditor(id: string): void;
+    openView(id: string, preserveFocus?: boolean): void;
+    showPage(id: string): void;
+    protected showView(id: string): void;
+    protected isShown(id: string): boolean;
+    closeEditor(id: string): Promise<void>;
+    closeEditors(ids: readonly string[]): Promise<void>;
+    pinEditor(id: string): void;
+    /** Removes a tab and tells the extension that opened it. */
+    protected dropEditor(editor: WebEditorEntry): void;
+    protected setDirty(run: Running, id: string, dirty: boolean): void;
+    connect(conversation: WebExtensionConversation | undefined): void;
+    setSessionSwitcher(switcher: ((sessionId: string) => Promise<void>) | undefined): void;
+    emit(event: TaEvent): void;
+    protected reconcile(): Promise<boolean>;
+    /** The tools open before, behind what is shown; the tab shown before, once it is open again. */
+    protected restoreTabs(): Promise<void>;
+    protected keepTabs(): void;
+    protected startPackage(info: TaWebExtensionInfo): Promise<void>;
+    protected start(loaded: LoadedWebExtension, factory: WebExtensionFactory, hash?: string): void;
+    protected stop(run: Running): void;
+    protected openEditor(run: Running, editor: WebEditor, preserveFocus?: boolean, preview?: boolean): void;
+    open(editor: WebEditorEntry, preserveFocus?: boolean): void;
+    protected removeEditors(match: (editor: WebExtensionsState['editors'][number]) => boolean): void;
+    protected record(loaded: LoadedWebExtension, hash?: string): Running;
+    /** The API of one extension: what it registers is its own and goes when it stops. */
+    /** Monaco in the theme and language of the settings, the same component for every extension. */
+    protected readonly codeEditor: (props: CodeEditorProps) => React.FunctionComponentElement<CodeEditorProps & {
+        settings: TaSettings;
+    }>;
+    protected readonly diffEditor: (props: DiffEditorProps) => React.FunctionComponentElement<DiffEditorProps & {
+        settings: TaSettings;
+    }>;
+    protected readonly listDirectory: (directory: string) => Promise<import("@celljs/ta-protocol").TaDirEntry[]>;
+    /** The message box, whose button of the directory lists those of the server. */
+    protected readonly composer: (props: WebComposerProps) => React.FunctionComponentElement<import("../components/web-composer").WebComposerHostProps>;
+    protected readonly folderPicker: ({ initial, onPick, onClose }: WebFolderPickerProps) => React.FunctionComponentElement<import("../components/folder-picker").FolderPickerProps>;
+    protected api(run: Running): WebExtensionAPI;
+    /** The data of the package of an extension on the server; of a directory with `cwd`. */
+    protected storage(run: Running, cwd?: string): WebStorage;
+    protected guard(run: Running, action: () => void): void;
+    protected publish(): void;
+    protected update(change: Partial<WebExtensionsState>): void;
+}
+export {};
+//# sourceMappingURL=web-extensions.d.ts.map

package/lib/browser/extension/web-extensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-extensions.d.ts","sourceRoot":"","sources":["../../../src/browser/extension/web-extensions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAA+C,kBAAkB,EAAqB,MAAM,qBAAqB,CAAC;AACvI,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAS/B,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,KAAK,SAAS,EAAa,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,KAAK,EACR,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,SAAS,EACT,UAAU,EACV,OAAO,EACP,OAAO,EACP,aAAa,EAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACH,mBAAmB,EACnB,KAAK,kBAAkB,EACvB,eAAe,EACf,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EAEvB,KAAK,aAAa,EACrB,MAAM,0BAA0B,CAAC;AAIlC,2DAA2D;AAC3D,UAAU,OAAO;IACb,MAAM,EAAE,kBAAkB,CAAC;IAC3B,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8EAA8E;IAC9E,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5B,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC;QAAC,OAAO,EAAE,aAAa,CAAA;KAAE,CAAC,CAAC;IACjF,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAChE,MAAM,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IAC/C,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;KAAE,EAAE,CAAC;IAChE,sFAAsF;IACtF,YAAY,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB;AAED,yBAAiB,gBAAgB,CAAC;IAC9B,SAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE9C;IAED,qDAAqD;IACrD,SAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAWrE;IAED,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAE9C;CACJ;AAED,yBAAiB,WAAW,CAAC;IACzB,uCAAuC;IACvC,SAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE/C;IAED,oFAAoF;IAC7E,MAAM,IAAI,EAAE,SAAS,CAAC,MAAM,CAAsE,CAAC;IAE1G,6GAA6G;IACtG,MAAM,IAAI,EAAE,SAAS,CAAC,aAAa,CAYzC,CAAC;IAEF,mGAAmG;IACnG,SAAgB,IAAI,CAAC,OAAO,EAAE,SAAS;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,aAAa,CAIlG;CACJ;AAED,qBACa,mBAAoB,YAAW,eAAe;IAEvD,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;IAG1C,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAGxC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC;IAEtC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAItC,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,EAAE,CAAM;IAE9C,SAAS,CAAC,OAAO,EAAE,kBAAkB,CAWnC;IACF,SAAS,CAAC,QAAQ,CAAC,OAAO,uBAA8B;IACxD,SAAS,CAAC,QAAQ,CAAC,SAAS,cAAmB,kBAAkB,KAAK,IAAI,EAAI;IAC9E,SAAS,CAAC,YAAY,CAAC,EAAE,wBAAwB,CAAC;IAClD,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,CAA0B;IAChE,4EAA4E;IAC5E,SAAS,CAAC,QAAQ,UAAS;IAC3B,4FAA4F;IAC5F,SAAS,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEjC,IAAI,KAAK,IAAI,kBAAkB,CAE9B;IAGD,SAAS,CAAC,IAAI,IAAI,IAAI,CAErB;IAED,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,GAAG,MAAM,IAAI,CAGnE;IAED,0DAA0D;IAC1D,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAO1B;IAEK,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGtC;IAED,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAM3B;IAED,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,UAAQ,GAAG,IAAI,CAMhD;IAED,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAKzB;IAED,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAWnC;IAED,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAErC;IAED,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAErC;IAEK,YAAY,CAAC,GAAG,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAyBxD;IAED,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAI1B;IAED,4DAA4D;IAC5D,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAMjD;IAED,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAOjE;IAED,OAAO,CAAC,YAAY,EAAE,wBAAwB,GAAG,SAAS,GAAG,IAAI,CAKhE;IAED,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAErF;IAED,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAQzB;IAED,UAAgB,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,CAqC5C;IAED,gGAAgG;IAChG,UAAgB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAW3C;IAED,SAAS,CAAC,QAAQ,IAAI,IAAI,CAIzB;IAED,UAAgB,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAQpE;IAED,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAW7F;IAED,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAgBjC;IAED,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,UAAQ,EAAE,OAAO,UAAQ,GAAG,IAAI,CAIlG;IAED,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,UAAQ,GAAG,IAAI,CAgCxD;IAED,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,OAAO,GAAG,IAAI,CAQ/F;IAED,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAcnE;IAED,qFAAqF;IACrF,gGAAgG;IAChG,SAAS,CAAC,QAAQ,CAAC,UAAU,UAAW,eAAe;;OAA4E;IACnI,SAAS,CAAC,QAAQ,CAAC,UAAU,UAAW,eAAe;;OAA4E;IACnI,SAAS,CAAC,QAAQ,CAAC,aAAa,cAAe,MAAM,yDAA4D;IACjH,gFAAgF;IAChF,SAAS,CAAC,QAAQ,CAAC,QAAQ,UAAW,gBAAgB,+FACoG;IAC1J,SAAS,CAAC,QAAQ,CAAC,YAAY,iCAAkC,oBAAoB,6FAM9E;IAEP,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,GAAG,eAAe,CAyI3C;IAED,wFAAwF;IACxF,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,UAAU,CAuBxD;IAED,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,GAAG,IAAI,CAMtD;IAED,SAAS,CAAC,OAAO,IAAI,IAAI,CAkDxB;IAED,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAK1D;CACJ"}