@vizzly/services 0.8.1 → 0.8.2-dev-4ac76b0195bc8bd9f3866e4cdcdac08e26caeff3

package/dist/shared-logic/src/TimeDimension/TimeDimension.d.ts

@@ -3,7 +3,7 @@ import { QueryAttributes } from '../QueryAttributes/types';
 export declare const id: (metric: QueryAttributes.TimeDimension) => string;
 export declare const decodeId: (metric: string, supportedTimeTruncFunctions: SupportedTimeTruncFunctions) => QueryAttributes.TimeDimension | null;
 export declare const vizzlyManagedTimeDimensions: SupportedTimeTruncFunctions;
-type SupportedTimeFunctions = 'minute' | 'hour' | 'second' | 'week' | 'quarter' | 'year' | 'month' | 'day';
+declare type SupportedTimeFunctions = 'minute' | 'hour' | 'second' | 'week' | 'quarter' | 'year' | 'month' | 'day';
 export declare const supportedTimeTruncFunctions: (keys?: Array<SupportedTimeFunctions>) => SupportedTimeTruncFunctions;
 export declare const isSupportedTimeTruncFunction: (supportedTimeFunctions: SupportedTimeTruncFunctions, proposedFunction: string) => boolean;
 export declare const getPublicName: (id: keyof typeof vizzlyManagedTimeDimensions) => string;

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

@@ -1,5 +1,5 @@
 import { DateTimeFormat } from '../Field/types';
