@cedar-policy/cedar-wasm 4.2.0 → 4.3.0

package/esm/cedar_wasm.d.ts

@@ -1,134 +1,76 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
-* Get valid request environment
-* @param {Template} t
-* @param {Schema} s
-* @returns {GetValidRequestEnvsResult}
-*/
+ * Get valid request environment
+ */
 export function getValidRequestEnvsTemplate(t: Template, s: Schema): GetValidRequestEnvsResult;
 /**
-* Get valid request environment
-* @param {Policy} t
-* @param {Schema} s
-* @returns {GetValidRequestEnvsResult}
-*/
+ * Get valid request environment
+ */
 export function getValidRequestEnvsPolicy(t: Policy, s: Schema): GetValidRequestEnvsResult;
-/**
-* @returns {string}
-*/
 export function getCedarVersion(): string;
+export function getCedarSDKVersion(): string;
 /**
-* 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}
-*/
+ * 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;
 /**
-* Apply the Cedar policy formatter to a policy set in the Cedar policy format
-* @param {FormattingCall} call
-* @returns {FormattingAnswer}
-*/
-export function formatPolicies(call: FormattingCall): FormattingAnswer;
+ * Get language version of Cedar
+ */
+export function getCedarLangVersion(): string;
 /**
-* Return the Cedar (textual) representation of a policy.
-* @param {Policy} policy
-* @returns {PolicyToTextAnswer}
-*/
+ * Return the Cedar (textual) representation of a policy.
+ */
 export function policyToText(policy: Policy): PolicyToTextAnswer;
 /**
-* Return the Cedar (textual) representation of a template.
-* @param {Template} template
-* @returns {PolicyToTextAnswer}
-*/
+ * Return the Cedar (textual) representation of a template.
+ */
 export function templateToText(template: Template): PolicyToTextAnswer;
 /**
-* Return the JSON representation of a policy.
-* @param {Policy} policy
-* @returns {PolicyToJsonAnswer}
-*/
+ * Return the JSON representation of a policy.
+ */
 export function policyToJson(policy: Policy): PolicyToJsonAnswer;
 /**
-* Return the JSON representation of a template.
-* @param {Template} template
-* @returns {PolicyToJsonAnswer}
-*/
+ * Return the JSON representation of a template.
+ */
 export function templateToJson(template: Template): PolicyToJsonAnswer;
 /**
-* Return the Cedar (textual) representation of a schema.
-* @param {Schema} schema
-* @returns {SchemaToTextAnswer}
-*/
+ * Return the Cedar (textual) representation of a schema.
+ */
 export function schemaToText(schema: Schema): SchemaToTextAnswer;
 /**
-* Return the JSON representation of a schema.
-* @param {Schema} schema
-* @returns {SchemaToJsonAnswer}
-*/
+ * Return the JSON representation of a schema.
+ */
 export function schemaToJson(schema: Schema): SchemaToJsonAnswer;
 /**
-* Check whether a policy set successfully parses.
-* @param {PolicySet} policies
-* @returns {CheckParseAnswer}
-*/
+ * Check whether a policy set successfully parses.
+ */
 export function checkParsePolicySet(policies: PolicySet): CheckParseAnswer;
 /**
-* Check whether a schema successfully parses.
-* @param {Schema} schema
-* @returns {CheckParseAnswer}
-*/
+ * Check whether a schema successfully parses.
+ */
 export function checkParseSchema(schema: Schema): CheckParseAnswer;
 /**
-* Check whether a set of entities successfully parses.
-* @param {EntitiesParsingCall} call
-* @returns {CheckParseAnswer}
-*/
+ * Check whether a set of entities successfully parses.
+ */
 export function checkParseEntities(call: EntitiesParsingCall): CheckParseAnswer;
 /**
-* Check whether a context successfully parses.
-* @param {ContextParsingCall} call
-* @returns {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
+ */
+export function formatPolicies(call: FormattingCall): FormattingAnswer;
 export type GetValidRequestEnvsResult = { type: "success"; principals: string[]; actions: string[]; resources: string[] } | { type: "failure"; error: string };
 
