@backstage/plugin-scaffolder 1.10.0-next.0 → 1.10.0-next.2

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.
@@ -10,48 +10,55 @@ import { ApiHolder } from '@backstage/core-plugin-api';
10
10
  import { ApiRef } from '@backstage/core-plugin-api';
11
11
  import { BackstagePlugin } from '@backstage/core-plugin-api';
12
12
  import { ComponentType } from 'react';
13
+ import { createScaffolderFieldExtension as createScaffolderFieldExtension_2 } from '@backstage/plugin-scaffolder-react';
14
+ import { CustomFieldExtensionSchema as CustomFieldExtensionSchema_2 } from '@backstage/plugin-scaffolder-react';
15
+ import { CustomFieldValidator as CustomFieldValidator_2 } from '@backstage/plugin-scaffolder-react';
13
16
  import { DiscoveryApi } from '@backstage/core-plugin-api';
14
17
  import { Entity } from '@backstage/catalog-model';
15
18
  import { Extension } from '@backstage/core-plugin-api';
16
19
  import { ExternalRouteRef } from '@backstage/core-plugin-api';
17
20
  import { FetchApi } from '@backstage/core-plugin-api';
18
- import { FieldProps } from '@rjsf/core';
19
- import { FieldProps as FieldProps_2 } from '@rjsf/utils';
21
+ import { FieldExtensionComponent as FieldExtensionComponent_2 } from '@backstage/plugin-scaffolder-react';
22
+ import { FieldExtensionComponentProps as FieldExtensionComponentProps_2 } from '@backstage/plugin-scaffolder-react';
23
+ import { FieldExtensionOptions as FieldExtensionOptions_2 } from '@backstage/plugin-scaffolder-react';
20
24
  import { FieldValidation } from '@rjsf/core';
21
- import { FieldValidation as FieldValidation_2 } from '@rjsf/utils';
22
25
  import type { FormProps as FormProps_2 } from '@rjsf/core';
23
26
  import type { FormProps as FormProps_3 } from '@rjsf/core-v5';
24
27
  import { IdentityApi } from '@backstage/core-plugin-api';
25
28
  import { JsonObject } from '@backstage/types';
26
- import { JSONSchema7 } from 'json-schema';
27
- import { JsonValue } from '@backstage/types';
29
+ import { ListActionsResponse as ListActionsResponse_2 } from '@backstage/plugin-scaffolder-react';
30
+ import { LogEvent as LogEvent_2 } from '@backstage/plugin-scaffolder-react';
28
31
  import { Observable } from '@backstage/types';
29
32
  import { PathParams } from '@backstage/core-plugin-api';
30
33
  import { PropsWithChildren } from 'react';
31
34
  import { default as React_2 } from 'react';
35
+ import { ReactNode } from 'react';
32
36
  import { RouteRef } from '@backstage/core-plugin-api';
37
+ import { ScaffolderApi as ScaffolderApi_2 } from '@backstage/plugin-scaffolder-react';
38
+ import { ScaffolderDryRunOptions as ScaffolderDryRunOptions_2 } from '@backstage/plugin-scaffolder-react';
39
+ import { ScaffolderDryRunResponse as ScaffolderDryRunResponse_2 } from '@backstage/plugin-scaffolder-react';
40
+ import { ScaffolderGetIntegrationsListOptions as ScaffolderGetIntegrationsListOptions_2 } from '@backstage/plugin-scaffolder-react';
41
+ import { ScaffolderGetIntegrationsListResponse as ScaffolderGetIntegrationsListResponse_2 } from '@backstage/plugin-scaffolder-react';
42
+ import { ScaffolderOutputLink } from '@backstage/plugin-scaffolder-react';
43
+ import { ScaffolderScaffoldOptions as ScaffolderScaffoldOptions_2 } from '@backstage/plugin-scaffolder-react';
44
+ import { ScaffolderScaffoldResponse as ScaffolderScaffoldResponse_2 } from '@backstage/plugin-scaffolder-react';
45
+ import { ScaffolderStreamLogsOptions as ScaffolderStreamLogsOptions_2 } from '@backstage/plugin-scaffolder-react';
46
+ import { ScaffolderTask as ScaffolderTask_2 } from '@backstage/plugin-scaffolder-react';
47
+ import { ScaffolderTaskOutput as ScaffolderTaskOutput_2 } from '@backstage/plugin-scaffolder-react';
48
+ import { ScaffolderTaskStatus as ScaffolderTaskStatus_2 } from '@backstage/plugin-scaffolder-react';
49
+ import { ScaffolderUseTemplateSecrets as ScaffolderUseTemplateSecrets_2 } from '@backstage/plugin-scaffolder-react';
33
50
  import { ScmIntegrationRegistry } from '@backstage/integration';
