@metad/contracts 0.0.1

package/README.md

@@ -0,0 +1 @@
+# Pangolin

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

@@ -0,0 +1,29 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { LanguagesEnum, IUser } from '../user.model';
+import { IBusinessArea } from './business-area';
+export interface IBusinessAreaUser extends IBasePerTenantAndOrganizationEntityModel {
+    businessAreaId: string;
+    businessArea?: IBusinessArea;
+    userId: string;
+    isDefault: boolean;
+    isActive: boolean;
+    user?: IUser;
+}
+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/analytics/business-area.d.ts

@@ -0,0 +1,16 @@
+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>;
+}
+export declare enum BusinessType {
+    SEMANTIC_MODEL = "SEMANTIC_MODEL",
+    STORY = "STORY",
+    INDICATOR = "INDICATOR"
+}

package/analytics/business-group.d.ts

@@ -0,0 +1,12 @@
+import { IBasePerTenantEntityModel } from "../base-entity.model";
+import { ITag } from "../tag-entity.model";
+import { BusinessType } from "./business-area";
+import { IStory } from "./story";
+export interface IBusinessGroup1 extends IBasePerTenantEntityModel {
+    type?: BusinessType;
+    name?: string;
+    parentId?: string;
+    level?: number;
+    tags?: ITag[];
+    stories?: Array<IStory>;
+}

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

@@ -0,0 +1,12 @@
+import { IBasePerTenantEntityModel } from "../base-entity.model";
+export interface IDataSourceType extends IBasePerTenantEntityModel {
+    name?: string;
+    type?: string;
+    syntax?: string;
+    protocol?: string;
+    configuration?: Record<string, unknown>;
+}
+export declare enum DataSourceSyntaxEnum {
+}
+export declare enum DataSourceProtocolEnum {
+}

package/analytics/data-source.d.ts

@@ -0,0 +1,43 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.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;
+    options?: Record<string, unknown>;
+    models?: ISemanticModel[];
+}
+export declare enum DataSourceTypeEnum {
+    NONE = "NONE",
+    BI_WEEKLY = "BI_WEEKLY",
+    WEEKLY = "WEEKLY",
+    TWICE_PER_MONTH = "TWICE_PER_MONTH",
+    MONTHLY = "MONTHLY"
+}
+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;
+    type: string;
+    nullable?: boolean;
+    position?: number;
+    /**
+     * 应该等同于 label
+     */
+    comment?: string;
+}

package/analytics/favorite.d.ts

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

package/analytics/features.d.ts

@@ -0,0 +1,19 @@
+export declare enum AnalyticsFeatures {
+    FEATURE_BUSINESS_GROUP = "FEATURE_BUSINESS_GROUP",
+    FEATURE_INDICATOR = "FEATURE_INDICATOR",
+    FEATURE_INDICATOR_MARKET = "FEATURE_INDICATOR_MARKET",
+    FEATURE_INDICATOR_REGISTER = "FEATURE_INDICATOR_REGISTER",
+    FEATURE_INDICATOR_MY = "FEATURE_INDICATOR_MY",
+    FEATURE_INDICATOR_VIEWER = "FEATURE_INDICATOR_VIEWER",
+    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_INSIGHT = "FEATURE_INSIGHT",
+    FEATURE_INSIGHT_ADMIN = "FEATURE_INSIGHT_ADMIN",
+    FEATURE_INSIGHT_VIEWER = "FEATURE_INSIGHT_VIEWER"
+}

package/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/analytics/index.d.ts

@@ -0,0 +1,20 @@
+export * from './business-area';
+export * from './business-area-user.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-market';
+export * from './insight-model';
+export * from './model-query';
+export * from './notification-destination';
+export * from './role-permissions';
+export * from './semantic-model';
+export * from './story';
+export * from './story-point';
+export * from './story-widget';
+export * from './subscription';
+export * from './visit.model';
+export * from './webSocket';

package/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/analytics/indicator.d.ts

