cloesce 0.0.5-unstable.2 → 0.0.5-unstable.3

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.
@@ -4,4 +4,4 @@ import { D1Database } from "@cloudflare/workers-types/experimental/index.js";
4
4
  * calling a default implementation.
5
5
  */
6
6
  export declare function proxyCrud(obj: any, ctor: any, d1: D1Database): any;
7
- //# sourceMappingURL=crud.d.ts.map
7
+ //# sourceMappingURL=crud.d.ts.map
@@ -6,55 +6,54 @@ import { NO_DATA_SOURCE } from "../ast.js";
6
6
  * calling a default implementation.
7
7
  */
8
8
  export function proxyCrud(obj, ctor, d1) {
9
- return new Proxy(obj, {
10
- get(target, method) {
11
- // If the instance defines the method, always use it (override allowed)
12
- const value = Reflect.get(target, method);
13
- if (typeof value === "function") {
14
- return value.bind(target);
15
- }
16
- // Fallback to CRUD methods
17
- if (method === "save") {
18
- return (body, ds) => upsert(ctor, body, ds, d1);
19
- }
20
- if (method === "list") {
21
- return (ds) => list(ctor, ds, d1);
22
- }
23
- if (method === "get") {
24
- return (id, ds) => _get(ctor, id, ds, d1);
25
- }
26
- return value;
27
- },
28
- });
9
+ return new Proxy(obj, {
10
+ get(target, method) {
11
+ // If the instance defines the method, always use it (override allowed)
12
+ const value = Reflect.get(target, method);
13
+ if (typeof value === "function") {
14
+ return value.bind(target);
15
+ }
16
+ // Fallback to CRUD methods
17
+ if (method === "save") {
18
+ return (body, ds) => upsert(ctor, body, ds, d1);
19
+ }
20
+ if (method === "list") {
21
+ return (ds) => list(ctor, ds, d1);
22
+ }
23
+ if (method === "get") {
24
+ return (id, ds) => _get(ctor, id, ds, d1);
25
+ }
26
+ return value;
27
+ },
28
+ });
29
29
  }
30
30
  async function upsert(ctor, body, dataSource, d1) {
31
- const includeTree = findIncludeTree(dataSource, ctor);
32
- const orm = Orm.fromD1(d1);
33
- const result = await orm.upsert(ctor, body, includeTree);
34
- if (result.isLeft())
35
- return HttpResult.fail(500, result.value);
36
- const getRes = await orm.get(ctor, result.value, includeTree);
37
- return getRes.isRight()
38
- ? HttpResult.ok(200, getRes.value)
39
- : HttpResult.fail(500, getRes.value);
31
+ const includeTree = findIncludeTree(dataSource, ctor);
32
+ const orm = Orm.fromD1(d1);
33
+ const result = await orm.upsert(ctor, body, includeTree);
34
+ if (result.isLeft()) return HttpResult.fail(500, result.value);
35
+ const getRes = await orm.get(ctor, result.value, includeTree);
36
+ return getRes.isRight()
37
+ ? HttpResult.ok(200, getRes.value)
38
+ : HttpResult.fail(500, getRes.value);
40
39
  }
41
40
  async function _get(ctor, id, dataSource, d1) {
42
- const includeTree = findIncludeTree(dataSource, ctor);
43
- const orm = Orm.fromD1(d1);
44
- const res = await orm.get(ctor, id, includeTree);
45
- return res.isRight()
46
- ? HttpResult.ok(200, res.value)
47
- : HttpResult.fail(500, res.value);
41
+ const includeTree = findIncludeTree(dataSource, ctor);
42
+ const orm = Orm.fromD1(d1);
43
+ const res = await orm.get(ctor, id, includeTree);
44
+ return res.isRight()
45
+ ? HttpResult.ok(200, res.value)
46
+ : HttpResult.fail(500, res.value);
48
47
  }
