@metad/contracts 3.6.0 → 3.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.babelrc +5 -0
- package/.eslintrc.json +18 -0
- package/babel.config.json +1 -0
- package/index.cjs.js +5 -3996
- package/jest.config.ts +16 -0
- package/package.json +2 -2
- package/project.json +53 -0
- package/src/agent/{ai-model.d.ts → ai-model.ts} +2 -2
- package/src/agent/graph.ts +272 -0
- package/src/agent/index.ts +5 -0
- package/src/agent/token.ts +23 -0
- package/src/agent/utils.spec.ts +283 -0
- package/src/agent/utils.ts +122 -0
- package/src/agent/variables.ts +21 -0
- package/src/ai/ai-model.model.ts +228 -0
- package/src/ai/ai-provider.model.ts +53 -0
- package/src/ai/ai.model.ts +87 -0
- package/src/ai/chat-message-feedback.model.ts +31 -0
- package/src/ai/chat-message.model.ts +277 -0
- package/src/ai/chat.model.ts +207 -0
- package/src/ai/copilot-checkpoint.model.ts +25 -0
- package/src/ai/copilot-example.model.ts +23 -0
- package/src/ai/copilot-model.model.ts +31 -0
- package/src/ai/copilot-organization.model.ts +21 -0
- package/src/ai/copilot-provider.model.ts +46 -0
- package/src/ai/copilot-role.model.ts +48 -0
- package/src/ai/copilot-store.model.ts +34 -0
- package/src/ai/copilot-user.model.ts +24 -0
- package/src/ai/copilot.model.ts +47 -0
- package/src/ai/{environment.model.d.ts → environment.model.ts} +12 -10
- package/src/ai/feature.model.ts +6 -0
- package/src/ai/index.ts +39 -0
- package/src/ai/knowledge-doc-chunk.model.ts +120 -0
- package/src/ai/knowledge-doc-chunk.spec.ts +47 -0
- package/src/ai/knowledge-doc-page.model.ts +20 -0
- package/src/ai/knowledge-doc.model.ts +252 -0
- package/src/ai/knowledge-pipeline.ts +138 -0
- package/src/ai/knowledge-retrieval-log.model.ts +19 -0
- package/src/ai/knowledgebase-task.model.ts +46 -0
- package/src/ai/knowledgebase.model.ts +190 -0
- package/src/ai/rag-web.ts +54 -0
- package/src/ai/rag.ts +24 -0
- package/src/ai/role-permissions.ts +13 -0
- package/src/ai/types.ts +83 -0
- package/src/ai/xpert-agent-execution.model.ts +115 -0
- package/src/ai/xpert-agent.model.ts +258 -0
- package/src/ai/xpert-project.model.ts +103 -0
- package/src/ai/xpert-task.model.ts +32 -0
- package/src/ai/xpert-template.model.ts +53 -0
- package/src/ai/xpert-tool-mcp.model.ts +72 -0
- package/src/ai/xpert-tool.model.ts +211 -0
- package/src/ai/xpert-toolset.model.ts +220 -0
- package/src/ai/xpert-workflow-task.prompt.ts +71 -0
- package/src/ai/xpert-workflow.model.ts +449 -0
- package/src/ai/xpert-workspace.model.ts +42 -0
- package/src/ai/xpert.model.ts +613 -0
- package/src/ai/xpert.utils.ts +214 -0
- package/src/analytics/ai.ts +79 -0
- package/src/analytics/approval-policy.model.ts +40 -0
- package/src/analytics/business-area-user.model.ts +43 -0
- package/src/analytics/business-area.ts +20 -0
- package/src/analytics/certification.model.ts +12 -0
- package/src/analytics/chatbi-conversation.model.ts +16 -0
- package/src/analytics/chatbi-model.model.ts +22 -0
- package/src/analytics/collection.model.ts +8 -0
- package/src/analytics/comment.model.ts +14 -0
- package/src/analytics/data-source-type.ts +19 -0
- package/src/analytics/data-source.ts +72 -0
- package/src/analytics/favorite.ts +18 -0
- package/src/analytics/features.ts +19 -0
- package/src/analytics/feed-model.ts +15 -0
- package/src/analytics/gateway.ts +30 -0
- package/src/analytics/index.ts +39 -0
- package/src/analytics/indicator-app.ts +49 -0
- package/src/analytics/{indicator-market.d.ts → indicator-market.ts} +6 -2
- package/src/analytics/indicator.ts +127 -0
- package/src/analytics/model-query-log.model.ts +45 -0
- package/src/analytics/model-query.ts +22 -0
- package/src/analytics/{notification-destination.d.ts → notification-destination.ts} +9 -5
- package/src/analytics/{permission-approval-user.model.d.ts → permission-approval-user.model.ts} +10 -8
- package/src/analytics/permission-approval.model.ts +58 -0
- package/src/analytics/project.model.ts +56 -0
- package/src/analytics/role-permissions.ts +36 -0
- package/src/analytics/schema.ts +300 -0
- package/src/analytics/screenshot.model.ts +28 -0
- package/src/analytics/semantic-model-entity.ts +49 -0
- package/src/analytics/semantic-model-member.ts +45 -0
- package/src/analytics/semantic-model.ts +227 -0
- package/src/analytics/{story-point.d.ts → story-point.ts} +11 -6
- package/src/analytics/story-template.model.ts +34 -0
- package/src/analytics/story-widget.ts +15 -0
- package/src/analytics/story.ts +109 -0
- package/src/analytics/subscription.ts +43 -0
- package/src/analytics/visit.model.ts +39 -0
- package/src/analytics/webSocket.ts +53 -0
- package/src/api-key.model.ts +11 -0
- package/src/base-entity.model.ts +34 -0
- package/src/contact.model.ts +45 -0
- package/src/core.model.ts +103 -0
- package/src/{country.model.d.ts → country.model.ts} +3 -2
- package/src/currency.model.ts +582 -0
- package/src/{custom-smtp.model.d.ts → custom-smtp.model.ts} +21 -17
- package/src/date-picker.model.ts +5 -0
- package/src/email-template.model.ts +50 -0
- package/src/email.model.ts +46 -0
- package/src/employee.model.ts +199 -0
- package/src/entity-with-members.model.ts +16 -0
- package/src/feature.model.ts +108 -0
- package/src/file-provider.ts +37 -0
- package/src/help-center-article.model.ts +35 -0
- package/src/help-center.model.ts +33 -0
- package/src/http-status.enum.ts +58 -0
- package/src/import-export.model.ts +42 -0
- package/src/index.ts +60 -0
- package/src/integration/dify.ts +31 -0
- package/src/integration/dingtalk.ts +16 -0
- package/src/integration/fastgpt.ts +32 -0
- package/src/integration/firecrawl.ts +46 -0
- package/src/integration/github.ts +149 -0
- package/src/integration/index.ts +15 -0
- package/src/integration/lark.ts +79 -0
- package/src/integration/wecom.ts +16 -0
- package/src/integration.model.ts +119 -0
- package/src/invite.model.ts +144 -0
- package/src/language.model.ts +22 -0
- package/src/organization-contact.model.ts +84 -0
- package/src/{organization-department.model.d.ts → organization-department.model.ts} +16 -10
- package/src/organization-language.model.ts +24 -0
- package/src/organization-projects.model.ts +99 -0
- package/src/organization-team-employee-model.ts +14 -0
- package/src/organization-team-model.ts +25 -0
- package/src/organization.model.ts +266 -0
- package/src/password-reset.model.ts +22 -0
- package/src/{plain-object.model.d.ts → plain-object.model.ts} +1 -1
- package/src/plugin.ts +15 -0
- package/src/role-permission.model.ts +123 -0
- package/src/role.model.ts +31 -0
- package/src/schedule.ts +71 -0
- package/src/secret-token.model.ts +15 -0
- package/src/seed.model.ts +50 -0
- package/src/storage-file.model.ts +46 -0
- package/src/tag-entity.model.ts +23 -0
- package/src/tenant.model.ts +52 -0
- package/src/tools/index.ts +1 -0
- package/src/tools/sandbox.ts +5 -0
- package/src/translation.model.ts +37 -0
- package/src/types.ts +277 -0
- package/src/user-organization.model.ts +31 -0
- package/src/user.model.ts +151 -0
- package/src/visibility.model.ts +6 -0
- package/tsconfig.json +22 -0
- package/tsconfig.lib.json +10 -0
- package/tsconfig.spec.json +9 -0
- package/index.cjs.d.ts +0 -1
- package/index.esm.d.ts +0 -1
- package/index.esm.js +0 -3900
- package/src/agent/graph.d.ts +0 -148
- package/src/agent/index.d.ts +0 -5
- package/src/agent/token.d.ts +0 -21
- package/src/agent/utils.d.ts +0 -19
- package/src/agent/variables.d.ts +0 -14
- package/src/ai/ai-model.model.d.ts +0 -195
- package/src/ai/ai-provider.model.d.ts +0 -43
- package/src/ai/ai.model.d.ts +0 -82
- package/src/ai/chat-message-feedback.model.d.ts +0 -24
- package/src/ai/chat-message.model.d.ts +0 -222
- package/src/ai/chat.model.d.ts +0 -189
- package/src/ai/copilot-checkpoint.model.d.ts +0 -23
- package/src/ai/copilot-example.model.d.ts +0 -19
- package/src/ai/copilot-model.model.d.ts +0 -26
- package/src/ai/copilot-organization.model.d.ts +0 -17
- package/src/ai/copilot-provider.model.d.ts +0 -31
- package/src/ai/copilot-role.model.d.ts +0 -43
- package/src/ai/copilot-store.model.d.ts +0 -29
- package/src/ai/copilot-user.model.d.ts +0 -20
- package/src/ai/copilot.model.d.ts +0 -36
- package/src/ai/feature.model.d.ts +0 -6
- package/src/ai/index.d.ts +0 -38
- package/src/ai/knowledge-doc-page.model.d.ts +0 -15
- package/src/ai/knowledge-doc.model.d.ts +0 -177
- package/src/ai/knowledge-pipeline.d.ts +0 -100
- package/src/ai/knowledge-retrieval-log.model.d.ts +0 -10
- package/src/ai/knowledgebase-task.model.d.ts +0 -36
- package/src/ai/knowledgebase.model.d.ts +0 -160
- package/src/ai/rag-web.d.ts +0 -26
- package/src/ai/rag.d.ts +0 -24
- package/src/ai/role-permissions.d.ts +0 -13
- package/src/ai/types.d.ts +0 -39
- package/src/ai/xpert-agent-execution.model.d.ts +0 -96
- package/src/ai/xpert-agent.model.d.ts +0 -192
- package/src/ai/xpert-project.model.d.ts +0 -86
- package/src/ai/xpert-task.model.d.ts +0 -26
- package/src/ai/xpert-template.model.d.ts +0 -47
- package/src/ai/xpert-tool-mcp.model.d.ts +0 -67
- package/src/ai/xpert-tool.model.d.ts +0 -147
- package/src/ai/xpert-toolset.model.d.ts +0 -200
- package/src/ai/xpert-workflow-task.prompt.d.ts +0 -2
- package/src/ai/xpert-workflow.model.d.ts +0 -365
- package/src/ai/xpert-workspace.model.d.ts +0 -32
- package/src/ai/xpert.model.d.ts +0 -497
- package/src/ai/xpert.utils.d.ts +0 -80
- package/src/analytics/ai.d.ts +0 -73
- package/src/analytics/approval-policy.model.d.ts +0 -30
- package/src/analytics/business-area-user.model.d.ts +0 -35
- package/src/analytics/business-area.d.ts +0 -17
- package/src/analytics/certification.model.d.ts +0 -11
- package/src/analytics/chatbi-conversation.model.d.ts +0 -15
- package/src/analytics/chatbi-model.model.d.ts +0 -18
- package/src/analytics/collection.model.d.ts +0 -6
- package/src/analytics/comment.model.d.ts +0 -10
- package/src/analytics/data-source-type.d.ts +0 -16
- package/src/analytics/data-source.d.ts +0 -62
- package/src/analytics/favorite.d.ts +0 -14
- package/src/analytics/features.d.ts +0 -19
- package/src/analytics/feed-model.d.ts +0 -13
- package/src/analytics/gateway.d.ts +0 -27
- package/src/analytics/index.d.ts +0 -38
- package/src/analytics/indicator-app.d.ts +0 -44
- package/src/analytics/indicator.d.ts +0 -106
- package/src/analytics/model-query-log.model.d.ts +0 -41
- package/src/analytics/model-query.d.ts +0 -21
- package/src/analytics/permission-approval.model.d.ts +0 -47
- package/src/analytics/project.model.d.ts +0 -50
- package/src/analytics/role-permissions.d.ts +0 -25
- package/src/analytics/schema.d.ts +0 -262
- package/src/analytics/screenshot.model.d.ts +0 -25
- package/src/analytics/semantic-model-entity.d.ts +0 -37
- package/src/analytics/semantic-model-member.d.ts +0 -24
- package/src/analytics/semantic-model.d.ts +0 -175
- package/src/analytics/story-template.model.d.ts +0 -28
- package/src/analytics/story-widget.d.ts +0 -12
- package/src/analytics/story.d.ts +0 -93
- package/src/analytics/subscription.d.ts +0 -38
- package/src/analytics/visit.model.d.ts +0 -34
- package/src/analytics/webSocket.d.ts +0 -48
- package/src/api-key.model.d.ts +0 -10
- package/src/base-entity.model.d.ts +0 -27
- package/src/contact.model.d.ts +0 -41
- package/src/core.model.d.ts +0 -97
- package/src/currency.model.d.ts +0 -579
- package/src/date-picker.model.d.ts +0 -5
- package/src/email-template.model.d.ts +0 -39
- package/src/email.model.d.ts +0 -36
- package/src/employee.model.d.ts +0 -128
- package/src/entity-with-members.model.d.ts +0 -13
- package/src/feature.model.d.ts +0 -93
- package/src/file-provider.d.ts +0 -33
- package/src/help-center-article.model.d.ts +0 -0
- package/src/help-center.model.d.ts +0 -0
- package/src/http-status.enum.d.ts +0 -57
- package/src/import-export.model.d.ts +0 -36
- package/src/index.d.ts +0 -48
- package/src/integration/dify.d.ts +0 -0
- package/src/integration/dingtalk.d.ts +0 -2
- package/src/integration/fastgpt.d.ts +0 -0
- package/src/integration/firecrawl.d.ts +0 -2
- package/src/integration/github.d.ts +0 -69
- package/src/integration/index.d.ts +0 -4
- package/src/integration/lark.d.ts +0 -11
- package/src/integration/ragflow.d.ts +0 -0
- package/src/integration/wecom.d.ts +0 -2
- package/src/integration.model.d.ts +0 -86
- package/src/invite.model.d.ts +0 -123
- package/src/language.model.d.ts +0 -19
- package/src/organization-contact.model.d.ts +0 -73
- package/src/organization-language.model.d.ts +0 -18
- package/src/organization-projects.model.d.ts +0 -80
- package/src/organization-team-employee-model.d.ts +0 -12
- package/src/organization-team-model.d.ts +0 -19
- package/src/organization.model.d.ts +0 -239
- package/src/password-reset.model.d.ts +0 -18
- package/src/plugin.d.ts +0 -13
- package/src/role-permission.model.d.ts +0 -61
- package/src/role.model.d.ts +0 -26
- package/src/schedule.d.ts +0 -27
- package/src/secret-token.model.d.ts +0 -11
- package/src/seed.model.d.ts +0 -37
- package/src/storage-file.model.d.ts +0 -40
- package/src/tag-entity.model.d.ts +0 -20
- package/src/tenant.model.d.ts +0 -40
- package/src/tools/index.d.ts +0 -1
- package/src/tools/sandbox.d.ts +0 -5
- package/src/translation.model.d.ts +0 -26
- package/src/types.d.ts +0 -240
- package/src/user-organization.model.d.ts +0 -24
- package/src/user.model.d.ts +0 -128
- package/src/visibility.model.d.ts +0 -6
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
|
|
2
|
-
import { IIndicator } from './indicator';
|
|
3
|
-
import { ISemanticModel } from './semantic-model';
|
|
4
|
-
import { IStory } from './story';
|
|
5
|
-
export interface IVisit extends IBasePerTenantAndOrganizationEntityModel {
|
|
6
|
-
type: VisitTypeEnum;
|
|
7
|
-
entity: VisitEntityEnum;
|
|
8
|
-
entityId: string;
|
|
9
|
-
entityName?: string;
|
|
10
|
-
businessAreaId?: string;
|
|
11
|
-
visitAt?: number;
|
|
12
|
-
visits?: number;
|
|
13
|
-
story?: IStory;
|
|
14
|
-
model?: ISemanticModel;
|
|
15
|
-
indicator?: IIndicator;
|
|
16
|
-
}
|
|
17
|
-
export declare enum VisitEntityEnum {
|
|
18
|
-
DataSource = "DataSource",
|
|
19
|
-
SemanticModel = "SemanticModel",
|
|
20
|
-
Story = "Story",
|
|
21
|
-
Widget = "Widget",
|
|
22
|
-
Indicator = "Indicator"
|
|
23
|
-
}
|
|
24
|
-
export declare enum VisitTypeEnum {
|
|
25
|
-
View = "View",
|
|
26
|
-
Data = "Data"
|
|
27
|
-
}
|
|
28
|
-
export interface IEntityVisits {
|
|
29
|
-
entity?: VisitEntityEnum;
|
|
30
|
-
entityId: string;
|
|
31
|
-
entityName: string;
|
|
32
|
-
pv?: number;
|
|
33
|
-
uv?: number;
|
|
34
|
-
}
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
import { ISemanticModel } from "./semantic-model";
|
|
2
|
-
export interface AgentEventRequest {
|
|
3
|
-
url?: string;
|
|
4
|
-
headers: {
|
|
5
|
-
[key: string]: string[];
|
|
6
|
-
};
|
|
7
|
-
body?: any;
|
|
8
|
-
catalog?: string;
|
|
9
|
-
table?: string;
|
|
10
|
-
forceRefresh?: boolean;
|
|
11
|
-
auth?: {
|
|
12
|
-
username: string;
|
|
13
|
-
password: string;
|
|
14
|
-
};
|
|
15
|
-
}
|
|
16
|
-
export interface AgentEventResponse extends AgentEventRequest {
|
|
17
|
-
status: number;
|
|
18
|
-
statusText: string;
|
|
19
|
-
}
|
|
20
|
-
export declare enum AgentEventType {
|
|
21
|
-
request = "request",
|
|
22
|
-
response = "response",
|
|
23
|
-
error = "error"
|
|
24
|
-
}
|
|
25
|
-
export interface AgentEvent {
|
|
26
|
-
type?: 'connected';
|
|
27
|
-
id: string;
|
|
28
|
-
event: AgentEventType;
|
|
29
|
-
data: {
|
|
30
|
-
organizationId?: string;
|
|
31
|
-
dataSource?: {
|
|
32
|
-
id: string;
|
|
33
|
-
name: string;
|
|
34
|
-
type: string;
|
|
35
|
-
updatedAt?: Date;
|
|
36
|
-
};
|
|
37
|
-
modelId?: string;
|
|
38
|
-
semanticModel?: ISemanticModel;
|
|
39
|
-
request: AgentEventRequest;
|
|
40
|
-
response?: AgentEventResponse;
|
|
41
|
-
error?: string;
|
|
42
|
-
};
|
|
43
|
-
}
|
|
44
|
-
export declare enum LocalAgentType {
|
|
45
|
-
TENANT = 0,
|
|
46
|
-
USER = 1
|
|
47
|
-
}
|
|
48
|
-
export declare const TENANT_AGENT_LOCAL_URL = "agent-local-url";
|
package/src/api-key.model.d.ts
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
|
|
2
|
-
export interface IApiKey extends IBasePerTenantAndOrganizationEntityModel {
|
|
3
|
-
token: string;
|
|
4
|
-
name?: string;
|
|
5
|
-
type?: string;
|
|
6
|
-
entityId?: string;
|
|
7
|
-
validUntil?: Date;
|
|
8
|
-
expired?: boolean;
|
|
9
|
-
lastUsedAt?: Date;
|
|
10
|
-
}
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
import { ITenant } from './tenant.model';
|
|
2
|
-
import { IOrganization } from './organization.model';
|
|
3
|
-
import { ID } from './types';
|
|
4
|
-
import { IUser } from './user.model';
|
|
5
|
-
export interface IBaseRelationsEntityModel {
|
|
6
|
-
relations?: string[];
|
|
7
|
-
}
|
|
8
|
-
export interface IBaseSoftDeleteEntityModel {
|
|
9
|
-
deletedAt?: Date;
|
|
10
|
-
}
|
|
11
|
-
export interface IBaseEntityModel extends IBaseSoftDeleteEntityModel {
|
|
12
|
-
id?: ID;
|
|
13
|
-
createdById?: ID;
|
|
14
|
-
createdBy?: IUser;
|
|
15
|
-
updatedById?: ID;
|
|
16
|
-
updatedBy?: IUser;
|
|
17
|
-
readonly createdAt?: Date;
|
|
18
|
-
readonly updatedAt?: Date;
|
|
19
|
-
}
|
|
20
|
-
export interface IBasePerTenantEntityModel extends IBaseEntityModel {
|
|
21
|
-
tenantId?: string;
|
|
22
|
-
tenant?: ITenant;
|
|
23
|
-
}
|
|
24
|
-
export interface IBasePerTenantAndOrganizationEntityModel extends IBasePerTenantEntityModel {
|
|
25
|
-
organizationId?: string;
|
|
26
|
-
organization?: IOrganization;
|
|
27
|
-
}
|
package/src/contact.model.d.ts
DELETED
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
import { IOrganizationContact } from './organization-contact.model';
|
|
2
|
-
import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
|
|
3
|
-
import { IEmployee } from './employee.model';
|
|
4
|
-
export interface IContact extends IBasePerTenantAndOrganizationEntityModel {
|
|
5
|
-
id?: string;
|
|
6
|
-
name?: string;
|
|
7
|
-
firstName?: string;
|
|
8
|
-
lastName?: string;
|
|
9
|
-
country?: string;
|
|
10
|
-
city?: string;
|
|
11
|
-
address?: string;
|
|
12
|
-
address2?: string;
|
|
13
|
-
postcode?: string;
|
|
14
|
-
latitude?: number;
|
|
15
|
-
longitude?: number;
|
|
16
|
-
regionCode?: string;
|
|
17
|
-
fax?: string;
|
|
18
|
-
fiscalInformation?: string;
|
|
19
|
-
website?: string;
|
|
20
|
-
organization_contacts?: IOrganizationContact[];
|
|
21
|
-
employees?: IEmployee[];
|
|
22
|
-
}
|
|
23
|
-
export interface IContactFindInput extends IContactCreateInput {
|
|
24
|
-
id?: string;
|
|
25
|
-
}
|
|
26
|
-
export interface IContactCreateInput extends IBasePerTenantAndOrganizationEntityModel {
|
|
27
|
-
name?: string;
|
|
28
|
-
firstName?: string;
|
|
29
|
-
lastName?: string;
|
|
30
|
-
country?: string;
|
|
31
|
-
city?: string;
|
|
32
|
-
address?: string;
|
|
33
|
-
address2?: string;
|
|
34
|
-
postcode?: string;
|
|
35
|
-
latitude?: number;
|
|
36
|
-
longitude?: number;
|
|
37
|
-
regionCode?: string;
|
|
38
|
-
fax?: string;
|
|
39
|
-
fiscalInformation?: string;
|
|
40
|
-
website?: string;
|
|
41
|
-
}
|
package/src/core.model.d.ts
DELETED
|
@@ -1,97 +0,0 @@
|
|
|
1
|
-
export interface IPaginationInput {
|
|
2
|
-
limit?: number;
|
|
3
|
-
page?: number;
|
|
4
|
-
}
|
|
5
|
-
/**
|
|
6
|
-
* Generic pagination interface
|
|
7
|
-
*/
|
|
8
|
-
export interface IPagination<T> {
|
|
9
|
-
/**
|
|
10
|
-
* Items included in the current listing
|
|
11
|
-
*/
|
|
12
|
-
readonly items: T[];
|
|
13
|
-
/**
|
|
14
|
-
* Total number of available items
|
|
15
|
-
*/
|
|
16
|
-
readonly total: number;
|
|
17
|
-
}
|
|
18
|
-
export interface IListQueryInput<T> {
|
|
19
|
-
/**
|
|
20
|
-
* Model entity defined relations
|
|
21
|
-
*/
|
|
22
|
-
readonly relations?: string[];
|
|
23
|
-
readonly findInput?: T | any;
|
|
24
|
-
readonly where?: any;
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* Describes generic pagination params
|
|
28
|
-
*/
|
|
29
|
-
export interface IPaginationParam extends IOptionParams {
|
|
30
|
-
/**
|
|
31
|
-
* Limit (paginated) - max number of entities should be taken.
|
|
32
|
-
*/
|
|
33
|
-
readonly take?: number;
|
|
34
|
-
/**
|
|
35
|
-
* Offset (paginated) where from entities should be taken.
|
|
36
|
-
*/
|
|
37
|
-
readonly skip?: number;
|
|
38
|
-
}
|
|
39
|
-
export interface IOptionParams {
|
|
40
|
-
/**
|
|
41
|
-
* Order, in which entities should be ordered.
|
|
42
|
-
*/
|
|
43
|
-
readonly order?: Record<string, any>;
|
|
44
|
-
/**
|
|
45
|
-
* Simple condition that should be applied to match entities.
|
|
46
|
-
*/
|
|
47
|
-
readonly where: Record<string, any>;
|
|
48
|
-
/**
|
|
49
|
-
* Indicates if soft-deleted rows should be included in entity result.
|
|
50
|
-
*/
|
|
51
|
-
readonly withDeleted?: boolean;
|
|
52
|
-
}
|
|
53
|
-
export declare enum OrderTypeEnum {
|
|
54
|
-
DESC = "DESC",
|
|
55
|
-
ASC = "ASC"
|
|
56
|
-
}
|
|
57
|
-
export type JSONValue = null | string | number | boolean | {
|
|
58
|
-
[x: string]: JSONValue;
|
|
59
|
-
} | Array<JSONValue>;
|
|
60
|
-
export type WhereOperator<T> = {
|
|
61
|
-
$eq?: T;
|
|
62
|
-
} | {
|
|
63
|
-
$ne?: T;
|
|
64
|
-
} | {
|
|
65
|
-
$in?: T[];
|
|
66
|
-
} | {
|
|
67
|
-
$notIn?: T[];
|
|
68
|
-
} | {
|
|
69
|
-
$like?: string;
|
|
70
|
-
} | {
|
|
71
|
-
$ilike?: string;
|
|
72
|
-
} | {
|
|
73
|
-
$gt?: T;
|
|
74
|
-
} | {
|
|
75
|
-
$gte?: T;
|
|
76
|
-
} | {
|
|
77
|
-
$lt?: T;
|
|
78
|
-
} | {
|
|
79
|
-
$lte?: T;
|
|
80
|
-
} | {
|
|
81
|
-
$isNull?: boolean;
|
|
82
|
-
};
|
|
83
|
-
export type SmartWhere<T> = Partial<{
|
|
84
|
-
[P in keyof T]?: T[P] | WhereOperator<T[P]>;
|
|
85
|
-
}>;
|
|
86
|
-
export type PaginationParams<T> = {
|
|
87
|
-
select?: (keyof T)[] | {
|
|
88
|
-
[P in keyof T]?: P extends "toString" ? unknown : NonNullable<T[P]>;
|
|
89
|
-
};
|
|
90
|
-
take?: number;
|
|
91
|
-
skip?: number;
|
|
92
|
-
where?: SmartWhere<T>;
|
|
93
|
-
relations?: string[];
|
|
94
|
-
order?: Partial<{
|
|
95
|
-
[P in keyof T]: OrderTypeEnum;
|
|
96
|
-
}>;
|
|
97
|
-
};
|