websequencediagrams 4.0.0 → 6.0.0

package/README.md

@@ -25,14 +25,14 @@ Call the WebSequenceDiagram.com API.
 Example:
 
 ```js
-const wsd = require('websequencediagrams')
-const fs = require('fs')
-
-;(async() => {
-  const [buf, typ] = await wsd.diagram('Alice->Bob: message', 'modern-blue', 'png')
-  console.log('Received MIME type:', typ)
-  fs.writeFile('my.png', buf)
-})()
+const wsd = require('websequencediagrams');
+const fs = require('node:fs');
+
+(async() => {
+  const [buf, typ] = await wsd.diagram('Alice->Bob: message', 'modern-blue', 'png');
+  console.log('Received MIME type:', typ);
+  fs.writeFile('my.png', buf);
+})();
 ```
 
 ### .diagram(text, style, output_type)
@@ -53,7 +53,7 @@ Returns a promise for a string containing the URL where the diagram can be found
 .styles is an array of all of the currently-known style types.
 
 ### .root
-.root is the URL for the service, which defaults to "http://www.websequencediagrams.com".  It can be modified to suit your needs.
+.root is the URL for the service, which defaults to "https://www.websequencediagrams.com".  It can be modified to suit your needs.
 
 ### License
 This code is licensed under the [Apache Software License, 2.0](http://www.apache.org/licenses/LICENSE-2.0)

package/bin/wsd_get

@@ -33,7 +33,7 @@ const {argv} = yargs
       alias: 'r',
       desc: 'WebSequenceDiagrams root URL',
       type: 'string',
-      default: 'https://websequencediagrams.com',
+      default: 'https://www.websequencediagrams.com',
     },
     key: {
       alias: 'k',

package/{types → lib}/fileStream.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 export = FileStream;
 /**
  * Promisified stream for a file.  Can be replaced with fs.promises one day.
@@ -30,5 +28,5 @@ declare class FileStream {
      */
     read(): Promise<Buffer>;
 }
-import fs = require("fs");
+import fs = require("node:fs");
 import { Buffer } from "buffer";

package/lib/fileStream.js

@@ -1,11 +1,9 @@
-'use strict'
+'use strict';
 
-const fs = require('fs')
-const path = require('path')
-const util = require('util')
-const {Buffer} = require('buffer')
-const stat = util.promisify(fs.stat)
-const readdir = util.promisify(fs.readdir)
+const fs = require('node:fs');
+const fsp = require('node:fs/promises');
+const path = require('node:path');
+const {Buffer} = require('node:buffer');
 
 /**
  * Promisified stream for a file.  Can be replaced with fs.promises one day.
@@ -17,12 +15,12 @@ class FileStream {
    * @param {string} [name='-'] File name, or '-' for stdin.
    */
   constructor(name = '-') {
-    this.name = name
+    this.name = name;
     if (name === '-') {
-      this.stream = process.stdin
-      process.stdin.resume()
+      this.stream = process.stdin;
+      process.stdin.resume();
     } else {
-      this.stream = fs.createReadStream(name)
+      this.stream = fs.createReadStream(name);
     }
   }
 
