@dxos/echo 0.8.2-main.36232bc → 0.8.2-main.5ca3450

package/src/type/Type.ts

@@ -0,0 +1,143 @@
+//
+// 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$,
+  SpaceIdSchema as SpaceIdSchema$,
+  type StoredSchema,
+  type TypeMeta,
+  getTypeAnnotation,
+  getSchema as getSchema$,
+  getSchemaDXN,
+  getSchemaTypename,
+  getSchemaVersion,
+  isInstanceOf,
+  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';
+
+// TODO(burdon): Type vs. Ref vs. Relation vs. Object.
+
+/**
+ * Type System API.
+ *
+ * @category api namespace
+ * @since 0.9.0
+ */
+export namespace Type {
+  //
+  // Keys
+  //
+
+  export const SpaceIdSchema = SpaceIdSchema$; // TODO(burdon): Reconcile with SpaceId as with ObjectId.
+  export const SpaceId = SpaceId$;
+  export type SpaceId = SpaceId$;
+
+  export const ObjectId = ObjectId$;
+  export type ObjectId = ObjectId$;
+
+  //
+  // 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;
+
+  export const create = live$;
+
+  /**
+   * 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);
+
+  //
+  // Refs
+  //
+
+  /**
+   * 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);
+
+  export const ref = Ref$.make;
+
+  //
+  // Object utils
+  //
+
+  export const getMeta = getTypeAnnotation;
+  export const getSchema = getSchema$;
+  export const instanceOf = isInstanceOf;
+
+  //
+  // Type utils
+  //
+
+  // TODO(burdon): Reconcile getDXN and getTypename.
+  export const getDXN = getSchemaDXN;
+  export const getTypename = (schema: Schema.Schema.AnyNoContext): string => {
+    const typename = getSchemaTypename(schema);
+    invariant(typename, 'Invalid object');
+    return typename;
+  };
+  export const getVersion = getSchemaVersion;
+  export const toJsonSchema = toJsonSchema$;
+}

package/src/type/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { Type } from './Type';
+export * as Relation from './Relation';

package/dist/types/src/Database.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Database.d.ts","sourceRoot":"","sources":["../../../src/Database.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC,GAAE"}

package/dist/types/src/Queue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Queue.d.ts","sourceRoot":"","sources":["../../../src/Queue.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC,GAAE"}

package/dist/types/src/Space.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Space.d.ts","sourceRoot":"","sources":["../../../src/Space.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC,GAAE"}

package/dist/types/src/Type.d.ts

@@ -1,49 +0,0 @@
-import { type Schema } from 'effect';
-import { type BaseSchema, type EchoSchema, type Expando as Expando$, type ImmutableSchema, type JsonSchemaType, type TypeMeta, EntityKind, ObjectId, Ref as Ref$, getTypeAnnotation, getSchema, getSchemaDXN, getSchemaTypename, getSchemaVersion, isInstanceOf } from '@dxos/echo-schema';
-export type { TypeMeta as Meta, JsonSchemaType as JsonSchema };
-export { EntityKind as Kind, ObjectId, getTypeAnnotation as getMeta, getSchema, getSchemaDXN as getDXN, getSchemaTypename as getTypename, getSchemaVersion as getVersion, isInstanceOf as instanceOf, };
-/**
- * Type API.
- *
- * @category api namespace
- * @since 0.9.0
- */
-export declare namespace Type {
-    /**
-     * A schema that can be extended with arbitrary properties.
-     */
-    type Expando = Expando$;
-    type Abstract<T = any> = BaseSchema<T>;
-    type ImmutableType<T> = ImmutableSchema<T>;
-    type MutableType<T> = EchoSchema<T>;
-}
-export declare const ref: <T extends import("@dxos/echo-schema").BaseObject>(obj: T) => Ref$<T>;
-export declare const create: {
-    <T extends import("@dxos/echo-schema").BaseObject>(obj: T): import("@dxos/live-object").Live<T>;
-    <T extends import("@dxos/echo-schema").BaseObject>(schema: Schema.Schema<T, any, never>, obj: NoInfer<import("@dxos/echo-schema").ExcludeId<T>>, meta?: import("@dxos/echo-schema").ObjectMeta): import("@dxos/live-object").Live<T>;
-};
-/**
- * Defines an ECHO type.
- *
- * @example
- * ```ts
- * const Organization = S.Struct({
- *   name: S.String,
- * }).pipe(Type.def({ typename: 'example.com/type/Organization', version: '1.0.0' }));
- * ```
- */
-export declare const def: (meta: TypeMeta) => <Self extends Schema.Schema.Any>(self: Self) => import("@dxos/echo-schema").EchoObjectSchema<Self>;
-/**
- * Defines a reference to an ECHO object.
- *
- * @example
- * ```ts
- * import { Type } from '@dxos/echo';
- * const Contact = S.Struct({
- *   name: S.String,
- *   organization: Type.Ref(Organization),
- * }).pipe(Type.def({ typename: 'example.com/type/Contact', version: '1.0.0' }));
- * ```
- */
-export declare const Ref: <S extends Schema.Schema.AnyNoContext>(self: S) => import("@dxos/echo-schema").Ref$<Schema.Schema.Type<S>>;
-//# sourceMappingURL=Type.d.ts.map

package/dist/types/src/Type.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Type.d.ts","sourceRoot":"","sources":["../../../src/Type.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,OAAO,EACL,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,OAAO,IAAI,QAAQ,EACxB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,QAAQ,EAEb,UAAU,EACV,QAAQ,EACR,GAAG,IAAI,IAAI,EACX,iBAAiB,EACjB,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACb,MAAM,mBAAmB,CAAC;AAW3B,YAAY,EAAE,QAAQ,IAAI,IAAI,EAAE,cAAc,IAAI,UAAU,EAAE,CAAC;AAC/D,OAAO,EACL,UAAU,IAAI,IAAI,EAClB,QAAQ,EACR,iBAAiB,IAAI,OAAO,EAC5B,SAAS,EACT,YAAY,IAAI,MAAM,EACtB,iBAAiB,IAAI,WAAW,EAChC,gBAAgB,IAAI,UAAU,EAC9B,YAAY,IAAI,UAAU,GAC3B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B;;OAEG;IACH,KAAY,OAAO,GAAG,QAAQ,CAAC;IAE/B,KAAY,QAAQ,CAAC,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC9C,KAAY,aAAa,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;IAClD,KAAY,WAAW,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;CAC5C;AAMD,eAAO,MAAM,GAAG,uEAAU,CAAC;AAC3B,eAAO,MAAM,MAAM;;;CAAU,CAAC;AAM9B;;;;;;;;;GASG;AACH,eAAO,MAAM,GAAG,SAAU,QAAQ,uGAAqB,CAAC;AAExD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,QAAQ,CAAC,4DAAsC,CAAC"}

package/dist/types/src/api.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=api.test.d.ts.map

package/dist/types/src/api.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.test.d.ts","sourceRoot":"","sources":["../../../src/api.test.ts"],"names":[],"mappings":""}

package/src/Type.ts

@@ -1,99 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type Schema } from 'effect';
-
-import {
-  type BaseSchema,
-  type EchoSchema,
-  type Expando as Expando$,
-  type ImmutableSchema,
-  type JsonSchemaType,
-  type TypeMeta,
-  EchoObject,
-  EntityKind,
-  ObjectId,
-  Ref as Ref$,
-  getTypeAnnotation,
-  getSchema,
-  getSchemaDXN,
-  getSchemaTypename,
-  getSchemaVersion,
-  isInstanceOf,
-} from '@dxos/echo-schema';
-import { live as create$, makeRef } from '@dxos/live-object';
-
-// NOTES:
-// - New Echo package and namespaces allow for incremental migration; vastly simplifies imports.
-// - Split into separate ECHO namespaces: Database, Space, Type, Query, Queue.
-//  - Example; import { Database, Type, Query, Queue } from '@dxos/echo';
-// - Use `declare namespace` for types (no code is generated). See Effect pattern, where Schema is a namespace, interface, and function.
-// - Test with @dxos/schema/testing types.
-// - Define user (Composer) types in namespace (e.g., of plugin) and drop Type suffix; remove all deprecated Braneframe types.
-
-export type { TypeMeta as Meta, JsonSchemaType as JsonSchema };
-export {
-  EntityKind as Kind,
-  ObjectId,
-  getTypeAnnotation as getMeta,
-  getSchema,
-  getSchemaDXN as getDXN,
-  getSchemaTypename as getTypename,
-  getSchemaVersion as getVersion,
-  isInstanceOf as instanceOf,
-};
-
-/**
- * Type API.
- *
- * @category api namespace
- * @since 0.9.0
- */
-export declare namespace Type {
-  /**
-   * A schema that can be extended with arbitrary properties.
-   */
-  export type Expando = Expando$;
-
-  export type Abstract<T = any> = BaseSchema<T>;
-  export type ImmutableType<T> = ImmutableSchema<T>;
-  export type MutableType<T> = EchoSchema<T>;
-}
-
-//
-// Constructors
-//
-
-export const ref = makeRef;
-export const create = create$;
-
-//
-// Combinators
-//
-
-/**
- * Defines an ECHO type.
- *
- * @example
- * ```ts
- * const Organization = S.Struct({
- *   name: S.String,
- * }).pipe(Type.def({ typename: 'example.com/type/Organization', version: '1.0.0' }));
- * ```
- */
-export const def = (meta: TypeMeta) => EchoObject(meta);
-
-/**
- * Defines a reference to an ECHO object.
- *
- * @example
- * ```ts
- * import { Type } from '@dxos/echo';
- * const Contact = S.Struct({
- *   name: S.String,
- *   organization: Type.Ref(Organization),
- * }).pipe(Type.def({ typename: 'example.com/type/Contact', version: '1.0.0' }));
- * ```
- */
-export const Ref = <S extends Schema.Schema.AnyNoContext>(self: S) => Ref$<Schema.Schema.Type<S>>(self);

