@rightkit/onboarding 0.3.2 → 0.3.3

package/README.md

@@ -20,9 +20,9 @@ First-run onboarding framework for Right Suite apps. The legal agreement gate co
 
 | Peer | Range |
 |---|---|
-| `@rightkit/app-shell` | `>=0.2.0 <1` |
+| `@rightkit/react-shell` | `>=0.2.0 <1` |
 | `@rightkit/legal-ui` | `>=0.1.2 <1` |
-| `react` | `>=18 <20` |
+| `react` | `>=18 <21` |
 
 ## Example
 
@@ -45,6 +45,10 @@ import "@rightkit/onboarding/onboarding.css";
 
 Acceptance is stored as `legalAcceptance: { version, documentsHash, acceptedAt, eligibilityBasis }`. An app that already keeps its own acceptance receipt can pass `legalReceipt` (`read()` and `write(record)`) and keep that store as the source of truth. Steps can set `canContinue(context)`.
 
+## When the legal gate re-prompts
+
+`isLegalAccepted(state, requiredVersion?, isAccepted?, requiredDocumentsHash?)` decides it, in this order: a custom `isAccepted` wins outright; a `requiredDocumentsHash` must equal the stored acceptance's `documentsHash`; a `requiredVersion` must equal its `version`; with neither, the stored `legalAccepted` flag is used. Pass `requiredDocumentsHash` (the hash of the material documents, from `@rightkit/legal`) to catch a text change that did not bump the version: without it only the version is compared. `documentsHash` is recorded with the acceptance and never compared; by default it covers document titles and URLs, not their text.
+
 ## Known issues
 
-- Peer React is `<20`, while `doc-render`, `i18n`, `media-ui` and `pdf-ui` accept `<21` (npm audit 2026-10-08).
+- Peer React is `<21`, the same range as `doc-render`, `i18n`, `media-ui` and `pdf-ui` (`package.json:29`).

package/dist/Onboarding.d.ts

@@ -1,5 +1,5 @@
 import type { OnboardingProps, PersistedOnboardingState } from "./types.js";
 /** True when the stored acceptance satisfies the host's requirement. */
-export declare function isLegalAccepted(state: PersistedOnboardingState, requiredVersion?: string, custom?: (state: PersistedOnboardingState) => boolean): boolean;
+export declare function isLegalAccepted(state: PersistedOnboardingState, requiredVersion?: string, custom?: (state: PersistedOnboardingState) => boolean, requiredDocumentsHash?: string): boolean;
 export declare function onboardingStateKey(): string;
-export declare function Onboarding({ settings, legal, steps, permissions, models, license, onComplete, onSkip, className, requiredVersion, isAccepted, documentsHash, beforeLegalGate, requireModel, autoStartDownload, shouldAutoStart, onModelsStepEnter, modelsIntro, allowSkip, titlebar, dragRegion, legalDragRegion, legalReceipt }: OnboardingProps): import("react").JSX.Element;
+export declare function Onboarding({ settings, legal, steps, permissions, models, license, onComplete, onSkip, className, requiredVersion, requiredDocumentsHash, isAccepted, documentsHash, beforeLegalGate, requireModel, autoStartDownload, shouldAutoStart, onModelsStepEnter, modelsIntro, allowSkip, titlebar, dragRegion, legalDragRegion, legalReceipt }: OnboardingProps): import("react").JSX.Element;

package/dist/Onboarding.js

@@ -1,7 +1,7 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { useCallback, useEffect, useMemo, useRef, useState } from "react";
 import { LegalGate } from "@rightkit/legal-ui";
-import { Button } from "@rightkit/app-shell/react";
+import { Button } from "@rightkit/react-shell/react";
 import { cx } from "./ui.js";
 import { licenseStep, modelsStep, permissionsStep } from "./steps.js";
 const KEY = "onboarding.state";
