superdoc 2.6.0-next.8 → 2.6.0-next.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -19,7 +19,7 @@ var COLLABORATION_UPGRADE_ENGINE_MINIMUM_NODE_MAJOR = 20;
19
19
  var PRIVATE_ENGINE_INFO = (0, _superdoc_docx_engine_collaboration_upgrade_engine.getCollaborationUpgradeEngineInfo)();
20
20
  var ENGINE_INFO = Object.freeze({
21
21
  ...PRIVATE_ENGINE_INFO,
22
- superdocVersion: "2.6.0-next.8",
22
+ superdocVersion: "2.6.0-next.9",
23
23
  roomSchemaVersion: Object.freeze({ ...PRIVATE_ENGINE_INFO.roomSchemaVersion }),
24
24
  supportedBundleVersions: SUPPORTED_COLLABORATION_UPGRADE_BUNDLE_VERSIONS,
25
25
  supportedV1ReaderContractVersions: SUPPORTED_V1_READER_CONTRACT_VERSIONS
@@ -18,7 +18,7 @@ var COLLABORATION_UPGRADE_ENGINE_MINIMUM_NODE_MAJOR = 20;
18
18
  var PRIVATE_ENGINE_INFO = getCollaborationUpgradeEngineInfo$1();
19
19
  var ENGINE_INFO = Object.freeze({
20
20
  ...PRIVATE_ENGINE_INFO,
21
- superdocVersion: "2.6.0-next.8",
21
+ superdocVersion: "2.6.0-next.9",
22
22
  roomSchemaVersion: Object.freeze({ ...PRIVATE_ENGINE_INFO.roomSchemaVersion }),
23
23
  supportedBundleVersions: SUPPORTED_COLLABORATION_UPGRADE_BUNDLE_VERSIONS,
24
24
  supportedV1ReaderContractVersions: SUPPORTED_V1_READER_CONTRACT_VERSIONS
@@ -3730,30 +3730,63 @@ export interface ProofingError {
3730
3730
  cause?: unknown;
3731
3731
  }
3732
3732
  export interface ProofingConfig {
3733
- /** Enable or disable proofing (default: false). */
3733
+ /**
3734
+ * Enables proofing. A provider is also required before SuperDoc runs checks.
3735
+ * @defaultValue false
3736
+ */
3734
3737
  enabled?: boolean;
3735
- /** Provider instance. */
3738
+ /**
3739
+ * Checks the text segments SuperDoc supplies and returns spelling, grammar,
3740
+ * or style issues.
3741
+ * @defaultValue null
3742
+ */
3736
3743
  provider?: ProofingProvider | null;
3737
- /** Fallback language for segments without a resolved language. */
3744
+ /**
3745
+ * Fallback language passed to the provider when a text segment has no
3746
+ * resolved language.
3747
+ * @defaultValue null
3748
+ */
3738
3749
  defaultLanguage?: string | null;
3739
- /** Debounce delay after edits before rechecking (default: 500). */
3750
+ /**
3751
+ * Delay in milliseconds between an edit and the next proofing check. Values
3752
+ * at or below 0 run without a delay.
3753
+ * @defaultValue 500
3754
+ */
3740
3755
  debounceMs?: number;
3741
- /** Maximum replacement suggestions per issue. */
3756
+ /** Suggestion limit passed to the provider. The provider decides how to apply it. */
3742
3757
  maxSuggestions?: number;
3743
- /** Prioritize checking visible pages first (default: true). */
3758
+ /** Prioritize checking visible pages first. */
3744
3759
  visibleFirst?: boolean;
3745
- /** Show "Ignore" in context menu (default: true). */
3760
+ /**
3761
+ * Shows Ignore in the proofing context menu. Ignored words remain suppressed
3762
+ * for this editor session.
3763
+ * @defaultValue true
3764
+ */
3746
3765
  allowIgnoreWord?: boolean;
3747
- /** Words to suppress from proofing results. */
3766
+ /**
3767
+ * Words whose proofing issues SuperDoc suppresses. Matching is
3768
+ * case-insensitive after Unicode normalization.
3769
+ * @defaultValue []
3770
+ */
3748
3771
  ignoredWords?: string[];
3749
- /** Provider call timeout in milliseconds (default: 10000). */
3772
+ /**
3773
+ * Maximum provider call time in milliseconds. Non-positive or non-finite
3774
+ * values use the default.
3775
+ * @defaultValue 10000
3776
+ */
3750
3777
  timeoutMs?: number;
3751
- /** Max concurrent provider requests (default: 2). */
3778
+ /** Maximum concurrent provider requests. */
3752
3779
  maxConcurrentRequests?: number;
3753
- /** Max segments per provider call (default: 20). */
3780
+ /** Maximum segments per provider call. */
3754
3781
  maxSegmentsPerBatch?: number;
3755
- /** Error callback for provider failures. */
3782
+ /**
3783
+ * Runs when a provider check fails or times out.
3784
+ * @param error - The failure kind, message, affected segment IDs, and cause.
3785
+ */
3756
3786
  onProofingError?: (error: ProofingError) => void;
3757
- /** Status change callback. */
3787
+ /**
3788
+ * Runs when the proofing lifecycle status changes.
3789
+ * @param status - The current proofing status.
3790
+ */
3758
3791
  onStatusChange?: (status: ProofingStatus) => void;
3759
3792
  }
package/dist/superdoc.cjs CHANGED
@@ -43477,7 +43477,7 @@ var SuperDoc = class extends require_eventemitter3.import_eventemitter3.default
43477
43477
  this.config.colors = shuffleArray(this.config.colors);
43478
43478
  this.userColorMap = /* @__PURE__ */ new Map();
43479
43479
  this.colorIndex = 0;
43480
- this.version = "2.6.0-next.8";
43480
+ this.version = "2.6.0-next.9";
43481
43481
  this.#log("🦋 [superdoc] Using SuperDoc version:", this.version);
43482
43482
  this.superdocId = config.superdocId || require_uuid.v4();
43483
43483
  this.colors = this.config.colors ?? [];
@@ -43410,7 +43410,7 @@ var SuperDoc = class extends import_eventemitter3.default {
43410
43410
  this.config.colors = shuffleArray(this.config.colors);
43411
43411
  this.userColorMap = /* @__PURE__ */ new Map();
43412
43412
  this.colorIndex = 0;
43413
- this.version = "2.6.0-next.8";
43413
+ this.version = "2.6.0-next.9";
43414
43414
  this.#log("🦋 [superdoc] Using SuperDoc version:", this.version);
43415
43415
  this.superdocId = config.superdocId || v4();
43416
43416
  this.colors = this.config.colors ?? [];