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

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.0",
+  "version": "2.0.0",
   "name": "@memori.ai/memori-api-client",
   "description": "React library to integrate a Memori in your app or website",
   "license": "Apache-2.0",
@@ -9,62 +9,111 @@
   "keywords": [
     "memori",
     "memori-ai",
+    "conversational-agents",
     "conversational-ai",
+    "nlp",
+    "typescript",
+    "ai",
     "api-client",
     "api-wrapper"
   ],
   "author": "Memori Srl",
   "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "module": "esm/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist",
+    "esm",
     "src",
-    "README.md",
+    "CHANGELOG.md",
     "LICENSE",
-    "CHANGELOG.md"
+    "README.md"
   ],
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "packageManager": "yarn@3.2.3",
   "scripts": {
-    "start": "tsdx watch",
-    "build": "tsdx build",
-    "test": "NODE_ENV=test tsdx test",
-    "test:husky": "NODE_ENV=test CI=true tsdx test --bail --colors",
-    "test:ci": "tsdx test --ci",
-    "lint": "tsdx lint",
-    "format": "prettier --write '**/*.{tsx,ts}'",
-    "typecheck": "tsc -b",
-    "prepare": "tsdx build; is-ci || husky install",
+    "clean": "rimraf dist esm",
+    "build:cjs": "tsc --module commonjs --outDir dist",
+    "build:esm": "tsc --module esnext --outDir esm",
+    "prebuild": "yarn clean",
+    "build": "yarn build:cjs && yarn build:esm",
+    "test:ci": "jest --passWithNoTests --ci",
+    "test:coverage": "jest --coverage src",
+    "test": "jest",
+    "lint": "eslint --ignore-path .gitignore \"src/**/*.+(ts|js|tsx)\"",
+    "typecheck": "tsc --noEmit",
+    "prepare:husky": "is-ci || husky install",
+    "prepare": "yarn build && yarn prepare:husky",
     "size": "size-limit",
     "analyze": "size-limit --why",
-    "prerelase": "tsdx build && git add . && git commit -m 'chore: update dist'",
+    "format": "prettier --write src test",
     "release": "release-it"
   },
-  "peerDependencies": {},
-  "husky": {
-    "hooks": {
-      "pre-commit": "tsdx lint"
-    }
-  },
   "prettier": {
     "printWidth": 80,
     "semi": true,
     "singleQuote": true,
-    "endOfLine": "lf",
-    "trailingComma": "es5"
+    "trailingComma": "es5",
+    "arrowParens": "avoid",
+    "endOfLine": "auto",
+    "overrides": [
+      {
+        "files": "*.css",
+        "options": {
+          "tabWidth": 4,
+          "printWidth": 120
+        }
+      },
+      {
+        "files": "*.json",
+        "options": {
+          "printWidth": 200
+        }
+      }
+    ]
   },
-  "module": "dist/memori-api-client.esm.js",
-  "size-limit": [
-    {
-      "path": "dist/memori-api-client.cjs.production.min.js",
-      "limit": "10 KB"
+  "eslintIgnore": [
+    "/node_modules",
+    "/build",
+    "/dist",
+    "/esm"
+  ],
+  "eslintConfig": {
+    "env": {
+      "browser": true,
+      "es2021": true,
+      "jest": true
     },
-    {
-      "path": "dist/memori-api-client.esm.js",
-      "limit": "10 KB"
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "ecmaFeatures": {
+        "jsx": true
+      },
+      "ecmaVersion": "latest",
+      "sourceType": "module"
+    },
+    "extends": [
+      "prettier"
+    ],
+    "plugins": [
+      "jest",
+      "@typescript-eslint",
+      "prettier"
+    ],
+    "rules": {
+      "endOfLine": "off",
+      "react/no-unknown-property": "off",
+      "react/require-default-props": "off",
+      "no-console": "off",
+      "no-shadow": "off"
     }
-  ],
+  },
   "release-it": {
     "hooks": {
       "after:bump": "yarn build"
@@ -108,22 +157,39 @@
       }
     }
   },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
