@frontegg/rest-api 6.0.1-alpha.4 → 7.28.0-alpha.0

package/user-phone-numbers/index.js

@@ -0,0 +1,31 @@
+import { urls } from '../constants';
+import { BaseApiClient } from '../BaseApiClient';
+export class PhoneNumbersApi extends BaseApiClient {
+  constructor(appName) {
+    super(appName);
+    this.getUserPhoneNumbers = async queryParams => {
+      return this.get(`${urls.identity.phoneNumbers.v1}`, queryParams);
+    };
+    this.createPhoneNumber = async body => {
+      return this.post(`${urls.identity.phoneNumbers.v1}`, body);
+    };
+    this.deletePhoneNumber = async phoneId => {
+      return this.delete(`${urls.identity.phoneNumbers.v1}/${phoneId}`);
+    };
+    this.preVerifyPhoneNumber = async body => {
+      return this.post(`${urls.identity.phoneNumbers.v1}/preverify`, body);
+    };
+    this.verifyPhoneNumber = async body => {
+      return this.post(`${urls.identity.phoneNumbers.v1}/verify`, body);
+    };
+    this.verifyDeletePhoneNumber = async (phoneId, body) => {
+      return this.post(`${urls.identity.phoneNumbers.v1}/${phoneId}/delete/verify`, body);
+    };
+  }
+
+  /**
+   * Get phone numbers of user
+   */
+}
+
+export default new PhoneNumbersApi('default');

package/user-phone-numbers/interfaces.d.ts

@@ -0,0 +1,32 @@
+export interface IGetPhoneNumbersQueryParams {
+    _limit?: number;
+    _offset?: number;
+}
+export type IPhoneNumber = {
+    id: string;
+    phoneNumber: string;
+    verified: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export type IUpdatePhoneNumber = {
+    phoneNumber: string;
+    verify?: boolean;
+};
+export interface IPreVerifyPhoneNumber {
+    phoneNumber: string;
+}
+export interface IVerifyPhoneNumber {
+    otcToken: string;
+    code: string;
+}
+export interface ICreatePhoneNumberResponse {
+    otcToken?: string;
+}
+export interface IPreVerifyPhoneNumberResponse {
+    otcToken: string;
+}
+export interface IDeletePhoneNumberResponse {
+    phoneId: string;
+    otcToken: string;
+}

package/user-phone-numbers/interfaces.js

@@ -0,0 +1 @@
+export {};

package/user-phone-numbers/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/user-phone-numbers/index.js",
+  "types": "./index.d.ts"
+}

package/users/index.d.ts

@@ -0,0 +1,24 @@
+import { GetCurrentUserTenantsResponse, GetUserGroupsParams, GetUserGroupsResponse, GetUserJwtRequestDto, GetUserJwtResponseDto, GetUserRolesResponse, GetUsersRolesParams, IGetUsersV2Response, ISearchUserQueryParamsV2, ISearchUserQueryParamsV3, IUnlockMeRequest, IUpdateUserDto, IUserProfile, IUsersV3Data } from './interfaces';
+import { FronteggPaginationWrapper, UserJwtOptions } from '../interfaces';
+import { BaseApiClient } from '../BaseApiClient';
+export declare class UsersApi extends BaseApiClient {
+    constructor(appName: string);
+    GetUserJwt: (body: GetUserJwtRequestDto) => Promise<GetUserJwtResponseDto>;
+    getUsersV2: (queryParams: ISearchUserQueryParamsV2, options?: UserJwtOptions) => Promise<FronteggPaginationWrapper<IGetUsersV2Response>>;
+    getUsersV3: (queryParams: ISearchUserQueryParamsV3, options?: UserJwtOptions) => Promise<FronteggPaginationWrapper<IUsersV3Data>>;
+    getUsersRoles: (queryParams: GetUsersRolesParams, options?: UserJwtOptions) => Promise<GetUserRolesResponse[]>;
+    getUsersGroups: (queryParams: GetUserGroupsParams, options?: UserJwtOptions) => Promise<GetUserGroupsResponse[]>;
+    /**
+     * get user tenant and user tenants by user active tenant
+     */
+    getCurrentUserTenantsV3: (options?: UserJwtOptions) => Promise<GetCurrentUserTenantsResponse>;
+    /**
+     * get user tenant and user tenants by context tenant
+     */
+    getCurrentUserTenantsV1: (options?: UserJwtOptions) => Promise<GetCurrentUserTenantsResponse>;
+    sendResetBreachedPasswordEmails: () => Promise<void>;
+    updateUserProfileV2: (body: Partial<IUpdateUserDto>) => Promise<IUserProfile>;
+    unlockMe: (body: IUnlockMeRequest) => Promise<void>;
+}
+declare const _default: UsersApi;
+export default _default;

