@theia/core
Version:
Theia is a cloud & desktop IDE framework implemented in TypeScript.
82 lines • 3.61 kB
JavaScript
;
// *****************************************************************************
// Copyright (C) 2018 TypeFox 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.ConnectionContainerModule = void 0;
/* eslint-disable @typescript-eslint/no-explicit-any */
const inversify_1 = require("inversify");
const common_1 = require("../../common");
/**
* ### Connection Container Module
*
* It provides bindings which are scoped per a connection, e.g.
* in order to allow backend services to access frontend service within the same connection.
*
* #### Binding a frontend service
* ```ts
* const myConnectionModule = ConnectionContainerModule.create(({ bindFrontendService }) => {
* bindFrontendService(myFrontendServicePath, MyFrontendService);
* });
*
* export const myBackendApplicationModule = new ContainerModule(bind => {
* bind(ConnectionContainerModule).toConstantValue(myConnectionModule);
* }
* ```
*
* #### Exposing a backend service
* ```ts
* const myConnectionModule2 = ConnectionContainerModule.create(({ bind, bindBackendService }) => {
* bind(MyBackendService).toSelf().inSingletonScope();
* bindBackendService(myBackendServicePath, MyBackendService);
* });
*
* export const myBackendApplicationModule2 = new ContainerModule(bind => {
* bind(ConnectionContainerModule).toConstantValue(myConnectionModule2);
* }
* ```
*
* #### Injecting a frontend service
* ```ts
* @injectable()
* export class MyBackendService {
* @inject(MyFrontendService)
* protected readonly myFrontendService: MyFrontendService;
* }
* ```
*/
exports.ConnectionContainerModule = Object.assign(Symbol('ConnectionContainerModule'), {
create(callback) {
return new inversify_1.ContainerModule((bind, unbind, isBound, rebind) => {
const bindFrontendService = (path, serviceIdentifier) => {
const serviceFactory = new common_1.RpcProxyFactory();
const service = serviceFactory.createProxy();
bind(common_1.ConnectionHandler).toConstantValue({
path,
onConnection: connection => serviceFactory.listen(connection)
});
return bind(serviceIdentifier).toConstantValue(service);
};
const bindBackendService = (path, serviceIdentifier, onActivation) => {
bind(common_1.ConnectionHandler).toDynamicValue(context => new common_1.RpcConnectionHandler(path, proxy => {
const service = context.container.get(serviceIdentifier);
return onActivation ? onActivation(service, proxy) : service;
})).inSingletonScope();
};
callback({ bind, unbind, isBound, rebind, bindFrontendService, bindBackendService });
});
}
});
//# sourceMappingURL=connection-container-module.js.map