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

@liascript/exporter 2.1.1--0.10.0 → 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 (11) hide show

package/README.md CHANGED Viewed

@@ -89,6 +89,8 @@ IMS settings:
 WEB settings:
+--web-iframe               Use an iframed version to hide the course URL.
+--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).
 --web-zip                  By default the result is not zipped, you can change this with this parameter.
 PDF settings:
@@ -312,6 +314,24 @@ responsivevoice-key via `--key`.
 __`--web-zip`:__ Use this parameter to directly bundle all input into a zip
 file instead of a folder.
+__`--web-iframe`:__ This will put the course into an secondary iframe, which will
+hide the course-URL (the Markdown-file). Unfortunately, it will not be possible
+anymore to link from outside to a specific slide.
+__`web-indexeddb`:__ Generate a LiaScript package that will store states persistently.
+By default, the database is generated uniquely for the packed course. That means,
+every update will use a new database, which makes sense, if and only if, typos get
+corrected or content is added to the end of the document. Mixing content and moving
+quizzes and surveys to different slides might cause some problems in restoring the
+state. But you can use this parameter with a key:
+```shell
+liaex --format web -i project/README.md -o outputFolder --web-indexeddb someKeyToUse
+updating title ...
+updating description ...
+updating logo ...
+```
 ### PDF
 For printing out courses to PDF this package uses

package/dist/index.js CHANGED Viewed

