@vapi-network/core 0.8.0 → 0.9.0

package/dist/tasks/operations.d.ts

@@ -0,0 +1,722 @@
+export { PENDING_SERVER_ROUTES, TASK_LIMITS, TASK_WATCH_STATES, TaskInputError, TaskOperationError, cachedMoneyClient, fundingRefusalReason, isMissingTaskEntity, nextTaskEvents, orderReceipts, parseTaskDuration, proposalTerms, publicNotFoundFetch, readTaskFile, resolveTaskBearer, taskEventState, taskMoneySnapshot, taskPolicyForWallet, taskRequest, taskStateMatches, validTaskBrief, } from "./operation-support.js";
+export type { MoneySnapshot, ProposalTerms, TaskOperationContext, TaskPolicy, TaskRoute, TaskUnlock, } from "./operation-support.js";
+import { type Address } from "viem";
+import { signScope, type SignScopeActionResult, type TaskDeliveryFile, type TaskFundingApproval } from "./actions.js";
+import type { TasksClient } from "./client.js";
+import type { PendingTransactions } from "./pending-transactions.js";
+import { type TaskMoney } from "./money.js";
+import { orderReceipts, type MoneySnapshot, type TaskOperationContext, type TaskPolicy, type TaskUnlock } from "./operation-support.js";
+import type { BoardQuery, CreateOrderInput, CreateOrderResponse, GetOrderResponse, ProposeResponse, SubmissionProof, SubmitResponse, UploadFileInput } from "./types.js";
+import type { SpendCaps } from "../config.js";
+import type { WalletName } from "../wallet-name.js";
+export declare function searchTasks(context: TaskOperationContext, input: {
+    tab?: BoardQuery["tab"];
+    limit?: number;
+    open?: boolean;
+    min?: bigint;
+}): Promise<{
+    cards: {
+        [x: string]: unknown;
+        id: string;
+        title: string;
+        brief: string;
+        shape: "task" | "open-bounty";
+        amount: {
+            [x: string]: unknown;
+            gross: string;
+            fee: string | null;
+            net: string | null;
+            asset: "USDC";
+            feeBp: number | null;
+        } | null;
+        deadlineAt: string | null;
+        durationSeconds: number | null;
+        createdAt: string;
+        state: "paid" | "expired" | "open" | "disputed" | "funded" | "delivered" | "refunded" | "awarded" | "closed";
+        poster: {
+            [x: string]: unknown;
+            address: string;
+            badge: {
+                [x: string]: unknown;
+                kind: "agent" | "human";
+                source: "none" | "agent-link" | "erc8004";
+                owner: {
+                    [x: string]: unknown;
+                    profileId: string;
+                    label: string;
+                } | null;
+                verifiedWorker: boolean;
+            };
+        };
+        takers: number;
+        awards: number;
+        maxAwards: number;
+        proofKinds: string[];
+        audience: string;
+        receiptUrl: string | null;
+    }[];
+    pinned: {
+        [x: string]: unknown;
+        id: string;
+        title: string;
+        brief: string;
+        shape: "task" | "open-bounty";
+        amount: {
+            [x: string]: unknown;
+            gross: string;
+            fee: string | null;
+            net: string | null;
+            asset: "USDC";
+            feeBp: number | null;
+        } | null;
+        deadlineAt: string | null;
+        durationSeconds: number | null;
+        createdAt: string;
+        state: "paid" | "expired" | "open" | "disputed" | "funded" | "delivered" | "refunded" | "awarded" | "closed";
+        poster: {
+            [x: string]: unknown;
+            address: string;
+            badge: {
+                [x: string]: unknown;
+                kind: "agent" | "human";
+                source: "none" | "agent-link" | "erc8004";
+                owner: {
+                    [x: string]: unknown;
+                    profileId: string;
+                    label: string;
+                } | null;
+                verifiedWorker: boolean;
+            };
+        };
+        takers: number;
+        awards: number;
+        maxAwards: number;
+        proofKinds: string[];
+        audience: string;
+        receiptUrl: string | null;
+    } | null;
+    numbers: {
+        [x: string]: unknown;
+        escrowedNow: string;
+        paidOutAllTime: string;
+        tasksSettled: number;
+        agentsActive30d: number;
+        feeBp: number | null;
+        call?: {
+            [x: string]: unknown;
+            routedThroughVapi30d: number;
+            paymentsOnBase30d: number;
+            volumeUsdOnBase30d: string;
+            asOf: string;
+        } | null | undefined;
+    };
+    nextCursor: string | null;
+}>;
+export declare function postTask(context: TaskOperationContext, input: {
+    order: CreateOrderInput;
+    amount: bigint;
+    intake?: "proposals" | "submissions";
+    maxAwards?: number;
+    deadlineAt: string;
+    webhook?: string;
+    onFeeUnavailable?: () => void;
+}): Promise<{
+    result: CreateOrderResponse & {
+        webhook?: Awaited<ReturnType<TasksClient["configureWebhook"]>>;
+    };
+    money: TaskMoney;
+    feeUnavailable: boolean;
+    unsupportedFields: string[];
+    postingMovesMoney: false;
+}>;
+export declare function proposeTask(context: TaskOperationContext, input: {
+    id: string;
+    price: bigint;
+    durationSeconds: number;
+    note: string;
+    unlock: TaskUnlock;
+}): Promise<ProposeResponse>;
+export declare function submitTask(context: TaskOperationContext, input: {
+    id: string;
+    proof: SubmissionProof[];
+    files: UploadFileInput[];
+    unlock: TaskUnlock;
+}): Promise<SubmitResponse>;
+export type PrivateTaskView = GetOrderResponse & {
+    receipts: ReturnType<typeof orderReceipts>;
+    receiptUrl?: string;
+    receiptUrlSource?: "escrow";
+};
+export type PublicTaskView = {
+    task: NonNullable<Awaited<ReturnType<TasksClient["publicTask"]>>>;
+    receiptUrl?: string;
+    receiptUrlSource?: "server";
+};
+export declare function showTask(context: TaskOperationContext, input: {
+    id: string;
+    signedIn: true;
+}): Promise<PrivateTaskView>;
+export declare function showTask(context: TaskOperationContext, input: {
+    id: string;
+    signedIn: false;
+}): Promise<PublicTaskView>;
+export declare function showTask(context: TaskOperationContext, input: {
+    id: string;
+    signedIn: boolean;
+}): Promise<PrivateTaskView | PublicTaskView>;
+export declare function taskStatus(context: TaskOperationContext, input: {
+    id: string;
+}): Promise<{
+    receiptUrl?: string | undefined;
+    receiptUrlSource?: "server" | undefined;
+    task: {
+        [x: string]: unknown;
+        id: string;
+        title: string;
+        brief: string;
+        shape: "task" | "open-bounty";
+        amount: {
+            [x: string]: unknown;
+            gross: string;
+            fee: string | null;
+            net: string | null;
+            asset: "USDC";
+            feeBp: number | null;
+        } | null;
+        deadlineAt: string | null;
+        durationSeconds: number | null;
+        createdAt: string;
+        state: "paid" | "expired" | "open" | "disputed" | "funded" | "delivered" | "refunded" | "awarded" | "closed";
+        poster: {
+            [x: string]: unknown;
+            address: string;
+            badge: {
+                [x: string]: unknown;
+                kind: "agent" | "human";
+                source: "none" | "agent-link" | "erc8004";
+                owner: {
+                    [x: string]: unknown;
+                    profileId: string;
+                    label: string;
+                } | null;
+                verifiedWorker: boolean;
+            };
+        };
+        takers: number;
+        awards: number;
+        maxAwards: number;
+        proofKinds: string[];
+        audience: string;
+        receiptUrl: string | null;
+        briefFull: string;
+        children: {
+            [x: string]: unknown;
+            orderId: string;
+            worker: {
+                [x: string]: unknown;
+                address: string;
+                badge: {
+                    [x: string]: unknown;
+                    kind: "agent" | "human";
+                    source: "none" | "agent-link" | "erc8004";
+                    owner: {
+                        [x: string]: unknown;
+                        profileId: string;
+                        label: string;
+                    } | null;
+                    verifiedWorker: boolean;
+                };
+            };
+            state: "paid" | "expired" | "open" | "disputed" | "funded" | "delivered" | "refunded" | "awarded" | "closed";
+            receiptUrl: string | null;
+        }[];
+    };
+}>;
+export declare function awardTask(context: TaskOperationContext, input: {
+    id: string;
+    proposalId: string;
+}): Promise<{
+    [x: string]: unknown;
+    workOrder: {
+        [x: string]: unknown;
+        version: "work-order-view-v1";
+        id: string;
+        state: "cancelled" | "open" | "awarded" | "completed";
+        title: string;
+        description: string;
+        policyFamily: "general-digital" | "software-api" | "research-data" | "design-content";
+        listingDeliveryTimeSeconds: number | null;
+        clientAddress: `0x${string}`;
+        invitedProviderAddress: `0x${string}` | null;
+        acceptedProposalId: string | null;
+        threadId: string | null;
+        role: "client" | "provider" | "proposer";
+        canFinalize: boolean;
+        proposals: {
+            [x: string]: unknown;
+            id: string;
+            workOrderId: string;
+            providerAddress: `0x${string}`;
+            state: "pending" | "rejected" | "accepted";
+            signedPayload: {
+                [x: string]: unknown;
+                version: "work-proposal-v1";
+                workOrderId: string;
+                providerAddress: `0x${string}`;
+                pricingModel: "fixed";
+                milestones: {
+                    version: "work-milestone-terms-v1";
+                    title: string;
+                    description: string;
+                    acceptanceCriteria: string[];
+                    acceptanceWindowSeconds: number;
+                    escrow: {
+                        protocol: "escrow-v1";
+                        contract: `0x${string}`;
+                    };
+                    evidenceRules: {
+                        acceptedInputs: ("text" | "private-file" | "git-commit")[];
+                        exactCommitRequired: boolean;
+                    };
+                    budget: {
+                        network: `eip155:${number}`;
+                        asset: string;
+                        amountBaseUnits: string;
+                    };
+                    workDurationSeconds?: number | undefined;
+                }[];
+                kind?: "proposal" | "submission" | undefined;
+                proof?: ({
+                    kind: "url";
+                    value: string;
+                    label?: string | undefined;
+                } | {
+                    kind: "file";
+                    value: string;
+                    label?: string | undefined;
+                })[] | undefined;
+            };
+            signature: string;
+            signatureHash: `0x${string}`;
+            proposedMilestones: {
+                version: "work-milestone-terms-v1";
+                title: string;
+                description: string;
+                acceptanceCriteria: string[];
+                acceptanceWindowSeconds: number;
+                escrow: {
+                    protocol: "escrow-v1";
+                    contract: `0x${string}`;
+                };
+                evidenceRules: {
+                    acceptedInputs: ("text" | "private-file" | "git-commit")[];
+                    exactCommitRequired: boolean;
+                };
+                budget: {
+                    network: `eip155:${number}`;
+                    asset: string;
+                    amountBaseUnits: string;
+                };
+                workDurationSeconds?: number | undefined;
+            }[];
+            acceptedAt: string | null;
+            createdAt: string;
+            updatedAt: string;
+        }[];
+        milestones: {
+            [x: string]: unknown;
+            id: string;
+            workOrderId: string;
+            ordinal: number;
+            state: "released" | "agreed" | "funding" | "funded" | "delivering" | "delivered" | "evaluating" | "refunded";
+            terms: {
+                version: "work-milestone-terms-v1";
+                title: string;
+                description: string;
+                acceptanceCriteria: string[];
+                acceptanceWindowSeconds: number;
+                escrow: {
+                    protocol: "escrow-v1";
+                    contract: `0x${string}`;
+                };
+                evidenceRules: {
+                    acceptedInputs: ("text" | "private-file" | "git-commit")[];
+                    exactCommitRequired: boolean;
+                };
+                budget: {
+                    network: `eip155:${number}`;
+                    asset: string;
+                    amountBaseUnits: string;
+                };
+                workDurationSeconds?: number | undefined;
+            };
+            termsHash: `0x${string}`;
+            termsFrozenAt: string;
+            network: `eip155:${number}`;
+            asset: string;
+            amountBaseUnits: string;
+            escrowProtocol: "escrow-v1";
+            escrowContract: `0x${string}`;
+            escrowState: "created" | "expired" | "submitted" | "locked" | "disputed" | "resolved" | null;
+            resolution: "split" | "release" | "refund" | null;
+            offerDeadlineAt: string | null;
+            workDeadlineAt: string | null;
+            acceptanceDeadlineAt: string | null;
+            dispute: {
+                [x: string]: unknown;
+                id: string;
+                state: "evidence" | "open" | "resolvable" | "executed";
+                network: string;
+                escrowAddress: `0x${string}`;
+                raisedByRole: "client" | "vendor";
+                raisedByAddress: `0x${string}`;
+                evidenceHash: `0x${string}`;
+                evidenceDeadlineAt: string;
+                reviewers: {
+                    [x: string]: unknown;
+                    address: `0x${string}`;
+                    vote: {
+                        [x: string]: unknown;
+                        outcome: "split" | "release" | "refund";
+                        txHash: `0x${string}`;
+                        votedAt: string;
+                    } | null;
+                }[];
+                outcome: "split" | "release" | "refund" | null;
+                executedTxHash: `0x${string}` | null;
+                resolvedAt: string | null;
+            } | null;
+            chainOperation: {
+                [x: string]: unknown;
+                id: string;
+                kind: "escrow-funding" | "escrow-create" | "escrow-delivery" | "escrow-release" | "escrow-dispute" | "escrow-counter-evidence" | "escrow-unmatched-resolution" | "escrow-vote" | "escrow-finalize" | "vendor-credential-mint";
+                state: "confirmed" | "prepared" | "submitted";
+                step: "create-escrow" | "approve-usdc" | "deposit-funds" | "fund-with-authorization" | "submit-delivery" | "release-funds" | "refund-buyer" | "raise-dispute" | "submit-counter-evidence" | "resolve-unmatched-dispute" | "timeout-refund" | "finalize" | "vote-dispute" | "mint-vendor-credential";
+                expectedActor: `0x${string}` | null;
+                transactionHash: `0x${string}` | null;
+                plan: {
+                    [x: string]: unknown;
+                    version: "work-transaction-plan-v2";
+                    operationId: string;
+                    step: "create-escrow" | "approve-usdc" | "deposit-funds" | "fund-with-authorization" | "submit-delivery" | "release-funds" | "refund-buyer" | "raise-dispute" | "submit-counter-evidence" | "resolve-unmatched-dispute" | "timeout-refund" | "finalize" | "vote-dispute" | "mint-vendor-credential" | "register-erc8004";
+                    chainId: number;
+                    network: `eip155:${string}`;
+                    from: `0x${string}`;
+                    to: `0x${string}`;
+                    data: `0x${string}`;
+                    value: "0";
+                } | null;
+            } | null;
+            artifact: {
+                [x: string]: unknown;
+                digest: `0x${string}`;
+            } | null;
+            fundingTxHash: `0x${string}` | null;
+            settlementTxHash: `0x${string}` | null;
+            fundedAt: string | null;
+            deliveredAt: string | null;
+            settledAt: string | null;
+            createdAt: string;
+            updatedAt: string;
+            delivery?: {
+                [x: string]: unknown;
+                id: string;
+                version: number;
+                note: string;
+                manifest: {
+                    [x: string]: unknown;
+                    files: {
+                        [x: string]: unknown;
+                        fileId: string;
+                        fileName: string;
+                        sha256: string;
+                        sizeBytes: number;
+                    }[];
+                    noteSha256: string;
+                };
+                manifestHash: `0x${string}`;
+                submittedAt: string;
+            } | null | undefined;
+        }[];
+        events: {
+            [x: string]: unknown;
+            id: string;
+            sequence: number;
+            type: string;
+            actor: string;
+            milestoneId: string | null;
+            payload: import("zod").JSONType;
+            txHash: `0x${string}` | null;
+            createdAt: string;
+        }[];
+        review: {
+            [x: string]: unknown;
+            id: string;
+            workOrderId: string;
+            clientAddress: `0x${string}`;
+            vendorProfileId: string;
+            rating: number;
+            body: string;
+            subRatings: import("zod").JSONType;
+            vendorResponse: string | null;
+            vendorRespondedAt: string | null;
+            createdAt: string;
+            updatedAt: string;
+        } | null;
+        publishedAt: string | null;
+        completedAt: string | null;
+        createdAt: string;
+        updatedAt: string;
+    };
+} | {
+    [x: string]: unknown;
+    childOrderId: string;
+    awards: number;
+    maxAwards: number;
+    parentState: "open" | "completed";
+}>;
+export declare function messageTask(context: TaskOperationContext, input: {
+    id: string;
+    body: string;
+}): Promise<{
+    [x: string]: unknown;
+    message: {
+        [x: string]: unknown;
+        id: string;
+        threadId: string;
+        senderProfileId: string;
+        senderRole: "client" | "provider" | "reviewer";
+        kind: "text" | "system" | "order-pin" | "scope-pin" | "delivery-pin";
+        body: string;
+        refType: string | null;
+        refId: string | null;
+        workOrderId: string | null;
+        orderId: string;
+        seq: number;
+        createdAt: string;
+        attachments: {
+            [x: string]: unknown;
+            id: string;
+            fileName: string;
+            mimeType: string;
+            sizeBytes: number;
+        }[];
+    };
+}>;
+export declare function threadTask(context: TaskOperationContext, input: {
+    id: string;
+    cursor?: number;
+}): Promise<{
+    [x: string]: unknown;
+    messages: {
+        [x: string]: unknown;
+        id: string;
+        threadId: string;
+        senderProfileId: string;
+        senderRole: "client" | "provider" | "reviewer";
+        kind: "text" | "system" | "order-pin" | "scope-pin" | "delivery-pin";
+        body: string;
+        refType: string | null;
+        refId: string | null;
+        workOrderId: string | null;
+        orderId: string;
+        seq: number;
+        createdAt: string;
+        attachments: {
+            [x: string]: unknown;
+            id: string;
+            fileName: string;
+            mimeType: string;
+            sizeBytes: number;
+        }[];
+    }[];
+    page: {
+        [x: string]: unknown;
+        nextBeforeSeq: number | null;
+    };
+}>;
+export declare function signTaskScope(context: TaskOperationContext, input: {
+    id: string;
+    counterparty?: string;
+    signerAddress?: Address;
+    signMessage: (message: string) => Promise<`0x${string}`>;
+    bindings?: Parameters<typeof signScope>[0]["bindings"];
+    onTerms?: Parameters<typeof signScope>[0]["onTerms"];
+}): Promise<SignScopeActionResult>;
+export declare function deliverTaskOperation(context: TaskOperationContext, input: {
+    id: string;
+    files: TaskDeliveryFile[];
+    counterparty?: string;
+    note: string;
+    onPrepared?: (manifestHash: `0x${string}`) => void;
+}): Promise<{
+    ok: true;
+    manifestHash: `0x${string}`;
+    result: import("./chain-port.js").TasksChainResult;
+}>;
+export declare function fundTaskOperation(context: TaskOperationContext & {
+    pending?: PendingTransactions;
+}, input: {
+    id: string;
+    snapshot?: MoneySnapshot;
+    policy: TaskPolicy;
+    caps: SpendCaps;
+    wallet: WalletName;
+    ledgerPath: string;
+    now: () => Date;
+    approval?: TaskFundingApproval;
+    idempotencyKey?: () => string;
+    beforeChainFund?: () => void;
+    counterparty?: string;
+}): Promise<{
+    ok: false;
+    reason: "policy.perTask" | "policy.perDay";
+    money: TaskMoney;
+    policySource: "defaults" | "agent-profile";
+    policyDecision: "policy.perTask" | "policy.perDay";
+    approval?: undefined;
+    declined?: undefined;
+    result?: undefined;
+} | {
+    ok: false;
+    approval: true;
+    money: TaskMoney;
+    policySource: "defaults" | "agent-profile";
+    policyDecision: "approval";
+    reason?: undefined;
+    declined?: undefined;
+    result?: undefined;
+} | {
+    ok: false;
+    declined: true;
+    money: TaskMoney;
+    policySource: "defaults" | "agent-profile";
+    policyDecision: "declined";
+    reason?: undefined;
+    approval?: undefined;
+    result?: undefined;
+} | {
+    ok: true;
+    money: TaskMoney;
+    policySource: "defaults" | "agent-profile";
+    policyDecision: "ok";
+    result: import("./chain-port.js").TasksChainResult;
+    reason?: undefined;
+    approval?: undefined;
+    declined?: undefined;
+}>;
+export declare function releaseTaskOperation(context: TaskOperationContext, input: {
+    id: string;
+    snapshot?: MoneySnapshot;
+    escrowId?: string;
+    counterparty?: string;
+}): Promise<import("./actions.js").TaskMoneyResult>;
+export declare function refundTaskOperation(context: TaskOperationContext, input: {
+    id: string;
+    snapshot?: MoneySnapshot;
+    escrowId?: string;
+    counterparty?: string;
+}): Promise<import("./actions.js").TaskMoneyResult>;
+export type TaskFeeOperationInput = {
+    id: string;
+    snapshot?: MoneySnapshot;
+    escrowId?: string;
+    counterparty?: string;
+    evidenceHash: string;
+    policy: TaskPolicy;
+    caps: SpendCaps;
+    wallet: WalletName;
+    ledgerPath: string;
+    now: () => Date;
+    approval?: TaskFundingApproval;
+    onFee?: (fee: bigint) => void;
+};
+export declare function disputeTaskOperation(context: TaskOperationContext, input: TaskFeeOperationInput): Promise<{
+    ok: false;
+    reason: "policy.perTask" | "policy.perDay";
+    money: TaskMoney;
+    disputeFee: import("./money.js").TaskMoneyAmount;
+    policySource: "defaults" | "agent-profile";
+    policyDecision: "policy.perTask" | "policy.perDay";
+} | {
+    ok: false;
+    approval: true;
+    policyDecision: "approval";
+    money: TaskMoney;
+    disputeFee: {
+        baseUnits: string;
+        usd: string;
+    };
+    policySource: "defaults" | "agent-profile";
+    reason?: undefined;
+} | {
+    ok: false;
+    declined: true;
+    policyDecision: "declined";
+    money: TaskMoney;
+    disputeFee: {
+        baseUnits: string;
+        usd: string;
+    };
+    policySource: "defaults" | "agent-profile";
+    reason?: undefined;
+} | {
+    ok: true;
+    result: import("./chain-port.js").TasksChainResult;
+    policyDecision: "ok";
+    money: TaskMoney;
+    disputeFee: {
+        baseUnits: string;
+        usd: string;
+    };
+    policySource: "defaults" | "agent-profile";
+    reason?: undefined;
+}>;
+export declare function counterEvidenceTaskOperation(context: TaskOperationContext, input: TaskFeeOperationInput): Promise<{
+    ok: false;
+    reason: "policy.perTask" | "policy.perDay";
+    money: TaskMoney;
+    disputeFee: import("./money.js").TaskMoneyAmount;
+    policySource: "defaults" | "agent-profile";
+    policyDecision: "policy.perTask" | "policy.perDay";
+} | {
+    ok: false;
+    approval: true;
+    policyDecision: "approval";
+    money: TaskMoney;
+    disputeFee: {
+        baseUnits: string;
+        usd: string;
+    };
+    policySource: "defaults" | "agent-profile";
+    reason?: undefined;
+} | {
+    ok: false;
+    declined: true;
+    policyDecision: "declined";
+    money: TaskMoney;
+    disputeFee: {
+        baseUnits: string;
+        usd: string;
+    };
+    policySource: "defaults" | "agent-profile";
+    reason?: undefined;
+} | {
+    ok: true;
+    result: import("./chain-port.js").TasksChainResult;
+    policyDecision: "ok";
+    money: TaskMoney;
+    disputeFee: {
+        baseUnits: string;
+        usd: string;
+    };
+    policySource: "defaults" | "agent-profile";
+    reason?: undefined;
+}>;
+export declare function resolveUnmatchedTaskOperation(context: TaskOperationContext, input: {
+    id: string;
+    snapshot?: MoneySnapshot;
+    escrowId?: string;
+    counterparty?: string;
+}): Promise<import("./actions.js").TaskMoneyResult>;
+//# sourceMappingURL=operations.d.ts.map