@webqit/oohtml 2.1.6 → 2.1.9

package/src/scoped-js/index.js

@@ -5,6 +5,7 @@
 import { resolveParams } from '@webqit/subscript/src/params.js';
 import SubscriptFunction from '@webqit/subscript/src/SubscriptFunctionLite.js';
 import Observer from '@webqit/observer';
+import Compiler from './Compiler.js';
 import wqDom from '@webqit/dom';
 
 /**
@@ -41,50 +42,6 @@ export {
     Observer,
 }
 
-/**
- * Performs realtime capture of elements and builds their relationships.
- *
- * @param Object params
- *
- * @return Void
- */
-function realtime( params ) {
-	const window = this, { dom } = window.wq;
-    const handled = () => {};
-	dom.realtime( window.document ).observe( params.scriptSelector, record => {
-        record.entrants.forEach( script => {
-            if ( 'contract' in script ) return handled( script );
-            Object.defineProperty( script, 'contract', { value: script.hasAttribute( 'contract' ) } ); 
-            if ( 'scoped' in script ) return handled( script );
-            Object.defineProperty( script, 'scoped', { value: script.hasAttribute( 'scoped' ) } ); 
-            // ---
-            const thisContext = script.scoped ? record.target : ( script.type === 'module' ? undefined : window );
-            compile.call( this, script, thisContext, params );
-        } );
-	}, { subtree: true, timing: 'intercept', generation: 'entrants' } );
-    // ---
-    window.wq.oohtml.Script.run = ( execHash ) => {
-        const exec = fromHash( execHash );
-        if ( !exec ) throw new Error( `Argument must be a valid exec hash.` );
-        const { script, compiledScript, thisContext } = exec;
-        if ( thisContext instanceof window.Element && script.scoped ) {
-            if ( !thisContext.scripts ) { Object.defineProperty( thisContext, 'scripts', { value: new Set } ); }
-            thisContext.scripts.add( script );
-        }
-        switch ( params.script.retention ) {
-            case 'dispose':
-                script.remove();
-                break;
-            case 'hidden':
-                script.textContent = `"source hidden"`;
-                break;
-            default:
-                script.textContent = compiledScript.function.originalSource;
-        }
-        return execute.call( this, compiledScript, thisContext, script );
-    };
-}
-
 // ------------------
 // Script runner
 export function execute( compiledScript, thisContext, script ) {
@@ -122,274 +79,28 @@ export function execute( compiledScript, thisContext, script ) {
     return script;
 }
 
-// ------------------
-// JAVASCRIPT::[SCOPED|CONTRACT]
-export function compile( script, thisContext, params = {} ) {
-    const { wq: { oohtml, SubscriptFunction } } = this;
-    const cache = oohtml.Script.compileCache[ script.contract ? 0 : 1 ];
-    const sourceHash = toHash( script.textContent );
-    // Script instances are parsed only once
-    let source = script.textContent, compiledScript;
-    if ( !( compiledScript = cache.get( sourceHash ) ) ) {
-        // Are there "import" (and "await") statements? Then, we need to rewrite that
-        let imports = [], meta = {};
-        let targetKeywords = [];
-        if ( script.type === 'module' ) targetKeywords.push( 'import ' );
-        if ( script.type === 'module' && !script.contract ) targetKeywords.push( 'await ' );
-        if ( targetKeywords.length && ( new RegExp( targetKeywords.join( '|' ) ) ).test( source ) ) {
-            [ imports, source, meta ] = parse( source );
-            if ( imports.length ) {
-                source = `\n\t${ rewriteImportStmts( imports ).join( `\n\t` ) }\n\t${ source }\n`;
-            }
-        }
-        // Let's obtain a material functions
-        let _Function, { parserParams, compilerParams, runtimeParams } = params.config;
-        if ( script.contract ) {
-            parserParams = { ...parserParams, allowAwaitOutsideFunction: script.type === 'module' };
-            runtimeParams = { ...runtimeParams, async: script.type === 'module' };
-            _Function = SubscriptFunction( source, { compilerParams, parserParams, runtimeParams, } );
-            Object.defineProperty( script, 'properties', { configurable: true, value: SubscriptFunction.inspect( _Function, 'properties' ) } );
-        } else {
-            const isAsync = script.type === 'module'//meta.topLevelAwait || imports.length;
-            const _FunctionConstructor = isAsync ? Object.getPrototypeOf( async function() {} ).constructor : Function;
-            _Function = runtimeParams?.compileFunction 
-                ? runtimeParams.compileFunction( source )
-                : new _FunctionConstructor( source );
-            Object.defineProperty( _Function, 'originalSource', { configurable: true, value: script.textContent } );
-        }
-        // Save material function to compile cache
-        compiledScript = Object.defineProperty( script.cloneNode(), 'function', { value: _Function } );
-        script.scoped && Object.defineProperty( compiledScript, 'scoped', Object.getOwnPropertyDescriptor( script, 'scoped') );
-        script.contract && Object.defineProperty( compiledScript, 'contract', Object.getOwnPropertyDescriptor( script, 'contract') );
-        cache.set( sourceHash, compiledScript );
-    }
-    const execHash = toHash( { script, compiledScript, thisContext } );
-    script.textContent = `wq.oohtml.Script.run('${ execHash }');`;
-}
-
-// ------------------
-// Match import statements
-// and detect top-level await
-export function parse( source ) {
-    const [ tokens, meta ] = tokenize( source, ( $tokens, event, char, meta, i, isLastChar ) => {
-        
-        if ( event === 'start-enclosure' && char === '{' && !meta.openAsync?.type && meta.openEnclosures.length === meta.openAsync?.scopeId ) {
-            meta.openAsync.type = 'block';
-        } else if ( event === 'end-enclosure' && char === '}' && meta.openAsync?.type === 'block' && meta.openEnclosures.length === meta.openAsync.scopeId ) {
-            meta.openAsync = null;
-        } else if ( event === 'start-quote' && !meta.openEnclosures.length && [ 'starting', 'from' ].includes( meta.openImport ) ) {
-            meta.openImport = 'url';
-        } else if ( event === 'end-quote' && meta.openImport === 'url' ) {
-            meta.openImport = 'closing';
-        } else if ( event === 'char' ) {
-
-            if ( meta.openImport === 'closing' && (
-                char === ';'/* explicit */ || ![ ' ', `\n` ].includes( char )/* implicit */ || isLastChar
-            ) ) {
-                if ( char === ';' || isLastChar ) {
-                    $tokens[ 0 ] += char;
-                    $tokens.unshift( '' );
-                } else { $tokens.unshift( char ); }
-                meta.openImport = null;
-                return false;
-            }
-
-            let remainder = source.substring( i - 1 );
-
-            if ( !meta.openImport && /^[\W]?import[ ]*[^\(]/.test( remainder ) ) {
-                meta.openImport = 'starting';
-                $tokens.unshift( '' );
-                return 6;
-            }
-            if ( meta.openImport === 'starting' && /^[\W]?from /.test( remainder ) ) {
-                meta.openImport = 'from';
-                return 4;
-            }
-            if ( !meta.openAsync ) {
-                if ( /^[\W]?async /.test( remainder ) ) {
-                    meta.openAsync = { scopeId: meta.openEnclosures.length };
-                    return 5;
-                }
-                if ( /^[\W]?await /.test( remainder ) ) {
-                    meta.topLevelAwait = true;
-                    return 5;
-                }
-            }
-            if ( meta.openAsync ) {
-                if ( !meta.openAsync.type && /.?\=\>[ ]*?\{/.test( remainder ) ) {
-                    meta.openAsync.type = 'inline-arrow';
-                } else if ( meta.openAsync.type === 'inline-arrow' && [ `\n`, ';' ].includes( char ) && meta.openEnclosures.length === meta.openAsync.scopeId ) {
-                    meta.openAsync = null;
-                }
-            }
-
-        }
-
-    } );
-    // Hoist all import statements
-    let imports = [], body = '', _str;
-    for ( const str of tokens.reverse() ) {
-        if ( ( _str = str.trim() ).startsWith( 'import ' ) ) {
-            imports.push( str );
-        } else if ( _str ) { body += str; }
-    }
-
-    return [ imports, body, meta ];
-}
-
-// ------------------
-// Rewrite import statements
-export function rewriteImportStmts( imports ) {
-    const importSpecs = [], importPromises = [];
-    imports.forEach( ( $import, i ) => {
-        $import = parseImportStmt( $import );
-        // Identify whole imports and individual imports
-        const [ wholeImport, individualImports ] = $import.items.reduce( ( [ whole, parts ], item ) => {
-            return item.id === '*' ? [ item.alias, parts ] : [ whole, parts.concat( item ) ];
-        }, [ null, [] ] );
-        if ( wholeImport ) {
-            // const main = await import("url");
-            importSpecs.push( `const ${ wholeImport } = __$imports$__[${ i }];` );
-        }
-        if ( individualImports.length ) {
-            // const { aa: bb, cc } = await import("url");
-            const individualImportsSpec = individualImports.map( item => `${ item.id }${ item.id !== item.alias ? `: ${ item.alias }` : '' }` ).join( ', ' );
-            importSpecs.push( `const { ${ individualImportsSpec } } = __$imports$__[${ i }];` );
-        }
-        importPromises.push( `import("${ $import.url }")` );
-    } );
-    return [
-        `\n\tconst __$imports$__ = await Promise.all([\n\t\t${ importPromises.join( `,\n\t\t` ) }\n\t]);`,
-        importSpecs.join( `\n\t` ),
-    ];
-}
-
-// ------------------
-// Parse import statements
-export function parseImportStmt( str ) {
-    const getUrl = str => {
-        let quo = /^[`'"]/.exec( str );
-        return quo && str.substring( 1, str.lastIndexOf( quo[ 0 ] ) );
-    }
-    let $import = { items: [ { id: '' } ] }, _str = str.replace( 'import', '' ).trim();
-    if ( !( $import.url = getUrl( _str ) ) ) {
-        tokenize( _str, ( $tokens, event, char, meta, i, isLastChar ) => {
-            if ( [ 'start-quote', 'ongoing-quote', 'end-quote', 'char' ].includes( event ) ) {
-                if ( $import.url ) return;
-                if ( !meta.openQuote ) {
-                    let remainder = _str.substring( i );
-                    if ( char === ',' ) {
-                        $import.items.unshift( { id: '' } );
-                        return;
-                    }
-                    if ( remainder.startsWith( ' as ' ) ) {
-                        $import.items[ 0 ].alias = '';
-                        return 3;
-                    }
-                    if ( remainder.startsWith( ' from ' ) ) {
-                        $import.url = getUrl( remainder.replace( 'from', '' ).trim() );
-                        return remainder.length;
-                    }
-                }
-                if ( 'alias' in $import.items[ 0 ] ) {
-                    $import.items[ 0 ].alias += char;
-                } else {
-                    $import.items[ 0 ].id += char;
-                    if ( meta.openEnclosures.length ) {
-                        $import.items[ 0 ].enclosed = true;
-                    }
-                }
-            }
+/**
+ * Performs realtime capture of elements and builds their relationships.
+ *
+ * @param Object params
+ *
+ * @return Void
+ */
+function realtime( params ) {
+	const window = this, { dom } = window.wq;
+    const compiler = new Compiler( window, params, execute ), handled = () => {};
+	dom.realtime( window.document ).observe( params.scriptSelector, record => {
+        record.entrants.forEach( script => {
+            if ( 'contract' in script ) return handled( script );
+            Object.defineProperty( script, 'contract', { value: script.hasAttribute( 'contract' ) } ); 
+            if ( 'scoped' in script ) return handled( script );
+            Object.defineProperty( script, 'scoped', { value: script.hasAttribute( 'scoped' ) } ); 
+            // ---
+            const thisContext = script.scoped ? record.target : ( script.type === 'module' ? undefined : window );
+            compiler.compile( script, thisContext );
         } );
-    }
-    $import.items = $import.items
-        .map( item => ( {
-            id: item.id && !item.alias && !item.enclosed ? 'default' : item.id.trim(),
-            alias: item.alias ? item.alias.trim() : item.id.trim(),
-        } ) )
-        .filter( item => item.id )
-        .reverse();
-    return $import;
-}
-
-// ------------------
-// Token JavaScript source
-export function tokenize( source, _callback ) {
-    const lastI = source.length - 1;
-    return [ ...source ].reduce( ( [ $tokens, meta, skip ], char, i ) => {
-        
-        if ( skip ) {
-            $tokens[ 0 ] += char;
-            return [ $tokens, meta, --skip ];
-        }
-        let callbackReturn;
-
-        if ( meta.openQuote || meta.openComment ) {
-            if ( char === meta.openQuote ) {
-                meta.openQuote = null;
-                callbackReturn = _callback( $tokens, 'end-quote', char, meta, i, i === lastI );
-            } else if ( meta.openQuote ) {
-                callbackReturn = _callback( $tokens, 'ongoing-quote', char, meta, i, i === lastI );
-            } else if ( meta.openComment ) {
-                if ( ( meta.openComment === '//' && char === `\n` ) || ( meta.openComment === '/*' && $tokens[ 0 ].substr( -1 ) === '*' && char === '/' ) ) {
-                    meta.openComment = null;
-                    callbackReturn = _callback( $tokens, 'end-comment', char, meta, i, i === lastI );
-                }
-            }
-            if ( callbackReturn !== false ) {
-                $tokens[ 0 ] += char;
-            }
-            return [ $tokens, meta, typeof callbackReturn === 'number' ? callbackReturn : skip ];
-        }
-
-        let enclosure;
-        if ( enclosure = [ '()', '{}', '[]' ].filter( pair => char === pair[ 0 ] )[ 0 ] ) {
-            callbackReturn = _callback( $tokens, 'start-enclosure', char, meta, i, i === lastI );
-            meta.openEnclosures.unshift( enclosure );
-        } else if ( meta.openEnclosures.length && char === meta.openEnclosures[ 0 ][ 1 ] ) {
-            meta.openEnclosures.shift();
-            callbackReturn = _callback( $tokens, 'end-enclosure', char, meta, i, i === lastI );
-        } else if ( [ '"', "'", "`" ].includes( char ) ) {
-            callbackReturn = _callback( $tokens, 'start-quote', char, meta, i, i === lastI );
-            meta.openQuote = char;
-        } else if ( !meta.openComment && [ '/*', '//' ].includes( source.substr( i, 2 ) ) ) {
-            callbackReturn = _callback( $tokens, 'start-comment', char, meta, i, i === lastI );
-            meta.openComment = source.substr( i, 2 );
-        } else {
-            callbackReturn = _callback( $tokens, 'char', char, meta, i, i === lastI );
-        }
-
-        if ( callbackReturn !== false ) {
-            $tokens[ 0 ] += char;
-        }
-        return [ $tokens, meta, typeof callbackReturn === 'number' ? callbackReturn : skip ];
-
-    }, [ [ '' ], { openEnclosures: [], }, 0 ] );
+	}, { subtree: true, timing: 'intercept', generation: 'entrants' } );
+    // ---
 }
 
