@cedar-policy/cedar-wasm 3.2.2 → 3.2.3

package/README.md

@@ -6,6 +6,33 @@ An implementation of various cedar functions to enable developers to write types
 
 Installing is simple, just run `npm i @cedar-policy/cedar-wasm --save` or install with whatever your favorite package manager is.
 
+Loading is much more complicated. It depends on your environment. We offer three subpackages:
+
+* es modules (default). It loads wasm in a way that will be bundled into a single file if you use dynamic imports, or embedded into your main bundle if you use regular imports.
+* commonjs (for node). It loads wasm using node's `fs` module, synchronously. Not really designed for bundling or shipping to the browser.
+* web: more customizable. This one is for when you need to load the wasm in some totally custom way. More details in the "alternate loading strategies" section.
+
+These sub-packages are named `@cedar-policy/cedar-wasm`, `@cedar-policy/cedar-wasm/nodejs`, and `@cedar-policy/cedar-wasm/web`, respectively.
+
+## Loading in bare nodeJs without a bundler
+
+Node uses CommonJs so you have to import with require, or with dynamic `import()`. 
+
+Importing the CJS export:
+
+```
+const cedar = require('@cedar-policy/cedar-wasm/nodejs');
+console.log(cedar.getCedarVersion());
+```
+
+Importing the esm version using esm async import:
+
+```
+import('@cedar-policy/cedar-wasm')
+  .then(cedar => console.log(cedar.getCedarVersion()));
+```
+
+
 ## Loading in webpack 5:
 
 Minimal package.json for webpack including dev server:
@@ -32,7 +59,8 @@ Minimal package.json for webpack including dev server:
     "typescript": "^5.4.5",
     "webpack": "^5.91.0",
     "webpack-cli": "^5.1.4",
-    "webpack-dev-server": "^5.0.4"
+    "webpack-dev-server": "^5.0.4",
+    "html-webpack-plugin": "^5.6.0"
   }
 }
 ```
@@ -57,6 +85,7 @@ Configure webpack.config.js:
 
 ```
 const path = require('path');
+const HtmlWebpackPlugin = require('html-webpack-plugin');
 
 module.exports = { 
   mode: 'development', // change this to suit you
@@ -79,7 +108,8 @@ module.exports = {
   },  
   experiments: {
     asyncWebAssembly: true, // enables wasm support in webpack
-  },  
+  },
+  plugins: [new HtmlWebpackPlugin()],
   devServer: {
     static: {
       directory: path.join(__dirname, 'dist'),

package/esm/README.md

@@ -6,6 +6,33 @@ An implementation of various cedar functions to enable developers to write types
 
 Installing is simple, just run `npm i @cedar-policy/cedar-wasm --save` or install with whatever your favorite package manager is.
 
+Loading is much more complicated. It depends on your environment. We offer three subpackages:
+
+* es modules (default). It loads wasm in a way that will be bundled into a single file if you use dynamic imports, or embedded into your main bundle if you use regular imports.
+* commonjs (for node). It loads wasm using node's `fs` module, synchronously. Not really designed for bundling or shipping to the browser.
+* web: more customizable. This one is for when you need to load the wasm in some totally custom way. More details in the "alternate loading strategies" section.
+
+These sub-packages are named `@cedar-policy/cedar-wasm`, `@cedar-policy/cedar-wasm/nodejs`, and `@cedar-policy/cedar-wasm/web`, respectively.
+
+## Loading in bare nodeJs without a bundler
+
+Node uses CommonJs so you have to import with require, or with dynamic `import()`. 
+
+Importing the CJS export:
+
+```
+const cedar = require('@cedar-policy/cedar-wasm/nodejs');
+console.log(cedar.getCedarVersion());
+```
+
+Importing the esm version using esm async import:
+
+```
+import('@cedar-policy/cedar-wasm')
+  .then(cedar => console.log(cedar.getCedarVersion()));
+```
+
+
 ## Loading in webpack 5:
 
 Minimal package.json for webpack including dev server:
@@ -32,7 +59,8 @@ Minimal package.json for webpack including dev server:
     "typescript": "^5.4.5",
     "webpack": "^5.91.0",
     "webpack-cli": "^5.1.4",
-    "webpack-dev-server": "^5.0.4"
+    "webpack-dev-server": "^5.0.4",
+    "html-webpack-plugin": "^5.6.0"
   }
 }
 ```
@@ -57,6 +85,7 @@ Configure webpack.config.js:
 
 ```
 const path = require('path');
