@worldcoin/minikit-js 1.11.0 → 2.0.0-dev.1

package/build/types-CSyzFDPt.d.cts

@@ -0,0 +1,223 @@
+type EventPayload = any;
+type EventHandler<E extends ResponseEvent = ResponseEvent> = (data: EventPayload) => void;
+declare class EventManager {
+    private listeners;
+    subscribe<E extends ResponseEvent>(event: E, handler: EventHandler<E>): void;
+    unsubscribe(event: ResponseEvent): void;
+    trigger(event: ResponseEvent, payload: EventPayload): void;
+}
+
+type User = {
+    walletAddress?: string;
+    username?: string;
+    profilePictureUrl?: string;
+    permissions?: {
+        notifications: boolean;
+        contacts: boolean;
+    };
+    optedIntoOptionalAnalytics?: boolean;
+};
+type DeviceProperties = {
+    safeAreaInsets?: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    deviceOS?: string;
+    worldAppVersion?: number;
+};
+type UserNameService = {
+    walletAddress: string;
+    username?: string;
+    profilePictureUrl?: string;
+};
+type MiniAppLocation = {
+    countryCode?: string;
+    regionCode?: string;
+};
+declare enum MiniAppLaunchLocation {
+    Chat = "chat",
+    Home = "home",
+    AppStore = "app-store",
+    DeepLink = "deep-link",
+    WalletTab = "wallet-tab"
+}
+declare enum MiniKitInstallErrorCodes {
+    Unknown = "unknown",
+    AlreadyInstalled = "already_installed",
+    OutsideOfWorldApp = "outside_of_worldapp",
+    NotOnClient = "not_on_client",
+    AppOutOfDate = "app_out_of_date"
+}
+declare const MiniKitInstallErrorMessage: {
+    unknown: string;
+    already_installed: string;
+    outside_of_worldapp: string;
+    not_on_client: string;
+    app_out_of_date: string;
+};
+type MiniKitInstallReturnType = {
+    success: true;
+} | {
+    success: false;
+    errorCode: MiniKitInstallErrorCodes;
+    errorMessage: (typeof MiniKitInstallErrorMessage)[MiniKitInstallErrorCodes];
+};
+
+declare enum Command {
+    Attestation = "attestation",
+    Pay = "pay",
+    WalletAuth = "wallet-auth",
+    SendTransaction = "send-transaction",
+    SignMessage = "sign-message",
+    SignTypedData = "sign-typed-data",
+    ShareContacts = "share-contacts",
+    RequestPermission = "request-permission",
+    GetPermissions = "get-permissions",
+    SendHapticFeedback = "send-haptic-feedback",
+    Share = "share",
+    Chat = "chat",
+    CloseMiniApp = "close-miniapp"
+}
+declare enum ResponseEvent {
+    MiniAppAttestation = "miniapp-attestation",
+    MiniAppPayment = "miniapp-payment",
+    MiniAppWalletAuth = "miniapp-wallet-auth",
+    MiniAppSendTransaction = "miniapp-send-transaction",
+    MiniAppSignMessage = "miniapp-sign-message",
+    MiniAppSignTypedData = "miniapp-sign-typed-data",
+    MiniAppShareContacts = "miniapp-share-contacts",
+    MiniAppRequestPermission = "miniapp-request-permission",
+    MiniAppGetPermissions = "miniapp-get-permissions",
+    MiniAppSendHapticFeedback = "miniapp-send-haptic-feedback",
+    MiniAppShare = "miniapp-share",
+    MiniAppMicrophone = "miniapp-microphone",
+    MiniAppChat = "miniapp-chat"
+}
+declare const COMMAND_VERSIONS: Record<Command, number>;
+declare function isCommandAvailable(command: Command | string): boolean;
+declare function setCommandAvailable(command: Command, available: boolean): void;
+declare function validateCommands(worldAppSupportedCommands: NonNullable<typeof window.WorldApp>['supported_commands']): boolean;
+interface CommandState {
+    deviceProperties: DeviceProperties;
+}
+interface CommandContext {
+    events: EventManager;
+    state: CommandState;
+}
+type WebViewBasePayload = {
+    command: Command;
+    version: number;
+    payload: Record<string, any>;
+};
+declare function sendMiniKitEvent<T extends Record<string, any>>(payload: T): void;
+type MiniAppBaseSuccessPayload = {
+    status: 'success';
+    version: number;
+};
+type MiniAppBaseErrorPayload<TErrorCode = string> = {
+    status: 'error';
+    error_code: TErrorCode;
+    version: number;
+};
+declare function isInWorldApp(): boolean;
+type CommandVia = 'minikit' | 'wagmi' | 'fallback';
+interface CommandResult<T> {
+    data: T;
+    executedWith: CommandVia;
+}
+type CommandResultByVia<TNative, TFallback = TNative, TViaNative extends CommandVia = Exclude<CommandVia, 'fallback'>> = {
+    executedWith: TViaNative;
+    data: TNative;
+} | {
+    executedWith: 'fallback';
+    data: TFallback;
+};
+interface FallbackConfig<TFallback = unknown> {
+    /**
+     * Optional custom fallback executor.
+     * The fallback return type can differ from the native/Wagmi success payload.
+     */
+    fallback?: () => Promise<TFallback> | TFallback;
+}
+type FallbackReason = 'notInWorldApp' | 'commandNotSupported' | 'oldAppVersion';
+declare class FallbackRequiredError extends Error {
+    constructor(command: string);
+}
+declare class CommandUnavailableError extends Error {
+    readonly reason: FallbackReason;
+    constructor(command: string, reason: FallbackReason);
+}
+
+/** @deprecated Use {@link MiniKitWalletAuthOptions} instead */
+type WalletAuthInput = {
+    nonce: string;
+    statement?: string;
+    requestId?: string;
+    expirationTime?: Date;
+    notBefore?: Date;
+};
+type WalletAuthPayload = {
+    siweMessage: string;
+};
+declare enum WalletAuthErrorCodes {
+    MalformedRequest = "malformed_request",
+    UserRejected = "user_rejected",
+    GenericError = "generic_error"
+}
+declare const WalletAuthErrorMessage: {
+    malformed_request: string;
+    user_rejected: string;
+    generic_error: string;
+};
+type MiniAppWalletAuthSuccessPayload = MiniAppBaseSuccessPayload & {
+    message: string;
+    signature: string;
+    address: string;
+};
+type MiniAppWalletAuthErrorPayload = MiniAppBaseErrorPayload<WalletAuthErrorCodes> & {
+    details: (typeof WalletAuthErrorMessage)[WalletAuthErrorCodes];
+};
+type MiniAppWalletAuthPayload = MiniAppWalletAuthSuccessPayload | MiniAppWalletAuthErrorPayload;
+interface MiniKitWalletAuthOptions<TCustomFallback = WalletAuthResult> extends FallbackConfig<TCustomFallback> {
+    /** Nonce for SIWE message (alphanumeric, at least 8 chars) */
+    nonce: string;
+    /** Optional statement to include in SIWE message */
+    statement?: string;
+    /** Optional request ID for tracking */
+    requestId?: string;
+    /** Optional expiration time for the SIWE message */
+    expirationTime?: Date;
+    /** Optional not-before time for the SIWE message */
+    notBefore?: Date;
+}
+interface WalletAuthResult {
+    /** Wallet address */
+    address: string;
+    /** Signed SIWE message */
+    message: string;
+    /** Signature */
+    signature: string;
+}
+type SiweMessage = {
+    scheme?: string;
+    domain: string;
+    address?: string;
+    statement?: string;
+    uri: string;
+    version: string;
+    chain_id: number;
+    nonce: string;
+    issued_at: string;
+    expiration_time?: string;
+    not_before?: string;
+    request_id?: string;
+};
+declare class WalletAuthError extends Error {
+    readonly code: string;
+    readonly details?: string;
+    constructor(code: string, details?: string);
+}
+
+export { type MiniAppWalletAuthPayload as A, WalletAuthError as B, type CommandResultByVia as C, type DeviceProperties as D, type MiniAppLocation as E, type FallbackConfig as F, MiniKitInstallErrorCodes as G, MiniKitInstallErrorMessage as H, type MiniKitWalletAuthOptions as M, ResponseEvent as R, type SiweMessage as S, type User as U, type WalletAuthResult as W, MiniAppLaunchLocation as a, type MiniKitInstallReturnType as b, type UserNameService as c, type CommandContext as d, Command as e, COMMAND_VERSIONS as f, isCommandAvailable as g, type CommandState as h, isInWorldApp as i, type WebViewBasePayload as j, sendMiniKitEvent as k, type MiniAppBaseSuccessPayload as l, type MiniAppBaseErrorPayload as m, type CommandVia as n, type CommandResult as o, type FallbackReason as p, FallbackRequiredError as q, CommandUnavailableError as r, setCommandAvailable as s, type WalletAuthInput as t, type WalletAuthPayload as u, validateCommands as v, WalletAuthErrorCodes as w, WalletAuthErrorMessage as x, type MiniAppWalletAuthSuccessPayload as y, type MiniAppWalletAuthErrorPayload as z };

