@wdio/globals 8.0.0-alpha.213

package/LICENSE-MIT

@@ -0,0 +1,20 @@
+Copyright (c) OpenJS Foundation and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,22 @@
+WDIO Globals
+============
+
+> A helper utility for importing global variables directly
+
+This package can be used to import global variables explicitly, e.g.
+
+```ts
+import { browser, $, $$, expect } from '@wdio/globals'
+
+describe('my test', () => {
+    // ...
+
+    it('can do something', async () => {
+        // ...
+    })
+
+    // ...
+})
+```
+
+For more information on WebdriverIO Globals, check out the [docs](https://webdriver.io/docs/api/globals).

package/build/index.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="types" />
+declare type SupportedGlobals = 'browser' | 'driver' | 'multiremotebrowser' | '$' | '$$';
+export declare const browser: WebdriverIO.Browser;
+export declare const driver: WebdriverIO.Browser;
+export declare const multiremotebrowser: WebdriverIO.MultiRemoteBrowser;
+export declare const $: WebdriverIO.Browser['$'];
+export declare const $$: WebdriverIO.Browser['$$'];
+/**
+ * allows to set global property to be imported and used later on
+ * @param key global key
+ * @param value actual value to be returned
+ * @private
+ */
+export declare function _setGlobal(key: SupportedGlobals, value: any, setGlobal?: boolean): void;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,aAAK,gBAAgB,GAAG,SAAS,GAAG,QAAQ,GAAG,oBAAoB,GAAG,GAAG,GAAG,IAAI,CAAA;AAiBhF,eAAO,MAAM,OAAO,EAAE,WAAW,CAAC,OAGjC,CAAA;AACD,eAAO,MAAM,MAAM,EAAE,WAAW,CAAC,OAGhC,CAAA;AACD,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC,kBAG5C,CAAA;AACD,eAAO,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,CAKtC,CAAA;AACD,eAAO,MAAM,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAKxC,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAE,GAAG,EAAE,gBAAgB,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,UAAO,QAO9E"}

package/build/index.js

@@ -0,0 +1,44 @@
+/// <reference path="../types.d.ts" />
+const globals = new Map();
+const GLOBALS_ERROR_MESSAGE = 'Don\'t import @wdio/globals outside of the WDIO testrunner context';
+function proxyHandler(key) {
+    return {
+        get: (self, prop) => {
+            if (!globals.has(key)) {
+                throw new Error(GLOBALS_ERROR_MESSAGE);
+            }
+            return globals.get(key)[prop];
+        }
+    };
+}
+export const browser = new Proxy(class Browser {
+}, proxyHandler('browser'));
+export const driver = new Proxy(class Browser {
+}, proxyHandler('driver'));
+export const multiremotebrowser = new Proxy(class Browser {
+}, proxyHandler('multiremotebrowser'));
+export const $ = (...args) => {
+    if (!globals.has('$')) {
+        throw new Error(GLOBALS_ERROR_MESSAGE);
+    }
+    return globals.get('$')(...args);
+};
+export const $$ = (...args) => {
+    if (!globals.has('$$')) {
+        throw new Error(GLOBALS_ERROR_MESSAGE);
+    }
+    return globals.get('$$')(...args);
+};
+/**
+ * allows to set global property to be imported and used later on
+ * @param key global key
+ * @param value actual value to be returned
+ * @private
+ */
+export function _setGlobal(key, value, setGlobal = true) {
+    globals.set(key, value);
+    if (setGlobal) {
+        // @ts-expect-error
+        globalThis[key] = value;
+    }
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@wdio/globals",
+  "version": "8.0.0-alpha.213+c5fb6d57e",
+  "description": "A helper utility for importing global variables directly",
+  "author": "Christian Bromann <mail@bromann.dev>",
+  "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-globals",
+  "license": "MIT",
+  "type": "module",
+  "exports": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "typeScriptVersion": "3.8.3",
+  "engines": {
+    "node": "^16.13 || >=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/webdriverio/webdriverio.git"
+  },
+  "keywords": [
+    "webdriver",
+    "wdio",
+    "wdio-utility"
+  ],
+  "bugs": {
+    "url": "https://github.com/webdriverio/webdriverio/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "webdriverio": "8.0.0-alpha.213+c5fb6d57e"
+  },
+  "gitHead": "c5fb6d57e168d8bf939a5aa5c2ada5abaceec5eb"
+}

package/types.d.ts

@@ -0,0 +1,30 @@
+type BrowserType = import('webdriverio').Browser<'async'>
+type ElementType = import('webdriverio').Element<'async'>
+type MultiRemoteBrowserType = import('webdriverio').MultiRemoteBrowser<'async'>
+
+declare namespace WebdriverIOAsync {
+    interface Browser {}
+    interface Element {}
+    interface MultiRemoteBrowser {}
+}
+
+declare namespace WebdriverIO {
+    interface Browser extends BrowserType, WebdriverIOAsync.Browser { }
+    interface Element extends ElementType, WebdriverIOAsync.Element { }
+    // @ts-expect-error
+    interface MultiRemoteBrowser extends MultiRemoteBrowserType, WebdriverIOAsync.MultiRemoteBrowser { }
+}
+
+declare module NodeJS {
+    interface Global {
+        browser: WebdriverIO.Browser
+        driver: WebdriverIO.Browser
+        multiremotebrowser: WebdriverIO.MultiRemoteBrowser
+    }
+}
+
+declare function $(...args: Parameters<WebdriverIO.Browser['$']>): ReturnType<WebdriverIO.Browser['$']>
+declare function $$(...args: Parameters<WebdriverIO.Browser['$$']>): ReturnType<WebdriverIO.Browser['$$']>
+declare const browser: WebdriverIO.Browser
+declare const driver: WebdriverIO.Browser
+declare const multiremotebrowser: WebdriverIO.MultiRemoteBrowser