@abloatai/ablo 0.11.1 → 0.12.0

package/docs/integration-guide.md

@@ -44,13 +44,18 @@ objects by hand.
 
 ## Your Database
 
-Every schema model is backed by **your own database**. You expose a signed Data
-Source endpoint; Ablo coordinates each write and your app commits it to your
-Postgres. The SDK call shape is the same everywhere.
+Every schema model is backed by **your own database**. The SDK call shape is the
+same everywhere.
 
-Do not pass a database URL to `Ablo(...)`. Application and agent code use
-`ABLO_API_KEY`. If your database stays canonical, expose a signed Data Source
-endpoint from your app and keep the database credentials inside your app.
+In this guide — an app that already owns its backend and database — keep
+`DATABASE_URL` inside your app and expose a signed Data Source endpoint: Ablo
+coordinates each write and your app commits it to your Postgres. Do not pass
+`databaseUrl` to `Ablo(...)` here; application and agent code use `ABLO_API_KEY`.
+
+If instead you want Ablo to connect to your Postgres directly, pass `databaseUrl`
+(a live, server-only option) to `Ablo(...)`. That and the sandbox-only `apiKey`
+shape are the other two start states — [Connect Your Database](./data-sources.md)
+is the single source of truth for all three.
 
 ## Test With Sandboxes
 
