@dxos/plugin-sheet 0.8.4-main.fd6878d → 0.8.4-staging.60fe92afc8

package/LICENSE

@@ -1,8 +1,105 @@
-MIT License 
-Copyright (c) 2022 DXOS
+# Functional Source License, Version 1.1, ALv2 Future License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## Abbreviation
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+FSL-1.1-Apache-2.0
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+## Notice
+
+Copyright 2026 DXOS
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+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.

package/PLUGIN.mdl

@@ -0,0 +1,359 @@
+---
+id: org.dxos.plugin.sheet
+name: SheetPlugin
+version: 0.1.0
+---
+
+Spreadsheet plugin for `DXOS` Composer — a full-featured grid backed by ECHO for local-first, real-time collaborative data entry, formula evaluation, and structured data display.
+
+## Extensions
+
+The following extension dialects are used in this document.
+Each extension is defined in the Appendix or resolved via its URI.
+
+| Term        | URI                            |
+|-------------|--------------------------------|
+| `type`      | `org.dxos.mdl.type@1.0`        |
+| `feat`      | `org.dxos.mdl.feat@1.0`        |
+| `test`      | `org.dxos.mdl.test@1.0`        |
+| `component` | `org.dxos.mdl.component@1.0`   |
+| `op`        | `org.dxos.mdl.op@1.0`          |
+
+## Types
+
+```mdl
+type CellValue
+  fields:
+    value: any                   # scalar: string | number | boolean | formula string
+```
+
+```mdl
+type RowColumnMeta
+  fields:
+    size?: number                # pixel width/height; absent means default
+```
+
+```mdl
+type Range
+  fields:
+    range: string                # A1-notation range (e.g. "A1:C3")
+    key: string                  # formatting key: alignment | comment | style
+    value: string                # formatting value (e.g. "center", "highlight")
+```
+
+```mdl
+type Axis
+  literals: row | col
+```
+
+```mdl
+type Sheet
+  typename: org.dxos.type.sheet
+  fields:
+    name?: string
+    cells: Map<string, CellValue>    # sparse map keyed by internal cell index
+    rows: string[]                   # ordered row indices
+    columns: string[]                # ordered column indices
+    rowMeta: Map<string, RowColumnMeta>
+    columnMeta: Map<string, RowColumnMeta>
+    ranges: Range[]                  # range-based formatting annotations
+```
+
+## Components
+
+```mdl
+component SheetArticle
+  desc: Primary spreadsheet view rendered inside an article or section role surface.
+  props:
+    subject: Sheet
+    attendableId: string
+    space: Space
+    registry: ComputeGraphRegistry
+  state:
+    selected?: CellAddress
+    activeRefs?: GridContentProps['activeRefs']
+  slots:
+    toolbar?: ReactNode
+  actions:
+    selectCell(address: CellAddress)
+    editCell(address: CellAddress, value: any)
+    insertRow(index: number)
+    insertColumn(index: number)
+    dropRow(axisIndex: string)
+    dropColumn(axisIndex: string)
+  layout: |
+    ┌───────────────────────────────────┐
+    │ [toolbar slot]                    │
+    ├───┬───┬───┬───┬───────────────────┤
+    │   │ A │ B │ C │  …  column header │
+    ├───┼───┼───┼───┤                   │
+    │ 1 │   │   │   │   cell grid       │
+    ├───┼───┼───┼───┤                   │
+    │ 2 │   │   │   │                   │
+    │ … │   │   │   │                   │
+    └───┴───┴───┴───┴───────────────────┘
+```
+
+```mdl
+component RangeList
+  desc: Object-properties panel listing named ranges and formatting annotations on a Sheet.
+  props:
+    sheet: Sheet
+  state:
+    selected?: Range
+  actions:
+    addRange(range: Range)
+    removeRange(range: Range)
+    updateRange(range: Range)
+```
+
+## Operations
+
+```mdl
+op insertAxis
+  desc: Inserts one or more rows or columns at the given index in the sheet model.
+  input:
+    model: SheetModel
+    axis: Axis
+    index: number
+    count?: number               # defaults to 1
+  output: void
+  effects: [echo:write]
+```
+
+```mdl
+op dropAxis
+  desc: Removes a row or column by axis index, returning data needed to restore it (undo).
+  input:
+    model: SheetModel
+    axis: Axis
+    axisIndex: string
+  output: DropAxisOutput         # axis, axisIndex, index, axisMeta, values
+  effects: [echo:write]
+```
+
+```mdl
+op restoreAxis
+  desc: Restores a previously dropped row or column (undo of dropAxis).
+  input:
+    model: SheetModel
+    axis: Axis
+    axisIndex: string            # original axis index to restore
+    index: number                # original position
+    axisMeta: RowColumnMeta
+    values: any[]                # cell values to re-insert
+  output: void
+  effects: [echo:write]
+```
+
+```mdl
+op scrollToAnchor
+  desc: Programmatically scrolls and highlights a cell range in an active grid instance.
+  input:
+    subject: string              # attendable ID of the target sheet
+    cursor: string               # A1-notation cell or range
+    ref?: any                    # active refs for highlight overlay
+  output: void
+  effects: [ui:scroll]
+```
+
+## Features
+
+```mdl
+feat F-1: Sheet Object
+
+  req F-1.1: A Sheet is an ECHO object with typename org.dxos.type.sheet persisted in the user's space.
+  req F-1.2: Cells are stored in a sparse map keyed by internal row/column indices.
+  req F-1.3: Row and column order is maintained via ordered index arrays; insertion/deletion preserves existing cell references.
+  req F-1.4: Range-based formatting annotations are stored as a flat array on the Sheet object.
+```
+
+```mdl
+feat F-2: Formula Evaluation
+
+  req F-2.1: Formulas are prefixed with "=" and evaluated by the HyperFormula engine via the ComputeGraph.
+  req F-2.2: Over 400 built-in functions are available (arithmetic, statistical, text, date/time, financial, logical).
+  req F-2.3:
+    when: a cell value changes
+    then: all dependent formula cells are recomputed reactively
+  req F-2.4: Cell references in stored formulas are translated to internal indices; A1-notation is converted on read/write.
+```
+
+```mdl
+feat F-3: Row and Column Management
+
+  req F-3.1:
+    when: op:insertAxis is called
+    then: a new row or column is inserted at the specified index; existing cells shift accordingly
+
+  req F-3.2:
+    when: op:dropAxis is called
+    then: the row or column is removed and undo data returned; op:restoreAxis reverses the operation
+
+  req F-3.3: Row and column sizes are persisted in rowMeta/columnMeta; absent size means default grid size.
+```
+
+```mdl
+feat F-4: Cell Formatting
+
+  req F-4.1: Ranges support alignment values: start | center | end.
+  req F-4.2: Ranges support comment annotations displayed as a visual overlay on the cell.
+  req F-4.3: Ranges support style values: highlight | softwrap.
+  req F-4.4: RangeList in the object-properties surface allows users to view and manage range annotations.
+```
+
+```mdl
+feat F-5: Collaborative Editing
+
+  req F-5.1: All cell edits are written through ECHO and replicated to peers in real time.
+  req F-5.2:
+    when: a peer writes a cell value
+    then: the local grid re-renders with the updated value without full reload
+
+  req F-5.3: ComputeGraphRegistry manages per-space HyperFormula instances so all peers share the same formula graph.
+```
+
+```mdl
+feat F-6: Markdown Integration
+
+  req F-6.1: SheetPlugin contributes a CodeMirror extension to plugin-markdown via MarkdownCapabilities.ExtensionProvider.
+  req F-6.2:
+    when: the extension is active in a document that belongs to a space
+    then: formula references inside Markdown fenced code blocks resolve against the space's ComputeGraph
+```
+
+```mdl
+feat F-7: Anchor Navigation
+
+  req F-7.1:
+    when: op:scrollToAnchor is invoked with a sheet attendable ID and cursor
+    then: the corresponding SheetArticle scrolls to the target cell and applies the active-ref highlight
+
+  req F-7.2: AnchorSort contributes a sort comparator so sheet anchors appear in canonical order in navigation menus.
+```
+
+## Acceptance
+
+```mdl
+test T-1: Create sheet and enter a value
+  given: a new Sheet is created in a space
+  when: user types "42" into cell A1
+  then:
+    - Sheet.cells contains an entry for the A1 index with value 42
+    - grid displays "42" in the A1 cell
+```
+
+```mdl
+test T-2: Formula evaluation
+  given: A1 = 10, A2 = 20
+  when: user enters "=A1+A2" in A3
+  then:
+    - A3 displays 30
+    - changing A1 to 15 causes A3 to update to 35
+```
+
+```mdl
+test T-3: Insert and drop row
+  given: a Sheet with values in rows 1 and 2
+  when: op:insertAxis runs with axis=row, index=1
+  then:
+    - a blank row is inserted between existing rows 1 and 2
+    - existing cell references remain valid
+
+  when: op:dropAxis runs on the inserted row
+  then:
+    - the row is removed
+    - op:restoreAxis re-inserts the row with its original values
+```
+
+```mdl
+test T-4: Range formatting
+  given: a Sheet open in SheetArticle
+  when: user applies "highlight" style to range B2:C4
+  then:
+    - Sheet.ranges contains an entry with range="B2:C4", key="style", value="highlight"
+    - cells in B2:C4 render with the highlight background class
+```
+
+```mdl
+test T-5: Real-time collaboration
+  given: two peers have the same Sheet open
+  when: peer A sets cell D5 to "hello"
+  then:
+    - peer B's grid displays "hello" in D5 without reload
+```
+
+```mdl
+test T-6: Scroll to anchor
+  given: a SheetArticle is mounted with attendableId "sheet-1"
+  when: op:scrollToAnchor runs with subject="sheet-1", cursor="E10"
+  then:
+    - the grid scrolls so that E10 is visible
+    - E10 is highlighted via activeRefs
+```
+
+---
+
+## Appendix: Extension Definitions
+
+```mdl
+ext type
+  uri: org.dxos.mdl.type@1.0
+  desc: A named data structure with typed fields and optional literals.
+  fields:
+    desc?: Prose
+    fields?: FieldMap
+    literals?: UnionList
+    extends?: TypeRef[]
+```
+
+```mdl
+ext feat
+  uri: org.dxos.mdl.feat@1.0
+  desc: A named feature grouping one or more requirements.
+  fields:
+    desc?: Prose
+    req: RequirementList
+  nesting: self
+```
+
+```mdl
+ext test
+  uri: org.dxos.mdl.test@1.0
+  desc: An acceptance scenario expressed as given / when / then steps.
+  fields:
+    given?: Step | Step[]
+    when?: Step | Step[]
+    then: Step | Step[]
+    tags?: TagList
+```
+
+```mdl
+ext component
+  uri: org.dxos.mdl.component@1.0
+  desc: A UI component with props, internal state, slots, actions, and events.
+  fields:
+    desc?: Prose
+    props?: FieldMap
+    state?: FieldMap
+    slots?: FieldMap
+    actions?: ActionMap
+    emits?: EventMap
+    layout?: CodeBlock
+```
+
+```mdl
+ext op
+  uri: org.dxos.mdl.op@1.0
+  desc: |
+    A named operation with typed inputs, outputs, and declared errors.
+    Pure ops have no effects or requires. Effectful ops declare both.
+  fields:
+    desc?: Prose
+    input?: FieldMap
+    output?: TypeExpr
+    errors?: ErrorMap
+    effects?: EffectList
+    requires?: ServiceList
+    note?: Prose
+```

