@researchdatabox/redbox-core-types 1.2.1 → 1.4.0

package/dist/Attachment.d.ts

@@ -1,15 +1,16 @@
-/**
- * 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: any;
-    label: string;
-    contentType: string;
-    dateCreated: any;
-    body: any;
-    readstream: any;
-    constructor();
-}
-export default Attachment;
+/**
+ * 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: any;
+    label: string;
+    contentType: string;
+    dateCreated: any;
+    body: any;
+    readstream: any;
+    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,GAAG,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,GAAG,CAAC;IACjB,IAAI,EAAE,GAAG,CAAC;IACV,UAAU,EAAE,GAAG,CAAC;;CAIjB;AACD,eAAe,UAAU,CAAA"}

package/dist/Attachment.js

@@ -1,32 +1,38 @@
-"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 {
-    constructor() {
-    }
-}
-exports.Attachment = Attachment;
-exports.default = Attachment;
+"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;
+    label;
+    contentType;
+    dateCreated;
+    body; // bad idea to load everything in-memory
+    readstream; // strongly suggest services stream rather than load everything in-mem
+    constructor() {
+    }
+}
+exports.Attachment = Attachment;
+exports.default = Attachment;

package/dist/CoreController.d.ts

@@ -1,106 +1,108 @@
-import { APIErrorResponse } from './model/APIErrorResponse';
-export declare module 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: any;
-        /**
-         * 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;
-        /**
-         **************************************************************************************************
-         **************************************** 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(): any;
-        /**
-         **************************************************************************************************
-         **************************************** 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: any, res: any, callback: any, options?: any): 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: any, res: any, callback: any, options?: any): void;
-        _getResolvedView(branding: string, portal: string, view: string): string;
-        _getResolvedLayout(branding: string, portal: string): string;
-        sendView(req: any, res: any, view: string, locals?: any): void;
-        respond(req: any, res: any, ajaxCb: any, normalCb: any, forceAjax?: boolean): any;
-        protected isAjax(req: any): boolean;
-        protected ajaxOk(req: any, res: any, msg?: string, data?: any, forceAjax?: boolean): void;
-        protected ajaxFail(req: any, res: any, msg?: string, data?: any, forceAjax?: boolean): void;
-        protected apiFail(req: any, res: any, statusCode?: number, errorResponse?: APIErrorResponse): any;
-        protected apiRespond(req: any, res: any, jsonObj?: any, statusCode?: number): void;
-        protected ajaxRespond(req: any, res: any, jsonObj: any, forceAjax: any): void;
-        protected getNg2Apps(viewPath: any): {
-            ng2_apps: any;
-        };
-    }
-}
+import { APIErrorResponse } from './model/APIErrorResponse';
+export declare module 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: any;
+        /**
+         * 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;
+        /**
+         **************************************************************************************************
+         **************************************** 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(): any;
+        /**
+         **************************************************************************************************
+         **************************************** 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: any, res: any, callback: any, options?: any): 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: any, res: any, callback: any, options?: any): void;
+        _getResolvedView(branding: string, portal: string, view: string): string;
+        _getResolvedLayout(branding: string, portal: string): string;
+        sendView(req: any, res: any, view: string, locals?: any): void;
+        respond(req: any, res: any, ajaxCb: any, normalCb: any, forceAjax?: boolean): any;
+        protected isAjax(req: any): boolean;
+        protected ajaxOk(req: any, res: any, msg?: string, data?: any, forceAjax?: boolean): void;
+        protected ajaxFail(req: any, res: any, msg?: string, data?: any, forceAjax?: boolean): void;
+        protected apiFail(req: any, res: any, statusCode?: number, errorResponse?: APIErrorResponse): any;
+        protected apiRespond(req: any, res: any, jsonObj?: any, statusCode?: number): void;
+        protected ajaxRespond(req: any, res: any, jsonObj: any, forceAjax: any): void;
+        protected getNg2Apps(viewPath: any): {
+            ng2_apps: any;
+        };
+        protected pathExistsSync(path: any): boolean;
+    }
+}
+//# 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":"AAGA,OAAO,EAAC,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC3D,sBAAc,WAAW,CAAC,IAAI,CAAC;IAE7B;;;;;;;;;;;;;;OAcG;IACH,MAAa,UAAU;QAErB;;;;WAIG;QACH,SAAS,CAAC,OAAO,EAAE,GAAG,CAAM;QAE5B;;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;QAEF;;;;WAIG;QAEH;;;;;WAKG;QACI,OAAO,IAAI,GAAG;QA2BrB;;;;WAIG;QAEH;;;;;;;;;;;WAWG;QACH,SAAS,CAAC,cAAc,CAAC,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,QAAQ,KAAA,EAAE,OAAO,GAAE,GAAQ,GAAG,IAAI;QAIrE;;;;WAIG;QAEH;;;;;;;;WAQG;QACI,KAAK,CAAC,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,GAAE,GAAQ;QAKhD,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;QA2BxE,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;QA2B5D,QAAQ,CAAC,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,GAAQ;QA2CjD,OAAO,CAAC,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,MAAM,KAAA,EAAE,QAAQ,KAAA,EAAE,SAAS,UAAM;QAQ1D,SAAS,CAAC,MAAM,CAAC,GAAG,KAAA;QAIpB,SAAS,CAAC,MAAM,CAAC,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,GAAG,SAAG,EAAE,IAAI,MAAK,EAAE,SAAS,UAAM;QAO7D,SAAS,CAAC,QAAQ,CAAC,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,GAAG,SAAG,EAAE,IAAI,MAAK,EAAE,SAAS,UAAM;QAO/D,SAAS,CAAC,OAAO,CAAC,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,UAAU,SAAM,EAAE,aAAa,GAAC,gBAAyC;QASrG,SAAS,CAAC,UAAU,CAAC,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,OAAO,MAAK,EAAE,UAAU,SAAI;QAgB3D,SAAS,CAAC,WAAW,CAAC,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,OAAO,KAAK,EAAE,SAAS,KAAA;QAavD,SAAS,CAAC,UAAU,CAAC,QAAQ,KAAA;;;QAQ7B,SAAS,CAAC,cAAc,CAAC,IAAI,KAAA,GAAG,OAAO;KAQxC;CACF"}