app-store-scraper-bun 1.0.0

package/dist/list.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Fetch app lists (top apps, new apps, etc.)
+ */
+import type { App, ListApp, ListOptions } from './types';
+export declare function list(opts?: ListOptions): Promise<App[] | ListApp[]>;

package/dist/privacy.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Fetch app privacy details
+ */
+import type { PrivacyDetails, PrivacyOptions } from './types';
+export declare function privacy(opts: PrivacyOptions): Promise<PrivacyDetails>;

package/dist/ratings.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Fetch app ratings breakdown
+ */
+import type { RatingsOptions, RatingsResult } from './types';
+export declare function ratings(opts: RatingsOptions): Promise<RatingsResult>;

package/dist/reviews.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Fetch app reviews
+ */
+import type { Review, ReviewsOptions } from './types';
+export declare function reviews(opts: ReviewsOptions): Promise<Review[]>;

package/dist/search.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Search for apps in the App Store
+ */
+import type { App, SearchOptions } from './types';
+export declare function search(opts: SearchOptions): Promise<App[] | string[]>;

package/dist/similar.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Fetch similar apps to a given app
+ */
+import type { App, SimilarOptions } from './types';
+export declare function similar(opts: SimilarOptions): Promise<App[]>;

package/dist/suggest.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get search suggestions for a term
+ */
+import type { Suggestion, SuggestOptions } from './types';
+export declare function suggest(opts: SuggestOptions): Promise<Suggestion[]>;

package/dist/types.d.ts

