@clairejs/server 3.12.13 → 3.13.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.
Files changed (87) hide show
  1. package/.prettierrc +8 -8
  2. package/README.md +834 -824
  3. package/dist/common/AbstractController.d.ts +3 -3
  4. package/dist/common/ControllerMetadata.d.ts +6 -6
  5. package/dist/common/FileOperation.d.ts +5 -5
  6. package/dist/common/ServerModelMetadata.d.ts +10 -10
  7. package/dist/common/Transactionable.d.ts +7 -7
  8. package/dist/common/auth/AbstractPrincipalResolver.d.ts +5 -4
  9. package/dist/common/auth/IPrincipal.d.ts +3 -4
  10. package/dist/common/constants.d.ts +1 -1
  11. package/dist/common/decorator.d.ts +5 -5
  12. package/dist/common/request/EndpointMetadata.d.ts +40 -40
  13. package/dist/common/request/HttpData.d.ts +1 -1
  14. package/dist/common/request/HttpEndpoint.d.ts +8 -8
  15. package/dist/common/request/JobData.d.ts +1 -1
  16. package/dist/common/request/MountedEndpointInfo.d.ts +6 -6
  17. package/dist/common/request/RequestOptions.d.ts +8 -8
  18. package/dist/common/request/SocketData.d.ts +1 -1
  19. package/dist/common/request/types.d.ts +1 -1
  20. package/dist/controllers/FileManageController.d.ts +14 -14
  21. package/dist/controllers/FileUploadController.d.ts +13 -13
  22. package/dist/controllers/dto/permissions.d.ts +20 -20
  23. package/dist/controllers/dto/system.d.ts +12 -12
  24. package/dist/controllers/dto/upload.d.ts +40 -40
  25. package/dist/http/auth/AbstractHttpAuthorizer.d.ts +6 -9
  26. package/dist/http/common/HttpRequest.d.ts +40 -40
  27. package/dist/http/common/HttpResponse.d.ts +34 -34
  28. package/dist/http/controller/AbstractHttpController.d.ts +8 -8
  29. package/dist/http/controller/AbstractHttpMiddleware.d.ts +10 -10
  30. package/dist/http/controller/AbstractHttpRequestHandler.d.ts +18 -18
  31. package/dist/http/controller/CrudHttpController.d.ts +41 -41
  32. package/dist/http/controller/DefaultHttpRequestHandler.d.ts +22 -21
  33. package/dist/http/decorators.d.ts +33 -33
  34. package/dist/http/file-upload/AbstractFileUploadHandler.d.ts +7 -7
  35. package/dist/http/file-upload/FileUploadHandler.d.ts +11 -11
  36. package/dist/http/file-upload/types.d.ts +1 -1
  37. package/dist/http/repository/AbstractRepository.d.ts +10 -10
  38. package/dist/http/repository/DtoRepository.d.ts +58 -58
  39. package/dist/http/repository/ICrudRepository.d.ts +27 -27
  40. package/dist/http/repository/ModelRepository.d.ts +37 -37
  41. package/dist/http/security/AbstractAccessCondition.d.ts +7 -7
  42. package/dist/http/security/access-conditions/DtoFieldValidation.d.ts +4 -4
  43. package/dist/http/security/access-conditions/FilterModelFieldAccessCondition.d.ts +4 -4
  44. package/dist/http/security/access-conditions/MaximumQueryLimit.d.ts +8 -8
  45. package/dist/http/security/cors.d.ts +6 -6
  46. package/dist/index.d.ts +69 -74
  47. package/dist/index.js +1 -1
  48. package/dist/job/AbstractJobController.d.ts +5 -5
  49. package/dist/job/AbstractJobRepository.d.ts +17 -17
  50. package/dist/job/AbstractJobScheduler.d.ts +38 -38
  51. package/dist/job/AwsJobScheduler.d.ts +48 -48
  52. package/dist/job/LocalJobScheduler.d.ts +88 -88
  53. package/dist/job/decorators.d.ts +5 -5
  54. package/dist/job/interfaces.d.ts +50 -50
  55. package/dist/logging/FileLogMedium.d.ts +13 -13
  56. package/dist/services/AbstractCacheService.d.ts +22 -22
  57. package/dist/services/AbstractFileService.d.ts +15 -15
  58. package/dist/services/AbstractMailService.d.ts +31 -31
  59. package/dist/services/AbstractService.d.ts +3 -3
  60. package/dist/services/AbstractSmsService.d.ts +12 -12
  61. package/dist/services/LocalFileService.d.ts +21 -21
  62. package/dist/services/ProxyFileService.d.ts +20 -20
  63. package/dist/services/RedisCacheService.d.ts +25 -25
  64. package/dist/services/S3FileService.d.ts +36 -36
  65. package/dist/services/SystemService.d.ts +12 -15
  66. package/dist/socket/AbstractServerSocket.d.ts +18 -18
  67. package/dist/socket/AbstractServerSocketManager.d.ts +47 -46
  68. package/dist/socket/AbstractSocketConnectionHandler.d.ts +6 -6
  69. package/dist/socket/AbstractSocketController.d.ts +14 -14
  70. package/dist/socket/AwsSocketManager.d.ts +30 -30
  71. package/dist/socket/IServerSocket.d.ts +16 -16
  72. package/dist/socket/LocalSocketManager.d.ts +48 -47
  73. package/dist/system/ClaireServer.d.ts +13 -13
  74. package/dist/system/ExpressWrapper.d.ts +19 -19
  75. package/dist/system/LambdaWrapper.d.ts +25 -25
  76. package/dist/system/ServerGlobalStore.d.ts +5 -5
  77. package/dist/system/errors.d.ts +13 -14
  78. package/dist/system/lamba-request-mapper.d.ts +2 -2
  79. package/dist/system/locale/LocaleEntry.d.ts +3 -3
  80. package/dist/system/locale/LocaleTranslation.d.ts +6 -6
  81. package/dist/system/locale/decorators.d.ts +2 -2
  82. package/package.json +67 -67
  83. package/dist/controllers/models/SystemSetting.d.ts +0 -5
  84. package/dist/http/auth/AbstractRbacHttpAuthorizer.d.ts +0 -18
  85. package/dist/http/auth/RedisRbacHttpAuthorizer.d.ts +0 -24
  86. package/dist/http/auth/SocketRbacHttpAuthorizer.d.ts +0 -25
  87. package/dist/http/auth/rbac.d.ts +0 -34
