@dxos/echo 0.8.4-main.3f58842 → 0.8.4-main.548089c

package/README.md

@@ -122,7 +122,7 @@ Defines attributes and encoding placed on objects.
 |                     | Optional                | Runtime prop                           | Runtime type           | JSON prop                   | JSON type  | Description                    |
 | ------------------- | ----------------------- | -------------------------------------- | ---------------------- | --------------------------- | ---------- | ------------------------------ |
 | Id                  | No                      | `id`                                   | `ObjectID` ULID string | `id`                        | string     | Unique object ID               |
-| Self DXN            | Yes                     | `Symbol(@dxos/echo/Self)`              | `DXN`                  | `@self`                     | string     | DXN to the object itself       |
+| Self DXN            | Yes                     | `Symbol(@dxos/echo/DXN)`               | `DXN`                  | `@dxn`                      | string     | DXN to the object itself       |
 | Type                | No                      | `Symbol(@dxos/echo/Type)`              | `DXN`                  | `@type`                     | string     | DXN to the object type         |
 | Schema              | Yes                     | `Symbol(@dxos/echo/Schema)`            | Effect-Schema          | -                           |            | Reference to the object schema |
 | Tombstone marker    | Yes                     | `Symbol(@dxos/echo/Deleted)`           | `boolean`              | `@deleted`                  | boolean    | Deletion marker                |

package/dist/lib/browser/chunk-3FCPYTWA.mjs