package/dist/lib/neutral/RangeList-HYB5S6KQ.mjs

@@ -0,0 +1,46 @@
+import "./chunk-J5LGTIGS.mjs";
+
+// src/containers/RangeList/RangeList.tsx
+import * as Schema from "effect/Schema";
+import React, { useCallback } from "react";
+import { rangeToA1Notation } from "@dxos/compute-hyperformula";
+import { useObject } from "@dxos/echo-react";
+import { Input, Message, useTranslation } from "@dxos/react-ui";
+import { List } from "@dxos/react-ui-list";
+import { meta } from "#meta";
+import { rangeFromIndex } from "#types";
+import { Sheet } from "#types";
+var RangeList = ({ sheet: sheetProp }) => {
+  const { t } = useTranslation(meta.id);
+  const [sheet, updateSheet] = useObject(sheetProp);
+  const handleSelectRange = (range) => {
+  };
+  const handleDeleteRange = useCallback((range) => {
+    const index = sheet.ranges.findIndex((sheetRange) => sheetRange === range);
+    updateSheet((sheet2) => {
+      sheet2.ranges.splice(index, 1);
+    });
+  }, [
+    sheet,
+    updateSheet
+  ]);
+  return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(Input.Root, null, /* @__PURE__ */ React.createElement(Input.Label, null, t("range-list.heading"))), sheet.ranges.length < 1 ? /* @__PURE__ */ React.createElement(Message.Root, null, /* @__PURE__ */ React.createElement(Message.Title, null, t("no-ranges.message"))) : /* @__PURE__ */ React.createElement(List.Root, {
+    items: sheet.ranges,
+    isItem: Schema.is(Sheet.Range)
+  }, ({ items: ranges }) => ranges.map((range, i) => /* @__PURE__ */ React.createElement(List.Item, {
+    key: i,
+    item: range
+  }, /* @__PURE__ */ React.createElement(List.ItemDragHandle, null), /* @__PURE__ */ React.createElement(List.ItemTitle, {
+    onClick: () => handleSelectRange(range)
+  }, t("range.title", {
+    position: rangeToA1Notation(rangeFromIndex(sheetProp, range.range)),
+    key: t(`range-key.${range.key}.label`),
+    value: t(`range-value.${range.value}.label`)
+  })), /* @__PURE__ */ React.createElement(List.ItemDeleteButton, {
+    onClick: () => handleDeleteRange(range)
+  })))));
+};
+export {
+  RangeList as default
+};
+//# sourceMappingURL=RangeList-HYB5S6KQ.mjs.map

