@skylabs-digital/react-identity-access 2.12.0 → 2.14.0

package/dist/providers/RoutingProvider.d.ts

@@ -0,0 +1,56 @@
+import { ReactNode } from 'react';
+import { RoutingConfig, ZoneRoots, ZonePresets, ZonePresetConfig, AccessDeniedReason, ReturnToStorage } from '../types/zoneRouting';
+
+/**
+ * Context value provided by RoutingProvider
+ */
+export interface RoutingContextValue {
+    zoneRoots: Required<ZoneRoots>;
+    presets: ZonePresets;
+    loadingFallback: ReactNode;
+    accessDeniedFallback: ReactNode;
+    onAccessDenied?: (reason: AccessDeniedReason) => void;
+    returnToParam: string;
+    returnToStorage: ReturnToStorage;
+}
+export interface RoutingProviderProps {
+    config?: RoutingConfig;
+    children: ReactNode;
+}
+/**
+ * RoutingProvider - Global configuration for zone-based routing
+ *
+ * Provides default redirect paths, presets, and fallbacks that ZoneRoute
+ * components will use. Can be customized per-application.
+ *
+ * @example
+ * ```tsx
+ * <RoutingProvider config={{
+ *   zoneRoots: {
+ *     tenantGuest: '/auth/login',
+ *     tenantUser: '/app/dashboard',
+ *     tenantAdmin: '/admin',
+ *   },
+ *   loadingFallback: <Spinner />,
+ *   onAccessDenied: (reason) => console.log('Access denied:', reason),
+ * }}>
+ *   <App />
+ * </RoutingProvider>
+ * ```
+ */
+export declare function RoutingProvider({ config, children }: RoutingProviderProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * Hook to access routing configuration
+ * @throws Error if used outside RoutingProvider
+ */
+export declare function useRouting(): RoutingContextValue;
+/**
+ * Optional hook that returns RoutingContext if available, defaults otherwise.
+ * Useful for ZoneRoute which should work with or without RoutingProvider.
+ */
+export declare function useRoutingOptional(): RoutingContextValue;
+/**
+ * Get a specific preset configuration
+ */
+export declare function useZonePreset(presetName: keyof ZonePresets | string): ZonePresetConfig | undefined;
+//# sourceMappingURL=RoutingProvider.d.ts.map

package/dist/providers/RoutingProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoutingProvider.d.ts","sourceRoot":"","sources":["../../src/providers/RoutingProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA6B,SAAS,EAAW,MAAM,OAAO,CAAC;AACtE,OAAO,EACL,aAAa,EACb,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAGhB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC/B,OAAO,EAAE,WAAW,CAAC;IACrB,eAAe,EAAE,SAAS,CAAC;IAC3B,oBAAoB,EAAE,SAAS,CAAC;IAChC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACtD,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,eAAe,CAAC;CAClC;AAID,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,eAAe,CAAC,EAAE,MAAW,EAAE,QAAQ,EAAE,EAAE,oBAAoB,2CAyB9E;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,mBAAmB,CAMhD;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,mBAAmB,CAiBxD;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,MAAM,WAAW,GAAG,MAAM,GACrC,gBAAgB,GAAG,SAAS,CAG9B"}

package/dist/types/zoneRouting.d.ts

@@ -0,0 +1,122 @@
+import { ReactNode } from 'react';
+import { UserType } from './api';
+
+/**
+ * Access mode for zone requirements
+ * - 'required': Must match condition (redirect if not)
+ * - 'forbidden': Must NOT match condition (redirect if matches)
+ * - 'optional': Can be either (no redirect)
+ */
+export type AccessMode = 'required' | 'forbidden' | 'optional';
+/**
+ * Reason types for access denial
+ */
+export type AccessDeniedType = 'no_tenant' | 'has_tenant' | 'not_authenticated' | 'already_authenticated' | 'wrong_user_type' | 'missing_permissions';
+/**
+ * Detailed reason object passed to callbacks when access is denied
+ */
+export interface AccessDeniedReason {
+    type: AccessDeniedType;
+    required?: {
+        tenant?: AccessMode;
+        auth?: AccessMode;
+        userType?: UserType | UserType[];
+        permissions?: string[];
+    };
+    current?: {
+        hasTenant: boolean;
+        isAuthenticated: boolean;
+        userType?: UserType;
+        permissions?: string[];
+    };
+    redirectTo: string;
+}
+/**
+ * Zone root paths for automatic redirects
+ */
+export interface ZoneRoots {
+    publicGuest?: string;
+    publicUser?: string;
+    publicAdmin?: string;
+    tenantGuest?: string;
+    tenantUser?: string;
+    tenantAdmin?: string;
+    default?: string;
+}
+/**
+ * Default zone roots
+ */
+export declare const DEFAULT_ZONE_ROOTS: Required<ZoneRoots>;
+/**
+ * Preset zone configuration
+ */
+export interface ZonePresetConfig {
+    tenant?: AccessMode;
+    auth?: AccessMode;
+    userType?: UserType | UserType[];
+    requiredPermissions?: string[];
+}
+/**
+ * Built-in zone presets
+ */
+export interface ZonePresets {
+    landing: ZonePresetConfig;
+    publicOnly: ZonePresetConfig;
+    login: ZonePresetConfig;
+    guest: ZonePresetConfig;
+    authenticated: ZonePresetConfig;
+    tenant: ZonePresetConfig;
+    tenantOpen: ZonePresetConfig;
+    tenantAuth: ZonePresetConfig;
+    user: ZonePresetConfig;
+    admin: ZonePresetConfig;
+    open: ZonePresetConfig;
+}
+/**
+ * Default preset configurations
+ */
+export declare const DEFAULT_ZONE_PRESETS: ZonePresets;
+/**
+ * Return URL storage options
+ */
+export type ReturnToStorage = 'url' | 'session' | 'local';
+/**
+ * Routing configuration for AuthProvider
+ */
+export interface RoutingConfig {
+    zoneRoots?: ZoneRoots;
+    presets?: Partial<ZonePresets>;
+    loadingFallback?: ReactNode;
+    accessDeniedFallback?: ReactNode;
+    onAccessDenied?: (reason: AccessDeniedReason) => void;
+    returnToParam?: string;
+    returnToStorage?: ReturnToStorage;
+}
+/**
+ * Props for ZoneRoute component
+ */
+export interface ZoneRouteProps {
+    children: ReactNode;
+    preset?: keyof ZonePresets | string;
+    tenant?: AccessMode;
+    auth?: AccessMode;
+    userType?: UserType | UserType[];
+    requiredPermissions?: string[];
+    requireAllPermissions?: boolean;
+    returnTo?: boolean | string;
+    onAccessDenied?: (reason: AccessDeniedReason) => void;
+    redirectTo?: string;
+    loadingFallback?: ReactNode;
+    accessDeniedFallback?: ReactNode;
+}
+/**
+ * Zone navigation hook return type
+ */
+export interface UseZoneNavigationReturn {
+    returnToUrl: string | null;
+    clearReturnTo: () => void;
+    setReturnTo: (url: string) => void;
+    navigateToZone: (zone: keyof ZoneRoots) => void;
+    getSmartRedirect: () => string;
+}
+//# sourceMappingURL=zoneRouting.d.ts.map

package/dist/types/zoneRouting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zoneRouting.d.ts","sourceRoot":"","sources":["../../src/types/zoneRouting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,UAAU,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,YAAY,GACZ,mBAAmB,GACnB,uBAAuB,GACvB,iBAAiB,GACjB,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,CAAC,EAAE;QACT,MAAM,CAAC,EAAE,UAAU,CAAC;QACpB,IAAI,CAAC,EAAE,UAAU,CAAC;QAClB,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,EAAE,CAAC;QACjC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;KACxB,CAAC;IACF,OAAO,CAAC,EAAE;QACR,SAAS,EAAE,OAAO,CAAC;QACnB,eAAe,EAAE,OAAO,CAAC;QACzB,QAAQ,CAAC,EAAE,QAAQ,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;KACxB,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CAAC,SAAS,CAQlD,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,EAAE,CAAC;IACjC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAE1B,OAAO,EAAE,gBAAgB,CAAC;IAC1B,UAAU,EAAE,gBAAgB,CAAC;IAG7B,KAAK,EAAE,gBAAgB,CAAC;IACxB,KAAK,EAAE,gBAAgB,CAAC;IACxB,aAAa,EAAE,gBAAgB,CAAC;IAGhC,MAAM,EAAE,gBAAgB,CAAC;IACzB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,UAAU,EAAE,gBAAgB,CAAC;IAG7B,IAAI,EAAE,gBAAgB,CAAC;IACvB,KAAK,EAAE,gBAAgB,CAAC;IAGxB,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,WAqBlC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,SAAS,GAAG,OAAO,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/B,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,oBAAoB,CAAC,EAAE,SAAS,CAAC;IACjC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACtD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,SAAS,CAAC;IAGpB,MAAM,CAAC,EAAE,MAAM,WAAW,GAAG,MAAM,CAAC;IAGpC,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,IAAI,CAAC,EAAE,UAAU,CAAC;IAGlB,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,EAAE,CAAC;IAGjC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAGhC,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAG5B,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAGtD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,oBAAoB,CAAC,EAAE,SAAS,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,aAAa,EAAE,MAAM,IAAI,CAAC;IAC1B,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,SAAS,KAAK,IAAI,CAAC;IAChD,gBAAgB,EAAE,MAAM,MAAM,CAAC;CAChC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skylabs-digital/react-identity-access",
-  "version": "2.12.0",
+  "version": "2.14.0",
   "type": "module",
   "publishConfig": {
     "access": "public"