solid-server 5.8.6 → 5.8.8-22f4cfec

package/bin/lib/{options.js → options.mjs}

@@ -1,405 +1,379 @@
-const fs = require('fs')
-const path = require('path')
-const validUrl = require('valid-url')
-const { URL } = require('url')
-const { isEmail } = require('validator')
-
-module.exports = [
-  // {
-  //   abbr: 'v',
-  //   flag: true,
-  //   help: 'Print the logs to console\n'
-  // },
-  {
-    name: 'root',
-    help: "Root folder to serve (default: './data')",
-    question: 'Path to the folder you want to serve. Default is',
-    default: './data',
-    prompt: true,
-    filter: (value) => path.resolve(value)
-  },
-  {
-    name: 'port',
-    help: 'SSL port to use',
-    question: 'SSL port to run on. Default is',
-    default: '8443',
-    prompt: true
-  },
-  {
-    name: 'server-uri',
-    question: 'Solid server uri (with protocol, hostname and port)',
-    help: "Solid server uri (default: 'https://localhost:8443')",
-    default: 'https://localhost:8443',
-    validate: validUri,
-    prompt: true
-  },
-  {
-    name: 'webid',
-    help: 'Enable WebID authentication and access control (uses HTTPS)',
-    flag: true,
-    default: true,
-    question: 'Enable WebID authentication',
-    prompt: true
-  },
-  {
-    name: 'mount',
-    help: "Serve on a specific URL path (default: '/')",
-    question: 'Serve Solid on URL path',
-    default: '/',
-    prompt: true
-  },
-  {
-    name: 'config-path',
-    question: 'Path to the config directory (for example: ./config)',
-    default: './config',
-    prompt: true
-  },
-  {
-    name: 'config-file',
-    question: 'Path to the config file (for example: ./config.json)',
-    default: './config.json',
-    prompt: true
-  },
-  {
-    name: 'db-path',
-    question: 'Path to the server metadata db directory (for users/apps etc)',
-    default: './.db',
-    prompt: true
-  },
-  {
-    name: 'auth',
-    help: 'Pick an authentication strategy for WebID: `tls` or `oidc`',
-    question: 'Select authentication strategy',
-    type: 'list',
-    choices: [
-      'WebID-OpenID Connect'
-    ],
-    prompt: false,
-    default: 'WebID-OpenID Connect',
-    filter: (value) => {
-      if (value === 'WebID-OpenID Connect') return 'oidc'
-    },
-    when: (answers) => {
-      return answers.webid
-    }
-  },
-  {
-    name: 'use-owner',
-    question: 'Do you already have a WebID?',
-    type: 'confirm',
-    default: false,
-    hide: true
-  },
-  {
-    name: 'owner',
-    help: 'Set the owner of the storage (overwrites the root ACL file)',
-    question: 'Your webid (to overwrite the root ACL with)',
-    prompt: false,
-    validate: function (value) {
-      if (value === '' || !value.startsWith('http')) {
-        return 'Enter a valid Webid'
-      }
-      return true
-    },
-    when: function (answers) {
-      return answers['use-owner']
-    }
-  },
-  {
-    name: 'ssl-key',
-    help: 'Path to the SSL private key in PEM format',
-    validate: validPath,
-    prompt: true
-  },
-  {
-    name: 'ssl-cert',
-    help: 'Path to the SSL certificate key in PEM format',
-    validate: validPath,
-    prompt: true
-  },
-  {
-    name: 'no-reject-unauthorized',
-    help: 'Accept self-signed certificates',
-    flag: true,
-    default: false,
-    prompt: false
-  },
-  {
-    name: 'multiuser',
-    help: 'Enable multi-user mode',
-    question: 'Enable multi-user mode',
-    flag: true,
-    default: false,
-    prompt: true
-  },
-  {
-    name: 'idp',
-    help: 'Obsolete; use --multiuser',
-    prompt: false
-  },
-  {
-    name: 'no-live',
-    help: 'Disable live support through WebSockets',
-    flag: true,
-    default: false
-  },
-  {
-    name: 'no-prep',
-    help: 'Disable Per Resource Events',
-    flag: true,
-    default: false
-  },
-  // {
-  //   full: 'default-app',
-  //   help: 'URI to use as a default app for resources (default: https://linkeddata.github.io/warp/#/list/)'
-  // },
-  {
-    name: 'use-cors-proxy',
-    help: 'Do you want to have a CORS proxy endpoint?',
-    flag: true,
-    default: false,
-    hide: true
-  },
-  {
-    name: 'proxy',
-    help: 'Obsolete; use --corsProxy',
-    prompt: false
-  },
-  {
-    name: 'cors-proxy',
-    help: 'Serve the CORS proxy on this path',
-    when: function (answers) {
-      return answers['use-cors-proxy']
-    },
-    default: '/proxy',
-    prompt: true
-  },
-  {
-    name: 'auth-proxy',
-    help: 'Object with path/server pairs to reverse proxy',
-    default: {},
-    prompt: false,
-    hide: true
-  },
-  {
-    name: 'suppress-data-browser',
-    help: 'Suppress provision of a data browser',
-    flag: true,
-    prompt: false,
-    default: false,
-    hide: false
-  },
-  {
-    name: 'data-browser-path',
-    help: 'An HTML file which is sent to allow users to browse the data (eg using mashlib.js)',
-    question: 'Path of data viewer page (defaults to using mashlib)',
-    validate: validPath,
-    default: 'default',
-    prompt: false
-  },
-  {
-    name: 'suffix-acl',
-    full: 'suffix-acl',
-    help: "Suffix for acl files (default: '.acl')",
-    default: '.acl',
-    prompt: false
-  },
-  {
-    name: 'suffix-meta',
-    full: 'suffix-meta',
-    help: "Suffix for metadata files (default: '.meta')",
-    default: '.meta',
-    prompt: false
-  },
-  {
-    name: 'secret',
-    help: 'Secret used to sign the session ID cookie (e.g. "your secret phrase")',
-    question: 'Session secret for cookie',
-    default: 'random',
-    prompt: false,
-    filter: function (value) {
-      if (value === '' || value === 'random') {
-        return
-      }
-      return value
-    }
-  },
-  // {
-  //   full: 'no-error-pages',
-  //   flag: true,
-  //   help: 'Disable custom error pages (use Node.js default pages instead)'
-  // },
-  {
-    name: 'error-pages',
-    help: 'Folder from which to look for custom error pages files (files must be named <error-code>.html -- eg. 500.html)',
-    validate: validPath,
-    prompt: false
-  },
-  {
-    name: 'force-user',
-    help: 'Force a WebID to always be logged in (useful when offline)'
-  },
-  {
-    name: 'strict-origin',
-    help: 'Enforce same origin policy in the ACL',
-    flag: true,
-    default: false,
-    prompt: false
-  },
-  {
-    name: 'use-email',
-    help: 'Do you want to set up an email service?',
-    flag: true,
-    prompt: true,
-    default: false
-  },
-  {
-    name: 'email-host',
-    help: 'Host of your email service',
-    prompt: true,
-    default: 'smtp.gmail.com',
-    when: (answers) => {
-      return answers['use-email']
-    }
-  },
-  {
-    name: 'email-port',
-    help: 'Port of your email service',
-    prompt: true,
-    default: '465',
-    when: (answers) => {
-      return answers['use-email']
-    }
-  },
-  {
-    name: 'email-auth-user',
-    help: 'User of your email service',
-    prompt: true,
-    when: (answers) => {
-      return answers['use-email']
-    },
-    validate: (value) => {
-      if (!value) {
-        return 'You must enter this information'
-      }
-      return true
-    }
-  },
-  {
-    name: 'email-auth-pass',
-    help: 'Password of your email service',
-    type: 'password',
-    prompt: true,
-    when: (answers) => {
-      return answers['use-email']
-    }
-  },
-  {
-    name: 'use-api-apps',
-    help: 'Do you want to load your default apps on /api/apps?',
-    flag: true,
-    prompt: false,
-    default: true
-  },
-  {
-    name: 'api-apps',
-    help: 'Path to the folder to mount on /api/apps',
-    prompt: true,
-    validate: validPath,
-    when: (answers) => {
-      return answers['use-api-apps']
-    }
-  },
-  { // copied from name: 'owner'
-    name: 'redirect-http-from',
-    help: 'HTTP port or \',\'-separated ports to redirect to the solid server port (e.g. "80,8080").',
-    prompt: false,
-    validate: function (value) {
-      if (!value.match(/^[0-9]+(,[0-9]+)*$/)) {
-        return 'direct-port(s) must be a comma-separated list of integers.'
-      }
-      const list = value.split(/,/).map(v => parseInt(v))
-      const bad = list.find(v => { return v < 1 || v > 65535 })
-      if (bad.length) {
-        return 'redirect-http-from port(s) ' + bad + ' out of range'
-      }
-      return true
-    }
-  },
-  {
-    // This property is packaged into an object for the server property in config.json
-    name: 'server-info-name', // All properties with prefix server-info- will be removed from the config
-    help: 'A name for your server (not required, but will be presented on your server\'s frontpage)',
-    prompt: true,
-    default: answers => new URL(answers['server-uri']).hostname
-  },
-  {
-    // This property is packaged into an object for the server property in config.json
-    name: 'server-info-description', // All properties with prefix server-info- will be removed from the config
-    help: 'A description of your server (not required)',
-    prompt: true
-  },
-  {
-    // This property is packaged into an object for the server property in config.json
-    name: 'server-info-logo', // All properties with prefix server-info- will be removed from the config
-    help: 'A logo that represents you, your brand, or your server (not required)',
-    prompt: true
-  },
-  {
-    name: 'enforce-toc',
-    help: 'Do you want to enforce Terms & Conditions for your service?',
-    flag: true,
-    prompt: true,
-    default: false,
-    when: answers => answers.multiuser
-  },
-  {
-    name: 'toc-uri',
-    help: 'URI to your Terms & Conditions',
-    prompt: true,
-    validate: validUri,
-    when: answers => answers['enforce-toc']
-  },
-  {
-    name: 'disable-password-checks',
-    help: 'Do you want to disable password strength checking?',
-    flag: true,
-    prompt: true,
-    default: false,
-    when: answers => answers.multiuser
-  },
-  {
-    name: 'support-email',
-    help: 'The support email you provide for your users (not required)',
-    prompt: true,
-    validate: (value) => {
-      if (value && !isEmail(value)) {
-        return 'Must be a valid email'
-      }
-      return true
-    },
-    when: answers => answers.multiuser
-  }
-]
-
-function validPath (value) {
-  if (value === 'default') {
-    return Promise.resolve(true)
-  }
-  if (!value) {
-    return Promise.resolve('You must enter a valid path')
-  }
-  return new Promise((resolve) => {
-    fs.stat(value, function (err) {
-      if (err) return resolve('Nothing found at this path')
-      return resolve(true)
-    })
-  })
-}
-
-function validUri (value) {
-  if (!validUrl.isUri(value)) {
-    return 'Enter a valid uri (with protocol)'
-  }
-  return true
-}
+import fs from 'fs'
+import path from 'path'
+import validUrl from 'valid-url'
+import { URL } from 'url'
+import validator from 'validator'
+const { isEmail } = validator
+
+const options = [
+  {
+    name: 'root',
+    help: "Root folder to serve (default: './data')",
+    question: 'Path to the folder you want to serve. Default is',
+    default: './data',
+    prompt: true,
+    filter: (value) => path.resolve(value)
+  },
+  {
+    name: 'port',
+    help: 'SSL port to use',
+    question: 'SSL port to run on. Default is',
+    default: '8443',
+    prompt: true
+  },
+  {
+    name: 'server-uri',
+    question: 'Solid server uri (with protocol, hostname and port)',
+    help: "Solid server uri (default: 'https://localhost:8443')",
+    default: 'https://localhost:8443',
+    validate: validUri,
+    prompt: true
+  },
+  {
+    name: 'webid',
+    help: 'Enable WebID authentication and access control (uses HTTPS)',
+    flag: true,
+    default: true,
+    question: 'Enable WebID authentication',
+    prompt: true
+  },
+  {
+    name: 'mount',
+    help: "Serve on a specific URL path (default: '/')",
+    question: 'Serve Solid on URL path',
+    default: '/',
+    prompt: true
+  },
+  {
+    name: 'config-path',
+    question: 'Path to the config directory (for example: ./config)',
+    default: './config',
+    prompt: true
+  },
+  {
+    name: 'config-file',
+    question: 'Path to the config file (for example: ./config.json)',
+    default: './config.json',
+    prompt: true
+  },
+  {
+    name: 'db-path',
+    question: 'Path to the server metadata db directory (for users/apps etc)',
+    default: './.db',
+    prompt: true
+  },
+  {
+    name: 'auth',
+    help: 'Pick an authentication strategy for WebID: `tls` or `oidc`',
+    question: 'Select authentication strategy',
+    type: 'list',
+    choices: [
+      'WebID-OpenID Connect'
+    ],
+    prompt: false,
+    default: 'WebID-OpenID Connect',
+    filter: (value) => {
+      if (value === 'WebID-OpenID Connect') return 'oidc'
+    },
+    when: (answers) => answers.webid
+  },
+  {
+    name: 'use-owner',
+    question: 'Do you already have a WebID?',
+    type: 'confirm',
+    default: false,
+    hide: true
+  },
+  {
+    name: 'owner',
+    help: 'Set the owner of the storage (overwrites the root ACL file)',
+    question: 'Your webid (to overwrite the root ACL with)',
+    prompt: false,
+    validate: function (value) {
+      if (value === '' || !value.startsWith('http')) {
+        return 'Enter a valid Webid'
+      }
+      return true
+    },
+    when: function (answers) {
+      return answers['use-owner']
+    }
+  },
+  {
+    name: 'ssl-key',
+    help: 'Path to the SSL private key in PEM format',
+    validate: validPath,
+    prompt: true
+  },
+  {
+    name: 'ssl-cert',
+    help: 'Path to the SSL certificate key in PEM format',
+    validate: validPath,
+    prompt: true
+  },
+  {
+    name: 'no-reject-unauthorized',
+    help: 'Accept self-signed certificates',
+    flag: true,
+    default: false,
+    prompt: false
+  },
+  {
+    name: 'multiuser',
+    help: 'Enable multi-user mode',
+    question: 'Enable multi-user mode',
+    flag: true,
+    default: false,
+    prompt: true
+  },
+  {
+    name: 'idp',
+    help: 'Obsolete; use --multiuser',
+    prompt: false
+  },
+  {
+    name: 'no-live',
+    help: 'Disable live support through WebSockets',
+    flag: true,
+    default: false
+  },
+  {
+    name: 'no-prep',
+    help: 'Disable Per Resource Events',
+    flag: true,
+    default: false
+  },
+  {
+    name: 'use-cors-proxy',
+    help: 'Do you want to have a CORS proxy endpoint?',
+    flag: true,
+    default: false,
+    hide: true
+  },
+  {
+    name: 'proxy',
+    help: 'Obsolete; use --corsProxy',
+    prompt: false
+  },
+  {
+    name: 'cors-proxy',
+    help: 'Serve the CORS proxy on this path',
+    when: function (answers) {
+      return answers['use-cors-proxy']
+    },
+    default: '/proxy',
+    prompt: true
+  },
+  {
+    name: 'auth-proxy',
+    help: 'Object with path/server pairs to reverse proxy',
+    default: {},
+    prompt: false,
+    hide: true
+  },
+  {
+    name: 'suppress-data-browser',
+    help: 'Suppress provision of a data browser',
+    flag: true,
+    prompt: false,
+    default: false,
+    hide: false
+  },
+  {
+    name: 'data-browser-path',
+    help: 'An HTML file which is sent to allow users to browse the data (eg using mashlib.js)',
+    question: 'Path of data viewer page (defaults to using mashlib)',
+    validate: validPath,
+    default: 'default',
+    prompt: false
+  },
+  {
+    name: 'suffix-acl',
+    full: 'suffix-acl',
+    help: "Suffix for acl files (default: '.acl')",
+    default: '.acl',
+    prompt: false
+  },
+  {
+    name: 'suffix-meta',
+    full: 'suffix-meta',
+    help: "Suffix for metadata files (default: '.meta')",
+    default: '.meta',
+    prompt: false
+  },
+  {
+    name: 'secret',
+    help: 'Secret used to sign the session ID cookie (e.g. "your secret phrase")',
+    question: 'Session secret for cookie',
+    default: 'random',
+    prompt: false,
+    filter: function (value) {
+      if (value === '' || value === 'random') {
+        return
+      }
+      return value
+    }
+  },
+  {
+    name: 'error-pages',
+    help: 'Folder from which to look for custom error pages files (files must be named <error-code>.html -- eg. 500.html)',
+    validate: validPath,
+    prompt: false
+  },
+  {
+    name: 'force-user',
+    help: 'Force a WebID to always be logged in (useful when offline)'
+  },
+  {
+    name: 'strict-origin',
+    help: 'Enforce same origin policy in the ACL',
+    flag: true,
+    default: false,
+    prompt: false
+  },
+  {
+    name: 'use-email',
+    help: 'Do you want to set up an email service?',
+    flag: true,
+    prompt: true,
+    default: false
+  },
+  {
+    name: 'email-host',
+    help: 'Host of your email service',
+    prompt: true,
+    default: 'smtp.gmail.com',
+    when: (answers) => answers['use-email']
+  },
+  {
+    name: 'email-port',
+    help: 'Port of your email service',
+    prompt: true,
+    default: '465',
+    when: (answers) => answers['use-email']
+  },
+  {
+    name: 'email-auth-user',
+    help: 'User of your email service',
+    prompt: true,
+    when: (answers) => answers['use-email'],
+    validate: (value) => {
+      if (!value) {
+        return 'You must enter this information'
+      }
+      return true
+    }
+  },
+  {
+    name: 'email-auth-pass',
+    help: 'Password of your email service',
+    type: 'password',
+    prompt: true,
+    when: (answers) => answers['use-email']
+  },
+  {
+    name: 'use-api-apps',
+    help: 'Do you want to load your default apps on /api/apps?',
+    flag: true,
+    prompt: false,
+    default: true
+  },
+  {
+    name: 'api-apps',
+    help: 'Path to the folder to mount on /api/apps',
+    prompt: true,
+    validate: validPath,
+    when: (answers) => answers['use-api-apps']
+  },
+  {
+    name: 'redirect-http-from',
+    help: 'HTTP port or comma-separated ports to redirect to the solid server port (e.g. "80,8080").',
+    prompt: false,
+    validate: function (value) {
+      if (!value.match(/^[0-9]+(,[0-9]+)*$/)) {
+        return 'direct-port(s) must be a comma-separated list of integers.'
+      }
+      const list = value.split(/,/).map(v => parseInt(v))
+      const bad = list.find(v => { return v < 1 || v > 65535 })
+      if (bad && bad.length) {
+        return 'redirect-http-from port(s) ' + bad + ' out of range'
+      }
+      return true
+    }
+  },
+  {
+    name: 'server-info-name',
+    help: 'A name for your server (not required, but will be presented on your server\'s frontpage)',
+    prompt: true,
+    default: answers => new URL(answers['server-uri']).hostname
+  },
+  {
+    name: 'server-info-description',
+    help: 'A description of your server (not required)',
+    prompt: true
+  },
+  {
+    name: 'server-info-logo',
+    help: 'A logo that represents you, your brand, or your server (not required)',
+    prompt: true
+  },
+  {
+    name: 'enforce-toc',
+    help: 'Do you want to enforce Terms & Conditions for your service?',
+    flag: true,
+    prompt: true,
+    default: false,
+    when: answers => answers.multiuser
+  },
+  {
+    name: 'toc-uri',
+    help: 'URI to your Terms & Conditions',
+    prompt: true,
+    validate: validUri,
+    when: answers => answers['enforce-toc']
+  },
+  {
+    name: 'disable-password-checks',
+    help: 'Do you want to disable password strength checking?',
+    flag: true,
+    prompt: true,
+    default: false,
+    when: answers => answers.multiuser
+  },
+  {
+    name: 'support-email',
+    help: 'The support email you provide for your users (not required)',
+    prompt: true,
+    validate: (value) => {
+      if (value && !isEmail(value)) {
+        return 'Must be a valid email'
+      }
+      return true
+    },
+    when: answers => answers.multiuser
+  }
+]
+
+function validPath (value) {
+  if (value === 'default') {
+    return Promise.resolve(true)
+  }
+  if (!value) {
+    return Promise.resolve('You must enter a valid path')
+  }
+  return new Promise((resolve) => {
+    fs.stat(value, function (err) {
+      if (err) return resolve('Nothing found at this path')
+      return resolve(true)
+    })
+  })
+}
+
+function validUri (value) {
+  if (!validUrl.isUri(value)) {
+    return 'Enter a valid uri (with protocol)'
+  }
+  return true
+}
+
+export default options