@theia/plugin-ext 1.67.0-next.56 → 1.67.0-next.86

package/lib/common/plugin-ext-api-contribution.d.ts

@@ -0,0 +1,89 @@
+import { RPCProtocol } from './rpc-protocol';
+import { PluginManager, Plugin } from './plugin-api-rpc';
+import { interfaces } from '@theia/core/shared/inversify';
+export declare const ExtPluginApiProvider = "extPluginApi";
+/**
+ * Provider for extension API description.
+ */
+export interface ExtPluginApiProvider {
+    /**
+     * Provide API description.
+     */
+    provideApi(): ExtPluginApi;
+}
+/**
+ * Provider for backend extension API description.
+ */
+export interface ExtPluginBackendApiProvider {
+    /**
+     * Provide API description.
+     */
+    provideApi(): ExtPluginBackendApi;
+}
+/**
+ * Provider for frontend extension API description.
+ */
+export interface ExtPluginFrontendApiProvider {
+    /**
+     * Provide API description.
+     */
+    provideApi(): ExtPluginFrontendApi;
+}
+/**
+ * Backend Plugin API extension description.
+ * This interface describes a script for the backend(NodeJs) runtime.
+ */
+export interface ExtPluginBackendApi {
+    /**
+     * Path to the script which should be loaded to provide api, module should export `provideApi` function with
+     * [ExtPluginApiBackendInitializationFn](#ExtPluginApiBackendInitializationFn) signature
+     */
+    backendInitPath?: string;
+}
+/**
+ * Frontend Plugin API extension description.
+ * This interface describes a script for the frontend(WebWorker) runtime.
+ */
+export interface ExtPluginFrontendApi {
+    /**
+     * Initialization information for frontend part of Plugin API
+     */
+    frontendExtApi?: FrontendExtPluginApi;
+}
+/**
+ * Plugin API extension description.
+ * This interface describes scripts for both plugin runtimes: frontend(WebWorker) and backend(NodeJs)
+ */
+export interface ExtPluginApi extends ExtPluginBackendApi, ExtPluginFrontendApi {
+}
+export interface ExtPluginApiFrontendInitializationFn {
+    (rpc: RPCProtocol, plugins: Map<string, Plugin>): void;
+}
+export interface ExtPluginApiBackendInitializationFn {
+    (rpc: RPCProtocol, pluginManager: PluginManager): void;
+}
+/**
+ * Interface contains information for frontend(WebWorker) Plugin API extension initialization
+ */
+export interface FrontendExtPluginApi {
+    /**
+     * path to js file
+     */
+    initPath: string;
+    /** global variable name */
+    initVariable: string;
+    /**
+     * init function name,
+     * function should have  [ExtPluginApiFrontendInitializationFn](#ExtPluginApiFrontendInitializationFn)
+     */
+    initFunction: string;
+}
+export declare const MainPluginApiProvider: unique symbol;
+/**
+ * Implementation should contains main(Theia) part of new namespace in Plugin API.
+ * [initialize](#initialize) will be called once per plugin runtime
+ */
+export interface MainPluginApiProvider {
+    initialize(rpc: RPCProtocol, container: interfaces.Container): void;
+}
+//# sourceMappingURL=plugin-ext-api-contribution.d.ts.map

package/lib/common/plugin-ext-api-contribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-ext-api-contribution.d.ts","sourceRoot":"","sources":["../../src/common/plugin-ext-api-contribution.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,eAAO,MAAM,oBAAoB,iBAAiB,CAAC;AACnD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,UAAU,IAAI,YAAY,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,UAAU,IAAI,mBAAmB,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,UAAU,IAAI,oBAAoB,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAEhC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IAEjC;;OAEG;IACH,cAAc,CAAC,EAAE,oBAAoB,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,mBAAmB,EAAE,oBAAoB;CAAI;AAEnF,MAAM,WAAW,oCAAoC;IACjD,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;CAC1D;AAED,MAAM,WAAW,mCAAmC;IAChD,CAAC,GAAG,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,eAAO,MAAM,qBAAqB,eAA0B,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,UAAU,CAAC,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC;CACvE"}

package/lib/common/plugin-ext-api-contribution.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MainPluginApiProvider = exports.ExtPluginApiProvider = void 0;
+exports.ExtPluginApiProvider = 'extPluginApi';
+exports.MainPluginApiProvider = Symbol('mainPluginApi');
+//# sourceMappingURL=plugin-ext-api-contribution.js.map

package/lib/common/plugin-ext-api-contribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-ext-api-contribution.js","sourceRoot":"","sources":["../../src/common/plugin-ext-api-contribution.ts"],"names":[],"mappings":";;;AAmBa,QAAA,oBAAoB,GAAG,cAAc,CAAC;AAuFtC,QAAA,qBAAqB,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC"}

package/lib/common/plugin-identifiers.d.ts

