@univerjs-pro/shape-editor-ui 1.0.0-alpha.6 → 1.0.0-alpha.7

package/lib/types/common/formula-shape-en-us.d.ts

@@ -0,0 +1,44 @@
+export declare const formulaShapeEnUS: {
+    panelTitle: string;
+    editFormula: string;
+    numberFormat: string;
+    moreFormats: string;
+    customFormatPlaceholder: string;
+    formatTypes: string;
+    decimalPlaces: string;
+    currencySymbol: string;
+    negativeNumberType: string;
+    dateType: string;
+    preview: string;
+    generalDescription: string;
+    accountingDescription: string;
+    currencyDescription: string;
+    dateDescription: string;
+    numberDescription: string;
+    customFormatDescription: string;
+    formulaPlaceholder: string;
+    sheetUnit: string;
+    baseUnit: string;
+    confirm: string;
+    cancel: string;
+    animation: string;
+    formats: {
+        general: string;
+        text: string;
+        number: string;
+        percent: string;
+        percentage: string;
+        scientific: string;
+        accounting: string;
+        financial: string;
+        currency: string;
+        roundingCurrency: string;
+        date: string;
+        time: string;
+        dateTime: string;
+        durationTime: string;
+        thousandSeparator: string;
+        custom: string;
+        more: string;
+    };
+};

package/lib/types/config/config.d.ts

@@ -1,5 +1,25 @@
+import type { IBaseSnapshot, IWorkbookData, UniverInstanceType } from '@univerjs/core';
 export declare const SHAPE_EDITOR_UI_PLUGIN_CONFIG_KEY = "shape-editor-ui.config";
 export declare const configSymbol: unique symbol;
+export type ShapeFormulaUnitType = UniverInstanceType.UNIVER_SHEET | UniverInstanceType.UNIVER_BASE;
+interface IShapeFormulaUnitResourceBase {
+    unitId: string;
+    name: string;
+}
+export type IShapeFormulaUnitResource = IShapeFormulaUnitResourceBase & ({
+    type: UniverInstanceType.UNIVER_SHEET;
+    loadSnapshot: () => Promise<IWorkbookData>;
+} | {
+    type: UniverInstanceType.UNIVER_BASE;
+    loadSnapshot: () => Promise<IBaseSnapshot>;
+});
+/** Supplies remote units that are visible to the current user. Loaded units are included automatically. */
+export interface IShapeFormulaUnitProvider {
+    listUnits: () => Promise<IShapeFormulaUnitResource[]>;
+}
 export interface IUniverShapeEditorUIConfig {
+    formulaUnitProvider?: IShapeFormulaUnitProvider;
+    formulaViewerWorkerURL?: string | Worker;
 }
 export declare const defaultPluginConfig: IUniverShapeEditorUIConfig;
+export {};

package/lib/types/index.d.ts

@@ -1,10 +1,18 @@
 import './global.css';
 export { FillStyleTabsEditor } from './components/fill-style-tabs-editor/FillStyleTabsEditor';
+export { SHAPE_EDITOR_UI_PLUGIN_CONFIG_KEY } from './config/config';
+export type { IShapeFormulaUnitProvider, IShapeFormulaUnitResource, IUniverShapeEditorUIConfig, ShapeFormulaUnitType, } from './config/config';
 export { UniverShapeEditorUIPlugin } from './plugin';
+export { ShapeFormulaUnitViewerService } from './services/shape-formula-unit-viewer.service';
+export type { ShapeFormulaViewerUnit } from './services/shape-formula-unit-viewer.service';
 export { activateDrawingObject, clearActiveDrawingObjects } from './utils/activate-drawing-object';
 export { SHAPE_FLOATING_TOOLBAR_TOP_OFFSET, SHEET_DOC_SHAPE_FLOATING_TOOLBAR_TOP_OFFSET } from './utils/shape-floating-toolbar-config';
 export { SHAPE_EDITOR_TRANSFORMER_CONFIG } from './utils/shape-transformer-config';
 export { getTextModel, getTextStyle, normalizeShapeTextModel } from './utils/util';
+export { drawFormulaShapeAnimationLayers, FormulaShapeAnimationController, } from './views/formula-shape/formula-shape-animation';
+export type { IFormulaShapeAnimationLayer } from './views/formula-shape/formula-shape-animation';
+export { resolveFormulaShapeAutoFitSize } from './views/formula-shape/formula-shape-auto-fit';
+export { useFormulaShapeToolbar } from './views/formula-shape/UseFormulaShapeToolbar';
 export { ShapeEditPanel } from './views/shape-editor-panel/ShapeEditorPanel';
 export { getInitialShapeFillType, ShapeFillEditor, } from './views/shape-editor-panel/ShapeFillEditor';
 export { ShapeImageFillEditor } from './views/shape-editor-panel/ShapeImageFillEditor';
