@metad/contracts 3.6.7 → 3.7.0

package/src/analytics/story.d.ts

@@ -0,0 +1,93 @@
+import { ITag } from '../tag-entity.model';
+import { Visibility } from '../visibility.model';
+import { IBusinessArea } from './business-area';
+import { ICollection } from './collection.model';
+import { IFavorite } from './favorite';
+import { IBasePerProjectEntityModel } from './project.model';
+import { IScreenshot } from './screenshot.model';
+import { ISemanticModel } from './semantic-model';
+import { IStoryPoint } from './story-point';
+import { IStoryTemplate } from './story-template.model';
+export interface IStory extends IBasePerProjectEntityModel {
+    name?: string;
+    description?: string;
+    tags?: ITag[];
+    status?: StoryStatusEnum;
+    collection?: ICollection;
+    collectionId?: string;
+    /**
+     * Released story destination
+     */
+    businessArea?: IBusinessArea;
+    businessAreaId?: string;
+    modelId?: string;
+    /**
+     * Story's models space
+     */
+    model?: ISemanticModel;
+    /**
+     * Story relative models
+     */
+    models?: ISemanticModel[];
+    visibility?: Visibility;
+    points?: IStoryPoint[];
+    options?: Record<string, unknown>;
+    thumbnail?: string;
+    previewId?: string;
+    preview?: IScreenshot;
+    templateId?: string;
+    template?: IStoryTemplate;
+    asTemplate?: IStoryTemplate;
+    pv?: number;
+}
+export declare enum StoryStatusEnum {
+    /**
+     * 草稿
+     */
+    DRAFT = "DRAFT",
+    /**
+     * 重新编辑
+     */
+    CHANGING = "CHANGING",
+    /**
+     * 审阅中
+     */
+    REVIEW = "REVIEW",
+    /**
+     * 通过
+     */
+    APPROVED = "APPROVED",
+    /**
+     * 退回
+     */
+    REJECTED = "REJECTED",
+    /**
+     * 已发布
+     */
+    RELEASED = "RELEASED",
+    /**
+     * 下线存档
+     */
+    ARCHIVED = "ARCHIVED"
+}
+export interface Accessibility {
+    access?: AccessEnum;
+    bookmark?: IFavorite;
+}
+/**
+ * 用户对某个实体的访问权限
+ */
+export declare enum AccessEnum {
+    /**
+     * 可看到
+     */
+    View = "View",
+    /**
+     * 可读取详情
+     */
+    Read = "Read",
+    /**
+     * 可编辑
+     */
+    Write = "Write"
+}

package/src/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/src/analytics/visit.model.d.ts

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

package/src/analytics/webSocket.d.ts

@@ -0,0 +1,48 @@
+import { ISemanticModel } from "./semantic-model";
+export interface AgentEventRequest {
+    url?: string;
+    headers: {
+        [key: string]: string[];
+    };
+    body?: any;
+    catalog?: string;
+    table?: string;
+    forceRefresh?: boolean;
+    auth?: {
+        username: string;
+        password: string;
+    };
+}
+export interface AgentEventResponse extends AgentEventRequest {
+    status: number;
+    statusText: string;
+}
+export declare enum AgentEventType {
+    request = "request",
+    response = "response",
+    error = "error"
+}
+export interface AgentEvent {
+    type?: 'connected';
+    id: string;
+    event: AgentEventType;
+    data: {
+        organizationId?: string;
+        dataSource?: {
+            id: string;
+            name: string;
+            type: string;
+            updatedAt?: Date;
+        };
+        modelId?: string;
+        semanticModel?: ISemanticModel;
+        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/src/api-key.model.d.ts

@@ -0,0 +1,10 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+export interface IApiKey extends IBasePerTenantAndOrganizationEntityModel {
+    token: string;
+    name?: string;
+    type?: string;
+    entityId?: string;
+    validUntil?: Date;
+    expired?: boolean;
+    lastUsedAt?: Date;
+}

package/src/base-entity.model.d.ts

@@ -0,0 +1,27 @@
+import { ITenant } from './tenant.model';
+import { IOrganization } from './organization.model';
+import { ID } from './types';
+import { IUser } from './user.model';
+export interface IBaseRelationsEntityModel {
+    relations?: string[];
+}
+export interface IBaseSoftDeleteEntityModel {
+    deletedAt?: Date;
+}
+export interface IBaseEntityModel extends IBaseSoftDeleteEntityModel {
+    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/src/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/src/core.model.d.ts

@@ -0,0 +1,97 @@
+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;
+}
+/**
+ * Describes generic pagination params
+ */
+export interface IPaginationParam extends IOptionParams {
+    /**
+     * Limit (paginated) - max number of entities should be taken.
+     */
+    readonly take?: number;
+    /**
+     * Offset (paginated) where from entities should be taken.
+     */
+    readonly skip?: number;
+}
+export interface IOptionParams {
+    /**
+     * Order, in which entities should be ordered.
+     */
+    readonly order?: Record<string, any>;
+    /**
+     * Simple condition that should be applied to match entities.
+     */
+    readonly where: Record<string, any>;
+    /**
+     * Indicates if soft-deleted rows should be included in entity result.
+     */
+    readonly withDeleted?: boolean;
+}
+export declare enum OrderTypeEnum {
+    DESC = "DESC",
+    ASC = "ASC"
+}
+export type JSONValue = null | string | number | boolean | {
+    [x: string]: JSONValue;
+} | Array<JSONValue>;
+export type WhereOperator<T> = {
+    $eq?: T;
+} | {
+    $ne?: T;
+} | {
+    $in?: T[];
+} | {
+    $notIn?: T[];
+} | {
+    $like?: string;
+} | {
+    $ilike?: string;
+} | {
+    $gt?: T;
+} | {
+    $gte?: T;
+} | {
+    $lt?: T;
+} | {
+    $lte?: T;
+} | {
+    $isNull?: boolean;
+};
+export type SmartWhere<T> = Partial<{
+    [P in keyof T]?: T[P] | WhereOperator<T[P]>;
+}>;
+export type PaginationParams<T> = {
+    select?: (keyof T)[] | {
+        [P in keyof T]?: P extends "toString" ? unknown : NonNullable<T[P]>;
+    };
+    take?: number;
+    skip?: number;
+    where?: SmartWhere<T>;
+    relations?: string[];
+    order?: Partial<{
+        [P in keyof T]: OrderTypeEnum;
+    }>;
+};

package/src/{country.model.ts → country.model.d.ts}

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