@clairejs/server 3.0.18 → 3.0.22

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 (57) hide show
  1. package/README.md +491 -483
  2. package/dist/common/constants.d.ts +1 -1
  3. package/dist/database/adapter/AbstractDatabaseAdapter.d.ts +19 -19
  4. package/dist/database/adapter/AbstractQuery.d.ts +52 -52
  5. package/dist/database/adapter/DefaultSqlDatabaseAdapter.d.ts +18 -18
  6. package/dist/database/adapter/IDatabaseProvider.d.ts +4 -4
  7. package/dist/database/adapter/IQuery.d.ts +75 -75
  8. package/dist/database/adapter/IQueryProvider.d.ts +9 -9
  9. package/dist/database/adapter/aggregators.d.ts +21 -21
  10. package/dist/database/adapter/providers.d.ts +8 -8
  11. package/dist/database/decorators.d.ts +2 -2
  12. package/dist/database/migrator/AbstractDatabaseMigrator.d.ts +4 -4
  13. package/dist/database/migrator/DefaultSqlDatabaseMigrator.d.ts +28 -28
  14. package/dist/database/transaction/ITransaction.d.ts +10 -10
  15. package/dist/database/transaction/ITransactionProvider.d.ts +4 -4
  16. package/dist/database/transaction/TransactionLink.d.ts +14 -14
  17. package/dist/database/transaction/TransactionObjectMetadata.d.ts +4 -4
  18. package/dist/database/transaction/TransactionState.d.ts +5 -5
  19. package/dist/database/util/transaction-provider.d.ts +1 -1
  20. package/dist/http/common/HttpRequest.d.ts +39 -39
  21. package/dist/http/common/HttpResponse.d.ts +25 -25
  22. package/dist/http/common/RequestOptions.d.ts +9 -9
  23. package/dist/http/common/ResponseValues.d.ts +10 -10
  24. package/dist/http/common/types.d.ts +1 -1
  25. package/dist/http/controller/AbstractHttpController.d.ts +12 -12
  26. package/dist/http/controller/AbstractHttpMiddleware.d.ts +5 -5
  27. package/dist/http/controller/AbstractHttpRequestHandler.d.ts +10 -10
  28. package/dist/http/controller/ControllerMetadata.d.ts +6 -6
  29. package/dist/http/controller/CrudHttpController.d.ts +58 -58
  30. package/dist/http/controller/DefaultHttpRequestHandler.d.ts +19 -19
  31. package/dist/http/controller/EndpointMetadata.d.ts +36 -36
  32. package/dist/http/controller/HttpEndpoint.d.ts +12 -12
  33. package/dist/http/controller/ModelRepository.d.ts +36 -36
  34. package/dist/http/controller/MountedEndpointInfo.d.ts +6 -6
  35. package/dist/http/decorators.d.ts +26 -26
  36. package/dist/http/security/AbstractAccessCondition.d.ts +7 -7
  37. package/dist/http/security/AbstractHttpAuthorizationProvider.d.ts +7 -7
  38. package/dist/http/security/IPrincipal.d.ts +3 -3
  39. package/dist/http/security/access-conditions/FilterModelFieldAccessCondition.d.ts +4 -4
  40. package/dist/http/security/access-conditions/OwnedResourceAccessCondition.d.ts +5 -5
  41. package/dist/index.d.ts +38 -38
  42. package/dist/index.js +1 -1
  43. package/dist/logging/FileLogMedium.d.ts +13 -13
  44. package/dist/service/AbstractService.d.ts +9 -9
  45. package/dist/socket/AbstractServerSocket.d.ts +36 -36
  46. package/dist/socket/AbstractServerSocketManager.d.ts +19 -19
  47. package/dist/socket/AwsSocketManager.d.ts +46 -46
  48. package/dist/socket/IServerSocket.d.ts +9 -9
  49. package/dist/socket/LocalSocketManager.d.ts +23 -23
  50. package/dist/socket/ServerSocket.d.ts +14 -14
  51. package/dist/system/AbstractFileUploadHandler.d.ts +6 -6
  52. package/dist/system/ClaireServer.d.ts +10 -10
  53. package/dist/system/ExpressWrapper.d.ts +17 -17
  54. package/dist/system/IRequestHandler.d.ts +5 -5
  55. package/dist/system/LambdaWrapper.d.ts +17 -17
  56. package/dist/system/ServerGlobalStore.d.ts +5 -5
  57. package/package.json +59 -60
