@liascript/exporter 2.5.8--0.10.30 → 2.6.0--0.10.31

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liascript/exporter",
-  "version": "2.5.8--0.10.30",
+  "version": "2.6.0--0.10.31",
   "description": "A generic exporter for LiaScript",
   "main": "dist/index.js",
   "repository": {
@@ -47,7 +47,9 @@
     "@liascript/simple-scorm-packager": "^0.3.0",
     "archiver": "^5.3.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",
     "temp": "^0.9.4",

package/src/export/helper.ts

@@ -1,5 +1,6 @@
 'use strict'
 
+import fetch from 'node-fetch'
 const temp = require('temp')
 const fs = require('fs-extra')
 const path = require('path')
@@ -180,3 +181,25 @@ export function getRepository(raw_url: string) {
 
   return null
 }
+
+export async function checkLicense(baseURL: string) {
+  const url = new URL('LICENSE', baseURL).href
+
+  return await checkFileExists(url)
+}
+
+export function baseURL(url: string) {
+  const path = url.split('/')
+  path.pop()
+  return path.join('/')
+}
+
+async function checkFileExists(fileUrl: string) {
+  try {
+    const response = await fetch(fileUrl, { method: 'HEAD' })
+    return response.status === 200
+  } catch (error) {
+    console.warn(`Error checking if file exists: ${error}`)
+    return false
+  }
+}

package/src/export/rdf.ts

@@ -0,0 +1,227 @@
+import * as helper from './helper'
+
+const jsonld = require('jsonld')
+const fs = require('fs-extra')
+
+export function help() {
+  console.log('\nRDF settings:')
+  console.log('')
+
+  console.log(
+    '--rdf-format               Output format n-quads, json-ld (defaults to json-ld).'
+  )
+  console.log('--rdf-preview              Output the result to the console.')
+  console.log(
+    '--rdf-url                  Refer to an external URL when parsing a local project.'
+  )
+  console.log(
+    '--rdf-type                 Course frm schmema.org is applied as default, overwrite this with EducationalResource, etc.'
+  )
+  console.log(
+    '--rdf-license              Add a license-URL, otherwise if url was provided as input, this will check for an existing LICENSE file.'
+  )
+  console.log(
+    '--rdf-educationalLevel     Typically beginner, intermediate or advanced, and formal sets of level indicators.'
+  )
+}
+
+export async function exporter(
+  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-input'?: string
+    'rdf-license'?: string
+    'rdf-educationalLevel'?: string
+  },
+  json
+) {
+  let doc = {}
+
+  doc = {
+    'http://schema.org/name': json.lia.str_title,
+    'http://schema.org/@type': argument['rdf-type'] || 'Course',
+  }
+
+  let baseURL: string | null = null
+
+  // If a Url is defined, this Url is used as the key and to generate
+  if (helper.isURL(argument.input) || argument['rdf-url']) {
+    doc['http://schema.org/@id'] = argument['rdf-url'] || argument.input
+    doc['http://schema.org/url'] =
+      'https://LiaScript.github.io/course/?' +
+      (argument['rdf-url'] || argument.input)
+
+    baseURL = helper.baseURL(argument['rdf-url'] || argument.input)
+  }
+
+  if (argument['rdf-educationalLevel']) {
+    doc['http://schema.org/educationalLevel'] = argument['rdf-educationalLevel']
+  }
+
+  doc = baseInformation(doc, json.lia.definition)
+  doc = langInformation(doc, json.lia.definition)
+  doc = logoInformation(doc, json.lia.definition, baseURL)
+  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)
+        }
+      )
+    }
+  }
+}
+
+/**
+ * Adds the following information, if they exist:
+ *
+ * - author:
+ *   - name
+ *   - email
+ * - description
+ * - keywords
+ * - version
+ */
+function baseInformation(doc: any, definition: any) {
+  if (definition?.author || definition?.email) {
+    const author = { 'http://schema.org/@type': 'Person' }
+
+    if (definition?.author) {
+      author['http://schema.org/name'] = definition?.author
+    }
+
+    if (definition?.email) {
+      author['http://schema.org/email'] = definition?.email
+    }
+
+    doc['http://schema.org/author'] = author
+  }
+
+  if (definition.macro?.comment) {
+    doc['http://schema.org/description'] = definition.macro?.comment
+  }
+
+  if (definition.macro?.tags) {
+    doc['http://schema.org/keywords'] = definition.macro.tags
+      .split(',')
+      .map((e: string) => e.trim())
+  }
+
+  if (definition?.version) {
+    doc['http://schema.org/version'] = definition?.version
+  }
+
+  return doc
+}
+
+/**
+ * Adds language information:
+ *
+ * - inLanguage
+ * - TODO: Translations
+ * @returns
+ */
+function langInformation(doc: any, definition: any) {
+  if (definition?.language) {
+    doc['http://schema.org/inLanguage'] = definition.language
+  }
+
+  return doc
+}
+
+/**
+ * Adds the image information.
+ *
+ * - image: from LiaScript logo
+ * - TODO: thumbnailUrl: from LiaScript icon
+ */
+function logoInformation(doc: any, definition: any, baseURL: null | string) {
+  if (definition?.logo) {
+    let imageUrl: string | null = null
+
+    if (helper.isURL(definition?.logo)) {
+      imageUrl = definition?.logo
+    } else if (baseURL) {
+      imageUrl = new URL(definition?.logo, baseURL).href
+    }
+
+    if (imageUrl) {
+      doc['http://schema.org/image'] = {
+        'http://schema.org/@type': 'ImageObject',
+        'http://schema.org/url': imageUrl,
+      }
+    }
+  }
+
+  return doc
+}
+
+async function licenseInformation(
+  doc: any,
+  argument: any,
+  baseURL: null | string
+) {
+  let licenseUrl: string | null = null
+
+  if (argument['rdf-license']) {
+    licenseUrl = argument['rdf-license']
+  } else if (baseURL && (await helper.checkLicense(baseURL))) {
+    licenseUrl = new URL(baseURL, 'LICENSE').href
+  }
+
+  if (licenseUrl) {
+    doc['http://schema.org/license'] = licenseUrl
+  }
+
+  return doc
+}
+
+/**
+ * For some reason, jsonld puts to all keys with a "Url" a "schema:"
+ * to the front. This functions replaces all "schema:.*" by ".*".
+ */
+function clean(obj: Object) {
+  if (!obj || typeof obj !== 'object') {
+    return obj
+  }
+  if (Array.isArray(obj)) {
+    return obj.map((item) => clean(item))
+  }
+  return Object.keys(obj).reduce((acc, key) => {
+    const value = obj[key]
+    if (key.startsWith('schema:')) {
+      acc[key.split(':').pop() || key] = value
+    } else {
+      acc[key] = clean(value)
+    }
+    return acc
+  }, {})
+}

