@frontegg/rest-api 3.1.74 → 3.1.76-alpha.9502349697

package/FetchClient.js

@@ -0,0 +1,308 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import { ContextHolder } from './ContextHolder';
+import { FronteggApiError } from './error';
+import { GENERIC_ERROR_MESSAGE } from './constants';
+import { fronteggHeaders } from './interfaces';
+export class FetchClient {
+  constructor(appName) {
+    this.appName = void 0;
+
+    this.getFronteggContext = () => {
+      return ContextHolder.for(this.appName);
+    };
+
+    this.prepareUrl = async (url, params) => {
+      const context = this.getFronteggContext().getContext();
+      const baseUrl = this.getContextBaseUrl(url);
+      const paramsToSend = await this.buildQueryParams(context, params);
+      let finalUrl = url.startsWith('http') ? url : `${baseUrl}${url}`;
+      const hasKeys = Object.keys(paramsToSend).length > 0;
+
+      if (paramsToSend && hasKeys) {
+        const urlParams = new URLSearchParams(paramsToSend);
+        finalUrl += `?${urlParams}`;
+      }
+
+      return finalUrl;
+    };
+
+    this.buildQueryParams = async (context, params) => {
+      if (!params) {
+        params = {};
+      }
+
+      const additionalQueryParams = await this.getAdditionalQueryParams(context);
+
+      for (const queryParam of additionalQueryParams) {
+        params[queryParam.key] = queryParam.value;
+      }
+
+      const keys = Object.keys(params);
+
+      for (const key of keys) {
+        const value = params[key];
+        params[key] = typeof value === 'object' ? JSON.stringify(value) : value;
+      }
+
+      return params;
+    };
+
+    this.getAdditionalQueryParams = async context => {
+      let output = [];
+
+      if (context.additionalQueryParamsResolver) {
+        output = await context.additionalQueryParamsResolver();
+      }
+
+      return output;
+    };
+
+    this.getAdditionalHeaders = async context => {
+      let output = [];
+
+      if (context.additionalHeadersResolver) {
+        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
+          });
+        }
+      }
+
+      if (context.appId) {
+        output.push({
+          key: 'frontegg-requested-application-id',
+          value: context.appId
+        });
+      }
+
+      return output;
+    };
+
+    this.buildRequestHeaders = async contentType => {
+      var _context$tokenResolve;
+
+      const fronteggContext = this.getFronteggContext();
+      const context = fronteggContext.getContext();
+      const headers = FetchClient.getMetadataHeaders(context);
+      const authToken = await ((_context$tokenResolve = context == null ? void 0 : context.tokenResolver) != null ? _context$tokenResolve : fronteggContext.getAccessToken)();
+      const requestSource = fronteggContext.getRequestSource();
+      const scopedTenant = FetchClient.getScopedTenant();
+
+      if (contentType) {
+        headers[fronteggHeaders.contentType] = contentType;
+      }
+
+      if (requestSource) {
+        headers[fronteggHeaders.source] = requestSource;
+      }
+
+      if (authToken) {
+        headers.Authorization = `Bearer ${authToken}`;
+      }
+
+      if (scopedTenant) {
+        headers[fronteggHeaders.scopedTenant] = scopedTenant;
+      }
+
+      for (const additionalHeader of await this.getAdditionalHeaders(context)) {
+        headers[`${additionalHeader.key}`] = `${additionalHeader.value}`;
+      }
+
+      return headers;
+    };
+
+    this.sendRequest = async opts => {
+      var _opts$method, _ref, _opts$credentials;
+
+      const context = this.getFronteggContext().getContext();
+      const headers = await this.buildRequestHeaders(opts.contentType);
+      const url = await this.prepareUrl(opts.url, opts.params);
+      const response = await fetch(url, {
+        body: opts.body ? opts.contentType === 'application/json' ? JSON.stringify(opts.body) : opts.body : null,
+        method: (_opts$method = opts.method) != null ? _opts$method : 'GET',
+        headers: _extends({}, headers, opts.headers),
+        credentials: (_ref = (_opts$credentials = opts.credentials) != null ? _opts$credentials : context.requestCredentials) != null ? _ref : 'same-origin'
+      });
+
+      if (response.status === 302) {
+        window.location.href = await response.text();
+        return new Promise(() => {});
+      }
+
+      if (!response.ok) {
+        var _context$logLevel, _context$logLevel2;
+
+        if (response.status === 413) {
+          throw new FronteggApiError('Error request is too large', response.status);
+        }
+
+        let errorMessage;
+        let isJsonResponse = true;
+
+        try {
+          errorMessage = await response.text();
+          errorMessage = JSON.parse(errorMessage);
+        } catch (e) {
+          isJsonResponse = false;
+        }
+
+        if (errorMessage.errors) {
+          errorMessage = errorMessage.errors.join(', ');
+        } else if (typeof errorMessage !== 'string') {
+          errorMessage = `Error ${response.status} - ${response.statusText}`;
+        }
+
+        if (response.status >= 400 && response.status < 500 && ['warn'].includes((_context$logLevel = context.logLevel) != null ? _context$logLevel : '')) console.warn(errorMessage);else if (response.status === 500 && ['warn', 'error'].includes((_context$logLevel2 = context.logLevel) != null ? _context$logLevel2 : '')) console.error(errorMessage);
+        throw new FronteggApiError(isJsonResponse ? errorMessage : GENERIC_ERROR_MESSAGE, response.status);
+      }
+
+      if (!opts.responseType || opts.responseType === 'json') {
+        try {
+          return await response.json();
+        } catch (e) {
+          return {};
+        }
+      } else if (opts.responseType === 'blob') {
+        const {
+          outputFileName
+        } = opts.params;
+        return await response.blob().then(blob => URL.createObjectURL(blob)).then(url => {
+          const tempLink = document.createElement('a');
+          tempLink.href = url;
+          tempLink.setAttribute('download', outputFileName || 'output');
+          tempLink.click();
+        });
+      } else {
+        return await response.text();
+      }
+    };
+
+    this.get = async (url, params, opts) => this.sendRequest(_extends({
+      url,
+      method: 'GET',
+      contentType: 'application/json',
+      params
+    }, opts));
+
+    this.post = async (url, body, opts) => this.sendRequest(_extends({
+      url,
+      method: 'POST',
+      contentType: 'application/json',
+      body
+    }, opts));
+
+    this.patch = async (url, body, opts) => this.sendRequest(_extends({
+      url,
+      method: 'PATCH',
+      contentType: 'application/json',
+      body
+    }, opts));
+
+    this.put = async (url, body, opts) => this.sendRequest(_extends({
+      url,
+      method: 'PUT',
+      contentType: 'application/json',
+      body
+    }, opts));
+
+    this.delete = async (url, body, opts) => this.sendRequest(_extends({
+      url,
+      method: 'DELETE',
+      contentType: 'application/json',
+      body
+    }, opts));
+
+    this.postDownload = async (url, body, params, opts) => this.sendRequest(_extends({
+      url,
+      method: 'POST',
+      contentType: 'application/json',
+      responseType: 'blob',
+      body,
+      params
+    }, opts));
+
+    this.extractHeadersFromOptions = (options = {}) => _extends({}, options.jwt ? {
+      Authorization: options.jwt
+    } : {});
+
+    this.getBaseUrl = (context, url, withFronteggPrefix = true) => {
+      return FetchClient.getBaseUrl(context, url, withFronteggPrefix);
+    };
+
+    this.getContextBaseUrl = (url, withFronteggPrefix = true) => {
+      const context = this.getFronteggContext().getContext();
+      return this.getBaseUrl(context, url, withFronteggPrefix);
+    };
+
+    this.getMetadataHeaders = context => {
+      return FetchClient.getMetadataHeaders(context);
+    };
+
+    this.getContextMetadataHeaders = () => {
+      const context = this.getFronteggContext().getContext();
+      return FetchClient.getMetadataHeaders(context);
+    };
+
+    this.appName = appName;
+  }
+
+}
+
+FetchClient.getBaseUrl = (context, url, withFronteggPrefix = true) => {
+  let baseUrl;
+
+  if (typeof context.baseUrl === 'function') {
+    baseUrl = context.baseUrl(url);
+  } else {
+    baseUrl = context.baseUrl;
+  }
+
+  const prefix = context.urlPrefix || 'frontegg';
+  const removePrefix = prefix === 'frontegg' && !withFronteggPrefix;
+
+  if (!baseUrl.endsWith('/')) {
+    baseUrl += '/';
+  }
+
+  if (!baseUrl.endsWith(prefix) && !removePrefix) {
+    baseUrl += prefix;
+  }
+
+  return baseUrl;
+};
+
+FetchClient.getMetadataHeaders = context => {
+  var _context$metadataHead, _context$metadataHead2;
+
+  const headers = {};
+
+  if (context != null && (_context$metadataHead = context.metadataHeaders) != null && _context$metadataHead.fronteggSdkVersion) {
+    headers[fronteggHeaders.fronteggSdkVersion] = context.metadataHeaders.fronteggSdkVersion;
+  }
+
+  if (context != null && (_context$metadataHead2 = context.metadataHeaders) != null && _context$metadataHead2.framework) {
+    headers[fronteggHeaders.frameWork] = context.metadataHeaders.framework;
+  }
+
+  return headers;
+};
+
+FetchClient.getScopedTenant = () => {
+  const urlParams = new URLSearchParams(window.location.search);
+  const scopedTenant = urlParams.get('tenantId');
+
+  if (scopedTenant) {
+    return scopedTenant;
+  }
+
+  return null;
+};
+
+export default new FetchClient('default');

