@frontegg/rest-api 2.10.90 → 3.0.1

package/src/connectivity/index.ts

@@ -1,160 +0,0 @@
-import { urls } from '../constants';
-import { Get, Patch, Post, Delete, Put } from '../fetch';
-import {
-  IWebhookTest,
-  IWebhooksSaveData,
-  ISlackSubscription,
-  IEmailSMSConfigResponse,
-  IEmailSMSSubscriptionResponse,
-} from './interfaces';
-
-export const getSlackConfiguration = () => {
-  console.debug('getSlackConfiguration()');
-  return Get(`${urls.integrations.configurations.v1}/slack`);
-};
-
-export const getSlackScope = () => {
-  console.debug('getSlackScope()');
-  return Get(`${urls.integrations.configurations.v1}/slack/applications`);
-};
-
-export const getSlackChannels = () => {
-  console.debug('getSlackChannels()');
-  return Get(`${urls.integrations.configurations.v1}/slack/channels`);
-};
-
-export const postSlackConfiguration = (data: ISlackSubscription) => {
-  console.debug('postSlackConfiguration()', data);
-  if (data.id) {
-    return Patch(`${urls.integrations.configurations.v1}/slack/subscription/${data.id}`, data);
-  }
-  return Post(`${urls.integrations.configurations.v1}/slack/subscriptions`, data);
-};
-export const deleteSlackConfiguration = (data: Required<ISlackSubscription>) => {
-  console.debug('deleteSlackConfiguration()', data);
-  return Delete(`${urls.integrations.configurations.v1}/slack/subscriptions/${data.id}`);
-};
-
-export const postSlackCode = (code: string) => {
-  console.debug('postSlackCode()', { code });
-  return Post(`${urls.integrations.configurations.v1}/slack/applications/registrations`, { code });
-};
-
-export const getEmailConfiguration = (): Promise<IEmailSMSConfigResponse[]> => {
-  console.debug('getEmailConfiguration()');
-  return Get(`${urls.integrations.configurations.v1}/emails`);
-};
-
-export const postEmailConfiguration = ({ eventKey, ...data }: IEmailSMSConfigResponse): Promise<null> => {
-  console.debug('postEmailConfiguration()', { ...data, eventKey });
-  return Post(`${urls.integrations.configurations.v1}/emails/${eventKey}`, data);
-};
-
-export const patchEmailConfiguration = ({
-  eventKey,
-  enabled,
-}: Pick<IEmailSMSConfigResponse, 'eventKey' | 'enabled'>): Promise<null> => {
-  console.debug('patchEmailConfiguration()', { eventKey, enabled });
-  return Patch(`${urls.integrations.configurations.v1}/emails/${eventKey}`, { enabled });
-};
-
-export const deleteEmailSubscriptions = (eventKey: string, subscriptionId: string): Promise<null> => {
-  console.debug('deleteEmailSubscriptions()', { eventKey, subscriptionId });
-  return Delete(`${urls.integrations.configurations.v1}/emails/${eventKey}/subscriptions/${subscriptionId}`);
-};
-
-export const putEmailSubscriptions = (
-  subscriptionId: string,
-  eventKey: string,
-  data: IEmailSMSSubscriptionResponse
-): Promise<null> => {
-  console.debug('putEmailSubscriptions()', { ...data, subscriptionId, eventKey });
-  return Put(`${urls.integrations.configurations.v1}/emails/${eventKey}/subscriptions/${subscriptionId}`, data);
-};
-
-export const deleteEmailConfiguration = (eventKey: string): Promise<null> => {
-  console.debug('deleteEmailConfiguration()', { eventKey });
-  return Delete(`${urls.integrations.configurations.v1}/emails/${eventKey}`);
-};
-
-export const getSMSConfiguration = (): Promise<IEmailSMSConfigResponse[]> => {
-  console.debug('getSMSConfiguration()');
-  return Get(`${urls.integrations.configurations.v2}/sms`);
-};
-
-export const postSMSConfiguration = ({ eventKey, ...data }: IEmailSMSConfigResponse) => {
-  console.debug('postSMSConfiguration()', { ...data, eventKey });
-  return Post(`${urls.integrations.configurations.v2}/sms/${eventKey}`, data);
-};
-
-export const patchSMSConfiguration = ({
-  eventKey,
-  enabled,
-}: Pick<IEmailSMSConfigResponse, 'eventKey' | 'enabled'>): Promise<null> => {
-  console.debug('patchSMSConfiguration()', { eventKey, enabled });
-  return Patch(`${urls.integrations.configurations.v2}/sms/${eventKey}`, { enabled });
-};
-
-export const deleteSMSSubscriptions = (eventKey: string, subscriptionId: string): Promise<null> => {
-  console.debug('deleteSMSSubscriptions()', { eventKey, subscriptionId });
-  return Delete(`${urls.integrations.configurations.v2}/sms/${eventKey}/subscriptions/${subscriptionId}`);
-};
-
-export const putSMSSubscriptions = (
-  subscriptionId: string,
-  eventKey: string,
-  data: IEmailSMSSubscriptionResponse
-): Promise<null> => {
-  console.debug('putSMSSubscriptions()', { ...data, subscriptionId, eventKey });
-  return Put(`${urls.integrations.configurations.v2}/sms/${eventKey}/subscriptions/${subscriptionId}`, data);
-};
-
-export const deleteSMSConfiguration = (eventKey: string): Promise<null> => {
-  console.debug('deleteSMSConfiguration()', { eventKey });
-  return Delete(`${urls.integrations.configurations.v2}/sms/${eventKey}`);
-};
-
-export const getWebhooksConfigurations = () => {
-  console.debug('getWebhooksConfigurations()');
-  return Get(urls.webhooks.v1);
-};
-
-export const postWebhooksConfiguration = (data: IWebhooksSaveData) => {
-  console.debug('postWebhooksConfiguration()', data);
-  if (data._id) {
-    return Patch(`${urls.webhooks.v1}/${data._id}`, data);
-  } else {
-    return Post(`${urls.webhooks.v1}/custom`, data);
-  }
-};
-
-export const deleteWebhooksConfiguration = (id: string): Promise<null> => {
-  console.debug('deleteWebhooksConfiguration()', id);
-  return Delete(`${urls.webhooks.v1}/${id}`);
-};
-
-export const getWebhookLog = (id: string, offset: number = 0, limit: number = 10) => {
-  console.debug('getWebhookLog()', id);
-  const query = new URLSearchParams({ id, offset: `${offset}`, limit: `${limit}` });
-  return Get(`${urls.webhooks.v1}/logs/?${query.toString()}`);
-};
-
-export const postWebhookTest = (data: IWebhookTest) => {
-  console.debug('postWebhookTest', data);
-  return Post(`${urls.webhooks.v1}/test`, data);
-};
-
-export const postWebhookRetry = (id: string) => {
-  console.debug('postWebhookRetry', id);
-  return Post(`${urls.webhooks.v1}/logs/${id}/retries`);
-};
-
-export const getCategories = () => {
-  console.debug('getCategories()');
-  return Get(`${urls.events.configurations.v1}/categories`);
-};
-
-export const getChannelMaps = (channels: string) => {
-  console.debug('getChannelMaps()', channels);
-  return Get(urls.events.configurations.v1, { channels });
-};

