cloesce 0.0.5-unstable.3 → 0.0.5-unstable.5

package/dist/router/router.d.ts

@@ -1,7 +1,7 @@
 import { OrmWasmExports } from "./wasm.js";
-import { HttpResult } from "../ui/backend.js";
-import { Either, KeysOfType } from "../ui/common.js";
 import { CloesceAst, Model, ApiMethod, Service } from "../ast.js";
+import { Either } from "../common.js";
+import { KeysOfType, HttpResult } from "../ui/backend.js";
 /**
  * Dependency injection container, mapping an object type name to an instance of that object.
  *
@@ -15,177 +15,131 @@ export type DependencyContainer = Map<string, any>;
  */
 export type ConstructorRegistry = Record<string, new () => any>;
 /**
- * Singleton instance containing the cidl, constructor registry, and wasm binary.
+ * Singleton instance containing the CIDL, constructor registry, and wasm binary.
  * These values are guaranteed to never change throughout a workers lifetime.
  */
 export declare class RuntimeContainer {
-  readonly ast: CloesceAst;
-  readonly constructorRegistry: ConstructorRegistry;
-  readonly wasm: OrmWasmExports;
-  private static instance;
-  private constructor();
-  static init(
-    ast: CloesceAst,
-    constructorRegistry: ConstructorRegistry,
-    wasm?: WebAssembly.Instance,
-  ): Promise<void>;
-  static get(): RuntimeContainer;
-  /**
-   * Disposes the singleton instance. For testing purposes only.
-   */
-  static dispose(): void;
+    readonly ast: CloesceAst;
+    readonly constructorRegistry: ConstructorRegistry;
+    readonly wasm: OrmWasmExports;
+    private static instance;
+    private constructor();
+    static init(ast: CloesceAst, constructorRegistry: ConstructorRegistry, wasm?: WebAssembly.Instance): Promise<void>;
+    static get(): RuntimeContainer;
+    /**
+     * Disposes the singleton instance. For testing purposes only.
+     */
+    static dispose(): void;
 }
 /**
  * Given a request, this represents a map of each body / url  param name to
  * its actual value. Unknown, as the a request can be anything.
  */
 export type RequestParamMap = Record<string, unknown>;
