@dxos/echo-solid 0.0.0 → 0.8.4-main.69d29f4

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

@@ -0,0 +1,101 @@
+import { type MaybeAccessor } from '@solid-primitives/utils';
+import { type Accessor } from 'solid-js';
+import { Obj, Ref } from '@dxos/echo';
+export interface ObjectUpdateCallback<T> {
+    (update: (obj: Obj.Mutable<T>) => void): void;
+    (update: (obj: Obj.Mutable<T>) => Obj.Mutable<T>): void;
+}
+export interface ObjectPropUpdateCallback<T> {
+    (update: (value: Obj.Mutable<T>) => void): void;
+    (update: (value: Obj.Mutable<T>) => Obj.Mutable<T>): void;
+    (newValue: T): void;
+}
+/**
+ * Helper type to conditionally include undefined in return type only if input includes undefined.
+ * Only adds undefined if T includes undefined AND R doesn't already include undefined.
+ */
+type ConditionalUndefined<T, R> = [T] extends [Exclude<T, undefined>] ? R : [R] extends [Exclude<R, undefined>] ? R | undefined : R;
+/**
+ * Subscribe to a Ref's target object.
+ * Automatically dereferences the ref and handles async loading.
+ * Returns undefined if the ref hasn't loaded yet.
+ *
+ * @param ref - The Ref to dereference and subscribe to (can be reactive)
+ * @returns A tuple of [accessor, updateCallback]
+ */
+export declare function useObject<T>(ref: MaybeAccessor<Ref.Ref<T>>): [Accessor<T | undefined>, ObjectUpdateCallback<T>];
+/**
+ * Subscribe to a Ref's target object that may be undefined.
+ * Returns undefined if the ref is undefined or hasn't loaded yet.
+ *
+ * @param ref - The Ref to dereference and subscribe to (can be undefined/reactive)
+ * @returns A tuple of [accessor, updateCallback]
+ */
+export declare function useObject<T>(ref: MaybeAccessor<Ref.Ref<T> | undefined>): [Accessor<T | undefined>, ObjectUpdateCallback<T>];
+/**
+ * Subscribe to an entire Echo object.
+ * Returns the current object value accessor and an update callback.
+ *
+ * @param obj - The Echo object to subscribe to (can be reactive)
+ * @returns A tuple of [accessor, updateCallback]
+ */
+export declare function useObject<T extends Obj.Unknown>(obj: MaybeAccessor<T>): [Accessor<ConditionalUndefined<T, T>>, ObjectUpdateCallback<T>];
+/**
+ * Subscribe to an entire Echo object that may be undefined.
+ * Returns undefined if the object is undefined.
+ *
+ * @param obj - The Echo object to subscribe to (can be undefined/reactive)
+ * @returns A tuple of [accessor, updateCallback]
+ */
+export declare function useObject<T extends Obj.Unknown>(obj: MaybeAccessor<T | undefined>): [Accessor<ConditionalUndefined<T, T>>, ObjectUpdateCallback<T>];
+/**
+ * Subscribe to a specific property of an Echo object.
+ * Returns the current property value accessor and an update callback.
+ *
+ * @param obj - The Echo object to subscribe to (can be reactive)
+ * @param property - Property key to subscribe to
+ * @returns A tuple of [accessor, updateCallback]
+ */
+export declare function useObject<T extends Obj.Unknown, K extends keyof T>(obj: MaybeAccessor<T>, property: K): [Accessor<T[K]>, ObjectPropUpdateCallback<T[K]>];
+/**
+ * Subscribe to a specific property of an Echo object that may be undefined.
+ * Returns undefined if the object is undefined.
+ *
+ * @param obj - The Echo object to subscribe to (can be undefined/reactive)
+ * @param property - Property key to subscribe to
+ * @returns A tuple of [accessor, updateCallback]
+ */
+export declare function useObject<T extends Obj.Unknown, K extends keyof T>(obj: MaybeAccessor<T | undefined>, property: K): [Accessor<T[K] | undefined>, ObjectPropUpdateCallback<T[K]>];
+/**
+ * Subscribe to a specific property of a Ref's target object.
+ * Automatically dereferences the ref and handles async loading.
+ * Returns undefined if the ref hasn't loaded yet.
+ *
+ * @param ref - The Ref to dereference and subscribe to (can be reactive)
+ * @param property - Property key to subscribe to
+ * @returns A tuple of [accessor, updateCallback]
+ */
+export declare function useObject<T, K extends keyof T>(ref: MaybeAccessor<Ref.Ref<T>>, property: K): [Accessor<T[K] | undefined>, ObjectPropUpdateCallback<T[K]>];
+/**
+ * Subscribe to a specific property of a Ref's target object that may be undefined.
+ * Returns undefined if the ref is undefined or hasn't loaded yet.
+ *
+ * @param ref - The Ref to dereference and subscribe to (can be undefined/reactive)
+ * @param property - Property key to subscribe to
+ * @returns A tuple of [accessor, updateCallback]
+ */
+export declare function useObject<T, K extends keyof T>(ref: MaybeAccessor<Ref.Ref<T> | undefined>, property: K): [Accessor<T[K] | undefined>, ObjectPropUpdateCallback<T[K]>];
+/**
+ * Subscribe to multiple Refs' target objects.
+ * Automatically dereferences each ref and handles async loading.
+ * Returns an accessor to an array of loaded snapshots (filtering out undefined values).
+ *
+ * This hook is useful for aggregate computations like counts or filtering
+ * across multiple refs without using .target directly.
+ *
+ * @param refs - Array of Refs to dereference and subscribe to (can be reactive)
+ * @returns Accessor to array of loaded target snapshots (excludes unloaded refs)
+ */
+export declare const useObjects: <T extends Obj.Unknown>(refs: MaybeAccessor<readonly Ref.Ref<T>[]>) => Accessor<T[]>;
+export {};
+//# sourceMappingURL=useObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useObject.d.ts","sourceRoot":"","sources":["../../../src/useObject.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAAE,KAAK,QAAQ,EAAqD,MAAM,UAAU,CAAC;AAE5F,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAItC,MAAM,WAAW,oBAAoB,CAAC,CAAC;IACrC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAC9C,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CACzD;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAChD,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC1D,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAC;CACrB;AAED;;;GAGG;AACH,KAAK,oBAAoB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,GACjE,CAAC,GACD,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,GACjC,CAAC,GAAG,SAAS,GACb,CAAC,CAAC;AAER;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjH;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,GAAG,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,GACzC,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEtD;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,EAC7C,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,GACpB,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnE;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,EAC7C,GAAG,EAAE,aAAa,CAAC,CAAC,GAAG,SAAS,CAAC,GAChC,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnE;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,EAAE,CAAC,SAAS,MAAM,CAAC,EAChE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,EACrB,QAAQ,EAAE,CAAC,GACV,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpD;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,GAAG,CAAC,OAAO,EAAE,CAAC,SAAS,MAAM,CAAC,EAChE,GAAG,EAAE,aAAa,CAAC,CAAC,GAAG,SAAS,CAAC,EACjC,QAAQ,EAAE,CAAC,GACV,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhE;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,EAC5C,GAAG,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAC9B,QAAQ,EAAE,CAAC,GACV,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhE;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,EAC5C,GAAG,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,EAC1C,QAAQ,EAAE,CAAC,GACV,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAiJhE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,GAAG,CAAC,OAAO,EAAE,MAAM,aAAa,CAAC,SAAS,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAG,QAAQ,CAAC,CAAC,EAAE,CAmE1G,CAAC"}