package/src/connectivity/interfaces.ts

@@ -1,106 +0,0 @@
-export interface ISlackConfigurations {
-  id: string;
-  slackSubscriptions: ISlackSubscription[];
-}
-
-export interface ISlackSubscription {
-  id?: string;
-  isActive: boolean;
-  slackEvents: ISlackEvent[];
-}
-
-export interface ISlackEvent {
-  eventKey: string;
-  channelIds: string[];
-  title?: string;
-  message?: string;
-}
-
-export interface IEmailSMSConfigResponse {
-  eventKey: string;
-  enabled: boolean;
-  subscriptions: IEmailSMSSubscriptionResponse[];
-}
-
-export interface IEmailSMSSubscriptionResponse {
-  id?: string;
-  name: string;
-  enabled: boolean;
-  recipients: string[];
-}
-
-export interface IWebhookTest {
-  url: string;
-  secret: string | null;
-  payload?: object;
-}
-export interface IWebhooksSaveData extends IWebhookTest {
-  _id?: string;
-  displayName: string;
-  description: string;
-  eventKeys: string[];
-  isActive: boolean;
-}
-export interface IWebhooksConfigurations extends Omit<IWebhooksSaveData, '_id'> {
-  _id: string;
-  invocations: number;
-  createdAt: string;
-  updatedAt: string;
-}
-
-export interface IMainField {
-  id: string;
-  createdAt: string;
-  updatedAt: string;
-  vendorId: string;
-}
-
-export interface IEvent extends IMainField {
-  key: string;
-  displayName: string;
-  description?: string;
-  category?: string;
-  categoryId?: string;
-}
-
-export interface ICategory extends IMainField {
-  name: string;
-  events?: IEvent[];
-}
-
-export interface ISlackChannel {
-  id: string;
-  name: string;
-}
-
-export interface IChannelsMap {
-  id: string;
-  key: string;
-  categoryId: string;
-  vendorId: string;
-  displayName: string;
-  description: string;
-  createdAt: string;
-  updatedAt: string;
-  category: {
-    id: string;
-    vendorId: string;
-    name: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-}
-
-export interface IWebhookLogsResponse {
-  count: number;
-  rows: IWebhookLog[];
-}
-export interface IWebhookLog {
-  body: string;
-  createdAt: string;
-  id: string;
-  statusCode: string;
-  tenantId: string;
-  vendorId: string;
-  webhookId: string;
-}

package/src/error.ts

@@ -1,13 +0,0 @@
-
-export class FronteggApiError extends Error {
-  private readonly _statusCode: number;
-
-  constructor(message: string, statusCode: number) {
-    super(message);
-    this._statusCode = statusCode;
-  }
-
-  get statusCode(): number {
-    return this._statusCode;
-  }
-}

package/src/fetch.ts

@@ -1,220 +0,0 @@
-import { ContextHolder } from './ContextHolder';
-import { ContextOptions, KeyValuePair } from './interfaces';
-import { FronteggApiError } from './error';
-
-interface RequestOptions {
-  url: string;
-  method: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
-  body?: any;
-  params?: any;
-  contentType?: string;
-  responseType?: 'json' | 'plain' | 'blob';
-  headers?: Record<string, string>;
-  credentials?: RequestCredentials;
-}
-
-export function getBaseUrl(context: ContextOptions, url: string): string {
-  let baseUrl;
-  if (typeof context.baseUrl === 'function') {
-    baseUrl = context.baseUrl(url);
-  } else {
-    baseUrl = context.baseUrl;
-  }
-  const prefix = context.urlPrefix || 'frontegg';
-  if (!baseUrl.endsWith('/')) {
-    baseUrl += '/';
-  }
-  if (!baseUrl.endsWith(prefix)) {
-    baseUrl += prefix;
-  }
-  return baseUrl;
-}
-
-async function prepareUrl(context: ContextOptions, url: string, params?: any): Promise<string> {
-  const baseUrl = getBaseUrl(context, url);
-  const paramsToSend = await 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;
-}
-
-async function buildRequestHeaders(
-  context: ContextOptions,
-  contentType: string | undefined
-): Promise<Record<string, string>> {
-  const authToken = await (context?.tokenResolver ?? ContextHolder.getAccessToken)();
-  const headers: Record<string, string> = {};
-  if (authToken) {
-    headers.Authorization = `Bearer ${authToken}`;
-  }
-  if (contentType) {
-    headers['Content-Type'] = contentType;
-  }
-  for (const additionalHeader of await getAdditionalHeaders(context)) {
-    headers[`${additionalHeader.key}`] = `${additionalHeader.value}`;
-  }
-  headers['x-frontegg-source'] = 'frontegg-react';
-  return headers;
-}
-
-async function buildQueryParams(context: ContextOptions, params?: any) {
-  if (!params) {
-    params = {};
-  }
-
-  const additionalQueryParams = await 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;
-}
-
-async function getAdditionalQueryParams(context: ContextOptions): Promise<KeyValuePair[]> {
-  let output: KeyValuePair[] = [];
-  if (context.additionalQueryParamsResolver) {
-    output = await context.additionalQueryParamsResolver();
-  }
-  return output;
-}
-
-async function getAdditionalHeaders(context: ContextOptions): Promise<KeyValuePair[]> {
-  let output: KeyValuePair[] = [];
-  if (context.additionalHeadersResolver) {
-    output = await context.additionalHeadersResolver();
-  }
-  return output;
-}
-
-const sendRequest = async (opts: RequestOptions) => {
-  const context = ContextHolder.getContext();
-  const headers = await buildRequestHeaders(context, opts.contentType);
-  const url = await prepareUrl(context, 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 ?? 'GET',
-    headers: {
-      ...headers,
-      ...opts.headers,
-    },
-    credentials: opts.credentials ?? context.requestCredentials ?? 'same-origin',
-  });
-
-  if (response.status === 302) {
-    window.location.href = await response.text();
-    return new Promise(() => {
-    });
-  }
-  if (!response.ok) {
-    if (response.status === 413) {
-      throw new FronteggApiError('Error request is too large', response.status);
-    }
-    let errorMessage;
-    try {
-      errorMessage = await response.text();
-      errorMessage = JSON.parse(errorMessage);
-    } catch (e) {
-    }
-    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 ?? ''))
-      console.warn(errorMessage);
-    else if (response.status === 500 && [ 'warn', 'error' ].includes(context.logLevel ?? '')) console.error(errorMessage);
-
-    throw new FronteggApiError(errorMessage, 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();
-  }
-};
-
-export const Get = async (url: string, params?: any, opts?: Omit<RequestOptions, 'method' | 'url'>) =>
-  sendRequest({
-    url,
-    method: 'GET',
-    contentType: 'application/json',
-    params,
-    ...opts,
-  });
-
-export const Post = async (url: string, body?: any, opts?: Omit<RequestOptions, 'method' | 'url'>) =>
-  sendRequest({
-    url,
-    method: 'POST',
-    contentType: 'application/json',
-    body,
-    ...opts,
-  });
-
-export const Patch = async (url: string, body?: any, opts?: Omit<RequestOptions, 'method' | 'url'>) =>
-  sendRequest({
-    url,
-    method: 'PATCH',
-    contentType: 'application/json',
-    body,
-    ...opts,
-  });
-
-export const Put = async (url: string, body?: any, opts?: Omit<RequestOptions, 'method' | 'url'>) =>
-  sendRequest({
-    url,
-    method: 'PUT',
-    contentType: 'application/json',
-    body,
-    ...opts,
-  });
-
-export const Delete = async (url: string, body?: any, opts?: Omit<RequestOptions, 'method' | 'url'>) =>
-  sendRequest({
-    url,
-    method: 'DELETE',
-    contentType: 'application/json',
-    body,
-    ...opts,
-  });
-
-export const PostDownload = async (url: string, body?: any, params?: any, opts?: any) =>
-  sendRequest({
-    url,
-    method: 'POST',
-    contentType: 'application/json',
-    responseType: 'blob',
-    body,
-    params,
-    ...opts,
-  });

