runwork 0.15.0 → 0.15.2

package/dist/api/__tests__/client.test.js

@@ -1,272 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-// HTTP goes through our `httpFetch` wrapper (single seam for diagnostics
-// and the optional `curl` transport). Tests mock that wrapper directly so
-// they exercise the same code path the production CLI uses.
-const mockFetch = vi.fn();
-vi.mock('../../utils/http.js', () => ({
-    httpFetch: (...args) => mockFetch(...args),
-}));
-const { ApiClient } = await import('../client.js');
-function createJsonResponse(data, status = 200) {
-    return {
-        ok: status >= 200 && status < 300,
-        status,
-        statusText: '',
-        url: '',
-        headers: new Headers(),
-        json: () => Promise.resolve(data),
-        text: () => Promise.resolve(JSON.stringify(data)),
-        arrayBuffer: () => Promise.resolve(new ArrayBuffer(8)),
-    };
-}
-const defaultCreds = {
-    apiKey: 'test-key-abc',
-    email: 'user@test.com',
-    baseUrl: 'https://custom.runwork.dev',
-};
-describe('ApiClient', () => {
-    beforeEach(() => {
-        vi.clearAllMocks();
-    });
-    describe('constructor', () => {
-        it('uses default base URL when baseUrl is empty', () => {
-            const client = new ApiClient({
-                apiKey: 'key',
-                email: 'e@e.com',
-                baseUrl: '',
-            });
-            // Verify by calling a method and checking the URL
-            mockFetch.mockResolvedValue(createJsonResponse({ data: [] }));
-            client.listWorkspaces();
-            expect(mockFetch).toHaveBeenCalledWith(expect.stringContaining('https://runwork.ai'), expect.anything());
-        });
-        it('uses custom base URL when provided', () => {
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: [] }));
-            client.listWorkspaces();
-            expect(mockFetch).toHaveBeenCalledWith(expect.stringContaining('https://custom.runwork.dev'), expect.anything());
-        });
-        it('uses provided API key for authorization', async () => {
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: [] }));
-            await client.listWorkspaces();
-            const callArgs = mockFetch.mock.calls[0];
-            expect(callArgs[1].headers['Authorization']).toBe('Bearer test-key-abc');
-        });
-    });
-    describe('request() - via methods', () => {
-        it('adds Authorization header when API key is set', async () => {
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: [] }));
-            await client.listWorkspaces();
-            const headers = mockFetch.mock.calls[0][1].headers;
-            expect(headers['Authorization']).toBe('Bearer test-key-abc');
-        });
-        it('omits Authorization header when API key is empty', async () => {
-            const client = new ApiClient({
-                apiKey: '',
-                email: 'e@e.com',
-                baseUrl: 'https://runwork.ai',
-            });
-            mockFetch.mockResolvedValue(createJsonResponse({ data: [] }));
-            await client.listWorkspaces();
-            const headers = mockFetch.mock.calls[0][1].headers;
-            expect(headers['Authorization']).toBeUndefined();
-        });
-        it('throws on non-ok response with status and body', async () => {
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ error: 'forbidden' }, 403));
-            await expect(client.listWorkspaces()).rejects.toThrow('API error 403');
-        });
-    });
-    describe('listWorkspaces()', () => {
-        it('calls correct endpoint and unwraps data', async () => {
-            const workspaces = [{ id: 'ws-1', name: 'My Workspace' }];
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: workspaces }));
-            const result = await client.listWorkspaces();
-            expect(mockFetch).toHaveBeenCalledWith('https://custom.runwork.dev/api/dev/workspaces', expect.anything());
-            expect(result).toEqual(workspaces);
-        });
-    });
-    describe('listApps()', () => {
-        it('calls correct endpoint without workspace filter', async () => {
-            const apps = [{ id: 'app-1', name: 'App' }];
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: apps }));
-            const result = await client.listApps();
-            expect(mockFetch).toHaveBeenCalledWith('https://custom.runwork.dev/api/dev/apps', expect.anything());
-            expect(result).toEqual(apps);
-        });
-        it('includes workspaceId query param when provided', async () => {
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: [] }));
-            await client.listApps('ws-123');
-            expect(mockFetch).toHaveBeenCalledWith('https://custom.runwork.dev/api/dev/apps?workspaceId=ws-123', expect.anything());
-        });
-    });
-    describe('getApp()', () => {
-        it('calls correct endpoint with appId', async () => {
-            const app = { id: 'app-42', name: 'Test App' };
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: app }));
-            const result = await client.getApp('app-42');
-            expect(mockFetch).toHaveBeenCalledWith('https://custom.runwork.dev/api/dev/apps/app-42', expect.anything());
-            expect(result).toEqual(app);
-        });
-    });
-    describe('initApp()', () => {
-        it('sends POST with correct body', async () => {
-            const app = { id: 'new-app', name: 'New App' };
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: app }));
-            const result = await client.initApp('ws-1', 'New App');
-            const callArgs = mockFetch.mock.calls[0];
-            expect(callArgs[1].method).toBe('POST');
-            expect(JSON.parse(callArgs[1].body)).toEqual({
-                workspaceId: 'ws-1',
-                appName: 'New App',
-            });
-            expect(result).toEqual(app);
-        });
-    });
-    describe('startDevSession()', () => {
-        it('sends POST with appId', async () => {
-            const session = {
-                sessionId: 's-1',
-                previewUrl: 'https://preview.test',
-                appId: 'app-1',
-            };
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: session }));
-            const result = await client.startDevSession('app-1');
-            const callArgs = mockFetch.mock.calls[0];
-            expect(callArgs[1].method).toBe('POST');
-            expect(JSON.parse(callArgs[1].body)).toEqual({ appId: 'app-1' });
-            expect(result).toEqual(session);
-        });
-    });
-    describe('getDevStatus()', () => {
-        it('calls correct endpoint', async () => {
-            const status = {
-                sessionId: 's-1',
-                previewUrl: 'https://preview.test',
-                appId: 'app-99',
-            };
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: status }));
-            const result = await client.getDevStatus('app-99');
-            expect(mockFetch).toHaveBeenCalledWith('https://custom.runwork.dev/api/dev/status/app-99', expect.anything());
-            expect(result).toEqual(status);
-        });
-    });
-    describe('triggerDeploy()', () => {
-        it('sends POST and returns deploymentUrl', async () => {
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({
-                data: { deploymentUrl: 'https://deployed.test' },
-            }));
-            const result = await client.triggerDeploy('app-1');
-            const callArgs = mockFetch.mock.calls[0];
-            expect(callArgs[0]).toBe('https://custom.runwork.dev/api/dev/deploy/app-1');
-            expect(callArgs[1].method).toBe('POST');
-            expect(result).toEqual({ deploymentUrl: 'https://deployed.test' });
-        });
-    });
-    describe('initiateLogin()', () => {
-        it('sends POST to auth/login', async () => {
-            const loginData = {
-                sessionId: 'sess-123',
-                loginUrl: 'https://runwork.ai/cli-auth?session=sess-123',
-            };
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: loginData }));
-            const result = await client.initiateLogin();
-            const callArgs = mockFetch.mock.calls[0];
-            expect(callArgs[0]).toBe('https://custom.runwork.dev/api/dev/auth/login');
-            expect(callArgs[1].method).toBe('POST');
-            expect(result).toEqual(loginData);
-        });
-    });
-    describe('pollLogin()', () => {
-        it('returns credentials when available', async () => {
-            const creds = {
-                apiKey: 'new-key',
-                email: 'new@test.com',
-                baseUrl: 'https://runwork.ai',
-            };
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ data: creds }));
-            const result = await client.pollLogin('sess-123');
-            expect(mockFetch).toHaveBeenCalledWith('https://custom.runwork.dev/api/dev/auth/poll/sess-123', expect.anything());
-            expect(result).toEqual(creds);
-        });
-        it('returns null on error', async () => {
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue(createJsonResponse({ error: 'pending' }, 404));
-            const result = await client.pollLogin('sess-123');
-            expect(result).toBeNull();
-        });
-        it('returns null when fetch throws', async () => {
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockRejectedValue(new Error('network error'));
-            const result = await client.pollLogin('sess-123');
-            expect(result).toBeNull();
-        });
-    });
-    describe('downloadSkeleton()', () => {
-        it('makes raw fetch call to skeleton endpoint', async () => {
-            const client = new ApiClient(defaultCreds);
-            const buffer = new ArrayBuffer(16);
-            mockFetch.mockResolvedValue({
-                ok: true,
-                arrayBuffer: () => Promise.resolve(buffer),
-            });
-            const result = await client.downloadSkeleton();
-            expect(mockFetch).toHaveBeenCalledWith('https://custom.runwork.dev/api/dev/skeleton', expect.objectContaining({
-                headers: expect.objectContaining({
-                    Authorization: 'Bearer test-key-abc',
-                }),
-            }));
-            expect(result).toBe(buffer);
-        });
-        it('throws on non-ok response', async () => {
-            const client = new ApiClient(defaultCreds);
-            mockFetch.mockResolvedValue({
-                ok: false,
-                status: 500,
-            });
-            await expect(client.downloadSkeleton()).rejects.toThrow('Failed to download skeleton: 500');
-        });
-        it('omits Authorization when apiKey is empty', async () => {
-            const client = new ApiClient({
-                apiKey: '',
-                email: 'e@e.com',
-                baseUrl: 'https://runwork.ai',
-            });
-            mockFetch.mockResolvedValue({
-                ok: true,
-                arrayBuffer: () => Promise.resolve(new ArrayBuffer(0)),
-            });
-            await client.downloadSkeleton();
-            const headers = mockFetch.mock.calls[0][1].headers;
-            expect(headers['Authorization']).toBeUndefined();
-        });
-    });
-    describe('getGitRemoteUrl()', () => {
-        it('returns correct URL format', () => {
-            const client = new ApiClient(defaultCreds);
-            const url = client.getGitRemoteUrl('ws-1', 'app-1');
-            expect(url).toBe('https://custom.runwork.dev/api/git/ws-1/app-1');
-        });
-        it('uses default base URL when none provided', () => {
-            const client = new ApiClient({
-                apiKey: 'key',
-                email: 'e@e.com',
-                baseUrl: '',
-            });
-            const url = client.getGitRemoteUrl('ws-2', 'app-2');
-            expect(url).toBe('https://runwork.ai/api/git/ws-2/app-2');
-        });
-    });
-});