49
48
  async function list(ctor, dataSource, d1) {
50
- const includeTree = findIncludeTree(dataSource, ctor);
51
- const orm = Orm.fromD1(d1);
52
- const res = await orm.list(ctor, { includeTree });
53
- return res.isRight()
54
- ? HttpResult.ok(200, res.value)
55
- : HttpResult.fail(500, res.value);
49
+ const includeTree = findIncludeTree(dataSource, ctor);
50
+ const orm = Orm.fromD1(d1);
51
+ const res = await orm.list(ctor, { includeTree });
52
+ return res.isRight()
53
+ ? HttpResult.ok(200, res.value)
54
+ : HttpResult.fail(500, res.value);
56
55
  }
57
56
  function findIncludeTree(dataSource, ctor) {
58
- const normalizedDs = dataSource === NO_DATA_SOURCE ? null : dataSource;
59
- return normalizedDs ? ctor[normalizedDs] : null;
57
+ const normalizedDs = dataSource === NO_DATA_SOURCE ? null : dataSource;
58
+ return normalizedDs ? ctor[normalizedDs] : null;
60
59
  }
@@ -19,136 +19,173 @@ export type ConstructorRegistry = Record<string, new () => any>;
19
19
  * These values are guaranteed to never change throughout a workers lifetime.
20
20
  */
21
21
  export declare class RuntimeContainer {
22
- readonly ast: CloesceAst;
23
- readonly constructorRegistry: ConstructorRegistry;
24
- readonly wasm: OrmWasmExports;
25
- private static instance;
26
- private constructor();
27
- static init(ast: CloesceAst, constructorRegistry: ConstructorRegistry, wasm?: WebAssembly.Instance): Promise<void>;
28
- static get(): RuntimeContainer;
29
- /**
30
- * Disposes the singleton instance. For testing purposes only.
31
- */
32
- static dispose(): void;
22
+ readonly ast: CloesceAst;
23
+ readonly constructorRegistry: ConstructorRegistry;
24
+ readonly wasm: OrmWasmExports;
25
+ private static instance;
26
+ private constructor();
27
+ static init(
28
+ ast: CloesceAst,
29
+ constructorRegistry: ConstructorRegistry,
30
+ wasm?: WebAssembly.Instance,
31
+ ): Promise<void>;
32
+ static get(): RuntimeContainer;
33
+ /**
34
+ * Disposes the singleton instance. For testing purposes only.
35
+ */
36
+ static dispose(): void;
33
37
  }
34
38
  /**
35
39
  * Given a request, this represents a map of each body / url param name to
36
40
  * its actual value. Unknown, as the a request can be anything.
37
41
  */
38
42
  export type RequestParamMap = Record<string, unknown>;
39
- export type MiddlewareFn = (di: DependencyContainer) => Promise<HttpResult | void>;
40
- export type ResultMiddlewareFn = (di: DependencyContainer, result: HttpResult) => Promise<HttpResult | void>;
43
+ export type MiddlewareFn = (
44
+ di: DependencyContainer,
45
+ ) => Promise<HttpResult | void>;
46
+ export type ResultMiddlewareFn = (
47
+ di: DependencyContainer,
48
+ result: HttpResult,
49
+ ) => Promise<HttpResult | void>;
41
50
  /**
42
51
  * Expected states in which the router may exit.
43
52
  */
44
53
  export declare enum RouterError {
45
- UnknownPrefix = 0,
46
- UnknownRoute = 1,
47
- UnmatchedHttpVerb = 2,
48
- InstantiatedMethodMissingId = 3,
49
- RequestMissingBody = 4,
50
- RequestBodyMissingParameters = 5,
51
- RequestBodyInvalidParameter = 6,
52
- InstantiatedMethodMissingDataSource = 7,
53
- MissingDependency = 8,
54
- InvalidDatabaseQuery = 9,
55
- ModelNotFound = 10,
56
- UncaughtException = 11
54
+ UnknownPrefix = 0,
55
+ UnknownRoute = 1,
56
+ UnmatchedHttpVerb = 2,
57
+ InstantiatedMethodMissingId = 3,
58
+ RequestMissingBody = 4,
59
+ RequestBodyMissingParameters = 5,
60
+ RequestBodyInvalidParameter = 6,
61
+ InstantiatedMethodMissingDataSource = 7,
62
+ MissingDependency = 8,
63
+ InvalidDatabaseQuery = 9,
64
+ ModelNotFound = 10,
65
+ UncaughtException = 11,
57
66
  }
