datagrok-tools 4.13.16 → 4.13.17

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Datagrok-tools changelog
 
 
+## 4.13.17 (2024-08-27)
+
+### Features
+
+* Added decorators for viewer functions
+
 ## 4.13.16 (2024-08-23)
 
 ### Features

package/bin/commands/create.js

@@ -56,6 +56,7 @@ function createDirectoryContents(name, config, templateDir, packageDir) {
       if (file === 'package.json') {
         // Generate scripts for non-default servers from `config.yaml`
         var _package = JSON.parse(contents);
+        _package['scripts'] = {};
         for (var server in config.servers) {
           if (server === config["default"]) continue;
           _package['scripts']["debug-".concat(name.toLowerCase(), "-").concat(server)] = "webpack && grok publish ".concat(server);

package/entity-template/viewer.js

@@ -1,8 +1,34 @@
 
-//name: #{NAME}
-//description: Creates #{NAME} viewer
-//tags: viewer
-//output: viewer result
-export function _#{NAME}() {
-  return new #{NAME}();
+
+@grok.decorators.viewer({
+  name: '#{NAME}',
+  description: 'Creates #{NAME} viewer'
+})
+export class #{NAME}Viewer extends DG.JsViewer {
+  constructor() {
+    super();
+  }
+
+  // Additional chart settings
+  init() {
+  }
+  
+  // Stream subscriptions
+  onTableAttached() {
+    this.init();
+    this.render();
+  }
+
+  // Cancel subscriptions when the viewer is detached
+  detach() {
+  }
+  
+  // Override to handle property changes
+  onPropertyChanged(property : DG.Property | null) {
+    super.onPropertyChanged(property);
+    this.render();
+  }
+  
+  render(computeData = true) {
+  }
 }

package/package-template/src/package-test.ts

@@ -1,8 +1,9 @@
 import * as DG from "datagrok-api/dg";
-import {runTests, tests, TestContext} from '@datagrok-libraries/utils/src/test';
+import * as grok from 'datagrok-api/grok';
+import { runTests, tests, TestContext } from '@datagrok-libraries/utils/src/test';
 
 export let _package = new DG.Package();
-export {tests};
+export { tests };
 
 //name: test
 //input: string category {optional: true}
@@ -10,6 +11,6 @@ export {tests};
 //input: object testContext {optional: true}
 //output: dataframe result
 export async function test(category: string, test: string, testContext: TestContext): Promise<DG.DataFrame> {
-  const data = await runTests({category, test, testContext});
+  const data = await runTests({ category, test, testContext });
   return DG.DataFrame.fromObjects(data)!;
-}
+}

package/package-template/webpack.config.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const packageName = path.parse(require('./package.json').name).name.toLowerCase().replace(/-/g, '');
-
+const FuncGeneratorPlugin = require('datagrok-tools/plugins/func-gen-plugin');
 module.exports = {
   cache: {
     type: 'filesystem',
@@ -29,4 +29,7 @@ module.exports = {
     libraryTarget: 'var',
     path: path.resolve(__dirname, 'dist'),
   },
+  plugins: [
+    new FuncGeneratorPlugin({outputPath: './src/package.g.ts'}),
+  ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datagrok-tools",
-  "version": "4.13.16",
+  "version": "4.13.17",
   "description": "Utility to upload and publish packages to Datagrok",
   "homepage": "https://github.com/datagrok-ai/public/tree/master/tools#readme",
   "dependencies": {