@dxos/echo 0.8.4-main.406dc2a → 0.8.4-main.59c2e9b

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

@@ -0,0 +1,120 @@
+import * as Schema from 'effect/Schema';
+import type * as Types from 'effect/Types';
+import { type ForeignKey, type QueryAST } from '@dxos/echo-protocol';
+import { DXN, ObjectId } from '@dxos/keys';
+export interface Filter<T> {
+    '~Filter': {
+        value: Types.Contravariant<T>;
+    };
+    ast: QueryAST.Filter;
+}
+export type Props<T> = {
+    [K in keyof T & string]?: Filter<T[K]> | T[K];
+};
+export type Any = Filter<any>;
+export type Type<F extends Any> = F extends Filter<infer T> ? T : never;
+declare class FilterClass implements Any {
+    readonly ast: QueryAST.Filter;
+    private static variance;
+    constructor(ast: QueryAST.Filter);
+    '~Filter': {
+        value: Types.Contravariant<any>;
+    };
+}
+export declare const is: (value: unknown) => value is Any;
+/** Construct a filter from an ast. */
+export declare const fromAst: (ast: QueryAST.Filter) => Any;
+/**
+ * Filter that matches all objects.
+ */
+export declare const everything: () => FilterClass;
+/**
+ * Filter that matches no objects.
+ */
+export declare const nothing: () => FilterClass;
+export declare const id: (...ids: ObjectId[]) => Any;
+/**
+ * Filter by type.
+ */
+export declare const type: <S extends Schema.Schema.All>(schema: S | string, props?: Props<Schema.Schema.Type<S>>) => Filter<Schema.Schema.Type<S>>;
+/**
+ * Filter by non-qualified typename.
+ */
+export declare const typename: (typename: string) => Any;
+/**
+ * Filter by fully qualified type DXN.
+ */
+export declare const typeDXN: (dxn: DXN) => Any;
+/**
+ * Filter by tag.
+ */
+export declare const tag: (tag: string) => Any;
+/**
+ * Filter by properties.
+ */
+export declare const props: <T>(props: Props<T>) => Filter<T>;
+export type TextSearchOptions = {
+    type?: 'full-text' | 'vector';
+};
+/**
+ * Full-text or vector search.
+ */
+export declare const text: (text: string, options?: TextSearchOptions) => Any;
+/**
+ * Filter by foreign keys.
+ */
+export declare const foreignKeys: <S extends Schema.Schema.All>(schema: S | string, keys: ForeignKey[]) => Filter<Schema.Schema.Type<S>>;
+/**
+ * Predicate for property to be equal to the provided value.
+ */
+export declare const eq: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be not equal to the provided value.
+ */
+export declare const neq: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be greater than the provided value.
+ */
+export declare const gt: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be greater than or equal to the provided value.
+ */
+export declare const gte: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be less than the provided value.
+ */
+export declare const lt: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be less than or equal to the provided value.
+ */
+export declare const lte: <T>(value: T) => Filter<T | undefined>;
+/**
+ * Predicate for property to be in the provided array.
+ * @param values - Values to check against.
+ */
+declare const in$: <T>(...values: T[]) => Filter<T | undefined>;
+export { in$ as in };
+/**
+ * Predicate for an array property to contain the provided value.
+ * @param value - Value to check against.
+ */
+export declare const contains: <T>(value: T) => Filter<readonly T[] | undefined>;
+/**
+ * Predicate for property to be in the provided range.
+ * @param from - Start of the range (inclusive).
+ * @param to - End of the range (exclusive).
+ */
+export declare const between: <T>(from: T, to: T) => Filter<unknown>;
+/**
+ * Negate the filter.
+ */
+export declare const not: <F extends Any>(filter: F) => Filter<Type<F>>;
+/**
+ * Combine filters with a logical AND.
+ */
+export declare const and: <Filters extends readonly Any[]>(...filters: Filters) => Filter<Type<Filters[number]>>;
+/**
+ * Combine filters with a logical OR.
+ */
+export declare const or: <Filters extends readonly Any[]>(...filters: Filters) => Filter<Type<Filters[number]>>;
+//# sourceMappingURL=Filter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Filter.d.ts","sourceRoot":"","sources":["../../../src/Filter.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAErE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAK3C,MAAM,WAAW,MAAM,CAAC,CAAC;IAEvB,SAAS,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;KAAE,CAAC;IAE7C,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI;KAEpB,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAE9B,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAExE,cAAM,WAAY,YAAW,GAAG;aAGF,GAAG,EAAE,QAAQ,CAAC,MAAM;IAFhD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAwC;gBAEnC,GAAG,EAAE,QAAQ,CAAC,MAAM;IAEhD,SAAS;;MAAwB;CAClC;AAED,eAAO,MAAM,EAAE,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,GAE5C,CAAC;AAEF,sCAAsC;AACtC,eAAO,MAAM,OAAO,GAAI,KAAK,QAAQ,CAAC,MAAM,KAAG,GAE9C,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,UAAU,QAAO,WAM7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,QAAO,WAS1B,CAAC;AAKF,eAAO,MAAM,EAAE,GAAI,GAAG,KAAK,QAAQ,EAAE,KAAG,GAiBvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC9C,QAAQ,CAAC,GAAG,MAAM,EAClB,QAAQ,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAO9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,UAAU,MAAM,KAAG,GAO3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,KAAK,GAAG,KAAG,GAMlC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,KAAK,MAAM,KAAG,GAKjC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,CAMlD,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAE9B,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,IAAI,GAEf,MAAM,MAAM,EACZ,UAAU,iBAAiB,KAC1B,GAMF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACrD,QAAQ,CAAC,GAAG,MAAM,EAClB,MAAM,UAAU,EAAE,KACjB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAQ9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAUpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMrD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMrD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAMrD,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,GAAG,GAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,KAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAKpD,CAAC;AACF,OAAO,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;AAErB;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,SAAS,CAAC,EAAE,GAAG,SAAS,CAKrE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,KAAG,MAAM,CAAC,OAAO,CAMzD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,SAAS,GAAG,EAAE,QAAQ,CAAC,KAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAK5D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,GAAG,GAAI,OAAO,SAAS,SAAS,GAAG,EAAE,EAAE,GAAG,SAAS,OAAO,KAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAKrG,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,EAAE,GAAI,OAAO,SAAS,SAAS,GAAG,EAAE,EAAE,GAAG,SAAS,OAAO,KAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAKpG,CAAC"}

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

