@applitools/dom-snapshot 4.13.7 → 4.13.9

package/dist/types/blob.d.ts

@@ -0,0 +1,63 @@
+export interface BlobResource {
+    type: string;
+    value: ArrayBuffer | Uint8Array | string;
+    compressed?: boolean;
+    dependencies?: string[];
+}
+export interface BlobsObj {
+    [url: string]: BlobResource | {
+        errorStatusCode: number;
+    } | {
+        errorStatusCode?: number;
+        type?: string;
+        value?: ArrayBuffer;
+        dependencies?: string[];
+    };
+}
+export interface BlobResult {
+    url: string;
+    type?: string;
+    value?: ArrayBuffer;
+}
+export interface BlobElement {
+    element: HTMLImageElement | HTMLVideoElement;
+    cdtNode: import('./raw-dom-snapshot').CDTNode;
+    url: string;
+}
+export interface CreateBlobParams {
+    type: string;
+    value: ArrayBuffer | Uint8Array;
+    compress?: boolean;
+    serialize?: boolean;
+}
+export interface BuildCanvasBlobsOptions {
+    log: (message: string, ...args: any[]) => void;
+    compress?: boolean;
+    serialize?: boolean;
+}
+export interface BuildBlobImagesOptions {
+    doc: Document;
+    fetchedBlobs: {
+        [url: string]: any;
+    };
+    log: (message: string, ...args: any[]) => void;
+    compress?: boolean;
+    serialize?: boolean;
+    sessionCache?: {
+        getItem: (key: string) => any;
+        setItem?: (key: string, value: any) => void;
+    };
+}
+export interface BuildBlobVideosOptions {
+    doc: Document;
+    fetchedBlobs: {
+        [url: string]: any;
+    };
+    compress?: boolean;
+    serialize?: boolean;
+    log?: (message: string, ...args: any[]) => void;
+    sessionCache?: {
+        getItem: (key: string) => any;
+        setItem?: (key: string, value: any) => void;
+    };
+}

package/dist/types/browser.d.ts

@@ -0,0 +1,52 @@
+import type { CDTNode } from './raw-dom-snapshot';
+import type { StyleSheetCache } from './css';
+export interface DomNodesToCdtResult {
+    cdt: CDTNode[];
+    docRoots: (Document | ShadowRoot | DocumentFragment)[];
+    canvasElements: import('./elements').CanvasElement[];
+    frames: import('./elements').FrameElement[];
+    inlineFrames: import('./elements').FrameElement[];
+    crossFrames: import('./raw-dom-snapshot').CrossFrame[];
+    linkUrls: string[];
+    imageBlobs: import('./elements').ImageBlob[];
+    videoBlobs: import('./elements').VideoBlob[];
+}
+export interface ExtractResourcesConfig {
+    styleSheetCache: StyleSheetCache;
+    removeReverseProxyURLPrefixes?: boolean;
+}
+export interface FindStyleSheetByUrlOptions {
+    styleSheetCache: StyleSheetCache;
+}
+export interface CorsFreeStyleSheetResult {
+    corsFreeStyleSheet: CSSStyleSheet;
+    cleanStyleSheet: () => void;
+}
+export interface ExtractSvgConfig {
+    extractResourceUrlsFromStyleTags: (document: Document) => string[];
+}
+export interface MediaQueryNode {
+    type: 'media-query';
+    name: string;
+    value: string;
+}
+export interface GetUrlFromCssTextOptions {
+    cssText: string;
+    baseUrl: string;
+}
+export interface SessionCacheParams {
+    log: (message?: any, ...optionalParams: any[]) => void;
+    sessionStorage?: Storage;
+}
+export interface SessionCache {
+    getItem: (key: string) => any;
+    setItem: (key: string, value: any) => void;
+    keys: () => string[];
+    persist: () => void;
+}
+export interface PollResult {
+    status: string;
+    value?: string;
+    error?: string;
+    done?: boolean;
+}

package/dist/types/css.d.ts

@@ -0,0 +1,16 @@
+export interface RuleProps {
+    atrule?: string;
+    prelude?: string;
+    block?: string;
+}
+export interface StyleSheetCache {
+    [url: string]: CSSStyleSheet;
+}
+export interface CSSMediaQueryNode {
+    type: string;
+    modifier?: string;
+    name?: string;
+    mediaType?: string;
+    condition?: CSSMediaQueryNode;
+    children?: CSSMediaQueryNode[];
+}

package/dist/types/elements.d.ts