-export type SupportedTimeTruncFunction = {
+export declare type SupportedTimeTruncFunction = {
     publicName: string;
     /**
      * Once from the query engine, what is
@@ -8,6 +8,6 @@ export type SupportedTimeTruncFunction = {
      * */
     dateFormat: DateTimeFormat | (string & {});
 };
-export type SupportedTimeTruncFunctions = {
+export declare type SupportedTimeTruncFunctions = {
     [key: string]: SupportedTimeTruncFunction;
 };

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

@@ -1,8 +1,8 @@
 export declare const SECTION_KEYS: readonly ["title", "description", "data_panel", "format_panel"];
-export type SectionKeys = typeof SECTION_KEYS[number];
+export declare type SectionKeys = typeof SECTION_KEYS[number];
 export declare const PROPERTIES: string[];
 export declare const CALL_TO_ACTION = "call_to_action";
-export type ExtractedKeys = {
+export declare type ExtractedKeys = {
     key: string;
     defaultValue: string;
     fixedVariables?: string[] | undefined;

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

@@ -2,7 +2,7 @@ import { ComponentInterface } from '../ComponentInterface/types';
 import { DataPanelSection } from '../DataPanelConfig/types';
 import { TextOverride } from './types';
 export declare const textOverrideComponent: (component: ComponentInterface<any>, textOverride?: TextOverride) => ComponentInterface<any>;
-type Panel = {
+declare type Panel = {
     namespace?: string;
     type?: string;
     title?: string;
@@ -12,14 +12,14 @@ type Panel = {
     x?: Panel & FormatPanel;
     y?: Panel & FormatPanel;
 };
-type FormatPanel = {
+declare type FormatPanel = {
     axisTitle?: Panel;
     count?: Panel;
     format?: Panel;
     postfix?: Panel;
     prefix?: Panel;
 };
-type Result = {
+declare type Result = {
     key: string;
     defaultValue: string;
     property: keyof DataPanelSection;

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

@@ -1,5 +1,5 @@
 import { TranslationInterpolation } from './types';
-export type VizzlyTranslations = {
+export declare type VizzlyTranslations = {
     /**
      * @default 'Start Date'
      *
@@ -1675,6 +1675,13 @@ export type VizzlyTranslations = {
      * String containing the translation.
      */
     add_prefix: string;
+    /**
+     * @default 'Goals need to be set'
+     *
+     * @returns
+     * String containing the translation.
+     */
+    'progress.goals_need to be set': string;
     /**
      * @default 'Linear'
      *

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

@@ -1,6 +1,6 @@
 import { VizzlyTranslations } from './translation.types';
 import { TranslationOptions, TranslationInterpolation } from './types';
-export type VizzlyTranslationKey = keyof VizzlyTranslations;
+export declare 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;

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

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

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

@@ -18,7 +18,7 @@ export declare const api: (config: ApiConfig) => {
     multiGetDashboards: (dashboardAccessTokens: string[], abortSignal: AbortSignal) => Promise<import("./vizzly/multiGetDashboards").Response>;
     multiGetEncryptedDashboards: (dashboardAccessTokens: string[]) => Promise<import("./vizzly/multiGetEncryptedDashboards").Response>;
     createDashboard: (params: import("./vizzly/createDashboard").CreateDashboardParams) => Promise<{
-        dashboard: import("../Dashboard").RawDashboard;
+        dashboard: import("../Dashboard").RawDashboard<import("../Dashboard").RawDefinition>;
         permissions: import("../DashboardPermission/types").RawDashboardPermission[];
     }>;
     updateDashboard: (params: import("./vizzly/updateDashboard").UpdateDashboardParams) => Promise<import("./vizzly/updateDashboard").EncryptedDashboardUpdateResponse | import("./vizzly/updateDashboard").UnEncryptedDashboardUpdateResponse>;

package/dist/shared-logic/src/api/queryEngine/createDashboard.d.ts

@@ -1,14 +1,16 @@
 import { RawDashboard, SaveableDashboardDefinition } from '../../Dashboard';
 import { RawDashboardPermission } from '../../DashboardPermission/types';
 import { QueryEngineEndpoint } from '../../QueryEngineConfig/types';
-export type Response = {
+export declare type Response = {
     dashboard: RawDashboard;
     permissions: Array<RawDashboardPermission>;
 };
-export type CreateDashboardParams = {
+export declare type CreateDashboardParams = {
     dashboardAccessToken: string;
     definition: SaveableDashboardDefinition;
-    meta: any;
+    /** @deprecated - use `metadata` instead */
+    meta?: any;
+    metadata?: any;
     parentDashboardId: string | null;
     permissions: Array<any>;
 };

package/dist/shared-logic/src/api/queryEngine/multiGetDashboards.d.ts

@@ -1,6 +1,6 @@
 import { QueryEngineEndpoint } from '../../QueryEngineConfig/types';
 import { RawDashboard } from '../../Dashboard';
-export type Response = {
+export declare type Response = {
     found: RawDashboard[];
     not_found: string[];
 };

package/dist/shared-logic/src/api/queryEngine/updateDashboard.d.ts

@@ -1,10 +1,10 @@
 import * as Dashboard from '../../Dashboard/Dashboard';
 import { RawDashboard, SaveableDashboardDefinition } from '../../Dashboard';
 import { QueryEngineEndpoint } from '../../QueryEngineConfig/types';
-export type Response = {
+export declare type Response = {
     dashboard: RawDashboard<Dashboard.RawDefinition>;
 };
-export type UpdateDashboardParams = {
+export declare type UpdateDashboardParams = {
     dashboardSessionToken: string;
     definition?: SaveableDashboardDefinition;
     meta?: any;

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

@@ -1,8 +1,8 @@
-export type Response<T> = {
+export declare type Response<T> = {
     statusCode: number;
     response: T;
 };
-export type Request<T> = {
+export declare type Request<T> = {
     path: string;
     abortSignal?: AbortSignal;
     method: 'get' | 'post' | 'delete' | 'put';
@@ -17,8 +17,8 @@ export type Request<T> = {
         resourceFilters: string[];
     };
 };
-export type NoBody = undefined;
-export type HttpClient = <ResponseBody>(request: Request<any>) => Promise<{
+export declare type NoBody = undefined;
+export declare type HttpClient = <ResponseBody>(request: Request<any>) => Promise<{
     status: number;
     body: ResponseBody;
     headers: Headers | null;

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

@@ -1,12 +1,12 @@
 import { Message } from '../../AI/types';
 import { HttpClient } from '../types';
-export type AIActionReponse = {
+export declare type AIActionReponse = {
     success: boolean;
 };
-export type AIOptions = {
+export declare type AIOptions = {
     reaction: Message['reaction'];
 };
-type APIResponse = {
+declare type APIResponse = {
     status: number;
     body: any;
     headers: any;

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

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

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

@@ -1,14 +1,16 @@
 import { RawDashboard, SaveableDashboardDefinition } from '../../Dashboard';
 import { RawDashboardPermission } from '../../DashboardPermission/types';
 import { HttpClient } from '../types';
-export type Response = {
+export declare type Response = {
     dashboard: RawDashboard;
     permissions: Array<RawDashboardPermission>;
 };
-export type CreateDashboardParams = {
+export declare type CreateDashboardParams = {
     dashboardAccessToken: string;
     definition: SaveableDashboardDefinition;
-    meta: any;
+    /** @deprecated - use `metadata` instead */
+    meta?: any;
+    metadata?: any;
     parentDashboardId: string | null;
     permissions: Array<any>;
 };

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

@@ -1,6 +1,6 @@
 import { HttpClient } from '../types';
 import { DashboardPermission, RawDashboardPermission } from '../../DashboardPermission/types';
-export type Response = {
+export declare type Response = {
     permissions: Array<RawDashboardPermission>;
 };
 export declare const createDashboardAccess: (httpClient: HttpClient) => (dashboardAccessToken: string, dashboardAdminOverrideToken: string | undefined, abortSignal: AbortSignal) => Promise<{

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

@@ -1,5 +1,5 @@
 import { HttpClient } from '../types';
-type MinimalDashboard = {
+declare type MinimalDashboard = {
     id: string;
     created_at: string;
     updated_at: string;

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

@@ -1,5 +1,5 @@
 import { HttpClient } from '../types';
-export type TeamMember = {
+export declare type TeamMember = {
     id: string;
     organisation_name: string;
     user_id: string;

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

@@ -1,6 +1,6 @@
 import { RawDashboard } from '../../Dashboard';
 import { HttpClient } from '../types';
-export type Response = {
+export declare type Response = {
     found: RawDashboard[];
     not_found: string[];
 };

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

@@ -1,6 +1,6 @@
 import { RawDashboard, RawDefinition } from '../../Dashboard';
 import { HttpClient } from '../types';
-export type Response = {
+export declare type Response = {
     found: RawDashboard<string | RawDefinition>[];
     not_found: string[];
 };

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

@@ -1,17 +1,19 @@
 import * as Dashboard from '../../Dashboard/Dashboard';
 import { RawDashboard, SaveableDashboardDefinition } from '../../Dashboard';
 import { HttpClient } from '../types';
-export type EncryptedDashboardUpdateResponse = {
+export declare type EncryptedDashboardUpdateResponse = {
     dashboard: RawDashboard<string>;
 };
-export type UnEncryptedDashboardUpdateResponse = {
+export declare type UnEncryptedDashboardUpdateResponse = {
     dashboard: RawDashboard<Dashboard.RawDefinition>;
 };
-type UpdateDashboardResponse = EncryptedDashboardUpdateResponse | UnEncryptedDashboardUpdateResponse;
-export type UpdateDashboardParams = {
+declare type UpdateDashboardResponse = EncryptedDashboardUpdateResponse | UnEncryptedDashboardUpdateResponse;
+export declare type UpdateDashboardParams = {
     dashboardSessionToken: string;
     definition?: SaveableDashboardDefinition;
+    /** @deprecated - use `metadata` instead */
     meta?: any;
+    metadata?: any;
     deleted?: boolean;
 };
 export declare const updateDashboard: (httpClient: HttpClient) => (params: UpdateDashboardParams) => Promise<UpdateDashboardResponse>;

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

@@ -1,5 +1,5 @@
 import { HttpClient } from '../types';
-type UpdateParams = {
+declare type UpdateParams = {
     disabled: boolean;
 };
 export declare const updateProjectApiKey: (httpClient: HttpClient) => (projectId: string, projectApiKeyId: string, updateParams: UpdateParams) => Promise<string>;

package/dist/shared-logic/src/typeHelpers.d.ts

@@ -1 +1 @@
-export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export declare type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/package.json

@@ -22,5 +22,5 @@
     "test": "jest",
     "prepare": "yarn build"
   },
-  "version": "0.8.1"
+  "version": "0.8.2-dev-4ac76b0195bc8bd9f3866e4cdcdac08e26caeff3"
 }