package/account-settings/index.d.ts

@@ -1,9 +1,21 @@
 import { IPublicSettingsResponse, ISettingsResponse, IUpdateSettings } from "./interfaces";
 import { UserJwtOptions } from "../interfaces";
-/*** update account settings for tenant.
- * tenantId is caclulated in the backend from context
- * ``authorized user``
- */
-export declare function updateSettings(body: IUpdateSettings, options?: UserJwtOptions): Promise<ISettingsResponse>;
-export declare function getSettings(options?: UserJwtOptions): Promise<ISettingsResponse>;
-export declare function getPublicSettings(): Promise<IPublicSettingsResponse>;
+import { BaseApiClient } from '../BaseApiClient';
+export declare class AccountSettingsApi extends BaseApiClient {
+    constructor(appName: string);
+    /**
+     * Update account settings for a tenant.
+     * TenantId is calculated in the backend from context of the `authorized user`.
+     */
+    updateSettings: (body: IUpdateSettings, options?: UserJwtOptions | undefined) => Promise<ISettingsResponse>;
+    /**
+     * Get account settings for a tenant.
+     */
+    getSettings: (options?: UserJwtOptions | undefined) => Promise<ISettingsResponse>;
+    /**
+     * Get public account settings.
+     */
+    getPublicSettings: () => Promise<IPublicSettingsResponse>;
+}
+declare const _default: AccountSettingsApi;
+export default _default;

