@dxos/halo-react 0.0.0 → 0.11.0

package/dist/lib/index.mjs

@@ -0,0 +1,124 @@
+import { createContext, useContext, useMemo } from "react";
+import { jsx } from "react/jsx-runtime";
+import { Atom, Result, useAtomValue } from "@effect-atom/atom-react";
+import * as Stream from "effect/Stream";
+import { Identity, Space } from "@dxos/halo";
+import * as Effect from "effect/Effect";
+import * as Option from "effect/Option";
+//#region src/HaloProvider.tsx
+/**
+* React context carrying the HALO services. Hooks read it, provide it into a service stream, and
+* surface the result through the default {@link Atom} runtime.
+*/
+var HaloServicesContext = createContext(void 0);
+/**
+* Provides the HALO services to the hook library. Wrap the application (or the subtree that uses
+* the hooks) in this provider. Replaces `ClientProvider` for HALO concerns.
+*/
+var HaloProvider = ({ services, children }) => /* @__PURE__ */ jsx(HaloServicesContext.Provider, {
+	value: services,
+	children
+});
+/**
+* Returns the HALO services context. Throws if no {@link HaloProvider} is above in the tree.
+*/
+var useHaloServices = () => {
+	const services = useContext(HaloServicesContext);
+	if (!services) throw new Error("Missing HaloProvider.");
+	return services;
+};
+//#endregion
+//#region src/useCredentials.ts
+var EMPTY$4 = [];
+/**
+* Returns the local identity's HALO credentials. Reactive: re-renders when credentials are
+* written. Replaces `@dxos/react-client`'s `useCredentials`.
+*/
+var useCredentials = () => {
+	const services = useHaloServices();
+	const atom = useMemo(() => Atom.make(Identity.credentials.pipe(Stream.provideContext(services))), [services]);
+	return Result.getOrElse(useAtomValue(atom), () => EMPTY$4);
+};
+//#endregion
+//#region src/useDevices.ts
+var EMPTY$3 = [];
+/**
+* Returns the devices belonging to the local identity. Reactive. Replaces
+* `@dxos/react-client`'s `useDevices`.
+*/
+var useDevices = () => {
+	const services = useHaloServices();
+	const atom = useMemo(() => Atom.make(Identity.devices.pipe(Stream.provideContext(services))), [services]);
+	return Result.getOrElse(useAtomValue(atom), () => EMPTY$3);
+};
+//#endregion
+//#region src/useIdentity.ts
+/**
+* Returns the local identity, or `undefined` if none exists. Reactive: re-renders when the
+* identity is created or its profile changes. Replaces `@dxos/react-client`'s `useIdentity`.
+*/
+var useIdentity = () => {
+	const services = useHaloServices();
+	const atom = useMemo(() => Atom.make(Identity.identity.pipe(Stream.provideContext(services), Stream.map(Option.getOrUndefined)), { initialValue: Option.getOrUndefined(Effect.runSync(Identity.getSnapshot.pipe(Effect.provide(services)))) }), [services]);
+	return Result.getOrElse(useAtomValue(atom), () => void 0);
+};
+//#endregion
+//#region src/useInvitations.ts
+var EMPTY$2 = [];
+/**
+* Returns the active (host-created) invitation flows for a space. Reactive. Replaces
+* `@dxos/react-client`'s `useSpaceInvitations`. Drive an individual flow through the
+* `Invitation` verbs (`events` / `authenticate` / `cancel` / `code`).
+*/
+var useSpaceInvitations = (spaceId) => {
+	const services = useHaloServices();
+	const atom = useMemo(() => Atom.make((spaceId ? Space.invitations(spaceId) : Stream.empty).pipe(Stream.provideContext(services))), [services, spaceId]);
+	return Result.getOrElse(useAtomValue(atom), () => EMPTY$2);
+};
+/**
+* Returns the active device-invitation flows for the local identity. Reactive. Replaces
+* `useHaloInvitations`.
+*/
+var useHaloInvitations = () => {
+	const services = useHaloServices();
+	const atom = useMemo(() => Atom.make(Identity.invitations.pipe(Stream.provideContext(services))), [services]);
+	return Result.getOrElse(useAtomValue(atom), () => EMPTY$2);
+};
+//#endregion
+//#region src/useMembers.ts
+var EMPTY$1 = [];
+/**
+* Returns the membership of a space. Reactive: re-renders on join/leave/role/presence changes.
+* Replaces `@dxos/react-client`'s `useMembers` (which took a `PublicKey`; this takes a
+* {@link SpaceId}).
+*/
+var useMembers = (spaceId) => {
+	const services = useHaloServices();
+	const atom = useMemo(() => Atom.make((spaceId ? Space.members(spaceId) : Stream.empty).pipe(Stream.provideContext(services))), [services, spaceId]);
+	return Result.getOrElse(useAtomValue(atom), () => EMPTY$1);
+};
+//#endregion
+//#region src/useSpaces.ts
+var EMPTY = [];
+/**
+* Returns the spaces known to the local identity. By default only `ready` spaces are returned;
+* pass `{ all: true }` for every space. Reactive. Replaces `@dxos/react-client`'s `useSpaces`.
+*/
+var useSpaces = ({ all = false } = {}) => {
+	const services = useHaloServices();
+	const atom = useMemo(() => Atom.make(Space.spaces.pipe(Stream.provideContext(services))), [services]);
+	const spaces = Result.getOrElse(useAtomValue(atom), () => EMPTY);
+	return useMemo(() => all ? spaces : spaces.filter((space) => space.state === "ready"), [spaces, all]);
+};
+/**
+* Resolves a single space by id, or `undefined`. Reactive. Replaces `useSpace`. Unlike the
+* legacy hook this takes a {@link SpaceId} only (no `PublicKey`).
+*/
+var useSpace = (spaceId) => {
+	const spaces = useSpaces({ all: true });
+	return useMemo(() => spaceId ? spaces.find((space) => space.id === spaceId) : void 0, [spaces, spaceId]);
+};
+//#endregion
+export { HaloProvider, useCredentials, useDevices, useHaloInvitations, useHaloServices, useIdentity, useMembers, useSpace, useSpaceInvitations, useSpaces };
+
+//# sourceMappingURL=index.mjs.map