package/users/index.js

@@ -0,0 +1,55 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import { urls } from '../constants';
+import { BaseApiClient } from '../BaseApiClient';
+export class UsersApi extends BaseApiClient {
+  constructor(appName) {
+    super(appName);
+    this.GetUserJwt = async body => {
+      return this.post(`${urls.identity.users.v3}/me/token`, body);
+    };
+    this.getUsersV2 = async (queryParams, options) => {
+      return this.get(urls.identity.users.v2, queryParams, {
+        headers: this.extractHeadersFromOptions(options)
+      });
+    };
+    this.getUsersV3 = async (queryParams, options) => {
+      return this.get(urls.identity.users.v3, queryParams, {
+        headers: this.extractHeadersFromOptions(options)
+      });
+    };
+    this.getUsersRoles = async (queryParams, options) => {
+      return this.get(urls.identity.users.roles.v3, _extends({}, queryParams, {
+        ids: queryParams.ids.join(',')
+      }), {
+        headers: this.extractHeadersFromOptions(options)
+      });
+    };
+    this.getUsersGroups = async (queryParams, options) => {
+      return this.get(urls.identity.users.groups.v3, _extends({}, queryParams, {
+        ids: queryParams.ids.join(',')
+      }), {
+        headers: this.extractHeadersFromOptions(options)
+      });
+    };
+    this.getCurrentUserTenantsV3 = async options => {
+      return this.get(urls.identity.users.tenants.me.v3, undefined, {
+        headers: this.extractHeadersFromOptions(options)
+      });
+    };
+    this.getCurrentUserTenantsV1 = async options => {
+      return this.get(urls.identity.users.tenants.me.v1, undefined, {
+        headers: this.extractHeadersFromOptions(options)
+      });
+    };
+    this.sendResetBreachedPasswordEmails = async () => {
+      return this.post(urls.identity.users.passwords.resetBreachedPasswords.v1);
+    };
+    this.updateUserProfileV2 = async body => {
+      return this.put(`${urls.identity.users.v2}/me`, body);
+    };
+    this.unlockMe = async body => {
+      return this.post(`${urls.identity.users.v3}/me/unlock`, body);
+    };
+  }
+}
+export default new UsersApi('default');

package/users/interfaces.d.ts

