adapt-authoring-adaptframework 0.0.1

package/lib/apidefs.js

@@ -0,0 +1,152 @@
+const responseDataMeta = {
+  200: {
+    description: 'The Adapt build data',
+    content: {
+      'application/json': {
+        schema: { $ref: '#components/schemas/adaptbuild' }
+      }
+    }
+  }
+}
+
+const responseZipMeta = {
+  200: {
+    description: 'Course build zip file',
+    content: { 'application/zip': {} }
+  }
+}
+
+const statusReportItemSchema = {
+  type: 'array',
+  items: {
+    type: 'object',
+    properties: {
+      code: { type: 'string' },
+      data: { type: 'string' }
+    }
+  }
+}
+
+export default {
+  preview: {
+    post: {
+      summary: 'Build a preview of an Adapt course',
+      responses: responseDataMeta
+    }
+  },
+  publish: {
+    post: {
+      summary: 'Create a publish zip of an Adapt course',
+      responses: responseDataMeta
+    },
+    get: {
+      summary: 'Retrieve an Adapt course publish zip',
+      responses: responseZipMeta
+    }
+  },
+  import: {
+    post: {
+      summary: 'Import an Adapt course',
+      requestBody: {
+        content: {
+          'application/json': {
+            schema: {
+              $schema: 'https://json-schema.org/draft/2020-12/schema',
+              type: 'object',
+              properties: {
+                isDryRun: { type: 'Boolean', default: false },
+                importContent: { type: 'Boolean', default: true },
+                importPlugins: { type: 'Boolean', default: true },
+                updatePlugins: { type: 'Boolean', default: false }
+              }
+            }
+          }
+        }
+      },
+      responses: {
+        200: {
+          description: '',
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  title: { type: 'string' },
+                  courseId: { type: 'string' },
+                  versions: { type: 'object' },
+                  content: {
+                    type: 'object',
+                    properties: {
+                      course: { type: 'number' },
+                      config: { type: 'number' },
+                      menu: { type: 'number' },
+                      page: { type: 'number' },
+                      article: { type: 'number' },
+                      block: { type: 'number' },
+                      component: { type: 'number' }
+                    }
+                  },
+                  statusReport: {
+                    type: 'object',
+                    properties: {
+                      error: statusReportItemSchema,
+                      warn: statusReportItemSchema,
+                      info: statusReportItemSchema
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  export: {
+    post: {
+      summary: 'Create an export zip of an Adapt course',
+      responses: responseDataMeta
+    },
+    get: {
+      summary: 'Retrieve an Adapt course export zip',
+      responses: responseZipMeta
+    }
+  },
+  update: {
+    post: {
+      summary: 'Updates the installed framework',
+      responses: {
+        200: {
+          description: 'Describes the upgraded elements',
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  from: { type: 'string' },
+                  to: { type: 'string' }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    get: {
+      summary: 'Retrieve framework update data',
+      responses: {
+        200: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  canBeUpdated: { type: 'boolean' },
+                  currentVersion: { type: 'string' },
+                  latestCompatibleVersion: { type: 'string' }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/lib/migrations/component.js

@@ -0,0 +1,12 @@
+async function ComponentTransform (data, importer) {
+  if (data._type !== 'component') {
+    return
+  }
+  data._component = importer.componentNameMap[data._component]
+
+  if (data._playerOptions === '') {
+    delete data._playerOptions
+  }
+}
+
+export default ComponentTransform

package/lib/migrations/config.js

@@ -0,0 +1,11 @@
+async function ConfigTransform (data) {
+  if (data._type !== 'config' || !data._accessibility._ariaLevels) {
+    return
+  }
+  ['_menu', '_menuItem', '_page', '_article', '_block', '_component', '_componentItem', '_notify'].forEach(k => {
+    const val = data._accessibility._ariaLevels[k]
+    if (val) data._accessibility._ariaLevels[k] = String(val)
+  })
+}
+
+export default ConfigTransform

package/lib/migrations/graphic-src.js

@@ -0,0 +1,10 @@
+async function GraphicSrcTransform (data) {
+  if (data._component !== 'adapt-contrib-graphic' && data._component !== 'adapt-contrib-hotgraphic') {
+    return
+  }
+  ([data].concat(data._items ?? [])).forEach(i => {
+    if (i._graphic.src) i._graphic.large = i._graphic.small = i._graphic.src
+  })
+}
+
+export default GraphicSrcTransform

package/lib/migrations/nav-order.js

@@ -0,0 +1,12 @@
+async function ConfigTransform (data) {
+  if (data._type !== 'course') {
+    return
+  }
+  const exts = data._globals._extensions
+  Object.keys(exts).forEach(k => {
+    if(exts[k]._navOrder !== undefined)
+      exts[k]._navOrder = Number(exts[k]._navOrder)
+  })
+}
+
+export default ConfigTransform

package/lib/migrations/parent-id.js

@@ -0,0 +1,7 @@
+async function ParentIdTransform (data, importer) {
+  if (data._parentId) {
+    data._parentId = importer.idMap[data._parentId]
+  }
+}
+
+export default ParentIdTransform

package/lib/migrations/remove-undef.js

@@ -0,0 +1,13 @@
+async function RemoveUndef (data) {
+  Object.entries(data).forEach(([k, v]) => {
+    if (v === null) {
+      delete data[k]
+      return
+    }
+    if (typeof v === 'object' && !Array.isArray(v)) {
+      RemoveUndef(v)
+    }
+  })
+}
+
+export default RemoveUndef

package/lib/migrations/start-page.js

@@ -0,0 +1,17 @@
+async function StartPage (data, importer) {
+    if (data._type !== 'course' || data._start === undefined) {
+      return
+    }
+    let pageIndex = 1
+    data._start._startIds.forEach((d, i) => {
+      const _id = data._start._startIds[i]._id
+      const co = importer.contentJson.contentObjects[_id]
+      if(!co) {
+        return importer.framework.log('warn', `StartPage transform: unable to find content with _id '${_id}'`)
+      }
+      co._friendlyId = data._start._startIds[i]._id = co._friendlyId ?? `start_page_${pageIndex++}`
+    })
+  }
+  
+  export default StartPage
+  

package/lib/migrations/theme-undef.js

@@ -0,0 +1,9 @@
+async function ThemeUndef (data, importer) {
+    if (data._type !== 'config' || data._theme !== undefined) {
+      return
+    }
+    data._theme = Object.values(importer.usedContentPlugins).find(p => p.type === 'theme')?.name
+  }
+  
+  export default ThemeUndef
+  

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "adapt-authoring-adaptframework",
+  "version": "0.0.1",
+  "description": "Adapt framework integration for the Adapt authoring tool",
+  "homepage": "https://github.com/adapt-security/adapt-authoring-adaptframework",
+  "license": "GPL-3.0",
+  "type": "module",
+  "main": "index.js",
+  "repository": "github:adapt-security/adapt-authoring-adaptframework",
+  "dependencies": {
+    "adapt-authoring-browserslist": "github:adapt-security/adapt-authoring-browserslist",
+    "adapt-authoring-content": "github:adapt-security/adapt-authoring-content",
+    "adapt-authoring-contentplugin": "github:adapt-security/adapt-authoring-contentplugin",
+    "adapt-authoring-courseassets": "github:adapt-security/adapt-authoring-courseassets",
+    "adapt-authoring-coursetheme": "github:adapt-security/adapt-authoring-coursetheme",
+    "adapt-authoring-spoortracking": "github:adapt-security/adapt-authoring-spoortracking",
+    "adapt-cli": "github:adaptlearning/adapt-cli#v3.3.1",
+    "adapt-octopus": "github:cgkineo/adapt-octopus#v0.1.1",
+    "bytes": "^3.1.2",
+    "fs-extra": "11.3.0",
+    "glob": "^11.0.0",
+    "lodash": "^4.17.21",
+    "semver": "^7.6.0",
+    "upath": "^2.0.1",
+    "zipper": "github:adapt-security/zipper#v1.0.0"
+  },
+  "devDependencies": {
+    "eslint": "^9.11.0",
+    "standard": "^17.1.0"
+  }
+}

package/schema/adaptbuild.schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$anchor": "adaptbuild",
+  "description": "An Adapt course build instance",
+  "type": "object",
+  "properties": {
+    "action": {
+      "description": "The course _id",
+      "type": "string"
+    },
+    "courseId": {
+      "description": "The course _id",
+      "type": "string"
+    },
+    "location": {
+      "description": "Location of the course preview",
+      "type": "string"
+    },
+    "expiresAt": {
+      "description": "When the preview should be purged from the server",
+      "type": "string",
+      "format": "date-time",
+      "isDate": true
+    },
+    "createdBy": {
+      "description": "User which initiated the build",
+      "type": "string",
+      "isObjectId": true
+    },
+    "versions": {
+      "description": "Versions of framework and plugins used in the build",
+      "type": "object"
+    }
+  },
+  "required": ["action", "courseId", "location", "expiresAt", "createdBy"]
+}