@dxos/plugin-sheet 0.8.4-main.406dc2a → 0.8.4-main.52d7546f51

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.
Files changed (239) hide show
  1. package/dist/lib/browser/SheetContainer-6DNFC4TY.mjs +397 -0
  2. package/dist/lib/browser/SheetContainer-6DNFC4TY.mjs.map +7 -0
  3. package/dist/lib/browser/anchor-sort-AMMLA66W.mjs +24 -0
  4. package/dist/lib/browser/anchor-sort-AMMLA66W.mjs.map +7 -0
  5. package/dist/lib/browser/chunk-EDWHV64N.mjs +1473 -0
  6. package/dist/lib/browser/chunk-EDWHV64N.mjs.map +7 -0
  7. package/dist/lib/browser/{chunk-SSN4HYJL.mjs → chunk-IFLWVS2V.mjs} +9 -9
  8. package/dist/lib/browser/chunk-IFLWVS2V.mjs.map +7 -0
  9. package/dist/lib/browser/chunk-KE3AKN5W.mjs +397 -0
  10. package/dist/lib/browser/chunk-KE3AKN5W.mjs.map +7 -0
  11. package/dist/lib/browser/compute-graph-registry-RC5L7RE4.mjs +21 -0
  12. package/dist/lib/browser/compute-graph-registry-RC5L7RE4.mjs.map +7 -0
  13. package/dist/lib/browser/index.mjs +71 -80
  14. package/dist/lib/browser/index.mjs.map +4 -4
  15. package/dist/lib/browser/markdown-D2T2DOVX.mjs +29 -0
  16. package/dist/lib/browser/markdown-D2T2DOVX.mjs.map +7 -0
  17. package/dist/lib/browser/meta.json +1 -1
  18. package/dist/lib/browser/operation-resolver-P2RX75DA.mjs +79 -0
  19. package/dist/lib/browser/operation-resolver-P2RX75DA.mjs.map +7 -0
  20. package/dist/lib/browser/{react-surface-7ZDMQDCT.mjs → react-surface-45CRAB5G.mjs} +19 -21
  21. package/dist/lib/browser/react-surface-45CRAB5G.mjs.map +7 -0
  22. package/dist/lib/browser/types/index.mjs +7 -12
  23. package/dist/lib/node-esm/SheetContainer-7H5R7M54.mjs +398 -0
  24. package/dist/lib/node-esm/SheetContainer-7H5R7M54.mjs.map +7 -0
  25. package/dist/lib/node-esm/anchor-sort-VHMBRX2E.mjs +25 -0
  26. package/dist/lib/node-esm/anchor-sort-VHMBRX2E.mjs.map +7 -0
  27. package/dist/lib/node-esm/chunk-6J5L47IB.mjs +398 -0
  28. package/dist/lib/node-esm/chunk-6J5L47IB.mjs.map +7 -0
  29. package/dist/lib/node-esm/chunk-AYSEWH7N.mjs +1474 -0
  30. package/dist/lib/node-esm/chunk-AYSEWH7N.mjs.map +7 -0
  31. package/dist/lib/node-esm/{chunk-IK4O7FUJ.mjs → chunk-PPOYR7DK.mjs} +9 -9
  32. package/dist/lib/node-esm/chunk-PPOYR7DK.mjs.map +7 -0
  33. package/dist/lib/node-esm/compute-graph-registry-ZGXVLVGD.mjs +22 -0
  34. package/dist/lib/node-esm/compute-graph-registry-ZGXVLVGD.mjs.map +7 -0
  35. package/dist/lib/node-esm/index.mjs +71 -80
  36. package/dist/lib/node-esm/index.mjs.map +4 -4
  37. package/dist/lib/node-esm/markdown-PTV72DLO.mjs +30 -0
  38. package/dist/lib/node-esm/markdown-PTV72DLO.mjs.map +7 -0
  39. package/dist/lib/node-esm/meta.json +1 -1
  40. package/dist/lib/node-esm/operation-resolver-WPIWQ5IO.mjs +80 -0
  41. package/dist/lib/node-esm/operation-resolver-WPIWQ5IO.mjs.map +7 -0
  42. package/dist/lib/node-esm/{react-surface-TUME5MM2.mjs → react-surface-ITV2L6HK.mjs} +19 -21
  43. package/dist/lib/node-esm/react-surface-ITV2L6HK.mjs.map +7 -0
  44. package/dist/lib/node-esm/types/index.mjs +7 -12
  45. package/dist/types/src/SheetPlugin.d.ts +2 -1
  46. package/dist/types/src/SheetPlugin.d.ts.map +1 -1
  47. package/dist/types/src/capabilities/anchor-sort/anchor-sort.d.ts +6 -0
  48. package/dist/types/src/capabilities/anchor-sort/anchor-sort.d.ts.map +1 -0
  49. package/dist/types/src/capabilities/anchor-sort/index.d.ts +3 -0
  50. package/dist/types/src/capabilities/anchor-sort/index.d.ts.map +1 -0
  51. package/dist/types/src/capabilities/compute-graph-registry/compute-graph-registry.d.ts +5 -0
  52. package/dist/types/src/capabilities/compute-graph-registry/compute-graph-registry.d.ts.map +1 -0
  53. package/dist/types/src/capabilities/compute-graph-registry/index.d.ts +3 -0
  54. package/dist/types/src/capabilities/compute-graph-registry/index.d.ts.map +1 -0
  55. package/dist/types/src/capabilities/index.d.ts +5 -9
  56. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  57. package/dist/types/src/capabilities/markdown/index.d.ts +3 -0
  58. package/dist/types/src/capabilities/markdown/index.d.ts.map +1 -0
  59. package/dist/types/src/capabilities/markdown/markdown.d.ts +5 -0
  60. package/dist/types/src/capabilities/markdown/markdown.d.ts.map +1 -0
  61. package/dist/types/src/capabilities/operation-resolver/index.d.ts +3 -0
  62. package/dist/types/src/capabilities/operation-resolver/index.d.ts.map +1 -0
  63. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts +5 -0
  64. package/dist/types/src/capabilities/operation-resolver/operation-resolver.d.ts.map +1 -0
  65. package/dist/types/src/capabilities/react-surface/index.d.ts +3 -0
  66. package/dist/types/src/capabilities/react-surface/index.d.ts.map +1 -0
  67. package/dist/types/src/capabilities/react-surface/react-surface.d.ts +5 -0
  68. package/dist/types/src/capabilities/react-surface/react-surface.d.ts.map +1 -0
  69. package/dist/types/src/components/GridSheet/GridSheet.d.ts.map +1 -1
  70. package/dist/types/src/components/GridSheet/GridSheet.stories.d.ts +3 -2
  71. package/dist/types/src/components/GridSheet/GridSheet.stories.d.ts.map +1 -1
  72. package/dist/types/src/components/GridSheet/SheetCellEditor.stories.d.ts +1 -1
  73. package/dist/types/src/components/GridSheet/SheetCellEditor.stories.d.ts.map +1 -1
  74. package/dist/types/src/components/GridSheet/util.d.ts.map +1 -1
  75. package/dist/types/src/components/RangeList/RangeList.d.ts +2 -2
  76. package/dist/types/src/components/RangeList/RangeList.d.ts.map +1 -1
  77. package/dist/types/src/components/SheetContainer/SheetContainer.d.ts +5 -6
  78. package/dist/types/src/components/SheetContainer/SheetContainer.d.ts.map +1 -1
  79. package/dist/types/src/components/SheetContainer/SheetContainer.stories.d.ts +5 -3
  80. package/dist/types/src/components/SheetContainer/SheetContainer.stories.d.ts.map +1 -1
  81. package/dist/types/src/components/SheetContext/SheetContext.d.ts +2 -2
  82. package/dist/types/src/components/SheetContext/SheetContext.d.ts.map +1 -1
  83. package/dist/types/src/components/SheetToolbar/SheetToolbar.d.ts +3 -4
  84. package/dist/types/src/components/SheetToolbar/SheetToolbar.d.ts.map +1 -1
  85. package/dist/types/src/components/SheetToolbar/SheetToolbar.stories.d.ts +2 -0
  86. package/dist/types/src/components/SheetToolbar/SheetToolbar.stories.d.ts.map +1 -1
  87. package/dist/types/src/components/SheetToolbar/align.d.ts +12 -19
  88. package/dist/types/src/components/SheetToolbar/align.d.ts.map +1 -1
  89. package/dist/types/src/components/SheetToolbar/style.d.ts +12 -18
  90. package/dist/types/src/components/SheetToolbar/style.d.ts.map +1 -1
  91. package/dist/types/src/components/SheetToolbar/useToolbarState.d.ts +14 -1
  92. package/dist/types/src/components/SheetToolbar/useToolbarState.d.ts.map +1 -1
  93. package/dist/types/src/components/index.d.ts +1 -1
  94. package/dist/types/src/components/index.d.ts.map +1 -1
  95. package/dist/types/src/extensions/compute.stories.d.ts.map +1 -1
  96. package/dist/types/src/extensions/editor/sheet-extension.d.ts.map +1 -1
  97. package/dist/types/src/index.d.ts +1 -1
  98. package/dist/types/src/index.d.ts.map +1 -1
  99. package/dist/types/src/integrations/thread-ranges.d.ts.map +1 -1
  100. package/dist/types/src/meta.d.ts +2 -2
  101. package/dist/types/src/meta.d.ts.map +1 -1
  102. package/dist/types/src/model/sheet-model.d.ts +6 -6
  103. package/dist/types/src/model/sheet-model.d.ts.map +1 -1
  104. package/dist/types/src/model/testing.d.ts +2 -2
  105. package/dist/types/src/model/testing.d.ts.map +1 -1
  106. package/dist/types/src/model/useSheetModel.d.ts +2 -2
  107. package/dist/types/src/model/useSheetModel.d.ts.map +1 -1
  108. package/dist/types/src/serializer.d.ts +2 -2
  109. package/dist/types/src/serializer.d.ts.map +1 -1
  110. package/dist/types/src/testing/data.d.ts +2 -2
  111. package/dist/types/src/testing/data.d.ts.map +1 -1
  112. package/dist/types/src/testing/testing.d.ts +26 -2
  113. package/dist/types/src/testing/testing.d.ts.map +1 -1
  114. package/dist/types/src/translations.d.ts +3 -2
  115. package/dist/types/src/translations.d.ts.map +1 -1
  116. package/dist/types/src/types/Sheet.d.ts +76 -0
  117. package/dist/types/src/types/Sheet.d.ts.map +1 -0
  118. package/dist/types/src/types/capabilities.d.ts +6 -0
  119. package/dist/types/src/types/capabilities.d.ts.map +1 -0
  120. package/dist/types/src/types/index.d.ts +2 -1
  121. package/dist/types/src/types/index.d.ts.map +1 -1
  122. package/dist/types/src/types/sheet-range-types.d.ts +2 -2
  123. package/dist/types/src/types/sheet-range-types.d.ts.map +1 -1
  124. package/dist/types/src/types/types.d.ts +91 -74
  125. package/dist/types/src/types/types.d.ts.map +1 -1
  126. package/dist/types/src/types/util.d.ts +10 -10
  127. package/dist/types/src/types/util.d.ts.map +1 -1
  128. package/dist/types/tsconfig.tsbuildinfo +1 -1
  129. package/package.json +76 -68
  130. package/src/SheetPlugin.tsx +41 -61
  131. package/src/capabilities/anchor-sort/anchor-sort.ts +27 -0
  132. package/src/capabilities/anchor-sort/index.ts +7 -0
  133. package/src/capabilities/compute-graph-registry/compute-graph-registry.ts +27 -0
  134. package/src/capabilities/compute-graph-registry/index.ts +7 -0
  135. package/src/capabilities/index.ts +5 -9
  136. package/src/capabilities/markdown/index.ts +7 -0
  137. package/src/capabilities/markdown/markdown.ts +30 -0
  138. package/src/capabilities/operation-resolver/index.ts +7 -0
  139. package/src/capabilities/operation-resolver/operation-resolver.ts +77 -0
  140. package/src/capabilities/react-surface/index.ts +7 -0
  141. package/src/capabilities/react-surface/react-surface.tsx +43 -0
  142. package/src/components/ComputeGraph/compute-graph.stories.tsx +9 -9
  143. package/src/components/FunctionEditor/FunctionEditor.tsx +2 -2
  144. package/src/components/GridSheet/GridSheet.stories.tsx +5 -5
  145. package/src/components/GridSheet/GridSheet.tsx +40 -30
  146. package/src/components/GridSheet/SheetCellEditor.stories.tsx +12 -9
  147. package/src/components/GridSheet/util.ts +11 -5
  148. package/src/components/RangeList/RangeList.tsx +10 -7
  149. package/src/components/SheetContainer/SheetContainer.stories.tsx +46 -23
  150. package/src/components/SheetContainer/SheetContainer.tsx +30 -22
  151. package/src/components/SheetContext/SheetContext.tsx +8 -8
  152. package/src/components/SheetToolbar/SheetToolbar.stories.tsx +1 -1
  153. package/src/components/SheetToolbar/SheetToolbar.tsx +39 -30
  154. package/src/components/SheetToolbar/align.ts +41 -16
  155. package/src/components/SheetToolbar/style.ts +45 -15
  156. package/src/components/SheetToolbar/useToolbarState.ts +22 -5
  157. package/src/extensions/compute.stories.tsx +19 -10
  158. package/src/extensions/compute.ts +1 -1
  159. package/src/extensions/editor/sheet-extension.ts +7 -4
  160. package/src/index.ts +1 -1
  161. package/src/integrations/thread-ranges.ts +39 -49
  162. package/src/meta.ts +8 -4
  163. package/src/model/sheet-model.test.ts +4 -4
  164. package/src/model/sheet-model.ts +80 -48
  165. package/src/model/testing.ts +4 -4
  166. package/src/model/useSheetModel.ts +2 -2
  167. package/src/playwright/playwright.config.ts +1 -1
  168. package/src/playwright/sheet.spec.ts +1 -0
  169. package/src/sanity.test.ts +3 -4
  170. package/src/serializer.ts +4 -4
  171. package/src/testing/data.ts +2 -2
  172. package/src/testing/testing.tsx +3 -3
  173. package/src/translations.ts +3 -2
  174. package/src/types/Sheet.ts +97 -0
  175. package/src/{capabilities → types}/capabilities.ts +2 -2
  176. package/src/types/index.ts +2 -1
  177. package/src/types/sheet-range-types.ts +2 -2
  178. package/src/types/types.ts +82 -48
  179. package/src/types/util.ts +11 -38
  180. package/dist/lib/browser/SheetContainer-VL34UND4.mjs +0 -351
  181. package/dist/lib/browser/SheetContainer-VL34UND4.mjs.map +0 -7
  182. package/dist/lib/browser/anchor-sort-3N44DS5F.mjs +0 -24
  183. package/dist/lib/browser/anchor-sort-3N44DS5F.mjs.map +0 -7
  184. package/dist/lib/browser/chunk-ADK2HW4A.mjs +0 -906
  185. package/dist/lib/browser/chunk-ADK2HW4A.mjs.map +0 -7
  186. package/dist/lib/browser/chunk-CSBSADPQ.mjs +0 -16
  187. package/dist/lib/browser/chunk-CSBSADPQ.mjs.map +0 -7
  188. package/dist/lib/browser/chunk-SSN4HYJL.mjs.map +0 -7
  189. package/dist/lib/browser/chunk-ZJWJMX4E.mjs +0 -852
  190. package/dist/lib/browser/chunk-ZJWJMX4E.mjs.map +0 -7
  191. package/dist/lib/browser/chunk-ZMPNHFIP.mjs +0 -15
  192. package/dist/lib/browser/chunk-ZMPNHFIP.mjs.map +0 -7
  193. package/dist/lib/browser/compute-graph-registry-MF65HGGM.mjs +0 -21
  194. package/dist/lib/browser/compute-graph-registry-MF65HGGM.mjs.map +0 -7
  195. package/dist/lib/browser/intent-resolver-BQLV6IAA.mjs +0 -56
  196. package/dist/lib/browser/intent-resolver-BQLV6IAA.mjs.map +0 -7
  197. package/dist/lib/browser/markdown-RMTMI237.mjs +0 -26
  198. package/dist/lib/browser/markdown-RMTMI237.mjs.map +0 -7
  199. package/dist/lib/browser/react-surface-7ZDMQDCT.mjs.map +0 -7
  200. package/dist/lib/node-esm/SheetContainer-NWJ7L6FC.mjs +0 -352
  201. package/dist/lib/node-esm/SheetContainer-NWJ7L6FC.mjs.map +0 -7
  202. package/dist/lib/node-esm/anchor-sort-YL2OZHYM.mjs +0 -25
  203. package/dist/lib/node-esm/anchor-sort-YL2OZHYM.mjs.map +0 -7
  204. package/dist/lib/node-esm/chunk-BZAPYBSH.mjs +0 -907
  205. package/dist/lib/node-esm/chunk-BZAPYBSH.mjs.map +0 -7
  206. package/dist/lib/node-esm/chunk-H3GSD33H.mjs +0 -18
  207. package/dist/lib/node-esm/chunk-H3GSD33H.mjs.map +0 -7
  208. package/dist/lib/node-esm/chunk-IK4O7FUJ.mjs.map +0 -7
  209. package/dist/lib/node-esm/chunk-LN6ZSAII.mjs +0 -16
  210. package/dist/lib/node-esm/chunk-LN6ZSAII.mjs.map +0 -7
  211. package/dist/lib/node-esm/chunk-YL7BVJPC.mjs +0 -853
  212. package/dist/lib/node-esm/chunk-YL7BVJPC.mjs.map +0 -7
  213. package/dist/lib/node-esm/compute-graph-registry-P2O5LDFZ.mjs +0 -22
  214. package/dist/lib/node-esm/compute-graph-registry-P2O5LDFZ.mjs.map +0 -7
  215. package/dist/lib/node-esm/intent-resolver-MV5ZFXAQ.mjs +0 -57
  216. package/dist/lib/node-esm/intent-resolver-MV5ZFXAQ.mjs.map +0 -7
  217. package/dist/lib/node-esm/markdown-EDIWHA3P.mjs +0 -27
  218. package/dist/lib/node-esm/markdown-EDIWHA3P.mjs.map +0 -7
  219. package/dist/lib/node-esm/react-surface-TUME5MM2.mjs.map +0 -7
  220. package/dist/types/src/capabilities/anchor-sort.d.ts +0 -6
  221. package/dist/types/src/capabilities/anchor-sort.d.ts.map +0 -1
  222. package/dist/types/src/capabilities/capabilities.d.ts +0 -5
  223. package/dist/types/src/capabilities/capabilities.d.ts.map +0 -1
  224. package/dist/types/src/capabilities/compute-graph-registry.d.ts +0 -4
  225. package/dist/types/src/capabilities/compute-graph-registry.d.ts.map +0 -1
  226. package/dist/types/src/capabilities/intent-resolver.d.ts +0 -4
  227. package/dist/types/src/capabilities/intent-resolver.d.ts.map +0 -1
  228. package/dist/types/src/capabilities/markdown.d.ts +0 -4
  229. package/dist/types/src/capabilities/markdown.d.ts.map +0 -1
  230. package/dist/types/src/capabilities/react-surface.d.ts +0 -4
  231. package/dist/types/src/capabilities/react-surface.d.ts.map +0 -1
  232. package/dist/types/src/types/schema.d.ts +0 -37
  233. package/dist/types/src/types/schema.d.ts.map +0 -1
  234. package/src/capabilities/anchor-sort.ts +0 -22
  235. package/src/capabilities/compute-graph-registry.ts +0 -23
  236. package/src/capabilities/intent-resolver.ts +0 -38
  237. package/src/capabilities/markdown.ts +0 -23
  238. package/src/capabilities/react-surface.tsx +0 -40
  239. package/src/types/schema.ts +0 -61
