mindupload 1.5.1

package/dist/index.d.ts

@@ -0,0 +1,557 @@
+declare const DEFAULT_BASE_URL = "https://partner.mindupload.app";
+/** A response envelope. `success` and `error_message` are always present; any
+ * other field the API returns is available by its documented (snake_case) name. */
+interface Result {
+    success: boolean;
+    error_message?: string | null;
+    [key: string]: unknown;
+}
+interface ClientOptions {
+    /** Your partner key. A server-side secret — never ship it to a browser. */
+    partnerKey: string;
+    baseUrl?: string;
+    /** Default locale sent with every call (per-call `preferredLanguage` overrides). */
+    preferredLanguage?: string;
+    timeoutMs?: number;
+    /** Retries on 429 / 5xx / network errors, with backoff. Default 2. */
+    maxRetries?: number;
+    userAgent?: string;
+}
+/** Transport, retry, and error handling shared by every operation. */
+declare class MindUploadBase {
+    protected readonly partnerKey: string;
+    protected readonly baseUrl: string;
+    protected readonly preferredLanguage?: string;
+    protected readonly timeoutMs: number;
+    protected readonly maxRetries: number;
+    protected readonly userAgent: string;
+    private readonly fetchFn;
+    constructor(options: ClientOptions);
+    protected request(operation: string, params: Record<string, unknown>): Promise<Result>;
+    private timeoutSignal;
+    private errorFor;
+}
+
+interface CreateCloneParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    codename?: string;
+    nickname?: string;
+    gender?: string;
+    avatarId?: string;
+    acceptChatroomInvitationByOthers?: boolean;
+}
+interface GetClonesParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+}
+interface UpdateCloneParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    codename?: string;
+    nickname?: string;
+    gender?: string;
+    avatarId?: string;
+    acceptChatroomInvitationByOthers?: boolean;
+}
+interface GetQuotaParams {
+    preferredLanguage?: string;
+    username?: string;
+}
+interface CheckUsernameParams {
+    preferredLanguage?: string;
+    username?: string;
+}
+interface LoginParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+}
+interface LogoutParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+}
+interface RegisterParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    email?: string;
+    emailVerificationCode?: string;
+    firstName?: string;
+    lastName?: string;
+    nickname?: string;
+    gender?: string;
+    birthDate?: number;
+    phoneNumber?: string;
+    avatarId?: string;
+    acceptChatroomInvitationByOthers?: boolean;
+}
+interface CheckChatroomUpdatesParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    chatrooms?: Record<string, unknown>[];
+}
+interface CreateChatroomParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    chatroomName?: string;
+    isPublic?: boolean;
+    avatarId?: string;
+    soulmateCheckEnabled?: boolean;
+}
+interface CreateChatroomMembershipParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    chatroomId?: string;
+    inviteeUsername?: string;
+    inviteeCodename?: string;
+    adminLevel?: string;
+}
+interface CreateChatroomMessageParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    chatroomId?: string;
+    text?: string;
+}
+interface GetChatroomMembershipParams {
+    preferredLanguage?: string;
+    page?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortOrder?: number;
+    useCursorPagination?: boolean;
+    cursorValue?: string;
+    cursorId?: string;
+    username?: string;
+    password?: string;
+    chatroomId?: string;
+}
+interface GetChatroomMessagesParams {
+    preferredLanguage?: string;
+    page?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortOrder?: number;
+    useCursorPagination?: boolean;
+    cursorValue?: string;
+    cursorId?: string;
+    username?: string;
+    password?: string;
+    chatroomId?: string;
+    sinceValue?: number;
+    sinceId?: string;
+}
+interface GetChatroomsParams {
+    preferredLanguage?: string;
+    page?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortOrder?: number;
+    useCursorPagination?: boolean;
+    cursorValue?: string;
+    cursorId?: string;
+    username?: string;
+    password?: string;
+    getPublic?: boolean;
+    getPrivate?: boolean;
+}
+interface GetChatParams {
+    preferredLanguage?: string;
+    page?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortOrder?: number;
+    useCursorPagination?: boolean;
+    cursorValue?: string;
+    cursorId?: string;
+    username?: string;
+    password?: string;
+    codename?: string;
+}
+interface RagParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    codename?: string;
+    text?: string;
+    chatroomId?: string;
+}
+interface TriggerSocialParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    membershipId?: string;
+    chatroomId?: string;
+}
+interface GetMindClusterParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    codename?: string;
+    nodeId?: string;
+    textsOffset?: number;
+    textsPageSize?: number;
+    forceRebuild?: boolean;
+}
+interface GetSoulmateReportParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    myCloneId?: string;
+    otherCloneId?: string;
+    chatroomId?: string;
+}
+interface AbortMultipartUploadParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    r2Key?: string;
+    uploadId?: string;
+}
+interface CancelUploadParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    r2Key?: string;
+}
+interface CompleteMultipartUploadParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    r2Key?: string;
+    uploadId?: string;
+    parts?: Record<string, unknown>[];
+}
+interface ListUploadPartsParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    r2Key?: string;
+    uploadId?: string;
+}
+interface RequestMultipartUploadParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    filename?: string;
+    contentType?: string;
+    fileSizeBytes?: number;
+    mediaType?: string;
+    hasThumbnail?: boolean;
+}
+interface RequestUploadUrlParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    filename?: string;
+    contentType?: string;
+    fileSizeBytes?: number;
+    mediaType?: string;
+    hasThumbnail?: boolean;
+}
+interface SignUploadPartParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    r2Key?: string;
+    uploadId?: string;
+    partNumber?: number;
+}
+interface SignUploadPartsBatchParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    r2Key?: string;
+    uploadId?: string;
+    partNumbers?: number[];
+}
+interface CreateTextParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    codename?: string;
+    cloneId?: string;
+    text?: string;
+    type?: string;
+}
+interface GetTextsParams {
+    preferredLanguage?: string;
+    page?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortOrder?: number;
+    useCursorPagination?: boolean;
+    cursorValue?: string;
+    cursorId?: string;
+    username?: string;
+    password?: string;
+    codename?: string;
+    type?: string;
+}
+interface GetUserParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+}
+interface UpdateUserParams {
+    preferredLanguage?: string;
+    username?: string;
+    password?: string;
+    email?: string;
+    emailVerificationCode?: string;
+    firstName?: string;
+    lastName?: string;
+    nickname?: string;
+    gender?: string;
+    birthDate?: number;
+    phoneNumber?: string;
+    avatarId?: string;
+    acceptChatroomInvitationByOthers?: boolean;
+}
+/**
+ * Client for the Mind Upload partner API. Create one with your partner key,
+ * then call any operation. Every method resolves to a {@link Result} and
+ * rejects with a {@link MindUploadError} subclass on failure.
+ */
+declare class MindUpload extends MindUploadBase {
+    /** Create a new AI consciousness for the user.
+     *
+     * Response fields: success, error_message.
+     * @see https://docs.mindupload.app
+     */
+    createClone(params?: CreateCloneParams): Promise<Result>;
+    /** List the user's AI consciousnesses.
+     *
+     * Response fields: success, error_message, clones.
+     * @see https://docs.mindupload.app
+     */
+    getClones(params?: GetClonesParams): Promise<Result>;
+    /** Update an AI consciousness's profile.
+     *
+     * Response fields: success, error_message.
+     * @see https://docs.mindupload.app
+     */
+    updateClone(params?: UpdateCloneParams): Promise<Result>;
+    /** Check your partner API rate limits, credit caps, and current usage.
+     *
+     * Response fields: success, error_message, per_user_rate_limit_per_min, per_user_daily_credit_cap, partner_rate_limit_per_min, partner_daily_credit_cap, max_users, registered_users, partner_requests_last_minute, partner_credit_spends_last_day, user, user_requests_last_minute, user_credit_spends_last_day, credit_spending_tasks, operation_duration_ms.
+     * @see https://docs.mindupload.app
+     */
+    getQuota(params?: GetQuotaParams): Promise<Result>;
+    /** Check whether a username is still available before registering.
+     *
+     * Response fields: success, error_message, exists, disabled, rate_limited, flood_window, wait_seconds, operation_duration_ms.
+     * @see https://docs.mindupload.app
+     */
+    checkUsername(params?: CheckUsernameParams): Promise<Result>;
+    /** Sign a user in and receive a session token (JWT) for subsequent calls.
+     *
+     * Response fields: success, error_message, jwt, decrypted_user.
+     * @see https://docs.mindupload.app
+     */
+    login(params?: LoginParams): Promise<Result>;
+    /** End the current user session.
+     *
+     * Response fields: success, error_message, revoked, operation_duration_ms.
+     * @see https://docs.mindupload.app
+     */
+    logout(params?: LogoutParams): Promise<Result>;
+    /** Create a user account on your platform.
+     *
+     * Response fields: success, error_message, jwt, decrypted_user.
+     * @see https://docs.mindupload.app
+     */
+    register(params?: RegisterParams): Promise<Result>;
+    /** Cheaply poll whether the user's chatrooms have new activity.
+     *
+     * Response fields: success, error_message, server_time, poll_config, chatrooms.
+     * @see https://docs.mindupload.app
+     */
+    checkChatroomUpdates(params?: CheckChatroomUpdatesParams): Promise<Result>;
+    /** Create a chatroom.
+     *
+     * Response fields: success, error_message, chatroom_id.
+     * @see https://docs.mindupload.app
+     */
+    createChatroom(params?: CreateChatroomParams): Promise<Result>;
+    /** Invite a user or an AI consciousness into a chatroom.
+     *
+     * Response fields: success, error_message, membership_id.
+     * @see https://docs.mindupload.app
+     */
+    createChatroomMembership(params?: CreateChatroomMembershipParams): Promise<Result>;
+    /** Send a message to a chatroom.
+     *
+     * Response fields: success, error_message, message_id.
+     * @see https://docs.mindupload.app
+     */
+    createChatroomMessage(params?: CreateChatroomMessageParams): Promise<Result>;
+    /** List the members of a chatroom the user belongs to.
+     *
+     * Response fields: success, error_message, total_count, page, page_size, total_pages, has_next, has_prev, next_cursor_value, next_cursor_id, memberships.
+     * @see https://docs.mindupload.app
+     */
+    getChatroomMembership(params?: GetChatroomMembershipParams): Promise<Result>;
+    /** Fetch messages from a chatroom the user belongs to.
+     *
+     * Response fields: success, error_message, total_count, page, page_size, total_pages, has_next, has_prev, next_cursor_value, next_cursor_id, messages, media_thumbnails, since_overflow.
+     * @see https://docs.mindupload.app
+     */
+    getChatroomMessages(params?: GetChatroomMessagesParams): Promise<Result>;
+    /** List the chatrooms the user belongs to.
+     *
+     * Response fields: success, error_message, total_count, page, page_size, total_pages, has_next, has_prev, next_cursor_value, next_cursor_id, chatrooms.
+     * @see https://docs.mindupload.app
+     */
+    getChatrooms(params?: GetChatroomsParams): Promise<Result>;
+    /** Fetch the one-on-one conversation history with an AI consciousness.
+     *
+     * Response fields: success, error_message, total_count, page, page_size, total_pages, has_next, has_prev, next_cursor_value, next_cursor_id, chats, media_thumbnails.
+     * @see https://docs.mindupload.app
+     */
+    getChat(params?: GetChatParams): Promise<Result>;
+    /** Send a message to an AI consciousness and receive its reply.
+     *
+     * Response fields: success, error_message, response_text, clone_nickname, consolidation_summary, consolidation_count, consolidation_dispatched.
+     * @see https://docs.mindupload.app
+     */
+    rag(params?: RagParams): Promise<Result>;
+    /** Have an AI consciousness proactively join the conversation in a chatroom.
+     *
+     * Response fields: success, error_message, response_text, chatroom_digests_count, chatroom_digests_summary, consolidation_summary, consolidation_count, consolidation_dispatched.
+     * @see https://docs.mindupload.app
+     */
+    triggerSocial(params?: TriggerSocialParams): Promise<Result>;
+    /** Fetch the mind-graph visualization data of an AI consciousness.
+     *
+     * Response fields: success, error_message, root_node_id, node, children, texts, total_texts, texts_offset, has_more_texts, is_building.
+     * @see https://docs.mindupload.app
+     */
+    getMindCluster(params?: GetMindClusterParams): Promise<Result>;
+    /** Generate or fetch the compatibility report between two chatroom members.
+     *
+     * Response fields: success, error_message, report, report_generated_at, is_generating, charged.
+     * @see https://docs.mindupload.app
+     */
+    getSoulmateReport(params?: GetSoulmateReportParams): Promise<Result>;
+    /** Cancel a multipart upload and discard its parts.
+     *
+     * Response fields: success, error_message.
+     * @see https://docs.mindupload.app
+     */
+    abortMultipartUpload(params?: AbortMultipartUploadParams): Promise<Result>;
+    /** Cancel a pending upload.
+     *
+     * Response fields: success, error_message.
+     * @see https://docs.mindupload.app
+     */
+    cancelUpload(params?: CancelUploadParams): Promise<Result>;
+    /** Finish a multipart upload.
+     *
+     * Response fields: success, error_message, media_url.
+     * @see https://docs.mindupload.app
+     */
+    completeMultipartUpload(params?: CompleteMultipartUploadParams): Promise<Result>;
+    /** List the parts already uploaded in a multipart upload.
+     *
+     * Response fields: success, error_message, parts.
+     * @see https://docs.mindupload.app
+     */
+    listUploadParts(params?: ListUploadPartsParams): Promise<Result>;
+    /** Start a large-file upload in multiple parts.
+     *
+     * Response fields: success, error_message, upload_id, r2_key, media_url, signed_media_url, thumbnail_r2_key, thumbnail_presigned_url, signed_thumbnail_url, message.
+     * @see https://docs.mindupload.app
+     */
+    requestMultipartUpload(params?: RequestMultipartUploadParams): Promise<Result>;
+    /** Request an upload slot and a signed viewing link for a media attachment.
+     *
+     * Response fields: success, error_message, r2_key, presigned_url, media_url, signed_media_url, thumbnail_r2_key, thumbnail_presigned_url, signed_thumbnail_url, message.
+     * @see https://docs.mindupload.app
+     */
+    requestUploadUrl(params?: RequestUploadUrlParams): Promise<Result>;
+    /** Get the signed link for one part of a multipart upload.
+     *
+     * Response fields: success, error_message, presigned_url.
+     * @see https://docs.mindupload.app
+     */
+    signUploadPart(params?: SignUploadPartParams): Promise<Result>;
+    /** Get signed links for several parts of a multipart upload at once.
+     *
+     * Response fields: success, error_message, presigned_urls.
+     * @see https://docs.mindupload.app
+     */
+    signUploadPartsBatch(params?: SignUploadPartsBatchParams): Promise<Result>;
+    /** Upload a memory or persona entry to an AI consciousness.
+     *
+     * Response fields: success, error_message, cluster_label, cluster_modified_count.
+     * @see https://docs.mindupload.app
+     */
+    createText(params?: CreateTextParams): Promise<Result>;
+    /** List the memories and persona entries uploaded to an AI consciousness.
+     *
+     * Response fields: success, error_message, total_count, page, page_size, total_pages, has_next, has_prev, next_cursor_value, next_cursor_id, texts.
+     * @see https://docs.mindupload.app
+     */
+    getTexts(params?: GetTextsParams): Promise<Result>;
+    /** Fetch the signed-in user's profile.
+     *
+     * Response fields: success, error_message, jwt, decrypted_user.
+     * @see https://docs.mindupload.app
+     */
+    getUser(params?: GetUserParams): Promise<Result>;
+    /** Update the signed-in user's profile.
+     *
+     * Response fields: success, error_message.
+     * @see https://docs.mindupload.app
+     */
+    updateUser(params?: UpdateUserParams): Promise<Result>;
+}
+
+interface ErrorOptions {
+    operation?: string;
+    response?: Result;
+}
+interface ApiErrorOptions extends ErrorOptions {
+    status: number;
+}
+interface RateLimitOptions extends ApiErrorOptions {
+    retryAfter?: number;
+}
+/** Base class for every Mind Upload error — one `catch` handles them all. */
+declare class MindUploadError extends Error {
+    readonly operation?: string;
+    readonly response?: Result;
+    constructor(message: string, options?: ErrorOptions);
+}
+/** The API returned an error HTTP status (or an unexpected response). */
+declare class ApiError extends MindUploadError {
+    readonly status: number;
+    constructor(message: string, options: ApiErrorOptions);
+}
+/** The partner key was missing, malformed, or rejected (HTTP 401). */
+declare class AuthenticationError extends ApiError {
+    constructor(message: string, options: ApiErrorOptions);
+}
+/** A rate limit or credit cap was hit (HTTP 429). */
+declare class RateLimitError extends ApiError {
+    /** Server-advised wait in seconds, when provided. */
+    readonly retryAfter?: number;
+    constructor(message: string, options: RateLimitOptions);
+}
+/** The API could not be reached (DNS, TLS, timeout, or network failure). */
+declare class MindUploadConnectionError extends MindUploadError {
+    constructor(message: string, options?: ErrorOptions);
+}
+
+declare const VERSION = "1.5.1";
+
+export { type AbortMultipartUploadParams, ApiError, type ApiErrorOptions, AuthenticationError, type CancelUploadParams, type CheckChatroomUpdatesParams, type CheckUsernameParams, type ClientOptions, type CompleteMultipartUploadParams, type CreateChatroomMembershipParams, type CreateChatroomMessageParams, type CreateChatroomParams, type CreateCloneParams, type CreateTextParams, DEFAULT_BASE_URL, type ErrorOptions, type GetChatParams, type GetChatroomMembershipParams, type GetChatroomMessagesParams, type GetChatroomsParams, type GetClonesParams, type GetMindClusterParams, type GetQuotaParams, type GetSoulmateReportParams, type GetTextsParams, type GetUserParams, type ListUploadPartsParams, type LoginParams, type LogoutParams, MindUpload, MindUploadBase, MindUploadConnectionError, MindUploadError, type RagParams, RateLimitError, type RateLimitOptions, type RegisterParams, type RequestMultipartUploadParams, type RequestUploadUrlParams, type Result, type SignUploadPartParams, type SignUploadPartsBatchParams, type TriggerSocialParams, type UpdateCloneParams, type UpdateUserParams, VERSION };