package/dist/lib/neutral/RangeList-HYB5S6KQ.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/containers/RangeList/RangeList.tsx"],
+  "sourcesContent": ["//\n// Copyright 2024 DXOS.org\n//\n\nimport * as Schema from 'effect/Schema';\nimport React, { useCallback } from 'react';\n\nimport { rangeToA1Notation } from '@dxos/compute-hyperformula';\nimport { useObject } from '@dxos/echo-react';\nimport { Input, Message, useTranslation } from '@dxos/react-ui';\nimport { List } from '@dxos/react-ui-list';\n\nimport { meta } from '#meta';\nimport { rangeFromIndex } from '#types';\nimport { Sheet } from '#types';\n\nexport type RangeListProps = {\n  sheet: Sheet.Sheet;\n};\n\nexport const RangeList = ({ sheet: sheetProp }: RangeListProps) => {\n  const { t } = useTranslation(meta.id);\n  const [sheet, updateSheet] = useObject(sheetProp);\n  // TODO(thure): Implement similar to comments, #8121\n  const handleSelectRange = (range: Sheet.Range) => {};\n  const handleDeleteRange = useCallback(\n    (range: Sheet.Range) => {\n      const index = sheet.ranges.findIndex((sheetRange) => sheetRange === range);\n      updateSheet((sheet) => {\n        sheet.ranges.splice(index, 1);\n      });\n    },\n    [sheet, updateSheet],\n  );\n  return (\n    <>\n      <Input.Root>\n        <Input.Label>{t('range-list.heading')}</Input.Label>\n      </Input.Root>\n      {sheet.ranges.length < 1 ? (\n        <Message.Root>\n          <Message.Title>{t('no-ranges.message')}</Message.Title>\n        </Message.Root>\n      ) : (\n        <List.Root<Sheet.Range> items={sheet.ranges} isItem={Schema.is(Sheet.Range)}>\n          {({ items: ranges }) =>\n            ranges.map((range, i) => (\n              <List.Item key={i} item={range}>\n                <List.ItemDragHandle />\n                <List.ItemTitle onClick={() => handleSelectRange(range)}>\n                  {t('range.title', {\n                    position: rangeToA1Notation(rangeFromIndex(sheetProp, range.range)),\n                    key: t(`range-key.${range.key}.label`),\n                    value: t(`range-value.${range.value}.label`),\n                  })}\n                </List.ItemTitle>\n                <List.ItemDeleteButton onClick={() => handleDeleteRange(range)} />\n              </List.Item>\n            ))\n          }\n        </List.Root>\n      )}\n    </>\n  );\n};\n"],
+  "mappings": ";;;AAIA,YAAYA,YAAY;AACxB,OAAOC,SAASC,mBAAmB;AAEnC,SAASC,yBAAyB;AAClC,SAASC,iBAAiB;AAC1B,SAASC,OAAOC,SAASC,sBAAsB;AAC/C,SAASC,YAAY;AAErB,SAASC,YAAY;AACrB,SAASC,sBAAsB;AAC/B,SAASC,aAAa;AAMf,IAAMC,YAAY,CAAC,EAAEC,OAAOC,UAAS,MAAkB;AAC5D,QAAM,EAAEC,EAAC,IAAKR,eAAeE,KAAKO,EAAE;AACpC,QAAM,CAACH,OAAOI,WAAAA,IAAeb,UAAUU,SAAAA;AAEvC,QAAMI,oBAAoB,CAACC,UAAAA;EAAwB;AACnD,QAAMC,oBAAoBlB,YACxB,CAACiB,UAAAA;AACC,UAAME,QAAQR,MAAMS,OAAOC,UAAU,CAACC,eAAeA,eAAeL,KAAAA;AACpEF,gBAAY,CAACJ,WAAAA;AACXA,MAAAA,OAAMS,OAAOG,OAAOJ,OAAO,CAAA;IAC7B,CAAA;EACF,GACA;IAACR;IAAOI;GAAY;AAEtB,SACE,sBAAA,cAAA,MAAA,UAAA,MACE,sBAAA,cAACZ,MAAMqB,MAAI,MACT,sBAAA,cAACrB,MAAMsB,OAAK,MAAEZ,EAAE,oBAAA,CAAA,CAAA,GAEjBF,MAAMS,OAAOM,SAAS,IACrB,sBAAA,cAACtB,QAAQoB,MAAI,MACX,sBAAA,cAACpB,QAAQuB,OAAK,MAAEd,EAAE,mBAAA,CAAA,CAAA,IAGpB,sBAAA,cAACP,KAAKkB,MAAI;IAAcI,OAAOjB,MAAMS;IAAQS,QAAeC,UAAGrB,MAAMsB,KAAK;KACvE,CAAC,EAAEH,OAAOR,OAAM,MACfA,OAAOY,IAAI,CAACf,OAAOgB,MACjB,sBAAA,cAAC3B,KAAK4B,MAAI;IAACC,KAAKF;IAAGG,MAAMnB;KACvB,sBAAA,cAACX,KAAK+B,gBAAc,IAAA,GACpB,sBAAA,cAAC/B,KAAKgC,WAAS;IAACC,SAAS,MAAMvB,kBAAkBC,KAAAA;KAC9CJ,EAAE,eAAe;IAChB2B,UAAUvC,kBAAkBO,eAAeI,WAAWK,MAAMA,KAAK,CAAA;IACjEkB,KAAKtB,EAAE,aAAaI,MAAMkB,GAAG,QAAQ;IACrCM,OAAO5B,EAAE,eAAeI,MAAMwB,KAAK,QAAQ;EAC7C,CAAA,CAAA,GAEF,sBAAA,cAACnC,KAAKoC,kBAAgB;IAACH,SAAS,MAAMrB,kBAAkBD,KAAAA;;AAQxE;",
+  "names": ["Schema", "React", "useCallback", "rangeToA1Notation", "useObject", "Input", "Message", "useTranslation", "List", "meta", "rangeFromIndex", "Sheet", "RangeList", "sheet", "sheetProp", "t", "id", "updateSheet", "handleSelectRange", "range", "handleDeleteRange", "index", "ranges", "findIndex", "sheetRange", "splice", "Root", "Label", "length", "Title", "items", "isItem", "is", "Range", "map", "i", "Item", "key", "item", "ItemDragHandle", "ItemTitle", "onClick", "position", "value", "ItemDeleteButton"]
+}

