@cortejojicoy/admin-kit 0.1.8

package/dist/types-N0f4k4Ie.d.cts

@@ -0,0 +1,210 @@
+import { ReactNode, ComponentType } from 'react';
+
+interface AuthUser {
+    id: string;
+    email?: string;
+    name?: string;
+    image?: string;
+    roles?: string[];
+    permissions?: string[];
+    [key: string]: unknown;
+}
+interface AuthSession {
+    user: AuthUser;
+    accessToken?: string;
+    refreshToken?: string;
+    expiresAt?: number;
+}
+type AuthStatus = 'idle' | 'loading' | 'authenticated' | 'unauthenticated';
+interface AuthState {
+    status: AuthStatus;
+    user: AuthUser | null;
+    session: AuthSession | null;
+    error: string | null;
+}
+interface AuthActions {
+    login: (credentials: Record<string, unknown>) => Promise<AuthSession>;
+    logout: () => Promise<void>;
+    getSession: () => Promise<AuthSession | null>;
+    refresh?: () => Promise<AuthSession | null>;
+}
+type AuthContextValue = AuthState & AuthActions & {
+    isAuthenticated: boolean;
+    isLoading: boolean;
+};
+/**
+ * AuthProvider is the strategy interface every auth backend implements.
+ * Instances are created from config and consumed by <AuthContextProvider>.
+ */
+interface AuthProvider {
+    readonly name: string;
+    initialize?: () => Promise<AuthSession | null>;
+    login: (credentials: Record<string, unknown>) => Promise<AuthSession>;
+    logout: () => Promise<void>;
+    getSession: () => Promise<AuthSession | null>;
+    refresh?: () => Promise<AuthSession | null>;
+}
+interface JWTEndpoints {
+    login: string;
+    me: string;
+    logout?: string;
+    refresh?: string;
+}
+interface JWTAuthConfig {
+    endpoints: JWTEndpoints;
+    /** Where the token is stored on the client. Default: 'cookie'. */
+    tokenStorage?: 'cookie' | 'localStorage' | 'memory';
+    cookieName?: string;
+    /** Used by middleware/server helpers to verify tokens. NEVER ship to the client. */
+    secret?: string;
+    /** Header to send on authenticated requests. Default: 'Authorization' with 'Bearer '. */
+    header?: {
+        name: string;
+        prefix?: string;
+    };
+    /** Extract user from /me response. */
+    mapUser?: (raw: unknown) => AuthUser;
+    /** Extract { accessToken, refreshToken?, expiresAt? } from /login response. */
+    mapTokens?: (raw: unknown) => Partial<AuthSession>;
+}
+interface OAuthProviderConfig {
+    id: string;
+    name: string;
+    authorizationUrl: string;
+    tokenUrl?: string;
+    userInfoUrl?: string;
+    clientId: string;
+    clientSecret?: string;
+    scopes?: string[];
+    redirectUri?: string;
+    icon?: ReactNode;
+    mapUser?: (raw: unknown) => AuthUser;
+}
+interface OAuthConfig {
+    providers: OAuthProviderConfig[];
+    callbackUrl?: string;
+    /** Server-only callback handler path; default '/api/auth/callback/:provider'. */
+    callbackPath?: string;
+}
+
+interface NavItem {
+    id?: string;
+    label: string;
+    href?: string;
+    icon?: ReactNode;
+    badge?: ReactNode | string | number;
+    external?: boolean;
+    /** Hide this item from rendering. Useful for feature flags. */
+    hidden?: boolean;
+    /** Restrict to users with any of these roles. */
+    roles?: string[];
+    /** Restrict to users with any of these permissions. */
+    permissions?: string[];
+    /** Programmatic visibility check; runs after role/permission filters. */
+    visible?: (user: AuthUser | null) => boolean;
+    /** Nested items render as a collapsible group. */
+    children?: NavItem[];
+    /** Optional sort weight; lower comes first. Default 0. */
+    order?: number;
+}
+interface NavSection {
+    id?: string;
+    label?: string;
+    items: NavItem[];
+    roles?: string[];
+    permissions?: string[];
+    visible?: (user: AuthUser | null) => boolean;
+    order?: number;
+}
+
+/**
+ * An AdminModule is a self-contained feature pack a consumer can drop into
+ * `config.modules`. Modules can contribute:
+ *   - nav sections (merged into the sidebar)
+ *   - top-level providers (wrapped around the children inside AdminProvider)
+ *   - dashboard widgets (rendered by the optional <DashboardSlot moduleId="..." />)
+ */
+interface AdminModule {
+    id: string;
+    name?: string;
+    description?: string;
+    /** Sections appended to the sidebar (merged with the same-id config section if present). */
+    navSections?: NavSection[];
+    /** Wrap children in this provider. Composed in declaration order. */
+    Provider?: ComponentType<{
+        children: ReactNode;
+    }>;
+    /** Optional dashboard widgets keyed by slot name. */
+    widgets?: Record<string, ComponentType>;
+    /** Predicate that runs once at boot — if false, module is fully skipped. */
+    enabled?: (ctx: {
+        user: AuthUser | null;
+    }) => boolean;
+}
+
+type RouterFlavor = 'app' | 'pages';
+interface LoginPageConfig {
+    path?: string;
+    title?: string;
+    subtitle?: string;
+    logo?: ReactNode;
+    component?: ComponentType<LoginPageProps>;
+}
+interface LoginPageProps {
+    onSubmit?: (credentials: Record<string, string>) => Promise<void> | void;
+    error?: string | null;
+    loading?: boolean;
+}
+interface AuthConfig {
+    provider: 'jwt' | 'oauth' | 'custom';
+    jwt?: JWTAuthConfig;
+    oauth?: OAuthConfig;
+    custom?: AuthProvider;
+    loginPage?: LoginPageConfig;
+    afterLoginRedirect?: string;
+    afterLogoutRedirect?: string;
+    publicRoutes?: string[];
+    authorize?: (user: AuthUser, pathname: string) => boolean;
+}
+interface ThemeConfig {
+    mode?: 'light' | 'dark' | 'system';
+    primaryColor?: string;
+    tokens?: Record<string, string>;
+    className?: string;
+}
+interface LayoutConfig {
+    sidebarPosition?: 'left' | 'right';
+    sidebarCollapsible?: boolean;
+    sidebarDefaultCollapsed?: boolean;
+    topbar?: {
+        visible?: boolean;
+        component?: ComponentType;
+    };
+    footer?: {
+        visible?: boolean;
+        component?: ComponentType;
+    };
+}
+interface AppConfig {
+    name: string;
+    logo?: ReactNode | string;
+    description?: string;
+    url?: string;
+}
+interface AdminConfig {
+    app: AppConfig;
+    router?: RouterFlavor;
+    auth: AuthConfig;
+    navigation: {
+        sections: NavSection[];
+    };
+    modules?: AdminModule[];
+    theme?: ThemeConfig;
+    layout?: LayoutConfig;
+}
+type ResolvedAdminConfig = Required<Pick<AdminConfig, 'app' | 'auth' | 'navigation'>> & AdminConfig & {
+    router: RouterFlavor;
+    layout: Required<Pick<LayoutConfig, 'sidebarPosition' | 'sidebarCollapsible' | 'sidebarDefaultCollapsed'>> & LayoutConfig;
+};
+
+export type { AdminConfig as A, JWTAuthConfig as J, LayoutConfig as L, NavItem as N, OAuthConfig as O, ResolvedAdminConfig as R, ThemeConfig as T, AdminModule as a, AppConfig as b, AuthActions as c, AuthConfig as d, AuthContextValue as e, AuthProvider as f, AuthSession as g, AuthState as h, AuthStatus as i, AuthUser as j, JWTEndpoints as k, LoginPageConfig as l, LoginPageProps as m, NavSection as n, OAuthProviderConfig as o, RouterFlavor as p };