-export type MiddlewareFn = (
-  di: DependencyContainer,
-) => Promise<HttpResult | void>;
-export type ResultMiddlewareFn = (
-  di: DependencyContainer,
-  result: HttpResult,
-) => Promise<HttpResult | void>;
+export type MiddlewareFn = (di: DependencyContainer) => Promise<HttpResult | void>;
+export type ResultMiddlewareFn = (di: DependencyContainer, result: HttpResult) => Promise<HttpResult | void>;
 /**
  * Expected states in which the router may exit.
  */
 export declare enum RouterError {
-  UnknownPrefix = 0,
-  UnknownRoute = 1,
-  UnmatchedHttpVerb = 2,
-  InstantiatedMethodMissingId = 3,
-  RequestMissingBody = 4,
-  RequestBodyMissingParameters = 5,
-  RequestBodyInvalidParameter = 6,
-  InstantiatedMethodMissingDataSource = 7,
-  MissingDependency = 8,
-  InvalidDatabaseQuery = 9,
-  ModelNotFound = 10,
-  UncaughtException = 11,
+    UnknownPrefix = 0,
+    UnknownRoute = 1,
+    UnmatchedHttpVerb = 2,
+    InstantiatedMethodMissingPrimaryKey = 3,
+    InstantiatedMethodMissingKeyParam = 4,
+    RequestMissingBody = 5,
+    RequestBodyMissingParameters = 6,
+    RequestBodyInvalidParameter = 7,
+    InstantiatedMethodMissingDataSource = 8,
+    MissingDependency = 9,
+    InvalidDatabaseQuery = 10,
+    ModelNotFound = 11,
+    UncaughtException = 12
 }
 export declare class CloesceApp {
-  routePrefix: string;
-  private globalMiddleware;
-  /**
-   * Registers global middleware which runs before any route matching.
-   *
-   * TODO: Middleware may violate the API contract and return unexpected types
-   *
-   * @param m - The middleware function to register.
-   */
-  onRequest(m: MiddlewareFn): void;
-  private resultMiddleware;
-  /**
-   * Registers middleware which runs after the response is generated, but before
-   * it is returned to the client.
-   *
-   * Optionally, return a new HttpResult to short-circuit the response.
-   *
-   * Errors thrown in response middleware are caught and returned as a 500 response.
-   *
-   * TODO: Middleware may violate the API contract and return unexpected types
-   *
-   * @param m - The middleware function to register.
-   */
-  onResult(m: ResultMiddlewareFn): void;
-  private namespaceMiddleware;
-  /**
-   * Registers middleware for a specific namespace (being, a model or service)
-   *
-   * Runs before request validation and method middleware.
-   *
-   * TODO: Middleware may violate the API contract and return unexpected types
-   *
-   * @typeParam T - The namespace type
-   * @param ctor - The namespace's constructor (used to derive its name).
-   * @param m - The middleware function to register.
-   */
-  onNamespace<T>(ctor: new () => T, m: MiddlewareFn): void;
-  private methodMiddleware;
-  /**
-   * Registers middleware for a specific method on a namespace
-   *
-   * Runs after namespace middleware and request validation.
-   *
-   * TODO: Middleware may violate the API contract and return unexpected types
-   *
-   * @typeParam T - The namespace type
-   * @param ctor - The namespace constructor
-   * @param method - The method name on the namespace.
-   * @param m - The middleware function to register.
-   */
-  onMethod<T>(
-    ctor: new () => T,
-    method: KeysOfType<T, (...args: any) => any>,
-    m: MiddlewareFn,
-  ): void;
-  private router;
-  /**
-   * Runs the Cloesce app. Intended to be called from the generated workers code.
-   */
-  run(
-    request: Request,
-    env: any,
-    ast: CloesceAst,
-    ctorReg: ConstructorRegistry,
-  ): Promise<Response>;
+    routePrefix: string;
+    static init(ast: CloesceAst, ctorReg: ConstructorRegistry): Promise<CloesceApp>;
+    private globalMiddleware;
+    /**
+     * Registers global middleware that runs before all requests.
+     *
+     * Runs before namespace middleware, request validation, and method middleware.
+     *
+     * TODO: Middleware may violate the API contract and return unexpected types
+     *
+     * @param m - The middleware function to register.
+     */
+    onRun(m: MiddlewareFn): void;
+    private namespaceMiddleware;
+    /**
+     * Registers middleware for a specific namespace (model or service)
+     *
+     * Runs before request validation and method middleware.
+     *
+     * TODO: Middleware may violate the API contract and return unexpected types
+     *
+     * @typeParam T - The namespace type
+     * @param ctor - The namespace's constructor (used to derive its name).
+     * @param m - The middleware function to register.
+     */
+    onNamespace<T>(ctor: new () => T, m: MiddlewareFn): void;
+    private methodMiddleware;
+    /**
+     * Registers middleware for a specific method on a namespace
+     *
+     * Runs after namespace middleware and request validation.
+     *
+     * TODO: Middleware may violate the API contract and return unexpected types
+     *
+     * @typeParam T - The namespace type
+     * @param ctor - The namespace constructor
+     * @param method - The method name on the namespace.
+     * @param m - The middleware function to register.
+     */
+    onMethod<T>(ctor: new () => T, method: KeysOfType<T, (...args: any) => any>, m: MiddlewareFn): void;
+    private router;
+    /**
+     * Runs the Cloesce app. Intended to be called from the generated workers code.
+     */
+    run(request: Request, env: any): Promise<Response>;
 }
 export type MatchedRoute = {
-  kind: "model" | "service";
-  namespace: string;
-  method: ApiMethod;
-  id: string | null;
-  model?: Model;
-  service?: Service;
+    kind: "model" | "service";
+    namespace: string;
+    method: ApiMethod;
+    primaryKey: string | null;
+    keyParams: Record<string, string>;
+    model?: Model;
+    service?: Service;
 };
 /**
  * Matches a request to an ApiInvocation
  * @param apiRoute The route from the domain to the actual API, ie https://foo.com/route/to/api => route/to/api/
  * @returns 404 or a matched route.
  */
-declare function matchRoute(
-  request: Request,
-  ast: CloesceAst,
-  routePrefix: string,
-): Either<HttpResult, MatchedRoute>;
+declare function matchRoute(request: Request, ast: CloesceAst, routePrefix: string): Either<HttpResult, MatchedRoute>;
 /**
  * Validates the request's body/search params against a ModelMethod
  * @returns 400 or a `RequestParamMap` consisting of each parameters name mapped to its value, and
  * a data source
  */