package/dist/lib/neutral/SheetArticle-5AJRM3V3.mjs

@@ -0,0 +1,33 @@
+import "./chunk-J5LGTIGS.mjs";
+
+// src/containers/SheetArticle/SheetArticle.tsx
+import React from "react";
+import { Panel } from "@dxos/react-ui";
+import { ComputeGraphContextProvider, Sheet, useComputeGraph } from "#components";
+var SheetArticle = ({ registry, ...props }) => /* @__PURE__ */ React.createElement(ComputeGraphContextProvider, {
+  registry
+}, /* @__PURE__ */ React.createElement(SheetArticleInner, props));
+var SheetArticleInner = ({ role, subject: sheet, attendableId, space, ignoreAttention }) => {
+  const graph = useComputeGraph(space);
+  if (!graph) {
+    return null;
+  }
+  return /* @__PURE__ */ React.createElement(Sheet.Root, {
+    graph,
+    sheet,
+    attendableId,
+    ignoreAttention
+  }, /* @__PURE__ */ React.createElement(Panel.Root, {
+    classNames: role === "section" && "aspect-aquare"
+  }, /* @__PURE__ */ React.createElement(Panel.Toolbar, {
+    asChild: true
+  }, /* @__PURE__ */ React.createElement(Sheet.Toolbar, null)), /* @__PURE__ */ React.createElement(Panel.Content, {
+    asChild: true
+  }, /* @__PURE__ */ React.createElement(Sheet.Content, null)), /* @__PURE__ */ React.createElement(Panel.Statusbar, {
+    asChild: true
+  }, /* @__PURE__ */ React.createElement(Sheet.Statusbar, null))));
+};
+export {
+  SheetArticle as default
+};
+//# sourceMappingURL=SheetArticle-5AJRM3V3.mjs.map

