@chilfish/gallery-dl-instagram 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,187 @@
+import { A as Extractor, B as HttpResponse, C as InstagramUser, D as ParserConfig, E as ParsedPost, F as Config, G as RequestConfig, H as MessageIter, I as ConfigValue, K as Storage, L as DirectoryMsg, M as Logger, N as noopLogger, O as TaggedUser, P as ConfigManager, R as ExtractorClass, S as InstagramPost, T as ParsedMedia, U as Metadata, V as Message, W as QueueMsg, _ as InstagramRestAPI, a as InstagramHighlightsExtractor, b as InstagramCarouselItem, c as InstagramPostsExtractor, d as InstagramStoriesExtractor, f as InstagramTagExtractor, g as InstagramExtractorOptions, h as InstagramExtractor, i as InstagramAvatarExtractor, j as ExtractorOptions, k as VideoVersion, l as InstagramReelsExtractor, m as InstagramUserExtractor, n as InstagramSDK, o as InstagramInfoExtractor, p as InstagramTaggedExtractor, q as UrlMsg, r as SDKOptions, s as InstagramPostExtractor, t as ExtractOptions, u as InstagramSavedExtractor, v as Coauthor, w as MusicSticker, x as InstagramLocation, y as ImageCandidate, z as HttpClient } from "./sdk-B9fRyc1e.mjs";
+
+//#region core/job.d.ts
+declare abstract class Job {
+  readonly extractor: Extractor;
+  status: number;
+  constructor(extractor: Extractor);
+  /**
+   * Main entry point.  Calls ``extractor[Symbol.asyncIterator]()`` and
+   * dispatches every yielded message.
+   */
+  run(): Promise<number>;
+  /** Override in subclasses to print a summary. */
+  protected _report(): void;
+  abstract handleDirectory(msg: DirectoryMsg): Promise<void>;
+  abstract handleUrl(msg: UrlMsg): Promise<void>;
+  abstract handleQueue(msg: QueueMsg): Promise<void>;
+}
+/** An in-memory archive: category → Set<archive-key>. */
+type ArchiveMap = Map<string, Set<string>>;
+declare class DownloadJob extends Job {
+  /** Base output directory (prepended to all paths). */
+  basePath: string;
+  /** Current target directory metadata (set by directory messages). */
+  private _currentDir;
+  /** In-memory archive keyed by archive format. */
+  readonly archive: ArchiveMap;
+  /**
+   * Registry of per-category "archive formats" — the key is formed
+   * by interpolating this format string over the metadata.
+   */
+  private readonly _archiveFmts;
+  private _postCount;
+  private _fileCount;
+  private _downloadedBytes;
+  private _skippedCount;
+  registerArchive(category: string, format: string): void;
+  /** Simple format-string interpolation for archive keys. */
+  private _interp;
+  /** Check whether this URL has already been downloaded (and skip). */
+  private _isArchived;
+  /** Mark a post/media as archived. */
+  private _archive;
+  /** Handlers */
+  handleDirectory(msg: DirectoryMsg): Promise<void>;
+  handleUrl(msg: UrlMsg): Promise<void>;
+  handleQueue(msg: QueueMsg): Promise<void>;
+  /** Report */
+  protected _report(): void;
+  /** Path builders */
+  private _buildDirPath;
+  private _buildFilename;
+}
+declare class PrintJob extends Job {
+  private _currentDir;
+  private _files;
+  private _postCount;
+  private _fileCount;
+  private _width;
+  constructor(extractor: Extractor);
+  handleDirectory(msg: DirectoryMsg): Promise<void>;
+  handleUrl(msg: UrlMsg): Promise<void>;
+  handleQueue(msg: QueueMsg): Promise<void>;
+  /** Output */
+  private _flushPost;
+  private _wrap;
+  protected _report(): void;
+}
+//#endregion
+//#region instagram/parsers.d.ts
+/** Main entry — REST */
+declare function parsePostRest(post: InstagramPost, cfg: ParserConfig): ParsedPost;
+/** Tagged users */
+declare function extractTaggedUsers(src: Record<string, unknown>, dest: ParsedMedia): void;
+/** Audio / music extraction */
+declare function extractAudio(src: Record<string, unknown>, dest: Record<string, unknown>, sticker: MusicSticker, cfg: ParserConfig): ParsedMedia | null;
+/** GraphQL parser */
+declare function parsePostGraphql(post: Record<string, unknown>, cfg: ParserConfig): ParsedPost;
+//#endregion
+//#region message.d.ts
+declare function directory(metadata?: Metadata): DirectoryMsg;
+declare function url(u: string, metadata?: Metadata): UrlMsg;
+declare function queue(u: string, metadata?: Metadata & {
+  _extractor?: ExtractorClass;
+}): QueueMsg;
+//#endregion
+//#region utils/id-codec.d.ts
+/**
+ * Instagram-style Base64-variant ID ↔ shortcode conversion.
+ */
+/**
+ * Decode an Instagram shortcode into its numeric post ID.
+ */
+declare function idFromShortcode(shortcode: string): string;
+/**
+ * Encode a numeric post ID into an Instagram shortcode.
+ */
+declare function shortcodeFromId(postId: string | number): string;
+//#endregion
+//#region utils/text.d.ts
+/**
+ * Text utilities ported from gallery-dl's ``text`` module.
+ *
+ * All functions are pure and environment-agnostic.
+ */
+/** String extraction */
+/**
+ * Extract the substring between ``begin`` and ``end`` from ``txt``.
+ * Returns the substring or ``null`` if either delimiter is missing.
+ */
+declare function extract(txt: string, begin: string, end: string): string | null;
+/**
+ * Shorthand: same as ``extract`` but returns ``default_`` on failure.
+ * Mirrors the Python ``extr()`` function.
+ */
+declare function extr(txt: string, begin: string, end: string, default_?: string): string;
+/** Unicode / HTML */
+/**
+ * Decode ``\\uXXXX`` escape sequences in a string.
+ */
+declare function parseUnicodeEscapes(text: string): string;
+declare function unescape(text: string): string;
+/** URL helpers */
+/**
+ * URL-decode a string.
+ */
+declare function unquote(text: string): string;
+/**
+ * Ensure a URL starts with ``https://`` (or ``http://``).
+ */
+declare function ensureHttpScheme(url: string, scheme?: string): string;
+/**
+ * Extract filename + extension from a URL and write into ``meta``.
+ */
+declare function nameExtFromURL(url: string, meta: Record<string, unknown>): void;
+/**
+ * Parse an integer from a possibly-null value. Returns ``default_`` on failure.
+ */
+declare function parseInt(value: string | number | null | undefined, default_?: number): number;
+/** Pre-configured hashtag regex. */
+declare const findTags: (text: string) => string[];
+//#endregion
+//#region index.d.ts
+/** Options for the Node.js convenience factory. */
+interface CreateSDKOptions {
+  /**
+   * Full browser Cookie header string.
+   * Copy from DevTools → Network → Request Headers → Cookie.
+   * Auto-extracts csrftoken for X-CSRFToken header.
+   *
+   * Either ``cookies`` or ``http`` must be provided.
+   */
+  cookies?: string;
+  /**
+   * Custom HttpClient implementation.
+   * If omitted, a Node.js axios-based client is created from ``cookies``.
+   */
+  http?: HttpClient;
+  /**
+   * Custom Storage implementation for file output.
+   * Defaults to Node.js fs/promises-based storage.
+   */
+  storage?: Storage;
+  /**
+   * Logger instance.  Defaults to a silent no-op logger.
+   */
+  log?: Logger;
+}
+/**
+ * Create an SDK instance with Node.js defaults.
+ *
+ * When ``cookies`` is provided, auto-creates an axios-based HttpClient
+ * with CSRF token extraction.  Pass ``http`` directly for custom adapters.
+ *
+ * ```ts
+ * import { createSDK } from '@chilfish/gallery-dl-instagram'
+ *
+ * // Node.js with cookies
+ * const ig = await createSDK({ cookies: 'ds_user_id=...; sessionid=...' })
+ *
+ * // Custom http adapter (browser / Deno / Edge)
+ * const ig = await createSDK({ http: myHttpClient, storage: myStorage })
+ * ```
+ */
+declare function createSDK(opts?: CreateSDKOptions): Promise<InstagramSDK>;
+//#endregion
+export { type Coauthor, type Config, ConfigManager, type ConfigValue, CreateSDKOptions, type DirectoryMsg, DownloadJob, type ExtractOptions, Extractor, type ExtractorClass, type ExtractorOptions, type HttpClient, type HttpResponse, type ImageCandidate, InstagramAvatarExtractor, type InstagramCarouselItem, InstagramExtractor, type InstagramExtractorOptions, InstagramHighlightsExtractor, InstagramInfoExtractor, type InstagramLocation, type InstagramPost, InstagramPostExtractor, InstagramPostsExtractor, InstagramReelsExtractor, InstagramRestAPI, InstagramSDK, InstagramSavedExtractor, InstagramStoriesExtractor, InstagramTagExtractor, InstagramTaggedExtractor, type InstagramUser, InstagramUserExtractor, Job, type Logger, type Message, type MessageIter, type Metadata, type ParsedMedia, type ParsedPost, type ParserConfig, PrintJob, type QueueMsg, type RequestConfig, type SDKOptions, type Storage, type TaggedUser, type UrlMsg, type VideoVersion, createSDK, directory, ensureHttpScheme, extr, extract, extractAudio, extractTaggedUsers, findTags, idFromShortcode, nameExtFromURL, noopLogger, parseInt, parsePostGraphql, parsePostRest, parseUnicodeEscapes, queue, shortcodeFromId, unescape, unquote, url };

