@memori.ai/memori-api-client 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,410 @@
+export declare type Error = {
+    code: number;
+    message: string;
+};
+export declare type ResponseSpec = {
+    requestID: string;
+    requestDateTime: string;
+    resultCode: number;
+    resultMessage: string;
+};
+export declare type MemoriConfig = {
+    memoriConfigID: string;
+    useCase: string;
+    culture: string;
+    descriptions?: {
+        [lang: string]: string;
+    };
+    dialogExamples?: {
+        [lang: string]: string;
+    };
+    logoURL?: string;
+};
+export declare type Memori = {
+    memoriID: string;
+    name: string;
+    password?: string;
+    recoveryTokens?: string[];
+    newPassword?: string;
+    ownerUserID?: string;
+    ownerTenantName?: string;
+    memoriConfigurationID: string;
+    description: string;
+    engineMemoriID?: string;
+    isGiver?: boolean;
+    isReceiver?: boolean;
+    giverTag?: string;
+    giverPIN?: string;
+    privacyType: 'PUBLIC' | 'PRIVATE' | 'SECRET';
+    secretToken?: string;
+    minimumNumberOfRecoveryTokens?: number;
+    totalNumberOfRecoveryTokens?: number;
+    avatarURL?: string;
+    coverURL?: string;
+    needsPosition?: boolean;
+    voiceType: string;
+    culture?: string;
+    publishedInTheMetaverse?: boolean;
+    metaverseEnvironment?: string;
+    properties?: {
+        [key: string]: string;
+    };
+    creationTimestamp?: string;
+    lastChangeTimestamp?: string;
+    integrations?: Integration[];
+    sentInvitations?: Invitation[];
+    receivedInvitations?: Invitation[];
+    categories?: string[];
+    ownerUserName?: string;
+};
+export declare type Venue = {
+    placeName: string;
+    latitude: number;
+    longitude: number;
+    uncertainty?: number;
+};
+export declare type User = {
+    tenant?: string;
+    userID?: string;
+    userName?: string;
+    password?: string;
+    newPassword?: string;
+    eMail?: string;
+    admin?: boolean;
+    superAdmin?: boolean;
+    verificationCode?: string;
+    flowID?: string;
+    newsletterSubscribed?: boolean;
+    maxMemori?: number;
+    canCreateMemori?: boolean;
+    canAccessAPI?: boolean;
+    canEditIntegrations?: boolean;
+    canEditDynamicIntents?: boolean;
+    canEditMemoriChaining?: boolean;
+    maxFreeSessions?: number;
+    creationTimestamp?: string;
+    lastChangeTimestamp?: string;
+};
+export declare type IntegrationResource = {
+    name: string;
+    url: string;
+};
+export declare type IntegrationType = 'GOOGLE' | 'ALEXA' | 'LANDING_EXPERIENCE';
+export declare type Integration = {
+    integrationID?: string;
+    memoriID?: string;
+    type: IntegrationType;
+    state?: 'NEW' | 'PROCESSING' | 'DONE' | 'REMOVED' | 'ERROR' | 'WAITING_MANUAL_ACTION' | 'DRAFT' | 'NOT_VALIDATED' | 'PUBLISHED';
+    publish?: boolean;
+    deviceEmails?: string[];
+    invocationText?: string;
+    jobID?: string;
+    customData?: string;
+    resources?: IntegrationResource[];
+    creationTimestamp?: string | Date;
+    lastChangeTimestamp?: string | Date;
+    dataResult?: {
+        [key: string]: any;
+    };
+};
+export declare type PublicIntegrationListItem = {
+    integration: Integration;
+    memori: Memori;
+    memoriUser: User;
+    remoteMemoriId?: string;
+};
+export interface RcFile extends File {
+    readonly lastModifiedDate: string | Date;
+    uid: string;
+}
+export declare type UploadFileStatus = 'error' | 'success' | 'done' | 'uploading' | 'removed';
+export interface UploadFile<T = any> {
+    uid: string;
+    size?: number;
+    name: string;
+    fileName?: string;
+    lastModified?: number;
+    lastModifiedDate?: string | Date;
+    url?: string;
+    status?: UploadFileStatus;
+    percent?: number;
+    thumbUrl?: string;
+    originFileObj?: RcFile;
+    response?: T;
+    error?: any;
+    linkProps?: any;
+    type?: string;
+    xhr?: T;
+    preview?: string;
+}
+export declare type TenantConfig = {
+    name: string;
+    showNewUser: boolean;
+    requirePosition: boolean;
+    feedbackURL?: string;
+};
+export declare type Tenant = {
+    id: string;
+    theme: string;
+    config: TenantConfig;
+    disableRegistration?: boolean;
+    maxMemoriPerAdmin?: number;
+    maxMemoriPerUser?: number;
+    maxTotalMemori?: number;
+    maxAdmins?: number;
+    maxUsers?: number;
+    usersCanCreateMemori?: boolean;
+    usersCanAccessAPI?: boolean;
+    usersCanEditIntegrations?: boolean;
+    usersCanEditDynamicIntents?: boolean;
+    usersCanEditMemoriChaining?: boolean;
+    maxFreeSessions?: number;
+    maxFreeSessionsPerUser?: number;
+};
+export declare type OpenSession = {
+    memoriID: string;
+    password?: string;
+    recoveryTokens?: string[];
+    tag?: string;
+    pin?: string;
+    initialContextVars?: {
+        [key: string]: string;
+    };
+};
+export declare type MemoriSession = {
+    sessionID: string;
+    currentState: DialogState;
+    stats?: Stats;
+};
+export declare type Medium = {
+    mediumID: string;
+    url?: string;
+    content?: string;
+    mimeType: string;
+    title?: string;
+    properties?: {
+        [key: string]: string;
+    };
+    creationTimestamp?: string;
+    creationName?: string;
+    lastChangeTimestamp?: string;
+    lastChangeName?: string;
+};
+export declare type Stats = {
+    totalReceivers: number;
+    receiversWithMemories: number;
+    totalMemories: number;
+    publicMemories: number;
+    memoriesWithMedia: number;
+    totalQuestions: number;
+    publicQuestions: number;
+    questionsWithMoreThanOneAnswer: number;
+    totalStories: number;
+    publicStories: number;
+    storiesWithDate: number;
+    storiesWithPlace: number;
+    storiesWithDateAndPlace: number;
+    unansweredQuestions: number;
+    successfulCorrelations: number;
+    failedCorrelations: number;
+};
+export declare type GamificationLevel = {
+    points: number;
+    badge: string;
+    pointsForCurrentBadge: number;
+    nextBadge: {
+        points: number;
+        badge: string;
+    };
+};
+export declare type EventLog = {
+    eventLogID: string;
+    timestamp: string;
+    eventType: string;
+    memoriID: string;
+    userAgent?: string;
+    ipAddress?: string;
+    memoryID?: string;
+    intentID?: string;
+    enteredText?: string;
+    receiverTag?: string;
+};
+export declare type UserLog = {
+    timestamp: string;
+    count: number;
+};
+export declare type UsersLog = {
+    timestamp: string;
+    countUsers: number;
+    countRecurrentUsers: number;
+};
+export declare type TranslatedHint = {
+    text: string;
+    originalText: string;
+};
+export declare type DialogState = {
+    state: string;
+    stateName: string;
+    previousState: string;
+    confidence?: number;
+    emission?: string;
+    acceptsTimeout?: boolean;
+    acceptsAbort?: boolean;
+    acceptsMedia?: boolean;
+    acceptsDate?: boolean;
+    acceptsPlace?: boolean;
+    acceptsTag?: boolean;
+    hints?: string[];
+    translatedHints?: TranslatedHint[];
+    currentTag?: string;
+    currentDate?: string;
+    currentPlaceName?: string;
+    currentLatitude?: number;
+    currentLongitude?: number;
+    currentUncertaintyKm?: number;
+    giverID?: string;
+    currentReceiverID?: string;
+    currentMemoryID?: string;
+    media?: Medium[];
+    knownTags?: {
+        [key: string]: string;
+    };
+    contextVars?: {
+        [key: string]: string;
+    };
+};
+export declare type Person = {
+    personID?: string;
+    personType: 'Giver' | 'Receiver';
+    name?: string;
+    information?: string;
+    pin: string;
+    tag: string;
+    creationTimestamp?: string;
+    creationName?: string;
+    lastChangeTimestamp?: string;
+    lastChangeName?: string;
+};
+export declare type PersonificationProfile = {
+    tag?: string;
+    pin?: string;
+    name?: string;
+    sessionID: string;
+};
+export declare type Invitation = {
+    invitationID?: string;
+    memoriID: string;
+    isInviter?: boolean;
+    isInvitee?: boolean;
+    text?: string;
+    destinationEMail: string;
+    destinationName: string;
+    tag: string;
+    pin: string;
+    type: string;
+    state?: 'PENDING' | 'ACCEPTED' | 'REJECTED';
+    creationTimestamp?: string;
+    lastChangeTimestamp?: string;
+};
+export declare type LocalizationKeyContent = {
+    key: string;
+    value: string;
+};
+export declare type LocalizationKey = LocalizationKeyContent & {
+    creationTimestamp?: string;
+    creationName?: string;
+    lastChangeTimestamp?: string;
+    lastChangeName?: string;
+};
+export declare type Asset = {
+    assetID: string;
+    assetURL: string;
+    mimeType: string;
+    memoriID: string;
+    originalFileName?: string;
+    title?: string;
+    engineMemoryID?: string;
+    creationTimestamp: string;
+    lastChangeTimestamp: string;
+};
+export declare type SearchQuery = {
+    text: string;
+    searchType?: 'Literal' | 'Semantic';
+    date?: string;
+    dateUncertaintyDays?: number;
+    placeName?: string;
+    placeLatitude?: number;
+    placeLongitude?: number;
+    placeUncertaintyKm?: number;
+    tag?: string;
+    ignoreLastRead?: boolean;
+    excludedMemoryIDs?: string[];
+    numberOfResults?: number;
+};
+export declare type SearchMatches = {
+    confidence: number;
+    confidenceLevel?: 'LOW' | 'MEDIUM' | 'HIGH';
+    memory: Memory;
+};
+export declare type Answer = {
+    text: string;
+    preformatted?: boolean;
+    creationTimestamp?: string;
+    creationName?: string;
+    lastChangeTimestamp?: string;
+    lastChangeName?: string;
+};
+export declare type Memory = {
+    memoryID: string;
+    memoryType: string;
+    lastRead?: string;
+    readOccurrencies?: number;
+    receiverID?: string;
+    receiverTag?: string;
+    receiverName?: string;
+    media?: Medium[];
+    text?: string;
+    textVariants?: string[];
+    answers?: Answer[];
+    title?: string;
+    titleVariants?: string[];
+    date?: string;
+    dateUncertaintyDays?: number;
+    placeName?: string;
+    placeLatitude?: number;
+    placeLongitude?: number;
+    placeUncertaintyKm?: number;
+    preformatted?: boolean;
+    conclusive?: boolean;
+    help?: boolean;
+    notPickable?: boolean;
+    contextVarsToSet?: {
+        [variable: string]: string;
+    };
+    contextVarsToMatch?: {
+        [variable: string]: string;
+    };
+    creationTimestamp?: string;
+    creationName?: string;
+    lastChangeTimestamp?: string;
+    lastChangeName?: string;
+};
+export declare type UnansweredQuestion = {
+    unansweredQuestionID?: string;
+    text: string;
+    occurrencies: number;
+    receiverID?: string;
+    receiverTag?: string;
+    receiverName?: string;
+    creationTimestamp?: string;
+    creationName?: string;
+    lastChangeTimestamp?: string;
+    lastChangeName?: string;
+    candidateAnswers?: SearchMatches[];
+};
+export declare type Message = {
+    text: string;
+    fromUser?: boolean;
+    media?: Medium[];
+    initial?: boolean;
+};

