@windward/core 0.2.1 → 0.2.3

package/lib/helpers/GlossaryTerm.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var GlossaryTerm = /** @class */ (function () {
+    function GlossaryTerm(params) {
+        this.alternate_forms = null;
+        this.related_term = null;
+        this.required = ['term', 'definition'];
+        this.required.forEach(function (field) {
+            if (!params[field]) {
+                throw new Error('Glossary term ' + field + ' is required');
+            }
+        });
+        this.term = params.term;
+        this.definition = params.definition;
+        this.alternate_forms = params.alternate_forms || null;
+        this.related_term = params.related_term || null;
+    }
+    GlossaryTerm.toString = function () {
+    };
+    return GlossaryTerm;
+}());
+exports.default = GlossaryTerm;

package/lib/helpers/MathHelper.d.ts

@@ -0,0 +1,99 @@
+import * as mathLiveObject from 'mathlive';
+export default class MathHelper {
+    /**
+     * expose mathlive object
+     */
+    static Mathlive: typeof mathLiveObject;
+    /**
+     * containsMathML
+     * @param content
+     * checks is string contains mathml
+     * @return boolean
+     *
+     */
+    static containsMathML(content: string): boolean;
+    /**
+     * containsLatex
+     * @param content
+     * checks is string contains latex
+     * @return boolean
+     *
+     */
+    static containsLatex(content: string): boolean;
+    /**
+     * containSREnhancedLatex
+     * @param content
+     * checks is string contains latex
+     * @return boolean
+     *
+     */
+    static containSREnhancedLatex(content: string): boolean;
+    /**
+     * convertMathMLToLatex
+     * @param content
+     * attempts to find mml in content string and replace it with latex equivalent
+     * @return string
+     */
+    static convertContentMathMLtoLatex(content: string): string;
+    /**
+     * wrapMathContentForTinyMCE
+     * @param content
+     * wrap content in span with math class for tinymce
+     * @return string
+     */
+    static wrapMathContentForTinyMCE(content: string): string;
+    /**
+     * check Math Content Wrapped For TMCE
+     * @param content
+     * checks all content
+     * @return string
+     */
+    static checkMathContentWrappedForTMCE(content: string): boolean;
+    /**
+     * convertContentLatexToHtml
+     * @param content
+     * attempts to find latex in content string and replace it with latex equivalent
+     * @return string
+     *
+     */
+    static convertContentLatexToHtml(content: string): string;
+    /**
+     * convertContentSREnhancedLatexToHtml
+     * @param content
+     * attempts to find latex in content string and place custom SR text on renderer math div
+     * @return string
+     *
+     */
+    static convertContentSREnhancedLatexToHtml(content: string): string;
+    /**
+     * convertMathContentToHtml
+     * @param content
+     * attempts to find any math format in content string and  convert it to HTML
+     * @return string
+     *
+     */
+    static convertMathContentToHtml(content: string): string;
+    /**
+     * convertMathMLToLatex
+     * @param content
+     * converts mml to latex
+     *
+     */
+    static convertMathMLToLatex(content: string): string;
+    /**
+     * parseSREnhancedLatexString
+     * @param content
+     * parse SR enhanced latex string and return Object
+     * @return Object
+     *
+     */
+    static parseSREnhancedLatexString(content: string): object;
+    /**
+     * parseSRLatex
+     * @param content
+     * parse latex expression from string
+     * @return any
+     *
+     */
+    static parseLatexString(content: string): string;
+}

