@remixhq/core 0.1.13 → 0.1.15

package/dist/contracts-CHmD-fMj.d.ts

@@ -0,0 +1,677 @@
+type JsonObject = Record<string, any>;
+
+type TurnUsageCaptureSource = "agent_supplied" | "hook" | "proxy" | "historical_import" | "unknown";
+type TurnUsageConfidence = "exact" | "partial" | "unknown";
+type ModelCall = {
+    provider: string;
+    model: string | null;
+    tier: string | null;
+    requestId: string | null;
+    timestamp: string | null;
+    isSidechain: boolean;
+    inputTokens: number | null;
+    outputTokens: number | null;
+    cacheReadTokens: number | null;
+    cacheWriteTokens: number | null;
+    cacheWrite5mTokens: number | null;
+    cacheWrite1hTokens: number | null;
+    reasoningTokens: number | null;
+    audioInputTokens: number | null;
+    imageInputTokens: number | null;
+};
+type ServerToolUsage = {
+    provider: string;
+    tool: string;
+    unit: string;
+    quantity: number;
+};
+type TurnUsage = {
+    schemaVersion: 1;
+    capturedAt: string;
+    captureSource: TurnUsageCaptureSource;
+    confidence: TurnUsageConfidence;
+    agent: {
+        name: string;
+        version: string | null;
+        sessionId: string | null;
+        turnId: string | null;
+        plan: string | null;
+    };
+    calls: ModelCall[];
+    serverTools: ServerToolUsage[];
+    warnings: {
+        code: string;
+        message: string;
+    }[];
+    extensions: Record<string, unknown> | null;
+};
+type TurnUsagePreviousPatch = {
+    previousAgentTurnId: string;
+    previousSessionId: string;
+    usage: TurnUsage;
+};
+type TurnUsagePayload = {
+    schemaVersion: 1;
+    currentTurn: TurnUsage | null;
+    previousTurn: TurnUsagePreviousPatch | null;
+};
+type MergeRequestStatus = "open" | "approved" | "rejected" | "merged" | "closed";
+type MergeRequestQueue = "reviewable" | "created_by_me" | "app_reviewable" | "app_outgoing" | "app_related_visible";
+type MergeRequest = {
+    id: string;
+    sourceAppId: string;
+    sourceCommitId: string;
+    sourceTipCommitId: string | null;
+    targetAppId: string;
+    targetCommitId: string | null;
+    kind: "merge" | "sync";
+    status: MergeRequestStatus;
+    title: string | null;
+    description: string | null;
+    category: string | null;
+    tags: string[] | null;
+    createdBy: string;
+    reviewedBy: string | null;
+    mergedBy: string | null;
+    createdAt: string;
+    updatedAt: string;
+    mergedAt: string | null;
+    closedAt: string | null;
+};
+type MergeRequestReviewPrompt = {
+    commitId: string;
+    messageId: string | null;
+    prompt: string | null;
+};
+type MergeRequestReviewChangeStep = {
+    id: string;
+    appId: string;
+    threadId: string | null;
+    messageId: string | null;
+    commitId: string | null;
+    baseCommitHash: string | null;
+    headCommitHash: string | null;
+    changedFilesCount: number | null;
+    insertions: number | null;
+    deletions: number | null;
+    status: string | null;
+    statusError: string | null;
+    actor: {
+        type: string | null;
+        name: string | null;
+        version: string | null;
+        provider: string | null;
+    };
+    workspaceMetadata: JsonObject | null;
+    prompt: string | null;
+    diff: string;
+    createdAt: string;
+};
+type MergeRequestReview = {
+    mergeRequest: MergeRequest;
+    prompts: MergeRequestReviewPrompt[];
+    changeSteps: MergeRequestReviewChangeStep[];
+    unifiedDiff: string;
+    stats: {
+        changeStepCount: number;
+        changedFilesCount: number;
+        insertions: number;
+        deletions: number;
+    };
+};
+type CollabApproveMode = "remote-only" | "sync-target-repo";
+type CollabStatusBlockedReason = "not_git_repo" | "not_bound" | "branch_binding_missing" | "family_ambiguous" | "missing_head" | "detached_head" | "branch_mismatch" | "dirty_worktree" | "baseline_missing" | "metadata_conflict" | "remote_error";
+type CollabRepoStateKind = "idle" | "local_only_changed" | "server_only_changed" | "both_changed" | "external_local_base_changed" | "metadata_conflict" | "binding_problem";
+type CollabPendingFinalizeState = "idle" | "queued" | "processing" | "retry_scheduled" | "awaiting_usage" | "failed";
+type CollabPendingFinalizeSummary = {
+    state: CollabPendingFinalizeState;
+    activeJobCount: number;
+    queuedJobCount: number;
+    processingJobCount: number;
+    retryScheduledJobCount: number;
+    awaitingUsageJobCount: number;
+    failedJobCount: number;
+    oldestCapturedAt: string | null;
+    newestCapturedAt: string | null;
+    nextRetryAt: string | null;
+    latestError: string | null;
+};
+type CollabStatusRecommendedAction = "init" | "pull" | "re_anchor" | "reconcile" | "await_finalize" | "record" | "review_queue" | "choose_family" | "no_action";
+type CollabStatus = {
+    schemaVersion: 1;
+    repo: {
+        isGitRepo: boolean;
+        repoRoot: string | null;
+        branch: string | null;
+        branchMismatch: boolean;
+        headCommitHash: string | null;
+        worktree: {
+            isClean: boolean;
+            entryCount: number;
+            hasTrackedChanges: boolean;
+            hasUntrackedFiles: boolean;
+            preview: string[];
+        };
+    };
+    binding: {
+        isBound: boolean;
+        path: string | null;
+        projectId: string | null;
+        currentAppId: string | null;
+        upstreamAppId: string | null;
+        isRemix: boolean | null;
+        threadId: string | null;
+        repoFingerprint: string | null;
+        remoteUrl: string | null;
+        dashboardUrl: string | null;
+        defaultBranch: string | null;
+        laneId: string | null;
+        branchName: string | null;
+        bindingMode: "legacy" | "lane" | "explicit_root" | null;
+    };
+    remote: {
+        checked: boolean;
+        error: string | null;
+        appStatus: string | null;
+        incomingOpenMergeRequestCount: number | null;
+        outgoingOpenMergeRequestCount: number | null;
+    };
+    sync: {
+        checked: boolean;
+        error: string | null;
+        canApply: boolean;
+        status: "not_available" | SyncLocalResponse["status"];
+        blockedReasons: CollabStatusBlockedReason[];
+        warnings: string[];
+        targetCommitHash: string | null;
+        targetCommitId: string | null;
+        stats: SyncLocalResponse["stats"] | null;
+    };
+    reconcile: {
+        checked: boolean;
+        error: string | null;
+        canApply: boolean;
+        status: "not_available" | "not_needed" | ReconcilePreflightResponse["status"];
+        blockedReasons: CollabStatusBlockedReason[];
+        warnings: string[];
+        targetHeadCommitHash: string | null;
+        targetHeadCommitId: string | null;
+    };
+    alignment: {
+        checked: boolean;
+        error: string | null;
+        repoState: CollabRepoStateKind | null;
+        canRecordTurn: boolean;
+        pendingFinalize: CollabPendingFinalizeSummary;
+        baseline: {
+            lastSnapshotId: string | null;
+            lastSnapshotHash: string | null;
+            lastServerHeadHash: string | null;
+            lastSeenLocalCommitHash: string | null;
+        };
+        current: {
+            snapshotHash: string | null;
+            serverHeadHash: string | null;
+            serverHeadCommitId: string | null;
+            localCommitHash: string | null;
+        };
+    };
+    recommendedAction: CollabStatusRecommendedAction;
+    warnings: string[];
+};
+type SyncLocalResponse = {
+    status: "up_to_date" | "delta_ready" | "ready_to_fast_forward" | "base_unknown" | "conflict_risk";
+    baseCommitHash: string;
+    targetCommitHash: string;
+    targetCommitId: string;
+    bundleRef: string | null;
+    bundleBase64: string | null;
+    bundleEncoding: "base64" | null;
+    bundleSizeBytes: number;
+    stats: {
+        changedFilesCount: number;
+        insertions: number;
+        deletions: number;
+    };
+    warnings: string[];
+};
+type AppHeadResponse = {
+    appId: string;
+    headCommitId: string;
+    headCommitHash: string;
+    status: string;
+    updatedAt: string;
+};
+type AppDeltaResponse = {
+    status: "up_to_date" | "delta_ready" | "base_unknown" | "content_equivalent" | "conflict_risk";
+    baseHeadHash: string;
+    targetHeadHash: string;
+    targetHeadCommitId: string | null;
+    diff: string;
+    diffSha256: string | null;
+    stats: {
+        changedFilesCount: number;
+        insertions: number;
+        deletions: number;
+    };
+    warnings: string[];
+};
+type SyncUpstreamResponse = {
+    status: "up-to-date" | "queued";
+    mergeRequestId?: string;
+};
+type CollabRecordingPreflightStatus = "not_git_repo" | "not_bound" | "branch_binding_missing" | "family_ambiguous" | "missing_head" | "branch_mismatch" | "metadata_conflict" | "ready" | "pull_required" | "re_anchor_required" | "reconcile_required";
+type CollabRecordingPreflight = {
+    status: CollabRecordingPreflightStatus;
+    repoState: CollabRepoStateKind | null;
+    repoRoot: string | null;
+    appId: string | null;
+    currentBranch: string | null;
+    branchName: string | null;
+    headCommitHash: string | null;
+    worktreeClean: boolean;
+    syncStatus: SyncLocalResponse["status"] | AppDeltaResponse["status"] | null;
+    syncTargetCommitHash: string | null;
+    syncTargetCommitId: string | null;
+    reconcileTargetHeadCommitHash: string | null;
+    reconcileTargetHeadCommitId: string | null;
+    warnings: string[];
+    hint: string | null;
+};
+type ReconcilePreflightResponse = {
+    status: "up_to_date" | "ready_to_reconcile" | "metadata_conflict";
+    localHeadCommitHash: string;
+    targetHeadCommitId: string;
+    targetHeadCommitHash: string;
+    warnings: string[];
+};
+type AppReconcileResponse = {
+    id: string;
+    appId: string;
+    uploadId: string;
+    queueItemId: string | null;
+    requestedBy: string;
+    repoFingerprint: string | null;
+    remoteUrl: string | null;
+    defaultBranch: string | null;
+    localHeadCommitHash: string;
+    targetHeadCommitId: string | null;
+    targetHeadCommitHash: string | null;
+    mergeBaseCommitHash: string | null;
+    reconciledHeadCommitId: string | null;
+    reconciledHeadCommitHash: string | null;
+    localCommitHashes: string[];
+    reconciledCommitIds: string[];
+    reconciledCommitHashes: string[];
+    status: "pending" | "queued" | "processing" | "succeeded" | "failed" | "manual_reconcile_required" | "cancelled";
+    failureKind: string | null;
+    statusError: string | null;
+    idempotencyKey: string | null;
+    resultBundleRef: string | null;
+    queuePosition?: number | null;
+    runId?: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+type CollabApproveResult = {
+    mode: CollabApproveMode;
+    mergeRequestId: string;
+    terminalStatus: MergeRequestStatus;
+    targetAppId: string;
+    mergeRequest: MergeRequest;
+    repoRoot?: string;
+    localSync?: {
+        status: SyncLocalResponse["status"];
+        branch: string;
+        repoRoot: string;
+        baseCommitHash: string;
+        targetCommitHash: string;
+        targetCommitId: string | null;
+        stats: SyncLocalResponse["stats"];
+        bundleRef?: string | null;
+        bundleSizeBytes?: number;
+        localCommitHash: string | null;
+        applied: boolean;
+        dryRun: boolean;
+    };
+};
+type CollabTurn = {
+    id: string;
+    appId: string;
+    threadId: string;
+    humanMessageId: string;
+    assistantMessageId: string;
+    changeStepId: string | null;
+    actor: {
+        type: string;
+        name: string | null;
+        version: string | null;
+        provider: string | null;
+    };
+    workspaceMetadata: JsonObject | null;
+    idempotencyKey: string | null;
+    createdBy: string;
+    createdAt: string;
+    updatedAt: string;
+    prompt: string | null;
+    assistantResponse: string | null;
+};
+type CollabFinalizeTurnMode = "changed_turn" | "no_diff_turn";
+type CollabFinalizeTurnAutoSync = {
+    requested: boolean;
+    eligible: boolean;
+    attempted: boolean;
+    applied: boolean;
+    trackedChangesDiscarded: boolean;
+    capturedUntrackedPathsCandidate: string[];
+    localHeadBefore: string | null;
+    localHeadAfter: string | null;
+    localRepoMutated: boolean;
+};
+type CollabFinalizeTurnResult = {
+    mode: CollabFinalizeTurnMode;
+    idempotencyKey: string;
+    queued: boolean;
+    jobId: string | null;
+    repoState: CollabRepoStateKind | null;
+    changeStep: JsonObject | null;
+    collabTurn: CollabTurn | null;
+    autoSync: CollabFinalizeTurnAutoSync | null;
+    warnings: string[];
+};
+type InvitationScopeType = "organization" | "project" | "app";
+type MembershipScopeType = InvitationScopeType;
+type OrganizationMemberRole = "owner" | "admin" | "member" | "viewer";
+type ProjectMemberRole = "owner" | "maintainer" | "editor" | "viewer";
+type AppMemberRole = "owner" | "maintainer" | "editor" | "viewer";
+type OrganizationMember = {
+    id: string;
+    userId: string;
+    organizationId: string;
+    role: OrganizationMemberRole;
+    invitedBy: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+type ProjectMember = {
+    id: string;
+    userId: string;
+    projectId: string;
+    role: ProjectMemberRole;
+    invitedBy: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+type AppMember = {
+    id: string;
+    userId: string;
+    appId: string;
+    role: AppMemberRole;
+    invitedBy: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+type CollabMember = OrganizationMember | ProjectMember | AppMember;
+type CollabApiClient = {
+    resolveProjectBinding(params: {
+        repoFingerprint?: string;
+        remoteUrl?: string;
+        branchName?: string;
+    }): Promise<unknown>;
+    resolveProjectLaneBinding(params: {
+        projectId?: string;
+        repoFingerprint?: string;
+        remoteUrl?: string;
+        defaultBranch?: string;
+        branchName: string;
+    }): Promise<unknown>;
+    ensureProjectLaneBinding(payload: {
+        projectId?: string;
+        repoFingerprint?: string;
+        remoteUrl?: string;
+        defaultBranch?: string;
+        branchName: string;
+        seedAppId?: string;
+        seedHeadCommitHash?: string;
+    }): Promise<unknown>;
+    bootstrapFreshProjectLane(payload: {
+        projectId?: string;
+        repoFingerprint?: string;
+        remoteUrl?: string;
+        defaultBranch?: string;
+        branchName: string;
+        seedAppId: string;
+        seedHeadCommitHash?: string;
+    }): Promise<unknown>;
+    getOrganization(orgId: string): Promise<unknown>;
+    getProject(projectId: string): Promise<unknown>;
+    listApps(params?: {
+        projectId?: string;
+        organizationId?: string;
+        ownership?: "mine" | "shared" | "all";
+        accessScope?: "all_readable" | "explicit_member";
+        createdBy?: "me" | string;
+        forked?: "only" | "exclude" | "all";
+        limit?: number;
+        offset?: number;
+    }): Promise<unknown>;
+    getApp(appId: string): Promise<unknown>;
+    getAppHead(appId: string): Promise<unknown>;
+    getAppDelta(appId: string, payload: {
+        baseHeadHash: string;
+        targetHeadHash?: string;
+        localSnapshotHash?: string;
+        repoFingerprint?: string;
+        remoteUrl?: string;
+        defaultBranch?: string;
+    }): Promise<unknown>;
+    getMergeRequest(mrId: string): Promise<unknown>;
+    presignImportUploadFirstParty(payload: {
+        file: {
+            name: string;
+            mimeType: string;
+            size: number;
+            checksumSha256?: string;
+        };
+    }): Promise<unknown>;
+    importFromUploadFirstParty(payload: {
+        uploadId: string;
+        appName?: string;
+        threadId?: string;
+        branch?: string;
+        path?: string;
+        platform?: string;
+        isPublic?: boolean;
+        remoteUrl?: string;
+        defaultBranch?: string;
+        repoFingerprint?: string;
+        headCommitHash?: string;
+        forceNew?: boolean;
+    }): Promise<unknown>;
+    forkApp(appId: string, payload?: {
+        name?: string;
+        platform?: string;
+        forkedFromCommitId?: string;
+        branchName?: string;
+    }): Promise<unknown>;
+    downloadAppBundle(appId: string): Promise<{
+        data: Buffer;
+        fileName: string | null;
+        contentType: string | null;
+    }>;
+    createChangeStep(appId: string, payload: {
+        threadId?: string;
+        collabLaneId?: string;
+        prompt: string;
+        assistantResponse?: string;
+        diff: string;
+        baseCommitHash?: string | null;
+        headCommitHash?: string | null;
+        changedFilesCount?: number;
+        insertions?: number;
+        deletions?: number;
+        actor?: {
+            type?: string;
+            name?: string;
+            version?: string;
+            provider?: string;
+        };
+        workspaceMetadata?: Record<string, unknown>;
+        idempotencyKey?: string;
+    }): Promise<unknown>;
+    startChangeStepReplay(appId: string, payload: {
+        prompt: string;
+        assistantResponse?: string;
+        diff: string;
+        baseCommitHash: string;
+        targetHeadCommitHash: string;
+        expectedPaths: string[];
+        actor?: {
+            type?: string;
+            name?: string;
+            version?: string;
+            provider?: string;
+        };
+        workspaceMetadata?: Record<string, unknown>;
+        idempotencyKey?: string;
+    }): Promise<unknown>;
+    getChangeStepReplay(appId: string, replayId: string): Promise<unknown>;
+    getChangeStepReplayDiff(appId: string, replayId: string): Promise<unknown>;
+    createCollabTurn(appId: string, payload: {
+        threadId?: string;
+        collabLaneId?: string;
+        prompt: string;
+        assistantResponse: string;
+        actor?: {
+            type?: string;
+            name?: string;
+            version?: string;
+            provider?: string;
+        };
+        workspaceMetadata?: Record<string, unknown>;
+        idempotencyKey?: string;
+    }): Promise<unknown>;
+    attachCollabTurnUsage(appId: string, payload: {
+        prompt: string;
+        workspaceMetadata: {
+            turnUsage: TurnUsagePayload;
+        } & Record<string, unknown>;
+    }): Promise<unknown>;
+    getChangeStep(appId: string, changeStepId: string): Promise<unknown>;
+    listMergeRequests(params?: {
+        queue?: MergeRequestQueue;
+        appId?: string;
+        sourceAppId?: string;
+        targetAppId?: string;
+        status?: string | string[];
+        kind?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<unknown>;
+    listCollabTurns(appId: string, params?: {
+        limit?: number;
+        offset?: number;
+        changeStepId?: string;
+        threadId?: string;
+        collabLaneId?: string;
+        createdAfter?: string;
+        createdBefore?: string;
+    }): Promise<unknown>;
+    openMergeRequest(sourceAppId: string): Promise<unknown>;
+    getMergeRequestReview(mrId: string): Promise<unknown>;
+    updateMergeRequest(mrId: string, payload: {
+        title?: string;
+        description?: string;
+        status?: string;
+    }): Promise<unknown>;
+    createOrganizationInvite(orgId: string, payload: {
+        email: string;
+        role?: string;
+        ttlDays?: number;
+    }): Promise<unknown>;
+    createProjectInvite(projectId: string, payload: {
+        email: string;
+        role?: string;
+        ttlDays?: number;
+    }): Promise<unknown>;
+    createAppInvite(appId: string, payload: {
+        email: string;
+        role?: string;
+        ttlDays?: number;
+    }): Promise<unknown>;
+    listOrganizationMembers(orgId: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<unknown>;
+    updateOrganizationMember(orgId: string, userId: string, payload: {
+        role: OrganizationMemberRole;
+    }): Promise<unknown>;
+    listProjectMembers(projectId: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<unknown>;
+    updateProjectMember(projectId: string, userId: string, payload: {
+        role: ProjectMemberRole;
+    }): Promise<unknown>;
+    listAppMembers(appId: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<unknown>;
+    updateAppMember(appId: string, userId: string, payload: {
+        role: AppMemberRole;
+    }): Promise<unknown>;
+    listOrganizationInvites(orgId: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<unknown>;
+    listProjectInvites(projectId: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<unknown>;
+    listAppInvites(appId: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<unknown>;
+    resendOrganizationInvite(orgId: string, inviteId: string, payload?: {
+        ttlDays?: number;
+    }): Promise<unknown>;
+    resendProjectInvite(projectId: string, inviteId: string, payload?: {
+        ttlDays?: number;
+    }): Promise<unknown>;
+    resendAppInvite(appId: string, inviteId: string, payload?: {
+        ttlDays?: number;
+    }): Promise<unknown>;
+    revokeOrganizationInvite(orgId: string, inviteId: string): Promise<unknown>;
+    revokeProjectInvite(projectId: string, inviteId: string): Promise<unknown>;
+    revokeAppInvite(appId: string, inviteId: string): Promise<unknown>;
+    syncUpstreamApp(appId: string): Promise<unknown>;
+    preflightAppReconcile(appId: string, payload: {
+        localHeadCommitHash: string;
+        repoFingerprint?: string;
+        remoteUrl?: string;
+        defaultBranch?: string;
+    }): Promise<unknown>;
+    startAppReconcile(appId: string, payload: {
+        uploadId: string;
+        localHeadCommitHash: string;
+        repoFingerprint?: string;
+        remoteUrl?: string;
+        defaultBranch?: string;
+        idempotencyKey?: string;
+    }): Promise<unknown>;
+    getAppReconcile(appId: string, reconcileId: string): Promise<unknown>;
+    downloadAppReconcileBundle(appId: string, reconcileId: string): Promise<{
+        data: Buffer;
+        fileName: string | null;
+        contentType: string | null;
+    }>;
+    syncLocalApp(appId: string, payload: {
+        baseCommitHash: string;
+        repoFingerprint?: string;
+        remoteUrl?: string;
+        defaultBranch?: string;
+        dryRun?: boolean;
+    }): Promise<unknown>;
+};
+
+export type { AppDeltaResponse as A, ProjectMemberRole as B, CollabApiClient as C, SyncLocalResponse as D, SyncUpstreamResponse as E, TurnUsageCaptureSource as F, TurnUsageConfidence as G, TurnUsagePreviousPatch as H, InvitationScopeType as I, JsonObject as J, MergeRequestQueue as M, OrganizationMember as O, ProjectMember as P, ReconcilePreflightResponse as R, ServerToolUsage as S, TurnUsage as T, TurnUsagePayload as a, CollabFinalizeTurnResult as b, CollabRecordingPreflight as c, CollabApproveMode as d, CollabApproveResult as e, MergeRequest as f, CollabMember as g, CollabStatus as h, MergeRequestReview as i, AppHeadResponse as j, AppMember as k, AppMemberRole as l, AppReconcileResponse as m, CollabFinalizeTurnAutoSync as n, CollabFinalizeTurnMode as o, CollabPendingFinalizeState as p, CollabPendingFinalizeSummary as q, CollabRecordingPreflightStatus as r, CollabRepoStateKind as s, CollabStatusBlockedReason as t, CollabStatusRecommendedAction as u, CollabTurn as v, MembershipScopeType as w, MergeRequestStatus as x, ModelCall as y, OrganizationMemberRole as z };