-// ------------------
-// Unique ID generator
-const hashTable = new Map;
-const uniqId = () => (0|Math.random()*9e6).toString(36);
 const _await = ( value, callback ) => value instanceof Promise ? value.then( callback ) : callback( value );
-
-// ------------------
-// Hash of anything generator
-export function toHash( val ) {
-    let hash;
-    if ( !( hash = hashTable.get( val ) ) ) {
-        hash = uniqId();
-        hashTable.set( val, hash );
-    }
-    return hash;
-}
-
-// ------------------
-// Value of any hash
-export function fromHash( hash ) {
-    let val;
-    hashTable.forEach( ( _hash, _val ) => {
-        if ( _hash === hash ) val = _val;
-    } );
-    return val;
-}

package/test/bindings-api.test.js

@@ -0,0 +1,42 @@
+
+/**
+ * @imports
+ */
+import { expect } from 'chai';
+import { createDocument } from './index.js';
+import Observer from '@webqit/observer';
+
+describe(`Bindings API`, function() {
+
+    describe( `Basic...`, function() {
+        
+        const head = ``;
+        const body = ``;
+        const { document } = createDocument( head, body );
+
+        it ( `The document object and elements should expose a "bindings" property each...`, async function() {
+            expect( document ).to.have.property( 'bindings' );
+            expect( document.body ).to.have.property( 'bindings' );
+        } );
+
+        it ( `Bindings objects should be observable...`, async function() {
+            let idReceived = null;
+            Observer.observe( document.bindings, records => {
+                idReceived = records[ 0 ].key;
+            } );
+            document.bindings.someKey = 'someValue'; // new
+            expect( idReceived ).to.eq( 'someKey' );
+            // -------------
+            let changes = [];
+            Observer.observe( document.bindings, records => {
+                changes.push( ...records );
+            } );
+            document.bindings.someKey2 = 'someValue2'; // new
+            document.bind( { someKey: 'someValue'/* update */, someKey3: 'someValue3'/* new */ } );
+            expect( changes ).to.an( 'array' ).with.length( 4 ); // (1) sets: someKey2, (2) deletes: someKey2, (3) updates: someKey, (4) sets: someKey3;
+        } );
+
+    } );
+
+} );
+

