@cedar-policy/cedar-wasm 4.3.0 → 4.4.0

package/web/cedar_wasm.d.ts

@@ -10,6 +10,26 @@ export function getValidRequestEnvsTemplate(t: Template, s: Schema): GetValidReq
 export function getValidRequestEnvsPolicy(t: Policy, s: Schema): GetValidRequestEnvsResult;
 export function getCedarVersion(): string;
 export function getCedarSDKVersion(): string;
+/**
+ * Basic interface, using [`AuthorizationCall`] and [`AuthorizationAnswer`] types
+ */
+export function isAuthorized(call: AuthorizationCall): AuthorizationAnswer;
+/**
+ * Check whether a policy set successfully parses.
+ */
+export function checkParsePolicySet(policies: PolicySet): CheckParseAnswer;
+/**
+ * Check whether a schema successfully parses.
+ */
+export function checkParseSchema(schema: Schema): CheckParseAnswer;
+/**
+ * Check whether a set of entities successfully parses.
+ */
+export function checkParseEntities(call: EntitiesParsingCall): CheckParseAnswer;
+/**
+ * Check whether a context successfully parses.
+ */
+export function checkParseContext(call: ContextParsingCall): CheckParseAnswer;
 /**
  * Parse a policy set and optionally validate it against a provided schema
  *
@@ -18,9 +38,9 @@ export function getCedarSDKVersion(): string;
  */
 export function validate(call: ValidationCall): ValidationAnswer;
 /**
- * Get language version of Cedar
+ * Apply the Cedar policy formatter to a policy set in the Cedar policy format
  */
-export function getCedarLangVersion(): string;
+export function formatPolicies(call: FormattingCall): FormattingAnswer;
 /**
  * Return the Cedar (textual) representation of a policy.
  */
@@ -46,73 +66,11 @@ export function schemaToText(schema: Schema): SchemaToTextAnswer;
  */
 export function schemaToJson(schema: Schema): SchemaToJsonAnswer;
 /**
- * Check whether a policy set successfully parses.
- */
-export function checkParsePolicySet(policies: PolicySet): CheckParseAnswer;
-/**
- * Check whether a schema successfully parses.
- */
-export function checkParseSchema(schema: Schema): CheckParseAnswer;
-/**
- * Check whether a set of entities successfully parses.
- */
-export function checkParseEntities(call: EntitiesParsingCall): CheckParseAnswer;
-/**
- * Check whether a context successfully parses.
- */
-export function checkParseContext(call: ContextParsingCall): CheckParseAnswer;
-/**
- * Basic interface, using [`AuthorizationCall`] and [`AuthorizationAnswer`] types
- */
-export function isAuthorized(call: AuthorizationCall): AuthorizationAnswer;
-/**
- * Apply the Cedar policy formatter to a policy set in the Cedar policy format
+ * Get language version of Cedar
  */