package/src/index.ts

@@ -10,6 +10,7 @@ import * as IMS from './export/ims'
 import * as ANDROID from './export/android'
 // import * as IOS from './export/ios'
 import * as PROJECT from './export/project'
+import * as RDF from './export/rdf'
 
 global.XMLHttpRequest = require('xhr2')
 
@@ -17,10 +18,11 @@ import YAML from 'yaml'
 const path = require('path')
 const fs = require('fs-extra')
 const argv = require('minimist')(process.argv.slice(2))
+import fetch from 'node-fetch'
 
 // -------------------------------Main Execution-------------------------------
 if (argv.v || argv.version) {
-  console.log('version: 2.5.8--0.10.30')
+  console.log('version: 2.6.0--0.10.31')
 } else if (argv.h || argv.help) {
   help()
 } else if (argv.i || argv.input) {
@@ -33,7 +35,7 @@ if (argv.v || argv.version) {
 
 var collection: any
 
-function run(argument) {
+async function run(argument) {
   var app = Elm.Worker.init({ flags: { cmd: '' } })
   app.ports.output.subscribe(function (event) {
     let [ok, string] = event
@@ -52,6 +54,10 @@ function run(argument) {
         })
         break
       }
+      case 'rdf': {
+        RDF.exporter(argument, JSON.parse(string))
+        break
+      }
       case 'scorm1.2': {
         SCORM12.exporter(argument, JSON.parse(string))
         break
@@ -118,6 +124,7 @@ function run(argument) {
       argument.format == 'ims' ||
       argument.format == 'android' ||
       argument.format == 'ios' ||
+      argument.format == 'rdf' ||
       argument.format == 'project'
         ? 'fulljson'
         : argument.format
@@ -136,6 +143,13 @@ function run(argument) {
       app.ports.input.send([format, data])
     } else if (argument.format === 'pdf') {
       PDF.exporter(argument, {})
+    } else if (argument.format === 'rdf') {
+      const resp = await fetch(argument.input)
+      const data = await resp.text()
+
+      if (data) {
+        app.ports.input.send([format, data])
+      }
     } else {
       console.warn('URLs are not allowed as input')
     }
@@ -167,7 +181,7 @@ function help() {
   console.log(
     '-f',
     '--format',
-    '         scorm1.2, scorm2004, json, fullJson, web, ims, pdf, android (default is json)'
+    '         scorm1.2, scorm2004, json, fullJson, web, ims, pdf, android, linkedData (default is json)'
   )
   console.log('-v', '--version', '        output the current version')
 
@@ -326,6 +340,8 @@ function help() {
   console.log(
     '--project-generate-cache   Only generate new files, if they do not exist.'
   )
+
+  RDF.help()
 }
 
 function escapeBackslash(path?: string) {
@@ -400,6 +416,14 @@ function parseArguments() {
     'project-generate-scorm2004': argv['project-generate-scorm2004'],
     'project-generate-android': argv['project-generate-android'],
     'project-generate-cache': argv['project-generate-cache'],
+
+    // RDF settngs
+    'rdf-format': argv['rdf-format'],
+    'rdf-preview': argv['rdf-preview'],
+    'rdf-url': argv['rdf-url'],
+    'rdf-type': argv['rdf-type'],
+    'rdf-license': argv['rdf-license'],
+    'rdf-educationalLevel': argv['rdf-educationalLevel'],
   }
 
   argument.format = argument.format.toLowerCase()