@dxos/echo 0.8.2-main.fbd8ed0 → 0.8.2-staging.7ac8446

package/src/type/Type.ts

@@ -1,134 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Schema } from 'effect';
-
-import { type AnyLiveObject as AnyLiveObject$ } from '@dxos/echo-db';
-import {
-  type BaseEchoObject,
-  type BaseObject,
-  type BaseSchema,
-  type EchoSchema,
-  EchoObject,
-  EntityKind,
-  Expando as Expando$,
-  type ImmutableSchema,
-  type JsonSchemaType,
-  ObjectId as ObjectId$,
-  Ref as Ref$,
-  type StoredSchema,
-  type TypeMeta,
-  getTypeAnnotation,
-  getSchema as getSchema$,
-  getSchemaDXN,
-  getSchemaTypename,
-  getSchemaVersion,
-  isInstanceOf,
-  isMutable as isMutable$,
-  toJsonSchema as toJsonSchema$,
-} from '@dxos/echo-schema';
-import { invariant } from '@dxos/invariant';
-import { SpaceId as SpaceId$ } from '@dxos/keys';
-import { live as live$ } from '@dxos/live-object';
-
-/**
- * Type System API.
- *
- * @category api namespace
- * @since 0.9.0
- */
-
-//
-// Keys
-//
-
-export const SpaceId = SpaceId$;
-export type SpaceId = SpaceId$;
-
-export const ObjectId = ObjectId$;
-export type ObjectId = ObjectId$;
-
-/**
- * Defines a reference to an ECHO object.
- *
- * @example
- * ```ts
- * import { Type } from '@dxos/echo';
- * const Person = Schema.Struct({
- *   name: Schema.String,
- *   organization: Type.Ref(Organization),
- * }).pipe(Type.def({
- *   typename: 'example.com/type/Person',
- *   version: '0.1.0',
- * }));
- * ```
- */
-export const Ref = <S extends Schema.Schema.AnyNoContext>(self: S) => Ref$<Schema.Schema.Type<S>>(self);
-
-//
-// Objects
-//
-
-export const Kind = EntityKind;
-export type AnyObject = BaseEchoObject;
-export type AnyLiveObject<T extends BaseObject> = AnyLiveObject$<T>;
-
-//
-// Schema
-//
-
-export type JsonSchema = JsonSchemaType;
-
-/**
- * A schema that can be extended with arbitrary properties.
- */
-export const Expando = Expando$;
-export type Expando = Expando$;
-
-// TODO(burdon): Review/remove.
-export type Abstract<T = any> = BaseSchema<T>;
-export type ImmutableType<T> = ImmutableSchema<T>;
-export type MutableType<T> = EchoSchema<T>;
-export type StoredType = StoredSchema;
-
-/**
- * Defines an ECHO type.
- *
- * @example
- * ```ts
- * import { Type } from '@dxos/echo';
- * const Organization = Schema.Struct({
- *   name: Schema.String,
- * }).pipe(Type.def({
- *   typename: 'example.com/type/Organization',
- *   version: '0.1.0',
- * }));
- * ```
- */
-export const def = (meta: TypeMeta) => EchoObject(meta);
-
-//
-// Object utils
-//
-
-export const create = live$;
-
-export const getSchema = getSchema$;
-export const instanceOf = isInstanceOf;
-
-//
-// Type utils
-//
-
-// TODO(burdon): Reconcile getDXN and getTypename.
-export const getDXN = getSchemaDXN;
-export const getMeta = getTypeAnnotation;
-export const getTypename = (schema: Schema.Schema.AnyNoContext): string => {
-  const typename = getSchemaTypename(schema);
-  invariant(typename, 'Invalid object');
-  return typename;
-};
-export const getVersion = getSchemaVersion;
-export const isMutable = isMutable$;
-export const toJsonSchema = toJsonSchema$;

package/src/type/api.test.ts

