@xpert-ai/contracts 3.9.0-beta.1

package/src/analytics/business-area-user.model.d.ts

@@ -0,0 +1,35 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { LanguagesEnum, IUser } from '../user.model';
+import { IBusinessArea } from './business-area';
+export declare enum BusinessAreaRole {
+    Adminer = 0,
+    Modeler = 1,
+    Viewer = 2
+}
+export interface IBusinessAreaUser extends IBasePerTenantAndOrganizationEntityModel {
+    businessAreaId: string;
+    businessArea?: IBusinessArea;
+    userId: string;
+    isDefault: boolean;
+    isActive: boolean;
+    user?: IUser;
+    role: BusinessAreaRole;
+}
+export interface IBusinessAreaUserFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    businessAreaId?: string;
+    id?: string;
+    userId?: string;
+    isDefault?: boolean;
+    isActive?: boolean;
+}
+export interface IBusinessAreaUserCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+    businessAreaId: string;
+    userId: string;
+    isDefault?: boolean;
+    isActive?: boolean;
+}
+export interface IBusinessAreaUserDeleteInput {
+    userbusinessAreaId: string;
+    requestingUser: IUser;
+    language?: LanguagesEnum;
+}

package/src/analytics/business-area.d.ts

@@ -0,0 +1,17 @@
+import { IBasePerTenantEntityModel } from "../base-entity.model";
+import { ITag } from "../tag-entity.model";
+import { IStory } from "./story";
+export interface IBusinessArea extends IBasePerTenantEntityModel {
+    type?: BusinessType;
+    name?: string;
+    parentId?: string;
+    level?: number;
+    tags?: ITag[];
+    stories?: Array<IStory>;
+    children?: Array<IBusinessArea>;
+}
+export declare enum BusinessType {
+    SEMANTIC_MODEL = "SEMANTIC_MODEL",
+    STORY = "STORY",
+    INDICATOR = "INDICATOR"
+}

package/src/analytics/certification.model.d.ts

@@ -0,0 +1,11 @@
+import { IBasePerTenantEntityModel } from '../base-entity.model';
+import { IUser } from '../user.model';
+export interface ICertification extends IBasePerTenantEntityModel {
+    name?: string;
+    description?: string;
+    /**
+     * Certification owner
+     */
+    owner?: IUser;
+    ownerId?: string;
+}

package/src/analytics/chatbi-conversation.model.d.ts

@@ -0,0 +1,15 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IIndicator } from './indicator';
+export interface IChatBIConversation extends IBasePerTenantAndOrganizationEntityModel {
+    key: string;
+    name?: string;
+    modelId?: string;
+    entity?: string;
+    command?: string;
+    options?: {
+        messages: any[];
+        indicators?: IIndicator;
+        answer?: any;
+        examples: string[];
+    };
+}

package/src/analytics/chatbi-model.model.d.ts

@@ -0,0 +1,18 @@
+import { IXpert } from '../ai';
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IIntegration } from '../integration.model';
+import { ISemanticModel } from './semantic-model';
+export interface IChatBIModel extends IBasePerTenantAndOrganizationEntityModel {
+    modelId: string;
+    model?: ISemanticModel;
+    entity: string;
+    entityCaption?: string;
+    entityDescription?: string;
+    visits?: number;
+    options?: ChatBIModelOptions;
+    xperts?: IXpert[];
+    integrations?: IIntegration[];
+}
+export type ChatBIModelOptions = {
+    suggestions: string[];
+};

package/src/analytics/collection.model.d.ts

@@ -0,0 +1,6 @@
+import { IBasePerProjectEntityModel } from './project.model';
+export interface ICollection extends IBasePerProjectEntityModel {
+    name?: string;
+    parentId?: string;
+    level?: number;
+}

package/src/analytics/comment.model.d.ts

@@ -0,0 +1,10 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IIndicator } from './indicator';
+export interface IComment extends IBasePerTenantAndOrganizationEntityModel {
+    content?: string;
+    parentId?: string;
+    level?: number;
+    options?: any;
+    indicatorId?: string;
+    indicator?: IIndicator;
+}

package/src/analytics/data-source-type.d.ts

