@automattic/jetpack-critical-css-gen 1.0.0 → 1.0.2

package/build/css-file-set.d.ts

@@ -0,0 +1,100 @@
+import { BrowserInterface } from './browser-interface.js';
+import { StyleAST } from './style-ast.js';
+import { FilterSpec } from './types.js';
+type CSSFile = {
+    css: string;
+    ast: StyleAST;
+    pages: string[];
+    urls: string[];
+};
+/**
+ * Represents a set of CSS files found on one or more HTML page. Automatically de-duplicates
+ * CSS files by URL and by content, and parses each into an Abstract Syntax Tree. Also tracks
+ * all errors that occur while loading or parsing CSS.
+ */
+export declare class CSSFileSet {
+    private browserInterface;
+    private knownUrls;
+    private cssFiles;
+    private errors;
+    private internalStyles;
+    constructor(browserInterface: BrowserInterface);
+    /**
+     * Add a set of CSS URLs from an HTML page to this set.
+     *
+     * @param {string} page        - URL of the page the CSS URLs were found on.
+     * @param {object} cssIncludes - Included CSS Files. Keyed by URL.
+     */
+    addMultiple(page: string, cssIncludes: {
+        [url: string]: {
+            media: string;
+        };
+    }): Promise<void>;
+    addInternalStyles(page: string, internalStyles: string): Promise<void>;
+    /**
+     * Add a CSS URL from an HTML page to this set.
+     *
+     * @param {string} page     - URL of the page the CSS URL was found on.
+     * @param {string} cssUrl   - The CSS file URL.
+     * @param {object} settings - Additional settings for the CSS file.
+     */
+    add(page: string, cssUrl: string, settings?: {
+        [url: string]: string;
+    }): Promise<void>;
+    /**
+     * Collates an object describing the selectors found in the CSS files in this set, and which
+     * HTML page URLs include them (via CSS files)
+     *
+     * @return {object} - An object with selector text keys, each containing a Set of page URLs (strings)
+     */
+    collateSelectorPages(): {
+        [selector: string]: Set<string>;
+    };
+    /**
+     * Applies filters to the properties or atRules in each AST in this set of CSS files.
+     * Mutates each AST in-place.
+     *
+     * @param {FilterSpec} filters - Object containing property and atRule filter functions.
+     */
+    applyFilters(filters: FilterSpec): void;
+    /**
+     * Returns a new AST which is pruned appropriately for the specified contentWindow, and the
+     * set of selectors that are worth keeping. (i.e.: appear above the fold).
+     *
+     * @param {Set<string>} usefulSelectors - Set of selectors to keep.
+     * @return {StyleAST[]} Array of pruned StyleAST objects.
+     */
+    prunedAsts(usefulSelectors: Set<string>): StyleAST[];
+    /**
+     * Internal method: Store the specified css found at the cssUrl for an HTML page,
+     * de-duplicating CSS files by content along the way.
+     *
+     * @param {string} page   - URL of HTML page this CSS file was found on.
+     * @param {string} cssUrl - URL of the CSS file.
+     * @param {string} css    - Content of the CSS File.
+     */
+    storeCss(page: string, cssUrl: string, css: string): void;
+    /**
+     * Internal method: Add an extra reference to a previously known CSS file found either
+     * on a new HTML page, or at a new URL.
+     *
+     * @param {string} page         - URL of the page this CSS file was found on.
+     * @param {string} cssUrl       - URL of the CSS File.
+     * @param {object} matchingFile - Internal CSS File object.
+     */
+    addExtraReference(page: string, cssUrl: string, matchingFile: CSSFile): void;
+    /**
+     * Stores an error that occurred while fetching or parsing CSS at the given URL.
+     *
+     * @param {string} url - CSS URL that failed to fetch or parse.
+     * @param {Error}  err - Error object describing the problem.
+     */
+    storeError(url: string, err: Error): void;
+    /**
+     * Returns a list of errors that occurred while fetching or parsing these CSS files.
+     *
+     * @return {Error[]} - List of errors that occurred.
+     */
+    getErrors(): Error[];
+}
+export {};

package/build/css-file-set.js