@@ -0,0 +1,31 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { ITag } from '../tag-entity.model';
+import { IBusinessArea } from './business-area';
+import { ISemanticModel } from './semantic-model';
+export interface IIndicator extends IBasePerTenantAndOrganizationEntityModel {
+    code?: string;
+    name?: string;
+    type?: IndicatorType;
+    modelId?: string;
+    model?: ISemanticModel;
+    entity?: string;
+    unit?: string;
+    principal?: string;
+    authentication?: string;
+    validity?: string;
+    business?: string;
+    status?: string;
+    options?: {
+        dimensions?: Array<string>;
+        filters?: Array<any>;
+        formula?: string;
+        measure?: string;
+    };
+    businessAreaId?: string;
+    businessArea?: IBusinessArea;
+    tags?: ITag[];
+}
+export declare enum IndicatorType {
+    BASIC = "BASIC",
+    DERIVE = "DERIVE"
+}

package/analytics/insight-model.d.ts

@@ -0,0 +1,14 @@
+import { IBasePerTenantEntityModel } from '../base-entity.model';
+import { ITag } from '../tag-entity.model';
+import { IBusinessArea } from './business-area';
+import { ISemanticModel } from './semantic-model';
+export interface IInsightModel extends IBasePerTenantEntityModel {
+    name?: string;
+    entity?: string;
+    options?: Record<string, unknown>;
+    modelId?: string;
+    model?: ISemanticModel;
+    businessAreaId?: string;
+    businessArea?: IBusinessArea;
+    tags?: ITag[];
+}

package/analytics/model-query.d.ts

@@ -0,0 +1,12 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { ISemanticModel } from './semantic-model';
+export interface IModelQuery extends IBasePerTenantAndOrganizationEntityModel {
+    key: string;
+    modelId: string;
+    model?: ISemanticModel;
+    name: string;
+    options: {
+        entities: string[];
+        statement?: string;
+    };
+}

package/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/analytics/role-permissions.d.ts

@@ -0,0 +1,19 @@
+export declare enum AnalyticsPermissionsEnum {
+    DATA_SOURCE_VIEW = "DATA_SOURCE_VIEW",
+    DATA_SOURCE_EDIT = "DATA_SOURCE_EDIT",
+    NOTIFICATION_DESTINATION_VIEW = "NOTIFICATION_DESTINATION_VIEW",
+    NOTIFICATION_DESTINATION_EDIT = "NOTIFICATION_DESTINATION_EDIT",
+    SUBSCRIPTION_VIEW = "SUBSCRIPTION_VIEW",
+    SUBSCRIPTION_EDIT = "SUBSCRIPTION_EDIT",
+    MODELS_VIEW = "MODELS_VIEW",
+    MODELS_EDIT = "MODELS_EDIT",
+    STORIES_VIEW = "STORIES_VIEW",
+    STORIES_EDIT = "STORIES_EDIT",
+    BUSINESS_GROUP_VIEW = "BUSINESS_GROUP_VIEW",
+    BUSINESS_GROUP_EDIT = "BUSINESS_GROUP_EDIT",
+    INDICATOR_VIEW = "INDICATOR_VIEW",
+    INDICATOR_MARTKET_VIEW = "INDICATOR_MARTKET_VIEW",
+    INDICATOR_EDIT = "INDICATOR_EDIT",
+    INSIGHT_VIEW = "INSIGHT_VIEW",
+    INSIGHT_EDIT = "INSIGHT_EDIT"
+}

package/analytics/semantic-model.d.ts

@@ -0,0 +1,42 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { ITag } from '../tag-entity.model';
+import { IBusinessArea } from './business-area';
+import { IDataSource } from './data-source';
+import { IIndicator } from './indicator';
+import { IModelQuery } from './model-query';
+import { IStory } from './story';
+export declare enum AgentType {
+    Local = "local",
+    Browser = "browser",
+    Server = "server",
+    Wasm = "wasm"
+}
+export interface ISemanticModelPreferences {
+    enableCache?: boolean;
+    expires?: number;
+    language?: string;
+}
+export interface ISemanticModel extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
+    type?: string;
+    agentType?: AgentType;
+    tags?: ITag[];
+    dataSourceId?: string;
+    dataSource?: IDataSource;
+    businessAreaId?: string;
+    businessArea?: IBusinessArea;
+    catalog?: string;
+    cube?: string;
+    options?: Record<string, unknown>;
+    preferences?: ISemanticModelPreferences;
+    stories?: Array<IStory>;
+    indicators?: Array<IIndicator>;
+    queries?: Array<IModelQuery>;
+}
+export declare enum ModelTypeEnum {
+    NONE = "NONE",
+    BI_WEEKLY = "BI_WEEKLY",
+    WEEKLY = "WEEKLY",
+    TWICE_PER_MONTH = "TWICE_PER_MONTH",
+    MONTHLY = "MONTHLY"
+}

