@dxos/echo 0.8.4-main.3a94e84 → 0.8.4-main.3c1ae3b

package/src/Obj.ts

@@ -2,161 +2,497 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Schema } from 'effect';
+import * as Function from 'effect/Function';
+import * as Schema from 'effect/Schema';
 
-import * as EchoSchema from '@dxos/echo-schema';
+import { type ForeignKey } from '@dxos/echo-protocol';
 import { assertArgument, invariant } from '@dxos/invariant';
-import { type DXN } from '@dxos/keys';
-import type * as LiveObject from '@dxos/live-object';
-import { live } from '@dxos/live-object';
-import { assumeType } from '@dxos/util';
-
-import type * as Ref from './Ref';
-import type * as Relation from './Relation';
-import type * as Type from './Type';
-
-// NOTE: Don't export: Obj.Any and Obj.Obj form the public API.
-interface ObjBase extends Type.OfKind<EchoSchema.EntityKind.Object> {
-  readonly id: EchoSchema.ObjectId;
-}
+import { type DXN, ObjectId } from '@dxos/keys';
+import { getSnapshot as getSnapshot$ } from '@dxos/live-object';
+import { assumeType, deepMapValues } from '@dxos/util';
+
+import * as Entity from './Entity';
+import {
+  type AnyEchoObject,
+  type AnyProperties,
+  type InternalObjectProps,
+  MetaId,
+  type ObjectJSON,
+  type ObjectMeta,
+  ObjectVersionId,
+  VersionTypeId,
+  getDescription as getDescription$,
+  getLabel as getLabel$,
+  getMeta as getMeta$,
+  getObjectDXN,
+  getSchema as getSchema$,
+  getSchemaTypename,
+  getTypeAnnotation,
+  getTypeDXN as getTypeDXN$,
+  isDeleted as isDeleted$,
+  isInstanceOf,
+  makeObject,
+  objectFromJSON,
+  objectToJSON,
+  setDescription as setDescription$,
+  setLabel as setLabel$,
+} from './internal';
+import * as Ref from './Ref';
+import * as Type from './Type';
+
+/**
+ * Base type for all ECHO objects.
+ * @private
+ */
+interface BaseObj extends AnyEchoObject, Entity.OfKind<typeof Entity.Kind.Object> {}
+
+/**
+ * Base type for all Obj objects.
+ */
+export interface Any extends BaseObj {}
+
+export const Any = Schema.Struct({}).pipe(
+  Type.Obj({
+    typename: 'dxos.org/type/Any',
+    version: '0.1.0',
+  }),
+);
 
 /**
  * Object type with specific properties.
  */
-export type Obj<Props> = ObjBase & Props;
+export type Obj<Props> = BaseObj & Props;
 
 /**
- * Base type for all ECHO objects.
+ * Object with arbitrary properties.
+ *
+ * NOTE: Due to how typescript works, this type is not assignable to a specific schema type.
+ * In that case, use `Obj.instanceOf` to check if an object is of a specific type.
  */
-export interface Any extends ObjBase {}
+export interface AnyProps extends BaseObj, AnyProperties {}
+
+const defaultMeta: ObjectMeta = {
+  keys: [],
+};
 
-type Props<T> = { id?: EchoSchema.ObjectId } & Type.Properties<T>;
+type Props<T = any> = {
+  id?: ObjectId;
+  [Meta]?: Partial<ObjectMeta>;
+} & Type.Properties<T>;
 
-export type MakeProps<S extends Type.Obj.Any> = NoInfer<Props<Schema.Schema.Type<S>>>;
+// TODO(burdon): Should we allow the caller to set the id?
+export type MakeProps<T extends Schema.Schema.AnyNoContext> = {
+  id?: ObjectId;
+  [Meta]?: Partial<ObjectMeta>;
+} & NoInfer<Props<Schema.Schema.Type<T>>>;
 
 /**
- * Creates new object.
+ * Creates a new object of the given types.
+ * @param schema - Object schema.
+ * @param props - Object properties.
+ * @param meta - Object metadata (deprecated) -- pass with Obj.Meta.
+ *
+ * Meta can be passed as a symbol in `props`.
+ *
+ * Example:
+ * ```ts
+ * const obj = Obj.make(Person, { [Obj.Meta]: { keys: [...] }, name: 'John' });
+ * ```
  */
