@dxos/echo 0.8.4-main.5ad4a44 → 0.8.4-main.66e292d

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

@@ -1,113 +0,0 @@
-import * as Schema from 'effect/Schema';
-import { Type } from '..';
-export declare namespace Testing {
-    const _Contact: Type.obj<Schema.SchemaClass<{
-        readonly email?: string | undefined;
-        readonly name?: string | undefined;
-        readonly username?: string | undefined;
-        readonly tasks?: import("../internal").Ref<Task>[] | undefined;
-        readonly address?: {
-            readonly city?: string | undefined;
-            readonly state?: string | undefined;
-            readonly zip?: string | undefined;
-            readonly coordinates: {
-                readonly lat?: number | undefined;
-                readonly lng?: number | undefined;
-            };
-        } | undefined;
-    }, {
-        readonly email?: string | undefined;
-        readonly name?: string | undefined;
-        readonly username?: string | undefined;
-        readonly tasks?: import("@dxos/echo-protocol").EncodedReference[] | undefined;
-        readonly address?: {
-            readonly coordinates: {
-                readonly lat?: number | undefined;
-                readonly lng?: number | undefined;
-            };
-            readonly city?: string | undefined;
-            readonly state?: string | undefined;
-            readonly zip?: string | undefined;
-        } | undefined;
-    }, never>>;
-    export interface Contact extends Schema.Schema.Type<typeof _Contact> {
-    }
-    export const Contact: Schema.Schema<Contact, Schema.Schema.Encoded<typeof _Contact>, never>;
-    const _Task: Type.obj<Schema.SchemaClass<{
-        readonly title?: string | undefined;
-        readonly description?: string | undefined;
-        readonly completed?: boolean | undefined;
-        readonly assignee?: import("../internal").Ref<Contact> | undefined;
-        readonly previous?: import("../internal").Ref<Task> | undefined;
-        readonly subTasks?: import("../internal").Ref<Task>[] | undefined;
-    }, {
-        readonly title?: string | undefined;
-        readonly description?: string | undefined;
-        readonly completed?: boolean | undefined;
-        readonly assignee?: import("@dxos/echo-protocol").EncodedReference | undefined;
-        readonly previous?: import("@dxos/echo-protocol").EncodedReference | undefined;
-        readonly subTasks?: import("@dxos/echo-protocol").EncodedReference[] | undefined;
-    }, never>>;
-    export interface Task extends Schema.Schema.Type<typeof _Task> {
-    }
-    export const Task: Schema.Schema<Task, Schema.Schema.Encoded<typeof _Task>, never>;
-    export enum RecordType {
-        UNDEFINED = 0,
-        PERSONAL = 1,
-        WORK = 2
-    }
-    export const Container: Type.obj<Schema.SchemaClass<{
-        readonly records?: {
-            readonly title?: string | undefined;
-            readonly description?: string | undefined;
-            readonly type?: RecordType | undefined;
-            readonly contacts?: import("../internal").Ref<Contact>[] | undefined;
-        }[] | undefined;
-        readonly objects?: import("../internal").Ref<Type.Expando>[] | undefined;
-    }, {
-        readonly records?: {
-            readonly title?: string | undefined;
-            readonly description?: string | undefined;
-            readonly type?: RecordType | undefined;
-            readonly contacts?: import("@dxos/echo-protocol").EncodedReference[] | undefined;
-        }[] | undefined;
-        readonly objects?: import("@dxos/echo-protocol").EncodedReference[] | undefined;
-    }, never>>;
-    export const WorksFor: Type.relation<Schema.Struct<{
-        since: Schema.optional<typeof Schema.String>;
-    }>, Schema.Schema<Contact, {
-        id: string;
-        email?: string | undefined;
-        name?: string | undefined;
-        username?: string | undefined;
-        tasks?: import("@dxos/echo-protocol").EncodedReference[] | undefined;
-        address?: {
-            readonly coordinates: {
-                readonly lat?: number | undefined;
-                readonly lng?: number | undefined;
-            };
-            readonly city?: string | undefined;
-            readonly state?: string | undefined;
-            readonly zip?: string | undefined;
-        } | undefined;
-    }, never>, Schema.Schema<Contact, {
-        id: string;
-        email?: string | undefined;
-        name?: string | undefined;
-        username?: string | undefined;
-        tasks?: import("@dxos/echo-protocol").EncodedReference[] | undefined;
-        address?: {
-            readonly coordinates: {
-                readonly lat?: number | undefined;
-                readonly lng?: number | undefined;
-            };
-            readonly city?: string | undefined;
-            readonly state?: string | undefined;
-            readonly zip?: string | undefined;
-        } | undefined;
-    }, never>>;
-    export interface WorksFor extends Schema.Schema.Type<typeof WorksFor> {
-    }
-    export {};
-}
-//# sourceMappingURL=types.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/testing/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAG1B,yBAAiB,OAAO,CAAC;IACvB,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAoBb,CAAC;IACF,MAAM,WAAW,OAAQ,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC;KAAG;IACvE,MAAM,CAAC,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,QAAQ,CAAC,EAAE,KAAK,CAAY,CAAC;IAEvG,MAAM,KAAK;;;;;;;;;;;;;;cAaV,CAAC;IACF,MAAM,WAAW,IAAK,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC;KAAG;IACjE,MAAM,CAAC,MAAM,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,KAAK,CAAC,EAAE,KAAK,CAAS,CAAC;IAE3F,MAAM,MAAM,UAAU;QACpB,SAAS,IAAI;QACb,QAAQ,IAAI;QACZ,IAAI,IAAI;KACT;IAED,MAAM,CAAC,MAAM,SAAS;;;;;;;;;;;;;;;;cAoBrB,CAAC;IAEF,MAAM,CAAC,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cASpB,CAAC;IACF,MAAM,WAAW,QAAS,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC;KAAG;;CACzE"}

