@frontegg/rest-api 2.10.90 → 3.0.3

package/src/metadata/index.ts

@@ -1,24 +0,0 @@
-import { Get } from '../fetch';
-import { IAuditsMetadata, IGetMetadata, IMetadataIp, INotificationMetadata, ISamlMetadata } from './interfaces';
-
-async function getMetadata(body: IGetMetadata) {
-  const data = await Get('/metadata', body);
-  if (data?.rows?.[0]) return data?.rows?.[0];
-
-  throw new Error(`metadata not found: ${body.entityName}`);
-}
-
-async function getIpMetadata(ip: string) {
-  const data = await Get(`/metadata/ip/${ip}`);
-  if (data) return data;
-
-  throw new Error(`ip metadata not found`);
-}
-
-export const getNotificationsMetadata = async (): Promise<INotificationMetadata> =>
-  getMetadata({ entityName: 'notifications' });
-export const getSamlMetadata = async (): Promise<ISamlMetadata> => getMetadata({ entityName: 'saml' });
-
-export const getAuditsMetadata = async (): Promise<IAuditsMetadata> => getMetadata({ entityName: 'audits' });
-
-export const getIpAdressMetadata = async (ip: string): Promise<IMetadataIp> => getIpMetadata(ip);

package/src/metadata/interfaces.ts

@@ -1,51 +0,0 @@
-export type IGetMetadata = Pick<IBaseMetadata, 'entityName'>;
-
-interface IBaseMetadata {
-  entityName: 'saml' | 'notifications' | 'audits';
-  id: string;
-  createdAt: string;
-  updatedAt: string;
-  properties: any[];
-  vendorId: string;
-}
-
-export type IMetadataTheme = {
-  id: string;
-  name: string;
-  styles: any;
-};
-
-export interface INotificationMetadata extends IBaseMetadata {
-  entityName: 'notifications';
-  channels: string[];
-  channelsConfig: string[];
-  severities: any[];
-  theme: IMetadataTheme;
-}
-
-export interface ISamlMetadata extends IBaseMetadata {
-  entityName: 'saml';
-  isActive: boolean;
-  configuration: {
-    acsUrl: string;
-    spEntityId: string;
-  };
-}
-
-export interface IAuditsMetadata extends IBaseMetadata {
-  entityName: 'audits';
-  theme: IMetadataTheme;
-}
-
-export interface IMetadataIp {
-  latitude: number;
-  longitude: number;
-  city: string | null;
-  country_name: string | null;
-  country_code: string | null;
-  zip: string | null;
-  location: {
-    country_flag?: string | null;
-    country_flag_emoji?: string | null;
-  };
-}

package/src/notifications/index.ts

@@ -1,40 +0,0 @@
-import {Get, Post, Put} from '../fetch';
-import {urls} from '../constants';
-import {ILoadMessages, IMessage, IUpdateNotificationStatus, IUpdateNotificationIsPinned} from './interfaces';
-
-/**
- * get Notifications
- */
-
-export async function getNotifications(params: ILoadMessages): Promise<Array<IMessage>> {
-  console.debug('getNotifications()');
-  return Get(urls.notifications.v1, {params});
-}
-
-/**
- * update Notification status
- */
-
-export async function updateNotificationStatus(params: IUpdateNotificationStatus): Promise<void> {
-  console.debug('getNotifications()');
-  return Put(`${urls.notifications.v1}/status`, {params});
-}
-
-/**
- * update Notification pin status
- */
-
-export async function updateNotificationIsPinned(params: IUpdateNotificationIsPinned): Promise<any> {
-  const {notificationId, pinStatus} = params;
-  console.debug('getNotifications()');
-  return Put(`${urls.notifications.v1}/${pinStatus}`, {notificationId});
-}
-
-/**
- * mark all notifications as read
- */
-
-export async function markAllAsRead(): Promise<void> {
-  console.debug('getNotifications()');
-  return Post(`${urls.notifications.v1}/status/mark-all-read`);
-}

package/src/notifications/interfaces.ts

