@frontera-sdk/agents 0.0.0-stage → 1.52.27

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Sebati
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,80 @@
-# Temporary Holding Version
+# @frontera-sdk/agents
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+React hooks for reading Agents from inside a Frontera app: the conversation
+counts, outcomes, handoffs, errors, reply times and cost that Agents › Monitor
+shows, and the customer sessions and their text that Agents › Sessions shows.
+
+```bash
+bun add @frontera-sdk/agents @frontera-sdk/core react @tanstack/react-query
+```
+
+```tsx
+import { agentsProvider } from '@frontera-sdk/agents/provider'
+import { useAgentMonitor, useAgents } from '@frontera-sdk/agents/hooks'
+import { isAppReadOff } from '@frontera-sdk/agents/errors'
+import { createFronteraApp } from '@frontera-sdk/core/create-frontera-app'
+
+createFronteraApp(<App />, { providers: [agentsProvider] })
+
+function App() {
+  const agents = useAgents()
+  const agent = agents.data?.[0]
+  const monitor = useAgentMonitor(agent?.id, { from: '2026-10-01', to: '2026-10-08' })
+
+  if (isAppReadOff(agents.error)) return <p>Ask a workspace admin to turn on Agent metrics in Apps.</p>
+  return <p>{monitor.data ? `${monitor.data.sessions.total} conversations` : 'Loading…'}</p>
+}
+```
+
+## What an App can read
+
+| Export | Returns |
+| --- | --- |
+| `useAgents()` | The Agents of the App's workspace, as `{ id, name }`, while either read is on |
+| `useAgentMonitor(agentId, period, options)` | That Agent's Monitor metrics for the period |
+| `useAgentSessions(agentId, query, options)` | One page of that Agent's customer sessions, newest first, and `nextCursor` |
+| `useAgentSession(agentId, sessionId, options)` | One session and its text lines |
+| `isAppReadOff(error)` | `true` when the workspace has the read turned off |
+
+Each hook stays disabled while an id it needs is `undefined`, so it composes
+with `useAgents` without a guard. Every hook accepts React Query options.
+
+The period covers sessions that started from `from` up to, and not including,
+`to`. Each value is a `Date`, a day such as `2026-10-01`, or an ISO date-time.
+Without a period the metrics cover the last 7 days. A period is at most a year.
+Pass `channelId` to count one channel only.
+
+## Conversations
+
+```tsx
+const page = useAgentSessions(agent?.id, { status: 'ended', from: '2026-10-01', limit: 20, cursor })
+const open = useAgentSession(agent?.id, openId)
+
+page.data?.items.map((s) => `${s.startedAt} ${s.channel?.name ?? s.surface} ${s.endCustomer.label}`)
+open.data?.transcript.map((line) => `${line.role}: ${line.text}`)
+// Next page: setCursor(page.data?.nextCursor ?? undefined)
+```
+
+The list holds customer sessions only. Preview, Try and evaluation sessions
+never appear, and neither do a member's own conversations: Frontera Chat, a
+Chat App they opened, or an Agent run for them. Messages that reach the Agent
+through a channel, such as Slack, Teams or WhatsApp, are listed whoever wrote
+them, a colleague's included. A customer is shown as `Guest`
+or `Verified customer`, never by any part of their phone number or account.
+`previousSessionId` links one customer's sessions. A session's `transcript`
+holds the text lines the customer, the Agent and staff wrote, oldest first, up
+to the newest 500 messages; it never holds tool steps or collected values. Text
+is shown as it was written. A customer's lines can contain anything they typed,
+and the Agent's replies can repeat details the Agent looked up. A session of another
+Agent answers `404`. With conversations on, `useAgentMonitor` also returns
+`attention`, the sessions that need attention.
+
+## Who sees what
+
+The workspace decides. Metrics are off until a workspace admin who can read
+metrics turns on **Agent metrics in Apps** in Workspace settings; sessions and
+their text are off until a workspace admin who can read conversations turns on
+**Agent conversations in Apps**. Then everyone who can open the App, and anyone with
+a workspace API key, reads the same data, whatever their own role. Each time an
+App opens one session's text, the audit log records it. An Agent of another
+workspace answers `404`, like one that does not exist.

package/package.json

