@sheetxl/react 0.8.0-beta.7 → 1.0.0
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.
- package/LICENSE.md +8 -7
- package/browser/esm/2YDUWXaXpl9cdsk7.mjs +8 -0
- package/browser/esm/64NfoZ1s7Oe3vdpX.mjs +60 -0
- package/browser/esm/BJDz5J4gFUEYi1Wz.mjs +36 -0
- package/browser/esm/B_CI6xMNropeWGgr.mjs +134 -0
- package/browser/esm/BgA4Cz8iMysciFOb.mjs +45 -0
- package/browser/esm/BkG6VuJDmu_hfIo6.mjs +31 -0
- package/browser/esm/BmO7yh4NjxeJylOD.mjs +14092 -0
- package/browser/esm/BwFFSeqtE3TIuvtc.mjs +341 -0
- package/browser/esm/CENTtj0PnF_tvpST.mjs +79 -0
- package/browser/esm/CVY0-_x6IgpdUVNp.mjs +264 -0
- package/browser/esm/CdyivRoMgPXvRiiE.mjs +197 -0
- package/browser/esm/CiylJlRA7mt8yjPD.mjs +128 -0
- package/browser/esm/D9CTIGFUbVGJkeVE.mjs +401 -0
- package/browser/esm/D9NgFucLwPgAQNgf.mjs +19 -0
- package/browser/esm/DdFOaG09eksHtKwT.mjs +145 -0
- package/browser/esm/DdHdNjRkzo1iShOo.mjs +78 -0
- package/browser/esm/DfIvpHB7HDdmIYNm.mjs +9560 -0
- package/browser/esm/DfNDtzixfTPjmoW_.mjs +32 -0
- package/browser/esm/Dtb9bOBjtPdUAr8x.mjs +20 -0
- package/browser/esm/Dz5pGpL4XWXVdntj.mjs +323 -0
- package/browser/esm/SJAlYSFKC-5yNZ-C.mjs +2706 -0
- package/browser/esm/chart.mjs +41 -0
- package/browser/esm/control.mjs +217 -0
- package/browser/esm/group.mjs +123 -0
- package/browser/esm/index.mjs +22289 -13986
- package/browser/esm/jHqSboF5oFvzSM7a.mjs +63 -0
- package/browser/esm/note.mjs +112 -0
- package/browser/esm/oljQE8EpIzoxUjUz.mjs +323 -0
- package/browser/esm/picture.mjs +7 -0
- package/browser/esm/shape.mjs +7 -0
- package/browser/esm/slicer.mjs +282 -0
- package/browser/esm/w8MsScJSe7QxP6jL.mjs +67 -0
- package/browser/esm/yRqWQRSVyiR1kYh8.mjs +42 -0
- package/licenses/dependencies.txt +284 -565
- package/node/esm/1XOgrNXKQF__O9SV.mjs +8 -0
- package/node/esm/Aw6aaKE_YOA1Vi_V.mjs +146 -0
- package/node/esm/B6Oqu2Gw1pwWPf_N.mjs +328 -0
- package/node/esm/BizlElAhqg_Bc624.mjs +198 -0
- package/node/esm/C06Y1xPsbxgn3YX7.mjs +128 -0
- package/node/esm/C2dHN_gvhBxlFFnJ.mjs +45 -0
- package/node/esm/C4_5UcCdys1hzt5E.mjs +68 -0
- package/node/esm/CIidiDtqyubz13ys.mjs +80 -0
- package/node/esm/CTFb8PjwC1q6yilw.mjs +80 -0
- package/node/esm/C_GJPG-BTFhta8GD.mjs +265 -0
- package/node/esm/CdTeYrDgGp-s-KNG.mjs +134 -0
- package/node/esm/CeMKhq6cSxfWzN5H.mjs +2706 -0
- package/node/esm/DJIBAu8bEDmlVjtD.mjs +20 -0
- package/node/esm/DUQ1PY9P63cTe_Es.mjs +37 -0
- package/node/esm/Db8NRp_kZ-FfkZaO.mjs +32 -0
- package/node/esm/Dl2kdvb4G_ddqeDN.mjs +19 -0
- package/node/esm/DlDr-o5nAZgPbn6R.mjs +1697 -0
- package/node/esm/DvRLP1lEBfwHBrEC.mjs +63 -0
- package/node/esm/JVlPlE1ys7DM3yCP.mjs +35 -0
- package/node/esm/NSddS40Vqf1xKdDd.mjs +406 -0
- package/node/esm/QqwCS9GFuDnQausz.mjs +66 -0
- package/node/esm/chart.mjs +41 -0
- package/node/esm/control.mjs +217 -0
- package/node/esm/group.mjs +123 -0
- package/node/esm/index.mjs +18027 -9614
- package/node/esm/note.mjs +113 -0
- package/node/esm/picture.mjs +326 -0
- package/node/esm/shape.mjs +342 -0
- package/node/esm/slicer.mjs +284 -0
- package/package.json +56 -15
- package/resources/contents.json +36 -0
- package/resources/locales/contents.json +84 -0
- package/resources/locales/de/chart.cmd.json +82 -0
- package/resources/locales/de/movable.cmd.json +68 -0
- package/resources/locales/de/picture.cmd.json +188 -0
- package/resources/locales/de/pivot.cmd.json +79 -0
- package/resources/locales/de/shape.cmd.json +17 -0
- package/resources/locales/de/sheet.cmd.json +270 -16
- package/resources/locales/de/slicer.cmd.json +17 -0
- package/resources/locales/de/sparkline.cmd.json +301 -0
- package/resources/locales/de/table.cmd.json +13 -2
- package/resources/locales/de/ui.msg.json +358 -2
- package/resources/locales/de/workbook.cmd.json +8 -1
- package/resources/locales/en/chart.cmd.json +82 -0
- package/resources/locales/en/movable.cmd.json +68 -0
- package/resources/locales/en/picture.cmd.json +188 -0
- package/resources/locales/en/pivot.cmd.json +79 -0
- package/resources/locales/en/shape.cmd.json +17 -0
- package/resources/locales/en/sheet.cmd.json +283 -17
- package/resources/locales/en/slicer.cmd.json +17 -0
- package/resources/locales/en/sparkline.cmd.json +301 -0
- package/resources/locales/en/table.cmd.json +13 -2
- package/resources/locales/en/ui.msg.json +360 -2
- package/resources/locales/en/workbook.cmd.json +8 -1
- package/types/chart.d.ts +2 -0
- package/types/control.d.ts +2 -0
- package/types/group.d.ts +2 -0
- package/types/note.d.ts +2 -0
- package/types/picture.d.ts +2 -0
- package/types/shape.d.ts +2 -0
- package/types/slicer.d.ts +2 -0
- package/types/src/annotation/RangeAnnotationLayer.d.ts +110 -0
- package/types/src/annotation/RangeAnnotationTag.d.ts +23 -0
- package/types/src/annotation/RangeAnnotations.d.ts +180 -0
- package/types/src/annotation/index.d.ts +4 -0
- package/types/src/autoFill/FillMenu.d.ts +2 -2
- package/types/src/autoFill/FillSeries.d.ts +2 -2
- package/types/src/border/StaticBorderRenderer.d.ts +18 -1
- package/types/src/border/useBorders.d.ts +95 -3
- package/types/src/cell/CellCheckboxRenderer.d.ts +20 -0
- package/types/src/cell/CellContent.d.ts +68 -0
- package/types/src/cell/CellControlContext.d.ts +37 -0
- package/types/src/cell/{FormulaCellRenderer.d.ts → CellFormulaRenderer.d.ts} +10 -7
- package/types/src/cell/CellImageRenderer.d.ts +11 -0
- package/types/src/cell/CellRenderers.d.ts +190 -0
- package/types/src/cell/{SheetCellRenderer.d.ts → CellTextRenderer.d.ts} +11 -8
- package/types/src/cell/ColumnButton.d.ts +3 -3
- package/types/src/cell/CornerTriangle.d.ts +2 -1
- package/types/src/cell/OutlineButton.d.ts +123 -0
- package/types/src/cell/PivotButton.d.ts +55 -0
- package/types/src/cell/SheetHeaderRenderer.d.ts +1 -1
- package/types/src/cell/StaticCellRenderer.d.ts +3 -3
- package/types/src/cell/_DropdownFace.d.ts +29 -0
- package/types/src/cell/index.d.ts +10 -2
- package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
- package/types/src/cell/useInsertableCellControls.d.ts +25 -0
- package/types/src/chart/ChartCommands.d.ts +15 -0
- package/types/src/chart/ChartEditor.d.ts +12 -2
- package/types/src/chart/ChartElement.d.ts +122 -0
- package/types/src/chart/ChartKind.d.ts +7 -0
- package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
- package/types/src/chart/index.d.ts +2 -1
- package/types/src/chart/paint/_fills.d.ts +24 -0
- package/types/src/chart/paint/_graphics.d.ts +38 -0
- package/types/src/chart/paint/_mode.d.ts +6 -0
- package/types/src/chart/paint/echarts.d.ts +33 -0
- package/types/src/chart/paint/index.d.ts +12 -0
- package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +140 -0
- package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
- package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
- package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
- package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
- package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
- package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
- package/types/src/chart/paint/kinds/_builtIns.d.ts +3 -0
- package/types/src/chart/paint/toEChartsOption.d.ts +42 -0
- package/types/src/checklist/ValueChecklist.d.ts +59 -18
- package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
- package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
- package/types/src/commands/ContextualToolbar.d.ts +19 -0
- package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
- package/types/src/commands/index.d.ts +1 -0
- package/types/src/comment/CommentCardRequest.d.ts +9 -9
- package/types/src/comment/index.d.ts +0 -1
- package/types/src/comment/useSheetComments.d.ts +2 -2
- package/types/src/conditionalFormat/ConditionalFormatPresets.d.ts +6 -6
- package/types/src/context/WorksheetContext.d.ts +18 -0
- package/types/src/context/index.d.ts +1 -1
- package/types/src/control/FormControlRenderers.d.ts +22 -0
- package/types/src/editableLabel/EditableLabel.d.ts +3 -1
- package/types/src/editor/EditorCommands.d.ts +3 -3
- package/types/src/editor/SheetCellEditorLayer.d.ts +2 -7
- package/types/src/editor/SheetCellEditorStartLayer.d.ts +22 -5
- package/types/src/editor/SheetCellInput.d.ts +14 -0
- package/types/src/editor/SheetEditable.d.ts +6 -6
- package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
- package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
- package/types/src/editor/VirtualKeyboardLayer.d.ts +50 -0
- package/types/src/editor/formulaAnchor.d.ts +12 -0
- package/types/src/editor/formulaPresentation.d.ts +4 -3
- package/types/src/editor/index.d.ts +2 -0
- package/types/src/editor/pickedReference.d.ts +3 -3
- package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
- package/types/src/editor/useFormulaHints.d.ts +3 -3
- package/types/src/editor/useFormulaInput.d.ts +6 -3
- package/types/src/editor/validationAlert.d.ts +24 -0
- package/types/src/form/FormulaInput.d.ts +5 -2
- package/types/src/form/useEditCommit.d.ts +23 -3
- package/types/src/form/useInputField.d.ts +2 -3
- package/types/src/frame/CommandContext.d.ts +101 -3
- package/types/src/group/GroupEditor.d.ts +25 -0
- package/types/src/index.d.ts +10 -1
- package/types/src/layer/BorderLayer.d.ts +5 -2
- package/types/src/layer/CellErrorLayer.d.ts +18 -7
- package/types/src/layer/CellFillLayer.d.ts +2 -2
- package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
- package/types/src/layer/CellInsertLayer.d.ts +71 -0
- package/types/src/layer/CircularIndicatorLayer.d.ts +3 -3
- package/types/src/layer/CommentCardLayer.d.ts +7 -9
- package/types/src/layer/CommentsLayer.d.ts +2 -2
- package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
- package/types/src/layer/ConditionalIcons.d.ts +4 -4
- package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
- package/types/src/layer/ContextMenuLayer.d.ts +2 -2
- package/types/src/layer/FreezeDragLines.d.ts +17 -0
- package/types/src/layer/GridFreezeLayer.d.ts +11 -0
- package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
- package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
- package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
- package/types/src/layer/HyperlinkLayer.d.ts +116 -0
- package/types/src/layer/MovableKindScope.d.ts +17 -0
- package/types/src/layer/PivotLayer.d.ts +47 -0
- package/types/src/layer/PivotToolbar.d.ts +29 -0
- package/types/src/layer/ProtectionLayer.d.ts +4 -5
- package/types/src/layer/RangeToolbar.d.ts +75 -0
- package/types/src/layer/ResizeIndicator.d.ts +11 -10
- package/types/src/layer/ResizeTooltip.d.ts +13 -0
- package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
- package/types/src/layer/SheetCellLayer.d.ts +15 -8
- package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
- package/types/src/layer/SheetGridLineLayer.d.ts +25 -15
- package/types/src/layer/SheetHeaderCellLayer.d.ts +10 -1
- package/types/src/layer/SheetLayers.d.ts +171 -0
- package/types/src/layer/SheetMovableLayer.d.ts +4 -3
- package/types/src/layer/SheetOutlineLayer.d.ts +40 -0
- package/types/src/layer/SheetPivotCommandLayer.d.ts +13 -0
- package/types/src/layer/SheetSparklineCommandLayer.d.ts +14 -0
- package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
- package/types/src/layer/SparklineLayer.d.ts +32 -0
- package/types/src/layer/SpillLayer.d.ts +2 -2
- package/types/src/layer/TableLayer.d.ts +6 -5
- package/types/src/layer/TableToolbar.d.ts +23 -0
- package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
- package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
- package/types/src/layer/ValidationPromptLayer.d.ts +47 -16
- package/types/src/layer/_sheetBorders.d.ts +6 -0
- package/types/src/layer/_tableColor.d.ts +6 -0
- package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
- package/types/src/layer/cellTip.d.ts +13 -0
- package/types/src/layer/freezeDragState.d.ts +21 -0
- package/types/src/layer/index.d.ts +15 -0
- package/types/src/layer/resizeIndicatorState.d.ts +3 -1
- package/types/src/layer/useFreezeDrag.d.ts +22 -0
- package/types/src/layer/useNormalBorderLines.d.ts +15 -0
- package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
- package/types/src/layer/useSheetVisibleCells.d.ts +5 -6
- package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
- package/types/src/layer/useTableHeaderCells.d.ts +2 -2
- package/types/src/layer/useValidationPicker.d.ts +3 -3
- package/types/src/layer/useVisibleTables.d.ts +2 -2
- package/types/src/layer/validationMark.d.ts +3 -3
- package/types/src/listener/index.d.ts +5 -0
- package/types/src/listener/useCell.d.ts +29 -0
- package/types/src/listener/useCellRange.d.ts +23 -0
- package/types/src/listener/useCellValue.d.ts +26 -0
- package/types/src/listener/useModelListener.d.ts +4 -4
- package/types/src/listener/useRangeListener.d.ts +13 -7
- package/types/src/listener/useRangeSnapshot.d.ts +35 -0
- package/types/src/listener/useTable.d.ts +26 -0
- package/types/src/movable/ConnectionSites.d.ts +18 -0
- package/types/src/movable/DefaultMovable.d.ts +8 -0
- package/types/src/movable/IMovableArea.d.ts +38 -0
- package/types/src/movable/MovableAdornment.d.ts +26 -0
- package/types/src/movable/MovableCommandGroups.d.ts +22 -0
- package/types/src/movable/MovableCommands.d.ts +8 -3
- package/types/src/movable/MovableControl.d.ts +80 -0
- package/types/src/movable/MovableFrame.d.ts +18 -16
- package/types/src/movable/MovableLayer.d.ts +30 -5
- package/types/src/movable/MovableRenderers.d.ts +210 -0
- package/types/src/movable/PlaceholderFrames.d.ts +11 -0
- package/types/src/movable/RotateHandle.d.ts +37 -0
- package/types/src/movable/connect.d.ts +16 -0
- package/types/src/movable/framePlacement.d.ts +72 -0
- package/types/src/movable/geometry.d.ts +61 -0
- package/types/src/movable/index.d.ts +9 -0
- package/types/src/movable/pressTarget.d.ts +20 -0
- package/types/src/movable/useFramePreview.d.ts +17 -0
- package/types/src/picker/cellPickerOpen.d.ts +3 -3
- package/types/src/picker/useCellPicker.d.ts +7 -5
- package/types/src/picture/PictureCommands.d.ts +20 -0
- package/types/src/picture/PictureKind.d.ts +7 -0
- package/types/src/picture/_pictureHyperlink.d.ts +13 -0
- package/types/src/picture/index.d.ts +0 -1
- package/types/src/picture/pictureCrop.d.ts +32 -0
- package/types/src/pivot/PivotAreas.d.ts +16 -0
- package/types/src/pivot/PivotChip.d.ts +33 -0
- package/types/src/pivot/PivotChipMenu.d.ts +74 -0
- package/types/src/pivot/PivotCommands.d.ts +24 -0
- package/types/src/pivot/PivotFieldList.d.ts +14 -0
- package/types/src/pivot/PivotFields.d.ts +47 -0
- package/types/src/pivot/PivotFieldsModel.d.ts +143 -0
- package/types/src/pivot/PivotTablePane.d.ts +47 -0
- package/types/src/pivot/_PivotFieldsContext.d.ts +41 -0
- package/types/src/pivot/_pivotNew.d.ts +12 -0
- package/types/src/pivot/_pivotRegion.d.ts +14 -0
- package/types/src/pivot/index.d.ts +9 -0
- package/types/src/pivot/usePivotFields.d.ts +17 -0
- package/types/src/presence/PresenceCommands.d.ts +35 -0
- package/types/src/presence/PresenceHost.d.ts +58 -0
- package/types/src/presence/PresenceMessages.d.ts +42 -0
- package/types/src/presence/PresenceStore.d.ts +165 -0
- package/types/src/presence/PresenceTypes.d.ts +78 -0
- package/types/src/presence/index.d.ts +7 -0
- package/types/src/presence/usePresence.d.ts +20 -0
- package/types/src/richText/RichTextEditor.d.ts +2 -2
- package/types/src/selection/SelectionCommands.d.ts +2 -2
- package/types/src/selection/SheetSelectionLayer.d.ts +6 -12
- package/types/src/shape/ConnectorControl.d.ts +46 -0
- package/types/src/shape/ShapeCommands.d.ts +11 -0
- package/types/src/shape/ShapeControl.d.ts +8 -0
- package/types/src/shape/ShapeEditor.d.ts +15 -2
- package/types/src/shape/ShapeGallery.d.ts +31 -0
- package/types/src/shape/ShapeHandles.d.ts +28 -0
- package/types/src/shape/ShapeKind.d.ts +7 -0
- package/types/src/shape/ShapeSVG.d.ts +22 -0
- package/types/src/shape/ShapeText.d.ts +17 -0
- package/types/src/shape/icons/ShapeIcons.d.ts +16 -0
- package/types/src/shape/icons/_ShapeIconPack.d.ts +4 -0
- package/types/src/shape/index.d.ts +3 -1
- package/types/src/shape/shapeFrame.d.ts +50 -0
- package/types/src/shape/shapeStyle.d.ts +82 -0
- package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
- package/types/src/sheet/IWorksheetElement.d.ts +289 -0
- package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
- package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
- package/types/src/sheet/SheetCommands.d.ts +18 -3
- package/types/src/sheet/SheetKindIcon.d.ts +14 -0
- package/types/src/sheet/SheetOutlineElement.d.ts +70 -0
- package/types/src/sheet/SheetPanels.d.ts +11 -0
- package/types/src/sheet/SheetScrollbar.d.ts +4 -13
- package/types/src/sheet/TopLeftCorner.d.ts +2 -2
- package/types/src/sheet/WorksheetElement.d.ts +12 -0
- package/types/src/sheet/_freezeAt.d.ts +10 -0
- package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
- package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
- package/types/src/sheet/circularReferences.d.ts +4 -4
- package/types/src/sheet/index.d.ts +5 -2
- package/types/src/sheet/useCycleHighlight.d.ts +2 -2
- package/types/src/slicer/SlicerCommands.d.ts +10 -0
- package/types/src/slicer/SlicerEditor.d.ts +8 -2
- package/types/src/slicer/SlicerKind.d.ts +7 -0
- package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
- package/types/src/slicer/index.d.ts +2 -1
- package/types/src/slicer/slicerStyles.d.ts +32 -0
- package/types/src/sparkline/PictureCache.d.ts +37 -0
- package/types/src/sparkline/SparklineCommands.d.ts +23 -0
- package/types/src/sparkline/SparklinePictures.d.ts +7 -0
- package/types/src/sparkline/paint/_drawing.d.ts +24 -0
- package/types/src/sparkline/paint/echarts.d.ts +8 -0
- package/types/src/sparkline/paint/index.d.ts +8 -0
- package/types/src/tabStrip/SheetTab.d.ts +1 -1
- package/types/src/tabStrip/Sortable.d.ts +5 -5
- package/types/src/tabStrip/TabStrip.d.ts +13 -6
- package/types/src/tabStrip/TabStripItem.d.ts +15 -13
- package/types/src/table/TableCommands.d.ts +2 -2
- package/types/src/taskPane/CellControlPane.d.ts +15 -0
- package/types/src/taskPane/MovablePane.d.ts +15 -0
- package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
- package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
- package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
- package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
- package/types/src/taskPane/_paneReasons.d.ts +7 -0
- package/types/src/taskPane/index.d.ts +3 -0
- package/types/src/taskPane/useTaskPane.d.ts +6 -3
- package/types/src/theme/ExplicitTokens.d.ts +18 -0
- package/types/src/theme/GridColorSchemeContext.d.ts +8 -0
- package/types/src/theme/ThemeRootStyles.d.ts +31 -0
- package/types/src/theme/ThemeState.d.ts +2 -2
- package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
- package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
- package/types/src/theme/buildTokensCSS.d.ts +15 -0
- package/types/src/theme/index.d.ts +2 -4
- package/types/src/theme/useAppColorScheme.d.ts +4 -1
- package/types/src/theme/useGridColorScheme.d.ts +9 -4
- package/types/src/theme/useSystemColors.d.ts +1 -15
- package/types/src/workbook/DefaultMovableRenderers.d.ts +20 -0
- package/types/src/workbook/DefaultRenderers.d.ts +5 -4
- package/types/src/workbook/IWorkbookElement.d.ts +176 -30
- package/types/src/workbook/WorkbookCommands.d.ts +6 -1
- package/types/src/workbook/WorkbookStrip.d.ts +14 -5
- package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
- package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +0 -156
- package/browser/cjs/index.cjs +0 -42
- package/browser/esm/CwXbsCWTrl3QB1t6.mjs +0 -6286
- package/node/esm/CZc8rKcLzArmqJz2.mjs +0 -9
- package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/area-template.json.d.ts +0 -9
- package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/bar-template.json.d.ts +0 -9
- package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/column-template.json.d.ts +0 -9
- package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
- package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
- package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
- package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
- package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
- package/types/src/chart/templates/line-template.json.d.ts +0 -9
- package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
- package/types/src/chart/templates/pie-template.json.d.ts +0 -9
- package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
- package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
- package/types/src/context/SheetContext.d.ts +0 -18
- package/types/src/movable/MoveableBundle.d.ts +0 -4
- package/types/src/sheet/ISheetElement.d.ts +0 -258
- package/types/src/sheet/SheetElement.d.ts +0 -15
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
import { IPivotTable } from '@sheetxl/sdk';
|
|
2
|
+
/**
|
|
3
|
+
* A pivot table's field list as a user works it, with no UI: what each field is and where it sits,
|
|
4
|
+
* the four areas in order, and one method per gesture (DESIGN-PIVOT-UI §3). A view renders
|
|
5
|
+
* {@link getSnapshot} and calls the gestures; it hears every change, the table's own and those made
|
|
6
|
+
* by script, undo or another view, through {@link subscribe}.
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* Reads and writes through the public {@link IPivotTable} only, so the same model drives a task pane
|
|
10
|
+
* beside a sheet and a pivot widget with no grid. Each gesture is one step to undo, two calls
|
|
11
|
+
* included, and gestures run one after another in the order they are asked for. A refused gesture
|
|
12
|
+
* rejects with the table's error and changes nothing.
|
|
13
|
+
*
|
|
14
|
+
* While anything subscribes, the snapshot is the same object until the table changes, as
|
|
15
|
+
* `useSyncExternalStore` needs; otherwise each call reads the table afresh.
|
|
16
|
+
*/
|
|
17
|
+
export declare class PivotFieldsModel {
|
|
18
|
+
private _pivot;
|
|
19
|
+
private _snapshot;
|
|
20
|
+
private _listeners;
|
|
21
|
+
private _removeSheetListener;
|
|
22
|
+
private _queue;
|
|
23
|
+
constructor(pivot: IPivotTable);
|
|
24
|
+
/** The table the model works. */
|
|
25
|
+
getPivotTable(): IPivotTable;
|
|
26
|
+
/** The table as the field list shows it now. */
|
|
27
|
+
getSnapshot(): PivotFieldsModel.Snapshot;
|
|
28
|
+
/**
|
|
29
|
+
* Calls `listener` after each change to the table; returns the call that stops it. The model
|
|
30
|
+
* listens to the table's sheet while anything listens to it.
|
|
31
|
+
*/
|
|
32
|
+
subscribe(listener: () => void): () => void;
|
|
33
|
+
/** Stops listening to the table, whoever still subscribes. */
|
|
34
|
+
close(): void;
|
|
35
|
+
/**
|
|
36
|
+
* Ticks a field in the list: a field of numbers goes to the values, as a Sum; any other to the
|
|
37
|
+
* rows, after the last ({@link IPivotTable.IField.getDataType}). Nothing for a field already ticked.
|
|
38
|
+
*/
|
|
39
|
+
tick(field: string): Promise<void>;
|
|
40
|
+
/** Unticks a field in the list: it comes off its axis and every value summarizing it goes. */
|
|
41
|
+
untick(field: string): Promise<void>;
|
|
42
|
+
/**
|
|
43
|
+
* Puts a chip, or a field from the list, in an area at `index` (counted from 0 among the area's
|
|
44
|
+
* chips, the values' slot among them); absent, after the last.
|
|
45
|
+
*
|
|
46
|
+
* @remarks
|
|
47
|
+
* - A field to the rows, columns or filters moves there; within its own area it changes place.
|
|
48
|
+
* - A field to the values is summarized, leaving any axis it was on, as Excel's does.
|
|
49
|
+
* - A value to another area: it goes, and its field takes that area.
|
|
50
|
+
* - The values' slot moves between the rows and the columns only.
|
|
51
|
+
*/
|
|
52
|
+
place(item: PivotFieldsModel.Draggable, area: PivotFieldsModel.Area, index?: number): Promise<void>;
|
|
53
|
+
/**
|
|
54
|
+
* Takes a chip off the table: a field off its axis, a value deleted. The values' slot deletes every
|
|
55
|
+
* value, as Excel's does.
|
|
56
|
+
*/
|
|
57
|
+
remove(item: PivotFieldsModel.Draggable): Promise<void>;
|
|
58
|
+
/** Changes what a value computes; a caption the table made follows it, as Excel's does. */
|
|
59
|
+
setFunction(value: string, fn: IPivotTable.IDataField.Function): Promise<void>;
|
|
60
|
+
/**
|
|
61
|
+
* Changes a value's settings as one step to undo: its function, then how it is shown, then its
|
|
62
|
+
* number format, then its caption. What `settings` leaves out stays.
|
|
63
|
+
*
|
|
64
|
+
* @remarks
|
|
65
|
+
* The order is the dialog's: a function rewrites the caption and a kind of show-as the format, so a
|
|
66
|
+
* caption or a format asked for with them is the one the value keeps.
|
|
67
|
+
*/
|
|
68
|
+
applyValueSettings(value: string, settings: PivotFieldsModel.ValueSettings): Promise<void>;
|
|
69
|
+
/** Renames a chip: a field, a value, or the values' slot. */
|
|
70
|
+
rename(item: PivotFieldsModel.Draggable, name: string): Promise<void>;
|
|
71
|
+
/** A field to a row, column or page area at `position`, or along it when it is there already. */
|
|
72
|
+
private _toAxis;
|
|
73
|
+
private _field;
|
|
74
|
+
private _data;
|
|
75
|
+
/** Runs `gesture` after those asked for before it. */
|
|
76
|
+
private _run;
|
|
77
|
+
/** Runs calls as one step to undo, on the table as the batch's workbook reaches it. */
|
|
78
|
+
private _batch;
|
|
79
|
+
private _changed;
|
|
80
|
+
private _stopListening;
|
|
81
|
+
}
|
|
82
|
+
export declare namespace PivotFieldsModel {
|
|
83
|
+
/** An area of the field list, by the axis it puts a field on. */
|
|
84
|
+
type Area = 'row' | 'column' | 'page' | 'values';
|
|
85
|
+
/** A field of the table's source, as the list shows it. */
|
|
86
|
+
interface Field {
|
|
87
|
+
/** Its caption. */
|
|
88
|
+
readonly name: string;
|
|
89
|
+
readonly dataType: IPivotTable.IField.DataType;
|
|
90
|
+
/** On an axis or summarized: its box is ticked. */
|
|
91
|
+
readonly ticked: boolean;
|
|
92
|
+
readonly axis: IPivotTable.Axis | null;
|
|
93
|
+
readonly filtered: boolean;
|
|
94
|
+
}
|
|
95
|
+
/** A field on the rows, columns or filters. */
|
|
96
|
+
interface FieldChip {
|
|
97
|
+
readonly kind: 'field';
|
|
98
|
+
readonly name: string;
|
|
99
|
+
readonly filtered: boolean;
|
|
100
|
+
}
|
|
101
|
+
/** Where the values sit among the rows or columns (`Σ Values`), with two values or more. */
|
|
102
|
+
interface ValuesChip {
|
|
103
|
+
readonly kind: 'values';
|
|
104
|
+
readonly name: string;
|
|
105
|
+
}
|
|
106
|
+
/** A value: a field summarized by a function. */
|
|
107
|
+
interface DataChip {
|
|
108
|
+
readonly kind: 'data';
|
|
109
|
+
readonly name: string;
|
|
110
|
+
/** The caption of the field it summarizes. */
|
|
111
|
+
readonly field: string;
|
|
112
|
+
readonly function: IPivotTable.IDataField.Function;
|
|
113
|
+
}
|
|
114
|
+
type Chip = FieldChip | ValuesChip | DataChip;
|
|
115
|
+
/** A value's settings to change ({@link PivotFieldsModel.applyValueSettings}); what is absent stays. */
|
|
116
|
+
interface ValueSettings {
|
|
117
|
+
readonly function?: IPivotTable.IDataField.Function;
|
|
118
|
+
/** `null` shows it as it is. */
|
|
119
|
+
readonly showAs?: IPivotTable.IDataField.ShowAs | null;
|
|
120
|
+
/** A format code. */
|
|
121
|
+
readonly numberFormat?: string;
|
|
122
|
+
readonly name?: string;
|
|
123
|
+
}
|
|
124
|
+
/** What a gesture takes: a chip, or a field from the list by its caption. */
|
|
125
|
+
type Draggable = Chip | {
|
|
126
|
+
readonly kind: 'field';
|
|
127
|
+
readonly name: string;
|
|
128
|
+
};
|
|
129
|
+
interface Snapshot {
|
|
130
|
+
/** The table is gone: deleted, or its sheet closed. */
|
|
131
|
+
readonly deleted: boolean;
|
|
132
|
+
readonly name: string;
|
|
133
|
+
/** As {@link IPivotTable.getSource}. */
|
|
134
|
+
readonly source: string | null;
|
|
135
|
+
/** Its location, without the page fields: `A3:D20`. */
|
|
136
|
+
readonly location: string | null;
|
|
137
|
+
/** The source's fields, in its order. */
|
|
138
|
+
readonly fields: readonly Field[];
|
|
139
|
+
/** Each area's chips, outermost or first first. */
|
|
140
|
+
readonly areas: Readonly<Record<Area, readonly Chip[]>>;
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
//# sourceMappingURL=PivotFieldsModel.d.ts.map
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { IPivotTable } from '@sheetxl/sdk';
|
|
3
|
+
import { TaskPaneProps } from '../taskPane/ITaskPane';
|
|
4
|
+
import { PivotFieldsProps } from './PivotFields';
|
|
5
|
+
/** What the PivotTable Fields pane can be asked to show (`activateTaskPane(key, { args })`). */
|
|
6
|
+
export interface PivotTablePaneArgs {
|
|
7
|
+
/** The table to show; absent, the one the selection is in. */
|
|
8
|
+
pivot?: IPivotTable;
|
|
9
|
+
}
|
|
10
|
+
/** What {@link PivotTablePaneProps.renderHeader} is handed. */
|
|
11
|
+
export interface PivotTableHeaderProps {
|
|
12
|
+
/** The table the pane shows. */
|
|
13
|
+
pivot: IPivotTable;
|
|
14
|
+
/** Its name now. */
|
|
15
|
+
name: string;
|
|
16
|
+
/** Its source now, as {@link IPivotTable.getSource}. */
|
|
17
|
+
source: string | null;
|
|
18
|
+
/** Shows an error from a change the header made. */
|
|
19
|
+
onError: (error: unknown) => void;
|
|
20
|
+
}
|
|
21
|
+
/** Props for {@link PivotTablePane}. */
|
|
22
|
+
export interface PivotTablePaneProps extends TaskPaneProps<any, PivotTablePaneArgs> {
|
|
23
|
+
/** As {@link PivotFieldsProps.renderMenu}. */
|
|
24
|
+
renderMenu?: PivotFieldsProps['renderMenu'];
|
|
25
|
+
/** As {@link PivotFieldsProps.renderFilter}. */
|
|
26
|
+
renderFilter?: PivotFieldsProps['renderFilter'];
|
|
27
|
+
/**
|
|
28
|
+
* The table's name and source above its fields, for a host that edits them. Absent, the name is
|
|
29
|
+
* shown as text.
|
|
30
|
+
*/
|
|
31
|
+
renderHeader?: (props: PivotTableHeaderProps) => React.ReactNode;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* The PivotTable Fields pane: the {@link PivotFields} of one pivot table.
|
|
35
|
+
*
|
|
36
|
+
* @remarks
|
|
37
|
+
* It opens on the table it is asked for, or the one the active cell is in, and then follows the
|
|
38
|
+
* active cell: into another pivot table, or out of every table to an empty pane.
|
|
39
|
+
*/
|
|
40
|
+
export declare const PivotTablePane: (props: PivotTablePaneProps) => React.ReactElement;
|
|
41
|
+
/**
|
|
42
|
+
* Registers the PivotTable Fields pane ({@link PivotTablePane}) with the default task pane registry,
|
|
43
|
+
* unless a pane is already registered under its key. The `editPivotTable` command calls it before
|
|
44
|
+
* opening the pane.
|
|
45
|
+
*/
|
|
46
|
+
export declare function registerPivotTablePane(): void;
|
|
47
|
+
//# sourceMappingURL=PivotTablePane.d.ts.map
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { PivotFieldsModel } from './PivotFieldsModel';
|
|
3
|
+
import { PivotChipMenuRenderProps } from './PivotChipMenu';
|
|
4
|
+
import { PivotMenuRenderProps } from '../workbook/IWorkbookElement';
|
|
5
|
+
/** What the field list and the areas share under a {@link PivotDragContext}. */
|
|
6
|
+
export interface PivotFieldsContextValue {
|
|
7
|
+
model: PivotFieldsModel;
|
|
8
|
+
snapshot: PivotFieldsModel.Snapshot;
|
|
9
|
+
/** Runs a gesture; a refused one goes to the host's error handler. */
|
|
10
|
+
run: (gesture: Promise<void>) => void;
|
|
11
|
+
/** As {@link PivotDragContextProps.renderMenu}. */
|
|
12
|
+
renderMenu: ((props: PivotChipMenuRenderProps) => React.ReactNode) | null | undefined;
|
|
13
|
+
/** As {@link PivotDragContextProps.renderFilter}. */
|
|
14
|
+
renderFilter: ((props: PivotMenuRenderProps) => React.ReactNode) | null | undefined;
|
|
15
|
+
}
|
|
16
|
+
export declare const PivotFieldsContext: React.Context<PivotFieldsContextValue | null>;
|
|
17
|
+
export declare const usePivotFieldsContext: () => PivotFieldsContextValue;
|
|
18
|
+
/** The droppable that is the field list: a chip dropped on it comes off the table. */
|
|
19
|
+
export declare const LIST_ID = "pivot-list";
|
|
20
|
+
/** The droppable that is the whole drag context: a drop on it, between the areas, does nothing. */
|
|
21
|
+
export declare const ROOT_ID = "pivot-root";
|
|
22
|
+
/** An area's droppable: a drop on its empty space goes after its last chip. */
|
|
23
|
+
export declare const areaId: (area: PivotFieldsModel.Area) => string;
|
|
24
|
+
/** A chip's id, unique across the areas. */
|
|
25
|
+
export declare const chipId: (area: PivotFieldsModel.Area, chip: PivotFieldsModel.Chip) => string;
|
|
26
|
+
/** A list row's id. */
|
|
27
|
+
export declare const rowId: (field: string) => string;
|
|
28
|
+
/** What a draggable carries, and what a chip carries as a drop target. */
|
|
29
|
+
export interface PivotDragData {
|
|
30
|
+
item: PivotFieldsModel.Draggable;
|
|
31
|
+
/** The area it is in; `null` for a row of the list. */
|
|
32
|
+
area: PivotFieldsModel.Area | null;
|
|
33
|
+
/** Its place in its area. */
|
|
34
|
+
index?: number;
|
|
35
|
+
}
|
|
36
|
+
/** What an area or the list carries as a drop target. */
|
|
37
|
+
export interface PivotDropData {
|
|
38
|
+
area?: PivotFieldsModel.Area;
|
|
39
|
+
list?: boolean;
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=_PivotFieldsContext.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { ICellRanges, IWorksheet } from '@sheetxl/sdk';
|
|
2
|
+
import { CommandContext } from '../frame';
|
|
3
|
+
/** The name `add` gives a new table: one past the highest `PivotTableN` in the workbook. */
|
|
4
|
+
export declare const nextPivotName: (sheet: IWorksheet) => string;
|
|
5
|
+
/** The sheet a new table at `location` goes on: `location`'s, or `sheet` while there is none. */
|
|
6
|
+
export declare const pivotSheetOf: (sheet: IWorksheet, location: ICellRanges | null) => IWorksheet;
|
|
7
|
+
/**
|
|
8
|
+
* What the New PivotTable dialog checks as it is filled in, before `add` would refuse: the name, as
|
|
9
|
+
* a table's on the sheet it goes on, and that nothing is in the empty table's cells.
|
|
10
|
+
*/
|
|
11
|
+
export declare const pivotTableTargetOf: (sheet: IWorksheet) => CommandContext.PivotTableTarget;
|
|
12
|
+
//# sourceMappingURL=_pivotNew.d.ts.map
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { RangeCoords } from '@sheetxl/utils';
|
|
2
|
+
import { IPivotTable, IWorksheet } from '@sheetxl/sdk';
|
|
3
|
+
/** A table's regions: its body, then the page fields above it when it has any. */
|
|
4
|
+
export declare const pivotRegions: (pivot: IPivotTable) => RangeCoords[];
|
|
5
|
+
/** The smallest range holding all of a table's regions. */
|
|
6
|
+
export declare const pivotBounds: (pivot: IPivotTable) => RangeCoords;
|
|
7
|
+
/**
|
|
8
|
+
* The pivot table `range` lies entirely within, in its body or in its page fields, as Excel's
|
|
9
|
+
* PivotTable tab opens for either. Tables per sheet are few, so the scan is cheap.
|
|
10
|
+
*/
|
|
11
|
+
export declare const pivotOfRange: (sheet: IWorksheet, range: RangeCoords) => IPivotTable | null;
|
|
12
|
+
/** The pivot table the selection's active cell is in, in its body or its page fields. */
|
|
13
|
+
export declare const pivotOfActiveCell: (sheet: IWorksheet) => IPivotTable | null;
|
|
14
|
+
//# sourceMappingURL=_pivotRegion.d.ts.map
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export * from './PivotFieldsModel';
|
|
2
|
+
export * from './usePivotFields';
|
|
3
|
+
export * from './PivotFields';
|
|
4
|
+
export * from './PivotFieldList';
|
|
5
|
+
export * from './PivotAreas';
|
|
6
|
+
export * from './PivotChip';
|
|
7
|
+
export { PIVOT_VALUE_SETTINGS_WINDOW, type PivotChipMenuItem, type PivotChipMenuRenderProps } from './PivotChipMenu';
|
|
8
|
+
export * from './PivotTablePane';
|
|
9
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { IPivotTable } from '@sheetxl/sdk';
|
|
2
|
+
import { PivotFieldsModel } from './PivotFieldsModel';
|
|
3
|
+
/** What {@link usePivotFields} returns for a table. */
|
|
4
|
+
export interface PivotFieldsState {
|
|
5
|
+
/** The gestures. */
|
|
6
|
+
model: PivotFieldsModel;
|
|
7
|
+
/** The table as the field list shows it now; a new object after each change. */
|
|
8
|
+
snapshot: PivotFieldsModel.Snapshot;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* A {@link PivotFieldsModel} over `pivot` and its current snapshot. The component re-renders on every
|
|
12
|
+
* change to the table, its own or one made by script, undo or another view.
|
|
13
|
+
*
|
|
14
|
+
* @returns `null` while `pivot` is `null`.
|
|
15
|
+
*/
|
|
16
|
+
export declare function usePivotFields(pivot: IPivotTable | null): PivotFieldsState | null;
|
|
17
|
+
//# sourceMappingURL=usePivotFields.d.ts.map
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { ComponentType } from 'react';
|
|
2
|
+
import { CommandContributionComponentProps } from '@sheetxl/utils-react';
|
|
3
|
+
import { WorkbookCommandContributorData } from '../workbook/WorkbookCommandContributor';
|
|
4
|
+
import { PresenceStore } from './PresenceStore';
|
|
5
|
+
/** The registered key of the presence task pane. */
|
|
6
|
+
export declare const PRESENCE_PANE_KEY = "agent";
|
|
7
|
+
/** The agent's icon key: the base pack's, the glyph Studio marks the agent's changes with too. */
|
|
8
|
+
export declare const PRESENCE_ICON = "Agent";
|
|
9
|
+
/** Keep-open for the strip's navigator. A placeholder glyph in presence's own icon pack. */
|
|
10
|
+
export declare const PRESENCE_PIN_ICON = "plugin-agent:Pin";
|
|
11
|
+
/** The keys of the presence commands, in the `workbook` scope. */
|
|
12
|
+
export declare const PresenceCommandKeys: {
|
|
13
|
+
readonly showPane: "showAgentPane";
|
|
14
|
+
readonly clearFindings: "clearAgentFindings";
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Register presence's icon pack and the chrome (label, description, icon) of its commands.
|
|
18
|
+
*
|
|
19
|
+
* @remarks
|
|
20
|
+
* The commands live in the `workbook` scope under their own source, the way scripting injects
|
|
21
|
+
* `showScriptEditor`: the chrome is seeded here and the behavior is contributed per workbook by
|
|
22
|
+
* {@link createPresenceCommands}. Icon packs stay registered (see `DefaultIconService.register`), and
|
|
23
|
+
* the catalog is replaced, not stacked, when registered again.
|
|
24
|
+
*/
|
|
25
|
+
export declare function registerPresenceCommandChrome(): void;
|
|
26
|
+
/**
|
|
27
|
+
* The per-workbook behavior of the presence commands, bound to `store`. Register with
|
|
28
|
+
* `Command.DefaultCommandRegistry.registerDynamic('workbook', …)`.
|
|
29
|
+
*
|
|
30
|
+
* @remarks
|
|
31
|
+
* `showAgentPane` is stateful (its state is whether the pane is open), so a quick button on it reads
|
|
32
|
+
* as a toggle.
|
|
33
|
+
*/
|
|
34
|
+
export declare function createPresenceCommands(store: PresenceStore): ComponentType<CommandContributionComponentProps<WorkbookCommandContributorData>>;
|
|
35
|
+
//# sourceMappingURL=PresenceCommands.d.ts.map
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { RangeAnnotationInput } from '../annotation';
|
|
2
|
+
import { PresenceIntent, PresencePrompt, PresencePromptAnswer } from './PresenceTypes';
|
|
3
|
+
/**
|
|
4
|
+
* What the agent side pushes at the view.
|
|
5
|
+
*
|
|
6
|
+
* @remarks
|
|
7
|
+
* `highlight` ranges arrive already resolved and sheet-qualified: the host is where an unresolvable
|
|
8
|
+
* address is reported back to the agent, so nothing unresolvable reaches the store.
|
|
9
|
+
*/
|
|
10
|
+
export type PresenceHostEvent = {
|
|
11
|
+
type: 'highlight';
|
|
12
|
+
sessionId: string;
|
|
13
|
+
ranges: RangeAnnotationInput[];
|
|
14
|
+
intent: PresenceIntent;
|
|
15
|
+
} | {
|
|
16
|
+
type: 'prompt';
|
|
17
|
+
sessionId: string;
|
|
18
|
+
prompt: PresencePrompt;
|
|
19
|
+
} | {
|
|
20
|
+
type: 'prompt.cancel';
|
|
21
|
+
promptId: string;
|
|
22
|
+
} | {
|
|
23
|
+
type: 'status';
|
|
24
|
+
connected: boolean;
|
|
25
|
+
activity?: {
|
|
26
|
+
label: string;
|
|
27
|
+
};
|
|
28
|
+
meter?: number;
|
|
29
|
+
}
|
|
30
|
+
/** The history epoch moved under this session (a reload): drop everything held for it. */
|
|
31
|
+
| {
|
|
32
|
+
type: 'reset';
|
|
33
|
+
sessionId: string;
|
|
34
|
+
};
|
|
35
|
+
/** What the user did that the agent may want to hear about on its next tool result. */
|
|
36
|
+
export type PresenceUserEvent = {
|
|
37
|
+
type: 'finding.dismissed';
|
|
38
|
+
id: string;
|
|
39
|
+
} | {
|
|
40
|
+
type: 'finding.dismissedAll';
|
|
41
|
+
intent: PresenceIntent;
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* The one seam between presence and whatever carries the agent's traffic.
|
|
45
|
+
*
|
|
46
|
+
* @remarks
|
|
47
|
+
* Presence knows nothing about the transport. A host that relays MCP tool calls into the page
|
|
48
|
+
* implements this; so would one that runs the agent in-process.
|
|
49
|
+
*/
|
|
50
|
+
export interface PresenceHost {
|
|
51
|
+
/** Everything the agent side pushes at the view. Returns the unsubscribe. */
|
|
52
|
+
subscribe(listener: (event: PresenceHostEvent) => void): () => void;
|
|
53
|
+
/** Deliver the user's answer to a prompt. */
|
|
54
|
+
answerPrompt(promptId: string, answer: PresencePromptAnswer): void;
|
|
55
|
+
/** User-side events the agent may want on its next tool result. Optional. */
|
|
56
|
+
notify?(event: PresenceUserEvent): void;
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=PresenceHost.d.ts.map
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The keys of presence's strings, for `t()`. The English text is in the package's catalog
|
|
3
|
+
* (`presence.msg.json`); a host re-words or translates any of them with a language pack.
|
|
4
|
+
*/
|
|
5
|
+
export declare const PresenceMessages: {
|
|
6
|
+
readonly paneTitle: string;
|
|
7
|
+
readonly findingsOpen: string;
|
|
8
|
+
readonly needsAttention: string;
|
|
9
|
+
readonly working: string;
|
|
10
|
+
readonly position: string;
|
|
11
|
+
readonly previous: string;
|
|
12
|
+
readonly next: string;
|
|
13
|
+
readonly goToCurrent: string;
|
|
14
|
+
readonly dismiss: string;
|
|
15
|
+
readonly dismissAll: string;
|
|
16
|
+
readonly tabReview: string;
|
|
17
|
+
readonly waitingOnYou: string;
|
|
18
|
+
readonly tabHistory: string;
|
|
19
|
+
readonly historyNone: string;
|
|
20
|
+
readonly historySearch: string;
|
|
21
|
+
readonly historyClearSearch: string;
|
|
22
|
+
readonly historyNoMatches: string;
|
|
23
|
+
readonly historyKindFinding: string;
|
|
24
|
+
readonly historyKindQuestion: string;
|
|
25
|
+
readonly historyKindChange: string;
|
|
26
|
+
readonly sectionFindings: string;
|
|
27
|
+
readonly findingsNone: string;
|
|
28
|
+
readonly findingsStale: string;
|
|
29
|
+
readonly changesUntitled: string;
|
|
30
|
+
readonly promptTitle: string;
|
|
31
|
+
readonly promptOther: string;
|
|
32
|
+
readonly promptSubmit: string;
|
|
33
|
+
readonly promptAcknowledge: string;
|
|
34
|
+
readonly promptSubmitAll: string;
|
|
35
|
+
readonly promptStepTab: string;
|
|
36
|
+
readonly promptOtherPlaceholder: string;
|
|
37
|
+
readonly pin: string;
|
|
38
|
+
readonly unpin: string;
|
|
39
|
+
readonly promptGoto: string;
|
|
40
|
+
readonly meter: string;
|
|
41
|
+
};
|
|
42
|
+
//# sourceMappingURL=PresenceMessages.d.ts.map
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
import { IWorkbook } from '@sheetxl/sdk';
|
|
2
|
+
import { RangeAnnotation } from '../annotation';
|
|
3
|
+
import { PresenceHost } from './PresenceHost';
|
|
4
|
+
import { PresenceLogEntry, PresencePrompt, PresencePromptQuestion, PresencePromptQuestionAnswer, PresenceStatus } from './PresenceTypes';
|
|
5
|
+
/** Everything the views read, for the bound session. Immutable; a new object on every change. */
|
|
6
|
+
export interface PresenceSnapshot {
|
|
7
|
+
/** The session the views are showing. `null` before a workbook is bound. */
|
|
8
|
+
sessionId: string | null;
|
|
9
|
+
workbook: IWorkbook | null;
|
|
10
|
+
/** The name of the sheet in view — decides whether a prompt pins to its cells or centers. */
|
|
11
|
+
sheetInView: string | null;
|
|
12
|
+
/**
|
|
13
|
+
* Every finding for the session (all intents, open and stale), in review order. Only the session's
|
|
14
|
+
* own annotations: other writers' are not presence.
|
|
15
|
+
*/
|
|
16
|
+
findings: readonly RangeAnnotation[];
|
|
17
|
+
/** The session's findings the navigator walks: open `finding` and `question`, in review order. */
|
|
18
|
+
navigable: readonly RangeAnnotation[];
|
|
19
|
+
/** The navigator's current finding, when it is one of the session's. */
|
|
20
|
+
current: RangeAnnotation | null;
|
|
21
|
+
/** Every finding the agent raised this session, open or dismissed, newest first. */
|
|
22
|
+
log: readonly PresenceLogEntry[];
|
|
23
|
+
/** The agent's `working` cursor (where it is about to write) while it is up. */
|
|
24
|
+
working: RangeAnnotation | null;
|
|
25
|
+
/** 1-based position of {@link current} in {@link navigable}; `0` when there is none. */
|
|
26
|
+
position: number;
|
|
27
|
+
/** The pending prompt, if the agent is waiting on the user. */
|
|
28
|
+
prompt: PresencePrompt | null;
|
|
29
|
+
/** The step of {@link prompt} on screen (0-based). */
|
|
30
|
+
promptStep: number;
|
|
31
|
+
/** The question on screen: `prompt.questions[promptStep]`. */
|
|
32
|
+
promptQuestion: PresencePromptQuestion | null;
|
|
33
|
+
/** What the user has chosen so far, by step; `undefined` for a step not yet answered. */
|
|
34
|
+
promptAnswers: readonly (PresencePromptQuestionAnswer | undefined)[];
|
|
35
|
+
/**
|
|
36
|
+
* Where the prompt's dialog opens: just below the first question's cells, in viewport pixels.
|
|
37
|
+
* `undefined` until a grid pane has measured them (or forever, when it cannot — then centered).
|
|
38
|
+
*/
|
|
39
|
+
promptAnchor: {
|
|
40
|
+
x: number;
|
|
41
|
+
y: number;
|
|
42
|
+
} | undefined;
|
|
43
|
+
status: PresenceStatus;
|
|
44
|
+
/**
|
|
45
|
+
* The agent is waiting on the user — a prompt is pending. Distinct from findings: a prompt needs
|
|
46
|
+
* the user now, findings wait for them. Never counted together, and tool calls never count.
|
|
47
|
+
*/
|
|
48
|
+
needsAttention: boolean;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Someone else working in the view: their findings, their working cursor, their prompt and status,
|
|
52
|
+
* for one session. The findings are the workbook's range annotations, written with the session as
|
|
53
|
+
* their `source`, fed by the host's `highlight` events and read back here so the views see one
|
|
54
|
+
* snapshot.
|
|
55
|
+
*
|
|
56
|
+
* @remarks
|
|
57
|
+
* Shows one session: the workbook passed to {@link bind}. A `highlight` for a session that is not
|
|
58
|
+
* bound yet is kept until it is (the workbook may still be loading); one for another session is
|
|
59
|
+
* dropped, since there is nothing to draw it on.
|
|
60
|
+
*
|
|
61
|
+
* The host hears about dismissals from the annotation store's events, so a dismissal from the
|
|
62
|
+
* grid's tag, from a list, or from a command reaches it the same way.
|
|
63
|
+
*/
|
|
64
|
+
export declare class PresenceStore {
|
|
65
|
+
private readonly host;
|
|
66
|
+
private readonly _listeners;
|
|
67
|
+
private readonly _prompts;
|
|
68
|
+
private readonly _pendingHighlights;
|
|
69
|
+
private readonly _log;
|
|
70
|
+
private readonly _removeHost;
|
|
71
|
+
private _removeWorkbook;
|
|
72
|
+
private _removeAnnotations;
|
|
73
|
+
private _removeTransactions;
|
|
74
|
+
private _workbook;
|
|
75
|
+
private _sessionId;
|
|
76
|
+
private _sheetInView;
|
|
77
|
+
private _status;
|
|
78
|
+
private _snapshot;
|
|
79
|
+
/** While the store clears a session on its own account (a reset): nothing the user dismissed. */
|
|
80
|
+
private _resetting;
|
|
81
|
+
constructor(host: PresenceHost);
|
|
82
|
+
/**
|
|
83
|
+
* Show this workbook's session.
|
|
84
|
+
*
|
|
85
|
+
* @param sessionId - The id the host addresses this workbook by. Defaults to the workbook's own id.
|
|
86
|
+
*/
|
|
87
|
+
bind(workbook: IWorkbook | null, sessionId?: string): void;
|
|
88
|
+
getSnapshot: () => PresenceSnapshot;
|
|
89
|
+
subscribe: (listener: () => void) => (() => void);
|
|
90
|
+
/**
|
|
91
|
+
* Move to the next finding (wrapping) and reveal it.
|
|
92
|
+
*
|
|
93
|
+
* @param fromId - Step from this finding instead of the current one — a chip's own arrows walk
|
|
94
|
+
* from that chip, wherever the user scrolled to.
|
|
95
|
+
*/
|
|
96
|
+
next(fromId?: string): void;
|
|
97
|
+
/** Move to the previous finding (wrapping) and reveal it. See {@link next} for `fromId`. */
|
|
98
|
+
prev(fromId?: string): void;
|
|
99
|
+
/** Make a finding current and reveal it. A stale or unknown id does nothing; a `working` one is only revealed. */
|
|
100
|
+
goTo(id: string): void;
|
|
101
|
+
/** Bring an address into view without touching the selection. */
|
|
102
|
+
reveal(address: string): void;
|
|
103
|
+
/** Select an address — for a link to the cells the user clicks (the prompt's range). */
|
|
104
|
+
select(address: string): void;
|
|
105
|
+
/** Dismiss one finding. The cursor moves to the one that takes its place. */
|
|
106
|
+
dismiss(id: string): void;
|
|
107
|
+
dismissCurrent(): void;
|
|
108
|
+
/** Dismiss every `finding` and `question` finding in the bound session. */
|
|
109
|
+
dismissAll(): void;
|
|
110
|
+
/** Clear the agent's `working` cursor, as Esc does. Returns whether there was one. */
|
|
111
|
+
clearWorking(): boolean;
|
|
112
|
+
/**
|
|
113
|
+
* Answer the step on screen of the bound session's prompt. Answering here or in the grid is the
|
|
114
|
+
* same thing.
|
|
115
|
+
*
|
|
116
|
+
* @remarks
|
|
117
|
+
* A single-question prompt is sent at once. With several, the answer is recorded and the next
|
|
118
|
+
* step comes up; the answers go together on {@link submitPrompt}.
|
|
119
|
+
*
|
|
120
|
+
* @param optionId - The option chosen; omitted to acknowledge a step that has none.
|
|
121
|
+
*/
|
|
122
|
+
choosePromptOption: (optionId?: string) => void;
|
|
123
|
+
/**
|
|
124
|
+
* Record the step on screen's answer in the user's own words ("Other"), as they type. It does not
|
|
125
|
+
* move on or send — the user may write several lines; {@link submitPrompt} sends. Blank text
|
|
126
|
+
* leaves the step unanswered.
|
|
127
|
+
*/
|
|
128
|
+
setPromptOtherText: (text: string) => void;
|
|
129
|
+
private _answerStep;
|
|
130
|
+
/**
|
|
131
|
+
* Record where the prompt's first question is on screen, so its dialog can open there. Set once:
|
|
132
|
+
* the dialog opens where its question was, then stays wherever the user puts it.
|
|
133
|
+
*/
|
|
134
|
+
setPromptAnchor: (promptId: string, anchor: {
|
|
135
|
+
x: number;
|
|
136
|
+
y: number;
|
|
137
|
+
}) => void;
|
|
138
|
+
/** Show another step of the bound session's prompt. Answers given stay until changed. */
|
|
139
|
+
promptGoToStep: (step: number) => void;
|
|
140
|
+
/** Send the prompt's answers. Only once every question has one. */
|
|
141
|
+
submitPrompt: () => void;
|
|
142
|
+
/** Dismiss the bound session's prompt. What was answered so far goes back with the `cancel`. */
|
|
143
|
+
cancelPrompt: () => void;
|
|
144
|
+
dispose(): void;
|
|
145
|
+
/**
|
|
146
|
+
* Tell the host what the user dismissed of the session's findings, however it was done. A `working`
|
|
147
|
+
* cursor is never reported: it goes on its own.
|
|
148
|
+
*/
|
|
149
|
+
private _onAnnotationEvent;
|
|
150
|
+
private _onHostEvent;
|
|
151
|
+
private _reset;
|
|
152
|
+
/**
|
|
153
|
+
* Record findings as the agent raises them — whatever the user later does with them. Newest first
|
|
154
|
+
* (a walk keeps the agent's order within it); the log only grows. A `working` cursor is never logged.
|
|
155
|
+
*/
|
|
156
|
+
private _addToLog;
|
|
157
|
+
private _pending;
|
|
158
|
+
private _setPending;
|
|
159
|
+
/** A question is asked AT its cells — bring them into view as the step appears. */
|
|
160
|
+
private _revealStep;
|
|
161
|
+
private _resolvePrompt;
|
|
162
|
+
private _setSheetInView;
|
|
163
|
+
private _changed;
|
|
164
|
+
}
|
|
165
|
+
//# sourceMappingURL=PresenceStore.d.ts.map
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { RangeAnnotation } from '../annotation';
|
|
2
|
+
/**
|
|
3
|
+
* What a highlight is for: the vocabulary of the MCP `highlight` tool.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* `working` is the agent's cursor: one range, where it is about to write. It is shown in the strip
|
|
7
|
+
* and as a box on the grid, never listed or logged, and gone on its own: replaced by the next
|
|
8
|
+
* `working` call, cleared by any commit or any other highlight, and by Esc. `finding` and `question`
|
|
9
|
+
* are things the agent wants the user to look at; they accumulate as walks and stay until the user
|
|
10
|
+
* dismisses them.
|
|
11
|
+
*/
|
|
12
|
+
export type PresenceIntent = 'working' | 'finding' | 'question';
|
|
13
|
+
/**
|
|
14
|
+
* A finding as the history records it: a copy taken when the agent raised it. Whether it is still
|
|
15
|
+
* open is the live annotations' to say, not the log's; dismissing a finding is not an answer to it.
|
|
16
|
+
*/
|
|
17
|
+
export interface PresenceLogEntry extends RangeAnnotation {
|
|
18
|
+
raisedAt: number;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* What the agent is waiting on: one prompt's dialog. It holds one question or several, which the
|
|
22
|
+
* user answers one step at a time and which go back together.
|
|
23
|
+
*/
|
|
24
|
+
export interface PresencePrompt {
|
|
25
|
+
/** The prompt's id; the answer is correlated by it. */
|
|
26
|
+
id: string;
|
|
27
|
+
/** In the order asked. Never empty. */
|
|
28
|
+
questions: PresencePromptQuestion[];
|
|
29
|
+
}
|
|
30
|
+
/** One step of a {@link PresencePrompt}. */
|
|
31
|
+
export interface PresencePromptQuestion {
|
|
32
|
+
/** What the answer goes back under. */
|
|
33
|
+
id: string;
|
|
34
|
+
/** A short name for the step's tab. */
|
|
35
|
+
header?: string;
|
|
36
|
+
message: string;
|
|
37
|
+
/** Empty for an acknowledge step. `description` is a second, quieter line under the label. */
|
|
38
|
+
options: {
|
|
39
|
+
id: string;
|
|
40
|
+
label: string;
|
|
41
|
+
description?: string;
|
|
42
|
+
}[];
|
|
43
|
+
/**
|
|
44
|
+
* The range the question is about, already resolved. `undefined` means a centered dialog:
|
|
45
|
+
* deliberately not the user's selection, which is theirs and almost never the subject.
|
|
46
|
+
*/
|
|
47
|
+
range?: string;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* One question's answer: the option chosen, or `text` when the user answered in their own words
|
|
51
|
+
* ("Other"). Neither is set for an acknowledged step.
|
|
52
|
+
*/
|
|
53
|
+
export interface PresencePromptQuestionAnswer {
|
|
54
|
+
questionId: string;
|
|
55
|
+
optionId?: string;
|
|
56
|
+
text?: string;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* The user's answer to a prompt, elicitation-shaped. Dismissal is a normal `cancel`, carrying the
|
|
60
|
+
* questions answered before it (possibly none).
|
|
61
|
+
*/
|
|
62
|
+
export interface PresencePromptAnswer {
|
|
63
|
+
action: 'accept' | 'cancel';
|
|
64
|
+
/** In question order. */
|
|
65
|
+
answers: PresencePromptQuestionAnswer[];
|
|
66
|
+
}
|
|
67
|
+
/** Agent presence and activity, as the host reports it. */
|
|
68
|
+
export interface PresenceStatus {
|
|
69
|
+
/** An agent is attached (host-global, not per workbook). */
|
|
70
|
+
connected: boolean;
|
|
71
|
+
/** Bumps on each tool call against this workbook; a change is a pulse, never a count. */
|
|
72
|
+
activity: number;
|
|
73
|
+
/** A short label for the last tool call. */
|
|
74
|
+
lastActivity?: string;
|
|
75
|
+
/** Tool calls against this workbook this session, as the host counts them. */
|
|
76
|
+
meter?: number;
|
|
77
|
+
}
|
|
78
|
+
//# sourceMappingURL=PresenceTypes.d.ts.map
|