@amigo-ai/platform-sdk 0.9.3 → 0.11.0

package/dist/types/core/device-code.d.ts

@@ -0,0 +1,134 @@
+/**
+ * RFC 8628 Device Authorization Grant for desktop and CLI apps.
+ *
+ * Authenticates users via the identity service's device code flow:
+ * the app displays a code, the user approves in their browser,
+ * and the app receives a workspace-scoped JWT.
+ */
+import { AmigoError, AuthenticationError } from './errors.js';
+export interface DeviceCodeIssuance {
+    device_code: string;
+    user_code: string;
+    verification_uri: string;
+    verification_uri_complete: string;
+    expires_in: number;
+    interval: number;
+}
+export interface IdentityTokenResponse {
+    access_token: string;
+    token_type: 'Bearer' | 'DPoP';
+    expires_in: number;
+    scope: string;
+    session_id?: string;
+    refresh_token?: string;
+}
+export interface WorkspaceChoice {
+    workspace_id: string;
+    role?: string;
+    name?: string;
+}
+export interface MultiWorkspaceResponse {
+    error: 'workspace_selection_required';
+    workspaces: WorkspaceChoice[];
+    access_token?: string;
+    token_type?: string;
+    expires_in?: number;
+    scope?: string;
+    refresh_token?: string;
+}
+export type DeviceCodeStatus = 'authorization_pending' | 'polling' | 'approved' | 'expired' | 'denied' | 'slow_down';
+export interface DeviceCodeLoginOptions {
+    /** Identity service base URL. Default: https://identity.platform.amigo.ai */
+    identityBaseUrl?: string;
+    /** Client description for audit logs */
+    clientDescription?: string;
+    /** OAuth scope to request */
+    scope?: string;
+    /** Called when device code is issued — display instructions to user */
+    onCode: (issuance: DeviceCodeIssuance) => void | Promise<void>;
+    /** Called with polling status updates */
+    onStatus?: (status: DeviceCodeStatus) => void;
+    /** Called when user must select a workspace — return the chosen workspace_id */
+    onWorkspaceRequired: (workspaces: WorkspaceChoice[]) => Promise<string>;
+    /** AbortSignal to cancel the login flow */
+    signal?: AbortSignal;
+    /** Custom fetch implementation */
+    fetch?: typeof globalThis.fetch;
+}
+export interface AuthResult {
+    accessToken: string;
+    refreshToken: string;
+    workspaceId: string;
+    expiresAt: number;
+    scope?: string;
+}
+export interface StoredCredentials {
+    access_token: string;
+    refresh_token: string;
+    workspace_id: string;
+    expires_at: number;
+    scope?: string;
+    identity_base_url?: string;
+}
+export interface TokenStorage {
+    load(): Promise<StoredCredentials | null>;
+    save(credentials: StoredCredentials): Promise<void>;
+    clear(): Promise<void>;
+}
+export declare class DeviceCodeExpiredError extends AmigoError {
+    constructor(message?: string);
+}
+export declare class DeviceCodeDeniedError extends AmigoError {
+    constructor(message?: string);
+}
+export declare class RefreshTokenExpiredError extends AuthenticationError {
+    constructor(message?: string);
+}
+export declare class LoginCancelledError extends AmigoError {
+    constructor();
+}
+export declare function decodeJwtPayload(jwt: string): Record<string, unknown> | null;
+export declare function loginWithDeviceCode(options: DeviceCodeLoginOptions): Promise<AuthResult>;
+export interface TokenManagerConfig {
+    storage?: TokenStorage;
+    identityBaseUrl?: string;
+    fetch?: typeof globalThis.fetch;
+}
+export declare class TokenManager {
+    private readonly _storage;
+    private readonly _baseUrl;
+    private readonly _fetch;
+    private _cached;
+    private _refreshPromise;
+    constructor(config?: TokenManagerConfig);
+    store(result: AuthResult): Promise<void>;
+    getAccessToken(): Promise<{
+        token: string;
+        workspaceId: string;
+    } | null>;
+    hasCredentials(): Promise<boolean>;
+    clear(): Promise<void>;
+    private _loadCached;
+    private _refresh;
+    private _doRefresh;
+}
+export declare class FileTokenStorage implements TokenStorage {
+    private readonly _explicitPath;
+    private _resolvedPath;
+    constructor(filePath?: string);
+    private _filePath;
+    load(): Promise<StoredCredentials | null>;
+    save(credentials: StoredCredentials): Promise<void>;
+    clear(): Promise<void>;
+}
+export declare class MemoryTokenStorage implements TokenStorage {
+    private _credentials;
+    load(): Promise<StoredCredentials | null>;
+    save(credentials: StoredCredentials): Promise<void>;
+    clear(): Promise<void>;
+}
+export declare function formatDeviceCodeInstructions(issuance: DeviceCodeIssuance): string;
+export declare function formatDeviceCodeLink(issuance: DeviceCodeIssuance): string;
+export declare function openBrowser(url: string): Promise<boolean>;
+export declare function formatWorkspaceList(workspaces: WorkspaceChoice[]): string;
+//# sourceMappingURL=device-code.d.ts.map