package/analytics/story-point.d.ts

@@ -0,0 +1,10 @@
+import { IStoryWidget } from './story-widget';
+import { IBasePerTenantEntityModel } from '../base-entity.model';
+import { IStory } from './story';
+export interface IStoryPoint extends IBasePerTenantEntityModel {
+    name?: string;
+    storyId: string;
+    story?: IStory;
+    options?: Record<string, unknown>;
+    widgets?: IStoryWidget[];
+}

package/analytics/story-widget.d.ts

@@ -0,0 +1,11 @@
+import { IBasePerTenantEntityModel } from '../base-entity.model';
+import { IStory } from './story';
+import { IStoryPoint } from './story-point';
+export interface IStoryWidget extends IBasePerTenantEntityModel {
+    name?: string;
+    storyId: string;
+    story?: IStory;
+    pointId: string;
+    point?: IStoryPoint;
+    options?: Record<string, unknown>;
+}

package/analytics/story.d.ts

@@ -0,0 +1,18 @@
+import { IBasePerTenantEntityModel } from '../base-entity.model';
+import { ITag } from '../tag-entity.model';
+import { Visibility } from '../visibility.model';
+import { IBusinessArea } from './business-area';
+import { ISemanticModel } from './semantic-model';
+import { IStoryPoint } from './story-point';
+export interface IStory extends IBasePerTenantEntityModel {
+    name?: string;
+    description?: string;
+    tags?: ITag[];
+    businessAreaId?: string;
+    businessArea?: IBusinessArea;
+    modelId?: string;
+    model?: ISemanticModel;
+    visibility?: Visibility;
+    points?: IStoryPoint[];
+    options?: Record<string, unknown>;
+}

package/analytics/subscription.d.ts

@@ -0,0 +1,38 @@
+import { IBasePerTenantEntityModel } from "../base-entity.model";
+import { INotificationDestination } from "./notification-destination";
+import { IStory } from "./story";
+export interface ISubscription extends IBasePerTenantEntityModel {
+    name: string;
+    type: SubscriptionType;
+    description?: string;
+    /**
+     * 启动订阅
+     */
+    enable?: boolean;
+    storyId?: string;
+    story?: IStory;
+    pointId?: string;
+    widgetId?: string;
+    destinationId?: string;
+    /**
+     * 目的地
+     */
+    destination?: INotificationDestination;
+    selectedDateType?: string;
+    sendDate?: string;
+    sendTime?: string;
+    miOffice?: boolean;
+    selectedUser?: string;
+    selectedGroup?: string;
+    notifyEveryone?: boolean;
+    subscriptionDetail?: string;
+    navigationButton?: boolean;
+    buttonDesc?: string;
+    linkSetting?: string;
+    linkUrl?: string;
+    options?: Record<string, unknown>;
+}
+export declare enum SubscriptionType {
+    CHART = "CHART",
+    INDICATOR = "INDICATOR"
+}

package/analytics/user-business-group.model.d.ts

@@ -0,0 +1,29 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { LanguagesEnum, IUser } from '../user.model';
+import { IBusinessGroup1 } from './business-group';
+export interface IUserBusinessGroup1 extends IBasePerTenantAndOrganizationEntityModel {
+    businessGroupId: string;
+    businessGroup?: IBusinessGroup1;
+    userId: string;
+    isDefault: boolean;
+    isActive: boolean;
+    user?: IUser;
+}
+export interface IUserBusinessGroupFindInput extends IBasePerTenantAndOrganizationEntityModel {
+    businessGroupId?: string;
+    id?: string;
+    userId?: string;
+    isDefault?: boolean;
+    isActive?: boolean;
+}
+export interface IUserBusinessGroupCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+    businessGroupId: string;
+    userId: string;
+    isDefault?: boolean;
+    isActive?: boolean;
+}
+export interface IUserBusinessGroupDeleteInput {
+    userBusinessGroupId: string;
+    requestingUser: IUser;
+    language?: LanguagesEnum;
+}

package/analytics/visit.model.d.ts

