@arbidocs/blocks 0.4.157 → 0.4.159

package/dist/docx/index.cjs

@@ -1,15 +1,17 @@
 "use client";
 'use strict';
 
-var chunkVY4UFXTM_cjs = require('../chunk-VY4UFXTM.cjs');
-var chunkTQIY2SVY_cjs = require('../chunk-TQIY2SVY.cjs');
+var chunkETJFC6MO_cjs = require('../chunk-ETJFC6MO.cjs');
+var chunkGFVIFXWT_cjs = require('../chunk-GFVIFXWT.cjs');
 var chunk464YPRAE_cjs = require('../chunk-464YPRAE.cjs');
-var chunkJSQEAPTC_cjs = require('../chunk-JSQEAPTC.cjs');
+var chunk4GITK3Q5_cjs = require('../chunk-4GITK3Q5.cjs');
+require('../chunk-JPWPR6QU.cjs');
 require('../chunk-5FYU7ZIU.cjs');
 require('../chunk-QT3A4PFC.cjs');
 require('../chunk-RC25WMVB.cjs');
 require('../chunk-7UTB4PHM.cjs');
 require('../chunk-MHVNT4J3.cjs');
+require('../chunk-ULWRNGGE.cjs');
 require('../chunk-DES3K4SD.cjs');
 var react = require('@docx-editor.dev/react');
 var hocuspocus = require('@arbidocs/coedit/hocuspocus');
@@ -18,11 +20,11 @@ var hocuspocus = require('@arbidocs/coedit/hocuspocus');
 
 Object.defineProperty(exports, "NativeDocxComparison", {
   enumerable: true,
-  get: function () { return chunkVY4UFXTM_cjs.NativeDocxComparison; }
+  get: function () { return chunkETJFC6MO_cjs.NativeDocxComparison; }
 });
 Object.defineProperty(exports, "StreamedWordArtifact", {
   enumerable: true,
-  get: function () { return chunkTQIY2SVY_cjs.StreamedWordArtifact; }
+  get: function () { return chunkGFVIFXWT_cjs.StreamedWordArtifact; }
 });
 Object.defineProperty(exports, "groupCandidates", {
   enumerable: true,
@@ -38,171 +40,183 @@ Object.defineProperty(exports, "loadDocxFonts", {
 });
 Object.defineProperty(exports, "BUILTIN_TEMPLATE_NAME", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.BUILTIN_TEMPLATE_NAME; }
+  get: function () { return chunk4GITK3Q5_cjs.BUILTIN_TEMPLATE_NAME; }
 });
 Object.defineProperty(exports, "CrossReferenceDialog", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.CrossReferenceDialog; }
+  get: function () { return chunk4GITK3Q5_cjs.CrossReferenceDialog; }
 });
 Object.defineProperty(exports, "CrossReferencesProvider", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.CrossReferencesProvider; }
+  get: function () { return chunk4GITK3Q5_cjs.CrossReferencesProvider; }
 });
 Object.defineProperty(exports, "DEFAULT_CROSS_REFERENCES_LABELS", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.DEFAULT_CROSS_REFERENCES_LABELS; }
+  get: function () { return chunk4GITK3Q5_cjs.DEFAULT_CROSS_REFERENCES_LABELS; }
 });
 Object.defineProperty(exports, "DEFAULT_DEFINED_TERMS_LABELS", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.DEFAULT_DEFINED_TERMS_LABELS; }
+  get: function () { return chunk4GITK3Q5_cjs.DEFAULT_DEFINED_TERMS_LABELS; }
 });
 Object.defineProperty(exports, "DEFINED_TERM_TRIGGER", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.DEFINED_TERM_TRIGGER; }
+  get: function () { return chunk4GITK3Q5_cjs.DEFINED_TERM_TRIGGER; }
 });
 Object.defineProperty(exports, "DefinedTermsProvider", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.DefinedTermsProvider; }
+  get: function () { return chunk4GITK3Q5_cjs.DefinedTermsProvider; }
 });
 Object.defineProperty(exports, "DocxAuthorContext", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.DocxAuthorContext; }
+  get: function () { return chunk4GITK3Q5_cjs.DocxAuthorContext; }
 });
 Object.defineProperty(exports, "DocxCommentActivity", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.DocxCommentActivity; }
+  get: function () { return chunk4GITK3Q5_cjs.DocxCommentActivity; }
 });
 Object.defineProperty(exports, "DocxEditorReview", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.DocxEditorReview; }