@@ -0,0 +1,327 @@
+/**
+ * App Store Scraper TypeScript Types
+ */
+export type Collection = 'topmacapps' | 'topfreemacapps' | 'topgrossingmacapps' | 'toppaidmacapps' | 'newapplications' | 'newfreeapplications' | 'newpaidapplications' | 'topfreeapplications' | 'topfreeipadapplications' | 'topgrossingapplications' | 'topgrossingipadapplications' | 'toppaidapplications' | 'toppaidipadapplications';
+export type Device = 'iPadSoftware' | 'macSoftware' | 'software';
+export type Sort = 'mostRecent' | 'mostHelpful';
+export type CountryCode = string;
+export type MarketId = number;
+export interface App {
+    id: number | string;
+    appId: string;
+    title: string;
+    url: string;
+    description: string;
+    icon: string;
+    genres: string[];
+    genreIds: string[];
+    primaryGenre: string;
+    primaryGenreId: number;
+    contentRating: string;
+    languages: string[];
+    size: string;
+    requiredOsVersion: string;
+    released: string;
+    updated: string;
+    releaseNotes: string;
+    version: string;
+    price: number | string;
+    currency: string;
+    free: boolean;
+    developerId: number;
+    developer: string;
+    developerUrl: string;
+    developerWebsite?: string;
+    score: number;
+    reviews: number;
+    currentVersionScore: number;
+    currentVersionReviews: number;
+    screenshots: string[];
+    ipadScreenshots: string[];
+    appletvScreenshots: string[];
+    supportedDevices: string[];
+}
+export interface AppWithRatings extends App {
+    ratings: number;
+    histogram: RatingsHistogram;
+}
+export interface ListApp {
+    id: string;
+    appId: string;
+    title: string;
+    icon: string;
+    url: string | undefined;
+    price: number;
+    currency: string;
+    free: boolean;
+    description?: string;
+    developer: string;
+    developerUrl?: string;
+    developerId?: string;
+    genre: string;
+    genreId: string;
+    released: string;
+}
+export interface RatingsHistogram {
+    1: number;
+    2: number;
+    3: number;
+    4: number;
+    5: number;
+}
+export interface RatingsResult {
+    ratings: number;
+    histogram: RatingsHistogram;
+}
+export interface Review {
+    id: string;
+    userName: string;
+    userUrl: string;
+    version: string;
+    score: number;
+    title: string;
+    text: string;
+    url: string;
+    updated: string;
+}
+export interface PrivacyDetails {
+    managePrivacyChoicesUrl: string | null;
+    privacyTypes: PrivacyType[];
+}
+export interface PrivacyType {
+    privacyType: string;
+    identifier: string;
+    description: string;
+    dataCategories: PrivacyDataCategory[];
+    purposes: PrivacyPurpose[];
+}
+export interface PrivacyDataCategory {
+    dataCategory: string;
+    identifier: string;
+    dataTypes: string[];
+}
+export interface PrivacyPurpose {
+    purpose: string;
+    identifier: string;
+    dataCategories: PrivacyDataCategory[];
+}
+export interface VersionHistoryEntry {
+    versionDisplay: string;
+    releaseDate: string;
+    releaseNotes?: string;
+}
+export interface Suggestion {
+    term: string;
+}
+export interface RequestOptions {
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    headers?: Record<string, string>;
+    timeout?: number;
+}
+export interface BaseOptions {
+    country?: string;
+    lang?: string;
+    requestOptions?: RequestOptions;
+    throttle?: number;
+}
+export interface AppOptions extends BaseOptions {
+    id?: number | string;
+    appId?: string;
+    ratings?: boolean;
+}
+export interface ListOptions extends BaseOptions {
+    collection?: Collection;
+    category?: number;
+    num?: number;
+    fullDetail?: boolean;
+}
+export interface SearchOptions extends BaseOptions {
+    term: string;
+    num?: number;
+    page?: number;
+    idsOnly?: boolean;
+}
+export interface DeveloperOptions extends BaseOptions {
+    devId: number | string;
+}
+export interface PrivacyOptions extends BaseOptions {
+    id: number | string;
+}
+export interface SuggestOptions extends BaseOptions {
+    term: string;
+}
+export interface SimilarOptions extends BaseOptions {
+    id?: number | string;
+    appId?: string;
+}
+export interface ReviewsOptions extends BaseOptions {
+    id?: number | string;
+    appId?: string;
+    sort?: Sort;
+    page?: number;
+}
+export interface RatingsOptions extends BaseOptions {
+    id: number | string;
+}
+export interface VersionHistoryOptions extends BaseOptions {
+    id: number | string;
+}
+export interface MemoizedOptions {
+    maxAge?: number;
+    max?: number;
+    primitive?: boolean;
+    normalizer?: (args: unknown[]) => string;
+}
+export interface ITunesLookupResponse {
+    resultCount: number;
+    results: ITunesApp[];
+}
+export interface ITunesApp {
+    trackId: number;
+    bundleId: string;
+    trackName: string;
+    trackViewUrl: string;
+    description: string;
+    artworkUrl512?: string;
+    artworkUrl100?: string;
+    artworkUrl60?: string;
+    genres: string[];
+    genreIds: string[];
+    primaryGenreName: string;
+    primaryGenreId: number;
+    contentAdvisoryRating: string;
+    languageCodesISO2A: string[];
+    fileSizeBytes: string;
+    minimumOsVersion: string;
+    releaseDate: string;
+    currentVersionReleaseDate?: string;
+    releaseNotes: string;
+    version: string;
+    price: number;
+    currency: string;
+    artistId: number;
+    artistName: string;
+    artistViewUrl: string;
+    sellerUrl?: string;
+    averageUserRating: number;
+    userRatingCount: number;
+    averageUserRatingForCurrentVersion: number;
+    userRatingCountForCurrentVersion: number;
+    screenshotUrls: string[];
+    ipadScreenshotUrls: string[];
+    appletvScreenshotUrls: string[];
+    supportedDevices: string[];
+    wrapperType?: string;
+}
+export interface RSSFeedResponse {
+    feed: {
+        entry: RSSFeedEntry[];
+    };
+}
+export interface RSSFeedEntry {
+    id: {
+        label: string;
+        attributes: {
+            'im:id': string;
+            'im:bundleId': string;
+        };
+    };
+    'im:name': {
+        label: string;
+    };
+    'im:image': Array<{
+        label: string;
+    }>;
+    link?: Array<{
+        attributes: {
+            rel: string;
+            href: string;
+        };
+    }> | {
+        attributes: {
+            rel: string;
+            href: string;
+        };
+    };
+    'im:price': {
+        label: string;
+        attributes: {
+            amount: string;
+            currency: string;
+        };
+    };
+    summary?: {
+        label: string;
+    };
+    'im:artist': {
+        label: string;
+        attributes?: {
+            href: string;
+        };
+    };
+    category: {
+        attributes: {
+            label: string;
+            'im:id': string;
+        };
+    };
+    'im:releaseDate': {
+        label: string;
+    };
+}
+export interface SearchResponse {
+    bubbles: Array<{
+        results?: Array<{
+            id: string;
+        }>;
+    }>;
+}
+export interface ReviewsFeedResponse {
+    feed: {
+        entry?: ReviewFeedEntry | ReviewFeedEntry[];
+    };
+}
+export interface ReviewFeedEntry {
+    id: {
+        label: string;
+    };
+    author: {
+        name: {
+            label: string;
+        };
+        uri: {
+            label: string;
+        };
+    };
+    'im:version': {
+        label: string;
+    };
+    'im:rating': {
+        label: string;
+    };
+    title: {
+        label: string;
+    };
+    content: {
+        label: string;
+    };
+    link: {
+        attributes: {
+            href: string;
+        };
+    };
+    updated: {
+        label: string;
+    };
+}
+export interface SuggestXMLResponse {
+    plist: {
+        dict: Array<{
+            array: Array<{
+                dict?: Array<{
+                    string: string[];
+                }>;
+            }>;
+        }>;
+    };
+}

package/dist/version-history.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Fetch app version history
+ */
+import type { VersionHistoryEntry, VersionHistoryOptions } from './types';
+export declare function versionHistory(opts: VersionHistoryOptions): Promise<VersionHistoryEntry[]>;

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "app-store-scraper-bun",
+  "version": "1.0.0",
+  "description": "Modern TypeScript library for scraping Apple App Store data. Fully typed, minimal dependencies, optimized for Bun.",
+  "module": "dist/index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "bun test",
+    "typecheck": "tsc --noEmit",
+    "build": "bun run build:js && bun run build:types",
+    "build:js": "bun build src/index.ts --outdir dist --target node --format esm",
+    "build:types": "tsc -p tsconfig.build.json"
+  },
+  "keywords": [
+    "app-store",
+    "apple",
+    "itunes",
+    "scraper",
+    "typescript",
+    "bun",
+    "ios",
+    "app-store-scraper"
+  ],
+  "author": "rjyo",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rjyo/app-store-scraper-bun.git"
+  },
+  "homepage": "https://github.com/rjyo/app-store-scraper-bun#readme",
+  "bugs": {
+    "url": "https://github.com/rjyo/app-store-scraper-bun/issues"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "cheerio": "^1.0.0"
+  }
+}