@arbidocs/blocks 0.4.97 → 0.4.99

package/dist/docx/template/HouseTemplate.d.ts

@@ -0,0 +1,64 @@
+/**
+ * The house template inside the Word editor: which template applies (the workspace's, else the
+ * deployment's, else ARBI's built-in legal template), its Quick Parts, and where this document's
+ * styles have drifted from it. Mount `HouseTemplateProvider` inside `DocxEditor.Root`; the ribbon's
+ * Quick Parts, Design tab and the style box read it from context.
+ */
+import React from 'react';
+import { type LinkedLevel, type BuildingBlockInfo, type StyleDivergence } from '@arbidocs/coedit/template';
+export type HouseTemplateSource = 'workspace' | 'deployment' | 'builtin';
+export interface HouseTemplate {
+    /** The .dotx/.docx bytes. */
+    bytes: Uint8Array;
+    /** What to call it: its filename, or "ARBI legal template". */
+    name: string;
+    source: HouseTemplateSource;
+    /** The workspace document it is, when it is one. */
+    documentId?: string;
+}
+/** How the host stores and resolves house templates. */
+export interface HouseTemplateHost {
+    /** The template that applies in this workspace. Falls back to the built-in one when it fails. */
+    load: () => Promise<HouseTemplate>;
+    /**
+     * Make a workspace document the workspace's house template. Present only when the user may
+     * (a workspace owner) and the server stores house templates.
+     */
+    setFromDocument?: (documentId: string) => Promise<void>;
+}
+export declare const BUILTIN_TEMPLATE_NAME = "ARBI legal template";
+/** The file name a document records as its attached template (`w:attachedTemplate`). */
+export declare const templateFileName: (t: Pick<HouseTemplate, "name">) => string;
+/** ARBI's built-in UK legal template, with its Quick Parts. */
+export declare function builtinHouseTemplate(): HouseTemplate;
+/** The template a host resolves, or the built-in one when there is no host or it fails. */
+export declare function resolveHouseTemplate(host?: HouseTemplateHost): Promise<HouseTemplate>;
+interface HouseTemplateContextValue {
+    template: HouseTemplate;
+    blocks: readonly BuildingBlockInfo[];
+    /** Null until measured (or for a document that cannot be read). */
+    divergence: StyleDivergence | null;
+    /** The document was started from this template (it records it as attached). */
+    basedOnTemplate: boolean;
+    /** Outline levels linked to styles in this document (Level 1 → Level 2 …), by style id. */
+    levels: Readonly<Record<string, LinkedLevel>>;
+    /** Insert a Quick Part at the caret, with the styles, numbering and pictures it uses. */
+    insertBlock: (name: string) => boolean;
+    /** Measure the divergence again (after something brought styles in). */
+    refresh: () => void;
+    /** Present when this document may become the workspace's house template. */
+    setAsHouseTemplate?: () => Promise<void>;
+    editable: boolean;
+}
+export declare const useHouseTemplate: () => HouseTemplateContextValue | null;
+export declare function HouseTemplateProvider({ host, documentId, editable, notify, enabled, children, }: {
+    /** False for a generating draft: no template chrome, no measuring. */
+    enabled?: boolean;
+    host?: HouseTemplateHost;
+    /** The stored document this editor shows; absent for an unsaved note. */
+    documentId?: string;
+    editable: boolean;
+    notify?: (message: string, kind: 'success' | 'error') => void;
+    children: React.ReactNode;
+}): React.JSX.Element;
+export {};

package/dist/docx/template/HouseTemplatePanel.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Design › House template: which template new documents start from, whether this document's
+ * styles still match it, and — for a workspace owner — making this document the house template.
+ */
+import React from 'react';
+export declare function HouseTemplatePanel(): React.JSX.Element | null;

package/dist/docx/template/QuickParts.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Insert › Quick Parts: the house template's building blocks (execution blocks, document markings,
+ * document skeletons) by category, each with a preview of its text; picking one inserts it at the
+ * caret with the styles, numbering and pictures it uses.
+ */
+import React from 'react';
+export declare function QuickParts(): React.JSX.Element | null;