package/dist/types/src/useObject.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useObject.test.d.ts.map

package/dist/types/src/useObject.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useObject.test.d.ts","sourceRoot":"","sources":["../../../src/useObject.test.tsx"],"names":[],"mappings":""}

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

@@ -0,0 +1,14 @@
+import { type Accessor } from 'solid-js';
+import { type Database, type Entity, Filter, Query } from '@dxos/echo';
+type MaybeAccessor<T> = T | Accessor<T>;
+/**
+ * Create a reactive query subscription.
+ * Accepts either values or accessors for resource and query/filter.
+ *
+ * @param resource - The database or queryable resource (can be reactive)
+ * @param queryOrFilter - The query or filter to apply (can be reactive)
+ * @returns An accessor that returns the current query results
+ */
+export declare const useQuery: <T extends Entity.Any = Entity.Any>(resource: MaybeAccessor<Database.Queryable | undefined>, queryOrFilter: MaybeAccessor<Query.Any | Filter.Any>) => Accessor<T[]>;
+export {};
+//# sourceMappingURL=useQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useQuery.d.ts","sourceRoot":"","sources":["../../../src/useQuery.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,QAAQ,EAAqD,MAAM,UAAU,CAAC;AAE5F,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAIvE,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;AAExC;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,EACxD,UAAU,aAAa,CAAC,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,EACvD,eAAe,aAAa,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,KACnD,QAAQ,CAAC,CAAC,EAAE,CAqCd,CAAC"}

package/dist/types/src/useQuery.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useQuery.test.d.ts.map

package/dist/types/src/useQuery.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useQuery.test.d.ts","sourceRoot":"","sources":["../../../src/useQuery.test.tsx"],"names":[],"mappings":""}

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

@@ -0,0 +1,14 @@
+import { type Accessor } from 'solid-js';
+import { type Database, type Type } from '@dxos/echo';
+type MaybeAccessor<T> = T | Accessor<T>;
+/**
+ * Subscribe to and retrieve schema changes from a database's schema registry.
+ * Accepts either values or accessors for db and typename.
+ *
+ * @param db - The database instance (can be reactive)
+ * @param typename - The schema typename to query (can be reactive)
+ * @returns An accessor that returns the current schema or undefined
+ */
+export declare const useSchema: <T extends Type.Entity.Any = Type.Entity.Any>(db?: MaybeAccessor<Database.Database | undefined>, typename?: MaybeAccessor<string | undefined>) => Accessor<T | undefined>;
+export {};
+//# sourceMappingURL=useSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSchema.d.ts","sourceRoot":"","sources":["../../../src/useSchema.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,QAAQ,EAAqD,MAAM,UAAU,CAAC;AAE5F,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AAEtD,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;AAExC;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,EACnE,KAAK,aAAa,CAAC,QAAQ,CAAC,QAAQ,GAAG,SAAS,CAAC,EACjD,WAAW,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC,KAC3C,QAAQ,CAAC,CAAC,GAAG,SAAS,CAqCxB,CAAC"}

package/dist/types/src/useSchema.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useSchema.test.d.ts.map

package/dist/types/src/useSchema.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSchema.test.d.ts","sourceRoot":"","sources":["../../../src/useSchema.test.tsx"],"names":[],"mappings":""}