image-exporter 1.2.2 → 1.3.0

package/dist/logger.d.ts

@@ -1,11 +1,11 @@
 export declare const log: {
-    info: (...messages: any[]) => Promise<void>;
-    error: (...messages: any[]) => Promise<void>;
-    verbose: (...messages: any[]) => Promise<void>;
+    info: (...messages: unknown[]) => Promise<void>;
+    error: (...messages: unknown[]) => Promise<void>;
+    verbose: (...messages: unknown[]) => Promise<void>;
     progress: (progress: number, total: number) => Promise<void>;
     group: {
-        open: (...messages: any[]) => Promise<void>;
-        close: (...messages: any[]) => Promise<void>;
+        open: (...messages: unknown[]) => Promise<void>;
+        close: (...messages: unknown[]) => Promise<void>;
     };
 };
 type LogType = "info" | "error" | "verbose" | "progress" | "group" | "groupEnd";

package/dist/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,GAAG;wBACM,GAAG,EAAE;yBACJ,GAAG,EAAE;2BACH,GAAG,EAAE;yBACP,MAAM,SAAS,MAAM;;4BAEpB,GAAG,EAAE;6BACJ,GAAG,EAAE;;CAE7B,CAAC;AAwCF,KAAK,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,CAAC;AAEhF,KAAK,GAAG,GAAG;IACT,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,QAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEjC,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,iBAAiB,EAAE,GAAG,EAAE,CAAC;QACzB,qBAAqB,EAAE,QAAQ,EAAE,CAAC;KACnC;CACF"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,GAAG;wBACM,OAAO,EAAE;yBACR,OAAO,EAAE;2BACP,OAAO,EAAE;yBACX,MAAM,SAAS,MAAM;;4BAEpB,OAAO,EAAE;6BACR,OAAO,EAAE;;CAEjC,CAAC;AAyCF,KAAK,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,CAAC;AAEhF,KAAK,GAAG,GAAG;IACT,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,QAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEjC,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,iBAAiB,EAAE,GAAG,EAAE,CAAC;QACzB,qBAAqB,EAAE,QAAQ,EAAE,CAAC;KACnC;CACF"}

package/dist/types.d.ts