@@ -1,6 +1,71 @@
 {
   "name": "@frontera-sdk/agents",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.52.27",
+  "description": "React hooks for reading Agent metrics and conversations from inside a Frontera app.",
+  "keywords": [
+    "frontera",
+    "agents",
+    "react",
+    "hooks"
+  ],
+  "license": "Apache-2.0",
+  "type": "module",
+  "files": [
+    "src",
+    "!src/__tests__",
+    "!src/**/*.test.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    "./types": {
+      "types": "./src/types.ts",
+      "import": "./src/types.ts"
+    },
+    "./errors": {
+      "types": "./src/errors.ts",
+      "import": "./src/errors.ts"
+    },
+    "./agents-client": {
+      "types": "./src/agents-client.ts",
+      "import": "./src/agents-client.ts"
+    },
+    "./hooks": {
+      "types": "./src/hooks.ts",
+      "import": "./src/hooks.ts"
+    },
+    "./provider": {
+      "types": "./src/provider.tsx",
+      "import": "./src/provider.tsx"
+    }
+  },
+  "scripts": {
+    "test": "bun test",
+    "typecheck": "bunx tsc --noEmit"
+  },
+  "dependencies": {
+    "@frontera-sdk/core": "1.52.27"
+  },
+  "peerDependencies": {
+    "@tanstack/react-query": "^5.90.21",
+    "react": "^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@tanstack/react-query": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@tanstack/react-query": "^5.90.21",
+    "@types/bun": "^1.3.14",
+    "@types/react": "^19",
+    "react": "19.2.5",
+    "typescript": "^5.9.3"
+  }
+}

package/src/agents-client.ts

@@ -0,0 +1,56 @@
+import type { FronteraClient } from '@frontera-sdk/core/client'
+
+import type { AgentConversation, AgentMonitor, AgentSessionPage, AgentSessionQuery, AppAgent, MonitorPeriod } from './types'
+
+/**
+ * Typed client for the App read routes.
+ *
+ * Every method reads the App's own workspace; the App token on the
+ * `FronteraClient` names the App. While the workspace has the read turned off
+ * (Agent metrics in Apps for `monitor`, Agent conversations in Apps for
+ * `sessions` and `session`, both for `agents`), the method fails with
+ * `isAppReadOff(error)` true.
+ * An Agent outside the workspace answers 404, like one that does not exist, so
+ * start from `agents()` rather than a hard-coded id.
+ */
+export class AgentsClient {
+  constructor(private readonly client: FronteraClient) {}
+
+  async agents(): Promise<AppAgent[]> {
+    return (await this.client.request<{ agents: AppAgent[] }>('/v1/app-reads/agents')).agents
+  }
+
+  monitor(agentId: string, period: MonitorPeriod = {}): Promise<AgentMonitor> {
+    return this.client.request<AgentMonitor>(`/v1/app-reads/agents/${encodeURIComponent(agentId)}/monitor`, {
+      query: {
+        from: wire(period.from),
+        to: wire(period.to),
+        channelId: period.channelId,
+      },
+    })
+  }
+
+  sessions(agentId: string, query: AgentSessionQuery = {}): Promise<AgentSessionPage> {
+    return this.client.request<AgentSessionPage>(`/v1/app-reads/agents/${encodeURIComponent(agentId)}/sessions`, {
+      query: {
+        from: wire(query.from),
+        to: wire(query.to),
+        status: query.status,
+        channelId: query.channelId,
+        limit: query.limit,
+        cursor: query.cursor,
+      },
+    })
+  }
+
+  session(agentId: string, sessionId: string): Promise<AgentConversation> {
+    return this.client.request<AgentConversation>(
+      `/v1/app-reads/agents/${encodeURIComponent(agentId)}/sessions/${encodeURIComponent(sessionId)}`,
+    )
+  }
+}
+
+/** A `Date` as ISO; a string as given, so a day stays a day. */
+export function wire(value: Date | string | undefined): string | undefined {
+  return value instanceof Date ? value.toISOString() : value
+}

package/src/errors.ts

