@dxos/echo 0.8.4-main.ef1bc66f44 → 0.8.4-main.effb148878

package/dist/types/src/internal/common/types/entity.d.ts

@@ -0,0 +1,94 @@
+import * as Schema from 'effect/Schema';
+/**
+ * String key used to identify the kind of an entity instance (object or relation).
+ */
+export declare const KindId: '~@dxos/echo/Kind';
+export type KindId = typeof KindId;
+/**
+ * String key used to identify the kind of a schema (object schema or relation schema).
+ * Parallels KindId which identifies instance kinds.
+ */
+export declare const SchemaKindId: '~@dxos/echo/SchemaKind';
+export type SchemaKindId = typeof SchemaKindId;
+/**
+ * String key used to brand snapshot types.
+ * Snapshots have SnapshotKindId instead of KindId, making them
+ * distinguishable from reactive objects at the type level.
+ */
+export declare const SnapshotKindId: '~@dxos/echo/SnapshotKind';
+export type SnapshotKindId = typeof SnapshotKindId;
+/**
+ * Hidden slot on a static `Type.Type` entity that holds the source Effect
+ * Schema. `Type.getSchema(...)` reads this for static types; persisted types
+ * rebuild from `jsonSchema` instead. Stored as a string key for declaration
+ * portability (see KindId comment above).
+ */
+export declare const StaticTypeSchemaSlot: '~@dxos/echo/Type.StaticSchema';
+export type StaticTypeSchemaSlot = typeof StaticTypeSchemaSlot;
+/**
+ * Read the hidden `StaticTypeSchemaSlot` off any value that may carry one.
+ * Returns `undefined` for raw schemas (no slot) and non-object inputs.
+ * Single point-of-cast for the slot lookup.
+ */
+export declare const getStaticTypeSchema: (value: unknown) => Schema.Schema.AnyNoContext | undefined;
+/**
+ * Read the `[SchemaKindId]` brand off a value. Returns `undefined` for raw
+ * schemas (which don't carry the brand on their static type) and non-object
+ * inputs. Single point-of-cast for the brand lookup.
+ */
+export declare const getSchemaKind: (value: unknown) => EntityKind | undefined;
+/**
+ * Read the `[KindId]` brand off a value. Returns `undefined` for raw schemas
+ * and non-object inputs. Companion to {@link getSchemaKind}.
+ */
+export declare const getEntityKindBrand: (value: unknown) => EntityKind | undefined;
+/**
+ * Phantom string key on `Type<A>` entities that carries the instance type `A`.
+ * Lets internal helpers (`makeObject`, `createObject`, etc.) pattern-match the
+ * instance type from an entity input without importing from the top-level
+ * `Type` module. Mirrors `Type.InstancePhantomId` (declared in `Type.ts`).
+ *
+ * Stored as a string key so declarations remain portable across packages
+ * (see KindId comment above).
+ */
+export declare const InstancePhantomId: '~@dxos/echo/Type.Instance';
+export type InstancePhantomId = typeof InstancePhantomId;
+/**
+ * Nominal brand carried by the well-known "any object" / "any relation"
+ * schemas (`Obj.Unknown`, `Relation.Unknown`). The brand lets `Ref.Ref`,
+ * `Filter.type`, and `Query.type` accept these schemas in addition to
+ * `Type.Type` entities, without opening the door to arbitrary raw schemas.
+ *
+ * Stored as a string key so declarations remain portable across packages
+ * (see KindId comment above).
+ */
+export declare const UnknownTypeSchemaBrandId: '~@dxos/echo/UnknownTypeSchemaBrand';
+export type UnknownTypeSchemaBrandId = typeof UnknownTypeSchemaBrandId;
+/**
+ * Schema-side companion to `Type.Type` entities for the "any object" /
+ * "any relation" cases. Branded so `Ref.Ref` / `Filter.type` / `Query.type`
+ * can pattern-match on it; arbitrary `Schema.Schema` values do not satisfy
+ * this shape.
+ */
+export interface UnknownTypeSchema<A, K extends EntityKind> extends Schema.Schema<A, any, never> {
+    readonly [UnknownTypeSchemaBrandId]: K;
+}
+/**
+ * Kinds of entities stored in ECHO: objects, relations, and types.
+ */
+export declare enum EntityKind {
+    Object = "object",
+    Relation = "relation",
+    Type = "type"
+}
+export declare const EntityKindSchema: Schema.Enums<typeof EntityKind>;
+/**
+ * Typename for generic object references (Type.Obj / Ref.Ref(Obj.Unknown)).
+ * Used when referencing any object without a specific schema.
+ */
+export declare const ANY_OBJECT_TYPENAME = "org.dxos.schema.anyObject";
+/**
+ * Version for generic object references.
+ */
+export declare const ANY_OBJECT_VERSION = "0.0.0";
+//# sourceMappingURL=entity.d.ts.map