@@ -94,12 +99,13 @@ import { defineSchema, model, z } from '@abloatai/ablo/schema';
 export const schema = defineSchema(
   {
     weatherReports: model({
-      id: z.string(),
+      // Reserved fields (id, createdAt, updatedAt, organizationId, createdBy)
+      // are SDK-provided automatically — never declare them. Declare only your
+      // own fields.
       projectId: z.string(),
       location: z.string(),
       status: z.enum(['pending', 'ready']),
       assigneeId: z.string().nullable(),
-      updatedAt: z.string(),
     }),
   },
   {
@@ -169,7 +175,7 @@ export const ablo = Ablo({
 Browser apps should use the React provider or a scoped session token, not a
 server API key in the bundle. Build the client first, then hand it to the
 provider — `AbloProvider` takes `{ client, userId?, onError?, fallback? }`, and
-nothing else (`schema`, `teamIds`, `scope`, and `authEndpoint` all live on the
+nothing else (`schema`, `teamIds`, and `apiKey` all live on the
 client now).
 
 ```tsx
@@ -179,7 +185,10 @@ import { schema } from '@/ablo/schema';
 
 // The browser never holds the API key. The client mints a short-lived token
 // from your session route (see below) and refreshes it before expiry.
-export const ablo = Ablo({ schema, authEndpoint: '/api/ablo-session' });
+export const ablo = Ablo({
+  schema,
+  apiKey: () => fetch('/api/ablo-session').then((r) => r.text()),
+});
 ```
 
 ```tsx

package/docs/migration.md

@@ -113,6 +113,11 @@ const ablo = Ablo({ schema, apiKey: process.env.ABLO_API_KEY, transport: 'http'
 await ablo.tasks.update({ id, data: { status: 'done' } });
 ```
 
+> **Minting still needs the stateful client.** `sessions.create(...)` is not on
+> the `transport: 'http'` surface. Keep a default-transport `server` client for
+> minting short-lived credentials (see the 0.9.2 example below), and use the
+> http client for the per-request reads and writes.
+
 ---
 
 ## 0.9.2 — `turn` / agent-`tasks` removed; `intents` deprecated
@@ -135,8 +140,10 @@ helper, and the agent/task type family (`Agent`, `AgentOptions`,
 ```diff
 - const turn = await engine.beginTurn();
 - await Ablo({ apiKey }).agent(agentId, opts).run(prompt, handler);
-+ // Mint a scoped credential, then claim + write under it.
-+ const { token } = await ablo.sessions.create({ agent: { id: agentId } });
++ // Mint a scoped credential from a stateful (default-transport) server client —
++ // sessions.create lives on the stateful client, not on transport: 'http'.
++ const server = Ablo({ schema, apiKey: process.env.ABLO_API_KEY });
++ const { token } = await server.sessions.create({ agent: { id: agentId } });
 + const agent = Ablo({ schema, apiKey: token });
 + await using claim = await agent.tasks.claim({ id });
 + await agent.tasks.update({ id, data: { status: 'done' }, wait: 'confirmed' });
@@ -277,7 +284,8 @@ One provider component now owns the full React lifecycle. `<SyncProvider>`,
 - <SyncProvider store={sync._store} organizationId={orgId}>
 -   <AbloProvider ablo={ablo}>{children}</AbloProvider>
 - </SyncProvider>
-+ <AbloProvider schema={schema} url={url} userId={userId} organizationId={orgId}>
++ const ablo = Ablo({ schema, apiKey });
++ <AbloProvider client={ablo}>
 +   {children}
 + </AbloProvider>
 ```

package/docs/quickstart.md

@@ -57,6 +57,9 @@ export const schema = defineSchema({
 });
 ```
 
+**Reserved fields** — `id`, `createdAt`, `updatedAt`, `organizationId`, and
+`createdBy` are provided by the SDK automatically. Don't declare them in your
+`model(...)` fields; declare only your own.
 
 The schema is registered once (init scaffolds `ablo/register.ts` for you), and
 every type is one parameter away — no `typeof schema` re-stating, anywhere:
@@ -210,8 +213,9 @@ and you write the usual way with `ablo.<model>.update({ id, data })`.
 Claims don't lock. If another writer holds the row, `claim` waits for them,
 re-reads the fresh row, then hands it to you — so two writers serialize instead
 of clobbering. Normal reads still work while the claim is held. If a server read
-should not return a row while someone else is mid-edit, pass `ifClaimed: 'wait'`
-to wait for the claim to clear, or `ifClaimed: 'fail'` to error out instead.
+should not return a row while someone else is mid-edit, pass `ifClaimed: 'fail'`
+to error out instead. Reads never block on a claim — to wait for a row to free
+up, `claim({ id })` it (the claim queues fairly behind the holder).
 Call `handle.release()` when your work is done.
 
 ```ts

package/docs/react.md

@@ -31,7 +31,7 @@ import { schema } from '@/ablo/schema';
 // from your own server route (see Identity below).
 export const ablo = Ablo({
   schema,
-  authEndpoint: '/api/ablo-session',
+  apiKey: () => fetch('/api/ablo-session').then((r) => r.text()),
 });
 ```
 
@@ -65,13 +65,13 @@ export function Providers({
 
 | Prop        | Default          | Purpose                                                                                                   |
 | ----------- | ---------------- | --------------------------------------------------------------------------------------------------------- |
-| `client`    | —                | **Required.** The `Ablo({ schema, authEndpoint })` instance. It carries the schema and connection config. |
+| `client`    | —                | **Required.** The `Ablo({ schema, apiKey })` instance. It carries the schema and connection config. |
 | `userId`    | resolved from auth | App participant id for app-owned fields and your `identityRoles`. Not the security boundary.            |
 | `fallback`  | neutral spinner  | Rendered during the *first* bootstrap only. Pass a branded skeleton, `null`, or `'passthrough'`.          |
 | `onError`   | —                | Engine / WebSocket / bootstrap errors. Wire to Sentry / Datadog.                                          |
 
 Everything that used to be a provider prop — `schema`, `url`, `apiKey`,
-`teamIds`, `syncGroups`/`scope`, `persistence`, `bootstrapMode` — now lives on
+`teamIds`, `syncGroups`, `persistence`, `bootstrapMode` — now lives on
 the `Ablo({ ... })` client you build before mounting the provider. Where the
 identity comes from, and why the API key never reaches the browser, is the whole
 of [Identity & Sync Groups](./identity.md) — read that if it isn't obvious how

package/docs/schema-contract.md

@@ -49,6 +49,20 @@ The model key (`weatherReports`) becomes the client namespace
 contract. You should not create a parallel string-keyed write path for the same
 data.
 
+### Reserved fields
+
+The SDK provides these on every row automatically — do **not** declare them in
+your `model(...)` fields:
+
+- `id`
+- `createdAt`
+- `updatedAt`
+- `organizationId`
+- `createdBy`
+
+Declare only your own fields; the reserved ones are still present on the row and
+readable, you just don't author them.
+
 ## Reads and writes
 
 Use async reads when the row may not be local:
@@ -88,12 +102,16 @@ the fresh row. Reads stay open; only acting on the row serializes.
 
 ## Storage boundary
 
-Every schema model is backed by your own database through a Data Source — Ablo
-coordinates each write and your app commits it to your Postgres.
+Every schema model is backed by your own database. There are three start states,
+all covered in [Connect Your Database](./data-sources.md) (the single source of
+truth): the sandbox (`apiKey` only, no database), a direct connection string
+(`databaseUrl` passed to `Ablo(...)`, a live, server-only option), or a signed
+Data Source endpoint where your app keeps the database credential and commits
+each write itself.
 
-Do not pass a database URL to `Ablo(...)`. Trusted runtimes use `ABLO_API_KEY`.
-Browser code goes through `<AbloProvider>` or a scoped session route, never a raw
-API key.
+If your database stays canonical behind a Data Source endpoint, do not pass
+`databaseUrl` to `Ablo(...)` — trusted runtimes use `ABLO_API_KEY`. Browser code
+goes through `<AbloProvider>` or a scoped session route, never a raw API key.
 
 ## Rules of thumb
 

package/llms-full.txt

@@ -39,9 +39,9 @@ Use `snapshot(...)` and `readAt` when an agent write depends on state it already
 read. `onStale: 'reject'` prevents lost updates by rejecting if the target
 changed after the snapshot.
 
-Claims are live coordination signals, not database locks. Schema clients wait
-from the realtime claim stream. Schema-less HTTP clients must pass an explicit
-`claimedPollInterval` for `ifClaimed: 'wait'`; no hidden hard-coded polling.
+Claims are live coordination signals, not database locks. Reads never block on a
+claim — to wait for a row to free up, `claim({ id })` it and the claim queues
+fairly behind the current holder.
 
 Agent run bookkeeping is internal. Most users should not create run ledger
 records or scoped access credentials manually.
@@ -307,7 +307,10 @@ common agent path.
 
 ## Model
 
-Every model read returns state plus coordination metadata:
+The read shape depends on whether the client has a local graph:
+
+- The stateful `ablo.<model>.retrieve({ id })` returns the BARE row (`T | undefined`), and `list({ where })` returns `T[]`. Read coordination metadata (state watermark, active claims) separately via `ablo.snapshot(...)` and `ablo.<model>.claim.state({ id })`.
+- The stateless HTTP / `.model(name)` `retrieve({ id })` returns a `ModelRead<T>` envelope because it has no local graph to carry the watermark; `list({ where })` still returns `T[]`.
 
 ```ts
 type ModelRead<T> = {
@@ -317,32 +320,31 @@ type ModelRead<T> = {
 };
 ```
 
-`stamp` is the state watermark. Pass it to writes as `readAt`.
+`stamp` is the state watermark. Pass it to writes as `readAt` (from `ablo.snapshot(...)` on the stateful client, or from the envelope on the HTTP client).
 
 `claims` lists active work on the target. Reads are allowed while another participant is working. The caller decides whether to return, fail, or wait.
 
 ## Claimed Behavior
 
-Claimed behavior is explicit:
+Claimed behavior is explicit, and there are only two policies:
 
-- `ifClaimed: 'return'` returns the current claims with the read.
+- `ifClaimed: 'return'` (the default) returns the row plus the current claims with the read.
 - `ifClaimed: 'fail'` throws `AbloClaimedError`.
-- `ifClaimed: 'wait'` waits for matching claims to clear.
-
-Schema clients use the realtime claim stream for waits.
 
-Schema-less HTTP clients cannot know when a claim clears unless the caller opts into polling. When using `ifClaimed: 'wait'` over HTTP, provide `claimedPollInterval` and usually `claimedTimeout`.
+Reads never block on a claim. To wait for a row to free up, `claim({ id })` it —
+the claim queues fairly behind the current holder and is granted when the row
+frees. Use `ifClaimed: 'fail'` when you'd rather refuse to read a claimed row.
 
 ```ts
+// Read a claimed row without blocking, surfacing who holds it:
 await api.model('reports').retrieve({
   id: 'report_stockholm',
-  ifClaimed: 'wait',
-  claimedPollInterval: 1_000,
-  claimedTimeout: 30_000,
+  ifClaimed: 'return',
 });
-```
 
-No hidden hard-coded claimed polling. `claimedTimeout` is a maximum wait, not the coordination mechanism.
+// Or wait for it to free up by queueing your own claim:
+await api.model('reports').claim({ id: 'report_stockholm' });
+```
 
 ## Write
 

package/llms.txt

@@ -99,13 +99,13 @@ coordination until the app reports it through Data Source events.
 ## Claimed Behavior
 
 Reads never silently block. Schema reads stay open while a row is claimed.
-Server reads through `ablo.model(name)` can pass `ifClaimed: 'return'` to
-receive active claims, `ifClaimed: 'fail'` to throw `AbloClaimedError`, or
-`ifClaimed: 'wait'` to wait until the active claim clears.
+Server reads through `ablo.model(name)` can pass `ifClaimed: 'return'` (the
+default — returns the row plus active claim metadata) or `ifClaimed: 'fail'`
+to throw `AbloClaimedError`.
 
-Schema clients learn when a claim clears by listening to the live claim stream, so they don't need to poll. Schema-less HTTP callers must provide an explicit `claimedPollInterval` when using `ifClaimed: 'wait'`; Ablo does not hide a hard-coded polling loop.
-
-Use `claimedTimeout` only as a maximum wait, not as the coordination mechanism.
+Reads never block on a claim. To wait for a row to free up, `claim({ id })` it —
+the claim queues fairly behind the current holder and is granted when the row
+frees. Use `ifClaimed: 'fail'` when you'd rather refuse to read a claimed row.
 
 ## Guarantees
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abloatai/ablo",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "description": "The Collaboration Layer For AI Agents",
   "license": "Apache-2.0",
   "type": "module",

package/dist/api/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * Internal compatibility entrypoint for the stateless hosted protocol client.
- *
- * Use this build for serverless functions, scripts, and backends that want
- * model reads/writes and commits over HTTP without the realtime sync runtime.
- */
-export { createProtocolClient, createProtocolClient as Ablo, type AbloApi, type AbloApiClientOptions, type AbloApiClaims, type Capability, type CapabilityCreateOptions, type CapabilityParticipantKind, type CapabilityRecord, type CapabilityResource, type CapabilityRevocation, type CapabilityScope, } from '../client/ApiClient.js';
-export type { CommitCreateOptions, CommitOperationInput, CommitReceipt, CommitWait, ClaimCreateOptions, ClaimHandle, ClaimWaitOptions, ClaimedOptions, IfClaimedPolicy, ModelClient, ModelClaim, ModelMutationOptions, ModelReadOptions, ModelRead, ModelTarget, } from '../client/Ablo.js';
-import { createProtocolClient } from '../client/ApiClient.js';
-export default createProtocolClient;

package/dist/api/index.js

@@ -1,9 +0,0 @@
-/**
- * Internal compatibility entrypoint for the stateless hosted protocol client.
- *
- * Use this build for serverless functions, scripts, and backends that want
- * model reads/writes and commits over HTTP without the realtime sync runtime.
- */
-export { createProtocolClient, createProtocolClient as Ablo, } from '../client/ApiClient.js';
-import { createProtocolClient } from '../client/ApiClient.js';
-export default createProtocolClient;

package/dist/principal.d.ts

@@ -1,44 +0,0 @@
-/**
- * Principal constructors — a thin typed façade over the raw
- * `SessionRef` / `AgentRef` shapes so call sites don't have to memorize
- * the discriminated-union tags.
- *
- * ```ts
- * import Ablo, { session } from '@abloatai/ablo';
- *
- * const ablo = Ablo({ schema, apiKey });
- * const participant = await ablo.participants.join({
- *   type: 'Matter',
- *   id: 'deal-1',
- * });
- * ```
- *
- * Browser-human flows use `session(...)`. Agent-spawn-agent flows use
- * `agent(...)`, but those rarely appear in customer code because the
- * participant layer handles attenuation.
- *
- * These are pure — no I/O, no hidden state. If the shape ever grows a
- * required field (say, a scope hint for the restricted key), the helper
- * is the one place to flag migrations.
- */
-import type { AgentRef, SessionRef } from './types/streams.js';
-/**
- * Build a `SessionRef` from the identifiers your auth system already
- * holds. Typical inputs: the Better Auth session id, the user id, and
- * the organization the session is scoped to.
- */
-export declare function session(params: {
-    id: string;
-    userId: string;
-    organizationId: string;
-}): SessionRef;
-/**
- * Build an `AgentRef` from an agent id + the capability token that
- * authenticates it. Rare in application code — the common path is
- * `participant.join(child)` where the parent's token is attenuated
- * automatically.
- */
-export declare function agent(params: {
-    id: string;
-    capabilityToken: string;
-}): AgentRef;

package/dist/principal.js

@@ -1,49 +0,0 @@
-/**
- * Principal constructors — a thin typed façade over the raw
- * `SessionRef` / `AgentRef` shapes so call sites don't have to memorize
- * the discriminated-union tags.
- *
- * ```ts
- * import Ablo, { session } from '@abloatai/ablo';
- *
- * const ablo = Ablo({ schema, apiKey });
- * const participant = await ablo.participants.join({
- *   type: 'Matter',
- *   id: 'deal-1',
- * });
- * ```
- *
- * Browser-human flows use `session(...)`. Agent-spawn-agent flows use
- * `agent(...)`, but those rarely appear in customer code because the
- * participant layer handles attenuation.
- *
- * These are pure — no I/O, no hidden state. If the shape ever grows a
- * required field (say, a scope hint for the restricted key), the helper
- * is the one place to flag migrations.
- */
-/**
- * Build a `SessionRef` from the identifiers your auth system already
- * holds. Typical inputs: the Better Auth session id, the user id, and
- * the organization the session is scoped to.
- */
-export function session(params) {
-    return {
-        kind: 'session',
-        id: params.id,
-        userId: params.userId,
-        organizationId: params.organizationId,
-    };
-}
-/**
- * Build an `AgentRef` from an agent id + the capability token that
- * authenticates it. Rare in application code — the common path is
- * `participant.join(child)` where the parent's token is attenuated
- * automatically.
- */
-export function agent(params) {
-    return {
-        kind: 'agent',
-        id: params.id,
-        capabilityToken: params.capabilityToken,
-    };
-}

package/dist/react/SyncGroupProvider.d.ts

@@ -1,19 +0,0 @@
-import { type ReactNode } from 'react';
-export interface SyncGroupProviderProps {
-    /** The sync-group identifier — e.g., `matter:abc-123`, `deck:xyz`. */
-    id: string;
-    children: ReactNode;
-}
-export declare function SyncGroupProvider({ id, children }: SyncGroupProviderProps): import("react").JSX.Element;
-/**
- * Returns the ID of the nearest `<SyncGroupProvider>`. Throws if
- * called outside one — sync-group awareness is mandatory by design,
- * so the error points the consumer at the provider instead of
- * returning undefined and letting downstream code silently miss scope.
- *
- * If a component legitimately renders both inside and outside a
- * group, structure the tree so the hook is only called on the
- * inside path (e.g., split into two components). Silent nulls are
- * never the right answer.
- */
-export declare function useSyncGroup(): string;

package/dist/react/SyncGroupProvider.js

@@ -1,44 +0,0 @@
-'use client';
-import { jsx as _jsx } from "react/jsx-runtime";
-import { createContext, useContext, useMemo } from 'react';
-import { AbloValidationError } from '../errors.js';
-/**
- * Narrow context for a per-entity sync-group scope. Maps directly onto
- * Liveblocks' `<RoomProvider id="...">`: wrap a subtree, and any hooks
- * inside can read `useSyncGroup()` to discover "which entity am I
- * scoped to?" without threading the ID through props.
- *
- * Typical IDs follow the multiplayer sync-group convention: `matter:<id>`,
- * `deck:<id>`, `project:<id>`. The ID is an opaque string — the
- * provider doesn't parse it.
- *
- * v0.3.0 scope: this is a thin passthrough. Future versions will
- * scope `useQuery` / `useOne` results to the group automatically.
- */
-const SyncGroupContext = createContext(null);
-export function SyncGroupProvider({ id, children }) {
-    // Stabilize the context value so consumers memoized on it don't
-    // re-render when the provider re-renders for unrelated reasons.
-    const value = useMemo(() => id, [id]);
-    return _jsx(SyncGroupContext.Provider, { value: value, children: children });
-}
-/**
- * Returns the ID of the nearest `<SyncGroupProvider>`. Throws if
- * called outside one — sync-group awareness is mandatory by design,
- * so the error points the consumer at the provider instead of
- * returning undefined and letting downstream code silently miss scope.
- *
- * If a component legitimately renders both inside and outside a
- * group, structure the tree so the hook is only called on the
- * inside path (e.g., split into two components). Silent nulls are
- * never the right answer.
- */
-export function useSyncGroup() {
-    const id = useContext(SyncGroupContext);
-    if (!id) {
-        throw new AbloValidationError('useSyncGroup: no <SyncGroupProvider> mounted above this component. ' +
-            'Wrap your tree with <SyncGroupProvider id="matter:..."> from ' +
-            '@abloatai/ablo/react.', { code: 'no_sync_group_provider' });
-    }
-    return id;
-}

package/dist/react/useClaim.d.ts

@@ -1,29 +0,0 @@
-import type { ResolveClaims } from '../types/global.js';
-/**
- * Named-claim invoker, typed via `ResolveClaims[ClaimName]`.
- *
- * The consumer declares their claim vocabulary in the global:
- *
- * ```ts
- * declare module '@abloatai/ablo' {
- *   interface Register {
- *     Claims: {
- *       editLayer: { slideId: string; layerId: string };
- *       generateWithAI: { entityId: string; tool: string };
- *     };
- *   }
- * }
- * ```
- *
- * Then `useClaim('editLayer')` returns a function whose sole argument
- * is the `editLayer` claim shape — no runtime checks, purely compile-
- * time narrowing.
- *
- * The SDK doesn't own what happens next: the `beginClaim` function on
- * the React context (supplied via `SyncProvider`) is where the claim
- * claim turns into a network effect. A Node-backed consumer wires it
- * through `SyncAgent.beginClaim`; a browser-backed consumer may
- * broadcast it through their own WebSocket. This hook is pure sugar
- * that adds the typed name + claim narrowing.
- */
-export declare function useClaim<Name extends keyof ResolveClaims & string>(claimName: Name): (claim: ResolveClaims[Name]) => unknown;

package/dist/react/useClaim.js

@@ -1,42 +0,0 @@
-'use client';
-import { useCallback } from 'react';
-import { useSyncContext } from './context.js';
-import { AbloValidationError } from '../errors.js';
-/**
- * Named-claim invoker, typed via `ResolveClaims[ClaimName]`.
- *
- * The consumer declares their claim vocabulary in the global:
- *
- * ```ts
- * declare module '@abloatai/ablo' {
- *   interface Register {
- *     Claims: {
- *       editLayer: { slideId: string; layerId: string };
- *       generateWithAI: { entityId: string; tool: string };
- *     };
- *   }
- * }
- * ```
- *
- * Then `useClaim('editLayer')` returns a function whose sole argument
- * is the `editLayer` claim shape — no runtime checks, purely compile-
- * time narrowing.
- *
- * The SDK doesn't own what happens next: the `beginClaim` function on
- * the React context (supplied via `SyncProvider`) is where the claim
- * claim turns into a network effect. A Node-backed consumer wires it
- * through `SyncAgent.beginClaim`; a browser-backed consumer may
- * broadcast it through their own WebSocket. This hook is pure sugar
- * that adds the typed name + claim narrowing.
- */
-export function useClaim(claimName) {
-    const { beginClaim } = useSyncContext();
-    return useCallback((claim) => {
-        if (!beginClaim) {
-            throw new AbloValidationError(`useClaim: no \`beginClaim\` wired into SyncProvider. Pass ` +
-                `a \`beginClaim\` prop (typically bound to your transport) ` +
-                `to enable claim invocations.`, { code: 'claim_not_wired' });
-        }
-        return beginClaim(claimName, claim);
-    }, [beginClaim, claimName]);
-}

package/dist/react/usePresence.d.ts

@@ -1,32 +0,0 @@
-import type { ResolvePresence } from '../types/global.js';
-/**
- * Read the consumer-supplied presence state with `ResolvePresence`d
- * typing — the shape the consumer declared in
- * `declare module '@abloatai/ablo' { interface Register { Presence: ... } }`.
- *
- * The SDK doesn't own a presence wire format. Consumers plug whatever
- * backs their cursors, status, or activity (a MobX store, a custom
- * WebSocket channel, `SyncAgent` in Node, a Zustand slice) via the
- * `presence` prop on `SyncProvider`. This hook returns it typed.
- *
- * ```ts
- * // apps/your-app/src/ablo-sync.d.ts
- * declare module '@abloatai/ablo' {
- *   interface Register {
- *     Presence: { cursor: { x: number; y: number } | null; status: 'away' | 'online' };
- *   }
- * }
- *
- * // consumer's <SyncProvider> wiring
- * <SyncProvider store={store} organizationId={orgId} presence={presenceStore}>
- *
- * // any component
- * const presence = usePresence();
- * presence?.cursor?.x; // fully typed
- * ```
- *
- * Returns `undefined` when no provider-level presence source is wired —
- * consumers can narrow with a guard or configure a default in their
- * provider.
- */
-export declare function usePresence(): ResolvePresence | undefined;

package/dist/react/usePresence.js

@@ -1,41 +0,0 @@
-'use client';
-import { useSyncContext } from './context.js';
-/**
- * Read the consumer-supplied presence state with `ResolvePresence`d
- * typing — the shape the consumer declared in
- * `declare module '@abloatai/ablo' { interface Register { Presence: ... } }`.
- *
- * The SDK doesn't own a presence wire format. Consumers plug whatever
- * backs their cursors, status, or activity (a MobX store, a custom
- * WebSocket channel, `SyncAgent` in Node, a Zustand slice) via the
- * `presence` prop on `SyncProvider`. This hook returns it typed.
- *
- * ```ts
- * // apps/your-app/src/ablo-sync.d.ts
- * declare module '@abloatai/ablo' {
- *   interface Register {
- *     Presence: { cursor: { x: number; y: number } | null; status: 'away' | 'online' };
- *   }
- * }
- *
- * // consumer's <SyncProvider> wiring
- * <SyncProvider store={store} organizationId={orgId} presence={presenceStore}>
- *
- * // any component
- * const presence = usePresence();
- * presence?.cursor?.x; // fully typed
- * ```
- *
- * Returns `undefined` when no provider-level presence source is wired —
- * consumers can narrow with a guard or configure a default in their
- * provider.
- */
-export function usePresence() {
-    const ctx = useSyncContext();
-    // The runtime value is whatever the consumer passed to `SyncProvider`.
-    // The type assertion reflects the consumer's declared global, which
-    // the hook can't verify at runtime — but the consumer controls both
-    // ends (the registration and the provider prop) so this is a
-    // single-source-of-truth contract, not blind trust.
-    return ctx.presence;
-}