From c00b4d38290ab91e317ac5999a45c74f8ba50272 Mon Sep 17 00:00:00 2001 From: Tim Hansen Date: Wed, 10 Nov 2021 13:38:04 -0700 Subject: [PATCH] Remove enum, package fixes Signed-off-by: Tim Hansen --- packages/permission-common/api-report.md | 18 +++--------------- packages/permission-common/package.json | 3 +-- .../permission-common/src/permissions/util.ts | 10 +++++----- packages/permission-common/src/types/api.ts | 4 ++-- packages/permission-common/src/types/index.ts | 1 - .../permission-common/src/types/permission.ts | 13 +------------ 6 files changed, 12 insertions(+), 37 deletions(-) diff --git a/packages/permission-common/api-report.md b/packages/permission-common/api-report.md index 159d61d4c8..9d7bc90e9e 100644 --- a/packages/permission-common/api-report.md +++ b/packages/permission-common/api-report.md @@ -55,21 +55,9 @@ export type Permission = { resourceType?: string; }; -// @public -export enum PermissionAction { - // (undocumented) - Create = 'create', - // (undocumented) - Delete = 'delete', - // (undocumented) - Read = 'read', - // (undocumented) - Update = 'update', -} - // @public export type PermissionAttributes = { - action?: PermissionAction; + action?: 'create' | 'read' | 'update' | 'delete'; }; // @public @@ -82,7 +70,7 @@ export class PermissionClient { } // @public -export type PermissionCondition = { +export type PermissionCondition = { rule: string; params: TParams; }; @@ -98,5 +86,5 @@ export type PermissionCriteria = | { not: PermissionCriteria; } - | PermissionCondition; + | PermissionCondition; ``` diff --git a/packages/permission-common/package.json b/packages/permission-common/package.json index 7fb89519c2..376f969b19 100644 --- a/packages/permission-common/package.json +++ b/packages/permission-common/package.json @@ -4,7 +4,6 @@ "version": "0.1.0", "main": "src/index.ts", "types": "src/index.ts", - "private": true, "publishConfig": { "access": "public", "main": "dist/index.cjs.js", @@ -25,7 +24,7 @@ "dist" ], "scripts": { - "build": "backstage-cli build --outputs cjs,types", + "build": "backstage-cli build", "lint": "backstage-cli lint", "test": "backstage-cli test", "prepack": "backstage-cli prepack", diff --git a/packages/permission-common/src/permissions/util.ts b/packages/permission-common/src/permissions/util.ts index 06253755d5..188609f4ae 100644 --- a/packages/permission-common/src/permissions/util.ts +++ b/packages/permission-common/src/permissions/util.ts @@ -14,14 +14,14 @@ * limitations under the License. */ -import { Permission, PermissionAction } from '../types'; +import { Permission } from '../types'; /** * Check if a given permission is related to a create action. * @public */ export function isCreatePermission(permission: Permission) { - return permission.attributes.action === PermissionAction.Create; + return permission.attributes.action === 'create'; } /** @@ -29,7 +29,7 @@ export function isCreatePermission(permission: Permission) { * @public */ export function isReadPermission(permission: Permission) { - return permission.attributes.action === PermissionAction.Read; + return permission.attributes.action === 'read'; } /** @@ -37,7 +37,7 @@ export function isReadPermission(permission: Permission) { * @public */ export function isUpdatePermission(permission: Permission) { - return permission.attributes.action === PermissionAction.Update; + return permission.attributes.action === 'update'; } /** @@ -45,5 +45,5 @@ export function isUpdatePermission(permission: Permission) { * @public */ export function isDeletePermission(permission: Permission) { - return permission.attributes.action === PermissionAction.Delete; + return permission.attributes.action === 'delete'; } diff --git a/packages/permission-common/src/types/api.ts b/packages/permission-common/src/types/api.ts index 9927f798d2..ffe8406f83 100644 --- a/packages/permission-common/src/types/api.ts +++ b/packages/permission-common/src/types/api.ts @@ -54,7 +54,7 @@ export type AuthorizeRequest = { * claims from a identity token. * @public */ -export type PermissionCondition = { +export type PermissionCondition = { rule: string; params: TParams; }; @@ -67,7 +67,7 @@ export type PermissionCriteria = | { allOf: PermissionCriteria[] } | { anyOf: PermissionCriteria[] } | { not: PermissionCriteria } - | PermissionCondition; + | PermissionCondition; /** * An authorization response from {@link PermissionClient#authorize}. diff --git a/packages/permission-common/src/types/index.ts b/packages/permission-common/src/types/index.ts index ef43666fa7..7faecc38e7 100644 --- a/packages/permission-common/src/types/index.ts +++ b/packages/permission-common/src/types/index.ts @@ -22,5 +22,4 @@ export type { PermissionCriteria, } from './api'; export type { DiscoveryApi } from './discovery'; -export { PermissionAction } from './permission'; export type { PermissionAttributes, Permission } from './permission'; diff --git a/packages/permission-common/src/types/permission.ts b/packages/permission-common/src/types/permission.ts index 6929bcd547..181b36065f 100644 --- a/packages/permission-common/src/types/permission.ts +++ b/packages/permission-common/src/types/permission.ts @@ -14,24 +14,13 @@ * limitations under the License. */ -/** - * The basic operation being performed in relation to this permission, expressed as a CRUD action. - * @public - */ -export enum PermissionAction { - Create = 'create', - Read = 'read', - Update = 'update', - Delete = 'delete', -} - /** * The attributes related to a given permission; these should be generic and widely applicable to * all permissions in the system. * @public */ export type PermissionAttributes = { - action?: PermissionAction; + action?: 'create' | 'read' | 'update' | 'delete'; }; /**