@mitralab.io/platform-sdk 1.1.4-beta.0 → 1.1.5-beta.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project are documented in this file.
 
+## 1.1.5-beta.0
+
+- The eight `agentCredentials` methods take a trailing `{ scope: "ACCOUNT" }`, sent as the
+  `scope=ACCOUNT` query parameter, and `session({ create: true })` and `agentTasks.create()`
+  accept `scope: "ACCOUNT"` in the create body, so the credential and the chat resolve against
+  the person's own account instead of the app. Without `scope` nothing changes on the wire. The
+  Copilot honors `ACCOUNT` only for apps listed by flag and answers
+  `ACCOUNT_CREDENTIAL_NOT_ALLOWED` otherwise.
+- Depend on `@mitralab.io/sdk-core@0.2.5-beta.0`, which carries the `scope` option through the
+  credential calls and into the create request and exports `AgentCredentialScope` and
+  `AgentCredentialOptions`.
+
 ## 1.1.4-beta.0
 
 - On the direct channel the message and the interrupt are written on the box socket, as the

package/README.md

@@ -331,6 +331,8 @@ session.close()
 
 A chat created with `create: true` over the `auto` or `websocket` transport is born on the T3 box (`runtime: "T3"` in the create request), so the first open does not wait for the box to adopt it; a chat created with `transport: "http"` stays on the Copilot runner. Pass `runtime: "RUNNER"` or `runtime: "T3"` to decide explicitly.
 
+`session({ create: true, agentId, scope: "ACCOUNT" })` and `agentTasks.create({ agentType, agentId, scope: "ACCOUNT" })` send `scope` in the create body, so the chat runs on the credential the person connected to their own account, the one the IDE and the builder read, instead of the agent's connection. The Copilot honors `ACCOUNT` only for apps listed by flag and answers `ACCOUNT_CREDENTIAL_NOT_ALLOWED` otherwise; a turn without a credential on the account fails with `ACCOUNT_CREDENTIAL_MISSING`. Through `agentTasks.session(...)` those refusals reach the session `error` event with the message and code the Copilot sends; through `agentTasks.create()` and the `agentCredentials` methods they reject the promise with a `MitraApiError` carrying status and code. No platform session is involved: the app token is used as always. Without `scope` nothing changes.
+
 Open an existing task with `session({ taskId })`. The default `auto` transport refreshes before connecting, asks the Copilot once where the chat is served, and opens whichever channel it names: the box that runs the agent when one is offered, `/copilot/ws/tasks/{taskId}` otherwise. The Copilot holds that request while the box boots and answers only once the box is ready or cannot be had; the SDK does not poll. The choice belongs to the server, never to application configuration, so a Copilot that stops offering the box leaves every application on the Copilot socket without a republish. Opening the box never asks it to replay, whether the conversation is new to the session or is being opened again after an idle close: what an idle conversation missed is history, which the application loads over REST. A box socket that drops in the middle of a turn is redialed by the SDK itself, with a bounded backoff (1, 2, 4, 8 and 16 seconds) and the replay from the last position seen on that socket, so the answer keeps streaming; a position taken on one box is forgotten when the Copilot points the conversation to another box; replayed `textChunk` frames reach the `delta` event like live text. While that happens the session emits `raw` events of type `channelReconnecting` (payload `attempt`, `maxAttempts`, `reason`) and `channelConnected` (payload `attempt`); the session `status` stays `streaming`, because Core has no reconnecting status. The disconnect reaches Core, and with it the `error` event, only when the attempts run out or the Copilot no longer offers the box. A drop with no turn in flight, a channel taken over by another tab (close code 4409), and any close of the Copilot socket the session did not ask for are reported at once, whatever the code, so the next send reopens the channel instead of waiting on a socket that is gone. Recovery through persisted history plus the HTTP/SSE channel is unchanged. Set `transport: "http"` when WebSockets are unavailable. Messages sent during a turn enter a FIFO queue with a maximum of 10 items; the session also exposes edit, remove, clear, approval, cancel, history, close, and typed events.
 
 On the direct channel the message and the interrupt are written on the box socket itself, as the frames the box reads from a client: `{ "type": "message", "content", "agentType"?, "reasoningEffort"? }` and `{ "type": "interrupt" }`. The box asks the Copilot to admit the turn and the Copilot records the history; the admission, its refusal and the turn itself come back on that same socket as the events the session already handles, so a message the box refuses surfaces through the `error` event with the box's code. `POST /copilot/api/v1/tasks/{taskId}/inputs` is the path when there is no box socket: a chat served by the Copilot socket or by SSE, a box socket that is not open at the moment of the send (a drop being redialed included), and every approval answer. A frame written on a socket that closes before the box acknowledges it is not sent again over REST, because the box may already have admitted the turn; the redial replays the box log, as it does for a turn started over REST.
