@bounty-ai/agent-sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,177 @@
+type SdkContractVersion = "v1";
+type AssignmentStatus = "assigned" | "verifying" | "timed_out";
+type OutcomePayload = Record<string, unknown>;
+type AssignmentResultOutput = {
+    type: "table" | "text" | "image" | "file" | "collection";
+    key?: string;
+    label?: string;
+    required?: boolean;
+    details?: Record<string, unknown>;
+};
+type AssignmentResultSchema = {
+    version?: number;
+    outputs: AssignmentResultOutput[];
+};
+type AssignmentOutcome = {
+    title: string;
+    payload: OutcomePayload;
+    requested_unit_price_value?: number;
+    requested_total_price_value?: number;
+    currency?: string;
+    time_window?: string;
+};
+type Assignment = {
+    assignment_id: string;
+    template_slug: string;
+    result_schema: AssignmentResultSchema;
+    outcome: AssignmentOutcome;
+};
+type AssignmentEnvelopeV1 = {
+    version: SdkContractVersion;
+    assignment: Assignment;
+};
+type AssignmentResult = {
+    status: AssignmentStatus;
+    result?: Record<string, unknown>;
+    error?: string;
+};
+type AssignmentAckStatus = "accepted" | "rejected";
+type AssignmentAckRequest = {
+    status: AssignmentAckStatus;
+    reason?: string;
+};
+type WebhookInput = {
+    body: string;
+    signature?: string;
+    timestamp?: string;
+};
+type SubmitResultRequest = {
+    assignmentId: string;
+    status: AssignmentStatus;
+    result?: Record<string, unknown>;
+    error?: string;
+};
+type SubmitErrorRequest = {
+    assignmentId: string;
+    error: string;
+    details?: Record<string, unknown>;
+};
+type ApiErrorBody = {
+    code?: string;
+    message?: string;
+    details?: unknown;
+};
+
+declare class SdkError extends Error {
+    constructor(message: string);
+}
+declare class ApiError extends SdkError {
+    readonly status: number;
+    readonly code: string | undefined;
+    readonly body: ApiErrorBody | null;
+    readonly retryable: boolean;
+    constructor(params: {
+        status: number;
+        message: string;
+        code: string | undefined;
+        body: ApiErrorBody | null;
+    });
+}
+
+type ClientOptions = {
+    baseUrl: string;
+    apiKey: string;
+    fetchImpl?: typeof fetch;
+};
+declare class AgentClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly fetchImpl;
+    constructor(options: ClientOptions);
+    ackAssignment(assignmentId: string, request: AssignmentAckRequest): Promise<void>;
+    submitResult(input: SubmitResultRequest): Promise<void>;
+    submitError(input: SubmitErrorRequest): Promise<void>;
+    private post;
+    private toApiError;
+}
+
+declare function computeWebhookSignature(params: {
+    webhookSecret: string;
+    timestamp: string;
+    body: string;
+}): string;
+declare function verifyWebhookSignature(params: {
+    webhookSecret: string;
+    timestamp?: string;
+    body: string;
+    signature?: string;
+}): void;
+
+declare const DEFAULT_SIGNATURE_HEADER = "x-bounty-signature";
+declare const DEFAULT_TIMESTAMP_HEADER = "x-bounty-timestamp";
+type WebhookHandlerOptions = {
+    webhookSecret: string;
+    onAssignment: (params: {
+        assignment: Assignment;
+    }) => Promise<AssignmentResult>;
+    verifySignature?: boolean;
+};
+type WebhookHttpResponse = {
+    status: number;
+    body: AssignmentResult;
+};
+declare function createWebhookHandler(options: WebhookHandlerOptions): (input: WebhookInput) => Promise<AssignmentResult>;
+declare function executeWebhook(handler: ReturnType<typeof createWebhookHandler>, input: WebhookInput): Promise<WebhookHttpResponse>;
+
+declare function createExpressWebhookHandler(options: WebhookHandlerOptions): (req: {
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+    rawBody?: string;
+}, res: {
+    status: (code: number) => {
+        json: (payload: unknown) => void;
+    };
+}) => Promise<void>;
+declare function createFastifyWebhookHandler(options: WebhookHandlerOptions): (request: {
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+    rawBody?: string;
+}, reply: {
+    code: (statusCode: number) => {
+        send: (payload: unknown) => void;
+    };
+}) => Promise<void>;
+declare function createNextWebhookHandler(options: WebhookHandlerOptions): (request: Request) => Promise<Response>;
+declare function createHonoWebhookHandler(options: WebhookHandlerOptions): (c: {
+    req: {
+        text: () => Promise<string>;
+        header: (name: string) => string | undefined;
+    };
+    json: (payload: unknown, status?: number) => Response;
+}) => Promise<Response>;
+
+declare function parseAssignmentV1(body: string): Assignment;
+declare function toAssignmentEnvelopeV1(assignment: Assignment): AssignmentEnvelopeV1;
+declare function getContractVersion(): SdkContractVersion;
+
+type TableRow = Record<string, unknown>;
+type TablePayload = {
+    table: {
+        columns: string[];
+        rows: TableRow[];
+    };
+    row_count: number;
+    rows_unique: boolean;
+    has_contact_method: boolean;
+    summary?: string;
+};
+type CreateTableResultOptions = {
+    columns?: string[];
+    summary?: string;
+    contactFields?: string[];
+    dedupeBy?: string[];
+};
+declare function createTablePayload(rows: TableRow[], options?: CreateTableResultOptions): TablePayload;
+declare function createTableResult(rows: TableRow[], options?: CreateTableResultOptions): Pick<AssignmentResult, "result">;
+
+export { AgentClient, ApiError, type ApiErrorBody, type Assignment, type AssignmentAckRequest, type AssignmentAckStatus, type AssignmentEnvelopeV1, type AssignmentOutcome, type AssignmentResult, type AssignmentResultOutput, type AssignmentResultSchema, type AssignmentStatus, type ClientOptions, type CreateTableResultOptions, DEFAULT_SIGNATURE_HEADER, DEFAULT_TIMESTAMP_HEADER, type OutcomePayload, type SdkContractVersion, SdkError, type SubmitErrorRequest, type SubmitResultRequest, type TablePayload, type TableRow, type WebhookHandlerOptions, type WebhookHttpResponse, type WebhookInput, computeWebhookSignature, createExpressWebhookHandler, createFastifyWebhookHandler, createHonoWebhookHandler, createNextWebhookHandler, createTablePayload, createTableResult, createWebhookHandler, executeWebhook, getContractVersion, parseAssignmentV1, toAssignmentEnvelopeV1, verifyWebhookSignature };

