Ability to set host and scheme (#35)

* add setHost and setScheme

* update baseurl

* version bump

* add test for custom host and scheme

* update readme

Author: typpo

README.md

@@ -95,6 +95,14 @@ Sets the device pixel ratio of the chart.  This will multiply the number of pixe
 
 Sets the Chart.js version to use (e.g. `2.9.4` or `3.4.0`).  Valid options are shown in the [documentation](https://quickchart.io/documentation/#parameters).
 
+### setHost(host: string)
+
+Sets the host of generated URLs.  `quickchart.io` by default.
+
+### setScheme(scheme: string)
+
+Sets the scheme of generated URLs.  `https` by default.
+
 ## Getting outputs
 
 There are two ways to get a URL for your chart object.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "quickchart-js",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Javascript client for QuickChart.io",
   "main": "build/quickchart.cjs.js",
   "module": "build/quickchart.mjs",

src/index.ts

@@ -48,7 +48,6 @@ function postJson(url: string, payload: PostData): Promise<Response> {
 class QuickChart {
   private host: string;
   private scheme: string;
-  private baseUrl: string;
   private width: number;
   private height: number;
   private devicePixelRatio: number;
@@ -66,7 +65,6 @@ class QuickChart {
 
     this.host = 'quickchart.io';
     this.scheme = 'https';
-    this.baseUrl = `${this.scheme}://${this.host}`;
 
     this.chart = undefined;
     this.width = 500;
@@ -82,6 +80,16 @@ class QuickChart {
     return this;
   }
 
+  setHost(host: string): QuickChart {
+    this.host = host;
+    return this;
+  }
+
+  setScheme(scheme: string): QuickChart {
+    this.scheme = scheme;
+    return this;
+  }
+
   setWidth(width: number): QuickChart {
     this.width = width;
     return this;
@@ -119,11 +127,15 @@ class QuickChart {
     return true;
   }
 
+  private getBaseUrl(): string {
+    return `${this.scheme}://${this.host}`;
+  }
+
   private getUrlObject(): URL {
     if (!this.isValid()) {
       throw new Error('You must call setConfig before getUrl');
     }
-    const ret = new URL(`${this.baseUrl}/chart`);
+    const ret = new URL(`${this.getBaseUrl()}/chart`);
     ret.searchParams.append('c', this.chart!);
     ret.searchParams.append('w', String(this.width));
     ret.searchParams.append('h', String(this.height));
@@ -204,7 +216,7 @@ class QuickChart {
       throw new Error('Short URLs must use quickchart.io host');
     }
 
-    const resp = await postJson(`${this.baseUrl}/chart/create`, this.getPostData());
+    const resp = await postJson(`${this.getBaseUrl()}/chart/create`, this.getPostData());
     if (!resp.ok) {
       const quickchartError = resp.headers.get('x-quickchart-error');
       const details = quickchartError ? `\n${quickchartError}` : '';
@@ -224,7 +236,7 @@ class QuickChart {
       throw new Error('You must call setConfig before getUrl');
     }
 
-    const resp = await postJson(`${this.baseUrl}/chart`, this.getPostData());
+    const resp = await postJson(`${this.getBaseUrl()}/chart`, this.getPostData());
     if (!resp.ok) {
       const quickchartError = resp.headers.get('x-quickchart-error');
       const details = quickchartError ? `\n${quickchartError}` : '';

test/index.test.ts

@@ -15,6 +15,21 @@ test('basic chart, no auth', () => {
   expect(qc.getUrl()).toContain('h=300');
 });
 
+test('basic chart with custom host', () => {
+  const qc = new QuickChart();
+  qc.setHost('foo.com');
+  qc.setScheme('http');
+  qc.setConfig({
+    type: 'bar',
+    data: { labels: ['Hello world', 'Foo bar'], datasets: [{ label: 'Foo', data: [1, 2] }] },
+  });
+
+  expect(qc.getUrl()).toContain('http://foo.com/chart?');
+  expect(qc.getUrl()).toContain('Hello+world');
+  expect(qc.getUrl()).toContain('w=500');
+  expect(qc.getUrl()).toContain('h=300');
+});
+
 test('basic chart with auth', () => {
   const qc = new QuickChart('abc123', '12345');
   qc.setConfig({