@bool-ts/guard-sdk 1.1.0-beta.11 → 1.1.0-beta.13

package/dist/types/actionGuard.d.ts

@@ -1,6 +1,6 @@
 import type { TOptionalTupleUnorderedNonEmpty } from "../ultils/types";
 import type { TResourceDefinition } from "./resources";
-export type TActionGuardOptions<T extends readonly TResourceDefinition[]> = {
+export type TActionGuardOptions<T extends readonly TResourceDefinition[] = readonly TResourceDefinition[]> = {
     [R in T[number] as R["alias"]]: {
         resource: R["alias"];
         action: R["actions"][number] | TOptionalTupleUnorderedNonEmpty<R["actions"]>;

package/dist/types/controllerGuard.d.ts

@@ -1,5 +1,5 @@
 import type { TResourceDefinition } from "./resources";
-export type TControllerGuardOptions<T extends readonly TResourceDefinition[]> = {
+export type TControllerGuardOptions<T extends readonly TResourceDefinition[] = readonly TResourceDefinition[]> = {
     [R in T[number] as R["alias"]]: {
         resource: R["alias"];
     };

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./actionGuard";
 export * from "./policies";
 export * from "./resources";
+export * from "./roles";

package/dist/types/roles.d.ts

@@ -0,0 +1,14 @@
+import type { TEnforceUnique, TOptionalTupleUnorderedNonEmpty } from "../ultils/types";
+import type { TResourceDefinition } from "./resources";
+export type TRolePermissionDefinition<T extends readonly TResourceDefinition[] = readonly TResourceDefinition[]> = {
+    [R in T[number] as R["alias"]]: {
+        readonly resource: R["alias"];
+        readonly actions: TOptionalTupleUnorderedNonEmpty<R["actions"]>;
+    };
+}[T[number]["alias"]];
+export type TRoleDefinition<T extends readonly TResourceDefinition[] = readonly TResourceDefinition[]> = {
+    readonly alias: string;
+    readonly [key: string]: unknown;
+} & {
+    readonly permissions: TEnforceUnique<Array<TRolePermissionDefinition<T>>, "resource">;
+};

package/dist/ultils/types/enforceUnique.d.ts

@@ -1,7 +1,9 @@
-type IsDuplicated<Arr extends readonly any[], K extends string, CurrentValue, Index extends string> = {
-    [I in keyof Arr]: I extends Index ? never : Arr[I] extends Record<K, any> ? Arr[I][K] extends CurrentValue ? true : never : never;
+type IsDuplicated<P extends readonly any[], K extends string, Index extends string> = {
+    [I in keyof P]: I extends Index ? never : P[I] extends Record<K, any> ? Index extends keyof P ? P[Index] extends Record<K, any> ? P[I][K] extends P[Index][K] ? true : never : never : never : never;
 }[number] extends never ? false : true;
-export type TEnforceUnique<Arr extends readonly any[], K extends keyof Arr[number]> = {
-    [I in keyof Arr]: IsDuplicated<Arr, K & string, Arr[I] extends Record<K, any> ? Arr[I][K] : never, I & string> extends true ? `❌ ERROR: Duplicate value "${Arr[I][K] & string}" found at key "${K & string}"` : Arr[I];
+export type TEnforceUnique<A extends readonly any[], K extends string> = {
+    [I in keyof A]: IsDuplicated<A, K, I & string> extends true ? A[I] & {
+        readonly __error: `Error: Duplicate value "${A[I] extends Record<K, any> ? A[I][K] : ""}" at key "${K}"`;
+    } : A[I];
 };
 export {};

package/package.json

@@ -41,10 +41,10 @@
         "url": "git+https://github.com/BoolTS/guard-sdk.git"
     },
     "scripts": {
-        "build": "tsc --emitDeclarationOnly && bun run ./app.build.ts",
-        "format": "prettier \"**/*.ts\" --write",
+        "build": "tsc --noEmit && bun run ./app.build.ts && tsc --emitDeclarationOnly",
+        "format": "prettier \"./src/**/*.ts\" --write",
         "test": "bun --hot run __test/index.ts"
     },
     "types": "./dist/index.d.ts",
-    "version": "1.1.0-beta.11"
+    "version": "1.1.0-beta.13"
 }

package/src/definers/resources.ts

@@ -1,4 +1,8 @@
-import type { TPolicyDefinition, TResourceDefinition } from "../types";
+import type {
+    TPolicyDefinition,
+    TResourceDefinition,
+    TRoleDefinition
+} from "../types";
 import type { TDeepReadonly, TEnforceUnique } from "../ultils/types";
 
 import { deepFreeze } from "../ultils/functions";
@@ -24,6 +28,7 @@ export const defineResources = <
     const resourceFreezed = deepFreeze(resources);
 
     return Object.freeze({
+        resources: resourceFreezed,
         getResource: <
             K extends D extends never ? never : D[number]["alias"],
             R extends Extract<D[number], { alias: K }>
@@ -42,9 +47,8 @@ export const defineResources = <
 
             return resourceFreezed[index] as R;
         },
-        resources: resourceFreezed,
         definePolicies: <const K extends readonly TPolicyDefinition<T>[]>(
-            policies: K & TEnforceUnique<K, "alias">
+            policies: TEnforceUnique<K, "alias">
         ) => {
             if (
                 new Set([
@@ -65,6 +69,59 @@ export const defineResources = <
             return Object.freeze({
                 policies: deepFreeze(policies)
             });
+        },
+        defineRoles: <
+            const R extends readonly TRoleDefinition<T>[] =
+                readonly TRoleDefinition<T>[],
+            L extends TDeepReadonly<R> = TDeepReadonly<R>
+        >(
+            roles: TEnforceUnique<
+                {
+                    [K in keyof R]: R[K] & {
+                        readonly permissions: R[K]["permissions"] &
+                            TEnforceUnique<R[K]["permissions"], "resource">;
+                    };
+                },
+                "alias"
+            >
+        ) => {
+            if (
+                new Set([
+                    ...roles
+                        .map((role) =>
+                            typeof role === "string" ? undefined : role.alias
+                        )
+                        .filter(
+                            (policyAlias) => typeof policyAlias !== "undefined"
+                        )
+                ]).size !== roles.length
+            ) {
+                throw new Error("Duplicated role alias.");
+            }
+
+            const rolesFreezed = deepFreeze(roles);
+
+            return Object.freeze({
+                roles: rolesFreezed,
+                getRole: <
+                    K extends L extends never ? never : L[number]["alias"],
+                    R extends Extract<L[number], { alias: K }>
+                >(
+                    alias: K
+                ): R => {
+                    const index = rolesFreezed.findIndex(
+                        ({ alias: roleAlias }) => alias === roleAlias
+                    );
+
+                    if (index === -1) {
+                        throw new Error(
+                            "Role not found, intialize roles error."
+                        );
+                    }
+
+                    return rolesFreezed[index] as R;
+                }
+            });
         }
     });
 };

package/src/index.ts

@@ -1,4 +1,5 @@
 export type * from "./interfaces";
+export type * from "./types";
 
 export * from "./constants";
 export * from "./decorators";

package/src/types/actionGuard.ts

@@ -1,7 +1,9 @@
 import type { TOptionalTupleUnorderedNonEmpty } from "../ultils/types";
 import type { TResourceDefinition } from "./resources";
 
-export type TActionGuardOptions<T extends readonly TResourceDefinition[]> = {
+export type TActionGuardOptions<
+    T extends readonly TResourceDefinition[] = readonly TResourceDefinition[]
+> = {
     [R in T[number] as R["alias"]]: {
         resource: R["alias"];
         action:

package/src/types/controllerGuard.ts

@@ -1,8 +1,9 @@
 import type { TResourceDefinition } from "./resources";
 
-export type TControllerGuardOptions<T extends readonly TResourceDefinition[]> =
-    {
-        [R in T[number] as R["alias"]]: {
-            resource: R["alias"];
-        };
-    }[T[number]["alias"]];
+export type TControllerGuardOptions<
+    T extends readonly TResourceDefinition[] = readonly TResourceDefinition[]
+> = {
+    [R in T[number] as R["alias"]]: {
+        resource: R["alias"];
+    };
+}[T[number]["alias"]];

package/src/types/index.ts

@@ -1,3 +1,4 @@
 export * from "./actionGuard";
 export * from "./policies";
 export * from "./resources";
+export * from "./roles";

package/src/types/policies.ts

@@ -12,25 +12,3 @@ export type TPolicyDefinition<
         readonly action: R["actions"][number];
     };
 }[T[number]["alias"]];
-
-// export type TPolicyAttributes<
-//     T extends readonly TResourceDefinition[],
-//     K extends readonly TPolicyDefinition[] = readonly TPolicyDefinition[]
-// > = {
-//     [R in K[number] as R["alias"]]: {
-//         readonly alias: string;
-//         readonly effect: "permit" | "deny";
-//     } & {
-//         [R in T[number] as R["type"]]: {
-//             readonly resource: R["type"];
-//             readonly action: R["actions"][number];
-//         };
-//     }[T[number]["type"]];
-// }[K[number]["alias"]];
-
-// {
-//     [R in K[number] as R["type"]]: {
-//         readonly resource: R["type"];
-//         readonly action: R["actions"][number];
-//     };
-// }[K[number]["type"]];

package/src/types/roles.ts

@@ -0,0 +1,26 @@
+import type {
+    TEnforceUnique,
+    TOptionalTupleUnorderedNonEmpty
+} from "../ultils/types";
+import type { TResourceDefinition } from "./resources";
+
+export type TRolePermissionDefinition<
+    T extends readonly TResourceDefinition[] = readonly TResourceDefinition[]
+> = {
+    [R in T[number] as R["alias"]]: {
+        readonly resource: R["alias"];
+        readonly actions: TOptionalTupleUnorderedNonEmpty<R["actions"]>;
+    };
+}[T[number]["alias"]];
+
+export type TRoleDefinition<
+    T extends readonly TResourceDefinition[] = readonly TResourceDefinition[]
+> = {
+    readonly alias: string;
+    readonly [key: string]: unknown;
+} & {
+    readonly permissions: TEnforceUnique<
+        Array<TRolePermissionDefinition<T>>,
+        "resource"
+    >;
+};

package/src/ultils/types/enforceUnique.ts

@@ -1,30 +1,27 @@
 type IsDuplicated<
-    Arr extends readonly any[],
+    P extends readonly any[],
     K extends string,
-    CurrentValue,
     Index extends string
 > = {
-    [I in keyof Arr]: I extends Index
+    [I in keyof P]: I extends Index
         ? never
-        : Arr[I] extends Record<K, any>
-          ? Arr[I][K] extends CurrentValue
-              ? true
+        : P[I] extends Record<K, any>
+          ? Index extends keyof P
+              ? P[Index] extends Record<K, any>
+                  ? P[I][K] extends P[Index][K]
+                      ? true
+                      : never
+                  : never
               : never
           : never;
 }[number] extends never
     ? false
     : true;
 
-export type TEnforceUnique<
-    Arr extends readonly any[],
-    K extends keyof Arr[number]
-> = {
-    [I in keyof Arr]: IsDuplicated<
-        Arr,
-        K & string,
-        Arr[I] extends Record<K, any> ? Arr[I][K] : never,
-        I & string
-    > extends true
-        ? `❌ ERROR: Duplicate value "${Arr[I][K] & string}" found at key "${K & string}"`
-        : Arr[I];
+export type TEnforceUnique<A extends readonly any[], K extends string> = {
+    [I in keyof A]: IsDuplicated<A, K, I & string> extends true
+        ? A[I] & {
+              readonly __error: `Error: Duplicate value "${A[I] extends Record<K, any> ? A[I][K] : ""}" at key "${K}"`;
+          }
+        : A[I];
 };

package/dist/definers/policies.d.ts

@@ -1,5 +0,0 @@
-import type { TPolicyDefinition } from "../types";
-import type { TEnforceUnique } from "../ultils/types";
-export declare const definePolicies: <const T extends readonly TPolicyDefinition[]>(policies: T & TEnforceUnique<T, "alias">) => Readonly<{
-    policies: import("../ultils/types").TDeepReadonly<T & TEnforceUnique<T, "alias">>;
-}>;

package/src/definers/policies.ts

@@ -1,24 +0,0 @@
-import type { TPolicyDefinition } from "../types";
-import type { TEnforceUnique } from "../ultils/types";
-
-import { deepFreeze } from "../ultils/functions";
-
-export const definePolicies = <const T extends readonly TPolicyDefinition[]>(
-    policies: T & TEnforceUnique<T, "alias">
-) => {
-    if (
-        new Set([
-            ...policies
-                .map((policy) =>
-                    typeof policy === "string" ? undefined : policy.alias
-                )
-                .filter((policyAlias) => typeof policyAlias !== "undefined")
-        ]).size !== policies.length
-    ) {
-        throw new Error("Duplicated policy alias.");
-    }
-
-    return Object.freeze({
-        policies: deepFreeze(policies)
-    });
-};