npm - @terreno/api - Versions diffs - 0.7.0 → 0.7.2 - Mend

@terreno/api 0.7.0 → 0.7.2

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.

Files changed (40) hide show

package/dist/__tests__/versionCheck.test.d.ts +1 -0
package/dist/__tests__/versionCheck.test.js +263 -0
package/dist/expressServer.js +2 -2
package/dist/index.d.ts +2 -0
package/dist/index.js +2 -0
package/dist/models/versionConfig.d.ts +17 -0
package/dist/models/versionConfig.js +66 -0
package/dist/terrenoApp.js +2 -2
package/dist/vendor/wesleytodd-openapi/index.d.ts +27 -0
package/dist/vendor/wesleytodd-openapi/index.js +176 -0
package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +2 -0
package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +13 -0
package/dist/vendor/wesleytodd-openapi/lib/generate-doc.d.ts +2 -0
package/dist/vendor/wesleytodd-openapi/lib/generate-doc.js +148 -0
package/dist/vendor/wesleytodd-openapi/lib/layer-schema.d.ts +2 -0
package/dist/vendor/wesleytodd-openapi/lib/layer-schema.js +12 -0
package/dist/vendor/wesleytodd-openapi/lib/minimum-doc.d.ts +6 -0
package/dist/vendor/wesleytodd-openapi/lib/minimum-doc.js +11 -0
package/dist/vendor/wesleytodd-openapi/lib/ui.d.ts +1 -0
package/dist/vendor/wesleytodd-openapi/lib/ui.js +37 -0
package/dist/vendor/wesleytodd-openapi/lib/validate.d.ts +2 -0
package/dist/vendor/wesleytodd-openapi/lib/validate.js +168 -0
package/dist/versionCheckPlugin.d.ts +15 -0
package/dist/versionCheckPlugin.js +106 -0
package/package.json +9 -2
package/src/__tests__/versionCheck.test.ts +132 -0
package/src/expressServer.ts +1 -2
package/src/index.ts +2 -0
package/src/models/versionConfig.ts +92 -0
package/src/terrenoApp.ts +1 -2
package/src/vendor/wesleytodd-openapi/LICENSE +15 -0
package/src/vendor/wesleytodd-openapi/index.js +189 -0
package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +13 -0
package/src/vendor/wesleytodd-openapi/lib/generate-doc.js +153 -0
package/src/vendor/wesleytodd-openapi/lib/layer-schema.js +13 -0
package/src/vendor/wesleytodd-openapi/lib/minimum-doc.js +12 -0
package/src/vendor/wesleytodd-openapi/lib/ui.js +71 -0
package/src/vendor/wesleytodd-openapi/lib/validate.js +152 -0
package/src/versionCheckPlugin.ts +81 -0
package/tsconfig.json +1 -1

package/src/vendor/wesleytodd-openapi/lib/ui.js ADDED Viewed

@@ -0,0 +1,71 @@
+// Vendored from https://github.com/wesleytodd/express-openapi (branch: express-5)
+// License: ISC (see ../LICENSE)
+'use strict'
+const path = require('path')
+const serve = require('serve-static')
+module.exports.serveSwaggerUI = function serveSwaggerUI (documentUrl, opts = {}) {
+  const { plugins, ...options } = opts
+  return [serve(path.resolve(require.resolve('swagger-ui-dist'), '..'), { index: false }),
+    function returnUiInit (req, res, next) {
+      if (req.path.endsWith('/swagger-ui-init.js')) {
+        res.type('.js')
+        res.send(`window.onload = function () {
+  window.ui = SwaggerUIBundle({
+    url: '${documentUrl}',
+    dom_id: '#swagger-ui',
+    ${plugins?.length ? `plugins: [${plugins}],` : ''}
+    ...${JSON.stringify(options)}
+  })
+}`
+        )
+      } else {
+        next()
+      }
+    },
+    function renderSwaggerHtml (req, res) {
+      res.type('html').send(renderHtmlPage('Swagger UI', `
+      <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
+    `, `
+      <div id="swagger-ui"></div>
+      <script src="./swagger-ui-bundle.js"></script>
+      <script src="./swagger-ui-standalone-preset.js"></script>
+      <script src="./swagger-ui-init.js"></script>
+    `))
+    }
+  ]
+}
+function renderHtmlPage (title, head, body) {
+  return `<!DOCTYPE html>
+<html>
+  <head>
+    <title>${title}</title>
+    <meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <style>
+      html {
+          box-sizing: border-box;
+          overflow: -moz-scrollbars-vertical;
+          overflow-y: scroll;
+      }
+      *,
+      *:before,
+      *:after {
+          box-sizing: inherit;
+      }
+      body {
+        margin: 0;
+        padding: 0;
+        background: #fafafa;
+      }
+    </style>
+    ${head}
+  </head>
+  <body>
+    ${body}
+  </body>
+</html>
+  `
+}

