npm - @liascript/exporter - Versions diffs - 2.6.1--0.10.31 → 2.6.2--0.10.31 - Mend

@liascript/exporter 2.6.1--0.10.31 → 2.6.2--0.10.31

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 (10) hide show

package/index.html ADDED Viewed

@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>OER - Kurssammlung</title>
+    <link rel="icon" type="image/x-icon" href="https://upload.wikimedia.org/wikipedia/commons/thumb/d/de/Logo_TU_Bergakademie_Freiberg.svg/242px-Logo_TU_Bergakademie_Freiberg.svg.png">
+    <meta property="og:type" content="website">
+    <meta property="og:title" content="OER-Kurssammlung">
+    <meta property="og:description" content="Sammlung der OER Inhalte der Arbeitsgruppe Softwareentwicklung und Robotik (TU Freiberg)">
+    <meta property="og:image" content="https://upload.wikimedia.org/wikipedia/commons/thumb/8/81/Universitaetsbibliothek_Freiberg_Fassade.jpg/1024px-Universitaetsbibliothek_Freiberg_Fassade.jpg">
+    <meta name="twitter:title" content="OER-Kurssammlung">
+    <meta name="twitter:description" content="Sammlung der OER Inhalte der Arbeitsgruppe Softwareentwicklung und Robotik (TU Freiberg)">
+    <meta name="twitter:image" content="https://upload.wikimedia.org/wikipedia/commons/thumb/8/81/Universitaetsbibliothek_Freiberg_Fassade.jpg/1024px-Universitaetsbibliothek_Freiberg_Fassade.jpg">
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+  </head>
+  <body>
+    <main>
+      <div class="container-fluid" style="background-size: cover; background-image: url('https://upload.wikimedia.org/wikipedia/commons/thumb/8/81/Universitaetsbibliothek_Freiberg_Fassade.jpg/1024px-Universitaetsbibliothek_Freiberg_Fassade.jpg'); background-position: center center; background-repeat: no-repeat;">
+        <section class="py-5 text-center container">
+          <div class="row py-lg-5">
+            <div class="col-lg-6 col-md-8 mx-auto">
+              <h1 class="fw-light">
+                <span style="background-color: rgba(0,106,179,0.75); padding: 5px; color: white">OER - Kurssammlung</span>
+              </h1>
+              <p class="lead text-muted">
+                <span style="color: rgb(0,106,179); background-color: rgba(255,255,255,0.75)">Sammlung der OER Inhalte der Arbeitsgruppe Softwareentwicklung und Robotik (TU Freiberg)</span>
+              </p>
+            </div>
+          </div>
+        </section>
+      </div>
+      <div class="album py-5 bg-light">
+        <div class="container">
+          <div class="row row-cols-1 row-cols-sm-1 row-cols-md-2 row-cols-xl-3 g-3">
+            <div class="col-12">
+              <div class="card">
+                <div class="card-header">Prozedurale Programmierung</div>
+                <div class="card-body">
+                  <p class="card-text">todo</p>
+                  <div class="row">
+                    <div class="col-sm-6 col-md-4 col-lg-3 mb-3">
+                      <div class="card shadow-sm m-1" style="height: 100%" data-category="">
+                        <div class="card-img-top" style="background-size: cover; height: 175px; background-image: url('https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_ProzeduraleProgrammierung/master/img/LogoCodeExample.png'); background-position: center center; background-repeat: no-repeat;"></div>
+                        <div class="card-body" style="transform: rotate(0);">
+                          <a href="https://liascript.github.io/course/?https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_ProzeduraleProgrammierung/master/00_Einfuehrung.md" class="link-dark stretched-link"><h6 class="card-title">Einführung</h6></a>
+                          <p class="card-text">
+                            <small>Einführung in die Programmierung für Nicht-Informatiker</small>
+                          </p>
+                        </div>
+                      </div>
+                    </div>
+                  </div>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+    </main>
+    <footer class="text-muted py-3">
+      <div class="container">
+        <p class="float-end">
+          <a href="#">Back to top</a>
+        </p>
+        <p>
+          Kontakt - Prof. Dr.-Ing. Sebastian Zug -
+          <a href="https://tu-freiberg.de/fakult1/inf/professuren/softwaretechnologie-und-robotik">Lehrstuhl für Softwaretechnologie und Robotik</a>
+          -
+          <a href="mailto:Sebastian.Zug@informatik.tu-freiberg.de">Sebastian.Zug@informatik.tu-freiberg.de</a>
+        </p>
+      </div>
+    </footer>
+  </body>
+</html>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@liascript/exporter",
-  "version": "2.6.1--0.10.31",
+  "version": "2.6.2--0.10.31",
   "description": "A generic exporter for LiaScript",
   "main": "dist/index.js",
   "repository": {
@@ -47,13 +47,13 @@
   "dependencies": {
     "@liascript/simple-scorm-packager": "^0.3.0",
     "archiver": "^5.3.0",
-    "clean-html": "^1.5.0",
     "fs-extra": "^9.1.0",
     "jsonld": "^8.1.1",
     "minimist": "^1.2.5",
     "node-fetch": "^2.6.9",
     "path": "^0.12.7",
     "puppeteer": "^19.2.2",
+    "simply-beautiful": "^0.2.14",
     "temp": "^0.9.4",
     "xhr2": "^0.2.1",
     "yaml": "^2.1.3"

package/src/export/helper.ts CHANGED Viewed

@@ -5,6 +5,7 @@ const temp = require('temp')
 const fs = require('fs-extra')
 const path = require('path')
 const archiver = require('archiver')
+const beautify = require('simply-beautiful')
 export function tmpDir() {
   return new Promise((resolve, reject) => {
@@ -51,6 +52,12 @@ export function injectResponsivevoice(key: string, into: string): string {
   )
 }
+/**
+ * Inject an arbitrary tag directly to the end of the html-head tag.
+ * @param element - new tag to be added
+ * @param into - old index.html content
+ * @returns - new index.html content
+ */
 export function inject(element: string, into: string): string {
   return into.replace('</head>', element + '</head>')
 }
@@ -67,15 +74,16 @@ export async function iframe(
   tmpPath,
   filename: string,
   readme: string,
+  jsonLD: string,
   style?: string,
   index?: string
 ) {
   await writeFile(
     path.join(tmpPath, filename),
-    `<!DOCTYPE html>
+    prettify(`<!DOCTYPE html>
     <html style="height:100%; overflow: hidden">
     <head>
+      ${jsonLD}
     </head>
     <body style="height:100%; margin: 0px">
@@ -97,7 +105,7 @@ export async function iframe(
     </body>
     </html>
-    `
+    `)
   )
 }
@@ -203,3 +211,12 @@ async function checkFileExists(fileUrl: string) {
     return false
   }
 }
+export function prettify(html: string) {
+  return beautify.html(html, {
+    indent_size: 4,
+    space_before_conditional: true,
+    jslint_happy: true,
+    max_char: 0,
+  })
+}

package/src/export/ims.ts CHANGED Viewed

@@ -1,4 +1,5 @@
 import * as helper from './helper'
+import * as RDF from './rdf'
 const path = require('path')
 const fs = require('fs-extra')
@@ -67,7 +68,15 @@ export async function exporter(
     await fs.move(old_, new_)
   }
-  await helper.iframe(tmpPath, 'start.html', argument.readme, argument.style)
+  const jsonLD = await RDF.script(argument, json)
+  await helper.iframe(
+    tmpPath,
+    'start.html',
+    argument.readme,
+    jsonLD,
+    argument.style
+  )
   helper.zip(tmpPath, argument.output)
 }

package/src/export/project.ts CHANGED Viewed

@@ -8,7 +8,6 @@ import * as ANDROID from './android'
 const fs = require('fs-extra')
 const path = require('path')
 const { execSync } = require('child_process')
-const cleaner = require('clean-html')
 var Categories: Set<string> = new Set([])
@@ -233,26 +232,8 @@ export async function exporter(
 </body>
 </html>
 `
-  cleaner.clean(
-    html,
-    {
-      wrap: 0,
-      'break-around-tags': [
-        'a',
-        'head',
-        'link',
-        'meta',
-        'p',
-        'script',
-        'small',
-        'span',
-        'title',
-      ],
-    },
-    function (htmlCleaned: string) {
-      helper.writeFile(output + '.html', htmlCleaned)
-    }
-  )
+  helper.writeFile(output + '.html', helper.prettify(html))
 }
 async function moveFile(oldPath, newPath) {

package/src/export/rdf.ts CHANGED Viewed

@@ -49,6 +49,80 @@ export async function exporter(
     'rdf-educationalLevel'?: string
   },
   json
+) {
+  let doc = parse(argument, json)
+  if (argument['rdf-format'] === 'n-quads') {
+    const nquads = await jsonld.toRDF(doc, { format: 'application/n-quads' })
+    if (argument['rdf-preview']) {
+      console.log(nquads)
+    } else {
+      fs.writeFile(argument.output + '.nq', nquads, function (err) {
+        if (err) console.error(err)
+      })
+    }
+  } else {
+    doc = clean(doc)
+    if (argument['rdf-preview']) {
+      console.log(JSON.stringify(doc, null, 2))
+    } else {
+      fs.writeFile(
+        argument.output + '.jsonld',
+        JSON.stringify(doc, null, 2),
+        function (err) {
+          if (err) console.error(err)
+        }
+      )
+    }
+  }
+}
+export async function script(
+  argument: {
+    input: string
+    readme: string
+    output: string
+    format: string
+    path: string
+    key?: string
+    style?: string
+    // special cases for RDF
+    'rdf-format'?: string
+    'rdf-preview'?: string
+    'rdf-url'?: string
+    'rdf-type'?: string
+    'rdf-template'?: string
+    'rdf-license'?: string
+    'rdf-educationalLevel'?: string
+  },
+  json
+) {
+  return `<script type="application/ld+json">
+    ${JSON.stringify(await parse(argument, json), null, 2)}
+  </script>`
+}
+export async function parse(
+  argument: {
+    input: string
+    readme: string
+    output: string
+    format: string
+    path: string
+    key?: string
+    style?: string
+    // special cases for RDF
+    'rdf-format'?: string
+    'rdf-preview'?: string
+    'rdf-url'?: string
+    'rdf-type'?: string
+    'rdf-template'?: string
+    'rdf-license'?: string
+    'rdf-educationalLevel'?: string
+  },
+  json
 ) {
   let doc = {}
@@ -96,29 +170,7 @@ export async function exporter(
   doc = await licenseInformation(doc, argument, baseURL)
   doc = await jsonld.compact(doc, 'http://schema.org')
-  if (argument['rdf-format'] === 'n-quads') {
-    const nquads = await jsonld.toRDF(doc, { format: 'application/n-quads' })
-    if (argument['rdf-preview']) {
-      console.log(nquads)
-    } else {
-      fs.writeFile(argument.output + '.nq', nquads, function (err) {
-        if (err) console.error(err)
-      })
-    }
-  } else {
-    doc = clean(doc)
-    if (argument['rdf-preview']) {
-      console.log(JSON.stringify(doc, null, 2))
-    } else {
-      fs.writeFile(
-        argument.output + '.jsonld',
-        JSON.stringify(doc, null, 2),
-        function (err) {
-          if (err) console.error(err)
-        }
-      )
-    }
-  }
+  return doc
 }
 /**

package/src/export/scorm12.ts CHANGED Viewed

@@ -1,4 +1,5 @@
 import * as helper from './helper'
+import * as RDF from './rdf'
 const scormPackager = require('@liascript/simple-scorm-packager')
 const path = require('path')
@@ -51,11 +52,20 @@ export async function exporter(
       ';'
   )
+  const jsonLD = await RDF.script(argument, json)
   if (argument['scorm-iframe']) {
-    await helper.iframe(tmpPath, 'start.html', argument.readme, argument.style)
+    await helper.iframe(
+      tmpPath,
+      'start.html',
+      argument.readme,
+      jsonLD,
+      argument.style
+    )
   }
   try {
+    index = helper.inject(jsonLD, index)
     await helper.writeFile(path.join(tmpPath, 'index.html'), index)
   } catch (e) {
     console.warn(e)

package/src/export/scorm2004.ts CHANGED Viewed

@@ -1,5 +1,7 @@
 import * as helper from './helper'
+import * as RDF from './rdf'
 const scormPackager = require('@liascript/simple-scorm-packager')
 const path = require('path')
 const fs = require('fs-extra')
@@ -50,11 +52,20 @@ export async function exporter(
       ';'
   )
+  const jsonLD = await RDF.script(argument, json)
   if (argument['scorm-iframe']) {
-    await helper.iframe(tmpPath, 'start.html', argument.readme, argument.style)
+    await helper.iframe(
+      tmpPath,
+      'start.html',
+      argument.readme,
+      jsonLD,
+      argument.style
+    )
   }
   try {
+    index = helper.inject(jsonLD, index)
     await helper.writeFile(path.join(tmpPath, 'index.html'), index)
   } catch (e) {
     console.warn(e)

package/src/export/web.ts CHANGED Viewed

@@ -1,4 +1,5 @@
 import * as helper from './helper'
+import * as RDF from './rdf'
 const path = require('path')
 const fs = require('fs-extra')
@@ -16,6 +17,15 @@ export async function exporter(
     'web-iframe'?: boolean
     'web-indexeddb'?: boolean
     'web-zip'?: boolean
+    // special cases for RDF
+    'rdf-format'?: string
+    'rdf-preview'?: string
+    'rdf-url'?: string
+    'rdf-type'?: string
+    'rdf-template'?: string
+    'rdf-license'?: string
+    'rdf-educationalLevel'?: string
   },
   json: any
 ) {
@@ -109,6 +119,8 @@ export async function exporter(
     console.warn('could not add image')
   }
+  const jsonLD = await RDF.script(argument, json)
   try {
     if (argument['web-iframe']) {
       await helper.writeFile(path.join(tmpPath, 'start.html'), index)
@@ -116,10 +128,14 @@ export async function exporter(
         tmpPath,
         'index.html',
         argument.readme,
+        jsonLD,
         argument.style,
         'start.html'
       )
     } else {
+      index = helper.inject(jsonLD, index)
+      index = helper.prettify(index)
       await helper.writeFile(path.join(tmpPath, 'index.html'), index)
     }
   } catch (e) {