@@ -0,0 +1,585 @@
+import "@dxos/node-std/globals";
+import {
+  ATTR_RELATION_SOURCE,
+  ATTR_RELATION_TARGET,
+  EchoObject,
+  EchoRelation,
+  EntityKind,
+  EntityKindId,
+  Expando,
+  Format,
+  JsonSchemaType,
+  LabelAnnotation,
+  MetaId,
+  ObjectVersionId,
+  Ref,
+  RelationSourceDXNId,
+  RelationSourceId,
+  RelationTargetDXNId,
+  RelationTargetId,
+  VersionTypeId,
+  __export,
+  getDescription,
+  getLabel,
+  getMeta,
+  getObjectDXN,
+  getSchema,
+  getSchemaDXN,
+  getSchemaTypename,
+  getSchemaVersion,
+  getType,
+  getTypeAnnotation,
+  isDeleted,
+  isInstanceOf,
+  isMutable,
+  live,
+  objectFromJSON,
+  objectToJSON,
+  setDescription,
+  setLabel,
+  toEffectSchema,
+  toJsonSchema
+} from "./chunk-5BNXQE6S.mjs";
+
+// src/errors.ts
+import { BaseError } from "@dxos/errors";
+var SchemaNotFoundError = class extends BaseError.extend("SCHEMA_NOT_FOUND", "Schema not found") {
+  constructor(schema, options) {
+    super({
+      context: {
+        schema
+      },
+      ...options
+    });
+  }
+};
+var ObjectNotFoundError = class extends BaseError.extend("OBJECT_NOT_FOUND", "Object not found") {
+  constructor(dxn, options) {
+    super({
+      context: {
+        dxn
+      },
+      ...options
+    });
+  }
+};
+
+// src/Key.ts
+var Key_exports = {};
+__export(Key_exports, {
+  ObjectId: () => ObjectId,
+  SpaceId: () => SpaceId
+});
+import { SpaceId, ObjectId } from "@dxos/keys";
+
+// src/Obj.ts
+var Obj_exports = {};
+__export(Obj_exports, {
+  Any: () => Any,
+  Meta: () => Meta,
+  VersionTypeId: () => VersionTypeId2,
+  addTag: () => addTag,
+  clone: () => clone,
+  compareVersions: () => compareVersions,
+  decodeVersion: () => decodeVersion,
+  deleteKeys: () => deleteKeys,
+  encodeVersion: () => encodeVersion,
+  fromJSON: () => fromJSON,
+  getDXN: () => getDXN2,
+  getDescription: () => getDescription2,
+  getKeys: () => getKeys,
+  getLabel: () => getLabel2,
+  getMeta: () => getMeta3,
+  getSchema: () => getSchema2,
+  getSnapshot: () => getSnapshot2,
+  getTypeDXN: () => getTypeDXN,
+  getTypename: () => getTypename2,
+  instanceOf: () => instanceOf,
+  isDeleted: () => isDeleted2,
+  isObject: () => isObject,
+  isVersion: () => isVersion,
+  make: () => make,
+  removeTag: () => removeTag,
+  setDescription: () => setDescription2,
+  setLabel: () => setLabel2,
+  sort: () => sort,
+  sortByLabel: () => sortByLabel,
+  sortByTypename: () => sortByTypename,
+  toJSON: () => toJSON,
+  version: () => version,
+  versionValid: () => versionValid
+});
+import * as Function from "effect/Function";
+import * as Schema from "effect/Schema";
+import { assertArgument, invariant as invariant2 } from "@dxos/invariant";
+import * as LiveObject from "@dxos/live-object";
+import { assumeType, deepMapValues } from "@dxos/util";
+
+// src/Type.ts
+var Type_exports = {};
+__export(Type_exports, {
+  DXN: () => DXN,
+  Expando: () => Expando2,
+  Format: () => Format,
+  JsonSchema: () => JsonSchemaType,
+  Kind: () => Kind,
+  KindId: () => KindId,
+  Obj: () => Obj,
+  ObjectId: () => ObjectId2,
+  Ref: () => Ref2,
+  Relation: () => Relation,
+  SpaceId: () => SpaceId2,
+  getDXN: () => getDXN,
+  getMeta: () => getMeta2,
+  getTypename: () => getTypename,
+  getVersion: () => getVersion,
+  isMutable: () => isMutable2,
+  toEffectSchema: () => toEffectSchema,
+  toJsonSchema: () => toJsonSchema
+});
+import { invariant } from "@dxos/invariant";
+import { SpaceId as SpaceId2, ObjectId as ObjectId2, DXN } from "@dxos/keys";
+var __dxlog_file = "/__w/dxos/dxos/packages/core/echo/echo/src/Type.ts";
+var KindId = EntityKindId;
+var Kind = EntityKind;
+var Obj = EchoObject;
+var Expando2 = Expando;
+var Relation = EchoRelation;
+var Ref2 = Ref;
+var getDXN = (schema) => {
+  return getSchemaDXN(schema);
+};
+var getTypename = (schema) => {
+  const typename = getSchemaTypename(schema);
+  invariant(typeof typename === "string" && !typename.startsWith("dxn:"), "Invalid typename", {
+    F: __dxlog_file,
+    L: 211,
+    S: void 0,
+    A: [
+      "typeof typename === 'string' && !typename.startsWith('dxn:')",
+      "'Invalid typename'"
+    ]
+  });
+  return typename;
+};
+var getVersion = (schema) => {
+  const version2 = getSchemaVersion(schema);
+  invariant(typeof version2 === "string" && version2.match(/^\d+\.\d+\.\d+$/), "Invalid version", {
+    F: __dxlog_file,
+    L: 221,
+    S: void 0,
+    A: [
+      "typeof version === 'string' && version.match(/^\\d+\\.\\d+\\.\\d+$/)",
+      "'Invalid version'"
+    ]
+  });
+  return version2;
+};
+var isMutable2 = isMutable;
+var getMeta2 = (schema) => {
+  return getTypeAnnotation(schema);
+};
+
+// src/Obj.ts
+var __dxlog_file2 = "/__w/dxos/dxos/packages/core/echo/echo/src/Obj.ts";
+var Any = Schema.Struct({}).pipe(Obj({
+  typename: "dxos.org/types/Any",
+  version: "0.1.0"
+}));
+var Meta = MetaId;
+var DEFAULT_META = {
+  keys: []
+};
+var make = (schema, props, meta) => {
+  assertArgument(getTypeAnnotation(schema)?.kind === EntityKind.Object, "schema", "Expected an object schema");
+  if (props[MetaId] != null) {
+    meta = {
+      ...structuredClone(DEFAULT_META),
+      ...props[MetaId]
+    };
+    delete props[MetaId];
+  }
+  const filterUndefined = Object.fromEntries(Object.entries(props).filter(([_, v]) => v !== void 0));
+  return live(schema, filterUndefined, {
+    keys: [],
+    ...meta
+  });
+};
+var isObject = (obj) => {
+  assumeType(obj);
+  return typeof obj === "object" && obj !== null && obj[EntityKindId] === EntityKind.Object;
+};
+var instanceOf = (...args) => {
+  if (args.length === 1) {
+    return (obj) => isInstanceOf(args[0], obj);
+  }
+  return isInstanceOf(args[0], args[1]);
+};
+var getSchema2 = getSchema;
+var getDXN2 = (obj) => {
+  assertArgument(!Schema.isSchema(obj), "obj", "Object should not be a schema.");
+  const dxn = getObjectDXN(obj);
+  invariant2(dxn != null, "Invalid object.", {
+    F: __dxlog_file2,
+    L: 136,
+    S: void 0,
+    A: [
+      "dxn != null",
+      "'Invalid object.'"
+    ]
+  });
+  return dxn;
+};
+var getTypeDXN = getType;
+var getTypename2 = (obj) => {
+  const schema = getSchema2(obj);
+  if (schema == null) {
+    return getType(obj)?.asTypeDXN()?.type;
+  }
+  return getSchemaTypename(schema);
+};
+var getMeta3 = (obj) => {
+  const meta = getMeta(obj);
+  invariant2(meta != null, "Invalid object.", {
+    F: __dxlog_file2,
+    L: 164,
+    S: void 0,
+    A: [
+      "meta != null",
+      "'Invalid object.'"
+    ]
+  });
+  return meta;
+};
+var getKeys = Function.dual(2, (obj, source) => {
+  const meta = getMeta(obj);
+  invariant2(meta != null, "Invalid object.", {
+    F: __dxlog_file2,
+    L: 176,
+    S: void 0,
+    A: [
+      "meta != null",
+      "'Invalid object.'"
+    ]
+  });
+  return meta.keys.filter((key) => key.source === source);
+});
+var deleteKeys = (obj, source) => {
+  const meta = getMeta(obj);
+  for (let i = 0; i < meta.keys.length; i++) {
+    if (meta.keys[i].source === source) {
+      meta.keys.splice(i, 1);
+      i--;
+    }
+  }
+};
+var isDeleted2 = (obj) => {
+  const deleted = isDeleted(obj);
+  invariant2(typeof deleted === "boolean", "Invalid object.", {
+    F: __dxlog_file2,
+    L: 198,
+    S: void 0,
+    A: [
+      "typeof deleted === 'boolean'",
+      "'Invalid object.'"
+    ]
+  });
+  return deleted;
+};
+var getLabel2 = (obj) => {
+  const schema = getSchema2(obj);
+  if (schema != null) {
+    return getLabel(schema, obj);
+  }
+};
+var setLabel2 = (obj, label) => {
+  const schema = getSchema2(obj);
+  if (schema != null) {
+    setLabel(schema, obj, label);
+  }
+};
+var getDescription2 = (obj) => {
+  const schema = getSchema2(obj);
+  if (schema != null) {
+    return getDescription(schema, obj);
+  }
+};
+var setDescription2 = (obj, description) => {
+  const schema = getSchema2(obj);
+  if (schema != null) {
+    setDescription(schema, obj, description);
+  }
+};
+var addTag = (obj, tag) => {
+  const meta = getMeta3(obj);
+  meta.tags ??= [];
+  meta.tags.push(tag);
+};
+var removeTag = (obj, tag) => {
+  const meta = getMeta3(obj);
+  if (!meta.tags) {
+    return;
+  }
+  for (let i = 0; i < meta.tags.length; i++) {
+    if (meta.tags[i] === tag) {
+      meta.tags.splice(i, 1);
+      i--;
+    }
+  }
+};
+var compare = (a, b) => {
+  if (a == null) {
+    return b == null ? 0 : 1;
+  }
+  if (b == null) {
+    return -1;
+  }
+  return a.localeCompare(b);
+};
+var sortByLabel = (a, b) => compare(getLabel2(a), getLabel2(b));
+var sortByTypename = (a, b) => compare(getTypename2(a), getTypename2(b));
+var sort = (...comparators) => {
+  return (a, b) => {
+    for (const comparator of comparators) {
+      const result = comparator(a, b);
+      if (result !== 0) {
+        return result;
+      }
+    }
+    return 0;
+  };
+};
+var toJSON = (obj) => objectToJSON(obj);
+var fromJSON = objectFromJSON;
+var getSnapshot2 = LiveObject.getSnapshot;
+var clone = (obj, opts) => {
+  const { id, ...data } = obj;
+  const schema = getSchema2(obj);
+  invariant2(schema != null, "Object should have a schema", {
+    F: __dxlog_file2,
+    L: 324,
+    S: void 0,
+    A: [
+      "schema != null",
+      "'Object should have a schema'"
+    ]
+  });
+  const props = deepMapValues(data, (value, recurse) => {
+    if (Ref.isRef(value)) {
+      return value;
+    }
+    return recurse(value);
+  });
+  if (opts?.retainId) {
+    props.id = id;
+  }
+  const meta = getMeta3(obj);
+  props[MetaId] = deepMapValues(meta, (value, recurse) => {
+    if (Ref.isRef(value)) {
+      return value;
+    }
+    return recurse(value);
+  });
+  return make(schema, props);
+};
+var VersionTypeId2 = VersionTypeId;
+var unversioned = {
+  [VersionTypeId2]: {},
+  versioned: false
+};
+var isVersion = (obj) => {
+  return obj != null && typeof obj === "object" && VersionTypeId2 in obj;
+};
+var version = (obj) => {
+  const version2 = obj[ObjectVersionId];
+  if (version2 === void 0) {
+    return unversioned;
+  }
+  return version2;
+};
+var versionValid = (version2) => {
+  assertArgument(isVersion(version2), "version", "Invalid version object");
+  return !!version2.versioned;
+};
+var compareVersions = (version1, version2) => {
+  assertArgument(isVersion(version1), "version1", "Invalid version object");
+  assertArgument(isVersion(version2), "version2", "Invalid version object");
+  if (!versionValid(version1) || !versionValid(version2)) {
+    return "unversioned";
+  }
+  if (version1.automergeHeads?.length !== version2.automergeHeads?.length) {
+    return "different";
+  }
+  if (version1.automergeHeads?.some((head) => !version2.automergeHeads?.includes(head))) {
+    return "different";
+  }
+  return "equal";
+};
+var encodeVersion = (version2) => {
+  return JSON.stringify(version2);
+};
+var decodeVersion = (version2) => {
+  const parsed = JSON.parse(version2);
+  parsed[VersionTypeId2] = {};
+  return parsed;
+};
+
+// src/Relation.ts
+var Relation_exports = {};
+__export(Relation_exports, {
+  Any: () => Any2,
+  Source: () => Source,
+  Target: () => Target,
+  getSource: () => getSource,
+  getSourceDXN: () => getSourceDXN,
+  getTarget: () => getTarget,
+  getTargetDXN: () => getTargetDXN,
+  isRelation: () => isRelation,
+  make: () => make2
+});
+import * as Schema2 from "effect/Schema";
+import { raise } from "@dxos/debug";
+import { assertArgument as assertArgument2, invariant as invariant3 } from "@dxos/invariant";
+import { DXN as DXN2 } from "@dxos/keys";
+import { assumeType as assumeType2 } from "@dxos/util";
+var __dxlog_file3 = "/__w/dxos/dxos/packages/core/echo/echo/src/Relation.ts";
+var Any2 = Schema2.Struct({}).pipe(Relation({
+  typename: "dxos.org/types/Any",
+  version: "0.1.0",
+  source: Any,
+  target: Any
+}));
+var Source = RelationSourceId;
+var Target = RelationTargetId;
+var make2 = (schema, props, meta) => {
+  assertArgument2(getTypeAnnotation(schema)?.kind === EntityKind.Relation, "schema", "Expected a relation schema");
+  if (props[MetaId] != null) {
+    meta = props[MetaId];
+    delete props[MetaId];
+  }
+  const sourceDXN = getObjectDXN(props[Source]) ?? raise(new Error("Unresolved relation source"));
+  const targetDXN = getObjectDXN(props[Target]) ?? raise(new Error("Unresolved relation target"));
+  props[RelationSourceDXNId] = sourceDXN;
+  props[RelationTargetDXNId] = targetDXN;
+  return live(schema, props, meta);
+};
+var isRelation = (value) => {
+  if (typeof value !== "object" || value === null) {
+    return false;
+  }
+  if (ATTR_RELATION_SOURCE in value || ATTR_RELATION_TARGET in value) {
+    return true;
+  }
+  const kind = value[EntityKindId];
+  return kind === EntityKind.Relation;
+};
+var getSourceDXN = (value) => {
+  assertArgument2(isRelation(value), "Expected a relation");
+  assumeType2(value);
+  const dxn = value[RelationSourceDXNId];
+  invariant3(dxn instanceof DXN2, void 0, {
+    F: __dxlog_file3,
+    L: 110,
+    S: void 0,
+    A: [
+      "dxn instanceof DXN",
+      ""
+    ]
+  });
+  return dxn;
+};
+var getTargetDXN = (value) => {
+  assertArgument2(isRelation(value), "Expected a relation");
+  assumeType2(value);
+  const dxn = value[RelationTargetDXNId];
+  invariant3(dxn instanceof DXN2, void 0, {
+    F: __dxlog_file3,
+    L: 122,
+    S: void 0,
+    A: [
+      "dxn instanceof DXN",
+      ""
+    ]
+  });
+  return dxn;
+};
+var getSource = (relation) => {
+  assertArgument2(isRelation(relation), "Expected a relation");
+  assumeType2(relation);
+  const obj = relation[RelationSourceId];
+  invariant3(obj !== void 0, `Invalid source: ${relation.id}`, {
+    F: __dxlog_file3,
+    L: 134,
+    S: void 0,
+    A: [
+      "obj !== undefined",
+      "`Invalid source: ${relation.id}`"
+    ]
+  });
+  return obj;
+};
+var getTarget = (relation) => {
+  assertArgument2(isRelation(relation), "Expected a relation");
+  assumeType2(relation);
+  const obj = relation[RelationTargetId];
+  invariant3(obj !== void 0, `Invalid target: ${relation.id}`, {
+    F: __dxlog_file3,
+    L: 146,
+    S: void 0,
+    A: [
+      "obj !== undefined",
+      "`Invalid target: ${relation.id}`"
+    ]
+  });
+  return obj;
+};
+
+// src/Tag.ts
+var Tag_exports = {};
+__export(Tag_exports, {
+  Tag: () => Tag,
+  createTagList: () => createTagList,
+  findTagByLabel: () => findTagByLabel,
+  make: () => make3,
+  sortTags: () => sortTags
+});
+import * as Schema3 from "effect/Schema";
+var Tag = Schema3.Struct({
+  label: Schema3.String,
+  hue: Schema3.optional(Schema3.String)
+}).pipe(Obj({
+  typename: "dxos.org/type/Tag",
+  version: "0.1.0"
+}), LabelAnnotation.set([
+  "label"
+]));
+var make3 = (props) => make(Tag, props);
+var sortTags = ({ label: a }, { label: b }) => a.localeCompare(b);
+var createTagList = (tags) => Object.entries(tags).map(([id, tag]) => ({
+  ...tag,
+  id
+})).sort(sortTags);
+var findTagByLabel = (tags, name) => {
+  const entry = Object.entries(tags ?? {}).find(([_, tag]) => tag.label.toLowerCase() === name.toLowerCase());
+  return entry ? {
+    ...entry[1],
+    id: entry[0]
+  } : void 0;
+};
+
+// src/index.ts
+import { QueryAST } from "@dxos/echo-protocol";
+import { DXN as DXN3 } from "@dxos/keys";
+
+export {
+  SchemaNotFoundError,
+  ObjectNotFoundError,
+  Key_exports,
+  Type_exports,
+  Obj_exports,
+  Relation_exports,
+  Tag_exports,
+  QueryAST,
+  DXN3 as DXN
+};
+//# sourceMappingURL=chunk-3FCPYTWA.mjs.map