@terreno/api 0.7.2 → 0.8.0

package/dist/types/consentResponse.d.ts

@@ -0,0 +1,23 @@
+import type mongoose from "mongoose";
+import type { FindExactlyOnePlugin, FindOneOrNonePlugin } from "../plugins";
+export type ConsentResponseMethods = {};
+export type ConsentResponseStatics = FindExactlyOnePlugin<ConsentResponseDocument> & FindOneOrNonePlugin<ConsentResponseDocument>;
+export type ConsentResponseModel = mongoose.Model<ConsentResponseDocument, object, ConsentResponseMethods> & ConsentResponseStatics;
+export interface ConsentResponseDocument extends mongoose.Document {
+    _id: mongoose.Types.ObjectId;
+    userId: mongoose.Types.ObjectId;
+    consentFormId: mongoose.Types.ObjectId;
+    agreed: boolean;
+    agreedAt: Date;
+    checkboxValues?: Map<string, boolean>;
+    locale: string;
+    signature?: string;
+    signedAt?: Date;
+    ipAddress?: string;
+    userAgent?: string;
+    contentSnapshot?: string;
+    formVersionSnapshot?: number;
+    created: Date;
+    updated: Date;
+    deleted: boolean;
+}

package/dist/types/consentResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/vendor/wesleytodd-openapi/lib/generate-doc.js

@@ -108,7 +108,7 @@ function processComplexMatch(thing, keys) {
         // (i.e. /:id, /:name, etc...) with the name(s) of those parameter(s)
         // This could have been accomplished with replaceAll for Node version 15 and above
         // no-useless-escape is disabled since we need three backslashes
-        .replace(/\(\?\:\(\[\^\\\/\]\+\?\)\)/g, function () { return "{".concat(keys[i++].name, "}"); }) // eslint-disable-line no-useless-escape
+        .replace(/\(\?\:\(\[\^\\\/\]\+\?\)\)/g, function () { return "{".concat(keys[i++].name, "}"); })
         .replace(/\\(.)/g, '$1')
         // The replace below removes the regex used at the start of the string and
         // the regex used to match the query parameters

package/dist/versionCheckPlugin.d.ts

@@ -3,8 +3,10 @@ import type { TerrenoPlugin } from "./terrenoPlugin";
 export type VersionCheckStatus = "ok" | "warning" | "required";
 export interface VersionCheckResponse {
     message?: string;
+    requiredVersion?: number;
     status: VersionCheckStatus;
     updateUrl?: string;
+    warningVersion?: number;
 }
 /**
  * TerrenoPlugin that adds a public GET /version-check endpoint for upgrade enforcement.

package/dist/versionCheckPlugin.js

@@ -80,21 +80,18 @@ var VersionCheckPlugin = /** @class */ (function () {
                             ? ((_c = config.webWarningVersion) !== null && _c !== void 0 ? _c : 0)
                             : ((_d = config.mobileWarningVersion) !== null && _d !== void 0 ? _d : 0);
                         response = {
+                            requiredVersion: requiredVersion > 0 ? requiredVersion : undefined,
                             status: "ok",
+                            updateUrl: config.updateUrl || undefined,
+                            warningVersion: warningVersion > 0 ? warningVersion : undefined,
                         };
                         if (requiredVersion > 0 && version < requiredVersion) {
                             response.status = "required";
                             response.message = (_e = config.requiredMessage) !== null && _e !== void 0 ? _e : DEFAULT_REQUIRED_MESSAGE;
-                            if (config.updateUrl) {
-                                response.updateUrl = config.updateUrl;
-                            }
                         }
                         else if (warningVersion > 0 && version < warningVersion) {
                             response.status = "warning";
                             response.message = (_f = config.warningMessage) !== null && _f !== void 0 ? _f : DEFAULT_WARNING_MESSAGE;
-                            if (config.updateUrl) {
-                                response.updateUrl = config.updateUrl;
-                            }
                         }
                         return [2 /*return*/, res.json(response)];
                 }

package/package.json

@@ -100,5 +100,5 @@
     "updateSnapshot": "bun test --update-snapshots"
   },
   "types": "dist/index.d.ts",
-  "version": "0.7.2"
+  "version": "0.8.0"
 }

package/src/__tests__/{versionCheck.test.ts → versionCheckPlugin.test.ts}

@@ -52,7 +52,7 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 150});
     expect(res.status).toBe(200);
-    expect(res.body).toEqual({status: "ok"});
+    expect(res.body).toEqual({requiredVersion: 50, status: "ok", warningVersion: 100});
   });
 
   it("returns warning when client version < warning (web)", async () => {
@@ -116,7 +116,7 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 100});
     expect(res.status).toBe(200);
-    expect(res.body).toEqual({status: "ok"});
+    expect(res.body).toEqual({requiredVersion: 50, status: "ok", warningVersion: 100});
   });
 
   it("version equal to required returns warning not required", async () => {

package/src/api.ts

@@ -160,8 +160,8 @@ export interface ModelRouterOptions<T> {
    * query, max limit,
    *  or 500. */
   maxLimit?: number; // defaults to 500
-  /** */
-  endpoints?: (router: any) => void;
+  /** Custom route setup function. Receives the router and optionally the full options (including openApi). */
+  endpoints?: (router: any, options?: Partial<ModelRouterOptions<T>>) => 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.
@@ -416,6 +416,8 @@ export interface ModelRouterRegistration {
   path: string;
   /** The Express router containing CRUD endpoints */
   router: express.Router;
+  /** @internal Rebuilds the router with the openApi instance injected into options */
+  _buildWithOpenApi: (openApi: any) => express.Router;
 }
 
 /**
@@ -459,7 +461,12 @@ export function modelRouter<T>(
   const router = _buildModelRouter(model, options);
 
   if (path !== undefined) {
-    return {__type: "modelRouter", path, router};
+    return {
+      __type: "modelRouter",
+      _buildWithOpenApi: (openApi: any) => _buildModelRouter(model, {...options, openApi}),
+      path,
+      router,
+    };
   }
   return router;
 }
@@ -469,7 +476,7 @@ function _buildModelRouter<T>(model: Model<T>, options: ModelRouterOptions<T>):
 
   // Do before the other router options so endpoints take priority.
   if (options.endpoints) {
-    options.endpoints(router);
+    options.endpoints(router, options);
   }
 
   const responseHandler = options.responseHandler ?? defaultResponseHandler;