@@ -18,7 +26,7 @@ export { ShapePickerDropdown, ShapePickerPanel } from './views/shape-picker/Shap
 export { ShapeGroupEnum, shapeTypeOptions } from './views/shape-picker/shapes';
 export type { ShapeTypeOption } from './views/shape-picker/shapes';
 export { DocParagraphTypeDropdown } from './views/shape-text-editor/DocParagraphTypeDropdown';
-export { createShapeTextBoxShapeData, resolveShapeTextEditorBehaviorShapeData, resolveShapeTextEditorFlowAxis, resolveShapeTextEditorWrapStrategy, shouldAllowShapeTextEditorHostSizeShrink, shouldAutoFitShapeTextEditorNoWrap, shouldClipShapeTextDocument, } from './views/shape-text-editor/shape-text-behavior';
+export { resolveShapeTextEditorBehaviorShapeData, resolveShapeTextEditorFlowAxis, resolveShapeTextEditorWrapStrategy, shouldAllowShapeTextEditorHostSizeShrink, shouldAutoFitShapeTextEditorNoWrap, shouldClipShapeTextDocument, } from './views/shape-text-editor/shape-text-behavior';
 export type { ShapeTextFlowAxis } from './views/shape-text-editor/shape-text-behavior';
 export { plainShapeTextToDocumentData, prepareShapeTextDocumentData, resolveShapeTextDocumentAlignment, resolveShapeTextDocumentPageHeight, stripShapeTextDocumentLayout, } from './views/shape-text-editor/shape-text-document';
 export { SHAPE_TEXT_EDITOR_QUOTE_COMMAND_ID } from './views/shape-text-editor/shape-text-editor-commands';

package/lib/types/locale/en-US.d.ts

