@gibwork/sdk 0.0.5 → 0.1.0

package/dist/index.d.ts

@@ -18,8 +18,9 @@ declare class GibworkApiError extends GibworkError {
     readonly method: string;
     readonly path: string;
     readonly requestId?: string | undefined;
+    readonly retryAfter?: string | undefined;
     readonly name: string;
-    constructor(status: number, body: unknown, method: string, path: string, requestId?: string | undefined);
+    constructor(status: number, body: unknown, method: string, path: string, requestId?: string | undefined, retryAfter?: string | undefined);
 }
 declare class GibworkNetworkError extends GibworkError {
     readonly method: string;
@@ -36,18 +37,46 @@ declare class GibworkRequestAbortedError extends GibworkNetworkError {
     readonly name: string;
     constructor(method: string, path: string, options?: ErrorOptions);
 }
-type SubmitOperation = 'create-task' | 'refund-task' | 'approve-submission';
+type SubmitOperation = 'create-task' | 'refund-task' | 'approve-submission' | 'create-submission';
 interface AmbiguousSubmitContext {
     operation: SubmitOperation;
     taskId?: string;
     submissionId?: string;
     intentId: string;
+    paymentAttemptId?: string;
+    idempotencyKey?: string;
+    walletAddress?: string;
+    environment?: 'stage' | 'prod';
+    apiUrl?: string;
 }
 declare class GibworkAmbiguousSubmitError extends GibworkNetworkError {
     readonly context: AmbiguousSubmitContext;
     readonly name: string;
     constructor(method: string, path: string, context: AmbiguousSubmitContext, options?: ErrorOptions);
 }
+declare class GibworkValidationError extends GibworkError {
+    readonly name: string;
+}
+declare class GibworkProtocolError extends GibworkError {
+    readonly name: string;
+}
+interface SubmissionRecoveryContext {
+    taskId: string;
+    idempotencyKey: string;
+    walletAddress: string;
+    environment: 'stage' | 'prod';
+    apiUrl: string;
+    phase: 'prepare' | 'sign' | 'submit';
+    intentId?: string;
+    paymentAttemptId?: string;
+    submissionId?: string;
+}
+/** Retains identifiers when creation stops, including before any payment is sent. */
+declare class GibworkSubmissionOperationError extends GibworkError {
+    readonly context: SubmissionRecoveryContext;
+    readonly name: string;
+    constructor(context: SubmissionRecoveryContext, options?: ErrorOptions);
+}
 
 interface RequestOptions {
     signal?: AbortSignal;
@@ -239,6 +268,13 @@ interface UserSummary {
     rejectedTaskSubmissions: number;
     rating: number;
 }
+interface PublicProfileReference {
+    id: string;
+    routeKey: string;
+}
+type WalletSubmissionUser = Omit<UserSummary, 'externalId' | 'membership'> & {
+    publicProfile: PublicProfileReference | null;
+};
 interface MediaItem {
     id: string;
     provider: string;
@@ -262,6 +298,14 @@ interface SubmissionComment {
     user: UserSummary;
     media: MediaItem[];
 }
+interface WalletSubmissionComment {
+    id: string;
+    taskSubmissionId: string;
+    content: string;
+    createdAt: string;
+    user: WalletSubmissionUser;
+    media: MediaItem[];
+}
 interface SubmissionAsset extends Record<string, unknown> {
     id?: string;
     mintAddress?: string;
@@ -272,6 +316,19 @@ interface SubmissionAsset extends Record<string, unknown> {
     decimals?: number;
 }
 type TaskSubmissionStatus = 'OPEN' | 'REJECTED' | 'CLAIMING' | 'WAITING_CLAIM' | 'CLOSED' | 'CLAIMED' | 'PROCESSING';
+interface WalletTaskSubmissionDetails {
+    id: string;
+    taskId: string;
+    content: string;
+    status: TaskSubmissionStatus;
+    createdAt: string;
+    rejectReason?: string | null;
+    rating: number | null;
+    user: WalletSubmissionUser;
+    comments: WalletSubmissionComment[];
+    media: MediaItem[];
+    asset?: SubmissionAsset | null;
+}
 interface TaskSubmission extends Record<string, unknown> {
     id: string;
     taskId: string;
@@ -297,6 +354,88 @@ interface GibworkApiErrorBody {
     error?: string;
     [key: string]: unknown;
 }
+interface AvailableTasksQuery {
+    page?: number;
+    limit?: number;
+}
+interface AvailableTask {
+    id: string;
+    slug: string;
+    title: string;
+    content: string;
+    requirements: string | null;
+    tags: string[];
+    primarySkillId: string | null;
+    createdAt: string;
+    deadline: string | null;
+    status: 'CREATED';
+    isOpen: boolean;
+    asset: AvailableTaskAsset | null;
+    minSubmissionAmount: string | null;
+    totalSubmissions: number;
+    maxSubmissions: number | null;
+    standardSubmissionSlotsRemaining: number | null;
+    requiresPremium: boolean;
+    participationRequirements: AvailableTaskParticipationRequirements;
+}
+type AvailableTaskPage = Paginated<AvailableTask>;
+interface CreateSubmissionInput {
+    content: string;
+    referral?: string | null;
+    mediaIds?: string[] | null;
+    /** Reuse for retries of this exact task and submission payload. */
+    idempotencyKey: string;
+}
+interface SubmitSubmissionInput {
+    paymentAttemptId: string;
+    signedTransaction: string;
+}
+type TaskSubmissionIntentStatus = 'pending' | 'submitted' | 'fulfilled' | 'failed' | 'expired' | 'requires_review';
+interface TaskSubmissionIntent {
+    intentId: string;
+    taskId: string;
+    /** Allocated in advance; exists as a submission only when fulfilled. */
+    taskSubmissionId: string;
+    paymentAttemptId: string;
+    status: TaskSubmissionIntentStatus;
+    txHash: string | null;
+    expiresAt: string;
+    lastValidBlockHeight: number;
+    fee: TaskSubmissionFee;
+    reviewReason?: string;
+    /** Only returned by prepare for a pending intent, including pending retries. */
+    serializedTransaction?: string;
+}
+interface TaskSubmissionFee {
+    amount: string;
+    amountBaseUnits: string;
+    totalDebit: string;
+    symbol: 'USDC';
+    mintAddress: string;
+    decimals: number;
+    destinationAddress: string;
+}
+interface AvailableTaskAsset {
+    mintAddress: string;
+    symbol: string;
+    imageUrl: string;
+    decimals: number;
+    /** Original reward pool in base units, not the remaining balance. */
+    amount: string;
+}
+interface AvailableTaskParticipationRequirements {
+    allowOnlyVerifiedSubmissions: boolean;
+    allowOnlyVerifiedTwitterAccountSubmissions: boolean;
+    minTwitterFollowers: number;
+    minTweetLikes: number;
+    minTweetViews: number;
+    isTwitterTask: boolean;
+    allowOnlyDiscordGuildSubmissions: boolean;
+    requiredDiscordGuildId: string | null;
+    requiredDiscordGuildName: string | null;
+    discordGuildInvitationUrl: string | null;
+    requiredDiscordRoleIds: string[];
+}
 
 type FetchImplementation = typeof fetch;
 interface HttpTransportOptions {
@@ -312,6 +451,7 @@ interface HttpRequest {
     body?: unknown;
     options?: RequestOptions;
     ambiguousSubmit?: AmbiguousSubmitContext;
+    validateResponse?: (body: unknown) => void;
 }
 declare class HttpTransport {
     private readonly baseUrl;
@@ -319,6 +459,11 @@ declare class HttpTransport {
     private readonly production;
     private readonly timeoutMs;
     constructor(options: HttpTransportOptions);
+    /** Recovery location without URL credentials. Retains reverse-proxy path prefixes. */
+    get recoveryLocation(): {
+        apiUrl: string;
+        environment: 'stage' | 'prod';
+    };
     request<T>(request: HttpRequest): Promise<T>;
 }
 
@@ -335,7 +480,16 @@ declare class SubmissionsResource {
     private readonly signer;
     readonly comments: SubmissionCommentsResource;
     constructor(transport: HttpTransport, signer: WalletSigner);
+    /** Creates work through a participation fee; only fulfilled confirms creation. */
+    create(taskId: string, input: CreateSubmissionInput, options?: RequestOptions): Promise<TaskSubmissionIntent>;
+    /** Reuse the exact input and idempotency key after an interrupted prepare. */
+    prepareCreate(taskId: string, input: CreateSubmissionInput, options?: RequestOptions): Promise<TaskSubmissionIntent>;
+    /** Never automatically retries. Recover an uncertain payment with getIntent. */
+    submitCreate(taskId: string, intentId: string, input: SubmitSubmissionInput, options?: RequestOptions): Promise<TaskSubmissionIntent>;
+    /** Reads/reconciles creation using the original wallet; does not report review/payout. */
+    getIntent(taskId: string, intentId: string, options?: RequestOptions): Promise<TaskSubmissionIntent>;
     list(taskId: string, query?: SubmissionPaginationQuery, options?: RequestOptions): Promise<Paginated<TaskSubmission>>;
+    get(taskId: string, submissionId: string, options?: RequestOptions): Promise<WalletTaskSubmissionDetails>;
     approve(taskId: string, submissionId: string, input: ApproveSubmissionInput, options?: RequestOptions): Promise<ApproveSubmissionResult>;
     reject(taskId: string, submissionId: string, reason?: string | null, options?: RequestOptions): Promise<RejectSubmissionResult>;
     prepareApproval(taskId: string, submissionId: string, input: ApproveSubmissionInput, options?: RequestOptions): Promise<PreparedApprovalIntent>;
@@ -349,6 +503,8 @@ declare class TasksResource {
     constructor(transport: HttpTransport, signer: WalletSigner);
     create(input: CreateTaskInput, options?: RequestOptions): Promise<CreateTaskResult>;
     list(query?: PaginationQuery, options?: RequestOptions): Promise<Paginated<WalletTaskSummary>>;
+    /** Discover tasks across creators. Eligibility is checked when preparing work. */
+    listAvailable(query?: AvailableTasksQuery, options?: RequestOptions): Promise<AvailableTaskPage>;
     update(taskId: string, input: UpdateTaskInput, options?: RequestOptions): Promise<UpdatedTask>;
     refund(taskId: string, options?: RequestOptions): Promise<RefundTaskResult>;
     prepareCreate(input: CreateTaskInput, options?: RequestOptions): Promise<PreparedTaskIntent>;
@@ -378,4 +534,4 @@ declare const DEFAULT_GIBWORK_API_URL: string;
 
 declare function signPreparedTransaction(serializedTransaction: string, signer: WalletSigner): Promise<string>;
 
-export { type AmbiguousSubmitContext, type ApprovalQuote, type ApprovalSubmitResult, type ApproveSubmissionInput, type ApproveSubmissionResult, type CreateTaskInput, type CreateTaskResult, DEFAULT_GIBWORK_API_URL, type FeeQuote, type FetchImplementation, GibworkAmbiguousSubmitError, GibworkApiError, type GibworkApiErrorBody, GibworkClient, type GibworkClientOptions, GibworkConfigurationError, GibworkError, GibworkNetworkError, GibworkRequestAbortedError, GibworkTimeoutError, type MediaItem, type Membership, type Paginated, type PaginationQuery, type PaymentQuote, type PreparedApprovalIntent, type PreparedRefundIntent, type PreparedTaskIntent, type RefundQuote, type RefundSubmitResult, type RefundTaskResult, type RejectSubmissionResult, type RequestOptions, type SubmissionAsset, type SubmissionComment, type SubmissionPaginationQuery, type SubmissionStatus, type SubmitOperation, type TaskSubmission, type TaskSubmissionStatus, type TaskSubmitResult, type TokenQuote, type UpdateTaskInput, type UpdatedTask, type UserSummary, type WalletSigner, type WalletTaskAsset, type WalletTaskSummary, signPreparedTransaction };
+export { type AmbiguousSubmitContext, type ApprovalQuote, type ApprovalSubmitResult, type ApproveSubmissionInput, type ApproveSubmissionResult, type AvailableTask, type AvailableTaskAsset, type AvailableTaskPage, type AvailableTaskParticipationRequirements, type AvailableTasksQuery, type CreateSubmissionInput, type CreateTaskInput, type CreateTaskResult, DEFAULT_GIBWORK_API_URL, type FeeQuote, type FetchImplementation, GibworkAmbiguousSubmitError, GibworkApiError, type GibworkApiErrorBody, GibworkClient, type GibworkClientOptions, GibworkConfigurationError, GibworkError, GibworkNetworkError, GibworkProtocolError, GibworkRequestAbortedError, GibworkSubmissionOperationError, GibworkTimeoutError, GibworkValidationError, type MediaItem, type Membership, type Paginated, type PaginationQuery, type PaymentQuote, type PreparedApprovalIntent, type PreparedRefundIntent, type PreparedTaskIntent, type PublicProfileReference, type RefundQuote, type RefundSubmitResult, type RefundTaskResult, type RejectSubmissionResult, type RequestOptions, type SubmissionAsset, type SubmissionComment, type SubmissionPaginationQuery, type SubmissionRecoveryContext, type SubmissionStatus, type SubmitOperation, type SubmitSubmissionInput, type TaskSubmission, type TaskSubmissionFee, type TaskSubmissionIntent, type TaskSubmissionIntentStatus, type TaskSubmissionStatus, type TaskSubmitResult, type TokenQuote, type UpdateTaskInput, type UpdatedTask, type UserSummary, type WalletSigner, type WalletSubmissionComment, type WalletSubmissionUser, type WalletTaskAsset, type WalletTaskSubmissionDetails, type WalletTaskSummary, signPreparedTransaction };

package/dist/index.js

@@ -1,3 +1,3 @@
-export { DEFAULT_GIBWORK_API_URL, GibworkAmbiguousSubmitError, GibworkApiError, GibworkClient, GibworkConfigurationError, GibworkError, GibworkNetworkError, GibworkRequestAbortedError, GibworkTimeoutError, signPreparedTransaction } from './chunk-BNAVP5XZ.js';
+export { DEFAULT_GIBWORK_API_URL, GibworkAmbiguousSubmitError, GibworkApiError, GibworkClient, GibworkConfigurationError, GibworkError, GibworkNetworkError, GibworkProtocolError, GibworkRequestAbortedError, GibworkSubmissionOperationError, GibworkTimeoutError, GibworkValidationError, signPreparedTransaction } from './chunk-HJ5D5SOE.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map