@@ -339,6 +341,8 @@ A prompt sent while the browser says it is offline (`navigator.onLine === false`
 
 API keys and removal accept `ANTHROPIC` or `OPENAI`. OAuth accepts only `ANTHROPIC`; device authorization accepts only `OPENAI`. The facade enforces those producer-supported pairs in TypeScript and at runtime.
 
+Every `agentCredentials` method takes a trailing `options` with `scope: "ACCOUNT"`, sent as the `scope` query parameter, so the credential is read from or written to the person's own account instead of the app: `startOAuth("ANTHROPIC", { scope: "ACCOUNT" })`, `exchangeOAuth("ANTHROPIC", input, { scope: "ACCOUNT" })`, `list({ scope: "ACCOUNT" })`. The Copilot honors `ACCOUNT` only for apps listed by flag and answers `ACCOUNT_CREDENTIAL_NOT_ALLOWED` otherwise. No platform session is involved: the app token is used as always. Without `options` the request is the same as before.
+
 The browser token roles expose Agent tasks, credential status, and model discovery. Administrative business-Agent CRUD is intentionally not exposed by this adapter because the `USE` app role does not carry `AGENT_*` authority.
 
 ## Custom queries

package/dist/index.cjs

@@ -2365,31 +2365,31 @@ function requireProvider(provider, allowed, flow) {
 function createBrowserAgentCredentialsModule(httpClient) {
   const core = (0, import_sdk_core9.createAgentCredentialsModule)(httpClient, coreErrors);
   return {
-    list: () => core.list(),
-    listModels: (agentId) => core.listModels(agentId),
-    saveApiKey: (provider, apiKey) => {
+    list: (options) => core.list(options),
+    listModels: (agentId, options) => core.listModels(agentId, options),
+    saveApiKey: (provider, apiKey, options) => {
       requireProvider(provider, ["ANTHROPIC", "OPENAI"], "API key authentication");
-      return core.saveApiKey(provider, apiKey);
+      return core.saveApiKey(provider, apiKey, options);
     },
-    remove: (provider) => {
+    remove: (provider, options) => {
       requireProvider(provider, ["ANTHROPIC", "OPENAI"], "Credential removal");
-      return core.remove(provider);
+      return core.remove(provider, options);
     },
-    startOAuth: (provider) => {
+    startOAuth: (provider, options) => {
       requireProvider(provider, ["ANTHROPIC"], "OAuth");
-      return core.startOAuth(provider);
+      return core.startOAuth(provider, options);
     },
-    exchangeOAuth: (provider, input) => {
+    exchangeOAuth: (provider, input, options) => {
       requireProvider(provider, ["ANTHROPIC"], "OAuth");
-      return core.exchangeOAuth(provider, input);
+      return core.exchangeOAuth(provider, input, options);
     },
-    startDeviceAuthorization: (provider) => {
+    startDeviceAuthorization: (provider, options) => {
       requireProvider(provider, ["OPENAI"], "Device authorization");
-      return core.startDeviceAuthorization(provider);
+      return core.startDeviceAuthorization(provider, options);
     },
-    pollDeviceAuthorization: (provider, deviceAuthId) => {
+    pollDeviceAuthorization: (provider, deviceAuthId, options) => {
       requireProvider(provider, ["OPENAI"], "Device authorization");
-      return core.pollDeviceAuthorization(provider, deviceAuthId);
+      return core.pollDeviceAuthorization(provider, deviceAuthId, options);
     }
   };
 }

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { Transport, TransportRequestOptions, QueryParamValue, EntityTable, FunctionExecution, ListTemplateConfigsOptions, TemplateConfigPage, ProxyResult, ProxyInput, QueryResult, CredentialStatus, AgentModel as AgentModel$1, OAuthStartResult, OAuthExchangeInput, AuthenticationResult, DeviceAuthorization, PublicFunctionsModule, AgentTasksWithSessions } from '@mitralab.io/sdk-core';
-export { AgentQueueItem, AgentSendAndWaitOptions, AgentSendOptions, AgentSessionTransport, AgentTask, AgentTaskCreateInput, AgentTaskInput, AgentTaskListOptions, AgentTaskRuntime, AgentTaskSessionEventMap, AgentTaskSessionOptions, AgentTaskSessionStatus, AgentTurnResult, AuthenticationResult, CredentialStatus, DeviceAuthorization, EntityListOptions, EntityTable, ExistingAgentTaskSessionOptions, FunctionExecution, ListTemplateConfigsOptions, AgentMessage as NativeAgentMessage, AgentModel as NativeAgentModel, AgentTaskSession as NativeAgentTaskSession, AgentTimelineItem as NativeAgentTimelineItem, AgentToolEvent as NativeAgentToolEvent, NewAgentTaskSessionOptions, OAuthExchangeInput, OAuthStartResult, Page, PageOptions, ProxyInput, ProxyResult, PublicFunctionAsyncResult, PublicFunctionResult, PublicFunctionsModule, QueryResult, TemplateConfigPage } from '@mitralab.io/sdk-core';
+import { Transport, TransportRequestOptions, QueryParamValue, EntityTable, FunctionExecution, ListTemplateConfigsOptions, TemplateConfigPage, ProxyResult, ProxyInput, QueryResult, AgentCredentialOptions, CredentialStatus, AgentModel as AgentModel$1, OAuthStartResult, OAuthExchangeInput, AuthenticationResult, DeviceAuthorization, PublicFunctionsModule, AgentTasksWithSessions } from '@mitralab.io/sdk-core';
+export { AgentCredentialOptions, AgentCredentialScope, AgentQueueItem, AgentSendAndWaitOptions, AgentSendOptions, AgentSessionTransport, AgentTask, AgentTaskCreateInput, AgentTaskInput, AgentTaskListOptions, AgentTaskRuntime, AgentTaskSessionEventMap, AgentTaskSessionOptions, AgentTaskSessionStatus, AgentTurnResult, AuthenticationResult, CredentialStatus, DeviceAuthorization, EntityListOptions, EntityTable, ExistingAgentTaskSessionOptions, FunctionExecution, ListTemplateConfigsOptions, AgentMessage as NativeAgentMessage, AgentModel as NativeAgentModel, AgentTaskSession as NativeAgentTaskSession, AgentTimelineItem as NativeAgentTimelineItem, AgentToolEvent as NativeAgentToolEvent, NewAgentTaskSessionOptions, OAuthExchangeInput, OAuthStartResult, Page, PageOptions, ProxyInput, ProxyResult, PublicFunctionAsyncResult, PublicFunctionResult, PublicFunctionsModule, QueryResult, TemplateConfigPage } from '@mitralab.io/sdk-core';
 import * as LegacyTypes from 'mitra-interactions-sdk';
 import { exchangeSsoCodeMitra as exchangeSsoCodeMitra$1, loginMitra as loginMitra$1, loginWithGoogleMitra as loginWithGoogleMitra$1, loginWithMicrosoftMitra as loginWithMicrosoftMitra$1 } from 'mitra-interactions-sdk';
 export { callIntegrationMitra, configureSdkMitra, createMitraInstance, createRecordMitra, createRecordsBatchMitra, deleteRecordMitra, executePublicServerFunctionAsyncMitra, executePublicServerFunctionMitra, executeServerFunctionAsyncMitra, executeServerFunctionMitra, getAgentTaskMitra, getConfig, getPublicServerFunctionExecutionMitra, getRecordMitra, listIntegrationsMitra, listRecordsMitra, manageAgentChatMitra, manageAgentCredentialMitra, patchRecordMitra, refreshTokenSilently, resolveProjectId, stopServerFunctionExecutionMitra, updateRecordMitra } from 'mitra-interactions-sdk';
@@ -652,14 +652,14 @@ type AgentCredentialProvider = 'ANTHROPIC' | 'OPENAI';
 type AgentOAuthProvider = 'ANTHROPIC';
 type AgentDeviceProvider = 'OPENAI';
 interface AgentCredentialsModule {
-    list(): Promise<CredentialStatus[]>;
-    listModels(agentId?: string): Promise<AgentModel$1[]>;
-    saveApiKey(provider: AgentCredentialProvider, apiKey: string): Promise<void>;
-    remove(provider: AgentCredentialProvider): Promise<void>;
-    startOAuth(provider: AgentOAuthProvider): Promise<OAuthStartResult>;
-    exchangeOAuth(provider: AgentOAuthProvider, input: OAuthExchangeInput): Promise<AuthenticationResult>;
-    startDeviceAuthorization(provider: AgentDeviceProvider): Promise<DeviceAuthorization>;
-    pollDeviceAuthorization(provider: AgentDeviceProvider, deviceAuthId: string): Promise<AuthenticationResult>;
+    list(options?: AgentCredentialOptions): Promise<CredentialStatus[]>;
+    listModels(agentId?: string, options?: AgentCredentialOptions): Promise<AgentModel$1[]>;
+    saveApiKey(provider: AgentCredentialProvider, apiKey: string, options?: AgentCredentialOptions): Promise<void>;
+    remove(provider: AgentCredentialProvider, options?: AgentCredentialOptions): Promise<void>;
+    startOAuth(provider: AgentOAuthProvider, options?: AgentCredentialOptions): Promise<OAuthStartResult>;
+    exchangeOAuth(provider: AgentOAuthProvider, input: OAuthExchangeInput, options?: AgentCredentialOptions): Promise<AuthenticationResult>;
+    startDeviceAuthorization(provider: AgentDeviceProvider, options?: AgentCredentialOptions): Promise<DeviceAuthorization>;
+    pollDeviceAuthorization(provider: AgentDeviceProvider, deviceAuthId: string, options?: AgentCredentialOptions): Promise<AuthenticationResult>;
 }
 
 /**

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { Transport, TransportRequestOptions, QueryParamValue, EntityTable, FunctionExecution, ListTemplateConfigsOptions, TemplateConfigPage, ProxyResult, ProxyInput, QueryResult, CredentialStatus, AgentModel as AgentModel$1, OAuthStartResult, OAuthExchangeInput, AuthenticationResult, DeviceAuthorization, PublicFunctionsModule, AgentTasksWithSessions } from '@mitralab.io/sdk-core';
-export { AgentQueueItem, AgentSendAndWaitOptions, AgentSendOptions, AgentSessionTransport, AgentTask, AgentTaskCreateInput, AgentTaskInput, AgentTaskListOptions, AgentTaskRuntime, AgentTaskSessionEventMap, AgentTaskSessionOptions, AgentTaskSessionStatus, AgentTurnResult, AuthenticationResult, CredentialStatus, DeviceAuthorization, EntityListOptions, EntityTable, ExistingAgentTaskSessionOptions, FunctionExecution, ListTemplateConfigsOptions, AgentMessage as NativeAgentMessage, AgentModel as NativeAgentModel, AgentTaskSession as NativeAgentTaskSession, AgentTimelineItem as NativeAgentTimelineItem, AgentToolEvent as NativeAgentToolEvent, NewAgentTaskSessionOptions, OAuthExchangeInput, OAuthStartResult, Page, PageOptions, ProxyInput, ProxyResult, PublicFunctionAsyncResult, PublicFunctionResult, PublicFunctionsModule, QueryResult, TemplateConfigPage } from '@mitralab.io/sdk-core';
+import { Transport, TransportRequestOptions, QueryParamValue, EntityTable, FunctionExecution, ListTemplateConfigsOptions, TemplateConfigPage, ProxyResult, ProxyInput, QueryResult, AgentCredentialOptions, CredentialStatus, AgentModel as AgentModel$1, OAuthStartResult, OAuthExchangeInput, AuthenticationResult, DeviceAuthorization, PublicFunctionsModule, AgentTasksWithSessions } from '@mitralab.io/sdk-core';
+export { AgentCredentialOptions, AgentCredentialScope, AgentQueueItem, AgentSendAndWaitOptions, AgentSendOptions, AgentSessionTransport, AgentTask, AgentTaskCreateInput, AgentTaskInput, AgentTaskListOptions, AgentTaskRuntime, AgentTaskSessionEventMap, AgentTaskSessionOptions, AgentTaskSessionStatus, AgentTurnResult, AuthenticationResult, CredentialStatus, DeviceAuthorization, EntityListOptions, EntityTable, ExistingAgentTaskSessionOptions, FunctionExecution, ListTemplateConfigsOptions, AgentMessage as NativeAgentMessage, AgentModel as NativeAgentModel, AgentTaskSession as NativeAgentTaskSession, AgentTimelineItem as NativeAgentTimelineItem, AgentToolEvent as NativeAgentToolEvent, NewAgentTaskSessionOptions, OAuthExchangeInput, OAuthStartResult, Page, PageOptions, ProxyInput, ProxyResult, PublicFunctionAsyncResult, PublicFunctionResult, PublicFunctionsModule, QueryResult, TemplateConfigPage } from '@mitralab.io/sdk-core';
 import * as LegacyTypes from 'mitra-interactions-sdk';
 import { exchangeSsoCodeMitra as exchangeSsoCodeMitra$1, loginMitra as loginMitra$1, loginWithGoogleMitra as loginWithGoogleMitra$1, loginWithMicrosoftMitra as loginWithMicrosoftMitra$1 } from 'mitra-interactions-sdk';
 export { callIntegrationMitra, configureSdkMitra, createMitraInstance, createRecordMitra, createRecordsBatchMitra, deleteRecordMitra, executePublicServerFunctionAsyncMitra, executePublicServerFunctionMitra, executeServerFunctionAsyncMitra, executeServerFunctionMitra, getAgentTaskMitra, getConfig, getPublicServerFunctionExecutionMitra, getRecordMitra, listIntegrationsMitra, listRecordsMitra, manageAgentChatMitra, manageAgentCredentialMitra, patchRecordMitra, refreshTokenSilently, resolveProjectId, stopServerFunctionExecutionMitra, updateRecordMitra } from 'mitra-interactions-sdk';
@@ -652,14 +652,14 @@ type AgentCredentialProvider = 'ANTHROPIC' | 'OPENAI';
 type AgentOAuthProvider = 'ANTHROPIC';
 type AgentDeviceProvider = 'OPENAI';
 interface AgentCredentialsModule {
-    list(): Promise<CredentialStatus[]>;
-    listModels(agentId?: string): Promise<AgentModel$1[]>;
-    saveApiKey(provider: AgentCredentialProvider, apiKey: string): Promise<void>;
-    remove(provider: AgentCredentialProvider): Promise<void>;
-    startOAuth(provider: AgentOAuthProvider): Promise<OAuthStartResult>;
-    exchangeOAuth(provider: AgentOAuthProvider, input: OAuthExchangeInput): Promise<AuthenticationResult>;
-    startDeviceAuthorization(provider: AgentDeviceProvider): Promise<DeviceAuthorization>;
-    pollDeviceAuthorization(provider: AgentDeviceProvider, deviceAuthId: string): Promise<AuthenticationResult>;
+    list(options?: AgentCredentialOptions): Promise<CredentialStatus[]>;
+    listModels(agentId?: string, options?: AgentCredentialOptions): Promise<AgentModel$1[]>;
+    saveApiKey(provider: AgentCredentialProvider, apiKey: string, options?: AgentCredentialOptions): Promise<void>;
+    remove(provider: AgentCredentialProvider, options?: AgentCredentialOptions): Promise<void>;
+    startOAuth(provider: AgentOAuthProvider, options?: AgentCredentialOptions): Promise<OAuthStartResult>;
+    exchangeOAuth(provider: AgentOAuthProvider, input: OAuthExchangeInput, options?: AgentCredentialOptions): Promise<AuthenticationResult>;
+    startDeviceAuthorization(provider: AgentDeviceProvider, options?: AgentCredentialOptions): Promise<DeviceAuthorization>;
+    pollDeviceAuthorization(provider: AgentDeviceProvider, deviceAuthId: string, options?: AgentCredentialOptions): Promise<AuthenticationResult>;
 }
 
 /**

package/dist/index.js

@@ -2330,31 +2330,31 @@ function requireProvider(provider, allowed, flow) {
 function createBrowserAgentCredentialsModule(httpClient) {
   const core = createAgentCredentialsModule(httpClient, coreErrors);
   return {
-    list: () => core.list(),
-    listModels: (agentId) => core.listModels(agentId),
-    saveApiKey: (provider, apiKey) => {
+    list: (options) => core.list(options),
+    listModels: (agentId, options) => core.listModels(agentId, options),
+    saveApiKey: (provider, apiKey, options) => {
       requireProvider(provider, ["ANTHROPIC", "OPENAI"], "API key authentication");
-      return core.saveApiKey(provider, apiKey);
+      return core.saveApiKey(provider, apiKey, options);
     },
-    remove: (provider) => {
+    remove: (provider, options) => {
       requireProvider(provider, ["ANTHROPIC", "OPENAI"], "Credential removal");
-      return core.remove(provider);
+      return core.remove(provider, options);
     },
-    startOAuth: (provider) => {
+    startOAuth: (provider, options) => {
       requireProvider(provider, ["ANTHROPIC"], "OAuth");
-      return core.startOAuth(provider);
+      return core.startOAuth(provider, options);
     },
-    exchangeOAuth: (provider, input) => {
+    exchangeOAuth: (provider, input, options) => {
       requireProvider(provider, ["ANTHROPIC"], "OAuth");
-      return core.exchangeOAuth(provider, input);
+      return core.exchangeOAuth(provider, input, options);
     },
-    startDeviceAuthorization: (provider) => {
+    startDeviceAuthorization: (provider, options) => {
       requireProvider(provider, ["OPENAI"], "Device authorization");
-      return core.startDeviceAuthorization(provider);
+      return core.startDeviceAuthorization(provider, options);
     },
-    pollDeviceAuthorization: (provider, deviceAuthId) => {
+    pollDeviceAuthorization: (provider, deviceAuthId, options) => {
       requireProvider(provider, ["OPENAI"], "Device authorization");
-      return core.pollDeviceAuthorization(provider, deviceAuthId);
+      return core.pollDeviceAuthorization(provider, deviceAuthId, options);
     }
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mitralab.io/platform-sdk",
-  "version": "1.1.4-beta.0",
+  "version": "1.1.5-beta.0",
   "description": "JavaScript/TypeScript SDK for building apps on the Mitra Platform",
   "type": "module",
   "sideEffects": false,
@@ -62,7 +62,7 @@
     "url": "https://github.com/mitralab-dev/mitra-platform-sdk/issues"
   },
   "dependencies": {
-    "@mitralab.io/sdk-core": "0.2.4",
+    "@mitralab.io/sdk-core": "0.2.5-beta.0",
     "mitra-interactions-sdk": "1.0.60-beta.48"
   },
   "devDependencies": {