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

package/esm/index.js

@@ -0,0 +1,16 @@
+import { getApiUrl } from './helpers/getApiUrl';
+import backend from './backend';
+import engine from './engine';
+import * as constants from './constants';
+import asset from './helpers/asset';
+const api = (hostname) => {
+    const apiUrl = getApiUrl(hostname);
+    return {
+        backend: backend(`${apiUrl}/api/v2`),
+        ...engine(`${apiUrl}/memori/v2`),
+        constants,
+        asset: asset(`${apiUrl}/api/v2`),
+    };
+};
+export default api;
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,MAAM,iBAAiB,CAAC;AAEpC,MAAM,GAAG,GAAG,CAAC,QAAiB,EAAE,EAAE;IAChC,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;IAEnC,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,GAAG,MAAM,SAAS,CAAC;QACpC,GAAG,MAAM,CAAC,GAAG,MAAM,YAAY,CAAC;QAChC,SAAS;QACT,KAAK,EAAE,KAAK,CAAC,GAAG,MAAM,SAAS,CAAC;KACjC,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,GAAG,CAAC"}

package/esm/types.d.ts

@@ -0,0 +1,627 @@
+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;
+    avatar3DURL?: string;
+    avatarOriginal3DURL?: string;
+    needsPosition?: boolean;
+    voiceType: string;
+    culture?: string;
+    publishedInTheMetaverse?: boolean;
+    metaverseEnvironment?: string;
+    exposed?: boolean;
+    disableR2R3Loop?: boolean;
+    disableR4Loop?: boolean;
+    disableR5Loop?: boolean;
+    enableCompletions?: boolean;
+    completionDescription?: string;
+    chainingMemoriID?: string;
+    chainingBaseURL?: string;
+    chainingPassword?: string;
+    properties?: {
+        [key: string]: any;
+    };
+    creationTimestamp?: string;
+    lastChangeTimestamp?: string;
+    blockedUntil?: string;
+    integrations?: Integration[];
+    sentInvitations?: Invitation[];
+    receivedInvitations?: Invitation[];
+    categories?: string[];
+    ownerUserName?: string;
+    gamificationLevel?: GamificationLevel;
+    contentQualityIndex?: number;
+    contentQualityIndexTimestamp?: string;
+};
+export declare type Venue = {
+    placeName: string;
+    latitude: number;
+    longitude: number;
+    uncertainty?: number;
+};
+export declare type NotificationPrefs = {
+    chatLogExtractionPeriod?: 'None' | 'Hourly' | 'Daily' | 'Weekly';
+    chatLogExtractionMinLines?: number;
+    memoriID?: string;
+};
+export declare type User = {
+    tenant?: string;
+    userID?: string;
+    userName?: string;
+    password?: string;
+    newPassword?: string;
+    eMail?: string;
+    admin?: boolean;
+    superAdmin?: boolean;
+    verificationCode?: string;
+    dontSendInvitationEmail?: boolean;
+    flowID?: string;
+    newsletterSubscribed?: boolean;
+    maxMemori?: number;
+    numMemori?: number;
+    canCreateMemori?: boolean;
+    canAccessAPI?: boolean;
+    canRunSnippets?: boolean;
+    canEditIntegrations?: boolean;
+    canEditDynamicIntents?: boolean;
+    canEditMemoriChaining?: boolean;
+    monthSessions?: number;
+    monthValidSessions?: number;
+    maxFreeSessions?: number;
+    nonFreeSessionCost?: number;
+    monthCompletions?: number;
+    maxCompletions?: number;
+    creationTimestamp?: string;
+    lastChangeTimestamp?: string;
+    referral?: string;
+    couponCode?: string;
+    paying?: boolean;
+    notificationPrefs?: NotificationPrefs[];
+};
+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;
+    memoriCount?: number;
+    maxAdmins?: number;
+    adminCount?: number;
+    maxUsers?: number;
+    userCount?: number;
+    usersCanCreateMemori?: boolean;
+    usersCanAccessAPI?: boolean;
+    usersCanEditIntegrations?: boolean;
+    usersCanEditDynamicIntents?: boolean;
+    usersCanEditMemoriChaining?: boolean;
+    maxFreeSessions?: number;
+    maxFreeSessionsPerUser?: number;
+    nonFreeSessionCost?: number;
+    maxCompletions?: number;
+    maxCompletionsPerUser?: number;
+    paying?: boolean;
+};
+export declare type OpenSession = {
+    memoriID: string;
+    password?: string;
+    recoveryTokens?: string[];
+    tag?: string;
+    pin?: string;
+    initialContextVars?: {
+        [key: string]: string;
+    };
+    initialQuestion?: 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]: any;
+    };
+    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;
+    confidenceLevel?: 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
+    emission?: string;
+    completion?: boolean;
+    continuationEmitted?: boolean;
+    lastMatchedMemoryID?: string;
+    acceptsTimeout?: boolean;
+    acceptsAbort?: boolean;
+    acceptsMedia?: boolean;
+    acceptsDate?: boolean;
+    acceptsPlace?: boolean;
+    acceptsTag?: boolean;
+    acceptsFeedback?: boolean;
+    hints?: string[];
+    timeout?: number;
+    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;
+    hints?: string[];
+    minTimeout?: number;
+    maxTimeout?: number;
+    contextVarsToSet?: {
+        [variable: string]: string;
+    };
+    contextVarsToMatch?: {
+        [variable: string]: string;
+    };
+    contextVars?: {
+        [variable: string]: string;
+    };
+    creationTimestamp?: string;
+    creationName?: string;
+    creationSessionID?: string;
+    lastChangeTimestamp?: string;
+    lastChangeName?: string;
+    lastChangeSessionID?: string;
+};
+export declare type UnansweredQuestion = {
+    unansweredQuestionID?: string;
+    text: string;
+    occurrencies: number;
+    receiverID?: string;
+    receiverTag?: string;
+    receiverName?: string;
+    creationTimestamp?: string;
+    creationName?: string;
+    creationSessionID?: string;
+    lastChangeTimestamp?: string;
+    lastChangeName?: string;
+    lastChangeSessionID?: string;
+    suggestions?: SearchMatches[];
+};
+export declare type Message = {
+    memoryID?: string;
+    text: string;
+    translatedText?: string;
+    acceptsFeedback?: boolean;
+    generatedByAI?: boolean;
+    fromUser?: boolean;
+    media?: Medium[];
+    initial?: boolean;
+    timestamp?: string;
+    contextVars?: {
+        [key: string]: string;
+    };
+};
+export type ConsumptionLog = {
+    consumptionLogID: string;
+    from: string;
+    to: string;
+    type: 'Daily' | 'Monthly';
+    userID?: string;
+    memoriID?: string;
+    totalSessions: number;
+    validSessions: number;
+    completions: number;
+};
+export type Notification = {
+    notificationID: string;
+    timestamp: string;
+    severity: 'INFO' | 'WARN' | 'ALERT';
+    texts: {
+        'it-IT': string;
+        'en-US': string;
+        [lang: string]: string;
+    };
+};
+export type ChatMedium = {
+    url?: string;
+    content?: string;
+    mimeType: string;
+    title?: string;
+    properties?: {
+        [key: string]: any;
+    };
+};
+export type ChatLogLine = {
+    timestamp: string;
+    inbound: boolean;
+    text: string;
+    media?: ChatMedium[];
+    memoryID?: string;
+    contextVars?: {
+        [key: string]: string;
+    };
+    completion?: boolean;
+    acceptsFeedback?: boolean;
+};
+export type ChatLog = {
+    chatLogID: string;
+    timestamp: string;
+    memoriID: string;
+    sessionID: string;
+    receiverTag?: string;
+    lines: ChatLogLine[];
+};
+export type CorrelationPair = {
+    pairID?: string;
+    text1: string;
+    text2: string;
+    correlated: boolean;
+    occurrencies?: number;
+};
+export type Utterance = {
+    utteranceID?: string;
+    text: string;
+    creationTimestamp?: string;
+    creationSessionID?: string;
+    lastChangeTimestamp?: string;
+    lastChangeSessionID?: string;
+};
+export type Intent = {
+    intentID?: string;
+    intentType?: 'Internal' | 'WebHook';
+    name: string;
+    utterances: Utterance[];
+    timeoutIntent?: boolean;
+    webHook?: string;
+    validityMinutes?: number;
+    creationTimestamp?: string;
+    creationSessionID?: string;
+    lastChangeTimestamp?: string;
+    lastChangeSessionID?: string;
+};
+export type IntentSlot = {
+    intentSlotID?: string;
+    name: string;
+    values?: string[];
+    webHook?: string;
+    validityMinutes?: number;
+    creationTimestamp?: string;
+    creationSessionID?: string;
+    lastChangeTimestamp?: string;
+    lastChangeSessionID?: string;
+};
+export type CustomWord = {
+    customWordID: string;
+    word: string;
+    definition: string;
+    creationTimestamp: string;
+    creationSessionID: string;
+    lastChangeTimestamp: string;
+    lastChangeSessionID: string;
+};
+export interface ImportCSVParams {
+    hasHeaders?: boolean;
+    headerNames?: string[];
+    questionColumnName: string;
+    answerColumnName: string;
+    contextVarsToMatchColumnName?: string;
+    contextVarsToSetColumnName?: string;
+    csvSeparator?: string;
+    questionTitleVariantsSeparator?: string;
+}
+export interface ImportTxtParams {
+    newLinesPerParagraphs?: number;
+}
+export interface ImportParams {
+    includedRows?: number[];
+    forceImport?: boolean;
+    csvSpecs?: ImportCSVParams;
+    txtSpecs?: ImportTxtParams;
+    conclusive?: boolean;
+    notPickable?: boolean;
+    contextVarsToSet?: {
+        [key: string]: string;
+    };
+}
+export interface ExportCSVParams {
+    newLine: '\n' | '\r\n';
+    hasHeaders?: boolean;
+    questionColumnName: string;
+    answerColumnName: string;
+    contextVarsToMatchColumnName?: string;
+    contextVarsToSetColumnName?: string;
+    csvSeparator?: string;
+    questionTitleVariantsSeparator?: string;
+}
+export interface ImportWarning {
+    warningType: 'Existing Similar Memory' | 'Internal Error';
+    rowNumber?: number;
+    row: string;
+    text?: string;
+    similarTexts?: {
+        text: string;
+        similarityLevel: 'HIGH' | 'MEDIUM' | 'LOW';
+    }[];
+}
+export interface ImportResponse {
+    importID: string;
+    status: 'Starting' | 'Running' | 'Stopped' | 'Completed' | 'Failed';
+    error?: string;
+    progress: number;
+    begin?: string;
+    end?: string;
+    eta?: number;
+    importedMemories?: number;
+    importWarnings?: ImportWarning[];
+}

package/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}