@vizzly/services 0.7.1 → 0.7.2-dev-dba36cbd0af6b3bcb07804673072c6fb5fb27a1f

package/dist/shared-logic/src/Translations/translations.d.ts

@@ -0,0 +1,9 @@
+import { VizzlyTranslations } from './translation.types';
+import { TranslationOptions, TranslationInterpolation } from './types';
+export type VizzlyTranslationKey = keyof VizzlyTranslations;
+export declare function getTranslation(translations: Partial<VizzlyTranslations>, key: string): string | TranslationInterpolation | undefined;
+export declare const defaultText: (key: string, defaultValue: string, variables?: TranslationOptions, developerMode?: boolean) => string;
+export declare const generateTranslation: (key: string, defaultValue: string, variables?: TranslationOptions, translations?: Partial<VizzlyTranslations>, developerMode?: boolean) => string;
+export declare function buildTextOverrides(translations?: Partial<VizzlyTranslations>, developerMode?: boolean): {
+    textOverride: (key: string, value: string, options?: TranslationOptions) => string;
+};

package/dist/shared-logic/src/Translations/types.d.ts

@@ -0,0 +1,13 @@
+export type TextOverride = (key: string, defaultValue: string, options?: TranslationOptions) => string;
+export type TranslationOptions = {
+    [key: string]: string | number | Pluralised;
+};
+export type Pluralised = {
+    count: number;
+    singular: string;
+    plural: string;
+};
+export type TranslationInterpolation = {
+    sentence: string;
+    [key: string]: string;
+};

package/dist/shared-logic/src/Translations/validation.d.ts

@@ -0,0 +1 @@
+export declare const isValidFormattedText: (text: string) => boolean;

package/dist/shared-logic/src/api/index.d.ts

@@ -22,15 +22,9 @@ export declare const api: (config: ApiConfig) => {
         permissions: import("../DashboardPermission/types").RawDashboardPermission[];
     }>;
     updateDashboard: (params: import("./vizzly/updateDashboard").UpdateDashboardParams) => Promise<import("./vizzly/updateDashboard").EncryptedDashboardUpdateResponse | import("./vizzly/updateDashboard").UnEncryptedDashboardUpdateResponse>;
