@empiricalrun/playwright-utils 0.16.2 → 0.17.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @empiricalrun/playwright-utils
 
+## 0.17.0
+
+### Minor Changes
+
+- 9f0a413: feat: auth store can extract cookies/localstorage
+
+## 0.16.3
+
+### Patch Changes
+
+- 67f6e79: feat: return logged in page from AuthStore
+
 ## 0.16.2
 
 ### Patch Changes

package/dist/auth/index.d.ts

@@ -3,6 +3,11 @@ type WithKey<T> = T & {
     key: string;
 };
 type AppType = "web-app" | "chrome-extension";
+type QueryFilter = {
+    type: "cookie" | "localStorage";
+    origin: string;
+    name: string;
+};
 export declare class AuthStore<T extends WithKey<{}>> {
     appType: AppType;
     page: Page;
@@ -17,6 +22,10 @@ export declare class AuthStore<T extends WithKey<{}>> {
         appType?: AppType;
     });
     loginIfRequired(): Promise<void>;
+    loggedInPage(): Promise<Page | undefined>;
+    static getValueFromAuthState(userContext: {
+        key: string;
+    }, query: QueryFilter): string | undefined;
     private newPageWithAuthState;
     private saveAuthState;
     static location(userContext: {

package/dist/auth/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAU,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE/D,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,KAAK,OAAO,GAAG,SAAS,GAAG,kBAAkB,CAAC;AAE9C,qBAAa,SAAS,CAAC,CAAC,SAAS,OAAO,CAAC,EAAE,CAAC;IAC1C,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,CAAC,CAAC;IACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;gBACxD,EACV,IAAI,EACJ,WAAW,EACX,SAAS,EACT,iBAAiB,EACjB,OAAmB,GACpB,EAAE;QACD,IAAI,EAAE,IAAI,CAAC;QACX,WAAW,EAAE,CAAC,CAAC;QACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QACpE,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;IAQK,eAAe;YA6BP,oBAAoB;YAsBpB,aAAa;IA6B3B,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;WAIxC,eAAe,CAC1B,OAAO,EAAE,cAAc,EACvB,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC;CAoB5B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAU,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAI/D,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,KAAK,OAAO,GAAG,SAAS,GAAG,kBAAkB,CAAC;AAE9C,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,QAAQ,GAAG,cAAc,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,qBAAa,SAAS,CAAC,CAAC,SAAS,OAAO,CAAC,EAAE,CAAC;IAC1C,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,CAAC,CAAC;IACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;gBACxD,EACV,IAAI,EACJ,WAAW,EACX,SAAS,EACT,iBAAiB,EACjB,OAAmB,GACpB,EAAE;QACD,IAAI,EAAE,IAAI,CAAC;QACX,WAAW,EAAE,CAAC,CAAC;QACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QACpE,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;IAQK,eAAe;IAIf,YAAY,IAAI,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAqC/C,MAAM,CAAC,qBAAqB,CAC1B,WAAW,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,EAC5B,KAAK,EAAE,WAAW,GACjB,MAAM,GAAG,SAAS;YA0BP,oBAAoB;YAsBpB,aAAa;IA6B3B,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;WAIxC,eAAe,CAC1B,OAAO,EAAE,cAAc,EACvB,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC;CAoB5B"}

package/dist/auth/index.js

@@ -21,7 +21,11 @@ class AuthStore {
         this.checkLoggedInFunc = checkLoggedInFunc;
     }
     async loginIfRequired() {
+        await this.loggedInPage();
+    }
+    async loggedInPage() {
         let shouldDoLogin = false;
+        let loggedInPage = undefined;
         const storagePath = AuthStore.location(this.userContext);
         if (!fs_1.default.existsSync(storagePath)) {
             shouldDoLogin = true;
@@ -30,8 +34,13 @@ class AuthStore {
             const page = await this.newPageWithAuthState(this.page, storagePath);
             try {
                 const hasLoggedIn = await this.checkLoggedInFunc(page, this.userContext);
+                if (!hasLoggedIn) {
+                    await page.close();
+                }
+                else {
+                    loggedInPage = page;
+                }
                 shouldDoLogin = !hasLoggedIn;
-                await page.close();
             }
             catch (err) {
                 if (err instanceof playwright_core_1.errors.TimeoutError) {
@@ -45,6 +54,32 @@ class AuthStore {
         if (shouldDoLogin) {
             await this.loginFunc(this.page, this.userContext);
             await this.saveAuthState(storagePath);
+            loggedInPage = this.page;
+        }
+        return loggedInPage;
+    }
+    static getValueFromAuthState(userContext, query) {
+        console.log(query);
+        const storagePath = AuthStore.location(userContext);
+        const contents = fs_1.default.readFileSync(storagePath);
+        if (!contents) {
+            throw new Error("No auth state found");
+        }
+        const authState = JSON.parse(contents.toString());
+        if (query.type === "cookie") {
+            const cookie = authState.cookies.find((c) => c.name === query.name && c.domain === query.origin);
+            if (cookie) {
+                return cookie.value;
+            }
+        }
+        else if (query.type === "localStorage") {
+            const origin = authState.origins.find((o) => o.origin === query.origin);
+            if (origin) {
+                const item = origin.localStorage.find((i) => i.name === query.name);
+                if (item) {
+                    return item.value;
+                }
+            }
         }
     }
     async newPageWithAuthState(page, storagePath) {

package/dist/auth/types.d.ts

@@ -0,0 +1,24 @@
+type AuthStateCookie = {
+    name: string;
+    value: string;
+    domain: string;
+    path: string;
+    expires: number;
+    httpOnly: boolean;
+    secure: boolean;
+    sameSite: "Strict" | "Lax" | "None";
+};
+type AuthStateLocalStorage = {
+    name: string;
+    value: string;
+};
+type AuthStateOrigin = {
+    origin: string;
+    localStorage: AuthStateLocalStorage[];
+};
+export type AuthStateFileContent = {
+    cookies: AuthStateCookie[];
+    origins: AuthStateOrigin[];
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/auth/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/auth/types.ts"],"names":[],"mappings":"AAAA,KAAK,eAAe,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;CACrC,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,qBAAqB,EAAE,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B,CAAC"}

package/dist/auth/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.16.2",
+  "version": "0.17.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"