@explita/cloud-auth-client 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,284 @@
+export type AuthProviderProps = {
+    children: React.ReactNode;
+    /**
+     * Configuration object for the AuthProvider.
+     */
+    config?: AuthConfig;
+};
+export type AuthConfig = {
+    /**
+     * Your application's host (eg: http://localhost:3000).
+     * Only useful if the auto-detection fails.
+     */
+    hostOverride?: string;
+    /**
+     * The path to the login page default is /login.
+     */
+    loginPath?: string;
+    /**
+     * The path to the signup page default is /signup.
+     */
+    signupPath?: string;
+    /**
+     * The path to the dashboard page default is /dashboard.
+     */
+    dashboardPath?: string;
+    /**
+     * The path to the reset password page default is /forgot-password.
+     */
+    resetPasswordPath?: string;
+    /**
+     * Whether to disable the loading screen default is false.
+     */
+    disableLoading?: boolean;
+    /**
+     * A callback to run when the user is authenticated.
+     */
+    onAuthSuccess?: (user: User) => void;
+    /**
+     * A function to set the cookie value.
+     *
+     * This function is only useful when you are working in development environment and your app is hosted on a localhost subdomain (eg: http://console.localhost:3000) and you need to access server session from server components or middlewares.
+     *
+     * @example
+     * ```ts
+     * import { setCookie } from "@explita/cloud-auth-client/server";
+     *
+     * export async function cookieOverrideHandler(cookie?: string) {
+     *   await setCookie(cookie);
+     * }
+     * ```
+     * @returns void
+     */
+    cookieOverride?: CookieOverrideFn;
+    /**
+     * Paths to exclude from authentication.
+     */
+    excludedPaths?: string[];
+};
+type ComputedRouteContext = {
+    loginUrl: string;
+    signupUrl: string;
+    dashboardUrl: string;
+    resetPasswordUrl: string;
+    returnPath: string;
+    currentPath: string;
+    excludedPaths: string[];
+    isExcluded: boolean;
+};
+type CookieOverrideFn = (cookie: string | undefined) => Promise<void>;
+export type ApiOptions = {
+    method?: "GET" | "POST" | "PUT" | "DELETE";
+    body?: Record<string, any>;
+    headers?: Record<string, string>;
+    [key: string]: any;
+};
+export type NewRole = {
+    groupId?: string;
+    name: string;
+    description?: string;
+    permissions?: string[];
+};
+export type Login = {
+    email: string;
+    password: string;
+    authToken?: string | null;
+};
+export type Signup = {
+    roleId?: string;
+    groupId?: string | null;
+    firstName: string;
+    lastName: string;
+    username?: string;
+    email: string;
+    password: string;
+    confirmPassword: string;
+    metaData?: Record<string, any>;
+    isSuperAdmin?: boolean;
+};
+export type UpdateUser = Omit<Signup, "password" | "confirmPassword">;
+export type GeneralResponse = {
+    status: "failure";
+    message: string;
+};
+export type FormResponse<T extends any = any> = {
+    status: "validation-error";
+    errors: Record<string, string>;
+    message: string;
+} | GeneralResponse | {
+    status: "success";
+    message: string;
+    data: T;
+    authToken?: string;
+};
+type VerifyUserKey = "email" | "username" | "password";
+export type VerifyUser = {
+    key: VerifyUserKey;
+    value: string;
+}[];
+export type VerifyUserResponse = {
+    success: true;
+    data: {
+        key: VerifyUserKey;
+        value: string;
+        status: "available" | "taken";
+        message: string;
+    }[];
+} | {
+    message: string;
+    message_slug: string;
+    success: false;
+};
+export type ResetPassword = {
+    password: string;
+    confirmPassword: string;
+};
+export type ResetPasswordWithToken = ResetPassword & {
+    token: string;
+};
+export type ResetPasswordWithUserId = ResetPassword & {
+    userId: string;
+};
+export type AuthContextType = {
+    user: User | null;
+    authLoading: boolean;
+    isAuthenticated: boolean;
+    error: AuthError | null;
+    login: (credentials: Login) => Promise<Partial<AuthError> | null>;
+    sendPasswordResetRequest: (email: string) => Promise<GeneralResponse>;
+    logout: (params?: Record<string, string>) => void;
+    hasPermission: (permission: string) => boolean;
+    revalidate: () => void;
+    computedRouteContext: ComputedRouteContext;
+};
+export type OTPContextReturn = {
+    processing: boolean;
+    isOpen: boolean;
+    open: () => void;
+    close: () => void;
+    onCanceled?: () => void;
+    successMessage: string;
+    errorMessage: string;
+    otpValue: string;
+    setOtpValue: (value: string) => void;
+    sendOtp: () => Promise<void>;
+    verifyOtp: () => Promise<void>;
+    isVerified: boolean;
+    id: string;
+    sendOnMount?: boolean;
+    hasSent: boolean;
+};
+export type OTPContextProps = {
+    id?: string;
+    userId: string;
+    email?: string;
+    sendOnMount?: boolean;
+    onVerified: (authToken: string, tempRefreshToken?: string) => void;
+    onCanceled?: () => void;
+    onSend?: () => void;
+    onError?: () => void;
+};
+export type Otp = {
+    id: string;
+    userId: string;
+    createdAt: Date;
+    serviceId: string | null;
+    sentTo: string;
+    code: string;
+    channel: Channel;
+    used: boolean;
+    success: boolean;
+    reason: Reason | null;
+    expiresAt: Date;
+    verifiedAt: Date | null;
+};
+export type User = {
+    id: string;
+    roleId: string | null;
+    groupId: string | null;
+    email: string;
+    username: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    fullName: string | null;
+    avatar: string | null;
+    with2fa: boolean;
+    metaData: Record<string, any>;
+    role: Role;
+    isSuperAdmin: boolean;
+    isActive: boolean;
+    isLive: boolean;
+    createdAt: string;
+    updatedAt: string;
+};
+export type NextAppCookies = {
+    get(name: string): {
+        value: string;
+    } | undefined;
+};
+export type Role = {
+    id: string;
+    userId: string | null;
+    groupId: string | null;
+    label: string;
+    description: string | null;
+    permissions: string[];
+    isActive: boolean;
+    isLive: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+    isSuperAdmin: boolean;
+};
+export type Project = {
+    id: string;
+    projectName: string;
+    createdAt: string;
+    updatedAt: string;
+    isActive: boolean;
+    slug: string;
+    services: Service[];
+};
+export type Service = {
+    id: string;
+    label: string;
+    type: ServiceType;
+    publicKey: string;
+    privateKey: string;
+    isLive: boolean;
+    isActive: boolean;
+    lastUsed: string | null;
+    createdAt: string;
+    updatedAt: string;
+    envs: {
+        privateEnv: string;
+        publicEnv: string;
+        combined: string;
+    };
+    slug: string;
+};
+export type AuthError = {
+    errors: Record<string, string>;
+    message: string;
+    message_slug: string;
+    status: "failure";
+};
+export type OTPProps = {
+    user: User | null;
+    onVerified: (authToken: string, tempRefreshToken?: string) => void;
+    onCanceled?: () => void;
+};
+export type UseTokenRefresherOptions = {
+    refreshTokenRequest: () => Promise<{
+        authToken: string;
+        tempRefreshToken?: string;
+    }>;
+    onRefreshFailed?: () => void;
+    onTokenRefreshed?: (authToken: string, tempRefreshToken?: string) => void;
+    revalidateUserWhenOnline?: () => void;
+    config?: AuthConfig;
+};
+export type Status = "ACTIVE" | "INACTIVE";
+export type ServiceType = "auth" | "database" | "otp" | "storage";
+export type Channel = "email" | "sms" | "totp" | "whatsapp";
+export type Reason = "expired" | "invalid" | "success";
+export {};

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/ui/index.d.ts

