@synthetixio/synpress-fixtures - npm Package Compare versions

Comparing version 0.0.0-devtest-20231206214259 to 0.0.1-alpha.0

package.json

 {
   "name": "@synthetixio/synpress-fixtures",
-  "version": "0.0.0-devtest-20231206214259",
+  "version": "0.0.1-alpha.0",
   "type": "module",
@@ -17,3 +17,3 @@ "exports": {
   "dependencies": {
-    "@synthetixio/synpress-core": "0.0.0-devtest-20231206214259",
+    "@synthetixio/synpress-core": "0.0.1-alpha.0",
     "@viem/anvil": "^0.0.6",
@@ -24,2 +24,3 @@ "fs-extra": "^11.1.1",
   "devDependencies": {
+    "@synthetixio/synpress-tsconfig": "0.0.1-alpha.0",
     "@types/fs-extra": "^11.0.2",
@@ -29,7 +30,6 @@ "@types/node": "^20.8.0",
     "tsup": "^7.2.0",
-    "typescript": "^5.2.2",
-    "tsconfig": "0.0.0"
+    "typescript": "^5.2.2"
   },
   "peerDependencies": {
-    "@playwright/test": "1.40.0"
+    "@playwright/test": "^1.41.1"
   },
@@ -36,0 +36,0 @@ "scripts": {

src/fixtures/testWithSynpress.ts

@@ -128,2 +128,14 @@ import path from 'node:path'
 
+/**
+ *  The factory function for the `test` fixture from Playwright extended with Synpress fixtures.
+ *
+ * @param walletSetup - An object returned from the `defineWalletSetup` function.
+ * @param walletSetup.hash - Hash of the cached wallet setup function.
+ * @param walletSetup.fn - The wallet setup function itself.
+ * @param walletSetup.walletPassword - The password of the wallet.
+ * @param unlockWallet - A function that unlocks the wallet.
+ * @param slowMo - Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to `0`.
+ *
+ * @returns The `test` fixture from Playwright extended with Synpress fixtures. See: https://playwright.dev/docs/api/class-test#test-call.
+ */
 export const testWithSynpress = (
@@ -130,0 +142,0 @@ walletSetup: ReturnType<typeof defineWalletSetup>,

src/utils/getExtensionId.ts

@@ -11,2 +11,14 @@ import type { BrowserContext } from '@playwright/test'
 
+/**
+ * Returns the extension ID for the given extension name. The ID is fetched from the `chrome://extensions` page.
+ *
+ * ::: tip
+ * This function soon will be removed to improve the developer experience! 😇
+ * :::
+ *
+ * @param context - The browser context.
+ * @param extensionName - The name of the extension, e.g., `MetaMask`.
+ *
+ * @returns The extension ID.
+ */
 export async function getExtensionId(context: BrowserContext, extensionName: string) {
@@ -13,0 +25,0 @@ const page = await context.newPage()

types/fixtures/testWithSynpress.d.ts

@@ -14,4 +14,16 @@ import type { Page, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions } from '@playwright/test';
 };
+/**
+ *  The factory function for the `test` fixture from Playwright extended with Synpress fixtures.
+ *
+ * @param walletSetup - An object returned from the `defineWalletSetup` function.
+ * @param walletSetup.hash - Hash of the cached wallet setup function.
+ * @param walletSetup.fn - The wallet setup function itself.
+ * @param walletSetup.walletPassword - The password of the wallet.
+ * @param unlockWallet - A function that unlocks the wallet.
+ * @param slowMo - Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to `0`.
+ *
+ * @returns The `test` fixture from Playwright extended with Synpress fixtures. See: https://playwright.dev/docs/api/class-test#test-call.
+ */
 export declare const testWithSynpress: (walletSetup: ReturnType<typeof defineWalletSetup>, unlockWallet: UnlockWalletFunction, slowMo?: number) => import("@playwright/test").TestType<PlaywrightTestArgs & PlaywrightTestOptions & PublicSynpressFixtures, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 export {};
 //# sourceMappingURL=testWithSynpress.d.ts.map

types/utils/getExtensionId.d.ts

 import type { BrowserContext } from '@playwright/test';
+/**
+ * Returns the extension ID for the given extension name. The ID is fetched from the `chrome://extensions` page.
+ *
+ * ::: tip
+ * This function soon will be removed to improve the developer experience! 😇
+ * :::
+ *
+ * @param context - The browser context.
+ * @param extensionName - The name of the extension, e.g., `MetaMask`.
+ *
+ * @returns The extension ID.
+ */
 export declare function getExtensionId(context: BrowserContext, extensionName: string): Promise<string>;
 //# sourceMappingURL=getExtensionId.d.ts.map

No alert changes

Improved metrics

Number of low supply chain risk alerts

4

decreased by-42.86%

Worsened metrics

Total package byte prevSize

24883

decreased by-2.09%

Number of package files

12

decreased by-7.69%

Lines of code

298

decreased by-13.87%

Dependency changes

• + Added@playwright/test@1.48.2(transitive)

• + Added@synthetixio/synpress-core@0.0.1-alpha.0(transitive)

• + Addedplaywright@1.48.2(transitive)

• + Addedplaywright-core@1.48.2(transitive)

• + Addedprogress@2.0.3(transitive)

• - Removed@playwright/test@1.40.0(transitive)

• - Removed@synthetixio/synpress-core@0.0.0-devtest-20231206214259(transitive)

• - Removedplaywright@1.40.0(transitive)

• - Removedplaywright-core@1.40.0(transitive)

• Updated@synthetixio/synpress-core@0.0.1-alpha.0