@memori.ai/memori-api-client 2.7.0 → 3.0.1

package/esm/index.d.ts

@@ -9,6 +9,86 @@ declare const api: (hostname?: string) => {
     asset: {
         getResourceUrl: ({ type, resourceURI, sessionID, baseURL, }: import("./helpers/asset").ResourceURLParams) => string;
     };
+    getTopics: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+        count: number;
+        topics: import("./types").Topic[];
+    }>;
+    getTopicsPaginated: (sessionId: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+        count: number;
+        topics: import("./types").Topic[];
+    }>;
+    getTopic: (sessionId: string, topicID: string) => Promise<import("./types").ResponseSpec & {
+        topic: import("./types").Topic;
+    }>;
+    getTopicUsers: (sessionId: string, topicId: string) => Promise<import("./types").ResponseSpec & {
+        count: number;
+        users: import("./types").MemoriUser[];
+    }>;
+    getTopicUsersPaginated: (sessionId: string, topicId: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+        count: number;
+        users: import("./types").MemoriUser[];
+    }>;
+    topics: {
+        getTopics: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+            count: number;
+            topics: import("./types").Topic[];
+        }>;
+        getTopicsPaginated: (sessionId: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+            count: number;
+            topics: import("./types").Topic[];
+        }>;
+        getTopic: (sessionId: string, topicID: string) => Promise<import("./types").ResponseSpec & {
+            topic: import("./types").Topic;
+        }>;
+        getTopicUsers: (sessionId: string, topicId: string) => Promise<import("./types").ResponseSpec & {
+            count: number;
+            users: import("./types").MemoriUser[];
+        }>;
+        getTopicUsersPaginated: (sessionId: string, topicId: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+            count: number;
+            users: import("./types").MemoriUser[];
+        }>;
+    };
+    getMemoriUsers: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+        count: number;
+        users: import("./types").MemoriUser[];
+    }>;
+    getMemoriUsersPaginated: (sessionId: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+        count: number;
+        users: import("./types").MemoriUser[];
+    }>;
+    getMemoriUser: (sessionId: string, userID: string) => Promise<import("./types").ResponseSpec & {
+        user: import("./types").MemoriUser;
+    }>;
+    getMemoriUserTopics: (sessionId: string, userID: string) => Promise<import("./types").ResponseSpec & {
+        count: number;
+        topics: import("./types").Topic[];
+    }>;
+    getMemoriUserTopicsPaginated: (sessionId: string, userID: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+        count: number;
+        topics: import("./types").Topic[];
+    }>;
+    user: {
+        getMemoriUsers: (sessionId: string) => Promise<import("./types").ResponseSpec & {
+            count: number;
+            users: import("./types").MemoriUser[];
+        }>;
+        getMemoriUsersPaginated: (sessionId: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+            count: number;
+            users: import("./types").MemoriUser[];
+        }>;
+        getMemoriUser: (sessionId: string, userID: string) => Promise<import("./types").ResponseSpec & {
+            user: import("./types").MemoriUser;
+        }>;
+        getMemoriUserTopics: (sessionId: string, userID: string) => Promise<import("./types").ResponseSpec & {
+            count: number;
+            topics: import("./types").Topic[];
+        }>;
+        getMemoriUserTopicsPaginated: (sessionId: string, userID: string, from: number, howMany: number) => Promise<import("./types").ResponseSpec & {
+            count: number;
+            topics: import("./types").Topic[];
+        }>;
+    };
     getKnownFacts: (sessionId: string) => Promise<import("./types").ResponseSpec & {
         count: number;
         knownFacts: import("./types").KnownFact[];
@@ -243,18 +323,6 @@ declare const api: (hostname?: string) => {
         postRandom: (sessionId: string) => Promise<import("./types").ResponseSpec>;
         postHints: (sessionId: string) => Promise<import("./types").ResponseSpec>;
     };
-    getPromptedQuestions: (sessionId: string) => Promise<import("./types").ResponseSpec>;
-    getPromptedQuestion: (sessionId: string, promptId: string) => Promise<import("./types").ResponseSpec>;
-    patchPromptedQuestion: (sessionId: string, promptId: string) => Promise<import("./types").ResponseSpec>;
-    deletePromptedQuestion: (sessionId: string, promptId: string) => Promise<import("./types").ResponseSpec>;
-    postPromptedQuestion: (sessionId: string) => Promise<import("./types").ResponseSpec>;
-    promptedQuestions: {
-        getPromptedQuestions: (sessionId: string) => Promise<import("./types").ResponseSpec>;
-        getPromptedQuestion: (sessionId: string, promptId: string) => Promise<import("./types").ResponseSpec>;
-        patchPromptedQuestion: (sessionId: string, promptId: string) => Promise<import("./types").ResponseSpec>;
-        deletePromptedQuestion: (sessionId: string, promptId: string) => Promise<import("./types").ResponseSpec>;
-        postPromptedQuestion: (sessionId: string) => Promise<import("./types").ResponseSpec>;
-    };
     getPeople: (sessionId: string) => Promise<import("./types").ResponseSpec & {
         people: import("./types").Person[];
     }>;
@@ -629,6 +697,9 @@ declare const api: (hostname?: string) => {
             flowID?: string | undefined;
         }>;
         userLogout: (authToken: string) => Promise<import("./types").ResponseSpec>;
+        getCurrentUser: (authToken: string) => Promise<import("./types").ResponseSpec & {
+            user: import("./types").User;
+        }>;
         getUser: (authToken: string, userID: string) => Promise<import("./types").ResponseSpec & {
             user: import("./types").User;
         }>;
@@ -803,6 +874,9 @@ declare const api: (hostname?: string) => {
                 flowID?: string | undefined;
             }>;
             userLogout: (authToken: string) => Promise<import("./types").ResponseSpec>;
+            getCurrentUser: (authToken: string) => Promise<import("./types").ResponseSpec & {
+                user: import("./types").User;
+            }>;
             getUser: (authToken: string, userID: string) => Promise<import("./types").ResponseSpec & {
                 user: import("./types").User;
             }>;

package/esm/types.d.ts

@@ -54,16 +54,19 @@ export declare type Memori = {
     disableR5Loop?: boolean;
     ageRestriction?: number;
     nsfw?: boolean;
-    enableBoardOfExperts?: boolean;
     enableCompletions?: boolean;
     completionDescription?: string;
-    completionProvider?: '-' | 'OpenAI';
+    completionProvider?: '-' | 'Mistral' | 'OpenAI';
     completionProviderConfig?: string;
     enableDeepThought?: boolean;
+    enableBoardOfExperts?: boolean;
     disableCompletionMediaExtraction?: boolean;
     chainingMemoriID?: string;
     chainingBaseURL?: string;
     chainingPassword?: string;
+    dcmUser?: string;
+    dcmSecret?: string;
+    dcmAppContext?: string;
     properties?: [{
         [key: string]: string;
     }];
@@ -105,13 +108,12 @@ export declare type User = {
     newsletterSubscribed?: boolean;
     maxMemori?: number;
     numMemori?: number;
-    canCreateMemori?: boolean;
-    canAccessAPI?: boolean;
-    canRunSnippets?: boolean;
-    canEditIntegrations?: boolean;
-    canEditDynamicIntents?: boolean;
-    canEditMemoriChaining?: boolean;
+    enableMemoriCreation?: boolean;
+    enableBoardOfExperts?: boolean;
+    enableDCMIntegration?: boolean;
     enableBadges?: boolean;
+    enableVirtualSpaces?: boolean;
+    enableDeepThought?: boolean;
     monthSessions?: number;
     monthValidSessions?: number;
     maxFreeSessions?: number;
@@ -124,7 +126,7 @@ export declare type User = {
     lastChangeTimestamp?: string;
     referral?: string;
     couponCode?: string;
-    defaultCompletionProvider?: '-' | 'OpenAI';
+    defaultCompletionProvider?: '-' | 'Mistral' | 'OpenAI';
     defaultCompletionProviderConfig?: string;
     paying?: boolean;
     notificationPrefs?: NotificationPrefs[];
@@ -132,6 +134,8 @@ export declare type User = {
     age?: number;
     tnCAndPPAccepted?: boolean;
     tnCAndPPAcceptanceDate?: string;
+    pAndCUAccepted?: boolean;
+    pAndCUAcceptanceDate?: string;
     avatarURL?: string;
     avatar3DURL?: string;
     avatar3DURLType?: string;
@@ -192,13 +196,13 @@ export type TenantConfig = {
     name: string;
     showNewUser: boolean;
     requirePosition: boolean;
-    feedbackURL?: string;
 };
 export type TenantBase = {
     tenantID?: string;
     name?: string;
     description?: string;
     logoURL?: string;
+    aliases?: string[];
     adminCount?: number;
     userCount?: number;
     memoriCount?: number;
@@ -211,15 +215,19 @@ export type TenantBase = {
     maxFreeSessions?: number;
     maxFreeSessionsPerUser?: number;
     nonFreeSessionCost?: number;
+    maxImportSize?: number;
+    maxImportSizePerUser?: number;
     maxCompletions?: number;
     maxCompletionsPerUser?: number;
+    defaultCompletionProvider?: '-' | 'Mistral' | 'OpenAI';
+    defaultCompletionProviderConfig?: string;
     paying?: boolean;
-    usersCanCreateMemori?: boolean;
-    usersCanAccessAPI?: boolean;
-    usersCanEditIntegrations?: boolean;
-    usersCanEditDynamicIntents?: boolean;
-    usersCanEditMemoriChaining?: boolean;
-    usersCanRunSnippets?: boolean;
+    enableUserMemoriCreation?: boolean;
+    enableBoardOfExperts?: boolean;
+    enableDCMIntegration?: boolean;
+    enableBadges?: boolean;
+    enableVirtualSpaces?: boolean;
+    enableDeepThought?: boolean;
     creationTimestamp?: string;
     lastChangeTimestamp?: string;
 };
@@ -706,3 +714,23 @@ export interface KnownFact {
     lastChangeTimestamp?: string;
     lastChangeSessionID?: string;
 }
+export interface MemoriUser {
+    userID: string;
+    email: string;
+    userName: string;
+    tenantName: string;
+    disableDeepThought: boolean;
+    creationTimestamp: string;
+    creationSessionID: string;
+    lastChangeTimestamp: string;
+    lastChangeSessionID: string;
+}
+export interface Topic {
+    topicID: string;
+    name: string;
+    weight: number;
+    creationTimestamp: string;
+    creationSessionID: string;
+    lastChangeTimestamp: string;
+    lastChangeSessionID: string;
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.7.0",
+  "version": "3.0.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/user.ts

@@ -50,6 +50,20 @@ export default (apiUrl: string) => ({
       method: 'POST',
     }) as Promise<ResponseSpec>,
 
+  /**
+   * Gets the details of the currently logged in User object.
+   * @param authToken - The login token
+   * @returns The user object
+   */
+  getCurrentUser: (authToken: string) =>
+    apiFetcher(`/User/${authToken}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        user: User;
+      }
+    >,
+
   /**
    * Gets the details of a User object.
    * @param authToken - The login token

package/src/client.test.ts

@@ -43,6 +43,6 @@ describe('client', () => {
       client.asset.getResourceUrl({
         type: 'avatar',
       })
-    ).toBe('https://app.twincreator.com/images/memoriAvatar.png');
+    ).toBe('https://aisuru.com/images/memoriAvatar.png');
   });
 });

package/src/engine/knownFacts.test.ts

@@ -1,7 +1,6 @@
 import memori from '../index';
 
-// FIXME: switch back to production when backend fixes request processing issue
-const client = memori('https://backend-staging.memori.ai');
+const client = memori('https://backend.memori.ai');
 
 describe('engine/knownFacts api', () => {
   it('works on knownFacts apis', async () => {

package/src/engine/topics.test.ts

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

package/src/engine/topics.ts

@@ -0,0 +1,124 @@
+import { ResponseSpec, MemoriUser, Topic } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/****************
+ *              *
+ *    Topics    *
+ *              *
+ ****************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Lists all Topic objects.
+   * @param {string} sessionId The session ID
+   */
+  getTopics: async (sessionId: string) =>
+    apiFetcher(`/Topics/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of MemoriUser objects.
+         */
+        count: number;
+        /**
+         * List of MemoriUser objects. May be empty.
+         */
+        topics: Topic[];
+      }
+    >,
+
+  /**
+   * Lists Topic objects with pagination.
+   * @param {string} sessionId The session ID
+   * @param {number} from The 0-based index of the first Topics object to list
+   * @param {number} howMany The number of the Topics objects to list
+   */
+  getTopicsPaginated: async (
+    sessionId: string,
+    from: number,
+    howMany: number
+  ) =>
+    apiFetcher(`/Topics/${sessionId}/${from}/${howMany}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of Topic objects.
+         */
+        count: number;
+        /**
+         * List of Topic objects. May be empty.
+         */
+        topics: Topic[];
+      }
+    >,
+
+  /**
+   * Gets the details of a Topic object.
+   * @param {string} sessionId The session ID
+   * @param {string} topicID The Topic object ID
+   */
+  getTopic: async (sessionId: string, topicID: string) =>
+    apiFetcher(`/Topic/${sessionId}/${topicID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        topic: Topic;
+      }
+    >,
+
+  /**
+   * Lists all MemoriUser objects referencing a specified Topic object.
+   * @param {string} sessionId The session ID
+   * @param {string} topicId The Topic object ID
+   */
+  getTopicUsers: async (sessionId: string, topicId: string) =>
+    apiFetcher(`/TopicUsers/${sessionId}/${topicId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of MemoriUser objects.
+         */
+        count: number;
+        /**
+         * List of MemoriUser objects. May be empty.
+         */
+        users: MemoriUser[];
+      }
+    >,
+
+  /**
+   * Lists all MemoriUser objects referencing a specified Topic object, with pagination.
+   * @param {string} sessionId The session ID
+   * @param {string} topicId The Topic object ID
+   * @param {number} from The 0-based index of the first MemoriUser object to list
+   * @param {number} howMany The number of the MemoriUser objects to list
+   */
+  getTopicUsersPaginated: async (
+    sessionId: string,
+    topicId: string,
+    from: number,
+    howMany: number
+  ) =>
+    apiFetcher(`/TopicUsers/${sessionId}/${topicId}/${from}/${howMany}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of MemoriUser objects.
+         */
+        count: number;
+        /**
+         * List of MemoriUser objects. May be empty.
+         */
+        users: MemoriUser[];
+      }
+    >,
+});

package/src/engine/{promptedQuestions.test.ts → user.test.ts}

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

package/src/engine/user.ts

@@ -0,0 +1,124 @@
+import { ResponseSpec, MemoriUser, Topic } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/****************
+ *              *
+ *     User     *
+ *              *
+ ****************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Lists all User objects associated with the Memori of the current session.
+   * @param {string} sessionId The session ID
+   */
+  getMemoriUsers: async (sessionId: string) =>
+    apiFetcher(`/Users/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of MemoriUser objects.
+         */
+        count: number;
+        /**
+         * List of MemoriUser objects. May be empty.
+         */
+        users: MemoriUser[];
+      }
+    >,
+
+  /**
+   * Lists all MemoriUser objects associated with the Memori of the current session, with pagination.
+   * @param {string} sessionId The session ID
+   * @param {number} from The 0-based index of the first MemoriUser object to list
+   * @param {number} howMany The number of the MemoriUser objects to list
+   */
+  getMemoriUsersPaginated: async (
+    sessionId: string,
+    from: number,
+    howMany: number
+  ) =>
+    apiFetcher(`/Users/${sessionId}/${from}/${howMany}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of MemoriUser objects.
+         */
+        count: number;
+        /**
+         * List of MemoriUser objects. May be empty.
+         */
+        users: MemoriUser[];
+      }
+    >,
+
+  /**
+   * Gets the details of a User object.
+   * @param {string} sessionId The session ID
+   * @param {string} userID The User object ID
+   */
+  getMemoriUser: async (sessionId: string, userID: string) =>
+    apiFetcher(`/User/${sessionId}/${userID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        user: MemoriUser;
+      }
+    >,
+
+  /**
+   * Lists all Topic objects referenced by a specified MemoriUser object.
+   * @param {string} sessionId The session ID
+   * @param {string} userID The User object ID
+   */
+  getMemoriUserTopics: async (sessionId: string, userID: string) =>
+    apiFetcher(`/UserTopics/${sessionId}/${userID}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of Topic objects.
+         */
+        count: number;
+        /**
+         * List of Topic objects. May be empty.
+         */
+        topics: Topic[];
+      }
+    >,
+
+  /**
+   * Lists all Topic objects referenced by a specified MemoriUser object, with pagination.
+   * @param {string} sessionId The session ID
+   * @param {string} userID The User object ID
+   * @param {number} from The 0-based index of the first Topics object to list
+   * @param {number} howMany The number of the Topics objects to list
+   */
+  getMemoriUserTopicsPaginated: async (
+    sessionId: string,
+    userID: string,
+    from: number,
+    howMany: number
+  ) =>
+    apiFetcher(`/UserTopics/${sessionId}/${userID}/${from}/${howMany}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        /**
+         * Total number of Topic objects.
+         */
+        count: number;
+        /**
+         * List of Topic objects. May be empty.
+         */
+        topics: Topic[];
+      }
+    >,
+});

package/src/engine.ts

@@ -6,7 +6,6 @@ import media from './engine/media';
 import memories from './engine/memories';
 import nlp from './engine/nlp';
 import people from './engine/people';
-import promptedQuestions from './engine/promptedQuestions';
 import search from './engine/search';
 import session from './engine/session';
 import stats from './engine/stats';
@@ -16,6 +15,8 @@ import customDictionary from './engine/customDictionary';
 import chatLogs from './engine/chatLogs';
 import expertReferences from './engine/expertReferences';
 import knownFacts from './engine/knownFacts';
+import user from './engine/user';
+import topics from './engine/topics';
 
 export default (apiUrl: string) => ({
   correlationPairs: correlationPairs(apiUrl),
@@ -34,8 +35,6 @@ export default (apiUrl: string) => ({
   ...nlp(apiUrl),
   people: people(apiUrl),
   ...people(apiUrl),
-  promptedQuestions: promptedQuestions(apiUrl),
-  ...promptedQuestions(apiUrl),
   search: search(apiUrl),
   ...search(apiUrl),
   session: session(apiUrl),
@@ -54,4 +53,8 @@ export default (apiUrl: string) => ({
   ...expertReferences(apiUrl),
   knownFacts: knownFacts(apiUrl),
   ...knownFacts(apiUrl),
+  user: user(apiUrl),
+  ...user(apiUrl),
+  topics: topics(apiUrl),
+  ...topics(apiUrl),
 });

package/src/helpers/asset.ts

@@ -13,14 +13,14 @@ export default (apiUrl: string) => ({
    * @param {string=} params.type - wheather is the avatar or the cover
    * @param {string=} params.resourceURI - the resource URI
    * @param {string=} params.sessionID - the session ID, required for memory media attachments
-   * @param {string=} params.baseURL - the base URL for default static assets (defaults to https://app.twincreator.com)
+   * @param {string=} params.baseURL - the base URL for default static assets (defaults to https://aisuru.com)
    * @returns {string}
    */
   getResourceUrl: ({
     type,
     resourceURI,
     sessionID,
-    baseURL = 'https://app.twincreator.com',
+    baseURL = 'https://aisuru.com',
   }: ResourceURLParams): string => {
     let defaultUri =
       type === 'cover'