remult 0.14.31 → 0.14.32

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.
@@ -1,7 +1,7 @@
1
1
  import { queuedJobInfoResponse } from '../src/server-action';
2
2
  import { DataProvider } from '../src/data-interfaces';
3
- import { DataApi, DataApiRequest, DataApiResponse } from '../src/data-api';
4
- import { AllowedForInstance, Remult, UserInfo } from '../src/context';
3
+ import { DataApiRequest } from '../src/data-api';
4
+ import { Remult, UserInfo } from '../src/context';
5
5
  import { ClassType } from '../classType';
6
6
  import { Repository } from '../src/remult3';
7
7
  import { IdEntity } from '../src/id-entity';
@@ -11,7 +11,6 @@ export declare type RemultServerOptions = {
11
11
  * @see [Connecting to a Database](https://remult.dev/docs/databases.html).
12
12
  */
13
13
  dataProvider?: DataProvider | Promise<DataProvider> | (() => Promise<DataProvider | undefined>);
14
- disableAutoApi?: boolean;
15
14
  queueStorage?: QueueStorage;
16
15
  initRequest?: (remult: Remult, origReq: GenericRequest) => Promise<void>;
17
16
  getUser?: (request: GenericRequest) => Promise<UserInfo>;
@@ -22,25 +21,28 @@ export declare type RemultServerOptions = {
22
21
  controllers?: ClassType<any>[];
23
22
  rootPath?: string;
24
23
  };
25
- export declare function buildRemultServer(app: GenericRouter, options: RemultServerOptions): RemultServer;
26
- export declare type GenericMiddleware = (req: GenericRequest, res: GenericResponse, next: VoidFunction) => void;
27
- export interface RemultExpressBridge extends GenericMiddleware, RemultServer {
24
+ export declare function buildRemultServer(options: RemultServerOptions): RemultServer;
25
+ export declare type GenericRequestHandler = (req: GenericRequest, res: GenericResponse, next: VoidFunction) => void;
26
+ export interface ServerHandleResponse {
27
+ data?: any;
28
+ statusCode: number;
28
29
  }
29
30
  export interface RemultServer {
30
31
  getRemult(req: GenericRequest): Promise<Remult>;
31
32
  openApiDoc(options: {
32
33
  title: string;
33
34
  }): any;
34
- addArea(rootUrl: string): void;
35
+ registerRouter(r: GenericRouter): void;
36
+ handle(req: GenericRequest, gRes?: GenericResponse): Promise<ServerHandleResponse | undefined>;
35
37
  }
36
38
  export declare type GenericRouter = {
37
39
  route(path: string): SpecificRoute;
38
40
  };
39
41
  export declare type SpecificRoute = {
40
- get(handler: GenericMiddleware): SpecificRoute;
41
- put(handler: GenericMiddleware): SpecificRoute;
42
- post(handler: GenericMiddleware): SpecificRoute;
43
- delete(handler: GenericMiddleware): SpecificRoute;
42
+ get(handler: GenericRequestHandler): SpecificRoute;
43
+ put(handler: GenericRequestHandler): SpecificRoute;
44
+ post(handler: GenericRequestHandler): SpecificRoute;
45
+ delete(handler: GenericRequestHandler): SpecificRoute;
44
46
  };
45
47
  export interface GenericRequest {
46
48
  url?: string;
@@ -55,53 +57,11 @@ export interface GenericResponse {
55
57
  setStatus?(statusCode: number): GenericResponse;
56
58
  end(): any;
57
59
  }
58
- declare class ExpressBridge {
59
- private app;
60
- queue: inProcessQueueHandler;
61
- options: RemultServerOptions;
62
- dataProvider: DataProvider | Promise<DataProvider>;
63
- openApiDoc(options: {
64
- title: string;
65
- version?: string;
66
- }): any;
67
- backendMethodsOpenApi: {
68
- path: string;
69
- allowed: AllowedForInstance<any>;
70
- tag: string;
71
- }[];
72
- constructor(app: GenericRouter, queue: inProcessQueueHandler, options: RemultServerOptions, dataProvider: DataProvider | Promise<DataProvider>);
73
- logApiEndPoints: boolean;
74
- private firstArea;
75
- addArea(rootUrl: string): SiteArea;
76
- getRemult(req?: GenericRequest): Promise<Remult>;
77
- }
78
- export declare class SiteArea {
79
- private bridge;
80
- private app;
81
- private rootUrl;
82
- private logApiEndpoints;
83
- constructor(bridge: ExpressBridge, app: GenericRouter, rootUrl: string, logApiEndpoints: boolean);
84
- add(key: string, dataApiFactory: ((req: Remult) => DataApi)): void;
85
- process(what: (remult: Remult, myReq: DataApiRequest, myRes: DataApiResponse, origReq: GenericRequest) => Promise<void>): (req: GenericRequest, res: GenericResponse) => Promise<void>;
86
- getRemult(req: GenericRequest): Promise<Remult>;
87
- initQueue(): void;
88
- addAction(action: {
89
- __register: (reg: (url: string, queue: boolean, allowed: AllowedForInstance<any>, what: ((data: any, req: Remult, res: DataApiResponse) => void)) => void) => void;
90
- }): void;
91
- }
92
60
  export declare class ExpressRequestBridgeToDataApiRequest implements DataApiRequest {
93
61
  private r;
94
62
  get(key: string): any;
95
63
  constructor(r: GenericRequest);
96
64
  }
97
- declare class inProcessQueueHandler {
98
- private storage;
99
- constructor(storage: QueueStorage);
100
- submitJob(url: string, req: Remult, body: any): Promise<string>;
101
- mapQueuedAction(url: string, what: (data: any, r: Remult, res: ApiActionResponse) => void): void;
102
- actions: Map<string, (data: any, r: Remult, res: ApiActionResponse) => void>;
103
- getJobInfo(queuedJobId: string): Promise<queuedJobInfo>;
104
- }
105
65
  export interface queuedJobInfo {
106
66
  info: queuedJobInfoResponse;
107
67
  userId: string;
@@ -136,4 +96,3 @@ export declare class JobsInQueueEntity extends IdEntity {
136
96
  error: boolean;
137
97
  progress: number;
138
98
  }
139
- export {};