@naturalcycles/backend-lib 9.20.0 → 9.22.0

package/cfg/tsconfig.json

@@ -61,8 +61,8 @@
     // Other
     "pretty": true,
     "newLine": "lf",
-    "experimentalDecorators": true,
-  },
+    "experimentalDecorators": true
+  }
   // Need to be specified in the project tsconfig
   // "include": ["src"],
   // "exclude": ["**/__exclude"]

package/dist/deploy/backend.cfg.util.js

@@ -5,7 +5,7 @@ import { yaml2 } from '@naturalcycles/nodejs-lib/yaml2';
 import { resourcesDir } from '../paths.cnst.js';
 const getBackendCfgSchema = _lazyValue(() => {
     const schemaJson = fs2.readJson(`${resourcesDir}/backendCfg.schema.json`);
-    return AjvSchema.create(schemaJson, { objectName: 'backend.cfg.yaml' });
+    return AjvSchema.create(schemaJson, { inputName: 'backend.cfg.yaml' });
 });
 export function getBackendCfg(projectDir = '.') {
     const backendCfgYamlPath = `${projectDir}/backend.cfg.yaml`;

package/dist/deploy/deployInfo.util.d.ts

@@ -1,2 +1 @@
-import type { DeployInfo } from './deploy.model.js';
-export declare const getDeployInfo: ((projectDir: string) => DeployInfo) & import("@naturalcycles/js-lib/decorators/memoFn.js").MemoizedFunction;
+export declare const getDeployInfo: any;

package/dist/validation/ajv/ajvValidateRequest.d.ts

@@ -5,15 +5,6 @@ declare class AjvValidateRequest {
     body<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
     query<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
     params<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
-    /**
-     * Validates `req.headers` against the provided schema.
-     *
-     * Note: as opposed to other methods, this method does not mutate `req.headers` in case of success,
-     * i.e. schemas that cast values will not have any effect.
-     *
-     * If you wish to mutate `req.headers` with the validated value, use `keepOriginal: false` option.
-     * Keep in mind that this will also remove all values that are not in the schema.
-     */
     headers<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
     private validate;
 }

package/dist/validation/ajv/ajvValidateRequest.js

@@ -9,30 +9,20 @@ class AjvValidateRequest {
     params(req, schema, opt = {}) {
         return this.validate(req, 'params', schema, opt);
     }
-    /**
-     * Validates `req.headers` against the provided schema.
-     *
-     * Note: as opposed to other methods, this method does not mutate `req.headers` in case of success,
-     * i.e. schemas that cast values will not have any effect.
-     *
-     * If you wish to mutate `req.headers` with the validated value, use `keepOriginal: false` option.
-     * Keep in mind that this will also remove all values that are not in the schema.
-     */
     headers(req, schema, opt = {}) {
         return this.validate(req, 'headers', schema, opt);
     }
     validate(req, reqProperty, schema, opt = {}) {
-        const { mutate } = opt;
-        const originalProperty = req[reqProperty] || {};
-        const item = mutate ? originalProperty : { ...originalProperty };
-        // Ajv mutates the input
-        const error = schema.getValidationError(item, {
-            objectName: `request ${reqProperty}`,
+        const { mutateInput = true } = opt;
+        const input = req[reqProperty] || {};
+        const [error, output] = schema.getValidationResult(input, {
+            mutateInput,
+            inputName: `request ${reqProperty}`,
         });
         if (error) {
-            handleValidationError(error, originalProperty, opt);
+            handleValidationError(error, input, opt);
         }
-        return item;
+        return output;
     }
 }
 export const ajvValidateRequest = new AjvValidateRequest();

package/dist/validation/joi/joiValidateRequest.js

@@ -23,10 +23,10 @@ class ValidateRequest {
         return this.validate(req, 'headers', schema, opt);
     }
     validate(req, reqProperty, schema, opt = {}) {
-        const { mutate } = opt;
+        const { mutateInput } = opt;
         const originalProperty = req[reqProperty] || {};
         // Joi does not mutate the input
-        const { error, value } = getValidationResult(originalProperty, schema, `request ${reqProperty}`);
+        const [error, value] = getValidationResult(originalProperty, schema, `request ${reqProperty}`);
         if (error) {
             if (opt.redactPaths) {
                 error.data.joiValidationErrorItems.length = 0; // clears the array
@@ -34,7 +34,7 @@ class ValidateRequest {
             }
             handleValidationError(error, originalProperty, opt);
         }
-        if (mutate) {
+        if (mutateInput) {
             req[reqProperty] = value;
         }
         return value;

package/dist/validation/validateRequest.util.d.ts

@@ -12,11 +12,10 @@ export interface ReqValidationOptions<ERR extends AppError> {
      */
     report?: boolean | ((err: ERR) => boolean);
     /**
-     * Defaults to false.
+     * Defaults to true.
      *
-     * When set to true, the validated object will be replaced with the converted value.
-     *
-     * To avoid mutation - shallow copy is performed.
+     * When set to true, input (body, query, headers or params) will be mutated.
+     * So, e.g req.body will already contain mutated data post-validation.
      */
-    mutate?: boolean;
+    mutateInput?: boolean;
 }

package/dist/validation/validateRequest.util.js

@@ -1,7 +1,6 @@
 import { AppError } from '@naturalcycles/js-lib/error/error.util.js';
 import { _get } from '@naturalcycles/js-lib/object/object.util.js';
 export function handleValidationError(error, originalProperty, opt = {}) {
-    // const item: T = opt.mutate ? { ...req[reqProperty] } : (req[reqProperty] || {})
     let report;
     if (typeof opt.report === 'boolean') {
         report = opt.report;

package/dist/validation/zod/zodValidateRequest.js

@@ -23,14 +23,14 @@ class ZodValidateRequest {
         return this.validate(req, 'headers', schema, opt);
     }
     validate(req, reqProperty, schema, opt = {}) {
-        const { mutate } = opt;
+        const { mutateInput } = opt;
         const originalProperty = req[reqProperty] || {};
         // Zod does not mutate the input
-        const { error, data } = zSafeValidate(originalProperty, schema);
+        const [error, data] = zSafeValidate(originalProperty, schema);
         if (error) {
             handleValidationError(error, originalProperty, opt);
         }
-        if (mutate) {
+        if (mutateInput) {
             req[reqProperty] = data;
         }
         return data;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.20.0",
+  "version": "9.22.0",
   "peerDependencies": {
     "@sentry/node": "^9"
   },
@@ -29,7 +29,7 @@
     "@sentry/node": "^9",
     "@types/ejs": "^3",
     "fastify": "^5",
-    "@naturalcycles/dev-lib": "18.4.2"
+    "@naturalcycles/dev-lib": "19.22.0"
   },
   "exports": {
     ".": "./dist/index.js",

package/src/deploy/backend.cfg.util.ts

@@ -42,7 +42,7 @@ export interface BackendCfg {
 
 const getBackendCfgSchema = _lazyValue(() => {
   const schemaJson = fs2.readJson<JsonSchema<BackendCfg>>(`${resourcesDir}/backendCfg.schema.json`)
-  return AjvSchema.create(schemaJson, { objectName: 'backend.cfg.yaml' })
+  return AjvSchema.create(schemaJson, { inputName: 'backend.cfg.yaml' })
 })
 
 export function getBackendCfg(projectDir = '.'): BackendCfg {

package/src/validation/ajv/ajvValidateRequest.ts

@@ -27,15 +27,6 @@ class AjvValidateRequest {
     return this.validate(req, 'params', schema, opt)
   }
 
-  /**
-   * Validates `req.headers` against the provided schema.
-   *
-   * Note: as opposed to other methods, this method does not mutate `req.headers` in case of success,
-   * i.e. schemas that cast values will not have any effect.
-   *
-   * If you wish to mutate `req.headers` with the validated value, use `keepOriginal: false` option.
-   * Keep in mind that this will also remove all values that are not in the schema.
-   */
   headers<T>(
     req: BackendRequest,
     schema: AjvSchema<T>,
@@ -50,20 +41,19 @@ class AjvValidateRequest {
     schema: AjvSchema<T>,
     opt: ReqValidationOptions<AjvValidationError> = {},
   ): T {
-    const { mutate } = opt
-    const originalProperty = req[reqProperty] || {}
-    const item: T = mutate ? originalProperty : { ...originalProperty }
+    const { mutateInput = true } = opt
+    const input: T = req[reqProperty] || {}
 
-    // Ajv mutates the input
-    const error = schema.getValidationError(item, {
-      objectName: `request ${reqProperty}`,
+    const [error, output] = schema.getValidationResult(input, {
+      mutateInput,
+      inputName: `request ${reqProperty}`,
     })
 
     if (error) {
-      handleValidationError(error, originalProperty, opt)
+      handleValidationError(error, input, opt)
     }
 
-    return item
+    return output
   }
 }
 

package/src/validation/joi/joiValidateRequest.ts

@@ -51,11 +51,11 @@ class ValidateRequest {
     schema: AnySchema<T>,
     opt: ReqValidationOptions<JoiValidationError> = {},
   ): T {
-    const { mutate } = opt
+    const { mutateInput } = opt
     const originalProperty = req[reqProperty] || {}
 
     // Joi does not mutate the input
-    const { error, value } = getValidationResult(originalProperty, schema, `request ${reqProperty}`)
+    const [error, value] = getValidationResult(originalProperty, schema, `request ${reqProperty}`)
 
     if (error) {
       if (opt.redactPaths) {
@@ -66,7 +66,7 @@ class ValidateRequest {
       handleValidationError(error, originalProperty, opt)
     }
 
-    if (mutate) {
+    if (mutateInput) {
       req[reqProperty] = value
     }
 

package/src/validation/validateRequest.util.ts

@@ -6,8 +6,6 @@ export function handleValidationError<T, ERR extends AppError>(
   originalProperty: T,
   opt: ReqValidationOptions<ERR> = {},
 ): never {
-  // const item: T = opt.mutate ? { ...req[reqProperty] } : (req[reqProperty] || {})
-
   let report: boolean | undefined
   if (typeof opt.report === 'boolean') {
     report = opt.report
@@ -54,11 +52,10 @@ export interface ReqValidationOptions<ERR extends AppError> {
   report?: boolean | ((err: ERR) => boolean)
 
   /**
-   * Defaults to false.
-   *
-   * When set to true, the validated object will be replaced with the converted value.
+   * Defaults to true.
    *
-   * To avoid mutation - shallow copy is performed.
+   * When set to true, input (body, query, headers or params) will be mutated.
+   * So, e.g req.body will already contain mutated data post-validation.
    */
-  mutate?: boolean
+  mutateInput?: boolean
 }

package/src/validation/zod/zodValidateRequest.ts

@@ -50,11 +50,11 @@ class ZodValidateRequest {
     schema: ZodType<T>,
     opt: ReqValidationOptions<ZodValidationError> = {},
   ): T {
-    const { mutate } = opt
+    const { mutateInput } = opt
     const originalProperty = req[reqProperty] || {}
 
     // Zod does not mutate the input
-    const { error, data } = zSafeValidate(
+    const [error, data] = zSafeValidate(
       originalProperty,
       schema,
       // opt2?.itemName,
@@ -64,7 +64,7 @@ class ZodValidateRequest {
       handleValidationError(error, originalProperty, opt)
     }
 
-    if (mutate) {
+    if (mutateInput) {
       req[reqProperty] = data
     }
 

package/dist/admin/login.html

@@ -1,150 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <title>Login</title>
-
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
-
-    <!-- CSS only -->
-    <link
-      href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.2/dist/css/bootstrap.min.css"
-      rel="stylesheet"
-      crossorigin="anonymous"
-    />
-  </head>
-  <body>
-    <div id="app" style="padding: 40px 50px">
-      <pre v-if="loading">Checking login...</pre>
-      <div v-else>
-        <div v-if="user">
-          <p>Logged in as:</p>
-          <pre><mark>{{ user.email }}</mark></pre>
-          <pre><mark>{{ user.token }}</mark></pre>
-          <button class="btn btn-primary btn-lg" @click="logout">Logout</button>
-        </div>
-        <div v-else>
-          <button class="btn btn-primary btn-lg" @click="login" id="loginBtn">Login</button>
-        </div>
-      </div>
-    </div>
-
-    <script type="module">
-      import { createApp } from 'https://cdn.jsdelivr.net/npm/vue@3.2.20/dist/vue.esm-browser.prod.js'
-      import { initializeApp } from 'https://www.gstatic.com/firebasejs/9.1.2/firebase-app.js'
-      import {
-        getAuth,
-        GoogleAuthProvider,
-        onAuthStateChanged,
-        signInWithRedirect,
-      } from 'https://www.gstatic.com/firebasejs/9.1.2/firebase-auth.js'
-
-      const apiKey = '<%= firebaseApiKey %>'
-      const authDomain = '<%= firebaseAuthDomain %>'
-      // const authProvider = '<%= firebaseAuthProvider %>'
-
-      if (!apiKey || !authDomain) {
-        alert(`Error: 'apiKey' or 'authDomain' is missing!`)
-      }
-
-      // Initialize Firebase
-      initializeApp({
-        apiKey,
-        authDomain,
-      })
-
-      const auth = getAuth()
-      const provider = new GoogleAuthProvider()
-
-      onAuthStateChanged(auth, user => {
-        // console.log('onAuthStateChanged, user: ', JSON.stringify(user, null, 2))
-        // console.log('onAuthStateChanged, user: ', user)
-        onUser(user)
-      })
-
-      const qs = Object.fromEntries(new URLSearchParams(location.search))
-      const { autoLogin, logout, returnUrl, adminTokenKey = 'admin_token' } = qs
-      // console.log(qs)
-
-      const app = createApp({
-        data() {
-          return {
-            loading: 'Loading...',
-            user: undefined,
-          }
-        },
-        methods: {
-          login: async function () {
-            try {
-              await signInWithRedirect(auth, provider)
-            } catch (err) {
-              logError(err)
-            }
-          },
-
-          logout: async function () {
-            try {
-              await auth.signOut()
-
-              await postToken('logout') // magic string
-
-              if (logout && returnUrl) {
-                alert('Logged out, redurecting back...')
-                location.href = returnUrl
-              }
-            } catch (err) {
-              logError(err)
-            }
-          },
-        },
-      }).mount('#app')
-
-      if (logout) app.logout()
-
-      ////
-
-      async function onUser(user) {
-        try {
-          // alert('onUser')
-          app.user = user
-          app.loading = false
-          if (!user) {
-            if (autoLogin) app.login()
-          } else {
-            const token = await auth.currentUser.getIdToken()
-
-            // alert('idToken')
-            // console.log(idToken)
-            app.user = Object.assign({}, app.user, {
-              token,
-            })
-
-            await postToken(token)
-
-            // Redirect if needed
-            if (returnUrl) {
-              // alert(`Logged in as ${app.user.email}, redirecting back...`)
-              location.href = returnUrl
-            }
-          }
-        } catch (err) {
-          logError(err)
-        }
-      }
-
-      function logError(err) {
-        console.error(err)
-        alert('Error\n ' + JSON.stringify(err, null, 2))
-      }
-
-      async function postToken(token) {
-        await fetch(`/admin/login`, {
-          method: 'post',
-          headers: {
-            Authentication: token,
-          },
-        })
-      }
-    </script>
-  </body>
-</html>

package/dist/deploy/files-default/.gcloudignore

@@ -1,7 +0,0 @@
-#
-# .gcloudignore
-#
-.gcloudignore
-.git
-.gitignore
-node_modules/