runid-lys 0.6.0 → 0.7.0

package/dist/index.js

@@ -1,10 +1,9 @@
 import { I18nLocaleEnum } from "./types/index.js";
 import { c, a, b, d, e, f, g, h, i, j, k, l, m, n, p, s, t, v } from "./translationTools-CKk0l3jr.js";
 import { g as g2, m as m2 } from "./i18nTools-C1k2y9xe.js";
-import { A, C, a as a2, b as b2, c as c2, E, F, G, L, d as d2, e as e2, f as f2, g as g3, P, R, S, U, W, u, h as h2, i as i2, j as j2, k as k2, l as l2, m as m3, n as n2, o, p as p2, q, r, s as s2, t as t2, v as v2, w, x, y, z } from "./constants-BMsk7KvD.js";
-import { u as u2, a as a3 } from "./hooks-CvhFUowR.js";
+import { A, C, a as a2, b as b2, c as c2, E, F, G, L, d as d2, e as e2, f as f2, g as g3, P, R, h as h2, S, U, W, u, i as i2, j as j2, k as k2, l as l2, m as m3, n as n2, o, p as p2, q, r, s as s2, t as t2, v as v2, w, x, y, z, B, D, H } from "./constants-sdhUzJ0l.js";
+import { P as P2, u as u2, a as a3 } from "./PublicAppTemplate-DLKcJZVR.js";
 import { R as R2, c as c3, a as a4 } from "./RelayEnvironment-D880U9SM.js";
