@bndynet/vue-site 1.3.2 → 1.4.1

package/dist/types.d.ts

@@ -11,7 +11,7 @@ import { RouteLocationNormalized } from 'vue-router';
 export type AuthRule = boolean | string | string[] | ((ctx: AuthContext) => boolean | Promise<boolean>);
 /**
  * Context passed to `SiteConfig.auth.authorize`. `to` / `from` are present when the guard runs
- * during navigation; they are absent during the one-time startup pass that filters the nav menu.
+ * during navigation; they are absent while filtering the nav menu.
  */
 export interface AuthContext {
     /** The `auth` rule declared on the matched nav / standalone item. */
@@ -28,8 +28,8 @@ export interface AuthConfig {
     /**
      * Decide whether the current user may access a route carrying `rule`. Return `true` to allow,
      * `false` to deny, or a path string to redirect (e.g. your login page). Runs at navigation time
-     * on every guarded route, and once at startup (with only `rule` / `item`) to filter the nav menu
-     * — there, any result other than `true` hides the item.
+     * on every guarded route, and whenever the auth-filtered nav menu is refreshed (with only
+     * `rule` / `item`) — there, any result other than `true` hides the item.
      */
     authorize: (ctx: AuthContext) => boolean | string | Promise<boolean | string>;
     /**
@@ -93,7 +93,7 @@ export interface NavItem {
      * Per-page authorization rule, interpreted by `SiteConfig.auth.authorize`. Unlike `visible`
      * (a build/startup-time existence switch), `auth` keeps the route registered and is enforced by
      * a navigation guard on every navigation, so it reacts to login/logout and can redirect to a
-     * login page. It is also evaluated once at startup to hide unauthorized items from the menu.
+     * login page. It is also evaluated for the menu whenever auth navigation is refreshed.
      * Requires `SiteConfig.auth` to be set; otherwise it is ignored.
      */
     auth?: AuthRule;
@@ -331,6 +331,14 @@ export interface ShellConfig {
      */
     align?: 'left' | 'center' | 'right';
 }
+/**
+ * Consumer-defined public configuration exposed through `useSiteConfig().config.custom`.
+ * Extend this interface with TypeScript module augmentation to type application-specific keys.
+ * Values are bundled into client code and must not contain secrets.
+ */
+export interface SiteCustomConfig {
+    [key: string]: unknown;
+}
 export interface SiteConfig {
     /** Site title (browser tab + header). Accepts a `LocalizedString` for multi-language sites. */
     title: LocalizedString;
@@ -364,7 +372,7 @@ export interface SiteConfig {
     /**
      * Central authorization policy. When set, any `NavItem` / `StandalonePage` carrying an `auth`
      * rule is enforced by a navigation guard (redirecting to `auth.loginPath` on denial) and hidden
-     * from the nav menu at startup when not authorized. Omit to disable authorization entirely.
+     * from the nav menu when not authorized. Omit to disable authorization entirely.
      */
     auth?: AuthConfig;
     /** Router history configuration (hash vs HTML5). See `RouterConfig`. */
@@ -408,6 +416,12 @@ export interface SiteConfig {
     baseUrl?: string;
     /** Development / build environment configuration */
     env?: SiteEnvConfig;
+    /**
+     * Consumer-defined public configuration. The framework preserves these values without
+     * interpreting them and exposes them through `useSiteConfig().config.custom`. Values are
+     * bundled into client code and must not contain secrets.
+     */
+    custom?: SiteCustomConfig;
     /**
      * Same as `env.watchPackages` (CLI only). Used when `env.watchPackages` is omitted.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bndynet/vue-site",
-  "version": "1.3.2",
+  "version": "1.4.1",
   "type": "module",
   "description": "A configurable Vue 3 site framework with sidebar navigation, markdown rendering, and theme switching.",
   "repository": {
@@ -34,7 +34,7 @@
     "lint": "node -e \"process.exit(0)\"",
     "clean": "rimraf dist example/example-dist",
     "build:lib": "vite build",
-    "build:lib:watch": "vite build --watch",
+    "build:lib:watch": "vite build --watch --emptyOutDir false",
     "dev:example": "npm --prefix example run dev",
     "dev": "npm run build:lib && concurrently -k -n lib,example -c blue,magenta \"npm run build:lib:watch\" \"npm run dev:example\"",
     "build": "npm run build:lib && npm install --prefix example && npm run build --prefix example",