-declare function validateRequest(
-  request: Request,
-  ast: CloesceAst,
-  ctorReg: ConstructorRegistry,
-  route: MatchedRoute,
-): Promise<
-  Either<
-    HttpResult,
-    {
-      params: RequestParamMap;
-      dataSource: string | null;
-    }
-  >
->;
+declare function validateRequest(request: Request, ast: CloesceAst, ctorReg: ConstructorRegistry, route: MatchedRoute): Promise<Either<HttpResult, {
+    params: RequestParamMap;
+    dataSource: string | null;
+}>>;
 /**
  * Calls a method on a model given a list of parameters.
  * @returns 500 on an uncaught client error, 200 with a result body on success
  */
-declare function methodDispatch(
-  obj: any,
-  di: DependencyContainer,
-  route: MatchedRoute,
-  params: Record<string, unknown>,
-): Promise<HttpResult<unknown>>;
+declare function methodDispatch(obj: any, di: DependencyContainer, route: MatchedRoute, params: Record<string, unknown>): Promise<HttpResult<unknown>>;
 /**
  * For testing purposes
  */
 export declare const _cloesceInternal: {
-  matchRoute: typeof matchRoute;
-  validateRequest: typeof validateRequest;
-  methodDispatch: typeof methodDispatch;
-  RuntimeContainer: typeof RuntimeContainer;
+    matchRoute: typeof matchRoute;
+    validateRequest: typeof validateRequest;
+    methodDispatch: typeof methodDispatch;
+    RuntimeContainer: typeof RuntimeContainer;
 };
 export {};
-//# sourceMappingURL=router.d.ts.map
+//# sourceMappingURL=router.d.ts.map

