@memori.ai/memori-api-client 0.1.0

package/LICENSE

@@ -0,0 +1,18 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2022 Memori Srl
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -0,0 +1,188 @@
+# memori-api-client
+
+[![npm version](https://img.shields.io/github/package-json/v/memori-ai/memori-api-client)](https://www.npmjs.com/package/@memoriai/memori-api-client)
+![Tests](https://github.com/memori-ai/memori-api-client/workflows/CI/badge.svg?branch=main)
+![TypeScript Support](https://img.shields.io/badge/TypeScript-Support-blue)
+
+TypeScript client to integrate with [Memori](https://memori.ai) API.
+
+## Installation
+
+```bash
+yarn add @memori.ai/memori-api-client
+```
+
+```bash
+npm install @memori.ai/memori-api-client
+```
+
+## Usage
+
+Every method has JSDoc annotations with usage and description and typings information.
+
+See an example [here](https://github.com/memori-ai/examples/blob/main/ts-sdk/index.ts).
+
+```ts
+import memoriApiClient from '@memori.ai/memori-api-client';
+
+const memori = memoriApiClient('https://backend.memori.ai');
+
+(async () => {
+  const { sessionID, currentState, ...response } = await memori.initSession(
+    '768b9654-e781-4c3c-81fa-ae1529d1bfbe'
+  );
+
+  const {
+    currentState: dialogState,
+    ...resp
+  } = await memori.postTextEnteredEvent(sessionID, 'Ciao, Memori!');
+})();
+```
+
+For the specification of the APIs, see the typings or the documentation from the dashboard if you are allowed to see it.
+
+### Constants
+
+```ts
+import memoriApiClient from '@memori.ai/memori-api-client';
+
+const memori = memoriApiClient('https://backend.memori.ai');
+
+memori.constants.allowedMediaTypes; // list of allowed media types in asset upload
+memori.constants.anonTag; // tag for anonymous users
+```
+
+### TTS
+
+Bundled with this client there is a TTS utility that can be used to synthesize text to speech.
+
+```ts
+const memori = memoriApiClient('https://backend.memori.ai');
+
+// Needs Azure Speech API key
+// See https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/quickstarts/setup-platform?pivots=programming-language-javascript
+// Second parameter is for debug mode
+const speechSdk = memori.speech(AZURE_COGNITIVE_SERVICES_TTS_KEY, true);
+
+// Requires the language code of the text to be spoken
+// And the voice type (female or male)
+const speech = speechSdk('it', 'FEMALE');
+
+speech.speak('Ciao, Memori!', () => {
+  console.log('spoken');
+});
+
+speech.isSpeaking();
+
+speech.stopSpeaking();
+```
+
+### STT
+
+There is also a speech recognition utility.
+
+```ts
+// Same as for the TTS
+const speech = speechSdk('it', 'FEMALE');
+
+speech.recognize(transcript => {
+  console.log('Recognized ', transcript);
+});
+
+speech.isRecognizing();
+
+speech.stopRecognizing();
+```
+
+### Asset
+
+There is a helper method parsing media urls from the DB, handling different cases
+
+```ts
+const memori = memoriApiClient('https://backend.memori.ai');
+
+memori.asset.getResourceUrl({
+  type: 'avatar',
+  resourceURI: '768b9654-e781-4c3c-81fa-ae1529d1bfbe.png',
+  mediaType: 'image/png',
+  sessionId: 'be2e4a44-890b-483b-a26a-f6e122f36e2b',
+});
+```
+
+## Development
+
+To run TSDX, use:
+
+```bash
+npm start # or yarn start
+```
+
+This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
+
+To do a one-off build, use `npm run build` or `yarn build`.
+
+To run tests, use `npm test` or `yarn test`.
+
+### Formatting and linting
+
+Code quality is set up with `prettier`, `husky`, and `lint-staged`.
+
+You can run prettier with `npm format` or `yarn format`.
+You can run linter with `npm lint` or `yarn lint`.
+You can run type checking with `npm typecheck` or `yarn typecheck`.
+
+### Jest
+
+Jest tests are set up to run with `npm test` or `yarn test`.
+
+### Bundle Analysis
+
+[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.
+
+### Rollup
+
+TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
+
+### TypeScript
+
+`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`.
+You can run type checking with `npm typecheck` or `yarn typecheck`.
+
+### Continuous Integration
+
+#### GitHub Actions
+
+Two actions are added by default:
+
+- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
+- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
+
+### Optimizations
+
+Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
+
+```js
+// ./types/index.d.ts
+declare var __DEV__: boolean;
+
+// inside your code...
+if (__DEV__) {
+  console.log('foo');
+}
+```
+
+You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
+
+### Module Formats
+
+CJS, ESModules, and UMD module formats are supported.
+
+The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
+
+### Commitlint
+
+We use [commmitlint](https://commitlint.js.org/) for commit message validation based on [Conventional Commits](https://www.conventionalcommits.org/en/).
+
+### Release
+
+Changelog and release management with [release-it](https://github.com/release-it/release-it), using [convential changelog](https://github.com/release-it/conventional-changelog).

package/dist/apiFetcher.d.ts

@@ -0,0 +1,13 @@
+export declare const fetcher: (path: string, opts: {
+    apiUrl: string;
+    method?: string;
+    body?: object;
+    headers?: object;
+}) => Promise<any>;
+export declare const devFetcher: (data: any) => Promise<any>;
+export declare const apiFetcher: (path: string, opts: {
+    apiUrl: string;
+    method?: string;
+    body?: object;
+    headers?: object;
+}) => Promise<any>;

package/dist/backend/asset.d.ts

@@ -0,0 +1,44 @@
+import { ResponseSpec, Asset } from '../types';
+declare const _default: (apiUrl: string) => {
+    /**
+     * URL to upload a file creating a new Asset object to access it.
+     * @param {string} authToken - The login token
+     * @param {string} memoriID - The memori ID
+     * @param {string=} memoryID - The memory ID
+     * @returns The URL to upload a file
+     */
+    getUploadAssetURL: (authToken: string, memoriID: string, memoryID?: string | undefined) => string;
+    /**
+     * Uploads a file and creates a new Asset object to access it.
+     * @param {string} authToken - The login token
+     * @param {string} memoriID - The memori ID
+     * @param {string=} memoryID - The memory ID
+     * @returns Response of an Upload Asset request.
+     */
+    uploadAsset: (fileName: string, fileUrl: string, authToken: string, memoriID: string, memoryID?: string | undefined) => Promise<ResponseSpec & {
+        asset: Asset;
+    }>;
+    /**
+     * Downloads a file from an Asset object
+     * @param {string} fileName - The file name
+     * @param {string} sessionID - The session ID
+     * @returns The asset file
+     */
+    getAsset: (fileName: string, sessionID: string) => Promise<any>;
+    /**
+     * Updates an Asset object
+     * @param {string} authToken - The login token
+     * @param {string} assetURL - The asset URL
+     * @returns The updated asset object
+     */
+    updateAsset: (authToken: string, assetURL: string, asset: Asset) => Promise<ResponseSpec & {
+        asset: Asset;
+    }>;
+    /**
+     * Deletes an Asset object
+     * @param {string} authToken - The login token
+     * @param {string} assetURL - The asset URL
+     */
+    deleteAsset: (authToken: string, assetURL: string) => Promise<ResponseSpec>;
+};
+export default _default;

package/dist/backend/integration.d.ts

@@ -0,0 +1,55 @@
+import { ResponseSpec, Integration } from '../types';
+declare const _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) => Promise<ResponseSpec & {
+        integrations: Integration[];
+    }>;
+    /**
+     * Gets a list of integration objects.
+     * @param authToken - The login token
+     * @returns A list of Integration objects
+     */
+    getAllIntegrationsList: (authToken: string) => 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) => 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) => 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) => 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) => Promise<ResponseSpec & {
+        integration: Integration;
+    }>;
+};
+export default _default;

package/dist/backend/invitation.d.ts

@@ -0,0 +1,82 @@
+import { ResponseSpec, Invitation } from '../types';
+declare const _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) => 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) => 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) => 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) => 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;
+    }) => 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) => 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) => 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) => 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'>>) => Promise<ResponseSpec & {
+        invitation: Invitation;
+    }>;
+};
+export default _default;

