@datagrok-libraries/utils 0.5.0 → 0.7.1

package/.eslintrc.json

@@ -53,7 +53,6 @@
       }
     ],
     "guard-for-in": "off",
-    "prefer-spread": "warn",
-    "valid-jsdoc": "warn"
+    "prefer-spread": "warn"
   }
 }

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "fullName": "Utils",
-  "version": "0.5.0",
+  "version": "0.7.1",
   "description": "Common utilities",
   "dependencies": {
     "@types/node": "^14.14.37",
@@ -14,17 +14,16 @@
     "exceljs": "^4.3.0",
     "html2canvas": "^1.4.1",
     "node-fetch": "^2.6.0",
-    "rxjs": "^7.4.0",
     "wu": "latest"
   },
   "devDependencies": {
     "@types/wu": "latest",
     "@typescript-eslint/eslint-plugin": "^5.11.0",
     "@typescript-eslint/parser": "^5.11.0",
-    "eslint": "^8.8.0",
+    "eslint": "^8.18.0",
     "eslint-config-google": "^0.14.0",
     "ts-loader": "^9.2.6",
-    "typescript": "^4.2.3"
+    "typescript": "^4.6.0"
   },
   "scripts": {
     "link": "npm link",

package/src/computation-view.d.ts

@@ -15,5 +15,18 @@ import { FunctionView } from './function-view';
  * - notifications for changing inputs, completion of computations, etc: {@link onInputChanged}
  * */
 export declare class ComputationView extends FunctionView {
+    /** Override to customize getting help feature
+      * @stability Stable
+    */
+    getHelp: (() => Promise<void>) | null;
+    /** Override to customize bug reporting feature
+      * @stability Stable
+    */
+    reportBug: (() => Promise<void>) | null;
+    /**
+     * Looks for {@link reportBug}, {@link getHelp} and {@link exportConfig} members and creates model menus
+     * @stability Stable
+    */
+    buildRibbonMenu(): void;
 }
 //# sourceMappingURL=computation-view.d.ts.map

package/src/computation-view.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"computation-view.d.ts","sourceRoot":"","sources":["computation-view.ts"],"names":[],"mappings":"AAKA,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAE7C;;;;;;;;;;;;;;KAcK;AACL,qBAAa,eAAgB,SAAQ,YAAY;CAEhD"}
+{"version":3,"file":"computation-view.d.ts","sourceRoot":"","sources":["computation-view.ts"],"names":[],"mappings":"AAKA,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAE7C;;;;;;;;;;;;;;KAcK;AACL,qBAAa,eAAgB,SAAQ,YAAY;IAC/C;;MAEE;IACF,OAAO,EAAE,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAQ;IAE7C;;MAEE;IACF,SAAS,EAAE,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAQ;IAE/C;;;MAGE;IACO,eAAe;CAoBzB"}

package/src/computation-view.js