@@ -0,0 +1,210 @@
+import { HttpError, UnknownError, UrlError } from './errors.js';
+import { StyleAST } from './style-ast.js';
+// Maximum number of iterations when pruning unused variables.
+const maxVarPruneIterations = 10;
+/**
+ * Represents a set of CSS files found on one or more HTML page. Automatically de-duplicates
+ * CSS files by URL and by content, and parses each into an Abstract Syntax Tree. Also tracks
+ * all errors that occur while loading or parsing CSS.
+ */
+export class CSSFileSet {
+    constructor(browserInterface) {
+        this.browserInterface = browserInterface;
+        this.internalStyles = {};
+        this.knownUrls = {};
+        this.cssFiles = [];
+        this.errors = [];
+    }
+    /**
+     * Add a set of CSS URLs from an HTML page to this set.
+     *
+     * @param {string} page        - URL of the page the CSS URLs were found on.
+     * @param {object} cssIncludes - Included CSS Files. Keyed by URL.
+     */
+    async addMultiple(page, cssIncludes) {
+        await Promise.all(Object.keys(cssIncludes).map(url => this.add(page, url, cssIncludes[url])));
+    }
+    async addInternalStyles(page, internalStyles) {
+        this.internalStyles[page] = StyleAST.parse(internalStyles);
+    }
+    /**
+     * Add a CSS URL from an HTML page to this set.
+     *
+     * @param {string} page     - URL of the page the CSS URL was found on.
+     * @param {string} cssUrl   - The CSS file URL.
+     * @param {object} settings - Additional settings for the CSS file.
+     */
+    async add(page, cssUrl, settings = {}) {
+        // Add by reference if we already know this file.
+        if (Object.prototype.hasOwnProperty.call(this.knownUrls, cssUrl)) {
+            if (this.knownUrls[cssUrl] instanceof Error) {
+                // We already know this URL failed. Bail early.
+                return;
+            }
+            this.addExtraReference(page, cssUrl, this.knownUrls[cssUrl]);
+            return;
+        }
+        // Try to load this URL.
+        try {
+            const response = await this.browserInterface.fetch(cssUrl, {}, 'css');
+            if (!response.ok) {
+                throw new HttpError({ code: response.status, url: cssUrl });
+            }
+            let css = await response.text();
+            // If there is an implied media query from the css's <link> tag, wrap the CSS in it.
+            if (settings.media) {
+                css = '@media ' + settings.media + ' {\n' + css + '\n}';
+            }
+            this.storeCss(page, cssUrl, css);
+        }
+        catch (err) {
+            let wrappedError = err;
+            // Wrap any unfamiliar fetch errors in an unknown error.
+            if (!(err instanceof UrlError)) {
+                wrappedError = new UnknownError({
+                    url: cssUrl,
+                    message: err.message,
+                });
+            }
+            this.storeError(cssUrl, wrappedError);
+        }
+    }
+    /**
+     * Collates an object describing the selectors found in the CSS files in this set, and which
+     * HTML page URLs include them (via CSS files)
+     *
+     * @return {object} - An object with selector text keys, each containing a Set of page URLs (strings)
+     */
+    collateSelectorPages() {
+        const selectors = {};
+        for (const file of this.cssFiles) {
+            file.ast.forEachSelector(selector => {
+                if (!selectors[selector]) {
+                    selectors[selector] = new Set();
+                }
+                file.pages.forEach(pageUrl => selectors[selector].add(pageUrl));
+            });
+        }
+        return selectors;
+    }
+    /**
+     * Applies filters to the properties or atRules in each AST in this set of CSS files.
+     * Mutates each AST in-place.
+     *
+     * @param {FilterSpec} filters - Object containing property and atRule filter functions.
+     */
+    applyFilters(filters) {
+        for (const file of this.cssFiles) {
+            file.ast.applyFilters(filters);
+        }
+    }
+    /**
+     * Returns a new AST which is pruned appropriately for the specified contentWindow, and the
+     * set of selectors that are worth keeping. (i.e.: appear above the fold).
+     *
+     * @param {Set<string>} usefulSelectors - Set of selectors to keep.
+     * @return {StyleAST[]} Array of pruned StyleAST objects.
+     */
+    prunedAsts(usefulSelectors) {
+        // Perform basic pruning.
+        let asts = this.cssFiles.map(file => {
+            return file.ast.pruned(usefulSelectors);
+        });
+        const internallyUsedVariables = new Set();
+        Object.values(this.internalStyles).reduce((set, ast) => {
+            ast.getUsedVariables().forEach(v => set.add(v));
+            return set;
+        }, internallyUsedVariables);
+        // Repeatedly prune unused variables (up to maxVarPruneIterations), to catch vars which are
+        // only used to define other vars which aren't used.
+        let prevUsedVariables;
+        for (let i = 0; i < maxVarPruneIterations; i++) {
+            // Gather the set of used variables.
+            const usedVariables = asts.reduce((set, ast) => {
+                ast.getUsedVariables().forEach(v => set.add(v));
+                return set;
+            }, new Set());
+            // If the number of used vars hasn't changed since last iteration, stop early.
+            if (prevUsedVariables && prevUsedVariables.size === usedVariables.size) {
+                break;
+            }
+            // Prune unused variables, keep a sum of pruned variables.
+            const prunedCount = asts.reduce((sum, ast) => {
+                sum += ast.pruneUnusedVariables(new Set([...usedVariables, ...internallyUsedVariables]));
+                return sum;
+            }, 0);
+            // If no variables were pruned this iteration, stop early.
+            if (prunedCount === 0) {
+                break;
+            }
+            prevUsedVariables = usedVariables;
+        }
+        // Find all fonts used across all ASTs, and prune all that are not referenced.
+        const fontWhitelist = asts.reduce((set, ast) => {
+            ast.getUsedFontFamilies().forEach(font => set.add(font));
+            return set;
+        }, new Set());
+        // Remove any fonts that aren't used above the fold.
+        asts.forEach(ast => ast.pruneNonCriticalFonts(fontWhitelist));
+        // Throw away any ASTs without rules.
+        asts = asts.filter(ast => ast.ruleCount() > 0);
+        return asts;
+    }
+    /**
+     * Internal method: Store the specified css found at the cssUrl for an HTML page,
+     * de-duplicating CSS files by content along the way.
+     *
+     * @param {string} page   - URL of HTML page this CSS file was found on.
+     * @param {string} cssUrl - URL of the CSS file.
+     * @param {string} css    - Content of the CSS File.
+     */
+    storeCss(page, cssUrl, css) {
+        // De-duplicate css contents in case cache busters in URLs or WAFs, etc confound URL de-duplication.
+        const matchingFile = this.cssFiles.find(file => file.css === css);
+        if (matchingFile) {
+            this.addExtraReference(page, cssUrl, matchingFile);
+            return;
+        }
+        // Parse the CSS into an AST.
+        const ast = StyleAST.parse(css);
+        // Make sure relative URLs in the AST are absolute.
+        ast.absolutifyUrls(cssUrl);
+        const file = { css, ast, pages: [page], urls: [cssUrl] };
+        this.knownUrls[cssUrl] = file;
+        this.cssFiles.push(file);
+    }
+    /**
+     * Internal method: Add an extra reference to a previously known CSS file found either
+     * on a new HTML page, or at a new URL.
+     *
+     * @param {string} page         - URL of the page this CSS file was found on.
+     * @param {string} cssUrl       - URL of the CSS File.
+     * @param {object} matchingFile - Internal CSS File object.
+     */
+    addExtraReference(page, cssUrl, matchingFile) {
+        this.knownUrls[cssUrl] = matchingFile;
+        matchingFile.pages.push(page);
+        if (!matchingFile.urls.includes(cssUrl)) {
+            matchingFile.urls.push(cssUrl);
+        }
+    }
+    /**
+     * Stores an error that occurred while fetching or parsing CSS at the given URL.
+     *
+     * @param {string} url - CSS URL that failed to fetch or parse.
+     * @param {Error}  err - Error object describing the problem.
+     */
+    storeError(url, err) {
+        this.knownUrls[url] = err;
+        this.errors.push(err);
+    }
+    /**
+     * Returns a list of errors that occurred while fetching or parsing these CSS files.
+     *
+     * @return {Error[]} - List of errors that occurred.
+     */
+    getErrors() {
+        return this.errors;
+    }
+}
+//# sourceMappingURL=css-file-set.js.map