package/dist/api/client.d.ts

@@ -1,326 +0,0 @@
-import type { Credentials, AppInfo, WorkspaceInfo, DevSession, WorkspaceAllData, WorkspaceSkill, ExternalSkillRegistration, McpServerConfig, RegistryEntity, WorkflowInfo, TriggerWorkflowResponse, WorkflowInstancesData, WorkflowInstanceDetailData, ScheduleInfo, TriggerScheduleResponse, ScheduleHistoryData, WorkspaceEndpoint, FileStorageInfo, ListBucketFilesData, ComponentInfo, ApiKeyInfo, ApiKeyCreateResponse, AgentInfo, AgentStatusResponse, AgentExecutionRecord } from '../types.js';
-export interface AgentConfigOverride {
-    extraInstructions?: string;
-    modelPreference?: string;
-    permissionRules?: {
-        allow?: string[];
-        deny?: string[];
-        defaultMode?: string;
-    };
-}
-export interface OnboardingConfigResponse {
-    config: {
-        teamInstructions: string | null;
-        agentConfigs: Record<string, AgentConfigOverride> | null;
-    } | null;
-}
-export declare class ApiClient {
-    private baseUrl;
-    private apiKey;
-    constructor(credentials: Credentials);
-    private request;
-    listWorkspaces(): Promise<WorkspaceInfo[]>;
-    listApps(workspaceId?: string): Promise<AppInfo[]>;
-    getApp(appId: string): Promise<AppInfo>;
-    initApp(workspaceId: string, appName: string): Promise<AppInfo>;
-    startDevSession(appId: string): Promise<DevSession>;
-    getDevStatus(appId: string): Promise<DevSession>;
-    triggerDeploy(appId: string): Promise<{
-        deploymentUrl: string;
-    }>;
-    initiateLogin(): Promise<{
-        sessionId: string;
-        loginUrl: string;
-    }>;
-    pollLogin(sessionId: string): Promise<Credentials | null>;
-    getAppSkill(appId: string): Promise<{
-        skill: string;
-        appName: string;
-    }>;
-    getPreviewLogs(appId: string): Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
-    getProductionLogs(appId: string, options?: {
-        limit?: number;
-        level?: string;
-        search?: string;
-        startTime?: string;
-        endTime?: string;
-    }): Promise<{
-        logs: Array<Record<string, unknown>>;
-        pagination?: {
-            total?: number;
-            hasMore?: boolean;
-        };
-    }>;
-    getAppEvents(appId: string, options?: {
-        limit?: number;
-        type?: string;
-        source?: string;
-        before?: string;
-    }): Promise<{
-        events: Array<{
-            id: string;
-            source: string;
-            type: string;
-            content: string;
-            summary?: string;
-            metadata?: Record<string, unknown>;
-            appId?: string;
-            timestamp: string;
-        }>;
-        totalCount: number;
-        hasMore: boolean;
-    }>;
-    downloadSkeleton(): Promise<ArrayBuffer>;
-    syncFiles(appId: string, files: Array<{
-        filePath: string;
-        fileContents: string;
-    }>, deletedFiles?: string[]): Promise<void>;
-    searchIntegrations(query: string, limit?: number, workspaceId?: string): Promise<{
-        results: Array<{
-            id: string;
-            name: string;
-            provider: string;
-            connectedByUser?: boolean;
-            usedByTeammates?: boolean;
-            docs?: {
-                name: string;
-                baseUrl: string;
-                pathFormat: string;
-                examples: string[];
-                notes?: string[];
-                requiredSetup?: string;
-            };
-        }>;
-    }>;
-    listConnectedIntegrations(workspaceId: string): Promise<Array<{
-        integrationId: string;
-        canonicalId?: string;
-        provider: string;
-        status?: string;
-        createdAt?: string;
-    }>>;
-    getTeamIntegrationUsage(workspaceId: string): Promise<Array<{
-        canonicalId: string;
-        integrationId: string;
-        userCount: number;
-        users: Array<{
-            id: string;
-            name: string;
-            avatarUrl?: string | null;
-        }>;
-        connectedByMe: boolean;
-    }>>;
-    /**
-     * Get git remote URL for an app.
-     * Both canonical ({baseUrl}/api/git/{workspaceId}/{appId}) and
-     * subdomain ({slug}.runwork.ai/api/git/{appId}) formats are supported.
-     */
-    getWorkspaceAll(workspaceId: string): Promise<WorkspaceAllData>;
-    getGitRemoteUrl(workspaceId: string, appId: string): string;
-    listWorkspaceSkills(workspaceId: string, includeContent?: boolean): Promise<WorkspaceSkill[]>;
-    listExternalSkills(workspaceId: string): Promise<ExternalSkillRegistration[]>;
-    importExternalSkill(workspaceId: string, skill: {
-        name: string;
-        description: string;
-        content: string;
-        importedFrom: string;
-    }): Promise<ExternalSkillRegistration>;
-    updateExternalSkill(workspaceId: string, skillId: string, skill: {
-        name: string;
-        description: string;
-        content: string;
-    }): Promise<ExternalSkillRegistration>;
-    getAppSkillContent(workspaceId: string, appId: string): Promise<string>;
-    listMcpServers(workspaceId: string): Promise<McpServerConfig[]>;
-    addMcpServer(workspaceId: string, server: {
-        name: string;
-        url: string;
-        transport: 'sse' | 'streamable-http';
-    }): Promise<McpServerConfig>;
-    removeMcpServer(workspaceId: string, serverId: string): Promise<void>;
-    /**
-     * Resolve decrypted auth headers for header-auth MCP servers, scoped to the
-     * authenticated user (their own + workspace-wide credentials). Keyed by server id.
-     */
-    resolveMcpCredentials(workspaceId: string): Promise<Record<string, Record<string, string>>>;
-    searchCommunitySkills(query: string, limit?: number, includeContent?: boolean): Promise<{
-        query: string;
-        count: number;
-        skills: Array<{
-            id: string;
-            title: string;
-            description: string | null;
-            source: string;
-            refs: {
-                skills_sh: string;
-                github: string;
-                raw: string | null;
-            };
-            install_count: number;
-            relevance_score: number;
-            content: string | null;
-        }>;
-    }>;
-    getCommunitySkillContent(source: string, skillId: string): Promise<{
-        id: string;
-        title: string;
-        description: string | null;
-        source: string;
-        content: string | null;
-        refs: {
-            skills_sh: string;
-            github: string;
-            raw: string | null;
-        };
-        install_count: number;
-    }>;
-    searchCommunityMcpServers(query: string, limit?: number): Promise<{
-        servers: Array<{
-            name: string;
-            description: string;
-            title: string | null;
-            version: string;
-            websiteUrl: string | null;
-            remotes: Array<{
-                type: 'sse' | 'streamable-http';
-                url: string;
-            }>;
-            keywords: string[];
-            publisher: string | null;
-        }>;
-        nextCursor: string | null;
-        count: number;
-    }>;
-    listEntities(workspaceId: string): Promise<RegistryEntity[]>;
-    listEntityRecords(workspaceId: string, entityName: string, opts?: {
-        limit?: number;
-        cursor?: string;
-        deploymentMode?: string;
-    }): Promise<{
-        items: unknown[];
-        next: string | null;
-    }>;
-    getEntityRecord(workspaceId: string, entityName: string, recordId: string): Promise<{
-        item: unknown;
-    }>;
-    createEntityRecord(workspaceId: string, entityName: string, data: Record<string, unknown>): Promise<{
-        item: unknown;
-    }>;
-    updateEntityRecord(workspaceId: string, entityName: string, recordId: string, data: Record<string, unknown>): Promise<{
-        item: unknown;
-    }>;
-    deleteEntityRecord(workspaceId: string, entityName: string, recordId: string): Promise<{
-        success: boolean;
-    }>;
-    listWorkflows(workspaceId: string): Promise<WorkflowInfo[]>;
-    triggerWorkflow(workspaceId: string, opts: {
-        workflowName: string;
-        appId: string;
-        params?: Record<string, unknown>;
-        instanceId?: string;
-    }): Promise<TriggerWorkflowResponse>;
-    listWorkflowInstances(workspaceId: string, appId: string, opts?: {
-        workflowName?: string;
-        status?: string;
-        limit?: number;
-    }): Promise<WorkflowInstancesData>;
-    getWorkflowInstance(workspaceId: string, instanceId: string, appId?: string): Promise<WorkflowInstanceDetailData>;
-    listSchedules(workspaceId: string): Promise<ScheduleInfo[]>;
-    triggerSchedule(workspaceId: string, opts: {
-        scheduleName: string;
-        appId: string;
-        deploymentMode?: string;
-    }): Promise<TriggerScheduleResponse>;
-    getScheduleHistory(workspaceId: string, appId: string): Promise<ScheduleHistoryData>;
-    getScheduleStatus(workspaceId: string, appId: string): Promise<Record<string, unknown>>;
-    pauseSchedule(workspaceId: string, scheduleName: string, appId: string): Promise<void>;
-    resumeSchedule(workspaceId: string, scheduleName: string, appId: string): Promise<void>;
-    listEndpoints(workspaceId: string): Promise<WorkspaceEndpoint[]>;
-    listFileStorages(workspaceId: string): Promise<FileStorageInfo[]>;
-    listBucketFiles(workspaceId: string, bucketName: string, opts?: {
-        prefix?: string;
-        delimiter?: string;
-    }): Promise<ListBucketFilesData>;
-    getPresignedUrl(workspaceId: string, bucketName: string, opts: {
-        action: 'read' | 'write';
-        key: string;
-        expiresIn?: number;
-    }): Promise<{
-        url: string;
-    }>;
-    deleteBucketFile(workspaceId: string, bucketName: string, key: string): Promise<void>;
-    listComponents(workspaceId: string): Promise<ComponentInfo[]>;
-    listApiKeys(workspaceId: string): Promise<ApiKeyInfo[]>;
-    createApiKey(workspaceId: string, opts: {
-        name: string;
-        appId?: string;
-        allowedEndpoints?: string[];
-        scopes?: string[];
-    }): Promise<ApiKeyCreateResponse>;
-    listAgents(workspaceId: string): Promise<AgentInfo[]>;
-    getAgentStatus(workspaceId: string, agentName: string, appId: string): Promise<AgentStatusResponse>;
-    listAgentExecutions(workspaceId: string): Promise<AgentExecutionRecord[]>;
-    getAgentExecutionStream(workspaceId: string, sessionId: string): Promise<string>;
-    getOnboardingConfig(workspaceId: string): Promise<OnboardingConfigResponse>;
-    reportTelemetry(workspaceId: string, events: Array<{
-        eventType: string;
-        agentSlug?: string;
-        metadata?: Record<string, unknown>;
-        timestamp: string;
-    }>): Promise<void>;
-    createSharedConversation(workspaceId: string, body: {
-        recipients?: string[];
-        isPersonal?: boolean;
-        sourceAgent: string;
-        title: string;
-        note?: string;
-        bundles: Array<{
-            format: string;
-            content: string;
-            sizeBytes: number;
-            sha256: string;
-        }>;
-        metadata?: Record<string, unknown>;
-        ttlDays?: number;
-    }): Promise<{
-        share: {
-            id: string;
-            title: string;
-            expiresAt: string;
-        };
-        sharedCount: number;
-        invitedCount: number;
-        skipped: Array<{
-            identifier: string;
-            reason: string;
-        }>;
-    }>;
-    listSharedConversations(workspaceId: string, opts?: {
-        scope?: 'all' | 'received' | 'sent' | 'saved';
-        limit?: number;
-        offset?: number;
-    }): Promise<{
-        shares: Array<Record<string, unknown>>;
-        total: number;
-    }>;
-    getSharedConversation(workspaceId: string, shareId: string): Promise<{
-        share: Record<string, unknown>;
-    }>;
-    downloadSharedConversationBundle(workspaceId: string, shareId: string, format: string): Promise<{
-        format: string;
-        content: string;
-        sizeBytes: number;
-        sha256: string;
-    }>;
-    markSharedConversationResumed(workspaceId: string, shareId: string): Promise<{
-        success: boolean;
-    }>;
-    callIntegrationProxy(integrationDbId: string, method: string, path: string, opts?: {
-        body?: unknown;
-        headers?: Record<string, string>;
-        query?: string;
-    }): Promise<unknown>;
-}