@@ -0,0 +1,19 @@
+import type { CDTNode } from './raw-dom-snapshot';
+export interface CanvasElement {
+    url: string;
+    element: HTMLCanvasElement;
+    cdtNode: CDTNode;
+}
+export interface FrameElement {
+    element: HTMLIFrameElement;
+    url: string;
+}
+export interface ImageBlob {
+    element: HTMLImageElement;
+    url: string;
+    cdtNode: CDTNode;
+}
+export interface VideoBlob {
+    element: HTMLVideoElement;
+    url: string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export type { CDTAttribute, CDTNode, CrossFrame, Blob } from './raw-dom-snapshot';
+export type { BlobResource, BlobsObj, BlobResult, BlobElement, CreateBlobParams, BuildCanvasBlobsOptions, BuildBlobImagesOptions, BuildBlobVideosOptions } from './blob';
+export type { CanvasElement, FrameElement, ImageBlob, VideoBlob } from './elements';
+export type { ResourceUrlsAndBlobs, FetchUrlResult, FetchUrlError, ProcessResourceResult, FetchUrlOptions, ProcessResourceOptions, ProcessResourceParams, GetResourceUrlsAndBlobsParams, GetResourceUrlsAndBlobsResult, ProcessResourceFunction, GetResourceUrlsAndBlobsFunction, AggregateFunction, MakeGetResourceUrlsAndBlobsOptions } from './resources';
+export type { SafeSelector } from './selectors';
+export type { RuleProps, StyleSheetCache, CSSMediaQueryNode } from './css';
+export type { DomNodesToCdtResult, ExtractResourcesConfig, FindStyleSheetByUrlOptions, CorsFreeStyleSheetResult, ExtractSvgConfig, MediaQueryNode, GetUrlFromCssTextOptions, SessionCacheParams, SessionCache, PollResult } from './browser';

package/dist/types/raw-dom-snapshot.d.ts

@@ -0,0 +1,37 @@
+export interface CDTAttribute {
+    name: string;
+    value: string;
+}
+export interface CDTNode {
+    nodeType: number;
+    nodeName?: string;
+    attributes?: CDTAttribute[];
+    childNodeIndexes?: number[] | null;
+    nodeValue?: string;
+    shadowRootIndex?: number;
+    exp_adoptedStyleSheets?: string[];
+}
+export interface CrossFrame {
+    selector: string;
+    index: number;
+}
+export interface Blob {
+    url: string;
+    value?: string;
+    type?: string;
+    errorStatusCode?: number;
+}
+export interface RawDomSnapshot {
+    url: string;
+    selector?: string;
+    cdt: CDTNode[];
+    crossFrames?: CrossFrame[];
+    frames: RawDomSnapshot[];
+    resourceUrls: string[];
+    blobs: Blob[];
+    srcAttr?: string;
+    baseUri?: string;
+    scriptVersion?: string;
+    safeSelectors?: string[];
+    warnings?: string[];
+}

package/dist/types/resources.d.ts

@@ -0,0 +1,92 @@
+import type { BlobsObj } from './blob';
+export interface ResourceUrlsAndBlobs {
+    resourceUrls: string[];
+    blobsObj: BlobsObj;
+}
+export interface FetchUrlResult {
+    url: string;
+    value?: ArrayBuffer;
+    type?: string;
+    probablyCORS?: boolean;
+    errorStatusCode?: number;
+    isTimeout?: boolean;
+}
+export interface FetchUrlError extends Error {
+    isTimeout: boolean;
+}
+export interface ProcessResourceResult {
+    resourceUrls?: string[];
+    blobsObj?: BlobsObj;
+}
+export interface FetchUrlOptions {
+    fetch?: typeof window.fetch;
+    AbortController?: typeof window.AbortController;
+    timeout?: number;
+    mediaDownloadTimeout?: number;
+}
+export interface ProcessResourceOptions {
+    fetchUrl: (url: string) => Promise<FetchUrlResult>;
+    findStyleSheetByUrl: (url: string, documents: Document[]) => CSSStyleSheet | null;
+    getCorsFreeStyleSheet: (value: ArrayBuffer, styleSheet?: CSSStyleSheet | null) => {
+        corsFreeStyleSheet: CSSStyleSheet;
+        cleanStyleSheet: () => void;
+    };
+    extractResourcesFromStyleSheet: (styleSheet: CSSStyleSheet) => string[];
+    extractResourcesFromSvg: (value: ArrayBuffer) => string[];
+    sessionCache?: {
+        getItem: (key: string) => string[];
+        setItem: (key: string, value: string[]) => void;
+        keys: () => string[];
+        persist?: () => void;
+    };
+    cache?: {
+        [url: string]: Promise<ProcessResourceResult>;
+    };
+    compress?: boolean;
+    serialize?: boolean;
+    log?: (message: string, ...args: any[]) => void;
+}
+export interface ProcessResourceParams {
+    url: string;
+    documents: Document[];
+    getResourceUrlsAndBlobs: (params: {
+        documents: Document[];
+        urls: string[];
+        forceCreateStyle?: boolean;
+        skipResources?: string[];
+    }) => Promise<{
+        resourceUrls: string[];
+        blobsObj: BlobsObj;
+    }>;
+    forceCreateStyle?: boolean;
+    skipResources?: string[];
+}
+export interface GetResourceUrlsAndBlobsParams {
+    documents: Document[];
+    urls: string[];
+    forceCreateStyle?: boolean;
+    skipResources?: string[];
+}
+export interface GetResourceUrlsAndBlobsResult {
+    resourceUrls: string[];
+    blobsObj: BlobsObj;
+}
+export interface ProcessResourceFunction {
+    (params: {
+        url: string;
+        documents: Document[];
+        getResourceUrlsAndBlobs: GetResourceUrlsAndBlobsFunction;
+        forceCreateStyle?: boolean;
+        skipResources?: string[];
+    }): Promise<ProcessResourceResult>;
+}
+export interface GetResourceUrlsAndBlobsFunction {
+    (params: GetResourceUrlsAndBlobsParams): Promise<GetResourceUrlsAndBlobsResult>;
+}
+export interface AggregateFunction {
+    (resourceUrlsAndBlobsArr: ProcessResourceResult[]): GetResourceUrlsAndBlobsResult;
+}
+export interface MakeGetResourceUrlsAndBlobsOptions {
+    processResource: ProcessResourceFunction;
+    aggregateResourceUrlsAndBlobs: AggregateFunction;
+}

package/dist/types/selectors.d.ts

@@ -0,0 +1,6 @@
+export interface SafeSelector {
+    type: string;
+    selector: string;
+    shadow?: SafeSelector;
+    error?: any;
+}

package/index.js

@@ -15,4 +15,4 @@ module.exports = {
   processPagePoll: require('./dist/processPagePollCjs'),
   //eslint-disable-next-line
   pollResult: require('./dist/pollResultCjs'),
-}
+}

