@researchdatabox/redbox-core-types 0.0.1-beta.10173

package/dist/Attachment.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Base class for information regarding an attachment, also includes payload
+ *
+ * @author <a target='_' href='https://github.com/shilob'>Shilo Banihit</a>
+ */
+export declare class Attachment {
+    dateUpdated: Date | string | null;
+    label: string;
+    contentType: string;
+    dateCreated: Date | string | null;
+    body: unknown;
+    readstream: NodeJS.ReadableStream | null;
+    size: number;
+    constructor();
+}
+export default Attachment;
+//# sourceMappingURL=Attachment.d.ts.map

package/dist/Attachment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Attachment.d.ts","sourceRoot":"","sources":["../src/Attachment.ts"],"names":[],"mappings":"AAmBA;;;;GAIG;AACH,qBAAa,UAAU;IACrB,WAAW,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAQ;IACzC,KAAK,EAAE,MAAM,CAAM;IACnB,WAAW,EAAE,MAAM,CAAM;IACzB,WAAW,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAQ;IACzC,IAAI,EAAE,OAAO,CAAQ;IACrB,UAAU,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAQ;IAChD,IAAI,EAAE,MAAM,CAAK;;CAGlB;AACD,eAAe,UAAU,CAAA"}

package/dist/Attachment.js

@@ -0,0 +1,40 @@
+"use strict";
+// Copyright (c) 2020 Queensland Cyber Infrastructure Foundation (http://www.qcif.edu.au/)
+//
+// GNU GENERAL PUBLIC LICENSE
+//    Version 2, June 1991
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Attachment = void 0;
+/**
+ * Base class for information regarding an attachment, also includes payload
+ *
+ * @author <a target='_' href='https://github.com/shilob'>Shilo Banihit</a>
+ */
+class Attachment {
+    dateUpdated = null;
+    label = '';
+    contentType = '';
+    dateCreated = null;
+    body = null; // bad idea to load everything in-memory
+    readstream = null; // strongly suggest services stream rather than load everything in-mem
+    size = 0; // the number of bytes the attachment is
+    constructor() {
+    }
+}
+exports.Attachment = Attachment;
+exports.default = Attachment;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQXR0YWNobWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9BdHRhY2htZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwwRkFBMEY7QUFDMUYsRUFBRTtBQUNGLDZCQUE2QjtBQUM3QiwwQkFBMEI7QUFDMUIsRUFBRTtBQUNGLHVFQUF1RTtBQUN2RSx1RUFBdUU7QUFDdkUsb0VBQW9FO0FBQ3BFLHNDQUFzQztBQUN0QyxFQUFFO0FBQ0Ysa0VBQWtFO0FBQ2xFLGlFQUFpRTtBQUNqRSxnRUFBZ0U7QUFDaEUsK0NBQStDO0FBQy9DLEVBQUU7QUFDRiwwRUFBMEU7QUFDMUUsMEVBQTBFO0FBQzFFLDhEQUE4RDs7O0FBRTlEOzs7O0dBSUc7QUFDSCxNQUFhLFVBQVU7SUFDckIsV0FBVyxHQUF5QixJQUFJLENBQUM7SUFDekMsS0FBSyxHQUFXLEVBQUUsQ0FBQztJQUNuQixXQUFXLEdBQVcsRUFBRSxDQUFDO0lBQ3pCLFdBQVcsR0FBeUIsSUFBSSxDQUFDO0lBQ3pDLElBQUksR0FBWSxJQUFJLENBQUMsQ0FBQyx3Q0FBd0M7SUFDOUQsVUFBVSxHQUFpQyxJQUFJLENBQUMsQ0FBQyxzRUFBc0U7SUFDdkgsSUFBSSxHQUFXLENBQUMsQ0FBQyxDQUFDLHdDQUF3QztJQUMxRDtJQUNBLENBQUM7Q0FDRjtBQVZELGdDQVVDO0FBQ0Qsa0JBQWUsVUFBVSxDQUFBIn0=

package/dist/CoreController.d.ts