package/dist/types/src/internal/common/types/entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../../../../../src/internal/common/types/entity.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AASxC;;GAEG;AACH,eAAO,MAAM,MAAM,EAAG,kBAA2B,CAAC;AAClD,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAG,wBAAiC,CAAC;AAC9D,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC;AAE/C;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAG,0BAAmC,CAAC;AAClE,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC;AAEnD;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,EAAG,+BAAwC,CAAC;AAC7E,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,UAAW,OAAO,KAAG,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG,SAKjF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,UAAW,OAAO,KAAG,UAAU,GAAG,SAK3D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,UAAW,OAAO,KAAG,UAAU,GAAG,SAKhE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,EAAG,2BAAoC,CAAC;AACtE,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC;AAEzD;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB,EAAG,oCAA6C,CAAC;AACtF,MAAM,MAAM,wBAAwB,GAAG,OAAO,wBAAwB,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,UAAU,CAAE,SAAQ,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC;IAC9F,QAAQ,CAAC,CAAC,wBAAwB,CAAC,EAAE,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,IAAI,SAAS;CACd;AAED,eAAO,MAAM,gBAAgB,iCAA2B,CAAC;AAEzD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,8BAA8B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,kBAAkB,UAAU,CAAC"}

package/dist/types/src/internal/{types → common/types}/index.d.ts

@@ -1,6 +1,7 @@
 export * from './base';
 export * from './entity';
 export * from './meta';
+export * from './model-symbols';
 export * from './typename';
 export * from './version';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/internal/common/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/internal/common/types/index.ts"],"names":[],"mappings":"AAIA,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/dist/types/src/internal/{types → common/types}/meta.d.ts

@@ -1,6 +1,7 @@
 import * as Schema from 'effect/Schema';
 import { ForeignKey } from '@dxos/echo-protocol';
 import { type Comparator } from '@dxos/util';
+import type * as Entity from '../../../Entity';
 import { type AnyProperties } from './base';
 /**
  * Property name for meta when object is serialized to JSON.
@@ -9,7 +10,7 @@ export declare const ATTR_META = "@meta";
 /**
  * Metadata section.
  */