package/build/css-file-set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"css-file-set.js","sourceRoot":"","sources":["../src/css-file-set.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG1C,8DAA8D;AAC9D,MAAM,qBAAqB,GAAG,EAAE,CAAC;AASjC;;;;GAIG;AACH,MAAM,OAAO,UAAU;IAMtB,YAAqB,gBAAkC;QAAlC,qBAAgB,GAAhB,gBAAgB,CAAkB;QAF/C,mBAAc,GAAkC,EAAE,CAAC;QAG1D,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAE,IAAY,EAAE,WAAmD;QACnF,MAAM,OAAO,CAAC,GAAG,CAChB,MAAM,CAAC,IAAI,CAAE,WAAW,CAAE,CAAC,GAAG,CAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAE,IAAI,EAAE,GAAG,EAAE,WAAW,CAAE,GAAG,CAAE,CAAE,CAAE,CAClF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAE,IAAY,EAAE,cAAsB;QAC5D,IAAI,CAAC,cAAc,CAAE,IAAI,CAAE,GAAG,QAAQ,CAAC,KAAK,CAAE,cAAc,CAAE,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CACR,IAAY,EACZ,MAAc,EACd,WAAwC,EAAE;QAE1C,iDAAiD;QACjD,IAAK,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAE,IAAI,CAAC,SAAS,EAAE,MAAM,CAAE,EAAG;YACrE,IAAK,IAAI,CAAC,SAAS,CAAE,MAAM,CAAE,YAAY,KAAK,EAAG;gBAChD,+CAA+C;gBAC/C,OAAO;aACP;YAED,IAAI,CAAC,iBAAiB,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAE,MAAM,CAAa,CAAE,CAAC;YAC5E,OAAO;SACP;QAED,wBAAwB;QACxB,IAAI;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAE,MAAM,EAAE,EAAE,EAAE,KAAK,CAAE,CAAC;YACxE,IAAK,CAAE,QAAQ,CAAC,EAAE,EAAG;gBACpB,MAAM,IAAI,SAAS,CAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,CAAE,CAAC;aAC9D;YAED,IAAI,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAEhC,oFAAoF;YACpF,IAAK,QAAQ,CAAC,KAAK,EAAG;gBACrB,GAAG,GAAG,SAAS,GAAG,QAAQ,CAAC,KAAK,GAAG,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC;aACxD;YAED,IAAI,CAAC,QAAQ,CAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAE,CAAC;SACnC;QAAC,OAAQ,GAAG,EAAG;YACf,IAAI,YAAY,GAAG,GAAG,CAAC;YAEvB,wDAAwD;YACxD,IAAK,CAAE,CAAE,GAAG,YAAY,QAAQ,CAAE,EAAG;gBACpC,YAAY,GAAG,IAAI,YAAY,CAAE;oBAChC,GAAG,EAAE,MAAM;oBACX,OAAO,EAAE,GAAG,CAAC,OAAO;iBACpB,CAAE,CAAC;aACJ;YAED,IAAI,CAAC,UAAU,CAAE,MAAM,EAAE,YAAY,CAAE,CAAC;SACxC;IACF,CAAC;IAED;;;;;OAKG;IACH,oBAAoB;QACnB,MAAM,SAAS,GAAG,EAAE,CAAC;QAErB,KAAM,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,EAAG;YACnC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAE,QAAQ,CAAC,EAAE;gBACpC,IAAK,CAAE,SAAS,CAAE,QAAQ,CAAE,EAAG;oBAC9B,SAAS,CAAE,QAAQ,CAAE,GAAG,IAAI,GAAG,EAAE,CAAC;iBAClC;gBAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAE,OAAO,CAAC,EAAE,CAAC,SAAS,CAAE,QAAQ,CAAE,CAAC,GAAG,CAAE,OAAO,CAAE,CAAE,CAAC;YACvE,CAAC,CAAE,CAAC;SACJ;QAED,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAE,OAAmB;QAChC,KAAM,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,EAAG;YACnC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAE,OAAO,CAAE,CAAC;SACjC;IACF,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAE,eAA8B;QACzC,yBAAyB;QACzB,IAAI,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAE,IAAI,CAAC,EAAE;YACpC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAE,eAAe,CAAE,CAAC;QAC3C,CAAC,CAAE,CAAC;QAEJ,MAAM,uBAAuB,GAAG,IAAI,GAAG,EAAY,CAAC;QACpD,MAAM,CAAC,MAAM,CAAE,IAAI,CAAC,cAAc,CAAE,CAAC,MAAM,CAAE,CAAE,GAAG,EAAE,GAAG,EAAG,EAAE;YAC3D,GAAG,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAE,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,CAAE,CAAE,CAAC;YACpD,OAAO,GAAG,CAAC;QACZ,CAAC,EAAE,uBAAuB,CAAE,CAAC;QAE7B,2FAA2F;QAC3F,oDAAoD;QACpD,IAAI,iBAAiB,CAAC;QACtB,KAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,qBAAqB,EAAE,CAAC,EAAE,EAAG;YACjD,oCAAoC;YACpC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAE,CAAE,GAAG,EAAE,GAAG,EAAG,EAAE;gBACjD,GAAG,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAE,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,CAAE,CAAE,CAAC;gBACpD,OAAO,GAAG,CAAC;YACZ,CAAC,EAAE,IAAI,GAAG,EAAY,CAAE,CAAC;YAEzB,8EAA8E;YAC9E,IAAK,iBAAiB,IAAI,iBAAiB,CAAC,IAAI,KAAK,aAAa,CAAC,IAAI,EAAG;gBACzE,MAAM;aACN;YAED,0DAA0D;YAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAE,CAAE,GAAG,EAAE,GAAG,EAAG,EAAE;gBAC/C,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAC9B,IAAI,GAAG,CAAE,CAAE,GAAG,aAAa,EAAE,GAAG,uBAAuB,CAAE,CAAE,CAC3D,CAAC;gBACF,OAAO,GAAG,CAAC;YACZ,CAAC,EAAE,CAAC,CAAE,CAAC;YAEP,0DAA0D;YAC1D,IAAK,WAAW,KAAK,CAAC,EAAG;gBACxB,MAAM;aACN;YAED,iBAAiB,GAAG,aAAa,CAAC;SAClC;QAED,8EAA8E;QAC9E,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAE,CAAE,GAAG,EAAE,GAAG,EAAG,EAAE;YACjD,GAAG,CAAC,mBAAmB,EAAE,CAAC,OAAO,CAAE,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAE,IAAI,CAAE,CAAE,CAAC;YAC7D,OAAO,GAAG,CAAC;QACZ,CAAC,EAAE,IAAI,GAAG,EAAY,CAAE,CAAC;QAEzB,oDAAoD;QACpD,IAAI,CAAC,OAAO,CAAE,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,qBAAqB,CAAE,aAAa,CAAE,CAAE,CAAC;QAElE,qCAAqC;QACrC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAE,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAE,CAAC;QAEjD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAE,IAAY,EAAE,MAAc,EAAE,GAAW;QAClD,oGAAoG;QACpG,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,CAAE,CAAC;QACpE,IAAK,YAAY,EAAG;YACnB,IAAI,CAAC,iBAAiB,CAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAE,CAAC;YACrD,OAAO;SACP;QAED,6BAA6B;QAC7B,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAE,GAAG,CAAE,CAAC;QAElC,mDAAmD;QACnD,GAAG,CAAC,cAAc,CAAE,MAAM,CAAE,CAAC;QAE7B,MAAM,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAE,IAAI,CAAE,EAAE,IAAI,EAAE,CAAE,MAAM,CAAE,EAAE,CAAC;QAC7D,IAAI,CAAC,SAAS,CAAE,MAAM,CAAE,GAAG,IAAI,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAE,IAAI,CAAE,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACH,iBAAiB,CAAE,IAAY,EAAE,MAAc,EAAE,YAAqB;QACrE,IAAI,CAAC,SAAS,CAAE,MAAM,CAAE,GAAG,YAAY,CAAC;QACxC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAE,IAAI,CAAE,CAAC;QAEhC,IAAK,CAAE,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAE,MAAM,CAAE,EAAG;YAC7C,YAAY,CAAC,IAAI,CAAC,IAAI,CAAE,MAAM,CAAE,CAAC;SACjC;IACF,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAE,GAAW,EAAE,GAAU;QAClC,IAAI,CAAC,SAAS,CAAE,GAAG,CAAE,GAAG,GAAG,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAE,GAAG,CAAE,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,SAAS;QACR,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;CACD"}

