@gibwork/sdk 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,356 @@
+import { PublicKey, VersionedTransaction } from '@solana/web3.js';
+
+interface WalletSigner {
+    publicKey: PublicKey;
+    signMessage(message: Uint8Array): Promise<Uint8Array>;
+    signTransaction(transaction: VersionedTransaction): Promise<VersionedTransaction>;
+}
+
+declare class GibworkError extends Error {
+    readonly name: string;
+}
+declare class GibworkConfigurationError extends GibworkError {
+    readonly name: string;
+}
+declare class GibworkApiError extends GibworkError {
+    readonly status: number;
+    readonly body: unknown;
+    readonly method: string;
+    readonly path: string;
+    readonly requestId?: string | undefined;
+    readonly name: string;
+    constructor(status: number, body: unknown, method: string, path: string, requestId?: string | undefined);
+}
+declare class GibworkNetworkError extends GibworkError {
+    readonly method: string;
+    readonly path: string;
+    readonly name: string;
+    constructor(message: string, method: string, path: string, options?: ErrorOptions);
+}
+declare class GibworkTimeoutError extends GibworkNetworkError {
+    readonly timeoutMs: number;
+    readonly name: string;
+    constructor(method: string, path: string, timeoutMs: number, options?: ErrorOptions);
+}
+declare class GibworkRequestAbortedError extends GibworkNetworkError {
+    readonly name: string;
+    constructor(method: string, path: string, options?: ErrorOptions);
+}
+type SubmitOperation = 'create-task' | 'refund-task' | 'approve-submission';
+interface AmbiguousSubmitContext {
+    operation: SubmitOperation;
+    taskId?: string;
+    submissionId?: string;
+    intentId: string;
+}
+declare class GibworkAmbiguousSubmitError extends GibworkNetworkError {
+    readonly context: AmbiguousSubmitContext;
+    readonly name: string;
+    constructor(method: string, path: string, context: AmbiguousSubmitContext, options?: ErrorOptions);
+}
+
+interface RequestOptions {
+    signal?: AbortSignal;
+}
+interface PaginationQuery {
+    page?: number;
+    limit?: number;
+    pageAll?: boolean;
+}
+type SubmissionStatus = 'pending' | 'approved' | 'rejected';
+interface SubmissionPaginationQuery extends PaginationQuery {
+    status?: SubmissionStatus;
+}
+interface Paginated<T> {
+    results: T[];
+    page: number;
+    limit: number;
+    total: number;
+    lastPage: number;
+}
+interface CreateTaskInput {
+    title: string;
+    content: string;
+    tags: string[];
+    primarySkillSlug?: string;
+    payment: {
+        mintAddress: string;
+        amount: string;
+    };
+    minSubmissionAmount: string;
+    refundFeeOverride?: number | null;
+    deadline?: string | null;
+    allowOnlyVerifiedSubmissions?: boolean;
+    allowOnlyDiscordGuildSubmissions?: boolean;
+    requiredDiscordGuildId?: string | null;
+    requiredDiscordGuildName?: string | null;
+    discordGuildInvitationUrl?: string | null;
+    requiredDiscordRoleIds?: string[];
+}
+interface ApproveSubmissionInput {
+    amount: string;
+    rating?: number;
+}
+interface TokenQuote {
+    mintAddress: string;
+    symbol: string;
+    decimals: number;
+}
+interface FeeQuote {
+    percent: number;
+    amount: string;
+}
+interface PaymentQuote {
+    token: TokenQuote;
+    fundingAmount: string;
+    platformFee: FeeQuote;
+    totalDebit: string;
+}
+interface RefundQuote {
+    token: TokenQuote;
+    grossRefundAmount: string;
+    platformFee: FeeQuote;
+    netRefundAmount: string;
+}
+interface ApprovalQuote {
+    token: TokenQuote;
+    grossApprovalAmount: string;
+    platformFee: FeeQuote;
+    referralFee: string;
+    netPayoutAmount: string;
+    closeTask: boolean;
+}
+interface PreparedTaskIntent {
+    intentId: string;
+    taskId: string;
+    serializedTransaction: string;
+    lastValidBlockHeight: number;
+    paymentQuote: PaymentQuote;
+}
+interface PreparedRefundIntent {
+    intentId: string;
+    taskId: string;
+    serializedTransaction: string;
+    lastValidBlockHeight: number;
+    refundQuote: RefundQuote;
+}
+interface PreparedApprovalIntent {
+    intentId: string;
+    taskId: string;
+    taskSubmissionId: string;
+    serializedTransaction: string;
+    lastValidBlockHeight: number;
+    approvalQuote: ApprovalQuote;
+}
+interface TaskSubmitResult {
+    taskId: string;
+    txHash?: string;
+    status: 'confirmed' | 'processing' | 'failed';
+}
+interface RefundSubmitResult {
+    taskId: string;
+    txHash: string;
+}
+interface ApprovalSubmitResult extends RefundSubmitResult {
+    taskSubmissionId: string;
+}
+interface CreateTaskResult extends TaskSubmitResult {
+    intentId: string;
+    lastValidBlockHeight: number;
+    paymentQuote: PaymentQuote;
+}
+interface RefundTaskResult extends RefundSubmitResult {
+    intentId: string;
+    lastValidBlockHeight: number;
+    refundQuote: RefundQuote;
+}
+interface ApproveSubmissionResult extends ApprovalSubmitResult {
+    intentId: string;
+    lastValidBlockHeight: number;
+    approvalQuote: ApprovalQuote;
+}
+interface RejectSubmissionResult {
+    message: 'Submission rejected';
+    submission: {
+        id: string;
+        taskId: string;
+        status: 'REJECTED';
+        rejectReason?: string | null;
+        reviewedAt: string;
+    };
+}
+interface WalletTaskAsset {
+    decimals: number;
+    imageUrl: string | null;
+    symbol: string | null;
+    amount: number;
+    rewarded: number;
+    price: string;
+    mintAddress: string | null;
+}
+interface WalletTaskSummary {
+    id: string;
+    createdAt: string;
+    type: 'tasks';
+    status: 'refunded' | 'complete' | 'creating' | 'in progress';
+    approvedSubmissions: number;
+    totalSubmissions: number;
+    title: string;
+    isOpen: boolean;
+    asset: WalletTaskAsset;
+    rewardedAmount: number;
+    rewardedPrice: string;
+}
+interface Membership {
+    tier: string;
+    entitlementLevel: number;
+    isPro: boolean;
+}
+interface UserSummary {
+    id: string;
+    externalId: string;
+    username: string;
+    firstName?: string;
+    lastName?: string;
+    profilePicture: string;
+    isPremium: boolean;
+    membership: Membership;
+    approvedTaskSubmissions: number;
+    rejectedTaskSubmissions: number;
+    rating: number;
+}
+interface MediaItem {
+    id: string;
+    provider: string;
+    providerFileId?: string;
+    type: string;
+    mimeType: string;
+    url: string;
+    thumbnailUrl?: string;
+    sizeBytes?: number | null;
+    order: number;
+    status: string;
+    metadata?: Record<string, unknown>;
+    createdAt: string;
+}
+interface SubmissionComment {
+    id: string;
+    taskSubmissionId: string;
+    content: string;
+    createdBy?: string;
+    createdAt: string;
+    user: UserSummary;
+    media: MediaItem[];
+}
+interface SubmissionAsset extends Record<string, unknown> {
+    id?: string;
+    mintAddress?: string;
+    symbol?: string;
+    imageUrl?: string;
+    amount?: number;
+    price?: number;
+    decimals?: number;
+}
+type TaskSubmissionStatus = 'OPEN' | 'REJECTED' | 'CLAIMING' | 'WAITING_CLAIM' | 'CLOSED' | 'CLAIMED' | 'PROCESSING';
+interface TaskSubmission extends Record<string, unknown> {
+    id: string;
+    taskId: string;
+    content: string;
+    status: TaskSubmissionStatus;
+    assetId: string | null;
+    transactionId: string | null;
+    rejectReason: string | null;
+    blinks: boolean;
+    isHidden: boolean;
+    referralId: string | null;
+    createdBy: string;
+    createdAt: string;
+    rating: number | null;
+    user: UserSummary;
+    comments: SubmissionComment[];
+    media: MediaItem[];
+    asset: SubmissionAsset | null;
+}
+interface GibworkApiErrorBody {
+    statusCode?: number;
+    message?: string | string[];
+    error?: string;
+    [key: string]: unknown;
+}
+
+type FetchImplementation = typeof fetch;
+interface HttpTransportOptions {
+    baseUrl: string;
+    fetch?: FetchImplementation;
+    timeoutMs?: number;
+}
+interface HttpRequest {
+    method: 'GET' | 'POST';
+    path: string;
+    headers?: Record<string, string>;
+    body?: unknown;
+    options?: RequestOptions;
+    ambiguousSubmit?: AmbiguousSubmitContext;
+}
+declare class HttpTransport {
+    private readonly baseUrl;
+    private readonly fetchImplementation;
+    private readonly timeoutMs;
+    constructor(options: HttpTransportOptions);
+    request<T>(request: HttpRequest): Promise<T>;
+}
+
+declare class SubmissionCommentsResource {
+    private readonly transport;
+    private readonly signer;
+    constructor(transport: HttpTransport, signer: WalletSigner);
+    list(taskId: string, submissionId: string, options?: RequestOptions): Promise<SubmissionComment[]>;
+    create(taskId: string, submissionId: string, content: string, options?: RequestOptions): Promise<SubmissionComment>;
+}
+
+declare class SubmissionsResource {
+    private readonly transport;
+    private readonly signer;
+    readonly comments: SubmissionCommentsResource;
+    constructor(transport: HttpTransport, signer: WalletSigner);
+    list(taskId: string, query?: SubmissionPaginationQuery, options?: RequestOptions): Promise<Paginated<TaskSubmission>>;
+    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>;
+    submitApproval(taskId: string, submissionId: string, intentId: string, signedTransaction: string, options?: RequestOptions): Promise<ApprovalSubmitResult>;
+    private get walletAddress();
+}
+
+declare class TasksResource {
+    private readonly transport;
+    private readonly signer;
+    constructor(transport: HttpTransport, signer: WalletSigner);
+    create(input: CreateTaskInput, options?: RequestOptions): Promise<CreateTaskResult>;
+    list(query?: PaginationQuery, options?: RequestOptions): Promise<Paginated<WalletTaskSummary>>;
+    refund(taskId: string, options?: RequestOptions): Promise<RefundTaskResult>;
+    prepareCreate(input: CreateTaskInput, options?: RequestOptions): Promise<PreparedTaskIntent>;
+    submitCreate(intentId: string, signedTransaction: string, options?: RequestOptions): Promise<TaskSubmitResult>;
+    prepareRefund(taskId: string, options?: RequestOptions): Promise<PreparedRefundIntent>;
+    submitRefund(taskId: string, intentId: string, signedTransaction: string, options?: RequestOptions): Promise<RefundSubmitResult>;
+    private get walletAddress();
+    private auth;
+}
+
+interface GibworkClientOptions {
+    baseUrl?: string;
+    signer: WalletSigner;
+    fetch?: FetchImplementation;
+    timeoutMs?: number;
+}
+declare class GibworkClient {
+    readonly tasks: TasksResource;
+    readonly submissions: SubmissionsResource;
+    constructor(options: GibworkClientOptions);
+}
+
+/** The API origin embedded when this package was built. */
+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 UserSummary, type WalletSigner, type WalletTaskAsset, type WalletTaskSummary, signPreparedTransaction };

package/dist/index.js

@@ -0,0 +1,3 @@
+export { DEFAULT_GIBWORK_API_URL, GibworkAmbiguousSubmitError, GibworkApiError, GibworkClient, GibworkConfigurationError, GibworkError, GibworkNetworkError, GibworkRequestAbortedError, GibworkTimeoutError, signPreparedTransaction } from './chunk-24XHBDMZ.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}