diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f1cf348..f31f9cc 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,7 +2,6 @@ - [ ] The commit message describes your change - [ ] Tests for the changes have been added if possible (for bug fixes / features) - [ ] Docs have been added / updated (for bug fixes / features) -- [ ] Changes are mentioned in the changelog (for bug fixes / features) * **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) diff --git a/.projen/deps.json b/.projen/deps.json index dc8bbb5..99b5163 100644 --- a/.projen/deps.json +++ b/.projen/deps.json @@ -101,7 +101,6 @@ }, { "name": "typescript", - "version": "^4.4.0", "type": "build" }, { diff --git a/docs/constructs/assets/main.js b/docs/constructs/assets/main.js index 3cee05e..d0aa8d5 100644 --- a/docs/constructs/assets/main.js +++ b/docs/constructs/assets/main.js @@ -1,7 +1,8 @@ "use strict"; -"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((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(),this.listenForCodeCopies(),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&&(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)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(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+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(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 _e(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 Re(t,e,r,n){if(_e(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 Fe(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 M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!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&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="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(M,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}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="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(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,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){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){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 te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{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()),ve.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 Z=class extends C{constructor(n){super(n);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 r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/constructs/assets/navigation.js b/docs/constructs/assets/navigation.js new file mode 100644 index 0000000..fcee5e2 --- /dev/null +++ b/docs/constructs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42Uy07DMBBF/yXrCmik8uguFIGokHhVsEAs3MRNrLq2ZU8pCPXfCShpEjyeZOs5czyxr/P2HQH/hGgaJc5xmGUqGkWGQVGupJKVa+64rhwVsJFleS1UFk3H8fl+dOi+ZI4nRvjNVYHqnelcCdDJFgquQKQMhEbGQDHKe2OZKR4lOlZTowx3bLPM2PVWpfhI3TpleuIO0EGqAtX7LFQu+YItJb9iwBxoy30RRlHWV23XK6l3vqmuUN11Jh6sNq5RCAXcrljaSs0f0VXFk1M/OmFTG6BEaEDC2jBObdIEJ2z+x1C6257wt6w4SsrnOxgi9jBKOndlZLX84Pbe/LL4EXgUpew+o/C5Ily/dmFZWj4NalgMpMTVmw0P2gYoEfZmw9YgPXQL7kSOR8CjKOULyCER8DFKWv90wp/fIfrv3RsNvszhrvGBTi7OxpN4//4DN/xYqBUHAAA=" \ No newline at end of file diff --git a/docs/constructs/assets/search.js b/docs/constructs/assets/search.js index a07b83e..616872e 100644 --- a/docs/constructs/assets/search.js +++ b/docs/constructs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":256,\"name\":\"AssetCdnProps\",\"url\":\"interfaces/AssetCdnProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"domainName\",\"url\":\"interfaces/AssetCdnProps.html#domainName\",\"classes\":\"\",\"parent\":\"AssetCdnProps\"},{\"kind\":1024,\"name\":\"hostName\",\"url\":\"interfaces/AssetCdnProps.html#hostName\",\"classes\":\"\",\"parent\":\"AssetCdnProps\"},{\"kind\":128,\"name\":\"AssetCdn\",\"url\":\"classes/AssetCdn.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/AssetCdn.html#constructor\",\"classes\":\"\",\"parent\":\"AssetCdn\"},{\"kind\":1024,\"name\":\"zone\",\"url\":\"classes/AssetCdn.html#zone\",\"classes\":\"\",\"parent\":\"AssetCdn\"},{\"kind\":1024,\"name\":\"assetBucket\",\"url\":\"classes/AssetCdn.html#assetBucket\",\"classes\":\"\",\"parent\":\"AssetCdn\"},{\"kind\":1024,\"name\":\"assetDomainName\",\"url\":\"classes/AssetCdn.html#assetDomainName\",\"classes\":\"\",\"parent\":\"AssetCdn\"},{\"kind\":256,\"name\":\"ICognitoAuthentication\",\"url\":\"interfaces/ICognitoAuthentication.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"userpool\",\"url\":\"interfaces/ICognitoAuthentication.html#userpool\",\"classes\":\"\",\"parent\":\"ICognitoAuthentication\"},{\"kind\":256,\"name\":\"IJwtAuthentication\",\"url\":\"interfaces/IJwtAuthentication.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"issuerUrl\",\"url\":\"interfaces/IJwtAuthentication.html#issuerUrl\",\"classes\":\"\",\"parent\":\"IJwtAuthentication\"},{\"kind\":1024,\"name\":\"audience\",\"url\":\"interfaces/IJwtAuthentication.html#audience\",\"classes\":\"\",\"parent\":\"IJwtAuthentication\"},{\"kind\":1024,\"name\":\"jwksUrl\",\"url\":\"interfaces/IJwtAuthentication.html#jwksUrl\",\"classes\":\"\",\"parent\":\"IJwtAuthentication\"},{\"kind\":256,\"name\":\"CognitoAuthenticationProps\",\"url\":\"interfaces/CognitoAuthenticationProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"userPoolName\",\"url\":\"interfaces/CognitoAuthenticationProps.html#userPoolName\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps\"},{\"kind\":1024,\"name\":\"triggers\",\"url\":\"interfaces/CognitoAuthenticationProps.html#triggers\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/CognitoAuthenticationProps.html#triggers.__type-3\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.triggers\"},{\"kind\":1024,\"name\":\"customMessages\",\"url\":\"interfaces/CognitoAuthenticationProps.html#triggers.__type-3.customMessages\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.triggers.__type\"},{\"kind\":1024,\"name\":\"preTokenGeneration\",\"url\":\"interfaces/CognitoAuthenticationProps.html#triggers.__type-3.preTokenGeneration\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.triggers.__type\"},{\"kind\":1024,\"name\":\"preSignUp\",\"url\":\"interfaces/CognitoAuthenticationProps.html#triggers.__type-3.preSignUp\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.triggers.__type\"},{\"kind\":1024,\"name\":\"userPoolProps\",\"url\":\"interfaces/CognitoAuthenticationProps.html#userPoolProps\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps\"},{\"kind\":1024,\"name\":\"sesEmailSender\",\"url\":\"interfaces/CognitoAuthenticationProps.html#sesEmailSender\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/CognitoAuthenticationProps.html#sesEmailSender.__type-2\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.sesEmailSender\"},{\"kind\":1024,\"name\":\"region\",\"url\":\"interfaces/CognitoAuthenticationProps.html#sesEmailSender.__type-2.region\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.sesEmailSender.__type\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/CognitoAuthenticationProps.html#sesEmailSender.__type-2.name\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.sesEmailSender.__type\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"interfaces/CognitoAuthenticationProps.html#sesEmailSender.__type-2.email\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.sesEmailSender.__type\"},{\"kind\":1024,\"name\":\"groups\",\"url\":\"interfaces/CognitoAuthenticationProps.html#groups\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/CognitoAuthenticationProps.html#groups.__type\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.groups\"},{\"kind\":1024,\"name\":\"identityPool\",\"url\":\"interfaces/CognitoAuthenticationProps.html#identityPool\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/CognitoAuthenticationProps.html#identityPool.__type-1\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.identityPool\"},{\"kind\":1024,\"name\":\"poolConfig\",\"url\":\"interfaces/CognitoAuthenticationProps.html#identityPool.__type-1.poolConfig\",\"classes\":\"\",\"parent\":\"CognitoAuthenticationProps.identityPool.__type\"},{\"kind\":128,\"name\":\"CognitoAuthentication\",\"url\":\"classes/CognitoAuthentication.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/CognitoAuthentication.html#constructor\",\"classes\":\"\",\"parent\":\"CognitoAuthentication\"},{\"kind\":1024,\"name\":\"userpool\",\"url\":\"classes/CognitoAuthentication.html#userpool\",\"classes\":\"\",\"parent\":\"CognitoAuthentication\"},{\"kind\":1024,\"name\":\"identityPool\",\"url\":\"classes/CognitoAuthentication.html#identityPool\",\"classes\":\"\",\"parent\":\"CognitoAuthentication\"},{\"kind\":1024,\"name\":\"customMessageFunction\",\"url\":\"classes/CognitoAuthentication.html#customMessageFunction\",\"classes\":\"\",\"parent\":\"CognitoAuthentication\"},{\"kind\":1024,\"name\":\"preSignUpFunction\",\"url\":\"classes/CognitoAuthentication.html#preSignUpFunction\",\"classes\":\"\",\"parent\":\"CognitoAuthentication\"},{\"kind\":1024,\"name\":\"preTokenGenerationFunction\",\"url\":\"classes/CognitoAuthentication.html#preTokenGenerationFunction\",\"classes\":\"\",\"parent\":\"CognitoAuthentication\"},{\"kind\":256,\"name\":\"BaseApiProps\",\"url\":\"interfaces/BaseApiProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"apiName\",\"url\":\"interfaces/BaseApiProps.html#apiName\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":1024,\"name\":\"stageName\",\"url\":\"interfaces/BaseApiProps.html#stageName\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":1024,\"name\":\"monitoring\",\"url\":\"interfaces/BaseApiProps.html#monitoring\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":1024,\"name\":\"singleTableDatastore\",\"url\":\"interfaces/BaseApiProps.html#singleTableDatastore\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":1024,\"name\":\"authentication\",\"url\":\"interfaces/BaseApiProps.html#authentication\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":1024,\"name\":\"assetCdn\",\"url\":\"interfaces/BaseApiProps.html#assetCdn\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":1024,\"name\":\"additionalEnv\",\"url\":\"interfaces/BaseApiProps.html#additionalEnv\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/BaseApiProps.html#additionalEnv.__type\",\"classes\":\"\",\"parent\":\"BaseApiProps.additionalEnv\"},{\"kind\":1024,\"name\":\"lambdaOptions\",\"url\":\"interfaces/BaseApiProps.html#lambdaOptions\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":1024,\"name\":\"lambdaTracing\",\"url\":\"interfaces/BaseApiProps.html#lambdaTracing\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":1024,\"name\":\"domainName\",\"url\":\"interfaces/BaseApiProps.html#domainName\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":1024,\"name\":\"hostedZone\",\"url\":\"interfaces/BaseApiProps.html#hostedZone\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":1024,\"name\":\"apiHostname\",\"url\":\"interfaces/BaseApiProps.html#apiHostname\",\"classes\":\"\",\"parent\":\"BaseApiProps\"},{\"kind\":128,\"name\":\"BaseApi\",\"url\":\"classes/BaseApi.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BaseApi.html#constructor\",\"classes\":\"\",\"parent\":\"BaseApi\"},{\"kind\":1024,\"name\":\"hostedZone\",\"url\":\"classes/BaseApi.html#hostedZone\",\"classes\":\"tsd-is-protected\",\"parent\":\"BaseApi\"},{\"kind\":1024,\"name\":\"apiHostName\",\"url\":\"classes/BaseApi.html#apiHostName\",\"classes\":\"tsd-is-protected\",\"parent\":\"BaseApi\"},{\"kind\":1024,\"name\":\"apiDomainName\",\"url\":\"classes/BaseApi.html#apiDomainName\",\"classes\":\"tsd-is-protected\",\"parent\":\"BaseApi\"},{\"kind\":1024,\"name\":\"apiFQDN\",\"url\":\"classes/BaseApi.html#apiFQDN\",\"classes\":\"tsd-is-protected\",\"parent\":\"BaseApi\"},{\"kind\":2097152,\"name\":\"LambdaOptions\",\"url\":\"types/LambdaOptions.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"LambdaTracingOptions\",\"url\":\"interfaces/LambdaTracingOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"xRayTracing\",\"url\":\"interfaces/LambdaTracingOptions.html#xRayTracing\",\"classes\":\"\",\"parent\":\"LambdaTracingOptions\"},{\"kind\":256,\"name\":\"LambdaFunctionProps\",\"url\":\"interfaces/LambdaFunctionProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"stageName\",\"url\":\"interfaces/LambdaFunctionProps.html#stageName\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"entry\",\"url\":\"interfaces/LambdaFunctionProps.html#entry\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"handler\",\"url\":\"interfaces/LambdaFunctionProps.html#handler\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"interfaces/LambdaFunctionProps.html#description\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"table\",\"url\":\"interfaces/LambdaFunctionProps.html#table\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"tableWrites\",\"url\":\"interfaces/LambdaFunctionProps.html#tableWrites\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"userPool\",\"url\":\"interfaces/LambdaFunctionProps.html#userPool\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"jwt\",\"url\":\"interfaces/LambdaFunctionProps.html#jwt\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"assetBucket\",\"url\":\"interfaces/LambdaFunctionProps.html#assetBucket\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"assetDomainName\",\"url\":\"interfaces/LambdaFunctionProps.html#assetDomainName\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"includeSDK\",\"url\":\"interfaces/LambdaFunctionProps.html#includeSDK\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"additionalEnv\",\"url\":\"interfaces/LambdaFunctionProps.html#additionalEnv\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LambdaFunctionProps.html#additionalEnv.__type\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps.additionalEnv\"},{\"kind\":1024,\"name\":\"lambdaOptions\",\"url\":\"interfaces/LambdaFunctionProps.html#lambdaOptions\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":1024,\"name\":\"lambdaTracing\",\"url\":\"interfaces/LambdaFunctionProps.html#lambdaTracing\",\"classes\":\"\",\"parent\":\"LambdaFunctionProps\"},{\"kind\":128,\"name\":\"LambdaFunction\",\"url\":\"classes/LambdaFunction.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/LambdaFunction.html#constructor\",\"classes\":\"\",\"parent\":\"LambdaFunction\"},{\"kind\":1024,\"name\":\"props\",\"url\":\"classes/LambdaFunction.html#props\",\"classes\":\"tsd-is-private\",\"parent\":\"LambdaFunction\"},{\"kind\":2048,\"name\":\"setTable\",\"url\":\"classes/LambdaFunction.html#setTable\",\"classes\":\"\",\"parent\":\"LambdaFunction\"},{\"kind\":2048,\"name\":\"setUserPool\",\"url\":\"classes/LambdaFunction.html#setUserPool\",\"classes\":\"\",\"parent\":\"LambdaFunction\"},{\"kind\":2048,\"name\":\"grantTableWrite\",\"url\":\"classes/LambdaFunction.html#grantTableWrite\",\"classes\":\"\",\"parent\":\"LambdaFunction\"},{\"kind\":2048,\"name\":\"grantSendEmails\",\"url\":\"classes/LambdaFunction.html#grantSendEmails\",\"classes\":\"\",\"parent\":\"LambdaFunction\"},{\"kind\":2048,\"name\":\"grantUploadAssets\",\"url\":\"classes/LambdaFunction.html#grantUploadAssets\",\"classes\":\"\",\"parent\":\"LambdaFunction\"},{\"kind\":2048,\"name\":\"grantDeleteAsset\",\"url\":\"classes/LambdaFunction.html#grantDeleteAsset\",\"classes\":\"\",\"parent\":\"LambdaFunction\"},{\"kind\":2048,\"name\":\"grantUserpoolRead\",\"url\":\"classes/LambdaFunction.html#grantUserpoolRead\",\"classes\":\"\",\"parent\":\"LambdaFunction\"},{\"kind\":2048,\"name\":\"grantUserpoolReadWrite\",\"url\":\"classes/LambdaFunction.html#grantUserpoolReadWrite\",\"classes\":\"\",\"parent\":\"LambdaFunction\"},{\"kind\":2048,\"name\":\"setTimeout\",\"url\":\"classes/LambdaFunction.html#setTimeout\",\"classes\":\"\",\"parent\":\"LambdaFunction\"},{\"kind\":256,\"name\":\"GraphQlApiProps\",\"url\":\"interfaces/GraphQlApiProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"definitionFileName\",\"url\":\"interfaces/GraphQlApiProps.html#definitionFileName\",\"classes\":\"\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"apiName\",\"url\":\"interfaces/GraphQlApiProps.html#apiName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"stageName\",\"url\":\"interfaces/GraphQlApiProps.html#stageName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"monitoring\",\"url\":\"interfaces/GraphQlApiProps.html#monitoring\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"singleTableDatastore\",\"url\":\"interfaces/GraphQlApiProps.html#singleTableDatastore\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"authentication\",\"url\":\"interfaces/GraphQlApiProps.html#authentication\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"assetCdn\",\"url\":\"interfaces/GraphQlApiProps.html#assetCdn\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"additionalEnv\",\"url\":\"interfaces/GraphQlApiProps.html#additionalEnv\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/GraphQlApiProps.html#additionalEnv.__type\",\"classes\":\"\",\"parent\":\"GraphQlApiProps.additionalEnv\"},{\"kind\":1024,\"name\":\"lambdaOptions\",\"url\":\"interfaces/GraphQlApiProps.html#lambdaOptions\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"lambdaTracing\",\"url\":\"interfaces/GraphQlApiProps.html#lambdaTracing\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"domainName\",\"url\":\"interfaces/GraphQlApiProps.html#domainName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"hostedZone\",\"url\":\"interfaces/GraphQlApiProps.html#hostedZone\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":1024,\"name\":\"apiHostname\",\"url\":\"interfaces/GraphQlApiProps.html#apiHostname\",\"classes\":\"tsd-is-inherited\",\"parent\":\"GraphQlApiProps\"},{\"kind\":256,\"name\":\"VtlResolverOptions\",\"url\":\"interfaces/VtlResolverOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"dataSource\",\"url\":\"interfaces/VtlResolverOptions.html#dataSource\",\"classes\":\"\",\"parent\":\"VtlResolverOptions\"},{\"kind\":1024,\"name\":\"variables\",\"url\":\"interfaces/VtlResolverOptions.html#variables\",\"classes\":\"\",\"parent\":\"VtlResolverOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/VtlResolverOptions.html#variables.__type\",\"classes\":\"\",\"parent\":\"VtlResolverOptions.variables\"},{\"kind\":256,\"name\":\"JsResolverOptions\",\"url\":\"interfaces/JsResolverOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"stashValues\",\"url\":\"interfaces/JsResolverOptions.html#stashValues\",\"classes\":\"\",\"parent\":\"JsResolverOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/JsResolverOptions.html#stashValues.__type\",\"classes\":\"\",\"parent\":\"JsResolverOptions.stashValues\"},{\"kind\":1024,\"name\":\"pipelineStepNames\",\"url\":\"interfaces/JsResolverOptions.html#pipelineStepNames\",\"classes\":\"\",\"parent\":\"JsResolverOptions\"},{\"kind\":128,\"name\":\"GraphQlApi\",\"url\":\"classes/GraphQlApi.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/GraphQlApi.html#constructor\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":1024,\"name\":\"api\",\"url\":\"classes/GraphQlApi.html#api\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":1024,\"name\":\"tableDataSource\",\"url\":\"classes/GraphQlApi.html#tableDataSource\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":1024,\"name\":\"_functions\",\"url\":\"classes/GraphQlApi.html#_functions\",\"classes\":\"tsd-is-private\",\"parent\":\"GraphQlApi\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/GraphQlApi.html#_functions.__type\",\"classes\":\"\",\"parent\":\"GraphQlApi._functions\"},{\"kind\":1024,\"name\":\"cognitoAuth\",\"url\":\"classes/GraphQlApi.html#cognitoAuth\",\"classes\":\"tsd-is-private\",\"parent\":\"GraphQlApi\"},{\"kind\":1024,\"name\":\"props\",\"url\":\"classes/GraphQlApi.html#props\",\"classes\":\"tsd-is-private\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"grantAccess\",\"url\":\"classes/GraphQlApi.html#grantAccess\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"grantAccessUnAuth\",\"url\":\"classes/GraphQlApi.html#grantAccessUnAuth\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"grantAccessAuth\",\"url\":\"classes/GraphQlApi.html#grantAccessAuth\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"getFunctionForOperation\",\"url\":\"classes/GraphQlApi.html#getFunctionForOperation\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"addLambdaResolver\",\"url\":\"classes/GraphQlApi.html#addLambdaResolver\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"addDynamoDbVtlResolver\",\"url\":\"classes/GraphQlApi.html#addDynamoDbVtlResolver\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"addDynamoDbJSResolver\",\"url\":\"classes/GraphQlApi.html#addDynamoDbJSResolver\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"addJSResolver\",\"url\":\"classes/GraphQlApi.html#addJSResolver\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"addVtlResolver\",\"url\":\"classes/GraphQlApi.html#addVtlResolver\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"substVariables\",\"url\":\"classes/GraphQlApi.html#substVariables\",\"classes\":\"tsd-is-private\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"createEntryFile\",\"url\":\"classes/GraphQlApi.html#createEntryFile\",\"classes\":\"tsd-is-private\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"createJSResolverFile\",\"url\":\"classes/GraphQlApi.html#createJSResolverFile\",\"classes\":\"tsd-is-private\",\"parent\":\"GraphQlApi\"},{\"kind\":1024,\"name\":\"hostedZone\",\"url\":\"classes/GraphQlApi.html#hostedZone\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"GraphQlApi\"},{\"kind\":1024,\"name\":\"apiHostName\",\"url\":\"classes/GraphQlApi.html#apiHostName\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"GraphQlApi\"},{\"kind\":1024,\"name\":\"apiDomainName\",\"url\":\"classes/GraphQlApi.html#apiDomainName\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"GraphQlApi\"},{\"kind\":1024,\"name\":\"apiFQDN\",\"url\":\"classes/GraphQlApi.html#apiFQDN\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"GraphQlApi\"},{\"kind\":256,\"name\":\"RestApiProps\",\"url\":\"interfaces/RestApiProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"autoGenerateRoutes\",\"url\":\"interfaces/RestApiProps.html#autoGenerateRoutes\",\"classes\":\"\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"restApiProps\",\"url\":\"interfaces/RestApiProps.html#restApiProps\",\"classes\":\"\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"lambdaOptionsByOperation\",\"url\":\"interfaces/RestApiProps.html#lambdaOptionsByOperation\",\"classes\":\"\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"definitionFileName\",\"url\":\"interfaces/RestApiProps.html#definitionFileName\",\"classes\":\"\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"cors\",\"url\":\"interfaces/RestApiProps.html#cors\",\"classes\":\"\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"apiName\",\"url\":\"interfaces/RestApiProps.html#apiName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"stageName\",\"url\":\"interfaces/RestApiProps.html#stageName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"monitoring\",\"url\":\"interfaces/RestApiProps.html#monitoring\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"singleTableDatastore\",\"url\":\"interfaces/RestApiProps.html#singleTableDatastore\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"authentication\",\"url\":\"interfaces/RestApiProps.html#authentication\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"assetCdn\",\"url\":\"interfaces/RestApiProps.html#assetCdn\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"additionalEnv\",\"url\":\"interfaces/RestApiProps.html#additionalEnv\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/RestApiProps.html#additionalEnv.__type\",\"classes\":\"\",\"parent\":\"RestApiProps.additionalEnv\"},{\"kind\":1024,\"name\":\"lambdaOptions\",\"url\":\"interfaces/RestApiProps.html#lambdaOptions\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"lambdaTracing\",\"url\":\"interfaces/RestApiProps.html#lambdaTracing\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"domainName\",\"url\":\"interfaces/RestApiProps.html#domainName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"hostedZone\",\"url\":\"interfaces/RestApiProps.html#hostedZone\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":1024,\"name\":\"apiHostname\",\"url\":\"interfaces/RestApiProps.html#apiHostname\",\"classes\":\"tsd-is-inherited\",\"parent\":\"RestApiProps\"},{\"kind\":128,\"name\":\"RestApi\",\"url\":\"classes/RestApi.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/RestApi.html#constructor\",\"classes\":\"\",\"parent\":\"RestApi\"},{\"kind\":1024,\"name\":\"api\",\"url\":\"classes/RestApi.html#api\",\"classes\":\"\",\"parent\":\"RestApi\"},{\"kind\":1024,\"name\":\"apiSpec\",\"url\":\"classes/RestApi.html#apiSpec\",\"classes\":\"\",\"parent\":\"RestApi\"},{\"kind\":1024,\"name\":\"_functions\",\"url\":\"classes/RestApi.html#_functions\",\"classes\":\"tsd-is-private\",\"parent\":\"RestApi\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/RestApi.html#_functions.__type\",\"classes\":\"\",\"parent\":\"RestApi._functions\"},{\"kind\":1024,\"name\":\"props\",\"url\":\"classes/RestApi.html#props\",\"classes\":\"tsd-is-private\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"cleanupSpec\",\"url\":\"classes/RestApi.html#cleanupSpec\",\"classes\":\"tsd-is-protected\",\"parent\":\"RestApi\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/RestApi.html#cleanupSpec.cleanupSpec-1.__type-1\",\"classes\":\"\",\"parent\":\"RestApi.cleanupSpec.cleanupSpec\"},{\"kind\":2048,\"name\":\"getFunctionForOperation\",\"url\":\"classes/RestApi.html#getFunctionForOperation\",\"classes\":\"\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"getFunctions\",\"url\":\"classes/RestApi.html#getFunctions\",\"classes\":\"\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"modifyOperationFunctions\",\"url\":\"classes/RestApi.html#modifyOperationFunctions\",\"classes\":\"\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"addRestResource\",\"url\":\"classes/RestApi.html#addRestResource\",\"classes\":\"\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"addCustomRestResource\",\"url\":\"classes/RestApi.html#addCustomRestResource\",\"classes\":\"\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"tableWriteAccessForMethod\",\"url\":\"classes/RestApi.html#tableWriteAccessForMethod\",\"classes\":\"tsd-is-private\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"patchSecurity\",\"url\":\"classes/RestApi.html#patchSecurity\",\"classes\":\"tsd-is-protected\",\"parent\":\"RestApi\"},{\"kind\":1024,\"name\":\"hostedZone\",\"url\":\"classes/RestApi.html#hostedZone\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"RestApi\"},{\"kind\":1024,\"name\":\"apiHostName\",\"url\":\"classes/RestApi.html#apiHostName\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"RestApi\"},{\"kind\":1024,\"name\":\"apiDomainName\",\"url\":\"classes/RestApi.html#apiDomainName\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"RestApi\"},{\"kind\":1024,\"name\":\"apiFQDN\",\"url\":\"classes/RestApi.html#apiFQDN\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"RestApi\"},{\"kind\":256,\"name\":\"SingleTableDesign\",\"url\":\"interfaces/SingleTableDesign.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"primaryKey\",\"url\":\"interfaces/SingleTableDesign.html#primaryKey\",\"classes\":\"\",\"parent\":\"SingleTableDesign\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/SingleTableDesign.html#primaryKey.__type\",\"classes\":\"\",\"parent\":\"SingleTableDesign.primaryKey\"},{\"kind\":1024,\"name\":\"partitionKey\",\"url\":\"interfaces/SingleTableDesign.html#primaryKey.__type.partitionKey\",\"classes\":\"\",\"parent\":\"SingleTableDesign.primaryKey.__type\"},{\"kind\":1024,\"name\":\"sortKey\",\"url\":\"interfaces/SingleTableDesign.html#primaryKey.__type.sortKey\",\"classes\":\"\",\"parent\":\"SingleTableDesign.primaryKey.__type\"},{\"kind\":1024,\"name\":\"timeToLiveAttribute\",\"url\":\"interfaces/SingleTableDesign.html#timeToLiveAttribute\",\"classes\":\"\",\"parent\":\"SingleTableDesign\"},{\"kind\":1024,\"name\":\"globalIndexes\",\"url\":\"interfaces/SingleTableDesign.html#globalIndexes\",\"classes\":\"\",\"parent\":\"SingleTableDesign\"},{\"kind\":1024,\"name\":\"localIndexes\",\"url\":\"interfaces/SingleTableDesign.html#localIndexes\",\"classes\":\"\",\"parent\":\"SingleTableDesign\"},{\"kind\":256,\"name\":\"SingleTableDatastoreProps\",\"url\":\"interfaces/SingleTableDatastoreProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"design\",\"url\":\"interfaces/SingleTableDatastoreProps.html#design\",\"classes\":\"\",\"parent\":\"SingleTableDatastoreProps\"},{\"kind\":1024,\"name\":\"encryption\",\"url\":\"interfaces/SingleTableDatastoreProps.html#encryption\",\"classes\":\"\",\"parent\":\"SingleTableDatastoreProps\"},{\"kind\":1024,\"name\":\"encryptionKey\",\"url\":\"interfaces/SingleTableDatastoreProps.html#encryptionKey\",\"classes\":\"\",\"parent\":\"SingleTableDatastoreProps\"},{\"kind\":128,\"name\":\"SingleTableDatastore\",\"url\":\"classes/SingleTableDatastore.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SingleTableDatastore.html#constructor\",\"classes\":\"\",\"parent\":\"SingleTableDatastore\"},{\"kind\":1024,\"name\":\"table\",\"url\":\"classes/SingleTableDatastore.html#table\",\"classes\":\"\",\"parent\":\"SingleTableDatastore\"},{\"kind\":256,\"name\":\"WorkflowProps\",\"url\":\"interfaces/WorkflowProps.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"stateMachineType\",\"url\":\"interfaces/WorkflowProps.html#stateMachineType\",\"classes\":\"\",\"parent\":\"WorkflowProps\"},{\"kind\":1024,\"name\":\"loggingConfiguration\",\"url\":\"interfaces/WorkflowProps.html#loggingConfiguration\",\"classes\":\"\",\"parent\":\"WorkflowProps\"},{\"kind\":1024,\"name\":\"tracingConfiguration\",\"url\":\"interfaces/WorkflowProps.html#tracingConfiguration\",\"classes\":\"\",\"parent\":\"WorkflowProps\"},{\"kind\":1024,\"name\":\"definitionFileName\",\"url\":\"interfaces/WorkflowProps.html#definitionFileName\",\"classes\":\"\",\"parent\":\"WorkflowProps\"},{\"kind\":1024,\"name\":\"definitionSubstitutions\",\"url\":\"interfaces/WorkflowProps.html#definitionSubstitutions\",\"classes\":\"\",\"parent\":\"WorkflowProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/WorkflowProps.html#definitionSubstitutions.__type\",\"classes\":\"\",\"parent\":\"WorkflowProps.definitionSubstitutions\"},{\"kind\":128,\"name\":\"Workflow\",\"url\":\"classes/Workflow.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Workflow.html#constructor\",\"classes\":\"\",\"parent\":\"Workflow\"},{\"kind\":1024,\"name\":\"role\",\"url\":\"classes/Workflow.html#role\",\"classes\":\"\",\"parent\":\"Workflow\"},{\"kind\":1024,\"name\":\"workflowArn\",\"url\":\"classes/Workflow.html#workflowArn\",\"classes\":\"\",\"parent\":\"Workflow\"},{\"kind\":1024,\"name\":\"grantPrincipal\",\"url\":\"classes/Workflow.html#grantPrincipal\",\"classes\":\"\",\"parent\":\"Workflow\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,49.127]],[\"comment/0\",[]],[\"name/1\",[1,38.14]],[\"comment/1\",[]],[\"name/2\",[2,49.127]],[\"comment/2\",[]],[\"name/3\",[3,38.14]],[\"comment/3\",[]],[\"name/4\",[4,31.781]],[\"comment/4\",[]],[\"name/5\",[5,49.127]],[\"comment/5\",[]],[\"name/6\",[6,44.018]],[\"comment/6\",[]],[\"name/7\",[7,44.018]],[\"comment/7\",[]],[\"name/8\",[8,49.127]],[\"comment/8\",[]],[\"name/9\",[9,40.654]],[\"comment/9\",[]],[\"name/10\",[10,49.127]],[\"comment/10\",[]],[\"name/11\",[11,49.127]],[\"comment/11\",[]],[\"name/12\",[12,49.127]],[\"comment/12\",[]],[\"name/13\",[13,49.127]],[\"comment/13\",[]],[\"name/14\",[14,49.127]],[\"comment/14\",[]],[\"name/15\",[15,49.127]],[\"comment/15\",[]],[\"name/16\",[16,49.127]],[\"comment/16\",[]],[\"name/17\",[17,25.773]],[\"comment/17\",[]],[\"name/18\",[18,49.127]],[\"comment/18\",[]],[\"name/19\",[19,49.127]],[\"comment/19\",[]],[\"name/20\",[20,49.127]],[\"comment/20\",[]],[\"name/21\",[21,49.127]],[\"comment/21\",[]],[\"name/22\",[22,49.127]],[\"comment/22\",[]],[\"name/23\",[17,25.773]],[\"comment/23\",[]],[\"name/24\",[23,49.127]],[\"comment/24\",[]],[\"name/25\",[24,49.127]],[\"comment/25\",[]],[\"name/26\",[25,49.127]],[\"comment/26\",[]],[\"name/27\",[26,49.127]],[\"comment/27\",[]],[\"name/28\",[17,25.773]],[\"comment/28\",[]],[\"name/29\",[27,44.018]],[\"comment/29\",[]],[\"name/30\",[17,25.773]],[\"comment/30\",[]],[\"name/31\",[28,49.127]],[\"comment/31\",[]],[\"name/32\",[29,49.127]],[\"comment/32\",[]],[\"name/33\",[4,31.781]],[\"comment/33\",[]],[\"name/34\",[9,40.654]],[\"comment/34\",[]],[\"name/35\",[27,44.018]],[\"comment/35\",[]],[\"name/36\",[30,49.127]],[\"comment/36\",[]],[\"name/37\",[31,49.127]],[\"comment/37\",[]],[\"name/38\",[32,49.127]],[\"comment/38\",[]],[\"name/39\",[33,49.127]],[\"comment/39\",[]],[\"name/40\",[34,40.654]],[\"comment/40\",[]],[\"name/41\",[35,38.14]],[\"comment/41\",[]],[\"name/42\",[36,40.654]],[\"comment/42\",[]],[\"name/43\",[37,38.14]],[\"comment/43\",[]],[\"name/44\",[38,40.654]],[\"comment/44\",[]],[\"name/45\",[3,38.14]],[\"comment/45\",[]],[\"name/46\",[39,38.14]],[\"comment/46\",[]],[\"name/47\",[17,25.773]],[\"comment/47\",[]],[\"name/48\",[40,36.134]],[\"comment/48\",[]],[\"name/49\",[41,38.14]],[\"comment/49\",[]],[\"name/50\",[1,38.14]],[\"comment/50\",[]],[\"name/51\",[42,34.463]],[\"comment/51\",[]],[\"name/52\",[43,34.463]],[\"comment/52\",[]],[\"name/53\",[44,49.127]],[\"comment/53\",[]],[\"name/54\",[4,31.781]],[\"comment/54\",[]],[\"name/55\",[42,34.463]],[\"comment/55\",[]],[\"name/56\",[43,34.463]],[\"comment/56\",[]],[\"name/57\",[45,40.654]],[\"comment/57\",[]],[\"name/58\",[46,40.654]],[\"comment/58\",[]],[\"name/59\",[40,36.134]],[\"comment/59\",[]],[\"name/60\",[47,49.127]],[\"comment/60\",[]],[\"name/61\",[48,49.127]],[\"comment/61\",[]],[\"name/62\",[49,49.127]],[\"comment/62\",[]],[\"name/63\",[35,38.14]],[\"comment/63\",[]],[\"name/64\",[50,49.127]],[\"comment/64\",[]],[\"name/65\",[51,49.127]],[\"comment/65\",[]],[\"name/66\",[52,49.127]],[\"comment/66\",[]],[\"name/67\",[53,44.018]],[\"comment/67\",[]],[\"name/68\",[54,49.127]],[\"comment/68\",[]],[\"name/69\",[9,40.654]],[\"comment/69\",[]],[\"name/70\",[55,49.127]],[\"comment/70\",[]],[\"name/71\",[6,44.018]],[\"comment/71\",[]],[\"name/72\",[7,44.018]],[\"comment/72\",[]],[\"name/73\",[56,49.127]],[\"comment/73\",[]],[\"name/74\",[39,38.14]],[\"comment/74\",[]],[\"name/75\",[17,25.773]],[\"comment/75\",[]],[\"name/76\",[40,36.134]],[\"comment/76\",[]],[\"name/77\",[41,38.14]],[\"comment/77\",[]],[\"name/78\",[57,49.127]],[\"comment/78\",[]],[\"name/79\",[4,31.781]],[\"comment/79\",[]],[\"name/80\",[58,40.654]],[\"comment/80\",[]],[\"name/81\",[59,49.127]],[\"comment/81\",[]],[\"name/82\",[60,49.127]],[\"comment/82\",[]],[\"name/83\",[61,49.127]],[\"comment/83\",[]],[\"name/84\",[62,49.127]],[\"comment/84\",[]],[\"name/85\",[63,49.127]],[\"comment/85\",[]],[\"name/86\",[64,49.127]],[\"comment/86\",[]],[\"name/87\",[65,49.127]],[\"comment/87\",[]],[\"name/88\",[66,49.127]],[\"comment/88\",[]],[\"name/89\",[67,49.127]],[\"comment/89\",[]],[\"name/90\",[68,49.127]],[\"comment/90\",[]],[\"name/91\",[69,40.654]],[\"comment/91\",[]],[\"name/92\",[34,40.654]],[\"comment/92\",[]],[\"name/93\",[35,38.14]],[\"comment/93\",[]],[\"name/94\",[36,40.654]],[\"comment/94\",[]],[\"name/95\",[37,38.14]],[\"comment/95\",[]],[\"name/96\",[38,40.654]],[\"comment/96\",[]],[\"name/97\",[3,38.14]],[\"comment/97\",[]],[\"name/98\",[39,38.14]],[\"comment/98\",[]],[\"name/99\",[17,25.773]],[\"comment/99\",[]],[\"name/100\",[40,36.134]],[\"comment/100\",[]],[\"name/101\",[41,38.14]],[\"comment/101\",[]],[\"name/102\",[1,38.14]],[\"comment/102\",[]],[\"name/103\",[42,34.463]],[\"comment/103\",[]],[\"name/104\",[43,34.463]],[\"comment/104\",[]],[\"name/105\",[70,49.127]],[\"comment/105\",[]],[\"name/106\",[71,49.127]],[\"comment/106\",[]],[\"name/107\",[72,49.127]],[\"comment/107\",[]],[\"name/108\",[17,25.773]],[\"comment/108\",[]],[\"name/109\",[73,49.127]],[\"comment/109\",[]],[\"name/110\",[74,49.127]],[\"comment/110\",[]],[\"name/111\",[17,25.773]],[\"comment/111\",[]],[\"name/112\",[75,49.127]],[\"comment/112\",[]],[\"name/113\",[76,49.127]],[\"comment/113\",[]],[\"name/114\",[4,31.781]],[\"comment/114\",[]],[\"name/115\",[77,44.018]],[\"comment/115\",[]],[\"name/116\",[78,49.127]],[\"comment/116\",[]],[\"name/117\",[79,44.018]],[\"comment/117\",[]],[\"name/118\",[17,25.773]],[\"comment/118\",[]],[\"name/119\",[80,49.127]],[\"comment/119\",[]],[\"name/120\",[58,40.654]],[\"comment/120\",[]],[\"name/121\",[81,49.127]],[\"comment/121\",[]],[\"name/122\",[82,49.127]],[\"comment/122\",[]],[\"name/123\",[83,49.127]],[\"comment/123\",[]],[\"name/124\",[84,44.018]],[\"comment/124\",[]],[\"name/125\",[85,49.127]],[\"comment/125\",[]],[\"name/126\",[86,49.127]],[\"comment/126\",[]],[\"name/127\",[87,49.127]],[\"comment/127\",[]],[\"name/128\",[88,49.127]],[\"comment/128\",[]],[\"name/129\",[89,49.127]],[\"comment/129\",[]],[\"name/130\",[90,49.127]],[\"comment/130\",[]],[\"name/131\",[91,49.127]],[\"comment/131\",[]],[\"name/132\",[92,49.127]],[\"comment/132\",[]],[\"name/133\",[42,34.463]],[\"comment/133\",[]],[\"name/134\",[43,34.463]],[\"comment/134\",[]],[\"name/135\",[45,40.654]],[\"comment/135\",[]],[\"name/136\",[46,40.654]],[\"comment/136\",[]],[\"name/137\",[93,44.018]],[\"comment/137\",[]],[\"name/138\",[94,49.127]],[\"comment/138\",[]],[\"name/139\",[93,44.018]],[\"comment/139\",[]],[\"name/140\",[95,49.127]],[\"comment/140\",[]],[\"name/141\",[69,40.654]],[\"comment/141\",[]],[\"name/142\",[96,49.127]],[\"comment/142\",[]],[\"name/143\",[34,40.654]],[\"comment/143\",[]],[\"name/144\",[35,38.14]],[\"comment/144\",[]],[\"name/145\",[36,40.654]],[\"comment/145\",[]],[\"name/146\",[37,38.14]],[\"comment/146\",[]],[\"name/147\",[38,40.654]],[\"comment/147\",[]],[\"name/148\",[3,38.14]],[\"comment/148\",[]],[\"name/149\",[39,38.14]],[\"comment/149\",[]],[\"name/150\",[17,25.773]],[\"comment/150\",[]],[\"name/151\",[40,36.134]],[\"comment/151\",[]],[\"name/152\",[41,38.14]],[\"comment/152\",[]],[\"name/153\",[1,38.14]],[\"comment/153\",[]],[\"name/154\",[42,34.463]],[\"comment/154\",[]],[\"name/155\",[43,34.463]],[\"comment/155\",[]],[\"name/156\",[97,49.127]],[\"comment/156\",[]],[\"name/157\",[4,31.781]],[\"comment/157\",[]],[\"name/158\",[77,44.018]],[\"comment/158\",[]],[\"name/159\",[98,49.127]],[\"comment/159\",[]],[\"name/160\",[79,44.018]],[\"comment/160\",[]],[\"name/161\",[17,25.773]],[\"comment/161\",[]],[\"name/162\",[58,40.654]],[\"comment/162\",[]],[\"name/163\",[99,49.127]],[\"comment/163\",[]],[\"name/164\",[17,25.773]],[\"comment/164\",[]],[\"name/165\",[84,44.018]],[\"comment/165\",[]],[\"name/166\",[100,49.127]],[\"comment/166\",[]],[\"name/167\",[101,49.127]],[\"comment/167\",[]],[\"name/168\",[102,49.127]],[\"comment/168\",[]],[\"name/169\",[103,49.127]],[\"comment/169\",[]],[\"name/170\",[104,49.127]],[\"comment/170\",[]],[\"name/171\",[105,49.127]],[\"comment/171\",[]],[\"name/172\",[42,34.463]],[\"comment/172\",[]],[\"name/173\",[43,34.463]],[\"comment/173\",[]],[\"name/174\",[45,40.654]],[\"comment/174\",[]],[\"name/175\",[46,40.654]],[\"comment/175\",[]],[\"name/176\",[106,49.127]],[\"comment/176\",[]],[\"name/177\",[107,49.127]],[\"comment/177\",[]],[\"name/178\",[17,25.773]],[\"comment/178\",[]],[\"name/179\",[108,49.127]],[\"comment/179\",[]],[\"name/180\",[109,49.127]],[\"comment/180\",[]],[\"name/181\",[110,49.127]],[\"comment/181\",[]],[\"name/182\",[111,49.127]],[\"comment/182\",[]],[\"name/183\",[112,49.127]],[\"comment/183\",[]],[\"name/184\",[113,49.127]],[\"comment/184\",[]],[\"name/185\",[114,49.127]],[\"comment/185\",[]],[\"name/186\",[115,49.127]],[\"comment/186\",[]],[\"name/187\",[116,49.127]],[\"comment/187\",[]],[\"name/188\",[37,38.14]],[\"comment/188\",[]],[\"name/189\",[4,31.781]],[\"comment/189\",[]],[\"name/190\",[53,44.018]],[\"comment/190\",[]],[\"name/191\",[117,49.127]],[\"comment/191\",[]],[\"name/192\",[118,49.127]],[\"comment/192\",[]],[\"name/193\",[119,49.127]],[\"comment/193\",[]],[\"name/194\",[120,49.127]],[\"comment/194\",[]],[\"name/195\",[69,40.654]],[\"comment/195\",[]],[\"name/196\",[121,49.127]],[\"comment/196\",[]],[\"name/197\",[17,25.773]],[\"comment/197\",[]],[\"name/198\",[122,49.127]],[\"comment/198\",[]],[\"name/199\",[4,31.781]],[\"comment/199\",[]],[\"name/200\",[123,49.127]],[\"comment/200\",[]],[\"name/201\",[124,49.127]],[\"comment/201\",[]],[\"name/202\",[125,49.127]],[\"comment/202\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":17,\"name\":{\"17\":{},\"23\":{},\"28\":{},\"30\":{},\"47\":{},\"75\":{},\"99\":{},\"108\":{},\"111\":{},\"118\":{},\"150\":{},\"161\":{},\"164\":{},\"178\":{},\"197\":{}},\"comment\":{}}],[\"_functions\",{\"_index\":79,\"name\":{\"117\":{},\"160\":{}},\"comment\":{}}],[\"addcustomrestresource\",{\"_index\":103,\"name\":{\"169\":{}},\"comment\":{}}],[\"adddynamodbjsresolver\",{\"_index\":87,\"name\":{\"127\":{}},\"comment\":{}}],[\"adddynamodbvtlresolver\",{\"_index\":86,\"name\":{\"126\":{}},\"comment\":{}}],[\"additionalenv\",{\"_index\":39,\"name\":{\"46\":{},\"74\":{},\"98\":{},\"149\":{}},\"comment\":{}}],[\"addjsresolver\",{\"_index\":88,\"name\":{\"128\":{}},\"comment\":{}}],[\"addlambdaresolver\",{\"_index\":85,\"name\":{\"125\":{}},\"comment\":{}}],[\"addrestresource\",{\"_index\":102,\"name\":{\"168\":{}},\"comment\":{}}],[\"addvtlresolver\",{\"_index\":89,\"name\":{\"129\":{}},\"comment\":{}}],[\"api\",{\"_index\":77,\"name\":{\"115\":{},\"158\":{}},\"comment\":{}}],[\"apidomainname\",{\"_index\":45,\"name\":{\"57\":{},\"135\":{},\"174\":{}},\"comment\":{}}],[\"apifqdn\",{\"_index\":46,\"name\":{\"58\":{},\"136\":{},\"175\":{}},\"comment\":{}}],[\"apihostname\",{\"_index\":43,\"name\":{\"52\":{},\"56\":{},\"104\":{},\"134\":{},\"155\":{},\"173\":{}},\"comment\":{}}],[\"apiname\",{\"_index\":34,\"name\":{\"40\":{},\"92\":{},\"143\":{}},\"comment\":{}}],[\"apispec\",{\"_index\":98,\"name\":{\"159\":{}},\"comment\":{}}],[\"assetbucket\",{\"_index\":6,\"name\":{\"6\":{},\"71\":{}},\"comment\":{}}],[\"assetcdn\",{\"_index\":3,\"name\":{\"3\":{},\"45\":{},\"97\":{},\"148\":{}},\"comment\":{}}],[\"assetcdnprops\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"assetdomainname\",{\"_index\":7,\"name\":{\"7\":{},\"72\":{}},\"comment\":{}}],[\"audience\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"authentication\",{\"_index\":38,\"name\":{\"44\":{},\"96\":{},\"147\":{}},\"comment\":{}}],[\"autogenerateroutes\",{\"_index\":94,\"name\":{\"138\":{}},\"comment\":{}}],[\"baseapi\",{\"_index\":44,\"name\":{\"53\":{}},\"comment\":{}}],[\"baseapiprops\",{\"_index\":33,\"name\":{\"39\":{}},\"comment\":{}}],[\"cleanupspec\",{\"_index\":99,\"name\":{\"163\":{}},\"comment\":{}}],[\"cognitoauth\",{\"_index\":80,\"name\":{\"119\":{}},\"comment\":{}}],[\"cognitoauthentication\",{\"_index\":29,\"name\":{\"32\":{}},\"comment\":{}}],[\"cognitoauthenticationprops\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":4,\"name\":{\"4\":{},\"33\":{},\"54\":{},\"79\":{},\"114\":{},\"157\":{},\"189\":{},\"199\":{}},\"comment\":{}}],[\"cors\",{\"_index\":96,\"name\":{\"142\":{}},\"comment\":{}}],[\"createentryfile\",{\"_index\":91,\"name\":{\"131\":{}},\"comment\":{}}],[\"createjsresolverfile\",{\"_index\":92,\"name\":{\"132\":{}},\"comment\":{}}],[\"custommessagefunction\",{\"_index\":30,\"name\":{\"36\":{}},\"comment\":{}}],[\"custommessages\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"datasource\",{\"_index\":71,\"name\":{\"106\":{}},\"comment\":{}}],[\"definitionfilename\",{\"_index\":69,\"name\":{\"91\":{},\"141\":{},\"195\":{}},\"comment\":{}}],[\"definitionsubstitutions\",{\"_index\":121,\"name\":{\"196\":{}},\"comment\":{}}],[\"description\",{\"_index\":52,\"name\":{\"66\":{}},\"comment\":{}}],[\"design\",{\"_index\":114,\"name\":{\"185\":{}},\"comment\":{}}],[\"domainname\",{\"_index\":1,\"name\":{\"1\":{},\"50\":{},\"102\":{},\"153\":{}},\"comment\":{}}],[\"email\",{\"_index\":25,\"name\":{\"26\":{}},\"comment\":{}}],[\"encryption\",{\"_index\":115,\"name\":{\"186\":{}},\"comment\":{}}],[\"encryptionkey\",{\"_index\":116,\"name\":{\"187\":{}},\"comment\":{}}],[\"entry\",{\"_index\":50,\"name\":{\"64\":{}},\"comment\":{}}],[\"getfunctionforoperation\",{\"_index\":84,\"name\":{\"124\":{},\"165\":{}},\"comment\":{}}],[\"getfunctions\",{\"_index\":100,\"name\":{\"166\":{}},\"comment\":{}}],[\"globalindexes\",{\"_index\":111,\"name\":{\"182\":{}},\"comment\":{}}],[\"grantaccess\",{\"_index\":81,\"name\":{\"121\":{}},\"comment\":{}}],[\"grantaccessauth\",{\"_index\":83,\"name\":{\"123\":{}},\"comment\":{}}],[\"grantaccessunauth\",{\"_index\":82,\"name\":{\"122\":{}},\"comment\":{}}],[\"grantdeleteasset\",{\"_index\":64,\"name\":{\"86\":{}},\"comment\":{}}],[\"grantprincipal\",{\"_index\":125,\"name\":{\"202\":{}},\"comment\":{}}],[\"grantsendemails\",{\"_index\":62,\"name\":{\"84\":{}},\"comment\":{}}],[\"granttablewrite\",{\"_index\":61,\"name\":{\"83\":{}},\"comment\":{}}],[\"grantuploadassets\",{\"_index\":63,\"name\":{\"85\":{}},\"comment\":{}}],[\"grantuserpoolread\",{\"_index\":65,\"name\":{\"87\":{}},\"comment\":{}}],[\"grantuserpoolreadwrite\",{\"_index\":66,\"name\":{\"88\":{}},\"comment\":{}}],[\"graphqlapi\",{\"_index\":76,\"name\":{\"113\":{}},\"comment\":{}}],[\"graphqlapiprops\",{\"_index\":68,\"name\":{\"90\":{}},\"comment\":{}}],[\"groups\",{\"_index\":26,\"name\":{\"27\":{}},\"comment\":{}}],[\"handler\",{\"_index\":51,\"name\":{\"65\":{}},\"comment\":{}}],[\"hostedzone\",{\"_index\":42,\"name\":{\"51\":{},\"55\":{},\"103\":{},\"133\":{},\"154\":{},\"172\":{}},\"comment\":{}}],[\"hostname\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"icognitoauthentication\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"identitypool\",{\"_index\":27,\"name\":{\"29\":{},\"35\":{}},\"comment\":{}}],[\"ijwtauthentication\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"includesdk\",{\"_index\":56,\"name\":{\"73\":{}},\"comment\":{}}],[\"issuerurl\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"jsresolveroptions\",{\"_index\":73,\"name\":{\"109\":{}},\"comment\":{}}],[\"jwksurl\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"jwt\",{\"_index\":55,\"name\":{\"70\":{}},\"comment\":{}}],[\"lambdafunction\",{\"_index\":57,\"name\":{\"78\":{}},\"comment\":{}}],[\"lambdafunctionprops\",{\"_index\":49,\"name\":{\"62\":{}},\"comment\":{}}],[\"lambdaoptions\",{\"_index\":40,\"name\":{\"48\":{},\"59\":{},\"76\":{},\"100\":{},\"151\":{}},\"comment\":{}}],[\"lambdaoptionsbyoperation\",{\"_index\":95,\"name\":{\"140\":{}},\"comment\":{}}],[\"lambdatracing\",{\"_index\":41,\"name\":{\"49\":{},\"77\":{},\"101\":{},\"152\":{}},\"comment\":{}}],[\"lambdatracingoptions\",{\"_index\":47,\"name\":{\"60\":{}},\"comment\":{}}],[\"localindexes\",{\"_index\":112,\"name\":{\"183\":{}},\"comment\":{}}],[\"loggingconfiguration\",{\"_index\":119,\"name\":{\"193\":{}},\"comment\":{}}],[\"modifyoperationfunctions\",{\"_index\":101,\"name\":{\"167\":{}},\"comment\":{}}],[\"monitoring\",{\"_index\":36,\"name\":{\"42\":{},\"94\":{},\"145\":{}},\"comment\":{}}],[\"name\",{\"_index\":24,\"name\":{\"25\":{}},\"comment\":{}}],[\"partitionkey\",{\"_index\":108,\"name\":{\"179\":{}},\"comment\":{}}],[\"patchsecurity\",{\"_index\":105,\"name\":{\"171\":{}},\"comment\":{}}],[\"pipelinestepnames\",{\"_index\":75,\"name\":{\"112\":{}},\"comment\":{}}],[\"poolconfig\",{\"_index\":28,\"name\":{\"31\":{}},\"comment\":{}}],[\"presignup\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"presignupfunction\",{\"_index\":31,\"name\":{\"37\":{}},\"comment\":{}}],[\"pretokengeneration\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"pretokengenerationfunction\",{\"_index\":32,\"name\":{\"38\":{}},\"comment\":{}}],[\"primarykey\",{\"_index\":107,\"name\":{\"177\":{}},\"comment\":{}}],[\"props\",{\"_index\":58,\"name\":{\"80\":{},\"120\":{},\"162\":{}},\"comment\":{}}],[\"region\",{\"_index\":23,\"name\":{\"24\":{}},\"comment\":{}}],[\"restapi\",{\"_index\":97,\"name\":{\"156\":{}},\"comment\":{}}],[\"restapiprops\",{\"_index\":93,\"name\":{\"137\":{},\"139\":{}},\"comment\":{}}],[\"role\",{\"_index\":123,\"name\":{\"200\":{}},\"comment\":{}}],[\"sesemailsender\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"settable\",{\"_index\":59,\"name\":{\"81\":{}},\"comment\":{}}],[\"settimeout\",{\"_index\":67,\"name\":{\"89\":{}},\"comment\":{}}],[\"setuserpool\",{\"_index\":60,\"name\":{\"82\":{}},\"comment\":{}}],[\"singletabledatastore\",{\"_index\":37,\"name\":{\"43\":{},\"95\":{},\"146\":{},\"188\":{}},\"comment\":{}}],[\"singletabledatastoreprops\",{\"_index\":113,\"name\":{\"184\":{}},\"comment\":{}}],[\"singletabledesign\",{\"_index\":106,\"name\":{\"176\":{}},\"comment\":{}}],[\"sortkey\",{\"_index\":109,\"name\":{\"180\":{}},\"comment\":{}}],[\"stagename\",{\"_index\":35,\"name\":{\"41\":{},\"63\":{},\"93\":{},\"144\":{}},\"comment\":{}}],[\"stashvalues\",{\"_index\":74,\"name\":{\"110\":{}},\"comment\":{}}],[\"statemachinetype\",{\"_index\":118,\"name\":{\"192\":{}},\"comment\":{}}],[\"substvariables\",{\"_index\":90,\"name\":{\"130\":{}},\"comment\":{}}],[\"table\",{\"_index\":53,\"name\":{\"67\":{},\"190\":{}},\"comment\":{}}],[\"tabledatasource\",{\"_index\":78,\"name\":{\"116\":{}},\"comment\":{}}],[\"tablewriteaccessformethod\",{\"_index\":104,\"name\":{\"170\":{}},\"comment\":{}}],[\"tablewrites\",{\"_index\":54,\"name\":{\"68\":{}},\"comment\":{}}],[\"timetoliveattribute\",{\"_index\":110,\"name\":{\"181\":{}},\"comment\":{}}],[\"tracingconfiguration\",{\"_index\":120,\"name\":{\"194\":{}},\"comment\":{}}],[\"triggers\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"userpool\",{\"_index\":9,\"name\":{\"9\":{},\"34\":{},\"69\":{}},\"comment\":{}}],[\"userpoolname\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"userpoolprops\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"variables\",{\"_index\":72,\"name\":{\"107\":{}},\"comment\":{}}],[\"vtlresolveroptions\",{\"_index\":70,\"name\":{\"105\":{}},\"comment\":{}}],[\"workflow\",{\"_index\":122,\"name\":{\"198\":{}},\"comment\":{}}],[\"workflowarn\",{\"_index\":124,\"name\":{\"201\":{}},\"comment\":{}}],[\"workflowprops\",{\"_index\":117,\"name\":{\"191\":{}},\"comment\":{}}],[\"xraytracing\",{\"_index\":48,\"name\":{\"61\":{}},\"comment\":{}}],[\"zone\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81dW5PbNrL+K6ek14ki8E6/OXGyJ9lkN5uxs1XH5UpxJI6GtkbUUtRMZl3+74cACakb7CbBS6ryNBehL8DXaDQ+kNDnRZE/nxav3n9efMoO28Urxw9uFofkMV28Wrw+ndLy2+3hlyI/nhY3i3Oxr/6bHcq0uE826elr1GD1UD7uq1abfVL9u9K5WHy50WrF2vEuerf5Y5Id/iH/sFK6RAJA/83imBTpoWz5yhh+yE/lALOg+UCjTtQaxIvNRtXFYOe4+cK5aNrkh1NZnDdlXnQrW+KW3b5zY/Xf/JD2mGmajNMvZcpvzptPadljBrecYO1NO+46LL6xDzpgFc6fH77Nd4eszF+fy4dKINskZZYfqOCjW9rPqPMpLY55vh+oewnk6B4yXWD6++NzadHXViv7fman0zkt3hV0R2nFSyjE9LLtOBdH522WHjZkBuHsA5mp5j8+fzoN7P1VZIRxiC4ZCezSwLceFtW/VNHJpeweG0tDnu5/R7cYt8oi2+3SYky3l0B2gjuB77tXYH7/vXw5jhog7c2qVvGVO8Kt1aVLzHBtzqcyf/w5PZ2SXTpp0C5urlo6R3vd6OScPxbp2/xTevhbekgLNqUN7wCp90/sxG22O7w7zub7Rd2f5bKeumPzy9JUMNfkr3R8V9UF+9v0sE2LMZ61NPwFEgH2SUPtjAHY6B4zjEW6GzmXGFdXF40TPe4JzMPItYhz+zBubRrmdCpbzum1Vvjnur0r8vO42X+R/AvMrdqX1UXB4DFrOsOVxFvZvnz5hSn/+9wz5P8CAwY90iEnxgwc6hq3NlaffZsf7rPdbK6ukM5JXhMTBFAL3dtLvbUdvrW0JR06NpY2DETf1rJ7h2vhRO/udpAH5ESz8GL8BLOqqL8/HzYDcV9yCmbw7VIcjvGLEp7HJ6PYHukcr2Wcl3B7/U1ySl8fM7bghZ/bb6GTY8btnlsKl9fGdHeQi1x9XFYhZW8SNh9v9DGXw1xkBzKJt62i9hP6WinYp2+Tu336JimTak4Vtt2mJce7kvTSbgTcpswE8ybJ3W342nqCye02k34n++8OT5Z2DZFBxm2rmx6zfXUgEscOMwOxTx7vtsk/j7KhXeZYmiLjUag1vS2SjfXkM0XGG+8+R2pbtjhGsjErj4XS7f/B85FOs6j9hIA/Zv9baeI2oGQ6BwLDDIMqs2nSWiqb/89SSUJdVrWjdsoeItIUA0152n6Vnb46FnmZbqoGAyw3g04eMiHTuOFctjuOuEzrzPnWNPvf/+vNP3otN43G2nTWcSj8a2D9RCZAmWVPX6PPOkMV1mI/wRTVkVmpdva12R+/Ji8dmZNVvsSC9AQhu9DVW13MsgUo0cy+r51lIafZojqkfOdIsENZvAwyryUmm35IDts9zRazxq8yk81v09OmyI5cZci6gOUmu1HKcneQA1piHtP/LrKSPoDqduAiN9kNfSgxyAcgNNmBj8/lINt1+8lmqWc9bMzbPPkx1A1ihbR2xeKRkAHuZIfN/rxNb9/8fZAnSGz6mPRto/gRsdpNdbtiu6myc6Jvb0VpmWeLxfpnt9MagFfvhqvHFbu6gXUF7Atwy1bRhz+eZZdAqLTaLBiesiwhLHy6bOqWRAGbPSVlamXbWXvXsaxyy1u0OnaZB40H9te0+c5cj3rMvhu2FHGWd0VyqLugllYr622ZyR7IM0h1GGmHeltmsgfvjvs82aqnCAf4YEhN9uJNuk/LVOmzdwILTR+J5qjm1zTZDhgJLDWrFwNDkxKdODvfZo9pfrbDBDUfahfsBf9WJMeHf+27DiKMJgMe+07vs4NabL/P9uxmkFK/JEXpbpo9GH4wQnpAnY00WT87PKQS8e0INzr3xaQj9J54Ble6D1FIX5hzlDnGxfJohR6ivtOVGRzsP3Chw4g/c5nDqY5jGNod6iRmDkf6dhW0N+yOYpxLtruLfmf6dhamhnl2FaRf/I5iBtx6dxcdLlE7ixlc6j7koVeLTmZ7ijPdRz+kM91HDJMmWfeBELeMkWdC49yBlcNvZVX7nPL9U1p0hHS71YD6ocrlt/m5oN++YDQvkRQ9ewnXGReekiKTy8qQvi2h0AgHbLNYr/m+JEYouLpOg/7jyQLzVqNBxwanh9+S/ZkecVrzEkvRnW17PnzE+833DXlbA/SdIyqyY7rPDultmR5lkhsyNJTs8AGCNNA1O7Q2KtePZqF/DHVW1A/wjs+ivZbqNmMtlLoQNZIXZ63dfqzl3++b3V6bXTCNoqY2xBZpvXPm9Ju2L7NWwF/uKcnrw3cWoQTbju6+BZ9oWh7CJZI22yzG602VAPot47YDQoyz+O5gNdaUxAzWh9qeajktNZXyfV6lSPPtMNYDVm6sJ9Veo6Z2dL7uT2eExATrb16q3/M3d6B+sHGBFpvBjx9vx7iBpCZ4Mcz6XFYHjv08Y346353K31olMWe31XyenLcp0krmO/mshiQH+3N9q/2cflwBHeBMS2ieFajjKTjTD8sH4f7Hbp845uE4ouayej5uuksdz8wRTlk+NjfdLfJROsKh3qfphrsCt3hVZJZdxwHw8wHvJZzLvHmRIv01PzPP5bR0L0k5On8hx9nXUAd2bmlIjDeNeLxvXtoVRKcbHdLjXbI7oGk7M+B0xsaNTU7frdA23LQcb6rjFIiIvYFHQDYOdJ7/tF0Yfvhj40T3yU/bixHHPlZjYXnmQwzLlAMfqzjpPe0hU9WYox4rdzrOeQhHhh7yWLnQd8JD+DHqeIdxxpaj63Gjj3FA4vOc6vQk81lR6j3P4ZwZephjtbx0nuQQy8rwYxwbN7rPcNpujDjAsVx6uk5vyOVn8NEN5wjgb5smrUqz+f8szC3UZUXbaqcGcLbIRhdh26/79phuevU3jUbZ6OBlkZnBpGzbrhUjyxi1TI4WXCzNhSKzQ4jQdjfxTnyfJofzsR9G3JDfQc09xMDuCvz+lei/7kLrYVRMpSuRm0O5yh5YgLqeWDBajrL2mG+z++vGyNJyh9QoL6qSQbaQ9A559oOzSqvxWJvfqgseBlkmRUbZv740UzPtVez8nJYPefvBTuRDl9gMSeGYlJuH23Rzriy89KQio+nYxGBLxiHjczBx/UscS8OZy9x0Dq7fmQ4CznRnDvat3yGSejNdmca7EdEKSLdbsKFNT9mO3Om1GtnTb9X0eUyKl7+n5AuRtOIlEqIzQ9vv4Tu2Xut9ZUlbAfCcG5CkKNXebuyQNE6tDEXDPey5E+2UF+VUH686ZnevzB7Tt/lP2VP6uiyL7O5cDsGYlh4eavgWuX1+l+x/OGzTP2iWmXHGlJvoxj7fjPHCEBvuBJdWNE/Gct9s4yFP/Nvkrrby5UWwv7+4H+y735vihX0BuscZJDy7QxaTudMn24nMugW4AKp9ax2kGs3CErCKrSgD0nerN9H77Xe/h95jGU7Af+fFp/t9/sxOOtRg0HOSZfpzsnnIDulbZl1tq14SYnQXsd9shtvtqqGobz4886dZhCOM6ARnyprAHOMMIzrBGbuDNcKVASdrAx25lQ9jZOWZpak7vTGlh7lkWwnau9BXEmJNXD/opKhlW/lCfzBL8kPKrBLexS/ubDsnchw20zQZp/+5+fx10aaRsBnccpw19eTeL0V22GTHpP3CMjbYatxn88NNFXdVjbV49XnxlBYnOeNfLZyVu4orgfss3W8r4fcLTb7nj49SxYfms99SiZRsUTf5er24eb++8eKVcMIPH27eawn1gfqHaiaqv8SNG62Eh1oJ1Mqp/nIoZQ5q5lZ/uYQyF7Xyqr+8G1eswkigZh5q5ld/+ZRNHzULqr+CG89brUWEmgWoWVj9FVLNQtQsqv6KKKMRalZB8j6+8darwMc9jfHgyrEWJArCgEHhIMiWGAohh1yQYAiMhpDDLlyyJUZEyJEXHtkSgyLk4AsSFoFxEXL8RUC2xNAICYEIbxx/FYYubonRERIFQeIjMEBCAiFisiXGyJFAOCRGDsbIkUA4JEaOMV3UfKEnDMbIcdm+OxgjRwLhkGg6GCNHAuGQaDoYI0cC4ZBoOhgjRwLhkGg6GCMn4nuEMXIkEA45KR2MkbtmdboYI1dhREaIizFyFUZkhLhGVnO5hOViiFyPSwsuRsj12Z67GCFXwuCS0elihFwJg0tGp4sRciUMLhmdLkbIlTC4ZMy5GCFPwuB6VN89jJAnYXB9YpXwMECeRKEq0iiVGCBPrTshpdJYeSQMbkSqxAh5PrOUeRgfT+ETUw0xPB6f5DwMjycx8NY3brASrqETw+NJDDxq9fYwOv6aWeV9jI0vEfCcG9dbeQF20sfg+BIBzyVbYnB8NXvIbORjdHy2MPCNysDn3cTw+AHvJsbHlyB4PhUaPsbHV/iQceljfPyYRdLHAAUSBy+kBinAEAUKIjLBBRiiQEFEJrgAQxS43JQMMEKBxMEns1GAIQpU9UZmo8Co3yQOPpmNAgxRIHHwXbLWwxAFEgefjLkAQxSwlVyAEQolDD65VIYYoVDCQFakIQYolCjQNSnGJ5Qo+OTiG2KAQo9LRyHGJ/TZdBRifMKADeLQKLFDLh2FGJ5QwUNGe4jhCWMuJYQYnkjBQ2b2CMMTSRB8clpEGJ9IohCQ0R5hgCKJQkBGe4QBiiQMARntEUYokjAE5NobYYQitQUioz3CCEUSh4AM4sjYB0kcAjLkIgxRJIEISDAjjFEsgQjI1BVjjGI1hegNFsYodti6I8YYxWySizFEscfWHTGGKPa5uiPGCMUBW3fEGKE4ZOqOGOMTR9xEj42dasxO9NjcrK7ZmV5/BtsKbq7XH8GmDlN81J/Ali67rtefwbYeu7LXn8G2Eo2Q2YYbu9a1xCOkN+JrY9+6VqQCvRVfGzvXNb8tqj+DbSUwIb1xXxugKR4hpLfuLY5B8D6YLIPiEkJ6o2/yDIpNCOmtvsk0CLbIEybVoAiFkFwghUk2KEohpJkBk25QpEIY03oN2EQHbCbloIiFiA4zg3QQDr9eCYN2EIpciOiQdExySEITMeyQAZsiGCI6zAzyQSiKIfLIMTPoB6FIhogOHYOAEIpmiOjQMSgIoYiGiFxphEFCCEU1RHQ8GDSEUGRDRHNFBhEhFN0Q0xgbVIRQhENM42aQEUJRDjGNm2vSeh1p0mAkhNuRJg1SQijqgd4CCYOWEIp8oDdBwiAmhKIfYrJuFwY1IRQBEdPpzCAnhKIgOL0GboqEiOmYNAgK4fHVhzA4CqGYiJiOX4OlEDVNQdYqwjMJWY+rVoTBVIiaqqChMNgKUdMVVMUiDL5CKFaCrlmEwVgIxUtQVYswGAuhiAmybhEGZyF8nvQTBm8hauKCLl0M5kLU1AVZkBjUhVAEBd3SwKvmLug56ZsUus/PSYO/EIqliOmcZzAYoqYwyKXVoDCEIiqYpdUgMYSiKmI6lRo0hlBkBbO0GkSGCDqqEYPKEIqwYJZLg8wQirOI6XRu8BlCsRacDwZsirdglsDAPPtQhx9rep0waA2hyIuqbKYbG8gp/qKqnOnGBnSKw6hKZ7qxgV1YH1bRudfgOISiMqrimW5soKfoDGZyGFSHUIQGMzkMskMoToNZsAy+QyhWg1mwDMZDhDV6dFYPzcOrGj16ihrEhwg7ykmD+hBhDR498Qz6Q0Q1eHTUGwyIiOrDRjo6DRJEKKpDMEeTBg8iFNshmNNJgwoRivAQzAGlwYYIxXkI5ozSIESEoj0Ec0xpcCJCMR+COak0aBGhyA96ATV4ERGx3JUwiBGh6A+a2RQGNSLiGjw63gx2RMQ1eHQMGQSJiGvwmENTAzxFhQj63FQYPIlQdAhTURlUiVCEiKCPWYXBloi44+jYYEyEIkYEfSorDNZExDx4Bm3iKGpEMCezBm/iKHJEMIezBnPi1MwJcz7bkCfqsZGntCjT7Q/14yPv31+eZ/q8+L15pqQaI6VUPl1S7XFfff5ys6j2ePXPqP5Z7V/UT6/5vEqL6mfVYfVT8hT1L0LoX/R//EZWrtzNL17zS6jbxErvl+uzK/Iv2Sf4juHV5aqMuLqsfZZVBK0k2W7r75SV12MUl/eHwBBU6+BVYRDzerbqPqbt3cdTcbmh6KongkPpcH0Cap7KPakngHoCXk/zwncq31i/irtgeLygQawZ81gPudfRS6Z3EfQq4sXrl7RJFT5U4fMqeKQciFSHE9zQwtBx2DGQb+iCeIO4Cl8HNmv9mNVvhysZoMcD3fd12LpaXw0Rre/+P/KGBKAJRIivIXUDrYkd2WP2cHlLG2gD4V9tdJQSXytb69nq6l/8i8cub8e04XogKJuUEDs6GDsUndT7r1dFMQxDn0VQXitx13w501UYDJueGKJLwwYPOxinJkN6OhNqOD02Khp9zavEV6Xrq1I2g0lZOqZAaOrk7HBaztssPRgTCs4nXhBfFgIGBIDh6RSjI8djM+C5zHfNPUlFc08SABhEimR2aB13ySk1pqkHBH0uohq5FgouxJaLquZd5lZIwqQScJabazwTdbUjyEhrmFxYy1dhGgkH+OByQJJaWkMhIABcUkIPAQMMQDw0tUMzU/zm71DXDOKST/TcifRHMT8MBY4VuFJ6bLfVPXapvFTvXl1hBxQIGGxcLqgVXJfFlhY4i/jRV0XIY/3F9rqwQTEIQsHlln2kBeMGMyM3b+SN4+11NYTDsOZMXx9NlwNgZqIARGCsaz1P/xJza9JV6Qk/tw+TFHQv5t0D3wh5lfYBOEGHrHqnCxhF0yBi3SezMvS3CX9dBq/1osemqFR+hROa26BuYMtB+CIY7AUsuaJ+4U/yjS0oD2dYxGX0tP4yUjDoIJQDLofs0lJPg/u8ykKXKxxAdoQgODpjBBwaQCOOoDXMsmwU1G9VZvqFRjgMENGIm+Hq0f6kubUYdAIKO1ySAcKtNQLuTxwuboCC86GlAi30nR3Yqm/PUjUHmt8ACjaQlILj9eUGOIlhFK87PTillUzzRWbAAdCFiI0pKa9eiXuuv+gKyAMYos5BPKsvMVMjgD0AOLAZodbQfONWob78C2gAg8DOppaGdlfArIy4VL+Tt2f+Z29uZuCEFh3D0Mi2yoMALDMxV7HuqroOiznALrs3vnyvMMgkADV23tf3UvxX3UsBihEQML7Ow3rzsm7qEqELFOFfeAkuOKnNE7DBiWW91RsYUg7NbCtFy5ej+opDYB/sAJymgHK5cco+Ppe8FwImSQ7Z5hteT9tPCCWALrstzKrElBby3SiUWmE8MpLX0is/tukgmB3XXOn48fnTyTQNBTmn1bcMg46CCRxyY1QzIFSJ58P9Ggc1Fm9NQA8UWgEXc7UOYrQ8ALLXUAd+EzfhZdOvqxWfQwTpv3shF+8Y1h5e92CV+k4/4CmIDE97qPcKa11Y+t0j0OilBgJAwXKH6oYDsiCA6ym7mjSvDm/w27pQDdw6xpya+uKnyxgzJQ6cSAGXYeH1qGDnAaav1xSosU6HHpdNWqkQVAgsu3e5g8SsNNdw+xJy01hdf3S6XH8E5WG0sbSO/o6Zar04ytY4k0AVLB0iM3CNKOo8cJ/dSB4Ltc84H5EkmJEOF4gXSXLjCKB3OeQrDWX+KT00zIsZiSgQrVWQ3oCpwfI3zaUtrSBApxF8V4yU6MMFVOcu53LywCFZpDuTRgFLgsPVmJKdNqqqGPrtc9VxI9hyP0YL0YUZ5mCo34yGpTX0es2F0Ck91UW1rK5RjeXAIoYbrKoYbq6aAOMOoibigl4K6q9/BWUkGLGI62klqutgJAtmDLsZq+9dVi5vr/eFgDAFDnhNDRjr6lCfmwi2uqbUt6k0VGKwmxaoq01ErGHFHnKxJe9Nas0mOKkjNi7kvd0tvh6kQk3iBHqUdMXssR2SXxT21HzJGcivcDfPVpjq4o/H+uKP1mklIrliFntJJYGvtgNTDda4LudCO9ABjoGeoOzu5xoVbaYN+i84MK8b2Ho/f58Xj811gxBeOJxsMXrVhVMmEGYP0uS8LfN99pQm1zuvIBpwNNkE0NRgfBUEV0ARc0FVObDbpZgARvQUN5pUCoFkZQ2nPt9iz3+1mhbZB6sGruzRwq0UAblNlhsiQzmEJeiaWyvBQSi1d0JbPs7558stIxA0aD7mIkiLJoUBOawV11y/tTSRWOGCG3PyfxTJC7WzAJMw4GRNNgEe3lIiH24uxeXi1fsPX778PzB1Wcu/qgAA"; \ No newline at end of file diff --git a/docs/constructs/assets/style.css b/docs/constructs/assets/style.css index 258146f..07a385b 100644 --- a/docs/constructs/assets/style.css +++ b/docs/constructs/assets/style.css @@ -11,6 +11,7 @@ --light-color-text-aside: #6e6e6e; --light-color-link: #1f70c2; + --light-color-ts-keyword: #056bd6; --light-color-ts-project: #b111c9; --light-color-ts-module: var(--light-color-ts-project); --light-color-ts-namespace: var(--light-color-ts-project); @@ -50,6 +51,7 @@ --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; + --dark-color-ts-keyword: #3399ff; --dark-color-ts-project: #e358ff; --dark-color-ts-module: var(--dark-color-ts-project); --dark-color-ts-namespace: var(--dark-color-ts-project); @@ -91,6 +93,7 @@ --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -132,6 +135,7 @@ --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -180,6 +184,7 @@ body { --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -219,6 +224,7 @@ body { --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -910,8 +916,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -924,7 +931,10 @@ a.tsd-index-link { background-color: var(--color-accent); } #tsd-search .results a { - display: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -980,6 +990,11 @@ a.tsd-index-link { overflow-x: auto; } +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + .tsd-signature-symbol { color: var(--color-text-aside); font-weight: normal; @@ -1134,7 +1149,7 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; } .warning { diff --git a/docs/constructs/classes/AssetCdn.html b/docs/constructs/classes/AssetCdn.html index 1d4a300..bf3af2c 100644 --- a/docs/constructs/classes/AssetCdn.html +++ b/docs/constructs/classes/AssetCdn.html @@ -1,171 +1,16 @@ -AssetCdn | cdk-serverless
-
- -
-
-
-
- -

Class AssetCdn

-
-

Hierarchy

-
    -
  • Construct -
      -
    • AssetCdn
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
assetBucket +AssetCdn | cdk-serverless

Hierarchy

  • Construct
    • AssetCdn

Constructors

Properties

-
-

Methods

-
-
-

Constructors

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns AssetCdn

-
-

Properties

-
- -
assetBucket: Bucket
-
- -
assetDomainName: string
-
- -
node: Node
-

The tree node.

-
-
-

Stability

stable

-
-
- -
zone: IHostedZone
-
-

Methods

-
- -
    - -
  • -

    Returns a string representation of this construct.

    -
    -

    Returns string

    -
    -

    Stability

    stable

    -
-
- -
    - -
  • -

    (deprecated) Checks if x is a construct.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

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

    - -
    -

    Deprecated

    use x instanceof Construct instead

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Methods

Constructors

Properties

assetBucket: Bucket
assetDomainName: string
node: Node

The tree node.

+

Stability

stable

+
zone: IHostedZone

Methods

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

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

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/constructs/classes/BaseApi.html b/docs/constructs/classes/BaseApi.html index 24485cb..ea73326 100644 --- a/docs/constructs/classes/BaseApi.html +++ b/docs/constructs/classes/BaseApi.html @@ -1,179 +1,17 @@ -BaseApi | cdk-serverless
-
- -
-
-
-
- -

Class BaseApiAbstract

-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
apiDomainName? +BaseApi | cdk-serverless

Class BaseApiAbstract

Hierarchy

-
-

Constructors

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns BaseApi

-
-

Properties

-
- -
apiDomainName?: string
-
- -
apiFQDN?: string
-
- -
apiHostName?: string
-
- -
hostedZone?: IHostedZone
-
- -
node: Node
-

The tree node.

-
-
-

Stability

stable

-
-
-

Methods

-
- -
    - -
  • -

    Returns a string representation of this construct.

    -
    -

    Returns string

    -
    -

    Stability

    stable

    -
-
- -
    - -
  • -

    (deprecated) Checks if x is a construct.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

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

    - -
    -

    Deprecated

    use x instanceof Construct instead

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Methods

Constructors

  • Parameters

    Returns BaseApi

Properties

apiDomainName?: string
apiFQDN?: string
apiHostName?: string
hostedZone?: IHostedZone
node: Node

The tree node.

+

Stability

stable

+

Methods

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

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

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/constructs/classes/CognitoAuthentication.html b/docs/constructs/classes/CognitoAuthentication.html index 54ef6e6..6bdf570 100644 --- a/docs/constructs/classes/CognitoAuthentication.html +++ b/docs/constructs/classes/CognitoAuthentication.html @@ -1,189 +1,19 @@ -CognitoAuthentication | cdk-serverless
-
- -
-
-
-
- -

Class CognitoAuthentication

-
-

Hierarchy

-
    -
  • Construct -
      -
    • CognitoAuthentication
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
customMessageFunction? +CognitoAuthentication | cdk-serverless

Class CognitoAuthentication

Hierarchy

  • Construct
    • CognitoAuthentication

Implements

-
-

Constructors

-
- -
-
-

Properties

-
- -
customMessageFunction?: LambdaFunction
-
- -
identityPool?: IdentityPool
-
- -
node: Node
-

The tree node.

-
-
-

Stability

stable

-
-
- -
preSignUpFunction?: LambdaFunction
-
- -
preTokenGenerationFunction?: LambdaFunction
-
- -
userpool: UserPool
-

The Cognito user pool that holds user information

-
-
-
-

Methods

-
- -
    - -
  • -

    Returns a string representation of this construct.

    -
    -

    Returns string

    -
    -

    Stability

    stable

    -
-
- -
    - -
  • -

    (deprecated) Checks if x is a construct.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

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

    - -
    -

    Deprecated

    use x instanceof Construct instead

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Methods

Constructors

Properties

customMessageFunction?: LambdaFunction
identityPool?: IdentityPool
node: Node

The tree node.

+

Stability

stable

+
preSignUpFunction?: LambdaFunction
preTokenGenerationFunction?: LambdaFunction
userpool: UserPool

The Cognito user pool that holds user information

+

Methods

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

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

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/constructs/classes/GraphQlApi.html b/docs/constructs/classes/GraphQlApi.html index 1ca6acc..158d90c 100644 --- a/docs/constructs/classes/GraphQlApi.html +++ b/docs/constructs/classes/GraphQlApi.html @@ -1,43 +1,5 @@ -GraphQlApi | cdk-serverless
-
- -
-
-
-
- -

Class GraphQlApi<RESOLVERS>

-
-

Type Parameters

-
    -
  • -

    RESOLVERS

-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
_functions +GraphQlApi | cdk-serverless

Class GraphQlApi<RESOLVERS>

Type Parameters

  • RESOLVERS

Hierarchy

-
-

Constructors

-
- -
-
-

Properties

-
- -
_functions: {
    [operationId: string]: LambdaFunction;
} = {}
-
-

Type declaration

-
-
- -
api: GraphqlApi
-
- -
apiDomainName?: string
-
- -
apiFQDN?: string
-
- -
apiHostName?: string
-
- -
-
- -
hostedZone?: IHostedZone
-
- -
node: Node
-

The tree node.

-
-
-

Stability

stable

-
-
- -
-
- -
tableDataSource?: DynamoDbDataSource
-
-

Methods

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      TYPE extends string | number | symbol

    • -
    • -

      FIELDTYPE extends {}

    -
    -

    Parameters

    -
      -
    • -
      typeName: TYPE
    • -
    • -
      fieldName: keyof FIELDTYPE
    • -
    • -
      Optional options: JsResolverOptions
      Optional
    -

    Returns void

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      TYPE extends string | number | symbol

    • -
    • -

      FIELDTYPE extends {}

    -
    -

    Parameters

    -
      -
    • -
      typeName: TYPE
    • -
    • -
      fieldName: keyof FIELDTYPE
    • -
    • -
      Optional options: Omit<VtlResolverOptions, "dataSource">
      Optional
    -

    Returns void

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      TYPE extends string | number | symbol

    • -
    • -

      FIELDTYPE extends {}

    -
    -

    Parameters

    -
      -
    • -
      typeName: TYPE
    • -
    • -
      fieldName: keyof FIELDTYPE
    • -
    • -
      dataSource: BaseDataSource
    • -
    • -
      Optional options: JsResolverOptions
      Optional
    -

    Returns void

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      TYPE extends string | number | symbol

    • -
    • -

      FIELDTYPE extends {}

    -
    -

    Parameters

    -
      -
    • -
      typeName: TYPE
    • -
    • -
      fieldName: keyof FIELDTYPE
    -

    Returns LambdaFunction

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      TYPE extends string | number | symbol

    • -
    • -

      FIELDTYPE extends {}

    -
    -

    Parameters

    -
    -

    Returns void

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      entryFile: string
    • -
    • -
      typeName: string
    • -
    • -
      fieldName: string
    -

    Returns void

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      fn: JsResolverConfig
    • -
    • -
      typeName: string
    • -
    • -
      fieldName: string
    -

    Returns void

-
- -
    - -
  • -

    getFunctionForOperation

    -
    -
    -

    Type Parameters

    -
      -
    • -

      TYPE extends string | number | symbol

    • -
    • -

      FIELDTYPE extends {}

    -
    -

    Parameters

    -
      -
    • -
      typeName: TYPE
    • -
    • -
      fieldName: keyof FIELDTYPE
    -

    Returns LambdaFunction

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      TYPE extends string | number | symbol

    • -
    • -

      FIELDTYPE extends {}

    -
    -

    Parameters

    -
      -
    • -
      grantee: IGrantable
    • -
    • -
      typeName: TYPE
    • -
    • -
      Rest ...fieldNames: (keyof FIELDTYPE)[]
      Rest
    -

    Returns void

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      TYPE extends string | number | symbol

    • -
    • -

      FIELDTYPE extends {}

    -
    -

    Parameters

    -
      -
    • -
      typeName: TYPE
    • -
    • -
      Rest ...fieldNames: (keyof FIELDTYPE)[]
      Rest
    -

    Returns void

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      TYPE extends string | number | symbol

    • -
    • -

      FIELDTYPE extends {}

    -
    -

    Parameters

    -
      -
    • -
      typeName: TYPE
    • -
    • -
      Rest ...fieldNames: (keyof FIELDTYPE)[]
      Rest
    -

    Returns void

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      data: string
    • -
    • -
      vars: {
          [name: string]: string;
      } = {}
      -
        -
      • -
        [name: string]: string
    -

    Returns string

-
- -
    - -
  • -

    Returns a string representation of this construct.

    -
    -

    Returns string

    -
    -

    Stability

    stable

    -
-
- -
    - -
  • -

    (deprecated) Checks if x is a construct.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

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

    - -
    -

    Deprecated

    use x instanceof Construct instead

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +isConstruct +

Constructors

Properties

_functions: {
    [operationId: string]: LambdaFunction;
} = {}

Type declaration

api: GraphqlApi
apiDomainName?: string
apiFQDN?: string
apiHostName?: string
hostedZone?: IHostedZone
node: Node

The tree node.

+

Stability

stable

+
tableDataSource?: DynamoDbDataSource

Methods

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    Returns void

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • fieldName: keyof FIELDTYPE
    • Optional options: Omit<VtlResolverOptions, "dataSource">

    Returns void

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • fieldName: keyof FIELDTYPE
    • dataSource: BaseDataSource
    • Optional options: JsResolverOptions

    Returns void

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • fieldName: keyof FIELDTYPE

    Returns LambdaFunction

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    Returns void

  • Parameters

    • entryFile: string
    • typeName: string
    • fieldName: string

    Returns void

  • Parameters

    • fn: JsResolverConfig
    • typeName: string
    • fieldName: string

    Returns void

  • getFunctionForOperation

    +

    Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • fieldName: keyof FIELDTYPE

    Returns LambdaFunction

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • grantee: IGrantable
    • typeName: TYPE
    • Rest ...fieldNames: (keyof FIELDTYPE)[]

    Returns void

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • Rest ...fieldNames: (keyof FIELDTYPE)[]

    Returns void

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • Rest ...fieldNames: (keyof FIELDTYPE)[]

    Returns void

  • Parameters

    • data: string
    • vars: {
          [name: string]: string;
      } = {}
      • [name: string]: string

    Returns string

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

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

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/constructs/classes/LambdaFunction.html b/docs/constructs/classes/LambdaFunction.html index e60ee1b..6f791e6 100644 --- a/docs/constructs/classes/LambdaFunction.html +++ b/docs/constructs/classes/LambdaFunction.html @@ -1,38 +1,5 @@ -LambdaFunction | cdk-serverless
-
- -
-
-
-
- -

Class LambdaFunction

-
-

Hierarchy

-
    -
  • NodejsFunction -
      -
    • LambdaFunction
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
architecture +LambdaFunction | cdk-serverless

Class LambdaFunction

Hierarchy

  • NodejsFunction
    • LambdaFunction
-
-

Constructors

-
- -
-
-

Properties

-
- -
architecture: Architecture
-

The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

-
-
-
- -
canCreatePermissions: true = true
-
- -
deadLetterQueue?: IQueue
-

The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).

-
-
-
- -
deadLetterTopic?: ITopic
-

The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).

-
-
-
- -
env: ResourceEnvironment
-
- -
functionArn: string
-

ARN of this function

-
-
-
- -
functionName: string
-

Name of this function

-
-
-
- -
grantPrincipal: IPrincipal
-

The principal this Lambda Function is running as

-
-
-
- -
node: Node
-

The tree node.

-
-
-

Stability

stable

-
-
- -
permissionsNode: Node
-
- -
physicalName: string
-

Returns a string-encoded token that resolves to the physical name that +

Constructors

Properties

architecture: Architecture

The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

+
canCreatePermissions: true = true
deadLetterQueue?: IQueue

The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).

+
deadLetterTopic?: ITopic

The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).

+
env: ResourceEnvironment
functionArn: string

ARN of this function

+
functionName: string

Name of this function

+
grantPrincipal: IPrincipal

The principal this Lambda Function is running as

+
node: Node

The tree node.

+

Stability

stable

+
permissionsNode: Node
physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

    @@ -202,949 +84,125 @@
-
-
-
- -
-
- -
role?: IRole
-

Execution role associated with this function

-
-
-
- -
runtime: Runtime
-

The runtime configured for this lambda.

-
-
-
- -
stack: Stack
-
- -
timeout?: Duration
-

The timeout configured for this lambda.

-
-
-
-

Accessors

-
- -
    -
  • get connections(): Connections
  • -
  • -

    Access the Connections object

    +
role?: IRole

Execution role associated with this function

+
runtime: Runtime

The runtime configured for this lambda.

+
stack: Stack
timeout?: Duration

The timeout configured for this lambda.

+

Accessors

  • get connections(): Connections
  • Access the Connections object

    Will fail if not a VPC-enabled Lambda Function

    -
    -

    Returns Connections

    -
-
- -
    -
  • get currentVersion(): Version
  • -
  • -

    Returns a lambda.Version which represents the current version of this +

    Returns Connections

  • get currentVersion(): Version
  • Returns a lambda.Version which represents the current version of this Lambda function. A new version will be created every time the function's configuration changes.

    You can specify options for this version using the currentVersionOptions prop when initializing the lambda.Function.

    -
    -

    Returns Version

    -
-
- -
    -
  • get isBoundToVpc(): boolean
  • -
  • -

    Whether or not this Lambda function was bound to a VPC

    +

    Returns Version

  • get isBoundToVpc(): boolean
  • Whether or not this Lambda function was bound to a VPC

    If this is is false, trying to access the connections object will fail.

    -
    -

    Returns boolean

    -
-
- -
    -
  • get latestVersion(): IVersion
  • -
  • -

    Returns IVersion

-
- -
    -
  • get logGroup(): ILogGroup
  • -
  • -

    The LogGroup where the Lambda function's logs are made available.

    +

    Returns boolean

  • get latestVersion(): IVersion
  • Returns IVersion

  • get logGroup(): ILogGroup
  • The LogGroup where the Lambda function's logs are made available.

    If either logRetention is set or this property is called, a CloudFormation custom resource is added to the stack that pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention period (never expire, by default).

    Further, if the log group already exists and the logRetention is not set, the custom resource will reset the log retention to never expire even if it was configured with a different value.

    -
    -

    Returns ILogGroup

    -
-
- -
    -
  • get resourceArnsForGrantInvoke(): string[]
  • -
  • -

    Returns string[]

-
-

Methods

-
- -
    - -
  • -

    Defines an alias for this function.

    +

    Returns ILogGroup

  • get resourceArnsForGrantInvoke(): string[]
  • Returns string[]

Methods

  • Defines an alias for this function.

    The alias will automatically be updated to point to the latest version of the function as it is being updated during a deployment.

    declare const fn: lambda.Function;

    fn.addAlias('Live');

    // Is equivalent to

    new lambda.Alias(this, 'AliasLive', {
    aliasName: 'Live',
    version: fn.currentVersion,
    });
    -
    -
    -

    Parameters

    -
      -
    • -
      aliasName: string
      -

      The name of the alias

      -
    • -
    • -
      Optional options: AliasOptions
      -

      Alias options

      -
      Optional
    -

    Returns Alias

    -
-
- -
    - -
  • -

    Adds an environment variable to this Lambda function. +

    Parameters

    • aliasName: string

      The name of the alias

      +
    • Optional options: AliasOptions

      Alias options

      +

    Returns Alias

  • Adds an environment variable to this Lambda function. If this is a ref to a Lambda function, this operation results in a no-op.

    -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The environment variable key.

      -
    • -
    • -
      value: string
      -

      The environment variable's value.

      -
    • -
    • -
      Optional options: EnvironmentOptions
      -

      Environment variable options.

      -
      Optional
    -

    Returns LambdaFunction

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      source: IEventSource
    -

    Returns void

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      id: string
    • -
    • -
      options: EventSourceMappingOptions
    -

    Returns EventSourceMapping

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional options: FunctionUrlOptions
      Optional
    -

    Returns FunctionUrl

-
- -
    - -
  • -

    Adds one or more Lambda Layers to this Lambda function.

    -
    -
    -

    Parameters

    -
      -
    • -
      Rest ...layers: ILayerVersion[]
      -

      the layers to be added.

      -
      Rest
    -

    Returns void

    -
    -

    Throws

    if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.

    -
-
- -
    - -
  • -

    Adds a permission to the Lambda resource policy.

    -
    -
    -

    Parameters

    -
      -
    • -
      id: string
      -

      The id for the permission construct

      -
    • -
    • -
      permission: Permission
      -

      The permission to grant to this Lambda function.

      -
    -

    Returns void

    -
    -

    See

    Permission for details.

    -
-
- -
    - -
  • -

    Adds a statement to the IAM role assumed by the instance.

    -
    -
    -

    Parameters

    -
      -
    • -
      statement: PolicyStatement
    -

    Returns void

    -
-
- -
    - -
  • -

    Apply the given removal policy to this resource

    +

    Parameters

    • key: string

      The environment variable key.

      +
    • value: string

      The environment variable's value.

      +
    • Optional options: EnvironmentOptions

      Environment variable options.

      +

    Returns LambdaFunction

  • Parameters

    • source: IEventSource

    Returns void

  • Parameters

    • id: string
    • options: EventSourceMappingOptions

    Returns EventSourceMapping

  • Parameters

    • Optional options: FunctionUrlOptions

    Returns FunctionUrl

  • Adds one or more Lambda Layers to this Lambda function.

    +

    Parameters

    • Rest ...layers: ILayerVersion[]

      the layers to be added.

      +

    Returns void

    Throws

    if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.

    +
  • Adds a permission to the Lambda resource policy.

    +

    Parameters

    • id: string

      The id for the permission construct

      +
    • permission: Permission

      The permission to grant to this Lambda function.

      +

    Returns void

    See

    Permission for details.

    +
  • Adds a statement to the IAM role assumed by the instance.

    +

    Parameters

    • statement: PolicyStatement

    Returns void

  • Apply the given removal policy to this resource

    The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

    The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

    -
    -
    -

    Parameters

    -
      -
    • -
      policy: RemovalPolicy
    -

    Returns void

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      options: EventInvokeConfigOptions
    -

    Returns void

-
- -
    - -
  • -

    A warning will be added to functions under the following conditions:

    +

    Parameters

    • policy: RemovalPolicy

    Returns void

  • Parameters

    • options: EventInvokeConfigOptions

    Returns void

  • A warning will be added to functions under the following conditions:

    • permissions that include lambda:InvokeFunction are added to the unqualified function.
    • function.currentVersion is invoked before or after the permission is created.

    This applies only to permissions on Lambda functions, not versions or aliases. This function is overridden as a noOp for QualifiedFunctionBase.

    -
    -
    -

    Parameters

    -
      -
    • -
      scope: Construct
    • -
    • -
      action: string
    -

    Returns void

    -
-
- -
    - -
  • -

    Returns string

-
- -
    - -
  • -

    Returns an environment-sensitive token that should be used for the +

    Parameters

    • scope: Construct
    • action: string

    Returns void

  • Returns string

  • Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

    Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

    -
    -
    -

    Parameters

    -
      -
    • -
      arnAttr: string
      -

      The CFN attribute which resolves to the ARN of the resource. +

      Parameters

      • arnAttr: string

        The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

        -
      • -
      • -
        arnComponents: ArnComponents
        -

        The format of the ARN of this resource. You must +

      • arnComponents: ArnComponents

        The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

        -
      -

      Returns string

      -
-
- -
    - -
  • -

    Returns an environment-sensitive token that should be used for the +

Returns string

  • Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

    Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

    -
    -
    -

    Parameters

    -
      -
    • -
      nameAttr: string
      -

      The CFN attribute which resolves to the resource's name. +

      Parameters

      • nameAttr: string

        The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

        -
      -

      Returns string

      -
-
- -
-
- -
    - -
  • -

    Grant the given identity permissions to invoke this Lambda

    -
    -
    -

    Parameters

    -
      -
    • -
      grantee: IGrantable
    -

    Returns Grant

    -
-
- -
    - -
  • -

    Grant the given identity permissions to invoke this Lambda Function URL

    -
    -
    -

    Parameters

    -
      -
    • -
      grantee: IGrantable
    -

    Returns Grant

    -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Return the given named metric for this Function

    -
    -
    -

    Parameters

    -
      -
    • -
      metricName: string
    • -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
-
- -
    - -
  • -

    How long execution of this Lambda takes

    +

Returns string

  • Grant the given identity permissions to invoke this Lambda

    +

    Parameters

    • grantee: IGrantable

    Returns Grant

  • Grant the given identity permissions to invoke this Lambda Function URL

    +

    Parameters

    • grantee: IGrantable

    Returns Grant

  • Return the given named metric for this Function

    +

    Parameters

    • metricName: string
    • Optional props: MetricOptions

    Returns Metric

  • How long execution of this Lambda takes

    Average over 5 minutes

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
-
- -
    - -
  • -

    How many invocations of this Lambda fail

    +

    Parameters

    • Optional props: MetricOptions

    Returns Metric

  • How many invocations of this Lambda fail

    Sum over 5 minutes

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
-
- -
    - -
  • -

    How often this Lambda is invoked

    +

    Parameters

    • Optional props: MetricOptions

    Returns Metric

  • How often this Lambda is invoked

    Sum over 5 minutes

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
-
- -
    - -
  • -

    How often this Lambda is throttled

    +

    Parameters

    • Optional props: MetricOptions

    Returns Metric

  • How often this Lambda is throttled

    Sum over 5 minutes

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      table: ITable
    • -
    • -
      Optional tableWrites: boolean
      Optional
    -

    Returns LambdaFunction

-
- -
-
- -
-
- -
    - -
  • -

    Returns a string representation of this construct.

    -
    -

    Returns string

    -
    -

    Stability

    stable

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      scope: Construct
    -

    Returns void

-
- -
    - -
  • -

    Record whether specific properties in the AWS::Lambda::Function resource should +

    Parameters

    • Optional props: MetricOptions

    Returns Metric

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

    +
  • Parameters

    • scope: Construct

    Returns void

  • Record whether specific properties in the AWS::Lambda::Function resource should also be associated to the Version resource. See 'currentVersion' section in the module README for more details.

    -
    -
    -

    Parameters

    -
      -
    • -
      propertyName: string
      -

      The property to classify

      -
    • -
    • -
      locked: boolean
      -

      whether the property should be associated to the version or not.

      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Import a lambda function into the CDK using its ARN

    -
    -
    -

    Parameters

    -
      -
    • -
      scope: Construct
    • -
    • -
      id: string
    • -
    • -
      functionArn: string
    -

    Returns IFunction

    -
-
- -
    - -
  • -

    Creates a Lambda function object which represents a function not defined +

    Parameters

    • propertyName: string

      The property to classify

      +
    • locked: boolean

      whether the property should be associated to the version or not.

      +

    Returns void

  • Import a lambda function into the CDK using its ARN

    +

    Parameters

    • scope: Construct
    • id: string
    • functionArn: string

    Returns IFunction

  • Creates a Lambda function object which represents a function not defined within this stack.

    -
    -
    -

    Parameters

    -
      -
    • -
      scope: Construct
      -

      The parent construct

      -
    • -
    • -
      id: string
      -

      The name of the lambda construct

      -
    • -
    • -
      attrs: FunctionAttributes
      -

      the attributes of the function to import

      -
    -

    Returns IFunction

    -
-
- -
    - -
  • -

    Import a lambda function into the CDK using its name

    -
    -
    -

    Parameters

    -
      -
    • -
      scope: Construct
    • -
    • -
      id: string
    • -
    • -
      functionName: string
    -

    Returns IFunction

    -
-
- -
    - -
  • -

    (deprecated) Checks if x is a construct.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

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

    - -
    -

    Deprecated

    use x instanceof Construct instead

    -
-
- -
    - -
  • -

    Returns true if the construct was created by CDK, and false otherwise

    -
    -
    -

    Parameters

    -
      -
    • -
      construct: IConstruct
    -

    Returns boolean

    -
-
- -
    - -
  • -

    Check whether the given construct is a Resource

    -
    -
    -

    Parameters

    -
      -
    • -
      construct: IConstruct
    -

    Returns construct is Resource

    -
-
- -
    - -
  • -

    Return the given named metric for this Lambda

    -
    -
    -

    Parameters

    -
      -
    • -
      metricName: string
    • -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
-
- -
    - -
  • -

    Metric for the number of concurrent executions across all Lambdas

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
    -

    Default

    max over 5 minutes
    +

    Parameters

    • scope: Construct

      The parent construct

      +
    • id: string

      The name of the lambda construct

      +
    • attrs: FunctionAttributes

      the attributes of the function to import

      +

    Returns IFunction

  • Import a lambda function into the CDK using its name

    +

    Parameters

    • scope: Construct
    • id: string
    • functionName: string

    Returns IFunction

  • (deprecated) Checks if x is a construct.

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +
  • Returns true if the construct was created by CDK, and false otherwise

    +

    Parameters

    • construct: IConstruct

    Returns boolean

  • Check whether the given construct is a Resource

    +

    Parameters

    • construct: IConstruct

    Returns construct is Resource

  • Return the given named metric for this Lambda

    +

    Parameters

    • metricName: string
    • Optional props: MetricOptions

    Returns Metric

  • Metric for the number of concurrent executions across all Lambdas

    +

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    max over 5 minutes
     
    -
-
- -
    - -
  • -

    Metric for the Duration executing all Lambdas

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
    -

    Default

    average over 5 minutes
    +
  • Metric for the Duration executing all Lambdas

    +

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    average over 5 minutes
     
    -
-
- -
    - -
  • -

    Metric for the number of Errors executing all Lambdas

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
    -

    Default

    sum over 5 minutes
    +
  • Metric for the number of Errors executing all Lambdas

    +

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    sum over 5 minutes
     
    -
-
- -
    - -
  • -

    Metric for the number of invocations of all Lambdas

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
    -

    Default

    sum over 5 minutes
    +
  • Metric for the number of invocations of all Lambdas

    +

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    sum over 5 minutes
     
    -
-
- -
    - -
  • -

    Metric for the number of throttled invocations of all Lambdas

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
    -

    Default

    sum over 5 minutes
    +
  • Metric for the number of throttled invocations of all Lambdas

    +

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    sum over 5 minutes
     
    -
-
- -
    - -
  • -

    Metric for the number of unreserved concurrent executions across all Lambdas

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional props: MetricOptions
      Optional
    -

    Returns Metric

    -
    -

    Default

    max over 5 minutes
    +
  • Metric for the number of unreserved concurrent executions across all Lambdas

    +

    Parameters

    • Optional props: MetricOptions

    Returns Metric

    Default

    max over 5 minutes
     
    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/constructs/classes/RestApi.html b/docs/constructs/classes/RestApi.html index 82ff5de..b68fe29 100644 --- a/docs/constructs/classes/RestApi.html +++ b/docs/constructs/classes/RestApi.html @@ -1,45 +1,5 @@ -RestApi | cdk-serverless
-
- -
-
-
-
- -

Class RestApi<PATHS, OPS>

-
-

Type Parameters

-
    -
  • -

    PATHS

  • -
  • -

    OPS

-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
_functions +RestApi | cdk-serverless

Class RestApi<PATHS, OPS>

Type Parameters

  • PATHS

  • OPS

Hierarchy

-
-

Constructors

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      PATHS

    • -
    • -

      OPS

    -
    -

    Parameters

    -
      -
    • -
      scope: Construct
    • -
    • -
      id: string
    • -
    • -
      props: RestApiProps<OPS>
    -

    Returns RestApi<PATHS, OPS>

-
-

Properties

-
- -
_functions: {
    [operationId: string]: LambdaFunction;
} = {}
-
-

Type declaration

-
-
- -
api: SpecRestApi
-
- -
apiDomainName?: string
-
- -
apiFQDN?: string
-
- -
apiHostName?: string
-
- -
apiSpec: OpenAPI3
-
- -
hostedZone?: IHostedZone
-
- -
node: Node
-

The tree node.

-
-
-

Stability

stable

-
-
- -
props: RestApiProps<OPS>
-
-

Methods

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      operation: OperationObject
    • -
    • -
      method: string
    • -
    • -
      description: string
    • -
    • -
      additionalLambdaOptions: LambdaOptions = {}
    -

    Returns undefined | LambdaFunction

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      P extends string | number | symbol

    -
    -

    Parameters

    -
      -
    • -
      path: P
    • -
    • -
      method: keyof PATHS[P]
    -

    Returns undefined | LambdaFunction

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      spec: {
          [key: string]: any;
      }
      -
        -
      • -
        [key: string]: any
    -

    Returns {
        [key: string]: any;
    }

    -
      -
    • -
      [key: string]: any
-
- -
    - -
  • -

    return the generated Lambda function for the specified API operation

    -
    -
    -

    Parameters

    -
      -
    • -
      operationId: keyof OPS
    -

    Returns LambdaFunction

    -
-
- -
-
- -
    - -
  • -

    Visitor method to modify the given functions

    -
    -
    -

    Parameters

    -
      -
    • -
      operationIds: (keyof OPS)[]
      -

      the list of functions to visit

      -
    • -
    • -
      op: ((fn) => void)
      -

      the function to call for every function

      -
      -
        -
      • -
    -

    Returns void

    -
-
- -
    - -
  • -

    AWS does not properly apply the 'security' option to every single path-method. +isConstruct +

Constructors

Properties

_functions: {
    [operationId: string]: LambdaFunction;
} = {}

Type declaration

api: SpecRestApi
apiDomainName?: string
apiFQDN?: string
apiHostName?: string
apiSpec: OpenAPI3
hostedZone?: IHostedZone
node: Node

The tree node.

+

Stability

stable

+
props: RestApiProps<OPS>

Methods

  • Parameters

    • operation: OperationObject
    • method: string
    • description: string
    • additionalLambdaOptions: LambdaOptions = {}

    Returns undefined | LambdaFunction

  • Type Parameters

    • P extends string | number | symbol

    Parameters

    • path: P
    • method: keyof PATHS[P]

    Returns undefined | LambdaFunction

  • Parameters

    • spec: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns {
        [key: string]: any;
    }

    • [key: string]: any
  • return the generated Lambda function for the specified API operation

    +

    Parameters

    • operationId: keyof OPS

    Returns LambdaFunction

  • Visitor method to modify the given functions

    +

    Parameters

    • operationIds: (keyof OPS)[]

      the list of functions to visit

      +
    • op: ((fn) => void)

      the function to call for every function

      +

    Returns void

  • AWS does not properly apply the 'security' option to every single path-method. According to documentation, global security gets applied, if there is no security set for the particular path-method. If there is any, even empty, it will get precedence. THIS DOES NOT HAPPEN ON AWS. IT JUST ALWAYS USES THE GLOBAL SETTING!

    'security applies [...] schemes globally to all API operations, unless overridden on the operation level'

    -
    -
    -

    Parameters

    -
      -
    • -
      spec: OpenAPI3
    -

    Returns void

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      method: string
    -

    Returns boolean

-
- -
    - -
  • -

    Returns a string representation of this construct.

    -
    -

    Returns string

    -
    -

    Stability

    stable

    -
-
- -
    - -
  • -

    (deprecated) Checks if x is a construct.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

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

    - -
    -

    Deprecated

    use x instanceof Construct instead

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

  • spec: OpenAPI3

Returns void

  • Parameters

    • method: string

    Returns boolean

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

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

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/constructs/classes/SingleTableDatastore.html b/docs/constructs/classes/SingleTableDatastore.html index ebe3d8a..4574dc6 100644 --- a/docs/constructs/classes/SingleTableDatastore.html +++ b/docs/constructs/classes/SingleTableDatastore.html @@ -1,161 +1,14 @@ -SingleTableDatastore | cdk-serverless
-
- -
-
-
-
- -

Class SingleTableDatastore

-
-

Hierarchy

-
    -
  • Construct -
      -
    • SingleTableDatastore
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
node +SingleTableDatastore | cdk-serverless

Class SingleTableDatastore

Hierarchy

  • Construct
    • SingleTableDatastore

Constructors

Properties

-
-

Methods

-
-
-

Constructors

-
- -
-
-

Properties

-
- -
node: Node
-

The tree node.

-
-
-

Stability

stable

-
-
- -
table: Table
-
-

Methods

-
- -
    - -
  • -

    Returns a string representation of this construct.

    -
    -

    Returns string

    -
    -

    Stability

    stable

    -
-
- -
    - -
  • -

    (deprecated) Checks if x is a construct.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

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

    - -
    -

    Deprecated

    use x instanceof Construct instead

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Methods

Constructors

Properties

node: Node

The tree node.

+

Stability

stable

+
table: Table

Methods

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

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

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/constructs/classes/Workflow.html b/docs/constructs/classes/Workflow.html index 94b09fb..6bd5947 100644 --- a/docs/constructs/classes/Workflow.html +++ b/docs/constructs/classes/Workflow.html @@ -1,176 +1,16 @@ -Workflow | cdk-serverless
-
- -
-
-
-
- -

Class Workflow

-
-

Hierarchy

-
    -
  • Construct -
      -
    • Workflow
-
-

Implements

-
    -
  • IGrantable
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
grantPrincipal +Workflow | cdk-serverless

Hierarchy

  • Construct
    • Workflow

Implements

  • IGrantable

Constructors

Properties

-
-

Methods

-
-
-

Constructors

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Workflow

-
-

Properties

-
- -
grantPrincipal: IPrincipal
-
- -
node: Node
-

The tree node.

-
-
-

Stability

stable

-
-
- -
role: IRole
-
- -
workflowArn: string
-
-

Methods

-
- -
    - -
  • -

    Returns a string representation of this construct.

    -
    -

    Returns string

    -
    -

    Stability

    stable

    -
-
- -
    - -
  • -

    (deprecated) Checks if x is a construct.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

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

    - -
    -

    Deprecated

    use x instanceof Construct instead

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Methods

Constructors

  • Parameters

    Returns Workflow

Properties

grantPrincipal: IPrincipal
node: Node

The tree node.

+

Stability

stable

+
role: IRole
workflowArn: string

Methods

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

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

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/constructs/index.html b/docs/constructs/index.html index 42b8f5b..6f037a1 100644 --- a/docs/constructs/index.html +++ b/docs/constructs/index.html @@ -1,18 +1,4 @@ -cdk-serverless
-
- -
-
-
-
-

cdk-serverless

-

CDK Serverless

npm version

+cdk-serverless

cdk-serverless

CDK Serverless

npm version

CDK Serverless is a tool suite to facilitate the use of the AWS Cloud Development Kit (CDK) in serverless architectures. It provides project management features to configure your TypeScript CDK app and also higher-level (L3) constructs for different APIs and resources needed for serverless applications. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.

Features

  • Projen helper classes to configure certain use cases easily
  • @@ -56,71 +42,4 @@

    cdk-serverless

  • Just file a PR with your recommended changes
  • Authors

    Brought to you by Taimos

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/AssetCdnProps.html b/docs/constructs/interfaces/AssetCdnProps.html index c0fda63..e13b52e 100644 --- a/docs/constructs/interfaces/AssetCdnProps.html +++ b/docs/constructs/interfaces/AssetCdnProps.html @@ -1,95 +1,5 @@ -AssetCdnProps | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface AssetCdnProps

    -
    -

    Hierarchy

    -
      -
    • AssetCdnProps
    -
    -
    -
    - -
    -
    -

    Properties

    -
    domainName +AssetCdnProps | cdk-serverless

    Interface AssetCdnProps

    interface AssetCdnProps {
        domainName: string;
        hostName: string;
    }

    Properties

    -
    -

    Properties

    -
    - -
    domainName: string
    -

    Domain name of the asset content delivery network (e.g. example.com)

    -
    -
    -
    - -
    hostName: string
    -

    Hostname of the asset content delivery network (e.g. cdn)

    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    domainName: string

    Domain name of the asset content delivery network (e.g. example.com)

    +
    hostName: string

    Hostname of the asset content delivery network (e.g. cdn)

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/BaseApiProps.html b/docs/constructs/interfaces/BaseApiProps.html index 9875b33..d6c46c5 100644 --- a/docs/constructs/interfaces/BaseApiProps.html +++ b/docs/constructs/interfaces/BaseApiProps.html @@ -1,35 +1,4 @@ -BaseApiProps | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface BaseApiProps

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    additionalEnv? +BaseApiProps | cdk-serverless

    Interface BaseApiProps

    interface BaseApiProps {
        additionalEnv?: {
            [key: string]: string;
        };
        apiHostname?: string;
        apiName: string;
        assetCdn?: AssetCdn;
        authentication?: IJwtAuthentication | ICognitoAuthentication;
        domainName?: string;
        hostedZone?: IHostedZone;
        lambdaOptions?: LambdaOptions;
        lambdaTracing?: LambdaTracingOptions;
        monitoring?: boolean;
        singleTableDatastore?: SingleTableDatastore;
        stageName: string;
    }

    Hierarchy

    -
    -

    Properties

    -
    - -
    additionalEnv?: {
        [key: string]: string;
    }
    -

    Additional environment variables of all Lambda functions

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -
    - -
    apiHostname?: string
    -

    Hostname of the API if a domain name is specified

    -
    -
    -

    Default

    api
    +

    Properties

    additionalEnv?: {
        [key: string]: string;
    }

    Additional environment variables of all Lambda functions

    +

    Type declaration

    • [key: string]: string
    apiHostname?: string

    Hostname of the API if a domain name is specified

    +

    Default

    api
     
    -
    -
    - -
    apiName: string
    -

    Name of the API

    -
    -
    -
    - -
    assetCdn?: AssetCdn
    -

    Configure a content delivery network for static assets

    -
    -
    -

    Default

    none
    +
    apiName: string

    Name of the API

    +
    assetCdn?: AssetCdn

    Configure a content delivery network for static assets

    +

    Default

    none
     
    -
    -
    - - -

    Use a Cognito user pool for authorization. +

    Use a Cognito user pool for authorization. Alternatively supply a JWT issuer and audience to use any other JWT-based authorization service.

    -
    -
    -

    Default

    none
    +

    Default

    none
     
    -
    -
    - -
    domainName?: string
    -

    Domain name of the API (e.g. example.com)

    +
    domainName?: string

    Domain name of the API (e.g. example.com)

    only one of hostedZone and domainName can be specified

    -
    -
    -

    Default

    - No custom domain is configured
    +

    Default

    - No custom domain is configured
     
    -
    -
    - -
    hostedZone?: IHostedZone
    -

    Hosted Zone of the API (e.g. example.com)

    +
    hostedZone?: IHostedZone

    Hosted Zone of the API (e.g. example.com)

    only one of hostedZone and domainName can be specified

    -
    -
    -

    Default

    - No custom domain is configured
    +

    Default

    - No custom domain is configured
     
    -
    -
    - -
    lambdaOptions?: LambdaOptions
    -

    additional options for the underlying Lambda function construct

    -
    -
    -
    - -
    lambdaTracing?: LambdaTracingOptions
    -

    Tracing config for the generated Lambda functions

    -
    -
    -
    - -
    monitoring?: boolean
    -

    Configure CloudWatch Dashboard for the API and the Lambda functions

    -
    -
    -

    Default

    true
    +
    lambdaOptions?: LambdaOptions

    additional options for the underlying Lambda function construct

    +
    lambdaTracing?: LambdaTracingOptions

    Tracing config for the generated Lambda functions

    +
    monitoring?: boolean

    Configure CloudWatch Dashboard for the API and the Lambda functions

    +

    Default

    true
     
    -
    -
    - -
    singleTableDatastore?: SingleTableDatastore
    -
    -

    Default

    none
    +
    singleTableDatastore?: SingleTableDatastore

    Default

    none
     
    -
    -
    - -
    stageName: string
    -

    Deployment stage (e.g. dev)

    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +
    stageName: string

    Deployment stage (e.g. dev)

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/CognitoAuthenticationProps.html b/docs/constructs/interfaces/CognitoAuthenticationProps.html index e389e66..4e45a42 100644 --- a/docs/constructs/interfaces/CognitoAuthenticationProps.html +++ b/docs/constructs/interfaces/CognitoAuthenticationProps.html @@ -1,190 +1,31 @@ -CognitoAuthenticationProps | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface CognitoAuthenticationProps

    -
    -

    Hierarchy

    -
      -
    • CognitoAuthenticationProps
    -
    -
    -
    - -
    -
    -

    Properties

    -
    groups? +CognitoAuthenticationProps | cdk-serverless

    Interface CognitoAuthenticationProps

    interface CognitoAuthenticationProps {
        groups?: {
            [name: string]: string;
        };
        identityPool?: {
            poolConfig?: IdentityPoolProps;
        };
        sesEmailSender?: {
            email: string;
            name: string;
            region: string;
        };
        triggers?: {
            customMessages?: boolean;
            preSignUp?: boolean;
            preTokenGeneration?: boolean;
        };
        userPoolName: string;
        userPoolProps?: UserPoolProps;
    }
    -
    -

    Properties

    -
    - -
    groups?: {
        [name: string]: string;
    }
    -

    Groups to create in Cognito user pool +

    Properties

    groups?: {
        [name: string]: string;
    }

    Groups to create in Cognito user pool Key: group name Value: group description

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string
    -
    -
    - -
    identityPool?: {
        poolConfig?: IdentityPoolProps;
    }
    -

    Create a new Cognito Identity Pool for the User pool

    -
    -
    -

    Type declaration

    -
      -
    • -
      Optional Readonly poolConfig?: IdentityPoolProps
      -

      configuration of the identity pool

      -
      -
    -
    -
    - -
    sesEmailSender?: {
        email: string;
        name: string;
        region: string;
    }
    -

    Configure SES mail sending

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly email: string
      -

      Sender email. Needs to be already verified in SES

      -
      -
    • -
    • -
      Readonly name: string
      -

      Sender name

      -
      -
    • -
    • -
      Readonly region: string
      -

      AWS region to use for SES

      -
      -
    -
    -
    - -
    triggers?: {
        customMessages?: boolean;
        preSignUp?: boolean;
        preTokenGeneration?: boolean;
    }
    -

    Configure Cognito Lambda triggers

    -
    -
    -

    Type declaration

    -
      -
    • -
      Optional Readonly customMessages?: boolean
      -

      Attaches a lambda function to the custom message trigger

      +

      Type declaration

      • [name: string]: string
    identityPool?: {
        poolConfig?: IdentityPoolProps;
    }

    Create a new Cognito Identity Pool for the User pool

    +

    Type declaration

    • Optional Readonly poolConfig?: IdentityPoolProps

      configuration of the identity pool

      +
    sesEmailSender?: {
        email: string;
        name: string;
        region: string;
    }

    Configure SES mail sending

    +

    Type declaration

    • Readonly email: string

      Sender email. Needs to be already verified in SES

      +
    • Readonly name: string

      Sender name

      +
    • Readonly region: string

      AWS region to use for SES

      +
    triggers?: {
        customMessages?: boolean;
        preSignUp?: boolean;
        preTokenGeneration?: boolean;
    }

    Configure Cognito Lambda triggers

    +

    Type declaration

    • Optional Readonly customMessages?: boolean

      Attaches a lambda function to the custom message trigger

      Code has to reside in './src/lambda/cognito.custom-message.ts' with a method 'handler'

      -
      -
      -

      Default

      false
      +

      Default

      false
       
      -
    • -
    • -
      Optional Readonly preSignUp?: boolean
      -

      Attaches a lambda function to the pre sign-up trigger

      +
    • Optional Readonly preSignUp?: boolean

      Attaches a lambda function to the pre sign-up trigger

      Code has to reside in './src/lambda/cognito.pre-signup.ts' with a method 'handler'

      -
      -
      -

      Default

      false
      +

      Default

      false
       
      -
    • -
    • -
      Optional Readonly preTokenGeneration?: boolean
      -

      Attaches a lambda function to the pre token generation trigger

      +
    • Optional Readonly preTokenGeneration?: boolean

      Attaches a lambda function to the pre token generation trigger

      Code has to reside in './src/lambda/cognito.pre-token-generation.ts' with a method 'handler'

      -
      -
      -

      Default

      false
      +

      Default

      false
       
      -
    -
    -
    - -
    userPoolName: string
    -

    Name for the Cognito user pool

    -
    -
    -
    - -
    userPoolProps?: UserPoolProps
    -

    Properties of the Cognito user pool

    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +
    userPoolName: string

    Name for the Cognito user pool

    +
    userPoolProps?: UserPoolProps

    Properties of the Cognito user pool

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/GraphQlApiProps.html b/docs/constructs/interfaces/GraphQlApiProps.html index 418938d..f8a807a 100644 --- a/docs/constructs/interfaces/GraphQlApiProps.html +++ b/docs/constructs/interfaces/GraphQlApiProps.html @@ -1,34 +1,4 @@ -GraphQlApiProps | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface GraphQlApiProps

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    additionalEnv? +GraphQlApiProps | cdk-serverless

    Interface GraphQlApiProps

    interface GraphQlApiProps {
        additionalEnv?: {
            [key: string]: string;
        };
        apiHostname?: string;
        apiName: string;
        assetCdn?: AssetCdn;
        authentication?: IJwtAuthentication | ICognitoAuthentication;
        definitionFileName: string;
        domainName?: string;
        hostedZone?: IHostedZone;
        lambdaOptions?: LambdaOptions;
        lambdaTracing?: LambdaTracingOptions;
        monitoring?: boolean;
        singleTableDatastore?: SingleTableDatastore;
        stageName: string;
    }

    Hierarchy

    -
    -

    Properties

    -
    - -
    additionalEnv?: {
        [key: string]: string;
    }
    -

    Additional environment variables of all Lambda functions

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -
    - -
    apiHostname?: string
    -

    Hostname of the API if a domain name is specified

    -
    -
    -

    Default

    api
    +

    Properties

    additionalEnv?: {
        [key: string]: string;
    }

    Additional environment variables of all Lambda functions

    +

    Type declaration

    • [key: string]: string
    apiHostname?: string

    Hostname of the API if a domain name is specified

    +

    Default

    api
     
    -
    -
    - -
    apiName: string
    -

    Name of the API

    -
    -
    -
    - -
    assetCdn?: AssetCdn
    -

    Configure a content delivery network for static assets

    -
    -
    -

    Default

    none
    +
    apiName: string

    Name of the API

    +
    assetCdn?: AssetCdn

    Configure a content delivery network for static assets

    +

    Default

    none
     
    -
    -
    - - -

    Use a Cognito user pool for authorization. +

    Use a Cognito user pool for authorization. Alternatively supply a JWT issuer and audience to use any other JWT-based authorization service.

    -
    -
    -

    Default

    none
    +

    Default

    none
     
    -
    -
    - -
    definitionFileName: string
    -
    - -
    domainName?: string
    -

    Domain name of the API (e.g. example.com)

    +
    definitionFileName: string
    domainName?: string

    Domain name of the API (e.g. example.com)

    only one of hostedZone and domainName can be specified

    -
    -
    -

    Default

    - No custom domain is configured
    +

    Default

    - No custom domain is configured
     
    -
    -
    - -
    hostedZone?: IHostedZone
    -

    Hosted Zone of the API (e.g. example.com)

    +
    hostedZone?: IHostedZone

    Hosted Zone of the API (e.g. example.com)

    only one of hostedZone and domainName can be specified

    -
    -
    -

    Default

    - No custom domain is configured
    +

    Default

    - No custom domain is configured
     
    -
    -
    - -
    lambdaOptions?: LambdaOptions
    -

    additional options for the underlying Lambda function construct

    -
    -
    -
    - -
    lambdaTracing?: LambdaTracingOptions
    -

    Tracing config for the generated Lambda functions

    -
    -
    -
    - -
    monitoring?: boolean
    -

    Configure CloudWatch Dashboard for the API and the Lambda functions

    -
    -
    -

    Default

    true
    +
    lambdaOptions?: LambdaOptions

    additional options for the underlying Lambda function construct

    +
    lambdaTracing?: LambdaTracingOptions

    Tracing config for the generated Lambda functions

    +
    monitoring?: boolean

    Configure CloudWatch Dashboard for the API and the Lambda functions

    +

    Default

    true
     
    -
    -
    - -
    singleTableDatastore?: SingleTableDatastore
    -
    -

    Default

    none
    +
    singleTableDatastore?: SingleTableDatastore

    Default

    none
     
    -
    -
    - -
    stageName: string
    -

    Deployment stage (e.g. dev)

    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +
    stageName: string

    Deployment stage (e.g. dev)

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/ICognitoAuthentication.html b/docs/constructs/interfaces/ICognitoAuthentication.html index 912e32b..8a2a305 100644 --- a/docs/constructs/interfaces/ICognitoAuthentication.html +++ b/docs/constructs/interfaces/ICognitoAuthentication.html @@ -1,91 +1,3 @@ -ICognitoAuthentication | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface ICognitoAuthentication

    -
    -

    Hierarchy

    -
      -
    • ICognitoAuthentication
    -
    -

    Implemented by

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    userpool: IUserPool
    -

    The Cognito user pool that holds user information

    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +ICognitoAuthentication | cdk-serverless

    Interface ICognitoAuthentication

    interface ICognitoAuthentication {
        userpool: IUserPool;
    }

    Implemented by

    Properties

    Properties

    userpool: IUserPool

    The Cognito user pool that holds user information

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/IJwtAuthentication.html b/docs/constructs/interfaces/IJwtAuthentication.html index a5c95b0..38df4d8 100644 --- a/docs/constructs/interfaces/IJwtAuthentication.html +++ b/docs/constructs/interfaces/IJwtAuthentication.html @@ -1,103 +1,7 @@ -IJwtAuthentication | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface IJwtAuthentication

    -
    -

    Hierarchy

    -
      -
    • IJwtAuthentication
    -
    -
    -
    - -
    -
    -

    Properties

    -
    audience? +IJwtAuthentication | cdk-serverless

    Interface IJwtAuthentication

    interface IJwtAuthentication {
        audience?: string[];
        issuerUrl: string;
        jwksUrl?: string;
    }
    -
    -

    Properties

    -
    - -
    audience?: string[]
    -

    The endpoint's audience. Will only be checked if present.

    -
    -
    -
    - -
    issuerUrl: string
    -

    The JWT issuer endpoint URL

    -
    -
    -
    - -
    jwksUrl?: string
    -

    The JWT endpoints JWKS store. Unless this is provided, OIDC discovery will be used to find this.

    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    audience?: string[]

    The endpoint's audience. Will only be checked if present.

    +
    issuerUrl: string

    The JWT issuer endpoint URL

    +
    jwksUrl?: string

    The JWT endpoints JWKS store. Unless this is provided, OIDC discovery will be used to find this.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/JsResolverOptions.html b/docs/constructs/interfaces/JsResolverOptions.html index e5874f4..66ebea2 100644 --- a/docs/constructs/interfaces/JsResolverOptions.html +++ b/docs/constructs/interfaces/JsResolverOptions.html @@ -1,106 +1,9 @@ -JsResolverOptions | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface JsResolverOptions

    -
    -

    Hierarchy

    -
      -
    • JsResolverOptions
    -
    -
    -
    - -
    -
    -

    Properties

    -
    pipelineStepNames? +JsResolverOptions | cdk-serverless

    Interface JsResolverOptions

    interface JsResolverOptions {
        pipelineStepNames?: string[];
        stashValues?: {
            [key: string]: string;
        };
    }
    -
    -

    Properties

    -
    - -
    pipelineStepNames?: string[]
    -

    name of the pipeline steps to create

    -
    -
    -

    Default

    - only a default step will be created
    +

    Properties

    pipelineStepNames?: string[]

    name of the pipeline steps to create

    +

    Default

    - only a default step will be created
     
    -
    -
    - -
    stashValues?: {
        [key: string]: string;
    }
    -

    Variables that will be put into the "stash" of the resolver pipeline

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -

    Default

    none
    +
    stashValues?: {
        [key: string]: string;
    }

    Variables that will be put into the "stash" of the resolver pipeline

    +

    Type declaration

    • [key: string]: string

    Default

    none
     
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/LambdaFunctionProps.html b/docs/constructs/interfaces/LambdaFunctionProps.html index a8f5581..c4f9bdd 100644 --- a/docs/constructs/interfaces/LambdaFunctionProps.html +++ b/docs/constructs/interfaces/LambdaFunctionProps.html @@ -1,32 +1,4 @@ -LambdaFunctionProps | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface LambdaFunctionProps

    -
    -

    Hierarchy

    -
      -
    • LambdaFunctionProps
    -
    -
    -
    - -
    -
    -

    Properties

    -
    additionalEnv? +LambdaFunctionProps | cdk-serverless

    Interface LambdaFunctionProps

    interface LambdaFunctionProps {
        additionalEnv?: {
            [key: string]: string;
        };
        assetBucket?: Bucket;
        assetDomainName?: string;
        description?: string;
        entry: string;
        handler?: string;
        includeSDK?: boolean;
        jwt?: IJwtAuthentication;
        lambdaOptions?: LambdaOptions;
        lambdaTracing?: LambdaTracingOptions;
        stageName?: string;
        table?: ITable;
        tableWrites?: boolean;
        userPool?: IUserPool;
    }
    -
    -

    Properties

    -
    - -
    additionalEnv?: {
        [key: string]: string;
    }
    -

    additional environment variables of the Lambda function

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -
    - -
    assetBucket?: Bucket
    -

    Bucket that is used for assets and published using the asset CDN +

    Properties

    additionalEnv?: {
        [key: string]: string;
    }

    additional environment variables of the Lambda function

    +

    Type declaration

    • [key: string]: string
    assetBucket?: Bucket

    Bucket that is used for assets and published using the asset CDN The name of the bucket is available as process.env.ASSET_BUCKET

    -
    -
    -
    - -
    assetDomainName?: string
    -

    Fully qualified domain name of the asset CDN +

    assetDomainName?: string

    Fully qualified domain name of the asset CDN It is available as process.env.ASSET_DOMAIN_NAME

    -
    -
    -
    - -
    description?: string
    -

    description of the Lambda function

    -
    -
    -
    - -
    entry: string
    -

    entry file name

    -
    -
    -
    - -
    handler?: string
    -

    name of the exported handler function

    -
    -
    -

    Default

    handler
    +
    description?: string

    description of the Lambda function

    +
    entry: string

    entry file name

    +
    handler?: string

    name of the exported handler function

    +

    Default

    handler
     
    -
    -
    - -
    includeSDK?: boolean
    -

    Should the AWS-SDK be packaged with the Lambda code or excluded

    -
    -
    -

    Default

    false (exclude SDK and use runtime provided one)
    +
    includeSDK?: boolean

    Should the AWS-SDK be packaged with the Lambda code or excluded

    +

    Default

    false (exclude SDK and use runtime provided one)
     
    -
    -
    - - -

    JwtAuthentication settings

    -
    -
    -
    - -
    lambdaOptions?: LambdaOptions
    -

    additional options for the underlying Lambda function construct

    -
    -
    -
    - -
    lambdaTracing?: LambdaTracingOptions
    -

    Tracing config

    -
    -
    -
    - -
    stageName?: string
    -

    Deployment stage (e.g. dev)

    -
    -
    -
    - -
    table?: ITable
    -

    DynamoDB that is used as datastore +

    JwtAuthentication settings

    +
    lambdaOptions?: LambdaOptions

    additional options for the underlying Lambda function construct

    +
    lambdaTracing?: LambdaTracingOptions

    Tracing config

    +
    stageName?: string

    Deployment stage (e.g. dev)

    +
    table?: ITable

    DynamoDB that is used as datastore The Lambda function will have read access to this table automatically The name of the table is available as process.env.TABLE

    -
    -
    -
    - -
    tableWrites?: boolean
    -

    Activate write permissions to the DynamoDB table

    -
    -
    -
    - -
    userPool?: IUserPool
    -

    Cognito user pool +

    tableWrites?: boolean

    Activate write permissions to the DynamoDB table

    +
    userPool?: IUserPool

    Cognito user pool The name of the pool is available as process.env.USER_POOL_ID

    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/LambdaTracingOptions.html b/docs/constructs/interfaces/LambdaTracingOptions.html index 85d9afe..2a37ad4 100644 --- a/docs/constructs/interfaces/LambdaTracingOptions.html +++ b/docs/constructs/interfaces/LambdaTracingOptions.html @@ -1,90 +1,5 @@ -LambdaTracingOptions | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface LambdaTracingOptions

    -
    -

    Hierarchy

    -
      -
    • LambdaTracingOptions
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    xRayTracing?: Tracing
    -

    Activate tracing with X-Ray

    -
    -
    -

    Default

    lambda.Tracing.DISABLED
    +LambdaTracingOptions | cdk-serverless

    Interface LambdaTracingOptions

    interface LambdaTracingOptions {
        xRayTracing?: Tracing;
    }

    Properties

    Properties

    xRayTracing?: Tracing

    Activate tracing with X-Ray

    +

    Default

    lambda.Tracing.DISABLED
     
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/RestApiProps.html b/docs/constructs/interfaces/RestApiProps.html index b4f6ff4..0a7c310 100644 --- a/docs/constructs/interfaces/RestApiProps.html +++ b/docs/constructs/interfaces/RestApiProps.html @@ -1,39 +1,4 @@ -RestApiProps | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface RestApiProps<OPS>

    -
    -

    Type Parameters

    -
      -
    • -

      OPS

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    additionalEnv? +RestApiProps | cdk-serverless

    Interface RestApiProps<OPS>

    interface RestApiProps {
        additionalEnv?: {
            [key: string]: string;
        };
        apiHostname?: string;
        apiName: string;
        assetCdn?: AssetCdn;
        authentication?: IJwtAuthentication | ICognitoAuthentication;
        autoGenerateRoutes?: boolean;
        cors: boolean;
        definitionFileName: string;
        domainName?: string;
        hostedZone?: IHostedZone;
        lambdaOptions?: LambdaOptions;
        lambdaOptionsByOperation?: {
            [operationId in string | number | symbol]?: LambdaOptions
        };
        lambdaTracing?: LambdaTracingOptions;
        monitoring?: boolean;
        restApiProps?: RestApiBaseProps;
        singleTableDatastore?: SingleTableDatastore;
        stageName: string;
    }

    Type Parameters

    • OPS

    Hierarchy

    -
    -

    Properties

    -
    - -
    additionalEnv?: {
        [key: string]: string;
    }
    -

    Additional environment variables of all Lambda functions

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    -
    - -
    apiHostname?: string
    -

    Hostname of the API if a domain name is specified

    -
    -
    -

    Default

    api
    +

    Properties

    additionalEnv?: {
        [key: string]: string;
    }

    Additional environment variables of all Lambda functions

    +

    Type declaration

    • [key: string]: string
    apiHostname?: string

    Hostname of the API if a domain name is specified

    +

    Default

    api
     
    -
    -
    - -
    apiName: string
    -

    Name of the API

    -
    -
    -
    - -
    assetCdn?: AssetCdn
    -

    Configure a content delivery network for static assets

    -
    -
    -

    Default

    none
    +
    apiName: string

    Name of the API

    +
    assetCdn?: AssetCdn

    Configure a content delivery network for static assets

    +

    Default

    none
     
    -
    -
    - - -

    Use a Cognito user pool for authorization. +

    Use a Cognito user pool for authorization. Alternatively supply a JWT issuer and audience to use any other JWT-based authorization service.

    -
    -
    -

    Default

    none
    +

    Default

    none
     
    -
    -
    - -
    autoGenerateRoutes?: boolean
    -

    Generate routes for all endpoints configured in the openapi.yaml file

    -
    -
    -

    Default

    true
    +
    autoGenerateRoutes?: boolean

    Generate routes for all endpoints configured in the openapi.yaml file

    +

    Default

    true
     
    -
    -
    - -
    cors: boolean
    -
    - -
    definitionFileName: string
    -
    - -
    domainName?: string
    -

    Domain name of the API (e.g. example.com)

    +
    cors: boolean
    definitionFileName: string
    domainName?: string

    Domain name of the API (e.g. example.com)

    only one of hostedZone and domainName can be specified

    -
    -
    -

    Default

    - No custom domain is configured
    +

    Default

    - No custom domain is configured
     
    -
    -
    - -
    hostedZone?: IHostedZone
    -

    Hosted Zone of the API (e.g. example.com)

    +
    hostedZone?: IHostedZone

    Hosted Zone of the API (e.g. example.com)

    only one of hostedZone and domainName can be specified

    -
    -
    -

    Default

    - No custom domain is configured
    +

    Default

    - No custom domain is configured
     
    -
    -
    - -
    lambdaOptions?: LambdaOptions
    -

    additional options for the underlying Lambda function construct

    -
    -
    -
    - -
    lambdaOptionsByOperation?: {
        [operationId in string | number | symbol]?: LambdaOptions
    }
    -

    additional options for the underlying Lambda function construct per operationId

    -
    -
    -

    Default

    -
    +
    lambdaOptions?: LambdaOptions

    additional options for the underlying Lambda function construct

    +
    lambdaOptionsByOperation?: {
        [operationId in string | number | symbol]?: LambdaOptions
    }

    additional options for the underlying Lambda function construct per operationId

    +

    Default

    -
     
    -
    -
    - -
    lambdaTracing?: LambdaTracingOptions
    -

    Tracing config for the generated Lambda functions

    -
    -
    -
    - -
    monitoring?: boolean
    -

    Configure CloudWatch Dashboard for the API and the Lambda functions

    -
    -
    -

    Default

    true
    +
    lambdaTracing?: LambdaTracingOptions

    Tracing config for the generated Lambda functions

    +
    monitoring?: boolean

    Configure CloudWatch Dashboard for the API and the Lambda functions

    +

    Default

    true
     
    -
    -
    - -
    restApiProps?: RestApiBaseProps
    -

    custom options for the created HttpApi

    -
    -
    -

    Default

    -
    +
    restApiProps?: RestApiBaseProps

    custom options for the created HttpApi

    +

    Default

    -
     
    -
    -
    - -
    singleTableDatastore?: SingleTableDatastore
    -
    -

    Default

    none
    +
    singleTableDatastore?: SingleTableDatastore

    Default

    none
     
    -
    -
    - -
    stageName: string
    -

    Deployment stage (e.g. dev)

    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +
    stageName: string

    Deployment stage (e.g. dev)

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/SingleTableDatastoreProps.html b/docs/constructs/interfaces/SingleTableDatastoreProps.html index bb2fff6..18914a0 100644 --- a/docs/constructs/interfaces/SingleTableDatastoreProps.html +++ b/docs/constructs/interfaces/SingleTableDatastoreProps.html @@ -1,116 +1,16 @@ -SingleTableDatastoreProps | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface SingleTableDatastoreProps

    -
    -

    Hierarchy

    -
      -
    • SingleTableDatastoreProps
    -
    -
    -
    - -
    -
    -

    Properties

    -
    design +SingleTableDatastoreProps | cdk-serverless

    Interface SingleTableDatastoreProps

    interface SingleTableDatastoreProps {
        design: SingleTableDesign;
        encryption?: TableEncryption;
        encryptionKey?: IKey;
    }
    -
    -

    Properties

    -
    - - -

    Table design

    -
    -
    -
    - -
    encryption?: TableEncryption
    -

    Whether server-side encryption with an AWS managed customer master key is enabled.

    -
    -
    -

    Default

    - server-side encryption is enabled with an AWS owned customer master key
    +

    Properties

    Table design

    +
    encryption?: TableEncryption

    Whether server-side encryption with an AWS managed customer master key is enabled.

    +

    Default

    - server-side encryption is enabled with an AWS owned customer master key
     
    -

    Stability

    stable

    -
    -
    - -
    encryptionKey?: IKey
    -

    External KMS key to use for table encryption.

    +
    encryptionKey?: IKey

    External KMS key to use for table encryption.

    This property can only be set if encryption is set to TableEncryption.CUSTOMER_MANAGED.

    -
    -
    -

    Default

      +

    Default

    • If encryption is set to TableEncryption.CUSTOMER_MANAGED and this property is undefined, a new KMS key will be created and associated with this table.
    -

    Stability

    stable

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/SingleTableDesign.html b/docs/constructs/interfaces/SingleTableDesign.html index e4ba9ba..67e7a20 100644 --- a/docs/constructs/interfaces/SingleTableDesign.html +++ b/docs/constructs/interfaces/SingleTableDesign.html @@ -1,121 +1,11 @@ -SingleTableDesign | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface SingleTableDesign

    -
    -

    Hierarchy

    -
      -
    • SingleTableDesign
    -
    -
    -
    - -
    -
    -

    Properties

    -
    globalIndexes? +SingleTableDesign | cdk-serverless

    Interface SingleTableDesign

    interface SingleTableDesign {
        globalIndexes?: GlobalSecondaryIndexProps[];
        localIndexes?: LocalSecondaryIndexProps[];
        primaryKey: {
            partitionKey: string;
            sortKey?: string;
        };
        timeToLiveAttribute?: string;
    }
    -
    -

    Properties

    -
    - -
    globalIndexes?: GlobalSecondaryIndexProps[]
    -

    global secondary indexes

    -
    -
    -
    - -
    localIndexes?: LocalSecondaryIndexProps[]
    -

    local secondary indexes

    -
    -
    -
    - -
    primaryKey: {
        partitionKey: string;
        sortKey?: string;
    }
    -

    structure of the primary key

    -
    -
    -

    Type declaration

    -
      -
    • -
      partitionKey: string
    • -
    • -
      Optional sortKey?: string
    -
    -
    - -
    timeToLiveAttribute?: string
    -

    The name of TTL attribute.

    -
    -
    -

    Default

    - TTL is disabled
    +

    Properties

    globalIndexes?: GlobalSecondaryIndexProps[]

    global secondary indexes

    +
    localIndexes?: LocalSecondaryIndexProps[]

    local secondary indexes

    +
    primaryKey: {
        partitionKey: string;
        sortKey?: string;
    }

    structure of the primary key

    +

    Type declaration

    • partitionKey: string
    • Optional sortKey?: string
    timeToLiveAttribute?: string

    The name of TTL attribute.

    +

    Default

    - TTL is disabled
     
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/VtlResolverOptions.html b/docs/constructs/interfaces/VtlResolverOptions.html index 8ae5dde..10c0a45 100644 --- a/docs/constructs/interfaces/VtlResolverOptions.html +++ b/docs/constructs/interfaces/VtlResolverOptions.html @@ -1,103 +1,7 @@ -VtlResolverOptions | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface VtlResolverOptions

    -
    -

    Hierarchy

    -
      -
    • VtlResolverOptions
    -
    -
    -
    - -
    -
    -

    Properties

    -
    dataSource +VtlResolverOptions | cdk-serverless

    Interface VtlResolverOptions

    interface VtlResolverOptions {
        dataSource: BaseDataSource;
        variables?: {
            [name: string]: string;
        };
    }
    -
    -

    Properties

    -
    - -
    dataSource: BaseDataSource
    -

    The datasource the VTL resolver targets

    -
    -
    -
    - -
    variables?: {
        [name: string]: string;
    }
    -

    string replacements to process on the VTL

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string
    -
    -

    Default

    no variable expansions
    +

    Properties

    dataSource: BaseDataSource

    The datasource the VTL resolver targets

    +
    variables?: {
        [name: string]: string;
    }

    string replacements to process on the VTL

    +

    Type declaration

    • [name: string]: string

    Default

    no variable expansions
     
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/interfaces/WorkflowProps.html b/docs/constructs/interfaces/WorkflowProps.html index a8ee21d..006c751 100644 --- a/docs/constructs/interfaces/WorkflowProps.html +++ b/docs/constructs/interfaces/WorkflowProps.html @@ -1,109 +1,6 @@ -WorkflowProps | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface WorkflowProps

    -
    -

    Hierarchy

    -
      -
    • WorkflowProps
    -
    -
    -
    - -
    -
    -

    Properties

    -
    definitionFileName +WorkflowProps | cdk-serverless

    Interface WorkflowProps

    interface WorkflowProps {
        definitionFileName: string;
        definitionSubstitutions?: {
            [key: string]: string;
        };
        loggingConfiguration?: LoggingConfigurationProperty;
        stateMachineType?: StateMachineType;
        tracingConfiguration?: TracingConfigurationProperty;
    }
    -
    -

    Properties

    -
    - -
    definitionFileName: string
    -
    - -
    definitionSubstitutions?: {
        [key: string]: string;
    }
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: string
    -
    - -
    loggingConfiguration?: LoggingConfigurationProperty
    -
    - -
    stateMachineType?: StateMachineType
    -
    - -
    tracingConfiguration?: TracingConfigurationProperty
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    definitionFileName: string
    definitionSubstitutions?: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string
    loggingConfiguration?: LoggingConfigurationProperty
    stateMachineType?: StateMachineType
    tracingConfiguration?: TracingConfigurationProperty

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/modules.html b/docs/constructs/modules.html index dc547b8..97764c4 100644 --- a/docs/constructs/modules.html +++ b/docs/constructs/modules.html @@ -1,23 +1,4 @@ -cdk-serverless
    -
    - -
    -
    -
    -
    -

    cdk-serverless

    -
    -
    -

    Index

    -
    -

    Classes

    -
    AssetCdn +cdk-serverless
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Type Aliases

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/constructs/types/LambdaOptions.html b/docs/constructs/types/LambdaOptions.html index 58a8731..9e7bbc9 100644 --- a/docs/constructs/types/LambdaOptions.html +++ b/docs/constructs/types/LambdaOptions.html @@ -1,62 +1 @@ -LambdaOptions | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Type alias LambdaOptions

    -
    LambdaOptions: Omit<lambdaNodejs.NodejsFunctionProps, "entry" | "handler" | "description">
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +LambdaOptions | cdk-serverless

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/assets/main.js b/docs/lambda/assets/main.js index 3cee05e..d0aa8d5 100644 --- a/docs/lambda/assets/main.js +++ b/docs/lambda/assets/main.js @@ -1,7 +1,8 @@ "use strict"; -"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((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(),this.listenForCodeCopies(),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&&(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)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(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+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(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 _e(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 Re(t,e,r,n){if(_e(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 Fe(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 M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!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&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="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(M,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}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="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(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,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){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){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 te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{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()),ve.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 Z=class extends C{constructor(n){super(n);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 r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/lambda/assets/navigation.js b/docs/lambda/assets/navigation.js new file mode 100644 index 0000000..6a05dc4 --- /dev/null +++ b/docs/lambda/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WUwVLCMBCG36VnRqUDqNwKI6IHdHAcDw6H2ASbsSQxTcXq+O6mUErTpGmqx6b/fv9udjfP355An8Ibe4Bhr+cxICL5saEwjVFyKg9PIrGJ5Z83TKA3HvS8MMIx5Ih44+cyOGDsISPhHBAYIz6lZHde4rD85msQFkSjWvXxh6OfXomfC8Ec2bq0DbxECaMkQS7kmtaGvmOIA4EpaQSWCifMExbREr2nKBETCrN2ai3AZhLc31wDgbYg++gXl3fki4wd+qbLatSzy/P+0K+SlVYboYqijVdprwlW+d1GCjmStTTlt05JmF/iHmvSqvzRQEMbUzVxG5M2QGV3ScCwE1fVdkQ3jlu7k3Xwuhov6GHn/pHCEaIls6qkA1KJ199Aeer4COJyPab0lWBBAxlLOf6qtiqMQZIcuNYY1bXvXyiLdQy83YpORore0cT/Q0V6jKtZx4r8DhXtdti9GLPcZuHK7gR1uZCWS6hOOuKc8kSf9f2507RPACw27CoP0nMqWDWdrcgZ5S8YQkTsRFVmA+Yvq51VKmyYBRUzmhJoRykqG+6R5O1CROBQzm8L1SQ29Xb1C49+N2PKCQAA" \ No newline at end of file diff --git a/docs/lambda/assets/search.js b/docs/lambda/assets/search.js index f088eb6..989b4c9 100644 --- a/docs/lambda/assets/search.js +++ b/docs/lambda/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":4,\"name\":\"auth\",\"url\":\"modules/auth.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"JwtAuthorizer\",\"url\":\"classes/auth.JwtAuthorizer.html\",\"classes\":\"\",\"parent\":\"auth\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/auth.JwtAuthorizer.html#constructor\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":1024,\"name\":\"claims\",\"url\":\"classes/auth.JwtAuthorizer.html#claims\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/auth.JwtAuthorizer.html#claims.__type\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer.claims\"},{\"kind\":1024,\"name\":\"issuerUrl\",\"url\":\"classes/auth.JwtAuthorizer.html#issuerUrl\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":1024,\"name\":\"groupClaim\",\"url\":\"classes/auth.JwtAuthorizer.html#groupClaim\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":1024,\"name\":\"adminClaim\",\"url\":\"classes/auth.JwtAuthorizer.html#adminClaim\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":1024,\"name\":\"jwksUrl\",\"url\":\"classes/auth.JwtAuthorizer.html#jwksUrl\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getGroups\",\"url\":\"classes/auth.JwtAuthorizer.html#getGroups\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"hasGroup\",\"url\":\"classes/auth.JwtAuthorizer.html#hasGroup\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"authenticate\",\"url\":\"classes/auth.JwtAuthorizer.html#authenticate\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"isAuthenticated\",\"url\":\"classes/auth.JwtAuthorizer.html#isAuthenticated\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"assertAuthenticated\",\"url\":\"classes/auth.JwtAuthorizer.html#assertAuthenticated\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"assertGroup\",\"url\":\"classes/auth.JwtAuthorizer.html#assertGroup\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"isAdmin\",\"url\":\"classes/auth.JwtAuthorizer.html#isAdmin\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"assertAdmin\",\"url\":\"classes/auth.JwtAuthorizer.html#assertAdmin\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getEMail\",\"url\":\"classes/auth.JwtAuthorizer.html#getEMail\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getSubject\",\"url\":\"classes/auth.JwtAuthorizer.html#getSubject\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getClaim\",\"url\":\"classes/auth.JwtAuthorizer.html#getClaim\",\"classes\":\"\",\"parent\":\"auth.JwtAuthorizer\"},{\"kind\":128,\"name\":\"CognitoAuthorizer\",\"url\":\"classes/auth.CognitoAuthorizer.html\",\"classes\":\"\",\"parent\":\"auth\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/auth.CognitoAuthorizer.html#constructor\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"claims\",\"url\":\"classes/auth.CognitoAuthorizer.html#claims\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/auth.CognitoAuthorizer.html#claims.__type\",\"classes\":\"\",\"parent\":\"auth.CognitoAuthorizer.claims\"},{\"kind\":1024,\"name\":\"issuerUrl\",\"url\":\"classes/auth.CognitoAuthorizer.html#issuerUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"groupClaim\",\"url\":\"classes/auth.CognitoAuthorizer.html#groupClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"adminClaim\",\"url\":\"classes/auth.CognitoAuthorizer.html#adminClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"jwksUrl\",\"url\":\"classes/auth.CognitoAuthorizer.html#jwksUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getGroups\",\"url\":\"classes/auth.CognitoAuthorizer.html#getGroups\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"hasGroup\",\"url\":\"classes/auth.CognitoAuthorizer.html#hasGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"authenticate\",\"url\":\"classes/auth.CognitoAuthorizer.html#authenticate\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"isAuthenticated\",\"url\":\"classes/auth.CognitoAuthorizer.html#isAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertAuthenticated\",\"url\":\"classes/auth.CognitoAuthorizer.html#assertAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertGroup\",\"url\":\"classes/auth.CognitoAuthorizer.html#assertGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"isAdmin\",\"url\":\"classes/auth.CognitoAuthorizer.html#isAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertAdmin\",\"url\":\"classes/auth.CognitoAuthorizer.html#assertAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getEMail\",\"url\":\"classes/auth.CognitoAuthorizer.html#getEMail\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getSubject\",\"url\":\"classes/auth.CognitoAuthorizer.html#getSubject\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getClaim\",\"url\":\"classes/auth.CognitoAuthorizer.html#getClaim\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.CognitoAuthorizer\"},{\"kind\":128,\"name\":\"ApiGatewayv1JwtAuthorizer\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html\",\"classes\":\"\",\"parent\":\"auth\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#constructor\",\"classes\":\"\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":1024,\"name\":\"event\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#event\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":1024,\"name\":\"_logger\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#_logger\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"authenticate\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#authenticate\",\"classes\":\"\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":1024,\"name\":\"claims\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#claims\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#claims.__type\",\"classes\":\"\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer.claims\"},{\"kind\":1024,\"name\":\"issuerUrl\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#issuerUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":1024,\"name\":\"groupClaim\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#groupClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":1024,\"name\":\"adminClaim\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#adminClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":1024,\"name\":\"jwksUrl\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#jwksUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getGroups\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#getGroups\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"hasGroup\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#hasGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"isAuthenticated\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#isAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"assertAuthenticated\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#assertAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"assertGroup\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#assertGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"isAdmin\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#isAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"assertAdmin\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#assertAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getEMail\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#getEMail\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getSubject\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#getSubject\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getClaim\",\"url\":\"classes/auth.ApiGatewayv1JwtAuthorizer.html#getClaim\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1JwtAuthorizer\"},{\"kind\":128,\"name\":\"ApiGatewayv2JwtAuthorizer\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html\",\"classes\":\"\",\"parent\":\"auth\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#constructor\",\"classes\":\"\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":1024,\"name\":\"event\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#event\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":1024,\"name\":\"_logger\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#_logger\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"authenticate\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#authenticate\",\"classes\":\"\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":1024,\"name\":\"claims\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#claims\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#claims.__type\",\"classes\":\"\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer.claims\"},{\"kind\":1024,\"name\":\"issuerUrl\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#issuerUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":1024,\"name\":\"groupClaim\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#groupClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":1024,\"name\":\"adminClaim\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#adminClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":1024,\"name\":\"jwksUrl\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#jwksUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getGroups\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#getGroups\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"hasGroup\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#hasGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"isAuthenticated\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#isAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"assertAuthenticated\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#assertAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"assertGroup\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#assertGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"isAdmin\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#isAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"assertAdmin\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#assertAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getEMail\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#getEMail\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getSubject\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#getSubject\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":2048,\"name\":\"getClaim\",\"url\":\"classes/auth.ApiGatewayv2JwtAuthorizer.html#getClaim\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2JwtAuthorizer\"},{\"kind\":128,\"name\":\"ApiGatewayv1CognitoAuthorizer\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html\",\"classes\":\"\",\"parent\":\"auth\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#constructor\",\"classes\":\"\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"event\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#event\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"_logger\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#_logger\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"authenticate\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#authenticate\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"claims\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#claims\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#claims.__type\",\"classes\":\"\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer.claims\"},{\"kind\":1024,\"name\":\"issuerUrl\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#issuerUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"groupClaim\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#groupClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"adminClaim\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#adminClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"jwksUrl\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#jwksUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getGroups\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#getGroups\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"hasGroup\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#hasGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"isAuthenticated\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#isAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertAuthenticated\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#assertAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertGroup\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#assertGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"isAdmin\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#isAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertAdmin\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#assertAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getEMail\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#getEMail\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getSubject\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#getSubject\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getClaim\",\"url\":\"classes/auth.ApiGatewayv1CognitoAuthorizer.html#getClaim\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv1CognitoAuthorizer\"},{\"kind\":128,\"name\":\"ApiGatewayv2CognitoAuthorizer\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html\",\"classes\":\"\",\"parent\":\"auth\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#constructor\",\"classes\":\"\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"event\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#event\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"_logger\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#_logger\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"authenticate\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#authenticate\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"claims\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#claims\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#claims.__type\",\"classes\":\"\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer.claims\"},{\"kind\":1024,\"name\":\"issuerUrl\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#issuerUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"groupClaim\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#groupClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"adminClaim\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#adminClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":1024,\"name\":\"jwksUrl\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#jwksUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getGroups\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#getGroups\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"hasGroup\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#hasGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"isAuthenticated\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#isAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertAuthenticated\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#assertAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertGroup\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#assertGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"isAdmin\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#isAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertAdmin\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#assertAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getEMail\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#getEMail\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getSubject\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#getSubject\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getClaim\",\"url\":\"classes/auth.ApiGatewayv2CognitoAuthorizer.html#getClaim\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.ApiGatewayv2CognitoAuthorizer\"},{\"kind\":128,\"name\":\"AppSyncCognitoAuthorizer\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html\",\"classes\":\"\",\"parent\":\"auth\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#constructor\",\"classes\":\"\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":1024,\"name\":\"event\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#event\",\"classes\":\"tsd-is-protected\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"authenticate\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#authenticate\",\"classes\":\"\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":1024,\"name\":\"claims\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#claims\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#claims.__type\",\"classes\":\"\",\"parent\":\"auth.AppSyncCognitoAuthorizer.claims\"},{\"kind\":1024,\"name\":\"issuerUrl\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#issuerUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":1024,\"name\":\"groupClaim\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#groupClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":1024,\"name\":\"adminClaim\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#adminClaim\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":1024,\"name\":\"jwksUrl\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#jwksUrl\",\"classes\":\"tsd-is-protected tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getGroups\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#getGroups\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"hasGroup\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#hasGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"isAuthenticated\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#isAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertAuthenticated\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#assertAuthenticated\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertGroup\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#assertGroup\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"isAdmin\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#isAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"assertAdmin\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#assertAdmin\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getEMail\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#getEMail\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getSubject\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#getSubject\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":2048,\"name\":\"getClaim\",\"url\":\"classes/auth.AppSyncCognitoAuthorizer.html#getClaim\",\"classes\":\"tsd-is-inherited\",\"parent\":\"auth.AppSyncCognitoAuthorizer\"},{\"kind\":4,\"name\":\"api\",\"url\":\"modules/api.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"HttpResponseContext\",\"url\":\"interfaces/api.HttpResponseContext.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"interfaces/api.HttpResponseContext.html#statusCode\",\"classes\":\"\",\"parent\":\"api.HttpResponseContext\"},{\"kind\":1024,\"name\":\"headers\",\"url\":\"interfaces/api.HttpResponseContext.html#headers\",\"classes\":\"\",\"parent\":\"api.HttpResponseContext\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/api.HttpResponseContext.html#headers.__type\",\"classes\":\"\",\"parent\":\"api.HttpResponseContext.headers\"},{\"kind\":1024,\"name\":\"json\",\"url\":\"interfaces/api.HttpResponseContext.html#json\",\"classes\":\"\",\"parent\":\"api.HttpResponseContext\"},{\"kind\":256,\"name\":\"HttpHandlerContext\",\"url\":\"interfaces/api.HttpHandlerContext.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":1024,\"name\":\"event\",\"url\":\"interfaces/api.HttpHandlerContext.html#event\",\"classes\":\"\",\"parent\":\"api.HttpHandlerContext\"},{\"kind\":1024,\"name\":\"lambdaContext\",\"url\":\"interfaces/api.HttpHandlerContext.html#lambdaContext\",\"classes\":\"\",\"parent\":\"api.HttpHandlerContext\"},{\"kind\":1024,\"name\":\"logger\",\"url\":\"interfaces/api.HttpHandlerContext.html#logger\",\"classes\":\"\",\"parent\":\"api.HttpHandlerContext\"},{\"kind\":1024,\"name\":\"response\",\"url\":\"interfaces/api.HttpHandlerContext.html#response\",\"classes\":\"\",\"parent\":\"api.HttpHandlerContext\"},{\"kind\":1024,\"name\":\"auth\",\"url\":\"interfaces/api.HttpHandlerContext.html#auth\",\"classes\":\"\",\"parent\":\"api.HttpHandlerContext\"},{\"kind\":2097152,\"name\":\"HttpHandler\",\"url\":\"types/api.HttpHandler.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/api.HttpHandler.html#__type\",\"classes\":\"\",\"parent\":\"api.HttpHandler\"},{\"kind\":256,\"name\":\"Operation\",\"url\":\"interfaces/api.Operation.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":1024,\"name\":\"responses\",\"url\":\"interfaces/api.Operation.html#responses\",\"classes\":\"\",\"parent\":\"api.Operation\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/api.Operation.html#responses.__type\",\"classes\":\"\",\"parent\":\"api.Operation.responses\"},{\"kind\":2097152,\"name\":\"APIGatewayv1Handler\",\"url\":\"types/api.APIGatewayv1Handler.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":256,\"name\":\"OperationWithRequestBody\",\"url\":\"interfaces/api.OperationWithRequestBody.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":1024,\"name\":\"requestBody\",\"url\":\"interfaces/api.OperationWithRequestBody.html#requestBody\",\"classes\":\"\",\"parent\":\"api.OperationWithRequestBody\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/api.OperationWithRequestBody.html#requestBody.__type\",\"classes\":\"\",\"parent\":\"api.OperationWithRequestBody.requestBody\"},{\"kind\":1024,\"name\":\"content\",\"url\":\"interfaces/api.OperationWithRequestBody.html#requestBody.__type.content\",\"classes\":\"\",\"parent\":\"api.OperationWithRequestBody.requestBody.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/api.OperationWithRequestBody.html#requestBody.__type.content.__type-1\",\"classes\":\"\",\"parent\":\"api.OperationWithRequestBody.requestBody.__type.content\"},{\"kind\":1024,\"name\":\"application/json\",\"url\":\"interfaces/api.OperationWithRequestBody.html#requestBody.__type.content.__type-1.application_json\",\"classes\":\"\",\"parent\":\"api.OperationWithRequestBody.requestBody.__type.content.__type\"},{\"kind\":1024,\"name\":\"responses\",\"url\":\"interfaces/api.OperationWithRequestBody.html#responses\",\"classes\":\"tsd-is-inherited\",\"parent\":\"api.OperationWithRequestBody\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/api.OperationWithRequestBody.html#responses.__type-2\",\"classes\":\"\",\"parent\":\"api.OperationWithRequestBody.responses\"},{\"kind\":64,\"name\":\"createOpenApiHandlerWithRequestBody\",\"url\":\"functions/api.createOpenApiHandlerWithRequestBody.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":64,\"name\":\"createOpenApiHandlerWithRequestBodyNoResponse\",\"url\":\"functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":64,\"name\":\"createOpenApiHandler\",\"url\":\"functions/api.createOpenApiHandler.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":64,\"name\":\"createHttpHandler\",\"url\":\"functions/api.createHttpHandler.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":256,\"name\":\"AppSyncHandlerContext\",\"url\":\"interfaces/api.AppSyncHandlerContext.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":1024,\"name\":\"event\",\"url\":\"interfaces/api.AppSyncHandlerContext.html#event\",\"classes\":\"\",\"parent\":\"api.AppSyncHandlerContext\"},{\"kind\":1024,\"name\":\"lambdaContext\",\"url\":\"interfaces/api.AppSyncHandlerContext.html#lambdaContext\",\"classes\":\"\",\"parent\":\"api.AppSyncHandlerContext\"},{\"kind\":1024,\"name\":\"logger\",\"url\":\"interfaces/api.AppSyncHandlerContext.html#logger\",\"classes\":\"\",\"parent\":\"api.AppSyncHandlerContext\"},{\"kind\":1024,\"name\":\"cognitoAuth\",\"url\":\"interfaces/api.AppSyncHandlerContext.html#cognitoAuth\",\"classes\":\"\",\"parent\":\"api.AppSyncHandlerContext\"},{\"kind\":2097152,\"name\":\"AppSyncHandler\",\"url\":\"types/api.AppSyncHandler.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/api.AppSyncHandler.html#__type\",\"classes\":\"\",\"parent\":\"api.AppSyncHandler\"},{\"kind\":64,\"name\":\"createAppSyncHandler\",\"url\":\"functions/api.createAppSyncHandler.html\",\"classes\":\"\",\"parent\":\"api\"},{\"kind\":4,\"name\":\"errors\",\"url\":\"modules/errors.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"HttpError\",\"url\":\"classes/errors.HttpError.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/errors.HttpError.html#constructor\",\"classes\":\"\",\"parent\":\"errors.HttpError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/errors.HttpError.html#statusCode\",\"classes\":\"\",\"parent\":\"errors.HttpError\"},{\"kind\":128,\"name\":\"BadRequestError\",\"url\":\"classes/errors.BadRequestError.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/errors.BadRequestError.html#constructor\",\"classes\":\"\",\"parent\":\"errors.BadRequestError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/errors.BadRequestError.html#statusCode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"errors.BadRequestError\"},{\"kind\":128,\"name\":\"UnauthenticatedError\",\"url\":\"classes/errors.UnauthenticatedError.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/errors.UnauthenticatedError.html#constructor\",\"classes\":\"\",\"parent\":\"errors.UnauthenticatedError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/errors.UnauthenticatedError.html#statusCode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"errors.UnauthenticatedError\"},{\"kind\":128,\"name\":\"ForbiddenError\",\"url\":\"classes/errors.ForbiddenError.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/errors.ForbiddenError.html#constructor\",\"classes\":\"\",\"parent\":\"errors.ForbiddenError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/errors.ForbiddenError.html#statusCode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"errors.ForbiddenError\"},{\"kind\":128,\"name\":\"NotFoundError\",\"url\":\"classes/errors.NotFoundError.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/errors.NotFoundError.html#constructor\",\"classes\":\"\",\"parent\":\"errors.NotFoundError\"},{\"kind\":1024,\"name\":\"statusCode\",\"url\":\"classes/errors.NotFoundError.html#statusCode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"errors.NotFoundError\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,43.72]],[\"comment/0\",[]],[\"name/1\",[1,48.828]],[\"comment/1\",[]],[\"name/2\",[2,27.625]],[\"comment/2\",[]],[\"name/3\",[3,32.734]],[\"comment/3\",[]],[\"name/4\",[4,26.141]],[\"comment/4\",[]],[\"name/5\",[5,32.734]],[\"comment/5\",[]],[\"name/6\",[6,32.734]],[\"comment/6\",[]],[\"name/7\",[7,32.734]],[\"comment/7\",[]],[\"name/8\",[8,32.734]],[\"comment/8\",[]],[\"name/9\",[9,32.734]],[\"comment/9\",[]],[\"name/10\",[10,32.734]],[\"comment/10\",[]],[\"name/11\",[11,32.734]],[\"comment/11\",[]],[\"name/12\",[12,32.734]],[\"comment/12\",[]],[\"name/13\",[13,32.734]],[\"comment/13\",[]],[\"name/14\",[14,32.734]],[\"comment/14\",[]],[\"name/15\",[15,32.734]],[\"comment/15\",[]],[\"name/16\",[16,32.734]],[\"comment/16\",[]],[\"name/17\",[17,32.734]],[\"comment/17\",[]],[\"name/18\",[18,32.734]],[\"comment/18\",[]],[\"name/19\",[19,32.734]],[\"comment/19\",[]],[\"name/20\",[20,48.828]],[\"comment/20\",[]],[\"name/21\",[2,27.625]],[\"comment/21\",[]],[\"name/22\",[3,32.734]],[\"comment/22\",[]],[\"name/23\",[4,26.141]],[\"comment/23\",[]],[\"name/24\",[5,32.734]],[\"comment/24\",[]],[\"name/25\",[6,32.734]],[\"comment/25\",[]],[\"name/26\",[7,32.734]],[\"comment/26\",[]],[\"name/27\",[8,32.734]],[\"comment/27\",[]],[\"name/28\",[9,32.734]],[\"comment/28\",[]],[\"name/29\",[10,32.734]],[\"comment/29\",[]],[\"name/30\",[11,32.734]],[\"comment/30\",[]],[\"name/31\",[12,32.734]],[\"comment/31\",[]],[\"name/32\",[13,32.734]],[\"comment/32\",[]],[\"name/33\",[14,32.734]],[\"comment/33\",[]],[\"name/34\",[15,32.734]],[\"comment/34\",[]],[\"name/35\",[16,32.734]],[\"comment/35\",[]],[\"name/36\",[17,32.734]],[\"comment/36\",[]],[\"name/37\",[18,32.734]],[\"comment/37\",[]],[\"name/38\",[19,32.734]],[\"comment/38\",[]],[\"name/39\",[21,48.828]],[\"comment/39\",[]],[\"name/40\",[2,27.625]],[\"comment/40\",[]],[\"name/41\",[22,32.734]],[\"comment/41\",[]],[\"name/42\",[23,37.842]],[\"comment/42\",[]],[\"name/43\",[11,32.734]],[\"comment/43\",[]],[\"name/44\",[3,32.734]],[\"comment/44\",[]],[\"name/45\",[4,26.141]],[\"comment/45\",[]],[\"name/46\",[5,32.734]],[\"comment/46\",[]],[\"name/47\",[6,32.734]],[\"comment/47\",[]],[\"name/48\",[7,32.734]],[\"comment/48\",[]],[\"name/49\",[8,32.734]],[\"comment/49\",[]],[\"name/50\",[9,32.734]],[\"comment/50\",[]],[\"name/51\",[10,32.734]],[\"comment/51\",[]],[\"name/52\",[12,32.734]],[\"comment/52\",[]],[\"name/53\",[13,32.734]],[\"comment/53\",[]],[\"name/54\",[14,32.734]],[\"comment/54\",[]],[\"name/55\",[15,32.734]],[\"comment/55\",[]],[\"name/56\",[16,32.734]],[\"comment/56\",[]],[\"name/57\",[17,32.734]],[\"comment/57\",[]],[\"name/58\",[18,32.734]],[\"comment/58\",[]],[\"name/59\",[19,32.734]],[\"comment/59\",[]],[\"name/60\",[24,48.828]],[\"comment/60\",[]],[\"name/61\",[2,27.625]],[\"comment/61\",[]],[\"name/62\",[22,32.734]],[\"comment/62\",[]],[\"name/63\",[23,37.842]],[\"comment/63\",[]],[\"name/64\",[11,32.734]],[\"comment/64\",[]],[\"name/65\",[3,32.734]],[\"comment/65\",[]],[\"name/66\",[4,26.141]],[\"comment/66\",[]],[\"name/67\",[5,32.734]],[\"comment/67\",[]],[\"name/68\",[6,32.734]],[\"comment/68\",[]],[\"name/69\",[7,32.734]],[\"comment/69\",[]],[\"name/70\",[8,32.734]],[\"comment/70\",[]],[\"name/71\",[9,32.734]],[\"comment/71\",[]],[\"name/72\",[10,32.734]],[\"comment/72\",[]],[\"name/73\",[12,32.734]],[\"comment/73\",[]],[\"name/74\",[13,32.734]],[\"comment/74\",[]],[\"name/75\",[14,32.734]],[\"comment/75\",[]],[\"name/76\",[15,32.734]],[\"comment/76\",[]],[\"name/77\",[16,32.734]],[\"comment/77\",[]],[\"name/78\",[17,32.734]],[\"comment/78\",[]],[\"name/79\",[18,32.734]],[\"comment/79\",[]],[\"name/80\",[19,32.734]],[\"comment/80\",[]],[\"name/81\",[25,48.828]],[\"comment/81\",[]],[\"name/82\",[2,27.625]],[\"comment/82\",[]],[\"name/83\",[22,32.734]],[\"comment/83\",[]],[\"name/84\",[23,37.842]],[\"comment/84\",[]],[\"name/85\",[11,32.734]],[\"comment/85\",[]],[\"name/86\",[3,32.734]],[\"comment/86\",[]],[\"name/87\",[4,26.141]],[\"comment/87\",[]],[\"name/88\",[5,32.734]],[\"comment/88\",[]],[\"name/89\",[6,32.734]],[\"comment/89\",[]],[\"name/90\",[7,32.734]],[\"comment/90\",[]],[\"name/91\",[8,32.734]],[\"comment/91\",[]],[\"name/92\",[9,32.734]],[\"comment/92\",[]],[\"name/93\",[10,32.734]],[\"comment/93\",[]],[\"name/94\",[12,32.734]],[\"comment/94\",[]],[\"name/95\",[13,32.734]],[\"comment/95\",[]],[\"name/96\",[14,32.734]],[\"comment/96\",[]],[\"name/97\",[15,32.734]],[\"comment/97\",[]],[\"name/98\",[16,32.734]],[\"comment/98\",[]],[\"name/99\",[17,32.734]],[\"comment/99\",[]],[\"name/100\",[18,32.734]],[\"comment/100\",[]],[\"name/101\",[19,32.734]],[\"comment/101\",[]],[\"name/102\",[26,48.828]],[\"comment/102\",[]],[\"name/103\",[2,27.625]],[\"comment/103\",[]],[\"name/104\",[22,32.734]],[\"comment/104\",[]],[\"name/105\",[23,37.842]],[\"comment/105\",[]],[\"name/106\",[11,32.734]],[\"comment/106\",[]],[\"name/107\",[3,32.734]],[\"comment/107\",[]],[\"name/108\",[4,26.141]],[\"comment/108\",[]],[\"name/109\",[5,32.734]],[\"comment/109\",[]],[\"name/110\",[6,32.734]],[\"comment/110\",[]],[\"name/111\",[7,32.734]],[\"comment/111\",[]],[\"name/112\",[8,32.734]],[\"comment/112\",[]],[\"name/113\",[9,32.734]],[\"comment/113\",[]],[\"name/114\",[10,32.734]],[\"comment/114\",[]],[\"name/115\",[12,32.734]],[\"comment/115\",[]],[\"name/116\",[13,32.734]],[\"comment/116\",[]],[\"name/117\",[14,32.734]],[\"comment/117\",[]],[\"name/118\",[15,32.734]],[\"comment/118\",[]],[\"name/119\",[16,32.734]],[\"comment/119\",[]],[\"name/120\",[17,32.734]],[\"comment/120\",[]],[\"name/121\",[18,32.734]],[\"comment/121\",[]],[\"name/122\",[19,32.734]],[\"comment/122\",[]],[\"name/123\",[27,48.828]],[\"comment/123\",[]],[\"name/124\",[2,27.625]],[\"comment/124\",[]],[\"name/125\",[22,32.734]],[\"comment/125\",[]],[\"name/126\",[11,32.734]],[\"comment/126\",[]],[\"name/127\",[3,32.734]],[\"comment/127\",[]],[\"name/128\",[4,26.141]],[\"comment/128\",[]],[\"name/129\",[5,32.734]],[\"comment/129\",[]],[\"name/130\",[6,32.734]],[\"comment/130\",[]],[\"name/131\",[7,32.734]],[\"comment/131\",[]],[\"name/132\",[8,32.734]],[\"comment/132\",[]],[\"name/133\",[9,32.734]],[\"comment/133\",[]],[\"name/134\",[10,32.734]],[\"comment/134\",[]],[\"name/135\",[12,32.734]],[\"comment/135\",[]],[\"name/136\",[13,32.734]],[\"comment/136\",[]],[\"name/137\",[14,32.734]],[\"comment/137\",[]],[\"name/138\",[15,32.734]],[\"comment/138\",[]],[\"name/139\",[16,32.734]],[\"comment/139\",[]],[\"name/140\",[17,32.734]],[\"comment/140\",[]],[\"name/141\",[18,32.734]],[\"comment/141\",[]],[\"name/142\",[19,32.734]],[\"comment/142\",[]],[\"name/143\",[28,48.828]],[\"comment/143\",[]],[\"name/144\",[29,48.828]],[\"comment/144\",[]],[\"name/145\",[30,34.165]],[\"comment/145\",[]],[\"name/146\",[31,48.828]],[\"comment/146\",[]],[\"name/147\",[4,26.141]],[\"comment/147\",[]],[\"name/148\",[32,48.828]],[\"comment/148\",[]],[\"name/149\",[33,48.828]],[\"comment/149\",[]],[\"name/150\",[22,32.734]],[\"comment/150\",[]],[\"name/151\",[34,43.72]],[\"comment/151\",[]],[\"name/152\",[35,43.72]],[\"comment/152\",[]],[\"name/153\",[36,48.828]],[\"comment/153\",[]],[\"name/154\",[0,43.72]],[\"comment/154\",[]],[\"name/155\",[37,48.828]],[\"comment/155\",[]],[\"name/156\",[4,26.141]],[\"comment/156\",[]],[\"name/157\",[38,48.828]],[\"comment/157\",[]],[\"name/158\",[39,43.72]],[\"comment/158\",[]],[\"name/159\",[4,26.141]],[\"comment/159\",[]],[\"name/160\",[40,48.828]],[\"comment/160\",[]],[\"name/161\",[41,48.828]],[\"comment/161\",[]],[\"name/162\",[42,48.828]],[\"comment/162\",[]],[\"name/163\",[4,26.141]],[\"comment/163\",[]],[\"name/164\",[43,48.828]],[\"comment/164\",[]],[\"name/165\",[4,26.141]],[\"comment/165\",[]],[\"name/166\",[44,48.828]],[\"comment/166\",[]],[\"name/167\",[39,43.72]],[\"comment/167\",[]],[\"name/168\",[4,26.141]],[\"comment/168\",[]],[\"name/169\",[45,48.828]],[\"comment/169\",[]],[\"name/170\",[46,48.828]],[\"comment/170\",[]],[\"name/171\",[47,48.828]],[\"comment/171\",[]],[\"name/172\",[48,48.828]],[\"comment/172\",[]],[\"name/173\",[49,48.828]],[\"comment/173\",[]],[\"name/174\",[22,32.734]],[\"comment/174\",[]],[\"name/175\",[34,43.72]],[\"comment/175\",[]],[\"name/176\",[35,43.72]],[\"comment/176\",[]],[\"name/177\",[50,48.828]],[\"comment/177\",[]],[\"name/178\",[51,48.828]],[\"comment/178\",[]],[\"name/179\",[4,26.141]],[\"comment/179\",[]],[\"name/180\",[52,48.828]],[\"comment/180\",[]],[\"name/181\",[53,48.828]],[\"comment/181\",[]],[\"name/182\",[54,48.828]],[\"comment/182\",[]],[\"name/183\",[2,27.625]],[\"comment/183\",[]],[\"name/184\",[30,34.165]],[\"comment/184\",[]],[\"name/185\",[55,48.828]],[\"comment/185\",[]],[\"name/186\",[2,27.625]],[\"comment/186\",[]],[\"name/187\",[30,34.165]],[\"comment/187\",[]],[\"name/188\",[56,48.828]],[\"comment/188\",[]],[\"name/189\",[2,27.625]],[\"comment/189\",[]],[\"name/190\",[30,34.165]],[\"comment/190\",[]],[\"name/191\",[57,48.828]],[\"comment/191\",[]],[\"name/192\",[2,27.625]],[\"comment/192\",[]],[\"name/193\",[30,34.165]],[\"comment/193\",[]],[\"name/194\",[58,48.828]],[\"comment/194\",[]],[\"name/195\",[2,27.625]],[\"comment/195\",[]],[\"name/196\",[30,34.165]],[\"comment/196\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":4,\"name\":{\"4\":{},\"23\":{},\"45\":{},\"66\":{},\"87\":{},\"108\":{},\"128\":{},\"147\":{},\"156\":{},\"159\":{},\"163\":{},\"165\":{},\"168\":{},\"179\":{}},\"comment\":{}}],[\"_logger\",{\"_index\":23,\"name\":{\"42\":{},\"63\":{},\"84\":{},\"105\":{}},\"comment\":{}}],[\"adminclaim\",{\"_index\":7,\"name\":{\"7\":{},\"26\":{},\"48\":{},\"69\":{},\"90\":{},\"111\":{},\"131\":{}},\"comment\":{}}],[\"api\",{\"_index\":28,\"name\":{\"143\":{}},\"comment\":{}}],[\"apigatewayv1cognitoauthorizer\",{\"_index\":25,\"name\":{\"81\":{}},\"comment\":{}}],[\"apigatewayv1handler\",{\"_index\":40,\"name\":{\"160\":{}},\"comment\":{}}],[\"apigatewayv1jwtauthorizer\",{\"_index\":21,\"name\":{\"39\":{}},\"comment\":{}}],[\"apigatewayv2cognitoauthorizer\",{\"_index\":26,\"name\":{\"102\":{}},\"comment\":{}}],[\"apigatewayv2jwtauthorizer\",{\"_index\":24,\"name\":{\"60\":{}},\"comment\":{}}],[\"application/json\",{\"_index\":44,\"name\":{\"166\":{}},\"comment\":{}}],[\"appsynccognitoauthorizer\",{\"_index\":27,\"name\":{\"123\":{}},\"comment\":{}}],[\"appsynchandler\",{\"_index\":51,\"name\":{\"178\":{}},\"comment\":{}}],[\"appsynchandlercontext\",{\"_index\":49,\"name\":{\"173\":{}},\"comment\":{}}],[\"assertadmin\",{\"_index\":16,\"name\":{\"16\":{},\"35\":{},\"56\":{},\"77\":{},\"98\":{},\"119\":{},\"139\":{}},\"comment\":{}}],[\"assertauthenticated\",{\"_index\":13,\"name\":{\"13\":{},\"32\":{},\"53\":{},\"74\":{},\"95\":{},\"116\":{},\"136\":{}},\"comment\":{}}],[\"assertgroup\",{\"_index\":14,\"name\":{\"14\":{},\"33\":{},\"54\":{},\"75\":{},\"96\":{},\"117\":{},\"137\":{}},\"comment\":{}}],[\"auth\",{\"_index\":0,\"name\":{\"0\":{},\"154\":{}},\"comment\":{}}],[\"authenticate\",{\"_index\":11,\"name\":{\"11\":{},\"30\":{},\"43\":{},\"64\":{},\"85\":{},\"106\":{},\"126\":{}},\"comment\":{}}],[\"badrequesterror\",{\"_index\":55,\"name\":{\"185\":{}},\"comment\":{}}],[\"claims\",{\"_index\":3,\"name\":{\"3\":{},\"22\":{},\"44\":{},\"65\":{},\"86\":{},\"107\":{},\"127\":{}},\"comment\":{}}],[\"cognitoauth\",{\"_index\":50,\"name\":{\"177\":{}},\"comment\":{}}],[\"cognitoauthorizer\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":2,\"name\":{\"2\":{},\"21\":{},\"40\":{},\"61\":{},\"82\":{},\"103\":{},\"124\":{},\"183\":{},\"186\":{},\"189\":{},\"192\":{},\"195\":{}},\"comment\":{}}],[\"content\",{\"_index\":43,\"name\":{\"164\":{}},\"comment\":{}}],[\"createappsynchandler\",{\"_index\":52,\"name\":{\"180\":{}},\"comment\":{}}],[\"createhttphandler\",{\"_index\":48,\"name\":{\"172\":{}},\"comment\":{}}],[\"createopenapihandler\",{\"_index\":47,\"name\":{\"171\":{}},\"comment\":{}}],[\"createopenapihandlerwithrequestbody\",{\"_index\":45,\"name\":{\"169\":{}},\"comment\":{}}],[\"createopenapihandlerwithrequestbodynoresponse\",{\"_index\":46,\"name\":{\"170\":{}},\"comment\":{}}],[\"errors\",{\"_index\":53,\"name\":{\"181\":{}},\"comment\":{}}],[\"event\",{\"_index\":22,\"name\":{\"41\":{},\"62\":{},\"83\":{},\"104\":{},\"125\":{},\"150\":{},\"174\":{}},\"comment\":{}}],[\"forbiddenerror\",{\"_index\":57,\"name\":{\"191\":{}},\"comment\":{}}],[\"getclaim\",{\"_index\":19,\"name\":{\"19\":{},\"38\":{},\"59\":{},\"80\":{},\"101\":{},\"122\":{},\"142\":{}},\"comment\":{}}],[\"getemail\",{\"_index\":17,\"name\":{\"17\":{},\"36\":{},\"57\":{},\"78\":{},\"99\":{},\"120\":{},\"140\":{}},\"comment\":{}}],[\"getgroups\",{\"_index\":9,\"name\":{\"9\":{},\"28\":{},\"50\":{},\"71\":{},\"92\":{},\"113\":{},\"133\":{}},\"comment\":{}}],[\"getsubject\",{\"_index\":18,\"name\":{\"18\":{},\"37\":{},\"58\":{},\"79\":{},\"100\":{},\"121\":{},\"141\":{}},\"comment\":{}}],[\"groupclaim\",{\"_index\":6,\"name\":{\"6\":{},\"25\":{},\"47\":{},\"68\":{},\"89\":{},\"110\":{},\"130\":{}},\"comment\":{}}],[\"hasgroup\",{\"_index\":10,\"name\":{\"10\":{},\"29\":{},\"51\":{},\"72\":{},\"93\":{},\"114\":{},\"134\":{}},\"comment\":{}}],[\"headers\",{\"_index\":31,\"name\":{\"146\":{}},\"comment\":{}}],[\"httperror\",{\"_index\":54,\"name\":{\"182\":{}},\"comment\":{}}],[\"httphandler\",{\"_index\":37,\"name\":{\"155\":{}},\"comment\":{}}],[\"httphandlercontext\",{\"_index\":33,\"name\":{\"149\":{}},\"comment\":{}}],[\"httpresponsecontext\",{\"_index\":29,\"name\":{\"144\":{}},\"comment\":{}}],[\"isadmin\",{\"_index\":15,\"name\":{\"15\":{},\"34\":{},\"55\":{},\"76\":{},\"97\":{},\"118\":{},\"138\":{}},\"comment\":{}}],[\"isauthenticated\",{\"_index\":12,\"name\":{\"12\":{},\"31\":{},\"52\":{},\"73\":{},\"94\":{},\"115\":{},\"135\":{}},\"comment\":{}}],[\"issuerurl\",{\"_index\":5,\"name\":{\"5\":{},\"24\":{},\"46\":{},\"67\":{},\"88\":{},\"109\":{},\"129\":{}},\"comment\":{}}],[\"json\",{\"_index\":32,\"name\":{\"148\":{}},\"comment\":{}}],[\"jwksurl\",{\"_index\":8,\"name\":{\"8\":{},\"27\":{},\"49\":{},\"70\":{},\"91\":{},\"112\":{},\"132\":{}},\"comment\":{}}],[\"jwtauthorizer\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"lambdacontext\",{\"_index\":34,\"name\":{\"151\":{},\"175\":{}},\"comment\":{}}],[\"logger\",{\"_index\":35,\"name\":{\"152\":{},\"176\":{}},\"comment\":{}}],[\"notfounderror\",{\"_index\":58,\"name\":{\"194\":{}},\"comment\":{}}],[\"operation\",{\"_index\":38,\"name\":{\"157\":{}},\"comment\":{}}],[\"operationwithrequestbody\",{\"_index\":41,\"name\":{\"161\":{}},\"comment\":{}}],[\"requestbody\",{\"_index\":42,\"name\":{\"162\":{}},\"comment\":{}}],[\"response\",{\"_index\":36,\"name\":{\"153\":{}},\"comment\":{}}],[\"responses\",{\"_index\":39,\"name\":{\"158\":{},\"167\":{}},\"comment\":{}}],[\"statuscode\",{\"_index\":30,\"name\":{\"145\":{},\"184\":{},\"187\":{},\"190\":{},\"193\":{},\"196\":{}},\"comment\":{}}],[\"unauthenticatederror\",{\"_index\":56,\"name\":{\"188\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA71c23IbNxL9lS36VVbYuMzFb44rt63a7JZT2X1QuVy0OJaYSCSXpOx4Xf73ncEAJAB2YwDMUC+JaOJygNPd6NMYztfZbvN5P3t183X252q9nL0SV7P14rGZvZotng73s6vZ0+6h/fC4WT49NPvvun+8vj88PrTf3D4s9vum7Tybfbsy/YFVxxH+/vnwum2/2a3+1+yOQ+lu/VBOE2Tgq9l2sWvWB4PnNJEEdpzodrPeH3ZPt4dN9DQv3D6nKQ/75cvV/uV2tzk0t4dm6UNwx7JXPmenzWvHWz3u48GY5hPgKKTkxRHI+/eHL9smEcj1sRdNhddbr4DYjtV+/9Tsft89RAOxe0xNzt1u87R90wGOhuN0mRrPYvm4WqfhcbpMjeePz3/uU7g6tZ8ACZuLUwS5aw4/dTsf70l2j1jjpWa/X+zVWNGTWx3Gzt21bPusbheHeO/1Oo3FsNq/tgZcJviu32/0brS9d4c8NHjfaRClmYfbZwJ2uiCQwopuPxEbSbO7fcYiaL38h38sVvEhyuowwdy/PX34o41qKbOfukwwf+LZdeqQMbed0L3Z3K1Xh81QUnfW7HKJHT5VfnJ3vsKMBI8CNZzk/U3/w2p93+xWqQDjM78gwqjs73yEURkgASguCxy3a0mpIYEzMj2cEOhQzkgAjcwbJwQaTCYJlDEJ5TiIKVkmxTmaaU6HKpx9EqDQDHQ6TMNZKWV3VGY6HbaobJWMM3R+OOHuxWax1CYOZLJTI003PyrDnZRlOu+k2T3LOydnNRkVlRFPGtcCWTId1s4z5UkxBbNnGhWWQU+KK+PYxzLrcUenlW2/3q5+an388+LLJ4gopZLNL5d9h6cks/CzHaFXSiQVzaeudw4m0zNBEySje/+wubvLo+nFqe/ECBPP8QGY8ZWm5N0LKashg5tCYcUAjldaUYijFBc90ijlNQBwKgWWbAZDSmwA92SKLBn4kDIb8qypFFoy8KBSG0A9jWJLjmMDym3IRvIUXDLKsJIbAJmn6JIxRqmnwVgxQpukn2GxamrI4caqqkzk+SaRrbJyrILWNcPWkK5tcq0gG2W2CsuJVQE1NhyqMlRZDsagOhtGmaXScnCOSA2yVFvUcYqrN5am3tg55kurN2TKLPXGohKNOPWGYRqn3uLQxao3DN9Y9UYizFdvGMws9Ra3e5HqDTW4idUbCThLvdGIU9WbN9JU6g0DeAH1FmcGCeoNw30J9RYHPEG9oZ51AfUWBzxWvWGoJ1dvcXEsXr2hNjJavcWhjFZvGMjR6i0OY6p6w2PFNBoo8gzLUG+ow02o3lKQ55vEFOot2iqidBFhDaM0UZIVZKOcQr1Fx6o49UaEqnHqLRpjrHojUI5Vb9E4R6QGY9UbfZwSd2+RT70FuzzPHVzi03BBjRv9gE/kXRyBbVjRpZWNo2FHX9IRwGOk3nTQR9zeTf5ETtZ2x97qXfLZyVjgebd745+pDI822S3fhZ+1zDKPlNu+Sz+DmbWAlFu/Sz+bmbWA6Nu/iz6zmRUPE24Bp32WMwtt/G3gpM94ZmFNvhW8xPOVeWdkzu3gpZ67HLGCcaYyyU3hNM9mxlnJuHu46Z7ZjLeKZ0Icf3s46XOduVijbxEnft4zF+/I1GP0jWLGM6EsXZeed3me28UJdSmy6nG3jM+jS+NhR18/PpcuDUIfcS95SV0av92x95XPpEuDwPPuLSfVpchok91fPp8ujTePlHvMZ9Sl8QtIuc98Rl0av4Doe83n0qXx8TDhfvNiujQebfw956V0aTzW5PvOC+vShDMy597zGXRp6grGmcokd6CT69KAlYy7YbyILh2wimdCHH8veildmoQ1+n70cro0Ce/I1GP0XWm8Lt3+9mV9Gy1J8daXVKOBGVOEKLHMHA0aQpT1oOsgtmS1FoJICrXRuxbWZEEip5Fjg3BTlNgw3kgRRgw0Un+F4E0nvdIMYFh1hVBPKLjSYA9rraA/TSez0mAPKKwQ5qnEVVrkGtRVQevIlVRpGIfUVAhirpBKQxipocLxYZT4SDyv4pVT0M3Gi6Yc3NnGMEIqJdtDSHcM2EGO3MjiPxfjCFmUHJ2CimggOGWJoWSEAzpoAGOmBEpGmZ8CZAqfQYTWYb9dHZEd3469XSESxlqfPCWNPx8O27fNfttKj+bNZn1o/jqxsWo/7j4ubvWQSNMBpdRiIw77/WFxeNq/2Syb1NleOF3JibH+FJj7ZrFsdvtkJKd+uTCCCXwijMH0nRpDr4JKy/abdTIk3Sl3W3wD/XmxXj40uwj7dFtmm6crmOPmQcQytmpvLQSAh8Xjh+Uib8Ev/M6TAHKvg2ORnF8C50PYaXtJBWH1mwKGqv8kQtB9Mqdn87oEyTCXOALpXP8MQ4r9B0MRPfqLyKhj8OJO/s9ts1scVnSkOTbIdmljBWSYd6d4Ybenl3YCnhfUqUljgvmp7wkrbTSv//XL8TEf2niQVik7jnL6n9Xh/m3z36dmf/h+s/wyuBVe+xGMj5vzhTtABBH+SkfaxBCoJCPxB9uhON0CaBeJ6HMwFef1abxxeM26n2d7DWz98SVMhf+4H9RBs90+dJWBdrDvQlnY6AVdWzO9H0zdMlZ4TlhmaCZWiEXqoMx6fqd14/pLlrvF54G+sBx217TBu+29fr1d6fBNRd+PT+vbbooefkTPpGQiCdOvm7d+apeM7jTGhDgT4IyaFUvosCkzUzv7VNbFhThFhTa+jKiip4rQVfiixkirAJx4dZUGKyiwQniGNVYSkNtT3SkDjds7H9JZ+uq0xzJXp8EFlA8yQYz48YAHogCxRCwQ5C/WcsfdbmMVvUzxsP/nYP3QfuKiC0k/dF3O6qN6oGODMEqNJv25CnSaqEcp/J4Jtcrw5BEVytDc1u5+v1jqMy64x16zy+40NlnKfvtryt51FAix96FscBiXxcjva/uBk2WQFqztZbkhZ0whCF1iNks0pHyqhhBafP242X1YLZfNOsiU2+qyHCFzpbDjLSibFwxGPiM0KouLXzeHHzdP67DTOI0uy8T5VClEuKvJ5gEBkU+Dh+ndVZu5LZu/Zq++zj41u31Xp3w1Y9f8um47f1w1D8t24JsebDvV5vGxG+6d/u7fTbcPXYu+yXfz2dXN/Erw65K9e3d1Yzqof1f/oFpB+wmuRHVdscppBk6zVgLfsCtWXhdMOs2Y04y3n/gVZ9clF04z7jQT7SdxxYprEOA0E04z2X6S2GjSaVa0nwqsWeE0K9tPJdasdJpV7acKa1Y5zVpObmqsWe1ub7fbMMcagkeEYgLQli4X0O156zxYS5cO6LYdUELAZQS6nQeBtnRJgW7zAaUFXF6g239AmQGXGugoAJQccNmBjgVA+QGXIOiIAJQicDliHRFsjjkBczliQLqB5y6McgTmMsQ45QrMJYgJyhmYyw+TlDswlx5WUA7BXHZYSbkEc8lhFeUUzOWG1aRXMJcbPie9grvccCC9grvkcEZ6BffCGSe9grv0cEF6BXf54ZL0Cu4SxAvSK7jLEC9Jr+AuRbwivYK7HPGOCIYeDdzlSMwprxAuRUK5D0qRcCkS6rxpKSqvK+EeX8KlSHDSQIR36AjKJ4XLkJDk8eQSJArKJ4XLjygpnxQuPaKifFK47Iia8knhkiPnlE9KlxwJpE9KlxxJnz/SJUfS5490yZH0+SO9pIA+f6RLj6TPH+nyI+nzR7oESfr8kS5Dkj5/pEtRofxHYJ5WuBwV5PlTuBQVjPS0wqWo4KSnFS5FhSA9rXApKiTlaYWXuRWUpxUuQUVJeVrh8lNUZDLo0lPUlKcVLjvlnPK00iWnBMrTSpeckpGeVrrklJz0tNIlpxSkp5UuOaUkPa102SkL0tNKL7UuSU8rXX7KivS00iWorElPK12GqjnpaZVLUaX8R2KeVrkcVaTgqVyKKk56WuVSVAnS0yqXokqSnla5FFUF5WmVy1BVUp5WefKnojytcvmpasrTKpeeek55Wu2yUwPlabVLTs0oT6tdcmpOelrtklML0tNql5xakp5Wu+TUBelptctOXZKeVrv01BXpabUnUGvS02pfo85JV+u/s9sC6Wz9d3Zb5UQFWl2Ye0p1zimH67+ymwrS5frv7LaSdLr+O7ttQbpd/53dtqQcr//KblpRrtd/ZTetKefrv7KaquoBrq3PCgtAOSD4lQVVP8ANwS8tqAICbgd+baEvLuBFEL+60JcXcHL9+kJfYMBZ8CsMfYkBL3D4NYa+yIDz4FcZ+jIDQYTHmaomEGUOr9IAqqBA+CTz60GM9kmv3gCqrMBK1Ce9kgOoygLuk17RAVRtgfBJr+4ALOBnXukBGO1nXvEBGO1nXvkBGO1nXv0BOO1nXgECOO1nXgUCOO1n3C/h0X7m1SCAB/zMq0IAD/iZV4cAHvAzrxIBPOBnXi0CeMDPvGoE8ICfefUIEAE/80oSIAJ+5hUlQAT8zCtLgCo+sAr1M+HXXpWf1XhbjzdVguAtx+IaCs8pvfIEqCoEx6v7XoUCBJkgglejAFWK4Awf1qNNVSM4x9t6tKmCBBFDvGIFqJIEF8j1BnjVClA1CS7Rph5pqijB8YTFK1iAKktg9ysg/YK5ogwPuV7JAiSpiMGrWYCqTHDcwryqBajaBK9RtB5jqjhBIPAIU9UJgRbOwatcgCpQCNwWveIFqBKFwA3MK19AQRbQwatfgKpSCNwWvQoGFGQNEAr/lkNRhpZvwCtjgKpW4Dx4hQwo6OPMK2WAqlgIVNaCV80AVbQQuIl7BQ1QdQuBG65X0wBVuRC4NXpVDVC1C4HHO6+uAWUg2fcqG6DqF3hQ8EoboAoYeFAo/bspVXvCrdyrboCqYUjcyr36BpS0o3kFDlBlDIk7hFfiAFXIkLiVe0UOULUMiZuuV+eAihZoXqEDVDmDOKO8UgeogobEbdcrdoCqaRAQPNJUVYOC4F8pKtJwl/CKHqBqGwQEjzRV3SAgeJUPUAUOiXuaV/yAmixNgVf+AFXkoCB4pKkyh8Qd2CuBgCp0EBA8zlSlg4LQk6YefPjU7A7N8pf+AYibm+OTnV9n7/VTEcfnNL7ORPufb1ezVq+o/7d5j/p/G23V/1uC1f87fd3/wcwfwnwlC/NHrf8ouPlDmj9Mr1K1+XZ66KL71C3l+OLcE0zGLZxMA9NDV8IAk8SA6oUut/3P0E9jlqchNX6m4QsNsdCraA2rn6FV9v0fHKipuh+jW7ir0yRdhkp2ujM/OdNPDy+sF3dZw8nTcFUAwnG0e/MkrcX43IJUzCMG+ePzgYADp6E4xaY1EgsvrrCAzVnEcDQwy6wDS/R/XGRtkrA3qaBH2H9Z34ZXZZkZMNoC1EgIXdLa4+60i+l/a57MtxZU28OQMNSrORb9qzlOncFmRvsI1/5sXL7UPlQb9wYTAmjL6GdzXwBjzWr5PGhf59r3pf5cat+vTXQx8DoJHZr1rn+NizWbzbgeletZpP5c6llqMwmYwMdLajb1K4DTNJbzmaDSj070bY7vdbOg2iahIxLXowkNudCQK7Mxc4OZURvzYbHUv19r+qcTLSO04g5UVJg173w79bMY1LiYJlBofOZYqAy8udlSRm2p5W4ORjuulRGdEV+1hmBU2HCej7T6Wl31UjU1QlNT6M8VM0s1ZyMzJ1hl/uW4HZXxotr0qsntN78ttbzedqGCsrP+BxWBEMRs9sl9UaPcHw5b7NCxz8GSiu39EJtts26jPDaKHUtL6vzDRvm8Otxr4/6gfgJoDWrbdkHFqohB15vTaxas4e3YWVKbZ36JYm26TR151usfhllmaHEltMEV2nSO1jU39sZMdJAmGJWUkXw0jzefBweblZpCetcczjIwsA8lbehcnx8mg6wMsrnJvUwIAUHZUTtX86he3mTN5diOnkt7mdSfSz13bZyOmckFRVw71Z1+id1pLmtZeiSTKpt9LvVijl5tDjjg1NnczrQ3b3uylmU7lp6E6+VI/bk0y5mb5ZjQBIKkq1vUGWGWLeutMxZkJIDJ7o9xC8ycnNrC+8X+/DS2g7kegekhpQZf6r2rzdaZY7sryxNTmdcVWUeUfZgK6mzswtq54dspQ0UZIxERuW2PkorpVmckqeN2jBBU6OrGMJEJGYTZTiionVvtz7NCO3BqM+CaAqk/l9pManOqGxsFTqWy7UxkRmgfRJp9rq1B6s+ltobaGIOBBpza5P7lqt1PE2xyT1PpAcwpLfSaCr2myixpfgwbFBW+zOD2ggS1I927PT10ltfr2ZlGIzSIUntNbVzdbBhwylJJOWW7CNG3/0kwZqO2kxjXhZLi4lz6c8fMzCJKylPXm8PH7vcf595qR8qasvPN6TU8FgS7q6RSy2PXULJhb2VBbSbV2baWgmIRS0K4nYRI6oSx3iJhdbXDgzlRoKA2of/hzq364Y41iB3OTWEJjoWbY2npWGg5xvSa4vnJ/QHcOd32kivUtd5dzbarbfOwWretbt59+/Z/hlClP4SrAAA="; \ No newline at end of file diff --git a/docs/lambda/assets/style.css b/docs/lambda/assets/style.css index 258146f..07a385b 100644 --- a/docs/lambda/assets/style.css +++ b/docs/lambda/assets/style.css @@ -11,6 +11,7 @@ --light-color-text-aside: #6e6e6e; --light-color-link: #1f70c2; + --light-color-ts-keyword: #056bd6; --light-color-ts-project: #b111c9; --light-color-ts-module: var(--light-color-ts-project); --light-color-ts-namespace: var(--light-color-ts-project); @@ -50,6 +51,7 @@ --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; + --dark-color-ts-keyword: #3399ff; --dark-color-ts-project: #e358ff; --dark-color-ts-module: var(--dark-color-ts-project); --dark-color-ts-namespace: var(--dark-color-ts-project); @@ -91,6 +93,7 @@ --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -132,6 +135,7 @@ --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -180,6 +184,7 @@ body { --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -219,6 +224,7 @@ body { --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -910,8 +916,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -924,7 +931,10 @@ a.tsd-index-link { background-color: var(--color-accent); } #tsd-search .results a { - display: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -980,6 +990,11 @@ a.tsd-index-link { overflow-x: auto; } +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + .tsd-signature-symbol { color: var(--color-text-aside); font-weight: normal; @@ -1134,7 +1149,7 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; } .warning { diff --git a/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html b/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html index 2445aae..ad81956 100644 --- a/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +++ b/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html @@ -1,54 +1,14 @@ -ApiGatewayv1CognitoAuthorizer | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class ApiGatewayv1CognitoAuthorizer

    -
    -

    ApiGatewayv1CognitoAuthorizer is a specialization of an ApiGatewayv1JwtAuthorizer +ApiGatewayv1CognitoAuthorizer | cdk-serverless

    Class ApiGatewayv1CognitoAuthorizer

    ApiGatewayv1CognitoAuthorizer is a specialization of an ApiGatewayv1JwtAuthorizer and implements authentication logic for API Gateway v1 requests when using Cognito..

    -
    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -

    Hierarchy

    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    _logger: LambdaLog
    -
    - -
    adminClaim: string
    -
    - -
    claims?: {
        [name: string]: string | number | boolean | string[];
    }
    -

    The claims of the authenticated user.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string | number | boolean | string[]
    -
    -
    - -
    event: APIGatewayProxyWithCognitoAuthorizerEvent
    -
    - -
    groupClaim: string
    -
    - -
    issuerUrl: string
    -
    - -
    jwksUrl?: string
    -
    -

    Methods

    -
    - -
    -
    - -
    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or does not belong +

    Constructors

    Properties

    _logger: LambdaLog
    adminClaim: string
    claims?: {
        [name: string]: string | number | boolean | string[];
    }

    The claims of the authenticated user.

    +

    Type declaration

    • [name: string]: string | number | boolean | string[]
    event: APIGatewayProxyWithCognitoAuthorizerEvent
    groupClaim: string
    issuerUrl: string
    jwksUrl?: string

    Methods

    • Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Authenticates the user using the claims provided by the API Gateway event or +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns void

    • Authenticates the user using the claims provided by the API Gateway event or by decoding a JWT token from the 'Authorization' header.

      -
      -

      Returns Promise<void>

      -
    -
    - -
      - -
    • -

      Returns the value of the claim with the specified name, or undefined if the +

      Returns Promise<void>

    • Returns the value of the claim with the specified name, or undefined if the claim does not exist.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The name of the claim to retrieve.

        -
      -

      Returns undefined | string | number | boolean | string[]

      -
    -
    - -
    -
    - -
      - -
    • -

      Returns an array of groups the user belongs to, or an empty array if the user +

      Parameters

      • name: string

        The name of the claim to retrieve.

        +

      Returns undefined | string | number | boolean | string[]

    • Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

      -
      -

      Returns string[]

      -
    -
    - -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the specified group, false otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the 'admin' group, false otherwise.

      -
      -

      Returns boolean

      -
    -
    - -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Returns string[]

    • Returns true if the user belongs to the specified group, false otherwise.

      +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html b/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html index 2eb6134..f08b57e 100644 --- a/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +++ b/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html @@ -1,55 +1,13 @@ -ApiGatewayv1JwtAuthorizer | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class ApiGatewayv1JwtAuthorizer

    -
    -

    Implements authorization on API Gateway v1 (Rest API) using JWT.

    -
    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    _logger +ApiGatewayv1JwtAuthorizer | cdk-serverless

    Class ApiGatewayv1JwtAuthorizer

    Implements authorization on API Gateway v1 (Rest API) using JWT.

    +

    Hierarchy

    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    _logger: LambdaLog
    -
    - -
    adminClaim: string
    -
    - -
    claims?: {
        [name: string]: string | number | boolean | string[];
    }
    -

    The claims of the authenticated user.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string | number | boolean | string[]
    -
    -
    - -
    event: APIGatewayProxyWithCognitoAuthorizerEvent
    -
    - -
    groupClaim: string
    -
    - -
    issuerUrl: string
    -
    - -
    jwksUrl?: string
    -
    -

    Methods

    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or is not an admin.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Throws an UnauthenticatedError if the user is not authenticated.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or does not belong +

    Constructors

    Properties

    _logger: LambdaLog
    adminClaim: string
    claims?: {
        [name: string]: string | number | boolean | string[];
    }

    The claims of the authenticated user.

    +

    Type declaration

    • [name: string]: string | number | boolean | string[]
    event: APIGatewayProxyWithCognitoAuthorizerEvent
    groupClaim: string
    issuerUrl: string
    jwksUrl?: string

    Methods

    • Throws a ForbiddenError if the user is not authenticated or is not an admin.

      +

      Returns void

    • Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Authenticates the user using the claims provided by the API Gateway event or +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns void

    • Authenticates the user using the claims provided by the API Gateway event or by decoding a JWT token from the 'Authorization' header.

      -
      -

      Returns Promise<void>

      -
    -
    - -
      - -
    • -

      Returns the value of the claim with the specified name, or undefined if the +

      Returns Promise<void>

    • Returns the value of the claim with the specified name, or undefined if the claim does not exist.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The name of the claim to retrieve.

        -
      -

      Returns undefined | string | number | boolean | string[]

      -
    -
    - -
      - -
    • -

      Returns the email of the authenticated user.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns an array of groups the user belongs to, or an empty array if the user +

      Parameters

      • name: string

        The name of the claim to retrieve.

        +

      Returns undefined | string | number | boolean | string[]

    • Returns the email of the authenticated user.

      +

      Returns string

    • Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

      -
      -

      Returns string[]

      -
    -
    - -
      - -
    • -

      Returns the subject of the authenticated user.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the specified group, false otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the 'admin' group, false otherwise.

      -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user is authenticated, false otherwise.

      -
      -

      Returns boolean

      -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Returns string[]

    • Returns the subject of the authenticated user.

      +

      Returns string

    • Returns true if the user belongs to the specified group, false otherwise.

      +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns boolean

    • Returns true if the user belongs to the 'admin' group, false otherwise.

      +

      Returns boolean

    • Returns true if the user is authenticated, false otherwise.

      +

      Returns boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html b/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html index 4b47714..2101098 100644 --- a/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +++ b/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html @@ -1,55 +1,15 @@ -ApiGatewayv2CognitoAuthorizer | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class ApiGatewayv2CognitoAuthorizer

    -
    -

    ApiGatewayv2CognitoAuthorizer is a class that extends CognitoAuthorizer +ApiGatewayv2CognitoAuthorizer | cdk-serverless

    Class ApiGatewayv2CognitoAuthorizer

    ApiGatewayv2CognitoAuthorizer is a class that extends CognitoAuthorizer and implements authentication logic for API Gateway v2 requests with a JWT authorizer.

    -
    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -

    Hierarchy

    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    _logger: LambdaLog
    -
    - -
    adminClaim: string
    -
    - -
    claims?: {
        [name: string]: string | number | boolean | string[];
    }
    -

    The claims of the authenticated user.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string | number | boolean | string[]
    -
    -
    - -
    event: APIGatewayProxyEventV2WithJWTAuthorizer
    -
    - -
    groupClaim: string
    -
    - -
    issuerUrl: string
    -
    - -
    jwksUrl?: string
    -
    -

    Methods

    -
    - -
    -
    - -
    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or does not belong +

    Constructors

    Properties

    _logger: LambdaLog
    adminClaim: string
    claims?: {
        [name: string]: string | number | boolean | string[];
    }

    The claims of the authenticated user.

    +

    Type declaration

    • [name: string]: string | number | boolean | string[]
    event: APIGatewayProxyEventV2WithJWTAuthorizer
    groupClaim: string
    issuerUrl: string
    jwksUrl?: string

    Methods

    • Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Authenticates the user using the claims provided by the API Gateway event or +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns void

    • Authenticates the user using the claims provided by the API Gateway event or by decoding a JWT token from the 'Authorization' header.

      -
      -

      Returns Promise<void>

      -
    -
    - -
      - -
    • -

      Returns the value of the claim with the specified name, or undefined if the +

      Returns Promise<void>

    • Returns the value of the claim with the specified name, or undefined if the claim does not exist.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The name of the claim to retrieve.

        -
      -

      Returns undefined | string | number | boolean | string[]

      -
    -
    - -
    -
    - -
      - -
    • -

      Returns an array of groups the user belongs to, or an empty array if the user +

      Parameters

      • name: string

        The name of the claim to retrieve.

        +

      Returns undefined | string | number | boolean | string[]

    • Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

      -
      -

      Returns string[]

      -
    -
    - -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the specified group, false otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the 'admin' group, false otherwise.

      -
      -

      Returns boolean

      -
    -
    - -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Returns string[]

    • Returns true if the user belongs to the specified group, false otherwise.

      +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html b/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html index a76c3ad..edd1080 100644 --- a/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +++ b/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html @@ -1,55 +1,13 @@ -ApiGatewayv2JwtAuthorizer | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class ApiGatewayv2JwtAuthorizer

    -
    -

    Implements JWT Authorization on API Gateway v2 (HTTP API).

    -
    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    _logger +ApiGatewayv2JwtAuthorizer | cdk-serverless

    Class ApiGatewayv2JwtAuthorizer

    Implements JWT Authorization on API Gateway v2 (HTTP API).

    +

    Hierarchy

    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    _logger: LambdaLog
    -
    - -
    adminClaim: string
    -
    - -
    claims?: {
        [name: string]: string | number | boolean | string[];
    }
    -

    The claims of the authenticated user.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string | number | boolean | string[]
    -
    -
    - -
    event: APIGatewayProxyEventV2WithJWTAuthorizer
    -
    - -
    groupClaim: string
    -
    - -
    issuerUrl: string
    -
    - -
    jwksUrl?: string
    -
    -

    Methods

    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or is not an admin.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Throws an UnauthenticatedError if the user is not authenticated.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or does not belong +

    Constructors

    Properties

    _logger: LambdaLog
    adminClaim: string
    claims?: {
        [name: string]: string | number | boolean | string[];
    }

    The claims of the authenticated user.

    +

    Type declaration

    • [name: string]: string | number | boolean | string[]
    event: APIGatewayProxyEventV2WithJWTAuthorizer
    groupClaim: string
    issuerUrl: string
    jwksUrl?: string

    Methods

    • Throws a ForbiddenError if the user is not authenticated or is not an admin.

      +

      Returns void

    • Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Authenticates the user using the claims provided by the API Gateway event or +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns void

    • Authenticates the user using the claims provided by the API Gateway event or by decoding a JWT token from the 'Authorization' header.

      -
      -

      Returns Promise<void>

      -
    -
    - -
      - -
    • -

      Returns the value of the claim with the specified name, or undefined if the +

      Returns Promise<void>

    • Returns the value of the claim with the specified name, or undefined if the claim does not exist.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The name of the claim to retrieve.

        -
      -

      Returns undefined | string | number | boolean | string[]

      -
    -
    - -
      - -
    • -

      Returns the email of the authenticated user.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns an array of groups the user belongs to, or an empty array if the user +

      Parameters

      • name: string

        The name of the claim to retrieve.

        +

      Returns undefined | string | number | boolean | string[]

    • Returns the email of the authenticated user.

      +

      Returns string

    • Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

      -
      -

      Returns string[]

      -
    -
    - -
      - -
    • -

      Returns the subject of the authenticated user.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the specified group, false otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the 'admin' group, false otherwise.

      -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user is authenticated, false otherwise.

      -
      -

      Returns boolean

      -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Returns string[]

    • Returns the subject of the authenticated user.

      +

      Returns string

    • Returns true if the user belongs to the specified group, false otherwise.

      +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns boolean

    • Returns true if the user belongs to the 'admin' group, false otherwise.

      +

      Returns boolean

    • Returns true if the user is authenticated, false otherwise.

      +

      Returns boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html b/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html index f31b58c..19decbe 100644 --- a/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +++ b/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html @@ -1,54 +1,14 @@ -AppSyncCognitoAuthorizer | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class AppSyncCognitoAuthorizer

    -
    -

    AppSyncCognitoAuthorizer is a class that extends CognitoAuthorizer +AppSyncCognitoAuthorizer | cdk-serverless

    Class AppSyncCognitoAuthorizer

    AppSyncCognitoAuthorizer is a class that extends CognitoAuthorizer and implements authentication logic for AppSync resolver events with a Cognito authorizer.

    -
    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -

    Hierarchy

    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    adminClaim: string
    -
    - -
    claims?: {
        [name: string]: string | number | boolean | string[];
    }
    -

    The claims of the authenticated user.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string | number | boolean | string[]
    -
    -
    - -
    event: AppSyncResolverEvent<any, null | Record<string, any>>
    -
    - -
    groupClaim: string
    -
    - -
    issuerUrl: string
    -
    - -
    jwksUrl?: string
    -
    -

    Methods

    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or is not an admin.

      -
      -

      Returns void

      -
    -
    - -
    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or does not belong +

    Constructors

    Properties

    adminClaim: string
    claims?: {
        [name: string]: string | number | boolean | string[];
    }

    The claims of the authenticated user.

    +

    Type declaration

    • [name: string]: string | number | boolean | string[]
    event: AppSyncResolverEvent<any, null | Record<string, any>>
    groupClaim: string
    issuerUrl: string
    jwksUrl?: string

    Methods

    • Throws a ForbiddenError if the user is not authenticated or is not an admin.

      +

      Returns void

    • Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Authenticates the user using the claims provided by the AppSync event.

      -
      -

      Returns Promise<void>

      -
    -
    - -
      - -
    • -

      Returns the value of the claim with the specified name, or undefined if the +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns void

    • Authenticates the user using the claims provided by the AppSync event.

      +

      Returns Promise<void>

    • Returns the value of the claim with the specified name, or undefined if the claim does not exist.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The name of the claim to retrieve.

        -
      -

      Returns undefined | string | number | boolean | string[]

      -
    -
    - -
      - -
    • -

      Returns the email of the authenticated user.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns an array of groups the user belongs to, or an empty array if the user +

      Parameters

      • name: string

        The name of the claim to retrieve.

        +

      Returns undefined | string | number | boolean | string[]

    • Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

      -
      -

      Returns string[]

      -
    -
    - -
      - -
    • -

      Returns the subject of the authenticated user.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the specified group, false otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the 'admin' group, false otherwise.

      -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user is authenticated, false otherwise.

      -
      -

      Returns boolean

      -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Returns string[]

    • Returns true if the user belongs to the specified group, false otherwise.

      +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns boolean

    • Returns true if the user belongs to the 'admin' group, false otherwise.

      +

      Returns boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/auth.CognitoAuthorizer.html b/docs/lambda/classes/auth.CognitoAuthorizer.html index 48c01ad..0c25333 100644 --- a/docs/lambda/classes/auth.CognitoAuthorizer.html +++ b/docs/lambda/classes/auth.CognitoAuthorizer.html @@ -1,54 +1,12 @@ -CognitoAuthorizer | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class CognitoAuthorizerAbstract

    -
    -

    CognitoAuthorizer is an abstract class representing an authorizer +CognitoAuthorizer | cdk-serverless

    Class CognitoAuthorizerAbstract

    CognitoAuthorizer is an abstract class representing an authorizer that can be used to authenticate and authorize a user through Cognito.

    -
    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -

    Hierarchy

    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    adminClaim: string
    -
    - -
    claims?: {
        [name: string]: string | number | boolean | string[];
    }
    -

    The claims of the authenticated user.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string | number | boolean | string[]
    -
    -
    - -
    groupClaim: string
    -
    - -
    issuerUrl: string
    -
    - -
    jwksUrl?: string
    -
    -

    Methods

    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or is not an admin.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Throws an UnauthenticatedError if the user is not authenticated.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or does not belong +

    Constructors

    Properties

    adminClaim: string
    claims?: {
        [name: string]: string | number | boolean | string[];
    }

    The claims of the authenticated user.

    +

    Type declaration

    • [name: string]: string | number | boolean | string[]
    groupClaim: string
    issuerUrl: string
    jwksUrl?: string

    Methods

    • Throws a ForbiddenError if the user is not authenticated or is not an admin.

      +

      Returns void

    • Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Authenticates the user and sets the claims.

      -
      -

      Returns Promise<void>

      -
    -
    - -
      - -
    • -

      Returns the value of the claim with the specified name, or undefined if the +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns void

    • Authenticates the user and sets the claims.

      +

      Returns Promise<void>

    • Returns the value of the claim with the specified name, or undefined if the claim does not exist.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The name of the claim to retrieve.

        -
      -

      Returns undefined | string | number | boolean | string[]

      -
    -
    - -
      - -
    • -

      Returns the email of the authenticated user.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns an array of groups the user belongs to, or an empty array if the user +

      Parameters

      • name: string

        The name of the claim to retrieve.

        +

      Returns undefined | string | number | boolean | string[]

    • Returns the email of the authenticated user.

      +

      Returns string

    • Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

      -
      -

      Returns string[]

      -
    -
    - -
      - -
    • -

      Returns the subject of the authenticated user.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the specified group, false otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the 'admin' group, false otherwise.

      -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user is authenticated, false otherwise.

      -
      -

      Returns boolean

      -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Returns string[]

    • Returns the subject of the authenticated user.

      +

      Returns string

    • Returns true if the user belongs to the specified group, false otherwise.

      +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns boolean

    • Returns true if the user belongs to the 'admin' group, false otherwise.

      +

      Returns boolean

    • Returns true if the user is authenticated, false otherwise.

      +

      Returns boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/auth.JwtAuthorizer.html b/docs/lambda/classes/auth.JwtAuthorizer.html index 74eb56e..d99d32d 100644 --- a/docs/lambda/classes/auth.JwtAuthorizer.html +++ b/docs/lambda/classes/auth.JwtAuthorizer.html @@ -1,55 +1,13 @@ -JwtAuthorizer | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class JwtAuthorizerAbstract

    -
    -

    A generic JWT authorizer base class, presupposing the presence of an issuer, a number of authorization claims, an +JwtAuthorizer | cdk-serverless

    Class JwtAuthorizerAbstract

    A generic JWT authorizer base class, presupposing the presence of an issuer, a number of authorization claims, an admin permission claim and optionally a separate URL to a JWKS to use if the issuers well-known URL does not point to it in its metadata.

    -
    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -

    Hierarchy

    -
    -

    Constructors

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        issuerUrl: string
      • -
      • -
        groupClaim: string
      • -
      • -
        adminClaim: string
      • -
      • -
        Optional jwksUrl: string
        Optional
      -

      Returns JwtAuthorizer

    -
    -

    Properties

    -
    - -
    adminClaim: string
    -
    - -
    claims?: {
        [name: string]: string | number | boolean | string[];
    }
    -

    The claims of the authenticated user.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string | number | boolean | string[]
    -
    -
    - -
    groupClaim: string
    -
    - -
    issuerUrl: string
    -
    - -
    jwksUrl?: string
    -
    -

    Methods

    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or is not an admin.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Throws an UnauthenticatedError if the user is not authenticated.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Throws a ForbiddenError if the user is not authenticated or does not belong +

    Constructors

    • Parameters

      • issuerUrl: string
      • groupClaim: string
      • adminClaim: string
      • Optional jwksUrl: string

      Returns JwtAuthorizer

    Properties

    adminClaim: string
    claims?: {
        [name: string]: string | number | boolean | string[];
    }

    The claims of the authenticated user.

    +

    Type declaration

    • [name: string]: string | number | boolean | string[]
    groupClaim: string
    issuerUrl: string
    jwksUrl?: string

    Methods

    • Throws a ForbiddenError if the user is not authenticated or is not an admin.

      +

      Returns void

    • Throws an UnauthenticatedError if the user is not authenticated.

      +

      Returns void

    • Throws a ForbiddenError if the user is not authenticated or does not belong to the specified group.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Authenticates the user and sets the claims.

      -
      -

      Returns Promise<void>

      -
    -
    - -
      - -
    • -

      Returns the value of the claim with the specified name, or undefined if the +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns void

    • Authenticates the user and sets the claims.

      +

      Returns Promise<void>

    • Returns the value of the claim with the specified name, or undefined if the claim does not exist.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The name of the claim to retrieve.

        -
      -

      Returns undefined | string | number | boolean | string[]

      -
    -
    - -
      - -
    • -

      Returns the email of the authenticated user.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns an array of groups the user belongs to, or an empty array if the user +

      Parameters

      • name: string

        The name of the claim to retrieve.

        +

      Returns undefined | string | number | boolean | string[]

    • Returns the email of the authenticated user.

      +

      Returns string

    • Returns an array of groups the user belongs to, or an empty array if the user is not authenticated or has no groups.

      -
      -

      Returns string[]

      -
    -
    - -
      - -
    • -

      Returns the subject of the authenticated user.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the specified group, false otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        group: string
        -

        The name of the group to check.

        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user belongs to the 'admin' group, false otherwise.

      -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns true if the user is authenticated, false otherwise.

      -
      -

      Returns boolean

      -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Returns string[]

    • Returns the subject of the authenticated user.

      +

      Returns string

    • Returns true if the user belongs to the specified group, false otherwise.

      +

      Parameters

      • group: string

        The name of the group to check.

        +

      Returns boolean

    • Returns true if the user belongs to the 'admin' group, false otherwise.

      +

      Returns boolean

    • Returns true if the user is authenticated, false otherwise.

      +

      Returns boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/errors.BadRequestError.html b/docs/lambda/classes/errors.BadRequestError.html index 4f3fb64..0e38b01 100644 --- a/docs/lambda/classes/errors.BadRequestError.html +++ b/docs/lambda/classes/errors.BadRequestError.html @@ -1,169 +1,12 @@ -BadRequestError | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class BadRequestError

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    message +BadRequestError | cdk-serverless

    Hierarchy

    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    message: string
    -
    - -
    name: string
    -
    - -
    stack?: string
    -
    - -
    statusCode: number
    -
    - -
    prepareStackTrace?: ((err, stackTraces) => any)
    -
    -

    Type declaration

    -
    -
    - -
    stackTraceLimit: number
    -
    -

    Methods

    -
    - -
      - -
    • -

      Create .stack property on a target object

      -
      -
      -

      Parameters

      -
        -
      • -
        targetObject: object
      • -
      • -
        Optional constructorOpt: Function
        Optional
      -

      Returns void

      -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    statusCode: number
    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/errors.ForbiddenError.html b/docs/lambda/classes/errors.ForbiddenError.html index 2de4ff2..21566ba 100644 --- a/docs/lambda/classes/errors.ForbiddenError.html +++ b/docs/lambda/classes/errors.ForbiddenError.html @@ -1,169 +1,12 @@ -ForbiddenError | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class ForbiddenError

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    message +ForbiddenError | cdk-serverless

    Hierarchy

    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    message: string
    -
    - -
    name: string
    -
    - -
    stack?: string
    -
    - -
    statusCode: number
    -
    - -
    prepareStackTrace?: ((err, stackTraces) => any)
    -
    -

    Type declaration

    -
    -
    - -
    stackTraceLimit: number
    -
    -

    Methods

    -
    - -
      - -
    • -

      Create .stack property on a target object

      -
      -
      -

      Parameters

      -
        -
      • -
        targetObject: object
      • -
      • -
        Optional constructorOpt: Function
        Optional
      -

      Returns void

      -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    statusCode: number
    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/errors.HttpError.html b/docs/lambda/classes/errors.HttpError.html index bb75f66..dc34592 100644 --- a/docs/lambda/classes/errors.HttpError.html +++ b/docs/lambda/classes/errors.HttpError.html @@ -1,175 +1,12 @@ -HttpError | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class HttpError

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    message +HttpError | cdk-serverless

    Hierarchy

    -
    -

    Constructors

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        statusCode: number
      • -
      • -
        Optional message: string
        Optional
      -

      Returns HttpError

    -
    -

    Properties

    -
    - -
    message: string
    -
    - -
    name: string
    -
    - -
    stack?: string
    -
    - -
    statusCode: number
    -
    - -
    prepareStackTrace?: ((err, stackTraces) => any)
    -
    -

    Type declaration

    -
    -
    - -
    stackTraceLimit: number
    -
    -

    Methods

    -
    - -
      - -
    • -

      Create .stack property on a target object

      -
      -
      -

      Parameters

      -
        -
      • -
        targetObject: object
      • -
      • -
        Optional constructorOpt: Function
        Optional
      -

      Returns void

      -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Methods

    Constructors

    • Parameters

      • statusCode: number
      • Optional message: string

      Returns HttpError

    Properties

    message: string
    name: string
    stack?: string
    statusCode: number
    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/errors.NotFoundError.html b/docs/lambda/classes/errors.NotFoundError.html index 6690406..204e398 100644 --- a/docs/lambda/classes/errors.NotFoundError.html +++ b/docs/lambda/classes/errors.NotFoundError.html @@ -1,169 +1,12 @@ -NotFoundError | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class NotFoundError

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    message +NotFoundError | cdk-serverless

    Hierarchy

    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    message: string
    -
    - -
    name: string
    -
    - -
    stack?: string
    -
    - -
    statusCode: number
    -
    - -
    prepareStackTrace?: ((err, stackTraces) => any)
    -
    -

    Type declaration

    -
    -
    - -
    stackTraceLimit: number
    -
    -

    Methods

    -
    - -
      - -
    • -

      Create .stack property on a target object

      -
      -
      -

      Parameters

      -
        -
      • -
        targetObject: object
      • -
      • -
        Optional constructorOpt: Function
        Optional
      -

      Returns void

      -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    statusCode: number
    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/classes/errors.UnauthenticatedError.html b/docs/lambda/classes/errors.UnauthenticatedError.html index bba7473..4835e33 100644 --- a/docs/lambda/classes/errors.UnauthenticatedError.html +++ b/docs/lambda/classes/errors.UnauthenticatedError.html @@ -1,169 +1,12 @@ -UnauthenticatedError | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class UnauthenticatedError

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    message +UnauthenticatedError | cdk-serverless

    Hierarchy

    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    message: string
    -
    - -
    name: string
    -
    - -
    stack?: string
    -
    - -
    statusCode: number
    -
    - -
    prepareStackTrace?: ((err, stackTraces) => any)
    -
    -

    Type declaration

    -
    -
    - -
    stackTraceLimit: number
    -
    -

    Methods

    -
    - -
      - -
    • -

      Create .stack property on a target object

      -
      -
      -

      Parameters

      -
        -
      • -
        targetObject: object
      • -
      • -
        Optional constructorOpt: Function
        Optional
      -

      Returns void

      -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Methods

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    statusCode: number
    prepareStackTrace?: ((err, stackTraces) => any)

    Type declaration

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/functions/api.createAppSyncHandler.html b/docs/lambda/functions/api.createAppSyncHandler.html index 5e4dbf6..cb79941 100644 --- a/docs/lambda/functions/api.createAppSyncHandler.html +++ b/docs/lambda/functions/api.createAppSyncHandler.html @@ -1,81 +1,4 @@ -createAppSyncHandler | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Function createAppSyncHandler

    -
    -

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/functions/api.createHttpHandler.html b/docs/lambda/functions/api.createHttpHandler.html index 7ab8bda..0a6e545 100644 --- a/docs/lambda/functions/api.createHttpHandler.html +++ b/docs/lambda/functions/api.createHttpHandler.html @@ -1,78 +1,2 @@ -createHttpHandler | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Function createHttpHandler

    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +createHttpHandler | cdk-serverless

    Function createHttpHandler

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/functions/api.createOpenApiHandler.html b/docs/lambda/functions/api.createOpenApiHandler.html index 2e11836..03501d2 100644 --- a/docs/lambda/functions/api.createOpenApiHandler.html +++ b/docs/lambda/functions/api.createOpenApiHandler.html @@ -1,78 +1,2 @@ -createOpenApiHandler | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Function createOpenApiHandler

    -
    -
      - -
    • -

      A factory function that creates an HTTP request handler for an OpenAPI operation.

      -
      -
      -

      Type Parameters

      -
        -
      • -

        OP extends Operation

      • -
      • -

        SC extends number = 200

      -
      -

      Parameters

      -
        -
      • -
        handler: HttpHandler<any, OP["responses"][SC]["content"]["application/json"]>
      -

      Returns APIGatewayv1Handler

      -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +createOpenApiHandler | cdk-serverless

    Function createOpenApiHandler

    • A factory function that creates an HTTP request handler for an OpenAPI operation.

      +

      Type Parameters

      Parameters

      • handler: HttpHandler<any, OP["responses"][SC]["content"]["application/json"]>

      Returns APIGatewayv1Handler

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html b/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html index 71fb14b..ccf7912 100644 --- a/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +++ b/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html @@ -1,78 +1,2 @@ -createOpenApiHandlerWithRequestBody | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Function createOpenApiHandlerWithRequestBody

    -
    -
      - -
    • -

      A factory function that creates an HTTP request handler for an OpenAPI operation with a request body.

      -
      -
      -

      Type Parameters

      -
      -
      -

      Parameters

      -
        -
      • -
        handler: HttpHandler<OP["requestBody"]["content"]["application/json"], OP["responses"][SC]["content"]["application/json"]>
      -

      Returns APIGatewayv1Handler

      -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +createOpenApiHandlerWithRequestBody | cdk-serverless

    Function createOpenApiHandlerWithRequestBody

    • A factory function that creates an HTTP request handler for an OpenAPI operation with a request body.

      +

      Type Parameters

      Parameters

      • handler: HttpHandler<OP["requestBody"]["content"]["application/json"], OP["responses"][SC]["content"]["application/json"]>

      Returns APIGatewayv1Handler

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html b/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html index 42bd5e1..3b15dab 100644 --- a/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +++ b/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html @@ -1,76 +1,2 @@ -createOpenApiHandlerWithRequestBodyNoResponse | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Function createOpenApiHandlerWithRequestBodyNoResponse

    -
    -
      - -
    • -

      A factory function that creates an HTTP request handler for an OpenAPI operation with a request body and no response.

      -
      -
      -

      Type Parameters

      -
      -
      -

      Parameters

      -
        -
      • -
        handler: HttpHandler<OP["requestBody"]["content"]["application/json"], void>
      -

      Returns APIGatewayv1Handler

      -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +createOpenApiHandlerWithRequestBodyNoResponse | cdk-serverless

    Function createOpenApiHandlerWithRequestBodyNoResponse

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/index.html b/docs/lambda/index.html index 8804236..73202a6 100644 --- a/docs/lambda/index.html +++ b/docs/lambda/index.html @@ -1,18 +1,4 @@ -cdk-serverless
    -
    - -
    -
    -
    -
    -

    cdk-serverless

    -

    CDK Serverless

    npm version

    +cdk-serverless

    cdk-serverless

    CDK Serverless

    npm version

    CDK Serverless is a tool suite to facilitate the use of the AWS Cloud Development Kit (CDK) in serverless architectures. It provides project management features to configure your TypeScript CDK app and also higher-level (L3) constructs for different APIs and resources needed for serverless applications. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.

    Features

    • Projen helper classes to configure certain use cases easily
    • @@ -56,51 +42,4 @@

      cdk-serverless

  • Just file a PR with your recommended changes
  • Authors

    Brought to you by Taimos

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/interfaces/api.AppSyncHandlerContext.html b/docs/lambda/interfaces/api.AppSyncHandlerContext.html index 55daa01..706114a 100644 --- a/docs/lambda/interfaces/api.AppSyncHandlerContext.html +++ b/docs/lambda/interfaces/api.AppSyncHandlerContext.html @@ -1,106 +1,7 @@ -AppSyncHandlerContext | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface AppSyncHandlerContext<T>

    -
    -

    The context for the AppSync resolver function. +AppSyncHandlerContext | cdk-serverless

    Interface AppSyncHandlerContext<T>

    The context for the AppSync resolver function. Contains information about the event, lambda context, logger, and Cognito authorizer.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Hierarchy

    -
      -
    • AppSyncHandlerContext
    -
    -
    -
    - -
    -
    -

    Properties

    -
    interface AppSyncHandlerContext {
        cognitoAuth: CognitoAuthorizer;
        event: AppSyncResolverEvent<T, null | Record<string, any>>;
        lambdaContext: Context;
        logger: LambdaLog;
    }

    Type Parameters

    • T

    -
    -

    Properties

    -
    - -
    cognitoAuth: CognitoAuthorizer
    -
    - -
    event: AppSyncResolverEvent<T, null | Record<string, any>>
    -
    - -
    lambdaContext: Context
    -
    - -
    logger: LambdaLog
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    cognitoAuth: CognitoAuthorizer
    event: AppSyncResolverEvent<T, null | Record<string, any>>
    lambdaContext: Context
    logger: LambdaLog

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/interfaces/api.HttpHandlerContext.html b/docs/lambda/interfaces/api.HttpHandlerContext.html index 8b38ecd..e3fc6e1 100644 --- a/docs/lambda/interfaces/api.HttpHandlerContext.html +++ b/docs/lambda/interfaces/api.HttpHandlerContext.html @@ -1,105 +1,7 @@ -HttpHandlerContext | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface HttpHandlerContext

    -
    -

    An object containing the properties for an HTTP request handler.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • HttpHandlerContext
    -
    -
    -
    - -
    -
    -

    Properties

    -
    auth +HttpHandlerContext | cdk-serverless

    Interface HttpHandlerContext

    An object containing the properties for an HTTP request handler.

    +
    interface HttpHandlerContext {
        auth: JwtAuthorizer;
        event: APIGatewayProxyWithCognitoAuthorizerEvent;
        lambdaContext: Context;
        logger: LambdaLog;
        response: HttpResponseContext;
    }
    -
    -

    Properties

    -
    - -
    -
    - -
    event: APIGatewayProxyWithCognitoAuthorizerEvent
    -
    - -
    lambdaContext: Context
    -
    - -
    logger: LambdaLog
    -
    - -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    event: APIGatewayProxyWithCognitoAuthorizerEvent
    lambdaContext: Context
    logger: LambdaLog

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/interfaces/api.HttpResponseContext.html b/docs/lambda/interfaces/api.HttpResponseContext.html index 8ffc0cf..b24a50b 100644 --- a/docs/lambda/interfaces/api.HttpResponseContext.html +++ b/docs/lambda/interfaces/api.HttpResponseContext.html @@ -1,100 +1,5 @@ -HttpResponseContext | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface HttpResponseContext

    -
    -

    An object containing the properties for an HTTP response.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • HttpResponseContext
    -
    -
    -
    - -
    -
    -

    Properties

    -
    headers +HttpResponseContext | cdk-serverless

    Interface HttpResponseContext

    An object containing the properties for an HTTP response.

    +
    interface HttpResponseContext {
        headers: {
            [name: string]: string;
        };
        json: boolean;
        statusCode?: number;
    }
    -
    -

    Properties

    -
    - -
    headers: {
        [name: string]: string;
    }
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string
    -
    - -
    json: boolean
    -
    - -
    statusCode?: number
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    headers: {
        [name: string]: string;
    }

    Type declaration

    • [name: string]: string
    json: boolean
    statusCode?: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/interfaces/api.Operation.html b/docs/lambda/interfaces/api.Operation.html index 55f373d..44f9961 100644 --- a/docs/lambda/interfaces/api.Operation.html +++ b/docs/lambda/interfaces/api.Operation.html @@ -1,92 +1,3 @@ -Operation | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface Operation

    -
    -

    An object containing the properties for an OpenAPI operation.

    -
    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    responses: {
        [statusCode: number]: {
            content: {
                application/json: any;
            };
        } | any;
    }
    -
    -

    Type declaration

    -
      -
    • -
      [statusCode: number]: {
          content: {
              application/json: any;
          };
      } | any
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Operation | cdk-serverless

    Interface Operation

    An object containing the properties for an OpenAPI operation.

    +
    interface Operation {
        responses: {
            [statusCode: number]: {
                content: {
                    application/json: any;
                };
            } | any;
        };
    }

    Hierarchy

    Properties

    Properties

    responses: {
        [statusCode: number]: {
            content: {
                application/json: any;
            };
        } | any;
    }

    Type declaration

    • [statusCode: number]: {
          content: {
              application/json: any;
          };
      } | any

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/interfaces/api.OperationWithRequestBody.html b/docs/lambda/interfaces/api.OperationWithRequestBody.html index 31ba086..2e27bd7 100644 --- a/docs/lambda/interfaces/api.OperationWithRequestBody.html +++ b/docs/lambda/interfaces/api.OperationWithRequestBody.html @@ -1,106 +1,4 @@ -OperationWithRequestBody | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface OperationWithRequestBody

    -
    -

    An object containing the properties for an OpenAPI operation with a request body.

    -
    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    requestBody +OperationWithRequestBody | cdk-serverless

    Interface OperationWithRequestBody

    An object containing the properties for an OpenAPI operation with a request body.

    +
    interface OperationWithRequestBody {
        requestBody: {
            content: {
                application/json: any;
            };
        };
        responses: {
            [statusCode: number]: {
                content: {
                    application/json: any;
                };
            } | any;
        };
    }

    Hierarchy

    -
    -

    Properties

    -
    - -
    requestBody: {
        content: {
            application/json: any;
        };
    }
    -
    -

    Type declaration

    -
      -
    • -
      content: {
          application/json: any;
      }
      -
        -
      • -
        application/json: any
    -
    - -
    responses: {
        [statusCode: number]: {
            content: {
                application/json: any;
            };
        } | any;
    }
    -
    -

    Type declaration

    -
      -
    • -
      [statusCode: number]: {
          content: {
              application/json: any;
          };
      } | any
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    requestBody: {
        content: {
            application/json: any;
        };
    }

    Type declaration

    • content: {
          application/json: any;
      }
      • application/json: any
    responses: {
        [statusCode: number]: {
            content: {
                application/json: any;
            };
        } | any;
    }

    Type declaration

    • [statusCode: number]: {
          content: {
              application/json: any;
          };
      } | any

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/modules.html b/docs/lambda/modules.html index 2106658..5cd02b2 100644 --- a/docs/lambda/modules.html +++ b/docs/lambda/modules.html @@ -1,47 +1,4 @@ -cdk-serverless
    -
    - -
    -
    -
    -
    -

    cdk-serverless

    -
    -
    -

    Index

    -
    -

    Namespaces

    -
    api +cdk-serverless

    cdk-serverless

    Index

    Namespaces

    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/modules/api.html b/docs/lambda/modules/api.html index 64acd9c..5a5578a 100644 --- a/docs/lambda/modules/api.html +++ b/docs/lambda/modules/api.html @@ -1,82 +1,14 @@ -api | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Namespace api

    -
    -
    -

    Index

    -
    -

    Interfaces

    -
    AppSyncHandlerContext +api | cdk-serverless
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/modules/auth.html b/docs/lambda/modules/auth.html index f61b9d3..40b7c0b 100644 --- a/docs/lambda/modules/auth.html +++ b/docs/lambda/modules/auth.html @@ -1,64 +1,8 @@ -auth | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Namespace auth

    -
    -
    -

    Index

    -
    -

    Classes

    -
    ApiGatewayv1CognitoAuthorizer +auth | cdk-serverless
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/modules/errors.html b/docs/lambda/modules/errors.html index 3bac60b..7007b4a 100644 --- a/docs/lambda/modules/errors.html +++ b/docs/lambda/modules/errors.html @@ -1,60 +1,6 @@ -errors | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Namespace errors

    -
    -
    -

    Index

    -
    -

    Classes

    -
    BadRequestError +errors | cdk-serverless
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/types/api.APIGatewayv1Handler.html b/docs/lambda/types/api.APIGatewayv1Handler.html index c400c48..f0456df 100644 --- a/docs/lambda/types/api.APIGatewayv1Handler.html +++ b/docs/lambda/types/api.APIGatewayv1Handler.html @@ -1,62 +1,2 @@ -APIGatewayv1Handler | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Type alias APIGatewayv1Handler

    -
    APIGatewayv1Handler: AWSLambda.Handler<AWSLambda.APIGatewayProxyWithCognitoAuthorizerEvent, AWSLambda.APIGatewayProxyResult | undefined>
    -

    A type definition for an API Gateway v1 request handler.

    -
    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +APIGatewayv1Handler | cdk-serverless

    Type alias APIGatewayv1Handler

    APIGatewayv1Handler: AWSLambda.Handler<AWSLambda.APIGatewayProxyWithCognitoAuthorizerEvent, AWSLambda.APIGatewayProxyResult | undefined>

    A type definition for an API Gateway v1 request handler.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/types/api.AppSyncHandler.html b/docs/lambda/types/api.AppSyncHandler.html index 8f19602..3a2d25b 100644 --- a/docs/lambda/types/api.AppSyncHandler.html +++ b/docs/lambda/types/api.AppSyncHandler.html @@ -1,83 +1,3 @@ -AppSyncHandler | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Type alias AppSyncHandler<T, R>

    -
    AppSyncHandler<T, R>: ((context) => Promise<R>)
    -
    -

    Type Parameters

    -
      -
    • -

      T

    • -
    • -

      R

    -
    -

    Type declaration

    -

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/lambda/types/api.HttpHandler.html b/docs/lambda/types/api.HttpHandler.html index 2b93189..eead29f 100644 --- a/docs/lambda/types/api.HttpHandler.html +++ b/docs/lambda/types/api.HttpHandler.html @@ -1,84 +1,2 @@ -HttpHandler | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Type alias HttpHandler<T, R>

    -
    HttpHandler<T, R>: ((context, body) => Promise<R>)
    -
    -

    Type Parameters

    -
      -
    • -

      T

    • -
    • -

      R

    -
    -

    Type declaration

    -
      -
    • -
        -
      • (context, body): Promise<R>
      • -
      • -

        A type definition for an HTTP handler.

        -
        -
        -

        Parameters

        -
        -

        Returns Promise<R>

        -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +HttpHandler | cdk-serverless

    Type alias HttpHandler<T, R>

    HttpHandler<T, R>: ((context, body) => Promise<R>)

    Type Parameters

    • T

    • R

    Type declaration

      • (context, body): Promise<R>
      • A type definition for an HTTP handler.

        +

        Parameters

        Returns Promise<R>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/assets/main.js b/docs/projen/assets/main.js index 3cee05e..d0aa8d5 100644 --- a/docs/projen/assets/main.js +++ b/docs/projen/assets/main.js @@ -1,7 +1,8 @@ "use strict"; -"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((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(),this.listenForCodeCopies(),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&&(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)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(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+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(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 _e(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 Re(t,e,r,n){if(_e(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 Fe(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 M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!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&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="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(M,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}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="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(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,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){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){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 te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{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()),ve.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 Z=class extends C{constructor(n){super(n);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 r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/projen/assets/navigation.js b/docs/projen/assets/navigation.js new file mode 100644 index 0000000..a7189eb --- /dev/null +++ b/docs/projen/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA33QwQ/BMBQG8P+l58ViQsStQRwEw8FBRGqerFZr074gEf+7HWYz5V33fe/X5ds+GMId2YCNBAqH2gILmBGYFp8SJZwDF1ZRK8WLKvJM5kc2aEf9Z1DdT6ww6VJxI32gzihhBQ5/npcBdbsGewWrwLnY6jMk6CtehfI22mYnpW8+806o62qwhUGpc1crMkewJ5F8rlqWmmDU7f0clxK9FkWWo1Jes0Jh3rYU+69MPfBenXK/OhQX8+GUT8b7OZ+Na+sqrBSH4sfCz7zpdKLn7gWWpN1PNQMAAA==" \ No newline at end of file diff --git a/docs/projen/assets/search.js b/docs/projen/assets/search.js index efaf37b..8ab78a3 100644 --- a/docs/projen/assets/search.js +++ b/docs/projen/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":32,\"name\":\"PACKAGE_NAME\",\"url\":\"variables/PACKAGE_NAME.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"ServerlessProjectOptions\",\"url\":\"interfaces/ServerlessProjectOptions.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"ServerlessProject\",\"url\":\"classes/ServerlessProject.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/ServerlessProject.html#constructor\",\"classes\":\"\",\"parent\":\"ServerlessProject\"},{\"kind\":256,\"name\":\"RestApiOptions\",\"url\":\"interfaces/RestApiOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"apiName\",\"url\":\"interfaces/RestApiOptions.html#apiName\",\"classes\":\"\",\"parent\":\"RestApiOptions\"},{\"kind\":1024,\"name\":\"definitionFile\",\"url\":\"interfaces/RestApiOptions.html#definitionFile\",\"classes\":\"\",\"parent\":\"RestApiOptions\"},{\"kind\":128,\"name\":\"RestApi\",\"url\":\"classes/RestApi.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/RestApi.html#constructor\",\"classes\":\"\",\"parent\":\"RestApi\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"classes/RestApi.html#options\",\"classes\":\"tsd-is-protected\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"createConstructFile\",\"url\":\"classes/RestApi.html#createConstructFile\",\"classes\":\"tsd-is-protected\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"validatePathRef\",\"url\":\"classes/RestApi.html#validatePathRef\",\"classes\":\"tsd-is-protected\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"addRestResource\",\"url\":\"classes/RestApi.html#addRestResource\",\"classes\":\"tsd-is-protected\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"createEntryFile\",\"url\":\"classes/RestApi.html#createEntryFile\",\"classes\":\"tsd-is-protected\",\"parent\":\"RestApi\"},{\"kind\":2048,\"name\":\"synthesize\",\"url\":\"classes/RestApi.html#synthesize\",\"classes\":\"\",\"parent\":\"RestApi\"},{\"kind\":256,\"name\":\"DatastoreOptions\",\"url\":\"interfaces/DatastoreOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"modelName\",\"url\":\"interfaces/DatastoreOptions.html#modelName\",\"classes\":\"\",\"parent\":\"DatastoreOptions\"},{\"kind\":1024,\"name\":\"definitionFile\",\"url\":\"interfaces/DatastoreOptions.html#definitionFile\",\"classes\":\"\",\"parent\":\"DatastoreOptions\"},{\"kind\":128,\"name\":\"Datastore\",\"url\":\"classes/Datastore.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Datastore.html#constructor\",\"classes\":\"\",\"parent\":\"Datastore\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"classes/Datastore.html#options\",\"classes\":\"tsd-is-protected\",\"parent\":\"Datastore\"},{\"kind\":2048,\"name\":\"createModelFile\",\"url\":\"classes/Datastore.html#createModelFile\",\"classes\":\"tsd-is-protected\",\"parent\":\"Datastore\"},{\"kind\":2048,\"name\":\"stringifyModel\",\"url\":\"classes/Datastore.html#stringifyModel\",\"classes\":\"tsd-is-private\",\"parent\":\"Datastore\"},{\"kind\":2048,\"name\":\"createConstructFile\",\"url\":\"classes/Datastore.html#createConstructFile\",\"classes\":\"tsd-is-protected\",\"parent\":\"Datastore\"},{\"kind\":2048,\"name\":\"synthesize\",\"url\":\"classes/Datastore.html#synthesize\",\"classes\":\"\",\"parent\":\"Datastore\"},{\"kind\":256,\"name\":\"WorkflowOptions\",\"url\":\"interfaces/WorkflowOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"workflowName\",\"url\":\"interfaces/WorkflowOptions.html#workflowName\",\"classes\":\"\",\"parent\":\"WorkflowOptions\"},{\"kind\":1024,\"name\":\"definitionFile\",\"url\":\"interfaces/WorkflowOptions.html#definitionFile\",\"classes\":\"\",\"parent\":\"WorkflowOptions\"},{\"kind\":128,\"name\":\"Workflow\",\"url\":\"classes/Workflow.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Workflow.html#constructor\",\"classes\":\"\",\"parent\":\"Workflow\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"classes/Workflow.html#options\",\"classes\":\"tsd-is-protected\",\"parent\":\"Workflow\"},{\"kind\":2048,\"name\":\"createConstructFile\",\"url\":\"classes/Workflow.html#createConstructFile\",\"classes\":\"tsd-is-protected\",\"parent\":\"Workflow\"},{\"kind\":2048,\"name\":\"renderStateConfigDefinition\",\"url\":\"classes/Workflow.html#renderStateConfigDefinition\",\"classes\":\"tsd-is-protected\",\"parent\":\"Workflow\"},{\"kind\":2048,\"name\":\"renderDefinitionSubstitution\",\"url\":\"classes/Workflow.html#renderDefinitionSubstitution\",\"classes\":\"tsd-is-protected\",\"parent\":\"Workflow\"},{\"kind\":2048,\"name\":\"synthesize\",\"url\":\"classes/Workflow.html#synthesize\",\"classes\":\"\",\"parent\":\"Workflow\"},{\"kind\":256,\"name\":\"GraphQlApiOptions\",\"url\":\"interfaces/GraphQlApiOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"apiName\",\"url\":\"interfaces/GraphQlApiOptions.html#apiName\",\"classes\":\"\",\"parent\":\"GraphQlApiOptions\"},{\"kind\":1024,\"name\":\"definitionFile\",\"url\":\"interfaces/GraphQlApiOptions.html#definitionFile\",\"classes\":\"\",\"parent\":\"GraphQlApiOptions\"},{\"kind\":128,\"name\":\"GraphQlApi\",\"url\":\"classes/GraphQlApi.html\",\"classes\":\"\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/GraphQlApi.html#constructor\",\"classes\":\"\",\"parent\":\"GraphQlApi\"},{\"kind\":1024,\"name\":\"codegenConfigFileName\",\"url\":\"classes/GraphQlApi.html#codegenConfigFileName\",\"classes\":\"tsd-is-protected\",\"parent\":\"GraphQlApi\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"classes/GraphQlApi.html#options\",\"classes\":\"tsd-is-protected\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"createConstructFile\",\"url\":\"classes/GraphQlApi.html#createConstructFile\",\"classes\":\"tsd-is-protected\",\"parent\":\"GraphQlApi\"},{\"kind\":2048,\"name\":\"synthesize\",\"url\":\"classes/GraphQlApi.html#synthesize\",\"classes\":\"\",\"parent\":\"GraphQlApi\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,34.012]],[\"comment/0\",[]],[\"name/1\",[1,34.012]],[\"comment/1\",[]],[\"name/2\",[2,34.012]],[\"comment/2\",[]],[\"name/3\",[3,21.019]],[\"comment/3\",[]],[\"name/4\",[4,34.012]],[\"comment/4\",[]],[\"name/5\",[5,28.904]],[\"comment/5\",[]],[\"name/6\",[6,23.026]],[\"comment/6\",[]],[\"name/7\",[7,34.012]],[\"comment/7\",[]],[\"name/8\",[3,21.019]],[\"comment/8\",[]],[\"name/9\",[8,23.026]],[\"comment/9\",[]],[\"name/10\",[9,23.026]],[\"comment/10\",[]],[\"name/11\",[10,34.012]],[\"comment/11\",[]],[\"name/12\",[11,34.012]],[\"comment/12\",[]],[\"name/13\",[12,34.012]],[\"comment/13\",[]],[\"name/14\",[13,23.026]],[\"comment/14\",[]],[\"name/15\",[14,34.012]],[\"comment/15\",[]],[\"name/16\",[15,34.012]],[\"comment/16\",[]],[\"name/17\",[6,23.026]],[\"comment/17\",[]],[\"name/18\",[16,34.012]],[\"comment/18\",[]],[\"name/19\",[3,21.019]],[\"comment/19\",[]],[\"name/20\",[8,23.026]],[\"comment/20\",[]],[\"name/21\",[17,34.012]],[\"comment/21\",[]],[\"name/22\",[18,34.012]],[\"comment/22\",[]],[\"name/23\",[9,23.026]],[\"comment/23\",[]],[\"name/24\",[13,23.026]],[\"comment/24\",[]],[\"name/25\",[19,34.012]],[\"comment/25\",[]],[\"name/26\",[20,34.012]],[\"comment/26\",[]],[\"name/27\",[6,23.026]],[\"comment/27\",[]],[\"name/28\",[21,34.012]],[\"comment/28\",[]],[\"name/29\",[3,21.019]],[\"comment/29\",[]],[\"name/30\",[8,23.026]],[\"comment/30\",[]],[\"name/31\",[9,23.026]],[\"comment/31\",[]],[\"name/32\",[22,34.012]],[\"comment/32\",[]],[\"name/33\",[23,34.012]],[\"comment/33\",[]],[\"name/34\",[13,23.026]],[\"comment/34\",[]],[\"name/35\",[24,34.012]],[\"comment/35\",[]],[\"name/36\",[5,28.904]],[\"comment/36\",[]],[\"name/37\",[6,23.026]],[\"comment/37\",[]],[\"name/38\",[25,34.012]],[\"comment/38\",[]],[\"name/39\",[3,21.019]],[\"comment/39\",[]],[\"name/40\",[26,34.012]],[\"comment/40\",[]],[\"name/41\",[8,23.026]],[\"comment/41\",[]],[\"name/42\",[9,23.026]],[\"comment/42\",[]],[\"name/43\",[13,23.026]],[\"comment/43\",[]]],\"invertedIndex\":[[\"addrestresource\",{\"_index\":11,\"name\":{\"12\":{}},\"comment\":{}}],[\"apiname\",{\"_index\":5,\"name\":{\"5\":{},\"36\":{}},\"comment\":{}}],[\"codegenconfigfilename\",{\"_index\":26,\"name\":{\"40\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":3,\"name\":{\"3\":{},\"8\":{},\"19\":{},\"29\":{},\"39\":{}},\"comment\":{}}],[\"createconstructfile\",{\"_index\":9,\"name\":{\"10\":{},\"23\":{},\"31\":{},\"42\":{}},\"comment\":{}}],[\"createentryfile\",{\"_index\":12,\"name\":{\"13\":{}},\"comment\":{}}],[\"createmodelfile\",{\"_index\":17,\"name\":{\"21\":{}},\"comment\":{}}],[\"datastore\",{\"_index\":16,\"name\":{\"18\":{}},\"comment\":{}}],[\"datastoreoptions\",{\"_index\":14,\"name\":{\"15\":{}},\"comment\":{}}],[\"definitionfile\",{\"_index\":6,\"name\":{\"6\":{},\"17\":{},\"27\":{},\"37\":{}},\"comment\":{}}],[\"graphqlapi\",{\"_index\":25,\"name\":{\"38\":{}},\"comment\":{}}],[\"graphqlapioptions\",{\"_index\":24,\"name\":{\"35\":{}},\"comment\":{}}],[\"modelname\",{\"_index\":15,\"name\":{\"16\":{}},\"comment\":{}}],[\"options\",{\"_index\":8,\"name\":{\"9\":{},\"20\":{},\"30\":{},\"41\":{}},\"comment\":{}}],[\"package_name\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"renderdefinitionsubstitution\",{\"_index\":23,\"name\":{\"33\":{}},\"comment\":{}}],[\"renderstateconfigdefinition\",{\"_index\":22,\"name\":{\"32\":{}},\"comment\":{}}],[\"restapi\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"restapioptions\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"serverlessproject\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"serverlessprojectoptions\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"stringifymodel\",{\"_index\":18,\"name\":{\"22\":{}},\"comment\":{}}],[\"synthesize\",{\"_index\":13,\"name\":{\"14\":{},\"24\":{},\"34\":{},\"43\":{}},\"comment\":{}}],[\"validatepathref\",{\"_index\":10,\"name\":{\"11\":{}},\"comment\":{}}],[\"workflow\",{\"_index\":21,\"name\":{\"28\":{}},\"comment\":{}}],[\"workflowname\",{\"_index\":20,\"name\":{\"26\":{}},\"comment\":{}}],[\"workflowoptions\",{\"_index\":19,\"name\":{\"25\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA61Z227bRhD9F/qVUbS71PXNSNygKJK6MdA+GIbBiCubNXUpSdt1Bf17d3mdIWcoyuFDwNA8c9k5M2eX1MGJd6+Js7w9OE/hNnCWSrrO1t9oZ+lcX3767fLL1f23y69Xjus8x5H544sfh/6PSCcf4ePRY7qJDGYV+UmijT/HObqlSzmZVj5vdPyiY2OeXMe7v/Uq/X2fhrttUvkPt6mO1/7KBOCwncGEnPPBqiiFaTtEp++JqIuzMomk8fMq3cU9vV5gExDBdfZ+rLcpmTJdx+86SS/3YUf1MKK7ZmPpVZ79ffjN/q+fy4saTi+okSgTNNDrcBtayC9h1Dt2y+rcFECvFKAWl8XfB+kL6KtXN5RJMVXbNdgn49SgOkaaBB/C5MM+3qWmxXTQHVOOvbpOq1j7qf5UJo/ootdJGgySy4sfhYFxfu2nj9/1ujuPNniQHPwgsAjzb/ccr07Uog0ekJOrbRq/9eUDggfJIXnbpo86Cf87ER7h+nY9VL7PfuonZmh0h/Y1Mf3Vb7MLdMTpH+n2AprQC2ql/G4VpDPoqYNdaQAlrGAtIqsng6gh9tZLD+vUzlTERqxzNZGKS0zgV9sJ5AQ219qCD5SHqWC4fQjXb5nvU2m00EQW4YvJ9B216N4hyHq8b484XRNemZr1OK1NZDSgTn/t4qd1tHvtEKcGpL82vRaGnDxRji8aRvSqmlm/W5/IFHrKU0cSQJ1KVIvL8sEg2oSc9ZKmKq8zlQlHOleYiKhnz2JjrT8xiqeyMbBAxzdpHmAdPnyuOuNEVt2WQ2ZXO755/pGkYfrcOz3WdJj8OnQMZ9NDxqhYQMW+xP7+8Y+o+wWzBRrkHZP2evI1s53xuzWMyaCninUmAnSsxrXYrB8NomUNd73UDGTH1HFljgwPeptPo60IIpSPTVv1m5DTWXEq28zjXJ0lI5+ttK1q/ITWns6oQy+aifRQDBjvzjXzEuh/neXBedFxYlVu6ciRGi2MyTrUUWA/KeaJGIe7zcY6uSue/alt71lEDvk4dtzbsau80VjIuzv3trTIHmR/yGDC3AkKJhBMmjtJwSSCKXOnXCkMbIFgCsE8c+dR3jwEm5i7iSvno8XYQ7AJgk3N3dSVajSWUwSbItjM3M2ooDMEm3NLmCOYIeV2TgVd4PLaai8onGjwkBFBEiYwFcKWXNCcYTaErbogaROYEGELLxSZJ+ZE2NoLkjyBaRG2/GJCIjEzYsYxKDA3wnIgpqRLTI9YcDQKTJAcc0RKTJDMCCIbSDZmJSNoTiIxQVJx3SExP5LnR2J+ZMbPggyO+ZGWBEl2nMT8SJYfifmRlgRJtqbE/EiWH4n5USw/CvOjBFdLhelRmZaRU6EaamZJkIpEYn4Uz4/C/ChLgiTnR2F+1JSTP4XpUSw9CtOjMnrIiVSYHsXSozA9niVBkhPpYX48wRHpYX48yRHpYXo8xRbdy+nJ9lSzmZpt/td8bzW7ox8EsTaHg+p78cG5L3Zeo6rFRn9wjJYuD8djvdPaOxvDnJrzPbi2m9RmE4tzHUMRbV0c1lbZYW1tDidNX3JaOzMl5LyA42Ztq2pTlecxzy9G9LKrLK5qwTnOTk+V+3V2eqoDLEB9xoXLIpKZsuzqcXXLXWv7jbzptj50G7+q0z77MNyyn9X2UjD2Qf0JFliCaov5KcvqhAsceMDBhHNQveY0MwfhpwVVs6KuxVXNGKcP9vD4T+Tblx3QPqAXFbeg2pRYkQQrUtyKMhqarStAbMENABFxXpuVfVo0lyquHkfq3l89+Q/6vpnKuHbJzVD+faGmJkHfF0A94FRxzZk7S9J8eMxoB+BbCvAFGl1xg2LVqcEq6G+uHQororyAT48xTqpfyPflj/ogaTBcfe2pSQHNwbkpv51v8m/nwBj0iGSzAG9cwBTwJ7yiv4qrKq4ex2v5A+feTx9j+wMn8At6THAreq2+rIJ6gkpIbkRLw9b2AKJKbsZKY4oFIOGSnG6zae7DvY7CrQHd3h2P/wMgD9b8zyIAAA=="; \ No newline at end of file diff --git a/docs/projen/assets/style.css b/docs/projen/assets/style.css index 258146f..07a385b 100644 --- a/docs/projen/assets/style.css +++ b/docs/projen/assets/style.css @@ -11,6 +11,7 @@ --light-color-text-aside: #6e6e6e; --light-color-link: #1f70c2; + --light-color-ts-keyword: #056bd6; --light-color-ts-project: #b111c9; --light-color-ts-module: var(--light-color-ts-project); --light-color-ts-namespace: var(--light-color-ts-project); @@ -50,6 +51,7 @@ --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; + --dark-color-ts-keyword: #3399ff; --dark-color-ts-project: #e358ff; --dark-color-ts-module: var(--dark-color-ts-project); --dark-color-ts-namespace: var(--dark-color-ts-project); @@ -91,6 +93,7 @@ --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -132,6 +135,7 @@ --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -180,6 +184,7 @@ body { --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -219,6 +224,7 @@ body { --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -910,8 +916,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -924,7 +931,10 @@ a.tsd-index-link { background-color: var(--color-accent); } #tsd-search .results a { - display: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -980,6 +990,11 @@ a.tsd-index-link { overflow-x: auto; } +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + .tsd-signature-symbol { color: var(--color-text-aside); font-weight: normal; @@ -1134,7 +1149,7 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; } .warning { diff --git a/docs/projen/classes/Datastore.html b/docs/projen/classes/Datastore.html index 3583964..3376096 100644 --- a/docs/projen/classes/Datastore.html +++ b/docs/projen/classes/Datastore.html @@ -1,44 +1,8 @@ -Datastore | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class Datastore

    -
    -

    Hierarchy

    -
      -
    • Component -
        -
      • Datastore
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    node +Datastore | cdk-serverless

    Hierarchy

    • Component
      • Datastore
    -
    -

    Constructors

    -
    - -
      - -
    • -
      -

      Parameters

      -
      -

      Returns Datastore

    -
    -

    Properties

    -
    - -
    node: Node
    -

    The tree node.

    -
    -
    -
    - -
    -
    - -
    project: Project
    -
    -

    Methods

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fileName: string
      • -
      • -
        model: OneSchema
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fileName: string
      • -
      • -
        model: OneSchema
      -

      Returns void

    -
    - -
      - -
    • -

      Called after synthesis. Order is not guaranteed.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Called before synthesis.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        model: OneSchema
      -

      Returns string

    -
    - -
      - -
    • -

      Returns void

    -
    - -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Test whether the given construct is a component.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Component

      -
    -
    - -
      - -
    • -

      Checks if x is a construct.

      +

    Constructors

    Properties

    node: Node

    The tree node.

    +
    project: Project

    Methods

    • Parameters

      • fileName: string
      • model: OneSchema

      Returns void

    • Parameters

      • fileName: string
      • model: OneSchema

      Returns void

    • Called after synthesis. Order is not guaranteed.

      +

      Returns void

    • Called before synthesis.

      +

      Returns void

    • Parameters

      • model: OneSchema

      Returns string

    • Returns void

    • Returns a string representation of this construct.

      +

      Returns string

    • Test whether the given construct is a component.

      +

      Parameters

      • x: any

      Returns x is Component

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -189,64 +29,6 @@

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
      -

      Returns x is Construct

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

      - -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

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

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/classes/GraphQlApi.html b/docs/projen/classes/GraphQlApi.html index e27d7b4..fca0b26 100644 --- a/docs/projen/classes/GraphQlApi.html +++ b/docs/projen/classes/GraphQlApi.html @@ -1,158 +1,21 @@ -GraphQlApi | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class GraphQlApi

    -
    -

    Hierarchy

    -
      -
    • Component -
        -
      • GraphQlApi
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    codegenConfigFileName +GraphQlApi | cdk-serverless

    Class GraphQlApi

    Hierarchy

    • Component
      • GraphQlApi
    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    codegenConfigFileName: string
    -
    - -
    node: Node
    -

    The tree node.

    -
    -
    -
    - -
    -
    - -
    project: Project
    -
    -

    Methods

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fileName: string
      -

      Returns void

    -
    - -
      - -
    • -

      Called after synthesis. Order is not guaranteed.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Called before synthesis.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Returns void

    -
    - -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Test whether the given construct is a component.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Component

      -
    -
    - -
      - -
    • -

      Checks if x is a construct.

      +

    Constructors

    Properties

    codegenConfigFileName: string
    node: Node

    The tree node.

    +
    project: Project

    Methods

    • Parameters

      • fileName: string

      Returns void

    • Called after synthesis. Order is not guaranteed.

      +

      Returns void

    • Called before synthesis.

      +

      Returns void

    • Returns void

    • Returns a string representation of this construct.

      +

      Returns string

    • Test whether the given construct is a component.

      +

      Parameters

      • x: any

      Returns x is Component

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -165,63 +28,6 @@

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
      -

      Returns x is Construct

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

      - -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

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

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/classes/RestApi.html b/docs/projen/classes/RestApi.html index 5a64272..bac3082 100644 --- a/docs/projen/classes/RestApi.html +++ b/docs/projen/classes/RestApi.html @@ -1,44 +1,8 @@ -RestApi | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class RestApi

    -
    -

    Hierarchy

    -
      -
    • Component -
        -
      • RestApi
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    node +RestApi | cdk-serverless

    Hierarchy

    • Component
      • RestApi
    -
    -

    Constructors

    -
    - -
      - -
    • -
      -

      Parameters

      -
      -

      Returns RestApi

    -
    -

    Properties

    -
    - -
    node: Node
    -

    The tree node.

    -
    -
    -
    - -
    -
    - -
    project: Project
    -
    -

    Methods

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        apiSpec: OpenAPI3
      • -
      • -
        path: string
      • -
      • -
        method: string
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fileName: string
      -

      Returns void

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        entryFile: string
      • -
      • -
        method: string
      • -
      • -
        operationId: string
      -

      Returns void

    -
    - -
      - -
    • -

      Called after synthesis. Order is not guaranteed.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Called before synthesis.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Returns void

    -
    - -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        apiSpec: OpenAPI3
      • -
      • -
        path: string
      • -
      • -
        visited: string[] = []
      -

      Returns boolean

    -
    - -
      - -
    • -

      Test whether the given construct is a component.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Component

      -
    -
    - -
      - -
    • -

      Checks if x is a construct.

      +

    Constructors

    • Parameters

      Returns RestApi

    Properties

    node: Node

    The tree node.

    +
    project: Project

    Methods

    • Parameters

      • apiSpec: OpenAPI3
      • path: string
      • method: string

      Returns void

    • Parameters

      • fileName: string

      Returns void

    • Parameters

      • entryFile: string
      • method: string
      • operationId: string

      Returns void

    • Called after synthesis. Order is not guaranteed.

      +

      Returns void

    • Called before synthesis.

      +

      Returns void

    • Returns void

    • Returns a string representation of this construct.

      +

      Returns string

    • Parameters

      • apiSpec: OpenAPI3
      • path: string
      • visited: string[] = []

      Returns boolean

    • Test whether the given construct is a component.

      +

      Parameters

      • x: any

      Returns x is Component

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -209,65 +30,6 @@

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
      -

      Returns x is Construct

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

      - -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

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

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/classes/ServerlessProject.html b/docs/projen/classes/ServerlessProject.html index d354092..f69ca8e 100644 --- a/docs/projen/classes/ServerlessProject.html +++ b/docs/projen/classes/ServerlessProject.html @@ -1,38 +1,5 @@ -ServerlessProject | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class ServerlessProject

    -
    -

    Hierarchy

    -
      -
    • AwsCdkTypeScriptApp -
        -
      • ServerlessProject
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    appEntrypoint +ServerlessProject | cdk-serverless

    Class ServerlessProject

    Hierarchy

    • AwsCdkTypeScriptApp
      • ServerlessProject
    -
    -

    Constructors

    -
    - -
    -
    -

    Properties

    -
    - -
    appEntrypoint: string
    -

    The CDK app entrypoint

    -
    -
    -
    - -
    artifactsDirectory: string
    -

    The build output directory. An npm tarball will be created under the js +

    Constructors

    Properties

    appEntrypoint: string

    The CDK app entrypoint

    +
    artifactsDirectory: string

    The build output directory. An npm tarball will be created under the js subdirectory. For example, if this is set to dist (the default), the npm tarball will be placed under dist/js/boom-boom-1.2.3.tg.

    -
    -
    -
    - -
    artifactsJavascriptDirectory: string
    -

    The location of the npm tarball after build (${artifactsDirectory}/js).

    -
    -
    -
    - -
    autoApprove?: AutoApprove
    -

    Auto approve set up for this project.

    -
    -
    -
    - -
    autoMerge?: AutoMerge
    -

    Component that sets up mergify for merging approved pull requests.

    -
    -
    -
    - -
    buildWorkflow?: BuildWorkflow
    -

    The PR build GitHub workflow. undefined if buildWorkflow is disabled.

    -
    -
    -
    - -
    bundler: Bundler
    -
    - -
    cdkConfig: CdkConfig
    -

    cdk.json configuration.

    -
    -
    -
    - -
    cdkDeps: AwsCdkDeps
    -
    - -
    cdkTasks: CdkTasks
    -

    Common CDK tasks.

    -
    -
    -
    - -
    commitGenerated: boolean
    -

    Whether to commit the managed files by default.

    -
    -
    -
    - -
    defaultTask?: Task
    -

    This is the "default" task, the one that executes "projen". Undefined if +

    artifactsJavascriptDirectory: string

    The location of the npm tarball after build (${artifactsDirectory}/js).

    +
    autoApprove?: AutoApprove

    Auto approve set up for this project.

    +
    autoMerge?: AutoMerge

    Component that sets up mergify for merging approved pull requests.

    +
    buildWorkflow?: BuildWorkflow

    The PR build GitHub workflow. undefined if buildWorkflow is disabled.

    +
    bundler: Bundler
    cdkConfig: CdkConfig

    cdk.json configuration.

    +
    cdkDeps: AwsCdkDeps
    cdkTasks: CdkTasks

    Common CDK tasks.

    +
    commitGenerated: boolean

    Whether to commit the managed files by default.

    +
    defaultTask?: Task

    This is the "default" task, the one that executes "projen". Undefined if the project is being ejected.

    -
    -
    -
    - -
    deps: Dependencies
    -

    Project dependencies.

    -
    -
    -
    - -
    devContainer: undefined | DevContainer
    -

    Access for .devcontainer.json (used for GitHub Codespaces)

    +
    deps: Dependencies

    Project dependencies.

    +
    devContainer: undefined | DevContainer

    Access for .devcontainer.json (used for GitHub Codespaces)

    This will be undefined if devContainer boolean is false

    -
    -
    -
    - -
    docgen?: boolean
    -
    - -
    docsDirectory: string
    -
    - -
    eslint?: Eslint
    -
    - -
    gitattributes: GitAttributesFile
    -

    The .gitattributes file for this repository.

    -
    -
    -
    - -
    github: undefined | GitHub
    -

    Access all github components.

    +
    docgen?: boolean
    docsDirectory: string
    eslint?: Eslint
    gitattributes: GitAttributesFile

    The .gitattributes file for this repository.

    +
    github: undefined | GitHub

    Access all github components.

    This will be undefined for subprojects.

    -
    -
    -
    - -
    gitignore: IgnoreFile
    -

    .gitignore

    -
    -
    -
    - -
    gitpod: undefined | Gitpod
    -

    Access for Gitpod

    +
    gitignore: IgnoreFile

    .gitignore

    +
    gitpod: undefined | Gitpod

    Access for Gitpod

    This will be undefined if gitpod boolean is false

    -
    -
    -
    - -
    initProject?: InitProject
    -

    The options used when this project is bootstrapped via projen new. It +

    initProject?: InitProject

    The options used when this project is bootstrapped via projen new. It includes the original set of options passed to the CLI and also the JSII FQN of the project type.

    -
    -
    -
    - -
    jest?: Jest
    -

    The Jest configuration (if enabled)

    -
    -
    -
    - -
    libdir: string
    -

    The directory in which compiled .js files reside.

    -
    -
    -
    - -
    logger: Logger
    -

    Logging utilities.

    -
    -
    -
    - -
    name: string
    -

    Project name.

    -
    -
    -
    - -
    node: Node
    -

    The tree node.

    -
    -
    -
    - -
    nodeVersion?: string
    -
    - -
    npmignore?: IgnoreFile
    -

    The .npmignore file.

    -
    -
    -
    - -
    outdir: string
    -

    Absolute output directory of this project.

    -
    -
    -
    - -
    package: NodePackage
    -

    API for managing the node package.

    -
    -
    -
    - -
    parent?: Project
    -

    A parent project. If undefined, this is the root project.

    -
    -
    -
    - -
    prettier?: Prettier
    -
    - -
    projectBuild: ProjectBuild
    -

    Manages the build process of the project.

    -
    -
    -
    - -
    projectType: ProjectType
    -
    - -
    projenCommand: string
    -

    The command to use in order to run the projen CLI.

    -
    -
    -
    - -
    publisher?: Publisher
    -

    Package publisher. This will be undefined if the project does not have a +

    jest?: Jest

    The Jest configuration (if enabled)

    +
    libdir: string

    The directory in which compiled .js files reside.

    +
    logger: Logger

    Logging utilities.

    +
    name: string

    Project name.

    +
    node: Node

    The tree node.

    +
    nodeVersion?: string
    npmignore?: IgnoreFile

    The .npmignore file.

    +
    outdir: string

    Absolute output directory of this project.

    +
    package: NodePackage

    API for managing the node package.

    +
    parent?: Project

    A parent project. If undefined, this is the root project.

    +
    prettier?: Prettier
    projectBuild: ProjectBuild

    Manages the build process of the project.

    +
    projectType: ProjectType
    projenCommand: string

    The command to use in order to run the projen CLI.

    +
    publisher?: Publisher

    Package publisher. This will be undefined if the project does not have a release workflow.

    -
    -
    -

    Deprecated

    use release.publisher.

    -
    -
    - -
    release?: Release
    -

    Release management.

    -
    -
    -
    - -
    runScriptCommand: string
    -

    The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).

    -
    -
    -
    - -
    srcdir: string
    -

    The directory in which the .ts sources reside.

    -
    -
    -
    - -
    tasks: Tasks
    -

    Project tasks.

    -
    -
    -
    - -
    testdir: string
    -

    The directory in which tests reside.

    -
    -
    -
    - -
    tsconfig?: TypescriptConfig
    -
    - -
    tsconfigDev: TypescriptConfig
    -

    A typescript configuration file which covers all files (sources, tests, projen).

    -
    -
    -
    - -
    tsconfigEslint?: TypescriptConfig
    -
    - -
    upgradeWorkflow?: UpgradeDependencies
    -

    The upgrade workflow.

    -
    -
    -
    - -
    vscode: undefined | VsCode
    -

    Access all VSCode components.

    +

    Deprecated

    use release.publisher.

    +
    release?: Release

    Release management.

    +
    runScriptCommand: string

    The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).

    +
    srcdir: string

    The directory in which the .ts sources reside.

    +
    tasks: Tasks

    Project tasks.

    +
    testdir: string

    The directory in which tests reside.

    +
    tsconfig?: TypescriptConfig
    tsconfigDev: TypescriptConfig

    A typescript configuration file which covers all files (sources, tests, projen).

    +
    tsconfigEslint?: TypescriptConfig
    upgradeWorkflow?: UpgradeDependencies

    The upgrade workflow.

    +
    vscode: undefined | VsCode

    Access all VSCode components.

    This will be undefined for subprojects.

    -
    -
    -
    - -
    watchTask: Task
    -

    The "watch" task.

    -
    -
    -
    - -
    workflowBootstrapSteps: JobStep[]
    -
    - -
    workflowPackageCache: boolean
    -
    - -
    DEFAULT_TASK: "default" = "default"
    -

    The name of the default task (the task executed when projen is run without arguments). Normally +

    watchTask: Task

    The "watch" task.

    +
    workflowBootstrapSteps: JobStep[]
    workflowPackageCache: boolean
    DEFAULT_TASK: "default" = "default"

    The name of the default task (the task executed when projen is run without arguments). Normally this task should synthesize the project files.

    -
    -
    -
    - -
    DEFAULT_TS_JEST_TRANFORM_PATTERN: "^.+\\.[t]sx?$" = "^.+\\.[t]sx?$"
    -
    -

    Accessors

    -
    - -
      -
    • get allowLibraryDependencies(): boolean
    • -
    • -

      Returns boolean

      -
      -

      Deprecated

      use package.allowLibraryDependencies

      -
    -
    - -
      -
    • get buildTask(): Task
    • -
    • -

      Returns Task

    -
    - -
      -
    • get buildWorkflowJobId(): undefined | string
    • -
    • -

      The job ID of the build workflow.

      -
      -

      Returns undefined | string

      -
    -
    - -
      -
    • get cdkVersion(): string
    • -
    • -

      The CDK version this app is using.

      -
      -

      Returns string

      -
    -
    - -
      -
    • get compileTask(): Task
    • -
    • -

      Returns Task

    -
    - -
      -
    • get components(): Component[]
    • -
    • -

      Returns all the components within this project.

      -
      -

      Returns Component[]

      -
    -
    - -
      -
    • get ejected(): boolean
    • -
    • -

      Whether or not the project is being ejected.

      -
      -

      Returns boolean

      -
    -
    - -
      -
    • get entrypoint(): string
    • -
    • -

      Returns string

      -
      -

      Deprecated

      use package.entrypoint

      -
    -
    - -
      -
    • get files(): FileBase[]
    • -
    • -

      All files in this project.

      -
      -

      Returns FileBase[]

      -
    -
    - -
      -
    • get manifest(): any
    • -
    • -

      Returns any

      -
      -

      Deprecated

      use package.addField(x, y)

      -
    -
    - -
      -
    • get maxNodeVersion(): undefined | string
    • -
    • -

      Maximum node version required by this package.

      -
      -

      Returns undefined | string

      -
    -
    - -
      -
    • get minNodeVersion(): undefined | string
    • -
    • -

      Minimum node.js version required by this package.

      -
      -

      Returns undefined | string

      -
    -
    - -
      -
    • get npmrc(): NpmConfig
    • -
    • -

      The .npmrc file

      -
      -

      Returns NpmConfig

      -
    -
    - -
      -
    • get packageManager(): NodePackageManager
    • -
    • -

      The package manager to use.

      -
      -

      Returns NodePackageManager

      -
      -

      Deprecated

      use package.packageManager

      -
    -
    - -
      -
    • get packageTask(): Task
    • -
    • -

      Returns Task

    -
    - -
      -
    • get postCompileTask(): Task
    • -
    • -

      Returns Task

    -
    - -
      -
    • get preCompileTask(): Task
    • -
    • -

      Returns Task

    -
    - -
      -
    • get root(): Project
    • -
    • -

      The root project.

      -
      -

      Returns Project

      -
    -
    - -
      -
    • get subprojects(): Project[]
    • -
    • -

      Returns all the subprojects within this project.

      -
      -

      Returns Project[]

      -
    -
    - -
      -
    • get testTask(): Task
    • -
    • -

      Returns Task

    -
    -

    Methods

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        bins: Record<string, string>
      -

      Returns void

    -
    - -
      - -
    • -

      Defines bundled dependencies.

      +
    DEFAULT_TS_JEST_TRANFORM_PATTERN: "^.+\\.[t]sx?$" = "^.+\\.[t]sx?$"

    Accessors

    • get allowLibraryDependencies(): boolean
    • Returns boolean

      Deprecated

      use package.allowLibraryDependencies

      +
    • get buildTask(): Task
    • Returns Task

    • get buildWorkflowJobId(): undefined | string
    • The job ID of the build workflow.

      +

      Returns undefined | string

    • get cdkVersion(): string
    • The CDK version this app is using.

      +

      Returns string

    • get compileTask(): Task
    • Returns Task

    • get components(): Component[]
    • Returns all the components within this project.

      +

      Returns Component[]

    • get ejected(): boolean
    • Whether or not the project is being ejected.

      +

      Returns boolean

    • get entrypoint(): string
    • Returns string

      Deprecated

      use package.entrypoint

      +
    • get files(): FileBase[]
    • All files in this project.

      +

      Returns FileBase[]

    • get manifest(): any
    • Returns any

      Deprecated

      use package.addField(x, y)

      +
    • get maxNodeVersion(): undefined | string
    • Maximum node version required by this package.

      +

      Returns undefined | string

    • get minNodeVersion(): undefined | string
    • Minimum node.js version required by this package.

      +

      Returns undefined | string

    • get npmrc(): NpmConfig
    • The .npmrc file

      +

      Returns NpmConfig

    • get packageManager(): NodePackageManager
    • The package manager to use.

      +

      Returns NodePackageManager

      Deprecated

      use package.packageManager

      +
    • get packageTask(): Task
    • Returns Task

    • get postCompileTask(): Task
    • Returns Task

    • get preCompileTask(): Task
    • Returns Task

    • get root(): Project
    • The root project.

      +

      Returns Project

    • get subprojects(): Project[]
    • Returns all the subprojects within this project.

      +

      Returns Project[]

    • get testTask(): Task
    • Returns Task

    Methods

    • Parameters

      • bins: Record<string, string>

      Returns void

    • Defines bundled dependencies.

      Bundled dependencies will be added as normal dependencies as well as to the bundledDependencies section of your package.json.

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...deps: string[]
        -

        Names modules to install. By default, the the dependency will +

        Parameters

        • Rest ...deps: string[]

          Names modules to install. By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

          -
          Rest
        -

        Returns void

        -
    -
    - -
      - -
    • -

      Adds an AWS CDK module dependencies

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...modules: string[]
        -

        The list of modules to depend on

        -
        Rest
      -

      Returns void

      -
    -
    - -
      - -
    • -

      DEPRECATED

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...commands: string[]
        Rest
      -

      Returns void

      -
      -

      Deprecated

      use project.compileTask.exec()

      -
    -
    - -
      - -
    • -

      Defines normal dependencies.

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...deps: string[]
        -

        Names modules to install. By default, the the dependency will +

      Returns void

    • Adds an AWS CDK module dependencies

      +

      Parameters

      • Rest ...modules: string[]

        The list of modules to depend on

        +

      Returns void

    • DEPRECATED

      +

      Parameters

      • Rest ...commands: string[]

      Returns void

      Deprecated

      use project.compileTask.exec()

      +
    • Defines normal dependencies.

      +

      Parameters

      • Rest ...deps: string[]

        Names modules to install. By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

        -
        Rest
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Defines development/test dependencies.

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...deps: string[]
        -

        Names modules to install. By default, the the dependency will +

      Returns void

    • Defines development/test dependencies.

      +

      Parameters

      • Rest ...deps: string[]

        Names modules to install. By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

        -
        Rest
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Exclude the matching files from pre-synth cleanup. Can be used when, for example, some +

    Returns void

    • Exclude the matching files from pre-synth cleanup. Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth.

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...globs: string[]
        -

        The glob patterns to match

        -
        Rest
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Directly set fields in package.json.

      -
      -
      -

      Parameters

      -
        -
      • -
        fields: {
            [name: string]: any;
        }
        -

        The fields to set

        -
        -
          -
        • -
          [name: string]: any
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Adds a .gitignore pattern.

      -
      -
      -

      Parameters

      -
        -
      • -
        pattern: string
        -

        The glob pattern to ignore.

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Adds keywords to package.json (deduplicated)

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...keywords: string[]
        -

        The keywords to add

        -
        Rest
      -

      Returns void

      -
    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        pattern: string
      -

      Returns void

    -
    - -
      - -
    • -

      Defines peer dependencies.

      +

      Parameters

      • Rest ...globs: string[]

        The glob patterns to match

        +

      Returns void

    • Directly set fields in package.json.

      +

      Parameters

      • fields: {
            [name: string]: any;
        }

        The fields to set

        +
        • [name: string]: any

      Returns void

    • Adds a .gitignore pattern.

      +

      Parameters

      • pattern: string

        The glob pattern to ignore.

        +

      Returns void

    • Adds keywords to package.json (deduplicated)

      +

      Parameters

      • Rest ...keywords: string[]

        The keywords to add

        +

      Returns void

    • Parameters

      • pattern: string

      Returns void

    • Defines peer dependencies.

      When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers.

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...deps: string[]
        -

        Names modules to install. By default, the the dependency will +

        Parameters

        • Rest ...deps: string[]

          Names modules to install. By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

          -
          Rest
        -

        Returns void

        -
    -
    - -
      - -
    • -

      Replaces the contents of multiple npm package.json scripts.

      -
      -
      -

      Parameters

      -
        -
      • -
        scripts: {
            [name: string]: string;
        }
        -

        The scripts to set

        -
        -
          -
        • -
          [name: string]: string
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Adds a new task to this project. This will fail if the project already has +

    Returns void

    • Replaces the contents of multiple npm package.json scripts.

      +

      Parameters

      • scripts: {
            [name: string]: string;
        }

        The scripts to set

        +
        • [name: string]: string

      Returns void

    • Adds a new task to this project. This will fail if the project already has a task with this name.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The task name to add

        -
      • -
      • -
        Optional props: TaskOptions
        -

        Task properties

        -
        Optional
      -

      Returns Task

      -
    -
    - -
      - -
    • -

      DEPRECATED

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...commands: string[]
        Rest
      -

      Returns void

      -
      -

      Deprecated

      use project.testTask.exec()

      -
    -
    - -
      - -
    • -

      Prints a "tip" message during synthesis.

      -
      -
      -

      Parameters

      -
        -
      • -
        message: string
        -

        The message

        -
      -

      Returns void

      -
      -

      Deprecated

        +

      Parameters

      • name: string

        The task name to add

        +
      • Optional props: TaskOptions

        Task properties

        +

      Returns Task

    • DEPRECATED

      +

      Parameters

      • Rest ...commands: string[]

      Returns void

      Deprecated

      use project.testTask.exec()

      +
    • Prints a "tip" message during synthesis.

      +

      Parameters

      • message: string

        The message

        +

      Returns void

      Deprecated

      • use project.logger.info(message) to show messages during synthesis
      -
    -
    - -
      - -
    • -

      Marks the provided file(s) as being generated. This is achieved using the +

    • Marks the provided file(s) as being generated. This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown.

      -
      -
      -

      Parameters

      -
        -
      • -
        glob: string
        -

        the glob pattern to match (could be a file path).

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Indicates if a script by the name name is defined.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The name of the script

        -
      -

      Returns boolean

      -
      -

      Deprecated

      Use project.tasks.tryFind(name)

      -
    -
    - -
      - -
    • -

      Called after all components are synthesized. Order is not guaranteed.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Called before all components are synthesized.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Removes the npm script (always successful).

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The name of the script.

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Removes a task from a project.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The name of the task to remove.

        -
      -

      Returns undefined | Task

      The Task that was removed, otherwise undefined.

      - -
    -
    - -
      - -
    • -

      Returns the set of workflow steps which should be executed to bootstrap a +

      Parameters

      • glob: string

        the glob pattern to match (could be a file path).

        +

      Returns void

    • Indicates if a script by the name name is defined.

      +

      Parameters

      • name: string

        The name of the script

        +

      Returns boolean

      Deprecated

      Use project.tasks.tryFind(name)

      +
    • Called after all components are synthesized. Order is not guaranteed.

      +

      Returns void

    • Called before all components are synthesized.

      +

      Returns void

    • Removes the npm script (always successful).

      +

      Parameters

      • name: string

        The name of the script.

        +

      Returns void

    • Removes a task from a project.

      +

      Parameters

      • name: string

        The name of the task to remove.

        +

      Returns undefined | Task

      The Task that was removed, otherwise undefined.

      +
    • Returns the set of workflow steps which should be executed to bootstrap a workflow.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional options: RenderWorkflowSetupOptions
        -

        Options.

        -
        Optional
      -

      Returns JobStep[]

      Job steps

      - -
    -
    - -
      - -
    • -

      Returns the shell command to execute in order to run a task. This will +

      Parameters

      • Optional options: RenderWorkflowSetupOptions

        Options.

        +

      Returns JobStep[]

      Job steps

      +
    • Returns the shell command to execute in order to run a task. This will typically be npx projen TASK.

      -
      -
      -

      Parameters

      -
        -
      • -
        task: Task
        -

        The task for which the command is required

        -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Replaces the contents of an npm package.json script.

      -
      -
      -

      Parameters

      -
        -
      • -
        name: string
        -

        The script name

        -
      • -
      • -
        command: string
        -

        The command to execute

        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Synthesize all project files into outdir.

      +

      Parameters

      • task: Task

        The task for which the command is required

        +

      Returns string

    • Replaces the contents of an npm package.json script.

      +

      Parameters

      • name: string

        The script name

        +
      • command: string

        The command to execute

        +

      Returns void

    -
    - -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Finds a file at the specified relative path within this project and all +

      Returns void

    • Returns a string representation of this construct.

      +

      Returns string

    • Finds a file at the specified relative path within this project and all its subprojects.

      -
      -
      -

      Parameters

      -
        -
      • -
        filePath: string
        -

        The file path. If this path is relative, it will be resolved +

        Parameters

        • filePath: string

          The file path. If this path is relative, it will be resolved from the root of this project.

          -
        -

        Returns undefined | FileBase

        a FileBase or undefined if there is no file in that path

        - -
    -
    - -
      - -
    • -

      Finds a json file by name.

      -
      -
      -

      Parameters

      -
        -
      • -
        filePath: string
        -

        The file path.

        -
      -

      Returns undefined | JsonFile

      -
      -

      Deprecated

      use tryFindObjectFile

      -
    -
    - -
      - -
    • -

      Finds an object file (like JsonFile, YamlFile, etc.) by name.

      -
      -
      -

      Parameters

      -
        -
      • -
        filePath: string
        -

        The file path.

        -
      -

      Returns undefined | ObjectFile

      -
    -
    - -
      - -
    • -

      Finds a file at the specified relative path within this project and removes +

    Returns undefined | FileBase

    a FileBase or undefined if there is no file in that path

    +
    • Finds a json file by name.

      +

      Parameters

      • filePath: string

        The file path.

        +

      Returns undefined | JsonFile

      Deprecated

      use tryFindObjectFile

      +
    • Finds an object file (like JsonFile, YamlFile, etc.) by name.

      +

      Parameters

      • filePath: string

        The file path.

        +

      Returns undefined | ObjectFile

    • Finds a file at the specified relative path within this project and removes it.

      -
      -
      -

      Parameters

      -
        -
      • -
        filePath: string
        -

        The file path. If this path is relative, it will be +

        Parameters

        • filePath: string

          The file path. If this path is relative, it will be resolved from the root of this project.

          -
        -

        Returns undefined | FileBase

        a FileBase if the file was found and removed, or undefined if +

    Returns undefined | FileBase

    a FileBase if the file was found and removed, or undefined if the file was not found.

    - -
    -
    - -
      - -
    • -

      Checks if x is a construct.

      +
    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -1258,191 +286,10 @@

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
      -

      Returns x is Construct

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

      - -
    -
    - -
      - -
    • -

      Test whether the given construct is a project.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Project

      -
    -
    - -
      - -
    • -

      Find the closest ancestor project for given construct. +

      Parameters

      • x: any

        Any object

        +

      Returns x is Construct

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

      +
    • Test whether the given construct is a project.

      +

      Parameters

      • x: any

      Returns x is Project

    • Find the closest ancestor project for given construct. When given a project, this it the project itself.

      -
      -
      -

      Parameters

      -
        -
      • -
        construct: IConstruct
      -

      Returns Project

      -
      -

      Throws

      when no project is found in the path to the root

      -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • construct: IConstruct

    Returns Project

    Throws

    when no project is found in the path to the root

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/classes/Workflow.html b/docs/projen/classes/Workflow.html index 2bb432c..9942e90 100644 --- a/docs/projen/classes/Workflow.html +++ b/docs/projen/classes/Workflow.html @@ -1,44 +1,8 @@ -Workflow | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Class Workflow

    -
    -

    Hierarchy

    -
      -
    • Component -
        -
      • Workflow
    -
    -
    -
    - -
    -
    -

    Constructors

    -
    -
    -

    Properties

    -
    node +Workflow | cdk-serverless

    Hierarchy

    • Component
      • Workflow
    -
    -

    Constructors

    -
    - -
      - -
    • -
      -

      Parameters

      -
      -

      Returns Workflow

    -
    -

    Properties

    -
    - -
    node: Node
    -

    The tree node.

    -
    -
    -
    - -
    -
    - -
    project: Project
    -
    -

    Methods

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        fileName: string
      • -
      • -
        matchedVariables: VariableDefinition[]
      -

      Returns void

    -
    - -
      - -
    • -

      Called after synthesis. Order is not guaranteed.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Called before synthesis.

      -
      -

      Returns void

      -
    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        def: VariableDefinition
      -

      Returns string

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        def: VariableDefinition
      -

      Returns string

    -
    - -
      - -
    • -

      Returns void

    -
    - -
      - -
    • -

      Returns a string representation of this construct.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Test whether the given construct is a component.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: any
      -

      Returns x is Component

      -
    -
    - -
      - -
    • -

      Checks if x is a construct.

      +

    Constructors

    Properties

    node: Node

    The tree node.

    +
    project: Project

    Methods

    • Parameters

      • fileName: string
      • matchedVariables: VariableDefinition[]

      Returns void

    • Called after synthesis. Order is not guaranteed.

      +

      Returns void

    • Called before synthesis.

      +

      Returns void

    • Parameters

      • def: VariableDefinition

      Returns string

    • Parameters

      • def: VariableDefinition

      Returns string

    • Returns void

    • Returns a string representation of this construct.

      +

      Returns string

    • Test whether the given construct is a component.

      +

      Parameters

      • x: any

      Returns x is Component

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on @@ -187,64 +29,6 @@

      -
      -

      Parameters

      -
        -
      • -
        x: any
        -

        Any object

        -
      -

      Returns x is Construct

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

      - -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Parameters

    • x: any

      Any object

      +

    Returns x is Construct

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

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/index.html b/docs/projen/index.html index 4f4ddc4..dfa26e2 100644 --- a/docs/projen/index.html +++ b/docs/projen/index.html @@ -1,18 +1,4 @@ -cdk-serverless
    -
    - -
    -
    -
    -
    -

    cdk-serverless

    -

    CDK Serverless

    npm version

    +cdk-serverless

    cdk-serverless

    CDK Serverless

    npm version

    CDK Serverless is a tool suite to facilitate the use of the AWS Cloud Development Kit (CDK) in serverless architectures. It provides project management features to configure your TypeScript CDK app and also higher-level (L3) constructs for different APIs and resources needed for serverless applications. Additionally, it leverages utility libraries to write Lambda functions and do live updates to Lambda function code during development.

    Features

    • Projen helper classes to configure certain use cases easily
    • @@ -56,59 +42,4 @@

      cdk-serverless

  • Just file a PR with your recommended changes
  • Authors

    Brought to you by Taimos

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/interfaces/DatastoreOptions.html b/docs/projen/interfaces/DatastoreOptions.html index fcee88c..349d482 100644 --- a/docs/projen/interfaces/DatastoreOptions.html +++ b/docs/projen/interfaces/DatastoreOptions.html @@ -1,77 +1,3 @@ -DatastoreOptions | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface DatastoreOptions

    -
    -

    Hierarchy

    -
      -
    • DatastoreOptions
    -
    -
    -
    - -
    -
    -

    Properties

    -
    definitionFile +DatastoreOptions | cdk-serverless

    Interface DatastoreOptions

    interface DatastoreOptions {
        definitionFile: string;
        modelName: string;
    }
    -
    -

    Properties

    -
    - -
    definitionFile: string
    -
    - -
    modelName: string
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    definitionFile: string
    modelName: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/interfaces/GraphQlApiOptions.html b/docs/projen/interfaces/GraphQlApiOptions.html index ba607b0..660dc4c 100644 --- a/docs/projen/interfaces/GraphQlApiOptions.html +++ b/docs/projen/interfaces/GraphQlApiOptions.html @@ -1,77 +1,3 @@ -GraphQlApiOptions | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface GraphQlApiOptions

    -
    -

    Hierarchy

    -
      -
    • GraphQlApiOptions
    -
    -
    -
    - -
    -
    -

    Properties

    -
    apiName +GraphQlApiOptions | cdk-serverless

    Interface GraphQlApiOptions

    interface GraphQlApiOptions {
        apiName: string;
        definitionFile: string;
    }
    -
    -

    Properties

    -
    - -
    apiName: string
    -
    - -
    definitionFile: string
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    apiName: string
    definitionFile: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/interfaces/RestApiOptions.html b/docs/projen/interfaces/RestApiOptions.html index c3f0084..e0c3c66 100644 --- a/docs/projen/interfaces/RestApiOptions.html +++ b/docs/projen/interfaces/RestApiOptions.html @@ -1,77 +1,3 @@ -RestApiOptions | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface RestApiOptions

    -
    -

    Hierarchy

    -
      -
    • RestApiOptions
    -
    -
    -
    - -
    -
    -

    Properties

    -
    apiName +RestApiOptions | cdk-serverless

    Interface RestApiOptions

    interface RestApiOptions {
        apiName: string;
        definitionFile: string;
    }
    -
    -

    Properties

    -
    - -
    apiName: string
    -
    - -
    definitionFile: string
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    apiName: string
    definitionFile: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/interfaces/ServerlessProjectOptions.html b/docs/projen/interfaces/ServerlessProjectOptions.html index 5da0d42..61b1c6b 100644 --- a/docs/projen/interfaces/ServerlessProjectOptions.html +++ b/docs/projen/interfaces/ServerlessProjectOptions.html @@ -1,34 +1,4 @@ -ServerlessProjectOptions | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface ServerlessProjectOptions

    -
    -

    Hierarchy

    -
      -
    • AwsCdkTypeScriptAppOptions -
        -
      • ServerlessProjectOptions
    -
    -
    -
    - -
    -
    -

    Properties

    -
    allowLibraryDependencies? +ServerlessProjectOptions | cdk-serverless

    Interface ServerlessProjectOptions

    interface ServerlessProjectOptions {
        allowLibraryDependencies?: boolean;
        appEntrypoint?: string;
        artifactsDirectory?: string;
        authorEmail?: string;
        authorName?: string;
        authorOrganization?: boolean;
        authorUrl?: string;
        autoApproveOptions?: AutoApproveOptions;
        autoApproveUpgrades?: boolean;
        autoDetectBin?: boolean;
        autoMerge?: boolean;
        autoMergeOptions?: AutoMergeOptions;
        bin?: Record<string, string>;
        bugsEmail?: string;
        bugsUrl?: string;
        buildCommand?: string;
        buildWorkflow?: boolean;
        buildWorkflowTriggers?: Triggers;
        bundledDeps?: string[];
        bundlerOptions?: BundlerOptions;
        cdkAssert?: boolean;
        cdkAssertions?: boolean;
        cdkDependencies?: string[];
        cdkDependenciesAsDeps?: boolean;
        cdkTestDependencies?: string[];
        cdkVersion: string;
        cdkVersionPinning?: boolean;
        cdkout?: string;
        checkLicenses?: LicenseCheckerOptions;
        clobber?: boolean;
        codeArtifactOptions?: CodeArtifactOptions;
        codeCov?: boolean;
        codeCovTokenSecret?: string;
        commitGenerated?: boolean;
        constructsVersion?: string;
        context?: {
            [key: string]: any;
        };
        copyrightOwner?: string;
        copyrightPeriod?: string;
        defaultReleaseBranch: string;
        dependabot?: boolean;
        dependabotOptions?: DependabotOptions;
        deps?: string[];
        depsUpgrade?: boolean;
        depsUpgradeOptions?: UpgradeDependenciesOptions;
        description?: string;
        devContainer?: boolean;
        devDeps?: string[];
        disableTsconfig?: boolean;
        disableTsconfigDev?: boolean;
        docgen?: boolean;
        docsDirectory?: string;
        edgeLambdaAutoDiscover?: boolean;
        entrypoint?: string;
        entrypointTypes?: string;
        eslint?: boolean;
        eslintOptions?: EslintOptions;
        experimentalIntegRunner?: boolean;
        featureFlags?: boolean;
        gitIgnoreOptions?: IgnoreFileOptions;
        gitOptions?: GitOptions;
        github?: boolean;
        githubOptions?: GitHubOptions;
        gitignore?: string[];
        gitpod?: boolean;
        homepage?: string;
        integrationTestAutoDiscover?: boolean;
        jest?: boolean;
        jestOptions?: JestOptions;
        jsiiReleaseVersion?: string;
        keywords?: string[];
        lambdaAutoDiscover?: boolean;
        lambdaExtensionAutoDiscover?: boolean;
        lambdaOptions?: LambdaFunctionCommonOptions;
        libdir?: string;
        license?: string;
        licensed?: boolean;
        logging?: LoggerOptions;
        majorVersion?: number;
        maxNodeVersion?: string;
        mergify?: boolean;
        mergifyOptions?: MergifyOptions;
        minMajorVersion?: number;
        minNodeVersion?: string;
        mutableBuild?: boolean;
        name: string;
        npmAccess?: NpmAccess;
        npmDistTag?: string;
        npmIgnoreOptions?: IgnoreFileOptions;
        npmRegistry?: string;
        npmRegistryUrl?: string;
        npmTokenSecret?: string;
        npmignore?: string[];
        npmignoreEnabled?: boolean;
        outdir?: string;
        package?: boolean;
        packageManager?: NodePackageManager;
        packageName?: string;
        parent?: Project;
        peerDependencyOptions?: PeerDependencyOptions;
        peerDeps?: string[];
        pnpmVersion?: string;
        postBuildSteps?: JobStep[];
        prerelease?: string;
        prettier?: boolean;
        prettierOptions?: PrettierOptions;
        projectType?: ProjectType;
        projenCommand?: string;
        projenCredentials?: GithubCredentials;
        projenDevDependency?: boolean;
        projenTokenSecret?: string;
        projenVersion?: string;
        projenrcJs?: boolean;
        projenrcJsOptions?: ProjenrcOptions;
        projenrcJson?: boolean;
        projenrcJsonOptions?: ProjenrcJsonOptions;
        projenrcTs?: boolean;
        projenrcTsOptions?: ProjenrcOptions;
        publishDryRun?: boolean;
        publishTasks?: boolean;
        pullRequestTemplate?: boolean;
        pullRequestTemplateContents?: string[];
        readme?: SampleReadmeProps;
        releasableCommits?: ReleasableCommits;
        release?: boolean;
        releaseBranches?: {
            [name: string]: BranchOptions;
        };
        releaseEveryCommit?: boolean;
        releaseFailureIssue?: boolean;
        releaseFailureIssueLabel?: string;
        releaseSchedule?: string;
        releaseTagPrefix?: string;
        releaseToNpm?: boolean;
        releaseTrigger?: ReleaseTrigger;
        releaseWorkflow?: boolean;
        releaseWorkflowName?: string;
        releaseWorkflowSetupSteps?: JobStep[];
        renovatebot?: boolean;
        renovatebotOptions?: RenovatebotOptions;
        repository?: string;
        repositoryDirectory?: string;
        requireApproval?: ApprovalLevel;
        sampleCode?: boolean;
        scopedPackagesOptions?: ScopedPackagesOptions[];
        scripts?: {
            [name: string]: string;
        };
        srcdir?: string;
        stability?: string;
        stale?: boolean;
        staleOptions?: StaleOptions;
        testdir?: string;
        tsJestOptions?: TsJestOptions;
        tsconfig?: TypescriptConfigOptions;
        tsconfigDev?: TypescriptConfigOptions;
        tsconfigDevFile?: string;
        typescriptVersion?: string;
        versionrcOptions?: Record<string, any>;
        vscode?: boolean;
        watchExcludes?: string[];
        watchIncludes?: string[];
        workflowBootstrapSteps?: JobStep[];
        workflowContainerImage?: string;
        workflowGitIdentity?: GitIdentity;
        workflowNodeVersion?: string;
        workflowPackageCache?: boolean;
        workflowRunsOn?: string[];
        workflowRunsOnGroup?: GroupRunnerOptions;
        yarnBerryOptions?: YarnBerryOptions;
    }

    Hierarchy

    • AwsCdkTypeScriptAppOptions
      • ServerlessProjectOptions
    -
    -

    Properties

    -
    - -
    allowLibraryDependencies?: boolean
    -

    Allow the project to include peerDependencies and bundledDependencies. +

    Properties

    allowLibraryDependencies?: boolean

    Allow the project to include peerDependencies and bundledDependencies. This is normally only allowed for libraries. For apps, there's no meaning for specifying these.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    appEntrypoint?: string
    -

    The CDK app's entrypoint (relative to the source directory, which is +

    Default

    true
    +
    +
    appEntrypoint?: string

    The CDK app's entrypoint (relative to the source directory, which is "src" by default).

    -
    -
    -

    Default

    "main.ts"
    -
    -
    -
    - -
    artifactsDirectory?: string
    -

    A directory which will contain build artifacts.

    -
    -
    -

    Default

    "dist"
    -
    -
    -
    - -
    authorEmail?: string
    -

    Author's e-mail

    -
    -
    -
    - -
    authorName?: string
    -

    Author's name

    -
    -
    -
    - -
    authorOrganization?: boolean
    -

    Is the author an organization

    -
    -
    -
    - -
    authorUrl?: string
    -

    Author's URL / Website

    -
    -
    -
    - -
    autoApproveOptions?: AutoApproveOptions
    -

    Enable and configure the 'auto approve' workflow.

    -
    -
    -

    Default

    - auto approve is disabled
    -
    -
    -
    - -
    autoApproveUpgrades?: boolean
    -

    Automatically approve deps upgrade PRs, allowing them to be +

    Default

    "main.ts"
    +
    +
    artifactsDirectory?: string

    A directory which will contain build artifacts.

    +

    Default

    "dist"
    +
    +
    authorEmail?: string

    Author's e-mail

    +
    authorName?: string

    Author's name

    +
    authorOrganization?: boolean

    Is the author an organization

    +
    authorUrl?: string

    Author's URL / Website

    +
    autoApproveOptions?: AutoApproveOptions

    Enable and configure the 'auto approve' workflow.

    +

    Default

    - auto approve is disabled
    +
    +
    autoApproveUpgrades?: boolean

    Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).

    Throw if set to true but autoApproveOptions are not defined.

    -
    -
    -

    Default

    - true
    -
    -
    -
    - -
    autoDetectBin?: boolean
    -

    Automatically add all executables under the bin directory to your +

    Default

    - true
    +
    +
    autoDetectBin?: boolean

    Automatically add all executables under the bin directory to your package.json file under the bin section.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    autoMerge?: boolean
    -

    Enable automatic merging on GitHub. Has no effect if github.mergify +

    Default

    true
    +
    +
    autoMerge?: boolean

    Enable automatic merging on GitHub. Has no effect if github.mergify is set to false.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    autoMergeOptions?: AutoMergeOptions
    -

    Configure options for automatic merging on GitHub. Has no effect if +

    Default

    true
    +
    +
    autoMergeOptions?: AutoMergeOptions

    Configure options for automatic merging on GitHub. Has no effect if github.mergify or autoMerge is set to false.

    -
    -
    -

    Default

      +

    Default

    • see defaults in AutoMergeOptions
    -
    -
    - -
    bin?: Record<string, string>
    -

    Binary programs vended with your module.

    +
    bin?: Record<string, string>

    Binary programs vended with your module.

    You can use this option to add/customize how binaries are represented in your package.json, but unless autoDetectBin is false, every executable file under bin will automatically be added to this section.

    -
    -
    -
    - -
    bugsEmail?: string
    -

    The email address to which issues should be reported.

    -
    -
    -
    - -
    bugsUrl?: string
    -

    The url to your project's issue tracker.

    -
    -
    -
    - -
    buildCommand?: string
    -

    A command to execute before synthesis. This command will be called when +

    bugsEmail?: string

    The email address to which issues should be reported.

    +
    bugsUrl?: string

    The url to your project's issue tracker.

    +
    buildCommand?: string

    A command to execute before synthesis. This command will be called when running cdk synth or when cdk watch identifies a change in your source code before redeployment.

    -
    -
    -

    Default

    - no build command
    -
    -
    -
    - -
    buildWorkflow?: boolean
    -

    Define a GitHub workflow for building PRs.

    -
    -
    -

    Default

    - true if not a subproject
    -
    -
    -
    - -
    buildWorkflowTriggers?: Triggers
    -

    Build workflow triggers

    -
    -
    -

    Default

    "{ pullRequest: {}, workflowDispatch: {} }"
    -
    -
    -
    - -
    bundledDeps?: string[]
    -

    List of dependencies to bundle into this module. These modules will be +

    Default

    - no build command
    +
    +
    buildWorkflow?: boolean

    Define a GitHub workflow for building PRs.

    +

    Default

    - true if not a subproject
    +
    +
    buildWorkflowTriggers?: Triggers

    Build workflow triggers

    +

    Default

    "{ pullRequest: {}, workflowDispatch: {} }"
    +
    +
    bundledDeps?: string[]

    List of dependencies to bundle into this module. These modules will be added both to the dependencies section and bundledDependencies section of your package.json.

    The recommendation is to only specify the module name here (e.g. @@ -381,314 +226,112 @@

    -
    -
    - -
    bundlerOptions?: BundlerOptions
    -

    Options for Bundler.

    -
    -
    -
    - -
    cdkAssert?: boolean
    -

    Warning: NodeJS only. +

    bundlerOptions?: BundlerOptions

    Options for Bundler.

    +
    cdkAssert?: boolean

    Warning: NodeJS only. Install the @aws-cdk/assert library?

    -
    -
    -

    Default

    - will be included by default for AWS CDK >= 1.0.0 < 2.0.0
    +

    Default

    - will be included by default for AWS CDK >= 1.0.0 < 2.0.0
     
    -

    Deprecated

    The @aws-cdk/assert library is deprecated in favor of @aws-cdk/assertions (in V1) and included in aws-cdk-lib for V2.

    -
    -
    - -
    cdkAssertions?: boolean
    -

    Install the assertions library?

    +
    cdkAssertions?: boolean

    Install the assertions library?

    Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib'

    -
    -
    -

    Default

    - will be included by default for AWS CDK >= 1.111.0 < 2.0.0
    -
    -
    -
    - -
    cdkDependencies?: string[]
    -

    Which AWS CDKv1 modules this project requires

    -
    -
    -

    Deprecated

    For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)

    -
    -
    - -
    cdkDependenciesAsDeps?: boolean
    -

    If this is enabled (default), all modules declared in cdkDependencies will be also added as +

    Default

    - will be included by default for AWS CDK >= 1.111.0 < 2.0.0
    +
    +
    cdkDependencies?: string[]

    Which AWS CDKv1 modules this project requires

    +

    Deprecated

    For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)

    +
    cdkDependenciesAsDeps?: boolean

    If this is enabled (default), all modules declared in cdkDependencies will be also added as normal dependencies (as well as peerDependencies).

    This is to ensure that downstream consumers actually have your CDK dependencies installed when using npm < 7 or yarn, where peer dependencies are not automatically installed. If this is disabled, cdkDependencies will be added to devDependencies to ensure they are present during development.

    Note: this setting only applies to construct library projects

    -
    -
    -

    Default

    true
    +

    Default

    true
     
    -

    Deprecated

    Not supported in CDK v2.

    -
    -
    - -
    cdkTestDependencies?: string[]
    -

    AWS CDK modules required for testing.

    -
    -
    -

    Deprecated

    For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead

    -
    -
    - -
    cdkVersion: string
    -

    Minimum version of the AWS CDK to depend on.

    -
    -
    -

    Default

    "2.1.0"
    -
    -
    -
    - -
    cdkVersionPinning?: boolean
    -

    Use pinned version instead of caret version for CDK.

    +
    cdkTestDependencies?: string[]

    AWS CDK modules required for testing.

    +

    Deprecated

    For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead

    +
    cdkVersion: string

    Minimum version of the AWS CDK to depend on.

    +

    Default

    "2.1.0"
    +
    +
    cdkVersionPinning?: boolean

    Use pinned version instead of caret version for CDK.

    You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

    -
    -
    -
    - -
    cdkout?: string
    -

    cdk.out directory.

    -
    -
    -

    Default

    "cdk.out"
    -
    -
    -
    - -
    checkLicenses?: LicenseCheckerOptions
    -

    Configure which licenses should be deemed acceptable for use by dependencies

    +
    cdkout?: string

    cdk.out directory.

    +

    Default

    "cdk.out"
    +
    +
    checkLicenses?: LicenseCheckerOptions

    Configure which licenses should be deemed acceptable for use by dependencies

    This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.

    -
    -
    -

    Default

    - no license checks are run during the build and all licenses will be accepted
    -
    -
    -
    - -
    clobber?: boolean
    -

    Add a clobber task which resets the repo to origin.

    -
    -
    -

    Default

    - true, but false for subprojects
    -
    -
    -
    - -
    codeArtifactOptions?: CodeArtifactOptions
    -

    Options for npm packages using AWS CodeArtifact. +

    Default

    - no license checks are run during the build and all licenses will be accepted
    +
    +
    clobber?: boolean

    Add a clobber task which resets the repo to origin.

    +

    Default

    - true, but false for subprojects
    +
    +
    codeArtifactOptions?: CodeArtifactOptions

    Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact

    -
    -
    -

    Default

    - undefined
    -
    -
    -
    - -
    codeCov?: boolean
    -

    Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ +

    Default

    - undefined
    +
    +
    codeCov?: boolean

    Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with @codeCovTokenSecret

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    codeCovTokenSecret?: string
    -

    Define the secret name for a specified https://codecov.io/ token +

    Default

    false
    +
    +
    codeCovTokenSecret?: string

    Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories

    -
    -
    -

    Default

    - if this option is not specified, only public repositories are supported
    -
    -
    -
    - -
    commitGenerated?: boolean
    -

    Whether to commit the managed files by default.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    constructsVersion?: string
    -

    Minimum version of the constructs library to depend on.

    -
    -
    -

    Default

    - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is
    "10.0.5". -
    -
    -
    - -
    context?: {
        [key: string]: any;
    }
    -

    Additional context to include in cdk.json.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [key: string]: any
    -
    -

    Default

    - no additional context
    -
    -
    -
    - -
    copyrightOwner?: string
    -

    License copyright owner.

    -
    -
    -

    Default

      +

    Default

    - if this option is not specified, only public repositories are supported
    +
    +
    commitGenerated?: boolean

    Whether to commit the managed files by default.

    +

    Default

    true
    +
    +
    constructsVersion?: string

    Minimum version of the constructs library to depend on.

    +

    Default

    - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is
    "10.0.5". +
    +
    context?: {
        [key: string]: any;
    }

    Additional context to include in cdk.json.

    +

    Type declaration

    • [key: string]: any

    Default

    - no additional context
    +
    +
    copyrightOwner?: string

    License copyright owner.

    +

    Default

    • defaults to the value of authorName or "" if authorName is undefined.
    -
    -
    - -
    copyrightPeriod?: string
    -

    The copyright years to put in the LICENSE file.

    -
    -
    -

    Default

    - current year
    -
    -
    -
    - -
    defaultReleaseBranch: string
    -

    The name of the main release branch.

    -
    -
    -

    Default

    "main"
    -
    -
    -
    - -
    dependabot?: boolean
    -

    Use dependabot to handle dependency upgrades. +

    copyrightPeriod?: string

    The copyright years to put in the LICENSE file.

    +

    Default

    - current year
    +
    +
    defaultReleaseBranch: string

    The name of the main release branch.

    +

    Default

    "main"
    +
    +
    dependabot?: boolean

    Use dependabot to handle dependency upgrades. Cannot be used in conjunction with depsUpgrade.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    dependabotOptions?: DependabotOptions
    -

    Options for dependabot.

    -
    -
    -

    Default

    - default options
    -
    -
    -
    - -
    deps?: string[]
    -

    Runtime dependencies of this module.

    +

    Default

    false
    +
    +
    dependabotOptions?: DependabotOptions

    Options for dependabot.

    +

    Default

    - default options
    +
    +
    deps?: string[]

    Runtime dependencies of this module.

    The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

    -
    -
    -

    Example

    [ 'express', 'lodash', 'foo@^2' ]
    +

    Example

    [ 'express', 'lodash', 'foo@^2' ]
     
    -

    Default

    []
     
    - -

    Featured

    -
    - -
    depsUpgrade?: boolean
    -

    Use tasks and github workflows to handle dependency upgrades. +

    Featured

    depsUpgrade?: boolean

    Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with dependabot.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    depsUpgradeOptions?: UpgradeDependenciesOptions
    -

    Options for UpgradeDependencies.

    -
    -
    -

    Default

    - default options
    -
    -
    -
    - -
    description?: string
    -

    The description is just a string that helps people understand the purpose of the package. +

    Default

    true
    +
    +
    depsUpgradeOptions?: UpgradeDependenciesOptions

    Options for UpgradeDependencies.

    +

    Default

    - default options
    +
    +
    description?: string

    The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description

    -
    -
    -

    Featured

    -
    - -
    devContainer?: boolean
    -

    Add a VSCode development environment (used for GitHub Codespaces)

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    devDeps?: string[]
    -

    Build dependencies for this module. These dependencies will only be +

    Featured

    devContainer?: boolean

    Add a VSCode development environment (used for GitHub Codespaces)

    +

    Default

    false
    +
    +
    devDeps?: string[]

    Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed.

    The recommendation is to only specify the module name here (e.g. @@ -697,554 +340,185 @@

    -
    -

    Example

    [ 'typescript', '@types/express' ]
    +

    Example

    [ 'typescript', '@types/express' ]
     
    -

    Default

    []
     
    - -

    Featured

    -
    - -
    disableTsconfig?: boolean
    -

    Do not generate a tsconfig.json file (used by jsii projects since +

    Featured

    disableTsconfig?: boolean

    Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    disableTsconfigDev?: boolean
    -

    Do not generate a tsconfig.dev.json file.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    docgen?: boolean
    -

    Docgen by Typedoc

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    docsDirectory?: string
    -

    Docs directory

    -
    -
    -

    Default

    "docs"
    -
    -
    -
    - -
    edgeLambdaAutoDiscover?: boolean
    -

    Automatically adds an cloudfront.experimental.EdgeFunction for each +

    Default

    false
    +
    +
    disableTsconfigDev?: boolean

    Do not generate a tsconfig.dev.json file.

    +

    Default

    false
    +
    +
    docgen?: boolean

    Docgen by Typedoc

    +

    Default

    false
    +
    +
    docsDirectory?: string

    Docs directory

    +

    Default

    "docs"
    +
    +
    edgeLambdaAutoDiscover?: boolean

    Automatically adds an cloudfront.experimental.EdgeFunction for each .edge-lambda.ts handler in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    entrypoint?: string
    -

    Module entrypoint (main in package.json)

    +

    Default

    true
    +
    +
    entrypoint?: string

    Module entrypoint (main in package.json)

    Set to an empty string to not include main in your package.json

    -
    -
    -

    Default

    "lib/index.js"
    -
    -
    -
    - -
    entrypointTypes?: string
    -

    The .d.ts file that includes the type declarations for this module.

    -
    -
    -

    Default

    - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
    -
    -
    -
    - -
    eslint?: boolean
    -

    Setup eslint.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    eslintOptions?: EslintOptions
    -

    Eslint options

    -
    -
    -

    Default

    - opinionated default options
    -
    -
    -
    - -
    experimentalIntegRunner?: boolean
    -

    Enable experimental support for the AWS CDK integ-runner.

    -
    -
    -

    Default

    false
    @experimental -
    -
    -
    - -
    featureFlags?: boolean
    -

    Include all feature flags in cdk.json

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    gitIgnoreOptions?: IgnoreFileOptions
    -

    Configuration options for .gitignore file

    -
    -
    -
    - -
    gitOptions?: GitOptions
    -

    Configuration options for git

    -
    -
    -
    - -
    github?: boolean
    -

    Enable GitHub integration.

    +

    Default

    "lib/index.js"
    +
    +
    entrypointTypes?: string

    The .d.ts file that includes the type declarations for this module.

    +

    Default

    - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
    +
    +
    eslint?: boolean

    Setup eslint.

    +

    Default

    true
    +
    +
    eslintOptions?: EslintOptions

    Eslint options

    +

    Default

    - opinionated default options
    +
    +
    experimentalIntegRunner?: boolean

    Enable experimental support for the AWS CDK integ-runner.

    +

    Default

    false
    @experimental +
    +
    featureFlags?: boolean

    Include all feature flags in cdk.json

    +

    Default

    true
    +
    +
    gitIgnoreOptions?: IgnoreFileOptions

    Configuration options for .gitignore file

    +
    gitOptions?: GitOptions

    Configuration options for git

    +
    github?: boolean

    Enable GitHub integration.

    Enabled by default for root projects. Disabled for non-root projects.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    githubOptions?: GitHubOptions
    -

    Options for GitHub integration

    -
    -
    -

    Default

    - see GitHubOptions
    -
    -
    -
    - -
    gitignore?: string[]
    -

    Additional entries to .gitignore

    -
    -
    -
    - -
    gitpod?: boolean
    -

    Add a Gitpod development environment

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    homepage?: string
    -

    Package's Homepage / Website

    -
    -
    -
    - -
    integrationTestAutoDiscover?: boolean
    -

    Automatically discovers and creates integration tests for each .integ.ts +

    Default

    true
    +
    +
    githubOptions?: GitHubOptions

    Options for GitHub integration

    +

    Default

    - see GitHubOptions
    +
    +
    gitignore?: string[]

    Additional entries to .gitignore

    +
    gitpod?: boolean

    Add a Gitpod development environment

    +

    Default

    false
    +
    +
    homepage?: string

    Package's Homepage / Website

    +
    integrationTestAutoDiscover?: boolean

    Automatically discovers and creates integration tests for each .integ.ts file in under your test directory.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    jest?: boolean
    -

    Setup jest unit tests

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    jestOptions?: JestOptions
    -

    Jest options

    -
    -
    -

    Default

    - default options
    -
    -
    -
    - -
    jsiiReleaseVersion?: string
    -

    Version requirement of publib which is used to publish modules to npm.

    -
    -
    -

    Default

    "latest"
    -
    -
    -
    - -
    keywords?: string[]
    -

    Keywords to include in package.json.

    -
    -
    -
    - -
    lambdaAutoDiscover?: boolean
    -

    Automatically adds an awscdk.LambdaFunction for each .lambda.ts handler +

    Default

    true
    +
    +
    jest?: boolean

    Setup jest unit tests

    +

    Default

    true
    +
    +
    jestOptions?: JestOptions

    Jest options

    +

    Default

    - default options
    +
    +
    jsiiReleaseVersion?: string

    Version requirement of publib which is used to publish modules to npm.

    +

    Default

    "latest"
    +
    +
    keywords?: string[]

    Keywords to include in package.json.

    +
    lambdaAutoDiscover?: boolean

    Automatically adds an awscdk.LambdaFunction for each .lambda.ts handler in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    lambdaExtensionAutoDiscover?: boolean
    -

    Automatically adds an awscdk.LambdaExtension for each .lambda-extension.ts +

    Default

    true
    +
    +
    lambdaExtensionAutoDiscover?: boolean

    Automatically adds an awscdk.LambdaExtension for each .lambda-extension.ts entrypoint in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    lambdaOptions?: LambdaFunctionCommonOptions
    -

    Common options for all AWS Lambda functions.

    -
    -
    -

    Default

    - default options
    -
    -
    -
    - -
    libdir?: string
    -

    Typescript artifacts output directory

    -
    -
    -

    Default

    "lib"
    -
    -
    -
    - -
    license?: string
    -

    License's SPDX identifier. +

    Default

    true
    +
    +
    lambdaOptions?: LambdaFunctionCommonOptions

    Common options for all AWS Lambda functions.

    +

    Default

    - default options
    +
    +
    libdir?: string

    Typescript artifacts output directory

    +

    Default

    "lib"
    +
    +
    license?: string

    License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the licensed option if you want to no license to be specified.

    -
    -
    -

    Default

    "Apache-2.0"
    -
    -
    -
    - -
    licensed?: boolean
    -

    Indicates if a license should be added.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    logging?: LoggerOptions
    -

    Configure logging options such as verbosity.

    -
    -
    -

    Default

    {}
    -
    -
    -
    - -
    majorVersion?: number
    -

    Major version to release from the default branch.

    +

    Default

    "Apache-2.0"
    +
    +
    licensed?: boolean

    Indicates if a license should be added.

    +

    Default

    true
    +
    +
    logging?: LoggerOptions

    Configure logging options such as verbosity.

    +

    Default

    {}
    +
    +
    majorVersion?: number

    Major version to release from the default branch.

    If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.

    -
    -
    -

    Default

    - Major version is not enforced.
    -
    -
    -
    - -
    maxNodeVersion?: string
    -

    Minimum node.js version to require via engines (inclusive).

    -
    -
    -

    Default

    - no max
    -
    -
    -
    - -
    mergify?: boolean
    -

    Whether mergify should be enabled on this repository or not.

    -
    -
    -

    Default

    true
    -
    - +

    Default

    - Major version is not enforced.
    +
    +
    maxNodeVersion?: string

    Minimum node.js version to require via engines (inclusive).

    +

    Default

    - no max
    +
    +
    mergify?: boolean

    Whether mergify should be enabled on this repository or not.

    +

    Default

    true
    +

    Deprecated

    use githubOptions.mergify instead

    -
    -
    - -
    mergifyOptions?: MergifyOptions
    -

    Options for mergify

    -
    -
    -

    Default

    - default options
    -
    - +
    mergifyOptions?: MergifyOptions

    Options for mergify

    +

    Default

    - default options
    +

    Deprecated

    use githubOptions.mergifyOptions instead

    -
    -
    - -
    minMajorVersion?: number
    -

    Minimal Major version to release

    +
    minMajorVersion?: number

    Minimal Major version to release

    This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number.

    Can not be set together with majorVersion.

    -
    -
    -

    Default

    - No minimum version is being enforced
    -
    -
    -
    - -
    minNodeVersion?: string
    -

    Minimum Node.js version to require via package.json engines (inclusive).

    -
    -
    -

    Default

    - no "engines" specified
    -
    -
    -
    - -
    mutableBuild?: boolean
    -

    Automatically update files modified during builds to pull-request branches. This means +

    Default

    - No minimum version is being enforced
    +
    +
    minNodeVersion?: string

    Minimum Node.js version to require via package.json engines (inclusive).

    +

    Default

    - no "engines" specified
    +
    +
    mutableBuild?: boolean

    Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.

    Implies that PR builds do not have anti-tamper checks.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    name: string
    -

    This is the name of your project.

    -
    -
    -

    Default

    $BASEDIR
    -
    - -

    Featured

    -
    - -
    npmAccess?: NpmAccess
    -

    Access level of the npm package.

    -
    -
    -

    Default

      +

    Default

    true
    +
    +
    name: string

    This is the name of your project.

    +

    Default

    $BASEDIR
    +
    +

    Featured

    npmAccess?: NpmAccess

    Access level of the npm package.

    +

    Default

    • for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.
    -
    -
    - -
    npmDistTag?: string
    -

    The npmDistTag to use when publishing from the default branch.

    +
    npmDistTag?: string

    The npmDistTag to use when publishing from the default branch.

    To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

    -
    -
    -

    Default

    "latest"
    -
    -
    -
    - -
    npmIgnoreOptions?: IgnoreFileOptions
    -

    Configuration options for .npmignore file

    -
    -
    -
    - -
    npmRegistry?: string
    -

    The host name of the npm registry to publish to. Cannot be set together with npmRegistryUrl.

    -
    -
    -

    Deprecated

    use npmRegistryUrl instead

    -
    -
    - -
    npmRegistryUrl?: string
    -

    The base URL of the npm package registry.

    +

    Default

    "latest"
    +
    +
    npmIgnoreOptions?: IgnoreFileOptions

    Configuration options for .npmignore file

    +
    npmRegistry?: string

    The host name of the npm registry to publish to. Cannot be set together with npmRegistryUrl.

    +

    Deprecated

    use npmRegistryUrl instead

    +
    npmRegistryUrl?: string

    The base URL of the npm package registry.

    Must be a URL (e.g. start with "https://" or "http://")

    -
    -
    -

    Default

    "https://registry.npmjs.org"
    -
    -
    -
    - -
    npmTokenSecret?: string
    -

    GitHub secret which contains the NPM token to use when publishing packages.

    -
    -
    -

    Default

    "NPM_TOKEN"
    -
    -
    -
    - -
    npmignore?: string[]
    -

    Additional entries to .npmignore.

    -
    -
    -

    Deprecated

      +

    Default

    "https://registry.npmjs.org"
    +
    +
    npmTokenSecret?: string

    GitHub secret which contains the NPM token to use when publishing packages.

    +

    Default

    "NPM_TOKEN"
    +
    +
    npmignore?: string[]

    Additional entries to .npmignore.

    +

    Deprecated

    • use project.addPackageIgnore
    -
    -
    - -
    npmignoreEnabled?: boolean
    -

    Defines an .npmignore file. Normally this is only needed for libraries that +

    npmignoreEnabled?: boolean

    Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    outdir?: string
    -

    The root directory of the project.

    +

    Default

    true
    +
    +
    outdir?: string

    The root directory of the project.

    Relative to this directory, all files are synthesized.

    If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects.

    -
    -
    -

    Default

    "."
    -
    -
    -
    - -
    package?: boolean
    -

    Defines a package task that will produce an npm tarball under the +

    Default

    "."
    +
    +
    package?: boolean

    Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    packageManager?: NodePackageManager
    -

    The Node Package Manager used to execute scripts

    -
    -
    -

    Default

    NodePackageManager.YARN_CLASSIC
    -
    -
    -
    - -
    packageName?: string
    -

    The "name" in package.json

    -
    -
    -

    Default

    - defaults to project name
    -
    - -

    Featured

    -
    - -
    parent?: Project
    -

    The parent project, if this project is part of a bigger project.

    -
    -
    -
    - -
    peerDependencyOptions?: PeerDependencyOptions
    -

    Options for peerDeps.

    -
    -
    -
    - -
    peerDeps?: string[]
    -

    Peer dependencies for this module. Dependencies listed here are required to +

    Default

    true
    +
    +
    packageManager?: NodePackageManager

    The Node Package Manager used to execute scripts

    +

    Default

    NodePackageManager.YARN_CLASSIC
    +
    +
    packageName?: string

    The "name" in package.json

    +

    Default

    - defaults to project name
    +
    +

    Featured

    parent?: Project

    The parent project, if this project is part of a bigger project.

    +
    peerDependencyOptions?: PeerDependencyOptions

    Options for peerDeps.

    +
    peerDeps?: string[]

    Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the consumer of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the node_modules tree of your consumers.

    @@ -1255,914 +529,240 @@
    -
    -

    Default

    []
    +

    Default

    []
     
    -
    -
    - -
    pnpmVersion?: string
    -

    The version of PNPM to use if using PNPM as a package manager.

    -
    -
    -

    Default

    "7"
    -
    -
    -
    - -
    postBuildSteps?: JobStep[]
    -

    Steps to execute after build as part of the release workflow.

    -
    -
    -

    Default

    []
    +
    pnpmVersion?: string

    The version of PNPM to use if using PNPM as a package manager.

    +

    Default

    "7"
    +
    +
    postBuildSteps?: JobStep[]

    Steps to execute after build as part of the release workflow.

    +

    Default

    []
     
    -
    -
    - -
    prerelease?: string
    -

    Bump versions from the default branch as pre-releases (e.g. "beta", +

    prerelease?: string

    Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

    -
    -
    -

    Default

    - normal semantic versions
    -
    -
    -
    - -
    prettier?: boolean
    -

    Setup prettier.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    prettierOptions?: PrettierOptions
    -

    Prettier options

    -
    -
    -

    Default

    - default options
    -
    -
    -
    - -
    projectType?: ProjectType
    -

    Which type of project this is (library/app).

    -
    -
    -

    Default

    ProjectType.UNKNOWN
    -
    - +

    Default

    - normal semantic versions
    +
    +
    prettier?: boolean

    Setup prettier.

    +

    Default

    false
    +
    +
    prettierOptions?: PrettierOptions

    Prettier options

    +

    Default

    - default options
    +
    +
    projectType?: ProjectType

    Which type of project this is (library/app).

    +

    Default

    ProjectType.UNKNOWN
    +

    Deprecated

    no longer supported at the base project level

    -
    -
    - -
    projenCommand?: string
    -

    The shell command to use in order to run the projen CLI.

    +
    projenCommand?: string

    The shell command to use in order to run the projen CLI.

    Can be used to customize in special environments.

    -
    -
    -

    Default

    "npx projen"
    -
    -
    -
    - -
    projenCredentials?: GithubCredentials
    -

    Choose a method of providing GitHub API access for projen workflows.

    -
    -
    -

    Default

    - use a personal access token named PROJEN_GITHUB_TOKEN
    -
    -
    -
    - -
    projenDevDependency?: boolean
    -

    Indicates of "projen" should be installed as a devDependency.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    projenTokenSecret?: string
    -

    The name of a secret which includes a GitHub Personal Access Token to be +

    Default

    "npx projen"
    +
    +
    projenCredentials?: GithubCredentials

    Choose a method of providing GitHub API access for projen workflows.

    +

    Default

    - use a personal access token named PROJEN_GITHUB_TOKEN
    +
    +
    projenDevDependency?: boolean

    Indicates of "projen" should be installed as a devDependency.

    +

    Default

    true
    +
    +
    projenTokenSecret?: string

    The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the repo, workflows and packages scope.

    -
    -
    -

    Default

    "PROJEN_GITHUB_TOKEN"
    +

    Default

    "PROJEN_GITHUB_TOKEN"
     
    -

    Deprecated

    use projenCredentials

    -
    -
    - -
    projenVersion?: string
    -

    Version of projen to install.

    -
    -
    -

    Default

    - Defaults to the latest version.
    -
    -
    -
    - -
    projenrcJs?: boolean
    -

    Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable +

    projenVersion?: string

    Version of projen to install.

    +

    Default

    - Defaults to the latest version.
    +
    +
    projenrcJs?: boolean

    Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.

    -
    -
    -

    Default

    - true if projenrcJson is false
    -
    -
    -
    - -
    projenrcJsOptions?: ProjenrcOptions
    -

    Options for .projenrc.js

    -
    -
    -

    Default

    - default options
    -
    -
    -
    - -
    projenrcJson?: boolean
    -

    Generate (once) .projenrc.json (in JSON). Set to false in order to disable +

    Default

    - true if projenrcJson is false
    +
    +
    projenrcJsOptions?: ProjenrcOptions

    Options for .projenrc.js

    +

    Default

    - default options
    +
    +
    projenrcJson?: boolean

    Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    projenrcJsonOptions?: ProjenrcJsonOptions
    -

    Options for .projenrc.json

    -
    -
    -

    Default

    - default options
    -
    -
    -
    - -
    projenrcTs?: boolean
    -

    Use TypeScript for your projenrc file (.projenrc.ts).

    -
    -
    -

    Default

    false
    -
    - +

    Default

    false
    +
    +
    projenrcJsonOptions?: ProjenrcJsonOptions

    Options for .projenrc.json

    +

    Default

    - default options
    +
    +
    projenrcTs?: boolean

    Use TypeScript for your projenrc file (.projenrc.ts).

    +

    Default

    false
    +

    Pjnew

    true

    -
    -
    - -
    projenrcTsOptions?: ProjenrcOptions
    -

    Options for .projenrc.ts

    -
    -
    -
    - -
    publishDryRun?: boolean
    -

    Instead of actually publishing to package managers, just print the publishing command.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    publishTasks?: boolean
    -

    Define publishing tasks that can be executed manually as well as workflows.

    +
    projenrcTsOptions?: ProjenrcOptions

    Options for .projenrc.ts

    +
    publishDryRun?: boolean

    Instead of actually publishing to package managers, just print the publishing command.

    +

    Default

    false
    +
    +
    publishTasks?: boolean

    Define publishing tasks that can be executed manually as well as workflows.

    Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    pullRequestTemplate?: boolean
    -

    Include a GitHub pull request template.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    pullRequestTemplateContents?: string[]
    -

    The contents of the pull request template.

    -
    -
    -

    Default

    - default content
    -
    -
    -
    - -
    readme?: SampleReadmeProps
    -

    The README setup.

    -
    -
    -

    Default

    - { filename: 'README.md', contents: '# replace this' }
    -
    - +

    Default

    false
    +
    +
    pullRequestTemplate?: boolean

    Include a GitHub pull request template.

    +

    Default

    true
    +
    +
    pullRequestTemplateContents?: string[]

    The contents of the pull request template.

    +

    Default

    - default content
    +
    +
    readme?: SampleReadmeProps

    The README setup.

    +

    Default

    - { filename: 'README.md', contents: '# replace this' }
    +

    Example

    "{ filename: 'readme.md', contents: '# title' }"
     
    -
    -
    - -
    releasableCommits?: ReleasableCommits
    -

    Find commits that should be considered releasable +

    releasableCommits?: ReleasableCommits

    Find commits that should be considered releasable Used to decide if a release is required.

    -
    -
    -

    Default

    ReleasableCommits.everyCommit()
    -
    -
    -
    - -
    release?: boolean
    -

    Add release management to this project.

    -
    -
    -

    Default

    - true (false for subprojects)
    -
    -
    -
    - -
    releaseBranches?: {
        [name: string]: BranchOptions;
    }
    -

    Defines additional release branches. A workflow will be created for each +

    Default

    ReleasableCommits.everyCommit()
    +
    +
    release?: boolean

    Add release management to this project.

    +

    Default

    - true (false for subprojects)
    +
    +
    releaseBranches?: {
        [name: string]: BranchOptions;
    }

    Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: BranchOptions
    -
    -

    Default

      +

    Type declaration

    • [name: string]: BranchOptions

    Default

    • no additional branches are used for release. you can use addBranch() to add additional branches.
    -
    -
    - -
    releaseEveryCommit?: boolean
    -

    Automatically release new versions every commit to one of branches in releaseBranches.

    -
    -
    -

    Default

    true
    -
    - +
    releaseEveryCommit?: boolean

    Automatically release new versions every commit to one of branches in releaseBranches.

    +

    Default

    true
    +

    Deprecated

    Use releaseTrigger: ReleaseTrigger.continuous() instead

    -
    -
    - -
    releaseFailureIssue?: boolean
    -

    Create a github issue on every failed publishing task.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    releaseFailureIssueLabel?: string
    -

    The label to apply to issues indicating publish failures. +

    releaseFailureIssue?: boolean

    Create a github issue on every failed publishing task.

    +

    Default

    false
    +
    +
    releaseFailureIssueLabel?: string

    The label to apply to issues indicating publish failures. Only applies if releaseFailureIssue is true.

    -
    -
    -

    Default

    "failed-release"
    -
    -
    -
    - -
    releaseSchedule?: string
    -

    CRON schedule to trigger new releases.

    -
    -
    -

    Default

    - no scheduled releases
    -
    - +

    Default

    "failed-release"
    +
    +
    releaseSchedule?: string

    CRON schedule to trigger new releases.

    +

    Default

    - no scheduled releases
    +

    Deprecated

    Use releaseTrigger: ReleaseTrigger.scheduled() instead

    -
    -
    - -
    releaseTagPrefix?: string
    -

    Automatically add the given prefix to release tags. +

    releaseTagPrefix?: string

    Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.

    Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix.

    -
    -
    -

    Default

    "v"
    -
    -
    -
    - -
    releaseToNpm?: boolean
    -

    Automatically release to npm when new versions are introduced.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    releaseTrigger?: ReleaseTrigger
    -

    The release trigger to use.

    -
    -
    -

    Default

      +

    Default

    "v"
    +
    +
    releaseToNpm?: boolean

    Automatically release to npm when new versions are introduced.

    +

    Default

    false
    +
    +
    releaseTrigger?: ReleaseTrigger

    The release trigger to use.

    +

    Default

    • Continuous releases (ReleaseTrigger.continuous())
    -
    -
    - -
    releaseWorkflow?: boolean
    -

    DEPRECATED: renamed to release.

    -
    -
    -

    Default

    - true if not a subproject
    -
    - +
    releaseWorkflow?: boolean

    DEPRECATED: renamed to release.

    +

    Default

    - true if not a subproject
    +

    Deprecated

    see release.

    -
    -
    - -
    releaseWorkflowName?: string
    -

    The name of the default release workflow.

    -
    -
    -

    Default

    "Release"
    -
    -
    -
    - -
    releaseWorkflowSetupSteps?: JobStep[]
    -

    A set of workflow steps to execute in order to setup the workflow +

    releaseWorkflowName?: string

    The name of the default release workflow.

    +

    Default

    "Release"
    +
    +
    releaseWorkflowSetupSteps?: JobStep[]

    A set of workflow steps to execute in order to setup the workflow container.

    -
    -
    -
    - -
    renovatebot?: boolean
    -

    Use renovatebot to handle dependency upgrades.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    renovatebotOptions?: RenovatebotOptions
    -

    Options for renovatebot.

    -
    -
    -

    Default

    - default options
    -
    -
    -
    - -
    repository?: string
    -

    The repository is the location where the actual code for your package lives. +

    renovatebot?: boolean

    Use renovatebot to handle dependency upgrades.

    +

    Default

    false
    +
    +
    renovatebotOptions?: RenovatebotOptions

    Options for renovatebot.

    +

    Default

    - default options
    +
    +
    repository?: string

    The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository

    -
    -
    -
    - -
    repositoryDirectory?: string
    -

    If the package.json for your package is not in the root directory (for example if it is part of a monorepo), +

    repositoryDirectory?: string

    If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.

    -
    -
    -
    - -
    requireApproval?: ApprovalLevel
    -

    To protect you against unintended changes that affect your security posture, +

    requireApproval?: ApprovalLevel

    To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.

    -
    -
    -

    Default

    ApprovalLevel.BROADENING
    -
    -
    -
    - -
    sampleCode?: boolean
    -

    Generate one-time sample in src/ and test/ if there are no files there.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    scopedPackagesOptions?: ScopedPackagesOptions[]
    -

    Options for privately hosted scoped packages

    -
    -
    -

    Default

    - fetch all scoped packages from the public npm registry
    -
    -
    -
    - -
    scripts?: {
        [name: string]: string;
    }
    -

    npm scripts to include. If a script has the same name as a standard script, +

    Default

    ApprovalLevel.BROADENING
    +
    +
    sampleCode?: boolean

    Generate one-time sample in src/ and test/ if there are no files there.

    +

    Default

    true
    +
    +
    scopedPackagesOptions?: ScopedPackagesOptions[]

    Options for privately hosted scoped packages

    +

    Default

    - fetch all scoped packages from the public npm registry
    +
    +
    scripts?: {
        [name: string]: string;
    }

    npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task.

    -
    -
    -

    Type declaration

    -
      -
    • -
      [name: string]: string
    -
    -

    Default

    {}
    -
    - +

    Type declaration

    • [name: string]: string

    Default

    {}
    +

    Deprecated

    use project.addTask() or package.setScript()

    -
    -
    - -
    srcdir?: string
    -

    Typescript sources directory.

    -
    -
    -

    Default

    "src"
    -
    -
    -
    - -
    stability?: string
    -

    Package's Stability

    -
    -
    -
    - -
    stale?: boolean
    -

    Auto-close of stale issues and pull request. See staleOptions for options.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    staleOptions?: StaleOptions
    -

    Auto-close stale issues and pull requests. To disable set stale to false.

    -
    -
    -

    Default

      +
    srcdir?: string

    Typescript sources directory.

    +

    Default

    "src"
    +
    +
    stability?: string

    Package's Stability

    +
    stale?: boolean

    Auto-close of stale issues and pull request. See staleOptions for options.

    +

    Default

    false
    +
    +
    staleOptions?: StaleOptions

    Auto-close stale issues and pull requests. To disable set stale to false.

    +

    Default

    • see defaults in StaleOptions
    -
    -
    - -
    testdir?: string
    -

    Jest tests directory. Tests files should be named xxx.test.ts.

    +
    testdir?: string

    Jest tests directory. Tests files should be named xxx.test.ts.

    If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.

    -
    -
    -

    Default

    "test"
    -
    -
    -
    - -
    tsJestOptions?: TsJestOptions
    -

    Options for ts-jest

    -
    -
    -
    - -
    tsconfig?: TypescriptConfigOptions
    -

    Custom TSConfig

    -
    -
    -

    Default

    - default options
    -
    -
    -
    - -
    tsconfigDev?: TypescriptConfigOptions
    -

    Custom tsconfig options for the development tsconfig.json file (used for testing).

    -
    -
    -

    Default

    - use the production tsconfig options
    -
    -
    -
    - -
    tsconfigDevFile?: string
    -

    The name of the development tsconfig.json file.

    -
    -
    -

    Default

    "tsconfig.dev.json"
    -
    -
    -
    - -
    typescriptVersion?: string
    -

    TypeScript version to use.

    +

    Default

    "test"
    +
    +
    tsJestOptions?: TsJestOptions

    Options for ts-jest

    +
    tsconfig?: TypescriptConfigOptions

    Custom TSConfig

    +

    Default

    - default options
    +
    +
    tsconfigDev?: TypescriptConfigOptions

    Custom tsconfig options for the development tsconfig.json file (used for testing).

    +

    Default

    - use the production tsconfig options
    +
    +
    tsconfigDevFile?: string

    The name of the development tsconfig.json file.

    +

    Default

    "tsconfig.dev.json"
    +
    +
    typescriptVersion?: string

    TypeScript version to use.

    NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~1.2.3).

    -
    -
    -

    Default

    "latest"
    -
    -
    -
    - -
    versionrcOptions?: Record<string, any>
    -

    Custom configuration used when creating changelog with standard-version package. +

    Default

    "latest"
    +
    +
    versionrcOptions?: Record<string, any>

    Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it.

    -
    -
    -

    Default

    - standard configuration applicable for GitHub repositories
    -
    -
    -
    - -
    vscode?: boolean
    -

    Enable VSCode integration.

    +

    Default

    - standard configuration applicable for GitHub repositories
    +
    +
    vscode?: boolean

    Enable VSCode integration.

    Enabled by default for root projects. Disabled for non-root projects.

    -
    -
    -

    Default

    true
    -
    -
    -
    - -
    watchExcludes?: string[]
    -

    Glob patterns to exclude from cdk watch.

    -
    -
    -

    Default

    []
    +

    Default

    true
     
    -
    -
    - -
    watchIncludes?: string[]
    -

    Glob patterns to include in cdk watch.

    -
    -
    -

    Default

    []
    +
    watchExcludes?: string[]

    Glob patterns to exclude from cdk watch.

    +

    Default

    []
     
    -
    -
    - -
    workflowBootstrapSteps?: JobStep[]
    -

    Workflow steps to use in order to bootstrap this repo.

    -
    -
    -

    Default

    "yarn install --frozen-lockfile && yarn projen"
    -
    -
    -
    - -
    workflowContainerImage?: string
    -

    Container image to use for GitHub workflows.

    -
    -
    -

    Default

    - default image
    -
    -
    -
    - -
    workflowGitIdentity?: GitIdentity
    -

    The git identity to use in workflows.

    -
    -
    -

    Default

    - GitHub Actions
    -
    -
    -
    - -
    workflowNodeVersion?: string
    -

    The node version to use in GitHub workflows.

    -
    -
    -

    Default

      +
    watchIncludes?: string[]

    Glob patterns to include in cdk watch.

    +

    Default

    []
    +
    +
    workflowBootstrapSteps?: JobStep[]

    Workflow steps to use in order to bootstrap this repo.

    +

    Default

    "yarn install --frozen-lockfile && yarn projen"
    +
    +
    workflowContainerImage?: string

    Container image to use for GitHub workflows.

    +

    Default

    - default image
    +
    +
    workflowGitIdentity?: GitIdentity

    The git identity to use in workflows.

    +

    Default

    - GitHub Actions
    +
    +
    workflowNodeVersion?: string

    The node version to use in GitHub workflows.

    +

    Default

    • same as minNodeVersion
    -
    -
    - -
    workflowPackageCache?: boolean
    -

    Enable Node.js package cache in GitHub workflows.

    -
    -
    -

    Default

    false
    -
    -
    -
    - -
    workflowRunsOn?: string[]
    -

    Github Runner selection labels

    -
    -
    -

    Default

    ["ubuntu-latest"]
    -
    - +
    workflowPackageCache?: boolean

    Enable Node.js package cache in GitHub workflows.

    +

    Default

    false
    +
    +
    workflowRunsOn?: string[]

    Github Runner selection labels

    +

    Default

    ["ubuntu-latest"]
    +

    Description

    Defines a target Runner by labels

    -

    Throws

    if both runsOn and runsOnGroup are specified

    -
    -
    - -
    workflowRunsOnGroup?: GroupRunnerOptions
    -

    Github Runner Group selection options

    -
    -
    -

    Description

    Defines a target Runner Group by name and/or labels

    - +
    workflowRunsOnGroup?: GroupRunnerOptions

    Github Runner Group selection options

    +

    Description

    Defines a target Runner Group by name and/or labels

    Throws

    if both runsOn and runsOnGroup are specified

    -
    -
    - -
    yarnBerryOptions?: YarnBerryOptions
    -

    Options for Yarn Berry

    -
    -
    -

    Default

    - Yarn Berry v4 with all default options
    -
    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +
    yarnBerryOptions?: YarnBerryOptions

    Options for Yarn Berry

    +

    Default

    - Yarn Berry v4 with all default options
    +
    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/interfaces/WorkflowOptions.html b/docs/projen/interfaces/WorkflowOptions.html index 7aead9c..7e76572 100644 --- a/docs/projen/interfaces/WorkflowOptions.html +++ b/docs/projen/interfaces/WorkflowOptions.html @@ -1,77 +1,3 @@ -WorkflowOptions | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Interface WorkflowOptions

    -
    -

    Hierarchy

    -
      -
    • WorkflowOptions
    -
    -
    -
    - -
    -
    -

    Properties

    -
    definitionFile +WorkflowOptions | cdk-serverless

    Interface WorkflowOptions

    interface WorkflowOptions {
        definitionFile: string;
        workflowName: string;
    }
    -
    -

    Properties

    -
    - -
    definitionFile: string
    -
    - -
    workflowName: string
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    definitionFile: string
    workflowName: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/modules.html b/docs/projen/modules.html index 922566e..1bd5932 100644 --- a/docs/projen/modules.html +++ b/docs/projen/modules.html @@ -1,69 +1,12 @@ -cdk-serverless
    -
    - -
    -
    -
    -
    -

    cdk-serverless

    -
    -
    -

    Index

    -
    -

    Classes

    -
    Datastore +cdk-serverless
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Variables

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/projen/variables/PACKAGE_NAME.html b/docs/projen/variables/PACKAGE_NAME.html index 62bcae1..c91f598 100644 --- a/docs/projen/variables/PACKAGE_NAME.html +++ b/docs/projen/variables/PACKAGE_NAME.html @@ -1,50 +1 @@ -PACKAGE_NAME | cdk-serverless
    -
    - -
    -
    -
    -
    - -

    Variable PACKAGE_NAMEConst

    -
    PACKAGE_NAME: "cdk-serverless" = 'cdk-serverless'
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +PACKAGE_NAME | cdk-serverless

    Variable PACKAGE_NAMEConst

    PACKAGE_NAME: "cdk-serverless" = 'cdk-serverless'

    Generated using TypeDoc

    \ No newline at end of file diff --git a/package.json b/package.json index 2a627f4..a98e389 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,7 @@ "devDependencies": { "@aws-cdk/aws-cognito-identitypool-alpha": "2.60.0-alpha.0", "@hapi/boom": "^10.0.1", - "@taimos/projen": "^0.0.187", + "@taimos/projen": "^0.0.188", "@types/aws-lambda": "^8.10.130", "@types/jest": "^29.5.11", "@types/js-yaml": "^4.0.9", @@ -47,7 +47,7 @@ "@typescript-eslint/parser": "^6", "aws-cdk-lib": "2.60.0", "constructs": "10.0.5", - "dynamodb-onetable": "~2.6.4", + "dynamodb-onetable": "~2.7.1", "eslint": "^8", "eslint-import-resolver-typescript": "^3.6.1", "eslint-plugin-import": "^2.29.1", @@ -58,8 +58,8 @@ "standard-version": "^9", "ts-jest": "^29.1.1", "ts-node": "^10.9.2", - "typedoc": "0.25.0", - "typescript": "^4.4.0" + "typedoc": "0.25.4", + "typescript": "^4.9.5" }, "peerDependencies": { "@aws-cdk/aws-cognito-identitypool-alpha": "^2.60.0-alpha.0", diff --git a/yarn.lock b/yarn.lock index 9bc3889..e6eb305 100644 --- a/yarn.lock +++ b/yarn.lock @@ -90,27 +90,27 @@ "@aws-sdk/util-utf8-browser" "^3.0.0" tslib "^1.11.1" -"@aws-sdk/client-dynamodb@^3.363.0": - version "3.481.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/client-dynamodb/-/client-dynamodb-3.481.0.tgz#9466026a4c155de0bccedf69b7d3d123e321f72d" - integrity sha512-u0RsYgAE9CmykwEwydQgWKL7/PX0JQlmytMfntsmgkU0VenhQk/DctzWGpvkZpQasIFtOihhlhXPV0xcZIaN/g== +"@aws-sdk/client-dynamodb@^3.410.0", "@aws-sdk/client-dynamodb@^3.418.0": + version "3.484.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/client-dynamodb/-/client-dynamodb-3.484.0.tgz#11e0c26f1c87dc5cd62de663ff00eefe91f81282" + integrity sha512-yCOzitHeeSbauH5LK0SZF4wgpYzfOBiRU8gHp75Xs+kG8QT+kBmtsjoaa6tmtvtCgqWgujuFqv7Gzd2GEePEgw== dependencies: "@aws-crypto/sha256-browser" "3.0.0" "@aws-crypto/sha256-js" "3.0.0" - "@aws-sdk/client-sts" "3.481.0" + "@aws-sdk/client-sts" "3.484.0" "@aws-sdk/core" "3.481.0" - "@aws-sdk/credential-provider-node" "3.481.0" + "@aws-sdk/credential-provider-node" "3.484.0" "@aws-sdk/middleware-endpoint-discovery" "3.470.0" "@aws-sdk/middleware-host-header" "3.468.0" "@aws-sdk/middleware-logger" "3.468.0" "@aws-sdk/middleware-recursion-detection" "3.468.0" "@aws-sdk/middleware-user-agent" "3.478.0" - "@aws-sdk/region-config-resolver" "3.470.0" + "@aws-sdk/region-config-resolver" "3.484.0" "@aws-sdk/types" "3.468.0" "@aws-sdk/util-endpoints" "3.478.0" "@aws-sdk/util-user-agent-browser" "3.468.0" "@aws-sdk/util-user-agent-node" "3.470.0" - "@smithy/config-resolver" "^2.0.21" + "@smithy/config-resolver" "^2.0.22" "@smithy/core" "^1.2.1" "@smithy/fetch-http-handler" "^2.3.1" "@smithy/hash-node" "^2.0.17" @@ -130,7 +130,7 @@ "@smithy/util-body-length-browser" "^2.0.1" "@smithy/util-body-length-node" "^2.1.0" "@smithy/util-defaults-mode-browser" "^2.0.23" - "@smithy/util-defaults-mode-node" "^2.0.30" + "@smithy/util-defaults-mode-node" "^2.0.31" "@smithy/util-endpoints" "^1.0.7" "@smithy/util-middleware" "^2.0.8" "@smithy/util-retry" "^2.0.8" @@ -139,10 +139,10 @@ tslib "^2.5.0" uuid "^8.3.2" -"@aws-sdk/client-sso@3.481.0": - version "3.481.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/client-sso/-/client-sso-3.481.0.tgz#5d484dfa202eac580db984bb2c9cf52203b9a985" - integrity sha512-d+crFfW8HSDXa68MSfMDX6LH0J22P29SxJW4IGgRZKwHWEaSf4UjOP0mjA4V26R50suAV052/WBY6LjtGsZsHg== +"@aws-sdk/client-sso@3.484.0": + version "3.484.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/client-sso/-/client-sso-3.484.0.tgz#3fffe4229c0883286c08f60f1fc5d83f1a989e7d" + integrity sha512-eHKXDHqgPt99977hNissa1y/efwXZ9kg3EKPLK13b6VzTC8s0+Ih+YZemNE22ahw6SYnRiGglYdkdypJ/uPHkg== dependencies: "@aws-crypto/sha256-browser" "3.0.0" "@aws-crypto/sha256-js" "3.0.0" @@ -151,12 +151,12 @@ "@aws-sdk/middleware-logger" "3.468.0" "@aws-sdk/middleware-recursion-detection" "3.468.0" "@aws-sdk/middleware-user-agent" "3.478.0" - "@aws-sdk/region-config-resolver" "3.470.0" + "@aws-sdk/region-config-resolver" "3.484.0" "@aws-sdk/types" "3.468.0" "@aws-sdk/util-endpoints" "3.478.0" "@aws-sdk/util-user-agent-browser" "3.468.0" "@aws-sdk/util-user-agent-node" "3.470.0" - "@smithy/config-resolver" "^2.0.21" + "@smithy/config-resolver" "^2.0.22" "@smithy/core" "^1.2.1" "@smithy/fetch-http-handler" "^2.3.1" "@smithy/hash-node" "^2.0.17" @@ -176,31 +176,31 @@ "@smithy/util-body-length-browser" "^2.0.1" "@smithy/util-body-length-node" "^2.1.0" "@smithy/util-defaults-mode-browser" "^2.0.23" - "@smithy/util-defaults-mode-node" "^2.0.30" + "@smithy/util-defaults-mode-node" "^2.0.31" "@smithy/util-endpoints" "^1.0.7" "@smithy/util-retry" "^2.0.8" "@smithy/util-utf8" "^2.0.2" tslib "^2.5.0" -"@aws-sdk/client-sts@3.481.0": - version "3.481.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/client-sts/-/client-sts-3.481.0.tgz#4aa7d1d5fff175b3b9e30dd891cd8b7e127c997f" - integrity sha512-GSnJiceKpwLSEW5q2KRu9zHNJgtYysiy9Xkey0EKLKCdDRdM62yCJEFerAbvRRVJsF2LTSrmBmUl2zWB5RT8mw== +"@aws-sdk/client-sts@3.484.0": + version "3.484.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/client-sts/-/client-sts-3.484.0.tgz#57f84be8f0acf7b4fcbb666197282fcc1a04da97" + integrity sha512-psQxH0mYhTVvZhfca3s9NbXgnuOM8l+5LtF7fZBF5y4xaPpfAPicPWp6po69J3ynwyXi/MpHNXd/13d/L09TTA== dependencies: "@aws-crypto/sha256-browser" "3.0.0" "@aws-crypto/sha256-js" "3.0.0" "@aws-sdk/core" "3.481.0" - "@aws-sdk/credential-provider-node" "3.481.0" + "@aws-sdk/credential-provider-node" "3.484.0" "@aws-sdk/middleware-host-header" "3.468.0" "@aws-sdk/middleware-logger" "3.468.0" "@aws-sdk/middleware-recursion-detection" "3.468.0" "@aws-sdk/middleware-user-agent" "3.478.0" - "@aws-sdk/region-config-resolver" "3.470.0" + "@aws-sdk/region-config-resolver" "3.484.0" "@aws-sdk/types" "3.468.0" "@aws-sdk/util-endpoints" "3.478.0" "@aws-sdk/util-user-agent-browser" "3.468.0" "@aws-sdk/util-user-agent-node" "3.470.0" - "@smithy/config-resolver" "^2.0.21" + "@smithy/config-resolver" "^2.0.22" "@smithy/core" "^1.2.1" "@smithy/fetch-http-handler" "^2.3.1" "@smithy/hash-node" "^2.0.17" @@ -220,7 +220,7 @@ "@smithy/util-body-length-browser" "^2.0.1" "@smithy/util-body-length-node" "^2.1.0" "@smithy/util-defaults-mode-browser" "^2.0.23" - "@smithy/util-defaults-mode-node" "^2.0.30" + "@smithy/util-defaults-mode-node" "^2.0.31" "@smithy/util-endpoints" "^1.0.7" "@smithy/util-middleware" "^2.0.8" "@smithy/util-retry" "^2.0.8" @@ -250,14 +250,14 @@ "@smithy/types" "^2.7.0" tslib "^2.5.0" -"@aws-sdk/credential-provider-ini@3.481.0": - version "3.481.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-ini/-/credential-provider-ini-3.481.0.tgz#02300c2f044c88749790bdfba74d99131234cf9c" - integrity sha512-QXMlILewLV/yQHkyjXsu7PhvmTZIDAaQ4uAfhjnqbH1B8mErRpZKkzHWwp4yeZdTcHfenTVqoTnx9WDa+SnK/Q== +"@aws-sdk/credential-provider-ini@3.484.0": + version "3.484.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-ini/-/credential-provider-ini-3.484.0.tgz#558cb307a61afdee942987cc9735969f3d272675" + integrity sha512-BbvU7seI0RPPwpujnz4LA1lC53Cj4BOSRpYYZbrxA6C7SzW0D/IQBZQP3JBbrxIhqewSROSsYGDjvYbyi5aDEw== dependencies: "@aws-sdk/credential-provider-env" "3.468.0" "@aws-sdk/credential-provider-process" "3.468.0" - "@aws-sdk/credential-provider-sso" "3.481.0" + "@aws-sdk/credential-provider-sso" "3.484.0" "@aws-sdk/credential-provider-web-identity" "3.468.0" "@aws-sdk/types" "3.468.0" "@smithy/credential-provider-imds" "^2.0.0" @@ -266,15 +266,15 @@ "@smithy/types" "^2.7.0" tslib "^2.5.0" -"@aws-sdk/credential-provider-node@3.481.0": - version "3.481.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-node/-/credential-provider-node-3.481.0.tgz#3bcc2577bb89ac2123f583e5d9b2d60e5dbea3b3" - integrity sha512-148Ztn2FjlS3VdGWJnAMjuXiZ55/tD823I/koawgp80LnDqMiKfmSGAioXIikqaBHl40K7ZvtBMqP/n/6GM41A== +"@aws-sdk/credential-provider-node@3.484.0": + version "3.484.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-node/-/credential-provider-node-3.484.0.tgz#4b7373724fef95374717e3fc83587ed696c8adbb" + integrity sha512-Ylqej3FqRwUD3I7929k214LRH1bUz7f2hfV4ZqY7teM9hQC5Ov5SpVtOtLKNfgaaxAkhD2ffMNfmq8TAg824+g== dependencies: "@aws-sdk/credential-provider-env" "3.468.0" - "@aws-sdk/credential-provider-ini" "3.481.0" + "@aws-sdk/credential-provider-ini" "3.484.0" "@aws-sdk/credential-provider-process" "3.468.0" - "@aws-sdk/credential-provider-sso" "3.481.0" + "@aws-sdk/credential-provider-sso" "3.484.0" "@aws-sdk/credential-provider-web-identity" "3.468.0" "@aws-sdk/types" "3.468.0" "@smithy/credential-provider-imds" "^2.0.0" @@ -294,13 +294,13 @@ "@smithy/types" "^2.7.0" tslib "^2.5.0" -"@aws-sdk/credential-provider-sso@3.481.0": - version "3.481.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-sso/-/credential-provider-sso-3.481.0.tgz#0a5b37407a087df0f1a1aaf181d94555807b0e9b" - integrity sha512-3MrSIQPQDOxhZDppC2XpOLVfuUm7iqRfTrwjSYGeWc//pUZtUI7nMXYjEDL+li5gvasw1lYfYX3VHNdwNnvyOQ== +"@aws-sdk/credential-provider-sso@3.484.0": + version "3.484.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/credential-provider-sso/-/credential-provider-sso-3.484.0.tgz#3e639d45c674557c4d2505140ff2d031d2decab7" + integrity sha512-Fl7+YhrlU2icZkz18z9aj4SiWb2aQlWp5LsVqMfSzTlJFc9yPlD9e7F33gnL7kKLVSnAVxsr5v4y4pFC6FZUSw== dependencies: - "@aws-sdk/client-sso" "3.481.0" - "@aws-sdk/token-providers" "3.481.0" + "@aws-sdk/client-sso" "3.484.0" + "@aws-sdk/token-providers" "3.484.0" "@aws-sdk/types" "3.468.0" "@smithy/property-provider" "^2.0.0" "@smithy/shared-ini-file-loader" "^2.0.6" @@ -377,21 +377,21 @@ "@smithy/types" "^2.7.0" tslib "^2.5.0" -"@aws-sdk/region-config-resolver@3.470.0": - version "3.470.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/region-config-resolver/-/region-config-resolver-3.470.0.tgz#74e5c5f7a5633ad8c482503bf940a9330bd1cd09" - integrity sha512-C1o1J06iIw8cyAAOvHqT4Bbqf+PgQ/RDlSyjt2gFfP2OovDpc2o2S90dE8f8iZdSGpg70N5MikT1DBhW9NbhtQ== +"@aws-sdk/region-config-resolver@3.484.0": + version "3.484.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/region-config-resolver/-/region-config-resolver-3.484.0.tgz#fb480b68a3c1b2bddf1c67eecf8b8966114179f7" + integrity sha512-qfYSwSIc9GasHFrJidydlQE433mB93d31dfypFWhrJPXRv1fhopO72NSfsY2WCcbaRkADc4AajLZFly4J96abw== dependencies: "@smithy/node-config-provider" "^2.1.8" "@smithy/types" "^2.7.0" - "@smithy/util-config-provider" "^2.0.0" + "@smithy/util-config-provider" "^2.1.0" "@smithy/util-middleware" "^2.0.8" tslib "^2.5.0" -"@aws-sdk/token-providers@3.481.0": - version "3.481.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/token-providers/-/token-providers-3.481.0.tgz#d10f86a3c3d61ee2917c70ecc43923d6d2a3d263" - integrity sha512-G4ObHF2A/FlvQG7Lb/2sjuklG89IiH3TI1EiNZSzgu6TvY904Js72Slldls4VeJLY2zAnZgyZ9903pBMkDrcxQ== +"@aws-sdk/token-providers@3.484.0": + version "3.484.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/token-providers/-/token-providers-3.484.0.tgz#68ee9b3e99a0fac943963e81340fee555e10e3c9" + integrity sha512-9Eb7X0sNhJANfYCeEYWCvfeD4shMZEse3YUz5EALzbpzi/So56ZaeA/lWWeh0fkYiByq74eA2QkC/tXZkHw6EQ== dependencies: "@aws-crypto/sha256-browser" "3.0.0" "@aws-crypto/sha256-js" "3.0.0" @@ -399,12 +399,12 @@ "@aws-sdk/middleware-logger" "3.468.0" "@aws-sdk/middleware-recursion-detection" "3.468.0" "@aws-sdk/middleware-user-agent" "3.478.0" - "@aws-sdk/region-config-resolver" "3.470.0" + "@aws-sdk/region-config-resolver" "3.484.0" "@aws-sdk/types" "3.468.0" "@aws-sdk/util-endpoints" "3.478.0" "@aws-sdk/util-user-agent-browser" "3.468.0" "@aws-sdk/util-user-agent-node" "3.470.0" - "@smithy/config-resolver" "^2.0.21" + "@smithy/config-resolver" "^2.0.22" "@smithy/fetch-http-handler" "^2.3.1" "@smithy/hash-node" "^2.0.17" "@smithy/invalid-dependency" "^2.0.15" @@ -425,7 +425,7 @@ "@smithy/util-body-length-browser" "^2.0.1" "@smithy/util-body-length-node" "^2.1.0" "@smithy/util-defaults-mode-browser" "^2.0.23" - "@smithy/util-defaults-mode-node" "^2.0.30" + "@smithy/util-defaults-mode-node" "^2.0.31" "@smithy/util-endpoints" "^1.0.7" "@smithy/util-retry" "^2.0.8" "@smithy/util-utf8" "^2.0.2" @@ -439,10 +439,10 @@ "@smithy/types" "^2.7.0" tslib "^2.5.0" -"@aws-sdk/util-dynamodb@^3.363.0": - version "3.481.0" - resolved "https://registry.yarnpkg.com/@aws-sdk/util-dynamodb/-/util-dynamodb-3.481.0.tgz#cbccae437918aee26875678d444497d9e6c446e7" - integrity sha512-43okW9YKT2YyUPVbLvrXjzAEptoHyWL4SdzWHbaxNJiEBVn7pq6eYqWzgWAnH12Vz1wbRP/iYWU/ZzwaozzA9w== +"@aws-sdk/util-dynamodb@^3.410.0", "@aws-sdk/util-dynamodb@^3.418.0": + version "3.484.0" + resolved "https://registry.yarnpkg.com/@aws-sdk/util-dynamodb/-/util-dynamodb-3.484.0.tgz#21aaeb9b9a87eab0f6abc34119cdbddc97a53b5d" + integrity sha512-IttZ0i26CBEElCSJ6R2ccOGqOeEHp99Vdh/k+jNfpaRKP1gigJfJWzO7I2rUGjaO9AO7kFL8/P2nRqPg3deAGQ== dependencies: tslib "^2.5.0" @@ -503,19 +503,19 @@ integrity sha512-uU27kfDRlhfKl+w1U6vp16IuvSLtjAxdArVXPa9BvLkrr7CYIsxH5adpHObeAGY/41+syctUWOZ140a2Rvkgjw== "@babel/core@^7.11.6", "@babel/core@^7.12.3": - version "7.23.6" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.23.6.tgz#8be77cd77c55baadcc1eae1c33df90ab6d2151d4" - integrity sha512-FxpRyGjrMJXh7X3wGLGhNDCRiwpWEF74sKjTLDJSG5Kyvow3QZaG0Adbqzi9ZrVjTWpsX+2cxWXD71NMg93kdw== + version "7.23.7" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.23.7.tgz#4d8016e06a14b5f92530a13ed0561730b5c6483f" + integrity sha512-+UpDgowcmqe36d4NwqvKsyPMlOLNGMsfMmQ5WGCu+siCe3t3dfe9njrzGfdN4qq+bcNUt0+Vw6haRxBOycs4dw== dependencies: "@ampproject/remapping" "^2.2.0" "@babel/code-frame" "^7.23.5" "@babel/generator" "^7.23.6" "@babel/helper-compilation-targets" "^7.23.6" "@babel/helper-module-transforms" "^7.23.3" - "@babel/helpers" "^7.23.6" + "@babel/helpers" "^7.23.7" "@babel/parser" "^7.23.6" "@babel/template" "^7.22.15" - "@babel/traverse" "^7.23.6" + "@babel/traverse" "^7.23.7" "@babel/types" "^7.23.6" convert-source-map "^2.0.0" debug "^4.1.0" @@ -616,13 +616,13 @@ resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.23.5.tgz#907a3fbd4523426285365d1206c423c4c5520307" integrity sha512-85ttAOMLsr53VgXkTbkx8oA6YTfT4q7/HzXSLEYmjcSTJPMPQtvq1BD79Byep5xMUYbGRzEpDsjUf3dyp54IKw== -"@babel/helpers@^7.23.6": - version "7.23.6" - resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.23.6.tgz#d03af2ee5fb34691eec0cda90f5ecbb4d4da145a" - integrity sha512-wCfsbN4nBidDRhpDhvcKlzHWCTlgJYUUdSJfzXb2NuBssDSIjc3xcb+znA7l+zYsFljAcGM0aFkN40cR3lXiGA== +"@babel/helpers@^7.23.7": + version "7.23.7" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.23.7.tgz#eb543c36f81da2873e47b76ee032343ac83bba60" + integrity sha512-6AMnjCoC8wjqBzDHkuqpa7jAKwvMo4dC+lr/TFBz+ucfulO1XMpDnwWPGBNwClOKZ8h6xn5N81W/R5OrcKtCbQ== dependencies: "@babel/template" "^7.22.15" - "@babel/traverse" "^7.23.6" + "@babel/traverse" "^7.23.7" "@babel/types" "^7.23.6" "@babel/highlight@^7.23.4": @@ -738,9 +738,9 @@ "@babel/helper-plugin-utils" "^7.22.5" "@babel/runtime@^7.21.0": - version "7.23.6" - resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.23.6.tgz#c05e610dc228855dc92ef1b53d07389ed8ab521d" - integrity sha512-zHd0eUrf5GZoOWVCXp6koAKQTfZV07eit6bGPmJgnZdnSAvvZee6zniW2XMF7Cmc4ISOOnPy3QaSiIJGJkVEDQ== + version "7.23.7" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.23.7.tgz#dd7c88deeb218a0f8bd34d5db1aa242e0f203193" + integrity sha512-w06OXVOFso7LcbzMiDGt+3X7Rh7Ho8MmgPoWU3rarH+8upf+wSU/grlGbWzQyr3DkdN6ZeuMFjpdwW0Q+HxobA== dependencies: regenerator-runtime "^0.14.0" @@ -753,10 +753,10 @@ "@babel/parser" "^7.22.15" "@babel/types" "^7.22.15" -"@babel/traverse@^7.23.6": - version "7.23.6" - resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.23.6.tgz#b53526a2367a0dd6edc423637f3d2d0f2521abc5" - integrity sha512-czastdK1e8YByZqezMPFiZ8ahwVMh/ESl9vPgvgdB9AmFMGP5jfpFax74AQgl5zj4XHzqeYAg2l8PuUeRS1MgQ== +"@babel/traverse@^7.23.7": + version "7.23.7" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.23.7.tgz#9a7bf285c928cb99b5ead19c3b1ce5b310c9c305" + integrity sha512-tY3mM8rH9jM0YHFGyfC0/xf+SB5eKUu7HPj7/k3fpi9dAlsMc5YbQvDi0Sh2QTPXqMhyaAtzAr807TIyfQrmyg== dependencies: "@babel/code-frame" "^7.23.5" "@babel/generator" "^7.23.6" @@ -1198,14 +1198,14 @@ "@smithy/types" "^2.7.0" tslib "^2.5.0" -"@smithy/config-resolver@^2.0.21": - version "2.0.21" - resolved "https://registry.yarnpkg.com/@smithy/config-resolver/-/config-resolver-2.0.21.tgz#97cb1c71f3c8c453fb01169545f98414b3414d7f" - integrity sha512-rlLIGT+BeqjnA6C2FWumPRJS1UW07iU5ZxDHtFuyam4W65gIaOFMjkB90ofKCIh+0mLVQrQFrl/VLtQT/6FWTA== +"@smithy/config-resolver@^2.0.22": + version "2.0.22" + resolved "https://registry.yarnpkg.com/@smithy/config-resolver/-/config-resolver-2.0.22.tgz#c994a7d09d3c6f9e9a97a029db2ae16a8fbb0838" + integrity sha512-YuPjsLnq6I5ZQBTx6BL5NsCLtcLel5YIMf3gDeEa+GSCXn5mgRXm+8XO8HtjR3Xf69b88aY4c7bwKQQS2i8vtA== dependencies: "@smithy/node-config-provider" "^2.1.8" "@smithy/types" "^2.7.0" - "@smithy/util-config-provider" "^2.0.0" + "@smithy/util-config-provider" "^2.1.0" "@smithy/util-middleware" "^2.0.8" tslib "^2.5.0" @@ -1474,10 +1474,10 @@ "@smithy/is-array-buffer" "^2.0.0" tslib "^2.5.0" -"@smithy/util-config-provider@^2.0.0": - version "2.0.0" - resolved "https://registry.yarnpkg.com/@smithy/util-config-provider/-/util-config-provider-2.0.0.tgz#4dd6a793605559d94267312fd06d0f58784b4c38" - integrity sha512-xCQ6UapcIWKxXHEU4Mcs2s7LcFQRiU3XEluM2WcCjjBtQkUN71Tb+ydGmJFPxMUrW/GWMgQEEGipLym4XG0jZg== +"@smithy/util-config-provider@^2.1.0": + version "2.1.0" + resolved "https://registry.yarnpkg.com/@smithy/util-config-provider/-/util-config-provider-2.1.0.tgz#c733a862892772aaeb373a3e8af5182556da0ef9" + integrity sha512-S6V0JvvhQgFSGLcJeT1CBsaTR03MM8qTuxMH9WPCCddlSo2W0V5jIHimHtIQALMLEDPGQ0ROSRr/dU0O+mxiQg== dependencies: tslib "^2.5.0" @@ -1492,12 +1492,12 @@ bowser "^2.11.0" tslib "^2.5.0" -"@smithy/util-defaults-mode-node@^2.0.30": - version "2.0.30" - resolved "https://registry.yarnpkg.com/@smithy/util-defaults-mode-node/-/util-defaults-mode-node-2.0.30.tgz#12c4c737a9f8b151cfbd951348cdf94febd083dd" - integrity sha512-nmcmEyRlClNprp7mBnUzfmW6HrKQK+yvl+cyXCRUoQSxRvZuLDrztV+JD+zr3qV/oirEc4Q0QNIrrhTDCE6JeA== +"@smithy/util-defaults-mode-node@^2.0.31": + version "2.0.31" + resolved "https://registry.yarnpkg.com/@smithy/util-defaults-mode-node/-/util-defaults-mode-node-2.0.31.tgz#1b7dc36f695375cead8e8fa7de5e90c8bfcd0df8" + integrity sha512-ZwdjAJAFkkQQ4hdE8HOcxFAWC3GPFXQ3yQ8IBwHH5nQBlr9q+p5eRQ7Y8iRRORJe4vksR+NASRXZ+E81Us1aXQ== dependencies: - "@smithy/config-resolver" "^2.0.21" + "@smithy/config-resolver" "^2.0.22" "@smithy/credential-provider-imds" "^2.1.4" "@smithy/node-config-provider" "^2.1.8" "@smithy/property-provider" "^2.0.16" @@ -1576,10 +1576,10 @@ "@smithy/types" "^2.7.0" tslib "^2.5.0" -"@taimos/projen@^0.0.187": - version "0.0.187" - resolved "https://registry.yarnpkg.com/@taimos/projen/-/projen-0.0.187.tgz#718b1088856f6b2195ffc90301e088fe4bec737b" - integrity sha512-kowrKSMnRnH/UHOce/q0Vrm8/QofF8BytoBjDPyXTz6NJtDz8Rw+dDPBWUVlohCriu9ALI7gFMLLUu1kGBVNaw== +"@taimos/projen@^0.0.188": + version "0.0.188" + resolved "https://registry.yarnpkg.com/@taimos/projen/-/projen-0.0.188.tgz#3af59a65754b3d1fc6387fe6e0a22fd1e82286db" + integrity sha512-Vf94YToMlWTzPv6IAgTkvkj76GNJ+Wdl8Ud6uIxIQGGLp67hlngE0tgaENG4orVM3yCVg+9G96HmqM7CJv9+tw== "@tsconfig/node10@^1.0.7": version "1.0.9" @@ -1633,9 +1633,9 @@ "@babel/types" "^7.0.0" "@types/babel__traverse@*", "@types/babel__traverse@^7.0.6": - version "7.20.4" - resolved "https://registry.yarnpkg.com/@types/babel__traverse/-/babel__traverse-7.20.4.tgz#ec2c06fed6549df8bc0eb4615b683749a4a92e1b" - integrity sha512-mSM/iKUk5fDDrEV/e83qY+Cr3I1+Q3qqTuEn++HAWYjEa1+NxZr6CNrcJGf2ZTnq4HoFGC3zaTPZTobCzCFukA== + version "7.20.5" + resolved "https://registry.yarnpkg.com/@types/babel__traverse/-/babel__traverse-7.20.5.tgz#7b7502be0aa80cc4ef22978846b983edaafcd4dd" + integrity sha512-WXCyOcRtH37HAUkpXhUduaxdm82b4GSlyTqajXviN4EfiuPgNYR109xMCKvpl6zPIpua0DGlMEDCq+g8EdoheQ== dependencies: "@babel/types" "^7.20.7" @@ -1713,16 +1713,16 @@ integrity sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag== "@types/node@*": - version "20.10.5" - resolved "https://registry.yarnpkg.com/@types/node/-/node-20.10.5.tgz#47ad460b514096b7ed63a1dae26fad0914ed3ab2" - integrity sha512-nNPsNE65wjMxEKI93yOP+NPGGBJz/PoN3kZsVLee0XMiJolxSekEVD8wRwBUBqkwc7UWop0edW50yrCQW4CyRw== + version "20.10.6" + resolved "https://registry.yarnpkg.com/@types/node/-/node-20.10.6.tgz#a3ec84c22965802bf763da55b2394424f22bfbb5" + integrity sha512-Vac8H+NlRNNlAmDfGUP7b5h/KA+AtWIzuXy0E6OyP8f1tCLYAtPvKRRDJjAPqhpCb0t6U2j7/xqAuLEebW2kiw== dependencies: undici-types "~5.26.4" "@types/node@^16": - version "16.18.68" - resolved "https://registry.yarnpkg.com/@types/node/-/node-16.18.68.tgz#3155f64a961b3d8d10246c80657f9a7292e3421a" - integrity sha512-sG3hPIQwJLoewrN7cr0dwEy+yF5nD4D/4FxtQpFciRD/xwUzgD+G05uxZHv5mhfXo4F9Jkp13jjn0CC2q325sg== + version "16.18.69" + resolved "https://registry.yarnpkg.com/@types/node/-/node-16.18.69.tgz#84853c5562baeabc6e864e36ea106f8c09495b24" + integrity sha512-AfDKv5fWd9XStaEuqFa6PYcM8FgTqxVMsP4BPk60emeB9YX+pp2P0zZ8nU1BQg8hyPGFrMt7MGMRMis8IrcPyg== "@types/normalize-package-data@^2.4.0": version "2.4.4" @@ -1866,9 +1866,9 @@ acorn-walk@^8.1.1: integrity sha512-TgUZgYvqZprrl7YldZNoa9OciCAyZR+Ejm9eXzKCmjsF5IKp/wgQ7Z/ZpjpGTIUPwrHQIcYeI8qDh4PsEwxMbw== acorn@^8.4.1, acorn@^8.9.0: - version "8.11.2" - resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.11.2.tgz#ca0d78b51895be5390a5903c5b3bdcdaf78ae40b" - integrity sha512-nc0Axzp/0FILLEVsm4fNwLCwMttvhEI263QtVPQcbpfZZ3ts0hLsZGOpE6czNlid7CJ9MlyH8reXkpsf3YUY4w== + version "8.11.3" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.11.3.tgz#71e0b14e13a4ec160724b38fb7b0f233b1b81d7a" + integrity sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg== add-stream@^1.0.0: version "1.0.0" @@ -2600,6 +2600,14 @@ cross-spawn@^7.0.2, cross-spawn@^7.0.3: shebang-command "^2.0.0" which "^2.0.1" +custom-metrics@^0.8.1: + version "0.8.2" + resolved "https://registry.yarnpkg.com/custom-metrics/-/custom-metrics-0.8.2.tgz#d1a7edaa7e5f651a443d0cb1db1548d70a5213ea" + integrity sha512-pT+AmdYC8Y5Hx9qkqklN9ywA9qs0WiA0TyIZxYa6qLkX63XbXByTsWvxGCo4zkDAeTA8NQwLWRojjOvk/xZ6QA== + dependencies: + "@aws-sdk/client-dynamodb" "^3.418.0" + "@aws-sdk/util-dynamodb" "^3.418.0" + dargs@^7.0.0: version "7.0.0" resolved "https://registry.yarnpkg.com/dargs/-/dargs-7.0.0.tgz#04015c41de0bcb69ec84050f3d9be0caf8d6d5cc" @@ -2738,13 +2746,14 @@ dotgitignore@^2.1.0: find-up "^3.0.0" minimatch "^3.0.4" -dynamodb-onetable@~2.6.4: - version "2.6.4" - resolved "https://registry.yarnpkg.com/dynamodb-onetable/-/dynamodb-onetable-2.6.4.tgz#c503a02970667201714211f5fbf57cd49ac5b538" - integrity sha512-/Tu7VoQ3KTR22gBhrJiQ1F3GdGjaVKGFvZosEklb0Dky8gAGdsjaXiNJFuZUImWAq034ph3k1CtU4yFo4bylaQ== +dynamodb-onetable@~2.7.1: + version "2.7.1" + resolved "https://registry.yarnpkg.com/dynamodb-onetable/-/dynamodb-onetable-2.7.1.tgz#ece6f336c1180135e84b2ac49a992d1a1f0994ae" + integrity sha512-lJtrUuysI90I+zLjOKSpxZnoLbulLaacNK9LWKJp+q92rMEEwNyp9eXwF+HxPaU0YyXOcKixzP7JpceV0pcJrA== dependencies: - "@aws-sdk/client-dynamodb" "^3.363.0" - "@aws-sdk/util-dynamodb" "^3.363.0" + "@aws-sdk/client-dynamodb" "^3.410.0" + "@aws-sdk/util-dynamodb" "^3.410.0" + custom-metrics "^0.8.1" ecdsa-sig-formatter@1.0.11: version "1.0.11" @@ -3187,9 +3196,9 @@ flatted@^3.2.9: integrity sha512-36yxDn5H7OFZQla0/jFJmbIKTdZAQHngCedGxiMmpNfEZM0sdEeT+WczLQrjK6D7o2aiyLYDnkw0R3JK0Qv1RQ== follow-redirects@^1.15.0: - version "1.15.3" - resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.3.tgz#fe2f3ef2690afce7e82ed0b44db08165b207123a" - integrity sha512-1VzOtuEM8pC9SFU1E+8KfTjZyMztRsgEfwQl44z8A25uy13jSzTj6dyK2Df52iV0vgHCfBwLhDWevLn95w5v6Q== + version "1.15.4" + resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.4.tgz#cdc7d308bf6493126b17ea2191ea0ccf3e535adf" + integrity sha512-Cr4D/5wlrb0z9dgERpUL3LrmPKVDsETIJhaCMeDfuFYcqa5bldGV6wBsAN6X/vxlXQtFBMrXdXxdL8CbDTGniw== for-each@^0.3.3: version "0.3.3" @@ -4957,9 +4966,9 @@ process-nextick-args@~2.0.0: integrity sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag== projen@^0.78.4: - version "0.78.4" - resolved "https://registry.yarnpkg.com/projen/-/projen-0.78.4.tgz#47ab90c449d63a1393af93104796099eb2f55f89" - integrity sha512-lj8U6OC6Ac5ToObt8HwcPsWd6o81yM2Vdkj/hK9lS0EpwDq1YcIxeSnM0udVpg4YwxF3Bw3+W96HL1KuEE0UMg== + version "0.78.5" + resolved "https://registry.yarnpkg.com/projen/-/projen-0.78.5.tgz#af188ff25cf8a7d8a6f9743b4d678b95459d581b" + integrity sha512-XghLqRVsbUrGo6YJJ9KuNXfzTZDvZaP664Di0uEJyQLvrawgag3z2UHOstVbtpzJ2MYZzKQyPVMgwlUfltTyCg== dependencies: "@iarna/toml" "^2.2.5" case "^1.6.3" @@ -5727,17 +5736,17 @@ typedarray@^0.0.6: resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA== -typedoc@0.25.0: - version "0.25.0" - resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.25.0.tgz#287f83d01c1c2186766884f4e04d698820d68115" - integrity sha512-FvCYWhO1n5jACE0C32qg6b3dSfQ8f2VzExnnRboowHtqUD6ARzM2r8YJeZFYXhcm2hI4C2oCRDgNPk/yaQUN9g== +typedoc@0.25.4: + version "0.25.4" + resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.25.4.tgz#5c2c0677881f504e41985f29d9aef0dbdb6f1e6f" + integrity sha512-Du9ImmpBCw54bX275yJrxPVnjdIyJO/84co0/L9mwe0R3G4FSR6rQ09AlXVRvZEGMUg09+z/usc8mgygQ1aidA== dependencies: lunr "^2.3.9" marked "^4.3.0" minimatch "^9.0.3" shiki "^0.14.1" -typescript@^4.4.0: +typescript@^4.9.5: version "4.9.5" resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.5.tgz#095979f9bcc0d09da324d58d03ce8f8374cbe65a" integrity sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==