@zorilla/playwright-extra 1.0.0

package/dist/helper/loader.d.ts

@@ -0,0 +1,27 @@
+import type * as pw from 'playwright-core';
+/** Node.js module loader helper */
+export declare class Loader<TargetModule> {
+    moduleName: string;
+    packageNames: string[];
+    constructor(moduleName: string, packageNames: string[]);
+    /**
+     * Lazy load a top level export from another module by wrapping it in a JS proxy.
+     *
+     * This allows us to re-export e.g. `devices` from `playwright` while redirecting direct calls
+     * to it to the module version the user has installed, rather than shipping with a hardcoded version.
+     *
+     * If we don't do this and the user doesn't have the target module installed we'd throw immediately when our code is imported.
+     *
+     * We use a "super" Proxy defining all traps, so calls like `Object.keys(playwright.devices).length` will return the correct value.
+     */
+    lazyloadExportOrDie<T extends keyof TargetModule>(exportName: T): TargetModule[T];
+    /** Load the module if possible */
+    loadModule(): TargetModule | undefined;
+    /** Load the module if possible or throw */
+    loadModuleOrDie(): TargetModule;
+    get requireError(): Error;
+}
+export declare function requirePackages<TargetModule = unknown>(packageNames: string[]): TargetModule | undefined;
+/** Playwright specific module loader */
+export declare const playwrightLoader: Loader<typeof pw>;
+//# sourceMappingURL=loader.d.ts.map

package/dist/helper/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../../src/helper/loader.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAI3C,mCAAmC;AACnC,qBAAa,MAAM,CAAC,YAAY;IAErB,UAAU,EAAE,MAAM;IAClB,YAAY,EAAE,MAAM,EAAE;gBADtB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EAAE;IAG/B;;;;;;;;;OASG;IACI,mBAAmB,CAAC,CAAC,SAAS,MAAM,YAAY,EAAE,UAAU,EAAE,CAAC,GAe/B,YAAY,CAAC,CAAC,CAAC;IAGtD,kCAAkC;IAC3B,UAAU;IAIjB,2CAA2C;IACpC,eAAe,IAAI,YAAY;IAQtC,IAAW,YAAY,UAgBtB;CACF;AAED,wBAAgB,eAAe,CAAC,YAAY,GAAG,OAAO,EACpD,YAAY,EAAE,MAAM,EAAE,GACrB,YAAY,GAAG,SAAS,CAO1B;AAED,wCAAwC;AACxC,eAAO,MAAM,gBAAgB,mBAG3B,CAAC"}

package/dist/helper/loader.js

@@ -0,0 +1,77 @@
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+/** Node.js module loader helper */
+export class Loader {
+    moduleName;
+    packageNames;
+    constructor(moduleName, packageNames) {
+        this.moduleName = moduleName;
+        this.packageNames = packageNames;
+    }
+    /**
+     * Lazy load a top level export from another module by wrapping it in a JS proxy.
+     *
+     * This allows us to re-export e.g. `devices` from `playwright` while redirecting direct calls
+     * to it to the module version the user has installed, rather than shipping with a hardcoded version.
+     *
+     * If we don't do this and the user doesn't have the target module installed we'd throw immediately when our code is imported.
+     *
+     * We use a "super" Proxy defining all traps, so calls like `Object.keys(playwright.devices).length` will return the correct value.
+     */
+    lazyloadExportOrDie(exportName) {
+        const trapHandler = Object.fromEntries(Object.getOwnPropertyNames(Reflect).map((name) => [
+            name,
+            (target, ...args) => {
+                const moduleExport = this.loadModuleOrDie()[exportName];
+                const customTarget = moduleExport;
+                const reflectMethod = Reflect[name];
+                const result = reflectMethod(customTarget || target, ...args);
+                return result;
+            },
+        ]));
+        return new Proxy({}, trapHandler);
+    }
+    /** Load the module if possible */
+    loadModule() {
+        return requirePackages(this.packageNames);
+    }
+    /** Load the module if possible or throw */
+    loadModuleOrDie() {
+        const module = requirePackages(this.packageNames);
+        if (module) {
+            return module;
+        }
+        throw this.requireError;
+    }
+    get requireError() {
+        const moduleNamePretty = this.moduleName.charAt(0).toUpperCase() + this.moduleName.slice(1);
+        return new Error(`
+  ${moduleNamePretty} is missing. :-)
+
+  I've tried loading ${this.packageNames
+            .map(p => `"${p}"`)
+            .join(', ')} - no luck.
+
+  Make sure you install one of those packages or use the named 'addExtra' export,
+  to patch a specific (and maybe non-standard) implementation of ${moduleNamePretty}.
+
+  To get the latest stable version of ${moduleNamePretty} run:
+  'npm i ${this.moduleName}'
+  `);
+    }
+}
+export function requirePackages(packageNames) {
+    for (const name of packageNames) {
+        try {
+            return require(name);
+        }
+        catch (_) { }
+    }
+    return undefined;
+}
+/** Playwright specific module loader */
+export const playwrightLoader = new Loader('playwright', [
+    'playwright-core',
+    'playwright',
+]);
+//# sourceMappingURL=loader.js.map

package/dist/helper/loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../../src/helper/loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE/C,mCAAmC;AACnC,MAAM,OAAO,MAAM;IAER;IACA;IAFT,YACS,UAAkB,EAClB,YAAsB;QADtB,eAAU,GAAV,UAAU,CAAQ;QAClB,iBAAY,GAAZ,YAAY,CAAU;IAC5B,CAAC;IAEJ;;;;;;;;;OASG;IACI,mBAAmB,CAA+B,UAAa;QACpE,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,CACpC,MAAM,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC;YACxD,IAAI;YACJ,CAAC,MAAc,EAAE,GAAG,IAAe,EAAE,EAAE;gBACrC,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC,UAAU,CAAC,CAAC;gBACxD,MAAM,YAAY,GAAG,YAAsB,CAAC;gBAC5C,MAAM,aAAa,GAAG,OAAO,CAAC,IAA4B,CAE9C,CAAC;gBACb,MAAM,MAAM,GAAG,aAAa,CAAC,YAAY,IAAI,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;gBAC9D,OAAO,MAAM,CAAC;YAChB,CAAC;SACF,CAAC,CACH,CAAC;QACF,OAAO,IAAI,KAAK,CAAC,EAAE,EAAE,WAAW,CAAoB,CAAC;IACvD,CAAC;IAED,kCAAkC;IAC3B,UAAU;QACf,OAAO,eAAe,CAAe,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1D,CAAC;IAED,2CAA2C;IACpC,eAAe;QACpB,MAAM,MAAM,GAAG,eAAe,CAAe,IAAI,CAAC,YAAY,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAED,IAAW,YAAY;QACrB,MAAM,gBAAgB,GACpB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrE,OAAO,IAAI,KAAK,CAAC;IACjB,gBAAgB;;uBAEG,IAAI,CAAC,YAAY;aACnC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;aAClB,IAAI,CAAC,IAAI,CAAC;;;mEAGoD,gBAAgB;;wCAE3C,gBAAgB;WAC7C,IAAI,CAAC,UAAU;GACvB,CAAC,CAAC;IACH,CAAC;CACF;AAED,MAAM,UAAU,eAAe,CAC7B,YAAsB;IAEtB,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAChC,IAAI,CAAC;YACH,OAAO,OAAO,CAAC,IAAI,CAAiB,CAAC;QACvC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;IAChB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,wCAAwC;AACxC,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,MAAM,CAAY,YAAY,EAAE;IAClE,iBAAiB;IACjB,YAAY;CACb,CAAC,CAAC"}