@@ -0,0 +1,11 @@
+export * from "../components/logged-in";
+export * from "../components/logged-out";
+export * from "../components/user-card";
+export * from "../components/loader";
+export * from "../components/signup-form";
+export * from "../components/login-form";
+export * from "../components/reset-password";
+export * from "../components/change-password";
+export * from "../components/settings";
+export * from "../components/toggle-account-status";
+export * from "../components/toggle-2fa";

package/dist/ui/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../components/logged-in"), exports);
+__exportStar(require("../components/logged-out"), exports);
+__exportStar(require("../components/user-card"), exports);
+__exportStar(require("../components/loader"), exports);
+__exportStar(require("../components/signup-form"), exports);
+__exportStar(require("../components/login-form"), exports);
+__exportStar(require("../components/reset-password"), exports);
+__exportStar(require("../components/change-password"), exports);
+__exportStar(require("../components/settings"), exports);
+__exportStar(require("../components/toggle-account-status"), exports);
+__exportStar(require("../components/toggle-2fa"), exports);

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@explita/cloud-auth-client",
+  "version": "0.0.1",
+  "author": "Explita",
+  "license": "MIT",
+  "description": "A simple authentication library for React",
+  "main": "./dist/index.js",
+  "types": "./dist/types.d.ts",
+  "exports": {
+    ".": {
+      "default": "./dist/index.js"
+    },
+    "./ui": {
+      "default": "./dist/ui/index.js"
+    },
+    "./server": {
+      "default": "./dist/server/index.js"
+    },
+    "./styles.css": "./dist/styles.css"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && tsc",
+    "postbuild": "node src/misc/post-build.js",
+    "prepublishOnly": "npm run build",
+    "styles": "npx @tailwindcss/cli -i ./src/dev-styles.css -o ./src/styles.css --watch"
+  },
+  "keywords": [
+    "auth",
+    "authentication",
+    "react",
+    "session",
+    "token",
+    "otp"
+  ],
+  "devDependencies": {
+    "@tailwindcss/cli": "^4.1.5",
+    "@types/node": "^24",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "fs-extra": "^11.3.0",
+    "rimraf": "^6.0.1",
+    "tailwindcss": "^4.1.5",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "class-variance-authority": "^0.7.1"
+  },
+  "optionalDependencies": {
+    "@explita/cloud-otp-client": "*"
+  },
+  "peerDependencies": {
+    "@radix-ui/react-dialog": "^1",
+    "@radix-ui/react-dropdown-menu": "^2",
+    "@radix-ui/react-slot": "^1",
+    "@radix-ui/react-switch": "^1",
+    "react": "^19",
+    "react-dom": "^19"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ]
+}