@@ -1,45 +0,0 @@
-export interface ILoadMessages {
-  count: number;
-  offset: number;
-}
-
-export interface IMessages {
-  data: Array<IMessage>;
-  current: number;
-  total: number | null;
-  unreadCount: number;
-}
-
-export interface IMessage {
-  actions: INotificationAction[];
-  id: string;
-  title: string;
-  body: string;
-  severity: string;
-  url: string;
-  viewed: boolean;
-  createdAt: string;
-  status: string;
-  isPinned: boolean;
-  key: string;
-}
-
-export interface INotificationAction {
-  visualization: string;
-  id: string;
-  name: string;
-  url: string;
-  method: string;
-  createdAt: string;
-  updatedAt: string;
-}
-
-export interface IUpdateNotificationStatus {
-  notificationId: string;
-  status: 'read' | 'unread' | 'archived';
-}
-
-export interface IUpdateNotificationIsPinned {
-  pinStatus: 'pin' | 'unpin';
-  notificationId: string;
-}

package/src/reports/index.ts

@@ -1,116 +0,0 @@
-/* tslint:disable:no-console */
-import {
-  IDownloadReport,
-  IGetReport,
-  IGetReports,
-  IRenderReport,
-  IRenderReportResponse,
-  IReportRecord,
-  IScheduleReport,
-  ISendReport,
-} from './interfaces';
-import {Get, Post} from '../fetch';
-import {urls} from '../constants';
-
-/**
- * Get all active tenant reports from reports service by active vendor.
- * Optional: pass filters and sort options to reports.
- *
- * @returns list of reports objects
- */
-export async function getReports(body: IGetReports): Promise<IReportRecord[]> {
-  console.debug('getReports()', body);
-  return Get(`${urls.reports.service.v2}/tenant-reports`, body);
-}
-
-/**
- * Get report record by id.
- *
- * @returns list of report object
- * @throws exception if report not found.
- */
-export async function getReport(body: IGetReport): Promise<IReportRecord> {
-  console.debug('getReport()', body);
-  return Get(`${urls.reports.service.v2}/${body.id}/tenant-reports`);
-}
-
-/**
- * Render report by id.
- * Optional: pass data filters if exists to render report by specific data.
- *
- * @returns html content of the rendered reports
- * @throws exception if report not found or the data api unreached.
- */
-export async function renderReport({dataFilters, ...body}: IRenderReport): Promise<IRenderReportResponse> {
-  console.debug('renderReport()', body);
-  const html = await Get(`${urls.reports.trigger.v1}/preview-report`,
-    {
-      ...body,
-      dataFilters: btoa(JSON.stringify(dataFilters || {})),
-      responseType: 'html',
-    },
-    {responseType: 'plain'}
-  );
-  return {html};
-}
-
-/**
- * schedule report by providing cron expression and data filters.
- *
- * @returns the updated report object
- * @throws exception if report not found or the data api unreached.
- */
-export async function scheduleReport({templateId, dataFilters, ...body}: IScheduleReport): Promise<IReportRecord> {
-  console.debug('scheduleReport()', body);
-  return Post(`${urls.reports.service.v2}/${templateId}/tenant-reports`, {
-    ...body,
-    dataFilters: btoa(JSON.stringify(dataFilters || {})),
-  });
-}
-
-/**
- * download report as file in specific format.
- * this function will add a href element with url to trigger file download.
- * Optional: pass data filters if exists to generate report by specific data.
- *
- * @throws exception if report not found or the data api unreached.
- */
-export async function downloadReport({dataFilters, ...body}: IDownloadReport): Promise<void> {
-  console.debug('downloadReport()', body);
-  const blob = await Get(`${urls.reports.trigger.v1}/preview-report`,
-    {
-      ...body,
-      dataFilters: btoa(JSON.stringify(dataFilters || {})),
-    },
-    {responseType: 'blob'}
-  );
-  let contentType = 'text/html';
-  let contentExt = 'html';
-  if (body.responseType === 'pdf') {
-    contentType = 'application/pdf';
-    contentExt = 'pdf';
-  } else if (body.responseType === 'image') {
-    contentType = 'image/jpeg';
-    contentExt = 'jpg';
-  }
-
-  const newBlob = new Blob([blob], {type: contentType});
-
-  const fileURL = URL.createObjectURL(newBlob);
-  const tempLink = document.createElement('a');
-  tempLink.href = fileURL;
-  tempLink.setAttribute('download', `report_${body.name || ''}.${contentExt}`);
-  tempLink.click();
-  setTimeout(tempLink.remove.bind(tempLink));
-}
-
-/**
- * send report to specific email address.
- * Optional: pass data filters if exists to send report by specific data.
- *
- * @throws exception if report not found or the data api unreached.
- */
-export async function sendReport(body: ISendReport): Promise<void> {
-  console.debug('sendReport()', body);
-  return Post(`${urls.reports.trigger.v1}/tenant-reports`, body);
-}

