@memori.ai/memori-api-client 6.6.0 → 6.6.2

package/src/backend/trustedApplication.ts

@@ -0,0 +1,64 @@
+import { ResponseSpec, TrustedApplication } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export default (apiUrl: string) => ({
+  /**
+   * Creates a new TrustedApplication.
+   * Only administrators can create TrustedApplications.
+   * @param authToken - The login token
+   * @param trustedApplication - The TrustedApplication specifications
+   * @returns The created TrustedApplication object
+   */
+  createTrustedApplication: (authToken: string, trustedApplication: TrustedApplication) =>
+    apiFetcher(`/TrustedApplication/${authToken}`, {
+      apiUrl,
+      body: trustedApplication,
+      method: 'POST',
+    }) as Promise<ResponseSpec & { trustedApplication: TrustedApplication }>,
+
+  /**
+   * Gets a TrustedApplication by ID.
+   * @param authToken - The login token
+   * @param trustedApplicationID - The TrustedApplication ID
+   * @returns The TrustedApplication object
+   */
+  getTrustedApplication: (authToken: string, trustedApplicationID: string) =>
+    apiFetcher(`/TrustedApplication/${authToken}/${trustedApplicationID}`, {
+      apiUrl,
+    }) as Promise<ResponseSpec & { trustedApplication: TrustedApplication }>,
+
+  /**
+   * Updates an existing TrustedApplication.
+   * @param authToken - The login token
+   * @param trustedApplicationID - The TrustedApplication ID
+   * @param trustedApplication - The TrustedApplication specifications
+   * @returns The updated TrustedApplication object
+   */
+  updateTrustedApplication: (authToken: string, trustedApplicationID: string, trustedApplication: TrustedApplication) =>
+    apiFetcher(`/TrustedApplication/${authToken}/${trustedApplicationID}`, {
+      apiUrl,
+      method: 'PUT',
+      body: trustedApplication,
+    }) as Promise<ResponseSpec & { trustedApplication: TrustedApplication }>,
+
+  /**
+   * Deletes a TrustedApplication.
+   * @param authToken - The login token
+   * @param trustedApplicationID - The TrustedApplication ID
+   */
+  deleteTrustedApplication: (authToken: string, trustedApplicationID: string) =>
+    apiFetcher(`/TrustedApplication/${authToken}/${trustedApplicationID}`, {
+      apiUrl,
+      method: 'DELETE',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Lists all TrustedApplications for the current tenant.
+   * @param authToken - The login token
+   * @returns A list of TrustedApplication objects
+   */
+  getTrustedApplicationsList: (authToken: string) =>
+    apiFetcher(`/TrustedApplications/${authToken}`, {
+      apiUrl,
+    }) as Promise<ResponseSpec & { trustedApplications: TrustedApplication[] }>,
+}); 

package/src/backend/userPwl.ts

@@ -0,0 +1,155 @@
+import { ResponseSpec, User, UserFilters } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export default (apiUrl: string) => ({
+  /**
+   * Tries a login with the specified credentials and returns a login token if successful.
+   * @param user - The user object
+   * @returns The logged in user object
+   */
+  pwlUserLogin: (user: User) =>
+    apiFetcher('/PwlLogin', {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<
+      ResponseSpec & { user: User; token?: string; flowID?: string }
+    >,
+
+  /**
+   * Logs out the user.
+   * @param authToken - The login token
+   */
+  pwlUserLogout: (authToken: string) =>
+    apiFetcher(`/PwlLogout/${authToken}`, {
+      apiUrl,
+      method: 'POST',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Gets the details of the currently logged in User object.
+   * @param authToken - The login token
+   * @returns The user object
+   */
+  pwlGetCurrentUser: (authToken: string) =>
+    apiFetcher(`/PwlUser/${authToken}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        user: User;
+      }
+    >,
+
+  /**
+   * Gets the details of a User object.
+   * @param authToken - The login token
+   * @param userID - The user ID
+   * @returns The user object
+   */
+  pwlGetUser: (authToken: string, userID: string) =>
+    apiFetcher(`/PwlUser/${authToken}/${userID}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        user: User;
+      }
+    >,
+
+  /**
+   * Gets a list of all the existing User objects.
+   * @param authToken - The login token
+   * @returns A list of User objects
+   */
+  pwlGetUsersList: (authToken: string) =>
+    apiFetcher(`/PwlUsers/${authToken}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        users: User[];
+      }
+    >,
+
+  /**
+   * Gets a list of all the existing User objects paginated.
+   * @param authToken - The login token
+   * @param from - The 0-based index of the first User object to list
+   * @param howMany - The number of User objects to list
+   * @returns A list of User objects
+   */
+  pwlGetUsersListPaginated: (authToken: string, filters: UserFilters) =>
+    apiFetcher(`/FilterPwlUsers/${authToken}`, {
+      apiUrl,
+      body: filters,
+      method: 'POST',
+    }) as Promise<
+      ResponseSpec & {
+        users: User[];
+        count: number;
+      }
+    >,
+
+  /**
+   * Deletes the currently logged in User.
+   * @param {string} authToken - The login token
+   * @param {string} userID: The User ID
+   */
+  pwlDeleteUser: (authToken: string, userID: string) =>
+    apiFetcher(`/PwlUser/${authToken}/${userID}`, {
+      apiUrl,
+      method: 'DELETE',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Updates the details of a User object.
+   * @param authToken - The login token
+   * @param userID - The user ID
+   * @returns The user object
+   */
+  pwlUpdateUser: (authToken: string, userID: string, user: User) =>
+    apiFetcher(`/PwlUser/${authToken}/${userID}`, {
+      apiUrl,
+      method: 'PATCH',
+      body: user,
+    }) as Promise<
+      ResponseSpec & {
+        user: User;
+      }
+    >,
+
+  /**
+   * Recovers a User's name and sends it to their configured e-mail.
+   * @param {User} user - The user object
+   */
+  pwlRecoverUsername: (user: User) =>
+    apiFetcher(`/RecoverPwlUserName`, {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Registers a new user.
+   * @param {User} user - The user object
+   */
+  pwlCreateUser: (authToken: string, user: Partial<User>) =>
+    apiFetcher(`/PwlUser/${authToken}`, {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<ResponseSpec & { user: User }>,
+
+  /**
+   * Tries a login with the specified JWT and returns a login token if successful.
+   * @param {object} payload - The payload object
+   * @param {string} payload.jwt - The JWT
+   * @returns The logged in user object
+   */
+  pwlLoginWithJWT: (jwt: string) =>
+    apiFetcher('/LoginWithJWT', {
+      apiUrl,
+      body: { jwt },
+      method: 'POST',
+    }) as Promise<
+      ResponseSpec & { user: User; token?: string; flowID?: string }
+    >,
+}); 

package/src/backend.ts

@@ -1,5 +1,6 @@
 import memori from './backend/memori';
 import user from './backend/user';
+import userPwl from './backend/userPwl';
 import integration from './backend/integration';
 import asset from './backend/asset';
 import invitation from './backend/invitation';
@@ -11,11 +12,13 @@ import analysis from './backend/analysis';
 import completionConfig from './backend/completionConfig';
 import badge from './backend/badge';
 import tenant from './backend/tenant';
+import trustedApplication from './backend/trustedApplication';
 
 const backendAPI = (apiUrl: string) => ({
   asset: asset(apiUrl),
   memori: memori(apiUrl),
   user: user(apiUrl),
+  userPwl: userPwl(apiUrl),
   integration: integration(apiUrl),
   invitation: invitation(apiUrl),
   consumptionLogs: consumptionLogs(apiUrl),
@@ -26,9 +29,11 @@ const backendAPI = (apiUrl: string) => ({
   completionConfig: completionConfig(apiUrl),
   badge: badge(apiUrl),
   tenant: tenant(apiUrl),
+  trustedApplication: trustedApplication(apiUrl),
   ...asset(apiUrl),
   ...memori(apiUrl),
   ...user(apiUrl),
+  ...userPwl(apiUrl),
   ...integration(apiUrl),
   ...invitation(apiUrl),
   ...consumptionLogs(apiUrl),
@@ -39,6 +44,7 @@ const backendAPI = (apiUrl: string) => ({
   ...completionConfig(apiUrl),
   ...badge(apiUrl),
   ...tenant(apiUrl),
+  ...trustedApplication(apiUrl),
 });
 
 export default backendAPI;

package/src/engine/chatLogs.ts

@@ -29,6 +29,33 @@ export default (apiUrl: string) => ({
       }
     >,
 
+  /**
+   * Gets paginated Chat Log objects for the Memori of the current session in a specific date interval.
+   * @param {string} sessionId The session ID
+   * @param {string} dateFrom The begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff
+   * @param {string} dateTo The end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff
+   * @param {number} from The starting index for pagination
+   * @param {number} howMany The number of items to retrieve
+   */
+  getChatLogsPaged: async (
+    sessionId: string,
+    dateFrom: string,
+    dateTo: string,
+    from: number,
+    howMany: number
+  ) =>
+    apiFetcher(
+      `/ChatLogsPaged/${sessionId}/${dateFrom}/${dateTo}/${from}/${howMany}`,
+      {
+        method: 'GET',
+        apiUrl,
+      }
+    ) as Promise<
+      ResponseSpec & {
+        chatLogs: ChatLog[];
+      }
+    >,
+
   /**
    * Gets the Chat Log objects for the Memori of the current session created by the current User.
    * @param {string} sessionId The session ID

package/src/types.ts

@@ -558,6 +558,7 @@ export declare type Tenant = {
   billingDelegation?: boolean;
   creationTimestamp?: string;
   lastChangeTimestamp?: string;
+  perplexityAPIKey?: string;
 };
 
 export declare type LocalizationKeyContent = {
@@ -630,11 +631,12 @@ export declare type ConsumptionLog = {
 export declare type Notification = {
   notificationID: string;
   timestamp: string;
-  severity: 'INFO' | 'WARN' | 'ALERT' | 'AWARD' | 'CHATLOG';
+  severity: 'INFO' | 'WARN' | 'ALERT' | 'AWARD' | 'CHANGELOG';
   type: 'BROADCAST' | 'TENANT' | 'USER';
   tenantID?: string;
   userID?: string;
   validFrom?: string;
+  userName?: string;
   validTo?: string;
   texts: {
     'it-IT': string;
@@ -882,6 +884,7 @@ export declare type OpenSession = {
   recoveryTokens?: string[];
   tag?: string;
   pin?: string;
+  continueFromChatLogID?: string;
   initialContextVars?: { [key: string]: string };
   initialQuestion?: string;
   forceCloseSessions?: boolean;
@@ -1932,3 +1935,17 @@ export declare type MacroFunction = {
     obfuscated?: boolean;
   }[];
 };
+
+export declare type TrustedApplication = {
+  trustedApplicationID: string;
+  tenantID: string;
+  name: string;
+  description: string;
+  baseUrl: string;
+  authorizationToken: string;
+  isEnabled: boolean;
+  createdByUserID: string;
+  lastModifiedByUserID: string;
+  creationTimestamp: string;
+  lastChangeTimestamp: string;
+};