package/account-settings/index.js

@@ -1,15 +1,25 @@
 import { urls } from "../constants";
-import { extractHeadersFromOptions, Get, Put } from "../fetch";
-export async function updateSettings(body, options) {
-  return Put(urls.tenants.accountSettings.v1, body, {
-    headers: extractHeadersFromOptions(options)
-  });
+import { BaseApiClient } from '../BaseApiClient';
+export class AccountSettingsApi extends BaseApiClient {
+  constructor(appName) {
+    super(appName);
+
+    this.updateSettings = async (body, options) => {
+      return this.put(urls.tenants.accountSettings.v1, body, {
+        headers: this.extractHeadersFromOptions(options)
+      });
+    };
+
+    this.getSettings = async options => {
+      return this.get(urls.tenants.accountSettings.v1, undefined, {
+        headers: this.extractHeadersFromOptions(options)
+      });
+    };
+
+    this.getPublicSettings = async () => {
+      return this.get(`${urls.tenants.accountSettings.v1}/public`);
+    };
+  }
+
 }
-export async function getSettings(options) {
-  return Get(urls.tenants.accountSettings.v1, undefined, {
-    headers: extractHeadersFromOptions(options)
-  });
-}
-export async function getPublicSettings() {
-  return Get(`${urls.tenants.accountSettings.v1}/public`);
-}
+export default new AccountSettingsApi('default');

package/applications/index.d.ts

@@ -1,46 +1,51 @@
-import { IUserApplicationsIdPayload, IUserApplicationsDataPayload, IApplicationsResponse, IAssignUserToApplicationsBody, IUsersApplicationsIdPayload, IUsersOfApplicationsResponse, ITenantApplicationsResponse, IGetUsersOfApplicationsQuery, IUsersApplicationsIdsResponse } from "./interfaces";
+import { BaseApiClient } from '../BaseApiClient';
+import { IUserApplicationsIdPayload, IUserApplicationsDataPayload, IApplicationsResponse, IAssignUserToApplicationsBody, IUsersApplicationsIdPayload, IUsersOfApplicationsResponse, ITenantApplicationsResponse, IGetUsersOfApplicationsQuery, IUsersApplicationsIdsResponse } from './interfaces';
 /**
- * Get applications id array for single user by user id
- * @param userId - user id to find his applications id array
- * @returns all app ids as string[]
+ * UsersApplicationsApi class for handling applications-related operations.
  */
-export declare function getUserApplicationsId({ userId }: IUserApplicationsIdPayload): Promise<string[]>;
-/**
- * Get applications id array for multiple users by user id array
- * @param userIds - array of all user id's
- * @returns object that maps every user id to his applications id array
- */
-export declare function getUsersApplicationsId({ userIds }: IUsersApplicationsIdPayload): Promise<IUsersApplicationsIdsResponse[]>;
-/**
- * Get applications data array for specific tenant
- * @returns array of object with tenant id and his applications id array
- */
-export declare function getTenantsApplications(): Promise<ITenantApplicationsResponse[]>;
-/**
- * Get applications data by array of application ids
- * @param appIds - array of application ids
- * @returns array of application data
- */
-export declare function getApplicationsData({ appIds, includeFreeAccess }: IUserApplicationsDataPayload): Promise<IApplicationsResponse[]>;
-/**
- * Assign user to multiple applications
- * @param appIds - string[]
- * @param tenantId - string
- * @param userId - string
- * @returns void
- */
-export declare function assignUserToApplications(body: IAssignUserToApplicationsBody): Promise<void>;
-/**
- * Unassign user from multiple applications
- * @param appIds - string[]
- * @param tenantId - string
- * @param userId - string
- * @returns void
- */
-export declare function unassignUserFromApplications(body: IAssignUserToApplicationsBody): Promise<void>;
-/**
- * Get users array for each application for array of applications
- * @param appIds - array of applications
- * @returns array of objects with application id and his users array
- */
-export declare function getUsersOfApplications({ appIds }: IGetUsersOfApplicationsQuery): Promise<IUsersOfApplicationsResponse[]>;
+export declare class ApplicationsApi extends BaseApiClient {
+    constructor(appName: string);
+    /**
+     * Get applications id array for a single user by user id.
+     * @param {IUserApplicationsIdPayload} param0 - user id to find their applications id array.
+     * @returns {Promise<string[]>} all app ids as string[].
+     */
+    getUserApplicationsId: ({ userId }: IUserApplicationsIdPayload) => Promise<string[]>;
+    /**
+     * Get applications id array for multiple users by user id array.
+     * @param {IUsersApplicationsIdPayload} param0 - array of all user ids.
+     * @returns {Promise<IUsersApplicationsIdsResponse[]>} object that maps every user id to its applications id array.
+     */
+    getUsersApplicationsId: ({ userIds }: IUsersApplicationsIdPayload) => Promise<IUsersApplicationsIdsResponse[]>;
+    /**
+     * Get applications data array for a specific tenant.
+     * @returns {Promise<ITenantApplicationsResponse[]>} array of objects with tenant id and its applications id array.
+     */
+    getTenantsApplications: () => Promise<ITenantApplicationsResponse[]>;
+    /**
+     * Get applications data by array of application ids.
+     * @param {IUserApplicationsDataPayload} param0 - array of application ids.
+     * @returns {Promise<IApplicationsResponse[]>} array of application data.
+     */
+    getApplicationsData: ({ appIds, includeFreeAccess }: IUserApplicationsDataPayload) => Promise<IApplicationsResponse[]>;
+    /**
+     * Assign user to multiple applications.
+     * @param {IAssignUserToApplicationsBody} body - assignment details.
+     * @returns {Promise<void>}
+     */
+    assignUserToApplications: (body: IAssignUserToApplicationsBody) => Promise<void>;
+    /**
+     * Unassign user from multiple applications.
+     * @param {IAssignUserToApplicationsBody} body - unassignment details.
+     * @returns {Promise<void>}
+     */
+    unassignUserFromApplications: (body: IAssignUserToApplicationsBody) => Promise<void>;
+    /**
+     * Get users array for each application for an array of applications.
+     * @param {IGetUsersOfApplicationsQuery} param0 - array of applications.
+     * @returns {Promise<IUsersOfApplicationsResponse[]>} array of objects with application id and its users array.
+     */
+    getUsersOfApplications: ({ appIds }: IGetUsersOfApplicationsQuery) => Promise<IUsersOfApplicationsResponse[]>;
+}
+declare const _default: ApplicationsApi;
+export default _default;

package/applications/index.js

@@ -1,39 +1,53 @@
 import { urls } from "../constants";
-import { Post, Get, Delete } from "../fetch";
-export async function getUserApplicationsId({
-  userId
-}) {
-  return Get(`${urls.identity.applications.v1}/${userId}/apps`);
+import { BaseApiClient } from '../BaseApiClient';
+export class ApplicationsApi extends BaseApiClient {
+  constructor(appName) {
+    super(appName);
+
+    this.getUserApplicationsId = async ({
+      userId
+    }) => {
+      return this.get(`${urls.identity.applications.v1}/${userId}/apps`);
+    };
+
+    this.getUsersApplicationsId = async ({
+      userIds
+    }) => {
+      return this.get(`${urls.identity.applications.v1}/users-apps`, {
+        userIds: userIds.join(',')
+      });
+    };
+
+    this.getTenantsApplications = async () => {
+      return this.get(urls.applications.tenant.v1);
+    };
+
+    this.getApplicationsData = async ({
+      appIds,
+      includeFreeAccess = true
+    }) => {
+      return this.get(urls.applications.v1, {
+        ids: appIds.join(','),
+        _includeFreeAccess: includeFreeAccess
+      });
+    };
+
+    this.assignUserToApplications = async body => {
+      return this.post(`${urls.identity.applications.v1}/apps-user`, body);
+    };
+
+    this.unassignUserFromApplications = async body => {
+      return this.delete(`${urls.identity.applications.v1}/user-apps`, body);
+    };
+
+    this.getUsersOfApplications = async ({
+      appIds
+    }) => {
+      return this.get(`${urls.identity.applications.v1}/apps-users`, {
+        appIds: appIds.join(',')
+      });
+    };
+  }
+
 }
-export async function getUsersApplicationsId({
-  userIds
-}) {
-  return Get(`${urls.identity.applications.v1}/users-apps`, {
-    userIds: userIds.join(',')
-  });
-}
-export async function getTenantsApplications() {
-  return Get(urls.applications.tenant.v1);
-}
-export async function getApplicationsData({
-  appIds,
-  includeFreeAccess = true
-}) {
-  return Get(urls.applications.v1, {
-    ids: appIds.join(','),
-    _includeFreeAccess: includeFreeAccess
-  });
-}
-export async function assignUserToApplications(body) {
-  return Post(`${urls.identity.applications.v1}/apps-user`, body);
-}
-export async function unassignUserFromApplications(body) {
-  return Delete(`${urls.identity.applications.v1}/user-apps`, body);
-}
-export async function getUsersOfApplications({
-  appIds
-}) {
-  return Get(`${urls.identity.applications.v1}/apps-users`, {
-    appIds: appIds.join(',')
-  });
-}
+export default new ApplicationsApi('default');

package/audits/index.d.ts

@@ -1,16 +1,28 @@
 import { IAudits, IAuditsStats, IGetAuditsParams, IGetAuditsStatsParams, IExportAudits } from './interfaces';
-/*****************************************
- * Audits Api
- *****************************************/
-/**
- * get Audits
- */
-export declare function getAudits(params: IGetAuditsParams): Promise<IAudits>;
-/**
- * get Audits Stats
- */
-export declare function getAuditsStats(params: IGetAuditsStatsParams): Promise<IAuditsStats>;
-/**
- * export Audits
- */
-export declare function exportAudits(params: IExportAudits): Promise<any>;
+import { BaseApiClient } from '../BaseApiClient';
+export declare class AuditsApi extends BaseApiClient {
+    constructor(appName: string);
+    /**
+     * Fetches audit logs based on the provided parameters.
+     *
+     * @param params - Parameters to filter and paginate audits.
+     * @returns A promise that resolves to the list of audits.
+     */
+    getAudits: (params: IGetAuditsParams) => Promise<IAudits>;
+    /**
+     * Retrieves audit statistics based on the provided parameters.
+     *
+     * @param params - Parameters to filter and define the scope of the stats.
+     * @returns A promise that resolves to the audits statistics.
+     */
+    getAuditsStats: (params: IGetAuditsStatsParams) => Promise<IAuditsStats>;
+    /**
+     * Exports audit logs based on the provided parameters.
+     *
+     * @param params - Parameters including endpoint, header properties, and other request specifics.
+     * @returns A promise that initiates a download for the exported audits.
+     */
+    exportAudits: (params: IExportAudits) => Promise<void>;
+}
+declare const _default: AuditsApi;
+export default _default;

package/audits/index.js

@@ -1,21 +1,31 @@
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 const _excluded = ["endpoint", "headerProps"];
-import { Get, PostDownload } from '../fetch';
 import { urls } from '../constants';
-export async function getAudits(params) {
-  return Get(urls.audits.v1, params);
-}
-export async function getAuditsStats(params) {
-  return Get(`${urls.audits.v1}/stats`, params);
-}
-export async function exportAudits(params) {
-  const {
-    endpoint,
-    headerProps
-  } = params,
-        restParams = _objectWithoutPropertiesLoose(params, _excluded);
+import { BaseApiClient } from '../BaseApiClient';
+export class AuditsApi extends BaseApiClient {
+  constructor(appName) {
+    super(appName);
+
+    this.getAudits = async params => {
+      return this.get(urls.audits.v1, params);
+    };
+
+    this.getAuditsStats = async params => {
+      return this.get(`${urls.audits.v1}/stats`, params);
+    };
 
-  return PostDownload(`${urls.audits.v1}/export/${endpoint}`, {
-    properties: headerProps
-  }, restParams);
-}
+    this.exportAudits = async params => {
+      const {
+        endpoint,
+        headerProps
+      } = params,
+            restParams = _objectWithoutPropertiesLoose(params, _excluded);
+
+      return this.postDownload(`${urls.audits.v1}/export/${endpoint}`, {
+        properties: headerProps
+      }, restParams);
+    };
+  }
+
+}
+export default new AuditsApi('default');