package/dist/types-N0f4k4Ie.d.ts

@@ -0,0 +1,210 @@
+import { ReactNode, ComponentType } from 'react';
+
+interface AuthUser {
+    id: string;
+    email?: string;
+    name?: string;
+    image?: string;
+    roles?: string[];
+    permissions?: string[];
+    [key: string]: unknown;
+}
+interface AuthSession {
+    user: AuthUser;
+    accessToken?: string;
+    refreshToken?: string;
+    expiresAt?: number;
+}
+type AuthStatus = 'idle' | 'loading' | 'authenticated' | 'unauthenticated';
+interface AuthState {
+    status: AuthStatus;
+    user: AuthUser | null;
+    session: AuthSession | null;
+    error: string | null;
+}
+interface AuthActions {
+    login: (credentials: Record<string, unknown>) => Promise<AuthSession>;
+    logout: () => Promise<void>;
+    getSession: () => Promise<AuthSession | null>;
+    refresh?: () => Promise<AuthSession | null>;
+}
+type AuthContextValue = AuthState & AuthActions & {
+    isAuthenticated: boolean;
+    isLoading: boolean;
+};
+/**
+ * AuthProvider is the strategy interface every auth backend implements.
+ * Instances are created from config and consumed by <AuthContextProvider>.
+ */
+interface AuthProvider {
+    readonly name: string;
+    initialize?: () => Promise<AuthSession | null>;
+    login: (credentials: Record<string, unknown>) => Promise<AuthSession>;
+    logout: () => Promise<void>;
+    getSession: () => Promise<AuthSession | null>;
+    refresh?: () => Promise<AuthSession | null>;
+}
+interface JWTEndpoints {
+    login: string;
+    me: string;
+    logout?: string;
+    refresh?: string;
+}
+interface JWTAuthConfig {
+    endpoints: JWTEndpoints;
+    /** Where the token is stored on the client. Default: 'cookie'. */
+    tokenStorage?: 'cookie' | 'localStorage' | 'memory';
+    cookieName?: string;
+    /** Used by middleware/server helpers to verify tokens. NEVER ship to the client. */
+    secret?: string;
+    /** Header to send on authenticated requests. Default: 'Authorization' with 'Bearer '. */
+    header?: {
+        name: string;
+        prefix?: string;
+    };
+    /** Extract user from /me response. */
+    mapUser?: (raw: unknown) => AuthUser;
+    /** Extract { accessToken, refreshToken?, expiresAt? } from /login response. */
+    mapTokens?: (raw: unknown) => Partial<AuthSession>;
+}
+interface OAuthProviderConfig {
+    id: string;
+    name: string;
+    authorizationUrl: string;
+    tokenUrl?: string;
+    userInfoUrl?: string;
+    clientId: string;
+    clientSecret?: string;
+    scopes?: string[];
+    redirectUri?: string;
+    icon?: ReactNode;
+    mapUser?: (raw: unknown) => AuthUser;
+}
+interface OAuthConfig {
+    providers: OAuthProviderConfig[];
+    callbackUrl?: string;
+    /** Server-only callback handler path; default '/api/auth/callback/:provider'. */
+    callbackPath?: string;
+}
+
+interface NavItem {
+    id?: string;
+    label: string;
+    href?: string;
+    icon?: ReactNode;
+    badge?: ReactNode | string | number;
+    external?: boolean;
+    /** Hide this item from rendering. Useful for feature flags. */
+    hidden?: boolean;
+    /** Restrict to users with any of these roles. */
+    roles?: string[];
+    /** Restrict to users with any of these permissions. */
+    permissions?: string[];
+    /** Programmatic visibility check; runs after role/permission filters. */
+    visible?: (user: AuthUser | null) => boolean;
+    /** Nested items render as a collapsible group. */
+    children?: NavItem[];
+    /** Optional sort weight; lower comes first. Default 0. */
+    order?: number;
+}
+interface NavSection {
+    id?: string;
+    label?: string;
+    items: NavItem[];
+    roles?: string[];
+    permissions?: string[];
+    visible?: (user: AuthUser | null) => boolean;
+    order?: number;
+}
+
+/**
+ * An AdminModule is a self-contained feature pack a consumer can drop into
+ * `config.modules`. Modules can contribute:
+ *   - nav sections (merged into the sidebar)
+ *   - top-level providers (wrapped around the children inside AdminProvider)
+ *   - dashboard widgets (rendered by the optional <DashboardSlot moduleId="..." />)
+ */
+interface AdminModule {
+    id: string;
+    name?: string;
+    description?: string;
+    /** Sections appended to the sidebar (merged with the same-id config section if present). */
+    navSections?: NavSection[];
+    /** Wrap children in this provider. Composed in declaration order. */
+    Provider?: ComponentType<{
+        children: ReactNode;
+    }>;
+    /** Optional dashboard widgets keyed by slot name. */
+    widgets?: Record<string, ComponentType>;
+    /** Predicate that runs once at boot — if false, module is fully skipped. */
+    enabled?: (ctx: {
+        user: AuthUser | null;
+    }) => boolean;
+}
+
+type RouterFlavor = 'app' | 'pages';
+interface LoginPageConfig {
+    path?: string;
+    title?: string;
+    subtitle?: string;
+    logo?: ReactNode;
+    component?: ComponentType<LoginPageProps>;
+}
+interface LoginPageProps {
+    onSubmit?: (credentials: Record<string, string>) => Promise<void> | void;
+    error?: string | null;
+    loading?: boolean;
+}
+interface AuthConfig {
+    provider: 'jwt' | 'oauth' | 'custom';
+    jwt?: JWTAuthConfig;
+    oauth?: OAuthConfig;
+    custom?: AuthProvider;
+    loginPage?: LoginPageConfig;
+    afterLoginRedirect?: string;
+    afterLogoutRedirect?: string;
+    publicRoutes?: string[];
+    authorize?: (user: AuthUser, pathname: string) => boolean;
+}
+interface ThemeConfig {
+    mode?: 'light' | 'dark' | 'system';
+    primaryColor?: string;
+    tokens?: Record<string, string>;
+    className?: string;
+}
+interface LayoutConfig {
+    sidebarPosition?: 'left' | 'right';
+    sidebarCollapsible?: boolean;
+    sidebarDefaultCollapsed?: boolean;
+    topbar?: {
+        visible?: boolean;
+        component?: ComponentType;
+    };
+    footer?: {
+        visible?: boolean;
+        component?: ComponentType;
+    };
+}
+interface AppConfig {
+    name: string;
+    logo?: ReactNode | string;
+    description?: string;
+    url?: string;
+}
+interface AdminConfig {
+    app: AppConfig;
+    router?: RouterFlavor;
+    auth: AuthConfig;
+    navigation: {
+        sections: NavSection[];
+    };
+    modules?: AdminModule[];
+    theme?: ThemeConfig;
+    layout?: LayoutConfig;
+}
+type ResolvedAdminConfig = Required<Pick<AdminConfig, 'app' | 'auth' | 'navigation'>> & AdminConfig & {
+    router: RouterFlavor;
+    layout: Required<Pick<LayoutConfig, 'sidebarPosition' | 'sidebarCollapsible' | 'sidebarDefaultCollapsed'>> & LayoutConfig;
+};
+
+export type { AdminConfig as A, JWTAuthConfig as J, LayoutConfig as L, NavItem as N, OAuthConfig as O, ResolvedAdminConfig as R, ThemeConfig as T, AdminModule as a, AppConfig as b, AuthActions as c, AuthConfig as d, AuthContextValue as e, AuthProvider as f, AuthSession as g, AuthState as h, AuthStatus as i, AuthUser as j, JWTEndpoints as k, LoginPageConfig as l, LoginPageProps as m, NavSection as n, OAuthProviderConfig as o, RouterFlavor as p };