package/lib/helpers/MathHelper.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var mathLiveObject = require("mathlive");
+var _ = require("lodash");
+var Mathml2latex = require('mathml-to-latex');
+var MathHelper = /** @class */ (function () {
+    function MathHelper() {
+    }
+    /**
+     * containsMathML
+     * @param content
+     * checks is string contains mathml
+     * @return boolean
+     *
+     */
+    MathHelper.containsMathML = function (content) {
+        var regex = /\<math.*?>.*?<\/math>/s;
+        return regex.exec(content) !== null;
+    };
+    /**
+     * containsLatex
+     * @param content
+     * checks is string contains latex
+     * @return boolean
+     *
+     */
+    MathHelper.containsLatex = function (content) {
+        var regex = /\$\$.*?\$\$/g;
+        return regex.exec(content) !== null;
+    };
+    /**
+     * containSREnhancedLatex
+     * @param content
+     * checks is string contains latex
+     * @return boolean
+     *
+     */
+    MathHelper.containSREnhancedLatex = function (content) {
+        var regex = /\*\*.*?\*\*/g;
+        return regex.exec(content) !== null;
+    };
+    /**
+     * convertMathMLToLatex
+     * @param content
+     * attempts to find mml in content string and replace it with latex equivalent
+     * @return string
+     */
+    MathHelper.convertContentMathMLtoLatex = function (content) {
+        var regex = /\<math.*?>.*?<\/math>/g;
+        var matches = content.match(regex);
+        if (matches) {
+            matches.forEach(function (match) {
+                content = content.replace(match, "$$$" + Mathml2latex.convert(match) + '$$$');
+            });
+        }
+        return content;
+    };
+    /**
+     * wrapMathContentForTinyMCE
+     * @param content
+     * wrap content in span with math class for tinymce
+     * @return string
+     */
+    MathHelper.wrapMathContentForTinyMCE = function (content) {
+        var regex = /(\*\*|\$\$)(.*?)\1/g;
+        var matches = content.match(regex);
+        if (matches) {
+            matches.forEach(function (match) {
+                var temp = match.replace(/\$\$/g, '');
+                if (match.match(/\$\$.*?\$\$/g) !== null) {
+                    content = content.replace(match, "<span class ='windward-math-content'>$$$" +
+                        temp +
+                        '$$$</span>');
+                }
+                if (match.match(/\*\*(.*?)\*\*/g) !== null) {
+                    content = content.replace(match, "<span class ='windward-math-content'>" +
+                        match +
+                        '</span>');
+                }
+            });
+        }
+        return content;
+    };
+    /**
+     * check Math Content Wrapped For TMCE
+     * @param content
+     * checks all content
+     * @return string
+     */
+    MathHelper.checkMathContentWrappedForTMCE = function (content) {
+        var regex = /\<span class ='windward-math-content'>(\*\*|\$\$)(.*?)\1<\/span>/g;
+        return regex.exec(content) !== null;
+    };
+    /**
+     * convertContentLatexToHtml
+     * @param content
+     * attempts to find latex in content string and replace it with latex equivalent
+     * @return string
+     *
+     */
+    MathHelper.convertContentLatexToHtml = function (content) {
+        var regex = /\$\$.*?\$\$/g;
+        var matches = content.match(regex);
+        if (matches) {
+            matches.forEach(function (match) {
+                content = content.replace(match, '<span tabindex="0"  aria-label="' +
+                    // @ts-ignore
+                    mathLiveObject.convertLatexToSpeakableText(match) +
+                    '"> <span tabindex="-1" >' +
+                    mathLiveObject.convertLatexToMarkup(_.unescape(match)) +
+                    '</span></span>');
+            });
+        }
+        return content;
+    };
+    /**
+     * convertContentSREnhancedLatexToHtml
+     * @param content
+     * attempts to find latex in content string and place custom SR text on renderer math div
+     * @return string
+     *
+     */
+    MathHelper.convertContentSREnhancedLatexToHtml = function (content) {
+        var regex = /\*\*.*?\*\*/g;
+        var matches = content.match(regex);
+        if (matches) {
+            matches.forEach(function (match) {
+                var mathObject = JSON.parse(match.replace(/\*\*/g, ''));
+                content = content.replace(match, '<span tabindex="0"  aria-label="' +
+                    mathObject.sr_text +
+                    '"> <span tabindex="-1" >' +
+                    mathLiveObject.convertLatexToMarkup('$$' + _.unescape(mathObject.latex) + '$$') +
+                    '</span></span>');
+            });
+        }
+        return content;
+    };
+    /**
+     * convertMathContentToHtml
+     * @param content
+     * attempts to find any math format in content string and  convert it to HTML
+     * @return string
+     *
+     */
+    MathHelper.convertMathContentToHtml = function (content) {
+        return MathHelper.convertContentSREnhancedLatexToHtml(MathHelper.convertContentLatexToHtml(MathHelper.convertContentMathMLtoLatex(content)));
+    };
+    /**
+     * convertMathMLToLatex
+     * @param content
+     * converts mml to latex
+     *
+     */
+    MathHelper.convertMathMLToLatex = function (content) {
+        return Mathml2latex.convert(content);
+    };
+    /**
+     * parseSREnhancedLatexString
+     * @param content
+     * parse SR enhanced latex string and return Object
+     * @return Object
+     *
+     */
+    MathHelper.parseSREnhancedLatexString = function (content) {
+        var regex = /\*\*.*?\*\*/g;
+        var matches = content.match(regex);
+        if (matches) {
+            var mathobject = JSON.parse(matches[0].replace(/\*\*/g, ''));
+            return mathobject;
+        }
+        return {};
+    };
+    /**
+     * parseSRLatex
+     * @param content
+     * parse latex expression from string
+     * @return any
+     *
+     */
+    MathHelper.parseLatexString = function (content) {
+        var regex = /\$\$.*?\$\$/g;
+        var matches = content.match(regex);
+        if (matches) {
+            return matches[0].replace(/\$\$/g, '');
+        }
+        return '';
+    };
+    /**
+     * expose mathlive object
+     */
+    MathHelper.Mathlive = mathLiveObject;
+    return MathHelper;
+}());
+exports.default = MathHelper;