package/src/index.ts

@@ -1,86 +0,0 @@
-import * as auth from './auth';
-import * as teams from './teams';
-import * as metadata from './metadata';
-import * as reports from './reports';
-import * as notifications from './notifications';
-import * as audits from './audits';
-import * as fetch from './fetch';
-import * as connectivity from './connectivity';
-import * as tenants from './tenants';
-import * as accountSettings from './account-settings';
-import * as roles from './roles';
-import * as subscriptions from './subscriptions';
-import {FronteggApiError} from './error';
-import * as vendor from './vendor';
-import * as subTenants from './sub-tenants';
-
-import {ContextHolder, FronteggContext} from './ContextHolder';
-
-export * from './interfaces';
-export * from './auth/interfaces';
-export * from './teams/interfaces';
-export * from './metadata/interfaces';
-export * from './reports/interfaces';
-export * from './connectivity/interfaces';
-export * from './notifications/interfaces';
-export * from './audits/interfaces';
-export * from './tenants/interfaces';
-export * from './account-settings/interfaces';
-export * from './roles/interfaces';
-export * from './subscriptions/interfaces';
-export * from './vendor/interfaces';
-export * from './sub-tenants/interfaces';
-export * from './routers';
-
-import {AuthStrategyEnum, SocialLoginProviders} from './auth'
-import {
-  ISubscriptionCancellationPolicy,
-  ISubscriptionStatus,
-  PaymentMethodType,
-  ProviderType
-} from './subscriptions'
-
-const api = {
-  auth,
-  teams,
-  metadata,
-  reports,
-  connectivity,
-  notifications,
-  audits,
-  tenants,
-  accountSettings,
-  roles,
-  subscriptions,
-  vendor,
-  subTenants
-};
-
-export {
-  fetch,
-  ContextHolder,
-  FronteggContext,
-  api,
-  FronteggApiError,
-  AuthStrategyEnum,
-  SocialLoginProviders,
-  ISubscriptionCancellationPolicy,
-  ISubscriptionStatus,
-  PaymentMethodType,
-  ProviderType,
-};
-
-export default {
-  fetch,
-  ContextHolder,
-  FronteggContext,
-  api,
-  FronteggApiError,
-  AuthStrategyEnum,
-  SocialLoginProviders,
-  ISubscriptionCancellationPolicy,
-  ISubscriptionStatus,
-  PaymentMethodType,
-  ProviderType,
-};
-