package/src/internal/ast/annotation-helper.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import type * as Option from 'effect/Option';
-import type * as Schema from 'effect/Schema';
-import * as SchemaAST from 'effect/SchemaAST';
-
-export interface AnnotationHelper<T> {
-  get: (schema: Schema.Schema.Any) => Option.Option<T>;
-  set: (value: T) => <S extends Schema.Schema.Any>(schema: S) => S;
-}
-
-export const createAnnotationHelper = <T>(id: symbol): AnnotationHelper<T> => {
-  return {
-    get: (schema) => SchemaAST.getAnnotation(schema.ast, id),
-    set:
-      (value) =>
-      <S extends Schema.Schema.Any>(schema: S) =>
-        schema.annotations({ [id]: value }) as S,
-  };
-};

package/src/internal/ast/annotations.ts

@@ -1,212 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import * as Function from 'effect/Function';
-import * as Option from 'effect/Option';
-import * as Schema from 'effect/Schema';
-import * as SchemaAST from 'effect/SchemaAST';
-
-import { assertArgument } from '@dxos/invariant';
-import { DXN } from '@dxos/keys';
-import { type Primitive } from '@dxos/util';
-
-import { createAnnotationHelper } from './annotation-helper';
-import { EntityKind } from './entity-kind';
-
-/**
- * If property is optional returns the nested property, otherwise returns the property.
- */
-// TODO(wittjosiah): Is there a way to do this as a generic?
-export const unwrapOptional = (property: SchemaAST.PropertySignature) => {
-  if (!property.isOptional || !SchemaAST.isUnion(property.type)) {
-    return property;
-  }
-
-  return property.type.types[0];
-};
-
-/**
- * ECHO identifier (for a stored schema).
- * Must be a `dxn:echo:` URI.
- */
-export const TypeIdentifierAnnotationId = Symbol.for('@dxos/schema/annotation/TypeIdentifier');
-
-export const getTypeIdentifierAnnotation = (schema: Schema.Schema.All) =>
-  Function.flow(
-    SchemaAST.getAnnotation<string>(TypeIdentifierAnnotationId),
-    Option.getOrElse(() => undefined),
-  )(schema.ast);
-
-/**
- * ECHO type.
- */
-export const TypeAnnotationId = Symbol.for('@dxos/schema/annotation/Type');
-
-// TODO(burdon): Create echo-schema Format types.
-// TODO(burdon): Reconcile with "short" DXN.
-export const Typename = Schema.String.pipe(Schema.pattern(/^[a-zA-Z]\w+\.[a-zA-Z]\w{1,}\/[\w/_-]+$/));
-export const SchemaVersion = Schema.String.pipe(Schema.pattern(/^\d+.\d+.\d+$/));
-
-/**
- * Payload stored under {@link TypeAnnotationId}.
- */
-// TODO(dmaretskyi): Rename getTypeAnnotation to represent commonality between objects and relations (e.g. `entity`).
-export const TypeAnnotation = Schema.Struct({
-  kind: Schema.Enums(EntityKind),
-  typename: Typename,
-  version: SchemaVersion,
-
-  /**
-   * If this is a relation, the schema of the source object.
-   * Must be present if entity kind is {@link EntityKind.Relation}.
-   */
-  sourceSchema: Schema.optional(DXN.Schema),
-
-  /**
-   * If this is a relation, the schema of the target object.
-   * Must be present if entity kind is {@link EntityKind.Relation}.
-   */
-  targetSchema: Schema.optional(DXN.Schema),
-});
-
-export interface TypeAnnotation extends Schema.Schema.Type<typeof TypeAnnotation> {}
-
-export type TypeMeta = Pick<TypeAnnotation, 'typename' | 'version'>;
-
-/**
- * @returns {@link TypeAnnotation} from a schema.
- * Schema must have been created with {@link TypedObject} or {@link TypedLink} or manually assigned an appropriate annotation.
- */
-export const getTypeAnnotation = (schema: Schema.Schema.All): TypeAnnotation | undefined => {
-  assertArgument(schema != null && schema.ast != null, 'schema', 'invalid schema');
-  return Function.flow(
-    SchemaAST.getAnnotation<TypeAnnotation>(TypeAnnotationId),
-    Option.getOrElse(() => undefined),
-  )(schema.ast);
-};
-
-/**
- * @returns {@link EntityKind} from a schema.
- */
-export const getEntityKind = (schema: Schema.Schema.All): EntityKind | undefined => getTypeAnnotation(schema)?.kind;
-
-/**
- * @deprecated Use {@link Type.getTypename} instead.
- * @returns Schema typename (without dxn: prefix or version number).
- */
-export const getSchemaTypename = (schema: Schema.Schema.All): string | undefined => getTypeAnnotation(schema)?.typename;
-
-/**
- * @deprecated Use {@link Type.getVersion} instead.
- * @returns Schema version in semver format.
- */
-export const getSchemaVersion = (schema: Schema.Schema.All): string | undefined => getTypeAnnotation(schema)?.version;
-
-/**
- * PropertyMeta (metadata for dynamic schema properties).
- * For user-defined annotations.
- */
-export const PropertyMetaAnnotationId = Symbol.for('@dxos/schema/annotation/PropertyMeta');
-
-export type PropertyMetaValue = Primitive | Record<string, Primitive> | Primitive[];
-
-export type PropertyMetaAnnotation = {
-  [name: string]: PropertyMetaValue;
-};
-
-export const PropertyMeta = (name: string, value: PropertyMetaValue) => {
-  return <A, I, R>(self: Schema.Schema<A, I, R>): Schema.Schema<A, I, R> => {
-    const existingMeta = self.ast.annotations[PropertyMetaAnnotationId] as PropertyMetaAnnotation;
-    return self.annotations({
-      [PropertyMetaAnnotationId]: {
-        ...existingMeta,
-        [name]: value,
-      },
-    });
-  };
-};
-
-export const getPropertyMetaAnnotation = <T>(prop: SchemaAST.PropertySignature, name: string) =>
-  Function.pipe(
-    SchemaAST.getAnnotation<PropertyMetaAnnotation>(PropertyMetaAnnotationId)(prop.type),
-    Option.map((meta) => meta[name] as T),
-    Option.getOrElse(() => undefined),
-  );
-
-/**
- * Schema reference.
- */
-export const ReferenceAnnotationId = Symbol.for('@dxos/schema/annotation/Reference');
-
-export type ReferenceAnnotationValue = TypeAnnotation;
-
-export const getReferenceAnnotation = (schema: Schema.Schema.AnyNoContext) =>
-  Function.pipe(
-    SchemaAST.getAnnotation<ReferenceAnnotationValue>(ReferenceAnnotationId)(schema.ast),
-    Option.getOrElse(() => undefined),
-  );
-
-/**
- * SchemaMeta.
- */
-export const SchemaMetaSymbol = Symbol.for('@dxos/schema/SchemaMeta');
-
-export type SchemaMeta = TypeMeta & { id: string };
-
-/**
- * Identifies a schema as a view.
- */
-export const ViewAnnotationId = Symbol.for('@dxos/schema/annotation/View');
-export const ViewAnnotation = createAnnotationHelper<boolean>(ViewAnnotationId);
-
-/**
- * Identifies label property or JSON path expression.
- * Either a string or an array of strings representing field accessors each matched in priority order.
- */
-export const LabelAnnotationId = Symbol.for('@dxos/schema/annotation/Label');
-export const LabelAnnotation = createAnnotationHelper<string[]>(LabelAnnotationId);
-
-/**
- * Default field to be used on referenced schema to lookup the value.
- */
-export const FieldLookupAnnotationId = Symbol.for('@dxos/schema/annotation/FieldLookup');
-
-/**
- * Generate test data.
- */
-export const GeneratorAnnotationId = Symbol.for('@dxos/schema/annotation/Generator');
-
-export type GeneratorAnnotationValue =
-  | string
-  | {
-      generator: string;
-      args?: any[];
-      probability?: number;
-    };
-
-export const GeneratorAnnotation = createAnnotationHelper<GeneratorAnnotationValue>(GeneratorAnnotationId);
-
-/**
- * @returns DXN of the schema.
- *
- * For non-stored schema returns `dxn:type:`.
- * For stored schema returns `dxn:echo:`.
- * @deprecated Use `Type.getDXN`.
- */
-export const getSchemaDXN = (schema: Schema.Schema.All): DXN | undefined => {
-  assertArgument(Schema.isSchema(schema), 'schema', 'invalid schema');
-
-  const id = getTypeIdentifierAnnotation(schema);
-  if (id) {
-    return DXN.parse(id);
-  }
-
-  // TODO(dmaretskyi): Add support for dynamic schema.
-  const objectAnnotation = getTypeAnnotation(schema);
-  if (!objectAnnotation) {
-    return undefined;
-  }
-
-  return DXN.fromTypenameAndVersion(objectAnnotation.typename, objectAnnotation.version);
-};