58
67
  export declare class CloesceApp {
59
- routePrefix: string;
60
- private globalMiddleware;
61
- /**
62
- * Registers global middleware which runs before any route matching.
63
- *
64
- * TODO: Middleware may violate the API contract and return unexpected types
65
- *
66
- * @param m - The middleware function to register.
67
- */
68
- onRequest(m: MiddlewareFn): void;
69
- private resultMiddleware;
70
- /**
71
- * Registers middleware which runs after the response is generated, but before
72
- * it is returned to the client.
73
- *
74
- * Optionally, return a new HttpResult to short-circuit the response.
75
- *
76
- * Errors thrown in response middleware are caught and returned as a 500 response.
77
- *
78
- * TODO: Middleware may violate the API contract and return unexpected types
79
- *
80
- * @param m - The middleware function to register.
81
- */
82
- onResult(m: ResultMiddlewareFn): void;
83
- private namespaceMiddleware;
84
- /**
85
- * Registers middleware for a specific namespace (being, a model or service)
86
- *
87
- * Runs before request validation and method middleware.
88
- *
89
- * TODO: Middleware may violate the API contract and return unexpected types
90
- *
91
- * @typeParam T - The namespace type
92
- * @param ctor - The namespace's constructor (used to derive its name).
93
- * @param m - The middleware function to register.
94
- */
95
- onNamespace<T>(ctor: new () => T, m: MiddlewareFn): void;
96
- private methodMiddleware;
97
- /**
98
- * Registers middleware for a specific method on a namespace
99
- *
100
- * Runs after namespace middleware and request validation.
101
- *
102
- * TODO: Middleware may violate the API contract and return unexpected types
103
- *
104
- * @typeParam T - The namespace type
105
- * @param ctor - The namespace constructor
106
- * @param method - The method name on the namespace.
107
- * @param m - The middleware function to register.
108
- */
109
- onMethod<T>(ctor: new () => T, method: KeysOfType<T, (...args: any) => any>, m: MiddlewareFn): void;
110
- private router;
111
- /**
112
- * Runs the Cloesce app. Intended to be called from the generated workers code.
113
- */
114
- run(request: Request, env: any, ast: CloesceAst, ctorReg: ConstructorRegistry): Promise<Response>;
68
+ routePrefix: string;
69
+ private globalMiddleware;
70
+ /**
71
+ * Registers global middleware which runs before any route matching.
72
+ *
73
+ * TODO: Middleware may violate the API contract and return unexpected types
74
+ *
75
+ * @param m - The middleware function to register.
76
+ */
77
+ onRequest(m: MiddlewareFn): void;
78
+ private resultMiddleware;
79
+ /**
80
+ * Registers middleware which runs after the response is generated, but before
81
+ * it is returned to the client.
82
+ *
83
+ * Optionally, return a new HttpResult to short-circuit the response.
84
+ *
85
+ * Errors thrown in response middleware are caught and returned as a 500 response.
86
+ *
87
+ * TODO: Middleware may violate the API contract and return unexpected types
88
+ *
89
+ * @param m - The middleware function to register.
90
+ */
91
+ onResult(m: ResultMiddlewareFn): void;
92
+ private namespaceMiddleware;
93
+ /**
94
+ * Registers middleware for a specific namespace (being, a model or service)
95
+ *
96
+ * Runs before request validation and method middleware.
97
+ *
98
+ * TODO: Middleware may violate the API contract and return unexpected types
99
+ *
100
+ * @typeParam T - The namespace type
101
+ * @param ctor - The namespace's constructor (used to derive its name).
102
+ * @param m - The middleware function to register.
103
+ */
104
+ onNamespace<T>(ctor: new () => T, m: MiddlewareFn): void;
105
+ private methodMiddleware;
106
+ /**
107
+ * Registers middleware for a specific method on a namespace
108
+ *
109
+ * Runs after namespace middleware and request validation.
110
+ *
111
+ * TODO: Middleware may violate the API contract and return unexpected types
112
+ *
113
+ * @typeParam T - The namespace type
114
+ * @param ctor - The namespace constructor
115
+ * @param method - The method name on the namespace.
116
+ * @param m - The middleware function to register.
117
+ */
118
+ onMethod<T>(
119
+ ctor: new () => T,
120
+ method: KeysOfType<T, (...args: any) => any>,
121
+ m: MiddlewareFn,
122
+ ): void;
123
+ private router;
124
+ /**
125
+ * Runs the Cloesce app. Intended to be called from the generated workers code.
126
+ */
127
+ run(
128
+ request: Request,
129
+ env: any,
130
+ ast: CloesceAst,
131
+ ctorReg: ConstructorRegistry,
132
+ ): Promise<Response>;
115
133
  }
