@memori.ai/memori-api-client 5.2.1 → 5.3.1

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.2.1",
+  "version": "5.3.1",
   "name": "@memori.ai/memori-api-client",
   "description": "React library to integrate a Memori in your app or website",
   "license": "Apache-2.0",

package/src/backend/badge.test.ts

@@ -0,0 +1,19 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('backend/badge api', () => {
+  it('works on badge apis', async () => {
+    expect(
+      await client.backend.badge.getUserBadges(
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on badge apis with shorthand version', async () => {
+    expect(
+      await client.backend.getUserBadges('be2e4a44-890b-483b-a26a-f6e122f36e2b')
+    ).not.toBeNull();
+  });
+});

package/src/backend/badge.ts

@@ -0,0 +1,36 @@
+import { ResponseSpec, Badge } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export default (apiUrl: string) => ({
+  /**
+   * Processes the specified outcome.
+   * @param {string} authToken - The login token
+   * @param {string} outcomeCode - The outcome code
+   */
+  postOutcome: (authToken: string, outcomeCode: string) =>
+    apiFetcher(`/Outcome/${authToken}/${outcomeCode}`, {
+      apiUrl,
+      method: 'POST',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Gets a list of Badge objects assigned to the currently logged in User.
+   * @param {string} authToken - The login token
+   * @returns The list of Badge objects.
+   */
+  getUserBadges: (authToken: string) =>
+    apiFetcher(`/Badges/${authToken}`, {
+      apiUrl,
+    }) as Promise<ResponseSpec & { badges: Badge[] }>,
+
+  /**
+   * Get the detail of a Badge object of the currently logged in User.
+   * @param {string} authToken - The login token
+   * @param {string} badgeID - The ID of the Badge object
+   * @returns The Badge object
+   */
+  getBadge: (authToken: string, badgeID: string) =>
+    apiFetcher(`/Badge/${authToken}/${badgeID}`, {
+      apiUrl,
+    }) as Promise<ResponseSpec & { badge: Badge }>,
+});

package/src/backend/user.ts

@@ -1,4 +1,4 @@
-import { ResponseSpec, Tenant, User } from '../types';
+import { ResponseSpec, Tenant, User, UserFilters } from '../types';
 import { apiFetcher } from '../apiFetcher';
 
 export default (apiUrl: string) => ({
@@ -93,6 +93,25 @@ export default (apiUrl: string) => ({
       }
     >,
 
+  /**
+   * 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
+   */
+  getUsersListPaginated: (authToken: string, filters: UserFilters) =>
+    apiFetcher(`/FilterUsers/${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

package/src/backend.ts

@@ -9,6 +9,7 @@ import importExport from './backend/importExport';
 import process from './backend/process';
 import analysis from './backend/analysis';
 import completionConfig from './backend/completionConfig';
+import badge from './backend/badge';
 
 const backendAPI = (apiUrl: string) => ({
   asset: asset(apiUrl),
@@ -22,6 +23,7 @@ const backendAPI = (apiUrl: string) => ({
   process: process(apiUrl),
   analysis: analysis(apiUrl),
   completionConfig: completionConfig(apiUrl),
+  badge: badge(apiUrl),
   ...asset(apiUrl),
   ...memori(apiUrl),
   ...user(apiUrl),
@@ -33,6 +35,7 @@ const backendAPI = (apiUrl: string) => ({
   ...process(apiUrl),
   ...analysis(apiUrl),
   ...completionConfig(apiUrl),
+  ...badge(apiUrl),
 });
 
 export default backendAPI;

package/src/client.test.ts

@@ -19,6 +19,36 @@ describe('client', () => {
       'https://custom.backend.com/api/v2'
     );
   });
+  it('works with staging backend url', () => {
+    const customClient = memori('https://backend-staging.memori.ai/api/v2');
+    expect(customClient.constants.BACKEND_URL).toBe(
+      'https://backend-staging.memori.ai/api/v2'
+    );
+    expect(customClient.constants.ENGINE_URL).toBe(
+      'https://engine-staging.memori.ai/memori/v2'
+    );
+  });
+  it('works with staging engine url', () => {
+    const customClient = memori(
+      undefined,
+      'https://engine-staging.memori.ai/memori/v2'
+    );
+    expect(customClient.constants.ENGINE_URL).toBe(
+      'https://engine-staging.memori.ai/memori/v2'
+    );
+  });
+  it('works with staging endpoints url', () => {
+    const customClient = memori(
+      'https://backend-staging.memori.ai/api/v2',
+      'https://engine-staging.memori.ai/memori/v2'
+    );
+    expect(customClient.constants.ENGINE_URL).toBe(
+      'https://engine-staging.memori.ai/memori/v2'
+    );
+    expect(customClient.constants.BACKEND_URL).toBe(
+      'https://backend-staging.memori.ai/api/v2'
+    );
+  });
   it('works with custom engine url', () => {
     const customClient = memori(
       undefined,
@@ -28,6 +58,18 @@ describe('client', () => {
       'https://custom.engine.com/memori/v2'
     );
   });
+  it('works with custom endpoints url', () => {
+    const customClient = memori(
+      'https://custom.backend.com/api/v2',
+      'https://custom.engine.com/memori/v2'
+    );
+    expect(customClient.constants.ENGINE_URL).toBe(
+      'https://custom.engine.com/memori/v2'
+    );
+    expect(customClient.constants.BACKEND_URL).toBe(
+      'https://custom.backend.com/api/v2'
+    );
+  });
 
   it('works', async () => {
     expect(

package/src/engine/chatLogs.ts

@@ -44,6 +44,33 @@ export default (apiUrl: string) => ({
       }
     >,
 
+  /**
+   * Gets the Chat Log objects for the Memori of the current session recorded during a specific other session.
+   * @param {string} sessionId The session ID
+   * @param {string} userID The user ID
+   * @param {?string} dateFrom The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff
+   * @param {?string} dateTo The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff
+   */
+  getUserChatLogs: async (
+    sessionId: string,
+    userID: string,
+    dateFrom?: string,
+    dateTo?: string
+  ) =>
+    apiFetcher(
+      `/UserChatLogs/${sessionId}/${userID}${dateFrom ? `/${dateFrom}` : ''}${
+        dateFrom && dateTo ? `/${dateTo}` : ''
+      }`,
+      {
+        method: 'GET',
+        apiUrl,
+      }
+    ) as Promise<
+      ResponseSpec & {
+        chatLogs: ChatLog[];
+      }
+    >,
+
   /**
    * Removes all Chat Log objects in a specific date internval.
    * @param {string} sessionId The session ID

package/src/engine/functions.ts

@@ -113,4 +113,25 @@ export default (apiUrl: string) => ({
         functionID: string;
       }
     >,
+
+  /**
+   * Lists all Macro Function objects.
+   * @param {string} sessionId The session ID
+   */
+  getMacroFunctions: async (sessionId: string) =>
+    apiFetcher(`/MacroFunctions/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of Macro Function objects.
+         */
+        count: number;
+        /**
+         * List of Function objects. May be empty.
+         */
+        macroFunctions: Function[];
+      }
+    >,
 });

package/src/engine/search.ts

@@ -20,6 +20,7 @@ export default (apiUrl: string) => ({
       apiUrl,
     }) as Promise<
       ResponseSpec & {
+        count: number;
         matches: SearchMatches[];
       }
     >,