@dxos/react-ui-table 0.6.11 → 0.6.12-main.568932b

package/src/schema/schema.test.ts

@@ -2,64 +2,49 @@
 // Copyright 2024 DXOS.org
 //
 
-import { expect } from 'chai';
+import { Schema as S } from '@effect/schema';
+import { describe, expect, test } from 'vitest';
 
-import { S } from '@dxos/echo-schema';
-import { describe, test } from '@dxos/test';
+import { getColumnTypes } from './schema';
 
-import { classifySchemaProperties } from './schema';
+// TODO(burdon): Realistic data.
 
-describe('schema->column-type', () => {
+describe('getColumnTypes', () => {
   test('basic', () => {
-    const simpleSchema = S.Struct({
+    const schema = S.Struct({
       field1: S.String,
       field2: S.Number,
+      field3: S.Date,
     });
 
-    const columns = classifySchemaProperties(simpleSchema);
-
+    const columns = getColumnTypes(schema);
     expect(columns).to.deep.equal([
       ['field1', 'string'],
       ['field2', 'number'],
+      ['field3', 'date'],
     ]);
   });
 
   test('optional properties', () => {
-    const simpleSchema = S.Struct({
+    const schema = S.Struct({
       field1: S.optional(S.String),
       field2: S.optional(S.Number),
     });
 
-    const columns = classifySchemaProperties(simpleSchema);
-
+    const columns = getColumnTypes(schema);
     expect(columns).to.deep.equal([
       ['field1', 'string'],
       ['field2', 'number'],
     ]);
   });
 
-  test('dates', () => {
-    const simpleSchema = S.Struct({
-      field1: S.Date,
-      field2: S.optional(S.Date),
-    });
-
-    const columns = classifySchemaProperties(simpleSchema);
-
-    expect(columns).to.deep.equal([
-      ['field1', 'date'],
-      ['field2', 'date'],
-    ]);
-  });
-
-  test('Piped validators', () => {
-    const simpleSchema = S.Struct({
-      name: S.optional(S.String.pipe(S.nonEmpty(), S.maxLength(10))),
+  test('piped validators', () => {
+    const schema = S.Struct({
+      name: S.optional(S.String.pipe(S.nonEmptyString(), S.maxLength(10))),
       age: S.Number.pipe(S.negative()),
     });
 
-    const columns = classifySchemaProperties(simpleSchema);
-
+    const columns = getColumnTypes(schema);
     expect(columns).to.deep.equal([
       ['name', 'string'],
       ['age', 'number'],
@@ -67,81 +52,24 @@ describe('schema->column-type', () => {
   });
 
   test('nested schema', () => {
-    const simpleSchema = S.Struct({
-      name: S.String,
-      nested: S.Struct({
-        age: S.Number,
-      }),
-      someUnion: S.Union(S.String, S.Number),
-    });
-
-    const columns = classifySchemaProperties(simpleSchema);
-
-    expect(columns).to.deep.equal([
-      ['name', 'string'],
-      ['nested.age', 'number'],
-      ['someUnion', 'display'],
-    ]);
-  });
-
-  test('deeply nested schema', () => {
-    const simpleSchema = S.Struct({
+    const schema = S.Struct({
       name: S.String,
-      nested: S.Struct({
+      nested1: S.Struct({
         age: S.Number,
         deeplyNested: S.Struct({
-          height: S.Number,
+          height: S.optional(S.Number),
         }),
       }),
-    });
-
-    const columns = classifySchemaProperties(simpleSchema);
-
-    expect(columns).to.deep.equal([
-      ['name', 'string'],
-      ['nested.age', 'number'],
-      ['nested.deeplyNested.height', 'number'],
-    ]);
-  });
-
-  test('even more deeply nested schema with optionals', () => {
-    const simpleSchema = S.Struct({
-      name: S.String,
-      nested: S.Struct({
-        age: S.Number,
-        deeplyNested: S.optional(
-          S.Struct({
-            height: S.optional(S.Number),
-          }),
-        ),
-      }),
-    });
-
-    const columns = classifySchemaProperties(simpleSchema);
-
-    expect(columns).to.deep.equal([
-      ['name', 'string'],
-      ['nested.age', 'number'],
-      ['nested.deeplyNested.height', 'number'],
-    ]);
-  });
-
-  test('multiple-nested schemata as sibblings', () => {
-    const simpleSchema = S.Struct({
-      name: S.String,
-      nested: S.Struct({
-        age: S.Number,
-      }),
       nested2: S.Struct({
         height: S.Number,
       }),
     });
 
-    const columns = classifySchemaProperties(simpleSchema);
-
+    const columns = getColumnTypes(schema);
     expect(columns).to.deep.equal([
       ['name', 'string'],
-      ['nested.age', 'number'],
+      ['nested1.age', 'number'],
+      ['nested1.deeplyNested.height', 'number'],
       ['nested2.height', 'number'],
     ]);
   });

package/src/schema/schema.ts

@@ -2,30 +2,27 @@
 // Copyright 2024 DXOS.org
 //
 
-import * as AST from '@effect/schema/AST';
-import type * as S from '@effect/schema/Schema';
+import { AST, type S } from '@dxos/effect';
 
 import { type ColumnType } from './types';
 
-// TODO(burdon): Reconcile with react-ui-table.
-export type ClassifiedColumnType = ColumnType | 'display';
-
-// TODO(burdon): Rename getX? and return typed array?
-export const classifySchemaProperties = (schema: S.Schema<any, any>): [string, ClassifiedColumnType][] => {
-  const recurse = (node: AST.AST, path: string[], acc: [string, ClassifiedColumnType][]) => {
-    const properties = AST.getPropertySignatures(node);
-    properties.forEach((prop) => {
+// TODO(burdon): Factor out to @dxos/effect?
+// TODO(burdon): Return struct (with prop metadata).
+export const getColumnTypes = (schema: S.Schema<any, any>): [string, ColumnType][] => {
+  const visitNode = (node: AST.AST, path: string[] = [], acc: [string, ColumnType][] = []) => {
+    const props = AST.getPropertySignatures(node);
+    props.forEach((prop) => {
       const propName = prop.name.toString();
 
       if (prop.isOptional) {
         const unwrappedAst = unwrapOptionProperty(prop);
         if (isStruct(unwrappedAst)) {
-          return recurse(unwrappedAst, [...path, propName], acc);
+          return visitNode(unwrappedAst, [...path, propName], acc);
         }
       }
 
       if (isStruct(prop.type)) {
-        recurse(prop.type, [...path, propName], acc);
+        visitNode(prop.type, [...path, propName], acc);
       } else {
         acc.push([path.concat(propName).join('.'), propertyToColumn(prop)]);
       }
@@ -34,27 +31,31 @@ export const classifySchemaProperties = (schema: S.Schema<any, any>): [string, C
     return acc;
   };
 
-  return recurse(schema.ast, [], []);
+  return visitNode(schema.ast);
 };
 
+// TODO(burdon): Document AST?
 const isStruct = (node: AST.AST) => AST.isTypeLiteral(node);
 
-const isOptionalUnion = (prop: AST.PropertySignature) => AST.isUnion(prop.type) && prop.isOptional;
-
-const unwrapOptionProperty = (prop: AST.PropertySignature) => {
-  if (!isOptionalUnion(prop)) {
-    throw new Error(`Not an optional property: ${String(prop.name)}`);
+const propertyToColumn = (prop: AST.PropertySignature): ColumnType => {
+  let type = prop.type;
+  if (prop.isOptional) {
+    type = unwrapOptionProperty(prop);
   }
 
+  return typeToColumn(type);
+};
+
+const unwrapOptionProperty = (prop: AST.PropertySignature) => {
   if (!AST.isUnion(prop.type)) {
     throw new Error(`Not a union type: ${String(prop.name)}`);
   }
 
-  const [type, _undefinedCase] = prop.type.types;
+  const [type] = prop.type.types;
   return type;
 };
 
-const typeToColumn = (type: AST.AST): ClassifiedColumnType => {
+const typeToColumn = (type: AST.AST): ColumnType => {
   if (AST.isStringKeyword(type)) {
     return 'string';
   } else if (AST.isNumberKeyword(type)) {
@@ -80,14 +81,6 @@ const typeToColumn = (type: AST.AST): ClassifiedColumnType => {
     }
   }
 
-  return 'display';
-};
-
-const propertyToColumn = (prop: AST.PropertySignature): ClassifiedColumnType => {
-  let type = prop.type;
-  if (prop.isOptional) {
-    type = unwrapOptionProperty(prop);
-  }
-
-  return typeToColumn(type);
+  // TODO(burdon): Better fallback?
+  return 'json';
 };

package/src/schema/types.ts

@@ -4,12 +4,14 @@
 
 export type TableDef = {
   id: string;
-  name?: string; // TODO(burdon): Required?
+  name?: string;
   columns: ColumnProps[];
 };
 
-export type ColumnType = 'number' | 'boolean' | 'date' | 'string' | 'ref';
+// TODO(burdon): Use Effect defs?
+export type ColumnType = 'number' | 'boolean' | 'date' | 'string' | 'json' | 'ref';
 
+// TODO(burdon): Effect schema?
 export type ColumnProps = {
   id: string;
   prop: string;

package/dist/types/src/components/ColumnMenu/ColumnSettingsForm.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-import { type TableDef, type ColumnProps } from '../../schema';
-export type ColumnSettingsFormProps = {
-    column: ColumnProps;
-    tableDef: TableDef;
-    tablesToReference: TableDef[];
-    onUpdate?: ((id: string, column: ColumnProps) => void) | undefined;
-    onDelete?: ((id: string) => void) | undefined;
-    onClose?: () => void;
-};
-export declare const ColumnSettingsForm: ({ column, tableDef, tablesToReference, onUpdate, onDelete, onClose, }: ColumnSettingsFormProps) => React.JSX.Element;
-//# sourceMappingURL=ColumnSettingsForm.d.ts.map

package/dist/types/src/components/ColumnMenu/ColumnSettingsForm.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ColumnSettingsForm.d.ts","sourceRoot":"","sources":["../../../../../src/components/ColumnMenu/ColumnSettingsForm.tsx"],"names":[],"mappings":"AAGA,OAAO,KAA2B,MAAM,OAAO,CAAC;AAKhD,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAmB,MAAM,cAAc,CAAC;AAGhF,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,WAAW,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,iBAAiB,EAAE,QAAQ,EAAE,CAAC;IAC9B,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IACnE,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC9C,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,kBAAkB,0EAO5B,uBAAuB,sBAkLzB,CAAC"}

package/dist/types/src/components/ColumnMenu/ColumnSettingsForm.stories.d.ts

@@ -1,63 +0,0 @@
-import '@dxos-theme';
-import React from 'react';
-import { type ColumnSettingsFormProps } from './ColumnSettingsForm';
-import { type TableDef } from '../../schema';
-declare const _default: {
-    title: string;
-    component: ({ column, tableDef, tablesToReference, onUpdate, onDelete, onClose, }: ColumnSettingsFormProps) => React.JSX.Element;
-    decorators: import("@storybook/react/*").Decorator[];
-};
-export default _default;
-export declare const Default: {
-    args: ColumnSettingsFormProps;
-};
-export declare const NumberColumn: {
-    args: {
-        column: {
-            id: string;
-            prop: string;
-            type: string;
-            label: string;
-            digits: number;
-        };
-        tableDef: TableDef;
-        tablesToReference: TableDef[];
-        onUpdate?: ((id: string, column: import("../../schema").ColumnProps) => void) | undefined;
-        onDelete?: ((id: string) => void) | undefined;
-        onClose?: () => void;
-    };
-};
-export declare const ReferenceColumn: {
-    args: {
-        column: {
-            id: string;
-            prop: string;
-            type: string;
-            label: string;
-            refTable: string;
-            refProp: string;
-        };
-        tableDef: TableDef;
-        tablesToReference: TableDef[];
-        onUpdate?: ((id: string, column: import("../../schema").ColumnProps) => void) | undefined;
-        onDelete?: ((id: string) => void) | undefined;
-        onClose?: () => void;
-    };
-};
-export declare const NewColumn: {
-    args: {
-        column: {
-            id: string;
-            prop: string;
-            type: string;
-            label: string;
-        };
-        tableDef: TableDef;
-        tablesToReference: TableDef[];
-        onUpdate?: ((id: string, column: import("../../schema").ColumnProps) => void) | undefined;
-        onDelete?: ((id: string) => void) | undefined;
-        onClose?: () => void;
-    };
-};
-export declare const Interactive: (args: ColumnSettingsFormProps) => React.JSX.Element;
-//# sourceMappingURL=ColumnSettingsForm.stories.d.ts.map

package/dist/types/src/components/ColumnMenu/ColumnSettingsForm.stories.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ColumnSettingsForm.stories.d.ts","sourceRoot":"","sources":["../../../../../src/components/ColumnMenu/ColumnSettingsForm.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AACrB,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,OAAO,EAAsB,KAAK,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AACxF,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAC;;;;;;AAE7C,wBAIE;AAqCF,eAAO,MAAM,OAAO;;CAEnB,CAAC;AAEF,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;CAWxB,CAAC;AAEF,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;CAY3B,CAAC;AAEF,eAAO,MAAM,SAAS;;;;;;;;;;;;;;CAUrB,CAAC;AAQF,eAAO,MAAM,WAAW,SANA,uBAAuB,sBAMH,CAAC"}

package/dist/types/src/schema/SchemaToTable.stories.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SchemaToTable.stories.d.ts","sourceRoot":"","sources":["../../../../src/schema/SchemaToTable.stories.tsx"],"names":[],"mappings":"AAIA,OAAO,aAAa,CAAC;AAIrB,OAAO,KAAK,MAAM,OAAO,CAAC;;;;;;AAS1B,wBAWE;AAuBF,eAAO,MAAM,WAAW;;CAmBvB,CAAC"}

package/dist/types/src/schema/schemaToColumns.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaToColumns.d.ts","sourceRoot":"","sources":["../../../../src/schema/schemaToColumns.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAEvD,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,mBAAmB,CAAC;AAK3C,eAAO,MAAM,kBAAkB,GAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,KAAG,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,EAoCjF,CAAC"}