@@ -0,0 +1,206 @@
+import type { Response } from 'express';
+import { ILogger } from './Logger';
+import { BuildResponseType, APIErrorResponse } from "./model";
+export declare namespace Controllers.Core {
+    /**
+     * Core controller which defines common logic between controllers.
+     *
+     * Workflow details:
+     * - First, the "_handleRequest" method must be called. It ensures common stuff happens, and bind some data into the option object.
+     * - It calls a magic method such as "__beforeIndex" if the request was coming from an "index" method.
+     * - If it doesn't find any specific magic method to call, it calls directly the "__beforeEach" method.
+     * - If it does find a custom magic method, then the "__beforeIndex" will automatically call the "__beforeEach" once it is done.
+     * - Once all the "__before" magic methods have been called, the caller's callback function is called.
+     *
+     * The options object contains specific stuff that belongs to the controllers logic, I could have use the req but I prefer not.
+     *
+     * The public methods such as index/show/etc. are defined but send by default a 404 response if they are not overridden in the child class.
+     * They exists just to bind by default all these methods without take care if they exists or not in order to speed up development.
+     */
+    class Controller {
+        /**
+         * 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...)
+         */
+        protected _theme: string;
+        /**
+         * Layout used by the controller by default.
+         */
+        protected _layout: string;
+        /**
+         * Relative path to a layout from a view.
+         */
+        protected _layoutRelativePath: string;
+        /**
+         * Default exported methods.
+         * 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;
+        /**
+         **************************************************************************************************
+         **************************************** Public methods ******************************************
+         **************************************************************************************************
+         */
+        /**
+         * Returns an object that contains all exported methods of the controller.
+         * These methods must be defined in either the "_defaultExportedMethods" or "_exportedMethods" arrays.
+         *
+         * @returns {*}
+         */
+        exports(): Record<string, unknown>;
+        /**
+         **************************************************************************************************
+         **************************************** Protected methods ******************************************
+         **************************************************************************************************
+         */
+        /**
+         * Acts as a requests workflow handler to automatically call magic methods such as "__before".
+         * Used to call magic methods before the targeted methods is called.
+         * Bind some data as well, like the current controller and action name.
+         *
+         * @param req       Request.
+         * @param res       Response.
+         * @param callback  Function to execute.
+         * @param options   Object that contains options.
+         *          controller  Controller      Child controller class. (static)
+         *
+         */
+        protected _handleRequest(req: Sails.Req, res: Sails.Res, callback: (req: Sails.Req, res: Sails.Res, options: Record<string, unknown>) => void, options?: Record<string, unknown>): void;
+        /**
+         **************************************************************************************************
+         **************************************** Controller basic methods ********************************
+         **************************************************************************************************
+         */
+        /**
+         * Displays the global content, displays several resources.
+         * This method is just to return a 404 error and explain the role.
+         *
+         * @param req       Request.
+         * @param res       Response.
+         * @param callback  Function to execute.
+         * @param options   Object that contains options.
+         */
+        index(req: Sails.Req, res: Sails.Res, callback: unknown, _options?: Record<string, unknown>): void;
+        _getResolvedView(branding: string, portal: string, view: string): string | null;
+        _getResolvedLayout(branding: string, portal: string): string | null;
+        sendView(req: Sails.Req, res: Sails.Res, view: string, locals?: Record<string, unknown>): void;
+        protected getSiteTitle(locals?: Record<string, unknown>): string;
+        protected formatDocumentTitle(pageTitle?: unknown, locals?: Record<string, unknown>): string;
+        protected translate(key: string, locals?: Record<string, unknown>): string;
+        protected resolvePageTitleFromLocals(locals?: Record<string, unknown>): string | undefined;
+        /**
+         * @deprecated Use `sendResp` instead.
+         */
+        respond(req: Sails.Req, res: Sails.Res, ajaxCb: (req: Sails.Req, res: Sails.Res) => unknown, normalCb: (req: Sails.Req, res: Sails.Res) => unknown, _forceAjax?: boolean): unknown;
+        protected isAjax(req: Sails.Req): boolean;
+        /**
+         * @deprecated Use `sendResp` instead.
+         */
+        protected ajaxOk(req: Sails.Req, res: Sails.Res, msg?: string, data?: unknown, _forceAjax?: boolean): Response;
+        /**
+         * @deprecated Use `sendResp` instead.
+         */
+        protected ajaxFail(req: Sails.Req, res: Sails.Res, msg?: string, data?: unknown, _forceAjax?: boolean): Response;
+        /**
+         * @deprecated Use `sendResp` instead.
+         */
+        protected apiFail(req: Sails.Req, res: Sails.Res, statusCode?: number, errorResponse?: APIErrorResponse): Response;
+        /**
+         * @deprecated Use `sendResp` instead.
+         */
+        protected apiSuccess(req: Sails.Req, res: Sails.Res, jsonObj?: unknown, statusCode?: number): Response;
+        /**
+         * @deprecated Use `sendResp` instead.
+         */
+        protected apiRespond(req: Sails.Req, res: Sails.Res, jsonObj?: unknown, statusCode?: number): Response;
+        /**
+         * @deprecated Use `sendResp` instead.
+         */
+        protected ajaxRespond(req: Sails.Req, res: Sails.Res, jsonObj?: unknown, _forceAjax?: boolean): Response;
+        protected getNg2Apps(viewPath: string): {
+            ng2_apps: unknown[];
+        };
+        /**
+         * Get the API version from the request.
+         * Defaults to v1.
+         * @param req The sails request.
+         * @return The API version string.
+         * @private
+         */
+        private getApiVersion;
+        /**
+         * Send a response built from the properties.
+         *
+         * Defaults / Conventions:
+         * - The default response format is 'json'.
+         * - If only 'data' is provided, the 'status' will be 200.
+         * - If there are any 'errors', the 'status' will default to 500.
+         * - If there are no displayErrors, a generic one will be added.
+         * - Errors are never used as display errors, to avoid revealing implementation details.
+         * - If there are any displayErrors:
+         *   - the top-level status will be 500 if any status starts with 5, or
+         *   - the top-level status will be 400 if any status starts with 4 and no statuses start with a 5, or
+         *   - the top-level status will be 500 if none of the display errors has a status, and the top-level status is not already 4xx or 5xx.
+         * - The response will be in the format matching the request kind (e.g. API, ajax).
+         * - If there is no displayError.title and no displayError.detail, and displayError.code is set,
+         *   the displayError.code will be used as a translation message identifier for displayError.title.
+         * - Both displayError.title and displayError.detail will be treated as translation message identifiers.
+         * - API v1 will return 'v1' if it is set.
+         * - API v1 will return 'data' as the body on 'status' 200, if no 'v1' is supplied.
+         *
+         * @param req The sails request.
+         * @param res The sails response.
+         * @param buildResponse Build the response from these properties.
+         * @protected
+         */
+        protected sendResp(req: Sails.Req, res: Sails.Res, buildResponse?: BuildResponseType): Response;
+        private collectAndLogErrors;
+        private ensureDisplayErrors;
+        private resolveResponseStatus;
+        private applyResponseHeaders;
+        private applyResponseStatus;
+        private shouldSendSuccessJson;
+        private sendSuccessJson;
+        private buildV1ErrorResponse;
+        private formatV2DisplayErrors;
+        private handleV1Response;
+        private handleV2Response;
+        protected getNoCacheHeaders(): Record<string, string>;
+        private setNoCacheHeaders;
+    }
+}
+//# sourceMappingURL=CoreController.d.ts.map

package/dist/CoreController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreController.d.ts","sourceRoot":"","sources":["../src/CoreController.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAKjB,MAAM,SAAS,CAAC;AAMjB,yBAAiB,WAAW,CAAC,IAAI,CAAC;IAEhC;;;;;;;;;;;;;;OAcG;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;QAKtG,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;QA2B/E,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;QA2BnE,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;QA8CzG,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,OAAO,CAAC,aAAa;QAkCrB;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,EAAE,iBAAiB,GAAG,QAAQ;QAuD/F,OAAO,CAAC,mBAAmB;QAa3B,OAAO,CAAC,mBAAmB;QAW3B,OAAO,CAAC,qBAAqB;QAkC7B,OAAO,CAAC,oBAAoB;QAM5B,OAAO,CAAC,mBAAmB;QAQ3B,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"}