package/dist/lib/neutral/SheetArticle-5AJRM3V3.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/containers/SheetArticle/SheetArticle.tsx"],
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { type AppSurface } from '@dxos/app-toolkit/ui';\nimport { type ComputeGraphRegistry } from '@dxos/compute-hyperformula';\nimport { type Space } from '@dxos/react-client/echo';\nimport { Panel } from '@dxos/react-ui';\n\nimport { ComputeGraphContextProvider, Sheet, useComputeGraph } from '#components';\nimport { type Sheet as SheetType } from '#types';\n\nexport type SheetArticleProps = AppSurface.ObjectArticleProps<\n  SheetType.Sheet,\n  {\n    space: Space;\n    registry: ComputeGraphRegistry;\n    ignoreAttention?: boolean;\n  }\n>;\n\nexport const SheetArticle = ({ registry, ...props }: SheetArticleProps) => (\n  <ComputeGraphContextProvider registry={registry}>\n    <SheetArticleInner {...props} />\n  </ComputeGraphContextProvider>\n);\n\nconst SheetArticleInner = ({\n  role,\n  subject: sheet,\n  attendableId,\n  space,\n  ignoreAttention,\n}: Omit<SheetArticleProps, 'registry'>) => {\n  const graph = useComputeGraph(space);\n  if (!graph) {\n    return null;\n  }\n\n  return (\n    <Sheet.Root graph={graph} sheet={sheet} attendableId={attendableId!} ignoreAttention={ignoreAttention}>\n      <Panel.Root classNames={role === 'section' && 'aspect-aquare'}>\n        <Panel.Toolbar asChild>\n          <Sheet.Toolbar />\n        </Panel.Toolbar>\n        <Panel.Content asChild>\n          <Sheet.Content />\n        </Panel.Content>\n        <Panel.Statusbar asChild>\n          <Sheet.Statusbar />\n        </Panel.Statusbar>\n      </Panel.Root>\n    </Sheet.Root>\n  );\n};\n"],
+  "mappings": ";;;AAIA,OAAOA,WAAW;AAKlB,SAASC,aAAa;AAEtB,SAASC,6BAA6BC,OAAOC,uBAAuB;AAY7D,IAAMC,eAAe,CAAC,EAAEC,UAAU,GAAGC,MAAAA,MAC1C,sBAAA,cAACL,6BAAAA;EAA4BI;GAC3B,sBAAA,cAACE,mBAAsBD,KAAAA,CAAAA;AAI3B,IAAMC,oBAAoB,CAAC,EACzBC,MACAC,SAASC,OACTC,cACAC,OACAC,gBAAe,MACqB;AACpC,QAAMC,QAAQX,gBAAgBS,KAAAA;AAC9B,MAAI,CAACE,OAAO;AACV,WAAO;EACT;AAEA,SACE,sBAAA,cAACZ,MAAMa,MAAI;IAACD;IAAcJ;IAAcC;IAA6BE;KACnE,sBAAA,cAACb,MAAMe,MAAI;IAACC,YAAYR,SAAS,aAAa;KAC5C,sBAAA,cAACR,MAAMiB,SAAO;IAACC,SAAAA;KACb,sBAAA,cAAChB,MAAMe,SAAO,IAAA,CAAA,GAEhB,sBAAA,cAACjB,MAAMmB,SAAO;IAACD,SAAAA;KACb,sBAAA,cAAChB,MAAMiB,SAAO,IAAA,CAAA,GAEhB,sBAAA,cAACnB,MAAMoB,WAAS;IAACF,SAAAA;KACf,sBAAA,cAAChB,MAAMkB,WAAS,IAAA,CAAA,CAAA,CAAA;AAK1B;",
+  "names": ["React", "Panel", "ComputeGraphContextProvider", "Sheet", "useComputeGraph", "SheetArticle", "registry", "props", "SheetArticleInner", "role", "subject", "sheet", "attendableId", "space", "ignoreAttention", "graph", "Root", "classNames", "Toolbar", "asChild", "Content", "Statusbar"]
+}