package/dist/types/core/device-code.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-code.d.ts","sourceRoot":"","sources":["../../../src/core/device-code.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAgC,MAAM,aAAa,CAAA;AAI3F,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,gBAAgB,EAAE,MAAM,CAAA;IACxB,yBAAyB,EAAE,MAAM,CAAA;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,QAAQ,GAAG,MAAM,CAAA;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,8BAA8B,CAAA;IACrC,UAAU,EAAE,eAAe,EAAE,CAAA;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,MAAM,gBAAgB,GACxB,uBAAuB,GACvB,SAAS,GACT,UAAU,GACV,SAAS,GACT,QAAQ,GACR,WAAW,CAAA;AAEf,MAAM,WAAW,sBAAsB;IACrC,6EAA6E;IAC7E,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,wCAAwC;IACxC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,6BAA6B;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,uEAAuE;IACvE,MAAM,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9D,yCAAyC;IACzC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAA;IAC7C,gFAAgF;IAChF,mBAAmB,EAAE,CAAC,UAAU,EAAE,eAAe,EAAE,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;IACvE,2CAA2C;IAC3C,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,kCAAkC;IAClC,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;CAChC;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,IAAI,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAA;IACzC,IAAI,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACnD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB;AAID,qBAAa,sBAAuB,SAAQ,UAAU;gBACxC,OAAO,SAAwD;CAG5E;AAED,qBAAa,qBAAsB,SAAQ,UAAU;gBACvC,OAAO,SAAsC;CAG1D;AAED,qBAAa,wBAAyB,SAAQ,mBAAmB;gBACnD,OAAO,SAAgD;CAGpE;AAED,qBAAa,mBAAoB,SAAQ,UAAU;;CAIlD;AAgHD,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAS5E;AAuCD,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC,CA4E9F;AAMD,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAA;CAChC;AAED,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAyB;IAChD,OAAO,CAAC,OAAO,CAAiC;IAChD,OAAO,CAAC,eAAe,CAA0C;gBAErD,MAAM,GAAE,kBAAuB;IAMrC,KAAK,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAYxC,cAAc,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAUxE,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAIlC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAMd,WAAW;YAOX,QAAQ;YAQR,UAAU;CA4BzB;AAID,qBAAa,gBAAiB,YAAW,YAAY;IACnD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAoB;IAClD,OAAO,CAAC,aAAa,CAAoB;gBAE7B,QAAQ,CAAC,EAAE,MAAM;YAIf,SAAS;IASjB,IAAI,IAAI,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAqBzC,IAAI,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IASnD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAU7B;AAED,qBAAa,kBAAmB,YAAW,YAAY;IACrD,OAAO,CAAC,YAAY,CAAiC;IAC/C,IAAI,IAAI,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAGzC,IAAI,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAGnD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7B;AAID,wBAAgB,4BAA4B,CAAC,QAAQ,EAAE,kBAAkB,GAAG,MAAM,CAcjF;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,kBAAkB,GAAG,MAAM,CAEzE;AAED,wBAAsB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAmB/D;AAED,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,eAAe,EAAE,GAAG,MAAM,CAUzE"}

package/dist/types/generated/api.d.ts

@@ -1502,6 +1502,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/{workspace_id}/brief": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Latest Workspace Brief
+         * @description Return the latest workspace-level Self-Image brief (null shape if none).
+         */
+        get: operations["get_latest_workspace_brief_v1__workspace_id__brief_get"];
+        put?: never;
+        /**
+         * Generate Workspace Brief
+         * @description Generate a workspace-level Self-Image brief (Opus 4.7).
+         */
+        post: operations["generate_workspace_brief_v1__workspace_id__brief_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/{workspace_id}/calls": {
         parameters: {
             query?: never;
@@ -2476,7 +2500,7 @@ export interface paths {
         put?: never;
         /**
          * Generate Brief
-         * @description Generate a Self-Image brief for the target entity (PR1: patient only).
+         * @description Generate a Self-Image brief for the target entity (patient, cohort, territory, emirate, or district).
          */
         post: operations["generate_brief_v1__workspace_id__entities__entity_id__brief_post"];
         delete?: never;
@@ -9324,9 +9348,9 @@ export interface components {
             target_entity_id: string;
             /**
              * Target Entity Type
-             * @constant
+             * @enum {string}
              */
-            target_entity_type: "patient";
+            target_entity_type: "patient" | "cohort" | "workspace" | "territory" | "emirate" | "district";
             /**
              * Truncated
              * @default false
@@ -28427,6 +28451,50 @@ export interface operations {
             };
         };
     };
+    get_latest_workspace_brief_v1__workspace_id__brief_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BriefResponse"];
+                };
+            };
+        };
+    };
+    generate_workspace_brief_v1__workspace_id__brief_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspace_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BriefResponse"];
+                };
+            };
+        };
+    };
     "list-calls": {
         parameters: {
             query?: {