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.
package/esm/graphql.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { RemultExpressBridge } from "./server/expressBridge";
2
- export declare function remultGraphql(api: RemultExpressBridge): {
1
+ import { RemultServer } from "./server/expressBridge";
2
+ export declare function remultGraphql(api: RemultServer): {
3
3
  rootValue: {};
4
4
  schema: string;
5
5
  };
@@ -1,11 +1,6 @@
1
- import { RemultServerOptions } from './server/expressBridge';
1
+ import * as express from 'express';
2
+ import { RemultServer, RemultServerOptions } from './server/expressBridge';
2
3
  export declare function remultExpress(options?: RemultServerOptions & {
3
4
  bodyParser?: boolean;
4
5
  bodySizeLimit?: string;
5
- }): import("express-serve-static-core").Router & {
6
- getRemult: (req: any) => Promise<import(".").Remult>;
7
- openApiDoc: (options: {
8
- title: string;
9
- }) => any;
10
- addArea: (x: any) => void;
11
- };
6
+ }): express.RequestHandler & RemultServer;
@@ -12,10 +12,11 @@ export function remultExpress(options) {
12
12
  app.use(express.json({ limit: options.bodySizeLimit }));
13
13
  app.use(express.urlencoded({ extended: true, limit: options.bodySizeLimit }));
14
14
  }
15
- const server = buildRemultServer(app, options);
15
+ const server = buildRemultServer(options);
16
+ server.registerRouter(app);
16
17
  return Object.assign(app, {
17
18
  getRemult: (req) => server.getRemult(req),
18
19
  openApiDoc: (options) => server.openApiDoc(options),
19
- addArea: x => server.addArea(x)
20
+ registerRouter: x => server.registerRouter(x)
20
21
  });
21
22
  }
@@ -18,7 +18,7 @@ export function remultFastify(options) {
18
18
  };
19
19
  return response;
20
20
  }
21
- let api;
21
+ const api = buildRemultServer(options);
22
22
  const pluginFunction = async (instance, op) => {
23
23
  //@ts-ignore
24
24
  let fastifyRouter = {
@@ -42,16 +42,11 @@ export function remultFastify(options) {
42
42
  return r;
43
43
  },
44
44
  };
45
- api = buildRemultServer(fastifyRouter, options);
46
- };
47
- const getApi = () => {
48
- if (!api)
49
- throw "Please call fastify's register before using this method";
50
- return api;
45
+ api.registerRouter(fastifyRouter);
51
46
  };
52
47
  return Object.assign(pluginFunction, {
53
- addArea: x => getApi().addArea(x),
54
- getRemult: x => getApi().getRemult(x),
55
- openApiDoc: x => getApi().openApiDoc(x)
48
+ getRemult: x => api.getRemult(x),
49
+ openApiDoc: x => api.openApiDoc(x),
50
+ handle: (req, res) => api.handle(req, res)
56
51
  });
57
52
  }
@@ -1,8 +1,7 @@
1
1
  import { RemultServerOptions, RemultServer } from "./server/expressBridge";
2
- import { Remult } from "./src/context";
3
2
  export declare function remultFresh(options: RemultServerOptions, response: FreshResponse): RemultFresh;
4
3
  export interface RemultFresh extends RemultServer {
5
- handle(req: FreshRequest, ctx: FreshContext): Promise<FreshResponse>;
4
+ freshHandler(req: FreshRequest, ctx: FreshContext): Promise<FreshResponse>;
6
5
  }
7
6
  export interface FreshRequest {
8
7
  url: string;
@@ -11,12 +10,8 @@ export interface FreshRequest {
11
10
  }
12
11
  export interface FreshContext {
13
12
  next: () => Promise<any>;
14
- state: FreshRemultState;
15
13
  }
16
14
  export interface FreshResponse {
17
15
  new (body?: any | undefined, init?: ResponseInit): any;
18
16
  json(data: unknown, init?: ResponseInit): any;
19
17
  }
20
- export interface FreshRemultState {
21
- remult: Remult;
22
- }
@@ -1,43 +1,36 @@
1
- import { remultMiddleware } from "./remult-middleware";
1
+ import { buildRemultServer } from "./server/expressBridge";
2
2
  export function remultFresh(options, response) {
3
- const mw = remultMiddleware(options);
4
- const orig = mw.handle;
5
- return {
6
- ...mw,
7
- ...{
8
- handle: async (req, ctx) => {
9
- const theReq = {
10
- method: req.method,
11
- url: req.url,
12
- body: undefined
13
- };
14
- switch (req.method.toLocaleLowerCase()) {
15
- case "put":
16
- case "post":
17
- console.log(req);
18
- theReq.body = await req.json();
19
- break;
20
- }
21
- let init = {};
22
- const res = await orig(theReq);
23
- if (res) {
24
- if (res.statusCode)
25
- init.status = res.statusCode;
26
- if (res.data) {
27
- console.log({ init, res });
28
- return response.json(res.data, init);
29
- }
30
- else
31
- return new response(undefined, init);
32
- }
33
- else {
34
- const remult = await mw.getRemult(req);
35
- ctx.state.remult = remult;
36
- return ctx.next();
3
+ const server = buildRemultServer(options);
4
+ const orig = server.handle;
5
+ return Object.assign(server, {
6
+ freshHandler: async (req, ctx) => {
7
+ const theReq = {
8
+ method: req.method,
9
+ url: req.url,
10
+ body: undefined
11
+ };
12
+ switch (req.method.toLocaleLowerCase()) {
13
+ case "put":
14
+ case "post":
15
+ theReq.body = await req.json();
16
+ break;
17
+ }
18
+ let init = {};
19
+ const res = await orig(theReq);
20
+ if (res) {
21
+ init.status = res.statusCode;
22
+ if (res.data) {
23
+ return response.json(res.data, init);
37
24
  }
38
- ;
25
+ else
26
+ return new response(undefined, init);
39
27
  }
28
+ else {
29
+ return ctx.next();
30
+ }
31
+ ;
40
32
  }
41
- };
33
+ });
42
34
  }
43
35
  ;
36
+ ;
@@ -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 {};