@@ -0,0 +1,144 @@
+import { PaginationOrderEnum } from '../interfaces';
+import { ITenantsResponse } from '../tenants/interfaces';
+import { IRole } from '../roles/interfaces';
+import { ITeamUserPermission, UserManagedByEnum } from '../teams/interfaces';
+import { IGroupResponse } from '../groups/interfaces';
+import { UserEntitlementsContext as UserEntitlementsResponseV2 } from '@frontegg/entitlements-javascript-commons';
+export declare enum SortByEnum {
+    createdAt = "createdAt",
+    name = "name",
+    email = "email",
+    id = "id",
+    verified = "verified",
+    isLocked = "isLocked",
+    provider = "provider",
+    tenantId = "tenantId"
+}
+export interface GetUserJwtRequestDto {
+    tenantId: string;
+}
+export interface GetUserJwtResponseDto {
+    accessToken: string;
+    expires: string;
+    expiresIn: number;
+}
+export interface IGetUserQueryParams {
+    _limit?: number;
+    _offset?: number;
+    ids?: string;
+    _sortBy?: SortByEnum;
+    _order?: PaginationOrderEnum;
+}
+export interface ISearchUserQueryParamsV2 extends IGetUserQueryParams {
+    _filter?: string;
+    metadata?: string;
+    _includeSubTenants?: boolean;
+}
+export interface ISearchUserQueryParamsV3 extends IGetUserQueryParams {
+    _email?: string;
+    _tenantId?: string;
+    _includeSubTenants?: boolean;
+    _preset?: GetUsersFilterPreset;
+    _maxInactiveSeconds?: number;
+}
+export interface IUserTenantData {
+    tenantId: string;
+    roles: IRole[];
+}
+export interface IBaseUserData {
+    id: string;
+    email: string;
+    name: string;
+    /**
+     * @deprecated
+     * use profilePictureUrl instead
+     */
+    profileImage?: string;
+    profilePictureUrl?: string | null;
+}
+export interface IBaseGetUserResponse extends IBaseUserData {
+    sub: string;
+    verified: boolean;
+    mfaEnrolled: boolean;
+    mfaBypass?: boolean;
+    phoneNumber?: string;
+    provider?: string;
+    tenantId: string;
+    tenantIds: string[];
+    activatedForTenant?: boolean;
+    isLocked?: boolean;
+    tenants: IUserTenantData[];
+    managedBy?: UserManagedByEnum;
+    invisible?: true;
+    superUser?: true;
+    metadata: string;
+    createdAt?: Date;
+    lastLogin?: Date;
+    subAccountAccessAllowed?: boolean;
+    temporaryExpirationDate?: Date;
+    isDisabled?: boolean;
+    entitlements?: UserEntitlementsResponseV2;
+}
+export type IUserProfile = IGetUsersV2Response;
+export interface IGetUsersV2Response extends IBaseGetUserResponse {
+    roles: IRole[];
+    /**
+     * @deprecated
+     * use roles instead
+     */
+    rolesIds?: string[];
+    permissions: ITeamUserPermission[];
+    groups?: Pick<IGroupResponse, 'id' | 'roles'>[];
+}
+export interface IGetUserAuthorizationResponse {
+    permissions: ITeamUserPermission[];
+    roles: IRole[];
+}
+export type IUsersV3Data = IBaseGetUserResponse;
+export declare enum GetUsersFilterPreset {
+    MFA_UNENROLLED = "mfa-unenrolled",
+    BREACHED_PASSWORDS = "breached-passwords",
+    INACTIVE = "inactive"
+}
+export interface GetUsersRolesParams {
+    ids: string[];
+}
+export interface GetUserRolesResponse {
+    vendorId: string;
+    tenantId: string;
+    userId: string;
+    roleIds: string[];
+}
+export interface GetUserGroupsParams {
+    ids: string[];
+}
+export interface GetUserGroupsResponse {
+    vendorId: string;
+    tenantId: string;
+    userId: string;
+    groupIds: string[];
+}
+export interface GetCurrentUserTenantsResponse {
+    tenants: ITenantsResponse[];
+    activeTenant: ITenantsResponse;
+}
+export interface IUpdateUserDto {
+    userAgent: string;
+    ipAddress: string;
+    name?: string;
+    phoneNumber?: string;
+    profilePictureUrl?: string | null;
+    metadata?: string;
+    sourceMetadata?: SourceMetadata;
+    provider?: typeof providersArray[number];
+    managedBy?: UserManagedByEnum;
+}
+export interface SourceMetadata {
+    source: 'SCIM';
+    sourceVersion: number;
+    sourceId: string;
+}
+export declare const providersArray: string[];
+export interface IUnlockMeRequest {
+    token: string;
+}

package/users/interfaces.js

