@rightkit/document-workspace 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.1.1
+
+- Ask 5: host contract documented in `README.md`: legal data is passed in with `configureLegal({ manifest, contract })`, product name with `setHostAppName()`, the DOCX host-toolbar patch requirement, and `VITE_RIGHTKIT_BROWSER_QA`. The `@rightkit-host` alias is documented as the test-fixture alias only; the README previously described it as the host's data path, which the code does not use.
+- Ask 4: pins `prosemirror-view` 1.42.8 (was 1.42.6).
+- Wording fix in the published section comments; no behaviour change.
+
 ## 0.1.0
 
 - First release. Multi-format document workspace shell: tabs, sidebar, document router, loaders, savers and actions.

package/README.md

@@ -24,18 +24,41 @@ Multi-format document workspace shell: tabs, sidebar, document router, loaders,
 
 `react`, `react-dom`
 
-## Host data
+## Host data (legal)
 
-Legal and version data stay in the host app. Alias `@rightkit-host` to the host project root
-(Vite `resolve.alias`); the package imports `@rightkit-host/legal/legal-manifest.json`,
-`@rightkit-host/src/generated/legal-contract.json`, `@rightkit-host/package.json` and
-`@rightkit-host/legal/*.md?raw` where it needs them.
+The package does not import the host's legal files. The host passes them in once at startup with
+`configureLegal({ manifest, contract })` (exported from the root and from `state/legal`):
+
+- `manifest`: the host's `legal/legal-manifest.json`, parsed. It must have a `documents` array.
+- `contract`: the host's generated `legal-contract.json`, with `acceptanceVersion` and `materialSha256` strings.
+
+Until `configureLegal` runs, the legal exports (`REQUIRED_LEGAL_ACCEPTANCE_VERSION`,
+`LEGAL_MATERIAL_SHA256`, `LEGAL_GATE_DOCUMENTS`, `LEGAL_ABOUT_LINKS`) are empty or unset, so call it
+before the first render. The exports are live bindings, so every importer sees the configured values.
+
+The `@rightkit-host` alias is only used by this package's own test fixture (`test/host-fixture`,
+set in `vitest.config.ts`). The `@rightkit-host/*` module declarations in `src/env.d.ts` describe the
+same files for type-checking; a host does not need to alias them to run the package.
 
 ## Product name
 
 User-facing copy reads the product name from `hostAppName()` (default `"App"`). Call
 `setHostAppName("Your App")` (exported from the root and from `appName`) once at startup, before
-rendering.
+rendering. Accent preset names and copy are read at display time, so the order matters only for
+values the host reads at import.
+
+## Host toolbar (DOCX)
+
+The DOCX pane uses `@rightkit/docx-editor`, which needs the host-toolbar patch on
+`@eigenpal/docx-editor-react@1.9.0` (see that package's README). Until the workspace root registers
+the patch, a host must apply it or the DOCX pane shows the editor's built-in toolbar.
+
+## Host configuration (environment and state)
+
+- `VITE_RIGHTKIT_BROWSER_QA=1` at build time enables browser-QA fixtures. A host's QA build sets
+  it; release builds leave it unset.
+- The ProseMirror packages used here (`prosemirror-view` and `prosemirror-transform`) are pinned exactly in the
+  dependent packages. A host must not install a second copy of either, or plugin keys break.
 
 ## Host contract
 

package/dist/settings/publishedSections.d.ts

@@ -6,7 +6,7 @@ export declare function AboutFrame({ card, panels }: {
     card: React.ReactNode;
     panels: React.ReactNode;
 }): import("react").JSX.Element;
-/** Renders the published licenseSection body (status, verify, deactivate, activate, purchase rows) under the the host app token map. */
+/** Renders the published licenseSection body (status, verify, deactivate, activate, purchase rows) under the host app token map. */
 export declare function PublishedLicense({ section }: {
     section: SettingsSection;
 }): import("react").JSX.Element;

package/dist/settings/publishedSections.js

@@ -24,7 +24,7 @@ function useRkContext() {
         };
     }, [settings.autoCheckUpdates, update]);
 }
-/** Renders a published section body under the the host app token map. */
+/** Renders a published section body under the host app token map. */
 function RkSection({ section, ctx, children }) {
     return (_jsxs("div", { className: "vr-rk", children: [section.render(ctx), children] }));
 }
@@ -66,7 +66,7 @@ export function AboutFrame({ card, panels }) {
     const section = useMemo(() => aboutSection({ appName: hostAppName(), version: APP_VERSION, card, panels }), [card, panels]);
     return _jsx(RkSection, { section: section, ctx: ctx });
 }
-/** Renders the published licenseSection body (status, verify, deactivate, activate, purchase rows) under the the host app token map. */
+/** Renders the published licenseSection body (status, verify, deactivate, activate, purchase rows) under the host app token map. */
 export function PublishedLicense({ section }) {
     const ctx = useRkContext();
     return _jsx(RkSection, { section: section, ctx: ctx });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rightkit/document-workspace",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Multi-format document workspace shell: tabs, sidebar, document router, loaders, savers and actions.",
   "license": "MIT OR Apache-2.0",
   "type": "module",
@@ -38,13 +38,13 @@
     "@lezer/highlight": "^1.2.5",
     "@phosphor-icons/react": "^2.1.10",
     "@rightkit/app-update": "^0.4.2",
-    "@rightkit/document-core": "^0.1.0",
-    "@rightkit/docx-editor": "^0.1.0",
-    "@rightkit/html-editor": "^0.1.0",
+    "@rightkit/document-core": "^0.1.1",
+    "@rightkit/docx-editor": "^0.1.1",
+    "@rightkit/html-editor": "^0.1.1",
     "@rightkit/legal": "^0.6.3",
     "@rightkit/legal-ui": "^0.4.1",
     "@rightkit/license": "^0.3.0",
-    "@rightkit/markdown-editor": "^0.1.0",
+    "@rightkit/markdown-editor": "^0.1.1",
     "@rightkit/media-ui": "^0.3.4",
     "@rightkit/onboarding": "^0.6.3",
     "@rightkit/platform-ui": "^0.4.0",
@@ -53,7 +53,7 @@
     "@tauri-apps/api": "^2.12.2",
     "@tauri-apps/plugin-process": "^2.4.0",
     "prosemirror-state": "^1.4.4",
-    "prosemirror-view": "1.42.6",
+    "prosemirror-view": "1.42.8",
     "tailwindcss": "^4.3.3"
   },
   "peerDependencies": {