@cedar-policy/cedar-wasm 4.5.0 → 4.6.1

package/esm/cedar_wasm.d.ts

@@ -1,129 +1,113 @@
 /* tslint:disable */
 /* eslint-disable */
+export function getCedarVersion(): string;
+export function getCedarSDKVersion(): string;
 /**
  * Get valid request environment
  */
-export function getValidRequestEnvsTemplate(t: Template, s: Schema): GetValidRequestEnvsResult;
+export function getValidRequestEnvsPolicy(t: Policy, s: Schema): GetValidRequestEnvsResult;
 /**
  * Get valid request environment
  */
-export function getValidRequestEnvsPolicy(t: Policy, s: Schema): GetValidRequestEnvsResult;
-export function getCedarVersion(): string;
-export function getCedarSDKVersion(): string;
+export function getValidRequestEnvsTemplate(t: Template, s: Schema): GetValidRequestEnvsResult;
 /**
- * Parse a policy set and optionally validate it against a provided schema
+ * Preparse and cache a policy set in thread-local storage
  *
- * This is the basic validator interface, using [`ValidationCall`] and
- * [`ValidationAnswer`] types
+ * # Errors
+ *
+ * Will return `Err` if the input cannot be parsed. Side-effect free on error.
  */
-export function validate(call: ValidationCall): ValidationAnswer;
+export function preparsePolicySet(pset_id: string, policies: PolicySet): CheckParseAnswer;
 /**
- * Check whether a policy set successfully parses.
+ * Basic interface, using [`AuthorizationCall`] and [`AuthorizationAnswer`] types
  */
-export function checkParsePolicySet(policies: PolicySet): CheckParseAnswer;
+export function isAuthorized(call: AuthorizationCall): AuthorizationAnswer;
 /**
- * Check whether a schema successfully parses.
+ * Stateful authorization using preparsed schemas and policy sets.
+ *
+ * This function works like [`is_authorized`] but retrieves schemas and policy sets
+ * from thread-local cache instead of parsing them on each call.
  */
-export function checkParseSchema(schema: Schema): CheckParseAnswer;
+export function statefulIsAuthorized(call: StatefulAuthorizationCall): AuthorizationAnswer;
 /**
- * Check whether a set of entities successfully parses.
+ * Preparse and cache a schema in thread-local storage
+ *
+ * # Errors
+ *
+ * Will return `Err` if the input cannot be parsed. Side-effect free on error.
  */
-export function checkParseEntities(call: EntitiesParsingCall): CheckParseAnswer;
+export function preparseSchema(schema_name: string, schema: Schema): CheckParseAnswer;
 /**
- * Check whether a context successfully parses.
+ * Check whether a set of entities successfully parses.
  */
-export function checkParseContext(call: ContextParsingCall): CheckParseAnswer;
+export function checkParseEntities(call: EntitiesParsingCall): CheckParseAnswer;
 /**
- * Apply the Cedar policy formatter to a policy set in the Cedar policy format
+ * Check whether a schema successfully parses.
  */
-export function formatPolicies(call: FormattingCall): FormattingAnswer;
+export function checkParseSchema(schema: Schema): CheckParseAnswer;
 /**
- * Basic interface, using [`AuthorizationCall`] and [`AuthorizationAnswer`] types
+ * Check whether a policy set successfully parses.
  */
-export function isAuthorized(call: AuthorizationCall): AuthorizationAnswer;
+export function checkParsePolicySet(policies: PolicySet): CheckParseAnswer;
 /**
- * Takes a PolicySet represented as string and return the policies
- * and templates split into vecs and sorted by id.
+ * Check whether a context successfully parses.
  */
-export function policySetTextToParts(policyset_str: string): PolicySetTextToPartsAnswer;
+export function checkParseContext(call: ContextParsingCall): CheckParseAnswer;
 /**
  * Return the Cedar (textual) representation of a policy.
  */
 export function policyToText(policy: Policy): PolicyToTextAnswer;
 /**
- * Return the Cedar (textual) representation of a template.
- */
-export function templateToText(template: Template): PolicyToTextAnswer;
-/**
- * Return the JSON representation of a policy.
+ * Return the Cedar (textual) representation of a schema.
  */