package/package.json

@@ -0,0 +1,125 @@
+{
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "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",
+    "size": "size-limit",
+    "analyze": "size-limit --why",
+    "prerelase": "tsdx build",
+    "release": "release-it"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/memori-ai/memori-api-client#readme",
+  "bugs": "https://github.com/memori-ai/memori-api-client/issues",
+  "repository": "https://github.com/memori-ai/memori-api-client.git",
+  "keywords": [
+    "memori",
+    "memori-ai",
+    "conversational-ai",
+    "api-client",
+    "api-wrapper"
+  ],
+  "peerDependencies": {},
+  "husky": {
+    "hooks": {
+      "pre-commit": "tsdx lint"
+    }
+  },
+  "prettier": {
+    "printWidth": 80,
+    "semi": true,
+    "singleQuote": true,
+    "endOfLine": "lf",
+    "trailingComma": "es5"
+  },
+  "name": "@memori.ai/memori-api-client",
+  "author": "Memori Srl",
+  "module": "dist/memori-api-client.esm.js",
+  "size-limit": [
+    {
+      "path": "dist/memori-api-client.cjs.production.min.js",
+      "limit": "10 KB"
+    },
+    {
+      "path": "dist/memori-api-client.esm.js",
+      "limit": "10 KB"
+    }
+  ],
+  "release-it": {
+    "git": {
+      "tagName": "v${version}",
+      "commitMessage": "chore: release v${version}"
+    },
+    "npm": {
+      "publish": true,
+      "skipChecks": true
+    },
+    "github": {
+      "release": true,
+      "releaseName": "${version}"
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "infile": "CHANGELOG.md",
+        "preset": {
+          "name": "conventionalcommits",
+          "types": [
+            {
+              "type": "feat",
+              "section": "Features"
+            },
+            {
+              "type": "fix",
+              "section": "Bug Fixes"
+            },
+            {
+              "type": "refactor",
+              "section": "Changes"
+            },
+            {
+              "type": "chore",
+              "section": "Maintenance"
+            }
+          ]
+        }
+      }
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "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",
+    "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"
+  },
+  "dependencies": {
+    "cross-fetch": "^3.1.5",
+    "microsoft-cognitiveservices-speech-sdk": "1.22.0"
+  }
+}

