@backstage/backend-plugin-api 0.1.0-next.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +32 -0
- package/alpha/package.json +1 -1
- package/dist/index.alpha.d.ts +17 -17
- package/dist/index.beta.d.ts +17 -17
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +17 -17
- package/package.json +6 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,37 @@
|
|
|
1
1
|
# @backstage/backend-plugin-api
|
|
2
2
|
|
|
3
|
+
## 0.1.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 0599732ec0: Refactored experimental backend system with new type names.
|
|
8
|
+
- 34c2f5aca1: The factory returned by `createBackendPlugin` and `createBackendModule` no longer require a parameter to be passed if the options are optional.
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
- @backstage/backend-common@0.15.0
|
|
11
|
+
- @backstage/backend-tasks@0.3.4
|
|
12
|
+
|
|
13
|
+
## 0.1.1-next.0
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- Updated dependencies
|
|
18
|
+
- @backstage/backend-common@0.15.0-next.0
|
|
19
|
+
- @backstage/backend-tasks@0.3.4-next.0
|
|
20
|
+
|
|
21
|
+
## 0.1.0
|
|
22
|
+
|
|
23
|
+
### Minor Changes
|
|
24
|
+
|
|
25
|
+
- 91c1d12123: Introduced new package for creating backend plugins using the new alpha backend plugin framework.
|
|
26
|
+
This package is still considered **EXPERIMENTAL** and things will change without warning. Do not use this for production.
|
|
27
|
+
|
|
28
|
+
### Patch Changes
|
|
29
|
+
|
|
30
|
+
- Updated dependencies
|
|
31
|
+
- @backstage/backend-common@0.14.1
|
|
32
|
+
- @backstage/plugin-permission-common@0.6.3
|
|
33
|
+
- @backstage/backend-tasks@0.3.3
|
|
34
|
+
|
|
3
35
|
## 0.1.0-next.0
|
|
4
36
|
|
|
5
37
|
### Minor Changes
|
package/alpha/package.json
CHANGED
package/dist/index.alpha.d.ts
CHANGED
|
@@ -23,35 +23,35 @@ export declare type AnyServiceFactory = ServiceFactory<unknown, unknown, {
|
|
|
23
23
|
}>;
|
|
24
24
|
|
|
25
25
|
/** @public */
|
|
26
|
-
export declare interface
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
[name in string]: unknown;
|
|
30
|
-
}>(options: {
|
|
31
|
-
deps: {
|
|
32
|
-
[name in keyof Deps]: ServiceRef<Deps[name]>;
|
|
33
|
-
};
|
|
34
|
-
init: (deps: Deps) => Promise<void>;
|
|
35
|
-
}): void;
|
|
26
|
+
export declare interface BackendFeature {
|
|
27
|
+
id: string;
|
|
28
|
+
register(reg: BackendRegistrationPoints): void;
|
|
36
29
|
}
|
|
37
30
|
|
|
38
31
|
/** @public */
|
|
39
32
|
export declare interface BackendModuleConfig<TOptions> {
|
|
40
33
|
pluginId: string;
|
|
41
34
|
moduleId: string;
|
|
42
|
-
register(reg: Omit<
|
|
35
|
+
register(reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>, options: TOptions): void;
|
|
43
36
|
}
|
|
44
37
|
|
|
45
38
|
/** @public */
|
|
46
39
|
export declare interface BackendPluginConfig<TOptions> {
|
|
47
40
|
id: string;
|
|
48
|
-
register(reg:
|
|
41
|
+
register(reg: BackendRegistrationPoints, options: TOptions): void;
|
|
49
42
|
}
|
|
50
43
|
|
|
51
44
|
/** @public */
|
|
52
|
-
export declare interface
|
|
53
|
-
|
|
54
|
-
|
|
45
|
+
export declare interface BackendRegistrationPoints {
|
|
46
|
+
registerExtensionPoint<TExtensionPoint>(ref: ExtensionPoint<TExtensionPoint>, impl: TExtensionPoint): void;
|
|
47
|
+
registerInit<Deps extends {
|
|
48
|
+
[name in string]: unknown;
|
|
49
|
+
}>(options: {
|
|
50
|
+
deps: {
|
|
51
|
+
[name in keyof Deps]: ServiceRef<Deps[name]> | ExtensionPoint<Deps[name]>;
|
|
52
|
+
};
|
|
53
|
+
init(deps: Deps): Promise<void>;
|
|
54
|
+
}): void;
|
|
55
55
|
}
|
|
56
56
|
|
|
57
57
|
/**
|
|
@@ -65,10 +65,10 @@ export declare const cacheServiceRef: ServiceRef<PluginCacheManager>;
|
|
|
65
65
|
export declare const configServiceRef: ServiceRef<Config>;
|
|
66
66
|
|
|
67
67
|
/** @public */
|
|
68
|
-
export declare function createBackendModule<TOptions>(config: BackendModuleConfig<TOptions>): (
|
|
68
|
+
export declare function createBackendModule<TOptions>(config: BackendModuleConfig<TOptions>): undefined extends TOptions ? (options?: TOptions) => BackendFeature : (options: TOptions) => BackendFeature;
|
|
69
69
|
|
|
70
70
|
/** @public */
|
|
71
|
-
export declare function createBackendPlugin<TOptions>(config: BackendPluginConfig<TOptions>): (
|
|
71
|
+
export declare function createBackendPlugin<TOptions>(config: BackendPluginConfig<TOptions>): undefined extends TOptions ? (options?: TOptions) => BackendFeature : (options: TOptions) => BackendFeature;
|
|
72
72
|
|
|
73
73
|
/** @public */
|
|
74
74
|
export declare function createExtensionPoint<T>(options: {
|
package/dist/index.beta.d.ts
CHANGED
|
@@ -23,35 +23,35 @@ export declare type AnyServiceFactory = ServiceFactory<unknown, unknown, {
|
|
|
23
23
|
}>;
|
|
24
24
|
|
|
25
25
|
/** @public */
|
|
26
|
-
export declare interface
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
[name in string]: unknown;
|
|
30
|
-
}>(options: {
|
|
31
|
-
deps: {
|
|
32
|
-
[name in keyof Deps]: ServiceRef<Deps[name]>;
|
|
33
|
-
};
|
|
34
|
-
init: (deps: Deps) => Promise<void>;
|
|
35
|
-
}): void;
|
|
26
|
+
export declare interface BackendFeature {
|
|
27
|
+
id: string;
|
|
28
|
+
register(reg: BackendRegistrationPoints): void;
|
|
36
29
|
}
|
|
37
30
|
|
|
38
31
|
/** @public */
|
|
39
32
|
export declare interface BackendModuleConfig<TOptions> {
|
|
40
33
|
pluginId: string;
|
|
41
34
|
moduleId: string;
|
|
42
|
-
register(reg: Omit<
|
|
35
|
+
register(reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>, options: TOptions): void;
|
|
43
36
|
}
|
|
44
37
|
|
|
45
38
|
/** @public */
|
|
46
39
|
export declare interface BackendPluginConfig<TOptions> {
|
|
47
40
|
id: string;
|
|
48
|
-
register(reg:
|
|
41
|
+
register(reg: BackendRegistrationPoints, options: TOptions): void;
|
|
49
42
|
}
|
|
50
43
|
|
|
51
44
|
/** @public */
|
|
52
|
-
export declare interface
|
|
53
|
-
|
|
54
|
-
|
|
45
|
+
export declare interface BackendRegistrationPoints {
|
|
46
|
+
registerExtensionPoint<TExtensionPoint>(ref: ExtensionPoint<TExtensionPoint>, impl: TExtensionPoint): void;
|
|
47
|
+
registerInit<Deps extends {
|
|
48
|
+
[name in string]: unknown;
|
|
49
|
+
}>(options: {
|
|
50
|
+
deps: {
|
|
51
|
+
[name in keyof Deps]: ServiceRef<Deps[name]> | ExtensionPoint<Deps[name]>;
|
|
52
|
+
};
|
|
53
|
+
init(deps: Deps): Promise<void>;
|
|
54
|
+
}): void;
|
|
55
55
|
}
|
|
56
56
|
|
|
57
57
|
/**
|
|
@@ -65,10 +65,10 @@ export declare const cacheServiceRef: ServiceRef<PluginCacheManager>;
|
|
|
65
65
|
export declare const configServiceRef: ServiceRef<Config>;
|
|
66
66
|
|
|
67
67
|
/** @public */
|
|
68
|
-
export declare function createBackendModule<TOptions>(config: BackendModuleConfig<TOptions>): (
|
|
68
|
+
export declare function createBackendModule<TOptions>(config: BackendModuleConfig<TOptions>): undefined extends TOptions ? (options?: TOptions) => BackendFeature : (options: TOptions) => BackendFeature;
|
|
69
69
|
|
|
70
70
|
/** @public */
|
|
71
|
-
export declare function createBackendPlugin<TOptions>(config: BackendPluginConfig<TOptions>): (
|
|
71
|
+
export declare function createBackendPlugin<TOptions>(config: BackendPluginConfig<TOptions>): undefined extends TOptions ? (options?: TOptions) => BackendFeature : (options: TOptions) => BackendFeature;
|
|
72
72
|
|
|
73
73
|
/** @public */
|
|
74
74
|
export declare function createExtensionPoint<T>(options: {
|
package/dist/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/services/system/types.ts","../src/services/definitions/configServiceRef.ts","../src/services/definitions/httpRouterServiceRef.ts","../src/services/definitions/loggerServiceRef.ts","../src/services/definitions/urlReaderServiceRef.ts","../src/services/definitions/cacheServiceRef.ts","../src/services/definitions/databaseServiceRef.ts","../src/services/definitions/discoveryServiceRef.ts","../src/services/definitions/tokenManagerServiceRef.ts","../src/services/definitions/permissionsServiceRef.ts","../src/services/definitions/schedulerServiceRef.ts","../src/services/helpers/loggerToWinstonLogger.ts","../src/wiring/types.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * TODO\n *\n * @public\n */\nexport type ServiceRef<T> = {\n id: string;\n\n /**\n * Utility for getting the type of the service, using `typeof serviceRef.T`.\n * Attempting to actually read this value will result in an exception.\n */\n T: T;\n\n toString(): string;\n\n $$ref: 'service';\n};\n\n/** @public */\nexport type TypesToServiceRef<T> = { [key in keyof T]: ServiceRef<T[key]> };\n\n/** @public */\nexport type DepsToDepFactories<T> = {\n [key in keyof T]: (pluginId: string) => Promise<T[key]>;\n};\n\n/** @public */\nexport type FactoryFunc<Impl> = (pluginId: string) => Promise<Impl>;\n\n/** @public */\nexport type ServiceFactory<\n TApi,\n TImpl extends TApi,\n TDeps extends { [name in string]: unknown },\n> = {\n service: ServiceRef<TApi>;\n deps: TypesToServiceRef<TDeps>;\n factory(deps: DepsToDepFactories<TDeps>): Promise<FactoryFunc<TImpl>>;\n};\n\n/** @public */\nexport type AnyServiceFactory = ServiceFactory<\n unknown,\n unknown,\n { [key in string]: unknown }\n>;\n\n/**\n * @public\n */\nexport function createServiceRef<T>(options: { id: string }): ServiceRef<T> {\n return {\n id: options.id,\n get T(): T {\n throw new Error(`tried to read ServiceRef.T of ${this}`);\n },\n toString() {\n return `serviceRef{${options.id}}`;\n },\n $$ref: 'service', // TODO: declare\n };\n}\n\n/**\n * @public\n */\nexport function createServiceFactory<\n Api,\n Impl extends Api,\n Deps extends { [name in string]: unknown },\n>(factory: ServiceFactory<Api, Impl, Deps>): ServiceFactory<Api, Api, {}> {\n return factory;\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport const configServiceRef = createServiceRef<Config>({\n id: 'core.config',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { Handler } from 'express';\n\n/**\n * @public\n */\nexport interface HttpRouterService {\n use(handler: Handler): void;\n}\n\n/**\n * @public\n */\nexport const httpRouterServiceRef = createServiceRef<HttpRouterService>({\n id: 'core.httpRouter',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport interface Logger {\n info(message: string): void;\n child(fields: { [name: string]: string }): Logger;\n}\n\n/**\n * @public\n */\nexport const loggerServiceRef = createServiceRef<Logger>({\n id: 'core.logger',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { UrlReader } from '@backstage/backend-common';\n\n/**\n * @public\n */\nexport const urlReaderServiceRef = createServiceRef<UrlReader>({\n id: 'core.urlReader',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginCacheManager } from '@backstage/backend-common';\n\n/**\n * @public\n */\nexport const cacheServiceRef = createServiceRef<PluginCacheManager>({\n id: 'core.cache',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PluginDatabaseManager } from '@backstage/backend-common';\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport const databaseServiceRef = createServiceRef<PluginDatabaseManager>({\n id: 'core.database',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginEndpointDiscovery } from '@backstage/backend-common';\n\n/**\n * @public\n */\nexport const discoveryServiceRef = createServiceRef<PluginEndpointDiscovery>({\n id: 'core.discovery',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { TokenManager } from '@backstage/backend-common';\n\n/**\n * @public\n */\nexport const tokenManagerServiceRef = createServiceRef<TokenManager>({\n id: 'core.tokenManager',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport {\n PermissionAuthorizer,\n PermissionEvaluator,\n} from '@backstage/plugin-permission-common';\n\n/**\n * @public\n */\nexport const permissionsServiceRef = createServiceRef<\n PermissionEvaluator | PermissionAuthorizer\n>({\n id: 'core.permissions',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginTaskScheduler } from '@backstage/backend-tasks';\n\n/**\n * @public\n */\nexport const schedulerServiceRef = createServiceRef<PluginTaskScheduler>({\n id: 'core.scheduler',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Logger as BackstageLogger } from '../definitions';\nimport { Logger as WinstonLogger, createLogger } from 'winston';\nimport Transport, { TransportStreamOptions } from 'winston-transport';\n\nclass BackstageLoggerTransport extends Transport {\n constructor(\n private readonly backstageLogger: BackstageLogger,\n opts?: TransportStreamOptions,\n ) {\n super(opts);\n }\n\n log(info: { message: string }, callback: VoidFunction) {\n // TODO: add support for levels and fields\n this.backstageLogger.info(info.message);\n callback();\n }\n}\n\n/** @public */\nexport function loggerToWinstonLogger(\n logger: BackstageLogger,\n opts?: TransportStreamOptions,\n): WinstonLogger {\n return createLogger({\n transports: [new BackstageLoggerTransport(logger, opts)],\n });\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ServiceRef } from '../services/system/types';\n\n/**\n * TODO\n *\n * @public\n */\nexport type ExtensionPoint<T> = {\n id: string;\n\n /**\n * Utility for getting the type of the extension point, using `typeof extensionPoint.T`.\n * Attempting to actually read this value will result in an exception.\n */\n T: T;\n\n toString(): string;\n\n $$ref: 'extension-point';\n};\n\n/** @public */\nexport function createExtensionPoint<T>(options: {\n id: string;\n}): ExtensionPoint<T> {\n return {\n id: options.id,\n get T(): T {\n throw new Error(`tried to read ExtensionPoint.T of ${this}`);\n },\n toString() {\n return `extensionPoint{${options.id}}`;\n },\n $$ref: 'extension-point', // TODO: declare\n };\n}\n\n/** @public */\nexport interface BackendInitRegistry {\n registerExtensionPoint<TExtensionPoint>(\n ref: ServiceRef<TExtensionPoint>,\n impl: TExtensionPoint,\n ): void;\n registerInit<Deps extends { [name in string]: unknown }>(options: {\n deps: { [name in keyof Deps]: ServiceRef<Deps[name]> };\n init: (deps: Deps) => Promise<void>;\n }): void;\n}\n\n/** @public */\nexport interface BackendRegistrable {\n id: string;\n register(reg: BackendInitRegistry): void;\n}\n\n/** @public */\nexport interface BackendPluginConfig<TOptions> {\n id: string;\n register(reg: BackendInitRegistry, options: TOptions): void;\n}\n\n// TODO: Make option optional in the returned factory if they are indeed optional\n/** @public */\nexport function createBackendPlugin<TOptions>(\n config: BackendPluginConfig<TOptions>,\n): (option: TOptions) => BackendRegistrable {\n return options => ({\n id: config.id,\n register(register) {\n return config.register(register, options);\n },\n });\n}\n\n/** @public */\nexport interface BackendModuleConfig<TOptions> {\n pluginId: string;\n moduleId: string;\n register(\n reg: Omit<BackendInitRegistry, 'registerExtensionPoint'>,\n options: TOptions,\n ): void;\n}\n\n// TODO: Make option optional in the returned factory if they are indeed optional\n/** @public */\nexport function createBackendModule<TOptions>(\n config: BackendModuleConfig<TOptions>,\n): (option: TOptions) => BackendRegistrable {\n return options => ({\n id: `${config.pluginId}.${config.moduleId}`,\n register(register) {\n // TODO: Hide registerExtensionPoint\n return config.register(register, options);\n },\n });\n}\n"],"names":["Transport","createLogger"],"mappings":";;;;;;;;;;;AAAO,SAAS,gBAAgB,CAAC,OAAO,EAAE;AAC1C,EAAE,OAAO;AACT,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE;AAClB,IAAI,IAAI,CAAC,GAAG;AACZ,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,8BAA8B,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAC/D,KAAK;AACL,IAAI,QAAQ,GAAG;AACf,MAAM,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACzC,KAAK;AACL,IAAI,KAAK,EAAE,SAAS;AACpB,GAAG,CAAC;AACJ,CAAC;AACM,SAAS,oBAAoB,CAAC,OAAO,EAAE;AAC9C,EAAE,OAAO,OAAO,CAAC;AACjB;;ACbY,MAAC,gBAAgB,GAAG,gBAAgB,CAAC;AACjD,EAAE,EAAE,EAAE,aAAa;AACnB,CAAC;;ACFW,MAAC,oBAAoB,GAAG,gBAAgB,CAAC;AACrD,EAAE,EAAE,EAAE,iBAAiB;AACvB,CAAC;;ACFW,MAAC,gBAAgB,GAAG,gBAAgB,CAAC;AACjD,EAAE,EAAE,EAAE,aAAa;AACnB,CAAC;;ACFW,MAAC,mBAAmB,GAAG,gBAAgB,CAAC;AACpD,EAAE,EAAE,EAAE,gBAAgB;AACtB,CAAC;;ACFW,MAAC,eAAe,GAAG,gBAAgB,CAAC;AAChD,EAAE,EAAE,EAAE,YAAY;AAClB,CAAC;;ACFW,MAAC,kBAAkB,GAAG,gBAAgB,CAAC;AACnD,EAAE,EAAE,EAAE,eAAe;AACrB,CAAC;;ACFW,MAAC,mBAAmB,GAAG,gBAAgB,CAAC;AACpD,EAAE,EAAE,EAAE,gBAAgB;AACtB,CAAC;;ACFW,MAAC,sBAAsB,GAAG,gBAAgB,CAAC;AACvD,EAAE,EAAE,EAAE,mBAAmB;AACzB,CAAC;;ACFW,MAAC,qBAAqB,GAAG,gBAAgB,CAAC;AACtD,EAAE,EAAE,EAAE,kBAAkB;AACxB,CAAC;;ACFW,MAAC,mBAAmB,GAAG,gBAAgB,CAAC;AACpD,EAAE,EAAE,EAAE,gBAAgB;AACtB,CAAC;;ACDD,MAAM,wBAAwB,SAASA,6BAAS,CAAC;AACjD,EAAE,WAAW,CAAC,eAAe,EAAE,IAAI,EAAE;AACrC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;AAChB,IAAI,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;AAC3C,GAAG;AACH,EAAE,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE;AACtB,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC5C,IAAI,QAAQ,EAAE,CAAC;AACf,GAAG;AACH,CAAC;AACM,SAAS,qBAAqB,CAAC,MAAM,EAAE,IAAI,EAAE;AACpD,EAAE,OAAOC,oBAAY,CAAC;AACtB,IAAI,UAAU,EAAE,CAAC,IAAI,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC5D,GAAG,CAAC,CAAC;AACL;;AChBO,SAAS,oBAAoB,CAAC,OAAO,EAAE;AAC9C,EAAE,OAAO;AACT,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE;AAClB,IAAI,IAAI,CAAC,GAAG;AACZ,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,kCAAkC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACnE,KAAK;AACL,IAAI,QAAQ,GAAG;AACf,MAAM,OAAO,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC7C,KAAK;AACL,IAAI,KAAK,EAAE,iBAAiB;AAC5B,GAAG,CAAC;AACJ,CAAC;AACM,SAAS,mBAAmB,CAAC,MAAM,EAAE;AAC5C,EAAE,OAAO,CAAC,OAAO,MAAM;AACvB,IAAI,EAAE,EAAE,MAAM,CAAC,EAAE;AACjB,IAAI,QAAQ,CAAC,QAAQ,EAAE;AACvB,MAAM,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAChD,KAAK;AACL,GAAG,CAAC,CAAC;AACL,CAAC;AACM,SAAS,mBAAmB,CAAC,MAAM,EAAE;AAC5C,EAAE,OAAO,CAAC,OAAO,MAAM;AACvB,IAAI,EAAE,EAAE,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC/C,IAAI,QAAQ,CAAC,QAAQ,EAAE;AACvB,MAAM,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAChD,KAAK;AACL,GAAG,CAAC,CAAC;AACL;;;;;;;;;;;;;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../src/services/system/types.ts","../src/services/definitions/configServiceRef.ts","../src/services/definitions/httpRouterServiceRef.ts","../src/services/definitions/loggerServiceRef.ts","../src/services/definitions/urlReaderServiceRef.ts","../src/services/definitions/cacheServiceRef.ts","../src/services/definitions/databaseServiceRef.ts","../src/services/definitions/discoveryServiceRef.ts","../src/services/definitions/tokenManagerServiceRef.ts","../src/services/definitions/permissionsServiceRef.ts","../src/services/definitions/schedulerServiceRef.ts","../src/services/helpers/loggerToWinstonLogger.ts","../src/wiring/factories.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * TODO\n *\n * @public\n */\nexport type ServiceRef<T> = {\n id: string;\n\n /**\n * Utility for getting the type of the service, using `typeof serviceRef.T`.\n * Attempting to actually read this value will result in an exception.\n */\n T: T;\n\n toString(): string;\n\n $$ref: 'service';\n};\n\n/** @public */\nexport type TypesToServiceRef<T> = { [key in keyof T]: ServiceRef<T[key]> };\n\n/** @public */\nexport type DepsToDepFactories<T> = {\n [key in keyof T]: (pluginId: string) => Promise<T[key]>;\n};\n\n/** @public */\nexport type FactoryFunc<Impl> = (pluginId: string) => Promise<Impl>;\n\n/** @public */\nexport type ServiceFactory<\n TApi,\n TImpl extends TApi,\n TDeps extends { [name in string]: unknown },\n> = {\n service: ServiceRef<TApi>;\n deps: TypesToServiceRef<TDeps>;\n factory(deps: DepsToDepFactories<TDeps>): Promise<FactoryFunc<TImpl>>;\n};\n\n/** @public */\nexport type AnyServiceFactory = ServiceFactory<\n unknown,\n unknown,\n { [key in string]: unknown }\n>;\n\n/**\n * @public\n */\nexport function createServiceRef<T>(options: { id: string }): ServiceRef<T> {\n return {\n id: options.id,\n get T(): T {\n throw new Error(`tried to read ServiceRef.T of ${this}`);\n },\n toString() {\n return `serviceRef{${options.id}}`;\n },\n $$ref: 'service', // TODO: declare\n };\n}\n\n/**\n * @public\n */\nexport function createServiceFactory<\n Api,\n Impl extends Api,\n Deps extends { [name in string]: unknown },\n>(factory: ServiceFactory<Api, Impl, Deps>): ServiceFactory<Api, Api, {}> {\n return factory;\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport const configServiceRef = createServiceRef<Config>({\n id: 'core.config',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { Handler } from 'express';\n\n/**\n * @public\n */\nexport interface HttpRouterService {\n use(handler: Handler): void;\n}\n\n/**\n * @public\n */\nexport const httpRouterServiceRef = createServiceRef<HttpRouterService>({\n id: 'core.httpRouter',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport interface Logger {\n info(message: string): void;\n child(fields: { [name: string]: string }): Logger;\n}\n\n/**\n * @public\n */\nexport const loggerServiceRef = createServiceRef<Logger>({\n id: 'core.logger',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { UrlReader } from '@backstage/backend-common';\n\n/**\n * @public\n */\nexport const urlReaderServiceRef = createServiceRef<UrlReader>({\n id: 'core.urlReader',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginCacheManager } from '@backstage/backend-common';\n\n/**\n * @public\n */\nexport const cacheServiceRef = createServiceRef<PluginCacheManager>({\n id: 'core.cache',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PluginDatabaseManager } from '@backstage/backend-common';\nimport { createServiceRef } from '../system/types';\n\n/**\n * @public\n */\nexport const databaseServiceRef = createServiceRef<PluginDatabaseManager>({\n id: 'core.database',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginEndpointDiscovery } from '@backstage/backend-common';\n\n/**\n * @public\n */\nexport const discoveryServiceRef = createServiceRef<PluginEndpointDiscovery>({\n id: 'core.discovery',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { TokenManager } from '@backstage/backend-common';\n\n/**\n * @public\n */\nexport const tokenManagerServiceRef = createServiceRef<TokenManager>({\n id: 'core.tokenManager',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport {\n PermissionAuthorizer,\n PermissionEvaluator,\n} from '@backstage/plugin-permission-common';\n\n/**\n * @public\n */\nexport const permissionsServiceRef = createServiceRef<\n PermissionEvaluator | PermissionAuthorizer\n>({\n id: 'core.permissions',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createServiceRef } from '../system/types';\nimport { PluginTaskScheduler } from '@backstage/backend-tasks';\n\n/**\n * @public\n */\nexport const schedulerServiceRef = createServiceRef<PluginTaskScheduler>({\n id: 'core.scheduler',\n});\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Logger as BackstageLogger } from '../definitions';\nimport { Logger as WinstonLogger, createLogger } from 'winston';\nimport Transport, { TransportStreamOptions } from 'winston-transport';\n\nclass BackstageLoggerTransport extends Transport {\n constructor(\n private readonly backstageLogger: BackstageLogger,\n opts?: TransportStreamOptions,\n ) {\n super(opts);\n }\n\n log(info: { message: string }, callback: VoidFunction) {\n // TODO: add support for levels and fields\n this.backstageLogger.info(info.message);\n callback();\n }\n}\n\n/** @public */\nexport function loggerToWinstonLogger(\n logger: BackstageLogger,\n opts?: TransportStreamOptions,\n): WinstonLogger {\n return createLogger({\n transports: [new BackstageLoggerTransport(logger, opts)],\n });\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n BackendRegistrationPoints,\n BackendFeature,\n ExtensionPoint,\n} from './types';\n\n/** @public */\nexport function createExtensionPoint<T>(options: {\n id: string;\n}): ExtensionPoint<T> {\n return {\n id: options.id,\n get T(): T {\n throw new Error(`tried to read ExtensionPoint.T of ${this}`);\n },\n toString() {\n return `extensionPoint{${options.id}}`;\n },\n $$ref: 'extension-point', // TODO: declare\n };\n}\n\n/** @public */\nexport interface BackendPluginConfig<TOptions> {\n id: string;\n register(reg: BackendRegistrationPoints, options: TOptions): void;\n}\n\n/** @public */\nexport function createBackendPlugin<TOptions>(\n config: BackendPluginConfig<TOptions>,\n): undefined extends TOptions\n ? (options?: TOptions) => BackendFeature\n : (options: TOptions) => BackendFeature {\n return (options?: TOptions) => ({\n id: config.id,\n register(register: BackendRegistrationPoints) {\n return config.register(register, options!);\n },\n });\n}\n\n/** @public */\nexport interface BackendModuleConfig<TOptions> {\n pluginId: string;\n moduleId: string;\n register(\n reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>,\n options: TOptions,\n ): void;\n}\n\n/** @public */\nexport function createBackendModule<TOptions>(\n config: BackendModuleConfig<TOptions>,\n): undefined extends TOptions\n ? (options?: TOptions) => BackendFeature\n : (options: TOptions) => BackendFeature {\n return (options?: TOptions) => ({\n id: `${config.pluginId}.${config.moduleId}`,\n register(register: BackendRegistrationPoints) {\n // TODO: Hide registerExtensionPoint\n return config.register(register, options!);\n },\n });\n}\n"],"names":["Transport","createLogger"],"mappings":";;;;;;;;;;;AAAO,SAAS,gBAAgB,CAAC,OAAO,EAAE;AAC1C,EAAE,OAAO;AACT,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE;AAClB,IAAI,IAAI,CAAC,GAAG;AACZ,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,8BAA8B,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAC/D,KAAK;AACL,IAAI,QAAQ,GAAG;AACf,MAAM,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACzC,KAAK;AACL,IAAI,KAAK,EAAE,SAAS;AACpB,GAAG,CAAC;AACJ,CAAC;AACM,SAAS,oBAAoB,CAAC,OAAO,EAAE;AAC9C,EAAE,OAAO,OAAO,CAAC;AACjB;;ACbY,MAAC,gBAAgB,GAAG,gBAAgB,CAAC;AACjD,EAAE,EAAE,EAAE,aAAa;AACnB,CAAC;;ACFW,MAAC,oBAAoB,GAAG,gBAAgB,CAAC;AACrD,EAAE,EAAE,EAAE,iBAAiB;AACvB,CAAC;;ACFW,MAAC,gBAAgB,GAAG,gBAAgB,CAAC;AACjD,EAAE,EAAE,EAAE,aAAa;AACnB,CAAC;;ACFW,MAAC,mBAAmB,GAAG,gBAAgB,CAAC;AACpD,EAAE,EAAE,EAAE,gBAAgB;AACtB,CAAC;;ACFW,MAAC,eAAe,GAAG,gBAAgB,CAAC;AAChD,EAAE,EAAE,EAAE,YAAY;AAClB,CAAC;;ACFW,MAAC,kBAAkB,GAAG,gBAAgB,CAAC;AACnD,EAAE,EAAE,EAAE,eAAe;AACrB,CAAC;;ACFW,MAAC,mBAAmB,GAAG,gBAAgB,CAAC;AACpD,EAAE,EAAE,EAAE,gBAAgB;AACtB,CAAC;;ACFW,MAAC,sBAAsB,GAAG,gBAAgB,CAAC;AACvD,EAAE,EAAE,EAAE,mBAAmB;AACzB,CAAC;;ACFW,MAAC,qBAAqB,GAAG,gBAAgB,CAAC;AACtD,EAAE,EAAE,EAAE,kBAAkB;AACxB,CAAC;;ACFW,MAAC,mBAAmB,GAAG,gBAAgB,CAAC;AACpD,EAAE,EAAE,EAAE,gBAAgB;AACtB,CAAC;;ACDD,MAAM,wBAAwB,SAASA,6BAAS,CAAC;AACjD,EAAE,WAAW,CAAC,eAAe,EAAE,IAAI,EAAE;AACrC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;AAChB,IAAI,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;AAC3C,GAAG;AACH,EAAE,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE;AACtB,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC5C,IAAI,QAAQ,EAAE,CAAC;AACf,GAAG;AACH,CAAC;AACM,SAAS,qBAAqB,CAAC,MAAM,EAAE,IAAI,EAAE;AACpD,EAAE,OAAOC,oBAAY,CAAC;AACtB,IAAI,UAAU,EAAE,CAAC,IAAI,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC5D,GAAG,CAAC,CAAC;AACL;;AChBO,SAAS,oBAAoB,CAAC,OAAO,EAAE;AAC9C,EAAE,OAAO;AACT,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE;AAClB,IAAI,IAAI,CAAC,GAAG;AACZ,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,kCAAkC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACnE,KAAK;AACL,IAAI,QAAQ,GAAG;AACf,MAAM,OAAO,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC7C,KAAK;AACL,IAAI,KAAK,EAAE,iBAAiB;AAC5B,GAAG,CAAC;AACJ,CAAC;AACM,SAAS,mBAAmB,CAAC,MAAM,EAAE;AAC5C,EAAE,OAAO,CAAC,OAAO,MAAM;AACvB,IAAI,EAAE,EAAE,MAAM,CAAC,EAAE;AACjB,IAAI,QAAQ,CAAC,QAAQ,EAAE;AACvB,MAAM,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAChD,KAAK;AACL,GAAG,CAAC,CAAC;AACL,CAAC;AACM,SAAS,mBAAmB,CAAC,MAAM,EAAE;AAC5C,EAAE,OAAO,CAAC,OAAO,MAAM;AACvB,IAAI,EAAE,EAAE,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC/C,IAAI,QAAQ,CAAC,QAAQ,EAAE;AACvB,MAAM,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAChD,KAAK;AACL,GAAG,CAAC,CAAC;AACL;;;;;;;;;;;;;;;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -23,35 +23,35 @@ export declare type AnyServiceFactory = ServiceFactory<unknown, unknown, {
|
|
|
23
23
|
}>;
|
|
24
24
|
|
|
25
25
|
/** @public */
|
|
26
|
-
export declare interface
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
[name in string]: unknown;
|
|
30
|
-
}>(options: {
|
|
31
|
-
deps: {
|
|
32
|
-
[name in keyof Deps]: ServiceRef<Deps[name]>;
|
|
33
|
-
};
|
|
34
|
-
init: (deps: Deps) => Promise<void>;
|
|
35
|
-
}): void;
|
|
26
|
+
export declare interface BackendFeature {
|
|
27
|
+
id: string;
|
|
28
|
+
register(reg: BackendRegistrationPoints): void;
|
|
36
29
|
}
|
|
37
30
|
|
|
38
31
|
/** @public */
|
|
39
32
|
export declare interface BackendModuleConfig<TOptions> {
|
|
40
33
|
pluginId: string;
|
|
41
34
|
moduleId: string;
|
|
42
|
-
register(reg: Omit<
|
|
35
|
+
register(reg: Omit<BackendRegistrationPoints, 'registerExtensionPoint'>, options: TOptions): void;
|
|
43
36
|
}
|
|
44
37
|
|
|
45
38
|
/** @public */
|
|
46
39
|
export declare interface BackendPluginConfig<TOptions> {
|
|
47
40
|
id: string;
|
|
48
|
-
register(reg:
|
|
41
|
+
register(reg: BackendRegistrationPoints, options: TOptions): void;
|
|
49
42
|
}
|
|
50
43
|
|
|
51
44
|
/** @public */
|
|
52
|
-
export declare interface
|
|
53
|
-
|
|
54
|
-
|
|
45
|
+
export declare interface BackendRegistrationPoints {
|
|
46
|
+
registerExtensionPoint<TExtensionPoint>(ref: ExtensionPoint<TExtensionPoint>, impl: TExtensionPoint): void;
|
|
47
|
+
registerInit<Deps extends {
|
|
48
|
+
[name in string]: unknown;
|
|
49
|
+
}>(options: {
|
|
50
|
+
deps: {
|
|
51
|
+
[name in keyof Deps]: ServiceRef<Deps[name]> | ExtensionPoint<Deps[name]>;
|
|
52
|
+
};
|
|
53
|
+
init(deps: Deps): Promise<void>;
|
|
54
|
+
}): void;
|
|
55
55
|
}
|
|
56
56
|
|
|
57
57
|
/**
|
|
@@ -65,10 +65,10 @@ export declare const cacheServiceRef: ServiceRef<PluginCacheManager>;
|
|
|
65
65
|
export declare const configServiceRef: ServiceRef<Config>;
|
|
66
66
|
|
|
67
67
|
/** @public */
|
|
68
|
-
export declare function createBackendModule<TOptions>(config: BackendModuleConfig<TOptions>): (
|
|
68
|
+
export declare function createBackendModule<TOptions>(config: BackendModuleConfig<TOptions>): undefined extends TOptions ? (options?: TOptions) => BackendFeature : (options: TOptions) => BackendFeature;
|
|
69
69
|
|
|
70
70
|
/** @public */
|
|
71
|
-
export declare function createBackendPlugin<TOptions>(config: BackendPluginConfig<TOptions>): (
|
|
71
|
+
export declare function createBackendPlugin<TOptions>(config: BackendPluginConfig<TOptions>): undefined extends TOptions ? (options?: TOptions) => BackendFeature : (options: TOptions) => BackendFeature;
|
|
72
72
|
|
|
73
73
|
/** @public */
|
|
74
74
|
export declare function createExtensionPoint<T>(options: {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/backend-plugin-api",
|
|
3
3
|
"description": "Core API used by Backstage backend plugins",
|
|
4
|
-
"version": "0.1.
|
|
4
|
+
"version": "0.1.1",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"private": false,
|
|
@@ -34,21 +34,21 @@
|
|
|
34
34
|
"start": "backstage-cli package start"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@backstage/backend-common": "^0.
|
|
38
|
-
"@backstage/backend-tasks": "^0.3.
|
|
37
|
+
"@backstage/backend-common": "^0.15.0",
|
|
38
|
+
"@backstage/backend-tasks": "^0.3.4",
|
|
39
39
|
"@backstage/config": "^1.0.1",
|
|
40
|
-
"@backstage/plugin-permission-common": "^0.6.3
|
|
40
|
+
"@backstage/plugin-permission-common": "^0.6.3",
|
|
41
41
|
"@types/express": "^4.17.6",
|
|
42
42
|
"express": "^4.17.1",
|
|
43
43
|
"winston": "^3.2.1",
|
|
44
44
|
"winston-transport": "^4.5.0"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@backstage/cli": "^0.18.
|
|
47
|
+
"@backstage/cli": "^0.18.1"
|
|
48
48
|
},
|
|
49
49
|
"files": [
|
|
50
50
|
"dist",
|
|
51
51
|
"alpha"
|
|
52
52
|
],
|
|
53
|
-
"gitHead": "
|
|
53
|
+
"gitHead": "a12f6269e3bf224aa7f52475be9152bc52addeed"
|
|
54
54
|
}
|