@theia/plugin-ext 1.45.1 → 1.46.0-next.72

package/lib/plugin/node/plugin-container-module.js

@@ -0,0 +1,115 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginApiCache = exports.PluginContainerModule = void 0;
+const inversify_1 = require("@theia/core/shared/inversify");
+const common_1 = require("../../common");
+/**
+ * Factory for an Inversify `ContainerModule` that supports registration of the plugin's
+ * API factory. Use the `PluginContainerModule`'s `create()` method to create the container
+ * module; its `callback` function provides a `registry` of Inversify binding functions that
+ * includes a `bindApiFactory` function for binding the API factory.
+ */
+exports.PluginContainerModule = Object.assign(Symbol('PluginContainerModule'), {
+    create(callback) {
+        const result = new inversify_1.ContainerModule((bind, unbind, isBound, rebind) => {
+            const bindApiFactory = (apiModuleName, serviceIdentifier, factoryClass) => {
+                result.initializeApi = container => {
+                    const apiCache = new PluginApiCache(apiModuleName, serviceIdentifier);
+                    apiCache.initializeApi(container);
+                    return apiCache;
+                };
+                bind(factoryClass).toSelf().inSingletonScope();
+                bind(serviceIdentifier).toDynamicValue(({ container }) => {
+                    const factory = container.get(factoryClass);
+                    return factory.createApi.bind(factory);
+                }).inSingletonScope();
+            };
+            callback({ bind, unbind, isBound, rebind, bindApiFactory });
+        });
+        return result;
+    }
+});
+/**
+ * An object that creates and caches the instance of the plugin API created by the
+ * factory binding in a {@link PluginContainerModule} in some plugin host.
+ *
+ * @template T the custom API object's type
+ */
+class PluginApiCache {
+    /**
+     * Initializes me with the module name by which plugins import the API
+     * and the service identifier to look up in the Inversify `Container` to
+     * obtain the {@link ApiFactory} that will instantiate it.
+     */
+    constructor(apiModuleName, serviceIdentifier) {
+        this.apiModuleName = apiModuleName;
+        this.serviceIdentifier = serviceIdentifier;
+        this.pluginsApiImpl = new Map();
+        this.hookedModuleLoader = false;
+    }
+    // Called by Theia to do any prep work needed for dishing out the API object
+    // when it's requested. The key part of that is hooking into the node module
+    // loader. This is called every time a plugin-host process is forked.
+    initializeApi(container) {
+        this.apiFactory = container.get(this.serviceIdentifier);
+        this.pluginManager = container.get(common_1.PluginManager);
+        if (!this.hookedModuleLoader) {
+            this.hookedModuleLoader = true;
+            this.overrideInternalLoad();
+        }
+    }
+    /**
+     * Hook into the override chain of JavaScript's `module` loading function
+     * to implement ourselves, using the API provider's registered factory,
+     * the construction of its default exports object.
+     */
+    overrideInternalLoad() {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const module = require('module');
+        const internalLoad = module._load;
+        const self = this;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        module._load = function (request, parent, isMain) {
+            if (request !== self.apiModuleName) {
+                // Pass the request to the next implementation down the chain
+                return internalLoad.call(this, request, parent, isMain);
+            }
+            const plugin = self.findPlugin(parent.filename);
+            if (plugin) {
+                let apiImpl = self.pluginsApiImpl.get(plugin.model.id);
+                if (!apiImpl) {
+                    apiImpl = self.apiFactory(plugin);
+                    self.pluginsApiImpl.set(plugin.model.id, apiImpl);
+                }
+                return apiImpl;
+            }
+            console.warn(`Extension module ${parent.filename} did an import of '${self.apiModuleName}' but our cache ` +
+                ' has no knowledge of that extension. Returning a generic API object; some functionality might not work correctly.');
+            if (!self.defaultApi) {
+                self.defaultApi = self.apiFactory(common_1.emptyPlugin);
+            }
+            return self.defaultApi;
+        };
+    }
+    // Search all loaded plugins to see which one has the given file (absolute path)
+    findPlugin(filePath) {
+        return this.pluginManager.getAllPlugins().find(plugin => filePath.startsWith(plugin.pluginFolder));
+    }
+}
+exports.PluginApiCache = PluginApiCache;
+//# sourceMappingURL=plugin-container-module.js.map

