@backstage/backend-plugin-api 0.2.0-next.2 → 0.2.0
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 +27 -0
- package/alpha/package.json +1 -1
- package/dist/index.alpha.d.ts +67 -30
- package/dist/index.beta.d.ts +67 -30
- package/dist/index.cjs.js +26 -4
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +67 -30
- package/package.json +6 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,32 @@
|
|
|
1
1
|
# @backstage/backend-plugin-api
|
|
2
2
|
|
|
3
|
+
## 0.2.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 884d749b14: **BREAKING**: All core service references are now exported via a single `coreServices` object. For example, the `loggerServiceRef` is now accessed via `coreServices.logger` instead.
|
|
8
|
+
- a025190552: **BREAKING**: All service interfaces are now suffixed with `*Service`.
|
|
9
|
+
|
|
10
|
+
### Patch Changes
|
|
11
|
+
|
|
12
|
+
- cb1c2781c0: Updated `LoggerService` interface with more log methods and meta.
|
|
13
|
+
- d6dbf1792b: Added initial support for registering shutdown hooks via `lifecycleServiceRef`.
|
|
14
|
+
- Updated dependencies
|
|
15
|
+
- @backstage/backend-common@0.17.0
|
|
16
|
+
- @backstage/backend-tasks@0.4.0
|
|
17
|
+
- @backstage/plugin-permission-common@0.7.2
|
|
18
|
+
- @backstage/config@1.0.5
|
|
19
|
+
|
|
20
|
+
## 0.2.0-next.3
|
|
21
|
+
|
|
22
|
+
### Patch Changes
|
|
23
|
+
|
|
24
|
+
- Updated dependencies
|
|
25
|
+
- @backstage/backend-tasks@0.4.0-next.3
|
|
26
|
+
- @backstage/plugin-permission-common@0.7.2-next.2
|
|
27
|
+
- @backstage/backend-common@0.17.0-next.3
|
|
28
|
+
- @backstage/config@1.0.5-next.1
|
|
29
|
+
|
|
3
30
|
## 0.2.0-next.2
|
|
4
31
|
|
|
5
32
|
### Minor Changes
|
package/alpha/package.json
CHANGED
package/dist/index.alpha.d.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
import { Config } from '@backstage/config';
|
|
8
8
|
import { Handler } from 'express';
|
|
9
|
-
import { Logger
|
|
9
|
+
import { Logger } from 'winston';
|
|
10
10
|
import { PermissionAuthorizer } from '@backstage/plugin-permission-common';
|
|
11
11
|
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
|
|
12
12
|
import { PluginCacheManager } from '@backstage/backend-common';
|
|
@@ -23,23 +23,6 @@ export declare interface BackendFeature {
|
|
|
23
23
|
register(reg: BackendRegistrationPoints): void;
|
|
24
24
|
}
|
|
25
25
|
|
|
26
|
-
/**
|
|
27
|
-
* @public
|
|
28
|
-
**/
|
|
29
|
-
export declare interface BackendLifecycle {
|
|
30
|
-
/**
|
|
31
|
-
* Register a function to be called when the backend is shutting down.
|
|
32
|
-
*/
|
|
33
|
-
addShutdownHook(options: BackendLifecycleShutdownHook): void;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* @public
|
|
38
|
-
**/
|
|
39
|
-
export declare type BackendLifecycleShutdownHook = {
|
|
40
|
-
fn: () => void | Promise<void>;
|
|
41
|
-
};
|
|
42
|
-
|
|
43
26
|
/** @public */
|
|
44
27
|
export declare interface BackendModuleConfig<TOptions> {
|
|
45
28
|
pluginId: string;
|
|
@@ -66,11 +49,19 @@ export declare interface BackendRegistrationPoints {
|
|
|
66
49
|
}): void;
|
|
67
50
|
}
|
|
68
51
|
|
|
52
|
+
/** @public */
|
|
53
|
+
export declare type CacheService = PluginCacheManager;
|
|
54
|
+
|
|
69
55
|
/**
|
|
70
56
|
* @public
|
|
71
57
|
*/
|
|
72
58
|
declare const cacheServiceRef: ServiceRef<PluginCacheManager, "plugin">;
|
|
73
59
|
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
export declare type ConfigService = Config;
|
|
64
|
+
|
|
74
65
|
/**
|
|
75
66
|
* @public
|
|
76
67
|
*/
|
|
@@ -145,11 +136,17 @@ export declare function createServiceRef<T>(options: {
|
|
|
145
136
|
defaultFactory?: (service: ServiceRef<T, 'root'>) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;
|
|
146
137
|
}): ServiceRef<T, 'root'>;
|
|
147
138
|
|
|
139
|
+
/** @public */
|
|
140
|
+
export declare type DatabaseService = PluginDatabaseManager;
|
|
141
|
+
|
|
148
142
|
/**
|
|
149
143
|
* @public
|
|
150
144
|
*/
|
|
151
145
|
declare const databaseServiceRef: ServiceRef<PluginDatabaseManager, "plugin">;
|
|
152
146
|
|
|
147
|
+
/** @public */
|
|
148
|
+
export declare type DiscoveryService = PluginEndpointDiscovery;
|
|
149
|
+
|
|
153
150
|
/**
|
|
154
151
|
* @public
|
|
155
152
|
*/
|
|
@@ -183,50 +180,84 @@ export declare interface HttpRouterService {
|
|
|
183
180
|
*/
|
|
184
181
|
declare const httpRouterServiceRef: ServiceRef<HttpRouterService, "plugin">;
|
|
185
182
|
|
|
183
|
+
/**
|
|
184
|
+
* @public
|
|
185
|
+
**/
|
|
186
|
+
export declare interface LifecycleService {
|
|
187
|
+
/**
|
|
188
|
+
* Register a function to be called when the backend is shutting down.
|
|
189
|
+
*/
|
|
190
|
+
addShutdownHook(options: LifecycleServiceShutdownHook): void;
|
|
191
|
+
}
|
|
192
|
+
|
|
186
193
|
/**
|
|
187
194
|
* @public
|
|
188
195
|
*/
|
|
189
|
-
declare const lifecycleServiceRef: ServiceRef<
|
|
196
|
+
declare const lifecycleServiceRef: ServiceRef<LifecycleService, "plugin">;
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* @public
|
|
200
|
+
**/
|
|
201
|
+
export declare type LifecycleServiceShutdownHook = {
|
|
202
|
+
fn: () => void | Promise<void>;
|
|
203
|
+
};
|
|
190
204
|
|
|
191
205
|
/**
|
|
192
206
|
* @public
|
|
193
207
|
*/
|
|
194
|
-
export declare interface
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
208
|
+
export declare interface LoggerService {
|
|
209
|
+
error(message: string, meta?: Error | LogMeta): void;
|
|
210
|
+
warn(message: string, meta?: Error | LogMeta): void;
|
|
211
|
+
info(message: string, meta?: Error | LogMeta): void;
|
|
212
|
+
debug(message: string, meta?: Error | LogMeta): void;
|
|
213
|
+
child(meta: LogMeta): LoggerService;
|
|
199
214
|
}
|
|
200
215
|
|
|
201
216
|
/**
|
|
202
217
|
* @public
|
|
203
218
|
*/
|
|
204
|
-
declare const loggerServiceRef: ServiceRef<
|
|
219
|
+
declare const loggerServiceRef: ServiceRef<LoggerService, "plugin">;
|
|
220
|
+
|
|
221
|
+
/** @public */
|
|
222
|
+
export declare function loggerToWinstonLogger(logger: LoggerService, opts?: TransportStreamOptions): Logger;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
export declare type LogMeta = {
|
|
228
|
+
[name: string]: unknown;
|
|
229
|
+
};
|
|
205
230
|
|
|
206
231
|
/** @public */
|
|
207
|
-
export declare
|
|
232
|
+
export declare type PermissionsService = PermissionEvaluator | PermissionAuthorizer;
|
|
208
233
|
|
|
209
234
|
/**
|
|
210
235
|
* @public
|
|
211
236
|
*/
|
|
212
|
-
declare const permissionsServiceRef: ServiceRef<
|
|
237
|
+
declare const permissionsServiceRef: ServiceRef<PermissionsService, "plugin">;
|
|
213
238
|
|
|
214
239
|
/**
|
|
215
240
|
* @public
|
|
216
241
|
*/
|
|
217
|
-
export declare interface
|
|
242
|
+
export declare interface PluginMetadataService {
|
|
218
243
|
getId(): string;
|
|
219
244
|
}
|
|
220
245
|
|
|
221
246
|
/**
|
|
222
247
|
* @public
|
|
223
248
|
*/
|
|
224
|
-
declare const pluginMetadataServiceRef: ServiceRef<
|
|
249
|
+
declare const pluginMetadataServiceRef: ServiceRef<PluginMetadataService, "plugin">;
|
|
250
|
+
|
|
251
|
+
/** @public */
|
|
252
|
+
export declare type RootLoggerService = LoggerService;
|
|
225
253
|
|
|
226
254
|
/**
|
|
227
255
|
* @public
|
|
228
256
|
*/
|
|
229
|
-
declare const rootLoggerServiceRef: ServiceRef<
|
|
257
|
+
declare const rootLoggerServiceRef: ServiceRef<LoggerService, "root">;
|
|
258
|
+
|
|
259
|
+
/** @public */
|
|
260
|
+
export declare type SchedulerService = PluginTaskScheduler;
|
|
230
261
|
|
|
231
262
|
/**
|
|
232
263
|
* @public
|
|
@@ -291,6 +322,9 @@ declare type ServiceRefsToInstances<T extends {
|
|
|
291
322
|
}[keyof T]]: T[name] extends ServiceRef<infer TImpl> ? TImpl : never;
|
|
292
323
|
};
|
|
293
324
|
|
|
325
|
+
/** @public */
|
|
326
|
+
export declare type TokenManagerService = TokenManager;
|
|
327
|
+
|
|
294
328
|
/**
|
|
295
329
|
* @public
|
|
296
330
|
*/
|
|
@@ -301,6 +335,9 @@ export declare type TypesToServiceRef<T> = {
|
|
|
301
335
|
[key in keyof T]: ServiceRef<T[key]>;
|
|
302
336
|
};
|
|
303
337
|
|
|
338
|
+
/** @public */
|
|
339
|
+
export declare type UrlReaderService = UrlReader;
|
|
340
|
+
|
|
304
341
|
/**
|
|
305
342
|
* @public
|
|
306
343
|
*/
|
package/dist/index.beta.d.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
import { Config } from '@backstage/config';
|
|
8
8
|
import { Handler } from 'express';
|
|
9
|
-
import { Logger
|
|
9
|
+
import { Logger } from 'winston';
|
|
10
10
|
import { PermissionAuthorizer } from '@backstage/plugin-permission-common';
|
|
11
11
|
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
|
|
12
12
|
import { PluginCacheManager } from '@backstage/backend-common';
|
|
@@ -23,23 +23,6 @@ export declare interface BackendFeature {
|
|
|
23
23
|
register(reg: BackendRegistrationPoints): void;
|
|
24
24
|
}
|
|
25
25
|
|
|
26
|
-
/**
|
|
27
|
-
* @public
|
|
28
|
-
**/
|
|
29
|
-
export declare interface BackendLifecycle {
|
|
30
|
-
/**
|
|
31
|
-
* Register a function to be called when the backend is shutting down.
|
|
32
|
-
*/
|
|
33
|
-
addShutdownHook(options: BackendLifecycleShutdownHook): void;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* @public
|
|
38
|
-
**/
|
|
39
|
-
export declare type BackendLifecycleShutdownHook = {
|
|
40
|
-
fn: () => void | Promise<void>;
|
|
41
|
-
};
|
|
42
|
-
|
|
43
26
|
/** @public */
|
|
44
27
|
export declare interface BackendModuleConfig<TOptions> {
|
|
45
28
|
pluginId: string;
|
|
@@ -66,11 +49,19 @@ export declare interface BackendRegistrationPoints {
|
|
|
66
49
|
}): void;
|
|
67
50
|
}
|
|
68
51
|
|
|
52
|
+
/** @public */
|
|
53
|
+
export declare type CacheService = PluginCacheManager;
|
|
54
|
+
|
|
69
55
|
/**
|
|
70
56
|
* @public
|
|
71
57
|
*/
|
|
72
58
|
declare const cacheServiceRef: ServiceRef<PluginCacheManager, "plugin">;
|
|
73
59
|
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
export declare type ConfigService = Config;
|
|
64
|
+
|
|
74
65
|
/**
|
|
75
66
|
* @public
|
|
76
67
|
*/
|
|
@@ -145,11 +136,17 @@ export declare function createServiceRef<T>(options: {
|
|
|
145
136
|
defaultFactory?: (service: ServiceRef<T, 'root'>) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;
|
|
146
137
|
}): ServiceRef<T, 'root'>;
|
|
147
138
|
|
|
139
|
+
/** @public */
|
|
140
|
+
export declare type DatabaseService = PluginDatabaseManager;
|
|
141
|
+
|
|
148
142
|
/**
|
|
149
143
|
* @public
|
|
150
144
|
*/
|
|
151
145
|
declare const databaseServiceRef: ServiceRef<PluginDatabaseManager, "plugin">;
|
|
152
146
|
|
|
147
|
+
/** @public */
|
|
148
|
+
export declare type DiscoveryService = PluginEndpointDiscovery;
|
|
149
|
+
|
|
153
150
|
/**
|
|
154
151
|
* @public
|
|
155
152
|
*/
|
|
@@ -183,50 +180,84 @@ export declare interface HttpRouterService {
|
|
|
183
180
|
*/
|
|
184
181
|
declare const httpRouterServiceRef: ServiceRef<HttpRouterService, "plugin">;
|
|
185
182
|
|
|
183
|
+
/**
|
|
184
|
+
* @public
|
|
185
|
+
**/
|
|
186
|
+
export declare interface LifecycleService {
|
|
187
|
+
/**
|
|
188
|
+
* Register a function to be called when the backend is shutting down.
|
|
189
|
+
*/
|
|
190
|
+
addShutdownHook(options: LifecycleServiceShutdownHook): void;
|
|
191
|
+
}
|
|
192
|
+
|
|
186
193
|
/**
|
|
187
194
|
* @public
|
|
188
195
|
*/
|
|
189
|
-
declare const lifecycleServiceRef: ServiceRef<
|
|
196
|
+
declare const lifecycleServiceRef: ServiceRef<LifecycleService, "plugin">;
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* @public
|
|
200
|
+
**/
|
|
201
|
+
export declare type LifecycleServiceShutdownHook = {
|
|
202
|
+
fn: () => void | Promise<void>;
|
|
203
|
+
};
|
|
190
204
|
|
|
191
205
|
/**
|
|
192
206
|
* @public
|
|
193
207
|
*/
|
|
194
|
-
export declare interface
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
208
|
+
export declare interface LoggerService {
|
|
209
|
+
error(message: string, meta?: Error | LogMeta): void;
|
|
210
|
+
warn(message: string, meta?: Error | LogMeta): void;
|
|
211
|
+
info(message: string, meta?: Error | LogMeta): void;
|
|
212
|
+
debug(message: string, meta?: Error | LogMeta): void;
|
|
213
|
+
child(meta: LogMeta): LoggerService;
|
|
199
214
|
}
|
|
200
215
|
|
|
201
216
|
/**
|
|
202
217
|
* @public
|
|
203
218
|
*/
|
|
204
|
-
declare const loggerServiceRef: ServiceRef<
|
|
219
|
+
declare const loggerServiceRef: ServiceRef<LoggerService, "plugin">;
|
|
220
|
+
|
|
221
|
+
/** @public */
|
|
222
|
+
export declare function loggerToWinstonLogger(logger: LoggerService, opts?: TransportStreamOptions): Logger;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
export declare type LogMeta = {
|
|
228
|
+
[name: string]: unknown;
|
|
229
|
+
};
|
|
205
230
|
|
|
206
231
|
/** @public */
|
|
207
|
-
export declare
|
|
232
|
+
export declare type PermissionsService = PermissionEvaluator | PermissionAuthorizer;
|
|
208
233
|
|
|
209
234
|
/**
|
|
210
235
|
* @public
|
|
211
236
|
*/
|
|
212
|
-
declare const permissionsServiceRef: ServiceRef<
|
|
237
|
+
declare const permissionsServiceRef: ServiceRef<PermissionsService, "plugin">;
|
|
213
238
|
|
|
214
239
|
/**
|
|
215
240
|
* @public
|
|
216
241
|
*/
|
|
217
|
-
export declare interface
|
|
242
|
+
export declare interface PluginMetadataService {
|
|
218
243
|
getId(): string;
|
|
219
244
|
}
|
|
220
245
|
|
|
221
246
|
/**
|
|
222
247
|
* @public
|
|
223
248
|
*/
|
|
224
|
-
declare const pluginMetadataServiceRef: ServiceRef<
|
|
249
|
+
declare const pluginMetadataServiceRef: ServiceRef<PluginMetadataService, "plugin">;
|
|
250
|
+
|
|
251
|
+
/** @public */
|
|
252
|
+
export declare type RootLoggerService = LoggerService;
|
|
225
253
|
|
|
226
254
|
/**
|
|
227
255
|
* @public
|
|
228
256
|
*/
|
|
229
|
-
declare const rootLoggerServiceRef: ServiceRef<
|
|
257
|
+
declare const rootLoggerServiceRef: ServiceRef<LoggerService, "root">;
|
|
258
|
+
|
|
259
|
+
/** @public */
|
|
260
|
+
export declare type SchedulerService = PluginTaskScheduler;
|
|
230
261
|
|
|
231
262
|
/**
|
|
232
263
|
* @public
|
|
@@ -291,6 +322,9 @@ declare type ServiceRefsToInstances<T extends {
|
|
|
291
322
|
}[keyof T]]: T[name] extends ServiceRef<infer TImpl> ? TImpl : never;
|
|
292
323
|
};
|
|
293
324
|
|
|
325
|
+
/** @public */
|
|
326
|
+
export declare type TokenManagerService = TokenManager;
|
|
327
|
+
|
|
294
328
|
/**
|
|
295
329
|
* @public
|
|
296
330
|
*/
|
|
@@ -301,6 +335,9 @@ export declare type TypesToServiceRef<T> = {
|
|
|
301
335
|
[key in keyof T]: ServiceRef<T[key]>;
|
|
302
336
|
};
|
|
303
337
|
|
|
338
|
+
/** @public */
|
|
339
|
+
export declare type UrlReaderService = UrlReader;
|
|
340
|
+
|
|
304
341
|
/**
|
|
305
342
|
* @public
|
|
306
343
|
*/
|
package/dist/index.cjs.js
CHANGED
|
@@ -81,9 +81,11 @@ const rootLoggerServiceRef = createServiceRef({
|
|
|
81
81
|
scope: "root"
|
|
82
82
|
});
|
|
83
83
|
|
|
84
|
-
const pluginMetadataServiceRef = createServiceRef(
|
|
85
|
-
|
|
86
|
-
|
|
84
|
+
const pluginMetadataServiceRef = createServiceRef(
|
|
85
|
+
{
|
|
86
|
+
id: "core.plugin-metadata"
|
|
87
|
+
}
|
|
88
|
+
);
|
|
87
89
|
|
|
88
90
|
const lifecycleServiceRef = createServiceRef({
|
|
89
91
|
id: "core.lifecycle",
|
|
@@ -113,7 +115,27 @@ class BackstageLoggerTransport extends Transport__default["default"] {
|
|
|
113
115
|
this.backstageLogger = backstageLogger;
|
|
114
116
|
}
|
|
115
117
|
log(info, callback) {
|
|
116
|
-
|
|
118
|
+
if (typeof info !== "object" || info === null) {
|
|
119
|
+
callback();
|
|
120
|
+
return;
|
|
121
|
+
}
|
|
122
|
+
const { level, message, ...meta } = info;
|
|
123
|
+
switch (level) {
|
|
124
|
+
case "error":
|
|
125
|
+
this.backstageLogger.error(String(message), meta);
|
|
126
|
+
break;
|
|
127
|
+
case "warn":
|
|
128
|
+
this.backstageLogger.warn(String(message), meta);
|
|
129
|
+
break;
|
|
130
|
+
case "info":
|
|
131
|
+
this.backstageLogger.info(String(message), meta);
|
|
132
|
+
break;
|
|
133
|
+
case "debug":
|
|
134
|
+
this.backstageLogger.debug(String(message), meta);
|
|
135
|
+
break;
|
|
136
|
+
default:
|
|
137
|
+
this.backstageLogger.info(String(message), meta);
|
|
138
|
+
}
|
|
117
139
|
callback();
|
|
118
140
|
}
|
|
119
141
|
}
|
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/definitions/rootLoggerServiceRef.ts","../src/services/definitions/pluginMetadataServiceRef.ts","../src/services/definitions/lifecycleServiceRef.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<\n TService,\n TScope extends 'root' | 'plugin' = 'root' | 'plugin',\n> = {\n id: string;\n\n /**\n * This determines the scope at which this service is available.\n *\n * Root scoped services are available to all other services but\n * may only depend on other root scoped services.\n *\n * Plugin scoped services are only available to other plugin scoped\n * services but may depend on all other services.\n */\n scope: TScope;\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: TService;\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 ServiceFactory<TService = unknown> =\n | {\n // This scope prop is needed in addition to the service ref, as TypeScript\n // can't properly discriminate the two factory types otherwise.\n scope: 'root';\n service: ServiceRef<TService, 'root'>;\n deps: { [key in string]: ServiceRef<unknown> };\n factory(deps: { [key in string]: unknown }): Promise<TService>;\n }\n | {\n scope: 'plugin';\n service: ServiceRef<TService, 'plugin'>;\n deps: { [key in string]: ServiceRef<unknown> };\n factory(deps: { [key in string]: unknown }): Promise<\n (deps: { [key in string]: unknown }) => Promise<TService>\n >;\n };\n\n/** @public */\nexport function createServiceRef<T>(options: {\n id: string;\n scope?: 'plugin';\n defaultFactory?: (\n service: ServiceRef<T, 'plugin'>,\n ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n}): ServiceRef<T, 'plugin'>;\n/** @public */\nexport function createServiceRef<T>(options: {\n id: string;\n scope: 'root';\n defaultFactory?: (\n service: ServiceRef<T, 'root'>,\n ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n}): ServiceRef<T, 'root'>;\nexport function createServiceRef<T>(options: {\n id: string;\n scope?: 'plugin' | 'root';\n defaultFactory?:\n | ((\n service: ServiceRef<T, 'plugin'>,\n ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>)\n | ((\n service: ServiceRef<T, 'root'>,\n ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>);\n}): ServiceRef<T> {\n const { id, scope = 'plugin', defaultFactory } = options;\n return {\n id,\n scope,\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 __defaultFactory: defaultFactory,\n } as ServiceRef<T, typeof scope> & {\n __defaultFactory?: (\n service: ServiceRef<T>,\n ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n };\n}\n\n/** @ignore */\ntype ServiceRefsToInstances<\n T extends { [key in string]: ServiceRef<unknown> },\n TScope extends 'root' | 'plugin' = 'root' | 'plugin',\n> = {\n [name in {\n [key in keyof T]: T[key] extends ServiceRef<unknown, TScope> ? key : never;\n }[keyof T]]: T[name] extends ServiceRef<infer TImpl> ? TImpl : never;\n};\n\n/**\n * @public\n */\nexport function createServiceFactory<\n TService,\n TScope extends 'root' | 'plugin',\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n TOpts extends object | undefined = undefined,\n>(config: {\n service: ServiceRef<TService, TScope>;\n deps: TDeps;\n factory(\n deps: ServiceRefsToInstances<TDeps, 'root'>,\n options: TOpts,\n ): TScope extends 'root'\n ? Promise<TImpl>\n : Promise<(deps: ServiceRefsToInstances<TDeps>) => Promise<TImpl>>;\n}): undefined extends TOpts\n ? (options?: TOpts) => ServiceFactory<TService>\n : (options: TOpts) => ServiceFactory<TService> {\n return (options?: TOpts) =>\n ({\n scope: config.service.scope,\n service: config.service,\n deps: config.deps,\n factory(deps: ServiceRefsToInstances<TDeps, 'root'>) {\n return config.factory(deps, options!);\n },\n } as ServiceFactory<TService>);\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.root.config',\n scope: 'root',\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 { createServiceRef } from '../system/types';\nimport { Logger } from './loggerServiceRef';\n\n/**\n * @public\n */\nexport const rootLoggerServiceRef = createServiceRef<Logger>({\n id: 'core.root.logger',\n scope: 'root',\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 PluginMetadata {\n getId(): string;\n}\n\n/**\n * @public\n */\nexport const pluginMetadataServiceRef = createServiceRef<PluginMetadata>({\n id: 'core.plugin-metadata',\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 type BackendLifecycleShutdownHook = {\n fn: () => void | Promise<void>;\n};\n\n/**\n * @public\n **/\nexport interface BackendLifecycle {\n /**\n * Register a function to be called when the backend is shutting down.\n */\n addShutdownHook(options: BackendLifecycleShutdownHook): void;\n}\n\n/**\n * @public\n */\nexport const lifecycleServiceRef = createServiceRef<BackendLifecycle>({\n id: 'core.lifecycle',\n scope: 'plugin',\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<\n TOptions extends object | undefined = undefined,\n>(config: {\n id: string;\n register(reg: BackendRegistrationPoints, options: TOptions): void;\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/**\n * @public\n *\n * Creates a new backend module for a given plugin.\n *\n * The `moduleId` should be equal to the module-specific prefix of the exported name, such\n * that the full name is `moduleId + PluginId + \"Module\"`. For example, a GitHub entity\n * provider module for the `catalog` plugin might have the module ID `'githubEntityProvider'`,\n * and the full exported name would be `githubEntityProviderCatalogModule`.\n *\n * The `pluginId` should exactly match the `id` of the plugin that the module extends.\n */\nexport function createBackendModule<\n TOptions extends object | undefined = undefined,\n>(\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":";;;;;;;;;;;AAuFO,SAAS,iBAAoB,OAUlB,EAAA;AAChB,EAAA,MAAM,EAAE,EAAA,EAAI,KAAQ,GAAA,QAAA,EAAU,gBAAmB,GAAA,OAAA,CAAA;AACjD,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAI,CAAO,GAAA;AACT,MAAM,MAAA,IAAI,KAAM,CAAA,CAAA,8BAAA,EAAiC,IAAM,CAAA,CAAA,CAAA,CAAA;AAAA,KACzD;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,cAAc,OAAQ,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KAC/B;AAAA,IACA,KAAO,EAAA,SAAA;AAAA,IACP,gBAAkB,EAAA,cAAA;AAAA,GACpB,CAAA;AAKF,CAAA;AAeO,SAAS,qBAMd,MAW+C,EAAA;AAC/C,EAAA,OAAO,CAAC,OACL,MAAA;AAAA,IACC,KAAA,EAAO,OAAO,OAAQ,CAAA,KAAA;AAAA,IACtB,SAAS,MAAO,CAAA,OAAA;AAAA,IAChB,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,QAAQ,IAA6C,EAAA;AACnD,MAAO,OAAA,MAAA,CAAO,OAAQ,CAAA,IAAA,EAAM,OAAQ,CAAA,CAAA;AAAA,KACtC;AAAA,GACF,CAAA,CAAA;AACJ;;ACvIO,MAAM,mBAAmB,gBAAyB,CAAA;AAAA,EACvD,EAAI,EAAA,kBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC,CAAA;;ACIM,MAAM,uBAAuB,gBAAoC,CAAA;AAAA,EACtE,EAAI,EAAA,iBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,mBAAmB,gBAAyB,CAAA;AAAA,EACvD,EAAI,EAAA,aAAA;AACN,CAAC,CAAA;;ACTM,MAAM,sBAAsB,gBAA4B,CAAA;AAAA,EAC7D,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,kBAAkB,gBAAqC,CAAA;AAAA,EAClE,EAAI,EAAA,YAAA;AACN,CAAC,CAAA;;ACFM,MAAM,qBAAqB,gBAAwC,CAAA;AAAA,EACxE,EAAI,EAAA,eAAA;AACN,CAAC,CAAA;;ACFM,MAAM,sBAAsB,gBAA0C,CAAA;AAAA,EAC3E,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,yBAAyB,gBAA+B,CAAA;AAAA,EACnE,EAAI,EAAA,mBAAA;AACN,CAAC,CAAA;;ACCM,MAAM,wBAAwB,gBAEnC,CAAA;AAAA,EACA,EAAI,EAAA,kBAAA;AACN,CAAC,CAAA;;ACPM,MAAM,sBAAsB,gBAAsC,CAAA;AAAA,EACvE,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,uBAAuB,gBAAyB,CAAA;AAAA,EAC3D,EAAI,EAAA,kBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC,CAAA;;ACGM,MAAM,2BAA2B,gBAAiC,CAAA;AAAA,EACvE,EAAI,EAAA,sBAAA;AACN,CAAC,CAAA;;ACQM,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AAAA,EACJ,KAAO,EAAA,QAAA;AACT,CAAC,CAAA;;;;;;;;;;;;;;;;;;;ACrBD,MAAM,iCAAiCA,6BAAU,CAAA;AAAA,EAC/C,WAAA,CACmB,iBACjB,IACA,EAAA;AACA,IAAA,KAAA,CAAM,IAAI,CAAA,CAAA;AAHO,IAAA,IAAA,CAAA,eAAA,GAAA,eAAA,CAAA;AAAA,GAInB;AAAA,EAEA,GAAA,CAAI,MAA2B,QAAwB,EAAA;AAErD,IAAK,IAAA,CAAA,eAAA,CAAgB,IAAK,CAAA,IAAA,CAAK,OAAO,CAAA,CAAA;AACtC,IAAS,QAAA,EAAA,CAAA;AAAA,GACX;AACF,CAAA;AAGgB,SAAA,qBAAA,CACd,QACA,IACe,EAAA;AACf,EAAA,OAAOC,oBAAa,CAAA;AAAA,IAClB,YAAY,CAAC,IAAI,wBAAyB,CAAA,MAAA,EAAQ,IAAI,CAAC,CAAA;AAAA,GACxD,CAAA,CAAA;AACH;;ACpBO,SAAS,qBAAwB,OAElB,EAAA;AACpB,EAAO,OAAA;AAAA,IACL,IAAI,OAAQ,CAAA,EAAA;AAAA,IACZ,IAAI,CAAO,GAAA;AACT,MAAM,MAAA,IAAI,KAAM,CAAA,CAAA,kCAAA,EAAqC,IAAM,CAAA,CAAA,CAAA,CAAA;AAAA,KAC7D;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,kBAAkB,OAAQ,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KACnC;AAAA,IACA,KAAO,EAAA,iBAAA;AAAA,GACT,CAAA;AACF,CAAA;AASO,SAAS,oBAEd,MAKwC,EAAA;AACxC,EAAA,OAAO,CAAC,OAAwB,MAAA;AAAA,IAC9B,IAAI,MAAO,CAAA,EAAA;AAAA,IACX,SAAS,QAAqC,EAAA;AAC5C,MAAO,OAAA,MAAA,CAAO,QAAS,CAAA,QAAA,EAAU,OAAQ,CAAA,CAAA;AAAA,KAC3C;AAAA,GACF,CAAA,CAAA;AACF,CAAA;AAwBO,SAAS,oBAGd,MAGwC,EAAA;AACxC,EAAA,OAAO,CAAC,OAAwB,MAAA;AAAA,IAC9B,EAAI,EAAA,CAAA,EAAG,MAAO,CAAA,QAAA,CAAA,CAAA,EAAY,MAAO,CAAA,QAAA,CAAA,CAAA;AAAA,IACjC,SAAS,QAAqC,EAAA;AAE5C,MAAO,OAAA,MAAA,CAAO,QAAS,CAAA,QAAA,EAAU,OAAQ,CAAA,CAAA;AAAA,KAC3C;AAAA,GACF,CAAA,CAAA;AACF;;;;;;;;;;"}
|
|
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/definitions/rootLoggerServiceRef.ts","../src/services/definitions/pluginMetadataServiceRef.ts","../src/services/definitions/lifecycleServiceRef.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<\n TService,\n TScope extends 'root' | 'plugin' = 'root' | 'plugin',\n> = {\n id: string;\n\n /**\n * This determines the scope at which this service is available.\n *\n * Root scoped services are available to all other services but\n * may only depend on other root scoped services.\n *\n * Plugin scoped services are only available to other plugin scoped\n * services but may depend on all other services.\n */\n scope: TScope;\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: TService;\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 ServiceFactory<TService = unknown> =\n | {\n // This scope prop is needed in addition to the service ref, as TypeScript\n // can't properly discriminate the two factory types otherwise.\n scope: 'root';\n service: ServiceRef<TService, 'root'>;\n deps: { [key in string]: ServiceRef<unknown> };\n factory(deps: { [key in string]: unknown }): Promise<TService>;\n }\n | {\n scope: 'plugin';\n service: ServiceRef<TService, 'plugin'>;\n deps: { [key in string]: ServiceRef<unknown> };\n factory(deps: { [key in string]: unknown }): Promise<\n (deps: { [key in string]: unknown }) => Promise<TService>\n >;\n };\n\n/** @public */\nexport function createServiceRef<T>(options: {\n id: string;\n scope?: 'plugin';\n defaultFactory?: (\n service: ServiceRef<T, 'plugin'>,\n ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n}): ServiceRef<T, 'plugin'>;\n/** @public */\nexport function createServiceRef<T>(options: {\n id: string;\n scope: 'root';\n defaultFactory?: (\n service: ServiceRef<T, 'root'>,\n ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n}): ServiceRef<T, 'root'>;\nexport function createServiceRef<T>(options: {\n id: string;\n scope?: 'plugin' | 'root';\n defaultFactory?:\n | ((\n service: ServiceRef<T, 'plugin'>,\n ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>)\n | ((\n service: ServiceRef<T, 'root'>,\n ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>);\n}): ServiceRef<T> {\n const { id, scope = 'plugin', defaultFactory } = options;\n return {\n id,\n scope,\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 __defaultFactory: defaultFactory,\n } as ServiceRef<T, typeof scope> & {\n __defaultFactory?: (\n service: ServiceRef<T>,\n ) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;\n };\n}\n\n/** @ignore */\ntype ServiceRefsToInstances<\n T extends { [key in string]: ServiceRef<unknown> },\n TScope extends 'root' | 'plugin' = 'root' | 'plugin',\n> = {\n [name in {\n [key in keyof T]: T[key] extends ServiceRef<unknown, TScope> ? key : never;\n }[keyof T]]: T[name] extends ServiceRef<infer TImpl> ? TImpl : never;\n};\n\n/**\n * @public\n */\nexport function createServiceFactory<\n TService,\n TScope extends 'root' | 'plugin',\n TImpl extends TService,\n TDeps extends { [name in string]: ServiceRef<unknown> },\n TOpts extends object | undefined = undefined,\n>(config: {\n service: ServiceRef<TService, TScope>;\n deps: TDeps;\n factory(\n deps: ServiceRefsToInstances<TDeps, 'root'>,\n options: TOpts,\n ): TScope extends 'root'\n ? Promise<TImpl>\n : Promise<(deps: ServiceRefsToInstances<TDeps>) => Promise<TImpl>>;\n}): undefined extends TOpts\n ? (options?: TOpts) => ServiceFactory<TService>\n : (options: TOpts) => ServiceFactory<TService> {\n return (options?: TOpts) =>\n ({\n scope: config.service.scope,\n service: config.service,\n deps: config.deps,\n factory(deps: ServiceRefsToInstances<TDeps, 'root'>) {\n return config.factory(deps, options!);\n },\n } as ServiceFactory<TService>);\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 type ConfigService = Config;\n\n/**\n * @public\n */\nexport const configServiceRef = createServiceRef<ConfigService>({\n id: 'core.root.config',\n scope: 'root',\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 type LogMeta = { [name: string]: unknown };\n\n/**\n * @public\n */\nexport interface LoggerService {\n error(message: string, meta?: Error | LogMeta): void;\n warn(message: string, meta?: Error | LogMeta): void;\n info(message: string, meta?: Error | LogMeta): void;\n debug(message: string, meta?: Error | LogMeta): void;\n\n child(meta: LogMeta): LoggerService;\n}\n\n/**\n * @public\n */\nexport const loggerServiceRef = createServiceRef<LoggerService>({\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/** @public */\nexport type UrlReaderService = UrlReader;\n\n/**\n * @public\n */\nexport const urlReaderServiceRef = createServiceRef<UrlReaderService>({\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/** @public */\nexport type CacheService = PluginCacheManager;\n\n/**\n * @public\n */\nexport const cacheServiceRef = createServiceRef<CacheService>({\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/** @public */\nexport type DatabaseService = PluginDatabaseManager;\n\n/**\n * @public\n */\nexport const databaseServiceRef = createServiceRef<DatabaseService>({\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/** @public */\nexport type DiscoveryService = PluginEndpointDiscovery;\n\n/**\n * @public\n */\nexport const discoveryServiceRef = createServiceRef<DiscoveryService>({\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/** @public */\nexport type TokenManagerService = TokenManager;\n\n/**\n * @public\n */\nexport const tokenManagerServiceRef = createServiceRef<TokenManagerService>({\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/** @public */\nexport type PermissionsService = PermissionEvaluator | PermissionAuthorizer;\n\n/**\n * @public\n */\nexport const permissionsServiceRef = createServiceRef<PermissionsService>({\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/** @public */\nexport type SchedulerService = PluginTaskScheduler;\n\n/**\n * @public\n */\nexport const schedulerServiceRef = createServiceRef<SchedulerService>({\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 { createServiceRef } from '../system/types';\nimport { LoggerService } from './loggerServiceRef';\n\n/** @public */\nexport type RootLoggerService = LoggerService;\n\n/**\n * @public\n */\nexport const rootLoggerServiceRef = createServiceRef<RootLoggerService>({\n id: 'core.root.logger',\n scope: 'root',\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 PluginMetadataService {\n getId(): string;\n}\n\n/**\n * @public\n */\nexport const pluginMetadataServiceRef = createServiceRef<PluginMetadataService>(\n {\n id: 'core.plugin-metadata',\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 { createServiceRef } from '../system/types';\n\n/**\n * @public\n **/\nexport type LifecycleServiceShutdownHook = {\n fn: () => void | Promise<void>;\n};\n\n/**\n * @public\n **/\nexport interface LifecycleService {\n /**\n * Register a function to be called when the backend is shutting down.\n */\n addShutdownHook(options: LifecycleServiceShutdownHook): void;\n}\n\n/**\n * @public\n */\nexport const lifecycleServiceRef = createServiceRef<LifecycleService>({\n id: 'core.lifecycle',\n scope: 'plugin',\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 { LoggerService } 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: LoggerService,\n opts?: TransportStreamOptions,\n ) {\n super(opts);\n }\n\n log(info: unknown, callback: VoidFunction) {\n if (typeof info !== 'object' || info === null) {\n callback();\n return;\n }\n const { level, message, ...meta } = info as { [name: string]: unknown };\n switch (level) {\n case 'error':\n this.backstageLogger.error(String(message), meta);\n break;\n case 'warn':\n this.backstageLogger.warn(String(message), meta);\n break;\n case 'info':\n this.backstageLogger.info(String(message), meta);\n break;\n case 'debug':\n this.backstageLogger.debug(String(message), meta);\n break;\n default:\n this.backstageLogger.info(String(message), meta);\n }\n callback();\n }\n}\n\n/** @public */\nexport function loggerToWinstonLogger(\n logger: LoggerService,\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<\n TOptions extends object | undefined = undefined,\n>(config: {\n id: string;\n register(reg: BackendRegistrationPoints, options: TOptions): void;\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/**\n * @public\n *\n * Creates a new backend module for a given plugin.\n *\n * The `moduleId` should be equal to the module-specific prefix of the exported name, such\n * that the full name is `moduleId + PluginId + \"Module\"`. For example, a GitHub entity\n * provider module for the `catalog` plugin might have the module ID `'githubEntityProvider'`,\n * and the full exported name would be `githubEntityProviderCatalogModule`.\n *\n * The `pluginId` should exactly match the `id` of the plugin that the module extends.\n */\nexport function createBackendModule<\n TOptions extends object | undefined = undefined,\n>(\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":";;;;;;;;;;;AAuFO,SAAS,iBAAoB,OAUlB,EAAA;AAChB,EAAA,MAAM,EAAE,EAAA,EAAI,KAAQ,GAAA,QAAA,EAAU,gBAAmB,GAAA,OAAA,CAAA;AACjD,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,KAAA;AAAA,IACA,IAAI,CAAO,GAAA;AACT,MAAM,MAAA,IAAI,KAAM,CAAA,CAAA,8BAAA,EAAiC,IAAM,CAAA,CAAA,CAAA,CAAA;AAAA,KACzD;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,cAAc,OAAQ,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KAC/B;AAAA,IACA,KAAO,EAAA,SAAA;AAAA,IACP,gBAAkB,EAAA,cAAA;AAAA,GACpB,CAAA;AAKF,CAAA;AAeO,SAAS,qBAMd,MAW+C,EAAA;AAC/C,EAAA,OAAO,CAAC,OACL,MAAA;AAAA,IACC,KAAA,EAAO,OAAO,OAAQ,CAAA,KAAA;AAAA,IACtB,SAAS,MAAO,CAAA,OAAA;AAAA,IAChB,MAAM,MAAO,CAAA,IAAA;AAAA,IACb,QAAQ,IAA6C,EAAA;AACnD,MAAO,OAAA,MAAA,CAAO,OAAQ,CAAA,IAAA,EAAM,OAAQ,CAAA,CAAA;AAAA,KACtC;AAAA,GACF,CAAA,CAAA;AACJ;;AClIO,MAAM,mBAAmB,gBAAgC,CAAA;AAAA,EAC9D,EAAI,EAAA,kBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC,CAAA;;ACDM,MAAM,uBAAuB,gBAAoC,CAAA;AAAA,EACtE,EAAI,EAAA,iBAAA;AACN,CAAC,CAAA;;ACOM,MAAM,mBAAmB,gBAAgC,CAAA;AAAA,EAC9D,EAAI,EAAA,aAAA;AACN,CAAC,CAAA;;ACfM,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,kBAAkB,gBAA+B,CAAA;AAAA,EAC5D,EAAI,EAAA,YAAA;AACN,CAAC,CAAA;;ACFM,MAAM,qBAAqB,gBAAkC,CAAA;AAAA,EAClE,EAAI,EAAA,eAAA;AACN,CAAC,CAAA;;ACFM,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,yBAAyB,gBAAsC,CAAA;AAAA,EAC1E,EAAI,EAAA,mBAAA;AACN,CAAC,CAAA;;ACCM,MAAM,wBAAwB,gBAAqC,CAAA;AAAA,EACxE,EAAI,EAAA,kBAAA;AACN,CAAC,CAAA;;ACLM,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AACN,CAAC,CAAA;;ACFM,MAAM,uBAAuB,gBAAoC,CAAA;AAAA,EACtE,EAAI,EAAA,kBAAA;AAAA,EACJ,KAAO,EAAA,MAAA;AACT,CAAC,CAAA;;ACAM,MAAM,wBAA2B,GAAA,gBAAA;AAAA,EACtC;AAAA,IACE,EAAI,EAAA,sBAAA;AAAA,GACN;AACF,CAAA;;ACMO,MAAM,sBAAsB,gBAAmC,CAAA;AAAA,EACpE,EAAI,EAAA,gBAAA;AAAA,EACJ,KAAO,EAAA,QAAA;AACT,CAAC,CAAA;;;;;;;;;;;;;;;;;;;ACrBD,MAAM,iCAAiCA,6BAAU,CAAA;AAAA,EAC/C,WAAA,CACmB,iBACjB,IACA,EAAA;AACA,IAAA,KAAA,CAAM,IAAI,CAAA,CAAA;AAHO,IAAA,IAAA,CAAA,eAAA,GAAA,eAAA,CAAA;AAAA,GAInB;AAAA,EAEA,GAAA,CAAI,MAAe,QAAwB,EAAA;AACzC,IAAA,IAAI,OAAO,IAAA,KAAS,QAAY,IAAA,IAAA,KAAS,IAAM,EAAA;AAC7C,MAAS,QAAA,EAAA,CAAA;AACT,MAAA,OAAA;AAAA,KACF;AACA,IAAA,MAAM,EAAE,KAAA,EAAO,OAAY,EAAA,GAAA,IAAA,EAAS,GAAA,IAAA,CAAA;AACpC,IAAA,QAAQ,KAAO;AAAA,MACb,KAAK,OAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,KAAA,CAAM,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAChD,QAAA,MAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAC/C,QAAA,MAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAC/C,QAAA,MAAA;AAAA,MACF,KAAK,OAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,KAAA,CAAM,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAChD,QAAA,MAAA;AAAA,MACF;AACE,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA,CAAA;AAAA,KACnD;AACA,IAAS,QAAA,EAAA,CAAA;AAAA,GACX;AACF,CAAA;AAGgB,SAAA,qBAAA,CACd,QACA,IACe,EAAA;AACf,EAAA,OAAOC,oBAAa,CAAA;AAAA,IAClB,YAAY,CAAC,IAAI,wBAAyB,CAAA,MAAA,EAAQ,IAAI,CAAC,CAAA;AAAA,GACxD,CAAA,CAAA;AACH;;ACvCO,SAAS,qBAAwB,OAElB,EAAA;AACpB,EAAO,OAAA;AAAA,IACL,IAAI,OAAQ,CAAA,EAAA;AAAA,IACZ,IAAI,CAAO,GAAA;AACT,MAAM,MAAA,IAAI,KAAM,CAAA,CAAA,kCAAA,EAAqC,IAAM,CAAA,CAAA,CAAA,CAAA;AAAA,KAC7D;AAAA,IACA,QAAW,GAAA;AACT,MAAA,OAAO,kBAAkB,OAAQ,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;AAAA,KACnC;AAAA,IACA,KAAO,EAAA,iBAAA;AAAA,GACT,CAAA;AACF,CAAA;AASO,SAAS,oBAEd,MAKwC,EAAA;AACxC,EAAA,OAAO,CAAC,OAAwB,MAAA;AAAA,IAC9B,IAAI,MAAO,CAAA,EAAA;AAAA,IACX,SAAS,QAAqC,EAAA;AAC5C,MAAO,OAAA,MAAA,CAAO,QAAS,CAAA,QAAA,EAAU,OAAQ,CAAA,CAAA;AAAA,KAC3C;AAAA,GACF,CAAA,CAAA;AACF,CAAA;AAwBO,SAAS,oBAGd,MAGwC,EAAA;AACxC,EAAA,OAAO,CAAC,OAAwB,MAAA;AAAA,IAC9B,EAAI,EAAA,CAAA,EAAG,MAAO,CAAA,QAAA,CAAA,CAAA,EAAY,MAAO,CAAA,QAAA,CAAA,CAAA;AAAA,IACjC,SAAS,QAAqC,EAAA;AAE5C,MAAO,OAAA,MAAA,CAAO,QAAS,CAAA,QAAA,EAAU,OAAQ,CAAA,CAAA;AAAA,KAC3C;AAAA,GACF,CAAA,CAAA;AACF;;;;;;;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
import { Config } from '@backstage/config';
|
|
8
8
|
import { Handler } from 'express';
|
|
9
|
-
import { Logger
|
|
9
|
+
import { Logger } from 'winston';
|
|
10
10
|
import { PermissionAuthorizer } from '@backstage/plugin-permission-common';
|
|
11
11
|
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
|
|
12
12
|
import { PluginCacheManager } from '@backstage/backend-common';
|
|
@@ -23,23 +23,6 @@ export declare interface BackendFeature {
|
|
|
23
23
|
register(reg: BackendRegistrationPoints): void;
|
|
24
24
|
}
|
|
25
25
|
|
|
26
|
-
/**
|
|
27
|
-
* @public
|
|
28
|
-
**/
|
|
29
|
-
export declare interface BackendLifecycle {
|
|
30
|
-
/**
|
|
31
|
-
* Register a function to be called when the backend is shutting down.
|
|
32
|
-
*/
|
|
33
|
-
addShutdownHook(options: BackendLifecycleShutdownHook): void;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* @public
|
|
38
|
-
**/
|
|
39
|
-
export declare type BackendLifecycleShutdownHook = {
|
|
40
|
-
fn: () => void | Promise<void>;
|
|
41
|
-
};
|
|
42
|
-
|
|
43
26
|
/** @public */
|
|
44
27
|
export declare interface BackendModuleConfig<TOptions> {
|
|
45
28
|
pluginId: string;
|
|
@@ -66,11 +49,19 @@ export declare interface BackendRegistrationPoints {
|
|
|
66
49
|
}): void;
|
|
67
50
|
}
|
|
68
51
|
|
|
52
|
+
/** @public */
|
|
53
|
+
export declare type CacheService = PluginCacheManager;
|
|
54
|
+
|
|
69
55
|
/**
|
|
70
56
|
* @public
|
|
71
57
|
*/
|
|
72
58
|
declare const cacheServiceRef: ServiceRef<PluginCacheManager, "plugin">;
|
|
73
59
|
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
export declare type ConfigService = Config;
|
|
64
|
+
|
|
74
65
|
/**
|
|
75
66
|
* @public
|
|
76
67
|
*/
|
|
@@ -145,11 +136,17 @@ export declare function createServiceRef<T>(options: {
|
|
|
145
136
|
defaultFactory?: (service: ServiceRef<T, 'root'>) => Promise<ServiceFactory<T> | (() => ServiceFactory<T>)>;
|
|
146
137
|
}): ServiceRef<T, 'root'>;
|
|
147
138
|
|
|
139
|
+
/** @public */
|
|
140
|
+
export declare type DatabaseService = PluginDatabaseManager;
|
|
141
|
+
|
|
148
142
|
/**
|
|
149
143
|
* @public
|
|
150
144
|
*/
|
|
151
145
|
declare const databaseServiceRef: ServiceRef<PluginDatabaseManager, "plugin">;
|
|
152
146
|
|
|
147
|
+
/** @public */
|
|
148
|
+
export declare type DiscoveryService = PluginEndpointDiscovery;
|
|
149
|
+
|
|
153
150
|
/**
|
|
154
151
|
* @public
|
|
155
152
|
*/
|
|
@@ -183,50 +180,84 @@ export declare interface HttpRouterService {
|
|
|
183
180
|
*/
|
|
184
181
|
declare const httpRouterServiceRef: ServiceRef<HttpRouterService, "plugin">;
|
|
185
182
|
|
|
183
|
+
/**
|
|
184
|
+
* @public
|
|
185
|
+
**/
|
|
186
|
+
export declare interface LifecycleService {
|
|
187
|
+
/**
|
|
188
|
+
* Register a function to be called when the backend is shutting down.
|
|
189
|
+
*/
|
|
190
|
+
addShutdownHook(options: LifecycleServiceShutdownHook): void;
|
|
191
|
+
}
|
|
192
|
+
|
|
186
193
|
/**
|
|
187
194
|
* @public
|
|
188
195
|
*/
|
|
189
|
-
declare const lifecycleServiceRef: ServiceRef<
|
|
196
|
+
declare const lifecycleServiceRef: ServiceRef<LifecycleService, "plugin">;
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* @public
|
|
200
|
+
**/
|
|
201
|
+
export declare type LifecycleServiceShutdownHook = {
|
|
202
|
+
fn: () => void | Promise<void>;
|
|
203
|
+
};
|
|
190
204
|
|
|
191
205
|
/**
|
|
192
206
|
* @public
|
|
193
207
|
*/
|
|
194
|
-
export declare interface
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
208
|
+
export declare interface LoggerService {
|
|
209
|
+
error(message: string, meta?: Error | LogMeta): void;
|
|
210
|
+
warn(message: string, meta?: Error | LogMeta): void;
|
|
211
|
+
info(message: string, meta?: Error | LogMeta): void;
|
|
212
|
+
debug(message: string, meta?: Error | LogMeta): void;
|
|
213
|
+
child(meta: LogMeta): LoggerService;
|
|
199
214
|
}
|
|
200
215
|
|
|
201
216
|
/**
|
|
202
217
|
* @public
|
|
203
218
|
*/
|
|
204
|
-
declare const loggerServiceRef: ServiceRef<
|
|
219
|
+
declare const loggerServiceRef: ServiceRef<LoggerService, "plugin">;
|
|
220
|
+
|
|
221
|
+
/** @public */
|
|
222
|
+
export declare function loggerToWinstonLogger(logger: LoggerService, opts?: TransportStreamOptions): Logger;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
export declare type LogMeta = {
|
|
228
|
+
[name: string]: unknown;
|
|
229
|
+
};
|
|
205
230
|
|
|
206
231
|
/** @public */
|
|
207
|
-
export declare
|
|
232
|
+
export declare type PermissionsService = PermissionEvaluator | PermissionAuthorizer;
|
|
208
233
|
|
|
209
234
|
/**
|
|
210
235
|
* @public
|
|
211
236
|
*/
|
|
212
|
-
declare const permissionsServiceRef: ServiceRef<
|
|
237
|
+
declare const permissionsServiceRef: ServiceRef<PermissionsService, "plugin">;
|
|
213
238
|
|
|
214
239
|
/**
|
|
215
240
|
* @public
|
|
216
241
|
*/
|
|
217
|
-
export declare interface
|
|
242
|
+
export declare interface PluginMetadataService {
|
|
218
243
|
getId(): string;
|
|
219
244
|
}
|
|
220
245
|
|
|
221
246
|
/**
|
|
222
247
|
* @public
|
|
223
248
|
*/
|
|
224
|
-
declare const pluginMetadataServiceRef: ServiceRef<
|
|
249
|
+
declare const pluginMetadataServiceRef: ServiceRef<PluginMetadataService, "plugin">;
|
|
250
|
+
|
|
251
|
+
/** @public */
|
|
252
|
+
export declare type RootLoggerService = LoggerService;
|
|
225
253
|
|
|
226
254
|
/**
|
|
227
255
|
* @public
|
|
228
256
|
*/
|
|
229
|
-
declare const rootLoggerServiceRef: ServiceRef<
|
|
257
|
+
declare const rootLoggerServiceRef: ServiceRef<LoggerService, "root">;
|
|
258
|
+
|
|
259
|
+
/** @public */
|
|
260
|
+
export declare type SchedulerService = PluginTaskScheduler;
|
|
230
261
|
|
|
231
262
|
/**
|
|
232
263
|
* @public
|
|
@@ -291,6 +322,9 @@ declare type ServiceRefsToInstances<T extends {
|
|
|
291
322
|
}[keyof T]]: T[name] extends ServiceRef<infer TImpl> ? TImpl : never;
|
|
292
323
|
};
|
|
293
324
|
|
|
325
|
+
/** @public */
|
|
326
|
+
export declare type TokenManagerService = TokenManager;
|
|
327
|
+
|
|
294
328
|
/**
|
|
295
329
|
* @public
|
|
296
330
|
*/
|
|
@@ -301,6 +335,9 @@ export declare type TypesToServiceRef<T> = {
|
|
|
301
335
|
[key in keyof T]: ServiceRef<T[key]>;
|
|
302
336
|
};
|
|
303
337
|
|
|
338
|
+
/** @public */
|
|
339
|
+
export declare type UrlReaderService = UrlReader;
|
|
340
|
+
|
|
304
341
|
/**
|
|
305
342
|
* @public
|
|
306
343
|
*/
|
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.2.0
|
|
4
|
+
"version": "0.2.0",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"publishConfig": {
|
|
@@ -33,17 +33,17 @@
|
|
|
33
33
|
"start": "backstage-cli package start"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@backstage/backend-common": "^0.17.0
|
|
37
|
-
"@backstage/backend-tasks": "^0.4.0
|
|
38
|
-
"@backstage/config": "^1.0.5
|
|
39
|
-
"@backstage/plugin-permission-common": "^0.7.2
|
|
36
|
+
"@backstage/backend-common": "^0.17.0",
|
|
37
|
+
"@backstage/backend-tasks": "^0.4.0",
|
|
38
|
+
"@backstage/config": "^1.0.5",
|
|
39
|
+
"@backstage/plugin-permission-common": "^0.7.2",
|
|
40
40
|
"@types/express": "^4.17.6",
|
|
41
41
|
"express": "^4.17.1",
|
|
42
42
|
"winston": "^3.2.1",
|
|
43
43
|
"winston-transport": "^4.5.0"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
|
-
"@backstage/cli": "^0.
|
|
46
|
+
"@backstage/cli": "^0.22.0"
|
|
47
47
|
},
|
|
48
48
|
"files": [
|
|
49
49
|
"dist",
|