package/dist/router/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/router/router.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAuB,MAAM,WAAW,CAAC;AAEhE,OAAO,EAAE,UAAU,EAAoB,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EACL,UAAU,EACV,KAAK,EACL,SAAS,EAET,OAAO,EAER,MAAM,WAAW,CAAC;AAGnB;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,CAAC,CAAC;AAEhE;;;GAGG;AACH,qBAAa,gBAAgB;aAGT,GAAG,EAAE,UAAU;aACf,mBAAmB,EAAE,mBAAmB;aACxC,IAAI,EAAE,cAAc;IAJtC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA+B;IACtD,OAAO;WAMM,IAAI,CACf,GAAG,EAAE,UAAU,EACf,mBAAmB,EAAE,mBAAmB,EACxC,IAAI,CAAC,EAAE,WAAW,CAAC,QAAQ;IAO7B,MAAM,CAAC,GAAG,IAAI,gBAAgB;IAI9B;;OAEG;IACH,MAAM,CAAC,OAAO;CAGf;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEtD,MAAM,MAAM,YAAY,GAAG,CACzB,EAAE,EAAE,mBAAmB,KACpB,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;AAEhC,MAAM,MAAM,kBAAkB,GAAG,CAC/B,EAAE,EAAE,mBAAmB,EACvB,MAAM,EAAE,UAAU,KACf,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;AAEhC;;GAEG;AACH,oBAAY,WAAW;IACrB,aAAa,IAAA;IACb,YAAY,IAAA;IACZ,iBAAiB,IAAA;IACjB,2BAA2B,IAAA;IAC3B,kBAAkB,IAAA;IAClB,4BAA4B,IAAA;IAC5B,2BAA2B,IAAA;IAC3B,mCAAmC,IAAA;IACnC,iBAAiB,IAAA;IACjB,oBAAoB,IAAA;IACpB,aAAa,KAAA;IACb,iBAAiB,KAAA;CAClB;AAED,qBAAa,UAAU;IACd,WAAW,EAAE,MAAM,CAAS;IAEnC,OAAO,CAAC,gBAAgB,CAAsB;IAE9C;;;;;;OAMG;IACI,SAAS,CAAC,CAAC,EAAE,YAAY;IAIhC,OAAO,CAAC,gBAAgB,CAA4B;IAEpD;;;;;;;;;;;OAWG;IACI,QAAQ,CAAC,CAAC,EAAE,kBAAkB;IAIrC,OAAO,CAAC,mBAAmB,CAA0C;IAErE;;;;;;;;;;OAUG;IACI,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,YAAY;IAQxD,OAAO,CAAC,gBAAgB,CACZ;IAEZ;;;;;;;;;;;OAWG;IACI,QAAQ,CAAC,CAAC,EACf,IAAI,EAAE,UAAU,CAAC,EACjB,MAAM,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,EAC5C,CAAC,EAAE,YAAY;YAcH,MAAM;IAqFpB;;OAEG;IACU,GAAG,CACd,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,UAAU,EACf,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,QAAQ,CAAC;CAuErB;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,SAAS,CAAC;IAClB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,iBAAS,UAAU,CACjB,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,UAAU,EACf,WAAW,EAAE,MAAM,GAClB,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,CA6DlC;AAED;;;;GAIG;AACH,iBAAe,eAAe,CAC5B,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,UAAU,EACf,OAAO,EAAE,mBAAmB,EAC5B,KAAK,EAAE,YAAY,GAClB,OAAO,CACR,MAAM,CAAC,UAAU,EAAE;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC,CAC3E,CAkFA;AAgED;;;GAGG;AACH,iBAAe,cAAc,CAC3B,GAAG,EAAE,GAAG,EACR,EAAE,EAAE,mBAAmB,EACvB,KAAK,EAAE,YAAY,EACnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CA2C9B;AAaD;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;CAK5B,CAAC"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/router/router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAe,MAAM,WAAW,CAAC;AAGxD,OAAO,EACL,UAAU,EACV,KAAK,EACL,SAAS,EAET,OAAO,EAER,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,MAAM,EAAiB,MAAM,cAAc,CAAC;AACrD,OAAO,EAAO,UAAU,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE/D;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,CAAC,CAAC;AAEhE;;;GAGG;AACH,qBAAa,gBAAgB;aAGT,GAAG,EAAE,UAAU;aACf,mBAAmB,EAAE,mBAAmB;aACxC,IAAI,EAAE,cAAc;IAJtC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA+B;IACtD,OAAO;WAMM,IAAI,CACf,GAAG,EAAE,UAAU,EACf,mBAAmB,EAAE,mBAAmB,EACxC,IAAI,CAAC,EAAE,WAAW,CAAC,QAAQ;IAO7B,MAAM,CAAC,GAAG,IAAI,gBAAgB;IAI9B;;OAEG;IACH,MAAM,CAAC,OAAO;CAGf;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEtD,MAAM,MAAM,YAAY,GAAG,CACzB,EAAE,EAAE,mBAAmB,KACpB,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;AAEhC,MAAM,MAAM,kBAAkB,GAAG,CAC/B,EAAE,EAAE,mBAAmB,EACvB,MAAM,EAAE,UAAU,KACf,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;AAEhC;;GAEG;AACH,oBAAY,WAAW;IACrB,aAAa,IAAA;IACb,YAAY,IAAA;IACZ,iBAAiB,IAAA;IACjB,mCAAmC,IAAA;IACnC,iCAAiC,IAAA;IACjC,kBAAkB,IAAA;IAClB,4BAA4B,IAAA;IAC5B,2BAA2B,IAAA;IAC3B,mCAAmC,IAAA;IACnC,iBAAiB,IAAA;IACjB,oBAAoB,KAAA;IACpB,aAAa,KAAA;IACb,iBAAiB,KAAA;CAClB;AAED,qBAAa,UAAU;IACd,WAAW,EAAE,MAAM,CAAS;WAEf,IAAI,CACtB,GAAG,EAAE,UAAU,EACf,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,UAAU,CAAC;IAKtB,OAAO,CAAC,gBAAgB,CAAsB;IAE9C;;;;;;;;OAQG;IACI,KAAK,CAAC,CAAC,EAAE,YAAY;IAI5B,OAAO,CAAC,mBAAmB,CAA0C;IAErE;;;;;;;;;;OAUG;IACI,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,EAAE,YAAY;IAUxD,OAAO,CAAC,gBAAgB,CACZ;IAEZ;;;;;;;;;;;OAWG;IACI,QAAQ,CAAC,CAAC,EACf,IAAI,EAAE,UAAU,CAAC,EACjB,MAAM,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,EAC5C,CAAC,EAAE,YAAY;YAiBH,MAAM;IA0DpB;;OAEG;IACU,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC;CAsEhE;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,SAAS,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,iBAAS,UAAU,CACjB,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,UAAU,EACf,WAAW,EAAE,MAAM,GAClB,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,CA0ElC;AAED;;;;GAIG;AACH,iBAAe,eAAe,CAC5B,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,UAAU,EACf,OAAO,EAAE,mBAAmB,EAC5B,KAAK,EAAE,YAAY,GAClB,OAAO,CACR,MAAM,CAAC,UAAU,EAAE;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC,CAC3E,CAmGA;AAoED;;;GAGG;AACH,iBAAe,cAAc,CAC3B,GAAG,EAAE,GAAG,EACR,EAAE,EAAE,mBAAmB,EACvB,KAAK,EAAE,YAAY,EACnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CA2C9B;AAaD;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;CAK5B,CAAC"}