@@ -33,13 +31,11 @@ class FileStream {
    */
   read() {
     return new Promise((resolve, reject) => {
-      const bufs = []
-      this.stream.on('error', er => {
-        reject(er)
-      })
-      this.stream.on('data', data => bufs.push(data))
-      this.stream.on('end', () => resolve(Buffer.concat(bufs)))
-    })
+      const bufs = /** @type {Buffer[]} */([]);
+      this.stream.on('error', reject);
+      this.stream.on('data', (/** @type {Buffer} */ data) => bufs.push(data));
+      this.stream.on('end', () => resolve(Buffer.concat(bufs)));
+    });
   }
 
   /**
@@ -53,19 +49,19 @@ class FileStream {
     const streams = await Promise.all(names.map(async n => {
       if (n === '-') {
         // Prevent stat() throwing
-        return new FileStream()
+        return new FileStream();
       }
-      const stats = await stat(n)
+      const stats = await fsp.stat(n);
       if (stats.isDirectory()) {
-        const dir = await readdir(n)
+        const dir = await fsp.readdir(n);
         return dir
           .filter(f => f.endsWith('.wsd'))
-          .map(fn => new FileStream(path.join(n, fn)))
+          .map(fn => new FileStream(path.join(n, fn)));
       }
-      return new FileStream(n)
-    }))
-    return streams.flat()
+      return new FileStream(n);
+    }));
+    return streams.flat();
   }
 }
 
-module.exports = FileStream
+module.exports = FileStream;

package/{types → lib}/wsd.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export = WSD;
 /**
  * API for WebSequenceDiagrams.
@@ -18,7 +17,7 @@ declare class WSD {
      *   formats include: 'png', 'svg', or 'pdf'.  'pdf' requires a paid
      *   account.
      * @param {string} [apikey] API key for non-free usage.
-     * @param {string} [root='http://www.websequencediagrams.com'] Root URL for
+     * @param {string} [root='https://www.websequencediagrams.com'] Root URL for
      *   the service.
      * @returns {Promise<string>} The URL for the diagram.
      */