+  get: function () { return chunk4GITK3Q5_cjs.DocxEditorReview; }
 });
 Object.defineProperty(exports, "DocxMentions", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.DocxMentions; }
+  get: function () { return chunk4GITK3Q5_cjs.DocxMentions; }
 });
 Object.defineProperty(exports, "DocxParticipants", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.DocxParticipants; }
+  get: function () { return chunk4GITK3Q5_cjs.DocxParticipants; }
 });
 Object.defineProperty(exports, "DocxRibbon", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.DocxRibbon; }
+  get: function () { return chunk4GITK3Q5_cjs.DocxRibbon; }
 });
 Object.defineProperty(exports, "GenerateImageButton", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.GenerateImageButton; }
+  get: function () { return chunk4GITK3Q5_cjs.GenerateImageButton; }
 });
 Object.defineProperty(exports, "HouseTemplateProvider", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.HouseTemplateProvider; }
+  get: function () { return chunk4GITK3Q5_cjs.HouseTemplateProvider; }
 });
 Object.defineProperty(exports, "LinkHoverCard", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.LinkHoverCard; }
+  get: function () { return chunk4GITK3Q5_cjs.LinkHoverCard; }
 });
 Object.defineProperty(exports, "NativeDocxEditor", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.NativeDocxEditor; }
+  get: function () { return chunk4GITK3Q5_cjs.NativeDocxEditor; }
+});
+Object.defineProperty(exports, "SignatureFieldMenu", {
+  enumerable: true,
+  get: function () { return chunk4GITK3Q5_cjs.SignatureFieldMenu; }
+});
+Object.defineProperty(exports, "SignatureFieldsProvider", {
+  enumerable: true,
+  get: function () { return chunk4GITK3Q5_cjs.SignatureFieldsProvider; }
 });
 Object.defineProperty(exports, "builtinHouseTemplate", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.builtinHouseTemplate; }
+  get: function () { return chunk4GITK3Q5_cjs.builtinHouseTemplate; }
 });
 Object.defineProperty(exports, "contentPath", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.contentPath; }
+  get: function () { return chunk4GITK3Q5_cjs.contentPath; }
 });
 Object.defineProperty(exports, "editorPort", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.editorPort; }
+  get: function () { return chunk4GITK3Q5_cjs.editorPort; }
 });
 Object.defineProperty(exports, "findDefinitionsSection", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.findDefinitionsSection; }
+  get: function () { return chunk4GITK3Q5_cjs.findDefinitionsSection; }
 });
 Object.defineProperty(exports, "insertCrossReference", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.insertCrossReference; }
+  get: function () { return chunk4GITK3Q5_cjs.insertCrossReference; }
 });
 Object.defineProperty(exports, "insertDefinedTerm", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.insertDefinedTerm; }
+  get: function () { return chunk4GITK3Q5_cjs.insertDefinedTerm; }
 });
 Object.defineProperty(exports, "insertDocumentReference", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.insertDocumentReference; }
+  get: function () { return chunk4GITK3Q5_cjs.insertDocumentReference; }
+});
+Object.defineProperty(exports, "insertSignatureField", {
+  enumerable: true,
+  get: function () { return chunk4GITK3Q5_cjs.insertSignatureField; }
 });
 Object.defineProperty(exports, "listTargets", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.listTargets; }
+  get: function () { return chunk4GITK3Q5_cjs.listTargets; }
 });
 Object.defineProperty(exports, "normalizeDocxExport", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.normalizeDocxExport; }
+  get: function () { return chunk4GITK3Q5_cjs.normalizeDocxExport; }
 });
 Object.defineProperty(exports, "paragraphNumber", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.paragraphNumber; }
+  get: function () { return chunk4GITK3Q5_cjs.paragraphNumber; }
 });
 Object.defineProperty(exports, "referenceText", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.referenceText; }
+  get: function () { return chunk4GITK3Q5_cjs.referenceText; }
 });
 Object.defineProperty(exports, "referencesPort", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.referencesPort; }
+  get: function () { return chunk4GITK3Q5_cjs.referencesPort; }
 });
 Object.defineProperty(exports, "resolveHouseTemplate", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.resolveHouseTemplate; }
+  get: function () { return chunk4GITK3Q5_cjs.resolveHouseTemplate; }
 });
 Object.defineProperty(exports, "reviewModule", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.reviewModule; }
+  get: function () { return chunk4GITK3Q5_cjs.reviewModule; }
 });
 Object.defineProperty(exports, "shortTitle", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.shortTitle; }