-export function policyToJson(policy: Policy): PolicyToJsonAnswer;
+export function schemaToText(schema: Schema): SchemaToTextAnswer;
 /**
  * Return the JSON representation of a template.
  */
 export function templateToJson(template: Template): PolicyToJsonAnswer;
 /**
- * Return the Cedar (textual) representation of a schema.
+ * Takes a `PolicySet` represented as string and return the policies
+ * and templates split into vecs and sorted by id.
  */
-export function schemaToText(schema: Schema): SchemaToTextAnswer;
+export function policySetTextToParts(policyset_str: string): PolicySetTextToPartsAnswer;
 /**
  * Return the JSON representation of a schema.
  */
 export function schemaToJson(schema: Schema): SchemaToJsonAnswer;
+/**
+ * Return the JSON representation of a policy.
+ */
+export function policyToJson(policy: Policy): PolicyToJsonAnswer;
+/**
+ * Return the Cedar (textual) representation of a template.
+ */
+export function templateToText(template: Template): PolicyToTextAnswer;
 /**
  * Get language version of Cedar
  */
 export function getCedarLangVersion(): string;
+/**
+ * Apply the Cedar policy formatter to a policy set in the Cedar policy format
+ */
+export function formatPolicies(call: FormattingCall): FormattingAnswer;
+/**
+ * Parse a policy set and optionally validate it against a provided schema
+ *
+ * This is the basic validator interface, using [`ValidationCall`] and
+ * [`ValidationAnswer`] types
+ */
+export function validate(call: ValidationCall): ValidationAnswer;
 export type GetValidRequestEnvsResult = { type: "success"; principals: string[]; actions: string[]; resources: string[] } | { type: "failure"; error: string };
 
-export interface ValidationCall {
-    validationSettings?: ValidationSettings;
-    schema: Schema;
-    policies: PolicySet;
-}
-
-export interface ValidationSettings {
-    mode: ValidationMode;
-}
-
-export interface ValidationError {
-    policyId: string;
-    error: DetailedError;
-}
-
-export type ValidationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; validationErrors: ValidationError[]; validationWarnings: ValidationError[]; otherWarnings: DetailedError[] };
-
-export type CheckParseAnswer = { type: "success" } | { type: "failure"; errors: DetailedError[] };
-
-export interface EntitiesParsingCall {
-    entities: Entities;
-    schema?: Schema | null;
-}
-
-export interface ContextParsingCall {
-    context: Context;
-    schema?: Schema | null;
-    action?: EntityUid | null;
-}
-
-export interface FormattingCall {
-    policyText: string;
-    lineWidth?: number;
-    indentWidth?: number;
-}
+export type SlotId = string;
 
-export type FormattingAnswer = { type: "failure"; errors: DetailedError[] } | { type: "success"; formatted_policy: string };
+export type PolicyId = string;
 
 export interface Response {
     decision: Decision;
     diagnostics: Diagnostics;
 }
 
