Update api-reports

Signed-off-by: Joe Porpeglia <josephp@spotify.com>
This commit is contained in:
Joe Porpeglia
2022-03-22 13:53:15 -04:00
committed by Joe Porpeglia
parent 0b98a49509
commit 979d4b976f
5 changed files with 83 additions and 68 deletions
+16 -28
View File
@@ -5,19 +5,22 @@
```ts
import { AllOfCriteria } from '@backstage/plugin-permission-common';
import { AnyOfCriteria } from '@backstage/plugin-permission-common';
import { AuthorizeDecision } from '@backstage/plugin-permission-common';
import { AuthorizeQuery } from '@backstage/plugin-permission-common';
import { AuthorizeRequestOptions } from '@backstage/plugin-permission-common';
import { AuthorizeResult } from '@backstage/plugin-permission-common';
import { BackstageIdentityResponse } from '@backstage/plugin-auth-node';
import { ConditionalPolicyDecision } from '@backstage/plugin-permission-common';
import { Config } from '@backstage/config';
import { DefinitivePolicyDecision } from '@backstage/plugin-permission-common';
import { EvaluatePermissionRequest } from '@backstage/plugin-permission-common';
import { EvaluatePermissionResponse } from '@backstage/plugin-permission-common';
import express from 'express';
import { Identified } from '@backstage/plugin-permission-common';
import { IdentifiedPermissionMessage } from '@backstage/plugin-permission-common';
import { NotCriteria } from '@backstage/plugin-permission-common';
import { Permission } from '@backstage/plugin-permission-common';
import { PermissionAuthorizer } from '@backstage/plugin-permission-common';
import { PermissionCondition } from '@backstage/plugin-permission-common';
import { PermissionCriteria } from '@backstage/plugin-permission-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { PolicyDecision } from '@backstage/plugin-permission-common';
import { TokenManager } from '@backstage/backend-common';
// @public
@@ -26,7 +29,7 @@ export type ApplyConditionsRequest = {
};
// @public
export type ApplyConditionsRequestEntry = Identified<{
export type ApplyConditionsRequestEntry = IdentifiedPermissionMessage<{
resourceRef: string;
resourceType: string;
conditions: PermissionCriteria<PermissionCondition>;
@@ -38,7 +41,8 @@ export type ApplyConditionsResponse = {
};
// @public
export type ApplyConditionsResponseEntry = Identified<DefinitivePolicyDecision>;
export type ApplyConditionsResponseEntry =
IdentifiedPermissionMessage<DefinitivePolicyDecision>;
// @public
export type Condition<TRule> = TRule extends PermissionRule<
@@ -49,14 +53,6 @@ export type Condition<TRule> = TRule extends PermissionRule<
? (...params: TParams) => PermissionCondition<TParams>
: never;
// @public
export type ConditionalPolicyDecision = {
result: AuthorizeResult.CONDITIONAL;
pluginId: string;
resourceType: string;
conditions: PermissionCriteria<PermissionCondition>;
};
// @public
export type Conditions<
TRules extends Record<string, PermissionRule<any, any>>,
@@ -116,11 +112,6 @@ export const createPermissionRule: <
rule: PermissionRule<TResource, TQuery, TParams>,
) => PermissionRule<TResource, TQuery, TParams>;
// @public
export type DefinitivePolicyDecision = {
result: AuthorizeResult.ALLOW | AuthorizeResult.DENY;
};
// @alpha
export const isAndCriteria: <T>(
criteria: PermissionCriteria<T>,
@@ -147,7 +138,7 @@ export const makeCreatePermissionRule: <TResource, TQuery>() => <
export interface PermissionPolicy {
// (undocumented)
handle(
request: PolicyAuthorizeQuery,
request: PolicyQuery,
user?: BackstageIdentityResponse,
): Promise<PolicyDecision>;
}
@@ -165,20 +156,17 @@ export type PermissionRule<
};
// @public
export type PolicyAuthorizeQuery = Omit<AuthorizeQuery, 'resourceRef'>;
// @public
export type PolicyDecision =
| DefinitivePolicyDecision
| ConditionalPolicyDecision;
export type PolicyQuery = {
permission: Permission;
};
// @public
export class ServerPermissionClient implements PermissionAuthorizer {
// (undocumented)
authorize(
queries: AuthorizeQuery[],
requests: EvaluatePermissionRequest[],
options?: AuthorizeRequestOptions,
): Promise<AuthorizeDecision[]>;
): Promise<EvaluatePermissionResponse[]>;
// (undocumented)
static fromConfig(
config: Config,