@theia/plugin-ext 1.53.0-next.4 → 1.53.0-next.55

package/src/common/plugin-ext-api-contribution.ts

@@ -1,115 +1,115 @@
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. 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
-// *****************************************************************************
-import { RPCProtocol } from './rpc-protocol';
-import { PluginManager, Plugin } from './plugin-api-rpc';
-import { interfaces } from '@theia/core/shared/inversify';
-
-export 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 const MainPluginApiProvider = Symbol('mainPluginApi');
-
-/**
- * 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;
-}
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. 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
+// *****************************************************************************
+import { RPCProtocol } from './rpc-protocol';
+import { PluginManager, Plugin } from './plugin-api-rpc';
+import { interfaces } from '@theia/core/shared/inversify';
+
+export 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 const MainPluginApiProvider = Symbol('mainPluginApi');
+
+/**
+ * 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;
+}

package/src/common/plugin-identifiers.ts

@@ -1,84 +1,84 @@
-// *****************************************************************************
-// 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
-// *****************************************************************************
-
-export namespace PluginIdentifiers {
-    export interface Components {
-        publisher?: string;
-        name: string;
-        version: string;
-    }
-
-    export interface IdAndVersion {
-        id: UnversionedId;
-        version: string;
-    }
-
-    export type VersionedId = `${string}.${string}@${string}`;
-    export type UnversionedId = `${string}.${string}`;
-    /** Unpublished plugins (not from Open VSX or VSCode plugin store) may not have a `publisher` field. */
-    export const UNPUBLISHED = '<unpublished>';
-
-    /**
-     * @returns a string in the format `<publisher>.<name>`
-     */
-    export function componentsToUnversionedId({ publisher = UNPUBLISHED, name }: Components): UnversionedId {
-        return `${publisher.toLowerCase()}.${name.toLowerCase()}`;
-    }
-    /**
-     * @returns a string in the format `<publisher>.<name>@<version>`.
-     */
-    export function componentsToVersionedId({ publisher = UNPUBLISHED, name, version }: Components): VersionedId {
-        return `${publisher.toLowerCase()}.${name.toLowerCase()}@${version}`;
-    }
-    export function componentsToVersionWithId(components: Components): IdAndVersion {
-        return { id: componentsToUnversionedId(components), version: components.version };
-    }
-    /**
-     * @returns a string in the format `<id>@<version>`.
-     */
-    export function idAndVersionToVersionedId({ id, version }: IdAndVersion): VersionedId {
-        return `${id}@${version}`;
-    }
-    /**
-     * @returns a string in the format `<publisher>.<name>`.
-     */
-    export function unversionedFromVersioned(id: VersionedId): UnversionedId {
-        const endOfId = id.indexOf('@');
-        return id.slice(0, endOfId) as UnversionedId;
-    }
-    /**
-     * @returns `undefined` if it looks like the string passed in does not have the format returned by {@link PluginIdentifiers.toVersionedId}.
-     */
-    export function identifiersFromVersionedId(probablyId: string): Components | undefined {
-        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) };
-    }
-    /**
-     * @returns `undefined` if it looks like the string passed in does not have the format returned by {@link PluginIdentifiers.toVersionedId}.
-     */
-    export function idAndVersionFromVersionedId(probablyId: string): IdAndVersion | undefined {
-        const endOfPublisher = probablyId.indexOf('.');
-        const endOfName = probablyId.indexOf('@', endOfPublisher);
-        if (endOfPublisher === -1 || endOfName === -1) {
-            return undefined;
-        }
-        return { id: probablyId.slice(0, endOfName) as UnversionedId, version: probablyId.slice(endOfName + 1) };
-    }
-}
+// *****************************************************************************
+// 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
+// *****************************************************************************
+
+export namespace PluginIdentifiers {
+    export interface Components {
+        publisher?: string;
+        name: string;
+        version: string;
+    }
+
+    export interface IdAndVersion {
+        id: UnversionedId;
+        version: string;
+    }
+
+    export type VersionedId = `${string}.${string}@${string}`;
+    export type UnversionedId = `${string}.${string}`;
+    /** Unpublished plugins (not from Open VSX or VSCode plugin store) may not have a `publisher` field. */
+    export const UNPUBLISHED = '<unpublished>';
+
+    /**
+     * @returns a string in the format `<publisher>.<name>`
+     */
+    export function componentsToUnversionedId({ publisher = UNPUBLISHED, name }: Components): UnversionedId {
+        return `${publisher.toLowerCase()}.${name.toLowerCase()}`;
+    }
+    /**
+     * @returns a string in the format `<publisher>.<name>@<version>`.
+     */
+    export function componentsToVersionedId({ publisher = UNPUBLISHED, name, version }: Components): VersionedId {
+        return `${publisher.toLowerCase()}.${name.toLowerCase()}@${version}`;
+    }
+    export function componentsToVersionWithId(components: Components): IdAndVersion {
+        return { id: componentsToUnversionedId(components), version: components.version };
+    }
+    /**
+     * @returns a string in the format `<id>@<version>`.
+     */
+    export function idAndVersionToVersionedId({ id, version }: IdAndVersion): VersionedId {
+        return `${id}@${version}`;
+    }
+    /**
+     * @returns a string in the format `<publisher>.<name>`.
+     */
+    export function unversionedFromVersioned(id: VersionedId): UnversionedId {
+        const endOfId = id.indexOf('@');
+        return id.slice(0, endOfId) as UnversionedId;
+    }
+    /**
+     * @returns `undefined` if it looks like the string passed in does not have the format returned by {@link PluginIdentifiers.toVersionedId}.
+     */
+    export function identifiersFromVersionedId(probablyId: string): Components | undefined {
+        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) };
+    }
+    /**
+     * @returns `undefined` if it looks like the string passed in does not have the format returned by {@link PluginIdentifiers.toVersionedId}.
+     */
+    export function idAndVersionFromVersionedId(probablyId: string): IdAndVersion | undefined {
+        const endOfPublisher = probablyId.indexOf('.');
+        const endOfName = probablyId.indexOf('@', endOfPublisher);
+        if (endOfPublisher === -1 || endOfName === -1) {
+            return undefined;
+        }
+        return { id: probablyId.slice(0, endOfName) as UnversionedId, version: probablyId.slice(endOfName + 1) };
+    }
+}