package/lib/helpers/tinymce/plugin.d.ts

@@ -0,0 +1,2 @@
+declare const MathEditorPlugin: (editor: any) => void;
+export { MathEditorPlugin };

package/lib/helpers/tinymce/plugin.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MathEditorPlugin = void 0;
+var MathEditorPlugin = function (editor) {
+    var formula;
+    // ----- Events ----- //
+    editor.ui.registry.addIcon('insertMath', '<svg  x="0px" y="0px"width="20px" height="20px" viewBox="0 0 445.878 445.878" style="enable-background:new 0 0 445.878 445.878;">' +
+        '<path d="M426.024,86.447H209.705l-84.911,298.911c-2.568,7.967-9.854,13.482-18.22,13.771c-0.236,0-0.464,0.006-0.688,0.006 c-8.092,0-15.41-4.924-18.436-12.478l-34.714-86.782H19.851C8.884,299.876,0,290.986,0,280.022 c0-10.965,8.893-19.854,19.851-19.854H66.18c8.109,0,15.421,4.941,18.436,12.483l19.237,48.09l72.472-260.218 c2.639-8.213,10.279-13.781,18.903-13.781h230.798c10.97,0,19.854,8.89,19.854,19.851S436.988,86.447,426.024,86.447z M436.723,353.227l-78.259-87.904l74.576-82.783c1.318-1.454,1.638-3.547,0.857-5.341c-0.804-1.791-2.577-2.946-4.54-2.946h-47.18 c-1.442,0-2.802,0.629-3.759,1.72l-50.059,58.047l-49.674-58.029c-0.939-1.103-2.317-1.738-3.771-1.738h-49.334 c-1.956,0-3.729,1.149-4.521,2.929c-0.81,1.785 0.479,3.875,0.824,5.332l73.743,82.81l-77.641,87.923 c-1.297,1.465-1.605,3.552 0.813,5.325c0.813,1.785,2.586,2.92,4.528,2.92h48.9c1.472,0,2.867-0.65,3.807-1.785l51.819-62.181 l53.05,62.229c0.951,1.11,2.328,1.743,3.782,1.743h49.97c1.962,0,3.735-1.141,4.527-2.926 C438.354,356.779,438.035,354.692,436.723,353.227z"/>' +
+        '</svg>');
+    editor.addCommand('equation-window', function (data) {
+        return editor.windowManager.openUrl({
+            url: '/plugins/tinymce/math',
+            title: 'Equation editor',
+            width: 800,
+            height: 600,
+            buttons: [
+                {
+                    type: 'cancel',
+                    text: 'cancel',
+                },
+                {
+                    type: 'custom',
+                    text: 'submit',
+                    primary: true,
+                },
+            ],
+            onAction: function () {
+                if (data.currentTarget) {
+                    editor.selection.select(data.currentTarget);
+                }
+                editor.selection.setContent("        <span class='windward-math-content'>" +
+                    formula +
+                    "</span>");
+                editor.windowManager.close();
+                setOnClickEquationContent(editor);
+            },
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            onMessage: function (instance, message) {
+                switch (message.mceAction) {
+                    case 'equation-insert':
+                        formula = message.content;
+                        break;
+                    case 'math-plugin-mounted':
+                        window.parent.postMessage({ latex: data.latex }, '*');
+                        break;
+                }
+            },
+        });
+    });
+    editor.ui.registry.addButton('mathButton', {
+        icon: 'insertMath',
+        onAction: function () {
+            editor.execCommand('equation-window', true);
+        },
+    });
+    editor.ui.registry.addMenuItem('math', {
+        text: 'Math',
+        icon: 'insertMath',
+        onAction: function () {
+            editor.execCommand('equation-window', true);
+        },
+    });
+    editor.on('init', function () {
+        setOnClickEquationContent(editor);
+    });
+    function setOnClickEquationContent(editor) {
+        var tinymceDoc = editor.getDoc();
+        var mqSpan = tinymceDoc.getElementsByClassName('windward-math-content');
+        // Add onclick listener to all equation content
+        for (var _i = 0, mqSpan_1 = mqSpan; _i < mqSpan_1.length; _i++) {
+            var equationContent = mqSpan_1[_i];
+            equationContent.contentEditable = 'true';
+            if (equationContent.onclick) {
+                continue;
+            }
+            equationContent.onclick = function (event) {
+                event.stopPropagation();
+                editor.execCommand('equation-window', {
+                    latex: event.target.innerText,
+                    currentTarget: event.target,
+                });
+            };
+        }
+    }
+};
+exports.MathEditorPlugin = MathEditorPlugin;

