adapt-authoring-docs 1.3.0 → 1.3.2

package/.github/workflows/releases.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Update npm
         run: npm install -g npm@latest
       - name: Install dependencies
-        run: npm ci
+        run: npm install
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/standardjs.yml

@@ -8,6 +8,5 @@ jobs:
       - uses: actions/setup-node@master
         with:
           node-version: 'lts/*'
-          cache: 'npm'
-      - run: npm ci
+      - run: npm install
       - run: npx standard

package/.github/workflows/tests.yml

@@ -10,6 +10,5 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 'lts/*'
-          cache: 'npm'
-      - run: npm ci
+      - run: npm install
       - run: npm test

package/docs/architecture.md

@@ -0,0 +1,175 @@
+# Adapt Authoring Tool — Architecture
+
+## System Architecture
+
+```mermaid
+flowchart TB
+    subgraph Client["Client Layer"]
+        UI["Backbone.js UI · 18 pluggable modules · Rollup · Babel · Handlebars · LESS"]
+    end
+
+    subgraph Server["Server & API Layer"]
+        direction LR
+        express["Express.js 5.1 · Helmet · Compression · Body Parser · Rate Limiter"]
+        apiCore["REST API · JSON Schema Validation (AJV)"]
+        corefw["Core Framework · App Singleton · AbstractModule · DependencyLoader · Hook System"]
+        express -- "routes" --> apiCore -- "loads" --> corefw
+    end
+
+    subgraph Services["Service Modules"]
+        direction LR
+        subgraph AuthGroup["Authentication & Authorization"]
+            direction TB
+            auth["Auth"]
+            authLocal["Auth Local (bcrypt)"]
+            jwt["JWT Tokens"]
+            sessions["Sessions"]
+            roles["Roles (RBAC)"]
+            users["Users"]
+            usergroups["User Groups"]
+            auth ~~~ authLocal ~~~ jwt ~~~ sessions ~~~ roles ~~~ users ~~~ usergroups
+        end
+        subgraph ContentGroup["Content & Authoring"]
+            direction TB
+            content["Content"]
+            authored["Authored"]
+            tags["Tags"]
+            assets["Assets"]
+            courseAssets["Course Assets"]
+            courseTheme["Course Theme"]
+            defaultPlugins["Default Plugins"]
+            adaptFW["Adapt Framework"]
+            content ~~~ authored ~~~ tags ~~~ assets ~~~ courseAssets ~~~ courseTheme ~~~ defaultPlugins ~~~ adaptFW
+        end
+        subgraph SupportGroup["Support Services"]
+            direction TB
+            config["Config"]
+            logger["Logger"]
+            mongoLogger["MongoDB Logger"]
+            lang["Lang (i18n)"]
+            langpack["Language Pack (EN)"]
+            mailer["Mailer"]
+            collab["Collab (WebSocket)"]
+            errors["Errors"]
+            config ~~~ logger ~~~ mongoLogger ~~~ lang ~~~ langpack ~~~ mailer ~~~ collab ~~~ errors
+        end
+    end
+
+    subgraph Data["Data Layer"]
+        direction LR
+        mongodb[("MongoDB 7.0")]
+        sessionStore[("Session Store")]
+        logStore[("Log Store")]
+    end
+
+    Client -- "HTTP / REST" --> Server
+    Server -- "validates & dispatches" --> Services
+    Services -- "persists" --> Data
+
+    classDef clientStyle fill:#4A90D9,stroke:#2C5F8A,color:#fff
+    classDef serverStyle fill:#5BAE5B,stroke:#3A7A3A,color:#fff
+    classDef serviceStyle fill:#E67E22,stroke:#BA6518,color:#fff
+    classDef dataStyle fill:#3498DB,stroke:#2471A3,color:#fff
+
+    class Client clientStyle
+    class Server serverStyle
+    class Services serviceStyle
+    class Data dataStyle
+```
+
+## Module Dependency Hierarchy
+
+```mermaid
+flowchart TD
+    core["core\n(App, AbstractModule,\nDependencyLoader, Hook)"]
+
+    core --> config
+    core --> logger
+    core --> errors
+    core --> server["server\n(Express.js)"]
+    core --> mongodb["mongodb\n(Native Driver)"]
+
+    server --> middleware["middleware\n(helmet, compression,\nbody-parser, rate-limiter)"]
+
+    core --> jsonschema["jsonschema\n(AJV)"]
+    core --> api["api\n(Abstract REST API)"]
+
+    api --> auth
+    api --> jsonschema
+    api --> mongodb
+
+    auth --> authLocal["auth-local\n(bcrypt)"]
+    auth --> sessions["sessions\n(connect-mongo)"]
+    auth --> roles
+    auth --> users
+    users --> usergroups
+
+    core --> lang
+    lang --> langpack["langpack-en"]
+
+    core --> content
+    content --> authored
+    content --> tags
+    content --> assets
+    content --> courseAssets["courseassets\n(FFmpeg)"]
+    content --> courseTheme["coursetheme"]
+    content --> defaultPlugins["defaultplugins"]
+
+    core --> adaptframework["adaptframework\n(adapt-cli)"]
+    adaptframework --> contentPlugin["contentplugin"]
+    adaptframework --> spoor["spoortracking\n(SCORM)"]
+    adaptframework --> browserslist
+    adaptframework --> zipper["_zipper\n(JSZip)"]
+
+    core --> mailer["mailer\n(Nodemailer)"]
+    core --> collab["collab\n(WebSocket)"]
+
+    logger --> mongodblogger["mongodblogger"]
+    mongodblogger --> mongodb
+
+    sessions --> mongodb
+
+    classDef coreNode fill:#9B59B6,stroke:#6C3483,color:#fff
+    classDef infraNode fill:#5BAE5B,stroke:#3A7A3A,color:#fff
+    classDef apiNode fill:#D4A843,stroke:#A07D2E,color:#fff
+    classDef authNode fill:#E74C3C,stroke:#B03A2E,color:#fff
+    classDef contentNode fill:#E67E22,stroke:#BA6518,color:#fff
+    classDef adaptNode fill:#3498DB,stroke:#2471A3,color:#fff
+    classDef supportNode fill:#1ABC9C,stroke:#148F77,color:#fff
+
+    class core coreNode
+    class config,logger,errors,server,middleware,mongodb infraNode
+    class api,jsonschema apiNode
+    class auth,authLocal,sessions,roles,users,usergroups authNode
+    class content,authored,tags,assets,courseAssets,courseTheme,defaultPlugins contentNode
+    class adaptframework,contentPlugin,spoor,browserslist,zipper adaptNode
+    class lang,langpack,mailer,collab,mongodblogger supportNode
+```
+
+## Technology Stack
+
+| Layer | Technologies |
+|---|---|
+| **Runtime** | Node.js 24, ES Modules |
+| **Frontend** | Backbone.js, jQuery, Underscore, Handlebars, LESS |
+| **Frontend Build** | Rollup, Babel 7 |
+| **Backend** | Express.js 5.1, custom module system |
+| **Database** | MongoDB 7.0 (native driver) |
+| **Auth** | bcryptjs, JWT, express-session, connect-mongo, RBAC |
+| **Validation** | AJV (JSON Schema) |
+| **Security** | Helmet, rate-limiter-flexible |
+| **Media** | FFmpeg, FFprobe |
+| **Email** | Nodemailer |
+| **Real-time** | WebSocket (ws) |
+| **i18n** | Custom lang module + language packs |
+| **Logging** | Chalk (CLI), MongoDB (persistent) |
+| **Packaging** | JSZip, adapt-cli |
+
+## Key Architectural Patterns
+
+- **Plugin-based modularity** — Every feature is a separate npm package extending `AbstractModule` from `core`
+- **Singleton App** — `App.instance` bootstraps and manages all modules via `DependencyLoader`
+- **Hook system** — Lifecycle hooks for module initialization, ready states, and extensibility
+- **RBAC** — Role-based access control with scoped permissions per API route
+- **Event-driven UI** — `Origin` singleton (Backbone.Events) acts as a global event bus in the frontend
+- **Schema-validated APIs** — All REST endpoints validated against JSON schemas using AJV