package/src/api.test.ts

@@ -1,92 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Schema as S } from 'effect';
-import { describe, test } from 'vitest';
-
-import { raise } from '@dxos/debug';
-import { FormatEnum, FormatAnnotation } from '@dxos/echo-schema';
-
-// Deliberately testing top-level import as if external consumer for @dxos/echo.
-import { Type } from '.';
-
-namespace Testing {
-  export const Organization = S.Struct({
-    id: Type.ObjectId,
-    name: S.String,
-  }).pipe(
-    Type.def({
-      typename: 'example.com/type/Organization',
-      version: '0.1.0',
-    }),
-  );
-
-  export interface Organization extends S.Schema.Type<typeof Organization> {}
-
-  export const Contact = S.Struct({
-    name: S.String,
-    dob: S.optional(S.String),
-    email: S.optional(S.String.pipe(FormatAnnotation.set(FormatEnum.Email))),
-    organization: S.optional(Type.Ref(Organization)),
-  }).pipe(
-    Type.def({
-      typename: 'example.com/type/Contact',
-      version: '0.1.0',
-    }),
-  );
-
-  export interface Contact extends S.Schema.Type<typeof Contact> {}
-
-  export const Message = S.Struct({
-    // TODO(burdon): Support S.Date; Custom Timestamp (with defaults).
-    // TODO(burdon): Support defaults (update create and create).
-    timestamp: S.String.pipe(
-      S.propertySignature,
-      S.withConstructorDefault(() => new Date().toISOString()),
-    ),
-  });
-
-  // TODO(burdon): Fix (Type.def currently removes TypeLiteral that implements the `make` function)..
-  // }).pipe(
-  //   Type.def({
-  //     typename: 'example.com/type/Message',
-  //     version: '0.1.0',
-  //   }),
-  // );
-
-  export interface Message extends S.Schema.Type<typeof Message> {}
-}
-
-describe('Experimental API review', () => {
-  test('type checks', ({ expect }) => {
-    const contact = Type.create(Testing.Contact, { name: 'Test' });
-    const type: S.Schema<Testing.Contact> = Type.getSchema(contact) ?? raise(new Error('No schema found'));
-
-    expect(Type.getDXN(type)?.typename).to.eq(Testing.Contact.typename);
-    expect(Type.getTypename(type)).to.eq('example.com/type/Contact');
-    expect(Type.getVersion(type)).to.eq('0.1.0');
-    expect(Type.getMeta(type)).to.deep.eq({
-      kind: Type.Kind.Object,
-      typename: 'example.com/type/Contact',
-      version: '0.1.0',
-    });
-  });
-
-  test('instance checks', ({ expect }) => {
-    const organization = Type.create(Testing.Organization, { name: 'DXOS' });
-    const contact = Type.create(Testing.Contact, { name: 'Test', organization: Type.ref(organization) });
-
-    expect(S.is(Testing.Contact)(contact)).to.be.true;
-    expect(Testing.Contact.instanceOf(contact)).to.be.true;
-    expect(Type.instanceOf(Testing.Contact, contact)).to.be.true;
-    expect(Type.instanceOf(Testing.Organization, organization)).to.be.true;
-  });
-
-  test('default props', ({ expect }) => {
-    // TODO(burdon): Doesn't work after pipe(Type.def).
-    // Property 'make' does not exist on type 'EchoObjectSchema<Struct<{ timestamp: PropertySignature<":", string, never, ":", string, true, never>; }>>'.ts(2339)
-    const message = Type.create(Testing.Message, Testing.Message.make({}));
-    expect(message.timestamp).to.exist;
-  });
-});