@dxos/echo 0.8.4-staging.ac66bdf99f → 0.9.0

package/src/Extension.test.ts

@@ -1,235 +0,0 @@
-//
-// Copyright 2026 DXOS.org
-//
-
-import * as Option from 'effect/Option';
-import * as Schema from 'effect/Schema';
-import { describe, test } from 'vitest';
-
-import * as Extension from './Extension';
-
-describe('Extension', () => {
-  describe('make', () => {
-    test('creates an extension with a string schema', ({ expect }) => {
-      const ColorExtension = Extension.make('color', Schema.String);
-
-      expect(ColorExtension.key).toBe('color');
-      expect(ColorExtension.valueSchema).toBe(Schema.String);
-      expect(ColorExtension[Extension.TypeId]).toBeDefined();
-    });
-
-    test('creates an extension with a number schema', ({ expect }) => {
-      const PriorityExtension = Extension.make('priority', Schema.Number);
-
-      expect(PriorityExtension.key).toBe('priority');
-      expect(PriorityExtension.valueSchema).toBe(Schema.Number);
-    });
-
-    test('creates an extension with a complex schema', ({ expect }) => {
-      const MetadataSchema = Schema.Struct({
-        author: Schema.String,
-        version: Schema.Number,
-        tags: Schema.Array(Schema.String),
-      });
-      const MetadataExtension = Extension.make('metadata', MetadataSchema);
-
-      expect(MetadataExtension.key).toBe('metadata');
-      expect(MetadataExtension.valueSchema).toBe(MetadataSchema);
-    });
-  });
-
-  describe('get and set', () => {
-    test('set and get a string value', ({ expect }) => {
-      const ColorExtension = Extension.make('color', Schema.String);
-      const values: Extension.Values = {};
-
-      Extension.set(values, ColorExtension, 'red');
-      const result = Extension.get(values, ColorExtension);
-
-      expect(Option.isSome(result)).toBe(true);
-      expect(Option.getOrThrow(result)).toBe('red');
-    });
-
-    test('set and get a number value', ({ expect }) => {
-      const PriorityExtension = Extension.make('priority', Schema.Number);
-      const values: Extension.Values = {};
-
-      Extension.set(values, PriorityExtension, 42);
-      const result = Extension.get(values, PriorityExtension);
-
-      expect(Option.isSome(result)).toBe(true);
-      expect(Option.getOrThrow(result)).toBe(42);
-    });
-
-    test('set and get a boolean value', ({ expect }) => {
-      const EnabledExtension = Extension.make('enabled', Schema.Boolean);
-      const values: Extension.Values = {};
-
-      Extension.set(values, EnabledExtension, true);
-      const result = Extension.get(values, EnabledExtension);
-
-      expect(Option.isSome(result)).toBe(true);
-      expect(Option.getOrThrow(result)).toBe(true);
-    });
-
-    test('set and get a complex object value', ({ expect }) => {
-      const ConfigSchema = Schema.Struct({
-        theme: Schema.String,
-        fontSize: Schema.Number,
-        darkMode: Schema.Boolean,
-      });
-      const ConfigExtension = Extension.make('config', ConfigSchema);
-      const values: Extension.Values = {};
-
-      const config = { theme: 'modern', fontSize: 14, darkMode: true };
-      Extension.set(values, ConfigExtension, config);
-      const result = Extension.get(values, ConfigExtension);
-
-      expect(Option.isSome(result)).toBe(true);
-      expect(Option.getOrThrow(result)).toEqual(config);
-    });
-
-    test('set and get an array value', ({ expect }) => {
-      const TagsExtension = Extension.make('tags', Schema.Array(Schema.String));
-      const values: Extension.Values = {};
-
-      const tags = ['important', 'urgent', 'review'];
-      Extension.set(values, TagsExtension, tags);
-      const result = Extension.get(values, TagsExtension);
-
-      expect(Option.isSome(result)).toBe(true);
-      expect(Option.getOrThrow(result)).toEqual(tags);
-    });
-
-    test('get returns None for missing extension', ({ expect }) => {
-      const ColorExtension = Extension.make('color', Schema.String);
-      const values: Extension.Values = {};
-
-      const result = Extension.get(values, ColorExtension);
-
-      expect(Option.isNone(result)).toBe(true);
-    });
-
-    test('overwriting an extension value', ({ expect }) => {
-      const ColorExtension = Extension.make('color', Schema.String);
-      const values: Extension.Values = {};
-
-      Extension.set(values, ColorExtension, 'red');
-      Extension.set(values, ColorExtension, 'blue');
-      const result = Extension.get(values, ColorExtension);
-
-      expect(Option.isSome(result)).toBe(true);
-      expect(Option.getOrThrow(result)).toBe('blue');
-    });
-
-    test('multiple extensions on the same values object', ({ expect }) => {
-      const ColorExtension = Extension.make('color', Schema.String);
-      const PriorityExtension = Extension.make('priority', Schema.Number);
-      const EnabledExtension = Extension.make('enabled', Schema.Boolean);
-      const values: Extension.Values = {};
-
-      Extension.set(values, ColorExtension, 'green');
-      Extension.set(values, PriorityExtension, 5);
-      Extension.set(values, EnabledExtension, false);
-
-      expect(Option.getOrThrow(Extension.get(values, ColorExtension))).toBe('green');
-      expect(Option.getOrThrow(Extension.get(values, PriorityExtension))).toBe(5);
-      expect(Option.getOrThrow(Extension.get(values, EnabledExtension))).toBe(false);
-    });
-  });
-
-  describe('curried forms', () => {
-    test('get curried form', ({ expect }) => {
-      const ColorExtension = Extension.make('color', Schema.String);
-      const values: Extension.Values = {};
-      Extension.set(values, ColorExtension, 'purple');
-
-      const getColor = Extension.get(ColorExtension);
-      const result = getColor(values);
-
-      expect(Option.isSome(result)).toBe(true);
-      expect(Option.getOrThrow(result)).toBe('purple');
-    });
-
-    test('set curried form', ({ expect }) => {
-      const ColorExtension = Extension.make('color', Schema.String);
-      const values: Extension.Values = {};
-
-      const setOrange = Extension.set(ColorExtension, 'orange');
-      setOrange(values);
-      const result = Extension.get(values, ColorExtension);
-
-      expect(Option.isSome(result)).toBe(true);
-      expect(Option.getOrThrow(result)).toBe('orange');
-    });
-
-    test('curried forms work in pipelines', ({ expect }) => {
-      const ColorExtension = Extension.make('color', Schema.String);
-      const values: Extension.Values = {};
-
-      Extension.set(ColorExtension, 'cyan')(values);
-      const result = Extension.get(ColorExtension)(values);
-
-      expect(Option.isSome(result)).toBe(true);
-      expect(Option.getOrThrow(result)).toBe('cyan');
-    });
-  });
-
-  describe('Key', () => {
-    test('Key.make creates a branded key', ({ expect }) => {
-      const key = Extension.Key.make('my-extension');
-
-      expect(key).toBe('my-extension');
-      expect(typeof key).toBe('string');
-    });
-  });
-
-  describe('Values schema', () => {
-    test('Values can be used as a schema', ({ expect }) => {
-      const PersonWithExtensions = Schema.Struct({
-        name: Schema.String,
-        extensions: Extension.Values,
-      });
-
-      const person = Schema.decodeUnknownSync(PersonWithExtensions)({
-        name: 'Alice',
-        extensions: {},
-      });
-
-      expect(person.name).toBe('Alice');
-      expect(person.extensions).toEqual({});
-    });
-
-    test('Values schema accepts extension data', ({ expect }) => {
-      const ColorExtension = Extension.make('color', Schema.String);
-      const values: Extension.Values = {};
-      Extension.set(values, ColorExtension, 'red');
-
-      const PersonWithExtensions = Schema.Struct({
-        name: Schema.String,
-        extensions: Extension.Values,
-      });
-
-      const person = Schema.decodeUnknownSync(PersonWithExtensions)({
-        name: 'Bob',
-        extensions: values,
-      });
-
-      expect(person.name).toBe('Bob');
-      const color = Extension.get(person.extensions, ColorExtension);
-      expect(Option.getOrThrow(color)).toBe('red');
-    });
-  });
-
-  describe('TypeId', () => {
-    test('TypeId is a unique symbol-like string', ({ expect }) => {
-      expect(Extension.TypeId).toBe('~@dxos/echo/Extension');
-    });
-
-    test('extensions have TypeId property', ({ expect }) => {
-      const ColorExtension = Extension.make('color', Schema.String);
-
-      expect(Extension.TypeId in ColorExtension).toBe(true);
-    });
-  });
-});