package/package.json

@@ -0,0 +1,106 @@
+{
+  "name": "@cortejojicoy/admin-kit",
+  "version": "0.1.8",
+  "description": "Next.js 16 admin panel kit — pluggable auth (JWT/OAuth/custom), customizable sidebar, modules, and components. Works with App Router and Pages Router.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "import": "./dist/client.mjs",
+      "require": "./dist/client.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "import": "./dist/server.mjs",
+      "require": "./dist/server.js"
+    },
+    "./middleware": {
+      "types": "./dist/middleware.d.ts",
+      "import": "./dist/middleware.mjs",
+      "require": "./dist/middleware.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts,.tsx",
+    "clean": "rm -rf dist",
+    "preversion": "npm run typecheck && npm run build",
+    "version": "node scripts/update-changelog.mjs && git add CHANGELOG.md",
+    "postversion": "git push --follow-tags",
+    "release:patch": "npm version patch -m \"chore(release): v%s\"",
+    "release:minor": "npm version minor -m \"chore(release): v%s\"",
+    "release:major": "npm version major -m \"chore(release): v%s\"",
+    "prepublishOnly": "npm run clean && npm run build",
+    "publish:npm": "npm publish --access public --provenance",
+    "publish:npm:local": "node scripts/publish-local.mjs"
+  },
+  "peerDependencies": {
+    "next": ">=16.0.0",
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "next": { "optional": false },
+    "react": { "optional": false },
+    "react-dom": { "optional": false }
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "next": "^16.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5.5.0"
+  },
+  "keywords": [
+    "nextjs",
+    "next16",
+    "admin",
+    "admin-panel",
+    "dashboard",
+    "jwt",
+    "oauth",
+    "sidebar",
+    "pluggable",
+    "app-router",
+    "pages-router"
+  ],
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=20.9.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/",
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cortejojicoy/admin-kit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cortejojicoy/admin-kit/issues"
+  },
+  "homepage": "https://github.com/cortejojicoy/admin-kit#readme"
+}