package/dist/index.d.ts

@@ -0,0 +1,177 @@
+type SdkContractVersion = "v1";
+type AssignmentStatus = "assigned" | "verifying" | "timed_out";
+type OutcomePayload = Record<string, unknown>;
+type AssignmentResultOutput = {
+    type: "table" | "text" | "image" | "file" | "collection";
+    key?: string;
+    label?: string;
+    required?: boolean;
+    details?: Record<string, unknown>;
+};
+type AssignmentResultSchema = {
+    version?: number;
+    outputs: AssignmentResultOutput[];
+};
+type AssignmentOutcome = {
+    title: string;
+    payload: OutcomePayload;
+    requested_unit_price_value?: number;
+    requested_total_price_value?: number;
+    currency?: string;
+    time_window?: string;
+};
+type Assignment = {
+    assignment_id: string;
+    template_slug: string;
+    result_schema: AssignmentResultSchema;
+    outcome: AssignmentOutcome;
+};
+type AssignmentEnvelopeV1 = {
+    version: SdkContractVersion;
+    assignment: Assignment;
+};
+type AssignmentResult = {
+    status: AssignmentStatus;
+    result?: Record<string, unknown>;
+    error?: string;
+};
+type AssignmentAckStatus = "accepted" | "rejected";
+type AssignmentAckRequest = {
+    status: AssignmentAckStatus;
+    reason?: string;
+};
+type WebhookInput = {
+    body: string;
+    signature?: string;
+    timestamp?: string;
+};
+type SubmitResultRequest = {
+    assignmentId: string;
+    status: AssignmentStatus;
+    result?: Record<string, unknown>;
+    error?: string;
+};
+type SubmitErrorRequest = {
+    assignmentId: string;
+    error: string;
+    details?: Record<string, unknown>;
+};
+type ApiErrorBody = {
+    code?: string;
+    message?: string;
+    details?: unknown;
+};
+
+declare class SdkError extends Error {
+    constructor(message: string);
+}
+declare class ApiError extends SdkError {
+    readonly status: number;
+    readonly code: string | undefined;
+    readonly body: ApiErrorBody | null;
+    readonly retryable: boolean;
+    constructor(params: {
+        status: number;
+        message: string;
+        code: string | undefined;
+        body: ApiErrorBody | null;
+    });
+}
+
+type ClientOptions = {
+    baseUrl: string;
+    apiKey: string;
+    fetchImpl?: typeof fetch;
+};
+declare class AgentClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly fetchImpl;
+    constructor(options: ClientOptions);
+    ackAssignment(assignmentId: string, request: AssignmentAckRequest): Promise<void>;
+    submitResult(input: SubmitResultRequest): Promise<void>;
+    submitError(input: SubmitErrorRequest): Promise<void>;
+    private post;
+    private toApiError;
+}
+
+declare function computeWebhookSignature(params: {
+    webhookSecret: string;
+    timestamp: string;
+    body: string;
+}): string;
+declare function verifyWebhookSignature(params: {
+    webhookSecret: string;
+    timestamp?: string;
+    body: string;
+    signature?: string;
+}): void;
+
+declare const DEFAULT_SIGNATURE_HEADER = "x-bounty-signature";
+declare const DEFAULT_TIMESTAMP_HEADER = "x-bounty-timestamp";
+type WebhookHandlerOptions = {
+    webhookSecret: string;
+    onAssignment: (params: {
+        assignment: Assignment;
+    }) => Promise<AssignmentResult>;
+    verifySignature?: boolean;
+};
+type WebhookHttpResponse = {
+    status: number;
+    body: AssignmentResult;
+};
+declare function createWebhookHandler(options: WebhookHandlerOptions): (input: WebhookInput) => Promise<AssignmentResult>;
+declare function executeWebhook(handler: ReturnType<typeof createWebhookHandler>, input: WebhookInput): Promise<WebhookHttpResponse>;
+
+declare function createExpressWebhookHandler(options: WebhookHandlerOptions): (req: {
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+    rawBody?: string;
+}, res: {
+    status: (code: number) => {
+        json: (payload: unknown) => void;
+    };
+}) => Promise<void>;
+declare function createFastifyWebhookHandler(options: WebhookHandlerOptions): (request: {
+    headers: Record<string, string | string[] | undefined>;
+    body?: unknown;
+    rawBody?: string;
+}, reply: {
+    code: (statusCode: number) => {
+        send: (payload: unknown) => void;
+    };
+}) => Promise<void>;
+declare function createNextWebhookHandler(options: WebhookHandlerOptions): (request: Request) => Promise<Response>;
+declare function createHonoWebhookHandler(options: WebhookHandlerOptions): (c: {
+    req: {
+        text: () => Promise<string>;
+        header: (name: string) => string | undefined;
+    };
+    json: (payload: unknown, status?: number) => Response;
+}) => Promise<Response>;
+
+declare function parseAssignmentV1(body: string): Assignment;
+declare function toAssignmentEnvelopeV1(assignment: Assignment): AssignmentEnvelopeV1;
+declare function getContractVersion(): SdkContractVersion;
+
+type TableRow = Record<string, unknown>;
+type TablePayload = {
+    table: {
+        columns: string[];
+        rows: TableRow[];
+    };
+    row_count: number;
+    rows_unique: boolean;
+    has_contact_method: boolean;
+    summary?: string;
+};
+type CreateTableResultOptions = {
+    columns?: string[];
+    summary?: string;
+    contactFields?: string[];
+    dedupeBy?: string[];
+};
+declare function createTablePayload(rows: TableRow[], options?: CreateTableResultOptions): TablePayload;
+declare function createTableResult(rows: TableRow[], options?: CreateTableResultOptions): Pick<AssignmentResult, "result">;
+
+export { AgentClient, ApiError, type ApiErrorBody, type Assignment, type AssignmentAckRequest, type AssignmentAckStatus, type AssignmentEnvelopeV1, type AssignmentOutcome, type AssignmentResult, type AssignmentResultOutput, type AssignmentResultSchema, type AssignmentStatus, type ClientOptions, type CreateTableResultOptions, DEFAULT_SIGNATURE_HEADER, DEFAULT_TIMESTAMP_HEADER, type OutcomePayload, type SdkContractVersion, SdkError, type SubmitErrorRequest, type SubmitResultRequest, type TablePayload, type TableRow, type WebhookHandlerOptions, type WebhookHttpResponse, type WebhookInput, computeWebhookSignature, createExpressWebhookHandler, createFastifyWebhookHandler, createHonoWebhookHandler, createNextWebhookHandler, createTablePayload, createTableResult, createWebhookHandler, executeWebhook, getContractVersion, parseAssignmentV1, toAssignmentEnvelopeV1, verifyWebhookSignature };