@@ -12245,8 +12245,8 @@ function $320134ce32dd9048$export$a976684a0efeb93f(element, into) {
 function $320134ce32dd9048$export$bab98af026af71ac(uri) {
     return uri.startsWith('http://') || uri.startsWith('https://') || uri.startsWith('file://');
 }
-async function $320134ce32dd9048$export$8cde213409fd6377(tmpPath, readme) {
-    await $320134ce32dd9048$export$552bfb764b5cd2b4($9Afec$path.join(tmpPath, 'start.html'), `<!DOCTYPE html>
+async function $320134ce32dd9048$export$8cde213409fd6377(tmpPath, filename, readme, index) {
+    await $320134ce32dd9048$export$552bfb764b5cd2b4($9Afec$path.join(tmpPath, filename), `<!DOCTYPE html>
     <html style="height:100%; overflow: hidden">
     <head>
@@ -12260,7 +12260,7 @@ async function $320134ce32dd9048$export$8cde213409fd6377(tmpPath, readme) {
       let iframe = document.getElementById("lia-container")
       if (iframe) {
-        const src = path + "index.html?" + path + "${readme.replace('./', '')}"
+        const src = path + "${index || 'index.html'}?" + path + "${readme.replace('./', '')}"
         iframe.src = src
       }
     </script>
@@ -12320,7 +12320,17 @@ async function $1e521125b288b3fc$export$372e2d09604f52f0(argument, json) {
     let tmp = await $320134ce32dd9048$export$6b76988456c0292f();
     let tmpPath = $9Afec$path.join(tmp, 'pro');
     // copy assets to temp
-    await $9Afec$fsextra.copy($9Afec$path.join(__dirname, './assets/web'), tmpPath);
+    await $9Afec$fsextra.copy($9Afec$path.join(__dirname, argument['web-indexeddb'] ? './assets/indexeddb' : './assets/web'), tmpPath);
+    // copy base path or readme-directory into temp
+    await $9Afec$fsextra.copy(argument.path, tmpPath);
+    // rename the readme if necessary
+    if (argument['web-indexeddb'] !== undefined) {
+        let newReadme = (typeof argument['web-indexeddb'] === 'string' ? argument['web-indexeddb'] : $320134ce32dd9048$export$4385e60b38654f68(20)) + '.md';
+        let old_ = $9Afec$path.join(tmpPath, argument.readme);
+        let new_ = $9Afec$path.join($9Afec$path.dirname(old_), newReadme);
+        argument.readme = argument.readme.replace($9Afec$path.basename(argument.readme), newReadme);
+        await $9Afec$fsextra.move(old_, new_);
+    }
     let index = $9Afec$fsextra.readFileSync($9Afec$path.join(tmpPath, 'index.html'), 'utf8');
     // change responsive key
     if (argument.key) index = $320134ce32dd9048$export$31a09876afc8115c(argument.key, index);
@@ -12329,7 +12339,7 @@ async function $1e521125b288b3fc$export$372e2d09604f52f0(argument, json) {
   if (!window.LIA) {
     window.LIA = {}
   }
-  window.LIA.defaultCourse="${$9Afec$path.basename(argument.readme)}"
+   window.LIA.defaultCourseURL = "${$9Afec$path.basename(argument.readme)}"
   </script>`, index);
     try {
         index = index.replace('<title>Lia</title>', `<title>${json.lia.str_title}</title><meta property="og:title" content="${json.lia.str_title}"> <meta name="twitter:title" content="${json.lia.str_title}">`);
@@ -12353,13 +12363,14 @@ async function $1e521125b288b3fc$export$372e2d09604f52f0(argument, json) {
         console.warn('could not add image');
     }
     try {
-        await $320134ce32dd9048$export$552bfb764b5cd2b4($9Afec$path.join(tmpPath, 'index.html'), index);
+        if (argument['web-iframe']) {
+            await $320134ce32dd9048$export$552bfb764b5cd2b4($9Afec$path.join(tmpPath, 'start.html'), index);
+            await $320134ce32dd9048$export$8cde213409fd6377(tmpPath, 'index.html', argument.readme, 'start.html');
+        } else await $320134ce32dd9048$export$552bfb764b5cd2b4($9Afec$path.join(tmpPath, 'index.html'), index);
     } catch (e3) {
         console.warn(e3);
         return;
     }
-    // copy base path or readme-directory into temp
-    await $9Afec$fsextra.copy(argument.path, tmpPath);
     if (argument['web-zip']) $320134ce32dd9048$export$8901015135f2fb22(tmpPath, argument.output);
     else await $9Afec$fsextra.move(tmpPath, argument.output, {
         filter: $320134ce32dd9048$export$3032dc2899b8ea9b
@@ -12386,7 +12397,7 @@ async function $699da5868da0be18$export$372e2d09604f52f0(argument, json) {
         quiz: json.quiz,
         survey: json.survey
     }) + ';');
-    if (argument['scorm-iframe']) await $320134ce32dd9048$export$8cde213409fd6377(tmpPath, argument.readme);
+    if (argument['scorm-iframe']) await $320134ce32dd9048$export$8cde213409fd6377(tmpPath, 'start.html', argument.readme);
     try {
         await $320134ce32dd9048$export$552bfb764b5cd2b4($9Afec$path.join(tmpPath, 'index.html'), index);
     } catch (e) {
@@ -12453,7 +12464,7 @@ async function $c4fe6e5c8950c8b3$export$372e2d09604f52f0(argument, json) {
         quiz: json.quiz,
         survey: json.survey
     }) + ';');
-    if (argument['scorm-iframe']) await $320134ce32dd9048$export$8cde213409fd6377(tmpPath, argument.readme);
+    if (argument['scorm-iframe']) await $320134ce32dd9048$export$8cde213409fd6377(tmpPath, 'start.html', argument.readme);
     try {
         await $320134ce32dd9048$export$552bfb764b5cd2b4($9Afec$path.join(tmpPath, 'index.html'), index);
     } catch (e) {
@@ -12638,7 +12649,7 @@ async function $e5a6b0d412255288$export$372e2d09604f52f0(argument, json) {
         argument.readme = argument.readme.replace($9Afec$path.basename(argument.readme), newReadme);
         await $9Afec$fsextra.move(old_, new_);
     }
-    await $320134ce32dd9048$export$8cde213409fd6377(tmpPath, argument.readme);
+    await $320134ce32dd9048$export$8cde213409fd6377(tmpPath, 'start.html', argument.readme);
     $320134ce32dd9048$export$8901015135f2fb22(tmpPath, argument.output);
 }
 async function $e5a6b0d412255288$var$manifest(tmpPath, meta) {
@@ -12785,6 +12796,8 @@ function $ccdb061a5468de1f$var$help() {
     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.');
@@ -12826,6 +12839,8 @@ function $ccdb061a5468de1f$var$parseArguments() {
         'ims-indexeddb': $ccdb061a5468de1f$var$argv['ims-indexeddb'],
         // web-cases
         'web-zip': $ccdb061a5468de1f$var$argv['web-zip'],
+        'web-indexeddb': $ccdb061a5468de1f$var$argv['web-indexeddb'],
+        'web-iframe': $ccdb061a5468de1f$var$argv['web-iframe'],
         // pdf cases
         'pdf-preview': $ccdb061a5468de1f$var$argv['pdf-preview'],
         'pdf-scale': $ccdb061a5468de1f$var$argv['pdf-scale'],

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@liascript/exporter",
-  "version": "2.1.1--0.10.0",
+  "version": "2.2.0--0.10.0",
   "description": "A generic exporter for LiaScript",
   "main": "dist/index.js",
   "repository": {

package/src/export/helper.ts CHANGED Viewed

@@ -54,9 +54,14 @@ export function isURL(uri: string) {
   )
 }
-export async function iframe(tmpPath, readme: string) {
+export async function iframe(
+  tmpPath,
+  filename: string,
+  readme: string,
+  index?: string
+) {
   await writeFile(
-    path.join(tmpPath, 'start.html'),
+    path.join(tmpPath, filename),
     `<!DOCTYPE html>
     <html style="height:100%; overflow: hidden">
     <head>
@@ -71,7 +76,9 @@ export async function iframe(tmpPath, readme: string) {
       let iframe = document.getElementById("lia-container")
       if (iframe) {
-        const src = path + "index.html?" + path + "${readme.replace('./', '')}"
+        const src = path + "${
+          index || 'index.html'
+        }?" + path + "${readme.replace('./', '')}"
         iframe.src = src
       }
     </script>

package/src/export/ims.ts CHANGED Viewed

@@ -64,7 +64,7 @@ export async function exporter(
     await fs.move(old_, new_)
   }
-  await helper.iframe(tmpPath, argument.readme)
+  await helper.iframe(tmpPath, 'start.html', argument.readme)
   helper.zip(tmpPath, argument.output)
 }

package/src/export/scorm12.ts CHANGED Viewed

@@ -49,7 +49,7 @@ export async function exporter(
   )
   if (argument['scorm-iframe']) {
-    await helper.iframe(tmpPath, argument.readme)
+    await helper.iframe(tmpPath, 'start.html', argument.readme)
   }
   try {

package/src/export/scorm2004.ts CHANGED Viewed

@@ -49,7 +49,7 @@ export async function exporter(
   )
   if (argument['scorm-iframe']) {
-    await helper.iframe(tmpPath, argument.readme)
+    await helper.iframe(tmpPath, 'start.html', argument.readme)
   }
   try {

package/src/export/web.ts CHANGED Viewed

@@ -12,6 +12,8 @@ export async function exporter(
     path: string
     key?: string
+    'web-iframe'?: boolean
+    'web-indexeddb'?: boolean
     'web-zip'?: boolean
   },
   json: any
@@ -22,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')
@@ -37,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
   )
@@ -79,15 +108,17 @@ 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)
   if (argument['web-zip']) {
     helper.zip(tmpPath, argument.output)
   } else {

package/src/index.ts CHANGED Viewed

@@ -147,6 +147,12 @@ function help() {
   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.'
   )
@@ -238,6 +244,8 @@ function parseArguments() {
     // web-cases
     'web-zip': argv['web-zip'],
+    'web-indexeddb': argv['web-indexeddb'],
+    'web-iframe': argv['web-iframe'],
     // pdf cases
     'pdf-preview': argv['pdf-preview'],

package/.vscode/settings.json DELETED Viewed

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