@memori.ai/memori-api-client 1.1.0 → 2.0.0

package/src/engine/importExport.ts

@@ -1,7 +1,7 @@
 import {
   ResponseSpec,
-  ImportReponse,
-  ImportCSVParams,
+  ImportParams,
+  ImportResponse,
   ExportCSVParams,
 } from '../types';
 import { apiFetcher } from '../apiFetcher';
@@ -16,22 +16,88 @@ export default (apiUrl: string) => ({
   /**
    * Imports memories from a CSV file.
    * @param {string} sessionId The session ID
-   * @param {string[]} csvRows Rows of the CSV file.
-   * @param {ImportCSVParams} params The specifications and content of the CSV file
+   * @param {string[]} rows Rows of the CSV file.
+   * @param {ImportParams} params The specifications and content of the CSV file
    */
-  importCSV: async (
+  importCSV: async (sessionId: string, rows: string[], params: ImportParams) =>
+    apiFetcher(`/ImportExport/ImportCSV/${sessionId}`, {
+      method: 'POST',
+      apiUrl,
+      body: {
+        rows,
+        ...params,
+      },
+    }) as Promise<
+      ResponseSpec & {
+        status: ImportResponse;
+      }
+    >,
+
+  /**
+   * Gets the list of recent Import processes for the Memori object associated with the specified session ID.
+   * @param {string} sessionId The session ID
+   */
+  importProcesses: async (sessionId: string) =>
+    apiFetcher(`/ImportExport/ImportProcesses/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        importProcesses: ImportResponse[];
+      }
+    >,
+
+  /**
+   * Gets the status of an ongoing Import process.
+   * @param {string} importID The import process ID
+   */
+  importStatus: async (importID: string) =>
+    apiFetcher(`/ImportExport/ImportStatus/${importID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        status: ImportResponse;
+      }
+    >,
+
+  /**
+   * Interrupts an ongoing Import process.
+   * @param {string} importID The import process ID
+   */
+  stopImport: async (importID: string) =>
+    apiFetcher(`/ImportExport/StopImport/${importID}`, {
+      method: 'POST',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        status: ImportResponse;
+      }
+    >,
+
+  /**
+   * Imports memories from a TXT file.
+   * @param {string} sessionId The session ID
+   * @param {string[]} rows Rows of the TXT file.
+   * @param {ImportCSVParams} params The specifications and content of the TXT file
+   */
+  importTXT: async (
     sessionId: string,
-    csvRows: string[],
-    params: ImportCSVParams
+    rows: string[],
+    params: Omit<ImportParams, 'csvSpecs'>
   ) =>
-    apiFetcher(`/ImportExport/ImportCSV/${sessionId}`, {
+    apiFetcher(`/ImportExport/ImportTXT/${sessionId}`, {
       method: 'POST',
       apiUrl,
       body: {
-        csvRows,
+        rows,
         ...params,
       },
-    }) as Promise<ResponseSpec & ImportReponse>,
+    }) as Promise<
+      ResponseSpec & {
+        status: ImportResponse;
+      }
+    >,
 
   /**
    * Exports memories to a CSV file.

package/src/engine/intents.test.ts

@@ -0,0 +1,23 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/intents api', () => {
+  it('works on intents apis', async () => {
+    expect(
+      await client.intents.getIntent(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on intents apis with shorthand version', async () => {
+    expect(
+      await client.getIntent(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+});

package/src/engine/localizationKeys.test.ts

@@ -0,0 +1,23 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/localizationKeys api', () => {
+  it('works on localizationKeys apis', async () => {
+    expect(
+      await client.localizationKeys.getLocalizationKey(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'GIVER_PRESENTATION'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on localizationKeys apis with shorthand version', async () => {
+    expect(
+      await client.getLocalizationKey(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'GIVER_PRESENTATION'
+      )
+    ).not.toBeNull();
+  });
+});

package/src/engine/media.test.ts

@@ -0,0 +1,23 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/media api', () => {
+  it('works on media apis', async () => {
+    expect(
+      await client.media.getMedia(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on media apis with shorthand version', async () => {
+    expect(
+      await client.getMedia(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+});

package/src/engine/memories.test.ts

@@ -0,0 +1,17 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/memories api', () => {
+  it('works on memory apis', async () => {
+    expect(
+      await client.memories.getMemories('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
+    ).not.toBeNull();
+  });
+
+  it('works on memory apis with shorthand version', async () => {
+    expect(
+      await client.getMemories('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
+    ).not.toBeNull();
+  });
+});

package/src/engine/nlp.test.ts

@@ -0,0 +1,23 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/nlp api', () => {
+  it('works on nlp apis', async () => {
+    expect(
+      await client.nlp.guessLanguage(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'Hola, quien eres?'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on nlp apis with shorthand version', async () => {
+    expect(
+      await client.guessLanguage(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'Hola, quien eres?'
+      )
+    ).not.toBeNull();
+  });
+});

package/src/engine/people.test.ts

@@ -0,0 +1,23 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/people api', () => {
+  it('works on people apis', async () => {
+    expect(
+      await client.people.getPerson(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on people apis with shorthand version', async () => {
+    expect(
+      await client.getPerson(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+});

package/src/engine/promptedQuestions.test.ts

@@ -0,0 +1,23 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/promptedQuestions api', () => {
+  it('works on promptedQuestions apis', async () => {
+    expect(
+      await client.promptedQuestions.getPromptedQuestion(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on promptedQuestions apis with shorthand version', async () => {
+    expect(
+      await client.getPromptedQuestion(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+});

package/src/engine/search.test.ts

@@ -0,0 +1,17 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/search api', () => {
+  it('works on search apis', async () => {
+    expect(
+      await client.search.postRandom('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
+    ).not.toBeNull();
+  });
+
+  it('works on search apis with shorthand version', async () => {
+    expect(
+      await client.postRandom('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
+    ).not.toBeNull();
+  });
+});

package/src/engine/session.test.ts

@@ -0,0 +1,17 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/session api', () => {
+  it('works on session apis', async () => {
+    expect(
+      await client.session.getSession('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
+    ).not.toBeNull();
+  });
+
+  it('works on session apis with shorthand version', async () => {
+    expect(
+      await client.getSession('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
+    ).not.toBeNull();
+  });
+});

package/src/engine/stats.test.ts

@@ -0,0 +1,17 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/stats api', () => {
+  it('works on statistics apis', async () => {
+    expect(
+      await client.stats.getStatistics('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
+    ).not.toBeNull();
+  });
+
+  it('works on statistics apis with shorthand version', async () => {
+    expect(
+      await client.getStatistics('768b9654-e781-4c3c-81fa-ae1529d1bfbe')
+    ).not.toBeNull();
+  });
+});

package/src/engine/unansweredQuestions.test.ts

@@ -0,0 +1,21 @@
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/unansweredQuestions api', () => {
+  it('works on unansweredQuestions apis', async () => {
+    expect(
+      await client.unansweredQuestions.getUnansweredQuestions(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on unansweredQuestions apis with shorthand version', async () => {
+    expect(
+      await client.getUnansweredQuestions(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe'
+      )
+    ).not.toBeNull();
+  });
+});

package/src/helpers/asset.test.ts

@@ -0,0 +1,116 @@
+import asset from './asset';
+
+const apiUrl = 'https://backend.memori.ai/api/v2';
+const { getResourceUrl } = asset(apiUrl);
+
+describe('Asset URL helper', () => {
+  const sessionId = 'a196b513-d745-4121-8913-8f457b999add';
+  const mediumId = 'f469e3e9-1a45-47df-abf3-eeaa01707510';
+
+  it('Get default avatar URL with no url', async () => {
+    expect(
+      getResourceUrl({
+        type: 'avatar',
+        baseURL: 'https://twin.memori.ai',
+      })
+    ).toBe('https://twin.memori.ai/images/memoriAvatar.png');
+  });
+  it('Get default cover URL with no url', async () => {
+    expect(
+      getResourceUrl({
+        type: 'cover',
+        baseURL: 'https://twin.memori.ai',
+      })
+    ).toBe('https://twin.memori.ai/images/memoriCover.png');
+  });
+
+  it('Get correct URL for media', async () => {
+    expect(
+      getResourceUrl({
+        resourceURI:
+          'https://api.lorem.space/image/game?w=150&h=220&hash=8B7BCDC2',
+      })
+    ).toBe('https://api.lorem.space/image/game?w=150&h=220&hash=8B7BCDC2');
+  });
+
+  it('Get correct URL for old memoriai/memory media', async () => {
+    expect(
+      getResourceUrl({
+        resourceURI:
+          'https://backend.memori.ai/api/v1/memoriai/memory/2d434f42-3e95-46ad-9bd5-a10b65977407/media/cloud/studio.memori.ai/2f7b56d1-06a2-4908-9dd3-ef30359b5d05.jpeg',
+        sessionID: sessionId,
+      })
+    ).toBe(
+      `https://backend.memori.ai/api/v1/memoriai/memory/2d434f42-3e95-46ad-9bd5-a10b65977407/media/cloud/studio.memori.ai/2f7b56d1-06a2-4908-9dd3-ef30359b5d05.jpeg?memori-ai-session-id=${sessionId}`
+    );
+  });
+
+  it('Get correct URL for old cloud://tenantID media', async () => {
+    expect(
+      getResourceUrl({
+        resourceURI: `cloud://twin.memori.ai/${mediumId}.png`,
+        sessionID: sessionId,
+      })
+    ).toBe(
+      `${apiUrl.replace('v2', 'v1')}/CloudAsset/twin.memori.ai/${mediumId}.png`
+    );
+  });
+
+  it('Get correct URL for old cloud://tenantID media', async () => {
+    expect(
+      getResourceUrl({
+        // cloud://twin.memori.ai/5fc7cd8b-7c8f-4d92-83ad-f48d04b6aafe.jpeg
+        resourceURI: `cloud://twin.memori.ai/5fc7cd8b-7c8f-4d92-83ad-f48d04b6aafe.jpeg
+`,
+        sessionID: sessionId,
+      })
+    ).toBe(
+      `${apiUrl.replace(
+        'v2',
+        'v1'
+      )}/CloudAsset/twin.memori.ai/5fc7cd8b-7c8f-4d92-83ad-f48d04b6aafe.jpeg
+`
+    );
+  });
+
+  it('Get correct URL for old cloud://tenantID media', async () => {
+    expect(
+      getResourceUrl({
+        resourceURI:
+          'cloud://twin.memori.ai/6c30043c-9de1-4d13-87e4-c53adb3f9885.jpg',
+        sessionID: sessionId,
+      })
+    ).toBe(
+      `${apiUrl.replace(
+        'v2',
+        'v1'
+      )}/CloudAsset/twin.memori.ai/6c30043c-9de1-4d13-87e4-c53adb3f9885.jpg`
+    );
+  });
+
+  it('Get correct URL for old cloud://tenantID media with old non-existent tenant', async () => {
+    expect(
+      getResourceUrl({
+        // cloud://twin.memori.ai/5fc7cd8b-7c8f-4d92-83ad-f48d04b6aafe.jpeg
+        resourceURI: `cloud://twin.memori.ai/5fc7cd8b-7c8f-4d92-83ad-f48d04b6aafe.jpeg
+`,
+        sessionID: sessionId,
+      })
+    ).toBe(
+      `${apiUrl.replace(
+        'v2',
+        'v1'
+      )}/CloudAsset/twin.memori.ai/5fc7cd8b-7c8f-4d92-83ad-f48d04b6aafe.jpeg
+`
+    );
+  });
+
+  it('Get correct URL for old guid://tenant media', async () => {
+    expect(
+      getResourceUrl({
+        resourceURI: `guid://${mediumId}`,
+        sessionID: sessionId,
+      })
+    ).toBe(`${apiUrl.replace('v2', 'v1')}/GuidAsset/${mediumId}`);
+  });
+});

package/src/helpers/getApiUrl.test.ts

@@ -0,0 +1,15 @@
+import { getApiUrl } from './getApiUrl';
+
+describe('API URL', () => {
+  it('parses the correct API URL with no arg', () => {
+    expect(getApiUrl()).toBe('https://backend.memori.ai');
+  });
+  it('parses the correct API URL passing host', () => {
+    expect(getApiUrl('backend.memori.ai')).toBe('https://backend.memori.ai');
+  });
+  it('parses the correct API URL passing more url parts', () => {
+    expect(getApiUrl('https://backend.memori.ai/memoriai/awanagana')).toBe(
+      'https://backend.memori.ai'
+    );
+  });
+});

package/src/{types.ts → types.d.ts}

@@ -844,37 +844,33 @@ export type CustomWord = {
   lastChangeSessionID: string;
 };
 
-export type ImportWarning = {
-  warningType: 'Existing Similar Memory' | 'Internal Error';
-  rowNumber?: number;
-  csvRow: string;
-  text?: string;
-  similarTexts?: {
-    text: string;
-    similarityLevel: 'HIGH' | 'MEDIUM' | 'LOW';
-  }[];
-};
-
-export type ImportReponse = {
-  importID: string;
-  importedMemories?: number;
-  importWarnings?: ImportWarning[];
-};
-
-export type ImportCSVParams = {
-  includedRows?: number[];
+export interface ImportCSVParams {
   hasHeaders?: boolean;
   headerNames?: string[];
-  forceImport?: boolean;
   questionColumnName: string;
   answerColumnName: string;
   contextVarsToMatchColumnName?: string;
   contextVarsToSetColumnName?: string;
   csvSeparator?: string;
   questionTitleVariantsSeparator?: string;
-};
+}
+
+export interface ImportTxtParams {
+  newLinesPerParagraphs?: number;
+}
 
-export type ExportCSVParams = {
+export interface ImportParams {
+  includedRows?: number[];
+  forceImport?: boolean;
+  csvSpecs?: ImportCSVParams;
+  txtSpecs?: ImportTxtParams;
+  conclusive?: boolean;
+  notPickable?: boolean;
+  contextVarsToSet?: {
+    [key: string]: string;
+  };
+}
+export interface ExportCSVParams {
   newLine: '\n' | '\r\n';
   hasHeaders?: boolean;
   questionColumnName: string;
@@ -883,4 +879,70 @@ export type ExportCSVParams = {
   contextVarsToSetColumnName?: string;
   csvSeparator?: string;
   questionTitleVariantsSeparator?: string;
-};
+}
+
+export interface ImportWarning {
+  warningType: 'Existing Similar Memory' | 'Internal Error';
+  rowNumber?: number;
+  row: string;
+  text?: string;
+  similarTexts?: {
+    text: string;
+    similarityLevel: 'HIGH' | 'MEDIUM' | 'LOW';
+  }[];
+}
+
+export interface ImportResponse {
+  /**
+   * @type {string}
+   * Import process ID.
+   */
+  importID: string;
+  /**
+   * @type {string}
+   * minLength: 1
+   * Current status of the Import process (starting, running etc.).
+   * May be one of the following:
+   * - Starting: the Import process is preparing to start, but has not started yet. Will advance to Running automatically.
+   * - Running: the Import process has been started and is actively processing Memory objects.
+   * - Stopped: the Import process has been stopped manually, not all Memory objects may have been processed.
+   * - Completed: the Import process finished successfully, all the Memory objects have been processed.
+   * - Failed: the Import process terminated due to an unexpected error, not all Memory objects may have been processed.
+   */
+  status: 'Starting' | 'Running' | 'Stopped' | 'Completed' | 'Failed';
+  /**
+   * @type {string=}
+   * If the Status is Failed, reports the error that caused the Import process to fail. Null otherwise.
+   */
+  error?: string;
+  /**
+   * @type {number}
+   * Progress of the Import process as a fraction of 1.
+   */
+  progress: number;
+  /**
+   * @type {string=}
+   * Timestamp of start of the Import process. Null until the Import process is in Starting status.
+   */
+  begin?: string;
+  /**
+   * @type {string=}
+   * Timestamp of end of the Import process. Null until the Import process is in Starting or Running status.
+   */
+  end?: string;
+  /**
+   * @type {number=}
+   * Estimated time required to complete the Import process, in seconds.
+   */
+  eta?: number;
+
+  /**
+   * @type {number=}
+   * Number of Imported Memory objects so far.
+   */
+  importedMemories?: number;
+  /**
+   * List of Import Warning objects. May be empty.
+   */
+  importWarnings?: ImportWarning[];
+}