@researchdatabox/redbox-core-types 5.1.0-beta.12573 → 5.1.0-beta.13939

package/browser/redoc-library-loader.cjs

@@ -0,0 +1,20 @@
+const { createHash } = require('node:crypto');
+
+// ReDoc 3.0.1 inlines DOMPurify even in its library build. Replace that entire
+// module with our installed dependency, rather than shipping a second sanitizer.
+// Fail closed when the pinned upstream artifact changes; review the new module
+// boundaries and repeat the emitted-bundle security test before updating them.
+module.exports = function redocLibraryLoader(source) {
+  const digest = createHash('sha256').update(source).digest('hex');
+  if (digest !== '09470eddd0727b75e52d8a393bc742f44a2704364f79b557890a42c0bfd36449') {
+    throw new Error('Unexpected ReDoc library artifact: review the DOMPurify replacement before building');
+  }
+  const start = source.indexOf('/*! @license DOMPurify 3.4.16');
+  const end = source.indexOf('Ry,Hre=o(', start);
+  const sanitizer = source.slice(start, end);
+  if (createHash('sha256').update(sanitizer).digest('hex') !== '4817ba27f180a033c6b92f5c46b0586fd1d39f490514515a7151ea97096f1547') {
+    throw new Error('Unexpected embedded DOMPurify module');
+  }
+  return "import portalDOMPurify from 'dompurify';\n" + source.slice(0, start) +
+    'var Ly=portalDOMPurify,Vre=()=>{},' + source.slice(end);
+};

package/browser/redoc-standalone.js