package/src/internal/ast/index.ts

@@ -1,8 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './annotations';
-export * from './annotation-helper';
-export * from './types';
-export * from './entity-kind';

package/src/internal/ast/types.ts

@@ -1,17 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { PropertyMeta } from './annotations';
-
-/**
- * @internal
- */
-export const FIELD_PATH_ANNOTATION = 'path';
-
-/**
- * Sets the path for the field.
- * @param path Data source path in the json path format. This is the field path in the source object.
- */
-// TODO(burdon): Field, vs. path vs. property.
-export const FieldPath = (path: string) => PropertyMeta(FIELD_PATH_ANNOTATION, path);

package/src/internal/json/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './json-schema';

package/src/internal/object/accessors.ts

@@ -1,115 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import * as Option from 'effect/Option';
-import * as Schema from 'effect/Schema';
-
-import { type JsonPath, getField } from '@dxos/effect';
-import { assertArgument, invariant } from '@dxos/invariant';
-import { DXN, ObjectId } from '@dxos/keys';
-import { assumeType } from '@dxos/util';
-
-import { LabelAnnotation } from '../ast';
-
-import { type InternalObjectProps, SchemaId, SelfDXNId } from './model';
-
-//
-// Accessors based on model.
-//
-
-/**
- * Returns a DXN for an object or schema.
- * @deprecated Use `Obj.getDXN`.
- */
-export const getObjectDXN = (object: any): DXN | undefined => {
-  invariant(!Schema.isSchema(object), 'schema not allowed in this function');
-  assertArgument(typeof object === 'object' && object != null, 'object', 'expected object');
-  assumeType<InternalObjectProps>(object);
-
-  if (object[SelfDXNId]) {
-    invariant(object[SelfDXNId] instanceof DXN, 'Invalid object model: invalid self dxn');
-    return object[SelfDXNId];
-  }
-
-  if (!ObjectId.isValid(object.id)) {
-    throw new TypeError('Object id is not valid.');
-  }
-
-  return DXN.fromLocalObjectId(object.id);
-};
-
-/**
- * Returns the schema for the given object if one is defined.
- */
-// TODO(burdon): Reconcile with `getTypename`.
-// TODO(dmaretskyi): For echo objects, this always returns the root schema.
-export const getSchema = (obj: unknown | undefined): Schema.Schema.AnyNoContext | undefined => {
-  if (obj) {
-    return (obj as any)[SchemaId];
-  }
-};
-
-/**
- * Internal use only.
- */
-export const setSchema = (obj: any, schema: Schema.Schema.AnyNoContext) => {
-  Object.defineProperty(obj, SchemaId, {
-    value: schema,
-    writable: false,
-    enumerable: false,
-    configurable: false,
-  });
-};
-
-/**
- * @deprecated Use {@link Obj.getLabel} instead.
- * Returns the label for a given object based on {@link LabelAnnotationId}.
- */
-export const getLabelForObject = (obj: unknown | undefined): string | undefined => {
-  const schema = getSchema(obj);
-  if (schema) {
-    return getLabel(schema, obj);
-  }
-};
-
-/**
- * Returns the label for a given object based on {@link LabelAnnotationId}.
- */
-// TODO(burdon): Convert to JsonPath?
-export const getLabel = <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>): string | undefined => {
-  const annotation = LabelAnnotation.get(schema).pipe(Option.getOrElse(() => ['name']));
-  for (const accessor of annotation) {
-    assertArgument(
-      typeof accessor === 'string',
-      'accessor',
-      'Label annotation must be a string or an array of strings',
-    );
-    const value = getField(object, accessor as JsonPath);
-    switch (typeof value) {
-      case 'string':
-      case 'number':
-      case 'boolean':
-      case 'bigint':
-      case 'symbol':
-        return value.toString();
-      case 'undefined':
-      case 'object':
-      case 'function':
-        continue;
-    }
-  }
-
-  return undefined;
-};
-
-/**
- * Sets the label for a given object based on {@link LabelAnnotationId}.
- */
-export const setLabel = <S extends Schema.Schema.Any>(schema: S, object: Schema.Schema.Type<S>, label: string) => {
-  const annotation = LabelAnnotation.get(schema).pipe(
-    Option.map((field) => field[0]),
-    Option.getOrElse(() => 'name'),
-  );
-  object[annotation] = label;
-};