@clairejs/server 3.4.0 → 3.5.2

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.
Files changed (87) hide show
  1. package/.prettierrc +8 -8
  2. package/README.md +654 -643
  3. package/dist/common/FileOperation.d.ts +5 -5
  4. package/dist/common/ServerModelMetadata.d.ts +10 -10
  5. package/dist/common/auth/AbstractPrincipalResolver.d.ts +4 -4
  6. package/dist/common/auth/IPrincipal.d.ts +4 -4
  7. package/dist/common/constants.d.ts +1 -1
  8. package/dist/common/request/EndpointMetadata.d.ts +40 -40
  9. package/dist/common/request/HttpData.d.ts +1 -1
  10. package/dist/common/request/HttpEndpoint.d.ts +8 -8
  11. package/dist/common/request/JobData.d.ts +1 -1
  12. package/dist/common/request/MountedEndpointInfo.d.ts +6 -6
  13. package/dist/common/request/RequestOptions.d.ts +6 -6
  14. package/dist/common/request/SocketData.d.ts +1 -1
  15. package/dist/common/request/types.d.ts +1 -1
  16. package/dist/database/QueryOperator.d.ts +15 -15
  17. package/dist/database/adapter/AbstractDatabaseAdapter.d.ts +20 -20
  18. package/dist/database/adapter/AbstractQuery.d.ts +53 -53
  19. package/dist/database/adapter/DefaultSqlDatabaseAdapter.d.ts +17 -17
  20. package/dist/database/adapter/IQuery.d.ts +77 -77
  21. package/dist/database/adapter/IQueryProvider.d.ts +9 -9
  22. package/dist/database/adapter/aggregators.d.ts +21 -21
  23. package/dist/database/adapter/providers.d.ts +8 -8
  24. package/dist/database/decorators.d.ts +2 -2
  25. package/dist/database/migrator/AbstractDatabaseMigrator.d.ts +4 -4
  26. package/dist/database/migrator/DefaultSqlDatabaseMigrator.d.ts +27 -27
  27. package/dist/database/transaction/ITransaction.d.ts +10 -10
  28. package/dist/database/transaction/ITransactionFactory.d.ts +4 -4
  29. package/dist/database/transaction/ITransactionProvider.d.ts +4 -4
  30. package/dist/database/transaction/TransactionLink.d.ts +14 -14
  31. package/dist/database/transaction/TransactionObjectMetadata.d.ts +4 -4
  32. package/dist/database/transaction/TransactionState.d.ts +5 -5
  33. package/dist/database/util/transaction-provider.d.ts +1 -1
  34. package/dist/http/auth/AbstractHttpAuthorizationProvider.d.ts +9 -9
  35. package/dist/http/auth/AbstractRbacAuthProvider.d.ts +18 -18
  36. package/dist/http/auth/RedisRbacAuthProvider.d.ts +23 -23
  37. package/dist/http/auth/SocketRbacAuthProvider.d.ts +25 -25
  38. package/dist/http/auth/rbac.d.ts +34 -34
  39. package/dist/http/common/HttpRequest.d.ts +37 -37
  40. package/dist/http/common/HttpResponse.d.ts +25 -25
  41. package/dist/http/controller/AbstractHttpController.d.ts +10 -10
  42. package/dist/http/controller/AbstractHttpMiddleware.d.ts +5 -5
  43. package/dist/http/controller/AbstractHttpRequestHandler.d.ts +16 -16
  44. package/dist/http/controller/ControllerMetadata.d.ts +6 -6
  45. package/dist/http/controller/CrudHttpController.d.ts +56 -56
  46. package/dist/http/controller/DefaultHttpRequestHandler.d.ts +19 -19
  47. package/dist/http/decorators.d.ts +32 -32
  48. package/dist/http/file-upload/AbstractFileUploadHandler.d.ts +6 -6
  49. package/dist/http/file-upload/FileUploadHandler.d.ts +10 -10
  50. package/dist/http/file-upload/types.d.ts +3 -3
  51. package/dist/http/repository/AbstractRepository.d.ts +10 -10
  52. package/dist/http/repository/DtoRepository.d.ts +60 -60
  53. package/dist/http/repository/ICrudRepository.d.ts +29 -29
  54. package/dist/http/repository/ModelRepository.d.ts +39 -39
  55. package/dist/http/security/AbstractAccessCondition.d.ts +7 -7
  56. package/dist/http/security/access-conditions/DtoFieldValidation.d.ts +4 -4
  57. package/dist/http/security/access-conditions/FilterModelFieldAccessCondition.d.ts +4 -4
  58. package/dist/http/security/access-conditions/MaximumQueryLimit.d.ts +8 -8
  59. package/dist/index.d.ts +70 -69
  60. package/dist/index.js +1 -1
  61. package/dist/job/AbstractJobController.d.ts +4 -4
  62. package/dist/job/AbstractJobExecutor.d.ts +10 -4
  63. package/dist/job/AbstractJobScheduler.d.ts +8 -9
  64. package/dist/job/AwsJobExecutor.d.ts +8 -5
  65. package/dist/job/AwsJobScheduler.d.ts +5 -0
  66. package/dist/job/LocalJobExecutor.d.ts +8 -5
  67. package/dist/job/LocalJobScheduler.d.ts +21 -14
  68. package/dist/job/decorators.d.ts +4 -3
  69. package/dist/job/interfaces.d.ts +16 -16
  70. package/dist/logging/FileLogMedium.d.ts +13 -13
  71. package/dist/service/AbstractCacheService.d.ts +22 -22
  72. package/dist/service/AbstractFileService.d.ts +8 -8
  73. package/dist/service/AbstractService.d.ts +8 -8
  74. package/dist/socket/AbstractServerSocket.d.ts +19 -19
  75. package/dist/socket/AbstractServerSocketManager.d.ts +44 -42
  76. package/dist/socket/AbstractSocketConnectionHandler.d.ts +6 -6
  77. package/dist/socket/AbstractSocketController.d.ts +14 -14
  78. package/dist/socket/AwsSocketManager.d.ts +31 -34
  79. package/dist/socket/IServerSocket.d.ts +16 -16
  80. package/dist/socket/LocalSocketManager.d.ts +48 -42
  81. package/dist/system/ClaireServer.d.ts +13 -13
  82. package/dist/system/ExpressWrapper.d.ts +17 -17
  83. package/dist/system/LambdaWrapper.d.ts +19 -19
  84. package/dist/system/ServerGlobalStore.d.ts +5 -5
  85. package/dist/system/errors.d.ts +14 -14
  86. package/dist/system/lamba-request-mapper.d.ts +12 -12
  87. package/package.json +61 -61
