Merge pull request #181 from stephenyeargin/feature/ship-typings

Feature/ship typings

.devcontainer/devcontainer.json

@@ -23,7 +23,8 @@
 		"vscode": {
 			"extensions": [
 				"esbenp.prettier-vscode",
-				"GitHub.copilot"
+				"GitHub.copilot",
+				"streetsidesoftware.code-spell-checker"
 			]
 		}
 	}

.gitignore

@@ -42,7 +42,6 @@ coverage.json
 
 # Node versions (nodenv)
 .node-version
-.vscode/settings.json
 
 # npm pack result
 *.tgz

.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+    "cSpell.words": [
+      "autofitpanels",
+      "datasource",
+      "gnet",
+      "linewidth",
+      "pointradius",
+      "sparkline",
+      "stephenyeargin",
+      "templating",
+      "xaxis",
+      "yaxes",
+      "yaxis",
+      "Yeargin"
+    ]
+}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "hubot-grafana",
   "description": "Query Grafana dashboards",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "author": "Stephen Yeargin <stephen@yearg.in>",
   "license": "MIT",
   "keywords": [
@@ -18,31 +18,31 @@
     "url": "https://github.com/stephenyeargin/hubot-grafana/issues"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.378.0",
-    "node-fetch": "^2.6.12"
+    "@aws-sdk/client-s3": "^3.565.0",
+    "node-fetch": "^2.7.0"
   },
   "peerDependencies": {
     "hubot": ">=3 || 0.0.0-development"
   },
   "devDependencies": {
-    "@types/hubot": "^3.3.2",
-    "chai": "^4.3.7",
+    "@types/hubot": "^3.3.7",
+    "chai": "^4.4.1",
     "eslint": "^8.45.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.27.5",
     "hubot": "^7.0.0",
     "hubot-mock-adapter": "^2.0.0",
-    "husky": "^8.0.3",
-    "mocha": "^10.2.0",
-    "nock": "^13.3.2",
+    "husky": "^9.0.11",
+    "mocha": "^10.4.0",
+    "nock": "^13.5.4",
     "nyc": "^15.1.0"
   },
   "main": "index.js",
   "scripts": {
-    "test": "mocha \"test/**/*.js\" --reporter spec --no-experiemental-fetch --timeout 200",
+    "test": "mocha \"test/**/*.js\" --reporter spec --no-experimental-fetch --timeout 200",
     "test-with-coverage": "nyc --reporter=text mocha \"test/**/*.js\" --reporter spec",
     "bootstrap": "script/bootstrap",
-    "prepare": "husky install",
+    "prepare": "husky",
     "lint": "eslint src/ test/"
   },
   "files": [
@@ -54,5 +54,6 @@
   ],
   "volta": {
     "node": "18.19.0"
-  }
+  },
+  "types": "types.d.ts"
 }

src/grafana-client.js

@@ -121,16 +121,16 @@ class GrafanaClient {
     });
   }
 
-  createGrafanaChartLink(query, uid, panel, timespan, variables) {
+  createGrafanaChartLink(query, uid, panel, timeSpan, variables) {
     const url = new URL(`${this.host}/d/${uid}/`);
 
     if (panel) {
       url.searchParams.set('panelId', panel.id);
       url.searchParams.set('fullscreen', '');
     }
 
-    url.searchParams.set('from', timespan.from);
-    url.searchParams.set('to', timespan.to);
+    url.searchParams.set('from', timeSpan.from);
+    url.searchParams.set('to', timeSpan.to);
 
     if (variables) {
       const additionalParams = new URLSearchParams(variables);
@@ -150,7 +150,7 @@ class GrafanaClient {
     return url.toString().replace('fullscreen=&', 'fullscreen&');
   }
 
-  createImageUrl(query, uid, panel, timespan, variables) {
+  createImageUrl(query, uid, panel, timeSpan, variables) {
     const url = new URL(`${this.host}/render/${query.apiEndpoint}/${uid}/`);
 
     if (panel) {
@@ -162,8 +162,8 @@ class GrafanaClient {
 
     url.searchParams.set('width', query.width);
     url.searchParams.set('height', query.height);
-    url.searchParams.set('from', timespan.from);
-    url.searchParams.set('to', timespan.to);
+    url.searchParams.set('from', timeSpan.from);
+    url.searchParams.set('to', timeSpan.to);
 
     if (variables) {
       const additionalParams = new URLSearchParams(variables);

types.d.ts

@@ -1,10 +1,10 @@
 type DashboardChart = {
   imageUrl: string;
-  grafanaChartLink: grafanaChartLink;
+  grafanaChartLink: string;
   title: string;
 };
 
-namespace GrafanaDashboardResponse {
+declare namespace GrafanaDashboardResponse {
   type Response = {
     meta: Meta;
     dashboard: Dashboard;