-    askAi: (conversationId: string | undefined, currentAttributes: Partial<import("../Component/types").Component.Attributes>, question: string, dashboardAccessToken: string, dataSets: import("../DataSet/types").DataSet[], queryEngineConfig: import("../QueryEngineConfig/types").QueryEngineConfig) => Promise<{
-        conversationId: string | undefined;
-        attributes: import("../Component/types").Component.Attributes;
-        messageHistory: {
-            content: string;
-            sender_type: "user" | "ai";
-            status: "active";
-        }[];
-    }>;
+    askAi: (conversationId: string | undefined, currentAttributes: import("../Component/types").Component.Attributes, question: string, dashboardAccessToken: string, dataSets: import("../DataSet/types").DataSet[], queryEngineConfig: import("../QueryEngineConfig/types").QueryEngineConfig, abortSignal: AbortSignal) => Promise<import("./vizzly/aiHelpers/types").AiConversation>;
+    aiActions: (conversationId: string, messageId: string, dashboardAccessToken: string, options: import("./vizzly/aiActions").AIOptions) => Promise<import("./vizzly/aiActions").AIActionReponse>;
+    askAiForQuestionSuggestions: (dashboardAccessToken: string, dataSets: import("../DataSet/types").DataSet[]) => Promise<import("./vizzly/aiHelpers/types").AskAiQuestionSuggestions>;
     createVizzlyConfigVersion: (projectId: string, encryptedVizzlyConfig: string) => Promise<boolean>;
     getVizzlyConfig: (projectId: string) => Promise<{
         encryptedConfig: string | null;

package/dist/shared-logic/src/api/vizzly/aiActions.d.ts

@@ -0,0 +1,18 @@
+import { Message } from '../../AI/types';
+import { HttpClient } from '../types';
+export type AIActionReponse = {
+    success: boolean;
+};
+export type AIOptions = {
+    reaction: Message['reaction'];
+};
+type APIResponse = {
+    status: number;
+    body: any;
+    headers: any;
+};
+export declare const aiActions: (httpClient: HttpClient) => (conversationId: string, messageId: string, dashboardAccessToken: string, options: AIOptions) => Promise<AIActionReponse>;
+export declare const buildAIActionResponse: (response: APIResponse) => {
+    success: boolean;
+};
+export {};

package/dist/shared-logic/src/api/vizzly/aiHelpers/buildAIResponse.d.ts

@@ -0,0 +1,5 @@
+import { DataSet } from '../../../DataSet/types';
+import { QueryEngineConfig } from '../../../QueryEngineConfig/types';
+import { AiConversation, AskAIResponse } from './types';
+import { Component } from '../../../Component/types';
+export declare const buildAIResponse: (askAiResponse: AskAIResponse, currentAttributes: Component.Attributes, queryEngineConfig: QueryEngineConfig, dataSets: DataSet[]) => AiConversation;

package/dist/shared-logic/src/api/vizzly/aiHelpers/buildDataSets.d.ts

@@ -0,0 +1,4 @@
+import { DataSet } from '../../../DataSet/types';
+import { DataSet as AiDataSet } from '@vizzly/ai-types';
+declare const _default: (dataSets: DataSet[]) => AiDataSet[];
+export default _default;

package/dist/shared-logic/src/api/vizzly/aiHelpers/checkAiResponseStatus.d.ts

@@ -0,0 +1,3 @@
+import { AskAIResponse } from './types';
+declare function checkAiResponseStatus(statusCode: number, body: any): asserts body is AskAIResponse;
+export default checkAiResponseStatus;

package/dist/shared-logic/src/api/vizzly/aiHelpers/types.d.ts

@@ -0,0 +1,23 @@
+import { ConversationState } from '../../../AI/types';
+import { Component } from '../../../Component/types';
+import { View } from '@vizzly/ai-types';
+export type AskAIResponse = {
+    message_id: string;
+    conversation_id: string;
+    ai_view: View;
+    conversation_content: {
+        messages: ConversationState['messageHistory'];
+    };
+};
+export type AskAIUsageResponse = {
+    quota: number;
+    used: number;
+};
+export type AiConversation = {
+    conversationId: ConversationState['conversationId'];
+    attributes: Component.Attributes;
+    messageHistory: ConversationState['messageHistory'];
+};
+export type AskAiQuestionSuggestions = {
+    suggestions: string[];
+};

package/dist/shared-logic/src/api/vizzly/aiHelpers/validateAndUpcastAIAttributes.d.ts

@@ -0,0 +1,4 @@
+import { QueryEngineConfig } from '../../../QueryEngineConfig/types';
+import { Component } from '../../../Component/types';
+declare const validateAndUpcast: (aiAttributes: Partial<Component.Attributes>, queryEngineConfig: QueryEngineConfig) => Component.Attributes;
+export default validateAndUpcast;

package/dist/shared-logic/src/api/vizzly/aiHelpers/view.d.ts

@@ -0,0 +1,10 @@
+import { Component } from '../../../Component/types';
+import { View } from '@vizzly/ai-types';
+import { DataSet } from '../../../DataSet/types';
+import { QueryEngineConfig } from '../../../QueryEngineConfig/types';
+/**
+ * Convert the complex view used on the frontend, to the simplified
+ * version that the AI is used too...
+ */
+export declare const attributesToAiView: (dataSet: DataSet, originalAttributes: Component.Attributes) => View;
+export declare const mergeAiViewIntoCurrentAttributes: (dataSets: DataSet[], currentAttributes: Component.Attributes, aiView: View, queryEngineConfig: QueryEngineConfig) => Component.Attributes;

package/dist/shared-logic/src/api/vizzly/askAi.d.ts

@@ -1,12 +1,6 @@
 import { HttpClient } from '../types';
 import { DataSet } from '../../DataSet/types';
 import { QueryEngineConfig } from '../../QueryEngineConfig/types';
+import { AiConversation } from './aiHelpers/types';
 import { Component } from '../../Component/types';
-import { ConversationState } from '../../AI/types';
-type AskAiReponse = {
-    conversationId: ConversationState['conversationId'];
-    attributes: Component.Attributes;
-    messageHistory: ConversationState['messageHistory'];
-};
-export declare const askAi: (httpClient: HttpClient) => (conversationId: string | undefined, currentAttributes: Partial<Component.Attributes>, question: string, dashboardAccessToken: string, dataSets: DataSet[], queryEngineConfig: QueryEngineConfig) => Promise<AskAiReponse>;
-export {};
+export declare const askAi: (httpClient: HttpClient) => (conversationId: string | undefined, currentAttributes: Component.Attributes, question: string, dashboardAccessToken: string, dataSets: DataSet[], queryEngineConfig: QueryEngineConfig, abortSignal: AbortSignal) => Promise<AiConversation>;

package/dist/shared-logic/src/api/vizzly/askAiForQuestionSuggestions.d.ts

@@ -0,0 +1,4 @@
+import { HttpClient } from '../types';
+import { DataSet } from '../../DataSet/types';
+import { AskAiQuestionSuggestions } from './aiHelpers/types';
+export declare const askAiForQuestionSuggestions: (httpClient: HttpClient) => (dashboardAccessToken: string, dataSets: DataSet[]) => Promise<AskAiQuestionSuggestions>;

package/dist/shared-logic/src/errors/AIAborted.d.ts

@@ -0,0 +1,4 @@
+declare class AIAborted extends Error {
+    constructor();
+}
+export default AIAborted;

package/dist/shared-logic/src/errors/AIContainsErrors.d.ts

@@ -0,0 +1,4 @@
+declare class AIContainsErrors extends Error {
+    constructor();
+}
+export default AIContainsErrors;

package/dist/shared-logic/src/errors/AIFailedToFetch.d.ts

@@ -0,0 +1,4 @@
+declare class AIFailedToFetch extends Error {
+    constructor();
+}
+export default AIFailedToFetch;

package/dist/shared-logic/src/errors/AIUsageLimitReached.d.ts

@@ -1,4 +1,4 @@
 declare class AIUsageLimitReached extends Error {
-    constructor();
+    constructor(message?: string);
 }
 export default AIUsageLimitReached;

package/dist/shared-logic/src/errors/index.d.ts

@@ -0,0 +1,5 @@
+import AIUsageLimitReached from './AIUsageLimitReached';
+import AIFailedToFetch from '../errors/AIFailedToFetch';
+import AIContainsErrors from '../errors/AIContainsErrors';
+import AIAborted from '../errors/AIAborted';
+export { AIUsageLimitReached, AIFailedToFetch, AIContainsErrors, AIAborted };

package/dist/shared-logic/src/utils/stringHelper.d.ts

@@ -1,7 +1,8 @@
+import { TextOverride } from '../Translations/types';
 export declare function pluralEnding(num: number, single: string, multiple: string): string;
 export declare function maxLengthString(str: string, length: number): string;
 export declare function plural(num: number, single: string, multiple: string): string;
-export declare function humanReadableList(values: (number | string)[], withQuotes?: boolean): string;
+export declare function humanReadableList(values: (number | string)[], withQuotes?: boolean, textOverride?: TextOverride): string;
 export declare const hashString: (str: string) => number;
 export declare const capitalise: (word: string) => string;
 export declare const replaceAll: (str: string, lookFor: string, replaceWith: string) => string;

package/package.json

@@ -22,5 +22,5 @@
     "test": "jest",
     "prepare": "yarn build"
   },
