@axium/core 0.22.1 → 0.23.0

package/dist/access.d.ts

@@ -1,5 +1,6 @@
-import * as z from 'zod';
 import { type Omit } from 'utilium';
+import * as z from 'zod';
+import { UserPublic } from './user.js';
 export declare const AccessControl: z.ZodObject<{
     itemId: z.ZodUUID;
     userId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
@@ -25,19 +26,37 @@ export declare const AccessControl: z.ZodObject<{
 export interface AccessControl extends z.infer<typeof AccessControl> {
 }
 export declare function getTarget(ac: AccessControl): AccessTarget;
-export declare function fromTarget(target: AccessTarget): Partial<Pick<AccessControl, 'userId' | 'role' | 'tag'>>;
-export declare function pickPermissions<T extends AccessControl & object>(ac: T): Omit<T, 'itemId' | 'userId' | 'role' | 'tag' | 'user' | 'createdAt'>;
+export declare function fromTarget(target: AccessTarget): Pick<AccessControl, 'userId' | 'role' | 'tag'>;
+export declare function controlMatchesUser(control: AccessControl, user?: Pick<UserPublic, 'id' | 'roles' | 'tags'>): boolean;
+type NonPermKeys = keyof (typeof AccessControl)['shape'];
+export type PickPermissions<T extends AccessControl> = Omit<T, NonPermKeys>;
+export declare function pickPermissions<T extends AccessControl>(ac: T): PickPermissions<T>;
+/**
+ * Check an ACL against a set of permissions.
+ * Returns the set of permissions that are missing.
+ */
+export declare function checkACL<const AC extends AccessControl>(acl: AC[], permissions: Partial<PickPermissions<AC>>): Set<keyof PickPermissions<AC>>;
+/**
+ * Check an ACL against a set of permissions and a user.
+ * Returns the set of permissions that are missing for the user.
+ */
+export declare function checkAndMatchACL<const AC extends AccessControl>(acl: AC[], user: Pick<UserPublic, 'id' | 'roles' | 'tags'>, permissions: Partial<PickPermissions<AC>>): Set<keyof PickPermissions<AC>>;
 export interface AccessControllable {
     id: string;
     userId: string;
     parentId?: string | null;
     acl?: AccessControl[];
 }
-export declare const AccessTarget: z.ZodUnion<readonly [z.ZodUUID, z.ZodTemplateLiteral<`@${string}`>, z.ZodTemplateLiteral<`#${string}`>, z.ZodLiteral<"public">]>;
+export declare const AccessTarget: z.ZodUnion<readonly [z.ZodUUID, z.ZodTemplateLiteral<`@${string}`>, z.ZodTemplateLiteral<`#${string}`>, z.ZodLiteral<null>]>;
+/**
+ * A primitive representation for the target of an access control.
+ *
+ */
 export type AccessTarget = z.infer<typeof AccessTarget>;
 export declare const AccessControlUpdate: z.ZodObject<{
-    target: z.ZodUnion<readonly [z.ZodUUID, z.ZodTemplateLiteral<`@${string}`>, z.ZodTemplateLiteral<`#${string}`>, z.ZodLiteral<"public">]>;
+    target: z.ZodUnion<readonly [z.ZodUUID, z.ZodTemplateLiteral<`@${string}`>, z.ZodTemplateLiteral<`#${string}`>, z.ZodLiteral<null>]>;
     permissions: z.ZodRecord<z.ZodString, z.ZodAny>;
 }, z.core.$strip>;
 export interface AccessControlUpdate extends z.infer<typeof AccessControlUpdate> {
 }
+export {};

package/dist/access.js

@@ -1,6 +1,6 @@
+import { omit } from 'utilium';
 import * as z from 'zod';
 import { UserPublic } from './user.js';
-import { omit } from 'utilium';
 export const AccessControl = z
     .object({
     itemId: z.uuid(),
@@ -18,10 +18,10 @@ export function getTarget(ac) {
         return '@' + ac.role;
     if (ac.tag)
         return '#' + ac.tag;
-    return 'public';
+    return null;
 }
 export function fromTarget(target) {
-    if (target == 'public')
+    if (target == null)
         return { userId: null, role: null, tag: null };
     if (target[0] == '@')
         return { userId: null, role: target.slice(1), tag: null };
@@ -29,14 +29,48 @@ export function fromTarget(target) {
         return { userId: null, role: null, tag: target.slice(1) };
     return { userId: target, role: null, tag: null };
 }
+export function controlMatchesUser(control, user) {
+    if (!control.role && !control.tag && !control.userId)
+        return true;
+    if (!user)
+        return false;
+    return !!(control.userId === user.id ||
+        (control.role && user.roles.includes(control.role)) ||
+        (control.tag && user.tags?.includes(control.tag)));
+}
 export function pickPermissions(ac) {
     return omit(ac, 'itemId', 'userId', 'role', 'tag', 'user', 'createdAt');
 }
+/**
+ * Check an ACL against a set of permissions.
+ * Returns the set of permissions that are missing.
+ */
+export function checkACL(acl, permissions) {
+    const allowed = new Set();
+    const all = new Set(Object.keys(permissions));
+    const entries = Object.entries(permissions);
+    for (const control of acl) {
+        for (const [key, needed] of entries) {
+            const value = control[key];
+            if (value === needed)
+                allowed.add(key);
+        }
+    }
+    return all.difference(allowed);
+}
+/**
+ * Check an ACL against a set of permissions and a user.
+ * Returns the set of permissions that are missing for the user.
+ */
+export function checkAndMatchACL(acl, user, permissions) {
+    const filtered = acl.filter(c => controlMatchesUser(c, user));
+    return checkACL(filtered, permissions);
+}
 export const AccessTarget = z.union([
     z.uuid(),
     z.templateLiteral(['@', z.string()]),
     z.templateLiteral(['#', z.string()]),
-    z.literal('public'),
+    z.literal(null),
 ]);
 export const AccessControlUpdate = z.object({
     target: AccessTarget,

package/dist/api.d.ts

@@ -434,7 +434,7 @@ declare const _API: {
             createdAt: z.ZodCoercedDate<unknown>;
         }, z.core.$catchall<z.ZodBoolean>>>;
         readonly PATCH: [z.ZodObject<{
-            target: z.ZodUnion<readonly [z.ZodUUID, z.ZodTemplateLiteral<`@${string}`>, z.ZodTemplateLiteral<`#${string}`>, z.ZodLiteral<"public">]>;
+            target: z.ZodUnion<readonly [z.ZodUUID, z.ZodTemplateLiteral<`@${string}`>, z.ZodTemplateLiteral<`#${string}`>, z.ZodLiteral<null>]>;
             permissions: z.ZodRecord<z.ZodString, z.ZodAny>;
         }, z.core.$strip>, z.ZodObject<{
             itemId: z.ZodUUID;
@@ -458,7 +458,7 @@ declare const _API: {
             }, z.core.$strip>>>;
             createdAt: z.ZodCoercedDate<unknown>;
         }, z.core.$catchall<z.ZodBoolean>>];
-        readonly PUT: [z.ZodUnion<readonly [z.ZodUUID, z.ZodTemplateLiteral<`@${string}`>, z.ZodTemplateLiteral<`#${string}`>, z.ZodLiteral<"public">]>, z.ZodObject<{
+        readonly PUT: [z.ZodUnion<readonly [z.ZodUUID, z.ZodTemplateLiteral<`@${string}`>, z.ZodTemplateLiteral<`#${string}`>, z.ZodLiteral<null>]>, z.ZodObject<{
             itemId: z.ZodUUID;
             userId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
             role: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -480,7 +480,7 @@ declare const _API: {
             }, z.core.$strip>>>;
             createdAt: z.ZodCoercedDate<unknown>;
         }, z.core.$catchall<z.ZodBoolean>>];
-        readonly DELETE: [z.ZodUnion<readonly [z.ZodUUID, z.ZodTemplateLiteral<`@${string}`>, z.ZodTemplateLiteral<`#${string}`>, z.ZodLiteral<"public">]>, z.ZodObject<{
+        readonly DELETE: [z.ZodUnion<readonly [z.ZodUUID, z.ZodTemplateLiteral<`@${string}`>, z.ZodTemplateLiteral<`#${string}`>, z.ZodLiteral<null>]>, z.ZodObject<{
             itemId: z.ZodUUID;
             userId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
             role: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -601,9 +601,9 @@ declare const _API: {
                 hooks: z.ZodOptional<z.ZodString>;
                 integrations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
             }, z.core.$strip>>;
+            description: z.ZodOptional<z.ZodString>;
             version: z.ZodString;
             cli: z.ZodOptional<z.ZodString>;
-            description: z.ZodOptional<z.ZodString>;
             apps: z.ZodOptional<z.ZodArray<z.ZodObject<{
                 id: z.ZodString;
                 name: z.ZodOptional<z.ZodString>;

package/dist/format.js

@@ -8,7 +8,7 @@ export function formatDateRange(date) {
 export function formatBytes(bytes) {
     const units = ['B', 'KB', 'MB', 'GB', 'TB'];
     const i = bytes == 0n ? 0 : Math.floor((bytes.toString(10).length - 1) / 3);
-    const value = bytes == 0n ? 0 : Number(bytes / 1000n ** BigInt(i));
+    const value = bytes == 0n ? 0 : Number(bytes) / Math.pow(1000, i);
     return `${Number.isInteger(value) ? value : value.toFixed(2)} ${units[i]}`;
 }
 export default {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axium/core",
-	"version": "0.22.1",
+	"version": "0.23.0",
 	"author": "James Prevett <axium@jamespre.dev>",
 	"funding": {
 		"type": "individual",