+const HtmlWebpackPlugin = require('html-webpack-plugin');
 
 module.exports = { 
   mode: 'development', // change this to suit you
@@ -79,7 +108,8 @@ module.exports = {
   },  
   experiments: {
     asyncWebAssembly: true, // enables wasm support in webpack
-  },  
+  },
+  plugins: [new HtmlWebpackPlugin()],
   devServer: {
     static: {
       directory: path.join(__dirname, 'dist'),

package/esm/cedar_wasm.d.ts

@@ -21,6 +21,13 @@ export function checkParsePolicySet(input_policies_str: string): CheckParsePolic
 */
 export function checkParseTemplate(template_str: string): CheckParseTemplateResult;
 /**
+* @param {string} policies_str
+* @param {number} line_width
+* @param {number} indent_width
+* @returns {FormattingResult}
+*/
+export function formatPolicies(policies_str: string, line_width: number, indent_width: number): FormattingResult;
+/**
 * @param {string} input_schema
 * @returns {CheckParseResult}
 */
@@ -39,17 +46,6 @@ export function checkParseEntities(entities_str: string, schema_str: string): Ch
 */
 export function checkParseContext(context_str: string, action_str: string, schema_str: string): CheckParseResult;
 /**
-* @param {string} policies_str
-* @param {number} line_width
-* @param {number} indent_width
-* @returns {FormattingResult}
-*/
-export function formatPolicies(policies_str: string, line_width: number, indent_width: number): FormattingResult;
-/**
-* @returns {string}
-*/
-export function getCedarVersion(): string;
-/**
 * @param {AuthorizationCall} call
 * @returns {AuthorizationAnswer}
 */
@@ -59,6 +55,10 @@ export function isAuthorized(call: AuthorizationCall): AuthorizationAnswer;
 * @returns {ValidationAnswer}
 */
 export function validate(call: ValidationCall): ValidationAnswer;
+/**
+* @returns {string}
+*/
+export function getCedarVersion(): string;
 export type JsonToPolicyResult = { type: "success"; policyText: string } | { type: "error"; errors: string[] };
 
 export type PolicyToJsonResult = { type: "success"; policy: Policy } | { type: "error"; errors: string[] };
@@ -67,34 +67,9 @@ export type CheckParsePolicySetResult = { type: "success"; policies: number; tem
 
 export type CheckParseTemplateResult = { type: "success"; slots: string[] } | { type: "error"; errors: string[] };
 
-export type CheckParseResult = { type: "success" } | { type: "error"; errors: string[] };
-
 export type FormattingResult = { type: "success"; formatted_policy: string } | { type: "error"; errors: string[] };
 
-export type Schema = { human: string } | { json: SchemaJson };
-
-export type PolicySet = string | Record<string, 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;
-    code: string | null;
-    url: string | null;
-    severity: Severity | null;
-    sourceLocations?: SourceLabel[];
-    related?: DetailedError[];
-}
+export type CheckParseResult = { type: "success" } | { type: "error"; errors: string[] };
 
 export type ValidationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; validationErrors: ValidationError[]; validationWarnings: ValidationError[]; otherWarnings: DetailedError[] };
 
@@ -167,6 +142,31 @@ export interface Response {
     diagnostics: Diagnostics;
 }
 
+export type Schema = { human: string } | { json: SchemaJson };
+
+export type PolicySet = string | Record<string, 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;
+    code: string | null;
+    url: string | null;
+    severity: Severity | null;
+    sourceLocations?: SourceLabel[];
+    related?: DetailedError[];
+}
+
 export type SchemaTypeVariant = { type: "String" } | { type: "Long" } | { type: "Boolean" } | { type: "Set"; element: SchemaType } | { type: "Record"; attributes: Record<SmolStr, TypeOfAttribute>; additionalAttributes: boolean } | { type: "Entity"; name: Name } | { type: "Extension"; name: Id };
 
 export type SchemaType = SchemaTypeVariant | { type: Name };
