@vicociv/instaloader 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,1664 @@
+/**
+ * Base exception for Instaloader.
+ * This exception should not be thrown directly.
+ */
+declare class InstaloaderException extends Error {
+    constructor(message?: string);
+}
+/**
+ * Thrown when Instagram API returns a 400 Bad Request.
+ */
+declare class QueryReturnedBadRequestException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when Instagram API returns a 403 Forbidden.
+ */
+declare class QueryReturnedForbiddenException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when the requested profile does not exist.
+ */
+declare class ProfileNotExistsException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * @deprecated Not raised anymore since version 4.2.2
+ */
+declare class ProfileHasNoPicsException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when trying to access a private profile that is not followed.
+ */
+declare class PrivateProfileNotFollowedException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when login is required to access a resource.
+ */
+declare class LoginRequiredException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Base exception for login-related errors.
+ */
+declare class LoginException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when two-factor authentication is required.
+ */
+declare class TwoFactorAuthRequiredException extends LoginException {
+    readonly twoFactorInfo: TwoFactorInfo;
+    constructor(twoFactorInfo: TwoFactorInfo, message?: string);
+}
+interface TwoFactorInfo {
+    username: string;
+    identifier: string;
+    obfuscatedPhoneNumber?: string;
+    showMessengerCodeOption?: boolean;
+    showNewLoginScreen?: boolean;
+    showTrustedDeviceOption?: boolean;
+    phoneverificationSettings?: PhoneVerificationSettings;
+    pendingTrustedNotificationPolling?: boolean;
+}
+interface PhoneVerificationSettings {
+    maxSmsCount?: number;
+    resendSmsDelaySec?: number;
+    robocallCountDownTimeSec?: number;
+    robocallAfterMaxSms?: boolean;
+}
+/**
+ * Thrown when an invalid argument is passed.
+ */
+declare class InvalidArgumentException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when the API returns an unexpected response.
+ */
+declare class BadResponseException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when login credentials are invalid.
+ */
+declare class BadCredentialsException extends LoginException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when there is a network connection error.
+ */
+declare class ConnectionException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when a post has changed since it was loaded.
+ * @since 4.2.2
+ */
+declare class PostChangedException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when Instagram API returns a 404 Not Found.
+ */
+declare class QueryReturnedNotFoundException extends ConnectionException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when Instagram API returns a 429 Too Many Requests.
+ */
+declare class TooManyRequestsException extends ConnectionException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when iPhone support is disabled but an iPhone-only feature is requested.
+ */
+declare class IPhoneSupportDisabledException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Exception that is not caught in the error handlers inside the download loop
+ * and so aborts the download loop.
+ *
+ * This exception is not a subclass of InstaloaderException.
+ *
+ * @since 4.7
+ */
+declare class AbortDownloadException extends Error {
+    constructor(message?: string);
+}
+/**
+ * Thrown when the session file is not found.
+ */
+declare class SessionNotFoundException extends InstaloaderException {
+    constructor(message?: string);
+}
+/**
+ * Thrown when a checkpoint/challenge is required.
+ */
+declare class CheckpointRequiredException extends ConnectionException {
+    readonly checkpointUrl: string | undefined;
+    constructor(message?: string, checkpointUrl?: string);
+}
+/**
+ * Thrown when the iterator state is invalid or expired.
+ */
+declare class InvalidIteratorException extends InstaloaderException {
+    constructor(message?: string);
+}
+
+/**
+ * Common types used throughout the Instaloader library.
+ */
+/**
+ * Generic JSON object type.
+ */
+type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+type JsonObject = {
+    [key: string]: JsonValue;
+};
+/**
+ * Cookie object for session management.
+ */
+interface CookieData {
+    [key: string]: string;
+}
+/**
+ * HTTP headers object.
+ */
+interface HttpHeaders {
+    [key: string]: string;
+}
+/**
+ * GraphQL query response.
+ */
+interface GraphQLResponse {
+    data?: JsonObject;
+    status?: string;
+    message?: string;
+    [key: string]: JsonValue | undefined;
+}
+/**
+ * Login response from Instagram.
+ */
+interface LoginResponse {
+    authenticated?: boolean;
+    user?: boolean;
+    userId?: string;
+    status?: string;
+    message?: string;
+    checkpoint_url?: string;
+    two_factor_required?: boolean;
+    two_factor_info?: {
+        two_factor_identifier: string;
+        obfuscated_phone_number?: string;
+        show_messenger_code_option?: boolean;
+        show_new_login_screen?: boolean;
+        show_trusted_device_option?: boolean;
+        pending_trusted_notification_polling?: boolean;
+    };
+    oneTapPrompt?: boolean;
+}
+/**
+ * HTTP response information.
+ */
+interface ResponseInfo {
+    status: number;
+    statusText: string;
+    headers: Headers;
+    url: string;
+}
+/**
+ * Request options for fetch.
+ */
+interface RequestOptions {
+    method?: 'GET' | 'POST' | 'HEAD';
+    headers?: HeadersInit;
+    body?: string | URLSearchParams;
+    redirect?: RequestRedirect;
+    signal?: AbortSignal;
+}
+/**
+ * Session data for persistence.
+ */
+interface SessionData {
+    cookies: CookieData;
+    username: string;
+    userId?: string;
+}
+/**
+ * Rate controller query timestamps.
+ */
+interface QueryTimestamps {
+    [queryType: string]: number[];
+}
+/**
+ * iPhone headers for API requests.
+ */
+interface IPhoneHeaders {
+    'User-Agent': string;
+    'x-ads-opt-out': string;
+    'x-bloks-is-panorama-enabled': string;
+    'x-bloks-version-id': string;
+    'x-fb-client-ip': string;
+    'x-fb-connection-type': string;
+    'x-fb-http-engine': string;
+    'x-fb-server-cluster': string;
+    'x-fb': string;
+    'x-ig-abr-connection-speed-kbps': string;
+    'x-ig-app-id': string;
+    'x-ig-app-locale': string;
+    'x-ig-app-startup-country': string;
+    'x-ig-bandwidth-speed-kbps': string;
+    'x-ig-capabilities': string;
+    'x-ig-connection-speed': string;
+    'x-ig-connection-type': string;
+    'x-ig-device-locale': string;
+    'x-ig-mapped-locale': string;
+    'x-ig-timezone-offset': string;
+    'x-ig-www-claim': string;
+    'x-pigeon-session-id': string;
+    'x-tigon-is-retry': string;
+    'x-whatsapp': string;
+    [key: string]: string;
+}
+/**
+ * Post node from GraphQL response.
+ */
+interface PostNode {
+    id: string;
+    shortcode: string;
+    typename?: string;
+    __typename?: string;
+    display_url?: string;
+    is_video?: boolean;
+    video_url?: string;
+    edge_media_to_caption?: {
+        edges: Array<{
+            node: {
+                text: string;
+            };
+        }>;
+    };
+    edge_media_to_comment?: {
+        count: number;
+    };
+    edge_liked_by?: {
+        count: number;
+    };
+    edge_media_preview_like?: {
+        count: number;
+    };
+    owner?: {
+        id: string;
+        username: string;
+    };
+    taken_at_timestamp?: number;
+    location?: {
+        id: string;
+        name: string;
+        slug?: string;
+    } | null;
+    accessibility_caption?: string | null;
+    edge_sidecar_to_children?: {
+        edges: Array<{
+            node: PostNode;
+        }>;
+    };
+    video_view_count?: number;
+    video_duration?: number;
+}
+/**
+ * Profile node from GraphQL response.
+ */
+interface ProfileNode {
+    id: string;
+    username: string;
+    full_name?: string;
+    biography?: string;
+    profile_pic_url?: string;
+    profile_pic_url_hd?: string;
+    is_private?: boolean;
+    is_verified?: boolean;
+    is_business_account?: boolean;
+    business_category_name?: string | null;
+    external_url?: string | null;
+    edge_followed_by?: {
+        count: number;
+    };
+    edge_follow?: {
+        count: number;
+    };
+    edge_owner_to_timeline_media?: {
+        count: number;
+    };
+    followed_by_viewer?: boolean;
+    follows_viewer?: boolean;
+    blocked_by_viewer?: boolean;
+    has_blocked_viewer?: boolean;
+    requested_by_viewer?: boolean;
+}
+/**
+ * Story item node from GraphQL response.
+ */
+interface StoryItemNode {
+    id: string;
+    __typename?: string;
+    display_url?: string;
+    is_video?: boolean;
+    video_resources?: Array<{
+        src: string;
+        profile?: string;
+    }>;
+    taken_at_timestamp?: number;
+    expiring_at_timestamp?: number;
+    story_cta_url?: string | null;
+    owner?: {
+        id: string;
+        username: string;
+    };
+}
+/**
+ * Highlight node from GraphQL response.
+ */
+interface HighlightNode {
+    id: string;
+    title: string;
+    cover_media?: {
+        thumbnail_src?: string;
+    };
+    cover_media_cropped_thumbnail?: {
+        url?: string;
+    };
+    owner?: {
+        id: string;
+        username: string;
+    };
+}
+/**
+ * Comment node from GraphQL response.
+ */
+interface CommentNode {
+    id: string;
+    text: string;
+    created_at: number;
+    owner: {
+        id: string;
+        username: string;
+        profile_pic_url?: string;
+    };
+    edge_liked_by?: {
+        count: number;
+    };
+    edge_threaded_comments?: {
+        count: number;
+        edges: Array<{
+            node: CommentNode;
+        }>;
+    };
+}
+/**
+ * Hashtag node from GraphQL response.
+ */
+interface HashtagNode {
+    id: string;
+    name: string;
+    profile_pic_url?: string;
+    edge_hashtag_to_media?: {
+        count: number;
+    };
+    edge_hashtag_to_top_posts?: {
+        edges: Array<{
+            node: PostNode;
+        }>;
+    };
+}
+/**
+ * Location node from GraphQL response.
+ */
+interface LocationNode {
+    id: string;
+    name: string;
+    slug?: string;
+    has_public_page?: boolean;
+    lat?: number;
+    lng?: number;
+}
+/**
+ * Page info for pagination.
+ */
+interface PageInfo {
+    has_next_page: boolean;
+    end_cursor: string | null;
+}
+/**
+ * Edge connection type for GraphQL pagination.
+ */
+interface EdgeConnection<T> {
+    count?: number;
+    page_info: PageInfo;
+    edges: Array<{
+        node: T;
+    }>;
+}
+/**
+ * Frozen iterator state for resumable downloads.
+ */
+interface FrozenIteratorState {
+    queryHash?: string;
+    queryVariables: JsonObject;
+    queryReferer?: string | null;
+    contextUsername?: string | null;
+    totalIndex: number;
+    bestBefore?: number;
+    remainingData?: Array<{
+        node: JsonObject;
+    }> | null;
+    firstNode?: JsonObject | null;
+    docId?: string;
+}
+
+/**
+ * InstaloaderContext - HTTP client and low-level communication with Instagram.
+ * Ported from Python instaloader/instaloadercontext.py
+ */
+
+/**
+ * Returns default user agent string.
+ */
+declare function defaultUserAgent(): string;
+/**
+ * Returns default iPhone headers for API requests.
+ */
+declare function defaultIphoneHeaders(): HttpHeaders;
+/**
+ * Class providing request tracking and rate controlling to stay within rate limits.
+ */
+declare class RateController {
+    protected _context: InstaloaderContext;
+    protected _queryTimestamps: Map<string, number[]>;
+    protected _earliestNextRequestTime: number;
+    protected _iphoneEarliestNextRequestTime: number;
+    constructor(context: InstaloaderContext);
+    /**
+     * Wait given number of seconds.
+     */
+    sleep(secs: number): Promise<void>;
+    /**
+     * Return how many requests of the given type can be done within a sliding window of 11 minutes.
+     */
+    countPerSlidingWindow(queryType: string): number;
+    private _reqsInSlidingWindow;
+    /**
+     * Calculate time needed to wait before query can be executed.
+     */
+    queryWaittime(queryType: string, currentTime: number, untrackedQueries?: boolean): number;
+    /**
+     * Called before a query to Instagram.
+     */
+    waitBeforeQuery(queryType: string): Promise<void>;
+    /**
+     * Handle a 429 Too Many Requests response.
+     */
+    handle429(queryType: string): Promise<void>;
+}
+interface InstaloaderContextOptions {
+    /** Whether to sleep between requests (default: true) */
+    sleep?: boolean;
+    /** Whether to suppress output (default: false) */
+    quiet?: boolean;
+    /** Custom user agent string */
+    userAgent?: string;
+    /** Maximum connection retry attempts (default: 3) */
+    maxConnectionAttempts?: number;
+    /** Request timeout in milliseconds (default: 300000) */
+    requestTimeout?: number;
+    /** Custom rate controller factory */
+    rateController?: (ctx: InstaloaderContext) => RateController;
+    /** HTTP status codes that should cause an AbortDownloadException */
+    fatalStatusCodes?: number[];
+    /** Whether to enable iPhone API support (default: true) */
+    iphoneSupport?: boolean;
+}
+/**
+ * Class providing methods for logging and low-level communication with Instagram.
+ *
+ * It provides low-level communication routines getJson(), graphqlQuery(), getIphoneJson()
+ * and implements mechanisms for rate controlling and error handling.
+ *
+ * Further, it provides methods for logging in and general session handles.
+ */
+declare class InstaloaderContext {
+    readonly userAgent: string;
+    readonly requestTimeout: number;
+    readonly maxConnectionAttempts: number;
+    readonly sleep: boolean;
+    readonly quiet: boolean;
+    readonly iphoneSupport: boolean;
+    readonly fatalStatusCodes: number[];
+    private _cookieJar;
+    private _csrfToken;
+    private _username;
+    private _userId;
+    private _iphoneHeaders;
+    private _rateController;
+    private _errorLog;
+    private _twoFactorAuthPending;
+    /** Raise all errors instead of catching them (for testing) */
+    raiseAllErrors: boolean;
+    /** Cache profile from id (mapping from id to Profile) */
+    readonly profile_id_cache: Map<number, any>;
+    constructor(options?: InstaloaderContextOptions);
+    private _initAnonymousCookies;
+    /** True if this instance is logged in. */
+    get is_logged_in(): boolean;
+    /** The username of the logged-in user, or null. */
+    get username(): string | null;
+    /** The user ID of the logged-in user, or null. */
+    get userId(): string | null;
+    /** iPhone headers for API requests. */
+    get iphone_headers(): HttpHeaders;
+    /** Whether any error has been reported and stored. */
+    get hasStoredErrors(): boolean;
+    /**
+     * Log a message to stdout (can be suppressed with quiet option).
+     * @param message - The message to log
+     * @param newline - Whether to add a newline (default true, false for inline messages)
+     */
+    log(message: string, newline?: boolean): void;
+    /**
+     * Log a non-fatal error message to stderr.
+     */
+    error(message: string, repeatAtEnd?: boolean): void;
+    /**
+     * Close the context and print any stored errors.
+     */
+    close(): void;
+    /**
+     * Returns default HTTP headers for requests.
+     */
+    private _defaultHttpHeader;
+    /**
+     * Sleep a short time if sleep is enabled.
+     */
+    doSleep(): Promise<void>;
+    /**
+     * Get cookies as a plain object.
+     */
+    getCookies(url?: string): CookieData;
+    /**
+     * Set cookies from a plain object.
+     */
+    setCookies(cookies: CookieData, url?: string): void;
+    /**
+     * Save session data for later restoration.
+     */
+    saveSession(): CookieData;
+    /**
+     * Load session data from a saved session.
+     */
+    loadSession(username: string, sessionData: CookieData): void;
+    /**
+     * Update cookies with new values.
+     */
+    updateCookies(cookies: CookieData): void;
+    /**
+     * Build cookie header string from cookie jar.
+     */
+    private _getCookieHeader;
+    /**
+     * Parse and store cookies from Set-Cookie headers.
+     */
+    private _storeCookies;
+    /**
+     * Format response error message.
+     */
+    private _responseError;
+    /**
+     * Make a JSON request to Instagram.
+     */
+    getJson(path: string, params: JsonObject, options?: {
+        host?: string;
+        usePost?: boolean;
+        attempt?: number;
+        headers?: HttpHeaders;
+    }): Promise<JsonObject>;
+    /**
+     * Do a GraphQL Query.
+     */
+    graphql_query(queryHash: string, variables: JsonObject, referer?: string): Promise<JsonObject>;
+    /**
+     * Do a doc_id-based GraphQL Query using POST.
+     */
+    doc_id_graphql_query(docId: string, variables: JsonObject, referer?: string): Promise<JsonObject>;
+    /**
+     * JSON request to i.instagram.com.
+     */
+    get_iphone_json(path: string, params: JsonObject): Promise<JsonObject>;
+    /**
+     * HEAD a URL anonymously.
+     */
+    head(url: string, options?: {
+        allowRedirects?: boolean;
+    }): Promise<{
+        headers: Map<string, string>;
+    }>;
+    /**
+     * Test if logged in by querying the current user.
+     */
+    testLogin(): Promise<string | null>;
+    /**
+     * Login to Instagram.
+     */
+    login(username: string, password: string): Promise<void>;
+    /**
+     * Second step of login if 2FA is enabled.
+     */
+    twoFactorLogin(twoFactorCode: string): Promise<void>;
+}
+
+/**
+ * NodeIterator - Async iterator for paginated GraphQL results.
+ *
+ * Ported from Python instaloader/nodeiterator.py
+ */
+
+/**
+ * Frozen state of a NodeIterator for resumable downloads.
+ */
+declare class FrozenNodeIterator {
+    readonly queryHash: string | null;
+    readonly queryVariables: JsonObject;
+    readonly queryReferer: string | null;
+    readonly contextUsername: string | null;
+    readonly totalIndex: number;
+    readonly bestBefore: number | null;
+    readonly remainingData: {
+        edges: Array<{
+            node: JsonObject;
+        }>;
+        page_info: {
+            has_next_page: boolean;
+            end_cursor: string | null;
+        };
+        count?: number;
+    } | null;
+    readonly firstNode: JsonObject | null;
+    readonly docId: string | undefined;
+    constructor(params: {
+        queryHash: string | null;
+        queryVariables: JsonObject;
+        queryReferer: string | null;
+        contextUsername: string | null;
+        totalIndex: number;
+        bestBefore: number | null;
+        remainingData: {
+            edges: Array<{
+                node: JsonObject;
+            }>;
+            page_info: {
+                has_next_page: boolean;
+                end_cursor: string | null;
+            };
+            count?: number;
+        } | null;
+        firstNode: JsonObject | null;
+        docId: string | undefined;
+    });
+    /**
+     * Convert to plain object for JSON serialization.
+     */
+    toObject(): {
+        queryHash: string | null;
+        queryVariables: JsonObject;
+        queryReferer: string | null;
+        contextUsername: string | null;
+        totalIndex: number;
+        bestBefore: number | null;
+        remainingData: {
+            edges: Array<{
+                node: JsonObject;
+            }>;
+            page_info: {
+                has_next_page: boolean;
+                end_cursor: string | null;
+            };
+            count?: number;
+        } | null;
+        firstNode: JsonObject | null;
+        docId: string | undefined;
+    };
+    /**
+     * Create from plain object (JSON deserialization).
+     */
+    static fromObject(obj: ReturnType<FrozenNodeIterator['toObject']>): FrozenNodeIterator;
+}
+interface NodeIteratorData {
+    edges: Array<{
+        node: JsonObject;
+    }>;
+    page_info: {
+        has_next_page: boolean;
+        end_cursor: string | null;
+    };
+    count?: number;
+}
+interface NodeIteratorOptions<T> {
+    context: InstaloaderContext;
+    queryHash: string | null;
+    edgeExtractor: (data: JsonObject) => JsonObject;
+    nodeWrapper: (node: JsonObject) => T;
+    queryVariables?: JsonObject;
+    queryReferer?: string | null;
+    firstData?: NodeIteratorData;
+    isFirst?: (item: T, currentFirst: T | null) => boolean;
+    docId?: string;
+}
+/**
+ * Iterate the nodes within edges in a GraphQL pagination.
+ *
+ * What makes this iterator special is its ability to freeze/store its current state,
+ * e.g. to interrupt an iteration, and later thaw/resume from where it left off.
+ *
+ * @example
+ * ```typescript
+ * const postIterator = profile.getPosts();
+ * try {
+ *   for await (const post of postIterator) {
+ *     await doSomethingWith(post);
+ *   }
+ * } catch (e) {
+ *   if (e instanceof KeyboardInterrupt) {
+ *     save("resume_information.json", postIterator.freeze());
+ *   }
+ * }
+ * ```
+ *
+ * And later reuse it with `thaw()`:
+ * ```typescript
+ * const postIterator = profile.getPosts();
+ * postIterator.thaw(load("resume_information.json"));
+ * ```
+ */
+declare class NodeIterator<T> implements AsyncIterable<T> {
+    private static readonly _graphql_page_length;
+    private static readonly _shelf_life_days;
+    private readonly _context;
+    private readonly _queryHash;
+    private readonly _docId;
+    private readonly _edgeExtractor;
+    private readonly _nodeWrapper;
+    private readonly _queryVariables;
+    private readonly _queryReferer;
+    private readonly _isFirst;
+    private _pageIndex;
+    private _totalIndex;
+    private _data;
+    private _bestBefore;
+    private _firstNode;
+    private _initialized;
+    private _initPromise;
+    constructor(options: NodeIteratorOptions<T>);
+    private _initialize;
+    private _ensureInitialized;
+    private _query;
+    private _queryDocId;
+    private _queryQueryHash;
+    /**
+     * The count as returned by Instagram.
+     * This is not always the total count this iterator will yield.
+     */
+    get count(): number | undefined;
+    /**
+     * Number of items that have already been returned.
+     */
+    get totalIndex(): number;
+    /**
+     * Magic string for easily identifying a matching iterator file for resuming.
+     * Two NodeIterators are matching if and only if they have the same magic.
+     */
+    get magic(): string;
+    /**
+     * If this iterator has produced any items, returns the first item produced.
+     *
+     * It is possible to override what is considered the first item by passing
+     * a callback function as the `isFirst` parameter when creating the class.
+     */
+    get firstItem(): T | null;
+    /**
+     * Static page length used for pagination.
+     */
+    static pageLength(): number;
+    /**
+     * Freeze the iterator for later resuming.
+     */
+    freeze(): FrozenNodeIterator;
+    /**
+     * Use this iterator for resuming from earlier iteration.
+     *
+     * @throws InvalidArgumentException if the iterator has already been used or the frozen state doesn't match
+     */
+    thaw(frozen: FrozenNodeIterator): void;
+    /**
+     * Async iterator implementation.
+     */
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+}
+/**
+ * Options for resumable iteration.
+ */
+interface ResumableIterationOptions<T> {
+    context: InstaloaderContext;
+    iterator: AsyncIterable<T> | Iterable<T>;
+    load: (context: InstaloaderContext, path: string) => FrozenNodeIterator | Promise<FrozenNodeIterator>;
+    save: (frozen: FrozenNodeIterator, path: string) => void | Promise<void>;
+    formatPath: (magic: string) => string;
+    checkBbd?: boolean;
+    enabled?: boolean;
+}
+/**
+ * Result of resumable iteration setup.
+ */
+interface ResumableIterationResult {
+    isResuming: boolean;
+    startIndex: number;
+}
+/**
+ * High-level function to handle resumable iteration.
+ *
+ * Note: Unlike Python's context manager, this returns the resumption info
+ * and the caller is responsible for handling interrupts.
+ *
+ * @example
+ * ```typescript
+ * const postIterator = profile.getPosts();
+ * const { isResuming, startIndex } = await resumableIteration({
+ *   context: L.context,
+ *   iterator: postIterator,
+ *   load: async (_, path) => FrozenNodeIterator.fromObject(JSON.parse(await fs.readFile(path, 'utf-8'))),
+ *   save: async (fni, path) => fs.writeFile(path, JSON.stringify(fni.toObject())),
+ *   formatPath: (magic) => `resume_info_${magic}.json`,
+ * });
+ *
+ * try {
+ *   for await (const post of postIterator) {
+ *     await doSomethingWith(post);
+ *   }
+ * } catch (e) {
+ *   // Save state on interrupt
+ *   if (postIterator instanceof NodeIterator) {
+ *     await save(postIterator.freeze(), formatPath(postIterator.magic));
+ *   }
+ *   throw e;
+ * }
+ * ```
+ */
+declare function resumableIteration<T>(options: ResumableIterationOptions<T>): Promise<ResumableIterationResult>;
+
+/**
+ * Data structures for Instagram content.
+ * Ported from Python instaloader/structures.py
+ */
+
+/**
+ * Item of a Sidecar Post.
+ */
+interface PostSidecarNode {
+    /** Whether this node is a video. */
+    is_video: boolean;
+    /** URL of image or video thumbnail. */
+    display_url: string;
+    /** URL of video or null. */
+    video_url: string | null;
+}
+/**
+ * Answer to a comment.
+ */
+interface PostCommentAnswer {
+    /** ID number of comment. */
+    id: number;
+    /** Timestamp when comment was created (UTC). */
+    created_at_utc: Date;
+    /** Comment text. */
+    text: string;
+    /** Owner Profile of the comment. */
+    owner: Profile;
+    /** Number of likes on comment. */
+    likes_count: number;
+}
+/**
+ * Location associated with a post.
+ */
+interface PostLocation {
+    /** ID number of location. */
+    id: number;
+    /** Location name. */
+    name: string;
+    /** URL friendly variant of location name. */
+    slug: string;
+    /** Whether location has a public page. */
+    has_public_page: boolean | null;
+    /** Latitude (number or null). */
+    lat: number | null;
+    /** Longitude (number or null). */
+    lng: number | null;
+}
+/**
+ * Convert a shortcode to a mediaid.
+ */
+declare function shortcodeToMediaid(code: string): bigint;
+/**
+ * Convert a mediaid to a shortcode.
+ */
+declare function mediaidToShortcode(mediaid: bigint): string;
+/**
+ * Extract hashtags from text.
+ */
+declare function extractHashtags(text: string): string[];
+/**
+ * Extract @mentions from text.
+ */
+declare function extractMentions(text: string): string[];
+/**
+ * Represents a comment on a post.
+ */
+declare class PostComment {
+    private readonly _context;
+    private readonly _node;
+    private readonly _answers;
+    private readonly _post;
+    constructor(context: InstaloaderContext, node: JsonObject, answers: AsyncIterable<PostCommentAnswer>, post: Post);
+    /**
+     * Create a PostComment from an iPhone API struct.
+     */
+    static fromIphoneStruct(context: InstaloaderContext, media: JsonObject, answers: AsyncIterable<PostCommentAnswer>, post: Post): PostComment;
+    /** ID number of comment. */
+    get id(): number;
+    /** Timestamp when comment was created (UTC). */
+    get created_at_utc(): Date;
+    /** Comment text. */
+    get text(): string;
+    /** Owner Profile of the comment. */
+    get owner(): Profile;
+    /** Number of likes on comment. */
+    get likes_count(): number;
+    /** Iterator which yields all PostCommentAnswer for the comment. */
+    get answers(): AsyncIterable<PostCommentAnswer>;
+    toString(): string;
+}
+/**
+ * Structure containing information about an Instagram post.
+ *
+ * Created by methods Profile.get_posts(), Instaloader.get_hashtag_posts(),
+ * Instaloader.get_feed_posts() and Profile.get_saved_posts().
+ *
+ * This class unifies access to the properties associated with a post.
+ * It implements equality comparison and is hashable.
+ */
+declare class Post {
+    private readonly _context;
+    private _node;
+    private _owner_profile;
+    private _full_metadata_dict;
+    private _location;
+    private _iphone_struct_;
+    /**
+     * @param context InstaloaderContext used for additional queries if necessary.
+     * @param node Node structure, as returned by Instagram.
+     * @param owner_profile The Profile of the owner, if already known at creation.
+     */
+    constructor(context: InstaloaderContext, node: JsonObject, owner_profile?: Profile | null);
+    /**
+     * Create a post object from a given shortcode.
+     */
+    static fromShortcode(context: InstaloaderContext, shortcode: string): Promise<Post>;
+    /**
+     * Create a post object from a given mediaid.
+     */
+    static fromMediaid(context: InstaloaderContext, mediaid: bigint): Promise<Post>;
+    /**
+     * Create a post from a given iphone_struct.
+     */
+    static fromIphoneStruct(context: InstaloaderContext, media: JsonObject): Post;
+    private static _convertIphoneCarousel;
+    /** The values of __typename fields that the Post class can handle. */
+    static supportedGraphqlTypes(): string[];
+    /** Media shortcode. URL of the post is instagram.com/p/<shortcode>/. */
+    get shortcode(): string;
+    /** The mediaid is a decimal representation of the media shortcode. */
+    get mediaid(): bigint;
+    /** Title of post */
+    get title(): string | null;
+    toString(): string;
+    equals(other: Post): boolean;
+    private _obtainMetadata;
+    private _getFullMetadata;
+    /**
+     * Get iPhone struct for high quality media.
+     * Reserved for future use to fetch HQ images.
+     */
+    private _getIphoneStruct;
+    /**
+     * Lookup fields in _node, and if not found in _full_metadata.
+     * Throws if not found anywhere.
+     */
+    private _field;
+    /**
+     * Async version of _field that can fetch full metadata if needed.
+     */
+    getField(...keys: string[]): Promise<JsonValue>;
+    /** Profile instance of the Post's owner. */
+    getOwnerProfile(): Promise<Profile>;
+    /** The Post's lowercase owner name. */
+    getOwnerUsername(): Promise<string>;
+    /** The ID of the Post's owner. */
+    get owner_id(): number | null;
+    /** Timestamp when the post was created (local time zone). */
+    get date_local(): Date;
+    /** Timestamp when the post was created (UTC). */
+    get date_utc(): Date;
+    /** Synonym to date_utc */
+    get date(): Date;
+    private _getTimestampDateCreated;
+    /** URL of the picture / video thumbnail of the post */
+    get url(): string;
+    /** Type of post: GraphImage, GraphVideo or GraphSidecar */
+    get typename(): string;
+    /** The number of media in a sidecar Post, or 1 if not a sidecar. */
+    get mediacount(): number;
+    /** Caption. */
+    get caption(): string | null;
+    /** List of all lowercased hashtags (without preceding #) that occur in the Post's caption. */
+    get caption_hashtags(): string[];
+    /** List of all lowercased profiles that are mentioned in the Post's caption, without preceding @. */
+    get caption_mentions(): string[];
+    /** Printable caption, useful as a format specifier for --filename-pattern. */
+    get pcaption(): string;
+    /** Accessibility caption of the post, if available. */
+    get accessibility_caption(): string | null;
+    /** List of all lowercased users that are tagged in the Post. */
+    get tagged_users(): string[];
+    /** True if the Post is a video. */
+    get is_video(): boolean;
+    /** URL of the video, or null. */
+    get video_url(): string | null;
+    /** View count of the video, or null. */
+    get video_view_count(): number | null;
+    /** Duration of the video in seconds, or null. */
+    get video_duration(): number | null;
+    /** Whether the viewer has liked the post, or null if not logged in. */
+    get viewer_has_liked(): boolean | null;
+    /** Likes count */
+    get likes(): number;
+    /** Comment count including answers */
+    get comments(): number;
+    /** Whether Post is a sponsored post. */
+    get is_sponsored(): boolean;
+    /** Returns true if is_video for each media in sidecar. */
+    getIsVideos(): boolean[];
+    /** Sidecar nodes of a Post with typename==GraphSidecar. */
+    getSidecarNodes(start?: number, end?: number): Generator<PostSidecarNode>;
+    /** Returns Post as a JSON-serializable object. */
+    toJSON(): JsonObject;
+}
+/**
+ * An Instagram Profile.
+ *
+ * Provides methods for accessing profile properties, as well as get_posts()
+ * and for own profile get_saved_posts().
+ *
+ * This class implements equality comparison and is hashable.
+ */
+declare class Profile {
+    private readonly _context;
+    private _node;
+    private _has_public_story;
+    private _has_full_metadata;
+    private _iphone_struct_;
+    constructor(context: InstaloaderContext, node: JsonObject);
+    /**
+     * Create a Profile instance from a given username.
+     * Raises exception if it does not exist.
+     */
+    static fromUsername(context: InstaloaderContext, username: string): Promise<Profile>;
+    /**
+     * Create a Profile instance from a given userid.
+     * If possible, use fromUsername or constructor instead.
+     */
+    static fromId(context: InstaloaderContext, profileId: number): Promise<Profile>;
+    /**
+     * Create a profile from a given iphone_struct.
+     */
+    static fromIphoneStruct(context: InstaloaderContext, media: JsonObject): Profile;
+    /**
+     * Return own profile if logged-in.
+     */
+    static ownProfile(context: InstaloaderContext): Promise<Profile>;
+    private _obtainMetadata;
+    private _metadata;
+    /**
+     * Async version that can fetch full metadata if needed.
+     */
+    getMetadata(...keys: string[]): Promise<JsonValue>;
+    /** User ID */
+    get userid(): number;
+    /** Profile Name (lowercase) */
+    get username(): string;
+    toString(): string;
+    equals(other: Profile): boolean;
+    /** Whether this is a private profile */
+    get is_private(): boolean;
+    /** Whether the viewer follows this profile */
+    get followed_by_viewer(): boolean;
+    /** Number of posts */
+    getMediacount(): Promise<number>;
+    /** Number of followers */
+    getFollowers(): Promise<number>;
+    /** Number of followees */
+    getFollowees(): Promise<number>;
+    /** External URL in bio */
+    getExternalUrl(): Promise<string | null>;
+    /** Whether this is a business account */
+    getIsBusinessAccount(): Promise<boolean>;
+    /** Business category name */
+    getBusinessCategoryName(): Promise<string | null>;
+    /** Biography (normalized) */
+    getBiography(): Promise<string>;
+    /** Full name */
+    getFullName(): Promise<string>;
+    /** Whether the viewer blocked this profile */
+    get blocked_by_viewer(): boolean;
+    /** Whether this profile follows the viewer */
+    get follows_viewer(): boolean;
+    /** Whether this profile has blocked the viewer */
+    get has_blocked_viewer(): boolean;
+    /** Whether this profile is verified */
+    getIsVerified(): Promise<boolean>;
+    /** Profile picture URL */
+    getProfilePicUrl(): Promise<string>;
+    /**
+     * Helper to check if a post is newer than the current first post.
+     * Used for determining the "first" (newest) post in an iteration.
+     */
+    private static _makeIsNewestChecker;
+    /**
+     * Retrieve all posts from a profile.
+     *
+     * @returns NodeIterator[Post]
+     */
+    getPosts(): NodeIterator<Post>;
+    /**
+     * Get Posts that are marked as saved by the user.
+     *
+     * @returns NodeIterator[Post]
+     * @throws LoginRequiredException if not logged in as the target profile
+     */
+    getSavedPosts(): NodeIterator<Post>;
+    /**
+     * Retrieve all posts where a profile is tagged.
+     *
+     * @returns NodeIterator[Post]
+     */
+    getTaggedPosts(): NodeIterator<Post>;
+    /** Returns Profile as a JSON-serializable object. */
+    toJSON(): JsonObject;
+}
+/**
+ * Structure containing information about a user story item (image or video).
+ *
+ * Created by method Story.get_items(). This class implements equality comparison
+ * and is hashable.
+ */
+declare class StoryItem {
+    private readonly _context;
+    private readonly _node;
+    private _owner_profile;
+    private _iphone_struct_;
+    constructor(context: InstaloaderContext, node: JsonObject, owner_profile?: Profile | null);
+    /**
+     * Create a StoryItem object from a given mediaid.
+     */
+    static fromMediaid(context: InstaloaderContext, mediaid: bigint): Promise<StoryItem>;
+    /** The mediaid is a decimal representation of the media shortcode. */
+    get mediaid(): bigint;
+    /** Convert mediaid to a shortcode-like string. */
+    get shortcode(): string;
+    toString(): string;
+    equals(other: StoryItem): boolean;
+    /** Profile instance of the story item's owner. */
+    getOwnerProfile(): Promise<Profile>;
+    /** The StoryItem owner's lowercase name. */
+    getOwnerUsername(): Promise<string>;
+    /** The ID of the StoryItem owner. */
+    getOwnerId(): Promise<number>;
+    /** Timestamp when the StoryItem was created (local time zone). */
+    get date_local(): Date;
+    /** Timestamp when the StoryItem was created (UTC). */
+    get date_utc(): Date;
+    /** Synonym to date_utc */
+    get date(): Date;
+    /** Timestamp when the StoryItem will get unavailable (local time zone). */
+    get expiring_local(): Date;
+    /** Timestamp when the StoryItem will get unavailable (UTC). */
+    get expiring_utc(): Date;
+    /** URL of the picture / video thumbnail of the StoryItem */
+    get url(): string;
+    /** Type of story item: GraphStoryImage or GraphStoryVideo */
+    get typename(): string;
+    /** Caption. */
+    get caption(): string | null;
+    /** List of all lowercased hashtags in the StoryItem's caption. */
+    get caption_hashtags(): string[];
+    /** List of all lowercased profiles mentioned in the StoryItem's caption. */
+    get caption_mentions(): string[];
+    /** Printable caption. */
+    get pcaption(): string;
+    /** True if the StoryItem is a video. */
+    get is_video(): boolean;
+    /** URL of the video, or null. */
+    get video_url(): string | null;
+    /** Returns StoryItem as a JSON-serializable object. */
+    toJSON(): JsonObject;
+}
+/**
+ * Structure representing a user story with its associated items.
+ *
+ * Provides methods for accessing story properties, as well as getItems()
+ * to request associated StoryItem nodes.
+ *
+ * This class implements equality comparison and is hashable.
+ */
+declare class Story {
+    protected readonly _context: InstaloaderContext;
+    protected readonly _node: JsonObject;
+    protected _unique_id: string | null;
+    protected _owner_profile: Profile | null;
+    protected _iphone_struct_: JsonObject | null;
+    constructor(context: InstaloaderContext, node: JsonObject);
+    toString(): string;
+    equals(other: Story): boolean;
+    /**
+     * This ID only equals amongst Story instances which have the same owner
+     * and the same set of StoryItem.
+     */
+    get unique_id(): string;
+    /** Timestamp of the most recent StoryItem that has been watched or null (local time zone). */
+    get last_seen_local(): Date | null;
+    /** Timestamp of the most recent StoryItem that has been watched or null (UTC). */
+    get last_seen_utc(): Date | null;
+    /** Timestamp when the last item of the story was created (local time zone). */
+    get latest_media_local(): Date;
+    /** Timestamp when the last item of the story was created (UTC). */
+    get latest_media_utc(): Date;
+    /** Count of items associated with the Story instance. */
+    get itemcount(): number;
+    /** Profile instance of the story owner. */
+    get owner_profile(): Profile;
+    /** The story owner's lowercase username. */
+    get owner_username(): string;
+    /** The story owner's ID. */
+    get owner_id(): number;
+    protected _fetchIphoneStruct(): Promise<void>;
+    /** Retrieve all items from a story. */
+    getItems(): AsyncGenerator<StoryItem>;
+}
+/**
+ * Structure representing a user's highlight with its associated story items.
+ *
+ * Extends Story and provides methods for accessing highlight properties.
+ */
+declare class Highlight extends Story {
+    private _items;
+    constructor(context: InstaloaderContext, node: JsonObject, owner?: Profile | null);
+    toString(): string;
+    /** A unique ID identifying this set of highlights. */
+    get unique_id(): string;
+    /** Profile instance of the highlights' owner. */
+    get owner_profile(): Profile;
+    /** The title of these highlights. */
+    get title(): string;
+    /** URL of the highlights' cover. */
+    get cover_url(): string;
+    /** URL of the cropped version of the cover. */
+    get cover_cropped_url(): string;
+    private _fetchItems;
+    protected _fetchIphoneStruct(): Promise<void>;
+    /** Count of items associated with the Highlight instance. */
+    get itemcount(): number;
+    /** Get accurate item count (async). */
+    getItemcount(): Promise<number>;
+    /** Retrieve all associated highlight items. */
+    getItems(): AsyncGenerator<StoryItem>;
+}
+/**
+ * An Instagram Hashtag.
+ *
+ * Provides methods for accessing hashtag properties and retrieving associated posts.
+ * This class implements equality comparison and is hashable.
+ */
+declare class Hashtag {
+    private readonly _context;
+    private _node;
+    private _has_full_metadata;
+    constructor(context: InstaloaderContext, node: JsonObject);
+    /**
+     * Create a Hashtag instance from a given hashtag name, without preceding '#'.
+     */
+    static fromName(context: InstaloaderContext, name: string): Promise<Hashtag>;
+    /** Hashtag name lowercased, without preceding '#' */
+    get name(): string;
+    private _query;
+    private _obtainMetadata;
+    private _metadata;
+    getMetadata(...keys: string[]): Promise<JsonValue>;
+    toString(): string;
+    equals(other: Hashtag): boolean;
+    /** Hashtag ID */
+    getHashtagId(): Promise<number>;
+    /** Profile picture URL of the hashtag */
+    getProfilePicUrl(): Promise<string>;
+    /** Hashtag description */
+    getDescription(): Promise<string | null>;
+    /** Whether following is allowed */
+    getAllowFollowing(): Promise<boolean>;
+    /** Whether the current user is following this hashtag */
+    getIsFollowing(): Promise<boolean>;
+    /** Count of all media associated with this hashtag */
+    getMediacount(): Promise<number>;
+    /** Yields the top posts of the hashtag. */
+    getTopPosts(): AsyncGenerator<Post>;
+    /**
+     * Yields the recent posts associated with this hashtag.
+     *
+     * @deprecated Use getPostsResumable() as this method may return incorrect results.
+     */
+    getPosts(): AsyncGenerator<Post>;
+    /**
+     * Get the recent posts of the hashtag in a resumable fashion.
+     *
+     * @returns NodeIterator[Post]
+     */
+    getPostsResumable(): NodeIterator<Post>;
+    /** Returns Hashtag as a JSON-serializable object. */
+    toJSON(): JsonObject;
+}
+/**
+ * An invocation of this class triggers a search on Instagram for the provided search string.
+ *
+ * Provides methods to access the search results as profiles, locations and hashtags.
+ */
+declare class TopSearchResults {
+    private readonly _context;
+    private readonly _searchstring;
+    private _node;
+    constructor(context: InstaloaderContext, searchstring: string);
+    private _ensureLoaded;
+    /** Provides the Profile instances from the search result. */
+    getProfiles(): AsyncGenerator<Profile>;
+    /** Provides all profile names from the search result that start with the search string. */
+    getPrefixedUsernames(): AsyncGenerator<string>;
+    /** Provides instances of PostLocation from the search result. */
+    getLocations(): AsyncGenerator<PostLocation>;
+    /** Provides the hashtags from the search result as strings. */
+    getHashtagStrings(): AsyncGenerator<string>;
+    /** Provides the hashtags from the search result. */
+    getHashtags(): AsyncGenerator<Hashtag>;
+    /** The string that was searched for on Instagram. */
+    get searchstring(): string;
+}
+/**
+ * Type that can be exported to JSON.
+ */
+type JsonExportable = Post | Profile | StoryItem | Hashtag;
+/**
+ * Returns Instaloader JSON structure for a Post, Profile, StoryItem, or Hashtag
+ * so that it can be loaded by loadStructure.
+ */
+declare function getJsonStructure(structure: JsonExportable): JsonObject;
+/**
+ * Loads a Post, Profile, StoryItem, or Hashtag from a json structure.
+ */
+declare function loadStructure(context: InstaloaderContext, jsonStructure: JsonObject): JsonExportable;
+
+/**
+ * Instaloader - Main class for downloading Instagram content.
+ *
+ * Ported from Python instaloader/instaloader.py
+ */
+
+/**
+ * Options for the Instaloader class.
+ */
+interface InstaloaderOptions {
+    /** Enable sleep between requests (rate limiting) */
+    sleep?: boolean;
+    /** Suppress output messages */
+    quiet?: boolean;
+    /** Custom user agent string */
+    userAgent?: string;
+    /** Directory pattern for downloads, default is "{target}" */
+    dirnamePattern?: string;
+    /** Filename pattern for downloads, default is "{date_utc}_UTC" */
+    filenamePattern?: string;
+    /** Title pattern for profile pics and covers */
+    titlePattern?: string;
+    /** Download pictures, default true */
+    downloadPictures?: boolean;
+    /** Download videos, default true */
+    downloadVideos?: boolean;
+    /** Download video thumbnails, default true */
+    downloadVideoThumbnails?: boolean;
+    /** Download geotags, default false */
+    downloadGeotags?: boolean;
+    /** Download comments, default false */
+    downloadComments?: boolean;
+    /** Save metadata JSON, default true */
+    saveMetadata?: boolean;
+    /** Compress JSON files with xz, default true */
+    compressJson?: boolean;
+    /** Pattern for post metadata txt files */
+    postMetadataTxtPattern?: string;
+    /** Pattern for story item metadata txt files */
+    storyitemMetadataTxtPattern?: string;
+    /** Maximum connection attempts, default 3 */
+    maxConnectionAttempts?: number;
+    /** Request timeout in seconds, default 300 */
+    requestTimeout?: number;
+    /** Custom rate controller factory */
+    rateController?: (context: InstaloaderContext) => RateController;
+    /** Resume file prefix, or null to disable resume */
+    resumePrefix?: string | null;
+    /** Check best-before date of resume files */
+    checkResumeBbd?: boolean;
+    /** Slide range for sidecar downloads (e.g., "1-3", "last") */
+    slide?: string;
+    /** Status codes that should abort the download */
+    fatalStatusCodes?: number[];
+    /** Enable iPhone API support */
+    iphoneSupport?: boolean;
+    /** Sanitize paths for Windows compatibility */
+    sanitizePaths?: boolean;
+}
+/**
+ * Gets the config directory for storing sessions and stamps.
+ */
+declare function getConfigDir(): string;
+/**
+ * Returns the default session filename for a given username.
+ */
+declare function getDefaultSessionFilename(username: string): string;
+/**
+ * Returns the default stamps filename.
+ */
+declare function getDefaultStampsFilename(): string;
+/**
+ * Check if a format string contains a specific key.
+ */
+declare function formatStringContainsKey(formatString: string, key: string): boolean;
+/**
+ * Sanitize a path component for safe filesystem usage.
+ */
+declare function sanitizePath(str: string, forceWindowsPath?: boolean): string;
+/**
+ * Format a filename with item attributes.
+ * Note: This is a simplified synchronous version. Some properties like owner
+ * require async access in the TypeScript version.
+ */
+declare function formatFilename(pattern: string, item: Post | StoryItem | Profile, target?: string, sanitize?: boolean): string;
+/**
+ * Main Instaloader class for downloading Instagram content.
+ *
+ * @example
+ * ```typescript
+ * const L = new Instaloader();
+ *
+ * // Login
+ * await L.login('username', 'password');
+ *
+ * // Download a profile
+ * const profile = await Profile.fromUsername(L.context, 'instagram');
+ * await L.downloadProfile(profile);
+ *
+ * // Save session for later
+ * await L.saveSessionToFile();
+ * ```
+ */
+declare class Instaloader {
+    /** The associated InstaloaderContext for low-level operations */
+    readonly context: InstaloaderContext;
+    readonly dirnamePattern: string;
+    readonly filenamePattern: string;
+    readonly titlePattern: string;
+    readonly downloadPictures: boolean;
+    readonly downloadVideos: boolean;
+    readonly downloadVideoThumbnails: boolean;
+    readonly downloadGeotags: boolean;
+    readonly downloadComments: boolean;
+    readonly saveMetadata: boolean;
+    readonly compressJson: boolean;
+    readonly postMetadataTxtPattern: string;
+    readonly storyitemMetadataTxtPattern: string;
+    readonly resumePrefix: string | null;
+    readonly checkResumeBbd: boolean;
+    readonly sanitizePaths: boolean;
+    readonly slide: string;
+    private slideStart;
+    private slideEnd;
+    constructor(options?: InstaloaderOptions);
+    /**
+     * Close the session and clean up resources.
+     */
+    close(): void;
+    /**
+     * Save session to a dictionary.
+     */
+    saveSession(): Record<string, string>;
+    /**
+     * Load session from a dictionary.
+     */
+    loadSession(username: string, sessionData: Record<string, string>): void;
+    /**
+     * Save session to file.
+     */
+    saveSessionToFile(filename?: string): Promise<void>;
+    /**
+     * Load session from file.
+     */
+    loadSessionFromFile(username: string, filename?: string): Promise<void>;
+    /**
+     * Test if the current session is valid.
+     * Returns the username if logged in, null otherwise.
+     */
+    testLogin(): Promise<string | null>;
+    /**
+     * Login with username and password.
+     */
+    login(user: string, passwd: string): Promise<void>;
+    /**
+     * Complete two-factor authentication.
+     */
+    twoFactorLogin(twoFactorCode: string): Promise<void>;
+    /**
+     * Download a picture or video from a URL.
+     *
+     * @param filename - Base filename (without extension)
+     * @param url - URL to download from
+     * @param mtime - Modification time to set on the file
+     * @param filenameSuffix - Optional suffix to add before extension
+     * @returns True if file was downloaded, false if it already existed
+     */
+    downloadPic(filename: string, url: string, mtime: Date, filenameSuffix?: string): Promise<boolean>;
+    /**
+     * Save metadata JSON for a structure.
+     */
+    saveMetadataJson(filename: string, structure: Post | StoryItem | Profile): Promise<void>;
+    /**
+     * Save caption to a text file.
+     */
+    saveCaption(filename: string, mtime: Date, caption: string): Promise<void>;
+    /**
+     * Download a single post.
+     *
+     * @param post - Post to download
+     * @param target - Target directory name
+     * @returns True if something was downloaded
+     */
+    downloadPost(post: Post, target: string): Promise<boolean>;
+    /**
+     * Download posts from an iterator.
+     *
+     * @param posts - Iterator of posts
+     * @param target - Target directory name
+     * @param options - Download options
+     */
+    downloadPosts(posts: AsyncIterable<Post>, target: string, options?: {
+        fastUpdate?: boolean;
+        postFilter?: (post: Post) => boolean;
+        maxCount?: number;
+        totalCount?: number;
+        ownerProfile?: Profile;
+        possiblyPinned?: number;
+    }): Promise<void>;
+    /**
+     * Download a profile's posts.
+     */
+    downloadProfile(profile: Profile, options?: {
+        fastUpdate?: boolean;
+        postFilter?: (post: Post) => boolean;
+        maxCount?: number;
+        downloadProfilePic?: boolean;
+        downloadStories?: boolean;
+        downloadHighlights?: boolean;
+    }): Promise<void>;
+    /**
+     * Download a profile's profile picture.
+     */
+    downloadProfilePic(profile: Profile): Promise<void>;
+    /**
+     * Download posts for a hashtag.
+     */
+    downloadHashtag(hashtag: Hashtag, options?: {
+        maxCount?: number;
+        postFilter?: (post: Post) => boolean;
+        resumable?: boolean;
+    }): Promise<void>;
+    /**
+     * Get a profile by username.
+     */
+    getProfile(username: string): Promise<Profile>;
+    /**
+     * Get a post by shortcode.
+     */
+    getPost(shortcode: string): Promise<Post>;
+    /**
+     * Get a hashtag by name.
+     */
+    getHashtag(name: string): Promise<Hashtag>;
+}
+
+export { AbortDownloadException, BadCredentialsException, BadResponseException, CheckpointRequiredException, type CommentNode, ConnectionException, type CookieData, type EdgeConnection, type FrozenIteratorState, FrozenNodeIterator, type GraphQLResponse, Hashtag, type HashtagNode, Highlight, type HighlightNode, type HttpHeaders, type IPhoneHeaders, IPhoneSupportDisabledException, Instaloader, InstaloaderContext, type InstaloaderContextOptions, InstaloaderException, type InstaloaderOptions, InvalidArgumentException, InvalidIteratorException, type JsonExportable, type JsonObject, type JsonValue, type LocationNode, LoginException, LoginRequiredException, type LoginResponse, NodeIterator, type NodeIteratorOptions, type PageInfo, type PhoneVerificationSettings, Post, PostChangedException, PostComment, type PostCommentAnswer, type PostLocation, type PostNode, type PostSidecarNode, PrivateProfileNotFollowedException, Profile, ProfileHasNoPicsException, type ProfileNode, ProfileNotExistsException, QueryReturnedBadRequestException, QueryReturnedForbiddenException, QueryReturnedNotFoundException, type QueryTimestamps, RateController, type RequestOptions, type ResponseInfo, type ResumableIterationOptions, type ResumableIterationResult, type SessionData, SessionNotFoundException, Story, StoryItem, type StoryItemNode, NodeIterator as StructureNodeIterator, TooManyRequestsException, TopSearchResults, TwoFactorAuthRequiredException, type TwoFactorInfo, defaultIphoneHeaders, defaultUserAgent, extractHashtags, extractMentions, formatFilename, formatStringContainsKey, getConfigDir, getDefaultSessionFilename, getDefaultStampsFilename, getJsonStructure, loadStructure, mediaidToShortcode, resumableIteration, sanitizePath, shortcodeToMediaid };