@@ -1,6 +1,50 @@
 declare const locale: {
     'shape-editor-ui': {
         title: string;
+        formulaShape: {
+            panelTitle: string;
+            editFormula: string;
+            numberFormat: string;
+            moreFormats: string;
+            customFormatPlaceholder: string;
+            formatTypes: string;
+            decimalPlaces: string;
+            currencySymbol: string;
+            negativeNumberType: string;
+            dateType: string;
+            preview: string;
+            generalDescription: string;
+            accountingDescription: string;
+            currencyDescription: string;
+            dateDescription: string;
+            numberDescription: string;
+            customFormatDescription: string;
+            formulaPlaceholder: string;
+            sheetUnit: string;
+            baseUnit: string;
+            confirm: string;
+            cancel: string;
+            animation: string;
+            formats: {
+                general: string;
+                text: string;
+                number: string;
+                percent: string;
+                percentage: string;
+                scientific: string;
+                accounting: string;
+                financial: string;
+                currency: string;
+                roundingCurrency: string;
+                date: string;
+                time: string;
+                dateTime: string;
+                durationTime: string;
+                thousandSeparator: string;
+                custom: string;
+                more: string;
+            };
+        };
         insertShape: string;
         openPanel: string;
         deleteShape: string;

package/lib/types/services/shape-formula-editor.d.ts

@@ -0,0 +1,20 @@
+import type { FormulaSequenceNode, IFormulaRefSelection } from '@univerjs/formula-ui';
+export interface IShapeFormulaReferenceSelectionChange {
+    references: string[];
+    visibleReferenceIndexes: number[];
+    activeReferenceIndex?: number;
+    isCtrlAddMode: boolean;
+}
+export interface IShapeFormulaReferenceEditResult {
+    formula: string;
+    selectionStart: number;
+    selectionEnd: number;
+}
+export declare function applyShapeFormulaReferenceSelection(options: {
+    formula: string;
+    sequenceNodes: FormulaSequenceNode[];
+    referenceSelections?: IFormulaRefSelection[];
+    selectionStart: number;
+    selectionEnd: number;
+    change: IShapeFormulaReferenceSelectionChange;
+}): IShapeFormulaReferenceEditResult | null;

package/lib/types/services/shape-formula-reference.d.ts

@@ -0,0 +1,15 @@
+import type { IShapeFormulaIdentity } from '@univerjs-pro/shape-editor';
+import type { IBaseSnapshot, IRange, Workbook, Worksheet } from '@univerjs/core';
+export declare function buildSheetShapeFormulaReference(options: {
+    host: IShapeFormulaIdentity;
+    range: IRange;
+    workbook: Workbook;
+    worksheet: Worksheet;
+}): string;
+export declare function buildBaseShapeFormulaReference(options: {
+    fieldIds: string[];
+    hostUnitId: string;
+    snapshot: IBaseSnapshot;
+    sourceUnitId: string;
+    tableId: string;
+}): string | null;

package/lib/types/services/shape-formula-unit-viewer.service.d.ts

@@ -0,0 +1,67 @@
+import type { IShapeFormulaIdentity } from '@univerjs-pro/shape-editor';
+import type { BaseDataModel } from '@univerjs/core';
+import type { FormulaSequenceNode, IFormulaRefSelection } from '@univerjs/formula-ui';
+import type { IShapeFormulaUnitResource } from '../config/config';
+import type { IShapeFormulaReferenceSelectionChange } from './shape-formula-editor';
+import { Disposable, IConfigService, IUniverInstanceService, LocaleService, ThemeService, Workbook } from '@univerjs/core';
+export type ShapeFormulaViewerUnit = Workbook | BaseDataModel;
+export interface IShapeFormulaViewerFormulaContext {
+    formula: string;
+    sequenceNodes: FormulaSequenceNode[];
+    refSelections: IFormulaRefSelection[];
+    selectionStart: number;
+    selectionEnd: number;
+}
+/** Owns the real, isolated Univer rendered inside the cross-unit formula editor. */
+export declare class ShapeFormulaUnitViewerService extends Disposable {
+    private readonly _configService;
+    private readonly _instanceService;
+    private readonly _localeService;
+    private readonly _themeService;
+    private _univer;
+    private _activeUnitId;
+    private _container;
+    private _generation;
+    private _selectionDisposables;
+    private _formulaContext;
+    private _host;
+    private _resource;
+    private _onSelectReferences;
+    private _activeWorkbook;
+    private _activeBase;
+    private _visibleReferenceIndexes;
+    private _isApplyingBaseHighlight;
+    private _pointerCtrlKey;
+    private _pointerListener;
+    private _selectionChangingDisposable;
+    private _controlDisposables;
+    private _isDraggingFormulaSelection;
+    private _closeRequest;
+    constructor(_configService: IConfigService, _instanceService: IUniverInstanceService, _localeService: LocaleService, _themeService: ThemeService);
+    listUnits(): Promise<IShapeFormulaUnitResource[]>;
+    mount(container: HTMLElement): void;
+    switchUnit(resource: IShapeFormulaUnitResource, host: IShapeFormulaIdentity, onSelectReferences: (change: IShapeFormulaReferenceSelectionChange) => void): Promise<ShapeFormulaViewerUnit | null>;
+    private _makeBaseSnapshotReadOnly;
+    private _setBasePermissionsReadOnly;
+    updateFormulaContext(context: IShapeFormulaViewerFormulaContext): void;
+    close(): void;
+    /** Defers nested Univer disposal until the owning React tree has finished unmounting. */
+    scheduleClose(): void;
+    private _closeNow;
+    dispose(): void;
+    private _createUniver;
+    private _observeSheetSelection;
+    private _observeBaseSelection;
+    private _handleBaseSelectionChange;
+    private _getBaseReferenceSource;
+    private _emitSheetSelectionChange;
+    private _refreshFormulaSelections;
+    private _refreshSheetFormulaSelections;
+    private _refreshBaseFormulaSelection;
+    private _bindFormulaSelectionControls;
+    private _getEditingContext;
+    private _canSelectFormulaReference;
+    private _matchesSheetReference;
+    private _matchesUnitQualifier;
+    private _listLoadedUnits;
+}

package/lib/types/views/formula-shape/FormulaShapeNumberFormat.d.ts

@@ -0,0 +1,23 @@
+export type FormulaShapeNumberFormatType = 'general' | 'accounting' | 'currency' | 'date' | 'number' | 'custom';
+export type FormulaShapeNumberFormatMenuEntry = {
+    kind: 'format';
+    key: string;
+    pattern: string;
+} | {
+    kind: 'separator';
+    key: string;
+} | {
+    kind: 'more';
+};
+export declare function createFormulaShapeNumberFormatMenuEntries(currencySymbol: string): FormulaShapeNumberFormatMenuEntry[];
+export declare function resolveFormulaShapeNumberFormatType(pattern: string): FormulaShapeNumberFormatType;
+export declare function FormulaShapeNumberFormatMenu(props: {
+    onSelect: (pattern: string) => void;
+    onMore: () => void;
+}): import("react").JSX.Element;
+export declare function FormulaShapeNumberFormatDialog(props: {
+    open: boolean;
+    pattern: string;
+    onClose: () => void;
+    onConfirm: (pattern: string) => void;
+}): import("react").JSX.Element;

package/lib/types/views/formula-shape/UseFormulaShapeToolbar.d.ts

@@ -0,0 +1,13 @@
+import type { IShapeData, IShapeFormulaBinding } from '@univerjs-pro/engine-shape';
+import type { IShapeFormulaIdentity } from '@univerjs-pro/shape-editor';
+import type { ReactNode } from 'react';
+import type { IShapeFloatingToolbarExtensionGroup } from '../shape-floating-toolbar/ShapeFloatingToolbar';
+interface IUseFormulaShapeToolbarOptions extends IShapeFormulaIdentity {
+    shapeData?: IShapeData;
+    onUpdateBinding: (binding: IShapeFormulaBinding) => void;
+}
+export declare function useFormulaShapeToolbar(options: IUseFormulaShapeToolbarOptions): {
+    extensionGroups?: IShapeFloatingToolbarExtensionGroup[];
+    panel: ReactNode;
+};
+export {};

package/lib/types/views/formula-shape/formula-shape-animation.d.ts

@@ -0,0 +1,33 @@
+import type { IShapeFormulaPresentation } from '@univerjs-pro/shape-editor';
+import type { UniverRenderingContext } from '@univerjs/engine-render';
+export declare const FORMULA_SHAPE_ANIMATION_DURATION = 360;
+export declare const FORMULA_SHAPE_TEXT_FLOAT_DISTANCE = 8;
+export interface IFormulaShapeAnimationLayer {
+    key: 'current' | 'previous';
+    offsetY: number;
+    opacity: number;
+    presentation: IShapeFormulaPresentation | undefined;
+}
+export declare function resolveFormulaShapeAnimationLayers(previous: IShapeFormulaPresentation | undefined, current: IShapeFormulaPresentation | undefined, progress: number): IFormulaShapeAnimationLayer[];
+export declare class FormulaShapeAnimationController {
+    private readonly _makeDirty;
+    private readonly _onAnimationCompleted;
+    private _current;
+    private _previous;
+    private _lastResolved;
+    private _progress;
+    private _startedAt;
+    private _frameId;
+    constructor(_makeDirty: () => void, _onAnimationCompleted?: () => void);
+    setPresentation(presentation: IShapeFormulaPresentation | undefined, animate?: boolean): void;
+    getLayers(): IFormulaShapeAnimationLayer[];
+    /**
+     * Returns the resolved presentations whose text must fit inside the shape while an animation is active.
+     * Keeping both endpoints prevents either the outgoing or incoming value from overflowing the transformer.
+     */
+    getAutoFitPresentations(): IShapeFormulaPresentation[];
+    dispose(): void;
+    private readonly _tick;
+    private _cancelFrame;
+}
+export declare function drawFormulaShapeAnimationLayers(ctx: UniverRenderingContext, controller: FormulaShapeAnimationController, draw: (ctx: UniverRenderingContext, presentation: IShapeFormulaPresentation | undefined, layerKey: IFormulaShapeAnimationLayer['key']) => void): void;

package/lib/types/views/formula-shape/formula-shape-auto-fit.d.ts

@@ -0,0 +1,15 @@
+import type { IShapeData, IShapeRect } from '@univerjs-pro/engine-shape';
+import type { IDocumentData } from '@univerjs/core';
+export interface IFormulaShapeAutoFitSize {
+    width: number;
+    height: number;
+}
+/** Resolves the runtime size implied by the standard OOXML shape-text auto-fit properties. */
+export declare function resolveFormulaShapeAutoFitSize(options: {
+    documentData: IDocumentData | readonly IDocumentData[];
+    height: number;
+    shapeData: IShapeData;
+    textRect: IShapeRect;
+    width: number;
+    widthBuffer?: number;
+}): IFormulaShapeAutoFitSize | null;

package/lib/types/views/formula-shape/formula-shape-number-format-utils.d.ts

@@ -0,0 +1,17 @@
+export declare function getFormulaShapeCurrencyType(pattern: string): string | undefined;
+export declare function getFormulaShapeDecimalFromPattern(pattern: string, defaultValue?: number): number;
+export declare function setFormulaShapePatternDecimal(patterns: string, decimalLength: number): string;
+export declare function getFormulaShapeCurrencyFormatOptions(symbol: string): {
+    label: string;
+    value: string;
+    color: string | undefined;
+}[];
+export declare function getFormulaShapeDateFormatOptions(): {
+    label: string;
+    value: string;
+}[];
+export declare function getFormulaShapeNumberFormatOptions(): {
+    label: string;
+    value: string;
+    color: string | undefined;
+}[];

package/lib/types/views/shape-floating-toolbar/ShapeFloatingToolbar.d.ts

@@ -65,12 +65,15 @@ export interface IShapeFloatingToolbarProps {
     defaultStrokeColor?: string;
     onUpdateShapeData: (oldShapeJSON: {
         oldShapeData?: IShapeData;
-    }, shapeData?: IShapeData) => void;
+    }, shapeData?: IShapeData, patch?: IShapeData) => void;
     onUpdateText: (params: IShapeTextUpdateOptions) => void;
     onUpdateWrappingStyle?: (value: IShapeFloatingToolbarWrappingStyle) => void;
     groupAction?: IShapeFloatingToolbarGroupAction;
     layerActions?: IShapeFloatingToolbarLayerActions;
     extensionGroups?: IShapeFloatingToolbarExtensionGroup[];
+    collapseLabel?: string;
+    expandLabel?: string;
+    deleteLabel?: string;
     onOpenPanel?: () => void;
     onDelete?: () => void;
 }
