@gravity-rail/sdk 0.21.0 → 0.32.0

package/dist/types-0c6_NGU4.d.cts

@@ -0,0 +1,90 @@
+/** Event received from a subscribed workspace realtime channel. */
+interface ChannelEvent {
+    type: string;
+    [key: string]: unknown;
+}
+type ChannelListener = (event: ChannelEvent) => void;
+type Unsubscribe = () => void;
+/**
+ * What every realtime connection needs: where the API is, and who is asking.
+ *
+ * The account socket needs nothing more — its scope comes from the server's
+ * grant map, not from the URL — so this is the base rather than a widening of
+ * {@link RealtimeAuthSession}. A workspace session is assignable to it, which
+ * is what lets one session object drive both clients during cutover.
+ */
+interface RealtimeSessionBase {
+    apiUrl: string;
+    accessToken: string;
+}
+/** Auth context for workspace realtime WebSocket connections. */
+interface RealtimeAuthSession extends RealtimeSessionBase {
+    workspaceUuid: string;
+}
+/** Auth context for the account realtime WebSocket. No workspace, by design. */
+type AccountRealtimeSession = RealtimeSessionBase;
+type OperatorSessionState = 'idle' | 'connecting' | 'connected' | 'error';
+type OperatorCallPhase = 'idle' | 'connecting' | 'ready' | 'dialing' | 'live' | 'onHold' | 'ended' | 'failed';
+/** Phases where Hold / Forward / Hang up apply to an active phone leg. */
+declare function isActiveCallPhase(phase: OperatorCallPhase): boolean;
+/**
+ * The two activity lanes a client can watch.
+ *
+ * `activity` is the whole workspace's feed; `activity:me` is the connected
+ * member's own private lane and open items, kept separate so a busy workspace
+ * does not wake every operator's badge on every event.
+ *
+ * Both are named constants rather than interpolated strings because the server
+ * matches them exactly — a typo would subscribe successfully to nothing.
+ */
+declare const ACTIVITY_CHANNEL: "activity";
+declare const ACTIVITY_MEMBER_CHANNEL: "activity:me";
+/**
+ * The account's own lane, on the account socket only.
+ *
+ * Carries two things the workspace lanes cannot: the account's
+ * `account_private` rows (manager / DM / agent-job chats, member-targeted
+ * routine runs, and the concierge lane, which has no workspace at all), and a
+ * change to the account's own grants.
+ */
+declare const ACCOUNT_ACTIVITY_CHANNEL: "account:activity";
+type ActivityChannelName = typeof ACTIVITY_CHANNEL | typeof ACTIVITY_MEMBER_CHANNEL | typeof ACCOUNT_ACTIVITY_CHANNEL;
+/**
+ * Operator presence, on the account socket only.
+ *
+ * The channel operator presence is **written** on. Presence state lives once,
+ * at the account (`docs/projects/active/account-socket.md` § "Presence,
+ * migrated"), and is projected into each chosen workspace's live set — so
+ * going live is one command here rather than one per workspace socket.
+ *
+ * Unlike the activity lanes this one is bidirectional and does carry a
+ * payload, because it is not an invalidation lane: `presence_confirmed`
+ * reports the scope set the server actually honoured, which is the answer to
+ * the command and is not re-fetchable from anywhere else.
+ */
+declare const ACCOUNT_PRESENCE_CHANNEL: "account:presence";
+/** The workspace-scoped presence channel, on the per-workspace socket. */
+declare const PRESENCE_CHANNEL: "presence";
+/**
+ * What an activity channel delivers — and deliberately all it delivers.
+ *
+ * **No event payloads travel over this socket.** The signal says *look again*;
+ * the look goes through `POST /activity/query` (or `/counts` for a badge) under
+ * the client's own session, where it is authorized against a freshly compiled
+ * grant set and recorded as a bulk PHI access. A payload here would be an
+ * authorization decision frozen at publish time by a producer that knows
+ * nothing about who is listening — and a read that left no audit record.
+ *
+ * So: refetch on this, never render from it.
+ */
+interface ActivityInvalidationEvent extends ChannelEvent {
+    type: 'invalidate';
+    data: {
+        scope: 'workspace' | 'member' | 'account';
+        reason: 'drain';
+    };
+}
+/** Narrow a channel event to an activity invalidation. */
+declare function isActivityInvalidation(event: ChannelEvent): event is ActivityInvalidationEvent;
+
+export { type AccountRealtimeSession as A, type ChannelEvent as C, type OperatorSessionState as O, PRESENCE_CHANNEL as P, type RealtimeSessionBase as R, type Unsubscribe as U, type ChannelListener as a, type RealtimeAuthSession as b, type OperatorCallPhase as c, ACCOUNT_ACTIVITY_CHANNEL as d, ACCOUNT_PRESENCE_CHANNEL as e, ACTIVITY_CHANNEL as f, ACTIVITY_MEMBER_CHANNEL as g, type ActivityChannelName as h, type ActivityInvalidationEvent as i, isActiveCallPhase as j, isActivityInvalidation as k };

package/dist/types-0c6_NGU4.d.ts

