@memori.ai/memori-api-client 0.1.0

package/src/backend/integration.ts

@@ -0,0 +1,98 @@
+import { ResponseSpec, Integration } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export default (apiUrl: string) => ({
+  /**
+   * Gets a list of integration objects for a specified Memori object.
+   * @param memoriID - The id of the Memori object
+   * @param authToken - The login token
+   * @returns A list of Integration objects
+   */
+  getMemoriIntegrationsList: (authToken: string, memoriID: string) =>
+    apiFetcher(`/Integrations/${authToken}/${memoriID}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        integrations: Integration[];
+      }
+    >,
+
+  /**
+   * Gets a list of integration objects.
+   * @param authToken - The login token
+   * @returns A list of Integration objects
+   */
+  getAllIntegrationsList: (authToken: string) =>
+    apiFetcher(`/AllIntegrations/${authToken}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        integrations: Integration[];
+      }
+    >,
+
+  /**
+   * Gets the detail of an integration object of the currently logged in User.
+   * @param authToken - The login token
+   * @param integrationID - The ID of the integration object
+   * @returns The Integration object
+   */
+  getIntegration: (authToken: string, integrationID: string) =>
+    apiFetcher(`/Integration/${authToken}/${integrationID}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        integration: Integration;
+      }
+    >,
+
+  /**
+   * Delete an exsisting integration object.
+   * @param authToken - The login token
+   * @param integrationID - The ID of the integration object
+   */
+  deleteIntegration: (authToken: string, integrationID: string) =>
+    apiFetcher(`/Integration/${authToken}/${integrationID}`, {
+      apiUrl,
+      method: 'DELETE',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Register a new integration object.
+   * @param authToken - The login token
+   * @param integration - The Integration object
+   * @returns The Integration object
+   */
+  createIntegration: (authToken: string, integration: Integration) =>
+    apiFetcher(`/Integration/${authToken}`, {
+      apiUrl,
+      method: 'POST',
+      body: integration,
+    }) as Promise<
+      ResponseSpec & {
+        integration: Integration;
+      }
+    >,
+
+  /**
+   * Updates the integration object.
+   * @param authToken - The login token
+   * @param integrationID - The id of the Integration object
+   * @param integration - The Integration object
+   * @returns The Integration object
+   */
+  updateIntegration: (
+    authToken: string,
+    integrationID: string,
+    integration: Integration
+  ) =>
+    apiFetcher(`/Integration/${authToken}/${integrationID}`, {
+      apiUrl,
+      method: 'PATCH',
+      body: integration,
+    }) as Promise<
+      ResponseSpec & {
+        integration: Integration;
+      }
+    >,
+});

package/src/backend/invitation.ts

@@ -0,0 +1,115 @@
+import { ResponseSpec, Invitation } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export default (apiUrl: string) => ({
+  /**
+   * Gets a list of invitations sent by the currently logged in User.
+   * @param {string} authToken - The login token
+   * @returns The list of Invitation objects.
+   */
+  getSentInvitations: (authToken: string) =>
+    apiFetcher(`/SentInvitations/${authToken}`, {
+      apiUrl,
+    }) as Promise<ResponseSpec & { invitations: Invitation[] }>,
+
+  /**
+   * Gets a list of invitations received by the currently logged in User.
+   * @param {string} authToken - The login token
+   * @returns The list of Invitation objects.
+   */
+  getReceivedInvitations: (authToken: string) =>
+    apiFetcher(`/ReceivedInvitations/${authToken}`, {
+      apiUrl,
+    }) as Promise<ResponseSpec & { invitations: Invitation[] }>,
+
+  /**
+   * Gets a list of all invitation objects
+   * @param {string} authToken - The login token
+   * @returns The list of Invitation objects.
+   */
+  getAllInvitations: (authToken: string) =>
+    apiFetcher(`/AllInvitations/${authToken}`, {
+      apiUrl,
+    }) as Promise<ResponseSpec & { invitations: Invitation[] }>,
+
+  /**
+   * Gets the details of an Invitation object of the currently logged in User.
+   * @param {string} authToken - The login token
+   * @param {string} invitationId - The ID of the Invitation object
+   * @returns The Invitation object.
+   */
+  getInvitation: (authToken: string, invitationId: string) =>
+    apiFetcher(`/Invitation/${authToken}/${invitationId}`, {
+      apiUrl,
+    }) as Promise<ResponseSpec & { invitation: Invitation }>,
+
+  /**
+   * Updates an existing Invitation object sent by the currently logged in User.
+   * @param {string} authToken - The login token
+   * @param {Invitation} invitation - The Invitation object
+   * @returns The Invitation object.
+   */
+  updateInvitation: (
+    authToken: string,
+    invitation: Partial<Omit<Invitation, 'invitationID'>> & {
+      invitationID: string;
+    }
+  ) =>
+    apiFetcher(`/Invitation/${authToken}/${invitation.invitationID}`, {
+      apiUrl,
+      method: 'PATCH',
+      body: invitation,
+    }) as Promise<ResponseSpec & { invitation: Invitation }>,
+
+  /**
+   * Deletes an existing Invitation object.
+   * @param {string} authToken - The login token
+   * @param {string} invitationId - The ID of the Invitation object
+   * @returns The Invitation object.
+   */
+  deleteInvitation: (authToken: string, invitationId: string) =>
+    apiFetcher(`/Invitation/${authToken}/${invitationId}`, {
+      apiUrl,
+      method: 'DELETE',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Accepts an Invitation object.
+   * @param {string} authToken - The login token
+   * @param {string} invitationId - The ID of the Invitation object
+   * @returns The Invitation object.
+   */
+  acceptInvitation: (authToken: string, invitationId: string) =>
+    apiFetcher(`/AcceptInvitation/${authToken}/${invitationId}`, {
+      apiUrl,
+      method: 'POST',
+    }) as Promise<ResponseSpec & { invitation: Invitation }>,
+
+  /**
+   * Rejects an Invitation object.
+   * @param {string} authToken - The login token
+   * @param {string} invitationId - The ID of the Invitation object
+   * @returns The Invitation object.
+   */
+  rejectInvitation: (authToken: string, invitationId: string) =>
+    apiFetcher(`/RejectInvitation/${authToken}/${invitationId}`, {
+      apiUrl,
+      method: 'POST',
+    }) as Promise<ResponseSpec & { invitation: Invitation }>,
+
+  /**
+   * Send a new Invitation object
+   * @param {string} authToken - The login token
+   * @param {Invitation} invitation - The Invitation object
+   * @returns The Invitation object.
+   */
+  sendInvitation: (
+    authToken: string,
+    invitation: Partial<Omit<Invitation, 'invitationID'>>
+  ) =>
+    apiFetcher(`/SendInvitation/${authToken}`, {
+      apiUrl,
+      method: 'POST',
+      body: invitation,
+    }) as Promise<ResponseSpec & { invitation: Invitation }>,
+});

package/src/backend/memori.ts

@@ -0,0 +1,223 @@
+import { ResponseSpec, Memori, MemoriConfig } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export default (apiUrl: string) => ({
+  /**
+   * Gets a list of all the public Memori objects for a specific Tenant.
+   * @param tenant - The name of the tenant
+   * @returns A list of Memori objects
+   */
+  getTenantPublicMemoriList: (tenant: string) =>
+    apiFetcher(`/TenantPublicMemori/${encodeURI(tenant)}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        memori: Memori[];
+      }
+    >,
+
+  /**
+   * Gets a list of all the public Memori objects for a specific Tenant accessible from user session.
+   * @param authToken - The login token
+   * @returns A list of Memori objects
+   */
+  getPublicMemoriList: (authToken: string) =>
+    apiFetcher(`/PublicMemori/${authToken}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        memori: Memori[];
+      }
+    >,
+
+  /**
+   * Gets a list of all Memori objects.
+   * @param authToken - The login token
+   * @returns A list of Memori objects
+   */
+  getAllMemori: (authToken: string) =>
+    apiFetcher(`/AllMemori/${authToken}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        memori: Memori[];
+      }
+    >,
+
+  /**
+   * Gets a list of Memori objects for the currently logged in User.
+   * @param authToken - The login token
+   * @returns A list of Memori objects
+   */
+  getUserMemoriList: (authToken: string) =>
+    apiFetcher(`/Memori/${authToken}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        memori: Memori[];
+      }
+    >,
+
+  /**
+   * Gets a list of Memori objects for the currently logged in User.
+   * @param authToken - The login token
+   * @returns A list of Memori objects
+   */
+  getSharedMemoriList: (authToken: string) =>
+    apiFetcher(`/SharedMemori/${authToken}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        memori: Memori[];
+      }
+    >,
+
+  /**
+   * Gets a list of all the known Memori categories (or tags).
+   * @param {string} tenant - The name of the tenant
+   * @returns A list of Memori categories
+   */
+  getTenantCategories: (tenant: string) =>
+    apiFetcher(`/TenantMemoriCategories/${encodeURI(tenant)}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        memoriCategories: string[];
+      }
+    >,
+
+  /**
+   * Gets a list of all the Memori Configuration objects.
+   * @param authToken - The login token
+   * @returns A list of Memori Configuration objects
+   */
+  getMemoriConfigs: (authToken: string) =>
+    apiFetcher(`/MemoriConfigs/${authToken}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        memoriConfigs: MemoriConfig[];
+      }
+    >,
+
+  /**
+   * Register a new Memori object.
+   * @param authToken - The login token
+   * @param memori - The Memori object
+   * @returns The created Memori object
+   */
+  createMemori: (authToken: string, memori: Memori) =>
+    apiFetcher(`/Memori/${authToken}`, {
+      apiUrl,
+      body: memori,
+      method: 'POST',
+    }) as Promise<ResponseSpec & { memori: Memori }>,
+
+  /**
+   * Update an existing Memori object.
+   * @param authToken - The login token
+   * @param memori - The Memori object
+   * @returns The created Memori object
+   */
+  updateMemori: (authToken: string, memori: Memori) =>
+    apiFetcher(`/Memori/${authToken}/${memori.memoriID}`, {
+      apiUrl,
+      body: memori,
+      method: 'PATCH',
+    }) as Promise<ResponseSpec & { memori: Memori }>,
+
+  /**
+   * Deletes an existing Memori object.
+   * @param authToken - The login token
+   * @param memori - The Memori object
+   */
+  deleteMemori: (authToken: string, memori: Memori) =>
+    apiFetcher(`/Memori/${authToken}`, {
+      apiUrl,
+      body: memori,
+      method: 'DELETE',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Gets the details of a Memori object of the currently logged in User.
+   * @param authToken - The login token
+   * @param memoriID - The ID of the Memori object
+   * @returns A Memori object
+   */
+  getMemoriById: (authToken: string, memoriID: string) =>
+    apiFetcher(`/Memori/${authToken}/${memoriID}`, {
+      apiUrl,
+    }) as Promise<ResponseSpec & { memori: Memori }>,
+
+  /**
+   * Gets the details of a Memori object of the currently logged in User.
+   * @param {string} tenantName - The Name of the Tenant
+   * @param {string} userID - The ID of the User object
+   * @param {string} memoriID - The ID of the Memori object
+   * @param {string?} authToken - The login token
+   * @returns A Memori object
+   */
+  getMemoriByUserAndId: (
+    tenantName: string,
+    userID: string,
+    memoriID: string,
+    authToken?: string
+  ) =>
+    apiFetcher(
+      `/MemoriById/${tenantName}/${userID}/${memoriID}${
+        authToken ? `/${authToken}` : ''
+      }`,
+      {
+        apiUrl,
+      }
+    ) as Promise<ResponseSpec & { memori: Memori }>,
+
+  /**
+   * Gets the details of a Memori object by name, owner and tenant
+   * @param {string} tenant - The name of the tenant
+   * @param {string} userName - The name of the user
+   * @param {string} memoriName - The name of the Memori object
+   * @param {string=} [authToken=''] - The token of the Memori object
+   */
+  getMemori: (
+    tenant: string,
+    userName: string,
+    memoriName: string,
+    authToken?: string
+  ) =>
+    apiFetcher(
+      `/Memori/${encodeURI(tenant)}/${encodeURI(userName)}/${encodeURI(
+        memoriName
+      )}/${authToken ?? ''}`,
+      {
+        apiUrl,
+      }
+    ) as Promise<ResponseSpec & { memori: Memori }>,
+
+  /**
+   * Gets the statistics for sessions opened in a specified interval for the specified Memori object.
+   * @param {string} authToken - The login token
+   * @param {string} memoriID - The ID of the Memori object
+   * @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
+   */
+  getMemoriSessions: (
+    authToken: string,
+    memoriID: string,
+    dateFrom?: string,
+    dateTo?: string
+  ) =>
+    apiFetcher(
+      `/MemoriSessions/${authToken}/${memoriID}${
+        dateFrom ? `/${dateFrom}` : ''
+      }${dateFrom && dateTo ? `/${dateTo}` : ''}`,
+      {
+        apiUrl,
+      }
+    ) as Promise<
+      ResponseSpec & {
+        totalSessions: number;
+        validSessions: number;
+      }
+    >,
+});

package/src/backend/user.ts

@@ -0,0 +1,186 @@
+import { ResponseSpec, Tenant, User } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export default (apiUrl: string) => ({
+  /**
+   * Registers a new user.
+   * @param user - The user object
+   * @returns The created user object
+   */
+  userSignIn: (user: User) =>
+    apiFetcher('/User', {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<ResponseSpec & { user: User }>,
+
+  /**
+   * Confirms the registration of a User and performs a Login.
+   * @param user - The user object
+   * @returns The created user object
+   */
+  userConfirmSignIn: (user: User) =>
+    apiFetcher('/UserConfirm', {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<ResponseSpec & { user: User; token?: 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
+   */
+  userLogin: (user: User) =>
+    apiFetcher('/Login', {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<
+      ResponseSpec & { user: User; token?: string; flowID?: string }
+    >,
+
+  /**
+   * Logs out the user.
+   * @param authToken - The login token
+   */
+  userLogout: (authToken: string) =>
+    apiFetcher(`/Logout/${authToken}`, {
+      apiUrl,
+      method: 'POST',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Gets the details of a User object.
+   * @param authToken - The login token
+   * @param userID - The user ID
+   * @returns The user object
+   */
+  getUser: (authToken: string, userID: string) =>
+    apiFetcher(`/User/${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
+   */
+  getUsersList: (authToken: string) =>
+    apiFetcher(`/Users/${authToken}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        users: User[];
+      }
+    >,
+
+  /**
+   * Deletes the currently logged in User.
+   * @param {string} authToken - The login token
+   * @param {string} userID: The User ID
+   */
+  deleteUser: (authToken: string, userID: string) =>
+    apiFetcher(`/User/${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
+   */
+  updateUser: (authToken: string, userID: string, user: User) =>
+    apiFetcher(`/User/${authToken}/${userID}`, {
+      apiUrl,
+      method: 'PATCH',
+      body: user,
+    }) as Promise<
+      ResponseSpec & {
+        user: User;
+      }
+    >,
+
+  /**
+   * Resets a User's password.
+   * If found, the User receives a verification code via e-mail.
+   * The code must be sent via the ResetConfirm API, passing the same User object
+   * sent to this API with the addition of the verification code and the new password.
+   * @param {User} user - The user object
+   */
+  resetPassword: (user: User) =>
+    apiFetcher(`/ResetPassword`, {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Confirms the password reset of a User and performs a Login
+   * @param {User} user - The user object
+   */
+  resetConfirm: (user: User) =>
+    apiFetcher(`/ResetConfirm`, {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<
+      ResponseSpec & {
+        user: User;
+        token?: string;
+        flowID?: string;
+      }
+    >,
+
+  /**
+   * Recovers a User's name and sends it to their configured e-mail.
+   * @param {User} user - The user object
+   */
+  recoverUsername: (user: User) =>
+    apiFetcher(`/RecoverUsername`, {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Gets the details of a Tenant object.
+   * @param tenantName - The name of the tenant
+   */
+  getTenantConfig: (tenantName: string) =>
+    apiFetcher(`/Tenant/${tenantName}`, {
+      apiUrl,
+    }) as Promise<
+      ResponseSpec & {
+        tenant: Tenant;
+      }
+    >,
+
+  /**
+   * Re-sends the verification code to confirm a pending User registration.
+   * @param {User} user - The user object
+   */
+  resendVerificationCode: (user: Partial<User>) =>
+    apiFetcher(`/ResendVerificationCode`, {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Registers a new user.
+   * @param {User} user - The user object
+   */
+  createUser: (authToken: string, user: Partial<User>) =>
+    apiFetcher(`/User/${authToken}`, {
+      apiUrl,
+      body: user,
+      method: 'POST',
+    }) as Promise<ResponseSpec & { user: User }>,
+});

package/src/backend.ts

@@ -0,0 +1,20 @@
+import memori from './backend/memori';
+import user from './backend/user';
+import integration from './backend/integration';
+import asset from './backend/asset';
+import invitation from './backend/invitation';
+
+const backendAPI = (apiUrl: string) => ({
+  asset: asset(apiUrl),
+  memori: memori(apiUrl),
+  user: user(apiUrl),
+  integration: integration(apiUrl),
+  invitation: invitation(apiUrl),
+  ...asset(apiUrl),
+  ...memori(apiUrl),
+  ...user(apiUrl),
+  ...integration(apiUrl),
+  ...invitation(apiUrl),
+});
+
+export default backendAPI;

package/src/constants.ts

@@ -0,0 +1,21 @@
+export const allowedMediaTypes = [
+  'image/jpeg',
+  'image/png',
+  'image/jpg',
+  'image/gif',
+  'text/plain',
+  'application/msword',
+  'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+  'application/vnd.ms-excel',
+  'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+  'application/pdf',
+  'video/mp4',
+  'video/avi',
+  'audio/mpeg3',
+  'audio/wav',
+  'audio/mpeg',
+  'video/mpeg',
+  'model/gltf-binary',
+];
+
+export const anonTag = '👤';

package/src/engine/correlationPairs.ts

@@ -0,0 +1,31 @@
+import { ResponseSpec } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/****************************
+ *                          *
+ *     CorrelationPairs     *
+ *                          *
+ ****************************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Lists all Correlation Pair objects.
+   * @param {string} sessionId The session ID
+   */
+  getCorrelationPairs: async (sessionId: string) =>
+    apiFetcher(`/CorrelationPairs/${sessionId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+
+  /**
+   * Removes an existing Correlation Pair object.
+   * @param {string} sessionId The session ID
+   * @param {string} pairId The Correlation Pair object ID
+   */
+  deleteCorrelationPair: async (sessionId: string, pairId: string) =>
+    apiFetcher(`/CorrelationPair/${sessionId}/${pairId}`, {
+      method: 'GET',
+      apiUrl,
+    }) as Promise<ResponseSpec>,
+});