restructure, move to TS

This commit is contained in:
2024-01-08 20:37:18 +01:00
parent 125ab80766
commit 90653fa34e
9 changed files with 344 additions and 88 deletions

75
src/build.js Normal file
View File

@@ -0,0 +1,75 @@
const fs = require('fs');
var ls = require('ls');
var path = require('path');
var Terser = require("terser");
var files = ['src/impress.js'];
// Libraries from src/lib
files.push('src/lib/gc.js', 'src/lib/util.js', 'src/lib/rotation.js')
// Plugins from src/plugins
files.push('src/plugins/autoplay/autoplay.js',
'src/plugins/blackout/blackout.js',
'src/plugins/extras/extras.js',
'src/plugins/form/form.js',
'src/plugins/fullscreen/fullscreen.js',
'src/plugins/goto/goto.js',
'src/plugins/bookmark/bookmark.js',
'src/plugins/help/help.js',
'src/plugins/impressConsole/impressConsole.js',
'src/plugins/media/media.js',
'src/plugins/mobile/mobile.js',
'src/plugins/mouse-timeout/mouse-timeout.js',
'src/plugins/navigation/navigation.js',
'src/plugins/navigation-ui/navigation-ui.js',
'src/plugins/progress/progress.js',
'src/plugins/rel/rel.js',
'src/plugins/resize/resize.js',
'src/plugins/skip/skip.js',
'src/plugins/stop/stop.js',
'src/plugins/substep/substep.js',
'src/plugins/touch/touch.js',
'src/plugins/toolbar/toolbar.js')
var output = files.map((f)=>{
return fs.readFileSync(f).toString();
}).join('\n')
var filename = 'js/impress.js';
fs.writeFileSync(filename, '// This file was automatically generated from files in src/ directory.\n\n' + output)
console.log(filename);
// terser --compress --mangle --comments '/^!/' --source-map --output js/impress.min.js js/impress.js
var code = fs.readFileSync('js/impress.js').toString();
var options = {
sourceMap: {
filename: 'js/impress.js',
url: 'js/impress.min.js.map'
},
output: {
comments: /^!/
}
};
var result = Terser.minify({'js/impress.js': code}, options);
filename = 'js/impress.min.js';
fs.writeFileSync(filename, result.code);
console.log(filename);
filename = 'js/impress.min.js.map';
fs.writeFileSync(filename, result.map);
console.log(filename);
/* Auto generate an index.html that lists all the directories under examples/
* This is useful for gh-pages, so you can link to http://impress.github.io/impress.js/examples
*/
var html_list = '<ul><br />\n'
ls( 'examples/*', { type: 'dir' }).forEach(function(dir) {
html_list += ' <li><a href="' + dir['file'] + '/">' + dir['name'] + '</a></li>\n';
});
html_list += '</ul>\n'
var html = '<html>\n<head>\n<title>Example presentations</title>\n</head>\n<body>'
html += '<h1>Example presentations</h1>\n' + html_list
html += '</body>\n</html>'
filename = path.resolve(__dirname, 'examples', 'index.html');
fs.writeFileSync(filename, html);
console.log(filename);

View File

@@ -33,7 +33,7 @@ window.impress = () => {
// this function is used to initialize impress. It calls various private functions that initialize
// various components
var init = () => {
var init: Function = () => {
console.log( 'init' );
};
@@ -48,22 +48,42 @@ window.impress = () => {
* Returns true if successful at positioning this element, false, if failed
* @param {string} DOMElementID
* @param {object} coordinates
* @param {number} coordinates.x The translation in direction of x-axis
* @param {number} coordinates.y The translation in direction of y-axis
* @param {number} coordinates.z The translation in direction of z-axis
* @param {object} rotation
* @param {number} rotation.x The rotation in degrees around the x-axis
* @param {number} rotation.y The rotation in degrees around the y-axis
* @param {number} rotation.z The rotation in degrees around the z-axis
* @return {boolean}
*/
var addElement = ( DOMElementID, coordinates, rotation ) => {
var addElement: Function = ( DOMElementID, coordinates, rotation ) => {
console.log( 'element added' );
return true;
};
/**
* Description
* @param {any} DOMElementID
* @return {any}
* This function allows you to remove an element from the virtual canvas. Essentially,
* impress.js just hides this element and ignores it in translations & rotations
* @param {string} DOMElementID The element that is removed. Has to be the element ID of a DOM element
* @return {boolean}
*/
var removeElement = ( DOMElementID ) => {
var removeElement = ( DOMElementID: string ): boolean => {
return true;
};
/**
* Description
* @param {object} coordinates
* @param {object} rotation
* @returns {promise}
*/
var moveTo = ( coordinates: object, rotation: object ): Promise<any> => {
return new Promise( ( resolve, reject ) => {
} );
}
return {
init
};