34
51
  import { SubRouteRef } from '@backstage/core-plugin-api';
35
- import { TaskSpec } from '@backstage/plugin-scaffolder-common';
36
- import { TaskStep } from '@backstage/plugin-scaffolder-common';
37
52
  import { TemplateEntityV1beta3 } from '@backstage/plugin-scaffolder-common';
38
- import { UIOptionsType } from '@rjsf/utils';
53
+ import { TemplateParameterSchema as TemplateParameterSchema_2 } from '@backstage/plugin-scaffolder-react';
39
54
  import { UiSchema } from '@rjsf/utils';
40
55
  import { z } from 'zod';
41
56
 
42
57
  /**
43
- * Method for creating field extensions that can be used in the scaffolder
44
- * frontend form.
45
- * @alpha
46
- */
47
- export declare function createNextScaffolderFieldExtension<TReturnValue = unknown, TInputProps extends UIOptionsType = {}>(options: NextFieldExtensionOptions<TReturnValue, TInputProps>): Extension<FieldExtensionComponent<TReturnValue, TInputProps>>;
48
-
49
- /**
50
- * Method for creating field extensions that can be used in the scaffolder
51
- * frontend form.
52
58
  * @public
59
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#createScaffolderFieldExtension} instead as this has now been moved.
53
60
  */
54
- export declare function createScaffolderFieldExtension<TReturnValue = unknown, TInputProps = unknown>(options: FieldExtensionOptions<TReturnValue, TInputProps>): Extension<FieldExtensionComponent<TReturnValue, TInputProps>>;
61
+ export declare const createScaffolderFieldExtension: typeof createScaffolderFieldExtension_2;
55
62
 
56
63
  /**
57
64
  * Method for creating custom Layouts that can be used in the scaffolder frontend form
@@ -61,37 +68,30 @@ export declare function createScaffolderFieldExtension<TReturnValue = unknown, T
61
68
  export declare function createScaffolderLayout<TInputProps = unknown>(options: LayoutOptions): Extension<LayoutComponent<TInputProps>>;
62
69
 
63
70
  /**
64
- * Type for the Custom Field Extension schema.
65
- *
66
71
  * @public
72
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#CustomFieldExtensionSchema} instead as this has now been moved.
67
73
  */
68
- export declare type CustomFieldExtensionSchema = {
69
- returnValue: JSONSchema7;
70
- uiOptions?: JSONSchema7;
71
- };
74
+ export declare type CustomFieldExtensionSchema = CustomFieldExtensionSchema_2;
72
75
 
73
76
  /**
74
- * Field validation type for Custom Field Extensions.
75
- *
76
77
  * @public
78
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#CustomFieldValidator} instead as this has now been moved.
77
79
  */
78
- export declare type CustomFieldValidator<TFieldReturnValue> = (data: TFieldReturnValue, field: FieldValidation, context: {
79
- apiHolder: ApiHolder;
80
- }) => void | Promise<void>;
80
+ export declare type CustomFieldValidator<TReturnFieldData> = CustomFieldValidator_2<TReturnFieldData>;
81
81
 
82
82
  /**
83
83
  * The field extension for selecting a name for a new Entity in the Catalog.
84
84
  *
85
85
  * @public
86
86
  */
87
- export declare const EntityNamePickerFieldExtension: FieldExtensionComponent<string, {}>;
87
+ export declare const EntityNamePickerFieldExtension: FieldExtensionComponent_2<string, {}>;
88
88
 
89
89
  /**
90
90
  * A field extension for selecting an Entity that exists in the Catalog.
91
91
  *
92
92
  * @public
93
93
  */