@@ -0,0 +1,143 @@
+/*!
+The MIT License (MIT)
+
+Copyright (c) 2015-present, Rebilly, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+// ReDoc 3 standalone adapter, built with our installed React and sanitizer.
+// Adapted from Redocly/redoc src/standalone.tsx at fc5257dc (MIT).
+const React = require('react');
+const { createRoot, hydrateRoot } = require('react-dom/client');
+const { configure } = require('mobx');
+const { HashRouter } = require('react-router');
+const { RedocStandalone, RedoclyApiDocsStandalone, prepareApiDocs, logoFromSpec } = require('redoc');
+const metadata = require('redoc/package.json');
+
+configure({ useProxies: 'ifavailable' });
+
+const roots = new WeakMap();
+const hydrationTimers = new WeakMap();
+const hydrationRequests = new WeakMap();
+
+function cancelHydration(element) {
+  clearTimeout(hydrationTimers.get(element));
+  hydrationTimers.delete(element);
+  hydrationRequests.delete(element);
+}
+
+function elementOptions(element) {
+  const options = {};
+  for (const attribute of element.attributes) {
+    const name = attribute.name.replace(/-(.)/g, (_, character) => character.toUpperCase());
+    options[name] = attribute.name === 'theme' ? JSON.parse(attribute.value) : attribute.value;
+  }
+  return options;
+}
+
+function resolveArgs(specOrUrl, options, element) {
+  const { router, basePath, ...settings } = { ...options, ...elementOptions(element) };
+  const isUrl = typeof specOrUrl === 'string' && !specOrUrl.includes('\n') &&
+    /^[^\s]+$/.test(specOrUrl.trim()) && !/^[[{]/.test(specOrUrl.trim());
+  return {
+    router,
+    props: {
+      spec: isUrl ? undefined : specOrUrl,
+      specUrl: isUrl ? specOrUrl.trim() : undefined,
+      basePath: basePath || '/',
+      options: settings,
+    },
+  };
+}
+
+function wrapInRouter(app, router) {
+  return router === 'history' ? app : React.createElement(HashRouter, null, app);
+}
+
+function requireElement(element) {
+  if (element === null) {
+    throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');
+  }
+  return element;
+}
+
+function init(specOrUrl, options = {}, element = document.querySelector('redoc'), callback) {
+  requireElement(element);
+  cancelHydration(element);
+  const { router, props } = resolveArgs(specOrUrl, options, element);
+  if (!roots.has(element)) roots.set(element, createRoot(element));
+  const root = roots.get(element);
+  root.render(wrapInRouter(React.createElement(RedocStandalone, {
+    ...props,
+    onLoaded: callback,
+  }), router));
+  return root;
+}
+
+function destroy(element = document.querySelector('redoc')) {
+  if (!element) return;
+  cancelHydration(element);
+  const root = roots.get(element);
+  if (root) {
+    root.unmount();
+    roots.delete(element);
+  }
+}
+
+async function hydrate(specOrUrl, options = {}, element = document.querySelector('redoc'), callback) {
+  requireElement(element);
+  destroy(element);
+  const request = {};
+  hydrationRequests.set(element, request);
+  const { router, props } = resolveArgs(specOrUrl, options, element);
+  const prepared = await prepareApiDocs({ ...props, convertedDownload: false });
+  if (hydrationRequests.get(element) !== request) return;
+  hydrationTimers.set(element, setTimeout(() => {
+    hydrationTimers.delete(element);
+    hydrationRequests.delete(element);
+    const app = wrapInRouter(React.createElement(RedoclyApiDocsStandalone, {
+      items: prepared.items,
+      store: prepared.store,
+      basePath: props.basePath,
+      options: prepared.options,
+      logo: logoFromSpec(prepared.document),
+      telemetryConfig: { disabled: true },
+      spec: prepared.document,
+      specUrl: props.specUrl,
+    }), router);
+    if (element.childElementCount === 0) {
+      const root = createRoot(element);
+      roots.set(element, root);
+      root.render(app);
+    } else {
+      roots.set(element, hydrateRoot(element, app, { onRecoverableError: callback }));
+    }
+  }, 0));
+}
+
+exports.init = init;
+exports.destroy = destroy;
+exports.hydrate = hydrate;
+exports.RedocStandalone = RedocStandalone;
+exports.version = metadata.version;
+
+const element = document.querySelector('redoc');
+if (element && element.getAttribute('spec-url')) {
+  init(element.getAttribute('spec-url'), {}, element);
+}

package/dist/CoreBase.d.ts

@@ -0,0 +1,43 @@
+import { ILogger } from '@researchdatabox/sails-ng-common';
+export declare abstract class CoreBase {
+    /**
+     * Exported methods. Must be overridden by the child to add custom methods.
+     */
+    protected _exportedMethods: string[];
+    private _logger?;
+    private _namespaceLoggerFailed;
+    protected abstract _loggerNamespaceSuffix: string;
+    constructor();
+    /**
+     * Function that allows async dynamic imports of modules (such as ECMAScript modules).
+     * Called in the constructor and intended to be overridden in sub class to allow imports.
+     */
+    protected processDynamicImports(): Promise<void>;
+    /**
+     * Function that is called during the construction of the Controller after the dynamic imports are completed.
+     * Intended to be overridden in the sub class
+     */
+    protected onDynamicImportsCompleted(): void;
+    /**
+     * Registers a Sails hook handler if Sails is available.
+     * @protected
+     */
+    protected registerSailsHook(action: 'on', eventName: string, handler: (...args: unknown[]) => void | Promise<void>): boolean;
+    protected registerSailsHook(action: 'after', eventName: string | string[], handler: (...args: unknown[]) => void | Promise<void>): boolean;
+    /**
+     * Get a namespaced logger for this class.
+     * Uses the class constructor name as the namespace.
+     * Falls back to sails.log or console logger if pino namespaced logging is not available.
+     * @protected
+     */
+    protected get logger(): ILogger;
+    /**
+     * Log at a particular level.
+     * This allows specifying the level in config so it can be changed.
+     * @param level Log level.
+     * @param args Log message.
+     * @protected
+     */
+    protected logAtLevel(level: string, ...args: unknown[]): void;
+}
+//# sourceMappingURL=CoreBase.d.ts.map