@@ -203,23 +203,28 @@ export interface NamespaceDefinition {
 
 export type SchemaJson = Record<string, NamespaceDefinition>;
 
-export type EntityUidJson = { __expr: string } | { __entity: TypeAndId } | TypeAndId;
+export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
 
-export interface FnAndArg {
-    fn: string;
-    arg: CedarValueJson;
+export interface PrincipalOrResourceIsConstraint {
+    entity_type: string;
+    in?: PrincipalOrResourceInConstraint;
 }
 
-export interface TypeAndId {
-    type: string;
-    id: string;
-}
+export type PrincipalOrResourceInConstraint = { entity: EntityUidJson } | { slot: string };
 
-export type CedarValueJson = { __expr: string } | { __entity: TypeAndId } | { __extn: FnAndArg } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
+export type EqConstraint = { entity: EntityUidJson } | { slot: string };
 
-export type Var = "principal" | "action" | "resource" | "context";
+export type ResourceConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
 
-export type Effect = "permit" | "forbid";
+export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+
+export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+
+export interface EntityJson {
+    uid: EntityUidJson;
+    attrs: Record<string, CedarValueJson>;
+    parents: EntityUidJson[];
+}
 
 export type Clause = { kind: "when"; body: Expr } | { kind: "unless"; body: Expr };
 
@@ -232,30 +237,23 @@ export interface Policy {
     annotations?: Record<string, string>;
 }
 
-export interface EntityJson {
-    uid: EntityUidJson;
-    attrs: Record<string, CedarValueJson>;
-    parents: EntityUidJson[];
-}
-
-export type Decision = "Allow" | "Deny";
+export type Effect = "permit" | "forbid";
 
-export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
+export type EntityUidJson = { __expr: string } | { __entity: TypeAndId } | TypeAndId;
 
-export interface PrincipalOrResourceIsConstraint {
-    entity_type: string;
-    in?: PrincipalOrResourceInConstraint;
+export interface FnAndArg {
+    fn: string;
+    arg: CedarValueJson;
 }
 
-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 interface TypeAndId {
+    type: string;
+    id: string;
+}
 
-export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+export type CedarValueJson = { __expr: string } | { __entity: TypeAndId } | { __extn: FnAndArg } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
 
-export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+export type Decision = "Allow" | "Deny";
 
 export type ExtFuncCall = {} & Record<string, Array<Expr>>;
 
@@ -263,6 +261,8 @@ export type ExprNoExt = { Value: CedarValueJson } | { Var: Var } | { Slot: strin
 
 export type Expr = ExprNoExt | ExtFuncCall;
 
+export type Var = "principal" | "action" | "resource" | "context";
+
 type SmolStr = string;
 type Name = string;
 type Id = string;

package/esm/cedar_wasm_bg.js

@@ -167,6 +167,19 @@ export function checkParseTemplate(template_str) {
     return takeObject(ret);
 }
 
+/**
+* @param {string} policies_str
+* @param {number} line_width
+* @param {number} indent_width
+* @returns {FormattingResult}
+*/
+export function formatPolicies(policies_str, line_width, indent_width) {
+    const ptr0 = passStringToWasm0(policies_str, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.formatPolicies(ptr0, len0, line_width, indent_width);
+    return takeObject(ret);
+}
+
 /**
 * @param {string} input_schema
 * @returns {CheckParseResult}
@@ -210,15 +223,20 @@ export function checkParseContext(context_str, action_str, schema_str) {
 }
 
 /**
-* @param {string} policies_str
-* @param {number} line_width
-* @param {number} indent_width
-* @returns {FormattingResult}
+* @param {AuthorizationCall} call
+* @returns {AuthorizationAnswer}
 */
-export function formatPolicies(policies_str, line_width, indent_width) {
-    const ptr0 = passStringToWasm0(policies_str, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-    const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.formatPolicies(ptr0, len0, line_width, indent_width);
+export function isAuthorized(call) {
+    const ret = wasm.isAuthorized(addHeapObject(call));
+    return takeObject(ret);
+}
+
+/**
+* @param {ValidationCall} call
+* @returns {ValidationAnswer}
+*/
+export function validate(call) {
+    const ret = wasm.validate(addHeapObject(call));
     return takeObject(ret);
 }
 
@@ -242,24 +260,6 @@ export function getCedarVersion() {
     }
 }
 
-/**
-* @param {AuthorizationCall} call
-* @returns {AuthorizationAnswer}
-*/
-export function isAuthorized(call) {
-    const ret = wasm.isAuthorized(addHeapObject(call));
-    return takeObject(ret);
-}
-
-/**
-* @param {ValidationCall} call
-* @returns {ValidationAnswer}
-*/
-export function validate(call) {
-    const ret = wasm.validate(addHeapObject(call));
-    return takeObject(ret);
-}
-
 function handleError(f, args) {
     try {
         return f.apply(this, args);

package/esm/cedar_wasm_bg.wasm.d.ts

@@ -5,13 +5,13 @@ export function policyTextFromJson(a: number, b: number): number;
 export function policyTextToJson(a: number, b: number): number;
 export function checkParsePolicySet(a: number, b: number): number;
 export function checkParseTemplate(a: number, b: number): number;
+export function formatPolicies(a: number, b: number, c: number, d: number): number;
 export function checkParseSchema(a: number, b: number): number;
 export function checkParseEntities(a: number, b: number, c: number, d: number): number;
 export function checkParseContext(a: number, b: number, c: number, d: number, e: number, f: number): number;
-export function formatPolicies(a: number, b: number, c: number, d: number): number;
-export function getCedarVersion(a: number): void;
 export function isAuthorized(a: number): number;
 export function validate(a: number): number;
+export function getCedarVersion(a: number): void;
 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;

package/esm/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@cedar-policy/cedar-wasm",
   "description": "Wasm bindings and typescript types for Cedar lib",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "license": "Apache-2.0",
   "files": [
     "cedar_wasm_bg.wasm",
-    "cedar_wasm_bg.wasm.d.ts",
     "cedar_wasm.js",
     "cedar_wasm_bg.js",
     "cedar_wasm.d.ts"

package/nodejs/README.md

@@ -6,6 +6,33 @@ An implementation of various cedar functions to enable developers to write types
 
 Installing is simple, just run `npm i @cedar-policy/cedar-wasm --save` or install with whatever your favorite package manager is.
 
+Loading is much more complicated. It depends on your environment. We offer three subpackages:
+
+* es modules (default). It loads wasm in a way that will be bundled into a single file if you use dynamic imports, or embedded into your main bundle if you use regular imports.
+* commonjs (for node). It loads wasm using node's `fs` module, synchronously. Not really designed for bundling or shipping to the browser.
+* web: more customizable. This one is for when you need to load the wasm in some totally custom way. More details in the "alternate loading strategies" section.
+
+These sub-packages are named `@cedar-policy/cedar-wasm`, `@cedar-policy/cedar-wasm/nodejs`, and `@cedar-policy/cedar-wasm/web`, respectively.
+
+## Loading in bare nodeJs without a bundler
+
+Node uses CommonJs so you have to import with require, or with dynamic `import()`. 
+
+Importing the CJS export:
+
+```
+const cedar = require('@cedar-policy/cedar-wasm/nodejs');
+console.log(cedar.getCedarVersion());
+```
+
+Importing the esm version using esm async import:
+
+```
+import('@cedar-policy/cedar-wasm')
+  .then(cedar => console.log(cedar.getCedarVersion()));
+```
+
+
 ## Loading in webpack 5:
 
 Minimal package.json for webpack including dev server:
@@ -32,7 +59,8 @@ Minimal package.json for webpack including dev server:
     "typescript": "^5.4.5",
     "webpack": "^5.91.0",
     "webpack-cli": "^5.1.4",
-    "webpack-dev-server": "^5.0.4"
+    "webpack-dev-server": "^5.0.4",
+    "html-webpack-plugin": "^5.6.0"
   }
 }
 ```
@@ -57,6 +85,7 @@ Configure webpack.config.js:
 
 ```
 const path = require('path');
+const HtmlWebpackPlugin = require('html-webpack-plugin');
 
 module.exports = { 
   mode: 'development', // change this to suit you
@@ -79,7 +108,8 @@ module.exports = {
   },  
   experiments: {
     asyncWebAssembly: true, // enables wasm support in webpack
-  },  
+  },
+  plugins: [new HtmlWebpackPlugin()],
   devServer: {
     static: {
       directory: path.join(__dirname, 'dist'),

package/nodejs/cedar_wasm.d.ts

@@ -21,6 +21,13 @@ export function checkParsePolicySet(input_policies_str: string): CheckParsePolic
 */
 export function checkParseTemplate(template_str: string): CheckParseTemplateResult;
 /**
+* @param {string} policies_str
+* @param {number} line_width
+* @param {number} indent_width
+* @returns {FormattingResult}
+*/
+export function formatPolicies(policies_str: string, line_width: number, indent_width: number): FormattingResult;
+/**
 * @param {string} input_schema
 * @returns {CheckParseResult}
 */
@@ -39,17 +46,6 @@ export function checkParseEntities(entities_str: string, schema_str: string): Ch
 */
 export function checkParseContext(context_str: string, action_str: string, schema_str: string): CheckParseResult;
 /**
-* @param {string} policies_str
-* @param {number} line_width
-* @param {number} indent_width
-* @returns {FormattingResult}
-*/
-export function formatPolicies(policies_str: string, line_width: number, indent_width: number): FormattingResult;
-/**
-* @returns {string}
-*/
-export function getCedarVersion(): string;
-/**
 * @param {AuthorizationCall} call
 * @returns {AuthorizationAnswer}
 */
@@ -59,6 +55,10 @@ export function isAuthorized(call: AuthorizationCall): AuthorizationAnswer;
 * @returns {ValidationAnswer}
 */
 export function validate(call: ValidationCall): ValidationAnswer;
+/**
+* @returns {string}
+*/
+export function getCedarVersion(): string;
 export type JsonToPolicyResult = { type: "success"; policyText: string } | { type: "error"; errors: string[] };
 
 export type PolicyToJsonResult = { type: "success"; policy: Policy } | { type: "error"; errors: string[] };
@@ -67,34 +67,9 @@ export type CheckParsePolicySetResult = { type: "success"; policies: number; tem
 
 export type CheckParseTemplateResult = { type: "success"; slots: string[] } | { type: "error"; errors: string[] };
 
-export type CheckParseResult = { type: "success" } | { type: "error"; errors: string[] };
-
 export type FormattingResult = { type: "success"; formatted_policy: string } | { type: "error"; errors: string[] };
 
-export type Schema = { human: string } | { json: SchemaJson };
-
-export type PolicySet = string | Record<string, 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;
-    code: string | null;
-    url: string | null;
-    severity: Severity | null;
-    sourceLocations?: SourceLabel[];
-    related?: DetailedError[];
-}
+export type CheckParseResult = { type: "success" } | { type: "error"; errors: string[] };
 
 export type ValidationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; validationErrors: ValidationError[]; validationWarnings: ValidationError[]; otherWarnings: DetailedError[] };
 
@@ -167,6 +142,31 @@ export interface Response {
     diagnostics: Diagnostics;
 }
 
+export type Schema = { human: string } | { json: SchemaJson };
+
+export type PolicySet = string | Record<string, 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;
+    code: string | null;
+    url: string | null;
+    severity: Severity | null;
+    sourceLocations?: SourceLabel[];
+    related?: DetailedError[];
+}
+
 export type SchemaTypeVariant = { type: "String" } | { type: "Long" } | { type: "Boolean" } | { type: "Set"; element: SchemaType } | { type: "Record"; attributes: Record<SmolStr, TypeOfAttribute>; additionalAttributes: boolean } | { type: "Entity"; name: Name } | { type: "Extension"; name: Id };
 
 export type SchemaType = SchemaTypeVariant | { type: Name };
@@ -203,23 +203,28 @@ export interface NamespaceDefinition {
 
 export type SchemaJson = Record<string, NamespaceDefinition>;
 
-export type EntityUidJson = { __expr: string } | { __entity: TypeAndId } | TypeAndId;
+export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
 
-export interface FnAndArg {
-    fn: string;
-    arg: CedarValueJson;
+export interface PrincipalOrResourceIsConstraint {
+    entity_type: string;
+    in?: PrincipalOrResourceInConstraint;
 }
 
-export interface TypeAndId {
-    type: string;
-    id: string;
-}
+export type PrincipalOrResourceInConstraint = { entity: EntityUidJson } | { slot: string };
 
-export type CedarValueJson = { __expr: string } | { __entity: TypeAndId } | { __extn: FnAndArg } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
+export type EqConstraint = { entity: EntityUidJson } | { slot: string };
 
-export type Var = "principal" | "action" | "resource" | "context";
+export type ResourceConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
 
-export type Effect = "permit" | "forbid";
+export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+
+export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+
+export interface EntityJson {
+    uid: EntityUidJson;
+    attrs: Record<string, CedarValueJson>;
+    parents: EntityUidJson[];
+}
 
 export type Clause = { kind: "when"; body: Expr } | { kind: "unless"; body: Expr };
 
@@ -232,30 +237,23 @@ export interface Policy {
     annotations?: Record<string, string>;
 }
 
-export interface EntityJson {
-    uid: EntityUidJson;
-    attrs: Record<string, CedarValueJson>;
-    parents: EntityUidJson[];
-}
-
-export type Decision = "Allow" | "Deny";
+export type Effect = "permit" | "forbid";
 
-export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
+export type EntityUidJson = { __expr: string } | { __entity: TypeAndId } | TypeAndId;
 
-export interface PrincipalOrResourceIsConstraint {
-    entity_type: string;
-    in?: PrincipalOrResourceInConstraint;
+export interface FnAndArg {
+    fn: string;
+    arg: CedarValueJson;
 }
 
-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 interface TypeAndId {
+    type: string;
+    id: string;
+}
 
-export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+export type CedarValueJson = { __expr: string } | { __entity: TypeAndId } | { __extn: FnAndArg } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
 
-export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+export type Decision = "Allow" | "Deny";
 
 export type ExtFuncCall = {} & Record<string, Array<Expr>>;
 
@@ -263,6 +261,8 @@ export type ExprNoExt = { Value: CedarValueJson } | { Var: Var } | { Slot: strin
 
 export type Expr = ExprNoExt | ExtFuncCall;
 
+export type Var = "principal" | "action" | "resource" | "context";
+
 type SmolStr = string;
 type Name = string;
 type Id = string;

package/nodejs/cedar_wasm.js

@@ -162,6 +162,19 @@ module.exports.checkParseTemplate = function(template_str) {
     return takeObject(ret);
 };
 
+/**
+* @param {string} policies_str
+* @param {number} line_width
+* @param {number} indent_width
+* @returns {FormattingResult}
+*/
+module.exports.formatPolicies = function(policies_str, line_width, indent_width) {
+    const ptr0 = passStringToWasm0(policies_str, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.formatPolicies(ptr0, len0, line_width, indent_width);
+    return takeObject(ret);
+};
+
 /**
 * @param {string} input_schema
 * @returns {CheckParseResult}
@@ -205,15 +218,20 @@ module.exports.checkParseContext = function(context_str, action_str, schema_str)
 };
 
 /**
-* @param {string} policies_str
-* @param {number} line_width
-* @param {number} indent_width
-* @returns {FormattingResult}
+* @param {AuthorizationCall} call
+* @returns {AuthorizationAnswer}
 */
-module.exports.formatPolicies = function(policies_str, line_width, indent_width) {
-    const ptr0 = passStringToWasm0(policies_str, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-    const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.formatPolicies(ptr0, len0, line_width, indent_width);
+module.exports.isAuthorized = function(call) {
+    const ret = wasm.isAuthorized(addHeapObject(call));
+    return takeObject(ret);
+};
+
+/**
+* @param {ValidationCall} call
+* @returns {ValidationAnswer}
+*/
+module.exports.validate = function(call) {
+    const ret = wasm.validate(addHeapObject(call));
     return takeObject(ret);
 };
 
@@ -237,24 +255,6 @@ module.exports.getCedarVersion = function() {
     }
 };
 
-/**
-* @param {AuthorizationCall} call
-* @returns {AuthorizationAnswer}
-*/
-module.exports.isAuthorized = function(call) {
-    const ret = wasm.isAuthorized(addHeapObject(call));
-    return takeObject(ret);
-};
-
-/**
-* @param {ValidationCall} call
-* @returns {ValidationAnswer}
-*/
-module.exports.validate = function(call) {
-    const ret = wasm.validate(addHeapObject(call));
-    return takeObject(ret);
-};
-
 function handleError(f, args) {
     try {
         return f.apply(this, args);

package/nodejs/cedar_wasm_bg.wasm.d.ts

@@ -5,13 +5,13 @@ export function policyTextFromJson(a: number, b: number): number;
 export function policyTextToJson(a: number, b: number): number;
 export function checkParsePolicySet(a: number, b: number): number;
 export function checkParseTemplate(a: number, b: number): number;
+export function formatPolicies(a: number, b: number, c: number, d: number): number;
 export function checkParseSchema(a: number, b: number): number;
 export function checkParseEntities(a: number, b: number, c: number, d: number): number;
 export function checkParseContext(a: number, b: number, c: number, d: number, e: number, f: number): number;
-export function formatPolicies(a: number, b: number, c: number, d: number): number;
-export function getCedarVersion(a: number): void;
 export function isAuthorized(a: number): number;
 export function validate(a: number): number;
+export function getCedarVersion(a: number): void;
 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;

package/nodejs/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@cedar-policy/cedar-wasm",
   "description": "Wasm bindings and typescript types for Cedar lib",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "license": "Apache-2.0",
   "files": [
     "cedar_wasm_bg.wasm",
-    "cedar_wasm_bg.wasm.d.ts",
     "cedar_wasm.js",
     "cedar_wasm.d.ts"
   ],

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cedar-policy/cedar-wasm",
   "description": "Wasm bindings and typescript types for Cedar lib",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "license": "Apache-2.0",
   "files": [
     "esm/package.json",
@@ -31,16 +31,16 @@
   ],
   "exports": {
     ".": {
-      "import": "esm/cedar_wasm.js",
-      "types": "esm/cedar_wasm.d.ts"
+      "import": "./esm/cedar_wasm.js",
+      "types": "./esm/cedar_wasm.d.ts"
     },
     "./nodejs": {
-      "import": "nodejs/cedar_wasm.js",
-      "types": "nodejs/cedar_wasm.d.ts"
+      "require": "./nodejs/cedar_wasm.js",
+      "types": "./nodejs/cedar_wasm.d.ts"
     },
     "./web": {
-      "import": "web/cedar_wasm.js",
-      "types": "web/cedar_wasm.d.ts"
+      "import": "./web/cedar_wasm.js",
+      "types": "./web/cedar_wasm.d.ts"
     }
   }
 }

package/web/README.md

@@ -6,6 +6,33 @@ An implementation of various cedar functions to enable developers to write types
 
 Installing is simple, just run `npm i @cedar-policy/cedar-wasm --save` or install with whatever your favorite package manager is.
 
+Loading is much more complicated. It depends on your environment. We offer three subpackages:
+
+* es modules (default). It loads wasm in a way that will be bundled into a single file if you use dynamic imports, or embedded into your main bundle if you use regular imports.
+* commonjs (for node). It loads wasm using node's `fs` module, synchronously. Not really designed for bundling or shipping to the browser.
+* web: more customizable. This one is for when you need to load the wasm in some totally custom way. More details in the "alternate loading strategies" section.
+
+These sub-packages are named `@cedar-policy/cedar-wasm`, `@cedar-policy/cedar-wasm/nodejs`, and `@cedar-policy/cedar-wasm/web`, respectively.
+
+## Loading in bare nodeJs without a bundler
+
+Node uses CommonJs so you have to import with require, or with dynamic `import()`. 
+
+Importing the CJS export:
+
+```
+const cedar = require('@cedar-policy/cedar-wasm/nodejs');
+console.log(cedar.getCedarVersion());
+```
+
+Importing the esm version using esm async import:
+
+```
+import('@cedar-policy/cedar-wasm')
+  .then(cedar => console.log(cedar.getCedarVersion()));
+```
+
+
 ## Loading in webpack 5:
 
 Minimal package.json for webpack including dev server:
@@ -32,7 +59,8 @@ Minimal package.json for webpack including dev server:
     "typescript": "^5.4.5",
     "webpack": "^5.91.0",
     "webpack-cli": "^5.1.4",
-    "webpack-dev-server": "^5.0.4"
+    "webpack-dev-server": "^5.0.4",
+    "html-webpack-plugin": "^5.6.0"
   }
 }
 ```
@@ -57,6 +85,7 @@ Configure webpack.config.js:
 
 ```
 const path = require('path');
+const HtmlWebpackPlugin = require('html-webpack-plugin');
 
 module.exports = { 
   mode: 'development', // change this to suit you
@@ -79,7 +108,8 @@ module.exports = {
   },  
   experiments: {
     asyncWebAssembly: true, // enables wasm support in webpack
-  },  
+  },
+  plugins: [new HtmlWebpackPlugin()],
   devServer: {
     static: {
       directory: path.join(__dirname, 'dist'),

package/web/cedar_wasm.d.ts

@@ -21,6 +21,13 @@ export function checkParsePolicySet(input_policies_str: string): CheckParsePolic
 */
 export function checkParseTemplate(template_str: string): CheckParseTemplateResult;
 /**
+* @param {string} policies_str
+* @param {number} line_width
+* @param {number} indent_width
+* @returns {FormattingResult}
+*/
+export function formatPolicies(policies_str: string, line_width: number, indent_width: number): FormattingResult;
+/**
 * @param {string} input_schema
 * @returns {CheckParseResult}
 */
@@ -39,17 +46,6 @@ export function checkParseEntities(entities_str: string, schema_str: string): Ch
 */
 export function checkParseContext(context_str: string, action_str: string, schema_str: string): CheckParseResult;
 /**
-* @param {string} policies_str
-* @param {number} line_width
-* @param {number} indent_width
-* @returns {FormattingResult}
-*/
-export function formatPolicies(policies_str: string, line_width: number, indent_width: number): FormattingResult;
-/**
-* @returns {string}
-*/
-export function getCedarVersion(): string;
-/**
 * @param {AuthorizationCall} call
 * @returns {AuthorizationAnswer}
 */
@@ -59,6 +55,10 @@ export function isAuthorized(call: AuthorizationCall): AuthorizationAnswer;
 * @returns {ValidationAnswer}
 */
 export function validate(call: ValidationCall): ValidationAnswer;
+/**
+* @returns {string}
+*/
+export function getCedarVersion(): string;
 export type JsonToPolicyResult = { type: "success"; policyText: string } | { type: "error"; errors: string[] };
 
 export type PolicyToJsonResult = { type: "success"; policy: Policy } | { type: "error"; errors: string[] };
@@ -67,34 +67,9 @@ export type CheckParsePolicySetResult = { type: "success"; policies: number; tem
 
 export type CheckParseTemplateResult = { type: "success"; slots: string[] } | { type: "error"; errors: string[] };
 
-export type CheckParseResult = { type: "success" } | { type: "error"; errors: string[] };
-
 export type FormattingResult = { type: "success"; formatted_policy: string } | { type: "error"; errors: string[] };
 
-export type Schema = { human: string } | { json: SchemaJson };
-
-export type PolicySet = string | Record<string, 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;
-    code: string | null;
-    url: string | null;
-    severity: Severity | null;
-    sourceLocations?: SourceLabel[];
-    related?: DetailedError[];
-}
+export type CheckParseResult = { type: "success" } | { type: "error"; errors: string[] };
 
 export type ValidationAnswer = { type: "failure"; errors: DetailedError[]; warnings: DetailedError[] } | { type: "success"; validationErrors: ValidationError[]; validationWarnings: ValidationError[]; otherWarnings: DetailedError[] };
 
@@ -167,6 +142,31 @@ export interface Response {
     diagnostics: Diagnostics;
 }
 
+export type Schema = { human: string } | { json: SchemaJson };
+
+export type PolicySet = string | Record<string, 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;
+    code: string | null;
+    url: string | null;
+    severity: Severity | null;
+    sourceLocations?: SourceLabel[];
+    related?: DetailedError[];
+}
+
 export type SchemaTypeVariant = { type: "String" } | { type: "Long" } | { type: "Boolean" } | { type: "Set"; element: SchemaType } | { type: "Record"; attributes: Record<SmolStr, TypeOfAttribute>; additionalAttributes: boolean } | { type: "Entity"; name: Name } | { type: "Extension"; name: Id };
 
 export type SchemaType = SchemaTypeVariant | { type: Name };
@@ -203,23 +203,28 @@ export interface NamespaceDefinition {
 
 export type SchemaJson = Record<string, NamespaceDefinition>;
 
-export type EntityUidJson = { __expr: string } | { __entity: TypeAndId } | TypeAndId;
+export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
 
-export interface FnAndArg {
-    fn: string;
-    arg: CedarValueJson;
+export interface PrincipalOrResourceIsConstraint {
+    entity_type: string;
+    in?: PrincipalOrResourceInConstraint;
 }
 
-export interface TypeAndId {
-    type: string;
-    id: string;
-}
+export type PrincipalOrResourceInConstraint = { entity: EntityUidJson } | { slot: string };
 
-export type CedarValueJson = { __expr: string } | { __entity: TypeAndId } | { __extn: FnAndArg } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
+export type EqConstraint = { entity: EntityUidJson } | { slot: string };
 
-export type Var = "principal" | "action" | "resource" | "context";
+export type ResourceConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
 
-export type Effect = "permit" | "forbid";
+export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+
+export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+
+export interface EntityJson {
+    uid: EntityUidJson;
+    attrs: Record<string, CedarValueJson>;
+    parents: EntityUidJson[];
+}
 
 export type Clause = { kind: "when"; body: Expr } | { kind: "unless"; body: Expr };
 
@@ -232,30 +237,23 @@ export interface Policy {
     annotations?: Record<string, string>;
 }
 
-export interface EntityJson {
-    uid: EntityUidJson;
-    attrs: Record<string, CedarValueJson>;
-    parents: EntityUidJson[];
-}
-
-export type Decision = "Allow" | "Deny";
+export type Effect = "permit" | "forbid";
 
-export type ActionInConstraint = { entity: EntityUidJson } | { entities: EntityUidJson[] };
+export type EntityUidJson = { __expr: string } | { __entity: TypeAndId } | TypeAndId;
 
-export interface PrincipalOrResourceIsConstraint {
-    entity_type: string;
-    in?: PrincipalOrResourceInConstraint;
+export interface FnAndArg {
+    fn: string;
+    arg: CedarValueJson;
 }
 
-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 interface TypeAndId {
+    type: string;
+    id: string;
+}
 
-export type ActionConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & ActionInConstraint);
+export type CedarValueJson = { __expr: string } | { __entity: TypeAndId } | { __extn: FnAndArg } | boolean | number | string | CedarValueJson[] | { [key: string]: CedarValueJson } | null;
 
-export type PrincipalConstraint = { op: "All" } | ({ op: "==" } & EqConstraint) | ({ op: "in" } & PrincipalOrResourceInConstraint) | ({ op: "is" } & PrincipalOrResourceIsConstraint);
+export type Decision = "Allow" | "Deny";
 
 export type ExtFuncCall = {} & Record<string, Array<Expr>>;
 
@@ -263,6 +261,8 @@ export type ExprNoExt = { Value: CedarValueJson } | { Var: Var } | { Slot: strin
 
 export type Expr = ExprNoExt | ExtFuncCall;
 
+export type Var = "principal" | "action" | "resource" | "context";
+
 
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
@@ -272,13 +272,13 @@ export interface InitOutput {
   readonly policyTextToJson: (a: number, b: number) => number;
   readonly checkParsePolicySet: (a: number, b: number) => number;
   readonly checkParseTemplate: (a: number, b: number) => number;
+  readonly formatPolicies: (a: number, b: number, c: number, d: number) => number;
   readonly checkParseSchema: (a: number, b: number) => number;
   readonly checkParseEntities: (a: number, b: number, c: number, d: number) => number;
   readonly checkParseContext: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
-  readonly formatPolicies: (a: number, b: number, c: number, d: number) => number;
-  readonly getCedarVersion: (a: number) => void;
   readonly isAuthorized: (a: number) => number;
   readonly validate: (a: number) => number;
+  readonly getCedarVersion: (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;

package/web/cedar_wasm.js

@@ -159,6 +159,19 @@ export function checkParseTemplate(template_str) {
     return takeObject(ret);
 }
 
+/**
+* @param {string} policies_str
+* @param {number} line_width
+* @param {number} indent_width
+* @returns {FormattingResult}
+*/
+export function formatPolicies(policies_str, line_width, indent_width) {
+    const ptr0 = passStringToWasm0(policies_str, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.formatPolicies(ptr0, len0, line_width, indent_width);
+    return takeObject(ret);
+}
+
 /**
 * @param {string} input_schema
 * @returns {CheckParseResult}
@@ -202,15 +215,20 @@ export function checkParseContext(context_str, action_str, schema_str) {
 }
 
 /**
-* @param {string} policies_str
-* @param {number} line_width
-* @param {number} indent_width
-* @returns {FormattingResult}
+* @param {AuthorizationCall} call
+* @returns {AuthorizationAnswer}
 */
-export function formatPolicies(policies_str, line_width, indent_width) {
-    const ptr0 = passStringToWasm0(policies_str, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-    const len0 = WASM_VECTOR_LEN;
-    const ret = wasm.formatPolicies(ptr0, len0, line_width, indent_width);
+export function isAuthorized(call) {
+    const ret = wasm.isAuthorized(addHeapObject(call));
+    return takeObject(ret);
+}
+
+/**
+* @param {ValidationCall} call
+* @returns {ValidationAnswer}
+*/
+export function validate(call) {
+    const ret = wasm.validate(addHeapObject(call));
     return takeObject(ret);
 }
 
@@ -234,24 +252,6 @@ export function getCedarVersion() {
     }
 }
 
-/**
-* @param {AuthorizationCall} call
-* @returns {AuthorizationAnswer}
-*/
-export function isAuthorized(call) {
-    const ret = wasm.isAuthorized(addHeapObject(call));
-    return takeObject(ret);
-}
-
-/**
-* @param {ValidationCall} call
-* @returns {ValidationAnswer}
-*/
-export function validate(call) {
-    const ret = wasm.validate(addHeapObject(call));
-    return takeObject(ret);
-}
-
 function handleError(f, args) {
     try {
         return f.apply(this, args);

package/web/cedar_wasm_bg.wasm.d.ts

@@ -5,13 +5,13 @@ export function policyTextFromJson(a: number, b: number): number;
 export function policyTextToJson(a: number, b: number): number;
 export function checkParsePolicySet(a: number, b: number): number;
 export function checkParseTemplate(a: number, b: number): number;
+export function formatPolicies(a: number, b: number, c: number, d: number): number;
 export function checkParseSchema(a: number, b: number): number;
 export function checkParseEntities(a: number, b: number, c: number, d: number): number;
 export function checkParseContext(a: number, b: number, c: number, d: number, e: number, f: number): number;
-export function formatPolicies(a: number, b: number, c: number, d: number): number;
-export function getCedarVersion(a: number): void;
 export function isAuthorized(a: number): number;
 export function validate(a: number): number;
+export function getCedarVersion(a: number): void;
 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;

package/web/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@cedar-policy/cedar-wasm",
   "description": "Wasm bindings and typescript types for Cedar lib",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "license": "Apache-2.0",
   "files": [
     "cedar_wasm_bg.wasm",
-    "cedar_wasm_bg.wasm.d.ts",
     "cedar_wasm.js",
     "cedar_wasm.d.ts"
   ],