package/dist/index.mjs

@@ -0,0 +1,40 @@
+import { a as extractCsrfFromCookies, r as createStorage, t as createHttpClient } from "./adapter-Bt86eL1R.mjs";
+import { A as idFromShortcode, C as parseUnicodeEscapes, D as queue, E as directory, F as ConfigManager, I as Extractor, L as noopLogger, M as DownloadJob, N as Job, O as url, P as PrintJob, S as parseInt, T as unquote, _ as ensureHttpScheme, a as InstagramPostsExtractor, b as findTags, c as InstagramStoriesExtractor, d as InstagramUserExtractor, f as InstagramExtractor, g as parsePostRest, h as parsePostGraphql, i as InstagramPostExtractor, j as shortcodeFromId, k as InstagramRestAPI, l as InstagramTagExtractor, m as extractTaggedUsers, n as InstagramHighlightsExtractor, o as InstagramReelsExtractor, p as extractAudio, r as InstagramInfoExtractor, s as InstagramSavedExtractor, t as InstagramAvatarExtractor, u as InstagramTaggedExtractor, v as extr, w as unescape, x as nameExtFromURL, y as extract } from "./extractors-Byw-2lPL.mjs";
+import { InstagramSDK } from "./sdk.mjs";
+//#region index.ts
+/**
+* Create an SDK instance with Node.js defaults.
+*
+* When ``cookies`` is provided, auto-creates an axios-based HttpClient
+* with CSRF token extraction.  Pass ``http`` directly for custom adapters.
+*
+* ```ts
+* import { createSDK } from '@chilfish/gallery-dl-instagram'
+*
+* // Node.js with cookies
+* const ig = await createSDK({ cookies: 'ds_user_id=...; sessionid=...' })
+*
+* // Custom http adapter (browser / Deno / Edge)
+* const ig = await createSDK({ http: myHttpClient, storage: myStorage })
+* ```
+*/
+async function createSDK(opts = {}) {
+	const { InstagramSDK } = await import("./sdk.mjs");
+	const log = opts.log ?? noopLogger;
+	const storage = opts.storage ?? createStorage();
+	let http;
+	let csrfToken = "";
+	if (opts.http) http = opts.http;
+	else if (opts.cookies) {
+		csrfToken = extractCsrfFromCookies(opts.cookies);
+		http = createHttpClient(void 0, opts.cookies, log);
+	} else throw new Error("Either \"cookies\" or \"http\" must be provided. Get cookies from browser DevTools → Application → Cookies → instagram.com");
+	return new InstagramSDK({
+		http,
+		storage,
+		log,
+		csrfToken
+	});
+}
+//#endregion
+export { ConfigManager, DownloadJob, Extractor, InstagramAvatarExtractor, InstagramExtractor, InstagramHighlightsExtractor, InstagramInfoExtractor, InstagramPostExtractor, InstagramPostsExtractor, InstagramReelsExtractor, InstagramRestAPI, InstagramSDK, InstagramSavedExtractor, InstagramStoriesExtractor, InstagramTagExtractor, InstagramTaggedExtractor, InstagramUserExtractor, Job, PrintJob, createSDK, directory, ensureHttpScheme, extr, extract, extractAudio, extractTaggedUsers, findTags, idFromShortcode, nameExtFromURL, noopLogger, parseInt, parsePostGraphql, parsePostRest, parseUnicodeEscapes, queue, shortcodeFromId, unescape, unquote, url };