diff --git a/docs/assets/main.js b/docs/assets/main.js index f7c8366..5e52542 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,7 +1,7 @@ "use strict"; -"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(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 h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}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(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+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),u=0;u1?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 ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function B(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){le.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()}ensureFocusedElementVisible(){this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null);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)}}};var I=class{constructor(e){this.el=e.el,this.app=e.app}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(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"?pe(e,-1):s.key==="ArrowDown"?pe(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 Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${fe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function pe(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 fe(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(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",j="mouseup",Z={x:0,y:0},ge=!1,se=!1,Be=!1,A=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",ye="touchmove",j="touchend");document.addEventListener(F,t=>{se=!0,A=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(se&&!A){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);A=Math.sqrt(n*n+r*r)>10}});document.addEventListener(j,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends I{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(j,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(j,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){A||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!A&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends I{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends I{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();B(X,".menu-highlight");B(K,"a[data-toggle]");B(te,".tsd-index-accordion");B(ee,".tsd-filter-item input[type=checkbox]");var we=document.getElementById("theme");we&&be(we);var je=new Y;Object.defineProperty(window,"app",{value:je});})(); +"use strict";(()=>{var be=Object.create;var re=Object.defineProperty;var Se=Object.getOwnPropertyDescriptor;var we=Object.getOwnPropertyNames;var Te=Object.getPrototypeOf,ke=Object.prototype.hasOwnProperty;var Qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Pe=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of we(e))!ke.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=Se(e,i))||n.enumerable});return t};var Ie=(t,e,r)=>(r=t!=null?be(Te(t)):{},Pe(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Qe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},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),r=1,n=0;r0){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),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=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,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&e?.parentElement?.parentElement!==r&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=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 r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ie(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ce(t,n,r,s)}function Ce(t,e,r,n){r.addEventListener("input",ie(()=>{_e(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Re(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function Oe(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function _e(t,e,r,n){if(Oe(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Re(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,Fe=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(Fe=!0,F="touchstart",fe="touchmove",N="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,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);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()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}addEventListener("load",()=>{de(),De(),G(X,"a[data-toggle]"),G(Z,".tsd-index-accordion"),G(Y,".tsd-filter-item input[type=checkbox]");let t=document.getElementById("tsd-theme");t&&ve(t);let e=new U;Object.defineProperty(window,"app",{value:e})});function De(){document.querySelectorAll("pre > button").forEach(t=>{let e;t.addEventListener("click",()=>{t.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(t.previousElementSibling.innerText.trim()),t.textContent="Copied!",t.classList.add("visible"),clearTimeout(e),e=setTimeout(()=>{t.classList.remove("visible"),e=setTimeout(()=>{t.textContent="Copy"},100)},1e3)})})}})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/search.js b/docs/assets/search.js index 668f05f..ef53230 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"generateAccountFile\",\"url\":\"functions/generateAccountFile.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"generateSsoConfigFile\",\"url\":\"functions/generateSsoConfigFile.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"AccountInfo\",\"url\":\"interfaces/AccountInfo.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"Id\",\"url\":\"interfaces/AccountInfo.html#Id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"interfaces/AccountInfo.html#Name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Email\",\"url\":\"interfaces/AccountInfo.html#Email\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Arn\",\"url\":\"interfaces/AccountInfo.html#Arn\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"JoinedMethod\",\"url\":\"interfaces/AccountInfo.html#JoinedMethod\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"JoinedTimestamp\",\"url\":\"interfaces/AccountInfo.html#JoinedTimestamp\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Status\",\"url\":\"interfaces/AccountInfo.html#Status\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":4194304,\"name\":\"AccountList\",\"url\":\"types/AccountList.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"AccountConfig\",\"url\":\"types/AccountConfig.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"GroupConfig\",\"url\":\"types/GroupConfig.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":256,\"name\":\"GroupInfo\",\"url\":\"interfaces/GroupInfo.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"GroupId\",\"url\":\"interfaces/GroupInfo.html#GroupId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GroupInfo\"},{\"kind\":1024,\"name\":\"DisplayName\",\"url\":\"interfaces/GroupInfo.html#DisplayName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GroupInfo\"},{\"kind\":1024,\"name\":\"ExternalIds\",\"url\":\"interfaces/GroupInfo.html#ExternalIds\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GroupInfo\"},{\"kind\":1024,\"name\":\"Description\",\"url\":\"interfaces/GroupInfo.html#Description\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GroupInfo\"},{\"kind\":4194304,\"name\":\"GroupList\",\"url\":\"types/GroupList.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":256,\"name\":\"SsoConfig\",\"url\":\"interfaces/SsoConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"instanceArn\",\"url\":\"interfaces/SsoConfig.html#instanceArn\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoConfig\"},{\"kind\":1024,\"name\":\"identityStoreId\",\"url\":\"interfaces/SsoConfig.html#identityStoreId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoConfig\"},{\"kind\":1024,\"name\":\"groups\",\"url\":\"interfaces/SsoConfig.html#groups\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoConfig\"},{\"kind\":256,\"name\":\"OrgPrincipalAware\",\"url\":\"interfaces/OrgPrincipalAware.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"orgPrincipalEnv\",\"url\":\"interfaces/OrgPrincipalAware.html#orgPrincipalEnv\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"OrgPrincipalAware\"},{\"kind\":256,\"name\":\"ControlTowerProps\",\"url\":\"interfaces/ControlTowerProps.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"accounts\",\"url\":\"interfaces/ControlTowerProps.html#accounts\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ControlTowerProps\"},{\"kind\":256,\"name\":\"SsoProps\",\"url\":\"interfaces/SsoProps.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"ssoConfig\",\"url\":\"interfaces/SsoProps.html#ssoConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoProps\"},{\"kind\":1024,\"name\":\"accounts\",\"url\":\"interfaces/SsoProps.html#accounts\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"SsoProps\"},{\"kind\":4194304,\"name\":\"LogBucketStackProps\",\"url\":\"types/LogBucketStackProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"LogBucketStack\",\"url\":\"classes/LogBucketStack.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/LogBucketStack.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"LogBucketStack\"},{\"kind\":1024,\"name\":\"flowLogsBucketName\",\"url\":\"classes/LogBucketStack.html#flowLogsBucketName\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"LogBucketStack\"},{\"kind\":256,\"name\":\"AccountBudgetOptions\",\"url\":\"interfaces/AccountBudgetOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"amount\",\"url\":\"interfaces/AccountBudgetOptions.html#amount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountBudgetOptions\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"interfaces/AccountBudgetOptions.html#email\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountBudgetOptions\"},{\"kind\":256,\"name\":\"BudgetConfig\",\"url\":\"interfaces/BudgetConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"budgets\",\"url\":\"interfaces/BudgetConfig.html#budgets\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"BudgetConfig\"},{\"kind\":4194304,\"name\":\"BudgetStackProps\",\"url\":\"types/BudgetStackProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"BudgetStack\",\"url\":\"classes/BudgetStack.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BudgetStack.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"BudgetStack\"},{\"kind\":256,\"name\":\"CostReportingConfig\",\"url\":\"interfaces/CostReportingConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"costReportBucketName\",\"url\":\"interfaces/CostReportingConfig.html#costReportBucketName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CostReportingConfig\"},{\"kind\":1024,\"name\":\"costReportName\",\"url\":\"interfaces/CostReportingConfig.html#costReportName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CostReportingConfig\"},{\"kind\":4194304,\"name\":\"CostReportingStackProps\",\"url\":\"types/CostReportingStackProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"CostReportingStack\",\"url\":\"classes/CostReportingStack.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/CostReportingStack.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"CostReportingStack\"},{\"kind\":256,\"name\":\"PermissionSetOptions\",\"url\":\"interfaces/PermissionSetOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"interfaces/PermissionSetOptions.html#description\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"inlinePolicy\",\"url\":\"interfaces/PermissionSetOptions.html#inlinePolicy\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"managedPolicies\",\"url\":\"interfaces/PermissionSetOptions.html#managedPolicies\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"sessionDuration\",\"url\":\"interfaces/PermissionSetOptions.html#sessionDuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"relayStateType\",\"url\":\"interfaces/PermissionSetOptions.html#relayStateType\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PermissionSetOptions\"},{\"kind\":256,\"name\":\"SsoPermissionConfig\",\"url\":\"interfaces/SsoPermissionConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"groupPermissions\",\"url\":\"interfaces/SsoPermissionConfig.html#groupPermissions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"adminSetOptions\",\"url\":\"interfaces/SsoPermissionConfig.html#adminSetOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"readOnlySetOptions\",\"url\":\"interfaces/SsoPermissionConfig.html#readOnlySetOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"billingSetOptions\",\"url\":\"interfaces/SsoPermissionConfig.html#billingSetOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"permissionSets\",\"url\":\"interfaces/SsoPermissionConfig.html#permissionSets\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/SsoPermissionConfig.html#permissionSets.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"SsoPermissionConfig.permissionSets\"},{\"kind\":1024,\"name\":\"defaultAssignmentsForNewAccount\",\"url\":\"interfaces/SsoPermissionConfig.html#defaultAssignmentsForNewAccount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":4194304,\"name\":\"SsoPermissionStackProps\",\"url\":\"types/SsoPermissionStackProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"SsoPermissionStack\",\"url\":\"classes/SsoPermissionStack.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SsoPermissionStack.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"SsoPermissionStack\"},{\"kind\":1024,\"name\":\"permissionSets\",\"url\":\"classes/SsoPermissionStack.html#permissionSets\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"SsoPermissionStack\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/SsoPermissionStack.html#permissionSets.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"SsoPermissionStack.permissionSets\"},{\"kind\":256,\"name\":\"BillingStageConfig\",\"url\":\"interfaces/BillingStageConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"budgetConfig\",\"url\":\"interfaces/BillingStageConfig.html#budgetConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"BillingStageConfig\"},{\"kind\":1024,\"name\":\"costReportConfig\",\"url\":\"interfaces/BillingStageConfig.html#costReportConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"BillingStageConfig\"},{\"kind\":4194304,\"name\":\"BillingStageProps\",\"url\":\"types/BillingStageProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"BillingStage\",\"url\":\"classes/BillingStage.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BillingStage.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"BillingStage\"},{\"kind\":256,\"name\":\"LogArchiveConfig\",\"url\":\"interfaces/LogArchiveConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"logArchiveAccount\",\"url\":\"interfaces/LogArchiveConfig.html#logArchiveAccount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LogArchiveConfig\"},{\"kind\":4194304,\"name\":\"LogArchiveStageProps\",\"url\":\"types/LogArchiveStageProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"LogArchiveStage\",\"url\":\"classes/LogArchiveStage.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/LogArchiveStage.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"LogArchiveStage\"},{\"kind\":4194304,\"name\":\"ControlTowerPipelineProps\",\"url\":\"types/ControlTowerPipelineProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"ControlTowerPipeline\",\"url\":\"classes/ControlTowerPipeline.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/ControlTowerPipeline.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":1024,\"name\":\"pipeline\",\"url\":\"classes/ControlTowerPipeline.html#pipeline\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/ControlTowerPipeline.html#repository\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":1024,\"name\":\"props\",\"url\":\"classes/ControlTowerPipeline.html#props\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addStage\",\"url\":\"classes/ControlTowerPipeline.html#addStage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addSsoConfig\",\"url\":\"classes/ControlTowerPipeline.html#addSsoConfig\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addBillingConfig\",\"url\":\"classes/ControlTowerPipeline.html#addBillingConfig\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addLogArchive\",\"url\":\"classes/ControlTowerPipeline.html#addLogArchive\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":256,\"name\":\"SsoStageConfig\",\"url\":\"interfaces/SsoStageConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"permissionsConfiguration\",\"url\":\"interfaces/SsoStageConfig.html#permissionsConfiguration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoStageConfig\"},{\"kind\":4194304,\"name\":\"SsoStageProps\",\"url\":\"types/SsoStageProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"SsoStage\",\"url\":\"classes/SsoStage.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SsoStage.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"SsoStage\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,41.378]],[\"comment/0\",[]],[\"name/1\",[1,41.378]],[\"comment/1\",[]],[\"name/2\",[2,41.378]],[\"comment/2\",[]],[\"name/3\",[3,41.378]],[\"comment/3\",[]],[\"name/4\",[4,41.378]],[\"comment/4\",[]],[\"name/5\",[5,36.27]],[\"comment/5\",[]],[\"name/6\",[6,41.378]],[\"comment/6\",[]],[\"name/7\",[7,41.378]],[\"comment/7\",[]],[\"name/8\",[8,41.378]],[\"comment/8\",[]],[\"name/9\",[9,41.378]],[\"comment/9\",[]],[\"name/10\",[10,41.378]],[\"comment/10\",[]],[\"name/11\",[11,41.378]],[\"comment/11\",[]],[\"name/12\",[12,41.378]],[\"comment/12\",[]],[\"name/13\",[13,41.378]],[\"comment/13\",[]],[\"name/14\",[14,41.378]],[\"comment/14\",[]],[\"name/15\",[15,41.378]],[\"comment/15\",[]],[\"name/16\",[16,41.378]],[\"comment/16\",[]],[\"name/17\",[17,36.27]],[\"comment/17\",[]],[\"name/18\",[18,41.378]],[\"comment/18\",[]],[\"name/19\",[19,36.27]],[\"comment/19\",[]],[\"name/20\",[20,41.378]],[\"comment/20\",[]],[\"name/21\",[21,41.378]],[\"comment/21\",[]],[\"name/22\",[22,41.378]],[\"comment/22\",[]],[\"name/23\",[23,41.378]],[\"comment/23\",[]],[\"name/24\",[24,41.378]],[\"comment/24\",[]],[\"name/25\",[25,41.378]],[\"comment/25\",[]],[\"name/26\",[26,36.27]],[\"comment/26\",[]],[\"name/27\",[27,41.378]],[\"comment/27\",[]],[\"name/28\",[19,36.27]],[\"comment/28\",[]],[\"name/29\",[26,36.27]],[\"comment/29\",[]],[\"name/30\",[28,41.378]],[\"comment/30\",[]],[\"name/31\",[29,41.378]],[\"comment/31\",[]],[\"name/32\",[30,24.032]],[\"comment/32\",[]],[\"name/33\",[31,41.378]],[\"comment/33\",[]],[\"name/34\",[32,41.378]],[\"comment/34\",[]],[\"name/35\",[33,41.378]],[\"comment/35\",[]],[\"name/36\",[5,36.27]],[\"comment/36\",[]],[\"name/37\",[34,36.27]],[\"comment/37\",[]],[\"name/38\",[35,41.378]],[\"comment/38\",[]],[\"name/39\",[36,41.378]],[\"comment/39\",[]],[\"name/40\",[37,41.378]],[\"comment/40\",[]],[\"name/41\",[30,24.032]],[\"comment/41\",[]],[\"name/42\",[38,41.378]],[\"comment/42\",[]],[\"name/43\",[39,41.378]],[\"comment/43\",[]],[\"name/44\",[40,41.378]],[\"comment/44\",[]],[\"name/45\",[41,41.378]],[\"comment/45\",[]],[\"name/46\",[42,41.378]],[\"comment/46\",[]],[\"name/47\",[30,24.032]],[\"comment/47\",[]],[\"name/48\",[43,41.378]],[\"comment/48\",[]],[\"name/49\",[17,36.27]],[\"comment/49\",[]],[\"name/50\",[44,41.378]],[\"comment/50\",[]],[\"name/51\",[45,41.378]],[\"comment/51\",[]],[\"name/52\",[46,41.378]],[\"comment/52\",[]],[\"name/53\",[47,41.378]],[\"comment/53\",[]],[\"name/54\",[48,41.378]],[\"comment/54\",[]],[\"name/55\",[49,41.378]],[\"comment/55\",[]],[\"name/56\",[50,41.378]],[\"comment/56\",[]],[\"name/57\",[51,41.378]],[\"comment/57\",[]],[\"name/58\",[52,41.378]],[\"comment/58\",[]],[\"name/59\",[53,36.27]],[\"comment/59\",[]],[\"name/60\",[54,36.27]],[\"comment/60\",[]],[\"name/61\",[55,41.378]],[\"comment/61\",[]],[\"name/62\",[56,41.378]],[\"comment/62\",[]],[\"name/63\",[57,41.378]],[\"comment/63\",[]],[\"name/64\",[30,24.032]],[\"comment/64\",[]],[\"name/65\",[53,36.27]],[\"comment/65\",[]],[\"name/66\",[54,36.27]],[\"comment/66\",[]],[\"name/67\",[58,41.378]],[\"comment/67\",[]],[\"name/68\",[34,36.27]],[\"comment/68\",[]],[\"name/69\",[59,41.378]],[\"comment/69\",[]],[\"name/70\",[60,41.378]],[\"comment/70\",[]],[\"name/71\",[61,41.378]],[\"comment/71\",[]],[\"name/72\",[30,24.032]],[\"comment/72\",[]],[\"name/73\",[62,41.378]],[\"comment/73\",[]],[\"name/74\",[63,41.378]],[\"comment/74\",[]],[\"name/75\",[64,41.378]],[\"comment/75\",[]],[\"name/76\",[65,41.378]],[\"comment/76\",[]],[\"name/77\",[30,24.032]],[\"comment/77\",[]],[\"name/78\",[66,41.378]],[\"comment/78\",[]],[\"name/79\",[67,41.378]],[\"comment/79\",[]],[\"name/80\",[30,24.032]],[\"comment/80\",[]],[\"name/81\",[68,41.378]],[\"comment/81\",[]],[\"name/82\",[69,41.378]],[\"comment/82\",[]],[\"name/83\",[70,41.378]],[\"comment/83\",[]],[\"name/84\",[71,41.378]],[\"comment/84\",[]],[\"name/85\",[72,41.378]],[\"comment/85\",[]],[\"name/86\",[73,41.378]],[\"comment/86\",[]],[\"name/87\",[74,41.378]],[\"comment/87\",[]],[\"name/88\",[75,41.378]],[\"comment/88\",[]],[\"name/89\",[76,41.378]],[\"comment/89\",[]],[\"name/90\",[77,41.378]],[\"comment/90\",[]],[\"name/91\",[78,41.378]],[\"comment/91\",[]],[\"name/92\",[30,24.032]],[\"comment/92\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":54,\"name\":{\"60\":{},\"66\":{}},\"comment\":{}}],[\"accountbudgetoptions\",{\"_index\":32,\"name\":{\"34\":{}},\"comment\":{}}],[\"accountconfig\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"accountinfo\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"accountlist\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"accounts\",{\"_index\":26,\"name\":{\"26\":{},\"29\":{}},\"comment\":{}}],[\"addbillingconfig\",{\"_index\":73,\"name\":{\"86\":{}},\"comment\":{}}],[\"addlogarchive\",{\"_index\":74,\"name\":{\"87\":{}},\"comment\":{}}],[\"addssoconfig\",{\"_index\":72,\"name\":{\"85\":{}},\"comment\":{}}],[\"addstage\",{\"_index\":71,\"name\":{\"84\":{}},\"comment\":{}}],[\"adminsetoptions\",{\"_index\":50,\"name\":{\"56\":{}},\"comment\":{}}],[\"amount\",{\"_index\":33,\"name\":{\"35\":{}},\"comment\":{}}],[\"arn\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"billingsetoptions\",{\"_index\":52,\"name\":{\"58\":{}},\"comment\":{}}],[\"billingstage\",{\"_index\":61,\"name\":{\"71\":{}},\"comment\":{}}],[\"billingstageconfig\",{\"_index\":58,\"name\":{\"67\":{}},\"comment\":{}}],[\"billingstageprops\",{\"_index\":60,\"name\":{\"70\":{}},\"comment\":{}}],[\"budgetconfig\",{\"_index\":34,\"name\":{\"37\":{},\"68\":{}},\"comment\":{}}],[\"budgets\",{\"_index\":35,\"name\":{\"38\":{}},\"comment\":{}}],[\"budgetstack\",{\"_index\":37,\"name\":{\"40\":{}},\"comment\":{}}],[\"budgetstackprops\",{\"_index\":36,\"name\":{\"39\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":30,\"name\":{\"32\":{},\"41\":{},\"47\":{},\"64\":{},\"72\":{},\"77\":{},\"80\":{},\"92\":{}},\"comment\":{}}],[\"controltowerpipeline\",{\"_index\":67,\"name\":{\"79\":{}},\"comment\":{}}],[\"controltowerpipelineprops\",{\"_index\":66,\"name\":{\"78\":{}},\"comment\":{}}],[\"controltowerprops\",{\"_index\":25,\"name\":{\"25\":{}},\"comment\":{}}],[\"costreportbucketname\",{\"_index\":39,\"name\":{\"43\":{}},\"comment\":{}}],[\"costreportconfig\",{\"_index\":59,\"name\":{\"69\":{}},\"comment\":{}}],[\"costreportingconfig\",{\"_index\":38,\"name\":{\"42\":{}},\"comment\":{}}],[\"costreportingstack\",{\"_index\":42,\"name\":{\"46\":{}},\"comment\":{}}],[\"costreportingstackprops\",{\"_index\":41,\"name\":{\"45\":{}},\"comment\":{}}],[\"costreportname\",{\"_index\":40,\"name\":{\"44\":{}},\"comment\":{}}],[\"defaultassignmentsfornewaccount\",{\"_index\":55,\"name\":{\"61\":{}},\"comment\":{}}],[\"description\",{\"_index\":17,\"name\":{\"17\":{},\"49\":{}},\"comment\":{}}],[\"displayname\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"email\",{\"_index\":5,\"name\":{\"5\":{},\"36\":{}},\"comment\":{}}],[\"externalids\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"flowlogsbucketname\",{\"_index\":31,\"name\":{\"33\":{}},\"comment\":{}}],[\"generateaccountfile\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"generatessoconfigfile\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"groupconfig\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"groupid\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"groupinfo\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"grouplist\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"grouppermissions\",{\"_index\":49,\"name\":{\"55\":{}},\"comment\":{}}],[\"groups\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"id\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"identitystoreid\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"inlinepolicy\",{\"_index\":44,\"name\":{\"50\":{}},\"comment\":{}}],[\"instancearn\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"joinedmethod\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"joinedtimestamp\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"logarchiveaccount\",{\"_index\":63,\"name\":{\"74\":{}},\"comment\":{}}],[\"logarchiveconfig\",{\"_index\":62,\"name\":{\"73\":{}},\"comment\":{}}],[\"logarchivestage\",{\"_index\":65,\"name\":{\"76\":{}},\"comment\":{}}],[\"logarchivestageprops\",{\"_index\":64,\"name\":{\"75\":{}},\"comment\":{}}],[\"logbucketstack\",{\"_index\":29,\"name\":{\"31\":{}},\"comment\":{}}],[\"logbucketstackprops\",{\"_index\":28,\"name\":{\"30\":{}},\"comment\":{}}],[\"managedpolicies\",{\"_index\":45,\"name\":{\"51\":{}},\"comment\":{}}],[\"name\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"orgprincipalaware\",{\"_index\":23,\"name\":{\"23\":{}},\"comment\":{}}],[\"orgprincipalenv\",{\"_index\":24,\"name\":{\"24\":{}},\"comment\":{}}],[\"permissionsconfiguration\",{\"_index\":76,\"name\":{\"89\":{}},\"comment\":{}}],[\"permissionsetoptions\",{\"_index\":43,\"name\":{\"48\":{}},\"comment\":{}}],[\"permissionsets\",{\"_index\":53,\"name\":{\"59\":{},\"65\":{}},\"comment\":{}}],[\"pipeline\",{\"_index\":68,\"name\":{\"81\":{}},\"comment\":{}}],[\"props\",{\"_index\":70,\"name\":{\"83\":{}},\"comment\":{}}],[\"readonlysetoptions\",{\"_index\":51,\"name\":{\"57\":{}},\"comment\":{}}],[\"relaystatetype\",{\"_index\":47,\"name\":{\"53\":{}},\"comment\":{}}],[\"repository\",{\"_index\":69,\"name\":{\"82\":{}},\"comment\":{}}],[\"sessionduration\",{\"_index\":46,\"name\":{\"52\":{}},\"comment\":{}}],[\"ssoconfig\",{\"_index\":19,\"name\":{\"19\":{},\"28\":{}},\"comment\":{}}],[\"ssopermissionconfig\",{\"_index\":48,\"name\":{\"54\":{}},\"comment\":{}}],[\"ssopermissionstack\",{\"_index\":57,\"name\":{\"63\":{}},\"comment\":{}}],[\"ssopermissionstackprops\",{\"_index\":56,\"name\":{\"62\":{}},\"comment\":{}}],[\"ssoprops\",{\"_index\":27,\"name\":{\"27\":{}},\"comment\":{}}],[\"ssostage\",{\"_index\":78,\"name\":{\"91\":{}},\"comment\":{}}],[\"ssostageconfig\",{\"_index\":75,\"name\":{\"88\":{}},\"comment\":{}}],[\"ssostageprops\",{\"_index\":77,\"name\":{\"90\":{}},\"comment\":{}}],[\"status\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"rows\":[{\"kind\":64,\"name\":\"generateAccountFile\",\"url\":\"functions/generateAccountFile.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"generateSsoConfigFile\",\"url\":\"functions/generateSsoConfigFile.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"AccountInfo\",\"url\":\"interfaces/AccountInfo.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"Id\",\"url\":\"interfaces/AccountInfo.html#Id\",\"classes\":\"\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"interfaces/AccountInfo.html#Name\",\"classes\":\"\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Email\",\"url\":\"interfaces/AccountInfo.html#Email\",\"classes\":\"\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Arn\",\"url\":\"interfaces/AccountInfo.html#Arn\",\"classes\":\"\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"JoinedMethod\",\"url\":\"interfaces/AccountInfo.html#JoinedMethod\",\"classes\":\"\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"JoinedTimestamp\",\"url\":\"interfaces/AccountInfo.html#JoinedTimestamp\",\"classes\":\"\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Status\",\"url\":\"interfaces/AccountInfo.html#Status\",\"classes\":\"\",\"parent\":\"AccountInfo\"},{\"kind\":4194304,\"name\":\"AccountList\",\"url\":\"types/AccountList.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"AccountConfig\",\"url\":\"types/AccountConfig.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"GroupConfig\",\"url\":\"types/GroupConfig.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"GroupInfo\",\"url\":\"interfaces/GroupInfo.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"GroupId\",\"url\":\"interfaces/GroupInfo.html#GroupId\",\"classes\":\"\",\"parent\":\"GroupInfo\"},{\"kind\":1024,\"name\":\"DisplayName\",\"url\":\"interfaces/GroupInfo.html#DisplayName\",\"classes\":\"\",\"parent\":\"GroupInfo\"},{\"kind\":1024,\"name\":\"ExternalIds\",\"url\":\"interfaces/GroupInfo.html#ExternalIds\",\"classes\":\"\",\"parent\":\"GroupInfo\"},{\"kind\":1024,\"name\":\"Description\",\"url\":\"interfaces/GroupInfo.html#Description\",\"classes\":\"\",\"parent\":\"GroupInfo\"},{\"kind\":4194304,\"name\":\"GroupList\",\"url\":\"types/GroupList.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"SsoConfig\",\"url\":\"interfaces/SsoConfig.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"instanceArn\",\"url\":\"interfaces/SsoConfig.html#instanceArn\",\"classes\":\"\",\"parent\":\"SsoConfig\"},{\"kind\":1024,\"name\":\"identityStoreId\",\"url\":\"interfaces/SsoConfig.html#identityStoreId\",\"classes\":\"\",\"parent\":\"SsoConfig\"},{\"kind\":1024,\"name\":\"groups\",\"url\":\"interfaces/SsoConfig.html#groups\",\"classes\":\"\",\"parent\":\"SsoConfig\"},{\"kind\":256,\"name\":\"OrgPrincipalAware\",\"url\":\"interfaces/OrgPrincipalAware.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"orgPrincipalEnv\",\"url\":\"interfaces/OrgPrincipalAware.html#orgPrincipalEnv\",\"classes\":\"\",\"parent\":\"OrgPrincipalAware\"},{\"kind\":256,\"name\":\"ControlTowerProps\",\"url\":\"interfaces/ControlTowerProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"accounts\",\"url\":\"interfaces/ControlTowerProps.html#accounts\",\"classes\":\"\",\"parent\":\"ControlTowerProps\"},{\"kind\":256,\"name\":\"SsoProps\",\"url\":\"interfaces/SsoProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"ssoConfig\",\"url\":\"interfaces/SsoProps.html#ssoConfig\",\"classes\":\"\",\"parent\":\"SsoProps\"},{\"kind\":1024,\"name\":\"accounts\",\"url\":\"interfaces/SsoProps.html#accounts\",\"classes\":\"tsd-is-inherited\",\"parent\":\"SsoProps\"},{\"kind\":4194304,\"name\":\"LogBucketStackProps\",\"url\":\"types/LogBucketStackProps.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"LogBucketStack\",\"url\":\"classes/LogBucketStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/LogBucketStack.html#constructor\",\"classes\":\"\",\"parent\":\"LogBucketStack\"},{\"kind\":1024,\"name\":\"flowLogsBucketName\",\"url\":\"classes/LogBucketStack.html#flowLogsBucketName\",\"classes\":\"\",\"parent\":\"LogBucketStack\"},{\"kind\":256,\"name\":\"AccountBudgetOptions\",\"url\":\"interfaces/AccountBudgetOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"amount\",\"url\":\"interfaces/AccountBudgetOptions.html#amount\",\"classes\":\"\",\"parent\":\"AccountBudgetOptions\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"interfaces/AccountBudgetOptions.html#email\",\"classes\":\"\",\"parent\":\"AccountBudgetOptions\"},{\"kind\":256,\"name\":\"BudgetConfig\",\"url\":\"interfaces/BudgetConfig.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"budgets\",\"url\":\"interfaces/BudgetConfig.html#budgets\",\"classes\":\"\",\"parent\":\"BudgetConfig\"},{\"kind\":4194304,\"name\":\"BudgetStackProps\",\"url\":\"types/BudgetStackProps.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"BudgetStack\",\"url\":\"classes/BudgetStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BudgetStack.html#constructor\",\"classes\":\"\",\"parent\":\"BudgetStack\"},{\"kind\":256,\"name\":\"CostReportingConfig\",\"url\":\"interfaces/CostReportingConfig.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"costReportBucketName\",\"url\":\"interfaces/CostReportingConfig.html#costReportBucketName\",\"classes\":\"\",\"parent\":\"CostReportingConfig\"},{\"kind\":1024,\"name\":\"costReportName\",\"url\":\"interfaces/CostReportingConfig.html#costReportName\",\"classes\":\"\",\"parent\":\"CostReportingConfig\"},{\"kind\":4194304,\"name\":\"CostReportingStackProps\",\"url\":\"types/CostReportingStackProps.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"CostReportingStack\",\"url\":\"classes/CostReportingStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/CostReportingStack.html#constructor\",\"classes\":\"\",\"parent\":\"CostReportingStack\"},{\"kind\":256,\"name\":\"PermissionSetOptions\",\"url\":\"interfaces/PermissionSetOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"interfaces/PermissionSetOptions.html#description\",\"classes\":\"\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"inlinePolicy\",\"url\":\"interfaces/PermissionSetOptions.html#inlinePolicy\",\"classes\":\"\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"managedPolicies\",\"url\":\"interfaces/PermissionSetOptions.html#managedPolicies\",\"classes\":\"\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"sessionDuration\",\"url\":\"interfaces/PermissionSetOptions.html#sessionDuration\",\"classes\":\"\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"relayStateType\",\"url\":\"interfaces/PermissionSetOptions.html#relayStateType\",\"classes\":\"\",\"parent\":\"PermissionSetOptions\"},{\"kind\":256,\"name\":\"SsoPermissionConfig\",\"url\":\"interfaces/SsoPermissionConfig.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"groupPermissions\",\"url\":\"interfaces/SsoPermissionConfig.html#groupPermissions\",\"classes\":\"\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"adminSetOptions\",\"url\":\"interfaces/SsoPermissionConfig.html#adminSetOptions\",\"classes\":\"\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"readOnlySetOptions\",\"url\":\"interfaces/SsoPermissionConfig.html#readOnlySetOptions\",\"classes\":\"\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"billingSetOptions\",\"url\":\"interfaces/SsoPermissionConfig.html#billingSetOptions\",\"classes\":\"\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"permissionSets\",\"url\":\"interfaces/SsoPermissionConfig.html#permissionSets\",\"classes\":\"\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/SsoPermissionConfig.html#permissionSets.__type\",\"classes\":\"\",\"parent\":\"SsoPermissionConfig.permissionSets\"},{\"kind\":1024,\"name\":\"defaultAssignmentsForNewAccount\",\"url\":\"interfaces/SsoPermissionConfig.html#defaultAssignmentsForNewAccount\",\"classes\":\"\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":4194304,\"name\":\"SsoPermissionStackProps\",\"url\":\"types/SsoPermissionStackProps.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"SsoPermissionStack\",\"url\":\"classes/SsoPermissionStack.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SsoPermissionStack.html#constructor\",\"classes\":\"\",\"parent\":\"SsoPermissionStack\"},{\"kind\":1024,\"name\":\"permissionSets\",\"url\":\"classes/SsoPermissionStack.html#permissionSets\",\"classes\":\"tsd-is-private\",\"parent\":\"SsoPermissionStack\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/SsoPermissionStack.html#permissionSets.__type\",\"classes\":\"\",\"parent\":\"SsoPermissionStack.permissionSets\"},{\"kind\":256,\"name\":\"BillingStageConfig\",\"url\":\"interfaces/BillingStageConfig.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"budgetConfig\",\"url\":\"interfaces/BillingStageConfig.html#budgetConfig\",\"classes\":\"\",\"parent\":\"BillingStageConfig\"},{\"kind\":1024,\"name\":\"costReportConfig\",\"url\":\"interfaces/BillingStageConfig.html#costReportConfig\",\"classes\":\"\",\"parent\":\"BillingStageConfig\"},{\"kind\":4194304,\"name\":\"BillingStageProps\",\"url\":\"types/BillingStageProps.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"BillingStage\",\"url\":\"classes/BillingStage.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BillingStage.html#constructor\",\"classes\":\"\",\"parent\":\"BillingStage\"},{\"kind\":256,\"name\":\"LogArchiveConfig\",\"url\":\"interfaces/LogArchiveConfig.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"logArchiveAccount\",\"url\":\"interfaces/LogArchiveConfig.html#logArchiveAccount\",\"classes\":\"\",\"parent\":\"LogArchiveConfig\"},{\"kind\":4194304,\"name\":\"LogArchiveStageProps\",\"url\":\"types/LogArchiveStageProps.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"LogArchiveStage\",\"url\":\"classes/LogArchiveStage.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/LogArchiveStage.html#constructor\",\"classes\":\"\",\"parent\":\"LogArchiveStage\"},{\"kind\":4194304,\"name\":\"ControlTowerPipelineProps\",\"url\":\"types/ControlTowerPipelineProps.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"ControlTowerPipeline\",\"url\":\"classes/ControlTowerPipeline.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/ControlTowerPipeline.html#constructor\",\"classes\":\"\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":1024,\"name\":\"pipeline\",\"url\":\"classes/ControlTowerPipeline.html#pipeline\",\"classes\":\"\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/ControlTowerPipeline.html#repository\",\"classes\":\"\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":1024,\"name\":\"props\",\"url\":\"classes/ControlTowerPipeline.html#props\",\"classes\":\"tsd-is-private\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addStage\",\"url\":\"classes/ControlTowerPipeline.html#addStage\",\"classes\":\"\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addSsoConfig\",\"url\":\"classes/ControlTowerPipeline.html#addSsoConfig\",\"classes\":\"\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addBillingConfig\",\"url\":\"classes/ControlTowerPipeline.html#addBillingConfig\",\"classes\":\"\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addLogArchive\",\"url\":\"classes/ControlTowerPipeline.html#addLogArchive\",\"classes\":\"\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":256,\"name\":\"SsoStageConfig\",\"url\":\"interfaces/SsoStageConfig.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"permissionsConfiguration\",\"url\":\"interfaces/SsoStageConfig.html#permissionsConfiguration\",\"classes\":\"\",\"parent\":\"SsoStageConfig\"},{\"kind\":4194304,\"name\":\"SsoStageProps\",\"url\":\"types/SsoStageProps.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"SsoStage\",\"url\":\"classes/SsoStage.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SsoStage.html#constructor\",\"classes\":\"\",\"parent\":\"SsoStage\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,41.378]],[\"comment/0\",[]],[\"name/1\",[1,41.378]],[\"comment/1\",[]],[\"name/2\",[2,41.378]],[\"comment/2\",[]],[\"name/3\",[3,41.378]],[\"comment/3\",[]],[\"name/4\",[4,41.378]],[\"comment/4\",[]],[\"name/5\",[5,36.27]],[\"comment/5\",[]],[\"name/6\",[6,41.378]],[\"comment/6\",[]],[\"name/7\",[7,41.378]],[\"comment/7\",[]],[\"name/8\",[8,41.378]],[\"comment/8\",[]],[\"name/9\",[9,41.378]],[\"comment/9\",[]],[\"name/10\",[10,41.378]],[\"comment/10\",[]],[\"name/11\",[11,41.378]],[\"comment/11\",[]],[\"name/12\",[12,41.378]],[\"comment/12\",[]],[\"name/13\",[13,41.378]],[\"comment/13\",[]],[\"name/14\",[14,41.378]],[\"comment/14\",[]],[\"name/15\",[15,41.378]],[\"comment/15\",[]],[\"name/16\",[16,41.378]],[\"comment/16\",[]],[\"name/17\",[17,36.27]],[\"comment/17\",[]],[\"name/18\",[18,41.378]],[\"comment/18\",[]],[\"name/19\",[19,36.27]],[\"comment/19\",[]],[\"name/20\",[20,41.378]],[\"comment/20\",[]],[\"name/21\",[21,41.378]],[\"comment/21\",[]],[\"name/22\",[22,41.378]],[\"comment/22\",[]],[\"name/23\",[23,41.378]],[\"comment/23\",[]],[\"name/24\",[24,41.378]],[\"comment/24\",[]],[\"name/25\",[25,41.378]],[\"comment/25\",[]],[\"name/26\",[26,36.27]],[\"comment/26\",[]],[\"name/27\",[27,41.378]],[\"comment/27\",[]],[\"name/28\",[19,36.27]],[\"comment/28\",[]],[\"name/29\",[26,36.27]],[\"comment/29\",[]],[\"name/30\",[28,41.378]],[\"comment/30\",[]],[\"name/31\",[29,41.378]],[\"comment/31\",[]],[\"name/32\",[30,24.032]],[\"comment/32\",[]],[\"name/33\",[31,41.378]],[\"comment/33\",[]],[\"name/34\",[32,41.378]],[\"comment/34\",[]],[\"name/35\",[33,41.378]],[\"comment/35\",[]],[\"name/36\",[5,36.27]],[\"comment/36\",[]],[\"name/37\",[34,36.27]],[\"comment/37\",[]],[\"name/38\",[35,41.378]],[\"comment/38\",[]],[\"name/39\",[36,41.378]],[\"comment/39\",[]],[\"name/40\",[37,41.378]],[\"comment/40\",[]],[\"name/41\",[30,24.032]],[\"comment/41\",[]],[\"name/42\",[38,41.378]],[\"comment/42\",[]],[\"name/43\",[39,41.378]],[\"comment/43\",[]],[\"name/44\",[40,41.378]],[\"comment/44\",[]],[\"name/45\",[41,41.378]],[\"comment/45\",[]],[\"name/46\",[42,41.378]],[\"comment/46\",[]],[\"name/47\",[30,24.032]],[\"comment/47\",[]],[\"name/48\",[43,41.378]],[\"comment/48\",[]],[\"name/49\",[17,36.27]],[\"comment/49\",[]],[\"name/50\",[44,41.378]],[\"comment/50\",[]],[\"name/51\",[45,41.378]],[\"comment/51\",[]],[\"name/52\",[46,41.378]],[\"comment/52\",[]],[\"name/53\",[47,41.378]],[\"comment/53\",[]],[\"name/54\",[48,41.378]],[\"comment/54\",[]],[\"name/55\",[49,41.378]],[\"comment/55\",[]],[\"name/56\",[50,41.378]],[\"comment/56\",[]],[\"name/57\",[51,41.378]],[\"comment/57\",[]],[\"name/58\",[52,41.378]],[\"comment/58\",[]],[\"name/59\",[53,36.27]],[\"comment/59\",[]],[\"name/60\",[54,36.27]],[\"comment/60\",[]],[\"name/61\",[55,41.378]],[\"comment/61\",[]],[\"name/62\",[56,41.378]],[\"comment/62\",[]],[\"name/63\",[57,41.378]],[\"comment/63\",[]],[\"name/64\",[30,24.032]],[\"comment/64\",[]],[\"name/65\",[53,36.27]],[\"comment/65\",[]],[\"name/66\",[54,36.27]],[\"comment/66\",[]],[\"name/67\",[58,41.378]],[\"comment/67\",[]],[\"name/68\",[34,36.27]],[\"comment/68\",[]],[\"name/69\",[59,41.378]],[\"comment/69\",[]],[\"name/70\",[60,41.378]],[\"comment/70\",[]],[\"name/71\",[61,41.378]],[\"comment/71\",[]],[\"name/72\",[30,24.032]],[\"comment/72\",[]],[\"name/73\",[62,41.378]],[\"comment/73\",[]],[\"name/74\",[63,41.378]],[\"comment/74\",[]],[\"name/75\",[64,41.378]],[\"comment/75\",[]],[\"name/76\",[65,41.378]],[\"comment/76\",[]],[\"name/77\",[30,24.032]],[\"comment/77\",[]],[\"name/78\",[66,41.378]],[\"comment/78\",[]],[\"name/79\",[67,41.378]],[\"comment/79\",[]],[\"name/80\",[30,24.032]],[\"comment/80\",[]],[\"name/81\",[68,41.378]],[\"comment/81\",[]],[\"name/82\",[69,41.378]],[\"comment/82\",[]],[\"name/83\",[70,41.378]],[\"comment/83\",[]],[\"name/84\",[71,41.378]],[\"comment/84\",[]],[\"name/85\",[72,41.378]],[\"comment/85\",[]],[\"name/86\",[73,41.378]],[\"comment/86\",[]],[\"name/87\",[74,41.378]],[\"comment/87\",[]],[\"name/88\",[75,41.378]],[\"comment/88\",[]],[\"name/89\",[76,41.378]],[\"comment/89\",[]],[\"name/90\",[77,41.378]],[\"comment/90\",[]],[\"name/91\",[78,41.378]],[\"comment/91\",[]],[\"name/92\",[30,24.032]],[\"comment/92\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":54,\"name\":{\"60\":{},\"66\":{}},\"comment\":{}}],[\"accountbudgetoptions\",{\"_index\":32,\"name\":{\"34\":{}},\"comment\":{}}],[\"accountconfig\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"accountinfo\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"accountlist\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"accounts\",{\"_index\":26,\"name\":{\"26\":{},\"29\":{}},\"comment\":{}}],[\"addbillingconfig\",{\"_index\":73,\"name\":{\"86\":{}},\"comment\":{}}],[\"addlogarchive\",{\"_index\":74,\"name\":{\"87\":{}},\"comment\":{}}],[\"addssoconfig\",{\"_index\":72,\"name\":{\"85\":{}},\"comment\":{}}],[\"addstage\",{\"_index\":71,\"name\":{\"84\":{}},\"comment\":{}}],[\"adminsetoptions\",{\"_index\":50,\"name\":{\"56\":{}},\"comment\":{}}],[\"amount\",{\"_index\":33,\"name\":{\"35\":{}},\"comment\":{}}],[\"arn\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"billingsetoptions\",{\"_index\":52,\"name\":{\"58\":{}},\"comment\":{}}],[\"billingstage\",{\"_index\":61,\"name\":{\"71\":{}},\"comment\":{}}],[\"billingstageconfig\",{\"_index\":58,\"name\":{\"67\":{}},\"comment\":{}}],[\"billingstageprops\",{\"_index\":60,\"name\":{\"70\":{}},\"comment\":{}}],[\"budgetconfig\",{\"_index\":34,\"name\":{\"37\":{},\"68\":{}},\"comment\":{}}],[\"budgets\",{\"_index\":35,\"name\":{\"38\":{}},\"comment\":{}}],[\"budgetstack\",{\"_index\":37,\"name\":{\"40\":{}},\"comment\":{}}],[\"budgetstackprops\",{\"_index\":36,\"name\":{\"39\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":30,\"name\":{\"32\":{},\"41\":{},\"47\":{},\"64\":{},\"72\":{},\"77\":{},\"80\":{},\"92\":{}},\"comment\":{}}],[\"controltowerpipeline\",{\"_index\":67,\"name\":{\"79\":{}},\"comment\":{}}],[\"controltowerpipelineprops\",{\"_index\":66,\"name\":{\"78\":{}},\"comment\":{}}],[\"controltowerprops\",{\"_index\":25,\"name\":{\"25\":{}},\"comment\":{}}],[\"costreportbucketname\",{\"_index\":39,\"name\":{\"43\":{}},\"comment\":{}}],[\"costreportconfig\",{\"_index\":59,\"name\":{\"69\":{}},\"comment\":{}}],[\"costreportingconfig\",{\"_index\":38,\"name\":{\"42\":{}},\"comment\":{}}],[\"costreportingstack\",{\"_index\":42,\"name\":{\"46\":{}},\"comment\":{}}],[\"costreportingstackprops\",{\"_index\":41,\"name\":{\"45\":{}},\"comment\":{}}],[\"costreportname\",{\"_index\":40,\"name\":{\"44\":{}},\"comment\":{}}],[\"defaultassignmentsfornewaccount\",{\"_index\":55,\"name\":{\"61\":{}},\"comment\":{}}],[\"description\",{\"_index\":17,\"name\":{\"17\":{},\"49\":{}},\"comment\":{}}],[\"displayname\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"email\",{\"_index\":5,\"name\":{\"5\":{},\"36\":{}},\"comment\":{}}],[\"externalids\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"flowlogsbucketname\",{\"_index\":31,\"name\":{\"33\":{}},\"comment\":{}}],[\"generateaccountfile\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"generatessoconfigfile\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"groupconfig\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"groupid\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"groupinfo\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"grouplist\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"grouppermissions\",{\"_index\":49,\"name\":{\"55\":{}},\"comment\":{}}],[\"groups\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"id\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"identitystoreid\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"inlinepolicy\",{\"_index\":44,\"name\":{\"50\":{}},\"comment\":{}}],[\"instancearn\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"joinedmethod\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"joinedtimestamp\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"logarchiveaccount\",{\"_index\":63,\"name\":{\"74\":{}},\"comment\":{}}],[\"logarchiveconfig\",{\"_index\":62,\"name\":{\"73\":{}},\"comment\":{}}],[\"logarchivestage\",{\"_index\":65,\"name\":{\"76\":{}},\"comment\":{}}],[\"logarchivestageprops\",{\"_index\":64,\"name\":{\"75\":{}},\"comment\":{}}],[\"logbucketstack\",{\"_index\":29,\"name\":{\"31\":{}},\"comment\":{}}],[\"logbucketstackprops\",{\"_index\":28,\"name\":{\"30\":{}},\"comment\":{}}],[\"managedpolicies\",{\"_index\":45,\"name\":{\"51\":{}},\"comment\":{}}],[\"name\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"orgprincipalaware\",{\"_index\":23,\"name\":{\"23\":{}},\"comment\":{}}],[\"orgprincipalenv\",{\"_index\":24,\"name\":{\"24\":{}},\"comment\":{}}],[\"permissionsconfiguration\",{\"_index\":76,\"name\":{\"89\":{}},\"comment\":{}}],[\"permissionsetoptions\",{\"_index\":43,\"name\":{\"48\":{}},\"comment\":{}}],[\"permissionsets\",{\"_index\":53,\"name\":{\"59\":{},\"65\":{}},\"comment\":{}}],[\"pipeline\",{\"_index\":68,\"name\":{\"81\":{}},\"comment\":{}}],[\"props\",{\"_index\":70,\"name\":{\"83\":{}},\"comment\":{}}],[\"readonlysetoptions\",{\"_index\":51,\"name\":{\"57\":{}},\"comment\":{}}],[\"relaystatetype\",{\"_index\":47,\"name\":{\"53\":{}},\"comment\":{}}],[\"repository\",{\"_index\":69,\"name\":{\"82\":{}},\"comment\":{}}],[\"sessionduration\",{\"_index\":46,\"name\":{\"52\":{}},\"comment\":{}}],[\"ssoconfig\",{\"_index\":19,\"name\":{\"19\":{},\"28\":{}},\"comment\":{}}],[\"ssopermissionconfig\",{\"_index\":48,\"name\":{\"54\":{}},\"comment\":{}}],[\"ssopermissionstack\",{\"_index\":57,\"name\":{\"63\":{}},\"comment\":{}}],[\"ssopermissionstackprops\",{\"_index\":56,\"name\":{\"62\":{}},\"comment\":{}}],[\"ssoprops\",{\"_index\":27,\"name\":{\"27\":{}},\"comment\":{}}],[\"ssostage\",{\"_index\":78,\"name\":{\"91\":{}},\"comment\":{}}],[\"ssostageconfig\",{\"_index\":75,\"name\":{\"88\":{}},\"comment\":{}}],[\"ssostageprops\",{\"_index\":77,\"name\":{\"90\":{}},\"comment\":{}}],[\"status\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 496e66f..5b96717 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -6,17 +6,36 @@ --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: #707070; - --light-color-link: #4da6ff; - --light-color-ts: #db1373; - --light-color-ts-interface: #139d2c; - --light-color-ts-enum: #9c891a; - --light-color-ts-class: #2484e5; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --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-namespace: #b111c9; - --light-color-ts-private: #707070; - --light-color-ts-variable: #4d68ff; + --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: var(--light-color-ts-type-alias); + --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); + /* object literal not included as it is not used and will be removed in 0.25 */ + --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; @@ -27,17 +46,36 @@ --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: #ff6492; - --dark-color-ts-interface: #6cff87; + + --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-class: #61b0ff; - --dark-color-ts-function: #9772ff; - --dark-color-ts-namespace: #e14dff; - --dark-color-ts-private: #e2e2e2; - --dark-color-ts-variable: #4d68ff; + --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: var(--dark-color-ts-type-alias); + --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); + /* object literal not included as it is not used and will be removed in 0.25 */ + --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; } @@ -50,17 +88,34 @@ --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: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-function: var(--light-color-ts-function); + + --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-private: var(--light-color-ts-private); + --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); } @@ -74,17 +129,34 @@ --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: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-function: var(--dark-color-ts-function); + + --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-private: var(--dark-color-ts-private); + --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); } @@ -105,17 +177,34 @@ body { --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: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-function: var(--light-color-ts-function); + + --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-private: var(--light-color-ts-private); + --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); } @@ -127,17 +216,34 @@ body { --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: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-function: var(--dark-color-ts-function); + + --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-private: var(--dark-color-ts-private); + --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); } @@ -156,6 +262,16 @@ h6 { line-height: 1.2; } +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + h1 { font-size: 1.875rem; margin: 0.67rem 0; @@ -190,12 +306,6 @@ h6 { text-transform: uppercase; } -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - dl, menu, ol, @@ -208,26 +318,10 @@ dd { } .container { - max-width: 1600px; + max-width: 1700px; padding: 0 2rem; } -@media (min-width: 640px) { - .container { - padding: 0 4rem; - } -} -@media (min-width: 1200px) { - .container { - padding: 0 8rem; - } -} -@media (min-width: 1600px) { - .container { - padding: 0 12rem; - } -} - /* Footer */ .tsd-generator { border-top: 1px solid var(--color-accent); @@ -243,26 +337,9 @@ dd { } .container-main { - display: flex; - justify-content: space-between; - position: relative; margin: 0 auto; -} - -.col-4, -.col-8 { - box-sizing: border-box; - float: left; - padding: 2rem 1rem; -} - -.col-4 { - flex: 0 0 25%; -} -.col-8 { - flex: 1 0; - flex-wrap: wrap; - padding-left: 0; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); } @keyframes fade-in { @@ -305,22 +382,6 @@ dd { opacity: 0; } } -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} @keyframes pop-in-from-right { from { transform: translate(100%, 0); @@ -369,13 +430,29 @@ pre { } pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; padding: 10px; - border: 0.1em solid var(--color-accent); + 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; @@ -409,91 +486,6 @@ blockquote { margin: 1em 0; } -@media (max-width: 1024px) { - html .col-content { - float: none; - max-width: 100%; - width: 100%; - padding-top: 3rem; - } - html .col-menu { - 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; - max-width: 25rem; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-menu > *: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 :is(header, footer, .col-content) { - animation: shift-to-left 0.4s; - } - - .to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu :is(header, footer, .col-content) { - animation: unshift-to-left 0.4s; - } - - .from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu :is(header, footer, .col-content) { - transform: translate(-25%, 0); - } - .has-menu .col-menu { - 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%; - } -} - .tsd-breadcrumb { margin: 0; padding: 0; @@ -672,43 +664,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { -o-page-break-inside: avoid; page-break-inside: avoid; } -.tsd-index-panel a, -.tsd-index-panel a.tsd-parent-kind-module { - color: var(--color-ts); -} -.tsd-index-panel a.tsd-parent-kind-interface { - color: var(--color-ts-interface); -} -.tsd-index-panel a.tsd-parent-kind-enum { - color: var(--color-ts-enum); -} -.tsd-index-panel a.tsd-parent-kind-class { - color: var(--color-ts-class); -} -.tsd-index-panel a.tsd-kind-module { - color: var(--color-ts-namespace); -} -.tsd-index-panel a.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-index-panel a.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-index-panel a.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-index-panel a.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-index-panel a.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-index-panel a.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-index-panel a.tsd-is-private { - color: var(--color-ts-private); -} .tsd-flag { display: inline-block; @@ -723,7 +678,7 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } .tsd-anchor { - position: absolute; + position: relative; top: -100px; } @@ -737,108 +692,64 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { margin-bottom: 0; border-bottom: none; } -.tsd-member [data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member [data-tsd-kind="Interface"] { - color: var(--color-ts-interface); -} -.tsd-member [data-tsd-kind="Enum"] { - color: var(--color-ts-enum); -} -.tsd-member [data-tsd-kind="Class"] { - color: var(--color-ts-class); + +.tsd-navigation.settings { + margin: 1rem 0; } -.tsd-member [data-tsd-kind="Private"] { - color: var(--color-ts-private); +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); } - -.tsd-navigation a { - display: block; - margin: 0.4rem 0; - border-left: 2px solid transparent; +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; color: var(--color-text); text-decoration: none; - transition: border-left-color 0.1s; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); } -.tsd-navigation a:hover { +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { text-decoration: underline; } -.tsd-navigation ul { - margin: 0; +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; padding: 0; list-style: none; } -.tsd-navigation li { +.tsd-navigation li, +.tsd-page-navigation li { padding: 0; + max-width: 100%; } - -.tsd-navigation.primary .tsd-accordion-details > ul { - margin-top: 0.75rem; -} -.tsd-navigation.primary a { - padding: 0.75rem 0.5rem; - margin: 0; +.tsd-nested-navigation { + margin-left: 3rem; } -.tsd-navigation.primary ul li a { - margin-left: 0.5rem; +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; } -.tsd-navigation.primary ul li li a { +.tsd-small-nested-navigation { margin-left: 1.5rem; } -.tsd-navigation.primary ul li li li a { - margin-left: 2.5rem; -} -.tsd-navigation.primary ul li li li li a { - margin-left: 3.5rem; -} -.tsd-navigation.primary ul li li li li li a { - margin-left: 4.5rem; -} -.tsd-navigation.primary ul li li li li li li a { - margin-left: 5.5rem; -} -.tsd-navigation.primary li.current > a { - border-left: 0.15rem var(--color-text) solid; -} -.tsd-navigation.primary li.selected > a { - font-weight: bold; - border-left: 0.2rem var(--color-text) solid; -} -.tsd-navigation.primary ul li a:hover { - border-left: 0.2rem var(--color-text-aside) solid; -} -.tsd-navigation.primary li.globals + li > span, -.tsd-navigation.primary li.globals + li > a { - padding-top: 20px; +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; } -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary > ul { - display: inline; - padding-right: 0.5rem; - transition: opacity 0.2s; +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); } -.tsd-navigation.secondary ul li a { - padding-left: 0; -} -.tsd-navigation.secondary ul li li a { - padding-left: 1.1rem; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 2.2rem; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 3.3rem; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 4.4rem; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 5.5rem; + +.tsd-page-navigation ul { + padding-left: 1.75rem; } #tsd-sidebar-links a { @@ -851,41 +762,38 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } a.tsd-index-link { - margin: 0.25rem 0; + 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 > h1, -.tsd-accordion-summary > h2, -.tsd-accordion-summary > h3, -.tsd-accordion-summary > h4, -.tsd-accordion-summary > h5 { - display: inline-flex; +.tsd-accordion-summary { + list-style-type: none; + display: flex; align-items: center; - vertical-align: middle; - margin-bottom: 0; +} +.tsd-accordion-summary, +.tsd-accordion-summary a { user-select: none; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; -} -.tsd-accordion-summary { - display: block; + cursor: pointer; } +.tsd-accordion-summary a { + flex-grow: 1; +} .tsd-accordion-summary > * { margin-top: 0; margin-bottom: 0; padding-top: 0; padding-bottom: 0; } -.tsd-accordion-summary::-webkit-details-marker { - display: none; -} -.tsd-index-accordion .tsd-accordion-summary svg { - margin-right: 0.25rem; +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; } .tsd-index-content > :not(:first-child) { margin-top: 0.75rem; @@ -910,34 +818,6 @@ a.tsd-index-link { margin-right: 0.8rem; } -@media (min-width: 1025px) { - .col-content { - margin: 2rem auto; - } - - .menu-sticky-wrap { - position: sticky; - height: calc(100vh - 2rem); - top: 4rem; - right: 0; - padding: 0 1.5rem; - padding-top: 1rem; - margin-top: 3rem; - transition: 0.3s ease-in-out; - transition-property: top, padding-top, padding, height; - overflow-y: auto; - } - .col-menu { - border-left: 1px solid var(--color-accent); - } - .col-menu--hide { - top: 1rem; - } - .col-menu .tsd-navigation:not(:last-child) { - padding-bottom: 1.75rem; - } -} - .tsd-panel { margin-bottom: 2.5rem; } @@ -1143,7 +1023,7 @@ ul.tsd-type-parameter-list h5 { } .tsd-page-toolbar { - position: fixed; + position: sticky; z-index: 1; top: 0; left: 0; @@ -1183,10 +1063,6 @@ ul.tsd-type-parameter-list h5 { padding: 12px 0; } -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - .tsd-widget { display: inline-block; overflow: hidden; @@ -1214,12 +1090,6 @@ ul.tsd-type-parameter-list h5 { .tsd-widget.menu { display: none; } -@media (max-width: 1024px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } -} input[type="checkbox"] + .tsd-widget:before { background-position: -120px 0; } @@ -1259,6 +1129,78 @@ img { 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); @@ -1277,3 +1219,147 @@ img { 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/classes/BillingStage.html b/docs/classes/BillingStage.html index 5d2cde9..5642172 100644 --- a/docs/classes/BillingStage.html +++ b/docs/classes/BillingStage.html @@ -1,4 +1,4 @@ -BillingStage | @taimos/cdk-controltower
+BillingStage | @taimos/cdk-controltower
-
+

Class BillingStage<T>

-
+

Type Parameters

-
    +
    • -

      T extends string

+

T extends string

Hierarchy

    -
  • Stage +
  • Stage
    • BillingStage
@@ -33,92 +33,92 @@

Constructors

-
+
-

Parameters

-

Returns BillingStage<T>

+

Returns BillingStage<T>

Properties

-
+
-
account?: string
+
account?: string

The default account for all resources defined within this stage.

-
+
-
node: Node
+
node: Node

The tree node.

Stability

stable

-
+
-
parentStage?: Stage
+
parentStage?: Stage

The parent stage or undefined if this is the app. *

-
+
-
region?: string
+
region?: string

The default region for all resources defined within this stage.

-
+
-
stageName: string
+
stageName: string

The name of the stage. Based on names of the parent stages separated by hypens.

Accessors

-
+
-
-
+
-
    +
    • get assetOutdir(): string
    • The cloud assembly asset output directory.

      Returns string

-
+
-
    +
    • get outdir(): string
    • The cloud assembly output directory.

      @@ -147,10 +147,10 @@

      Returns stringInherited from Stage.outdir

Methods

-
+
-
+

Returns CloudAssembly

-
+
-
    - +
      +
    • Returns a string representation of this construct.

      @@ -174,30 +174,29 @@

      Stability

      stable

      Returns string

-
+
-
    - +
      +
    • (deprecated) Checks if x is a construct.

      -

      Returns

      true if x is an object created from a class which extends Construct.

      -

      Deprecated

      use x instanceof Construct instead

      Parameters

      • -
        x: any
        +
        x: any

        Any object.

      -

      Returns x is Construct

-
+
-
    - +
      +
    • Test whether the given construct is a stage.

      @@ -205,13 +204,13 @@
      • -
        x: any
      -

      Returns x is Stage

    +

    Returns x is Stage

-
+
-
    - +
      +
    • Return the stage this construct is contained with, if available. If called on a nested stage, returns its parent.

      @@ -220,13 +219,14 @@
      • -
        construct: IConstruct
      -

      Returns undefined | Stage

    +

    Returns undefined | Stage

- +
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/BudgetStack.html b/docs/classes/BudgetStack.html index a076f06..eed7a48 100644 --- a/docs/classes/BudgetStack.html +++ b/docs/classes/BudgetStack.html @@ -1,4 +1,4 @@ -BudgetStack | @taimos/cdk-controltower
+BudgetStack | @taimos/cdk-controltower

Constructors

-
+
-
    - +
      +
    • -
      +

      Type Parameters

      -
        +
        • -

          T extends string

      +

      T extends string

Parameters

  • -
    scope: Construct
  • +
    scope: Construct
  • -
    id: string
  • +
    id: string
  • -
    props: BudgetStackProps<T>
-

Returns BudgetStack<T>

Properties

-
+
-
account: string
+
account: string

The AWS account into which this stack will be deployed.

This value is resolved according to the following rules:

    @@ -129,15 +129,15 @@
-
+
-
artifactId: string
+
artifactId: string

The ID of the cloud assembly artifact for this stack.

-
+
-
environment: string
+
environment: string

The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

@@ -149,24 +149,24 @@
-
+
-
nestedStackResource?: CfnResource
+
nestedStackResource?: CfnResource

If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

-
+
-
node: Node
+
node: Node

The tree node.

Stability

stable

-
+
-
region: string
+
region: string

The AWS region into which this stack will be deployed (e.g. us-west-2).

This value is resolved according to the following rules:

    @@ -186,43 +186,43 @@
-
+
-
synthesizer: IStackSynthesizer
+
synthesizer: IStackSynthesizer

Synthesis method for this stack

-
+
-
tags: TagManager
+
tags: TagManager

Tags to be applied to the stack.

-
+
-
templateFile: string
+
templateFile: string

The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

-
+
-
templateOptions: ITemplateOptions
+
templateOptions: ITemplateOptions

Options for CloudFormation template (like version, transform, description).

-
+
-
terminationProtection?: boolean
+
terminationProtection?: boolean

Whether termination protection is enabled for this stack.

Accessors

-
+
-
-
+
-
    +
    • get bundlingRequired(): boolean
    • Indicates whether the stack requires bundling or not

      Returns boolean

-
+
-
    -
  • get dependencies(): Stack[]
  • +
      +
    • get dependencies(): Stack[]
    • Return the stacks this stack depends on

      -

      Returns Stack[]

-
+
-
    +
    • get maxResources(): any
    • Maximum number of resources in the stack

      @@ -266,57 +266,57 @@

      Returns any

-
+
-
    +
    • get nested(): boolean
    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      Returns boolean

-
+
-
    -
  • get nestedStackParent(): undefined | Stack
  • +
      +
    • get nestedStackParent(): undefined | Stack
    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

-
+
-
    +
    • get notificationArns(): string[]
    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      Returns string[]

-
+
-
    +
    • get partition(): string
    • The partition in which this stack is defined

      Returns string

-
+
-
    +
    • get stackId(): string
    • The ID of the stack

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123' -
      +

      Returns string

-
+
-
-
+
-
    +
    • get urlSuffix(): string
    • The Amazon domain suffix for the region in which this stack is defined

      @@ -341,10 +341,10 @@

      Returns stringInherited from Stack.urlSuffix

Methods

-
+
-
-
+
-
    - +
      +
    • Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

      @@ -371,21 +371,21 @@

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31') -
      +

      Parameters

      • -
        transform: string
        +
        transform: string

        The transform to add

      Returns void

-
+
-
    - +
      +
    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize @@ -423,15 +423,15 @@

      • -
        cfnElement: CfnElement
        +
        cfnElement: CfnElement

        The element for which the logical ID is allocated.

      Returns string

-
+
-
    - +
      +
    • Create a CloudFormation Export for a value

      Returns a string representing the corresponding Fn.importValue() @@ -446,22 +446,14 @@

      Example

      Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).

      It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.

      Instead, the process takes two deployments:

      - - -

      Deployment 1: break the relationship

      -
      -
        +

        Deployment 1: break the relationship

        • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether).
        • @@ -470,11 +462,7 @@

          Deployment 1: break the relationship

          between the two stacks is being broken.
        • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        - - -

        Deployment 2: remove the bucket resource

        -
        -
          +

          Deployment 2: remove the bucket resource

          • You are now free to remove the bucket resource from producerStack.
          • Don't forget to remove the exportValue() call as well.
          • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
          • @@ -484,15 +472,15 @@

            Deployment 2: remove the bucket resource

            Parameters

            • -
              exportedValue: any
            • +
              exportedValue: any
            • -
              Optional options: ExportValueOptions
      +
      Optional options: ExportValueOptions

    Returns string

-
+
-
-
+
-
-
+
-
-
+
-
-
+
-
    - +
      +
    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how @@ -595,15 +583,15 @@

      • -
        report: MissingContext
        +
        report: MissingContext

        The set of parameters needed to obtain the context

      Returns void

-
+
-
-
+
-
-
+
-
-
+
-
    - +
      +
    • Returns a string representation of this construct.

      @@ -665,30 +653,29 @@

      Stability

      stable

      Returns string

-
+
-
    - +
      +
    • (deprecated) Checks if x is a construct.

      -

      Returns

      true if x is an object created from a class which extends Construct.

      -

      Deprecated

      use x instanceof Construct instead

      Parameters

      • -
        x: any
        +
        x: any

        Any object.

      -

      Returns x is Construct

-
+
-
    - +
      +
    • Return whether the given object is a Stack.

      We do attribute detection since we can't reliably use 'instanceof'.

      @@ -697,13 +684,13 @@
      • -
        x: any
      -

      Returns x is Stack

    +

    Returns x is Stack

-
+
-
    - +
      +
    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      @@ -711,15 +698,16 @@
      • -
        construct: IConstruct
        +
        construct: IConstruct

        The construct to start the search from.

      -

      Returns Stack

- +
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/ControlTowerPipeline.html b/docs/classes/ControlTowerPipeline.html index 61ee9e1..67fba3e 100644 --- a/docs/classes/ControlTowerPipeline.html +++ b/docs/classes/ControlTowerPipeline.html @@ -1,4 +1,4 @@ -ControlTowerPipeline | @taimos/cdk-controltower
+ControlTowerPipeline | @taimos/cdk-controltower

Constructors

-
+
-

Parameters

-

Returns ControlTowerPipeline<T, S>

Properties

-
+
-
account: string
+
account: string

The AWS account into which this stack will be deployed.

This value is resolved according to the following rules:

    @@ -138,15 +138,15 @@
-
+
-
artifactId: string
+
artifactId: string

The ID of the cloud assembly artifact for this stack.

-
+
-
environment: string
+
environment: string

The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

@@ -158,30 +158,30 @@
-
+
-
nestedStackResource?: CfnResource
+
nestedStackResource?: CfnResource

If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

-
+
-
node: Node
+
node: Node

The tree node.

Stability

stable

-
+
-
pipeline: CodePipeline
-
+
pipeline: CodePipeline
+
-
-
+
+
-
region: string
+
region: string

The AWS region into which this stack will be deployed (e.g. us-west-2).

This value is resolved according to the following rules:

    @@ -201,46 +201,46 @@
-
+
-
repository: Repository
-
+
repository: Repository
+
-
synthesizer: IStackSynthesizer
+
synthesizer: IStackSynthesizer

Synthesis method for this stack

-
+
-
tags: TagManager
+
tags: TagManager

Tags to be applied to the stack.

-
+
-
templateFile: string
+
templateFile: string

The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

-
+
-
templateOptions: ITemplateOptions
+
templateOptions: ITemplateOptions

Options for CloudFormation template (like version, transform, description).

-
+
-
terminationProtection?: boolean
+
terminationProtection?: boolean

Whether termination protection is enabled for this stack.

Accessors

-
+
-
-
+
-
    +
    • get bundlingRequired(): boolean
    • Indicates whether the stack requires bundling or not

      Returns boolean

-
+
-
    -
  • get dependencies(): Stack[]
  • +
      +
    • get dependencies(): Stack[]
    • Return the stacks this stack depends on

      -

      Returns Stack[]

-
+
-
    +
    • get maxResources(): any
    • Maximum number of resources in the stack

      @@ -284,57 +284,57 @@

      Returns any

-
+
-
    +
    • get nested(): boolean
    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      Returns boolean

-
+
-
    -
  • get nestedStackParent(): undefined | Stack
  • +
      +
    • get nestedStackParent(): undefined | Stack
    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

-
+
-
    +
    • get notificationArns(): string[]
    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      Returns string[]

-
+
-
    +
    • get partition(): string
    • The partition in which this stack is defined

      Returns string

-
+
-
    +
    • get stackId(): string
    • The ID of the stack

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123' -
      +

      Returns string

-
+
-
-
+
-
    +
    • get urlSuffix(): string
    • The Amazon domain suffix for the region in which this stack is defined

      @@ -359,23 +359,23 @@

      Returns stringInherited from Stack.urlSuffix

Methods

-
+
-
-
+
-
-
+
-
    - +
      +
    • Parameters

      • -
        logArchiveAccount: T
      +
      logArchiveAccount: T

    Returns void

-
+
-
-
+
-
    - +
      +
    • Parameters

      • -
        appStage: Stage
      • +
        appStage: Stage
      • -
        Optional options: AddStageOpts
      -

      Returns StageDeployment

-
+
Optional options: AddStageOpts
+

Returns StageDeployment

+
-
    - +
      +
    • Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

      @@ -437,21 +437,21 @@

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31') -
      +

      Parameters

      • -
        transform: string
        +
        transform: string

        The transform to add

      Returns void

-
+
-
    - +
      +
    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize @@ -489,15 +489,15 @@

      • -
        cfnElement: CfnElement
        +
        cfnElement: CfnElement

        The element for which the logical ID is allocated.

      Returns string

-
+
-
    - +
      +
    • Create a CloudFormation Export for a value

      Returns a string representing the corresponding Fn.importValue() @@ -512,22 +512,14 @@

      Example

      Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).

      It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.

      Instead, the process takes two deployments:

      - - -

      Deployment 1: break the relationship

      -
      -
        +

        Deployment 1: break the relationship

        • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether).
        • @@ -536,11 +528,7 @@

          Deployment 1: break the relationship

          between the two stacks is being broken.
        • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        - - -

        Deployment 2: remove the bucket resource

        -
        -
          +

          Deployment 2: remove the bucket resource

          • You are now free to remove the bucket resource from producerStack.
          • Don't forget to remove the exportValue() call as well.
          • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
          • @@ -550,15 +538,15 @@

            Deployment 2: remove the bucket resource

            Parameters

            • -
              exportedValue: any
            • +
              exportedValue: any
            • -
              Optional options: ExportValueOptions
      +
      Optional options: ExportValueOptions

    Returns string

-
+
-
-
+
-
-
+
-
-
+
-
-
+
-
    - +
      +
    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how @@ -661,15 +649,15 @@

      • -
        report: MissingContext
        +
        report: MissingContext

        The set of parameters needed to obtain the context

      Returns void

-
+
-
-
+
-
-
+
-
-
+
-
    - +
      +
    • Returns a string representation of this construct.

      @@ -731,30 +719,29 @@

      Stability

      stable

      Returns string

-
+
-
    - +
      +
    • (deprecated) Checks if x is a construct.

      -

      Returns

      true if x is an object created from a class which extends Construct.

      -

      Deprecated

      use x instanceof Construct instead

      Parameters

      • -
        x: any
        +
        x: any

        Any object.

      -

      Returns x is Construct

-
+
-
    - +
      +
    • Return whether the given object is a Stack.

      We do attribute detection since we can't reliably use 'instanceof'.

      @@ -763,13 +750,13 @@
      • -
        x: any
      -

      Returns x is Stack

    +

    Returns x is Stack

-
+
-
    - +
      +
    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      @@ -777,15 +764,16 @@
      • -
        construct: IConstruct
        +
        construct: IConstruct

        The construct to start the search from.

      -

      Returns Stack

- +
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/CostReportingStack.html b/docs/classes/CostReportingStack.html index cdb0980..f1be0f1 100644 --- a/docs/classes/CostReportingStack.html +++ b/docs/classes/CostReportingStack.html @@ -1,4 +1,4 @@ -CostReportingStack | @taimos/cdk-controltower
+CostReportingStack | @taimos/cdk-controltower

Constructors

-
+
-

Properties

-
+
-
account: string
+
account: string

The AWS account into which this stack will be deployed.

This value is resolved according to the following rules:

    @@ -119,15 +119,15 @@
-
+
-
artifactId: string
+
artifactId: string

The ID of the cloud assembly artifact for this stack.

-
+
-
environment: string
+
environment: string

The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

@@ -139,24 +139,24 @@
-
+
-
nestedStackResource?: CfnResource
+
nestedStackResource?: CfnResource

If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

-
+
-
node: Node
+
node: Node

The tree node.

Stability

stable

-
+
-
region: string
+
region: string

The AWS region into which this stack will be deployed (e.g. us-west-2).

This value is resolved according to the following rules:

    @@ -176,43 +176,43 @@
-
+
-
synthesizer: IStackSynthesizer
+
synthesizer: IStackSynthesizer

Synthesis method for this stack

-
+
-
tags: TagManager
+
tags: TagManager

Tags to be applied to the stack.

-
+
-
templateFile: string
+
templateFile: string

The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

-
+
-
templateOptions: ITemplateOptions
+
templateOptions: ITemplateOptions

Options for CloudFormation template (like version, transform, description).

-
+
-
terminationProtection?: boolean
+
terminationProtection?: boolean

Whether termination protection is enabled for this stack.

Accessors

-
+
-
-
+
-
    +
    • get bundlingRequired(): boolean
    • Indicates whether the stack requires bundling or not

      Returns boolean

-
+
-
    -
  • get dependencies(): Stack[]
  • +
      +
    • get dependencies(): Stack[]
    • Return the stacks this stack depends on

      -

      Returns Stack[]

-
+
-
    +
    • get maxResources(): any
    • Maximum number of resources in the stack

      @@ -256,57 +256,57 @@

      Returns any

-
+
-
    +
    • get nested(): boolean
    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      Returns boolean

-
+
-
    -
  • get nestedStackParent(): undefined | Stack
  • +
      +
    • get nestedStackParent(): undefined | Stack
    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

-
+
-
    +
    • get notificationArns(): string[]
    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      Returns string[]

-
+
-
    +
    • get partition(): string
    • The partition in which this stack is defined

      Returns string

-
+
-
    +
    • get stackId(): string
    • The ID of the stack

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123' -
      +

      Returns string

-
+
-
-
+
-
    +
    • get urlSuffix(): string
    • The Amazon domain suffix for the region in which this stack is defined

      @@ -331,10 +331,10 @@

      Returns stringInherited from Stack.urlSuffix

Methods

-
+
-
-
+
-
    - +
      +
    • Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

      @@ -361,21 +361,21 @@

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31') -
      +

      Parameters

      • -
        transform: string
        +
        transform: string

        The transform to add

      Returns void

-
+
-
    - +
      +
    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize @@ -413,15 +413,15 @@

      • -
        cfnElement: CfnElement
        +
        cfnElement: CfnElement

        The element for which the logical ID is allocated.

      Returns string

-
+
-
    - +
      +
    • Create a CloudFormation Export for a value

      Returns a string representing the corresponding Fn.importValue() @@ -436,22 +436,14 @@

      Example

      Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).

      It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.

      Instead, the process takes two deployments:

      - - -

      Deployment 1: break the relationship

      -
      -
        +

        Deployment 1: break the relationship

        • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether).
        • @@ -460,11 +452,7 @@

          Deployment 1: break the relationship

          between the two stacks is being broken.
        • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        - - -

        Deployment 2: remove the bucket resource

        -
        -
          +

          Deployment 2: remove the bucket resource

          • You are now free to remove the bucket resource from producerStack.
          • Don't forget to remove the exportValue() call as well.
          • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
          • @@ -474,15 +462,15 @@

            Deployment 2: remove the bucket resource

            Parameters

            • -
              exportedValue: any
            • +
              exportedValue: any
            • -
              Optional options: ExportValueOptions
      +
      Optional options: ExportValueOptions

    Returns string

-
+
-
-
+
-
-
+
-
-
+
-
-
+
-
    - +
      +
    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how @@ -585,15 +573,15 @@

      • -
        report: MissingContext
        +
        report: MissingContext

        The set of parameters needed to obtain the context

      Returns void

-
+
-
-
+
-
-
+
-
-
+
-
    - +
      +
    • Returns a string representation of this construct.

      @@ -655,30 +643,29 @@

      Stability

      stable

      Returns string

-
+
-
    - +
      +
    • (deprecated) Checks if x is a construct.

      -

      Returns

      true if x is an object created from a class which extends Construct.

      -

      Deprecated

      use x instanceof Construct instead

      Parameters

      • -
        x: any
        +
        x: any

        Any object.

      -

      Returns x is Construct

-
+
-
    - +
      +
    • Return whether the given object is a Stack.

      We do attribute detection since we can't reliably use 'instanceof'.

      @@ -687,13 +674,13 @@
      • -
        x: any
      -

      Returns x is Stack

    +

    Returns x is Stack

-
+
-
    - +
      +
    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      @@ -701,15 +688,16 @@
      • -
        construct: IConstruct
        +
        construct: IConstruct

        The construct to start the search from.

      -

      Returns Stack

- +
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/LogArchiveStage.html b/docs/classes/LogArchiveStage.html index 0a6e601..7a350c7 100644 --- a/docs/classes/LogArchiveStage.html +++ b/docs/classes/LogArchiveStage.html @@ -1,4 +1,4 @@ -LogArchiveStage | @taimos/cdk-controltower
+LogArchiveStage | @taimos/cdk-controltower
-
+

Hierarchy

    -
  • Stage +
  • Stage
    • LogArchiveStage
@@ -28,87 +28,87 @@

Constructors

-
+
-

Properties

-
+
-
account?: string
+
account?: string

The default account for all resources defined within this stage.

-
+
-
node: Node
+
node: Node

The tree node.

Stability

stable

-
+
-
parentStage?: Stage
+
parentStage?: Stage

The parent stage or undefined if this is the app. *

-
+
-
region?: string
+
region?: string

The default region for all resources defined within this stage.

-
+
-
stageName: string
+
stageName: string

The name of the stage. Based on names of the parent stages separated by hypens.

Accessors

-
+
-
-
+
-
    +
    • get assetOutdir(): string
    • The cloud assembly asset output directory.

      Returns string

-
+
-
    +
    • get outdir(): string
    • The cloud assembly output directory.

      @@ -137,10 +137,10 @@

      Returns stringInherited from Stage.outdir

Methods

-
+
-
-
+
-
    - +
      +
    • Returns a string representation of this construct.

      @@ -164,30 +164,29 @@

      Stability

      stable

      Returns string

-
+
-
    - +
      +
    • (deprecated) Checks if x is a construct.

      -

      Returns

      true if x is an object created from a class which extends Construct.

      -

      Deprecated

      use x instanceof Construct instead

      Parameters

      • -
        x: any
        +
        x: any

        Any object.

      -

      Returns x is Construct

-
+
-
    - +
      +
    • Test whether the given construct is a stage.

      @@ -195,13 +194,13 @@
      • -
        x: any
      -

      Returns x is Stage

    +

    Returns x is Stage

-
+
-
    - +
      +
    • Return the stage this construct is contained with, if available. If called on a nested stage, returns its parent.

      @@ -210,13 +209,14 @@
      • -
        construct: IConstruct
      -

      Returns undefined | Stage

    +

    Returns undefined | Stage

- +
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/LogBucketStack.html b/docs/classes/LogBucketStack.html index 2bc556e..46d8878 100644 --- a/docs/classes/LogBucketStack.html +++ b/docs/classes/LogBucketStack.html @@ -1,4 +1,4 @@ -LogBucketStack | @taimos/cdk-controltower
+LogBucketStack | @taimos/cdk-controltower

Constructors

-
+
-

Properties

-
+
-
account: string
+
account: string

The AWS account into which this stack will be deployed.

This value is resolved according to the following rules:

    @@ -120,15 +120,15 @@
-
+
-
artifactId: string
+
artifactId: string

The ID of the cloud assembly artifact for this stack.

-
+
-
environment: string
+
environment: string

The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

@@ -140,27 +140,27 @@
-
+
-
flowLogsBucketName: string
-
+
flowLogsBucketName: string
+
-
nestedStackResource?: CfnResource
+
nestedStackResource?: CfnResource

If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

-
+
-
node: Node
+
node: Node

The tree node.

Stability

stable

-
+
-
region: string
+
region: string

The AWS region into which this stack will be deployed (e.g. us-west-2).

This value is resolved according to the following rules:

    @@ -180,43 +180,43 @@
-
+
-
synthesizer: IStackSynthesizer
+
synthesizer: IStackSynthesizer

Synthesis method for this stack

-
+
-
tags: TagManager
+
tags: TagManager

Tags to be applied to the stack.

-
+
-
templateFile: string
+
templateFile: string

The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

-
+
-
templateOptions: ITemplateOptions
+
templateOptions: ITemplateOptions

Options for CloudFormation template (like version, transform, description).

-
+
-
terminationProtection?: boolean
+
terminationProtection?: boolean

Whether termination protection is enabled for this stack.

Accessors

-
+
-
-
+
-
    +
    • get bundlingRequired(): boolean
    • Indicates whether the stack requires bundling or not

      Returns boolean

-
+
-
    -
  • get dependencies(): Stack[]
  • +
      +
    • get dependencies(): Stack[]
    • Return the stacks this stack depends on

      -

      Returns Stack[]

-
+
-
    +
    • get maxResources(): any
    • Maximum number of resources in the stack

      @@ -260,57 +260,57 @@

      Returns any

-
+
-
    +
    • get nested(): boolean
    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      Returns boolean

-
+
-
    -
  • get nestedStackParent(): undefined | Stack
  • +
      +
    • get nestedStackParent(): undefined | Stack
    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

-
+
-
    +
    • get notificationArns(): string[]
    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      Returns string[]

-
+
-
    +
    • get partition(): string
    • The partition in which this stack is defined

      Returns string

-
+
-
    +
    • get stackId(): string
    • The ID of the stack

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123' -
      +

      Returns string

-
+
-
-
+
-
    +
    • get urlSuffix(): string
    • The Amazon domain suffix for the region in which this stack is defined

      @@ -335,10 +335,10 @@

      Returns stringInherited from Stack.urlSuffix

Methods

-
+
-
-
+
-
    - +
      +
    • Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

      @@ -365,21 +365,21 @@

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31') -
      +

      Parameters

      • -
        transform: string
        +
        transform: string

        The transform to add

      Returns void

-
+
-
    - +
      +
    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize @@ -417,15 +417,15 @@

      • -
        cfnElement: CfnElement
        +
        cfnElement: CfnElement

        The element for which the logical ID is allocated.

      Returns string

-
+
-
    - +
      +
    • Create a CloudFormation Export for a value

      Returns a string representing the corresponding Fn.importValue() @@ -440,22 +440,14 @@

      Example

      Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).

      It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.

      Instead, the process takes two deployments:

      - - -

      Deployment 1: break the relationship

      -
      -
        +

        Deployment 1: break the relationship

        • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether).
        • @@ -464,11 +456,7 @@

          Deployment 1: break the relationship

          between the two stacks is being broken.
        • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        - - -

        Deployment 2: remove the bucket resource

        -
        -
          +

          Deployment 2: remove the bucket resource

          • You are now free to remove the bucket resource from producerStack.
          • Don't forget to remove the exportValue() call as well.
          • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
          • @@ -478,15 +466,15 @@

            Deployment 2: remove the bucket resource

            Parameters

            • -
              exportedValue: any
            • +
              exportedValue: any
            • -
              Optional options: ExportValueOptions
      +
      Optional options: ExportValueOptions

    Returns string

-
+
-
-
+
-
-
+
-
-
+
-
-
+
-
    - +
      +
    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how @@ -589,15 +577,15 @@

      • -
        report: MissingContext
        +
        report: MissingContext

        The set of parameters needed to obtain the context

      Returns void

-
+
-
-
+
-
-
+
-
-
+
-
    - +
      +
    • Returns a string representation of this construct.

      @@ -659,30 +647,29 @@

      Stability

      stable

      Returns string

-
+
-
    - +
      +
    • (deprecated) Checks if x is a construct.

      -

      Returns

      true if x is an object created from a class which extends Construct.

      -

      Deprecated

      use x instanceof Construct instead

      Parameters

      • -
        x: any
        +
        x: any

        Any object.

      -

      Returns x is Construct

-
+
-
    - +
      +
    • Return whether the given object is a Stack.

      We do attribute detection since we can't reliably use 'instanceof'.

      @@ -691,13 +678,13 @@
      • -
        x: any
      -

      Returns x is Stack

    +

    Returns x is Stack

-
+
-
    - +
      +
    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      @@ -705,15 +692,16 @@
      • -
        construct: IConstruct
        +
        construct: IConstruct

        The construct to start the search from.

      -

      Returns Stack

- +
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/SsoPermissionStack.html b/docs/classes/SsoPermissionStack.html index 0494bba..b10869b 100644 --- a/docs/classes/SsoPermissionStack.html +++ b/docs/classes/SsoPermissionStack.html @@ -1,4 +1,4 @@ -SsoPermissionStack | @taimos/cdk-controltower
+SsoPermissionStack | @taimos/cdk-controltower

Constructors

-
+
-
    - +
      +
    • -
      +

      Type Parameters

      -
        +
        • -

          T extends string

        • +

          T extends string

        • -

          S extends string

      +

      S extends string

Parameters

-

Returns SsoPermissionStack<T, S>

Properties

-
+
-
account: string
+
account: string

The AWS account into which this stack will be deployed.

This value is resolved according to the following rules:

    @@ -134,15 +134,15 @@
-
+
-
artifactId: string
+
artifactId: string

The ID of the cloud assembly artifact for this stack.

-
+
-
environment: string
+
environment: string

The environment coordinates in which this stack is deployed. In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

@@ -154,32 +154,32 @@
-
+
-
nestedStackResource?: CfnResource
+
nestedStackResource?: CfnResource

If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. undefined for top-level (non-nested) stacks.

-
+
-
node: Node
+
node: Node

The tree node.

Stability

stable

-
+
-
permissionSets: {
    [name: string]: sso.CfnPermissionSet;
} = {}
+
permissionSets: {
    [name: string]: sso.CfnPermissionSet;
} = {}

Type declaration

  • -
    [name: string]: sso.CfnPermissionSet
-
+
[name: string]: sso.CfnPermissionSet
+
-
region: string
+
region: string

The AWS region into which this stack will be deployed (e.g. us-west-2).

This value is resolved according to the following rules:

    @@ -199,43 +199,43 @@
-
+
-
synthesizer: IStackSynthesizer
+
synthesizer: IStackSynthesizer

Synthesis method for this stack

-
+
-
tags: TagManager
+
tags: TagManager

Tags to be applied to the stack.

-
+
-
templateFile: string
+
templateFile: string

The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

-
+
-
templateOptions: ITemplateOptions
+
templateOptions: ITemplateOptions

Options for CloudFormation template (like version, transform, description).

-
+
-
terminationProtection?: boolean
+
terminationProtection?: boolean

Whether termination protection is enabled for this stack.

Accessors

-
+
-
-
+
-
    +
    • get bundlingRequired(): boolean
    • Indicates whether the stack requires bundling or not

      Returns boolean

-
+
-
    -
  • get dependencies(): Stack[]
  • +
      +
    • get dependencies(): Stack[]
    • Return the stacks this stack depends on

      -

      Returns Stack[]

-
+
-
    +
    • get maxResources(): any
    • Maximum number of resources in the stack

      @@ -279,57 +279,57 @@

      Returns any

-
+
-
    +
    • get nested(): boolean
    • Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

      Returns boolean

-
+
-
    -
  • get nestedStackParent(): undefined | Stack
  • +
      +
    • get nestedStackParent(): undefined | Stack
    • If this is a nested stack, returns it's parent stack.

      -

      Returns undefined | Stack

-
+
-
    +
    • get notificationArns(): string[]
    • Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

      Returns string[]

-
+
-
    +
    • get partition(): string
    • The partition in which this stack is defined

      Returns string

-
+
-
    +
    • get stackId(): string
    • The ID of the stack

      Example

      // After resolving, looks like
      'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123' -
      +

      Returns string

-
+
-
-
+
-
    +
    • get urlSuffix(): string
    • The Amazon domain suffix for the region in which this stack is defined

      @@ -354,10 +354,10 @@

      Returns stringInherited from Stack.urlSuffix

Methods

-
+
-
-
+
-
    - +
      +
    • Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

      @@ -384,21 +384,21 @@

      Example

      declare const stack: Stack;

      stack.addTransform('AWS::Serverless-2016-10-31') -
      +

      Parameters

      • -
        transform: string
        +
        transform: string

        The transform to add

      Returns void

-
+
-
    - +
      +
    • Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize @@ -436,15 +436,15 @@

      • -
        cfnElement: CfnElement
        +
        cfnElement: CfnElement

        The element for which the logical ID is allocated.

      Returns string

-
+
-
    - +
      +
    • Create a CloudFormation Export for a value

      Returns a string representing the corresponding Fn.importValue() @@ -459,22 +459,14 @@

      Example

      Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).

      It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.

      Instead, the process takes two deployments:

      - - -

      Deployment 1: break the relationship

      -
      -
        +

        Deployment 1: break the relationship

        • Make sure consumerStack no longer references bucket.bucketName (maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether).
        • @@ -483,11 +475,7 @@

          Deployment 1: break the relationship

          between the two stacks is being broken.
        • Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).
        - - -

        Deployment 2: remove the bucket resource

        -
        -
          +

          Deployment 2: remove the bucket resource

          • You are now free to remove the bucket resource from producerStack.
          • Don't forget to remove the exportValue() call as well.
          • Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).
          • @@ -497,15 +485,15 @@

            Deployment 2: remove the bucket resource

            Parameters

            • -
              exportedValue: any
            • +
              exportedValue: any
            • -
              Optional options: ExportValueOptions
      +
      Optional options: ExportValueOptions

    Returns string

-
+
-
-
+
-
-
+
-
-
+
-
-
+
-
    - +
      +
    • Indicate that a context key was expected

      Contains instructions which will be emitted into the cloud assembly on how @@ -608,15 +596,15 @@

      • -
        report: MissingContext
        +
        report: MissingContext

        The set of parameters needed to obtain the context

      Returns void

-
+
-
-
+
-
-
+
-
-
+
-
    - +
      +
    • Returns a string representation of this construct.

      @@ -678,30 +666,29 @@

      Stability

      stable

      Returns string

-
+
-
    - +
      +
    • (deprecated) Checks if x is a construct.

      -

      Returns

      true if x is an object created from a class which extends Construct.

      -

      Deprecated

      use x instanceof Construct instead

      Parameters

      • -
        x: any
        +
        x: any

        Any object.

      -

      Returns x is Construct

-
+
-
    - +
      +
    • Return whether the given object is a Stack.

      We do attribute detection since we can't reliably use 'instanceof'.

      @@ -710,13 +697,13 @@
      • -
        x: any
      -

      Returns x is Stack

    +

    Returns x is Stack

-
+
-
    - +
      +
    • Looks up the first stack scope in which construct is defined. Fails if there is no stack up the tree.

      @@ -724,15 +711,16 @@
      • -
        construct: IConstruct
        +
        construct: IConstruct

        The construct to start the search from.

      -

      Returns Stack

- +
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/classes/SsoStage.html b/docs/classes/SsoStage.html index 01c6675..cb51449 100644 --- a/docs/classes/SsoStage.html +++ b/docs/classes/SsoStage.html @@ -1,4 +1,4 @@ -SsoStage | @taimos/cdk-controltower
+SsoStage | @taimos/cdk-controltower
-
+

Class SsoStage<T, S>

-
+

Type Parameters

-
    +
    • -

      T extends string

    • +

      T extends string

    • -

      S extends string

+

S extends string

Hierarchy

    -
  • Stage +
  • Stage
    • SsoStage
@@ -35,94 +35,94 @@

Constructors

-
+
-
    - +
      +
    • -
      +

      Type Parameters

      -
        +
        • -

          T extends string

        • +

          T extends string

        • -

          S extends string

      +

      S extends string

Parameters

-

Returns SsoStage<T, S>

Properties

-
+
-
account?: string
+
account?: string

The default account for all resources defined within this stage.

-
+
-
node: Node
+
node: Node

The tree node.

Stability

stable

-
+
-
parentStage?: Stage
+
parentStage?: Stage

The parent stage or undefined if this is the app. *

-
+
-
region?: string
+
region?: string

The default region for all resources defined within this stage.

-
+
-
stageName: string
+
stageName: string

The name of the stage. Based on names of the parent stages separated by hypens.

Accessors

-
+
-
-
+
-
    +
    • get assetOutdir(): string
    • The cloud assembly asset output directory.

      Returns string

-
+
-
    +
    • get outdir(): string
    • The cloud assembly output directory.

      @@ -151,10 +151,10 @@

      Returns stringInherited from Stage.outdir

Methods

-
+
-
-
+
-
    - +
      +
    • Returns a string representation of this construct.

      @@ -178,30 +178,29 @@

      Stability

      stable

      Returns string

-
+
-
    - +
      +
    • (deprecated) Checks if x is a construct.

      -

      Returns

      true if x is an object created from a class which extends Construct.

      -

      Deprecated

      use x instanceof Construct instead

      Parameters

      • -
        x: any
        +
        x: any

        Any object.

      -

      Returns x is Construct

-
+
-
    - +
      +
    • Test whether the given construct is a stage.

      @@ -209,13 +208,13 @@
      • -
        x: any
      -

      Returns x is Stage

    +

    Returns x is Stage

-
+
-
    - +
      +
    • Return the stage this construct is contained with, if available. If called on a nested stage, returns its parent.

      @@ -224,13 +223,14 @@
      • -
        construct: IConstruct
      -

      Returns undefined | Stage

    +

    Returns undefined | Stage

- +
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/functions/generateAccountFile.html b/docs/functions/generateAccountFile.html index 8e60543..7b36557 100644 --- a/docs/functions/generateAccountFile.html +++ b/docs/functions/generateAccountFile.html @@ -1,4 +1,4 @@ -generateAccountFile | @taimos/cdk-controltower
+generateAccountFile | @taimos/cdk-controltower
-
+

Function generateAccountFile

-
    - +
      +
    • -

      Returns Promise<string>

-
+ -
+

Theme

+ +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/functions/generateSsoConfigFile.html b/docs/functions/generateSsoConfigFile.html index e0bcda6..b746241 100644 --- a/docs/functions/generateSsoConfigFile.html +++ b/docs/functions/generateSsoConfigFile.html @@ -1,4 +1,4 @@ -generateSsoConfigFile | @taimos/cdk-controltower
+generateSsoConfigFile | @taimos/cdk-controltower
-
+

Function generateSsoConfigFile

-
    - +
      +
    • -

      Returns Promise<string>

-
+ -
+

Theme

+ +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 1eb15b1..2d5ad3b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -@taimos/cdk-controltower
+@taimos/cdk-controltower
-
+

@taimos/cdk-controltower

-
- -

CDK ControlTower

-
-

npm version

+

CDK ControlTower

npm version

CDK ControlTower is a tool suite to facilitate the use of the AWS Cloud Development Kit (CDK) for AWS Account management and Landing Zone setup. It provides project management features to configure your TypeScript CDK app and also higher-level (L3) constructs for different APIs and resources needed for account management.

- - -

Features

-
-
- +
+

On This Page

-
-
+ +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/interfaces/AccountBudgetOptions.html b/docs/interfaces/AccountBudgetOptions.html index 84cc9d4..5d12938 100644 --- a/docs/interfaces/AccountBudgetOptions.html +++ b/docs/interfaces/AccountBudgetOptions.html @@ -1,4 +1,4 @@ -AccountBudgetOptions | @taimos/cdk-controltower
+AccountBudgetOptions | @taimos/cdk-controltower
-
+

Properties

-
+
-
amount: number
-
+
amount: number
+
-
email?: string
-
+
+
+
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/interfaces/AccountInfo.html b/docs/interfaces/AccountInfo.html index 5ca13f4..d0c1bd7 100644 --- a/docs/interfaces/AccountInfo.html +++ b/docs/interfaces/AccountInfo.html @@ -1,4 +1,4 @@ -AccountInfo | @taimos/cdk-controltower
+AccountInfo | @taimos/cdk-controltower

Properties

-
+
-
Arn: string
-
+
Arn: string
+
-
Email: string
-
+
Email: string
+
-
Id: string
-
+
Id: string
+
-
JoinedMethod: string
-
+
JoinedMethod: string
+
-
JoinedTimestamp: string
-
+
JoinedTimestamp: string
+
-
Name: string
-
+
Name: string
+
-
Status: string
-
+
+
+
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/interfaces/BillingStageConfig.html b/docs/interfaces/BillingStageConfig.html index 7c5835b..2c2c7c6 100644 --- a/docs/interfaces/BillingStageConfig.html +++ b/docs/interfaces/BillingStageConfig.html @@ -1,4 +1,4 @@ -BillingStageConfig | @taimos/cdk-controltower
+BillingStageConfig | @taimos/cdk-controltower
-
+

Interface BillingStageConfig<T>

-
+

Type Parameters

-
    +
    • -

      T extends string

+

T extends string

Hierarchy

Properties

-
+
-
budgetConfig?: BudgetConfig<T>
-
+
budgetConfig?: BudgetConfig<T>
+
-
costReportConfig?: CostReportingConfig
-
+
+
+
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/interfaces/BudgetConfig.html b/docs/interfaces/BudgetConfig.html index bae4fb8..19d3990 100644 --- a/docs/interfaces/BudgetConfig.html +++ b/docs/interfaces/BudgetConfig.html @@ -1,4 +1,4 @@ -BudgetConfig | @taimos/cdk-controltower
+BudgetConfig | @taimos/cdk-controltower
-
+

Interface BudgetConfig<T>

-
+

Type Parameters

-
    +
    • -

      T extends string

+

T extends string

Hierarchy

Properties

-
+
-
budgets: AccountConfig<T, number | AccountBudgetOptions>
-
+
+
+
+

On This Page

- - + +

Generated using TypeDoc

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/interfaces/ControlTowerProps.html b/docs/interfaces/ControlTowerProps.html index 315ed19..69aee6d 100644 --- a/docs/interfaces/ControlTowerProps.html +++ b/docs/interfaces/ControlTowerProps.html @@ -1,4 +1,4 @@ -ControlTowerProps | @taimos/cdk-controltower
+ControlTowerProps | @taimos/cdk-controltower
-
+

Properties of a cdk-controltower stack stack

-
+

Type Parameters

-
    +
    • -

      T extends string

      +

      T extends string

      the AccountName type of the generated account list

@@ -30,7 +30,7 @@

Hierarchy

+
  • SsoProps
  • @@ -38,19 +38,20 @@

    Properties

    -
    +
    -
    accounts: AccountList<T>
    +
    accounts: AccountList<T>

    The list of AWS accounts. Can be generated by running npx fetch-accounts

    - +
    +

    On This Page

    - - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/CostReportingConfig.html b/docs/interfaces/CostReportingConfig.html index 35866b6..5ac2a00 100644 --- a/docs/interfaces/CostReportingConfig.html +++ b/docs/interfaces/CostReportingConfig.html @@ -1,4 +1,4 @@ -CostReportingConfig | @taimos/cdk-controltower
    +CostReportingConfig | @taimos/cdk-controltower

    Properties

    -
    +
    -
    costReportBucketName?: string
    +
    costReportBucketName?: string

    Name of the Cost and Usage report S3 bucket

    Default

    ${orgPrincipalAccount}-costreport

    -
    +
    -
    costReportName?: string
    +
    costReportName?: string

    Name of the Cost and Usage report

    Default

    default-cur

    - +
    +

    On This Page

    - - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/GroupInfo.html b/docs/interfaces/GroupInfo.html index 7abbcf4..0fb47c6 100644 --- a/docs/interfaces/GroupInfo.html +++ b/docs/interfaces/GroupInfo.html @@ -1,4 +1,4 @@ -GroupInfo | @taimos/cdk-controltower
    +GroupInfo | @taimos/cdk-controltower

    Properties

    -
    +
    -
    Description?: string
    -
    +
    Description?: string
    +
    -
    DisplayName: string
    -
    +
    DisplayName: string
    +
    -
    ExternalIds?: {
        Id: string;
        Issuer: string;
    }[]
    -
    +
    ExternalIds?: {
        Id: string;
        Issuer: string;
    }[]
    +
    -
    GroupId: string
    -
    +
    +
    +
    +

    On This Page

    - - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/LogArchiveConfig.html b/docs/interfaces/LogArchiveConfig.html index d0a044b..c9bb1db 100644 --- a/docs/interfaces/LogArchiveConfig.html +++ b/docs/interfaces/LogArchiveConfig.html @@ -1,4 +1,4 @@ -LogArchiveConfig | @taimos/cdk-controltower
    +LogArchiveConfig | @taimos/cdk-controltower
    -
    +

    Properties

    -
    +
    -
    logArchiveAccount: AccountInfo
    -
    +
    +
    +
    +

    On This Page

    - - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/OrgPrincipalAware.html b/docs/interfaces/OrgPrincipalAware.html index d0ae864..1a0c622 100644 --- a/docs/interfaces/OrgPrincipalAware.html +++ b/docs/interfaces/OrgPrincipalAware.html @@ -1,4 +1,4 @@ -OrgPrincipalAware | @taimos/cdk-controltower
    +OrgPrincipalAware | @taimos/cdk-controltower
    -
    +

    Properties

    -
    +
    -
    orgPrincipalEnv: Environment
    +
    orgPrincipalEnv: Environment

    The organization principal account

    - +
    +

    On This Page

    - - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/PermissionSetOptions.html b/docs/interfaces/PermissionSetOptions.html index 831f05d..e497156 100644 --- a/docs/interfaces/PermissionSetOptions.html +++ b/docs/interfaces/PermissionSetOptions.html @@ -1,4 +1,4 @@ -PermissionSetOptions | @taimos/cdk-controltower
    +PermissionSetOptions | @taimos/cdk-controltower

    Properties

    -
    +
    -
    description?: string
    +
    description?: string
    -
    +
    -
    inlinePolicy?: any
    +
    inlinePolicy?: any
    -
    +
    -
    managedPolicies?: string[]
    +
    managedPolicies?: string[]
    -
    +
    -
    relayStateType?: string
    +
    relayStateType?: string

    Used to redirect users within the application during the federation authentication process.

    Link

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-relaystatetype

    -
    +
    -
    sessionDuration?: string
    +
    sessionDuration?: string

    The length of time that the application user sessions are valid for in the ISO-8601 standard.

    Link

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-sessionduration

    - +
    +

    On This Page

    - - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/SsoConfig.html b/docs/interfaces/SsoConfig.html index a5f34bb..5948264 100644 --- a/docs/interfaces/SsoConfig.html +++ b/docs/interfaces/SsoConfig.html @@ -1,4 +1,4 @@ -SsoConfig | @taimos/cdk-controltower
    +SsoConfig | @taimos/cdk-controltower
    -
    +

    Interface SsoConfig<T>

    -
    +

    Type Parameters

    -
      +
      • -

        T extends string

    +

    T extends string

    Hierarchy

    Properties

    -
    +
    -
    groups: GroupList<T>
    -
    +
    groups: GroupList<T>
    +
    -
    identityStoreId: string
    -
    +
    identityStoreId: string
    +
    -
    instanceArn: string
    -
    +
    +
    +
    +

    On This Page

    - - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/SsoPermissionConfig.html b/docs/interfaces/SsoPermissionConfig.html index 2fe3d06..f5272ce 100644 --- a/docs/interfaces/SsoPermissionConfig.html +++ b/docs/interfaces/SsoPermissionConfig.html @@ -1,4 +1,4 @@ -SsoPermissionConfig | @taimos/cdk-controltower
    +SsoPermissionConfig | @taimos/cdk-controltower
    -
    +

    Interface SsoPermissionConfig<T, S>

    -
    +

    Type Parameters

    -
      +
      • -

        T extends string

      • +

        T extends string

      • -

        S extends string

    +

    S extends string

    Hierarchy

    Properties

    -
    +
    -
    adminSetOptions?: PermissionSetOptions
    +
    adminSetOptions?: PermissionSetOptions

    optional configuration options for the Admin permission set

    Default

    AdministratorAccess with 8 hours session duration

    -
    +
    -
    billingSetOptions?: PermissionSetOptions
    +
    billingSetOptions?: PermissionSetOptions

    optional configuration options for the Admin permission set

    Default

    ReadOnlyAccess and job-function/Billing with 8 hours session duration

    -
    +
    -
    defaultAssignmentsForNewAccount?: {
        groupName: S;
        permissionSetName: string;
    }[]
    +
    defaultAssignmentsForNewAccount?: {
        groupName: S;
        permissionSetName: string;
    }[]

    Collection of group - permission set assignments for every new account

    Use this to grant your admins permissions for every account directly after creation

    -
    +
    -
    groupPermissions: AccountConfig<T, GroupConfig<S, string[]>>
    -
    +
    groupPermissions: AccountConfig<T, GroupConfig<S, string[]>>
    +
    -
    permissionSets?: {
        [name: string]: PermissionSetOptions;
    }
    +
    permissionSets?: {
        [name: string]: PermissionSetOptions;
    }

    add more permission sets here besides Admin, Billing, and ReadOnly

    Type declaration

    -
    +
    [name: string]: PermissionSetOptions
    +
    -
    readOnlySetOptions?: PermissionSetOptions
    +
    readOnlySetOptions?: PermissionSetOptions

    optional configuration options for the ReadOnly permission set

    Default

    ReadOnlyAccess with 8 hours session duration

    - +
    +

    On This Page

    - - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/SsoProps.html b/docs/interfaces/SsoProps.html index 243d784..256de0f 100644 --- a/docs/interfaces/SsoProps.html +++ b/docs/interfaces/SsoProps.html @@ -1,4 +1,4 @@ -SsoProps | @taimos/cdk-controltower
    +SsoProps | @taimos/cdk-controltower
    -
    +

    Properties of the SSO stack

    -
    +

    Type Parameters

    -
      +
      • -

        T extends string

        +

        T extends string

        the AccountName type of the generated account list

      • -

        S extends string

        +

        S extends string

        the GroupName type of the generated sso config

    Hierarchy

    @@ -42,26 +42,27 @@

    Properties

    -
    +
    -
    accounts: AccountList<T>
    +
    accounts: AccountList<T>

    The list of AWS accounts. Can be generated by running npx fetch-accounts

    -
    +
    -
    ssoConfig: SsoConfig<S>
    +
    ssoConfig: SsoConfig<S>

    The configuration of the AWS SSO org. Can be generated by running npx fetch-sso-config

    - +
    +

    On This Page

    - - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/interfaces/SsoStageConfig.html b/docs/interfaces/SsoStageConfig.html index bf1be7c..11dc7fa 100644 --- a/docs/interfaces/SsoStageConfig.html +++ b/docs/interfaces/SsoStageConfig.html @@ -1,4 +1,4 @@ -SsoStageConfig | @taimos/cdk-controltower
    +SsoStageConfig | @taimos/cdk-controltower
    -
    +

    Interface SsoStageConfig<T, S>

    -
    +

    Type Parameters

    -
      +
      • -

        T extends string

      • +

        T extends string

      • -

        S extends string

    +

    S extends string

    Hierarchy

    Properties

    -
    +
    -
    permissionsConfiguration?: SsoPermissionConfig<T, S>
    -
    +
    +
    +
    +

    On This Page

    - - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 2e19268..ef9fb4b 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4 +1,4 @@ -@taimos/cdk-controltower
    +@taimos/cdk-controltower
    - + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/AccountConfig.html b/docs/types/AccountConfig.html index c7948d9..740abb4 100644 --- a/docs/types/AccountConfig.html +++ b/docs/types/AccountConfig.html @@ -1,4 +1,4 @@ -AccountConfig | @taimos/cdk-controltower
    +AccountConfig | @taimos/cdk-controltower
    -
    +

    Type alias AccountConfig<T, V>

    -
    AccountConfig<T, V>: { [ name in T]?: V }
    -
    +
    AccountConfig<T, V>: {
        [name in T]?: V
    }
    +

    Type Parameters

    -
      +
      • -

        T extends string

      • +

        T extends string

      • -

        V

    -
    + -
    +

    Theme

    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/AccountList.html b/docs/types/AccountList.html index 4b4f772..16ce017 100644 --- a/docs/types/AccountList.html +++ b/docs/types/AccountList.html @@ -1,4 +1,4 @@ -AccountList | @taimos/cdk-controltower
    +AccountList | @taimos/cdk-controltower
    -
    +

    Type alias AccountList<T>

    -
    AccountList<T>: { [ name in T]: AccountInfo }
    -
    +
    AccountList<T>: {
        [name in T]: AccountInfo
    }
    +

    Type Parameters

    -
      +
      • -

        T extends string

    -
    + -
    +

    Theme

    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/BillingStageProps.html b/docs/types/BillingStageProps.html index 22b4436..2d1cc1f 100644 --- a/docs/types/BillingStageProps.html +++ b/docs/types/BillingStageProps.html @@ -1,4 +1,4 @@ -BillingStageProps | @taimos/cdk-controltower
    +BillingStageProps | @taimos/cdk-controltower
    -
    +

    Type alias BillingStageProps<T>

    -
    BillingStageProps<T>: BillingStageConfig<T> & StageProps & ControlTowerProps<T> & OrgPrincipalAware
    -
    +
    BillingStageProps<T>: BillingStageConfig<T> & StageProps & ControlTowerProps<T> & OrgPrincipalAware
    +

    Type Parameters

    -
      +
      • -

        T extends string

    -
    + -
    +

    Theme

    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/BudgetStackProps.html b/docs/types/BudgetStackProps.html index 505b201..7175ce4 100644 --- a/docs/types/BudgetStackProps.html +++ b/docs/types/BudgetStackProps.html @@ -1,4 +1,4 @@ -BudgetStackProps | @taimos/cdk-controltower
    +BudgetStackProps | @taimos/cdk-controltower
    -
    +

    Type alias BudgetStackProps<T>

    -
    BudgetStackProps<T>: BudgetConfig<T> & StackProps & ControlTowerProps<T>
    -
    +
    BudgetStackProps<T>: BudgetConfig<T> & StackProps & ControlTowerProps<T>
    +

    Type Parameters

    -
      +
      • -

        T extends string

    -
    + -
    +

    Theme

    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/ControlTowerPipelineProps.html b/docs/types/ControlTowerPipelineProps.html index 230a55a..c0f8a09 100644 --- a/docs/types/ControlTowerPipelineProps.html +++ b/docs/types/ControlTowerPipelineProps.html @@ -1,4 +1,4 @@ -ControlTowerPipelineProps | @taimos/cdk-controltower
    +ControlTowerPipelineProps | @taimos/cdk-controltower
    -
    +

    Type alias ControlTowerPipelineProps<T, S>

    -
    ControlTowerPipelineProps<T, S>: SsoProps<T, S> & OrgPrincipalAware & StackProps
    -
    +
    ControlTowerPipelineProps<T, S>: SsoProps<T, S> & OrgPrincipalAware & StackProps
    +

    Type Parameters

    -
      +
      • -

        T extends string

      • +

        T extends string

      • -

        S extends string

    -
    + -
    +

    Theme

    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/CostReportingStackProps.html b/docs/types/CostReportingStackProps.html index bc61721..8869448 100644 --- a/docs/types/CostReportingStackProps.html +++ b/docs/types/CostReportingStackProps.html @@ -1,4 +1,4 @@ -CostReportingStackProps | @taimos/cdk-controltower
    +CostReportingStackProps | @taimos/cdk-controltower
    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/GroupConfig.html b/docs/types/GroupConfig.html index 761d908..947d466 100644 --- a/docs/types/GroupConfig.html +++ b/docs/types/GroupConfig.html @@ -1,4 +1,4 @@ -GroupConfig | @taimos/cdk-controltower
    +GroupConfig | @taimos/cdk-controltower
    -
    +

    Type alias GroupConfig<T, V>

    -
    GroupConfig<T, V>: { [ name in T]?: V }
    -
    +
    GroupConfig<T, V>: {
        [name in T]?: V
    }
    +

    Type Parameters

    -
      +
      • -

        T extends string

      • +

        T extends string

      • -

        V

    -
    + -
    +

    Theme

    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/GroupList.html b/docs/types/GroupList.html index 2b8dffd..401c8c2 100644 --- a/docs/types/GroupList.html +++ b/docs/types/GroupList.html @@ -1,4 +1,4 @@ -GroupList | @taimos/cdk-controltower
    +GroupList | @taimos/cdk-controltower
    -
    +

    Type alias GroupList<T>

    -
    GroupList<T>: { [ name in T]: GroupInfo }
    -
    +
    GroupList<T>: {
        [name in T]: GroupInfo
    }
    +

    Type Parameters

    -
      +
      • -

        T extends string

    -
    + -
    +

    Theme

    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/LogArchiveStageProps.html b/docs/types/LogArchiveStageProps.html index 8c38bba..270cea9 100644 --- a/docs/types/LogArchiveStageProps.html +++ b/docs/types/LogArchiveStageProps.html @@ -1,4 +1,4 @@ -LogArchiveStageProps | @taimos/cdk-controltower
    +LogArchiveStageProps | @taimos/cdk-controltower
    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/LogBucketStackProps.html b/docs/types/LogBucketStackProps.html index cb770b9..6dc56d3 100644 --- a/docs/types/LogBucketStackProps.html +++ b/docs/types/LogBucketStackProps.html @@ -1,4 +1,4 @@ -LogBucketStackProps | @taimos/cdk-controltower
    +LogBucketStackProps | @taimos/cdk-controltower
    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/SsoPermissionStackProps.html b/docs/types/SsoPermissionStackProps.html index 5054c58..95904e4 100644 --- a/docs/types/SsoPermissionStackProps.html +++ b/docs/types/SsoPermissionStackProps.html @@ -1,4 +1,4 @@ -SsoPermissionStackProps | @taimos/cdk-controltower
    +SsoPermissionStackProps | @taimos/cdk-controltower
    -
    +

    Type alias SsoPermissionStackProps<T, S>

    -
    SsoPermissionStackProps<T, S>: SsoProps<T, S> & SsoPermissionConfig<T, S> & StackProps
    -
    +
    SsoPermissionStackProps<T, S>: SsoProps<T, S> & SsoPermissionConfig<T, S> & StackProps
    +

    Type Parameters

    -
      +
      • -

        T extends string

      • +

        T extends string

      • -

        S extends string

    -
    + -
    +

    Theme

    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/types/SsoStageProps.html b/docs/types/SsoStageProps.html index 7a1c55a..6cf01b7 100644 --- a/docs/types/SsoStageProps.html +++ b/docs/types/SsoStageProps.html @@ -1,4 +1,4 @@ -SsoStageProps | @taimos/cdk-controltower
    +SsoStageProps | @taimos/cdk-controltower
    -
    +

    Type alias SsoStageProps<T, S>

    -
    SsoStageProps<T, S>: SsoStageConfig<T, S> & SsoProps<T, S> & StageProps & OrgPrincipalAware
    -
    +
    SsoStageProps<T, S>: SsoStageConfig<T, S> & SsoProps<T, S> & StageProps & OrgPrincipalAware
    +

    Type Parameters

    -
      +
      • -

        T extends string

      • +

        T extends string

      • -

        S extends string

    -
    + -
    +

    Theme

    + +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file