116
134
  export type MatchedRoute = {
117
- kind: "model" | "service";
118
- namespace: string;
119
- method: ApiMethod;
120
- id: string | null;
121
- model?: Model;
122
- service?: Service;
135
+ kind: "model" | "service";
136
+ namespace: string;
137
+ method: ApiMethod;
138
+ id: string | null;
139
+ model?: Model;
140
+ service?: Service;
123
141
  };
124
142
  /**
125
143
  * Matches a request to an ApiInvocation
126
144
  * @param apiRoute The route from the domain to the actual API, ie https://foo.com/route/to/api => route/to/api/
127
145
  * @returns 404 or a matched route.
128
146
  */
129
- declare function matchRoute(request: Request, ast: CloesceAst, routePrefix: string): Either<HttpResult, MatchedRoute>;
147
+ declare function matchRoute(
148
+ request: Request,
149
+ ast: CloesceAst,
150
+ routePrefix: string,
151
+ ): Either<HttpResult, MatchedRoute>;
130
152
  /**
131
153
  * Validates the request's body/search params against a ModelMethod
132
154
  * @returns 400 or a `RequestParamMap` consisting of each parameters name mapped to its value, and
133
155
  * a data source
134
156
  */
135
- declare function validateRequest(request: Request, ast: CloesceAst, ctorReg: ConstructorRegistry, route: MatchedRoute): Promise<Either<HttpResult, {
136
- params: RequestParamMap;
137
- dataSource: string | null;
138
- }>>;
157
+ declare function validateRequest(
158
+ request: Request,
159
+ ast: CloesceAst,
160
+ ctorReg: ConstructorRegistry,
161
+ route: MatchedRoute,
162
+ ): Promise<
163
+ Either<
164
+ HttpResult,
165
+ {
166
+ params: RequestParamMap;
167
+ dataSource: string | null;
168
+ }
169
+ >
170
+ >;
139
171
  /**
140
172
  * Calls a method on a model given a list of parameters.
141
173
  * @returns 500 on an uncaught client error, 200 with a result body on success
142
174
  */
143
- declare function methodDispatch(obj: any, di: DependencyContainer, route: MatchedRoute, params: Record<string, unknown>): Promise<HttpResult<unknown>>;
175
+ declare function methodDispatch(
176
+ obj: any,
177
+ di: DependencyContainer,
178
+ route: MatchedRoute,
179
+ params: Record<string, unknown>,
180
+ ): Promise<HttpResult<unknown>>;
144
181
  /**
145
182
  * For testing purposes
146
183
  */
147
184
  export declare const _cloesceInternal: {
148
- matchRoute: typeof matchRoute;
149
- validateRequest: typeof validateRequest;
150
- methodDispatch: typeof methodDispatch;
151
- RuntimeContainer: typeof RuntimeContainer;
185
+ matchRoute: typeof matchRoute;
186
+ validateRequest: typeof validateRequest;
187
+ methodDispatch: typeof methodDispatch;
188
+ RuntimeContainer: typeof RuntimeContainer;
152
189
  };
153
190
  export {};
154
- //# sourceMappingURL=router.d.ts.map
191
+ //# sourceMappingURL=router.d.ts.map