package/lib/plugin/node/plugin-container-module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-container-module.js","sourceRoot":"","sources":["../../../src/plugin/node/plugin-container-module.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,+CAA+C;AAC/C,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;AAEhF,4DAA2E;AAC3E,yCAAkE;AAgClE;;;;;GAKG;AACU,QAAA,qBAAqB,GAAkF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC,EAAE;IAC/J,MAAM,CAAC,QAAuC;QAC1C,MAAM,MAAM,GAAkC,IAAI,2BAAe,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;YAChG,MAAM,cAAc,GAAmB,CAAC,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,EAAE;gBACtF,MAAM,CAAC,aAAa,GAAG,SAAS,CAAC,EAAE;oBAC/B,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;oBACtE,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;oBAClC,OAAO,QAAQ,CAAC;gBACpB,CAAC,CAAC;gBACF,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,EAAE,CAAC,gBAAgB,EAAE,CAAC;gBAC/C,IAAI,CAAC,iBAAiB,CAAC,CAAC,cAAc,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE;oBACrD,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;oBAC5C,OAAO,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC3C,CAAC,CAAC,CAAC,gBAAgB,EAAE,CAAC;YAC1B,CAAC,CAAC;YACF,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ,CAAC,CAAC;AAWH;;;;;GAKG;AACH,MAAa,cAAc;IAQvB;;;;OAIG;IACH,YAA6B,aAAqB,EAC7B,iBAA8D;QADtD,kBAAa,GAAb,aAAa,CAAQ;QAC7B,sBAAiB,GAAjB,iBAAiB,CAA6C;QAT3E,mBAAc,GAAG,IAAI,GAAG,EAAa,CAAC;QACtC,uBAAkB,GAAG,KAAK,CAAC;IAQmD,CAAC;IAEvF,4EAA4E;IAC5E,4EAA4E;IAC5E,qEAAqE;IACrE,aAAa,CAAC,SAA+B;QACzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACxD,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,sBAAa,CAAC,CAAC;QAElD,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC1B,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;YAC/B,IAAI,CAAC,oBAAoB,EAAE,CAAC;SAC/B;IACL,CAAC;IAED;;;;OAIG;IACK,oBAAoB;QACxB,8DAA8D;QAC9D,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEjC,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC;QAElB,8DAA8D;QAC9D,MAAM,CAAC,KAAK,GAAG,UAAU,OAAe,EAAE,MAAW,EAAE,MAAW;YAC9D,IAAI,OAAO,KAAK,IAAI,CAAC,aAAa,EAAE;gBAChC,6DAA6D;gBAC7D,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;aAC3D;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAChD,IAAI,MAAM,EAAE;gBACR,IAAI,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACvD,IAAI,CAAC,OAAO,EAAE;oBACV,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;oBAClC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;iBACrD;gBACD,OAAO,OAAO,CAAC;aAClB;YAED,OAAO,CAAC,IAAI,CACR,oBAAoB,MAAM,CAAC,QAAQ,sBAAsB,IAAI,CAAC,aAAa,kBAAkB;gBACzF,mHAAmH,CAC1H,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;gBAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAW,CAAC,CAAC;aAClD;YACD,OAAO,IAAI,CAAC,UAAU,CAAC;QAC3B,CAAC,CAAC;IACN,CAAC;IAED,gFAAgF;IACtE,UAAU,CAAC,QAAgB;QACjC,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IACvG,CAAC;CACJ;AAzED,wCAyEC"}

package/lib/plugin/notebook/notebook-document.d.ts