package/dist/backend/memori.d.ts

@@ -0,0 +1,125 @@
+import { ResponseSpec, Memori, MemoriConfig } from '../types';
+declare const _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) => 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) => 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) => 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) => 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) => 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) => 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) => 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) => 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) => Promise<ResponseSpec & {
+        memori: Memori;
+    }>;
+    /**
+     * Deletes an existing Memori object.
+     * @param authToken - The login token
+     * @param memori - The Memori object
+     */
+    deleteMemori: (authToken: string, memori: Memori) => 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) => 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 | undefined) => 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 | undefined) => 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 | undefined, dateTo?: string | undefined) => Promise<ResponseSpec & {
+        totalSessions: number;
+        validSessions: number;
+    }>;
+};
+export default _default;

package/dist/backend/user.d.ts

@@ -0,0 +1,109 @@
+import { ResponseSpec, Tenant, User } from '../types';
+declare const _default: (apiUrl: string) => {
+    /**
+     * Registers a new user.
+     * @param user - The user object
+     * @returns The created user object
+     */
+    userSignIn: (user: User) => 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) => Promise<ResponseSpec & {
+        user: User;
+        token?: string | undefined;
+    }>;
+    /**
+     * 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) => Promise<ResponseSpec & {
+        user: User;
+        token?: string | undefined;
+        flowID?: string | undefined;
+    }>;
+    /**
+     * Logs out the user.
+     * @param authToken - The login token
+     */
+    userLogout: (authToken: string) => 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) => 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) => 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) => 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) => 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) => Promise<ResponseSpec>;
+    /**
+     * Confirms the password reset of a User and performs a Login
+     * @param {User} user - The user object
+     */
+    resetConfirm: (user: User) => Promise<ResponseSpec & {
+        user: User;
+        token?: string | undefined;
+        flowID?: string | undefined;
+    }>;
+    /**
+     * Recovers a User's name and sends it to their configured e-mail.
+     * @param {User} user - The user object
+     */
+    recoverUsername: (user: User) => Promise<ResponseSpec>;
+    /**
+     * Gets the details of a Tenant object.
+     * @param tenantName - The name of the tenant
+     */
+    getTenantConfig: (tenantName: string) => 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>) => Promise<ResponseSpec>;
+    /**
+     * Registers a new user.
+     * @param {User} user - The user object
+     */
+    createUser: (authToken: string, user: Partial<User>) => Promise<ResponseSpec & {
+        user: User;
+    }>;
+};
+export default _default;