@@ -1,8 +1,8 @@
1
- import { ITransactionFactory } from "@clairejs/orm";
2
- import { AbstractController } from "../../common/AbstractController";
3
- import { EndpointMetadata } from "../../common/request/EndpointMetadata";
4
- export declare abstract class AbstractHttpController extends AbstractController {
5
- protected readonly databaseAdapter: ITransactionFactory;
6
- constructor(databaseAdapter: ITransactionFactory);
7
- getEndpointMetadata(): Readonly<EndpointMetadata>[];
8
- }
1
+ import { ITransactionFactory } from "@clairejs/orm";
2
+ import { AbstractController } from "../../common/AbstractController";
3
+ import { EndpointMetadata } from "../../common/request/EndpointMetadata";
4
+ export declare abstract class AbstractHttpController extends AbstractController {
5
+ protected readonly databaseAdapter: ITransactionFactory;
6
+ constructor(databaseAdapter: ITransactionFactory);
7
+ getEndpointMetadata(): Readonly<EndpointMetadata>[];
8
+ }
@@ -1,10 +1,10 @@
1
- import { HttpRequest } from "../common/HttpRequest";
2
- import { HttpResponse } from "../common/HttpResponse";
3
- export declare abstract class AbstractHttpMiddleware {
4
- /**
5
- * Return true to proceed to next middleware and controller, return false to immediately break and returning current response
6
- * @param request the http request
7
- * @param response the http response
8
- */
9
- abstract intercept(request: HttpRequest, response: HttpResponse<any>): Promise<boolean>;
10
- }
1
+ import { HttpRequest } from "../common/HttpRequest";
2
+ import { HttpResponse } from "../common/HttpResponse";
3
+ export declare abstract class AbstractHttpMiddleware {
4
+ /**
5
+ * Return true to proceed to next middleware and controller, return false to immediately break and returning current response
6
+ * @param request the http request
7
+ * @param response the http response
8
+ */
9
+ abstract intercept(request: HttpRequest, response: HttpResponse<any>): Promise<boolean>;
10
+ }
@@ -1,18 +1,18 @@
1
- import { AbstractLogger } from "@clairejs/core";
2
- import { HttpData } from "../../common/request/HttpData";
3
- import { MountedEndpointInfo } from "../../common/request/MountedEndpointInfo";
4
- import { HttpResponse } from "../common/HttpResponse";
5
- import { ControllerMetadata } from "../../common/ControllerMetadata";
6
- import { CorsConfig } from "../security/cors";
7
- import { AbstractHttpMiddleware } from "./AbstractHttpMiddleware";
8
- export declare abstract class AbstractHttpRequestHandler {
9
- readonly mountPoint: string;
10
- readonly logger: AbstractLogger;
11
- private mountedEndpointInfo?;
12
- corsConfig?: CorsConfig;
13
- constructor(mountPoint: string, logger: AbstractLogger);
14
- protected resolverMountPoint(controllerMetadata: ControllerMetadata, mappingUrls: string[]): string;
15
- getMountedEndpointInfo(): Promise<MountedEndpointInfo[]>;
16
- abstract getMiddleware(): Promise<AbstractHttpMiddleware[]>;
17
- abstract handle(httpData: HttpData): Promise<HttpResponse<any>>;
18
- }
1
+ import { AbstractLogger } from "@clairejs/core";
2
+ import { HttpData } from "../../common/request/HttpData";
3
+ import { MountedEndpointInfo } from "../../common/request/MountedEndpointInfo";
4
+ import { HttpResponse } from "../common/HttpResponse";
5
+ import { ControllerMetadata } from "../../common/ControllerMetadata";
6
+ import { CorsConfig } from "../security/cors";
7
+ import { AbstractHttpMiddleware } from "./AbstractHttpMiddleware";
8
+ export declare abstract class AbstractHttpRequestHandler {
9
+ readonly mountPoint: string;
10
+ readonly logger: AbstractLogger;
11
+ private mountedEndpointInfo?;
12
+ corsConfig?: CorsConfig;
13
+ constructor(mountPoint: string, logger: AbstractLogger);
14
+ protected resolverMountPoint(controllerMetadata: ControllerMetadata, mappingUrls: string[]): string;
15
+ getMountedEndpointInfo(): Promise<MountedEndpointInfo[]>;
16
+ abstract getMiddleware(): Promise<AbstractHttpMiddleware[]>;
17
+ abstract handle(httpData: HttpData): Promise<HttpResponse<any>>;
18
+ }
@@ -1,41 +1,41 @@
1
- import { DtoMetadata, CreateManyResponseBody, GetManyResponseBody, UpdateManyResponse, Identifiable, Constructor } from "@clairejs/core";
2
- import { IQueryProvider, ITransactionFactory } from "@clairejs/orm";
3
- import { HttpRequest } from "../common/HttpRequest";
4
- import { AbstractHttpController } from "./AbstractHttpController";
5
- import { EndpointMetadata } from "../../common/request/EndpointMetadata";
6
- import { HttpResponse } from "../common/HttpResponse";
7
- import { ICrudRepository } from "../repository/ICrudRepository";
8
- export declare class CrudHttpController<T extends Identifiable> extends AbstractHttpController {
9
- protected readonly model: Constructor<T>;
10
- protected readonly crudRepository: ICrudRepository<T>;
11
- protected readonly databaseAdapter: ITransactionFactory & IQueryProvider;
12
- protected readonly modelMetadata: DtoMetadata;
13
- private authProvider?;
14
- constructor(model: Constructor<T>, crudRepository: ICrudRepository<T>, databaseAdapter: ITransactionFactory & IQueryProvider);
15
- protected getMountedUrl(): string;
16
- private getAuthProvider;
17
- /**
18
- * This provides endpoint metadata for mounting /POST request.
19
- */
20
- private createManyEndpoinMetadata;
21
- /**
22
- * This provides endpoint metadata for mounting /GET request.
23
- */
24
- private getManyEndpointMetadata;
25
- /**
26
- * This provides endpoint metadata for mounting /PUT request.
27
- */
28
- private updateManyEndpoinMetadata;
29
- /**
30
- * This provides endpoint metadata for mounting /DELETE request.
31
- */
32
- private deleteManyEndpoinMetadata;
33
- /**
34
- * Handler functions
35
- */
36
- getEndpointMetadata(): Readonly<EndpointMetadata>[];
37
- protected createMany(req: HttpRequest): Promise<HttpResponse<CreateManyResponseBody<T>>>;
38
- protected getMany(req: HttpRequest): Promise<HttpResponse<GetManyResponseBody<T>>>;
39
- protected updateMany(req: HttpRequest): Promise<HttpResponse<UpdateManyResponse<T>>>;
40
- protected deleteMany(req: HttpRequest): Promise<HttpResponse<UpdateManyResponse<T>>>;
41
- }
1
+ import { DtoMetadata, CreateManyResponseBody, GetManyResponseBody, UpdateManyResponse, Identifiable, Constructor } from "@clairejs/core";
2
+ import { IQueryProvider, ITransactionFactory } from "@clairejs/orm";
3
+ import { HttpRequest } from "../common/HttpRequest";
4
+ import { AbstractHttpController } from "./AbstractHttpController";
5
+ import { EndpointMetadata } from "../../common/request/EndpointMetadata";
6
+ import { HttpResponse } from "../common/HttpResponse";
7
+ import { ICrudRepository } from "../repository/ICrudRepository";
8
+ export declare class CrudHttpController<T extends Identifiable> extends AbstractHttpController {
9
+ protected readonly model: Constructor<T>;
10
+ protected readonly crudRepository: ICrudRepository<T>;
11
+ protected readonly databaseAdapter: ITransactionFactory & IQueryProvider;
12
+ protected readonly modelMetadata: DtoMetadata;
13
+ private principalResolver?;
14
+ constructor(model: Constructor<T>, crudRepository: ICrudRepository<T>, databaseAdapter: ITransactionFactory & IQueryProvider);
15
+ protected getMountedUrl(): string;
16
+ private getAuthProvider;
17
+ /**
18
+ * This provides endpoint metadata for mounting /POST request.
19
+ */
20
+ private createManyEndpoinMetadata;
21
+ /**
22
+ * This provides endpoint metadata for mounting /GET request.
23
+ */
24
+ private getManyEndpointMetadata;
25
+ /**
26
+ * This provides endpoint metadata for mounting /PUT request.
27
+ */
28
+ private updateManyEndpoinMetadata;
29
+ /**
30
+ * This provides endpoint metadata for mounting /DELETE request.
31
+ */
32
+ private deleteManyEndpoinMetadata;
33
+ /**
34
+ * Handler functions
35
+ */
36
+ getEndpointMetadata(): Readonly<EndpointMetadata>[];
37
+ protected createMany(req: HttpRequest): Promise<HttpResponse<CreateManyResponseBody<T>>>;
38
+ protected getMany(req: HttpRequest): Promise<HttpResponse<GetManyResponseBody<T>>>;
39
+ protected updateMany(req: HttpRequest): Promise<HttpResponse<UpdateManyResponse<T>>>;
40
+ protected deleteMany(req: HttpRequest): Promise<HttpResponse<UpdateManyResponse<T>>>;
41
+ }
@@ -1,21 +1,22 @@
1
- import { AbstractLogger } from "@clairejs/core";
2
- import { HttpResponse } from "../common/HttpResponse";
3
- import { HttpRequest } from "../common/HttpRequest";
4
- import { AbstractHttpAuthorizer } from "../auth/AbstractHttpAuthorizer";
5
- import { MountedEndpointInfo } from "../../common/request/MountedEndpointInfo";
6
- import { AbstractHttpRequestHandler } from "./AbstractHttpRequestHandler";
7
- import { IPrincipal } from "../../common/auth/IPrincipal";
8
- import { HttpData } from "../../common/request/HttpData";
9
- import { AbstractHttpMiddleware } from "./AbstractHttpMiddleware";
10
- export declare class DefaultHttpRequestHandler extends AbstractHttpRequestHandler {
11
- readonly logger: AbstractLogger;
12
- readonly authorizationProvider: AbstractHttpAuthorizer<IPrincipal>;
13
- private _middleware;
14
- constructor(logger: AbstractLogger, authorizationProvider: AbstractHttpAuthorizer<IPrincipal>);
15
- protected accessControl(endpoint: MountedEndpointInfo, req: HttpRequest): Promise<void>;
16
- protected handleRequest(endpoint: MountedEndpointInfo, req: HttpRequest): Promise<HttpResponse<any>>;
17
- exit(): void;
18
- private getResponse;
19
- handle(httpData: HttpData): Promise<HttpResponse<any>>;
20
- getMiddleware(): Promise<AbstractHttpMiddleware[]>;
21
- }
1
+ import { AbstractLogger } from "@clairejs/core";
2
+ import { HttpResponse } from "../common/HttpResponse";
3
+ import { HttpRequest } from "../common/HttpRequest";
4
+ import { AbstractHttpAuthorizer } from "../auth/AbstractHttpAuthorizer";
5
+ import { MountedEndpointInfo } from "../../common/request/MountedEndpointInfo";
6
+ import { AbstractHttpRequestHandler } from "./AbstractHttpRequestHandler";
7
+ import { HttpData } from "../../common/request/HttpData";
8
+ import { AbstractHttpMiddleware } from "./AbstractHttpMiddleware";
9
+ import { AbstractPrincipalResolver } from "../../common/auth/AbstractPrincipalResolver";
10
+ export declare class DefaultHttpRequestHandler extends AbstractHttpRequestHandler {
11
+ readonly logger: AbstractLogger;
12
+ readonly authorizationProvider: AbstractHttpAuthorizer;
13
+ readonly principalResolver: AbstractPrincipalResolver;
14
+ private _middleware;
15
+ constructor(logger: AbstractLogger, authorizationProvider: AbstractHttpAuthorizer, principalResolver: AbstractPrincipalResolver);
16
+ protected accessControl(endpoint: MountedEndpointInfo, req: HttpRequest): Promise<void>;
17
+ protected handleRequest(endpoint: MountedEndpointInfo, req: HttpRequest): Promise<HttpResponse<any>>;
18
+ exit(): void;
19
+ private getResponse;
20
+ handle(httpData: HttpData): Promise<HttpResponse<any>>;
21
+ getMiddleware(): Promise<AbstractHttpMiddleware[]>;
22
+ }
@@ -1,33 +1,33 @@
1
- import { HttpMethod, Constructor, AbstractModel } from "@clairejs/core";
2
- import { AbstractHttpController } from "./controller/AbstractHttpController";
3
- import { AbstractAccessCondition } from "./security/AbstractAccessCondition";
4
- import { HttpResponse } from "./common/HttpResponse";
5
- import { UriMapperHandler } from "./file-upload/types";
6
- import { IPrincipal } from "../common/auth/IPrincipal";
7
- declare type HttpFunctionMethod<T> = (...args: any[]) => Promise<HttpResponse<T>>;
8
- export declare const ApiDescription: (description: string) => (prototype: AbstractHttpController, propertyKey: string) => void;
9
- export declare const Endpoint: (config: {
10
- method: HttpMethod;
11
- url: string;
12
- }) => (prototype: any, propertyKey: string) => void;
13
- export declare const Post: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
14
- export declare const Put: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
15
- export declare const Del: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
16
- export declare const Get: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
17
- export declare const Head: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
18
- export declare const ApiResponse: <T>(responseClass: Constructor<T>) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<T>>) => void;
19
- export declare const OpenAccess: () => (prototype: AbstractHttpController, propertyKey: string) => void;
20
- export declare const TfaRequired: () => (prototype: AbstractHttpController, propertyKey: string) => void;
21
- export declare const AccessCondition: (conditions: Constructor<AbstractAccessCondition>[]) => (prototype: AbstractHttpController, propertyKey: string) => void;
22
- export declare const Body: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
23
- export declare const Params: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
24
- export declare const Queries: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
25
- export declare const Headers: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
26
- export declare const Socket: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
27
- export declare const Raw: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
28
- export declare const UriMapper: (mapper: UriMapperHandler) => <T extends AbstractModel>(prototype: T, propertyKey: keyof T) => void;
29
- /**
30
- * Current User decorator only has effect when being used with ICrudRepository.
31
- * */
32
- export declare const CurrentUser: <T extends IPrincipal>(resolver: (principal: T) => any) => (prototype: any, propertyKey: string) => void;
33
- export {};
1
+ import { HttpMethod, Constructor, AbstractModel } from "@clairejs/core";
2
+ import { AbstractHttpController } from "./controller/AbstractHttpController";
3
+ import { AbstractAccessCondition } from "./security/AbstractAccessCondition";
4
+ import { HttpResponse } from "./common/HttpResponse";
5
+ import { UriMapperHandler } from "./file-upload/types";
6
+ import { IPrincipal } from "../common/auth/IPrincipal";
7
+ declare type HttpFunctionMethod<T> = (...args: any[]) => Promise<HttpResponse<T>>;
8
+ export declare const ApiDescription: (description: string) => (prototype: AbstractHttpController, propertyKey: string) => void;
9
+ export declare const Endpoint: (config: {
10
+ method: HttpMethod;
11
+ url: string;
12
+ }) => (prototype: any, propertyKey: string) => void;
13
+ export declare const Post: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
14
+ export declare const Put: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
15
+ export declare const Del: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
16
+ export declare const Get: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
17
+ export declare const Head: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
18
+ export declare const ApiResponse: <T>(responseClass: Constructor<T>) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<T>>) => void;
19
+ export declare const OpenAccess: () => (prototype: AbstractHttpController, propertyKey: string) => void;
20
+ export declare const TfaRequired: () => (prototype: AbstractHttpController, propertyKey: string) => void;
21
+ export declare const AccessCondition: (conditions: Constructor<AbstractAccessCondition>[]) => (prototype: AbstractHttpController, propertyKey: string) => void;
22
+ export declare const Body: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
23
+ export declare const Params: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
24
+ export declare const Queries: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
25
+ export declare const Headers: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
26
+ export declare const Socket: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
27
+ export declare const Raw: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
28
+ export declare const UriMapper: (mapper: UriMapperHandler) => <T extends AbstractModel>(prototype: T, propertyKey: keyof T) => void;
29
+ /**
30
+ * Current User decorator only has effect when being used with ICrudRepository.
31
+ * */
32
+ export declare const CurrentUser: <T extends IPrincipal>(resolver: (principal: T) => any) => (prototype: any, propertyKey: string) => void;
33
+ export {};
@@ -1,7 +1,7 @@
1
- export declare abstract class AbstractFileUploadHandler {
2
- abstract moveFile(fromUri: string, toUri: string): Promise<void>;
3
- abstract copyFile(fromUri: string, toUri: string): Promise<void>;
4
- abstract removeFile(uri: string): Promise<void>;
5
- abstract resolvePublicUrl(uri: string): Promise<string>;
6
- abstract resolvePrivateUrl(uri: string): Promise<string>;
7
- }
1
+ export declare abstract class AbstractFileUploadHandler {
2
+ abstract moveFile(fromUri: string, toUri: string): Promise<void>;
3
+ abstract copyFile(fromUri: string, toUri: string): Promise<void>;
4
+ abstract removeFile(uri: string): Promise<void>;
5
+ abstract resolvePublicUrl(uri: string): Promise<string>;
6
+ abstract resolvePrivateUrl(uri: string): Promise<string>;
7
+ }
@@ -1,11 +1,11 @@
1
- import { AbstractFileService } from "../../services/AbstractFileService";
2
- import { AbstractFileUploadHandler } from "./AbstractFileUploadHandler";
3
- export declare class FileUploadHandler extends AbstractFileUploadHandler {
4
- readonly fileService: AbstractFileService;
5
- constructor(fileService: AbstractFileService);
6
- moveFile(fromURI: string, toURI: string): Promise<void>;
7
- copyFile(fromURI: string, toURI: string): Promise<void>;
8
- removeFile(uri: string): Promise<void>;
9
- resolvePublicUrl(uri: string): Promise<string>;
10
- resolvePrivateUrl(uri: string): Promise<string>;
11
- }
1
+ import { AbstractFileService } from "../../services/AbstractFileService";
2
+ import { AbstractFileUploadHandler } from "./AbstractFileUploadHandler";
3
+ export declare class FileUploadHandler extends AbstractFileUploadHandler {
4
+ readonly fileService: AbstractFileService;
5
+ constructor(fileService: AbstractFileService);
6
+ moveFile(fromURI: string, toURI: string): Promise<void>;
7
+ copyFile(fromURI: string, toURI: string): Promise<void>;
8
+ removeFile(uri: string): Promise<void>;
9
+ resolvePublicUrl(uri: string): Promise<string>;
10
+ resolvePrivateUrl(uri: string): Promise<string>;
11
+ }
@@ -1 +1 @@
1
- export declare type UriMapperHandler = (tmpUri: string, locale?: string) => string;
1
+ export declare type UriMapperHandler = (tmpUri: string, locale?: string) => string;
@@ -1,10 +1,10 @@
1
- import { Constructor, DeepPartial, Identifiable } from "@clairejs/core";
2
- import { ServerModelMetadata } from "../../common/ServerModelMetadata";
3
- import { IPrincipal } from "../../common/auth/IPrincipal";
4
- export declare abstract class AbstractRepository<T extends Identifiable> {
5
- readonly model: Constructor<T>;
6
- protected readonly modelMetadata: ServerModelMetadata;
7
- constructor(model: Constructor<T>);
8
- protected beforeCreating(principal: IPrincipal | undefined, records: DeepPartial<T>[]): Promise<void>;
9
- protected project(records: Partial<T>[], projection?: (keyof T)[]): any[];
10
- }
1
+ import { Constructor, DeepPartial, Identifiable } from "@clairejs/core";
2
+ import { ServerModelMetadata } from "../../common/ServerModelMetadata";
3
+ import { IPrincipal } from "../../common/auth/IPrincipal";
4
+ export declare abstract class AbstractRepository<T extends Identifiable> {
5
+ readonly model: Constructor<T>;
6
+ protected readonly modelMetadata: ServerModelMetadata;
7
+ constructor(model: Constructor<T>);
8
+ protected beforeCreating(principal: IPrincipal | undefined, records: DeepPartial<T>[]): Promise<void>;
9
+ protected project(records: Partial<T>[], projection?: (keyof T)[]): any[];
10
+ }
@@ -1,58 +1,58 @@
1
- import { AbstractModel, Constructor, CreateManyRequestBody, CreateManyResponseBody, DeepPartial, GetManyQueries, GetManyResponseBody, Identifiable, UpdateManyBody, UpdateManyQueries, UpdateManyResponse } from "@clairejs/core";
2
- import { IQueryProvider, ITransaction, QueryCondition } from "@clairejs/orm";
3
- import { IPrincipal } from "../../common/auth/IPrincipal";
4
- import { AbstractRepository } from "./AbstractRepository";
5
- import { ICrudRepository } from "./ICrudRepository";
6
- export declare type DtoDissolver<R extends Identifiable, K extends Identifiable> = (t: DeepPartial<K>) => MappingMetadata<R, any>[];
7
- export interface MappingMetadata<R extends Identifiable, K extends AbstractModel> {
8
- multiple: boolean;
9
- modelClass: Constructor<K>;
10
- forwardOps: (ops?: QueryCondition<R>[]) => QueryCondition<K>[] | undefined;
11
- forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined;
12
- rootMapping: (ks?: DeepPartial<K>[]) => DeepPartial<R>;
13
- nestedMapping?: DtoDissolver<R, K>;
14
- }
15
- export declare const SingleMap: <R extends Identifiable, K extends AbstractModel>(modelClass: Constructor<K>, forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined, forwardMapping: (t: DeepPartial<K>) => DeepPartial<K> | undefined, rootMapping: (k?: DeepPartial<K> | undefined) => DeepPartial<R>, nestedMapping?: DtoDissolver<R, K> | undefined) => {
16
- multiple: boolean;
17
- modelClass: Constructor<K>;
18
- forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined;
19
- forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined;
20
- rootMapping: (ks?: DeepPartial<K>[] | undefined) => DeepPartial<R>;
21
- nestedMapping: DtoDissolver<R, K> | undefined;
22
- };
23
- export declare const MultipleMap: <R extends Identifiable, K extends AbstractModel>(modelClass: Constructor<K>, forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined, forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined, rootMapping: (ks?: DeepPartial<K>[] | undefined) => DeepPartial<R>, nestedMapping?: DtoDissolver<R, K> | undefined) => {
24
- multiple: boolean;
25
- modelClass: Constructor<K>;
26
- forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined;
27
- forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined;
28
- rootMapping: (ks?: DeepPartial<K>[] | undefined) => DeepPartial<R>;
29
- nestedMapping: DtoDissolver<R, K> | undefined;
30
- };
31
- export declare class DtoRepository<T extends Identifiable> extends AbstractRepository<T> implements ICrudRepository<T> {
32
- readonly model: Constructor<T>;
33
- readonly dissolver: DtoDissolver<T, any>;
34
- constructor(model: Constructor<T>, dissolver: DtoDissolver<T, any>);
35
- private getMapValue;
36
- createMany({ principal, body, tx, }: {
37
- principal?: IPrincipal | undefined;
38
- body: CreateManyRequestBody<T>;
39
- tx: ITransaction & IQueryProvider;
40
- }): Promise<CreateManyResponseBody<T>>;
41
- updateMany({ principal, queries, ops, body, tx, }: {
42
- principal?: IPrincipal | undefined;
43
- queries?: UpdateManyQueries<T>;
44
- ops?: QueryCondition<T>[];
45
- body: UpdateManyBody<T>;
46
- tx: ITransaction & IQueryProvider;
47
- }): Promise<UpdateManyResponse<T>>;
48
- getMany({ queries, ops, queryProvider, }: {
49
- queries?: GetManyQueries<T>;
50
- ops?: QueryCondition<T>[];
51
- queryProvider: IQueryProvider;
52
- }): Promise<GetManyResponseBody<T>>;
53
- deleteMany({ queries, ops, tx, }: {
54
- queries?: UpdateManyQueries<T>;
55
- ops?: QueryCondition<T>[];
56
- tx: ITransaction;
57
- }): Promise<UpdateManyResponse<T>>;
58
- }
1
+ import { AbstractModel, Constructor, CreateManyRequestBody, CreateManyResponseBody, DeepPartial, GetManyQueries, GetManyResponseBody, Identifiable, UpdateManyBody, UpdateManyQueries, UpdateManyResponse } from "@clairejs/core";
2
+ import { IQueryProvider, ITransaction, QueryCondition } from "@clairejs/orm";
3
+ import { IPrincipal } from "../../common/auth/IPrincipal";
4
+ import { AbstractRepository } from "./AbstractRepository";
5
+ import { ICrudRepository } from "./ICrudRepository";
6
+ export declare type DtoDissolver<R extends Identifiable, K extends Identifiable> = (t: DeepPartial<K>) => MappingMetadata<R, any>[];
7
+ export interface MappingMetadata<R extends Identifiable, K extends AbstractModel> {
8
+ multiple: boolean;
9
+ modelClass: Constructor<K>;
10
+ forwardOps: (ops?: QueryCondition<R>[]) => QueryCondition<K>[] | undefined;
11
+ forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined;
12
+ rootMapping: (ks?: DeepPartial<K>[]) => DeepPartial<R>;
13
+ nestedMapping?: DtoDissolver<R, K>;
14
+ }
15
+ export declare const SingleMap: <R extends Identifiable<string | number>, K extends AbstractModel>(modelClass: Constructor<K>, forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined, forwardMapping: (t: DeepPartial<K>) => DeepPartial<K> | undefined, rootMapping: (k?: DeepPartial<K> | undefined) => DeepPartial<R>, nestedMapping?: DtoDissolver<R, K> | undefined) => {
16
+ multiple: boolean;
17
+ modelClass: Constructor<K>;
18
+ forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined;
19
+ forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined;
20
+ rootMapping: (ks?: DeepPartial<K>[] | undefined) => DeepPartial<R>;
21
+ nestedMapping: DtoDissolver<R, K> | undefined;
22
+ };
23
+ export declare const MultipleMap: <R extends Identifiable<string | number>, K extends AbstractModel>(modelClass: Constructor<K>, forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined, forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined, rootMapping: (ks?: DeepPartial<K>[] | undefined) => DeepPartial<R>, nestedMapping?: DtoDissolver<R, K> | undefined) => {
24
+ multiple: boolean;
25
+ modelClass: Constructor<K>;
26
+ forwardOps: (ops?: QueryCondition<R>[] | undefined) => QueryCondition<K>[] | undefined;
27
+ forwardMapping: (t: DeepPartial<K>[]) => DeepPartial<K>[] | undefined;
28
+ rootMapping: (ks?: DeepPartial<K>[] | undefined) => DeepPartial<R>;
29
+ nestedMapping: DtoDissolver<R, K> | undefined;
30
+ };
31
+ export declare class DtoRepository<T extends Identifiable> extends AbstractRepository<T> implements ICrudRepository<T> {
32
+ readonly model: Constructor<T>;
33
+ readonly dissolver: DtoDissolver<T, any>;
34
+ constructor(model: Constructor<T>, dissolver: DtoDissolver<T, any>);
35
+ private getMapValue;
36
+ createMany({ principal, body, tx, }: {
37
+ principal?: IPrincipal | undefined;
38
+ body: CreateManyRequestBody<T>;
39
+ tx: ITransaction & IQueryProvider;
40
+ }): Promise<CreateManyResponseBody<T>>;
41
+ updateMany({ principal, queries, ops, body, tx, }: {
42
+ principal?: IPrincipal | undefined;
43
+ queries?: UpdateManyQueries<T>;
44
+ ops?: QueryCondition<T>[];
45
+ body: UpdateManyBody<T>;
46
+ tx: ITransaction & IQueryProvider;
47
+ }): Promise<UpdateManyResponse<T>>;
48
+ getMany({ queries, ops, queryProvider, }: {
49
+ queries?: GetManyQueries<T>;
50
+ ops?: QueryCondition<T>[];
51
+ queryProvider: IQueryProvider;
52
+ }): Promise<GetManyResponseBody<T>>;
53
+ deleteMany({ queries, ops, tx, }: {
54
+ queries?: UpdateManyQueries<T>;
55
+ ops?: QueryCondition<T>[];
56
+ tx: ITransaction;
57
+ }): Promise<UpdateManyResponse<T>>;
58
+ }
@@ -1,27 +1,27 @@
1
- import { CreateManyRequestBody, CreateManyResponseBody, GetManyQueries, GetManyResponseBody, UpdateManyBody, UpdateManyQueries, UpdateManyResponse } from "@clairejs/core";
2
- import { IQueryProvider, ITransaction, QueryCondition } from "@clairejs/orm";
3
- import { IPrincipal } from "../../common/auth/IPrincipal";
4
- export interface ICrudRepository<T> {
5
- createMany({ principal, body, tx, }: {
6
- principal?: IPrincipal;
7
- body: CreateManyRequestBody<T>;
8
- tx: ITransaction;
9
- }): Promise<CreateManyResponseBody<T>>;
10
- getMany({ queries, ops, queryProvider, }: {
11
- queries?: GetManyQueries<T>;
12
- ops?: QueryCondition<T>[];
13
- queryProvider: IQueryProvider;
14
- }): Promise<GetManyResponseBody<T>>;
15
- updateMany({ principal, queries, ops, body, tx, }: {
16
- principal?: IPrincipal;
17
- queries?: UpdateManyQueries<T>;
18
- ops?: QueryCondition<T>[];
19
- body: UpdateManyBody<T>;
20
- tx: ITransaction;
21
- }): Promise<UpdateManyResponse<T>>;
22
- deleteMany({ queries, ops, tx, }: {
23
- queries?: UpdateManyQueries<T>;
24
- ops?: QueryCondition<T>[];
25
- tx: ITransaction;
26
- }): Promise<UpdateManyResponse<T>>;
27
- }
1
+ import { CreateManyRequestBody, CreateManyResponseBody, GetManyQueries, GetManyResponseBody, UpdateManyBody, UpdateManyQueries, UpdateManyResponse } from "@clairejs/core";
2
+ import { IQueryProvider, ITransaction, QueryCondition } from "@clairejs/orm";
3
+ import { IPrincipal } from "../../common/auth/IPrincipal";
4
+ export interface ICrudRepository<T> {
5
+ createMany({ principal, body, tx, }: {
6
+ principal?: IPrincipal;
7
+ body: CreateManyRequestBody<T>;
8
+ tx: ITransaction;
9
+ }): Promise<CreateManyResponseBody<T>>;
10
+ getMany({ queries, ops, queryProvider, }: {
11
+ queries?: GetManyQueries<T>;
12
+ ops?: QueryCondition<T>[];
13
+ queryProvider: IQueryProvider;
14
+ }): Promise<GetManyResponseBody<T>>;
15
+ updateMany({ principal, queries, ops, body, tx, }: {
16
+ principal?: IPrincipal;
17
+ queries?: UpdateManyQueries<T>;
18
+ ops?: QueryCondition<T>[];
19
+ body: UpdateManyBody<T>;
20
+ tx: ITransaction;
21
+ }): Promise<UpdateManyResponse<T>>;
22
+ deleteMany({ queries, ops, tx, }: {
23
+ queries?: UpdateManyQueries<T>;
24
+ ops?: QueryCondition<T>[];
25
+ tx: ITransaction;
26
+ }): Promise<UpdateManyResponse<T>>;
27
+ }
@@ -1,37 +1,37 @@
1
- import { AbstractModel, Constructor, CreateManyRequestBody, CreateManyResponseBody, GetManyQueries, GetManyResponseBody, UpdateManyBody, UpdateManyQueries, UpdateManyResponse } from "@clairejs/core";
2
- import { IQueryProvider, ITransaction, QueryCondition } from "@clairejs/orm";
3
- import { IPrincipal } from "../../common/auth/IPrincipal";
4
- import { ICrudRepository } from "./ICrudRepository";
5
- import { AbstractRepository } from "./AbstractRepository";
6
- export declare class ModelRepository<T extends AbstractModel> extends AbstractRepository<T> implements ICrudRepository<T> {
7
- readonly model: Constructor<T>;
8
- private fileUploadHandler?;
9
- constructor(model: Constructor<T>);
10
- private getNestedQueries;
11
- private getUploadHandler;
12
- private getRequestQueryConditionFromQuery;
13
- protected uriHandling(records: Partial<T>[]): Promise<() => Promise<void>>;
14
- protected beforeReturning(records: Partial<T>[]): Promise<void>;
15
- createMany({ principal, body, tx, }: {
16
- principal?: IPrincipal;
17
- body: CreateManyRequestBody<T>;
18
- tx: ITransaction;
19
- }): Promise<CreateManyResponseBody<T>>;
20
- updateMany({ principal, ops, queries, body, tx, }: {
21
- principal?: IPrincipal;
22
- queries?: UpdateManyQueries<T>;
23
- ops?: QueryCondition<T>[];
24
- body: UpdateManyBody<T>;
25
- tx: ITransaction;
26
- }): Promise<UpdateManyResponse<T>>;
27
- getMany({ queries, ops, queryProvider, }: {
28
- queries?: GetManyQueries<T>;
29
- ops?: QueryCondition<T>[];
30
- queryProvider: IQueryProvider;
31
- }): Promise<GetManyResponseBody<T>>;
32
- deleteMany({ queries, ops, tx, }: {
33
- queries?: UpdateManyQueries<T>;
34
- ops?: QueryCondition<T>[];
35
- tx: ITransaction;
36
- }): Promise<UpdateManyResponse<T>>;
37
- }
1
+ import { AbstractModel, Constructor, CreateManyRequestBody, CreateManyResponseBody, GetManyQueries, GetManyResponseBody, UpdateManyBody, UpdateManyQueries, UpdateManyResponse } from "@clairejs/core";
2
+ import { IQueryProvider, ITransaction, QueryCondition } from "@clairejs/orm";
3
+ import { IPrincipal } from "../../common/auth/IPrincipal";
4
+ import { ICrudRepository } from "./ICrudRepository";
5
+ import { AbstractRepository } from "./AbstractRepository";
6
+ export declare class ModelRepository<T extends AbstractModel> extends AbstractRepository<T> implements ICrudRepository<T> {
7
+ readonly model: Constructor<T>;
8
+ private fileUploadHandler?;
9
+ constructor(model: Constructor<T>);
10
+ private getNestedQueries;
11
+ private getUploadHandler;
12
+ private getRequestQueryConditionFromQuery;
13
+ protected uriHandling(records: Partial<T>[]): Promise<() => Promise<void>>;
14
+ protected beforeReturning(records: Partial<T>[]): Promise<void>;
15
+ createMany({ principal, body, tx, }: {
16
+ principal?: IPrincipal;
17
+ body: CreateManyRequestBody<T>;
18
+ tx: ITransaction;
19
+ }): Promise<CreateManyResponseBody<T>>;
20
+ updateMany({ principal, ops, queries, body, tx, }: {
21
+ principal?: IPrincipal;
22
+ queries?: UpdateManyQueries<T>;
23
+ ops?: QueryCondition<T>[];
24
+ body: UpdateManyBody<T>;
25
+ tx: ITransaction;
26
+ }): Promise<UpdateManyResponse<T>>;
27
+ getMany({ queries, ops, queryProvider, }: {
28
+ queries?: GetManyQueries<T>;
29
+ ops?: QueryCondition<T>[];
30
+ queryProvider: IQueryProvider;
31
+ }): Promise<GetManyResponseBody<T>>;
32
+ deleteMany({ queries, ops, tx, }: {
33
+ queries?: UpdateManyQueries<T>;
34
+ ops?: QueryCondition<T>[];
35
+ tx: ITransaction;
36
+ }): Promise<UpdateManyResponse<T>>;
37
+ }
@@ -1,7 +1,7 @@
1
- import { AccessConditionMetadata } from "@clairejs/core";
2
- import { HttpRequest } from "../common/HttpRequest";
3
- export declare abstract class AbstractAccessCondition<T = any> {
4
- abstract resolveConditionValue(request: HttpRequest): Promise<T>;
5
- abstract validate(conditionValue: T, permittedConditionValue: any): Promise<boolean>;
6
- abstract getConditionMetadata(): AccessConditionMetadata;
7
- }
1
+ import { AccessConditionMetadata } from "@clairejs/core";
2
+ import { HttpRequest } from "../common/HttpRequest";
3
+ export declare abstract class AbstractAccessCondition<T = any> {
4
+ abstract resolveConditionValue(request: HttpRequest): Promise<T>;
5
+ abstract validate(conditionValue: T, permittedConditionValue: any): Promise<boolean>;
6
+ abstract getConditionMetadata(): AccessConditionMetadata;
7
+ }