jurist 0.0.8 → 0.0.10

package/README.md

@@ -14,32 +14,32 @@ With Jurist, permissions are expressed in a tree structure.
 
 ```typescript
 // my-authorization.ts
-import { Laws, optional, required } from "jurist";
+import { Laws, optional, required } from "jurist"
 
 const authorization = new Laws({
-  roles: ["suspended", "free", "premium"],
-  permissions: required({
-    create: optional({
-      document: required({
-        "<=5": optional({ "<=5000": null }),
-        shareDocuments: null,
-      }),
-    }),
-  }),
-  rolePermissions: {
-    suspended: new Set([]),
-    free: new Set([
-      /* a granted  permission grants all preceding permissions, e.g., 
+	roles: ["suspended", "free", "premium"],
+	permissions: required({
+		create: optional({
+			document: required({
+				"<=5": optional({ "<=5000": null }),
+				shareDocuments: null,
+			}),
+		}),
+	}),
+	rolePermissions: {
+		suspended: new Set([]),
+		free: new Set([
+			/* a granted  permission grants all preceding permissions, e.g.,
       "create"
       "create_documents" */
-      "create_documents_<=5",
-    ]),
-    premium: new Set([
-      "create_documents_<=5_<=5000",
-      "create_documents_shareDocuments",
-    ]),
-  },
-});
+			"create_documents_<=5",
+		]),
+		premium: new Set([
+			"create_documents_<=5_<=5000",
+			"create_documents_shareDocuments",
+		]),
+	},
+})
 ```
 
 The idea here is that some permissions must logically follow from other permissions. In other words, the `create_documents_<=5` permission is a prerequisite for the `create_documents_<=5_<=5000` permission, because if you are allowed to create 5,000 documents, you are logically allowed to create 5 documents in the first place.
@@ -48,24 +48,24 @@ This makes authorization checks easier, safer, and more explicit.
 
 ```typescript
 // routes.ts
-import { Roles } from "jurist";
+import { Roles } from "jurist"
 
-import { authorization } from "./my-authorization";
-import { app } from "./my-hono-like-app";
+import { authorization } from "./my-authorization"
+import { app } from "./my-hono-like-app"
 
-type Role = Roles<typeof authorization>; // "free" | "premium" | "suspended"
+type Role = Roles<typeof authorization> // "free" | "premium" | "suspended"
 
 type User = {
-  id: string;
-  role: Role;
-};
+	id: string
+	role: Role
+}
 
 app.post("/api/v1/resources", async (c) => {
-  const { user /* { id: "123-456", role: "free" } */ } = c.get("user");
-  /* ✅ true  */ authorization.check(user.role, "create");
-  /* ✅ true  */ authorization.check(user.role, "create_documents_<=5");
-  /* ❌ false */ authorization.check(user.role, "create_documents_<=5_<=5000");
-});
+	const { user /* { id: "123-456", role: "free" } */ } = c.get("user")
+	/* ✅ true  */ authorization.check(user.role, "create")
+	/* ✅ true  */ authorization.check(user.role, "create_documents_<=5")
+	/* ❌ false */ authorization.check(user.role, "create_documents_<=5_<=5000")
+})
 ```
 
 Here, we can see that a free user has permission to create a resource, and has permission to own up to 5 documents, but they cannot own up to 5,000 documents like a premium user.

package/dist/jurist.js