package/lib/i18n/en-US/components/content/blocks/image.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    title: string;
+    description: string;
+    no_image_url: string;
+};
+export default _default;

package/lib/i18n/en-US/components/content/blocks/image.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    title: 'Pick an image',
+    description: 'Pick an image to display',
+    no_image_url: 'No Image Selected',
+};

package/lib/i18n/en-US/components/content/blocks/index.d.ts

@@ -0,0 +1,75 @@
+declare const _default: {
+    user_upload: {
+        user_uploads: string;
+        dialog_view: string;
+        instructions: string;
+        instructions_none: string;
+        instructions_title: string;
+        must_save: string;
+        uploaded: string;
+        name: string;
+        size: string;
+        download: string;
+    };
+    image: {
+        title: string;
+        description: string;
+        no_image_url: string;
+    };
+    video: {
+        tabs: {
+            video: string;
+            poster: string;
+            preroll: string;
+            postroll: string;
+        };
+        forms: {
+            unsaved: string;
+            cancel: string;
+            confirm: string;
+        };
+        video: {
+            title: string;
+            configure_blurb: string;
+            not_configured_title: string;
+            edit_prompt: string;
+            autoplay: string;
+            controls: string;
+            loop: string;
+            muted: string;
+            disablepictureinpicture: string;
+            poster: string;
+            playback_rates: string;
+            rewind: string;
+            playsinline: string;
+            captionsmenu: string;
+            playlistmenu: string;
+            playlistautoadvance: string;
+        };
+        caption: {
+            title: string;
+            configure_blurb: string;
+        };
+        poster: {
+            title: string;
+            configure_blurb: string;
+        };
+        preroll: {
+            title: string;
+            configure_blurb: string;
+        };
+        postroll: {
+            title: string;
+            configure_blurb: string;
+        };
+    };
+    table: {
+        column: string;
+        row: string;
+    };
+    tab: {
+        add_tab: string;
+        delete_tab: string;
+    };
+};
+export default _default;

package/lib/i18n/en-US/components/content/blocks/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var user_upload_1 = require("./user_upload");
+var image_1 = require("./image");
+var video_1 = require("./video");
+var table_1 = require("./table");
+var tab_1 = require("./tab");
+exports.default = {
+    user_upload: user_upload_1.default,
+    image: image_1.default,
+    video: video_1.default,
+    table: table_1.default,
+    tab: tab_1.default,
+};

package/lib/i18n/en-US/components/content/blocks/tab.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    add_tab: string;
+    delete_tab: string;
+};
+export default _default;

package/lib/i18n/en-US/components/content/blocks/tab.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    add_tab: 'Add Tab',
+    delete_tab: 'Delete Tab'
+};