package/build/types-CSyzFDPt.d.ts

@@ -0,0 +1,223 @@
+type EventPayload = any;
+type EventHandler<E extends ResponseEvent = ResponseEvent> = (data: EventPayload) => void;
+declare class EventManager {
+    private listeners;
+    subscribe<E extends ResponseEvent>(event: E, handler: EventHandler<E>): void;
+    unsubscribe(event: ResponseEvent): void;
+    trigger(event: ResponseEvent, payload: EventPayload): void;
+}
+
+type User = {
+    walletAddress?: string;
+    username?: string;
+    profilePictureUrl?: string;
+    permissions?: {
+        notifications: boolean;
+        contacts: boolean;
+    };
+    optedIntoOptionalAnalytics?: boolean;
+};
+type DeviceProperties = {
+    safeAreaInsets?: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    deviceOS?: string;
+    worldAppVersion?: number;
+};
+type UserNameService = {
+    walletAddress: string;
+    username?: string;
+    profilePictureUrl?: string;
+};
+type MiniAppLocation = {
+    countryCode?: string;
+    regionCode?: string;
+};
+declare enum MiniAppLaunchLocation {
+    Chat = "chat",
+    Home = "home",
+    AppStore = "app-store",
+    DeepLink = "deep-link",
+    WalletTab = "wallet-tab"
+}
+declare enum MiniKitInstallErrorCodes {
+    Unknown = "unknown",
+    AlreadyInstalled = "already_installed",
+    OutsideOfWorldApp = "outside_of_worldapp",
+    NotOnClient = "not_on_client",
+    AppOutOfDate = "app_out_of_date"
+}
+declare const MiniKitInstallErrorMessage: {
+    unknown: string;
+    already_installed: string;
+    outside_of_worldapp: string;
+    not_on_client: string;
+    app_out_of_date: string;
+};
+type MiniKitInstallReturnType = {
+    success: true;
+} | {
+    success: false;
+    errorCode: MiniKitInstallErrorCodes;
+    errorMessage: (typeof MiniKitInstallErrorMessage)[MiniKitInstallErrorCodes];
+};
+
+declare enum Command {
+    Attestation = "attestation",
+    Pay = "pay",
+    WalletAuth = "wallet-auth",
+    SendTransaction = "send-transaction",
+    SignMessage = "sign-message",
+    SignTypedData = "sign-typed-data",
+    ShareContacts = "share-contacts",
+    RequestPermission = "request-permission",
+    GetPermissions = "get-permissions",
+    SendHapticFeedback = "send-haptic-feedback",
+    Share = "share",
+    Chat = "chat",
+    CloseMiniApp = "close-miniapp"
+}
+declare enum ResponseEvent {
+    MiniAppAttestation = "miniapp-attestation",
+    MiniAppPayment = "miniapp-payment",
+    MiniAppWalletAuth = "miniapp-wallet-auth",
+    MiniAppSendTransaction = "miniapp-send-transaction",
+    MiniAppSignMessage = "miniapp-sign-message",
+    MiniAppSignTypedData = "miniapp-sign-typed-data",
+    MiniAppShareContacts = "miniapp-share-contacts",
+    MiniAppRequestPermission = "miniapp-request-permission",
+    MiniAppGetPermissions = "miniapp-get-permissions",
+    MiniAppSendHapticFeedback = "miniapp-send-haptic-feedback",
+    MiniAppShare = "miniapp-share",
+    MiniAppMicrophone = "miniapp-microphone",
+    MiniAppChat = "miniapp-chat"
+}
+declare const COMMAND_VERSIONS: Record<Command, number>;
+declare function isCommandAvailable(command: Command | string): boolean;
+declare function setCommandAvailable(command: Command, available: boolean): void;
+declare function validateCommands(worldAppSupportedCommands: NonNullable<typeof window.WorldApp>['supported_commands']): boolean;
+interface CommandState {
+    deviceProperties: DeviceProperties;
+}
+interface CommandContext {
+    events: EventManager;
+    state: CommandState;
+}
+type WebViewBasePayload = {
+    command: Command;
+    version: number;
+    payload: Record<string, any>;
+};
+declare function sendMiniKitEvent<T extends Record<string, any>>(payload: T): void;
+type MiniAppBaseSuccessPayload = {
+    status: 'success';
+    version: number;
+};
+type MiniAppBaseErrorPayload<TErrorCode = string> = {
+    status: 'error';
+    error_code: TErrorCode;
+    version: number;
+};
+declare function isInWorldApp(): boolean;
+type CommandVia = 'minikit' | 'wagmi' | 'fallback';
+interface CommandResult<T> {
+    data: T;
+    executedWith: CommandVia;
+}
+type CommandResultByVia<TNative, TFallback = TNative, TViaNative extends CommandVia = Exclude<CommandVia, 'fallback'>> = {
+    executedWith: TViaNative;
+    data: TNative;
+} | {
+    executedWith: 'fallback';
+    data: TFallback;
+};
+interface FallbackConfig<TFallback = unknown> {
+    /**
+     * Optional custom fallback executor.
+     * The fallback return type can differ from the native/Wagmi success payload.
+     */
+    fallback?: () => Promise<TFallback> | TFallback;
+}
+type FallbackReason = 'notInWorldApp' | 'commandNotSupported' | 'oldAppVersion';
+declare class FallbackRequiredError extends Error {
+    constructor(command: string);
+}
+declare class CommandUnavailableError extends Error {
+    readonly reason: FallbackReason;
+    constructor(command: string, reason: FallbackReason);
+}
+
+/** @deprecated Use {@link MiniKitWalletAuthOptions} instead */
+type WalletAuthInput = {
+    nonce: string;
+    statement?: string;
+    requestId?: string;
+    expirationTime?: Date;
+    notBefore?: Date;
+};
+type WalletAuthPayload = {
+    siweMessage: string;
+};
+declare enum WalletAuthErrorCodes {
+    MalformedRequest = "malformed_request",
+    UserRejected = "user_rejected",
+    GenericError = "generic_error"
+}
+declare const WalletAuthErrorMessage: {
+    malformed_request: string;
+    user_rejected: string;
+    generic_error: string;
+};
+type MiniAppWalletAuthSuccessPayload = MiniAppBaseSuccessPayload & {
+    message: string;
+    signature: string;
+    address: string;
+};
+type MiniAppWalletAuthErrorPayload = MiniAppBaseErrorPayload<WalletAuthErrorCodes> & {
+    details: (typeof WalletAuthErrorMessage)[WalletAuthErrorCodes];
+};
+type MiniAppWalletAuthPayload = MiniAppWalletAuthSuccessPayload | MiniAppWalletAuthErrorPayload;
+interface MiniKitWalletAuthOptions<TCustomFallback = WalletAuthResult> extends FallbackConfig<TCustomFallback> {
+    /** Nonce for SIWE message (alphanumeric, at least 8 chars) */
+    nonce: string;
+    /** Optional statement to include in SIWE message */
+    statement?: string;
+    /** Optional request ID for tracking */
+    requestId?: string;
+    /** Optional expiration time for the SIWE message */
+    expirationTime?: Date;
+    /** Optional not-before time for the SIWE message */
+    notBefore?: Date;
+}
+interface WalletAuthResult {
+    /** Wallet address */
+    address: string;
+    /** Signed SIWE message */
+    message: string;
+    /** Signature */
+    signature: string;
+}
+type SiweMessage = {
+    scheme?: string;
+    domain: string;
+    address?: string;
+    statement?: string;
+    uri: string;
+    version: string;
+    chain_id: number;
+    nonce: string;
+    issued_at: string;
+    expiration_time?: string;
+    not_before?: string;
+    request_id?: string;
+};
+declare class WalletAuthError extends Error {
+    readonly code: string;
+    readonly details?: string;
+    constructor(code: string, details?: string);
+}
+
+export { type MiniAppWalletAuthPayload as A, WalletAuthError as B, type CommandResultByVia as C, type DeviceProperties as D, type MiniAppLocation as E, type FallbackConfig as F, MiniKitInstallErrorCodes as G, MiniKitInstallErrorMessage as H, type MiniKitWalletAuthOptions as M, ResponseEvent as R, type SiweMessage as S, type User as U, type WalletAuthResult as W, MiniAppLaunchLocation as a, type MiniKitInstallReturnType as b, type UserNameService as c, type CommandContext as d, Command as e, COMMAND_VERSIONS as f, isCommandAvailable as g, type CommandState as h, isInWorldApp as i, type WebViewBasePayload as j, sendMiniKitEvent as k, type MiniAppBaseSuccessPayload as l, type MiniAppBaseErrorPayload as m, type CommandVia as n, type CommandResult as o, type FallbackReason as p, FallbackRequiredError as q, CommandUnavailableError as r, setCommandAvailable as s, type WalletAuthInput as t, type WalletAuthPayload as u, validateCommands as v, WalletAuthErrorCodes as w, WalletAuthErrorMessage as x, type MiniAppWalletAuthSuccessPayload as y, type MiniAppWalletAuthErrorPayload as z };