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

package/lib/types/docs/data-model/text-x/structure-validator.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { IDocumentBody, IDocumentData } from '../../../types/interfaces/i-document-data';
+export type DocStructureIssueCode = 'missing-root-paragraph' | 'missing-root-section-break' | 'paragraph-token-mismatch' | 'duplicate-paragraph-metadata' | 'section-break-token-mismatch' | 'duplicate-section-break-metadata' | 'missing-section-id' | 'duplicate-section-id' | 'table-start-token-mismatch' | 'table-end-token-mismatch' | 'missing-table-metadata' | 'overlapping-table' | 'block-range-token-mismatch' | 'missing-block-range-metadata' | 'overlapping-block-range' | 'unbalanced-block' | 'column-group-range-token-mismatch' | 'missing-column-group-metadata' | 'overlapping-column-group' | 'column-group-column-count-mismatch' | 'custom-block-token-mismatch' | 'missing-custom-block-metadata' | 'duplicate-custom-block-metadata' | 'empty-column' | 'empty-table-cell' | 'unbalanced-column-group' | 'unbalanced-table';
+export interface IDocStructureIssue {
+    code: DocStructureIssueCode;
+    segmentType: 'body' | 'header' | 'footer';
+    segmentId?: string;
+    index?: number;
+    message: string;
+}
+interface IValidationContext {
+    segmentType: IDocStructureIssue['segmentType'];
+    segmentId?: string;
+}
+export declare function validateDocBodyStructure(body: IDocumentBody, context?: IValidationContext): IDocStructureIssue[];
+export declare function validateDocumentStructure(snapshot: Pick<IDocumentData, 'body' | 'headers' | 'footers'>): IDocStructureIssue[];
+export {};

package/lib/types/docs/data-model/text-x/utils.d.ts

@@ -21,14 +21,19 @@ export declare enum SliceBodyType {
     copy = 0,
     cut = 1
 }
+export declare enum SliceStructuralRangeMode {
+    intersect = 0,
+    contained = 1,
+    ending = 2
+}
 export declare function getTextRunSlice(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyTextRuns?: boolean): ITextRun[] | undefined;