@@ -1,5 +1,5 @@
1
- export declare enum FileOperation {
2
- GET = "getObject",
3
- PUT = "putObject",
4
- DELETE = "deleteObject"
5
- }
1
+ export declare enum FileOperation {
2
+ GET = "getObject",
3
+ PUT = "putObject",
4
+ DELETE = "deleteObject"
5
+ }
@@ -1,10 +1,10 @@
1
- import { ModelFieldMetadata, ModelMetadata } from "@clairejs/core";
2
- import { IPrincipal } from "./auth/IPrincipal";
3
- import { UriMapperHandler } from "../http/file-upload/types";
4
- export interface ServerModelFieldMetadata extends ModelFieldMetadata {
5
- uriMapper?: UriMapperHandler<any>;
6
- userResolver?: (principal: IPrincipal) => any;
7
- }
8
- export interface ServerModelMetadata extends ModelMetadata {
9
- fields: ServerModelFieldMetadata[];
10
- }
1
+ import { ModelFieldMetadata, ModelMetadata } from "@clairejs/core";
2
+ import { IPrincipal } from "./auth/IPrincipal";
3
+ import { UriMapperHandler } from "../http/file-upload/types";
4
+ export interface ServerModelFieldMetadata extends ModelFieldMetadata {
5
+ uriMapper?: UriMapperHandler<any>;
6
+ userResolver?: (principal: IPrincipal) => any;
7
+ }
8
+ export interface ServerModelMetadata extends ModelMetadata {
9
+ fields: ServerModelFieldMetadata[];
10
+ }
@@ -1,4 +1,4 @@
1
- import { IPrincipal } from "./IPrincipal";
2
- export declare abstract class AbstractPrincipalResolver<T extends IPrincipal = IPrincipal> {
3
- abstract resolvePrincipal(authData?: any): Promise<T | undefined>;
4
- }
1
+ import { IPrincipal } from "./IPrincipal";
2
+ export declare abstract class AbstractPrincipalResolver<T extends IPrincipal = IPrincipal> {
3
+ abstract resolvePrincipal(authData?: any): Promise<T | undefined>;
4
+ }
@@ -1,4 +1,4 @@
1
- export interface IPrincipal {
2
- id: any;
3
- hasTfa?: boolean;
4
- }
1
+ export interface IPrincipal {
2
+ id: any;
3
+ hasTfa?: boolean;
4
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,40 +1,40 @@
1
- import { Constructor, DtoMetadata, HttpMethod, SocketMethod, ObjectFieldMetadata } from "@clairejs/core";
2
- import { RequestDataSource } from "./types";
3
- import { AbstractAccessCondition } from "../../http/security/AbstractAccessCondition";
4
- export interface EndpointMetadata extends ObjectFieldMetadata {
5
- /**
6
- * Basic HTTP information, name property is handler function name.
7
- */
8
- httpMethod: HttpMethod | SocketMethod;
9
- url: string;
10
- /**
11
- * User-friendly display name of endpoint.
12
- */
13
- displayName?: string;
14
- bodyValidationDto?: DtoMetadata;
15
- queriesValidationDto?: DtoMetadata;
16
- paramsValidationDto?: DtoMetadata;
17
- responseValidationDto?: DtoMetadata;
18
- params?: {
19
- [index: number]: {
20
- source?: RequestDataSource;
21
- diClass?: Constructor<any>;
22
- };
23
- };
24
- /**
25
- * This endpoint requires tfa
26
- */
27
- tfaRequired?: boolean;
28
- /**
29
- * Allow public access to this endpoint.
30
- */
31
- openAccess?: boolean;
32
- /**
33
- * Metadata of access condition to allow a conditional access to the endpoint.
34
- */
35
- accessConditions?: Constructor<AbstractAccessCondition>[];
36
- /**
37
- * Group of permission of this endpoint.
38
- */
39
- permissionGroup?: string;
40
- }
1
+ import { Constructor, DtoMetadata, HttpMethod, SocketMethod, ObjectFieldMetadata } from "@clairejs/core";
2
+ import { RequestDataSource } from "./types";
3
+ import { AbstractAccessCondition } from "../../http/security/AbstractAccessCondition";
4
+ export interface EndpointMetadata extends ObjectFieldMetadata {
5
+ /**
6
+ * Basic HTTP information, name property is handler function name.
7
+ */
8
+ httpMethod: HttpMethod | SocketMethod;
9
+ url: string;
10
+ /**
11
+ * User-friendly display name of endpoint.
12
+ */
13
+ displayName?: string;
14
+ bodyValidationDto?: DtoMetadata;
15
+ queriesValidationDto?: DtoMetadata;
16
+ paramsValidationDto?: DtoMetadata;
17
+ responseValidationDto?: DtoMetadata;
18
+ params?: {
19
+ [index: number]: {
20
+ source?: RequestDataSource;
21
+ diClass?: Constructor<any>;
22
+ };
23
+ };
24
+ /**
25
+ * This endpoint requires tfa
26
+ */
27
+ tfaRequired?: boolean;
28
+ /**
29
+ * Allow public access to this endpoint.
30
+ */
31
+ openAccess?: boolean;
32
+ /**
33
+ * Metadata of access condition to allow a conditional access to the endpoint.
34
+ */
35
+ accessConditions?: Constructor<AbstractAccessCondition>[];
36
+ /**
37
+ * Group of permission of this endpoint.
38
+ */
39
+ permissionGroup?: string;
40
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,8 +1,8 @@
1
- import { HttpMethod, SocketMethod } from "@clairejs/core";
2
- export declare const getEndpointId: (endpoint: HttpEndpoint) => string;
3
- export interface HttpEndpoint {
4
- mount?: string;
5
- httpMethod?: HttpMethod | SocketMethod;
6
- controller: any;
7
- handlerFunctionName: string;
8
- }
1
+ import { HttpMethod, SocketMethod } from "@clairejs/core";
2
+ export declare const getEndpointId: (endpoint: HttpEndpoint) => string;
3
+ export interface HttpEndpoint {
4
+ mount?: string;
5
+ httpMethod?: HttpMethod | SocketMethod;
6
+ controller: any;
7
+ handlerFunctionName: string;
8
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1,6 +1,6 @@
1
- import { EndpointMetadata } from "./EndpointMetadata";
2
- import { HttpEndpoint } from "./HttpEndpoint";
3
- export interface MountedEndpointInfo {
4
- endpointMetadata: EndpointMetadata;
5
- endpoint: HttpEndpoint;
6
- }
1
+ import { EndpointMetadata } from "./EndpointMetadata";
2
+ import { HttpEndpoint } from "./HttpEndpoint";
3
+ export interface MountedEndpointInfo {
4
+ endpointMetadata: EndpointMetadata;
5
+ endpoint: HttpEndpoint;
6
+ }
@@ -1,6 +1,6 @@
1
- export interface RequestOptions {
2
- method: string;
3
- rawPath: string;
4
- headers?: any;
5
- body?: any;
6
- }
1
+ export interface RequestOptions {
2
+ method: string;
3
+ rawPath: string;
4
+ headers?: any;
5
+ body?: any;
6
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {};
@@ -1 +1 @@
1
- export declare type RequestDataSource = "body" | "params" | "queries" | "headers" | "socket" | "raw";
1
+ export declare type RequestDataSource = "body" | "params" | "queries" | "headers" | "socket" | "raw";
@@ -1,15 +1,15 @@
1
- export declare type MultiOperandOps = "_and" | "_or";
2
- export declare type Op = "_eq" | "_neq" | "_in"
3
- /**
4
- * Does not belong to array
5
- */
6
- | "_nin" | "_sub" | "_isub" | "_usub" | "_iusub" | "_regex" | "_gt" | "_lt" | "_gte" | "_lte" | MultiOperandOps;
7
- export declare type SingleOperator<T> = {
8
- [key in Exclude<Op, MultiOperandOps>]?: {
9
- [name in keyof T]?: any;
10
- };
11
- };
12
- export declare type MultileOperator<T> = {
13
- [key in MultiOperandOps]?: (SingleOperator<T> | MultileOperator<T>)[];
14
- };
15
- export declare type QueryCondition<T> = SingleOperator<T> | MultileOperator<T>;
1
+ export declare type MultiOperandOps = "_and" | "_or";
2
+ export declare type Op = "_eq" | "_neq" | "_in"
3
+ /**
4
+ * Does not belong to array
5
+ */
6
+ | "_nin" | "_sub" | "_isub" | "_usub" | "_iusub" | "_regex" | "_gt" | "_lt" | "_gte" | "_lte" | MultiOperandOps;
7
+ export declare type SingleOperator<T> = {
8
+ [key in Exclude<Op, MultiOperandOps>]?: {
9
+ [name in keyof T]?: any;
10
+ };
11
+ };
12
+ export declare type MultileOperator<T> = {
13
+ [key in MultiOperandOps]?: (SingleOperator<T> | MultileOperator<T>)[];
14
+ };
15
+ export declare type QueryCondition<T> = SingleOperator<T> | MultileOperator<T>;
@@ -1,20 +1,20 @@
1
- import { ModelMetadata, AbstractModel, IInit, Constructor } from "@clairejs/core";
2
- import { IQueryProvider } from "./IQueryProvider";
3
- import { IQuery } from "./IQuery";
4
- import { ITransaction } from "../transaction/ITransaction";
5
- import { ITransactionFactory } from "../transaction/ITransactionFactory";
6
- export declare type ConnectionHolder<T> = {
7
- connection: T;
8
- };
9
- export declare abstract class AbstractDatabaseAdapter implements IInit, IQueryProvider, ITransactionFactory {
10
- protected modelMetadata: ModelMetadata[];
11
- protected models: Constructor<AbstractModel>[];
12
- protected modelConnections: {
13
- [key: string]: ConnectionHolder<any>;
14
- };
15
- protected constructor();
16
- abstract createTransaction(): Promise<ITransaction>;
17
- abstract use<T extends AbstractModel>(model: Constructor<T>): IQuery<T>;
18
- init(): Promise<void>;
19
- exit(): void;
20
- }
1
+ import { ModelMetadata, AbstractModel, IInit, Constructor } from "@clairejs/core";
2
+ import { IQueryProvider } from "./IQueryProvider";
3
+ import { IQuery } from "./IQuery";
4
+ import { ITransaction } from "../transaction/ITransaction";
5
+ import { ITransactionFactory } from "../transaction/ITransactionFactory";
6
+ export declare type ConnectionHolder<T> = {
7
+ connection: T;
8
+ };
9
+ export declare abstract class AbstractDatabaseAdapter implements IInit, IQueryProvider, ITransactionFactory {
10
+ protected modelMetadata: ModelMetadata[];
11
+ protected models: Constructor<AbstractModel>[];
12
+ protected modelConnections: {
13
+ [key: string]: ConnectionHolder<any>;
14
+ };
15
+ protected constructor();
16
+ abstract createTransaction(): Promise<ITransaction>;
17
+ abstract use<T extends AbstractModel>(model: Constructor<T>): IQuery<T>;
18
+ init(): Promise<void>;
19
+ exit(): void;
20
+ }
@@ -1,53 +1,53 @@
1
- import { AbstractModel, ModelMetadata, Constructor } from "@clairejs/core";
2
- import { QueryCondition } from "../QueryOperator";
3
- import { IGroupBy, IJoin, IQuery, ISelect, IWhere, JoinMode, OrderDirective } from "./IQuery";
4
- export declare abstract class AbstractQuery<T extends AbstractModel> implements IQuery<T> {
5
- readonly metadata: ModelMetadata;
6
- readonly model: Constructor<T>;
7
- protected constructor(model: Constructor<AbstractModel>);
8
- abstract join<K extends AbstractModel>(model: Constructor<K>, leftField: keyof T, rightField: keyof K, joinMode?: JoinMode): IJoin<T & K> & IWhere<T & K> & IGroupBy<T & K> & ISelect<T & K>;
9
- abstract getById<K extends keyof T>(id: number, options?: {
10
- projection?: K[];
11
- }): Promise<Pick<T, K> | undefined>;
12
- abstract getByIds<K extends keyof T>(ids: number[], options?: {
13
- projection?: K[];
14
- }): Promise<Pick<T, K>[]>;
15
- abstract getOne<K extends keyof T>(queries?: QueryCondition<T>, options?: {
16
- projection?: K[];
17
- }): Promise<Pick<T, K> | undefined>;
18
- abstract getMany<K extends keyof T>(queries?: QueryCondition<T>, options?: {
19
- order?: OrderDirective<T>;
20
- projection?: K[];
21
- limit?: number;
22
- page?: number;
23
- }, includes?: {
24
- modelId: string;
25
- queries: QueryCondition<any>;
26
- }[]): Promise<{
27
- total: number;
28
- records: Pick<T, K>[];
29
- }>;
30
- abstract getRecords<K extends keyof T>(queries?: QueryCondition<T>, options?: {
31
- order?: OrderDirective<T>;
32
- projection?: K[];
33
- limit?: number;
34
- }, includes?: {
35
- modelId: string;
36
- queries: QueryCondition<any>;
37
- }[]): Promise<Pick<T, K>[]>;
38
- abstract createOne(modelInstance: Partial<T>): Promise<T>;
39
- abstract count(queries?: QueryCondition<T>, options?: {
40
- distinct?: keyof T;
41
- }, includes?: {
42
- modelId: string;
43
- queries: QueryCondition<any>;
44
- }[]): Promise<number>;
45
- abstract createMany(modelInstances: Partial<T>[]): Promise<T[]>;
46
- abstract updateOne(modelInstance: T): Promise<T>;
47
- abstract updateMany(queries: QueryCondition<T>, update: Partial<T>, returning?: boolean): Promise<number[]>;
48
- abstract deleteOne(modelInstance: T): Promise<T>;
49
- abstract deleteMany(queries: QueryCondition<T>, returning?: boolean): Promise<T[]>;
50
- abstract rawQuery(...args: any[]): Promise<any>;
51
- protected convertToLogicObjects<K extends keyof T>(dataObjects: T[], projection?: K[]): Pick<T, K>[];
52
- protected convertToDataObjects(modelInstances: Partial<T>[], forUpdate?: boolean): any[];
53
- }
1
+ import { AbstractModel, ModelMetadata, Constructor } from "@clairejs/core";
2
+ import { QueryCondition } from "../QueryOperator";
3
+ import { IGroupBy, IJoin, IQuery, ISelect, IWhere, JoinMode, OrderDirective } from "./IQuery";
4
+ export declare abstract class AbstractQuery<T extends AbstractModel> implements IQuery<T> {
5
+ readonly metadata: ModelMetadata;
6
+ readonly model: Constructor<T>;
7
+ protected constructor(model: Constructor<AbstractModel>);
8
+ abstract join<K extends AbstractModel>(model: Constructor<K>, leftField: keyof T, rightField: keyof K, joinMode?: JoinMode): IJoin<T & K> & IWhere<T & K> & IGroupBy<T & K> & ISelect<T & K>;
9
+ abstract getById<K extends keyof T>(id: number, options?: {
10
+ projection?: K[];
11
+ }): Promise<Pick<T, K> | undefined>;
12
+ abstract getByIds<K extends keyof T>(ids: number[], options?: {
13
+ projection?: K[];
14
+ }): Promise<Pick<T, K>[]>;
15
+ abstract getOne<K extends keyof T>(queries?: QueryCondition<T>, options?: {
16
+ projection?: K[];
17
+ }): Promise<Pick<T, K> | undefined>;
18
+ abstract getMany<K extends keyof T>(queries?: QueryCondition<T>, options?: {
19
+ order?: OrderDirective<T>;
20
+ projection?: K[];
21
+ limit?: number;
22
+ page?: number;
23
+ }, includes?: {
24
+ modelId: string;
25
+ queries: QueryCondition<any>;
26
+ }[]): Promise<{
27
+ total: number;
28
+ records: Pick<T, K>[];
29
+ }>;
30
+ abstract getRecords<K extends keyof T>(queries?: QueryCondition<T>, options?: {
31
+ order?: OrderDirective<T>;
32
+ projection?: K[];
33
+ limit?: number;
34
+ }, includes?: {
35
+ modelId: string;
36
+ queries: QueryCondition<any>;
37
+ }[]): Promise<Pick<T, K>[]>;
38
+ abstract createOne(modelInstance: Partial<T>): Promise<T>;
39
+ abstract count(queries?: QueryCondition<T>, options?: {
40
+ distinct?: keyof T;
41
+ }, includes?: {
42
+ modelId: string;
43
+ queries: QueryCondition<any>;
44
+ }[]): Promise<number>;
45
+ abstract createMany(modelInstances: Partial<T>[]): Promise<T[]>;
46
+ abstract updateOne(modelInstance: T): Promise<T>;
47
+ abstract updateMany(queries: QueryCondition<T>, update: Partial<T>, returning?: boolean): Promise<number[]>;
48
+ abstract deleteOne(modelInstance: T): Promise<T>;
49
+ abstract deleteMany(queries: QueryCondition<T>, returning?: boolean): Promise<T[]>;
50
+ abstract rawQuery(...args: any[]): Promise<any>;
51
+ protected convertToLogicObjects<K extends keyof T>(dataObjects: T[], projection?: K[]): Pick<T, K>[];
52
+ protected convertToDataObjects(modelInstances: Partial<T>[], forUpdate?: boolean): any[];
53
+ }
@@ -1,17 +1,17 @@
1
- import { AbstractModel, AbstractLogger, Constructor } from "@clairejs/core";
2
- import { ITransaction } from "../transaction/ITransaction";
3
- import { AbstractDatabaseAdapter } from "./AbstractDatabaseAdapter";
4
- import { IQuery } from "./IQuery";
5
- import { SqlProvider } from "./providers";
6
- export declare class DefaultSqlDatabaseAdapter extends AbstractDatabaseAdapter {
7
- readonly logger: AbstractLogger;
8
- private readonly sqlProvider;
9
- private readonly dbConnection;
10
- private readonly modelAdapters;
11
- constructor(sqlProvider: SqlProvider, connectionString: string, logger: AbstractLogger);
12
- createTransaction(): Promise<ITransaction>;
13
- init(): Promise<void>;
14
- exit(): number;
15
- use<T extends AbstractModel>(model: Constructor<T>): IQuery<T>;
16
- private generateSchemaObject;
17
- }
1
+ import { AbstractModel, AbstractLogger, Constructor } from "@clairejs/core";
2
+ import { ITransaction } from "../transaction/ITransaction";
3
+ import { AbstractDatabaseAdapter } from "./AbstractDatabaseAdapter";
4
+ import { IQuery } from "./IQuery";
5
+ import { SqlProvider } from "./providers";
6
+ export declare class DefaultSqlDatabaseAdapter extends AbstractDatabaseAdapter {
7
+ readonly logger: AbstractLogger;
8
+ private readonly sqlProvider;
9
+ private readonly dbConnection;
10
+ private readonly modelAdapters;
11
+ constructor(sqlProvider: SqlProvider, connectionString: string, logger: AbstractLogger);
12
+ createTransaction(): Promise<ITransaction>;
13
+ init(): Promise<void>;
14
+ exit(): number;
15
+ use<T extends AbstractModel>(model: Constructor<T>): IQuery<T>;
16
+ private generateSchemaObject;
17
+ }
@@ -1,77 +1,77 @@
1
- import { AbstractModel, Constructor, OrderDirection } from "@clairejs/core";
2
- import { QueryCondition } from "../QueryOperator";
3
- import { Aggregator, HavingCondition } from "./aggregators";
4
- /**
5
- * Query condition based on a interface/class.
6
- */
7
- export declare type JoinMode = "inner" | "left" | "right";
8
- export declare type OrderDirective<K> = [keyof K, OrderDirection][] | "random";
9
- export interface ISelect<T> {
10
- count(): Promise<number>;
11
- rows<K>(mapping: {
12
- [field in keyof K]: Aggregator<T>;
13
- }, options?: {
14
- order?: OrderDirective<T>;
15
- limit?: number;
16
- page?: number;
17
- }): Promise<{
18
- total: number;
19
- records: K[];
20
- }>;
21
- }
22
- export interface IHaving<T> {
23
- having(conditions: HavingCondition<T>): ISelect<T>;
24
- }
25
- export interface IGroupBy<T> {
26
- groupBy(fields: (keyof T)[]): IHaving<T> & ISelect<T>;
27
- }
28
- export interface IWhere<T> {
29
- where(queries?: QueryCondition<T>): IGroupBy<T> & ISelect<T>;
30
- }
31
- export interface IJoin<T extends AbstractModel> {
32
- join<K extends AbstractModel>(model: Constructor<K>, leftField: keyof T, rightField: keyof K, joinMode?: JoinMode): IJoin<T & K> & IWhere<T & K> & IGroupBy<T & K> & ISelect<T & K>;
33
- }
34
- export interface IQuery<T extends AbstractModel> extends IJoin<T> {
35
- createOne(modelInstance: Partial<T>): Promise<T>;
36
- getById<K extends keyof T>(id: number, options?: {
37
- projection?: K[];
38
- }): Promise<Pick<T, K> | undefined>;
39
- getByIds<K extends keyof T>(ids: number[], options?: {
40
- projection?: K[];
41
- }): Promise<Pick<T, K>[]>;
42
- getOne<K extends keyof T>(queries?: QueryCondition<T>, options?: {
43
- projection?: K[];
44
- }): Promise<Pick<T, K> | undefined>;
45
- count(queries?: QueryCondition<T>, options?: {
46
- distinct?: keyof T;
47
- }, includes?: {
48
- modelId: string;
49
- queries: QueryCondition<any>;
50
- }[]): Promise<number>;
51
- getMany<K extends keyof T>(queries?: QueryCondition<T>, options?: {
52
- order?: OrderDirective<T>;
53
- projection?: K[];
54
- limit?: number;
55
- page?: number;
56
- }, includes?: {
57
- modelId: string;
58
- queries: QueryCondition<any>;
59
- }[]): Promise<{
60
- total: number;
61
- records: Pick<T, K>[];
62
- }>;
63
- getRecords<K extends keyof T>(queries?: QueryCondition<T>, options?: {
64
- order?: OrderDirective<T>;
65
- projection?: K[];
66
- limit?: number;
67
- }, includes?: {
68
- modelId: string;
69
- queries: QueryCondition<any>;
70
- }[]): Promise<Pick<T, K>[]>;
71
- createMany(modelInstances: Partial<T>[]): Promise<T[]>;
72
- updateOne(modelInstance: T): Promise<T>;
73
- updateMany(queries: QueryCondition<T> | undefined, update: Partial<T>, returning?: boolean): Promise<number[]>;
74
- deleteOne(modelInstance: T): Promise<T>;
75
- deleteMany(queries?: QueryCondition<T>, returning?: boolean): Promise<T[]>;
76
- rawQuery(...args: any[]): Promise<any>;
77
- }
1
+ import { AbstractModel, Constructor, OrderDirection } from "@clairejs/core";
2
+ import { QueryCondition } from "../QueryOperator";
3
+ import { Aggregator, HavingCondition } from "./aggregators";
4
+ /**
5
+ * Query condition based on a interface/class.
6
+ */
7
+ export declare type JoinMode = "inner" | "left" | "right";
8
+ export declare type OrderDirective<K> = [keyof K, OrderDirection][] | "random";
9
+ export interface ISelect<T> {
10
+ count(): Promise<number>;
11
+ rows<K>(mapping: {
12
+ [field in keyof K]: Aggregator<T>;
13
+ }, options?: {
14
+ order?: OrderDirective<T>;
15
+ limit?: number;
16
+ page?: number;
17
+ }): Promise<{
18
+ total: number;
19
+ records: K[];
20
+ }>;
21
+ }
22
+ export interface IHaving<T> {
23
+ having(conditions: HavingCondition<T>): ISelect<T>;
24
+ }
25
+ export interface IGroupBy<T> {
26
+ groupBy(fields: (keyof T)[]): IHaving<T> & ISelect<T>;
27
+ }
28
+ export interface IWhere<T> {
29
+ where(queries?: QueryCondition<T>): IGroupBy<T> & ISelect<T>;
30
+ }
31
+ export interface IJoin<T extends AbstractModel> {
32
+ join<K extends AbstractModel>(model: Constructor<K>, leftField: keyof T, rightField: keyof K, joinMode?: JoinMode): IJoin<T & K> & IWhere<T & K> & IGroupBy<T & K> & ISelect<T & K>;
33
+ }
34
+ export interface IQuery<T extends AbstractModel> extends IJoin<T> {
35
+ createOne(modelInstance: Partial<T>): Promise<T>;
36
+ getById<K extends keyof T>(id: number, options?: {
37
+ projection?: K[];
38
+ }): Promise<Pick<T, K> | undefined>;
39
+ getByIds<K extends keyof T>(ids: number[], options?: {
40
+ projection?: K[];
41
+ }): Promise<Pick<T, K>[]>;
42
+ getOne<K extends keyof T>(queries?: QueryCondition<T>, options?: {
43
+ projection?: K[];
44
+ }): Promise<Pick<T, K> | undefined>;
45
+ count(queries?: QueryCondition<T>, options?: {
46
+ distinct?: keyof T;
47
+ }, includes?: {
48
+ modelId: string;
49
+ queries: QueryCondition<any>;
50
+ }[]): Promise<number>;
51
+ getMany<K extends keyof T>(queries?: QueryCondition<T>, options?: {
52
+ order?: OrderDirective<T>;
53
+ projection?: K[];
54
+ limit?: number;
55
+ page?: number;
56
+ }, includes?: {
57
+ modelId: string;
58
+ queries: QueryCondition<any>;
59
+ }[]): Promise<{
60
+ total: number;
61
+ records: Pick<T, K>[];
62
+ }>;
63
+ getRecords<K extends keyof T>(queries?: QueryCondition<T>, options?: {
64
+ order?: OrderDirective<T>;
65
+ projection?: K[];
66
+ limit?: number;
67
+ }, includes?: {
68
+ modelId: string;
69
+ queries: QueryCondition<any>;
70
+ }[]): Promise<Pick<T, K>[]>;
71
+ createMany(modelInstances: Partial<T>[]): Promise<T[]>;
72
+ updateOne(modelInstance: T): Promise<T>;
73
+ updateMany(queries: QueryCondition<T> | undefined, update: Partial<T>, returning?: boolean): Promise<number[]>;
74
+ deleteOne(modelInstance: T): Promise<T>;
75
+ deleteMany(queries?: QueryCondition<T>, returning?: boolean): Promise<T[]>;
76
+ rawQuery(...args: any[]): Promise<any>;
77
+ }
@@ -1,9 +1,9 @@
1
- import { AbstractModel, Constructor } from "@clairejs/core";
2
- import { IQuery } from "./IQuery";
3
- export interface IQueryProvider {
4
- /**
5
- * Use a model to provide the query interface for this model.
6
- * @param model the model to get query interface
7
- */
8
- use<T extends AbstractModel>(model: Constructor<T>): IQuery<T>;
9
- }
1
+ import { AbstractModel, Constructor } from "@clairejs/core";
2
+ import { IQuery } from "./IQuery";
3
+ export interface IQueryProvider {
4
+ /**
5
+ * Use a model to provide the query interface for this model.
6
+ * @param model the model to get query interface
7
+ */
8
+ use<T extends AbstractModel>(model: Constructor<T>): IQuery<T>;
9
+ }
@@ -1,21 +1,21 @@
1
- import { MultiOperandOps, Op } from "../QueryOperator";
2
- export declare type AggregatorFn = "count" | "sum" | "avg" | "min" | "max" | "join" | "is";
3
- export interface Aggregator<T> {
4
- fn: AggregatorFn;
5
- field: keyof T;
6
- args?: any;
7
- }
8
- export declare type SingleHaving<T> = {
9
- [key in Exclude<Op, MultiOperandOps>]?: [Aggregator<T>, any];
10
- };
11
- export declare type MultileHaving<T> = {
12
- [key in MultiOperandOps]?: (SingleHaving<T> | MultileHaving<T>)[];
13
- };
14
- export declare type HavingCondition<T> = SingleHaving<T> | MultileHaving<T>;
15
- export declare const _count: <T>(field: keyof T, distinct?: boolean | undefined) => Aggregator<T>;
16
- export declare const _sum: <T>(field: keyof T) => Aggregator<T>;
17
- export declare const _avg: <T>(field: keyof T) => Aggregator<T>;
18
- export declare const _min: <T>(field: keyof T) => Aggregator<T>;
19
- export declare const _max: <T>(field: keyof T) => Aggregator<T>;
20
- export declare const _join: <T>(field: keyof T, symbol: string) => Aggregator<T>;
21
- export declare const _is: <T>(field: keyof T) => Aggregator<T>;
1
+ import { MultiOperandOps, Op } from "../QueryOperator";
2
+ export declare type AggregatorFn = "count" | "sum" | "avg" | "min" | "max" | "join" | "is";
3
+ export interface Aggregator<T> {
4
+ fn: AggregatorFn;
5
+ field: keyof T;
6
+ args?: any;
7
+ }
8
+ export declare type SingleHaving<T> = {
9
+ [key in Exclude<Op, MultiOperandOps>]?: [Aggregator<T>, any];
10
+ };
11
+ export declare type MultileHaving<T> = {
12
+ [key in MultiOperandOps]?: (SingleHaving<T> | MultileHaving<T>)[];
13
+ };
14
+ export declare type HavingCondition<T> = SingleHaving<T> | MultileHaving<T>;
15
+ export declare const _count: <T>(field: keyof T, distinct?: boolean | undefined) => Aggregator<T>;
16
+ export declare const _sum: <T>(field: keyof T) => Aggregator<T>;
17
+ export declare const _avg: <T>(field: keyof T) => Aggregator<T>;
18
+ export declare const _min: <T>(field: keyof T) => Aggregator<T>;
19
+ export declare const _max: <T>(field: keyof T) => Aggregator<T>;
20
+ export declare const _join: <T>(field: keyof T, symbol: string) => Aggregator<T>;
21
+ export declare const _is: <T>(field: keyof T) => Aggregator<T>;