package/src/Extension.ts

@@ -1,122 +0,0 @@
-// @import-as-namespace
-//
-// Copyright 2026 DXOS.org
-//
-
-import * as Function from 'effect/Function';
-import * as Option from 'effect/Option';
-import * as Schema from 'effect/Schema';
-import type * as Types from 'effect/Types';
-
-// @import-as-namespace
-
-/**
- * Extensions allow objects to contain typed properties that are not part of the schema.
- */
-
-export const TypeId = '~@dxos/echo/Extension' as const;
-export type TypeId = typeof TypeId;
-
-export interface Extension<T> extends Record<
-  TypeId,
-  {
-    _Type: T;
-  }
-> {
-  readonly [TypeId]: {
-    _Type: T;
-  };
-
-  readonly key: Key;
-  readonly valueSchema: Schema.Schema<T>;
-}
-
-/**
- * Create a new typed extension.
- *
- * ```ts
- * const ColorExtension = Extension.make('color', Schema.String);
- *
- * const obj = Obj.make(Person, {
- *   [Obj.Meta]: { keys: [{ source: 'external', id: '123' }] },
- *   name: 'John',
- *   email: 'john@example.com',
- * });
- *
- * Obj.change(obj, (obj) => {
- *   Extension.set(obj.extensions, ColorExtension, 'red');
- * });
- *
- * console.log(Extension.get(obj.extensions, ColorExtension)); // 'red'
- * ```
- */
-export const make = <S extends Schema.Schema.AnyNoContext>(
-  key: string,
-  valueSchema: S,
-): Extension<Schema.Schema.Type<S>> => {
-  return {
-    [TypeId]: {} as any,
-    key: Key.make(key),
-    valueSchema,
-  };
-};
-
-/**
- * Unique identifier for an extension.
- */
-// TODO(dmaretskyi): filter to be fully qualified: (e.g., org.dxos.extension.color)
-export const Key = Schema.String.pipe(Schema.brand('~@dxos/echo/ExtensionKey'));
-export type Key = Schema.Schema.Type<typeof Key>;
-
-/**
- * Set of extension values.
- *
- * Can be used inside an object/relation schema:
- *
- * ```ts
- * const Person = Schema.Struct({
- *   name: Schema.String,
- *   extensions: Extension.Values,
- * });
- * ```
- */
-export const Values = Schema.Record({ key: Key, value: Schema.Unknown });
-export interface Values extends Schema.Schema.Type<typeof Values> {}
-
-/**
- * Get the value of an extension from a set of values.
- */
-export const get: {
-  <T>(extension: Extension<T>): (values: Values) => Option.Option<T>;
-  <T>(values: Values, extension: Extension<T>): Option.Option<T>;
-} = Function.dual<
-  <T>(extension: Extension<T>) => (values: Values) => Option.Option<T>,
-  <T>(values: Values, extension: Extension<T>) => Option.Option<T>
->(2, (values, extension) => {
-  if (!(extension.key in values)) {
-    return Option.none();
-  }
-
-  return Function.pipe(values[extension.key], Schema.decodeUnknownSync(extension.valueSchema), Option.some);
-});
-
-/**
- * Set the value of an extension in a set of values.
- *
- * Can also be used within Obj.change callback:
- *
- * ```ts
- * Obj.change(obj, (obj) => {
- *   Extension.set(obj.extensions, ColorExtension, 'red');
- * });
- * ```
- */
-export const set: {
-  <T>(extension: Extension<T>, value: T): (values: Values) => void;
-  <T>(values: Types.Mutable<Values>, extension: Extension<T>, value: T): void;
-} = Function.dual<
-  <T>(extension: Extension<T>, value: T) => (values: Values) => void,
-  <T>(values: Types.Mutable<Values>, extension: Extension<T>, value: T) => void
->(3, (values, extension, value) => {
-  values[extension.key] = Schema.encodeSync(extension.valueSchema)(value);
-});