-import { P as P2 } from "./PublicAppTemplate-B93G2Smc.js";
 import { e as e3, i as i3 } from "./errors-BOacmKM0.js";
 import { messagesTranslations } from "./i18n/index.js";
 export {
@@ -26,6 +25,7 @@ export {
   P2 as PublicAppTemplate,
   R as RefreshSignalContext,
   R2 as RelayEnvironment,
+  h2 as RouteProvider,
   S as SignalProvider,
   U as UrlQueriesProvider,
   W as WebserviceAccessProvider,
@@ -55,25 +55,27 @@ export {
   t as toSnakeCase,
   u as useAlertMessages,
   u2 as useChatbot,
-  h2 as useClientId,
+  i2 as useClientId,
   a3 as useConnectedUserInfo,
-  i2 as useDialogWithUpdates,
-  j2 as useFilterLabels,
-  k2 as useLocale,
-  l2 as useLysDialog,
-  m3 as useLysLoadingFallback,
-  n2 as useLysMutation,
-  o as useLysQuery,
-  p2 as usePageContext,
-  q as usePermissionCheck,
-  r as useRefreshSignal,
-  s2 as useRestrictedLink,
-  t2 as useSignal,
-  v2 as useSignalRefresh,
-  w as useSignalSubscription,
-  x as useUrlQueries,
-  y as useWebserviceAccess,
+  j2 as useDialogWithUpdates,
+  k2 as useFilterLabels,
+  l2 as useLocale,
+  m3 as useLysDialog,
+  n2 as useLysLoadingFallback,
+  o as useLysMutation,
+  p2 as useLysQuery,
+  q as usePageContext,
+  r as usePermissionCheck,
+  s2 as useRefreshSignal,
+  t2 as useRestrictedLink,
+  v2 as useRouteAccess,
+  w as useRouteInfo,
+  x as useSignal,
+  y as useSignalRefresh,
+  z as useSignalSubscription,
+  B as useUrlQueries,
+  D as useWebserviceAccess,
   v as validators,
-  z as webserviceAccessProviderConfig
+  H as webserviceAccessProviderConfig
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/providers/RouteProvider/hooks.d.ts

@@ -0,0 +1,22 @@
+import { RouteInterface } from '../../types/routeTypes';
+/**
+ * Shape of the value exposed by the route context.
+ */
+export interface RouteContextValue {
+    /** Currently active route (the one matching the URL). */
+    route: RouteInterface | null;
+    /** Default route used as fallback for authenticated users (e.g. home page). */
+    defaultPrivateRoute: RouteInterface | null;
+    /** Default route used as fallback for anonymous users (e.g. login page). */
+    defaultPublicRoute: RouteInterface | null;
+    /** All known routes keyed by route name for O(1) lookup. */
+    allRoutes: Record<string, RouteInterface>;
+    /** Look up a route by its name. */
+    getRouteByName: (name: string) => RouteInterface | undefined;
+}
+declare const RouteContext: import('react').Context<RouteContextValue>;
+/**
+ * Hook to access the active route, default routes and the route map.
+ */
+declare const useRouteInfo: () => RouteContextValue;
+export { RouteContext, useRouteInfo };

package/dist/providers/RouteProvider/index.d.ts

@@ -0,0 +1,45 @@
+import { RouteInterface } from '../../types/routeTypes';
+import * as React from "react";
+/**
+ * Shape expected from any template component plugged into `RouteProvider`.
+ *
+ * Templates receive the same triplet (active route + default routes) so they
+ * can render the page chrome and trigger any post-mount redirects.
+ */
+export interface RouteTemplateProps {
+    route: RouteInterface;
+    defaultPrivateRoute: RouteInterface;
+    defaultPublicRoute: RouteInterface;
+    children: React.ReactNode;
+}
+export interface RouteProviderProps {
+    route: RouteInterface;
+    routes: RouteInterface[];
+    defaultPrivateRoute: RouteInterface;
+    defaultPublicRoute: RouteInterface;
+    /**
+     * Template used when the active route's `type` is `"private"`.
+     * Projects inject their own private template (e.g. with sidebar/topbar)
+     * because the layout is project-specific.
+     */
+    privateTemplate: React.ComponentType<RouteTemplateProps>;
+    /**
+     * Optional override for public pages. Defaults to the generic
+     * `PublicAppTemplate` shipped with lys-front (handles connected-user
+     * redirects).
+     */
+    publicTemplate?: React.ComponentType<RouteTemplateProps>;
+    children: React.ReactNode;
+}
+/**
+ * Generic route provider:
+ * - Exposes the active route, the route map and helpers via `useRouteInfo`.
+ * - Wires the chatbot's `pageContext` to the current route + URL params.
+ * - Auto-opens the chatbot for routes flagged with `autoOpenChatbot`.
+ * - Renders the project-supplied template matching the route type.
+ *
+ * The two templates are injected as props so projects keep ownership of their
+ * page chrome (sidebar, navbar, branding…) while reusing all the route plumbing.
+ */
+declare const RouteProvider: React.FC<RouteProviderProps>;
+export default RouteProvider;

package/dist/providers/hooks/useRestrictedLink.d.ts

@@ -6,8 +6,9 @@ export interface RestrictedLink {
 /**
  * Hook to check route permission and provide navigation callback.
  *
- * Combines permission checking (via WebserviceAccessProvider) with
- * navigation (via react-router) for a given route.
+ * Combines permission checking (via WebserviceAccessProvider — delegated to
+ * `useRouteAccess` so the single/array `mainWebserviceName` semantics stay
+ * in one place) with navigation (via react-router) for a given route.
  *
  * Usage:
  * ```tsx

package/dist/providers/hooks/useRouteAccess.d.ts

@@ -0,0 +1,25 @@
+import { RouteInterface } from '../../types/routeTypes';
+/**
+ * Hook that returns a function reporting whether the current user has
+ * access to a given route.
+ *
+ * The returned function accepts either a `RouteInterface` (when the caller
+ * already has the route resolved) or a route name (the hook performs the
+ * lookup against the `RouteProvider`'s map). `undefined` always returns
+ * `false`.
+ *
+ * Permission semantics for `route.mainWebserviceName`:
+ * - `undefined` → no permission gate → access granted.
+ * - `string`    → access requires that single webservice.
+ * - `string[]`  → any-of: access granted as soon as the user has at least
+ *                 one of the listed webservices.
+ *
+ * Usage:
+ * ```tsx
+ * const hasAccess = useRouteAccess();
+ * hasAccess(route);                // route already resolved
+ * hasAccess("AdministrationPage"); // resolved internally via RouteProvider
+ * hasAccess(undefined);            // false
+ * ```
+ */
+export declare const useRouteAccess: () => (routeOrName: RouteInterface | string | undefined) => boolean;

package/dist/providers/index.d.ts

@@ -12,6 +12,7 @@ export { default as SignalProvider } from './SignalProvider';
 export { default as LysQueryProvider } from './LysQueryProvider';
 export { default as LysMutationProvider } from './LysMutationProvider';
 export { default as ClientProvider } from './ClientProvider';
+export { default as RouteProvider } from './RouteProvider';
 export { useAlertMessages } from './AlertMessageProvider/hooks';
 export { useLocale } from './LocaleProvider/hooks';
 export { useLysDialog, useDialogWithUpdates } from './LysDialogProvider/hooks';
@@ -28,6 +29,10 @@ export { useLysMutation } from './LysMutationProvider/hooks';
 export { usePermissionCheck } from './hooks/usePermissionCheck';
 export { useRestrictedLink } from './hooks/useRestrictedLink';
 export type { RestrictedLink } from './hooks/useRestrictedLink';
+export { useRouteAccess } from './hooks/useRouteAccess';
+export { useRouteInfo } from './RouteProvider/hooks';
+export type { RouteContextValue } from './RouteProvider/hooks';
+export type { RouteProviderProps, RouteTemplateProps } from './RouteProvider';
 export { useClientId } from './ClientProvider/hooks';
 export type { ClientContextValue, ClientProviderProps } from './ClientProvider/types';
 export { default as LysLoadingContext, useLysLoadingFallback } from './LysQueryProvider/LysLoadingContext';

package/dist/providers/index.js

@@ -1,5 +1,5 @@
-import { A, C, a, b, c, E, F, G, L, d, e, f, g, P, R, S, U, W, u, h, i, j, k, l, m, n, o, p, q, r, s, t, v, w, x, y, z } from "../constants-BMsk7KvD.js";
-import { u as u2, a as a2 } from "../hooks-CvhFUowR.js";
+import { A, C, a, b, c, E, F, G, L, d, e, f, g, P, R, h, S, U, W, u, i, j, k, l, m, n, o, p, q, r, s, t, v, w, x, y, z, B, D, H } from "../constants-sdhUzJ0l.js";
+import { u as u2, a as a2 } from "../PublicAppTemplate-DLKcJZVR.js";
 import { c as c2 } from "../RelayEnvironment-D880U9SM.js";
 export {
   A as AlertMessageProvider,
@@ -17,30 +17,33 @@ export {
   g as LysQueryProvider,
   P as PageContextProvider,
   R as RefreshSignalContext,
+  h as RouteProvider,
   S as SignalProvider,
   U as UrlQueriesProvider,
   W as WebserviceAccessProvider,
   c2 as clearRelayCache,
   u as useAlertMessages,
   u2 as useChatbot,
-  h as useClientId,
+  i as useClientId,
   a2 as useConnectedUserInfo,
-  i as useDialogWithUpdates,
-  j as useFilterLabels,
-  k as useLocale,
-  l as useLysDialog,
-  m as useLysLoadingFallback,
-  n as useLysMutation,
-  o as useLysQuery,
-  p as usePageContext,
-  q as usePermissionCheck,
-  r as useRefreshSignal,
-  s as useRestrictedLink,
-  t as useSignal,
-  v as useSignalRefresh,
-  w as useSignalSubscription,
-  x as useUrlQueries,
-  y as useWebserviceAccess,
-  z as webserviceAccessProviderConfig
+  j as useDialogWithUpdates,
+  k as useFilterLabels,
+  l as useLocale,
+  m as useLysDialog,
+  n as useLysLoadingFallback,
+  o as useLysMutation,
+  p as useLysQuery,
+  q as usePageContext,
+  r as usePermissionCheck,
+  s as useRefreshSignal,
+  t as useRestrictedLink,
+  v as useRouteAccess,
+  w as useRouteInfo,
+  x as useSignal,
+  y as useSignalRefresh,
+  z as useSignalSubscription,
+  B as useUrlQueries,
+  D as useWebserviceAccess,
+  H as webserviceAccessProviderConfig
 };
 //# sourceMappingURL=index.js.map

package/dist/templates/index.js

@@ -1,4 +1,4 @@
-import { P } from "../PublicAppTemplate-B93G2Smc.js";
+import { P } from "../PublicAppTemplate-DLKcJZVR.js";
 export {
   P as PublicAppTemplate
 };

package/dist/types/descriptionTypes.d.ts

@@ -22,7 +22,13 @@ export type PageDescriptionType = ComponentDescriptionType & {
     options?: {
         [key: string]: string | number | boolean;
     };
-    mainWebserviceName?: string | undefined;
+    /**
+     * Webservice(s) gating access to the page.
+     * - `string`: single webservice — user needs access to it.
+     * - `string[]`: any-of semantics — user needs access to at least one.
+     * - `undefined`: page has no permission gate.
+     */
+    mainWebserviceName?: string | string[] | undefined;
     description?: string;
     chatbotBehaviour?: ChatbotBehaviourType;
     extraWebservices?: string[];

package/dist/types/routeTypes.d.ts

@@ -14,7 +14,13 @@ export interface RouteInterface {
     options?: {
         [key: string]: string | number | boolean;
     };
-    mainWebserviceName?: string | undefined;
+    /**
+     * Webservice(s) gating access to the route.
+     * - `string`: single webservice — user needs access to it.
+     * - `string[]`: any-of semantics — user needs access to at least one.
+     * - `undefined`: route has no permission gate.
+     */
+    mainWebserviceName?: string | string[] | undefined;
     description?: string;
     /** If true, the chatbot is automatically opened when the user enters this route. */
     autoOpenChatbot?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "runid-lys",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Frontend framework library for the lys ecosystem — providers, hooks, tools, and types for React applications",
   "keywords": [
     "react",

package/dist/PublicAppTemplate-B93G2Smc.js

@@ -1,26 +0,0 @@
-import { jsx, Fragment } from "react/jsx-runtime";
-import { useEffect } from "react";
-import { Navigate } from "react-router-dom";
-import { a as useConnectedUserInfo, u as useChatbot } from "./hooks-CvhFUowR.js";
-const PublicAppTemplate = ({
-  route,
-  defaultPrivateRoute,
-  children
-}) => {
-  var _a;
-  const { user } = useConnectedUserInfo();
-  const { setIsChatbotEnabled } = useChatbot();
-  useEffect(() => {
-    setIsChatbotEnabled(false);
-    return () => setIsChatbotEnabled(true);
-  }, [setIsChatbotEnabled]);
-  const isOpened = ((_a = route.options) == null ? void 0 : _a.opened) === true;
-  if (user && !isOpened) {
-    return /* @__PURE__ */ jsx(Navigate, { to: defaultPrivateRoute.path, replace: true });
-  }
-  return /* @__PURE__ */ jsx(Fragment, { children });
-};
-export {
-  PublicAppTemplate as P
-};
-//# sourceMappingURL=PublicAppTemplate-B93G2Smc.js.map

package/dist/PublicAppTemplate-B93G2Smc.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PublicAppTemplate-B93G2Smc.js","sources":["../src/templates/PublicAppTemplate.tsx"],"sourcesContent":["import * as React from \"react\";\nimport {useEffect} from \"react\";\nimport {Navigate} from \"react-router-dom\";\nimport {useConnectedUserInfo} from \"../providers/ConnectedUserProvider/hooks\";\nimport {useChatbot} from \"../providers/ChatbotProvider/hooks\";\nimport {RouteInterface} from \"../types/routeTypes\";\n\ninterface PublicAppTemplateProps {\n    route: RouteInterface\n    defaultPrivateRoute: RouteInterface\n    defaultPublicRoute: RouteInterface\n    children: React.ReactNode\n}\n\n/**\n * Public app template\n * Wraps public pages and redirects authenticated users to private area\n * Unless route.options?.opened is true (public pages accessible when connected)\n */\nconst PublicAppTemplate: React.ComponentType<PublicAppTemplateProps> = (\n    {\n        route,\n        defaultPrivateRoute,\n        children\n    }) => {\n\n    /*******************************************************************************************************************\n     *                                                  HOOKS\n     ******************************************************************************************************************/\n\n    const {user} = useConnectedUserInfo();\n    const {setIsChatbotEnabled} = useChatbot();\n\n    /*******************************************************************************************************************\n     *                                                  EFFECTS\n     ******************************************************************************************************************/\n\n    // Disable chatbot on public pages\n    useEffect(() => {\n        setIsChatbotEnabled(false);\n        return () => setIsChatbotEnabled(true);\n    }, [setIsChatbotEnabled]);\n\n    /*******************************************************************************************************************\n     *                                                  RENDER\n     ******************************************************************************************************************/\n\n    // Redirect authenticated users to private area (unless page is opened)\n    const isOpened = route.options?.opened === true;\n    if (user && !isOpened) {\n        return <Navigate to={defaultPrivateRoute.path} replace />;\n    }\n\n    return (\n        <>\n            {children}\n        </>\n    );\n};\n\nexport default PublicAppTemplate;\n"],"names":[],"mappings":";;;;AAmBA,MAAM,oBAAiE,CACnE;AAAA,EACI;AAAA,EACA;AAAA,EACA;AACJ,MAAM;;AAMN,QAAM,EAAC,KAAA,IAAQ,qBAAA;AACf,QAAM,EAAC,oBAAA,IAAuB,WAAA;AAO9B,YAAU,MAAM;AACZ,wBAAoB,KAAK;AACzB,WAAO,MAAM,oBAAoB,IAAI;AAAA,EACzC,GAAG,CAAC,mBAAmB,CAAC;AAOxB,QAAM,aAAW,WAAM,YAAN,mBAAe,YAAW;AAC3C,MAAI,QAAQ,CAAC,UAAU;AACnB,+BAAQ,UAAA,EAAS,IAAI,oBAAoB,MAAM,SAAO,MAAC;AAAA,EAC3D;AAEA,yCAES,UACL;AAER;"}

package/dist/hooks-CvhFUowR.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"hooks-CvhFUowR.js","sources":["../src/providers/ChatbotProvider/hooks.ts","../src/providers/ConnectedUserProvider/hooks.ts"],"sourcesContent":["import {createContext, useContext} from \"react\";\nimport {ChatbotContextValue} from \"./types\";\n\nexport const ChatbotContext = createContext<ChatbotContextValue | null>(null);\n\nexport const useChatbot = (): ChatbotContextValue => {\n    const context = useContext(ChatbotContext);\n    if (!context) {\n        throw new Error(\"useChatbot must be used within a ChatbotProvider\");\n    }\n    return context;\n};\n","import {createContext, useContext} from \"react\";\nimport {ConnectedUserInterface} from \"./types\";\n\n/**\n * Connected user context\n */\nconst ConnectedUserContext = createContext<{\n    user: ConnectedUserInterface | undefined\n    push(webservice: () => void): void\n    login: [(login: string, password: string) => void, boolean],\n    logout: [() => void, boolean],\n    refresh: [() => void, boolean],\n    handleSessionExpired: (onRefreshSuccess?: () => void) => void\n}>({\n    user: undefined,\n    push: () => {\n        console.warn(\"ConnectedUserProvider not initialized: push\")\n    },\n    login: [() => {\n        console.warn(\"ConnectedUserProvider not initialized: login\")\n    }, false],\n    logout: [() => {\n        console.warn(\"ConnectedUserProvider not initialized: logout\")\n    }, false],\n    refresh: [() => {\n        console.warn(\"ConnectedUserProvider not initialized: refresh\")\n    }, false],\n    handleSessionExpired: () => {\n        console.warn(\"ConnectedUserProvider not initialized: handleSessionExpired\")\n    }\n});\n\n/**\n * Hook to access connected user info\n */\nfunction useConnectedUserInfo() {\n    return useContext(ConnectedUserContext)\n}\n\nexport {\n    ConnectedUserContext,\n    useConnectedUserInfo\n}\n"],"names":[],"mappings":";AAGO,MAAM,iBAAiB,cAA0C,IAAI;AAErE,MAAM,aAAa,MAA2B;AACjD,QAAM,UAAU,WAAW,cAAc;AACzC,MAAI,CAAC,SAAS;AACV,UAAM,IAAI,MAAM,kDAAkD;AAAA,EACtE;AACA,SAAO;AACX;ACLA,MAAM,uBAAuB,cAO1B;AAAA,EACC,MAAM;AAAA,EACN,MAAM,MAAM;AACR,YAAQ,KAAK,6CAA6C;AAAA,EAC9D;AAAA,EACA,OAAO,CAAC,MAAM;AACV,YAAQ,KAAK,8CAA8C;AAAA,EAC/D,GAAG,KAAK;AAAA,EACR,QAAQ,CAAC,MAAM;AACX,YAAQ,KAAK,+CAA+C;AAAA,EAChE,GAAG,KAAK;AAAA,EACR,SAAS,CAAC,MAAM;AACZ,YAAQ,KAAK,gDAAgD;AAAA,EACjE,GAAG,KAAK;AAAA,EACR,sBAAsB,MAAM;AACxB,YAAQ,KAAK,6DAA6D;AAAA,EAC9E;AACJ,CAAC;AAKD,SAAS,uBAAuB;AAC5B,SAAO,WAAW,oBAAoB;AAC1C;"}