@dxos/plugin-sheet 0.6.11 → 0.6.12-main.568932b

package/dist/lib/node-esm/chunk-2HAM45RC.mjs

@@ -0,0 +1,88 @@
+import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
+import {
+  SHEET_PLUGIN
+} from "./chunk-IU2L277A.mjs";
+
+// packages/plugins/plugin-sheet/src/types.ts
+import { ref, S, TypedObject } from "@dxos/echo-schema";
+import { ThreadType } from "@dxos/plugin-space/types";
+var SHEET_ACTION = `${SHEET_PLUGIN}/action`;
+var SheetAction;
+(function(SheetAction2) {
+  SheetAction2[SheetAction2["CREATE"] = `${SHEET_ACTION}/create`] = "CREATE";
+})(SheetAction || (SheetAction = {}));
+var 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
+});
+var ValueTypeEnum;
+(function(ValueTypeEnum2) {
+  ValueTypeEnum2[ValueTypeEnum2["Null"] = 0] = "Null";
+  ValueTypeEnum2[ValueTypeEnum2["Number"] = 1] = "Number";
+  ValueTypeEnum2[ValueTypeEnum2["Boolean"] = 2] = "Boolean";
+  ValueTypeEnum2[ValueTypeEnum2["String"] = 3] = "String";
+  ValueTypeEnum2[ValueTypeEnum2["Percent"] = 10] = "Percent";
+  ValueTypeEnum2[ValueTypeEnum2["Currency"] = 11] = "Currency";
+  ValueTypeEnum2[ValueTypeEnum2["DateTime"] = 20] = "DateTime";
+  ValueTypeEnum2[ValueTypeEnum2["Date"] = 21] = "Date";
+  ValueTypeEnum2[ValueTypeEnum2["Time"] = 22] = "Time";
+  ValueTypeEnum2[ValueTypeEnum2["URL"] = 30] = "URL";
+  ValueTypeEnum2[ValueTypeEnum2["DID"] = 31] = "DID";
+})(ValueTypeEnum || (ValueTypeEnum = {}));
+var ValueType = S.Enums(ValueTypeEnum);
+var Formatting = S.Struct({
+  type: S.optional(ValueType),
+  format: S.optional(S.String),
+  precision: S.optional(S.Number),
+  classNames: S.optional(S.Array(S.String))
+});
+var RowColumnMeta = S.Struct({
+  size: S.optional(S.Number)
+});
+var SheetType = class extends TypedObject({
+  typename: "dxos.org/type/SheetType",
+  version: "0.1.0"
+})({
+  name: S.optional(S.String),
+  // Sparse map of cells referenced by index.
+  cells: S.mutable(S.Record({
+    key: S.String,
+    value: 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({
+    key: S.String,
+    value: S.mutable(RowColumnMeta)
+  })),
+  // Column metadata referenced by index.
+  columnMeta: S.mutable(S.Record({
+    key: S.String,
+    value: S.mutable(RowColumnMeta)
+  })),
+  // Cell formatting referenced by indexed range.
+  formatting: S.mutable(S.Record({
+    key: S.String,
+    value: S.mutable(Formatting)
+  })),
+  // Threads associated with the sheet
+  threads: S.optional(S.mutable(S.Array(ref(ThreadType))))
+}) {
+};
+
+export {
+  SheetAction,
+  CellValue,
+  ValueTypeEnum,
+  ValueType,
+  Formatting,
+  RowColumnMeta,
+  SheetType
+};
+//# sourceMappingURL=chunk-2HAM45RC.mjs.map

package/dist/lib/node-esm/chunk-2HAM45RC.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/types.ts"],
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport type {\n  GraphBuilderProvides,\n  IntentResolverProvides,\n  MetadataRecordsProvides,\n  SurfaceProvides,\n  TranslationsProvides,\n} from '@dxos/app-framework';\nimport { ref, S, TypedObject } from '@dxos/echo-schema';\nimport { type SchemaProvides } from '@dxos/plugin-client';\nimport { type MarkdownExtensionProvides } from '@dxos/plugin-markdown';\nimport { type SpaceInitProvides } from '@dxos/plugin-space';\nimport { ThreadType } from '@dxos/plugin-space/types';\nimport { type StackProvides } from '@dxos/plugin-stack';\n\nimport { SHEET_PLUGIN } from './meta';\n\nconst SHEET_ACTION = `${SHEET_PLUGIN}/action`;\n\nexport enum SheetAction {\n  CREATE = `${SHEET_ACTION}/create`,\n}\n\n// TODO(Zan): Move this to the plugin-space plugin or another common location\n// when we implement comments in sheets.\n// This is currently duplicated in a few places.\ntype ThreadProvides<T> = {\n  thread: {\n    predicate: (obj: any) => obj is T;\n    createSort: (obj: T) => (anchorA: string | undefined, anchorB: string | undefined) => number;\n  };\n};\n\nexport type SheetPluginProvides = SurfaceProvides &\n  IntentResolverProvides &\n  GraphBuilderProvides &\n  MarkdownExtensionProvides &\n  MetadataRecordsProvides &\n  TranslationsProvides &\n  SchemaProvides &\n  SpaceInitProvides &\n  StackProvides &\n  ThreadProvides<SheetType>;\n\nexport type CellScalarValue = number | string | boolean | null;\n\nexport const CellValue = S.Struct({\n  // TODO(burdon): How to store dates (datetime, date, time), percentages, etc.\n  //  Consider import/export; natural access for other plugins. Special handling for currency (precision).\n  // TODO(burdon): Automerge (long string) or short string or number.\n  // TODO(burdon): Arrays?\n  value: S.Any,\n});\n\nexport type CellValue = S.Schema.Type<typeof CellValue>;\n\n/**\n * https://www.tutorialsteacher.com/typescript/typescript-number\n */\n// TODO(burdon): Format vs. value.\nexport enum ValueTypeEnum {\n  Null = 0,\n  Number = 1,\n  Boolean = 2,\n  String = 3,\n\n  // Special numbers.\n  Percent = 10,\n  Currency = 11,\n\n  // Dates.\n  DateTime = 20,\n  Date = 21,\n  Time = 22,\n\n  // Validated string types.\n  // TODO(burdon): Define effect types.\n  URL = 30,\n  DID = 31,\n}\n\nexport const ValueType = S.Enums(ValueTypeEnum);\n\nexport const Formatting = S.Struct({\n  type: S.optional(ValueType),\n  format: S.optional(S.String),\n  precision: S.optional(S.Number),\n  classNames: S.optional(S.Array(S.String)),\n});\n\nexport type Formatting = S.Schema.Type<typeof Formatting>;\n\n// TODO(burdon): Visibility, locked, frozen, etc.\nexport const RowColumnMeta = S.Struct({\n  size: S.optional(S.Number),\n});\n\n// TODO(burdon): Index to all updates when rows/columns are inserted/deleted.\n// TODO(wittjosiah): Migrate typename to remove `Type` suffix.\n// TODO(wittjosiah): Rename title to name to align with other schemas.\nexport class SheetType extends TypedObject({ typename: 'dxos.org/type/SheetType', version: '0.1.0' })({\n  name: S.optional(S.String),\n\n  // Sparse map of cells referenced by index.\n  cells: S.mutable(S.Record({ key: S.String, value: S.mutable(CellValue) })),\n\n  // Ordered row indices.\n  rows: S.mutable(S.Array(S.String)),\n\n  // Ordered column indices.\n  columns: S.mutable(S.Array(S.String)),\n\n  // Row metadata referenced by index.\n  rowMeta: S.mutable(S.Record({ key: S.String, value: S.mutable(RowColumnMeta) })),\n\n  // Column metadata referenced by index.\n  columnMeta: S.mutable(S.Record({ key: S.String, value: S.mutable(RowColumnMeta) })),\n\n  // Cell formatting referenced by indexed range.\n  formatting: S.mutable(S.Record({ key: S.String, value: S.mutable(Formatting) })),\n\n  // Threads associated with the sheet\n  threads: S.optional(S.mutable(S.Array(ref(ThreadType)))),\n}) {}\n\nexport type SheetSize = {\n  rows: number;\n  columns: number;\n};\n\nexport type CreateSheetOptions = {\n  name?: string;\n  cells?: Record<string, CellValue>;\n} & Partial<SheetSize>;\n"],
+  "mappings": ";;;;;;AAWA,SAASA,KAAKC,GAAGC,mBAAmB;AAIpC,SAASC,kBAAkB;AAK3B,IAAMC,eAAe,GAAGC,YAAAA;;UAEZC,cAAAA;wCACD,GAAGF,YAAAA,SAAqB,IAAA;GADvBE,gBAAAA,cAAAA,CAAAA,EAAAA;AA2BL,IAAMC,YAAYC,EAAEC,OAAO;;;;;EAKhCC,OAAOF,EAAEG;AACX,CAAA;;UAQYC,gBAAAA;;;;;;;;;;;;GAAAA,kBAAAA,gBAAAA,CAAAA,EAAAA;AAqBL,IAAMC,YAAYL,EAAEM,MAAMF,aAAAA;AAE1B,IAAMG,aAAaP,EAAEC,OAAO;EACjCO,MAAMR,EAAES,SAASJ,SAAAA;EACjBK,QAAQV,EAAES,SAAST,EAAEW,MAAM;EAC3BC,WAAWZ,EAAES,SAAST,EAAEa,MAAM;EAC9BC,YAAYd,EAAES,SAAST,EAAEe,MAAMf,EAAEW,MAAM,CAAA;AACzC,CAAA;AAKO,IAAMK,gBAAgBhB,EAAEC,OAAO;EACpCgB,MAAMjB,EAAES,SAAST,EAAEa,MAAM;AAC3B,CAAA;AAKO,IAAMK,YAAN,cAAwBC,YAAY;EAAEC,UAAU;EAA2BC,SAAS;AAAQ,CAAA,EAAG;EACpGC,MAAMtB,EAAES,SAAST,EAAEW,MAAM;;EAGzBY,OAAOvB,EAAEwB,QAAQxB,EAAEyB,OAAO;IAAEC,KAAK1B,EAAEW;IAAQT,OAAOF,EAAEwB,QAAQzB,SAAAA;EAAW,CAAA,CAAA;;EAGvE4B,MAAM3B,EAAEwB,QAAQxB,EAAEe,MAAMf,EAAEW,MAAM,CAAA;;EAGhCiB,SAAS5B,EAAEwB,QAAQxB,EAAEe,MAAMf,EAAEW,MAAM,CAAA;;EAGnCkB,SAAS7B,EAAEwB,QAAQxB,EAAEyB,OAAO;IAAEC,KAAK1B,EAAEW;IAAQT,OAAOF,EAAEwB,QAAQR,aAAAA;EAAe,CAAA,CAAA;;EAG7Ec,YAAY9B,EAAEwB,QAAQxB,EAAEyB,OAAO;IAAEC,KAAK1B,EAAEW;IAAQT,OAAOF,EAAEwB,QAAQR,aAAAA;EAAe,CAAA,CAAA;;EAGhFe,YAAY/B,EAAEwB,QAAQxB,EAAEyB,OAAO;IAAEC,KAAK1B,EAAEW;IAAQT,OAAOF,EAAEwB,QAAQjB,UAAAA;EAAY,CAAA,CAAA;;EAG7EyB,SAAShC,EAAES,SAAST,EAAEwB,QAAQxB,EAAEe,MAAMkB,IAAIC,UAAAA,CAAAA,CAAAA,CAAAA;AAC5C,CAAA,EAAA;AAAI;",
+  "names": ["ref", "S", "TypedObject", "ThreadType", "SHEET_ACTION", "SHEET_PLUGIN", "SheetAction", "CellValue", "S", "Struct", "value", "Any", "ValueTypeEnum", "ValueType", "Enums", "Formatting", "type", "optional", "format", "String", "precision", "Number", "classNames", "Array", "RowColumnMeta", "size", "SheetType", "TypedObject", "typename", "version", "name", "cells", "mutable", "Record", "key", "rows", "columns", "rowMeta", "columnMeta", "formatting", "threads", "ref", "ThreadType"]
+}