Remove enum, package fixes

Signed-off-by: Tim Hansen <timbonicus@gmail.com>
This commit is contained in:
Tim Hansen
2021-11-10 13:38:04 -07:00
committed by Mike Lewis
parent e6805978d8
commit c00b4d3829
6 changed files with 12 additions and 37 deletions
+3 -15
View File
@@ -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<TParams extends any[] = any> = {
export type PermissionCondition<TParams extends unknown> = {
rule: string;
params: TParams;
};
@@ -98,5 +86,5 @@ export type PermissionCriteria =
| {
not: PermissionCriteria;
}
| PermissionCondition<any>;
| PermissionCondition<unknown>;
```
+1 -2
View File
@@ -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",
@@ -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';
}
+2 -2
View File
@@ -54,7 +54,7 @@ export type AuthorizeRequest = {
* claims from a identity token.
* @public
*/
export type PermissionCondition<TParams extends any[] = any> = {
export type PermissionCondition<TParams extends unknown> = {
rule: string;
params: TParams;
};
@@ -67,7 +67,7 @@ export type PermissionCriteria =
| { allOf: PermissionCriteria[] }
| { anyOf: PermissionCriteria[] }
| { not: PermissionCriteria }
| PermissionCondition<any>;
| PermissionCondition<unknown>;
/**
* An authorization response from {@link PermissionClient#authorize}.
@@ -22,5 +22,4 @@ export type {
PermissionCriteria,
} from './api';
export type { DiscoveryApi } from './discovery';
export { PermissionAction } from './permission';
export type { PermissionAttributes, Permission } from './permission';
@@ -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';
};
/**