+  "size-limit": [
+    {
+      "path": "dist/memori-api-client.cjs.production.min.js",
+      "limit": "10 KB"
+    },
+    {
+      "path": "dist/memori-api-client.esm.js",
+      "limit": "10 KB"
+    }
+  ],
   "devDependencies": {
-    "@commitlint/cli": "17.0.3",
-    "@commitlint/config-conventional": "17.0.3",
-    "@release-it/conventional-changelog": "5.0.0",
-    "@size-limit/preset-small-lib": "7.0.8",
-    "husky": "8.0.1",
+    "@commitlint/cli": "17.3.0",
+    "@commitlint/config-conventional": "17.3.0",
+    "@release-it/conventional-changelog": "5.1.1",
+    "@size-limit/preset-small-lib": "8.1.0",
+    "@types/jest": "29.2.4",
+    "@typescript-eslint/eslint-plugin": "5.45.1",
+    "@typescript-eslint/parser": "5.45.1",
+    "eslint": "8.29.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-jest": "27.1.5",
+    "eslint-plugin-prettier": "4.2.1",
+    "husky": "8.0.2",
     "is-ci": "3.0.1",
-    "release-it": "15.1.1",
-    "size-limit": "7.0.8",
-    "tsdx": "0.14.1",
-    "tslib": "2.4.0",
-    "typescript": "4.7.4"
+    "jest": "29.3.1",
+    "prettier": "2.8.0",
+    "release-it": "15.5.0",
+    "rimraf": "3.0.2",
+    "size-limit": "8.1.0",
+    "ts-jest": "29.0.3",
+    "tslib": "2.4.1",
+    "typescript": "4.9.3"
   },
   "dependencies": {
     "cross-fetch": "^3.1.5"

package/src/backend/asset.test.ts

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

package/src/backend/consumptionLogs.test.ts

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

package/src/backend/integration.test.ts

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

package/src/backend/invitation.test.ts

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

package/src/backend/memori.test.ts

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

package/src/backend/notifications.test.ts

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

package/src/backend/user.test.ts

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

package/src/client.test.ts

@@ -0,0 +1,48 @@
+import memori from './index';
+
+const client = memori();
+
+describe('client', () => {
+  it('works', async () => {
+    expect(
+      await client.backend.memori.getMemoriById(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works with shorthand version', async () => {
+    expect(
+      await client.backend.getMemoriById(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+
+  it('has backend queries', () => {
+    expect(Object.keys(client.backend).length).toBeGreaterThan(0);
+  });
+
+  it('has engine queries', () => {
+    expect(Object.keys(client.session).length).toBeGreaterThan(0);
+  });
+
+  it('has constants', () => {
+    expect(Object.keys(client.constants).length).toBeGreaterThan(0);
+  });
+
+  it('has asset helper', () => {
+    expect(client.asset.getResourceUrl).toBeDefined();
+    expect(client.asset.getResourceUrl).toBeInstanceOf(Function);
+  });
+
+  it('asset helper works', () => {
+    expect(
+      client.asset.getResourceUrl({
+        type: 'avatar',
+      })
+    ).toBe('https://app.twincreator.com/images/memoriAvatar.png');
+  });
+});

package/src/constants.test.ts

@@ -0,0 +1,12 @@
+import memori from './index';
+
+const client = memori();
+
+describe('constants', () => {
+  it('has allowed mimetypes constant', () => {
+    expect(client.constants.allowedMediaTypes).toHaveLength(17);
+  });
+  it('has anon tag', () => {
+    expect(client.constants.anonTag).toBe('👤');
+  });
+});

package/src/engine/chatLogs.test.ts

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

package/src/engine/contextVars.test.ts

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

package/src/engine/correlationPairs.test.ts

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

package/src/engine/customDictionary.test.ts

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

package/src/engine/dialog.test.ts

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

package/src/engine/importExport.test.ts

@@ -0,0 +1,38 @@
+import { ImportParams } from '../../src/types';
+import memori from '../index';
+
+const client = memori('https://backend.memori.ai');
+
+describe('engine/importExport api', () => {
+  const importCsvParams: ImportParams = {
+    includedRows: [0, 1],
+    forceImport: false,
+    csvSpecs: {
+      hasHeaders: false,
+      questionColumnName: 'Title',
+      answerColumnName: 'Answers',
+      csvSeparator: ',',
+      questionTitleVariantsSeparator: '|',
+    },
+  };
+
+  it('works on import apis', async () => {
+    expect(
+      await client.importExport.importCSV(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        ['Title,Answers', 'Chi sei?,Sono un Memori'],
+        importCsvParams
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on import apis with shorthand version', async () => {
+    expect(
+      await client.importCSV(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        ['Title,Answers', 'Chi sei?,Sono un Memori'],
+        importCsvParams
+      )
+    ).not.toBeNull();
+  });
+});

package/src/engine/importExport.ts

@@ -1,8 +1,8 @@
 import {
   ResponseSpec,
-  ImportReponse,
-  ExportCSVParams,
   ImportParams,
+  ImportResponse,
+  ExportCSVParams,
 } from '../types';
 import { apiFetcher } from '../apiFetcher';
 
@@ -27,7 +27,25 @@ export default (apiUrl: string) => ({
         rows,
         ...params,
       },
-    }) as Promise<ResponseSpec & ImportReponse>,
+    }) 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.
@@ -37,7 +55,11 @@ export default (apiUrl: string) => ({
     apiFetcher(`/ImportExport/ImportStatus/${importID}`, {
       method: 'GET',
       apiUrl,
-    }) as Promise<ResponseSpec & ImportReponse>,
+    }) as Promise<
+      ResponseSpec & {
+        status: ImportResponse;
+      }
+    >,
 
   /**
    * Interrupts an ongoing Import process.
@@ -47,7 +69,11 @@ export default (apiUrl: string) => ({
     apiFetcher(`/ImportExport/StopImport/${importID}`, {
       method: 'POST',
       apiUrl,
-    }) as Promise<ResponseSpec & ImportReponse>,
+    }) as Promise<
+      ResponseSpec & {
+        status: ImportResponse;
+      }
+    >,
 
   /**
    * Imports memories from a TXT file.
@@ -67,7 +93,11 @@ export default (apiUrl: string) => ({
         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();
+  });
+});