package/dist/CoreBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreBase.d.ts","sourceRoot":"","sources":["../src/CoreBase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,OAAO,EAAc,MAAM,kCAAkC,CAAC;AAGtF,8BAAsB,QAAQ;IAC5B;;OAEG;IACH,SAAS,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAM;IAE1C,OAAO,CAAC,OAAO,CAAC,CAAsB;IAEtC,OAAO,CAAC,sBAAsB,CAAS;IAEvC,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;;IASlD;;;OAGG;cACa,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAItD;;;OAGG;IACH,SAAS,CAAC,yBAAyB,IAAI,IAAI;IAI3C;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,IAAI,EACZ,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GACpD,OAAO;IACV,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,OAAO,EACf,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAC5B,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GACpD,OAAO;IAgCV;;;;;OAKG;IACH,SAAS,KAAK,MAAM,IAAI,OAAO,CAkC9B;IAED;;;;;;OAMG;IACH,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;CAG9D"}

package/dist/CoreBase.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoreBase = void 0;
+const sails_ng_common_1 = require("@researchdatabox/sails-ng-common");
+const PinoLoggerUtils_1 = require("./utilities/PinoLoggerUtils");
+class CoreBase {
+    /**
+     * Exported methods. Must be overridden by the child to add custom methods.
+     */
+    _exportedMethods = [];
+    _logger = undefined;
+    _namespaceLoggerFailed = false;
+    constructor() {
+        this.processDynamicImports().then(() => {
+            this.logger.verbose('Dynamic imports imported');
+            this.onDynamicImportsCompleted();
+        });
+    }
+    /**
+     * Function that allows async dynamic imports of modules (such as ECMAScript modules).
+     * Called in the constructor and intended to be overridden in sub class to allow imports.
+     */
+    async processDynamicImports() {
+        // Override in sub class as needed
+    }
+    /**
+     * Function that is called during the construction of the Controller after the dynamic imports are completed.
+     * Intended to be overridden in the sub class
+     */
+    onDynamicImportsCompleted() {
+        // Override in sub class as needed
+    }
+    registerSailsHook(action, eventName, handler) {
+        if (typeof sails === 'undefined') {
+            this.logger.warn(`Sails is undefined so did not register hook action ${action} eventName ${eventName} handler ${handler}`);
+            return false;
+        }
+        if (action === 'on') {
+            if (typeof sails.on !== 'function') {
+                this.logger.warn(`Sails.on is not a function so did not register hook action ${action} eventName ${eventName} handler ${handler}`);
+                return false;
+            }
+            sails.on(eventName, handler);
+            return true;
+        }
+        if (typeof sails.after !== 'function') {
+            this.logger.warn(`Sails.after is not a function so did not register hook action ${action} eventName ${eventName} handler ${handler}`);
+            return false;
+        }
+        sails.after(eventName, handler);
+        return true;
+    }
+    /**
+     * Get a namespaced logger for this class.
+     * Uses the class constructor name as the namespace.
+     * Falls back to sails.log or console logger if pino namespaced logging is not available.
+     * @protected
+     */
+    get logger() {
+        // Check logger in preference order.
+        if (this._logger !== undefined) {
+            // If a namespace logger has already been created, use it.
+            return this._logger;
+        }
+        const logConfig = typeof sails !== 'undefined' ? sails?.config?.log : undefined;
+        if (!this._namespaceLoggerFailed &&
+            typeof logConfig?.createNamespaceLogger === 'function' &&
+            (0, PinoLoggerUtils_1.isPinoLogger)(logConfig?.customLogger)) {
+            // Create and store a pino namespace logger.
+            const serviceName = this.constructor.name + this._loggerNamespaceSuffix;
+            try {
+                this._logger = logConfig.createNamespaceLogger(serviceName, logConfig.customLogger);
+                return this._logger;
+            }
+            catch (error) {
+                // Don't let a misconfigured logger break the class; use the fallback logger instead.
+                this._namespaceLoggerFailed = true;
+                sails?.log?.warn(`Could not create namespace logger '${serviceName}', using the default logger.`, error);
+            }
+        }
+        if (typeof sails !== 'undefined' && sails?.log !== undefined) {
+            // Use sails.log without storing it - once the app has loaded the namespace config should be available.
+            return sails.log;
+        }
+        // Console logger as fallback for when sails is not defined (e.g. during shim generation).
+        // Don't store it - once the app has loaded the namespace config should be available.
+        return sails_ng_common_1.consoleLogger;
+    }
+    /**
+     * Log at a particular level.
+     * This allows specifying the level in config so it can be changed.
+     * @param level Log level.
+     * @param args Log message.
+     * @protected
+     */
+    logAtLevel(level, ...args) {
+        (0, sails_ng_common_1.logAtLevel)(this.logger, level, ...args);
+    }
+}
+exports.CoreBase = CoreBase;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ29yZUJhc2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvQ29yZUJhc2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsc0VBQXNGO0FBQ3RGLGlFQUEyRDtBQUUzRCxNQUFzQixRQUFRO0lBQzVCOztPQUVHO0lBQ08sZ0JBQWdCLEdBQWEsRUFBRSxDQUFDO0lBRWxDLE9BQU8sR0FBYSxTQUFTLENBQUM7SUFFOUIsc0JBQXNCLEdBQUcsS0FBSyxDQUFDO0lBSXZDO1FBQ0UsSUFBSSxDQUFDLHFCQUFxQixFQUFFLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRTtZQUNyQyxJQUFJLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQywwQkFBMEIsQ0FBQyxDQUFDO1lBQ2hELElBQUksQ0FBQyx5QkFBeUIsRUFBRSxDQUFDO1FBQ25DLENBQUMsQ0FBQyxDQUFDO0lBQ0wsQ0FBQztJQUVEOzs7T0FHRztJQUNPLEtBQUssQ0FBQyxxQkFBcUI7UUFDbkMsa0NBQWtDO0lBQ3BDLENBQUM7SUFFRDs7O09BR0c7SUFDTyx5QkFBeUI7UUFDakMsa0NBQWtDO0lBQ3BDLENBQUM7SUFnQlMsaUJBQWlCLENBQ3pCLE1BQXNCLEVBQ3RCLFNBQTRCLEVBQzVCLE9BQXFEO1FBRXJELElBQUksT0FBTyxLQUFLLEtBQUssV0FBVyxFQUFFLENBQUM7WUFDakMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQ2Qsc0RBQXNELE1BQU0sY0FBYyxTQUFTLFlBQVksT0FBTyxFQUFFLENBQ3pHLENBQUM7WUFDRixPQUFPLEtBQUssQ0FBQztRQUNmLENBQUM7UUFDRCxJQUFJLE1BQU0sS0FBSyxJQUFJLEVBQUUsQ0FBQztZQUNwQixJQUFJLE9BQU8sS0FBSyxDQUFDLEVBQUUsS0FBSyxVQUFVLEVBQUUsQ0FBQztnQkFDbkMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQ2QsOERBQThELE1BQU0sY0FBYyxTQUFTLFlBQVksT0FBTyxFQUFFLENBQ2pILENBQUM7Z0JBQ0YsT0FBTyxLQUFLLENBQUM7WUFDZixDQUFDO1lBQ0QsS0FBSyxDQUFDLEVBQUUsQ0FBQyxTQUFtQixFQUFFLE9BQU8sQ0FBQyxDQUFDO1lBQ3ZDLE9BQU8sSUFBSSxDQUFDO1FBQ2QsQ0FBQztRQUNELElBQUksT0FBTyxLQUFLLENBQUMsS0FBSyxLQUFLLFVBQVUsRUFBRSxDQUFDO1lBQ3RDLElBQUksQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUNkLGlFQUFpRSxNQUFNLGNBQWMsU0FBUyxZQUFZLE9BQU8sRUFBRSxDQUNwSCxDQUFDO1lBQ0YsT0FBTyxLQUFLLENBQUM7UUFDZixDQUFDO1FBQ0QsS0FBSyxDQUFDLEtBQUssQ0FBQyxTQUFTLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDaEMsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxJQUFjLE1BQU07UUFDbEIsb0NBQW9DO1FBRXBDLElBQUksSUFBSSxDQUFDLE9BQU8sS0FBSyxTQUFTLEVBQUUsQ0FBQztZQUMvQiwwREFBMEQ7WUFDMUQsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDO1FBQ3RCLENBQUM7UUFFRCxNQUFNLFNBQVMsR0FBRyxPQUFPLEtBQUssS0FBSyxXQUFXLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxNQUFNLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUM7UUFDaEYsSUFDRSxDQUFDLElBQUksQ0FBQyxzQkFBc0I7WUFDNUIsT0FBTyxTQUFTLEVBQUUscUJBQXFCLEtBQUssVUFBVTtZQUN0RCxJQUFBLDhCQUFZLEVBQUMsU0FBUyxFQUFFLFlBQVksQ0FBQyxFQUNyQyxDQUFDO1lBQ0QsNENBQTRDO1lBQzVDLE1BQU0sV0FBVyxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxzQkFBc0IsQ0FBQztZQUN4RSxJQUFJLENBQUM7Z0JBQ0gsSUFBSSxDQUFDLE9BQU8sR0FBRyxTQUFTLENBQUMscUJBQXFCLENBQUMsV0FBVyxFQUFFLFNBQVMsQ0FBQyxZQUFZLENBQUMsQ0FBQztnQkFDcEYsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDO1lBQ3RCLENBQUM7WUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO2dCQUNmLHFGQUFxRjtnQkFDckYsSUFBSSxDQUFDLHNCQUFzQixHQUFHLElBQUksQ0FBQztnQkFDbkMsS0FBSyxFQUFFLEdBQUcsRUFBRSxJQUFJLENBQUMsc0NBQXNDLFdBQVcsOEJBQThCLEVBQUUsS0FBSyxDQUFDLENBQUM7WUFDM0csQ0FBQztRQUNILENBQUM7UUFFRCxJQUFJLE9BQU8sS0FBSyxLQUFLLFdBQVcsSUFBSSxLQUFLLEVBQUUsR0FBRyxLQUFLLFNBQVMsRUFBRSxDQUFDO1lBQzdELHVHQUF1RztZQUN2RyxPQUFPLEtBQUssQ0FBQyxHQUFHLENBQUM7UUFDbkIsQ0FBQztRQUVELDBGQUEwRjtRQUMxRixxRkFBcUY7UUFDckYsT0FBTywrQkFBYSxDQUFDO0lBQ3ZCLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDTyxVQUFVLENBQUMsS0FBYSxFQUFFLEdBQUcsSUFBZTtRQUNwRCxJQUFBLDRCQUFVLEVBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxLQUFLLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQztJQUMxQyxDQUFDO0NBQ0Y7QUFwSUQsNEJBb0lDIn0=

