@dxos/plugin-sheet 0.6.8-main.046e6cf

package/src/types.ts

@@ -0,0 +1,110 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import type {
+  GraphBuilderProvides,
+  IntentResolverProvides,
+  MetadataRecordsProvides,
+  SurfaceProvides,
+  TranslationsProvides,
+} from '@dxos/app-framework';
+import { create, S, TypedObject } from '@dxos/echo-schema';
+import { type SchemaProvides } from '@dxos/plugin-client';
+import type { StackProvides } from '@dxos/plugin-stack';
+
+import { SHEET_PLUGIN } from './meta';
+
+const SHEET_ACTION = `${SHEET_PLUGIN}/action`;
+
+export enum SheetAction {
+  CREATE = `${SHEET_ACTION}/create`,
+}
+
+export type SheetPluginProvides = SurfaceProvides &
+  IntentResolverProvides &
+  GraphBuilderProvides &
+  MetadataRecordsProvides &
+  TranslationsProvides &
+  SchemaProvides &
+  StackProvides;
+
+export type CellScalarValue = number | string | boolean | null;
+
+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)),
+});
+
+export type Formatting = S.Schema.Type<typeof Formatting>;
+
+// TODO(burdon): Visibility, locked, frozen, etc.
+export const RowColumnMeta = S.Struct({
+  size: S.optional(S.Number),
+});
+
+// TODO(burdon): Index to all updates when rows/columns are inserted/deleted.
+export class SheetType extends TypedObject({ typename: 'dxos.org/type/SheetType', version: '0.1.0' })({
+  title: S.optional(S.String),
+
+  // Sparse map of cells referenced by index.
+  cells: S.mutable(S.Record(S.String, S.mutable(CellValue))),
+
+  // Ordered row indices.
+  rows: S.mutable(S.Array(S.String)),
+
+  // Ordered column indices.
+  columns: S.mutable(S.Array(S.String)),
+
+  // Row metadata referenced by index.
+  rowMeta: S.mutable(S.Record(S.String, S.mutable(RowColumnMeta))),
+
+  // Column metadata referenced by index.
+  columnMeta: S.mutable(S.Record(S.String, S.mutable(RowColumnMeta))),
+
+  // Cell formatting referenced by indexed range.
+  formatting: S.mutable(S.Record(S.String, S.mutable(Formatting))),
+}) {}
+
+// TODO(burdon): Fix defaults.
+export const createSheet = (title?: string): SheetType =>
+  create(SheetType, { title, cells: {}, rows: [], columns: [], rowMeta: {}, columnMeta: {}, formatting: {} });