@dxos/plugin-sheet 0.6.13 → 0.6.14-main.69511f5

package/src/types.ts

@@ -9,8 +9,11 @@ import type {
   SurfaceProvides,
   TranslationsProvides,
 } from '@dxos/app-framework';
-import { create, S, TypedObject } from '@dxos/echo-schema';
+import { ref, S, TypedObject } from '@dxos/echo-schema';
 import { type SchemaProvides } from '@dxos/plugin-client';
+import { type MarkdownExtensionProvides } from '@dxos/plugin-markdown';
+import { type SpaceInitProvides } from '@dxos/plugin-space';
+import { ThreadType } from '@dxos/plugin-space/types';
 import { type StackProvides } from '@dxos/plugin-stack';
 
 import { SHEET_PLUGIN } from './meta';
@@ -21,13 +24,26 @@ export enum SheetAction {
   CREATE = `${SHEET_ACTION}/create`,
 }
 
+// TODO(Zan): Move this to the plugin-space plugin or another common location
+// when we implement comments in sheets.
+// This is currently duplicated in a few places.
+type ThreadProvides<T> = {
+  thread: {
+    predicate: (obj: any) => obj is T;
+    createSort: (obj: T) => (anchorA: string | undefined, anchorB: string | undefined) => number;
+  };
+};
+
 export type SheetPluginProvides = SurfaceProvides &
   IntentResolverProvides &
   GraphBuilderProvides &
+  MarkdownExtensionProvides &
   MetadataRecordsProvides &
   TranslationsProvides &
   SchemaProvides &
-  StackProvides;
+  SpaceInitProvides &
+  StackProvides &
+  ThreadProvides<SheetType>;
 
 export type CellScalarValue = number | string | boolean | null;
 
@@ -35,47 +51,19 @@ export const CellValue = S.Struct({
   // TODO(burdon): How to store dates (datetime, date, time), percentages, etc.
   //  Consider import/export; natural access for other plugins. Special handling for currency (precision).
   // TODO(burdon): Automerge (long string) or short string or number.
-  // TODO(burdon): Arrays?
   value: S.Any,
 });
 
 export type CellValue = S.Schema.Type<typeof CellValue>;
 
-/**
- * https://www.tutorialsteacher.com/typescript/typescript-number
- */
-// TODO(burdon): Format vs. value.
-export enum ValueTypeEnum {
-  Null = 0,
-  Number = 1,
-  Boolean = 2,
-  String = 3,
-
-  // Special numbers.
-  Percent = 10,
-  Currency = 11,
-
-  // Dates.
-  DateTime = 20,
-  Date = 21,
-  Time = 22,
-
-  // Validated string types.
-  // TODO(burdon): Define effect types.
-  URL = 30,
-  DID = 31,
-}
-
-export const ValueType = S.Enums(ValueTypeEnum);
-
-export const Formatting = S.Struct({
-  type: S.optional(ValueType),
-  format: S.optional(S.String),
-  precision: S.optional(S.Number),
-  classNames: S.optional(S.Array(S.String)),
+// TODO(burdon): IMPORTANT: Reconcile with Field definition.
+export const Range = S.Struct({
+  range: S.String,
+  key: S.String,
+  value: S.String,
 });
 
-export type Formatting = S.Schema.Type<typeof Formatting>;
+export type Range = S.Schema.Type<typeof Range>;
 
 // TODO(burdon): Visibility, locked, frozen, etc.
 export const RowColumnMeta = S.Struct({
@@ -83,13 +71,11 @@ export const RowColumnMeta = S.Struct({
 });
 
 // TODO(burdon): Index to all updates when rows/columns are inserted/deleted.
-// TODO(wittjosiah): Migrate typename to remove `Type` suffix.
-// TODO(wittjosiah): Rename title to name to align with other schemas.
-export class SheetType extends TypedObject({ typename: 'dxos.org/type/SheetType', version: '0.1.0' })({
-  title: S.optional(S.String),
+export class SheetType extends TypedObject({ typename: 'dxos.org/type/Sheet', version: '0.1.0' })({
+  name: S.optional(S.String),
 
   // Sparse map of cells referenced by index.
-  cells: S.mutable(S.Record(S.String, S.mutable(CellValue))),
+  cells: S.mutable(S.Record({ key: S.String, value: S.mutable(CellValue) })),
 
   // Ordered row indices.
   rows: S.mutable(S.Array(S.String)),
@@ -98,15 +84,24 @@ export class SheetType extends TypedObject({ typename: 'dxos.org/type/SheetType'
   columns: S.mutable(S.Array(S.String)),
 
   // Row metadata referenced by index.
-  rowMeta: S.mutable(S.Record(S.String, S.mutable(RowColumnMeta))),
+  rowMeta: S.mutable(S.Record({ key: S.String, value: S.mutable(RowColumnMeta) })),
 
   // Column metadata referenced by index.
-  columnMeta: S.mutable(S.Record(S.String, S.mutable(RowColumnMeta))),
+  columnMeta: S.mutable(S.Record({ key: S.String, value: S.mutable(RowColumnMeta) })),
 
   // Cell formatting referenced by indexed range.
-  formatting: S.mutable(S.Record(S.String, S.mutable(Formatting))),
+  ranges: S.mutable(S.Array(Range)),
+
+  // Threads associated with the sheet
+  threads: S.optional(S.mutable(S.Array(ref(ThreadType)))),
 }) {}
 
-// TODO(burdon): Fix defaults.
-export const createSheet = (title?: string): SheetType =>
-  create(SheetType, { title, cells: {}, rows: [], columns: [], rowMeta: {}, columnMeta: {}, formatting: {} });
+export type SheetSize = {
+  rows: number;
+  columns: number;
+};
+
+export type CreateSheetOptions = {
+  name?: string;
+  cells?: Record<string, CellValue>;
+} & Partial<SheetSize>;