@dxos/echo 0.8.2-main.f11618f → 0.8.2-main.fbd8ed0

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;
-  });
-});