@remixhq/core 0.1.2

package/dist/collab.d.ts

@@ -0,0 +1,680 @@
+type JsonObject = Record<string, any>;
+type MergeRequestStatus = "open" | "approved" | "rejected" | "merged" | "closed";
+type MergeRequest = {
+    id: string;
+    sourceAppId: string;
+    sourceCommitId: string;
+    sourceTipCommitId: string | null;
+    targetAppId: string;
+    targetCommitId: string | null;
+    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" | "missing_head" | "detached_head" | "branch_mismatch" | "dirty_worktree" | "metadata_conflict" | "remote_error";
+type CollabStatusRecommendedAction = "init" | "sync" | "reconcile" | "review_inbox" | "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;
+        defaultBranch: string | null;
+        preferredBranch: string | 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;
+    };
+    recommendedAction: CollabStatusRecommendedAction;
+    warnings: string[];
+};
+type SyncLocalResponse = {
+    status: "up_to_date" | "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 SyncUpstreamResponse = {
+    status: "up-to-date" | "queued";
+    mergeRequestId?: string;
+};
+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;
+        stats: SyncLocalResponse["stats"];
+        bundleRef?: string | null;
+        bundleSizeBytes?: number;
+        localCommitHash: string;
+        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 InvitationScopeType = "organization" | "project" | "app";
+type CollabApiClient = {
+    resolveProjectBinding(params: {
+        repoFingerprint?: string;
+        remoteUrl?: string;
+    }): Promise<unknown>;
+    getOrganization(orgId: string): Promise<unknown>;
+    getProject(projectId: string): Promise<unknown>;
+    listApps(params?: {
+        projectId?: string;
+        organizationId?: string;
+        forked?: "only" | "exclude" | "all";
+    }): Promise<unknown>;
+    getApp(appId: 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;
+        path?: string;
+        platform?: string;
+        isPublic?: boolean;
+        remoteUrl?: string;
+        defaultBranch?: string;
+        repoFingerprint?: string;
+        headCommitHash?: string;
+    }): Promise<unknown>;
+    forkApp(appId: string, payload?: {
+        name?: string;
+        platform?: string;
+        forkedFromCommitId?: string;
+    }): Promise<unknown>;
+    downloadAppBundle(appId: string): Promise<{
+        data: Buffer;
+        fileName: string | null;
+        contentType: string | null;
+    }>;
+    createChangeStep(appId: string, payload: {
+        threadId?: 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;
+        prompt: string;
+        assistantResponse: string;
+        actor?: {
+            type?: string;
+            name?: string;
+            version?: string;
+            provider?: string;
+        };
+        workspaceMetadata?: Record<string, unknown>;
+        idempotencyKey?: string;
+    }): Promise<unknown>;
+    getChangeStep(appId: string, changeStepId: string): Promise<unknown>;
+    listMergeRequests(params?: {
+        sourceAppId?: string;
+        targetAppId?: string;
+        status?: string | string[];
+        kind?: 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>;
+    listOrganizationInvites(orgId: string): Promise<unknown>;
+    listProjectInvites(projectId: string): Promise<unknown>;
+    listAppInvites(appId: string): 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>;
+};
+
+declare function collabAdd(params: {
+    api: CollabApiClient;
+    cwd: string;
+    prompt: string;
+    assistantResponse?: string | null;
+    diff?: string | null;
+    diffSource?: "worktree" | "external";
+    sync?: boolean;
+    allowBranchMismatch?: boolean;
+    idempotencyKey?: string | null;
+    actor?: {
+        type?: string;
+        name?: string;
+        version?: string;
+        provider?: string;
+    };
+}): Promise<JsonObject>;
+
+declare function collabRecordTurn(params: {
+    api: CollabApiClient;
+    cwd: string;
+    prompt: string;
+    assistantResponse: string;
+    allowBranchMismatch?: boolean;
+    idempotencyKey?: string | null;
+    actor?: {
+        type?: string;
+        name?: string;
+        version?: string;
+        provider?: string;
+    };
+}): Promise<CollabTurn>;
+
+declare function collabApprove(params: {
+    api: CollabApiClient;
+    mrId: string;
+    mode: CollabApproveMode;
+    cwd?: string;
+    allowBranchMismatch?: boolean;
+}): Promise<CollabApproveResult>;
+
+declare function collabInbox(params: {
+    api: CollabApiClient;
+}): Promise<{
+    mergeRequests: any;
+}>;
+
+declare function collabInit(params: {
+    api: CollabApiClient;
+    cwd: string;
+    appName?: string | null;
+    path?: string | null;
+    forceNew?: boolean;
+}): Promise<{
+    warnings?: string[] | undefined;
+    reused: boolean;
+    projectId: string;
+    appId: string;
+    upstreamAppId: string;
+    bindingPath: string;
+    repoRoot: string;
+} | {
+    warnings?: string[] | undefined;
+    reused: boolean;
+    projectId: string;
+    appId: string;
+    upstreamAppId: string;
+    bindingPath: string;
+    repoRoot: string;
+    remoteUrl: string | null;
+    defaultBranch: string | null;
+    preferredBranch: string | null;
+}>;
+
+declare function collabInvite(params: {
+    api: CollabApiClient;
+    cwd: string;
+    email: string;
+    role?: string | null;
+    ttlDays?: number;
+    scope?: InvitationScopeType | null;
+    targetId?: string | null;
+}): Promise<{
+    scopeType: InvitationScopeType;
+    targetId: string;
+}>;
+
+declare function collabList(params: {
+    api: CollabApiClient;
+}): Promise<{
+    apps: JsonObject[];
+}>;
+
+declare function collabReconcile(params: {
+    api: CollabApiClient;
+    cwd: string;
+    dryRun: boolean;
+    allowBranchMismatch?: boolean;
+}): Promise<{
+    status: "ready_to_fast_forward";
+    branch: string;
+    repoRoot: string;
+    baseCommitHash: string;
+    targetCommitHash: string;
+    targetCommitId: string;
+    stats: {
+        changedFilesCount: number;
+        insertions: number;
+        deletions: number;
+    };
+    bundleRef: string | null;
+    bundleSizeBytes: number;
+    localCommitHash: string;
+    applied: boolean;
+    dryRun: boolean;
+} | {
+    status: "up_to_date";
+    branch: string;
+    repoRoot: string;
+    baseCommitHash: string;
+    targetCommitHash: string;
+    targetCommitId: string;
+    stats: {
+        changedFilesCount: number;
+        insertions: number;
+        deletions: number;
+    };
+    localCommitHash: string;
+    applied: boolean;
+    dryRun: boolean;
+} | {
+    status: "ready_to_reconcile";
+    branch: string;
+    repoRoot: string;
+    localHeadCommitHash: string;
+    targetHeadCommitId: string;
+    targetHeadCommitHash: string;
+    warnings: string[];
+    applied: boolean;
+    dryRun: boolean;
+} | {
+    status: "queued" | "pending" | "processing" | "succeeded" | "failed" | "manual_reconcile_required" | "cancelled";
+    reconcileId: string;
+    mergeBaseCommitHash: string | null;
+    reconciledHeadCommitId: string | null;
+    reconciledHeadCommitHash: string | null;
+    backupBranchName: string;
+    localCommitHash: string;
+    applied: boolean;
+    dryRun: boolean;
+    warnings: string[];
+    branch: string;
+    repoRoot: string;
+    localHeadCommitHash: string;
+    targetHeadCommitId: string;
+    targetHeadCommitHash: string;
+}>;
+
+declare function collabReject(params: {
+    api: CollabApiClient;
+    mrId: string;
+}): Promise<JsonObject>;
+
+declare function collabRemix(params: {
+    api: CollabApiClient;
+    cwd: string;
+    appId?: string | null;
+    name?: string | null;
+    outputDir?: string | null;
+}): Promise<{
+    appId: string;
+    projectId: string;
+    upstreamAppId: string;
+    bindingPath: string;
+    repoRoot: string;
+}>;
+
+declare function collabRequestMerge(params: {
+    api: CollabApiClient;
+    cwd: string;
+}): Promise<JsonObject>;
+
+declare function collabStatus(params: {
+    api?: CollabApiClient | null;
+    cwd: string;
+}): Promise<CollabStatus>;
+
+declare function collabSync(params: {
+    api: CollabApiClient;
+    cwd: string;
+    dryRun: boolean;
+    allowBranchMismatch?: boolean;
+}): Promise<{
+    status: "ready_to_fast_forward";
+    branch: string;
+    repoRoot: string;
+    baseCommitHash: string;
+    targetCommitHash: string;
+    targetCommitId: string;
+    stats: {
+        changedFilesCount: number;
+        insertions: number;
+        deletions: number;
+    };
+    bundleRef: string | null;
+    bundleSizeBytes: number;
+    localCommitHash: string;
+    applied: boolean;
+    dryRun: boolean;
+} | {
+    status: "up_to_date";
+    branch: string;
+    repoRoot: string;
+    baseCommitHash: string;
+    targetCommitHash: string;
+    targetCommitId: string;
+    stats: {
+        changedFilesCount: number;
+        insertions: number;
+        deletions: number;
+    };
+    localCommitHash: string;
+    applied: boolean;
+    dryRun: boolean;
+}>;
+
+declare function collabSyncUpstream(params: {
+    api: CollabApiClient;
+    cwd: string;
+}): Promise<{
+    status: "up-to-date";
+    repoRoot: string;
+    appId: string;
+    upstreamAppId: string;
+    localUpdated: boolean;
+} | {
+    warnings?: string[] | undefined;
+    status: "queued";
+    mergeRequestId: string | null;
+    repoRoot: string;
+    appId: string;
+    upstreamAppId: string;
+    remoteHeadCommitId: string | null;
+    localSync: {
+        warnings?: string[] | undefined;
+        status: "ready_to_fast_forward";
+        branch: string;
+        repoRoot: string;
+        baseCommitHash: string;
+        targetCommitHash: string;
+        targetCommitId: string;
+        stats: {
+            changedFilesCount: number;
+            insertions: number;
+            deletions: number;
+        };
+        bundleRef: string | null;
+        bundleSizeBytes: number;
+        localCommitHash: string;
+        applied: boolean;
+        dryRun: boolean;
+    } | {
+        warnings?: string[] | undefined;
+        status: "up_to_date";
+        branch: string;
+        repoRoot: string;
+        baseCommitHash: string;
+        targetCommitHash: string;
+        targetCommitId: string;
+        stats: {
+            changedFilesCount: number;
+            insertions: number;
+            deletions: number;
+        };
+        localCommitHash: string;
+        applied: boolean;
+        dryRun: boolean;
+    };
+    localUpdated: boolean;
+}>;
+
+declare function collabView(params: {
+    api: CollabApiClient;
+    mrId: string;
+}): Promise<MergeRequestReview>;
+
+export { type AppReconcileResponse, type CollabApiClient, type CollabApproveMode, type CollabApproveResult, type CollabStatus, type CollabStatusBlockedReason, type CollabStatusRecommendedAction, type CollabTurn, type InvitationScopeType, type JsonObject, type MergeRequest, type MergeRequestReview, type MergeRequestStatus, type ReconcilePreflightResponse, type SyncLocalResponse, type SyncUpstreamResponse, collabAdd, collabApprove, collabInbox, collabInit, collabInvite, collabList, collabReconcile, collabRecordTurn, collabReject, collabRemix, collabRequestMerge, collabStatus, collabSync, collabSyncUpstream, collabView };