adapt-authoring-content 3.2.2 → 3.2.3

package/lib/ContentModule.js

@@ -2,7 +2,7 @@ import { AbstractApiModule } from 'adapt-authoring-api'
 import { Hook, stringifyValues } from 'adapt-authoring-core'
 import { createObjectId, parseObjectId } from 'adapt-authoring-mongodb'
 import { ObjectId } from 'mongodb'
-import { ContentTree, buildAssetUsagePipeline, computeSortOrderOps, contentTypeToSchemaName, extractAssetIds, formatFriendlyId, parseMaxSeq } from './utils.js'
+import { ContentTree, buildAssetUsagePipeline, computeSortOrderOps, contentTypeToSchemaName, extractAssetIds, fieldsToProjection, formatFriendlyId, parseMaxSeq } from './utils.js'
 /**
  * Module which handles course content
  * @memberof content
@@ -685,10 +685,28 @@ class ContentModule extends AbstractApiModule {
       if (ifModifiedSince && lastModified <= ifModifiedSince) {
         return res.status(304).end()
       }
+      const treeFields = [
+        '_id',
+        '_parentId',
+        '_courseId',
+        '_type',
+        '_sortOrder',
+        'title',
+        'displayTitle',
+        '_friendlyId',
+        '_component',
+        '_layout',
+        '_menu',
+        '_theme',
+        '_enabledPlugins',
+        '_colorLabel',
+        'heroImage',
+        'updatedAt'
+      ]
       const items = await this.find(
         { _courseId },
         { validate: false },
-        { projection: { _id: 1, _parentId: 1, _courseId: 1, _type: 1, _sortOrder: 1, title: 1, displayTitle: 1, _friendlyId: 1, _component: 1, _layout: 1, _menu: 1, _theme: 1, _enabledPlugins: 1, _colorLabel: 1, updatedAt: 1 } }
+        { projection: fieldsToProjection(treeFields) }
       )
       const tree = new ContentTree(items)
       res.set('Last-Modified', lastModified.toUTCString())

package/lib/utils/fieldsToProjection.js

@@ -0,0 +1,10 @@
+/**
+ * Builds a MongoDB inclusion projection from a list of field names, mapping
+ * each to `1` (e.g. `['_id', 'title']` -> `{ _id: 1, title: 1 }`). Lets a
+ * handler declare its projected fields as a readable one-per-line array.
+ * @param {Array<string>} fields Field names to include
+ * @return {Object} Inclusion projection
+ */
+export default function fieldsToProjection (fields) {
+  return Object.fromEntries((fields ?? []).map(field => [field, 1]))
+}

package/lib/utils.js

@@ -3,5 +3,6 @@ export { default as buildAssetUsagePipeline } from './utils/buildAssetUsagePipel
 export { default as computeSortOrderOps } from './utils/computeSortOrderOps.js'
 export { extractAssetIds } from './utils/extractAssetIds.js'
 export { default as contentTypeToSchemaName } from './utils/contentTypeToSchemaName.js'
+export { default as fieldsToProjection } from './utils/fieldsToProjection.js'
 export { default as formatFriendlyId } from './utils/formatFriendlyId.js'
 export { default as parseMaxSeq } from './utils/parseMaxSeq.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-content",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "description": "Module for managing Adapt content",
   "homepage": "https://github.com/adapt-security/adapt-authoring-content",
   "license": "GPL-3.0",

package/tests/utils-fieldsToProjection.spec.js

@@ -0,0 +1,22 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import fieldsToProjection from '../lib/utils/fieldsToProjection.js'
+
+describe('fieldsToProjection', () => {
+  it('maps each field name to 1', () => {
+    assert.deepEqual(fieldsToProjection(['_id', 'title']), { _id: 1, title: 1 })
+  })
+
+  it('returns an empty projection for an empty array', () => {
+    assert.deepEqual(fieldsToProjection([]), {})
+  })
+
+  it('treats a missing argument as empty', () => {
+    assert.deepEqual(fieldsToProjection(), {})
+    assert.deepEqual(fieldsToProjection(undefined), {})
+  })
+
+  it('collapses duplicate field names to a single key', () => {
+    assert.deepEqual(fieldsToProjection(['_id', '_id', 'title']), { _id: 1, title: 1 })
+  })
+})