Convert to ES Module

eslint.config.js

@@ -12,7 +12,7 @@ export default [
   { ignores: ['client/*'] },
   {
     languageOptions: {
-      sourceType: 'commonjs',
+      sourceType: 'module',
       globals: {
         wiki: 'readonly',
         ...globals.node,

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

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,18 +49,18 @@ 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')
     }
   } else {
     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

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 }

lib/page.js

@@ -10,12 +10,53 @@
 // Everything is stored using json flat files.
 
 // #### Requires ####
-const fs = require('fs')
-const path = require('path')
-const events = require('events')
+// 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 url 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 wikiPackageImport = async () => {
+  let done = false
+  return new Promise(resolve => {
+    import('wiki/package.json', { with: { type: 'json' } })
+      .then(imported => {
+        done = true
+        resolve(imported.default)
+      })
+      .catch(e => {
+        return e
+      })
+      .then(async () => {
+        if (done) return
+        const packageJsonPath = path.join(process.cwd(), 'package.json')
+        const packageJsonUrl = url.pathToFileURL(packageJsonPath).href
+        import(packageJsonUrl, { with: { type: 'json' } })
+          .then(imported => {
+            resolve(imported.default)
+          })
+          .catch(e => console.error('problems importing package', e))
+      })
+  })
+}
 
-const random_id = require('./random_id')
-const synopsis = require('wiki-client/lib/synopsis')
+const packageJson = await wikiPackageImport()
+
+// 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 +66,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 +75,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 => {

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
@@ -39,11 +39,8 @@ module.exports = exports = argv => {
   }
 
   const startServers = params => {
-    // emitter = new events.EventEmitter()
-    // forward.init params.app, emitter
-    // params.emitter = emitter
-
-    Object.keys(require.main.require('./package').dependencies)
+    const dependencies = params.packageJson.dependencies
+    Object.keys(dependencies)
       .filter(depend => depend.startsWith('wiki-plugin'))
       .forEach(plugin => {
         startServer(params, plugin)

lib/random_id.js

@@ -10,6 +10,4 @@
 // 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('')
-
-module.exports = random_id.random_id = random_id
+export default (chars = 16) => [...Array(chars)].map(() => Math.floor(Math.random() * 16).toString(16)).join('')

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 = []

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