-export function formatPolicies(call: FormattingCall): FormattingAnswer;
+export function getCedarLangVersion(): string;
 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 PolicyToTextAnswer = { type: "success"; text: 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 SlotId = string;
-
-export type PolicyId = string;
-
-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 Response {
     decision: Decision;
     diagnostics: Diagnostics;
@@ -141,13 +99,22 @@ export interface AuthorizationCall {
     entities: Entities;
 }
 
-export interface FormattingCall {
-    policyText: string;
-    lineWidth?: number;
-    indentWidth?: number;
+export type CheckParseAnswer = { type: "success" } | { type: "failure"; errors: DetailedError[] };
+
+export interface EntitiesParsingCall {
+    entities: Entities;
+    schema?: Schema | null;
 }
 
-export type FormattingAnswer = { type: "failure"; errors: DetailedError[] } | { type: "success"; formatted_policy: string };
+export interface ContextParsingCall {
+    context: Context;
+    schema?: Schema | null;
+    action?: EntityUid | null;
+}
+
+export type SlotId = string;
+
+export type PolicyId = string;
 
 export type Schema = string | SchemaJson<string>;
 
@@ -196,6 +163,39 @@ export interface DetailedError {
     related?: DetailedError[];
 }
 
+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 interface FormattingCall {
+    policyText: string;
+    lineWidth?: number;
+    indentWidth?: number;
+}
+
+export type FormattingAnswer = { type: "failure"; errors: DetailedError[] } | { type: "success"; formatted_policy: string };
+
+export type PolicyToTextAnswer = { type: "success"; text: 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 ValidationMode = "strict";
 
 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 };
@@ -227,13 +227,14 @@ export interface ActionType<N> {
 
 export type AttributesOrContext<N> = Type<N>;
 
-export interface EntityType<N> {
+export interface StandardEntityType<N> {
     memberOfTypes?: N[];
     shape?: AttributesOrContext<N>;
     tags?: Type<N>;
-    annotations?: Annotations;
 }
 
+export type EntityTypeKind<N> = StandardEntityType<N> | { enum: NonEmpty<SmolStr> };
+
 export interface NamespaceDefinition<N> {
     commonTypes?: Record<CommonTypeId, CommonType<N>>;
     entityTypes: Record<UnreservedId, EntityType<N>>;
@@ -245,41 +246,8 @@ export type CommonTypeId = string;
 
 export type SchemaJson<N> = Record<string, NamespaceDefinition<N>>;
 
-export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
-
-export interface PrincipalOrResourceIsConstraint {
-    entity_type: string;
-    in?: PrincipalOrResourceInConstraint;
-}
-
-export type PrincipalOrResourceInConstraint = { entity: EntityUidJson } | { slot: string };
-
-export type EqConstraint = { entity: EntityUidJson } | { slot: string };
-
-export type ResourceConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
-
-export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
-
-export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
-
 export type Var = "principal" | "action" | "resource" | "context";
 
-export type EntityUidJson = { __entity: TypeAndId } | TypeAndId;
-
-export interface FnAndArg {
-    fn: string;
-    arg: CedarValueJson;
-}
-
-export interface TypeAndId {
-    type: string;
-    id: string;
-}
-
-export type CedarValueJson = { __entity: TypeAndId } | { __extn: FnAndArg } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
-
-export type Annotations = Record<string, Annotation>;
-
 export interface EntityJson {
     uid: EntityUidJson;
     attrs: Record<string, CedarValueJson>;
@@ -289,8 +257,6 @@ export interface EntityJson {
 
 export type Decision = "allow" | "deny";
 
-export type Annotation = SmolStr;
-
 export type Clause = { kind: "when"; body: Expr } | { kind: "unless"; body: Expr };
 
 export interface PolicyJson {
@@ -314,36 +280,73 @@ export type AnyId = SmolStr;
 
 export type UnreservedId = string;
 
+export type EntityUidJson = { __entity: TypeAndId } | TypeAndId;
+
+export interface FnAndArg {
+    fn: string;
+    arg: CedarValueJson;
+}
+
+export interface TypeAndId {
+    type: string;
+    id: string;
+}
+
+export type CedarValueJson = { __entity: TypeAndId } | { __extn: FnAndArg } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
+
+export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
+
+export interface PrincipalOrResourceIsConstraint {
+    entity_type: string;
+    in?: PrincipalOrResourceInConstraint;
+}
+
+export type PrincipalOrResourceInConstraint = { entity: EntityUidJson } | { slot: string };
+
+export type EqConstraint = { entity: EntityUidJson } | { slot: string };
+
+export type ResourceConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+
+export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+
+export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+
 export type Effect = "permit" | "forbid";
 
+export type Annotations = Record<string, Annotation>;
+
+export type Annotation = SmolStr;
+
 
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
   readonly memory: WebAssembly.Memory;
-  readonly getValidRequestEnvsTemplate: (a: number, b: number) => number;
-  readonly getValidRequestEnvsPolicy: (a: number, b: number) => number;
-  readonly getCedarSDKVersion: (a: number) => void;
-  readonly getCedarVersion: (a: number) => void;
-  readonly validate: (a: number) => number;
-  readonly getCedarLangVersion: (a: number) => void;
-  readonly policyToText: (a: number) => number;
-  readonly templateToText: (a: number) => number;
-  readonly policyToJson: (a: number) => number;
-  readonly templateToJson: (a: number) => number;
-  readonly schemaToText: (a: number) => number;
-  readonly schemaToJson: (a: number) => number;
-  readonly checkParsePolicySet: (a: number) => number;
-  readonly checkParseSchema: (a: number) => number;
-  readonly checkParseEntities: (a: number) => number;
-  readonly checkParseContext: (a: number) => number;
-  readonly isAuthorized: (a: number) => number;
-  readonly formatPolicies: (a: number) => number;
+  readonly getValidRequestEnvsTemplate: (a: any, b: any) => any;
+  readonly getValidRequestEnvsPolicy: (a: any, b: any) => any;
+  readonly getCedarSDKVersion: () => [number, number];
+  readonly getCedarVersion: () => [number, number];
+  readonly isAuthorized: (a: any) => any;
+  readonly checkParsePolicySet: (a: any) => any;
+  readonly checkParseSchema: (a: any) => any;
+  readonly checkParseEntities: (a: any) => any;
+  readonly checkParseContext: (a: any) => any;
+  readonly validate: (a: any) => any;
+  readonly formatPolicies: (a: any) => any;
+  readonly policyToText: (a: any) => any;
+  readonly templateToText: (a: any) => any;
+  readonly policyToJson: (a: any) => any;
+  readonly templateToJson: (a: any) => any;
+  readonly schemaToText: (a: any) => any;
+  readonly schemaToJson: (a: any) => any;
+  readonly getCedarLangVersion: () => [number, number];
   readonly __wbindgen_exn_store: (a: number) => void;
+  readonly __externref_table_alloc: () => number;
+  readonly __wbindgen_export_2: WebAssembly.Table;
   readonly __wbindgen_malloc: (a: number, b: number) => number;
   readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
-  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
   readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_start: () => void;
 }
 
 export type SyncInitInput = BufferSource | WebAssembly.Module;
@@ -369,3 +372,5 @@ export default function __wbg_init (module_or_path?: { module_or_path: InitInput
 type SmolStr = string;
 export type TypeOfAttribute<N> = Type<N> & { required?: boolean };
 export type CommonType<N> = Type<N> & { annotations?: Annotations };
+export type EntityType<N> = EntityTypeKind<N> & { annotations?: Annotations; };
+export type NonEmpty<Type> = Array<Type>;