@@ -0,0 +1,18 @@
+export let SortByEnum;
+(function (SortByEnum) {
+  SortByEnum["createdAt"] = "createdAt";
+  SortByEnum["name"] = "name";
+  SortByEnum["email"] = "email";
+  SortByEnum["id"] = "id";
+  SortByEnum["verified"] = "verified";
+  SortByEnum["isLocked"] = "isLocked";
+  SortByEnum["provider"] = "provider";
+  SortByEnum["tenantId"] = "tenantId";
+})(SortByEnum || (SortByEnum = {}));
+export let GetUsersFilterPreset;
+(function (GetUsersFilterPreset) {
+  GetUsersFilterPreset["MFA_UNENROLLED"] = "mfa-unenrolled";
+  GetUsersFilterPreset["BREACHED_PASSWORDS"] = "breached-passwords";
+  GetUsersFilterPreset["INACTIVE"] = "inactive";
+})(GetUsersFilterPreset || (GetUsersFilterPreset = {}));
+export const providersArray = ['local', 'saml', 'google', 'github', 'facebook', 'microsoft', 'scim2', 'slack'];

package/users/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/users/index.js",
+  "types": "./index.d.ts"
+}

package/velo/index.d.ts

@@ -0,0 +1,46 @@
+import { IGetVeloConversationPayload, IGetVeloConversationResourcePayload, ISendVeloConversationApiResponsePayload, ISendVeloConversationMessagePayload, IVeloAgentConfigResponse, IVeloConversationResource, IVeloConversationsResponse, IVeloMessageStream } from './interfaces';
+import { BaseApiClient } from '../BaseApiClient';
+export declare class VeloApi extends BaseApiClient {
+    constructor(appName: string);
+    /**
+     * Get Velo agents config
+     * @returns {Promise<IVeloAgentConfigResponse[]>}
+     */
+    getAgentsConfig: () => Promise<{
+        agents: IVeloAgentConfigResponse[];
+    }>;
+    /**
+     * Get Velo conversations list
+     * @returns {Promise<IVeloConversationsResponse[]>}
+     */
+    getConversations: () => Promise<{
+        conversations: IVeloConversationsResponse[];
+    }>;
+    /**
+     * Get Velo conversation by id
+     * @returns {Promise<IVeloConversationsResponse>}
+     */
+    getConversationById: (payload: IGetVeloConversationPayload) => Promise<IVeloConversationsResponse>;
+    /**
+     * Create a new conversation and send the prompt message
+     * @returns {Promise<IVeloMessageStream>}
+     */
+    createConversation: (payload: Omit<ISendVeloConversationMessagePayload, "conversationId">) => Promise<IVeloMessageStream>;
+    /**
+     * Send a new conversation message
+     * @returns {Promise<IVeloMessageStream>}
+     */
+    sendMessage: (payload: ISendVeloConversationMessagePayload) => Promise<IVeloMessageStream>;
+    /**
+     * Send an api response conversation message
+     * @returns {Promise<IVeloMessageStream>}
+     */
+    sendApiResponse: (payload: ISendVeloConversationApiResponsePayload) => Promise<IVeloMessageStream>;
+    /**
+     * Send an api response conversation message
+     * @returns {Promise<IVeloMessageStream>}
+     */
+    getConversationResource: (payload: IGetVeloConversationResourcePayload) => Promise<IVeloConversationResource>;
+}
+declare const _default: VeloApi;
+export default _default;

package/velo/index.js