@@ -39,11 +39,17 @@ function withReceipt(state, record) {
     return record ? { ...rest, legalAccepted: true, eligibilityBasis: record.eligibilityBasis, legalAcceptance: record } : { ...rest, legalAccepted: false };
 }
 /** True when the stored acceptance satisfies the host's requirement. */
-export function isLegalAccepted(state, requiredVersion, custom) {
+export function isLegalAccepted(state, requiredVersion, custom, requiredDocumentsHash) {
     if (custom)
         return custom(state);
+    // A host that supplies the documents' hash is asking for the text itself to be what was accepted:
+    // a changed text re-prompts even when the version string did not move.
+    if (requiredDocumentsHash !== undefined && state.legalAcceptance?.documentsHash !== requiredDocumentsHash)
+        return false;
     if (requiredVersion !== undefined)
         return state.legalAcceptance?.version === requiredVersion;
+    if (requiredDocumentsHash !== undefined)
+        return state.legalAcceptance !== undefined;
     return state.legalAccepted;
 }
 /** FNV-1a fallback when SubtleCrypto is unavailable. */
@@ -73,7 +79,7 @@ function TitleStrip({ titlebar, dragRegion }) {
         return null;
     return _jsx("div", { className: "rk-onboarding__titlebar", "data-testid": "onboarding-titlebar", ...(dragRegion ? { "data-tauri-drag-region": "" } : {}), children: titlebar });
 }
-export function Onboarding({ settings, legal, steps = [], permissions, models, license, onComplete, onSkip, className, requiredVersion, isAccepted, documentsHash, beforeLegalGate, requireModel, autoStartDownload, shouldAutoStart, onModelsStepEnter, modelsIntro, allowSkip = true, titlebar, dragRegion, legalDragRegion = false, legalReceipt }) {
+export function Onboarding({ settings, legal, steps = [], permissions, models, license, onComplete, onSkip, className, requiredVersion, requiredDocumentsHash, isAccepted, documentsHash, beforeLegalGate, requireModel, autoStartDownload, shouldAutoStart, onModelsStepEnter, modelsIntro, allowSkip = true, titlebar, dragRegion, legalDragRegion = false, legalReceipt }) {
     const [state, setState] = useState(null);
     const [saving, setSaving] = useState(false);
     const [error, setError] = useState(null);
@@ -145,7 +151,7 @@ export function Onboarding({ settings, legal, steps = [], permissions, models, l
         ...steps,
     ], [license, models, permissions, steps, requireModel, autoStartDownload, shouldAutoStart, onModelsStepEnter, modelsIntro]);
     const activeState = state ?? INITIAL;
-    const accepted = isLegalAccepted(activeState, requiredVersion, isAccepted);
+    const accepted = isLegalAccepted(activeState, requiredVersion, isAccepted, requiredDocumentsHash);
     const needsGate = state !== null && !accepted;
     // The agreement gate does not depend on the saved step: until it is accepted, the active step is the first.
     // Once accepted, the Agreement step (index 0) is never shown again when other steps exist.
@@ -199,7 +205,7 @@ export function Onboarding({ settings, legal, steps = [], permissions, models, l
             return _jsxs("div", { className: cx("rk-onboarding", className), "aria-busy": "true", children: [_jsx(TitleStrip, { titlebar: titlebar, dragRegion: legalDragRegion }), _jsx("p", { className: "rk-onboarding__muted", children: "Loading setup\u2026" })] });
         const reacceptance = activeState.legalAccepted || activeState.legalAcceptance !== undefined;
         return _jsxs("div", { className: cx("rk-onboarding rk-onboarding--legal", className), "data-testid": "onboarding-legal", "data-variant": reacceptance ? "re-acceptance" : "first-run", children: [_jsx(TitleStrip, { titlebar: titlebar, dragRegion: legalDragRegion }), _jsx(LegalGate, { ...legal, variant: reacceptance ? "re-acceptance" : "first-run", onQuit: () => void legal.onQuit?.(), onAgree: async ({ eligibilityBasis }) => {
-                        const legalAcceptance = { version: requiredVersion ?? "1", documentsHash: documentsHash ?? await hashDocuments(legal.documents), acceptedAt: new Date().toISOString(), eligibilityBasis };
+                        const legalAcceptance = { version: requiredVersion ?? "1", documentsHash: documentsHash ?? requiredDocumentsHash ?? await hashDocuments(legal.documents), acceptedAt: new Date().toISOString(), eligibilityBasis };
                         if (legalReceipt) {
                             try {
                                 await legalReceipt.write(legalAcceptance);

package/dist/steps.js

@@ -1,6 +1,6 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { useCallback, useEffect, useRef, useState } from "react";
-import { Button, Input, Badge } from "@rightkit/app-shell/react";
+import { Button, Input, Badge } from "@rightkit/react-shell/react";
 function ProgressBar({ value, label }) {
     const pct = Math.max(0, Math.min(1, value));
     return _jsx("div", { className: "rk-onboarding__progress", role: "progressbar", "aria-label": label, "aria-valuemin": 0, "aria-valuemax": 100, "aria-valuenow": Math.round(pct * 100), children: _jsx("i", { style: { width: `${pct * 100}%` } }) });

package/dist/types.d.ts

@@ -5,7 +5,7 @@ export interface SettingsSnapshot {
     values: SettingsValues;
     revision: number;
 }
-/** Structural port shared with @rightkit/settings-ui and rightkit-settings. */
+/** Structural port shared with @rightkit/settings-ui and rightkit-app-settings. */
 export interface SettingsBackend {
     load(): Promise<SettingsSnapshot>;
     patch(patch: SettingsValues, expectedRevision?: number): Promise<SettingsSnapshot>;
@@ -129,7 +129,13 @@ export interface OnboardingProps {
     requiredVersion?: string;
     /** Custom acceptance check; takes precedence over `requiredVersion`. */
     isAccepted?: (state: PersistedOnboardingState) => boolean;
-    /** Hash of the legal documents recorded with the acceptance. Default: hash of document titles and URLs. */
+    /**
+     * Hash the stored acceptance must carry. A stored acceptance with a different (or no) hash re-prompts even when
+     * the version is unchanged, so a text change without a version bump is caught. Pass the hash of the MATERIAL
+     * documents only (see `@rightkit/legal`), not of appendices that regenerate on dependency bumps.
+     */
+    requiredDocumentsHash?: string;
+    /** Hash of the legal documents recorded with the acceptance. Default: `requiredDocumentsHash`, else a hash of document titles and URLs. Recorded only; never compared. */
     documentsHash?: string;
     /** Runs (and is awaited) before the legal gate is shown, e.g. to resize or reveal the window. */
     beforeLegalGate?: () => void | Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rightkit/onboarding",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "First-run onboarding framework: ordered steps, progress, skip/resume, legal gate first, permissions, model download and licence/trial steps.",
   "license": "MIT OR Apache-2.0",
   "type": "module",
@@ -24,14 +24,14 @@
     "*.css"
   ],
   "peerDependencies": {
-    "@rightkit/app-shell": ">=0.2.0 <1",
+    "@rightkit/react-shell": ">=0.2.0 <1",
     "@rightkit/legal-ui": ">=0.1.2 <1",
     "react": ">=18 <21"
   },
   "devDependencies": {
-    "@rightkit/app-shell": "0.4.1",
-    "@rightkit/legal-ui": "0.2.0",
-    "@rightkit/qa-chrome": "0.1.3",
+    "@rightkit/react-shell": "0.6.4",
+    "@rightkit/legal-ui": "0.2.2",
+    "@rightkit/qa-chrome": "0.1.6",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.1.0",
     "@testing-library/user-event": "^14.5.2",
@@ -50,7 +50,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bogusyogi/rightkit.git",
+    "url": "git+https://github.com/Orthic-Labs/rightkit.git",
     "directory": "packages/onboarding"
   },
   "scripts": {