From e01a2e93caeaec35b95afa50189df1b2548d402c Mon Sep 17 00:00:00 2001 From: Frank Kong Date: Thu, 2 May 2024 23:16:04 -0400 Subject: [PATCH] chore: fix tsc errors and update api-report Signed-off-by: Frank Kong --- plugins/scaffolder-backend/api-report.md | 14 +-------- .../scaffolder-backend/src/service/router.ts | 30 +++++-------------- plugins/scaffolder-common/api-report-alpha.md | 17 ++++------- 3 files changed, 14 insertions(+), 47 deletions(-) diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index e99ac56bee..e6738497fe 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -36,7 +36,6 @@ import { PermissionsService } from '@backstage/backend-plugin-api'; import { PluginDatabaseManager } from '@backstage/backend-common'; import { PluginTaskScheduler } from '@backstage/backend-tasks'; import { RESOURCE_TYPE_SCAFFOLDER_ACTION } from '@backstage/plugin-scaffolder-common/alpha'; -import { RESOURCE_TYPE_SCAFFOLDER_TASK } from '@backstage/plugin-scaffolder-common/alpha'; import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common/alpha'; import { ScaffolderEntitiesProcessor as ScaffolderEntitiesProcessor_2 } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model'; import { Schema } from 'jsonschema'; @@ -502,8 +501,7 @@ export const ScaffolderEntitiesProcessor: typeof ScaffolderEntitiesProcessor_2; // @public (undocumented) export type ScaffolderPermissionRuleInput = | TemplatePermissionRuleInput - | ActionPermissionRuleInput - | TaskPermissionRuleInput; + | ActionPermissionRuleInput; // @public @deprecated export type SerializedTask = SerializedTask_2; @@ -580,16 +578,6 @@ export class TaskManager implements TaskContext_2 { ): Promise; } -// @public (undocumented) -export type TaskPermissionRuleInput< - TParams extends PermissionRuleParams = PermissionRuleParams, -> = PermissionRule< - TemplateEntityStepV1beta3 | TemplateParametersV1beta3, - {}, - typeof RESOURCE_TYPE_SCAFFOLDER_TASK, - TParams ->; - // @public @deprecated (undocumented) export type TaskSecrets = TaskSecrets_2; diff --git a/plugins/scaffolder-backend/src/service/router.ts b/plugins/scaffolder-backend/src/service/router.ts index 287d058030..ff1796e71f 100644 --- a/plugins/scaffolder-backend/src/service/router.ts +++ b/plugins/scaffolder-backend/src/service/router.ts @@ -104,10 +104,13 @@ import { import { InternalTaskSecrets } from '../scaffolder/tasks/types'; import { checkPermission } from '../util/checkPermissions'; -type ScaffolderPermissionRuleInput = +/** + * + * @public + */ +export type ScaffolderPermissionRuleInput = | TemplatePermissionRuleInput - | ActionPermissionRuleInput - | TaskPermissionRuleInput; + | ActionPermissionRuleInput; /** * @@ -145,23 +148,6 @@ function isActionPermissionRuleInput( return permissionRule.resourceType === RESOURCE_TYPE_SCAFFOLDER_ACTION; } -/** - * - * @public - */ -export type TaskPermissionRuleInput< - TParams extends PermissionRuleParams = PermissionRuleParams, -> = PermissionRule< - TemplateEntityStepV1beta3 | TemplateParametersV1beta3, - {}, - typeof RESOURCE_TYPE_SCAFFOLDER_TASK, - TParams ->; -function isTaskPermissionRuleInput( - permissionRule: ScaffolderPermissionRuleInput, -): permissionRule is TaskPermissionRuleInput { - return permissionRule.resourceType === RESOURCE_TYPE_SCAFFOLDER_TASK; -} /** * RouterOptions * @@ -418,14 +404,12 @@ export async function createRouter( const actionRules: ActionPermissionRuleInput[] = Object.values( scaffolderActionRules, ); - const taskRules: TaskPermissionRuleInput[] = []; if (permissionRules) { templateRules.push( ...permissionRules.filter(isTemplatePermissionRuleInput), ); actionRules.push(...permissionRules.filter(isActionPermissionRuleInput)); - taskRules.push(...permissionRules.filter(isTaskPermissionRuleInput)); } const isAuthorized = createConditionAuthorizer(Object.values(templateRules)); @@ -445,7 +429,7 @@ export async function createRouter( { resourceType: 'basic', permissions: scaffolderTaskPermissions, - rules: taskRules, + rules: [], }, ], }); diff --git a/plugins/scaffolder-common/api-report-alpha.md b/plugins/scaffolder-common/api-report-alpha.md index 3762b0b773..a06f3123e7 100644 --- a/plugins/scaffolder-common/api-report-alpha.md +++ b/plugins/scaffolder-common/api-report-alpha.md @@ -3,6 +3,7 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts +import { BasicPermission } from '@backstage/plugin-permission-common'; import { ResourcePermission } from '@backstage/plugin-permission-common'; // @alpha @@ -14,9 +15,6 @@ export const actionReadPermission: ResourcePermission<'scaffolder-action'>; // @alpha export const RESOURCE_TYPE_SCAFFOLDER_ACTION = 'scaffolder-action'; -// @alpha -export const RESOURCE_TYPE_SCAFFOLDER_TASK = 'scaffolder-task'; - // @alpha export const RESOURCE_TYPE_SCAFFOLDER_TEMPLATE = 'scaffolder-template'; @@ -24,25 +22,22 @@ export const RESOURCE_TYPE_SCAFFOLDER_TEMPLATE = 'scaffolder-template'; export const scaffolderActionPermissions: ResourcePermission<'scaffolder-action'>[]; // @alpha -export const scaffolderPermissions: ( - | ResourcePermission<'scaffolder-action'> - | ResourcePermission<'scaffolder-template'> -)[]; +export const scaffolderPermissions: ResourcePermission<'scaffolder-template'>[]; // @alpha -export const scaffolderTaskPermissions: ResourcePermission<'scaffolder-task'>[]; +export const scaffolderTaskPermissions: BasicPermission[]; // @alpha export const scaffolderTemplatePermissions: ResourcePermission<'scaffolder-template'>[]; // @alpha -export const taskCancelPermission: ResourcePermission<'scaffolder-task'>; +export const taskCancelPermission: BasicPermission; // @alpha -export const taskCreatePermission: ResourcePermission<'scaffolder-task'>; +export const taskCreatePermission: BasicPermission; // @alpha -export const taskReadPermission: ResourcePermission<'scaffolder-task'>; +export const taskReadPermission: BasicPermission; // @alpha export const templateParameterReadPermission: ResourcePermission<'scaffolder-template'>;