permission: api-reports

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>

plugins/permission-common/report.api.md

@@ -83,7 +83,7 @@ export type EvaluatePermissionRequest = {
   resourceRef?: string;
 };
 
-// @public
+// @public @deprecated
 export type EvaluatePermissionRequestBatch =
   PermissionMessageBatch<EvaluatePermissionRequest>;
 

plugins/permission-common/src/PermissionClient.ts

@@ -35,7 +35,6 @@ import { DiscoveryApi } from './types/discovery';
 import {
   AuthorizeRequestOptions,
   BasicPermission,
-  Permission,
   ResourcePermission,
 } from './types/permission';
 import { isResourcePermission } from './permissions';
@@ -270,6 +269,9 @@ export class PermissionClient implements PermissionEvaluator {
   }
 }
 
+/**
+ * @internal
+ */
 export type BatchedAuthorizePermissionRequest = IdentifiedPermissionMessage<
   | {
       permission: BasicPermission;

plugins/permission-common/src/index.ts

@@ -21,4 +21,7 @@
  */
 export * from './types';
 export * from './permissions';
-export * from './PermissionClient';
+export {
+  PermissionClient,
+  type PermissionClientRequestOptions,
+} from './PermissionClient';

plugins/permission-node/report.api.md

@@ -7,6 +7,7 @@ import { AllOfCriteria } from '@backstage/plugin-permission-common';
 import { AnyOfCriteria } from '@backstage/plugin-permission-common';
 import { AuthorizePermissionRequest } from '@backstage/plugin-permission-common';
 import { AuthorizePermissionResponse } from '@backstage/plugin-permission-common';
+import { AuthorizeResult } from '@backstage/plugin-permission-common';
 import { AuthService } from '@backstage/backend-plugin-api';
 import { BackstageCredentials } from '@backstage/backend-plugin-api';
 import { BackstageUserIdentity } from '@backstage/plugin-auth-node';
@@ -37,11 +38,20 @@ export type ApplyConditionsRequest = {
 };
 
 // @public
-export type ApplyConditionsRequestEntry = IdentifiedPermissionMessage<{
-  resourceRef: string;
-  resourceType: string;
-  conditions: PermissionCriteria<PermissionCondition>;
-}>;
+export type ApplyConditionsRequestEntry = IdentifiedPermissionMessage<
+  | {
+      resourceRef: string;
+      resourceRefs?: undefined;
+      resourceType: string;
+      conditions: PermissionCriteria<PermissionCondition>;
+    }
+  | {
+      resourceRef?: undefined;
+      resourceRefs: string[];
+      resourceType: string;
+      conditions: PermissionCriteria<PermissionCondition>;
+    }
+>;
 
 // @public
 export type ApplyConditionsResponse = {
@@ -49,8 +59,12 @@ export type ApplyConditionsResponse = {
 };
 
 // @public
-export type ApplyConditionsResponseEntry =
-  IdentifiedPermissionMessage<DefinitivePolicyDecision>;
+export type ApplyConditionsResponseEntry = IdentifiedPermissionMessage<
+  | DefinitivePolicyDecision
+  | {
+      result: Array<AuthorizeResult.ALLOW | AuthorizeResult.DENY>;
+    }
+>;
 
 // @public
 export type Condition<TRule> = TRule extends PermissionRule<