@@ -1,3 +1,13 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as DG from 'datagrok-api/dg';
 import { FunctionView } from './function-view';
 /**
  * Base class for handling Compute models (see https://github.com/datagrok-ai/public/blob/master/help/compute/compute.md).
@@ -15,5 +25,36 @@ import { FunctionView } from './function-view';
  * - notifications for changing inputs, completion of computations, etc: {@link onInputChanged}
  * */
 export class ComputationView extends FunctionView {
+    constructor() {
+        super(...arguments);
+        /** Override to customize getting help feature
+          * @stability Stable
+        */
+        this.getHelp = null;
+        /** Override to customize bug reporting feature
+          * @stability Stable
+        */
+        this.reportBug = null;
+    }
+    /**
+     * Looks for {@link reportBug}, {@link getHelp} and {@link exportConfig} members and creates model menus
+     * @stability Stable
+    */
+    buildRibbonMenu() {
+        super.buildRibbonMenu();
+        if (!this.exportConfig && !this.reportBug && !this.getHelp)
+            return;
+        const ribbonMenu = this.ribbonMenu.group('Model');
+        if (this.exportConfig && this.exportConfig.supportedFormats.length > 0) {
+            ribbonMenu
+                .group('Export')
+                .items(this.exportConfig.supportedFormats, (format) => __awaiter(this, void 0, void 0, function* () { return DG.Utils.download(this.exportConfig.filename(format), yield this.exportConfig.export(format)); }))
+                .endGroup();
+        }
+        if (this.reportBug)
+            ribbonMenu.item('Report a bug', () => this.reportBug());
+        if (this.getHelp)
+            ribbonMenu.item('Help', () => this.getHelp());
+    }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tcHV0YXRpb24tdmlldy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbImNvbXB1dGF0aW9uLXZpZXcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBS0EsT0FBTyxFQUFDLFlBQVksRUFBQyxNQUFNLGlCQUFpQixDQUFDO0FBRTdDOzs7Ozs7Ozs7Ozs7OztLQWNLO0FBQ0wsTUFBTSxPQUFPLGVBQWdCLFNBQVEsWUFBWTtDQUVoRCIsInNvdXJjZXNDb250ZW50IjpbIi8qIGVzbGludC1kaXNhYmxlIG1heC1sZW4gKi9cbi8qIGVzbGludC1kaXNhYmxlIHZhbGlkLWpzZG9jICovXG5pbXBvcnQgKiBhcyBncm9rIGZyb20gJ2RhdGFncm9rLWFwaS9ncm9rJztcbmltcG9ydCAqIGFzIHVpIGZyb20gJ2RhdGFncm9rLWFwaS91aSc7XG5pbXBvcnQgKiBhcyBERyBmcm9tICdkYXRhZ3Jvay1hcGkvZGcnO1xuaW1wb3J0IHtGdW5jdGlvblZpZXd9IGZyb20gJy4vZnVuY3Rpb24tdmlldyc7XG5cbi8qKlxuICogQmFzZSBjbGFzcyBmb3IgaGFuZGxpbmcgQ29tcHV0ZSBtb2RlbHMgKHNlZSBodHRwczovL2dpdGh1Yi5jb20vZGF0YWdyb2stYWkvcHVibGljL2Jsb2IvbWFzdGVyL2hlbHAvY29tcHV0ZS9jb21wdXRlLm1kKS5cbiAqIEluIG1vc3QgY2FzZXMsIHRoZSBjb21wdXRhdGlvbiBpcyBhIHNpbXBsZSB7QGxpbmsgRnVuY31cbiAqIEV4dGVuZCBpdCBpbiBjYXNlcyB3aGVyZSBhIGJlaGF2aW9yIG9yIFVJIG5vdCBzdXBwb3J0ZWQgYnkgdGhlIHtAbGluayBGdW5jdGlvblZpZXd9IGlzIG5lZWRlZC5cbiAqXG4gKiBJdCBwcm92aWRlcyB0aGUgZm9sbG93aW5nIGZ1bmN0aW9uYWxpdHkgb3V0LW9mLXRoZS1ib3gsIHdoZXJlIGVhY2ggc2VjdGlvbiBjb3VsZCBiZSBjdXN0b21pemVkOlxuICogLSBhIHN0cnVjdHVyZWQgd2F5IHRvIHJlcHJlc2VudCBpbnB1dCBhbmQgb3V0cHV0IHBhcmFtZXRlcnM6IHtAbGluayBwYXJhbWV0ZXJzfVxuICogLSBnZW5lcmljIHdheSB0byBnZW5lcmF0ZSBVSSBmb3IgaW5wdXRzLCBvdXRwdXRzLCBhbmQgaW50ZXJhY3Rpdml0eSAocnVubmluZyB0aGUgbW9kZWwsIGV0YylcbiAqICAgLSBwZXJzaXN0aW5nIGhpc3RvcmljYWwgcmVzdWx0cyB0byB0aGUgZGIgKHZpYSB7QGxpbmsgcGFyYW1ldGVyc30pXG4gKiAtIGV4cG9ydCAodG8gRXhjZWwgYW5kIFBERik6IHtAbGluayBleHBvcnR9XG4gKiAtIGVhc3kgbG9hZGluZyBvZiBoaXN0b3JpY2FsIHJ1bnNcbiAqIC0gcm91dGluZ1xuICogLSBlbnRlcmluZyB0aGUgcmVhbCwgbWVhc3VyZWQgKGFzIG9wcG9zZWQgdG8gcHJlZGljdGVkKSB2YWx1ZXMgbWFudWFsbHlcbiAqIC0gbm90aWZpY2F0aW9ucyBmb3IgY2hhbmdpbmcgaW5wdXRzLCBjb21wbGV0aW9uIG9mIGNvbXB1dGF0aW9ucywgZXRjOiB7QGxpbmsgb25JbnB1dENoYW5nZWR9XG4gKiAqL1xuZXhwb3J0IGNsYXNzIENvbXB1dGF0aW9uVmlldyBleHRlbmRzIEZ1bmN0aW9uVmlldyB7XG5cbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tcHV0YXRpb24tdmlldy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbImNvbXB1dGF0aW9uLXZpZXcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7O0FBSUEsT0FBTyxLQUFLLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUN0QyxPQUFPLEVBQUMsWUFBWSxFQUFDLE1BQU0saUJBQWlCLENBQUM7QUFFN0M7Ozs7Ozs7Ozs7Ozs7O0tBY0s7QUFDTCxNQUFNLE9BQU8sZUFBZ0IsU0FBUSxZQUFZO0lBQWpEOztRQUNFOztVQUVFO1FBQ0YsWUFBTyxHQUFpQyxJQUFJLENBQUM7UUFFN0M7O1VBRUU7UUFDRixjQUFTLEdBQWlDLElBQUksQ0FBQztJQTBCakQsQ0FBQztJQXhCQzs7O01BR0U7SUFDTyxlQUFlO1FBQ3RCLEtBQUssQ0FBQyxlQUFlLEVBQUUsQ0FBQztRQUV4QixJQUFJLENBQUMsSUFBSSxDQUFDLFlBQVksSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTztZQUFFLE9BQU87UUFFbkUsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7UUFFbEQsSUFBSSxJQUFJLENBQUMsWUFBWSxJQUFJLElBQUksQ0FBQyxZQUFZLENBQUMsZ0JBQWdCLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRTtZQUN0RSxVQUFVO2lCQUNQLEtBQUssQ0FBQyxRQUFRLENBQUM7aUJBQ2YsS0FBSyxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsZ0JBQWdCLEVBQUUsQ0FBTyxNQUFjLEVBQUUsRUFBRSxnREFBQyxPQUFBLEVBQUUsQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxZQUFhLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxFQUFFLE1BQU0sSUFBSSxDQUFDLFlBQWEsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQSxHQUFBLENBQUM7aUJBQ3BLLFFBQVEsRUFBRSxDQUFDO1NBQ2Y7UUFFRCxJQUFJLElBQUksQ0FBQyxTQUFTO1lBQ2hCLFVBQVUsQ0FBQyxJQUFJLENBQUMsY0FBYyxFQUFFLEdBQUcsRUFBRSxDQUFDLElBQUksQ0FBQyxTQUFVLEVBQUUsQ0FBQyxDQUFDO1FBRTNELElBQUksSUFBSSxDQUFDLE9BQU87WUFDZCxVQUFVLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxHQUFHLEVBQUUsQ0FBQyxJQUFJLENBQUMsT0FBUSxFQUFFLENBQUMsQ0FBQztJQUNuRCxDQUFDO0NBQ0YiLCJzb3VyY2VzQ29udGVudCI6WyIvKiBlc2xpbnQtZGlzYWJsZSB2YWxpZC1qc2RvYyAqL1xuLyogZXNsaW50LWRpc2FibGUgbWF4LWxlbiAqL1xuaW1wb3J0ICogYXMgZ3JvayBmcm9tICdkYXRhZ3Jvay1hcGkvZ3Jvayc7XG5pbXBvcnQgKiBhcyB1aSBmcm9tICdkYXRhZ3Jvay1hcGkvdWknO1xuaW1wb3J0ICogYXMgREcgZnJvbSAnZGF0YWdyb2stYXBpL2RnJztcbmltcG9ydCB7RnVuY3Rpb25WaWV3fSBmcm9tICcuL2Z1bmN0aW9uLXZpZXcnO1xuXG4vKipcbiAqIEJhc2UgY2xhc3MgZm9yIGhhbmRsaW5nIENvbXB1dGUgbW9kZWxzIChzZWUgaHR0cHM6Ly9naXRodWIuY29tL2RhdGFncm9rLWFpL3B1YmxpYy9ibG9iL21hc3Rlci9oZWxwL2NvbXB1dGUvY29tcHV0ZS5tZCkuXG4gKiBJbiBtb3N0IGNhc2VzLCB0aGUgY29tcHV0YXRpb24gaXMgYSBzaW1wbGUge0BsaW5rIEZ1bmN9XG4gKiBFeHRlbmQgaXQgaW4gY2FzZXMgd2hlcmUgYSBiZWhhdmlvciBvciBVSSBub3Qgc3VwcG9ydGVkIGJ5IHRoZSB7QGxpbmsgRnVuY3Rpb25WaWV3fSBpcyBuZWVkZWQuXG4gKlxuICogSXQgcHJvdmlkZXMgdGhlIGZvbGxvd2luZyBmdW5jdGlvbmFsaXR5IG91dC1vZi10aGUtYm94LCB3aGVyZSBlYWNoIHNlY3Rpb24gY291bGQgYmUgY3VzdG9taXplZDpcbiAqIC0gYSBzdHJ1Y3R1cmVkIHdheSB0byByZXByZXNlbnQgaW5wdXQgYW5kIG91dHB1dCBwYXJhbWV0ZXJzOiB7QGxpbmsgcGFyYW1ldGVyc31cbiAqIC0gZ2VuZXJpYyB3YXkgdG8gZ2VuZXJhdGUgVUkgZm9yIGlucHV0cywgb3V0cHV0cywgYW5kIGludGVyYWN0aXZpdHkgKHJ1bm5pbmcgdGhlIG1vZGVsLCBldGMpXG4gKiAgIC0gcGVyc2lzdGluZyBoaXN0b3JpY2FsIHJlc3VsdHMgdG8gdGhlIGRiICh2aWEge0BsaW5rIHBhcmFtZXRlcnN9KVxuICogLSBleHBvcnQgKHRvIEV4Y2VsIGFuZCBQREYpOiB7QGxpbmsgZXhwb3J0fVxuICogLSBlYXN5IGxvYWRpbmcgb2YgaGlzdG9yaWNhbCBydW5zXG4gKiAtIHJvdXRpbmdcbiAqIC0gZW50ZXJpbmcgdGhlIHJlYWwsIG1lYXN1cmVkIChhcyBvcHBvc2VkIHRvIHByZWRpY3RlZCkgdmFsdWVzIG1hbnVhbGx5XG4gKiAtIG5vdGlmaWNhdGlvbnMgZm9yIGNoYW5naW5nIGlucHV0cywgY29tcGxldGlvbiBvZiBjb21wdXRhdGlvbnMsIGV0Yzoge0BsaW5rIG9uSW5wdXRDaGFuZ2VkfVxuICogKi9cbmV4cG9ydCBjbGFzcyBDb21wdXRhdGlvblZpZXcgZXh0ZW5kcyBGdW5jdGlvblZpZXcge1xuICAvKiogT3ZlcnJpZGUgdG8gY3VzdG9taXplIGdldHRpbmcgaGVscCBmZWF0dXJlXG4gICAgKiBAc3RhYmlsaXR5IFN0YWJsZVxuICAqL1xuICBnZXRIZWxwOiAoKCkgPT4gUHJvbWlzZTx2b2lkPikgfCBudWxsID0gbnVsbDtcblxuICAvKiogT3ZlcnJpZGUgdG8gY3VzdG9taXplIGJ1ZyByZXBvcnRpbmcgZmVhdHVyZVxuICAgICogQHN0YWJpbGl0eSBTdGFibGVcbiAgKi9cbiAgcmVwb3J0QnVnOiAoKCkgPT4gUHJvbWlzZTx2b2lkPikgfCBudWxsID0gbnVsbDtcblxuICAvKipcbiAgICogTG9va3MgZm9yIHtAbGluayByZXBvcnRCdWd9LCB7QGxpbmsgZ2V0SGVscH0gYW5kIHtAbGluayBleHBvcnRDb25maWd9IG1lbWJlcnMgYW5kIGNyZWF0ZXMgbW9kZWwgbWVudXNcbiAgICogQHN0YWJpbGl0eSBTdGFibGVcbiAgKi9cbiAgb3ZlcnJpZGUgYnVpbGRSaWJib25NZW51KCkge1xuICAgIHN1cGVyLmJ1aWxkUmliYm9uTWVudSgpO1xuXG4gICAgaWYgKCF0aGlzLmV4cG9ydENvbmZpZyAmJiAhdGhpcy5yZXBvcnRCdWcgJiYgIXRoaXMuZ2V0SGVscCkgcmV0dXJuO1xuXG4gICAgY29uc3QgcmliYm9uTWVudSA9IHRoaXMucmliYm9uTWVudS5ncm91cCgnTW9kZWwnKTtcblxuICAgIGlmICh0aGlzLmV4cG9ydENvbmZpZyAmJiB0aGlzLmV4cG9ydENvbmZpZy5zdXBwb3J0ZWRGb3JtYXRzLmxlbmd0aCA+IDApIHtcbiAgICAgIHJpYmJvbk1lbnVcbiAgICAgICAgLmdyb3VwKCdFeHBvcnQnKVxuICAgICAgICAuaXRlbXModGhpcy5leHBvcnRDb25maWcuc3VwcG9ydGVkRm9ybWF0cywgYXN5bmMgKGZvcm1hdDogc3RyaW5nKSA9PiBERy5VdGlscy5kb3dubG9hZCh0aGlzLmV4cG9ydENvbmZpZyEuZmlsZW5hbWUoZm9ybWF0KSwgYXdhaXQgdGhpcy5leHBvcnRDb25maWchLmV4cG9ydChmb3JtYXQpKSlcbiAgICAgICAgLmVuZEdyb3VwKCk7XG4gICAgfVxuXG4gICAgaWYgKHRoaXMucmVwb3J0QnVnKVxuICAgICAgcmliYm9uTWVudS5pdGVtKCdSZXBvcnQgYSBidWcnLCAoKSA9PiB0aGlzLnJlcG9ydEJ1ZyEoKSk7XG5cbiAgICBpZiAodGhpcy5nZXRIZWxwKVxuICAgICAgcmliYm9uTWVudS5pdGVtKCdIZWxwJywgKCkgPT4gdGhpcy5nZXRIZWxwISgpKTtcbiAgfVxufVxuIl19

package/src/function-view.d.ts

@@ -1,81 +1,166 @@
-import * as rxjs from 'rxjs';
 import * as DG from 'datagrok-api/dg';
 export declare class FunctionView extends DG.ViewBase {
-    constructor(funcCall: DG.FuncCall | null);
-    get func(): DG.Func;
-    onViewInitialized: rxjs.Subject<void>;
-    onInputChanged: rxjs.Subject<void>;
-    onComputationStarted: rxjs.Subject<DG.FuncCall>;
-    onComputationCompleted: rxjs.Subject<DG.FuncCall>;
-    onComputationSucceeded: rxjs.Subject<DG.FuncCall>;
-    onComputationError: rxjs.Subject<DG.FuncCall>;
-    private _type;
+    protected readonly context: DG.Context;
+    protected _funcCall?: DG.FuncCall;
+    protected _lastCall?: DG.FuncCall;
+    protected _type: string;
+    constructor(funcCall?: DG.FuncCall);
+    /**
+     * Get current function call of the view
+     * @returns The actual funccall associated with the view
+     * @stability Stable
+   */
+    get funcCall(): DG.FuncCall | undefined;
+    /**
+     * Get Func of the view
+     * @returns The actual func associated with the view
+     * @stability Stable
+   */
+    get func(): DG.Func | undefined;
+    /**
+     * Get data of last call of associated function
+     * @returns The actual func associated with the view
+     * @stability Stable
+   */
+    get lastCall(): DG.FuncCall | undefined;
+    /**
+     * Set data of last call of associated function
+     * @stability Stable
+   */
+    set lastCall(lastCall: DG.FuncCall | undefined);
+    /**
+     * View type
+     * @stability Stable
+   */
     get type(): string;
-    get isInputPanelRequired(): boolean;
-    get tabsLabels(): string[];
-    readonly context: DG.Context;
-    preparedCall: DG.FuncCall | null;
-    lastCall: DG.FuncCall | null;
-    protected outputCategories: string[];
-    protected paramToCategoryMap: Record<string, string[]>;
-    init(funcCall: DG.FuncCall): Promise<void>;
-    /** Override to create a fully custom UI */
-    build(): HTMLElement;
-    /** Override to create a custom input block. */
+    /** Export options. Could be overriden partially, using default implementation of each option.
+      * @stability Stable
+    */
+    exportConfig: {
+        /** Override to provide custom export logic.
+          * Default implementation {@link defaultExport} heavily relies on the default implementation of {@link buildIO}.
+          * @returns Blob with data to be exported into the file.
+          * @stability Stable
+        */
+        export: ((format: string) => Promise<Blob>);
+        /** Filename for exported files. Override for custom filenames.
+          * Default implementation is {@link defaultExportFilename}
+          * @param format Format name to be exported
+          * @returns The actual filename to be used for the generated file.
+          * @stability Stable
+        */
+        filename: ((format: string) => string);
+        /** Override to provide custom list of supported export formats.
+         * Default implementation is {@link defaultSupportedExportFormats}
+         * These formats are available under the "Export" popup on the ribbon panel.
+         * @returns The array of formats available for the export.
+         * @stability Stable
+        */
+        supportedFormats: string[];
+        /** Override to provide custom file extensions for exported formats.
+           * Default implementation is {@link defaultSupportedExportExtensions}
+           * These extensions are used in filenames {@link exportFilename}.
+           * @returns The mapping between supported export formats and their extensions.
+           * @stability Stable
+         */
+        supportedExtensions: Record<string, string>;
+    } | null;
+    /**
+     * Link FuncCall to the view
+     * @param funcCall The actual funccall to be associated with the view
+     * @stability Stable
+   */
+    linkFunccall(funcCall: DG.FuncCall): void;
+    /**
+     * Method for custom logic that could not be placed in the constructor.
+     * Any async methods and most of the logic should be placed here.
+     * @stability Stable
+   */
+    init(): Promise<void>;
+    /**
+     * Override to create a fully custom UI including ribbon menus and panels
+     * @stability Stable
+   */
+    build(): void;
+    /**
+     * Override to create a custom input-output block
+     * @returns The HTMLElement with whole UI excluding ribbon menus and panels
+     * @stability Stable
+   */
+    buildIO(): HTMLElement;
+    /**
+     * Override to create a custom input block
+     * @returns The HTMLElement with input block UI on the left side by default
+     * @stability Stable
+   */
     buildInputBlock(): HTMLElement;
-    /** Override to create a custom output block. */
+    /**
+     * Override to create a custom output block.
+     * @returns The HTMLElement with input block UI on the left side by default
+     * @stability Stable
+   */
     buildOutputBlock(): HTMLElement;
-    /** Override to create a custom historical runs control. */
+    /**
+     * Override to create a custom historical runs control.
+     * @returns The HTMLElement with history block UI
+     * @stability Experimental
+   */
     buildHistoryBlock(): HTMLElement;
-    /** Override to create a custom input control. */
+    /**
+     * Looks for {@link supportedExportFormats} members and creates ribbon panel
+     * @returns The HTMLElements of ribbonPanels
+     * @stability Stable
+   */
     buildRibbonPanels(): HTMLElement[][];
-    /** Override to create a custom ribbon menu on the top. */
+    /**
+     * Override to create a custom ribbon menu on the top.
+     * @stability Stable
+   */
     buildRibbonMenu(): void;
-    /** Override to create bug reporting feature */
-    reportBug: (() => Promise<void>) | null;
-    /** Filename for exported files. Override for custom names */
-    exportFilename(format: string): string;
-    /** Override to provide supported export formats.
-     * These formats are available under the "Export" popup on the ribbon panel. */
-    get supportedExportFormats(): string[];
-    /** Override to provide custom file extensions for exported formats.
-     * These formats are available under the "Export" popup on the ribbon panel. */
-    get supportedExportExtensions(): Record<string, string>;
-    /** Override to provide custom export. Obligatory to override if custom {@link build()} or {@link buildOutputBlock()} is overriden. */
-    export(format: string): Promise<Blob>;
-    /** Saves the computation results to the historical results, returns its id. See also {@link loadRun}. */
-    saveRun(call: DG.FuncCall): Promise<string>;
-    /** Loads the specified historical results. See also {@link saveRun}. */
-    loadRun(runId: string): Promise<DG.FuncCall>;
-    /** Loads all the function call of this function. */
+    /**
+     * Saves the computation results to the historical results, returns its id. See also {@link loadRun}.
+     * @stability Experimental
+   */
+    saveRun(): Promise<DG.FuncCall>;
+    /**
+     * Loads the specified historical run. See also {@link saveRun}.
+     * @stability Experimental
+   */
+    loadRun(funcCallId: string): Promise<DG.FuncCall>;
+    /**
+     * Loads all the function call of this function.
+     * Designed to pull hstorical runs in fast manner and the call {@link loadRun} with specified run ID.
+     * WARNING: FuncCall inputs/outputs are not included
+     * @stability Experimental
+   */
     pullRuns(): Promise<DG.FuncCall[]>;
-    clearResults(switchToOutput?: boolean): void;
     run(): Promise<void>;
-    compute(call: DG.FuncCall): Promise<void>;
-    outputParametersToView(call: DG.FuncCall): void;
-    renderRunSection(call: DG.FuncCall): HTMLElement;
-    showInputs: boolean;
-    singleDfParam: boolean;
-    paramGridSwitches: Map<string, HTMLElement>;
-    paramViewers: Map<string, DG.Viewer[]>;
-    paramSpans: Map<string, HTMLElement>;
-    resultTabs: Map<String, HTMLElement>;
-    resultsTabControl: DG.TabControl | undefined;
-    resultsDiv: HTMLElement;
-    controlsRoot: HTMLDivElement;
-    resultsRoot: HTMLDivElement;
-    historyRoot: HTMLDivElement;
-    inputsDiv: HTMLDivElement;
-    appendResultDataFrame(param: DG.FuncCallParam, options?: {
-        caption?: string;
-        category?: string;
-        height?: number;
-    }): void;
-    appendResultScalar(param: DG.FuncCallParam, options: {
-        caption?: string;
-        category: string;
-        height?: number;
-    }): void;
-    _appendResultElement(d: HTMLElement, category?: string): void;
+    protected defaultExportFilename: (format: string) => string;
+    protected defaultSupportedExportExtensions: () => {
+        Excel: string;
+    };
+    protected defaultSupportedExportFormats: () => string[];
+    protected defaultExport: (format: string) => Promise<Blob>;
+    protected get isInputPanelRequired(): boolean;
+    protected get outParamCategories(): string[];
+    protected get outputTabsLabels(): string[];
+    protected get tabsLabels(): string[];
+    protected get paramToCategoryMap(): Record<string, string[]>;
+    protected renderRunSection(call: DG.FuncCall): HTMLElement;
+    private clearResults;
+    private outputParametersToView;
+    protected paramGridSwitches: Map<string, HTMLElement>;
+    protected existingParamViewers: Map<string, DG.Viewer[]>;
+    protected paramSpans: Map<string, HTMLElement>;
+    protected resultTabs: Map<String, HTMLElement>;
+    protected resultsTabControl: DG.TabControl | undefined;
+    protected resultsDiv: HTMLElement;
+    protected controlsRoot: HTMLDivElement;
+    protected resultsRoot: HTMLDivElement;
+    protected historyRoot: HTMLDivElement;
+    protected inputsRoot: HTMLDivElement;
+    private appendOutputDf;
+    private appendResultScalar;
+    private appendResultElement;
 }
 //# sourceMappingURL=function-view.d.ts.map

package/src/function-view.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"function-view.d.ts","sourceRoot":"","sources":["function-view.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAItC,qBAAa,YAAa,SAAQ,EAAE,CAAC,QAAQ;gBAC/B,QAAQ,EAAE,EAAE,CAAC,QAAQ,GAAG,IAAI;IAWxC,IAAI,IAAI,YAEP;IAED,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAsB;IAC3D,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAsB;IAExD,oBAAoB,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAsB;IACrE,sBAAsB,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAsB;IACvE,sBAAsB,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAsB;IACvE,kBAAkB,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAsB;IAEnE,OAAO,CAAC,KAAK,CAAsB;IACnC,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,oBAAoB,YAE9B;IAED,IAAW,UAAU,aAEpB;IAED,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC;IACtB,YAAY,EAAE,EAAE,CAAC,QAAQ,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,EAAE,CAAC,QAAQ,GAAG,IAAI,CAAQ;IAC3C,SAAS,CAAC,gBAAgB,WAAkB;IAC5C,SAAS,CAAC,kBAAkB,2BAAkC;IAExD,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ;IAmDhC,2CAA2C;IAC3C,KAAK,IAAI,WAAW;IAOpB,+CAA+C;IAC/C,eAAe,IAAI,WAAW;IAO9B,gDAAgD;IAChD,gBAAgB,IAAI,WAAW;IAM/B,2DAA2D;IAC3D,iBAAiB,IAAI,WAAW;IAkBhC,iDAAiD;IACjD,iBAAiB,IAAI,WAAW,EAAE,EAAE;IAcpC,0DAA0D;IAC1D,eAAe;IAmBf,+CAA+C;IAC/C,SAAS,EAAE,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAQ;IAE/C,6DAA6D;IAC7D,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAItC;mFAC+E;IAC/E,IAAI,sBAAsB,IAAI,MAAM,EAAE,CAIrC;IAED;mFAC+E;IAC/E,IAAI,yBAAyB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAItD;IAED,sIAAsI;IAChI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuH3C,yGAAyG;IACnG,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IAKjD,wEAAwE;IAClE,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAKlD,oDAAoD;IAC9C,QAAQ,IAAI,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;IAMxC,YAAY,CAAC,cAAc,GAAE,OAAc;IA4BrC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAYpB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C,sBAAsB,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,GAAG,IAAI;IAY/C,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,GAAG,WAAW;IAgBhD,UAAU,EAAE,OAAO,CAAS;IAC5B,aAAa,EAAE,OAAO,CAAS;IAE/B,iBAAiB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAa;IAExD,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CAAa;IAEnD,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAa;IAEjD,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAa;IACjD,iBAAiB,EAAE,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC;IAC7C,UAAU,EAAE,WAAW,CAAqC;IAC5D,YAAY,EAAE,cAAc,CAAY;IACxC,WAAW,EAAE,cAAc,CAAY;IACvC,WAAW,EAAE,cAAc,CAAuD;IAClF,SAAS,EAAE,cAAc,CAA6C;IAEtE,qBAAqB,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;IA6FjH,kBAAkB,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,EAAE,OAAO,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;IAa5G,oBAAoB,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,MAAM;CAMvD"}
+{"version":3,"file":"function-view.d.ts","sourceRoot":"","sources":["function-view.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAMtC,qBAAa,YAAa,SAAQ,EAAE,CAAC,QAAQ;IAC3C,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC;IACvC,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC;IAClC,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC;IAClC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAc;gBAEzB,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ;IAgBlC;;;;KAIC;IACD,IAAW,QAAQ,IAAI,EAAE,CAAC,QAAQ,GAAG,SAAS,CAE7C;IAED;;;;KAIC;IACD,IAAI,IAAI,wBAEP;IAED;;;;KAIC;IACD,IAAI,QAAQ,IAQW,EAAE,CAAC,QAAQ,GAAG,SAAS,CAN7C;IAED;;;KAGC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,GAAG,SAAS,EAE7C;IAED;;;KAGC;IACD,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;MAEE;IACF,YAAY,EAAE;QACZ;;;;UAIE;QACF,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QAG5C;;;;;UAKE;QACF,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;QAEvC;;;;;UAKE;QACF,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAE3B;;;;;WAKG;QACH,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC7C,GAAG,IAAI,CAAQ;IAEhB;;;;KAIC;IACM,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ;IAIzC;;;;KAIC;IACY,IAAI;IAqBjB;;;KAGC;IACM,KAAK,IAAI,IAAI;IAQpB;;;;KAIC;IACM,OAAO,IAAI,WAAW;IAe7B;;;;KAIC;IACM,eAAe,IAAI,WAAW;IASrC;;;;KAIC;IACM,gBAAgB,IAAI,WAAW;IAMtC;;;;KAIC;IACM,iBAAiB,IAAI,WAAW;IAkBvC;;;;KAIC;IACD,iBAAiB,IAAI,WAAW,EAAE,EAAE;IAcpC;;;KAGC;IACM,eAAe;IAItB;;;KAGC;IACY,OAAO,IAAI,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAK5C;;;KAGC;IACY,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC;IAI9D;;;;;KAKC;IACY,QAAQ,IAAI,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;IAKlC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAYjC,SAAS,CAAC,qBAAqB,WAAY,MAAM,YAE/C;IAEF,SAAS,CAAC,gCAAgC;;MAIxC;IAEF,SAAS,CAAC,6BAA6B,iBAErC;IAEF,SAAS,CAAC,aAAa,WAAkB,MAAM,mBAmH7C;IAEF,SAAS,KAAK,oBAAoB,YAEjC;IAED,SAAS,KAAK,kBAAkB,aAI/B;IAED,SAAS,KAAK,gBAAgB,aAK7B;IAED,SAAS,KAAK,UAAU,aAEvB;IAED,SAAS,KAAK,kBAAkB,6BAQ/B;IAGD,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,GAAG,WAAW;IAgB1D,OAAO,CAAC,YAAY;IAmBpB,OAAO,CAAC,sBAAsB;IAY9B,SAAS,CAAC,iBAAiB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAa;IAElE,SAAS,CAAC,oBAAoB,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CAAa;IAErE,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAa;IAE3D,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAa;IAC3D,SAAS,CAAC,iBAAiB,EAAE,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC;IACvD,SAAS,CAAC,UAAU,EAAE,WAAW,CAAqC;IAEtE,SAAS,CAAC,YAAY,EAAE,cAAc,CAA8C;IACpF,SAAS,CAAC,WAAW,EAAE,cAAc,CAAY;IACjD,SAAS,CAAC,WAAW,EAAE,cAAc,CAAuD;IAC5F,SAAS,CAAC,UAAU,EAAE,cAAc,CAA6C;IAEjF,OAAO,CAAC,cAAc;IA4FtB,OAAO,CAAC,kBAAkB;IAa1B,OAAO,CAAC,mBAAmB;CAM5B"}