@@ -0,0 +1,47 @@
+export declare namespace PluginIdentifiers {
+    interface Components {
+        publisher?: string;
+        name: string;
+        version: string;
+    }
+    interface IdAndVersion {
+        id: UnversionedId;
+        version: string;
+    }
+    type VersionedId = `${string}.${string}@${string}`;
+    type UnversionedId = `${string}.${string}`;
+    /** Unpublished plugins (not from Open VSX or VSCode plugin store) may not have a `publisher` field. */
+    const UNPUBLISHED = "<unpublished>";
+    /**
+     * @returns a string in the format `<publisher>.<name>`
+     */
+    function componentsToUnversionedId({ publisher, name }: Components): UnversionedId;
+    /**
+     * @returns a string in the format `<publisher>.<name>@<version>`.
+     */
+    function componentsToVersionedId({ publisher, name, version }: Components): VersionedId;
+    function componentsToVersionWithId(components: Components): IdAndVersion;
+    /**
+     * @returns a string in the format `<id>@<version>`.
+     */
+    function idAndVersionToVersionedId({ id, version }: IdAndVersion): VersionedId;
+    /**
+     * @returns a string in the format `<publisher>.<name>`.
+     */
+    function unversionedFromVersioned(id: VersionedId): UnversionedId;
+    /**
+     * @returns a string in the format `<publisher>.<name>`.
+     *
+     * If the supplied ID does not include `@`, it will be returned in whole.
+     */
+    function toUnversioned(id: VersionedId | UnversionedId): UnversionedId;
+    /**
+     * @returns `undefined` if it looks like the string passed in does not have the format of {@link VersionedId}.
+     */
+    function identifiersFromVersionedId(probablyId: string): Components | undefined;
+    /**
+     * @returns `undefined` if it looks like the string passed in does not have the format of {@link VersionedId}.
+     */
+    function idAndVersionFromVersionedId(probablyId: string): IdAndVersion | undefined;
+}
+//# sourceMappingURL=plugin-identifiers.d.ts.map

package/lib/common/plugin-identifiers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-identifiers.d.ts","sourceRoot":"","sources":["../../src/common/plugin-identifiers.ts"],"names":[],"mappings":"AAgBA,yBAAiB,iBAAiB,CAAC;IAC/B,UAAiB,UAAU;QACvB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,YAAY;QACzB,EAAE,EAAE,aAAa,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;KACnB;IAED,KAAY,WAAW,GAAG,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;IAC1D,KAAY,aAAa,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAClD,uGAAuG;IAChG,MAAM,WAAW,kBAAkB,CAAC;IAE3C;;OAEG;IACH,SAAgB,yBAAyB,CAAC,EAAE,SAAuB,EAAE,IAAI,EAAE,EAAE,UAAU,GAAG,aAAa,CAEtG;IACD;;OAEG;IACH,SAAgB,uBAAuB,CAAC,EAAE,SAAuB,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,UAAU,GAAG,WAAW,CAE3G;IACD,SAAgB,yBAAyB,CAAC,UAAU,EAAE,UAAU,GAAG,YAAY,CAE9E;IACD;;OAEG;IACH,SAAgB,yBAAyB,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,YAAY,GAAG,WAAW,CAEpF;IACD;;OAEG;IACH,SAAgB,wBAAwB,CAAC,EAAE,EAAE,WAAW,GAAG,aAAa,CAEvE;IACD;;;;OAIG;IACH,SAAgB,aAAa,CAAC,EAAE,EAAE,WAAW,GAAG,aAAa,GAAG,aAAa,CAG5E;IACD;;OAEG;IACH,SAAgB,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAOrF;IACD;;OAEG;IACH,SAAgB,2BAA2B,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAOxF;CACJ"}

package/lib/common/plugin-identifiers.js