package/dist/lib/neutral/SheetPlugin.mjs

@@ -0,0 +1,63 @@
+import "./chunk-J5LGTIGS.mjs";
+
+// src/SheetPlugin.tsx
+import { ActivationEvent, ActivationEvents, Plugin } from "@dxos/app-framework";
+import { AppActivationEvents, AppPlugin } from "@dxos/app-toolkit";
+import { ClientEvents } from "@dxos/plugin-client";
+import { MarkdownEvents } from "@dxos/plugin-markdown";
+import { AnchorSort, AppGraphBuilder, NavigationResolver, CommentConfig, ComputeGraphRegistry, CreateObject, Markdown, OperationHandler, UndoMappings, ReactSurface, SheetState } from "#capabilities";
+import { meta } from "#meta";
+import { translations } from "#translations";
+import { Sheet } from "#types";
+
+// raw-loader:/__w/dxos/dxos/packages/plugins/plugin-sheet/PLUGIN.mdl?raw
+var PLUGIN_default = '---\nid: org.dxos.plugin.sheet\nname: SheetPlugin\nversion: 0.1.0\n---\n\nSpreadsheet plugin for `DXOS` Composer \u2014 a full-featured grid backed by ECHO for local-first, real-time collaborative data entry, formula evaluation, and structured data display.\n\n## Extensions\n\nThe following extension dialects are used in this document.\nEach extension is defined in the Appendix or resolved via its URI.\n\n| Term        | URI                            |\n|-------------|--------------------------------|\n| `type`      | `org.dxos.mdl.type@1.0`        |\n| `feat`      | `org.dxos.mdl.feat@1.0`        |\n| `test`      | `org.dxos.mdl.test@1.0`        |\n| `component` | `org.dxos.mdl.component@1.0`   |\n| `op`        | `org.dxos.mdl.op@1.0`          |\n\n## Types\n\n```mdl\ntype CellValue\n  fields:\n    value: any                   # scalar: string | number | boolean | formula string\n```\n\n```mdl\ntype RowColumnMeta\n  fields:\n    size?: number                # pixel width/height; absent means default\n```\n\n```mdl\ntype Range\n  fields:\n    range: string                # A1-notation range (e.g. "A1:C3")\n    key: string                  # formatting key: alignment | comment | style\n    value: string                # formatting value (e.g. "center", "highlight")\n```\n\n```mdl\ntype Axis\n  literals: row | col\n```\n\n```mdl\ntype Sheet\n  typename: org.dxos.type.sheet\n  fields:\n    name?: string\n    cells: Map<string, CellValue>    # sparse map keyed by internal cell index\n    rows: string[]                   # ordered row indices\n    columns: string[]                # ordered column indices\n    rowMeta: Map<string, RowColumnMeta>\n    columnMeta: Map<string, RowColumnMeta>\n    ranges: Range[]                  # range-based formatting annotations\n```\n\n## Components\n\n```mdl\ncomponent SheetArticle\n  desc: Primary spreadsheet view rendered inside an article or section role surface.\n  props:\n    subject: Sheet\n    attendableId: string\n    space: Space\n    registry: ComputeGraphRegistry\n  state:\n    selected?: CellAddress\n    activeRefs?: GridContentProps[\'activeRefs\']\n  slots:\n    toolbar?: ReactNode\n  actions:\n    selectCell(address: CellAddress)\n    editCell(address: CellAddress, value: any)\n    insertRow(index: number)\n    insertColumn(index: number)\n    dropRow(axisIndex: string)\n    dropColumn(axisIndex: string)\n  layout: |\n    \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n    \u2502 [toolbar slot]                    \u2502\n    \u251C\u2500\u2500\u2500\u252C\u2500\u2500\u2500\u252C\u2500\u2500\u2500\u252C\u2500\u2500\u2500\u252C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n    \u2502   \u2502 A \u2502 B \u2502 C \u2502  \u2026  column header \u2502\n    \u251C\u2500\u2500\u2500\u253C\u2500\u2500\u2500\u253C\u2500\u2500\u2500\u253C\u2500\u2500\u2500\u2524                   \u2502\n    \u2502 1 \u2502   \u2502   \u2502   \u2502   cell grid       \u2502\n    \u251C\u2500\u2500\u2500\u253C\u2500\u2500\u2500\u253C\u2500\u2500\u2500\u253C\u2500\u2500\u2500\u2524                   \u2502\n    \u2502 2 \u2502   \u2502   \u2502   \u2502                   \u2502\n    \u2502 \u2026 \u2502   \u2502   \u2502   \u2502                   \u2502\n    \u2514\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n```\n\n```mdl\ncomponent RangeList\n  desc: Object-properties panel listing named ranges and formatting annotations on a Sheet.\n  props:\n    sheet: Sheet\n  state:\n    selected?: Range\n  actions:\n    addRange(range: Range)\n    removeRange(range: Range)\n    updateRange(range: Range)\n```\n\n## Operations\n\n```mdl\nop insertAxis\n  desc: Inserts one or more rows or columns at the given index in the sheet model.\n  input:\n    model: SheetModel\n    axis: Axis\n    index: number\n    count?: number               # defaults to 1\n  output: void\n  effects: [echo:write]\n```\n\n```mdl\nop dropAxis\n  desc: Removes a row or column by axis index, returning data needed to restore it (undo).\n  input:\n    model: SheetModel\n    axis: Axis\n    axisIndex: string\n  output: DropAxisOutput         # axis, axisIndex, index, axisMeta, values\n  effects: [echo:write]\n```\n\n```mdl\nop restoreAxis\n  desc: Restores a previously dropped row or column (undo of dropAxis).\n  input:\n    model: SheetModel\n    axis: Axis\n    axisIndex: string            # original axis index to restore\n    index: number                # original position\n    axisMeta: RowColumnMeta\n    values: any[]                # cell values to re-insert\n  output: void\n  effects: [echo:write]\n```\n\n```mdl\nop scrollToAnchor\n  desc: Programmatically scrolls and highlights a cell range in an active grid instance.\n  input:\n    subject: string              # attendable ID of the target sheet\n    cursor: string               # A1-notation cell or range\n    ref?: any                    # active refs for highlight overlay\n  output: void\n  effects: [ui:scroll]\n```\n\n## Features\n\n```mdl\nfeat F-1: Sheet Object\n\n  req F-1.1: A Sheet is an ECHO object with typename org.dxos.type.sheet persisted in the user\'s space.\n  req F-1.2: Cells are stored in a sparse map keyed by internal row/column indices.\n  req F-1.3: Row and column order is maintained via ordered index arrays; insertion/deletion preserves existing cell references.\n  req F-1.4: Range-based formatting annotations are stored as a flat array on the Sheet object.\n```\n\n```mdl\nfeat F-2: Formula Evaluation\n\n  req F-2.1: Formulas are prefixed with "=" and evaluated by the HyperFormula engine via the ComputeGraph.\n  req F-2.2: Over 400 built-in functions are available (arithmetic, statistical, text, date/time, financial, logical).\n  req F-2.3:\n    when: a cell value changes\n    then: all dependent formula cells are recomputed reactively\n  req F-2.4: Cell references in stored formulas are translated to internal indices; A1-notation is converted on read/write.\n```\n\n```mdl\nfeat F-3: Row and Column Management\n\n  req F-3.1:\n    when: op:insertAxis is called\n    then: a new row or column is inserted at the specified index; existing cells shift accordingly\n\n  req F-3.2:\n    when: op:dropAxis is called\n    then: the row or column is removed and undo data returned; op:restoreAxis reverses the operation\n\n  req F-3.3: Row and column sizes are persisted in rowMeta/columnMeta; absent size means default grid size.\n```\n\n```mdl\nfeat F-4: Cell Formatting\n\n  req F-4.1: Ranges support alignment values: start | center | end.\n  req F-4.2: Ranges support comment annotations displayed as a visual overlay on the cell.\n  req F-4.3: Ranges support style values: highlight | softwrap.\n  req F-4.4: RangeList in the object-properties surface allows users to view and manage range annotations.\n```\n\n```mdl\nfeat F-5: Collaborative Editing\n\n  req F-5.1: All cell edits are written through ECHO and replicated to peers in real time.\n  req F-5.2:\n    when: a peer writes a cell value\n    then: the local grid re-renders with the updated value without full reload\n\n  req F-5.3: ComputeGraphRegistry manages per-space HyperFormula instances so all peers share the same formula graph.\n```\n\n```mdl\nfeat F-6: Markdown Integration\n\n  req F-6.1: SheetPlugin contributes a CodeMirror extension to plugin-markdown via MarkdownCapabilities.ExtensionProvider.\n  req F-6.2:\n    when: the extension is active in a document that belongs to a space\n    then: formula references inside Markdown fenced code blocks resolve against the space\'s ComputeGraph\n```\n\n```mdl\nfeat F-7: Anchor Navigation\n\n  req F-7.1:\n    when: op:scrollToAnchor is invoked with a sheet attendable ID and cursor\n    then: the corresponding SheetArticle scrolls to the target cell and applies the active-ref highlight\n\n  req F-7.2: AnchorSort contributes a sort comparator so sheet anchors appear in canonical order in navigation menus.\n```\n\n## Acceptance\n\n```mdl\ntest T-1: Create sheet and enter a value\n  given: a new Sheet is created in a space\n  when: user types "42" into cell A1\n  then:\n    - Sheet.cells contains an entry for the A1 index with value 42\n    - grid displays "42" in the A1 cell\n```\n\n```mdl\ntest T-2: Formula evaluation\n  given: A1 = 10, A2 = 20\n  when: user enters "=A1+A2" in A3\n  then:\n    - A3 displays 30\n    - changing A1 to 15 causes A3 to update to 35\n```\n\n```mdl\ntest T-3: Insert and drop row\n  given: a Sheet with values in rows 1 and 2\n  when: op:insertAxis runs with axis=row, index=1\n  then:\n    - a blank row is inserted between existing rows 1 and 2\n    - existing cell references remain valid\n\n  when: op:dropAxis runs on the inserted row\n  then:\n    - the row is removed\n    - op:restoreAxis re-inserts the row with its original values\n```\n\n```mdl\ntest T-4: Range formatting\n  given: a Sheet open in SheetArticle\n  when: user applies "highlight" style to range B2:C4\n  then:\n    - Sheet.ranges contains an entry with range="B2:C4", key="style", value="highlight"\n    - cells in B2:C4 render with the highlight background class\n```\n\n```mdl\ntest T-5: Real-time collaboration\n  given: two peers have the same Sheet open\n  when: peer A sets cell D5 to "hello"\n  then:\n    - peer B\'s grid displays "hello" in D5 without reload\n```\n\n```mdl\ntest T-6: Scroll to anchor\n  given: a SheetArticle is mounted with attendableId "sheet-1"\n  when: op:scrollToAnchor runs with subject="sheet-1", cursor="E10"\n  then:\n    - the grid scrolls so that E10 is visible\n    - E10 is highlighted via activeRefs\n```\n\n---\n\n## Appendix: Extension Definitions\n\n```mdl\next type\n  uri: org.dxos.mdl.type@1.0\n  desc: A named data structure with typed fields and optional literals.\n  fields:\n    desc?: Prose\n    fields?: FieldMap\n    literals?: UnionList\n    extends?: TypeRef[]\n```\n\n```mdl\next feat\n  uri: org.dxos.mdl.feat@1.0\n  desc: A named feature grouping one or more requirements.\n  fields:\n    desc?: Prose\n    req: RequirementList\n  nesting: self\n```\n\n```mdl\next test\n  uri: org.dxos.mdl.test@1.0\n  desc: An acceptance scenario expressed as given / when / then steps.\n  fields:\n    given?: Step | Step[]\n    when?: Step | Step[]\n    then: Step | Step[]\n    tags?: TagList\n```\n\n```mdl\next component\n  uri: org.dxos.mdl.component@1.0\n  desc: A UI component with props, internal state, slots, actions, and events.\n  fields:\n    desc?: Prose\n    props?: FieldMap\n    state?: FieldMap\n    slots?: FieldMap\n    actions?: ActionMap\n    emits?: EventMap\n    layout?: CodeBlock\n```\n\n```mdl\next op\n  uri: org.dxos.mdl.op@1.0\n  desc: |\n    A named operation with typed inputs, outputs, and declared errors.\n    Pure ops have no effects or requires. Effectful ops declare both.\n  fields:\n    desc?: Prose\n    input?: FieldMap\n    output?: TypeExpr\n    errors?: ErrorMap\n    effects?: EffectList\n    requires?: ServiceList\n    note?: Prose\n```\n';
+
+// src/SheetPlugin.tsx
+var SheetPlugin = Plugin.define(meta).pipe(AppPlugin.addAppGraphModule({
+  activate: AppGraphBuilder
+}), AppPlugin.addNavigationResolverModule({
+  activate: NavigationResolver
+}), AppPlugin.addCommentConfigModule({
+  activate: CommentConfig
+}), AppPlugin.addCreateObjectModule({
+  activate: CreateObject
+}), AppPlugin.addOperationHandlerModule({
+  activate: OperationHandler
+}), AppPlugin.addUndoMappingsModule({
+  activate: UndoMappings
+}), AppPlugin.addSchemaModule({
+  schema: [
+    Sheet.Sheet
+  ]
+}), AppPlugin.addSurfaceModule({
+  activate: ReactSurface
+}), AppPlugin.addTranslationsModule({
+  translations
+}), Plugin.addModule({
+  activatesOn: AppActivationEvents.SetupSettings,
+  activate: SheetState
+}), Plugin.addModule({
+  activatesOn: ActivationEvent.allOf(ClientEvents.ClientReady, ActivationEvents.ProcessManagerReady),
+  activate: ComputeGraphRegistry
+}), Plugin.addModule({
+  activatesOn: MarkdownEvents.SetupExtensions,
+  activate: Markdown
+}), Plugin.addModule({
+  // TODO(wittjosiah): More relevant event?
+  activatesOn: AppActivationEvents.AppGraphReady,
+  activate: AnchorSort
+}), AppPlugin.addPluginAssetModule({
+  asset: {
+    pluginId: meta.id,
+    path: "PLUGIN.mdl",
+    content: PLUGIN_default,
+    mimeType: "application/x-mdl"
+  }
+}), Plugin.make);
+var SheetPlugin_default = SheetPlugin;
+export {
+  SheetPlugin,
+  SheetPlugin_default as default
+};
+//# sourceMappingURL=SheetPlugin.mjs.map