@cedar-policy/cedar-wasm 4.2.2 → 4.3.0

package/nodejs/cedar_wasm_bg.wasm.d.ts

@@ -1,24 +1,26 @@
 /* tslint:disable */
 /* eslint-disable */
 export const memory: WebAssembly.Memory;
-export function getValidRequestEnvsTemplate(a: number, b: number): number;
-export function getValidRequestEnvsPolicy(a: number, b: number): number;
-export function getCedarVersion(a: number): void;
-export function formatPolicies(a: number): number;
-export function policyToText(a: number): number;
-export function templateToText(a: number): number;
-export function policyToJson(a: number): number;
-export function templateToJson(a: number): number;
-export function schemaToText(a: number): number;
-export function schemaToJson(a: number): number;
-export function isAuthorized(a: number): number;
-export function validate(a: number): number;
-export function checkParsePolicySet(a: number): number;
-export function checkParseSchema(a: number): number;
-export function checkParseEntities(a: number): number;
-export function checkParseContext(a: number): number;
-export function __wbindgen_malloc(a: number, b: number): number;
-export function __wbindgen_realloc(a: number, b: number, c: number, d: number): number;
-export function __wbindgen_add_to_stack_pointer(a: number): number;
-export function __wbindgen_free(a: number, b: number, c: number): void;
-export function __wbindgen_exn_store(a: number): void;
+export const getValidRequestEnvsTemplate: (a: number, b: number) => number;
+export const getValidRequestEnvsPolicy: (a: number, b: number) => number;
+export const getCedarSDKVersion: (a: number) => void;
+export const getCedarVersion: (a: number) => void;
+export const validate: (a: number) => number;
+export const getCedarLangVersion: (a: number) => void;
+export const policyToText: (a: number) => number;
+export const templateToText: (a: number) => number;
+export const policyToJson: (a: number) => number;
+export const templateToJson: (a: number) => number;
+export const schemaToText: (a: number) => number;
+export const schemaToJson: (a: number) => number;
+export const checkParsePolicySet: (a: number) => number;
+export const checkParseSchema: (a: number) => number;
+export const checkParseEntities: (a: number) => number;
+export const checkParseContext: (a: number) => number;
+export const isAuthorized: (a: number) => number;
+export const formatPolicies: (a: number) => number;
+export const __wbindgen_exn_store: (a: number) => void;
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+export const __wbindgen_add_to_stack_pointer: (a: number) => number;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;

package/nodejs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cedar-policy/cedar-wasm",
   "description": "Wasm bindings and typescript types for Cedar lib",