@@ -0,0 +1,16 @@
+import { IBasePerTenantEntityModel } from '../base-entity.model';
+export interface IDataSourceType extends IBasePerTenantEntityModel {
+    name?: string;
+    type?: string;
+    syntax?: DataSourceSyntaxEnum;
+    protocol?: DataSourceProtocolEnum;
+    configuration?: Record<string, unknown>;
+}
+export declare enum DataSourceSyntaxEnum {
+    SQL = "sql",
+    MDX = "mdx"
+}
+export declare enum DataSourceProtocolEnum {
+    SQL = "sql",
+    XMLA = "xmla"
+}

package/src/analytics/data-source.d.ts

@@ -0,0 +1,62 @@
+import { IBasePerTenantAndOrganizationEntityModel, IBasePerTenantEntityModel } from '../base-entity.model';
+import { IUser } from '../user.model';
+import { IDataSourceType } from './data-source-type';
+import { ISemanticModel } from './semantic-model';
+export interface IDataSource extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
+    typeId?: string;
+    type?: IDataSourceType;
+    useLocalAgent?: boolean;
+    authType?: AuthenticationEnum;
+    options?: Record<string, unknown>;
+    models?: ISemanticModel[];
+    authentications?: IDataSourceAuthentication[];
+}
+export interface IDataSourceAuthentication extends IBasePerTenantEntityModel {
+    dataSourceId: string;
+    userId: string;
+    username: string;
+    password: string;
+    validUntil?: Date;
+    dataSource?: IDataSource;
+    user?: IUser;
+}
+export declare enum AuthenticationEnum {
+    NONE = "NONE",
+    BASIC = "BASIC"
+}
+export declare enum DataSourceTypeEnum {
+    NONE = "NONE"
+}
+export interface IDSSchema {
+    catalog?: string;
+    schema?: string;
+    name: string;
+    label?: string;
+    type?: string;
+    tables?: Array<IDSTable>;
+}
+export interface IDSTable {
+    schema?: string;
+    name?: string;
+    label?: string;
+    columns?: Array<IColumnDef>;
+}
+export interface IColumnDef {
+    name: string;
+    label?: string;
+    /**
+     * Types in javascript
+     */
+    type: 'number' | 'string' | 'boolean' | 'object' | 'timestamp';
+    /**
+     * Original data type in database
+     */
+    dataType: string;
+    nullable?: boolean;
+    position?: number;
+    /**
+     * 应该等同于 label
+     */
+    comment?: string;
+}

package/src/analytics/favorite.d.ts

@@ -0,0 +1,14 @@
+import { BusinessType } from './business-area';
+import { IIndicator } from './indicator';
+import { IBasePerProjectEntityModel } from './project.model';
+import { ISemanticModel } from './semantic-model';
+import { IStory } from './story';
+export interface IFavorite extends IBasePerProjectEntityModel {
+    type?: BusinessType;
+    modelId?: string;
+    model?: ISemanticModel;
+    storyId?: string;
+    story?: IStory;
+    indicatorId?: string;
+    indicator?: IIndicator;
+}

package/src/analytics/features.d.ts

@@ -0,0 +1,19 @@
+export declare enum AnalyticsFeatures {
+    FEATURE_BUSINESS_AREA = "FEATURE_BUSINESS_AREA",
+    FEATURE_INDICATOR = "FEATURE_INDICATOR",
+    FEATURE_INDICATOR_MARKET = "FEATURE_INDICATOR_MARKET",
+    FEATURE_INDICATOR_REGISTER = "FEATURE_INDICATOR_REGISTER",
+    FEATURE_INDICATOR_APP = "FEATURE_INDICATOR_APP",
+    FEATURE_STORY = "FEATURE_STORY",
+    FEATURE_STORY_CREATION = "FEATURE_STORY_CREATION",
+    FEATURE_STORY_VIEWER = "FEATURE_STORY_VIEWER",
+    FEATURE_STORY_MARKET = "FEATURE_STORY_MARKET",
+    FEATURE_MODEL = "FEATURE_MODEL",
+    FEATURE_MODEL_CREATION = "FEATURE_MODEL_CREATION",
+    FEATURE_MODEL_VIEWER = "FEATURE_MODEL_VIEWER",
+    FEATURE_SUBSCRIPTION = "FEATURE_SUBSCRIPTION",
+    FEATURE_HOME_TREND = "FEATURE_HOME_TREND",
+    FEATURE_HOME_CATALOG = "FEATURE_HOME_CATALOG",
+    FEATURE_PROJECT = "FEATURE_PROJECT",
+    FEATURE_DATA_FACTORY = "FEATURE_DATA_FACTORY"
+}

