npm - @liascript/exporter - Versions diffs - 2.0.0--preview3 → 2.2.0--0.10.0 - Mend

@liascript/exporter 2.0.0--preview3 → 2.2.0--0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (589) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@liascript/exporter",
-  "version": "2.0.0--preview3",
+  "version": "2.2.0--0.10.0",
   "description": "A generic exporter for LiaScript",
   "main": "dist/index.js",
   "repository": {
@@ -19,12 +19,13 @@
   "preferGlobal": true,
   "scripts": {
     "__preinstall": "cd LiaScript && npm i && npm run build:scorm1.2 && cp -r dist ../assets/scorm1.2",
-    "build:assets": "npm run clean && npm run asset:scorm1.2 && npm run asset:scorm2004 && npm run asset:web && npm run asset:pdf",
+    "build:assets": "npm run clean && npm run asset:scorm1.2 && npm run asset:scorm2004 && npm run asset:web && npm run asset:indexeddb && npm run asset:pdf",
     "clean": "rm -rf dist/assets/*",
     "asset:web": "cd LiaScript && npm i && npm run build:base && cp -r dist ../dist/assets/web",
     "asset:pdf": "cd LiaScript && git checkout feat/fullPage && npm i && npm run build:pdf && cp -r dist ../dist/assets/pdf && git checkout development",
     "asset:scorm1.2": "cd LiaScript && npm i && npm run build:scorm1.2 && cp -r dist ../dist/assets/scorm1.2",
     "asset:scorm2004": "cd LiaScript && npm i && npm run build:scorm2004 && cp -r dist ../dist/assets/scorm2004",
+    "asset:indexeddb": "cd LiaScript && npm i && npm run build:indexeddb && cp -r dist ../dist/assets/indexeddb",
     "build": "npx parcel build --no-cache --no-source-maps --no-scope-hoist src/index.ts && npm run shebang",
     "build:debug": "npx parcel build --target node --no-minify --log-level 5 src/index.ts",
     "run:moodle": "cd docker/moodle && docker-compose up",
@@ -42,6 +43,7 @@
   "license": "ISC",
   "dependencies": {
     "@liascript/simple-scorm-packager": "^0.2.6",
+    "archiver": "^5.3.0",
     "fs-extra": "^9.1.0",
     "minimist": "^1.2.5",
     "path": "^0.12.7",

package/src/export/helper.ts CHANGED Viewed

@@ -2,6 +2,8 @@
 const temp = require('temp')
 const fs = require('fs-extra')
+const path = require('path')
+const archiver = require('archiver')
 export function tmpDir() {
   return new Promise((resolve, reject) => {
@@ -51,3 +53,98 @@ export function isURL(uri: string) {
     uri.startsWith('file://')
   )
 }
+export async function iframe(
+  tmpPath,
+  filename: string,
+  readme: string,
+  index?: string
+) {
+  await writeFile(
+    path.join(tmpPath, filename),
+    `<!DOCTYPE html>
+    <html style="height:100%; overflow: hidden">
+    <head>
+    </head>
+    <body style="height:100%">
+    <iframe id="lia-container" src="" style="border: 0px; width: 100%; height: 100%"></iframe>
+    <script>
+      let path = window.location.pathname.replace("start.html", "")
+      let iframe = document.getElementById("lia-container")
+      if (iframe) {
+        const src = path + "${
+          index || 'index.html'
+        }?" + path + "${readme.replace('./', '')}"
+        iframe.src = src
+      }
+    </script>
+    </body>
+    </html>
+    `
+  )
+}
+export async function zip(dir: string, filename: string) {
+  const output = fs.createWriteStream(
+    path.dirname(filename) + '/' + path.basename(filename + '.zip')
+  )
+  const archive = archiver('zip', {
+    zlib: { level: 9 }, // Sets the compression level.
+  })
+  // listen for all archive data to be written
+  // 'close' event is fired only when a file descriptor is involved
+  output.on('close', function () {
+    console.log(archive.pointer() + ' total bytes')
+    console.log(
+      'archiver has been finalized and the output file descriptor has closed.'
+    )
+  })
+  // This event is fired when the data source is drained no matter what was the data source.
+  // It is not part of this library but rather from the NodeJS Stream API.
+  // @see: https://nodejs.org/api/stream.html#stream_event_end
+  output.on('end', function () {
+    console.log('Data has been drained')
+  })
+  // good practice to catch warnings (ie stat failures and other non-blocking errors)
+  archive.on('warning', function (err) {
+    if (err.code === 'ENOENT') {
+      // log warning
+    } else {
+      // throw error
+      throw err
+    }
+  })
+  // good practice to catch this error explicitly
+  archive.on('error', function (err) {
+    throw err
+  })
+  // pipe archive data to the file
+  archive.pipe(output)
+  archive.directory(dir, false)
+  archive.finalize()
+}
+export function random(length: number = 16) {
+  // Declare all characters
+  let chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
+  // Pick characters randomly
+  let str = ''
+  for (let i = 0; i < length; i++) {
+    str += chars.charAt(Math.floor(Math.random() * chars.length))
+  }
+  return str
+}

package/src/export/ims.ts ADDED Viewed

@@ -0,0 +1,129 @@
+import * as helper from './helper'
+const path = require('path')
+const fs = require('fs-extra')
+export async function exporter(
+  argument: {
+    input: string
+    readme: string
+    output: string
+    format: string
+    path: string
+    key?: string
+    // special cases for IMS
+    'ims-indexeddb'?: boolean
+  },
+  json: any
+) {
+  // make temp folder
+  let tmp = await helper.tmpDir()
+  let tmpPath = path.join(tmp, 'pro')
+  // copy assets to temp
+  await fs.copy(
+    path.join(
+      __dirname,
+      argument['ims-indexeddb'] ? './assets/indexeddb' : './assets/web'
+    ),
+    tmpPath
+  )
+  let index = fs.readFileSync(path.join(tmpPath, 'index.html'), 'utf8')
+  // change responsive key
+  if (argument.key) {
+    index = helper.injectResponsivevoice(argument.key, index)
+  }
+  try {
+    await helper.writeFile(path.join(tmpPath, 'index.html'), index)
+  } catch (e) {
+    console.warn(e)
+    return
+  }
+  await manifest(tmpPath, json.lia)
+  // copy base path or readme-directory into temp
+  await fs.copy(argument.path, tmpPath, { filter: helper.filterHidden })
+  if (argument['ims-indexeddb']) {
+    let newReadme = helper.random(20) + '.md'
+    let old_ = path.join(tmpPath, argument.readme)
+    let new_ = path.join(path.dirname(old_), newReadme)
+    argument.readme = argument.readme.replace(
+      path.basename(argument.readme),
+      newReadme
+    )
+    await fs.move(old_, new_)
+  }
+  await helper.iframe(tmpPath, 'start.html', argument.readme)
+  helper.zip(tmpPath, argument.output)
+}
+async function manifest(tmpPath: any, meta: any) {
+  let keywords = ''
+  try {
+    const tags = meta.definition.macro.tags
+      .split(',')
+      .map((e: string) => e.trim())
+    for (let i = 0; i < tags.length; i++) {
+      keywords += `<imsmd:langstring xml:lang="${meta.definition.language}">${tags[i]}</imsmd:langstring>`
+    }
+  } catch (e) {}
+  await helper.writeFile(
+    path.join(tmpPath, 'imsmanifest.xml'),
+    `<manifest xmlns="http://www.imsglobal.org/xsd/imscp_v1p1" xmlns:imsmd="http://www.imsglobal.org/xsd/imsmd_v1p2"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://www.imsglobal.org/xsd/imscp_v1p1 http://www.imsglobal.org/xsd/imscp_v1p1.xsd http://www.imsglobal.org/xsd/imsmd_v1p2 http://www.imsglobal.org/xsd/imsmd_v1p2.xsd "
+    identifier="Manifest5-CEC3D3-3201-DF8E-8F42-3CEED12F4197" version="IMS CP 1.1.4">
+    <metadata>
+        <schema>IMS Content</schema>
+        <schemaversion>1.1.4</schemaversion>
+        <imsmd:lom>
+            <imsmd:general>
+                <imsmd:title>
+                    <imsmd:langstring xml:lang="${meta.definition.language}">${meta.str_title}</imsmd:langstring>
+                </imsmd:title>
+                <imsmd:language>${meta.definition.language}</imsmd:language>
+                <imsmd:description>
+                    <imsmd:langstring xml:lang="${meta.definition.language}">${meta.comment}</imsmd:langstring>
+                </imsmd:description>
+                <imsmd:keyword>
+                    ${keywords}
+                </imsmd:keyword>
+            </imsmd:general>
+            <imsmd:lifecycle>
+                <imsmd:version>
+                    <imsmd:langstring xml:lang="${meta.definition.language}">${meta.definition.version}</imsmd:langstring>
+                </imsmd:version>
+            </imsmd:lifecycle>
+        </imsmd:lom>
+    </metadata>
+    <organizations default="TOC1">
+        <organization identifier="TOC1" structure="hierarchical">
+            <title>All Lessons</title>
+            <item identifier="ITEM1" identifierref="LIASCRIPT">
+                <title>LiaScript - Course</title>
+            </item>
+        </organization>
+    </organizations>
+    <resources>
+        <resource identifier="LIASCRIPT" type="webcontent" href="start.html">
+            <file href="start.html" />
+        </resource>
+    </resources>
+</manifest>`
+  )
+}

package/src/export/scorm12.ts CHANGED Viewed

@@ -4,34 +4,6 @@ const scormPackager = require('@liascript/simple-scorm-packager')
 const path = require('path')
 const fs = require('fs-extra')
-export async function iframe(tmpPath, readme: string) {
-  await helper.writeFile(
-    path.join(tmpPath, 'start.html'),
-    `<!DOCTYPE html>
-    <html style="height:100%; overflow: hidden">
-    <head>
-    </head>
-    <body style="height:100%">
-    <iframe id="lia-container" src="" style="border: 0px; width: 100%; height: 100%"></iframe>
-    <script>
-      let path = window.location.pathname.replace("start.html", "")
-      let iframe = document.getElementById("lia-container")
-      if (iframe) {
-        const src = path + "index.html?" + path + "${readme.replace('./', '')}"
-        iframe.src = src
-      }
-    </script>
-    </body>
-    </html>
-    `
-  )
-}
 export async function exporter(
   argument: {
     input: string
@@ -77,7 +49,7 @@ export async function exporter(
   )
   if (argument['scorm-iframe']) {
-    await iframe(tmpPath, argument.readme)
+    await helper.iframe(tmpPath, 'start.html', argument.readme)
   }
   try {

package/src/export/scorm2004.ts CHANGED Viewed

@@ -1,5 +1,4 @@
 import * as helper from './helper'
-import * as SCORM from './scorm12'
 const scormPackager = require('@liascript/simple-scorm-packager')
 const path = require('path')
@@ -50,7 +49,7 @@ export async function exporter(
   )
   if (argument['scorm-iframe']) {
-    await SCORM.iframe(tmpPath, argument.readme)
+    await helper.iframe(tmpPath, 'start.html', argument.readme)
   }
   try {

package/src/export/web.ts CHANGED Viewed

@@ -11,6 +11,10 @@ export async function exporter(
     format: string
     path: string
     key?: string
+    'web-iframe'?: boolean
+    'web-indexeddb'?: boolean
+    'web-zip'?: boolean
   },
   json: any
 ) {
@@ -20,7 +24,34 @@ export async function exporter(
   let tmpPath = path.join(tmp, 'pro')
   // copy assets to temp
-  await fs.copy(path.join(__dirname, './assets/web'), tmpPath)
+  await fs.copy(
+    path.join(
+      __dirname,
+      argument['web-indexeddb'] ? './assets/indexeddb' : './assets/web'
+    ),
+    tmpPath
+  )
+  // copy base path or readme-directory into temp
+  await fs.copy(argument.path, tmpPath)
+  // rename the readme if necessary
+  if (argument['web-indexeddb'] !== undefined) {
+    let newReadme =
+      (typeof argument['web-indexeddb'] === 'string'
+        ? argument['web-indexeddb']
+        : helper.random(20)) + '.md'
+    let old_ = path.join(tmpPath, argument.readme)
+    let new_ = path.join(path.dirname(old_), newReadme)
+    argument.readme = argument.readme.replace(
+      path.basename(argument.readme),
+      newReadme
+    )
+    await fs.move(old_, new_)
+  }
   let index = fs.readFileSync(path.join(tmpPath, 'index.html'), 'utf8')
@@ -35,7 +66,7 @@ export async function exporter(
   if (!window.LIA) {
     window.LIA = {}
   }
-  window.LIA.defaultCourse="${path.basename(argument.readme)}"
+   window.LIA.defaultCourseURL = "${path.basename(argument.readme)}"
   </script>`,
     index
   )
@@ -77,13 +108,20 @@ export async function exporter(
   }
   try {
-    await helper.writeFile(path.join(tmpPath, 'index.html'), index)
+    if (argument['web-iframe']) {
+      await helper.writeFile(path.join(tmpPath, 'start.html'), index)
+      await helper.iframe(tmpPath, 'index.html', argument.readme, 'start.html')
+    } else {
+      await helper.writeFile(path.join(tmpPath, 'index.html'), index)
+    }
   } catch (e) {
     console.warn(e)
     return
   }
-  // copy base path or readme-directory into temp
-  await fs.copy(argument.path, tmpPath)
-  await fs.move(tmpPath, argument.output, { filter: helper.filterHidden })
+  if (argument['web-zip']) {
+    helper.zip(tmpPath, argument.output)
+  } else {
+    await fs.move(tmpPath, argument.output, { filter: helper.filterHidden })
+  }
 }

package/src/index.ts CHANGED Viewed

@@ -6,6 +6,7 @@ import * as SCORM12 from './export/scorm12'
 import * as SCORM2004 from './export/scorm2004'
 import * as PDF from './export/pdf'
 import * as helper from './export/helper'
+import * as IMS from './export/ims'
 global.XMLHttpRequest = require('xhr2')
@@ -15,7 +16,7 @@ const argv = require('minimist')(process.argv.slice(2))
 // -------------------------------Main Execution-------------------------------
 if (argv.v || argv.version) {
-  console.log('version: 1.0.51--0.9.51')
+  console.log('version: 2.0.0--0.10.0')
 } else if (argv.h || argv.help) {
   help()
 } else if (argv.i || argv.input) {
@@ -53,6 +54,10 @@ function run(argument) {
         SCORM2004.exporter(argument, JSON.parse(string))
         break
       }
+      case 'ims': {
+        IMS.exporter(argument, JSON.parse(string))
+        break
+      }
       case 'web': {
         WEB.exporter(argument, JSON.parse(string))
         break
@@ -74,7 +79,8 @@ function run(argument) {
       argument.format == 'scorm1.2' ||
       argument.format == 'scorm2004' ||
       argument.format == 'pdf' ||
-      argument.format == 'web'
+      argument.format == 'web' ||
+      argument.format == 'ims'
         ? 'fulljson'
         : argument.format
@@ -109,13 +115,13 @@ function help() {
   console.log(
     '-f',
     '--format',
-    '         scorm1.2, scorm2004, json, fullJson, web, pdf (default is json)'
+    '         scorm1.2, scorm2004, json, fullJson, web, ims, pdf (default is json)'
   )
   console.log('-v', '--version', '        output the current version')
   console.log('\n-k', '--key', '            responsive voice key ')
-  console.log('\nSCORM 1.2 settings:')
+  console.log('\nSCORM settings:')
   console.log('')
   console.log('--scorm-organization', '      set the organization title')
   console.log(
@@ -132,6 +138,25 @@ function help() {
     '            use an iframe, when a SCORM starting parameter is not working'
   )
+  console.log('\nIMS settings:')
+  console.log('')
+  console.log(
+    '--ims-indexeddb',
+    '           Use IndexedDB to store data persistently'
+  )
+  console.log('\nWEB settings:')
+  console.log('')
+  console.log(
+    '--web-iframe               Use an iframed version to hide the course URL.'
+  )
+  console.log(
+    '--web-indexeddb            This will allow to store data within the browser using indexeddb, you can optionally pass a unique key (by default one is generated randomly).'
+  )
+  console.log(
+    '--web-zip                  By default the result is not zipped, you can change this with this parameter.'
+  )
   console.log('\nPDF settings:\n')
   console.log(
     '--pdf-stylesheet           Inject an local CSS for changing the appearance.'
@@ -214,6 +239,14 @@ function parseArguments() {
     'scorm-typicalDuration': argv['scorm-typicalDuration'],
     'scorm-iframe': argv['scorm-iframe'],
+    // special IMS cases
+    'ims-indexeddb': argv['ims-indexeddb'],
+    // web-cases
+    'web-zip': argv['web-zip'],
+    'web-indexeddb': argv['web-indexeddb'],
+    'web-iframe': argv['web-iframe'],
     // pdf cases
     'pdf-preview': argv['pdf-preview'],
     'pdf-scale': argv['pdf-scale'],

package/.vscode/settings.json DELETED Viewed

@@ -1,5 +0,0 @@
-{
-    "cSpell.words": [
-        "ILIAS"
-    ]
-}

package/dist/assets/scorm1.2/icon.0052da31.woff2 DELETED Viewed

Binary file