package/package.json

@@ -1,24 +1,36 @@
 {
   "name": "@applitools/dom-snapshot",
-  "version": "4.13.7",
+  "version": "4.13.9",
   "homepage": "https://applitools.com",
   "license": "SEE LICENSE IN LICENSE",
   "author": {
     "name": "Applitools Team",
     "email": "team@applitools.com"
   },
-  "main": "index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./index.js",
+    "./dist/processPagePollCjs": {
+      "types": "./dist/processPagePollCjs.d.ts",
+      "default": "./dist/processPagePollCjs.js"
+    },
+    "./dist/pollResultCjs": {
+      "types": "./dist/pollResultCjs.d.ts",
+      "default": "./dist/pollResultCjs.js"
+    }
+  },
   "files": [
     "dist",
-    "src/getScript.js"
+    "src/getScript.js",
+    "index.js"
   ],
   "scripts": {
-    "lint": "run --top-level eslint '**/*.js'",
+    "lint": "run --top-level eslint '**/*.{js,ts}'",
     "build": "rollup -c src/build/rollup.config.js",
     "build:pretty": "APPLITOOLS_BUILD_MODE=pretty rollup -c src/build/rollup.config.js",
     "build:watch": "yarn build --watch",
     "test": "run test:mocha && run test:testcafe",
-    "test:mocha": "run --top-level mocha './test/**/*.test.js'",
+    "test:mocha": "run --top-level mocha './test/**/*.test.{js,ts}'",
     "test:testcafe": "testcafe chrome:headless test/testcafe/*.testcafe.js",
     "surge": "surge test/fixtures applitools-dom-snapshot.surge.sh"
   },
@@ -32,6 +44,7 @@
     "@applitools/monitoring-commons": "^1.0.19",
     "@applitools/snippets": "2.7.0",
     "@applitools/spec-driver-puppeteer": "1.6.5",
+    "@applitools/spec-driver-webdriver": "1.4.5",
     "@applitools/test-server": "^1.3.3",
     "@applitools/test-utils": "^1.5.17",
     "@babel/core": "^7.26.0",
@@ -42,6 +55,9 @@
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-replace": "^5.0.4",
     "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^24.3.0",
     "@types/pixelmatch": "^5.2.4",
     "abort-controller": "^3.0.0",
     "chai": "^4.2.0",
@@ -59,6 +75,7 @@
     "rollup-plugin-polyfill": "^4.2.0",
     "selenium-webdriver": "^4.15.0",
     "testcafe": "^1.18.1",
+    "typescript": "^5.9.2",
     "whatwg-fetch": "^3.0.0"
   },
   "engines": {

package/src/getScript.js

@@ -8,4 +8,4 @@ const makeGetScript = filename =>
     return await p(fs.readFile)(__dirname + `/../dist/${filename}.js`, 'utf-8')
   })
 
-module.exports = makeGetScript
+module.exports = makeGetScript