package/src/analytics/feed-model.d.ts

@@ -0,0 +1,13 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+export interface IFeed extends IBasePerTenantAndOrganizationEntityModel {
+    type: FeedTypeEnum;
+    entityId?: string;
+    hidden?: boolean;
+    options?: any;
+}
+export declare enum FeedTypeEnum {
+    StoryWidget = "StoryWidget",
+    IndicatorWidget = "IndicatorWidget",
+    Recents = "Recents",
+    Ranking = "Ranking"
+}

package/src/analytics/gateway.d.ts

@@ -0,0 +1,28 @@
+import { TQueryOptions } from './model-query-log.model';
+export type TGatewayQueryEvent = {
+    id: string;
+    organizationId: string;
+    dataSourceId: string;
+    tenantId?: string;
+    modelId?: string;
+    isDraft: boolean;
+    body: {
+        /**
+         * @deprecated use statement
+         */
+        mdx?: string;
+        statement?: string;
+        query?: TQueryOptions;
+        /**
+         * Is use indicators draft, corresponding to `DataSourceOptions['isIndicatorsDraft']` in the ocap framework.
+         */
+        isIndicatorsDraft?: boolean;
+    };
+    acceptLanguage?: string;
+    forceRefresh: boolean;
+};
+export type TGatewayRespEvent = any;
+export type TGatewayRespError = {
+    message: string;
+    status: number;
+};

package/src/analytics/index.d.ts

@@ -0,0 +1,38 @@
+import * as MDX from './schema';
+export * from './ai';
+export * from './business-area';
+export * from './business-area-user.model';
+export * from './collection.model';
+export * from './data-source';
+export * from './data-source-type';
+export * from './favorite';
+export * from './features';
+export * from './feed-model';
+export * from './indicator';
+export * from './indicator-app';
+export * from './indicator-market';
+export * from './model-query';
+export * from './notification-destination';
+export * from './role-permissions';
+export * from './semantic-model';
+export * from './semantic-model-entity';
+export * from './semantic-model-member';
+export * from './story';
+export * from './story-point';
+export * from './story-widget';
+export * from './subscription';
+export * from './visit.model';
+export * from './webSocket';
+export * from './approval-policy.model';
+export * from './permission-approval.model';
+export * from './permission-approval-user.model';
+export * from './project.model';
+export * from './comment.model';
+export * from './story-template.model';
+export * from './screenshot.model';
+export * from './certification.model';
+export * from './chatbi-conversation.model';
+export * from './chatbi-model.model';
+export * from './model-query-log.model';
+export * from './gateway';
+export { MDX };

package/src/analytics/indicator-app.d.ts

@@ -0,0 +1,44 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+/**
+ * Store user states for the indicator app
+ */
+export interface IIndicatorApp extends IBasePerTenantAndOrganizationEntityModel {
+    options?: {
+        /**
+         * The indicators user favorited
+         */
+        favorites?: string[];
+        /**
+         * The order of the indicators user sorted
+         */
+        order?: string[];
+        /**
+         * Time granularity
+         */
+        timeGranularity?: TimeGranularity;
+        /**
+         * Limit the lookback period in trend analysis for every time granularity
+         */
+        lookback?: Record<TimeGranularity, number>;
+        /**
+         * Tag type show in indicator list
+         */
+        tagType?: IndicatorTagEnum;
+        /**
+         * Periods for detail view
+         */
+        detailPeriods?: string;
+    };
+}
+export declare enum TimeGranularity {
+    Year = "Year",
+    Quarter = "Quarter",
+    Month = "Month",
+    Week = "Week",
+    Day = "Day"
+}
+export declare enum IndicatorTagEnum {
+    UNIT = 0,
+    MOM = 1,
+    YOY = 2
+}

package/src/analytics/indicator-market.d.ts

@@ -0,0 +1,4 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+export interface IIndicatorMarket extends IBasePerTenantAndOrganizationEntityModel {
+    options?: Record<string, unknown>;
+}

package/src/analytics/indicator.d.ts

