{"id":22546547,"url":"https://github.com/deephaven/deephaven-js-plugin-template","last_synced_at":"2026-01-06T18:39:53.524Z","repository":{"id":91842828,"uuid":"458175923","full_name":"deephaven/deephaven-js-plugin-template","owner":"deephaven","description":"Deephaven JS Plugin template","archived":false,"fork":false,"pushed_at":"2024-05-22T13:11:32.000Z","size":1107,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-02-02T16:42:15.389Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deephaven.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-11T12:23:06.000Z","updated_at":"2024-05-22T13:11:37.000Z","dependencies_parsed_at":"2024-05-22T14:33:45.197Z","dependency_job_id":"cf36ec2c-2c6b-44df-af33-54c1e531be36","html_url":"https://github.com/deephaven/deephaven-js-plugin-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deephaven%2Fdeephaven-js-plugin-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deephaven%2Fdeephaven-js-plugin-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deephaven%2Fdeephaven-js-plugin-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deephaven%2Fdeephaven-js-plugin-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deephaven","download_url":"https://codeload.github.com/deephaven/deephaven-js-plugin-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246059336,"owners_count":20717085,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-07T15:08:10.540Z","updated_at":"2026-01-06T18:39:53.482Z","avatar_url":"https://github.com/deephaven.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DEPRECATED\n\nPlease use the [cookiecutter templates](https://github.com/deephaven/deephaven-plugins/tree/main/templates) instead.\n\nUse this Template to create a JavaScript Plugin. It is set up with TypeScript, React, ESLint, Prettier, sass, and image loader. Use this template as a starting point for creating new Deephaven JavaScript Module Plugins. Each JavaScript module may or may not include different plugin types, such as a `DashboardPlugin` or a `TablePlugin`.\n\n## Initial Setup\n\nAfter checking out this template for the first time:\n\n1. Do an `npm install`\n\n## Build the Plugin\n\n```bash\nnpm run build\n```\n\nYour output will be in `dist/index.js`\n\n## Source Files\n\nYour main source file is `src/index.ts`. From this file, export the plugin types you want to register. For example, you can export a `DashboardPlugin` and a `TablePlugin` from this file.\n\n## Installing the Plugin Module\n\n### Development Installation\n\nIn development, run `npm start` to start a local build that watches for changes. Anytime you make a change to the source code, your build will update. \nYou'll then need to define a `manifest.json` in the parent directory, using the name of this directory as the name of the plugin. For example, a proper manifest would be:\n```json\n{\n  \"plugins\": [{ \"name\": \"deephaven-js-plugin-template\", \"version\": \"0.0.1\", \"main\": \"dist/index.js\" }]\n}\n``` \nYou can then start up Deephaven using [the parent directory with the manifest.json file as the plugin directory](https://deephaven.io/core/docs/how-to-guides/configuration/js-plugins/#configuration):\n\n```bash\nSTART_OPTS=\"-Ddeephaven.jsPlugins.resourceBase=/path/to/manifest/directory\" ./gradlew server-jetty-app:run\n```\n\nThen, refresh your browser after making changes to the source code to see your changes.\n\n### Production Installation\n\nIn production, you need to publish your plugin:\n\n- [Publish your package](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages): You'll need to publish your package so it can be installed in a production Deephaven environment.\n- [Install the package](https://deephaven.io/core/docs/how-to-guides/configuration/js-plugins/#examples): After the plugin is published, you install the plugin in your Docker image so it can be used.\n\n## Plugin Types\n\nA module can optionally export one or more of the following types of plugins.\n\n### Dashboard Plugin (`DashboardPlugin`)\n\nExport a `DashboardPlugin` from the module to register a Dashboard Plugin. Dashboard Plugins can listen for and emit events on a Dashboard, register their own type of components for display in a Dashboard, and display their own UI overtop of a Dashboard.\n\n### Table Plugin (`TablePlugin`)\n\nSet the `PLUGIN_NAME` attribute on the Table with the name of the plugin.\n\n```python\nfrom deephaven import empty_table\nt = empty_table(5).update(\"X=i\")\nt = t.with_attributes({'PluginName': 'deephaven-js-plugin-template'})\n```\n\n### Authentication Plugin (`AuthenticationPlugin`)\n\nExport an `AuthenticationPlugin` from the module to register an Authentication Plugin. Authentication Plugins can provide a UI for authenticating users and provide credentials when connecting to the Deephaven server.\n\nFor some examples of the core Authentication Plugins, see the [@deephaven/auth-plugins](https://github.com/deephaven/web-client-ui/tree/main/packages/auth-plugins/src) package. This package includes plugins for anonymous, pre-shared key, and parent window authentication.\n\nFor a complete example of an Authentication Plugin that authenticates using Keycloak, see the [@deephaven/auth-keycloak](https://github.com/deephaven/deephaven-js-plugins/tree/main/plugins/auth-keycloak) repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeephaven%2Fdeephaven-js-plugin-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeephaven%2Fdeephaven-js-plugin-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeephaven%2Fdeephaven-js-plugin-template/lists"}