-  "version": "4.2.2",
+  "version": "4.3.0",
   "license": "Apache-2.0",
   "files": [
     "cedar_wasm_bg.wasm",

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@cedar-policy/cedar-wasm",
-  "type": "module",
   "description": "Wasm bindings and typescript types for Cedar lib",
-  "version": "4.2.2",
+  "version": "4.3.0",
   "license": "Apache-2.0",
   "files": [
     "esm/package.json",
@@ -25,12 +24,11 @@
     "web/cedar_wasm.js",
     "web/cedar_wasm.d.ts"
   ],
-  "main": "cedar_wasm.js",
+  "module": "esm/cedar_wasm.js",
   "types": "esm/cedar_wasm.d.ts",
   "sideEffects": [
     "./snippets/*"
   ],
-  "module": "esm/cedar_wasm.js",
   "exports": {
     ".": {
       "import": "./esm/cedar_wasm.js",

package/web/cedar_wasm.d.ts

@@ -2,118 +2,91 @@
 /* eslint-disable */
 /**
  * Get valid request environment
- * @param {Template} t
- * @param {Schema} s
- * @returns {GetValidRequestEnvsResult}
  */
 export function getValidRequestEnvsTemplate(t: Template, s: Schema): GetValidRequestEnvsResult;
 /**
  * Get valid request environment
- * @param {Policy} t
- * @param {Schema} s
- * @returns {GetValidRequestEnvsResult}
  */
 export function getValidRequestEnvsPolicy(t: Policy, s: Schema): GetValidRequestEnvsResult;
+export function getCedarVersion(): string;
+export function getCedarSDKVersion(): string;
 /**
- * @returns {string}
+ * 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 getCedarVersion(): string;
+export function validate(call: ValidationCall): ValidationAnswer;
 /**
- * Apply the Cedar policy formatter to a policy set in the Cedar policy format
- * @param {FormattingCall} call
- * @returns {FormattingAnswer}
+ * Get language version of Cedar
  */
-export function formatPolicies(call: FormattingCall): FormattingAnswer;
+export function getCedarLangVersion(): string;
 /**
  * Return the Cedar (textual) representation of a policy.
- * @param {Policy} policy
- * @returns {PolicyToTextAnswer}
  */
 export function policyToText(policy: Policy): PolicyToTextAnswer;
 /**
  * Return the Cedar (textual) representation of a template.
- * @param {Template} template
- * @returns {PolicyToTextAnswer}
  */
 export function templateToText(template: Template): PolicyToTextAnswer;
 /**
  * Return the JSON representation of a policy.
- * @param {Policy} policy
- * @returns {PolicyToJsonAnswer}
  */
 export function policyToJson(policy: Policy): PolicyToJsonAnswer;
 /**
  * Return the JSON representation of a template.
- * @param {Template} template
- * @returns {PolicyToJsonAnswer}
  */
 export function templateToJson(template: Template): PolicyToJsonAnswer;
 /**
  * Return the Cedar (textual) representation of a schema.
- * @param {Schema} schema
- * @returns {SchemaToTextAnswer}
  */
 export function schemaToText(schema: Schema): SchemaToTextAnswer;
 /**
  * Return the JSON representation of a schema.
- * @param {Schema} schema
- * @returns {SchemaToJsonAnswer}
  */
 export function schemaToJson(schema: Schema): SchemaToJsonAnswer;
-/**
- * Basic interface, using [`AuthorizationCall`] and [`AuthorizationAnswer`] types
- * @param {AuthorizationCall} call
- * @returns {AuthorizationAnswer}
- */
-export function isAuthorized(call: AuthorizationCall): AuthorizationAnswer;
-/**
- * Parse a policy set and optionally validate it against a provided schema
- *
- * This is the basic validator interface, using [`ValidationCall`] and
- * [`ValidationAnswer`] types
- * @param {ValidationCall} call
- * @returns {ValidationAnswer}
- */
-export function validate(call: ValidationCall): ValidationAnswer;
 /**
  * Check whether a policy set successfully parses.
- * @param {PolicySet} policies
- * @returns {CheckParseAnswer}
  */
 export function checkParsePolicySet(policies: PolicySet): CheckParseAnswer;
 /**
  * Check whether a schema successfully parses.
- * @param {Schema} schema
- * @returns {CheckParseAnswer}
  */
 export function checkParseSchema(schema: Schema): CheckParseAnswer;
 /**
  * Check whether a set of entities successfully parses.
- * @param {EntitiesParsingCall} call
- * @returns {CheckParseAnswer}
  */
 export function checkParseEntities(call: EntitiesParsingCall): CheckParseAnswer;
 /**
  * Check whether a context successfully parses.
- * @param {ContextParsingCall} call
- * @returns {CheckParseAnswer}
  */
 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
+ */
+export function formatPolicies(call: FormattingCall): FormattingAnswer;
 export type GetValidRequestEnvsResult = { type: "success"; principals: string[]; actions: string[]; resources: string[] } | { type: "failure"; error: string };
 
-export type SlotId = string;
-
-export type PolicyId = string;
+export interface ValidationCall {
+    validationSettings?: ValidationSettings;
+    schema: Schema;
+    policies: PolicySet;
+}
 
-export type ValidationMode = "strict";
+export interface ValidationSettings {
+    mode: ValidationMode;
+}
 
-export interface FormattingCall {
-    policyText: string;
-    lineWidth?: number;
-    indentWidth?: number;
+export interface ValidationError {
+    policyId: string;
+    error: DetailedError;
 }
 
-export type FormattingAnswer = { type: "failure"; errors: DetailedError[] } | { type: "success"; formatted_policy: string };
+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[] };
 
@@ -123,6 +96,23 @@ export type SchemaToTextAnswer = { type: "success"; text: string; warnings: Deta
 
 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;
@@ -151,35 +141,13 @@ export interface AuthorizationCall {
     entities: Entities;
 }
 
-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 FormattingCall {
+    policyText: string;
+    lineWidth?: number;
+    indentWidth?: number;
 }
 
-export interface ContextParsingCall {
-    context: Context;
-    schema?: Schema | null;
-    action?: EntityUid | null;
-}
+export type FormattingAnswer = { type: "failure"; errors: DetailedError[] } | { type: "success"; formatted_policy: string };
 
 export type Schema = string | SchemaJson<string>;
 
@@ -228,6 +196,8 @@ export interface DetailedError {
     related?: 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 };
 
 export interface RecordType<N> {
@@ -235,7 +205,7 @@ export interface RecordType<N> {
     additionalAttributes?: boolean;
 }
 
-export type Type<N> = TypeVariant<N> | { type: N };
+export type Type<N> = ({} & TypeVariant<N>) | { type: N };
 
 export interface ActionEntityUID<N> {
     id: SmolStr;
@@ -252,6 +222,7 @@ export interface ActionType<N> {
     attributes?: Record<SmolStr, CedarValueJson>;
     appliesTo?: ApplySpec<N>;
     memberOf?: ActionEntityUID<N>[];
+    annotations?: Annotations;
 }
 
 export type AttributesOrContext<N> = Type<N>;
@@ -260,51 +231,38 @@ export interface EntityType<N> {
     memberOfTypes?: N[];
     shape?: AttributesOrContext<N>;
     tags?: Type<N>;
+    annotations?: Annotations;
 }
 
 export interface NamespaceDefinition<N> {
-    commonTypes?: Record<CommonTypeId, Type<N>>;
+    commonTypes?: Record<CommonTypeId, CommonType<N>>;
     entityTypes: Record<UnreservedId, EntityType<N>>;
     actions: Record<SmolStr, ActionType<N>>;
+    annotations?: Annotations;
 }
 
 export type CommonTypeId = string;
 
 export type SchemaJson<N> = Record<string, NamespaceDefinition<N>>;
 
-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?: Record<string, string>;
-}
-
-export type Effect = "permit" | "forbid";
-
-export type UnreservedId = string;
+export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
 
-export interface EntityJson {
-    uid: EntityUidJson;
-    attrs: Record<string, CedarValueJson>;
-    parents: EntityUidJson[];
-    tags?: Record<string, CedarValueJson>;
+export interface PrincipalOrResourceIsConstraint {
+    entity_type: string;
+    in?: PrincipalOrResourceInConstraint;
 }
 
-export type Decision = "allow" | "deny";
+export type PrincipalOrResourceInConstraint = { entity: EntityUidJson } | { slot: string };
 
-export type Var = "principal" | "action" | "resource" | "context";
+export type EqConstraint = { entity: EntityUidJson } | { slot: string };
 
-export type ExtFuncCall = {} & Record<string, Array<Expr>>;
+export type ResourceConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
 
-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 } } | { 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 ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
 
-export type PatternElem = "Wildcard" | { Literal: SmolStr };
+export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
 
-export type Expr = ExprNoExt | ExtFuncCall;
+export type Var = "principal" | "action" | "resource" | "context";
 
 export type EntityUidJson = { __entity: TypeAndId } | TypeAndId;
 
@@ -320,22 +278,43 @@ export interface TypeAndId {
 
 export type CedarValueJson = { __entity: TypeAndId } | { __extn: FnAndArg } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
 
-export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
+export type Annotations = Record<string, Annotation>;
 
-export interface PrincipalOrResourceIsConstraint {
-    entity_type: string;
-    in?: PrincipalOrResourceInConstraint;
+export interface EntityJson {
+    uid: EntityUidJson;
+    attrs: Record<string, CedarValueJson>;
+    parents: EntityUidJson[];
+    tags?: Record<string, CedarValueJson>;
 }
 
-export type PrincipalOrResourceInConstraint = { entity: EntityUidJson } | { slot: string };
+export type Decision = "allow" | "deny";
 
-export type EqConstraint = { entity: EntityUidJson } | { slot: string };
+export type Annotation = SmolStr;
 
-export type ResourceConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+export type Clause = { kind: "when"; body: Expr } | { kind: "unless"; body: Expr };
 
-export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+export interface PolicyJson {
+    effect: Effect;
+    principal: PrincipalConstraint;
+    action: ActionConstraint;
+    resource: ResourceConstraint;
+    conditions: Clause[];
+    annotations?: Annotations;
+}
 
-export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+export type ExtFuncCall = {} & Record<string, Array<Expr>>;
+
+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 PatternElem = "Wildcard" | { Literal: SmolStr };
+
+export type Expr = ExprNoExt | ExtFuncCall;
+
+export type AnyId = SmolStr;
+
+export type UnreservedId = string;
+
+export type Effect = "permit" | "forbid";
 
 
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
@@ -344,25 +323,27 @@ 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 formatPolicies: (a: number) => number;
+  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 isAuthorized: (a: number) => number;
-  readonly validate: (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 __wbindgen_exn_store: (a: number) => void;
   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_exn_store: (a: number) => void;
 }
 
 export type SyncInitInput = BufferSource | WebAssembly.Module;
@@ -387,3 +368,4 @@ export function initSync(module: { module: SyncInitInput } | SyncInitInput): Ini
 export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;
 type SmolStr = string;
 export type TypeOfAttribute<N> = Type<N> & { required?: boolean };
+export type CommonType<N> = Type<N> & { annotations?: Annotations };