-// TODO(dmaretskyi): Move meta into props.
-export const make = <S extends Type.Obj.Any>(
+export const make = <S extends Schema.Schema.AnyNoContext>(
   schema: S,
   props: MakeProps<S>,
-  meta?: EchoSchema.ObjectMeta,
-): LiveObject.Live<Schema.Schema.Type<S>> => {
-  assertArgument(
-    EchoSchema.getTypeAnnotation(schema)?.kind === EchoSchema.EntityKind.Object,
-    'Expected an object schema',
-  );
+  meta?: Partial<ObjectMeta>,
+): Obj<Schema.Schema.Type<S>> => {
+  assertArgument(getTypeAnnotation(schema)?.kind === Entity.Kind.Object, 'schema', 'Expected an object schema');
 
-  if (props[EchoSchema.MetaId] != null) {
-    meta = props[EchoSchema.MetaId] as any;
-    delete props[EchoSchema.MetaId];
+  // Set default fields on meta on creation.
+  if (props[MetaId] != null) {
+    meta = { ...structuredClone(defaultMeta), ...props[MetaId] };
+    delete props[MetaId];
   }
 
-  return live<Schema.Schema.Type<S>>(schema, props as any, meta);
+  // Filter undefined values.
+  const filterUndefined = Object.fromEntries(Object.entries(props).filter(([_, v]) => v !== undefined));
+
+  return makeObject<Schema.Schema.Type<S>>(schema, filterUndefined as any, {
+    ...defaultMeta,
+    ...meta,
+  });
 };
 
+/**
+ * Determine if object is an ECHO object.
+ */
 export const isObject = (obj: unknown): obj is Any => {
-  assumeType<EchoSchema.InternalObjectProps>(obj);
-  return typeof obj === 'object' && obj !== null && obj[EchoSchema.EntityKindId] === EchoSchema.EntityKind.Object;
+  assumeType<InternalObjectProps>(obj);
+  return typeof obj === 'object' && obj !== null && obj[Entity.KindId] === Entity.Kind.Object;
+};
+
+//
+// Snapshot
+//
+
+/**
+ * Returns an immutable snapshot of an object.
+ */
+export const getSnapshot: <T extends Any>(obj: Obj<T>) => T = getSnapshot$;
+
+export type CloneOptions = {
+  /**
+   * Retain the original object's ID.
+   * @default false
+   */
+  retainId?: boolean;
+};
+
+/**
+ * Clones an object or relation.
+ * This does not clone referenced objects, only the properties in the object.
+ * @returns A new object with the same schema and properties.
+ */
+export const clone = <T extends Any>(obj: T, opts?: CloneOptions): T => {
+  const { id, ...data } = obj;
+  const schema = getSchema$(obj);
+  invariant(schema != null, 'Object should have a schema');
+  const props: any = deepMapValues(data, (value, recurse) => {
+    if (Ref.isRef(value)) {
+      return value;
+    }
+    return recurse(value);
+  });
+
+  if (opts?.retainId) {
+    props.id = id;
+  }
+  const meta = getMeta(obj);
+  props[MetaId] = deepMapValues(meta, (value, recurse) => {
+    if (Ref.isRef(value)) {
+      return value;
+    }
+    return recurse(value);
+  });
+
+  return make(schema as Type.Obj.Any, props);
 };
 
+//
+// Type
+//
+
+// TODO(burdon): To discuss: prefer over ObjectId or Key.ObjectId or Type.ID?
+export const ID = ObjectId;
+export type ID = ObjectId;
+
 /**
  * Test if object or relation is an instance of a schema.
  * @example
  * ```ts
  * const john = Obj.make(Person, { name: 'John' });
- * const johnIsPerson = Obj.instanceOf(Person)(john);
- *
  * const isPerson = Obj.instanceOf(Person);
- * if(isPerson(john)) {
+ * if (isPerson(john)) {
  *   // john is Person
  * }
  * ```
  */
 export const instanceOf: {
-  <S extends Type.Relation.Any | Type.Obj.Any>(schema: S): (value: unknown) => value is Schema.Schema.Type<S>;
-  <S extends Type.Relation.Any | Type.Obj.Any>(schema: S, value: unknown): value is Schema.Schema.Type<S>;
-} = ((
-  ...args: [schema: Type.Relation.Any | Type.Obj.Any, value: unknown] | [schema: Type.Relation.Any | Type.Obj.Any]
-) => {
+  <S extends Type.Entity.Any>(schema: S): (value: unknown) => value is Schema.Schema.Type<S>;
+  <S extends Type.Entity.Any>(schema: S, value: unknown): value is Schema.Schema.Type<S>;
+} = ((...args: [schema: Type.Entity.Any, value: unknown] | [schema: Type.Entity.Any]) => {
   if (args.length === 1) {
-    return (obj: unknown) => EchoSchema.isInstanceOf(args[0], obj);
+    return (entity: unknown) => isInstanceOf(args[0], entity);
   }
 
-  return EchoSchema.isInstanceOf(args[0], args[1]);
+  return isInstanceOf(args[0], args[1]);
 }) as any;
 
-export const getSchema = EchoSchema.getSchema;
-
 // TODO(dmaretskyi): Allow returning undefined.
-export const getDXN = (obj: Any): DXN => {
-  assertArgument(!Schema.isSchema(obj), 'Object should not be a schema.');
-  const dxn = EchoSchema.getObjectDXN(obj);
+export const getDXN = (entity: Entity.Unknown): DXN => {
+  assertArgument(!Schema.isSchema(entity), 'obj', 'Object should not be a schema.');
+  const dxn = getObjectDXN(entity);
   invariant(dxn != null, 'Invalid object.');
   return dxn;
 };
 
 /**
  * @returns The DXN of the object's type.
- * @example dxn:example.com/type/Contact:1.0.0
+ * @example dxn:example.com/type/Person:1.0.0
+ */
+// TODO(burdon): Must define and return type for expando.
+export const getTypeDXN = getTypeDXN$;
+
+/**
+ * Get the schema of the object.
  */
-// TODO(burdon): Expando does not have a type.
-export const getTypeDXN = EchoSchema.getType;
+export const getSchema = getSchema$;
 
 /**
  * @returns The typename of the object's type.
- * @example `example.com/type/Contact`
+ * @example `example.com/type/Person`
  */
-export const getTypename = (obj: Any): string | undefined => {
-  const schema = getSchema(obj);
+export const getTypename = (entity: Entity.Unknown): string | undefined => {
+  const schema = getSchema$(entity);
   if (schema == null) {
     // Try to extract typename from DXN.
-    return EchoSchema.getType(obj)?.asTypeDXN()?.type;
+    return getTypeDXN$(entity)?.asTypeDXN()?.type;
   }
 
-  return EchoSchema.getSchemaTypename(schema);
+  return getSchemaTypename(schema);
 };
 
+//
+// Meta
+//
+
+export const Meta: unique symbol = MetaId as any;
+
+// TODO(burdon): Narrow type.
 // TODO(dmaretskyi): Allow returning undefined.
-export const getMeta = (obj: Any): EchoSchema.ObjectMeta => {
-  const meta = EchoSchema.getMeta(obj);
+export const getMeta = (entity: AnyProperties): ObjectMeta => {
+  const meta = getMeta$(entity);
   invariant(meta != null, 'Invalid object.');
   return meta;
 };
 
+/**
+ * @returns Foreign keys for the object from the specified source.
+ */
+export const getKeys: {
+  (entity: Entity.Unknown, source: string): ForeignKey[];
+  (source: string): (entity: Entity.Unknown) => ForeignKey[];
+} = Function.dual(2, (entity: Entity.Unknown, source?: string): ForeignKey[] => {
+  const meta = getMeta(entity);
+  invariant(meta != null, 'Invalid object.');
+  return meta.keys.filter((key) => key.source === source);
+});
+
+/**
+ * Delete all keys from the object for the specified source.
+ * @param entity
+ * @param source
+ */
+export const deleteKeys = (entity: Entity.Unknown, source: string) => {
+  const meta = getMeta(entity);
+  for (let i = 0; i < meta.keys.length; i++) {
+    if (meta.keys[i].source === source) {
+      meta.keys.splice(i, 1);
+      i--;
+    }
+  }
+};
+
+export const addTag = (entity: Entity.Unknown, tag: string) => {
+  const meta = getMeta(entity);
+  meta.tags ??= [];
+  meta.tags.push(tag);
+};
+
+export const removeTag = (entity: Entity.Unknown, tag: string) => {
+  const meta = getMeta(entity);
+  if (!meta.tags) {
+    return;
+  }
+  for (let i = 0; i < meta.tags.length; i++) {
+    if (meta.tags[i] === tag) {
+      meta.tags.splice(i, 1);
+      i--;
+    }
+  }
+};
+
 // TODO(dmaretskyi): Default to `false`.
-export const isDeleted = (obj: Any): boolean => {
-  const deleted = EchoSchema.isDeleted(obj);
+export const isDeleted = (entity: Entity.Unknown): boolean => {
+  const deleted = isDeleted$(entity);
   invariant(typeof deleted === 'boolean', 'Invalid object.');
   return deleted;
 };
 
-// TODO(burdon): Rename "label"
-export const getLabel = (obj: Any): string | undefined => {
-  const schema = getSchema(obj);
+//
+// Annotations
+//
+
+export const getLabel = (entity: Entity.Unknown): string | undefined => {
+  const schema = getSchema$(entity);
   if (schema != null) {
-    return EchoSchema.getLabel(schema, obj);
+    return getLabel$(schema, entity);
   }
 };
 
+export const setLabel = (entity: Entity.Unknown, label: string) => {
+  const schema = getSchema$(entity);
+  if (schema != null) {
+    setLabel$(schema, entity, label);
+  }
+};
+
+export const getDescription = (entity: Entity.Unknown): string | undefined => {
+  const schema = getSchema$(entity);
+  if (schema != null) {
+    return getDescription$(schema, entity);
+  }
+};
+
+export const setDescription = (entity: Entity.Unknown, description: string) => {
+  const schema = getSchema$(entity);
+  if (schema != null) {
+    setDescription$(schema, entity, description);
+  }
+};
+
+//
+// JSON
+//
+
 /**
  * JSON representation of an object.
  */
-export type JSON = EchoSchema.ObjectJSON;
+export type JSON = ObjectJSON;
 
 /**
  * Converts object to its JSON representation.
  *
  * The same algorithm is used when calling the standard `JSON.stringify(obj)` function.
  */
-export const toJSON = (obj: Any | Relation.Any): JSON => EchoSchema.objectToJSON(obj);
+export const toJSON = (entity: Entity.Unknown): JSON => objectToJSON(entity);
 
 /**
  * Creates an object from its json representation, performing schema validation.
  * References and schemas will be resolvable if the `refResolver` is provided.
  *
- * The function need to be async to support resolving the schema as well as the relation endpoints.
+ * The function must be async to support resolving the schema as well as the relation endpoints.
+ *
+ * @param options.refResolver - Resolver for references. Produces hydrated references that can be resolved.
+ * @param options.dxn - Override object DXN. Changes the result of `Obj.getDXN`.
+ */
+export const fromJSON: (json: unknown, options?: { refResolver?: Ref.Resolver; dxn?: DXN }) => Promise<Any> =
+  objectFromJSON as any;
+
+//
+// Sorting
+//
+
+const compare = (a?: string, b?: string) => {
+  if (a == null) {
+    return b == null ? 0 : 1;
+  }
+
+  if (b == null) {
+    return -1;
+  }
+
+  return a.localeCompare(b);
+};
+
+export type Comparator = (a: Entity.Unknown, b: Entity.Unknown) => number;
+
+export const sortByLabel: Comparator = (a: Entity.Unknown, b: Entity.Unknown) => compare(getLabel(a), getLabel(b));
+export const sortByTypename: Comparator = (a: Entity.Unknown, b: Entity.Unknown) =>
+  compare(getTypename(a), getTypename(b));
+export const sort = (...comparators: Comparator[]): Comparator => {
+  return (a: Entity.Unknown, b: Entity.Unknown) => {
+    for (const comparator of comparators) {
+      const result = comparator(a, b);
+      if (result !== 0) {
+        return result;
+      }
+    }
+
+    return 0;
+  };
+};
+
+//
+// Version
+//
+
+/**
+ * Unique symbol for version type identification.
+ */
+export { VersionTypeId };
+
+/**
+ * Represent object version.
+ * May be backed by Automerge.
+ * Objects with no history are not versioned.
  */
-export const fromJSON: (json: unknown, options?: { refResolver?: Ref.Resolver }) => Promise<Any> =
-  EchoSchema.objectFromJSON as any;
+export interface Version {
+  [VersionTypeId]: {};
+
+  /**
+   * Whether the object is versioned.
+   */
+  versioned: boolean;
+
+  /**
+   * Automerge heads.
+   */
+  automergeHeads?: string[];
+}
+
+const unversioned: Version = {
+  [VersionTypeId]: {},
+  versioned: false,
+};
+
+/**
+ * Checks that `obj` is a version object.
+ */
+export const isVersion = (entity: unknown): entity is Version => {
+  return entity != null && typeof entity === 'object' && VersionTypeId in entity;
+};
+
+/**
+ * Returns the version of the object.
+ */
+export const version = (entity: Entity.Unknown): Version => {
+  const version = (entity as any)[ObjectVersionId];
+  if (version === undefined) {
+    return unversioned;
+  }
+
+  return version;
+};
+
+/**
+ * Checks that `version` is a valid version object.
+ */
+export const versionValid = (version: Version): boolean => {
+  assertArgument(isVersion(version), 'version', 'Invalid version object');
+  return !!version.versioned;
+};
+
+export type VersionCompareResult = 'unversioned' | 'equal' | 'different';
+
+/**
+ * Compares two versions.
+ * @param version1
+ * @param version2
+ * @returns 'unversioned' if either object is unversioned, 'equal' if the versions are equal, 'different' if the versions are different.
+ */
+export const compareVersions = (version1: Version, version2: Version): VersionCompareResult => {
+  assertArgument(isVersion(version1), 'version1', 'Invalid version object');
+  assertArgument(isVersion(version2), 'version2', 'Invalid version object');
+
+  if (!versionValid(version1) || !versionValid(version2)) {
+    return 'unversioned';
+  }
+
+  if (version1.automergeHeads?.length !== version2.automergeHeads?.length) {
+    return 'different';
+  }
+  if (version1.automergeHeads?.some((head) => !version2.automergeHeads?.includes(head))) {
+    return 'different';
+  }
+
+  return 'equal';
+};
+
+export const encodeVersion = (version: Version): string => {
+  return JSON.stringify(version);
+};
+
+export const decodeVersion = (version: string): Version => {
+  const parsed = JSON.parse(version);
+  parsed[VersionTypeId] = {};
+  return parsed;
+};

package/src/Order.ts

@@ -0,0 +1,34 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type QueryAST } from '@dxos/echo-protocol';
+
+export interface Order<T> {
+  // TODO(dmaretskyi): See new effect-schema approach to variance.
+  '~Order': { value: T };
+
+  ast: QueryAST.Order;
+}
+
+export type Any = Order<any>;
+
+class OrderClass implements Order<any> {
+  private static variance: Order<any>['~Order'] = {} as Order<any>['~Order'];
+
+  static is(value: unknown): value is Order<any> {
+    return typeof value === 'object' && value !== null && '~Order' in value;
+  }
+
+  constructor(public readonly ast: QueryAST.Order) {}
+
+  '~Order' = OrderClass.variance;
+}
+
+export const natural: Order<any> = new OrderClass({ kind: 'natural' });
+export const property = <T>(property: keyof T & string, direction: QueryAST.OrderDirection): Order<T> =>
+  new OrderClass({
+    kind: 'property',
+    property,
+    direction,
+  });