@@ -0,0 +1,105 @@
+import { EmbeddingStatusEnum } from '../ai';
+import { ITag } from '../tag-entity.model';
+import { ChecklistItem } from '../types';
+import { Visibility } from '../visibility.model';
+import { IBusinessArea } from './business-area';
+import { ICertification } from './certification.model';
+import { IComment } from './comment.model';
+import { IPermissionApproval } from './permission-approval.model';
+import { IBasePerProjectEntityModel } from './project.model';
+import { ISemanticModel } from './semantic-model';
+/**
+ * Common fields of Indicator (draft and entity)
+ */
+export type TIndicator = {
+    code?: string;
+    name?: string;
+    /**
+     * Indicator Type
+     */
+    type?: IndicatorType;
+    /**
+     * Visible in model
+     */
+    visible?: boolean;
+    /**
+     * Available in indicator market app
+     */
+    isApplication?: boolean;
+    modelId?: string;
+    entity?: string;
+    unit?: string;
+    principal?: string;
+    /**
+     * @deprecated use certificationId
+     */
+    authentication?: string;
+    certificationId?: string;
+    validity?: string;
+    business?: string;
+    options?: {
+        dimensions?: Array<string>;
+        filters?: Array<any>;
+        formula?: string;
+        measure?: string;
+        aggregator?: string;
+        calendar?: string;
+    };
+    businessAreaId?: string;
+};
+/**
+ * Fields included in the draft of Indicator, please keep it in sync with TIndicator type
+ */
+export declare const IndicatorDraftFields: Array<keyof IIndicator>;
+export type TIndicatorDraft = TIndicator & {
+    checklist?: ChecklistItem[];
+    version?: number;
+    savedAt?: Date;
+};
+export interface IIndicator extends IBasePerProjectEntityModel, TIndicator {
+    draft?: TIndicatorDraft;
+    /**
+     * Visibilty in public or secret or private
+     */
+    visibility?: Visibility;
+    model?: ISemanticModel;
+    /**
+     * Quality Certification
+     */
+    certification?: ICertification;
+    status?: IndicatorStatusEnum;
+    embeddingStatus?: EmbeddingStatusEnum;
+    error?: string;
+    publishedAt?: Date;
+    businessArea?: IBusinessArea;
+    permissionApprovals?: IPermissionApproval[];
+    tags?: ITag[];
+    comments?: IComment[];
+}
+export declare const IndicatorOptionFields: string[];
+/**
+ * Indicator Type:
+ * * Basic indicators
+ * * Derivative Indicators
+ */
+export declare enum IndicatorType {
+    BASIC = "BASIC",
+    DERIVE = "DERIVE"
+}
+/**
+ * Status of the indicator
+ */
+export declare enum IndicatorStatusEnum {
+    /**
+     * draft
+     */
+    DRAFT = "DRAFT",
+    /**
+     * Published
+     */
+    RELEASED = "RELEASED",
+    /**
+     * Offline Archive
+     */
+    ARCHIVED = "ARCHIVED"
+}

package/src/analytics/model-query-log.model.d.ts

@@ -0,0 +1,41 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IIndicator } from './indicator';
+import { ISemanticModel } from './semantic-model';
+export type TQueryOptions = {
+    rows?: any;
+    columns?: any;
+    cube?: string;
+    /**
+     * Indicators modified by the client
+     */
+    indicators?: IIndicator[];
+    calculatedMeasures?: any[];
+} & Record<string, any>;
+export declare enum QueryStatusEnum {
+    PENDING = "pending",// Query submitted, waiting for execution
+    RUNNING = "running",// Query is executing
+    SUCCESS = "success",// Query succeeded
+    FAILED = "failed"
+}
+export interface ISemanticModelQueryLog extends IBasePerTenantAndOrganizationEntityModel {
+    /**
+     * Unique ID of the client query
+     */
+    key?: string;
+    modelId: string;
+    model?: ISemanticModel;
+    cube?: string;
+    status: QueryStatusEnum;
+    /**
+     * Structural parameters for query
+     */
+    params: TQueryOptions;
+    /**
+     * Statement of query
+     */
+    query?: string;
+    result: any;
+    executionTime: number;
+    waitingTime: number;
+    error?: string;
+}

package/src/analytics/model-query.d.ts

