npm - @forgerock/iframe-manager - Versions diffs - 1.3.0 → 2.1.0 - Mend

@forgerock/iframe-manager 1.3.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (28) hide show

package/README.md +18 -18
package/dist/src/lib/iframe-manager.effects.d.ts +4 -0
package/dist/src/lib/iframe-manager.effects.d.ts.map +1 -1
package/dist/src/lib/iframe-manager.effects.js +52 -18
package/dist/tsconfig.lib.tsbuildinfo +1 -1
package/package.json +8 -1
package/CHANGELOG.md +0 -22
package/coverage/base.css +0 -224
package/coverage/block-navigation.js +0 -87
package/coverage/coverage-final.json +0 -3
package/coverage/favicon.png +0 -0
package/coverage/index.html +0 -131
package/coverage/prettify.css +0 -1
package/coverage/prettify.js +0 -2
package/coverage/sort-arrow-sprite.png +0 -0
package/coverage/sorter.js +0 -210
package/coverage/src/index.html +0 -116
package/coverage/src/index.ts.html +0 -88
package/coverage/src/lib/iframe-manager.effects.ts.html +0 -604
package/coverage/src/lib/index.html +0 -116
package/eslint.config.mjs +0 -22
package/src/index.ts +0 -1
package/src/lib/iframe-manager.effects.ts +0 -173
package/tsconfig.json +0 -16
package/tsconfig.lib.json +0 -34
package/tsconfig.spec.json +0 -41
package/typedoc.json +0 -4
package/vite.config.ts +0 -0

package/coverage/src/lib/index.html DELETED Viewed

@@ -1,116 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-    <title>Code coverage report for src/lib</title>
-    <meta charset="utf-8" />
-    <link rel="stylesheet" href="../../prettify.css" />
-    <link rel="stylesheet" href="../../base.css" />
-    <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <style type='text/css'>
-        .coverage-summary .sorter {
-            background-image: url(../../sort-arrow-sprite.png);
-        }
-    </style>
-</head>
-<body>
-<div class='wrapper'>
-    <div class='pad1'>
-        <h1><a href="../../index.html">All files</a> src/lib</h1>
-        <div class='clearfix'>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">0% </span>
-                <span class="quiet">Statements</span>
-                <span class='fraction'>0/105</span>
-            </div>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">100% </span>
-                <span class="quiet">Branches</span>
-                <span class='fraction'>1/1</span>
-            </div>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">100% </span>
-                <span class="quiet">Functions</span>
-                <span class='fraction'>1/1</span>
-            </div>
-            <div class='fl pad1y space-right2'>
-                <span class="strong">0% </span>
-                <span class="quiet">Lines</span>
-                <span class='fraction'>0/105</span>
-            </div>
-        </div>
-        <p class="quiet">
-            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
-        </p>
-        <template id="filterTemplate">
-            <div class="quiet">
-                Filter:
-                <input type="search" id="fileSearch">
-            </div>
-        </template>
-    </div>
-    <div class='status-line low'></div>
-    <div class="pad1">
-<table class="coverage-summary">
-<thead>
-<tr>
-   <th data-col="file" data-fmt="html" data-html="true" class="file">File</th>
-   <th data-col="pic" data-type="number" data-fmt="html" data-html="true" class="pic"></th>
-   <th data-col="statements" data-type="number" data-fmt="pct" class="pct">Statements</th>
-   <th data-col="statements_raw" data-type="number" data-fmt="html" class="abs"></th>
-   <th data-col="branches" data-type="number" data-fmt="pct" class="pct">Branches</th>
-   <th data-col="branches_raw" data-type="number" data-fmt="html" class="abs"></th>
-   <th data-col="functions" data-type="number" data-fmt="pct" class="pct">Functions</th>
-   <th data-col="functions_raw" data-type="number" data-fmt="html" class="abs"></th>
-   <th data-col="lines" data-type="number" data-fmt="pct" class="pct">Lines</th>
-   <th data-col="lines_raw" data-type="number" data-fmt="html" class="abs"></th>
-</tr>
-</thead>
-<tbody><tr>
-	<td class="file low" data-value="iframe-manager.effects.ts"><a href="iframe-manager.effects.ts.html">iframe-manager.effects.ts</a></td>
-	<td data-value="0" class="pic low">
-	<div class="chart"><div class="cover-fill" style="width: 0%"></div><div class="cover-empty" style="width: 100%"></div></div>
-	</td>
-	<td data-value="0" class="pct low">0%</td>
-	<td data-value="105" class="abs low">0/105</td>
-	<td data-value="100" class="pct high">100%</td>
-	<td data-value="1" class="abs high">1/1</td>
-	<td data-value="100" class="pct high">100%</td>
-	<td data-value="1" class="abs high">1/1</td>
-	<td data-value="0" class="pct low">0%</td>
-	<td data-value="105" class="abs low">0/105</td>
-	</tr>
-</tbody>
-</table>
-</div>
-                <div class='push'></div><!-- for sticky footer -->
-            </div><!-- /wrapper -->
-            <div class='footer quiet pad2 space-top1 center small'>
-                Code coverage generated by
-                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-11-24T21:09:11.652Z
-            </div>
-        <script src="../../prettify.js"></script>
-        <script>
-            window.onload = function () {
-                prettyPrint();
-            };
-        </script>
-        <script src="../../sorter.js"></script>
-        <script src="../../block-navigation.js"></script>
-    </body>
-</html>