@@ -1,26 +1,26 @@
1
- import { HttpMethod, Constructor, SocketMethod } from "@clairejs/core";
2
- import { AbstractHttpController } from "./controller/AbstractHttpController";
3
- import { AbstractAccessCondition } from "./security/AbstractAccessCondition";
4
- import { HttpResponse } from "./common/HttpResponse";
5
- declare type HttpFunctionMethod<T> = (...args: any[]) => Promise<HttpResponse<T>>;
6
- export declare const Controller: (config?: {
7
- permissionGroup?: string | undefined;
8
- } | undefined) => <T extends AbstractHttpController>(constructor: Constructor<T>) => void;
9
- export declare const Endpoint: (config: {
10
- method: HttpMethod | SocketMethod;
11
- url: string;
12
- }) => (prototype: AbstractHttpController, propertyKey: string) => void;
13
- export declare const Socket: (channel: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
14
- export declare const Post: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
15
- export declare const Put: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
16
- export declare const Del: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
17
- export declare const Get: (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 AccessCondition: (conditions: Constructor<AbstractAccessCondition>[]) => (prototype: AbstractHttpController, propertyKey: string) => void;
21
- export declare const Body: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
22
- export declare const Params: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
23
- export declare const Queries: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
24
- export declare const Headers: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
25
- export declare const Raw: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
26
- export {};
1
+ import { HttpMethod, Constructor, SocketMethod } from "@clairejs/core";
2
+ import { AbstractHttpController } from "./controller/AbstractHttpController";
3
+ import { AbstractAccessCondition } from "./security/AbstractAccessCondition";
4
+ import { HttpResponse } from "./common/HttpResponse";
5
+ declare type HttpFunctionMethod<T> = (...args: any[]) => Promise<HttpResponse<T>>;
6
+ export declare const Controller: (config?: {
7
+ permissionGroup?: string | undefined;
8
+ } | undefined) => <T extends AbstractHttpController>(constructor: Constructor<T>) => void;
9
+ export declare const Endpoint: (config: {
10
+ method: HttpMethod | SocketMethod;
11
+ url: string;
12
+ }) => (prototype: AbstractHttpController, propertyKey: string) => void;
13
+ export declare const Socket: (channel: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
14
+ export declare const Post: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
15
+ export declare const Put: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
16
+ export declare const Del: (url: string) => (prototype: AbstractHttpController, propertyKey: string, _descriptor: TypedPropertyDescriptor<HttpFunctionMethod<any>>) => void;
17
+ export declare const Get: (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 AccessCondition: (conditions: Constructor<AbstractAccessCondition>[]) => (prototype: AbstractHttpController, propertyKey: string) => void;
21
+ export declare const Body: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
22
+ export declare const Params: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
23
+ export declare const Queries: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
24
+ export declare const Headers: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
25
+ export declare const Raw: () => (prototype: AbstractHttpController, propertyKey: string, paramIndex: number) => void;
26
+ export {};
@@ -1,7 +1,7 @@
1
- import { AccessConditionMetadata } from "@clairejs/core";
2
- import { HttpRequest } from "../common/HttpRequest";
3
- export declare abstract class AbstractAccessCondition {
4
- abstract resolveConditionValue(request: HttpRequest): Promise<any>;
5
- abstract validate(conditionValue: any, 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 {
4
+ abstract resolveConditionValue(request: HttpRequest): Promise<any>;
5
+ abstract validate(conditionValue: any, permittedConditionValue: any): Promise<boolean>;
6
+ abstract getConditionMetadata(): AccessConditionMetadata;
7
+ }
@@ -1,7 +1,7 @@
1
- import { HttpRequest } from "../common/HttpRequest";
2
- import { MountedEndpointInfo } from "../controller/MountedEndpointInfo";
3
- import { IPrincipal } from "./IPrincipal";
4
- export declare abstract class AbstractHttpAuthorizationProvider<T extends IPrincipal> {
5
- abstract resolvePrincipal(req: HttpRequest): Promise<T | undefined>;
6
- abstract authorize(principal: T | undefined, req: HttpRequest, endpoint: MountedEndpointInfo): Promise<void>;
7
- }
1
+ import { HttpRequest } from "../common/HttpRequest";
2
+ import { MountedEndpointInfo } from "../controller/MountedEndpointInfo";
3
+ import { IPrincipal } from "./IPrincipal";
4
+ export declare abstract class AbstractHttpAuthorizationProvider<T extends IPrincipal> {
5
+ abstract resolvePrincipal(req: HttpRequest): Promise<T | undefined>;
6
+ abstract authorize(principal: T | undefined, req: HttpRequest, endpoint: MountedEndpointInfo): Promise<void>;
7
+ }
@@ -1,3 +1,3 @@
1
- export interface IPrincipal {
2
- id: number;
3
- }
1
+ export interface IPrincipal {
2
+ id: number;
3
+ }
@@ -1,4 +1,4 @@
1
- import { AbstractModel, Constructor } from "@clairejs/core";
2
- import { HttpRequest } from "../../common/HttpRequest";
3
- import { AbstractAccessCondition } from "../AbstractAccessCondition";
4
- export declare const FilterModelFieldAccessCondition: <T extends AbstractModel>(model: Constructor<T>, requestedConditionValueResolver: (request: HttpRequest) => string[] | undefined) => Constructor<AbstractAccessCondition>;
1
+ import { AbstractModel, Constructor } from "@clairejs/core";
2
+ import { HttpRequest } from "../../common/HttpRequest";
3
+ import { AbstractAccessCondition } from "../AbstractAccessCondition";
4
+ export declare const FilterModelFieldAccessCondition: <T extends AbstractModel>(model: Constructor<T>, requestedConditionValueResolver: (request: HttpRequest) => string[] | undefined) => Constructor<AbstractAccessCondition>;
@@ -1,5 +1,5 @@
1
- import { Constructor } from "@clairejs/core";
2
- import { AbstractDatabaseAdapter } from "../../../database/adapter/AbstractDatabaseAdapter";
3
- import { HttpRequest } from "../../common/HttpRequest";
4
- import { AbstractAccessCondition } from "../AbstractAccessCondition";
5
- export declare const OwnedResourceAccessCondition: (ownedResourceChecker: (request: HttpRequest, databaseAdapter: AbstractDatabaseAdapter) => Promise<boolean>) => Constructor<AbstractAccessCondition>;
1
+ import { Constructor } from "@clairejs/core";
2
+ import { AbstractDatabaseAdapter } from "../../../database/adapter/AbstractDatabaseAdapter";
3
+ import { HttpRequest } from "../../common/HttpRequest";
4
+ import { AbstractAccessCondition } from "../AbstractAccessCondition";
5
+ export declare const OwnedResourceAccessCondition: (ownedResourceChecker: (request: HttpRequest, databaseAdapter: AbstractDatabaseAdapter) => Promise<boolean>) => Constructor<AbstractAccessCondition>;
package/dist/index.d.ts CHANGED
@@ -1,38 +1,38 @@
1
- export * from "./http/decorators";
2
- export * from "./http/common/HttpRequest";
3
- export * from "./http/security/IPrincipal";
4
- export * from "./http/common/RequestOptions";
5
- export * from "./http/common/ResponseValues";
6
- export * from "./http/common/HttpResponse";
7
- export * from "./http/controller/DefaultHttpRequestHandler";
8
- export * from "./http/controller/AbstractHttpController";
9
- export * from "./http/controller/CrudHttpController";
10
- export * from "./http/controller/MountedEndpointInfo";
11
- export * from "./http/controller/EndpointMetadata";
12
- export * from "./http/controller/AbstractHttpRequestHandler";
13
- export * from "./http/controller/AbstractHttpMiddleware";
14
- export * from "./http/security/AbstractHttpAuthorizationProvider";
15
- export * from "./http/security/AbstractAccessCondition";
16
- export * from "./http/security/access-conditions/FilterModelFieldAccessCondition";
17
- export * from "./http/security/access-conditions/OwnedResourceAccessCondition";
18
- export * from "./logging/FileLogMedium";
19
- export * from "./system/ClaireServer";
20
- export * from "./system/ExpressWrapper";
21
- export * from "./system/LambdaWrapper";
22
- export * from "./system/ServerGlobalStore";
23
- export * from "./system/AbstractFileUploadHandler";
24
- export * from "./service/AbstractService";
25
- export * from "./database/adapter/AbstractDatabaseAdapter";
26
- export * from "./database/transaction/TransactionLink";
27
- export * from "./database/adapter/DefaultSqlDatabaseAdapter";
28
- export * from "./database/migrator/DefaultSqlDatabaseMigrator";
29
- export * from "./database/adapter/providers";
30
- export * from "./database/decorators";
31
- export * from "./database/migrator/AbstractDatabaseMigrator";
32
- export * from "./socket/AbstractServerSocketManager";
33
- export * from "./socket/LocalSocketManager";
34
- export * from "./socket/AwsSocketManager";
35
- export * from "./database/adapter/aggregators";
36
- export * from "./socket/IServerSocket";
37
- export * from "./http/controller/ModelRepository";
38
- export { QueryTypes } from "sequelize";
1
+ export * from "./http/decorators";
2
+ export * from "./http/common/HttpRequest";
3
+ export * from "./http/security/IPrincipal";
4
+ export * from "./http/common/RequestOptions";
5
+ export * from "./http/common/ResponseValues";
6
+ export * from "./http/common/HttpResponse";
7
+ export * from "./http/controller/DefaultHttpRequestHandler";
8
+ export * from "./http/controller/AbstractHttpController";
9
+ export * from "./http/controller/CrudHttpController";
10
+ export * from "./http/controller/MountedEndpointInfo";
11
+ export * from "./http/controller/EndpointMetadata";
12
+ export * from "./http/controller/AbstractHttpRequestHandler";
13
+ export * from "./http/controller/AbstractHttpMiddleware";
14
+ export * from "./http/security/AbstractHttpAuthorizationProvider";
15
+ export * from "./http/security/AbstractAccessCondition";
16
+ export * from "./http/security/access-conditions/FilterModelFieldAccessCondition";
17
+ export * from "./http/security/access-conditions/OwnedResourceAccessCondition";
18
+ export * from "./logging/FileLogMedium";
19
+ export * from "./system/ClaireServer";
20
+ export * from "./system/ExpressWrapper";
21
+ export * from "./system/LambdaWrapper";
22
+ export * from "./system/ServerGlobalStore";
23
+ export * from "./system/AbstractFileUploadHandler";
24
+ export * from "./service/AbstractService";
25
+ export * from "./database/adapter/AbstractDatabaseAdapter";
26
+ export * from "./database/transaction/TransactionLink";
27
+ export * from "./database/adapter/DefaultSqlDatabaseAdapter";
28
+ export * from "./database/migrator/DefaultSqlDatabaseMigrator";
29
+ export * from "./database/adapter/providers";
30
+ export * from "./database/decorators";
31
+ export * from "./database/migrator/AbstractDatabaseMigrator";
32
+ export * from "./socket/AbstractServerSocketManager";
33
+ export * from "./socket/LocalSocketManager";
34
+ export * from "./socket/AwsSocketManager";
35
+ export * from "./database/adapter/aggregators";
36
+ export * from "./socket/IServerSocket";
37
+ export * from "./http/controller/ModelRepository";
38
+ export { QueryTypes } from "sequelize";