cloesce 0.0.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,23 @@
+# cloesce
+
+View the [internal documentation](https://cloesce.pages.dev)
+
+### Unit Tests
+
+- `src/extractor/ts` run `npm test`
+- `src/generator` run `cargo test`
+
+### Integration Tests
+
+- To run the regression tests: `cargo run --bin test regression`
+- To run the pass fail extractor tests: `cargo run --bin test run-fail`
+
+Optionally, pass `--check` if new snapshots should not be created.
+
+### E2E
+
+- `tests/e2e` run `npm test`
+
+### Code Formatting
+
+- `cargo fmt`, `cargo clippy`, `npm run format:fix`

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,337 @@
+#!/usr/bin/env node
+import { WASI } from "node:wasi";
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { command, run, subcommands, flag, option, optional, string, } from "cmd-ts";
+import { Project } from "ts-morph";
+import { CidlExtractor } from "./extract.js";
+import { ExtractorError, ExtractorErrorCode, getErrorInfo } from "./common.js";
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const WASM_PATH = path.join(__dirname, "..", "dist", "cli.wasm");
+function loadCloesceConfig(root, debug = false) {
+    const configPath = path.join(root, "cloesce-config.json");
+    if (fs.existsSync(configPath)) {
+        try {
+            const config = JSON.parse(fs.readFileSync(configPath, "utf8"));
+            if (debug)
+                console.log(`Loaded config from ${configPath}`);
+            return config;
+        }
+        catch (err) {
+            console.warn(`Failed to parse cloesce-config.json: ${err}`);
+        }
+    }
+    return {};
+}
+function readPackageJsonProjectName(cwd) {
+    const pkgPath = path.join(cwd, "package.json");
+    let projectName = path.basename(cwd);
+    if (fs.existsSync(pkgPath)) {
+        const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+        projectName = pkg.name ?? projectName;
+    }
+    return projectName;
+}
+function findCloesceProject(root, searchPaths, project) {
+    for (const searchPath of searchPaths) {
+        let fullPath;
+        if (path.isAbsolute(searchPath) || searchPath.startsWith(root)) {
+            fullPath = path.normalize(searchPath);
+        }
+        else {
+            fullPath = path.resolve(root, searchPath);
+        }
+        if (!fs.existsSync(fullPath)) {
+            console.warn(`Warning: Path "${searchPath}" does not exist`);
+            continue;
+        }
+        const stats = fs.statSync(fullPath);
+        if (stats.isFile() && /\.cloesce\.ts$/i.test(fullPath)) {
+            project.addSourceFileAtPath(fullPath);
+        }
+        else if (stats.isDirectory()) {
+            walkDirectory(fullPath, project);
+        }
+    }
+    function walkDirectory(dir, project) {
+        for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+            const fullPath = path.join(dir, entry.name);
+            if (entry.isDirectory() && !entry.name.startsWith(".")) {
+                walkDirectory(fullPath, project);
+            }
+            else if (entry.isFile() && /\.cloesce\.ts$/i.test(entry.name)) {
+                project.addSourceFileAtPath(fullPath);
+            }
+        }
+    }
+}
+function formatErr(e) {
+    const { description, suggestion } = getErrorInfo(e.code);
+    const contextLine = e.context ? `Context: ${e.context}\n` : "";
+    const snippetLine = e.snippet ? `${e.snippet}\n\n` : "";
+    return `==== CLOESCE ERROR ====
+Error [${ExtractorErrorCode[e.code]}]: ${description}
+Phase: TypeScript IDL Extraction
+${contextLine}${snippetLine}Suggested fix: ${suggestion}`;
+}
+async function runExtractor(opts) {
+    const root = process.cwd();
+    const projectRoot = process.cwd();
+    const config = loadCloesceConfig(projectRoot, opts.debug);
+    const searchPaths = opts.inp ? [opts.inp] : (config.paths ?? [root]);
+    const outputDir = config.outputDir ?? ".generated";
+    const outPath = opts.out ?? path.join(outputDir, "cidl.json");
+    const truncate = opts.truncateSourcePaths ?? config.truncateSourcePaths ?? false;
+    const cloesceProjectName = opts.projectName ??
+        config.projectName ??
+        readPackageJsonProjectName(projectRoot);
+    const project = new Project({
+        compilerOptions: {
+            strictNullChecks: true,
+        },
+    });
+    findCloesceProject(root, searchPaths, project);
+    const fileCount = project.getSourceFiles().length;
+    if (fileCount === 0) {
+        new ExtractorError(ExtractorErrorCode.MissingFile);
+    }
+    if (opts.debug)
+        console.log(`Found ${fileCount} .cloesce.ts files`);
+    try {
+        const extractor = new CidlExtractor(cloesceProjectName, "v0.0.3");
+        const result = extractor.extract(project);
+        if (!result.ok) {
+            console.error(formatErr(result.value));
+            process.exit(1);
+        }
+        let ast = result.value;
+        if (truncate) {
+            ast.wrangler_env.source_path =
+                "./" + path.basename(ast.wrangler_env.source_path);
+            for (const model of Object.values(ast.models)) {
+                model.source_path =
+                    "./" + path.basename(model.source_path);
+            }
+            if (ast.poos) {
+                for (const poo of Object.values(ast.poos)) {
+                    poo.source_path =
+                        "./" + path.basename(poo.source_path);
+                }
+            }
+        }
+        const json = JSON.stringify(ast, null, 4);
+        fs.mkdirSync(path.dirname(outPath), { recursive: true });
+        fs.writeFileSync(outPath, json);
+        console.log(`CIDL generated successfully at ${outPath}`);
+        return { outPath, projectName: cloesceProjectName };
+    }
+    catch (err) {
+        console.error("Critical uncaught error. Submit a ticket to https://github.com/bens-schreiber/cloesce: ", err?.message ?? err);
+        process.exit(1);
+    }
+}
+async function runWasmCommand(config) {
+    const root = process.cwd();
+    const outputDir = ".generated";
+    const wranglerPath = path.join(root, outputDir, "wrangler.toml");
+    if (!fs.existsSync(wranglerPath)) {
+        fs.mkdirSync(path.dirname(wranglerPath), { recursive: true });
+        fs.writeFileSync(wranglerPath, "");
+    }
+    const wasi = new WASI({
+        version: "preview1",
+        args: [path.basename(WASM_PATH), ...config.args],
+        env: { ...process.env, ...config.env },
+        preopens: { "/": root },
+    });
+    const bytes = fs.readFileSync(WASM_PATH);
+    const mod = await WebAssembly.compile(bytes);
+    const instance = await WebAssembly.instantiate(mod, {
+        wasi_snapshot_preview1: wasi.wasiImport,
+    });
+    try {
+        wasi.start(instance);
+    }
+    catch (err) {
+        console.error(`WASM execution failed for ${config.name}:`, err);
+    }
+}
+const runCmd = command({
+    name: "run",
+    description: "Extract CIDL and run all code generators",
+    args: {
+        debug: flag({
+            long: "debug",
+            short: "d",
+            description: "Show debug output",
+        }),
+    },
+    handler: async (args) => {
+        const config = loadCloesceConfig(process.cwd(), args.debug);
+        if (!config.workersUrl || !config.clientUrl) {
+            console.error("Error: workersUrl and clientUrl must be defined in cloesce-config.json");
+            process.exit(1);
+        }
+        await runExtractor({ debug: args.debug });
+        // in case the user wants to dump their generated files somewhere else
+        // we should allow them to define that directory in the config
+        const outputDir = config.outputDir ?? ".generated";
+        const allConfig = {
+            name: "all",
+            wasmFile: "cli.wasm",
+            args: [
+                "generate",
+                "all",
+                path.join(outputDir, "cidl.json"),
+                path.join(outputDir, "wrangler.toml"),
+                path.join(outputDir, "migrations.sql"),
+                path.join(outputDir, "workers.ts"),
+                path.join(outputDir, "client.ts"),
+                config.clientUrl,
+                config.workersUrl,
+            ],
+        };
+        await runWasmCommand(allConfig);
+    },
+});
+// In case the user wants to run individual steps we should probably allow them
+const wranglerCmd = command({
+    name: "wrangler",
+    description: "Generate wrangler.toml configuration",
+    args: {},
+    handler: async () => {
+        const config = loadCloesceConfig(process.cwd());
+        const outputDir = config.outputDir ?? ".generated";
+        await runWasmCommand({
+            name: "wrangler",
+            wasmFile: "cli.wasm",
+            args: ["generate", "wrangler", path.join(outputDir, "wrangler.toml")],
+        });
+    },
+});
+const d1Cmd = command({
+    name: "d1",
+    description: "Generate database schema",
+    args: {},
+    handler: async () => {
+        const config = loadCloesceConfig(process.cwd());
+        const outputDir = config.outputDir ?? ".generated";
+        await runWasmCommand({
+            name: "d1",
+            wasmFile: "cli.wasm",
+            args: [
+                "generate",
+                "d1",
+                path.join(outputDir, "cidl.json"),
+                path.join(outputDir, "migrations.sql"),
+            ],
+        });
+    },
+});
+const workersCmd = command({
+    name: "workers",
+    description: "Generate workers TypeScript",
+    args: {},
+    handler: async () => {
+        const config = loadCloesceConfig(process.cwd());
+        const outputDir = config.outputDir ?? ".generated";
+        if (!config.workersUrl) {
+            console.error("Error: workersUrl must be defined in cloesce-config.json");
+            process.exit(1);
+        }
+        await runWasmCommand({
+            name: "workers",
+            wasmFile: "cli.wasm",
+            args: [
+                "generate",
+                "workers",
+                path.join(outputDir, "cidl.json"),
+                path.join(outputDir, "workers.ts"),
+                path.join(outputDir, "wrangler.toml"),
+                config.workersUrl,
+            ],
+        });
+    },
+});
+const clientCmd = command({
+    name: "client",
+    description: "Generate client TypeScript",
+    args: {},
+    handler: async () => {
+        const config = loadCloesceConfig(process.cwd());
+        const outputDir = config.outputDir ?? ".generated";
+        if (!config.clientUrl) {
+            console.error("Error: clientUrl must be defined in cloesce-config.json");
+            process.exit(1);
+        }
+        await runWasmCommand({
+            name: "client",
+            wasmFile: "cli.wasm",
+            args: [
+                "generate",
+                "client",
+                path.join(outputDir, "cidl.json"),
+                path.join(outputDir, "client.ts"),
+                config.clientUrl,
+            ],
+        });
+    },
+});
+const extractCmd = command({
+    name: "extract",
+    description: "Extract models and write cidl.json only",
+    args: {
+        projectName: option({
+            long: "project-name",
+            type: optional(string),
+            description: "Project name",
+        }),
+        out: option({
+            long: "out",
+            short: "o",
+            type: optional(string),
+            description: "Output path (default: .generated/cidl.json)",
+        }),
+        inp: option({
+            long: "in",
+            short: "i",
+            type: optional(string),
+            description: "Input file or directory",
+        }),
+        location: option({
+            long: "location",
+            short: "l",
+            type: optional(string),
+            description: "Project directory (default: cwd)",
+        }),
+        truncateSourcePaths: flag({
+            long: "truncateSourcePaths",
+            description: "Sets all source paths to just their file name",
+        }),
+        debug: flag({
+            long: "debug",
+            short: "d",
+            description: "Show debug output",
+        }),
+    },
+    handler: async (args) => {
+        await runExtractor({ ...args });
+    },
+});
+const router = subcommands({
+    name: "cloesce",
+    cmds: {
+        run: runCmd,
+        extract: extractCmd,
+        wrangler: wranglerCmd,
+        d1: d1Cmd,
+        workers: workersCmd,
+        client: clientCmd,
+    },
+});
+run(router, process.argv.slice(2)).catch((err) => {
+    console.error(err);
+    process.exit(1);
+});

