From d7ef962073699be1182c20ff270cf4f9b3d1e38d Mon Sep 17 00:00:00 2001 From: Vincenzo Scamporlino Date: Fri, 17 Feb 2023 10:51:02 +0100 Subject: [PATCH] api reports Signed-off-by: Vincenzo Scamporlino --- packages/errors/api-report.md | 3 ++ plugins/permission-node/api-report.md | 43 +++++++++++++++++---------- 2 files changed, 31 insertions(+), 15 deletions(-) diff --git a/packages/errors/api-report.md b/packages/errors/api-report.md index 1a65ae2315..650a826a30 100644 --- a/packages/errors/api-report.md +++ b/packages/errors/api-report.md @@ -84,6 +84,9 @@ export class NotAllowedError extends CustomErrorBase {} // @public export class NotFoundError extends CustomErrorBase {} +// @public +export class NotImplementedError extends CustomErrorBase {} + // @public export class NotModifiedError extends CustomErrorBase {} diff --git a/plugins/permission-node/api-report.md b/plugins/permission-node/api-report.md index b8d337819c..9fda5cfd96 100644 --- a/plugins/permission-node/api-report.md +++ b/plugins/permission-node/api-report.md @@ -111,26 +111,34 @@ export const createConditionTransformer: < permissionRules: [...TRules], ) => ConditionTransformer; -// @public -export const createIsAuthorized: ( - rules: PermissionRule[], -) => (decision: PolicyDecision, resource: TResource | undefined) => boolean; - // @public export const createPermissionIntegrationRouter: < TResourceType extends string, TResource, ->(options: { +>( + options: CreatePermissionIntegrationRouterOptions, +) => express.Router; + +// @public +export type CreatePermissionIntegrationRouterOptions< + TResourceType extends string, + TResource, +> = + | { + permissions: Array; + } + | CreatePermissionIntegrationRouterResourceOptions; + +// @public +export type CreatePermissionIntegrationRouterResourceOptions< + TResourceType extends string, + TResource, +> = { resourceType: TResourceType; - permissions?: Permission[] | undefined; - rules: PermissionRule< - TResource, - any, - NoInfer, - PermissionRuleParams - >[]; - getResources: (resourceRefs: string[]) => Promise<(TResource | undefined)[]>; -}) => express.Router; + permissions?: Array; + rules: PermissionRule>[]; + getResources?: GetResourcesFn; +}; // @public export const createPermissionRule: < @@ -142,6 +150,11 @@ export const createPermissionRule: < rule: PermissionRule, ) => PermissionRule; +// @public +export type GetResourcesFn = ( + resourceRefs: string[], +) => Promise>; + // @alpha export const isAndCriteria: ( criteria: PermissionCriteria,