package/build/errors.d.ts

@@ -0,0 +1,101 @@
+export type MetaType = {
+    [key: string]: string | number;
+};
+export type ErrorSpec = {
+    message: string;
+    type: string;
+    meta: MetaType;
+};
+/**
+ * SuccessTargetError - Indicates that insufficient pages loaded to meet
+ * a specified success target. Contains information about each error that caused
+ * problems and the URLs they affect.
+ */
+export declare class SuccessTargetError extends Error {
+    readonly isSuccessTargetError: boolean;
+    readonly urlErrors: {
+        [url: string]: ErrorSpec;
+    };
+    constructor(urlErrors: {
+        [url: string]: UrlError;
+    });
+}
+/**
+ * Base class for URL specific errors, which can be bundled inside a
+ * SuccessTargetError.
+ */
+export declare class UrlError extends Error {
+    readonly type: string;
+    readonly meta: MetaType;
+    constructor(type: string, meta: MetaType, message: string);
+}
+/**
+ * HttpError - Indicates an HTTP request has failed with a non-2xx status code.
+ */
+export declare class HttpError extends UrlError {
+    constructor({ url, code }: {
+        url: string;
+        code: number;
+    });
+}
+/**
+ * UnknownError - Indicates that fetch() threw an error with its own error string.
+ * Contains a raw (and difficult to translate) error message generated by fetch.
+ */
+export declare class UnknownError extends UrlError {
+    constructor({ url, message }: {
+        url: string;
+        message: string;
+    });
+}
+/**
+ * CrossDomainError - Indicates that a requested URL failed due to CORS / security
+ * limitations imposed by the browser.
+ */
+export declare class CrossDomainError extends UrlError {
+    constructor({ url }: {
+        url: string;
+    });
+}
+/**
+ * LoadTimeoutError - Indicates that an HTTP request failed due to a timeout.
+ */
+export declare class LoadTimeoutError extends UrlError {
+    constructor({ url }: {
+        url: string;
+    });
+}
+/**
+ * RedirectError - Indicates that a requested URL failed due to an HTTP redirection of that url.
+ */
+export declare class RedirectError extends UrlError {
+    constructor({ url, redirectUrl }: {
+        url: string;
+        redirectUrl: string;
+    });
+}
+/**
+ * UrlVerifyError - Indicates that a provided BrowserInterface verifyUrl
+ * callback returned false for a page which was otherwise loaded successfully.
+ */
+export declare class UrlVerifyError extends UrlError {
+    constructor({ url }: {
+        url: string;
+    });
+}
+/**
+ * EmptyCSSError - Indicates that a requested URL does not have any CSS in its external style sheet(s) and therefore Critical CSS could not be generated.
+ */
+export declare class EmptyCSSError extends UrlError {
+    constructor({ url }: {
+        url: string;
+    });
+}
+/**
+ * XFrameDenyError - Indicates that a requested URL failed due to x-frame-options deny configuration
+ */
+export declare class XFrameDenyError extends UrlError {
+    constructor({ url }: {
+        url: any;
+    });
+}

