From 540e0da0bf006ab5e150b5830ff88d50ffde1db8 Mon Sep 17 00:00:00 2001 From: lajbel Date: Sat, 13 Apr 2024 20:37:46 -0300 Subject: [PATCH] rewrite makers and options, remove extendOptions, add doc --- .gitignore | 1 - docs/.nojekyll | 1 + docs/assets/highlight.css | 85 ++ docs/assets/icons.js | 15 + docs/assets/icons.svg | 1 + docs/assets/main.js | 59 ++ docs/assets/navigation.js | 1 + docs/assets/search.js | 1 + docs/assets/style.css | 1415 +++++++++++++++++++++++++++++ docs/functions/extendMaker.html | 2 + docs/functions/kiboom.html | 1 + docs/functions/makeArea.html | 5 + docs/functions/makeBg.html | 3 + docs/functions/makeCircle.html | 3 + docs/functions/makeMaker.html | 5 + docs/functions/makeObject.html | 4 + docs/functions/makeRect.html | 3 + docs/functions/makeRender.html | 11 + docs/functions/makeSprite.html | 3 + docs/functions/makeText.html | 3 + docs/index.html | 7 + docs/interfaces/KiboomPlugin.html | 44 + docs/modules.html | 28 + docs/types/ApplierFN.html | 1 + docs/types/AreaOpt.html | 2 + docs/types/BackgroundOpt.html | 2 + docs/types/BaseComps.html | 2 + docs/types/CircleOpt.html | 3 + docs/types/HasOptionalKey.html | 1 + docs/types/MakerFN.html | 1 + docs/types/ObjOpt.html | 7 + docs/types/OptionFN.html | 1 + docs/types/OptionalOptionFN.html | 1 + docs/types/RectOpt.html | 4 + docs/types/RenderComps.html | 1 + docs/types/RenderOpt.html | 2 + docs/types/SpriteOpt.html | 3 + docs/types/TextOpt.html | 6 + src/factory/makers.ts | 52 +- src/factory/options.ts | 35 +- src/index.ts | 8 +- src/objects/makeArea.ts | 8 +- src/objects/makeBg.ts | 21 +- src/objects/makeCircle.ts | 13 +- src/objects/makeRect.ts | 16 +- src/objects/makeRender.ts | 6 +- src/objects/makeSprite.ts | 14 +- src/objects/makeText.ts | 32 +- src/types.ts | 51 +- src/utils/types.ts | 33 +- 50 files changed, 1891 insertions(+), 136 deletions(-) create mode 100644 docs/.nojekyll create mode 100644 docs/assets/highlight.css create mode 100644 docs/assets/icons.js create mode 100644 docs/assets/icons.svg create mode 100644 docs/assets/main.js create mode 100644 docs/assets/navigation.js create mode 100644 docs/assets/search.js create mode 100644 docs/assets/style.css create mode 100644 docs/functions/extendMaker.html create mode 100644 docs/functions/kiboom.html create mode 100644 docs/functions/makeArea.html create mode 100644 docs/functions/makeBg.html create mode 100644 docs/functions/makeCircle.html create mode 100644 docs/functions/makeMaker.html create mode 100644 docs/functions/makeObject.html create mode 100644 docs/functions/makeRect.html create mode 100644 docs/functions/makeRender.html create mode 100644 docs/functions/makeSprite.html create mode 100644 docs/functions/makeText.html create mode 100644 docs/index.html create mode 100644 docs/interfaces/KiboomPlugin.html create mode 100644 docs/modules.html create mode 100644 docs/types/ApplierFN.html create mode 100644 docs/types/AreaOpt.html create mode 100644 docs/types/BackgroundOpt.html create mode 100644 docs/types/BaseComps.html create mode 100644 docs/types/CircleOpt.html create mode 100644 docs/types/HasOptionalKey.html create mode 100644 docs/types/MakerFN.html create mode 100644 docs/types/ObjOpt.html create mode 100644 docs/types/OptionFN.html create mode 100644 docs/types/OptionalOptionFN.html create mode 100644 docs/types/RectOpt.html create mode 100644 docs/types/RenderComps.html create mode 100644 docs/types/RenderOpt.html create mode 100644 docs/types/SpriteOpt.html create mode 100644 docs/types/TextOpt.html diff --git a/.gitignore b/.gitignore index c390bb8..6139c75 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,4 @@ node_modules dist -docs test \ No newline at end of file diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 0000000..63020ab --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,85 @@ +:root { + --light-hl-0: #001080; + --dark-hl-0: #9CDCFE; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #AF00DB; + --dark-hl-2: #C586C0; + --light-hl-3: #A31515; + --dark-hl-3: #CE9178; + --light-hl-4: #795E26; + --dark-hl-4: #DCDCAA; + --light-hl-5: #008000; + --dark-hl-5: #6A9955; + --light-hl-6: #0000FF; + --dark-hl-6: #569CD6; + --light-hl-7: #0070C1; + --dark-hl-7: #4FC1FF; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.js b/docs/assets/icons.js new file mode 100644 index 0000000..b79c9e8 --- /dev/null +++ b/docs/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg new file mode 100644 index 0000000..7dead61 --- /dev/null +++ b/docs/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 0000000..1daeb69 --- /dev/null +++ b/docs/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.scrollToHash(),this.updateIndexVisibility())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.scrollToHash(),this.updateIndexVisibility())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 0000000..c4a2d60 --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42U0W6CMBSGX8X0mszNTJdxpyZmi9lYnHfGiwpHrJTSlJpolr37AgUG0nq8I+fr/1XqTzc/RMNZE58EuyOEevBBE1A58Uh4YDxSIIi/adakNIGpAko8Iqk+EJ/sTyLULBP5sGYPB51y4pGEiYj4k+dfrxOfxa7wLEaic6ZCDq64oYjCvKRLYSiiWN0QrO6JiwiUW1BQRPEtFdPOczAUUayLR4egYL34tiUIZLnY0ZGiA4Fs2fVFQj6sxl3x6PH15Wk8arlnNExilZ1EZHF0IGYyfbBYGoAZgt3REjdTLFs0wRKuxni6qIE1XwHMYFpgMTQAMxQ1sOSrsT3dbsm70KD2NARXUZZsl2XpFz/FTPzvwprYsL3gar/xpLPX+iJhMOWM5s7dplJyBmrx2StmDfBq5jDPUpn3a1kBzPBGc/PtUL6Ey7WmSzFXeU/336Yao9UuN+rH6/l9ecpve/75fYW3nm4L4aVb1DeZowVJWSnbzWfIzXuv+J8dXjhrEFF5+DZ5CyMXs1PRQMtP3P4BzsbQ88YHAAA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 0000000..19ce623 --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62a226cSBCG36Vzi8buE3O4iyNFu4p2s4qjvRlZEWbwmHgGRgxOvLH87qumG6hiujgsezUyXfVXUV9Vg4FXVuQ/z2yzfWVPabZjm1AFLIuOCduwp/Q+z48sYM/FgW3Yw3MWl2mena/swuKxPB5YwOJDdD4nZ7Zh7C2oZcT1esm1aLT+iJ6S4uOfjVj5zyk5X7mjvUqh1jJsdL59M549Mu8aC6AWsFNUJFkJEqFTfX86HVJPss3xuelioaGE23TolD+fDJjoYH8vMu8uTyL3W3Su/T8l/3SU8eIk3d5c5xcZ6QzVuMmlJ937759PZTdIdXB2qq3KYKI2i1aeX4t2YE/5eVB6YY365BcuCSJKlMWPeTEcqLGbEavIy6gcrteisZsR69dwmF/zIpTRfgQgZzUtTrddb6Jz8iE/nrrxmuOTZvV9kUSX3e+Ozt4OgczgZugSIQp8Tn+NUF84s94QwyX+kmS7pLgsS3N8bmGw0FBp2nSI4sT54WJsvSEWteVAoIFuz09RnJbdK4Y/Yms7L+Y5jg6jyrioLSfH87eBb9bAyqRpu4nip32RP2e7y+ZCa3Mb7FJsqMlwauOnkIzUP4vYbRDFh7SID8ll0ZrjcwuGhYaK1aZDXd2iXfrc7RpvjEVjOhBqTL/GpW/Tqo7O37JameENyyZCFOdnuisfh+UXtV1vkIFt4zFJ9499JamDNYYTo3Uh3J6KtPR0anN8LggsNISiTYca6cpgTIxFYzoQarhIX5MXT6e6o3MLBGWGylMnQt3WJS99STb3ddasN8TQDWTyUt5e7q5UtNu+vXV8xI95Nvb8nOnciO8P6T4bGbK2nRhT6LZBPlXPM/46PO/TNmqalUnxEMXJ+QquD1zJ1apRPUZPyef770lcjtJ8h+z9Z4MS7Qlr7mHHB3XW80Lam53xQRv7uWGnlPfL/1Fce60dH7Sxnxf2K9xlBoN+7dtsxoa8xbv+YNDb/q1/bNib/fiQle28cNUTwfERa/P/HjR5KZNsNyEsdpgUGDzO9exH7SPddrH/wqrofQaLmaUpUp39A4vZxWly5Gl+mXiSnXnHYnZxihyaYyxmlqZIdeYTi9nFKXJg7rDUzX6KDG5srFStjRXzzUkrB1Z9gncBS7Nd8sI2r+xHUpzTPGMbJhZysWYBe0iTw8689rCxAhbnx6MZpDu39ncSl3lhLKzJ1TULtteBXC7Wa3F3F2xrj2qhOlCZcRZsuc+MIzPBgq0I+HIRConMBDKTLNhKn5pEZopSU8hMs2CrfGoamYUs2GqfWYjMlizYhj6zJTJbUbmtkNmaBdulT22Ny3tNyfEOB1PvlRcEJsFNxddeQ8yCm5pzbwtwjIObsnN/F2Ai3FSeC68lhsJN8bm3Fzjmwk39uZczx2g4yYZjONxA4DqQYrFaKWyJ+QhDgXvbQmBAgpMj0BkVg4F7e0NgQqIi5IUuMCFREfJSF5iQMBiEl7rAhITBILzUBSYkluSpY0BiRdZdYELCYBDeRhKYkCQnSGJAsgLk330wIVntZt6Ok539TJLBMSBZbWneXUhiQLIC5O04iQHJCpC3kSQGJElAEgOS1QR5O05iQLIC5O04iQEpEpDCgJShIL2tqTAgZShIb2sqDEhVVxxvH6nONcdgkN72UJiQMhiktz0UJqQMBuntd4UJKcNBhl5LjEgZDnLptcSIlOEgV15LjEgbEHLts9SYkTYg1LXXEjPSBoTiXkvMSBsQSngtMSNtQCjptezcGlT3BspriRlpmpHGjDTNSGNGmmakMSNNM9KYUUgzCjGjkGYUYkYhzSjEjEKaUYgZhTSjEDMKaUahZVTd8/5IijLZ/W7vfbfb5unnK/vmboibJ6yvTLDN61vAlP1Z2R9+7X7d34K736X9lW5dSvfrjqvq+Ft7M23+MmnWXwK0KazbFLigvOyHLw8ZdJSto6T8iiTKzWPj1osrEG9J+N03L5s63oKDgoWk9zmJ7UtAEBekyynPuPoXshsTQlpTnvY9LYi3BF5UXe0/Tkf7b1Xrq0CNtLZEQ01oPEbn3H3382Q+CmpldKtCnXD9EgWcbQiwUjHrz9Fat+vWi2o963Ryj3ZBH4GzVVREU6OoesQBHEGqyjW+plrKCNzvUZUBV+3mJ6Q62bjH7ukDyAAMj3ajGFLnbyQuUYO21G72Q9WjkLvHRiAJwFmFrgwU8CqBrsAKCKydANXoVsA+IAISoNuV26v0qk8C7yVgrHmPV/1CC9QPeGq3hYbUuBkJ++oHCIDO1W53Dakc8vvvnc0BnDdVseaDCnC6oOKCarl6qu0vrhfcIHrdsRsYGGpOqm/SWg+QKKeqUr8QB5sIvDaQbua5TmerBeclKYq2+y42eAFACqoo1rd7SQJlEdT01p+1ATcQkFMQ3bctwAtsGYIadPslBnACI87dhApqvC6HRACKst+tCwT0t6T2FPuVHMgWbKycItGdQwmqqaiWMU6RfckIPEGzKaqixvOheiMKHEGeigJoHLtFAQglNfXGr4tRgs1KUe3tPqIA4QB8SZ3fLwQAbqdej7uAndJTckizhG22d29v/wKNlMTxfS4AAA=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 0000000..072daed --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1415 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/docs/functions/extendMaker.html b/docs/functions/extendMaker.html new file mode 100644 index 0000000..93d0222 --- /dev/null +++ b/docs/functions/extendMaker.html @@ -0,0 +1,2 @@ +extendMaker | kiboom

Function extendMaker

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/kiboom.html b/docs/functions/kiboom.html new file mode 100644 index 0000000..da5a058 --- /dev/null +++ b/docs/functions/kiboom.html @@ -0,0 +1 @@ +kiboom | kiboom

Function kiboom

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/makeArea.html b/docs/functions/makeArea.html new file mode 100644 index 0000000..ecc5e15 --- /dev/null +++ b/docs/functions/makeArea.html @@ -0,0 +1,5 @@ +makeArea | kiboom

Function makeArea

  • makeArea(opt): GameObj<BaseComps & AreaComp>

  • Make an object with a collider component. +Maker extends makeObject

    +

    Parameters

    Returns GameObj<BaseComps & AreaComp>

    Example

    const clickableArea = k.add(makeArea({
      width: 100,
      height: 100,
    }));
+
    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/makeBg.html b/docs/functions/makeBg.html new file mode 100644 index 0000000..3d62890 --- /dev/null +++ b/docs/functions/makeBg.html @@ -0,0 +1,3 @@ +makeBg | kiboom

Function makeBg

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/makeCircle.html b/docs/functions/makeCircle.html new file mode 100644 index 0000000..377befc --- /dev/null +++ b/docs/functions/makeCircle.html @@ -0,0 +1,3 @@ +makeCircle | kiboom

Function makeCircle

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/makeMaker.html b/docs/functions/makeMaker.html new file mode 100644 index 0000000..bac27e7 --- /dev/null +++ b/docs/functions/makeMaker.html @@ -0,0 +1,5 @@ +makeMaker | kiboom

Function makeMaker

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/makeObject.html b/docs/functions/makeObject.html new file mode 100644 index 0000000..7f1c668 --- /dev/null +++ b/docs/functions/makeObject.html @@ -0,0 +1,4 @@ +makeObject | kiboom

Function makeObject

  • makeObject(opt): GameObj<BaseComps>

  • Make an object with the base components.

    +

    Parameters

    Returns GameObj<BaseComps>

    Example

    // Good for parent objects!

    const myParent = k.add(makeObject({
     pos: k.vec2(100, 100),
    });

    myParent.add(k.makeSprite({
     sprite: "bean",
    }));
    
+
    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/makeRect.html b/docs/functions/makeRect.html new file mode 100644 index 0000000..47b7cbc --- /dev/null +++ b/docs/functions/makeRect.html @@ -0,0 +1,3 @@ +makeRect | kiboom

Function makeRect

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/makeRender.html b/docs/functions/makeRender.html new file mode 100644 index 0000000..64c428f --- /dev/null +++ b/docs/functions/makeRender.html @@ -0,0 +1,11 @@ +makeRender | kiboom

Function makeRender

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/makeSprite.html b/docs/functions/makeSprite.html new file mode 100644 index 0000000..62719c1 --- /dev/null +++ b/docs/functions/makeSprite.html @@ -0,0 +1,3 @@ +makeSprite | kiboom

Function makeSprite

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/makeText.html b/docs/functions/makeText.html new file mode 100644 index 0000000..7b7366c --- /dev/null +++ b/docs/functions/makeText.html @@ -0,0 +1,3 @@ +makeText | kiboom

Function makeText

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..dae37f9 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,7 @@ +kiboom

kiboom

kiboom is a Kaboom.js plugin that mainly provides a set of new "factory" +functions, made for create new easily modifiable objects.

+

Installation

npm install kiboom
+
+

Usage

import kaboom from "kaboom";
import { kiboom } from "kiboom";

kaboom({
    plugins: [kiboom],
});

// New methods
makeSprite();
makeText();
+
+

Settings

Member Visibility

Theme

On This Page

InstallationUsage

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/KiboomPlugin.html b/docs/interfaces/KiboomPlugin.html new file mode 100644 index 0000000..331c3ff --- /dev/null +++ b/docs/interfaces/KiboomPlugin.html @@ -0,0 +1,44 @@ +KiboomPlugin | kiboom

Interface KiboomPluginInternal

The kiboom Kaboom's plugin

+
interface KiboomPlugin {
    extendMaker<TBaseComps, TBaseOpt, TNewComps, TNewOpt>(baseMaker, defaultOpt, componentsApply, baseDefaultOpt?): MakerFN<TNewOpt & TBaseOpt, TNewComps & TBaseComps>;
    makeArea(opt): GameObj<BaseComps & AreaComp>;
    makeBg(opt?): GameObj<BaseComps & RenderComps & RectComp>;
    makeCircle(opt): GameObj<BaseComps & RenderComps>;
    makeMaker<TComps, TOpt>(defaultOpt, componentsApply): MakerFN<TOpt, TComps>;
    makeObject(opt): GameObj<BaseComps>;
    makeRect(opt): GameObj<BaseComps & RenderComps & RectComp>;
    makeRender(opt?): GameObj<BaseComps & RenderComps>;
    makeSprite(opt): GameObj<BaseComps & RenderComps & SpriteComp>;
    makeText(opt): GameObj<BaseComps & RenderComps & TextComp>;
}

Object Makers - Object Makers

makeArea +makeBg +makeCircle +makeObject +makeRect +makeRender +makeSprite +makeText +

Base - Base

extendMaker +makeMaker +

Object Makers - Object Makers

makeArea

  • makeArea(opt): GameObj<BaseComps & AreaComp>

  • Make an object with a collider component. +Maker extends makeObject

    +

    Parameters

    Returns GameObj<BaseComps & AreaComp>

    Example

    const clickableArea = k.add(makeArea({
      width: 100,
      height: 100,
    }));
+
    +

makeBg

makeCircle

makeObject

  • makeObject(opt): GameObj<BaseComps>

  • Make an object with the base components.

    +

    Parameters

    Returns GameObj<BaseComps>

    Example

    // Good for parent objects!

    const myParent = k.add(makeObject({
     pos: k.vec2(100, 100),
    });

    myParent.add(k.makeSprite({
     sprite: "bean",
    }));
    
+
    +

makeRect

makeRender

makeSprite

makeText

Base - Base

extendMaker

makeMaker

Settings

Member Visibility

Theme

On This Page

makeAreamakeBgmakeCirclemakeObjectmakeRectmakeRendermakeSpritemakeTextextendMakermakeMaker

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 0000000..035854b --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,28 @@ +kiboom

kiboom

Index

Object Makers - Object Makers

makeArea +makeBg +makeCircle +makeObject +makeRect +makeRender +makeSprite +makeText +

Options

AreaOpt +BackgroundOpt +CircleOpt +ObjOpt +RectOpt +RenderOpt +SpriteOpt +TextOpt +

Interfaces

KiboomPlugin +

Type Aliases

ApplierFN +BaseComps +HasOptionalKey +MakerFN +OptionFN +OptionalOptionFN +RenderComps +

Functions

kiboom +

Base - Base

extendMaker +makeMaker +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ApplierFN.html b/docs/types/ApplierFN.html new file mode 100644 index 0000000..c7c7cba --- /dev/null +++ b/docs/types/ApplierFN.html @@ -0,0 +1 @@ +ApplierFN | kiboom

Type alias ApplierFN<TComps, TOpt>

ApplierFN<TComps, TOpt>: ((opt, k) => CompList<TComps>)

Type Parameters

  • TComps
  • TOpt

Type declaration

    • (opt, k): CompList<TComps>

    • Parameters

      • opt: Required<TOpt>
      • k: KaboomCtx

      Returns CompList<TComps>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/AreaOpt.html b/docs/types/AreaOpt.html new file mode 100644 index 0000000..4fa3fe8 --- /dev/null +++ b/docs/types/AreaOpt.html @@ -0,0 +1,2 @@ +AreaOpt | kiboom

Type alias AreaOpt

AreaOpt: {
    size: Vec2;
}

The options of the area object

+

Type declaration

  • size: Vec2

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/BackgroundOpt.html b/docs/types/BackgroundOpt.html new file mode 100644 index 0000000..2b0544f --- /dev/null +++ b/docs/types/BackgroundOpt.html @@ -0,0 +1,2 @@ +BackgroundOpt | kiboom

Type alias BackgroundOpt

BackgroundOpt: {
    size: Vec2;
}

The options of the background object

+

Type declaration

  • size: Vec2

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/BaseComps.html b/docs/types/BaseComps.html new file mode 100644 index 0000000..666fdd4 --- /dev/null +++ b/docs/types/BaseComps.html @@ -0,0 +1,2 @@ +BaseComps | kiboom

Type alias BaseComps

BaseComps: PosComp | AnchorComp | RotateComp | ZComp | StateComp

The components of the base object

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/CircleOpt.html b/docs/types/CircleOpt.html new file mode 100644 index 0000000..ff5ad57 --- /dev/null +++ b/docs/types/CircleOpt.html @@ -0,0 +1,3 @@ +CircleOpt | kiboom

Type alias CircleOpt

CircleOpt: {
    radius: number;
}

The options of the circle object

+

Type declaration

  • radius: number

    The radius of the circle

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/HasOptionalKey.html b/docs/types/HasOptionalKey.html new file mode 100644 index 0000000..efe7c91 --- /dev/null +++ b/docs/types/HasOptionalKey.html @@ -0,0 +1 @@ +HasOptionalKey | kiboom

Type alias HasOptionalKey<T>

HasOptionalKey<T>: T[keyof T] extends NonNullable<T[keyof T]>
    ? false
    : true

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/MakerFN.html b/docs/types/MakerFN.html new file mode 100644 index 0000000..7a476f0 --- /dev/null +++ b/docs/types/MakerFN.html @@ -0,0 +1 @@ +MakerFN | kiboom

Type alias MakerFN<TOpt, TComps>

MakerFN<TOpt, TComps>: ((opt) => GameObj<TComps>)

Type Parameters

  • TOpt
  • TComps

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ObjOpt.html b/docs/types/ObjOpt.html new file mode 100644 index 0000000..35aafa6 --- /dev/null +++ b/docs/types/ObjOpt.html @@ -0,0 +1,7 @@ +ObjOpt | kiboom

Type alias ObjOpt

ObjOpt: {
    anchor?: Anchor | Vec2;
    pos?: Vec2;
    rotate?: number;
    tags?: string[];
    z?: number;
}

The base options of all object makers

+

Type declaration

  • Optional anchor?: Anchor | Vec2

    Anchor point of the object

    +
  • Optional pos?: Vec2

    Position of the object

    +
  • Optional rotate?: number

    The rotation of the object

    +
  • Optional tags?: string[]

    Tags of the object

    +
  • Optional z?: number

    The z index of the object

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/OptionFN.html b/docs/types/OptionFN.html new file mode 100644 index 0000000..6596d17 --- /dev/null +++ b/docs/types/OptionFN.html @@ -0,0 +1 @@ +OptionFN | kiboom

Type alias OptionFN<TOpt>

OptionFN<TOpt>: ((k) => TOpt)

Type Parameters

  • TOpt

Type declaration

    • (k): TOpt

    • Parameters

      • k: KaboomCtx

      Returns TOpt

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/OptionalOptionFN.html b/docs/types/OptionalOptionFN.html new file mode 100644 index 0000000..abc6c7e --- /dev/null +++ b/docs/types/OptionalOptionFN.html @@ -0,0 +1 @@ +OptionalOptionFN | kiboom

Type alias OptionalOptionFN<T>

OptionalOptionFN<T>: T extends HasOptionalKey<T>
    ? OptionFN<T> | undefined
    : OptionFN<T>

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/RectOpt.html b/docs/types/RectOpt.html new file mode 100644 index 0000000..97c54fc --- /dev/null +++ b/docs/types/RectOpt.html @@ -0,0 +1,4 @@ +RectOpt | kiboom

Type alias RectOpt

RectOpt: {
    height: number;
    width: number;
}

The options of the rect object

+

Type declaration

  • height: number

    The height of the rect

    +
  • width: number

    The width of the rect

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/RenderComps.html b/docs/types/RenderComps.html new file mode 100644 index 0000000..cebeb07 --- /dev/null +++ b/docs/types/RenderComps.html @@ -0,0 +1 @@ +RenderComps | kiboom

Type alias RenderComps

RenderComps: ColorComp | OpacityComp | ScaleComp

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/RenderOpt.html b/docs/types/RenderOpt.html new file mode 100644 index 0000000..1198f18 --- /dev/null +++ b/docs/types/RenderOpt.html @@ -0,0 +1,2 @@ +RenderOpt | kiboom

Type alias RenderOpt

RenderOpt: {
    color?: string;
    opacity?: number;
    scale?: Vec2;
}

The options of the render object

+

Type declaration

  • Optional color?: string
  • Optional opacity?: number
  • Optional scale?: Vec2

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/SpriteOpt.html b/docs/types/SpriteOpt.html new file mode 100644 index 0000000..c637749 --- /dev/null +++ b/docs/types/SpriteOpt.html @@ -0,0 +1,3 @@ +SpriteOpt | kiboom

Type alias SpriteOpt

SpriteOpt: {
    sprite: string;
}

The options of the sprite object

+

Type declaration

  • sprite: string

    The sprite name

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/TextOpt.html b/docs/types/TextOpt.html new file mode 100644 index 0000000..c61a0ec --- /dev/null +++ b/docs/types/TextOpt.html @@ -0,0 +1,6 @@ +TextOpt | kiboom

Type alias TextOpt

TextOpt: {
    text: string;
    textAlign?: TextAlign;
    textFont?: string;
    textSize?: number;
}

The options of the text object

+

Type declaration

  • text: string

    The text to display

    +
  • Optional textAlign?: TextAlign

    The align of the text

    +
  • Optional textFont?: string

    The font of the text

    +
  • Optional textSize?: number

    The size of the text

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/src/factory/makers.ts b/src/factory/makers.ts index 925620e..395dfd2 100644 --- a/src/factory/makers.ts +++ b/src/factory/makers.ts @@ -1,23 +1,19 @@ -import { CompList, GameObj, KaboomCtx } from "kaboom"; +import { GameObj, KaboomCtx } from "kaboom"; import { getK } from "../plugin"; -import { FlipOptional } from "../utils/types"; +import { + ApplierFN, + HasOptionalKey, + MakerFN, + OptionalOptionFN, + OptionFN, +} from "../utils/types"; import { use } from "../utils/use"; import { mergeOptions } from "./options"; -type MakerFN = ( - opt: TOpt, -) => GameObj; - -export const makeMaker = < - TComps, - TOpt, ->( - defaultOpt: (k: KaboomCtx) => TOpt, - componentsApply: ( - opt: Required, - k: KaboomCtx, - ) => CompList, -): MakerFN, TComps> => { +export const makeMaker = ( + defaultOpt: OptionFN, + componentsApply: ApplierFN, +): MakerFN => { return (opt) => { const k = getK(); @@ -39,31 +35,31 @@ export const makeMaker = < export const extendMaker = < TBaseComps, + TBaseOpt, TNewComps, - TOpt, + TNewOpt, >( - baseMaker: (opt: TOpt) => GameObj, - defaultOpt: (k: KaboomCtx) => TOpt, - componentsApply: ( - opt: Required, - k: KaboomCtx, - ) => CompList, -): MakerFN, TBaseComps & TNewComps> => { + baseMaker: MakerFN, + defaultOpt: OptionFN, + componentsApply: ApplierFN, + baseDefaultOpt: OptionalOptionFN = undefined as any, +): MakerFN => { return (opt) => { const k = getK(); const applyNewComponents = ( obj: GameObj, - opt: Required, + opt: Required, ) => { const comps = componentsApply?.(opt, k); return use(obj, comps); }; - const baseOpt = defaultOpt(k); - const requiredOpt = mergeOptions(baseOpt, opt); + const defOpt = defaultOpt(k); + const baseOpt = baseDefaultOpt?.(k); + const requiredOpt = mergeOptions(defOpt, opt); - const baseObj = baseMaker(requiredOpt); + const baseObj = baseMaker(baseOpt); const newObj = applyNewComponents(baseObj, requiredOpt); return newObj; diff --git a/src/factory/options.ts b/src/factory/options.ts index ea4e79c..f51c82d 100644 --- a/src/factory/options.ts +++ b/src/factory/options.ts @@ -1,14 +1,12 @@ import { KaboomCtx } from "kaboom"; -import { FlipOptional } from "../utils/types"; +import { OptionFN } from "../utils/types"; -export const makeOptions = < - T, ->( - opt: (k: KaboomCtx) => FlipOptional, -) => { - return (k: KaboomCtx) => { - return opt(k); - }; +export const makeOptions = ( + opt: (k: KaboomCtx) => Partial, +): OptionFN => { + // For now, is user responsability to make sure that the options are correct + // respecting the type T + return (k) => opt(k) as T; }; export const mergeOptions = < @@ -17,24 +15,9 @@ export const mergeOptions = < >( defaultOpt: T, opt: T2, -): Required => { +) => { return { ...defaultOpt, ...opt, - } as Required; -}; - -export const extendOptions = < - TNew, - TBase, ->( - baseOpt: (k: KaboomCtx) => TBase, - newOpt: (k: KaboomCtx) => FlipOptional & TBase, -) => { - return (k: KaboomCtx) => { - return { - ...baseOpt(k), - ...newOpt(k), - } as FlipOptional; - }; + } as Required; }; diff --git a/src/index.ts b/src/index.ts index 97daa9f..99c2133 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,7 +1,5 @@ -import { children } from "./components/childrens"; -import { custom } from "./components/custom"; import { extendMaker, makeMaker } from "./factory/makers"; -import { extendOptions } from "./factory/options"; +import { makeOptions } from "./factory/options"; import { makeArea } from "./objects/makeArea"; import { makeBg } from "./objects/makeBg"; import { makeCircle } from "./objects/makeCircle"; @@ -12,7 +10,6 @@ import { makeSprite } from "./objects/makeSprite"; import { makeText } from "./objects/makeText"; import { createOptions } from "./options/createOptions"; import { createKaboomPlugin } from "./plugin"; -import { kiScene } from "./scenes/kiScene"; import { KiboomPlugin } from "./types"; const { run: kiboom } = createKaboomPlugin(() => { @@ -41,8 +38,7 @@ const { run: kiboom } = createKaboomPlugin(() => { extendMaker, // options api - makeOptions: createOptions, - extendOptions: extendOptions, + makeOptions: makeOptions, }; }); diff --git a/src/objects/makeArea.ts b/src/objects/makeArea.ts index 22facfc..87bb743 100644 --- a/src/objects/makeArea.ts +++ b/src/objects/makeArea.ts @@ -1,7 +1,7 @@ -import { Vec2 } from "kaboom"; +import type { Vec2 } from "kaboom"; import { extendMaker } from "../factory/makers"; -import { extendOptions } from "../factory/options"; -import { makeObject, objectOpt, ObjOpt } from "./makeObject"; +import { makeOptions } from "../factory/options"; +import { makeObject } from "./makeObject"; /** * The options of the area object @@ -12,7 +12,7 @@ export type AreaOpt = { size: Vec2; }; -const areaOpt = extendOptions(objectOpt, (k) => ({})); +const areaOpt = makeOptions((k) => ({})); export const makeArea = extendMaker(makeObject, areaOpt, (opt, k) => [ k.area({ diff --git a/src/objects/makeBg.ts b/src/objects/makeBg.ts index e32c847..9ed7083 100644 --- a/src/objects/makeBg.ts +++ b/src/objects/makeBg.ts @@ -1,8 +1,8 @@ import { Vec2 } from "kaboom"; import { extendMaker } from "../factory/makers"; -import { extendOptions } from "../factory/options"; +import { makeOptions } from "../factory/options"; import { ObjOpt } from "./makeObject"; -import { makeRender, RenderOpt, renderOpt } from "./makeRender"; +import { makeRender } from "./makeRender"; /** * The options of the background object @@ -10,16 +10,17 @@ import { makeRender, RenderOpt, renderOpt } from "./makeRender"; * @group Options */ export type BackgroundOpt = { - size?: Vec2; + size: Vec2; }; -export const backgroundOpt = extendOptions( - renderOpt, - (k) => ({ - size: k.vec2(k.width(), k.height()), - }), -); +const backgroundOpt = makeOptions((k) => ({ + size: k.vec2(k.width(), k.height()), +})); + +const objOpt = makeOptions((k) => ({ + pos: k.vec2(k.center()), +})); export const makeBg = extendMaker(makeRender, backgroundOpt, (opt, k) => [ k.rect(opt.size.x, opt.size.y), -]); +], objOpt); diff --git a/src/objects/makeCircle.ts b/src/objects/makeCircle.ts index 38b4b8a..e2b9bee 100644 --- a/src/objects/makeCircle.ts +++ b/src/objects/makeCircle.ts @@ -1,7 +1,6 @@ import { extendMaker } from "../factory/makers"; -import { extendOptions } from "../factory/options"; -import { ObjOpt } from "./makeObject"; -import { makeRender, RenderOpt, renderOpt } from "./makeRender"; +import { makeOptions } from "../factory/options"; +import { makeRender } from "./makeRender"; /** * The options of the circle object @@ -9,13 +8,13 @@ import { makeRender, RenderOpt, renderOpt } from "./makeRender"; * @group Options */ export type CircleOpt = { + /** + * The radius of the circle + */ radius: number; }; -export const circleOpt = extendOptions( - renderOpt, - () => ({}), -); +export const circleOpt = makeOptions(() => ({})); export const makeCircle = extendMaker(makeRender, circleOpt, (opt, k) => [ k.circle(opt.radius), diff --git a/src/objects/makeRect.ts b/src/objects/makeRect.ts index 4c568dd..9ffc7b0 100644 --- a/src/objects/makeRect.ts +++ b/src/objects/makeRect.ts @@ -1,7 +1,6 @@ import { extendMaker } from "../factory/makers"; -import { extendOptions } from "../factory/options"; -import { ObjOpt } from "./makeObject"; -import { makeRender, RenderOpt, renderOpt } from "./makeRender"; +import { makeOptions } from "../factory/options"; +import { makeRender } from "./makeRender"; /** * The options of the rect object @@ -9,14 +8,17 @@ import { makeRender, RenderOpt, renderOpt } from "./makeRender"; * @group Options */ export type RectOpt = { + /** + * The width of the rect + */ width: number; + /** + * The height of the rect + */ height: number; }; -export const rectOpt = extendOptions( - renderOpt, - () => ({}), -); +export const rectOpt = makeOptions(() => ({})); export const makeRect = extendMaker(makeRender, rectOpt, (opt, k) => [ k.rect(opt.width, opt.height), diff --git a/src/objects/makeRender.ts b/src/objects/makeRender.ts index cd9ddd5..0162cc2 100644 --- a/src/objects/makeRender.ts +++ b/src/objects/makeRender.ts @@ -1,7 +1,7 @@ import { ColorComp, CompList, OpacityComp, ScaleComp, Vec2 } from "kaboom"; import { extendMaker } from "../factory/makers"; -import { extendOptions } from "../factory/options"; -import { makeObject, objectOpt, ObjOpt } from "./makeObject"; +import { makeOptions } from "../factory/options"; +import { makeObject } from "./makeObject"; /** * The options of the render object @@ -16,7 +16,7 @@ export type RenderOpt = { export type RenderComps = ColorComp | OpacityComp | ScaleComp; -export const renderOpt = extendOptions(objectOpt, (k) => ({ +export const renderOpt = makeOptions((k) => ({ color: "#ffffff", opacity: 1, scale: k.vec2(1), diff --git a/src/objects/makeSprite.ts b/src/objects/makeSprite.ts index 1db00ec..2ba05a4 100644 --- a/src/objects/makeSprite.ts +++ b/src/objects/makeSprite.ts @@ -1,7 +1,6 @@ import { extendMaker } from "../factory/makers"; -import { extendOptions } from "../factory/options"; -import { ObjOpt } from "./makeObject"; -import { makeRender, RenderOpt, renderOpt } from "./makeRender"; +import { makeOptions } from "../factory/options"; +import { makeRender } from "./makeRender"; /** * The options of the sprite object @@ -9,14 +8,13 @@ import { makeRender, RenderOpt, renderOpt } from "./makeRender"; * @group Options */ export type SpriteOpt = { + /** + * The sprite name + */ sprite: string; }; -// TODO: Default sprite shouldn't be avaible -export const spriteOpt = extendOptions( - renderOpt, - () => ({}), -); +const spriteOpt = makeOptions(() => ({})); export const makeSprite = extendMaker(makeRender, spriteOpt, (opt, k) => [ k.sprite(opt.sprite), diff --git a/src/objects/makeText.ts b/src/objects/makeText.ts index 3e8814c..6b1dbcd 100644 --- a/src/objects/makeText.ts +++ b/src/objects/makeText.ts @@ -1,8 +1,7 @@ -import { TextAlign } from "kaboom"; +import type { TextAlign } from "kaboom"; import { extendMaker } from "../factory/makers"; -import { extendOptions } from "../factory/options"; -import { ObjOpt } from "./makeObject"; -import { makeRender, RenderOpt, renderOpt } from "./makeRender"; +import { makeOptions } from "../factory/options"; +import { makeRender } from "./makeRender"; /** * The options of the text object @@ -10,23 +9,26 @@ import { makeRender, RenderOpt, renderOpt } from "./makeRender"; * @group Options */ export type TextOpt = { + /** The text to display */ text: string; - size: number; - font: string; - align: TextAlign; + /** The size of the text */ + textSize?: number; + /** The font of the text */ + textFont?: string; + /** The align of the text */ + textAlign?: TextAlign; }; -const textOpt = extendOptions(renderOpt, () => ({ - text: "text", - size: 24, - font: "monospace", - align: "left", +const textOpt = makeOptions(() => ({ + textSize: 24, + textFont: "monospace", + textAlign: "left", })); export const makeText = extendMaker(makeRender, textOpt, (opt, k) => [ k.text(opt.text, { - size: opt.size, - font: opt.font, - align: opt.align, + size: opt.textSize, + font: opt.textFont, + align: opt.textAlign, }), ]); diff --git a/src/types.ts b/src/types.ts index 0579ff4..8d419fe 100644 --- a/src/types.ts +++ b/src/types.ts @@ -6,6 +6,7 @@ import type { SpriteComp, TextComp, } from "kaboom"; +import { extendMaker, makeMaker } from "./factory/makers"; import type { AreaOpt } from "./objects/makeArea"; import type { BackgroundOpt } from "./objects/makeBg"; import type { CircleOpt } from "./objects/makeCircle"; @@ -14,8 +15,7 @@ import type { RectOpt } from "./objects/makeRect"; import type { RenderComps, RenderOpt } from "./objects/makeRender"; import type { SpriteOpt } from "./objects/makeSprite"; import type { TextOpt } from "./objects/makeText"; - -type OptExtend = Partial; +import { ApplierFN, MakerFN, OptionalOptionFN, OptionFN } from "./utils/types"; export declare function kiboom(k: KaboomCtx): KiboomPlugin; @@ -35,7 +35,7 @@ export interface KiboomPlugin { * ```js * // Good for parent objects! * - * const myParent = k.add(makeBase({ + * const myParent = k.add(makeObject({ * pos: k.vec2(100, 100), * }); * @@ -45,11 +45,11 @@ export interface KiboomPlugin { * * ``` */ - makeObject(opt: Partial): GameObj; + makeObject(opt: ObjOpt): GameObj; /** * Make an object with a collider component. - * *Maker extends {@link makeBase}* + * *Maker extends {@link makeObject}* * * @group Object Makers * @category Object Makers @@ -62,7 +62,7 @@ export interface KiboomPlugin { * })); * ``` */ - makeArea(opt: Partial): GameObj; + makeArea(opt: ObjOpt & AreaOpt): GameObj; /** * Make an object with a color and opacity components. @@ -80,7 +80,7 @@ export interface KiboomPlugin { * @category Object Makers */ makeRender( - opt?: OptExtend, + opt?: ObjOpt & RenderOpt, ): GameObj; /** @@ -91,7 +91,7 @@ export interface KiboomPlugin { * @category Object Makers */ makeRect( - opt: Partial, + opt: ObjOpt & RenderOpt & RectOpt, ): GameObj; /** @@ -102,7 +102,7 @@ export interface KiboomPlugin { * @category Object Makers */ makeCircle( - opt: Partial, + opt: ObjOpt & RenderOpt & CircleOpt, ): GameObj; /** @@ -113,7 +113,7 @@ export interface KiboomPlugin { * @category Object Makers */ makeText( - opt: Partial, + opt: ObjOpt & RenderOpt & TextOpt, ): GameObj; /** @@ -124,7 +124,7 @@ export interface KiboomPlugin { * @category Object Makers */ makeSprite( - opt: Partial, + opt: ObjOpt & RenderOpt & SpriteOpt, ): GameObj; /** @@ -135,6 +135,33 @@ export interface KiboomPlugin { * @category Object Makers */ makeBg( - opt?: Partial, + opt?: ObjOpt & RenderOpt & BackgroundOpt, ): GameObj; + + /** + * Make an object maker. This is used internally for {@link makeObject}, + * but we recommend using {@link extendMaker} instead if you want to + * mantain the base options. + * + * @group Base + * @category Base + */ + makeMaker( + /** The default options for the maker */ + defaultOpt: OptionFN, + componentsApply: ApplierFN, + ): MakerFN; + + /** + * Extend a maker with new components. + * + * @group Base + * @category Base + */ + extendMaker( + baseMaker: MakerFN, + defaultOpt: OptionFN, + componentsApply: ApplierFN, + baseDefaultOpt?: OptionalOptionFN, + ): MakerFN; } diff --git a/src/utils/types.ts b/src/utils/types.ts index 65f09e9..e52a55c 100644 --- a/src/utils/types.ts +++ b/src/utils/types.ts @@ -1,9 +1,24 @@ -type OptionalKeys = { - [K in keyof T]-?: {} extends Pick ? K : never; -}[keyof T]; - -export type FlipOptional = ( - & Required>> - & Partial>> -) extends infer O ? { [K in keyof O]: O[K] } - : never; +import { CompList, GameObj, KaboomCtx } from "kaboom"; + +export type MakerFN = ( + opt: TOpt, +) => GameObj; + +export type ApplierFN = ( + opt: Required, + k: KaboomCtx, +) => CompList; + +export type OptionalOptionFN = T extends HasOptionalKey + ? OptionFN | undefined + : OptionFN; + +export type HasOptionalKey = T[keyof T] extends NonNullable + ? false + : true; + +export type OptionFN< + TOpt, +> = ( + k: KaboomCtx, +) => TOpt;