-export declare function getTableSlice(body: IDocumentBody, startOffset: number, endOffset: number): {
+export declare function getTableSlice(body: IDocumentBody, startOffset: number, endOffset: number, mode?: SliceStructuralRangeMode): {
     startIndex: number;
     endIndex: number;
     tableId: string;
 }[];
-export declare function getBlockRangeSlice(body: IDocumentBody, startOffset: number, endOffset: number): IDocumentBlockRange[];
-export declare function getColumnGroupSlice(body: IDocumentBody, startOffset: number, endOffset: number): ICustomColumnGroup[];
+export declare function getBlockRangeSlice(body: IDocumentBody, startOffset: number, endOffset: number, mode?: SliceStructuralRangeMode): IDocumentBlockRange[];
+export declare function getColumnGroupSlice(body: IDocumentBody, startOffset: number, endOffset: number, mode?: SliceStructuralRangeMode): ICustomColumnGroup[];
 export declare function getParagraphsSlice(body: IDocumentBody, startOffset: number, endOffset: number, type?: SliceBodyType): {
     startIndex: number;
     paragraphId: string;
@@ -37,6 +42,7 @@ export declare function getParagraphsSlice(body: IDocumentBody, startOffset: num
 }[] | undefined;
 export declare function getSectionBreakSlice(body: IDocumentBody, startOffset: number, endOffset: number): {
     startIndex: number;
+    sectionId: string;
     pageNumberStart?: number;
     pageSize?: import("../../..").ISize;
     pageOrient?: import("../../..").PageOrientType;
@@ -71,7 +77,9 @@ export declare function getCustomBlockSlice(body: IDocumentBody, startOffset: nu
     blockType?: import("../../..").BlockType;
     blockId: string;
 }[] | undefined;
-export declare function getBodySlice(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyArray?: boolean, type?: SliceBodyType): IDocumentBody;
+export declare function getBodySlice(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyArray?: boolean, type?: SliceBodyType, structuralRangeMode?: SliceStructuralRangeMode): IDocumentBody;
+export declare function getBodySliceForTextXAction(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyArray?: boolean, type?: SliceBodyType): IDocumentBody;
+export declare function getBodySliceForSplitTextXAction(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyArray?: boolean, type?: SliceBodyType): IDocumentBody;
 export declare function normalizeBody(body: IDocumentBody): IDocumentBody;
 export declare function getCustomRangeSlice(body: IDocumentBody, startOffset: number, endOffset: number): {
     customRanges?: undefined;

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

@@ -14,3 +14,8 @@
  * limitations under the License.
  */
 export * from './data-model';
+export { cloneBodyWithFreshParagraphIds, cloneParagraphWithId, createParagraphId, PARAGRAPH_ID_PREFIX, } from './paragraph-id';
+export type { IParagraphIdScope } from './paragraph-id';
+export { cloneSectionBreakWithId, createSectionId, SECTION_ID_PREFIX, } from './section-break-id';
+export { getSectionHeaderFooterReferenceKey, resolveSectionHeaderFooterReference, resolveSectionHeaderFooterReferences, } from './section-header-footer';
+export type { IResolvedSectionHeaderFooterReference, SectionHeaderFooterKind, SectionHeaderFooterReferenceKey, SectionHeaderFooterVariant, } from './section-header-footer';

package/lib/types/docs/section-break-id.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 { ISectionBreak } from '../types/interfaces/i-document-data';
+export declare const SECTION_ID_PREFIX = "section_";
+export declare function createSectionId(existingIds: Set<string>): string;
+export declare function cloneSectionBreakWithId(sectionBreak: ISectionBreak, existingIds: Set<string>, preserveId?: boolean): ISectionBreak;

package/lib/types/docs/section-header-footer.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { IDocumentStyle, ISectionBreak } from '../types/interfaces/i-document-data';
+export type SectionHeaderFooterKind = 'header' | 'footer';
+export type SectionHeaderFooterVariant = 'default' | 'first' | 'even';
+export type SectionHeaderFooterReferenceKey = 'defaultHeaderId' | 'defaultFooterId' | 'firstPageHeaderId' | 'firstPageFooterId' | 'evenPageHeaderId' | 'evenPageFooterId';
+export interface IResolvedSectionHeaderFooterReference {
+    segmentId?: string;
+    linkedToPrevious: boolean;
+    sourceSectionId?: string;
+}
+export declare function getSectionHeaderFooterReferenceKey(kind: SectionHeaderFooterKind, variant: SectionHeaderFooterVariant): SectionHeaderFooterReferenceKey;
+/**
+ * Resolves one OOXML header/footer reference for a document section.
+ * A missing reference after the first section inherits the previous section.
+ * Document-level references are defaults for the first section only.
+ */
+export declare function resolveSectionHeaderFooterReference(documentStyle: IDocumentStyle, sections: Readonly<ISectionBreak[]>, sectionIndex: number, key: SectionHeaderFooterReferenceKey): IResolvedSectionHeaderFooterReference;
+export declare function resolveSectionHeaderFooterReferences(documentStyle: IDocumentStyle, sections: Readonly<ISectionBreak[]>, sectionIndex: number): Pick<ISectionBreak, SectionHeaderFooterReferenceKey>;

package/lib/types/facade/f-enum.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AbsoluteRefType, AutoFillSeries, BaselineOffset, BooleanNumber, BorderStyleTypes, BorderType, ColorType, CommandType, CommonHideTypes, CopyPasteType, DataValidationErrorStyle, DataValidationOperator, DataValidationRenderMode, DataValidationStatus, DataValidationType, DeleteDirection, DeveloperMetadataVisibility, Dimension, Direction, HorizontalAlign, InterpolationPointType, LifecycleStages, LocaleType, MentionType, ProtectionType, RelativeDate, SheetTypes, TextDecoration, TextDirection, ThemeColorType, UniverInstanceType, VerticalAlign, WrapStrategy } from '@univerjs/core';
+import { AbsoluteRefType, AutoFillSeries, BaselineOffset, BooleanNumber, BorderStyleTypes, BorderType, ColorType, CommandType, CommonHideTypes, CopyPasteType, DataValidationErrorStyle, DataValidationOperator, DataValidationRenderMode, DataValidationStatus, DataValidationType, DeleteDirection, DeveloperMetadataVisibility, Dimension, Direction, HorizontalAlign, ImageSourceType, InterpolationPointType, LifecycleStages, LocaleType, MentionType, NumberUnitType, PresetListType, ProtectionType, RelativeDate, SheetTypes, SpacingRule, TextDecoration, TextDirection, ThemeColorType, UniverInstanceType, VerticalAlign, WrapStrategy } from '@univerjs/core';
 /**
  * @hideconstructor
  */
@@ -136,6 +136,36 @@ export declare class FEnum {
      * ```
      */
     get HorizontalAlign(): typeof HorizontalAlign;
+    /**
+     * Paragraph line-height interpretation modes
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.SpacingRule.EXACT);
+     * ```
+     */
+    get SpacingRule(): typeof SpacingRule;
+    /**
+     * Units accepted by document lengths such as paragraph indentation and spacing
+     *
+     * Agent-facing rich-text helpers accept plain numbers as document points, so this enum is only needed when an
+     * explicit alternative unit is required.
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.NumberUnitType.POINT);
+     * ```
+     */
+    get NumberUnitType(): typeof NumberUnitType;
+    /**
+     * Preset ordered, unordered, and checklist styles used by rich-text list items
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.PresetListType.BULLET_LIST);
+     * ```
+     */
+    get PresetListType(): typeof PresetListType;
     /**
      * Different text decoration styles
      *
@@ -325,4 +355,13 @@ export declare class FEnum {
      * ```
      */
     get ThemeColorType(): typeof ThemeColorType;
+    /**
+     * Image source types
+     *
+     * @example
+     * ```ts
+     * console.log(univerAPI.Enum.ImageSourceType.URL);
+     * ```
+     */
+    get ImageSourceType(): typeof ImageSourceType;
 }

package/lib/types/facade/f-hooks.d.ts

@@ -25,41 +25,49 @@ export declare class FHooks extends FBase {
     constructor(_injector: Injector, _lifecycleService: LifecycleService);
     /**
      * @param callback
+     * @returns {IDisposable} A disposable used to remove the listener.
      * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
      */
     onStarting(callback: () => void): IDisposable;
     /**
      * @param callback
+     * @returns {IDisposable} A disposable used to remove the listener.
      * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
      */
     onReady(callback: () => void): IDisposable;
     /**
      * @param callback
+     * @returns {IDisposable} A disposable used to remove the listener.
      * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
      */
     onRendered(callback: () => void): IDisposable;
     /**
      * @param callback
+     * @returns {IDisposable} A disposable used to remove the listener.
      * @deprecated use `univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, ({ stage }) => {})` as instead
      */
     onSteady(callback: () => void): IDisposable;
     /**
      * @param callback
+     * @returns {IDisposable} A disposable used to remove the listener.
      * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeUndo, (event) => {})` as instead
      */
     onBeforeUndo(callback: (action: IUndoRedoItem) => void): IDisposable;
     /**
      * @param callback
+     * @returns {IDisposable} A disposable used to remove the listener.
      * @deprecated use `univerAPI.addEvent(univerAPI.Event.Undo, (event) => {})` as instead
      */
     onUndo(callback: (action: IUndoRedoItem) => void): IDisposable;
     /**
      * @param callback
+     * @returns {IDisposable} A disposable used to remove the listener.
      * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeRedo, (event) => {})` as instead
      */
     onBeforeRedo(callback: (action: IUndoRedoItem) => void): IDisposable;
     /**
      * @param callback
+     * @returns {IDisposable} A disposable used to remove the listener.
      * @deprecated use `univerAPI.addEvent(univerAPI.Event.Redo, (event) => {})` as instead
      */
     onRedo(callback: (action: IUndoRedoItem) => void): IDisposable;

package/lib/types/facade/f-univer.d.ts

@@ -259,46 +259,47 @@ export declare class FUniver extends Disposable {
     newBlob(): FBlob;
     /**
      * Create a new rich text.
-     * @param {IDocumentData} data
      * @returns {RichTextBuilder} The new rich text instance
      * @example
      * ```ts
-     * const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } });
-     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
-     * if (!fWorksheet) return;
-     * const range = fWorksheet.getRange('A1');
-     * range.setRichTextValueForCell(richText);
+     * const richText = univerAPI.newRichText()
+     *   .align({ horizontal: univerAPI.Enum.HorizontalAlign.CENTER })
+     *   .text('Status: ')
+     *   .span('Ready', { bold: true, color: '#16a34a' });
      * ```
      */
-    newRichText(data?: IDocumentData): RichTextBuilder;
+    newRichText(): RichTextBuilder;
+    /**
+     * Create a rich-text builder from raw Univer document data.
+     *
+     * This is an advanced integration escape hatch for importers and adapters. Application and agent code should use
+     * the fluent builder returned by `newRichText()`.
+     *
+     * @param data Raw Univer document data.
+     * @returns A rich-text builder initialized with the supplied document data.
+     * @advanced
+     */
+    newRichTextFromDocumentData(data: IDocumentData): RichTextBuilder;
     /**
      * Create a new rich text value.
-     * @param {IDocumentData} data - The rich text data
+     *
+     * This is an advanced integration escape hatch for callers that already own Univer document data. Application and
+     * agent code should prefer the fluent value returned by `newRichText()`.
+     *
+     * @param {IDocumentData} data The raw Univer document data.
      * @returns {RichTextValue} The new rich text value instance
-     * @example
-     * ```ts
-     * const richTextValue = univerAPI.newRichTextValue({ body: { dataStream: 'Hello World\r\n' } });
-     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
-     * if (!fWorksheet) return;
-     * const range = fWorksheet.getRange('A1');
-     * range.setRichTextValueForCell(richTextValue);
-     * ```
+     * @advanced
      */
     newRichTextValue(data: IDocumentData): RichTextValue;
     /**
      * Create a new paragraph style.
-     * @param {IParagraphStyle} style - The paragraph style
+     *
+     * This is an advanced document-model API. Application and agent code should normally use
+     * `newRichText().paragraph({ ... })`.
+     *
+     * @param {IParagraphStyle} style The paragraph style
      * @returns {ParagraphStyleBuilder} The new paragraph style instance
-     * @example
-     * ```ts
-     * const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } });
-     * const paragraphStyle = univerAPI.newParagraphStyle({ textStyle: { ff: 'Arial', fs: 12, it: univerAPI.Enum.BooleanNumber.TRUE, bl: univerAPI.Enum.BooleanNumber.TRUE } });
-     * richText.insertParagraph(paragraphStyle);
-     * const fWorksheet = univerAPI.getActiveWorkbook().getSheetByName('Sheet1');
-     * if (!fWorksheet) return;
-     * const range = fWorksheet.getRange('A1');
-     * range.setRichTextValueForCell(richText);
-     * ```
+     * @advanced
      */
     newParagraphStyle(style?: IParagraphStyle): ParagraphStyleBuilder;
     /**

package/lib/types/index.d.ts

@@ -32,6 +32,7 @@ export * from './common/lodash';
 export { MemoryCursor } from './common/memory-cursor';
 export { mixinClass } from './common/mixin';
 export { isNumeric, isSafeNumeric, willLoseNumericPrecision } from './common/number';
+export { regexp } from './common/regexp';
 export { Registry, RegistryAsMap } from './common/registry';
 export { requestImmediateMacroTask } from './common/request-immediate-macro-task';
 export { sequence, sequenceAsync } from './common/sequence';
@@ -39,24 +40,7 @@ export type { ISequenceExecuteResult } from './common/sequence';
 export { mergeSets } from './common/set';
 export { UnitModel, UniverInstanceType } from './common/unit';
 export { isSafeUrl, normalizeUrl, resolveWithBasePath } from './common/url';
-export * from './docs/data-model';
-export { JSON1, JSONX } from './docs/data-model/json-x/json-x';
-export type { JSONXActions, JSONXPath } from './docs/data-model/json-x/json-x';
-export { replaceInDocumentBody } from './docs/data-model/replacement';
-export { ParagraphStyleBuilder, ParagraphStyleValue, RichTextBuilder, RichTextValue, TextDecorationBuilder, TextStyleBuilder, TextStyleValue, } from './docs/data-model/rich-text-builder';
-export { DEFAULT_DOCUMENT_SUB_COMPONENT_ID } from './docs/data-model/subdocument';
-export { ActionIterator } from './docs/data-model/text-x/action-iterator';
-export { TextXActionType } from './docs/data-model/text-x/action-types';
-export type { IDeleteAction, IInsertAction, IRetainAction, TextXAction } from './docs/data-model/text-x/action-types';
-export { normalizeTextRuns, RESTORE_INSERTED_PARAGRAPH_IDS } from './docs/data-model/text-x/apply-utils/common';
-export { updateAttributeByDelete } from './docs/data-model/text-x/apply-utils/delete-apply';
-export { updateAttributeByInsert } from './docs/data-model/text-x/apply-utils/insert-apply';
-export { getPlainText } from './docs/data-model/text-x/build-utils/parse';
-export { TextX } from './docs/data-model/text-x/text-x';
-export type { TPriority } from './docs/data-model/text-x/text-x';
-export { composeBody, getBodySlice, getCustomBlockSlice, getCustomDecorationSlice, getCustomRangeSlice, getParagraphsSlice, getRichTextEditPath, getSectionBreakSlice, getTableSlice, getTextRunSlice, normalizeBody, SliceBodyType, } from './docs/data-model/text-x/utils';
-export { cloneBodyWithFreshParagraphIds, cloneParagraphWithId, createParagraphId, PARAGRAPH_ID_PREFIX, } from './docs/paragraph-id';
-export type { IParagraphIdScope } from './docs/paragraph-id';
+export * from './docs';
 export { EventState, EventSubject, fromEventSubject } from './observer/observable';
 export type { IEventObserver } from './observer/observable';
 export { AuthzIoLocalService } from './services/authz-io/authz-io-local.service';
@@ -114,20 +98,7 @@ export { getIntersectRange } from './shared/range';
 export { afterTime, bufferDebounceTime, convertObservableToBehaviorSubject, fromCallback, takeAfter, } from './shared/rxjs';
 export { awaitTime, delayAnimationFrame } from './shared/timer';
 export { isNodeEnv } from './shared/tools';
-export * from './sheets/clone';
-export { Range } from './sheets/range';
-export { getCellCoordByIndexSimple, getCellWithCoordByIndexCore, SheetSkeleton } from './sheets/sheet-skeleton';
-export type { IGetRowColByPosOptions } from './sheets/sheet-skeleton';
-export * from './sheets/sheet-skeleton';
-export { DEFAULT_WORKSHEET_COLUMN_COUNT, DEFAULT_WORKSHEET_COLUMN_COUNT_KEY, DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT, DEFAULT_WORKSHEET_COLUMN_TITLE_HEIGHT_KEY, DEFAULT_WORKSHEET_COLUMN_WIDTH, DEFAULT_WORKSHEET_COLUMN_WIDTH_KEY, DEFAULT_WORKSHEET_ROW_COUNT, DEFAULT_WORKSHEET_ROW_COUNT_KEY, DEFAULT_WORKSHEET_ROW_HEIGHT, DEFAULT_WORKSHEET_ROW_HEIGHT_KEY, DEFAULT_WORKSHEET_ROW_TITLE_WIDTH, DEFAULT_WORKSHEET_ROW_TITLE_WIDTH_KEY, mergeWorksheetSnapshotWithDefault, } from './sheets/sheet-snapshot-utils';
-export { Styles } from './sheets/styles';
-export * from './sheets/typedef';
-export type { IPosition } from './sheets/typedef';
-export { addLinkToDocumentModel, getEmptyCell, isNotNullOrUndefined, isRangesEqual, isUnitRangesEqual, } from './sheets/util';
-export { createDocumentModelWithStyle } from './sheets/util';
-export { SheetViewModel } from './sheets/view-model';
-export { getWorksheetUID, Workbook } from './sheets/workbook';
-export { extractPureTextFromCell, getDisplayValueFromCell, getOriginCellValue, Worksheet } from './sheets/worksheet';
+export * from './sheets';
 export { Skeleton } from './skeleton';
 export * from './types/const';
 export { skipParseTagNames } from './types/const/clipboard';

package/lib/types/services/authz-io/authz-io-local.service.d.ts

@@ -66,7 +66,7 @@ export declare class AuthzIoLocalService implements IAuthzIoService {
     clearAllOverrides(objectID: string): void;
     updateCollaborator(): Promise<void>;
     createCollaborator(): Promise<void>;
-    putCollaborators(config: IPutCollaboratorsRequest): Promise<void>;
+    putCollaborators(_config: IPutCollaboratorsRequest): Promise<void>;
     setCfgEnableObjInherit(enabled: boolean): void;
     getCfgEnableObjInherit(): boolean;
 }

package/lib/types/services/instance/instance.service.d.ts

@@ -32,6 +32,28 @@ export interface ICreateUnitOptions {
      * @default true
      */
     makeCurrent?: boolean;
+    /**
+     * If product UI render services should skip their default main-canvas render
+     * creation. Embedded units create their render explicitly into a host-owned
+     * container instead.
+     *
+     * @default false
+     */
+    skipAutoRender?: boolean;
+    /**
+     * If render services should create the render unit as an embedded/non-main
+     * render. Embedded renders are mounted explicitly by a host container and
+     * must not mutate global workbench state while resolving their local view.
+     *
+     * @default false
+     */
+    embeddedRender?: boolean;
+    /**
+     * Optional parent injector for an embedded render unit. Render modules will
+     * resolve their dependencies from this injector before falling back to the
+     * root injector.
+     */
+    renderParentInjector?: Injector;
 }
 interface ICreateUnitEvent<T extends UnitModel = UnitModel> {
     unit: T;
@@ -71,6 +93,8 @@ export interface IUniverInstanceService {
     getCurrentTypeOfUnit$<T extends UnitModel>(type: UniverInstanceType): Observable<Nullable<T>>;
     /** Create a unit with snapshot info. */
     createUnit<T, U extends UnitModel>(type: UniverInstanceType, data: Partial<T>, options?: ICreateUnitOptions): U;
+    /** Get the options originally used to create a unit. */
+    getUnitCreateOptions(unitId: string): Nullable<ICreateUnitOptions>;
     /** Dispose a unit  */
     disposeUnit(unitId: string): boolean;
     registerCtorForType<T extends UnitModel>(type: UniverInstanceType, ctor: new (...args: any[]) => T): IDisposable;
@@ -88,6 +112,7 @@ export declare class UniverInstanceService extends Disposable implements IUniver
     private readonly _contextService;
     private readonly _logService;
     private readonly _unitsByType;
+    private readonly _unitCreateOptions;
     constructor(_injector: Injector, _contextService: IContextService, _logService: ILogService);
     dispose(): void;
     private _createHandler;
@@ -117,6 +142,7 @@ export declare class UniverInstanceService extends Disposable implements IUniver
     readonly unitDisposed$: Observable<UnitModel<object, UniverInstanceType>>;
     getTypeOfUnitDisposed$<T extends UnitModel<object, number>>(type: UniverInstanceType): Observable<T>;
     getUnit<T extends UnitModel = UnitModel>(id: string, type?: UniverInstanceType): Nullable<T>;
+    getUnitCreateOptions(unitId: string): Nullable<ICreateUnitOptions>;
     getUniverSheetInstance(unitId: string): Nullable<Workbook>;
     getAllUnitsForType<T>(type: UniverInstanceType): T[];
     changeDoc(unitId: string, doc: DocumentDataModel): void;

package/lib/types/services/resource-manager/type.d.ts

@@ -21,7 +21,7 @@ export type IResources = Array<{
     name: string;
     data: string;
 }>;
-type IBusinessName = 'SHEET' | 'DOC' | 'SLIDE';
+type IBusinessName = 'SHEET' | 'DOC' | 'SLIDE' | 'BASE' | 'UNIVER';
 export type IResourceName = `${IBusinessName}_${string}_PLUGIN`;
 export interface IResourceHook<T = any> {
     pluginName: IResourceName;

package/lib/types/shared/date-kit.d.ts

@@ -19,6 +19,7 @@ export type DateKitInput = Date | number | string | IDateKit | null | undefined;
 export interface IDateKit {
     isValid(): boolean;
     format(template?: string): string;
+    formatIntl(locale?: string | string[], options?: Intl.DateTimeFormatOptions): string;
     valueOf(): number;
     toDate(): Date;
     add(value: number, unit?: DateKitUnitType): IDateKit;

package/lib/types/shared/numfmt/api.d.ts

@@ -0,0 +1,82 @@
+/**
+ * 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 { FormatColor, FormatDateInfo, FormatInfo, FormatOptions } from './types';
+export { dec2frac } from './dec-to-frac';
+export { addLocale, getLocale, parseLocale } from './locale';
+export { parseBool, parseDate, parseNumber, parseTime, parseValue } from './parse-value';
+export { round } from './round';
+export { dateFromSerial, dateToSerial } from './serial-date';
+export { tokenize } from './tokenize';
+export type { FormatDateInfo, FormatInfo, FormatToken, LocaleData, LocaleToken, ParseData, } from './types';
+/**
+ * Formats a value as a string and returns the result.
+ */
+export declare function format(pattern: string, value: unknown, options?: FormatOptions): string;
+/**
+ * Find the color appropriate to a value as dictated by a format pattern.
+ */
+export declare function formatColor(pattern: string, value: unknown, options?: FormatOptions): FormatColor;
+/** Determine if a given format pattern is a date pattern. */
+export declare function isDateFormat(pattern: string): boolean;
+/** Determine if a given format pattern is a percentage pattern. */
+export declare function isPercentFormat(pattern: string): boolean;
+/** Determine if a given format pattern is a text only pattern. */
+export declare function isTextFormat(pattern: string): boolean;
+/** Determine if a given format pattern is valid. */
+export declare function isValidFormat(pattern: string): boolean;
+/** Returns metadata describing a parsed format pattern. */
+export declare function getFormatInfo(pattern: string, options?: {
+    currency?: string;
+}): FormatInfo;
+/** Gets information about date codes used in a format string. */
+export declare function getFormatDateInfo(pattern: string): FormatDateInfo;
+/** A dictionary of the types used to identify token variants. */
+export declare const tokenTypes: Readonly<{
+    AMPM: "ampm";
+    BREAK: "break";
+    CALENDAR: "calendar";
+    CHAR: "char";
+    COLOR: "color";
+    COMMA: "comma";
+    CONDITION: "condition";
+    DATETIME: "datetime";
+    DBNUM: "dbnum";
+    DIGIT: "digit";
+    DURATION: "duration";
+    ERROR: "error";
+    ESCAPED: "escaped";
+    EXP: "exp";
+    FILL: "fill";
+    GENERAL: "general";
+    GROUP: "group";
+    HASH: "hash";
+    LOCALE: "locale";
+    MINUS: "minus";
+    MODIFIER: "modifier";
+    NATNUM: "natnum";
+    PAREN: "paren";
+    PERCENT: "percent";
+    PLUS: "plus";
+    POINT: "point";
+    QMARK: "qmark";
+    SCALE: "scale";
+    SKIP: "skip";
+    SLASH: "slash";
+    SPACE: "space";
+    STRING: "string";
+    TEXT: "text";
+    ZERO: "zero";
+}>;

package/lib/types/shared/numfmt/clamp.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 clamp(number: number): number;

package/lib/types/shared/numfmt/code-to-locale.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 const codeToLocale: Readonly<Record<number, string>>;

package/lib/types/shared/numfmt/constants.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 const u_YEAR = 2;
+export declare const u_MONTH: number;
+export declare const u_DAY: number;
+export declare const u_HOUR: number;
+export declare const u_MIN: number;
+export declare const u_SEC: number;
+export declare const u_DSEC: number;
+export declare const u_CSEC: number;
+export declare const u_MSEC: number;
+export declare const MIN_S_DATE = 0;
+export declare const MAX_S_DATE = 2958466;
+export declare const MIN_L_DATE = -694324;
+export declare const MAX_L_DATE = 35830291;
+export declare const EPOCH_1904 = -1;
+export declare const EPOCH_1900 = 1;
+export declare const EPOCH_1317 = 6;
+export declare const TOKEN_GENERAL = "general";
+export declare const TOKEN_HASH = "hash";
+export declare const TOKEN_ZERO = "zero";
+export declare const TOKEN_QMARK = "qmark";
+export declare const TOKEN_SLASH = "slash";
+export declare const TOKEN_GROUP = "group";
+export declare const TOKEN_SCALE = "scale";
+export declare const TOKEN_COMMA = "comma";
+export declare const TOKEN_BREAK = "break";
+export declare const TOKEN_TEXT = "text";
+export declare const TOKEN_PLUS = "plus";
+export declare const TOKEN_MINUS = "minus";
+export declare const TOKEN_POINT = "point";
+export declare const TOKEN_SPACE = "space";
+export declare const TOKEN_PERCENT = "percent";
+export declare const TOKEN_DIGIT = "digit";
+export declare const TOKEN_CALENDAR = "calendar";
+export declare const TOKEN_ERROR = "error";
+export declare const TOKEN_DATETIME = "datetime";
+export declare const TOKEN_DURATION = "duration";
+export declare const TOKEN_CONDITION = "condition";
+export declare const TOKEN_DBNUM = "dbnum";
+export declare const TOKEN_NATNUM = "natnum";
+export declare const TOKEN_LOCALE = "locale";
+export declare const TOKEN_COLOR = "color";
+export declare const TOKEN_MODIFIER = "modifier";
+export declare const TOKEN_AMPM = "ampm";
+export declare const TOKEN_ESCAPED = "escaped";
+export declare const TOKEN_STRING = "string";
+export declare const TOKEN_SKIP = "skip";
+export declare const TOKEN_EXP = "exp";
+export declare const TOKEN_FILL = "fill";
+export declare const TOKEN_PAREN = "paren";
+export declare const TOKEN_CHAR = "char";
+export declare const indexColors: string[];
+export declare const currencySymbols: string[];
+export declare const reCurrencySymbols: RegExp;