package/dist/CoreController.d.ts

@@ -1,6 +1,6 @@
 import type { Response } from 'express';
-import { ILogger } from './Logger';
-import { BuildResponseType, APIErrorResponse, ApiVersionStrings } from "./model";
+import { BuildResponseType, APIErrorResponse, ApiVersionStrings } from './model';
+import { CoreBase } from './CoreBase';
 export declare namespace Controllers.Core {
     /**
      * Core controller which defines common logic between controllers.
@@ -21,17 +21,13 @@ export declare namespace Controllers.Core {
      * @remarks Use `sendResp` for responses so API versioning and the standard response envelope remain consistent.
      * @see https://github.com/redbox-mint/redbox-portal/wiki/Redbox-Loader
      */
-    class Controller {
+    class Controller extends CoreBase {
         /**
          * Overrides for the settings in `config/controllers.js`
          * (specific to the controller where it's defined)
          * Specific to sails. Don't rename.
          */
         protected _config: Record<string, unknown>;
-        /**
-         * Exported methods. Must be overridden by the child to add custom methods.
-         */
-        protected _exportedMethods: string[];
         /**
          * Theme used by the controller by default.
          * Could be overridden by the user theme. (One day, when the feature will be done...)
@@ -50,30 +46,7 @@ export declare namespace Controllers.Core {
          * These methods will be accessible.
          */
         private _defaultExportedMethods;
-        private _logger;
-        private getFallbackLogger;
-        /**
-         * Get a namespaced logger for this controller class.
-         * Uses the class constructor name as the namespace.
-         * Falls back to sails.log if pino namespaced logging is not available.
-         */
-        protected get logger(): ILogger;
-        /**
-         * Registers a Sails hook handler if Sails is available.
-         */
-        protected registerSailsHook(action: 'on', eventName: string, handler: (...args: unknown[]) => void | Promise<void>): boolean;
-        protected registerSailsHook(action: 'after', eventName: string | string[], handler: (...args: unknown[]) => void | Promise<void>): boolean;
-        constructor();
-        /**
-         * Function that allows async dynamic imports of modules (such as ECMAScript modules).
-         * Called in the constructor and intended to be overridden in sub class to allow imports.
-         */
-        protected processDynamicImports(): Promise<void>;
-        /**
-         * Function that is called during the construction of the Controller after the dynamic imports are completed.
-         * Intended to be overridden in the sub class
-         */
-        protected onDynamicImportsCompleted(): void;
+        protected _loggerNamespaceSuffix: string;
         /**
          **************************************************************************************************
          **************************************** Public methods ******************************************
@@ -201,6 +174,25 @@ export declare namespace Controllers.Core {
          * @protected
          */
         protected sendResp(req: Sails.Req, res: Sails.Res, buildResponse?: BuildResponseType): Response;
+        /**
+         * Add details and errors to the request chronicle, which is logged when the request finishes.
+         * Values are sanitised and size-bounded, but prefer identifiers, counts, and codes over whole objects.
+         * @param req The sails request.
+         * @param info The details to add.
+         * @param errors The errors to add.
+         * @protected
+         */
+        protected updateChronicle(req: Sails.Req, info?: Record<string, unknown>, errors?: (Error | unknown)[]): void;
+        /**
+         * Record the result of work that is not awaited before the response is sent, such as an audit event.
+         * If the work finishes after the response, its result is logged separately with the request id,
+         * so failures are never discarded.
+         * @param req The sails request.
+         * @param operation A short name for the operation, used as the request chronicle key.
+         * @param work The work.
+         * @protected
+         */
+        protected recordBackgroundOperation(req: Sails.Req, operation: string, work: PromiseLike<unknown>): void;
         private collectAndLogErrors;
         private ensureDisplayErrors;
         private resolveResponseStatus;

package/dist/CoreController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CoreController.d.ts","sourceRoot":"","sources":["../src/CoreController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAGxC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAKnC,OAAO,EACL,iBAAiB,EAEjB,gBAAgB,EAEhB,iBAAiB,EAGlB,MAAM,SAAS,CAAC;AAMjB,yBAAiB,WAAW,CAAC,IAAI,CAAC;IAIhC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAa,UAAU;QAErB;;;;WAIG;QACH,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM;QAEhD;;WAEG;QACH,SAAS,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAM;QAE1C;;;WAGG;QACH,SAAS,CAAC,MAAM,EAAE,MAAM,CAAa;QAErC;;WAEG;QACH,SAAS,CAAC,OAAO,EAAE,MAAM,CAAa;QAEtC;;WAEG;QACH,SAAS,CAAC,mBAAmB,EAAE,MAAM,CAAkB;QAEvD;;;WAGG;QACH,OAAO,CAAC,uBAAuB,CAG7B;QAGF,OAAO,CAAC,OAAO,CAAwB;QAEvC,OAAO,CAAC,iBAAiB;QAmBzB;;;;WAIG;QACH,SAAS,KAAK,MAAM,IAAI,OAAO,CAiB9B;QAED;;WAEG;QACH,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO;QAC5H,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO;;QA0B1I;;;WAGG;kBACa,qBAAqB;QAIrC;;;WAGG;QACH,SAAS,CAAC,yBAAyB;QAInC;;;;WAIG;QAEH;;;;;WAKG;QACI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;QA6BzC;;;;WAIG;QAEH;;;;;;;;;;;WAWG;QACH,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,IAAI;QAI3L;;;;WAIG;QAEH;;;;;;;;WAQG;QACI,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,IAAI;QAK7G,OAAO,CAAC,eAAe;QAIvB,OAAO,CAAC,mBAAmB;QAO3B,OAAO,CAAC,oBAAoB;QAK5B,OAAO,CAAC,eAAe;QAkBvB,OAAO,CAAC,iBAAiB;QAoBzB,OAAO,CAAC,gBAAgB;QAMxB,OAAO,CAAC,iBAAiB;QAUzB,OAAO,CAAC,sBAAsB;QAI9B,OAAO,CAAC,2BAA2B;QAoC5B,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;QAK/E,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;QAKnE,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,IAAI;QAwDzG,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;QAIhE,SAAS,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;QAW5F,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;QAI1E,SAAS,CAAC,0BAA0B,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,SAAS;QAqB1F;;WAEG;QACI,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,KAAK,OAAO,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,KAAK,OAAO,EAAE,UAAU,UAAQ,GAAG,OAAO;QAQvL,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,OAAO;QAIzC;;WAEG;QACH,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,SAAK,EAAE,IAAI,GAAE,OAAc,EAAE,UAAU,UAAQ,GAAG,QAAQ;QAK9G;;WAEG;QACH,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,SAAK,EAAE,IAAI,GAAE,OAAc,EAAE,UAAU,UAAQ,GAAG,QAAQ;QAKhH;;WAEG;QACH,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,UAAU,SAAM,EAAE,aAAa,CAAC,EAAE,gBAAgB,GAAG,QAAQ;QAQ/G;;WAEG;QACH,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,GAAE,OAAc,EAAE,UAAU,SAAM,GAAG,QAAQ;QAIzG;;WAEG;QACH,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,GAAE,OAAc,EAAE,UAAU,SAAM,GAAG,QAAQ;QAIzG;;WAEG;QACH,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,GAAE,OAAc,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ;QAI9G,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG;YAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;SAAE;QAS/D;;;;;;WAMG;QACH,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,iBAAiB;QAkC1D;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,EAAE,iBAAiB,GAAG,QAAQ;QAiE/F,OAAO,CAAC,mBAAmB;QAa3B,OAAO,CAAC,mBAAmB;QAW3B,OAAO,CAAC,qBAAqB;QAkC7B,OAAO,CAAC,oBAAoB;QAM5B,OAAO,CAAC,mBAAmB;QAQ3B,OAAO,CAAC,0BAA0B;QAIlC,OAAO,CAAC,eAAe;QAwDvB,OAAO,CAAC,eAAe;QASvB,OAAO,CAAC,mBAAmB;QAe3B,OAAO,CAAC,qBAAqB;QA4B7B,OAAO,CAAC,eAAe;QAoBvB,OAAO,CAAC,oBAAoB;QA0B5B,OAAO,CAAC,qBAAqB;QAqB7B,OAAO,CAAC,gBAAgB;QA6CxB,OAAO,CAAC,gBAAgB;QA2CxB,SAAS,CAAC,iBAAiB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;QAQrD,OAAO,CAAC,iBAAiB;KAG1B;CACF"}
+{"version":3,"file":"CoreController.d.ts","sourceRoot":"","sources":["../src/CoreController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAOxC,OAAO,EACL,iBAAiB,EAEjB,gBAAgB,EAEhB,iBAAiB,EAGlB,MAAM,SAAS,CAAC;AAQjB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,yBAAiB,WAAW,CAAC,IAAI,CAAC;IAGhC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAa,UAAW,SAAQ,QAAQ;QACtC;;;;WAIG;QACH,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM;QAEhD;;;WAGG;QACH,SAAS,CAAC,MAAM,EAAE,MAAM,CAAa;QAErC;;WAEG;QACH,SAAS,CAAC,OAAO,EAAE,MAAM,CAAa;QAEtC;;WAEG;QACH,SAAS,CAAC,mBAAmB,EAAE,MAAM,CAAkB;QAEvD;;;WAGG;QACH,OAAO,CAAC,uBAAuB,CAG7B;QAEF,SAAS,CAAC,sBAAsB,EAAE,MAAM,CAAgB;QAExD;;;;WAIG;QAEH;;;;;WAKG;QACI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;QA+BzC;;;;WAIG;QAEH;;;;;;;;;;;WAWG;QACH,SAAS,CAAC,cAAc,CACtB,GAAG,EAAE,KAAK,CAAC,GAAG,EACd,GAAG,EAAE,KAAK,CAAC,GAAG,EACd,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,EACpF,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACpC,IAAI;QAIP;;;;WAIG;QAEH;;;;;;;;WAQG;QACI,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,IAAI;QAI7G,OAAO,CAAC,eAAe;QAIvB,OAAO,CAAC,mBAAmB;QAO3B,OAAO,CAAC,oBAAoB;QAI5B,OAAO,CAAC,eAAe;QAkBvB,OAAO,CAAC,iBAAiB;QAoBzB,OAAO,CAAC,gBAAgB;QAMxB,OAAO,CAAC,iBAAiB;QAUzB,OAAO,CAAC,sBAAsB;QAI9B,OAAO,CAAC,2BAA2B;QAoC5B,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;QAK/E,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;QAKnE,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,IAAI;QA6DzG,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;QAIhE,SAAS,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;QAW5F,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;QAI1E,SAAS,CAAC,0BAA0B,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,SAAS;QAqB1F;;WAEG;QACI,OAAO,CACZ,GAAG,EAAE,KAAK,CAAC,GAAG,EACd,GAAG,EAAE,KAAK,CAAC,GAAG,EACd,MAAM,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,KAAK,OAAO,EACnD,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,KAAK,OAAO,EACrD,UAAU,UAAQ,GACjB,OAAO;QAQV,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,OAAO;QAIzC;;WAEG;QACH,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,SAAK,EAAE,IAAI,GAAE,OAAc,EAAE,UAAU,UAAQ,GAAG,QAAQ;QAK9G;;WAEG;QACH,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,SAAK,EAAE,IAAI,GAAE,OAAc,EAAE,UAAU,UAAQ,GAAG,QAAQ;QAKhH;;WAEG;QACH,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,UAAU,SAAM,EAAE,aAAa,CAAC,EAAE,gBAAgB,GAAG,QAAQ;QAU/G;;WAEG;QACH,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,GAAE,OAAc,EAAE,UAAU,SAAM,GAAG,QAAQ;QAIzG;;WAEG;QACH,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,GAAE,OAAc,EAAE,UAAU,SAAM,GAAG,QAAQ;QAIzG;;WAEG;QACH,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,GAAE,OAAc,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ;QAI9G,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG;YAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;SAAE;QAS/D;;;;;;WAMG;QACH,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,iBAAiB;QAyC1D;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,EAAE,iBAAiB,GAAG,QAAQ;QAsG/F;;;;;;;WAOG;QACH,SAAS,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,KAAK,GAAG,OAAO,CAAC,EAAE,GAAG,IAAI;QAwB7G;;;;;;;;WAQG;QACH,SAAS,CAAC,yBAAyB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI;QAgCxG,OAAO,CAAC,mBAAmB;QAe3B,OAAO,CAAC,mBAAmB;QAW3B,OAAO,CAAC,qBAAqB;QAmC7B,OAAO,CAAC,oBAAoB;QAM5B,OAAO,CAAC,mBAAmB;QAQ3B,OAAO,CAAC,0BAA0B;QAIlC,OAAO,CAAC,eAAe;QAuDvB,OAAO,CAAC,eAAe;QAavB,OAAO,CAAC,mBAAmB;QAe3B,OAAO,CAAC,qBAAqB;QA0B7B,OAAO,CAAC,eAAe;QAoBvB,OAAO,CAAC,oBAAoB;QA0B5B,OAAO,CAAC,qBAAqB;QAqB7B,OAAO,CAAC,gBAAgB;QAuDxB,OAAO,CAAC,gBAAgB;QAqDxB,SAAS,CAAC,iBAAiB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;QAQrD,OAAO,CAAC,iBAAiB;KAG1B;CACF"}