@frontegg/rest-api 3.0.84 → 3.0.86

package/auth/index.d.ts

@@ -1,7 +1,7 @@
 export * from "./secutiry-poilicy";
 export * from "./enums";
 import { ISamlRolesGroup } from "../teams/interfaces";
-import { IAcceptInvitation, IActivateAccount, IAllowedToRememberMfaDevice, ICreateSamlGroup, IDeleteApiToken, IDisableMfa, IEnrollMfaResponse, IForgotPassword, IGetActivateAccountStrategy, IGetActivateAccountStrategyResponse, IGetUserById, IGetUserPasswordConfig, ILogin, ILoginResponse, ILoginViaSocialLogin, ILoginViaSocialLoginResponse, ILoginWithMfa, IOidcPostLogin, IOidcConfiguration, IPostLogin, IPreLogin, IRecoverMFAToken, IResendActivationEmail, IResetPassword, ISamlConfiguration, ISamlVendorConfigResponse, ISignUpResponse, ISignUpUser, ISocialLoginProviderConfiguration, ITenantApiTokensData, IUpdateSamlConfiguration, IUpdateSamlGroup, IUpdateSamlRoles, IUpdateSamlVendorMetadata, IUpdateTenantApiTokensData, IUpdateUserApiTokensData, IUserApiTokensData, IUserIdResponse, IVendorConfig, IVerifyMfa, IVerifyMfaResponse, TestConfig, ISSOPublicConfiguration, IPreLoginWithIdpTypeResponse, IPasswordlessPreLogin, IPasswordlessPostLogin, ICreateSSODomain, IVerifyInviteToken, ISSODomain, ISSOConfigurationDefaultRoles, ISSOConfiguration, IUpdateSSOConfiguration, IOidcPostLoginV2, IExchangeOAuthTokens, IOAuthTokenResponse, ISocialLoginProviderConfigurationV2, ILoginResponseV2, IResetPhoneNumber, IVerifyResetPhoneNumber, IChangePhoneNumber, IVerifyResetPhoneNumberResponse, IResetPhoneNumberResponse, IWebAuthnPreLogin, IWebAuthnPostLogin, IVerifyNewWebAuthnDevice, IWebAuthnPreLoginResponse, ICreateNewDeviceSessionResponse, IAuthStrategiesConfig, ISessionResponse, IChangePhoneNumberWithVerification, IChangePhoneNumberWithVerificationResponse, IVerifyChangePhoneNumber, ISessionConfigurations, IResendInvitationEmail, IPreEnrollMFA, IEnrollMFAAuthenticatorApp, IPreEnrollMFASMS, IEnrollMFASMS, IEnrollMFAWebAuthn, IPreEnrollMFAAuthenticatorAppResponse, IPreEnrollMFAWebAuthnResponse, IVerifyMFAAuthenticatorApp, IPreVerifyMFA, IPreVerifyMFASMSResponse, IVerifyMFASMS, IPreVerifyMFAWebAuthnResponse, IVerifyMFAWebAuthn, IPreEnrollMFASMSResponse, IPreDisableMFASMSResponse, IDisableMFASMS, IDisableMFAWebAuthn, IPreDisableMFAWebAuthnResponse, UserMFADevicesResponse, WithoutMFAToken, IMFAStrategiesResponse, IOAuthLogout, IGetUserAccessTokens, IGetTenantAccessTokens, IDeleteAccessToken, ICreateTenantAccessTokenData, ICreateUserAccessTokenData, IWebAuthnDevices } from "./interfaces";
+import { IAcceptInvitation, IActivateAccount, IAllowedToRememberMfaDevice, ICreateSamlGroup, IDeleteApiToken, IDisableMfa, IEnrollMfaResponse, IForgotPassword, IGetActivateAccountStrategy, IGetActivateAccountStrategyResponse, IGetUserById, IGetUserPasswordConfig, ILogin, ILoginResponse, ILoginViaSocialLogin, ILoginViaSocialLoginResponse, ILoginWithMfa, IOidcPostLogin, IOidcConfiguration, IPostLogin, IPreLogin, IRecoverMFAToken, IResendActivationEmail, IResetPassword, ISamlConfiguration, ISamlVendorConfigResponse, ISignUpResponse, ISignUpUser, ISocialLoginProviderConfiguration, ITenantApiTokensData, IUpdateSamlConfiguration, IUpdateSamlGroup, IUpdateSamlRoles, IUpdateSamlVendorMetadata, IUpdateTenantApiTokensData, IUpdateUserApiTokensData, IUserApiTokensData, IUserIdResponse, IVendorConfig, IVerifyMfa, IVerifyMfaResponse, TestConfig, ISSOPublicConfiguration, IPreLoginWithIdpTypeResponse, IPasswordlessPreLogin, IPasswordlessPostLogin, ICreateSSODomain, IVerifyInviteToken, ISSODomain, ISSOConfigurationDefaultRoles, ISSOConfiguration, IUpdateSSOConfiguration, IOidcPostLoginV2, IExchangeOAuthTokens, IOAuthTokenResponse, ISocialLoginProviderConfigurationV2, ILoginResponseV2, IResetPhoneNumber, IVerifyResetPhoneNumber, IChangePhoneNumber, IVerifyResetPhoneNumberResponse, IResetPhoneNumberResponse, IWebAuthnPreLogin, IWebAuthnPostLogin, IVerifyNewWebAuthnDevice, IWebAuthnPreLoginResponse, ICreateNewDeviceSessionResponse, IAuthStrategiesConfig, ISessionResponse, IChangePhoneNumberWithVerification, IChangePhoneNumberWithVerificationResponse, IVerifyChangePhoneNumber, ISessionConfigurations, IResendInvitationEmail, IPreEnrollMFA, IEnrollMFAAuthenticatorApp, IPreEnrollMFASMS, IEnrollMFASMS, IEnrollMFAWebAuthn, IPreEnrollMFAAuthenticatorAppResponse, IPreEnrollMFAWebAuthnResponse, IVerifyMFAAuthenticatorApp, IPreVerifyMFA, IPreVerifyMFASMSResponse, IVerifyMFASMS, IPreVerifyMFAWebAuthnResponse, IVerifyMFAWebAuthn, IPreEnrollMFASMSResponse, IPreDisableMFASMSResponse, IDisableMFASMS, IDisableMFAWebAuthn, IPreDisableMFAWebAuthnResponse, UserMFADevicesResponse, WithoutMFAToken, IMFAStrategiesResponse, IOAuthLogout, IGetUserAccessTokens, IGetTenantAccessTokens, IDeleteAccessToken, ICreateTenantAccessTokenData, ICreateUserAccessTokenData, IWebAuthnDevices, ICustomSocialLoginProviderConfigurationV1 } from './interfaces';
 /*****************************************
  * Authentication
  *****************************************/