package/docsify/docsify.js

@@ -23,7 +23,7 @@ function generateSectionTitle (sectionName) {
 export default async function docsify (app, configs, outputdir, defaultPages) {
   const dir = path.resolve(outputdir, 'manual')
   const sectionsConf = app.config.get('adapt-authoring-docs.manualSections')
-  const defaultSection = Object.entries(sectionsConf).reduce((m, [id, data]) => data.default ? id : m)
+  const defaultSection = Object.entries(sectionsConf).find(([, data]) => data.default)?.[0]
   /**
    * init docsify folder
    */

package/jsdoc3/.jsdocConfig.json

@@ -0,0 +1,57 @@
+{
+  "source": {
+    "include": []
+  },
+  "docdash": {
+    "collapse": true,
+    "typedefs": true,
+    "search": true,
+    "static": true,
+    "menu": {
+      "<img class=\"logo\" src=\"assets/logo-outline-colour.png\" />Adapt authoring tool back-end API documentation<br><span class=\"version\">v2.5.0</span>": {
+        "class": "menu-title"
+      },
+      "Documentation home": {
+        "href": "https://adapt-security.github.io/adapt-authoring-documentation/",
+        "target": "_self",
+        "class": "menu-item",
+        "id": "home_link"
+      },
+      "Project Website": {
+        "href": "https://www.adaptlearning.org/",
+        "target": "_blank",
+        "class": "menu-item",
+        "id": "website_link"
+      },
+      "Technical Discussion Forum": {
+        "href": "https://community.adaptlearning.org/mod/forum/view.php?id=4",
+        "target": "_blank",
+        "class": "menu-item",
+        "id": "forum_link"
+      }
+    },
+    "sectionOrder": [
+      "Namespaces",
+      "Classes",
+      "Modules",
+      "Externals",
+      "Events",
+      "Mixins",
+      "Tutorials",
+      "Interfaces"
+    ],
+    "meta": {
+      "title": "Adapt authoring tool UI documentation",
+      "description": "Adapt authoring tool UI documentation",
+      "keyword": "v2.5.0"
+    },
+    "scripts": [
+      "styles/adapt.css",
+      "scripts/adapt.js"
+    ]
+  },
+  "opts": {
+    "destination": "/var/folders/28/8f7zyfj927z96jtjw_v0j9x80000gn/T/jsdoc-test-lPjKMQ/backend",
+    "template": "node_modules/docdash"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-docs",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Tools for auto-generating documentation for the Adapt authoring tool",
   "homepage": "https://github.com/adapt-security/adapt-authoring-docs",
   "license": "GPL-3.0",

package/tests/docsify.spec.js

@@ -205,18 +205,7 @@ describe('docsify', () => {
   })
 
   describe('bugs', () => {
-    it('TODO: defaultSection reduce with single entry returns array tuple instead of string', async () => {
-      // BUG: In docsify.js line 26, Object.entries(sectionsConf).reduce((m, [id, data]) => ...)
-      // has no initial value. When there is only one section entry, reduce() returns
-      // the entry itself (an [id, data] array) without calling the callback.
-      // This causes generateSectionTitle to fail with:
-      //   TypeError: sectionName.slice(...).replaceAll is not a function
-      // because sectionName is an array, not a string.
-      //
-      // To fix: add an initial value to reduce, e.g.:
-      //   Object.entries(sectionsConf).reduce((m, [id, data]) => data.default ? id : m, undefined)
-      // or use Array.find instead:
-      //   Object.entries(sectionsConf).find(([, data]) => data.default)?.[0]
+    it('defaultSection reduce with single entry returns string section name', async () => {
       tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'docsify-test-'))
       const outputDir = tmpDir
       const docsSrcDir = await fs.mkdtemp(path.join(os.tmpdir(), 'docsify-src-'))
@@ -238,10 +227,8 @@ describe('docsify', () => {
       }]
 
       const { default: docsify } = await import('../docsify/docsify.js')
-      // This should work but fails due to the bug described above
-      await assert.rejects(
-        () => docsify(mockApp, configs, outputDir, {}),
-        TypeError
+      await assert.doesNotReject(
+        () => docsify(mockApp, configs, outputDir, {})
       )
 
       await fs.rm(docsSrcDir, { recursive: true, force: true })