@terreno/api 0.0.1

package/LICENSE

@@ -0,0 +1,202 @@
+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 2020 Josh Gachnang
+Copyright 2022 Flourish Health Inc.
+
+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,170 @@
+# @terreno/api
+
+This library attempts to make creating REST APIs much easier with Express and Mongoose.
+Most REST APIs wind up being a lot of boilerplate, so this tries to cut that down without turning
+into a full blown framework of its own. This library is inspired by the
+[Django-REST-Framework](https://www.django-rest-framework.org).
+
+### Coming soon:
+
+A frontend library to consume these APIs with Redux Toolkit Query.
+
+## Getting started
+
+To install:
+
+    npm install @terreno/api
+
+    yarn install @terreno/api
+    
+    bun install @terreno/api
+
+## DateOnly Type
+
+If you're using the `DateOnly` schema type from @terreno/api, you must register it with Mongoose as early as possible in your application—**before mongoose is imported elsewhere**. This ensures the custom type is available when your schemas are defined.
+
+Add this to the top of your entry point (e.g., `src/index.ts`):
+
+```typescript
+import {Schema} from "mongoose";
+import {DateOnly} from "@terreno/api";
+
+// Register DateOnly type before any models are loaded
+(Schema.Types as any).DateOnly = DateOnly;
+```
+
+Then you can use it in your schemas:
+
+```typescript
+const eventSchema = new Schema({
+  eventDate: {type: Schema.Types.DateOnly},
+});
+```
+
+## Usage
+
+Assuming we have a model:
+
+    const foodSchema = new Schema<Food>({
+      name: String,
+      hidden: {type: Boolean, default: false},
+      ownerId: {type: "ObjectId", ref: "User"},
+    });
+    export const FoodModel = model("Food", foodSchema);
+
+We can expose this model as an API like this:
+
+    import express from "express";
+    import {modelRouter, Permissions} from "@terreno/api";
+
+    const app = express();
+    app.use(
+      "/foods",
+      modelRouter(UserModel, {
+        permissions: {
+          list: [Permissions.IsAny],
+          create: [Permissions.IsAuthenticated],
+          read: [Permissions.IsAny],
+          update: [Permissions.IsOwner],
+          delete: [Permissions.IsAdmin],
+        },
+      })
+    );
+
+Now we can perform operations on the Food model in a standard REST way. We've also added some permissioning.
+
+    # Gets a list of foods. Anyone can do this without being authenticated.
+    GET /foods
+    {
+        data: [{_id: "62c86d787c7e2db0bf286acd", name: "Carrots", hidden: false, ownerId: "62c44d9f003d9f8ee8cc9256"}],
+        more: false,
+        page: 1,
+        limit: 100
+    }
+
+    # Get a specific food. Anyone can do this.
+    GET /foods/62c86d787c7e2db0bf286acd
+    {_id: "62c86d787c7e2db0bf286acd", name: "Carrots", hidden: false, ownerId: "62c44d9f003d9f8ee8cc9256"}
+
+    # Creates a new food. Only authenticated users are allowed to do this.
+    POST /foods {name: "Broccoli", ownerId: "62c44d9f003d9f8ee8cc9256"}
+    {_id: "62c86d787c7e2db0bf286000", name: "Broccoli", hidden: false, ownerId: "62c44d9f003d9f8ee8cc9256"}
+
+    # Updates an existing food. Only the owner of the food can do this, otherwise an error code is returned.
+    PATCH /foods/62c86d787c7e2db0bf286acd {name: "Peas And Carrots"}
+    {_id: "62c86d787c7e2db0bf286acd", name: "Peas And Carrots", hidden: false, ownerId: "62c44d9f003d9f8ee8cc9256"}
+
+    # Deletes an existing food. Only admins are allowed to do this (users with `user.admin` set to true).
+    DELETE /foods/62c86d787c7e2db0bf286acd
+
+You can create your own permissions functions. Check permissions.ts for some examples of how to write them.
+
+## Sentry
+To enable Sentry, create a "src/sentryInstrumment.ts" file in your project.
+
+```
+// Include dotenv here at the start if you're including configuration from dot files.
+import "dotenv/config";
+
+import * as Sentry from "@sentry/node";
+import {nodeProfilingIntegration} from "@sentry/profiling-node";
+
+if (process.env.NODE_ENV === "production" && !process.env.SENTRY_DSN) {
+  throw new Error("SENTRY_DSN must be set");
+}
+
+Sentry.init({
+  dsn: process.env.SENTRY_DSN,
+  integrations: [
+    // Only profile integration needs to be added, the rest are defaults and are already added,
+    // including Express, mongoose, HTTP, etc.
+    nodeProfilingIntegration() as any,
+  ],
+  // Debug can be helpful for figuruing out why something isn't working.
+  // debug: true,
+  environment: process.env.SENTRY_ENVIRONMENT ?? "production",
+  // Skip some errors if needed.
+  ignoreErrors: [
+    /^.*ECONNRESET*$/,
+    /^.*socket hang up*$/,
+  ],
+  // Set to 1.0 when testing the integration. Lower these to something like 0.1 or 0.2 in production. You can also use tracesSampler as a function to filter out ones
+  // you don't care about.
+  tracesSampleRate: 1.0,
+  profileSessionSampleRate: 1.0
+});
+```
+
+Then at the top of your src/index.ts file, before express is imported anywhere:
+
+```
+import "./sentryInstrument";
+```
+
+## Example
+
+To test out how the API works, you can look at and run [example.ts] by running `bun run compile` then running `bun dist/example.js` in /@terreno/api; while running, you can use a mongoDB client such as Compass to view collections.
+
+## Dev
+
+To continuously compile the package:
+
+    bun run dev
+
+To run tests, linting, and fixing up lint issues:
+
+    bun run lint
+    bun run lint:fix
+    bun run test
+
+To see how your changes will affect the docs:
+
+    bun run docs
+    cd docs/
+    bunx http-server
+
+A lot of dev may require using bun link. You'll want to keep the `bun run dev` window running to continuously compile:
+
+    bun link
+    cd $your-api-repo
+    bun link @terreno/api

package/biome.jsonc

@@ -0,0 +1,22 @@
+{
+  "root": false,
+  "$schema": "https://biomejs.dev/schemas/2.3.10/schema.json",
+  "extends": ["../biome.jsonc"],
+  "files": {
+    "includes": [
+      "package.json",
+      "src/**/*.ts",
+      "src/**/*.tsx",
+      "!src/populate.ts",
+      "!!src/populate.ts",
+      "!!**/node_modules",
+      "!!node_modules",
+      "!!**/dist",
+      "!!dist",
+      "!!**/build",
+      "!!build",
+      "!!**/coverage",
+      "!!coverage"
+    ]
+  }
+}

package/bunfig.toml

@@ -0,0 +1,4 @@
+[test]
+preload = ["./src/tests/bunSetup.ts"]
+root = "./src"
+

package/dist/api.d.ts

@@ -0,0 +1,227 @@
+import express, { type NextFunction, type Request, type Response } from "express";
+import mongoose, { type Document, type Model } from "mongoose";
+import { type User } from "./auth";
+import { type RESTPermissions } from "./permissions";
+import type { PopulatePath } from "./populate";
+import { type TerrenoTransformer } from "./transformers";
+export type JSONPrimitive = string | number | boolean | null;
+export interface JSONArray extends Array<JSONValue> {
+}
+export type JSONObject = {
+    [member: string]: JSONValue;
+};
+export type JSONValue = JSONPrimitive | JSONObject | JSONArray;
+export declare function addPopulateToQuery(builtQuery: mongoose.Query<any[], any, Record<string, never>, any>, populatePaths?: PopulatePath[]): mongoose.Query<any[], any, Record<string, never>, any, "find", Record<string, never>>;
+/**
+ * @param a - the first number
+ * @param b - the second number
+ * @returns The sum of `a` and `b`
+ */
+export type RESTMethod = "list" | "create" | "read" | "update" | "delete";
+/**
+ * This is the main configuration.
+ * @param T - the base document type. This should not include Mongoose models, just the types of the object.
+ */
+export interface modelRouterOptions<T> {
+    /**
+     * A group of method-level (create/read/update/delete/list) permissions.
+     * Determine if the user can perform the operation at all, and for read/update/delete methods,
+     * whether the user can perform the operation on the object referenced.
+     * */
+    permissions: RESTPermissions<T>;
+    /**
+     * Allow anonymous users to access the resource.
+     * Defaults to false.
+     */
+    allowAnonymous?: boolean;
+    /**
+     * A list of fields on the model that can be queried using standard comparisons for booleans,
+     * strings, dates
+     *    (as ISOStrings), and numbers.
+     * For example:
+     *  ?foo=true // boolean query
+     *  ?foo=bar // string query
+     *  ?foo=1 // number query
+     *  ?foo=2022-07-23T02:34:07.118Z // date query (should first be encoded for query params, not shown here)
+     * Note: `limit` and `page` are automatically supported and are reserved. */
+    queryFields?: string[];
+    /**
+     * queryFilter is a function to parse the query params and see if the query should be allowed.
+     * This can be used for permissioning to make sure less privileged users are not making
+     * privileged queries. If a query should not be allowed,
+     * return `null` from the function and an empty query result will be returned to the client
+     * without an error. You can also throw an APIError to be explicit about the issues.
+     * You can transform the given query params by returning different values.
+     * If the query is acceptable as-is, return `query` as-is.
+     */
+    queryFilter?: (user?: User, query?: Record<string, any>) => Record<string, any> | null | Promise<Record<string, any> | null>;
+    /**
+     * Transformers allow data to be transformed before actions are executed,
+     * and serialized before being returned to the user.
+     *
+     * Transformers can be used to throw out fields that the user should not be able to write to, such as the `admin` flag.
+     * Serializers can be used to hide data from the client or change how it is presented. Serializers run after the data
+     * has been changed or queried but before returning to the client.
+     * @deprecated Use preCreate/preUpdate/preDelete hooks instead of transformer.transform. Use serialize instead of
+     * transformer.serialize.
+     * */
+    transformer?: TerrenoTransformer<T>;
+    /** Default sort for list operations. Can be a single field, a space-seperated list of fields, or an object.
+     * ?sort=foo // single field: foo ascending
+     * ?sort=-foo // single field: foo descending
+     * ?sort=-foo bar // multi field: foo descending, bar ascending
+     * ?sort=\{foo: 'ascending', bar: 'descending'\} // object: foo ascending, bar descending
+     *
+     * Note: you should have an index field on these fields or Mongo may slow down considerably.
+     * */
+    sort?: string | {
+        [key: string]: "ascending" | "descending";
+    };
+    /**
+     * Default queries to provide to Mongo before any user queries or transforms happen when making
+     * list queries. Accepts any Mongoose-style queries, and runs for all user types.
+     *    defaultQueryParams: \{hidden: false\} // By default, don't show objects with hidden=true
+     * These can be overridden by the user if not disallowed by queryFilter. */
+    defaultQueryParams?: {
+        [key: string]: any;
+    };
+    /**
+     * Manages Mongoose populations before returning from all methods (list, read, create, etc).
+     * For each population:
+     *  path: Accepts Mongoose-style populate strings for path. e.g. "user" or "users.userId"
+     *    (for an array of subschemas with userId)
+     *  fields: An array of strings to filter on the populated objects, following Mongoose's select
+     *    rules. If each field starts a preceding "-", will act as a block list and only remove those
+     *    fields. If each field does not start with a "-", will act as an allow list and only
+     *    return those fields. Mixing allow and blocking is not supported. e.g. "-created updated"
+     *    is an error.
+     *  openApiComponent: If you have a component already registered,
+     *    use that instead of autogenerating the types for the populated fields.
+     *
+     */
+    populatePaths?: PopulatePath[];
+    /** Default limit applied to list queries if not specified by the user. Defaults to 100. */
+    defaultLimit?: number;
+    /**
+     * Maximum query limit the user can request. Defaults to 500, and is the lowest of the limit
+     * query, max limit,
+     *  or 500. */
+    maxLimit?: number;
+    /** */
+    endpoints?: (router: any) => void;
+    /**
+     * Hook that runs after `transformer.transform` but before the object is created.
+     * Can update the body fields based on the request or the user.
+     * Return null to return a generic 403 error. Throw an APIError to return a 400 with specific
+     * error information.
+     */
+    preCreate?: (value: any, request: express.Request) => T | Promise<T> | null;
+    /**
+     * Hook that runs after `transformer.transform` but before changes are made for update operations.
+     * Can update the body fields based on the request or the user.
+     * Also applies to all array operations. Return null to return a generic 403 error.
+     * Throw an APIError to return a 400 with specific error information.
+     *
+     * @param value - The request body relative to the model update (type: Partial<T>). Note: this does not contain the entire document to be updated, only the fields being updated.
+     * @param request - The Express request object.
+     */
+    preUpdate?: (value: Partial<T>, request: express.Request) => T | Promise<T> | null;
+    /**
+     * Hook that runs after `transformer.transform` but before the object is deleted.
+     * Return null to return a generic 403 error.
+     * Throw an APIError to return a 400 with specific error information.
+     *
+     * @param value - The document to be deleted, before the soft update of deleted: true (type: T).
+     * @param request - The Express request object.
+     */
+    preDelete?: (value: T, request: express.Request) => T | Promise<T> | null;
+    /**
+     * Hook that runs after the object is created but before the responseHandler serializes and
+     * returned. This is a good spot to perform dependent changes to other models or performing async
+     * tasks/side effects, such as sending a push notification.
+     * Throw an APIError to return a 400 with an error message.
+     */
+    postCreate?: (value: T, request: express.Request) => void | Promise<void>;
+    /**
+     * Hook that runs after the object is updated but before the responseHandler serializes and
+     * returned. This is a good spot to perform dependent changes to other models or perform async
+     * tasks/side effects, such as sending a push notification.
+     * Throw an APIError to return a 400 with an error message.
+     *
+     * @param value - The document after it has been updated (type: T).
+     * @param cleanedBody - The request body relative to the model update (type: Partial<T>).
+     * @param request - The Express request object.
+     * @param prevValue - The entire document before it was updated (type: T).
+     */
+    postUpdate?: (value: T, cleanedBody: Partial<T>, request: express.Request, prevValue: T) => void | Promise<void>;
+    /**
+     * Hook that runs after the object is deleted. This is a good spot to perform dependent changes
+     * to other models or performing async tasks/side effects, such as cascading object deletions.
+     * Throw an APIError to return a 400 with an error message.
+     *
+     * @param request - The Express request object.
+     * @param value - The document that was deleted, after the soft update of deleted: true (type: T).
+     */
+    postDelete?: (request: express.Request, value: T) => void | Promise<void>;
+    /** Hook that runs after the object is fetched but before it is serialized.
+     * Returns a promise so that asynchronous actions can be included in the function.
+     * Throw an APIError to return a 400 with an error message.
+     * @deprecated: Use responseHandler instead.
+     */
+    postGet?: (value: T, request: express.Request) => undefined | Promise<T>;
+    /** Hook that runs after the list of objects is fetched but before they are serialized.
+     * Returns a promise so that asynchronous actions can be included in the function.
+     * Throw an APIError to return a 400 with an error message.
+     * @deprecated: Use responseHandler instead.
+     */
+    postList?: (value: (Document<any, any, any> & T)[], request: express.Request) => Promise<(Document<any, any, any> & T)[]>;
+    /**
+     * Serialize an object or list of objects before returning to the client.
+     * This is a good spot to remove sensitive information from the object, such as passwords or API
+     * keys. Throw an APIError to return a 400 with an error message.
+     */
+    responseHandler?: (value: (Document<any, any, any> & T) | (Document<any, any, any> & T)[], method: "list" | "create" | "read" | "update" | "delete", request: express.Request, options: modelRouterOptions<T>) => Promise<JSONValue>;
+    /**
+     * The discriminatorKey that you passed when creating the Mongoose models. Defaults to __t. See:
+     * https://mongoosejs.com/docs/discriminators.html If this key is provided,
+     * you must provide the same key as part of the top level of the body when making performing
+     * update or delete operations on this model.
+     *    \{discriminatorKey: "__t"\}
+     *
+     *     PATCH \{__t: "SuperUser", name: "Foo"\} // __t is required or there will be a 404 error.
+     */
+    discriminatorKey?: string;
+    /**
+     * The OpenAPI generator for this server. This is used to generate the OpenAPI documentation.
+     */
+    openApi?: any;
+    /**
+     * Overwrite parts of the configuration for the OpenAPI generator.
+     * This will be merged with the generated configuration.
+     */
+    openApiOverwrite?: {
+        get?: any;
+        list?: any;
+        create?: any;
+        update?: any;
+        delete?: any;
+    };
+    /**
+     * Overwrite parts of the model properties for the OpenAPI generator.
+     * This will be merged with the generated configuration.
+     * This is useful if you add custom properties to the model during serialize, for example,
+     * that you want to be documented and typed in the SDK.
+     */
+    openApiExtraModelProperties?: any;
+}
+export declare function getModel(baseModel: Model<any>, body?: any, options?: modelRouterOptions<any>): mongoose.Model<any, {}, {}, {}, any, any, any>;
+/**
+ * Create a set of CRUD routes given a Mongoose model $baseModel and configuration options.
+ *
+ * @param baseModel A Mongoose Model
+ * @param options Options for configuring the REST API, such as permissions, transformers, and hooks.
+ */
+export declare function modelRouter<T>(baseModel: Model<T>, options: modelRouterOptions<T>): express.Router;
+export declare const asyncHandler: (fn: any) => (req: Request, res: Response, next: NextFunction) => Promise<any>;
+export declare const gooseRestRouter: typeof modelRouter;
+export type GooseRESTOptions<T> = modelRouterOptions<T>;