@@ -93,6 +96,7 @@ export declare function ShapeFloatingToolbarButton(props: {
     children: ReactNode;
     className?: string;
     sizeClassName?: string;
+    tooltipVisible?: boolean;
     ariaExpanded?: boolean;
     onClick?: () => void;
     onMouseDown?: (event: MouseEvent<HTMLButtonElement>) => void;
@@ -115,6 +119,10 @@ export declare function ShapeFloatingToolbarFontSizeSelect(props: {
     onAfterChange?: () => void;
 }): import("react").JSX.Element;
 export type ShapeStrokePanelMode = 'none' | 'solid' | 'dash' | 'dot';
+export declare function buildShapeStrokeDataUpdate(currentStroke: IShapeData['stroke'], resolvedStroke: NonNullable<IShapeData['stroke']>, partial: Partial<NonNullable<IShapeData['stroke']>>): {
+    nextShapeData: IShapeData;
+    patch: IShapeData;
+};
 export interface IShapeStrokePanelContentProps {
     titleKey: string;
     shapeData: IShapeData;
@@ -136,18 +144,22 @@ export declare function ShapeStrokePanelContent(props: IShapeStrokePanelContentP
 export declare function ShapeStrokePanelButton(props: {
     titleKey: string;
     shapeData: IShapeData;
+    open?: boolean;
     disabled?: boolean;
     resetLabelKey?: string;
     fallbackColor?: string;
     onReset?: () => void;
+    onOpenChange?: (open: boolean) => void;
     onUpdateShapeData: IShapeFloatingToolbarProps['onUpdateShapeData'];
 }): import("react").JSX.Element;
 export declare function ShapeFillButton(props: {
     titleKey: string;
     shapeData: IShapeData;
+    open?: boolean;
     disabled?: boolean;
     fallbackColor?: string;
     fallbackGradientEndColor?: string;
+    onOpenChange?: (open: boolean) => void;
     onUpdateShapeData: IShapeFloatingToolbarProps['onUpdateShapeData'];
 }): import("react").JSX.Element;
 export declare function TextFillButton(props: {

package/lib/types/views/shape-text-editor/shape-text-behavior.d.ts

@@ -1,8 +1,5 @@
 import type { IShapeData, IShapeTextData } from '@univerjs-pro/engine-shape';
 import type { Nullable, WrapStrategy as WrapStrategyType } from '@univerjs/core';
-export declare function createShapeTextBoxShapeData(options: Pick<IShapeData, 'fill' | 'stroke'> & {
-    isHorizontal: boolean;
-}): IShapeData;
 export declare function resolveShapeTextEditorBehaviorShapeData(shapeData: Nullable<IShapeData> | undefined, shapeTextData: IShapeTextData): IShapeData;
 export declare function resolveShapeTextEditorWrapStrategy(shapeData: IShapeData, fallbackWrapStrategy?: WrapStrategyType): WrapStrategyType;
 export declare function shouldClipShapeTextDocument(shapeData: IShapeData, wrapStrategy?: WrapStrategyType): boolean;

package/lib/types/views/shape-text-editor/shape-text-placeholder.d.ts

@@ -4,5 +4,6 @@ export declare function createShapeTextPlaceholderDocumentData(options: {
     documentData?: IDocumentData;
     isTextBox: boolean;
     placeholder: string;
+    showPlaceholder?: boolean;
     text?: string;
 }): IDocumentData | undefined;