Hong-Phuc Bui
2024-09-23 ddc431b5be5afe4995a7b278d79e5564739f3128
build lib OK
3 files added
23 ■■■■■ changed files
dist/lib/mathcoach-ide-tool-utils.js 8 ●●●●● patch | view | raw | blame | history
dist/lib/mathcoach-ide-tool-utils.js.map 1 ●●●● patch | view | raw | blame | history
dist/lib/standalone-usage.html 14 ●●●●● patch | view | raw | blame | history
dist/lib/mathcoach-ide-tool-utils.js
New file
@@ -0,0 +1,8 @@
parcelRequire=function(e,r,t,n){var i,o="function"==typeof parcelRequire&&parcelRequire,u="function"==typeof require&&require;function f(t,n){if(!r[t]){if(!e[t]){var i="function"==typeof parcelRequire&&parcelRequire;if(!n&&i)return i(t,!0);if(o)return o(t,!0);if(u&&"string"==typeof t)return u(t);var c=new Error("Cannot find module '"+t+"'");throw c.code="MODULE_NOT_FOUND",c}p.resolve=function(r){return e[t][1][r]||r},p.cache={};var l=r[t]=new f.Module(t);e[t][0].call(l.exports,p,l,l.exports,this)}return r[t].exports;function p(e){return f(p.resolve(e))}}f.isParcelRequire=!0,f.Module=function(e){this.id=e,this.bundle=f,this.exports={}},f.modules=e,f.cache=r,f.parent=o,f.register=function(r,t){e[r]=[function(e,r){r.exports=t},{}]};for(var c=0;c<t.length;c++)try{f(t[c])}catch(e){i||(i=e)}if(t.length){var l=f(t[t.length-1]);"object"==typeof exports&&"undefined"!=typeof module?module.exports=l:"function"==typeof define&&define.amd?define(function(){return l}):n&&(this[n]=l)}if(parcelRequire=f,i)throw i;return f}({"TGp+":[function(require,module,exports) {
"use strict";Object.defineProperty(exports,"__esModule",{value:!0});
},{}],"R81e":[function(require,module,exports) {
"use strict";var e,t=this&&this.__awaiter||function(e,t,i,n){return new(i||(i=Promise))(function(r,o){function s(e){try{f(n.next(e))}catch(t){o(t)}}function a(e){try{f(n.throw(e))}catch(t){o(t)}}function f(e){var t;e.done?r(e.value):(t=e.value,t instanceof i?t:new i(function(e){e(t)})).then(s,a)}f((n=n.apply(e,t||[])).next())})};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Helpers=void 0,function(e){function i(e="dummy.json",i=("undefined"==typeof localStorage?new r:localStorage)){const o=e=>`mock-file://${e.owner}@${e.part}/${e.path}`,s=(e,t)=>console.log(["[MC MOCK API]"," ",e,"(",(t||[""]).join(","),")"].join("")),a=(e,t)=>(i,n,r=!1)=>{if(void 0===n){if(r)return;throw new Error(`missing parameter '${i}'`)}if(t(n))throw new Error(`parameter '${i}' is invalid: ${e}`)},f=a("not a string",e=>"string"!=typeof e),u=a("not a boolean",e=>"boolean"!=typeof e),d=a("not a valid file",e=>!n(e));return{ide:{getContextFile(){return t(this,void 0,void 0,function*(){return s("MC.ide.getContextFile"),{owner:"jdoe",path:`/file.${e}`,part:"vfs"}})},getUserName(){return t(this,void 0,void 0,function*(){return s("MC.ide.getUserName"),"jdoe"})},fs:{readFile(e){return t(this,void 0,void 0,function*(){return s("MC.ide.fs.readFile",[JSON.stringify(e)]),d("file",e),i.getItem(o(e))||""})},writeFile(e,n){return t(this,void 0,void 0,function*(){return s("MC.ide.fs.writeFile",[JSON.stringify(e),JSON.stringify(`...${n.length} chars...`)]),d("file",e),f("text",n),i.setItem(o(e),n)})}},navigator:{navigateTo(e,i){return t(this,void 0,void 0,function*(){s("MC.ide.navigator.navigateTo",[JSON.stringify(e),JSON.stringify(!!i)]),f("link",e),u("forceOpen",i,!0)})},navigateToExercise(e,i){return t(this,void 0,void 0,function*(){s("MC.ide.navigator.navigateToExercise",[JSON.stringify(e),JSON.stringify(!!i)]),d("file",e),u("forceOpen",i,!0)})}}},isReady(){return t(this,void 0,void 0,function*(){return s("MC.isReady"),!0})}}}function n(e){return!(!e||!e.owner||"string"!=typeof e.owner||!e.part||"string"!=typeof e.part||"vfs"!==e.part&&"www"!==e.part||!e.path||"string"!=typeof e.path||0!==e.path.indexOf("/"))}e.enableOfflineUsageIfNecessary=function(e="dummy.json"){if("undefined"==typeof MC)return console.warn("you are offline - offline api is used"),("undefined"==typeof window?{}:window).MC=i(e),!0;return!1},e.createStorageBasedApi=i,e.isFile=n,e.contextFileToExerciseFile=function(e){if(n(e))return{part:e.part,owner:e.owner,path:e.path.split(".")[0]+".groovy"};throw new Error("no valid file reference given, expected object like {owner:'demo', part:'vfs'|'www', path: '/...'}")};class r{constructor(){this.items=new Map}get length(){return this.items.size}clear(){this.items.clear()}getItem(e){const t=this.items.get(e);return t||null}key(e){throw new Error("InMemoryStorage: key function is not implemented now")}removeItem(e){this.items.delete(e)}setItem(e,t){this.items.set(e,t)}}e.InMemoryStorage=r}(e=exports.Helpers||(exports.Helpers={}));
},{}],"7QCb":[function(require,module,exports) {
"use strict";var e=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&("get"in o?t.__esModule:!o.writable&&!o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),t=this&&this.__exportStar||function(t,r){for(var i in t)"default"===i||Object.prototype.hasOwnProperty.call(r,i)||e(r,t,i)};Object.defineProperty(exports,"__esModule",{value:!0}),t(require("./MathCoach"),exports),t(require("./Helpers"),exports);
},{"./MathCoach":"TGp+","./Helpers":"R81e"}]},{},["7QCb"], "MC_IDE_TOOL_UTILS")
//# sourceMappingURL=mathcoach-ide-tool-utils.js.map
dist/lib/mathcoach-ide-tool-utils.js.map
New file
@@ -0,0 +1 @@
{"version":3,"sources":["Helpers.ts","index.ts"],"names":[],"mappings":";;;AAMA,aAAA,IAAiB,EAAjB,EAAA,MAAA,KAAA,WAAA,SAAA,EAAA,EAAA,EAAA,GAAA,OAAA,IAAA,IAAA,EAAA,UAAA,SAAA,EAAA,GAAA,SAAA,EAAA,GAAA,IAAA,EAAA,EAAA,KAAA,IAAA,MAAA,GAAA,EAAA,IAAA,SAAA,EAAA,GAAA,IAAA,EAAA,EAAA,MAAA,IAAA,MAAA,GAAA,EAAA,IAAA,SAAA,EAAA,GAAA,IAAA,EAAA,EAAA,KAAA,EAAA,EAAA,QAAA,EAAA,EAAA,MAAA,aAAA,EAAA,EAAA,IAAA,EAAA,SAAA,GAAA,EAAA,MAAA,KAAA,EAAA,GAAA,GAAA,EAAA,EAAA,MAAA,EAAA,GAAA,KAAA,WAAA,OAAA,eAAA,QAAA,aAAA,CAAA,OAAA,IAAA,QAAA,aAAA,EAAA,SAAiB,GAoDG,SAAA,EACZ,EAA+B,aAC/B,GAA4C,oBAAjB,aAAgC,IAAI,EAAoB,eAE7E,MAAA,EAAkB,kBAAwC,EAAK,SAAS,EAAK,QAAQ,EAAK,OAC1F,EAAc,CAAC,EAAgB,IAAiB,QAAQ,IAAI,CAAC,gBAAiB,IAAK,EAAQ,KAAM,GAAc,CAAC,KAAK,KAAK,KAAM,KAAK,KAAK,KAC1I,EAAe,CAAC,EAAsB,IACjC,CAAC,EAAmB,EAAY,GAAoB,KACnD,QAAU,IAAV,EAAqB,CACjB,GAAA,EACA,OAEM,MAAA,IAAI,4BAA4B,MAG1C,GAAA,EAAU,GACJ,MAAA,IAAI,oBAAoB,kBAA0B,MAI9D,EAAqB,EAAa,eAAgB,GAAkB,iBAAN,GAC9D,EAAsB,EAAa,gBAAiB,GAAkB,kBAAN,GAChE,EAAmB,EAAa,mBAAoB,IAAM,EAAO,IA8ChE,MA7CoB,CACvB,IAAK,CACK,iBA7EtB,OAAA,EAAA,UAAA,OAAA,EAAA,YA+E2B,OADP,EAAY,yBACL,CACH,MAAO,OACP,cAAe,IACf,KAAM,UAGR,cArFtB,OAAA,EAAA,UAAA,OAAA,EAAA,YAuF2B,OADP,EAAY,sBACL,UAEX,GAAI,CACM,SAAS,GA1FnC,OAAA,EAAA,UAAA,OAAA,EAAA,YA6F+B,OAFP,EAAY,qBAAsB,CAAC,KAAK,UAAU,KAClD,EAAiB,OAAQ,GAClB,EAAQ,QAAQ,EAAe,KAAU,MAE9C,UAAU,EAAsB,GA/F1D,OAAA,EAAA,UAAA,OAAA,EAAA,YAmG+B,OAHP,EAAY,sBAAuB,CAAC,KAAK,UAAU,GAAO,KAAK,gBAAgB,EAAK,qBACpF,EAAiB,OAAQ,GACzB,EAAmB,OAAQ,GACpB,EAAQ,QAAQ,EAAe,GAAO,OAGrD,UAAW,CACD,WAAW,EAAc,GAvGnD,OAAA,EAAA,UAAA,OAAA,EAAA,YAwGwB,EAAY,8BAA+B,CAAC,KAAK,UAAU,GAAO,KAAK,YAAU,KACjF,EAAmB,OAAQ,GAC3B,EAAoB,YAAa,GAAW,MAE1C,mBAAmB,EAAsB,GA5GnE,OAAA,EAAA,UAAA,OAAA,EAAA,YA6GwB,EAAY,sCAAuC,CAAC,KAAK,UAAU,GAAO,KAAK,YAAU,KACzF,EAAiB,OAAQ,GACzB,EAAoB,YAAa,GAAW,QAIlD,UAnHlB,OAAA,EAAA,UAAA,OAAA,EAAA,YAqHuB,OADP,EAAY,eACL,MAYH,SAAA,EAAO,GACZ,SAAC,IACA,EAAU,OAAqD,iBAApB,EAAU,QACrD,EAAU,MAAmD,iBAAnB,EAAU,MACjC,QAAnB,EAAU,MAAqC,QAAnB,EAAU,OACtC,EAAU,MAAmD,iBAAnB,EAAU,MACpB,IAAhC,EAAU,KAAK,QAAQ,MAnHnB,EAAA,8BAAA,SAA8B,EAA+B,cACrE,GAAc,oBAAP,GAIA,OAHP,QAAQ,KAAK,0CACqB,oBAAX,OAA0B,GAAY,QACtD,GAAK,EAAsB,IAC3B,EAEA,OAAA,GAyBC,EAAA,sBAAqB,EA6ErB,EAAA,OAAM,EA0BN,EAAA,0BAAA,SAA0B,GAClC,GAAA,EAAO,GAMA,MAL4B,CAC/B,KAAM,EAAY,KAClB,MAAO,EAAY,MACnB,KAAM,EAAY,KAAK,MAAM,KAAK,GAAK,WAIrC,MAAA,IAAI,MAAM,uGAQX,MAAA,EAAb,cAEqB,KAAA,MAA6B,IAAI,IAE9C,aACO,OAAA,KAAK,MAAM,KAEtB,QACS,KAAA,MAAM,QAEf,QAAQ,GACE,MAAA,EAAQ,KAAK,MAAM,IAAI,GACtB,OAAA,GAAgB,KAE3B,IAAI,GACM,MAAA,IAAI,MAAM,wDAEpB,WAAW,GACF,KAAA,MAAM,OAAO,GAEtB,QAAQ,EAAa,GACZ,KAAA,MAAM,IAAI,EAAK,IArBf,EAAA,gBAAe,EA5KhC,CAAiB,EAAA,QAAA,UAAA,QAAA,QAAO;;ACLxB,aAAA,IAAA,EAAA,MAAA,KAAA,kBAAA,OAAA,OAAA,SAAA,EAAA,EAAA,EAAA,QAAA,IAAA,IAAA,EAAA,GAAA,IAAA,EAAA,OAAA,yBAAA,EAAA,GAAA,IAAA,QAAA,EAAA,EAAA,YAAA,EAAA,WAAA,EAAA,gBAAA,EAAA,CAAA,YAAA,EAAA,IAAA,WAAA,OAAA,EAAA,MAAA,OAAA,eAAA,EAAA,EAAA,IAAA,SAAA,EAAA,EAAA,EAAA,QAAA,IAAA,IAAA,EAAA,GAAA,EAAA,GAAA,EAAA,KAAA,EAAA,MAAA,KAAA,cAAA,SAAA,EAAA,GAAA,IAAA,IAAA,KAAA,EAAA,YAAA,GAAA,OAAA,UAAA,eAAA,KAAA,EAAA,IAAA,EAAA,EAAA,EAAA,IAAA,OAAA,eAAA,QAAA,aAAA,CAAA,OAAA,IADA,EAAA,QAAA,eAAA,SACA,EAAA,QAAA,aAAA","file":"mathcoach-ide-tool-utils.js","sourceRoot":"../../src","sourcesContent":["import { MathCoach } from \"./MathCoach\"; \n \n/**\n * Hilfsfunktionen für Werkzeug-Entwickler. Diese werden nicht durch die `ide-lib.js` \n * ausgeliefert!\n */\nexport namespace Helpers {\n\n    /**\n     * Bildet die MathCoach API nach, sodass diese auch Offline (ohne IDE) \n     * verfügbar ist. (Siehe auch `createStorageBasedApi`).\n     * \n     * **Hinweis**: Wenn die echte MathCoach-API der IDE verfügbar ist, hat der Aufruf \n     * dieser Funktion keinen Seiteneffekt.\n     * \n     * Anwendungsbeispiel \n     * \n     *      import { Helpers } from \"@mathcoach/ide-api\";\n     *      Helpers.enableOfflineUsageIfNecessary();\n     *      MC.isReady() // use the api\n     * \n     * @param contextFileExtension Datei-Erweiterung der Kontext-Datei (Das Werkzeug soll \n     * jedoch unabhängig von der Endung arbeiten können)\n     * @returns Gibt `true` zurück, wenn die Offline-Funktionalität aktiviert \n     * wurde, andernfalls `false`\n     */\n    export function enableOfflineUsageIfNecessary(contextFileExtension: string = \"dummy.json\"): boolean {\n        if (typeof MC === \"undefined\") {\n            console.warn(\"you are offline - offline api is used\");\n            const WINDOW = (typeof window === \"undefined\") ? {} as any : window;\n            WINDOW.MC = createStorageBasedApi(contextFileExtension);\n            return true;\n        } else {\n            return false;\n        }\n    }\n\n    /**\n     * Implementierung der MathCoach API zu Testzwecken.\n     * \n     * Das Dateisystem wird durch einen Storage implementiert. Einige Features der \n     * IDE (beispielsweise der Navigator) sind nicht verfügbar und führen keine Aktionen \n     * durch. Alle Aktionen werden in der Browser-Console geloggt.\n     * \n     * Anwendungsbeispiel\n     * \n     *      import { Helpers } from \"@mathcoach/ide-api\";\n     *      const _MC = Helpers.createStorageBasedApi();\n     *      const contextFile = await _MC.ide.getContextFile() // use the api\n     * \n     * @param contextFileExtension Die Datei-Erweiterung der Kontext-Datei. Das Werkzeug sollte\n     *      unabhängig davon implementiert sein, da der Administrator der MathCoach IDE unter \n     *      Umständen auf eine Alternative ausweichen muss.\n     * @param storage Storage-Implementierung, die zum Speichern von Dateien verwendet werden \n     *      soll. Standardmäßig wird der `LocalStorage` des Browsers verwendet \n     *      bzw. falls nicht verfügbar der `InMemoryStorage`.\n     * \n     */\n    export function createStorageBasedApi(\n        contextFileExtension: string = \"dummy.json\",\n        storage: Storage = (typeof localStorage === \"undefined\") ? new InMemoryStorage() : localStorage\n    ): MathCoach.Api {\n        const fileIdentifier = (file: MathCoach.File) => `mock-file://${file.owner}@${file.part}/${file.path}`;\n        const traceMethod = (method: string, args?: any[]) => console.log([\"[MC MOCK API]\", \" \", method, \"(\", (args ? args : [\"\"]).join(\",\"), \")\"].join(\"\"));\n        const runtimeCheck = (errorMessage: string, isInvalid: (param: any) => boolean) => {\n            return (paramName: string, value: any, optional: boolean = false) => {\n                if (value === undefined) {\n                    if (optional) {\n                        return;\n                    } else {\n                        throw new Error(`missing parameter '${paramName}'`);\n                    }\n                }\n                if (isInvalid(value)) {\n                    throw new Error(`parameter '${paramName}' is invalid: ${errorMessage}`);\n                }\n            }\n        }\n        const runtimeCheckString = runtimeCheck(\"not a string\", v => typeof v !== \"string\");\n        const runtimeCheckBoolean = runtimeCheck(\"not a boolean\", v => typeof v !== \"boolean\");\n        const runtimeCheckFile = runtimeCheck(\"not a valid file\", v => !isFile(v));\n        const api: MathCoach.Api = {\n            ide: {\n                async getContextFile(): Promise<MathCoach.File> {\n                    traceMethod(\"MC.ide.getContextFile\");\n                    return {\n                        owner: \"jdoe\",\n                        path: `/file.${contextFileExtension}`,\n                        part: \"vfs\"\n                    }\n                },\n                async getUserName(): Promise<string> {\n                    traceMethod(\"MC.ide.getUserName\");\n                    return \"jdoe\"\n                },\n                fs: {\n                    async readFile(file: MathCoach.File) {\n                        traceMethod(\"MC.ide.fs.readFile\", [JSON.stringify(file)]);\n                        runtimeCheckFile(\"file\", file);\n                        return storage.getItem(fileIdentifier(file)) || \"\";\n                    },\n                    async writeFile(file: MathCoach.File, text: string) {\n                        traceMethod(\"MC.ide.fs.writeFile\", [JSON.stringify(file), JSON.stringify(`...${text.length} chars...`)]);\n                        runtimeCheckFile(\"file\", file);\n                        runtimeCheckString(\"text\", text);\n                        return storage.setItem(fileIdentifier(file), text);\n                    }\n                },\n                navigator: {\n                    async navigateTo(link: string, forceOpen?: boolean) {\n                        traceMethod(\"MC.ide.navigator.navigateTo\", [JSON.stringify(link), JSON.stringify(forceOpen ? true : false)]);\n                        runtimeCheckString(\"link\", link);\n                        runtimeCheckBoolean(\"forceOpen\", forceOpen, true);\n                    },\n                    async navigateToExercise(file: MathCoach.File, forceOpen?: boolean) {\n                        traceMethod(\"MC.ide.navigator.navigateToExercise\", [JSON.stringify(file), JSON.stringify(forceOpen ? true : false)]);\n                        runtimeCheckFile(\"file\", file);\n                        runtimeCheckBoolean(\"forceOpen\", forceOpen, true);\n                    }\n                }\n            },\n            async isReady() {\n                traceMethod(\"MC.isReady\");\n                return true;\n            }\n        };\n        return api;\n    }\n\n\n    /**\n     * Type Guard, der prüft, ob es sich um eine gültige `MathCoach.File`-Referenz handelt.\n     * \n     * @param maybeFile Ein beliebiges Objekt, das geprüft werden soll\n     */\n    export function isFile(maybeFile: any): maybeFile is MathCoach.File {\n        return (maybeFile ? true : false)\n            && (maybeFile.owner ? true : false) && (typeof maybeFile.owner === \"string\")\n            && (maybeFile.part ? true : false) && (typeof maybeFile.part === \"string\")\n            && (maybeFile.part === \"vfs\" || maybeFile.part === \"www\")\n            && (maybeFile.path ? true : false) && (typeof maybeFile.path === \"string\")\n            && (maybeFile.path.indexOf(\"/\") === 0)\n    }\n\n\n    /**\n     * Bildet die Kontext-Datei auf eine Aufgaben-Datei mit selben Namen ab.\n     * \n     * Ein Werkzeug speichert sein Datenmodell in der sogenannten Kontext-Datei. Soll \n     * eine MathCoach-Aufgabe generiert werden, ist es sinnvoll, wenn die Aufgaben-Datei\n     * den selben Namen wie die Kontext-Datei trägt (natürlich mit anderer Dateiendung).\n     * \n     * Beispielsweise wird eine Dateireferenz mit dem Pfad `\"/path/to/myExercise.mcq.json\"` \n     * auf eine Dateireferenz mit dem Pfad `\"/path/to/myExercise.groovy\"` abgebildet.\n     * \n     * Anwendungsbeispiel\n     * \n     *      import { Helpers } from \"@mathcoach/ide-api\";\n     *      const contextFile: MathCoach.File = await MC.ide.getContextFile();\n     *      const exerciseFile: MathCoach.File = Helpers.contextFileToExerciseFile(contextFile);\n     */\n    export function contextFileToExerciseFile(contextFile: MathCoach.File): MathCoach.File {\n        if (isFile(contextFile)) {\n            let exerciseFile: MathCoach.File = {\n                part: contextFile.part,\n                owner: contextFile.owner,\n                path: contextFile.path.split(\".\")[0] + \".groovy\"\n            };\n            return exerciseFile;\n        } else {\n            throw new Error(\"no valid file reference given, expected object like {owner:'demo', part:'vfs'|'www', path: '/...'}\")\n        }\n    }\n\n    /**\n     * Storage auf Basis einer Map. Kann z.B. bei Unit-Tests verwendet\n     * werden, beid denen der LocalStorage nicht verfügbar ist.\n     */\n    export class InMemoryStorage implements Storage {\n\n        private readonly items: Map<string, string> = new Map();\n\n        get length(): number {\n            return this.items.size;\n        }\n        clear(): void {\n            this.items.clear();\n        }\n        getItem(key: string): string | null {\n            const value = this.items.get(key);\n            return value ? value : null;\n        }\n        key(_index: number): string | null {\n            throw new Error(\"InMemoryStorage: key function is not implemented now\");\n        }\n        removeItem(key: string): void {\n            this.items.delete(key);\n        }\n        setItem(key: string, value: string): void {\n            this.items.set(key, value);\n        }\n\n    }\n\n}\n\n","export * from \"./MathCoach\"\nexport * from \"./Helpers\"\n"]}
dist/lib/standalone-usage.html
New file
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>MC IDE Example</title>
</head>
<body>
<script src="mathcoach-ide-tool-utils.js"></script>
<script>
    console.log(window.MC_IDE_TOOL_UTILS);
</script>
</body>
</html>