@@ -0,0 +1,15 @@
+import type { FronteraError } from '@frontera-sdk/core/errors'
+
+/** A refusal because the App's workspace has this read turned off. */
+export type AppReadOffError = FronteraError & { code: 'APP_READ_OFF' }
+
+/**
+ * Narrow an error from any hook or client method here. Retrying cannot change
+ * the answer: a workspace admin turns on Agent metrics in Apps (for metrics)
+ * or Agent conversations in Apps (for sessions and their text) in Workspace
+ * settings. Either one opens the Agents list.
+ */
+export function isAppReadOff(error: unknown): error is AppReadOffError {
+  // By code rather than `instanceof`: an App can bundle a second copy of the core package.
+  return error instanceof Error && (error as { code?: unknown }).code === 'APP_READ_OFF'
+}

package/src/hooks.ts

@@ -0,0 +1,130 @@
+import { createContext, useContext } from 'react'
+import { useQuery, type UseQueryOptions, type UseQueryResult } from '@tanstack/react-query'
+
+import { wire, type AgentsClient } from './agents-client'
+import { isAppReadOff } from './errors'
+import type { AgentConversation, AgentMonitor, AgentSessionPage, AgentSessionQuery, AppAgent, MonitorPeriod } from './types'
+
+/** Query keys. Periods are sent on the wire form first, so a `Date` and its ISO string share a cache entry. */
+export const agentKeys = {
+  all: ['frontera-agents'] as const,
+  agents: () => ['frontera-agents', 'agents'] as const,
+  monitor: (agentId: string, period: MonitorPeriod = {}) =>
+    ['frontera-agents', 'monitor', agentId, wire(period.from) ?? null, wire(period.to) ?? null, period.channelId ?? null] as const,
+  sessions: (agentId: string, query: AgentSessionQuery = {}) =>
+    [
+      'frontera-agents', 'sessions', agentId, wire(query.from) ?? null, wire(query.to) ?? null, query.status ?? null,
+      query.channelId ?? null, query.limit ?? null, query.cursor ?? null,
+    ] as const,
+  session: (agentId: string, sessionId: string) => ['frontera-agents', 'session', agentId, sessionId] as const,
+}
+
+export const FronteraAgentsContext = createContext<AgentsClient | null>(null)
+
+export function useAgentsClient(): AgentsClient {
+  const client = useContext(FronteraAgentsContext)
+  if (!client) {
+    throw new Error(
+      'No AgentsClient in context. Add agentsProvider to the providers of createFronteraApp or FronteraAppProvider.',
+    )
+  }
+  return client
+}
+
+type ReadOptions<TData> = Omit<UseQueryOptions<TData, Error>, 'queryKey' | 'queryFn'>
+
+/** A switched-off read is not retried: asking again cannot change the answer. */
+const retryUnlessOff = (failures: number, error: Error) => !isAppReadOff(error) && failures < 3
+
+/** The Agents of the App's workspace. */
+export function useAgents(options: ReadOptions<AppAgent[]> = {}): UseQueryResult<AppAgent[], Error> {
+  const client = useAgentsClient()
+  return useQuery({
+    queryKey: agentKeys.agents(),
+    queryFn: () => client.agents(),
+    retry: retryUnlessOff,
+    ...options,
+  })
+}
+
+/**
+ * The query `useAgentMonitor` runs. Disabled while `agentId` is missing, so a
+ * caller composes it with `useAgents` without a guard; the caller's own
+ * `enabled` applies once the id is known.
+ */
+export function agentMonitorQuery(
+  client: AgentsClient,
+  agentId: string | null | undefined,
+  period: MonitorPeriod = {},
+  options: ReadOptions<AgentMonitor> = {},
+): UseQueryOptions<AgentMonitor, Error> {
+  return {
+    queryKey: agentKeys.monitor(agentId ?? '', period),
+    queryFn: () => client.monitor(agentId!, period),
+    retry: retryUnlessOff,
+    ...options,
+    enabled: agentId ? (options.enabled ?? true) : false,
+  }
+}
+
+/** An Agent's Monitor metrics for a period. */
+export function useAgentMonitor(
+  agentId: string | null | undefined,
+  period: MonitorPeriod = {},
+  options: ReadOptions<AgentMonitor> = {},
+): UseQueryResult<AgentMonitor, Error> {
+  return useQuery(agentMonitorQuery(useAgentsClient(), agentId, period, options))
+}
+
+/**
+ * The query `useAgentSessions` runs: one page of an Agent's customer
+ * sessions. Disabled while `agentId` is missing.
+ */
+export function agentSessionsQuery(
+  client: AgentsClient,
+  agentId: string | null | undefined,
+  query: AgentSessionQuery = {},
+  options: ReadOptions<AgentSessionPage> = {},
+): UseQueryOptions<AgentSessionPage, Error> {
+  return {
+    queryKey: agentKeys.sessions(agentId ?? '', query),
+    queryFn: () => client.sessions(agentId!, query),
+    retry: retryUnlessOff,
+    ...options,
+    enabled: agentId ? (options.enabled ?? true) : false,
+  }
+}
+
+/** One page of an Agent's customer sessions, newest first. Pass `nextCursor` as `cursor` for the next page. */
+export function useAgentSessions(
+  agentId: string | null | undefined,
+  query: AgentSessionQuery = {},
+  options: ReadOptions<AgentSessionPage> = {},
+): UseQueryResult<AgentSessionPage, Error> {
+  return useQuery(agentSessionsQuery(useAgentsClient(), agentId, query, options))
+}
+
+/** The query `useAgentSession` runs. Disabled until both ids are known. */
+export function agentSessionQuery(
+  client: AgentsClient,
+  agentId: string | null | undefined,
+  sessionId: string | null | undefined,
+  options: ReadOptions<AgentConversation> = {},
+): UseQueryOptions<AgentConversation, Error> {
+  return {
+    queryKey: agentKeys.session(agentId ?? '', sessionId ?? ''),
+    queryFn: () => client.session(agentId!, sessionId!),
+    retry: retryUnlessOff,
+    ...options,
+    enabled: agentId && sessionId ? (options.enabled ?? true) : false,
+  }
+}
+
+/** One session and its text lines, as the customer and the Agent wrote them. */
+export function useAgentSession(
+  agentId: string | null | undefined,
+  sessionId: string | null | undefined,
+  options: ReadOptions<AgentConversation> = {},
+): UseQueryResult<AgentConversation, Error> {
+  return useQuery(agentSessionQuery(useAgentsClient(), agentId, sessionId, options))
+}

