@researchdatabox/redbox-core-types 1.1.1 → 1.2.0

package/package.json

@@ -1,24 +1,24 @@
-{
-  "name": "@researchdatabox/redbox-core-types",
-  "version": "1.1.1",
-  "description": "",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "/dist"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "lodash": "^4.17.21",
-    "moment": "^2.29.1",
-    "path-exists": "^4.0.0",
-    "rxjs": "^6.6.2",
-    "rxjs-compat": "^6.6.7",
-    "stream": "0.0.2",
-    "typescript": "^4.3.5"
-  }
-}
+{
+  "name": "@researchdatabox/redbox-core-types",
+  "version": "1.2.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "lodash": "^4.17.21",
+    "moment": "^2.29.1",
+    "path-exists": "^4.0.0",
+    "rxjs": "^6.6.2",
+    "rxjs-compat": "^6.6.7",
+    "stream": "0.0.2",
+    "typescript": "^4.3.5"
+  }
+}

package/dist/Attachment.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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;

package/dist/Attachment.js

@@ -1,32 +0,0 @@
-"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;

package/dist/CoreController.d.ts

@@ -1,106 +0,0 @@
-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;
-        };
-    }
-}

package/dist/CoreController.js

@@ -1,278 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Controllers = void 0;
-const pathExists = require("path-exists");
-const APIErrorResponse_1 = require("./model/APIErrorResponse");
-var Controllers;
-(function (Controllers) {
-    var Core;
-    (function (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 {
-            constructor() {
-                /**
-                 * Overrides for the settings in `config/controllers.js`
-                 * (specific to the controller where it's defined)
-                 * Specific to sails. Don't rename.
-                 */
-                this._config = {};
-                /**
-                 * Exported methods. Must be overridden by the child to add custom methods.
-                 */
-                this._exportedMethods = [];
-                /**
-                 * Theme used by the controller by default.
-                 * Could be overridden by the user theme. (One day, when the feature will be done...)
-                 */
-                this._theme = 'default';
-                /**
-                 * Layout used by the controller by default.
-                 */
-                this._layout = 'default';
-                /**
-                 * Relative path to a layout from a view.
-                 */
-                this._layoutRelativePath = '../_layouts/';
-                /**
-                 * Default exported methods.
-                 * These methods will be accessible.
-                 */
-                this._defaultExportedMethods = [
-                    // Sails controller custom config.
-                    '_config',
-                ];
-            }
-            /**
-             **************************************************************************************************
-             **************************************** 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() {
-                // Merge default array and custom array from child.
-                var methods = this._defaultExportedMethods.concat(this._exportedMethods);
-                var exportedMethods = {};
-                for (var i = 0; i < methods.length; i++) {
-                    // Check if the method exists.
-                    if (typeof this[methods[i]] !== 'undefined') {
-                        // Check that the method shouldn't be private. (Exception for _config, which is a sails config)
-                        if (methods[i][0] !== '_' || methods[i] === '_config') {
-                            if (_.isFunction(this[methods[i]])) {
-                                exportedMethods[methods[i]] = this[methods[i]].bind(this);
-                            }
-                            else {
-                                exportedMethods[methods[i]] = this[methods[i]];
-                            }
-                        }
-                        else {
-                            console.error('The method "' + methods[i] + '" is not public and cannot be exported. ' + this);
-                        }
-                    }
-                    else {
-                        console.error('The method "' + methods[i] + '" does not exist on the controller ' + this);
-                    }
-                }
-                return exportedMethods;
-            }
-            /**
-             **************************************************************************************************
-             **************************************** 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)
-             *
-             */
-            _handleRequest(req, res, callback, options = {}) {
-                callback(req, res, options);
-            }
-            /**
-             **************************************************************************************************
-             **************************************** 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, res, callback, options = {}) {
-                res.notFound();
-            }
-            _getResolvedView(branding, portal, view) {
-                var resolvedView = null;
-                //Check if view exists for branding and portal
-                var viewToTest = sails.config.appPath + "/views/" + branding + "/" + portal + "/" + view + ".ejs";
-                if (pathExists.sync(viewToTest)) {
-                    resolvedView = branding + "/" + portal + "/" + view;
-                }
-                // If view doesn't exist, next try for portal with default branding
-                if (resolvedView == null) {
-                    viewToTest = sails.config.appPath + "/views/default/" + portal + "/" + view + ".ejs";
-                    if (pathExists.sync(viewToTest)) {
-                        resolvedView = "default/" + portal + "/" + view;
-                    }
-                }
-                // If view still doesn't exist, next try for default portal with default branding
-                if (resolvedView == null) {
-                    viewToTest = sails.config.appPath + "/views/default/default/" + view + ".ejs";
-                    if (pathExists.sync(viewToTest)) {
-                        resolvedView = "default/default/" + view;
-                    }
-                }
-                return resolvedView;
-            }
-            _getResolvedLayout(branding, portal) {
-                var resolvedLayout = null;
-                //Check if view exists for branding and portal
-                var layoutToTest = sails.config.appPath + "/views/" + branding + "/" + portal + "/layout/layout.ejs";
-                if (pathExists.sync(layoutToTest)) {
-                    resolvedLayout = branding + "/" + portal + "/layout";
-                }
-                // If view doesn't exist, next try for portal with default branding
-                if (resolvedLayout == null) {
-                    layoutToTest = sails.config.appPath + "/views/default/" + portal + "/layout.ejs";
-                    if (pathExists.sync(layoutToTest)) {
-                        resolvedLayout = "/default/" + portal + "/layout";
-                    }
-                }
-                // If view still doesn't exist, next try for default portal with default branding
-                if (resolvedLayout == null) {
-                    layoutToTest = sails.config.appPath + "/views/default/default/" + "layout.ejs";
-                    if (pathExists.sync(layoutToTest)) {
-                        resolvedLayout = "default/default/layout";
-                    }
-                }
-                return resolvedLayout;
-            }
-            sendView(req, res, view, locals = {}) {
-                if (req.options.locals == null) {
-                    req.options.locals = {};
-                }
-                var mergedLocal = Object.assign({}, req.options.locals, locals);
-                var branding = mergedLocal['branding'];
-                var portal = mergedLocal['portal'];
-                var resolvedView = this._getResolvedView(branding, portal, view);
-                var resolvedLayout = this._getResolvedLayout(branding, portal);
-                // If we can resolve a layout set it.
-                if (resolvedLayout != null && mergedLocal["layout"] != false) {
-                    res.locals.layout = resolvedLayout;
-                }
-                // View still doesn't exist so return a 404
-                if (resolvedView == null) {
-                    res.notFound(mergedLocal, "404");
-                }
-                // Add some properties blueprints usually adds
-                // TODO: Doesn't seem to be binding properly. Investigate
-                mergedLocal.view = {};
-                mergedLocal.view.pathFromApp = resolvedView;
-                mergedLocal.view.ext = 'ejs';
-                // merge with ng2 app...
-                _.merge(mergedLocal, this.getNg2Apps(view));
-                let fullViewPath = sails.config.appPath + "/views/" + resolvedView;
-                mergedLocal['templateDirectoryLocation'] = fullViewPath.substring(0, fullViewPath.lastIndexOf('/') + 1);
-                sails.log.debug("resolvedView");
-                sails.log.debug(resolvedView);
-                sails.log.debug("mergedLocal");
-                sails.log.debug(mergedLocal);
-                res.view(resolvedView, mergedLocal);
-            }
-            respond(req, res, ajaxCb, normalCb, forceAjax = false) {
-                if (this.isAjax(req) || forceAjax == true) {
-                    return ajaxCb(req, res);
-                }
-                else {
-                    return normalCb(req, res);
-                }
-            }
-            isAjax(req) {
-                return req.headers['x-source'] == 'jsclient';
-            }
-            ajaxOk(req, res, msg = '', data = null, forceAjax = false) {
-                if (!data) {
-                    data = { status: true, message: msg };
-                }
-                this.ajaxRespond(req, res, data, forceAjax);
-            }
-            ajaxFail(req, res, msg = '', data = null, forceAjax = false) {
-                if (!data) {
-                    data = { status: false, message: msg };
-                }
-                this.ajaxRespond(req, res, data, forceAjax);
-            }
-            apiFail(req, res, statusCode = 500, errorResponse = new APIErrorResponse_1.APIErrorResponse()) {
-                // this.apiRespond(req, res, errorResponse, statusCode);
-                res.set('Cache-control', 'no-cache');
-                res.set('Pragma', 'no-cache');
-                res.set('Expires', 0);
-                res.status(statusCode);
-                return res.json(errorResponse);
-            }
-            apiRespond(req, res, jsonObj = null, statusCode = 200) {
-                var ajaxMsg = "Got ajax request, don't know what do...";
-                this.respond(req, res, (req, res) => {
-                    sails.log.verbose(ajaxMsg);
-                    res.notFound(ajaxMsg);
-                }, (req, res) => {
-                    res.set('Cache-control', 'no-cache');
-                    res.set('Pragma', 'no-cache');
-                    res.set('Expires', 0);
-                    res.status(statusCode);
-                    return res.json(jsonObj);
-                });
-            }
-            ajaxRespond(req, res, jsonObj = null, forceAjax) {
-                var notAjaxMsg = "Got non-ajax request, don't know what do...";
-                this.respond(req, res, (req, res) => {
-                    res.set('Cache-control', 'no-cache');
-                    res.set('Pragma', 'no-cache');
-                    res.set('Expires', 0);
-                    return res.json(jsonObj);
-                }, (req, res) => {
-                    sails.log.verbose(notAjaxMsg);
-                    res.notFound(notAjaxMsg);
-                }, forceAjax);
-            }
-            getNg2Apps(viewPath) {
-                if (sails.config.ng2.use_bundled && sails.config.ng2.apps[viewPath]) {
-                    return { ng2_apps: sails.config.ng2.apps[viewPath] };
-                }
-                else {
-                    return { ng2_apps: [] };
-                }
-            }
-        }
-        Core.Controller = Controller;
-    })(Core = Controllers.Core || (Controllers.Core = {}));
-})(Controllers = exports.Controllers || (exports.Controllers = {}));

package/dist/CoreService.d.ts

@@ -1,41 +0,0 @@
-import { Observable } from 'rxjs/Rx';
-export declare module Services.Core {
-    class Service {
-        /**
-         * Exported methods. Must be overridden by the child to add custom methods.
-         */
-        protected _exportedMethods: string[];
-        /**
-         * Default exported methods.
-         * These methods will be accessible.
-         */
-        private _defaultExportedMethods;
-        protected logHeader: string;
-        /**
-        * Returns an RxJS Observable wrapped nice and tidy for your subscribing pleasure
-        */
-        protected getObservable(q: any, method?: string, type?: string): Observable<any>;
-        /**
-        * Wrapper for straightforward query, no chaining..
-        */
-        protected exec(q: any, successFn: any, errorFn: any): void;
-        /**
-         * 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;
-        /**
-         * returns a string that is 'true' or 'false' (literal) depending on whether the 'options.triggerCondition' is met!
-         *
-         * @author <a target='_' href='https://github.com/shilob'>Shilo Banihit</a>
-         * @param  oid
-         * @param  record
-         * @param  options
-         * @return
-         */
-        protected metTriggerCondition(oid: any, record: any, options: any): string;
-        protected sleep(ms: any): Promise<unknown>;
-    }
-}

package/dist/CoreService.js

@@ -1,112 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Services = void 0;
-const Rx_1 = require("rxjs/Rx");
-// changed to a manual lodash load instead of relying on Sails global object
-// this enables testing of installable hooks that rely on services at load-time (i.e. index.js)
-const _ = require("lodash");
-var Services;
-(function (Services) {
-    var Core;
-    (function (Core) {
-        class Service {
-            constructor() {
-                /**
-                 * Exported methods. Must be overridden by the child to add custom methods.
-                 */
-                this._exportedMethods = [];
-                /**
-                 * Default exported methods.
-                 * These methods will be accessible.
-                 */
-                this._defaultExportedMethods = [
-                    // Sails controller custom config.
-                    '_config',
-                ];
-            }
-            /**
-            * Returns an RxJS Observable wrapped nice and tidy for your subscribing pleasure
-            */
-            getObservable(q, method = 'exec', type = 'node') {
-                if (type == 'node')
-                    return Rx_1.Observable.bindNodeCallback(q[method].bind(q))();
-                else
-                    return Rx_1.Observable.bindCallback(q[method].bind(q))();
-            }
-            /**
-            * Wrapper for straightforward query, no chaining..
-            */
-            exec(q, successFn, errorFn) {
-                this.getObservable(q).subscribe(successFn, errorFn);
-            }
-            /**
-             * 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() {
-                // Merge default array and custom array from child.
-                var methods = this._defaultExportedMethods.concat(this._exportedMethods);
-                var exportedMethods = {};
-                for (var i = 0; i < methods.length; i++) {
-                    // Check if the method exists.
-                    if (typeof this[methods[i]] !== 'undefined') {
-                        // Check that the method shouldn't be private. (Exception for _config, which is a sails config)
-                        if (methods[i][0] !== '_' || methods[i] === '_config') {
-                            if (_.isFunction(this[methods[i]])) {
-                                exportedMethods[methods[i]] = this[methods[i]].bind(this);
-                            }
-                            else {
-                                exportedMethods[methods[i]] = this[methods[i]];
-                            }
-                        }
-                        else {
-                            console.error('The method "' + methods[i] + '" is not public and cannot be exported. ' + this);
-                        }
-                    }
-                    else {
-                        console.error('The method "' + methods[i] + '" does not exist on the controller ' + this);
-                    }
-                }
-                return exportedMethods;
-            }
-            /**
-             * returns a string that is 'true' or 'false' (literal) depending on whether the 'options.triggerCondition' is met!
-             *
-             * @author <a target='_' href='https://github.com/shilob'>Shilo Banihit</a>
-             * @param  oid
-             * @param  record
-             * @param  options
-             * @return
-             */
-            metTriggerCondition(oid, record, options) {
-                const triggerCondition = _.get(options, "triggerCondition", "");
-                const forceRun = _.get(options, "forceRun", false);
-                const variables = {
-                    imports: {
-                        record: record,
-                        oid: oid
-                    }
-                };
-                if (!_.isUndefined(triggerCondition) && !_.isEmpty(triggerCondition)) {
-                    const compiled = _.template(triggerCondition, variables);
-                    return compiled();
-                }
-                else if (forceRun) {
-                    return "true";
-                }
-                else {
-                    // if trigger condition is not set, fail fast!
-                    return "false";
-                }
-            }
-            sleep(ms) {
-                return new Promise(resolve => {
-                    setTimeout(resolve, ms);
-                });
-            }
-        }
-        Core.Service = Service;
-    })(Core = Services.Core || (Services.Core = {}));
-})(Services = exports.Services || (exports.Services = {}));

package/dist/Datastream.d.ts

@@ -1,10 +0,0 @@
-/**
- * Base class for a datastream
- *
- */
-export declare class Datastream {
-    fileId: string;
-    metadata: any;
-    constructor(data?: any);
-}
-export default Datastream;