Merge pull request #6433 from backstage/rugvip/report-all-the-things

root: bump api-extractor & friends + recreate API reports along with previously unsupported packages
2021-07-12 20:28:09 +02:00
parent 11251fedfc a07354e109
commit 1118f33e4f
82 changed files with 9295 additions and 4009 deletions
@@ -3,6 +3,7 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

 ```ts
+/// <reference types="node" />

 import { CatalogApi } from '@backstage/catalog-client';
 import { Config } from '@backstage/config';
@@ -22,37 +23,40 @@ import { Writable } from 'stream';

 // @public (undocumented)
 export type ActionContext<Input extends InputBase> = {
-    baseUrl?: string;
-    logger: Logger_2;
-    logStream: Writable;
-    token?: string | undefined;
-    workspacePath: string;
-    input: Input;
-    output(name: string, value: JsonValue): void;
-    createTemporaryDirectory(): Promise<string>;
+  baseUrl?: string;
+  logger: Logger_2;
+  logStream: Writable;
+  token?: string | undefined;
+  workspacePath: string;
+  input: Input;
+  output(name: string, value: JsonValue): void;
+  createTemporaryDirectory(): Promise<string>;
 };

 // @public
 export class CatalogEntityClient {
-    constructor(catalogClient: CatalogApi);
-    findTemplate(templateName: string, options?: {
-        token?: string;
-    }): Promise<TemplateEntityV1beta2>;
+  constructor(catalogClient: CatalogApi);
+  findTemplate(
+    templateName: string,
+    options?: {
+      token?: string;
+    },
+  ): Promise<TemplateEntityV1beta2>;
 }

 // @public (undocumented)
 export const createBuiltinActions: (options: {
-    reader: UrlReader;
-    integrations: ScmIntegrations;
-    catalogClient: CatalogApi;
-    containerRunner: ContainerRunner;
-    config: Config;
+  reader: UrlReader;
+  integrations: ScmIntegrations;
+  catalogClient: CatalogApi;
+  containerRunner: ContainerRunner;
+  config: Config;
 }) => TemplateAction<any>[];

 // @public (undocumented)
 export function createCatalogRegisterAction(options: {
-    catalogClient: CatalogApi;
-    integrations: ScmIntegrations;
+  catalogClient: CatalogApi;
+  integrations: ScmIntegrations;
 }): TemplateAction<any>;

 // @public (undocumented)
@@ -63,21 +67,21 @@ export function createDebugLogAction(): TemplateAction<any>;

 // @public (undocumented)
 export function createFetchCookiecutterAction(options: {
-    reader: UrlReader;
-    integrations: ScmIntegrations;
-    containerRunner: ContainerRunner;
+  reader: UrlReader;
+  integrations: ScmIntegrations;
+  containerRunner: ContainerRunner;
 }): TemplateAction<any>;

 // @public (undocumented)
 export function createFetchPlainAction(options: {
-    reader: UrlReader;
-    integrations: ScmIntegrations;
+  reader: UrlReader;
+  integrations: ScmIntegrations;
 }): TemplateAction<any>;

 // @public (undocumented)
 export function createFetchTemplateAction(options: {
-    reader: UrlReader;
-    integrations: ScmIntegrations;
+  reader: UrlReader;
+  integrations: ScmIntegrations;
 }): TemplateAction<any>;

 // @public (undocumented)
@@ -88,14 +92,14 @@ export const createFilesystemRenameAction: () => TemplateAction<any>;

 // @public (undocumented)
 export function createPublishAzureAction(options: {
-    integrations: ScmIntegrationRegistry;
-    config: Config;
+  integrations: ScmIntegrationRegistry;
+  config: Config;
 }): TemplateAction<any>;

 // @public (undocumented)
 export function createPublishBitbucketAction(options: {
-    integrations: ScmIntegrationRegistry;
-    config: Config;
+  integrations: ScmIntegrationRegistry;
+  config: Config;
 }): TemplateAction<any>;

 // @public
@@ -103,81 +107,98 @@ export function createPublishFileAction(): TemplateAction<any>;

 // @public (undocumented)
 export function createPublishGithubAction(options: {
-    integrations: ScmIntegrationRegistry;
-    config: Config;
+  integrations: ScmIntegrationRegistry;
+  config: Config;
 }): TemplateAction<any>;

 // @public (undocumented)
-export const createPublishGithubPullRequestAction: ({ integrations, clientFactory, }: CreateGithubPullRequestActionOptions) => TemplateAction<any>;
+export const createPublishGithubPullRequestAction: ({
+  integrations,
+  clientFactory,
+}: CreateGithubPullRequestActionOptions) => TemplateAction<any>;

 // @public (undocumented)
 export function createPublishGitlabAction(options: {
-    integrations: ScmIntegrationRegistry;
-    config: Config;
+  integrations: ScmIntegrationRegistry;
+  config: Config;
 }): TemplateAction<any>;

 // @public (undocumented)
 export function createRouter(options: RouterOptions): Promise<express.Router>;

 // @public (undocumented)
-export const createTemplateAction: <Input extends Partial<{
-    [name: string]: JsonValue| Partial<JsonObject> | undefined;
-}>>(templateAction: TemplateAction<Input>) => TemplateAction<any>;
+export const createTemplateAction: <
+  Input extends Partial<{
+    [name: string]: JsonValue | Partial<JsonObject> | undefined;
+  }>
+>(
+  templateAction: TemplateAction<Input>,
+) => TemplateAction<any>;

 // @public (undocumented)
-export function fetchContents({ reader, integrations, baseUrl, fetchUrl, outputPath, }: {
-    reader: UrlReader;
-    integrations: ScmIntegrations;
-    baseUrl?: string;
-    fetchUrl?: JsonValue;
-    outputPath: string;
+export function fetchContents({
+  reader,
+  integrations,
+  baseUrl,
+  fetchUrl,
+  outputPath,
+}: {
+  reader: UrlReader;
+  integrations: ScmIntegrations;
+  baseUrl?: string;
+  fetchUrl?: JsonValue;
+  outputPath: string;
 }): Promise<void>;

 // @public (undocumented)
 export interface RouterOptions {
-    // (undocumented)
-    actions?: TemplateAction<any>[];
-    // (undocumented)
-    catalogClient: CatalogApi;
-    // (undocumented)
-    config: Config;
-    // (undocumented)
-    containerRunner: ContainerRunner;
-    // (undocumented)
-    database: PluginDatabaseManager;
-    // (undocumented)
-    logger: Logger_2;
-    // (undocumented)
-    reader: UrlReader;
-    // (undocumented)
-    taskWorkers?: number;
+  // (undocumented)
+  actions?: TemplateAction<any>[];
+  // (undocumented)
+  catalogClient: CatalogApi;
+  // (undocumented)
+  config: Config;
+  // (undocumented)
+  containerRunner: ContainerRunner;
+  // (undocumented)
+  database: PluginDatabaseManager;
+  // (undocumented)
+  logger: Logger_2;
+  // (undocumented)
+  reader: UrlReader;
+  // (undocumented)
+  taskWorkers?: number;
 }

 // @public (undocumented)
-export const runCommand: ({ command, args, logStream, }: RunCommandOptions) => Promise<void>;
+export const runCommand: ({
+  command,
+  args,
+  logStream,
+}: RunCommandOptions) => Promise<void>;

 // @public (undocumented)
 export type TemplateAction<Input extends InputBase> = {
-    id: string;
-    description?: string;
-    schema?: {
-        input?: Schema;
-        output?: Schema;
-    };
-    handler: (ctx: ActionContext<Input>) => Promise<void>;
+  id: string;
+  description?: string;
+  schema?: {
+    input?: Schema;
+    output?: Schema;
+  };
+  handler: (ctx: ActionContext<Input>) => Promise<void>;
 };

 // @public (undocumented)
 export class TemplateActionRegistry {
-    // (undocumented)
-    get(actionId: string): TemplateAction<any>;
-    // (undocumented)
-    list(): TemplateAction<any>[];
-    // (undocumented)
-    register<Parameters extends InputBase>(action: TemplateAction<Parameters>): void;
+  // (undocumented)
+  get(actionId: string): TemplateAction<any>;
+  // (undocumented)
+  list(): TemplateAction<any>[];
+  // (undocumented)
+  register<Parameters extends InputBase>(
+    action: TemplateAction<Parameters>,
+  ): void;
 }

-
 // (No @packageDocumentation comment for this package)
-
 ```