@@ -367,6 +367,11 @@ export declare function getSocialLoginProviders(): Promise<ISocialLoginProviderC
  * @return array of providers configurations
  */
 export declare function getSocialLoginProvidersV2(): Promise<ISocialLoginProviderConfigurationV2[]>;
+/**
+ *  Get social logins custom providers configurations
+ * @return array of custom providers configurations
+ */
+export declare function getCustomSocialLoginProvidersV1(): Promise<ICustomSocialLoginProviderConfigurationV1>;
 /**
  * Login using social login
  * @return cookie with refresh token

package/auth/index.js

@@ -270,6 +270,9 @@ export async function getSocialLoginProviders() {
 export async function getSocialLoginProvidersV2() {
   return Get(urls.identity.sso.v2);
 }
+export async function getCustomSocialLoginProvidersV1() {
+  return Get(urls.identity.sso.custom.v1);
+}
 export async function loginViaSocialLogin({
   provider,
   code,

package/auth/interfaces.d.ts

@@ -149,6 +149,21 @@ export interface ISocialLoginProviderConfigurationV2 {
     options?: Record<string, unknown>;
     customised: boolean;
 }
+export interface ICustomSocialLoginProviderConfigurationV1 {
+    providers: {
+        id: string;
+        type: string;
+        clientId: string;
+        redirectUrl: string;
+        redirectUrlPattern: string;
+        authorizationUrl: string;
+        userInfoUrl: string;
+        scopes: string;
+        ssoLogoUrl: string | null;
+        displayName: string;
+        active: boolean;
+    }[];
+}
 export interface ILoginViaSocialLogin {
     code?: string;
     idToken?: string;

package/constants.d.ts

@@ -46,6 +46,9 @@ export declare const urls: {
         sso: {
             v1: string;
             v2: string;
+            custom: {
+                v1: string;
+            };
         };
         permissions: {
             v1: string;

package/constants.js

@@ -45,7 +45,10 @@ export const urls = {
     },
     sso: {
       v1: '/identity/resources/sso/v1',
-      v2: '/identity/resources/sso/v2'
+      v2: '/identity/resources/sso/v2',
+      custom: {
+        v1: '/identity/resources/sso/custom/v1'
+      }
     },
     permissions: {
       v1: '/identity/resources/permissions/v1'

package/fetch.js

@@ -98,6 +98,17 @@ async function getAdditionalHeaders(context) {
     output = await context.additionalHeadersResolver();
   }
 
+  if (context.tenantResolver) {
+    const resolvedTenantResult = await context.tenantResolver();
+
+    if (!!(resolvedTenantResult != null && resolvedTenantResult.tenant)) {
+      output.push({
+        key: 'frontegg-login-alias',
+        value: resolvedTenantResult.tenant
+      });
+    }
+  }
+
   return output;
 }
 

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.84
+/** @license Frontegg v3.0.86
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/interfaces.d.ts

@@ -17,11 +17,19 @@ export interface KeyValuePair {
     key: string;
     value: string;
 }
+export interface ResolvedTenantResult {
+    tenant: string | null;
+}
 export declare type LogLevel = 'warn' | 'error';
 export interface ContextOptions {
     baseUrl: string | ((url: string) => string);
     clientId?: string;
     tokenResolver?: () => Promise<string> | string;
+    /**
+     * custom login header value
+     * @returns `{ tenant: string | null }`
+     */
+    tenantResolver?: () => Promise<ResolvedTenantResult> | ResolvedTenantResult;
     additionalQueryParamsResolver?: () => Promise<KeyValuePair[]> | KeyValuePair[];
     additionalHeadersResolver?: () => Promise<KeyValuePair[]> | KeyValuePair[];
     currentUserRoles?: string[];

