@seontechnologies/playwright-utils 3.10.0

package/dist/cjs/api-request/ui-display.js

@@ -0,0 +1,370 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * UI display functionality for API requests
+ * Adapted from pw-api-plugin to provide rich visual feedback in Playwright UI
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addApiCardToUI = void 0;
+const test_1 = require("@playwright/test");
+const internal_1 = require("../internal");
+/**
+ * Adds an API card to the UI by updating the page content with the provided request and response data.
+ * Only works when a page context is available (UI tests)
+ */
+const addApiCardToUI = async (requestData, responseData, page, uiMode) => {
+    // Only show UI if we have a page and UI mode is enabled (either via parameter or environment variable)
+    const shouldShowUI = page && (uiMode || shouldDisplayApiUI());
+    if (!shouldShowUI)
+        return;
+    try {
+        const apiCallHtml = await createApiCallHtml(requestData, responseData);
+        const html = await createPageHtml(apiCallHtml);
+        // Open validation results in a new tab if this is a validation request
+        if (requestData.validationInfo) {
+            // Create a new page/tab for validation results
+            const newPage = await page.context().newPage();
+            await newPage.setContent(html);
+            // Optional: Bring the new tab to front
+            await newPage.bringToFront();
+        }
+        else {
+            // For non-validation requests, use the original behavior
+            await page.setContent(html);
+        }
+        // Also attach as test report since UI mode is enabled
+        const method = requestData.method.toUpperCase();
+        await test_1.test.info().attach(`API request - ${method} - ${requestData.url}`, {
+            body: await createApiCallReportAttachment(apiCallHtml),
+            contentType: 'text/html'
+        });
+    }
+    catch (error) {
+        await (0, internal_1.getLogger)().warning(`Failed to display API UI: ${error}`);
+    }
+};
+exports.addApiCardToUI = addApiCardToUI;
+/**
+ * Determines if API UI should be displayed based on environment variables
+ */
+const shouldDisplayApiUI = () => {
+    // One environment variable to rule them all
+    const envUiMode = process.env.API_E2E_UI_MODE;
+    if (envUiMode === 'true')
+        return true;
+    if (envUiMode === 'false')
+        return false;
+    // Default is false unless explicitly enabled
+    return false;
+};
+/**
+ * Generates an HTML representation of an API call
+ */
+const createApiCallHtml = async (requestData, responseData) => {
+    const callId = Math.floor(10000000 + Math.random() * 90000000);
+    // Add validation results section if present
+    const validationSection = responseData.validationResult
+        ? `
+        <hr>
+        <div class="pw-api-validation">
+            <label class="title">${responseData.validationResult.icon} SCHEMA VALIDATION - </label>
+            <label class="title-property">${responseData.validationResult.summary}</label>
+            <br>
+            <label class="property">Schema Info:</label> ${responseData.validationResult.schemaInfo}
+            ${responseData.validationResult.schema
+            ? `
+                    <div class="pw-val-data-tabs-${callId} pw-data-tabs">
+                        ${await createValidationTab(responseData.validationResult.errors &&
+                responseData.validationResult.errors.length > 0
+                ? `<div style="color: #d00;">
+                                <strong>❌ Validation Failed - ${responseData.validationResult.errors.length} error(s):</strong>
+                                <ul style="margin: 10px 0; padding-left: 20px;">
+                                    ${responseData.validationResult.errors.map((err) => `<li>${err}</li>`).join('')}
+                                </ul>
+                              </div>`
+                : '<span style="color: #0d0; font-weight: bold;">✅ All validations passed successfully</span>', 'VALIDATION RESULT', callId, true)}
+                        ${await createValidationTab(formatJson(responseData.validationResult.schema), 'SCHEMA', callId)}
+                    </div>
+                  `
+            : responseData.validationResult.errors &&
+                responseData.validationResult.errors.length > 0
+                ? `
+                      <br><br>
+                      <label class="property">Validation Errors:</label>
+                      <div class="pw-validation-errors" style="background: #ffe6e6; border-left: 4px solid #ff0000; padding: 10px; margin-top: 10px;">
+                          <ul style="margin: 0; padding-left: 20px;">
+                              ${responseData.validationResult.errors.map((err) => `<li style="color: #d00;">${err}</li>`).join('')}
+                          </ul>
+                      </div>
+                    `
+                : '<br><span style="color: #0d0;">✓ All validations passed</span>'}
+        </div>
+      `
+        : '';
+    return `<div class="pw-api-call pw-card">
+        ${await createApiCallHtmlRequest(requestData, callId)}
+        <hr>
+        ${await createApiCallHtmlResponse(responseData, callId)}
+        ${validationSection}
+    </div>`;
+};
+/**
+ * Generates HTML for the request section
+ */
+const createApiCallHtmlRequest = async (requestData, callId) => {
+    const { url, method, headers, data, params, otherOptions } = requestData;
+    const requestHeaders = headers ? formatJson(headers) : undefined;
+    const requestBody = data ? formatJson(data) : undefined;
+    const requestParams = params ? formatJson(params) : undefined;
+    const requestOtherOptions = otherOptions
+        ? formatJson(otherOptions)
+        : undefined;
+    return `<div class="pw-api-request">
+        <label class="title">REQUEST - </label>
+        <label class="title-property">(METHOD: ${method.toUpperCase()})</label>
+        <br>
+
+        <label class="property">URL</label>
+        <pre class="hljs pw-api-hljs">${url}</pre>
+        <div class="pw-req-data-tabs-${callId} pw-data-tabs">
+            ${await createRequestTab(requestBody, 'BODY', callId, true)}
+            ${await createRequestTab(requestHeaders, 'HEADERS', callId)}
+            ${await createRequestTab(requestParams, 'PARAMS', callId)}
+            ${await createRequestTab(requestOtherOptions, 'OTHER OPTIONS', callId)}
+        </div>
+    </div>`;
+};
+/**
+ * Creates HTML for a request tab
+ */
+const createRequestTab = async (data, tabLabel, callId, checked) => {
+    if (data === undefined)
+        return '';
+    const tabLabelForId = tabLabel.toLowerCase().replace(/[^a-z0-9]/g, '-');
+    return `<input type="radio" name="pw-req-data-tabs-${callId}" id="pw-req-${tabLabelForId}-${callId}" ${checked ? 'checked="checked"' : ''}>
+        <label for="pw-req-${tabLabelForId}-${callId}" class="property pw-tab-label">${tabLabel.toUpperCase()}</label>
+        <div class="pw-tab-content">
+           <pre class="hljs" id="req-${tabLabelForId}-${callId}" data-tab-type="req-${tabLabelForId}">${data}</pre>
+        </div>`;
+};
+/**
+ * Generates HTML for the response section
+ */
+const createApiCallHtmlResponse = async (responseData, callId) => {
+    const { status, statusClass, statusText, headers, body, duration } = responseData;
+    const responseHeaders = headers ? formatJson(headers) : undefined;
+    const responseBody = body ? formatJson(body) : undefined;
+    const durationMsg = duration
+        ? 'Duration approx. ' +
+            (duration < 1000 ? `${duration}ms` : `${(duration / 1000).toFixed(2)}s`)
+        : '';
+    return `<div class="pw-api-response">
+        <label class="title">RESPONSE - </label>
+        <label class="title-property pw-api-${statusClass}">(STATUS: ${status} - ${statusText})</label>
+        <label class="title-property"> - ${durationMsg}</label>
+        <br>
+        <div class="pw-res-data-tabs-${callId} pw-data-tabs">
+            ${await createResponseTab(responseBody, 'BODY', callId, true)}
+            ${await createResponseTab(responseHeaders, 'HEADERS', callId)}
+         </div>
+    </div>`;
+};
+/**
+ * Creates HTML for a response tab
+ */
+const createResponseTab = async (data, tabLabel, callId, checked) => {
+    if (data === undefined)
+        return '';
+    const tabLabelForId = tabLabel.toLowerCase().replace(/[^a-z0-9]/g, '-');
+    return `<input type="radio" name="pw-res-data-tabs-${callId}" id="pw-res-${tabLabelForId}-${callId}" ${checked ? 'checked="checked"' : ''}>
+        <label for="pw-res-${tabLabelForId}-${callId}" class="property pw-tab-label">${tabLabel.toUpperCase()}</label>
+        <div class="pw-tab-content">
+            <pre class="hljs" id="res-${tabLabelForId}-${callId}" data-tab-type="res-${tabLabelForId}">${data}</pre>
+        </div>`;
+};
+/**
+ * Creates HTML for a validation tab
+ */
+const createValidationTab = async (data, tabLabel, callId, checked) => {
+    if (data === undefined)
+        return '';
+    const tabLabelForId = tabLabel.toLowerCase().replace(/[^a-z0-9]/g, '-');
+    return `<input type="radio" name="pw-val-data-tabs-${callId}" id="pw-val-${tabLabelForId}-${callId}" ${checked ? 'checked="checked"' : ''}>
+        <label for="pw-val-${tabLabelForId}-${callId}" class="property pw-tab-label">${tabLabel.toUpperCase()}</label>
+        <div class="pw-tab-content">
+            <pre class="hljs" id="val-${tabLabelForId}-${callId}" data-tab-type="val-${tabLabelForId}">${data}</pre>
+        </div>`;
+};
+/**
+ * Creates a complete HTML page for API call display
+ */
+const createPageHtml = async (apiCallHtml) => {
+    return `<!DOCTYPE html>
+    <html lang="en">
+        <head>
+            <meta charset="UTF-8">
+            <meta name="viewport" content="width=device-width, initial-scale=1.0">
+            <title>API Call Details</title>
+            ${inlineStyles}
+        </head>
+        <body>
+            <div class="pw-api-container">${apiCallHtml}</div>
+        </body>
+    </html>`;
+};
+/**
+ * Creates HTML for API call report attachment
+ */
+const createApiCallReportAttachment = async (apiCallHtml) => {
+    return `<html>
+        <head>
+            <title>API Call Report</title>
+            ${inlineStyles}
+        </head>
+        <body>
+            ${apiCallHtml}
+        </body>
+    </html>`;
+};
+/**
+ * Formats a JSON object for display with basic highlighting
+ */
+const formatJson = (jsonObject) => {
+    try {
+        const jsonString = JSON.stringify(jsonObject, null, 4);
+        // First escape HTML entities to prevent XSS
+        const escapedString = jsonString
+            .replace(/&/g, '&amp;')
+            .replace(/</g, '&lt;')
+            .replace(/>/g, '&gt;')
+            .replace(/"/g, '&quot;')
+            .replace(/'/g, '&#039;');
+        // Then apply syntax highlighting
+        return escapedString
+            .replace(/&quot;([^&]+)&quot;:/g, '<span class="json-key">"$1":</span>')
+            .replace(/: &quot;([^&]+)&quot;/g, ': <span class="json-string">"$1"</span>')
+            .replace(/: (\d+)/g, ': <span class="json-number">$1</span>')
+            .replace(/: (true|false|null)/g, ': <span class="json-literal">$1</span>');
+    }
+    catch {
+        return String(jsonObject)
+            .replace(/&/g, '&amp;')
+            .replace(/</g, '&lt;')
+            .replace(/>/g, '&gt;');
+    }
+};
+/**
+ * Inline CSS styles for the API display
+ */
+const inlineStyles = `<style>
+    body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; margin: 0; padding: 20px; }
+    .pw-card { 
+        box-shadow: 0 4px 8px 0 rgba(0,0,0,0.1); 
+        transition: 0.3s; 
+        border-radius: 8px;
+        overflow: hidden;
+    }
+    .pw-card:hover { box-shadow: 0 8px 16px 0 rgba(0,0,0,0.2); }
+    .pw-api-container { color: rgb(40, 40, 40); max-width: 1200px; margin: 0 auto; }
+    .pw-api-call { 
+        background-color: rgb(248, 250, 252); 
+        border: 1px solid rgb(226, 232, 240);
+        margin: 20px 0; 
+        padding: 20px; 
+        font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace; 
+    }
+    .pw-api-request, .pw-api-response { margin-bottom: 20px; }
+    .title { 
+        font-weight: 800; 
+        font-size: 1.4em; 
+        color: rgb(30, 64, 175);
+        margin-right: 10px;
+    }
+    .title-property { 
+        color: rgb(75, 85, 99); 
+        font-weight: 600; 
+        font-size: 1.1em; 
+    }
+    .property { 
+        display: inline-block;
+        padding: 8px 12px; 
+        margin: 10px 5px 0 0; 
+        cursor: pointer;
+        color: rgb(55, 65, 81); 
+        font-weight: 600; 
+        font-size: 0.9em; 
+        border-radius: 6px 6px 0 0;
+        background-color: rgb(229, 231, 235);
+        border: 1px solid rgb(209, 213, 219);
+    }
+    .pw-api-hljs { 
+        background: white;
+        border: 1px solid rgb(229, 231, 235);
+        border-radius: 6px;
+        padding: 12px;
+        margin: 8px 0;
+        font-size: 0.9em;
+        overflow-x: auto;
+    }
+    
+    /* Status color coding */
+    .pw-api-1xx { color: rgb(59, 130, 246)!important; }
+    .pw-api-2xx { color: rgb(34, 197, 94)!important; }
+    .pw-api-3xx { color: rgb(249, 115, 22)!important; }
+    .pw-api-4xx { color: rgb(239, 68, 68)!important; }
+    .pw-api-5xx { color: rgb(220, 38, 127)!important; }
+    
+    /* Tab styling */
+    .pw-data-tabs { display: flex; flex-wrap: wrap; margin-top: 10px; }
+    .pw-data-tabs [type="radio"] { display: none; }
+    .pw-tab-label { 
+        background-color: rgb(243, 244, 246);
+        border: 1px solid rgb(209, 213, 219);
+        border-bottom: none;
+    }
+    .pw-tab-label:hover { 
+        background-color: rgb(229, 231, 235);
+        color: rgb(30, 64, 175); 
+    }
+    .pw-tab-content { 
+        width: 100%; 
+        order: 1; 
+        display: none;
+        border: 1px solid rgb(209, 213, 219);
+        border-top: none;
+        border-radius: 0 0 6px 6px;
+    }
+    .pw-data-tabs [type="radio"]:checked + label + .pw-tab-content { display: block; }
+    .pw-data-tabs [type="radio"]:checked + label { 
+        background: white; 
+        border-bottom: 1px solid white;
+        color: rgb(30, 64, 175);
+        font-weight: 700;
+    }
+    
+    .hljs { 
+        background: white;
+        padding: 16px; 
+        margin: 0;
+        overflow-x: auto;
+        font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace;
+        font-size: 0.85em;
+        line-height: 1.5;
+        white-space: pre-wrap;
+        word-wrap: break-word;
+    }
+    
+    /* Simple JSON highlighting */
+    .json-key { color: rgb(147, 51, 234); font-weight: 600; }
+    .json-string { color: rgb(34, 197, 94); }
+    .json-number { color: rgb(249, 115, 22); }
+    .json-literal { color: rgb(239, 68, 68); font-weight: 600; }
+    
+    hr { 
+        border: none; 
+        height: 1px; 
+        background: rgb(229, 231, 235);
+        margin: 20px 0;
+    }
+</style>`;
+//# sourceMappingURL=ui-display.js.map

package/dist/cjs/api-request/ui-display.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-display.js","sourceRoot":"","sources":["../../../src/api-request/ui-display.ts"],"names":[],"mappings":";AAAA,uDAAuD;AACvD;;;GAGG;;;AAEH,2CAAkD;AAClD,0CAAuC;AAmCvC;;;GAGG;AACI,MAAM,cAAc,GAAG,KAAK,EACjC,WAAiC,EACjC,YAAmC,EACnC,IAAW,EACX,MAAgB,EACD,EAAE;IACjB,uGAAuG;IACvG,MAAM,YAAY,GAAG,IAAI,IAAI,CAAC,MAAM,IAAI,kBAAkB,EAAE,CAAC,CAAA;IAE7D,IAAI,CAAC,YAAY;QAAE,OAAM;IAEzB,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,MAAM,iBAAiB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;QACtE,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,CAAA;QAE9C,uEAAuE;QACvE,IAAI,WAAW,CAAC,cAAc,EAAE,CAAC;YAC/B,+CAA+C;YAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,CAAA;YAC9C,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;YAE9B,uCAAuC;YACvC,MAAM,OAAO,CAAC,YAAY,EAAE,CAAA;QAC9B,CAAC;aAAM,CAAC;YACN,yDAAyD;YACzD,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QAC7B,CAAC;QAED,sDAAsD;QACtD,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,WAAW,EAAE,CAAA;QAC/C,MAAM,WAAI,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,iBAAiB,MAAM,MAAM,WAAW,CAAC,GAAG,EAAE,EAAE;YACvE,IAAI,EAAE,MAAM,6BAA6B,CAAC,WAAW,CAAC;YACtD,WAAW,EAAE,WAAW;SACzB,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAA,oBAAS,GAAE,CAAC,OAAO,CAAC,6BAA6B,KAAK,EAAE,CAAC,CAAA;IACjE,CAAC;AACH,CAAC,CAAA;AArCY,QAAA,cAAc,kBAqC1B;AAED;;GAEG;AACH,MAAM,kBAAkB,GAAG,GAAY,EAAE;IACvC,4CAA4C;IAC5C,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAA;IAC7C,IAAI,SAAS,KAAK,MAAM;QAAE,OAAO,IAAI,CAAA;IACrC,IAAI,SAAS,KAAK,OAAO;QAAE,OAAO,KAAK,CAAA;IAEvC,6CAA6C;IAC7C,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,iBAAiB,GAAG,KAAK,EAC7B,WAAiC,EACjC,YAAmC,EAClB,EAAE;IACnB,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAA;IAE9D,4CAA4C;IAC5C,MAAM,iBAAiB,GAAG,YAAY,CAAC,gBAAgB;QACrD,CAAC,CAAC;;;mCAG6B,YAAY,CAAC,gBAAgB,CAAC,IAAI;4CACzB,YAAY,CAAC,gBAAgB,CAAC,OAAO;;2DAEtB,YAAY,CAAC,gBAAgB,CAAC,UAAU;cAErF,YAAY,CAAC,gBAAgB,CAAC,MAAM;YAClC,CAAC,CAAC;mDACiC,MAAM;0BAC/B,MAAM,mBAAmB,CACzB,YAAY,CAAC,gBAAgB,CAAC,MAAM;gBAClC,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;gBAC/C,CAAC,CAAC;gEACkC,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM;;sCAErE,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;;qCAE9E;gBACT,CAAC,CAAC,4FAA4F,EAChG,mBAAmB,EACnB,MAAM,EACN,IAAI,CACL;0BACC,MAAM,mBAAmB,CACzB,UAAU,CAAC,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAChD,QAAQ,EACR,MAAM,CACP;;mBAEN;YACH,CAAC,CAAC,YAAY,CAAC,gBAAgB,CAAC,MAAM;gBAClC,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;gBACjD,CAAC,CAAC;;;;;gCAKY,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,4BAA4B,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;;;qBAG7G;gBACH,CAAC,CAAC,gEACR;;OAEL;QACH,CAAC,CAAC,EAAE,CAAA;IAEN,OAAO;UACC,MAAM,wBAAwB,CAAC,WAAW,EAAE,MAAM,CAAC;;UAEnD,MAAM,yBAAyB,CAAC,YAAY,EAAE,MAAM,CAAC;UACrD,iBAAiB;WAChB,CAAA;AACX,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,wBAAwB,GAAG,KAAK,EACpC,WAAiC,EACjC,MAAc,EACG,EAAE;IACnB,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,WAAW,CAAA;IAExE,MAAM,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAChE,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACvD,MAAM,aAAa,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC7D,MAAM,mBAAmB,GAAG,YAAY;QACtC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC;QAC1B,CAAC,CAAC,SAAS,CAAA;IAEb,OAAO;;iDAEwC,MAAM,CAAC,WAAW,EAAE;;;;wCAI7B,GAAG;uCACJ,MAAM;cAC/B,MAAM,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC;cACzD,MAAM,gBAAgB,CAAC,cAAc,EAAE,SAAS,EAAE,MAAM,CAAC;cACzD,MAAM,gBAAgB,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC;cACvD,MAAM,gBAAgB,CAAC,mBAAmB,EAAE,eAAe,EAAE,MAAM,CAAC;;WAEvE,CAAA;AACX,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,gBAAgB,GAAG,KAAK,EAC5B,IAAS,EACT,QAAgB,EAChB,MAAc,EACd,OAAiB,EACA,EAAE;IACnB,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,CAAA;IAEjC,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;IACvE,OAAO,8CAA8C,MAAM,gBAAgB,aAAa,IAAI,MAAM,KAChG,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAClC;6BAC2B,aAAa,IAAI,MAAM,mCAAmC,QAAQ,CAAC,WAAW,EAAE;;uCAEtE,aAAa,IAAI,MAAM,wBAAwB,aAAa,KAAK,IAAI;eAC7F,CAAA;AACf,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,yBAAyB,GAAG,KAAK,EACrC,YAAmC,EACnC,MAAc,EACG,EAAE;IACnB,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAChE,YAAY,CAAA;IAEd,MAAM,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACjE,MAAM,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACxD,MAAM,WAAW,GAAG,QAAQ;QAC1B,CAAC,CAAC,mBAAmB;YACnB,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;QAC1E,CAAC,CAAC,EAAE,CAAA;IAEN,OAAO;;8CAEqC,WAAW,cAAc,MAAM,MAAM,UAAU;2CAClD,WAAW;;uCAEf,MAAM;cAC/B,MAAM,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC;cAC3D,MAAM,iBAAiB,CAAC,eAAe,EAAE,SAAS,EAAE,MAAM,CAAC;;WAE9D,CAAA;AACX,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,iBAAiB,GAAG,KAAK,EAC7B,IAAS,EACT,QAAgB,EAChB,MAAc,EACd,OAAiB,EACA,EAAE;IACnB,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,CAAA;IAEjC,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;IACvE,OAAO,8CAA8C,MAAM,gBAAgB,aAAa,IAAI,MAAM,KAChG,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAClC;6BAC2B,aAAa,IAAI,MAAM,mCAAmC,QAAQ,CAAC,WAAW,EAAE;;wCAErE,aAAa,IAAI,MAAM,wBAAwB,aAAa,KAAK,IAAI;eAC9F,CAAA;AACf,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,mBAAmB,GAAG,KAAK,EAC/B,IAAS,EACT,QAAgB,EAChB,MAAc,EACd,OAAiB,EACA,EAAE;IACnB,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,CAAA;IAEjC,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;IACvE,OAAO,8CAA8C,MAAM,gBAAgB,aAAa,IAAI,MAAM,KAChG,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAClC;6BAC2B,aAAa,IAAI,MAAM,mCAAmC,QAAQ,CAAC,WAAW,EAAE;;wCAErE,aAAa,IAAI,MAAM,wBAAwB,aAAa,KAAK,IAAI;eAC9F,CAAA;AACf,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,cAAc,GAAG,KAAK,EAAE,WAAmB,EAAmB,EAAE;IACpE,OAAO;;;;;;cAMK,YAAY;;;4CAGkB,WAAW;;YAE3C,CAAA;AACZ,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,6BAA6B,GAAG,KAAK,EACzC,WAAmB,EACF,EAAE;IACnB,OAAO;;;cAGK,YAAY;;;cAGZ,WAAW;;YAEb,CAAA;AACZ,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,UAAU,GAAG,CAAC,UAAkB,EAAU,EAAE;IAChD,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;QACtD,4CAA4C;QAC5C,MAAM,aAAa,GAAG,UAAU;aAC7B,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC;aACvB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAE1B,iCAAiC;QACjC,OAAO,aAAa;aACjB,OAAO,CAAC,uBAAuB,EAAE,qCAAqC,CAAC;aACvE,OAAO,CACN,wBAAwB,EACxB,yCAAyC,CAC1C;aACA,OAAO,CAAC,UAAU,EAAE,uCAAuC,CAAC;aAC5D,OAAO,CAAC,sBAAsB,EAAE,wCAAwC,CAAC,CAAA;IAC9E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,MAAM,CAAC,UAAU,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC1B,CAAC;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,YAAY,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA8GZ,CAAA"}

package/dist/cjs/auth-session/apply-user-cookies-to-browser-context.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Utility to apply user authentication to a browser context
+ *
+ * This utility takes a user's token and applies it to a browser context
+ * without persisting it to disk, making it ideal for ephemeral test users.
+ */
+import type { BrowserContext } from '@playwright/test';
+/**
+ * Apply a user's authentication token to a browser context
+ * Uses the auth provider to extract and apply cookies to a browser context
+ *
+ * @param context The browser context to apply the auth token to
+ * @param tokenData The storage state object or user data containing the token
+ * @returns The context with auth applied
+ */
+export declare function applyUserCookiesToBrowserContext(context: BrowserContext, tokenData: Record<string, unknown>): Promise<BrowserContext>;
+//# sourceMappingURL=apply-user-cookies-to-browser-context.d.ts.map

package/dist/cjs/auth-session/apply-user-cookies-to-browser-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-user-cookies-to-browser-context.d.ts","sourceRoot":"","sources":["../../../src/auth-session/apply-user-cookies-to-browser-context.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAGtD;;;;;;;GAOG;AACH,wBAAsB,gCAAgC,CACpD,OAAO,EAAE,cAAc,EACvB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACjC,OAAO,CAAC,cAAc,CAAC,CA0CzB"}

package/dist/cjs/auth-session/apply-user-cookies-to-browser-context.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyUserCookiesToBrowserContext = applyUserCookiesToBrowserContext;
+const log_1 = require("../log");
+const auth_provider_1 = require("./internal/auth-provider");
+/**
+ * Apply a user's authentication token to a browser context
+ * Uses the auth provider to extract and apply cookies to a browser context
+ *
+ * @param context The browser context to apply the auth token to
+ * @param tokenData The storage state object or user data containing the token
+ * @returns The context with auth applied
+ */
+async function applyUserCookiesToBrowserContext(context, tokenData) {
+    try {
+        // Get cookies from the auth provider
+        const authProvider = (0, auth_provider_1.getAuthProvider)();
+        try {
+            const cookies = authProvider.extractCookies(tokenData);
+            // Log what we're doing
+            await log_1.log.info(`Applying user auth with ${cookies.length} cookies`);
+            if (cookies.length > 0) {
+                try {
+                    // Apply the cookies to the browser context
+                    await context.addCookies(cookies);
+                    await log_1.log.info('Successfully applied auth cookies to browser context');
+                }
+                catch (cookieError) {
+                    await log_1.log.error(`Failed to apply auth cookies to browser context: ${String(cookieError)}`);
+                    throw new Error(`Failed to apply auth cookies: ${String(cookieError)}`);
+                }
+            }
+            else {
+                await log_1.log.warning('No auth cookies found to apply');
+            }
+        }
+        catch (extractError) {
+            await log_1.log.error(`Failed to extract auth cookies from token data: ${String(extractError)}`);
+            throw new Error(`Failed to extract auth cookies: ${String(extractError)}`);
+        }
+    }
+    catch (error) {
+        await log_1.log.error(`Error in applyUserCookiesToBrowserContext: ${String(error)}`);
+        throw error;
+    }
+    // Always return the context if no errors
+    return context;
+}
+//# sourceMappingURL=apply-user-cookies-to-browser-context.js.map

package/dist/cjs/auth-session/apply-user-cookies-to-browser-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-user-cookies-to-browser-context.js","sourceRoot":"","sources":["../../../src/auth-session/apply-user-cookies-to-browser-context.ts"],"names":[],"mappings":";;AAiBA,4EA6CC;AAvDD,gCAA4B;AAC5B,4DAA0D;AAC1D;;;;;;;GAOG;AACI,KAAK,UAAU,gCAAgC,CACpD,OAAuB,EACvB,SAAkC;IAElC,IAAI,CAAC;QACH,qCAAqC;QACrC,MAAM,YAAY,GAAG,IAAA,+BAAe,GAAE,CAAA;QAEtC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA;YAEtD,uBAAuB;YACvB,MAAM,SAAG,CAAC,IAAI,CAAC,2BAA2B,OAAO,CAAC,MAAM,UAAU,CAAC,CAAA;YAEnE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,IAAI,CAAC;oBACH,2CAA2C;oBAC3C,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;oBACjC,MAAM,SAAG,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAA;gBACxE,CAAC;gBAAC,OAAO,WAAW,EAAE,CAAC;oBACrB,MAAM,SAAG,CAAC,KAAK,CACb,oDAAoD,MAAM,CAAC,WAAW,CAAC,EAAE,CAC1E,CAAA;oBACD,MAAM,IAAI,KAAK,CACb,iCAAiC,MAAM,CAAC,WAAW,CAAC,EAAE,CACvD,CAAA;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,SAAG,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;QAAC,OAAO,YAAY,EAAE,CAAC;YACtB,MAAM,SAAG,CAAC,KAAK,CACb,mDAAmD,MAAM,CAAC,YAAY,CAAC,EAAE,CAC1E,CAAA;YACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;QAC5E,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,SAAG,CAAC,KAAK,CACb,8CAA8C,MAAM,CAAC,KAAK,CAAC,EAAE,CAC9D,CAAA;QACD,MAAM,KAAK,CAAA;IACb,CAAC;IAED,yCAAyC;IACzC,OAAO,OAAO,CAAA;AAChB,CAAC"}

package/dist/cjs/auth-session/core.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Core authentication functionality for the auth session library
+ * This file is the single source of truth for the public API
+ * following SEON's functional programming principles
+ */
+import type { APIRequestContext } from '@playwright/test';
+import type { AuthSessionOptions, AuthIdentifiers } from './internal/types';
+import { AuthSessionManager } from './internal/auth-session';
+export { AuthSessionManager };
+export { setAuthProvider } from './internal/auth-provider';
+/**
+ * Load a token from storage if one exists
+ * Handles token expiration checking using registered token expiration function
+ *
+ * @param tokenPath Path to the token file
+ * @param checkExpiration Whether to check if the token is expired (defaults to true)
+ */
+export declare function loadTokenFromStorage(tokenPath: string, checkExpiration?: boolean): string | null;
+/**
+ * Save a token to storage
+ * @param tokenPath Path to the token file
+ * @param token Token to save
+ * @returns Boolean indicating whether the token was successfully saved
+ */
+export declare function saveTokenToStorage(tokenPath: string, token: string): boolean;
+/**
+ * Load a storage state file and parse it into an object in one step
+ * This simplifies token management by handling both loading and parsing
+ *
+ * Note: This function no longer performs automatic token validation.
+ * Applications should implement their own validation logic based on their
+ * specific token formats and requirements.
+ *
+ * @param tokenPath Path to the storage state file
+ * @returns The parsed storage state object or null if file doesn't exist or is invalid
+ */
+export declare function loadStorageState(tokenPath: string): Record<string, unknown> | null;
+/**
+ * Configure the authentication session with the provided options
+ * This is the main entry point for setting up the auth system
+ */
+export declare const configureAuthSession: (options: AuthSessionOptions) => void;
+/**
+ * Get an authentication token, fetching a new one if needed
+ * @param request The Playwright APIRequestContext
+ * @param options Optional environment and user identifier overrides
+ * @returns A promise that resolves to a storage state object compatible with Playwright context
+ */
+export declare function getAuthToken(request: APIRequestContext, options?: AuthIdentifiers): Promise<Record<string, unknown>>;
+/**
+ * Clear the authentication token from storage
+ * @param options Optional environment and user identifier overrides
+ * @returns Boolean indicating whether a token was successfully cleared
+ */
+export declare function clearAuthToken(options?: AuthIdentifiers): boolean;
+//# sourceMappingURL=core.d.ts.map

package/dist/cjs/auth-session/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/auth-session/core.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AAMzD,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAM5D,OAAO,EAAE,kBAAkB,EAAE,CAAA;AAG7B,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AA6D1D;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,MAAM,EACjB,eAAe,GAAE,OAAc,GAC9B,MAAM,GAAG,IAAI,CAmCf;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAiB5E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,MAAM,GAChB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAqBhC;AAED;;;GAGG;AACH,eAAO,MAAM,oBAAoB,GAAI,SAAS,kBAAkB,SACxC,CAAA;AAExB;;;;;GAKG;AACH,wBAAsB,YAAY,CAChC,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CA6ClC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAgCjE"}