-export interface Response {
-    decision: Decision;
-    diagnostics: Diagnostics;
-}
-
-export interface Diagnostics {
-    reason: PolicyId[];
-    errors: AuthorizationError[];
-}
-
-export interface AuthorizationError {
-    policyId: string;
-    error: DetailedError;
-}
-
-export type AuthorizationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; response: Response; warnings: DetailedError[] };
-
-export interface AuthorizationCall {
-    principal: EntityUid;
-    action: EntityUid;
-    resource: EntityUid;
-    context: Context;
-    schema?: Schema;
-    validateRequest?: boolean;
-    policies: PolicySet;
-    entities: Entities;
-}
-
 export interface ValidationCall {
     validationSettings?: ValidationSettings;
     schema: Schema;
@@ -146,14 +88,6 @@ export interface ValidationError {
 
 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[] };
@@ -162,7 +96,9 @@ 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 ValidationMode = "strict";
+export type SlotId = string;
+
+export type PolicyId = string;
 
 export type CheckParseAnswer = { type: "success" } | { type: "failure"; errors: DetailedError[] };
 
@@ -177,9 +113,41 @@ export interface ContextParsingCall {
     action?: EntityUid | null;
 }
 
-export type SlotId = string;
+export interface Response {
+    decision: Decision;
+    diagnostics: Diagnostics;
+}
 
-export type PolicyId = string;
+export interface Diagnostics {
+    reason: PolicyId[];
+    errors: AuthorizationError[];
+}
+
+export interface AuthorizationError {
+    policyId: string;
+    error: DetailedError;
+}
+
+export type AuthorizationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; response: Response; warnings: DetailedError[] };
+
+export interface AuthorizationCall {
+    principal: EntityUid;
+    action: EntityUid;
+    resource: EntityUid;
+    context: Context;
+    schema?: Schema;
+    validateRequest?: boolean;
+    policies: PolicySet;
+    entities: Entities;
+}
+
+export interface FormattingCall {
+    policyText: string;
+    lineWidth?: number;
+    indentWidth?: number;
+}
+
+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,41 +231,20 @@ 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 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?: Record<string, string>;
-}
-
-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 } } | { 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 Effect = "permit" | "forbid";
-
 export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
 
 export interface PrincipalOrResourceIsConstraint {
@@ -312,12 +262,7 @@ export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | (
 
 export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
 
-export interface EntityJson {
-    uid: EntityUidJson;
-    attrs: Record<string, CedarValueJson>;
-    parents: EntityUidJson[];
-    tags?: Record<string, CedarValueJson>;
-}
+export type Var = "principal" | "action" | "resource" | "context";
 
 export type EntityUidJson = { __entity: TypeAndId } | TypeAndId;
 
@@ -333,9 +278,44 @@ export interface TypeAndId {
 
 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>;
+    parents: EntityUidJson[];
+    tags?: Record<string, CedarValueJson>;
+}
+
+export type Decision = "allow" | "deny";
+
+export type Annotation = SmolStr;
+
+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 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 Var = "principal" | "action" | "resource" | "context";
+export type Effect = "permit" | "forbid";
 
 type SmolStr = string;
 export type TypeOfAttribute<N> = Type<N> & { required?: boolean };
+export type CommonType<N> = Type<N> & { annotations?: Annotations };

package/esm/cedar_wasm.js

@@ -1,5 +1,4 @@
-
 import * as wasm from "./cedar_wasm_bg.wasm";
-import { __wbg_set_wasm } from "./cedar_wasm_bg.js";
-__wbg_set_wasm(wasm);
 export * from "./cedar_wasm_bg.js";
+import { __wbg_set_wasm } from "./cedar_wasm_bg.js";
+__wbg_set_wasm(wasm);