package/src/vendor/wesleytodd-openapi/lib/validate.js ADDED Viewed

@@ -0,0 +1,152 @@
+// Vendored from https://github.com/wesleytodd/express-openapi (branch: express-5)
+// License: ISC (see ../LICENSE)
+'use strict'
+const Ajv = require('ajv')
+const addFormats = require('ajv-formats')
+const addKeywords = require('ajv-keywords')
+const httpErrors = require('http-errors')
+const BASE_REQ_SCHEMA = {
+  type: 'object',
+  required: ['headers', 'params', 'query'],
+  properties: {
+    headers: {
+      type: 'object',
+      required: [],
+      properties: {}
+    },
+    params: {
+      type: 'object',
+      required: [],
+      properties: {}
+    },
+    query: {
+      type: 'object',
+      required: [],
+      properties: {}
+    },
+    body: {
+      type: 'object',
+      required: [],
+      properties: {}
+    }
+  }
+}
+module.exports = function makeValidatorMiddleware (middleware, schema, opts) {
+  let ajv
+  let validate
+  function makeValidator () {
+    const reqSchema = structuredClone(BASE_REQ_SCHEMA)
+    // Compile req schema on first request
+    // Build param validation
+    schema.parameters && schema.parameters.forEach((p) => {
+      switch (p.in) {
+        case 'path':
+          reqSchema.properties.params.properties[p.name] = p.schema
+          p.required && !reqSchema.properties.params.required.includes(p.name) && reqSchema.properties.params.required.push(p.name)
+          break
+        case 'query':
+          reqSchema.properties.query.properties[p.name] = p.schema
+          p.required && !reqSchema.properties.query.required.includes(p.name) && reqSchema.properties.query.required.push(p.name)
+          break
+        case 'header': {
+          const name = p.name.toLowerCase()
+          reqSchema.properties.headers.properties[name] = p.schema
+          p.required && !reqSchema.properties.headers.required.includes(p.name) && reqSchema.properties.headers.required.push(name)
+          break
+        }
+      }
+    })
+    // Compile req body schema
+    schema.requestBody && Object.entries(schema.requestBody.content)
+      .forEach(([contentType, { schema }]) => {
+        switch (contentType) {
+          case 'application/json':
+            reqSchema.properties.body = schema
+            break
+          default:
+            throw new TypeError(`Validation of content type not supported: ${contentType}`)
+        }
+      })
+    // Add components for references
+    reqSchema.components = middleware.document && middleware.document.components
+    return ajv.compile(reqSchema)
+  }
+  return function validateMiddleware (req, res, next) {
+    // Restrict validation to only "route" layers
+    // This prevents running any validation
+    // if we are in a .use call which could
+    // be a non-routable request thus
+    if (!req.route) {
+      return next()
+    }
+    // Create ajv instance on first request
+    if (!ajv) {
+      ajv = new Ajv({
+        coerceTypes: opts.coerce === 'false' ? opts.coerce : true,
+        strict: opts.strict === true ? opts.strict : false
+      })
+      addFormats(ajv)
+      if (middleware.router && !middleware.router.handle) {
+        return next()
+      }
+      if (opts.keywords) { addKeywords(ajv, opts.keywords) }
+    }
+    if (!validate) {
+      validate = makeValidator()
+    }
+    // Validate request
+    let r = req
+    if (opts.coerce !== true) {
+      r = makeReqCopy(req)
+    } else {
+      // Redifine query and params as normal objects we can write to, so we can coerce the data
+      Object.defineProperty(req, 'query', {
+        value: { ...req.query },
+        writable: true,
+        enumerable: true,
+        configurable: true
+      })
+      Object.defineProperty(req, 'params', {
+        value: { ...req.params },
+        writable: true,
+        enumerable: true,
+        configurable: true
+      })
+    }
+    const validationStatus = validate(r)
+    if (validationStatus === true) {
+      return next()
+    }
+    // build error?
+    const err = new Error('Request validation failed')
+    err.validationErrors = validate.errors
+    err.validationSchema = validate.schema
+    next(httpErrors(400, err))
+  }
+}
+// This is because ajv modifies the original data,
+// preventing this requires that we dont pass the
+// actual req.  An issue has been opened (@TODO open the issue)
+function makeReqCopy (req) {
+  return JSON.parse(JSON.stringify({
+    headers: req.headers,
+    params: req.params,
+    query: req.query,
+    body: req.body
+  }))
+}