94
- export declare const EntityPickerFieldExtension: FieldExtensionComponent<string, {
94
+ export declare const EntityPickerFieldExtension: FieldExtensionComponent_2<string, {
95
95
  defaultKind?: string | undefined;
96
96
  defaultNamespace?: string | false | undefined;
97
97
  allowedKinds?: string[] | undefined;
@@ -122,7 +122,7 @@ export declare type EntityPickerUiOptions = typeof EntityPickerFieldSchema.uiOpt
122
122
  * EntityTagsPickerFieldExtension
123
123
  * @public
124
124
  */
125
- export declare const EntityTagsPickerFieldExtension: FieldExtensionComponent<string[], {
125
+ export declare const EntityTagsPickerFieldExtension: FieldExtensionComponent_2<string[], {
126
126
  showCounts?: boolean | undefined;
127
127
  kinds?: string[] | undefined;
128
128
  helperText?: string | undefined;
@@ -146,36 +146,22 @@ helperText?: string | undefined;
146
146
  export declare type EntityTagsPickerUiOptions = typeof EntityTagsPickerFieldSchema.uiOptionsType;
147
147
 
148
148
  /**
149
- * A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
150
- *
151
149
  * @public
150
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#FieldExtensionComponent} instead as this has now been moved.
152
151
  */
153
- export declare type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null;
152
+ export declare type FieldExtensionComponent<_TReturnValue, _TInputProps> = FieldExtensionComponent_2<_TReturnValue, _TInputProps>;
154
153
 
155
154
  /**
156
- * Type for field extensions and being able to type
157
- * incoming props easier.
158
- *
159
155
  * @public
156
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#FieldExtensionComponentProps} instead as this has now been moved.
160
157
  */
161
- export declare interface FieldExtensionComponentProps<TFieldReturnValue, TUiOptions extends {} = {}> extends FieldProps<TFieldReturnValue> {
162
- uiSchema: FieldProps['uiSchema'] & {
163
- 'ui:options'?: TUiOptions;
164
- };
165
- }
158
+ export declare type FieldExtensionComponentProps<TFieldReturnValue, TUiOptions extends {} = {}> = FieldExtensionComponentProps_2<TFieldReturnValue, TUiOptions>;
166
159
 
167
160
  /**
168
- * Type for the Custom Field Extension with the
169
- * name and components and validation function.
170
- *
171
161
  * @public
162
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#FieldExtensionOptions} instead as this has now been moved.
172
163
  */
173
- export declare type FieldExtensionOptions<TFieldReturnValue = unknown, TInputProps = unknown> = {
174
- name: string;
175
- component: (props: FieldExtensionComponentProps<TFieldReturnValue, TInputProps>) => JSX.Element | null;
176
- validation?: CustomFieldValidator<TFieldReturnValue>;
177
- schema?: CustomFieldExtensionSchema;
178
- };
164
+ export declare type FieldExtensionOptions = FieldExtensionOptions_2;
179
165
 
180
166
  /**
181
167
  * @public
@@ -183,8 +169,8 @@ export declare type FieldExtensionOptions<TFieldReturnValue = unknown, TInputPro
183
169
  * matching FieldExtensionComponentProps type for a field extension.
184
170
  */
185
171
  export declare interface FieldSchema<TReturn, TUiOptions> {
186
- readonly schema: CustomFieldExtensionSchema;
187
- readonly type: FieldExtensionComponentProps<TReturn, TUiOptions>;
172
+ readonly schema: CustomFieldExtensionSchema_2;
173
+ readonly type: FieldExtensionComponentProps_2<TReturn, TUiOptions>;
188
174
  readonly uiOptionsType: TUiOptions;
189
175
  }
190
176
 
@@ -192,6 +178,7 @@ export declare interface FieldSchema<TReturn, TUiOptions> {
192
178
  * Any `@rjsf/core` form properties that are publicly exposed to the `NextScaffolderpage`
193
179
  *
194
180
  * @alpha
181
+ * @deprecated use the import from {@link @backstage/plugin-scaffolder-react/alpha#FormProps} instead
195
182
  */
196
183
  export declare type FormProps = Pick<FormProps_3, 'transformErrors' | 'noHtml5Validate'>;
197
184
 
@@ -220,35 +207,16 @@ export declare interface LayoutOptions<P = any> {
220
207
  export declare type LayoutTemplate<T = any> = FormProps_2<T>['ObjectFieldTemplate'];
221
208
 
222
209
  /**
223
- * The response shape for the `listActions` call to the `scaffolder-backend`
224
- *
225
210
  * @public
211
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ListActionsResponse} instead as this has now been moved.
226
212
  */
227
- export declare type ListActionsResponse = Array<{
228
- id: string;
229
- description?: string;
230
- schema?: {
231
- input?: JSONSchema7;
232
- output?: JSONSchema7;
233
- };
234
- }>;
213
+ export declare type ListActionsResponse = ListActionsResponse_2;
235
214
 
236
215
  /**
237
- * The shape of a `LogEvent` message from the `scaffolder-backend`
238
- *
239
216
  * @public
217
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#LogEvent} instead as this has now been moved.
240
218
  */
241
- export declare type LogEvent = {
242
- type: 'log' | 'completion';
243
- body: {
244
- message: string;
245
- stepId?: string;
246
- status?: ScaffolderTaskStatus;
247
- };
248
- createdAt: string;
249
- id: string;
250
- taskId: string;
251
- };
219
+ export declare type LogEvent = LogEvent_2;
252
220
 
253
221
  /**
254
222
  * @public
@@ -257,40 +225,6 @@ export declare type LogEvent = {
257
225
  */
258
226
  export declare function makeFieldSchemaFromZod<TReturnSchema extends z.ZodType, TUiOptionsSchema extends z.ZodType = z.ZodType<any, any, {}>>(returnSchema: TReturnSchema, uiOptionsSchema?: TUiOptionsSchema): FieldSchema<TReturnSchema extends z.ZodType<any, any, infer IReturn> ? IReturn : never, TUiOptionsSchema extends z.ZodType<any, any, infer IUiOptions> ? IUiOptions : never>;
259
227
 
260
- /**
261
- * Field validation type for Custom Field Extensions.
262
- *
263
- * @alpha
264
- */
265
- export declare type NextCustomFieldValidator<TFieldReturnValue> = (data: TFieldReturnValue, field: FieldValidation_2, context: {
266
- apiHolder: ApiHolder;
267
- formData: JsonObject;
268
- }) => void | Promise<void>;
269
-
270
- /**
271
- * Type for Field Extension Props for RJSF v5
272
- *
273
- * @alpha
274
- */
275
- export declare interface NextFieldExtensionComponentProps<TFieldReturnValue, TUiOptions = {}> extends PropsWithChildren<FieldProps_2<TFieldReturnValue>> {
276
- uiSchema?: UiSchema<TFieldReturnValue> & {
277
- 'ui:options'?: TUiOptions & UIOptionsType;
278
- };
279
- }
280
-
281
- /**
282
- * Type for the Custom Field Extension with the
283
- * name and components and validation function.
284
- *
285
- * @alpha
286
- */
287
- export declare type NextFieldExtensionOptions<TFieldReturnValue = unknown, TInputProps = unknown> = {
288
- name: string;
289
- component: (props: NextFieldExtensionComponentProps<TFieldReturnValue, TInputProps>) => JSX.Element | null;
290
- validation?: NextCustomFieldValidator<TFieldReturnValue>;
291
- schema?: CustomFieldExtensionSchema;
292
- };
293
-
294
228
  /** @alpha */
295
229
  export declare const nextRouteRef: RouteRef<undefined>;
296
230
 
@@ -316,6 +250,9 @@ export declare type NextRouterProps = {
316
250
  */
317
251
  export declare const NextScaffolderPage: (props: PropsWithChildren<NextRouterProps>) => JSX.Element;
318
252
 
253
+ /** @alpha */
254
+ export declare const nextScaffolderTaskRouteRef: SubRouteRef<PathParams<"/tasks/:taskId">>;
255
+
319
256
  /** @alpha */
320
257
  export declare const nextSelectedTemplateRouteRef: SubRouteRef<PathParams<"/templates/:namespace/:templateName">>;
321
258
 
@@ -324,7 +261,7 @@ export declare const nextSelectedTemplateRouteRef: SubRouteRef<PathParams<"/temp
324
261
  *
325
262
  * @public
326
263
  */
327
- export declare const OwnedEntityPickerFieldExtension: FieldExtensionComponent<string, {
264
+ export declare const OwnedEntityPickerFieldExtension: FieldExtensionComponent_2<string, {
328
265
  defaultKind?: string | undefined;
329
266
  defaultNamespace?: string | false | undefined;
330
267
  allowedKinds?: string[] | undefined;
@@ -354,7 +291,7 @@ export declare type OwnedEntityPickerUiOptions = typeof OwnedEntityPickerFieldSc
354
291
  *
355
292
  * @public
356
293
  */
357
- export declare const OwnerPickerFieldExtension: FieldExtensionComponent<string, {
294
+ export declare const OwnerPickerFieldExtension: FieldExtensionComponent_2<string, {
358
295
  defaultNamespace?: string | false | undefined;
359
296
  allowedKinds?: string[] | undefined;
360
297
  allowArbitraryValues?: boolean | undefined;
@@ -396,12 +333,12 @@ export declare const repoPickerValidation: (value: string, validation: FieldVali
396
333
  *
397
334
  * @public
398
335
  */
399
- export declare const RepoUrlPickerFieldExtension: FieldExtensionComponent<string, {
400
- allowedOwners?: string[] | undefined;
336
+ export declare const RepoUrlPickerFieldExtension: FieldExtensionComponent_2<string, {
337
+ allowedHosts?: string[] | undefined;
401
338
  allowedOrganizations?: string[] | undefined;
339
+ allowedOwners?: string[] | undefined;
402
340
  allowedProjects?: string[] | undefined;
403
341
  allowedRepos?: string[] | undefined;
404
- allowedHosts?: string[] | undefined;
405
342
  requestUserCredentials?: {
406
343
  additionalScopes?: {
407
344
  azure?: string[] | undefined;
@@ -418,11 +355,11 @@ secretsKey: string;
418
355
  * @public
419
356
  */
420
357
  export declare const RepoUrlPickerFieldSchema: FieldSchema<string, {
421
- allowedOwners?: string[] | undefined;
358
+ allowedHosts?: string[] | undefined;
422
359
  allowedOrganizations?: string[] | undefined;
360
+ allowedOwners?: string[] | undefined;
423
361
  allowedProjects?: string[] | undefined;
424
362
  allowedRepos?: string[] | undefined;
425
- allowedHosts?: string[] | undefined;
426
363
  requestUserCredentials?: {
427
364
  additionalScopes?: {
428
365
  azure?: string[] | undefined;
@@ -462,7 +399,10 @@ export declare type ReviewStepProps = {
462
399
  }[];
463
400
  };
464
401
 
465
- /** @public */
402
+ /**
403
+ * @public
404
+ * @deprecated use import from `{@link @backstage/plugin-scaffolder#scaffolderPlugin}.routes.root` instead.
405
+ */
466
406
  export declare const rootRouteRef: RouteRef<undefined>;
467
407
 
468
408
  /**
@@ -499,47 +439,23 @@ export declare type RouterProps = {
499
439
  };
500
440
 
501
441
  /**
502
- * An API to interact with the scaffolder backend.
503
- *
504
442
  * @public
443
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderApi} instead as this has now been moved.
505
444
  */
506
- export declare interface ScaffolderApi {
507
- getTemplateParameterSchema(templateRef: string): Promise<TemplateParameterSchema>;
508
- /**
509
- * Executes the scaffolding of a component, given a template and its
510
- * parameter values.
511
- *
512
- * @param options - The {@link ScaffolderScaffoldOptions} the scaffolding.
513
- */
514
- scaffold(options: ScaffolderScaffoldOptions): Promise<ScaffolderScaffoldResponse>;
515
- getTask(taskId: string): Promise<ScaffolderTask>;
516
- listTasks?(options: {
517
- filterByOwnership: 'owned' | 'all';
518
- }): Promise<{
519
- tasks: ScaffolderTask[];
520
- }>;
521
- getIntegrationsList(options: ScaffolderGetIntegrationsListOptions): Promise<ScaffolderGetIntegrationsListResponse>;
522
- /**
523
- * Returns a list of all installed actions.
524
- */
525
- listActions(): Promise<ListActionsResponse>;
526
- streamLogs(options: ScaffolderStreamLogsOptions): Observable<LogEvent>;
527
- dryRun?(options: ScaffolderDryRunOptions): Promise<ScaffolderDryRunResponse>;
528
- }
445
+ export declare type ScaffolderApi = ScaffolderApi_2;
529
446
 
530
447
  /**
531
- * Utility API reference for the {@link ScaffolderApi}.
532
- *
533
448
  * @public
449
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#scaffolderApiRef} instead as this has now been moved.
534
450
  */
535
- export declare const scaffolderApiRef: ApiRef<ScaffolderApi>;
451
+ export declare const scaffolderApiRef: ApiRef<ScaffolderApi_2>;
536
452
 
537
453
  /**
538
454
  * An API to interact with the scaffolder backend.
539
455
  *
540
456
  * @public
541
457
  */
542
- export declare class ScaffolderClient implements ScaffolderApi {
458
+ export declare class ScaffolderClient implements ScaffolderApi_2 {
543
459
  private readonly discoveryApi;
544
460
  private readonly scmIntegrationsApi;
545
461
  private readonly fetchApi;
@@ -555,76 +471,50 @@ export declare class ScaffolderClient implements ScaffolderApi {
555
471
  listTasks(options: {
556
472
  filterByOwnership: 'owned' | 'all';
557
473
  }): Promise<{
558
- tasks: ScaffolderTask[];
474
+ tasks: ScaffolderTask_2[];
559
475
  }>;
560
- getIntegrationsList(options: ScaffolderGetIntegrationsListOptions): Promise<ScaffolderGetIntegrationsListResponse>;
561
- getTemplateParameterSchema(templateRef: string): Promise<TemplateParameterSchema>;
562
- /**
563
- * Executes the scaffolding of a component, given a template and its
564
- * parameter values.
565
- *
566
- * @param options - The {@link ScaffolderScaffoldOptions} the scaffolding.
567
- */
568
- scaffold(options: ScaffolderScaffoldOptions): Promise<ScaffolderScaffoldResponse>;
569
- getTask(taskId: string): Promise<ScaffolderTask>;
570
- streamLogs(options: ScaffolderStreamLogsOptions): Observable<LogEvent>;
571
- dryRun(options: ScaffolderDryRunOptions): Promise<ScaffolderDryRunResponse>;
476
+ getIntegrationsList(options: ScaffolderGetIntegrationsListOptions_2): Promise<ScaffolderGetIntegrationsListResponse_2>;
477
+ getTemplateParameterSchema(templateRef: string): Promise<TemplateParameterSchema_2>;
478
+ scaffold(options: ScaffolderScaffoldOptions_2): Promise<ScaffolderScaffoldResponse_2>;
479
+ getTask(taskId: string): Promise<ScaffolderTask_2>;
480
+ streamLogs(options: ScaffolderStreamLogsOptions_2): Observable<LogEvent_2>;
481
+ dryRun(options: ScaffolderDryRunOptions_2): Promise<ScaffolderDryRunResponse_2>;
572
482
  private streamLogsEventStream;
573
483
  private streamLogsPolling;
574
- listActions(): Promise<ListActionsResponse>;
484
+ listActions(): Promise<ListActionsResponse_2>;
575
485
  }
576
486
 
577
- /** @public */
578
- export declare interface ScaffolderDryRunOptions {
579
- template: JsonValue;
580
- values: JsonObject;
581
- secrets?: Record<string, string>;
582
- directoryContents: {
583
- path: string;
584
- base64Content: string;
585
- }[];
586
- }
487
+ /**
488
+ * @public
489
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderDryRunOptions} instead as this has now been moved.
490
+ */
491
+ export declare type ScaffolderDryRunOptions = ScaffolderDryRunOptions_2;
587
492
 
588
- /** @public */
589
- export declare interface ScaffolderDryRunResponse {
590
- directoryContents: Array<{
591
- path: string;
592
- base64Content: string;
593
- executable: boolean;
594
- }>;
595
- log: Array<Pick<LogEvent, 'body'>>;
596
- steps: TaskStep[];
597
- output: ScaffolderTaskOutput;
598
- }
493
+ /**
494
+ * @public
495
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderDryRunResponse} instead as this has now been moved.
496
+ */
497
+ export declare type ScaffolderDryRunResponse = ScaffolderDryRunResponse_2;
599
498
 
600
499
  /**
601
- * The Wrapping component for defining fields extensions inside
602
- *
603
500
  * @public
501
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderFieldExtensions} instead as this has now been moved.
604
502
  */
605
- export declare const ScaffolderFieldExtensions: React_2.ComponentType;
503
+ export declare const ScaffolderFieldExtensions: ComponentType< {
504
+ children?: ReactNode;
505
+ }>;
606
506
 
607
507
  /**
608
- * The arguments for `getIntegrationsList`.
609
- *
610
508
  * @public
509
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderGetIntegrationsListOptions} instead as this has now been moved.
611
510
  */
612
- export declare interface ScaffolderGetIntegrationsListOptions {
613
- allowedHosts: string[];
614
- }
511
+ export declare type ScaffolderGetIntegrationsListOptions = ScaffolderGetIntegrationsListOptions_2;
615
512
 
616
513
  /**
617
- * The response shape for `getIntegrationsList`.
618
- *
619
514
  * @public
515
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderGetIntegrationsListResponse} instead as this has now been moved.
620
516
  */
621
- export declare interface ScaffolderGetIntegrationsListResponse {
622
- integrations: {
623
- type: string;
624
- title: string;
625
- host: string;
626
- }[];
627
- }
517
+ export declare type ScaffolderGetIntegrationsListResponse = ScaffolderGetIntegrationsListResponse_2;
628
518
 
629
519
  /**
630
520
  * The wrapping component for defining scaffolder layouts as children
@@ -633,13 +523,11 @@ export declare interface ScaffolderGetIntegrationsListResponse {
633
523
  */
634
524
  export declare const ScaffolderLayouts: React.ComponentType;
635
525
 
636
- /** @public */
637
- export declare type ScaffolderOutputLink = {
638
- title?: string;
639
- icon?: string;
640
- url?: string;
641
- entityRef?: string;
642
- };
526
+ /**
527
+ * @public
528
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderOutputlink} instead as this has now been moved.
529
+ */
530
+ export declare type ScaffolderOutputlink = ScaffolderOutputLink;
643
531
 
644
532
  /**
645
533
  * The Router and main entrypoint to the Scaffolder plugin.
@@ -654,6 +542,8 @@ export declare const ScaffolderPage: (props: RouterProps) => JSX.Element;
654
542
  */
655
543
  export declare const scaffolderPlugin: BackstagePlugin< {
656
544
  root: RouteRef<undefined>;
545
+ selectedTemplate: SubRouteRef<PathParams<"/templates/:namespace/:templateName">>;
546
+ ongoingTask: SubRouteRef<PathParams<"/tasks/:taskId">>;
657
547
  }, {
658
548
  registerComponent: ExternalRouteRef<undefined, true>;
659
549
  viewTechDoc: ExternalRouteRef< {
@@ -664,72 +554,46 @@ namespace: string;
664
554
  }, {}>;
665
555
 
666
556
  /**
667
- * The input options to the `scaffold` method of the `ScaffolderClient`.
668
- *
669
557
  * @public
558
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderScaffoldOptions} instead as this has now been moved.
670
559
  */
671
- export declare interface ScaffolderScaffoldOptions {
672
- templateRef: string;
673
- values: Record<string, JsonValue>;
674
- secrets?: Record<string, string>;
675
- }
560
+ export declare type ScaffolderScaffoldOptions = ScaffolderScaffoldOptions_2;
676
561
 
677
562
  /**
678
- * The response shape of the `scaffold` method of the `ScaffolderClient`.
679
- *
680
563
  * @public
564
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderScaffoldResponse} instead as this has now been moved.
681
565
  */
682
- export declare interface ScaffolderScaffoldResponse {
683
- taskId: string;
684
- }
566
+ export declare type ScaffolderScaffoldResponse = ScaffolderScaffoldResponse_2;
685
567
 
686
568
  /**
687
- * The input options to the `streamLogs` method of the `ScaffolderClient`.
688
- *
689
569
  * @public
570
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderStreamLogsOptions} instead as this has now been moved.
690
571
  */
691
- export declare interface ScaffolderStreamLogsOptions {
692
- taskId: string;
693
- after?: number;
694
- }
572
+ export declare type ScaffolderStreamLogsOptions = ScaffolderStreamLogsOptions_2;
695
573
 
696
574
  /**
697
- * The shape of each task returned from the `scaffolder-backend`
698
- *
699
575
  * @public
576
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderTask} instead as this has now been moved.
700
577
  */
701
- export declare type ScaffolderTask = {
702
- id: string;
703
- spec: TaskSpec;
704
- status: 'failed' | 'completed' | 'processing' | 'open' | 'cancelled';
705
- lastHeartbeatAt: string;
706
- createdAt: string;
707
- };
708
-
709
- /** @public */
710
- export declare type ScaffolderTaskOutput = {
711
- links?: ScaffolderOutputLink[];
712
- } & {
713
- [key: string]: unknown;
714
- };
578
+ export declare type ScaffolderTask = ScaffolderTask_2;
715
579
 
716
580
  /**
717
- * The status of each task in a Scaffolder Job
718
- *
719
581
  * @public
582
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderTaskOutput} instead as this has now been moved.
720
583
  */
721
- export declare type ScaffolderTaskStatus = 'open' | 'processing' | 'failed' | 'completed' | 'skipped';
584
+ export declare type ScaffolderTaskOutput = ScaffolderTaskOutput_2;
722
585
 
723
586
  /**
724
- * The return type from the useTemplateSecrets hook.
725
587
  * @public
588
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderTaskStatus} instead as this has now been moved.
726
589
  */
727
- export declare interface ScaffolderUseTemplateSecrets {
728
- setSecrets: (input: Record<string, string>) => void;
729
- }
590
+ export declare type ScaffolderTaskStatus = ScaffolderTaskStatus_2;
730
591
 
731
- /** @public */
732
- export declare const selectedTemplateRouteRef: SubRouteRef<PathParams<"/templates/:namespace/:templateName">>;
592
+ /**
593
+ * @public
594
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#ScaffolderUseTemplateSecrets} instead as this has now been moved.
595
+ */
596
+ export declare type ScaffolderUseTemplateSecrets = ScaffolderUseTemplateSecrets_2;
733
597
 
734
598
  /**
735
599
  * TaskPage for showing the status of the taskId provided as a param
@@ -758,20 +622,10 @@ export declare type TemplateGroupFilter = {
758
622
  };
759
623
 
760
624
  /**
761
- * The shape of each entry of parameters which gets rendered
762
- * as a separate step in the wizard input
763
- *
764
625
  * @public
626
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#TemplateParameterSchema} instead as this has now been moved.
765
627
  */
766
- export declare type TemplateParameterSchema = {
767
- title: string;
768
- description?: string;
769
- steps: Array<{
770
- title: string;
771
- description?: string;
772
- schema: JsonObject;
773
- }>;
774
- };
628
+ export declare type TemplateParameterSchema = TemplateParameterSchema_2;
775
629
 
776
630
  /**
777
631
  * The component to select the `type` of `Template` that you will see in the table.
@@ -781,9 +635,9 @@ export declare type TemplateParameterSchema = {
781
635
  export declare const TemplateTypePicker: () => JSX.Element | null;
782
636
 
783
637
  /**
784
- * Hook to access the secrets context.
785
638
  * @public
639
+ * @deprecated use import from {@link @backstage/plugin-scaffolder-react#useTemplateSecrets} instead as this has now been moved.
786
640
  */
787
- export declare const useTemplateSecrets: () => ScaffolderUseTemplateSecrets;
641
+ export declare const useTemplateSecrets: () => ScaffolderUseTemplateSecrets_2;
788
642
 
789
643
  export { }