-export declare const MetaId: unique symbol;
+export declare const MetaId: Entity.Meta;
 export declare const ObjectMetaSchema: Schema.Struct<{
     keys: Schema.Array$<Schema.Schema<{
         readonly source: string;
@@ -24,6 +25,16 @@ export declare const ObjectMetaSchema: Schema.Struct<{
      * ECHO makes no assumptions about the tag structure.
      */
     tags: Schema.optional<Schema.Array$<typeof Schema.String>>;
+    /**
+     * Fully-qualified registry key for the object (FQN format, e.g. `org.example.type.foo`).
+     * Identifies the canonical registry entry the object instance was created from.
+     */
+    key: Schema.optional<typeof Schema.String>;
+    /**
+     * Semantic version of the registry entry the object was created from.
+     * Must be a valid semver string (e.g. `1.2.3`).
+     */
+    version: Schema.optional<typeof Schema.String>;
 }>;
 export type ObjectMeta = Schema.Schema.Type<typeof ObjectMetaSchema>;
 export declare const foreignKey: (source: string, id: string) => ForeignKey;

package/dist/types/src/internal/common/types/meta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../../../../src/internal/common/types/meta.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,KAAK,UAAU,EAAgB,MAAM,YAAY,CAAC;AAE3D,OAAO,KAAK,KAAK,MAAM,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,QAAQ,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,SAAS,UAAU,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,MAAM,CAAC,IAA2C,CAAC;AAOxE,eAAO,MAAM,gBAAgB;;;;;;;;IAG3B;;;;OAIG;;IAMH;;;OAGG;;IAGH;;;OAGG;;EAEH,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAmBrE,eAAO,MAAM,UAAU,WAAY,MAAM,MAAM,MAAM,KAAG,UAA8B,CAAC;AACvF,eAAO,MAAM,gBAAgB,MAAO,UAAU,KAAK,UAAU,YAA2C,CAAC;AAGzG,eAAO,MAAM,kBAAkB,EAAE,UAAU,CAAC,aAAa,CACoB,CAAC"}

package/dist/types/src/internal/common/types/model-symbols.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Internal symbol/string constants for the echo object model.
+ * Defined in common/ so proxy/ can use them without importing from Entity/.
+ * Entity/ re-exports these for external consumers.
+ */
+/**
+ * Property name for the object's own URI when serialized to JSON.
+ */
+export declare const ATTR_SELF_URI = "@uri";
+/**
+ * @deprecated Legacy JSON property name accepted on read for backward compat.
+ */
+export declare const ATTR_SELF_URI_LEGACY = "@dxn";
+/**
+ * Symbol carrying the object's own URI on live entities.
+ */
+export declare const SelfURIId: unique symbol;
+/**
+ * Property name for deleted when object is serialized to JSON.
+ */
+export declare const ATTR_DELETED = "@deleted";
+/**
+ * Deletion marker.
+ */
+export declare const ObjectDeletedId: unique symbol;
+/**
+ * Object version accessor symbol.
+ */
+export declare const ObjectVersionId: unique symbol;
+/**
+ * Object database accessor symbol.
+ */
+export declare const ObjectDatabaseId: unique symbol;
+/**
+ * Property name for relation source when object is serialized to JSON.
+ */
+export declare const ATTR_RELATION_SOURCE = "@relationSource";
+/**
+ * Used to access relation source ref on live ECHO objects.
+ */
+export declare const RelationSourceId: unique symbol;
+/**
+ * Used to access relation source DXN on live ECHO objects.
+ */
+export declare const RelationSourceDXNId: unique symbol;
+/**
+ * Property name for relation target when object is serialized to JSON.
+ */
+export declare const ATTR_RELATION_TARGET = "@relationTarget";
+/**
+ * Used to access relation target ref on live ECHO objects.
+ */
+export declare const RelationTargetId: unique symbol;
+/**
+ * Used to access relation target DXN on live ECHO objects.
+ */
+export declare const RelationTargetDXNId: unique symbol;
+//# sourceMappingURL=model-symbols.d.ts.map

package/dist/types/src/internal/common/types/model-symbols.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-symbols.d.ts","sourceRoot":"","sources":["../../../../../../src/internal/common/types/model-symbols.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,aAAa,SAAS,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,oBAAoB,SAAS,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,SAAS,eAA+B,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,YAAY,aAAa,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,eAAe,eAAmC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,OAAO,MAAyC,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,gBAAgB,eAAoC,CAAC;AAElE;;GAEG;AACH,eAAO,MAAM,oBAAoB,oBAAoB,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,MAAgD,CAAC;AAEvF;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAAmD,CAAC;AAE7F;;GAEG;AACH,eAAO,MAAM,oBAAoB,oBAAoB,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,MAAgD,CAAC;AAEvF;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAAmD,CAAC"}

package/dist/types/src/internal/{types → common/types}/typename.d.ts

@@ -18,4 +18,11 @@ export declare const ATTR_PARENT = "@parent";
  * Reference to the object parent.
  */
 export declare const ParentId: unique symbol;
+/**
+ * Reference to the object's type entity (`Type.Obj`, `Type.Relation`, or
+ * `Type.Type`). Set at instance creation by `createObject` / `makeObject`
+ * when the entity is known. Public read-back via `Obj.getType` / `Relation.getType`
+ * / `Entity.getType`.
+ */
+export declare const TypeEntityId: unique symbol;
 //# sourceMappingURL=typename.d.ts.map

package/dist/types/src/internal/common/types/typename.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typename.d.ts","sourceRoot":"","sources":["../../../../../../src/internal/common/types/typename.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,eAAO,MAAM,SAAS,UAAU,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,MAAM,eAAgC,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,QAAQ,eAAkC,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,WAAW,YAAY,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,QAAQ,eAAkC,CAAC;AAExD;;;;;GAKG;AACH,eAAO,MAAM,YAAY,eAAsC,CAAC"}

package/dist/types/src/internal/{types → common/types}/version.d.ts

@@ -1,7 +1,7 @@
 /**
- * Version type symbol.
+ * Version type identifier.
  */
-export declare const VersionTypeId: unique symbol;
+export declare const VersionTypeId: '~@dxos/echo/VersionTypeId';
 export type VersionTypeId = typeof VersionTypeId;
 /**
  * Represents the object version.

package/dist/types/src/internal/common/types/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../../../../src/internal/common/types/version.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,eAAO,MAAM,aAAa,EAAG,2BAAoC,CAAC;AAClE,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B"}

package/dist/types/src/internal/index.d.ts

@@ -1,12 +1,11 @@
 export { JsonPath, JsonProp, getValue, splitJsonPath } from '@dxos/effect';
-export * from './annotations';
-export * from './api';
-export * from './entities';
-export * from './formats';
-export * from './json-schema';
-export * from './ref';
-export * from './types';
-export * from './object';
-export * from './proxy';
-export * from './schema';
+export * from './Annotation';
+export * from './common';
+export * from './Entity';
+export * from './Format';
+export * from './JsonSchema';
+export * from './Obj';
+export * from './Query';
+export * from './Ref';
+export * from './Type';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/internal/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/internal/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE3E,cAAc,eAAe,CAAC;AAC9B,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AAGxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/internal/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE3E,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAE7B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC"}

package/dist/types/src/testing/test-data.d.ts

@@ -1,18 +1,18 @@
 import { DatabaseDirectory } from '@dxos/echo-protocol';
 export declare const PEOPLE: {
-    alice: DatabaseDirectory;
-    bob: DatabaseDirectory;
+    readonly alice: DatabaseDirectory;
+    readonly bob: DatabaseDirectory;
 };
 export declare const ORGS: {
-    dxos: DatabaseDirectory;
-    cyberdyne: DatabaseDirectory;
+    readonly dxos: DatabaseDirectory;
+    readonly cyberdyne: DatabaseDirectory;
 };
 export declare const WORKS_FOR: {
-    fredWorksForCyberdyne: DatabaseDirectory;
-    aliceWorksForAperture: DatabaseDirectory;
+    readonly fredWorksForCyberdyne: DatabaseDirectory;
+    readonly aliceWorksForAperture: DatabaseDirectory;
 };
 export declare const TASKS: {
-    task1: DatabaseDirectory;
-    task2: DatabaseDirectory;
+    readonly task1: DatabaseDirectory;
+    readonly task2: DatabaseDirectory;
 };
 //# sourceMappingURL=test-data.d.ts.map

package/dist/types/src/testing/test-data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test-data.d.ts","sourceRoot":"","sources":["../../../../src/testing/test-data.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAmB,MAAM,qBAAqB,CAAC;AAWzE,eAAO,MAAM,MAAM;;;CAuBlB,CAAC;AAEF,eAAO,MAAM,IAAI;;;CAyBhB,CAAC;AAEF,eAAO,MAAM,SAAS;;;CA6BrB,CAAC;AAEF,eAAO,MAAM,KAAK;;;CA+BjB,CAAC"}
+{"version":3,"file":"test-data.d.ts","sourceRoot":"","sources":["../../../../src/testing/test-data.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAmB,MAAM,qBAAqB,CAAC;AA0BzE,eAAO,MAAM,MAAM;aACb,KAAK,EAAI,iBAAiB;aAiB1B,GAAG,EAAI,iBAAiB;CAgB7B,CAAC;AAEF,eAAO,MAAM,IAAI;aACX,IAAI,EAAI,iBAAiB;aAkBzB,SAAS,EAAI,iBAAiB;CAiBnC,CAAC;AAEF,eAAO,MAAM,SAAS;aAChB,qBAAqB,EAAI,iBAAiB;aAoB1C,qBAAqB,EAAI,iBAAiB;CAmB/C,CAAC;AAEF,eAAO,MAAM,KAAK;aACZ,KAAK,EAAI,iBAAiB;aAqB1B,KAAK,EAAI,iBAAiB;CAoB/B,CAAC"}