package/src/versionCheckPlugin.ts ADDED Viewed

@@ -0,0 +1,81 @@
+import type express from "express";
+import {asyncHandler} from "./api";
+import {VersionConfig} from "./models/versionConfig";
+import type {TerrenoPlugin} from "./terrenoPlugin";
+export type VersionCheckStatus = "ok" | "warning" | "required";
+export interface VersionCheckResponse {
+  message?: string;
+  status: VersionCheckStatus;
+  updateUrl?: string;
+}
+const DEFAULT_WARNING_MESSAGE =
+  "A new version is available. Please update for the best experience.";
+const DEFAULT_REQUIRED_MESSAGE = "This version is no longer supported. Please update to continue.";
+/**
+ * TerrenoPlugin that adds a public GET /version-check endpoint for upgrade enforcement.
+ * Compares client build number against admin-configured thresholds per platform.
+ */
+export class VersionCheckPlugin implements TerrenoPlugin {
+  register(app: express.Application): void {
+    app.get(
+      "/version-check",
+      asyncHandler(async (req, res) => {
+        const versionParam = req.query.version;
+        const platform = req.query.platform as string | undefined;
+        const version =
+          typeof versionParam === "string"
+            ? parseInt(versionParam, 10)
+            : typeof versionParam === "number"
+              ? versionParam
+              : undefined;
+        if (version === undefined || Number.isNaN(version)) {
+          return res.json({status: "ok" as VersionCheckStatus});
+        }
+        const platformNormalized = platform === "web" || platform === "mobile" ? platform : "web";
+        const config = await VersionConfig.findOneOrNone({_singleton: "config"});
+        if (!config) {
+          return res.json({status: "ok" as VersionCheckStatus});
+        }
+        const requiredVersion =
+          platformNormalized === "web"
+            ? (config.webRequiredVersion ?? 0)
+            : (config.mobileRequiredVersion ?? 0);
+        const warningVersion =
+          platformNormalized === "web"
+            ? (config.webWarningVersion ?? 0)
+            : (config.mobileWarningVersion ?? 0);
+        const response: VersionCheckResponse = {
+          status: "ok",
+        };
+        if (requiredVersion > 0 && version < requiredVersion) {
+          response.status = "required";
+          response.message = config.requiredMessage ?? DEFAULT_REQUIRED_MESSAGE;
+          if (config.updateUrl) {
+            response.updateUrl = config.updateUrl;
+          }
+        } else if (warningVersion > 0 && version < warningVersion) {
+          response.status = "warning";
+          response.message = config.warningMessage ?? DEFAULT_WARNING_MESSAGE;
+          if (config.updateUrl) {
+            response.updateUrl = config.updateUrl;
+          }
+        }
+        return res.json(response);
+      })
+    );
+  }
+}

package/tsconfig.json CHANGED Viewed

@@ -56,5 +56,5 @@
     "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
   },
   "exclude": ["node_modules"],
-  "include": ["src/**/*.ts*", "src/*.ts", "types.d.ts"]
+  "include": ["src/**/*.ts*", "src/*.ts", "src/**/*.js", "types.d.ts"]
 }