package/dist/docx/wordStyles.d.ts

@@ -4,6 +4,7 @@
  * styles and notes.
  */
 import type { ParagraphStyleOption } from '@docx-editor.dev/react';
+import type { StyleDivergence } from '@arbidocs/coedit/template';
 /** Word's quick picks, by the built-in style names `styles.xml` gives them. */
 export declare const QUICK_STYLES: readonly ["Normal", "Title", "heading 1", "heading 2", "heading 3"];
 /**
@@ -19,3 +20,5 @@ export declare function styleLabel(name: string): string;
  * Ctrl+Shift+N; read from `code` so a keyboard layout cannot move them.
  */
 export declare function wordShortcut(event: Pick<KeyboardEvent, 'ctrlKey' | 'metaKey' | 'altKey' | 'shiftKey' | 'code'>): 'footnote' | 'endnote' | 'heading 1' | 'heading 2' | 'heading 3' | 'Normal' | null;
+/** A summary of how the document differs, for a tooltip; null when it matches. */
+export declare function divergenceSummary(divergence: StyleDivergence | null): string | null;

package/dist/index.cjs

@@ -2,16 +2,16 @@
 'use strict';
 
 var chunkQI6AIHWP_cjs = require('./chunk-QI6AIHWP.cjs');
-var chunk46IU3UPF_cjs = require('./chunk-46IU3UPF.cjs');
 var chunkHBF4BDRU_cjs = require('./chunk-HBF4BDRU.cjs');
+var chunk46IU3UPF_cjs = require('./chunk-46IU3UPF.cjs');
 var chunk65THHQVB_cjs = require('./chunk-65THHQVB.cjs');
 var chunk7QDX2CO4_cjs = require('./chunk-7QDX2CO4.cjs');
 var chunkMJCCBMM5_cjs = require('./chunk-MJCCBMM5.cjs');
 var chunkELR74ME6_cjs = require('./chunk-ELR74ME6.cjs');
 var chunkXAJIKT6Y_cjs = require('./chunk-XAJIKT6Y.cjs');
 var chunkLENXDIMY_cjs = require('./chunk-LENXDIMY.cjs');
-var chunkAOFATOT3_cjs = require('./chunk-AOFATOT3.cjs');
 var chunkD54JXTPG_cjs = require('./chunk-D54JXTPG.cjs');
+var chunkAOFATOT3_cjs = require('./chunk-AOFATOT3.cjs');
 var chunkOUW6G4O2_cjs = require('./chunk-OUW6G4O2.cjs');
 var chunkVPPX5XUF_cjs = require('./chunk-VPPX5XUF.cjs');
 require('./chunk-RC25WMVB.cjs');
@@ -966,10 +966,6 @@ Object.defineProperty(exports, "stripMarkdownLinks", {
   enumerable: true,
   get: function () { return chunkQI6AIHWP_cjs.stripMarkdownLinks; }
 });