package/src/provider.tsx

@@ -0,0 +1,19 @@
+import type { ReactNode } from 'react'
+import type { FronteraClient } from '@frontera-sdk/core/client'
+
+import { AgentsClient } from './agents-client'
+import { FronteraAgentsContext } from './hooks'
+
+/**
+ * Plug Agent reads into `createFronteraApp` or `FronteraAppProvider`:
+ *
+ * ```tsx
+ * createFronteraApp(<App />, { providers: [blueprintProvider, agentsProvider] })
+ * ```
+ *
+ * The client is rebuilt whenever the host rotates the credential, because the
+ * `FronteraClient` it wraps is replaced rather than mutated.
+ */
+export function agentsProvider(value: { client: FronteraClient }, children: ReactNode): ReactNode {
+  return <FronteraAgentsContext.Provider value={new AgentsClient(value.client)}>{children}</FronteraAgentsContext.Provider>
+}

package/src/types.ts

@@ -0,0 +1,132 @@
+/**
+ * What an App reads from Agents, as the App sees it. Dates arrive as ISO
+ * strings (JSON), so they are typed as strings.
+ *
+ * Metrics are open only while the App's workspace turns on Agent metrics in
+ * Apps; sessions and their text only while it turns on Agent conversations in
+ * Apps.
+ * Every person who opens the App reads the same data.
+ */
+
+/** An Agent of the App's workspace. */
+export interface AppAgent {
+  id: string
+  name: string
+}
+
+/**
+ * Which sessions the metrics cover: those that started in `[from, to)`,
+ * optionally on one channel. A `Date`, a day (`2026-10-01`) or an ISO
+ * date-time. Defaults to the last 7 days; at most a year.
+ */
+export interface MonitorPeriod {
+  from?: Date | string
+  to?: Date | string
+  channelId?: string
+}
+
+/**
+ * An Agent's Monitor metrics for a period, as Agents › Monitor shows them.
+ * Customer sessions only: Preview, Try and evaluation sessions never count.
+ */
+export interface AgentMonitor {
+  period: { from: string; to: string }
+  sessions: { total: number; open: number; ended: number; continued: number; endedByInactivity: number }
+  outcomes: {
+    recorded: { resolved: number; handedOff: number; unresolved: number; resolutionRate: number | null; concluded: number }
+    inferred: { analysed: number; resolved: number; unresolved: number; abandoned: number; unknown: number }
+    unknown: number
+  }
+  handoffs: { sessions: number; rate: number | null }
+  focus: { decisions: number; rejected: number; uncertain: number; unavailable: number; blockedRate: number | null }
+  errors: { sessions: number; events: number; actionFailures: number; reconciliations: number; repliesBlocked: number }
+  actions: { completed: number }
+  latency: { replies: number; p50Ms: number | null; p95Ms: number | null }
+  messages: { fromCustomers: number }
+  cost: { usd: number; tokens: number; perSession: number | null }
+  /** One entry per day with sessions, `day` as `YYYY-MM-DD` in UTC. */
+  daily: Array<{ day: string; sessions: number; resolved: number; handedOff: number }>
+  byChannel: Array<{ channelId: string | null; surface: string; name: string | null; type: string | null; sessions: number; resolved: number; handedOff: number }>
+  byProcedure: Array<{ procedureId: string | null; sessions: number; resolved: number; handedOff: number; unresolved: number }>
+  /** What each metric counts and where it comes from. */
+  definitions: Record<string, { denominator: string; source: string }>
+  /**
+   * Up to 20 sessions that need attention, newest first. Present only while
+   * the workspace also has Agent conversations in Apps turned on.
+   */
+  attention?: Array<{
+    sessionId: string
+    status: AgentSessionStatus
+    reason: 'reconciliation' | 'error' | 'analysis_failed'
+    startedAt: string
+    lastActivityAt: string
+  }>
+}
+
+export type AgentSessionStatus = 'active' | 'waiting_customer' | 'action_pending' | 'ended'
+
+/**
+ * Which sessions to list: those that started in `[from, to)`, newest first.
+ * `status` `attention` keeps the sessions Monitor counts as needing attention.
+ * Pass the previous page's `nextCursor` as `cursor` for the next page.
+ */
+export interface AgentSessionQuery {
+  from?: Date | string
+  to?: Date | string
+  status?: 'open' | 'ended' | 'attention'
+  channelId?: string
+  /** 1 to 100; 25 by default. */
+  limit?: number
+  cursor?: string
+}
+
+/**
+ * One customer session. Preview, Try and evaluation sessions never appear, and
+ * neither do a member's own conversations: Frontera Chat, a Chat App they
+ * opened, or an Agent run for them.
+ */
+export interface AgentSession {
+  id: string
+  surface: 'channel' | 'chat-app' | 'api'
+  channel: { id: string; name: string; type: string } | null
+  status: AgentSessionStatus
+  harness: string
+  phase: 'step-by-step' | null
+  procedure: { id: string; name: string } | null
+  outcome: 'resolved' | 'handed_off' | 'abandoned' | 'unresolved' | 'unknown' | 'transferred' | null
+  outcomeSource: 'recorded' | 'inferred' | null
+  endReason: 'inactivity' | 'explicit' | 'call_completed' | 'superseded' | 'closed_by_staff' | 'transferred' | null
+  startedAt: string
+  lastActivityAt: string
+  lastCustomerActivityAt: string
+  expiresAt: string | null
+  endedAt: string | null
+  /** Never the customer's phone number or any part of it. */
+  endCustomer: { label: 'Guest' | 'Verified customer'; verified: boolean }
+  configVersion: { id: string; number: number | null } | null
+  /** The same customer's session before this one, when their conversation continued. */
+  previousSessionId: string | null
+  analysisStatus: string | null
+}
+
+export interface AgentSessionPage {
+  items: AgentSession[]
+  /** The `cursor` for the next page; `null` on the last page. */
+  nextCursor: string | null
+}
+
+/** One line of a conversation: text as the customer, the Agent or staff wrote it. */
+export interface TranscriptLine {
+  id: string
+  role: 'customer' | 'agent'
+  /** A person replied while they had control. */
+  staff?: boolean
+  text: string
+  at: string
+}
+
+/** One session and its text lines, oldest first, at most the newest 500 messages. */
+export interface AgentConversation {
+  session: AgentSession
+  transcript: TranscriptLine[]
+}