@@ -0,0 +1,90 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2022 Ericsson 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.PluginIdentifiers = void 0;
+var PluginIdentifiers;
+(function (PluginIdentifiers) {
+    /** Unpublished plugins (not from Open VSX or VSCode plugin store) may not have a `publisher` field. */
+    PluginIdentifiers.UNPUBLISHED = '<unpublished>';
+    /**
+     * @returns a string in the format `<publisher>.<name>`
+     */
+    function componentsToUnversionedId({ publisher = PluginIdentifiers.UNPUBLISHED, name }) {
+        return `${publisher.toLowerCase()}.${name.toLowerCase()}`;
+    }
+    PluginIdentifiers.componentsToUnversionedId = componentsToUnversionedId;
+    /**
+     * @returns a string in the format `<publisher>.<name>@<version>`.
+     */
+    function componentsToVersionedId({ publisher = PluginIdentifiers.UNPUBLISHED, name, version }) {
+        return `${publisher.toLowerCase()}.${name.toLowerCase()}@${version}`;
+    }
+    PluginIdentifiers.componentsToVersionedId = componentsToVersionedId;
+    function componentsToVersionWithId(components) {
+        return { id: componentsToUnversionedId(components), version: components.version };
+    }
+    PluginIdentifiers.componentsToVersionWithId = componentsToVersionWithId;
+    /**
+     * @returns a string in the format `<id>@<version>`.
+     */
+    function idAndVersionToVersionedId({ id, version }) {
+        return `${id}@${version}`;
+    }
+    PluginIdentifiers.idAndVersionToVersionedId = idAndVersionToVersionedId;
+    /**
+     * @returns a string in the format `<publisher>.<name>`.
+     */
+    function unversionedFromVersioned(id) {
+        return toUnversioned(id);
+    }
+    PluginIdentifiers.unversionedFromVersioned = unversionedFromVersioned;
+    /**
+     * @returns a string in the format `<publisher>.<name>`.
+     *
+     * If the supplied ID does not include `@`, it will be returned in whole.
+     */
+    function toUnversioned(id) {
+        const endOfId = id.indexOf('@');
+        return endOfId === -1 ? id : id.slice(0, endOfId);
+    }
+    PluginIdentifiers.toUnversioned = toUnversioned;
+    /**
+     * @returns `undefined` if it looks like the string passed in does not have the format of {@link VersionedId}.
+     */
+    function identifiersFromVersionedId(probablyId) {
+        const endOfPublisher = probablyId.indexOf('.');
+        const endOfName = probablyId.indexOf('@', endOfPublisher);
+        if (endOfPublisher === -1 || endOfName === -1) {
+            return undefined;
+        }
+        return { publisher: probablyId.slice(0, endOfPublisher), name: probablyId.slice(endOfPublisher + 1, endOfName), version: probablyId.slice(endOfName + 1) };
+    }
+    PluginIdentifiers.identifiersFromVersionedId = identifiersFromVersionedId;
+    /**
+     * @returns `undefined` if it looks like the string passed in does not have the format of {@link VersionedId}.
+     */
+    function idAndVersionFromVersionedId(probablyId) {
+        const endOfPublisher = probablyId.indexOf('.');
+        const endOfName = probablyId.indexOf('@', endOfPublisher);
+        if (endOfPublisher === -1 || endOfName === -1) {
+            return undefined;
+        }
+        return { id: probablyId.slice(0, endOfName), version: probablyId.slice(endOfName + 1) };
+    }
+    PluginIdentifiers.idAndVersionFromVersionedId = idAndVersionFromVersionedId;
+})(PluginIdentifiers || (exports.PluginIdentifiers = PluginIdentifiers = {}));
+//# sourceMappingURL=plugin-identifiers.js.map

package/lib/common/plugin-identifiers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-identifiers.js","sourceRoot":"","sources":["../../src/common/plugin-identifiers.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,0CAA0C;AAC1C,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,IAAiB,iBAAiB,CA2EjC;AA3ED,WAAiB,iBAAiB;IAc9B,uGAAuG;IAC1F,6BAAW,GAAG,eAAe,CAAC;IAE3C;;OAEG;IACH,SAAgB,yBAAyB,CAAC,EAAE,SAAS,GAAG,kBAAA,WAAW,EAAE,IAAI,EAAc;QACnF,OAAO,GAAG,SAAS,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;IAC9D,CAAC;IAFe,2CAAyB,4BAExC,CAAA;IACD;;OAEG;IACH,SAAgB,uBAAuB,CAAC,EAAE,SAAS,GAAG,kBAAA,WAAW,EAAE,IAAI,EAAE,OAAO,EAAc;QAC1F,OAAO,GAAG,SAAS,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE,IAAI,OAAO,EAAE,CAAC;IACzE,CAAC;IAFe,yCAAuB,0BAEtC,CAAA;IACD,SAAgB,yBAAyB,CAAC,UAAsB;QAC5D,OAAO,EAAE,EAAE,EAAE,yBAAyB,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC;IACtF,CAAC;IAFe,2CAAyB,4BAExC,CAAA;IACD;;OAEG;IACH,SAAgB,yBAAyB,CAAC,EAAE,EAAE,EAAE,OAAO,EAAgB;QACnE,OAAO,GAAG,EAAE,IAAI,OAAO,EAAE,CAAC;IAC9B,CAAC;IAFe,2CAAyB,4BAExC,CAAA;IACD;;OAEG;IACH,SAAgB,wBAAwB,CAAC,EAAe;QACpD,OAAO,aAAa,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAFe,0CAAwB,2BAEvC,CAAA;IACD;;;;OAIG;IACH,SAAgB,aAAa,CAAC,EAA+B;QACzD,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAChC,OAAO,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAkB,CAAC;IACvE,CAAC;IAHe,+BAAa,gBAG5B,CAAA;IACD;;OAEG;IACH,SAAgB,0BAA0B,CAAC,UAAkB;QACzD,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC1D,IAAI,cAAc,KAAK,CAAC,CAAC,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;YAC5C,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC;IAC/J,CAAC;IAPe,4CAA0B,6BAOzC,CAAA;IACD;;OAEG;IACH,SAAgB,2BAA2B,CAAC,UAAkB;QAC1D,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC1D,IAAI,cAAc,KAAK,CAAC,CAAC,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;YAC5C,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,EAAE,EAAE,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAkB,EAAE,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC;IAC7G,CAAC;IAPe,6CAA2B,8BAO1C,CAAA;AACL,CAAC,EA3EgB,iBAAiB,iCAAjB,iBAAiB,QA2EjC"}