package/src/meta.ts CHANGED
@@ -2,14 +2,18 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { type PluginMeta } from '@dxos/app-framework';
5
+ import { type Plugin } from '@dxos/app-framework';
6
+ import { trim } from '@dxos/util';
6
7
 
7
- export const meta: PluginMeta = {
8
+ export const meta: Plugin.Meta = {
8
9
  id: 'dxos.org/plugin/sheet',
9
10
  name: 'Sheet',
10
- description:
11
- 'Sheets in Composer are simple spreadsheets which allow you to leverage custom functions inside of cell grids. Leverage more than 400 pre-built formulas like Sum, Average, Count, Max, Min along with many others. You can also deploy your own custom functions using the Scripts plugin. ',
11
+ description: trim`
12
+ Full-featured spreadsheet application with over 400 built-in formulas for calculations and data analysis.
13
+ Create custom JavaScript functions and integrate with AI agents for advanced automation.
14
+ `,
12
15
  icon: 'ph--grid-nine--regular',
16
+ iconHue: 'indigo',
13
17
  source: 'https://github.com/dxos/dxos/tree/main/packages/plugins/plugin-sheet',
14
18
  screenshots: ['https://dxos.network/plugin-details-sheet-dark.png'],
15
19
  };
@@ -7,10 +7,10 @@ import { afterEach, beforeEach, describe, expect, onTestFinished, test } from 'v
7
7
  import { Trigger } from '@dxos/async';
8
8
  import { type CellScalarValue, addressFromA1Notation, isFormula } from '@dxos/compute';
9
9
  import { TestBuilder, testFunctionPlugins } from '@dxos/compute/testing';
10
- import { FunctionType } from '@dxos/functions';
10
+ import { Function } from '@dxos/functions';
11
11
  import { log } from '@dxos/log';
12
12
 
13
- import { createSheet, mapFormulaIndicesToRefs, mapFormulaRefsToIndices } from '../types';
13
+ import { Sheet, mapFormulaIndicesToRefs, mapFormulaRefsToIndices } from '../types';
14
14
 
15
15
  import { SheetModel } from './sheet-model';
16
16
  import { createTestGrid } from './testing';
@@ -18,7 +18,7 @@ import { createTestGrid } from './testing';
18
18
  describe('SheetModel', () => {
19
19
  let testBuilder: TestBuilder;
20
20
  beforeEach(async () => {
21
- testBuilder = new TestBuilder({ types: [FunctionType], plugins: testFunctionPlugins });
21
+ testBuilder = new TestBuilder({ types: [Function.Function], plugins: testFunctionPlugins });
22
22
  await testBuilder.open();
23
23
  });
24
24
  afterEach(async () => {
@@ -31,7 +31,7 @@ describe('SheetModel', () => {
31
31
  await graph.open();
32
32
 
33
33
  // TODO(burdon): Create via factory.
34
- const sheet = createSheet({ rows: 5, columns: 5 });
34
+ const sheet = Sheet.make({ rows: 5, columns: 5 });
35
35
  const model = new SheetModel(graph, sheet);
36
36
  await model.open();
37
37
  testBuilder.ctx.onDispose(() => model.close());
@@ -23,7 +23,7 @@ import {
23
23
  } from '@dxos/compute';
24
24
  import { Resource } from '@dxos/context';
25
25
  import { Obj } from '@dxos/echo';
26
- import { FormatEnum, TypeEnum } from '@dxos/echo/internal';
26
+ import { Format, TypeEnum } from '@dxos/echo/internal';
27
27
  import { invariant } from '@dxos/invariant';
28
28
  import { PublicKey } from '@dxos/keys';
29
29
  import { log } from '@dxos/log';
@@ -39,21 +39,21 @@ import {
39
39
  mapFormulaIndicesToRefs,
40
40
  mapFormulaRefsToIndices,
41
41
  } from '../types';
42
- import { type CellValue, type SheetAction, type SheetType } from '../types';
42
+ import { type Sheet, type SheetAction } from '../types';
43
43
 
44
44
  // TODO(burdon): Move to compute.
45
45
  // Map sheet types to system types.
46
46
  // https://hyperformula.handsontable.com/guide/types-of-values.html
47
47
  // - https://github.com/handsontable/hyperformula/blob/master/src/Cell.ts (CellValueType)
48
48
  // - https://github.com/handsontable/hyperformula/blob/master/src/interpreter/InterpreterValue.ts (NumberType)
49
- const typeMap: Record<string, { type: TypeEnum; format?: FormatEnum }> = {
49
+ const typeMap: Record<string, { type: TypeEnum; format?: Format.TypeFormat }> = {
50
50
  BOOLEAN: { type: TypeEnum.Boolean },
51
51
  NUMBER_RAW: { type: TypeEnum.Number },
52
- NUMBER_PERCENT: { type: TypeEnum.Number, format: FormatEnum.Percent },
53
- NUMBER_CURRENCY: { type: TypeEnum.Number, format: FormatEnum.Currency },
54
- NUMBER_DATETIME: { type: TypeEnum.String, format: FormatEnum.DateTime },
55
- NUMBER_DATE: { type: TypeEnum.String, format: FormatEnum.Date },
56
- NUMBER_TIME: { type: TypeEnum.String, format: FormatEnum.Time },
52
+ NUMBER_PERCENT: { type: TypeEnum.Number, format: Format.TypeFormat.Percent },
53
+ NUMBER_CURRENCY: { type: TypeEnum.Number, format: Format.TypeFormat.Currency },
54
+ NUMBER_DATETIME: { type: TypeEnum.String, format: Format.TypeFormat.DateTime },
55
+ NUMBER_DATE: { type: TypeEnum.String, format: Format.TypeFormat.Date },
56
+ NUMBER_TIME: { type: TypeEnum.String, format: Format.TypeFormat.Time },
57
57
  };
58
58
 
59
59
  const getTopLeft = (range: CellRange): CellAddress => {
@@ -92,7 +92,7 @@ export class SheetModel extends Resource {
92
92
 
93
93
  constructor(
94
94
  private readonly _graph: ComputeGraph,
95
- private readonly _sheet: SheetType,
95
+ private readonly _sheet: Sheet.Sheet,
96
96
  private readonly _options: SheetModelOptions = {},
97
97
  ) {
98
98
  super();
@@ -122,7 +122,9 @@ export class SheetModel extends Resource {
122
122
  */
123
123
  protected override async _open(): Promise<void> {
124
124
  log('initialize', { id: this.id });
125
- initialize(this._sheet);
125
+ Obj.change(this._sheet, (obj) => {
126
+ initialize(obj);
127
+ });
126
128
 
127
129
  this._graph.update.on((event) => {
128
130
  if (event.type === 'functionsUpdated') {
@@ -181,13 +183,19 @@ export class SheetModel extends Resource {
181
183
  }
182
184
 
183
185
  insertRows(i: number, n = 1): string[] {
184
- const idx = insertIndices(this._sheet.rows, i, n, MAX_ROWS);
186
+ let idx: string[] = [];
187
+ Obj.change(this._sheet, (obj) => {
188
+ idx = insertIndices(obj.rows, i, n, MAX_ROWS);
189
+ });
185
190
  this.reset();
186
191
  return idx;
187
192
  }
188
193
 
189
194
  insertColumns(i: number, n = 1): string[] {
190
- const idx = insertIndices(this._sheet.columns, i, n, MAX_COLS);
195
+ let idx: string[] = [];
196
+ Obj.change(this._sheet, (obj) => {
197
+ idx = insertIndices(obj.columns, i, n, MAX_COLS);
198
+ });
191
199
  this.reset();
192
200
  return idx;
193
201
  }
@@ -200,8 +208,10 @@ export class SheetModel extends Resource {
200
208
  const values = this.getCellValues(range).flat();
201
209
  const index = this._sheet.rows.indexOf(rowIndex);
202
210
  this.clear(range);
203
- this._sheet.rows.splice(index, 1);
204
- delete this._sheet.rowMeta[rowIndex];
211
+ Obj.change(this._sheet, (obj) => {
212
+ obj.rows.splice(index, 1);
213
+ delete obj.rowMeta[rowIndex];
214
+ });
205
215
  this.reset();
206
216
  return { axis: 'row', index, axisIndex: rowIndex, axisMeta: this._sheet.rowMeta[rowIndex], values };
207
217
  }
@@ -214,35 +224,43 @@ export class SheetModel extends Resource {
214
224
  const values = this.getCellValues(range).flat();
215
225
  const index = this._sheet.columns.indexOf(colIndex);
216
226
  this.clear(range);
217
- this._sheet.columns.splice(index, 1);
218
- delete this._sheet.columnMeta[colIndex];
227
+ Obj.change(this._sheet, (obj) => {
228
+ obj.columns.splice(index, 1);
229
+ delete obj.columnMeta[colIndex];
230
+ });
219
231
  this.reset();
220
232
  return { axis: 'col', index, axisIndex: colIndex, axisMeta: this._sheet.rowMeta[colIndex], values };
221
233
  }
222
234
 
223
235
  restoreRow({ index, axisIndex, axisMeta, values }: SheetAction.RestoreAxis): void {
224
- this._sheet.rows.splice(index, 0, axisIndex);
225
- values.forEach((value, col) => {
226
- if (value) {
227
- this._sheet.cells[`${this._sheet.columns[col]}@${axisIndex}`] = { value };
236
+ Obj.change(this._sheet, (obj) => {
237
+ obj.rows.splice(index, 0, axisIndex);
238
+ values.forEach((value, col) => {
239
+ if (value) {
240
+ obj.cells[`${obj.columns[col]}@${axisIndex}`] = { value };
241
+ }
242
+ });
243
+
244
+ if (axisMeta) {
245
+ obj.rowMeta[axisIndex] = axisMeta;
228
246
  }
229
247
  });
230
- if (axisMeta) {
231
- this._sheet.rowMeta[axisIndex] = axisMeta;
232
- }
233
248
  this.reset();
234
249
  }
235
250
 
236
251
  restoreColumn({ index, axisIndex, axisMeta, values }: SheetAction.RestoreAxis): void {
237
- this._sheet.columns.splice(index, 0, axisIndex);
238
- values.forEach((value, row) => {
239
- if (value) {
240
- this._sheet.cells[`${axisIndex}@${this._sheet.rows[row]}`] = { value };
252
+ Obj.change(this._sheet, (obj) => {
253
+ obj.columns.splice(index, 0, axisIndex);
254
+ values.forEach((value, row) => {
255
+ if (value) {
256
+ obj.cells[`${axisIndex}@${obj.rows[row]}`] = { value };
257
+ }
258
+ });
259
+
260
+ if (axisMeta) {
261
+ obj.columnMeta[axisIndex] = axisMeta;
241
262
  }
242
263
  });
243
- if (axisMeta) {
244
- this._sheet.columnMeta[axisIndex] = axisMeta;
245
- }
246
264
  this.reset();
247
265
  }
248
266
 
@@ -259,18 +277,22 @@ export class SheetModel extends Resource {
259
277
  const topLeft = getTopLeft(range);
260
278
  const values = this._iterRange(range, () => null);
261
279
  this._node.graph.hf.setCellContents(toSimpleCellAddress(this._node.sheetId, topLeft), values);
262
- this._iterRange(range, (cell) => {
263
- const idx = addressToIndex(this._sheet, cell);
264
- delete this._sheet.cells[idx];
280
+ Obj.change(this._sheet, (obj) => {
281
+ this._iterRange(range, (cell) => {
282
+ const idx = addressToIndex(this._sheet, cell);
283
+ delete obj.cells[idx];
284
+ });
265
285
  });
266
286
  }
267
287
 
268
288
  cut(range: CellRange): void {
269
289
  invariant(this._node);
270
290
  this._node.graph.hf.cut(toModelRange(this._node.sheetId, range));
271
- this._iterRange(range, (cell) => {
272
- const idx = addressToIndex(this._sheet, cell);
273
- delete this._sheet.cells[idx];
291
+ Obj.change(this._sheet, (obj) => {
292
+ this._iterRange(range, (cell) => {
293
+ const idx = addressToIndex(this._sheet, cell);
294
+ delete obj.cells[idx];
295
+ });
274
296
  });
275
297
  }
276
298
 
@@ -283,13 +305,15 @@ export class SheetModel extends Resource {
283
305
  invariant(this._node);
284
306
  if (!this._node.graph.hf.isClipboardEmpty()) {
285
307
  const changes = this._node.graph.hf.paste(toSimpleCellAddress(this._node.sheetId, cell));
286
- for (const change of changes) {
287
- if (change instanceof ExportedCellChange) {
288
- const { address, newValue } = change;
289
- const idx = addressToIndex(this._sheet, { row: address.row, col: address.col });
290
- this._sheet.cells[idx] = { value: newValue };
308
+ Obj.change(this._sheet, (obj) => {
309
+ for (const change of changes) {
310
+ if (change instanceof ExportedCellChange) {
311
+ const { address, newValue } = change;
312
+ const idx = addressToIndex(this._sheet, { row: address.row, col: address.col });
313
+ obj.cells[idx] = { value: newValue };
314
+ }
291
315
  }
292
- }
316
+ });
293
317
  }
294
318
  }
295
319
 
@@ -361,7 +385,7 @@ export class SheetModel extends Resource {
361
385
  /**
362
386
  * Get value type.
363
387
  */
364
- getValueDescription(cell: CellAddress): { type: TypeEnum; format?: FormatEnum } | undefined {
388
+ getValueDescription(cell: CellAddress): { type: TypeEnum; format?: Format.TypeFormat } | undefined {
365
389
  invariant(this._node);
366
390
  const addr = toSimpleCellAddress(this._node.sheetId, cell);
367
391
  const type = this._node.graph.hf.getCellValueDetailedType(addr);
@@ -380,11 +404,15 @@ export class SheetModel extends Resource {
380
404
  // Reallocate if > current bounds.
381
405
  let refresh = false;
382
406
  if (cell.row >= this._sheet.rows.length) {
383
- insertIndices(this._sheet.rows, cell.row, 1, MAX_ROWS);
407
+ Obj.change(this._sheet, (obj) => {
408
+ insertIndices(obj.rows, cell.row, 1, MAX_ROWS);
409
+ });
384
410
  refresh = true;
385
411
  }
386
412
  if (cell.col >= this._sheet.columns.length) {
387
- insertIndices(this._sheet.columns, cell.col, 1, MAX_COLS);
413
+ Obj.change(this._sheet, (obj) => {
414
+ insertIndices(obj.columns, cell.col, 1, MAX_COLS);
415
+ });
388
416
  refresh = true;
389
417
  }
390
418
 
@@ -401,20 +429,24 @@ export class SheetModel extends Resource {
401
429
  // Insert into sheet.
402
430
  const idx = addressToIndex(this._sheet, cell);
403
431
  if (value === undefined || value === null) {
404
- delete this._sheet.cells[idx];
432
+ Obj.change(this._sheet, (obj) => {
433
+ delete obj.cells[idx];
434
+ });
405
435
  } else {
406
436
  if (isFormula(value)) {
407
437
  value = this._graph.mapFunctionBindingToId(mapFormulaRefsToIndices(this._sheet, value));
408
438
  }
409
439
 
410
- this._sheet.cells[idx] = { value };
440
+ Obj.change(this._sheet, (obj) => {
441
+ obj.cells[idx] = { value };
442
+ });
411
443
  }
412
444
  }
413
445
 
414
446
  /**
415
447
  * Sets values from a simple map.
416
448
  */
417
- setValues(values: Record<string, CellValue>): void {
449
+ setValues(values: Record<string, Sheet.CellValue>): void {
418
450
  Object.entries(values).forEach(([key, { value }]) => {
419
451
  this.setValue(addressFromA1Notation(key), value);
420
452
  });
@@ -4,14 +4,14 @@
4
4
 
5
5
  import { addressToA1Notation } from '@dxos/compute';
6
6
 
7
- import { type CellValue, type SheetType, createSheet } from '../types';
7
+ import { Sheet } from '../types';
8
8
 
9
9
  // TODO(burdon): Create testing endpoint.
10
10
  // TODO(burdon): Move to react-ui-sheet.
11
- export const createTestGrid = ({ cols = 4, rows = 10 }: { cols: number; rows: number }): SheetType => {
11
+ export const createTestGrid = ({ cols = 4, rows = 10 }: { cols: number; rows: number }): Sheet.Sheet => {
12
12
  const year = new Date().getFullYear();
13
13
 
14
- const cells: Record<string, CellValue> = {};
14
+ const cells: Record<string, Sheet.CellValue> = {};
15
15
  for (let col = 1; col <= cols; col++) {
16
16
  for (let row = 1; row <= 10; row++) {
17
17
  const cell = addressToA1Notation({ col, row });
@@ -27,7 +27,7 @@ export const createTestGrid = ({ cols = 4, rows = 10 }: { cols: number; rows: nu
27
27
  }
28
28
  }
29
29
 
30
- const sheet = createSheet({
30
+ const sheet = Sheet.make({
31
31
  name: 'Test',
32
32
  cells,
33
33
  });
@@ -7,7 +7,7 @@ import { useEffect, useState } from 'react';
7
7
  import { type ComputeGraph } from '@dxos/compute';
8
8
 
9
9
  import { SheetModel } from '../model';
10
- import { type SheetType } from '../types';
10
+ import { type Sheet } from '../types';
11
11
 
12
12
  export type UseSheetModelOptions = {
13
13
  readonly?: boolean;
@@ -15,7 +15,7 @@ export type UseSheetModelOptions = {
15
15
 
16
16
  export const useSheetModel = (
17
17
  graph?: ComputeGraph,
18
- sheet?: SheetType,
18
+ sheet?: Sheet.Sheet,
19
19
  { readonly }: UseSheetModelOptions = {},
20
20
  ): SheetModel | undefined => {
21
21
  const [model, setModel] = useState<SheetModel>();
@@ -10,7 +10,7 @@ export default defineConfig({
10
10
  ...e2ePreset(import.meta.dirname),
11
11
  // TODO(wittjosiah): Avoid hard-coding ports.
12
12
  webServer: {
13
- command: 'moon run storybook:serve-e2e -- --port=9005',
13
+ command: 'moon run storybook-react:serve-e2e -- --port=9005',
14
14
  port: 9005,
15
15
  reuseExistingServer: false,
16
16
  },
@@ -16,6 +16,7 @@ test.describe('plugin-sheet', () => {
16
16
  test.beforeEach(async ({ browser }) => {
17
17
  const setup = await setupPage(browser, {
18
18
  url: storybookUrl('plugins-plugin-sheet-sheetcontainer--spec', 9005),
19
+ viewportSize: { width: 1280, height: 720 },
19
20
  });
20
21
  page = setup.page;
21
22
  sheet = new SheetManager(page);
@@ -5,8 +5,7 @@
5
5
  import { describe, expect, test } from 'vitest';
6
6
 
7
7
  import { Client } from '@dxos/client';
8
- import { Obj } from '@dxos/echo';
9
- import { FunctionType } from '@dxos/functions';
8
+ import { Function } from '@dxos/functions';
10
9
 
11
10
  // Part 2.
12
11
  // TODO(burdon): Cannot test outside of browser.
@@ -23,7 +22,7 @@ import { FunctionType } from '@dxos/functions';
23
22
  describe('test', () => {
24
23
  test('test', async () => {
25
24
  const client = new Client();
26
- client.addTypes([FunctionType]);
25
+ await client.addTypes([Function.Function]);
27
26
  await client.initialize();
28
27
  await client.halo.createIdentity();
29
28
 
@@ -34,7 +33,7 @@ describe('test', () => {
34
33
  // - ERROR "process.nextTick is not a function"
35
34
  // - ERROR "Identifier 'Buffer' has already been declared" if { nodeExternal: true }
36
35
  const space = await client.spaces.create();
37
- const fn = space.db.add(Obj.make(FunctionType, { name: 'test', version: '0.0.1', binding: 'HELLO' }));
36
+ const fn = space.db.add(Function.make({ name: 'test', version: '0.0.1', binding: 'HELLO' }));
38
37
  expect(fn).to.exist;
39
38
  });
40
39
  });
package/src/serializer.ts CHANGED
@@ -3,19 +3,19 @@
3
3
  //
4
4
 
5
5
  import { Obj } from '@dxos/echo';
6
+ import { getObjectCore } from '@dxos/echo-db';
6
7
  import { type TypedObjectSerializer } from '@dxos/plugin-space/types';
7
- import { getObjectCore } from '@dxos/react-client/echo';
8
8
 
9
- import { SheetType } from './types';
9
+ import { Sheet } from './types';
10
10
 
11
- export const serializer: TypedObjectSerializer<SheetType> = {
11
+ export const serializer: TypedObjectSerializer<Sheet.Sheet> = {
12
12
  serialize: async ({ object }): Promise<string> => {
13
13
  return JSON.stringify(object, null, 2);
14
14
  },
15
15
 
16
16
  deserialize: async ({ content, newId }) => {
17
17
  const { id, ...parsed } = JSON.parse(content);
18
- const sheet = Obj.make(SheetType, parsed);
18
+ const sheet = Obj.make(Sheet.Sheet, parsed);
19
19
 
20
20
  if (!newId) {
21
21
  const core = getObjectCore(sheet);
@@ -2,9 +2,9 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- import type { CellValue } from '../types';
5
+ import type { Sheet } from '../types';
6
6
 
7
- export const createTestCells = (testSheetName = 'test'): Record<string, CellValue> => ({
7
+ export const createTestCells = (testSheetName = 'test'): Record<string, Sheet.CellValue> => ({
8
8
  B1: { value: 'Qty2' },
9
9
  B3: { value: 1 },
10
10
  B4: { value: 2 },
@@ -11,15 +11,15 @@ import { type Space } from '@dxos/react-client/echo';
11
11
  import { useAsyncState } from '@dxos/react-hooks';
12
12
 
13
13
  import { ComputeGraphContextProvider } from '../components';
14
- import { type CreateSheetOptions, createSheet } from '../types';
14
+ import { Sheet } from '../types';
15
15
 
16
- export const useTestSheet = (space?: Space, graph?: ComputeGraph, options?: CreateSheetOptions) => {
16
+ export const useTestSheet = (space?: Space, graph?: ComputeGraph, options?: Sheet.SheetProps) => {
17
17
  const [sheet] = useAsyncState(async () => {
18
18
  if (!space || !graph) {
19
19
  return;
20
20
  }
21
21
 
22
- const sheet = createSheet(options);
22
+ const sheet = Sheet.make(options);
23
23
  space.db.add(sheet);
24
24
  return sheet;
25
25
  }, [space, graph]);
@@ -5,12 +5,12 @@
5
5
  import { type Resource } from '@dxos/react-ui';
6
6
 
7
7
  import { meta } from './meta';
8
- import { SheetType } from './types';
8
+ import { Sheet } from './types';
9
9
 
10
10
  export const translations = [
11
11
  {
12
12
  'en-US': {
13
- [SheetType.typename]: {
13
+ [Sheet.Sheet.typename]: {
14
14
  'typename label': 'Sheet',
15
15
  'typename label_zero': 'Sheets',
16
16
  'typename label_one': 'Sheet',
@@ -18,6 +18,7 @@ export const translations = [
18
18
  'object name placeholder': 'New sheet',
19
19
  'rename object label': 'Rename sheet',
20
20
  'delete object label': 'Delete sheet',
21
+ 'object deleted label': 'Sheet deleted',
21
22
  },
22
23
  [meta.id]: {
23
24
  'plugin name': 'Sheets',
@@ -0,0 +1,97 @@
1
+ //
2
+ // Copyright 2023 DXOS.org
3
+ //
4
+
5
+ import * as Schema from 'effect/Schema';
6
+
7
+ import { addressFromA1Notation, isFormula } from '@dxos/compute';
8
+ import { Obj, Type } from '@dxos/echo';
9
+ import { FormInputAnnotation } from '@dxos/echo/internal';
10
+
11
+ import { addressToIndex, initialize, mapFormulaRefsToIndices } from './util';
12
+
13
+ export type SheetSize = {
14
+ rows: number;
15
+ columns: number;
16
+ };
17
+
18
+ export const CellValue = Schema.Struct({
19
+ // TODO(burdon): How to store dates (datetime, date, time), percentages, etc.
20
+ // Consider import/export; natural access for other plugins. Special handling for currency (precision).
21
+ // TODO(burdon): Automerge (long string) or short string or number.
22
+ value: Schema.Any,
23
+ });
24
+
25
+ export type CellValue = Schema.Schema.Type<typeof CellValue>;
26
+
27
+ // TODO(burdon): IMPORTANT: Reconcile with Field definition.
28
+ export const Range = Schema.Struct({
29
+ range: Schema.String,
30
+ key: Schema.String,
31
+ value: Schema.String,
32
+ });
33
+
34
+ export type Range = Schema.Schema.Type<typeof Range>;
35
+
36
+ // TODO(burdon): Visibility, locked, frozen, etc.
37
+ export const RowColumnMeta = Schema.Struct({
38
+ size: Schema.optional(Schema.Number),
39
+ });
40
+
41
+ // TODO(burdon): Reconcile col/column (across packages).
42
+ // TODO(burdon): Index to all updates when rows/columns are inserted/deleted.
43
+ export const Sheet = Schema.Struct({
44
+ name: Schema.optional(Schema.String),
45
+
46
+ // Sparse map of cells referenced by index.
47
+ cells: Schema.Record({ key: Schema.String, value: CellValue }).pipe(FormInputAnnotation.set(false)),
48
+
49
+ // Ordered row indices.
50
+ rows: Schema.Array(Schema.String).pipe(FormInputAnnotation.set(false)),
51
+
52
+ // Ordered column indices.
53
+ columns: Schema.Array(Schema.String).pipe(FormInputAnnotation.set(false)),
54
+
55
+ // Row metadata referenced by index.
56
+ rowMeta: Schema.Record({ key: Schema.String, value: RowColumnMeta }).pipe(FormInputAnnotation.set(false)),
57
+
58
+ // Column metadata referenced by index.
59
+ columnMeta: Schema.Record({ key: Schema.String, value: RowColumnMeta }).pipe(FormInputAnnotation.set(false)),
60
+
61
+ // Cell formatting referenced by indexed range.
62
+ ranges: Schema.Array(Range).pipe(FormInputAnnotation.set(false)),
63
+ }).pipe(
64
+ Type.object({
65
+ typename: 'dxos.org/type/Sheet',
66
+ version: '0.1.0',
67
+ }),
68
+ );
69
+
70
+ export interface Sheet extends Schema.Schema.Type<typeof Sheet> {}
71
+
72
+ export type SheetProps = {
73
+ name?: string;
74
+ cells?: Record<string, CellValue>;
75
+ } & Partial<SheetSize>;
76
+
77
+ export const make = ({ name, cells = {}, ...size }: SheetProps = {}) => {
78
+ const sheet = Obj.make(Sheet, { name, cells: {}, rows: [], columns: [], rowMeta: {}, columnMeta: {}, ranges: [] });
79
+
80
+ // Initialize and set cells within Obj.change to satisfy change context requirements.
81
+ Obj.change(sheet, (s) => {
82
+ initialize(s, size);
83
+
84
+ if (cells) {
85
+ Object.entries(cells).forEach(([key, { value }]) => {
86
+ const idx = addressToIndex(s, addressFromA1Notation(key));
87
+ if (isFormula(value)) {
88
+ value = mapFormulaRefsToIndices(s, value);
89
+ }
90
+
91
+ s.cells[idx] = { value };
92
+ });
93
+ }
94
+ });
95
+
96
+ return sheet;
97
+ };
@@ -2,13 +2,13 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import { defineCapability } from '@dxos/app-framework';
5
+ import { Capability } from '@dxos/app-framework';
6
6
  import { type ComputeGraphRegistry } from '@dxos/compute';
7
7
 
8
8
  import { meta } from '../meta';
9
9
 
10
10
  export namespace SheetCapabilities {
11
- export const ComputeGraphRegistry = defineCapability<ComputeGraphRegistry>(
11
+ export const ComputeGraphRegistry = Capability.make<ComputeGraphRegistry>(
12
12
  `${meta.id}/capability/compute-graph-registry`,
13
13
  );
14
14
  }
@@ -2,7 +2,8 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- export * from './schema';
5
+ export * from './capabilities';
6
+ export * as Sheet from './Sheet';
6
7
  export * from './sheet-range-types';
7
8
  export * from './types';
8
9
  export * from './util';
@@ -4,7 +4,7 @@
4
4
 
5
5
  import { type ClassNameValue } from '@dxos/react-ui';
6
6
 
7
- import { type SheetType } from '../types';
7
+ import { type Sheet } from '../types';
8
8
 
9
9
  export const alignKey = 'alignment';
10
10
  export type AlignKey = typeof alignKey;
@@ -19,7 +19,7 @@ export type StyleKey = typeof styleKey;
19
19
  export type StyleValue = 'highlight' | 'softwrap';
20
20
 
21
21
  // TODO(burdon): Reconcile with plugin-table.
22
- export const cellClassNameForRange = ({ key, value }: SheetType['ranges'][number]): ClassNameValue => {
22
+ export const cellClassNameForRange = ({ key, value }: Sheet.Sheet['ranges'][number]): ClassNameValue => {
23
23
  switch (key) {
24
24
  case alignKey:
25
25
  switch (value) {