package/dist/cloesce.d.ts

@@ -0,0 +1,108 @@
+import { D1Database } from "@cloudflare/workers-types/experimental/index.js";
+import { HttpResult, Either, ModelMethod, CloesceAst, Model } from "./common.js";
+import { IncludeTree } from "./index.js";
+/**
+ * A map of model names to their respective constructor.
+ *
+ * The value accepted into the `cloesce` function is generated by the Cloesce compiler, and
+ * is guaranteed to contain all model definitions.
+ */
+type ModelConstructorRegistry = Record<string, new () => UserDefinedModel>;
+/**
+ * A dependency injection container, mapping an object type name to an instance of that object.
+ *
+ * The value accepted into the `cloesce` function is generated by the Cloesce compiler, and is
+ * guaranteed to contain all injected model method parameters.
+ */
+type InstanceRegistry = Map<string, any>;
+/**
+ * Users will create Cloesce models, which have metadata for them in the ast.
+ * For TypeScript's purposes, these models can be anything. We can assume any
+ * `UserDefinedModel` has been verified by the compiler.
+ */
+type UserDefinedModel = any;
+type InstantiatedUserDefinedModel = object;
+/**
+ * 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.
+ */
+type RequestParamMap = Record<string, unknown>;
+/**
+ * Meta information on the wrangler env and db bindings
+ */
+interface MetaWranglerEnv {
+    envName: string;
+    dbName: string;
+}
+/**
+ * Creates model instances given a properly formatted SQL record
+ * (either a foreign-key-less model or derived from a Cloesce generated view)
+ * @param ctor The type of the model
+ * @param records SQL records
+ * @param includeTree The include tree to use when parsing the records
+ * @returns
+ */
+export declare function modelsFromSql<T>(ctor: new () => T, records: Record<string, any>[], includeTree: IncludeTree<T> | null): T[];
+/**
+ * Cloesce entry point. Given a request, undergoes routing, validating,
+ * hydrating, and method dispatch.
+ * @param ast The CIDL AST
+ * @param constructorRegistry A mapping of user defined class names to their respective constructor
+ * @param instanceRegistry A mapping of a dependency class name to its instantiated object.
+ * @param request An incoming request to the workers server
+ * @param api_route The url's path to the api, e.g. api/v1/fooapi/
+ * @param envMeta Meta information on the wrangler env and D1 databases
+ * @returns A Response with an `HttpResult` JSON body.
+ */
+export declare function cloesce(request: Request, ast: CloesceAst, constructorRegistry: ModelConstructorRegistry, instanceRegistry: InstanceRegistry, envMeta: MetaWranglerEnv, api_route: string): Promise<Response>;
+/**
+ * Matches a request to a method on a model.
+ * @param api_route The route from the domain to the actual API, ie https://foo.com/route/to/api => route/to/api/
+ * @returns 404 or a `MatchedRoute`
+ */
+declare function matchRoute(request: Request, ast: CloesceAst, api_route: 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, model: Model, method: ModelMethod, id: string | null): Promise<Either<HttpResult, [RequestParamMap, string | null]>>;
+/**
+ * Queries D1 for a particular model's ID, then transforms the SQL column output into
+ * an instance of a model using the provided include tree and metadata as a guide.
+ * @returns 404 if no record was found for the provided ID
+ * @returns 500 if the D1 database is not synced with Cloesce and yields an error
+ * @returns The instantiated model on success
+ */
+declare function hydrateModel(ast: CloesceAst, constructorRegistry: ModelConstructorRegistry, d1: D1Database, model: Model, id: string, dataSource: string | null): Promise<Either<HttpResult, object>>;
+/**
+ * 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(instance: InstantiatedUserDefinedModel, instanceRegistry: InstanceRegistry, envMeta: MetaWranglerEnv, method: ModelMethod, params: Record<string, unknown>): Promise<HttpResult<unknown>>;
+/**
+ * Actual implementation of sql to model mapping.
+ *
+ * TODO: If we don't want to write this in every language, would it be possible to create a
+ * single WASM binary for this method?
+ *
+ * @throws generic errors if the metadata is missing some value
+ */
+declare function _modelsFromSql(modelName: string, ast: CloesceAst, constructorRegistry: ModelConstructorRegistry, records: Record<string, any>[], includeTree: Record<string, UserDefinedModel> | null): InstantiatedUserDefinedModel[];
+interface MatchedRoute {
+    model: Model;
+    method: ModelMethod;
+    id: string | null;
+}
+/**
+ * Each individual state of the `cloesce` function for testing purposes.
+ */
+export declare const _cloesceInternal: {
+    matchRoute: typeof matchRoute;
+    validateRequest: typeof validateRequest;
+    hydrateModel: typeof hydrateModel;
+    methodDispatch: typeof methodDispatch;
+    _modelsFromSql: typeof _modelsFromSql;
+};
+export {};
+//# sourceMappingURL=cloesce.d.ts.map