feat: createPortalUrl

Author: DanielRivers

lib/sdk/clients/browser/authcode-with-pkce.ts

@@ -1,6 +1,7 @@
 import { BrowserSessionManager } from '../../session-managers/index.js';
 import { AuthCodeWithPKCE } from '../../oauth2-flows/index.js';
 import * as utilities from '../../utilities/index.js';
+import type { GeneratePortalUrlParams } from '@kinde/js-utils';
 
 import type {
   UserType,
@@ -63,6 +64,18 @@ const createAuthCodeWithPKCEClient = (options: BrowserPKCEClientOptions) => {
     });
   };
 
+  /**
+   * Method makes use of the `createPortalUrl` method of the AuthCodeWithPKCE
+   * client above to return portal url.
+   * @param {GeneratePortalUrlParams} options
+   * @returns {Promise<{url: URL}>} portal URL
+   */
+  const portal = async (options: GeneratePortalUrlParams): Promise<{ url: URL }> => {
+    return await client.createPortalUrl(sessionManager, {
+      ...options,
+    });
+  };
+
   /**
    * Method makes use of the `handleRedirectFromAuthDomain` method of the
    * `AuthCodeWithPKCE` client above to handle the redirection back to the app.
@@ -379,6 +392,7 @@ const createAuthCodeWithPKCEClient = (options: BrowserPKCEClientOptions) => {
     getFlag,
     logout,
     login,
+    portal,
   };
 };
 

lib/sdk/clients/server/authorization-code.ts

@@ -12,6 +12,7 @@ import type {
 } from '../types.js';
 
 import type { OAuth2CodeExchangeResponse } from '../../oauth2-flows/types.js';
+import type { GeneratePortalUrlParams } from '@kinde/js-utils';
 
 const createAuthorizationCodeClient = (
   options: ACClientOptions,
@@ -73,6 +74,22 @@ const createAuthorizationCodeClient = (
     });
   };
 
+  /**
+   * Method makes use of the `createPortalUrl` method of the AuthCodeAbstract
+   * client above to return login url.
+   * @param {SessionManager} sessionManager
+   * @param {GeneratePortalUrlParams} options
+   * @returns {Promise<{ url: URL }>} required authorization URL
+   */
+  const portal = async (
+    sessionManager: SessionManager,
+    options: GeneratePortalUrlParams
+  ): Promise<{ url: URL }> => {
+    return await client.createPortalUrl(sessionManager, {
+      ...options,
+    });
+  };
+
   /**
    * Method makes use of the `handleRedirectFromAuthDomain` method of the
    * `AuthCodeAbstract` client above to handle the redirection back to the app.
@@ -175,6 +192,7 @@ const createAuthorizationCodeClient = (
     getUser,
     logout,
     login,
+    portal,
   };
 };
 

lib/sdk/clients/types.ts

@@ -12,6 +12,9 @@ export interface BrowserPKCEClientOptions extends AuthorizationCodeOptions {
   sessionManager?: SessionManager;
 }
 
+export { PortalPage } from '@kinde/js-utils';
+export type { GeneratePortalUrlParams } from '@kinde/js-utils';
+
 export interface PKCEClientOptions extends AuthorizationCodeOptions {}
 export interface CCClientOptions extends ClientCredentialsOptions {}
 export interface ACClientOptions extends AuthorizationCodeOptions {

lib/sdk/oauth2-flows/AuthCodeAbstract.ts

@@ -13,6 +13,7 @@ import type {
 } from './types.js';
 import { createLocalJWKSet } from 'jose';
 import { getRemoteJwks } from '../utilities/remote-jwks-cache.js';
+import type { GeneratePortalUrlParams } from '@kinde/js-utils';
 
 /**
  * Abstract class provides contract (methods) for classes implementing OAuth2.0 flows
@@ -71,6 +72,17 @@ export abstract class AuthCodeAbstract {
     options: AuthURLOptions
   ): Promise<URL>;
 
+  /**
+   * Abstract method mandates implementation of logic required for creating portal URL
+   * for accessing Kinde's portal interface, utilizing session data for authentication.
+   * @param {GeneratePortalUrlParams} options
+   * @returns {Promise<{url: URL}>} object containing the portal URL
+   */
+  public abstract createPortalUrl(
+    sessionManager: SessionManager,
+    options: GeneratePortalUrlParams
+  ): Promise<{ url: URL }>;
+
   /**
    * Abstract method will implement logic required for exchanging received auth code
    * post user-authentication with authorization server to receive access, refresh

lib/sdk/oauth2-flows/AuthCodeWithPKCE.ts

@@ -12,6 +12,8 @@ import type {
   AuthURLOptions,
   AuthorizationCodeOptions,
 } from './types.js';
+import type { GeneratePortalUrlParams } from '@kinde/js-utils';
+import { createPortalUrl } from '../utilities/createPortalUrl.js';
 
 /**
  * Class provides implementation for the authorization code with PKCE extension
@@ -67,6 +69,24 @@ export class AuthCodeWithPKCE extends AuthCodeAbstract {
     return authURL;
   }
 
+  /**
+   * Method provides implementation for `createPortalUrl` method mandated by
+   * `AuthCodeAbstract` parent class, see corresponding comment in parent class for
+   * further explanation.
+   * @param {SessionManager} sessionManager
+   * @param {Omit<GeneratePortalUrlParams, 'domain'>} options
+   * @returns {Promise<{url: URL}>} required authorization URL
+   */
+  async createPortalUrl(
+    sessionManager: SessionManager,
+    options: Omit<GeneratePortalUrlParams, 'domain'>
+  ): Promise<{ url: URL }> {
+    return await createPortalUrl(sessionManager, {
+      domain: this.config.authDomain,
+      ...options,
+    });
+  }
+
   /**
    * Method provides implementation for `refreshTokens` method mandated by
    * `AuthCodeAbstract` parent class, see corresponding comment in parent class for

lib/sdk/oauth2-flows/AuthorizationCode.ts

@@ -7,6 +7,8 @@ import type {
   AuthorizationCodeOptions,
   AuthURLOptions,
 } from './types.js';
+import type { GeneratePortalUrlParams } from '@kinde/js-utils';
+import { createPortalUrl } from '../utilities/createPortalUrl.js';
 
 /**
  * Class provides implementation for the authorization code OAuth2.0 flow.
@@ -52,6 +54,24 @@ export class AuthorizationCode extends AuthCodeAbstract {
     return authURL;
   }
 
+  /**
+   * Method provides implementation for `createPortalUrl` method mandated by
+   * `AuthCodeAbstract` parent class, see corresponding comment in parent class for
+   * further explanation.
+   * @param {SessionManager} sessionManager
+   * @param {Omit<GeneratePortalUrlParams, 'domain'>} options
+   * @returns {Promise<{url: URL}>} required authorization URL
+   */
+  async createPortalUrl(
+    sessionManager: SessionManager,
+    options: Omit<GeneratePortalUrlParams, 'domain'>
+  ): Promise<{ url: URL }> {
+    return await createPortalUrl(sessionManager, {
+      domain: this.config.authDomain,
+      ...options,
+    });
+  }
+
   /**
    * Method provides implementation for `refreshTokens` method mandated by
    * `AuthCodeAbstract` parent class, see corresponding comment in parent class for

lib/sdk/utilities/createPortalUrl.ts

@@ -0,0 +1,29 @@
+import {
+  generatePortalUrl,
+  MemoryStorage,
+  setActiveStorage,
+  StorageKeys,
+} from '@kinde/js-utils';
+import type { GeneratePortalUrlParams } from '@kinde/js-utils';
+import { type SessionManager } from '../session-managers/index.js';
+
+export const createPortalUrl = async (
+  sessionManager: SessionManager,
+  options: GeneratePortalUrlParams
+): Promise<{ url: URL }> => {
+  const token = await sessionManager.getSessionItem('access_token'); // Ensure session is initialized
+
+  if (!token) {
+    throw new Error('No active session found.');
+  }
+
+  const storage = new MemoryStorage();
+  await storage.setSessionItem(StorageKeys.accessToken, token);
+  setActiveStorage(storage);
+
+  return await generatePortalUrl({
+    domain: options.domain,
+    returnUrl: options.returnUrl,
+    subNav: options.subNav,
+  });
+};

package.json

@@ -69,6 +69,7 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
+    "@kinde/js-utils": "^0.18.1",
     "jose": "^5.2.2",
     "uncrypto": "^0.1.3"
   },