-Object.defineProperty(exports, "UsageMeter", {
-  enumerable: true,
-  get: function () { return chunk46IU3UPF_cjs.UsageMeter; }
-});
 Object.defineProperty(exports, "ActionCluster", {
   enumerable: true,
   get: function () { return chunkHBF4BDRU_cjs.ActionCluster; }
@@ -1146,6 +1142,10 @@ Object.defineProperty(exports, "workspaceKindMeta", {
   enumerable: true,
   get: function () { return chunkHBF4BDRU_cjs.workspaceKindMeta; }
 });
+Object.defineProperty(exports, "UsageMeter", {
+  enumerable: true,
+  get: function () { return chunk46IU3UPF_cjs.UsageMeter; }
+});
 Object.defineProperty(exports, "ArticleList", {
   enumerable: true,
   get: function () { return chunk65THHQVB_cjs.ArticleList; }
@@ -1514,6 +1514,46 @@ Object.defineProperty(exports, "workspaceActivityTarget", {
   enumerable: true,
   get: function () { return chunkLENXDIMY_cjs.workspaceActivityTarget; }
 });
+Object.defineProperty(exports, "DEFAULT_DETAIL_PANEL_LABELS", {
+  enumerable: true,
+  get: function () { return chunkD54JXTPG_cjs.DEFAULT_DETAIL_PANEL_LABELS; }
+});
+Object.defineProperty(exports, "DetailBody", {
+  enumerable: true,
+  get: function () { return chunkD54JXTPG_cjs.DetailBody; }
+});
+Object.defineProperty(exports, "DetailEmpty", {
+  enumerable: true,
+  get: function () { return chunkD54JXTPG_cjs.DetailEmpty; }
+});
+Object.defineProperty(exports, "DetailField", {
+  enumerable: true,
+  get: function () { return chunkD54JXTPG_cjs.DetailField; }
+});
+Object.defineProperty(exports, "DetailFields", {
+  enumerable: true,
+  get: function () { return chunkD54JXTPG_cjs.DetailFields; }
+});
+Object.defineProperty(exports, "DetailLinkItem", {
+  enumerable: true,
+  get: function () { return chunkD54JXTPG_cjs.DetailLinkItem; }
+});
+Object.defineProperty(exports, "DetailLinkList", {
+  enumerable: true,
+  get: function () { return chunkD54JXTPG_cjs.DetailLinkList; }
+});
+Object.defineProperty(exports, "DetailLoading", {
+  enumerable: true,
+  get: function () { return chunkD54JXTPG_cjs.DetailLoading; }
+});
+Object.defineProperty(exports, "DetailPanel", {
+  enumerable: true,
+  get: function () { return chunkD54JXTPG_cjs.DetailPanel; }
+});
+Object.defineProperty(exports, "DetailSection", {
+  enumerable: true,
+  get: function () { return chunkD54JXTPG_cjs.DetailSection; }
+});
 Object.defineProperty(exports, "DEFINITIONS_LABEL", {
   enumerable: true,
   get: function () { return chunkAOFATOT3_cjs.DEFINITIONS_LABEL; }
@@ -1562,46 +1602,6 @@ Object.defineProperty(exports, "toDefinition", {
   enumerable: true,
   get: function () { return chunkAOFATOT3_cjs.toDefinition; }
 });
-Object.defineProperty(exports, "DEFAULT_DETAIL_PANEL_LABELS", {
-  enumerable: true,
-  get: function () { return chunkD54JXTPG_cjs.DEFAULT_DETAIL_PANEL_LABELS; }
-});
-Object.defineProperty(exports, "DetailBody", {
-  enumerable: true,
-  get: function () { return chunkD54JXTPG_cjs.DetailBody; }
-});
-Object.defineProperty(exports, "DetailEmpty", {
-  enumerable: true,
-  get: function () { return chunkD54JXTPG_cjs.DetailEmpty; }
-});
-Object.defineProperty(exports, "DetailField", {
-  enumerable: true,
-  get: function () { return chunkD54JXTPG_cjs.DetailField; }
-});
-Object.defineProperty(exports, "DetailFields", {
-  enumerable: true,
-  get: function () { return chunkD54JXTPG_cjs.DetailFields; }
-});
-Object.defineProperty(exports, "DetailLinkItem", {
-  enumerable: true,
-  get: function () { return chunkD54JXTPG_cjs.DetailLinkItem; }
-});
-Object.defineProperty(exports, "DetailLinkList", {
-  enumerable: true,
-  get: function () { return chunkD54JXTPG_cjs.DetailLinkList; }
-});
-Object.defineProperty(exports, "DetailLoading", {
-  enumerable: true,
-  get: function () { return chunkD54JXTPG_cjs.DetailLoading; }
-});
-Object.defineProperty(exports, "DetailPanel", {
-  enumerable: true,
-  get: function () { return chunkD54JXTPG_cjs.DetailPanel; }
-});
-Object.defineProperty(exports, "DetailSection", {
-  enumerable: true,
-  get: function () { return chunkD54JXTPG_cjs.DetailSection; }
-});
 Object.defineProperty(exports, "DEFAULT_SEARCH_HIT_LABELS", {
   enumerable: true,
   get: function () { return chunkOUW6G4O2_cjs.DEFAULT_SEARCH_HIT_LABELS; }

package/dist/index.js

@@ -1,7 +1,7 @@
 "use client";
 export { ApplyLabelButton, ApplyLabelDialog, DEFAULT_APPLY_LABEL_DIALOG_LABELS, DEFAULT_RELEVANCE_STEPS, DEFAULT_SEARCH_BAR_LABELS, DEFAULT_SEARCH_EMPTY_STATE_LABELS, DEFAULT_SEARCH_GROUP_HEADER_LABELS, DEFAULT_SEARCH_NO_RESULTS_LABELS, DEFAULT_SEARCH_PAGINATION_LABELS, DEFAULT_SEARCH_TOTALS_LABELS, DOCUMENT_SEARCH_NOUNS, Highlight, RelevanceThreshold, SearchBar, SearchControlsBar, SearchEmptyState, SearchErrorBanner, SearchGroupCard, SearchGroupHeader, SearchNoResults, SearchPageBody, SearchPageFrame, SearchPageHeader, SearchPagination, SearchPillToggle, SearchResultList, SearchResultsInner, SearchResultsMain, SearchToolbarRow, SearchTotalsHeadline, getPageNumbers, highlightTerms, searchNouns, splitByTerms, stripMarkdownLinks } from './chunk-2MJWWPHY.js';
-export { UsageMeter } from './chunk-D5T53XCL.js';
 export { ActionCluster, AskField, AskRow, AskTrigger, DEFAULT_ASK_FIELD_LABELS, DEFAULT_INSTALL_PROMPT_LABELS, DEFAULT_MOBILE_BARS_LABELS, DEFAULT_OFFLINE_PILL_LABELS, DEFAULT_REMOTE_CONTROL_PILL_LABELS, DEFAULT_SIDEBAR_LABELS, DEFAULT_TIP_CARD_LABELS, DEFAULT_WORKSPACE_KIND_LABELS, DEFAULT_WORKSPACE_SWITCHER_LABELS, INSTALL_PROMPT_DISMISSED_KEY, InfoBar, InstallPrompt, MobileAppBar, MobileTabBar, NotificationBell, OfflinePill, RemoteControlPill, STATUS_ROW_BASE_CLASS, STATUS_ROW_TONES, Sidebar, SidebarBadgeRow, SidebarRowAction, SidebarRowHoverContext, SplitLayout, StatusBadge, StatusRow, TipCard, UserMenu, WorkspaceIdentity, WorkspaceSwitcher, getInstallInstructions, initInstallPrompt, isIosDevice, promptAppInstall, resolveSidebarLayout, useInstallPrompt, useSidebarContext, useSidebarSettle, workspaceKindColor, workspaceKindMeta } from './chunk-VLOPZHFH.js';
+export { UsageMeter } from './chunk-D5T53XCL.js';
 export { ArticleList, Chart, CheckList, CollectionDetail, CtaBand, DefinitionList, EditorialHeading, EditorialHero, EditorialProse, EditorialSection, Eyebrow, PanelGrid, ProofStrip, PullQuote, Reveal, TagList } from './chunk-LYUO3E6V.js';
 export { DataTable, DataTableBlock, MetricCard, PageHeader, StatGroup } from './chunk-ZCF2JJFA.js';
 export { Accordion, AvatarBlock, Banner, BlockImage, BlockLink, CTABanner, Columns, ContactForm, Container, FAQ, FONT_PAIRINGS, FeatureGrid, Footer, Gallery, Hero, ListBlock, LogoCloud, MediaText, Navbar, PricingTable, ProfileCard, RichTextBlock, SectionHeading, Spacer, Steps, THEME_STYLE_ID, Tabs, TeamGrid, Testimonial, TestimonialGrid, ThemeEditor, VideoEmbed, applyFontVars, applyStoredTheme, applyThemeVars, clearFontVars, clearThemeVars, createThemeStore, fontPackages, getFontPairing, matchFontPairing, tid, toEmbedUrl, toHslTriplet } from './chunk-DLBUFHLY.js';
@@ -9,10 +9,10 @@ export { Timeline } from './chunk-OVEQERPO.js';
 export { MemberAvatarStack } from './chunk-XNOASBGW.js';
 import { DEFAULT_TAG_TABLE_LABELS, rowLinks, TagTableCell } from './chunk-Z3G65XHZ.js';
 export { DEFAULT_TAG_COLUMNS_EDITOR_LABELS, DEFAULT_TAG_TABLE_DOCX_LABELS, DEFAULT_TAG_TABLE_LABELS, DEFAULT_THREAD_FOLLOW_LABELS, DEFAULT_WORKSPACE_ACTIVITY_LABELS, DEFAULT_WORKSPACE_NOTIFICATION_MENU_LABELS, TAG_TABLE_DOCX_LANDSCAPE_AFTER, TagColumnsEditor, TagTable, TagTableCell, ThreadFollowButton, ThreadFollowMenuItem, WorkspaceActivityList, WorkspaceNotificationMenu, cellText, cellValue, fieldWrites, isGap, parseCell, rowLinks, tagTableDocumentXml, tagTableDocx, tagTableMarkdown, workspaceActivityHeadline, workspaceActivityTarget } from './chunk-Z3G65XHZ.js';
-import { groupDefinitions, compareDefinitions, minuteUtc, page, cell, documentXml, paragraph, docxPackage, TABLE_DOCUMENT_STYLES } from './chunk-D3QPYKZG.js';
-export { DEFINITIONS_LABEL, DEFINITION_BOOKMARK_PREFIX, compareDefinitions, compareTerms, definitionBookmark, definitionIdOfBookmark, definitionLabels, filterTermGroups, groupDefinitions, parseDefinition, termKey, toDefinition } from './chunk-D3QPYKZG.js';
 import { DetailLoading, DetailBody, DetailSection, DetailFields, DetailField, DetailLinkList, DetailLinkItem, DetailEmpty } from './chunk-ZCOVDK2E.js';
 export { DEFAULT_DETAIL_PANEL_LABELS, DetailBody, DetailEmpty, DetailField, DetailFields, DetailLinkItem, DetailLinkList, DetailLoading, DetailPanel, DetailSection } from './chunk-ZCOVDK2E.js';
+import { groupDefinitions, compareDefinitions, minuteUtc, page, cell, documentXml, paragraph, docxPackage, TABLE_DOCUMENT_STYLES } from './chunk-D3QPYKZG.js';
+export { DEFINITIONS_LABEL, DEFINITION_BOOKMARK_PREFIX, compareDefinitions, compareTerms, definitionBookmark, definitionIdOfBookmark, definitionLabels, filterTermGroups, groupDefinitions, parseDefinition, termKey, toDefinition } from './chunk-D3QPYKZG.js';
 export { DEFAULT_SEARCH_HIT_LABELS, SearchHit } from './chunk-A2YAC22G.js';
 export { TIMELINE_ZOOM, TimelineCalendar, TimelineGantt, TimelineZoomControl, dayKey, formatSpan, monthLabel, parseIso, utcDay } from './chunk-4EZVCGRL.js';
 import './chunk-AF6RDAJF.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbidocs/blocks",
-  "version": "0.4.97",
+  "version": "0.4.99",
   "description": "Composable, domain-neutral UI blocks for ARBI apps, organised by capability (retrieval, facts, agents, workspaces, citations, collaboration) plus shell, theme and site primitives, on top of @arbidocs/react.",
   "type": "module",
   "main": "dist/index.cjs",
@@ -266,8 +266,8 @@
     "example:test:e2e": "playwright test -c examples/custom-ui/playwright.config.ts"
   },
   "dependencies": {
-    "@arbidocs/client": "0.4.97",
-    "@arbidocs/coedit": "0.4.97",
+    "@arbidocs/client": "0.4.99",
+    "@arbidocs/coedit": "0.4.99",
     "@dnd-kit/core": "^6.3.1",
     "@dnd-kit/sortable": "^10.0.0",
     "@dnd-kit/utilities": "^3.2.2",
@@ -293,7 +293,7 @@
     "zustand": "^5.0.14"
   },
   "peerDependencies": {
-    "@arbidocs/react": "0.4.97",
+    "@arbidocs/react": "0.4.99",
     "@docx-editor.dev/core": "2.28.0",
     "@docx-editor.dev/react": "2.28.0",
     "@lexical/html": "0.35.0",

package/src/docx/styles.css

@@ -966,3 +966,105 @@
   color: hsl(var(--muted-foreground));
   font-size: 13px;
 }
+
+/* House template: a dot on the style box (and on a style) that differs from the house template. */
+.native-docx-style-diverged {
+  flex: none;
+  width: 6px;
+  height: 6px;
+  margin-left: auto;
+  border-radius: 50%;
+  background: hsl(var(--warning, 38 92% 50%));
+}
+.native-docx-style-list > li {
+  display: flex;
+  align-items: center;
+  gap: 6px;
+}
+
+/* Insert › Quick Parts and Design › House template panels. */
+.native-docx-ribbon-menu:has([data-testid='docx-quick-parts']) .native-docx-ribbon-popover,
+.native-docx-ribbon-menu:has([data-testid='docx-house-template']) .native-docx-ribbon-popover {
+  width: 340px;
+  padding: 8px;
+}
+.native-docx-quick-parts {
+  display: flex;
+  flex-direction: column;
+  gap: 8px;
+  width: 100%;
+  max-height: 60vh;
+  overflow-y: auto;
+}
+.native-docx-quick-parts h3 {
+  margin: 0 0 4px;
+  color: hsl(var(--muted-foreground));
+  font-size: 11px;
+  font-weight: 600;
+  text-transform: uppercase;
+  letter-spacing: 0.04em;
+}
+.native-docx-quick-parts ul {
+  margin: 0;
+  padding: 0;
+  list-style: none;
+}
+.native-docx-quick-parts button {
+  display: flex;
+  flex-direction: column;
+  width: 100%;
+  padding: 6px 8px;
+  border: 0;
+  border-radius: 4px;
+  background: transparent;
+  color: inherit;
+  text-align: left;
+  cursor: pointer;
+}
+.native-docx-quick-parts button:hover:not(:disabled) {
+  background: hsl(var(--muted));
+}
+.native-docx-quick-part-name {
+  font-size: 13px;
+  font-weight: 500;
+}
+.native-docx-quick-part-preview {
+  overflow: hidden;
+  color: hsl(var(--muted-foreground));
+  font-size: 12px;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+}
+.native-docx-quick-parts-source,
+.native-docx-house-template p {
+  margin: 0;
+  color: hsl(var(--muted-foreground));
+  font-size: 12px;
+}
+.native-docx-house-template {
+  display: flex;
+  flex-direction: column;
+  gap: 8px;
+  width: 100%;
+}
+.native-docx-house-template strong {
+  color: hsl(var(--foreground));
+  font-size: 13px;
+}
+.native-docx-house-template-actions {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 6px;
+}
+.native-docx-house-template-actions button {
+  display: inline-flex;
+  align-items: center;
+  gap: 4px;
+  padding: 4px 8px;
+  border: 1px solid hsl(var(--border));
+  border-radius: 4px;
+  background: hsl(var(--background));
+  color: inherit;
+  font-size: 12px;
+  cursor: pointer;
+}