-  "version": "0.7.1"
+  "version": "0.7.2-dev-dba36cbd0af6b3bcb07804673072c6fb5fb27a1f"
 }

package/dist/shared-logic/src/Documentation/index.d.ts

@@ -1,2 +0,0 @@
-export * from './joiToDocumentation';
-export * from './joiToSchemaDefinition';

package/dist/shared-logic/src/Documentation/joiToDocumentation.d.ts

@@ -1,4 +0,0 @@
-import Joi from '@vizzly/joi';
-import joiToJson from 'joi-to-json';
-export type SchemaDocumentation = ReturnType<typeof joiToJson>;
-export declare const joiToDocumentation: (obj: Joi.Schema) => SchemaDocumentation;

package/dist/shared-logic/src/Documentation/joiToSchemaDefinition.d.ts

@@ -1,2 +0,0 @@
-import Joi from '@vizzly/joi';
-export declare const joiToSchemaDefinition: (obj: Joi.Schema) => any;

package/dist/shared-logic/src/api/vizzly/askAi/types.d.ts

@@ -1,2 +0,0 @@
-import { Component } from '../../../Component/types';
-export type AIAttributes = Partial<Component.Attributes>;

package/dist/shared-logic/src/api/vizzly/askAi/validateAndUpcast.d.ts

@@ -1,5 +0,0 @@
-import { AIAttributes } from './types';
-import { QueryEngineConfig } from '../../../QueryEngineConfig/types';
-import { Component } from '../../../Component/types';
-declare const validateAndUpcast: (aiAttributes: Partial<AIAttributes>, queryEngineConfig: QueryEngineConfig) => Component.Attributes;
-export default validateAndUpcast;