@backstage/plugin-scaffolder 0.12.3 → 0.15.0-next.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 +146 -0
- package/dist/esm/{Router-fe84df85.esm.js → Router-722c3528.esm.js} +232 -45
- package/dist/esm/Router-722c3528.esm.js.map +1 -0
- package/dist/esm/{index-87e5c74b.esm.js → index-3fd3ab40.esm.js} +140 -302
- package/dist/esm/index-3fd3ab40.esm.js.map +1 -0
- package/dist/index.d.ts +264 -112
- package/dist/index.esm.js +3 -6
- package/dist/index.esm.js.map +1 -1
- package/package.json +21 -20
- package/dist/esm/Router-fe84df85.esm.js.map +0 -1
- package/dist/esm/index-87e5c74b.esm.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,18 +1,25 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
|
|
3
3
|
import { DiscoveryApi, FetchApi, ApiHolder, Extension } from '@backstage/core-plugin-api';
|
|
4
|
-
import * as _backstage_catalog_model from '@backstage/catalog-model';
|
|
5
|
-
import { JSONSchema, EntityName, Entity } from '@backstage/catalog-model';
|
|
6
4
|
import { ScmIntegrationRegistry } from '@backstage/integration';
|
|
7
|
-
import {
|
|
8
|
-
import
|
|
9
|
-
import {
|
|
10
|
-
import
|
|
11
|
-
import React__default, { ComponentProps, ComponentType } from 'react';
|
|
5
|
+
import { JsonObject, JsonValue, Observable } from '@backstage/types';
|
|
6
|
+
import { TaskSpec, TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common';
|
|
7
|
+
import { JSONSchema7 } from 'json-schema';
|
|
8
|
+
import React, { ComponentType } from 'react';
|
|
12
9
|
import { FieldValidation, FieldProps } from '@rjsf/core';
|
|
13
|
-
import {
|
|
10
|
+
import { Entity } from '@backstage/catalog-model';
|
|
14
11
|
|
|
15
|
-
|
|
12
|
+
/**
|
|
13
|
+
* The status of each task in a Scaffolder Job
|
|
14
|
+
*
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
declare type ScaffolderTaskStatus = 'open' | 'processing' | 'failed' | 'completed' | 'skipped';
|
|
18
|
+
/**
|
|
19
|
+
* The shape of each task returned from the `scaffolder-backend`
|
|
20
|
+
*
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
16
23
|
declare type ScaffolderTask = {
|
|
17
24
|
id: string;
|
|
18
25
|
spec: TaskSpec;
|
|
@@ -20,21 +27,38 @@ declare type ScaffolderTask = {
|
|
|
20
27
|
lastHeartbeatAt: string;
|
|
21
28
|
createdAt: string;
|
|
22
29
|
};
|
|
30
|
+
/**
|
|
31
|
+
* The response shape for the `listActions` call to the `scaffolder-backend`
|
|
32
|
+
*
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
23
35
|
declare type ListActionsResponse = Array<{
|
|
24
36
|
id: string;
|
|
25
37
|
description?: string;
|
|
26
38
|
schema?: {
|
|
27
|
-
input?:
|
|
28
|
-
output?:
|
|
39
|
+
input?: JSONSchema7;
|
|
40
|
+
output?: JSONSchema7;
|
|
29
41
|
};
|
|
30
42
|
}>;
|
|
31
|
-
|
|
43
|
+
/** @public */
|
|
44
|
+
declare type ScaffolderOutputLink = {
|
|
45
|
+
title?: string;
|
|
46
|
+
icon?: string;
|
|
47
|
+
url?: string;
|
|
48
|
+
entityRef?: string;
|
|
49
|
+
};
|
|
50
|
+
/** @public */
|
|
51
|
+
declare type ScaffolderTaskOutput = {
|
|
52
|
+
links?: ScaffolderOutputLink[];
|
|
53
|
+
} & {
|
|
54
|
+
[key: string]: unknown;
|
|
55
|
+
};
|
|
32
56
|
/**
|
|
33
|
-
*
|
|
57
|
+
* The shape of each entry of parameters which gets rendered
|
|
58
|
+
* as a seperate step in the wizard input
|
|
34
59
|
*
|
|
35
60
|
* @public
|
|
36
61
|
*/
|
|
37
|
-
declare const scaffolderApiRef: _backstage_core_plugin_api.ApiRef<ScaffolderApi>;
|
|
38
62
|
declare type TemplateParameterSchema = {
|
|
39
63
|
title: string;
|
|
40
64
|
steps: Array<{
|
|
@@ -42,50 +66,98 @@ declare type TemplateParameterSchema = {
|
|
|
42
66
|
schema: JsonObject;
|
|
43
67
|
}>;
|
|
44
68
|
};
|
|
69
|
+
/**
|
|
70
|
+
* The shape of a `LogEvent` message from the `scaffolder-backend`
|
|
71
|
+
*
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
45
74
|
declare type LogEvent = {
|
|
46
75
|
type: 'log' | 'completion';
|
|
47
76
|
body: {
|
|
48
77
|
message: string;
|
|
49
78
|
stepId?: string;
|
|
50
|
-
status?:
|
|
79
|
+
status?: ScaffolderTaskStatus;
|
|
51
80
|
};
|
|
52
81
|
createdAt: string;
|
|
53
82
|
id: string;
|
|
54
83
|
taskId: string;
|
|
55
84
|
};
|
|
85
|
+
/**
|
|
86
|
+
* The input options to the `scaffold` method of the `ScaffolderClient`.
|
|
87
|
+
*
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
interface ScaffolderScaffoldOptions {
|
|
91
|
+
templateRef: string;
|
|
92
|
+
values: Record<string, JsonValue>;
|
|
93
|
+
secrets?: Record<string, string>;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* The response shape of the `scaffold` method of the `ScaffolderClient`.
|
|
97
|
+
*
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
interface ScaffolderScaffoldResponse {
|
|
101
|
+
taskId: string;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* The arguments for `getIntegrationsList`.
|
|
105
|
+
*
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
interface ScaffolderGetIntegrationsListOptions {
|
|
109
|
+
allowedHosts: string[];
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* The response shape for `getIntegrationsList`.
|
|
113
|
+
*
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
interface ScaffolderGetIntegrationsListResponse {
|
|
117
|
+
integrations: {
|
|
118
|
+
type: string;
|
|
119
|
+
title: string;
|
|
120
|
+
host: string;
|
|
121
|
+
}[];
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* The input options to the `streamLogs` method of the `ScaffolderClient`.
|
|
125
|
+
*
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
interface ScaffolderStreamLogsOptions {
|
|
129
|
+
taskId: string;
|
|
130
|
+
after?: number;
|
|
131
|
+
}
|
|
56
132
|
/**
|
|
57
133
|
* An API to interact with the scaffolder backend.
|
|
58
134
|
*
|
|
59
135
|
* @public
|
|
60
136
|
*/
|
|
61
137
|
interface ScaffolderApi {
|
|
62
|
-
getTemplateParameterSchema(
|
|
138
|
+
getTemplateParameterSchema(templateRef: string): Promise<TemplateParameterSchema>;
|
|
63
139
|
/**
|
|
64
140
|
* Executes the scaffolding of a component, given a template and its
|
|
65
141
|
* parameter values.
|
|
66
142
|
*
|
|
67
|
-
* @param
|
|
68
|
-
* @param values - Parameters for the template, e.g. name, description
|
|
69
|
-
* @param secrets - Optional secrets to pass to as the secrets parameter to the template.
|
|
143
|
+
* @param options - The {@link ScaffolderScaffoldOptions} the scaffolding.
|
|
70
144
|
*/
|
|
71
|
-
scaffold(
|
|
145
|
+
scaffold(options: ScaffolderScaffoldOptions): Promise<ScaffolderScaffoldResponse>;
|
|
72
146
|
getTask(taskId: string): Promise<ScaffolderTask>;
|
|
73
|
-
getIntegrationsList(options:
|
|
74
|
-
allowedHosts: string[];
|
|
75
|
-
}): Promise<{
|
|
76
|
-
type: string;
|
|
77
|
-
title: string;
|
|
78
|
-
host: string;
|
|
79
|
-
}[]>;
|
|
147
|
+
getIntegrationsList(options: ScaffolderGetIntegrationsListOptions): Promise<ScaffolderGetIntegrationsListResponse>;
|
|
80
148
|
/**
|
|
81
149
|
* Returns a list of all installed actions.
|
|
82
150
|
*/
|
|
83
151
|
listActions(): Promise<ListActionsResponse>;
|
|
84
|
-
streamLogs(options:
|
|
85
|
-
taskId: string;
|
|
86
|
-
after?: number;
|
|
87
|
-
}): Observable<LogEvent>;
|
|
152
|
+
streamLogs(options: ScaffolderStreamLogsOptions): Observable<LogEvent>;
|
|
88
153
|
}
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* Utility API reference for the {@link ScaffolderApi}.
|
|
157
|
+
*
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
declare const scaffolderApiRef: _backstage_core_plugin_api.ApiRef<ScaffolderApi>;
|
|
89
161
|
/**
|
|
90
162
|
* An API to interact with the scaffolder backend.
|
|
91
163
|
*
|
|
@@ -102,28 +174,17 @@ declare class ScaffolderClient implements ScaffolderApi {
|
|
|
102
174
|
scmIntegrationsApi: ScmIntegrationRegistry;
|
|
103
175
|
useLongPollingLogs?: boolean;
|
|
104
176
|
});
|
|
105
|
-
getIntegrationsList(options:
|
|
106
|
-
|
|
107
|
-
}): Promise<{
|
|
108
|
-
type: string;
|
|
109
|
-
title: string;
|
|
110
|
-
host: string;
|
|
111
|
-
}[]>;
|
|
112
|
-
getTemplateParameterSchema(templateName: EntityName): Promise<TemplateParameterSchema>;
|
|
177
|
+
getIntegrationsList(options: ScaffolderGetIntegrationsListOptions): Promise<ScaffolderGetIntegrationsListResponse>;
|
|
178
|
+
getTemplateParameterSchema(templateRef: string): Promise<TemplateParameterSchema>;
|
|
113
179
|
/**
|
|
114
180
|
* Executes the scaffolding of a component, given a template and its
|
|
115
181
|
* parameter values.
|
|
116
182
|
*
|
|
117
|
-
* @param
|
|
118
|
-
* @param values - Parameters for the template, e.g. name, description
|
|
119
|
-
* @param secrets - Optional secrets to pass to as the secrets parameter to the template.
|
|
183
|
+
* @param options - The {@link ScaffolderScaffoldOptions} the scaffolding.
|
|
120
184
|
*/
|
|
121
|
-
scaffold(
|
|
122
|
-
getTask(taskId: string): Promise<
|
|
123
|
-
streamLogs(options:
|
|
124
|
-
taskId: string;
|
|
125
|
-
after?: number;
|
|
126
|
-
}): Observable<LogEvent>;
|
|
185
|
+
scaffold(options: ScaffolderScaffoldOptions): Promise<ScaffolderScaffoldResponse>;
|
|
186
|
+
getTask(taskId: string): Promise<ScaffolderTask>;
|
|
187
|
+
streamLogs(options: ScaffolderStreamLogsOptions): Observable<LogEvent>;
|
|
127
188
|
private streamLogsEventStream;
|
|
128
189
|
private streamLogsPolling;
|
|
129
190
|
listActions(): Promise<ListActionsResponse>;
|
|
@@ -134,19 +195,19 @@ declare class ScaffolderClient implements ScaffolderApi {
|
|
|
134
195
|
*
|
|
135
196
|
* @public
|
|
136
197
|
*/
|
|
137
|
-
declare type CustomFieldValidator<
|
|
198
|
+
declare type CustomFieldValidator<TFieldReturnValue> = (data: TFieldReturnValue, field: FieldValidation, context: {
|
|
138
199
|
apiHolder: ApiHolder;
|
|
139
|
-
}) => void
|
|
200
|
+
}) => void;
|
|
140
201
|
/**
|
|
141
202
|
* Type for the Custom Field Extension with the
|
|
142
203
|
* name and components and validation function.
|
|
143
204
|
*
|
|
144
205
|
* @public
|
|
145
206
|
*/
|
|
146
|
-
declare type FieldExtensionOptions<
|
|
207
|
+
declare type FieldExtensionOptions<TFieldReturnValue = unknown, TInputProps = unknown> = {
|
|
147
208
|
name: string;
|
|
148
|
-
component: (props:
|
|
149
|
-
validation?: CustomFieldValidator<
|
|
209
|
+
component: (props: FieldExtensionComponentProps<TFieldReturnValue, TInputProps>) => JSX.Element | null;
|
|
210
|
+
validation?: CustomFieldValidator<TFieldReturnValue>;
|
|
150
211
|
};
|
|
151
212
|
/**
|
|
152
213
|
* Type for field extensions and being able to type
|
|
@@ -154,48 +215,18 @@ declare type FieldExtensionOptions<T = any> = {
|
|
|
154
215
|
*
|
|
155
216
|
* @public
|
|
156
217
|
*/
|
|
157
|
-
interface FieldExtensionComponentProps<
|
|
158
|
-
uiSchema: {
|
|
159
|
-
'ui:options'?:
|
|
218
|
+
interface FieldExtensionComponentProps<TFieldReturnValue, TUiOptions extends {} = {}> extends FieldProps<TFieldReturnValue> {
|
|
219
|
+
uiSchema: FieldProps['uiSchema'] & {
|
|
220
|
+
'ui:options'?: TUiOptions;
|
|
160
221
|
};
|
|
161
222
|
}
|
|
162
223
|
|
|
163
|
-
declare function createScaffolderFieldExtension<T = any>(options: FieldExtensionOptions<T>): Extension<() => null>;
|
|
164
|
-
declare const ScaffolderFieldExtensions: React__default.ComponentType;
|
|
165
|
-
|
|
166
|
-
declare const scaffolderPlugin: _backstage_core_plugin_api.BackstagePlugin<{
|
|
167
|
-
root: _backstage_core_plugin_api.RouteRef<undefined>;
|
|
168
|
-
}, {
|
|
169
|
-
registerComponent: _backstage_core_plugin_api.ExternalRouteRef<undefined, true>;
|
|
170
|
-
}>;
|
|
171
|
-
declare const EntityPickerFieldExtension: () => null;
|
|
172
|
-
declare const EntityNamePickerFieldExtension: () => null;
|
|
173
|
-
declare const RepoUrlPickerFieldExtension: () => null;
|
|
174
|
-
declare const OwnerPickerFieldExtension: () => null;
|
|
175
|
-
declare const ScaffolderPage: ({ TemplateCardComponent, TaskPageComponent, groups, }: {
|
|
176
|
-
TemplateCardComponent?: React.ComponentType<{
|
|
177
|
-
template: _backstage_plugin_scaffolder_common.TemplateEntityV1beta2;
|
|
178
|
-
}> | undefined;
|
|
179
|
-
TaskPageComponent?: React.ComponentType<{}> | undefined;
|
|
180
|
-
groups?: {
|
|
181
|
-
title?: string | undefined;
|
|
182
|
-
titleComponent?: React.ReactNode;
|
|
183
|
-
filter: (entity: _backstage_catalog_model.Entity) => boolean;
|
|
184
|
-
}[] | undefined;
|
|
185
|
-
}) => JSX.Element;
|
|
186
|
-
declare const OwnedEntityPickerFieldExtension: () => null;
|
|
187
224
|
/**
|
|
188
|
-
*
|
|
225
|
+
* The input props that can be specified under `ui:options` for the
|
|
226
|
+
* `RepoUrlPicker` field extension.
|
|
227
|
+
*
|
|
189
228
|
* @public
|
|
190
229
|
*/
|
|
191
|
-
declare const EntityTagsPickerFieldExtension: () => null;
|
|
192
|
-
|
|
193
|
-
declare const EntityNamePicker: ({ schema: { title, description }, ...props }: FieldProps<string>) => JSX.Element;
|
|
194
|
-
|
|
195
|
-
declare const EntityPicker: ({ onChange, schema: { title, description }, required, uiSchema, rawErrors, formData, idSchema, }: FieldProps<string>) => JSX.Element;
|
|
196
|
-
|
|
197
|
-
declare const OwnerPicker: ({ schema: { title, description }, uiSchema, ...props }: FieldProps<string>) => JSX.Element;
|
|
198
|
-
|
|
199
230
|
interface RepoUrlPickerUiOptions {
|
|
200
231
|
allowedHosts?: string[];
|
|
201
232
|
allowedOwners?: string[];
|
|
@@ -209,48 +240,169 @@ interface RepoUrlPickerUiOptions {
|
|
|
209
240
|
};
|
|
210
241
|
};
|
|
211
242
|
}
|
|
212
|
-
declare const RepoUrlPicker: (props: FieldExtensionComponentProps<string, RepoUrlPickerUiOptions>) => JSX.Element;
|
|
213
243
|
|
|
214
|
-
|
|
244
|
+
/**
|
|
245
|
+
* The input props that can be specified under `ui:options` for the
|
|
246
|
+
* `EntityTagsPicker` field extension.
|
|
247
|
+
*
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
interface EntityTagsPickerUiOptions {
|
|
251
|
+
kinds?: string[];
|
|
252
|
+
}
|
|
215
253
|
|
|
216
|
-
|
|
254
|
+
/**
|
|
255
|
+
* The input props that can be specified under `ui:options` for the
|
|
256
|
+
* `EntityPicker` field extension.
|
|
257
|
+
*
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
interface EntityPickerUiOptions {
|
|
261
|
+
allowedKinds?: string[];
|
|
262
|
+
defaultKind?: string;
|
|
263
|
+
allowArbitraryValues?: boolean;
|
|
264
|
+
}
|
|
217
265
|
|
|
218
266
|
/**
|
|
219
|
-
*
|
|
267
|
+
* A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
|
|
268
|
+
*
|
|
220
269
|
* @public
|
|
221
270
|
*/
|
|
222
|
-
declare
|
|
271
|
+
declare type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null;
|
|
272
|
+
/**
|
|
273
|
+
* Method for creating field extensions that can be used in the scaffolder
|
|
274
|
+
* frontend form.
|
|
275
|
+
* @public
|
|
276
|
+
*/
|
|
277
|
+
declare function createScaffolderFieldExtension<TReturnValue = unknown, TInputProps = unknown>(options: FieldExtensionOptions<TReturnValue, TInputProps>): Extension<FieldExtensionComponent<TReturnValue, TInputProps>>;
|
|
278
|
+
/**
|
|
279
|
+
* The Wrapping component for defining fields extensions inside
|
|
280
|
+
*
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
declare const ScaffolderFieldExtensions: React.ComponentType;
|
|
223
284
|
|
|
224
|
-
declare type Props = ComponentProps<typeof IconButton> & {
|
|
225
|
-
entity: Entity;
|
|
226
|
-
};
|
|
227
285
|
/**
|
|
228
|
-
*
|
|
229
|
-
*
|
|
286
|
+
* The input props that can be specified under `ui:options` for the
|
|
287
|
+
* `OwnedEntityPicker` field extension.
|
|
288
|
+
*
|
|
289
|
+
* @public
|
|
230
290
|
*/
|
|
231
|
-
|
|
291
|
+
interface OwnedEntityPickerUiOptions {
|
|
292
|
+
allowedKinds?: string[];
|
|
293
|
+
defaultKind?: string;
|
|
294
|
+
}
|
|
232
295
|
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
296
|
+
/**
|
|
297
|
+
* The props for the entrypoint `ScaffolderPage` component the plugin.
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
declare type RouterProps = {
|
|
301
|
+
components?: {
|
|
302
|
+
TemplateCardComponent?: ComponentType<{
|
|
303
|
+
template: TemplateEntityV1beta3;
|
|
304
|
+
}> | undefined;
|
|
305
|
+
TaskPageComponent?: ComponentType<{}>;
|
|
306
|
+
};
|
|
307
|
+
groups?: Array<{
|
|
238
308
|
title?: string;
|
|
239
|
-
titleComponent?:
|
|
309
|
+
titleComponent?: React.ReactNode;
|
|
240
310
|
filter: (entity: Entity) => boolean;
|
|
241
|
-
}
|
|
311
|
+
}>;
|
|
242
312
|
};
|
|
243
|
-
declare const TemplateList: ({ TemplateCardComponent, group, }: TemplateListProps) => JSX.Element | null;
|
|
244
313
|
|
|
314
|
+
/**
|
|
315
|
+
* The input props that can be specified under `ui:options` for the
|
|
316
|
+
* `OwnerPicker` field extension.
|
|
317
|
+
*
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
interface OwnerPickerUiOptions {
|
|
321
|
+
allowedKinds?: string[];
|
|
322
|
+
}
|
|
323
|
+
|
|
324
|
+
/**
|
|
325
|
+
* The validation function for the `repoUrl` that is returned from the
|
|
326
|
+
* field extension. Ensures that you have all the required fields filled for
|
|
327
|
+
* the different providers that exist.
|
|
328
|
+
*
|
|
329
|
+
* @public
|
|
330
|
+
*/
|
|
331
|
+
declare const repoPickerValidation: (value: string, validation: FieldValidation, context: {
|
|
332
|
+
apiHolder: ApiHolder;
|
|
333
|
+
}) => void;
|
|
334
|
+
|
|
335
|
+
/**
|
|
336
|
+
* The main plugin export for the scaffolder.
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
declare const scaffolderPlugin: _backstage_core_plugin_api.BackstagePlugin<{
|
|
340
|
+
root: _backstage_core_plugin_api.RouteRef<undefined>;
|
|
341
|
+
}, {
|
|
342
|
+
registerComponent: _backstage_core_plugin_api.ExternalRouteRef<undefined, true>;
|
|
343
|
+
}>;
|
|
344
|
+
/**
|
|
345
|
+
* A field extension for selecting an Entity that exists in the Catalog.
|
|
346
|
+
*
|
|
347
|
+
* @public
|
|
348
|
+
*/
|
|
349
|
+
declare const EntityPickerFieldExtension: FieldExtensionComponent<string, EntityPickerUiOptions>;
|
|
350
|
+
/**
|
|
351
|
+
* The field extension for selecting a name for a new Entity in the Catalog.
|
|
352
|
+
*
|
|
353
|
+
* @public
|
|
354
|
+
*/
|
|
355
|
+
declare const EntityNamePickerFieldExtension: FieldExtensionComponent<string, {}>;
|
|
356
|
+
/**
|
|
357
|
+
* The field extension which provides the ability to select a RepositoryUrl.
|
|
358
|
+
* Currently this is an encoded URL that looks something like the following `github.com?repo=myRepoName&owner=backstage`.
|
|
359
|
+
*
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
declare const RepoUrlPickerFieldExtension: FieldExtensionComponent<string, RepoUrlPickerUiOptions>;
|
|
363
|
+
/**
|
|
364
|
+
* A field extension for picking users and groups out of the Catalog.
|
|
365
|
+
*
|
|
366
|
+
* @public
|
|
367
|
+
*/
|
|
368
|
+
declare const OwnerPickerFieldExtension: FieldExtensionComponent<string, OwnerPickerUiOptions>;
|
|
369
|
+
/**
|
|
370
|
+
* The Router and main entrypoint to the Scaffolder plugin.
|
|
371
|
+
*
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
declare const ScaffolderPage: (props: RouterProps) => JSX.Element;
|
|
375
|
+
/**
|
|
376
|
+
* A field extension to show all the Entities that are owned by the current logged-in User for use in templates.
|
|
377
|
+
*
|
|
378
|
+
* @public
|
|
379
|
+
*/
|
|
380
|
+
declare const OwnedEntityPickerFieldExtension: FieldExtensionComponent<string, OwnedEntityPickerUiOptions>;
|
|
381
|
+
/**
|
|
382
|
+
* EntityTagsPickerFieldExtension
|
|
383
|
+
* @public
|
|
384
|
+
*/
|
|
385
|
+
declare const EntityTagsPickerFieldExtension: FieldExtensionComponent<string[], EntityTagsPickerUiOptions>;
|
|
386
|
+
|
|
387
|
+
/**
|
|
388
|
+
* The component to select the `type` of `Template` that you will see in the table.
|
|
389
|
+
*
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
245
392
|
declare const TemplateTypePicker: () => JSX.Element | null;
|
|
246
393
|
|
|
394
|
+
/**
|
|
395
|
+
* The return type from the useTemplateSecrets hook.
|
|
396
|
+
* @public
|
|
397
|
+
*/
|
|
398
|
+
interface ScaffolderUseTemplateSecrets {
|
|
399
|
+
setSecrets: (input: Record<string, string>) => void;
|
|
400
|
+
}
|
|
247
401
|
/**
|
|
248
402
|
* Hook to access the secrets context.
|
|
249
403
|
* @public
|
|
250
404
|
*/
|
|
251
|
-
declare const useTemplateSecrets: () =>
|
|
252
|
-
setSecret: (input: Record<string, string>) => void;
|
|
253
|
-
};
|
|
405
|
+
declare const useTemplateSecrets: () => ScaffolderUseTemplateSecrets;
|
|
254
406
|
|
|
255
407
|
/**
|
|
256
408
|
* TaskPageProps for constructing a TaskPage
|
|
@@ -269,4 +421,4 @@ declare type TaskPageProps = {
|
|
|
269
421
|
*/
|
|
270
422
|
declare const TaskPage: ({ loadingText }: TaskPageProps) => JSX.Element;
|
|
271
423
|
|
|
272
|
-
export { CustomFieldValidator,
|
|
424
|
+
export { CustomFieldValidator, EntityNamePickerFieldExtension, EntityPickerFieldExtension, EntityPickerUiOptions, EntityTagsPickerFieldExtension, EntityTagsPickerUiOptions, FieldExtensionComponent, FieldExtensionComponentProps, FieldExtensionOptions, ListActionsResponse, LogEvent, OwnedEntityPickerFieldExtension, OwnedEntityPickerUiOptions, OwnerPickerFieldExtension, OwnerPickerUiOptions, RepoUrlPickerFieldExtension, RepoUrlPickerUiOptions, RouterProps, ScaffolderApi, ScaffolderClient, ScaffolderFieldExtensions, ScaffolderGetIntegrationsListOptions, ScaffolderGetIntegrationsListResponse, ScaffolderOutputLink, ScaffolderPage, ScaffolderScaffoldOptions, ScaffolderScaffoldResponse, ScaffolderStreamLogsOptions, ScaffolderTask, ScaffolderTaskOutput, ScaffolderTaskStatus, ScaffolderUseTemplateSecrets, TaskPage, TaskPageProps, TemplateParameterSchema, TemplateTypePicker, createScaffolderFieldExtension, repoPickerValidation, scaffolderApiRef, scaffolderPlugin, useTemplateSecrets };
|
package/dist/index.esm.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
export {
|
|
1
|
+
export { p as EntityNamePickerFieldExtension, o as EntityPickerFieldExtension, q as EntityTagsPickerFieldExtension, u as OwnedEntityPickerFieldExtension, t as OwnerPickerFieldExtension, v as RepoUrlPickerFieldExtension, l as ScaffolderClient, n as ScaffolderFieldExtensions, w as ScaffolderPage, k as TaskPage, T as TemplateTypePicker, m as createScaffolderFieldExtension, r as repoPickerValidation, f as scaffolderApiRef, x as scaffolderPlugin, y as useTemplateSecrets } from './esm/index-3fd3ab40.esm.js';
|
|
2
2
|
import '@backstage/catalog-model';
|
|
3
|
-
import '@backstage/integration-react';
|
|
4
3
|
import '@backstage/core-plugin-api';
|
|
5
4
|
import '@backstage/errors';
|
|
6
5
|
import 'qs';
|
|
@@ -13,15 +12,12 @@ import 'react';
|
|
|
13
12
|
import 'react-use/lib/useAsync';
|
|
14
13
|
import 'react-use/lib/useEffectOnce';
|
|
15
14
|
import '@material-ui/lab';
|
|
15
|
+
import '@backstage/integration-react';
|
|
16
16
|
import '@material-ui/core/FormHelperText';
|
|
17
17
|
import '@material-ui/core/Input';
|
|
18
18
|
import '@material-ui/core/InputLabel';
|
|
19
19
|
import '@backstage/core-components';
|
|
20
20
|
import 'react-use/lib/useDebounce';
|
|
21
|
-
import '@material-ui/icons/Star';
|
|
22
|
-
import '@material-ui/icons/StarBorder';
|
|
23
|
-
import '@material-ui/icons/Warning';
|
|
24
|
-
import 'react-router';
|
|
25
21
|
import 'lodash/capitalize';
|
|
26
22
|
import '@material-ui/icons/CheckBox';
|
|
27
23
|
import '@material-ui/icons/CheckBoxOutlineBlank';
|
|
@@ -37,6 +33,7 @@ import '@material-ui/icons/Check';
|
|
|
37
33
|
import '@material-ui/icons/FiberManualRecord';
|
|
38
34
|
import 'classnames';
|
|
39
35
|
import 'luxon';
|
|
36
|
+
import 'react-router';
|
|
40
37
|
import 'react-use/lib/useInterval';
|
|
41
38
|
import 'use-immer';
|
|
42
39
|
import '@material-ui/icons/Language';
|
package/dist/index.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-scaffolder",
|
|
3
3
|
"description": "The Backstage plugin that helps you create new things",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.15.0-next.0",
|
|
5
5
|
"main": "dist/index.esm.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -34,25 +34,26 @@
|
|
|
34
34
|
"clean": "backstage-cli package clean"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@backstage/catalog-client": "^0.
|
|
38
|
-
"@backstage/catalog-model": "^0.
|
|
39
|
-
"@backstage/config": "^0.1.
|
|
40
|
-
"@backstage/core-components": "^0.
|
|
41
|
-
"@backstage/core-plugin-api": "^0.
|
|
42
|
-
"@backstage/errors": "^0.2.
|
|
43
|
-
"@backstage/integration": "^0.
|
|
44
|
-
"@backstage/integration-react": "^0.1.
|
|
45
|
-
"@backstage/plugin-catalog-common": "^0.
|
|
46
|
-
"@backstage/plugin-catalog-react": "^0.
|
|
47
|
-
"@backstage/plugin-permission-react": "^0.3.
|
|
48
|
-
"@backstage/plugin-scaffolder-common": "^0.
|
|
37
|
+
"@backstage/catalog-client": "^0.9.0-next.0",
|
|
38
|
+
"@backstage/catalog-model": "^0.13.0-next.0",
|
|
39
|
+
"@backstage/config": "^0.1.15",
|
|
40
|
+
"@backstage/core-components": "^0.9.1-next.0",
|
|
41
|
+
"@backstage/core-plugin-api": "^0.8.0",
|
|
42
|
+
"@backstage/errors": "^0.2.2",
|
|
43
|
+
"@backstage/integration": "^0.8.0",
|
|
44
|
+
"@backstage/integration-react": "^0.1.25-next.0",
|
|
45
|
+
"@backstage/plugin-catalog-common": "^0.2.2-next.0",
|
|
46
|
+
"@backstage/plugin-catalog-react": "^0.9.0-next.0",
|
|
47
|
+
"@backstage/plugin-permission-react": "^0.3.3",
|
|
48
|
+
"@backstage/plugin-scaffolder-common": "^0.3.0-next.0",
|
|
49
49
|
"@backstage/theme": "^0.2.15",
|
|
50
|
-
"@backstage/types": "^0.1.
|
|
50
|
+
"@backstage/types": "^0.1.3",
|
|
51
51
|
"@material-ui/core": "^4.12.2",
|
|
52
52
|
"@material-ui/icons": "^4.9.1",
|
|
53
53
|
"@material-ui/lab": "4.0.0-alpha.57",
|
|
54
54
|
"@rjsf/core": "^3.2.1",
|
|
55
55
|
"@rjsf/material-ui": "^3.2.1",
|
|
56
|
+
"@types/json-schema": "^7.0.9",
|
|
56
57
|
"classnames": "^2.2.6",
|
|
57
58
|
"git-url-parse": "^11.6.0",
|
|
58
59
|
"humanize-duration": "^3.25.1",
|
|
@@ -72,11 +73,11 @@
|
|
|
72
73
|
"react": "^16.13.1 || ^17.0.0"
|
|
73
74
|
},
|
|
74
75
|
"devDependencies": {
|
|
75
|
-
"@backstage/cli": "^0.
|
|
76
|
-
"@backstage/core-app-api": "^0.
|
|
77
|
-
"@backstage/dev-utils": "^0.2.
|
|
78
|
-
"@backstage/plugin-catalog": "^0.
|
|
79
|
-
"@backstage/test-utils": "^0.
|
|
76
|
+
"@backstage/cli": "^0.15.2-next.0",
|
|
77
|
+
"@backstage/core-app-api": "^0.6.0",
|
|
78
|
+
"@backstage/dev-utils": "^0.2.25-next.0",
|
|
79
|
+
"@backstage/plugin-catalog": "^0.10.0-next.0",
|
|
80
|
+
"@backstage/test-utils": "^0.3.0",
|
|
80
81
|
"@testing-library/jest-dom": "^5.10.1",
|
|
81
82
|
"@testing-library/react": "^11.2.5",
|
|
82
83
|
"@testing-library/react-hooks": "^7.0.2",
|
|
@@ -91,5 +92,5 @@
|
|
|
91
92
|
"files": [
|
|
92
93
|
"dist"
|
|
93
94
|
],
|
|
94
|
-
"gitHead": "
|
|
95
|
+
"gitHead": "e90d3ed129ebfce978f1adfa40c1dc2cef3f7e65"
|
|
95
96
|
}
|