Hong-Phuc Bui
2023-05-18 c3e108a2ac3595a61ec69959787498befcdf8be8
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,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,SAAA,EAAA,GAAA,IAAA,IAAA,KAAA,EAAA,QAAA,eAAA,KAAA,QAAA,GAAA,EAAA,IAAA,OAAA,eAAA,QAAA,aAAA,CAAA,OAAA,IADA,EAAA,QAAA,gBACA,EAAA,QAAA","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"]}