@bool-ts/guard-sdk 1.0.2-beta.5 → 1.1.0-beta.1

package/src/instances/client.ts

@@ -1,5 +1,10 @@
 import type { TApiResponse } from "../interfaces/base";
-import type { IClient, TClientConfigs, TClientOptions } from "../interfaces/client.interface";
+import type {
+    IClient,
+    TClientCredential,
+    TClientDefinition,
+    TClientOptions
+} from "../interfaces/client.interface";
 
 import { SignJWT } from "jose";
 import { email } from "zod/v4";
@@ -7,6 +12,7 @@ import { Enums } from "../constants";
 
 export class Client implements IClient {
     readonly #baseUri = Enums.ETokenAudiences.SYSTEM;
+    readonly #defaultVersion: number = 1;
 
     private token: string | undefined;
 
@@ -16,8 +22,11 @@ export class Client implements IClient {
      * @param options
      */
     constructor(
-        private readonly configs: TClientConfigs,
-        private readonly options?: TClientOptions
+        private readonly params: Readonly<{
+            credential: TClientCredential;
+            definition?: TClientDefinition;
+            options?: TClientOptions;
+        }>
     ) {}
 
     /**
@@ -25,8 +34,16 @@ export class Client implements IClient {
      * @returns
      */
     async signToken() {
+        const {
+            params: {
+                credential: { tenantId, appId, modeId, secretKey },
+                options
+            }
+        } = this;
+
         try {
-            const rawKey = new Uint8Array(Buffer.from(this.configs.secretKey, "base64"));
+            const rawKey = new Uint8Array(Buffer.from(secretKey, "base64"));
+
             const privateKey = await crypto.subtle.importKey(
                 "raw",
                 rawKey,
@@ -36,10 +53,10 @@ export class Client implements IClient {
             );
 
             const jwt = await new SignJWT({
-                tenantId: this.configs.tenantId,
-                appId: this.configs.appId,
-                modeId: this.configs.modeId,
-                iss: this.configs.tenantId,
+                tenantId: tenantId,
+                appId: appId,
+                modeId: modeId,
+                iss: tenantId,
                 aud: Enums.ETokenAudiences.SYSTEM
             })
                 .setProtectedHeader({ alg: "HS512" })
@@ -49,7 +66,7 @@ export class Client implements IClient {
 
             return jwt;
         } catch (error) {
-            if (this.options?.logs) {
+            if (options?.logs) {
                 console.error("[BoolGuard] Sign token error:", error);
             }
 
@@ -63,17 +80,27 @@ export class Client implements IClient {
      * @returns
      */
     async ping() {
-        try {
-            const authToken = this.token || (await this.signToken());
+        const {
+            token,
+            params: {
+                credential: { tenantId, appId, modeId },
+                options
+            }
+        } = this;
 
+        try {
+            const authToken = token || (await this.signToken());
             const requestHeaders = new Headers();
-            requestHeaders.append("X-Tenant-ID", this.configs.tenantId);
-            requestHeaders.append("X-App-ID", this.configs.appId);
-            requestHeaders.append("X-Mode-ID", this.configs.modeId);
+
+            requestHeaders.append("X-Tenant-ID", tenantId);
+            requestHeaders.append("X-App-ID", appId);
+            requestHeaders.append("X-Mode-ID", modeId);
             requestHeaders.append("Authorization", `Bearer ${authToken}`);
 
             const response = await fetch(
-                `${this.#baseUri}/v${this.options?.version}/tenant-app-modes/ping`,
+                `${this.#baseUri}/v${
+                    options?.version || this.#defaultVersion
+                }/tenant-app-modes/ping`,
                 {
                     method: "GET",
                     headers: requestHeaders
@@ -86,7 +113,7 @@ export class Client implements IClient {
 
             return response.ok;
         } catch (error) {
-            if (this.options?.logs) {
+            if (options?.logs) {
                 console.error("[BoolGuard] Ping error:", error);
             }
 
@@ -106,28 +133,38 @@ export class Client implements IClient {
     }: Parameters<IClient["createPlainAccount"]>[number]): ReturnType<
         IClient["createPlainAccount"]
     > {
-        try {
-            const authToken = this.token || (await this.signToken());
+        const {
+            token,
+            params: {
+                credential: { tenantId, appId, modeId },
+                options
+            }
+        } = this;
 
+        try {
+            const authToken = token || (await this.signToken());
             const requestHeaders = new Headers();
-            requestHeaders.append("X-Tenant-ID", this.configs.tenantId);
-            requestHeaders.append("X-App-ID", this.configs.appId);
-            requestHeaders.append("X-Mode-ID", this.configs.modeId);
+
+            requestHeaders.append("X-Tenant-ID", tenantId);
+            requestHeaders.append("X-App-ID", appId);
+            requestHeaders.append("X-Mode-ID", modeId);
             requestHeaders.append("Authorization", `Bearer ${authToken}`);
             requestHeaders.append("Content-Type", "application/json");
 
             const response = await fetch(
-                `${this.#baseUri}/v${this.options?.version}/tenant-app-mode-accounts`,
+                `${this.#baseUri}/v${
+                    options?.version || this.#defaultVersion
+                }/tenant-app-mode-accounts`,
                 {
                     method: "POST",
                     headers: requestHeaders,
                     body: JSON.stringify({
-                        data: {
+                        data: Object.freeze({
                             type: "plain",
                             identity: identity,
                             password: password,
                             metadata: metadata
-                        }
+                        })
                     })
                 }
             );
@@ -136,14 +173,16 @@ export class Client implements IClient {
                 throw await response.json();
             }
 
-            const { data } = (await response.json()) as TApiResponse<IClient["createPlainAccount"]>;
+            const { data } = (await response.json()) as TApiResponse<
+                IClient["createPlainAccount"]
+            >;
 
             return Object.freeze({
                 account: data.account,
                 credential: data.credential
             });
         } catch (error) {
-            if (this.options?.logs) {
+            if (options?.logs) {
                 console.error("[BoolGuard] Create plain account error:", error);
             }
 
@@ -163,28 +202,38 @@ export class Client implements IClient {
     }: Parameters<IClient["createEmailAccount"]>[number]): ReturnType<
         IClient["createEmailAccount"]
     > {
-        try {
-            const authToken = this.token || (await this.signToken());
+        const {
+            token,
+            params: {
+                credential: { tenantId, appId, modeId },
+                options
+            }
+        } = this;
 
+        try {
+            const authToken = token || (await this.signToken());
             const requestHeaders = new Headers();
-            requestHeaders.append("X-Tenant-ID", this.configs.tenantId);
-            requestHeaders.append("X-App-ID", this.configs.appId);
-            requestHeaders.append("X-Mode-ID", this.configs.modeId);
+
+            requestHeaders.append("X-Tenant-ID", tenantId);
+            requestHeaders.append("X-App-ID", appId);
+            requestHeaders.append("X-Mode-ID", modeId);
             requestHeaders.append("Authorization", `Bearer ${authToken}`);
             requestHeaders.append("Content-Type", "application/json");
 
             const response = await fetch(
-                `${this.#baseUri}/v${this.options?.version}/tenant-app-mode-accounts`,
+                `${this.#baseUri}/v${
+                    options?.version || this.#defaultVersion
+                }/tenant-app-mode-accounts`,
                 {
                     method: "POST",
                     headers: requestHeaders,
                     body: JSON.stringify({
-                        data: {
+                        data: Object.freeze({
                             type: "email",
                             identity: identity,
                             password: password,
                             metadata: metadata
-                        }
+                        })
                     })
                 }
             );
@@ -193,14 +242,16 @@ export class Client implements IClient {
                 throw await response.json();
             }
 
-            const { data } = (await response.json()) as TApiResponse<IClient["createEmailAccount"]>;
+            const { data } = (await response.json()) as TApiResponse<
+                IClient["createEmailAccount"]
+            >;
 
             return Object.freeze({
                 account: data.account,
                 credential: data.credential
             });
         } catch (error) {
-            if (this.options?.logs) {
+            if (options?.logs) {
                 console.error("[BoolGuard] Create email account error:", error);
             }
 
@@ -216,29 +267,41 @@ export class Client implements IClient {
     async authenticate({
         identity,
         password
-    }: Parameters<IClient["authenticate"]>[number]): ReturnType<IClient["authenticate"]> {
+    }: Parameters<IClient["authenticate"]>[number]): ReturnType<
+        IClient["authenticate"]
+    > {
+        const {
+            token,
+            params: {
+                credential: { tenantId, appId, modeId },
+                options
+            }
+        } = this;
+
         try {
-            const authToken = this.token || (await this.signToken());
+            const authToken = token || (await this.signToken());
             const emailValidation = await email().safeParseAsync(identity);
-
             const requestHeaders = new Headers();
-            requestHeaders.append("X-Tenant-ID", this.configs.tenantId);
-            requestHeaders.append("X-App-ID", this.configs.appId);
-            requestHeaders.append("X-Mode-ID", this.configs.modeId);
+
+            requestHeaders.append("X-Tenant-ID", tenantId);
+            requestHeaders.append("X-App-ID", appId);
+            requestHeaders.append("X-Mode-ID", modeId);
             requestHeaders.append("Authorization", `Bearer ${authToken}`);
             requestHeaders.append("Content-Type", "application/json");
 
             const response = await fetch(
-                `${this.#baseUri}/v${this.options?.version}/tenant-app-mode-accounts/authenticate`,
+                `${this.#baseUri}/v${
+                    options?.version || this.#defaultVersion
+                }/tenant-app-mode-accounts/authenticate`,
                 {
                     method: "POST",
                     headers: requestHeaders,
                     body: JSON.stringify({
-                        data: {
+                        data: Object.freeze({
                             type: !emailValidation.success ? "plain" : "email",
                             identity: identity,
                             password: password
-                        }
+                        })
                     })
                 }
             );
@@ -247,7 +310,9 @@ export class Client implements IClient {
                 throw await response.json();
             }
 
-            const { data } = (await response.json()) as TApiResponse<IClient["authenticate"]>;
+            const { data } = (await response.json()) as TApiResponse<
+                IClient["authenticate"]
+            >;
 
             return Object.freeze({
                 account: data.account,
@@ -255,7 +320,7 @@ export class Client implements IClient {
                 token: data.token
             });
         } catch (error) {
-            if (this.options?.logs) {
+            if (options?.logs) {
                 console.error("[BoolGuard] Authenticate error:", error);
             }
 
@@ -269,26 +334,37 @@ export class Client implements IClient {
      */
     async verifyToken({
         token
-    }: Parameters<IClient["verifyToken"]>[number]): ReturnType<IClient["verifyToken"]> {
+    }: Parameters<IClient["verifyToken"]>[number]): ReturnType<
+        IClient["verifyToken"]
+    > {
+        const {
+            params: {
+                credential: { tenantId, appId, modeId },
+                options
+            }
+        } = this;
+
         try {
             const authToken = this.token || (await this.signToken());
-
             const requestHeaders = new Headers();
-            requestHeaders.append("X-Tenant-ID", this.configs.tenantId);
-            requestHeaders.append("X-App-ID", this.configs.appId);
-            requestHeaders.append("X-Mode-ID", this.configs.modeId);
+
+            requestHeaders.append("X-Tenant-ID", tenantId);
+            requestHeaders.append("X-App-ID", appId);
+            requestHeaders.append("X-Mode-ID", modeId);
             requestHeaders.append("Authorization", `Bearer ${authToken}`);
             requestHeaders.append("Content-Type", "application/json");
 
             const response = await fetch(
-                `${this.#baseUri}/v${this.options?.version}/tenant-app-mode-accounts/verify`,
+                `${this.#baseUri}/v${
+                    options?.version || this.#defaultVersion
+                }/tenant-app-mode-accounts/verify`,
                 {
                     method: "POST",
                     headers: requestHeaders,
                     body: JSON.stringify({
-                        data: {
+                        data: Object.freeze({
                             token: token
-                        }
+                        })
                     })
                 }
             );
@@ -297,14 +373,16 @@ export class Client implements IClient {
                 throw await response.json();
             }
 
-            const { data } = (await response.json()) as TApiResponse<IClient["verifyToken"]>;
+            const { data } = (await response.json()) as TApiResponse<
+                IClient["verifyToken"]
+            >;
 
             return Object.freeze({
                 account: data.account,
                 credential: data.credential
             });
         } catch (error) {
-            if (this.options?.logs) {
+            if (options?.logs) {
                 console.error("[BoolGuard] Verify token error:", error);
             }
 

package/src/interfaces/client.interface.ts

@@ -1,17 +1,23 @@
+import type { defineResources } from "../definers";
 import type { IAccount, TDefaultAccountMetadata } from "./account.interface";
 import type { IAccountCredential } from "./accountCredential.interface";
 
-export type TClientConfigs = {
+export type TClientCredential = Readonly<{
     tenantId: string;
     appId: string;
     modeId: string;
     secretKey: string;
-};
+}>;
+
+export type TClientDefinition = Readonly<{
+    resources: ReturnType<typeof defineResources>["resources"];
+    policies: ReturnType<ReturnType<typeof defineResources>["definePolicies"]>;
+}>;
 
-export type TClientOptions = {
+export type TClientOptions = Readonly<{
     version?: 1;
     logs?: boolean;
-};
+}>;
 
 export interface IClient<
     TAccountMetadata extends TDefaultAccountMetadata = TDefaultAccountMetadata
@@ -36,14 +42,20 @@ export interface IClient<
             credential: IAccountCredential;
         }>
     >;
-    authenticate(args: { identity: string; password?: string | null }): Promise<{
+    authenticate(args: {
+        identity: string;
+        password?: string | null;
+    }): Promise<{
         token: string;
         account: IAccount<TAccountMetadata>;
         credential: IAccountCredential;
     }>;
     verifyToken(args: {
         token: string;
-    }): Promise<{ account: IAccount<TAccountMetadata>; credential: IAccountCredential }>;
+    }): Promise<{
+        account: IAccount<TAccountMetadata>;
+        credential: IAccountCredential;
+    }>;
 }
 
 export type TAuthState = {

package/src/interfaces/index.ts

@@ -1,4 +1,5 @@
 export type { IAccount } from "./account.interface";
 export type { IAccountCredential } from "./accountCredential.interface";
 export type { TApiResponse } from "./base";
-export type { IClient, TAuthState, TClientConfigs, TClientOptions } from "./client.interface";
+export type { IClient, TAuthState, TClientCredential as TClientConfigs, TClientOptions } from "./client.interface";
+

package/src/types/actionGuard.ts

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

package/src/types/controllerGuard.ts

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

package/src/types/index.ts

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

package/src/types/policies.ts

@@ -0,0 +1,36 @@
+import type { TResourceDefinition } from "./resources";
+
+export type TPolicyDefinition<
+    T extends readonly TResourceDefinition[] = readonly TResourceDefinition[]
+> = {
+    readonly alias: string;
+    readonly effect: "permit" | "deny";
+    readonly [key: string]: unknown;
+} & {
+    [R in T[number] as R["type"]]: {
+        readonly resource: R["type"];
+        readonly action: R["actions"][number];
+    };
+}[T[number]["type"]];
+
+// 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/resources.ts

@@ -0,0 +1,10 @@
+import type { TNonEmptyArray } from "../ultils/types";
+
+export type TResourceDefinition<
+    T extends string = string,
+    A extends TNonEmptyArray<string> = TNonEmptyArray<string>
+> = {
+    readonly type: T;
+    readonly actions: A;
+    readonly [key: string]: unknown;
+};

package/src/ultils/functions/deepFreeze.ts

@@ -0,0 +1,19 @@
+type DeepReadonly<T> = T extends (...args: any[]) => any
+    ? T
+    : T extends readonly any[]
+    ? { readonly [K in keyof T]: DeepReadonly<T[K]> }
+    : T extends object
+    ? { readonly [K in keyof T]: DeepReadonly<T[K]> }
+    : T;
+
+export function deepFreeze<const T>(obj: T): DeepReadonly<T> {
+    if (typeof obj !== "object" || obj === null) return obj as any;
+    Object.freeze(obj);
+    for (const key of Object.keys(obj)) {
+        const val = (obj as any)[key];
+        if (typeof val === "object" && val !== null && !Object.isFrozen(val)) {
+            deepFreeze(val);
+        }
+    }
+    return obj as any;
+}

package/src/ultils/functions/index.ts

@@ -0,0 +1 @@
+export { deepFreeze } from "./deepFreeze";

package/src/ultils/types/constructor.ts

@@ -0,0 +1 @@
+export type TConstructor<T, K extends any[] = any[]> = new (...args: K) => T;

package/src/ultils/types/enforceUnique.ts

@@ -0,0 +1,30 @@
+type ValuesOfKey<Arr extends any[], K extends keyof any> = Arr extends [
+    infer Head,
+    ...infer Tail
+]
+    ? Head extends Record<K, any>
+        ? [Head[K], ...ValuesOfKey<Tail, K>]
+        : ValuesOfKey<Tail, K>
+    : [];
+
+type Includes<Arr extends any[], V> = Arr extends [infer H, ...infer R]
+    ? [V] extends [H]
+        ? true
+        : Includes<R, V>
+    : false;
+
+type HasDuplicate<
+    Arr extends readonly any[],
+    K extends keyof any
+> = Arr extends [infer Head, ...infer Tail]
+    ? Head extends Record<K, any>
+        ? Includes<ValuesOfKey<Tail, K>, Head[K]> extends true
+            ? true
+            : HasDuplicate<Tail, K>
+        : HasDuplicate<Tail, K>
+    : false;
+
+export type TEnforceUnique<
+    Arr extends readonly any[],
+    K extends keyof Arr[number]
+> = HasDuplicate<Arr, K> extends true ? ["Duplicate key found"] : Arr;

package/src/ultils/types/error.ts

@@ -0,0 +1 @@
+export type TError<Message extends string> = { __error__: Message };

package/src/ultils/types/extractTuple.ts

@@ -0,0 +1 @@
+export type ExtractTuple<T> = T extends readonly [...infer U] ? U : never;

package/src/ultils/types/inArray.ts

@@ -0,0 +1,7 @@
+export type TInArray<T, X> = T extends readonly [X, ...infer _Rest]
+    ? true
+    : T extends readonly [X]
+    ? true
+    : T extends readonly [infer _, ...infer Rest]
+    ? TInArray<Rest, X>
+    : false;

package/src/ultils/types/index.ts

@@ -0,0 +1,14 @@
+export type { TConstructor } from "./constructor";
+export type { TEnforceUnique } from "./enforceUnique";
+export type { TError } from "./error";
+export type { ExtractTuple } from "./extractTuple";
+export type { TInArray } from "./inArray";
+export type { MergeTuple } from "./mergeTuple";
+export type { TNonEmptyArray } from "./noneEmptyArray";
+export type { TPartialTuple } from "./partialTuple";
+export type { TPartialTupleUnordered as TOptionalTupleUnordered } from "./partialTupleUnordered";
+export type { TOptionalTupleUnorderedNonEmpty } from "./partialTupleUnorderedNonEmpty";
+export type { TPartialTupleNonEmpty } from "./partialTurpleNonEmpty";
+export type { TPermutationTuple } from "./permutationTuple";
+export type { TShuffleTuple } from "./shuffleTuple";
+export type { TStrictPartial } from "./strictPartial";

package/src/ultils/types/mergeTuple.ts

@@ -0,0 +1,3 @@
+export type MergeTuple<T extends readonly any[], U> = {
+    [K in keyof T]: T[K] & U;
+};

package/src/ultils/types/noneEmptyArray.ts

@@ -0,0 +1 @@
+export type TNonEmptyArray<T> = readonly [T, ...T[]];

package/src/ultils/types/partialTuple.ts

@@ -0,0 +1,3 @@
+export type TPartialTuple<T extends readonly any[]> = T extends readonly [infer Head, ...infer Tail]
+    ? TPartialTuple<Tail> | [Head, ...TPartialTuple<Tail>]
+    : [];

package/src/ultils/types/partialTupleUnordered.ts

@@ -0,0 +1,8 @@
+import type { TPartialTuple } from "./partialTuple";
+import type { TPermutationTuple } from "./permutationTuple";
+
+export type TPartialTupleUnordered<T extends readonly any[]> = TPartialTuple<T> extends infer S
+    ? S extends readonly any[]
+        ? TPermutationTuple<S[number]>
+        : never
+    : never;

package/src/ultils/types/partialTupleUnorderedNonEmpty.ts

@@ -0,0 +1,9 @@
+import type { TPartialTupleNonEmpty } from "./partialTurpleNonEmpty";
+import type { TPermutationTuple } from "./permutationTuple";
+
+export type TOptionalTupleUnorderedNonEmpty<T extends readonly any[]> =
+    TPartialTupleNonEmpty<T> extends infer S
+        ? S extends readonly any[]
+            ? TPermutationTuple<S[number]>
+            : never
+        : never;

package/src/ultils/types/partialTurpleNonEmpty.ts

@@ -0,0 +1,8 @@
+import type { TPartialTuple } from "./partialTuple";
+
+export type TPartialTupleNonEmpty<T extends readonly any[]> = T extends readonly [
+    infer Head,
+    ...infer Tail
+]
+    ? [Head, ...TPartialTuple<Tail>] | TPartialTupleNonEmpty<Tail>
+    : never;

package/src/ultils/types/permutationTuple.ts

@@ -0,0 +1,5 @@
+export type TPermutationTuple<T, K = T> = [T] extends [never]
+    ? []
+    : T extends any
+    ? [T, ...TPermutationTuple<Exclude<K, T>>]
+    : never;

package/src/ultils/types/shuffleTuple.ts

@@ -0,0 +1,7 @@
+type Values<T> = T[keyof T];
+
+export type TShuffleTuple<U extends string | number> = [U] extends [never]
+    ? []
+    : Values<{
+          [K in U]: [K, ...TShuffleTuple<Exclude<U, K>>];
+      }>;