@muxoai/sdk 1.3.0 → 1.4.2

package/dist/store.d.ts

@@ -1,5 +1,5 @@
 import { DatabaseSync } from "node:sqlite";
-import type { ActionPlan, ApiKeyRecord, ByokKeyRecord, ConnectionRecord, ExecutionReceipt, ExecutionRun, GovernanceDecisionRecord, GovernancePolicy, LedgerEntry, MemoryContextSummary, ProviderLane, ProvisionedResource, RiskLevel, SupplierSettlement, SupplierSettlementSummary, User, Workspace, WorkspaceMemoryRecord } from "./types.js";
+import type { ActionPlan, ApiKeyRecord, ByokKeyRecord, ConnectionRecord, ExecutionReceipt, ExecutionRun, GovernanceDecisionRecord, GovernancePolicy, LedgerEntry, MemoryContextSummary, ProviderLane, ProvisionedResource, RiskLevel, SupplierSettlement, SupplierSettlementSummary, TeamOnboardingKit, TemporalGraphFact, User, Workspace, WorkspaceMembership, WorkspaceMemoryRecord, WorkspaceRole, WorkspaceSummary } from "./types.js";
 export declare const BYOK_PROVIDER_CATALOG: Record<string, {
     category: "llm" | "supplier";
     envVarName: string;
@@ -10,6 +10,11 @@ export declare class MuxoStore {
     private readonly vaultKey;
     constructor(dbPath: string, vaultKey: Buffer);
     private initSchema;
+    /**
+     * Older databases declared receipts.run_id UNIQUE, which blocks cancellation receipts from
+     * superseding a run's original receipt. SQLite cannot drop a constraint, so rebuild the table.
+     */
+    private migrateReceiptsAllowMultiplePerRun;
     encryptSecrets(workspaceId: string, secrets: Record<string, string>): string;
     decryptSecrets(workspaceId: string, payloadHex: string | null): Record<string, string>;
     ensureDefaultWorkspace(): {
@@ -28,6 +33,7 @@ export declare class MuxoStore {
         user: User;
         workspace: Workspace;
         sessionToken: string;
+        apiKey: string;
     };
     loginUser(email: string, password: string): {
         user: User;
@@ -35,7 +41,7 @@ export declare class MuxoStore {
         sessionToken: string;
     } | null;
     createSession(userId: string, workspaceId: string): string;
-    resolveAuthToken(token: string): {
+    resolveAuthToken(token: string, workspaceOverrideId?: string | null): {
         user: User;
         workspace: Workspace;
         authType: "session" | "api_key";
@@ -43,18 +49,101 @@ export declare class MuxoStore {
     } | null;
     getUser(userId: string): User | null;
     getWorkspace(workspaceId: string): Workspace | null;
+    ensureWorkspaceMembership(params: {
+        workspaceId: string;
+        userId: string;
+        role?: WorkspaceRole;
+        teamName?: string | null;
+        joinedViaKeyId?: string | null;
+    }): WorkspaceMembership;
+    userCanAccessWorkspace(userId: string, workspaceId: string): boolean;
+    listUserWorkspaces(userId: string, activeWorkspaceId?: string): WorkspaceSummary[];
+    switchUserWorkspace(userId: string, workspaceId: string): {
+        user: User;
+        workspace: Workspace;
+    } | null;
+    createWorkspaceForUser(params: {
+        userId: string;
+        name: string;
+        teamName?: string | null;
+        role?: WorkspaceRole;
+        switchActive?: boolean;
+    }): {
+        workspace: Workspace;
+        apiKey: string;
+        keyRecord: ApiKeyRecord;
+        membership: WorkspaceMembership;
+    };
+    joinWorkspaceWithApiKey(params: {
+        apiKey: string;
+        userId?: string | null;
+        switchActive?: boolean;
+    }): {
+        workspace: Workspace;
+        keyRecord: ApiKeyRecord;
+        user: User | null;
+        membership: WorkspaceMembership | null;
+    } | null;
+    onboardTeam(params: {
+        currentWorkspaceId: string;
+        userId: string;
+        userEmail?: string | null;
+        teamName: string;
+        role?: WorkspaceRole;
+        mode?: "shared_workspace" | "dedicated_workspace";
+        environment?: "live" | "test";
+        scopes?: string[];
+        inviteEmail?: string | null;
+        baseUrl: string;
+    }): TeamOnboardingKit;
     updateWorkspacePolicy(workspaceId: string, policy: Partial<GovernancePolicy>): Workspace;
     createApiKey(params: {
         workspaceId: string;
         name: string;
         environment?: "live" | "test";
         scopes?: string[];
+        teamName?: string | null;
+        role?: WorkspaceRole;
+        createdByEmail?: string | null;
     }): {
         record: ApiKeyRecord;
         secretKey: string;
     };
     listApiKeys(workspaceId: string): ApiKeyRecord[];
     revokeApiKey(workspaceId: string, keyId: string): boolean;
+    /** Looks up an active workspace API key by its raw secret. */
+    findActiveApiKey(secret: string): {
+        id: string;
+        workspaceId: string;
+    } | null;
+    saveOAuthRefreshToken(params: {
+        refreshToken: string;
+        accessToken: string;
+        keyId: string;
+        workspaceId: string;
+        clientId: string;
+        scope: string;
+    }): void;
+    getOAuthRefreshToken(refreshToken: string): {
+        keyId: string;
+        workspaceId: string;
+        clientId: string;
+        scope: string;
+        accessToken: string;
+    } | null;
+    deleteOAuthRefreshToken(refreshToken: string): void;
+    /**
+     * Maps a verified Clerk session to a local user. Only a verified email can link to an
+     * existing account; otherwise a fresh user and workspace are created so an unverified
+     * address can never take over someone else's account.
+     */
+    provisionClerkUser(clerkUserId: string, identity: {
+        email: string | null;
+        emailVerified: boolean;
+        name: string | null;
+    }, ownerWorkspaceId: string | null): User;
+    getClerkLinkedUser(clerkUserId: string): User | null;
+    getUserByEmail(email: string): User | null;
     upsertConnection(params: {
         workspaceId: string;
         lane: ProviderLane;
@@ -80,6 +169,8 @@ export declare class MuxoStore {
         metadata?: Record<string, unknown>;
     }): ProvisionedResource;
     getResource(workspaceId: string, resourceNameOrId: string): ProvisionedResource | null;
+    findResourceAnyWorkspace(resourceNameOrId: string): ProvisionedResource | null;
+    getDecryptedResourceSecrets(workspaceId: string, resourceNameOrId: string): Record<string, string>;
     listResources(workspaceId: string): ProvisionedResource[];
     getDecryptedWorkspaceEnv(workspaceId: string): Record<string, string>;
     normalizeByokProvider(providerInput: string): {
@@ -107,6 +198,7 @@ export declare class MuxoStore {
         memoryContext?: MemoryContextSummary | null;
     }): ActionPlan;
     getPlan(workspaceId: string, planId: string): ActionPlan | null;
+    getPlanById(planId: string): ActionPlan | null;
     listPlans(workspaceId: string, limit?: number): ActionPlan[];
     updatePlanApproval(params: {
         workspaceId: string;
@@ -129,6 +221,15 @@ export declare class MuxoStore {
         run: ExecutionRun;
         receipt: ExecutionReceipt;
     };
+    cancelRun(params: {
+        workspaceId: string;
+        runId: string;
+        cancelledBy: string;
+        reason?: string;
+    }): {
+        run: ExecutionRun;
+        receipt: ExecutionReceipt;
+    };
     private issueReceipt;
     verifyReceipt(receipt: ExecutionReceipt): boolean;
     getRun(workspaceId: string, runId: string): ExecutionRun | null;
@@ -172,6 +273,30 @@ export declare class MuxoStore {
     }): WorkspaceMemoryRecord;
     listMemoryRecords(workspaceId: string, limit?: number): WorkspaceMemoryRecord[];
     deleteMemoryRecord(workspaceId: string, idOrDocId: string): WorkspaceMemoryRecord | null;
+    upsertTemporalFact(params: {
+        workspaceId: string;
+        subject: string;
+        predicate: string;
+        object: string;
+        summary: string;
+        confidence?: number;
+        sourceKind?: TemporalGraphFact["sourceKind"];
+        sourceReferenceId?: string | null;
+        metadata?: Record<string, unknown>;
+        supersedeExisting?: boolean;
+    }): TemporalGraphFact;
+    listTemporalFacts(workspaceId: string, opts?: {
+        includeHistorical?: boolean;
+        subject?: string;
+        predicate?: string;
+        query?: string;
+        limit?: number;
+    }): TemporalGraphFact[];
+    forgetMatchingMemoryRecords(workspaceId: string, query: string): {
+        deletedMemories: WorkspaceMemoryRecord[];
+        invalidatedFacts: TemporalGraphFact[];
+    };
+    private mapTemporalFact;
     createAutonomousAgentSignup(params?: {
         agentName?: string;
         harness?: string;
@@ -188,9 +313,13 @@ export declare class MuxoStore {
         claimedAt: string | null;
         expiresAt: string;
     } | null;
+    /**
+     * Creates a claim link for a workspace. A claim minted without an email (at agent signup)
+     * stays unusable until the agent names the owner; naming one reuses that same link.
+     */
     createAgentClaim(params: {
         workspaceId: string;
-        email: string;
+        email: string | null;
         baseUrl: string;
     }): {
         claimSlug: string;
@@ -199,13 +328,16 @@ export declare class MuxoStore {
         status: "invited" | "claimed";
         expiresAt: string;
     };
-    redeemAgentClaim(claimSlug: string): {
+    /** Returns a claim only while it can still be accepted (invited and not expired). */
+    getOpenAgentClaim(claimSlug: string): {
         claimSlug: string;
         workspace: Workspace;
         targetEmail: string;
-        status: "claimed";
-        claimedAt: string;
+        status: "invited";
+        expiresAt: string;
     } | null;
+    /** Transfers workspace ownership to the verified claimer and closes the claim. */
+    acceptAgentClaim(claimSlug: string, userId: string): Workspace | null;
     private mapUser;
     private mapWorkspace;
     private mapConnection;