plugins: generate api reports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-17 11:00:16 +02:00
parent 5429bfa69e
commit d8d7226fce
54 changed files with 5209 additions and 0 deletions
@@ -0,0 +1,112 @@
+## API Report File for "@backstage/plugin-scaffolder"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ApiRef } from '@backstage/core';
+import { BackstagePlugin } from '@backstage/core';
+import { DiscoveryApi } from '@backstage/core';
+import { EntityName } from '@backstage/catalog-model';
+import { Extension } from '@backstage/core';
+import { ExternalRouteRef } from '@backstage/core';
+import { FieldProps } from '@rjsf/core';
+import { FieldValidation } from '@rjsf/core';
+import { IdentityApi } from '@backstage/core';
+import { JsonObject } from '@backstage/config';
+import { JSONSchema } from '@backstage/catalog-model';
+import { JsonValue } from '@backstage/config';
+import { Observable } from '@backstage/core';
+import { default as React_2 } from 'react';
+import { RouteRef } from '@backstage/core';
+import { ScmIntegrationRegistry } from '@backstage/integration';
+
+// @public (undocumented)
+export function createScaffolderFieldExtension<T = any>(options: FieldExtensionOptions<T>): Extension<() => null>;
+
+// @public (undocumented)
+export const EntityPickerFieldExtension: () => null;
+
+// @public (undocumented)
+export const OwnerPickerFieldExtension: () => null;
+
+// @public (undocumented)
+export const RepoUrlPickerFieldExtension: () => null;
+
+// @public (undocumented)
+export interface ScaffolderApi {
+    // (undocumented)
+    getIntegrationsList(options: {
+        allowedHosts: string[];
+    }): Promise<{
+        type: string;
+        title: string;
+        host: string;
+    }[]>;
+    // (undocumented)
+    getTask(taskId: string): Promise<ScaffolderTask>;
+    // (undocumented)
+    getTemplateParameterSchema(templateName: EntityName): Promise<TemplateParameterSchema>;
+    // (undocumented)
+    listActions(): Promise<ListActionsResponse>;
+    scaffold(templateName: string, values: Record<string, any>): Promise<string>;
+    // (undocumented)
+    streamLogs({ taskId, after, }: {
+        taskId: string;
+        after?: number;
+    }): Observable<LogEvent>;
+}
+
+// @public (undocumented)
+export const scaffolderApiRef: ApiRef<ScaffolderApi>;
+
+// @public (undocumented)
+export class ScaffolderClient implements ScaffolderApi {
+    constructor(options: {
+        discoveryApi: DiscoveryApi;
+        identityApi: IdentityApi;
+        scmIntegrationsApi: ScmIntegrationRegistry;
+    });
+    // (undocumented)
+    getIntegrationsList(options: {
+        allowedHosts: string[];
+    }): Promise<{
+        type: string;
+        title: string;
+        host: string;
+    }[]>;
+    // (undocumented)
+    getTask(taskId: string): Promise<any>;
+    // (undocumented)
+    getTemplateParameterSchema(templateName: EntityName): Promise<TemplateParameterSchema>;
+    // (undocumented)
+    listActions(): Promise<ListActionsResponse>;
+    scaffold(templateName: string, values: Record<string, any>): Promise<string>;
+    // (undocumented)
+    streamLogs({ taskId, after, }: {
+        taskId: string;
+        after?: number;
+    }): Observable<LogEvent>;
+}
+
+// @public (undocumented)
+export const ScaffolderFieldExtensions: React_2.ComponentType;
+
+// @public (undocumented)
+export const ScaffolderPage: () => JSX.Element;
+
+// @public (undocumented)
+const scaffolderPlugin: BackstagePlugin<{
+    root: RouteRef<undefined>;
+}, {
+    registerComponent: ExternalRouteRef<undefined, true>;
+}>;
+
+export { scaffolderPlugin as plugin }
+
+export { scaffolderPlugin }
+
+
+// (No @packageDocumentation comment for this package)
+
+```