adapt-authoring-core 2.0.0 → 2.1.0

package/index.js

@@ -2,4 +2,4 @@ export { default as AbstractModule } from './lib/AbstractModule.js'
 export { default as App } from './lib/App.js'
 export { default as DependencyLoader } from './lib/DependencyLoader.js'
 export { default as Hook } from './lib/Hook.js'
-export { metadataFileName, packageFileName, isObject, getArgs, spawn, readJson, writeJson, toBoolean, ensureDir, escapeRegExp } from './lib/Utils.js'
+export { metadataFileName, packageFileName, isObject, getArgs, spawn, readJson, writeJson, toBoolean, ensureDir, escapeRegExp, stringifyValues } from './lib/Utils.js'

package/lib/Utils.js

@@ -7,3 +7,4 @@ export { writeJson } from './utils/writeJson.js'
 export { toBoolean } from './utils/toBoolean.js'
 export { ensureDir } from './utils/ensureDir.js'
 export { escapeRegExp } from './utils/escapeRegExp.js'
+export { stringifyValues } from './utils/stringifyValues.js'

package/lib/utils/stringifyValues.js

@@ -0,0 +1,18 @@
+/**
+ * Clones an object and converts any Dates and ObjectIds to Strings
+ * @param {Object} data
+ * @returns A clone object with stringified ObjectIds
+ * @memberof core
+ */
+export function stringifyValues (data) {
+  return Object.entries(data).reduce((cloned, [key, val]) => {
+    const type = val?.constructor?.name
+    cloned[key] =
+      type === 'Date' || type === 'ObjectId'
+        ? val.toString()
+        : type === 'Array' || type === 'Object'
+          ? stringifyValues(val)
+          : val
+    return cloned
+  }, Array.isArray(data) ? [] : {})
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-core",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A bundle of reusable 'core' functionality",
   "homepage": "https://github.com/adapt-security/adapt-authoring-core",
   "license": "GPL-3.0",

package/tests/utils-stringifyValues.spec.js

@@ -0,0 +1,67 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { stringifyValues } from '../lib/utils/stringifyValues.js'
+
+describe('stringifyValues()', () => {
+  it('should pass through plain values unchanged', () => {
+    const data = { a: 'hello', b: 42, c: true, d: null }
+    assert.deepEqual(stringifyValues(data), data)
+  })
+
+  it('should convert Date values to strings', () => {
+    const date = new Date('2025-01-01T00:00:00.000Z')
+    const result = stringifyValues({ date })
+    assert.equal(typeof result.date, 'string')
+    assert.equal(result.date, date.toString())
+  })
+
+  it('should convert ObjectId-like values to strings', () => {
+    class ObjectId {
+      constructor (id) { this.id = id }
+      toString () { return this.id }
+    }
+    const data = { _id: new ObjectId('abc123') }
+    const result = stringifyValues(data)
+    assert.equal(typeof result._id, 'string')
+    assert.equal(result._id, 'abc123')
+  })
+
+  it('should recursively process nested objects', () => {
+    const date = new Date('2025-01-01')
+    const data = { nested: { value: 'test', date } }
+    const result = stringifyValues(data)
+    assert.equal(typeof result.nested, 'object')
+    assert.equal(typeof result.nested.date, 'string')
+    assert.equal(result.nested.value, 'test')
+  })
+
+  it('should recursively process arrays', () => {
+    const date = new Date('2025-01-01')
+    const data = { items: [date, 'text', 42] }
+    const result = stringifyValues(data)
+    assert.ok(Array.isArray(result.items))
+    assert.equal(typeof result.items[0], 'string')
+    assert.equal(result.items[1], 'text')
+    assert.equal(result.items[2], 42)
+  })
+
+  it('should return an array when input is an array', () => {
+    const result = stringifyValues([{ a: 1 }, { b: 2 }])
+    assert.ok(Array.isArray(result))
+    assert.equal(result.length, 2)
+  })
+
+  it('should not mutate the original data', () => {
+    const date = new Date('2025-01-01')
+    const data = { date }
+    stringifyValues(data)
+    assert.ok(data.date instanceof Date)
+  })
+
+  it('should handle deeply nested structures', () => {
+    const date = new Date('2025-01-01')
+    const data = { a: { b: { c: { date } } } }
+    const result = stringifyValues(data)
+    assert.equal(typeof result.a.b.c.date, 'string')
+  })
+})

package/.github/workflows/test.yml

@@ -1,13 +0,0 @@
-name: Tests
-on: push
-jobs:
-  default:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@master
-      - uses: actions/setup-node@master
-        with:
-          node-version: 'lts/*'
-          cache: 'npm'
-      - run: npm ci
-      - run: npm test