automated release 1.0.0 [skip ci]

Author: CircleCI Automation

dist/CHANGELOG.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dist/LICENSE

@@ -0,0 +1,37 @@
+
+-----BEGIN PGP SIGNED MESSAGE-----
+Hash: SHA512
+
+{
+  "manifestVersion": "2.0.0",
+  "signatureType": "grafana",
+  "signedByOrg": "grafana",
+  "signedByOrgName": "Grafana Labs",
+  "plugin": "grafana-div-panel",
+  "version": "1.0.0",
+  "time": 1620511704659,
+  "keyId": "7e4d0c6a708866e7",
+  "files": {
+    "img/logo.svg": "745fb75066b18dcf4f31f6a5af9adaa85ecc9f89a53d97088c068e28cb1a58e6",
+    "img/logo.png": "e7b447f4452ae70fe19e51b68daeb16a5461613c7a0690db082f24074345f858",
+    "img/screenshot1.png": "2a2c9d6af6c8c0527b5149a3545b3eafa41d9dbd2b3cc495ae14644ebb91c1f4",
+    "img/echarts-gl-gps.png": "9c66a147d2fbe5e8a224d0625b7cdfc236193ce59de009f8217edcf20c66f3ee",
+    "module.js": "bc7833a5e0f4b0260e43b238d896319448c4fbf3833bdb279f7a125bf7db57b0",
+    "module.js.LICENSE.txt": "c4ab058faaafd72803e487b4ac2a53ee2d01fc94ce0a23c196a1324240112de5",
+    "module.js.map": "93d92201b3f94ac041ea6029f6a46ad150fb9071b14c3f29815d0d690edf45cf",
+    "README.md": "59dbc64ebef53efd89e6b3d3b8d24c11eb456cdb2affd5bbe095050a2b211a37",
+    "plugin.json": "4fa225e470a6b9919551f4e3dd9904a9912b02673b6dcf8b59c51f0e2a119264",
+    "LICENSE": "b40930bbcf80744c86c46a12bc9da056641d722716c378f5659b9e555ef833e1",
+    "CHANGELOG.md": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+  }
+}
+-----BEGIN PGP SIGNATURE-----
+Version: OpenPGP.js v4.10.1
+Comment: https://openpgpjs.org
+
+wqEEARMKAAYFAmCXC9gACgkQfk0ManCIZudSCgIIyb84lOTjByG5eM0veClw
+Hw5ILgiwiYoQd4fEbZvJmfBdXMLDNIeWrUqdola23gvgqm9lzenOjZxnwiIn
+66bX/gUCCQEkq87h4MMQqp6hVnN5+Kg7oABwJfXAgP0igY7WWhlUCoZh+899
+zrx6t1Whn8xeeuSsYemFBds7oLFx7Tn56MCHTA==
+=PIgE
+-----END PGP SIGNATURE-----

dist/MANIFEST.txt

@@ -0,0 +1,132 @@
+# Grafana DIV Panel
+
+![](https://raw.githubusercontent.com/srclosson/grafana-div-panel/master/src/img/screenshot1.png)
+![](https://raw.githubusercontent.com/srclosson/grafana-div-panel/master/src/img/echarts-gl-gps.png)
+
+The div panel is a generic panel allowing you to specify your own html and javascript
+Just write your html the same way you normally would:
+
+```
+<html>
+  <head>
+    <!-- Add anything so it's available when your body script is run
+    <link href="to/some.css" >
+    <script src="to/some.js" /></script>
+    -->
+  </head>
+  <body>
+    <div>
+        Hello Div Panel
+    </div>
+
+    <script>
+        /**
+         * @param elem The div element containing your div panel
+         */
+        function onDivPanelInit(elem) {
+          console.log("I am in init", elem);
+        }
+
+        /**
+         * @param elem The div element containing your panel
+         * @param content The content set by the editor you used while in edit mode
+         */
+        function onDivPanelEnterEditMode(elem, content) {
+          console.log("I entered edit mode", elem, content);
+        }
+
+        /**
+         * @param elem The div element containing your div panel
+         * @returns The html content to save and be loaded in onDivPanelEnterEditMode
+         */
+        function onDivPanelExitEditMode(elem) {
+          console.log("I exited edit mode", elem);
+          let html = '<p>Hello</p>';
+          return html;
+        }
+
+        /**
+         * @param data The data retrieved from your panel data config
+         */
+        function onDivPanelDataUpdate(data) {
+          console.log("I have data", data);
+        }
+        
+        console.log("Hello from my script!");
+    </script>
+  </body>
+</html>
+```
+
+Alternatively, you can use `script` tags and specify a `run` type. The same script above then would be:
+```
+<html>
+  <head>
+    <!-- Add anything so it's available when your body script is run
+    <link href="to/some.css" >
+    <script src="to/some.js" /></script>
+    -->
+  </head>
+  <body>
+    <div>
+        Hello Div Panel
+    </div>
+
+    <script run="oninit">
+      console.log("I am in init", elem);
+    </script>
+
+    <sceript run="onentereditmode">
+      console.log("I entered edit mode", elem, content);
+    </script>
+
+    <script run="onexiteditmode">
+      console.log("I exited edit mode", elem);
+      let html = '<p>Hello</p>';
+      return html;
+    <script>
+      
+    <script> run="ondata">
+      console.log("I have data", data);
+    </script>
+    
+    <script>
+      console.log("You will see this on all updates");
+    </script>
+  </body>
+</html>
+```
+
+It differs from other "DIY" panels in that it tries to allow as close as possible, the ability to load and use javascript
+libraries exactly as you would if you were developing an html page without grafana. Just open the embedded code editor (monaco)
+and write your code.
+
+## Features
+1. Builtin monaco code editor
+2. Support for handlebars templates. If you log your data from the `onDivPanelDataUpdate` callback, you can use handlebars addressing to reference the data. Your templates will be resolved when the panel renders.
+3. Support for script type="module".
+
+## Development workflow
+1. Write the code in the code editor.
+2. Hit `run` to run a data update
+3. Hit `clear` to clear the the rendered HTML+Javascript. When you hit run the next time, you will also get your `onDivPanelInit` callback.
+*Important* You must hit `<CTRL+S>` in the editor to save. When saving, your control will be re-rendered.
+
+## Callbacks
+There are four callbacks provided. 
+1. `onDivPanelInit`: Called when your panel is contructed and your html is available.
+2. `onDivPanelDataUpdate`: Called with the data retrieved from the datasource.
+3. `onDivPanelEnterEditMode`: Called whenever you enter edit mode.
+4. `onDivPanelExitEditMode`: Called whenever you exit edit mode.
+
+## Building
+To build:
+1. Clone this repo
+2. `yarn install`
+3. `yarn dev` (for a dev build) or `yarn build` (for a prod build that is minified)
+4. Restart grafana
+
+## Examples
+See the examples in the examples folder
+
+