package/node/auth/index.js

@@ -69,6 +69,7 @@ var _exportNames = {
   getSSOPublicConfiguration: true,
   getSocialLoginProviders: true,
   getSocialLoginProvidersV2: true,
+  getCustomSocialLoginProvidersV1: true,
   loginViaSocialLogin: true,
   getVendorConfig: true,
   signUpUser: true,
@@ -171,6 +172,7 @@ exports.generateLoginResponseV2 = generateLoginResponseV2;
 exports.getActivateAccountStrategy = getActivateAccountStrategy;
 exports.getCurrentUserSession = getCurrentUserSession;
 exports.getCurrentUserSessions = getCurrentUserSessions;
+exports.getCustomSocialLoginProvidersV1 = getCustomSocialLoginProvidersV1;
 exports.getMFADevices = getMFADevices;
 exports.getMFAStrategiesConfig = getMFAStrategiesConfig;
 exports.getOidcConfiguration = getOidcConfiguration;
@@ -622,6 +624,10 @@ async function getSocialLoginProvidersV2() {
   return (0, _fetch.Get)(_constants.urls.identity.sso.v2);
 }
 
+async function getCustomSocialLoginProvidersV1() {
+  return (0, _fetch.Get)(_constants.urls.identity.sso.custom.v1);
+}
+
 async function loginViaSocialLogin({
   provider,
   code,

package/node/constants.js

@@ -51,7 +51,10 @@ const urls = {
     },
     sso: {
       v1: '/identity/resources/sso/v1',
-      v2: '/identity/resources/sso/v2'
+      v2: '/identity/resources/sso/v2',
+      custom: {
+        v1: '/identity/resources/sso/custom/v1'
+      }
     },
     permissions: {
       v1: '/identity/resources/permissions/v1'

package/node/fetch.js

@@ -111,6 +111,17 @@ async function getAdditionalHeaders(context) {
     output = await context.additionalHeadersResolver();
   }
 
+  if (context.tenantResolver) {
+    const resolvedTenantResult = await context.tenantResolver();
+
+    if (!!(resolvedTenantResult != null && resolvedTenantResult.tenant)) {
+      output.push({
+        key: 'frontegg-login-alias',
+        value: resolvedTenantResult.tenant
+      });
+    }
+  }
+
   return output;
 }
 

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.84
+/** @license Frontegg v3.0.86
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontegg/rest-api",
-  "version": "3.0.84",
+  "version": "3.0.86",
   "main": "./node/index.js",
   "license": "MIT",
   "dependencies": {