feat(javascript): add a identifyPlatform util to detect the identity platform

Author: brionmario

packages/javascript/src/index.ts

@@ -1,3 +1,4 @@
+import { Platform } from './models/platforms';
 /**
  * Copyright (c) 2020, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
  *
@@ -57,6 +58,7 @@ export {default as AsgardeoRuntimeError} from './errors/AsgardeoRuntimeError';
 export {AsgardeoAuthException} from './errors/exception';
 
 export {AllOrganizationsApiResponse} from './models/organization';
+export {Platform} from './models/platforms';
 export {
   EmbeddedSignInFlowInitiateResponse,
   EmbeddedSignInFlowStatus,
@@ -142,6 +144,7 @@ export {default as generateUserProfile} from './utils/generateUserProfile';
 export {default as getLatestStateParam} from './utils/getLatestStateParam';
 export {default as generateFlattenedUserProfile} from './utils/generateFlattenedUserProfile';
 export {default as getI18nBundles} from './utils/getI18nBundles';
+export {default as identifyPlatform} from './utils/identifyPlatform';
 export {default as isEmpty} from './utils/isEmpty';
 export {default as set} from './utils/set';
 export {default as get} from './utils/get';

packages/javascript/src/models/platforms.ts

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+
+/**
+ * Enumeration of supported identity platforms.
+ *
+ * - `Asgardeo`: Represents the Asgardeo cloud identity platform (asgardeo.io domains).
+ * - `IdentityServer`: Represents WSO2 Identity Server (on-prem or custom domains).
+ * - `Unknown`: Used when the platform cannot be determined from the configuration.
+ *
+ * This enum is used to distinguish between different identity providers and to
+ * enable platform-specific logic throughout the SDK.
+ */
+export enum Platform {
+  /** Asgardeo cloud identity platform (asgardeo.io domains) */
+  Asgardeo = 'ASGARDEO',
+  /** WSO2 Identity Server (on-prem or custom domains) */
+  IdentityServer = 'IDENTITY_SERVER',
+  /** Unknown or unsupported platform */
+  Unknown = 'UNKNOWN',
+}

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

@@ -0,0 +1,66 @@
+/**
+ * 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 identifyPlatform from '../identifyPlatform';
+import {Platform} from '../../models/platforms';
+import {Config} from '../../models/config';
+
+vi.mock('../logger', () => ({default: {debug: vi.fn(), warn: vi.fn()}}));
+
+describe('identifyPlatform', () => {
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should return Platform.Asgardeo for recognized asgardeo domains', () => {
+    const configs: Config[] = [
+      {baseUrl: 'https://api.asgardeo.io/t/org', clientId: '', applicationId: ''},
+      {baseUrl: 'https://accounts.asgardeo.io/t/org', clientId: '', applicationId: ''},
+      {baseUrl: 'https://asgardeo.io/t/org', clientId: '', applicationId: ''},
+    ];
+
+    configs.forEach(config => {
+      expect(identifyPlatform(config)).toBe(Platform.Asgardeo);
+    });
+  });
+
+  it('should return Platform.IdentityServer for non-asgardeo recognized base Urls', () => {
+    const configs: Config[] = [
+      {baseUrl: 'https://localhost:9443/t/carbon.super', clientId: '', applicationId: ''},
+      {baseUrl: 'https://is.dev.com/t/abc.com', clientId: '', applicationId: ''},
+      {baseUrl: 'https://192.168.1.1/t/mytenant', clientId: '', applicationId: ''},
+    ];
+
+    configs.forEach(config => {
+      expect(identifyPlatform(config)).toBe(Platform.IdentityServer);
+    });
+  });
+
+  it('should return Platform.IdentityServer if baseUrl is not recognized', () => {
+    const config: Config = {baseUrl: undefined, clientId: '', applicationId: ''};
+
+    expect(identifyPlatform(config)).toBe(Platform.Unknown);
+  });
+
+  it('should return Platform.IdentityServer if baseUrl is malformed', () => {
+    const config: Config = {baseUrl: 'http://[::1', clientId: '', applicationId: ''};
+
+    expect(identifyPlatform(config)).toBe(Platform.Unknown);
+  });
+});

packages/javascript/src/utils/identifyPlatform.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 {Platform} from '../models/platforms';
+import isRecognizedBaseUrlPattern from './isRecognizedBaseUrlPattern';
+import logger from './logger';
+
+/**
+ * Identifies the platform based on the given base URL.
+ *
+ * If the URL is recognized and matches the Asgardeo domain, returns Platform.Asgardeo.
+ * Otherwise, returns Platform.IdentityServer.
+ *
+ * @param baseUrl - The base URL to check
+ * @returns Platform enum value
+ */
+const identifyPlatform = (config: Config): Platform => {
+  const {baseUrl} = config;
+
+  try {
+    if (isRecognizedBaseUrlPattern(baseUrl)) {
+      try {
+        const url = new URL(baseUrl!);
+        // Check for asgardeo domain (e.g., api.asgardeo.io, etc.)
+        if (/\.asgardeo\.io$/i.test(url.hostname) || /asgardeo\.io$/i.test(url.hostname)) {
+          return Platform.Asgardeo;
+        }
+      } catch {
+        // Fallback to IdentityServer if URL parsing fails.
+        logger.debug(
+          `[identifyPlatform] Could not identify platform from the base URL: ${baseUrl}. Defaulting to WSO2 Identity Server as the platform.`,
+        );
+      }
+
+      return Platform.IdentityServer;
+    }
+  } catch (error) {
+    logger.debug(`[identifyPlatform] Error identifying platform from base URL: ${baseUrl}. Error: ${error.message}`);
+
+    return Platform.Unknown;
+  }
+};
+
+export default identifyPlatform;