-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
plugin-ext-api-contribution.ts
82 lines (73 loc) · 2.73 KB
/
plugin-ext-api-contribution.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
// *****************************************************************************
// 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 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;
}
/**
* Plugin API extension description.
* This interface describes scripts for both plugin runtimes: frontend(WebWorker) and backend(NodeJs)
*/
export interface ExtPluginApi {
/**
* Path to the script which should be loaded to provide api, module should export `provideApi` function with
* [ExtPluginApiBackendInitializationFn](#ExtPluginApiBackendInitializationFn) signature
*/
backendInitPath?: string;
/**
* Initialization information for frontend part of Plugin API
*/
frontendExtApi?: FrontendExtPluginApi;
}
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;
}