From 0d6167f1aa28ae50ff04d94368ad77114e7ddbd5 Mon Sep 17 00:00:00 2001 From: Rogerio Angeliski Date: Thu, 28 Apr 2022 09:51:20 -0300 Subject: [PATCH] feat: update api-report Signed-off-by: Rogerio Angeliski --- plugins/scaffolder-backend/api-report.md | 7 +++++++ plugins/scaffolder/api-report.md | 9 +++++++++ .../ListTasksPage/columns/OwnerEntityColumn.tsx | 6 +----- plugins/scaffolder/src/index.ts | 1 + 4 files changed, 18 insertions(+), 5 deletions(-) diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index b059a30d9b..fe3b14762b 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -395,6 +395,8 @@ export class DatabaseTaskStore implements TaskStore { // (undocumented) heartbeatTask(taskId: string): Promise; // (undocumented) + list(options: Partial): Promise; + // (undocumented) listEvents({ taskId, after }: TaskStoreListEventsOptions): Promise<{ events: SerializedTaskEvent[]; }>; @@ -493,6 +495,7 @@ export type SerializedTask = { lastHeartbeatAt?: string; createdBy?: string; secrets?: TaskSecrets; + createdBy: string | null; }; // @public @@ -519,6 +522,8 @@ export interface TaskBroker { // (undocumented) get(taskId: string): Promise; // (undocumented) + list(options?: Partial): Promise; + // (undocumented) vacuumTasks(options: { timeoutS: number }): Promise; } @@ -616,6 +621,8 @@ export interface TaskStore { // (undocumented) heartbeatTask(taskId: string): Promise; // (undocumented) + list(options: Partial): Promise; + // (undocumented) listEvents({ taskId, after }: TaskStoreListEventsOptions): Promise<{ events: SerializedTaskEvent[]; }>; diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md index 229737eaf6..159fd10871 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.md @@ -16,6 +16,7 @@ import { ExternalRouteRef } from '@backstage/core-plugin-api'; import { FetchApi } from '@backstage/core-plugin-api'; import { FieldProps } from '@rjsf/core'; import { FieldValidation } from '@rjsf/core'; +import { IdentityApi } from '@backstage/core-plugin-api'; import { JsonObject } from '@backstage/types'; import { JSONSchema7 } from 'json-schema'; import { JsonValue } from '@backstage/types'; @@ -237,6 +238,8 @@ export interface ScaffolderApi { templateRef: string, ): Promise; listActions(): Promise; + // (undocumented) + listTasks(createdBy: TasksOwnerFilterKind): Promise; scaffold( options: ScaffolderScaffoldOptions, ): Promise; @@ -252,6 +255,7 @@ export class ScaffolderClient implements ScaffolderApi { constructor(options: { discoveryApi: DiscoveryApi; fetchApi: FetchApi; + identityApi: IdentityApi; scmIntegrationsApi: ScmIntegrationRegistry; useLongPollingLogs?: boolean; }); @@ -267,6 +271,8 @@ export class ScaffolderClient implements ScaffolderApi { ): Promise; // (undocumented) listActions(): Promise; + // (undocumented) + listTasks(createdBy: TasksOwnerFilterKind): Promise; scaffold( options: ScaffolderScaffoldOptions, ): Promise; @@ -376,6 +382,9 @@ export type TaskPageProps = { loadingText?: string; }; +// @public +export type TasksOwnerFilterKind = 'owned' | 'all'; + // @alpha (undocumented) export type TemplateGroupFilter = { title?: React_2.ReactNode; diff --git a/plugins/scaffolder/src/components/ListTasksPage/columns/OwnerEntityColumn.tsx b/plugins/scaffolder/src/components/ListTasksPage/columns/OwnerEntityColumn.tsx index d2ca8f2620..e595c11199 100644 --- a/plugins/scaffolder/src/components/ListTasksPage/columns/OwnerEntityColumn.tsx +++ b/plugins/scaffolder/src/components/ListTasksPage/columns/OwnerEntityColumn.tsx @@ -23,11 +23,7 @@ import { ListItemText } from '@material-ui/core'; import { catalogApiRef, entityRouteRef } from '@backstage/plugin-catalog-react'; import { parseEntityRef, UserEntity } from '@backstage/catalog-model'; -export const OwnerEntityColumn = ({ - entityRef, -}: { - entityRef?: string | null; -}) => { +export const OwnerEntityColumn = ({ entityRef }: { entityRef?: string }) => { const catalogApi = useApi(catalogApiRef); const catalogEntityRoute = useRouteRef(entityRouteRef); diff --git a/plugins/scaffolder/src/index.ts b/plugins/scaffolder/src/index.ts index fc132f644c..4f4c650f1c 100644 --- a/plugins/scaffolder/src/index.ts +++ b/plugins/scaffolder/src/index.ts @@ -35,6 +35,7 @@ export type { ScaffolderTaskOutput, ScaffolderTaskStatus, TemplateParameterSchema, + TasksOwnerFilterKind, } from './types'; export { createScaffolderFieldExtension,