wiki-server 0.26.0-rc.4 → 0.26.0-rc.5

package/index.js

@@ -2,7 +2,11 @@
 // Simple file so that if you require this directory
 // in node it instead requires ./lib/server.coffee
 // with coffee-script already loaded.
-require('coffeescript')
-require('coffeescript/register')
+// import('coffeescript')
+// import('coffeescript/register.js')
 
-module.exports = require('./lib/server')
+// const { default: server } = await import('./lib/server.js')
+// export default server
+
+import { default as server } from './lib/server.js'
+export default server

package/lib/defaultargs.js

@@ -9,13 +9,19 @@
 // **defaultargs.coffee** when called on the argv object this
 // module will create reasonable defaults for options not supplied,
 // based on what information is provided.
-const path = require('node:path')
+import path from 'node:path'
+import { randomBytes } from 'node:crypto'
+import { fileURLToPath } from 'node:url'
+import { dirname } from 'node:path'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
 
 const getUserHome = () => {
   return process.env.HOME || process.env.HOMEPATH || process.env.USERPROFILE
 }
 
-module.exports = argv => {
+export default argv => {
   argv = argv || {}
   argv.root ||= __dirname
   // the directory that contains all the packages that makeup the wiki
@@ -32,7 +38,7 @@ module.exports = argv => {
   argv.url ||= `http://localhost${argv.port === 80 ? '' : ':' + argv.port}`
   argv.id ||= path.join(argv.status, 'owner.json')
   argv.uploadLimit ||= '5mb'
-  argv.cookieSecret ||= require('crypto').randomBytes(64).toString('hex')
+  argv.cookieSecret ||= randomBytes(64).toString('hex')
   argv.secure_cookie ||= false
   argv.session_duration ||= 7
   argv.neighbors ||= ''
@@ -43,9 +49,9 @@ module.exports = argv => {
     argv.database = JSON.parse(argv.database)
   }
   argv.database ||= {}
-  argv.database.type ||= './page'
+  argv.database.type ||= './page.js'
   if (argv.database.type.charAt(0) === '.') {
-    if (argv.database.type != './page') {
+    if (argv.database.type != './page.js') {
       console.log('\n\nWARNING: This storage option is depeciated.')
       console.log('    See ReadMe for details of the changes required.\n\n')
     }
@@ -53,8 +59,8 @@ module.exports = argv => {
     argv.database.type = 'wiki-storage-' + argv.database.type
   }
 
-  argv.security_type ||= './security'
-  if (argv.security_type === './security') {
+  argv.security_type ||= './security.js'
+  if (argv.security_type === './security.js') {
     console.log('\n\nINFORMATION: Using default security module.')
   } else {
     argv.security_type = 'wiki-security-' + argv.security_type

package/lib/forward.js

@@ -1,4 +1,4 @@
-const init = (app, emitter) => {
+export const init = (app, emitter) => {
   let sockets = []
   app.io.on('connection', socket => {
     let listeners = []
@@ -35,4 +35,3 @@ const init = (app, emitter) => {
     })
   })
 }
-module.exports = { init }

package/lib/page.js

@@ -10,12 +10,31 @@
 // Everything is stored using json flat files.
 
 // #### Requires ####
-const fs = require('fs')
-const path = require('path')
-const events = require('events')
-
-const random_id = require('./random_id')
-const synopsis = require('wiki-client/lib/synopsis')
+// const fs = require('fs')
+// const path = require('path')
+// const events = require('events')
+// const glob = require('glob')
+//
+// const async = require('async')
+//
+// // const random_id = require('./random_id.cjs')
+// const synopsis = require('wiki-client/lib/synopsis')
+
+import fs from 'node:fs'
+import path from 'node:path'
+import { pathToFileURL } from 'node:url'
+import events from 'node:events'
+
+import { createRequire } from 'node:module'
+const require = createRequire(import.meta.url)
+
+// Use dynamic import to load package.json from the main application's working directory
+const packageJsonPath = path.join(process.cwd(), 'package.json')
+const packageJsonUrl = pathToFileURL(packageJsonPath).href
+const { default: packageJson } = await import(packageJsonUrl, { with: { type: 'json' } })
+
+// import random_id from './random_id.cjs'; // Uncomment if needed
+import synopsis from 'wiki-client/lib/synopsis.js' // Add correct extension if necessary
 
 const asSlug = name =>
   name
@@ -25,7 +44,7 @@ const asSlug = name =>
 
 // Export a function that generates a page handler
 // when called with options object.
-module.exports = exports = argv => {
+export default argv => {
   const wikiName = new URL(argv.url).hostname
 
   fs.mkdir(argv.db, { recursive: true }, e => {
@@ -34,13 +53,11 @@ module.exports = exports = argv => {
 
   // create a list of plugin pages.
   const pluginPages = new Map()
-  Object.keys(require.main.require('./package').dependencies)
+
+  Object.keys(packageJson.dependencies)
     .filter(depend => depend.startsWith('wiki-plugin'))
     .forEach(plugin => {
-      const pagesPath = path.join(
-        path.dirname(require.resolve(`${plugin}/package`, { paths: require.main.paths })),
-        'pages',
-      )
+      const pagesPath = path.join(path.dirname(require.resolve(`${plugin}/package`)), 'pages')
       fs.readdir(pagesPath, { withFileTypes: true }, (err, entries) => {
         if (err) return
         entries.forEach(entry => {

package/lib/plugins.js

@@ -8,11 +8,11 @@
 
 // support server-side plugins
 
-const fs = require('node:fs')
-const { pathToFileURL } = require('node:url')
-// forward = require './forward'
+import fs from 'node:fs'
+import { pathToFileURL } from 'node:url'
+// import forward from './forward.cjs'; // Uncomment if needed and adjust import style if it's not a default export
 
-module.exports = exports = argv => {
+export default argv => {
   // NOTE: plugins are now in their own package directories alongside this one...
   // Plugins are in directories of the form wiki-package-*
   // those with a server component will have a server directory

package/lib/random_id.js

@@ -10,6 +10,5 @@
 // Simple random hex generator, takes an optional number of
 // chars that defaults to 16 and returns a random id.
 
-const random_id = (chars = 16) => [...Array(chars)].map(() => Math.floor(Math.random() * 16).toString(16)).join('')
+export default (chars = 16) => [...Array(chars)].map(() => Math.floor(Math.random() * 16).toString(16)).join('')
 
-module.exports = random_id.random_id = random_id

package/lib/search.js

@@ -8,15 +8,15 @@
 
 // **search.js**
 
-const fs = require('node:fs')
-const path = require('node:path')
-const events = require('node:events')
-const url = require('node:url')
-const writeFileAtomic = require('write-file-atomic')
+import fs from 'node:fs'
+import path from 'node:path'
+import events from 'node:events'
+import url from 'node:url'
+import writeFileAtomic from 'write-file-atomic'
 
-const miniSearch = require('minisearch')
+import MiniSearch from 'minisearch'
 
-module.exports = exports = argv => {
+export default argv => {
   const wikiName = new URL(argv.url).hostname
   let siteIndex = []
   const queue = []

package/lib/security.js

@@ -13,11 +13,11 @@
 // allow the server to run read-only.
 
 // #### Requires ####
-const fs = require('node:fs')
+import fs from 'node:fs'
 
 // Export a function that generates security handler
 // when called with options object.
-module.exports = exports = (log, loga, argv) => {
+export default (log, loga, argv) => {
   const security = {}
 
   // #### Private utility methods. ####
@@ -84,7 +84,16 @@ module.exports = exports = (log, loga, argv) => {
   }
   // Wiki server admin
   security.isAdmin = () => {
-    return false
+    // nobody is admin - unless legacy support, and test
+    if (argv.security_legacy) {
+      if (argv.test) {
+        return true
+      } else {
+        return false
+      }
+    } else {
+      return false
+    }
   }
   security.defineRoutes = (app, cors, updateOwner) => {
     // default security does not have any routes

package/lib/server.js

@@ -19,19 +19,18 @@
 //     npm install
 
 // Standard lib
-const fs = require('fs')
-const path = require('path')
-const http = require('http')
-const url = require('url')
-const { pipeline } = require('node:stream/promises')
+import fs from 'fs'
+import path from 'path'
+import url from 'url'
+import { pipeline } from 'node:stream/promises'
 
 // From npm
-const express = require('express')
-const hbs = require('express-hbs')
-const f = require('flates')
+import express from 'express'
+import hbs from 'express-hbs'
+import f from 'flates'
 
-const createDOMPurify = require('dompurify')
-const { JSDOM } = require('jsdom')
+import createDOMPurify from 'dompurify'
+import { JSDOM } from 'jsdom'
 
 const window = new JSDOM('').window
 const DOMPurify = createDOMPurify(window)
@@ -39,21 +38,30 @@ const DOMPurify = createDOMPurify(window)
 // Using native fetch API (available in Node.js 18+)
 
 // Express 4 middleware
-const logger = require('morgan')
-const cookieParser = require('cookie-parser')
-const methodOverride = require('method-override')
-// session = require 'express-session'
-const sessions = require('client-sessions')
-const bodyParser = require('body-parser')
-const errorHandler = require('errorhandler')
+import logger from 'morgan'
+import cookieParser from 'cookie-parser'
+import methodOverride from 'method-override'
+// session = require('express-session') // This one was commented out — uncomment if used
+import sessions from 'client-sessions'
+import bodyParser from 'body-parser'
+import errorHandler from 'errorhandler'
 
 // Local files
-const random = require('./random_id')
-const defargs = require('./defaultargs')
-const resolveClient = require('wiki-client/lib/resolve')
-const pluginsFactory = require('./plugins')
-const sitemapFactory = require('./sitemap')
-const searchFactory = require('./search')
+// Make sure these files are ESM modules or compatible
+// If they are CommonJS, you will need to dynamically import them (see below)
+import defargs from './defaultargs.js'
+import resolveClient from 'wiki-client/lib/resolve.js'
+import pluginsFactory from './plugins.js'
+import sitemapFactory from './sitemap.js'
+import searchFactory from './search.js'
+import { warn } from 'node:console'
+import { createRequire } from 'module'
+const require = createRequire(import.meta.url)
+
+// Use dynamic import to load package.json from the main application's working directory
+const packageJsonPath = path.join(process.cwd(), 'package.json')
+const packageJsonUrl = url.pathToFileURL(packageJsonPath).href
+const { default: packageJson } = await import(packageJsonUrl, { with: { type: 'json' } })
 
 const render = page => {
   return (
@@ -90,7 +98,7 @@ const render = page => {
   )
 }
 // Set export objects for node and coffee to a function that generates a sfw server.
-module.exports = exports = argv => {
+export default async argv => {
   // Create the main application object, app.
   const app = express()
 
@@ -125,18 +133,22 @@ module.exports = exports = argv => {
     }
     next()
   }
+
   let pagehandler, sitemaphandler, searchhandler, securityhandler
-  // Require the database adapter and initialize it with options.
-  app.pagehandler = pagehandler = require(argv.database.type)(argv)
 
-  // Require the sitemap adapter and initialize it with options.
+  // Dynamically import database adapter (since the module name is dynamic)
+  const dbModule = await import(argv.database.type)
+  app.pagehandler = pagehandler = dbModule.default(argv)
+
+  // Initialize sitemap handler
   app.sitemaphandler = sitemaphandler = sitemapFactory(argv)
 
-  // Require the site indexer and initialize it with options
+  // Initialize search handler
   app.searchhandler = searchhandler = searchFactory(argv)
 
-  // Require the security adapter and initialize it with options.
-  app.securityhandler = securityhandler = require(argv.security_type)(log, loga, argv)
+  // Dynamically import security adapter (also dynamic)
+  const securityModule = await import(argv.security_type)
+  app.securityhandler = securityhandler = securityModule.default(log, loga, argv)
 
   // If the site is owned, owner will contain the name of the owner
   let owner = ''
@@ -268,13 +280,10 @@ module.exports = exports = argv => {
   app.use('/assets', cors, express.static(argv.assets))
 
   // Add static routes to the plugins client.
-  Object.keys(require.main.require('./package').dependencies)
+  Object.keys(packageJson.dependencies)
     .filter(depend => depend.startsWith('wiki-plugin'))
     .forEach(plugin => {
-      const clientPath = path.join(
-        path.dirname(require.resolve(`${plugin}/package`, { paths: require.main.paths })),
-        'client',
-      )
+      const clientPath = path.join(path.dirname(require.resolve(`${plugin}/package`)), 'client')
       const pluginPath = '/plugins/' + plugin.slice(12)
       app.use(pluginPath, cors, express.static(clientPath, staticPathOptions))
     })
@@ -387,17 +396,29 @@ module.exports = exports = argv => {
   app.get('/system/factories.json', (req, res) => {
     res.status(200)
     res.header('Content-Type', 'application/json')
+
     const factories = []
-    Object.keys(require.main.require('./package').dependencies)
-      .filter(depend => depend.startsWith('wiki-plugin'))
-      .forEach(plugin => {
+
+    const getPackageFactory = plugin => {
+      return new Promise(resolve => {
         try {
-          factories.push(require.main.require(`${plugin}/factory`))
-        } catch {
-          // do nothing if plugin doesn't have a factory category.
+          import(`${plugin}/factory.json`, { with: { type: 'json' } }).then(({ default: factory }) => {
+            console.log(plugin, factory)
+            resolve(factories.push(factory))
+          })
+        } catch (error) {
+          resolve()
         }
       })
-    res.end(JSON.stringify(factories))
+    }
+
+    Promise.all(
+      Object.keys(packageJson.dependencies)
+        .filter(depend => depend.startsWith('wiki-plugin'))
+        .map(plugin => {
+          return getPackageFactory(plugin)
+        }),
+    ).then(() => res.end(JSON.stringify(factories)))
   })
 
   // ###### Json Routes ######
@@ -679,27 +700,56 @@ module.exports = exports = argv => {
   }
 
   app.get('/system/version.json', admin, (req, res) => {
+    const getPackageVersion = packageName => {
+      return new Promise(resolve => {
+        try {
+          // Use dynamic import to load package.json from the main application's working directory
+          const packageJsonPath = path.join(process.cwd(), 'node_modules', packageName, 'package.json')
+          const packageJsonUrl = url.pathToFileURL(packageJsonPath).href
+          import(packageJsonUrl, { with: { type: 'json' } }).then(({ default: packageJson }) => {
+            resolve({ [packageName]: packageJson.version })
+          })
+        } catch (error) {
+          console.error(`Error reading package for ${packageName}:`, error)
+          resolve({ [packageName]: 'unknown' })
+        }
+      })
+    }
+
     const versions = {}
-    const wikiModule = require.main
-    versions[wikiModule.require('./package').name] = wikiModule.require('./package').version
-    versions[wikiModule.require('wiki-server/package').name] = wikiModule.require('wiki-server/package').version
-    versions[wikiModule.require('wiki-client/package').name] = wikiModule.require('wiki-client/package').version
-
-    versions['security'] = {}
-    Object.keys(require.main.require('./package').dependencies)
-      .filter(depend => depend.startsWith('wiki-security'))
-      .forEach(key => {
-        versions.security[key] = wikiModule.require(`${key}/package`).version
+
+    const security = () => {
+      return new Promise(resolve => {
+        Promise.all(
+          Object.keys(packageJson.dependencies)
+            .filter(depend => depend.startsWith('wiki-security'))
+            .map(key => {
+              return getPackageVersion(key)
+            }),
+        ).then(values => {
+          resolve({ security: values.reduce((acc, cV) => Object.assign(acc, cV), {}) })
+        })
       })
+    }
 
-    versions['plugins'] = {}
-    Object.keys(require.main.require('./package').dependencies)
-      .filter(depend => depend.startsWith('wiki-plugin'))
-      .forEach(key => {
-        versions.plugins[key] = wikiModule.require(`${key}/package`).version
+    const plugins = () => {
+      return new Promise(resolve => {
+        Promise.all(
+          Object.keys(packageJson.dependencies)
+            .filter(depend => depend.startsWith('wiki-plugin'))
+            .map(key => {
+              return getPackageVersion(key)
+            }),
+        ).then(values => {
+          resolve({ plugins: values.reduce((acc, cV) => Object.assign(acc, cV), {}) })
+        })
       })
+    }
 
-    res.json(versions)
+    Promise.all([getPackageVersion('wiki-server'), getPackageVersion('wiki-client'), security(), plugins()]).then(v => {
+      Object.assign(versions, { [packageJson.name]: packageJson.version }, ...v)
+      res.json(versions)
+    })
   })
 
   // ##### Proxy routes #####

package/lib/sitemap.js

@@ -7,14 +7,13 @@
  */
 
 // **sitemap.coffee**
+import fs from 'node:fs'
+import path from 'node:path'
+import events from 'node:events'
+import writeFileAtomic from 'write-file-atomic'
+import xml2js from 'xml2js'
 
-const fs = require('fs')
-const path = require('path')
-const events = require('events')
-const writeFileAtomic = require('write-file-atomic')
-const xml2js = require('xml2js')
-
-const synopsis = require('wiki-client/lib/synopsis')
+import synopsis from 'wiki-client/lib/synopsis.js' // Add .js if needed
 
 const asSlug = name =>
   name
@@ -22,7 +21,7 @@ const asSlug = name =>
     .replace(/[^A-Za-z0-9-]/g, '')
     .toLowerCase()
 
-module.exports = exports = argv => {
+export default argv => {
   const wikiName = new URL(argv.url).hostname
 
   let sitemap = []

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "wiki-server",
   "description": "A Federated Wiki Server",
-  "version": "0.26.0-rc.4",
+  "version": "0.26.0-rc.5",
+  "type": "module",
   "author": {
     "name": "Ward Cunningham",
     "email": "ward@c2.com",
@@ -49,12 +50,13 @@
   "scripts": {
     "prettier:format": "prettier --write './**/*.js'",
     "prettier:check": "prettier --check ./**/*.js",
-    "test": "node --test",
+    "test": "cd test; node --test",
+    "watch": "cd test; node --test --watch",
     "update-authors": "node scripts/update-authors.js"
   },
   "devDependencies": {
-    "@eslint/js": "^9.31.0",
-    "eslint": "^9.31.0",
+    "@eslint/js": "^9.32.0",
+    "eslint": "^9.32.0",
     "globals": "^16.1.0",
     "grunt-git-authors": "^3.2.0",
     "prettier": "^3.5.3",