package/build/errors.js

@@ -0,0 +1,103 @@
+/**
+ * SuccessTargetError - Indicates that insufficient pages loaded to meet
+ * a specified success target. Contains information about each error that caused
+ * problems and the URLs they affect.
+ */
+export class SuccessTargetError extends Error {
+    constructor(urlErrors) {
+        super('Insufficient pages loaded to meet success target. Errors:\n' +
+            Object.values(urlErrors)
+                .map(e => e.message)
+                .join('\n'));
+        // Mark this as a SuccessTargetError in an easy way for other code to check.
+        this.isSuccessTargetError = true;
+        // Convert any Error object into reliable {message,type,meta} objects.
+        this.urlErrors = {};
+        for (const [url, errorObject] of Object.entries(urlErrors)) {
+            this.urlErrors[url] = {
+                message: errorObject.message,
+                type: errorObject.type || 'UnknownError',
+                meta: errorObject.meta || {},
+            };
+        }
+    }
+}
+/**
+ * Base class for URL specific errors, which can be bundled inside a
+ * SuccessTargetError.
+ */
+export class UrlError extends Error {
+    constructor(type, meta, message) {
+        super(message);
+        this.type = type;
+        this.meta = meta;
+    }
+}
+/**
+ * HttpError - Indicates an HTTP request has failed with a non-2xx status code.
+ */
+export class HttpError extends UrlError {
+    constructor({ url, code }) {
+        super('HttpError', { url, code }, `HTTP error ${code} on URL ${url}`);
+    }
+}
+/**
+ * UnknownError - Indicates that fetch() threw an error with its own error string.
+ * Contains a raw (and difficult to translate) error message generated by fetch.
+ */
+export class UnknownError extends UrlError {
+    constructor({ url, message }) {
+        super('UnknownError', { url, message }, `Error while loading ${url}: ${message}`);
+    }
+}
+/**
+ * CrossDomainError - Indicates that a requested URL failed due to CORS / security
+ * limitations imposed by the browser.
+ */
+export class CrossDomainError extends UrlError {
+    constructor({ url }) {
+        super('CrossDomainError', { url }, `Failed to fetch cross-domain content at ${url}`);
+    }
+}
+/**
+ * LoadTimeoutError - Indicates that an HTTP request failed due to a timeout.
+ */
+export class LoadTimeoutError extends UrlError {
+    constructor({ url }) {
+        super('LoadTimeoutError', { url }, `Timeout while reading ${url}`);
+    }
+}
+/**
+ * RedirectError - Indicates that a requested URL failed due to an HTTP redirection of that url.
+ */
+export class RedirectError extends UrlError {
+    constructor({ url, redirectUrl }) {
+        super('RedirectError', { url, redirectUrl }, `Failed to process ${url} because it redirects to ${redirectUrl} which cannot be verified`);
+    }
+}
+/**
+ * UrlVerifyError - Indicates that a provided BrowserInterface verifyUrl
+ * callback returned false for a page which was otherwise loaded successfully.
+ */
+export class UrlVerifyError extends UrlError {
+    constructor({ url }) {
+        super('UrlVerifyError', { url }, `Failed to verify page at ${url}`);
+    }
+}
+/**
+ * EmptyCSSError - Indicates that a requested URL does not have any CSS in its external style sheet(s) and therefore Critical CSS could not be generated.
+ */
+export class EmptyCSSError extends UrlError {
+    constructor({ url }) {
+        super('EmptyCSSError', { url }, `The ${url} does not have any CSS in its external style sheet(s).`);
+    }
+}
+/**
+ * XFrameDenyError - Indicates that a requested URL failed due to x-frame-options deny configuration
+ */
+export class XFrameDenyError extends UrlError {
+    constructor({ url }) {
+        super('XFrameDenyError', { url }, `Failed to load ${url} due to the "X-Frame-Options: DENY" header`);
+    }
+}
+//# sourceMappingURL=errors.js.map