@@ -0,0 +1,68 @@
+import { urls } from '../constants';
+import { BaseApiClient } from '../BaseApiClient';
+const VeloDebugHeaders = {
+  'x-frontegg-api-key': 'my-frontegg-api-key',
+  'frontegg-vendor-id': '04ae2174-d8d9-4a90-8bab-2548e210a508',
+  'frontegg-tenant-id': '02e6ab6f-8b25-48e4-b06d-2c53745ce213',
+  'frontegg-user-id': 'e5c397a1-7120-4753-9216-e5d7f35d1f2d'
+};
+export class VeloApi extends BaseApiClient {
+  constructor(appName) {
+    super(appName);
+    this.getAgentsConfig = async () => {
+      return this.get(`${urls.velo.v1}/config`, undefined, {
+        headers: VeloDebugHeaders
+      });
+    };
+    this.getConversations = async () => {
+      return this.get(`${urls.velo.v1}/conversations`, undefined, {
+        headers: VeloDebugHeaders
+      });
+    };
+    this.getConversationById = async payload => {
+      return this.get(`${urls.velo.v1}/conversation/${payload.id}`, undefined, {
+        headers: VeloDebugHeaders
+      });
+    };
+    this.createConversation = async payload => {
+      return this.post(`${urls.velo.v1}/conversations`, {
+        message: payload.message,
+        stream: payload.stream
+      }, {
+        responseType: payload.stream === false ? 'json' : 'stream',
+        headers: VeloDebugHeaders
+      });
+    };
+    this.sendMessage = async payload => {
+      return this.post(`${urls.velo.v1}/conversation/${payload.conversationId}/messages`, {
+        message: payload.message,
+        stream: payload.stream
+      }, {
+        responseType: payload.stream === false ? 'json' : 'stream',
+        headers: VeloDebugHeaders
+      });
+    };
+    this.sendApiResponse = async payload => {
+      return this.post(`${urls.velo.v1}/conversation/${payload.conversationId}/response/${payload.callId}`, {
+        data: payload.data,
+        status: payload.status,
+        stream: payload.stream
+      }, {
+        responseType: payload.stream === false ? 'json' : 'stream',
+        headers: VeloDebugHeaders
+      });
+    };
+    this.getConversationResource = async payload => {
+      return this.get(`${urls.velo.v1}/conversation/${payload.conversationId}/resource/${payload.resourceId}`, undefined, {
+        headers: VeloDebugHeaders
+      });
+    };
+  }
+
+  /**
+   * Get Velo agents config
+   * @returns {Promise<IVeloAgentConfigResponse[]>}
+   */
+}
+
+export default new VeloApi('default');

package/velo/interfaces.d.ts