package/src/apiFetcher.ts

@@ -0,0 +1,29 @@
+import { default as fetch } from 'cross-fetch';
+
+export const fetcher = (
+  path: string,
+  opts: {
+    apiUrl: string;
+    method?: string;
+    body?: object;
+    headers?: object;
+  }
+) =>
+  fetch(`${opts.apiUrl}${path}`, {
+    ...opts,
+    body: opts?.body ? JSON.stringify(opts.body) : undefined,
+    mode: 'cors',
+    credentials: 'include',
+    headers: {
+      // "Access-Control-Allow-Origin": "*",
+      'Content-Type': 'application/json',
+      ...opts?.headers,
+    },
+  }).then(res => res.json());
+
+export const devFetcher = (data: any) => Promise.resolve(data);
+
+export const apiFetcher =
+  process.env.CI === 'true' || process.env.NODE_ENV === 'test'
+    ? devFetcher
+    : fetcher;

package/src/backend/asset.ts

@@ -0,0 +1,86 @@
+import { ResponseSpec, Asset } from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+export 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) =>
+    `${apiUrl}/Asset/${authToken}/${memoriID}${memoryID ? `/${memoryID}` : ''}`,
+
+  /**
+   * 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: async (
+    fileName: string,
+    fileUrl: string,
+    authToken: string,
+    memoriID: string,
+    memoryID?: string
+  ) => {
+    const data = new FormData();
+    const file = await fetch(fileUrl);
+    const fileBlob = await file.blob();
+
+    data.append(fileName, fileBlob, fileName);
+
+    const upload = await fetch(
+      `${apiUrl}/Asset/${authToken}/${memoriID}${
+        memoryID ? `/${memoryID}` : ''
+      }`,
+      {
+        method: 'POST',
+        body: data,
+      }
+    );
+    return (await upload.json()) as 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) =>
+    apiFetcher(`/Asset/${fileName}/${sessionID}`, {
+      apiUrl,
+      method: 'GET',
+    }),
+
+  /**
+   * 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) =>
+    apiFetcher(`/Asset/${authToken}/${assetURL.split('/').reverse()[0]}`, {
+      apiUrl,
+      method: 'PATCH',
+      body: asset,
+    }) as 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) =>
+    apiFetcher(`/Asset/${authToken}/${assetURL.split('/').reverse()[0]}`, {
+      apiUrl,
+      method: 'DELETE',
+    }) as Promise<ResponseSpec>,
+});