@@ -0,0 +1,27 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+export interface IVisit extends IBasePerTenantAndOrganizationEntityModel {
+    type: VisitTypeEnum;
+    entity: VisitEntityEnum;
+    entityId: string;
+    entityName?: string;
+    businessAreaId?: string;
+    visitAt?: number;
+    visits?: number;
+}
+export declare enum VisitEntityEnum {
+    DataSource = "DataSource",
+    SemanticModel = "SemanticModel",
+    Story = "Story",
+    Widget = "Widget"
+}
+export declare enum VisitTypeEnum {
+    View = "View",
+    Data = "Data"
+}
+export interface IEntityVisits {
+    entity?: VisitEntityEnum;
+    entityId: string;
+    entityName: string;
+    pv?: number;
+    uv?: number;
+}

package/analytics/webSocket.d.ts

@@ -0,0 +1,40 @@
+export interface AgentEventRequest {
+    url?: string;
+    headers: {
+        [key: string]: string[];
+    };
+    body?: any;
+    catalog?: string;
+    table?: string;
+    forceRefresh?: boolean;
+}
+export interface AgentEventResponse extends AgentEventRequest {
+    status: number;
+    statusText: string;
+}
+export declare enum AgentEventType {
+    request = "request",
+    response = "response",
+    error = "error"
+}
+export interface AgentEvent {
+    id: string;
+    event: AgentEventType;
+    data: {
+        organizationId?: string;
+        dataSource?: {
+            id: string;
+            type: string;
+            updatedAt?: Date;
+        };
+        modelId?: string;
+        request: AgentEventRequest;
+        response?: AgentEventResponse;
+        error?: string;
+    };
+}
+export declare enum LocalAgentType {
+    TENANT = 0,
+    USER = 1
+}
+export declare const TENANT_AGENT_LOCAL_URL = "agent-local-url";

package/base-entity.model.d.ts

@@ -0,0 +1,21 @@
+import { ITenant } from './tenant.model';
+import { IOrganization } from './organization.model';
+import { IUser } from './user.model';
+export declare type ID = string;
+export interface IBaseEntityModel {
+    id?: ID;
+    createdById?: ID;
+    createdBy?: IUser;
+    updatedById?: ID;
+    updatedBy?: IUser;
+    readonly createdAt?: Date;
+    readonly updatedAt?: Date;
+}
+export interface IBasePerTenantEntityModel extends IBaseEntityModel {
+    tenantId?: string;
+    tenant?: ITenant;
+}
+export interface IBasePerTenantAndOrganizationEntityModel extends IBasePerTenantEntityModel {
+    organizationId?: string;
+    organization?: IOrganization;
+}

package/contact.model.d.ts

@@ -0,0 +1,41 @@
+import { IOrganizationContact } from './organization-contact.model';
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { IEmployee } from './employee.model';
+export interface IContact extends IBasePerTenantAndOrganizationEntityModel {
+    id?: string;
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+    country?: string;
+    city?: string;
+    address?: string;
+    address2?: string;
+    postcode?: string;
+    latitude?: number;
+    longitude?: number;
+    regionCode?: string;
+    fax?: string;
+    fiscalInformation?: string;
+    website?: string;
+    organization_contacts?: IOrganizationContact[];
+    employees?: IEmployee[];
+}
+export interface IContactFindInput extends IContactCreateInput {
+    id?: string;
+}
+export interface IContactCreateInput extends IBasePerTenantAndOrganizationEntityModel {
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+    country?: string;
+    city?: string;
+    address?: string;
+    address2?: string;
+    postcode?: string;
+    latitude?: number;
+    longitude?: number;
+    regionCode?: string;
+    fax?: string;
+    fiscalInformation?: string;
+    website?: string;
+}

package/core.model.d.ts

@@ -0,0 +1,25 @@
+export interface IPaginationInput {
+    limit?: number;
+    page?: number;
+}
+/**
+* Generic pagination interface
+*/
+export interface IPagination<T> {
+    /**
+     * Items included in the current listing
+     */
+    readonly items: T[];
+    /**
+     * Total number of available items
+     */
+    readonly total: number;
+}
+export interface IListQueryInput<T> {
+    /**
+     * Model entity defined relations
+     */
+    readonly relations?: string[];
+    readonly findInput?: T | any;
+    readonly where?: any;
+}

package/country.model.d.ts

@@ -0,0 +1,5 @@
+import { IBaseEntityModel } from './base-entity.model';
+export interface ICountry extends IBaseEntityModel {
+    isoCode: string;
+    country: string;
+}