@@ -36,10 +35,11 @@ declare class WSD {
      *   account.
      * @param {string} [apikey] API key for non-free usage.
      * @param {string} [root] Root URL for the service.
-     * @returns {Promise<Array>} Array with the contents of the diagram as the
-     *   first item and the MIME type of the response as the second item.
+     * @returns {Promise<[Buffer, string]>} Array with the contents of the
+     *   diagram as the first item and the MIME type of the response as the
+     *   second item.
      */
-    static diagram(description: string, style?: string, format?: string, apikey?: string, root?: string): Promise<any[]>;
+    static diagram(description: string, style?: string, format?: string, apikey?: string, root?: string): Promise<[Buffer, string]>;
 }
 declare namespace WSD {
     export { styles };

package/lib/wsd.js

@@ -1,9 +1,9 @@
-'use strict'
+'use strict';
 
-const fetch = require('node-fetch')
-const {Buffer} = require('buffer')
+const {Buffer} = require('node:buffer');
+const {version} = require('../package.json');
 
-const defaultRoot = 'http://www.websequencediagrams.com'
+const defaultRoot = 'https://www.websequencediagrams.com';
 const styles = [
   'default',
   'earth',
@@ -17,7 +17,7 @@ const styles = [
   'magazine',
   'vs2010',
   'patent',
-]
+];
 
 /**
  * API for WebSequenceDiagrams.
@@ -37,56 +37,51 @@ class WSD {
    *   formats include: 'png', 'svg', or 'pdf'.  'pdf' requires a paid
    *   account.
    * @param {string} [apikey] API key for non-free usage.
-   * @param {string} [root='http://www.websequencediagrams.com'] Root URL for
+   * @param {string} [root='https://www.websequencediagrams.com'] Root URL for
    *   the service.
    * @returns {Promise<string>} The URL for the diagram.
    */
   // eslint-disable-next-line max-params
   static async diagramURL(
-    message, style = 'default',
+    message,
+    style = 'default',
     format = 'png',
-    apikey = null,
+    apikey = undefined,
     root = defaultRoot
   ) {
-    if (message instanceof Buffer) {
-      message = message.toString('utf8')
-    }
+    const msg = Buffer.isBuffer(message) ? message.toString('utf8') : message;
     if (WSD.styles.indexOf(style) === -1) {
-      throw new Error(`Unknown style: ${style}`)
+      throw new Error(`Unknown style: ${style}`);
     }
     if (['png', 'pdf', 'svg'].indexOf(format) === -1) {
-      throw new Error(`Unknown format: ${format}`)
+      throw new Error(`Unknown format: ${format}`);
     }
 
-    const query = new URLSearchParams(apikey ?
-      {
-        apiVersion: '1',
-        message,
-        style,
-        format,
-        apikey,
-      } :
-      {
-        apiVersion: '1',
-        message,
-        style,
-        format,
-      })
-    const res = await fetch(`${root}/index.php`, {
+    const query = new URLSearchParams({
+      apiVersion: '1',
+      message: msg,
+      style,
+      format,
+      ...(apikey ? {apikey} : {}),
+    });
+
+    const u = new URL('index.php', root);
+    const res = await fetch(u, {
       method: 'POST',
       body: query,
-    })
+      redirect: 'error',
+      headers: {
+        'user-agent': `node-websequencediagrams/${version}`,
+      },
+    });
     if (res.status !== 200) {
-      throw new Error(`HTTP Error: ${res.status}`)
-    }
-    const jres = await res.json()
-    if (!jres.errors) {
-      throw new Error(`Invalid JSON response: ${jres}`)
+      throw new Error(`${res.status} ${res.statusText}: ${res.headers.get('status')}`);
     }
-    if (jres.errors.length > 0) {
-      throw new Error(jres.errors.join(', '))
+    const jres = await res.json();
+    if (jres.errors?.length > 0) {
+      throw new Error(jres.errors.join(', '));
     }
-    return `${root}/${jres.img}`
+    return new URL(jres.img, root).toString();
   }
 
   /**
@@ -102,18 +97,19 @@ class WSD {
    *   account.
    * @param {string} [apikey] API key for non-free usage.
    * @param {string} [root] Root URL for the service.
-   * @returns {Promise<Array>} Array with the contents of the diagram as the
-   *   first item and the MIME type of the response as the second item.
+   * @returns {Promise<[Buffer, string]>} Array with the contents of the
+   *   diagram as the first item and the MIME type of the response as the
+   *   second item.
    */
   // eslint-disable-next-line max-params
   static async diagram(description, style, format, apikey, root) {
-    const u = await WSD.diagramURL(description, style, format, apikey, root)
-    const res = await fetch(u)
-    const ct = res.headers.get('content-type')
-    const buf = await res.buffer()
-    return [buf, ct]
+    const u = await WSD.diagramURL(description, style, format, apikey, root);
+    const res = await fetch(u);
+    const ct = res.headers.get('content-type') ?? 'text/plain';
+    const buf = await res.arrayBuffer();
+    return [Buffer.from(buf), ct];
   }
 }
-WSD.styles = styles
+WSD.styles = styles;
 
-module.exports = WSD
+module.exports = WSD;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "websequencediagrams",
   "description": "Interface to websequencediagrams.com",
-  "version": "4.0.0",
+  "version": "6.0.0",
   "author": "Joe Hildebrand <joe-github@cursive.net>",
   "contributors": [
     "Ed Crump <ed.crump@gmail.com> (https://github.com/icedawn)",
@@ -17,7 +17,6 @@
     "lib": "lib"
   },
   "main": "lib/wsd",
-  "types": "types/wsd.d.ts",
   "keywords": [
     "uml",
     "sequence diagram",
@@ -27,39 +26,10 @@
     "websequencediagrams.com"
   ],
   "license": "Apache-2.0",
-  "scripts": {
-    "test": "ava",
-    "lint": "eslint . --ext js,cjs,mjs,md bin/*",
-    "coverage": "c8 -r lcov npm test",
-    "release": "npm version patch && git push --follow-tags && npm publish"
-  },
-  "devDependencies": {
-    "@cto.af/eslint-config": "^2.0.3",
-    "@types/node": "^20.3.2",
-    "ava": "^5.3.1",
-    "c8": "8.0.0",
-    "eslint": "^8.43.0",
-    "eslint-plugin-jsdoc": "^46.4.2",
-    "eslint-plugin-markdown": "^3.0.0",
-    "eslint-plugin-node": "^11.1.0",
-    "nock": "^13.3.1",
-    "tmp-promise": "^3.0.3"
-  },
   "dependencies": {
-    "node-fetch": "2",
     "yargs": "^17.7.2"
   },
-  "pnpm": {
-    "overrides": {
-      "semver": ">=7.5.3",
-      "word-wrap": "npm:@aashutoshrathi/word-wrap"
-    }
-  },
-  "overrides": {
-    "semver": ">=7.5.3",
-    "word-wrap": "npm:@aashutoshrathi/word-wrap"
-  },
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   }
 }