package/src/reports/interfaces.ts

@@ -1,167 +0,0 @@
-import { IFronteggRecord } from '../interfaces';
-
-export interface ReportSchedule {
-  interval: 'daily' | 'weekly' | 'monthly' | 'custom';
-  cron: string;
-  tz: string;
-  active: boolean;
-  dataFilters?: { [K in string]: any };
-}
-
-export interface IReportRecord extends IFronteggRecord {
-  id: string;
-  name: string;
-  description: string;
-  schedule?: ReportSchedule;
-  status: string;
-  updatedAt: string;
-  createdAt: string;
-  htmlTemplate: string;
-  customerListApiUrl: string;
-  type: 'html' | 'pdf' | 'image';
-  dataFilters?: {
-    type: string;
-    config: DataFilter;
-  }[];
-}
-
-export interface DataFilterBase {
-  name: string;
-  label: string;
-}
-
-export interface DataFilterText extends DataFilterBase {
-  type: 'text';
-  placeholder?: string;
-  defaultValue?: string;
-  validation?: 'email' | 'url' | 'phone' | string;
-  validationError?: string;
-}
-
-export interface DataFilterNumber extends DataFilterBase {
-  type: 'number';
-  placeholder?: string;
-  defaultValue?: string;
-  min?: string;
-  max?: string;
-  integer: boolean;
-}
-
-export interface DataFilterBoolean extends DataFilterBase {
-  type: 'boolean';
-  defaultValue?: boolean;
-  trueLabel?: string;
-  falseLabel?: string;
-  trueValue?: string;
-  falseValue?: string;
-}
-
-export interface DataFilterSelect extends DataFilterBase {
-  type: 'select';
-  placeholder?: string;
-  defaultValue?: any;
-  options: { label: string; value: any }[];
-}
-
-export interface DataFilterMultiSelect extends DataFilterBase {
-  type: 'multi-select';
-  placeholder?: string;
-  defaultValue?: any[];
-  options: { label: string; value: any }[];
-}
-
-export interface DataFilterDate extends DataFilterBase {
-  type: 'date';
-  defaultValue?: {
-    startDate?: number;
-    endDate?: number;
-  };
-  placeholder?: {
-    startDate?: number;
-    endDate?: number;
-  };
-  isRange?: boolean;
-  maxDate?: {
-    type: 'fixed' | 'from-now';
-    value: number;
-  };
-  minDate?: {
-    type: 'fixed' | 'from-now';
-    value: number;
-  };
-}
-
-export interface DataFilterRelativeDate extends DataFilterBase {
-  type: 'relative-date';
-  defaultValue?: {
-    type: 'current' | 'last';
-    period: 'seconds' | 'minutes' | 'hours' | 'day' | 'week' | 'month' | 'year';
-    value: number;
-  };
-  periods: ('seconds' | 'minutes' | 'hours' | 'day' | 'week' | 'month' | 'year')[];
-}
-
-export type DataFilter =
-  | DataFilterText
-  | DataFilterNumber
-  | DataFilterBoolean
-  | DataFilterSelect
-  | DataFilterMultiSelect
-  | DataFilterDate
-  | DataFilterRelativeDate;
-
-export type ReportColumnsNames = 'name' | 'schedule' | 'status' | 'updatedAt' | 'createdAt';
-
-export interface IReportFilterBy {
-  column: ReportColumnsNames;
-  filterType: 'equal';
-  value: any;
-}
-
-export interface IReportsFilter {
-  query?: string;
-  filterBy?: IReportFilterBy;
-}
-
-export interface IReportsSort {
-  column: ReportColumnsNames;
-  direction: 'asc' | 'desc';
-}
-
-export interface IGetReports {
-  filters?: IReportsFilter;
-  sort?: IReportsSort;
-}
-
-export interface IGetReport {
-  id: string;
-}
-
-export interface IRenderReport {
-  templateId: string;
-  dataFilters?: any;
-}
-
-export interface IRenderReportResponse {
-  html: string;
-}
-
-export interface IScheduleReport {
-  templateId: string;
-  schedule: ReportSchedule;
-  status: string;
-  dataFilters: any;
-  type: 'html' | 'pdf' | 'image';
-}
-
-export interface IDownloadReport {
-  templateId: string;
-  name: string;
-  dataFilters: any;
-  responseType: 'image' | 'pdf' | 'html';
-}
-
-export interface ISendReport {
-  templateId: string;
-  to: string[];
-}