package/src/SchemaRegistry.ts

@@ -1,106 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import type * as Types from 'effect/Types';
-
-import type * as JsonSchema from './JsonSchema';
-import type * as Key from './Key';
-import type * as QueryResult from './QueryResult';
-import type * as Type from './Type';
-
-// TODO(wittjosiah): Replace w/ Query.Query.
-export type Query = {
-  /**
-   * Filter by schema ID.
-   * Schema id is a DXN with `echo` or `type` kind.
-   */
-  id?: string | string[];
-
-  /**
-   * Id of the backing ECHO object.
-   */
-  backingObjectId?: Key.ObjectId | Key.ObjectId[];
-
-  /**
-   * One or more typenames to filter by.
-   */
-  typename?: string | string[];
-
-  /**
-   * [Semver Range](https://docs.npmjs.com/cli/v6/using-npm/semver#ranges) for the schema version.
-   */
-  version?: string;
-
-  /**
-   * Where to look for the schema.
-   *
-   * Database schema are stored in the database of the current space.
-   * Runtime schema are registered in the runtime.
-   *
-   * @default ['database']
-   */
-  location?: ('database' | 'runtime')[];
-
-  /**
-   * Include system schemas.
-   * @default false
-   *
-   * The system schema include but are not limited to:
-   *  - org.dxos.type.schema
-   */
-  includeSystem?: boolean;
-};
-
-/**
- * Input for schema registration.
- * The typename, version and schema mutability metadata is read from the schema annotations.
- *
- * Accepts:
- * - Branded ECHO schemas created with Type.Obj() or Type.Relation()
- * - JSON schema with typename and version
- */
-export type RegisterSchemaInput =
-  | Type.AnyEntity
-  | {
-      typename: string;
-      version: string;
-      jsonSchema: JsonSchema.JsonSchema;
-      /**
-       * Display name of the schema.
-       */
-      name?: string;
-    };
-
-export type ExtractQueryResult<Query> = Query extends { location: ('database' | 'runtime')[] }
-  ? Type.AnyEntity
-  : Type.RuntimeType;
-
-// TODO(dmaretskyi): Rename TypeRegistry
-export interface SchemaRegistry {
-  /**
-   * Checks if the provided schema is registered.
-   */
-  // TODO(burdon): Type?
-  hasSchema(schema: Type.AnyEntity): boolean;
-
-  /**
-   * Registers the provided schema.
-   *
-   * @returns Mutable runtime instances of schemas that were registered.
-   *
-   * The behavior of this method depends on the state of the database.
-   * The general principle is that the schema will be upserted into the space.
-   * If an equivalent schema with the same name and version already exists, the method does nothing.
-   * If a different schema with the same name and version exists, the method throws an error.
-   * If no schema with the same name and version exists, a new schema will be inserted based on semantic versioning rules.
-   */
-  register(input: RegisterSchemaInput[]): Promise<Type.RuntimeType[]>;
-
-  /**
-   *
-   */
-  query<Q extends Types.NoExcessProperties<Query, Q>>(
-    query?: Q & Query,
-  ): QueryResult.QueryResult<ExtractQueryResult<Q>>;
-}

package/src/internal/Obj/ids.ts

@@ -1,12 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { DXN, ObjectId, QueueSubspaceTags, SpaceId } from '@dxos/keys';
-
-/**
- * @deprecated Use `db.queues.create()`
- */
-// TODO(burdon): Move to @dxos/keys.
-export const createQueueDXN = (spaceId = SpaceId.random(), queueId = ObjectId.random()) =>
-  new DXN(DXN.kind.QUEUE, [QueueSubspaceTags.DATA, spaceId, queueId]);