@cedar-policy/cedar-wasm 4.8.2 → 4.9.1

package/esm/cedar_wasm.d.ts

@@ -1,16 +1,22 @@
 /* tslint:disable */
 /* eslint-disable */
-export type GetValidRequestEnvsResult = { type: "success"; principals: string[]; actions: string[]; resources: string[] } | { type: "failure"; error: string };
-
-export type FormattingAnswer = { type: "failure"; errors: DetailedError[] } | { type: "success"; formatted_policy: string };
+export interface ActionEntityUID<N> {
+    id: SmolStr;
+    type?: N;
+}
 
-export interface FormattingCall {
-    policyText: string;
-    lineWidth?: number;
-    indentWidth?: number;
+export interface ActionType<N> {
+    attributes?: Record<SmolStr, CedarValueJson>;
+    appliesTo?: ApplySpec<N>;
+    memberOf?: ActionEntityUID<N>[];
+    annotations?: Annotations;
 }
 
-export type ValidationMode = "strict";
+export interface ApplySpec<N> {
+    resourceTypes: N[];
+    principalTypes: N[];
+    context?: AttributesOrContext<N>;
+}
 
 export interface AuthorizationCall {
     principal: EntityUid;
@@ -23,32 +29,15 @@ export interface AuthorizationCall {
     entities: Entities;
 }
 
-export type AuthorizationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; response: Response; warnings: DetailedError[] };
-
 export interface AuthorizationError {
     policyId: string;
     error: DetailedError;
 }
 
-export interface StatefulAuthorizationCall {
-    principal: EntityUid;
-    action: EntityUid;
-    resource: EntityUid;
+export interface ContextParsingCall {
     context: Context;
-    preparsedSchemaName?: string;
-    validateRequest?: boolean;
-    preparsedPolicySetId: string;
-    entities: Entities;
-}
-
-export interface Diagnostics {
-    reason: PolicyId[];
-    errors: AuthorizationError[];
-}
-
-export interface Response {
-    decision: Decision;
-    diagnostics: Diagnostics;
+    schema?: Schema | null;
+    action?: EntityUid | null;
 }
 
 export interface DetailedError {
@@ -61,9 +50,55 @@ export interface DetailedError {
     related?: DetailedError[];
 }
 
-export type StaticPolicySet = string | Policy[] | Record<PolicyId, Policy>;
+export interface Diagnostics {
+    reason: PolicyId[];
+    errors: AuthorizationError[];
+}
 
-export type Entities = Array<EntityJson>;
+export interface EntitiesParsingCall {
+    entities: Entities;
+    schema?: Schema | null;
+}
+
+export interface EntityJson {
+    uid: EntityUidJson;
+    attrs: Record<string, CedarValueJson>;
+    parents: EntityUidJson[];
+    tags?: Record<string, CedarValueJson>;
+}
+
+export interface FormattingCall {
+    policyText: string;
+    lineWidth?: number;
+    indentWidth?: number;
+}
+
+export interface NamespaceDefinition<N> {
+    commonTypes?: Record<CommonTypeId, CommonType<N>>;
+    entityTypes: Record<UnreservedId, EntityType<N>>;
+    actions: Record<SmolStr, ActionType<N>>;
+    annotations?: Annotations;
+}
+
+export interface PartialAuthorizationCall {
+    principal: EntityUid | null;
+    action: EntityUid | null;
+    resource: EntityUid | null;
+    context: Context;
+    schema?: Schema;
+    validateRequest?: boolean;
+    policies: PolicySet;
+    entities: Entities;
+}
+
+export interface PolicyJson {
+    effect: Effect;
+    principal: PrincipalConstraint;
+    action: ActionConstraint;
+    resource: ResourceConstraint;
+    conditions: Clause[];
+    annotations?: Annotations;
+}
 
 export interface PolicySet {
     staticPolicies?: StaticPolicySet;
@@ -71,42 +106,66 @@ export interface PolicySet {
     templateLinks?: TemplateLink[];
 }
 
-export interface SourceLocation {
-    start: number;
-    end: number;
+export interface PrincipalOrResourceIsConstraint {
+    entity_type: string;
+    in?: PrincipalOrResourceInConstraint;
 }
 
-export interface TemplateLink {
-    templateId: PolicyId;
-    newId: PolicyId;
-    values: Record<SlotId, EntityUid>;
+export interface RecordType<N> {
+    attributes: Record<SmolStr, TypeOfAttribute<N>>;
+    additionalAttributes?: boolean;
 }
 
-export type Severity = "advice" | "warning" | "error";
-
-export type Schema = string | SchemaJson<string>;
-
-export type Context = Record<string, CedarValueJson>;
+export interface ResidualResponse {
+    decision: Decision | null;
+    satisfied: PolicyId[];
+    errored: PolicyId[];
+    mayBeDetermining: PolicyId[];
+    mustBeDetermining: PolicyId[];
+    residuals: Record<string, PolicyJson>;
+    nontrivialResiduals: PolicyId[];
+}
 
-export type Policy = string | PolicyJson;
+export interface Response {
+    decision: Decision;
+    diagnostics: Diagnostics;
+}
 
 export interface SourceLabel extends SourceLocation {
     label: string | null;
 }
 
-export type EntityUid = EntityUidJson;
+export interface SourceLocation {
+    start: number;
+    end: number;
+}
 
-export type Template = string | PolicyJson;
+export interface StandardEntityType<N> {
+    memberOfTypes?: N[];
+    shape?: AttributesOrContext<N>;
+    tags?: Type<N>;
+}
 
-export type ValidationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; validationErrors: ValidationError[]; validationWarnings: ValidationError[]; otherWarnings: DetailedError[] };
+export interface StatefulAuthorizationCall {
+    principal: EntityUid;
+    action: EntityUid;
+    resource: EntityUid;
+    context: Context;
+    preparsedSchemaName?: string;
+    validateRequest?: boolean;
+    preparsedPolicySetId: string;
+    entities: Entities;
+}
 
-export interface ValidationError {
-    policyId: string;
-    error: DetailedError;
+export interface TemplateLink {
+    templateId: PolicyId;
+    newId: PolicyId;
+    values: Record<SlotId, EntityUid>;
 }
 
-export interface ValidationSettings {
-    mode: ValidationMode;
+export interface TypeAndId {
+    type: string;
+    id: string;
 }
 
 export interface ValidationCall {
@@ -115,148 +174,114 @@ export interface ValidationCall {
     policies: PolicySet;
 }
 
-export interface ContextParsingCall {
-    context: Context;
-    schema?: Schema | null;
-    action?: EntityUid | null;
+export interface ValidationError {
+    policyId: string;
+    error: DetailedError;
 }
 
-export interface EntitiesParsingCall {
-    entities: Entities;
-    schema?: Schema | null;
+export interface ValidationSettings {
+    mode: ValidationMode;
 }
 
-export type CheckParseAnswer = { type: "success" } | { type: "failure"; errors: DetailedError[] };
+export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
 
-export type PolicyId = string;
+export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
 
-export type SlotId = string;
+export type Annotation = SmolStr;
 
-export type SchemaToJsonAnswer = { type: "success"; json: SchemaJson<string>; warnings: DetailedError[] } | { type: "failure"; errors: DetailedError[] };
+export type Annotations = Record<string, Annotation>;
 
-export type PolicyToJsonAnswer = { type: "success"; json: PolicyJson } | { type: "failure"; errors: DetailedError[] };
+export type AnyId = SmolStr;
 
-export type PolicySetTextToPartsAnswer = { type: "success"; policies: string[]; policy_templates: string[] } | { type: "failure"; errors: DetailedError[] };
+export type AttributesOrContext<N> = Type<N>;
 
-export type PolicyToTextAnswer = { type: "success"; text: string } | { type: "failure"; errors: DetailedError[] };
+export type AuthorizationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; response: Response; warnings: DetailedError[] };
 
-export type SchemaToTextAnswer = { type: "success"; text: string; warnings: DetailedError[] } | { type: "failure"; errors: DetailedError[] };
+export type CedarValueJson = { __entity: TypeAndId } | { __extn: FnAndArgs } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
 
-export type Annotation = SmolStr;
+export type CheckParseAnswer = { type: "success" } | { type: "failure"; errors: DetailedError[] };
 
-export type Annotations = Record<string, Annotation>;
+export type Clause = { kind: "when"; body: Expr } | { kind: "unless"; body: Expr };
 
-export interface EntityJson {
-    uid: EntityUidJson;
-    attrs: Record<string, CedarValueJson>;
-    parents: EntityUidJson[];
-    tags?: Record<string, CedarValueJson>;
-}
+export type CommonTypeId = string;
 
-export type Var = "principal" | "action" | "resource" | "context";
+export type Context = Record<string, CedarValueJson>;
 
 export type Decision = "allow" | "deny";
 
-export type AnyId = SmolStr;
+export type Effect = "permit" | "forbid";
 
-export type UnreservedId = string;
+export type Entities = Array<EntityJson>;
 
-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 EntityTypeKind<N> = StandardEntityType<N> | { enum: NonEmpty<SmolStr> };
 
-export type Type<N> = ({} & TypeVariant<N>) | { type: N };
+export type EntityUid = EntityUidJson;
 
-export interface RecordType<N> {
-    attributes: Record<SmolStr, TypeOfAttribute<N>>;
-    additionalAttributes?: boolean;
-}
+export type EntityUidJson = { __entity: TypeAndId } | TypeAndId;
 
-export type CommonTypeId = string;
+export type EqConstraint = { entity: EntityUidJson } | { slot: string };
 
-export type AttributesOrContext<N> = Type<N>;
+export type Expr = ExprNoExt | ExtFuncCall;
 
-export interface ActionEntityUID<N> {
-    id: SmolStr;
-    type?: N;
-}
+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 interface ActionType<N> {
-    attributes?: Record<SmolStr, CedarValueJson>;
-    appliesTo?: ApplySpec<N>;
-    memberOf?: ActionEntityUID<N>[];
-    annotations?: Annotations;
-}
+export type ExtFuncCall = {} & Record<string, Array<Expr>>;
 
-export type SchemaJson<N> = Record<string, NamespaceDefinition<N>>;
+export type FnAndArgs = { fn: string; arg: CedarValueJson } | { fn: string; args: CedarValueJson[] };
 
-export type EntityTypeKind<N> = StandardEntityType<N> | { enum: NonEmpty<SmolStr> };
+export type FormattingAnswer = { type: "failure"; errors: DetailedError[] } | { type: "success"; formatted_policy: string };
 
-export interface NamespaceDefinition<N> {
-    commonTypes?: Record<CommonTypeId, CommonType<N>>;
-    entityTypes: Record<UnreservedId, EntityType<N>>;
-    actions: Record<SmolStr, ActionType<N>>;
-    annotations?: Annotations;
-}
+export type GetValidRequestEnvsResult = { type: "success"; principals: string[]; actions: string[]; resources: string[] } | { type: "failure"; error: string };
 
-export interface StandardEntityType<N> {
-    memberOfTypes?: N[];
-    shape?: AttributesOrContext<N>;
-    tags?: Type<N>;
-}
+export type PartialAuthorizationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "residuals"; response: ResidualResponse; warnings: DetailedError[] };
 
-export interface ApplySpec<N> {
-    resourceTypes: N[];
-    principalTypes: N[];
-    context?: AttributesOrContext<N>;
-}
+export type PatternElem = "Wildcard" | { Literal: SmolStr };
 
-export type Effect = "permit" | "forbid";
+export type Policy = string | PolicyJson;
 
-export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+export type PolicyId = string;
 
-export interface PrincipalOrResourceIsConstraint {
-    entity_type: string;
-    in?: PrincipalOrResourceInConstraint;
-}
+export type PolicySetTextToPartsAnswer = { type: "success"; policies: string[]; policy_templates: string[] } | { type: "failure"; errors: DetailedError[] };
 
-export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+export type PolicyToJsonAnswer = { type: "success"; json: PolicyJson } | { type: "failure"; errors: DetailedError[] };
 
-export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
+export type PolicyToTextAnswer = { type: "success"; text: string } | { type: "failure"; errors: DetailedError[] };
+
+export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
 
 export type PrincipalOrResourceInConstraint = { entity: EntityUidJson } | { slot: string };
 
 export type ResourceConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
 
-export type EqConstraint = { entity: EntityUidJson } | { slot: string };
+export type Schema = string | SchemaJson<string>;
 
-export type Clause = { kind: "when"; body: Expr } | { kind: "unless"; body: Expr };
+export type SchemaJson<N> = Record<string, NamespaceDefinition<N>>;
 
-export interface PolicyJson {
-    effect: Effect;
-    principal: PrincipalConstraint;
-    action: ActionConstraint;
-    resource: ResourceConstraint;
-    conditions: Clause[];
-    annotations?: Annotations;
-}
+export type SchemaToJsonAnswer = { type: "success"; json: SchemaJson<string>; warnings: DetailedError[] } | { type: "failure"; errors: DetailedError[] };
 
-export type ExtFuncCall = {} & Record<string, Array<Expr>>;
+export type SchemaToJsonWithResolvedTypesAnswer = { type: "success"; json: SchemaJson<string>; warnings: DetailedError[] } | { type: "failure"; errors: DetailedError[] };
 
-export type Expr = ExprNoExt | ExtFuncCall;
+export type SchemaToTextAnswer = { type: "success"; text: string; warnings: DetailedError[] } | { type: "failure"; errors: DetailedError[] };
 
-export type PatternElem = "Wildcard" | { Literal: SmolStr };
+export type Severity = "advice" | "warning" | "error";
 
-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 SlotId = string;
 
-export interface TypeAndId {
-    type: string;
-    id: string;
-}
+export type StaticPolicySet = string | Policy[] | Record<PolicyId, Policy>;
 
-export type CedarValueJson = { __entity: TypeAndId } | { __extn: FnAndArgs } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
+export type Template = string | PolicyJson;
 
-export type EntityUidJson = { __entity: TypeAndId } | TypeAndId;
+export type Type<N> = ({} & TypeVariant<N>) | { type: N };
 
-export type FnAndArgs = { fn: string; arg: CedarValueJson } | { fn: string; args: CedarValueJson[] };
+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 UnreservedId = string;
+
+export type ValidationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; validationErrors: ValidationError[]; validationWarnings: ValidationError[]; otherWarnings: DetailedError[] };
+
+export type ValidationMode = "strict";
+
+export type Var = "principal" | "action" | "resource" | "context";
 
 
 /**
@@ -308,6 +333,12 @@ export function getValidRequestEnvsTemplate(t: Template, s: Schema): GetValidReq
  */
 export function isAuthorized(call: AuthorizationCall): AuthorizationAnswer;
 
+/**
+ * Basic interface for partial evaluation, using [`AuthorizationCall`] and
+ * [`PartialAuthorizationAnswer`] types
+ */
+export function isAuthorizedPartial(call: PartialAuthorizationCall): PartialAuthorizationAnswer;
+
 /**
  * Takes a `PolicySet` represented as string and return the policies
  * and templates split into vecs and sorted by id.
@@ -347,6 +378,16 @@ export function preparseSchema(schema_name: string, schema: Schema): CheckParseA
  */
 export function schemaToJson(schema: Schema): SchemaToJsonAnswer;
 
+/**
+ * Convert a Cedar schema string to JSON format with resolved types.
+ *
+ * This function resolves ambiguous "`EntityOrCommon`" types to their specific
+ * Entity or `CommonType` classifications using the schema's type definitions.
+ * This is primarily meant to be used when working with schemas programmatically,
+ * for example when creating a schema building UI.
+ */
+export function schemaToJsonWithResolvedTypes(schema_str: string): SchemaToJsonWithResolvedTypesAnswer;
+
 /**
  * Return the Cedar (textual) representation of a schema.
  */

package/esm/cedar_wasm.js

@@ -1,5 +1,9 @@
+/* @ts-self-types="./cedar_wasm.d.ts" */
+
 import * as wasm from "./cedar_wasm_bg.wasm";
-export * from "./cedar_wasm_bg.js";
 import { __wbg_set_wasm } from "./cedar_wasm_bg.js";
 __wbg_set_wasm(wasm);
 wasm.__wbindgen_start();
+export {
+    checkParseContext, checkParseEntities, checkParsePolicySet, checkParseSchema, formatPolicies, getCedarLangVersion, getCedarSDKVersion, getCedarVersion, getValidRequestEnvsPolicy, getValidRequestEnvsTemplate, isAuthorized, isAuthorizedPartial, policySetTextToParts, policyToJson, policyToText, preparsePolicySet, preparseSchema, schemaToJson, schemaToJsonWithResolvedTypes, schemaToText, statefulIsAuthorized, templateToJson, templateToText, validate
+} from "./cedar_wasm_bg.js";