package/eslint.config.mjs DELETED Viewed

@@ -1,22 +0,0 @@
-import baseConfig from '../../../eslint.config.mjs';
-export default [
-  ...baseConfig,
-  {
-    files: ['**/*.json'],
-    rules: {
-      '@nx/dependency-checks': [
-        'warn',
-        {
-          ignoredFiles: [
-            '{projectRoot}/eslint.config.{js,cjs,mjs}',
-            '{projectRoot}/vite.config.{js,ts,mjs,mts}',
-          ],
-        },
-      ],
-    },
-    languageOptions: {
-      parser: (await import('jsonc-eslint-parser')).default,
-    },
-  },
-];

package/src/index.ts DELETED Viewed

	@@ -1 +0,0 @@
1	- export * from './lib/iframe-manager.effects.js';

package/src/lib/iframe-manager.effects.ts DELETED Viewed

@@ -1,173 +0,0 @@
-/*
- * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
- *
- * This software may be modified and distributed under the terms
- * of the MIT license. See the LICENSE file for details.
- */
-/* eslint-disable @typescript-eslint/no-empty-function */
-export interface GetParamsFromIFrameOptions {
-  /** The URL to load in the iframe. */
-  url: string;
-  /** Timeout in milliseconds for the entire operation. */
-  timeout: number;
-  /** Array of query parameter keys expected upon successful completion. */
-  successParams: string[];
-  /** Array of query parameter keys indicating an error occurred. */
-  errorParams: string[];
-}
-export type ResolvedParams = Record<string, string>;
-type Noop = () => void;
-function hasErrorParams(params: URLSearchParams, errorParams: string[]): boolean {
-  for (const key of errorParams) {
-    if (params.has(key)) {
-      return true;
-    }
-  }
-  return false;
-}
-// Helper function to check if all required success params are present
-function hasSomeSuccessParams(params: URLSearchParams, successParams: string[]): boolean {
-  return successParams.some((key) => params.has(key));
-}
-function searchParamsToRecord(params: URLSearchParams): ResolvedParams {
-  const result: ResolvedParams = {};
-  params.forEach((value, key) => {
-    result[key] = value;
-  });
-  return result;
-}
-/**
- * Initializes the Iframe Manager effect.
- * @returns An object containing the API for managing iframe requests.
- */
-export function iFrameManager() {
-  /**
-   * Creates a hidden iframe to navigate to the specified URL,
-   * waits for a redirect back to the application's origin,
-   * and resolves/rejects based on the query parameters found in the redirect URL.
-   * IMPORTANT: This relies on the final redirect target being on the SAME ORIGIN
-   * as the parent window due to browser security restrictions (Same-Origin Policy).
-   * Accessing contentWindow.location of a cross-origin iframe will fail.
-   *
-   * @param options - The options for the iframe request (URL, timeout, success/error params).
-   * @returns A Promise that resolves with the parsed query parameters on success,
-   *          or rejects on error, timeout, or if unable to access iframe content.
-   */
-  return {
-    getParamsByRedirect: (options: GetParamsFromIFrameOptions): Promise<ResolvedParams> => {
-      const { url, timeout, successParams, errorParams } = options;
-      if (
-        !successParams ||
-        !errorParams ||
-        successParams.length === 0 ||
-        errorParams.length === 0
-      ) {
-        const error = new Error('successParams and errorParams must be provided');
-        throw error;
-      }
-      return new Promise<ResolvedParams>((resolve, reject) => {
-        let iframe: HTMLIFrameElement | null = null;
-        let timerId: ReturnType<typeof setTimeout> | null = null;
-        let onLoadHandler: () => void = () => {};
-        let cleanup: Noop = () => {};
-        cleanup = (): void => {
-          if (!iframe && !timerId) return;
-          if (timerId) {
-            clearTimeout(timerId);
-            timerId = null;
-          }
-          if (iframe) {
-            iframe.removeEventListener('load', onLoadHandler);
-            if (iframe.parentNode) {
-              iframe.remove();
-            }
-            iframe = null;
-          }
-          onLoadHandler = () => {};
-          cleanup = () => {};
-        };
-        onLoadHandler = (): void => {
-          try {
-            if (iframe && iframe.contentWindow) {
-              const currentIframeHref = iframe.contentWindow.location.href;
-              if (currentIframeHref === 'about:blank' || !currentIframeHref) {
-                return; // Wait for actual navigation
-              }
-              const redirectUrl = new URL(currentIframeHref);
-              const searchParams = redirectUrl.searchParams;
-              const parsedParams = searchParamsToRecord(searchParams);
-              // 1. Check for Error Parameters
-              if (hasErrorParams(searchParams, errorParams)) {
-                cleanup();
-                resolve(parsedParams); // Reject with all parsed params for context
-                return;
-              }
-              // 2. Check for Success Parameters
-              if (hasSomeSuccessParams(searchParams, successParams)) {
-                cleanup();
-                resolve(parsedParams); // Resolve with all parsed params
-                return;
-              }
-              /*
-               * 3. Neither Error nor Success: Intermediate Redirect?
-               * If neither error nor all required success params are found,
-               * assume it's an intermediate step in the redirect flow.
-               * Do nothing, let the timeout eventually handle non-resolving states
-               * or wait for the next 'load' event.
-               */
-            }
-          } catch {
-            // This likely means a cross-origin navigation occurred where access is denied.
-            cleanup();
-            reject({
-              type: 'internal_error',
-              message: 'unexpected failure',
-            });
-          }
-        };
-        try {
-          iframe = document.createElement('iframe');
-          iframe.style.display = 'none'; // Hide the iframe
-          iframe.addEventListener('load', onLoadHandler);
-          document.body.appendChild(iframe);
-          timerId = setTimeout(() => {
-            cleanup();
-            reject({
-              type: 'internal_error',
-              message: 'iframe timed out',
-            });
-          }, timeout);
-          iframe.src = url;
-        } catch {
-          cleanup(); // Attempt cleanup even if setup failed partially
-          reject({
-            type: 'internal_error',
-            message: 'error setting up iframe',
-          });
-        }
-      });
-    },
-  };
-}

