@dxos/echo-react 0.8.4-main.69d29f4 → 0.8.4-main.6fa680abb7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/neutral/index.mjs.map +7 -0
- package/dist/lib/{browser → neutral}/meta.json +1 -1
- package/dist/types/src/useSchema.d.ts +1 -1
- package/dist/types/src/useSchema.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +7 -8
- package/src/useObject.test.tsx +43 -1
- package/src/useSchema.ts +1 -1
- package/dist/lib/browser/index.mjs.map +0 -7
- package/dist/lib/node-esm/index.mjs +0 -155
- package/dist/lib/node-esm/index.mjs.map +0 -7
- package/dist/lib/node-esm/meta.json +0 -1
- /package/dist/lib/{browser → neutral}/index.mjs +0 -0
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../../src/useQuery.ts", "../../../src/useSchema.ts", "../../../src/useObject.ts"],
|
|
4
|
+
"sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { useMemo, useSyncExternalStore } from 'react';\n\nimport { type Database, type Entity, Filter, Query } from '@dxos/echo';\n\nconst EMPTY_ARRAY: never[] = [];\n\nconst noop = () => {};\n\ninterface UseQueryFn {\n <Q extends Query.Any, O extends Entity.Entity<Query.Type<Q>> = Entity.Entity<Query.Type<Q>>>(\n resource: Database.Queryable | undefined,\n query: Q,\n ): O[];\n\n <F extends Filter.Any, O extends Entity.Entity<Filter.Type<F>> = Entity.Entity<Filter.Type<F>>>(\n resource: Database.Queryable | undefined,\n filter: F,\n ): O[];\n}\n\n/**\n * Create subscription.\n */\nexport const useQuery: UseQueryFn = (\n resource: Database.Queryable | undefined,\n queryOrFilter: Query.Any | Filter.Any,\n): Entity.Any[] => {\n const query = Filter.is(queryOrFilter) ? Query.select(queryOrFilter) : queryOrFilter;\n\n const { getObjects, subscribe } = useMemo(() => {\n let queryResult = undefined;\n if (resource) {\n queryResult = resource.query(query);\n }\n\n let subscribed = false;\n return {\n getObjects: () => (subscribed && queryResult ? queryResult.results : EMPTY_ARRAY),\n subscribe: (cb: () => void) => {\n subscribed = true;\n const unsubscribe = queryResult?.subscribe(cb) ?? noop;\n return () => {\n unsubscribe?.();\n subscribed = false;\n };\n },\n };\n }, [resource, JSON.stringify(query.ast)]);\n\n // https://beta.reactjs.org/reference/react/useSyncExternalStore\n // NOTE: This hook will resubscribe whenever the callback passed to the first argument changes; make sure it is stable.\n const objects = useSyncExternalStore<Entity.Any[]>(subscribe, getObjects);\n return objects;\n};\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport { useMemo, useSyncExternalStore } from 'react';\n\nimport { type Database, type Type } from '@dxos/echo';\n\n/**\n * Subscribe to and retrieve schema changes from a space's schema registry.\n */\nexport const useSchema = <T extends Type.AnyEntity = Type.AnyEntity>(\n db?: Database.Database,\n typename?: string,\n): T | undefined => {\n const { subscribe, getSchema } = useMemo(() => {\n if (!typename || !db) {\n return {\n subscribe: () => () => {},\n getSchema: () => undefined,\n };\n }\n\n const query = db.schemaRegistry.query({ typename, location: ['database', 'runtime'] });\n const initialResult = query.runSync()[0];\n let currentSchema = initialResult;\n\n return {\n subscribe: (onStoreChange: () => void) => {\n const unsubscribe = query.subscribe(() => {\n currentSchema = query.results[0];\n onStoreChange();\n });\n\n return unsubscribe;\n },\n getSchema: () => currentSchema,\n };\n }, [typename, db]);\n\n return useSyncExternalStore(subscribe, getSchema) as T;\n};\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport * as Atom from '@effect-atom/atom/Atom';\nimport { useAtomValue } from '@effect-atom/atom-react';\nimport { useCallback, useMemo } from 'react';\n\nimport { Obj, Ref } from '@dxos/echo';\nimport { AtomObj } from '@dxos/echo-atom';\n\nexport interface ObjectUpdateCallback<T> {\n (update: (obj: Obj.Mutable<T>) => void): void;\n (update: (obj: Obj.Mutable<T>) => Obj.Mutable<T>): void;\n}\n\nexport interface ObjectPropUpdateCallback<T> {\n (update: (value: Obj.Mutable<T>) => void): void;\n (update: (value: Obj.Mutable<T>) => Obj.Mutable<T>): void;\n (newValue: T): void;\n}\n\nexport const useObject: {\n /**\n * Hook to subscribe to a Ref's target object.\n * Automatically dereferences the ref and handles async loading.\n * Returns a snapshot (undefined if the ref hasn't loaded yet).\n *\n * @param ref - The Ref to dereference and subscribe to\n * @returns The current target snapshot (or undefined if not loaded) and update callback\n */\n <T extends Obj.Unknown>(ref: Ref.Ref<T>): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to a Ref's target object that may be undefined.\n * Returns a snapshot (undefined if the ref is undefined or hasn't loaded yet).\n *\n * @param ref - The Ref to dereference and subscribe to (can be undefined)\n * @returns The current target snapshot (or undefined) and update callback\n */\n <T extends Obj.Unknown>(ref: Ref.Ref<T> | undefined): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to an entire Echo object.\n * Returns a snapshot of the current object value and automatically re-renders when the object changes.\n *\n * @param obj - The Echo object to subscribe to (objects only, not relations)\n * @returns The current object snapshot and update callback\n */\n <T extends Obj.Unknown>(obj: T): [Obj.Snapshot<T>, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to an entire Echo object that may be undefined.\n * Returns a snapshot (undefined if the object is undefined).\n *\n * @param obj - The Echo object to subscribe to (can be undefined, objects only)\n * @returns The current object snapshot (or undefined) and update callback\n */\n <T extends Obj.Unknown>(obj: T | undefined): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to an Echo object or Ref.\n * Handles both cases - if passed a Ref, dereferences it and subscribes to the target.\n * Returns a snapshot (undefined if ref hasn't loaded).\n *\n * @param objOrRef - The Echo object or Ref to subscribe to\n * @returns The current object snapshot (or undefined) and update callback\n */\n <T extends Obj.Unknown>(objOrRef: T | Ref.Ref<T>): [Obj.Snapshot<T> | undefined, ObjectUpdateCallback<T>];\n\n /**\n * Hook to subscribe to a specific property of an Echo object.\n * Returns the current property value and automatically re-renders when the property changes.\n *\n * @param obj - The Echo object to subscribe to (objects only, not relations)\n * @param property - Property key to subscribe to\n * @returns The current property value and update callback\n */\n <T extends Obj.Unknown, K extends keyof T>(obj: T, property: K): [T[K], ObjectPropUpdateCallback<T[K]>];\n\n /**\n * Hook to subscribe to a specific property of an Echo object that may be undefined.\n * Returns undefined if the object is undefined.\n *\n * @param obj - The Echo object to subscribe to (can be undefined, objects only)\n * @param property - Property key to subscribe to\n * @returns The current property value (or undefined) and update callback\n */\n <T extends Obj.Unknown, K extends keyof T>(\n obj: T | undefined,\n property: K,\n ): [T[K] | undefined, ObjectPropUpdateCallback<T[K]>];\n\n /**\n * Hook to subscribe to a specific property of a Ref's target object.\n * Automatically dereferences the ref and handles async loading.\n * Returns undefined if the ref hasn't loaded yet.\n *\n * @param ref - The Ref to dereference and subscribe to\n * @param property - Property key to subscribe to\n * @returns The current property value (or undefined if not loaded) and update callback\n */\n <T, K extends keyof T>(ref: Ref.Ref<T>, property: K): [T[K] | undefined, ObjectPropUpdateCallback<T[K]>];\n\n /**\n * Hook to subscribe to a specific property of a Ref's target object that may be undefined.\n * Returns undefined if the ref is undefined or hasn't loaded yet.\n *\n * @param ref - The Ref to dereference and subscribe to (can be undefined)\n * @param property - Property key to subscribe to\n * @returns The current property value (or undefined) and update callback\n */\n <T, K extends keyof T>(ref: Ref.Ref<T> | undefined, property: K): [T[K] | undefined, ObjectPropUpdateCallback<T[K]>];\n} = (<T extends Obj.Unknown, K extends keyof T>(objOrRef: T | Ref.Ref<T> | undefined, property?: K): any => {\n // Get the live object for the callback (refs need to dereference).\n const isRef = Ref.isRef(objOrRef);\n const liveObj = isRef ? (objOrRef as Ref.Ref<T>)?.target : (objOrRef as T | undefined);\n\n const callback: ObjectPropUpdateCallback<unknown> = useCallback(\n (updateOrValue: unknown | ((obj: unknown) => unknown)) => {\n // Get current target for refs (may have loaded since render).\n const obj = isRef ? (objOrRef as Ref.Ref<T>)?.target : liveObj;\n if (obj === undefined) {\n return;\n }\n Obj.change(obj, (o: any) => {\n if (typeof updateOrValue === 'function') {\n const returnValue = updateOrValue(property !== undefined ? o[property] : o);\n if (returnValue !== undefined) {\n if (property === undefined) {\n throw new Error('Cannot re-assign the entire object');\n }\n o[property] = returnValue;\n }\n } else {\n if (property === undefined) {\n throw new Error('Cannot re-assign the entire object');\n }\n o[property] = updateOrValue;\n }\n });\n },\n [objOrRef, property, isRef, liveObj],\n );\n\n if (property !== undefined) {\n // For property subscriptions on refs, we subscribe to trigger re-render on load.\n // TODO(dxos): Property subscriptions on refs may not update correctly until the ref loads.\n useObjectValue(objOrRef);\n return [useObjectProperty(liveObj, property as any), callback];\n }\n return [useObjectValue(objOrRef), callback];\n}) as any;\n\n/**\n * Internal hook for subscribing to an Echo object or Ref.\n * AtomObj.make handles both objects and refs, returning snapshots.\n */\nconst useObjectValue = <T extends Obj.Unknown>(objOrRef: T | Ref.Ref<T> | undefined): Obj.Snapshot<T> | undefined => {\n const atom = useMemo(() => AtomObj.make(objOrRef), [objOrRef]);\n return useAtomValue(atom) as Obj.Snapshot<T> | undefined;\n};\n\n/**\n * Internal hook for subscribing to a specific property of an Echo object.\n * Uses useAtomValue directly since makeProperty returns the value directly.\n */\nconst useObjectProperty = <T extends Obj.Unknown, K extends keyof T>(\n obj: T | undefined,\n property: K,\n): T[K] | undefined => {\n const atom = useMemo(() => AtomObj.makeProperty(obj, property), [obj, property]);\n return useAtomValue(atom);\n};\n\n/**\n * Hook to subscribe to multiple Refs' target objects.\n * Automatically dereferences each ref and handles async loading.\n * Returns an array of loaded snapshots (filtering out undefined values).\n *\n * This hook is useful for aggregate computations like counts or filtering\n * across multiple refs without using .target directly.\n *\n * @param refs - Array of Refs to dereference and subscribe to\n * @returns Array of loaded target snapshots (excludes unloaded refs)\n */\nexport const useObjects = <T extends Obj.Unknown>(refs: readonly Ref.Ref<T>[]): Obj.Snapshot<T>[] => {\n const atom = useMemo(\n () =>\n Atom.make((get) => {\n const results: Obj.Snapshot<T>[] = [];\n for (const ref of refs) {\n const value = get(AtomObj.make(ref));\n if (value !== undefined) {\n results.push(value as Obj.Snapshot<T>);\n }\n }\n return results;\n }),\n [refs],\n );\n return useAtomValue(atom);\n};\n"],
|
|
5
|
+
"mappings": ";AAIA,SAASA,SAASC,4BAA4B;AAE9C,SAAqCC,QAAQC,aAAa;AAE1D,IAAMC,cAAuB,CAAA;AAE7B,IAAMC,OAAO,MAAA;AAAO;AAiBb,IAAMC,WAAuB,CAClCC,UACAC,kBAAAA;AAEA,QAAMC,QAAQC,OAAOC,GAAGH,aAAAA,IAAiBI,MAAMC,OAAOL,aAAAA,IAAiBA;AAEvE,QAAM,EAAEM,YAAYC,UAAS,IAAKC,QAAQ,MAAA;AACxC,QAAIC,cAAcC;AAClB,QAAIX,UAAU;AACZU,oBAAcV,SAASE,MAAMA,KAAAA;IAC/B;AAEA,QAAIU,aAAa;AACjB,WAAO;MACLL,YAAY,MAAOK,cAAcF,cAAcA,YAAYG,UAAUhB;MACrEW,WAAW,CAACM,OAAAA;AACVF,qBAAa;AACb,cAAMG,cAAcL,aAAaF,UAAUM,EAAAA,KAAOhB;AAClD,eAAO,MAAA;AACLiB,wBAAAA;AACAH,uBAAa;QACf;MACF;IACF;EACF,GAAG;IAACZ;IAAUgB,KAAKC,UAAUf,MAAMgB,GAAG;GAAE;AAIxC,QAAMC,UAAUC,qBAAmCZ,WAAWD,UAAAA;AAC9D,SAAOY;AACT;;;ACrDA,SAASE,WAAAA,UAASC,wBAAAA,6BAA4B;AAOvC,IAAMC,YAAY,CACvBC,IACAC,aAAAA;AAEA,QAAM,EAAEC,WAAWC,UAAS,IAAKC,SAAQ,MAAA;AACvC,QAAI,CAACH,YAAY,CAACD,IAAI;AACpB,aAAO;QACLE,WAAW,MAAM,MAAA;QAAO;QACxBC,WAAW,MAAME;MACnB;IACF;AAEA,UAAMC,QAAQN,GAAGO,eAAeD,MAAM;MAAEL;MAAUO,UAAU;QAAC;QAAY;;IAAW,CAAA;AACpF,UAAMC,gBAAgBH,MAAMI,QAAO,EAAG,CAAA;AACtC,QAAIC,gBAAgBF;AAEpB,WAAO;MACLP,WAAW,CAACU,kBAAAA;AACV,cAAMC,cAAcP,MAAMJ,UAAU,MAAA;AAClCS,0BAAgBL,MAAMQ,QAAQ,CAAA;AAC9BF,wBAAAA;QACF,CAAA;AAEA,eAAOC;MACT;MACAV,WAAW,MAAMQ;IACnB;EACF,GAAG;IAACV;IAAUD;GAAG;AAEjB,SAAOe,sBAAqBb,WAAWC,SAAAA;AACzC;;;ACrCA,YAAYa,UAAU;AACtB,SAASC,oBAAoB;AAC7B,SAASC,aAAaC,WAAAA,gBAAe;AAErC,SAASC,KAAKC,WAAW;AACzB,SAASC,eAAe;AAajB,IAAMC,YA2FR,CAA2CC,UAAsCC,aAAAA;AAEpF,QAAMC,QAAQC,IAAID,MAAMF,QAAAA;AACxB,QAAMI,UAAUF,QAASF,UAAyBK,SAAUL;AAE5D,QAAMM,WAA8CC,YAClD,CAACC,kBAAAA;AAEC,UAAMC,MAAMP,QAASF,UAAyBK,SAASD;AACvD,QAAIK,QAAQC,QAAW;AACrB;IACF;AACAC,QAAIC,OAAOH,KAAK,CAACI,MAAAA;AACf,UAAI,OAAOL,kBAAkB,YAAY;AACvC,cAAMM,cAAcN,cAAcP,aAAaS,SAAYG,EAAEZ,QAAAA,IAAYY,CAAAA;AACzE,YAAIC,gBAAgBJ,QAAW;AAC7B,cAAIT,aAAaS,QAAW;AAC1B,kBAAM,IAAIK,MAAM,oCAAA;UAClB;AACAF,YAAEZ,QAAAA,IAAYa;QAChB;MACF,OAAO;AACL,YAAIb,aAAaS,QAAW;AAC1B,gBAAM,IAAIK,MAAM,oCAAA;QAClB;AACAF,UAAEZ,QAAAA,IAAYO;MAChB;IACF,CAAA;EACF,GACA;IAACR;IAAUC;IAAUC;IAAOE;GAAQ;AAGtC,MAAIH,aAAaS,QAAW;AAG1BM,mBAAehB,QAAAA;AACf,WAAO;MAACiB,kBAAkBb,SAASH,QAAAA;MAAkBK;;EACvD;AACA,SAAO;IAACU,eAAehB,QAAAA;IAAWM;;AACpC;AAMA,IAAMU,iBAAiB,CAAwBhB,aAAAA;AAC7C,QAAMkB,OAAOC,SAAQ,MAAMC,QAAQC,KAAKrB,QAAAA,GAAW;IAACA;GAAS;AAC7D,SAAOsB,aAAaJ,IAAAA;AACtB;AAMA,IAAMD,oBAAoB,CACxBR,KACAR,aAAAA;AAEA,QAAMiB,OAAOC,SAAQ,MAAMC,QAAQG,aAAad,KAAKR,QAAAA,GAAW;IAACQ;IAAKR;GAAS;AAC/E,SAAOqB,aAAaJ,IAAAA;AACtB;AAaO,IAAMM,aAAa,CAAwBC,SAAAA;AAChD,QAAMP,OAAOC,SACX,MACOE,UAAK,CAACK,QAAAA;AACT,UAAMC,UAA6B,CAAA;AACnC,eAAWC,OAAOH,MAAM;AACtB,YAAMI,QAAQH,IAAIN,QAAQC,KAAKO,GAAAA,CAAAA;AAC/B,UAAIC,UAAUnB,QAAW;AACvBiB,gBAAQG,KAAKD,KAAAA;MACf;IACF;AACA,WAAOF;EACT,CAAA,GACF;IAACF;GAAK;AAER,SAAOH,aAAaJ,IAAAA;AACtB;",
|
|
6
|
+
"names": ["useMemo", "useSyncExternalStore", "Filter", "Query", "EMPTY_ARRAY", "noop", "useQuery", "resource", "queryOrFilter", "query", "Filter", "is", "Query", "select", "getObjects", "subscribe", "useMemo", "queryResult", "undefined", "subscribed", "results", "cb", "unsubscribe", "JSON", "stringify", "ast", "objects", "useSyncExternalStore", "useMemo", "useSyncExternalStore", "useSchema", "db", "typename", "subscribe", "getSchema", "useMemo", "undefined", "query", "schemaRegistry", "location", "initialResult", "runSync", "currentSchema", "onStoreChange", "unsubscribe", "results", "useSyncExternalStore", "Atom", "useAtomValue", "useCallback", "useMemo", "Obj", "Ref", "AtomObj", "useObject", "objOrRef", "property", "isRef", "Ref", "liveObj", "target", "callback", "useCallback", "updateOrValue", "obj", "undefined", "Obj", "change", "o", "returnValue", "Error", "useObjectValue", "useObjectProperty", "atom", "useMemo", "AtomObj", "make", "useAtomValue", "makeProperty", "useObjects", "refs", "get", "results", "ref", "value", "push"]
|
|
7
|
+
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"inputs":{"src/useQuery.ts":{"bytes":5192,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo","kind":"import-statement","external":true}],"format":"esm"},"src/useSchema.ts":{"bytes":
|
|
1
|
+
{"inputs":{"src/useQuery.ts":{"bytes":5192,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo","kind":"import-statement","external":true}],"format":"esm"},"src/useSchema.ts":{"bytes":4013,"imports":[{"path":"react","kind":"import-statement","external":true}],"format":"esm"},"src/useObject.ts":{"bytes":17411,"imports":[{"path":"@effect-atom/atom/Atom","kind":"import-statement","external":true},{"path":"@effect-atom/atom-react","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo","kind":"import-statement","external":true},{"path":"@dxos/echo-atom","kind":"import-statement","external":true}],"format":"esm"},"src/index.ts":{"bytes":638,"imports":[{"path":"src/useQuery.ts","kind":"import-statement","original":"./useQuery"},{"path":"src/useSchema.ts","kind":"import-statement","original":"./useSchema"},{"path":"src/useObject.ts","kind":"import-statement","original":"./useObject"}],"format":"esm"}},"outputs":{"dist/lib/neutral/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":15150},"dist/lib/neutral/index.mjs":{"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@effect-atom/atom/Atom","kind":"import-statement","external":true},{"path":"@effect-atom/atom-react","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo","kind":"import-statement","external":true},{"path":"@dxos/echo-atom","kind":"import-statement","external":true}],"exports":["useObject","useObjects","useQuery","useSchema"],"entryPoint":"src/index.ts","inputs":{"src/useQuery.ts":{"bytesInOutput":921},"src/index.ts":{"bytesInOutput":0},"src/useSchema.ts":{"bytesInOutput":889},"src/useObject.ts":{"bytesInOutput":1979}},"bytes":3948}}}
|
|
@@ -2,5 +2,5 @@ import { type Database, type Type } from '@dxos/echo';
|
|
|
2
2
|
/**
|
|
3
3
|
* Subscribe to and retrieve schema changes from a space's schema registry.
|
|
4
4
|
*/
|
|
5
|
-
export declare const useSchema: <T extends Type.
|
|
5
|
+
export declare const useSchema: <T extends Type.AnyEntity = Type.AnyEntity>(db?: Database.Database, typename?: string) => T | undefined;
|
|
6
6
|
//# sourceMappingURL=useSchema.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useSchema.d.ts","sourceRoot":"","sources":["../../../src/useSchema.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,IAAI,CAAC,
|
|
1
|
+
{"version":3,"file":"useSchema.d.ts","sourceRoot":"","sources":["../../../src/useSchema.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,EACjE,KAAK,QAAQ,CAAC,QAAQ,EACtB,WAAW,MAAM,KAChB,CAAC,GAAG,SA2BN,CAAC"}
|