-export interface Diagnostics {
-    reason: PolicyId[];
-    errors: AuthorizationError[];
-}
-
 export interface AuthorizationError {
     policyId: string;
     error: DetailedError;
@@ -131,6 +115,17 @@ export interface AuthorizationError {
 
 export type AuthorizationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; response: Response; warnings: DetailedError[] };
 
+export interface StatefulAuthorizationCall {
+    principal: EntityUid;
+    action: EntityUid;
+    resource: EntityUid;
+    context: Context;
+    preparsedSchemaName?: string;
+    validateRequest?: boolean;
+    preparsedPolicySetId: string;
+    entities: Entities;
+}
+
 export interface AuthorizationCall {
     principal: EntityUid;
     action: EntityUid;
@@ -142,53 +137,26 @@ export interface AuthorizationCall {
     entities: Entities;
 }
 
-export type PolicyToTextAnswer = { type: "success"; text: string } | { type: "failure"; errors: DetailedError[] };
-
-export type PolicySetTextToPartsAnswer = { type: "success"; policies: string[]; policy_templates: string[] } | { type: "failure"; errors: DetailedError[] };
-
-export type PolicyToJsonAnswer = { type: "success"; json: PolicyJson } | { type: "failure"; errors: DetailedError[] };
-
-export type SchemaToTextAnswer = { type: "success"; text: string; warnings: DetailedError[] } | { type: "failure"; errors: DetailedError[] };
-
-export type SchemaToJsonAnswer = { type: "success"; json: SchemaJson<string>; warnings: DetailedError[] } | { type: "failure"; errors: DetailedError[] };
-
-export type Schema = string | SchemaJson<string>;
-
-export interface PolicySet {
-    staticPolicies?: StaticPolicySet;
-    templates?: Record<PolicyId, Template>;
-    templateLinks?: TemplateLink[];
+export interface Diagnostics {
+    reason: PolicyId[];
+    errors: AuthorizationError[];
 }
 
+export type Severity = "advice" | "warning" | "error";
+
 export interface TemplateLink {
     templateId: PolicyId;
     newId: PolicyId;
     values: Record<SlotId, EntityUid>;
 }
 
-export type StaticPolicySet = string | Policy[] | Record<PolicyId, Policy>;
-
-export type Template = string | PolicyJson;
-
-export type Policy = string | PolicyJson;
-
-export type Entities = Array<EntityJson>;
-
-export type Context = Record<string, CedarValueJson>;
-
-export type EntityUid = EntityUidJson;
+export type Schema = string | SchemaJson<string>;
 
 export interface SourceLocation {
     start: number;
     end: number;
 }
 
-export interface SourceLabel extends SourceLocation {
-    label: string | null;
-}
-
-export type Severity = "advice" | "warning" | "error";
-
 export interface DetailedError {
     message: string;
     help: string | null;
@@ -199,30 +167,77 @@ export interface DetailedError {
     related?: DetailedError[];
 }
 
-export type SlotId = string;
+export interface PolicySet {
+    staticPolicies?: StaticPolicySet;
+    templates?: Record<PolicyId, Template>;
+    templateLinks?: TemplateLink[];
+}
 
-export type PolicyId = string;
+export type EntityUid = EntityUidJson;
+
+export type Policy = string | PolicyJson;
+
+export type StaticPolicySet = string | Policy[] | Record<PolicyId, Policy>;
+
+export type Context = Record<string, CedarValueJson>;
+
+export type Entities = Array<EntityJson>;
+
+export interface SourceLabel extends SourceLocation {
+    label: string | null;
+}
+
+export type Template = string | PolicyJson;
 
 export type ValidationMode = "strict";
 
-export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
+export interface EntitiesParsingCall {
+    entities: Entities;
+    schema?: Schema | null;
+}
 
-export interface PrincipalOrResourceIsConstraint {
-    entity_type: string;
-    in?: PrincipalOrResourceInConstraint;
+export interface ContextParsingCall {
+    context: Context;
+    schema?: Schema | null;
+    action?: EntityUid | null;
 }
 
-export type PrincipalOrResourceInConstraint = { entity: EntityUidJson } | { slot: string };
+export type CheckParseAnswer = { type: "success" } | { type: "failure"; errors: DetailedError[] };
 
-export type EqConstraint = { entity: EntityUidJson } | { slot: string };
+export type PolicyToJsonAnswer = { type: "success"; json: PolicyJson } | { type: "failure"; errors: DetailedError[] };
 
-export type ResourceConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+export type PolicyToTextAnswer = { type: "success"; text: string } | { type: "failure"; errors: DetailedError[] };
 
-export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+export type PolicySetTextToPartsAnswer = { type: "success"; policies: string[]; policy_templates: string[] } | { type: "failure"; errors: DetailedError[] };
 
-export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+export type SchemaToJsonAnswer = { type: "success"; json: SchemaJson<string>; warnings: DetailedError[] } | { type: "failure"; errors: DetailedError[] };
 
-export type Effect = "permit" | "forbid";
+export type SchemaToTextAnswer = { type: "success"; text: string; warnings: DetailedError[] } | { type: "failure"; errors: DetailedError[] };
+
+export type FormattingAnswer = { type: "failure"; errors: DetailedError[] } | { type: "success"; formatted_policy: string };
+
+export interface FormattingCall {
+    policyText: string;
+    lineWidth?: number;
+    indentWidth?: number;
+}
+
+export interface ValidationSettings {
+    mode: ValidationMode;
+}
+
+export interface ValidationError {
+    policyId: string;
+    error: DetailedError;
+}
+
+export interface ValidationCall {
+    validationSettings?: ValidationSettings;
+    schema: Schema;
+    policies: PolicySet;
+}
+
+export type ValidationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; validationErrors: ValidationError[]; validationWarnings: ValidationError[]; otherWarnings: DetailedError[] };
 
 export interface EntityJson {
     uid: EntityUidJson;
@@ -231,42 +246,68 @@ export interface EntityJson {
     tags?: Record<string, CedarValueJson>;
 }
 
-export type ExtFuncCall = {} & Record<string, Array<Expr>>;
+export type AnyId = SmolStr;
 
-export type ExprNoExt = { Value: CedarValueJson } | { Var: Var } | { Slot: string } | { "!": { arg: Expr } } | { neg: { arg: Expr } } | { "==": { left: Expr; right: Expr } } | { "!=": { left: Expr; right: Expr } } | { in: { left: Expr; right: Expr } } | { "<": { left: Expr; right: Expr } } | { "<=": { left: Expr; right: Expr } } | { ">": { left: Expr; right: Expr } } | { ">=": { left: Expr; right: Expr } } | { "&&": { left: Expr; right: Expr } } | { "||": { left: Expr; right: Expr } } | { "+": { left: Expr; right: Expr } } | { "-": { left: Expr; right: Expr } } | { "*": { left: Expr; right: Expr } } | { contains: { left: Expr; right: Expr } } | { containsAll: { left: Expr; right: Expr } } | { containsAny: { left: Expr; right: Expr } } | { isEmpty: { arg: Expr } } | { getTag: { left: Expr; right: Expr } } | { hasTag: { left: Expr; right: Expr } } | { ".": { left: Expr; attr: SmolStr } } | { has: { left: Expr; attr: SmolStr } } | { like: { left: Expr; pattern: PatternElem[] } } | { is: { left: Expr; entity_type: SmolStr; in?: Expr } } | { "if-then-else": { if: Expr; then: Expr; else: Expr } } | { Set: Expr[] } | { Record: Record<string, Expr> };
+export type UnreservedId = string;
 
-export type PatternElem = "Wildcard" | { Literal: SmolStr };
+export type Effect = "permit" | "forbid";
 
-export type Expr = ExprNoExt | ExtFuncCall;
+export type EqConstraint = { entity: EntityUidJson } | { slot: string };
 
-export type TypeVariant<N> = { type: "String" } | { type: "Long" } | { type: "Boolean" } | { type: "Set"; element: Type<N> } | ({ type: "Record" } & RecordType<N>) | { type: "Entity"; name: N } | { type: "EntityOrCommon"; name: N } | { type: "Extension"; name: UnreservedId };
+export type ResourceConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
 
-export interface RecordType<N> {
-    attributes: Record<SmolStr, TypeOfAttribute<N>>;
-    additionalAttributes?: boolean;
+export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+
+export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
+
+export interface PrincipalOrResourceIsConstraint {
+    entity_type: string;
+    in?: PrincipalOrResourceInConstraint;
 }
 
+export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+
+export type PrincipalOrResourceInConstraint = { entity: EntityUidJson } | { slot: string };
+
+export type AttributesOrContext<N> = Type<N>;
+
+export type TypeVariant<N> = { type: "String" } | { type: "Long" } | { type: "Boolean" } | { type: "Set"; element: Type<N> } | ({ type: "Record" } & RecordType<N>) | { type: "Entity"; name: N } | { type: "EntityOrCommon"; name: N } | { type: "Extension"; name: UnreservedId };
+
 export type Type<N> = ({} & TypeVariant<N>) | { type: N };
 
+export type EntityTypeKind<N> = StandardEntityType<N> | { enum: NonEmpty<SmolStr> };
+
 export interface ActionEntityUID<N> {
     id: SmolStr;
     type?: N;
 }
 
+export interface ActionType<N> {
+    attributes?: Record<SmolStr, CedarValueJson>;
+    appliesTo?: ApplySpec<N>;
+    memberOf?: ActionEntityUID<N>[];
+    annotations?: Annotations;
+}
+
 export interface ApplySpec<N> {
     resourceTypes: N[];
     principalTypes: N[];
     context?: AttributesOrContext<N>;
 }
 
-export interface ActionType<N> {
-    attributes?: Record<SmolStr, CedarValueJson>;
-    appliesTo?: ApplySpec<N>;
-    memberOf?: ActionEntityUID<N>[];
+export type SchemaJson<N> = Record<string, NamespaceDefinition<N>>;
+
+export interface NamespaceDefinition<N> {
+    commonTypes?: Record<CommonTypeId, CommonType<N>>;
+    entityTypes: Record<UnreservedId, EntityType<N>>;
+    actions: Record<SmolStr, ActionType<N>>;
     annotations?: Annotations;
 }
 
-export type AttributesOrContext<N> = Type<N>;
+export interface RecordType<N> {
+    attributes: Record<SmolStr, TypeOfAttribute<N>>;
+    additionalAttributes?: boolean;
+}
 
 export interface StandardEntityType<N> {
     memberOfTypes?: N[];
@@ -274,55 +315,45 @@ export interface StandardEntityType<N> {
     tags?: Type<N>;
 }
 
-export type EntityTypeKind<N> = StandardEntityType<N> | { enum: NonEmpty<SmolStr> };
+export type CommonTypeId = string;
 
-export interface NamespaceDefinition<N> {
-    commonTypes?: Record<CommonTypeId, CommonType<N>>;
-    entityTypes: Record<UnreservedId, EntityType<N>>;
-    actions: Record<SmolStr, ActionType<N>>;
+export type Decision = "allow" | "deny";
+
+export type Clause = { kind: "when"; body: Expr } | { kind: "unless"; body: Expr };
+
+export interface PolicyJson {
+    effect: Effect;
+    principal: PrincipalConstraint;
+    action: ActionConstraint;
+    resource: ResourceConstraint;
+    conditions: Clause[];
     annotations?: Annotations;
 }
 
-export type CommonTypeId = string;
-
-export type SchemaJson<N> = Record<string, NamespaceDefinition<N>>;
+export type ExtFuncCall = {} & Record<string, Array<Expr>>;
 
-export type AnyId = SmolStr;
+export type Expr = ExprNoExt | ExtFuncCall;
 
-export type UnreservedId = string;
+export type ExprNoExt = { Value: CedarValueJson } | { Var: Var } | { Slot: string } | { "!": { arg: Expr } } | { neg: { arg: Expr } } | { "==": { left: Expr; right: Expr } } | { "!=": { left: Expr; right: Expr } } | { in: { left: Expr; right: Expr } } | { "<": { left: Expr; right: Expr } } | { "<=": { left: Expr; right: Expr } } | { ">": { left: Expr; right: Expr } } | { ">=": { left: Expr; right: Expr } } | { "&&": { left: Expr; right: Expr } } | { "||": { left: Expr; right: Expr } } | { "+": { left: Expr; right: Expr } } | { "-": { left: Expr; right: Expr } } | { "*": { left: Expr; right: Expr } } | { contains: { left: Expr; right: Expr } } | { containsAll: { left: Expr; right: Expr } } | { containsAny: { left: Expr; right: Expr } } | { isEmpty: { arg: Expr } } | { getTag: { left: Expr; right: Expr } } | { hasTag: { left: Expr; right: Expr } } | { ".": { left: Expr; attr: SmolStr } } | { has: { left: Expr; attr: SmolStr } } | { like: { left: Expr; pattern: PatternElem[] } } | { is: { left: Expr; entity_type: SmolStr; in?: Expr } } | { "if-then-else": { if: Expr; then: Expr; else: Expr } } | { Set: Expr[] } | { Record: Record<string, Expr> };
 
-export type Annotations = Record<string, Annotation>;
+export type PatternElem = "Wildcard" | { Literal: SmolStr };
 
 export type Annotation = SmolStr;
 
-export type EntityUidJson = { __entity: TypeAndId } | TypeAndId;
+export type Annotations = Record<string, Annotation>;
 
-export interface FnAndArg {
-    fn: string;
-    arg: CedarValueJson;
-}
+export type Var = "principal" | "action" | "resource" | "context";
 
 export interface TypeAndId {
     type: string;
     id: string;
 }
 
-export type CedarValueJson = { __entity: TypeAndId } | { __extn: FnAndArg } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
-
-export type Var = "principal" | "action" | "resource" | "context";
-
-export type Clause = { kind: "when"; body: Expr } | { kind: "unless"; body: Expr };
+export type FnAndArgs = { fn: string; arg: CedarValueJson } | { fn: string; args: CedarValueJson[] };
 
-export interface PolicyJson {
-    effect: Effect;
-    principal: PrincipalConstraint;
-    action: ActionConstraint;
-    resource: ResourceConstraint;
-    conditions: Clause[];
-    annotations?: Annotations;
-}
+export type EntityUidJson = { __entity: TypeAndId } | TypeAndId;
 
-export type Decision = "allow" | "deny";
+export type CedarValueJson = { __entity: TypeAndId } | { __extn: FnAndArgs } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
 
 type SmolStr = string;
 export type TypeOfAttribute<N> = Type<N> & { required?: boolean };