package/src/roles/index.ts

@@ -1,80 +0,0 @@
-import {
-  IRole,
-  IRolePermission,
-  IRolePermissionCategory,
-  IAddRole,
-  IDeleteRole,
-  IUpdateRole,
-  IAttachPermissionsToRole,
-  IAttachPermissionToRoles,
-} from './interfaces';
-import {Delete, Get, Patch, Post, Put} from '../fetch';
-import {urls} from '../constants';
-
-/**
- * Gets tenant related roles
- */
-export async function getRoles(): Promise<IRole[]> {
-  console.debug('getRoles()');
-  return Get(urls.identity.roles.v1);
-}
-
-/**
- * Adds tenant related roles
- * @param body: IAddRole
- */
-export async function addRole(body: IAddRole): Promise<IRole> {
-  console.debug('addRole()', body);
-  return Post(urls.identity.roles.v1, body);
-}
-
-/**
- * Deletes role given role ID
- */
-export async function deleteRole({roleId}: IDeleteRole): Promise<void> {
-  console.debug('deleteRole()', roleId);
-  return Delete(`${urls.identity.roles.v1}/${roleId}`);
-}
-
-/**
- * Updates role using a given role ID and IUpdateRole object
- */
-export async function updateRole({roleId, ...body}: IUpdateRole): Promise<IRole> {
-  console.debug('updateRole()', roleId, body);
-  return Patch(`${urls.identity.roles.v1}/${roleId}`, body);
-}
-
-/**
- * Attaches permissions to role given a role ID
- */
-export async function attachPermissionsToRole({roleId, ...body}: IAttachPermissionsToRole): Promise<IRole> {
-  console.debug('attachPermissionsToRole()', roleId, body);
-  return Put(`${urls.identity.roles.v1}/${roleId}/permissions`, body);
-}
-
-/**
- * Gets all vendor permissions
- */
-export async function getPermissions(): Promise<IRolePermission[]> {
-  console.debug('getPermissions()');
-  return Get(urls.identity.permissions.v1);
-}
-
-/**
- * Associate permission to roles
- */
-export async function attachPermissionToRoles({
-                                                permissionId,
-                                                ...body
-                                              }: IAttachPermissionToRoles): Promise<IRolePermission> {
-  console.debug('attachPermissionToRoles()');
-  return Put(`${urls.identity.permissions.v1}/${permissionId}/roles`, body);
-}
-
-/**
- * Gets all vendor categories including the permissions
- */
-export async function getPermissionCategories(): Promise<IRolePermissionCategory[]> {
-  console.debug('getPermissionCategories()');
-  return Get(`${urls.identity.permissions.v1}/categories`);
-}

package/src/roles/interfaces.ts