@@ -1,62 +1,62 @@
-import * as theia from '@theia/plugin';
-import * as rpc from '../../common';
-import { EditorsAndDocumentsExtImpl } from '../editors-and-documents';
-import * as notebookCommon from '@theia/notebook/lib/common';
-import { Disposable, URI } from '@theia/core';
-import { ModelAddedData, NotebookCellDto, NotebookCellsChangedEventDto, NotebookModelAddedData, NotebookOutputDto } from '../../common';
-import { DocumentsExtImpl } from '../documents';
-export declare class Cell {
-    readonly notebookDocument: NotebookDocument;
-    private readonly editorsAndDocuments;
-    private readonly cellData;
-    static asModelAddData(notebook: theia.NotebookDocument, cell: NotebookCellDto): ModelAddedData & {
-        notebook: theia.NotebookDocument;
-    };
-    private cell;
-    readonly handle: number;
-    readonly uri: URI;
-    readonly cellKind: notebookCommon.CellKind;
-    private outputs;
-    private metadata;
-    private previousResult;
-    internalMetadata: notebookCommon.NotebookCellInternalMetadata;
-    get language(): string;
-    constructor(notebookDocument: NotebookDocument, editorsAndDocuments: EditorsAndDocumentsExtImpl, cellData: rpc.NotebookCellDto);
-    get apiCell(): theia.NotebookCell;
-    setOutputs(newOutputs: NotebookOutputDto[]): void;
-    setMetadata(newMetadata: notebookCommon.NotebookCellMetadata): void;
-    setInternalMetadata(newInternalMetadata: notebookCommon.NotebookCellInternalMetadata): void;
-}
-export declare class NotebookDocument implements Disposable {
-    private readonly proxy;
-    private readonly editorsAndDocuments;
-    private readonly textDocuments;
-    readonly uri: theia.Uri;
-    private readonly cells;
-    private readonly notebookType;
-    private notebook?;
-    private metadata;
-    private versionId;
-    private isDirty;
-    private disposed;
-    constructor(proxy: rpc.NotebookDocumentsMain, editorsAndDocuments: EditorsAndDocumentsExtImpl, textDocuments: DocumentsExtImpl, uri: theia.Uri, notebookData: NotebookModelAddedData);
-    get apiNotebook(): theia.NotebookDocument;
-    private validateIndex;
-    private validateRange;
-    private getCells;
-    private save;
-    acceptDirty(isDirty: boolean): void;
-    acceptModelChanged(event: NotebookCellsChangedEventDto, isDirty: boolean, newMetadata: notebookCommon.NotebookDocumentMetadata | undefined): theia.NotebookDocumentChangeEvent;
-    private spliceNotebookCells;
-    private moveCells;
-    private setCellOutputs;
-    private changeCellLanguage;
-    private changeCellMetadata;
-    private changeCellInternalMetadata;
-    getCellFromApiCell(apiCell: theia.NotebookCell): Cell | undefined;
-    getCell(cellHandle: number): Cell | undefined;
-    getCellFromIndex(index: number): Cell | undefined;
-    getCellIndex(cell: Cell): number;
-    dispose(): void;
-}
+import * as theia from '@theia/plugin';
+import * as rpc from '../../common';
+import { EditorsAndDocumentsExtImpl } from '../editors-and-documents';
+import * as notebookCommon from '@theia/notebook/lib/common';
+import { Disposable, URI } from '@theia/core';
+import { ModelAddedData, NotebookCellDto, NotebookCellsChangedEventDto, NotebookModelAddedData, NotebookOutputDto } from '../../common';
+import { DocumentsExtImpl } from '../documents';
+export declare class Cell {
+    readonly notebookDocument: NotebookDocument;
+    private readonly editorsAndDocuments;
+    private readonly cellData;
+    static asModelAddData(notebook: theia.NotebookDocument, cell: NotebookCellDto): ModelAddedData & {
+        notebook: theia.NotebookDocument;
+    };
+    private cell;
+    readonly handle: number;
+    readonly uri: URI;
+    readonly cellKind: notebookCommon.CellKind;
+    private outputs;
+    private metadata;
+    private previousResult;
+    internalMetadata: notebookCommon.NotebookCellInternalMetadata;
+    get language(): string;
+    constructor(notebookDocument: NotebookDocument, editorsAndDocuments: EditorsAndDocumentsExtImpl, cellData: rpc.NotebookCellDto);
+    get apiCell(): theia.NotebookCell;
+    setOutputs(newOutputs: NotebookOutputDto[]): void;
+    setMetadata(newMetadata: notebookCommon.NotebookCellMetadata): void;
+    setInternalMetadata(newInternalMetadata: notebookCommon.NotebookCellInternalMetadata): void;
+}
+export declare class NotebookDocument implements Disposable {
+    private readonly proxy;
+    private readonly editorsAndDocuments;
+    private readonly textDocuments;
+    readonly uri: theia.Uri;
+    private readonly cells;
+    private readonly notebookType;
+    private notebook?;
+    private metadata;
+    private versionId;
+    private isDirty;
+    private disposed;
+    constructor(proxy: rpc.NotebookDocumentsMain, editorsAndDocuments: EditorsAndDocumentsExtImpl, textDocuments: DocumentsExtImpl, uri: theia.Uri, notebookData: NotebookModelAddedData);
+    get apiNotebook(): theia.NotebookDocument;
+    private validateIndex;
+    private validateRange;
+    private getCells;
+    private save;
+    acceptDirty(isDirty: boolean): void;
+    acceptModelChanged(event: NotebookCellsChangedEventDto, isDirty: boolean, newMetadata: notebookCommon.NotebookDocumentMetadata | undefined): theia.NotebookDocumentChangeEvent;
+    private spliceNotebookCells;
+    private moveCells;
+    private setCellOutputs;
+    private changeCellLanguage;
+    private changeCellMetadata;
+    private changeCellInternalMetadata;
+    getCellFromApiCell(apiCell: theia.NotebookCell): Cell | undefined;
+    getCell(cellHandle: number): Cell | undefined;
+    getCellFromIndex(index: number): Cell | undefined;
+    getCellIndex(cell: Cell): number;
+    dispose(): void;
+}
 //# sourceMappingURL=notebook-document.d.ts.map