package/src/state-api/index.js

@@ -1,59 +0,0 @@
-
-/**
- * @imports
- */
-import wqDom from '@webqit/dom';
-import Observer from '@webqit/observer';
-import { _ } from '../util.js';
-
-/**
- * @init
- * 
- * @param Object $params
- */
-export default function init( $params = {} ) {
-	const window = this, dom = wqDom.call( window );
-    if ( !window.wq ) { window.wq = {}; }
-    window.wq.Observer = Observer;
-    const params = dom.meta( 'oohtml' ).copyWithDefaults( $params, {
-        api: { state: 'state', },
-    } );
-    exposeAPIs.call( this, params );
-}
-
-export { Observer }
-
-/**
- * @Exports
- * 
- * The internal state object
- * within elements and the document object.
- */
-function getStateObject( node ) {
-	if ( !_( node ).has( 'state' ) ) {
-		const stateObj = Object.create( null );
-		_( node ).set( 'state', stateObj );
-	}
-	return _( node ).get( 'state' );
-}
-
-/**
- * Exposes State with native APIs.
- *
- * @param Object params
- *
- * @return Void
- */
-function exposeAPIs( params ) {
-	const window = this;
-    // Assertions
-    if ( params.api.state in window.document ) { throw new Error( `document already has a "${ params.api.state }" property!` ); }
-    if ( params.api.state in window.Element.prototype ) { throw new Error( `The "Element" class already has a "${ params.api.state }" property!` ); }
-    // Definitions
-    Object.defineProperty( window.document, params.api.state, { get: function() {
-        return Observer.proxy( getStateObject( window.document ) );
-    } });
-    Object.defineProperty( window.Element.prototype, params.api.state, { get: function() {
-        return Observer.proxy( getStateObject( this ) );
-    } } );
-}

package/test/state-api.test.js

@@ -1,34 +0,0 @@
-
-/**
- * @imports
- */
-import { expect } from 'chai';
-import { createDocument } from './index.js';
-import Observer from '@webqit/observer';
-
-describe(`State API`, function() {
-
-    describe( `Basic...`, function() {
-        
-        const head = ``;
-        const body = ``;
-        const { document } = createDocument( head, body );
-
-        it ( `The document object and elements should expose a "state" property each...`, async function() {
-            expect( document ).to.have.property( 'state' );
-            expect( document.body ).to.have.property( 'state' );
-        } );
-
-        it ( `State objects should be observable...`, async function() {
-            let idReceived = null;
-            Observer.observe( document.state, records => {
-                idReceived = records[ 0 ].key;
-            } );
-            document.state.someKey = 'someValue';
-            expect( idReceived ).to.eq( 'someKey' );
-        } );
-
-    } );
-
-} );
-