+  get: function () { return chunk4GITK3Q5_cjs.shortTitle; }
 });
 Object.defineProperty(exports, "structuralPort", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.structuralPort; }
+  get: function () { return chunk4GITK3Q5_cjs.structuralPort; }
 });
 Object.defineProperty(exports, "templateFileName", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.templateFileName; }
+  get: function () { return chunk4GITK3Q5_cjs.templateFileName; }
 });
 Object.defineProperty(exports, "trackedOrNoted", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.trackedOrNoted; }
+  get: function () { return chunk4GITK3Q5_cjs.trackedOrNoted; }
 });
 Object.defineProperty(exports, "useCrossReferences", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.useCrossReferences; }
+  get: function () { return chunk4GITK3Q5_cjs.useCrossReferences; }
 });
 Object.defineProperty(exports, "useDefinedTerms", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.useDefinedTerms; }
+  get: function () { return chunk4GITK3Q5_cjs.useDefinedTerms; }
 });
 Object.defineProperty(exports, "useHouseTemplate", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.useHouseTemplate; }
+  get: function () { return chunk4GITK3Q5_cjs.useHouseTemplate; }
 });
 Object.defineProperty(exports, "useReview", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.useReview; }
+  get: function () { return chunk4GITK3Q5_cjs.useReview; }
 });
 Object.defineProperty(exports, "useReviewItem", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.useReviewItem; }
+  get: function () { return chunk4GITK3Q5_cjs.useReviewItem; }
 });
 Object.defineProperty(exports, "useTrackedOrNoted", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.useTrackedOrNoted; }
