@univerjs/core 1.0.0-alpha.2 → 1.0.0-alpha.3

package/lib/types/bases/base-data-model.d.ts

@@ -25,6 +25,10 @@ export declare class BaseDataModel extends UnitModel<IBaseSnapshot, UniverInstan
     getUnitId(): string;
     setName(name: string): void;
     getSnapshot(): IBaseSnapshot;
+    /** Check if a table name already exists, ignoring case. */
+    checkTableName(name: string): boolean;
+    /** Generate a table name that does not conflict with existing tables. */
+    uniqueTableName(name: string): string;
     setSnapshot(snapshot: IBaseSnapshot): void;
     getRev(): number;
     incrementRev(): void;

package/lib/types/bases/empty-snapshot.d.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import type { IBaseSnapshot, ITableSnapshot } from './typedef';
+import { LocaleType } from '../types/enum';
 export interface ICreateDefaultBaseTableSnapshotOptions {
     id: string;
     name: string;
@@ -24,4 +25,4 @@ export interface ICreateDefaultBaseTableSnapshotOptions {
     now?: number;
 }
 export declare function createDefaultBaseTableSnapshot(options: ICreateDefaultBaseTableSnapshotOptions): ITableSnapshot;
-export declare function getEmptyBaseSnapshot(unitID?: string, name?: string): IBaseSnapshot;
+export declare function getEmptySnapshot(unitId?: string, name?: string, locale?: LocaleType): IBaseSnapshot;

package/lib/types/bases/index.d.ts

@@ -14,5 +14,6 @@
  * limitations under the License.
  */
 export { BaseDataModel } from './base-data-model';
-export { createDefaultBaseTableSnapshot, getEmptyBaseSnapshot, type ICreateDefaultBaseTableSnapshotOptions } from './empty-snapshot';
-export type { BaseCellData, BaseCellMatrix, BaseCellPrimitiveValue, CellValue as BaseCellValue, BaseCellValueType, BaseHitTestResult, BaseId, BaseInvalidation, PrimitiveCellValue as BasePrimitiveCellValue, BaseResources, BaseSelection, BaseSnapshot, BaseViewColorCondition, BaseViewProjection, CalendarEventResizeSelection, CalendarEventSelection, CalendarProjection, CalendarViewConfig, CardLayoutConfig, FieldCapabilities, FieldConfig, FieldId, FieldSnapshot, FieldType, FilterCondition, FilterConfig, FilterOperator, GalleryCardSelection, GalleryProjection, GalleryViewConfig, GanttBarSelection, GanttCellSelection, GanttProjection, GanttTimeColumn, GanttViewConfig, GridCellSelection, GridFieldSelection, GridGroupSelection, GridProjection, GridRecordSelection, GridViewConfig, GroupConfig, IBaseCellData, IBaseInvalidation, IBaseResources, IBaseSnapshot, IBaseViewColorCondition, ICalendarEventResizeSelection, ICalendarEventSelection, ICalendarProjection, ICalendarViewConfig, ICardLayoutConfig, IFieldCapabilities, IFieldSnapshot, IFilterCondition, IFilterConfig, IGalleryCardSelection, IGalleryProjection, IGalleryViewConfig, IGanttBarSelection, IGanttCellSelection, IGanttProjection, IGanttTimeColumn, IGanttViewConfig, IGridCellSelection, IGridFieldSelection, IGridGroupSelection, IGridProjection, IGridRecordSelection, IGridViewConfig, IGroupConfig, IInvalidViewProjection, IKanbanCardSelection, IKanbanColumnSetting, IKanbanFieldCardSetting, IKanbanProjection, IKanbanViewConfig, InvalidViewProjection, IProjectedField, IProjectedGroup, IProjectedRow, IRecordSnapshot, IRect, ISortConfig, ITableSnapshot, IValidationResult, IViewFieldSetting, IViewport, IViewProjection, IViewSnapshot, KanbanCardLayoutMode, KanbanCardSelection, KanbanColumnSetting, KanbanFieldCardSetting, KanbanProjection, KanbanViewConfig, ProjectedField, ProjectedGroup, ProjectedRow, RecordId, RecordSnapshot, Rect, SortConfig, TableId, TableSnapshot, ValidationResult, ViewFieldSetting, ViewId, Viewport, ViewProjection, ViewSnapshot, ViewSpecificConfig, ViewType, } from './typedef';
+export { createDefaultBaseTableSnapshot, getEmptySnapshot as getBasesEmptySnapshot, type ICreateDefaultBaseTableSnapshotOptions, } from './empty-snapshot';
+export { BaseFieldType, BaseFilterConjunction, BaseFilterOperator, BaseSortDirection, BaseViewType } from './typedef';
+export type { BaseCellMatrix, BaseCellPrimitiveValue, CellValue as BaseCellValue, BaseCellValueType, BaseHitTestResult, BaseId, PrimitiveCellValue as BasePrimitiveCellValue, BaseSelection, BaseSnapshot, BaseViewProjection, FieldConfig, FieldId, FieldSnapshot, IBaseCellData, IBaseInvalidation, IBaseRect, IBaseResources, IBaseSnapshot, IBaseViewColorCondition, IBaseViewport, ICalendarEventResizeSelection, ICalendarEventSelection, ICalendarProjection, ICalendarViewConfig, ICardLayoutConfig, IFieldCapabilities, IFieldSnapshot, IFilterCondition, IFilterConfig, IGalleryCardSelection, IGalleryProjection, IGalleryViewConfig, IGanttBarSelection, IGanttCellSelection, IGanttProjection, IGanttTimeColumn, IGanttViewConfig, IGridCellSelection, IGridFieldSelection, IGridGroupSelection, IGridProjection, IGridRecordSelection, IGridViewConfig, IGroupConfig, IInvalidViewProjection, IKanbanCardSelection, IKanbanColumnSetting, IKanbanFieldCardSetting, IKanbanProjection, IKanbanViewConfig, IProjectedField, IProjectedGroup, IProjectedRow, IRecordSnapshot, ISortConfig, ITableSnapshot, IValidationResult, IViewFieldSetting, IViewProjection, IViewSnapshot, KanbanCardLayoutMode, RecordId, RecordSnapshot, TableId, TableSnapshot, ViewId, ViewSnapshot, ViewSpecificConfig, } from './typedef';

package/lib/types/bases/typedef.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { CellValueType } from '../types/enum';
+import type { CellValueType, LocaleType } from '../types/enum';
 import type { IDocumentData } from '../types/interfaces';
 export type BaseId = string;
 export type TableId = string;
@@ -38,20 +38,58 @@ export interface IBaseResources {
     attachmentSets?: Record<string, string[]>;
     attachments?: Record<string, Record<string, unknown>>;
 }
-export type FieldType = 'text' | 'singleSelect' | 'multiSelect' | 'person' | 'group' | 'date' | 'attachment' | 'number' | 'checkbox' | 'link' | 'formula' | 'lookup' | 'flow' | 'button' | 'numbering' | 'phone' | 'email' | 'location' | 'barcode' | 'progress' | 'currency' | 'rating' | 'twoWayLink' | 'recordId' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'summary';
-export type ViewType = 'grid' | 'kanban' | 'calendar' | 'gantt' | 'gallery';
+export declare enum BaseFieldType {
+    Text = "text",
+    SingleSelect = "singleSelect",
+    MultiSelect = "multiSelect",
+    Person = "person",
+    Group = "group",
+    Date = "date",
+    Attachment = "attachment",
+    Number = "number",
+    Checkbox = "checkbox",
+    Link = "link",
+    Formula = "formula",
+    Lookup = "lookup",
+    Flow = "flow",
+    Button = "button",
+    Numbering = "numbering",
+    Phone = "phone",
+    Email = "email",
+    Location = "location",
+    Barcode = "barcode",
+    Progress = "progress",
+    Currency = "currency",
+    Rating = "rating",
+    TwoWayLink = "twoWayLink",
+    RecordId = "recordId",
+    CreatedBy = "createdBy",
+    UpdatedBy = "updatedBy",
+    CreatedAt = "createdAt",
+    UpdatedAt = "updatedAt",
+    Summary = "summary"
+}
+export declare enum BaseViewType {
+    Grid = "grid",
+    Kanban = "kanban",
+    Calendar = "calendar",
+    Gantt = "gantt",
+    Gallery = "gallery"
+}
 export type FieldConfig = Record<string, unknown>;
 export type ViewSpecificConfig = IGridViewConfig | IKanbanViewConfig | ICalendarViewConfig | IGanttViewConfig | IGalleryViewConfig | Record<string, unknown>;
 export interface IBaseSnapshot {
     id: BaseId;
     name: string;
+    rev?: number;
+    appVersion?: string;
+    locale?: LocaleType;
     schemaVersion: number;
     tables: Record<TableId, ITableSnapshot>;
     tableOrder: TableId[];
     createdAt: number;
     updatedAt: number;
     createdBy?: string;
-    rev?: number;
 }
 export interface ITableSnapshot {
     id: TableId;
@@ -69,7 +107,6 @@ export interface ITableSnapshot {
     views: Record<ViewId, IViewSnapshot>;
     viewOrder: ViewId[];
     primaryFieldId: FieldId;
-    deleted?: boolean;
 }
 export interface IRecordSnapshot {
     id: RecordId;
@@ -79,31 +116,28 @@ export interface IRecordSnapshot {
     updatedAt: number;
     createdBy?: string;
     updatedBy?: string;
-    deleted?: boolean;
 }
 export interface IFieldSnapshot {
     id: FieldId;
     name: string;
     description?: string;
-    type: FieldType;
+    type: BaseFieldType;
     config: FieldConfig;
     defaultValue?: CellValue;
     system?: boolean;
     readonly?: boolean;
-    deleted?: boolean;
 }
 export interface IViewSnapshot<TConfig extends ViewSpecificConfig = ViewSpecificConfig> {
     id: ViewId;
     tableId: TableId;
     name: string;
-    type: ViewType;
+    type: BaseViewType;
     fieldOrder?: FieldId[];
     fieldSettings?: Record<FieldId, IViewFieldSetting>;
     filter?: IFilterConfig | null;
     sort?: ISortConfig[];
     group?: IGroupConfig[];
     config: TConfig;
-    deleted?: boolean;
 }
 export type BaseSnapshot = IBaseSnapshot;
 export type TableSnapshot = ITableSnapshot;
@@ -135,23 +169,44 @@ export interface IValidationResult {
     valid: boolean;
     reason?: string;
 }
-export type FilterOperator = 'is' | 'isNot' | 'contains' | 'notContains' | 'isEmpty' | 'isNotEmpty' | 'greaterThan' | 'greaterThanOrEqual' | 'lessThan' | 'lessThanOrEqual';
+export declare enum BaseFilterOperator {
+    IS = "is",
+    IS_NOT = "isNot",
+    CONTAINS = "contains",
+    NOT_CONTAINS = "notContains",
+    IS_EMPTY = "isEmpty",
+    IS_NOT_EMPTY = "isNotEmpty",
+    GREATER_THAN = "greaterThan",
+    GREATER_THAN_OR_EQUAL = "greaterThanOrEqual",
+    LESS_THAN = "lessThan",
+    LESS_THAN_OR_EQUAL = "lessThanOrEqual",
+    BEFORE = "before",
+    AFTER = "after"
+}
+export declare enum BaseFilterConjunction {
+    AND = "and",
+    OR = "or"
+}
 export interface IFilterConfig {
-    conjunction: 'and' | 'or';
+    conjunction: BaseFilterConjunction;
     conditions: IFilterCondition[];
 }
 export interface IFilterCondition {
     fieldId: FieldId;
-    operator: string;
+    operator: BaseFilterOperator;
     operand?: unknown;
 }
+export declare enum BaseSortDirection {
+    ASC = "asc",
+    DESC = "desc"
+}
 export interface ISortConfig {
     fieldId: FieldId;
-    direction: 'asc' | 'desc';
+    direction: BaseSortDirection;
 }
 export interface IGroupConfig {
     fieldId: FieldId;
-    direction?: 'asc' | 'desc';
+    direction?: BaseSortDirection;
     hideEmptyGroup?: boolean;
 }
 export interface IGridViewConfig {
@@ -260,13 +315,13 @@ export interface IProjectedField {
     id: FieldId;
     name: string;
     description?: string;
-    type: FieldType;
+    type: BaseFieldType;
     config?: FieldConfig;
     width?: number;
     setting: IViewFieldSetting;
 }
 export interface IViewProjection {
-    type: ViewType;
+    type: BaseViewType;
     fields: IProjectedField[];
     rows: IProjectedRow[];
     groups?: IProjectedGroup[];
@@ -285,11 +340,11 @@ export interface IProjectedGroup {
     children?: IProjectedGroup[];
 }
 export interface IGridProjection extends IViewProjection {
-    type: 'grid';
+    type: BaseViewType.Grid;
     frozenFieldCount?: number;
 }
 export interface IKanbanProjection extends IViewProjection {
-    type: 'kanban';
+    type: BaseViewType.Kanban;
     groupFieldId: FieldId;
     coverFieldId?: FieldId | null;
     cardLayout: KanbanCardLayoutMode;
@@ -303,7 +358,7 @@ export interface IKanbanProjection extends IViewProjection {
     }>;
 }
 export interface ICalendarProjection extends IViewProjection {
-    type: 'calendar';
+    type: BaseViewType.Calendar;
     config: ICalendarViewConfig;
     events: Array<{
         recordId: RecordId;
@@ -326,7 +381,7 @@ export interface IGanttTimeColumn {
     nonWorking?: boolean;
 }
 export interface IGanttProjection extends IViewProjection {
-    type: 'gantt';
+    type: BaseViewType.Gantt;
     config: IGanttViewConfig;
     dateRangeAllDay?: boolean;
     timeline: {
@@ -354,7 +409,7 @@ export interface IGanttProjection extends IViewProjection {
     }>;
 }
 export interface IGalleryProjection extends IViewProjection {
-    type: 'gallery';
+    type: BaseViewType.Gallery;
     coverFieldId?: FieldId | null;
     cardLayout: KanbanCardLayoutMode;
     showFieldNames: boolean;
@@ -368,18 +423,18 @@ export interface IGalleryProjection extends IViewProjection {
 }
 export interface IInvalidViewProjection {
     type: 'invalid';
-    viewType: ViewType;
+    viewType: BaseViewType;
     reason: 'missingField' | 'invalidGroupField' | 'invalidDateField' | 'invalidGanttStartField' | 'invalidGanttEndField';
     fieldId?: FieldId;
 }
 export type BaseViewProjection = IGridProjection | IKanbanProjection | ICalendarProjection | IGanttProjection | IGalleryProjection | IInvalidViewProjection;
-export interface IViewport {
+export interface IBaseViewport {
     x: number;
     y: number;
     width: number;
     height: number;
 }
-export interface IRect extends IViewport {
+export interface IBaseRect extends IBaseViewport {
 }
 export type BaseSelection = IGridCellSelection | IGridGroupSelection | IGridRecordSelection | IGridFieldSelection | IKanbanCardSelection | ICalendarEventSelection | IGanttCellSelection | IGanttBarSelection | IGalleryCardSelection;
 export interface IGridCellSelection {
@@ -598,45 +653,3 @@ export interface IBaseInvalidation {
     column?: number;
     reason: 'cell' | 'field' | 'record' | 'view' | 'table' | 'unknown';
 }
-export type BaseCellData = IBaseCellData;
-export type BaseResources = IBaseResources;
-export type ViewFieldSetting = IViewFieldSetting;
-export type FieldCapabilities = IFieldCapabilities;
-export type ValidationResult = IValidationResult;
-export type FilterConfig = IFilterConfig;
-export type FilterCondition = IFilterCondition;
-export type SortConfig = ISortConfig;
-export type GroupConfig = IGroupConfig;
-export type GridViewConfig = IGridViewConfig;
-export type CardLayoutConfig = ICardLayoutConfig;
-export type KanbanFieldCardSetting = IKanbanFieldCardSetting;
-export type KanbanColumnSetting = IKanbanColumnSetting;
-export type KanbanViewConfig = IKanbanViewConfig;
-export type CalendarViewConfig = ICalendarViewConfig;
-export type BaseViewColorCondition = IBaseViewColorCondition;
-export type GanttViewConfig = IGanttViewConfig;
-export type GalleryViewConfig = IGalleryViewConfig;
-export type ProjectedField = IProjectedField;
-export type ViewProjection = IViewProjection;
-export type ProjectedRow = IProjectedRow;
-export type ProjectedGroup = IProjectedGroup;
-export type GridProjection = IGridProjection;
-export type KanbanProjection = IKanbanProjection;
-export type CalendarProjection = ICalendarProjection;
-export type GanttTimeColumn = IGanttTimeColumn;
-export type GanttProjection = IGanttProjection;
-export type GalleryProjection = IGalleryProjection;
-export type InvalidViewProjection = IInvalidViewProjection;
-export type Viewport = IViewport;
-export type Rect = IRect;
-export type GridCellSelection = IGridCellSelection;
-export type GridGroupSelection = IGridGroupSelection;
-export type GridRecordSelection = IGridRecordSelection;
-export type GridFieldSelection = IGridFieldSelection;
-export type KanbanCardSelection = IKanbanCardSelection;
-export type CalendarEventSelection = ICalendarEventSelection;
-export type CalendarEventResizeSelection = ICalendarEventResizeSelection;
-export type GanttCellSelection = IGanttCellSelection;
-export type GanttBarSelection = IGanttBarSelection;
-export type GalleryCardSelection = IGalleryCardSelection;
-export type BaseInvalidation = IBaseInvalidation;

package/lib/types/common/regexp/charset.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export type CharsetDataUnit = [number, number];
+/**
+ * A single character, code point, or inclusive range used to build a character class.
+ *
+ * String inputs must contain exactly one Unicode code point. Use `or()` for multi-character
+ * alternatives such as keywords or table names.
+ */
+export type CharsetRawInput = string | number | [string, string] | [number, number];
+export type CharsetInput = Charset | CharsetRawInput;
+/**
+ * Builds a normalized regular-expression character class.
+ *
+ * `Charset` is intended for dynamic character sets, especially when callers need set
+ * operations that are hard to read or easy to get wrong with handwritten `[...]` strings.
+ * Ranges are stored as inclusive Unicode code-point pairs and merged during construction.
+ */
+export declare class Charset {
+    readonly data: CharsetDataUnit[];
+    constructor(...inputs: CharsetInput[]);
+    /**
+     * Returns a new charset containing this charset and all provided characters or ranges.
+     */
+    union(...inputs: CharsetInput[]): Charset;
+    /**
+     * Returns a new charset with the provided characters or ranges removed.
+     */
+    subtract(...inputs: CharsetInput[]): Charset;
+    /**
+     * Returns a new charset containing only characters shared with the provided inputs.
+     */
+    intersect(...inputs: CharsetInput[]): Charset;
+    /**
+     * Returns whether this charset would match no characters.
+     */
+    isEmpty(): boolean;
+    /**
+     * Serializes to a regex fragment, not a full anchored pattern.
+     */
+    toString(): string;
+    /**
+     * Creates a `RegExp` from this charset fragment with optional flags.
+     */
+    toRegExp(flags?: string): RegExp;
+}
+/**
+ * Convenience factory for `new Charset(...)`.
+ */
+export declare const charset: (...inputs: CharsetInput[]) => Charset;

package/lib/types/common/regexp/escape.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Escapes text so it can be embedded in a regular-expression pattern as a literal.
+ */
+export declare function escapeRegExp(value: string): string;
+/**
+ * Creates a `RegExp` that matches literal text rather than regular-expression syntax.
+ */
+export declare function createLiteralRegExp(value: string, flags?: string): RegExp;
+/**
+ * Converts a spreadsheet-style wildcard pattern to an anchored regular expression.
+ *
+ * `*` matches any number of characters and `?` matches one character. All other
+ * regular-expression syntax is treated as literal text. Matching is case-insensitive.
+ */
+export declare function createFromWildcard(pattern: string): RegExp;

package/lib/types/common/regexp/factory.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare function createRegExpFromSafeFragment(fragment: string, flags?: string): RegExp;

package/lib/types/common/regexp/index.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Charset } from './charset';
+import { createFromWildcard, createLiteralRegExp, escapeRegExp } from './escape';
+import { createRegExpFromSafeFragment } from './factory';
+import { Or } from './or';
+/**
+ * Namespace-style public API for regex helpers.
+ *
+ * Import this as `regexp` and call methods through the namespace, for example
+ * `regexp.escapeRegExp(value)` or `regexp.or(...names)`. Do not export these
+ * helpers individually from the package root; keeping one namespace avoids
+ * scattered regex APIs and accidental name collisions.
+ */
+export declare const regexp: {
+    Charset: typeof Charset;
+    Or: typeof Or;
+    charset: (...inputs: import("./charset").CharsetInput[]) => Charset;
+    or: (...inputs: import("./or").OrInput[]) => Or;
+    createRegExpFromSafeFragment: typeof createRegExpFromSafeFragment;
+    escapeRegExp: typeof escapeRegExp;
+    createLiteralRegExp: typeof createLiteralRegExp;
+    createFromWildcard: typeof createFromWildcard;
+};

package/lib/types/common/regexp/or.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { CharsetInput } from './charset';
+import { Charset } from './charset';
+/**
+ * A literal string, existing `Or`, or character-set input used to build alternatives.
+ */
+export type OrInput = string | Or | CharsetInput;
+/**
+ * Builds a regex alternation from literal strings and character sets.
+ *
+ * Literal strings are escaped automatically. Character-set inputs are folded into one
+ * `Charset`, so `or('SUM', charset('A', 'B'))` serializes to an alternation containing
+ * both the string branch and the character-class branch.
+ */
+export declare class Or {
+    readonly charset: Charset;
+    readonly strings: string[];
+    constructor(...inputs: OrInput[]);
+    /**
+     * Returns a new alternation containing this instance and all provided inputs.
+     */
+    union(...inputs: OrInput[]): Or;
+    /**
+     * Returns a new alternation with matching string and charset inputs removed.
+     */
+    subtract(...inputs: OrInput[]): Or;
+    /**
+     * Returns whether this alternation would match no branches.
+     */
+    isEmpty(): boolean;
+    /**
+     * Serializes to a regex fragment, not a full anchored pattern.
+     */
+    toString(): string;
+    /**
+     * Creates a `RegExp` from this alternation fragment with optional flags.
+     */
+    toRegExp(flags?: string): RegExp;
+}
+/**
+ * Convenience factory for `new Or(...)`.
+ */
+export declare const or: (...inputs: OrInput[]) => Or;

package/lib/types/docs/data-model/empty-snapshot.d.ts

@@ -15,4 +15,5 @@
  */
 import type { IDocumentData } from '../../types/interfaces';
 import { LocaleType } from '../../types/enum/locale-type';
-export declare function getEmptySnapshot(unitID?: string, locale?: LocaleType, title?: string): IDocumentData;
+import { DocumentFlavor } from '../../types/interfaces';
+export declare function getEmptySnapshot(unitID?: string, locale?: LocaleType, title?: string, documentFlavor?: DocumentFlavor): IDocumentData;

package/lib/types/docs/data-model/index.d.ts

@@ -14,6 +14,26 @@
  * limitations under the License.
  */
 export * from './document-data-model';
+export { getEmptySnapshot as getDocsEmptySnapshot } from './empty-snapshot';
+export { JSON1, JSONX } from './json-x/json-x';
+export type { JSONXActions, JSONXPath } from './json-x/json-x';
+export { resolveDocumentParagraphStyle } from './paragraph-style';
+export type { IResolveDocumentParagraphStyleOptions } from './paragraph-style';
 export * from './preset-list-type';
+export { replaceInDocumentBody } from './replacement';
+export { ParagraphStyleBuilder, ParagraphStyleValue, RichTextBuilder, RichTextValue, TextDecorationBuilder, TextStyleBuilder, TextStyleValue, } from './rich-text-builder';
+export { DEFAULT_DOCUMENT_SUB_COMPONENT_ID } from './subdocument';
+export { ActionIterator } from './text-x/action-iterator';
+export { PRESERVE_INSERTED_PARAGRAPH_IDS, TextXActionType } from './text-x/action-types';
+export type { IDeleteAction, IInsertAction, IRetainAction, TextXAction } from './text-x/action-types';
+export { normalizeInsertedSectionIdsForDocument, normalizeTextRuns, RESTORE_INSERTED_PARAGRAPH_IDS } from './text-x/apply-utils/common';
+export { updateAttributeByDelete } from './text-x/apply-utils/delete-apply';
+export { updateAttributeByInsert } from './text-x/apply-utils/insert-apply';
 export * from './text-x/build-utils';
+export { getPlainText } from './text-x/build-utils/parse';
+export { validateDocBodyStructure, validateDocumentStructure } from './text-x/structure-validator';
+export type { DocStructureIssueCode, IDocStructureIssue } from './text-x/structure-validator';
+export { TextX } from './text-x/text-x';
+export type { TPriority } from './text-x/text-x';
+export { composeBody, getBodySlice, getBodySliceForSplitTextXAction, getBodySliceForTextXAction, getCustomBlockSlice, getCustomDecorationSlice, getCustomRangeSlice, getParagraphsSlice, getRichTextEditPath, getSectionBreakSlice, getTableSlice, getTextRunSlice, normalizeBody, SliceBodyType, } from './text-x/utils';
 export * from './types';

package/lib/types/docs/data-model/paragraph-style.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { Nullable } from '../../shared';
+import type { IDocumentStyle, IParagraphStyle } from '../../types/interfaces';
+export interface IResolveDocumentParagraphStyleOptions {
+    excludeDocumentOuterSpacing?: boolean;
+    useLegacyModernDefaults?: boolean;
+}
+export declare function resolveDocumentParagraphStyle(documentStyle: Nullable<IDocumentStyle>, paragraphStyle: Nullable<IParagraphStyle>, options?: IResolveDocumentParagraphStyleOptions): IParagraphStyle;

package/lib/types/docs/data-model/preset-list-type.d.ts

@@ -25,42 +25,55 @@ export declare enum QuickListType {
     BULLET_LIST = "*"
 }
 export declare enum PresetListType {
+    /** Standard filled-circle bullet list. */
     BULLET_LIST = "BULLET_LIST",
+    /** Decorative diamond and arrow bullet list. */
     BULLET_LIST_1 = "BULLET_LIST_1",
+    /** Checkmark-led bullet list for completed-item style content. */
     BULLET_LIST_2 = "BULLET_LIST_2",
+    /** Square and diamond bullet list. */
     BULLET_LIST_3 = "BULLET_LIST_3",
+    /** Star-like decorative bullet list. */
     BULLET_LIST_4 = "BULLET_LIST_4",
+    /** Arrow-led bullet list. */
     BULLET_LIST_5 = "BULLET_LIST_5",
     /**
-     * 1 a i
+     * Hierarchical ordered list using `1`, `a`, and `i` markers.
      */
     ORDER_LIST = "ORDER_LIST",
     /**
-     * 1) a) i)
+     * Hierarchical ordered list using `1)`, `a)`, and `i)` markers.
      */
     ORDER_LIST_1 = "ORDER_LIST_1",
     /**
-     * 1. 1.1. 1.1.1.
+     * Outline list using compound markers such as `1.`, `1.1.`, and `1.1.1.`.
      */
     ORDER_LIST_2 = "ORDER_LIST_2",
     /**
-     * A a i
+     * Hierarchical ordered list using `A`, `a`, and `i` markers.
      */
     ORDER_LIST_3 = "ORDER_LIST_3",
     /**
-     * A 1 i
+     * Hierarchical ordered list using `A`, `1`, and `i` markers.
      */
     ORDER_LIST_4 = "ORDER_LIST_4",
     /**
-     * 01 a i
+     * Zero-padded ordered list using `01`, `a`, and `i` markers.
      */
     ORDER_LIST_5 = "ORDER_LIST_5",
+    /** Quick ordered list using closing-parenthesis markers. */
     ORDER_LIST_QUICK_2 = "ORDER_LIST_QUICK_2",
+    /** Quick ordered list using lowercase letter and period markers. */
     ORDER_LIST_QUICK_3 = "ORDER_LIST_QUICK_3",
+    /** Quick ordered list using lowercase Roman numeral markers. */
     ORDER_LIST_QUICK_4 = "ORDER_LIST_QUICK_4",
+    /** Quick ordered list using uppercase letter markers. */
     ORDER_LIST_QUICK_5 = "ORDER_LIST_QUICK_5",
+    /** Quick ordered list using uppercase Roman numeral markers. */
     ORDER_LIST_QUICK_6 = "ORDER_LIST_QUICK_6",
+    /** Unchecked task-list item. */
     CHECK_LIST = "CHECK_LIST",
+    /** Checked task-list item. */
     CHECK_LIST_CHECKED = "CHECK_LIST_CHECKED"
 }
 export declare const PRESET_LIST_TYPE: Record<string, IListData>;