@@ -1,5 +1,4 @@
-export * from "treetrunks"
-
+export * from "treetrunks";
 //#region src/jurist.ts
 var Laws = class {
 	roles;
@@ -64,7 +63,7 @@ function fromEntries(entries) {
 function toEntries(obj) {
 	return Object.entries(obj);
 }
-
 //#endregion
 export { Escalator, Laws };
+
 //# sourceMappingURL=jurist.js.map

package/dist/jurist.js.map

@@ -1 +1 @@
-{"version":3,"file":"jurist.js","names":[],"sources":["../src/jurist.ts"],"sourcesContent":["import type { Join, Tree, TreePathName } from \"treetrunks\"\n\nexport * from \"treetrunks\"\n\nexport type Roles<L extends Laws<any, any, any, any>> =\n\tL extends Laws<infer Role, any, any, any> ? Role : never\n\nexport type Permissions<L extends Laws<any, any, any, any>> =\n\tL extends Laws<any, any, infer Permission, any> ? Permission : never\n\nexport type PermissionData<L extends Laws<any, any, any, any>, D> = Entries<\n\tPermissions<L>,\n\tD\n>\n\nexport class Laws<\n\tRole extends string,\n\tPermissionTree extends Tree,\n\tPermission extends Join<TreePathName<PermissionTree>, `_`>,\n\tRolePermissions extends { [r in Role]: ReadonlySet<Permission> },\n> {\n\tpublic readonly roles: Role[]\n\tpublic readonly permissionTree: PermissionTree\n\tpublic readonly rolePermissions: RolePermissions\n\tprotected readonly decompressedRolePermissions: {\n\t\t[r in Role]: ReadonlySet<string>\n\t}\n\n\tpublic constructor(options: {\n\t\troles: Role[]\n\t\tpermissions: PermissionTree\n\t\trolePermissions: RolePermissions\n\t}) {\n\t\tconst { roles, permissions, rolePermissions } = options\n\t\tthis.roles = roles\n\t\tthis.permissionTree = permissions\n\t\tthis.rolePermissions = rolePermissions\n\t\tthis.decompressedRolePermissions = fromEntries(\n\t\t\ttoEntries<RolePermissions>(rolePermissions).map(\n\t\t\t\t([role, permissionsOfRole]) => [\n\t\t\t\t\trole,\n\t\t\t\t\tdecompressRolePermissions(permissionsOfRole),\n\t\t\t\t],\n\t\t\t),\n\t\t)\n\t}\n\n\tpublic check(role: Role, permission: Permission): boolean {\n\t\treturn this.decompressedRolePermissions[role].has(permission)\n\t}\n}\n\nfunction decompressRolePermissions(\n\tpermissionSet: ReadonlySet<string>,\n): ReadonlySet<string> {\n\tconst decompressed = new Set<string>(permissionSet)\n\tfor (const permission of permissionSet) {\n\t\tconst preconditions = permission.split(`_`)\n\t\tfor (let i = 0; i < preconditions.length - 1; i++) {\n\t\t\tconst subPermission = preconditions.slice(0, i + 1).join(`_`)\n\t\t\tdecompressed.add(subPermission)\n\t\t}\n\t}\n\treturn decompressed\n}\n\nexport type EscalatorStyle = `firstFound` | `lastFound` | `untilMiss`\nexport class Escalator<\n\tS extends EscalatorStyle,\n\tL extends Laws<any, any, any, any>,\n\tP extends PermissionData<L, any>,\n\tD extends P extends PermissionData<L, infer d> ? d : never,\n\tF,\n> {\n\tpublic readonly style: S\n\tpublic readonly laws: L\n\tpublic readonly permissionData: P\n\tpublic readonly fallback: F\n\tpublic constructor(\n\t\toptions: Readonly<{\n\t\t\tstyle: S\n\t\t\tlaws: L\n\t\t\tpermissionData: P\n\t\t\tfallback: F\n\t\t}>,\n\t) {\n\t\tconst { style, laws, permissionData, fallback } = options\n\t\tthis.style = style\n\t\tthis.laws = laws\n\t\tthis.permissionData = permissionData\n\t\tthis.fallback = fallback\n\t}\n\n\tpublic get(role: Roles<L>): D | F {\n\t\tlet result: D | F = this.fallback\n\t\tfor (const [permission, data] of this.permissionData) {\n\t\t\tconst hasPermission = this.laws.check(role, permission)\n\t\t\tswitch (this.style) {\n\t\t\t\tcase `firstFound`:\n\t\t\t\t\tif (hasPermission) return data\n\t\t\t\t\tbreak\n\t\t\t\tcase `lastFound`:\n\t\t\t\t\tif (hasPermission) result = data\n\t\t\t\t\tbreak\n\t\t\t\tcase `untilMiss`:\n\t\t\t\t\tif (hasPermission) result = data\n\t\t\t\t\telse return result\n\t\t\t}\n\t\t}\n\t\treturn result\n\t}\n}\n\ntype Flat<R extends { [K in PropertyKey]: any }> = {\n\t[K in keyof R]: R[K]\n}\n\nexport type Count<N extends number, A extends any[] = []> = [\n\t...A,\n\tany,\n][`length`] extends N\n\t? A[`length`]\n\t: A[`length`] | Count<N, [...A, any]>\n\ntype Entries<K extends PropertyKey = PropertyKey, V = any> = [K, V][]\n\ntype KeyOfEntries<E extends Entries> = E extends [infer K, any][] ? K : never\n\ntype ValueOfEntry<E extends Entries, K extends KeyOfEntries<E>> = {\n\t[P in Count<E[`length`]>]: E[P] extends [K, infer V] ? V : never\n}[Count<E[`length`]>]\n\ntype FromEntries<E extends Entries> = Flat<{\n\t[K in KeyOfEntries<E>]: ValueOfEntry<E, K>\n}>\n\nfunction fromEntries<E extends Entries>(entries: E): FromEntries<E> {\n\treturn Object.fromEntries(entries) as FromEntries<E>\n}\n\nfunction toEntries<T extends object>(obj: T): Entries<keyof T, T[keyof T]> {\n\treturn Object.entries(obj) as Entries<keyof T, T[keyof T]>\n}\n"],"mappings":";;;AAeA,IAAa,OAAb,MAKE;CACD,AAAgB;CAChB,AAAgB;CAChB,AAAgB;CAChB,AAAmB;CAInB,AAAO,YAAY,SAIhB;EACF,MAAM,EAAE,OAAO,aAAa,oBAAoB;AAChD,OAAK,QAAQ;AACb,OAAK,iBAAiB;AACtB,OAAK,kBAAkB;AACvB,OAAK,8BAA8B,YAClC,UAA2B,gBAAgB,CAAC,KAC1C,CAAC,MAAM,uBAAuB,CAC9B,MACA,0BAA0B,kBAAkB,CAC5C,CACD,CACD;;CAGF,AAAO,MAAM,MAAY,YAAiC;AACzD,SAAO,KAAK,4BAA4B,MAAM,IAAI,WAAW;;;AAI/D,SAAS,0BACR,eACsB;CACtB,MAAM,eAAe,IAAI,IAAY,cAAc;AACnD,MAAK,MAAM,cAAc,eAAe;EACvC,MAAM,gBAAgB,WAAW,MAAM,IAAI;AAC3C,OAAK,IAAI,IAAI,GAAG,IAAI,cAAc,SAAS,GAAG,KAAK;GAClD,MAAM,gBAAgB,cAAc,MAAM,GAAG,IAAI,EAAE,CAAC,KAAK,IAAI;AAC7D,gBAAa,IAAI,cAAc;;;AAGjC,QAAO;;AAIR,IAAa,YAAb,MAME;CACD,AAAgB;CAChB,AAAgB;CAChB,AAAgB;CAChB,AAAgB;CAChB,AAAO,YACN,SAMC;EACD,MAAM,EAAE,OAAO,MAAM,gBAAgB,aAAa;AAClD,OAAK,QAAQ;AACb,OAAK,OAAO;AACZ,OAAK,iBAAiB;AACtB,OAAK,WAAW;;CAGjB,AAAO,IAAI,MAAuB;EACjC,IAAI,SAAgB,KAAK;AACzB,OAAK,MAAM,CAAC,YAAY,SAAS,KAAK,gBAAgB;GACrD,MAAM,gBAAgB,KAAK,KAAK,MAAM,MAAM,WAAW;AACvD,WAAQ,KAAK,OAAb;IACC,KAAK;AACJ,SAAI,cAAe,QAAO;AAC1B;IACD,KAAK;AACJ,SAAI,cAAe,UAAS;AAC5B;IACD,KAAK,YACJ,KAAI,cAAe,UAAS;QACvB,QAAO;;;AAGf,SAAO;;;AA2BT,SAAS,YAA+B,SAA4B;AACnE,QAAO,OAAO,YAAY,QAAQ;;AAGnC,SAAS,UAA4B,KAAsC;AAC1E,QAAO,OAAO,QAAQ,IAAI"}
+{"version":3,"file":"jurist.js","names":[],"sources":["../src/jurist.ts"],"sourcesContent":["import type { Join, Tree, TreePathName } from \"treetrunks\"\n\nexport * from \"treetrunks\"\n\nexport type Roles<L extends Laws<any, any, any, any>> =\n\tL extends Laws<infer Role, any, any, any> ? Role : never\n\nexport type Permissions<L extends Laws<any, any, any, any>> =\n\tL extends Laws<any, any, infer Permission, any> ? Permission : never\n\nexport type PermissionData<L extends Laws<any, any, any, any>, D> = Entries<\n\tPermissions<L>,\n\tD\n>\n\nexport class Laws<\n\tRole extends string,\n\tPermissionTree extends Tree,\n\tPermission extends Join<TreePathName<PermissionTree>, `_`>,\n\tRolePermissions extends { [r in Role]: ReadonlySet<Permission> },\n> {\n\tpublic readonly roles: Role[]\n\tpublic readonly permissionTree: PermissionTree\n\tpublic readonly rolePermissions: RolePermissions\n\tprotected readonly decompressedRolePermissions: {\n\t\t[r in Role]: ReadonlySet<string>\n\t}\n\n\tpublic constructor(options: {\n\t\troles: Role[]\n\t\tpermissions: PermissionTree\n\t\trolePermissions: RolePermissions\n\t}) {\n\t\tconst { roles, permissions, rolePermissions } = options\n\t\tthis.roles = roles\n\t\tthis.permissionTree = permissions\n\t\tthis.rolePermissions = rolePermissions\n\t\tthis.decompressedRolePermissions = fromEntries(\n\t\t\ttoEntries<RolePermissions>(rolePermissions).map(\n\t\t\t\t([role, permissionsOfRole]) => [\n\t\t\t\t\trole,\n\t\t\t\t\tdecompressRolePermissions(permissionsOfRole),\n\t\t\t\t],\n\t\t\t),\n\t\t)\n\t}\n\n\tpublic check(role: Role, permission: Permission): boolean {\n\t\treturn this.decompressedRolePermissions[role].has(permission)\n\t}\n}\n\nfunction decompressRolePermissions(\n\tpermissionSet: ReadonlySet<string>,\n): ReadonlySet<string> {\n\tconst decompressed = new Set<string>(permissionSet)\n\tfor (const permission of permissionSet) {\n\t\tconst preconditions = permission.split(`_`)\n\t\tfor (let i = 0; i < preconditions.length - 1; i++) {\n\t\t\tconst subPermission = preconditions.slice(0, i + 1).join(`_`)\n\t\t\tdecompressed.add(subPermission)\n\t\t}\n\t}\n\treturn decompressed\n}\n\nexport type EscalatorStyle = `firstFound` | `lastFound` | `untilMiss`\nexport class Escalator<\n\tS extends EscalatorStyle,\n\tL extends Laws<any, any, any, any>,\n\tP extends PermissionData<L, any>,\n\tD extends P extends PermissionData<L, infer d> ? d : never,\n\tF,\n> {\n\tpublic readonly style: S\n\tpublic readonly laws: L\n\tpublic readonly permissionData: P\n\tpublic readonly fallback: F\n\tpublic constructor(\n\t\toptions: Readonly<{\n\t\t\tstyle: S\n\t\t\tlaws: L\n\t\t\tpermissionData: P\n\t\t\tfallback: F\n\t\t}>,\n\t) {\n\t\tconst { style, laws, permissionData, fallback } = options\n\t\tthis.style = style\n\t\tthis.laws = laws\n\t\tthis.permissionData = permissionData\n\t\tthis.fallback = fallback\n\t}\n\n\tpublic get(role: Roles<L>): D | F {\n\t\tlet result: D | F = this.fallback\n\t\tfor (const [permission, data] of this.permissionData) {\n\t\t\tconst hasPermission = this.laws.check(role, permission)\n\t\t\tswitch (this.style) {\n\t\t\t\tcase `firstFound`:\n\t\t\t\t\tif (hasPermission) return data\n\t\t\t\t\tbreak\n\t\t\t\tcase `lastFound`:\n\t\t\t\t\tif (hasPermission) result = data\n\t\t\t\t\tbreak\n\t\t\t\tcase `untilMiss`:\n\t\t\t\t\tif (hasPermission) result = data\n\t\t\t\t\telse return result\n\t\t\t}\n\t\t}\n\t\treturn result\n\t}\n}\n\ntype Flat<R extends { [K in PropertyKey]: any }> = {\n\t[K in keyof R]: R[K]\n}\n\nexport type Count<N extends number, A extends any[] = []> = [\n\t...A,\n\tany,\n][`length`] extends N\n\t? A[`length`]\n\t: A[`length`] | Count<N, [...A, any]>\n\ntype Entries<K extends PropertyKey = PropertyKey, V = any> = [K, V][]\n\ntype KeyOfEntries<E extends Entries> = E extends [infer K, any][] ? K : never\n\ntype ValueOfEntry<E extends Entries, K extends KeyOfEntries<E>> = {\n\t[P in Count<E[`length`]>]: E[P] extends [K, infer V] ? V : never\n}[Count<E[`length`]>]\n\ntype FromEntries<E extends Entries> = Flat<{\n\t[K in KeyOfEntries<E>]: ValueOfEntry<E, K>\n}>\n\nfunction fromEntries<E extends Entries>(entries: E): FromEntries<E> {\n\treturn Object.fromEntries(entries) as FromEntries<E>\n}\n\nfunction toEntries<T extends object>(obj: T): Entries<keyof T, T[keyof T]> {\n\treturn Object.entries(obj) as Entries<keyof T, T[keyof T]>\n}\n"],"mappings":";;AAeA,IAAa,OAAb,MAKE;CACD;CACA;CACA;CACA;CAIA,YAAmB,SAIhB;EACF,MAAM,EAAE,OAAO,aAAa,oBAAoB;EAChD,KAAK,QAAQ;EACb,KAAK,iBAAiB;EACtB,KAAK,kBAAkB;EACvB,KAAK,8BAA8B,YAClC,UAA2B,eAAe,CAAC,CAAC,KAC1C,CAAC,MAAM,uBAAuB,CAC9B,MACA,0BAA0B,iBAAiB,CAC5C,CACD,CACD;CACD;CAEA,MAAa,MAAY,YAAiC;EACzD,OAAO,KAAK,4BAA4B,KAAK,CAAC,IAAI,UAAU;CAC7D;AACD;AAEA,SAAS,0BACR,eACsB;CACtB,MAAM,eAAe,IAAI,IAAY,aAAa;CAClD,KAAK,MAAM,cAAc,eAAe;EACvC,MAAM,gBAAgB,WAAW,MAAM,GAAG;EAC1C,KAAK,IAAI,IAAI,GAAG,IAAI,cAAc,SAAS,GAAG,KAAK;GAClD,MAAM,gBAAgB,cAAc,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG;GAC5D,aAAa,IAAI,aAAa;EAC/B;CACD;CACA,OAAO;AACR;AAGA,IAAa,YAAb,MAME;CACD;CACA;CACA;CACA;CACA,YACC,SAMC;EACD,MAAM,EAAE,OAAO,MAAM,gBAAgB,aAAa;EAClD,KAAK,QAAQ;EACb,KAAK,OAAO;EACZ,KAAK,iBAAiB;EACtB,KAAK,WAAW;CACjB;CAEA,IAAW,MAAuB;EACjC,IAAI,SAAgB,KAAK;EACzB,KAAK,MAAM,CAAC,YAAY,SAAS,KAAK,gBAAgB;GACrD,MAAM,gBAAgB,KAAK,KAAK,MAAM,MAAM,UAAU;GACtD,QAAQ,KAAK,OAAb;IACC,KAAK;KACJ,IAAI,eAAe,OAAO;KAC1B;IACD,KAAK;KACJ,IAAI,eAAe,SAAS;KAC5B;IACD,KAAK,aACJ,IAAI,eAAe,SAAS;SACvB,OAAO;GACd;EACD;EACA,OAAO;CACR;AACD;AAyBA,SAAS,YAA+B,SAA4B;CACnE,OAAO,OAAO,YAAY,OAAO;AAClC;AAEA,SAAS,UAA4B,KAAsC;CAC1E,OAAO,OAAO,QAAQ,GAAG;AAC1B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jurist",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "license": "MIT",
   "author": {
     "name": "Jeremy Banka",
@@ -21,26 +21,25 @@
   ],
   "main": "dist/jurist.js",
   "dependencies": {
-    "treetrunks": "0.1.6"
+    "treetrunks": "0.1.8"
   },
   "devDependencies": {
-    "@typescript/native-preview": "7.0.0-dev.20260303.1",
-    "concurrently": "9.2.1",
-    "eslint": "10.0.2",
-    "rimraf": "6.1.3",
-    "tsdown": "0.20.3",
-    "vite": "7.3.1",
-    "vitest": "4.0.18"
+    "@typescript/native-preview": "7.0.0-dev.20260611.2",
+    "concurrently": "10.0.3",
+    "eslint": "10.4.1",
+    "tsdown": "0.22.2",
+    "vite": "8.0.16",
+    "vitest": "4.1.8"
   },
   "scripts": {
     "build": "tsdown",
-    "lint:biome": "biome check -- .",
     "lint:eslint": "eslint -- .",
+    "lint:oxlint": "oxlint --type-aware -c ../../.oxlintrc.jsonc .",
     "lint:types": "tsgo --noEmit",
     "watch:types": "tsgo --watch --noEmit",
     "lint": "concurrently \"bun:lint:*\"",
     "test": "vitest",
     "test:once": "vitest run",
-    "postversion": "biome format --write package.json"
+    "postversion": "dprint fmt package.json"
   }
 }