@@ -0,0 +1,108 @@
+export interface IVeloApiCallMessage {
+    /**
+     * The role of the messages author, in this case `tool`.
+     */
+    role: 'tool';
+    /**
+     * The id of the tool call.
+     */
+    tool_call_id: string;
+    /**
+     * The url to call in the API.
+     */
+    url: string;
+    /**
+     * The method to use in the API call.
+     */
+    method: string;
+    /**
+     * The body of the API call.
+     */
+    body: Record<string, string>;
+    /**
+     * The message to display while the API call is loading.
+     */
+    loadingMessage: string;
+}
+export interface IVeloUserMessage {
+    /**
+     * The role of the messages author, in this case `user`.
+     */
+    role: 'user';
+    /**
+     * The contents of the user message.
+     */
+    content: string;
+    /**
+     * An optional name for the participant. Provides the model information to
+     * differentiate between participants of the same role.
+     */
+    name?: string;
+}
+export interface IVeloAssistantMessage {
+    /**
+     * The contents of the user message.
+     */
+    content: string;
+    /**
+     * The role of the messages author, in this case `user`.
+     */
+    role: 'user';
+    /**
+     * An optional name for the participant. Provides the model information to
+     * differentiate between participants of the same role.
+     */
+    name?: string;
+}
+export type IVeloConversationMessageResponse = IVeloApiCallMessage | IVeloUserMessage | IVeloAssistantMessage;
+export interface IGetVeloConversationPayload {
+    id: string;
+}
+export interface IVeloConversationsResponse {
+    id: string;
+    title: string;
+    messages: IVeloConversationMessageResponse[];
+    createdAt: string;
+    updatedAt: string;
+}
+type Localized<T> = {
+    en: T;
+    [key: string]: T;
+};
+interface IModelQuickActionsResponse {
+    icon: string;
+    title: Localized<string>;
+    prompt: string;
+}
+export interface IVeloAgentConfigResponse {
+    id: string;
+    agentName: string;
+    version: number;
+    whatCanDo: Localized<string[]>;
+    quickActions: IModelQuickActionsResponse[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ISendVeloConversationMessagePayload {
+    conversationId: string;
+    message: string;
+    stream?: boolean;
+}
+export type IVeloMessageStream = ReadableStream<Uint8Array>;
+export interface ISendVeloConversationApiResponsePayload {
+    conversationId: string;
+    callId: string;
+    data: string;
+    status: number;
+    stream?: boolean;
+}
+export interface IGetVeloConversationResourcePayload {
+    conversationId: string;
+    resourceId: string;
+}
+export interface IVeloConversationResource {
+    id: string;
+    type: string;
+    content: string;
+}
+export {};

package/velo/interfaces.js

@@ -0,0 +1 @@
+export {};

package/velo/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/velo/index.js",
+  "types": "./index.d.ts"
+}

package/vendor/index.d.ts

@@ -1,6 +1,12 @@
-import { IVendorPublicInfoResponse } from "./interfaces";
-/**
- * provide vendor public info by providing the vendor context.
- * @return IVendorPublicInfoResponse
- */
-export declare function getVendorPublicInfo(): Promise<IVendorPublicInfoResponse>;
+import { IVendorPublicInfoResponse } from './interfaces';
+import { BaseApiClient } from '../BaseApiClient';
+export declare class VendorApi extends BaseApiClient {
+    constructor(appName: string);
+    /**
+     * Provide vendor public info by providing the vendor context.
+     * @returns {Promise<IVendorPublicInfoResponse>}
+     */
+    getVendorPublicInfo: () => Promise<IVendorPublicInfoResponse>;
+}
+declare const _default: VendorApi;
+export default _default;

package/vendor/index.js

@@ -1,6 +1,17 @@
-import { Get } from '../fetch';
 import { urls } from '../constants';
-export async function getVendorPublicInfo() {
-  return Get(`${urls.vendor}/public`);
+import { BaseApiClient } from '../BaseApiClient';
+export class VendorApi extends BaseApiClient {
+  constructor(appName) {
+    super(appName);
+    this.getVendorPublicInfo = async () => {
+      return this.get(`${urls.vendor}/public`);
+    };
+  }
+
+  /**
+   * Provide vendor public info by providing the vendor context.
+   * @returns {Promise<IVendorPublicInfoResponse>}
+   */
 }
-;
+
+export default new VendorApi('default');

package/ContextHolder.d.ts

@@ -1,29 +0,0 @@
-import { IUserProfile } from './teams/interfaces';
-import { ContextOptions, RedirectOptions } from './interfaces';
-export declare class ContextHolder {
-    private static instance;
-    private context;
-    private accessToken;
-    private user;
-    private onRedirectTo;
-    private logout;
-    private constructor();
-    static getInstance(): ContextHolder;
-    static setContext(context: ContextOptions): void;
-    static setAccessToken(accessToken: string | null): void;
-    static setUser(user: IUserProfile | null): void;
-    static setOnRedirectTo(onRedirectTo: (path: string, opts?: RedirectOptions) => void): void;
-    static setLogout(logout: (callback?: () => void) => void, logoutUrl: string): void;
-    static getContext(): ContextOptions;
-    static getAccessToken(): string | null;
-    static getUser(): IUserProfile | null;
-    static onRedirectTo(path: string, opts?: RedirectOptions): void;
-    static logout(callback?: () => void): void;
-}
-export declare const FronteggContext: {
-    getContext: () => ContextOptions;
-    getAccessToken: () => string | null;
-    getUser: () => IUserProfile | null;
-    onRedirectTo: (path: string, opts: RedirectOptions) => void;
-    logout: (callback?: (() => void) | undefined) => void;
-};