+  get: function () { return chunk4GITK3Q5_cjs.useTrackedOrNoted; }
 });
 Object.defineProperty(exports, "withDirectEditing", {
   enumerable: true,
-  get: function () { return chunkJSQEAPTC_cjs.withDirectEditing; }
+  get: function () { return chunk4GITK3Q5_cjs.withDirectEditing; }
 });
 Object.defineProperty(exports, "DocxEditor", {
   enumerable: true,

package/dist/docx/index.d.ts

@@ -24,3 +24,4 @@ export { DocxAuthorContext, useTrackedOrNoted } from './structural/useTrackedOrN
 export { contentPath } from './NativeDocxEditor';
 export { HouseTemplateProvider, useHouseTemplate, builtinHouseTemplate, resolveHouseTemplate, templateFileName, BUILTIN_TEMPLATE_NAME, type HouseTemplate, type HouseTemplateHost, type HouseTemplateSource, } from './template/HouseTemplate';
 export { groupCandidates, isCandidate, type CandidateGroup, type HouseTemplateCandidate, } from './template/candidates';
+export { SignatureFieldMenu, SignatureFieldsProvider, insertSignatureField, type DocxSigner, } from './signatures/SignatureFields';

package/dist/docx/index.js

@@ -1,13 +1,15 @@
 "use client";
-export { NativeDocxComparison } from '../chunk-EWCJXUBP.js';
-export { StreamedWordArtifact } from '../chunk-7IRSCMNK.js';
+export { NativeDocxComparison } from '../chunk-AVXRXPII.js';
+export { StreamedWordArtifact } from '../chunk-BGXWPVHR.js';
 export { groupCandidates, isCandidate, loadDocxFonts } from '../chunk-MTSKK3BN.js';
-export { BUILTIN_TEMPLATE_NAME, CrossReferenceDialog, CrossReferencesProvider, DEFAULT_CROSS_REFERENCES_LABELS, DEFAULT_DEFINED_TERMS_LABELS, DEFINED_TERM_TRIGGER, DefinedTermsProvider, DocxAuthorContext, DocxCommentActivity, DocxEditorReview, DocxMentions, DocxParticipants, DocxRibbon, GenerateImageButton, HouseTemplateProvider, LinkHoverCard, NativeDocxEditor, builtinHouseTemplate, contentPath, editorPort, findDefinitionsSection, insertCrossReference, insertDefinedTerm, insertDocumentReference, listTargets, normalizeDocxExport, paragraphNumber, referenceText, referencesPort, resolveHouseTemplate, reviewModule, shortTitle, structuralPort, templateFileName, trackedOrNoted, useCrossReferences, useDefinedTerms, useHouseTemplate, useReview, useReviewItem, useTrackedOrNoted, withDirectEditing } from '../chunk-ONTUMV74.js';
+export { BUILTIN_TEMPLATE_NAME, CrossReferenceDialog, CrossReferencesProvider, DEFAULT_CROSS_REFERENCES_LABELS, DEFAULT_DEFINED_TERMS_LABELS, DEFINED_TERM_TRIGGER, DefinedTermsProvider, DocxAuthorContext, DocxCommentActivity, DocxEditorReview, DocxMentions, DocxParticipants, DocxRibbon, GenerateImageButton, HouseTemplateProvider, LinkHoverCard, NativeDocxEditor, SignatureFieldMenu, SignatureFieldsProvider, builtinHouseTemplate, contentPath, editorPort, findDefinitionsSection, insertCrossReference, insertDefinedTerm, insertDocumentReference, insertSignatureField, listTargets, normalizeDocxExport, paragraphNumber, referenceText, referencesPort, resolveHouseTemplate, reviewModule, shortTitle, structuralPort, templateFileName, trackedOrNoted, useCrossReferences, useDefinedTerms, useHouseTemplate, useReview, useReviewItem, useTrackedOrNoted, withDirectEditing } from '../chunk-XER3JLC7.js';
+import '../chunk-DAN7EJ4O.js';
 import '../chunk-HFZ45FD3.js';
 import '../chunk-DIB4JYUY.js';
 import '../chunk-AF6RDAJF.js';
 import '../chunk-AA3PT6KR.js';
 import '../chunk-7F6CBP3Z.js';
+import '../chunk-TX2ZICS7.js';
 import '../chunk-VUNV25KB.js';
 export { DocxEditor, useDocxEditor, useEditorState } from '@docx-editor.dev/react';
 export { createHocuspocusCollaboration } from '@arbidocs/coedit/hocuspocus';

package/dist/docx/signatures/SignatureFields.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Insert › Signature field: a field where a signature request will ask someone to sign, initial,
+ * date or print their name, placed at the caret. The field is a locked chip ("Signature — Priya
+ * Shah") whose hidden payload names the signer by email; when the version is saved, its PDF
+ * carries an invisible anchor there, and Request signatures places the field exactly on it, for
+ * that signer. A field with no signer is assigned when the request is made. See
+ * `@arbidocs/coedit/commands` (`signatureFieldWrite`).
+ *
+ * Insert › My signature puts one's own saved signature or initials (Account settings › Your
+ * signature, sealed with one's own key) at the cursor as an inline picture, through the editor's
+ * picture insert (a tracked insertion while suggesting). Nothing saved yet: the adopt dialog opens
+ * first. That is an informal signature; verified signing is Request signatures.
+ */
+import React from 'react';
+import { useDocxEditor } from '@docx-editor.dev/react';
+import { type SavedSignature } from '@arbidocs/react/document-tools';
+import { type SignatureFieldSpec } from '@arbidocs/coedit/commands';
+/** Someone who may be asked to sign: a workspace member, offered first in the signer picker. */
+export interface DocxSigner {
+    email: string;
+    name: string;
+}
+/** One's own saved signature (sealed with one's own key), for Insert › My signature. */
+export interface DocxSavedSignature {
+    load: () => Promise<SavedSignature | null>;
+    save: (signature: SavedSignature) => Promise<void>;
+    /** The name the adopt dialog starts from when nothing is saved yet. */
+    defaultName: string;
+}
+export declare function SignatureFieldsProvider({ signers, editable, notify, mySignature, children, }: {
+    /** Absent: the Insert tab offers no signature field (not a workspace document). */
+    signers?: readonly DocxSigner[];
+    editable: boolean;
+    notify?: (message: string, kind: 'success' | 'error') => void;
+    /** Present: Insert offers My signature / My initials. */
+    mySignature?: DocxSavedSignature;
+    children: React.ReactNode;
+}): React.JSX.Element;
+type Mark = 'signature' | 'initials';
+/** Insert one's saved signature (or initials) at the caret as an inline picture. */
+export declare function insertSavedMark(editor: Editor, saved: SavedSignature, mark: Mark): Promise<void>;
+/** Insert tab: My signature (insert my signature / initials). */
+export declare function MySignatureMenu(): React.JSX.Element | null;
+/** Right-click menu rows: Insert my signature / Insert my initials. */
+export declare function MySignatureContextItems(): React.JSX.Element | null;
+type Editor = NonNullable<ReturnType<typeof useDocxEditor>>;
+/** Insert the field at the caret, directly (a payload cannot be a tracked change). */
+export declare function insertSignatureField(editor: Editor, spec: SignatureFieldSpec): string | null;
+export declare function SignatureFieldMenu(): React.JSX.Element | null;
+export {};