@@ -0,0 +1,21 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { ISemanticModel } from './semantic-model';
+export interface IModelQuery extends IBasePerTenantAndOrganizationEntityModel {
+    key: string;
+    modelId: string;
+    model?: ISemanticModel;
+    name: string;
+    /**
+     * Index of the query in the list of queries in model
+     */
+    index?: number;
+    /**
+     * The details
+     */
+    options?: {
+        type?: 'sql' | 'mdx';
+        entities?: string[];
+        statement?: string;
+        conversations?: any[];
+    };
+}

package/src/analytics/notification-destination.d.ts

@@ -0,0 +1,10 @@
+import { IBasePerTenantEntityModel } from "../base-entity.model";
+export interface INotificationDestinationType {
+    name: string;
+    type: string;
+    icon?: string;
+    schema?: Record<string, unknown>;
+}
+export interface INotificationDestination extends IBasePerTenantEntityModel, INotificationDestinationType {
+    options?: Record<string, unknown>;
+}

package/src/analytics/permission-approval-user.model.d.ts

@@ -0,0 +1,10 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IUser } from '../user.model';
+import { IPermissionApproval } from './permission-approval.model';
+export interface IPermissionApprovalUser extends IBasePerTenantAndOrganizationEntityModel {
+    permissionApprovalId: string;
+    userId: string;
+    status: number;
+    permissionApproval: IPermissionApproval;
+    user: IUser;
+}

package/src/analytics/permission-approval.model.d.ts

@@ -0,0 +1,47 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { ITag } from '../tag-entity.model';
+import { IUser } from '../user.model';
+import { ApprovalPolicyTypesStringEnum, IApprovalPolicy } from './approval-policy.model';
+import { IIndicator } from './indicator';
+import { IPermissionApprovalUser } from './permission-approval-user.model';
+export interface IPermissionApproval extends IBasePerTenantAndOrganizationEntityModel {
+    status: number;
+    createdByName: string;
+    min_count: number;
+    permissionId: string;
+    permissionType: ApprovalPolicyTypesStringEnum;
+    approvalPolicy: IApprovalPolicy;
+    approvalPolicyId: string;
+    indicator: IIndicator;
+    indicatorId: string;
+    userApprovals?: IPermissionApprovalUser[];
+    tags?: ITag[];
+}
+export interface IPermissionApprovalCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+    id?: string;
+    userApprovals?: IPermissionApprovalUser[];
+    users?: IUser[];
+    permissionType?: ApprovalPolicyTypesStringEnum;
+    permissionId?: string;
+    indicatorId?: string;
+    status?: number;
+    approvalPolicyId?: string;
+    tags?: ITag[];
+}
+export declare enum PermissionApprovalStatusTypesEnum {
+    REQUESTED = 1,
+    APPROVED = 2,
+    REFUSED = 3
+}
+export declare const PermissionApprovalStatus: {
+    REQUESTED: number;
+    APPROVED: number;
+    REFUSED: number;
+};
+export interface IPermissionApprovalFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    id?: string;
+}
+export interface IApprovalsData {
+    icon: string;
+    title: string;
+}

package/src/analytics/project.model.d.ts

@@ -0,0 +1,50 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IStorageFile } from '../storage-file.model';
+import { IUser } from '../user.model';
+import { ICertification } from './certification.model';
+import { IIndicator } from './indicator';
+import { ISemanticModel } from './semantic-model';
+import { IStory } from './story';
+export interface IProject extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
+    description?: string;
+    options?: any;
+    /**
+     * Project owner, can be transfered
+     */
+    owner?: IUser;
+    ownerId?: string;
+    status?: ProjectStatusEnum;
+    stories?: IStory[];
+    indicators?: IIndicator[];
+    /**
+     * Project Members
+     */
+    members?: IUser[];
+    /**
+     * Semantic model bound in the project
+     */
+    models?: ISemanticModel[];
+    /**
+     * Certifications available in the project
+     */
+    certifications?: ICertification[];
+    /**
+     * Files in the project
+     */
+    files?: IStorageFile[];
+}
+export declare enum ProjectStatusEnum {
+    /**
+     * In use
+     */
+    Progressing = "Progressing",
+    /**
+     * Archived
+     */
+    Archived = "Archived"
+}
+export interface IBasePerProjectEntityModel extends IBasePerTenantAndOrganizationEntityModel {
+    projectId?: string;
+    project?: IProject;
+}