paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 31 Packages Projects Releases Wiki Activity

permission-node: updated createPermissionRule to improve type inference

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2025-01-30 09:55:10 +01:00
parent b4183adc9d
commit ec07d0a579
2 changed files with 30 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/permission-node/report.api.md
+11 -3
View File
@@ -203,10 +203,17 @@ export function createPermissionResourceRef<TResource, TQuery>(): {
export function createPermissionRule<
TResource,
TQuery,
TQueryOutput extends TQuery,
TResourceType extends string,
TParams extends PermissionRuleParams = undefined,
>(
rule: CreatePermissionRuleOptions<TResource, TQuery, TResourceType, TParams>,
rule: CreatePermissionRuleOptions<
TResource,
TQuery,
TQueryOutput,
TResourceType,
TParams
>,
): PermissionRule<TResource, TQuery, TResourceType, TParams>;
// @public @deprecated
@@ -223,15 +230,16 @@ export function createPermissionRule<
export type CreatePermissionRuleOptions<
TResource,
TQuery,
TQueryOutput extends TQuery,
TResourceType extends string,
TParams extends PermissionRuleParams = PermissionRuleParams,
TParams extends PermissionRuleParams,
> = {
name: string;
description: string;
resourceRef: PermissionResourceRef<TResource, TQuery, TResourceType>;
paramsSchema?: z.ZodSchema<TParams>;
apply(resource: TResource, params: NoInfer_2<TParams>): boolean;
toQuery(params: NoInfer_2<TParams>): PermissionCriteria<TQuery>;
toQuery(params: NoInfer_2<TParams>): PermissionCriteria<TQueryOutput>;
};
// @public
plugins/permission-node/src/integration/createPermissionRule.ts
+19 -4
View File
@@ -29,8 +29,9 @@ import { NoInfer } from './util';
export type CreatePermissionRuleOptions<
TResource,
TQuery,
TQueryOutput extends TQuery,
TResourceType extends string,
TParams extends PermissionRuleParams = PermissionRuleParams,
TParams extends PermissionRuleParams,
> = {
name: string;
description: string;
@@ -54,7 +55,7 @@ export type CreatePermissionRuleOptions<
* can be used for loading a collection of resources efficiently with conditional criteria already
* applied.
*/
toQuery(params: NoInfer<TParams>): PermissionCriteria<TQuery>;
toQuery(params: NoInfer<TParams>): PermissionCriteria<TQueryOutput>;
};
/**
@@ -65,10 +66,17 @@ export type CreatePermissionRuleOptions<
export function createPermissionRule<
TResource,
TQuery,
TQueryOutput extends TQuery,
TResourceType extends string,
TParams extends PermissionRuleParams = undefined,
>(
rule: CreatePermissionRuleOptions<TResource, TQuery, TResourceType, TParams>,
rule: CreatePermissionRuleOptions<
TResource,
TQuery,
TQueryOutput,
TResourceType,
TParams
>,
): PermissionRule<TResource, TQuery, TResourceType, TParams>;
/**
* Helper function to ensure that {@link PermissionRule} definitions are typed correctly.
@@ -87,12 +95,19 @@ export function createPermissionRule<
export function createPermissionRule<
TResource,
TQuery,
TQueryOutput extends TQuery,
TResourceType extends string,
TParams extends PermissionRuleParams = undefined,
>(
rule:
| PermissionRule<TResource, TQuery, TResourceType, TParams>
| CreatePermissionRuleOptions<TResource, TQuery, TResourceType, TParams>,
| CreatePermissionRuleOptions<
TResource,
TQuery,
TQueryOutput,
TResourceType,
TParams
>,
): PermissionRule<TResource, TQuery, TResourceType, TParams> {
if ('resourceRef' in rule) {
return { ...rule, resourceType: rule.resourceRef.resourceType };