package/dist/lib/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/HaloProvider.tsx","../../src/useCredentials.ts","../../src/useDevices.ts","../../src/useIdentity.ts","../../src/useInvitations.ts","../../src/useMembers.ts","../../src/useSpaces.ts"],"sourcesContent":["//\n// Copyright 2026 DXOS.org\n//\n\nimport * as Context from 'effect/Context';\nimport React, { type PropsWithChildren, createContext, useContext } from 'react';\n\nimport { type Identity, type Space } from '@dxos/halo';\n\n/**\n * The HALO services, as the tag union carried in an Effect service {@link Context.Context}.\n */\nexport type HaloServices = Identity.Service | Space.Service;\n\n/**\n * React context carrying the HALO services. Hooks read it, provide it into a service stream, and\n * surface the result through the default {@link Atom} runtime.\n */\nconst HaloServicesContext = createContext<Context.Context<HaloServices> | undefined>(undefined);\n\nexport type HaloProviderProps = PropsWithChildren<{\n  /**\n   * The HALO services context. Build it from a concrete backing — e.g. the client adapter's\n   * `makeIdentityService` / `makeSpaceService` from `@dxos/halo-adapter-client` — and pass it\n   * here.\n   */\n  services: Context.Context<HaloServices>;\n}>;\n\n/**\n * Provides the HALO services to the hook library. Wrap the application (or the subtree that uses\n * the hooks) in this provider. Replaces `ClientProvider` for HALO concerns.\n */\nexport const HaloProvider = ({ services, children }: HaloProviderProps) => (\n  <HaloServicesContext.Provider value={services}>{children}</HaloServicesContext.Provider>\n);\n\n/**\n * Returns the HALO services context. Throws if no {@link HaloProvider} is above in the tree.\n */\nexport const useHaloServices = (): Context.Context<HaloServices> => {\n  const services = useContext(HaloServicesContext);\n  if (!services) {\n    throw new Error('Missing HaloProvider.');\n  }\n  return services;\n};\n","//\n// Copyright 2026 DXOS.org\n//\n\nimport { Atom, Result, useAtomValue } from '@effect-atom/atom-react';\nimport * as Stream from 'effect/Stream';\nimport { useMemo } from 'react';\n\nimport { Identity } from '@dxos/halo';\n\nimport { useHaloServices } from './HaloProvider';\n\nconst EMPTY: readonly Identity.Credential[] = [];\n\n/**\n * Returns the local identity's HALO credentials. Reactive: re-renders when credentials are\n * written. Replaces `@dxos/react-client`'s `useCredentials`.\n */\nexport const useCredentials = (): readonly Identity.Credential[] => {\n  const services = useHaloServices();\n  const atom = useMemo(() => Atom.make(Identity.credentials.pipe(Stream.provideContext(services))), [services]);\n  return Result.getOrElse(useAtomValue(atom), () => EMPTY);\n};\n","//\n// Copyright 2026 DXOS.org\n//\n\nimport { Atom, Result, useAtomValue } from '@effect-atom/atom-react';\nimport * as Stream from 'effect/Stream';\nimport { useMemo } from 'react';\n\nimport { Identity } from '@dxos/halo';\n\nimport { useHaloServices } from './HaloProvider';\n\nconst EMPTY: readonly Identity.DeviceInfo[] = [];\n\n/**\n * Returns the devices belonging to the local identity. Reactive. Replaces\n * `@dxos/react-client`'s `useDevices`.\n */\nexport const useDevices = (): readonly Identity.DeviceInfo[] => {\n  const services = useHaloServices();\n  const atom = useMemo(() => Atom.make(Identity.devices.pipe(Stream.provideContext(services))), [services]);\n  return Result.getOrElse(useAtomValue(atom), () => EMPTY);\n};\n","//\n// Copyright 2026 DXOS.org\n//\n\nimport { Atom, Result, useAtomValue } from '@effect-atom/atom-react';\nimport * as Effect from 'effect/Effect';\nimport * as Option from 'effect/Option';\nimport * as Stream from 'effect/Stream';\nimport { useMemo } from 'react';\n\nimport { Identity } from '@dxos/halo';\n\nimport { useHaloServices } from './HaloProvider';\n\n/**\n * Returns the local identity, or `undefined` if none exists. Reactive: re-renders when the\n * identity is created or its profile changes. Replaces `@dxos/react-client`'s `useIdentity`.\n */\nexport const useIdentity = (): Identity.Info | undefined => {\n  const services = useHaloServices();\n  const atom = useMemo(\n    () =>\n      Atom.make(Identity.identity.pipe(Stream.provideContext(services), Stream.map(Option.getOrUndefined)), {\n        // The stream emits the current identity, but only after its first (async) subscription\n        // tick — until then the atom would sit at `Result.Initial` and callers would see \"no\n        // identity\" for the first render(s) even when one already exists. Seed it with the\n        // service's synchronous snapshot so the current identity is available on the very first\n        // render; the stream's value takes over as soon as it arrives (and covers post-mount\n        // create/update).\n        initialValue: Option.getOrUndefined(Effect.runSync(Identity.getSnapshot.pipe(Effect.provide(services)))),\n      }),\n    [services],\n  );\n  return Result.getOrElse(useAtomValue(atom), () => undefined);\n};\n","//\n// Copyright 2026 DXOS.org\n//\n\nimport { Atom, Result, useAtomValue } from '@effect-atom/atom-react';\nimport * as Stream from 'effect/Stream';\nimport { useMemo } from 'react';\n\nimport { Identity, type Invitation, Space } from '@dxos/halo';\nimport { type SpaceId } from '@dxos/keys';\n\nimport { useHaloServices } from './HaloProvider';\n\nconst EMPTY: readonly Invitation.Flow[] = [];\n\n/**\n * Returns the active (host-created) invitation flows for a space. Reactive. Replaces\n * `@dxos/react-client`'s `useSpaceInvitations`. Drive an individual flow through the\n * `Invitation` verbs (`events` / `authenticate` / `cancel` / `code`).\n */\nexport const useSpaceInvitations = (spaceId?: SpaceId): readonly Invitation.Flow[] => {\n  const services = useHaloServices();\n  const atom = useMemo(\n    () => Atom.make((spaceId ? Space.invitations(spaceId) : Stream.empty).pipe(Stream.provideContext(services))),\n    [services, spaceId],\n  );\n  return Result.getOrElse(useAtomValue(atom), () => EMPTY);\n};\n\n/**\n * Returns the active device-invitation flows for the local identity. Reactive. Replaces\n * `useHaloInvitations`.\n */\nexport const useHaloInvitations = (): readonly Invitation.Flow[] => {\n  const services = useHaloServices();\n  const atom = useMemo(() => Atom.make(Identity.invitations.pipe(Stream.provideContext(services))), [services]);\n  return Result.getOrElse(useAtomValue(atom), () => EMPTY);\n};\n","//\n// Copyright 2026 DXOS.org\n//\n\nimport { Atom, Result, useAtomValue } from '@effect-atom/atom-react';\nimport * as Stream from 'effect/Stream';\nimport { useMemo } from 'react';\n\nimport { Space } from '@dxos/halo';\nimport { type SpaceId } from '@dxos/keys';\n\nimport { useHaloServices } from './HaloProvider';\n\nconst EMPTY: readonly Space.Member[] = [];\n\n/**\n * Returns the membership of a space. Reactive: re-renders on join/leave/role/presence changes.\n * Replaces `@dxos/react-client`'s `useMembers` (which took a `PublicKey`; this takes a\n * {@link SpaceId}).\n */\nexport const useMembers = (spaceId?: SpaceId): readonly Space.Member[] => {\n  const services = useHaloServices();\n  const atom = useMemo(\n    () => Atom.make((spaceId ? Space.members(spaceId) : Stream.empty).pipe(Stream.provideContext(services))),\n    [services, spaceId],\n  );\n\n  return Result.getOrElse(useAtomValue(atom), () => EMPTY);\n};\n","//\n// Copyright 2026 DXOS.org\n//\n\nimport { Atom, Result, useAtomValue } from '@effect-atom/atom-react';\nimport * as Stream from 'effect/Stream';\nimport { useMemo } from 'react';\n\nimport { Space } from '@dxos/halo';\nimport { type SpaceId } from '@dxos/keys';\n\nimport { useHaloServices } from './HaloProvider';\n\nconst EMPTY: readonly Space.Info[] = [];\n\nexport type UseSpacesOptions = {\n  /** Include spaces that are not yet `ready` (default: only `ready` spaces). */\n  all?: boolean;\n};\n\n/**\n * Returns the spaces known to the local identity. By default only `ready` spaces are returned;\n * pass `{ all: true }` for every space. Reactive. Replaces `@dxos/react-client`'s `useSpaces`.\n */\nexport const useSpaces = ({ all = false }: UseSpacesOptions = {}): readonly Space.Info[] => {\n  const services = useHaloServices();\n  const atom = useMemo(() => Atom.make(Space.spaces.pipe(Stream.provideContext(services))), [services]);\n  const spaces = Result.getOrElse(useAtomValue(atom), () => EMPTY);\n  return useMemo(() => (all ? spaces : spaces.filter((space) => space.state === 'ready')), [spaces, all]);\n};\n\n/**\n * Resolves a single space by id, or `undefined`. Reactive. Replaces `useSpace`. Unlike the\n * legacy hook this takes a {@link SpaceId} only (no `PublicKey`).\n */\nexport const useSpace = (spaceId?: SpaceId): Space.Info | undefined => {\n  const spaces = useSpaces({ all: true });\n  return useMemo(() => (spaceId ? spaces.find((space) => space.id === spaceId) : undefined), [spaces, spaceId]);\n};\n"],"mappings":";;;;;;;;;;;;AAkBA,IAAM,sBAAsB,cAAyD,KAAA,CAAS;;;;;AAe9F,IAAa,gBAAgB,EAAE,UAAU,eACvC,oBAAC,oBAAoB,UAArB;CAA8B,OAAO;CAAW;AAAuC,CAAA;;;;AAMzF,IAAa,wBAAuD;CAClE,MAAM,WAAW,WAAW,mBAAmB;CAC/C,IAAI,CAAC,UACH,MAAM,IAAI,MAAM,uBAAuB;CAEzC,OAAO;AACT;;;AClCA,IAAM,UAAwC,CAAC;;;;;AAM/C,IAAa,uBAAuD;CAClE,MAAM,WAAW,gBAAgB;CACjC,MAAM,OAAO,cAAc,KAAK,KAAK,SAAS,YAAY,KAAK,OAAO,eAAe,QAAQ,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;CAC5G,OAAO,OAAO,UAAU,aAAa,IAAI,SAAS,OAAK;AACzD;;;ACVA,IAAM,UAAwC,CAAC;;;;;AAM/C,IAAa,mBAAmD;CAC9D,MAAM,WAAW,gBAAgB;CACjC,MAAM,OAAO,cAAc,KAAK,KAAK,SAAS,QAAQ,KAAK,OAAO,eAAe,QAAQ,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;CACxG,OAAO,OAAO,UAAU,aAAa,IAAI,SAAS,OAAK;AACzD;;;;;;;ACJA,IAAa,oBAA+C;CAC1D,MAAM,WAAW,gBAAgB;CACjC,MAAM,OAAO,cAET,KAAK,KAAK,SAAS,SAAS,KAAK,OAAO,eAAe,QAAQ,GAAG,OAAO,IAAI,OAAO,cAAc,CAAC,GAAG,EAOpG,cAAc,OAAO,eAAe,OAAO,QAAQ,SAAS,YAAY,KAAK,OAAO,QAAQ,QAAQ,CAAC,CAAC,CAAC,EACzG,CAAC,GACH,CAAC,QAAQ,CACX;CACA,OAAO,OAAO,UAAU,aAAa,IAAI,SAAS,KAAA,CAAS;AAC7D;;;ACrBA,IAAM,UAAoC,CAAC;;;;;;AAO3C,IAAa,uBAAuB,YAAkD;CACpF,MAAM,WAAW,gBAAgB;CACjC,MAAM,OAAO,cACL,KAAK,MAAM,UAAU,MAAM,YAAY,OAAO,IAAI,OAAO,MAAA,CAAO,KAAK,OAAO,eAAe,QAAQ,CAAC,CAAC,GAC3G,CAAC,UAAU,OAAO,CACpB;CACA,OAAO,OAAO,UAAU,aAAa,IAAI,SAAS,OAAK;AACzD;;;;;AAMA,IAAa,2BAAuD;CAClE,MAAM,WAAW,gBAAgB;CACjC,MAAM,OAAO,cAAc,KAAK,KAAK,SAAS,YAAY,KAAK,OAAO,eAAe,QAAQ,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;CAC5G,OAAO,OAAO,UAAU,aAAa,IAAI,SAAS,OAAK;AACzD;;;ACxBA,IAAM,UAAiC,CAAC;;;;;;AAOxC,IAAa,cAAc,YAA+C;CACxE,MAAM,WAAW,gBAAgB;CACjC,MAAM,OAAO,cACL,KAAK,MAAM,UAAU,MAAM,QAAQ,OAAO,IAAI,OAAO,MAAA,CAAO,KAAK,OAAO,eAAe,QAAQ,CAAC,CAAC,GACvG,CAAC,UAAU,OAAO,CACpB;CAEA,OAAO,OAAO,UAAU,aAAa,IAAI,SAAS,OAAK;AACzD;;;ACfA,IAAM,QAA+B,CAAC;;;;;AAWtC,IAAa,aAAa,EAAE,MAAM,UAA4B,CAAC,MAA6B;CAC1F,MAAM,WAAW,gBAAgB;CACjC,MAAM,OAAO,cAAc,KAAK,KAAK,MAAM,OAAO,KAAK,OAAO,eAAe,QAAQ,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;CACpG,MAAM,SAAS,OAAO,UAAU,aAAa,IAAI,SAAS,KAAK;CAC/D,OAAO,cAAe,MAAM,SAAS,OAAO,QAAQ,UAAU,MAAM,UAAU,OAAO,GAAI,CAAC,QAAQ,GAAG,CAAC;AACxG;;;;;AAMA,IAAa,YAAY,YAA8C;CACrE,MAAM,SAAS,UAAU,EAAE,KAAK,KAAK,CAAC;CACtC,OAAO,cAAe,UAAU,OAAO,MAAM,UAAU,MAAM,OAAO,OAAO,IAAI,KAAA,GAAY,CAAC,QAAQ,OAAO,CAAC;AAC9G"}

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

@@ -1 +1 @@
-{"version":3,"file":"useIdentity.d.ts","sourceRoot":"","sources":["../../../src/useIdentity.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;GAGG;AACH,eAAO,MAAM,WAAW,QAAO,QAAQ,CAAC,IAAI,GAAG,SAO9C,CAAC"}
+{"version":3,"file":"useIdentity.d.ts","sourceRoot":"","sources":["../../../src/useIdentity.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;GAGG;AACH,eAAO,MAAM,WAAW,QAAO,QAAQ,CAAC,IAAI,GAAG,SAgB9C,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"useMembers.d.ts","sourceRoot":"","sources":["../../../src/useMembers.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AAM1C;;;;GAIG;AACH,eAAO,MAAM,UAAU,aAAc,OAAO,KAAG,SAAS,KAAK,CAAC,MAAM,EAOnE,CAAC"}
+{"version":3,"file":"useMembers.d.ts","sourceRoot":"","sources":["../../../src/useMembers.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AAM1C;;;;GAIG;AACH,eAAO,MAAM,UAAU,aAAc,OAAO,KAAG,SAAS,KAAK,CAAC,MAAM,EAQnE,CAAC"}