websequencediagrams 2.0.1 → 3.0.0

package/README.md

@@ -13,6 +13,9 @@ Call the WebSequenceDiagram.com API.
     -s, --style   Output style (one of: [default, earth, modern-blue, mscgen,
                   omegapple, qsd, rose, roundgreen, napkin, magazine, vs2010,
                   patent])
+    -r, --root    The base URL for the service, which defaults to
+                  "http://www.websequencediagrams.com".  It can be modified
+                  to suit your needs, if you have a private installation.
     -k, --key     WebSequenceDiagrams API key.  Key can also be specified with
                   the WSD_APIKEY environment variable.  Requires a premium
                   account.  See https://www.websequencediagrams.com/order.html

package/bin/wsd_get

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-/* eslint-disable node/shebang */
 'use strict'
 
 const yargs = require('yargs')
@@ -30,6 +29,12 @@ const {argv} = yargs
       choices: wsd.styles,
       default: 'default',
     },
+    root: {
+      alias: 'r',
+      desc: 'WebSequenceDiagrams root URL',
+      type: 'string',
+      default: 'https://websequencediagrams.com',
+    },
     key: {
       alias: 'k',
       desc: 'WebSequenceDiagrams API key',
@@ -57,7 +62,7 @@ FileStream.createAll(files)
   .then(async streams => {
     for (const s of streams) {
       const inp = await s.read()
-      const [buf, typ] = await wsd.diagram(inp, argv.s, argv.f, argv.k)
+      const [buf, typ] = await wsd.diagram(inp, argv.s, argv.f, argv.k, argv.r)
 
       let output = argv.o
       if (!output) {

package/lib/fileStream.js

@@ -35,7 +35,6 @@ class FileStream {
     return new Promise((resolve, reject) => {
       const bufs = []
       this.stream.on('error', er => {
-        console.error(`error opening file ${this.name}`)
         reject(er)
       })
       this.stream.on('data', data => bufs.push(data))

package/lib/wsd.js

@@ -3,7 +3,7 @@
 const fetch = require('node-fetch')
 const {Buffer} = require('buffer')
 
-const root = 'http://www.websequencediagrams.com'
+const defaultRoot = 'http://www.websequencediagrams.com'
 const styles = [
   'default',
   'earth',
@@ -30,14 +30,24 @@ class WSD {
    *
    * @param {string|Buffer} message The diagram description.
    * @param {string} [style='default'] Style of the diagram.  Valid styles
-   *   include: 'default', 'earth', 'modern-blue', 'mscgen', 'omegapple', 'qsd',
-   *   'rose', 'roundgreen', 'napkin', 'magazine', 'vs2010', or 'patent'.
-   * @param {string} [format='png'] Format for the output.  Valid output formats
-   *   include: 'png', 'svg', or 'pdf'.  'pdf' requires a paid account.
+   *   include: 'default', 'earth', 'modern-blue', 'mscgen', 'omegapple',
+   *   'qsd', 'rose', 'roundgreen', 'napkin', 'magazine', 'vs2010', or
+   *   'patent'.
+   * @param {string} [format='png'] Format for the output.  Valid output
+   *   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
+   *   the service.
    * @returns {Promise<string>} The URL for the diagram.
    */
-  static async diagramURL(message, style = 'default', format = 'png', apikey = null) {
+  // eslint-disable-next-line max-params
+  static async diagramURL(
+    message, style = 'default',
+    format = 'png',
+    apikey = null,
+    root = defaultRoot
+  ) {
     if (message instanceof Buffer) {
       message = message.toString('utf8')
     }
@@ -62,7 +72,7 @@ class WSD {
         style,
         format,
       })
-    const res = await fetch(`${WSD.root}/index.php`, {
+    const res = await fetch(`${root}/index.php`, {
       method: 'POST',
       body: query,
     })
@@ -76,7 +86,7 @@ class WSD {
     if (jres.errors.length > 0) {
       throw new Error(jres.errors.join(', '))
     }
-    return `${WSD.root}/${jres.img}`
+    return `${root}/${jres.img}`
   }
 
   /**
@@ -91,11 +101,13 @@ 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] 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.
    */
-  static async diagram(description, style, format, apikey) {
-    const u = await WSD.diagramURL(description, style, format, apikey)
+  // 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()
@@ -103,6 +115,5 @@ class WSD {
   }
 }
 WSD.styles = styles
-WSD.root = root
 
 module.exports = WSD

package/package.json

@@ -1,8 +1,12 @@
 {
-  "author": "Joe Hildebrand <joe-github@cursive.net>",
   "name": "websequencediagrams",
   "description": "Interface to websequencediagrams.com",
-  "version": "2.0.1",
+  "version": "3.0.0",
+  "author": "Joe Hildebrand <joe-github@cursive.net>",
+  "contributors": [
+    "Ed Crump <ed.crump@gmail.com> (https://github.com/icedawn)",
+    "Michael Callaghan <michael@walkingriver.com> (https://walkingriver.com)"
+  ],
   "homepage": "https://github.com/hildjj/node-websequencediagrams",
   "repository": {
     "type": "git",
@@ -14,9 +18,6 @@
   },
   "main": "lib/wsd",
   "types": "types/wsd.d.ts",
-  "engines": {
-    "node": ">=12.19"
-  },
   "keywords": [
     "uml",
     "sequence diagram",
@@ -35,23 +36,23 @@
     "release": "npm version patch && git push --follow-tags && npm publish"
   },
   "devDependencies": {
-    "@cto.af/eslint-config": "^0.0.11",
-    "@types/node": "^16.11.4",
-    "ava": "^4.0.0-alpha.2",
+    "@cto.af/eslint-config": "^0.1.7",
+    "@types/node": "^18.11.5",
+    "ava": "^5.0.1",
     "coveralls": "^3.1.1",
-    "eslint": "^8.1.0",
-    "eslint-plugin-jsdoc": "^37.0.0",
-    "eslint-plugin-markdown": "^2.2.1",
+    "eslint": "^8.26.0",
+    "eslint-plugin-jsdoc": "^39.3.24",
+    "eslint-plugin-markdown": "^3.0.0",
     "eslint-plugin-node": "^11.1.0",
-    "nock": "^13.1.4",
+    "nock": "^13.2.9",
     "nyc": "^15.1.0",
-    "tmp-promise": "^3.0.2"
+    "tmp-promise": "^3.0.3"
   },
   "dependencies": {
     "node-fetch": "^2.6.5",
-    "yargs": "^17.2.1"
+    "yargs": "^17.6.0"
   },
-  "contributors": [
-    "Ed Crump <ed.crump@gmail.com> (https://github.com/icedawn)"
-  ]
+  "engines": {
+    "node": ">=14"
+  }
 }

package/types/fileStream.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 export = FileStream;
 /**
  * Promisified stream for a file.  Can be replaced with fs.promises one day.

package/types/wsd.d.ts

@@ -11,14 +11,18 @@ declare class WSD {
      *
      * @param {string|Buffer} message The diagram description.
      * @param {string} [style='default'] Style of the diagram.  Valid styles
-     *   include: 'default', 'earth', 'modern-blue', 'mscgen', 'omegapple', 'qsd',
-     *   'rose', 'roundgreen', 'napkin', 'magazine', 'vs2010', or 'patent'.
-     * @param {string} [format='png'] Format for the output.  Valid output formats
-     *   include: 'png', 'svg', or 'pdf'.  'pdf' requires a paid account.
+     *   include: 'default', 'earth', 'modern-blue', 'mscgen', 'omegapple',
+     *   'qsd', 'rose', 'roundgreen', 'napkin', 'magazine', 'vs2010', or
+     *   'patent'.
+     * @param {string} [format='png'] Format for the output.  Valid output
+     *   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
+     *   the service.
      * @returns {Promise<string>} The URL for the diagram.
      */
-    static diagramURL(message: string | Buffer, style?: string, format?: string, apikey?: string): Promise<string>;
+    static diagramURL(message: string | Buffer, style?: string, format?: string, apikey?: string, root?: string): Promise<string>;
     /**
      * Retrieve a diagram.
      *
@@ -31,15 +35,14 @@ declare class WSD {
      *   formats include: 'png', 'svg', or 'pdf'.  'pdf' requires a paid
      *   account.
      * @param {string} [apikey] API key for non-free usage.
-     * @returns {Promise<Array<{diagram:Buffer, mimeType:string}>>} Array with the
-     *   contents of the diagram and the MIME type of the response.
+     * @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.
      */
-    static diagram(description: string, style?: string, format?: string, apikey?: string): Promise<[Buffer, string]>; // MANUAL EDIT!
+    static diagram(description: string, style?: string, format?: string, apikey?: string, root?: string): Promise<any[]>;
 }
 declare namespace WSD {
     export { styles };
-    export { root };
 }
 import { Buffer } from "buffer";
 declare const styles: string[];
-declare const root: "http://www.websequencediagrams.com";