@@ -1,128 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Schema } from 'effect';
-import { describe, test } from 'vitest';
-
-import { raise } from '@dxos/debug';
-import { FormatEnum, FormatAnnotation } from '@dxos/echo-schema';
-
-import { Obj, Ref, Type } from '.';
-
-namespace Testing {
-  export const Organization = Schema.Struct({
-    id: Type.ObjectId,
-    name: Schema.String,
-  }).pipe(
-    Type.def({
-      typename: 'example.com/type/Organization',
-      version: '0.1.0',
-    }),
-  );
-
-  export interface Organization extends Schema.Schema.Type<typeof Organization> {}
-
-  export const Person = Schema.Struct({
-    name: Schema.String,
-    dob: Schema.optional(Schema.String),
-    email: Schema.optional(Schema.String.pipe(FormatAnnotation.set(FormatEnum.Email))),
-    organization: Schema.optional(Type.Ref(Organization)),
-  }).pipe(
-    Type.def({
-      typename: 'example.com/type/Person',
-      version: '0.1.0',
-    }),
-  );
-
-  export interface Person extends Schema.Schema.Type<typeof Person> {}
-
-  // export const WorksFor = S.Struct({
-  //   id: Type.ObjectId,
-  //   since: S.String,
-  //   jobTitle: S.String,
-  //   ...Range({ from, to }),
-  //   ...Provenance({ source: 'duckduckgo.com', confidence: 0.9 }), // keys
-  //   ...Relation.make({ source: Contact, target: Organization }),
-  // }).pipe(
-  //   Relation.def({
-  //     typename: 'example.com/relation/WorksFor',
-  //     version: '0.1.0',
-  //   }),
-  // );
-
-  // {
-  //   const contact = db.add(create(Contact, { name: 'Test' }));
-  //   const organization = db.add(create(Organization, { name: 'DXOS' }));
-  //   db.add(create(WorksFor, { source: contact, target: organization }));
-  // }
-
-  export const WorksFor = Schema.Struct({
-    // id: Type.ObjectId,
-    role: Schema.String,
-  }).pipe(
-    // Relation.def
-    Type.def({
-      typename: 'example.com/type/WorksFor',
-      version: '0.1.0',
-      // source: Person,
-      // target: Organization,
-    }),
-  );
-
-  export interface WorksFor extends Schema.Schema.Type<typeof WorksFor> {}
-
-  // TODO(burdon): Fix (Type.def currently removes TypeLiteral that implements the `make` function).
-  //  Property 'make' does not exist on type 'EchoObjectSchema<Struct<{ timestamp: PropertySignature<":", string, never, ":", string, true, never>; }>>'.ts(2339)
-  export const MessageStruct = Schema.Struct({
-    // TODO(burdon): Support S.Date; Custom Timestamp (with defaults).
-    // TODO(burdon): Support defaults (update create and create).
-    timestamp: Schema.String.pipe(
-      Schema.propertySignature,
-      Schema.withConstructorDefault(() => new Date().toISOString()),
-    ),
-  });
-
-  export const Message = MessageStruct.pipe(
-    Type.def({
-      typename: 'example.com/type/Message',
-      version: '0.1.0',
-    }),
-  );
-
-  export interface Message extends Schema.Schema.Type<typeof Message> {}
-}
-
-describe('Experimental API review', () => {
-  test('type checks', ({ expect }) => {
-    const contact = Obj.create(Testing.Person, { name: 'Test' });
-    const type: Schema.Schema<Testing.Person> = Obj.getSchema(contact) ?? raise(new Error('No schema found'));
-
-    expect(Type.getDXN(type)?.typename).to.eq(Testing.Person.typename);
-    expect(Type.getTypename(type)).to.eq('example.com/type/Person');
-    expect(Type.getVersion(type)).to.eq('0.1.0');
-    expect(Type.getMeta(type)).to.deep.eq({
-      kind: Type.Kind.Object,
-      typename: 'example.com/type/Person',
-      version: '0.1.0',
-    });
-  });
-
-  test('instance checks', ({ expect }) => {
-    const organization: Obj.Obj.Live<Testing.Organization> = Obj.create(Testing.Organization, { name: 'DXOS' });
-    const contact: Obj.Obj.Live<Testing.Person> = Obj.create(Testing.Person, {
-      name: 'Test',
-      organization: Ref.make(organization),
-    });
-
-    expect(Schema.is(Testing.Person)(contact)).to.be.true;
-    expect(Testing.Person.instanceOf(contact)).to.be.true;
-    expect(Type.instanceOf(Testing.Person, contact)).to.be.true;
-    expect(Type.instanceOf(Testing.Organization, organization)).to.be.true;
-  });
-
-  test('default props', ({ expect }) => {
-    const message = Obj.create(Testing.Message, Testing.MessageStruct.make({}));
-    expect(message.timestamp).to.exist;
-  });
-});

package/src/type/index.ts

@@ -1,8 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export * as Obj from './Obj';
-export * as Ref from './Ref';
-export * as Relation from './Relation';
-export * as Type from './Type';