@@ -0,0 +1,4 @@
+import { type TypeFormat as Format } from './internal';
+export * from './internal/formats';
+export type { Format };
+//# sourceMappingURL=Format.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Format.d.ts","sourceRoot":"","sources":["../../../src/Format.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,UAAU,IAAI,MAAM,EAAE,MAAM,YAAY,CAAC;AAEvD,cAAc,oBAAoB,CAAC;AAEnC,YAAY,EAAE,MAAM,EAAE,CAAC"}

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

@@ -0,0 +1,60 @@
+import { type DXN } from '@dxos/keys';
+import type * as Database from './Database';
+import type * as Entity from './Entity';
+import { type AnyProperties } from './internal';
+import type * as Key from './Key';
+import type * as Ref from './Ref';
+import type * as SchemaRegistry from './SchemaRegistry';
+/**
+ * Resolution context.
+ * Affects how non-absolute DXNs are resolved.
+ */
+export interface RefResolutionContext {
+    /**
+     * Space that the resolution is happening from.
+     */
+    space?: Key.SpaceId;
+    /**
+     * Queue that the resolution is happening from.
+     * This queue will be searched first, and then the space it belongs to.
+     */
+    queue?: DXN;
+}
+export interface RefResolverOptions {
+    /**
+     * Resolution context.
+     * Affects how non-absolute DXNs are resolved.
+     */
+    context?: RefResolutionContext;
+    /**
+     * Middleware to change the resolved object before returning it.
+     * @deprecated On track to be removed.
+     */
+    middleware?: (obj: AnyProperties) => AnyProperties;
+}
+/**
+ *
+ */
+export interface Hypergraph extends Database.Queryable {
+    get schemaRegistry(): SchemaRegistry.SchemaRegistry;
+    /**
+     * Query objects.
+     */
+    query: Database.QueryFn;
+    /**
+     * Creates a reference to an existing object in the database.
+     *
+     * NOTE: The reference may be dangling if the object is not present in the database.
+     * NOTE: Difference from `Ref.fromDXN`
+     * `Ref.fromDXN(dxn)` returns an unhydrated reference. The `.load` and `.target` APIs will not work.
+     * `db.makeRef(dxn)` is preferable in cases with access to the database.
+     */
+    makeRef<T extends Entity.Unknown = Entity.Unknown>(dxn: DXN): Ref.Ref<T>;
+    /**
+     * @param hostDb Host database for reference resolution.
+     * @param middleware Called with the loaded object. The caller may change the object.
+     * @returns Result of `onLoad`.
+     */
+    createRefResolver(options: RefResolverOptions): Ref.Resolver;
+}
+//# sourceMappingURL=Hypergraph.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Hypergraph.d.ts","sourceRoot":"","sources":["../../../src/Hypergraph.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,KAAK,KAAK,QAAQ,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,GAAG,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,KAAK,cAAc,MAAM,kBAAkB,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;IAEpB;;;OAGG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAE/B;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,aAAa,CAAC;CACpD;AAED;;GAEG;AAEH,MAAM,WAAW,UAAW,SAAQ,QAAQ,CAAC,SAAS;IACpD,IAAI,cAAc,IAAI,cAAc,CAAC,cAAc,CAAC;IAEpD;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;IAExB;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAEzE;;;;OAIG;IAEH,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,GAAG,CAAC,QAAQ,CAAC;CAC9D"}

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

@@ -0,0 +1,9 @@
+import type * as Schema from 'effect/Schema';
+import { JsonSchemaType } from './internal';
+export { toEffectSchema, toJsonSchema } from './internal';
+/**
+ * Serializable JsonSchema type definition.
+ */
+export type JsonSchema = JsonSchemaType;
+export declare const JsonSchema: Schema.Schema<JsonSchemaType>;
+//# sourceMappingURL=JsonSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"JsonSchema.d.ts","sourceRoot":"","sources":["../../../src/JsonSchema.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,CAAC;AAExC,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,cAAc,CAAkB,CAAC"}

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

@@ -1,2 +1,3 @@
+export { ForeignKey } from '@dxos/echo-protocol';
 export { SpaceId, ObjectId } from '@dxos/keys';
 //# sourceMappingURL=Key.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Key.d.ts","sourceRoot":"","sources":["../../../src/Key.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"Key.d.ts","sourceRoot":"","sources":["../../../src/Key.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}