@@ -0,0 +1,81 @@
+import type { Options as ModernScreenshotOptions } from "modern-screenshot";
+export interface ImageOptions {
+    /** Label for image. Does not include file extension or scale. */
+    label: Label;
+    /** File format, jpg, png, or svg. */
+    format: Format;
+    /** Scale of image. Can be a number or a comma-separated list of numbers. */
+    scale: Scale;
+    /** Quality of image. 0.0 to 1.0, only applies to jpg.*/
+    quality: Quality;
+    /** Include scale in label. True or false. Automatically true if scale is an array. */
+    includeScaleInLabel: IncludeScaleInLabel;
+}
+export interface Config extends ImageOptions {
+    /** Download images as files upon capture. */
+    downloadImages: boolean;
+    /** Default label for images. Does not include file extension or scale. */
+    defaultImageLabel: string;
+    /** Label for zip file. Does not include file extension or scale. */
+    zipLabel: Label;
+    /** Base URL for CORS proxy used when fetching external images.
+     *
+     * URLs will be encoded and appended without a `?`. Include your own trailing slash.
+     *
+     * I recommend [cors-proxy-worker](https://github.com/briantuckerdesign/cors-proxy-worker) for production and [local-cors-proxy-encoded](https://github.com/briantuckerdesign/local-cors-proxy-encoded) for development.
+     *
+     * Example: `https://cors-proxy.com/` -> `https://cors-proxy.com/https%3A%2F%2FmyEncodedUrl.com`
+     */
+    corsProxyBaseUrl: string;
+    /** Enable window logging for use by external scripts. */
+    enableWindowLogging: boolean;
+    /** Enable verbose logging for debugging. */
+    loggingLevel: LoggingLevel;
+    /**
+     * Called after each capture completes, with the number completed so far and
+     * the total number of captures. A package-friendly alternative to polling
+     * `window.imageExporterProgress`.
+     */
+    onProgress?: (completed: number, total: number) => void;
+    /**
+     * Abort an in-progress capture. When the signal fires, the loop stops and
+     * the images captured so far are returned (download is skipped).
+     */
+    signal?: AbortSignal;
+    /**
+     * Extra options passed through to modern-screenshot (fonts, width/height,
+     * pixelRatio, backgroundColor, etc.). `scale` and `quality` remain controlled
+     * by the per-image options; a `filter` here is combined with the built-in
+     * `data-ignore-capture` filter (both must pass).
+     */
+    screenshotOptions?: Partial<ModernScreenshotOptions>;
+    /**
+     * What the returned images carry:
+     * - `"dataurl"` (default): `dataURL` only
+     * - `"blob"`: `blob` only (no base64 retained — lighter on memory)
+     * - `"both"`: `dataURL` and `blob`
+     *
+     * Downloading works in every mode.
+     */
+    output?: Output;
+}
+export interface ParsedImageOptions extends ImageOptions {
+    /** After parsing, this will always be a number rather than possibly an array. */
+    scale: number;
+}
+export interface Image {
+    /** base64 data URL. Empty when `output` is `"blob"`. */
+    dataURL: string;
+    fileName: string;
+    /** Populated when `config.output` is `"blob"` or `"both"`. */
+    blob?: Blob;
+}
+/** What the returned Image carries. Default `"dataurl"`. */
+export type Output = "dataurl" | "blob" | "both";
+export type Label = string;
+export type Format = "jpg" | "png" | "svg" | "webp";
+export type Scale = number | number[];
+export type Quality = number;
+export type IncludeScaleInLabel = boolean;
+export type LoggingLevel = "none" | "info" | "error" | "verbose";
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5E,MAAM,WAAW,YAAY;IAC3B,iEAAiE;IACjE,KAAK,EAAE,KAAK,CAAC;IACb,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,4EAA4E;IAC5E,KAAK,EAAE,KAAK,CAAC;IACb,wDAAwD;IACxD,OAAO,EAAE,OAAO,CAAC;IACjB,sFAAsF;IACtF,mBAAmB,EAAE,mBAAmB,CAAC;CAC1C;AAED,MAAM,WAAW,MAAO,SAAQ,YAAY;IAC1C,6CAA6C;IAC7C,cAAc,EAAE,OAAO,CAAC;IACxB,0EAA0E;IAC1E,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oEAAoE;IACpE,QAAQ,EAAE,KAAK,CAAC;IAChB;;;;;;;OAOG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,mBAAmB,EAAE,OAAO,CAAC;IAC7B,4CAA4C;IAC5C,YAAY,EAAE,YAAY,CAAC;IAC3B;;;;OAIG;IACH,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACxD;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACrD;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,iFAAiF;IACjF,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,KAAK;IACpB,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,8DAA8D;IAC9D,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,4DAA4D;AAC5D,MAAM,MAAM,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjD,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC;AAC3B,MAAM,MAAM,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;AACpD,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AACtC,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAC1C,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC"}

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "image-exporter",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "Easily download one or more DOM elements as images",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "browser": "./dist/index.browser.js",
+  "unpkg": "./dist/index.browser.js",
+  "jsdelivr": "./dist/index.browser.js",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
@@ -23,6 +25,14 @@
   "scripts": {
     "dev": "bun run --watch src/index.ts",
     "build": "bun run scripts/build.ts",
+    "test": "bun run test:dom && bun run test:node",
+    "test:dom": "bun test --preload ./test/happydom.ts dom.test",
+    "test:node": "bun test node.test",
+    "typecheck": "tsc --noEmit -p tsconfig.test.json",
+    "lint": "eslint .",
+    "format:check": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "release": "bun run build && changeset publish",
     "prepublishOnly": "bun run build"
   },
   "repository": {
@@ -39,18 +49,32 @@
     "gennyflow"
   ],
   "author": "Brian Tucker",
-  "license": "ISC",
+  "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/briantuckerdesign/image-exporter/issues"
   },
   "homepage": "https://github.com/briantuckerdesign/image-exporter#readme",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "dependencies": {
     "jszip": "^3.10.1",
     "modern-screenshot": "^4.6.0"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^0.7.0",
+    "@changesets/cli": "^2.31.0",
+    "@eslint/js": "^10.0.1",
+    "@happy-dom/global-registrator": "^20.10.6",
+    "@types/bun": "^1.3.14",
     "concurrently": "^9.1.2",
+    "eslint": "^10.5.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^17.7.0",
     "http-server": "^14.1.1",
-    "typescript": "^5.7.3"
+    "prettier": "^3.8.4",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.62.0"
   }
 }