feat(javascript): add getRedirectBasedSignUpUrl utility and corresponding tests; update TypeScript configuration

Author: brionmario

packages/javascript/package.json

@@ -42,7 +42,7 @@
     "typecheck": "tsc -p tsconfig.lib.json"
   },
   "devDependencies": {
-    "@types/node": "^22.15.3",
+    "@types/node": "^22.15.30",
     "@wso2/eslint-plugin": "catalog:",
     "@wso2/prettier-config": "catalog:",
     "esbuild": "^0.25.9",

packages/javascript/src/index.ts

@@ -143,6 +143,7 @@ export {default as flattenUserSchema} from './utils/flattenUserSchema';
 export {default as generateUserProfile} from './utils/generateUserProfile';
 export {default as getLatestStateParam} from './utils/getLatestStateParam';
 export {default as generateFlattenedUserProfile} from './utils/generateFlattenedUserProfile';
+export {default as getRedirectBasedSignUpUrl} from './utils/getRedirectBasedSignUpUrl';
 export {default as getI18nBundles} from './utils/getI18nBundles';
 export {default as identifyPlatform} from './utils/identifyPlatform';
 export {default as isEmpty} from './utils/isEmpty';

packages/javascript/src/utils/__tests__/getRedirectBasedSignUpUrl.test.ts

@@ -0,0 +1,73 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import {describe, it, expect, vi, afterEach} from 'vitest';
+import {Config} from '../../models/config';
+import isRecognizedBaseUrlPattern from '../isRecognizedBaseUrlPattern';
+import getRedirectBasedSignUpUrl from '../getRedirectBasedSignUpUrl';
+
+vi.mock('../isRecognizedBaseUrlPattern', () => ({default: vi.fn()}));
+
+describe('getRedirectBasedSignUpUrl', () => {
+  const baseUrl: string = 'https://api.asgardeo.io/t/org';
+  const expectedBaseUrl: string = 'https://accounts.asgardeo.io/t/org';
+  const clientId: string = 'client123';
+  const applicationId: string = 'app456';
+
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('returns the correct sign-up URL if baseUrl is recognized and both params are present', () => {
+    (isRecognizedBaseUrlPattern as unknown as ReturnType<typeof vi.fn>).mockReturnValue(true);
+    const config: Config = {baseUrl, clientId, applicationId};
+    const url: URL = new URL(expectedBaseUrl + '/accountrecoveryendpoint/register.do');
+    url.searchParams.set('client_id', clientId);
+    url.searchParams.set('spId', applicationId);
+    expect(getRedirectBasedSignUpUrl(config)).toBe(url.toString());
+  });
+
+  it('returns the correct sign-up URL if only clientId is present', () => {
+    (isRecognizedBaseUrlPattern as unknown as ReturnType<typeof vi.fn>).mockReturnValue(true);
+    const config: Config = {baseUrl, clientId};
+    const url: URL = new URL(expectedBaseUrl + '/accountrecoveryendpoint/register.do');
+    url.searchParams.set('client_id', clientId);
+    expect(getRedirectBasedSignUpUrl(config)).toBe(url.toString());
+  });
+
+  it('returns the correct sign-up URL if only applicationId is present', () => {
+    (isRecognizedBaseUrlPattern as unknown as ReturnType<typeof vi.fn>).mockReturnValue(true);
+    const config: Config = {baseUrl, applicationId, clientId: ''};
+    const url: URL = new URL(expectedBaseUrl + '/accountrecoveryendpoint/register.do');
+    url.searchParams.set('spId', applicationId);
+    expect(getRedirectBasedSignUpUrl(config)).toBe(url.toString());
+  });
+
+  it('returns the correct sign-up URL if neither param is present', () => {
+    (isRecognizedBaseUrlPattern as unknown as ReturnType<typeof vi.fn>).mockReturnValue(true);
+    const config: Config = {baseUrl, clientId: ''};
+    const url: URL = new URL(expectedBaseUrl + '/accountrecoveryendpoint/register.do');
+    expect(getRedirectBasedSignUpUrl(config)).toBe(url.toString());
+  });
+
+  it('returns empty string if baseUrl is not recognized', () => {
+    (isRecognizedBaseUrlPattern as unknown as ReturnType<typeof vi.fn>).mockReturnValue(false);
+    const config: Config = {baseUrl, clientId, applicationId};
+    expect(getRedirectBasedSignUpUrl(config)).toBe('');
+  });
+});

packages/javascript/src/utils/getRedirectBasedSignUpUrl.ts

@@ -0,0 +1,72 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import {Config} from '../models/config';
+import isRecognizedBaseUrlPattern from './isRecognizedBaseUrlPattern';
+import identifyPlatform from './identifyPlatform';
+import {Platform} from '../models/platforms';
+import logger from './logger';
+
+/**
+ * Utility to generate the redirect-based sign-up URL for Asgardeo.
+ *
+ * If the baseUrl is recognized (standard Asgardeo pattern), constructs the sign-up URL.
+ * Otherwise, returns an empty string.
+ *
+ * @param baseUrl - The base URL of the Asgardeo identity server (string or undefined)
+ * @returns The sign-up URL if baseUrl is recognized, otherwise an empty string
+ */
+const getRedirectBasedSignUpUrl = (config: Config): string => {
+  const {baseUrl} = config;
+
+  if (!isRecognizedBaseUrlPattern(baseUrl)) return '';
+
+  let signUpBaseUrl: string = baseUrl;
+
+  if (identifyPlatform(config) === Platform.Asgardeo) {
+    try {
+      const url: URL = new URL(baseUrl!);
+
+      // Replace 'api.' with 'accounts.' in the hostname, preserving subdomains like 'dev.'
+      if (/([a-z0-9-]+\.)*api\.asgardeo\.io$/i.test(url.hostname)) {
+        url.hostname = url.hostname.replace('api.', 'accounts.');
+        signUpBaseUrl = url.toString().replace(/\/$/, ''); // Remove trailing slash if any
+      }
+    } catch {
+      logger.debug(
+        `[getRedirectBasedSignUpUrl] Could not parse base URL to replace 'api.' with 'accounts.'. Base URL: ${baseUrl}`,
+      );
+    }
+  }
+
+  const url: URL = new URL(signUpBaseUrl + '/accountrecoveryendpoint/register.do');
+
+  if (config.clientId) {
+    url.searchParams.set('client_id', config.clientId);
+  }
+
+  if (config.applicationId) {
+    url.searchParams.set('spId', config.applicationId);
+  }
+
+  logger.debug(`[getRedirectBasedSignUpUrl] Generated sign-up URL: ${url.toString()}`);
+
+  return url.toString();
+};
+
+export default getRedirectBasedSignUpUrl;

packages/javascript/tsconfig.json

@@ -6,7 +6,7 @@
     "esModuleInterop": true,
     "experimentalDecorators": true,
     "importHelpers": true,
-    "lib": ["ESNext"],
+    "lib": ["ESNext", "DOM"],
     "module": "ESNext",
     "moduleResolution": "node",
     "skipLibCheck": true,