package/lib/i18n/en-US/components/content/blocks/table.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    column: string;
+    row: string;
+};
+export default _default;

package/lib/i18n/en-US/components/content/blocks/table.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    column: 'column',
+    row: 'cell',
+};

package/lib/i18n/en-US/components/content/blocks/user_upload.d.ts

@@ -0,0 +1,13 @@
+declare const _default: {
+    user_uploads: string;
+    dialog_view: string;
+    instructions: string;
+    instructions_none: string;
+    instructions_title: string;
+    must_save: string;
+    uploaded: string;
+    name: string;
+    size: string;
+    download: string;
+};
+export default _default;

package/lib/i18n/en-US/components/content/blocks/user_upload.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    user_uploads: 'User Uploads',
+    dialog_view: 'View Uploads',
+    instructions: 'Instructions:',
+    instructions_none: 'None',
+    instructions_title: 'Student instructions:',
+    must_save: 'You must save this block before users can make uploads',
+    uploaded: 'Uploaded',
+    name: 'Name',
+    size: 'Size',
+    download: 'Download',
+};

package/lib/i18n/en-US/components/content/blocks/video.d.ts

@@ -0,0 +1,48 @@
+declare const _default: {
+    tabs: {
+        video: string;
+        poster: string;
+        preroll: string;
+        postroll: string;
+    };
+    forms: {
+        unsaved: string;
+        cancel: string;
+        confirm: string;
+    };
+    video: {
+        title: string;
+        configure_blurb: string;
+        not_configured_title: string;
+        edit_prompt: string;
+        autoplay: string;
+        controls: string;
+        loop: string;
+        muted: string;
+        disablepictureinpicture: string;
+        poster: string;
+        playback_rates: string;
+        rewind: string;
+        playsinline: string;
+        captionsmenu: string;
+        playlistmenu: string;
+        playlistautoadvance: string;
+    };
+    caption: {
+        title: string;
+        configure_blurb: string;
+    };
+    poster: {
+        title: string;
+        configure_blurb: string;
+    };
+    preroll: {
+        title: string;
+        configure_blurb: string;
+    };
+    postroll: {
+        title: string;
+        configure_blurb: string;
+    };
+};
+export default _default;

package/lib/i18n/en-US/components/content/blocks/video.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    tabs: {
+        video: 'Video',
+        poster: 'Poster',
+        preroll: 'Preroll',
+        postroll: 'Postroll',
+    },
+    forms: {
+        unsaved: 'You have unsaved changes. Would you like to save them?',
+        cancel: 'Cancel',
+        confirm: 'Confirm',
+    },
+    video: {
+        title: 'Video File',
+        configure_blurb: 'Upload a video file (.mp4 or .webm), pick one from the file manager, or add via the public URL',
+        not_configured_title: 'Video not configured',
+        edit_prompt: 'Edit this block to get started',
+        autoplay: 'Autoplay on load',
+        controls: 'Show Controls',
+        loop: 'Loop video',
+        muted: 'Start muted',
+        disablepictureinpicture: 'Disable picture-in-picture button',
+        poster: 'Video poster',
+        playback_rates: 'Playback Rates',
+        rewind: 'Allow 10 Second Rewind',
+        playsinline: 'Disable fullscreen and force inline viewing',
+        captionsmenu: 'Show the interactive captions menu',
+        playlistmenu: 'Show playlist menu (Requires more than 1 video selected to show)',
+        playlistautoadvance: 'Auto-advance the playlist on media end',
+    },
+    caption: {
+        title: 'Captions File',
+        configure_blurb: 'Upload a captions file (.vtt or .xml), pick one from the file manager, or add via the public URL',
+    },
+    poster: {
+        title: 'Poster Image File',
+        configure_blurb: 'Upload a poster file (.png or .jpg), pick one from the file manager, or add via the public URL. This is the image that appears before the video is played.',
+    },
+    preroll: {
+        title: 'Preroll Video File',
+        configure_blurb: 'Upload a preroll video file (.mp4 or .webm), pick one from the file manager, or add via the public URL',
+    },
+    postroll: {
+        title: 'Postroll Video File',
+        configure_blurb: 'Upload a postroll video file (.mp4 or .webm), pick one from the file manager, or add via the public URL',
+    },
+};