package/build/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAUA;;;;GAIG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAI5C,YAAa,SAAwC;QACpD,KAAK,CACJ,6DAA6D;YAC5D,MAAM,CAAC,MAAM,CAAE,SAAS,CAAE;iBACxB,GAAG,CAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAE;iBACrB,IAAI,CAAE,IAAI,CAAE,CACf,CAAC;QAEF,4EAA4E;QAC5E,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QAEjC,sEAAsE;QACtE,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,KAAM,MAAM,CAAE,GAAG,EAAE,WAAW,CAAE,IAAI,MAAM,CAAC,OAAO,CAAE,SAAS,CAAE,EAAG;YACjE,IAAI,CAAC,SAAS,CAAE,GAAG,CAAE,GAAG;gBACvB,OAAO,EAAE,WAAW,CAAC,OAAO;gBAC5B,IAAI,EAAE,WAAW,CAAC,IAAI,IAAI,cAAc;gBACxC,IAAI,EAAE,WAAW,CAAC,IAAI,IAAI,EAAE;aAC5B,CAAC;SACF;IACF,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,KAAK;IAClC,YACiB,IAAY,EACZ,IAAc,EAC9B,OAAe;QAEf,KAAK,CAAE,OAAO,CAAE,CAAC;QAJD,SAAI,GAAJ,IAAI,CAAQ;QACZ,SAAI,GAAJ,IAAI,CAAU;IAI/B,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,QAAQ;IACtC,YAAa,EAAE,GAAG,EAAE,IAAI,EAAiC;QACxD,KAAK,CAAE,WAAW,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,cAAe,IAAK,WAAY,GAAI,EAAE,CAAE,CAAC;IAC7E,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,QAAQ;IACzC,YAAa,EAAE,GAAG,EAAE,OAAO,EAAoC;QAC9D,KAAK,CAAE,cAAc,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,uBAAwB,GAAI,KAAM,OAAQ,EAAE,CAAE,CAAC;IACzF,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,gBAAiB,SAAQ,QAAQ;IAC7C,YAAa,EAAE,GAAG,EAAmB;QACpC,KAAK,CAAE,kBAAkB,EAAE,EAAE,GAAG,EAAE,EAAE,2CAA4C,GAAI,EAAE,CAAE,CAAC;IAC1F,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,QAAQ;IAC7C,YAAa,EAAE,GAAG,EAAmB;QACpC,KAAK,CAAE,kBAAkB,EAAE,EAAE,GAAG,EAAE,EAAE,yBAA0B,GAAI,EAAE,CAAE,CAAC;IACxE,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,QAAQ;IAC1C,YAAa,EAAE,GAAG,EAAE,WAAW,EAAwC;QACtE,KAAK,CACJ,eAAe,EACf,EAAE,GAAG,EAAE,WAAW,EAAE,EACpB,qBAAsB,GAAI,4BAA6B,WAAY,2BAA2B,CAC9F,CAAC;IACH,CAAC;CACD;AAED;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,QAAQ;IAC3C,YAAa,EAAE,GAAG,EAAmB;QACpC,KAAK,CAAE,gBAAgB,EAAE,EAAE,GAAG,EAAE,EAAE,4BAA6B,GAAI,EAAE,CAAE,CAAC;IACzE,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,QAAQ;IAC1C,YAAa,EAAE,GAAG,EAAmB;QACpC,KAAK,CACJ,eAAe,EACf,EAAE,GAAG,EAAE,EACP,OAAQ,GAAI,wDAAwD,CACpE,CAAC;IACH,CAAC;CACD;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,QAAQ;IAC5C,YAAa,EAAE,GAAG,EAAE;QACnB,KAAK,CACJ,iBAAiB,EACjB,EAAE,GAAG,EAAE,EACP,kBAAmB,GAAI,4CAA4C,CACnE,CAAC;IACH,CAAC;CACD"}