@@ -1,64 +0,0 @@
-export type IRole = {
-  id: string;
-  key: string;
-  isDefault: boolean;
-  name: string;
-  description?: null;
-  permissions: string[];
-  tenantId?: string;
-  vendorId: string;
-  createdAt: Date;
-  updatedAt: Date;
-};
-export type IRolePermission = {
-  id: string;
-  key: string;
-  name: string;
-  description?: string;
-  categoryId: string;
-  fePermission: boolean;
-  createdAt: Date;
-  updatedAt: Date;
-};
-
-export type IRolePermissionCategory = {
-  id: string;
-  name: string;
-  description: string;
-  feCategory: boolean;
-  permissionIds: string[];
-  createdAt: Date;
-  updatedAt: Date;
-};
-
-export type IAddRole = {
-  key: string;
-  name: string;
-  description: string;
-  isDefault: boolean;
-  level: number;
-  permissions: string[];
-};
-
-export type IUpdateRole = {
-  roleId: string;
-  key?: string;
-  name?: string;
-  description?: string;
-  isDefault?: boolean;
-  level?: number;
-};
-
-export type IDeleteRole = {
-  roleId: string;
-};
-
-export type IAttachPermissionsToRole = {
-  roleId: string;
-  permissionIds: string[];
-};
-
-export type IAttachPermissionToRoles = {
-  permissionId: string;
-  roleIds: string[];
-};

package/src/routers.ts

@@ -1,18 +0,0 @@
-import { urls } from './constants';
-
-export const fronteggAuthApiRoutes = [
-  `${urls.identity.auth.v1}/logout`,
-  `${urls.identity.auth.v1}/user/saml/postlogin`,
-  `${urls.identity.auth.v2}/user/oidc/postlogin`,
-  `${urls.identity.auth.v1}/user`,
-  `${urls.identity.auth.v1}/user/mfa/verify`,
-  `${urls.identity.auth.v1}/user/token/refresh`,
-  `${urls.identity.users.v1}`,
-  `${urls.identity.auth.v1}/passwordless/magiclink/postlogin`,
-  `${urls.identity.auth.v1}/passwordless/code/postlogin`,
-  `${urls.identity.auth.v1}/passwordless/smscode/postlogin`,
-  `${urls.identity.users.v1}/activate`,
-  `${urls.identity.users.v1}/invitation/accept`
-]
-
-export const fronteggRefreshTokenUrl = `${urls.identity.auth.v1}/user/token/refresh`;

package/src/sub-tenants/index.ts

@@ -1,49 +0,0 @@
-import { PaginationResult } from "../interfaces";
-import { Delete, Get, Patch, Post } from "../fetch";
-import { urls } from "../constants";
-import {
-  AddUserToSubTenantsRequest,
-  ILoadAllUsers,
-  ISubTenantUser,
-  RemoveUserFromSubTenantsRequest,
-  UpdateUserRolesForSubTenantsRequestDto,
-} from "./interfaces";
-
-export async function loadAllUsers(
-  params: ILoadAllUsers
-): Promise<PaginationResult<ISubTenantUser>> {
-  return Get(urls.identity.subTenants.v1, params);
-}
-
-export async function addUserToTenantAndSubTenants(
-  body: AddUserToSubTenantsRequest
-): Promise<void> {
-  return Post(urls.identity.subTenants.v1, body);
-}
-
-export async function removeUserFromTenantAndSubTenants(
-  body: RemoveUserFromSubTenantsRequest
-): Promise<void> {
-  return Delete(urls.identity.subTenants.v1, body);
-}
-
-export async function addUserRolesForSubTenants(
-  userId: string,
-  body: UpdateUserRolesForSubTenantsRequestDto
-): Promise<void> {
-  return Post(`${urls.identity.subTenants.v1}/${userId}/roles`, body);
-}
-
-export async function removeUserRolesFromSubTenants(
-  userId: string,
-  body: UpdateUserRolesForSubTenantsRequestDto
-): Promise<void> {
-  return Delete(`${urls.identity.subTenants.v1}/${userId}/roles`, body);
-}
-
-export async function setUserRolesForSubTenants(
-  userId: string,
-  body: UpdateUserRolesForSubTenantsRequestDto
-): Promise<void> {
-  return Patch(`${urls.identity.subTenants.v1}/${userId}/roles`, body);
-}