package/tsconfig.json DELETED Viewed

@@ -1,16 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ],
-  "nx": {
-    "addTypecheckTarget": false
-  }
-}

package/tsconfig.lib.json DELETED Viewed

@@ -1,34 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "outDir": "dist",
-    "tsBuildInfoFile": "dist/tsconfig.lib.tsbuildinfo",
-    "emitDeclarationOnly": false,
-    "module": "nodenext",
-    "moduleResolution": "nodenext",
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "importHelpers": true,
-    "noImplicitOverride": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"],
-  "references": [],
-  "exclude": [
-    "vite.config.ts",
-    "vite.config.mts",
-    "vitest.config.ts",
-    "vitest.config.mts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.tsx",
-    "src/**/*.spec.tsx",
-    "src/**/*.test.js",
-    "src/**/*.spec.js",
-    "src/**/*.test.jsx",
-    "src/**/*.spec.jsx"
-  ]
-}

package/tsconfig.spec.json DELETED Viewed

@@ -1,41 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "./out-tsc/vitest",
-    "types": [
-      "vitest/globals",
-      "vitest/importMeta",
-      "vite/client",
-      "node",
-      "vitest"
-    ],
-    "module": "nodenext",
-    "moduleResolution": "nodenext",
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "importHelpers": true,
-    "noImplicitOverride": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true
-  },
-  "include": [
-    "vite.config.ts",
-    "vite.config.mts",
-    "vitest.config.ts",
-    "vitest.config.mts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.tsx",
-    "src/**/*.spec.tsx",
-    "src/**/*.test.js",
-    "src/**/*.spec.js",
-    "src/**/*.test.jsx",
-    "src/**/*.spec.jsx",
-    "src/**/*.d.ts"
-  ],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    }
-  ]
-}

package/typedoc.json DELETED Viewed

@@ -1,4 +0,0 @@
-{
-  "name": "@forgerock/iframe-manager",
-  "entryPoints": ["src/index.ts"]
-}

package/vite.config.ts DELETED Viewed

Binary file