package/build/generate-critical-css.d.ts

@@ -0,0 +1,24 @@
+import { BrowserInterface } from './browser-interface.js';
+import { FilterSpec, Viewport } from './types.js';
+/**
+ * Generates critical CSS for the given URLs and viewports.
+ *
+ * @param {object}           root0                  - The options object
+ * @param {BrowserInterface} root0.browserInterface - Interface to interact with the browser
+ * @param {Function}         root0.progressCallback - Optional callback function to report progress
+ * @param {string[]}         root0.urls             - Array of URLs to generate critical CSS for
+ * @param {Viewport[]}       root0.viewports        - Array of viewport sizes to consider
+ * @param {FilterSpec}       root0.filters          - Optional filters to apply to the CSS
+ * @param {number}           root0.successRatio     - Ratio of successful URLs required (default: 1)
+ * @param {number}           root0.maxPages         - Maximum number of pages to process (default: 10)
+ * @return {Promise<[string, Error[]]>} A promise that resolves to an array containing the critical CSS string and an array of errors.
+ */
+export declare function generateCriticalCSS({ browserInterface, progressCallback, urls, viewports, filters, successRatio, maxPages, }: {
+    browserInterface: BrowserInterface;
+    progressCallback?: (step: number, total: number) => void;
+    urls: string[];
+    viewports: Viewport[];
+    filters?: FilterSpec;
+    successRatio?: number;
+    maxPages?: number;
+}): Promise<[string, Error[]]>;