@@ -0,0 +1,90 @@
+/** Event received from a subscribed workspace realtime channel. */
+interface ChannelEvent {
+    type: string;
+    [key: string]: unknown;
+}
+type ChannelListener = (event: ChannelEvent) => void;
+type Unsubscribe = () => void;
+/**
+ * What every realtime connection needs: where the API is, and who is asking.
+ *
+ * The account socket needs nothing more — its scope comes from the server's
+ * grant map, not from the URL — so this is the base rather than a widening of
+ * {@link RealtimeAuthSession}. A workspace session is assignable to it, which
+ * is what lets one session object drive both clients during cutover.
+ */
+interface RealtimeSessionBase {
+    apiUrl: string;
+    accessToken: string;
+}
+/** Auth context for workspace realtime WebSocket connections. */
+interface RealtimeAuthSession extends RealtimeSessionBase {
+    workspaceUuid: string;
+}
+/** Auth context for the account realtime WebSocket. No workspace, by design. */
+type AccountRealtimeSession = RealtimeSessionBase;
+type OperatorSessionState = 'idle' | 'connecting' | 'connected' | 'error';
+type OperatorCallPhase = 'idle' | 'connecting' | 'ready' | 'dialing' | 'live' | 'onHold' | 'ended' | 'failed';
+/** Phases where Hold / Forward / Hang up apply to an active phone leg. */
+declare function isActiveCallPhase(phase: OperatorCallPhase): boolean;
+/**
+ * The two activity lanes a client can watch.
+ *
+ * `activity` is the whole workspace's feed; `activity:me` is the connected
+ * member's own private lane and open items, kept separate so a busy workspace
+ * does not wake every operator's badge on every event.
+ *
+ * Both are named constants rather than interpolated strings because the server
+ * matches them exactly — a typo would subscribe successfully to nothing.
+ */
+declare const ACTIVITY_CHANNEL: "activity";
+declare const ACTIVITY_MEMBER_CHANNEL: "activity:me";
+/**
+ * The account's own lane, on the account socket only.
+ *
+ * Carries two things the workspace lanes cannot: the account's
+ * `account_private` rows (manager / DM / agent-job chats, member-targeted
+ * routine runs, and the concierge lane, which has no workspace at all), and a
+ * change to the account's own grants.
+ */
+declare const ACCOUNT_ACTIVITY_CHANNEL: "account:activity";
+type ActivityChannelName = typeof ACTIVITY_CHANNEL | typeof ACTIVITY_MEMBER_CHANNEL | typeof ACCOUNT_ACTIVITY_CHANNEL;
+/**
+ * Operator presence, on the account socket only.
+ *
+ * The channel operator presence is **written** on. Presence state lives once,
+ * at the account (`docs/projects/active/account-socket.md` § "Presence,
+ * migrated"), and is projected into each chosen workspace's live set — so
+ * going live is one command here rather than one per workspace socket.
+ *
+ * Unlike the activity lanes this one is bidirectional and does carry a
+ * payload, because it is not an invalidation lane: `presence_confirmed`
+ * reports the scope set the server actually honoured, which is the answer to
+ * the command and is not re-fetchable from anywhere else.
+ */
+declare const ACCOUNT_PRESENCE_CHANNEL: "account:presence";
+/** The workspace-scoped presence channel, on the per-workspace socket. */
+declare const PRESENCE_CHANNEL: "presence";
+/**
+ * What an activity channel delivers — and deliberately all it delivers.
+ *
+ * **No event payloads travel over this socket.** The signal says *look again*;
+ * the look goes through `POST /activity/query` (or `/counts` for a badge) under
+ * the client's own session, where it is authorized against a freshly compiled
+ * grant set and recorded as a bulk PHI access. A payload here would be an
+ * authorization decision frozen at publish time by a producer that knows
+ * nothing about who is listening — and a read that left no audit record.
+ *
+ * So: refetch on this, never render from it.
+ */
+interface ActivityInvalidationEvent extends ChannelEvent {
+    type: 'invalidate';
+    data: {
+        scope: 'workspace' | 'member' | 'account';
+        reason: 'drain';
+    };
+}
+/** Narrow a channel event to an activity invalidation. */
+declare function isActivityInvalidation(event: ChannelEvent): event is ActivityInvalidationEvent;
+
+export { type AccountRealtimeSession as A, type ChannelEvent as C, type OperatorSessionState as O, PRESENCE_CHANNEL as P, type RealtimeSessionBase as R, type Unsubscribe as U, type ChannelListener as a, type RealtimeAuthSession as b, type OperatorCallPhase as c, ACCOUNT_ACTIVITY_CHANNEL as d, ACCOUNT_PRESENCE_CHANNEL as e, ACTIVITY_CHANNEL as f, ACTIVITY_MEMBER_CHANNEL as g, type ActivityChannelName as h, type ActivityInvalidationEvent as i, isActiveCallPhase as j, isActivityInvalidation as k };

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@gravity-rail/sdk",
-   "version": "0.21.0",
+   "version": "0.32.0",
    "description": "Gravity Rail TypeScript SDK — API client for workspace management",
    "type": "module",
    "main": "./dist/index.cjs",
@@ -77,8 +77,8 @@
       "docs:json": "typedoc --json docs/api.json"
    },
    "dependencies": {
-      "libphonenumber-js": "^1.13.11",
-      "react-hook-form": "^7.85.0"
+      "libphonenumber-js": "^1.13.12",
+      "react-hook-form": "^7.87.0"
    },
    "peerDependencies": {
       "react": "^19",