package/src/interfaces.ts

@@ -1,47 +0,0 @@
-export interface IFronteggRecord {
-  __frontegg__loader?: boolean;
-  __frontegg__error?: boolean;
-}
-
-export interface PaginationResult<T> {
-  totalPages: number;
-  items: T[];
-}
-
-export interface KeyValuePair {
-  key: string;
-  value: string;
-}
-
-export type LogLevel = 'warn' | 'error';
-
-export interface ContextOptions {
-  baseUrl: string | ((url: string) => string);
-  clientId?: string;
-  tokenResolver?: () => Promise<string> | string; // custom resolve Authorization Header value
-  additionalQueryParamsResolver?: () => Promise<KeyValuePair[]> | KeyValuePair[];
-  additionalHeadersResolver?: () => Promise<KeyValuePair[]> | KeyValuePair[];
-  currentUserRoles?: string[];
-  requestCredentials?: RequestCredentials;
-  urlPrefix?: string;
-  logLevel?: LogLevel;
-  auditsOptions?: {
-    virtualScroll?: boolean;
-  };
-}
-
-export interface QuerySort {
-  id: string;
-  desc?: boolean;
-}
-
-export interface QueryFilter {
-  id: string;
-  value: any;
-}
-
-export interface RedirectOptions {
-  refresh?: boolean;
-  replace?: boolean;
-  preserveQueryParams?: boolean;
-}