diff --git a/v4.1/404.html b/v4.1/404.html index 30c948c..e8832b1 100644 --- a/v4.1/404.html +++ b/v4.1/404.html @@ -19,7 +19,7 @@ - + @@ -1628,7 +1628,7 @@ - + diff --git a/v4.1/assets/javascripts/bundle.dbc0afdc.min.js b/v4.1/assets/javascripts/bundle.6e5f0216.min.js similarity index 71% rename from v4.1/assets/javascripts/bundle.dbc0afdc.min.js rename to v4.1/assets/javascripts/bundle.6e5f0216.min.js index c2eab7e..6333b8d 100644 --- a/v4.1/assets/javascripts/bundle.dbc0afdc.min.js +++ b/v4.1/assets/javascripts/bundle.6e5f0216.min.js @@ -1,3 +1,3 @@ -"use strict";(()=>{var Oc=Object.create;var Hn=Object.defineProperty,Sc=Object.defineProperties,Lc=Object.getOwnPropertyDescriptor,Mc=Object.getOwnPropertyDescriptors,kc=Object.getOwnPropertyNames,Dr=Object.getOwnPropertySymbols,Ac=Object.getPrototypeOf,$n=Object.prototype.hasOwnProperty,Wo=Object.prototype.propertyIsEnumerable;var Do=(e,t,r)=>t in e?Hn(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,M=(e,t)=>{for(var r in t||(t={}))$n.call(t,r)&&Do(e,r,t[r]);if(Dr)for(var r of Dr(t))Wo.call(t,r)&&Do(e,r,t[r]);return e},He=(e,t)=>Sc(e,Mc(t));var gr=(e,t)=>{var r={};for(var n in e)$n.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&Dr)for(var n of Dr(e))t.indexOf(n)<0&&Wo.call(e,n)&&(r[n]=e[n]);return r};var Pn=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Cc=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of kc(t))!$n.call(e,o)&&o!==r&&Hn(e,o,{get:()=>t[o],enumerable:!(n=Lc(t,o))||n.enumerable});return e};var _r=(e,t,r)=>(r=e!=null?Oc(Ac(e)):{},Cc(t||!e||!e.__esModule?Hn(r,"default",{value:e,enumerable:!0}):r,e));var Vo=(e,t,r)=>new Promise((n,o)=>{var i=c=>{try{s(r.next(c))}catch(l){o(l)}},a=c=>{try{s(r.throw(c))}catch(l){o(l)}},s=c=>c.done?n(c.value):Promise.resolve(c.value).then(i,a);s((r=r.apply(e,t)).next())});var qo=Pn((In,zo)=>{(function(e,t){typeof In=="object"&&typeof zo!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(In,(function(){"use strict";function e(r){var n=!0,o=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(_){return!!(_&&_!==document&&_.nodeName!=="HTML"&&_.nodeName!=="BODY"&&"classList"in _&&"contains"in _.classList)}function c(_){var de=_.type,be=_.tagName;return!!(be==="INPUT"&&a[de]&&!_.readOnly||be==="TEXTAREA"&&!_.readOnly||_.isContentEditable)}function l(_){_.classList.contains("focus-visible")||(_.classList.add("focus-visible"),_.setAttribute("data-focus-visible-added",""))}function u(_){_.hasAttribute("data-focus-visible-added")&&(_.classList.remove("focus-visible"),_.removeAttribute("data-focus-visible-added"))}function p(_){_.metaKey||_.altKey||_.ctrlKey||(s(r.activeElement)&&l(r.activeElement),n=!0)}function d(_){n=!1}function m(_){s(_.target)&&(n||c(_.target))&&l(_.target)}function h(_){s(_.target)&&(_.target.classList.contains("focus-visible")||_.target.hasAttribute("data-focus-visible-added"))&&(o=!0,window.clearTimeout(i),i=window.setTimeout(function(){o=!1},100),u(_.target))}function v(_){document.visibilityState==="hidden"&&(o&&(n=!0),y())}function y(){document.addEventListener("mousemove",T),document.addEventListener("mousedown",T),document.addEventListener("mouseup",T),document.addEventListener("pointermove",T),document.addEventListener("pointerdown",T),document.addEventListener("pointerup",T),document.addEventListener("touchmove",T),document.addEventListener("touchstart",T),document.addEventListener("touchend",T)}function E(){document.removeEventListener("mousemove",T),document.removeEventListener("mousedown",T),document.removeEventListener("mouseup",T),document.removeEventListener("pointermove",T),document.removeEventListener("pointerdown",T),document.removeEventListener("pointerup",T),document.removeEventListener("touchmove",T),document.removeEventListener("touchstart",T),document.removeEventListener("touchend",T)}function T(_){_.target.nodeName&&_.target.nodeName.toLowerCase()==="html"||(n=!1,E())}document.addEventListener("keydown",p,!0),document.addEventListener("mousedown",d,!0),document.addEventListener("pointerdown",d,!0),document.addEventListener("touchstart",d,!0),document.addEventListener("visibilitychange",v,!0),y(),r.addEventListener("focus",m,!0),r.addEventListener("blur",h,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)}))});var Mo=Pn((W0,_s)=>{"use strict";var Qu=/["'&<>]/;_s.exports=ep;function ep(e){var t=""+e,r=Qu.exec(t);if(!r)return t;var n,o="",i=0,a=0;for(i=r.index;i{(function(t,r){typeof jr=="object"&&typeof Ao=="object"?Ao.exports=r():typeof define=="function"&&define.amd?define([],r):typeof jr=="object"?jr.ClipboardJS=r():t.ClipboardJS=r()})(jr,function(){return(function(){var e={686:(function(n,o,i){"use strict";i.d(o,{default:function(){return vr}});var a=i(279),s=i.n(a),c=i(370),l=i.n(c),u=i(817),p=i.n(u);function d(G){try{return document.execCommand(G)}catch(H){return!1}}var m=function(H){var C=p()(H);return d("cut"),C},h=m;function v(G){var H=document.documentElement.getAttribute("dir")==="rtl",C=document.createElement("textarea");C.style.fontSize="12pt",C.style.border="0",C.style.padding="0",C.style.margin="0",C.style.position="absolute",C.style[H?"right":"left"]="-9999px";var W=window.pageYOffset||document.documentElement.scrollTop;return C.style.top="".concat(W,"px"),C.setAttribute("readonly",""),C.value=G,C}var y=function(H,C){var W=v(H);C.container.appendChild(W);var V=p()(W);return d("copy"),W.remove(),V},E=function(H){var C=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},W="";return typeof H=="string"?W=y(H,C):H instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(H==null?void 0:H.type)?W=y(H.value,C):(W=p()(H),d("copy")),W},T=E;function _(G){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?_=function(C){return typeof C}:_=function(C){return C&&typeof Symbol=="function"&&C.constructor===Symbol&&C!==Symbol.prototype?"symbol":typeof C},_(G)}var de=function(){var H=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},C=H.action,W=C===void 0?"copy":C,V=H.container,Z=H.target,We=H.text;if(W!=="copy"&&W!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Z!==void 0)if(Z&&_(Z)==="object"&&Z.nodeType===1){if(W==="copy"&&Z.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(W==="cut"&&(Z.hasAttribute("readonly")||Z.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(We)return T(We,{container:V});if(Z)return W==="cut"?h(Z):T(Z,{container:V})},be=de;function A(G){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?A=function(C){return typeof C}:A=function(C){return C&&typeof Symbol=="function"&&C.constructor===Symbol&&C!==Symbol.prototype?"symbol":typeof C},A(G)}function S(G,H){if(!(G instanceof H))throw new TypeError("Cannot call a class as a function")}function D(G,H){for(var C=0;C0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof V.action=="function"?V.action:this.defaultAction,this.target=typeof V.target=="function"?V.target:this.defaultTarget,this.text=typeof V.text=="function"?V.text:this.defaultText,this.container=A(V.container)==="object"?V.container:document.body}},{key:"listenClick",value:function(V){var Z=this;this.listener=l()(V,"click",function(We){return Z.onClick(We)})}},{key:"onClick",value:function(V){var Z=V.delegateTarget||V.currentTarget,We=this.action(Z)||"copy",Jt=be({action:We,container:this.container,target:this.target(Z),text:this.text(Z)});this.emit(Jt?"success":"error",{action:We,text:Jt,trigger:Z,clearSelection:function(){Z&&Z.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(V){return Yt("action",V)}},{key:"defaultTarget",value:function(V){var Z=Yt("target",V);if(Z)return document.querySelector(Z)}},{key:"defaultText",value:function(V){return Yt("text",V)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(V){var Z=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return T(V,Z)}},{key:"cut",value:function(V){return h(V)}},{key:"isSupported",value:function(){var V=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Z=typeof V=="string"?[V]:V,We=!!document.queryCommandSupported;return Z.forEach(function(Jt){We=We&&!!document.queryCommandSupported(Jt)}),We}}]),C})(s()),vr=kt}),828:(function(n){var o=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,c){for(;s&&s.nodeType!==o;){if(typeof s.matches=="function"&&s.matches(c))return s;s=s.parentNode}}n.exports=a}),438:(function(n,o,i){var a=i(828);function s(u,p,d,m,h){var v=l.apply(this,arguments);return u.addEventListener(d,v,h),{destroy:function(){u.removeEventListener(d,v,h)}}}function c(u,p,d,m,h){return typeof u.addEventListener=="function"?s.apply(null,arguments):typeof d=="function"?s.bind(null,document).apply(null,arguments):(typeof u=="string"&&(u=document.querySelectorAll(u)),Array.prototype.map.call(u,function(v){return s(v,p,d,m,h)}))}function l(u,p,d,m){return function(h){h.delegateTarget=a(h.target,p),h.delegateTarget&&m.call(u,h)}}n.exports=c}),879:(function(n,o){o.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},o.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||o.node(i[0]))},o.string=function(i){return typeof i=="string"||i instanceof String},o.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}}),370:(function(n,o,i){var a=i(879),s=i(438);function c(d,m,h){if(!d&&!m&&!h)throw new Error("Missing required arguments");if(!a.string(m))throw new TypeError("Second argument must be a String");if(!a.fn(h))throw new TypeError("Third argument must be a Function");if(a.node(d))return l(d,m,h);if(a.nodeList(d))return u(d,m,h);if(a.string(d))return p(d,m,h);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function l(d,m,h){return d.addEventListener(m,h),{destroy:function(){d.removeEventListener(m,h)}}}function u(d,m,h){return Array.prototype.forEach.call(d,function(v){v.addEventListener(m,h)}),{destroy:function(){Array.prototype.forEach.call(d,function(v){v.removeEventListener(m,h)})}}}function p(d,m,h){return s(document.body,d,m,h)}n.exports=c}),817:(function(n){function o(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var c=window.getSelection(),l=document.createRange();l.selectNodeContents(i),c.removeAllRanges(),c.addRange(l),a=c.toString()}return a}n.exports=o}),279:(function(n){function o(){}o.prototype={on:function(i,a,s){var c=this.e||(this.e={});return(c[i]||(c[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var c=this;function l(){c.off(i,l),a.apply(s,arguments)}return l._=a,this.on(i,l,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),c=0,l=s.length;for(c;c0&&i[i.length-1])&&(l[0]===6||l[0]===2)){r=0;continue}if(l[0]===3&&(!i||l[1]>i[0]&&l[1]=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function te(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var n=r.call(e),o,i=[],a;try{for(;(t===void 0||t-- >0)&&!(o=n.next()).done;)i.push(o.value)}catch(s){a={error:s}}finally{try{o&&!o.done&&(r=n.return)&&r.call(n)}finally{if(a)throw a.error}}return i}function ne(e,t,r){if(r||arguments.length===2)for(var n=0,o=t.length,i;n1||c(m,v)})},h&&(o[m]=h(o[m])))}function c(m,h){try{l(n[m](h))}catch(v){d(i[0][3],v)}}function l(m){m.value instanceof At?Promise.resolve(m.value.v).then(u,p):d(i[0][2],m)}function u(m){c("next",m)}function p(m){c("throw",m)}function d(m,h){m(h),i.shift(),i.length&&c(i[0][0],i[0][1])}}function Go(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof $e=="function"?$e(e):e[Symbol.iterator](),r={},n("next"),n("throw"),n("return"),r[Symbol.asyncIterator]=function(){return this},r);function n(i){r[i]=e[i]&&function(a){return new Promise(function(s,c){a=e[i](a),o(s,c,a.done,a.value)})}}function o(i,a,s,c){Promise.resolve(c).then(function(l){i({value:l,done:s})},a)}}function U(e){return typeof e=="function"}function Xt(e){var t=function(n){Error.call(n),n.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var Vr=Xt(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +"use strict";(()=>{var Oc=Object.create;var Hn=Object.defineProperty,Sc=Object.defineProperties,Lc=Object.getOwnPropertyDescriptor,Mc=Object.getOwnPropertyDescriptors,kc=Object.getOwnPropertyNames,Dr=Object.getOwnPropertySymbols,Ac=Object.getPrototypeOf,$n=Object.prototype.hasOwnProperty,Wo=Object.prototype.propertyIsEnumerable;var Do=(e,t,r)=>t in e?Hn(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,M=(e,t)=>{for(var r in t||(t={}))$n.call(t,r)&&Do(e,r,t[r]);if(Dr)for(var r of Dr(t))Wo.call(t,r)&&Do(e,r,t[r]);return e},He=(e,t)=>Sc(e,Mc(t));var gr=(e,t)=>{var r={};for(var n in e)$n.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&Dr)for(var n of Dr(e))t.indexOf(n)<0&&Wo.call(e,n)&&(r[n]=e[n]);return r};var Pn=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Cc=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of kc(t))!$n.call(e,o)&&o!==r&&Hn(e,o,{get:()=>t[o],enumerable:!(n=Lc(t,o))||n.enumerable});return e};var _r=(e,t,r)=>(r=e!=null?Oc(Ac(e)):{},Cc(t||!e||!e.__esModule?Hn(r,"default",{value:e,enumerable:!0}):r,e));var Vo=(e,t,r)=>new Promise((n,o)=>{var i=c=>{try{s(r.next(c))}catch(l){o(l)}},a=c=>{try{s(r.throw(c))}catch(l){o(l)}},s=c=>c.done?n(c.value):Promise.resolve(c.value).then(i,a);s((r=r.apply(e,t)).next())});var qo=Pn((In,zo)=>{(function(e,t){typeof In=="object"&&typeof zo!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(In,(function(){"use strict";function e(r){var n=!0,o=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(_){return!!(_&&_!==document&&_.nodeName!=="HTML"&&_.nodeName!=="BODY"&&"classList"in _&&"contains"in _.classList)}function c(_){var de=_.type,ge=_.tagName;return!!(ge==="INPUT"&&a[de]&&!_.readOnly||ge==="TEXTAREA"&&!_.readOnly||_.isContentEditable)}function l(_){_.classList.contains("focus-visible")||(_.classList.add("focus-visible"),_.setAttribute("data-focus-visible-added",""))}function u(_){_.hasAttribute("data-focus-visible-added")&&(_.classList.remove("focus-visible"),_.removeAttribute("data-focus-visible-added"))}function p(_){_.metaKey||_.altKey||_.ctrlKey||(s(r.activeElement)&&l(r.activeElement),n=!0)}function d(_){n=!1}function m(_){s(_.target)&&(n||c(_.target))&&l(_.target)}function h(_){s(_.target)&&(_.target.classList.contains("focus-visible")||_.target.hasAttribute("data-focus-visible-added"))&&(o=!0,window.clearTimeout(i),i=window.setTimeout(function(){o=!1},100),u(_.target))}function v(_){document.visibilityState==="hidden"&&(o&&(n=!0),x())}function x(){document.addEventListener("mousemove",T),document.addEventListener("mousedown",T),document.addEventListener("mouseup",T),document.addEventListener("pointermove",T),document.addEventListener("pointerdown",T),document.addEventListener("pointerup",T),document.addEventListener("touchmove",T),document.addEventListener("touchstart",T),document.addEventListener("touchend",T)}function E(){document.removeEventListener("mousemove",T),document.removeEventListener("mousedown",T),document.removeEventListener("mouseup",T),document.removeEventListener("pointermove",T),document.removeEventListener("pointerdown",T),document.removeEventListener("pointerup",T),document.removeEventListener("touchmove",T),document.removeEventListener("touchstart",T),document.removeEventListener("touchend",T)}function T(_){_.target.nodeName&&_.target.nodeName.toLowerCase()==="html"||(n=!1,E())}document.addEventListener("keydown",p,!0),document.addEventListener("mousedown",d,!0),document.addEventListener("pointerdown",d,!0),document.addEventListener("touchstart",d,!0),document.addEventListener("visibilitychange",v,!0),x(),r.addEventListener("focus",m,!0),r.addEventListener("blur",h,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)}))});var Mo=Pn((W0,_s)=>{"use strict";var Qu=/["'&<>]/;_s.exports=ep;function ep(e){var t=""+e,r=Qu.exec(t);if(!r)return t;var n,o="",i=0,a=0;for(i=r.index;i{(function(t,r){typeof jr=="object"&&typeof Ao=="object"?Ao.exports=r():typeof define=="function"&&define.amd?define([],r):typeof jr=="object"?jr.ClipboardJS=r():t.ClipboardJS=r()})(jr,function(){return(function(){var e={686:(function(n,o,i){"use strict";i.d(o,{default:function(){return vr}});var a=i(279),s=i.n(a),c=i(370),l=i.n(c),u=i(817),p=i.n(u);function d(G){try{return document.execCommand(G)}catch(H){return!1}}var m=function(H){var C=p()(H);return d("cut"),C},h=m;function v(G){var H=document.documentElement.getAttribute("dir")==="rtl",C=document.createElement("textarea");C.style.fontSize="12pt",C.style.border="0",C.style.padding="0",C.style.margin="0",C.style.position="absolute",C.style[H?"right":"left"]="-9999px";var W=window.pageYOffset||document.documentElement.scrollTop;return C.style.top="".concat(W,"px"),C.setAttribute("readonly",""),C.value=G,C}var x=function(H,C){var W=v(H);C.container.appendChild(W);var V=p()(W);return d("copy"),W.remove(),V},E=function(H){var C=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},W="";return typeof H=="string"?W=x(H,C):H instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(H==null?void 0:H.type)?W=x(H.value,C):(W=p()(H),d("copy")),W},T=E;function _(G){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?_=function(C){return typeof C}:_=function(C){return C&&typeof Symbol=="function"&&C.constructor===Symbol&&C!==Symbol.prototype?"symbol":typeof C},_(G)}var de=function(){var H=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},C=H.action,W=C===void 0?"copy":C,V=H.container,Z=H.target,We=H.text;if(W!=="copy"&&W!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Z!==void 0)if(Z&&_(Z)==="object"&&Z.nodeType===1){if(W==="copy"&&Z.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(W==="cut"&&(Z.hasAttribute("readonly")||Z.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(We)return T(We,{container:V});if(Z)return W==="cut"?h(Z):T(Z,{container:V})},ge=de;function A(G){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?A=function(C){return typeof C}:A=function(C){return C&&typeof Symbol=="function"&&C.constructor===Symbol&&C!==Symbol.prototype?"symbol":typeof C},A(G)}function S(G,H){if(!(G instanceof H))throw new TypeError("Cannot call a class as a function")}function D(G,H){for(var C=0;C0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof V.action=="function"?V.action:this.defaultAction,this.target=typeof V.target=="function"?V.target:this.defaultTarget,this.text=typeof V.text=="function"?V.text:this.defaultText,this.container=A(V.container)==="object"?V.container:document.body}},{key:"listenClick",value:function(V){var Z=this;this.listener=l()(V,"click",function(We){return Z.onClick(We)})}},{key:"onClick",value:function(V){var Z=V.delegateTarget||V.currentTarget,We=this.action(Z)||"copy",Jt=ge({action:We,container:this.container,target:this.target(Z),text:this.text(Z)});this.emit(Jt?"success":"error",{action:We,text:Jt,trigger:Z,clearSelection:function(){Z&&Z.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(V){return Yt("action",V)}},{key:"defaultTarget",value:function(V){var Z=Yt("target",V);if(Z)return document.querySelector(Z)}},{key:"defaultText",value:function(V){return Yt("text",V)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(V){var Z=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return T(V,Z)}},{key:"cut",value:function(V){return h(V)}},{key:"isSupported",value:function(){var V=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Z=typeof V=="string"?[V]:V,We=!!document.queryCommandSupported;return Z.forEach(function(Jt){We=We&&!!document.queryCommandSupported(Jt)}),We}}]),C})(s()),vr=kt}),828:(function(n){var o=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,c){for(;s&&s.nodeType!==o;){if(typeof s.matches=="function"&&s.matches(c))return s;s=s.parentNode}}n.exports=a}),438:(function(n,o,i){var a=i(828);function s(u,p,d,m,h){var v=l.apply(this,arguments);return u.addEventListener(d,v,h),{destroy:function(){u.removeEventListener(d,v,h)}}}function c(u,p,d,m,h){return typeof u.addEventListener=="function"?s.apply(null,arguments):typeof d=="function"?s.bind(null,document).apply(null,arguments):(typeof u=="string"&&(u=document.querySelectorAll(u)),Array.prototype.map.call(u,function(v){return s(v,p,d,m,h)}))}function l(u,p,d,m){return function(h){h.delegateTarget=a(h.target,p),h.delegateTarget&&m.call(u,h)}}n.exports=c}),879:(function(n,o){o.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},o.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||o.node(i[0]))},o.string=function(i){return typeof i=="string"||i instanceof String},o.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}}),370:(function(n,o,i){var a=i(879),s=i(438);function c(d,m,h){if(!d&&!m&&!h)throw new Error("Missing required arguments");if(!a.string(m))throw new TypeError("Second argument must be a String");if(!a.fn(h))throw new TypeError("Third argument must be a Function");if(a.node(d))return l(d,m,h);if(a.nodeList(d))return u(d,m,h);if(a.string(d))return p(d,m,h);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function l(d,m,h){return d.addEventListener(m,h),{destroy:function(){d.removeEventListener(m,h)}}}function u(d,m,h){return Array.prototype.forEach.call(d,function(v){v.addEventListener(m,h)}),{destroy:function(){Array.prototype.forEach.call(d,function(v){v.removeEventListener(m,h)})}}}function p(d,m,h){return s(document.body,d,m,h)}n.exports=c}),817:(function(n){function o(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var c=window.getSelection(),l=document.createRange();l.selectNodeContents(i),c.removeAllRanges(),c.addRange(l),a=c.toString()}return a}n.exports=o}),279:(function(n){function o(){}o.prototype={on:function(i,a,s){var c=this.e||(this.e={});return(c[i]||(c[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var c=this;function l(){c.off(i,l),a.apply(s,arguments)}return l._=a,this.on(i,l,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),c=0,l=s.length;for(c;c0&&i[i.length-1])&&(l[0]===6||l[0]===2)){r=0;continue}if(l[0]===3&&(!i||l[1]>i[0]&&l[1]=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function te(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var n=r.call(e),o,i=[],a;try{for(;(t===void 0||t-- >0)&&!(o=n.next()).done;)i.push(o.value)}catch(s){a={error:s}}finally{try{o&&!o.done&&(r=n.return)&&r.call(n)}finally{if(a)throw a.error}}return i}function ne(e,t,r){if(r||arguments.length===2)for(var n=0,o=t.length,i;n1||c(m,v)})},h&&(o[m]=h(o[m])))}function c(m,h){try{l(n[m](h))}catch(v){d(i[0][3],v)}}function l(m){m.value instanceof At?Promise.resolve(m.value.v).then(u,p):d(i[0][2],m)}function u(m){c("next",m)}function p(m){c("throw",m)}function d(m,h){m(h),i.shift(),i.length&&c(i[0][0],i[0][1])}}function Go(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof $e=="function"?$e(e):e[Symbol.iterator](),r={},n("next"),n("throw"),n("return"),r[Symbol.asyncIterator]=function(){return this},r);function n(i){r[i]=e[i]&&function(a){return new Promise(function(s,c){a=e[i](a),o(s,c,a.done,a.value)})}}function o(i,a,s,c){Promise.resolve(c).then(function(l){i({value:l,done:s})},a)}}function U(e){return typeof e=="function"}function Xt(e){var t=function(n){Error.call(n),n.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var Vr=Xt(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: `+r.map(function(n,o){return o+1+") "+n.toString()}).join(` - `):"",this.name="UnsubscriptionError",this.errors=r}});function ut(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var rt=(function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,n,o,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=$e(a),c=s.next();!c.done;c=s.next()){var l=c.value;l.remove(this)}}catch(v){t={error:v}}finally{try{c&&!c.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var u=this.initialTeardown;if(U(u))try{u()}catch(v){i=v instanceof Vr?v.errors:[v]}var p=this._finalizers;if(p){this._finalizers=null;try{for(var d=$e(p),m=d.next();!m.done;m=d.next()){var h=m.value;try{Yo(h)}catch(v){i=i!=null?i:[],v instanceof Vr?i=ne(ne([],te(i)),te(v.errors)):i.push(v)}}}catch(v){n={error:v}}finally{try{m&&!m.done&&(o=d.return)&&o.call(d)}finally{if(n)throw n.error}}}if(i)throw new Vr(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)Yo(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&ut(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&ut(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=(function(){var t=new e;return t.closed=!0,t})(),e})();var jn=rt.EMPTY;function zr(e){return e instanceof rt||e&&"closed"in e&&U(e.remove)&&U(e.add)&&U(e.unsubscribe)}function Yo(e){U(e)?e():e.unsubscribe()}var Je={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var Zt={setTimeout:function(e,t){for(var r=[],n=2;n0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var n=this,o=this,i=o.hasError,a=o.isStopped,s=o.observers;return i||a?jn:(this.currentObservers=null,s.push(r),new rt(function(){n.currentObservers=null,ut(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var n=this,o=n.hasError,i=n.thrownError,a=n.isStopped;o?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,n){return new ni(r,n)},t})(F);var ni=(function(e){ue(t,e);function t(r,n){var o=e.call(this)||this;return o.destination=r,o.source=n,o}return t.prototype.next=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.next)===null||o===void 0||o.call(n,r)},t.prototype.error=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.error)===null||o===void 0||o.call(n,r)},t.prototype.complete=function(){var r,n;(n=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||n===void 0||n.call(r)},t.prototype._subscribe=function(r){var n,o;return(o=(n=this.source)===null||n===void 0?void 0:n.subscribe(r))!==null&&o!==void 0?o:jn},t})(I);var Wn=(function(e){ue(t,e);function t(r){var n=e.call(this)||this;return n._value=r,n}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var n=e.prototype._subscribe.call(this,r);return!n.closed&&r.next(this._value),n},t.prototype.getValue=function(){var r=this,n=r.hasError,o=r.thrownError,i=r._value;if(n)throw o;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t})(I);var xr={now:function(){return(xr.delegate||Date).now()},delegate:void 0};var wr=(function(e){ue(t,e);function t(r,n,o){r===void 0&&(r=1/0),n===void 0&&(n=1/0),o===void 0&&(o=xr);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=n,i._timestampProvider=o,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=n===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,n),i}return t.prototype.next=function(r){var n=this,o=n.isStopped,i=n._buffer,a=n._infiniteTimeWindow,s=n._timestampProvider,c=n._windowTime;o||(i.push(r),!a&&i.push(s.now()+c)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var n=this._innerSubscribe(r),o=this,i=o._infiniteTimeWindow,a=o._buffer,s=a.slice(),c=0;c0?e.prototype.schedule.call(this,r,n):(this.delay=n,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,n){return n>0||this.closed?e.prototype.execute.call(this,r,n):this._execute(r,n)},t.prototype.requestAsyncId=function(r,n,o){return o===void 0&&(o=0),o!=null&&o>0||o==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,n,o):(r.flush(this),0)},t})(rr);var ai=(function(e){ue(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t})(nr);var qn=new ai(ii);var si=(function(e){ue(t,e);function t(r,n){var o=e.call(this,r,n)||this;return o.scheduler=r,o.work=n,o}return t.prototype.requestAsyncId=function(r,n,o){return o===void 0&&(o=0),o!==null&&o>0?e.prototype.requestAsyncId.call(this,r,n,o):(r.actions.push(this),r._scheduled||(r._scheduled=tr.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,n,o){var i;if(o===void 0&&(o=0),o!=null?o>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,n,o);var a=r.actions;n!=null&&n===r._scheduled&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==n&&(tr.cancelAnimationFrame(n),r._scheduled=void 0)},t})(rr);var ci=(function(e){ue(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var n;r?n=r.id:(n=this._scheduled,this._scheduled=void 0);var o=this.actions,i;r=r||o.shift();do if(i=r.execute(r.state,r.delay))break;while((r=o[0])&&r.id===n&&o.shift());if(this._active=!1,i){for(;(r=o[0])&&r.id===n&&o.shift();)r.unsubscribe();throw i}},t})(nr);var je=new ci(si);var x=new F(function(e){return e.complete()});function Br(e){return e&&U(e.schedule)}function Kn(e){return e[e.length-1]}function nt(e){return U(Kn(e))?e.pop():void 0}function qe(e){return Br(Kn(e))?e.pop():void 0}function Gr(e,t){return typeof Kn(e)=="number"?e.pop():t}var or=(function(e){return e&&typeof e.length=="number"&&typeof e!="function"});function Yr(e){return U(e==null?void 0:e.then)}function Jr(e){return U(e[er])}function Xr(e){return Symbol.asyncIterator&&U(e==null?void 0:e[Symbol.asyncIterator])}function Zr(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Nc(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Qr=Nc();function en(e){return U(e==null?void 0:e[Qr])}function tn(e){return Bo(this,arguments,function(){var r,n,o,i;return Wr(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,At(r.read())];case 3:return n=a.sent(),o=n.value,i=n.done,i?[4,At(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,At(o)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function rn(e){return U(e==null?void 0:e.getReader)}function N(e){if(e instanceof F)return e;if(e!=null){if(Jr(e))return Dc(e);if(or(e))return Wc(e);if(Yr(e))return Vc(e);if(Xr(e))return li(e);if(en(e))return zc(e);if(rn(e))return qc(e)}throw Zr(e)}function Dc(e){return new F(function(t){var r=e[er]();if(U(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Wc(e){return new F(function(t){for(var r=0;r=2;return function(n){return n.pipe(e?L(function(o,i){return e(o,i,n)}):Le,Me(1),r?at(t):Ti(function(){return new an}))}}function Zn(e){return e<=0?function(){return x}:O(function(t,r){var n=[];t.subscribe(w(r,function(o){n.push(o),e=2,!0))}function xe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new I}:t,n=e.resetOnError,o=n===void 0?!0:n,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,c=s===void 0?!0:s;return function(l){var u,p,d,m=0,h=!1,v=!1,y=function(){p==null||p.unsubscribe(),p=void 0},E=function(){y(),u=d=void 0,h=v=!1},T=function(){var _=u;E(),_==null||_.unsubscribe()};return O(function(_,de){m++,!v&&!h&&y();var be=d=d!=null?d:r();de.add(function(){m--,m===0&&!v&&!h&&(p=Qn(T,c))}),be.subscribe(de),!u&&m>0&&(u=new Ht({next:function(A){return be.next(A)},error:function(A){v=!0,y(),p=Qn(E,o,A),be.error(A)},complete:function(){h=!0,y(),p=Qn(E,a),be.complete()}}),N(_).subscribe(u))})(l)}}function Qn(e,t){for(var r=[],n=2;ne.next(document)),e}function P(e,t=document){return Array.from(t.querySelectorAll(e))}function Y(e,t=document){let r=we(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function we(e,t=document){return t.querySelector(e)||void 0}function xt(){var e,t,r,n;return(n=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?n:void 0}var ll=R(b(document.body,"focusin"),b(document.body,"focusout")).pipe(Be(1),J(void 0),f(()=>xt()||document.body),ie(1));function ar(e){return ll.pipe(f(t=>e.contains(t)),ae())}function Ut(e,t){let{matches:r}=matchMedia("(hover)");return j(()=>(r?R(b(e,"mouseenter").pipe(f(()=>!0)),b(e,"mouseleave").pipe(f(()=>!1))):R(b(e,"touchstart").pipe(f(()=>!0)),b(e,"touchend").pipe(f(()=>!1)),b(e,"touchcancel").pipe(f(()=>!1)))).pipe(t?Tr(o=>Ve(+!o*t)):Le,J(!0,e.matches(":hover"))))}function Mi(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Mi(e,r)}function k(e,t,...r){let n=document.createElement(e);if(t)for(let o of Object.keys(t))typeof t[o]!="undefined"&&(typeof t[o]!="boolean"?n.setAttribute(o,t[o]):n.setAttribute(o,""));for(let o of r)Mi(n,o);return n}function ki(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function wt(e){let t=k("script",{src:e});return j(()=>(document.head.appendChild(t),R(b(t,"load"),b(t,"error").pipe(g(()=>on(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(f(()=>{}),z(()=>document.head.removeChild(t)),Me(1))))}function Ai(e){let t=k("link",{rel:"stylesheet",href:e});return document.head.appendChild(t),R(b(t,"load"),b(t,"error").pipe(g(()=>on(()=>new ReferenceError(`Invalid styles: ${e}`))))).pipe(f(()=>{}),Me(1))}var Ci=new I,ul=j(()=>typeof ResizeObserver=="undefined"?wt("https://unpkg.com/resize-observer-polyfill"):K(void 0)).pipe(f(()=>new ResizeObserver(e=>e.forEach(t=>Ci.next(t)))),g(e=>R(Ke,K(e)).pipe(z(()=>e.disconnect()))),ie(1));function Ae(e){return{width:e.offsetWidth,height:e.offsetHeight}}function Re(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return ul.pipe($(r=>r.observe(t)),g(r=>Ci.pipe(L(n=>n.target===t),z(()=>r.unobserve(t)))),f(()=>Ae(e)),J(Ae(e)))}function Mr(e){return{width:e.scrollWidth,height:e.scrollHeight}}function Hi(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function $i(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Et(e){return{x:e.offsetLeft,y:e.offsetTop}}function Pi(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function Ii(e){return R(b(window,"load"),b(window,"resize")).pipe(Xe(0,je),f(()=>Et(e)),J(Et(e)))}function fn(e){return{x:e.scrollLeft,y:e.scrollTop}}function Nt(e){return R(b(e,"scroll"),b(window,"scroll"),b(window,"resize")).pipe(Xe(0,je),f(()=>fn(e)),J(fn(e)))}var Ri=new I,pl=j(()=>K(new IntersectionObserver(e=>{for(let t of e)Ri.next(t)},{threshold:0}))).pipe(g(e=>R(Ke,K(e)).pipe(z(()=>e.disconnect()))),ie(1));function Tt(e){return pl.pipe($(t=>t.observe(e)),g(t=>Ri.pipe(L(({target:r})=>r===e),z(()=>t.unobserve(e)),f(({isIntersecting:r})=>r))))}var fl=Object.create,fa=Object.defineProperty,ml=Object.getOwnPropertyDescriptor,dl=Object.getOwnPropertyNames,hl=Object.getPrototypeOf,vl=Object.prototype.hasOwnProperty,bl=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports),gl=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of dl(t))!vl.call(e,o)&&o!==r&&fa(e,o,{get:()=>t[o],enumerable:!(n=ml(t,o))||n.enumerable});return e},_l=(e,t,r)=>(r=e!=null?fl(hl(e)):{},gl(t||!e||!e.__esModule?fa(r,"default",{value:e,enumerable:!0}):r,e)),yl=bl((e,t)=>{var r="Expected a function",n=NaN,o="[object Symbol]",i=/^\s+|\s+$/g,a=/^[-+]0x[0-9a-f]+$/i,s=/^0b[01]+$/i,c=/^0o[0-7]+$/i,l=parseInt,u=typeof global=="object"&&global&&global.Object===Object&&global,p=typeof self=="object"&&self&&self.Object===Object&&self,d=u||p||Function("return this")(),m=Object.prototype,h=m.toString,v=Math.max,y=Math.min,E=function(){return d.Date.now()};function T(S,D,ee){var le,ce,Ne,_t,De,lt,tt=0,Yt=!1,kt=!1,vr=!0;if(typeof S!="function")throw new TypeError(r);D=A(D)||0,_(ee)&&(Yt=!!ee.leading,kt="maxWait"in ee,Ne=kt?v(A(ee.maxWait)||0,D):Ne,vr="trailing"in ee?!!ee.trailing:vr);function G(Oe){var yt=le,br=ce;return le=ce=void 0,tt=Oe,_t=S.apply(br,yt),_t}function H(Oe){return tt=Oe,De=setTimeout(V,D),Yt?G(Oe):_t}function C(Oe){var yt=Oe-lt,br=Oe-tt,No=D-yt;return kt?y(No,Ne-br):No}function W(Oe){var yt=Oe-lt,br=Oe-tt;return lt===void 0||yt>=D||yt<0||kt&&br>=Ne}function V(){var Oe=E();if(W(Oe))return Z(Oe);De=setTimeout(V,C(Oe))}function Z(Oe){return De=void 0,vr&&le?G(Oe):(le=ce=void 0,_t)}function We(){De!==void 0&&clearTimeout(De),tt=0,le=lt=ce=De=void 0}function Jt(){return De===void 0?_t:Z(E())}function Nr(){var Oe=E(),yt=W(Oe);if(le=arguments,ce=this,lt=Oe,yt){if(De===void 0)return H(lt);if(kt)return De=setTimeout(V,D),G(lt)}return De===void 0&&(De=setTimeout(V,D)),_t}return Nr.cancel=We,Nr.flush=Jt,Nr}function _(S){var D=typeof S;return!!S&&(D=="object"||D=="function")}function de(S){return!!S&&typeof S=="object"}function be(S){return typeof S=="symbol"||de(S)&&h.call(S)==o}function A(S){if(typeof S=="number")return S;if(be(S))return n;if(_(S)){var D=typeof S.valueOf=="function"?S.valueOf():S;S=_(D)?D+"":D}if(typeof S!="string")return S===0?S:+S;S=S.replace(i,"");var ee=s.test(S);return ee||c.test(S)?l(S.slice(2),ee?2:8):a.test(S)?n:+S}t.exports=T}),En,B,ma,da,Dt,ji,ha,va,ba,fo,oo,io,xl,Ar={},ga=[],wl=/acit|ex(?:s|g|n|p|$)|rph|grid|ows|mnc|ntw|ine[ch]|zoo|^ord|itera/i,Pr=Array.isArray;function mt(e,t){for(var r in t)e[r]=t[r];return e}function mo(e){e&&e.parentNode&&e.parentNode.removeChild(e)}function Vt(e,t,r){var n,o,i,a={};for(i in t)i=="key"?n=t[i]:i=="ref"?o=t[i]:a[i]=t[i];if(arguments.length>2&&(a.children=arguments.length>3?En.call(arguments,2):r),typeof e=="function"&&e.defaultProps!=null)for(i in e.defaultProps)a[i]===void 0&&(a[i]=e.defaultProps[i]);return hn(e,a,n,o,null)}function hn(e,t,r,n,o){var i={type:e,props:t,key:r,ref:n,__k:null,__:null,__b:0,__e:null,__c:null,constructor:void 0,__v:o!=null?o:++ma,__i:-1,__u:0};return o==null&&B.vnode!=null&&B.vnode(i),i}function dt(e){return e.children}function ct(e,t){this.props=e,this.context=t}function cr(e,t){if(t==null)return e.__?cr(e.__,e.__i+1):null;for(var r;ts&&Dt.sort(va),e=Dt.shift(),s=Dt.length,e.__d&&(r=void 0,n=void 0,o=(n=(t=e).__v).__e,i=[],a=[],t.__P&&((r=mt({},n)).__v=n.__v+1,B.vnode&&B.vnode(r),ho(t.__P,r,n,t.__n,t.__P.namespaceURI,32&n.__u?[o]:null,i,o!=null?o:cr(n),!!(32&n.__u),a),r.__v=n.__v,r.__.__k[r.__i]=r,wa(i,r,a),n.__e=n.__=null,r.__e!=o&&_a(r)));_n.__r=0}function ya(e,t,r,n,o,i,a,s,c,l,u){var p,d,m,h,v,y,E,T=n&&n.__k||ga,_=t.length;for(c=El(r,t,T,c,_),p=0;p<_;p++)(m=r.__k[p])!=null&&(d=m.__i==-1?Ar:T[m.__i]||Ar,m.__i=p,y=ho(e,m,d,o,i,a,s,c,l,u),h=m.__e,m.ref&&d.ref!=m.ref&&(d.ref&&vo(d.ref,null,m),u.push(m.ref,m.__c||h,m)),v==null&&h!=null&&(v=h),(E=!!(4&m.__u))||d.__k===m.__k?c=xa(m,c,e,E):typeof m.type=="function"&&y!==void 0?c=y:h&&(c=h.nextSibling),m.__u&=-7);return r.__e=v,c}function El(e,t,r,n,o){var i,a,s,c,l,u=r.length,p=u,d=0;for(e.__k=new Array(o),i=0;i0?hn(a.type,a.props,a.key,a.ref?a.ref:null,a.__v):a).__=e,a.__b=e.__b+1,s=null,(l=a.__i=Tl(a,r,c,p))!=-1&&(p--,(s=r[l])&&(s.__u|=2)),s==null||s.__v==null?(l==-1&&(o>u?d--:oc?d--:d++,a.__u|=4))):e.__k[i]=null;if(p)for(i=0;i(u?1:0)){for(o=r-1,i=r+1;o>=0||i=0?o--:i++])!=null&&!(2&l.__u)&&s==l.key&&c==l.type)return a}return-1}function Ui(e,t,r){t[0]=="-"?e.setProperty(t,r!=null?r:""):e[t]=r==null?"":typeof r!="number"||wl.test(t)?r:r+"px"}function mn(e,t,r,n,o){var i,a;e:if(t=="style")if(typeof r=="string")e.style.cssText=r;else{if(typeof n=="string"&&(e.style.cssText=n=""),n)for(t in n)r&&t in r||Ui(e.style,t,"");if(r)for(t in r)n&&r[t]==n[t]||Ui(e.style,t,r[t])}else if(t[0]=="o"&&t[1]=="n")i=t!=(t=t.replace(ba,"$1")),a=t.toLowerCase(),t=a in e||t=="onFocusOut"||t=="onFocusIn"?a.slice(2):t.slice(2),e.l||(e.l={}),e.l[t+i]=r,r?n?r.u=n.u:(r.u=fo,e.addEventListener(t,i?io:oo,i)):e.removeEventListener(t,i?io:oo,i);else{if(o=="http://www.w3.org/2000/svg")t=t.replace(/xlink(H|:h)/,"h").replace(/sName$/,"s");else if(t!="width"&&t!="height"&&t!="href"&&t!="list"&&t!="form"&&t!="tabIndex"&&t!="download"&&t!="rowSpan"&&t!="colSpan"&&t!="role"&&t!="popover"&&t in e)try{e[t]=r!=null?r:"";break e}catch(s){}typeof r=="function"||(r==null||r===!1&&t[4]!="-"?e.removeAttribute(t):e.setAttribute(t,t=="popover"&&r==1?"":r))}}function Ni(e){return function(t){if(this.l){var r=this.l[t.type+e];if(t.t==null)t.t=fo++;else if(t.t0?e:Pr(e)?e.map(Ea):mt({},e)}function Ol(e,t,r,n,o,i,a,s,c){var l,u,p,d,m,h,v,y=r.props,E=t.props,T=t.type;if(T=="svg"?o="http://www.w3.org/2000/svg":T=="math"?o="http://www.w3.org/1998/Math/MathML":o||(o="http://www.w3.org/1999/xhtml"),i!=null){for(l=0;l=r.__.length&&r.__.push({}),r.__[e]}function yn(e){return $r=1,Ml(La,e)}function Ml(e,t,r){var n=bo(Hr++,2);if(n.t=e,!n.__c&&(n.__=[r?r(t):La(void 0,t),function(s){var c=n.__N?n.__N[0]:n.__[0],l=n.t(c,s);c!==l&&(n.__N=[l,n.__[1]],n.__c.setState({}))}],n.__c=ve,!ve.__f)){var o=function(s,c,l){if(!n.__c.__H)return!0;var u=n.__c.__H.__.filter(function(d){return!!d.__c});if(u.every(function(d){return!d.__N}))return!i||i.call(this,s,c,l);var p=n.__c.props!==s;return u.forEach(function(d){if(d.__N){var m=d.__[0];d.__=d.__N,d.__N=void 0,m!==d.__[0]&&(p=!0)}}),i&&i.call(this,s,c,l)||p};ve.__f=!0;var i=ve.shouldComponentUpdate,a=ve.componentWillUpdate;ve.componentWillUpdate=function(s,c,l){if(this.__e){var u=i;i=void 0,o(s,c,l),i=u}a&&a.call(this,s,c,l)},ve.shouldComponentUpdate=o}return n.__N||n.__}function ht(e,t){var r=bo(Hr++,3);!Ee.__s&&Sa(r.__H,t)&&(r.__=e,r.u=t,ve.__H.__h.push(r))}function zt(e){return $r=5,ur(function(){return{current:e}},[])}function ur(e,t){var r=bo(Hr++,7);return Sa(r.__H,t)&&(r.__=e(),r.__H=t,r.__h=e),r.__}function kl(e,t){return $r=8,ur(function(){return e},t)}function Al(){for(var e;e=Oa.shift();)if(e.__P&&e.__H)try{e.__H.__h.forEach(vn),e.__H.__h.forEach(so),e.__H.__h=[]}catch(t){e.__H.__h=[],Ee.__e(t,e.__v)}}Ee.__b=function(e){ve=null,Wi&&Wi(e)},Ee.__=function(e,t){e&&t.__k&&t.__k.__m&&(e.__m=t.__k.__m),Bi&&Bi(e,t)},Ee.__r=function(e){Vi&&Vi(e),Hr=0;var t=(ve=e.__c).__H;t&&(to===ve?(t.__h=[],ve.__h=[],t.__.forEach(function(r){r.__N&&(r.__=r.__N),r.u=r.__N=void 0})):(t.__h.forEach(vn),t.__h.forEach(so),t.__h=[],Hr=0)),to=ve},Ee.diffed=function(e){zi&&zi(e);var t=e.__c;t&&t.__H&&(t.__H.__h.length&&(Oa.push(t)!==1&&Di===Ee.requestAnimationFrame||((Di=Ee.requestAnimationFrame)||Cl)(Al)),t.__H.__.forEach(function(r){r.u&&(r.__H=r.u),r.u=void 0})),to=ve=null},Ee.__c=function(e,t){t.some(function(r){try{r.__h.forEach(vn),r.__h=r.__h.filter(function(n){return!n.__||so(n)})}catch(n){t.some(function(o){o.__h&&(o.__h=[])}),t=[],Ee.__e(n,r.__v)}}),qi&&qi(e,t)},Ee.unmount=function(e){Ki&&Ki(e);var t,r=e.__c;r&&r.__H&&(r.__H.__.forEach(function(n){try{vn(n)}catch(o){t=o}}),r.__H=void 0,t&&Ee.__e(t,r.__v))};var Gi=typeof requestAnimationFrame=="function";function Cl(e){var t,r=function(){clearTimeout(n),Gi&&cancelAnimationFrame(t),setTimeout(e)},n=setTimeout(r,35);Gi&&(t=requestAnimationFrame(r))}function vn(e){var t=ve,r=e.__c;typeof r=="function"&&(e.__c=void 0,r()),ve=t}function so(e){var t=ve;e.__c=e.__(),ve=t}function Sa(e,t){return!e||e.length!==t.length||t.some(function(r,n){return r!==e[n]})}function La(e,t){return typeof t=="function"?t(e):t}function Hl(e,t){for(var r in t)e[r]=t[r];return e}function Yi(e,t){for(var r in e)if(r!=="__source"&&!(r in t))return!0;for(var n in t)if(n!=="__source"&&e[n]!==t[n])return!0;return!1}function Ji(e,t){this.props=e,this.context=t}(Ji.prototype=new ct).isPureReactComponent=!0,Ji.prototype.shouldComponentUpdate=function(e,t){return Yi(this.props,e)||Yi(this.state,t)};var Xi=B.__b;B.__b=function(e){e.type&&e.type.__f&&e.ref&&(e.props.ref=e.ref,e.ref=null),Xi&&Xi(e)};var cw=typeof Symbol<"u"&&Symbol.for&&Symbol.for("react.forward_ref")||3911,$l=B.__e;B.__e=function(e,t,r,n){if(e.then){for(var o,i=t;i=i.__;)if((o=i.__c)&&o.__c)return t.__e==null&&(t.__e=r.__e,t.__k=r.__k),o.__c(e,t)}$l(e,t,r,n)};var Zi=B.unmount;function Ma(e,t,r){return e&&(e.__c&&e.__c.__H&&(e.__c.__H.__.forEach(function(n){typeof n.__c=="function"&&n.__c()}),e.__c.__H=null),(e=Hl({},e)).__c!=null&&(e.__c.__P===r&&(e.__c.__P=t),e.__c.__e=!0,e.__c=null),e.__k=e.__k&&e.__k.map(function(n){return Ma(n,t,r)})),e}function ka(e,t,r){return e&&r&&(e.__v=null,e.__k=e.__k&&e.__k.map(function(n){return ka(n,t,r)}),e.__c&&e.__c.__P===t&&(e.__e&&r.appendChild(e.__e),e.__c.__e=!0,e.__c.__P=r)),e}function ro(){this.__u=0,this.o=null,this.__b=null}function Aa(e){var t=e.__.__c;return t&&t.__a&&t.__a(e)}function dn(){this.i=null,this.l=null}B.unmount=function(e){var t=e.__c;t&&t.__R&&t.__R(),t&&32&e.__u&&(e.type=null),Zi&&Zi(e)},(ro.prototype=new ct).__c=function(e,t){var r=t.__c,n=this;n.o==null&&(n.o=[]),n.o.push(r);var o=Aa(n.__v),i=!1,a=function(){i||(i=!0,r.__R=null,o?o(s):s())};r.__R=a;var s=function(){if(!--n.__u){if(n.state.__a){var c=n.state.__a;n.__v.__k[0]=ka(c,c.__c.__P,c.__c.__O)}var l;for(n.setState({__a:n.__b=null});l=n.o.pop();)l.forceUpdate()}};n.__u++||32&t.__u||n.setState({__a:n.__b=n.__v.__k[0]}),e.then(a,a)},ro.prototype.componentWillUnmount=function(){this.o=[]},ro.prototype.render=function(e,t){if(this.__b){if(this.__v.__k){var r=document.createElement("div"),n=this.__v.__k[0].__c;this.__v.__k[0]=Ma(this.__b,r,n.__O=n.__P)}this.__b=null}var o=t.__a&&Vt(dt,null,e.fallback);return o&&(o.__u&=-33),[Vt(dt,null,t.__a?null:e.children),o]};var Qi=function(e,t,r){if(++r[1]===r[0]&&e.l.delete(t),e.props.revealOrder&&(e.props.revealOrder[0]!=="t"||!e.l.size))for(r=e.i;r;){for(;r.length>3;)r.pop()();if(r[1]Object.freeze({get current(){return t.current}}),[])}var zl=typeof globalThis<"u"&&typeof navigator<"u"&&typeof document<"u";function ql(e,...t){var r;(r=e==null?void 0:e.addEventListener)==null||r.call(e,...t)}function Kl(e,...t){var r;(r=e==null?void 0:e.removeEventListener)==null||r.call(e,...t)}var Bl=(e,t)=>Object.hasOwn(e,t),Gl=()=>!0,Yl=()=>!1;function Jl(e=!1){let t=zt(e),r=kl(()=>t.current,[]);return ht(()=>(t.current=!0,()=>{t.current=!1}),[]),r}function Xl(e,...t){let r=Jl(),n=Ha(t[1]),o=ur(()=>function(...i){r()&&(typeof n.current=="function"?n.current.apply(this,i):typeof n.current.handleEvent=="function"&&n.current.handleEvent.apply(this,i))},[]);ht(()=>{let i=Zl(e)?e.current:e;if(!i)return;let a=t.slice(2);return ql(i,t[0],o,...a),()=>{Kl(i,t[0],o,...a)}},[e,t[0]])}function Zl(e){return e!==null&&typeof e=="object"&&Bl(e,"current")}var Ql=e=>typeof e=="function"?e:typeof e=="string"?t=>t.key===e:e?Gl:Yl,eu=zl?globalThis:null;function $a(e,t,r=[],n={}){let{event:o="keydown",target:i=eu,eventOptions:a}=n,s=Ha(t),c=ur(()=>{let l=Ql(e);return function(u){l(u)&&s.current.call(this,u)}},r);Xl(i,o,c,a)}function Pa(e){var t,r,n="";if(typeof e=="string"||typeof e=="number")n+=e;else if(typeof e=="object")if(Array.isArray(e)){var o=e.length;for(t=0;t1)St--;else{for(var e,t=!1;kr!==void 0;){var r=kr;for(kr=void 0,co++;r!==void 0;){var n=r.o;if(r.o=void 0,r.f&=-3,!(8&r.f)&&ja(r))try{r.c()}catch(o){t||(e=o,t=!0)}r=n}}if(co=0,St--,t)throw e}}function nu(e){if(St>0)return e();St++;try{return e()}finally{Tn()}}var se=void 0;function Ia(e){var t=se;se=void 0;try{return e()}finally{se=t}}var kr=void 0,St=0,co=0,xn=0;function Ra(e){if(se!==void 0){var t=e.n;if(t===void 0||t.t!==se)return t={i:0,S:e,p:se.s,n:void 0,t:se,e:void 0,x:void 0,r:t},se.s!==void 0&&(se.s.n=t),se.s=t,e.n=t,32&se.f&&e.S(t),t;if(t.i===-1)return t.i=0,t.n!==void 0&&(t.n.p=t.p,t.p!==void 0&&(t.p.n=t.n),t.p=se.s,t.n=void 0,se.s.n=t,se.s=t),t}}function Ce(e,t){this.v=e,this.i=0,this.n=void 0,this.t=void 0,this.W=t==null?void 0:t.watched,this.Z=t==null?void 0:t.unwatched,this.name=t==null?void 0:t.name}Ce.prototype.brand=ru;Ce.prototype.h=function(){return!0};Ce.prototype.S=function(e){var t=this,r=this.t;r!==e&&e.e===void 0&&(e.x=r,this.t=e,r!==void 0?r.e=e:Ia(function(){var n;(n=t.W)==null||n.call(t)}))};Ce.prototype.U=function(e){var t=this;if(this.t!==void 0){var r=e.e,n=e.x;r!==void 0&&(r.x=n,e.e=void 0),n!==void 0&&(n.e=r,e.x=void 0),e===this.t&&(this.t=n,n===void 0&&Ia(function(){var o;(o=t.Z)==null||o.call(t)}))}};Ce.prototype.subscribe=function(e){var t=this;return Kt(function(){var r=t.value,n=se;se=void 0;try{e(r)}finally{se=n}},{name:"sub"})};Ce.prototype.valueOf=function(){return this.value};Ce.prototype.toString=function(){return this.value+""};Ce.prototype.toJSON=function(){return this.value};Ce.prototype.peek=function(){var e=se;se=void 0;try{return this.value}finally{se=e}};Object.defineProperty(Ce.prototype,"value",{get:function(){var e=Ra(this);return e!==void 0&&(e.i=this.i),this.v},set:function(e){if(e!==this.v){if(co>100)throw new Error("Cycle detected");this.v=e,this.i++,xn++,St++;try{for(var t=this.t;t!==void 0;t=t.x)t.t.N()}finally{Tn()}}}});function Lt(e,t){return new Ce(e,t)}function ja(e){for(var t=e.s;t!==void 0;t=t.n)if(t.S.i!==t.i||!t.S.h()||t.S.i!==t.i)return!0;return!1}function Fa(e){for(var t=e.s;t!==void 0;t=t.n){var r=t.S.n;if(r!==void 0&&(t.r=r),t.S.n=t,t.i=-1,t.n===void 0){e.s=t;break}}}function Ua(e){for(var t=e.s,r=void 0;t!==void 0;){var n=t.p;t.i===-1?(t.S.U(t),n!==void 0&&(n.n=t.n),t.n!==void 0&&(t.n.p=n)):r=t,t.S.n=t.r,t.r!==void 0&&(t.r=void 0),t=n}e.s=r}function Bt(e,t){Ce.call(this,void 0),this.x=e,this.s=void 0,this.g=xn-1,this.f=4,this.W=t==null?void 0:t.watched,this.Z=t==null?void 0:t.unwatched,this.name=t==null?void 0:t.name}Bt.prototype=new Ce;Bt.prototype.h=function(){if(this.f&=-3,1&this.f)return!1;if((36&this.f)==32||(this.f&=-5,this.g===xn))return!0;if(this.g=xn,this.f|=1,this.i>0&&!ja(this))return this.f&=-2,!0;var e=se;try{Fa(this),se=this;var t=this.x();(16&this.f||this.v!==t||this.i===0)&&(this.v=t,this.f&=-17,this.i++)}catch(r){this.v=r,this.f|=16,this.i++}return se=e,Ua(this),this.f&=-2,!0};Bt.prototype.S=function(e){if(this.t===void 0){this.f|=36;for(var t=this.s;t!==void 0;t=t.n)t.S.S(t)}Ce.prototype.S.call(this,e)};Bt.prototype.U=function(e){if(this.t!==void 0&&(Ce.prototype.U.call(this,e),this.t===void 0)){this.f&=-33;for(var t=this.s;t!==void 0;t=t.n)t.S.U(t)}};Bt.prototype.N=function(){if(!(2&this.f)){this.f|=6;for(var e=this.t;e!==void 0;e=e.x)e.t.N()}};Object.defineProperty(Bt.prototype,"value",{get:function(){if(1&this.f)throw new Error("Cycle detected");var e=Ra(this);if(this.h(),e!==void 0&&(e.i=this.i),16&this.f)throw this.v;return this.v}});function oa(e,t){return new Bt(e,t)}function Na(e){var t=e.u;if(e.u=void 0,typeof t=="function"){St++;var r=se;se=void 0;try{t()}catch(n){throw e.f&=-2,e.f|=8,go(e),n}finally{se=r,Tn()}}}function go(e){for(var t=e.s;t!==void 0;t=t.n)t.S.U(t);e.x=void 0,e.s=void 0,Na(e)}function ou(e){if(se!==this)throw new Error("Out-of-order effect");Ua(this),se=e,this.f&=-2,8&this.f&&go(this),Tn()}function pr(e,t){this.x=e,this.u=void 0,this.s=void 0,this.o=void 0,this.f=32,this.name=t==null?void 0:t.name}pr.prototype.c=function(){var e=this.S();try{if(8&this.f||this.x===void 0)return;var t=this.x();typeof t=="function"&&(this.u=t)}finally{e()}};pr.prototype.S=function(){if(1&this.f)throw new Error("Cycle detected");this.f|=1,this.f&=-9,Na(this),Fa(this),St++;var e=se;return se=this,ou.bind(this,e)};pr.prototype.N=function(){2&this.f||(this.f|=2,this.o=kr,kr=this)};pr.prototype.d=function(){this.f|=8,1&this.f||go(this)};pr.prototype.dispose=function(){this.d()};function Kt(e,t){var r=new pr(e,t);try{r.c()}catch(o){throw r.d(),o}var n=r.d.bind(r);return n[Symbol.dispose]=n,n}var Da,_o,no,Wa=[];Kt(function(){Da=this.N})();function fr(e,t){B[e]=t.bind(null,B[e]||function(){})}function wn(e){no&&no(),no=e&&e.S()}function Va(e){var t=this,r=e.data,n=au(r);n.value=r;var o=ur(function(){for(var s=t,c=t.__v;c=c.__;)if(c.__c){c.__c.__$f|=4;break}var l=oa(function(){var m=n.value.value;return m===0?0:m===!0?"":m||""}),u=oa(function(){return!Array.isArray(l.value)&&!da(l.value)}),p=Kt(function(){if(this.N=za,u.value){var m=l.value;s.__v&&s.__v.__e&&s.__v.__e.nodeType===3&&(s.__v.__e.data=m)}}),d=t.__$u.d;return t.__$u.d=function(){p(),d.call(this)},[u,l]},[]),i=o[0],a=o[1];return i.value?a.peek():a.value}Va.displayName="ReactiveTextNode";Object.defineProperties(Ce.prototype,{constructor:{configurable:!0,value:void 0},type:{configurable:!0,value:Va},props:{configurable:!0,get:function(){return{data:this}}},__b:{configurable:!0,value:1}});fr("__b",function(e,t){if(typeof t.type=="function"&&typeof window<"u"&&window.__PREACT_SIGNALS_DEVTOOLS__&&window.__PREACT_SIGNALS_DEVTOOLS__.exitComponent(),typeof t.type=="string"){var r,n=t.props;for(var o in n)if(o!=="children"){var i=n[o];i instanceof Ce&&(r||(t.__np=r={}),r[o]=i,n[o]=i.peek())}}e(t)});fr("__r",function(e,t){if(typeof t.type=="function"&&typeof window<"u"&&window.__PREACT_SIGNALS_DEVTOOLS__&&window.__PREACT_SIGNALS_DEVTOOLS__.enterComponent(t),t.type!==dt){wn();var r,n=t.__c;n&&(n.__$f&=-2,(r=n.__$u)===void 0&&(n.__$u=r=(function(o){var i;return Kt(function(){i=this}),i.c=function(){n.__$f|=1,n.setState({})},i})())),_o=n,wn(r)}e(t)});fr("__e",function(e,t,r,n){typeof window<"u"&&window.__PREACT_SIGNALS_DEVTOOLS__&&window.__PREACT_SIGNALS_DEVTOOLS__.exitComponent(),wn(),_o=void 0,e(t,r,n)});fr("diffed",function(e,t){typeof t.type=="function"&&typeof window<"u"&&window.__PREACT_SIGNALS_DEVTOOLS__&&window.__PREACT_SIGNALS_DEVTOOLS__.exitComponent(),wn(),_o=void 0;var r;if(typeof t.type=="string"&&(r=t.__e)){var n=t.__np,o=t.props;if(n){var i=r.U;if(i)for(var a in i){var s=i[a];s!==void 0&&!(a in n)&&(s.d(),i[a]=void 0)}else i={},r.U=i;for(var c in n){var l=i[c],u=n[c];l===void 0?(l=iu(r,c,u,o),i[c]=l):l.o(u,o)}}}e(t)});function iu(e,t,r,n){var o=t in e&&e.ownerSVGElement===void 0,i=Lt(r);return{o:function(a,s){i.value=a,n=s},d:Kt(function(){this.N=za;var a=i.value.value;n[t]!==a&&(n[t]=a,o?e[t]=a:a?e.setAttribute(t,a):e.removeAttribute(t))})}}fr("unmount",function(e,t){if(typeof t.type=="string"){var r=t.__e;if(r){var n=r.U;if(n){r.U=void 0;for(var o in n){var i=n[o];i&&i.d()}}}}else{var a=t.__c;if(a){var s=a.__$u;s&&(a.__$u=void 0,s.d())}}e(t)});fr("__h",function(e,t,r,n){(n<3||n===9)&&(t.__$f|=2),e(t,r,n)});ct.prototype.shouldComponentUpdate=function(e,t){var r=this.__$u,n=r&&r.s!==void 0;for(var o in t)return!0;if(this.__f||typeof this.u=="boolean"&&this.u===!0){var i=2&this.__$f;if(!(n||i||4&this.__$f)||1&this.__$f)return!0}else if(!(n||4&this.__$f)||3&this.__$f)return!0;for(var a in e)if(a!=="__source"&&e[a]!==this.props[a])return!0;for(var s in this.props)if(!(s in e))return!0;return!1};function au(e,t){return yn(function(){return Lt(e,t)})[0]}var su=function(e){queueMicrotask(function(){queueMicrotask(e)})};function cu(){nu(function(){for(var e;e=Wa.shift();)Da.call(e)})}function za(){Wa.push(this)===1&&(B.requestAnimationFrame||su)(cu)}var lo=[0];for(let e=0;e<32;e++)lo.push(lo[e]|1<>>5]>>>e&1}set(e){this.data[e>>>5]|=1<<(e&31)}forEach(e){let t=this.size&31;for(let r=0;r{var r;return(r=t.tags)==null?void 0:r.length})&&(matchMedia("(max-width: 768px)").matches||qa())}function Wt(){Qe.value=He(M({},Qe.value),{hideSearch:!Qe.value.hideSearch})}function qa(){Qe.value=He(M({},Qe.value),{hideFilters:!Qe.value.hideFilters})}function bn(){return Qe.value.selectedItem}function uo(e){Qe.value=He(M({},Qe.value),{selectedItem:e})}function pu(){var e,t;return(t=(e=lr.value)==null?void 0:e.items)!=null?t:[]}function On(){return typeof Se.value.input=="string"?Se.value.input:""}function Ka(e){let t=Ba();e.length&&!t.length?Se.value=He(M({},Se.value),{page:void 0,input:e}):!e.length&&t.length?Se.value=He(M({},Se.value),{page:void 0,input:{type:"operator",data:{operator:"not",operands:[]}}}):Se.value=He(M({},Se.value),{page:void 0,input:e})}function fu(){typeof st.value.pagination.next<"u"&&(Se.value=He(M({},Se.value),{page:st.value.pagination.next}))}function mu(e){let t=Se.value.filter.input;if("type"in t&&t.type==="operator"){for(let r of t.data.operands)if("type"in r&&r.type==="value"&&typeof r.data.value=="string"&&r.data.value===e)return!0}return!1}function Ba(){let e=Se.value.filter.input,t=[];if("type"in e&&e.type==="operator")for(let r of e.data.operands)"type"in r&&r.type==="value"&&typeof r.data.value=="string"&&t.push(r.data.value);return t}function du(e){let t=Se.value.filter.input,r=[];if("type"in t&&t.type==="operator")for(let n of t.data.operands)"type"in n&&n.type==="value"&&typeof n.data.value=="string"&&r.push(n.data.value);if(r.includes(e)){let n=r.indexOf(e);n>-1&&r.splice(n,1)}else r.push(e);Se.value=He(M({},Se.value),{page:void 0,filter:He(M({},Se.value.filter),{input:{type:"operator",data:{operator:"and",operands:r.map(n=>({type:"value",data:{field:"tags",value:n}}))}}})}),Ka(On())}function hu(){return st.value.items}function vu(){return st.value.total}function bu(){var e;for(let t of(e=st.value.aggregations)!=null?e:[])if(t.type==="term")return t.data.value;return[]}function sr(){return Qe.value.hideSearch}function gu(){return Qe.value.hideFilters}function Ga(){var e;return(e=Ya.value.highlight)!=null?e:!1}var Qe=Lt({hideSearch:!0,hideFilters:!0,selectedItem:0}),Ya=Lt({}),lr=Lt(),aa=Lt(),Se=Lt({input:"",filter:{input:{type:"operator",data:{operator:"and",operands:[]}},aggregation:{input:[{type:"term",data:{field:"tags"}}]}}}),st=Lt({items:[],query:{select:{documents:new ia(0),terms:new ia(0)},values:[]},pagination:{total:0}});function _u(e,t,r){for(let n=0;tr&&t(0,o,r,r=i);continue;case 62:e.charCodeAt(r+1)===47?t(2,--o,r,r=i+1):_u(e,r,n)?t(3,o,r,r=i+1):t(1,o++,r,r=i+1)}i>r&&t(0,o,r,i)}function xu(e,t=0,r=e.length){let n=++t;e:for(let l=0;n{let i=[],a=[],{onElement:s,onText:c=wu}=typeof r=="function"?{onElement:r}:r,l=0,u=0;return e(t,(p,d,m,h)=>{if(p===0)i[l++]=c(t,m,h),a[u++]={value:null,depth:d};else if(p&1&&(a[u++]={value:xu(t,m,h),depth:d}),p&2)for(let v=0;u>=0;v++){let{value:y,depth:E}=a[--u];if(E>d)continue;let T=i.slice(l-=v,l+v);i[l++]=s(y,T),u++;break}},n,o),i.slice(0,l)}}function Tu(e){return e.replace(/[&<>]/g,t=>{switch(t.charCodeAt(0)){case 38:return"&";case 60:return"<";case 62:return">"}})}function gn(e){return e.replace(/&(amp|[lg]t);/g,t=>{switch(t.charCodeAt(1)){case 97:return"&";case 108:return"<";case 103:return">"}})}function Ou(e,t){return{start:e.start+t,end:e.end+t,value:e.value}}function Su(e,t,r){return e.slice(t,r)}function Lu(e){let{onHighlight:t,onText:r=Su}=typeof e=="function"?{onHighlight:e}:e;return(n,o,i=0,a=n.length)=>{var l;let s=[],c=(l=o==null?void 0:o.ranges)!=null?l:[];for(let u=0,p=i;ua)break;let m=c[u].end;if(mi&&s.push(r(n,i,d));let{value:h}=c[u];s.push(t(n,{start:d,end:i=m,value:h}))}return i{let o=n.data;switch(o.type){case 1:aa.value=!0;break;case 3:typeof o.data.pagination.prev<"u"?st.value=He(M({},st.value),{pagination:o.data.pagination,items:[...st.value.items,...o.data.items]}):(st.value=o.data,uo(0));break}},Kt(()=>{lr.value&&r.postMessage({type:0,data:lr.value})}),Kt(()=>{aa.value&&r.postMessage({type:2,data:Se.value})})}var sa={container:"p",hidden:"m"};function $u(e){return q("div",{class:qt(sa.container,{[sa.hidden]:e.hidden}),onClick:()=>Wt()})}var ca={container:"r",disabled:"c"};function po(e){return q("button",{class:qt(ca.container,{[ca.disabled]:!e.onClick}),onClick:e.onClick,children:e.children})}var la=e=>e.replace(/([a-z0-9])([A-Z])/g,"$1-$2").toLowerCase(),Pu=e=>e.replace(/^([A-Z])|[\s-_]+(\w)/g,(t,r,n)=>n?n.toUpperCase():r.toLowerCase()),ua=e=>{let t=Pu(e);return t.charAt(0).toUpperCase()+t.slice(1)},Iu=(...e)=>e.filter((t,r,n)=>!!t&&t.trim()!==""&&n.indexOf(t)===r).join(" ").trim(),Ru={xmlns:"http://www.w3.org/2000/svg",width:24,height:24,viewBox:"0 0 24 24",fill:"none",stroke:"currentColor","stroke-width":"2","stroke-linecap":"round","stroke-linejoin":"round"},ju=c=>{var l=c,{color:e="currentColor",size:t=24,strokeWidth:r=2,absoluteStrokeWidth:n,children:o,iconNode:i,class:a=""}=l,s=gr(l,["color","size","strokeWidth","absoluteStrokeWidth","children","iconNode","class"]);return Vt("svg",M(He(M({},Ru),{width:String(t),height:t,stroke:e,"stroke-width":n?Number(r)*24/Number(t):r,class:["lucide",a].join(" ")}),s),[...i.map(([u,p])=>Vt(u,p)),...Cr(o)])},yo=(e,t)=>{let r=a=>{var s=a,{class:n="",children:o}=s,i=gr(s,["class","children"]);return Vt(ju,He(M({},i),{iconNode:t,class:Iu(`lucide-${la(ua(e))}`,`lucide-${la(e)}`,n)}),o)};return r.displayName=ua(e),r},Fu=yo("corner-down-left",[["path",{d:"M20 4v7a4 4 0 0 1-4 4H4",key:"6o5b7l"}],["path",{d:"m9 10-5 5 5 5",key:"1kshq7"}]]),Uu=yo("list-filter",[["path",{d:"M2 5h20",key:"1fs1ex"}],["path",{d:"M6 12h12",key:"8npq4p"}],["path",{d:"M9 19h6",key:"456am0"}]]),Nu=yo("search",[["path",{d:"m21 21-4.34-4.34",key:"14j7rj"}],["circle",{cx:"11",cy:"11",r:"8",key:"4ej97u"}]]),lw=_l(yl(),1);function Du({threshold:e=0,root:t=null,rootMargin:r="0%",freezeOnceVisible:n=!1,initialIsIntersecting:o=!1,onChange:i}={}){var a;let[s,c]=yn(null),[l,u]=yn(()=>({isIntersecting:o,entry:void 0})),p=zt();p.current=i;let d=((a=l.entry)==null?void 0:a.isIntersecting)&&n;ht(()=>{if(!s||!("IntersectionObserver"in window)||d)return;let v,y=new IntersectionObserver(E=>{let T=Array.isArray(y.thresholds)?y.thresholds:[y.thresholds];E.forEach(_=>{let de=_.isIntersecting&&T.some(be=>_.intersectionRatio>=be);u({isIntersecting:de,entry:_}),p.current&&p.current(de,_),de&&n&&v&&(v(),v=void 0)})},{threshold:e,root:t,rootMargin:r});return y.observe(s),()=>{y.disconnect()}},[s,JSON.stringify(e),t,r,d,n]);let m=zt(null);ht(()=>{var v;!s&&(v=l.entry)!=null&&v.target&&!n&&!d&&m.current!==l.entry.target&&(m.current=l.entry.target,u({isIntersecting:o,entry:void 0}))},[s,l.entry,n,d,o]);let h=[c,!!l.isIntersecting,l.entry];return h.ref=h[0],h.isIntersecting=h[1],h.entry=h[2],h}var pt={container:"n",hidden:"l",content:"u",pop:"d",badge:"y",sidebar:"i",controls:"w",results:"k",loadmore:"z"};function Wu(e){let{isIntersecting:t,ref:r}=Du({threshold:0});ht(()=>{t&&fu()},[t]);let n=zt(null);ht(()=>{n.current&&typeof Se.value.page>"u"&&n.current.scrollTo({top:0,behavior:"smooth"})},[Se.value]);let o=Ba();return q("div",{class:qt(pt.container,{[pt.hidden]:e.hidden}),children:[q("div",{class:pt.content,children:[q("div",{class:pt.controls,children:[q(po,{onClick:Wt,children:q(Nu,{})}),q(zu,{focus:!e.hidden}),q(po,{onClick:qa,children:[q(Uu,{}),o.length>0&&q("span",{class:pt.badge,children:o.length})]})]}),q("div",{class:pt.results,ref:n,children:[q(qu,{keyboard:!e.hidden}),q("div",{class:pt.loadmore,ref:r})]})]}),q("div",{class:qt(pt.sidebar,{[pt.hidden]:gu()}),children:q(Vu,{})})]})}var Ot={container:"X",list:"j",heading:"F",title:"I",item:"o",active:"g",value:"R",count:"q"};function Vu(e){let t=bu();return t.sort((r,n)=>n.node.count-r.node.count),q("div",{class:Ot.container,children:[q("h3",{class:Ot.heading,children:"Filters"}),q("h4",{class:Ot.title,children:"Tags"}),q("ol",{class:Ot.list,children:t.map(r=>q("li",{class:qt(Ot.item,{[Ot.active]:mu(r.node.value)}),onClick:()=>du(r.node.value),children:[q("span",{class:Ot.value,children:r.node.value}),q("span",{class:Ot.count,children:r.node.count})]}))})]})}var pa={container:"f"};function zu(e){let t=zt(null);return ht(()=>{var r,n;e.focus?(r=t.current)==null||r.focus():(n=t.current)==null||n.blur()},[e.focus]),q("div",{class:pa.container,children:q("input",{ref:t,type:"text",class:pa.content,value:gn(On()),onInput:r=>Ka(Tu(r.currentTarget.value)),autocapitalize:"off",autocomplete:"off",autocorrect:"off",placeholder:"Search",spellcheck:!1,role:"combobox"})})}var ft={container:"b",heading:"A",item:"a",active:"h",wrapper:"B",actions:"s",title:"x",path:"t"};function Za(){let[e,t]=yn(!1);return ht(()=>{let r=()=>t(!0),n=()=>t(!1);return document.addEventListener("compositionstart",r),document.addEventListener("compositionend",n),()=>{document.removeEventListener("compositionstart",r),document.removeEventListener("compositionend",n)}},[]),e}function qu(e){var s;let t=pu(),r=hu(),n=bn(),o=zt([]),i=Za();ht(()=>{let c=o.current[n];c&&c.scrollIntoView({block:"center",behavior:"smooth"})},[n]),$a(e.keyboard,c=>{if(i)return;let l=bn();c.key==="ArrowDown"?(c.preventDefault(),uo(Math.min(l+1,r.length-1))):c.key==="ArrowUp"&&(c.preventDefault(),uo(Math.max(l-1,0)))},[e.keyboard,i]);let a=(s=vu())!=null?s:0;return q(dt,{children:[r.length>0&&q("h3",{class:ft.heading,children:[q("span",{class:ft.bubble,children:new Intl.NumberFormat("en-US").format(a)})," ","results"]}),q("ol",{class:ft.container,children:r.map((c,l)=>{var m;let u=Ja(t[c.id].title,c.matches.find(({field:h})=>h==="title")),p=Hu((m=t[c.id].path)!=null?m:[],c.matches.find(({field:h})=>h==="path")),d=t[c.id].location;if(Ga()){let h=encodeURIComponent(On()),[v,y]=d.split("#",2);d=`${v}?h=${h.replace(/%20/g,"+")}`,typeof y<"u"&&(d+=`#${y}`)}return q("li",{children:q("a",{ref:h=>{o.current[l]=h},href:d,onClick:()=>Wt(),class:qt(ft.item,{[ft.active]:l===bn()}),children:[q("div",{class:ft.wrapper,children:[q("h2",{class:ft.title,children:u}),q("menu",{class:ft.path,children:p.map(h=>q("li",{children:h}))})]}),q("nav",{class:ft.actions,children:q(po,{children:q(Fu,{})})})]})})})})]})}var Ku={container:"e"};function Bu(e){let t=Za();return $a(!0,r=>{var n,o,i,a,s;if(!t)if((r.metaKey||r.ctrlKey)&&r.key==="k")r.preventDefault(),Wt();else if((r.metaKey||r.ctrlKey)&&r.key==="j")document.body.classList.toggle("dark");else if(r.key==="Enter"&&!sr()){r.preventDefault();let c=bn(),l=(o=(n=st.value)==null?void 0:n.items[c])==null?void 0:o.id;if((a=(i=lr.value)==null?void 0:i.items[l])!=null&&a.location){Wt();let u=(s=lr.value)==null?void 0:s.items[l].location;if(Ga()){let p=encodeURIComponent(On()),[d,m]=u.split("#",2);u=`${d}?h=${p.replace(/%20/g,"+")}`,typeof m<"u"&&(u+=`#${m}`)}window.location.href=u}}else r.key==="Escape"&&!sr()&&(r.preventDefault(),Wt())},[t]),q("div",{class:Ku.container,children:[q($u,{hidden:sr()}),q(Wu,{hidden:sr()})]})}function Qa(e,t){uu(e),Ll(q(Bu,{}),t)}function xo(){Wt()}function Gu(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Yu(){return R(b(window,"compositionstart").pipe(f(()=>!0)),b(window,"compositionend").pipe(f(()=>!1))).pipe(J(!1))}function es(){let e=b(window,"keydown").pipe(f(t=>({mode:sr()?"global":"search",type:t.key,meta:t.ctrlKey||t.metaKey,claim(){t.preventDefault(),t.stopPropagation()}})),L(({mode:t,type:r})=>{if(t==="global"){let n=xt();if(typeof n!="undefined")return!Gu(n,r)}return!0}),xe());return Yu().pipe(g(t=>t?x:e))}function Ge(){return new URL(location.href)}function vt(e,t=!1){if(X("navigation.instant")&&!t){let r=k("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function ts(){return new I}function rs(){return location.hash.slice(1)}function ns(e){let t=k("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function wo(e){return R(b(window,"hashchange"),e).pipe(f(rs),J(rs()),L(t=>t.length>0),f(decodeURIComponent),ie(1))}function os(e){return wo(e).pipe(f(t=>we(`[id="${t}"]`)),L(t=>typeof t!="undefined"))}function Ir(e){let t=matchMedia(e);return ln(r=>t.addListener(()=>r(t.matches))).pipe(J(t.matches))}function is(){let e=matchMedia("print");return R(b(window,"beforeprint").pipe(f(()=>!0)),b(window,"afterprint").pipe(f(()=>!1))).pipe(J(e.matches))}function Eo(e,t){return e.pipe(g(r=>r?t():x))}function To(e,t){return new F(r=>{let n=new XMLHttpRequest;return n.open("GET",`${e}`),n.responseType="blob",n.addEventListener("load",()=>{n.status>=200&&n.status<300?(r.next(n.response),r.complete()):r.error(new Error(n.statusText))}),n.addEventListener("error",()=>{r.error(new Error("Network error"))}),n.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(n.addEventListener("progress",o=>{var i;if(o.lengthComputable)t.progress$.next(o.loaded/o.total*100);else{let a=(i=n.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(o.loaded/+a*100)}}),t.progress$.next(5)),n.send(),()=>n.abort()})}function et(e,t){return To(e,t).pipe(g(r=>r.text()),f(r=>JSON.parse(r)),ie(1))}function Sn(e,t){let r=new DOMParser;return To(e,t).pipe(g(n=>n.text()),f(n=>r.parseFromString(n,"text/html")),ie(1))}function as(e,t){let r=new DOMParser;return To(e,t).pipe(g(n=>n.text()),f(n=>r.parseFromString(n,"text/xml")),ie(1))}var Oo={drawer:Y("[data-md-toggle=drawer]"),search:Y("[data-md-toggle=search]")};function So(e,t){Oo[e].checked!==t&&Oo[e].click()}function Ln(e){let t=Oo[e];return b(t,"change").pipe(f(()=>t.checked),J(t.checked))}function ss(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function cs(){return R(b(window,"scroll",{passive:!0}),b(window,"resize",{passive:!0})).pipe(f(ss),J(ss()))}function ls(){return{width:innerWidth,height:innerHeight}}function us(){return b(window,"resize",{passive:!0}).pipe(f(ls),J(ls()))}function ps(){return re([cs(),us()]).pipe(f(([e,t])=>({offset:e,size:t})),ie(1))}function Mn(e,{viewport$:t,header$:r}){let n=t.pipe(fe("size")),o=re([n,r]).pipe(f(()=>Et(e)));return re([r,t,o]).pipe(f(([{height:i},{offset:a,size:s},{x:c,y:l}])=>({offset:{x:a.x-c,y:a.y-l+i},size:s})))}var Ju=Y("#__config"),mr=JSON.parse(Ju.textContent);mr.base=`${new URL(mr.base,Ge())}`;function Ue(){return mr}function X(e){return mr.features.includes(e)}function Gt(e,t){return typeof t!="undefined"?mr.translations[e].replace("#",t.toString()):mr.translations[e]}function bt(e,t=document){return Y(`[data-md-component=${e}]`,t)}function Te(e,t=document){return P(`[data-md-component=${e}]`,t)}function Xu(e){let t=Y(".md-typeset > :first-child",e);return b(t,"click",{once:!0}).pipe(f(()=>Y(".md-typeset",e)),f(r=>({hash:__md_hash(r.innerHTML)})))}function fs(e){if(!X("announce.dismiss")||!e.childElementCount)return x;if(!e.hidden){let t=Y(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return j(()=>{let t=new I;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),Xu(e).pipe($(r=>t.next(r)),z(()=>t.complete()),f(r=>M({ref:e},r)))})}function Zu(e,{target$:t}){return t.pipe(f(r=>({hidden:r!==e})))}function ms(e,t){let r=new I;return r.subscribe(({hidden:n})=>{e.hidden=n}),Zu(e,t).pipe($(n=>r.next(n)),z(()=>r.complete()),f(n=>M({ref:e},n)))}function Lo(e,t){return t==="inline"?k("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},k("div",{class:"md-tooltip__inner md-typeset"})):k("div",{class:"md-tooltip",id:e,role:"tooltip"},k("div",{class:"md-tooltip__inner md-typeset"}))}function kn(...e){return k("div",{class:"md-tooltip2",role:"dialog"},k("div",{class:"md-tooltip2__inner md-typeset"},e))}function ds(...e){return k("div",{class:"md-tooltip2",role:"tooltip"},k("div",{class:"md-tooltip2__inner md-typeset"},e))}function hs(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return k("aside",{class:"md-annotation",tabIndex:0},Lo(t),k("a",{href:r,class:"md-annotation__index",tabIndex:-1},k("span",{"data-md-annotation-id":e})))}else return k("aside",{class:"md-annotation",tabIndex:0},Lo(t),k("span",{class:"md-annotation__index",tabIndex:-1},k("span",{"data-md-annotation-id":e})))}function vs(e){return k("button",{class:"md-code__button",title:Gt("clipboard.copy"),"data-clipboard-target":`#${e} > code`,"data-md-type":"copy"})}function bs(){return k("button",{class:"md-code__button",title:"Toggle line selection","data-md-type":"select"})}function gs(){return k("nav",{class:"md-code__nav"})}var tp=_r(Mo());function ys(e){return k("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>k("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?ki(r):r)))}function ko(e){let t=`tabbed-control tabbed-control--${e}`;return k("div",{class:t,hidden:!0},k("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function xs(e){return k("div",{class:"md-typeset__scrollwrap"},k("div",{class:"md-typeset__table"},e))}function rp(e){var n;let t=Ue(),r=new URL(`../${e.version}/`,t.base);return k("li",{class:"md-version__item"},k("a",{href:`${r}`,class:"md-version__link"},e.title,((n=t.version)==null?void 0:n.alias)&&e.aliases.length>0&&k("span",{class:"md-version__alias"},e.aliases[0])))}function ws(e,t){var n;let r=Ue();return e=e.filter(o=>{var i;return!((i=o.properties)!=null&&i.hidden)}),k("div",{class:"md-version"},k("button",{class:"md-version__current","aria-label":Gt("select.version")},t.title,((n=r.version)==null?void 0:n.alias)&&t.aliases.length>0&&k("span",{class:"md-version__alias"},t.aliases[0])),k("ul",{class:"md-version__list"},e.map(rp)))}var np=0;function op(e,t=250){let r=re([ar(e),Ut(e,t)]).pipe(f(([o,i])=>o||i),ae()),n=j(()=>$i(e)).pipe(oe(Nt),Lr(1),Ze(r),f(()=>Pi(e)));return r.pipe(Or(o=>o),g(()=>re([r,n])),f(([o,i])=>({active:o,offset:i})),xe())}function Rr(e,t,r=250){let{content$:n,viewport$:o}=t,i=`__tooltip2_${np++}`;return j(()=>{let a=new I,s=new Wn(!1);a.pipe(he(),ye(!1)).subscribe(s);let c=s.pipe(Tr(u=>Ve(+!u*250,qn)),ae(),g(u=>u?n:x),$(u=>u.id=i),xe());re([a.pipe(f(({active:u})=>u)),c.pipe(g(u=>Ut(u,250)),J(!1))]).pipe(f(u=>u.some(p=>p))).subscribe(s);let l=s.pipe(L(u=>u),pe(c,o),f(([u,p,{size:d}])=>{let m=e.getBoundingClientRect(),h=m.width/2;if(p.role==="tooltip")return{x:h,y:8+m.height};if(m.y>=d.height/2){let{height:v}=Ae(p);return{x:h,y:-16-v}}else return{x:h,y:16+m.height}}));return re([c,a,l]).subscribe(([u,{offset:p},d])=>{u.style.setProperty("--md-tooltip-host-x",`${p.x}px`),u.style.setProperty("--md-tooltip-host-y",`${p.y}px`),u.style.setProperty("--md-tooltip-x",`${d.x}px`),u.style.setProperty("--md-tooltip-y",`${d.y}px`),u.classList.toggle("md-tooltip2--top",d.y<0),u.classList.toggle("md-tooltip2--bottom",d.y>=0)}),s.pipe(L(u=>u),pe(c,(u,p)=>p),L(u=>u.role==="tooltip")).subscribe(u=>{let p=Ae(Y(":scope > *",u));u.style.setProperty("--md-tooltip-width",`${p.width}px`),u.style.setProperty("--md-tooltip-tail","0px")}),s.pipe(ae(),Ie(je),pe(c)).subscribe(([u,p])=>{p.classList.toggle("md-tooltip2--active",u)}),re([s.pipe(L(u=>u)),c]).subscribe(([u,p])=>{p.role==="dialog"?(e.setAttribute("aria-controls",i),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",i)}),s.pipe(L(u=>!u)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),op(e,r).pipe($(u=>a.next(u)),z(()=>a.complete()),f(u=>M({ref:e},u)))})}function Ye(e,{viewport$:t},r=document.body){return Rr(e,{content$:new F(n=>{let o=e.title,i=ds(o);return n.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",o)}}),viewport$:t},0)}function ip(e,t){let r=j(()=>re([Ii(e),Nt(t)])).pipe(f(([{x:n,y:o},i])=>{let{width:a,height:s}=Ae(e);return{x:n-i.x+a/2,y:o-i.y+s/2}}));return ar(e).pipe(g(n=>r.pipe(f(o=>({active:n,offset:o})),Me(+!n||1/0))))}function Es(e,t,{target$:r}){let[n,o]=Array.from(e.children);return j(()=>{let i=new I,a=i.pipe(he(),ye(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),Tt(e).pipe(Q(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),R(i.pipe(L(({active:s})=>s)),i.pipe(Be(250),L(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(n):n.remove()},complete(){e.prepend(n)}}),i.pipe(Xe(16,je)).subscribe(({active:s})=>{n.classList.toggle("md-tooltip--active",s)}),i.pipe(Lr(125,je),L(()=>!!e.offsetParent),f(()=>e.offsetParent.getBoundingClientRect()),f(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),b(o,"click").pipe(Q(a),L(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),b(o,"mousedown").pipe(Q(a),pe(i)).subscribe(([s,{active:c}])=>{var l;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(c){s.preventDefault();let u=e.parentElement.closest(".md-annotation");u instanceof HTMLElement?u.focus():(l=xt())==null||l.blur()}}),r.pipe(Q(a),L(s=>s===n),Rt(125)).subscribe(()=>e.focus()),ip(e,t).pipe($(s=>i.next(s)),z(()=>i.complete()),f(s=>M({ref:e},s)))})}function ap(e){let t=Ue();if(e.tagName!=="CODE")return[e];let r=[".c",".c1",".cm"];if(t.annotate){let n=e.closest("[class|=language]");if(n)for(let o of Array.from(n.classList)){if(!o.startsWith("language-"))continue;let[,i]=o.split("-");i in t.annotate&&r.push(...t.annotate[i])}}return P(r.join(", "),e)}function sp(e){let t=[];for(let r of ap(e)){let n=[],o=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=o.nextNode();i;i=o.nextNode())n.push(i);for(let i of n){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,c]=a;if(typeof c=="undefined"){let l=i.splitText(a.index);i=l.splitText(s.length),t.push(l)}else{i.textContent=s,t.push(i);break}}}}return t}function Ts(e,t){t.append(...Array.from(e.childNodes))}function An(e,t,{target$:r,print$:n}){let o=t.closest("[id]"),i=o==null?void 0:o.id,a=new Map;for(let s of sp(t)){let[,c]=s.textContent.match(/\((\d+)\)/);we(`:scope > li:nth-child(${c})`,e)&&(a.set(c,hs(c,i)),s.replaceWith(a.get(c)))}return a.size===0?x:j(()=>{let s=new I,c=s.pipe(he(),ye(!0)),l=[];for(let[u,p]of a)l.push([Y(".md-typeset",p),Y(`:scope > li:nth-child(${u})`,e)]);return n.pipe(Q(c)).subscribe(u=>{e.hidden=!u,e.classList.toggle("md-annotation-list",u);for(let[p,d]of l)u?Ts(p,d):Ts(d,p)}),R(...[...a].map(([,u])=>Es(u,t,{target$:r}))).pipe(z(()=>s.complete()),xe())})}function Os(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return Os(t)}}function Ss(e,t){return j(()=>{let r=Os(e);return typeof r!="undefined"?An(r,e,t):x})}var Ms=_r(Co());var cp=0,Ls=R(b(window,"keydown").pipe(f(()=>!0)),R(b(window,"keyup"),b(window,"contextmenu")).pipe(f(()=>!1))).pipe(J(!1),ie(1));function ks(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return ks(t)}}function lp(e){return Re(e).pipe(f(({width:t})=>({scrollable:Mr(e).width>t})),fe("scrollable"))}function As(e,t){let{matches:r}=matchMedia("(hover)"),n=j(()=>{let o=new I,i=o.pipe(Zn(1));o.subscribe(({scrollable:m})=>{m&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[],s=e.closest("pre"),c=s.closest("[id]"),l=c?c.id:cp++;s.id=`__code_${l}`;let u=[],p=e.closest(".highlight");if(p instanceof HTMLElement){let m=ks(p);if(typeof m!="undefined"&&(p.classList.contains("annotate")||X("content.code.annotate"))){let h=An(m,e,t);u.push(Re(p).pipe(Q(i),f(({width:v,height:y})=>v&&y),ae(),g(v=>v?h:x)))}}let d=P(":scope > span[id]",e);if(d.length&&(e.classList.add("md-code__content"),e.closest(".select")||X("content.code.select")&&!e.closest(".no-select"))){let m=+d[0].id.split("-").pop(),h=bs();a.push(h),X("content.tooltips")&&u.push(Ye(h,{viewport$}));let v=b(h,"click").pipe(Sr(A=>!A,!1),$(()=>h.blur()),xe());v.subscribe(A=>{h.classList.toggle("md-code__button--active",A)});let y=me(d).pipe(oe(A=>Ut(A).pipe(f(S=>[A,S]))));v.pipe(g(A=>A?y:x)).subscribe(([A,S])=>{let D=we(".hll.select",A);if(D&&!S)D.replaceWith(...Array.from(D.childNodes));else if(!D&&S){let ee=document.createElement("span");ee.className="hll select",ee.append(...Array.from(A.childNodes).slice(1)),A.append(ee)}});let E=me(d).pipe(oe(A=>b(A,"mousedown").pipe($(S=>S.preventDefault()),f(()=>A)))),T=v.pipe(g(A=>A?E:x),pe(Ls),f(([A,S])=>{var ee;let D=d.indexOf(A)+m;if(S===!1)return[D,D];{let le=P(".hll",e).map(ce=>d.indexOf(ce.parentElement)+m);return(ee=window.getSelection())==null||ee.removeAllRanges(),[Math.min(D,...le),Math.max(D,...le)]}})),_=wo(x).pipe(L(A=>A.startsWith(`__codelineno-${l}-`)));_.subscribe(A=>{let[,,S]=A.split("-"),D=S.split(":").map(le=>+le-m+1);D.length===1&&D.push(D[0]);for(let le of P(".hll:not(.select)",e))le.replaceWith(...Array.from(le.childNodes));let ee=d.slice(D[0]-1,D[1]);for(let le of ee){let ce=document.createElement("span");ce.className="hll",ce.append(...Array.from(le.childNodes).slice(1)),le.append(ce)}}),_.pipe(Me(1),Ie(ge)).subscribe(A=>{if(A.includes(":")){let S=document.getElementById(A.split(":")[0]);S&&setTimeout(()=>{let D=S,ee=-64;for(;D!==document.body;)ee+=D.offsetTop,D=D.offsetParent;window.scrollTo({top:ee})},1)}});let be=me(P('a[href^="#__codelineno"]',p)).pipe(oe(A=>b(A,"click").pipe($(S=>S.preventDefault()),f(()=>A)))).pipe(Q(i),pe(Ls),f(([A,S])=>{let ee=+Y(`[id="${A.hash.slice(1)}"]`).parentElement.id.split("-").pop();if(S===!1)return[ee,ee];{let le=P(".hll",e).map(ce=>+ce.parentElement.id.split("-").pop());return[Math.min(ee,...le),Math.max(ee,...le)]}}));R(T,be).subscribe(A=>{let S=`#__codelineno-${l}-`;A[0]===A[1]?S+=A[0]:S+=`${A[0]}:${A[1]}`,history.replaceState({},"",S),window.dispatchEvent(new HashChangeEvent("hashchange",{newURL:window.location.origin+window.location.pathname+S,oldURL:window.location.href}))})}if(Ms.default.isSupported()&&(e.closest(".copy")||X("content.code.copy")&&!e.closest(".no-copy"))){let m=vs(s.id);a.push(m),X("content.tooltips")&&u.push(Ye(m,{viewport$}))}if(a.length){let m=gs();m.append(...a),s.insertBefore(m,e)}return lp(e).pipe($(m=>o.next(m)),z(()=>o.complete()),f(m=>M({ref:e},m)),jt(R(...u).pipe(Q(i))))});return X("content.lazy")?Tt(e).pipe(L(o=>o),Me(1),g(()=>n)):n}function up(e,{target$:t,print$:r}){let n=!0;return R(t.pipe(f(o=>o.closest("details:not([open])")),L(o=>e===o),f(()=>({action:"open",reveal:!0}))),r.pipe(L(o=>o||!n),$(()=>n=e.open),f(o=>({action:o?"open":"close"}))))}function Cs(e,t){return j(()=>{let r=new I;return r.subscribe(({action:n,reveal:o})=>{e.toggleAttribute("open",n==="open"),o&&e.scrollIntoView()}),up(e,t).pipe($(n=>r.next(n)),z(()=>r.complete()),f(n=>M({ref:e},n)))})}var Ho;function pp(){return typeof GLightbox=="undefined"||GLightbox instanceof Element?Gn([wt("https://unpkg.com/glightbox@3/dist/js/glightbox.min.js"),Ai("https://unpkg.com/glightbox@3/dist/css/glightbox.min.css")]).pipe(f(()=>{})):K(void 0)}function Hs(e){return Ho||(Ho=pp().pipe(f(()=>new GLightbox(M({touchNavigation:!0,loop:!1,zoomable:!0,draggable:!0,openEffect:"zoom",closeEffect:"zoom",slideEffect:"slide",onOpen:()=>{document.activeElement instanceof HTMLElement&&document.activeElement.blur()}},typeof GLightboxOptions!="undefined"?GLightboxOptions:{}))),ie(1))),Ho.pipe($(t=>t.setElements(e))),Ho.pipe(g(()=>e.map(t=>({ref:t}))))}var $s=0,Ps=new Map;function fp(e){let t=document.createElement("h3");t.innerHTML=e.innerHTML;let r=[t],n=e.nextElementSibling;for(;n&&!(n instanceof HTMLHeadingElement);)r.push(n.cloneNode(!0)),n=n.nextElementSibling;return r}function mp(e,t){for(let r of P("[href], [src]",e))for(let n of["href","src"]){let o=r.getAttribute(n);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){r[n]=new URL(r.getAttribute(n),t).toString();break}}for(let r of P("[name^=__], [for]",e))for(let n of["id","for","name"]){let o=r.getAttribute(n);o&&r.setAttribute(n,`${o}$preview_${$s}`)}return $s++,K(e)}function dp(e){let t=Ps.get(e.toString());return t?K(t):Sn(e).pipe(g(r=>mp(r,e)),f(r=>(Ps.set(e.toString(),r),r)))}function Is(e,t){let{sitemap$:r}=t;if(!(e instanceof HTMLAnchorElement))return x;if(!(X("navigation.instant.preview")||e.hasAttribute("data-preview")))return x;e.removeAttribute("title");let n=re([ar(e),Ut(e).pipe(ke(1))]).pipe(f(([i,a])=>i||a),ae(),L(i=>i));return Pt([r,n]).pipe(g(([i])=>{let a=new URL(e.href);return a.search=a.hash="",i.has(`${a}`)?K(a):x}),g(i=>dp(i)),g(i=>{let a=e.hash?`article [id="${decodeURIComponent(e.hash.slice(1))}"]`:"article h1",s=we(a,i);return typeof s=="undefined"?x:K(fp(s))})).pipe(g(i=>{let a=new F(s=>{let c=kn(...i);return s.next(c),document.body.append(c),()=>c.remove()});return Rr(e,M({content$:a},t))}))}var Rs=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.flowchartTitleText{fill:var(--md-mermaid-label-fg-color)}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel p,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel p{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color)}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}.classDiagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs marker.marker.composition.class path,defs marker.marker.dependency.class path,defs marker.marker.extension.class path{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs marker.marker.aggregation.class path{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}.statediagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}[id^=entity] path,[id^=entity] rect{fill:var(--md-default-bg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs .marker.oneOrMore.er *,defs .marker.onlyOne.er *,defs .marker.zeroOrMore.er *,defs .marker.zeroOrOne.er *{stroke:var(--md-mermaid-edge-color)!important}text:not([class]):last-child{fill:var(--md-mermaid-label-fg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}.actor-line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}[id$=-arrowhead] path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var $o,vp=0;function bp(){return typeof mermaid=="undefined"||mermaid instanceof Element?wt("https://unpkg.com/mermaid@11/dist/mermaid.min.js"):K(void 0)}function js(e){return e.classList.remove("mermaid"),$o||($o=bp().pipe($(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Rs,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),f(()=>{}),ie(1))),$o.subscribe(()=>Vo(null,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${vp++}`,r=k("div",{class:"mermaid"}),n=e.textContent,{svg:o,fn:i}=yield mermaid.render(t,n),a=r.attachShadow({mode:"closed"});a.innerHTML=o,e.replaceWith(r),i==null||i(a)})),$o.pipe(f(()=>({ref:e})))}var Fs=k("table");function Us(e){return e.replaceWith(Fs),Fs.replaceWith(xs(e)),K({ref:e})}function gp(e){let t=e.find(r=>r.checked)||e[0];return R(...e.map(r=>b(r,"change").pipe(f(()=>Y(`label[for="${r.id}"]`))))).pipe(J(Y(`label[for="${t.id}"]`)),f(r=>({active:r})))}function Ns(e,{viewport$:t,target$:r}){let n=Y(".tabbed-labels",e),o=P(":scope > input",e),i=ko("prev");e.append(i);let a=ko("next");return e.append(a),j(()=>{let s=new I,c=s.pipe(he(),ye(!0));re([s,Re(e),Tt(e)]).pipe(Q(c),Xe(1,je)).subscribe({next([{active:l},u]){let p=Et(l),{width:d}=Ae(l);e.style.setProperty("--md-indicator-x",`${p.x}px`),e.style.setProperty("--md-indicator-width",`${d}px`);let m=fn(n);(p.xm.x+u.width)&&n.scrollTo({left:Math.max(0,p.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),re([Nt(n),Re(n)]).pipe(Q(c)).subscribe(([l,u])=>{let p=Mr(n);i.hidden=l.x<16,a.hidden=l.x>p.width-u.width-16}),R(b(i,"click").pipe(f(()=>-1)),b(a,"click").pipe(f(()=>1))).pipe(Q(c)).subscribe(l=>{let{width:u}=Ae(n);n.scrollBy({left:u*l,behavior:"smooth"})}),r.pipe(Q(c),L(l=>o.includes(l))).subscribe(l=>l.click()),n.classList.add("tabbed-labels--linked");for(let l of o){let u=Y(`label[for="${l.id}"]`);u.replaceChildren(k("a",{href:`#${u.htmlFor}`,tabIndex:-1},...Array.from(u.childNodes))),b(u.firstElementChild,"click").pipe(Q(c),L(p=>!(p.metaKey||p.ctrlKey)),$(p=>{p.preventDefault(),p.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${u.htmlFor}`),u.click()})}return X("content.tabs.link")&&s.pipe(ke(1),pe(t)).subscribe(([{active:l},{offset:u}])=>{let p=l.innerText.trim();if(l.hasAttribute("data-md-switching"))l.removeAttribute("data-md-switching");else{let d=e.offsetTop-u.y;for(let h of P("[data-tabs]"))for(let v of P(":scope > input",h)){let y=Y(`label[for="${v.id}"]`);if(y!==l&&y.innerText.trim()===p){y.setAttribute("data-md-switching",""),v.click();break}}window.scrollTo({top:e.offsetTop-d});let m=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([p,...m])])}}),s.pipe(Q(c)).subscribe(()=>{for(let l of P("audio, video",e))l.offsetWidth&&l.autoplay?l.play().catch(()=>{}):l.pause()}),gp(o).pipe($(l=>s.next(l)),z(()=>s.complete()),f(l=>M({ref:e},l)))}).pipe($t(ge))}function Ds(e,t){let{viewport$:r,target$:n,print$:o}=t;return R(...P(".annotate:not(.highlight)",e).map(i=>Ss(i,{target$:n,print$:o})),...P("pre:not(.mermaid) > code",e).map(i=>As(i,{target$:n,print$:o})),...P("a",e).map(i=>Is(i,t)),...P("pre.mermaid",e).map(i=>js(i)),Hs(P(".glightbox",e)),...P("table:not([class])",e).map(i=>Us(i)),...P("details",e).map(i=>Cs(i,{target$:n,print$:o})),...P("[data-tabs]",e).map(i=>Ns(i,{viewport$:r,target$:n})),...P("[title]:not([data-preview])",e).filter(()=>X("content.tooltips")).map(i=>Ye(i,{viewport$:r})),...P(".footnote-ref",e).filter(()=>X("content.footnote.tooltips")).map(i=>Rr(i,{content$:new F(a=>{let s=new URL(i.href).hash.slice(1),c=Array.from(document.getElementById(s).cloneNode(!0).children),l=kn(...c);return a.next(l),document.body.append(l),()=>l.remove()}),viewport$:r})))}function _p(e,{alert$:t}){return t.pipe(g(r=>R(K(!0),K(!1).pipe(Rt(2e3))).pipe(f(n=>({message:r,active:n})))))}function Ws(e,t){let r=Y(".md-typeset",e);return j(()=>{let n=new I;return n.subscribe(({message:o,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=o}),_p(e,t).pipe($(o=>n.next(o)),z(()=>n.complete()),f(o=>M({ref:e},o)))})}function yp({viewport$:e}){if(!X("header.autohide"))return K(!1);let t=e.pipe(f(({offset:{y:o}})=>o),It(2,1),f(([o,i])=>[oMath.abs(i-o.y)>100),f(([,[o]])=>o),ae()),n=Ln("search");return re([e,n]).pipe(f(([{offset:o},i])=>o.y>400&&!i),ae(),g(o=>o?r:K(!1)),J(!1))}function Vs(e,t){return j(()=>re([Re(e),yp(t)])).pipe(f(([{height:r},n])=>({height:r,hidden:n})),ae((r,n)=>r.height===n.height&&r.hidden===n.hidden),ie(1))}function zs(e,{viewport$:t,header$:r,main$:n}){return j(()=>{let o=new I,i=o.pipe(he(),ye(!0));o.pipe(fe("active"),Ze(r)).subscribe(([{active:s},{hidden:c}])=>{e.classList.toggle("md-header--shadow",s&&!c),e.hidden=c});let a=me(P("[title]",e)).pipe(L(()=>X("content.tooltips")),oe(s=>Ye(s,{viewport$:t})));return n.subscribe(o),r.pipe(Q(i),f(s=>M({ref:e},s)),jt(a.pipe(Q(i))))})}function xp(e,{viewport$:t,header$:r}){return Mn(e,{viewport$:t,header$:r}).pipe(f(({offset:{y:n}})=>{let{height:o}=Ae(e);return{active:o>0&&n>=o}}),fe("active"))}function qs(e,t){return j(()=>{let r=new I;r.subscribe({next({active:o}){e.classList.toggle("md-header__title--active",o)},complete(){e.classList.remove("md-header__title--active")}});let n=we(".md-content h1");return typeof n=="undefined"?x:xp(n,t).pipe($(o=>r.next(o)),z(()=>r.complete()),f(o=>M({ref:e},o)))})}function Ks(e,{viewport$:t,header$:r}){let n=r.pipe(f(({height:i})=>i),ae()),o=n.pipe(g(()=>Re(e).pipe(f(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),fe("bottom"))));return re([n,o,t]).pipe(f(([i,{top:a,bottom:s},{offset:{y:c},size:{height:l}}])=>(l=Math.max(0,l-Math.max(0,a-c,i)-Math.max(0,l+c-s)),{offset:a-i,height:l,active:a-i<=c})),ae((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function wp(e){let t=__md_get("__palette")||{index:e.findIndex(n=>matchMedia(n.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return K(...e).pipe(oe(n=>b(n,"change").pipe(f(()=>n))),J(e[r]),f(n=>({index:e.indexOf(n),color:{media:n.getAttribute("data-md-color-media"),scheme:n.getAttribute("data-md-color-scheme"),primary:n.getAttribute("data-md-color-primary"),accent:n.getAttribute("data-md-color-accent")}})),ie(1))}function Bs(e){let t=P("input",e),r=k("meta",{name:"theme-color"});document.head.appendChild(r);let n=k("meta",{name:"color-scheme"});document.head.appendChild(n);let o=Ir("(prefers-color-scheme: light)");return j(()=>{let i=new I;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),c=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=c.getAttribute("data-md-color-scheme"),a.color.primary=c.getAttribute("data-md-color-primary"),a.color.accent=c.getAttribute("data-md-color-accent")}for(let[s,c]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,c);for(let s=0;sa.key==="Enter"),pe(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(f(()=>{let a=bt("header"),s=window.getComputedStyle(a);return n.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(c=>(+c).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(Ie(ge)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),wp(t).pipe(Q(o.pipe(ke(1))),Ft(),$(a=>i.next(a)),z(()=>i.complete()),f(a=>M({ref:e},a)))})}function Gs(e,{progress$:t}){return j(()=>{let r=new I;return r.subscribe(({value:n})=>{e.style.setProperty("--md-progress-value",`${n}`)}),t.pipe($(n=>r.next({value:n})),z(()=>r.complete()),f(n=>({ref:e,value:n})))})}var Ys='.v u{text-decoration:underline!important;text-decoration-style:wavy!important;text-decoration-thickness:1px!important}.p{-webkit-backdrop-filter:blur(8px);backdrop-filter:blur(8px);background-color:rgba(var(--color-backdrop)/var(--alpha-lighter));cursor:pointer;height:100%;pointer-events:auto;position:absolute;transition:opacity .25s;width:100%}.p.m{opacity:0;pointer-events:none;transition:opacity .35s}.r{align-items:center;background-color:initial;border:none;border-radius:var(--space-2);cursor:pointer;display:flex;flex-shrink:0;font-family:var(--font-family);height:36px;justify-content:center;outline:none;padding:0;position:relative;transition:background-color .25s,color .25s;width:36px;z-index:1}.r svg{stroke:rgb(var(--color-foreground));height:18px;opacity:.5;width:18px}.r:before{background-color:rgb(var(--color-background-subtle));border-radius:var(--border-radius-2);content:"";inset:0;opacity:0;position:absolute;transform:scale(.75);transition:transform 125ms,opacity 125ms;z-index:0}.r:hover:before{opacity:1;transform:scale(1)}.r.c{cursor:auto}.r.c:before{display:none}.n{-webkit-backdrop-filter:blur(8px);backdrop-filter:blur(8px);background-color:rgba(var(--color-background)/var(--alpha-light));border-radius:var(--space-3);box-shadow:0 0 60px #0000000d;display:flex;height:480px;overflow:hidden;pointer-events:auto;position:absolute;transition:transform .25s cubic-bezier(.16,1,.3,1),opacity .25s;width:640px}.n.l{opacity:0;pointer-events:none;transform:scale(1.1);transition:transform .25s .15s,opacity .15s}@media (max-width:680px){.n{border-radius:0;height:100%;width:100%}}.u{display:flex;flex-basis:min-content;flex-direction:column;flex-grow:1;flex-shrink:0}@keyframes d{0%{transform:scale(0)}50%{transform:scale(1.2)}to{transform:scale(1)}}.y{animation:d .25s ease-in-out;background:var(--color-highlight);border-radius:100%;color:#fff;font-size:8px;font-weight:700;height:12px;padding-top:1px;position:absolute;right:4px;top:4px;width:12px}.i{background-color:rgb(var(--color-background-subtle)/var(--alpha-lighter));flex-shrink:0;overflow:scroll;position:relative;transition:width .35s cubic-bezier(.16,1,.3,1),opacity .25s;width:200px}.i>*{transform:translate(0);transition:transform .25s cubic-bezier(.16,1,.3,1)}.i.l{opacity:0;width:0}.i.l>*{transform:translate(-48px)}@media (max-width:680px){.i{-webkit-backdrop-filter:blur(8px);backdrop-filter:blur(8px);background-color:rgba(var(--color-background-subtle)/var(--alpha-light));box-shadow:0 0 60px #00000026;height:100%;position:absolute;right:0;top:0}}.w{border-bottom:1px solid rgb(var(--color-foreground)/var(--alpha-lightest));display:flex;gap:var(--space-1);padding:var(--space-2)}.k{-webkit-overflow-scrolling:touch;overflow:auto;overscroll-behavior:contain}.z{padding:8px 10px}.X{color:rgb(var(--color-foreground)/var(--alpha-light));padding:var(--space-2);position:absolute;width:200px}.X,.j{display:flex;flex-direction:column}.j{gap:2px;list-style:none;padding:0}.F,.j{margin:0}.F{font-size:16px;font-weight:400}.F,.I{padding:8px}.I{font-size:14px;margin:4px 0 0;opacity:.5}.I,.o{font-size:12px}.o{cursor:pointer;display:flex;padding:4px 8px;position:relative}.o:before{background-color:var(--color-highlight-transparent);border-radius:var(--space-1);content:"";inset:0;opacity:0;position:absolute;transform:scale(.75);transition:transform 125ms,opacity 125ms;z-index:0}.o.g:before,.o:hover:before{opacity:1;transform:scale(1)}.o.g,.o:hover{color:var(--color-highlight)}.R{flex-grow:1}.R,.q{position:relative}.q{font-weight:700}.f{flex-grow:1}.f input{background:#0000;border:none;color:rgb(var(--color-foreground));font-family:var(--font-family);font-size:16px;height:100%;letter-spacing:-.25px;outline:none;width:100%}.b{color:rgb(var(--color-foreground)/var(--alpha-light));display:flex;flex-direction:column;gap:2px;line-height:1.3;list-style:none;margin:var(--space-2);margin-top:0;padding:0}.A,.b li{margin:0}.A{color:rgb(var(--color-foreground)/var(--alpha-lighter));font-size:12px;margin-top:var(--space-2);padding:0 18px}.a{border-radius:var(--space-2);color:inherit;cursor:pointer;display:flex;flex-direction:row;flex-grow:1;padding:8px 10px;position:relative;text-decoration:none}.a:before{background-color:rgb(var(--color-background-subtle));border-radius:var(--border-radius-2);content:"";display:block;inset:0;opacity:0;position:absolute;transform:scale(.9);transition:transform 125ms,opacity 125ms;z-index:0}@media (pointer:fine){.a.h:before,.a:hover:before{opacity:1;transform:scale(1)}}.a mark{background:#0000;color:var(--color-highlight)}.a u{background-color:var(--color-highlight-transparent);border-radius:2px;box-shadow:0 0 0 1px var(--color-highlight-transparent);text-decoration:none}.B{flex-grow:1}.s{margin-right:-8px;opacity:0;position:relative;transform:translate(-2px);transition:transform 125ms,opacity 125ms;z-index:0}@media (pointer:fine){.h>.s,:hover>.s{opacity:1;transform:none}}.x{font-size:14px;margin:0;position:relative}.x code{background:rgb(var(--color-background-subtle));border-radius:var(--space-1);font-size:13px;padding:2px 4px}.t{color:rgb(var(--color-foreground)/var(--alpha-lighter));display:inline-flex;flex-wrap:wrap;font-size:12px;gap:var(--space-1);list-style:none;margin:0;padding:0;position:relative}.t li{white-space:nowrap}.t li:after{content:"/";display:inline;margin-left:var(--space-1)}.t li:last-child:after{content:"";display:none}.e{--space-1:4px;--space-2:calc(var(--space-1)*2);--space-3:calc(var(--space-2)*2);--space-4:calc(var(--space-3)*2);--space-5:calc(var(--space-4)*2);--alpha-light:.7;--alpha-lighter:.54;--alpha-lightest:.1;--color-highlight:var(--md-accent-fg-color,#526cfe);--color-highlight-transparent:var(--md-accent-fg-color--transparent,#526cfe1a);--border-radius-1:var(--space-1);--border-radius-2:var(--space-2);--border-radius-3:calc(var(--space-1) + var(--space-2));--font-family:var(--md-text-font-family,Inter,Roboto Flex,system-ui,sans-serif);--font-size:16px;--line-height:1.5;--letter-spacing:-.5px;-webkit-font-smoothing:antialiased;align-items:center;display:flex;font-family:var(--font-family);font-size:var(--font-size);height:100vh;justify-content:center;letter-spacing:var(--letter-spacing);line-height:var(--line-height);pointer-events:none;position:absolute;width:100vw}@media (pointer:coarse){.e{height:-webkit-fill-available}}.e *,.e :after,.e :before{box-sizing:border-box}';function Js(e,{index$:t}){let r=Ue(),n=document.createElement("div");document.body.appendChild(n),n.style.position="fixed",n.style.height="100%",n.style.top="0",n.style.zIndex="4";let o=n.attachShadow({mode:"open"});o.appendChild(k("style",{},Ys.toString()));try{Xa(r.search,{highlight:r.features.includes("search.highlight")}),me(t).subscribe(i=>{for(let a of i.items)a.location=new URL(`./${a.location}`,r.base).toString();Qa(i,o)}),b(e,"click").subscribe(()=>{xo()}),Ln("search").pipe(ke(1)).subscribe(()=>xo())}catch(i){e.hidden=!0;let a=Y("label[for=__search]");a.hidden=!0}return Ke}var Xs=_r(Mo());function Zs(e,{index$:t,location$:r}){return re([t,r.pipe(J(Ge()),L(n=>!!n.searchParams.get("h")))]).pipe(f(([n,o])=>Tp(n.config)(o.searchParams.get("h"))),f(n=>{var a;let o=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let c=s.textContent,l=n(c);l.length>c.length&&o.set(s,l)}for(let[s,c]of o){let{childNodes:l}=k("span",null,c);s.replaceWith(...Array.from(l))}return{ref:e,nodes:o}}))}function Tp(e){let t=e.separator.split("|").map(o=>o.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":o).join("|"),r=new RegExp(t,"img"),n=(o,i,a)=>`${i}${a}`;return o=>{o=o.replace(/\s+/g," ").replace(/&/g,"&").trim();let i=new RegExp(`(^|${e.separator}|)(${o.split(r).map(a=>a.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&")).filter(a=>a.length>0).join("|")})`,"img");return a=>(0,Xs.default)(a).replace(i,n).replace(/<\/mark>(\s+)]*>/img,"$1")}}function Op(e,{viewport$:t,main$:r}){let n=e.closest(".md-grid"),o=n.offsetTop-n.parentElement.offsetTop;return re([r,t]).pipe(f(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(o,Math.max(0,s-i))-o,{height:a,locked:s>=i+o})),ae((i,a)=>i.height===a.height&&i.locked===a.locked))}function Po(e,n){var o=n,{header$:t}=o,r=gr(o,["header$"]);let i=Y(".md-sidebar__scrollwrap",e),{y:a}=Et(i);return j(()=>{let s=new I,c=s.pipe(he(),ye(!0)),l=s.pipe(Xe(0,je));return l.pipe(pe(t)).subscribe({next([{height:u},{height:p}]){i.style.height=`${u-2*a}px`,e.style.top=`${p}px`},complete(){i.style.height="",e.style.top=""}}),l.pipe(Or()).subscribe(()=>{for(let u of P(".md-nav__link--active[href]",e)){if(!u.clientHeight)continue;let p=u.closest(".md-sidebar__scrollwrap");if(typeof p!="undefined"){let d=u.offsetTop-p.offsetTop,{height:m}=Ae(p);p.scrollTo({top:d-m/2})}}}),me(P("label[tabindex]",e)).pipe(oe(u=>b(u,"click").pipe(Ie(ge),f(()=>u),Q(c)))).subscribe(u=>{let p=Y(`[id="${u.htmlFor}"]`);Y(`[aria-labelledby="${u.id}"]`).setAttribute("aria-expanded",`${p.checked}`)}),X("content.tooltips")&&me(P("abbr[title]",e)).pipe(oe(u=>Ye(u,{viewport$})),Q(c)).subscribe(),Op(e,r).pipe($(u=>s.next(u)),z(()=>s.complete()),f(u=>M({ref:e},u)))})}function Qs(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return Pt(et(`${r}/releases/latest`).pipe(_e(()=>x),f(n=>({version:n.tag_name})),at({})),et(r).pipe(_e(()=>x),f(n=>({stars:n.stargazers_count,forks:n.forks_count})),at({}))).pipe(f(([n,o])=>M(M({},n),o)))}else{let r=`https://api.github.com/users/${e}`;return et(r).pipe(f(n=>({repositories:n.public_repos})),at({}))}}function ec(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return Pt(et(`${r}/releases/permalink/latest`).pipe(_e(()=>x),f(({tag_name:n})=>({version:n})),at({})),et(r).pipe(_e(()=>x),f(({star_count:n,forks_count:o})=>({stars:n,forks:o})),at({}))).pipe(f(([n,o])=>M(M({},n),o)))}function tc(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,n]=t;return Qs(r,n)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,n]=t;return ec(r,n)}return x}var Sp;function Lp(e){return Sp||(Sp=j(()=>{let t=__md_get("__source",sessionStorage);if(t)return K(t);if(Te("consent").length){let n=__md_get("__consent");if(!(n&&n.github))return x}return tc(e.href).pipe($(n=>__md_set("__source",n,sessionStorage)))}).pipe(_e(()=>x),L(t=>Object.keys(t).length>0),f(t=>({facts:t})),ie(1)))}function rc(e){let t=Y(":scope > :last-child",e);return j(()=>{let r=new I;return r.subscribe(({facts:n})=>{t.appendChild(ys(n)),t.classList.add("md-source__repository--active")}),Lp(e).pipe($(n=>r.next(n)),z(()=>r.complete()),f(n=>M({ref:e},n)))})}function Mp(e,{viewport$:t,header$:r}){return Re(document.body).pipe(g(()=>Mn(e,{header$:r,viewport$:t})),f(({offset:{y:n}})=>({hidden:n>=10})),fe("hidden"))}function nc(e,t){return j(()=>{let r=new I;return r.subscribe({next({hidden:n}){e.hidden=n},complete(){e.hidden=!1}}),(X("navigation.tabs.sticky")?K({hidden:!1}):Mp(e,t)).pipe($(n=>r.next(n)),z(()=>r.complete()),f(n=>M({ref:e},n)))})}function kp(e,{viewport$:t,header$:r}){let n=new Map,o=P(".md-nav__link",e);for(let s of o){let c=decodeURIComponent(s.hash.substring(1)),l=we(`[id="${c}"]`);typeof l!="undefined"&&n.set(s,l)}let i=r.pipe(fe("height"),f(({height:s})=>{let c=bt("main"),l=Y(":scope > :first-child",c);return s+.9*(l.offsetTop-c.offsetTop)}),xe());return Re(document.body).pipe(fe("height"),g(s=>j(()=>{let c=[];return K([...n].reduce((l,[u,p])=>{for(;c.length&&n.get(c[c.length-1]).tagName>=p.tagName;)c.pop();let d=p.offsetTop;for(;!d&&p.parentElement;)p=p.parentElement,d=p.offsetTop;let m=p.offsetParent;for(;m;m=m.offsetParent)d+=m.offsetTop;return l.set([...c=[...c,u]].reverse(),d)},new Map))}).pipe(f(c=>new Map([...c].sort(([,l],[,u])=>l-u))),Ze(i),g(([c,l])=>t.pipe(Sr(([u,p],{offset:{y:d},size:m})=>{let h=d+m.height>=Math.floor(s.height);for(;p.length;){let[,v]=p[0];if(v-l=d&&!h)p=[u.pop(),...p];else break}return[u,p]},[[],[...c]]),ae((u,p)=>u[0]===p[0]&&u[1]===p[1])))))).pipe(f(([s,c])=>({prev:s.map(([l])=>l),next:c.map(([l])=>l)})),J({prev:[],next:[]}),It(2,1),f(([s,c])=>s.prev.length{let i=new I,a=i.pipe(he(),ye(!0));i.subscribe(({prev:c,next:l})=>{for(let[u]of l)u.classList.remove("md-nav__link--passed"),u.classList.remove("md-nav__link--active");for(let[u,[p]]of c.entries())p.classList.add("md-nav__link--passed"),p.classList.toggle("md-nav__link--active",u===c.length-1)});let s=we(".md-sidebar--secondary");if(typeof s!="undefined"&&b(document.body,"click").subscribe(c=>{let l=c.target;if(!s.contains(l)){let u=we(".md-nav__toggle",s);typeof u!="undefined"&&(u.checked=!1)}}),X("toc.follow")){let c=R(t.pipe(Be(1),f(()=>{})),t.pipe(Be(250),f(()=>"smooth")));i.pipe(L(({prev:l})=>l.length>0),Ze(n.pipe(Ie(ge))),pe(c)).subscribe(([[{prev:l}],u])=>{let[p]=l[l.length-1];if(p.offsetHeight){let d=Hi(p);if(typeof d!="undefined"){let m=p.offsetTop-d.offsetTop,{height:h}=Ae(d);d.scrollTo({top:m-h/2,behavior:u})}}})}return X("navigation.tracking")&&t.pipe(Q(a),fe("offset"),Be(250),ke(1),Q(o.pipe(ke(1))),Ft({delay:250}),pe(i)).subscribe(([,{prev:c}])=>{let l=Ge(),u=c[c.length-1];if(u&&u.length){let[p]=u,{hash:d}=new URL(p.href);l.hash!==d&&(l.hash=d,history.replaceState({},"",`${l}`))}else l.hash="",history.replaceState({},"",`${l}`)}),kp(e,{viewport$:t,header$:r}).pipe($(c=>i.next(c)),z(()=>i.complete()),f(c=>M({ref:e},c)))})}function Ap(e,{viewport$:t,main$:r,target$:n}){let o=t.pipe(f(({offset:{y:a}})=>a),It(2,1),f(([a,s])=>a>s&&s>0),ae()),i=r.pipe(f(({active:a})=>a));return re([i,o]).pipe(f(([a,s])=>!(a&&s)),ae(),Q(n.pipe(ke(1))),ye(!0),Ft({delay:250}),f(a=>({hidden:a})))}function ic(e,{viewport$:t,header$:r,main$:n,target$:o}){let i=new I,a=i.pipe(he(),ye(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(Q(a),fe("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),b(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),Ap(e,{viewport$:t,main$:n,target$:o}).pipe($(s=>i.next(s)),z(()=>i.complete()),f(s=>M({ref:e},s)))}function ac(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,t.port&&(e.port=t.port),e}function Cp(e,t){let r=new Map;for(let n of P("url",e)){let o=Y("loc",n),i=[ac(new URL(o.textContent),t)];r.set(`${i[0]}`,i);for(let a of P("[rel=alternate]",n)){let s=a.getAttribute("href");s!=null&&i.push(ac(new URL(s),t))}}return r}function dr(e){return as(new URL("sitemap.xml",e)).pipe(f(t=>Cp(t,new URL(e))),_e(()=>K(new Map)),xe())}function sc({document$:e}){let t=new Map;e.pipe(g(()=>P("link[rel=alternate]")),f(r=>new URL(r.href)),L(r=>!t.has(r.toString())),oe(r=>dr(r).pipe(f(n=>[r,n]),_e(()=>x)))).subscribe(([r,n])=>{t.set(r.toString().replace(/\/$/,""),n)}),b(document.body,"click").pipe(L(r=>!r.metaKey&&!r.ctrlKey),g(r=>{if(r.target instanceof Element){let n=r.target.closest("a");if(n&&!n.target){let o=[...t].find(([p])=>n.href.startsWith(`${p}/`));if(typeof o=="undefined")return x;let[i,a]=o,s=Ge();if(s.href.startsWith(i))return x;let c=Ue(),l=s.href.replace(c.base,"");l=`${i}/${l}`;let u=a.has(l.split("#")[0])?new URL(l,c.base):new URL(i);return r.preventDefault(),K(u)}}return x})).subscribe(r=>vt(r,!0))}var Io=_r(Co());function Hp(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function cc({alert$:e}){Io.default.isSupported()&&new F(t=>{new Io.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||Hp(Y(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe($(t=>{t.trigger.focus()}),f(()=>Gt("clipboard.copied"))).subscribe(e)}function lc(e,t){if(!(e.target instanceof Element))return x;let r=e.target.closest("a");if(r===null)return x;if(r.target||e.metaKey||e.ctrlKey)return x;let n=new URL(r.href);return n.search=n.hash="",t.has(`${n}`)?(e.preventDefault(),K(r)):x}function uc(e){let t=new Map;for(let r of P(":scope > *",e.head))t.set(r.outerHTML,r);return t}function pc(e){for(let t of P("[href], [src]",e))for(let r of["href","src"]){let n=t.getAttribute(r);if(n&&!/^(?:[a-z]+:)?\/\//i.test(n)){t[r]=t[r];break}}return K(e)}function $p(e){for(let n of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...X("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let o=we(n),i=we(n,e);typeof o!="undefined"&&typeof i!="undefined"&&o.replaceWith(i)}let t=uc(document);for(let[n,o]of uc(e))t.has(n)?t.delete(n):document.head.appendChild(o);for(let n of t.values()){let o=n.getAttribute("name");o!=="theme-color"&&o!=="color-scheme"&&n.remove()}let r=bt("container");return it(P("script",r)).pipe(g(n=>{let o=e.createElement("script");if(n.src){for(let i of n.getAttributeNames())o.setAttribute(i,n.getAttribute(i));return n.replaceWith(o),new F(i=>{o.onload=()=>i.complete()})}else return o.textContent=n.textContent,n.replaceWith(o),x}),he(),ye(document))}function fc({sitemap$:e,location$:t,viewport$:r,progress$:n}){if(location.protocol==="file:")return Ke;K(document).subscribe(pc);let o=b(document.body,"click").pipe(Ze(e),g(([s,c])=>lc(s,c)),f(({href:s})=>new URL(s)),xe()),i=b(window,"popstate").pipe(f(Ge),xe());o.pipe(pe(r)).subscribe(([s,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",s)}),R(o,i).subscribe(t);let a=t.pipe(fe("pathname"),g(s=>Sn(s,{progress$:n}).pipe(_e(()=>(vt(s,!0),x)))),g(pc),g($p),xe());return R(a.pipe(pe(t,(s,c)=>c)),a.pipe(g(()=>t),fe("hash")),t.pipe(ae((s,c)=>s.pathname===c.pathname&&s.hash===c.hash),g(()=>o),$(()=>history.back()))).subscribe(s=>{var c,l;history.state!==null||!s.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",ns(s.hash),history.scrollRestoration="manual")}),t.subscribe(()=>{history.scrollRestoration="manual"}),b(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),r.pipe(fe("offset"),Be(100)).subscribe(({offset:s})=>{history.replaceState(s,"")}),X("navigation.instant.prefetch")&&R(b(document.body,"mousemove"),b(document.body,"focusin")).pipe(Ze(e),g(([s,c])=>lc(s,c)),Be(25),Xn(({href:s})=>s),pn(s=>{let c=document.createElement("link");return c.rel="prefetch",c.href=s.toString(),document.head.appendChild(c),b(c,"load").pipe(f(()=>c),Me(1))})).subscribe(s=>s.remove()),a}function mc(e){var u;let{selectedVersionSitemap:t,selectedVersionBaseURL:r,currentLocation:n,currentBaseURL:o}=e,i=(u=Ro(o))==null?void 0:u.pathname;if(i===void 0)return;let a=Pp(n.pathname,i);if(a===void 0)return;let s=Rp(t.keys());if(!t.has(s))return;let c=Ro(a,s);if(!c||!t.has(c.href))return;let l=Ro(a,r);if(l)return l.hash=n.hash,l.search=n.search,l}function Ro(e,t){try{return new URL(e,t)}catch(r){return}}function Pp(e,t){if(e.startsWith(t))return e.slice(t.length)}function Ip(e,t){let r=Math.min(e.length,t.length),n;for(n=0;nx)),n=r.pipe(f(o=>{let[,i]=t.base.match(/([^/]+)\/?$/);return o.find(({version:a,aliases:s})=>a===i||s.includes(i))||o[0]}));r.pipe(f(o=>new Map(o.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),g(o=>b(document.body,"click").pipe(L(i=>!i.metaKey&&!i.ctrlKey),pe(n),g(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&o.has(s.href)){let c=s.href;return!i.target.closest(".md-version")&&o.get(c)===a?x:(i.preventDefault(),K(new URL(c)))}}return x}),g(i=>dr(i).pipe(f(a=>{var s;return(s=mc({selectedVersionSitemap:a,selectedVersionBaseURL:i,currentLocation:Ge(),currentBaseURL:t.base}))!=null?s:i})))))).subscribe(o=>vt(o,!0)),re([r,n]).subscribe(([o,i])=>{Y(".md-header__topic").appendChild(ws(o,i))}),e.pipe(g(()=>n)).subscribe(o=>{var s;let i=new URL(t.base),a=__md_get("__outdated",sessionStorage,i);if(a===null){a=!0;let c=((s=t.version)==null?void 0:s.default)||"latest";Array.isArray(c)||(c=[c]);e:for(let l of c)for(let u of o.aliases.concat(o.version))if(new RegExp(l,"i").test(u)){a=!1;break e}__md_set("__outdated",a,sessionStorage,i)}if(a)for(let c of Te("outdated"))c.hidden=!1})}function hc({document$:e,viewport$:t}){e.pipe(g(()=>P(".md-ellipsis")),oe(r=>Tt(r).pipe(Q(e.pipe(ke(1))),L(n=>n),f(()=>r),Me(1))),L(r=>r.offsetWidth{let n=r.innerText,o=r.closest("a")||r;return o.title=n,X("content.tooltips")?Ye(o,{viewport$:t}).pipe(Q(e.pipe(ke(1))),z(()=>o.removeAttribute("title"))):x})).subscribe(),X("content.tooltips")&&e.pipe(g(()=>P(".md-status")),oe(r=>Ye(r,{viewport$:t}))).subscribe()}function vc({document$:e,tablet$:t}){e.pipe(g(()=>P(".md-toggle--indeterminate")),$(r=>{r.indeterminate=!0,r.checked=!1}),oe(r=>b(r,"change").pipe(eo(()=>r.classList.contains("md-toggle--indeterminate")),f(()=>r))),pe(t)).subscribe(([r,n])=>{r.classList.remove("md-toggle--indeterminate"),n&&(r.checked=!1)})}function jp(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function bc({document$:e}){e.pipe(g(()=>P("[data-md-scrollfix]")),$(t=>t.removeAttribute("data-md-scrollfix")),L(jp),oe(t=>b(t,"touchstart").pipe(f(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let n=e[r];typeof n=="string"?n=document.createTextNode(n):n.parentNode&&n.parentNode.removeChild(n),r?t.insertBefore(this.previousSibling,n):t.replaceChild(n,this)}}}));function Fp(){return location.protocol==="file:"?wt(`${new URL("search.js",Cn.base)}`).pipe(f(()=>__index),_e(()=>Ke),ie(1)):et(new URL("search.json",Cn.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var gt=Li(),Ur=ts(),hr=os(Ur),_c=es(),ze=ps(),jo=Ir("(min-width: 60em)"),yc=Ir("(min-width: 76.25em)"),xc=is(),Cn=Ue(),wc=we(".md-search")?Fp():Ke,Fo=new I;cc({alert$:Fo});sc({document$:gt});var Uo=new I,Ec=dr(Cn.base);X("navigation.instant")&&fc({sitemap$:Ec,location$:Ur,viewport$:ze,progress$:Uo}).subscribe(gt);var gc;((gc=Cn.version)==null?void 0:gc.provider)==="mike"&&dc({document$:gt});R(Ur,hr).pipe(Rt(125)).subscribe(()=>{So("drawer",!1),So("search",!1)});_c.pipe(L(({mode:e,meta:t})=>e==="global"&&!t)).subscribe(e=>{switch(e.type){case",":case"p":let t=document.querySelector("link[rel=prev]");t instanceof HTMLLinkElement&&vt(t);break;case".":case"n":let r=document.querySelector("link[rel=next]");r instanceof HTMLLinkElement&&vt(r);break;case"/":let n=document.querySelector("[data-md-component=search] button");n instanceof HTMLButtonElement&&n.click();break;case"Enter":let o=xt();o instanceof HTMLLabelElement&&o.click()}});hc({viewport$:ze,document$:gt});vc({document$:gt,tablet$:jo});bc({document$:gt});var Mt=Vs(bt("header"),{viewport$:ze}),Fr=gt.pipe(f(()=>bt("main")),g(e=>Ks(e,{viewport$:ze,header$:Mt})),ie(1)),Up=R(...Te("consent").map(e=>ms(e,{target$:hr})),...Te("dialog").map(e=>Ws(e,{alert$:Fo})),...Te("palette").map(e=>Bs(e)),...Te("progress").map(e=>Gs(e,{progress$:Uo})),...Te("search").map(e=>Js(e,{index$:wc})),...Te("source").map(e=>rc(e))),Np=j(()=>R(...Te("announce").map(e=>fs(e)),...Te("content").map(e=>Ds(e,{sitemap$:Ec,viewport$:ze,target$:hr,print$:xc})),...Te("content").map(e=>X("search.highlight")?Zs(e,{index$:wc,location$:Ur}):x),...Te("header").map(e=>zs(e,{viewport$:ze,header$:Mt,main$:Fr})),...Te("header-title").map(e=>qs(e,{viewport$:ze,header$:Mt})),...Te("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Eo(yc,()=>Po(e,{viewport$:ze,header$:Mt,main$:Fr})):Eo(jo,()=>Po(e,{viewport$:ze,header$:Mt,main$:Fr}))),...Te("tabs").map(e=>nc(e,{viewport$:ze,header$:Mt})),...Te("toc").map(e=>oc(e,{viewport$:ze,header$:Mt,main$:Fr,target$:hr})),...Te("top").map(e=>ic(e,{viewport$:ze,header$:Mt,main$:Fr,target$:hr})))),Tc=gt.pipe(g(()=>Np),jt(Up),ie(1));Tc.subscribe();window.document$=gt;window.location$=Ur;window.target$=hr;window.keyboard$=_c;window.viewport$=ze;window.tablet$=jo;window.screen$=yc;window.print$=xc;window.alert$=Fo;window.progress$=Uo;window.component$=Tc;})(); + `):"",this.name="UnsubscriptionError",this.errors=r}});function ut(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var rt=(function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,n,o,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=$e(a),c=s.next();!c.done;c=s.next()){var l=c.value;l.remove(this)}}catch(v){t={error:v}}finally{try{c&&!c.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var u=this.initialTeardown;if(U(u))try{u()}catch(v){i=v instanceof Vr?v.errors:[v]}var p=this._finalizers;if(p){this._finalizers=null;try{for(var d=$e(p),m=d.next();!m.done;m=d.next()){var h=m.value;try{Yo(h)}catch(v){i=i!=null?i:[],v instanceof Vr?i=ne(ne([],te(i)),te(v.errors)):i.push(v)}}}catch(v){n={error:v}}finally{try{m&&!m.done&&(o=d.return)&&o.call(d)}finally{if(n)throw n.error}}}if(i)throw new Vr(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)Yo(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&ut(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&ut(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=(function(){var t=new e;return t.closed=!0,t})(),e})();var jn=rt.EMPTY;function zr(e){return e instanceof rt||e&&"closed"in e&&U(e.remove)&&U(e.add)&&U(e.unsubscribe)}function Yo(e){U(e)?e():e.unsubscribe()}var Je={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var Zt={setTimeout:function(e,t){for(var r=[],n=2;n0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var n=this,o=this,i=o.hasError,a=o.isStopped,s=o.observers;return i||a?jn:(this.currentObservers=null,s.push(r),new rt(function(){n.currentObservers=null,ut(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var n=this,o=n.hasError,i=n.thrownError,a=n.isStopped;o?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,n){return new ni(r,n)},t})(F);var ni=(function(e){ue(t,e);function t(r,n){var o=e.call(this)||this;return o.destination=r,o.source=n,o}return t.prototype.next=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.next)===null||o===void 0||o.call(n,r)},t.prototype.error=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.error)===null||o===void 0||o.call(n,r)},t.prototype.complete=function(){var r,n;(n=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||n===void 0||n.call(r)},t.prototype._subscribe=function(r){var n,o;return(o=(n=this.source)===null||n===void 0?void 0:n.subscribe(r))!==null&&o!==void 0?o:jn},t})(I);var Wn=(function(e){ue(t,e);function t(r){var n=e.call(this)||this;return n._value=r,n}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var n=e.prototype._subscribe.call(this,r);return!n.closed&&r.next(this._value),n},t.prototype.getValue=function(){var r=this,n=r.hasError,o=r.thrownError,i=r._value;if(n)throw o;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t})(I);var xr={now:function(){return(xr.delegate||Date).now()},delegate:void 0};var wr=(function(e){ue(t,e);function t(r,n,o){r===void 0&&(r=1/0),n===void 0&&(n=1/0),o===void 0&&(o=xr);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=n,i._timestampProvider=o,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=n===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,n),i}return t.prototype.next=function(r){var n=this,o=n.isStopped,i=n._buffer,a=n._infiniteTimeWindow,s=n._timestampProvider,c=n._windowTime;o||(i.push(r),!a&&i.push(s.now()+c)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var n=this._innerSubscribe(r),o=this,i=o._infiniteTimeWindow,a=o._buffer,s=a.slice(),c=0;c0?e.prototype.schedule.call(this,r,n):(this.delay=n,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,n){return n>0||this.closed?e.prototype.execute.call(this,r,n):this._execute(r,n)},t.prototype.requestAsyncId=function(r,n,o){return o===void 0&&(o=0),o!=null&&o>0||o==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,n,o):(r.flush(this),0)},t})(rr);var ai=(function(e){ue(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t})(nr);var qn=new ai(ii);var si=(function(e){ue(t,e);function t(r,n){var o=e.call(this,r,n)||this;return o.scheduler=r,o.work=n,o}return t.prototype.requestAsyncId=function(r,n,o){return o===void 0&&(o=0),o!==null&&o>0?e.prototype.requestAsyncId.call(this,r,n,o):(r.actions.push(this),r._scheduled||(r._scheduled=tr.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,n,o){var i;if(o===void 0&&(o=0),o!=null?o>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,n,o);var a=r.actions;n!=null&&n===r._scheduled&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==n&&(tr.cancelAnimationFrame(n),r._scheduled=void 0)},t})(rr);var ci=(function(e){ue(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var n;r?n=r.id:(n=this._scheduled,this._scheduled=void 0);var o=this.actions,i;r=r||o.shift();do if(i=r.execute(r.state,r.delay))break;while((r=o[0])&&r.id===n&&o.shift());if(this._active=!1,i){for(;(r=o[0])&&r.id===n&&o.shift();)r.unsubscribe();throw i}},t})(nr);var je=new ci(si);var y=new F(function(e){return e.complete()});function Br(e){return e&&U(e.schedule)}function Kn(e){return e[e.length-1]}function nt(e){return U(Kn(e))?e.pop():void 0}function qe(e){return Br(Kn(e))?e.pop():void 0}function Gr(e,t){return typeof Kn(e)=="number"?e.pop():t}var or=(function(e){return e&&typeof e.length=="number"&&typeof e!="function"});function Yr(e){return U(e==null?void 0:e.then)}function Jr(e){return U(e[er])}function Xr(e){return Symbol.asyncIterator&&U(e==null?void 0:e[Symbol.asyncIterator])}function Zr(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Nc(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Qr=Nc();function en(e){return U(e==null?void 0:e[Qr])}function tn(e){return Bo(this,arguments,function(){var r,n,o,i;return Wr(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,At(r.read())];case 3:return n=a.sent(),o=n.value,i=n.done,i?[4,At(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,At(o)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function rn(e){return U(e==null?void 0:e.getReader)}function N(e){if(e instanceof F)return e;if(e!=null){if(Jr(e))return Dc(e);if(or(e))return Wc(e);if(Yr(e))return Vc(e);if(Xr(e))return li(e);if(en(e))return zc(e);if(rn(e))return qc(e)}throw Zr(e)}function Dc(e){return new F(function(t){var r=e[er]();if(U(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Wc(e){return new F(function(t){for(var r=0;r=2;return function(n){return n.pipe(e?L(function(o,i){return e(o,i,n)}):Le,Me(1),r?at(t):Ti(function(){return new an}))}}function Zn(e){return e<=0?function(){return y}:O(function(t,r){var n=[];t.subscribe(w(r,function(o){n.push(o),e=2,!0))}function xe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new I}:t,n=e.resetOnError,o=n===void 0?!0:n,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,c=s===void 0?!0:s;return function(l){var u,p,d,m=0,h=!1,v=!1,x=function(){p==null||p.unsubscribe(),p=void 0},E=function(){x(),u=d=void 0,h=v=!1},T=function(){var _=u;E(),_==null||_.unsubscribe()};return O(function(_,de){m++,!v&&!h&&x();var ge=d=d!=null?d:r();de.add(function(){m--,m===0&&!v&&!h&&(p=Qn(T,c))}),ge.subscribe(de),!u&&m>0&&(u=new Ht({next:function(A){return ge.next(A)},error:function(A){v=!0,x(),p=Qn(E,o,A),ge.error(A)},complete:function(){h=!0,x(),p=Qn(E,a),ge.complete()}}),N(_).subscribe(u))})(l)}}function Qn(e,t){for(var r=[],n=2;ne.next(document)),e}function P(e,t=document){return Array.from(t.querySelectorAll(e))}function Y(e,t=document){let r=we(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function we(e,t=document){return t.querySelector(e)||void 0}function xt(){var e,t,r,n;return(n=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?n:void 0}var ll=R(b(document.body,"focusin"),b(document.body,"focusout")).pipe(Be(1),J(void 0),f(()=>xt()||document.body),ie(1));function ar(e){return ll.pipe(f(t=>e.contains(t)),ae())}function Ut(e,t){let{matches:r}=matchMedia("(hover)");return j(()=>(r?R(b(e,"mouseenter").pipe(f(()=>!0)),b(e,"mouseleave").pipe(f(()=>!1))):R(b(e,"touchstart").pipe(f(()=>!0)),b(e,"touchend").pipe(f(()=>!1)),b(e,"touchcancel").pipe(f(()=>!1)))).pipe(t?Tr(o=>Ve(+!o*t)):Le,J(!0,e.matches(":hover"))))}function Mi(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Mi(e,r)}function k(e,t,...r){let n=document.createElement(e);if(t)for(let o of Object.keys(t))typeof t[o]!="undefined"&&(typeof t[o]!="boolean"?n.setAttribute(o,t[o]):n.setAttribute(o,""));for(let o of r)Mi(n,o);return n}function ki(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function wt(e){let t=k("script",{src:e});return j(()=>(document.head.appendChild(t),R(b(t,"load"),b(t,"error").pipe(g(()=>on(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(f(()=>{}),z(()=>document.head.removeChild(t)),Me(1))))}function Ai(e){let t=k("link",{rel:"stylesheet",href:e});return document.head.appendChild(t),R(b(t,"load"),b(t,"error").pipe(g(()=>on(()=>new ReferenceError(`Invalid styles: ${e}`))))).pipe(f(()=>{}),Me(1))}var Ci=new I,ul=j(()=>typeof ResizeObserver=="undefined"?wt("https://unpkg.com/resize-observer-polyfill"):K(void 0)).pipe(f(()=>new ResizeObserver(e=>e.forEach(t=>Ci.next(t)))),g(e=>R(Ke,K(e)).pipe(z(()=>e.disconnect()))),ie(1));function Ae(e){return{width:e.offsetWidth,height:e.offsetHeight}}function Re(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return ul.pipe($(r=>r.observe(t)),g(r=>Ci.pipe(L(n=>n.target===t),z(()=>r.unobserve(t)))),f(()=>Ae(e)),J(Ae(e)))}function Mr(e){return{width:e.scrollWidth,height:e.scrollHeight}}function Hi(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function $i(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Et(e){return{x:e.offsetLeft,y:e.offsetTop}}function Pi(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function Ii(e){return R(b(window,"load"),b(window,"resize")).pipe(Xe(0,je),f(()=>Et(e)),J(Et(e)))}function fn(e){return{x:e.scrollLeft,y:e.scrollTop}}function Nt(e){return R(b(e,"scroll"),b(window,"scroll"),b(window,"resize")).pipe(Xe(0,je),f(()=>fn(e)),J(fn(e)))}var Ri=new I,pl=j(()=>K(new IntersectionObserver(e=>{for(let t of e)Ri.next(t)},{threshold:0}))).pipe(g(e=>R(Ke,K(e)).pipe(z(()=>e.disconnect()))),ie(1));function Tt(e){return pl.pipe($(t=>t.observe(e)),g(t=>Ri.pipe(L(({target:r})=>r===e),z(()=>t.unobserve(e)),f(({isIntersecting:r})=>r))))}var fl=Object.create,fa=Object.defineProperty,ml=Object.getOwnPropertyDescriptor,dl=Object.getOwnPropertyNames,hl=Object.getPrototypeOf,vl=Object.prototype.hasOwnProperty,bl=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports),gl=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of dl(t))!vl.call(e,o)&&o!==r&&fa(e,o,{get:()=>t[o],enumerable:!(n=ml(t,o))||n.enumerable});return e},_l=(e,t,r)=>(r=e!=null?fl(hl(e)):{},gl(t||!e||!e.__esModule?fa(r,"default",{value:e,enumerable:!0}):r,e)),yl=bl((e,t)=>{var r="Expected a function",n=NaN,o="[object Symbol]",i=/^\s+|\s+$/g,a=/^[-+]0x[0-9a-f]+$/i,s=/^0b[01]+$/i,c=/^0o[0-7]+$/i,l=parseInt,u=typeof global=="object"&&global&&global.Object===Object&&global,p=typeof self=="object"&&self&&self.Object===Object&&self,d=u||p||Function("return this")(),m=Object.prototype,h=m.toString,v=Math.max,x=Math.min,E=function(){return d.Date.now()};function T(S,D,ee){var le,ce,Ne,_t,De,lt,tt=0,Yt=!1,kt=!1,vr=!0;if(typeof S!="function")throw new TypeError(r);D=A(D)||0,_(ee)&&(Yt=!!ee.leading,kt="maxWait"in ee,Ne=kt?v(A(ee.maxWait)||0,D):Ne,vr="trailing"in ee?!!ee.trailing:vr);function G(Oe){var yt=le,br=ce;return le=ce=void 0,tt=Oe,_t=S.apply(br,yt),_t}function H(Oe){return tt=Oe,De=setTimeout(V,D),Yt?G(Oe):_t}function C(Oe){var yt=Oe-lt,br=Oe-tt,No=D-yt;return kt?x(No,Ne-br):No}function W(Oe){var yt=Oe-lt,br=Oe-tt;return lt===void 0||yt>=D||yt<0||kt&&br>=Ne}function V(){var Oe=E();if(W(Oe))return Z(Oe);De=setTimeout(V,C(Oe))}function Z(Oe){return De=void 0,vr&&le?G(Oe):(le=ce=void 0,_t)}function We(){De!==void 0&&clearTimeout(De),tt=0,le=lt=ce=De=void 0}function Jt(){return De===void 0?_t:Z(E())}function Nr(){var Oe=E(),yt=W(Oe);if(le=arguments,ce=this,lt=Oe,yt){if(De===void 0)return H(lt);if(kt)return De=setTimeout(V,D),G(lt)}return De===void 0&&(De=setTimeout(V,D)),_t}return Nr.cancel=We,Nr.flush=Jt,Nr}function _(S){var D=typeof S;return!!S&&(D=="object"||D=="function")}function de(S){return!!S&&typeof S=="object"}function ge(S){return typeof S=="symbol"||de(S)&&h.call(S)==o}function A(S){if(typeof S=="number")return S;if(ge(S))return n;if(_(S)){var D=typeof S.valueOf=="function"?S.valueOf():S;S=_(D)?D+"":D}if(typeof S!="string")return S===0?S:+S;S=S.replace(i,"");var ee=s.test(S);return ee||c.test(S)?l(S.slice(2),ee?2:8):a.test(S)?n:+S}t.exports=T}),En,B,ma,da,Dt,ji,ha,va,ba,fo,oo,io,xl,Ar={},ga=[],wl=/acit|ex(?:s|g|n|p|$)|rph|grid|ows|mnc|ntw|ine[ch]|zoo|^ord|itera/i,Pr=Array.isArray;function mt(e,t){for(var r in t)e[r]=t[r];return e}function mo(e){e&&e.parentNode&&e.parentNode.removeChild(e)}function Vt(e,t,r){var n,o,i,a={};for(i in t)i=="key"?n=t[i]:i=="ref"?o=t[i]:a[i]=t[i];if(arguments.length>2&&(a.children=arguments.length>3?En.call(arguments,2):r),typeof e=="function"&&e.defaultProps!=null)for(i in e.defaultProps)a[i]===void 0&&(a[i]=e.defaultProps[i]);return hn(e,a,n,o,null)}function hn(e,t,r,n,o){var i={type:e,props:t,key:r,ref:n,__k:null,__:null,__b:0,__e:null,__c:null,constructor:void 0,__v:o!=null?o:++ma,__i:-1,__u:0};return o==null&&B.vnode!=null&&B.vnode(i),i}function dt(e){return e.children}function ct(e,t){this.props=e,this.context=t}function cr(e,t){if(t==null)return e.__?cr(e.__,e.__i+1):null;for(var r;ts&&Dt.sort(va),e=Dt.shift(),s=Dt.length,e.__d&&(r=void 0,n=void 0,o=(n=(t=e).__v).__e,i=[],a=[],t.__P&&((r=mt({},n)).__v=n.__v+1,B.vnode&&B.vnode(r),ho(t.__P,r,n,t.__n,t.__P.namespaceURI,32&n.__u?[o]:null,i,o!=null?o:cr(n),!!(32&n.__u),a),r.__v=n.__v,r.__.__k[r.__i]=r,wa(i,r,a),n.__e=n.__=null,r.__e!=o&&_a(r)));_n.__r=0}function ya(e,t,r,n,o,i,a,s,c,l,u){var p,d,m,h,v,x,E,T=n&&n.__k||ga,_=t.length;for(c=El(r,t,T,c,_),p=0;p<_;p++)(m=r.__k[p])!=null&&(d=m.__i==-1?Ar:T[m.__i]||Ar,m.__i=p,x=ho(e,m,d,o,i,a,s,c,l,u),h=m.__e,m.ref&&d.ref!=m.ref&&(d.ref&&vo(d.ref,null,m),u.push(m.ref,m.__c||h,m)),v==null&&h!=null&&(v=h),(E=!!(4&m.__u))||d.__k===m.__k?c=xa(m,c,e,E):typeof m.type=="function"&&x!==void 0?c=x:h&&(c=h.nextSibling),m.__u&=-7);return r.__e=v,c}function El(e,t,r,n,o){var i,a,s,c,l,u=r.length,p=u,d=0;for(e.__k=new Array(o),i=0;i0?hn(a.type,a.props,a.key,a.ref?a.ref:null,a.__v):a).__=e,a.__b=e.__b+1,s=null,(l=a.__i=Tl(a,r,c,p))!=-1&&(p--,(s=r[l])&&(s.__u|=2)),s==null||s.__v==null?(l==-1&&(o>u?d--:oc?d--:d++,a.__u|=4))):e.__k[i]=null;if(p)for(i=0;i(u?1:0)){for(o=r-1,i=r+1;o>=0||i=0?o--:i++])!=null&&!(2&l.__u)&&s==l.key&&c==l.type)return a}return-1}function Ui(e,t,r){t[0]=="-"?e.setProperty(t,r!=null?r:""):e[t]=r==null?"":typeof r!="number"||wl.test(t)?r:r+"px"}function mn(e,t,r,n,o){var i,a;e:if(t=="style")if(typeof r=="string")e.style.cssText=r;else{if(typeof n=="string"&&(e.style.cssText=n=""),n)for(t in n)r&&t in r||Ui(e.style,t,"");if(r)for(t in r)n&&r[t]==n[t]||Ui(e.style,t,r[t])}else if(t[0]=="o"&&t[1]=="n")i=t!=(t=t.replace(ba,"$1")),a=t.toLowerCase(),t=a in e||t=="onFocusOut"||t=="onFocusIn"?a.slice(2):t.slice(2),e.l||(e.l={}),e.l[t+i]=r,r?n?r.u=n.u:(r.u=fo,e.addEventListener(t,i?io:oo,i)):e.removeEventListener(t,i?io:oo,i);else{if(o=="http://www.w3.org/2000/svg")t=t.replace(/xlink(H|:h)/,"h").replace(/sName$/,"s");else if(t!="width"&&t!="height"&&t!="href"&&t!="list"&&t!="form"&&t!="tabIndex"&&t!="download"&&t!="rowSpan"&&t!="colSpan"&&t!="role"&&t!="popover"&&t in e)try{e[t]=r!=null?r:"";break e}catch(s){}typeof r=="function"||(r==null||r===!1&&t[4]!="-"?e.removeAttribute(t):e.setAttribute(t,t=="popover"&&r==1?"":r))}}function Ni(e){return function(t){if(this.l){var r=this.l[t.type+e];if(t.t==null)t.t=fo++;else if(t.t0?e:Pr(e)?e.map(Ea):mt({},e)}function Ol(e,t,r,n,o,i,a,s,c){var l,u,p,d,m,h,v,x=r.props,E=t.props,T=t.type;if(T=="svg"?o="http://www.w3.org/2000/svg":T=="math"?o="http://www.w3.org/1998/Math/MathML":o||(o="http://www.w3.org/1999/xhtml"),i!=null){for(l=0;l=r.__.length&&r.__.push({}),r.__[e]}function yn(e){return $r=1,Ml(La,e)}function Ml(e,t,r){var n=bo(Hr++,2);if(n.t=e,!n.__c&&(n.__=[r?r(t):La(void 0,t),function(s){var c=n.__N?n.__N[0]:n.__[0],l=n.t(c,s);c!==l&&(n.__N=[l,n.__[1]],n.__c.setState({}))}],n.__c=be,!be.__f)){var o=function(s,c,l){if(!n.__c.__H)return!0;var u=n.__c.__H.__.filter(function(d){return!!d.__c});if(u.every(function(d){return!d.__N}))return!i||i.call(this,s,c,l);var p=n.__c.props!==s;return u.forEach(function(d){if(d.__N){var m=d.__[0];d.__=d.__N,d.__N=void 0,m!==d.__[0]&&(p=!0)}}),i&&i.call(this,s,c,l)||p};be.__f=!0;var i=be.shouldComponentUpdate,a=be.componentWillUpdate;be.componentWillUpdate=function(s,c,l){if(this.__e){var u=i;i=void 0,o(s,c,l),i=u}a&&a.call(this,s,c,l)},be.shouldComponentUpdate=o}return n.__N||n.__}function ht(e,t){var r=bo(Hr++,3);!Ee.__s&&Sa(r.__H,t)&&(r.__=e,r.u=t,be.__H.__h.push(r))}function zt(e){return $r=5,ur(function(){return{current:e}},[])}function ur(e,t){var r=bo(Hr++,7);return Sa(r.__H,t)&&(r.__=e(),r.__H=t,r.__h=e),r.__}function kl(e,t){return $r=8,ur(function(){return e},t)}function Al(){for(var e;e=Oa.shift();)if(e.__P&&e.__H)try{e.__H.__h.forEach(vn),e.__H.__h.forEach(so),e.__H.__h=[]}catch(t){e.__H.__h=[],Ee.__e(t,e.__v)}}Ee.__b=function(e){be=null,Wi&&Wi(e)},Ee.__=function(e,t){e&&t.__k&&t.__k.__m&&(e.__m=t.__k.__m),Bi&&Bi(e,t)},Ee.__r=function(e){Vi&&Vi(e),Hr=0;var t=(be=e.__c).__H;t&&(to===be?(t.__h=[],be.__h=[],t.__.forEach(function(r){r.__N&&(r.__=r.__N),r.u=r.__N=void 0})):(t.__h.forEach(vn),t.__h.forEach(so),t.__h=[],Hr=0)),to=be},Ee.diffed=function(e){zi&&zi(e);var t=e.__c;t&&t.__H&&(t.__H.__h.length&&(Oa.push(t)!==1&&Di===Ee.requestAnimationFrame||((Di=Ee.requestAnimationFrame)||Cl)(Al)),t.__H.__.forEach(function(r){r.u&&(r.__H=r.u),r.u=void 0})),to=be=null},Ee.__c=function(e,t){t.some(function(r){try{r.__h.forEach(vn),r.__h=r.__h.filter(function(n){return!n.__||so(n)})}catch(n){t.some(function(o){o.__h&&(o.__h=[])}),t=[],Ee.__e(n,r.__v)}}),qi&&qi(e,t)},Ee.unmount=function(e){Ki&&Ki(e);var t,r=e.__c;r&&r.__H&&(r.__H.__.forEach(function(n){try{vn(n)}catch(o){t=o}}),r.__H=void 0,t&&Ee.__e(t,r.__v))};var Gi=typeof requestAnimationFrame=="function";function Cl(e){var t,r=function(){clearTimeout(n),Gi&&cancelAnimationFrame(t),setTimeout(e)},n=setTimeout(r,35);Gi&&(t=requestAnimationFrame(r))}function vn(e){var t=be,r=e.__c;typeof r=="function"&&(e.__c=void 0,r()),be=t}function so(e){var t=be;e.__c=e.__(),be=t}function Sa(e,t){return!e||e.length!==t.length||t.some(function(r,n){return r!==e[n]})}function La(e,t){return typeof t=="function"?t(e):t}function Hl(e,t){for(var r in t)e[r]=t[r];return e}function Yi(e,t){for(var r in e)if(r!=="__source"&&!(r in t))return!0;for(var n in t)if(n!=="__source"&&e[n]!==t[n])return!0;return!1}function Ji(e,t){this.props=e,this.context=t}(Ji.prototype=new ct).isPureReactComponent=!0,Ji.prototype.shouldComponentUpdate=function(e,t){return Yi(this.props,e)||Yi(this.state,t)};var Xi=B.__b;B.__b=function(e){e.type&&e.type.__f&&e.ref&&(e.props.ref=e.ref,e.ref=null),Xi&&Xi(e)};var cw=typeof Symbol<"u"&&Symbol.for&&Symbol.for("react.forward_ref")||3911,$l=B.__e;B.__e=function(e,t,r,n){if(e.then){for(var o,i=t;i=i.__;)if((o=i.__c)&&o.__c)return t.__e==null&&(t.__e=r.__e,t.__k=r.__k),o.__c(e,t)}$l(e,t,r,n)};var Zi=B.unmount;function Ma(e,t,r){return e&&(e.__c&&e.__c.__H&&(e.__c.__H.__.forEach(function(n){typeof n.__c=="function"&&n.__c()}),e.__c.__H=null),(e=Hl({},e)).__c!=null&&(e.__c.__P===r&&(e.__c.__P=t),e.__c.__e=!0,e.__c=null),e.__k=e.__k&&e.__k.map(function(n){return Ma(n,t,r)})),e}function ka(e,t,r){return e&&r&&(e.__v=null,e.__k=e.__k&&e.__k.map(function(n){return ka(n,t,r)}),e.__c&&e.__c.__P===t&&(e.__e&&r.appendChild(e.__e),e.__c.__e=!0,e.__c.__P=r)),e}function ro(){this.__u=0,this.o=null,this.__b=null}function Aa(e){var t=e.__.__c;return t&&t.__a&&t.__a(e)}function dn(){this.i=null,this.l=null}B.unmount=function(e){var t=e.__c;t&&t.__R&&t.__R(),t&&32&e.__u&&(e.type=null),Zi&&Zi(e)},(ro.prototype=new ct).__c=function(e,t){var r=t.__c,n=this;n.o==null&&(n.o=[]),n.o.push(r);var o=Aa(n.__v),i=!1,a=function(){i||(i=!0,r.__R=null,o?o(s):s())};r.__R=a;var s=function(){if(!--n.__u){if(n.state.__a){var c=n.state.__a;n.__v.__k[0]=ka(c,c.__c.__P,c.__c.__O)}var l;for(n.setState({__a:n.__b=null});l=n.o.pop();)l.forceUpdate()}};n.__u++||32&t.__u||n.setState({__a:n.__b=n.__v.__k[0]}),e.then(a,a)},ro.prototype.componentWillUnmount=function(){this.o=[]},ro.prototype.render=function(e,t){if(this.__b){if(this.__v.__k){var r=document.createElement("div"),n=this.__v.__k[0].__c;this.__v.__k[0]=Ma(this.__b,r,n.__O=n.__P)}this.__b=null}var o=t.__a&&Vt(dt,null,e.fallback);return o&&(o.__u&=-33),[Vt(dt,null,t.__a?null:e.children),o]};var Qi=function(e,t,r){if(++r[1]===r[0]&&e.l.delete(t),e.props.revealOrder&&(e.props.revealOrder[0]!=="t"||!e.l.size))for(r=e.i;r;){for(;r.length>3;)r.pop()();if(r[1]Object.freeze({get current(){return t.current}}),[])}var zl=typeof globalThis<"u"&&typeof navigator<"u"&&typeof document<"u";function ql(e,...t){var r;(r=e==null?void 0:e.addEventListener)==null||r.call(e,...t)}function Kl(e,...t){var r;(r=e==null?void 0:e.removeEventListener)==null||r.call(e,...t)}var Bl=(e,t)=>Object.hasOwn(e,t),Gl=()=>!0,Yl=()=>!1;function Jl(e=!1){let t=zt(e),r=kl(()=>t.current,[]);return ht(()=>(t.current=!0,()=>{t.current=!1}),[]),r}function Xl(e,...t){let r=Jl(),n=Ha(t[1]),o=ur(()=>function(...i){r()&&(typeof n.current=="function"?n.current.apply(this,i):typeof n.current.handleEvent=="function"&&n.current.handleEvent.apply(this,i))},[]);ht(()=>{let i=Zl(e)?e.current:e;if(!i)return;let a=t.slice(2);return ql(i,t[0],o,...a),()=>{Kl(i,t[0],o,...a)}},[e,t[0]])}function Zl(e){return e!==null&&typeof e=="object"&&Bl(e,"current")}var Ql=e=>typeof e=="function"?e:typeof e=="string"?t=>t.key===e:e?Gl:Yl,eu=zl?globalThis:null;function $a(e,t,r=[],n={}){let{event:o="keydown",target:i=eu,eventOptions:a}=n,s=Ha(t),c=ur(()=>{let l=Ql(e);return function(u){l(u)&&s.current.call(this,u)}},r);Xl(i,o,c,a)}function Pa(e){var t,r,n="";if(typeof e=="string"||typeof e=="number")n+=e;else if(typeof e=="object")if(Array.isArray(e)){var o=e.length;for(t=0;t1)St--;else{for(var e,t=!1;kr!==void 0;){var r=kr;for(kr=void 0,co++;r!==void 0;){var n=r.o;if(r.o=void 0,r.f&=-3,!(8&r.f)&&ja(r))try{r.c()}catch(o){t||(e=o,t=!0)}r=n}}if(co=0,St--,t)throw e}}function nu(e){if(St>0)return e();St++;try{return e()}finally{Tn()}}var se=void 0;function Ia(e){var t=se;se=void 0;try{return e()}finally{se=t}}var kr=void 0,St=0,co=0,xn=0;function Ra(e){if(se!==void 0){var t=e.n;if(t===void 0||t.t!==se)return t={i:0,S:e,p:se.s,n:void 0,t:se,e:void 0,x:void 0,r:t},se.s!==void 0&&(se.s.n=t),se.s=t,e.n=t,32&se.f&&e.S(t),t;if(t.i===-1)return t.i=0,t.n!==void 0&&(t.n.p=t.p,t.p!==void 0&&(t.p.n=t.n),t.p=se.s,t.n=void 0,se.s.n=t,se.s=t),t}}function Ce(e,t){this.v=e,this.i=0,this.n=void 0,this.t=void 0,this.W=t==null?void 0:t.watched,this.Z=t==null?void 0:t.unwatched,this.name=t==null?void 0:t.name}Ce.prototype.brand=ru;Ce.prototype.h=function(){return!0};Ce.prototype.S=function(e){var t=this,r=this.t;r!==e&&e.e===void 0&&(e.x=r,this.t=e,r!==void 0?r.e=e:Ia(function(){var n;(n=t.W)==null||n.call(t)}))};Ce.prototype.U=function(e){var t=this;if(this.t!==void 0){var r=e.e,n=e.x;r!==void 0&&(r.x=n,e.e=void 0),n!==void 0&&(n.e=r,e.x=void 0),e===this.t&&(this.t=n,n===void 0&&Ia(function(){var o;(o=t.Z)==null||o.call(t)}))}};Ce.prototype.subscribe=function(e){var t=this;return Kt(function(){var r=t.value,n=se;se=void 0;try{e(r)}finally{se=n}},{name:"sub"})};Ce.prototype.valueOf=function(){return this.value};Ce.prototype.toString=function(){return this.value+""};Ce.prototype.toJSON=function(){return this.value};Ce.prototype.peek=function(){var e=se;se=void 0;try{return this.value}finally{se=e}};Object.defineProperty(Ce.prototype,"value",{get:function(){var e=Ra(this);return e!==void 0&&(e.i=this.i),this.v},set:function(e){if(e!==this.v){if(co>100)throw new Error("Cycle detected");this.v=e,this.i++,xn++,St++;try{for(var t=this.t;t!==void 0;t=t.x)t.t.N()}finally{Tn()}}}});function Lt(e,t){return new Ce(e,t)}function ja(e){for(var t=e.s;t!==void 0;t=t.n)if(t.S.i!==t.i||!t.S.h()||t.S.i!==t.i)return!0;return!1}function Fa(e){for(var t=e.s;t!==void 0;t=t.n){var r=t.S.n;if(r!==void 0&&(t.r=r),t.S.n=t,t.i=-1,t.n===void 0){e.s=t;break}}}function Ua(e){for(var t=e.s,r=void 0;t!==void 0;){var n=t.p;t.i===-1?(t.S.U(t),n!==void 0&&(n.n=t.n),t.n!==void 0&&(t.n.p=n)):r=t,t.S.n=t.r,t.r!==void 0&&(t.r=void 0),t=n}e.s=r}function Bt(e,t){Ce.call(this,void 0),this.x=e,this.s=void 0,this.g=xn-1,this.f=4,this.W=t==null?void 0:t.watched,this.Z=t==null?void 0:t.unwatched,this.name=t==null?void 0:t.name}Bt.prototype=new Ce;Bt.prototype.h=function(){if(this.f&=-3,1&this.f)return!1;if((36&this.f)==32||(this.f&=-5,this.g===xn))return!0;if(this.g=xn,this.f|=1,this.i>0&&!ja(this))return this.f&=-2,!0;var e=se;try{Fa(this),se=this;var t=this.x();(16&this.f||this.v!==t||this.i===0)&&(this.v=t,this.f&=-17,this.i++)}catch(r){this.v=r,this.f|=16,this.i++}return se=e,Ua(this),this.f&=-2,!0};Bt.prototype.S=function(e){if(this.t===void 0){this.f|=36;for(var t=this.s;t!==void 0;t=t.n)t.S.S(t)}Ce.prototype.S.call(this,e)};Bt.prototype.U=function(e){if(this.t!==void 0&&(Ce.prototype.U.call(this,e),this.t===void 0)){this.f&=-33;for(var t=this.s;t!==void 0;t=t.n)t.S.U(t)}};Bt.prototype.N=function(){if(!(2&this.f)){this.f|=6;for(var e=this.t;e!==void 0;e=e.x)e.t.N()}};Object.defineProperty(Bt.prototype,"value",{get:function(){if(1&this.f)throw new Error("Cycle detected");var e=Ra(this);if(this.h(),e!==void 0&&(e.i=this.i),16&this.f)throw this.v;return this.v}});function oa(e,t){return new Bt(e,t)}function Na(e){var t=e.u;if(e.u=void 0,typeof t=="function"){St++;var r=se;se=void 0;try{t()}catch(n){throw e.f&=-2,e.f|=8,go(e),n}finally{se=r,Tn()}}}function go(e){for(var t=e.s;t!==void 0;t=t.n)t.S.U(t);e.x=void 0,e.s=void 0,Na(e)}function ou(e){if(se!==this)throw new Error("Out-of-order effect");Ua(this),se=e,this.f&=-2,8&this.f&&go(this),Tn()}function pr(e,t){this.x=e,this.u=void 0,this.s=void 0,this.o=void 0,this.f=32,this.name=t==null?void 0:t.name}pr.prototype.c=function(){var e=this.S();try{if(8&this.f||this.x===void 0)return;var t=this.x();typeof t=="function"&&(this.u=t)}finally{e()}};pr.prototype.S=function(){if(1&this.f)throw new Error("Cycle detected");this.f|=1,this.f&=-9,Na(this),Fa(this),St++;var e=se;return se=this,ou.bind(this,e)};pr.prototype.N=function(){2&this.f||(this.f|=2,this.o=kr,kr=this)};pr.prototype.d=function(){this.f|=8,1&this.f||go(this)};pr.prototype.dispose=function(){this.d()};function Kt(e,t){var r=new pr(e,t);try{r.c()}catch(o){throw r.d(),o}var n=r.d.bind(r);return n[Symbol.dispose]=n,n}var Da,_o,no,Wa=[];Kt(function(){Da=this.N})();function fr(e,t){B[e]=t.bind(null,B[e]||function(){})}function wn(e){no&&no(),no=e&&e.S()}function Va(e){var t=this,r=e.data,n=au(r);n.value=r;var o=ur(function(){for(var s=t,c=t.__v;c=c.__;)if(c.__c){c.__c.__$f|=4;break}var l=oa(function(){var m=n.value.value;return m===0?0:m===!0?"":m||""}),u=oa(function(){return!Array.isArray(l.value)&&!da(l.value)}),p=Kt(function(){if(this.N=za,u.value){var m=l.value;s.__v&&s.__v.__e&&s.__v.__e.nodeType===3&&(s.__v.__e.data=m)}}),d=t.__$u.d;return t.__$u.d=function(){p(),d.call(this)},[u,l]},[]),i=o[0],a=o[1];return i.value?a.peek():a.value}Va.displayName="ReactiveTextNode";Object.defineProperties(Ce.prototype,{constructor:{configurable:!0,value:void 0},type:{configurable:!0,value:Va},props:{configurable:!0,get:function(){return{data:this}}},__b:{configurable:!0,value:1}});fr("__b",function(e,t){if(typeof t.type=="function"&&typeof window<"u"&&window.__PREACT_SIGNALS_DEVTOOLS__&&window.__PREACT_SIGNALS_DEVTOOLS__.exitComponent(),typeof t.type=="string"){var r,n=t.props;for(var o in n)if(o!=="children"){var i=n[o];i instanceof Ce&&(r||(t.__np=r={}),r[o]=i,n[o]=i.peek())}}e(t)});fr("__r",function(e,t){if(typeof t.type=="function"&&typeof window<"u"&&window.__PREACT_SIGNALS_DEVTOOLS__&&window.__PREACT_SIGNALS_DEVTOOLS__.enterComponent(t),t.type!==dt){wn();var r,n=t.__c;n&&(n.__$f&=-2,(r=n.__$u)===void 0&&(n.__$u=r=(function(o){var i;return Kt(function(){i=this}),i.c=function(){n.__$f|=1,n.setState({})},i})())),_o=n,wn(r)}e(t)});fr("__e",function(e,t,r,n){typeof window<"u"&&window.__PREACT_SIGNALS_DEVTOOLS__&&window.__PREACT_SIGNALS_DEVTOOLS__.exitComponent(),wn(),_o=void 0,e(t,r,n)});fr("diffed",function(e,t){typeof t.type=="function"&&typeof window<"u"&&window.__PREACT_SIGNALS_DEVTOOLS__&&window.__PREACT_SIGNALS_DEVTOOLS__.exitComponent(),wn(),_o=void 0;var r;if(typeof t.type=="string"&&(r=t.__e)){var n=t.__np,o=t.props;if(n){var i=r.U;if(i)for(var a in i){var s=i[a];s!==void 0&&!(a in n)&&(s.d(),i[a]=void 0)}else i={},r.U=i;for(var c in n){var l=i[c],u=n[c];l===void 0?(l=iu(r,c,u,o),i[c]=l):l.o(u,o)}}}e(t)});function iu(e,t,r,n){var o=t in e&&e.ownerSVGElement===void 0,i=Lt(r);return{o:function(a,s){i.value=a,n=s},d:Kt(function(){this.N=za;var a=i.value.value;n[t]!==a&&(n[t]=a,o?e[t]=a:a?e.setAttribute(t,a):e.removeAttribute(t))})}}fr("unmount",function(e,t){if(typeof t.type=="string"){var r=t.__e;if(r){var n=r.U;if(n){r.U=void 0;for(var o in n){var i=n[o];i&&i.d()}}}}else{var a=t.__c;if(a){var s=a.__$u;s&&(a.__$u=void 0,s.d())}}e(t)});fr("__h",function(e,t,r,n){(n<3||n===9)&&(t.__$f|=2),e(t,r,n)});ct.prototype.shouldComponentUpdate=function(e,t){var r=this.__$u,n=r&&r.s!==void 0;for(var o in t)return!0;if(this.__f||typeof this.u=="boolean"&&this.u===!0){var i=2&this.__$f;if(!(n||i||4&this.__$f)||1&this.__$f)return!0}else if(!(n||4&this.__$f)||3&this.__$f)return!0;for(var a in e)if(a!=="__source"&&e[a]!==this.props[a])return!0;for(var s in this.props)if(!(s in e))return!0;return!1};function au(e,t){return yn(function(){return Lt(e,t)})[0]}var su=function(e){queueMicrotask(function(){queueMicrotask(e)})};function cu(){nu(function(){for(var e;e=Wa.shift();)Da.call(e)})}function za(){Wa.push(this)===1&&(B.requestAnimationFrame||su)(cu)}var lo=[0];for(let e=0;e<32;e++)lo.push(lo[e]|1<>>5]>>>e&1}set(e){this.data[e>>>5]|=1<<(e&31)}forEach(e){let t=this.size&31;for(let r=0;r{var r;return(r=t.tags)==null?void 0:r.length})&&(matchMedia("(max-width: 768px)").matches||qa())}function Wt(){Qe.value=He(M({},Qe.value),{hideSearch:!Qe.value.hideSearch})}function qa(){Qe.value=He(M({},Qe.value),{hideFilters:!Qe.value.hideFilters})}function bn(){return Qe.value.selectedItem}function uo(e){Qe.value=He(M({},Qe.value),{selectedItem:e})}function pu(){var e,t;return(t=(e=lr.value)==null?void 0:e.items)!=null?t:[]}function On(){return typeof Se.value.input=="string"?Se.value.input:""}function Ka(e){let t=Ba();e.length&&!t.length?Se.value=He(M({},Se.value),{page:void 0,input:e}):!e.length&&t.length?Se.value=He(M({},Se.value),{page:void 0,input:{type:"operator",data:{operator:"not",operands:[]}}}):Se.value=He(M({},Se.value),{page:void 0,input:e})}function fu(){typeof st.value.pagination.next<"u"&&(Se.value=He(M({},Se.value),{page:st.value.pagination.next}))}function mu(e){let t=Se.value.filter.input;if("type"in t&&t.type==="operator"){for(let r of t.data.operands)if("type"in r&&r.type==="value"&&typeof r.data.value=="string"&&r.data.value===e)return!0}return!1}function Ba(){let e=Se.value.filter.input,t=[];if("type"in e&&e.type==="operator")for(let r of e.data.operands)"type"in r&&r.type==="value"&&typeof r.data.value=="string"&&t.push(r.data.value);return t}function du(e){let t=Se.value.filter.input,r=[];if("type"in t&&t.type==="operator")for(let n of t.data.operands)"type"in n&&n.type==="value"&&typeof n.data.value=="string"&&r.push(n.data.value);if(r.includes(e)){let n=r.indexOf(e);n>-1&&r.splice(n,1)}else r.push(e);Se.value=He(M({},Se.value),{page:void 0,filter:He(M({},Se.value.filter),{input:{type:"operator",data:{operator:"and",operands:r.map(n=>({type:"value",data:{field:"tags",value:n}}))}}})}),Ka(On())}function hu(){return st.value.items}function vu(){return st.value.total}function bu(){var e;for(let t of(e=st.value.aggregations)!=null?e:[])if(t.type==="term")return t.data.value;return[]}function sr(){return Qe.value.hideSearch}function gu(){return Qe.value.hideFilters}function Ga(){var e;return(e=Ya.value.highlight)!=null?e:!1}var Qe=Lt({hideSearch:!0,hideFilters:!0,selectedItem:0}),Ya=Lt({}),lr=Lt(),aa=Lt(),Se=Lt({input:"",filter:{input:{type:"operator",data:{operator:"and",operands:[]}},aggregation:{input:[{type:"term",data:{field:"tags"}}]}}}),st=Lt({items:[],query:{select:{documents:new ia(0),terms:new ia(0)},values:[]},pagination:{total:0}});function _u(e,t,r){for(let n=0;tr&&t(0,o,r,r=i);continue;case 62:e.charCodeAt(r+1)===47?t(2,--o,r,r=i+1):_u(e,r,n)?t(3,o,r,r=i+1):t(1,o++,r,r=i+1)}i>r&&t(0,o,r,i)}function xu(e,t=0,r=e.length){let n=++t;e:for(let l=0;n{let i=[],a=[],{onElement:s,onText:c=wu}=typeof r=="function"?{onElement:r}:r,l=0,u=0;return e(t,(p,d,m,h)=>{if(p===0)i[l++]=c(t,m,h),a[u++]={value:null,depth:d};else if(p&1&&(a[u++]={value:xu(t,m,h),depth:d}),p&2)for(let v=0;u>=0;v++){let{value:x,depth:E}=a[--u];if(E>d)continue;let T=i.slice(l-=v,l+v);i[l++]=s(x,T),u++;break}},n,o),i.slice(0,l)}}function Tu(e){return e.replace(/[&<>]/g,t=>{switch(t.charCodeAt(0)){case 38:return"&";case 60:return"<";case 62:return">"}})}function gn(e){return e.replace(/&(amp|[lg]t);/g,t=>{switch(t.charCodeAt(1)){case 97:return"&";case 108:return"<";case 103:return">"}})}function Ou(e,t){return{start:e.start+t,end:e.end+t,value:e.value}}function Su(e,t,r){return e.slice(t,r)}function Lu(e){let{onHighlight:t,onText:r=Su}=typeof e=="function"?{onHighlight:e}:e;return(n,o,i=0,a=n.length)=>{var l;let s=[],c=(l=o==null?void 0:o.ranges)!=null?l:[];for(let u=0,p=i;ua)break;let m=c[u].end;if(mi&&s.push(r(n,i,d));let{value:h}=c[u];s.push(t(n,{start:d,end:i=m,value:h}))}return i{let o=n.data;switch(o.type){case 1:aa.value=!0;break;case 3:typeof o.data.pagination.prev<"u"?st.value=He(M({},st.value),{pagination:o.data.pagination,items:[...st.value.items,...o.data.items]}):(st.value=o.data,uo(0));break}},Kt(()=>{lr.value&&r.postMessage({type:0,data:lr.value})}),Kt(()=>{aa.value&&r.postMessage({type:2,data:Se.value})})}var sa={container:"p",hidden:"m"};function $u(e){return q("div",{class:qt(sa.container,{[sa.hidden]:e.hidden}),onClick:()=>Wt()})}var ca={container:"r",disabled:"c"};function po(e){return q("button",{class:qt(ca.container,{[ca.disabled]:!e.onClick}),onClick:e.onClick,children:e.children})}var la=e=>e.replace(/([a-z0-9])([A-Z])/g,"$1-$2").toLowerCase(),Pu=e=>e.replace(/^([A-Z])|[\s-_]+(\w)/g,(t,r,n)=>n?n.toUpperCase():r.toLowerCase()),ua=e=>{let t=Pu(e);return t.charAt(0).toUpperCase()+t.slice(1)},Iu=(...e)=>e.filter((t,r,n)=>!!t&&t.trim()!==""&&n.indexOf(t)===r).join(" ").trim(),Ru={xmlns:"http://www.w3.org/2000/svg",width:24,height:24,viewBox:"0 0 24 24",fill:"none",stroke:"currentColor","stroke-width":"2","stroke-linecap":"round","stroke-linejoin":"round"},ju=c=>{var l=c,{color:e="currentColor",size:t=24,strokeWidth:r=2,absoluteStrokeWidth:n,children:o,iconNode:i,class:a=""}=l,s=gr(l,["color","size","strokeWidth","absoluteStrokeWidth","children","iconNode","class"]);return Vt("svg",M(He(M({},Ru),{width:String(t),height:t,stroke:e,"stroke-width":n?Number(r)*24/Number(t):r,class:["lucide",a].join(" ")}),s),[...i.map(([u,p])=>Vt(u,p)),...Cr(o)])},yo=(e,t)=>{let r=a=>{var s=a,{class:n="",children:o}=s,i=gr(s,["class","children"]);return Vt(ju,He(M({},i),{iconNode:t,class:Iu(`lucide-${la(ua(e))}`,`lucide-${la(e)}`,n)}),o)};return r.displayName=ua(e),r},Fu=yo("corner-down-left",[["path",{d:"M20 4v7a4 4 0 0 1-4 4H4",key:"6o5b7l"}],["path",{d:"m9 10-5 5 5 5",key:"1kshq7"}]]),Uu=yo("list-filter",[["path",{d:"M2 5h20",key:"1fs1ex"}],["path",{d:"M6 12h12",key:"8npq4p"}],["path",{d:"M9 19h6",key:"456am0"}]]),Nu=yo("search",[["path",{d:"m21 21-4.34-4.34",key:"14j7rj"}],["circle",{cx:"11",cy:"11",r:"8",key:"4ej97u"}]]),lw=_l(yl(),1);function Du({threshold:e=0,root:t=null,rootMargin:r="0%",freezeOnceVisible:n=!1,initialIsIntersecting:o=!1,onChange:i}={}){var a;let[s,c]=yn(null),[l,u]=yn(()=>({isIntersecting:o,entry:void 0})),p=zt();p.current=i;let d=((a=l.entry)==null?void 0:a.isIntersecting)&&n;ht(()=>{if(!s||!("IntersectionObserver"in window)||d)return;let v,x=new IntersectionObserver(E=>{let T=Array.isArray(x.thresholds)?x.thresholds:[x.thresholds];E.forEach(_=>{let de=_.isIntersecting&&T.some(ge=>_.intersectionRatio>=ge);u({isIntersecting:de,entry:_}),p.current&&p.current(de,_),de&&n&&v&&(v(),v=void 0)})},{threshold:e,root:t,rootMargin:r});return x.observe(s),()=>{x.disconnect()}},[s,JSON.stringify(e),t,r,d,n]);let m=zt(null);ht(()=>{var v;!s&&(v=l.entry)!=null&&v.target&&!n&&!d&&m.current!==l.entry.target&&(m.current=l.entry.target,u({isIntersecting:o,entry:void 0}))},[s,l.entry,n,d,o]);let h=[c,!!l.isIntersecting,l.entry];return h.ref=h[0],h.isIntersecting=h[1],h.entry=h[2],h}var pt={container:"n",hidden:"l",content:"u",pop:"d",badge:"y",sidebar:"i",controls:"w",results:"k",loadmore:"z"};function Wu(e){let{isIntersecting:t,ref:r}=Du({threshold:0});ht(()=>{t&&fu()},[t]);let n=zt(null);ht(()=>{n.current&&typeof Se.value.page>"u"&&n.current.scrollTo({top:0,behavior:"smooth"})},[Se.value]);let o=Ba();return q("div",{class:qt(pt.container,{[pt.hidden]:e.hidden}),children:[q("div",{class:pt.content,children:[q("div",{class:pt.controls,children:[q(po,{onClick:Wt,children:q(Nu,{})}),q(zu,{focus:!e.hidden}),q(po,{onClick:qa,children:[q(Uu,{}),o.length>0&&q("span",{class:pt.badge,children:o.length})]})]}),q("div",{class:pt.results,ref:n,children:[q(qu,{keyboard:!e.hidden}),q("div",{class:pt.loadmore,ref:r})]})]}),q("div",{class:qt(pt.sidebar,{[pt.hidden]:gu()}),children:q(Vu,{})})]})}var Ot={container:"X",list:"j",heading:"F",title:"I",item:"o",active:"g",value:"R",count:"q"};function Vu(e){let t=bu();return t.sort((r,n)=>n.node.count-r.node.count),q("div",{class:Ot.container,children:[q("h3",{class:Ot.heading,children:"Filters"}),q("h4",{class:Ot.title,children:"Tags"}),q("ol",{class:Ot.list,children:t.map(r=>q("li",{class:qt(Ot.item,{[Ot.active]:mu(r.node.value)}),onClick:()=>du(r.node.value),children:[q("span",{class:Ot.value,children:r.node.value}),q("span",{class:Ot.count,children:r.node.count})]}))})]})}var pa={container:"f"};function zu(e){let t=zt(null);return ht(()=>{var r,n;e.focus?(r=t.current)==null||r.focus():(n=t.current)==null||n.blur()},[e.focus]),q("div",{class:pa.container,children:q("input",{ref:t,type:"text",class:pa.content,value:gn(On()),onInput:r=>Ka(Tu(r.currentTarget.value)),autocapitalize:"off",autocomplete:"off",autocorrect:"off",placeholder:"Search",spellcheck:!1,role:"combobox"})})}var ft={container:"b",heading:"A",item:"a",active:"h",wrapper:"B",actions:"s",title:"x",path:"t"};function Za(){let[e,t]=yn(!1);return ht(()=>{let r=()=>t(!0),n=()=>t(!1);return document.addEventListener("compositionstart",r),document.addEventListener("compositionend",n),()=>{document.removeEventListener("compositionstart",r),document.removeEventListener("compositionend",n)}},[]),e}function qu(e){var s;let t=pu(),r=hu(),n=bn(),o=zt([]),i=Za();ht(()=>{let c=o.current[n];c&&c.scrollIntoView({block:"center",behavior:"smooth"})},[n]),$a(e.keyboard,c=>{if(i)return;let l=bn();c.key==="ArrowDown"?(c.preventDefault(),uo(Math.min(l+1,r.length-1))):c.key==="ArrowUp"&&(c.preventDefault(),uo(Math.max(l-1,0)))},[e.keyboard,i]);let a=(s=vu())!=null?s:0;return q(dt,{children:[r.length>0&&q("h3",{class:ft.heading,children:[q("span",{class:ft.bubble,children:new Intl.NumberFormat("en-US").format(a)})," ","results"]}),q("ol",{class:ft.container,children:r.map((c,l)=>{var m;let u=Ja(t[c.id].title,c.matches.find(({field:h})=>h==="title")),p=Hu((m=t[c.id].path)!=null?m:[],c.matches.find(({field:h})=>h==="path")),d=t[c.id].location;if(Ga()){let h=encodeURIComponent(On()),[v,x]=d.split("#",2);d=`${v}?h=${h.replace(/%20/g,"+")}`,typeof x<"u"&&(d+=`#${x}`)}return q("li",{children:q("a",{ref:h=>{o.current[l]=h},href:d,onClick:()=>Wt(),class:qt(ft.item,{[ft.active]:l===bn()}),children:[q("div",{class:ft.wrapper,children:[q("h2",{class:ft.title,children:u}),q("menu",{class:ft.path,children:p.map(h=>q("li",{children:h}))})]}),q("nav",{class:ft.actions,children:q(po,{children:q(Fu,{})})})]})})})})]})}var Ku={container:"e"};function Bu(e){let t=Za();return $a(!0,r=>{var n,o,i,a,s;if(!t)if((r.metaKey||r.ctrlKey)&&r.key==="k")r.preventDefault(),Wt();else if((r.metaKey||r.ctrlKey)&&r.key==="j")document.body.classList.toggle("dark");else if(r.key==="Enter"&&!sr()){r.preventDefault();let c=bn(),l=(o=(n=st.value)==null?void 0:n.items[c])==null?void 0:o.id;if((a=(i=lr.value)==null?void 0:i.items[l])!=null&&a.location){Wt();let u=(s=lr.value)==null?void 0:s.items[l].location;if(Ga()){let p=encodeURIComponent(On()),[d,m]=u.split("#",2);u=`${d}?h=${p.replace(/%20/g,"+")}`,typeof m<"u"&&(u+=`#${m}`)}window.location.href=u}}else r.key==="Escape"&&!sr()&&(r.preventDefault(),Wt())},[t]),q("div",{class:Ku.container,children:[q($u,{hidden:sr()}),q(Wu,{hidden:sr()})]})}function Qa(e,t){uu(e),Ll(q(Bu,{}),t)}function xo(){Wt()}function Gu(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Yu(){return R(b(window,"compositionstart").pipe(f(()=>!0)),b(window,"compositionend").pipe(f(()=>!1))).pipe(J(!1))}function es(){let e=b(window,"keydown").pipe(f(t=>({mode:sr()?"global":"search",type:t.key,meta:t.ctrlKey||t.metaKey,claim(){t.preventDefault(),t.stopPropagation()}})),L(({mode:t,type:r})=>{if(t==="global"){let n=xt();if(typeof n!="undefined")return!Gu(n,r)}return!0}),xe());return Yu().pipe(g(t=>t?y:e))}function Ge(){return new URL(location.href)}function vt(e,t=!1){if(X("navigation.instant")&&!t){let r=k("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function ts(){return new I}function rs(){return location.hash.slice(1)}function ns(e){let t=k("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function wo(e){return R(b(window,"hashchange"),e).pipe(f(rs),J(rs()),L(t=>t.length>0),f(decodeURIComponent),ie(1))}function os(e){return wo(e).pipe(f(t=>we(`[id="${t}"]`)),L(t=>typeof t!="undefined"))}function Ir(e){let t=matchMedia(e);return ln(r=>t.addListener(()=>r(t.matches))).pipe(J(t.matches))}function is(){let e=matchMedia("print");return R(b(window,"beforeprint").pipe(f(()=>!0)),b(window,"afterprint").pipe(f(()=>!1))).pipe(J(e.matches))}function Eo(e,t){return e.pipe(g(r=>r?t():y))}function To(e,t){return new F(r=>{let n=new XMLHttpRequest;return n.open("GET",`${e}`),n.responseType="blob",n.addEventListener("load",()=>{n.status>=200&&n.status<300?(r.next(n.response),r.complete()):r.error(new Error(n.statusText))}),n.addEventListener("error",()=>{r.error(new Error("Network error"))}),n.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(n.addEventListener("progress",o=>{var i;if(o.lengthComputable)t.progress$.next(o.loaded/o.total*100);else{let a=(i=n.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(o.loaded/+a*100)}}),t.progress$.next(5)),n.send(),()=>n.abort()})}function et(e,t){return To(e,t).pipe(g(r=>r.text()),f(r=>JSON.parse(r)),ie(1))}function Sn(e,t){let r=new DOMParser;return To(e,t).pipe(g(n=>n.text()),f(n=>r.parseFromString(n,"text/html")),ie(1))}function as(e,t){let r=new DOMParser;return To(e,t).pipe(g(n=>n.text()),f(n=>r.parseFromString(n,"text/xml")),ie(1))}var Oo={drawer:Y("[data-md-toggle=drawer]"),search:Y("[data-md-toggle=search]")};function So(e,t){Oo[e].checked!==t&&Oo[e].click()}function Ln(e){let t=Oo[e];return b(t,"change").pipe(f(()=>t.checked),J(t.checked))}function ss(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function cs(){return R(b(window,"scroll",{passive:!0}),b(window,"resize",{passive:!0})).pipe(f(ss),J(ss()))}function ls(){return{width:innerWidth,height:innerHeight}}function us(){return b(window,"resize",{passive:!0}).pipe(f(ls),J(ls()))}function ps(){return re([cs(),us()]).pipe(f(([e,t])=>({offset:e,size:t})),ie(1))}function Mn(e,{viewport$:t,header$:r}){let n=t.pipe(fe("size")),o=re([n,r]).pipe(f(()=>Et(e)));return re([r,t,o]).pipe(f(([{height:i},{offset:a,size:s},{x:c,y:l}])=>({offset:{x:a.x-c,y:a.y-l+i},size:s})))}var Ju=Y("#__config"),mr=JSON.parse(Ju.textContent);mr.base=`${new URL(mr.base,Ge())}`;function Ue(){return mr}function X(e){return mr.features.includes(e)}function Gt(e,t){return typeof t!="undefined"?mr.translations[e].replace("#",t.toString()):mr.translations[e]}function bt(e,t=document){return Y(`[data-md-component=${e}]`,t)}function Te(e,t=document){return P(`[data-md-component=${e}]`,t)}function Xu(e){let t=Y(".md-typeset > :first-child",e);return b(t,"click",{once:!0}).pipe(f(()=>Y(".md-typeset",e)),f(r=>({hash:__md_hash(r.innerHTML)})))}function fs(e){if(!X("announce.dismiss")||!e.childElementCount)return y;if(!e.hidden){let t=Y(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return j(()=>{let t=new I;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),Xu(e).pipe($(r=>t.next(r)),z(()=>t.complete()),f(r=>M({ref:e},r)))})}function Zu(e,{target$:t}){return t.pipe(f(r=>({hidden:r!==e})))}function ms(e,t){let r=new I;return r.subscribe(({hidden:n})=>{e.hidden=n}),Zu(e,t).pipe($(n=>r.next(n)),z(()=>r.complete()),f(n=>M({ref:e},n)))}function Lo(e,t){return t==="inline"?k("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},k("div",{class:"md-tooltip__inner md-typeset"})):k("div",{class:"md-tooltip",id:e,role:"tooltip"},k("div",{class:"md-tooltip__inner md-typeset"}))}function kn(...e){return k("div",{class:"md-tooltip2",role:"dialog"},k("div",{class:"md-tooltip2__inner md-typeset"},e))}function ds(...e){return k("div",{class:"md-tooltip2",role:"tooltip"},k("div",{class:"md-tooltip2__inner md-typeset"},e))}function hs(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return k("aside",{class:"md-annotation",tabIndex:0},Lo(t),k("a",{href:r,class:"md-annotation__index",tabIndex:-1},k("span",{"data-md-annotation-id":e})))}else return k("aside",{class:"md-annotation",tabIndex:0},Lo(t),k("span",{class:"md-annotation__index",tabIndex:-1},k("span",{"data-md-annotation-id":e})))}function vs(e){return k("button",{class:"md-code__button",title:Gt("clipboard.copy"),"data-clipboard-target":`#${e} > code`,"data-md-type":"copy"})}function bs(){return k("button",{class:"md-code__button",title:"Toggle line selection","data-md-type":"select"})}function gs(){return k("nav",{class:"md-code__nav"})}var tp=_r(Mo());function ys(e){return k("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>k("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?ki(r):r)))}function ko(e){let t=`tabbed-control tabbed-control--${e}`;return k("div",{class:t,hidden:!0},k("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function xs(e){return k("div",{class:"md-typeset__scrollwrap"},k("div",{class:"md-typeset__table"},e))}function rp(e){var n;let t=Ue(),r=new URL(`../${e.version}/`,t.base);return k("li",{class:"md-version__item"},k("a",{href:`${r}`,class:"md-version__link"},e.title,((n=t.version)==null?void 0:n.alias)&&e.aliases.length>0&&k("span",{class:"md-version__alias"},e.aliases[0])))}function ws(e,t){var n;let r=Ue();return e=e.filter(o=>{var i;return!((i=o.properties)!=null&&i.hidden)}),k("div",{class:"md-version"},k("button",{class:"md-version__current","aria-label":Gt("select.version")},t.title,((n=r.version)==null?void 0:n.alias)&&t.aliases.length>0&&k("span",{class:"md-version__alias"},t.aliases[0])),k("ul",{class:"md-version__list"},e.map(rp)))}var np=0;function op(e,t=250){let r=re([ar(e),Ut(e,t)]).pipe(f(([o,i])=>o||i),ae()),n=j(()=>$i(e)).pipe(oe(Nt),Lr(1),Ze(r),f(()=>Pi(e)));return r.pipe(Or(o=>o),g(()=>re([r,n])),f(([o,i])=>({active:o,offset:i})),xe())}function Rr(e,t,r=250){let{content$:n,viewport$:o}=t,i=`__tooltip2_${np++}`;return j(()=>{let a=new I,s=new Wn(!1);a.pipe(ve(),ye(!1)).subscribe(s);let c=s.pipe(Tr(u=>Ve(+!u*250,qn)),ae(),g(u=>u?n:y),$(u=>u.id=i),xe());re([a.pipe(f(({active:u})=>u)),c.pipe(g(u=>Ut(u,250)),J(!1))]).pipe(f(u=>u.some(p=>p))).subscribe(s);let l=s.pipe(L(u=>u),pe(c,o),f(([u,p,{size:d}])=>{let m=e.getBoundingClientRect(),h=m.width/2;if(p.role==="tooltip")return{x:h,y:8+m.height};if(m.y>=d.height/2){let{height:v}=Ae(p);return{x:h,y:-16-v}}else return{x:h,y:16+m.height}}));return re([c,a,l]).subscribe(([u,{offset:p},d])=>{u.style.setProperty("--md-tooltip-host-x",`${p.x}px`),u.style.setProperty("--md-tooltip-host-y",`${p.y}px`),u.style.setProperty("--md-tooltip-x",`${d.x}px`),u.style.setProperty("--md-tooltip-y",`${d.y}px`),u.classList.toggle("md-tooltip2--top",d.y<0),u.classList.toggle("md-tooltip2--bottom",d.y>=0)}),s.pipe(L(u=>u),pe(c,(u,p)=>p),L(u=>u.role==="tooltip")).subscribe(u=>{let p=Ae(Y(":scope > *",u));u.style.setProperty("--md-tooltip-width",`${p.width}px`),u.style.setProperty("--md-tooltip-tail","0px")}),s.pipe(ae(),Ie(je),pe(c)).subscribe(([u,p])=>{p.classList.toggle("md-tooltip2--active",u)}),re([s.pipe(L(u=>u)),c]).subscribe(([u,p])=>{p.role==="dialog"?(e.setAttribute("aria-controls",i),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",i)}),s.pipe(L(u=>!u)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),op(e,r).pipe($(u=>a.next(u)),z(()=>a.complete()),f(u=>M({ref:e},u)))})}function Ye(e,{viewport$:t},r=document.body){return Rr(e,{content$:new F(n=>{let o=e.title,i=ds(o);return n.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",o)}}),viewport$:t},0)}function ip(e,t){let r=j(()=>re([Ii(e),Nt(t)])).pipe(f(([{x:n,y:o},i])=>{let{width:a,height:s}=Ae(e);return{x:n-i.x+a/2,y:o-i.y+s/2}}));return ar(e).pipe(g(n=>r.pipe(f(o=>({active:n,offset:o})),Me(+!n||1/0))))}function Es(e,t,{target$:r}){let[n,o]=Array.from(e.children);return j(()=>{let i=new I,a=i.pipe(ve(),ye(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),Tt(e).pipe(Q(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),R(i.pipe(L(({active:s})=>s)),i.pipe(Be(250),L(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(n):n.remove()},complete(){e.prepend(n)}}),i.pipe(Xe(16,je)).subscribe(({active:s})=>{n.classList.toggle("md-tooltip--active",s)}),i.pipe(Lr(125,je),L(()=>!!e.offsetParent),f(()=>e.offsetParent.getBoundingClientRect()),f(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),b(o,"click").pipe(Q(a),L(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),b(o,"mousedown").pipe(Q(a),pe(i)).subscribe(([s,{active:c}])=>{var l;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(c){s.preventDefault();let u=e.parentElement.closest(".md-annotation");u instanceof HTMLElement?u.focus():(l=xt())==null||l.blur()}}),r.pipe(Q(a),L(s=>s===n),Rt(125)).subscribe(()=>e.focus()),ip(e,t).pipe($(s=>i.next(s)),z(()=>i.complete()),f(s=>M({ref:e},s)))})}function ap(e){let t=Ue();if(e.tagName!=="CODE")return[e];let r=[".c",".c1",".cm"];if(t.annotate){let n=e.closest("[class|=language]");if(n)for(let o of Array.from(n.classList)){if(!o.startsWith("language-"))continue;let[,i]=o.split("-");i in t.annotate&&r.push(...t.annotate[i])}}return P(r.join(", "),e)}function sp(e){let t=[];for(let r of ap(e)){let n=[],o=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=o.nextNode();i;i=o.nextNode())n.push(i);for(let i of n){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,c]=a;if(typeof c=="undefined"){let l=i.splitText(a.index);i=l.splitText(s.length),t.push(l)}else{i.textContent=s,t.push(i);break}}}}return t}function Ts(e,t){t.append(...Array.from(e.childNodes))}function An(e,t,{target$:r,print$:n}){let o=t.closest("[id]"),i=o==null?void 0:o.id,a=new Map;for(let s of sp(t)){let[,c]=s.textContent.match(/\((\d+)\)/);we(`:scope > li:nth-child(${c})`,e)&&(a.set(c,hs(c,i)),s.replaceWith(a.get(c)))}return a.size===0?y:j(()=>{let s=new I,c=s.pipe(ve(),ye(!0)),l=[];for(let[u,p]of a)l.push([Y(".md-typeset",p),Y(`:scope > li:nth-child(${u})`,e)]);return n.pipe(Q(c)).subscribe(u=>{e.hidden=!u,e.classList.toggle("md-annotation-list",u);for(let[p,d]of l)u?Ts(p,d):Ts(d,p)}),R(...[...a].map(([,u])=>Es(u,t,{target$:r}))).pipe(z(()=>s.complete()),xe())})}function Os(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return Os(t)}}function Ss(e,t){return j(()=>{let r=Os(e);return typeof r!="undefined"?An(r,e,t):y})}var Ms=_r(Co());var cp=0,Ls=R(b(window,"keydown").pipe(f(()=>!0)),R(b(window,"keyup"),b(window,"contextmenu")).pipe(f(()=>!1))).pipe(J(!1),ie(1));function ks(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return ks(t)}}function lp(e){return Re(e).pipe(f(({width:t})=>({scrollable:Mr(e).width>t})),fe("scrollable"))}function As(e,t){let{matches:r}=matchMedia("(hover)"),n=j(()=>{let o=new I,i=o.pipe(Zn(1));o.subscribe(({scrollable:m})=>{m&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[],s=e.closest("pre"),c=s.closest("[id]"),l=c?c.id:cp++;s.id=`__code_${l}`;let u=[],p=e.closest(".highlight");if(p instanceof HTMLElement){let m=ks(p);if(typeof m!="undefined"&&(p.classList.contains("annotate")||X("content.code.annotate"))){let h=An(m,e,t);u.push(Re(p).pipe(Q(i),f(({width:v,height:x})=>v&&x),ae(),g(v=>v?h:y)))}}let d=P(":scope > span[id]",e);if(d.length&&(e.classList.add("md-code__content"),e.closest(".select")||X("content.code.select")&&!e.closest(".no-select"))){let m=+d[0].id.split("-").pop(),h=bs();a.push(h),X("content.tooltips")&&u.push(Ye(h,{viewport$}));let v=b(h,"click").pipe(Sr(A=>!A,!1),$(()=>h.blur()),xe());v.subscribe(A=>{h.classList.toggle("md-code__button--active",A)});let x=me(d).pipe(oe(A=>Ut(A).pipe(f(S=>[A,S]))));v.pipe(g(A=>A?x:y)).subscribe(([A,S])=>{let D=we(".hll.select",A);if(D&&!S)D.replaceWith(...Array.from(D.childNodes));else if(!D&&S){let ee=document.createElement("span");ee.className="hll select",ee.append(...Array.from(A.childNodes).slice(1)),A.append(ee)}});let E=me(d).pipe(oe(A=>b(A,"mousedown").pipe($(S=>S.preventDefault()),f(()=>A)))),T=v.pipe(g(A=>A?E:y),pe(Ls),f(([A,S])=>{var ee;let D=d.indexOf(A)+m;if(S===!1)return[D,D];{let le=P(".hll",e).map(ce=>d.indexOf(ce.parentElement)+m);return(ee=window.getSelection())==null||ee.removeAllRanges(),[Math.min(D,...le),Math.max(D,...le)]}})),_=wo(y).pipe(L(A=>A.startsWith(`__codelineno-${l}-`)));_.subscribe(A=>{let[,,S]=A.split("-"),D=S.split(":").map(le=>+le-m+1);D.length===1&&D.push(D[0]);for(let le of P(".hll:not(.select)",e))le.replaceWith(...Array.from(le.childNodes));let ee=d.slice(D[0]-1,D[1]);for(let le of ee){let ce=document.createElement("span");ce.className="hll",ce.append(...Array.from(le.childNodes).slice(1)),le.append(ce)}}),_.pipe(Me(1),Ie(_e)).subscribe(A=>{if(A.includes(":")){let S=document.getElementById(A.split(":")[0]);S&&setTimeout(()=>{let D=S,ee=-64;for(;D!==document.body;)ee+=D.offsetTop,D=D.offsetParent;window.scrollTo({top:ee})},1)}});let ge=me(P('a[href^="#__codelineno"]',p)).pipe(oe(A=>b(A,"click").pipe($(S=>S.preventDefault()),f(()=>A)))).pipe(Q(i),pe(Ls),f(([A,S])=>{let ee=+Y(`[id="${A.hash.slice(1)}"]`).parentElement.id.split("-").pop();if(S===!1)return[ee,ee];{let le=P(".hll",e).map(ce=>+ce.parentElement.id.split("-").pop());return[Math.min(ee,...le),Math.max(ee,...le)]}}));R(T,ge).subscribe(A=>{let S=`#__codelineno-${l}-`;A[0]===A[1]?S+=A[0]:S+=`${A[0]}:${A[1]}`,history.replaceState({},"",S),window.dispatchEvent(new HashChangeEvent("hashchange",{newURL:window.location.origin+window.location.pathname+S,oldURL:window.location.href}))})}if(Ms.default.isSupported()&&(e.closest(".copy")||X("content.code.copy")&&!e.closest(".no-copy"))){let m=vs(s.id);a.push(m),X("content.tooltips")&&u.push(Ye(m,{viewport$}))}if(a.length){let m=gs();m.append(...a),s.insertBefore(m,e)}return lp(e).pipe($(m=>o.next(m)),z(()=>o.complete()),f(m=>M({ref:e},m)),jt(R(...u).pipe(Q(i))))});return X("content.lazy")?Tt(e).pipe(L(o=>o),Me(1),g(()=>n)):n}function up(e,{target$:t,print$:r}){let n=!0;return R(t.pipe(f(o=>o.closest("details:not([open])")),L(o=>e===o),f(()=>({action:"open",reveal:!0}))),r.pipe(L(o=>o||!n),$(()=>n=e.open),f(o=>({action:o?"open":"close"}))))}function Cs(e,t){return j(()=>{let r=new I;return r.subscribe(({action:n,reveal:o})=>{e.toggleAttribute("open",n==="open"),o&&e.scrollIntoView()}),up(e,t).pipe($(n=>r.next(n)),z(()=>r.complete()),f(n=>M({ref:e},n)))})}var Ho;function pp(){return typeof GLightbox=="undefined"||GLightbox instanceof Element?Gn([wt("https://unpkg.com/glightbox@3/dist/js/glightbox.min.js"),Ai("https://unpkg.com/glightbox@3/dist/css/glightbox.min.css")]).pipe(he(()=>y),f(()=>{})):K(void 0)}function Hs(e){return Ho||(Ho=pp().pipe(f(()=>new GLightbox(M({touchNavigation:!0,loop:!1,zoomable:!0,draggable:!0,openEffect:"zoom",closeEffect:"zoom",slideEffect:"slide",onOpen:()=>{document.activeElement instanceof HTMLElement&&document.activeElement.blur()}},typeof GLightboxOptions!="undefined"?GLightboxOptions:{}))),ie(1))),Ho.pipe($(t=>t.setElements(e))),Ho.pipe(g(()=>e.map(t=>({ref:t}))))}var $s=0,Ps=new Map;function fp(e){let t=document.createElement("h3");t.innerHTML=e.innerHTML;let r=[t],n=e.nextElementSibling;for(;n&&!(n instanceof HTMLHeadingElement);)r.push(n.cloneNode(!0)),n=n.nextElementSibling;return r}function mp(e,t){for(let r of P("[href], [src]",e))for(let n of["href","src"]){let o=r.getAttribute(n);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){r[n]=new URL(r.getAttribute(n),t).toString();break}}for(let r of P("[name^=__], [for]",e))for(let n of["id","for","name"]){let o=r.getAttribute(n);o&&r.setAttribute(n,`${o}$preview_${$s}`)}return $s++,K(e)}function dp(e){let t=Ps.get(e.toString());return t?K(t):Sn(e).pipe(g(r=>mp(r,e)),f(r=>(Ps.set(e.toString(),r),r)))}function Is(e,t){let{sitemap$:r}=t;if(!(e instanceof HTMLAnchorElement))return y;if(!(X("navigation.instant.preview")||e.hasAttribute("data-preview")))return y;e.removeAttribute("title");let n=re([ar(e),Ut(e).pipe(ke(1))]).pipe(f(([i,a])=>i||a),ae(),L(i=>i));return Pt([r,n]).pipe(g(([i])=>{let a=new URL(e.href);return a.search=a.hash="",i.has(`${a}`)?K(a):y}),g(i=>dp(i)),g(i=>{let a=e.hash?`article [id="${decodeURIComponent(e.hash.slice(1))}"]`:"article h1",s=we(a,i);return typeof s=="undefined"?y:K(fp(s))})).pipe(g(i=>{let a=new F(s=>{let c=kn(...i);return s.next(c),document.body.append(c),()=>c.remove()});return Rr(e,M({content$:a},t))}))}var Rs=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.flowchartTitleText{fill:var(--md-mermaid-label-fg-color)}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel p,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel p{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color)}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}.classDiagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs marker.marker.composition.class path,defs marker.marker.dependency.class path,defs marker.marker.extension.class path{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs marker.marker.aggregation.class path{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}.statediagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}[id^=entity] path,[id^=entity] rect{fill:var(--md-default-bg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs .marker.oneOrMore.er *,defs .marker.onlyOne.er *,defs .marker.zeroOrMore.er *,defs .marker.zeroOrOne.er *{stroke:var(--md-mermaid-edge-color)!important}text:not([class]):last-child{fill:var(--md-mermaid-label-fg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}.actor-line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}[id$=-arrowhead] path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var $o,vp=0;function bp(){return typeof mermaid=="undefined"||mermaid instanceof Element?wt("https://unpkg.com/mermaid@11/dist/mermaid.min.js"):K(void 0)}function js(e){return e.classList.remove("mermaid"),$o||($o=bp().pipe($(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Rs,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),f(()=>{}),ie(1))),$o.subscribe(()=>Vo(null,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${vp++}`,r=k("div",{class:"mermaid"}),n=e.textContent,{svg:o,fn:i}=yield mermaid.render(t,n),a=r.attachShadow({mode:"closed"});a.innerHTML=o,e.replaceWith(r),i==null||i(a)})),$o.pipe(f(()=>({ref:e})))}var Fs=k("table");function Us(e){return e.replaceWith(Fs),Fs.replaceWith(xs(e)),K({ref:e})}function gp(e){let t=e.find(r=>r.checked)||e[0];return R(...e.map(r=>b(r,"change").pipe(f(()=>Y(`label[for="${r.id}"]`))))).pipe(J(Y(`label[for="${t.id}"]`)),f(r=>({active:r})))}function Ns(e,{viewport$:t,target$:r}){let n=Y(".tabbed-labels",e),o=P(":scope > input",e),i=ko("prev");e.append(i);let a=ko("next");return e.append(a),j(()=>{let s=new I,c=s.pipe(ve(),ye(!0));re([s,Re(e),Tt(e)]).pipe(Q(c),Xe(1,je)).subscribe({next([{active:l},u]){let p=Et(l),{width:d}=Ae(l);e.style.setProperty("--md-indicator-x",`${p.x}px`),e.style.setProperty("--md-indicator-width",`${d}px`);let m=fn(n);(p.xm.x+u.width)&&n.scrollTo({left:Math.max(0,p.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),re([Nt(n),Re(n)]).pipe(Q(c)).subscribe(([l,u])=>{let p=Mr(n);i.hidden=l.x<16,a.hidden=l.x>p.width-u.width-16}),R(b(i,"click").pipe(f(()=>-1)),b(a,"click").pipe(f(()=>1))).pipe(Q(c)).subscribe(l=>{let{width:u}=Ae(n);n.scrollBy({left:u*l,behavior:"smooth"})}),r.pipe(Q(c),L(l=>o.includes(l))).subscribe(l=>l.click()),n.classList.add("tabbed-labels--linked");for(let l of o){let u=Y(`label[for="${l.id}"]`);u.replaceChildren(k("a",{href:`#${u.htmlFor}`,tabIndex:-1},...Array.from(u.childNodes))),b(u.firstElementChild,"click").pipe(Q(c),L(p=>!(p.metaKey||p.ctrlKey)),$(p=>{p.preventDefault(),p.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${u.htmlFor}`),u.click()})}return X("content.tabs.link")&&s.pipe(ke(1),pe(t)).subscribe(([{active:l},{offset:u}])=>{let p=l.innerText.trim();if(l.hasAttribute("data-md-switching"))l.removeAttribute("data-md-switching");else{let d=e.offsetTop-u.y;for(let h of P("[data-tabs]"))for(let v of P(":scope > input",h)){let x=Y(`label[for="${v.id}"]`);if(x!==l&&x.innerText.trim()===p){x.setAttribute("data-md-switching",""),v.click();break}}window.scrollTo({top:e.offsetTop-d});let m=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([p,...m])])}}),s.pipe(Q(c)).subscribe(()=>{for(let l of P("audio, video",e))l.offsetWidth&&l.autoplay?l.play().catch(()=>{}):l.pause()}),gp(o).pipe($(l=>s.next(l)),z(()=>s.complete()),f(l=>M({ref:e},l)))}).pipe($t(_e))}function Ds(e,t){let{viewport$:r,target$:n,print$:o}=t;return R(...P(".annotate:not(.highlight)",e).map(i=>Ss(i,{target$:n,print$:o})),...P("pre:not(.mermaid) > code",e).map(i=>As(i,{target$:n,print$:o})),...P("a",e).map(i=>Is(i,t)),...P("pre.mermaid",e).map(i=>js(i)),...[P(".glightbox",e)].filter(i=>i.length>0).map(i=>Hs(i)),...P("table:not([class])",e).map(i=>Us(i)),...P("details",e).map(i=>Cs(i,{target$:n,print$:o})),...P("[data-tabs]",e).map(i=>Ns(i,{viewport$:r,target$:n})),...P("[title]:not([data-preview])",e).filter(()=>X("content.tooltips")).map(i=>Ye(i,{viewport$:r})),...P(".footnote-ref",e).filter(()=>X("content.footnote.tooltips")).map(i=>Rr(i,{content$:new F(a=>{let s=new URL(i.href).hash.slice(1),c=Array.from(document.getElementById(s).cloneNode(!0).children),l=kn(...c);return a.next(l),document.body.append(l),()=>l.remove()}),viewport$:r})))}function _p(e,{alert$:t}){return t.pipe(g(r=>R(K(!0),K(!1).pipe(Rt(2e3))).pipe(f(n=>({message:r,active:n})))))}function Ws(e,t){let r=Y(".md-typeset",e);return j(()=>{let n=new I;return n.subscribe(({message:o,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=o}),_p(e,t).pipe($(o=>n.next(o)),z(()=>n.complete()),f(o=>M({ref:e},o)))})}function yp({viewport$:e}){if(!X("header.autohide"))return K(!1);let t=e.pipe(f(({offset:{y:o}})=>o),It(2,1),f(([o,i])=>[oMath.abs(i-o.y)>100),f(([,[o]])=>o),ae()),n=Ln("search");return re([e,n]).pipe(f(([{offset:o},i])=>o.y>400&&!i),ae(),g(o=>o?r:K(!1)),J(!1))}function Vs(e,t){return j(()=>re([Re(e),yp(t)])).pipe(f(([{height:r},n])=>({height:r,hidden:n})),ae((r,n)=>r.height===n.height&&r.hidden===n.hidden),ie(1))}function zs(e,{viewport$:t,header$:r,main$:n}){return j(()=>{let o=new I,i=o.pipe(ve(),ye(!0));o.pipe(fe("active"),Ze(r)).subscribe(([{active:s},{hidden:c}])=>{e.classList.toggle("md-header--shadow",s&&!c),e.hidden=c});let a=me(P("[title]",e)).pipe(L(()=>X("content.tooltips")),oe(s=>Ye(s,{viewport$:t})));return n.subscribe(o),r.pipe(Q(i),f(s=>M({ref:e},s)),jt(a.pipe(Q(i))))})}function xp(e,{viewport$:t,header$:r}){return Mn(e,{viewport$:t,header$:r}).pipe(f(({offset:{y:n}})=>{let{height:o}=Ae(e);return{active:o>0&&n>=o}}),fe("active"))}function qs(e,t){return j(()=>{let r=new I;r.subscribe({next({active:o}){e.classList.toggle("md-header__title--active",o)},complete(){e.classList.remove("md-header__title--active")}});let n=we(".md-content h1");return typeof n=="undefined"?y:xp(n,t).pipe($(o=>r.next(o)),z(()=>r.complete()),f(o=>M({ref:e},o)))})}function Ks(e,{viewport$:t,header$:r}){let n=r.pipe(f(({height:i})=>i),ae()),o=n.pipe(g(()=>Re(e).pipe(f(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),fe("bottom"))));return re([n,o,t]).pipe(f(([i,{top:a,bottom:s},{offset:{y:c},size:{height:l}}])=>(l=Math.max(0,l-Math.max(0,a-c,i)-Math.max(0,l+c-s)),{offset:a-i,height:l,active:a-i<=c})),ae((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function wp(e){let t=__md_get("__palette")||{index:e.findIndex(n=>matchMedia(n.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return K(...e).pipe(oe(n=>b(n,"change").pipe(f(()=>n))),J(e[r]),f(n=>({index:e.indexOf(n),color:{media:n.getAttribute("data-md-color-media"),scheme:n.getAttribute("data-md-color-scheme"),primary:n.getAttribute("data-md-color-primary"),accent:n.getAttribute("data-md-color-accent")}})),ie(1))}function Bs(e){let t=P("input",e),r=k("meta",{name:"theme-color"});document.head.appendChild(r);let n=k("meta",{name:"color-scheme"});document.head.appendChild(n);let o=Ir("(prefers-color-scheme: light)");return j(()=>{let i=new I;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),c=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=c.getAttribute("data-md-color-scheme"),a.color.primary=c.getAttribute("data-md-color-primary"),a.color.accent=c.getAttribute("data-md-color-accent")}for(let[s,c]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,c);for(let s=0;sa.key==="Enter"),pe(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(f(()=>{let a=bt("header"),s=window.getComputedStyle(a);return n.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(c=>(+c).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(Ie(_e)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),wp(t).pipe(Q(o.pipe(ke(1))),Ft(),$(a=>i.next(a)),z(()=>i.complete()),f(a=>M({ref:e},a)))})}function Gs(e,{progress$:t}){return j(()=>{let r=new I;return r.subscribe(({value:n})=>{e.style.setProperty("--md-progress-value",`${n}`)}),t.pipe($(n=>r.next({value:n})),z(()=>r.complete()),f(n=>({ref:e,value:n})))})}var Ys='.v u{text-decoration:underline!important;text-decoration-style:wavy!important;text-decoration-thickness:1px!important}.p{-webkit-backdrop-filter:blur(8px);backdrop-filter:blur(8px);background-color:rgba(var(--color-backdrop)/var(--alpha-lighter));cursor:pointer;height:100%;pointer-events:auto;position:absolute;transition:opacity .25s;width:100%}.p.m{opacity:0;pointer-events:none;transition:opacity .35s}.r{align-items:center;background-color:initial;border:none;border-radius:var(--space-2);cursor:pointer;display:flex;flex-shrink:0;font-family:var(--font-family);height:36px;justify-content:center;outline:none;padding:0;position:relative;transition:background-color .25s,color .25s;width:36px;z-index:1}.r svg{stroke:rgb(var(--color-foreground));height:18px;opacity:.5;width:18px}.r:before{background-color:rgb(var(--color-background-subtle));border-radius:var(--border-radius-2);content:"";inset:0;opacity:0;position:absolute;transform:scale(.75);transition:transform 125ms,opacity 125ms;z-index:0}.r:hover:before{opacity:1;transform:scale(1)}.r.c{cursor:auto}.r.c:before{display:none}.n{-webkit-backdrop-filter:blur(8px);backdrop-filter:blur(8px);background-color:rgba(var(--color-background)/var(--alpha-light));border-radius:var(--space-3);box-shadow:0 0 60px #0000000d;display:flex;height:480px;overflow:hidden;pointer-events:auto;position:absolute;transition:transform .25s cubic-bezier(.16,1,.3,1),opacity .25s;width:640px}.n.l{opacity:0;pointer-events:none;transform:scale(1.1);transition:transform .25s .15s,opacity .15s}@media (max-width:680px){.n{border-radius:0;height:100%;width:100%}}.u{display:flex;flex-basis:min-content;flex-direction:column;flex-grow:1;flex-shrink:0}@keyframes d{0%{transform:scale(0)}50%{transform:scale(1.2)}to{transform:scale(1)}}.y{animation:d .25s ease-in-out;background:var(--color-highlight);border-radius:100%;color:#fff;font-size:8px;font-weight:700;height:12px;padding-top:1px;position:absolute;right:4px;top:4px;width:12px}.i{background-color:rgb(var(--color-background-subtle)/var(--alpha-lighter));flex-shrink:0;overflow:scroll;position:relative;transition:width .35s cubic-bezier(.16,1,.3,1),opacity .25s;width:200px}.i>*{transform:translate(0);transition:transform .25s cubic-bezier(.16,1,.3,1)}.i.l{opacity:0;width:0}.i.l>*{transform:translate(-48px)}@media (max-width:680px){.i{-webkit-backdrop-filter:blur(8px);backdrop-filter:blur(8px);background-color:rgba(var(--color-background-subtle)/var(--alpha-light));box-shadow:0 0 60px #00000026;height:100%;position:absolute;right:0;top:0}}.w{border-bottom:1px solid rgb(var(--color-foreground)/var(--alpha-lightest));display:flex;gap:var(--space-1);padding:var(--space-2)}.k{-webkit-overflow-scrolling:touch;overflow:auto;overscroll-behavior:contain}.z{padding:8px 10px}.X{color:rgb(var(--color-foreground)/var(--alpha-light));padding:var(--space-2);position:absolute;width:200px}.X,.j{display:flex;flex-direction:column}.j{gap:2px;list-style:none;padding:0}.F,.j{margin:0}.F{font-size:16px;font-weight:400}.F,.I{padding:8px}.I{font-size:14px;margin:4px 0 0;opacity:.5}.I,.o{font-size:12px}.o{cursor:pointer;display:flex;padding:4px 8px;position:relative}.o:before{background-color:var(--color-highlight-transparent);border-radius:var(--space-1);content:"";inset:0;opacity:0;position:absolute;transform:scale(.75);transition:transform 125ms,opacity 125ms;z-index:0}.o.g:before,.o:hover:before{opacity:1;transform:scale(1)}.o.g,.o:hover{color:var(--color-highlight)}.R{flex-grow:1}.R,.q{position:relative}.q{font-weight:700}.f{flex-grow:1}.f input{background:#0000;border:none;color:rgb(var(--color-foreground));font-family:var(--font-family);font-size:16px;height:100%;letter-spacing:-.25px;outline:none;width:100%}.b{color:rgb(var(--color-foreground)/var(--alpha-light));display:flex;flex-direction:column;gap:2px;line-height:1.3;list-style:none;margin:var(--space-2);margin-top:0;padding:0}.A,.b li{margin:0}.A{color:rgb(var(--color-foreground)/var(--alpha-lighter));font-size:12px;margin-top:var(--space-2);padding:0 18px}.a{border-radius:var(--space-2);color:inherit;cursor:pointer;display:flex;flex-direction:row;flex-grow:1;padding:8px 10px;position:relative;text-decoration:none}.a:before{background-color:rgb(var(--color-background-subtle));border-radius:var(--border-radius-2);content:"";display:block;inset:0;opacity:0;position:absolute;transform:scale(.9);transition:transform 125ms,opacity 125ms;z-index:0}@media (pointer:fine){.a.h:before,.a:hover:before{opacity:1;transform:scale(1)}}.a mark{background:#0000;color:var(--color-highlight)}.a u{background-color:var(--color-highlight-transparent);border-radius:2px;box-shadow:0 0 0 1px var(--color-highlight-transparent);text-decoration:none}.B{flex-grow:1}.s{margin-right:-8px;opacity:0;position:relative;transform:translate(-2px);transition:transform 125ms,opacity 125ms;z-index:0}@media (pointer:fine){.h>.s,:hover>.s{opacity:1;transform:none}}.x{font-size:14px;margin:0;position:relative}.x code{background:rgb(var(--color-background-subtle));border-radius:var(--space-1);font-size:13px;padding:2px 4px}.t{color:rgb(var(--color-foreground)/var(--alpha-lighter));display:inline-flex;flex-wrap:wrap;font-size:12px;gap:var(--space-1);list-style:none;margin:0;padding:0;position:relative}.t li{white-space:nowrap}.t li:after{content:"/";display:inline;margin-left:var(--space-1)}.t li:last-child:after{content:"";display:none}.e{--space-1:4px;--space-2:calc(var(--space-1)*2);--space-3:calc(var(--space-2)*2);--space-4:calc(var(--space-3)*2);--space-5:calc(var(--space-4)*2);--alpha-light:.7;--alpha-lighter:.54;--alpha-lightest:.1;--color-highlight:var(--md-accent-fg-color,#526cfe);--color-highlight-transparent:var(--md-accent-fg-color--transparent,#526cfe1a);--border-radius-1:var(--space-1);--border-radius-2:var(--space-2);--border-radius-3:calc(var(--space-1) + var(--space-2));--font-family:var(--md-text-font-family,Inter,Roboto Flex,system-ui,sans-serif);--font-size:16px;--line-height:1.5;--letter-spacing:-.5px;-webkit-font-smoothing:antialiased;align-items:center;display:flex;font-family:var(--font-family);font-size:var(--font-size);height:100vh;justify-content:center;letter-spacing:var(--letter-spacing);line-height:var(--line-height);pointer-events:none;position:absolute;width:100vw}@media (pointer:coarse){.e{height:-webkit-fill-available}}.e *,.e :after,.e :before{box-sizing:border-box}';function Js(e,{index$:t}){let r=Ue(),n=document.createElement("div");document.body.appendChild(n),n.style.position="fixed",n.style.height="100%",n.style.top="0",n.style.zIndex="4";let o=n.attachShadow({mode:"open"});o.appendChild(k("style",{},Ys.toString()));try{Xa(r.search,{highlight:r.features.includes("search.highlight")}),me(t).subscribe(i=>{for(let a of i.items)a.location=new URL(`./${a.location}`,r.base).toString();Qa(i,o)}),b(e,"click").subscribe(()=>{xo()}),Ln("search").pipe(ke(1)).subscribe(()=>xo())}catch(i){e.hidden=!0;let a=Y("label[for=__search]");a.hidden=!0}return Ke}var Xs=_r(Mo());function Zs(e,{index$:t,location$:r}){return re([t,r.pipe(J(Ge()),L(n=>!!n.searchParams.get("h")))]).pipe(f(([n,o])=>Tp(n.config)(o.searchParams.get("h"))),f(n=>{var a;let o=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let c=s.textContent,l=n(c);l.length>c.length&&o.set(s,l)}for(let[s,c]of o){let{childNodes:l}=k("span",null,c);s.replaceWith(...Array.from(l))}return{ref:e,nodes:o}}))}function Tp(e){let t=e.separator.split("|").map(o=>o.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":o).join("|"),r=new RegExp(t,"img"),n=(o,i,a)=>`${i}${a}`;return o=>{o=o.replace(/\s+/g," ").replace(/&/g,"&").trim();let i=new RegExp(`(^|${e.separator}|)(${o.split(r).map(a=>a.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&")).filter(a=>a.length>0).join("|")})`,"img");return a=>(0,Xs.default)(a).replace(i,n).replace(/<\/mark>(\s+)]*>/img,"$1")}}function Op(e,{viewport$:t,main$:r}){let n=e.closest(".md-grid"),o=n.offsetTop-n.parentElement.offsetTop;return re([r,t]).pipe(f(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(o,Math.max(0,s-i))-o,{height:a,locked:s>=i+o})),ae((i,a)=>i.height===a.height&&i.locked===a.locked))}function Po(e,n){var o=n,{header$:t}=o,r=gr(o,["header$"]);let i=Y(".md-sidebar__scrollwrap",e),{y:a}=Et(i);return j(()=>{let s=new I,c=s.pipe(ve(),ye(!0)),l=s.pipe(Xe(0,je));return l.pipe(pe(t)).subscribe({next([{height:u},{height:p}]){i.style.height=`${u-2*a}px`,e.style.top=`${p}px`},complete(){i.style.height="",e.style.top=""}}),l.pipe(Or()).subscribe(()=>{for(let u of P(".md-nav__link--active[href]",e)){if(!u.clientHeight)continue;let p=u.closest(".md-sidebar__scrollwrap");if(typeof p!="undefined"){let d=u.offsetTop-p.offsetTop,{height:m}=Ae(p);p.scrollTo({top:d-m/2})}}}),me(P("label[tabindex]",e)).pipe(oe(u=>b(u,"click").pipe(Ie(_e),f(()=>u),Q(c)))).subscribe(u=>{let p=Y(`[id="${u.htmlFor}"]`);Y(`[aria-labelledby="${u.id}"]`).setAttribute("aria-expanded",`${p.checked}`)}),X("content.tooltips")&&me(P("abbr[title]",e)).pipe(oe(u=>Ye(u,{viewport$})),Q(c)).subscribe(),Op(e,r).pipe($(u=>s.next(u)),z(()=>s.complete()),f(u=>M({ref:e},u)))})}function Qs(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return Pt(et(`${r}/releases/latest`).pipe(he(()=>y),f(n=>({version:n.tag_name})),at({})),et(r).pipe(he(()=>y),f(n=>({stars:n.stargazers_count,forks:n.forks_count})),at({}))).pipe(f(([n,o])=>M(M({},n),o)))}else{let r=`https://api.github.com/users/${e}`;return et(r).pipe(f(n=>({repositories:n.public_repos})),at({}))}}function ec(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return Pt(et(`${r}/releases/permalink/latest`).pipe(he(()=>y),f(({tag_name:n})=>({version:n})),at({})),et(r).pipe(he(()=>y),f(({star_count:n,forks_count:o})=>({stars:n,forks:o})),at({}))).pipe(f(([n,o])=>M(M({},n),o)))}function tc(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,n]=t;return Qs(r,n)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,n]=t;return ec(r,n)}return y}var Sp;function Lp(e){return Sp||(Sp=j(()=>{let t=__md_get("__source",sessionStorage);if(t)return K(t);if(Te("consent").length){let n=__md_get("__consent");if(!(n&&n.github))return y}return tc(e.href).pipe($(n=>__md_set("__source",n,sessionStorage)))}).pipe(he(()=>y),L(t=>Object.keys(t).length>0),f(t=>({facts:t})),ie(1)))}function rc(e){let t=Y(":scope > :last-child",e);return j(()=>{let r=new I;return r.subscribe(({facts:n})=>{t.appendChild(ys(n)),t.classList.add("md-source__repository--active")}),Lp(e).pipe($(n=>r.next(n)),z(()=>r.complete()),f(n=>M({ref:e},n)))})}function Mp(e,{viewport$:t,header$:r}){return Re(document.body).pipe(g(()=>Mn(e,{header$:r,viewport$:t})),f(({offset:{y:n}})=>({hidden:n>=10})),fe("hidden"))}function nc(e,t){return j(()=>{let r=new I;return r.subscribe({next({hidden:n}){e.hidden=n},complete(){e.hidden=!1}}),(X("navigation.tabs.sticky")?K({hidden:!1}):Mp(e,t)).pipe($(n=>r.next(n)),z(()=>r.complete()),f(n=>M({ref:e},n)))})}function kp(e,{viewport$:t,header$:r}){let n=new Map,o=P(".md-nav__link",e);for(let s of o){let c=decodeURIComponent(s.hash.substring(1)),l=we(`[id="${c}"]`);typeof l!="undefined"&&n.set(s,l)}let i=r.pipe(fe("height"),f(({height:s})=>{let c=bt("main"),l=Y(":scope > :first-child",c);return s+.9*(l.offsetTop-c.offsetTop)}),xe());return Re(document.body).pipe(fe("height"),g(s=>j(()=>{let c=[];return K([...n].reduce((l,[u,p])=>{for(;c.length&&n.get(c[c.length-1]).tagName>=p.tagName;)c.pop();let d=p.offsetTop;for(;!d&&p.parentElement;)p=p.parentElement,d=p.offsetTop;let m=p.offsetParent;for(;m;m=m.offsetParent)d+=m.offsetTop;return l.set([...c=[...c,u]].reverse(),d)},new Map))}).pipe(f(c=>new Map([...c].sort(([,l],[,u])=>l-u))),Ze(i),g(([c,l])=>t.pipe(Sr(([u,p],{offset:{y:d},size:m})=>{let h=d+m.height>=Math.floor(s.height);for(;p.length;){let[,v]=p[0];if(v-l=d&&!h)p=[u.pop(),...p];else break}return[u,p]},[[],[...c]]),ae((u,p)=>u[0]===p[0]&&u[1]===p[1])))))).pipe(f(([s,c])=>({prev:s.map(([l])=>l),next:c.map(([l])=>l)})),J({prev:[],next:[]}),It(2,1),f(([s,c])=>s.prev.length{let i=new I,a=i.pipe(ve(),ye(!0));i.subscribe(({prev:c,next:l})=>{for(let[u]of l)u.classList.remove("md-nav__link--passed"),u.classList.remove("md-nav__link--active");for(let[u,[p]]of c.entries())p.classList.add("md-nav__link--passed"),p.classList.toggle("md-nav__link--active",u===c.length-1)});let s=we(".md-sidebar--secondary");if(typeof s!="undefined"&&b(document.body,"click").subscribe(c=>{let l=c.target;if(!s.contains(l)){let u=we(".md-nav__toggle",s);typeof u!="undefined"&&(u.checked=!1)}}),X("toc.follow")){let c=R(t.pipe(Be(1),f(()=>{})),t.pipe(Be(250),f(()=>"smooth")));i.pipe(L(({prev:l})=>l.length>0),Ze(n.pipe(Ie(_e))),pe(c)).subscribe(([[{prev:l}],u])=>{let[p]=l[l.length-1];if(p.offsetHeight){let d=Hi(p);if(typeof d!="undefined"){let m=p.offsetTop-d.offsetTop,{height:h}=Ae(d);d.scrollTo({top:m-h/2,behavior:u})}}})}return X("navigation.tracking")&&t.pipe(Q(a),fe("offset"),Be(250),ke(1),Q(o.pipe(ke(1))),Ft({delay:250}),pe(i)).subscribe(([,{prev:c}])=>{let l=Ge(),u=c[c.length-1];if(u&&u.length){let[p]=u,{hash:d}=new URL(p.href);l.hash!==d&&(l.hash=d,history.replaceState({},"",`${l}`))}else l.hash="",history.replaceState({},"",`${l}`)}),kp(e,{viewport$:t,header$:r}).pipe($(c=>i.next(c)),z(()=>i.complete()),f(c=>M({ref:e},c)))})}function Ap(e,{viewport$:t,main$:r,target$:n}){let o=t.pipe(f(({offset:{y:a}})=>a),It(2,1),f(([a,s])=>a>s&&s>0),ae()),i=r.pipe(f(({active:a})=>a));return re([i,o]).pipe(f(([a,s])=>!(a&&s)),ae(),Q(n.pipe(ke(1))),ye(!0),Ft({delay:250}),f(a=>({hidden:a})))}function ic(e,{viewport$:t,header$:r,main$:n,target$:o}){let i=new I,a=i.pipe(ve(),ye(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(Q(a),fe("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),b(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),Ap(e,{viewport$:t,main$:n,target$:o}).pipe($(s=>i.next(s)),z(()=>i.complete()),f(s=>M({ref:e},s)))}function ac(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,t.port&&(e.port=t.port),e}function Cp(e,t){let r=new Map;for(let n of P("url",e)){let o=Y("loc",n),i=[ac(new URL(o.textContent),t)];r.set(`${i[0]}`,i);for(let a of P("[rel=alternate]",n)){let s=a.getAttribute("href");s!=null&&i.push(ac(new URL(s),t))}}return r}function dr(e){return as(new URL("sitemap.xml",e)).pipe(f(t=>Cp(t,new URL(e))),he(()=>K(new Map)),xe())}function sc({document$:e}){let t=new Map;e.pipe(g(()=>P("link[rel=alternate]")),f(r=>new URL(r.href)),L(r=>!t.has(r.toString())),oe(r=>dr(r).pipe(f(n=>[r,n]),he(()=>y)))).subscribe(([r,n])=>{t.set(r.toString().replace(/\/$/,""),n)}),b(document.body,"click").pipe(L(r=>!r.metaKey&&!r.ctrlKey),g(r=>{if(r.target instanceof Element){let n=r.target.closest("a");if(n&&!n.target){let o=[...t].find(([p])=>n.href.startsWith(`${p}/`));if(typeof o=="undefined")return y;let[i,a]=o,s=Ge();if(s.href.startsWith(i))return y;let c=Ue(),l=s.href.replace(c.base,"");l=`${i}/${l}`;let u=a.has(l.split("#")[0])?new URL(l,c.base):new URL(i);return r.preventDefault(),K(u)}}return y})).subscribe(r=>vt(r,!0))}var Io=_r(Co());function Hp(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function cc({alert$:e}){Io.default.isSupported()&&new F(t=>{new Io.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||Hp(Y(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe($(t=>{t.trigger.focus()}),f(()=>Gt("clipboard.copied"))).subscribe(e)}function lc(e,t){if(!(e.target instanceof Element))return y;let r=e.target.closest("a");if(r===null)return y;if(r.target||e.metaKey||e.ctrlKey)return y;let n=new URL(r.href);return n.search=n.hash="",t.has(`${n}`)?(e.preventDefault(),K(r)):y}function uc(e){let t=new Map;for(let r of P(":scope > *",e.head))t.set(r.outerHTML,r);return t}function pc(e){for(let t of P("[href], [src]",e))for(let r of["href","src"]){let n=t.getAttribute(r);if(n&&!/^(?:[a-z]+:)?\/\//i.test(n)){t[r]=t[r];break}}return K(e)}function $p(e){for(let n of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...X("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let o=we(n),i=we(n,e);typeof o!="undefined"&&typeof i!="undefined"&&o.replaceWith(i)}let t=uc(document);for(let[n,o]of uc(e))t.has(n)?t.delete(n):document.head.appendChild(o);for(let n of t.values()){let o=n.getAttribute("name");o!=="theme-color"&&o!=="color-scheme"&&n.remove()}let r=bt("container");return it(P("script",r)).pipe(g(n=>{let o=e.createElement("script");if(n.src){for(let i of n.getAttributeNames())o.setAttribute(i,n.getAttribute(i));return n.replaceWith(o),new F(i=>{o.onload=()=>i.complete()})}else return o.textContent=n.textContent,n.replaceWith(o),y}),ve(),ye(document))}function fc({sitemap$:e,location$:t,viewport$:r,progress$:n}){if(location.protocol==="file:")return Ke;K(document).subscribe(pc);let o=b(document.body,"click").pipe(Ze(e),g(([s,c])=>lc(s,c)),f(({href:s})=>new URL(s)),xe()),i=b(window,"popstate").pipe(f(Ge),xe());o.pipe(pe(r)).subscribe(([s,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",s)}),R(o,i).subscribe(t);let a=t.pipe(fe("pathname"),g(s=>Sn(s,{progress$:n}).pipe(he(()=>(vt(s,!0),y)))),g(pc),g($p),xe());return R(a.pipe(pe(t,(s,c)=>c)),a.pipe(g(()=>t),fe("hash")),t.pipe(ae((s,c)=>s.pathname===c.pathname&&s.hash===c.hash),g(()=>o),$(()=>history.back()))).subscribe(s=>{var c,l;history.state!==null||!s.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",ns(s.hash),history.scrollRestoration="manual")}),t.subscribe(()=>{history.scrollRestoration="manual"}),b(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),r.pipe(fe("offset"),Be(100)).subscribe(({offset:s})=>{history.replaceState(s,"")}),X("navigation.instant.prefetch")&&R(b(document.body,"mousemove"),b(document.body,"focusin")).pipe(Ze(e),g(([s,c])=>lc(s,c)),Be(25),Xn(({href:s})=>s),pn(s=>{let c=document.createElement("link");return c.rel="prefetch",c.href=s.toString(),document.head.appendChild(c),b(c,"load").pipe(f(()=>c),Me(1))})).subscribe(s=>s.remove()),a}function mc(e){var u;let{selectedVersionSitemap:t,selectedVersionBaseURL:r,currentLocation:n,currentBaseURL:o}=e,i=(u=Ro(o))==null?void 0:u.pathname;if(i===void 0)return;let a=Pp(n.pathname,i);if(a===void 0)return;let s=Rp(t.keys());if(!t.has(s))return;let c=Ro(a,s);if(!c||!t.has(c.href))return;let l=Ro(a,r);if(l)return l.hash=n.hash,l.search=n.search,l}function Ro(e,t){try{return new URL(e,t)}catch(r){return}}function Pp(e,t){if(e.startsWith(t))return e.slice(t.length)}function Ip(e,t){let r=Math.min(e.length,t.length),n;for(n=0;ny)),n=r.pipe(f(o=>{let[,i]=t.base.match(/([^/]+)\/?$/);return o.find(({version:a,aliases:s})=>a===i||s.includes(i))||o[0]}));r.pipe(f(o=>new Map(o.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),g(o=>b(document.body,"click").pipe(L(i=>!i.metaKey&&!i.ctrlKey),pe(n),g(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&o.has(s.href)){let c=s.href;return!i.target.closest(".md-version")&&o.get(c)===a?y:(i.preventDefault(),K(new URL(c)))}}return y}),g(i=>dr(i).pipe(f(a=>{var s;return(s=mc({selectedVersionSitemap:a,selectedVersionBaseURL:i,currentLocation:Ge(),currentBaseURL:t.base}))!=null?s:i})))))).subscribe(o=>vt(o,!0)),re([r,n]).subscribe(([o,i])=>{Y(".md-header__topic").appendChild(ws(o,i))}),e.pipe(g(()=>n)).subscribe(o=>{var s;let i=new URL(t.base),a=__md_get("__outdated",sessionStorage,i);if(a===null){a=!0;let c=((s=t.version)==null?void 0:s.default)||"latest";Array.isArray(c)||(c=[c]);e:for(let l of c)for(let u of o.aliases.concat(o.version))if(new RegExp(l,"i").test(u)){a=!1;break e}__md_set("__outdated",a,sessionStorage,i)}if(a)for(let c of Te("outdated"))c.hidden=!1})}function hc({document$:e,viewport$:t}){e.pipe(g(()=>P(".md-ellipsis")),oe(r=>Tt(r).pipe(Q(e.pipe(ke(1))),L(n=>n),f(()=>r),Me(1))),L(r=>r.offsetWidth{let n=r.innerText,o=r.closest("a")||r;return o.title=n,X("content.tooltips")?Ye(o,{viewport$:t}).pipe(Q(e.pipe(ke(1))),z(()=>o.removeAttribute("title"))):y})).subscribe(),X("content.tooltips")&&e.pipe(g(()=>P(".md-status")),oe(r=>Ye(r,{viewport$:t}))).subscribe()}function vc({document$:e,tablet$:t}){e.pipe(g(()=>P(".md-toggle--indeterminate")),$(r=>{r.indeterminate=!0,r.checked=!1}),oe(r=>b(r,"change").pipe(eo(()=>r.classList.contains("md-toggle--indeterminate")),f(()=>r))),pe(t)).subscribe(([r,n])=>{r.classList.remove("md-toggle--indeterminate"),n&&(r.checked=!1)})}function jp(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function bc({document$:e}){e.pipe(g(()=>P("[data-md-scrollfix]")),$(t=>t.removeAttribute("data-md-scrollfix")),L(jp),oe(t=>b(t,"touchstart").pipe(f(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let n=e[r];typeof n=="string"?n=document.createTextNode(n):n.parentNode&&n.parentNode.removeChild(n),r?t.insertBefore(this.previousSibling,n):t.replaceChild(n,this)}}}));function Fp(){return location.protocol==="file:"?wt(`${new URL("search.js",Cn.base)}`).pipe(f(()=>__index),he(()=>Ke),ie(1)):et(new URL("search.json",Cn.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var gt=Li(),Ur=ts(),hr=os(Ur),_c=es(),ze=ps(),jo=Ir("(min-width: 60em)"),yc=Ir("(min-width: 76.25em)"),xc=is(),Cn=Ue(),wc=we(".md-search")?Fp():Ke,Fo=new I;cc({alert$:Fo});sc({document$:gt});var Uo=new I,Ec=dr(Cn.base);X("navigation.instant")&&fc({sitemap$:Ec,location$:Ur,viewport$:ze,progress$:Uo}).subscribe(gt);var gc;((gc=Cn.version)==null?void 0:gc.provider)==="mike"&&dc({document$:gt});R(Ur,hr).pipe(Rt(125)).subscribe(()=>{So("drawer",!1),So("search",!1)});_c.pipe(L(({mode:e,meta:t})=>e==="global"&&!t)).subscribe(e=>{switch(e.type){case",":case"p":let t=document.querySelector("link[rel=prev]");t instanceof HTMLLinkElement&&vt(t);break;case".":case"n":let r=document.querySelector("link[rel=next]");r instanceof HTMLLinkElement&&vt(r);break;case"/":let n=document.querySelector("[data-md-component=search] button");n instanceof HTMLButtonElement&&n.click();break;case"Enter":let o=xt();o instanceof HTMLLabelElement&&o.click()}});hc({viewport$:ze,document$:gt});vc({document$:gt,tablet$:jo});bc({document$:gt});var Mt=Vs(bt("header"),{viewport$:ze}),Fr=gt.pipe(f(()=>bt("main")),g(e=>Ks(e,{viewport$:ze,header$:Mt})),ie(1)),Up=R(...Te("consent").map(e=>ms(e,{target$:hr})),...Te("dialog").map(e=>Ws(e,{alert$:Fo})),...Te("palette").map(e=>Bs(e)),...Te("progress").map(e=>Gs(e,{progress$:Uo})),...Te("search").map(e=>Js(e,{index$:wc})),...Te("source").map(e=>rc(e))),Np=j(()=>R(...Te("announce").map(e=>fs(e)),...Te("content").map(e=>Ds(e,{sitemap$:Ec,viewport$:ze,target$:hr,print$:xc})),...Te("content").map(e=>X("search.highlight")?Zs(e,{index$:wc,location$:Ur}):y),...Te("header").map(e=>zs(e,{viewport$:ze,header$:Mt,main$:Fr})),...Te("header-title").map(e=>qs(e,{viewport$:ze,header$:Mt})),...Te("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Eo(yc,()=>Po(e,{viewport$:ze,header$:Mt,main$:Fr})):Eo(jo,()=>Po(e,{viewport$:ze,header$:Mt,main$:Fr}))),...Te("tabs").map(e=>nc(e,{viewport$:ze,header$:Mt})),...Te("toc").map(e=>oc(e,{viewport$:ze,header$:Mt,main$:Fr,target$:hr})),...Te("top").map(e=>ic(e,{viewport$:ze,header$:Mt,main$:Fr,target$:hr})))),Tc=gt.pipe(g(()=>Np),jt(Up),ie(1));Tc.subscribe();window.document$=gt;window.location$=Ur;window.target$=hr;window.keyboard$=_c;window.viewport$=ze;window.tablet$=jo;window.screen$=yc;window.print$=xc;window.alert$=Fo;window.progress$=Uo;window.component$=Tc;})(); diff --git a/v4.1/examples/pagination-search/index.html b/v4.1/examples/pagination-search/index.html index e62a273..fcc224a 100644 --- a/v4.1/examples/pagination-search/index.html +++ b/v4.1/examples/pagination-search/index.html @@ -25,7 +25,7 @@ - + @@ -2331,7 +2331,7 @@ - + diff --git a/v4.1/index.html b/v4.1/index.html index c94b7ed..324430c 100644 --- a/v4.1/index.html +++ b/v4.1/index.html @@ -23,7 +23,7 @@ - + @@ -1941,7 +1941,7 @@ - + diff --git a/v4.1/migration/v2/index.html b/v4.1/migration/v2/index.html index 45e9ae8..bfe1315 100644 --- a/v4.1/migration/v2/index.html +++ b/v4.1/migration/v2/index.html @@ -25,7 +25,7 @@ - + @@ -2168,7 +2168,7 @@ - + diff --git a/v4.1/migration/v3/index.html b/v4.1/migration/v3/index.html index cd0548b..71ba2bf 100644 --- a/v4.1/migration/v3/index.html +++ b/v4.1/migration/v3/index.html @@ -25,7 +25,7 @@ - + @@ -2156,7 +2156,7 @@ - + diff --git a/v4.1/migration/v4/index.html b/v4.1/migration/v4/index.html index 2bd00a0..4835829 100644 --- a/v4.1/migration/v4/index.html +++ b/v4.1/migration/v4/index.html @@ -25,7 +25,7 @@ - + @@ -1914,7 +1914,7 @@ The function creates and manages its own dedicated session inte - + diff --git a/v4.1/module/cli/index.html b/v4.1/module/cli/index.html index f467bb1..5a8d689 100644 --- a/v4.1/module/cli/index.html +++ b/v4.1/module/cli/index.html @@ -25,7 +25,7 @@ - + @@ -2026,7 +2026,7 @@ - + diff --git a/v4.1/module/crud/index.html b/v4.1/module/crud/index.html index 9af7ade..9c12992 100644 --- a/v4.1/module/crud/index.html +++ b/v4.1/module/crud/index.html @@ -25,7 +25,7 @@ - + @@ -3091,7 +3091,7 @@ - + diff --git a/v4.1/module/db/index.html b/v4.1/module/db/index.html index 7d218fa..a67cb1d 100644 --- a/v4.1/module/db/index.html +++ b/v4.1/module/db/index.html @@ -25,7 +25,7 @@ - + @@ -2084,30 +2084,34 @@ ...

Available lock modes are defined in LockMode: ACCESS_SHARE, ROW_SHARE, ROW_EXCLUSIVE, SHARE_UPDATE_EXCLUSIVE, SHARE, SHARE_ROW_EXCLUSIVE, EXCLUSIVE, ACCESS_EXCLUSIVE.

+

Pass timeout to limit how long the lock waits before giving up. On timeout, a LockTimeoutError is raised instead of a raw database error:

+
async with lock_tables(session_maker, [Order], timeout="2s") as session:
+    ...
+

Advisory locking

advisory_lock acquires a PostgreSQL session-level advisory lock. The lock is released explicitly when the context exits, regardless of whether the transaction has committed.

-
from fastapi_toolsets.db import advisory_lock
-
-# Blocking exclusive lock — waits until the lock is free
-async with advisory_lock(session=session, key=42):
-    ...
-
-# Non-blocking — yields False immediately if already held
-async with advisory_lock(session=session, key=42, nowait=True) as acquired:
-    if not acquired:
-        raise HTTPException(409, "Resource is locked")
-
-# Blocking with a timeout — raises DBAPIError if not acquired in time
-async with advisory_lock(session=session, key=42, timeout="5s"):
-    ...
-
-# Shared — multiple readers allowed simultaneously, blocks exclusive writers
-async with advisory_lock(session=session, key=42, shared=True):
-    ...
-
-# Two-integer key for namespacing (e.g. lock_type + resource_id)
-async with advisory_lock(session=session, key=(1, user_id)):
-    ...
+
from fastapi_toolsets.db import advisory_lock
+
+# Blocking exclusive lock — waits until the lock is free
+async with advisory_lock(session=session, key=42):
+    ...
+
+# Non-blocking — yields False immediately if already held
+async with advisory_lock(session=session, key=42, nowait=True) as acquired:
+    if not acquired:
+        raise HTTPException(409, "Resource is locked")
+
+# Blocking with a timeout — raises LockTimeoutError if not acquired in time
+async with advisory_lock(session=session, key=42, timeout="5s"):
+    ...
+
+# Shared — multiple readers allowed simultaneously, blocks exclusive writers
+async with advisory_lock(session=session, key=42, shared=True):
+    ...
+
+# Two-integer key for namespacing (e.g. lock_type + resource_id)
+async with advisory_lock(session=session, key=(1, user_id)):
+    ...
 

 

 
Note

@@ -2115,28 +2119,28 @@
 

 
Row-change polling

 
wait_for_row_change polls a row until a specific column changes value, useful for waiting on async side effects:

-
from fastapi_toolsets.db import wait_for_row_change
-
-# Wait up to 30s for order.status to change
-await wait_for_row_change(
-    session=session,
-    model=Order,
-    pk_value=order_id,
-    columns=[Order.status],
-    interval=1.0,
-    timeout=30.0,
-)
+
from fastapi_toolsets.db import wait_for_row_change
+
+# Wait up to 30s for order.status to change
+await wait_for_row_change(
+    session=session,
+    model=Order,
+    pk_value=order_id,
+    columns=[Order.status],
+    interval=1.0,
+    timeout=30.0,
+)
 

 
Creating a database

 

 
Added in v2.1

 

 
create_database creates a database at a given URL. It connects to server_url and issues a CREATE DATABASE statement:

-
from fastapi_toolsets.db import create_database
-
-SERVER_URL = "postgresql+asyncpg://postgres:postgres@localhost/postgres"
-
-await create_database(db_name="myapp_test", server_url=SERVER_URL)
+
from fastapi_toolsets.db import create_database
+
+SERVER_URL = "postgresql+asyncpg://postgres:postgres@localhost/postgres"
+
+await create_database(db_name="myapp_test", server_url=SERVER_URL)
 

 
For test isolation with automatic cleanup, use create_worker_database from the pytest module instead — it handles drop-before, create, and drop-after automatically.

 
Cleaning up tables

@@ -2144,44 +2148,44 @@
 
Added in v2.1

 

 
cleanup_tables truncates all tables:

-
from fastapi_toolsets.db import cleanup_tables
-
-@pytest.fixture(autouse=True)
-async def clean(db_session):
-    yield
-    await cleanup_tables(session=db_session, base=Base)
+
from fastapi_toolsets.db import cleanup_tables
+
+@pytest.fixture(autouse=True)
+async def clean(db_session):
+    yield
+    await cleanup_tables(session=db_session, base=Base)
 

 
Many-to-Many helpers

 
SQLAlchemy's ORM collection API triggers lazy-loads when you append to a relationship inside a savepoint (e.g. inside lock_tables or a nested get_transaction). The three m2m_* helpers bypass the ORM collection entirely and issue direct SQL against the association table.

 
m2m_add — insert associations

 
m2m_add inserts one or more rows into a secondary table without touching the ORM collection:

-
from fastapi_toolsets.db import lock_tables, m2m_add
-
-async with lock_tables(session_maker, [Tag]) as session:
-    tag = await TagCrud.create(session, TagCreate(name="python"))
-    await m2m_add(session, post, Post.tags, tag)
+
from fastapi_toolsets.db import lock_tables, m2m_add
+
+async with lock_tables(session_maker, [Tag]) as session:
+    tag = await TagCrud.create(session, TagCreate(name="python"))
+    await m2m_add(session, post, Post.tags, tag)
 

 
Pass ignore_conflicts=True to silently skip associations that already exist:

-
await m2m_add(session, post, Post.tags, tag, ignore_conflicts=True)
+
await m2m_add(session, post, Post.tags, tag, ignore_conflicts=True)
 

 
m2m_remove — delete associations

 
m2m_remove deletes specific association rows. Removing a non-existent association is a no-op:

-
from fastapi_toolsets.db import get_transaction, m2m_remove
-
-async with get_transaction(session):
-    await m2m_remove(session, post, Post.tags, tag1, tag2)
+
from fastapi_toolsets.db import get_transaction, m2m_remove
+
+async with get_transaction(session):
+    await m2m_remove(session, post, Post.tags, tag1, tag2)
 

 
m2m_set — replace the full set

 
m2m_set atomically replaces all associations: it deletes every existing row for the owner instance then inserts the new set. Passing no related instances clears the association entirely:

-
from fastapi_toolsets.db import get_transaction, m2m_set
-
-# Replace all tags
-async with get_transaction(session):
-    await m2m_set(session, post, Post.tags, tag_a, tag_b)
-
-# Clear all tags
-async with get_transaction(session):
-    await m2m_set(session, post, Post.tags)
+
from fastapi_toolsets.db import get_transaction, m2m_set
+
+# Replace all tags
+async with get_transaction(session):
+    await m2m_set(session, post, Post.tags, tag_a, tag_b)
+
+# Clear all tags
+async with get_transaction(session):
+    await m2m_set(session, post, Post.tags)
 

 
All three helpers raise TypeError if the relationship attribute is not a Many-to-Many (i.e. has no secondary table).

 

@@ -2292,7 +2296,7 @@
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/module/dependencies/index.html b/v4.1/module/dependencies/index.html
index f48095b..55d2d20 100644
--- a/v4.1/module/dependencies/index.html
+++ b/v4.1/module/dependencies/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -1952,7 +1952,7 @@
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/module/exceptions/index.html b/v4.1/module/exceptions/index.html
index cd2b203..f97d343 100644
--- a/v4.1/module/exceptions/index.html
+++ b/v4.1/module/exceptions/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2001,6 +2001,16 @@
 422
 Invalid Order Field
 
+
+PoolExhaustedError
+503
+Service Unavailable
+
+
+LockTimeoutError
+503
+Service Unavailable
+
 
 
 
Per-instance overrides

@@ -2193,7 +2203,7 @@
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/module/fixtures/index.html b/v4.1/module/fixtures/index.html
index bc32f99..432ae25 100644
--- a/v4.1/module/fixtures/index.html
+++ b/v4.1/module/fixtures/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2294,7 +2294,7 @@
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/module/logger/index.html b/v4.1/module/logger/index.html
index 22cff9b..e1b3173 100644
--- a/v4.1/module/logger/index.html
+++ b/v4.1/module/logger/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -1930,7 +1930,7 @@
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/module/metrics/index.html b/v4.1/module/metrics/index.html
index f0778a5..4f42577 100644
--- a/v4.1/module/metrics/index.html
+++ b/v4.1/module/metrics/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2111,7 +2111,7 @@
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/module/models/index.html b/v4.1/module/models/index.html
index a058e71..357585f 100644
--- a/v4.1/module/models/index.html
+++ b/v4.1/module/models/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2368,7 +2368,7 @@ when the outermost commit() is called.

       
     
     
-      
+      
       
     
   
diff --git a/v4.1/module/pytest/index.html b/v4.1/module/pytest/index.html
index e1e9cad..06c9a4d 100644
--- a/v4.1/module/pytest/index.html
+++ b/v4.1/module/pytest/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2048,7 +2048,7 @@
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/module/schemas/index.html b/v4.1/module/schemas/index.html
index 680768b..9587b65 100644
--- a/v4.1/module/schemas/index.html
+++ b/v4.1/module/schemas/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2194,7 +2194,7 @@
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/module/security/index.html b/v4.1/module/security/index.html
index 510bf37..179a8a2 100644
--- a/v4.1/module/security/index.html
+++ b/v4.1/module/security/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2588,7 +2588,7 @@ The prefix (for BearerTokenAuth), cookie name and {"annotate":null,"base":"../..","features":["announce.dismiss","content.action.view","content.code.annotate","content.code.copy","content.code.select","content.footnote.tooltips","content.tabs.link","content.tooltips","navigation.footer","navigation.indexes","navigation.instant","navigation.instant.prefetch","navigation.path","navigation.sections","navigation.tabs","navigation.top","navigation.tracking","search.highlight"],"search":"../../assets/javascripts/workers/search.e2d2d235.min.js","tags":null,"translations":{"clipboard.copied":"Copied to clipboard","clipboard.copy":"Copy to clipboard","search.result.more.one":"1 more on this page","search.result.more.other":"# more on this page","search.result.none":"No matching documents","search.result.one":"1 matching document","search.result.other":"# matching documents","search.result.placeholder":"Type to start searching","search.result.term.missing":"Missing","select.version":"Select version"},"version":{"alias":true,"default":"stable","provider":"mike"}}
     
     
-      
+      
       
     
   
diff --git a/v4.1/objects.inv b/v4.1/objects.inv
index 048f5f9..57ca9a0 100644
Binary files a/v4.1/objects.inv and b/v4.1/objects.inv differ
diff --git a/v4.1/reference/cli/index.html b/v4.1/reference/cli/index.html
index 80ecd87..6672eb5 100644
--- a/v4.1/reference/cli/index.html
+++ b/v4.1/reference/cli/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2279,7 +2279,7 @@
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/crud/index.html b/v4.1/reference/crud/index.html
index afb69c4..75f9f73 100644
--- a/v4.1/reference/crud/index.html
+++ b/v4.1/reference/crud/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -6575,7 +6575,7 @@ Must match one of the resolved search field keys.

       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/db/index.html b/v4.1/reference/db/index.html
index 29f27d2..1cf949b 100644
--- a/v4.1/reference/db/index.html
+++ b/v4.1/reference/db/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2651,12 +2651,11 @@ if exceeded. Ignored when nowait is True.

       
           
             
-                  DBAPIError
+                  LockTimeoutError
             
             
               

-                
If timeout is set and the lock cannot be acquired
-in time.

+                
If timeout is set and the lock cannot be acquired in time.

               

             
           
@@ -3554,7 +3553,7 @@ in the association table (ON CONFLICT DO NOTHING).

       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/dependencies/index.html b/v4.1/reference/dependencies/index.html
index a36d930..e8ac1b5 100644
--- a/v4.1/reference/dependencies/index.html
+++ b/v4.1/reference/dependencies/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2201,7 +2201,7 @@
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/exceptions/index.html b/v4.1/reference/exceptions/index.html
index 8efc850..ae832a3 100644
--- a/v4.1/reference/exceptions/index.html
+++ b/v4.1/reference/exceptions/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -1375,6 +1375,62 @@
       
     
   
+
+      
+        
  • 
+  
+    
+      
+        PoolExhaustedError
+      
+    
+  
+  
+    
+  
+
    • 
+      
+        
  • 
+  
+    
+      
+        LockTimeoutError
+      
+    
+  
+  
+    
+  
 
    • 
       
         
  • 
@@ -2154,6 +2210,62 @@
       
     
   
+
    • 
+      
+        
  • 
+  
+    
+      
+        PoolExhaustedError
+      
+    
+  
+  
+    
+  
+
    • 
+      
+        
  • 
+  
+    
+      
+        LockTimeoutError
+      
+    
+  
+  
+    
+  
 
    • 
       
         
  • 
@@ -2296,9 +2408,11 @@
     InvalidSearchColumnError,
     InvalidFacetFilterError,
     InvalidOrderFieldError,
-    generate_error_responses,
-    init_exceptions_handlers,
-)
+    PoolExhaustedError,
+    LockTimeoutError,
+    generate_error_responses,
+    init_exceptions_handlers,
+)
 
    • 
 
 
@@ -3387,6 +3501,268 @@ HTTP response body.
    
 
 
 
+  
    
+
+    
    
+
+
    
+
+
    
+
+
+
+
    
+            fastapi_toolsets.exceptions.exceptions.PoolExhaustedError
+
+
+
    
+
+
+    
    
+            
    
+              Bases: ApiException
    
+
+
+
+        
    HTTP 503 - Database connection pool is exhausted.
    
+
+
+
+
+
+
+
+
+
+
+
+
    
+
+
+
+
+
+
+
+
+
+
+
    
+
+
+
    
+            __init__(detail=None, *, desc=None, data=None)
+
+
    
+
+
+    
    
+
+        
    Initialize the exception.
    
+
+
+
    Parameters:
    
+    
+      
+        
+          
+          
+          
+          
+        
+      
+      
+          
+            
+            
+            
+            
+          
+          
+            
+            
+            
+            
+          
+          
+            
+            
+            
+            
+          
+      
+    
    NameTypeDescriptionDefault
    
+                detail
+            
+                  str | None
+            
+              
    
+                
    Optional human-readable message
    
+              
    
+                		
+                  None
+            
    
+                desc
+            
+                  str | None
+            
+              
    
+                
    Optional per-instance override for the description field
+in the HTTP response body.
    
+              
    
+                		
+                  None
+            
    
+                data
+            
+                  Any
+            
+              
    
+                
    Optional per-instance override for the data field in the
+HTTP response body.
    
+              
    
+                		
+                  None
+            
    
+
+
+    
    
+
+
    
+
+
+
+  
    
+
+    
    
+
+
    
+
+
    
+
+
+
+
    
+            fastapi_toolsets.exceptions.exceptions.LockTimeoutError
+
+
+
    
+
+
+    
    
+            
    
+              Bases: ApiException
    
+
+
+
+        
    HTTP 503 - A database lock could not be acquired within the timeout.
    
+
+
+
+
+
+
+
+
+
+
+
+
    
+
+
+
+
+
+
+
+
+
+
+
    
+
+
+
    
+            __init__(detail=None, *, desc=None, data=None)
+
+
    
+
+
+    
    
+
+        
    Initialize the exception.
    
+
+
+
    Parameters:
    
+    
+      
+        
+          
+          
+          
+          
+        
+      
+      
+          
+            
+            
+            
+            
+          
+          
+            
+            
+            
+            
+          
+          
+            
+            
+            
+            
+          
+      
+    
    NameTypeDescriptionDefault
    
+                detail
+            
+                  str | None
+            
+              
    
+                
    Optional human-readable message
    
+              
    
+                		
+                  None
+            
    
+                desc
+            
+                  str | None
+            
+              
    
+                
    Optional per-instance override for the description field
+in the HTTP response body.
    
+              
    
+                		
+                  None
+            
    
+                data
+            
+                  Any
+            
+              
    
+                
    Optional per-instance override for the data field in the
+HTTP response body.
    
+              
    
+                		
+                  None
+            
    
+
+
+    
    
+
+
    
+
+
+
   
    
 
     
    
@@ -3642,7 +4018,7 @@ HTTP response body.
    
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/fixtures/index.html b/v4.1/reference/fixtures/index.html
index 14a27a0..c23fbbc 100644
--- a/v4.1/reference/fixtures/index.html
+++ b/v4.1/reference/fixtures/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -3754,7 +3754,7 @@ that returns a sequence of SQLAlchemy model instances.
    
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/logger/index.html b/v4.1/reference/logger/index.html
index ff40a6b..2adeb0f 100644
--- a/v4.1/reference/logger/index.html
+++ b/v4.1/reference/logger/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2100,7 +2100,7 @@ Pass None to get the root logger.
    
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/metrics/index.html b/v4.1/reference/metrics/index.html
index 201f83f..736ea63 100644
--- a/v4.1/reference/metrics/index.html
+++ b/v4.1/reference/metrics/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2550,7 +2550,7 @@ If False (default), called once at init time.
    
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/models/index.html b/v4.1/reference/models/index.html
index f44d006..489f471 100644
--- a/v4.1/reference/models/index.html
+++ b/v4.1/reference/models/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2426,7 +2426,7 @@ Defaults to all event types.
    
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/pytest/index.html b/v4.1/reference/pytest/index.html
index 4edcef8..ee3f80c 100644
--- a/v4.1/reference/pytest/index.html
+++ b/v4.1/reference/pytest/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -2660,7 +2660,7 @@ connection and as the base for the worker database name).
    
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/schemas/index.html b/v4.1/reference/schemas/index.html
index 181f581..a6c25bc 100644
--- a/v4.1/reference/schemas/index.html
+++ b/v4.1/reference/schemas/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -3013,7 +3013,7 @@ by a unified paginate() endpoint.
    
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/reference/security/index.html b/v4.1/reference/security/index.html
index c5c9201..406aba7 100644
--- a/v4.1/reference/security/index.html
+++ b/v4.1/reference/security/index.html
@@ -25,7 +25,7 @@
       
       
       
-      
+      
     
     
       
@@ -4176,7 +4176,7 @@ Do not forward arbitrary URLs to RedirectResponse.
    
       
     
     
-      
+      
       
     
   
diff --git a/v4.1/search.json b/v4.1/search.json
index e118e6d..fb9b058 100644
--- a/v4.1/search.json
+++ b/v4.1/search.json
@@ -1 +1 @@
-{"config":{"separator":"[\\s\\-_,:!=\\[\\]()\\\\\"`/]+|\\.(?!\\d)"},"items":[{"location":"","level":1,"title":"FastAPI Toolsets","text":"
    A modular collection of production-ready utilities for FastAPI. Install only what you need — from async CRUD and database helpers to CLI tooling, Prometheus metrics, and pytest fixtures. Each module is independently installable via optional extras, keeping your dependency footprint minimal.
     
     
     
    Documentation: https://fastapi-toolsets.d3vyce.fr
     
    Source Code: https://github.com/d3vyce/fastapi-toolsets
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"#installation","level":2,"title":"Installation","text":"
    The base package includes the core modules (CRUD, database, schemas, exceptions, fixtures, dependencies, model mixins, logging):
     
    uv add fastapi-toolsets\n
     
    Install only the extras you need:
     
    uv add \"fastapi-toolsets[cli]\"\nuv add \"fastapi-toolsets[metrics]\"\nuv add \"fastapi-toolsets[security]\"\nuv add \"fastapi-toolsets[pytest]\"\n
     
    Or install everything:
     
    uv add \"fastapi-toolsets[all]\"\n
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"#features","level":2,"title":"Features","text":"","path":["FastAPI Toolsets"],"tags":[]},{"location":"#core","level":3,"title":"Core","text":"
       
    • CRUD: Generic async CRUD operations with CrudFactory, built-in full-text/faceted search and Offset/Cursor pagination.
      •  
    • Database: Session management, transaction helpers, table locking, and polling-based row change detection
      •  
    • Dependencies: FastAPI dependency factories (PathDependency, BodyDependency) for automatic DB lookups from path or body parameters
      •  
    • Fixtures: Fixture system with dependency management, context support, and pytest integration
      •  
    • Model Mixins: SQLAlchemy mixins for common column patterns (UUIDMixin, UUIDv7Mixin, CreatedAtMixin, UpdatedAtMixin, TimestampMixin).
      •  
    • Lifecycle Events: Post-commit event system (EventSession, listens_for) that dispatches async/sync callbacks for insert, update, and delete operations.
      •  
    • Standardized API Responses: Consistent response format with Response, ErrorResponse, PaginatedResponse, CursorPaginatedResponse and OffsetPaginatedResponse.
      •  
    • Exception Handling: Structured error responses with automatic OpenAPI documentation
      •  
    • Logging: Logging configuration with uvicorn integration via configure_logging and get_logger
      •  
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"#optional","level":3,"title":"Optional","text":"
       
    • Security: Composable authentication sources (BearerTokenAuth, CookieAuth, APIKeyHeaderAuth, MultiAuth) with HMAC-signed cookies and OAuth 2.0 / OIDC helpers
      •  
    • CLI: Django-like command-line interface with fixture management and custom commands support
      •  
    • Metrics: Prometheus metrics endpoint with provider/collector registry
      •  
    • Pytest Helpers: Async test client, database session management, pytest-xdist support, and table cleanup utilities
      •  
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"#license","level":2,"title":"License","text":"
    MIT License - see LICENSE for details.
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"#contributing","level":2,"title":"Contributing","text":"
    Contributions are welcome! Please feel free to submit issues and pull requests.
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"examples/pagination-search/","level":1,"title":"Pagination & search","text":"
    This example builds an articles listing endpoint that supports offset pagination, cursor pagination, full-text search, faceted filtering, and sorting — all from a single CrudFactory definition.
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#models","level":2,"title":"Models","text":"models.py
    import uuid\n\nfrom sqlalchemy import Boolean, ForeignKey, String, Text\nfrom sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship\n\nfrom fastapi_toolsets.models import CreatedAtMixin\n\n\nclass Base(DeclarativeBase):\n    pass\n\n\nclass Category(Base):\n    __tablename__ = \"categories\"\n\n    id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4)\n    name: Mapped[str] = mapped_column(String(64), unique=True)\n\n    articles: Mapped[list[\"Article\"]] = relationship(back_populates=\"category\")\n\n\nclass Article(Base, CreatedAtMixin):\n    __tablename__ = \"articles\"\n\n    id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4)\n    title: Mapped[str] = mapped_column(String(256))\n    body: Mapped[str] = mapped_column(Text)\n    status: Mapped[str] = mapped_column(String(32))\n    published: Mapped[bool] = mapped_column(Boolean, default=False)\n    category_id: Mapped[uuid.UUID | None] = mapped_column(\n        ForeignKey(\"categories.id\"), nullable=True\n    )\n\n    category: Mapped[\"Category | None\"] = relationship(back_populates=\"articles\")\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#schemas","level":2,"title":"Schemas","text":"schemas.py
    import datetime\nimport uuid\n\nfrom fastapi_toolsets.schemas import PydanticBase\n\n\nclass ArticleRead(PydanticBase):\n    id: uuid.UUID\n    created_at: datetime.datetime\n    title: str\n    status: str\n    published: bool\n    category_id: uuid.UUID | None\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#crud","level":2,"title":"Crud","text":"
    Declare searchable_fields, facet_fields, and order_fields once on CrudFactory. All endpoints built from this class share the same defaults and can override them per call.
     crud.py
    from fastapi_toolsets.crud import CrudFactory\n\nfrom .models import Article, Category\n\nArticleCrud = CrudFactory(\n    model=Article,\n    cursor_column=Article.created_at,\n    searchable_fields=[  # default fields for full-text search\n        Article.title,\n        Article.body,\n        (Article.category, Category.name),\n    ],\n    facet_fields=[  # fields exposed as filter dropdowns\n        Article.status,\n        (Article.category, Category.name),\n    ],\n    order_fields=[  # fields exposed for client-driven ordering\n        Article.title,\n        Article.created_at,\n    ],\n)\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#session-dependency","level":2,"title":"Session dependency","text":"db.py
    from typing import Annotated\n\nfrom fastapi import Depends\nfrom sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine\n\nfrom fastapi_toolsets.db import create_db_context, create_db_dependency\n\nDATABASE_URL = \"postgresql+asyncpg://postgres:postgres@localhost:5432/postgres\"\n\nengine = create_async_engine(url=DATABASE_URL, future=True)\nasync_session_maker = async_sessionmaker(bind=engine, expire_on_commit=False)\n\nget_db = create_db_dependency(session_maker=async_session_maker)\nget_db_context = create_db_context(session_maker=async_session_maker)\n\n\nSessionDep = Annotated[AsyncSession, Depends(get_db)]\n
     
    Deploy a Postgres DB with docker
     
    docker run -d --name postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=postgres -p 5432:5432 postgres:18-alpine\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#app","level":2,"title":"App","text":"app.py
    from fastapi import FastAPI\n\nfrom fastapi_toolsets.exceptions import init_exceptions_handlers\n\nfrom .routes import router\n\napp = FastAPI()\ninit_exceptions_handlers(app=app)\napp.include_router(router=router)\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#routes","level":2,"title":"Routes","text":"routes.py:1:16
    from typing import Annotated\n\nfrom fastapi import APIRouter, Depends\n\nfrom fastapi_toolsets.schemas import (\n    CursorPaginatedResponse,\n    OffsetPaginatedResponse,\n    PaginatedResponse,\n)\n\nfrom .crud import ArticleCrud\nfrom .db import SessionDep\nfrom .models import Article\nfrom .schemas import ArticleRead\n\nrouter = APIRouter(prefix=\"/articles\")\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#offset-pagination","level":3,"title":"Offset pagination","text":"
    Best for admin panels or any UI that needs a total item count and numbered pages.
     routes.py:19:37
    @router.get(\"/offset\")\nasync def list_articles_offset(\n    session: SessionDep,\n    params: Annotated[\n        dict,\n        Depends(\n            ArticleCrud.offset_paginate_params(\n                default_page_size=20,\n                max_page_size=100,\n                default_order_field=Article.created_at,\n            )\n        ),\n    ],\n) -> OffsetPaginatedResponse[ArticleRead]:\n    return await ArticleCrud.offset_paginate(\n        session=session,\n        **params,\n        schema=ArticleRead,\n    )\n
     
    Example request
     
    GET /articles/offset?page=2&items_per_page=10&search=fastapi&status=published&order_by=title&order=asc\n
     
    Example response
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"offset\",\n  \"data\": [\n    { \"id\": \"3f47ac69-...\", \"title\": \"FastAPI tips\", \"status\": \"published\", ... }\n  ],\n  \"pagination\": {\n    \"total_count\": 42,\n    \"pages\": 5,\n    \"page\": 2,\n    \"items_per_page\": 10,\n    \"has_more\": true\n  },\n  \"filter_attributes\": {\n    \"status\": [\"archived\", \"draft\", \"published\"],\n    \"name\": [\"backend\", \"frontend\", \"python\"]\n  }\n}\n
     
    filter_attributes always reflects the values visible after applying the active filters. Use it to populate filter dropdowns on the client.
     
    To skip the COUNT(*) query for better performance on large tables, pass include_total=False. pagination.total_count will be null in the response, while has_more remains accurate.
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#cursor-pagination","level":3,"title":"Cursor pagination","text":"
    Best for feeds, infinite scroll, or any high-throughput API where offset performance degrades.
     routes.py:40:58
    @router.get(\"/cursor\")\nasync def list_articles_cursor(\n    session: SessionDep,\n    params: Annotated[\n        dict,\n        Depends(\n            ArticleCrud.cursor_paginate_params(\n                default_page_size=20,\n                max_page_size=100,\n                default_order_field=Article.created_at,\n            )\n        ),\n    ],\n) -> CursorPaginatedResponse[ArticleRead]:\n    return await ArticleCrud.cursor_paginate(\n        session=session,\n        **params,\n        schema=ArticleRead,\n    )\n
     
    Example request
     
    GET /articles/cursor?items_per_page=10&status=published&order_by=created_at&order=desc\n
     
    Example response
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"cursor\",\n  \"data\": [\n    { \"id\": \"3f47ac69-...\", \"title\": \"FastAPI tips\", \"status\": \"published\", ... }\n  ],\n  \"pagination\": {\n    \"next_cursor\": \"eyJ2YWx1ZSI6ICIzZjQ3YWM2OS0uLi4ifQ==\",\n    \"prev_cursor\": null,\n    \"items_per_page\": 10,\n    \"has_more\": true\n  },\n  \"filter_attributes\": {\n    \"status\": [\"published\"],\n    \"name\": [\"backend\", \"python\"]\n  }\n}\n
     
    Pass next_cursor as the cursor query parameter on the next request to advance to the next page.
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#unified-endpoint-both-strategies","level":3,"title":"Unified endpoint (both strategies)","text":"
    Added in v2.3.0
     
    paginate() lets a single endpoint support both strategies via a pagination_type query parameter. The pagination_type field in the response acts as a discriminator for frontend tooling.
     routes.py:61:79
    @router.get(\"/\")\nasync def list_articles(\n    session: SessionDep,\n    params: Annotated[\n        dict,\n        Depends(\n            ArticleCrud.paginate_params(\n                default_page_size=20,\n                max_page_size=100,\n                default_order_field=Article.created_at,\n            )\n        ),\n    ],\n) -> PaginatedResponse[ArticleRead]:\n    return await ArticleCrud.paginate(\n        session,\n        **params,\n        schema=ArticleRead,\n    )\n
     
    Offset request (default)
     
    GET /articles/?pagination_type=offset&page=1&items_per_page=10\n
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"offset\",\n  \"data\": [\"...\"],\n  \"pagination\": { \"total_count\": 42, \"pages\": 5, \"page\": 1, \"items_per_page\": 10, \"has_more\": true }\n}\n
     
    Cursor request
     
    GET /articles/?pagination_type=cursor&items_per_page=10\nGET /articles/?pagination_type=cursor&items_per_page=10&cursor=eyJ2YWx1ZSI6...\n
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"cursor\",\n  \"data\": [\"...\"],\n  \"pagination\": { \"next_cursor\": \"eyJ2YWx1ZSI6...\", \"prev_cursor\": null, \"items_per_page\": 10, \"has_more\": true }\n}\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#search-behaviour","level":2,"title":"Search behaviour","text":"
    Both endpoints inherit the same searchable_fields declared on ArticleCrud:
     
    Search is case-insensitive and uses a LIKE %query% pattern. Pass a SearchConfig instead of a plain string to control case sensitivity or switch to match_mode=\"all\" (AND across all fields instead of OR).
     
    from fastapi_toolsets.crud import SearchConfig\n\n# Both title AND body must contain \"fastapi\"\nresult = await ArticleCrud.offset_paginate(\n    session,\n    search=SearchConfig(query=\"fastapi\", case_sensitive=True, match_mode=\"all\"),\n    search_fields=[Article.title, Article.body],\n)\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"migration/v2/","level":1,"title":"Migrating to v2.0","text":"
    This page covers every breaking change introduced in v2.0 and the steps required to update your code.
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#crud","level":2,"title":"CRUD","text":"","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#schema-is-now-required-in-offset_paginate-and-cursor_paginate","level":3,"title":"schema is now required in offset_paginate() and cursor_paginate()","text":"
    Calls that omit schema will now raise a TypeError at runtime.
     
    Previously schema was optional; omitting it returned raw SQLAlchemy model instances inside the response. It is now a required keyword argument and the response always contains serialized schema instances.
     Before (v1)Now (v2) 
    # schema omitted — returned raw model instances\nresult = await UserCrud.offset_paginate(session=session, page=1)\nresult = await UserCrud.cursor_paginate(session=session, cursor=token)\n
     
    result = await UserCrud.offset_paginate(session=session, page=1, schema=UserRead)\nresult = await UserCrud.cursor_paginate(session=session, cursor=token, schema=UserRead)\n
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#as_response-removed-from-create-get-and-update","level":3,"title":"as_response removed from create(), get(), and update()","text":"
    Passing as_response to these methods will raise a TypeError at runtime.
     
    The as_response=True shorthand is replaced by passing a schema directly. The return value is a Response[schema] when schema is provided, or the raw model instance when it is not.
     Before (v1)Now (v2) 
    user = await UserCrud.create(session=session, obj=data, as_response=True)\nuser = await UserCrud.get(session=session, filters=filters, as_response=True)\nuser = await UserCrud.update(session=session, obj=data, filters, as_response=True)\n
     
    user = await UserCrud.create(session=session, obj=data, schema=UserRead)\nuser = await UserCrud.get(session=session, filters=filters, schema=UserRead)\nuser = await UserCrud.update(session=session, obj=data, filters, schema=UserRead)\n
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#delete-as_response-renamed-and-return-type-changed","level":3,"title":"delete(): as_response renamed and return type changed","text":"
    as_response is gone, and the plain (non-response) call no longer returns True.
     
    Two changes were made to delete():
     
       
    1. The as_response parameter is renamed to return_response.
      2.  
    2. When called without return_response=True, the method now returns None on success instead of True.
      3.  
     Before (v1)Now (v2) 
    ok = await UserCrud.delete(session=session, filters=filters)\nif ok:  # True on success\n    ...\n\nresponse = await UserCrud.delete(session=session, filters=filters, as_response=True)\n
     
    await UserCrud.delete(session=session, filters=filters)  # returns None\n\nresponse = await UserCrud.delete(session=session, filters=filters, return_response=True)\n
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#paginate-alias-removed","level":3,"title":"paginate() alias removed","text":"
    Any call to crud.paginate(...) will raise AttributeError at runtime.
     
    The paginate shorthand was an alias for offset_paginate. It has been removed; call offset_paginate directly.
     Before (v1)Now (v2) 
    result = await UserCrud.paginate(session=session, page=2, items_per_page=20, schema=UserRead)\n
     
    result = await UserCrud.offset_paginate(session=session, page=2, items_per_page=20, schema=UserRead)\n
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#exceptions","level":2,"title":"Exceptions","text":"","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#missing-api_error-raises-typeerror-at-class-definition-time","level":3,"title":"Missing api_error raises TypeError at class definition time","text":"
    Unfinished or stub exception subclasses that previously compiled fine will now fail on import.
     
    In v1, a subclass without api_error would only fail when the exception was raised. In v2, __init_subclass__ validates this at class definition time.
     Before (v1)Now (v2) 
    class MyError(ApiException):\n    pass  # fine until raised\n
     
    class MyError(ApiException):\n    pass  # TypeError: MyError must define an 'api_error' class attribute.\n
     
    For shared base classes that are not meant to be raised directly, use abstract=True:
     
    class BillingError(ApiException, abstract=True):\n    \"\"\"Base for all billing-related errors — not raised directly.\"\"\"\n\nclass PaymentRequiredError(BillingError):\n    api_error = ApiError(code=402, msg=\"Payment Required\", desc=\"...\", err_code=\"BILLING-402\")\n
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#schemas","level":2,"title":"Schemas","text":"","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#pagination-alias-removed","level":3,"title":"Pagination alias removed","text":"
    Pagination was already deprecated in v1 and is fully removed in v2, you now need to use OffsetPagination or CursorPagination.
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v3/","level":1,"title":"Migrating to v3.0","text":"
    This page covers every breaking change introduced in v3.0 and the steps required to update your code.
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#crud","level":2,"title":"CRUD","text":"","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#facet-keys-now-always-use-the-full-relationship-chain","level":3,"title":"Facet keys now always use the full relationship chain","text":"
    In v2, relationship facet fields used only the terminal column key (e.g. \"name\" for Role.name) and only prepended the relationship name when two facet fields shared the same column key. In v3, facet keys always include the full relationship chain joined by __, regardless of collisions.
     Before (v2)Now (v3) 
    User.status -> status\n(User.role, Role.name) -> name\n(User.role, Role.permission, Permission.name) -> name\n
     
    User.status -> status\n(User.role, Role.name) -> role__name\n(User.role, Role.permission, Permission.name) -> role__permission__name\n
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#_params-dependencies-consolidated-into-per-paginate-methods","level":3,"title":"*_params dependencies consolidated into per-paginate methods","text":"
    The six individual dependency methods (offset_params, cursor_params, paginate_params, filter_params, search_params, order_params) have been removed and replaced by three consolidated methods that bundle pagination, search, filter, and order into a single Depends() call.
     Removed Replacement offset_params() + filter_params() + search_params() + order_params() offset_paginate_params() cursor_params() + filter_params() + search_params() + order_params() cursor_paginate_params() paginate_params() + filter_params() + search_params() + order_params() paginate_params() 
    Each new method accepts search, filter, and order boolean toggles (all True by default) to disable features you don't need.
     Before (v2)Now (v3) 
    from fastapi_toolsets.crud import OrderByClause\n\n@router.get(\"/offset\")\nasync def list_articles_offset(\n    session: SessionDep,\n    params: Annotated[dict, Depends(ArticleCrud.offset_params(default_page_size=20))],\n    filter_by: Annotated[dict, Depends(ArticleCrud.filter_params())],\n    order_by: Annotated[OrderByClause | None, Depends(ArticleCrud.order_params(default_field=Article.created_at))],\n    search: str | None = None,\n) -> OffsetPaginatedResponse[ArticleRead]:\n    return await ArticleCrud.offset_paginate(\n        session=session,\n        **params,\n        search=search,\n        filter_by=filter_by or None,\n        order_by=order_by,\n        schema=ArticleRead,\n    )\n
     
    @router.get(\"/offset\")\nasync def list_articles_offset(\n    session: SessionDep,\n    params: Annotated[\n        dict,\n        Depends(\n            ArticleCrud.offset_paginate_params(\n                default_page_size=20,\n                default_order_field=Article.created_at,\n            )\n        ),\n    ],\n) -> OffsetPaginatedResponse[ArticleRead]:\n    return await ArticleCrud.offset_paginate(session=session, **params, schema=ArticleRead)\n
     
    The same pattern applies to cursor_paginate_params() and paginate_params(). To disable a feature, pass the toggle:
     
    # No search or ordering, only pagination + filtering\nArticleCrud.offset_paginate_params(search=False, order=False)\n
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#models","level":2,"title":"Models","text":"
    The lifecycle event system has been rewritten. Callbacks are now registered with a module-level listens_for decorator and dispatched by EventSession, replacing the mixin-based approach from v2.
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#watchedfieldsmixin-and-watch-removed","level":3,"title":"WatchedFieldsMixin and @watch removed","text":"
    Importing WatchedFieldsMixin or watch will raise ImportError.
     
    Model method callbacks (on_create, on_delete, on_update) and the @watch decorator are replaced by:
     
       
    1. __watched_fields__ — a plain class attribute to restrict which field changes trigger UPDATE events (replaces @watch).
      2.  
    2. @listens_for — a module-level decorator to register callbacks for one or more ModelEvent types (replaces on_create / on_delete / on_update methods).
      3.  
     Before (v2)Now (v3) 
    from fastapi_toolsets.models import WatchedFieldsMixin, watch\n\n@watch(\"status\")\nclass Order(Base, UUIDMixin, WatchedFieldsMixin):\n    __tablename__ = \"orders\"\n\n    status: Mapped[str]\n\n    async def on_create(self):\n        await notify_new_order(self.id)\n\n    async def on_update(self, changes):\n        if \"status\" in changes:\n            await notify_status_change(self.id, changes[\"status\"])\n\n    async def on_delete(self):\n        await notify_order_cancelled(self.id)\n
     
    from fastapi_toolsets.models import ModelEvent, UUIDMixin, listens_for\n\nclass Order(Base, UUIDMixin):\n    __tablename__ = \"orders\"\n    __watched_fields__ = (\"status\",)\n\n    status: Mapped[str]\n\n@listens_for(Order, [ModelEvent.CREATE])\nasync def on_order_created(order: Order, event_type: ModelEvent, changes: None):\n    await notify_new_order(order.id)\n\n@listens_for(Order, [ModelEvent.UPDATE])\nasync def on_order_updated(order: Order, event_type: ModelEvent, changes: dict):\n    if \"status\" in changes:\n        await notify_status_change(order.id, changes[\"status\"])\n\n@listens_for(Order, [ModelEvent.DELETE])\nasync def on_order_deleted(order: Order, event_type: ModelEvent, changes: None):\n    await notify_order_cancelled(order.id)\n
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#eventsession-now-required","level":3,"title":"EventSession now required","text":"
    Without EventSession, lifecycle callbacks will silently stop firing.
     
    Callbacks are now dispatched inside EventSession.commit() rather than via background tasks. Pass it as the session class when creating your session factory:
     Before (v2)Now (v3) 
    from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False)\n
     
    from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine\nfrom fastapi_toolsets.models import EventSession\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False, class_=EventSession)\n
     
    Note
     
    If you use create_db_session from fastapi_toolsets.pytest, the session already uses EventSession — no changes needed in tests.
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v4/","level":1,"title":"Migrating to v4.0","text":"
    This page covers every breaking change introduced in v4.0 and the steps required to update your code.
    ","path":["Migration","Migrating to v4.0"],"tags":[]},{"location":"migration/v4/#database","level":2,"title":"Database","text":"","path":["Migration","Migrating to v4.0"],"tags":[]},{"location":"migration/v4/#lock_tables-now-takes-a-session_maker-instead-of-a-session","level":3,"title":"lock_tables now takes a session_maker instead of a session","text":"
    The first argument of lock_tables changed from an AsyncSession instance to an async_sessionmaker. The function creates and manages its own dedicated session internally, yielding it to the caller.
     Before (v3)Now (v4) 
    from fastapi_toolsets.db import lock_tables, LockMode\n\nasync with lock_tables(session=session, tables=[User, Account]):\n    user = await UserCrud.get(session, [User.id == 1])\n    user.balance += 100\n\n# With a custom lock mode\nasync with lock_tables(session, [Order], mode=LockMode.EXCLUSIVE):\n    await process_order(session, order_id)\n
     
    from fastapi_toolsets.db import lock_tables, LockMode\n\nasync with lock_tables(session_maker=session_maker, tables=[User, Account]) as session:\n    user = await UserCrud.get(session, [User.id == 1])\n    user.balance += 100\n\n# With a custom lock mode\nasync with lock_tables(session_maker, [Order], mode=LockMode.EXCLUSIVE) as session:\n    await process_order(session, order_id)\n
    ","path":["Migration","Migrating to v4.0"],"tags":[]},{"location":"module/cli/","level":1,"title":"CLI","text":"
    Typer-based command-line interface for managing your FastAPI application, with built-in fixture commands integration.
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#installation","level":2,"title":"Installation","text":"uvpip 
    uv add \"fastapi-toolsets[cli]\"\n
     
    pip install \"fastapi-toolsets[cli]\"\n
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#overview","level":2,"title":"Overview","text":"
    The cli module provides a manager entry point built with Typer. It allow custom commands to be added in addition of the fixture commands when a FixtureRegistry and a database context are configured.
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#configuration","level":2,"title":"Configuration","text":"
    Configure the CLI in your pyproject.toml:
     
    [tool.fastapi-toolsets]\ncli = \"myapp.cli:cli\"                   # Custom Typer app\nfixtures = \"myapp.fixtures:registry\"    # FixtureRegistry instance\ndb_context = \"myapp.db:db_context\"      # Async context manager for sessions\n
     
    All fields are optional. Without configuration, the manager command still works but no command are available.
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#usage","level":2,"title":"Usage","text":"
    # Manager commands\nmanager --help\n\n Usage: manager [OPTIONS] COMMAND [ARGS]...\n\n FastAPI utilities CLI.\n\n╭─ Options ────────────────────────────────────────────────────────────────────────╮\n│ --install-completion          Install completion for the current shell.          │\n│ --show-completion             Show completion for the current shell, to copy it  │\n│                               or customize the installation.                     │\n│ --help                        Show this message and exit.                        │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n╭─ Commands ───────────────────────────────────────────────────────────────────────╮\n│ check-db                                                                         │\n│ fixtures  Manage database fixtures.                                              │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n\n# Fixtures commands\nmanager fixtures --help\n\n Usage: manager fixtures [OPTIONS] COMMAND [ARGS]...\n\n Manage database fixtures.\n\n╭─ Options ────────────────────────────────────────────────────────────────────────╮\n│ --help          Show this message and exit.                                      │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n╭─ Commands ───────────────────────────────────────────────────────────────────────╮\n│ list  List all registered fixtures.                                              │\n│ load  Load fixtures into the database.                                           │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#custom-cli","level":2,"title":"Custom CLI","text":"
    You can extend the CLI by providing your own Typer app. The manager entry point will merge your app's commands with the built-in ones:
     
    # myapp/cli.py\nimport typer\n\ncli = typer.Typer()\n\n@cli.command()\ndef hello():\n    print(\"Hello from my app!\")\n
     
    [tool.fastapi-toolsets]\ncli = \"myapp.cli:cli\"\n
     
     API Reference
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/crud/","level":1,"title":"CRUD","text":"
    Generic async CRUD operations for SQLAlchemy models with search, pagination, and many-to-many support.
     
    Info
     
    This module has been coded and tested to be compatible with PostgreSQL only.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#overview","level":2,"title":"Overview","text":"
    The crud module provides AsyncCrud, a base class with a full suite of async database operations, and CrudFactory, a convenience function to instantiate it for a given model.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#creating-a-crud-class","level":2,"title":"Creating a CRUD class","text":"","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#factory-style","level":3,"title":"Factory style","text":"
    from fastapi_toolsets.crud import CrudFactory\nfrom myapp.models import User\n\nUserCrud = CrudFactory(model=User)\n
     
    CrudFactory dynamically creates a class named AsyncUserCrud with User as its model. This is the most concise option for straightforward CRUD with no custom logic.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#subclass-style","level":3,"title":"Subclass style","text":"
    Added in v2.3.0
     
    from fastapi_toolsets.crud.factory import AsyncCrud\nfrom myapp.models import User\n\nclass UserCrud(AsyncCrud[User]):\n    model = User\n    searchable_fields = [User.username, User.email]\n    default_load_options = [selectinload(User.role)]\n
     
    Subclassing AsyncCrud directly is the preferred style when you need to add custom methods or when the configuration is complex enough to benefit from a named class body.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#adding-custom-methods","level":3,"title":"Adding custom methods","text":"
    class UserCrud(AsyncCrud[User]):\n    model = User\n\n    @classmethod\n    async def get_active(cls, session: AsyncSession) -> list[User]:\n        return await cls.get_multi(session, filters=[User.is_active == True])\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#sharing-a-custom-base-across-multiple-models","level":3,"title":"Sharing a custom base across multiple models","text":"
    Define a generic base class with the shared methods, then subclass it for each model:
     
    from typing import Generic, TypeVar\nfrom sqlalchemy.ext.asyncio import AsyncSession\nfrom sqlalchemy.orm import DeclarativeBase\nfrom fastapi_toolsets.crud.factory import AsyncCrud\n\nT = TypeVar(\"T\", bound=DeclarativeBase)\n\nclass AuditedCrud(AsyncCrud[T], Generic[T]):\n    \"\"\"Base CRUD with custom function\"\"\"\n\n    @classmethod\n    async def get_active(cls, session: AsyncSession):\n        return await cls.get_multi(session, filters=[cls.model.is_active == True])\n\n\nclass UserCrud(AuditedCrud[User]):\n    model = User\n    searchable_fields = [User.username, User.email]\n
     
    You can also use the factory shorthand with the same base by passing base_class:
     
    UserCrud = CrudFactory(User, base_class=AuditedCrud)\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#basic-operations","level":2,"title":"Basic operations","text":"
    get_or_none added in v2.2
     
    # Create\nuser = await UserCrud.create(session=session, obj=UserCreateSchema(username=\"alice\"))\n\n# Get one (raises NotFoundError if not found)\nuser = await UserCrud.get(session=session, filters=[User.id == user_id])\n\n# Get one or None (never raises)\nuser = await UserCrud.get_or_none(session=session, filters=[User.id == user_id])\n\n# Get first or None\nuser = await UserCrud.first(session=session, filters=[User.email == email])\n\n# Get multiple\nusers = await UserCrud.get_multi(session=session, filters=[User.is_active == True])\n\n# Update\nuser = await UserCrud.update(session=session, obj=UserUpdateSchema(username=\"bob\"), filters=[User.id == user_id])\n\n# Delete\nawait UserCrud.delete(session=session, filters=[User.id == user_id])\n\n# Count / exists\ncount = await UserCrud.count(session=session, filters=[User.is_active == True])\nexists = await UserCrud.exists(session=session, filters=[User.email == email])\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#fetching-a-single-record","level":2,"title":"Fetching a single record","text":"
    Three methods fetch a single record — choose based on how you want to handle the \"not found\" case and whether you need strict uniqueness:
     Method Not found Multiple results get raises NotFoundError raises MultipleResultsFound get_or_none returns None raises MultipleResultsFound first returns None returns the first match silently 
    Use get when the record must exist (e.g. a detail endpoint that should return 404):
     
    user = await UserCrud.get(session=session, filters=[User.id == user_id])\n
     
    Use get_or_none when the record may not exist but you still want strict uniqueness enforcement:
     
    user = await UserCrud.get_or_none(session=session, filters=[User.email == email])\nif user is None:\n    ...  # handle missing case without catching an exception\n
     
    Use first when you only care about any one match and don't need uniqueness:
     
    user = await UserCrud.first(session=session, filters=[User.is_active == True])\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#row-locking","level":2,"title":"Row locking","text":"
    get, get_or_none, first, get_multi, and update all accept a with_for_update parameter that appends a FOR UPDATE clause to the underlying SELECT, preventing concurrent transactions from modifying the matched rows until the current transaction commits.
     Value SQL clause False (default) no locking True FOR UPDATE \"nowait\" FOR UPDATE NOWAIT \"skip_locked\" FOR UPDATE SKIP LOCKED 
    # Lock before reading — typical read-modify-write pattern\nuser = await UserCrud.get(session, [User.id == user_id], with_for_update=True)\n\n# Raise immediately if another transaction holds the lock\nuser = await UserCrud.get(session, [User.id == user_id], with_for_update=\"nowait\")\n\n# Skip rows already locked by another transaction (e.g. job queues)\nrows = await JobCrud.get_multi(session, filters=[Job.status == \"pending\"], with_for_update=\"skip_locked\")\n\n# Lock atomically as part of update (prevents race between SELECT and UPDATE)\nuser = await UserCrud.update(session, UserUpdate(credits=10), [User.id == user_id], with_for_update=True)\n
     
    Warning
     
    with_for_update requires an open transaction. Wrap your call in async with session.begin() or use the get_transaction helper if you are not already inside one.
     
    Note
     
    NOWAIT raises sqlalchemy.exc.OperationalError immediately if the row is locked rather than waiting.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#pagination","level":2,"title":"Pagination","text":"
    Added in v1.1 (only offset_pagination via paginate if <v1.1)
     
    Three pagination methods are available.  All return a typed response whose pagination_type field tells clients which strategy was used.
     offset_paginate cursor_paginate paginate Return type OffsetPaginatedResponse CursorPaginatedResponse either, based on pagination_type param Total count Yes No / Jump to arbitrary page Yes No / Performance on deep pages Degrades Constant / Stable under concurrent inserts No Yes / Use case Admin panels, numbered pagination Feeds, APIs, infinite scroll single endpoint, both strategies","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#offset-pagination","level":3,"title":"Offset pagination","text":"
    from typing import Annotated\nfrom fastapi import Depends\n\n@router.get(\"\")\nasync def get_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.offset_paginate_params())],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
     
    The offset_paginate method returns an OffsetPaginatedResponse:
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"offset\",\n  \"data\": [\"...\"],\n  \"pagination\": {\n    \"total_count\": 100,\n    \"pages\": 5,\n    \"page\": 1,\n    \"items_per_page\": 20,\n    \"has_more\": true\n  }\n}\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#skipping-the-count-query","level":4,"title":"Skipping the COUNT query","text":"
    Added in v2.4.1
     
    By default offset_paginate runs two queries: one for the page items and one COUNT(*) for total_count. On large tables the COUNT can be expensive. Pass include_total=False to offset_paginate_params() to skip it:
     
    @router.get(\"\")\nasync def get_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.offset_paginate_params(include_total=False))],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#cursor-pagination","level":3,"title":"Cursor pagination","text":"
    @router.get(\"\")\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.cursor_paginate_params())],\n) -> CursorPaginatedResponse[UserRead]:\n    return await UserCrud.cursor_paginate(session=session, **params, schema=UserRead)\n
     
    The cursor_paginate method returns a CursorPaginatedResponse:
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"cursor\",\n  \"data\": [\"...\"],\n  \"pagination\": {\n    \"next_cursor\": \"eyJ2YWx1ZSI6ICIzZjQ3YWM2OS0uLi4ifQ==\",\n    \"prev_cursor\": null,\n    \"items_per_page\": 20,\n    \"has_more\": true\n  }\n}\n
     
    Pass next_cursor as the cursor query parameter on the next request to advance to the next page. prev_cursor is set on pages 2+ and points back to the first item of the current page. Both are null when there is no adjacent page.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#choosing-a-cursor-column","level":4,"title":"Choosing a cursor column","text":"
    The cursor column is set once on CrudFactory via the cursor_column parameter. It must be monotonically ordered for stable results:
     
       
    • Auto-increment integer PKs
      •  
    • UUID v7 PKs
      •  
    • Timestamps
      •  
     
    Warning
     
    Random UUID v4 PKs are not suitable as cursor columns because their ordering is non-deterministic.
     
    Note
     
    cursor_column is required. Calling cursor_paginate on a CRUD class that has no cursor_column configured raises a ValueError.
     
    The cursor value is URL-safe base64-encoded (no padding) when returned to the client and decoded back to the correct Python type on the next request. The following SQLAlchemy column types are supported:
     SQLAlchemy type Python type Integer, BigInteger, SmallInteger int Uuid uuid.UUID DateTime datetime.datetime Date datetime.date Float, Numeric decimal.Decimal 
    # Paginate by the primary key\nPostCrud = CrudFactory(model=Post, cursor_column=Post.id)\n\n# Paginate by a timestamp column instead\nPostCrud = CrudFactory(model=Post, cursor_column=Post.created_at)\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#unified-endpoint-both-strategies","level":3,"title":"Unified endpoint (both strategies)","text":"
    Added in v2.3.0
     
    paginate() dispatches to offset_paginate or cursor_paginate based on a pagination_type query parameter, letting you expose one endpoint that supports both strategies.  The pagination_type field in the response tells clients which strategy was used, enabling frontend discriminated-union typing.
     
    from fastapi_toolsets.schemas import PaginatedResponse\n\n@router.get(\"\")\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.paginate_params())],\n) -> PaginatedResponse[UserRead]:\n    return await UserCrud.paginate(session, **params, schema=UserRead)\n
     
    GET /users?pagination_type=offset&page=2&items_per_page=10\nGET /users?pagination_type=cursor&cursor=eyJ2YWx1ZSI6...&items_per_page=10\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#search","level":2,"title":"Search","text":"
    Two search strategies are available, both compatible with offset_paginate and cursor_paginate.
     Full-text search Faceted search Input Free-text string Exact column values Relationship support Yes Yes Use case Search bars Filter dropdowns 
    You can use both search strategies in the same endpoint!
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#full-text-search","level":3,"title":"Full-text search","text":"
    Added in v2.2.1
     
    The model's primary key is always included in searchable_fields automatically, so searching by ID works out of the box without any configuration. When no searchable_fields are declared, only the primary key is searched.
     
    Declare searchable_fields on the CRUD class. Relationship traversal is supported via tuples:
     
    PostCrud = CrudFactory(\n    model=Post,\n    searchable_fields=[\n        Post.title,\n        Post.content,\n        (Post.author, User.username),  # search across relationship\n    ],\n)\n
     
    You can override searchable_fields per call with search_fields:
     
    result = await UserCrud.offset_paginate(\n    session=session,\n    search_fields=[User.country],\n)\n
     
    Or via the dependency to narrow which fields are exposed as query parameters:
     
    params = UserCrud.offset_paginate_params(search_fields=[Post.title])\n
     
    This allows searching with both offset_paginate and cursor_paginate:
     
    @router.get(\"\")\nasync def get_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.offset_paginate_params())],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
     
    @router.get(\"\")\nasync def get_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.cursor_paginate_params())],\n) -> CursorPaginatedResponse[UserRead]:\n    return await UserCrud.cursor_paginate(session=session, **params, schema=UserRead)\n
     
    The dependency adds two query parameters to the endpoint:
     Parameter Type search str \\| null search_column str \\| null 
    GET /posts?search=hello                        → search all configured columns\nGET /posts?search=hello&search_column=title    → search only Post.title\n
     
    The available search column keys are returned in the search_columns field of PaginatedResponse. Use them to populate a column picker in the UI, or to validate search_column values on the client side:
     
    {\n  \"status\": \"SUCCESS\",\n  \"data\": [\"...\"],\n  \"pagination\": { \"...\" },\n  \"search_columns\": [\"content\", \"author__username\", \"title\"]\n}\n
     
    Key format uses __ as a separator for relationship chains.
     
    A direct column Post.title produces \"title\". A relationship tuple (Post.author, User.username) produces \"author__username\". An unknown search_column value raises InvalidSearchColumnError (HTTP 422).
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#faceted-search","level":3,"title":"Faceted search","text":"
    Added in v1.2
     
    Declare facet_fields on the CRUD class to return distinct column values alongside paginated results. This is useful for populating filter dropdowns or building faceted search UIs. Relationship traversal is supported via tuples, using the same syntax as searchable_fields:
     
    UserCrud = CrudFactory(\n    model=User,\n    facet_fields=[\n        User.status,\n        User.country,\n        (User.role, Role.name),  # value from a related model\n    ],\n)\n
     
    You can override facet_fields per call:
     
    result = await UserCrud.offset_paginate(\n    session=session,\n    facet_fields=[User.country],\n)\n
     
    Or via the dependency to narrow which fields are exposed as query parameters:
     
    params = UserCrud.offset_paginate_params(facet_fields=[User.country])\n
     
    Facet filtering is built into the consolidated params dependencies. When filter=True (the default), each facet field is exposed as a query parameter and values are collected into filter_by automatically:
     
    from typing import Annotated\n\nfrom fastapi import Depends\n\n@router.get(\"\", response_model_exclude_none=True)\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.offset_paginate_params())],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
     
    @router.get(\"\", response_model_exclude_none=True)\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.cursor_paginate_params())],\n) -> CursorPaginatedResponse[UserRead]:\n    return await UserCrud.cursor_paginate(session=session, **params, schema=UserRead)\n
     
    Both single-value and multi-value query parameters work:
     
    GET /users?status=active                      → filter_by={\"status\": [\"active\"]}\nGET /users?status=active&country=FR           → filter_by={\"status\": [\"active\"], \"country\": [\"FR\"]}\nGET /users?role__name=admin&role__name=editor → filter_by={\"role__name\": [\"admin\", \"editor\"]}  (IN clause)\n
     
    filter_by and filters can be combined — both are applied with AND logic.
     
    The distinct values for each facet field are returned in the filter_attributes field of PaginatedResponse. Use them to populate filter dropdowns in the UI, or to validate filter_by keys on the client side:
     
    {\n  \"status\": \"SUCCESS\",\n  \"data\": [\"...\"],\n  \"pagination\": { \"...\" },\n  \"filter_attributes\": {\n    \"status\": [\"active\", \"inactive\"],\n    \"country\": [\"DE\", \"FR\", \"US\"],\n    \"role__name\": [\"admin\", \"editor\", \"viewer\"]\n  }\n}\n
     
    Key format uses __ as a separator for relationship chains.
     
    A direct column User.status produces \"status\". A relationship tuple (User.role, Role.name) produces \"role__name\". A deeper chain (User.role, Role.permission, Permission.name) produces \"role__permission__name\". An unknown filter_by key raises InvalidFacetFilterError (HTTP 422).
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#sorting","level":2,"title":"Sorting","text":"
    Added in v1.3
     
    Declare order_fields on the CRUD class. Relationship traversal is supported via tuples, using the same syntax as searchable_fields and facet_fields:
     
    UserCrud = CrudFactory(\n    model=User,\n    order_fields=[\n        User.name,\n        User.created_at,\n        (User.role, Role.name),  # sort by a related model column\n    ],\n)\n
     
    You can override order_fields per call:
     
    result = await UserCrud.offset_paginate(\n    session=session,\n    order_fields=[User.name],\n)\n
     
    Or via the dependency to narrow which fields are exposed as query parameters:
     
    params = UserCrud.offset_paginate_params(order_fields=[User.name])\n
     
    Sorting is built into the consolidated params dependencies. When order=True (the default), order_by and order query parameters are exposed and resolved into an OrderByClause automatically:
     
    from typing import Annotated\n\nfrom fastapi import Depends\n\n@router.get(\"\")\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.offset_paginate_params())],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
     
    @router.get(\"\")\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.cursor_paginate_params())],\n) -> CursorPaginatedResponse[UserRead]:\n    return await UserCrud.cursor_paginate(session=session, **params, schema=UserRead)\n
     
    The dependency adds two query parameters to the endpoint:
     Parameter Type order_by str \\| null order asc or desc 
    GET /users?order_by=name&order=asc         → ORDER BY users.name ASC\nGET /users?order_by=role__name&order=desc  → LEFT JOIN roles ON ... ORDER BY roles.name DESC\n
     
    Relationship tuples are joined automatically.
     
    When a relation field is selected, the related table is LEFT OUTER JOINed automatically. An unknown order_by value raises InvalidOrderFieldError (HTTP 422).
     
    The available sort keys are returned in the order_columns field of PaginatedResponse. Use them to populate a sort picker in the UI, or to validate order_by values on the client side:
     
    {\n  \"status\": \"SUCCESS\",\n  \"data\": [\"...\"],\n  \"pagination\": { \"...\" },\n  \"order_columns\": [\"created_at\", \"name\", \"role__name\"]\n}\n
     
    Key format uses __ as a separator for relationship chains.
     
    A direct column User.name produces \"name\". A relationship tuple (User.role, Role.name) produces \"role__name\".
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#relationship-loading","level":2,"title":"Relationship loading","text":"
    Added in v1.1
     
    By default, SQLAlchemy relationships are not loaded unless explicitly requested. Instead of using lazy=\"selectin\" on model definitions (which is implicit and applies globally), define a default_load_options on the CRUD class to control loading strategy explicitly.
     
    Warning
     
    Avoid using lazy=\"selectin\" on model relationships. It fires silently on every query, cannot be disabled per-call, and can cause unexpected cascading loads through deep relationship chains. Use default_load_options instead.
     
    from sqlalchemy.orm import selectinload\n\nArticleCrud = CrudFactory(\n    model=Article,\n    default_load_options=[\n        selectinload(Article.category),\n        selectinload(Article.tags),\n    ],\n)\n
     
    default_load_options applies automatically to all read operations (get, first, get_multi, offset_paginate, cursor_paginate). When load_options is passed at call-site, it fully replaces default_load_options for that query — giving you precise per-call control:
     
    # Only loads category, tags are not loaded\narticle = await ArticleCrud.get(\n    session=session,\n    filters=[Article.id == article_id],\n    load_options=[selectinload(Article.category)],\n)\n\n# Loads nothing — useful for write-then-refresh flows or lightweight checks\narticles = await ArticleCrud.get_multi(session=session, load_options=[])\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#many-to-many-relationships","level":2,"title":"Many-to-many relationships","text":"
    Use m2m_fields to map schema fields containing lists of IDs to SQLAlchemy relationships. The CRUD class resolves and validates all IDs before persisting:
     
    PostCrud = CrudFactory(\n    model=Post,\n    m2m_fields={\"tag_ids\": Post.tags},\n)\n\npost = await PostCrud.create(session=session, obj=PostCreateSchema(title=\"Hello\", tag_ids=[1, 2, 3]))\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#upsert","level":2,"title":"Upsert","text":"
    Atomic INSERT ... ON CONFLICT DO UPDATE using PostgreSQL:
     
    await UserCrud.upsert(\n    session=session,\n    obj=UserCreateSchema(email=\"alice@example.com\", username=\"alice\"),\n    index_elements=[User.email],\n    set_={\"username\"},\n)\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#response-serialization","level":2,"title":"Response serialization","text":"
    Added in v1.1
     
    Pass a Pydantic schema class to create, get, update, or offset_paginate to serialize the result directly into that schema and wrap it in a Response[schema] or PaginatedResponse[schema]:
     
    class UserRead(PydanticBase):\n    id: UUID\n    username: str\n\n@router.get(\n    \"/{uuid}\",\n    responses=generate_error_responses(NotFoundError),\n)\nasync def get_user(session: SessionDep, uuid: UUID) -> Response[UserRead]:\n    return await crud.UserCrud.get(\n        session=session,\n        filters=[User.id == uuid],\n        schema=UserRead,\n    )\n\n@router.get(\"\")\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(crud.UserCrud.offset_paginate_params())],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await crud.UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
     
    The schema must have from_attributes=True (or inherit from PydanticBase) so it can be built from SQLAlchemy model instances.
     
     API Reference
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/db/","level":1,"title":"DB","text":"
    SQLAlchemy async session management with transactions, table locking, advisory locking, and row-change polling.
     
    Info
     
    This module has been coded and tested to be compatible with PostgreSQL only.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#overview","level":2,"title":"Overview","text":"
    The db module provides helpers to create FastAPI dependencies and context managers for AsyncSession, along with utilities for nested transactions, table locks, advisory locks, and polling for row changes.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#session-dependency","level":2,"title":"Session dependency","text":"
    Use create_db_dependency to create a FastAPI dependency that yields a session and auto-commits on success:
     
    from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker\nfrom fastapi_toolsets.db import create_db_dependency\n\nengine = create_async_engine(url=\"postgresql+asyncpg://...\", future=True)\nsession_maker = async_sessionmaker(bind=engine, expire_on_commit=False)\n\nget_db = create_db_dependency(session_maker=session_maker)\n\n@router.get(\"/users\")\nasync def list_users(session: AsyncSession = Depends(get_db)):\n    ...\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#session-context-manager","level":2,"title":"Session context manager","text":"
    Use create_db_context for sessions outside request handlers (e.g. background tasks, CLI commands):
     
    from fastapi_toolsets.db import create_db_context\n\ndb_context = create_db_context(session_maker=session_maker)\n\nasync def seed():\n    async with db_context() as session:\n        ...\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#nested-transactions","level":2,"title":"Nested transactions","text":"
    get_transaction handles savepoints automatically, allowing safe nesting:
     
    from fastapi_toolsets.db import get_transaction\n\nasync def create_user_with_role(session=session):\n    async with get_transaction(session=session):\n        ...\n        async with get_transaction(session=session):  # uses savepoint\n            ...\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#table-locking","level":2,"title":"Table locking","text":"
    lock_tables acquires PostgreSQL table-level locks before executing critical sections. It opens a dedicated session internally and yields it to the caller, so the lock is guaranteed to be released when the context exits:
     
    from fastapi_toolsets.db import lock_tables, LockMode\n\nasync with lock_tables(session_maker=session_maker, tables=[User], mode=LockMode.EXCLUSIVE) as session:\n    # No other transaction can modify User until this block exits\n    ...\n
     
    Available lock modes are defined in LockMode: ACCESS_SHARE, ROW_SHARE, ROW_EXCLUSIVE, SHARE_UPDATE_EXCLUSIVE, SHARE, SHARE_ROW_EXCLUSIVE, EXCLUSIVE, ACCESS_EXCLUSIVE.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#advisory-locking","level":2,"title":"Advisory locking","text":"
    advisory_lock acquires a PostgreSQL session-level advisory lock. The lock is released explicitly when the context exits, regardless of whether the transaction has committed.
     
    from fastapi_toolsets.db import advisory_lock\n\n# Blocking exclusive lock — waits until the lock is free\nasync with advisory_lock(session=session, key=42):\n    ...\n\n# Non-blocking — yields False immediately if already held\nasync with advisory_lock(session=session, key=42, nowait=True) as acquired:\n    if not acquired:\n        raise HTTPException(409, \"Resource is locked\")\n\n# Blocking with a timeout — raises DBAPIError if not acquired in time\nasync with advisory_lock(session=session, key=42, timeout=\"5s\"):\n    ...\n\n# Shared — multiple readers allowed simultaneously, blocks exclusive writers\nasync with advisory_lock(session=session, key=42, shared=True):\n    ...\n\n# Two-integer key for namespacing (e.g. lock_type + resource_id)\nasync with advisory_lock(session=session, key=(1, user_id)):\n    ...\n
     
    Note
     
    Advisory locks use PostgreSQL session-level functions (pg_advisory_lock / pg_advisory_unlock). The lock is tied to the database connection, not the SQLAlchemy transaction — it is released when the context exits, even if the surrounding transaction is still open.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#row-change-polling","level":2,"title":"Row-change polling","text":"
    wait_for_row_change polls a row until a specific column changes value, useful for waiting on async side effects:
     
    from fastapi_toolsets.db import wait_for_row_change\n\n# Wait up to 30s for order.status to change\nawait wait_for_row_change(\n    session=session,\n    model=Order,\n    pk_value=order_id,\n    columns=[Order.status],\n    interval=1.0,\n    timeout=30.0,\n)\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#creating-a-database","level":2,"title":"Creating a database","text":"
    Added in v2.1
     
    create_database creates a database at a given URL. It connects to server_url and issues a CREATE DATABASE statement:
     
    from fastapi_toolsets.db import create_database\n\nSERVER_URL = \"postgresql+asyncpg://postgres:postgres@localhost/postgres\"\n\nawait create_database(db_name=\"myapp_test\", server_url=SERVER_URL)\n
     
    For test isolation with automatic cleanup, use create_worker_database from the pytest module instead — it handles drop-before, create, and drop-after automatically.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#cleaning-up-tables","level":2,"title":"Cleaning up tables","text":"
    Added in v2.1
     
    cleanup_tables truncates all tables:
     
    from fastapi_toolsets.db import cleanup_tables\n\n@pytest.fixture(autouse=True)\nasync def clean(db_session):\n    yield\n    await cleanup_tables(session=db_session, base=Base)\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#many-to-many-helpers","level":2,"title":"Many-to-Many helpers","text":"
    SQLAlchemy's ORM collection API triggers lazy-loads when you append to a relationship inside a savepoint (e.g. inside lock_tables or a nested get_transaction). The three m2m_* helpers bypass the ORM collection entirely and issue direct SQL against the association table.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#m2m_add-insert-associations","level":3,"title":"m2m_add — insert associations","text":"
    m2m_add inserts one or more rows into a secondary table without touching the ORM collection:
     
    from fastapi_toolsets.db import lock_tables, m2m_add\n\nasync with lock_tables(session_maker, [Tag]) as session:\n    tag = await TagCrud.create(session, TagCreate(name=\"python\"))\n    await m2m_add(session, post, Post.tags, tag)\n
     
    Pass ignore_conflicts=True to silently skip associations that already exist:
     
    await m2m_add(session, post, Post.tags, tag, ignore_conflicts=True)\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#m2m_remove-delete-associations","level":3,"title":"m2m_remove — delete associations","text":"
    m2m_remove deletes specific association rows. Removing a non-existent association is a no-op:
     
    from fastapi_toolsets.db import get_transaction, m2m_remove\n\nasync with get_transaction(session):\n    await m2m_remove(session, post, Post.tags, tag1, tag2)\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#m2m_set-replace-the-full-set","level":3,"title":"m2m_set — replace the full set","text":"
    m2m_set atomically replaces all associations: it deletes every existing row for the owner instance then inserts the new set. Passing no related instances clears the association entirely:
     
    from fastapi_toolsets.db import get_transaction, m2m_set\n\n# Replace all tags\nasync with get_transaction(session):\n    await m2m_set(session, post, Post.tags, tag_a, tag_b)\n\n# Clear all tags\nasync with get_transaction(session):\n    await m2m_set(session, post, Post.tags)\n
     
    All three helpers raise TypeError if the relationship attribute is not a Many-to-Many (i.e. has no secondary table).
     
     API Reference
    ","path":["Modules","DB"],"tags":[]},{"location":"module/dependencies/","level":1,"title":"Dependencies","text":"
    FastAPI dependency factories for automatic model resolution from path and body parameters.
    ","path":["Modules","Dependencies"],"tags":[]},{"location":"module/dependencies/#overview","level":2,"title":"Overview","text":"
    The dependencies module provides two factory functions that create FastAPI dependencies to fetch a model instance from the database automatically — either from a path parameter or from a request body field — and inject it directly into your route handler.
    ","path":["Modules","Dependencies"],"tags":[]},{"location":"module/dependencies/#pathdependency","level":2,"title":"PathDependency","text":"
    PathDependency resolves a model from a URL path parameter and injects it into the route handler. Raises NotFoundError automatically if the record does not exist.
     
    from fastapi_toolsets.dependencies import PathDependency\n\n# Plain callable\nUserDep = PathDependency(model=User, field=User.id, session_dep=get_db)\n\n# Annotated\nSessionDep = Annotated[AsyncSession, Depends(get_db)]\nUserDep = PathDependency(model=User, field=User.id, session_dep=SessionDep)\n\n@router.get(\"/users/{user_id}\")\nasync def get_user(user: User = UserDep):\n    return user\n
     
    By default the parameter name is inferred from the field (user_id for User.id). You can override it:
     
    UserDep = PathDependency(model=User, field=User.id, session_dep=get_db, param_name=\"id\")\n\n@router.get(\"/users/{id}\")\nasync def get_user(user: User = UserDep):\n    return user\n
    ","path":["Modules","Dependencies"],"tags":[]},{"location":"module/dependencies/#bodydependency","level":2,"title":"BodyDependency","text":"
    BodyDependency resolves a model from a field in the request body. Useful when a body contains a foreign key and you want the full object injected:
     
    from fastapi_toolsets.dependencies import BodyDependency\n\n# Plain callable\nRoleDep = BodyDependency(model=Role, field=Role.id, session_dep=get_db, body_field=\"role_id\")\n\n# Annotated\nSessionDep = Annotated[AsyncSession, Depends(get_db)]\nRoleDep = BodyDependency(model=Role, field=Role.id, session_dep=SessionDep, body_field=\"role_id\")\n\n\n@router.post(\"/users\")\nasync def create_user(body: UserCreateSchema, role: Role = RoleDep):\n    user = User(username=body.username, role=role)\n    ...\n
     
     API Reference
    ","path":["Modules","Dependencies"],"tags":[]},{"location":"module/exceptions/","level":1,"title":"Exceptions","text":"
    Structured API exceptions with consistent error responses and automatic OpenAPI documentation.
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#overview","level":2,"title":"Overview","text":"
    The exceptions module provides a set of pre-built HTTP exceptions and a FastAPI exception handler that formats all errors — including validation errors — into a uniform ErrorResponse.
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#setup","level":2,"title":"Setup","text":"
    Register the exception handlers on your FastAPI app at startup:
     
    from fastapi import FastAPI\nfrom fastapi_toolsets.exceptions import init_exceptions_handlers\n\napp = FastAPI()\ninit_exceptions_handlers(app=app)\n
     
    This registers handlers for:
     
       
    • ApiException — all custom exceptions below
      •  
    • HTTPException — Starlette/FastAPI HTTP errors
      •  
    • RequestValidationError — Pydantic request validation (422)
      •  
    • ResponseValidationError — Pydantic response validation (422)
      •  
    • Exception — unhandled errors (500)
      •  
     
    It also patches app.openapi() to replace the default Pydantic 422 schema with a structured example matching the ErrorResponse format.
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#built-in-exceptions","level":2,"title":"Built-in exceptions","text":"Exception Status Default message UnauthorizedError 401 Unauthorized ForbiddenError 403 Forbidden NotFoundError 404 Not Found ConflictError 409 Conflict NoSearchableFieldsError 400 No Searchable Fields InvalidFacetFilterError 400 Invalid Facet Filter InvalidOrderFieldError 422 Invalid Order Field","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#per-instance-overrides","level":3,"title":"Per-instance overrides","text":"
    All built-in exceptions accept optional keyword arguments to customise the response for a specific raise site without changing the class defaults:
     Argument Effect detail Overrides both str(exc) (log output) and the message field in the response body desc Overrides the description field data Overrides the data field 
    raise NotFoundError(detail=\"User 42 not found\", desc=\"No user with that ID exists in the database.\")\n
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#custom-exceptions","level":2,"title":"Custom exceptions","text":"
    Subclass ApiException and define an api_error class variable:
     
    from fastapi_toolsets.exceptions import ApiException\nfrom fastapi_toolsets.schemas import ApiError\n\nclass PaymentRequiredError(ApiException):\n    api_error = ApiError(\n        code=402,\n        msg=\"Payment Required\",\n        desc=\"Your subscription has expired.\",\n        err_code=\"BILLING-402\",\n    )\n
     
    Warning
     
    Subclasses that do not define api_error raise a TypeError at class creation time, not at raise time.
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#custom-__init__","level":3,"title":"Custom __init__","text":"
    Override __init__ to compute detail, desc, or data dynamically, then delegate to super().__init__():
     
    class OrderValidationError(ApiException):\n    api_error = ApiError(\n        code=422,\n        msg=\"Order Validation Failed\",\n        desc=\"One or more order fields are invalid.\",\n        err_code=\"ORDER-422\",\n    )\n\n    def __init__(self, *field_errors: str) -> None:\n        super().__init__(\n            f\"{len(field_errors)} validation error(s)\",\n            desc=\", \".join(field_errors),\n            data={\"errors\": [{\"message\": e} for e in field_errors]},\n        )\n
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#intermediate-base-classes","level":3,"title":"Intermediate base classes","text":"
    Use abstract=True when creating a shared base that is not meant to be raised directly:
     
    class BillingError(ApiException, abstract=True):\n    \"\"\"Base for all billing-related errors.\"\"\"\n\nclass PaymentRequiredError(BillingError):\n    api_error = ApiError(code=402, msg=\"Payment Required\", desc=\"...\", err_code=\"BILLING-402\")\n\nclass SubscriptionExpiredError(BillingError):\n    api_error = ApiError(code=402, msg=\"Subscription Expired\", desc=\"...\", err_code=\"BILLING-402-EXP\")\n
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#openapi-response-documentation","level":2,"title":"OpenAPI response documentation","text":"
    Use generate_error_responses to add error schemas to your endpoint's OpenAPI spec:
     
    from fastapi_toolsets.exceptions import generate_error_responses, NotFoundError, ForbiddenError\n\n@router.get(\n    \"/users/{id}\",\n    responses=generate_error_responses(NotFoundError, ForbiddenError),\n)\nasync def get_user(...): ...\n
     
    Multiple exceptions sharing the same HTTP status code are grouped under one entry, each appearing as a named example keyed by its err_code. This keeps the OpenAPI UI readable when several error variants map to the same status.
     
     API Reference
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/fixtures/","level":1,"title":"Fixtures","text":"
    Dependency-aware database seeding with context-based loading strategies.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#overview","level":2,"title":"Overview","text":"
    The fixtures module lets you define named fixtures with dependencies between them, then load them into the database in the correct order. Fixtures can be scoped to contexts (e.g. base data, testing data) so that only the relevant ones are loaded for each environment.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#defining-fixtures","level":2,"title":"Defining fixtures","text":"
    from fastapi_toolsets.fixtures import FixtureRegistry, Context\n\nfixtures = FixtureRegistry()\n\n@fixtures.register\ndef roles():\n    return [\n        Role(id=1, name=\"admin\"),\n        Role(id=2, name=\"user\"),\n    ]\n\n@fixtures.register(depends_on=[\"roles\"], contexts=[Context.TESTING])\ndef test_users():\n    return [\n        User(id=1, username=\"alice\", role_id=1),\n        User(id=2, username=\"bob\", role_id=2),\n    ]\n
     
    Dependencies declared via depends_on are resolved topologically — roles will always be loaded before test_users.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#loading-fixtures","level":2,"title":"Loading fixtures","text":"
    By context with load_fixtures_by_context:
     
    from fastapi_toolsets.fixtures import load_fixtures_by_context\n\nasync with db_context() as session:\n    await load_fixtures_by_context(session, fixtures, Context.TESTING)\n
     
    Directly by name with load_fixtures:
     
    from fastapi_toolsets.fixtures import load_fixtures\n\nasync with db_context() as session:\n    await load_fixtures(session, fixtures, \"roles\", \"test_users\")\n
     
    Both functions return a dict[str, list[...]] mapping each fixture name to the list of loaded instances.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#contexts","level":2,"title":"Contexts","text":"
    Context is an enum with predefined values:
     Context Description Context.BASE Core data required in all environments Context.TESTING Data only loaded during tests Context.DEVELOPMENT Data only loaded in development Context.PRODUCTION Data only loaded in production 
    A fixture with no contexts defined takes Context.BASE by default.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#custom-contexts","level":3,"title":"Custom contexts","text":"
    Plain strings and any Enum subclass are accepted wherever a Context enum is expected.
     
    from enum import Enum\n\nclass AppContext(str, Enum):\n    STAGING = \"staging\"\n    DEMO = \"demo\"\n\n@fixtures.register(contexts=[AppContext.STAGING])\ndef staging_data():\n    return [Config(key=\"feature_x\", enabled=True)]\n\nawait load_fixtures_by_context(session, fixtures, AppContext.STAGING)\n
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#default-context-for-a-registry","level":3,"title":"Default context for a registry","text":"
    Pass contexts to FixtureRegistry to set a default for all fixtures registered in it:
     
    testing_registry = FixtureRegistry(contexts=[Context.TESTING])\n\n@testing_registry.register          # implicitly contexts=[Context.TESTING]\ndef test_orders():\n    return [Order(id=1, total=99)]\n
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#same-fixture-name-multiple-context-variants","level":3,"title":"Same fixture name, multiple context variants","text":"
    The same fixture name may be registered under different (non-overlapping) context sets. When multiple contexts are loaded together, all matching variants are merged:
     
    @fixtures.register(contexts=[Context.BASE])\ndef users():\n    return [User(id=1, username=\"admin\")]\n\n@fixtures.register(contexts=[Context.TESTING])\ndef users():\n    return [User(id=2, username=\"tester\")]\n\n# loads both admin and tester\nawait load_fixtures_by_context(session, fixtures, Context.BASE, Context.TESTING)\n
     
    Registering two variants with overlapping context sets raises ValueError.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#load-strategies","level":2,"title":"Load strategies","text":"
    LoadStrategy controls how the fixture loader handles rows that already exist:
     Strategy Description LoadStrategy.INSERT Insert only, fail on duplicates LoadStrategy.MERGE Insert or update on conflict (default) LoadStrategy.SKIP_EXISTING Skip rows that already exist 
    await load_fixtures_by_context(\n    session, fixtures, Context.BASE, strategy=LoadStrategy.SKIP_EXISTING\n)\n
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#merging-registries","level":2,"title":"Merging registries","text":"
    Split fixture definitions across modules and merge them:
     
    from myapp.fixtures.dev import dev_fixtures\nfrom myapp.fixtures.prod import prod_fixtures\n\nfixtures = FixtureRegistry()\nfixtures.include_registry(registry=dev_fixtures)\nfixtures.include_registry(registry=prod_fixtures)\n
     
    Fixtures with the same name are allowed as long as their context sets do not overlap. Conflicting contexts raise ValueError.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#looking-up-fixture-instances","level":2,"title":"Looking up fixture instances","text":"
    get_obj_by_attr retrieves a specific instance from a fixture function by attribute value — useful when building cross-fixture depends_on relationships:
     
    from fastapi_toolsets.fixtures import get_obj_by_attr\n\n@fixtures.register(depends_on=[\"roles\"])\ndef users():\n    admin_role = get_obj_by_attr(roles, \"name\", \"admin\")\n    return [User(id=1, username=\"alice\", role_id=admin_role.id)]\n
     
    Raises StopIteration if no matching instance is found.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#pytest-integration","level":2,"title":"Pytest integration","text":"
    Use register_fixtures to expose each fixture in your registry as an injectable pytest fixture named fixture_{name} by default:
     
    # conftest.py\nimport pytest\nfrom fastapi_toolsets.pytest import create_db_session, register_fixtures\nfrom app.fixtures import registry\nfrom app.models import Base\n\nDATABASE_URL = \"postgresql+asyncpg://user:pass@localhost/test_db\"\n\n@pytest.fixture\nasync def db_session():\n    async with create_db_session(database_url=DATABASE_URL, base=Base, cleanup=True) as session:\n        yield session\n\nregister_fixtures(registry=registry, namespace=globals())\n
     
    # test_users.py\nasync def test_user_can_login(fixture_users: list[User], fixture_roles: list[Role]):\n    ...\n
     
    The load order is resolved automatically from the depends_on declarations in your registry. Each generated fixture receives db_session as a dependency and returns the list of loaded model instances.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#cli-integration","level":2,"title":"CLI integration","text":"
    Fixtures can be triggered from the CLI. See the CLI module for setup instructions.
     
     API Reference
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/logger/","level":1,"title":"Logger","text":"
    Lightweight logging utilities with consistent formatting and uvicorn integration.
    ","path":["Modules","Logger"],"tags":[]},{"location":"module/logger/#overview","level":2,"title":"Overview","text":"
    The logger module provides two helpers: one to configure the root logger (and uvicorn loggers) at startup, and one to retrieve a named logger anywhere in your codebase.
    ","path":["Modules","Logger"],"tags":[]},{"location":"module/logger/#setup","level":2,"title":"Setup","text":"
    Call configure_logging once at application startup:
     
    from fastapi_toolsets.logger import configure_logging\n\nconfigure_logging(level=\"INFO\")\n
     
    This sets up a stdout handler with a consistent format and also configures uvicorn's access and error loggers so all log output shares the same style.
    ","path":["Modules","Logger"],"tags":[]},{"location":"module/logger/#getting-a-logger","level":2,"title":"Getting a logger","text":"
    from fastapi_toolsets.logger import get_logger\n\nlogger = get_logger(name=__name__)\nlogger.info(\"User created\")\n
     
    When called without arguments, get_logger auto-detects the caller's module name via frame inspection:
     
    # Equivalent to get_logger(name=__name__)\nlogger = get_logger()\n
     
     API Reference
    ","path":["Modules","Logger"],"tags":[]},{"location":"module/metrics/","level":1,"title":"Metrics","text":"
    Prometheus metrics integration with a decorator-based registry and multi-process support.
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#installation","level":2,"title":"Installation","text":"uvpip 
    uv add \"fastapi-toolsets[metrics]\"\n
     
    pip install \"fastapi-toolsets[metrics]\"\n
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#overview","level":2,"title":"Overview","text":"
    The metrics module provides a MetricsRegistry to declare Prometheus metrics with decorators, and an init_metrics function to mount a /metrics endpoint on your FastAPI app.
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#setup","level":2,"title":"Setup","text":"
    from fastapi import FastAPI\nfrom fastapi_toolsets.metrics import MetricsRegistry, init_metrics\n\napp = FastAPI()\nmetrics = MetricsRegistry()\n\ninit_metrics(app=app, registry=metrics)\n
     
    This mounts the /metrics endpoint that Prometheus can scrape.
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#declaring-metrics","level":2,"title":"Declaring metrics","text":"","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#providers","level":3,"title":"Providers","text":"
    Providers are called once at startup by init_metrics. The return value (the Prometheus metric object) is stored in the registry and can be retrieved later with registry.get(name).
     
    Use providers when you want deferred initialization: the Prometheus metric is not registered with the global CollectorRegistry until init_metrics runs, not at import time. This is particularly useful for testing — importing the module in a test suite without calling init_metrics leaves no metrics registered, avoiding cross-test pollution.
     
    It is also useful when metrics are defined across multiple modules and merged with include_registry: any code that needs a metric can call metrics.get() on the shared registry instead of importing the metric directly from its origin module.
     
    If neither of these applies to you, declaring metrics at module level (e.g. HTTP_REQUESTS = Counter(...)) is simpler and equally valid.
     
    from prometheus_client import Counter, Histogram\n\n@metrics.register\ndef http_requests():\n    return Counter(\"http_requests_total\", \"Total HTTP requests\", [\"method\", \"status\"])\n\n@metrics.register\ndef request_duration():\n    return Histogram(\"request_duration_seconds\", \"Request duration\")\n
     
    To use a provider's metric elsewhere (e.g. in a middleware), call metrics.get() inside the handler — not at module level, as providers are only initialized when init_metrics runs:
     
    async def metrics_middleware(request: Request, call_next):\n    response = await call_next(request)\n    metrics.get(\"http_requests\").labels(\n        method=request.method, status=response.status_code\n    ).inc()\n    return response\n
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#collectors","level":3,"title":"Collectors","text":"
    Collectors are called on every scrape. Use them for metrics that reflect current state (e.g. gauges).
     
    Declare the metric at module level
     
    Do not instantiate the Prometheus metric inside the collector function. Doing so recreates it on every scrape, raising ValueError: Duplicated timeseries in CollectorRegistry. Declare it once at module level instead:
     
    from prometheus_client import Gauge\n\n_queue_depth = Gauge(\"queue_depth\", \"Current queue depth\")\n\n@metrics.register(collect=True)\ndef collect_queue_depth():\n    _queue_depth.set(get_current_queue_depth())\n
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#merging-registries","level":2,"title":"Merging registries","text":"
    Split metrics definitions across modules and merge them:
     
    from myapp.metrics.http import http_metrics\nfrom myapp.metrics.db import db_metrics\n\nmetrics = MetricsRegistry()\nmetrics.include_registry(registry=http_metrics)\nmetrics.include_registry(registry=db_metrics)\n
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#multi-process-mode","level":2,"title":"Multi-process mode","text":"
    Multi-process support is enabled automatically when the PROMETHEUS_MULTIPROC_DIR environment variable is set. No code changes are required.
     
    Environment variable name
     
    The correct variable is PROMETHEUS_MULTIPROC_DIR (not PROMETHEUS_MULTIPROCESS_DIR).
     
     API Reference
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/models/","level":1,"title":"Models","text":"
    Added in v2.0
     
    Reusable SQLAlchemy 2.0 mixins for common column patterns, designed to be composed freely on any DeclarativeBase model.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#overview","level":2,"title":"Overview","text":"
    The models module provides mixins that each add a single, well-defined column behaviour. They work with standard SQLAlchemy 2.0 declarative syntax and are fully compatible with AsyncSession.
     
    from fastapi_toolsets.models import UUIDMixin, TimestampMixin\n\nclass Article(Base, UUIDMixin, TimestampMixin):\n    __tablename__ = \"articles\"\n\n    title: Mapped[str]\n    content: Mapped[str]\n
     
    All timestamp columns are timezone-aware (TIMESTAMPTZ). All defaults are server-side (clock_timestamp()), so they are also applied when inserting rows via raw SQL outside the ORM.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#mixins","level":2,"title":"Mixins","text":"","path":["Modules","Models"],"tags":[]},{"location":"module/models/#uuidmixin","level":3,"title":"UUIDMixin","text":"
    Adds a id: UUID primary key generated server-side by PostgreSQL using gen_random_uuid(). The value is retrieved via RETURNING after insert, so it is available on the Python object immediately after flush().
     
    Requires PostgreSQL 13+
     
    from fastapi_toolsets.models import UUIDMixin\n\nclass User(Base, UUIDMixin):\n    __tablename__ = \"users\"\n\n    username: Mapped[str]\n\n# id is None before flush\nuser = User(username=\"alice\")\nsession.add(user)\nawait session.flush()\nprint(user.id)  # UUID('...')\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#uuidv7mixin","level":3,"title":"UUIDv7Mixin","text":"
    Added in v2.3
     
    Adds a id: UUID primary key generated server-side by PostgreSQL using uuidv7(). It's a time-ordered UUID format that encodes a millisecond-precision timestamp in the most significant bits, making it naturally sortable and index-friendly.
     
    Requires PostgreSQL 18+
     
    from fastapi_toolsets.models import UUIDv7Mixin\n\nclass Event(Base, UUIDv7Mixin):\n    __tablename__ = \"events\"\n\n    name: Mapped[str]\n\n# id is None before flush\nevent = Event(name=\"user.signup\")\nsession.add(event)\nawait session.flush()\nprint(event.id)  # UUID('019...')\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#createdatmixin","level":3,"title":"CreatedAtMixin","text":"
    Adds a created_at: datetime column set to clock_timestamp() on insert. The column has no onupdate hook — it is intentionally immutable after the row is created.
     
    from fastapi_toolsets.models import UUIDMixin, CreatedAtMixin\n\nclass Order(Base, UUIDMixin, CreatedAtMixin):\n    __tablename__ = \"orders\"\n\n    total: Mapped[float]\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#updatedatmixin","level":3,"title":"UpdatedAtMixin","text":"
    Adds an updated_at: datetime column set to clock_timestamp() on insert and automatically updated to clock_timestamp() on every ORM-level update (via SQLAlchemy's onupdate hook).
     
    from fastapi_toolsets.models import UUIDMixin, UpdatedAtMixin\n\nclass Post(Base, UUIDMixin, UpdatedAtMixin):\n    __tablename__ = \"posts\"\n\n    title: Mapped[str]\n\npost = Post(title=\"Hello\")\nawait session.flush()\nawait session.refresh(post)\n\npost.title = \"Hello World\"\nawait session.flush()\nawait session.refresh(post)\nprint(post.updated_at)\n
     
    Note
     
    updated_at is updated by SQLAlchemy at ORM flush time. If you update rows via raw SQL (e.g. UPDATE posts SET ...), the column will not be updated automatically — use a database trigger if you need that guarantee.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#timestampmixin","level":3,"title":"TimestampMixin","text":"
    Convenience mixin that combines CreatedAtMixin and UpdatedAtMixin. Equivalent to inheriting both.
     
    from fastapi_toolsets.models import UUIDMixin, TimestampMixin\n\nclass Article(Base, UUIDMixin, TimestampMixin):\n    __tablename__ = \"articles\"\n\n    title: Mapped[str]\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#lifecycle-events","level":2,"title":"Lifecycle events","text":"
    The event system provides lifecycle callbacks that fire after commit. If the transaction rolls back, no callback fires.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#setup","level":3,"title":"Setup","text":"
    Event dispatch requires EventSession. Pass it as the session class when creating your session factory:
     
    from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine\nfrom fastapi_toolsets.models import EventSession\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False, class_=EventSession)\n
     
    Callbacks fire on session.commit() only — not on savepoints.
     
    Savepoints created by get_transaction or begin_nested() do not trigger callbacks. All events accumulated across flushes are dispatched once when the outermost commit() is called.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#events","level":3,"title":"Events","text":"
    Three event types are available, each corresponding to a ModelEvent value:
     Event Trigger ModelEvent.CREATE After INSERT commit ModelEvent.DELETE After DELETE commit ModelEvent.UPDATE After UPDATE commit on a watched field 
    Callbacks fire only for ORM-level changes. Rows updated via raw SQL (UPDATE ... SET ...) are not detected.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#watched-fields","level":3,"title":"Watched fields","text":"
    Set __watched_fields__ on the model to restrict which field changes trigger UPDATE events. It must be a tuple[str, ...] — any other type raises TypeError:
     Class attribute UPDATE behaviour __watched_fields__ = (\"status\", \"role\") Only fires when status or role changes (not set) Fires when any mapped field changes 
    __watched_fields__ is inherited through the class hierarchy via normal Python MRO. A subclass can override it:
     
    class Order(Base, UUIDMixin):\n    __watched_fields__ = (\"status\",)\n    ...\n\nclass UrgentOrder(Order):\n    # inherits __watched_fields__ = (\"status\",)\n    ...\n\nclass PriorityOrder(Order):\n    __watched_fields__ = (\"priority\",)\n    # overrides parent — UPDATE fires only for priority changes\n    ...\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#registering-handlers","level":3,"title":"Registering handlers","text":"
    Register handlers with the listens_for decorator. Every callback receives three arguments: the model instance, the ModelEvent that triggered it, and a changes dict (None for CREATE and DELETE):
     
    from fastapi_toolsets.models import ModelEvent, UUIDMixin, listens_for\n\nclass Order(Base, UUIDMixin):\n    __tablename__ = \"orders\"\n    __watched_fields__ = (\"status\",)\n\n    status: Mapped[str]\n\n@listens_for(Order, [ModelEvent.CREATE])\nasync def on_order_created(order: Order, event_type: ModelEvent, changes: None):\n    await notify_new_order(order.id)\n\n@listens_for(Order, [ModelEvent.DELETE])\nasync def on_order_deleted(order: Order, event_type: ModelEvent, changes: None):\n    await notify_order_cancelled(order.id)\n\n@listens_for(Order, [ModelEvent.UPDATE])\nasync def on_order_updated(order: Order, event_type: ModelEvent, changes: dict):\n    if \"status\" in changes:\n        await notify_status_change(order.id, changes[\"status\"])\n
     
    Multiple handlers can be registered for the same model and event. Handlers registered on a parent class also fire for subclass instances.
     
    A single handler can listen for multiple events at once. When event_types is omitted, the handler fires for all events:
     
    @listens_for(Order, [ModelEvent.CREATE, ModelEvent.UPDATE])\nasync def on_order_changed(order: Order, event_type: ModelEvent, changes: dict | None):\n    await invalidate_cache(order.id)\n\n@listens_for(Order)  # all events\nasync def on_any_order_event(order: Order, event_type: ModelEvent, changes: dict | None):\n    await audit_log(order.id, event_type)\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#field-changes-format","level":3,"title":"Field changes format","text":"
    The changes dict maps each watched field that changed to {\"old\": ..., \"new\": ...}. Only fields that actually changed are included. For CREATE and DELETE events, changes is None:
     
    # CREATE / DELETE → changes is None\n# status changed   → {\"status\": {\"old\": \"pending\", \"new\": \"shipped\"}}\n# two fields changed → {\"status\": {...}, \"assigned_to\": {...}}\n
     
    Multiple flushes in one transaction are merged: the earliest old and latest new are preserved, and on_update fires only once per commit.
     
     API Reference
    ","path":["Modules","Models"],"tags":[]},{"location":"module/pytest/","level":1,"title":"Pytest","text":"
    Testing helpers for FastAPI applications with async client, database sessions, and parallel worker support.
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#installation","level":2,"title":"Installation","text":"uvpip 
    uv add \"fastapi-toolsets[pytest]\"\n
     
    pip install \"fastapi-toolsets[pytest]\"\n
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#overview","level":2,"title":"Overview","text":"
    The pytest module provides utilities for setting up async test clients, managing test database sessions, and supporting parallel test execution with pytest-xdist.
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#creating-an-async-client","level":2,"title":"Creating an async client","text":"
    Use create_async_client to get an httpx.AsyncClient configured for your FastAPI app:
     
    from fastapi_toolsets.pytest import create_async_client\n\n@pytest.fixture\nasync def http_client(db_session):\n    async def _override_get_db():\n        yield db_session\n\n    async with create_async_client(\n        app=app,\n        base_url=\"http://127.0.0.1/api/v1\",\n        dependency_overrides={get_db: _override_get_db},\n    ) as c:\n        yield c\n
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#database-sessions-in-tests","level":2,"title":"Database sessions in tests","text":"
    Use create_db_session to create an isolated AsyncSession for a test, combined with create_worker_database to set up a per-worker database:
     
    from fastapi_toolsets.pytest import create_worker_database, create_db_session\n\n@pytest.fixture(scope=\"session\")\nasync def worker_db_url():\n    async with create_worker_database(\n        database_url=str(settings.SQLALCHEMY_DATABASE_URI)\n    ) as url:\n        yield url\n\n\n@pytest.fixture\nasync def db_session(worker_db_url):\n    async with create_db_session(\n        database_url=worker_db_url, base=Base, cleanup=True\n    ) as session:\n        yield session\n
     
    Info
     
    In this example, the database is reset between each test using the argument cleanup=True.
     
    Use worker_database_url to derive the per-worker URL manually if needed:
     
    from fastapi_toolsets.pytest import worker_database_url\n\nurl = worker_database_url(\"postgresql+asyncpg://user:pass@localhost/test_db\", default_test_db=\"test\")\n# e.g. \"postgresql+asyncpg://user:pass@localhost/test_db_gw0\" under xdist\n
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#parallel-testing-with-pytest-xdist","level":2,"title":"Parallel testing with pytest-xdist","text":"
    The examples above are already compatible with parallel test execution with pytest-xdist.
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#cleaning-up-tables","level":2,"title":"Cleaning up tables","text":"
    If you want to manually clean up a database you can use cleanup_tables, this will truncate all tables between tests for fast isolation:
     
    from fastapi_toolsets.db import cleanup_tables\n\n@pytest.fixture(autouse=True)\nasync def clean(db_session):\n    yield\n    await cleanup_tables(session=db_session, base=Base)\n
     
     API Reference
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/schemas/","level":1,"title":"Schemas","text":"
    Standardized Pydantic response models for consistent API responses across your FastAPI application.
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#overview","level":2,"title":"Overview","text":"
    The schemas module provides generic response wrappers that enforce a uniform response structure. All models use from_attributes=True for ORM compatibility and validate_assignment=True for runtime type safety.
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#response-models","level":2,"title":"Response models","text":"","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#responset","level":3,"title":"Response[T]","text":"
    The most common wrapper for a single resource response.
     
    from fastapi_toolsets.schemas import Response\n\n@router.get(\"/users/{id}\")\nasync def get_user(user: User = UserDep) -> Response[UserSchema]:\n    return Response(data=user, message=\"User retrieved\")\n
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#paginated-response-models","level":3,"title":"Paginated response models","text":"
    Three classes wrap paginated list results. Pick the one that matches your endpoint's strategy:
     Class pagination type pagination_type field Use when OffsetPaginatedResponse[T] OffsetPagination \"offset\" (fixed) endpoint always uses offset CursorPaginatedResponse[T] CursorPagination \"cursor\" (fixed) endpoint always uses cursor PaginatedResponse[T] OffsetPagination \\| CursorPagination — unified endpoint supporting both strategies","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#offsetpaginatedresponset","level":4,"title":"OffsetPaginatedResponse[T]","text":"
    Added in v2.3.0
     
    Use as the return type when the endpoint always uses offset_paginate.  The pagination field is guaranteed to be an OffsetPagination object; the response always includes a pagination_type: \"offset\" discriminator.
     
    from fastapi_toolsets.schemas import OffsetPaginatedResponse\n\n@router.get(\"/users\")\nasync def list_users(\n    page: int = 1,\n    items_per_page: int = 20,\n) -> OffsetPaginatedResponse[UserSchema]:\n    return await UserCrud.offset_paginate(\n        session, page=page, items_per_page=items_per_page, schema=UserSchema\n    )\n
     
    Response shape:
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"offset\",\n  \"data\": [\"...\"],\n  \"pagination\": {\n    \"total_count\": 100,\n    \"page\": 1,\n    \"items_per_page\": 20,\n    \"has_more\": true\n  }\n}\n
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#cursorpaginatedresponset","level":4,"title":"CursorPaginatedResponse[T]","text":"
    Added in v2.3.0
     
    Use as the return type when the endpoint always uses cursor_paginate.  The pagination field is guaranteed to be a CursorPagination object; the response always includes a pagination_type: \"cursor\" discriminator.
     
    from fastapi_toolsets.schemas import CursorPaginatedResponse\n\n@router.get(\"/events\")\nasync def list_events(\n    cursor: str | None = None,\n    items_per_page: int = 20,\n) -> CursorPaginatedResponse[EventSchema]:\n    return await EventCrud.cursor_paginate(\n        session, cursor=cursor, items_per_page=items_per_page, schema=EventSchema\n    )\n
     
    Response shape:
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"cursor\",\n  \"data\": [\"...\"],\n  \"pagination\": {\n    \"next_cursor\": \"eyJpZCI6IDQyfQ==\",\n    \"prev_cursor\": null,\n    \"items_per_page\": 20,\n    \"has_more\": true\n  }\n}\n
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#paginatedresponset","level":4,"title":"PaginatedResponse[T]","text":"
    Return type for endpoints that support both pagination strategies via a pagination_type query parameter (using paginate()).
     
    When used as a return annotation, PaginatedResponse[T] automatically expands to Annotated[Union[CursorPaginatedResponse[T], OffsetPaginatedResponse[T]], Field(discriminator=\"pagination_type\")], so FastAPI emits a proper oneOf + discriminator in the OpenAPI schema with no extra boilerplate:
     
    from fastapi_toolsets.crud import PaginationType\nfrom fastapi_toolsets.schemas import PaginatedResponse\n\n@router.get(\"/users\")\nasync def list_users(\n    pagination_type: PaginationType = PaginationType.OFFSET,\n    page: int = 1,\n    cursor: str | None = None,\n    items_per_page: int = 20,\n) -> PaginatedResponse[UserSchema]:\n    return await UserCrud.paginate(\n        session,\n        pagination_type=pagination_type,\n        page=page,\n        cursor=cursor,\n        items_per_page=items_per_page,\n        schema=UserSchema,\n    )\n
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#pagination-metadata-models","level":4,"title":"Pagination metadata models","text":"
    The optional filter_attributes field is populated when facet_fields are configured on the CRUD class (see Filter attributes). It is None by default and can be hidden from API responses with response_model_exclude_none=True.
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#errorresponse","level":3,"title":"ErrorResponse","text":"
    Returned automatically by the exceptions handler.
     
     API Reference
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/security/","level":1,"title":"Security","text":"
    Composable authentication helpers for FastAPI that use Security() for OpenAPI documentation and accept user-provided validator functions with full type flexibility.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#overview","level":2,"title":"Overview","text":"
    The security module provides four auth source classes, a MultiAuth factory, and a set of OAuth 2.0 / OIDC helper utilities. Each auth class wraps a FastAPI security scheme for OpenAPI and accepts a validator function called as:
     
    await validator(credential, **kwargs)\n
     
    where kwargs are the extra keyword arguments provided at instantiation (roles, permissions, enums, etc.). The validator returns the authenticated identity (e.g. a User model) which becomes the route dependency value.
     
    from fastapi import Security\nfrom fastapi_toolsets.security import BearerTokenAuth\n\nasync def verify_token(token: str, *, role: str) -> User:\n    user = await db.get_by_token(token)\n    if not user or user.role != role:\n        raise UnauthorizedError()\n    return user\n\nbearer_admin = BearerTokenAuth(verify_token, role=\"admin\")\n\n@app.get(\"/admin\")\nasync def admin_route(user: User = Security(bearer_admin)):\n    return user\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#auth-sources","level":2,"title":"Auth sources","text":"","path":["Modules","Security"],"tags":[]},{"location":"module/security/#bearertokenauth","level":3,"title":"BearerTokenAuth","text":"
    Reads the Authorization: Bearer <token> header. Wraps HTTPBearer for OpenAPI.
     
    from fastapi_toolsets.security import BearerTokenAuth\n\nbearer = BearerTokenAuth(validator=verify_token)\n\n@app.get(\"/me\")\nasync def me(user: User = Security(bearer)):\n    return user\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#token-prefix","level":4,"title":"Token prefix","text":"
    The optional prefix parameter restricts a BearerTokenAuth instance to tokens that start with a given string. The prefix is kept in the value passed to the validator — store and compare tokens with their prefix included.
     
    This lets you deploy multiple BearerTokenAuth instances in the same application and disambiguate them efficiently in MultiAuth:
     
    user_bearer = BearerTokenAuth(verify_user, prefix=\"user_\")  # matches \"Bearer user_...\"\norg_bearer  = BearerTokenAuth(verify_org,  prefix=\"org_\")   # matches \"Bearer org_...\"\n
     
    Use generate_token() to create correctly-prefixed tokens.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#token-generation","level":4,"title":"Token generation","text":"
    BearerTokenAuth.generate_token() produces a secure random token ready to store in your database and return to the client. If a prefix is configured it is prepended automatically:
     
    bearer = BearerTokenAuth(verify_token, prefix=\"user_\")\n\ntoken = bearer.generate_token()   # e.g. \"user_Xk3mN...\"\nawait db.store_token(user_id, token)\nreturn {\"access_token\": token, \"token_type\": \"bearer\"}\n
     
    The client sends Authorization: Bearer user_Xk3mN... and the validator receives the full token (prefix included) to compare against the stored value.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#cookieauth","level":3,"title":"CookieAuth","text":"
    Reads a named cookie. Wraps APIKeyCookie for OpenAPI.
     
    Cookies are issued with the Secure flag set by default, meaning they are only transmitted over HTTPS. Set secure=False when running locally over plain HTTP:
     
    from fastapi_toolsets.security import CookieAuth\n\n# Production (HTTPS) — default\ncookie_auth = CookieAuth(\"session\", validator=verify_session)\n\n# Local development (HTTP only)\ncookie_auth = CookieAuth(\"session\", validator=verify_session, secure=False)\n\n@app.get(\"/me\")\nasync def me(user: User = Security(cookie_auth)):\n    return user\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#signed-cookies","level":4,"title":"Signed cookies","text":"
    Pass secret_key to enable HMAC-SHA256 signed, tamper-proof cookies. The cookie payload includes an expiry timestamp (ttl, default 24 h). No database entry is required — the signature is self-contained.
     
    Use set_cookie() to issue the signed cookie on login and delete_cookie() to clear it on logout:
     
    # Production\ncookie_auth = CookieAuth(\"session\", verify_session, secret_key=\"your-secret\")\n\n# Local development\ncookie_auth = CookieAuth(\"session\", verify_session, secret_key=\"your-secret\", secure=False)\n\n@app.post(\"/login\")\nasync def login(response: Response):\n    cookie_auth.set_cookie(response, user_id)\n    return {\"ok\": True}\n\n@app.post(\"/logout\")\nasync def logout(response: Response):\n    cookie_auth.delete_cookie(response)\n    return {\"ok\": True}\n\n@app.get(\"/me\")\nasync def me(user: User = Security(cookie_auth)):\n    return user\n
     
    When secret_key is not set, the raw cookie value is passed directly to the validator (stateful session behaviour — you manage the session store).
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#apikeyheaderauth","level":3,"title":"APIKeyHeaderAuth","text":"
    Reads an API key from a named HTTP header. Wraps APIKeyHeader for OpenAPI.
     
    from fastapi_toolsets.security import APIKeyHeaderAuth\n\napi_key_auth = APIKeyHeaderAuth(\"X-API-Key\", validator=verify_api_key)\n\n@app.get(\"/data\")\nasync def data(user: User = Security(api_key_auth)):\n    return user\n
     
    The header name is configurable — use any header your API defines (e.g. \"X-API-Key\", \"Authorization\", \"X-Service-Token\").
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#typed-validator-kwargs","level":2,"title":"Typed validator kwargs","text":"
    All auth classes forward extra instantiation keyword arguments to the validator. Arguments can be any type — enums, strings, integers, etc. The validator returns the authenticated identity, which FastAPI injects directly into the route handler.
     
    async def verify_token(token: str, *, role: Role, permission: str) -> User:\n    user = await decode_token(token)\n    if user.role != role or permission not in user.permissions:\n        raise UnauthorizedError()\n    return user\n\nbearer = BearerTokenAuth(verify_token, role=Role.ADMIN, permission=\"billing:read\")\n
     
    Each auth instance is self-contained — create a separate instance per distinct requirement instead of passing requirements through Security(scopes=[...]).
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#using-require-inline","level":3,"title":"Using .require() inline","text":"
    If declaring a new top-level variable per role feels verbose, use .require() to create a configured clone directly in the route decorator. The original instance is not mutated:
     
    bearer = BearerTokenAuth(verify_token)\n\n@app.get(\"/admin/stats\")\nasync def admin_stats(user: User = Security(bearer.require(role=Role.ADMIN))):\n    return {\"message\": f\"Hello admin {user.name}\"}\n\n@app.get(\"/profile\")\nasync def profile(user: User = Security(bearer.require(role=Role.USER))):\n    return {\"id\": user.id, \"name\": user.name}\n
     
    .require() kwargs are merged over existing ones — new values win on conflict. The prefix (for BearerTokenAuth), cookie name and secret_key (for CookieAuth), and header name (for APIKeyHeaderAuth) are always preserved.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#multiauth","level":2,"title":"MultiAuth","text":"
    MultiAuth combines multiple auth sources into a single callable. Sources are tried in order; the first one that finds a credential wins.
     
    If a credential is extracted but the validator raises, the exception propagates immediately — the remaining sources are not tried. This prevents silent fallthrough on invalid credentials.
     
    from fastapi_toolsets.security import MultiAuth\n\nmulti = MultiAuth(user_bearer, org_bearer, cookie_auth)\n\n@app.get(\"/data\")\nasync def data_route(user = Security(multi)):\n    return user\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#using-require-on-multiauth","level":3,"title":"Using .require() on MultiAuth","text":"
    MultiAuth also supports .require(), which propagates the kwargs to every source that implements it. Sources that do not (e.g. custom AuthSource subclasses) are passed through unchanged:
     
    multi = MultiAuth(bearer, cookie)\n\n@app.get(\"/admin\")\nasync def admin(user: User = Security(multi.require(role=Role.ADMIN))):\n    return user\n
     
    This is equivalent to calling .require() on each source individually:
     
    # These two are identical\nmulti.require(role=Role.ADMIN)\n\nMultiAuth(\n    bearer.require(role=Role.ADMIN),\n    cookie.require(role=Role.ADMIN),\n)\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#prefix-based-dispatch","level":3,"title":"Prefix-based dispatch","text":"
    Because extract() is pure string matching (no I/O), prefix-based source selection is essentially free. Only the matching source's validator (which may involve DB or network I/O) is ever called:
     
    user_bearer = BearerTokenAuth(verify_user, prefix=\"user_\")\norg_bearer  = BearerTokenAuth(verify_org,  prefix=\"org_\")\n\nmulti = MultiAuth(user_bearer, org_bearer)\n\n# \"Bearer user_alice\" → only verify_user runs, receives \"user_alice\"\n# \"Bearer org_acme\"   → only verify_org runs, receives \"org_acme\"\n
     
    Tokens are stored and compared with their prefix — use generate_token() on each source to issue correctly-prefixed tokens:
     
    user_token = user_bearer.generate_token()  # \"user_...\"\norg_token  = org_bearer.generate_token()   # \"org_...\"\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#custom-auth-sources","level":2,"title":"Custom auth sources","text":"
    Subclass AuthSource to implement any credential extraction strategy. You only need to implement extract() and authenticate():
     
    from fastapi_toolsets.security import AuthSource\nfrom fastapi_toolsets.exceptions import UnauthorizedError\n\nclass MTLSAuth(AuthSource):\n    async def extract(self, request) -> str | None:\n        return request.headers.get(\"X-Client-Cert-DN\") or None\n\n    async def authenticate(self, credential: str):\n        dn = parse_dn(credential)\n        if dn.get(\"O\") != \"MyOrg\":\n            raise UnauthorizedError()\n        return {\"dn\": credential}\n
     
    Custom sources work transparently inside MultiAuth.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#oauth-20-oidc-helpers","level":2,"title":"OAuth 2.0 / OIDC helpers","text":"
    The module provides standalone async utilities for building OAuth 2.0 / OIDC login flows. They handle provider discovery, authorization redirects, token exchange, and state encoding — leaving JWT validation and session management to your application.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#provider-discovery","level":3,"title":"Provider discovery","text":"
    oauth_resolve_provider_urls() fetches the OIDC discovery document and returns the endpoint URLs. Results are cached in-process to avoid repeated network calls:
     
    from fastapi_toolsets.security import oauth_resolve_provider_urls\n\nauth_url, token_url, userinfo_url = await oauth_resolve_provider_urls(\n    \"https://accounts.google.com/.well-known/openid-configuration\"\n)\n
     
    Returns a (authorization_url, token_url, userinfo_url) tuple. userinfo_url is None when the provider does not advertise one.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#authorization-redirect","level":3,"title":"Authorization redirect","text":"
    oauth_build_authorization_redirect() constructs the redirect to the provider's authorization page.  It requires a state_token — a random CSRF token generated by oauth_generate_state_token() — that must be stored server-side (e.g. in the session) and verified on the callback to prevent login-CSRF attacks (RFC 6749 §10.12):
     
    from fastapi import Request\nfrom fastapi_toolsets.security import oauth_build_authorization_redirect, oauth_generate_state_token\n\n@app.get(\"/auth/google/login\")\nasync def google_login(request: Request):\n    auth_url, _, _ = await oauth_resolve_provider_urls(GOOGLE_DISCOVERY_URL)\n    state_token = oauth_generate_state_token()\n    request.session[\"oauth_state\"] = state_token  # requires SessionMiddleware\n    return oauth_build_authorization_redirect(\n        auth_url,\n        client_id=GOOGLE_CLIENT_ID,\n        scopes=\"openid email profile\",\n        redirect_uri=\"https://myapp.com/auth/google/callback\",\n        destination=\"/dashboard\",\n        state_token=state_token,\n    )\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#token-exchange-and-userinfo","level":3,"title":"Token exchange and userinfo","text":"
    oauth_fetch_userinfo() performs the two-step exchange: it POSTs the authorization code to the token endpoint, then GETs the userinfo endpoint with the resulting access token.
     
    On the callback, retrieve the stored token and pass it to oauth_decode_state() to verify the CSRF token before processing the code:
     
    from fastapi import HTTPException, Request\nfrom fastapi_toolsets.security import oauth_decode_state, oauth_fetch_userinfo\n\n@app.get(\"/auth/google/callback\")\nasync def google_callback(request: Request, code: str, state: str):\n    # Pop token first — single-use, regardless of whether verification succeeds\n    state_token = request.session.pop(\"oauth_state\", None)\n    if state_token is None:\n        raise HTTPException(status_code=400, detail=\"missing OAuth state\")\n    destination = oauth_decode_state(state, expected_state_token=state_token, fallback=\"/\")\n    if not destination.startswith(\"/\"):  # reject absolute URLs to prevent open-redirect\n        destination = \"/\"\n\n    _, token_url, userinfo_url = await oauth_resolve_provider_urls(GOOGLE_DISCOVERY_URL)\n    userinfo = await oauth_fetch_userinfo(\n        token_url=token_url,\n        userinfo_url=userinfo_url,\n        code=code,\n        client_id=GOOGLE_CLIENT_ID,\n        client_secret=GOOGLE_CLIENT_SECRET,\n        redirect_uri=\"https://myapp.com/auth/google/callback\",\n        required_scopes=\"openid email profile\",\n    )\n    user = await db.upsert_user(email=userinfo[\"email\"])\n    response = RedirectResponse(destination)\n    session_cookie.set_cookie(response, str(user.id))\n    return response\n
     
    Pass required_scopes to guard against providers silently granting fewer scopes than requested — oauth_fetch_userinfo raises ValueError if any are missing.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#state-encoding","level":3,"title":"State encoding","text":"
    oauth_encode_state() and oauth_decode_state() encode and decode the destination URL together with the CSRF token embedded in the OAuth state parameter.  oauth_decode_state returns fallback if state is absent, malformed, or the token does not match:
     
    from fastapi_toolsets.security import oauth_encode_state, oauth_decode_state\n\nstate_token = oauth_generate_state_token()\nencoded = oauth_encode_state(\"/dashboard\", state_token)\ndecoded = oauth_decode_state(encoded, expected_state_token=state_token, fallback=\"/\")  # \"/dashboard\"\ndecoded = oauth_decode_state(encoded, expected_state_token=\"wrong\", fallback=\"/\")  # \"/\"\ndecoded = oauth_decode_state(None, expected_state_token=state_token, fallback=\"/\")       # \"/\"\n
     
     API Reference
    ","path":["Modules","Security"],"tags":[]},{"location":"reference/cli/","level":1,"title":"cli","text":"
    Here's the reference for the CLI configuration helpers used to load settings from pyproject.toml.
     
    You can import them directly from fastapi_toolsets.cli.config:
     
    from fastapi_toolsets.cli.config import (\n    import_from_string,\n    get_config_value,\n    get_fixtures_registry,\n    get_db_context,\n    get_custom_cli,\n)\n
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.import_from_string","level":2,"title":"fastapi_toolsets.cli.config.import_from_string(import_path)","text":"
    Import an object from a dotted string path.
     
    Parameters:
     Name Type Description Default import_path str 
    Import path in \"module.submodule:attribute\" format
     required 
    Returns:
     Type Description Any 
    The imported attribute
     
    Raises:
     Type Description BadParameter 
    If the import path is invalid or import fails
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_config_value","level":2,"title":"fastapi_toolsets.cli.config.get_config_value(key, required=False)","text":"
    get_config_value(key: str, required: Literal[True]) -> Any\n
    get_config_value(\n    key: str, required: bool = False\n) -> Any | None\n
     
    Get a configuration value from pyproject.toml.
     
    Parameters:
     Name Type Description Default key str 
    The configuration key in [tool.fastapi-toolsets].
     required required bool 
    If True, raises an error when the key is missing.
     False 
    Returns:
     Type Description Any | None 
    The configuration value, or None if not found and not required.
     
    Raises:
     Type Description BadParameter 
    If required=True and the key is missing.
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_fixtures_registry","level":2,"title":"fastapi_toolsets.cli.config.get_fixtures_registry()","text":"
    Import and return the fixtures registry from config.
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_db_context","level":2,"title":"fastapi_toolsets.cli.config.get_db_context()","text":"
    Import and return the db_context function from config.
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_custom_cli","level":2,"title":"fastapi_toolsets.cli.config.get_custom_cli()","text":"
    Import and return the custom CLI Typer instance from config.
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.utils.async_command","level":2,"title":"fastapi_toolsets.cli.utils.async_command(func)","text":"
    Decorator to run an async function as a sync CLI command.
     Example 
    @fixture_cli.command(\"load\")\n@async_command\nasync def load(ctx: typer.Context) -> None:\n    async with get_db_context() as session:\n        await load_fixtures(session, registry)\n
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/crud/","level":1,"title":"crud","text":"
    Here's the reference for the CRUD classes, factory, and search utilities.
     
    You can import the main symbols from fastapi_toolsets.crud:
     
    from fastapi_toolsets.crud import CrudFactory, AsyncCrud\nfrom fastapi_toolsets.crud.search import SearchConfig, get_searchable_fields, build_search_filters\n
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud","level":2,"title":"fastapi_toolsets.crud.factory.AsyncCrud","text":"
                   Bases: Generic[ModelType]
     
    Generic async CRUD operations for SQLAlchemy models.
     
    Subclass this and set the model class variable, or use CrudFactory.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.count","level":3,"title":"count(session, filters=None, *, joins=None, outer_join=False)  async classmethod","text":"
    Count records matching the filters.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] | None 
    List of SQLAlchemy filter conditions
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False 
    Returns:
     Type Description int 
    Number of matching records
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.create","level":3,"title":"create(session, obj, *, schema=None)  async classmethod","text":"
    create(\n    session: AsyncSession,\n    obj: BaseModel,\n    *,\n    schema: type[SchemaType],\n) -> Response[SchemaType]\n
    create(\n    session: AsyncSession,\n    obj: BaseModel,\n    *,\n    schema: None = ...,\n) -> ModelType\n
     
    Create a new record in the database.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required obj BaseModel 
    Pydantic model with data to create
     required schema type[BaseModel] | None 
    Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
     None 
    Returns:
     Type Description ModelType | Response[Any] 
    Created model instance, or Response[schema] when schema is given.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.cursor_paginate","level":3,"title":"cursor_paginate(session, *, cursor=None, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, order_joins=None, items_per_page=20, search=None, search_fields=None, search_column=None, order_fields=None, facet_fields=None, filter_by=None, schema)  async classmethod","text":"
    Get paginated results using cursor-based pagination.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session.
     required cursor str | None 
    Cursor string from a previous CursorPagination. Omit (or pass None) to start from the beginning.
     None filters list[Any] | None 
    List of SQLAlchemy filter conditions.
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables.
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN.
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options. Falls back to default_load_options when not provided.
     None order_by OrderByClause | None 
    Additional ordering applied after the cursor column.
     None items_per_page int 
    Number of items per page (default 20).
     20 search str | SearchConfig | None 
    Search query string or SearchConfig object.
     None search_fields Sequence[SearchFieldType] | None 
    Fields to search in (overrides class default).
     None search_column str | None 
    Restrict search to a single column key.
     None order_fields Sequence[OrderFieldType] | None 
    Fields allowed for sorting (overrides class default).
     None facet_fields Sequence[FacetFieldType] | None 
    Columns to compute distinct values for (overrides class default).
     None filter_by dict[str, Any] | BaseModel | None 
    Dict of {column_key: value} to filter by declared facet fields. Keys must match the column.key of a facet field. Scalar → equality, list → IN clause. Raises InvalidFacetFilterError for unknown keys.
     None schema type[BaseModel] 
    Optional Pydantic schema to serialize each item into.
     required 
    Returns:
     Type Description CursorPaginatedResponse[Any] 
    PaginatedResponse with CursorPagination metadata
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.cursor_paginate_params","level":3,"title":"cursor_paginate_params(*, default_page_size=20, max_page_size=100, search=True, filter=True, order=True, search_fields=None, facet_fields=None, order_fields=None, default_order_field=None, default_order='asc')  classmethod","text":"
    Return a FastAPI dependency that collects all params for :meth:cursor_paginate.
     
    Parameters:
     Name Type Description Default default_page_size int 
    Default items_per_page value.
     20 max_page_size int 
    Maximum items_per_page value.
     100 search bool 
    Enable search query parameters.
     True filter bool 
    Enable facet filter query parameters.
     True order bool 
    Enable order query parameters.
     True search_fields Sequence[SearchFieldType] | None 
    Override searchable fields.
     None facet_fields Sequence[FacetFieldType] | None 
    Override facet fields.
     None order_fields Sequence[OrderFieldType] | None 
    Override order fields.
     None default_order_field QueryableAttribute[Any] | None 
    Default field to order by when order_by is absent.
     None default_order Literal['asc', 'desc'] 
    Default sort direction.
     'asc' 
    Returns:
     Name Type Description Callable[..., Awaitable[dict[str, Any]]] 
    An async dependency that resolves to a dict ready to be unpacked
     into Callable[..., Awaitable[dict[str, Any]]] 
    meth:cursor_paginate.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.delete","level":3,"title":"delete(session, filters, *, return_response=False)  async classmethod","text":"
    delete(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    return_response: Literal[True],\n) -> Response[None]\n
    delete(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    return_response: Literal[False] = ...,\n) -> None\n
     
    Delete records from the database.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] 
    List of SQLAlchemy filter conditions
     required return_response bool 
    When True, returns Response[None] instead of None. Useful for API endpoints that expect a consistent response envelope.
     False 
    Returns:
     Type Description None | Response[None] 
    None, or Response[None] when return_response=True.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.exists","level":3,"title":"exists(session, filters, *, joins=None, outer_join=False)  async classmethod","text":"
    Check if a record exists.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] 
    List of SQLAlchemy filter conditions
     required joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False 
    Returns:
     Type Description bool 
    True if at least one record matches
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.first","level":3,"title":"first(session, filters=None, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None)  async classmethod","text":"
    first(\n    session: AsyncSession,\n    filters: list[Any] | None = None,\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: type[SchemaType],\n) -> Response[SchemaType] | None\n
    first(\n    session: AsyncSession,\n    filters: list[Any] | None = None,\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: None = ...,\n) -> ModelType | None\n
     
    Get the first matching record, or None.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] | None 
    List of SQLAlchemy filter conditions
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False with_for_update _ForUpdateMode 
    Lock the row for update
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options (e.g., selectinload)
     None schema type[BaseModel] | None 
    Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
     None 
    Returns:
     Type Description ModelType | Response[Any] | None 
    Model instance, Response[schema] when schema is given,
     ModelType | Response[Any] | None 
    or None when no record matches.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.get","level":3,"title":"get(session, filters, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None)  async classmethod","text":"
    get(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: type[SchemaType],\n) -> Response[SchemaType]\n
    get(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: None = ...,\n) -> ModelType\n
     
    Get exactly one record. Raises NotFoundError if not found.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] 
    List of SQLAlchemy filter conditions
     required joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False with_for_update _ForUpdateMode 
    Lock the row for update
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options (e.g., selectinload)
     None schema type[BaseModel] | None 
    Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
     None 
    Returns:
     Type Description ModelType | Response[Any] 
    Model instance, or Response[schema] when schema is given.
     
    Raises:
     Type Description NotFoundError 
    If no record found
     MultipleResultsFound 
    If more than one record found
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.get_multi","level":3,"title":"get_multi(session, *, filters=None, joins=None, outer_join=False, with_for_update=False, load_options=None, order_by=None, limit=None, offset=None)  async classmethod","text":"
    Get multiple records from the database.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] | None 
    List of SQLAlchemy filter conditions
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False with_for_update _ForUpdateMode 
    Lock rows for update. True for plain FOR UPDATE, \"nowait\" for FOR UPDATE NOWAIT, \"skip_locked\" for FOR UPDATE SKIP LOCKED.
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options
     None order_by OrderByClause | None 
    Column or list of columns to order by
     None limit int | None 
    Max number of rows to return
     None offset int | None 
    Rows to skip
     None 
    Returns:
     Type Description Sequence[ModelType] 
    List of model instances
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.get_or_none","level":3,"title":"get_or_none(session, filters, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None)  async classmethod","text":"
    get_or_none(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: type[SchemaType],\n) -> Response[SchemaType] | None\n
    get_or_none(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: None = ...,\n) -> ModelType | None\n
     
    Get exactly one record, or None if not found.
     
    Like :meth:get but returns None instead of raising :class:~fastapi_toolsets.exceptions.NotFoundError when no record matches the filters.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] 
    List of SQLAlchemy filter conditions
     required joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False with_for_update _ForUpdateMode 
    Lock the row for update
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options (e.g., selectinload)
     None schema type[BaseModel] | None 
    Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
     None 
    Returns:
     Type Description ModelType | Response[Any] | None 
    Model instance, Response[schema] when schema is given,
     ModelType | Response[Any] | None 
    or None when no record matches.
     
    Raises:
     Type Description MultipleResultsFound 
    If more than one record found
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.offset_paginate","level":3,"title":"offset_paginate(session, *, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, order_joins=None, page=1, items_per_page=20, include_total=True, search=None, search_fields=None, search_column=None, order_fields=None, facet_fields=None, filter_by=None, schema)  async classmethod","text":"
    Get paginated results using offset-based pagination.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] | None 
    List of SQLAlchemy filter conditions
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options
     None order_by OrderByClause | None 
    Column or list of columns to order by
     None page int 
    Page number (1-indexed)
     1 items_per_page int 
    Number of items per page
     20 include_total bool 
    When False, skip the COUNT query; pagination.total_count will be None.
     True search str | SearchConfig | None 
    Search query string or SearchConfig object
     None search_fields Sequence[SearchFieldType] | None 
    Fields to search in (overrides class default)
     None search_column str | None 
    Restrict search to a single column key.
     None order_fields Sequence[OrderFieldType] | None 
    Fields allowed for sorting (overrides class default).
     None facet_fields Sequence[FacetFieldType] | None 
    Columns to compute distinct values for (overrides class default)
     None filter_by dict[str, Any] | BaseModel | None 
    Dict of {column_key: value} to filter by declared facet fields. Keys must match the column.key of a facet field. Scalar → equality, list → IN clause. Raises InvalidFacetFilterError for unknown keys.
     None schema type[BaseModel] 
    Pydantic schema to serialize each item into.
     required 
    Returns:
     Type Description OffsetPaginatedResponse[Any] 
    PaginatedResponse with OffsetPagination metadata
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.offset_paginate_params","level":3,"title":"offset_paginate_params(*, default_page_size=20, max_page_size=100, include_total=True, search=True, filter=True, order=True, search_fields=None, facet_fields=None, order_fields=None, default_order_field=None, default_order='asc')  classmethod","text":"
    Return a FastAPI dependency that collects all params for :meth:offset_paginate.
     
    Parameters:
     Name Type Description Default default_page_size int 
    Default items_per_page value.
     20 max_page_size int 
    Maximum items_per_page value.
     100 include_total bool 
    Whether to include total count (not a query param).
     True search bool 
    Enable search query parameters.
     True filter bool 
    Enable facet filter query parameters.
     True order bool 
    Enable order query parameters.
     True search_fields Sequence[SearchFieldType] | None 
    Override searchable fields.
     None facet_fields Sequence[FacetFieldType] | None 
    Override facet fields.
     None order_fields Sequence[OrderFieldType] | None 
    Override order fields.
     None default_order_field QueryableAttribute[Any] | None 
    Default field to order by when order_by is absent.
     None default_order Literal['asc', 'desc'] 
    Default sort direction.
     'asc' 
    Returns:
     Name Type Description Callable[..., Awaitable[dict[str, Any]]] 
    An async dependency that resolves to a dict ready to be unpacked
     into Callable[..., Awaitable[dict[str, Any]]] 
    meth:offset_paginate.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.paginate","level":3,"title":"paginate(session, *, pagination_type=PaginationType.OFFSET, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, order_joins=None, page=1, cursor=None, items_per_page=20, include_total=True, search=None, search_fields=None, search_column=None, order_fields=None, facet_fields=None, filter_by=None, schema)  async classmethod","text":"
    paginate(\n    session: AsyncSession,\n    *,\n    pagination_type: Literal[PaginationType.OFFSET],\n    filters: list[Any] | None = ...,\n    joins: JoinType | None = ...,\n    outer_join: bool = ...,\n    load_options: Sequence[ExecutableOption] | None = ...,\n    order_by: OrderByClause | None = ...,\n    order_joins: list[Any] | None = ...,\n    page: int = ...,\n    cursor: str | None = ...,\n    items_per_page: int = ...,\n    include_total: bool = ...,\n    search: str | SearchConfig | None = ...,\n    search_fields: Sequence[SearchFieldType] | None = ...,\n    search_column: str | None = ...,\n    order_fields: Sequence[OrderFieldType] | None = ...,\n    facet_fields: Sequence[FacetFieldType] | None = ...,\n    filter_by: dict[str, Any] | BaseModel | None = ...,\n    schema: type[BaseModel],\n) -> OffsetPaginatedResponse[Any]\n
    paginate(\n    session: AsyncSession,\n    *,\n    pagination_type: Literal[PaginationType.CURSOR],\n    filters: list[Any] | None = ...,\n    joins: JoinType | None = ...,\n    outer_join: bool = ...,\n    load_options: Sequence[ExecutableOption] | None = ...,\n    order_by: OrderByClause | None = ...,\n    order_joins: list[Any] | None = ...,\n    page: int = ...,\n    cursor: str | None = ...,\n    items_per_page: int = ...,\n    include_total: bool = ...,\n    search: str | SearchConfig | None = ...,\n    search_fields: Sequence[SearchFieldType] | None = ...,\n    search_column: str | None = ...,\n    order_fields: Sequence[OrderFieldType] | None = ...,\n    facet_fields: Sequence[FacetFieldType] | None = ...,\n    filter_by: dict[str, Any] | BaseModel | None = ...,\n    schema: type[BaseModel],\n) -> CursorPaginatedResponse[Any]\n
     
    Get paginated results using either offset or cursor pagination.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session.
     required pagination_type PaginationType 
    Pagination strategy.  Defaults to PaginationType.OFFSET.
     OFFSET filters list[Any] | None 
    List of SQLAlchemy filter conditions.
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables.
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN.
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options.  Falls back to default_load_options when not provided.
     None order_by OrderByClause | None 
    Column or expression to order results by.
     None page int 
    Page number (1-indexed).  Only used when pagination_type is OFFSET.
     1 cursor str | None 
    Cursor token from a previous :class:.CursorPaginatedResponse.  Only used when pagination_type is CURSOR.
     None items_per_page int 
    Number of items per page (default 20).
     20 include_total bool 
    When False, skip the COUNT query; only applies when pagination_type is OFFSET.
     True search str | SearchConfig | None 
    Search query string or :class:.SearchConfig object.
     None search_fields Sequence[SearchFieldType] | None 
    Fields to search in (overrides class default).
     None search_column str | None 
    Restrict search to a single column key.
     None order_fields Sequence[OrderFieldType] | None 
    Fields allowed for sorting (overrides class default).
     None facet_fields Sequence[FacetFieldType] | None 
    Columns to compute distinct values for (overrides class default).
     None filter_by dict[str, Any] | BaseModel | None 
    Dict of {column_key: value} to filter by declared facet fields.  Keys must match the column.key of a facet field.  Scalar → equality, list → IN clause.  Raises :exc:.InvalidFacetFilterError for unknown keys.
     None schema type[BaseModel] 
    Pydantic schema to serialize each item into.
     required 
    Returns:
     Type Description OffsetPaginatedResponse[Any] | CursorPaginatedResponse[Any] 
    class:.OffsetPaginatedResponse when pagination_type is
     OffsetPaginatedResponse[Any] | CursorPaginatedResponse[Any] 
    OFFSET, :class:.CursorPaginatedResponse when it is
     OffsetPaginatedResponse[Any] | CursorPaginatedResponse[Any] 
    CURSOR.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.paginate_params","level":3,"title":"paginate_params(*, default_page_size=20, max_page_size=100, default_pagination_type=PaginationType.OFFSET, include_total=True, search=True, filter=True, order=True, search_fields=None, facet_fields=None, order_fields=None, default_order_field=None, default_order='asc')  classmethod","text":"
    Return a FastAPI dependency that collects all params for :meth:paginate.
     
    Parameters:
     Name Type Description Default default_page_size int 
    Default items_per_page value.
     20 max_page_size int 
    Maximum items_per_page value.
     100 default_pagination_type PaginationType 
    Default pagination strategy.
     OFFSET include_total bool 
    Whether to include total count (not a query param).
     True search bool 
    Enable search query parameters.
     True filter bool 
    Enable facet filter query parameters.
     True order bool 
    Enable order query parameters.
     True search_fields Sequence[SearchFieldType] | None 
    Override searchable fields.
     None facet_fields Sequence[FacetFieldType] | None 
    Override facet fields.
     None order_fields Sequence[OrderFieldType] | None 
    Override order fields.
     None default_order_field QueryableAttribute[Any] | None 
    Default field to order by when order_by is absent.
     None default_order Literal['asc', 'desc'] 
    Default sort direction.
     'asc' 
    Returns:
     Name Type Description Callable[..., Awaitable[dict[str, Any]]] 
    An async dependency that resolves to a dict ready to be unpacked
     into Callable[..., Awaitable[dict[str, Any]]] 
    meth:paginate.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.update","level":3,"title":"update(session, obj, filters, *, exclude_unset=True, exclude_none=False, with_for_update=False, schema=None)  async classmethod","text":"
    update(\n    session: AsyncSession,\n    obj: BaseModel,\n    filters: list[Any],\n    *,\n    exclude_unset: bool = True,\n    exclude_none: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    schema: type[SchemaType],\n) -> Response[SchemaType]\n
    update(\n    session: AsyncSession,\n    obj: BaseModel,\n    filters: list[Any],\n    *,\n    exclude_unset: bool = True,\n    exclude_none: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    schema: None = ...,\n) -> ModelType\n
     
    Update a record in the database.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required obj BaseModel 
    Pydantic model with update data
     required filters list[Any] 
    List of SQLAlchemy filter conditions
     required exclude_unset bool 
    Exclude fields not explicitly set in the schema
     True exclude_none bool 
    Exclude fields with None value
     False with_for_update _ForUpdateMode 
    Lock the row before updating. True for plain FOR UPDATE, \"nowait\" for FOR UPDATE NOWAIT, \"skip_locked\" for FOR UPDATE SKIP LOCKED.
     False schema type[BaseModel] | None 
    Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
     None 
    Returns:
     Type Description ModelType | Response[Any] 
    Updated model instance, or Response[schema] when schema is given.
     
    Raises:
     Type Description NotFoundError 
    If no record found
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.upsert","level":3,"title":"upsert(session, obj, index_elements, *, set_=None, where=None)  async classmethod","text":"
    Create or update a record (PostgreSQL only).
     
    Uses INSERT ... ON CONFLICT for atomic upsert.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required obj BaseModel 
    Pydantic model with data
     required index_elements list[str] 
    Columns for ON CONFLICT (unique constraint)
     required set_ BaseModel | None 
    Pydantic model for ON CONFLICT DO UPDATE SET
     None where WhereHavingRole | None 
    WHERE clause for ON CONFLICT DO UPDATE
     None 
    Returns:
     Type Description ModelType | None 
    Model instance
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.CrudFactory","level":2,"title":"fastapi_toolsets.crud.factory.CrudFactory(model, *, base_class=AsyncCrud, searchable_fields=None, facet_fields=None, order_fields=None, m2m_fields=None, default_load_options=None, cursor_column=None)","text":"
    Create a CRUD class for a specific model.
     
    Parameters:
     Name Type Description Default model type[ModelType] 
    SQLAlchemy model class
     required base_class type[AsyncCrud[Any]] 
    Optional base class to inherit from instead of AsyncCrud. Use this to share custom methods across multiple CRUD classes while still using the factory shorthand.
     AsyncCrud searchable_fields Sequence[SearchFieldType] | None 
    Optional list of searchable fields
     None facet_fields Sequence[FacetFieldType] | None 
    Optional list of columns to compute distinct values for in paginated responses. Supports direct columns (User.status) and relationship tuples ((User.role, Role.name)). Can be overridden per call.
     None order_fields Sequence[OrderFieldType] | None 
    Optional list of model attributes that callers are allowed to order by via offset_paginate_params(). Can be overridden per call.
     None m2m_fields M2MFieldType | None 
    Optional mapping for many-to-many relationships. Maps schema field names (containing lists of IDs) to SQLAlchemy relationship attributes.
     None default_load_options Sequence[ExecutableOption] | None 
    Default SQLAlchemy loader options applied to all read queries when no explicit load_options are passed. Use this instead of lazy=\"selectin\" on the model so that loading strategy is explicit and per-CRUD. Overridden entirely (not merged) when load_options is provided at call-site.
     None cursor_column Any | None 
    Required to call cursor_paginate. Must be monotonically ordered (e.g. integer PK, UUID v7, timestamp). See the cursor pagination docs for supported column types.
     None 
    Returns:
     Type Description type[AsyncCrud[ModelType]] 
    AsyncCrud subclass bound to the model
     Example 
    from fastapi_toolsets.crud import CrudFactory\nfrom myapp.models import User, Post\n\nUserCrud = CrudFactory(User)\nPostCrud = CrudFactory(Post)\n\n# With searchable fields:\nUserCrud = CrudFactory(\n    User,\n    searchable_fields=[User.username, User.email, (User.role, Role.name)]\n)\n\n# With many-to-many fields:\n# Schema has `tag_ids: list[UUID]`, model has `tags` relationship to Tag\nPostCrud = CrudFactory(\n    Post,\n    m2m_fields={\"tag_ids\": Post.tags},\n)\n\n# With facet fields for filter dropdowns / faceted search:\nUserCrud = CrudFactory(\n    User,\n    facet_fields=[User.status, User.country, (User.role, Role.name)],\n)\n\n# With a fixed cursor column for cursor_paginate:\nPostCrud = CrudFactory(\n    Post,\n    cursor_column=Post.created_at,\n)\n\n# With default load strategy (replaces lazy=\"selectin\" on the model):\nArticleCrud = CrudFactory(\n    Article,\n    default_load_options=[selectinload(Article.category), selectinload(Article.tags)],\n)\n\n# Override default_load_options for a specific call:\narticle = await ArticleCrud.get(\n    session,\n    [Article.id == 1],\n    load_options=[selectinload(Article.category)],  # tags won't load\n)\n\n# Usage\nuser = await UserCrud.get(session, [User.id == 1])\nposts = await PostCrud.get_multi(session, filters=[Post.user_id == user.id])\n\n# Create with M2M - tag_ids are automatically resolved\npost = await PostCrud.create(session, PostCreate(title=\"Hello\", tag_ids=[id1, id2]))\n\n# With search\nresult = await UserCrud.offset_paginate(session, search=\"john\")\n\n# With joins (inner join by default):\nusers = await UserCrud.get_multi(\n    session,\n    joins=[(Post, Post.user_id == User.id)],\n    filters=[Post.published == True],\n)\n\n# With outer join:\nusers = await UserCrud.get_multi(\n    session,\n    joins=[(Post, Post.user_id == User.id)],\n    outer_join=True,\n)\n\n# With a shared custom base class:\nfrom typing import Generic, TypeVar\nfrom sqlalchemy.orm import DeclarativeBase\n\nT = TypeVar(\"T\", bound=DeclarativeBase)\n\nclass AuditedCrud(AsyncCrud[T], Generic[T]):\n    @classmethod\n    async def get_active(cls, session):\n        return await cls.get_multi(session, filters=[cls.model.is_active == True])\n\nUserCrud = CrudFactory(User, base_class=AuditedCrud)\n
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.search.SearchConfig","level":2,"title":"fastapi_toolsets.crud.search.SearchConfig  dataclass","text":"
    Advanced search configuration.
     
    Attributes:
     Name Type Description query str 
    The search string
     fields Sequence[SearchFieldType] | None 
    Fields to search (columns or tuples for relationships)
     case_sensitive bool 
    Case-sensitive search (default: False)
     match_mode Literal['any', 'all'] 
    \"any\" (OR) or \"all\" (AND) to combine fields
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.search.get_searchable_fields","level":2,"title":"fastapi_toolsets.crud.search.get_searchable_fields(model, *, include_relationships=True, max_depth=1)  cached","text":"
    Auto-detect String fields on a model and its relationships.
     
    Parameters:
     Name Type Description Default model type[DeclarativeBase] 
    SQLAlchemy model class
     required include_relationships bool 
    Include fields from many-to-one/one-to-one relationships
     True max_depth int 
    Max depth for relationship traversal (default: 1)
     1 
    Returns:
     Type Description list[SearchFieldType] 
    List of columns and tuples (relationship, column)
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.search.build_search_filters","level":2,"title":"fastapi_toolsets.crud.search.build_search_filters(model, search, search_fields=None, default_fields=None, search_column=None)","text":"
    Build SQLAlchemy filter conditions for search.
     
    Parameters:
     Name Type Description Default model type[DeclarativeBase] 
    SQLAlchemy model class
     required search str | SearchConfig 
    Search string or SearchConfig
     required search_fields Sequence[SearchFieldType] | None 
    Fields specified per-call (takes priority)
     None default_fields Sequence[SearchFieldType] | None 
    Default fields (from ClassVar)
     None search_column str | None 
    Optional key to narrow search to a single field. Must match one of the resolved search field keys.
     None 
    Returns:
     Type Description tuple[list[ColumnElement[bool]], list[InstrumentedAttribute[Any]]] 
    Tuple of (filter_conditions, joins_needed)
     
    Raises:
     Type Description NoSearchableFieldsError 
    If no searchable field has been configured
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/db/","level":1,"title":"db","text":"
    Here's the reference for all database session utilities, transaction helpers, and locking functions.
     
    You can import them directly from fastapi_toolsets.db:
     
    from fastapi_toolsets.db import (\n    LockMode,\n    advisory_lock,\n    cleanup_tables,\n    create_database,\n    create_db_dependency,\n    create_db_context,\n    get_transaction,\n    lock_tables,\n    m2m_add,\n    m2m_remove,\n    m2m_set,\n    wait_for_row_change,\n)\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.LockMode","level":2,"title":"fastapi_toolsets.db.LockMode","text":"
                   Bases: str, Enum
     
    PostgreSQL table lock modes.
     
    See: https://www.postgresql.org/docs/current/explicit-locking.html
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.create_db_dependency","level":2,"title":"fastapi_toolsets.db.create_db_dependency(session_maker)","text":"
    Create a FastAPI dependency for database sessions.
     
    Creates a dependency function that yields a session and auto-commits if a transaction is active when the request completes.
     
    Parameters:
     Name Type Description Default session_maker async_sessionmaker[_SessionT] 
    Async session factory from create_session_factory()
     required 
    Returns:
     Type Description Callable[[], AsyncGenerator[_SessionT, None]] 
    An async generator function usable with FastAPI's Depends()
     Example 
    from fastapi import Depends\nfrom sqlalchemy.ext.asyncio import AsyncSession, create_async_engine, async_sessionmaker\nfrom fastapi_toolsets.db import create_db_dependency\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False)\nget_db = create_db_dependency(SessionLocal)\n\n@app.get(\"/users\")\nasync def list_users(session: AsyncSession = Depends(get_db)):\n    ...\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.create_db_context","level":2,"title":"fastapi_toolsets.db.create_db_context(session_maker)","text":"
    Create a context manager for database sessions.
     
    Creates a context manager for use outside of FastAPI request handlers, such as in background tasks, CLI commands, or tests.
     
    Parameters:
     Name Type Description Default session_maker async_sessionmaker[_SessionT] 
    Async session factory from create_session_factory()
     required 
    Returns:
     Type Description Callable[[], AbstractAsyncContextManager[_SessionT]] 
    An async context manager function
     Example 
    from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker\nfrom fastapi_toolsets.db import create_db_context\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False)\nget_db_context = create_db_context(SessionLocal)\n\nasync def background_task():\n    async with get_db_context() as session:\n        user = await UserCrud.get(session, [User.id == 1])\n        ...\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.get_transaction","level":2,"title":"fastapi_toolsets.db.get_transaction(session)  async","text":"
    Get a transaction context, handling nested transactions.
     
    If already in a transaction, creates a savepoint (nested transaction). Otherwise, starts a new transaction.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    AsyncSession instance
     required 
    Yields:
     Type Description AsyncGenerator[AsyncSession, None] 
    The session within the transaction context
     Example 
    async with get_transaction(session):\n    session.add(model)\n    # Auto-commits on exit, rolls back on exception\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.lock_tables","level":2,"title":"fastapi_toolsets.db.lock_tables(session_maker, tables, *, mode=LockMode.SHARE_UPDATE_EXCLUSIVE, timeout='5s')","text":"
    Lock PostgreSQL tables for the duration of a transaction.
     
    Parameters:
     Name Type Description Default session_maker async_sessionmaker[_SessionT] 
    Async session factory used to create the dedicated session.
     required tables list[type[DeclarativeBase]] 
    List of SQLAlchemy model classes to lock.
     required mode LockMode 
    Lock mode (default: SHARE UPDATE EXCLUSIVE).
     SHARE_UPDATE_EXCLUSIVE timeout str 
    Lock timeout (default: \"5s\").
     '5s' 
    Yields:
     Type Description AbstractAsyncContextManager[_SessionT] 
    The dedicated session, open within the locked transaction.
     
    Raises:
     Type Description SQLAlchemyError 
    If the lock cannot be acquired within timeout.
     Example 
    from fastapi_toolsets.db import lock_tables, LockMode\n\nasync with lock_tables(session_maker, [User, Account]) as session:\n    # Tables are locked; changes are committed when the context exits.\n    user = await UserCrud.get(session, [User.id == 1])\n    user.balance += 100\n\n# With custom lock mode\nasync with lock_tables(session_maker, [Order], mode=LockMode.EXCLUSIVE) as session:\n    await process_order(session, order_id)\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.advisory_lock","level":2,"title":"fastapi_toolsets.db.advisory_lock(session, key, *, shared=False, nowait=False, timeout=None)  async","text":"
    Acquire a PostgreSQL session-level advisory lock.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    AsyncSession instance.
     required key int | tuple[int, int] 
    Lock key — a single int (bigint) or a (int, int) pair for namespacing.
     required shared bool 
    Acquire a shared lock (multiple holders allowed). Default is exclusive.
     False nowait bool 
    Return False immediately if the lock is unavailable instead of waiting.
     False timeout str | None 
    Maximum wait time (e.g. \"5s\", \"500ms\"). Raises DBAPIError if exceeded. Ignored when nowait is True.
     None 
    Yields:
     Type Description AsyncGenerator[bool, None] 
    True if the lock was acquired, False if nowait is True and the lock
     AsyncGenerator[bool, None] 
    is already held.
     
    Raises:
     Type Description DBAPIError 
    If timeout is set and the lock cannot be acquired in time.
     Example 
    from fastapi_toolsets.db import advisory_lock\n\nasync with advisory_lock(session, 42):\n    ...\n\nasync with advisory_lock(session, 42, nowait=True) as acquired:\n    if not acquired:\n        raise HTTPException(409, \"Resource is locked\")\n\nasync with advisory_lock(session, 42, timeout=\"5s\"):\n    ...\n\nasync with advisory_lock(session, (1, user_id), shared=True):\n    ...\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.wait_for_row_change","level":2,"title":"fastapi_toolsets.db.wait_for_row_change(session, model, pk_value, *, columns=None, interval=0.5, timeout=None)  async","text":"
    Poll a database row until a change is detected.
     
    Queries the row every interval seconds and returns the model instance once a change is detected in any column (or only the specified columns).
     
    Parameters:
     Name Type Description Default session AsyncSession 
    AsyncSession instance
     required model type[_M] 
    SQLAlchemy model class
     required pk_value Any 
    Primary key value of the row to watch
     required columns list[str] | None 
    Optional list of column names to watch. If None, all columns      are watched.
     None interval float 
    Polling interval in seconds (default: 0.5)
     0.5 timeout float | None 
    Maximum time to wait in seconds. None means wait forever.
     None 
    Returns:
     Type Description _M 
    The refreshed model instance with updated values
     
    Raises:
     Type Description NotFoundError 
    If the row does not exist or is deleted during polling
     TimeoutError 
    If timeout expires before a change is detected
     Example 
    from fastapi_toolsets.db import wait_for_row_change\n\n# Wait for any column to change\nupdated = await wait_for_row_change(session, User, user_id)\n\n# Watch specific columns with a timeout\nupdated = await wait_for_row_change(\n    session, User, user_id,\n    columns=[\"status\", \"email\"],\n    interval=1.0,\n    timeout=30.0,\n)\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.create_database","level":2,"title":"fastapi_toolsets.db.create_database(db_name, *, server_url)  async","text":"
    Create a database.
     
    Connects to server_url using AUTOCOMMIT isolation and issues a CREATE DATABASE statement for db_name.
     
    Parameters:
     Name Type Description Default db_name str 
    Name of the database to create.
     required server_url str 
    URL used for server-level DDL (must point to an existing database on the same server).
     required Example 
    from fastapi_toolsets.db import create_database\n\nSERVER_URL = \"postgresql+asyncpg://postgres:postgres@localhost/postgres\"\nawait create_database(\"myapp_test\", server_url=SERVER_URL)\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.cleanup_tables","level":2,"title":"fastapi_toolsets.db.cleanup_tables(session, base)  async","text":"
    Truncate all tables for fast between-test cleanup.
     
    Executes a single TRUNCATE … RESTART IDENTITY CASCADE statement across every table in base's metadata, which is significantly faster than dropping and re-creating tables between tests.
     
    This is a no-op when the metadata contains no tables.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    An active async database session.
     required base type[DeclarativeBase] 
    SQLAlchemy DeclarativeBase class containing model metadata.
     required Example 
    @pytest.fixture\nasync def db_session(worker_db_url):\n    async with create_db_session(worker_db_url, Base) as session:\n        yield session\n        await cleanup_tables(session, Base)\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.m2m_add","level":2,"title":"fastapi_toolsets.db.m2m_add(session, instance, rel_attr, *related, ignore_conflicts=False)  async","text":"
    Insert rows into a Many-to-Many association table without loading the ORM collection.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session.
     required instance DeclarativeBase 
    The \"owner\" side model instance (e.g. the A in A.b_list).
     required rel_attr QueryableAttribute 
    The M2M relationship attribute on the model class (e.g. A.b_list).
     required *related DeclarativeBase 
    One or more related instances to associate with instance.
     () ignore_conflicts bool 
    When True, silently skip rows that already exist in the association table (ON CONFLICT DO NOTHING).
     False 
    Raises:
     Type Description TypeError 
    If rel_attr is not a Many-to-Many relationship.
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.m2m_remove","level":2,"title":"fastapi_toolsets.db.m2m_remove(session, instance, rel_attr, *related)  async","text":"
    Remove rows from a Many-to-Many association table without loading the ORM collection.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session.
     required instance DeclarativeBase 
    The \"owner\" side model instance (e.g. the A in A.b_list).
     required rel_attr QueryableAttribute 
    The M2M relationship attribute on the model class (e.g. A.b_list).
     required *related DeclarativeBase 
    One or more related instances to disassociate from instance.
     () 
    Raises:
     Type Description TypeError 
    If rel_attr is not a Many-to-Many relationship.
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.m2m_set","level":2,"title":"fastapi_toolsets.db.m2m_set(session, instance, rel_attr, *related)  async","text":"
    Replace the entire Many-to-Many association set atomically.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session.
     required instance DeclarativeBase 
    The \"owner\" side model instance (e.g. the A in A.b_list).
     required rel_attr QueryableAttribute 
    The M2M relationship attribute on the model class (e.g. A.b_list).
     required *related DeclarativeBase 
    The new complete set of related instances.
     () 
    Raises:
     Type Description TypeError 
    If rel_attr is not a Many-to-Many relationship.
    ","path":["Reference","db"],"tags":[]},{"location":"reference/dependencies/","level":1,"title":"dependencies","text":"
    Here's the reference for the FastAPI dependency factory functions.
     
    You can import them directly from fastapi_toolsets.dependencies:
     
    from fastapi_toolsets.dependencies import PathDependency, BodyDependency\n
    ","path":["Reference","dependencies"],"tags":[]},{"location":"reference/dependencies/#fastapi_toolsets.dependencies.PathDependency","level":2,"title":"fastapi_toolsets.dependencies.PathDependency(model, field, *, session_dep, param_name=None)","text":"
    Create a dependency that fetches a DB object from a path parameter.
     
    Parameters:
     Name Type Description Default model type[ModelType] 
    SQLAlchemy model class
     required field Any 
    Model field to filter by (e.g., User.id)
     required session_dep SessionDependency 
    Session dependency function (e.g., get_db)
     required param_name str | None 
    Path parameter name (defaults to model_field, e.g., user_id)
     None 
    Returns:
     Type Description ModelType 
    A Depends() instance that resolves to the model instance
     
    Raises:
     Type Description NotFoundError 
    If no matching record is found
     Example 
    UserDep = PathDependency(User, User.id, session_dep=get_db)\n\n@router.get(\"/user/{id}\")\nasync def get(\n    user: User = UserDep,\n): ...\n
    ","path":["Reference","dependencies"],"tags":[]},{"location":"reference/dependencies/#fastapi_toolsets.dependencies.BodyDependency","level":2,"title":"fastapi_toolsets.dependencies.BodyDependency(model, field, *, session_dep, body_field)","text":"
    Create a dependency that fetches a DB object from a body field.
     
    Parameters:
     Name Type Description Default model type[ModelType] 
    SQLAlchemy model class
     required field Any 
    Model field to filter by (e.g., User.id)
     required session_dep SessionDependency 
    Session dependency function (e.g., get_db)
     required body_field str 
    Name of the field in the request body
     required 
    Returns:
     Type Description ModelType 
    A Depends() instance that resolves to the model instance
     
    Raises:
     Type Description NotFoundError 
    If no matching record is found
     Example 
    UserDep = BodyDependency(\n    User, User.ctfd_id, session_dep=get_db, body_field=\"user_id\"\n)\n\n@router.post(\"/assign\")\nasync def assign(\n    user: User = UserDep,\n): ...\n
    ","path":["Reference","dependencies"],"tags":[]},{"location":"reference/exceptions/","level":1,"title":"exceptions","text":"
    Here's the reference for all exception classes and handler utilities.
     
    You can import them directly from fastapi_toolsets.exceptions:
     
    from fastapi_toolsets.exceptions import (\n    ApiException,\n    UnauthorizedError,\n    ForbiddenError,\n    NotFoundError,\n    ConflictError,\n    NoSearchableFieldsError,\n    InvalidSearchColumnError,\n    InvalidFacetFilterError,\n    InvalidOrderFieldError,\n    generate_error_responses,\n    init_exceptions_handlers,\n)\n
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ApiException","level":2,"title":"fastapi_toolsets.exceptions.exceptions.ApiException","text":"
                   Bases: Exception
     
    Base exception for API errors with structured response.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ApiException.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.UnauthorizedError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.UnauthorizedError","text":"
                   Bases: ApiException
     
    HTTP 401 - User is not authenticated.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.UnauthorizedError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ForbiddenError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.ForbiddenError","text":"
                   Bases: ApiException
     
    HTTP 403 - User lacks required permissions.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ForbiddenError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NotFoundError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.NotFoundError","text":"
                   Bases: ApiException
     
    HTTP 404 - Resource not found.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NotFoundError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ConflictError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.ConflictError","text":"
                   Bases: ApiException
     
    HTTP 409 - Resource conflict.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ConflictError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError","text":"
                   Bases: ApiException
     
    Raised when search is requested but no searchable fields are available.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError.__init__","level":3,"title":"__init__(model)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default model type 
    The model class that has no searchable fields configured.
     required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidSearchColumnError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.InvalidSearchColumnError","text":"
                   Bases: ApiException
     
    Raised when search_column is not one of the configured searchable fields.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidSearchColumnError.__init__","level":3,"title":"__init__(column, valid_columns)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default column str 
    The unknown search column provided by the caller.
     required valid_columns list[str] 
    List of valid search column keys.
     required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidFacetFilterError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.InvalidFacetFilterError","text":"
                   Bases: ApiException
     
    Raised when filter_by contains a key not declared in facet_fields.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidFacetFilterError.__init__","level":3,"title":"__init__(key, valid_keys)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default key str 
    The unknown filter key provided by the caller.
     required valid_keys set[str] 
    Set of valid keys derived from the declared facet_fields.
     required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidOrderFieldError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.InvalidOrderFieldError","text":"
                   Bases: ApiException
     
    Raised when order_by contains a field not in the allowed order fields.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidOrderFieldError.__init__","level":3,"title":"__init__(field, valid_fields)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default field str 
    The unknown order field provided by the caller.
     required valid_fields list[str] 
    List of valid field names.
     required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.generate_error_responses","level":2,"title":"fastapi_toolsets.exceptions.exceptions.generate_error_responses(*errors)","text":"
    Generate OpenAPI response documentation for exceptions.
     
    Parameters:
     Name Type Description Default *errors type[ApiException] 
    Exception classes that inherit from ApiException.
     () 
    Returns:
     Type Description dict[int | str, dict[str, Any]] 
    Dict suitable for FastAPI's responses parameter.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.handler.init_exceptions_handlers","level":2,"title":"fastapi_toolsets.exceptions.handler.init_exceptions_handlers(app)","text":"
    Register exception handlers and custom OpenAPI schema on a FastAPI app.
     
    Parameters:
     Name Type Description Default app FastAPI 
    FastAPI application instance.
     required 
    Returns:
     Type Description FastAPI 
    The same FastAPI instance (for chaining).
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/fixtures/","level":1,"title":"fixtures","text":"
    Here's the reference for the fixture registry, enums, and loading utilities.
     
    You can import them directly from fastapi_toolsets.fixtures:
     
    from fastapi_toolsets.fixtures import (\n    Context,\n    LoadStrategy,\n    Fixture,\n    FixtureRegistry,\n    load_fixtures,\n    load_fixtures_by_context,\n    get_obj_by_attr,\n)\n
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context","level":2,"title":"fastapi_toolsets.fixtures.enum.Context","text":"
                   Bases: str, Enum
     
    Predefined fixture contexts.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.BASE","level":3,"title":"BASE = 'base'  class-attribute instance-attribute","text":"
    Base fixtures loaded in all environments.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.DEVELOPMENT","level":3,"title":"DEVELOPMENT = 'development'  class-attribute instance-attribute","text":"
    Development fixtures.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.PRODUCTION","level":3,"title":"PRODUCTION = 'production'  class-attribute instance-attribute","text":"
    Production-only fixtures.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.TESTING","level":3,"title":"TESTING = 'testing'  class-attribute instance-attribute","text":"
    Test fixtures.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy","level":2,"title":"fastapi_toolsets.fixtures.enum.LoadStrategy","text":"
                   Bases: str, Enum
     
    Strategy for loading fixtures into the database.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy.INSERT","level":3,"title":"INSERT = 'insert'  class-attribute instance-attribute","text":"
    Insert new records. Fails if record already exists.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy.MERGE","level":3,"title":"MERGE = 'merge'  class-attribute instance-attribute","text":"
    Insert or update based on primary key (SQLAlchemy merge).
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy.SKIP_EXISTING","level":3,"title":"SKIP_EXISTING = 'skip_existing'  class-attribute instance-attribute","text":"
    Insert only if record doesn't exist (based on primary key).
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.Fixture","level":2,"title":"fastapi_toolsets.fixtures.registry.Fixture  dataclass","text":"
    A fixture definition with metadata.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry","level":2,"title":"fastapi_toolsets.fixtures.registry.FixtureRegistry","text":"
    Registry for managing fixtures with dependencies.
     Example 
    from fastapi_toolsets.fixtures import FixtureRegistry, Context\n\nfixtures = FixtureRegistry()\n\n@fixtures.register\ndef roles():\n    return [\n        Role(id=1, name=\"admin\"),\n        Role(id=2, name=\"user\"),\n    ]\n\n@fixtures.register(depends_on=[\"roles\"])\ndef users():\n    return [\n        User(id=1, username=\"admin\", role_id=1),\n    ]\n\n@fixtures.register(depends_on=[\"users\"], contexts=[Context.TESTING])\ndef test_data():\n    return [\n        Post(id=1, title=\"Test\", user_id=1),\n    ]\n
     
    Fixtures with the same name may be registered for different contexts. When multiple contexts are loaded together, their instances are merged:
     
    ```python\n@fixtures.register(contexts=[Context.BASE])\ndef users():\n    return [User(id=1, username=\"admin\")]\n\n@fixtures.register(contexts=[Context.TESTING])\ndef users():\n    return [User(id=2, username=\"tester\")]\n# load_fixtures_by_context(..., Context.BASE, Context.TESTING)\n# → loads both User(admin) and User(tester) under the \"users\" name\n```\n
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.get","level":3,"title":"get(name)","text":"
    Get a fixture by name.
     
    Raises:
     Type Description KeyError 
    If no fixture with name is registered.
     ValueError 
    If the fixture has multiple context variants — use :meth:get_variants in that case.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.get_all","level":3,"title":"get_all()","text":"
    Get all registered fixtures (all variants of all names).
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.get_by_context","level":3,"title":"get_by_context(*contexts)","text":"
    Get fixtures for specific contexts.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.get_variants","level":3,"title":"get_variants(name, *contexts)","text":"
    Return all registered variants for name, optionally filtered by context.
     
    Parameters:
     Name Type Description Default name str 
    Fixture name.
     required *contexts str | Enum 
    If given, only return variants whose context set intersects with these values.  Both :class:Context enum values and plain strings are accepted.
     () 
    Returns:
     Type Description list[Fixture] 
    List of matching :class:Fixture objects (may be empty when a
     list[Fixture] 
    context filter is applied and nothing matches).
     
    Raises:
     Type Description KeyError 
    If no fixture with name is registered.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.include_registry","level":3,"title":"include_registry(registry)","text":"
    Include another FixtureRegistry in the same current FixtureRegistry.
     
    Fixtures with the same name are allowed as long as their context sets do not overlap.  Conflicting contexts raise :class:ValueError.
     
    Parameters:
     Name Type Description Default registry FixtureRegistry 
    The FixtureRegistry to include
     required 
    Raises:
     Type Description ValueError 
    If a fixture name already exists with overlapping contexts
     Example 
    registry = FixtureRegistry()\ndev_registry = FixtureRegistry()\n\n@dev_registry.register\ndef dev_data():\n    return [...]\n\nregistry.include_registry(registry=dev_registry)\n
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.register","level":3,"title":"register(func=None, *, name=None, depends_on=None, contexts=None)","text":"
    Register a fixture function.
     
    Can be used as a decorator with or without arguments.
     
    Parameters:
     Name Type Description Default func Callable[[], Sequence[DeclarativeBase]] | None 
    Fixture function returning list of model instances
     None name str | None 
    Fixture name (defaults to function name)
     None depends_on list[str] | None 
    List of fixture names this depends on
     None contexts list[str | Enum] | None 
    List of contexts this fixture belongs to.  Both :class:Context enum values and plain strings are accepted.
     None Example 
    ```python @fixtures.register def roles():     return [Role(id=1, name=\"admin\")]
     
    @fixtures.register(depends_on=[\"roles\"], contexts=[Context.TESTING]) def test_users():     return [User(id=1, username=\"test\", role_id=1)]
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.resolve_context_dependencies","level":3,"title":"resolve_context_dependencies(*contexts)","text":"
    Resolve all fixtures for contexts with dependencies.
     
    Parameters:
     Name Type Description Default *contexts str | Enum 
    Contexts to load
     () 
    Returns:
     Type Description list[str] 
    List of fixture names in load order
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.resolve_dependencies","level":3,"title":"resolve_dependencies(*names)","text":"
    Resolve fixture dependencies in topological order.
     
    When a fixture name has multiple context variants, the union of all variants' depends_on lists is used.
     
    Parameters:
     Name Type Description Default *names str 
    Fixture names to resolve
     () 
    Returns:
     Type Description list[str] 
    List of fixture names in load order (dependencies first)
     
    Raises:
     Type Description KeyError 
    If a fixture is not found
     ValueError 
    If circular dependency detected
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.utils.load_fixtures","level":2,"title":"fastapi_toolsets.fixtures.utils.load_fixtures(session, registry, *names, strategy=LoadStrategy.MERGE)  async","text":"
    Load specific fixtures by name with dependencies.
     
    All context variants of each requested fixture are loaded and merged.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    Database session
     required registry FixtureRegistry 
    Fixture registry
     required *names str 
    Fixture names to load (dependencies auto-resolved)
     () strategy LoadStrategy 
    How to handle existing records
     MERGE 
    Returns:
     Type Description dict[str, list[DeclarativeBase]] 
    Dict mapping fixture names to loaded instances
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.utils.load_fixtures_by_context","level":2,"title":"fastapi_toolsets.fixtures.utils.load_fixtures_by_context(session, registry, *contexts, strategy=LoadStrategy.MERGE)  async","text":"
    Load all fixtures for specific contexts.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    Database session
     required registry FixtureRegistry 
    Fixture registry
     required *contexts str | Enum 
    Contexts to load (e.g., Context.BASE, Context.TESTING, or plain strings for custom contexts)
     () strategy LoadStrategy 
    How to handle existing records
     MERGE 
    Returns:
     Type Description dict[str, list[DeclarativeBase]] 
    Dict mapping fixture names to loaded instances
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.utils.get_obj_by_attr","level":2,"title":"fastapi_toolsets.fixtures.utils.get_obj_by_attr(fixtures, attr_name, value)","text":"
    Get a SQLAlchemy model instance by matching an attribute value.
     
    Parameters:
     Name Type Description Default fixtures Callable[[], Sequence[ModelType]] 
    A fixture function registered via @registry.register that returns a sequence of SQLAlchemy model instances.
     required attr_name str 
    Name of the attribute to match against.
     required value Any 
    Value to match.
     required 
    Returns:
     Type Description ModelType 
    The first model instance where the attribute matches the given value.
     
    Raises:
     Type Description StopIteration 
    If no matching object is found in the fixture group.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/logger/","level":1,"title":"logger","text":"
    Here's the reference for the logging utilities.
     
    You can import them directly from fastapi_toolsets.logger:
     
    from fastapi_toolsets.logger import configure_logging, get_logger\n
    ","path":["Reference","logger"],"tags":[]},{"location":"reference/logger/#fastapi_toolsets.logger.configure_logging","level":2,"title":"fastapi_toolsets.logger.configure_logging(level='INFO', fmt=DEFAULT_FORMAT, logger_name=None)","text":"
    Configure logging with a stdout handler and consistent format.
     
    Sets up a :class:~logging.StreamHandler writing to stdout with the given format and level.  Also configures the uvicorn loggers so that FastAPI access logs use the same format.
     
    Calling this function multiple times is safe -- existing handlers are replaced rather than duplicated.
     
    Parameters:
     Name Type Description Default level LogLevel | int 
    Log level (e.g. \"DEBUG\", \"INFO\", or logging.DEBUG).
     'INFO' fmt str 
    Log format string.  Defaults to \"%(asctime)s - %(name)s - %(levelname)s - %(message)s\".
     DEFAULT_FORMAT logger_name str | None 
    Logger name to configure.  None (the default) configures the root logger so all loggers inherit the settings.
     None 
    Returns:
     Type Description Logger 
    The configured Logger instance.
     Example 
    from fastapi_toolsets.logger import configure_logging\n\nlogger = configure_logging(\"DEBUG\")\nlogger.info(\"Application started\")\n
    ","path":["Reference","logger"],"tags":[]},{"location":"reference/logger/#fastapi_toolsets.logger.get_logger","level":2,"title":"fastapi_toolsets.logger.get_logger(name=_SENTINEL)","text":"
    Return a logger with the given name.
     
    A thin convenience wrapper around :func:logging.getLogger that keeps logging imports consistent across the codebase.
     
    When called without arguments, the caller's __name__ is used automatically, so get_logger() in a module is equivalent to logging.getLogger(__name__).  Pass None explicitly to get the root logger.
     
    Parameters:
     Name Type Description Default name str | None 
    Logger name.  Defaults to the caller's __name__. Pass None to get the root logger.
     _SENTINEL 
    Returns:
     Type Description Logger 
    A Logger instance.
     Example 
    from fastapi_toolsets.logger import get_logger\n\nlogger = get_logger()          # uses caller's __name__\nlogger = get_logger(\"myapp\")   # explicit name\nlogger = get_logger(None)      # root logger\n
    ","path":["Reference","logger"],"tags":[]},{"location":"reference/metrics/","level":1,"title":"metrics","text":"
    Here's the reference for the Prometheus metrics registry and endpoint handler.
     
    You can import them directly from fastapi_toolsets.metrics:
     
    from fastapi_toolsets.metrics import Metric, MetricsRegistry, init_metrics\n
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.Metric","level":2,"title":"fastapi_toolsets.metrics.registry.Metric  dataclass","text":"
    A metric definition with metadata.
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry","level":2,"title":"fastapi_toolsets.metrics.registry.MetricsRegistry","text":"
    Registry for managing Prometheus metric providers and collectors.
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get","level":3,"title":"get(name)","text":"
    Return the metric instance created by a provider.
     
    Parameters:
     Name Type Description Default name str 
    The metric name (defaults to the provider function name).
     required 
    Raises:
     Type Description KeyError 
    If the metric name is unknown or init_metrics has not been called yet.
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get_all","level":3,"title":"get_all()","text":"
    Get all registered metric definitions.
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get_collectors","level":3,"title":"get_collectors()","text":"
    Get collectors (called on each scrape).
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get_providers","level":3,"title":"get_providers()","text":"
    Get metric providers (called once at init).
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.include_registry","level":3,"title":"include_registry(registry)","text":"
    Include another :class:MetricsRegistry into this one.
     
    Parameters:
     Name Type Description Default registry MetricsRegistry 
    The registry to merge in.
     required 
    Raises:
     Type Description ValueError 
    If a metric name already exists in the current registry.
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.register","level":3,"title":"register(func=None, *, name=None, collect=False)","text":"
    Register a metric provider or collector function.
     
    Can be used as a decorator with or without arguments.
     
    Parameters:
     Name Type Description Default func Callable[..., Any] | None 
    The metric function to register.
     None name str | None 
    Metric name (defaults to function name).
     None collect bool 
    If True, the function is called on every scrape. If False (default), called once at init time.
     False","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.handler.init_metrics","level":2,"title":"fastapi_toolsets.metrics.handler.init_metrics(app, registry, *, path='/metrics')","text":"
    Register a Prometheus /metrics endpoint on a FastAPI app.
     
    Parameters:
     Name Type Description Default app FastAPI 
    FastAPI application instance.
     required registry MetricsRegistry 
    A :class:MetricsRegistry containing providers and collectors.
     required path str 
    URL path for the metrics endpoint (default /metrics).
     '/metrics' 
    Returns:
     Type Description FastAPI 
    The same FastAPI instance (for chaining).
     Example 
    from fastapi import FastAPI\nfrom fastapi_toolsets.metrics import MetricsRegistry, init_metrics\n\nmetrics = MetricsRegistry()\napp = FastAPI()\ninit_metrics(app, registry=metrics)\n
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/models/","level":1,"title":"models","text":"
    Here's the reference for the SQLAlchemy model mixins provided by the models module.
     
    You can import them directly from fastapi_toolsets.models:
     
    from fastapi_toolsets.models import (\n    EventSession,\n    ModelEvent,\n    UUIDMixin,\n    UUIDv7Mixin,\n    CreatedAtMixin,\n    UpdatedAtMixin,\n    TimestampMixin,\n    listens_for,\n)\n
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.EventSession","level":2,"title":"fastapi_toolsets.models.EventSession","text":"
                   Bases: AsyncSession
     
    AsyncSession subclass that dispatches lifecycle callbacks after commit.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.ModelEvent","level":2,"title":"fastapi_toolsets.models.ModelEvent","text":"
                   Bases: str, Enum
     
    Event types dispatched by :class:EventSession.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.UUIDMixin","level":2,"title":"fastapi_toolsets.models.UUIDMixin","text":"
    Mixin that adds a UUID primary key auto-generated by the database.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.UUIDv7Mixin","level":2,"title":"fastapi_toolsets.models.UUIDv7Mixin","text":"
    Mixin that adds a UUIDv7 primary key auto-generated by the database.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.CreatedAtMixin","level":2,"title":"fastapi_toolsets.models.CreatedAtMixin","text":"
    Mixin that adds a created_at timestamp column.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.UpdatedAtMixin","level":2,"title":"fastapi_toolsets.models.UpdatedAtMixin","text":"
    Mixin that adds an updated_at timestamp column.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.TimestampMixin","level":2,"title":"fastapi_toolsets.models.TimestampMixin","text":"
                   Bases: CreatedAtMixin, UpdatedAtMixin
     
    Mixin that combines created_at and updated_at timestamp columns.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.listens_for","level":2,"title":"fastapi_toolsets.models.listens_for(model_class, event_types=None)","text":"
    Register a callback for one or more model lifecycle events.
     
    Parameters:
     Name Type Description Default model_class type 
    The SQLAlchemy model class to listen on.
     required event_types list[ModelEvent] | None 
    List of :class:ModelEvent values to listen for. Defaults to all event types.
     None","path":["Reference","models"],"tags":[]},{"location":"reference/pytest/","level":1,"title":"pytest","text":"
    Here's the reference for all testing utilities and pytest fixtures.
     
    You can import them directly from fastapi_toolsets.pytest:
     
    from fastapi_toolsets.pytest import (\n    register_fixtures,\n    create_async_client,\n    create_db_session,\n    worker_database_url,\n    create_worker_database,\n    cleanup_tables,\n)\n
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.plugin.register_fixtures","level":2,"title":"fastapi_toolsets.pytest.plugin.register_fixtures(registry, namespace, *, prefix='fixture_', session_fixture='db_session', strategy=LoadStrategy.MERGE)","text":"
    Register pytest fixtures from a FixtureRegistry.
     
    Automatically creates pytest fixtures for each fixture in the registry. Dependencies are resolved via pytest fixture dependencies.
     
    Parameters:
     Name Type Description Default registry FixtureRegistry 
    The FixtureRegistry containing fixtures
     required namespace dict[str, Any] 
    The module's globals() dict to add fixtures to
     required prefix str 
    Prefix for generated fixture names (default: \"fixture_\")
     'fixture_' session_fixture str 
    Name of the db session fixture (default: \"db_session\")
     'db_session' strategy LoadStrategy 
    Loading strategy for fixtures (default: MERGE)
     MERGE 
    Returns:
     Type Description list[str] 
    List of created fixture names
     Example 
    # conftest.py\nfrom app.fixtures import fixtures\nfrom fastapi_toolsets.pytest_plugin import register_fixtures\n\nregister_fixtures(fixtures, globals())\n\n# Creates fixtures like:\n# - fixture_roles\n# - fixture_users (depends on fixture_roles if users depends on roles)\n# - fixture_posts (depends on fixture_users if posts depends on users)\n
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.utils.create_async_client","level":2,"title":"fastapi_toolsets.pytest.utils.create_async_client(app, base_url='http://test', dependency_overrides=None)  async","text":"
    Create an async httpx client for testing FastAPI applications.
     
    Parameters:
     Name Type Description Default app Any 
    FastAPI application instance.
     required base_url str 
    Base URL for requests. Defaults to \"http://test\".
     'http://test' dependency_overrides dict[Callable[..., Any], Callable[..., Any]] | None 
    Optional mapping of original dependencies to their test replacements. Applied via app.dependency_overrides before yielding and cleaned up after.
     None 
    Yields:
     Type Description AsyncGenerator[AsyncClient, None] 
    An AsyncClient configured for the app.
     Example 
    from fastapi import FastAPI\nfrom fastapi_toolsets.pytest import create_async_client\n\napp = FastAPI()\n\n@pytest.fixture\nasync def client():\n    async with create_async_client(app) as c:\n        yield c\n\nasync def test_endpoint(client: AsyncClient):\n    response = await client.get(\"/health\")\n    assert response.status_code == 200\n
     Example with dependency overrides 
    from fastapi_toolsets.pytest import create_async_client, create_db_session\nfrom app.db import get_db\n\n@pytest.fixture\nasync def db_session():\n    async with create_db_session(DATABASE_URL, Base, cleanup=True) as session:\n        yield session\n\n@pytest.fixture\nasync def client(db_session):\n    async def override():\n        yield db_session\n\n    async with create_async_client(\n        app, dependency_overrides={get_db: override}\n    ) as c:\n        yield c\n
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.utils.create_db_session","level":2,"title":"fastapi_toolsets.pytest.utils.create_db_session(database_url, base, *, echo=False, expire_on_commit=False, drop_tables=True, cleanup=False)  async","text":"
    Create a database session for testing.
     
    Creates tables before yielding the session and optionally drops them after. Each call creates a fresh engine and session for test isolation.
     
    Parameters:
     Name Type Description Default database_url str 
    Database connection URL (e.g., \"postgresql+asyncpg://...\").
     required base type[DeclarativeBase] 
    SQLAlchemy DeclarativeBase class containing model metadata.
     required echo bool 
    Enable SQLAlchemy query logging. Defaults to False.
     False expire_on_commit bool 
    Expire objects after commit. Defaults to False.
     False drop_tables bool 
    Drop tables after test. Defaults to True.
     True cleanup bool 
    Truncate all tables after test using :func:cleanup_tables. Defaults to False.
     False 
    Yields:
     Type Description AsyncGenerator[AsyncSession, None] 
    An AsyncSession ready for database operations.
     Example 
    from fastapi_toolsets.pytest import create_db_session\nfrom app.models import Base\n\nDATABASE_URL = \"postgresql+asyncpg://user:pass@localhost/test_db\"\n\n@pytest.fixture\nasync def db_session():\n    async with create_db_session(\n        DATABASE_URL, Base, cleanup=True\n    ) as session:\n        yield session\n\nasync def test_create_user(db_session: AsyncSession):\n    user = User(name=\"test\")\n    db_session.add(user)\n    await db_session.commit()\n
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.utils.worker_database_url","level":2,"title":"fastapi_toolsets.pytest.utils.worker_database_url(database_url, default_test_db)","text":"
    Derive a per-worker database URL for pytest-xdist parallel runs.
     
    Appends _{worker_name} to the database name so each xdist worker operates on its own database.  When not running under xdist, _{default_test_db} is appended instead.
     
    The worker name is read from the PYTEST_XDIST_WORKER environment variable (set automatically by xdist in each worker process).
     
    Parameters:
     Name Type Description Default database_url str 
    Original database connection URL.
     required default_test_db str 
    Suffix appended to the database name when PYTEST_XDIST_WORKER is not set.
     required 
    Returns:
     Type Description str 
    A database URL with a worker- or default-specific database name.
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.utils.create_worker_database","level":2,"title":"fastapi_toolsets.pytest.utils.create_worker_database(database_url, default_test_db='test_db')  async","text":"
    Create and drop a per-worker database for pytest-xdist isolation.
     
    Derives a worker-specific database URL using :func:worker_database_url, then delegates to :func:~fastapi_toolsets.db.create_database to create and drop it.  Intended for use as a session-scoped fixture.
     
    When running under xdist the database name is suffixed with the worker name (e.g. _gw0).  Otherwise it is suffixed with default_test_db.
     
    Parameters:
     Name Type Description Default database_url str 
    Original database connection URL (used as the server connection and as the base for the worker database name).
     required default_test_db str 
    Suffix appended to the database name when PYTEST_XDIST_WORKER is not set. Defaults to \"test_db\".
     'test_db' 
    Yields:
     Type Description AsyncGenerator[str, None] 
    The worker-specific database URL.
     Example 
    from fastapi_toolsets.pytest import create_worker_database, create_db_session\n\nDATABASE_URL = \"postgresql+asyncpg://postgres:postgres@localhost/test_db\"\n\n@pytest.fixture(scope=\"session\")\nasync def worker_db_url():\n    async with create_worker_database(DATABASE_URL) as url:\n        yield url\n\n@pytest.fixture\nasync def db_session(worker_db_url):\n    async with create_db_session(\n        worker_db_url, Base, cleanup=True\n    ) as session:\n        yield session\n
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/schemas/","level":1,"title":"schemas","text":"
    Here's the reference for all response models and types provided by the schemas module.
     
    You can import them directly from fastapi_toolsets.schemas:
     
    from fastapi_toolsets.schemas import (\n    PydanticBase,\n    ResponseStatus,\n    ApiError,\n    BaseResponse,\n    Response,\n    ErrorResponse,\n    OffsetPagination,\n    CursorPagination,\n    PaginationType,\n    PaginatedResponse,\n    OffsetPaginatedResponse,\n    CursorPaginatedResponse,\n)\n
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.PydanticBase","level":2,"title":"fastapi_toolsets.schemas.PydanticBase","text":"
                   Bases: BaseModel
     
    Base class for all Pydantic models with common configuration.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.ResponseStatus","level":2,"title":"fastapi_toolsets.schemas.ResponseStatus","text":"
                   Bases: str, Enum
     
    Standard API response status.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.ApiError","level":2,"title":"fastapi_toolsets.schemas.ApiError","text":"
                   Bases: PydanticBase
     
    Structured API error definition.
     
    Used to define standard error responses with consistent format.
     
    Attributes:
     Name Type Description code int 
    HTTP status code
     msg str 
    Short error message
     desc str 
    Detailed error description
     err_code str 
    Application-specific error code (e.g., \"AUTH-401\")
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.BaseResponse","level":2,"title":"fastapi_toolsets.schemas.BaseResponse","text":"
                   Bases: PydanticBase
     
    Base response structure for all API responses.
     
    Attributes:
     Name Type Description status ResponseStatus 
    SUCCESS or FAIL
     message str 
    Human-readable message
     error_code str | None 
    Error code if status is FAIL, None otherwise
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.Response","level":2,"title":"fastapi_toolsets.schemas.Response","text":"
                   Bases: BaseResponse, Generic[DataT]
     
    Generic API response with data payload.
     Example 
    Response[UserRead](data=user, message=\"User retrieved\")\n
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.ErrorResponse","level":2,"title":"fastapi_toolsets.schemas.ErrorResponse","text":"
                   Bases: BaseResponse
     
    Error response with additional description field.
     
    Used for error responses that need more context.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.OffsetPagination","level":2,"title":"fastapi_toolsets.schemas.OffsetPagination","text":"
                   Bases: PydanticBase
     
    Pagination metadata for offset-based list responses.
     
    Attributes:
     Name Type Description total_count int | None 
    Total number of items across all pages. None when include_total=False.
     items_per_page int 
    Number of items per page
     page int 
    Current page number (1-indexed)
     has_more bool 
    Whether there are more pages
     pages int | None 
    Total number of pages
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.OffsetPagination.pages","level":3,"title":"pages  property","text":"
    Total number of pages, or None when total_count is unknown.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.CursorPagination","level":2,"title":"fastapi_toolsets.schemas.CursorPagination","text":"
                   Bases: PydanticBase
     
    Pagination metadata for cursor-based list responses.
     
    Attributes:
     Name Type Description next_cursor str | None 
    Encoded cursor for the next page, or None on the last page.
     prev_cursor str | None 
    Encoded cursor for the previous page, or None on the first page.
     items_per_page int 
    Number of items requested per page.
     has_more bool 
    Whether there is at least one more page after this one.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.PaginationType","level":2,"title":"fastapi_toolsets.schemas.PaginationType","text":"
                   Bases: str, Enum
     
    Pagination strategy selector for :meth:.AsyncCrud.paginate.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.PaginatedResponse","level":2,"title":"fastapi_toolsets.schemas.PaginatedResponse","text":"
                   Bases: BaseResponse, Generic[DataT]
     
    Paginated API response for list endpoints.
     
    Base class and return type for endpoints that support both pagination strategies.  Use :class:OffsetPaginatedResponse or :class:CursorPaginatedResponse when the strategy is fixed.
     
    When used as PaginatedResponse[T] in a return annotation, subscripting returns Annotated[Union[CursorPaginatedResponse[T], OffsetPaginatedResponse[T]], Field(discriminator=\"pagination_type\")] so FastAPI emits a proper oneOf + discriminator in the OpenAPI schema.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.OffsetPaginatedResponse","level":2,"title":"fastapi_toolsets.schemas.OffsetPaginatedResponse","text":"
                   Bases: PaginatedResponse[DataT]
     
    Paginated response with typed offset-based pagination metadata.
     
    The pagination_type field is always \"offset\" and acts as a discriminator, allowing frontend clients to narrow the union type returned by a unified paginate() endpoint.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.CursorPaginatedResponse","level":2,"title":"fastapi_toolsets.schemas.CursorPaginatedResponse","text":"
                   Bases: PaginatedResponse[DataT]
     
    Paginated response with typed cursor-based pagination metadata.
     
    The pagination_type field is always \"cursor\" and acts as a discriminator, allowing frontend clients to narrow the union type returned by a unified paginate() endpoint.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/security/","level":1,"title":"security","text":"
    Here's the reference for the authentication helpers provided by the security module.
     
    You can import them directly from fastapi_toolsets.security:
     
    from fastapi_toolsets.security import (\n    AuthSource,\n    BearerTokenAuth,\n    CookieAuth,\n    APIKeyHeaderAuth,\n    MultiAuth,\n    oauth_build_authorization_redirect,\n    oauth_decode_state,\n    oauth_encode_state,\n    oauth_fetch_userinfo,\n    oauth_generate_state_token,\n    oauth_resolve_provider_urls,\n)\n
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.AuthSource","level":2,"title":"fastapi_toolsets.security.AuthSource","text":"
                   Bases: ABC
     
    Abstract base class for authentication sources.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.AuthSource.__call__","level":3,"title":"__call__(**kwargs)  async","text":"
    FastAPI dependency dispatch.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.AuthSource.__init__","level":3,"title":"__init__()","text":"
    Set up the default FastAPI dependency signature.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.AuthSource.authenticate","level":3,"title":"authenticate(credential)  abstractmethod async","text":"
    Validate a credential and return the authenticated identity.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.AuthSource.extract","level":3,"title":"extract(request)  abstractmethod async","text":"
    Extract the raw credential from the request without validating.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth","level":2,"title":"fastapi_toolsets.security.BearerTokenAuth","text":"
                   Bases: AuthSource
     
    Bearer token authentication source.
     
    Wraps :class:fastapi.security.HTTPBearer for OpenAPI documentation. The validator is called as await validator(credential, **kwargs) where kwargs are the extra keyword arguments provided at instantiation.
     
    Parameters:
     Name Type Description Default validator Callable[..., Any] 
    Sync or async callable that receives the credential and any extra keyword arguments, and returns the authenticated identity (e.g. a User model). Should raise :class:~fastapi_toolsets.exceptions.UnauthorizedError on failure.
     required prefix str | None 
    Optional token prefix (e.g. \"user_\"). If set, only tokens whose value starts with this prefix are matched. The prefix is kept in the value passed to the validator — store and compare tokens with their prefix included. Use :meth:generate_token to create correctly-prefixed tokens. This enables multiple BearerTokenAuth instances in the same app (e.g. \"user_\" for user tokens, \"org_\" for org tokens).
     None **kwargs Any 
    Extra keyword arguments forwarded to the validator on every call (e.g. role=Role.ADMIN).
     {}","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth.__call__","level":3,"title":"__call__(**kwargs)  async","text":"
    FastAPI dependency dispatch.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth.authenticate","level":3,"title":"authenticate(credential)  async","text":"
    Validate a credential and return the identity.
     
    Calls await validator(credential, **kwargs) where kwargs are the extra keyword arguments provided at instantiation.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth.extract","level":3,"title":"extract(request)  async","text":"
    Extract the raw credential from the request without validating.
     
    Returns None if no Authorization: Bearer header is present, the token is empty, or the token does not match the configured prefix. The prefix is included in the returned value.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth.generate_token","level":3,"title":"generate_token(nbytes=32)","text":"
    Generate a secure random token for this auth source.
     
    Returns a URL-safe random token. If a prefix is configured it is prepended — the returned value is what you store in your database and return to the client as-is.
     
    Parameters:
     Name Type Description Default nbytes int 
    Number of random bytes before base64 encoding. The resulting string is ceil(nbytes * 4 / 3) characters (43 chars for the default 32 bytes). Defaults to 32.
     32 
    Returns:
     Type Description str 
    A ready-to-use token string (e.g. \"user_Xk3...\").
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth.require","level":3,"title":"require(**kwargs)","text":"
    Return a new instance with additional (or overriding) validator kwargs.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.CookieAuth","level":2,"title":"fastapi_toolsets.security.CookieAuth","text":"
                   Bases: AuthSource
     
    Cookie-based authentication source.
     
    Wraps :class:fastapi.security.APIKeyCookie for OpenAPI documentation. Optionally signs the cookie with HMAC-SHA256 to provide stateless, tamper- proof sessions without any database entry.
     
    Parameters:
     Name Type Description Default name str 
    Cookie name.
     required validator Callable[..., Any] 
    Sync or async callable that receives the cookie value (plain, after signature verification when secret_key is set) and any extra keyword arguments, and returns the authenticated identity.
     required secret_key str | None 
    When provided, the cookie is HMAC-SHA256 signed. :meth:set_cookie embeds an expiry and signs the payload; :meth:extract verifies the signature and expiry before handing the plain value to the validator.  When None (default), the raw cookie value is passed to the validator as-is.
     None ttl int 
    Cookie lifetime in seconds (default 24 h).  Only used when secret_key is set.
     86400 secure bool 
    Set the Secure flag on the cookie so it is only transmitted over HTTPS (default True).  Set to False only in local development environments where HTTPS is unavailable.
     True **kwargs Any 
    Extra keyword arguments forwarded to the validator on every call (e.g. role=Role.ADMIN).
     {}","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.CookieAuth.__call__","level":3,"title":"__call__(**kwargs)  async","text":"
    FastAPI dependency dispatch.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.CookieAuth.delete_cookie","level":3,"title":"delete_cookie(response)","text":"
    Clear the session cookie (logout).
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.CookieAuth.require","level":3,"title":"require(**kwargs)","text":"
    Return a new instance with additional (or overriding) validator kwargs.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.CookieAuth.set_cookie","level":3,"title":"set_cookie(response, value)","text":"
    Attach the cookie to response, signing it when secret_key is set.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.APIKeyHeaderAuth","level":2,"title":"fastapi_toolsets.security.APIKeyHeaderAuth","text":"
                   Bases: AuthSource
     
    API key header authentication source.
     
    Wraps :class:fastapi.security.APIKeyHeader for OpenAPI documentation. The validator is called as await validator(api_key, **kwargs) where kwargs are the extra keyword arguments provided at instantiation.
     
    Parameters:
     Name Type Description Default name str 
    HTTP header name that carries the API key (e.g. \"X-API-Key\").
     required validator Callable[..., Any] 
    Sync or async callable that receives the API key and any extra keyword arguments, and returns the authenticated identity. Should raise :class:~fastapi_toolsets.exceptions.UnauthorizedError on failure.
     required **kwargs Any 
    Extra keyword arguments forwarded to the validator on every call (e.g. role=Role.ADMIN).
     {}","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.APIKeyHeaderAuth.__call__","level":3,"title":"__call__(**kwargs)  async","text":"
    FastAPI dependency dispatch.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.APIKeyHeaderAuth.authenticate","level":3,"title":"authenticate(credential)  async","text":"
    Validate a credential and return the identity.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.APIKeyHeaderAuth.extract","level":3,"title":"extract(request)  async","text":"
    Extract the API key from the configured header.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.APIKeyHeaderAuth.require","level":3,"title":"require(**kwargs)","text":"
    Return a new instance with additional (or overriding) validator kwargs.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.MultiAuth","level":2,"title":"fastapi_toolsets.security.MultiAuth","text":"
    Combine multiple authentication sources into a single callable.
     
    Parameters:
     Name Type Description Default *sources AuthSource 
    Auth source instances to try in order.
     ()","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.MultiAuth.require","level":3,"title":"require(**kwargs)","text":"
    Return a new :class:MultiAuth with kwargs forwarded to each source.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_resolve_provider_urls","level":2,"title":"fastapi_toolsets.security.oauth_resolve_provider_urls(discovery_url)  async","text":"
    Fetch the OIDC discovery document and return endpoint URLs.
     
    Parameters:
     Name Type Description Default discovery_url str 
    URL of the provider's /.well-known/openid-configuration.
     required 
    Returns:
     Type Description str 
    A (authorization_url, token_url, userinfo_url) tuple.
     str 
    userinfo_url is None when the provider does not advertise one.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_fetch_userinfo","level":2,"title":"fastapi_toolsets.security.oauth_fetch_userinfo(*, token_url, userinfo_url, code, client_id, client_secret, redirect_uri, required_scopes=None)  async","text":"
    Exchange an authorization code for tokens and return the userinfo payload.
     
    Parameters:
     Name Type Description Default token_url str 
    Provider's token endpoint.
     required userinfo_url str 
    Provider's userinfo endpoint.
     required code str 
    Authorization code received from the provider's callback.
     required client_id str 
    OAuth application client ID.
     required client_secret str 
    OAuth application client secret.
     required redirect_uri str 
    Redirect URI that was used in the authorization request.
     required required_scopes str | None 
    Space-separated scopes that must be present in the token response scope field (RFC 6749 §3.3).  Raises ValueError if the provider granted fewer scopes than requested.
     None 
    Returns:
     Type Description dict[str, Any] 
    The JSON payload returned by the userinfo endpoint as a plain dict.
     
    Raises:
     Type Description ValueError 
    If the provider granted a different token type than bearer or did not grant all required_scopes.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_generate_state_token","level":2,"title":"fastapi_toolsets.security.oauth_generate_state_token()","text":"
    Generate a cryptographically random CSRF token for the OAuth state parameter.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_build_authorization_redirect","level":2,"title":"fastapi_toolsets.security.oauth_build_authorization_redirect(authorization_url, *, client_id, scopes, redirect_uri, destination, state_token)","text":"
    Return an OAuth 2.0 authorization RedirectResponse.
     
    Parameters:
     Name Type Description Default authorization_url str 
    Provider's authorization endpoint.
     required client_id str 
    OAuth application client ID.
     required scopes str 
    Space-separated list of requested scopes.
     required redirect_uri str 
    URI the provider should redirect back to after authorization.
     required destination str 
    URL the user should be sent to after the full OAuth flow completes (embedded in state).
     required state_token str 
    CSRF token generated by :func:oauth_generate_state_token. Must be stored server-side (session or signed cookie) and verified via :func:oauth_decode_state on the callback endpoint (RFC 6749 §10.12).
     required 
    Returns:
     Name Type Description A RedirectResponse 
    class:~fastapi.responses.RedirectResponse to the provider's
     RedirectResponse 
    authorization page.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_encode_state","level":2,"title":"fastapi_toolsets.security.oauth_encode_state(url, state_token)","text":"
    Encode a destination URL and CSRF token into an OAuth state parameter.
     
    Parameters:
     Name Type Description Default url str 
    Post-login destination URL.
     required state_token str 
    CSRF token from :func:oauth_generate_state_token.
     required","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_decode_state","level":2,"title":"fastapi_toolsets.security.oauth_decode_state(state, *, expected_state_token, fallback)","text":"
    Decode and CSRF-verify an OAuth state parameter.
     
    Uses a constant-time comparison for the CSRF token to prevent timing attacks.
     
    Parameters:
     Name Type Description Default state str | None 
    Raw state query parameter from the provider's callback.
     required expected_state_token str 
    The token stored before the authorization redirect. If it does not match the decoded value, fallback is returned.
     required fallback str 
    URL to return when state is absent, malformed, or fails CSRF verification.
     required 
    Returns:
     Type Description str 
    The destination URL embedded in state, or fallback.
     Important 
    Single-use: delete the stored token from the session immediately after calling this function — whether it matched or not — so that a captured callback URL cannot be replayed.
     
    Open-redirect: validate the returned URL against a known-good origin or relative-path allowlist before issuing the final redirect. Do not forward arbitrary URLs to RedirectResponse.
    ","path":["Reference","security"],"tags":[]}]}
\ No newline at end of file
+{"config":{"separator":"[\\s\\-_,:!=\\[\\]()\\\\\"`/]+|\\.(?!\\d)"},"items":[{"location":"","level":1,"title":"FastAPI Toolsets","text":"
    A modular collection of production-ready utilities for FastAPI. Install only what you need — from async CRUD and database helpers to CLI tooling, Prometheus metrics, and pytest fixtures. Each module is independently installable via optional extras, keeping your dependency footprint minimal.
     
     
     
    Documentation: https://fastapi-toolsets.d3vyce.fr
     
    Source Code: https://github.com/d3vyce/fastapi-toolsets
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"#installation","level":2,"title":"Installation","text":"
    The base package includes the core modules (CRUD, database, schemas, exceptions, fixtures, dependencies, model mixins, logging):
     
    uv add fastapi-toolsets\n
     
    Install only the extras you need:
     
    uv add \"fastapi-toolsets[cli]\"\nuv add \"fastapi-toolsets[metrics]\"\nuv add \"fastapi-toolsets[security]\"\nuv add \"fastapi-toolsets[pytest]\"\n
     
    Or install everything:
     
    uv add \"fastapi-toolsets[all]\"\n
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"#features","level":2,"title":"Features","text":"","path":["FastAPI Toolsets"],"tags":[]},{"location":"#core","level":3,"title":"Core","text":"
       
    • CRUD: Generic async CRUD operations with CrudFactory, built-in full-text/faceted search and Offset/Cursor pagination.
      •  
    • Database: Session management, transaction helpers, table locking, and polling-based row change detection
      •  
    • Dependencies: FastAPI dependency factories (PathDependency, BodyDependency) for automatic DB lookups from path or body parameters
      •  
    • Fixtures: Fixture system with dependency management, context support, and pytest integration
      •  
    • Model Mixins: SQLAlchemy mixins for common column patterns (UUIDMixin, UUIDv7Mixin, CreatedAtMixin, UpdatedAtMixin, TimestampMixin).
      •  
    • Lifecycle Events: Post-commit event system (EventSession, listens_for) that dispatches async/sync callbacks for insert, update, and delete operations.
      •  
    • Standardized API Responses: Consistent response format with Response, ErrorResponse, PaginatedResponse, CursorPaginatedResponse and OffsetPaginatedResponse.
      •  
    • Exception Handling: Structured error responses with automatic OpenAPI documentation
      •  
    • Logging: Logging configuration with uvicorn integration via configure_logging and get_logger
      •  
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"#optional","level":3,"title":"Optional","text":"
       
    • Security: Composable authentication sources (BearerTokenAuth, CookieAuth, APIKeyHeaderAuth, MultiAuth) with HMAC-signed cookies and OAuth 2.0 / OIDC helpers
      •  
    • CLI: Django-like command-line interface with fixture management and custom commands support
      •  
    • Metrics: Prometheus metrics endpoint with provider/collector registry
      •  
    • Pytest Helpers: Async test client, database session management, pytest-xdist support, and table cleanup utilities
      •  
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"#license","level":2,"title":"License","text":"
    MIT License - see LICENSE for details.
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"#contributing","level":2,"title":"Contributing","text":"
    Contributions are welcome! Please feel free to submit issues and pull requests.
    ","path":["FastAPI Toolsets"],"tags":[]},{"location":"examples/pagination-search/","level":1,"title":"Pagination & search","text":"
    This example builds an articles listing endpoint that supports offset pagination, cursor pagination, full-text search, faceted filtering, and sorting — all from a single CrudFactory definition.
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#models","level":2,"title":"Models","text":"models.py
    import uuid\n\nfrom sqlalchemy import Boolean, ForeignKey, String, Text\nfrom sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship\n\nfrom fastapi_toolsets.models import CreatedAtMixin\n\n\nclass Base(DeclarativeBase):\n    pass\n\n\nclass Category(Base):\n    __tablename__ = \"categories\"\n\n    id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4)\n    name: Mapped[str] = mapped_column(String(64), unique=True)\n\n    articles: Mapped[list[\"Article\"]] = relationship(back_populates=\"category\")\n\n\nclass Article(Base, CreatedAtMixin):\n    __tablename__ = \"articles\"\n\n    id: Mapped[uuid.UUID] = mapped_column(primary_key=True, default=uuid.uuid4)\n    title: Mapped[str] = mapped_column(String(256))\n    body: Mapped[str] = mapped_column(Text)\n    status: Mapped[str] = mapped_column(String(32))\n    published: Mapped[bool] = mapped_column(Boolean, default=False)\n    category_id: Mapped[uuid.UUID | None] = mapped_column(\n        ForeignKey(\"categories.id\"), nullable=True\n    )\n\n    category: Mapped[\"Category | None\"] = relationship(back_populates=\"articles\")\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#schemas","level":2,"title":"Schemas","text":"schemas.py
    import datetime\nimport uuid\n\nfrom fastapi_toolsets.schemas import PydanticBase\n\n\nclass ArticleRead(PydanticBase):\n    id: uuid.UUID\n    created_at: datetime.datetime\n    title: str\n    status: str\n    published: bool\n    category_id: uuid.UUID | None\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#crud","level":2,"title":"Crud","text":"
    Declare searchable_fields, facet_fields, and order_fields once on CrudFactory. All endpoints built from this class share the same defaults and can override them per call.
     crud.py
    from fastapi_toolsets.crud import CrudFactory\n\nfrom .models import Article, Category\n\nArticleCrud = CrudFactory(\n    model=Article,\n    cursor_column=Article.created_at,\n    searchable_fields=[  # default fields for full-text search\n        Article.title,\n        Article.body,\n        (Article.category, Category.name),\n    ],\n    facet_fields=[  # fields exposed as filter dropdowns\n        Article.status,\n        (Article.category, Category.name),\n    ],\n    order_fields=[  # fields exposed for client-driven ordering\n        Article.title,\n        Article.created_at,\n    ],\n)\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#session-dependency","level":2,"title":"Session dependency","text":"db.py
    from typing import Annotated\n\nfrom fastapi import Depends\nfrom sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine\n\nfrom fastapi_toolsets.db import create_db_context, create_db_dependency\n\nDATABASE_URL = \"postgresql+asyncpg://postgres:postgres@localhost:5432/postgres\"\n\nengine = create_async_engine(url=DATABASE_URL, future=True)\nasync_session_maker = async_sessionmaker(bind=engine, expire_on_commit=False)\n\nget_db = create_db_dependency(session_maker=async_session_maker)\nget_db_context = create_db_context(session_maker=async_session_maker)\n\n\nSessionDep = Annotated[AsyncSession, Depends(get_db)]\n
     
    Deploy a Postgres DB with docker
     
    docker run -d --name postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=postgres -p 5432:5432 postgres:18-alpine\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#app","level":2,"title":"App","text":"app.py
    from fastapi import FastAPI\n\nfrom fastapi_toolsets.exceptions import init_exceptions_handlers\n\nfrom .routes import router\n\napp = FastAPI()\ninit_exceptions_handlers(app=app)\napp.include_router(router=router)\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#routes","level":2,"title":"Routes","text":"routes.py:1:16
    from typing import Annotated\n\nfrom fastapi import APIRouter, Depends\n\nfrom fastapi_toolsets.schemas import (\n    CursorPaginatedResponse,\n    OffsetPaginatedResponse,\n    PaginatedResponse,\n)\n\nfrom .crud import ArticleCrud\nfrom .db import SessionDep\nfrom .models import Article\nfrom .schemas import ArticleRead\n\nrouter = APIRouter(prefix=\"/articles\")\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#offset-pagination","level":3,"title":"Offset pagination","text":"
    Best for admin panels or any UI that needs a total item count and numbered pages.
     routes.py:19:37
    @router.get(\"/offset\")\nasync def list_articles_offset(\n    session: SessionDep,\n    params: Annotated[\n        dict,\n        Depends(\n            ArticleCrud.offset_paginate_params(\n                default_page_size=20,\n                max_page_size=100,\n                default_order_field=Article.created_at,\n            )\n        ),\n    ],\n) -> OffsetPaginatedResponse[ArticleRead]:\n    return await ArticleCrud.offset_paginate(\n        session=session,\n        **params,\n        schema=ArticleRead,\n    )\n
     
    Example request
     
    GET /articles/offset?page=2&items_per_page=10&search=fastapi&status=published&order_by=title&order=asc\n
     
    Example response
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"offset\",\n  \"data\": [\n    { \"id\": \"3f47ac69-...\", \"title\": \"FastAPI tips\", \"status\": \"published\", ... }\n  ],\n  \"pagination\": {\n    \"total_count\": 42,\n    \"pages\": 5,\n    \"page\": 2,\n    \"items_per_page\": 10,\n    \"has_more\": true\n  },\n  \"filter_attributes\": {\n    \"status\": [\"archived\", \"draft\", \"published\"],\n    \"name\": [\"backend\", \"frontend\", \"python\"]\n  }\n}\n
     
    filter_attributes always reflects the values visible after applying the active filters. Use it to populate filter dropdowns on the client.
     
    To skip the COUNT(*) query for better performance on large tables, pass include_total=False. pagination.total_count will be null in the response, while has_more remains accurate.
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#cursor-pagination","level":3,"title":"Cursor pagination","text":"
    Best for feeds, infinite scroll, or any high-throughput API where offset performance degrades.
     routes.py:40:58
    @router.get(\"/cursor\")\nasync def list_articles_cursor(\n    session: SessionDep,\n    params: Annotated[\n        dict,\n        Depends(\n            ArticleCrud.cursor_paginate_params(\n                default_page_size=20,\n                max_page_size=100,\n                default_order_field=Article.created_at,\n            )\n        ),\n    ],\n) -> CursorPaginatedResponse[ArticleRead]:\n    return await ArticleCrud.cursor_paginate(\n        session=session,\n        **params,\n        schema=ArticleRead,\n    )\n
     
    Example request
     
    GET /articles/cursor?items_per_page=10&status=published&order_by=created_at&order=desc\n
     
    Example response
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"cursor\",\n  \"data\": [\n    { \"id\": \"3f47ac69-...\", \"title\": \"FastAPI tips\", \"status\": \"published\", ... }\n  ],\n  \"pagination\": {\n    \"next_cursor\": \"eyJ2YWx1ZSI6ICIzZjQ3YWM2OS0uLi4ifQ==\",\n    \"prev_cursor\": null,\n    \"items_per_page\": 10,\n    \"has_more\": true\n  },\n  \"filter_attributes\": {\n    \"status\": [\"published\"],\n    \"name\": [\"backend\", \"python\"]\n  }\n}\n
     
    Pass next_cursor as the cursor query parameter on the next request to advance to the next page.
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#unified-endpoint-both-strategies","level":3,"title":"Unified endpoint (both strategies)","text":"
    Added in v2.3.0
     
    paginate() lets a single endpoint support both strategies via a pagination_type query parameter. The pagination_type field in the response acts as a discriminator for frontend tooling.
     routes.py:61:79
    @router.get(\"/\")\nasync def list_articles(\n    session: SessionDep,\n    params: Annotated[\n        dict,\n        Depends(\n            ArticleCrud.paginate_params(\n                default_page_size=20,\n                max_page_size=100,\n                default_order_field=Article.created_at,\n            )\n        ),\n    ],\n) -> PaginatedResponse[ArticleRead]:\n    return await ArticleCrud.paginate(\n        session,\n        **params,\n        schema=ArticleRead,\n    )\n
     
    Offset request (default)
     
    GET /articles/?pagination_type=offset&page=1&items_per_page=10\n
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"offset\",\n  \"data\": [\"...\"],\n  \"pagination\": { \"total_count\": 42, \"pages\": 5, \"page\": 1, \"items_per_page\": 10, \"has_more\": true }\n}\n
     
    Cursor request
     
    GET /articles/?pagination_type=cursor&items_per_page=10\nGET /articles/?pagination_type=cursor&items_per_page=10&cursor=eyJ2YWx1ZSI6...\n
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"cursor\",\n  \"data\": [\"...\"],\n  \"pagination\": { \"next_cursor\": \"eyJ2YWx1ZSI6...\", \"prev_cursor\": null, \"items_per_page\": 10, \"has_more\": true }\n}\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"examples/pagination-search/#search-behaviour","level":2,"title":"Search behaviour","text":"
    Both endpoints inherit the same searchable_fields declared on ArticleCrud:
     
    Search is case-insensitive and uses a LIKE %query% pattern. Pass a SearchConfig instead of a plain string to control case sensitivity or switch to match_mode=\"all\" (AND across all fields instead of OR).
     
    from fastapi_toolsets.crud import SearchConfig\n\n# Both title AND body must contain \"fastapi\"\nresult = await ArticleCrud.offset_paginate(\n    session,\n    search=SearchConfig(query=\"fastapi\", case_sensitive=True, match_mode=\"all\"),\n    search_fields=[Article.title, Article.body],\n)\n
    ","path":["Examples","Pagination & search"],"tags":[]},{"location":"migration/v2/","level":1,"title":"Migrating to v2.0","text":"
    This page covers every breaking change introduced in v2.0 and the steps required to update your code.
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#crud","level":2,"title":"CRUD","text":"","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#schema-is-now-required-in-offset_paginate-and-cursor_paginate","level":3,"title":"schema is now required in offset_paginate() and cursor_paginate()","text":"
    Calls that omit schema will now raise a TypeError at runtime.
     
    Previously schema was optional; omitting it returned raw SQLAlchemy model instances inside the response. It is now a required keyword argument and the response always contains serialized schema instances.
     Before (v1)Now (v2) 
    # schema omitted — returned raw model instances\nresult = await UserCrud.offset_paginate(session=session, page=1)\nresult = await UserCrud.cursor_paginate(session=session, cursor=token)\n
     
    result = await UserCrud.offset_paginate(session=session, page=1, schema=UserRead)\nresult = await UserCrud.cursor_paginate(session=session, cursor=token, schema=UserRead)\n
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#as_response-removed-from-create-get-and-update","level":3,"title":"as_response removed from create(), get(), and update()","text":"
    Passing as_response to these methods will raise a TypeError at runtime.
     
    The as_response=True shorthand is replaced by passing a schema directly. The return value is a Response[schema] when schema is provided, or the raw model instance when it is not.
     Before (v1)Now (v2) 
    user = await UserCrud.create(session=session, obj=data, as_response=True)\nuser = await UserCrud.get(session=session, filters=filters, as_response=True)\nuser = await UserCrud.update(session=session, obj=data, filters, as_response=True)\n
     
    user = await UserCrud.create(session=session, obj=data, schema=UserRead)\nuser = await UserCrud.get(session=session, filters=filters, schema=UserRead)\nuser = await UserCrud.update(session=session, obj=data, filters, schema=UserRead)\n
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#delete-as_response-renamed-and-return-type-changed","level":3,"title":"delete(): as_response renamed and return type changed","text":"
    as_response is gone, and the plain (non-response) call no longer returns True.
     
    Two changes were made to delete():
     
       
    1. The as_response parameter is renamed to return_response.
      2.  
    2. When called without return_response=True, the method now returns None on success instead of True.
      3.  
     Before (v1)Now (v2) 
    ok = await UserCrud.delete(session=session, filters=filters)\nif ok:  # True on success\n    ...\n\nresponse = await UserCrud.delete(session=session, filters=filters, as_response=True)\n
     
    await UserCrud.delete(session=session, filters=filters)  # returns None\n\nresponse = await UserCrud.delete(session=session, filters=filters, return_response=True)\n
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#paginate-alias-removed","level":3,"title":"paginate() alias removed","text":"
    Any call to crud.paginate(...) will raise AttributeError at runtime.
     
    The paginate shorthand was an alias for offset_paginate. It has been removed; call offset_paginate directly.
     Before (v1)Now (v2) 
    result = await UserCrud.paginate(session=session, page=2, items_per_page=20, schema=UserRead)\n
     
    result = await UserCrud.offset_paginate(session=session, page=2, items_per_page=20, schema=UserRead)\n
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#exceptions","level":2,"title":"Exceptions","text":"","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#missing-api_error-raises-typeerror-at-class-definition-time","level":3,"title":"Missing api_error raises TypeError at class definition time","text":"
    Unfinished or stub exception subclasses that previously compiled fine will now fail on import.
     
    In v1, a subclass without api_error would only fail when the exception was raised. In v2, __init_subclass__ validates this at class definition time.
     Before (v1)Now (v2) 
    class MyError(ApiException):\n    pass  # fine until raised\n
     
    class MyError(ApiException):\n    pass  # TypeError: MyError must define an 'api_error' class attribute.\n
     
    For shared base classes that are not meant to be raised directly, use abstract=True:
     
    class BillingError(ApiException, abstract=True):\n    \"\"\"Base for all billing-related errors — not raised directly.\"\"\"\n\nclass PaymentRequiredError(BillingError):\n    api_error = ApiError(code=402, msg=\"Payment Required\", desc=\"...\", err_code=\"BILLING-402\")\n
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#schemas","level":2,"title":"Schemas","text":"","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v2/#pagination-alias-removed","level":3,"title":"Pagination alias removed","text":"
    Pagination was already deprecated in v1 and is fully removed in v2, you now need to use OffsetPagination or CursorPagination.
    ","path":["Migration","Migrating to v2.0"],"tags":[]},{"location":"migration/v3/","level":1,"title":"Migrating to v3.0","text":"
    This page covers every breaking change introduced in v3.0 and the steps required to update your code.
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#crud","level":2,"title":"CRUD","text":"","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#facet-keys-now-always-use-the-full-relationship-chain","level":3,"title":"Facet keys now always use the full relationship chain","text":"
    In v2, relationship facet fields used only the terminal column key (e.g. \"name\" for Role.name) and only prepended the relationship name when two facet fields shared the same column key. In v3, facet keys always include the full relationship chain joined by __, regardless of collisions.
     Before (v2)Now (v3) 
    User.status -> status\n(User.role, Role.name) -> name\n(User.role, Role.permission, Permission.name) -> name\n
     
    User.status -> status\n(User.role, Role.name) -> role__name\n(User.role, Role.permission, Permission.name) -> role__permission__name\n
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#_params-dependencies-consolidated-into-per-paginate-methods","level":3,"title":"*_params dependencies consolidated into per-paginate methods","text":"
    The six individual dependency methods (offset_params, cursor_params, paginate_params, filter_params, search_params, order_params) have been removed and replaced by three consolidated methods that bundle pagination, search, filter, and order into a single Depends() call.
     Removed Replacement offset_params() + filter_params() + search_params() + order_params() offset_paginate_params() cursor_params() + filter_params() + search_params() + order_params() cursor_paginate_params() paginate_params() + filter_params() + search_params() + order_params() paginate_params() 
    Each new method accepts search, filter, and order boolean toggles (all True by default) to disable features you don't need.
     Before (v2)Now (v3) 
    from fastapi_toolsets.crud import OrderByClause\n\n@router.get(\"/offset\")\nasync def list_articles_offset(\n    session: SessionDep,\n    params: Annotated[dict, Depends(ArticleCrud.offset_params(default_page_size=20))],\n    filter_by: Annotated[dict, Depends(ArticleCrud.filter_params())],\n    order_by: Annotated[OrderByClause | None, Depends(ArticleCrud.order_params(default_field=Article.created_at))],\n    search: str | None = None,\n) -> OffsetPaginatedResponse[ArticleRead]:\n    return await ArticleCrud.offset_paginate(\n        session=session,\n        **params,\n        search=search,\n        filter_by=filter_by or None,\n        order_by=order_by,\n        schema=ArticleRead,\n    )\n
     
    @router.get(\"/offset\")\nasync def list_articles_offset(\n    session: SessionDep,\n    params: Annotated[\n        dict,\n        Depends(\n            ArticleCrud.offset_paginate_params(\n                default_page_size=20,\n                default_order_field=Article.created_at,\n            )\n        ),\n    ],\n) -> OffsetPaginatedResponse[ArticleRead]:\n    return await ArticleCrud.offset_paginate(session=session, **params, schema=ArticleRead)\n
     
    The same pattern applies to cursor_paginate_params() and paginate_params(). To disable a feature, pass the toggle:
     
    # No search or ordering, only pagination + filtering\nArticleCrud.offset_paginate_params(search=False, order=False)\n
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#models","level":2,"title":"Models","text":"
    The lifecycle event system has been rewritten. Callbacks are now registered with a module-level listens_for decorator and dispatched by EventSession, replacing the mixin-based approach from v2.
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#watchedfieldsmixin-and-watch-removed","level":3,"title":"WatchedFieldsMixin and @watch removed","text":"
    Importing WatchedFieldsMixin or watch will raise ImportError.
     
    Model method callbacks (on_create, on_delete, on_update) and the @watch decorator are replaced by:
     
       
    1. __watched_fields__ — a plain class attribute to restrict which field changes trigger UPDATE events (replaces @watch).
      2.  
    2. @listens_for — a module-level decorator to register callbacks for one or more ModelEvent types (replaces on_create / on_delete / on_update methods).
      3.  
     Before (v2)Now (v3) 
    from fastapi_toolsets.models import WatchedFieldsMixin, watch\n\n@watch(\"status\")\nclass Order(Base, UUIDMixin, WatchedFieldsMixin):\n    __tablename__ = \"orders\"\n\n    status: Mapped[str]\n\n    async def on_create(self):\n        await notify_new_order(self.id)\n\n    async def on_update(self, changes):\n        if \"status\" in changes:\n            await notify_status_change(self.id, changes[\"status\"])\n\n    async def on_delete(self):\n        await notify_order_cancelled(self.id)\n
     
    from fastapi_toolsets.models import ModelEvent, UUIDMixin, listens_for\n\nclass Order(Base, UUIDMixin):\n    __tablename__ = \"orders\"\n    __watched_fields__ = (\"status\",)\n\n    status: Mapped[str]\n\n@listens_for(Order, [ModelEvent.CREATE])\nasync def on_order_created(order: Order, event_type: ModelEvent, changes: None):\n    await notify_new_order(order.id)\n\n@listens_for(Order, [ModelEvent.UPDATE])\nasync def on_order_updated(order: Order, event_type: ModelEvent, changes: dict):\n    if \"status\" in changes:\n        await notify_status_change(order.id, changes[\"status\"])\n\n@listens_for(Order, [ModelEvent.DELETE])\nasync def on_order_deleted(order: Order, event_type: ModelEvent, changes: None):\n    await notify_order_cancelled(order.id)\n
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v3/#eventsession-now-required","level":3,"title":"EventSession now required","text":"
    Without EventSession, lifecycle callbacks will silently stop firing.
     
    Callbacks are now dispatched inside EventSession.commit() rather than via background tasks. Pass it as the session class when creating your session factory:
     Before (v2)Now (v3) 
    from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False)\n
     
    from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine\nfrom fastapi_toolsets.models import EventSession\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False, class_=EventSession)\n
     
    Note
     
    If you use create_db_session from fastapi_toolsets.pytest, the session already uses EventSession — no changes needed in tests.
    ","path":["Migration","Migrating to v3.0"],"tags":[]},{"location":"migration/v4/","level":1,"title":"Migrating to v4.0","text":"
    This page covers every breaking change introduced in v4.0 and the steps required to update your code.
    ","path":["Migration","Migrating to v4.0"],"tags":[]},{"location":"migration/v4/#database","level":2,"title":"Database","text":"","path":["Migration","Migrating to v4.0"],"tags":[]},{"location":"migration/v4/#lock_tables-now-takes-a-session_maker-instead-of-a-session","level":3,"title":"lock_tables now takes a session_maker instead of a session","text":"
    The first argument of lock_tables changed from an AsyncSession instance to an async_sessionmaker. The function creates and manages its own dedicated session internally, yielding it to the caller.
     Before (v3)Now (v4) 
    from fastapi_toolsets.db import lock_tables, LockMode\n\nasync with lock_tables(session=session, tables=[User, Account]):\n    user = await UserCrud.get(session, [User.id == 1])\n    user.balance += 100\n\n# With a custom lock mode\nasync with lock_tables(session, [Order], mode=LockMode.EXCLUSIVE):\n    await process_order(session, order_id)\n
     
    from fastapi_toolsets.db import lock_tables, LockMode\n\nasync with lock_tables(session_maker=session_maker, tables=[User, Account]) as session:\n    user = await UserCrud.get(session, [User.id == 1])\n    user.balance += 100\n\n# With a custom lock mode\nasync with lock_tables(session_maker, [Order], mode=LockMode.EXCLUSIVE) as session:\n    await process_order(session, order_id)\n
    ","path":["Migration","Migrating to v4.0"],"tags":[]},{"location":"module/cli/","level":1,"title":"CLI","text":"
    Typer-based command-line interface for managing your FastAPI application, with built-in fixture commands integration.
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#installation","level":2,"title":"Installation","text":"uvpip 
    uv add \"fastapi-toolsets[cli]\"\n
     
    pip install \"fastapi-toolsets[cli]\"\n
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#overview","level":2,"title":"Overview","text":"
    The cli module provides a manager entry point built with Typer. It allow custom commands to be added in addition of the fixture commands when a FixtureRegistry and a database context are configured.
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#configuration","level":2,"title":"Configuration","text":"
    Configure the CLI in your pyproject.toml:
     
    [tool.fastapi-toolsets]\ncli = \"myapp.cli:cli\"                   # Custom Typer app\nfixtures = \"myapp.fixtures:registry\"    # FixtureRegistry instance\ndb_context = \"myapp.db:db_context\"      # Async context manager for sessions\n
     
    All fields are optional. Without configuration, the manager command still works but no command are available.
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#usage","level":2,"title":"Usage","text":"
    # Manager commands\nmanager --help\n\n Usage: manager [OPTIONS] COMMAND [ARGS]...\n\n FastAPI utilities CLI.\n\n╭─ Options ────────────────────────────────────────────────────────────────────────╮\n│ --install-completion          Install completion for the current shell.          │\n│ --show-completion             Show completion for the current shell, to copy it  │\n│                               or customize the installation.                     │\n│ --help                        Show this message and exit.                        │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n╭─ Commands ───────────────────────────────────────────────────────────────────────╮\n│ check-db                                                                         │\n│ fixtures  Manage database fixtures.                                              │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n\n# Fixtures commands\nmanager fixtures --help\n\n Usage: manager fixtures [OPTIONS] COMMAND [ARGS]...\n\n Manage database fixtures.\n\n╭─ Options ────────────────────────────────────────────────────────────────────────╮\n│ --help          Show this message and exit.                                      │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n╭─ Commands ───────────────────────────────────────────────────────────────────────╮\n│ list  List all registered fixtures.                                              │\n│ load  Load fixtures into the database.                                           │\n╰──────────────────────────────────────────────────────────────────────────────────╯\n
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/cli/#custom-cli","level":2,"title":"Custom CLI","text":"
    You can extend the CLI by providing your own Typer app. The manager entry point will merge your app's commands with the built-in ones:
     
    # myapp/cli.py\nimport typer\n\ncli = typer.Typer()\n\n@cli.command()\ndef hello():\n    print(\"Hello from my app!\")\n
     
    [tool.fastapi-toolsets]\ncli = \"myapp.cli:cli\"\n
     
     API Reference
    ","path":["Modules","CLI"],"tags":[]},{"location":"module/crud/","level":1,"title":"CRUD","text":"
    Generic async CRUD operations for SQLAlchemy models with search, pagination, and many-to-many support.
     
    Info
     
    This module has been coded and tested to be compatible with PostgreSQL only.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#overview","level":2,"title":"Overview","text":"
    The crud module provides AsyncCrud, a base class with a full suite of async database operations, and CrudFactory, a convenience function to instantiate it for a given model.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#creating-a-crud-class","level":2,"title":"Creating a CRUD class","text":"","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#factory-style","level":3,"title":"Factory style","text":"
    from fastapi_toolsets.crud import CrudFactory\nfrom myapp.models import User\n\nUserCrud = CrudFactory(model=User)\n
     
    CrudFactory dynamically creates a class named AsyncUserCrud with User as its model. This is the most concise option for straightforward CRUD with no custom logic.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#subclass-style","level":3,"title":"Subclass style","text":"
    Added in v2.3.0
     
    from fastapi_toolsets.crud.factory import AsyncCrud\nfrom myapp.models import User\n\nclass UserCrud(AsyncCrud[User]):\n    model = User\n    searchable_fields = [User.username, User.email]\n    default_load_options = [selectinload(User.role)]\n
     
    Subclassing AsyncCrud directly is the preferred style when you need to add custom methods or when the configuration is complex enough to benefit from a named class body.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#adding-custom-methods","level":3,"title":"Adding custom methods","text":"
    class UserCrud(AsyncCrud[User]):\n    model = User\n\n    @classmethod\n    async def get_active(cls, session: AsyncSession) -> list[User]:\n        return await cls.get_multi(session, filters=[User.is_active == True])\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#sharing-a-custom-base-across-multiple-models","level":3,"title":"Sharing a custom base across multiple models","text":"
    Define a generic base class with the shared methods, then subclass it for each model:
     
    from typing import Generic, TypeVar\nfrom sqlalchemy.ext.asyncio import AsyncSession\nfrom sqlalchemy.orm import DeclarativeBase\nfrom fastapi_toolsets.crud.factory import AsyncCrud\n\nT = TypeVar(\"T\", bound=DeclarativeBase)\n\nclass AuditedCrud(AsyncCrud[T], Generic[T]):\n    \"\"\"Base CRUD with custom function\"\"\"\n\n    @classmethod\n    async def get_active(cls, session: AsyncSession):\n        return await cls.get_multi(session, filters=[cls.model.is_active == True])\n\n\nclass UserCrud(AuditedCrud[User]):\n    model = User\n    searchable_fields = [User.username, User.email]\n
     
    You can also use the factory shorthand with the same base by passing base_class:
     
    UserCrud = CrudFactory(User, base_class=AuditedCrud)\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#basic-operations","level":2,"title":"Basic operations","text":"
    get_or_none added in v2.2
     
    # Create\nuser = await UserCrud.create(session=session, obj=UserCreateSchema(username=\"alice\"))\n\n# Get one (raises NotFoundError if not found)\nuser = await UserCrud.get(session=session, filters=[User.id == user_id])\n\n# Get one or None (never raises)\nuser = await UserCrud.get_or_none(session=session, filters=[User.id == user_id])\n\n# Get first or None\nuser = await UserCrud.first(session=session, filters=[User.email == email])\n\n# Get multiple\nusers = await UserCrud.get_multi(session=session, filters=[User.is_active == True])\n\n# Update\nuser = await UserCrud.update(session=session, obj=UserUpdateSchema(username=\"bob\"), filters=[User.id == user_id])\n\n# Delete\nawait UserCrud.delete(session=session, filters=[User.id == user_id])\n\n# Count / exists\ncount = await UserCrud.count(session=session, filters=[User.is_active == True])\nexists = await UserCrud.exists(session=session, filters=[User.email == email])\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#fetching-a-single-record","level":2,"title":"Fetching a single record","text":"
    Three methods fetch a single record — choose based on how you want to handle the \"not found\" case and whether you need strict uniqueness:
     Method Not found Multiple results get raises NotFoundError raises MultipleResultsFound get_or_none returns None raises MultipleResultsFound first returns None returns the first match silently 
    Use get when the record must exist (e.g. a detail endpoint that should return 404):
     
    user = await UserCrud.get(session=session, filters=[User.id == user_id])\n
     
    Use get_or_none when the record may not exist but you still want strict uniqueness enforcement:
     
    user = await UserCrud.get_or_none(session=session, filters=[User.email == email])\nif user is None:\n    ...  # handle missing case without catching an exception\n
     
    Use first when you only care about any one match and don't need uniqueness:
     
    user = await UserCrud.first(session=session, filters=[User.is_active == True])\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#row-locking","level":2,"title":"Row locking","text":"
    get, get_or_none, first, get_multi, and update all accept a with_for_update parameter that appends a FOR UPDATE clause to the underlying SELECT, preventing concurrent transactions from modifying the matched rows until the current transaction commits.
     Value SQL clause False (default) no locking True FOR UPDATE \"nowait\" FOR UPDATE NOWAIT \"skip_locked\" FOR UPDATE SKIP LOCKED 
    # Lock before reading — typical read-modify-write pattern\nuser = await UserCrud.get(session, [User.id == user_id], with_for_update=True)\n\n# Raise immediately if another transaction holds the lock\nuser = await UserCrud.get(session, [User.id == user_id], with_for_update=\"nowait\")\n\n# Skip rows already locked by another transaction (e.g. job queues)\nrows = await JobCrud.get_multi(session, filters=[Job.status == \"pending\"], with_for_update=\"skip_locked\")\n\n# Lock atomically as part of update (prevents race between SELECT and UPDATE)\nuser = await UserCrud.update(session, UserUpdate(credits=10), [User.id == user_id], with_for_update=True)\n
     
    Warning
     
    with_for_update requires an open transaction. Wrap your call in async with session.begin() or use the get_transaction helper if you are not already inside one.
     
    Note
     
    NOWAIT raises sqlalchemy.exc.OperationalError immediately if the row is locked rather than waiting.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#pagination","level":2,"title":"Pagination","text":"
    Added in v1.1 (only offset_pagination via paginate if <v1.1)
     
    Three pagination methods are available.  All return a typed response whose pagination_type field tells clients which strategy was used.
     offset_paginate cursor_paginate paginate Return type OffsetPaginatedResponse CursorPaginatedResponse either, based on pagination_type param Total count Yes No / Jump to arbitrary page Yes No / Performance on deep pages Degrades Constant / Stable under concurrent inserts No Yes / Use case Admin panels, numbered pagination Feeds, APIs, infinite scroll single endpoint, both strategies","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#offset-pagination","level":3,"title":"Offset pagination","text":"
    from typing import Annotated\nfrom fastapi import Depends\n\n@router.get(\"\")\nasync def get_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.offset_paginate_params())],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
     
    The offset_paginate method returns an OffsetPaginatedResponse:
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"offset\",\n  \"data\": [\"...\"],\n  \"pagination\": {\n    \"total_count\": 100,\n    \"pages\": 5,\n    \"page\": 1,\n    \"items_per_page\": 20,\n    \"has_more\": true\n  }\n}\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#skipping-the-count-query","level":4,"title":"Skipping the COUNT query","text":"
    Added in v2.4.1
     
    By default offset_paginate runs two queries: one for the page items and one COUNT(*) for total_count. On large tables the COUNT can be expensive. Pass include_total=False to offset_paginate_params() to skip it:
     
    @router.get(\"\")\nasync def get_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.offset_paginate_params(include_total=False))],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#cursor-pagination","level":3,"title":"Cursor pagination","text":"
    @router.get(\"\")\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.cursor_paginate_params())],\n) -> CursorPaginatedResponse[UserRead]:\n    return await UserCrud.cursor_paginate(session=session, **params, schema=UserRead)\n
     
    The cursor_paginate method returns a CursorPaginatedResponse:
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"cursor\",\n  \"data\": [\"...\"],\n  \"pagination\": {\n    \"next_cursor\": \"eyJ2YWx1ZSI6ICIzZjQ3YWM2OS0uLi4ifQ==\",\n    \"prev_cursor\": null,\n    \"items_per_page\": 20,\n    \"has_more\": true\n  }\n}\n
     
    Pass next_cursor as the cursor query parameter on the next request to advance to the next page. prev_cursor is set on pages 2+ and points back to the first item of the current page. Both are null when there is no adjacent page.
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#choosing-a-cursor-column","level":4,"title":"Choosing a cursor column","text":"
    The cursor column is set once on CrudFactory via the cursor_column parameter. It must be monotonically ordered for stable results:
     
       
    • Auto-increment integer PKs
      •  
    • UUID v7 PKs
      •  
    • Timestamps
      •  
     
    Warning
     
    Random UUID v4 PKs are not suitable as cursor columns because their ordering is non-deterministic.
     
    Note
     
    cursor_column is required. Calling cursor_paginate on a CRUD class that has no cursor_column configured raises a ValueError.
     
    The cursor value is URL-safe base64-encoded (no padding) when returned to the client and decoded back to the correct Python type on the next request. The following SQLAlchemy column types are supported:
     SQLAlchemy type Python type Integer, BigInteger, SmallInteger int Uuid uuid.UUID DateTime datetime.datetime Date datetime.date Float, Numeric decimal.Decimal 
    # Paginate by the primary key\nPostCrud = CrudFactory(model=Post, cursor_column=Post.id)\n\n# Paginate by a timestamp column instead\nPostCrud = CrudFactory(model=Post, cursor_column=Post.created_at)\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#unified-endpoint-both-strategies","level":3,"title":"Unified endpoint (both strategies)","text":"
    Added in v2.3.0
     
    paginate() dispatches to offset_paginate or cursor_paginate based on a pagination_type query parameter, letting you expose one endpoint that supports both strategies.  The pagination_type field in the response tells clients which strategy was used, enabling frontend discriminated-union typing.
     
    from fastapi_toolsets.schemas import PaginatedResponse\n\n@router.get(\"\")\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.paginate_params())],\n) -> PaginatedResponse[UserRead]:\n    return await UserCrud.paginate(session, **params, schema=UserRead)\n
     
    GET /users?pagination_type=offset&page=2&items_per_page=10\nGET /users?pagination_type=cursor&cursor=eyJ2YWx1ZSI6...&items_per_page=10\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#search","level":2,"title":"Search","text":"
    Two search strategies are available, both compatible with offset_paginate and cursor_paginate.
     Full-text search Faceted search Input Free-text string Exact column values Relationship support Yes Yes Use case Search bars Filter dropdowns 
    You can use both search strategies in the same endpoint!
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#full-text-search","level":3,"title":"Full-text search","text":"
    Added in v2.2.1
     
    The model's primary key is always included in searchable_fields automatically, so searching by ID works out of the box without any configuration. When no searchable_fields are declared, only the primary key is searched.
     
    Declare searchable_fields on the CRUD class. Relationship traversal is supported via tuples:
     
    PostCrud = CrudFactory(\n    model=Post,\n    searchable_fields=[\n        Post.title,\n        Post.content,\n        (Post.author, User.username),  # search across relationship\n    ],\n)\n
     
    You can override searchable_fields per call with search_fields:
     
    result = await UserCrud.offset_paginate(\n    session=session,\n    search_fields=[User.country],\n)\n
     
    Or via the dependency to narrow which fields are exposed as query parameters:
     
    params = UserCrud.offset_paginate_params(search_fields=[Post.title])\n
     
    This allows searching with both offset_paginate and cursor_paginate:
     
    @router.get(\"\")\nasync def get_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.offset_paginate_params())],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
     
    @router.get(\"\")\nasync def get_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.cursor_paginate_params())],\n) -> CursorPaginatedResponse[UserRead]:\n    return await UserCrud.cursor_paginate(session=session, **params, schema=UserRead)\n
     
    The dependency adds two query parameters to the endpoint:
     Parameter Type search str \\| null search_column str \\| null 
    GET /posts?search=hello                        → search all configured columns\nGET /posts?search=hello&search_column=title    → search only Post.title\n
     
    The available search column keys are returned in the search_columns field of PaginatedResponse. Use them to populate a column picker in the UI, or to validate search_column values on the client side:
     
    {\n  \"status\": \"SUCCESS\",\n  \"data\": [\"...\"],\n  \"pagination\": { \"...\" },\n  \"search_columns\": [\"content\", \"author__username\", \"title\"]\n}\n
     
    Key format uses __ as a separator for relationship chains.
     
    A direct column Post.title produces \"title\". A relationship tuple (Post.author, User.username) produces \"author__username\". An unknown search_column value raises InvalidSearchColumnError (HTTP 422).
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#faceted-search","level":3,"title":"Faceted search","text":"
    Added in v1.2
     
    Declare facet_fields on the CRUD class to return distinct column values alongside paginated results. This is useful for populating filter dropdowns or building faceted search UIs. Relationship traversal is supported via tuples, using the same syntax as searchable_fields:
     
    UserCrud = CrudFactory(\n    model=User,\n    facet_fields=[\n        User.status,\n        User.country,\n        (User.role, Role.name),  # value from a related model\n    ],\n)\n
     
    You can override facet_fields per call:
     
    result = await UserCrud.offset_paginate(\n    session=session,\n    facet_fields=[User.country],\n)\n
     
    Or via the dependency to narrow which fields are exposed as query parameters:
     
    params = UserCrud.offset_paginate_params(facet_fields=[User.country])\n
     
    Facet filtering is built into the consolidated params dependencies. When filter=True (the default), each facet field is exposed as a query parameter and values are collected into filter_by automatically:
     
    from typing import Annotated\n\nfrom fastapi import Depends\n\n@router.get(\"\", response_model_exclude_none=True)\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.offset_paginate_params())],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
     
    @router.get(\"\", response_model_exclude_none=True)\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.cursor_paginate_params())],\n) -> CursorPaginatedResponse[UserRead]:\n    return await UserCrud.cursor_paginate(session=session, **params, schema=UserRead)\n
     
    Both single-value and multi-value query parameters work:
     
    GET /users?status=active                      → filter_by={\"status\": [\"active\"]}\nGET /users?status=active&country=FR           → filter_by={\"status\": [\"active\"], \"country\": [\"FR\"]}\nGET /users?role__name=admin&role__name=editor → filter_by={\"role__name\": [\"admin\", \"editor\"]}  (IN clause)\n
     
    filter_by and filters can be combined — both are applied with AND logic.
     
    The distinct values for each facet field are returned in the filter_attributes field of PaginatedResponse. Use them to populate filter dropdowns in the UI, or to validate filter_by keys on the client side:
     
    {\n  \"status\": \"SUCCESS\",\n  \"data\": [\"...\"],\n  \"pagination\": { \"...\" },\n  \"filter_attributes\": {\n    \"status\": [\"active\", \"inactive\"],\n    \"country\": [\"DE\", \"FR\", \"US\"],\n    \"role__name\": [\"admin\", \"editor\", \"viewer\"]\n  }\n}\n
     
    Key format uses __ as a separator for relationship chains.
     
    A direct column User.status produces \"status\". A relationship tuple (User.role, Role.name) produces \"role__name\". A deeper chain (User.role, Role.permission, Permission.name) produces \"role__permission__name\". An unknown filter_by key raises InvalidFacetFilterError (HTTP 422).
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#sorting","level":2,"title":"Sorting","text":"
    Added in v1.3
     
    Declare order_fields on the CRUD class. Relationship traversal is supported via tuples, using the same syntax as searchable_fields and facet_fields:
     
    UserCrud = CrudFactory(\n    model=User,\n    order_fields=[\n        User.name,\n        User.created_at,\n        (User.role, Role.name),  # sort by a related model column\n    ],\n)\n
     
    You can override order_fields per call:
     
    result = await UserCrud.offset_paginate(\n    session=session,\n    order_fields=[User.name],\n)\n
     
    Or via the dependency to narrow which fields are exposed as query parameters:
     
    params = UserCrud.offset_paginate_params(order_fields=[User.name])\n
     
    Sorting is built into the consolidated params dependencies. When order=True (the default), order_by and order query parameters are exposed and resolved into an OrderByClause automatically:
     
    from typing import Annotated\n\nfrom fastapi import Depends\n\n@router.get(\"\")\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.offset_paginate_params())],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
     
    @router.get(\"\")\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(UserCrud.cursor_paginate_params())],\n) -> CursorPaginatedResponse[UserRead]:\n    return await UserCrud.cursor_paginate(session=session, **params, schema=UserRead)\n
     
    The dependency adds two query parameters to the endpoint:
     Parameter Type order_by str \\| null order asc or desc 
    GET /users?order_by=name&order=asc         → ORDER BY users.name ASC\nGET /users?order_by=role__name&order=desc  → LEFT JOIN roles ON ... ORDER BY roles.name DESC\n
     
    Relationship tuples are joined automatically.
     
    When a relation field is selected, the related table is LEFT OUTER JOINed automatically. An unknown order_by value raises InvalidOrderFieldError (HTTP 422).
     
    The available sort keys are returned in the order_columns field of PaginatedResponse. Use them to populate a sort picker in the UI, or to validate order_by values on the client side:
     
    {\n  \"status\": \"SUCCESS\",\n  \"data\": [\"...\"],\n  \"pagination\": { \"...\" },\n  \"order_columns\": [\"created_at\", \"name\", \"role__name\"]\n}\n
     
    Key format uses __ as a separator for relationship chains.
     
    A direct column User.name produces \"name\". A relationship tuple (User.role, Role.name) produces \"role__name\".
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#relationship-loading","level":2,"title":"Relationship loading","text":"
    Added in v1.1
     
    By default, SQLAlchemy relationships are not loaded unless explicitly requested. Instead of using lazy=\"selectin\" on model definitions (which is implicit and applies globally), define a default_load_options on the CRUD class to control loading strategy explicitly.
     
    Warning
     
    Avoid using lazy=\"selectin\" on model relationships. It fires silently on every query, cannot be disabled per-call, and can cause unexpected cascading loads through deep relationship chains. Use default_load_options instead.
     
    from sqlalchemy.orm import selectinload\n\nArticleCrud = CrudFactory(\n    model=Article,\n    default_load_options=[\n        selectinload(Article.category),\n        selectinload(Article.tags),\n    ],\n)\n
     
    default_load_options applies automatically to all read operations (get, first, get_multi, offset_paginate, cursor_paginate). When load_options is passed at call-site, it fully replaces default_load_options for that query — giving you precise per-call control:
     
    # Only loads category, tags are not loaded\narticle = await ArticleCrud.get(\n    session=session,\n    filters=[Article.id == article_id],\n    load_options=[selectinload(Article.category)],\n)\n\n# Loads nothing — useful for write-then-refresh flows or lightweight checks\narticles = await ArticleCrud.get_multi(session=session, load_options=[])\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#many-to-many-relationships","level":2,"title":"Many-to-many relationships","text":"
    Use m2m_fields to map schema fields containing lists of IDs to SQLAlchemy relationships. The CRUD class resolves and validates all IDs before persisting:
     
    PostCrud = CrudFactory(\n    model=Post,\n    m2m_fields={\"tag_ids\": Post.tags},\n)\n\npost = await PostCrud.create(session=session, obj=PostCreateSchema(title=\"Hello\", tag_ids=[1, 2, 3]))\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#upsert","level":2,"title":"Upsert","text":"
    Atomic INSERT ... ON CONFLICT DO UPDATE using PostgreSQL:
     
    await UserCrud.upsert(\n    session=session,\n    obj=UserCreateSchema(email=\"alice@example.com\", username=\"alice\"),\n    index_elements=[User.email],\n    set_={\"username\"},\n)\n
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/crud/#response-serialization","level":2,"title":"Response serialization","text":"
    Added in v1.1
     
    Pass a Pydantic schema class to create, get, update, or offset_paginate to serialize the result directly into that schema and wrap it in a Response[schema] or PaginatedResponse[schema]:
     
    class UserRead(PydanticBase):\n    id: UUID\n    username: str\n\n@router.get(\n    \"/{uuid}\",\n    responses=generate_error_responses(NotFoundError),\n)\nasync def get_user(session: SessionDep, uuid: UUID) -> Response[UserRead]:\n    return await crud.UserCrud.get(\n        session=session,\n        filters=[User.id == uuid],\n        schema=UserRead,\n    )\n\n@router.get(\"\")\nasync def list_users(\n    session: SessionDep,\n    params: Annotated[dict, Depends(crud.UserCrud.offset_paginate_params())],\n) -> OffsetPaginatedResponse[UserRead]:\n    return await crud.UserCrud.offset_paginate(session=session, **params, schema=UserRead)\n
     
    The schema must have from_attributes=True (or inherit from PydanticBase) so it can be built from SQLAlchemy model instances.
     
     API Reference
    ","path":["Modules","CRUD"],"tags":[]},{"location":"module/db/","level":1,"title":"DB","text":"
    SQLAlchemy async session management with transactions, table locking, advisory locking, and row-change polling.
     
    Info
     
    This module has been coded and tested to be compatible with PostgreSQL only.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#overview","level":2,"title":"Overview","text":"
    The db module provides helpers to create FastAPI dependencies and context managers for AsyncSession, along with utilities for nested transactions, table locks, advisory locks, and polling for row changes.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#session-dependency","level":2,"title":"Session dependency","text":"
    Use create_db_dependency to create a FastAPI dependency that yields a session and auto-commits on success:
     
    from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker\nfrom fastapi_toolsets.db import create_db_dependency\n\nengine = create_async_engine(url=\"postgresql+asyncpg://...\", future=True)\nsession_maker = async_sessionmaker(bind=engine, expire_on_commit=False)\n\nget_db = create_db_dependency(session_maker=session_maker)\n\n@router.get(\"/users\")\nasync def list_users(session: AsyncSession = Depends(get_db)):\n    ...\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#session-context-manager","level":2,"title":"Session context manager","text":"
    Use create_db_context for sessions outside request handlers (e.g. background tasks, CLI commands):
     
    from fastapi_toolsets.db import create_db_context\n\ndb_context = create_db_context(session_maker=session_maker)\n\nasync def seed():\n    async with db_context() as session:\n        ...\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#nested-transactions","level":2,"title":"Nested transactions","text":"
    get_transaction handles savepoints automatically, allowing safe nesting:
     
    from fastapi_toolsets.db import get_transaction\n\nasync def create_user_with_role(session=session):\n    async with get_transaction(session=session):\n        ...\n        async with get_transaction(session=session):  # uses savepoint\n            ...\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#table-locking","level":2,"title":"Table locking","text":"
    lock_tables acquires PostgreSQL table-level locks before executing critical sections. It opens a dedicated session internally and yields it to the caller, so the lock is guaranteed to be released when the context exits:
     
    from fastapi_toolsets.db import lock_tables, LockMode\n\nasync with lock_tables(session_maker=session_maker, tables=[User], mode=LockMode.EXCLUSIVE) as session:\n    # No other transaction can modify User until this block exits\n    ...\n
     
    Available lock modes are defined in LockMode: ACCESS_SHARE, ROW_SHARE, ROW_EXCLUSIVE, SHARE_UPDATE_EXCLUSIVE, SHARE, SHARE_ROW_EXCLUSIVE, EXCLUSIVE, ACCESS_EXCLUSIVE.
     
    Pass timeout to limit how long the lock waits before giving up. On timeout, a LockTimeoutError is raised instead of a raw database error:
     
    async with lock_tables(session_maker, [Order], timeout=\"2s\") as session:\n    ...\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#advisory-locking","level":2,"title":"Advisory locking","text":"
    advisory_lock acquires a PostgreSQL session-level advisory lock. The lock is released explicitly when the context exits, regardless of whether the transaction has committed.
     
    from fastapi_toolsets.db import advisory_lock\n\n# Blocking exclusive lock — waits until the lock is free\nasync with advisory_lock(session=session, key=42):\n    ...\n\n# Non-blocking — yields False immediately if already held\nasync with advisory_lock(session=session, key=42, nowait=True) as acquired:\n    if not acquired:\n        raise HTTPException(409, \"Resource is locked\")\n\n# Blocking with a timeout — raises LockTimeoutError if not acquired in time\nasync with advisory_lock(session=session, key=42, timeout=\"5s\"):\n    ...\n\n# Shared — multiple readers allowed simultaneously, blocks exclusive writers\nasync with advisory_lock(session=session, key=42, shared=True):\n    ...\n\n# Two-integer key for namespacing (e.g. lock_type + resource_id)\nasync with advisory_lock(session=session, key=(1, user_id)):\n    ...\n
     
    Note
     
    Advisory locks use PostgreSQL session-level functions (pg_advisory_lock / pg_advisory_unlock). The lock is tied to the database connection, not the SQLAlchemy transaction — it is released when the context exits, even if the surrounding transaction is still open.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#row-change-polling","level":2,"title":"Row-change polling","text":"
    wait_for_row_change polls a row until a specific column changes value, useful for waiting on async side effects:
     
    from fastapi_toolsets.db import wait_for_row_change\n\n# Wait up to 30s for order.status to change\nawait wait_for_row_change(\n    session=session,\n    model=Order,\n    pk_value=order_id,\n    columns=[Order.status],\n    interval=1.0,\n    timeout=30.0,\n)\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#creating-a-database","level":2,"title":"Creating a database","text":"
    Added in v2.1
     
    create_database creates a database at a given URL. It connects to server_url and issues a CREATE DATABASE statement:
     
    from fastapi_toolsets.db import create_database\n\nSERVER_URL = \"postgresql+asyncpg://postgres:postgres@localhost/postgres\"\n\nawait create_database(db_name=\"myapp_test\", server_url=SERVER_URL)\n
     
    For test isolation with automatic cleanup, use create_worker_database from the pytest module instead — it handles drop-before, create, and drop-after automatically.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#cleaning-up-tables","level":2,"title":"Cleaning up tables","text":"
    Added in v2.1
     
    cleanup_tables truncates all tables:
     
    from fastapi_toolsets.db import cleanup_tables\n\n@pytest.fixture(autouse=True)\nasync def clean(db_session):\n    yield\n    await cleanup_tables(session=db_session, base=Base)\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#many-to-many-helpers","level":2,"title":"Many-to-Many helpers","text":"
    SQLAlchemy's ORM collection API triggers lazy-loads when you append to a relationship inside a savepoint (e.g. inside lock_tables or a nested get_transaction). The three m2m_* helpers bypass the ORM collection entirely and issue direct SQL against the association table.
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#m2m_add-insert-associations","level":3,"title":"m2m_add — insert associations","text":"
    m2m_add inserts one or more rows into a secondary table without touching the ORM collection:
     
    from fastapi_toolsets.db import lock_tables, m2m_add\n\nasync with lock_tables(session_maker, [Tag]) as session:\n    tag = await TagCrud.create(session, TagCreate(name=\"python\"))\n    await m2m_add(session, post, Post.tags, tag)\n
     
    Pass ignore_conflicts=True to silently skip associations that already exist:
     
    await m2m_add(session, post, Post.tags, tag, ignore_conflicts=True)\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#m2m_remove-delete-associations","level":3,"title":"m2m_remove — delete associations","text":"
    m2m_remove deletes specific association rows. Removing a non-existent association is a no-op:
     
    from fastapi_toolsets.db import get_transaction, m2m_remove\n\nasync with get_transaction(session):\n    await m2m_remove(session, post, Post.tags, tag1, tag2)\n
    ","path":["Modules","DB"],"tags":[]},{"location":"module/db/#m2m_set-replace-the-full-set","level":3,"title":"m2m_set — replace the full set","text":"
    m2m_set atomically replaces all associations: it deletes every existing row for the owner instance then inserts the new set. Passing no related instances clears the association entirely:
     
    from fastapi_toolsets.db import get_transaction, m2m_set\n\n# Replace all tags\nasync with get_transaction(session):\n    await m2m_set(session, post, Post.tags, tag_a, tag_b)\n\n# Clear all tags\nasync with get_transaction(session):\n    await m2m_set(session, post, Post.tags)\n
     
    All three helpers raise TypeError if the relationship attribute is not a Many-to-Many (i.e. has no secondary table).
     
     API Reference
    ","path":["Modules","DB"],"tags":[]},{"location":"module/dependencies/","level":1,"title":"Dependencies","text":"
    FastAPI dependency factories for automatic model resolution from path and body parameters.
    ","path":["Modules","Dependencies"],"tags":[]},{"location":"module/dependencies/#overview","level":2,"title":"Overview","text":"
    The dependencies module provides two factory functions that create FastAPI dependencies to fetch a model instance from the database automatically — either from a path parameter or from a request body field — and inject it directly into your route handler.
    ","path":["Modules","Dependencies"],"tags":[]},{"location":"module/dependencies/#pathdependency","level":2,"title":"PathDependency","text":"
    PathDependency resolves a model from a URL path parameter and injects it into the route handler. Raises NotFoundError automatically if the record does not exist.
     
    from fastapi_toolsets.dependencies import PathDependency\n\n# Plain callable\nUserDep = PathDependency(model=User, field=User.id, session_dep=get_db)\n\n# Annotated\nSessionDep = Annotated[AsyncSession, Depends(get_db)]\nUserDep = PathDependency(model=User, field=User.id, session_dep=SessionDep)\n\n@router.get(\"/users/{user_id}\")\nasync def get_user(user: User = UserDep):\n    return user\n
     
    By default the parameter name is inferred from the field (user_id for User.id). You can override it:
     
    UserDep = PathDependency(model=User, field=User.id, session_dep=get_db, param_name=\"id\")\n\n@router.get(\"/users/{id}\")\nasync def get_user(user: User = UserDep):\n    return user\n
    ","path":["Modules","Dependencies"],"tags":[]},{"location":"module/dependencies/#bodydependency","level":2,"title":"BodyDependency","text":"
    BodyDependency resolves a model from a field in the request body. Useful when a body contains a foreign key and you want the full object injected:
     
    from fastapi_toolsets.dependencies import BodyDependency\n\n# Plain callable\nRoleDep = BodyDependency(model=Role, field=Role.id, session_dep=get_db, body_field=\"role_id\")\n\n# Annotated\nSessionDep = Annotated[AsyncSession, Depends(get_db)]\nRoleDep = BodyDependency(model=Role, field=Role.id, session_dep=SessionDep, body_field=\"role_id\")\n\n\n@router.post(\"/users\")\nasync def create_user(body: UserCreateSchema, role: Role = RoleDep):\n    user = User(username=body.username, role=role)\n    ...\n
     
     API Reference
    ","path":["Modules","Dependencies"],"tags":[]},{"location":"module/exceptions/","level":1,"title":"Exceptions","text":"
    Structured API exceptions with consistent error responses and automatic OpenAPI documentation.
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#overview","level":2,"title":"Overview","text":"
    The exceptions module provides a set of pre-built HTTP exceptions and a FastAPI exception handler that formats all errors — including validation errors — into a uniform ErrorResponse.
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#setup","level":2,"title":"Setup","text":"
    Register the exception handlers on your FastAPI app at startup:
     
    from fastapi import FastAPI\nfrom fastapi_toolsets.exceptions import init_exceptions_handlers\n\napp = FastAPI()\ninit_exceptions_handlers(app=app)\n
     
    This registers handlers for:
     
       
    • ApiException — all custom exceptions below
      •  
    • HTTPException — Starlette/FastAPI HTTP errors
      •  
    • RequestValidationError — Pydantic request validation (422)
      •  
    • ResponseValidationError — Pydantic response validation (422)
      •  
    • Exception — unhandled errors (500)
      •  
     
    It also patches app.openapi() to replace the default Pydantic 422 schema with a structured example matching the ErrorResponse format.
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#built-in-exceptions","level":2,"title":"Built-in exceptions","text":"Exception Status Default message UnauthorizedError 401 Unauthorized ForbiddenError 403 Forbidden NotFoundError 404 Not Found ConflictError 409 Conflict NoSearchableFieldsError 400 No Searchable Fields InvalidFacetFilterError 400 Invalid Facet Filter InvalidOrderFieldError 422 Invalid Order Field PoolExhaustedError 503 Service Unavailable LockTimeoutError 503 Service Unavailable","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#per-instance-overrides","level":3,"title":"Per-instance overrides","text":"
    All built-in exceptions accept optional keyword arguments to customise the response for a specific raise site without changing the class defaults:
     Argument Effect detail Overrides both str(exc) (log output) and the message field in the response body desc Overrides the description field data Overrides the data field 
    raise NotFoundError(detail=\"User 42 not found\", desc=\"No user with that ID exists in the database.\")\n
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#custom-exceptions","level":2,"title":"Custom exceptions","text":"
    Subclass ApiException and define an api_error class variable:
     
    from fastapi_toolsets.exceptions import ApiException\nfrom fastapi_toolsets.schemas import ApiError\n\nclass PaymentRequiredError(ApiException):\n    api_error = ApiError(\n        code=402,\n        msg=\"Payment Required\",\n        desc=\"Your subscription has expired.\",\n        err_code=\"BILLING-402\",\n    )\n
     
    Warning
     
    Subclasses that do not define api_error raise a TypeError at class creation time, not at raise time.
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#custom-__init__","level":3,"title":"Custom __init__","text":"
    Override __init__ to compute detail, desc, or data dynamically, then delegate to super().__init__():
     
    class OrderValidationError(ApiException):\n    api_error = ApiError(\n        code=422,\n        msg=\"Order Validation Failed\",\n        desc=\"One or more order fields are invalid.\",\n        err_code=\"ORDER-422\",\n    )\n\n    def __init__(self, *field_errors: str) -> None:\n        super().__init__(\n            f\"{len(field_errors)} validation error(s)\",\n            desc=\", \".join(field_errors),\n            data={\"errors\": [{\"message\": e} for e in field_errors]},\n        )\n
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#intermediate-base-classes","level":3,"title":"Intermediate base classes","text":"
    Use abstract=True when creating a shared base that is not meant to be raised directly:
     
    class BillingError(ApiException, abstract=True):\n    \"\"\"Base for all billing-related errors.\"\"\"\n\nclass PaymentRequiredError(BillingError):\n    api_error = ApiError(code=402, msg=\"Payment Required\", desc=\"...\", err_code=\"BILLING-402\")\n\nclass SubscriptionExpiredError(BillingError):\n    api_error = ApiError(code=402, msg=\"Subscription Expired\", desc=\"...\", err_code=\"BILLING-402-EXP\")\n
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/exceptions/#openapi-response-documentation","level":2,"title":"OpenAPI response documentation","text":"
    Use generate_error_responses to add error schemas to your endpoint's OpenAPI spec:
     
    from fastapi_toolsets.exceptions import generate_error_responses, NotFoundError, ForbiddenError\n\n@router.get(\n    \"/users/{id}\",\n    responses=generate_error_responses(NotFoundError, ForbiddenError),\n)\nasync def get_user(...): ...\n
     
    Multiple exceptions sharing the same HTTP status code are grouped under one entry, each appearing as a named example keyed by its err_code. This keeps the OpenAPI UI readable when several error variants map to the same status.
     
     API Reference
    ","path":["Modules","Exceptions"],"tags":[]},{"location":"module/fixtures/","level":1,"title":"Fixtures","text":"
    Dependency-aware database seeding with context-based loading strategies.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#overview","level":2,"title":"Overview","text":"
    The fixtures module lets you define named fixtures with dependencies between them, then load them into the database in the correct order. Fixtures can be scoped to contexts (e.g. base data, testing data) so that only the relevant ones are loaded for each environment.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#defining-fixtures","level":2,"title":"Defining fixtures","text":"
    from fastapi_toolsets.fixtures import FixtureRegistry, Context\n\nfixtures = FixtureRegistry()\n\n@fixtures.register\ndef roles():\n    return [\n        Role(id=1, name=\"admin\"),\n        Role(id=2, name=\"user\"),\n    ]\n\n@fixtures.register(depends_on=[\"roles\"], contexts=[Context.TESTING])\ndef test_users():\n    return [\n        User(id=1, username=\"alice\", role_id=1),\n        User(id=2, username=\"bob\", role_id=2),\n    ]\n
     
    Dependencies declared via depends_on are resolved topologically — roles will always be loaded before test_users.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#loading-fixtures","level":2,"title":"Loading fixtures","text":"
    By context with load_fixtures_by_context:
     
    from fastapi_toolsets.fixtures import load_fixtures_by_context\n\nasync with db_context() as session:\n    await load_fixtures_by_context(session, fixtures, Context.TESTING)\n
     
    Directly by name with load_fixtures:
     
    from fastapi_toolsets.fixtures import load_fixtures\n\nasync with db_context() as session:\n    await load_fixtures(session, fixtures, \"roles\", \"test_users\")\n
     
    Both functions return a dict[str, list[...]] mapping each fixture name to the list of loaded instances.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#contexts","level":2,"title":"Contexts","text":"
    Context is an enum with predefined values:
     Context Description Context.BASE Core data required in all environments Context.TESTING Data only loaded during tests Context.DEVELOPMENT Data only loaded in development Context.PRODUCTION Data only loaded in production 
    A fixture with no contexts defined takes Context.BASE by default.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#custom-contexts","level":3,"title":"Custom contexts","text":"
    Plain strings and any Enum subclass are accepted wherever a Context enum is expected.
     
    from enum import Enum\n\nclass AppContext(str, Enum):\n    STAGING = \"staging\"\n    DEMO = \"demo\"\n\n@fixtures.register(contexts=[AppContext.STAGING])\ndef staging_data():\n    return [Config(key=\"feature_x\", enabled=True)]\n\nawait load_fixtures_by_context(session, fixtures, AppContext.STAGING)\n
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#default-context-for-a-registry","level":3,"title":"Default context for a registry","text":"
    Pass contexts to FixtureRegistry to set a default for all fixtures registered in it:
     
    testing_registry = FixtureRegistry(contexts=[Context.TESTING])\n\n@testing_registry.register          # implicitly contexts=[Context.TESTING]\ndef test_orders():\n    return [Order(id=1, total=99)]\n
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#same-fixture-name-multiple-context-variants","level":3,"title":"Same fixture name, multiple context variants","text":"
    The same fixture name may be registered under different (non-overlapping) context sets. When multiple contexts are loaded together, all matching variants are merged:
     
    @fixtures.register(contexts=[Context.BASE])\ndef users():\n    return [User(id=1, username=\"admin\")]\n\n@fixtures.register(contexts=[Context.TESTING])\ndef users():\n    return [User(id=2, username=\"tester\")]\n\n# loads both admin and tester\nawait load_fixtures_by_context(session, fixtures, Context.BASE, Context.TESTING)\n
     
    Registering two variants with overlapping context sets raises ValueError.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#load-strategies","level":2,"title":"Load strategies","text":"
    LoadStrategy controls how the fixture loader handles rows that already exist:
     Strategy Description LoadStrategy.INSERT Insert only, fail on duplicates LoadStrategy.MERGE Insert or update on conflict (default) LoadStrategy.SKIP_EXISTING Skip rows that already exist 
    await load_fixtures_by_context(\n    session, fixtures, Context.BASE, strategy=LoadStrategy.SKIP_EXISTING\n)\n
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#merging-registries","level":2,"title":"Merging registries","text":"
    Split fixture definitions across modules and merge them:
     
    from myapp.fixtures.dev import dev_fixtures\nfrom myapp.fixtures.prod import prod_fixtures\n\nfixtures = FixtureRegistry()\nfixtures.include_registry(registry=dev_fixtures)\nfixtures.include_registry(registry=prod_fixtures)\n
     
    Fixtures with the same name are allowed as long as their context sets do not overlap. Conflicting contexts raise ValueError.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#looking-up-fixture-instances","level":2,"title":"Looking up fixture instances","text":"
    get_obj_by_attr retrieves a specific instance from a fixture function by attribute value — useful when building cross-fixture depends_on relationships:
     
    from fastapi_toolsets.fixtures import get_obj_by_attr\n\n@fixtures.register(depends_on=[\"roles\"])\ndef users():\n    admin_role = get_obj_by_attr(roles, \"name\", \"admin\")\n    return [User(id=1, username=\"alice\", role_id=admin_role.id)]\n
     
    Raises StopIteration if no matching instance is found.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#pytest-integration","level":2,"title":"Pytest integration","text":"
    Use register_fixtures to expose each fixture in your registry as an injectable pytest fixture named fixture_{name} by default:
     
    # conftest.py\nimport pytest\nfrom fastapi_toolsets.pytest import create_db_session, register_fixtures\nfrom app.fixtures import registry\nfrom app.models import Base\n\nDATABASE_URL = \"postgresql+asyncpg://user:pass@localhost/test_db\"\n\n@pytest.fixture\nasync def db_session():\n    async with create_db_session(database_url=DATABASE_URL, base=Base, cleanup=True) as session:\n        yield session\n\nregister_fixtures(registry=registry, namespace=globals())\n
     
    # test_users.py\nasync def test_user_can_login(fixture_users: list[User], fixture_roles: list[Role]):\n    ...\n
     
    The load order is resolved automatically from the depends_on declarations in your registry. Each generated fixture receives db_session as a dependency and returns the list of loaded model instances.
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/fixtures/#cli-integration","level":2,"title":"CLI integration","text":"
    Fixtures can be triggered from the CLI. See the CLI module for setup instructions.
     
     API Reference
    ","path":["Modules","Fixtures"],"tags":[]},{"location":"module/logger/","level":1,"title":"Logger","text":"
    Lightweight logging utilities with consistent formatting and uvicorn integration.
    ","path":["Modules","Logger"],"tags":[]},{"location":"module/logger/#overview","level":2,"title":"Overview","text":"
    The logger module provides two helpers: one to configure the root logger (and uvicorn loggers) at startup, and one to retrieve a named logger anywhere in your codebase.
    ","path":["Modules","Logger"],"tags":[]},{"location":"module/logger/#setup","level":2,"title":"Setup","text":"
    Call configure_logging once at application startup:
     
    from fastapi_toolsets.logger import configure_logging\n\nconfigure_logging(level=\"INFO\")\n
     
    This sets up a stdout handler with a consistent format and also configures uvicorn's access and error loggers so all log output shares the same style.
    ","path":["Modules","Logger"],"tags":[]},{"location":"module/logger/#getting-a-logger","level":2,"title":"Getting a logger","text":"
    from fastapi_toolsets.logger import get_logger\n\nlogger = get_logger(name=__name__)\nlogger.info(\"User created\")\n
     
    When called without arguments, get_logger auto-detects the caller's module name via frame inspection:
     
    # Equivalent to get_logger(name=__name__)\nlogger = get_logger()\n
     
     API Reference
    ","path":["Modules","Logger"],"tags":[]},{"location":"module/metrics/","level":1,"title":"Metrics","text":"
    Prometheus metrics integration with a decorator-based registry and multi-process support.
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#installation","level":2,"title":"Installation","text":"uvpip 
    uv add \"fastapi-toolsets[metrics]\"\n
     
    pip install \"fastapi-toolsets[metrics]\"\n
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#overview","level":2,"title":"Overview","text":"
    The metrics module provides a MetricsRegistry to declare Prometheus metrics with decorators, and an init_metrics function to mount a /metrics endpoint on your FastAPI app.
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#setup","level":2,"title":"Setup","text":"
    from fastapi import FastAPI\nfrom fastapi_toolsets.metrics import MetricsRegistry, init_metrics\n\napp = FastAPI()\nmetrics = MetricsRegistry()\n\ninit_metrics(app=app, registry=metrics)\n
     
    This mounts the /metrics endpoint that Prometheus can scrape.
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#declaring-metrics","level":2,"title":"Declaring metrics","text":"","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#providers","level":3,"title":"Providers","text":"
    Providers are called once at startup by init_metrics. The return value (the Prometheus metric object) is stored in the registry and can be retrieved later with registry.get(name).
     
    Use providers when you want deferred initialization: the Prometheus metric is not registered with the global CollectorRegistry until init_metrics runs, not at import time. This is particularly useful for testing — importing the module in a test suite without calling init_metrics leaves no metrics registered, avoiding cross-test pollution.
     
    It is also useful when metrics are defined across multiple modules and merged with include_registry: any code that needs a metric can call metrics.get() on the shared registry instead of importing the metric directly from its origin module.
     
    If neither of these applies to you, declaring metrics at module level (e.g. HTTP_REQUESTS = Counter(...)) is simpler and equally valid.
     
    from prometheus_client import Counter, Histogram\n\n@metrics.register\ndef http_requests():\n    return Counter(\"http_requests_total\", \"Total HTTP requests\", [\"method\", \"status\"])\n\n@metrics.register\ndef request_duration():\n    return Histogram(\"request_duration_seconds\", \"Request duration\")\n
     
    To use a provider's metric elsewhere (e.g. in a middleware), call metrics.get() inside the handler — not at module level, as providers are only initialized when init_metrics runs:
     
    async def metrics_middleware(request: Request, call_next):\n    response = await call_next(request)\n    metrics.get(\"http_requests\").labels(\n        method=request.method, status=response.status_code\n    ).inc()\n    return response\n
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#collectors","level":3,"title":"Collectors","text":"
    Collectors are called on every scrape. Use them for metrics that reflect current state (e.g. gauges).
     
    Declare the metric at module level
     
    Do not instantiate the Prometheus metric inside the collector function. Doing so recreates it on every scrape, raising ValueError: Duplicated timeseries in CollectorRegistry. Declare it once at module level instead:
     
    from prometheus_client import Gauge\n\n_queue_depth = Gauge(\"queue_depth\", \"Current queue depth\")\n\n@metrics.register(collect=True)\ndef collect_queue_depth():\n    _queue_depth.set(get_current_queue_depth())\n
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#merging-registries","level":2,"title":"Merging registries","text":"
    Split metrics definitions across modules and merge them:
     
    from myapp.metrics.http import http_metrics\nfrom myapp.metrics.db import db_metrics\n\nmetrics = MetricsRegistry()\nmetrics.include_registry(registry=http_metrics)\nmetrics.include_registry(registry=db_metrics)\n
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/metrics/#multi-process-mode","level":2,"title":"Multi-process mode","text":"
    Multi-process support is enabled automatically when the PROMETHEUS_MULTIPROC_DIR environment variable is set. No code changes are required.
     
    Environment variable name
     
    The correct variable is PROMETHEUS_MULTIPROC_DIR (not PROMETHEUS_MULTIPROCESS_DIR).
     
     API Reference
    ","path":["Modules","Metrics"],"tags":[]},{"location":"module/models/","level":1,"title":"Models","text":"
    Added in v2.0
     
    Reusable SQLAlchemy 2.0 mixins for common column patterns, designed to be composed freely on any DeclarativeBase model.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#overview","level":2,"title":"Overview","text":"
    The models module provides mixins that each add a single, well-defined column behaviour. They work with standard SQLAlchemy 2.0 declarative syntax and are fully compatible with AsyncSession.
     
    from fastapi_toolsets.models import UUIDMixin, TimestampMixin\n\nclass Article(Base, UUIDMixin, TimestampMixin):\n    __tablename__ = \"articles\"\n\n    title: Mapped[str]\n    content: Mapped[str]\n
     
    All timestamp columns are timezone-aware (TIMESTAMPTZ). All defaults are server-side (clock_timestamp()), so they are also applied when inserting rows via raw SQL outside the ORM.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#mixins","level":2,"title":"Mixins","text":"","path":["Modules","Models"],"tags":[]},{"location":"module/models/#uuidmixin","level":3,"title":"UUIDMixin","text":"
    Adds a id: UUID primary key generated server-side by PostgreSQL using gen_random_uuid(). The value is retrieved via RETURNING after insert, so it is available on the Python object immediately after flush().
     
    Requires PostgreSQL 13+
     
    from fastapi_toolsets.models import UUIDMixin\n\nclass User(Base, UUIDMixin):\n    __tablename__ = \"users\"\n\n    username: Mapped[str]\n\n# id is None before flush\nuser = User(username=\"alice\")\nsession.add(user)\nawait session.flush()\nprint(user.id)  # UUID('...')\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#uuidv7mixin","level":3,"title":"UUIDv7Mixin","text":"
    Added in v2.3
     
    Adds a id: UUID primary key generated server-side by PostgreSQL using uuidv7(). It's a time-ordered UUID format that encodes a millisecond-precision timestamp in the most significant bits, making it naturally sortable and index-friendly.
     
    Requires PostgreSQL 18+
     
    from fastapi_toolsets.models import UUIDv7Mixin\n\nclass Event(Base, UUIDv7Mixin):\n    __tablename__ = \"events\"\n\n    name: Mapped[str]\n\n# id is None before flush\nevent = Event(name=\"user.signup\")\nsession.add(event)\nawait session.flush()\nprint(event.id)  # UUID('019...')\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#createdatmixin","level":3,"title":"CreatedAtMixin","text":"
    Adds a created_at: datetime column set to clock_timestamp() on insert. The column has no onupdate hook — it is intentionally immutable after the row is created.
     
    from fastapi_toolsets.models import UUIDMixin, CreatedAtMixin\n\nclass Order(Base, UUIDMixin, CreatedAtMixin):\n    __tablename__ = \"orders\"\n\n    total: Mapped[float]\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#updatedatmixin","level":3,"title":"UpdatedAtMixin","text":"
    Adds an updated_at: datetime column set to clock_timestamp() on insert and automatically updated to clock_timestamp() on every ORM-level update (via SQLAlchemy's onupdate hook).
     
    from fastapi_toolsets.models import UUIDMixin, UpdatedAtMixin\n\nclass Post(Base, UUIDMixin, UpdatedAtMixin):\n    __tablename__ = \"posts\"\n\n    title: Mapped[str]\n\npost = Post(title=\"Hello\")\nawait session.flush()\nawait session.refresh(post)\n\npost.title = \"Hello World\"\nawait session.flush()\nawait session.refresh(post)\nprint(post.updated_at)\n
     
    Note
     
    updated_at is updated by SQLAlchemy at ORM flush time. If you update rows via raw SQL (e.g. UPDATE posts SET ...), the column will not be updated automatically — use a database trigger if you need that guarantee.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#timestampmixin","level":3,"title":"TimestampMixin","text":"
    Convenience mixin that combines CreatedAtMixin and UpdatedAtMixin. Equivalent to inheriting both.
     
    from fastapi_toolsets.models import UUIDMixin, TimestampMixin\n\nclass Article(Base, UUIDMixin, TimestampMixin):\n    __tablename__ = \"articles\"\n\n    title: Mapped[str]\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#lifecycle-events","level":2,"title":"Lifecycle events","text":"
    The event system provides lifecycle callbacks that fire after commit. If the transaction rolls back, no callback fires.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#setup","level":3,"title":"Setup","text":"
    Event dispatch requires EventSession. Pass it as the session class when creating your session factory:
     
    from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine\nfrom fastapi_toolsets.models import EventSession\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False, class_=EventSession)\n
     
    Callbacks fire on session.commit() only — not on savepoints.
     
    Savepoints created by get_transaction or begin_nested() do not trigger callbacks. All events accumulated across flushes are dispatched once when the outermost commit() is called.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#events","level":3,"title":"Events","text":"
    Three event types are available, each corresponding to a ModelEvent value:
     Event Trigger ModelEvent.CREATE After INSERT commit ModelEvent.DELETE After DELETE commit ModelEvent.UPDATE After UPDATE commit on a watched field 
    Callbacks fire only for ORM-level changes. Rows updated via raw SQL (UPDATE ... SET ...) are not detected.
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#watched-fields","level":3,"title":"Watched fields","text":"
    Set __watched_fields__ on the model to restrict which field changes trigger UPDATE events. It must be a tuple[str, ...] — any other type raises TypeError:
     Class attribute UPDATE behaviour __watched_fields__ = (\"status\", \"role\") Only fires when status or role changes (not set) Fires when any mapped field changes 
    __watched_fields__ is inherited through the class hierarchy via normal Python MRO. A subclass can override it:
     
    class Order(Base, UUIDMixin):\n    __watched_fields__ = (\"status\",)\n    ...\n\nclass UrgentOrder(Order):\n    # inherits __watched_fields__ = (\"status\",)\n    ...\n\nclass PriorityOrder(Order):\n    __watched_fields__ = (\"priority\",)\n    # overrides parent — UPDATE fires only for priority changes\n    ...\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#registering-handlers","level":3,"title":"Registering handlers","text":"
    Register handlers with the listens_for decorator. Every callback receives three arguments: the model instance, the ModelEvent that triggered it, and a changes dict (None for CREATE and DELETE):
     
    from fastapi_toolsets.models import ModelEvent, UUIDMixin, listens_for\n\nclass Order(Base, UUIDMixin):\n    __tablename__ = \"orders\"\n    __watched_fields__ = (\"status\",)\n\n    status: Mapped[str]\n\n@listens_for(Order, [ModelEvent.CREATE])\nasync def on_order_created(order: Order, event_type: ModelEvent, changes: None):\n    await notify_new_order(order.id)\n\n@listens_for(Order, [ModelEvent.DELETE])\nasync def on_order_deleted(order: Order, event_type: ModelEvent, changes: None):\n    await notify_order_cancelled(order.id)\n\n@listens_for(Order, [ModelEvent.UPDATE])\nasync def on_order_updated(order: Order, event_type: ModelEvent, changes: dict):\n    if \"status\" in changes:\n        await notify_status_change(order.id, changes[\"status\"])\n
     
    Multiple handlers can be registered for the same model and event. Handlers registered on a parent class also fire for subclass instances.
     
    A single handler can listen for multiple events at once. When event_types is omitted, the handler fires for all events:
     
    @listens_for(Order, [ModelEvent.CREATE, ModelEvent.UPDATE])\nasync def on_order_changed(order: Order, event_type: ModelEvent, changes: dict | None):\n    await invalidate_cache(order.id)\n\n@listens_for(Order)  # all events\nasync def on_any_order_event(order: Order, event_type: ModelEvent, changes: dict | None):\n    await audit_log(order.id, event_type)\n
    ","path":["Modules","Models"],"tags":[]},{"location":"module/models/#field-changes-format","level":3,"title":"Field changes format","text":"
    The changes dict maps each watched field that changed to {\"old\": ..., \"new\": ...}. Only fields that actually changed are included. For CREATE and DELETE events, changes is None:
     
    # CREATE / DELETE → changes is None\n# status changed   → {\"status\": {\"old\": \"pending\", \"new\": \"shipped\"}}\n# two fields changed → {\"status\": {...}, \"assigned_to\": {...}}\n
     
    Multiple flushes in one transaction are merged: the earliest old and latest new are preserved, and on_update fires only once per commit.
     
     API Reference
    ","path":["Modules","Models"],"tags":[]},{"location":"module/pytest/","level":1,"title":"Pytest","text":"
    Testing helpers for FastAPI applications with async client, database sessions, and parallel worker support.
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#installation","level":2,"title":"Installation","text":"uvpip 
    uv add \"fastapi-toolsets[pytest]\"\n
     
    pip install \"fastapi-toolsets[pytest]\"\n
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#overview","level":2,"title":"Overview","text":"
    The pytest module provides utilities for setting up async test clients, managing test database sessions, and supporting parallel test execution with pytest-xdist.
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#creating-an-async-client","level":2,"title":"Creating an async client","text":"
    Use create_async_client to get an httpx.AsyncClient configured for your FastAPI app:
     
    from fastapi_toolsets.pytest import create_async_client\n\n@pytest.fixture\nasync def http_client(db_session):\n    async def _override_get_db():\n        yield db_session\n\n    async with create_async_client(\n        app=app,\n        base_url=\"http://127.0.0.1/api/v1\",\n        dependency_overrides={get_db: _override_get_db},\n    ) as c:\n        yield c\n
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#database-sessions-in-tests","level":2,"title":"Database sessions in tests","text":"
    Use create_db_session to create an isolated AsyncSession for a test, combined with create_worker_database to set up a per-worker database:
     
    from fastapi_toolsets.pytest import create_worker_database, create_db_session\n\n@pytest.fixture(scope=\"session\")\nasync def worker_db_url():\n    async with create_worker_database(\n        database_url=str(settings.SQLALCHEMY_DATABASE_URI)\n    ) as url:\n        yield url\n\n\n@pytest.fixture\nasync def db_session(worker_db_url):\n    async with create_db_session(\n        database_url=worker_db_url, base=Base, cleanup=True\n    ) as session:\n        yield session\n
     
    Info
     
    In this example, the database is reset between each test using the argument cleanup=True.
     
    Use worker_database_url to derive the per-worker URL manually if needed:
     
    from fastapi_toolsets.pytest import worker_database_url\n\nurl = worker_database_url(\"postgresql+asyncpg://user:pass@localhost/test_db\", default_test_db=\"test\")\n# e.g. \"postgresql+asyncpg://user:pass@localhost/test_db_gw0\" under xdist\n
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#parallel-testing-with-pytest-xdist","level":2,"title":"Parallel testing with pytest-xdist","text":"
    The examples above are already compatible with parallel test execution with pytest-xdist.
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/pytest/#cleaning-up-tables","level":2,"title":"Cleaning up tables","text":"
    If you want to manually clean up a database you can use cleanup_tables, this will truncate all tables between tests for fast isolation:
     
    from fastapi_toolsets.db import cleanup_tables\n\n@pytest.fixture(autouse=True)\nasync def clean(db_session):\n    yield\n    await cleanup_tables(session=db_session, base=Base)\n
     
     API Reference
    ","path":["Modules","Pytest"],"tags":[]},{"location":"module/schemas/","level":1,"title":"Schemas","text":"
    Standardized Pydantic response models for consistent API responses across your FastAPI application.
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#overview","level":2,"title":"Overview","text":"
    The schemas module provides generic response wrappers that enforce a uniform response structure. All models use from_attributes=True for ORM compatibility and validate_assignment=True for runtime type safety.
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#response-models","level":2,"title":"Response models","text":"","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#responset","level":3,"title":"Response[T]","text":"
    The most common wrapper for a single resource response.
     
    from fastapi_toolsets.schemas import Response\n\n@router.get(\"/users/{id}\")\nasync def get_user(user: User = UserDep) -> Response[UserSchema]:\n    return Response(data=user, message=\"User retrieved\")\n
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#paginated-response-models","level":3,"title":"Paginated response models","text":"
    Three classes wrap paginated list results. Pick the one that matches your endpoint's strategy:
     Class pagination type pagination_type field Use when OffsetPaginatedResponse[T] OffsetPagination \"offset\" (fixed) endpoint always uses offset CursorPaginatedResponse[T] CursorPagination \"cursor\" (fixed) endpoint always uses cursor PaginatedResponse[T] OffsetPagination \\| CursorPagination — unified endpoint supporting both strategies","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#offsetpaginatedresponset","level":4,"title":"OffsetPaginatedResponse[T]","text":"
    Added in v2.3.0
     
    Use as the return type when the endpoint always uses offset_paginate.  The pagination field is guaranteed to be an OffsetPagination object; the response always includes a pagination_type: \"offset\" discriminator.
     
    from fastapi_toolsets.schemas import OffsetPaginatedResponse\n\n@router.get(\"/users\")\nasync def list_users(\n    page: int = 1,\n    items_per_page: int = 20,\n) -> OffsetPaginatedResponse[UserSchema]:\n    return await UserCrud.offset_paginate(\n        session, page=page, items_per_page=items_per_page, schema=UserSchema\n    )\n
     
    Response shape:
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"offset\",\n  \"data\": [\"...\"],\n  \"pagination\": {\n    \"total_count\": 100,\n    \"page\": 1,\n    \"items_per_page\": 20,\n    \"has_more\": true\n  }\n}\n
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#cursorpaginatedresponset","level":4,"title":"CursorPaginatedResponse[T]","text":"
    Added in v2.3.0
     
    Use as the return type when the endpoint always uses cursor_paginate.  The pagination field is guaranteed to be a CursorPagination object; the response always includes a pagination_type: \"cursor\" discriminator.
     
    from fastapi_toolsets.schemas import CursorPaginatedResponse\n\n@router.get(\"/events\")\nasync def list_events(\n    cursor: str | None = None,\n    items_per_page: int = 20,\n) -> CursorPaginatedResponse[EventSchema]:\n    return await EventCrud.cursor_paginate(\n        session, cursor=cursor, items_per_page=items_per_page, schema=EventSchema\n    )\n
     
    Response shape:
     
    {\n  \"status\": \"SUCCESS\",\n  \"pagination_type\": \"cursor\",\n  \"data\": [\"...\"],\n  \"pagination\": {\n    \"next_cursor\": \"eyJpZCI6IDQyfQ==\",\n    \"prev_cursor\": null,\n    \"items_per_page\": 20,\n    \"has_more\": true\n  }\n}\n
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#paginatedresponset","level":4,"title":"PaginatedResponse[T]","text":"
    Return type for endpoints that support both pagination strategies via a pagination_type query parameter (using paginate()).
     
    When used as a return annotation, PaginatedResponse[T] automatically expands to Annotated[Union[CursorPaginatedResponse[T], OffsetPaginatedResponse[T]], Field(discriminator=\"pagination_type\")], so FastAPI emits a proper oneOf + discriminator in the OpenAPI schema with no extra boilerplate:
     
    from fastapi_toolsets.crud import PaginationType\nfrom fastapi_toolsets.schemas import PaginatedResponse\n\n@router.get(\"/users\")\nasync def list_users(\n    pagination_type: PaginationType = PaginationType.OFFSET,\n    page: int = 1,\n    cursor: str | None = None,\n    items_per_page: int = 20,\n) -> PaginatedResponse[UserSchema]:\n    return await UserCrud.paginate(\n        session,\n        pagination_type=pagination_type,\n        page=page,\n        cursor=cursor,\n        items_per_page=items_per_page,\n        schema=UserSchema,\n    )\n
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#pagination-metadata-models","level":4,"title":"Pagination metadata models","text":"
    The optional filter_attributes field is populated when facet_fields are configured on the CRUD class (see Filter attributes). It is None by default and can be hidden from API responses with response_model_exclude_none=True.
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/schemas/#errorresponse","level":3,"title":"ErrorResponse","text":"
    Returned automatically by the exceptions handler.
     
     API Reference
    ","path":["Modules","Schemas"],"tags":[]},{"location":"module/security/","level":1,"title":"Security","text":"
    Composable authentication helpers for FastAPI that use Security() for OpenAPI documentation and accept user-provided validator functions with full type flexibility.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#overview","level":2,"title":"Overview","text":"
    The security module provides four auth source classes, a MultiAuth factory, and a set of OAuth 2.0 / OIDC helper utilities. Each auth class wraps a FastAPI security scheme for OpenAPI and accepts a validator function called as:
     
    await validator(credential, **kwargs)\n
     
    where kwargs are the extra keyword arguments provided at instantiation (roles, permissions, enums, etc.). The validator returns the authenticated identity (e.g. a User model) which becomes the route dependency value.
     
    from fastapi import Security\nfrom fastapi_toolsets.security import BearerTokenAuth\n\nasync def verify_token(token: str, *, role: str) -> User:\n    user = await db.get_by_token(token)\n    if not user or user.role != role:\n        raise UnauthorizedError()\n    return user\n\nbearer_admin = BearerTokenAuth(verify_token, role=\"admin\")\n\n@app.get(\"/admin\")\nasync def admin_route(user: User = Security(bearer_admin)):\n    return user\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#auth-sources","level":2,"title":"Auth sources","text":"","path":["Modules","Security"],"tags":[]},{"location":"module/security/#bearertokenauth","level":3,"title":"BearerTokenAuth","text":"
    Reads the Authorization: Bearer <token> header. Wraps HTTPBearer for OpenAPI.
     
    from fastapi_toolsets.security import BearerTokenAuth\n\nbearer = BearerTokenAuth(validator=verify_token)\n\n@app.get(\"/me\")\nasync def me(user: User = Security(bearer)):\n    return user\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#token-prefix","level":4,"title":"Token prefix","text":"
    The optional prefix parameter restricts a BearerTokenAuth instance to tokens that start with a given string. The prefix is kept in the value passed to the validator — store and compare tokens with their prefix included.
     
    This lets you deploy multiple BearerTokenAuth instances in the same application and disambiguate them efficiently in MultiAuth:
     
    user_bearer = BearerTokenAuth(verify_user, prefix=\"user_\")  # matches \"Bearer user_...\"\norg_bearer  = BearerTokenAuth(verify_org,  prefix=\"org_\")   # matches \"Bearer org_...\"\n
     
    Use generate_token() to create correctly-prefixed tokens.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#token-generation","level":4,"title":"Token generation","text":"
    BearerTokenAuth.generate_token() produces a secure random token ready to store in your database and return to the client. If a prefix is configured it is prepended automatically:
     
    bearer = BearerTokenAuth(verify_token, prefix=\"user_\")\n\ntoken = bearer.generate_token()   # e.g. \"user_Xk3mN...\"\nawait db.store_token(user_id, token)\nreturn {\"access_token\": token, \"token_type\": \"bearer\"}\n
     
    The client sends Authorization: Bearer user_Xk3mN... and the validator receives the full token (prefix included) to compare against the stored value.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#cookieauth","level":3,"title":"CookieAuth","text":"
    Reads a named cookie. Wraps APIKeyCookie for OpenAPI.
     
    Cookies are issued with the Secure flag set by default, meaning they are only transmitted over HTTPS. Set secure=False when running locally over plain HTTP:
     
    from fastapi_toolsets.security import CookieAuth\n\n# Production (HTTPS) — default\ncookie_auth = CookieAuth(\"session\", validator=verify_session)\n\n# Local development (HTTP only)\ncookie_auth = CookieAuth(\"session\", validator=verify_session, secure=False)\n\n@app.get(\"/me\")\nasync def me(user: User = Security(cookie_auth)):\n    return user\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#signed-cookies","level":4,"title":"Signed cookies","text":"
    Pass secret_key to enable HMAC-SHA256 signed, tamper-proof cookies. The cookie payload includes an expiry timestamp (ttl, default 24 h). No database entry is required — the signature is self-contained.
     
    Use set_cookie() to issue the signed cookie on login and delete_cookie() to clear it on logout:
     
    # Production\ncookie_auth = CookieAuth(\"session\", verify_session, secret_key=\"your-secret\")\n\n# Local development\ncookie_auth = CookieAuth(\"session\", verify_session, secret_key=\"your-secret\", secure=False)\n\n@app.post(\"/login\")\nasync def login(response: Response):\n    cookie_auth.set_cookie(response, user_id)\n    return {\"ok\": True}\n\n@app.post(\"/logout\")\nasync def logout(response: Response):\n    cookie_auth.delete_cookie(response)\n    return {\"ok\": True}\n\n@app.get(\"/me\")\nasync def me(user: User = Security(cookie_auth)):\n    return user\n
     
    When secret_key is not set, the raw cookie value is passed directly to the validator (stateful session behaviour — you manage the session store).
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#apikeyheaderauth","level":3,"title":"APIKeyHeaderAuth","text":"
    Reads an API key from a named HTTP header. Wraps APIKeyHeader for OpenAPI.
     
    from fastapi_toolsets.security import APIKeyHeaderAuth\n\napi_key_auth = APIKeyHeaderAuth(\"X-API-Key\", validator=verify_api_key)\n\n@app.get(\"/data\")\nasync def data(user: User = Security(api_key_auth)):\n    return user\n
     
    The header name is configurable — use any header your API defines (e.g. \"X-API-Key\", \"Authorization\", \"X-Service-Token\").
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#typed-validator-kwargs","level":2,"title":"Typed validator kwargs","text":"
    All auth classes forward extra instantiation keyword arguments to the validator. Arguments can be any type — enums, strings, integers, etc. The validator returns the authenticated identity, which FastAPI injects directly into the route handler.
     
    async def verify_token(token: str, *, role: Role, permission: str) -> User:\n    user = await decode_token(token)\n    if user.role != role or permission not in user.permissions:\n        raise UnauthorizedError()\n    return user\n\nbearer = BearerTokenAuth(verify_token, role=Role.ADMIN, permission=\"billing:read\")\n
     
    Each auth instance is self-contained — create a separate instance per distinct requirement instead of passing requirements through Security(scopes=[...]).
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#using-require-inline","level":3,"title":"Using .require() inline","text":"
    If declaring a new top-level variable per role feels verbose, use .require() to create a configured clone directly in the route decorator. The original instance is not mutated:
     
    bearer = BearerTokenAuth(verify_token)\n\n@app.get(\"/admin/stats\")\nasync def admin_stats(user: User = Security(bearer.require(role=Role.ADMIN))):\n    return {\"message\": f\"Hello admin {user.name}\"}\n\n@app.get(\"/profile\")\nasync def profile(user: User = Security(bearer.require(role=Role.USER))):\n    return {\"id\": user.id, \"name\": user.name}\n
     
    .require() kwargs are merged over existing ones — new values win on conflict. The prefix (for BearerTokenAuth), cookie name and secret_key (for CookieAuth), and header name (for APIKeyHeaderAuth) are always preserved.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#multiauth","level":2,"title":"MultiAuth","text":"
    MultiAuth combines multiple auth sources into a single callable. Sources are tried in order; the first one that finds a credential wins.
     
    If a credential is extracted but the validator raises, the exception propagates immediately — the remaining sources are not tried. This prevents silent fallthrough on invalid credentials.
     
    from fastapi_toolsets.security import MultiAuth\n\nmulti = MultiAuth(user_bearer, org_bearer, cookie_auth)\n\n@app.get(\"/data\")\nasync def data_route(user = Security(multi)):\n    return user\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#using-require-on-multiauth","level":3,"title":"Using .require() on MultiAuth","text":"
    MultiAuth also supports .require(), which propagates the kwargs to every source that implements it. Sources that do not (e.g. custom AuthSource subclasses) are passed through unchanged:
     
    multi = MultiAuth(bearer, cookie)\n\n@app.get(\"/admin\")\nasync def admin(user: User = Security(multi.require(role=Role.ADMIN))):\n    return user\n
     
    This is equivalent to calling .require() on each source individually:
     
    # These two are identical\nmulti.require(role=Role.ADMIN)\n\nMultiAuth(\n    bearer.require(role=Role.ADMIN),\n    cookie.require(role=Role.ADMIN),\n)\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#prefix-based-dispatch","level":3,"title":"Prefix-based dispatch","text":"
    Because extract() is pure string matching (no I/O), prefix-based source selection is essentially free. Only the matching source's validator (which may involve DB or network I/O) is ever called:
     
    user_bearer = BearerTokenAuth(verify_user, prefix=\"user_\")\norg_bearer  = BearerTokenAuth(verify_org,  prefix=\"org_\")\n\nmulti = MultiAuth(user_bearer, org_bearer)\n\n# \"Bearer user_alice\" → only verify_user runs, receives \"user_alice\"\n# \"Bearer org_acme\"   → only verify_org runs, receives \"org_acme\"\n
     
    Tokens are stored and compared with their prefix — use generate_token() on each source to issue correctly-prefixed tokens:
     
    user_token = user_bearer.generate_token()  # \"user_...\"\norg_token  = org_bearer.generate_token()   # \"org_...\"\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#custom-auth-sources","level":2,"title":"Custom auth sources","text":"
    Subclass AuthSource to implement any credential extraction strategy. You only need to implement extract() and authenticate():
     
    from fastapi_toolsets.security import AuthSource\nfrom fastapi_toolsets.exceptions import UnauthorizedError\n\nclass MTLSAuth(AuthSource):\n    async def extract(self, request) -> str | None:\n        return request.headers.get(\"X-Client-Cert-DN\") or None\n\n    async def authenticate(self, credential: str):\n        dn = parse_dn(credential)\n        if dn.get(\"O\") != \"MyOrg\":\n            raise UnauthorizedError()\n        return {\"dn\": credential}\n
     
    Custom sources work transparently inside MultiAuth.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#oauth-20-oidc-helpers","level":2,"title":"OAuth 2.0 / OIDC helpers","text":"
    The module provides standalone async utilities for building OAuth 2.0 / OIDC login flows. They handle provider discovery, authorization redirects, token exchange, and state encoding — leaving JWT validation and session management to your application.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#provider-discovery","level":3,"title":"Provider discovery","text":"
    oauth_resolve_provider_urls() fetches the OIDC discovery document and returns the endpoint URLs. Results are cached in-process to avoid repeated network calls:
     
    from fastapi_toolsets.security import oauth_resolve_provider_urls\n\nauth_url, token_url, userinfo_url = await oauth_resolve_provider_urls(\n    \"https://accounts.google.com/.well-known/openid-configuration\"\n)\n
     
    Returns a (authorization_url, token_url, userinfo_url) tuple. userinfo_url is None when the provider does not advertise one.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#authorization-redirect","level":3,"title":"Authorization redirect","text":"
    oauth_build_authorization_redirect() constructs the redirect to the provider's authorization page.  It requires a state_token — a random CSRF token generated by oauth_generate_state_token() — that must be stored server-side (e.g. in the session) and verified on the callback to prevent login-CSRF attacks (RFC 6749 §10.12):
     
    from fastapi import Request\nfrom fastapi_toolsets.security import oauth_build_authorization_redirect, oauth_generate_state_token\n\n@app.get(\"/auth/google/login\")\nasync def google_login(request: Request):\n    auth_url, _, _ = await oauth_resolve_provider_urls(GOOGLE_DISCOVERY_URL)\n    state_token = oauth_generate_state_token()\n    request.session[\"oauth_state\"] = state_token  # requires SessionMiddleware\n    return oauth_build_authorization_redirect(\n        auth_url,\n        client_id=GOOGLE_CLIENT_ID,\n        scopes=\"openid email profile\",\n        redirect_uri=\"https://myapp.com/auth/google/callback\",\n        destination=\"/dashboard\",\n        state_token=state_token,\n    )\n
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#token-exchange-and-userinfo","level":3,"title":"Token exchange and userinfo","text":"
    oauth_fetch_userinfo() performs the two-step exchange: it POSTs the authorization code to the token endpoint, then GETs the userinfo endpoint with the resulting access token.
     
    On the callback, retrieve the stored token and pass it to oauth_decode_state() to verify the CSRF token before processing the code:
     
    from fastapi import HTTPException, Request\nfrom fastapi_toolsets.security import oauth_decode_state, oauth_fetch_userinfo\n\n@app.get(\"/auth/google/callback\")\nasync def google_callback(request: Request, code: str, state: str):\n    # Pop token first — single-use, regardless of whether verification succeeds\n    state_token = request.session.pop(\"oauth_state\", None)\n    if state_token is None:\n        raise HTTPException(status_code=400, detail=\"missing OAuth state\")\n    destination = oauth_decode_state(state, expected_state_token=state_token, fallback=\"/\")\n    if not destination.startswith(\"/\"):  # reject absolute URLs to prevent open-redirect\n        destination = \"/\"\n\n    _, token_url, userinfo_url = await oauth_resolve_provider_urls(GOOGLE_DISCOVERY_URL)\n    userinfo = await oauth_fetch_userinfo(\n        token_url=token_url,\n        userinfo_url=userinfo_url,\n        code=code,\n        client_id=GOOGLE_CLIENT_ID,\n        client_secret=GOOGLE_CLIENT_SECRET,\n        redirect_uri=\"https://myapp.com/auth/google/callback\",\n        required_scopes=\"openid email profile\",\n    )\n    user = await db.upsert_user(email=userinfo[\"email\"])\n    response = RedirectResponse(destination)\n    session_cookie.set_cookie(response, str(user.id))\n    return response\n
     
    Pass required_scopes to guard against providers silently granting fewer scopes than requested — oauth_fetch_userinfo raises ValueError if any are missing.
    ","path":["Modules","Security"],"tags":[]},{"location":"module/security/#state-encoding","level":3,"title":"State encoding","text":"
    oauth_encode_state() and oauth_decode_state() encode and decode the destination URL together with the CSRF token embedded in the OAuth state parameter.  oauth_decode_state returns fallback if state is absent, malformed, or the token does not match:
     
    from fastapi_toolsets.security import oauth_encode_state, oauth_decode_state\n\nstate_token = oauth_generate_state_token()\nencoded = oauth_encode_state(\"/dashboard\", state_token)\ndecoded = oauth_decode_state(encoded, expected_state_token=state_token, fallback=\"/\")  # \"/dashboard\"\ndecoded = oauth_decode_state(encoded, expected_state_token=\"wrong\", fallback=\"/\")  # \"/\"\ndecoded = oauth_decode_state(None, expected_state_token=state_token, fallback=\"/\")       # \"/\"\n
     
     API Reference
    ","path":["Modules","Security"],"tags":[]},{"location":"reference/cli/","level":1,"title":"cli","text":"
    Here's the reference for the CLI configuration helpers used to load settings from pyproject.toml.
     
    You can import them directly from fastapi_toolsets.cli.config:
     
    from fastapi_toolsets.cli.config import (\n    import_from_string,\n    get_config_value,\n    get_fixtures_registry,\n    get_db_context,\n    get_custom_cli,\n)\n
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.import_from_string","level":2,"title":"fastapi_toolsets.cli.config.import_from_string(import_path)","text":"
    Import an object from a dotted string path.
     
    Parameters:
     Name Type Description Default import_path str 
    Import path in \"module.submodule:attribute\" format
     required 
    Returns:
     Type Description Any 
    The imported attribute
     
    Raises:
     Type Description BadParameter 
    If the import path is invalid or import fails
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_config_value","level":2,"title":"fastapi_toolsets.cli.config.get_config_value(key, required=False)","text":"
    get_config_value(key: str, required: Literal[True]) -> Any\n
    get_config_value(\n    key: str, required: bool = False\n) -> Any | None\n
     
    Get a configuration value from pyproject.toml.
     
    Parameters:
     Name Type Description Default key str 
    The configuration key in [tool.fastapi-toolsets].
     required required bool 
    If True, raises an error when the key is missing.
     False 
    Returns:
     Type Description Any | None 
    The configuration value, or None if not found and not required.
     
    Raises:
     Type Description BadParameter 
    If required=True and the key is missing.
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_fixtures_registry","level":2,"title":"fastapi_toolsets.cli.config.get_fixtures_registry()","text":"
    Import and return the fixtures registry from config.
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_db_context","level":2,"title":"fastapi_toolsets.cli.config.get_db_context()","text":"
    Import and return the db_context function from config.
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.config.get_custom_cli","level":2,"title":"fastapi_toolsets.cli.config.get_custom_cli()","text":"
    Import and return the custom CLI Typer instance from config.
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/cli/#fastapi_toolsets.cli.utils.async_command","level":2,"title":"fastapi_toolsets.cli.utils.async_command(func)","text":"
    Decorator to run an async function as a sync CLI command.
     Example 
    @fixture_cli.command(\"load\")\n@async_command\nasync def load(ctx: typer.Context) -> None:\n    async with get_db_context() as session:\n        await load_fixtures(session, registry)\n
    ","path":["Reference","cli"],"tags":[]},{"location":"reference/crud/","level":1,"title":"crud","text":"
    Here's the reference for the CRUD classes, factory, and search utilities.
     
    You can import the main symbols from fastapi_toolsets.crud:
     
    from fastapi_toolsets.crud import CrudFactory, AsyncCrud\nfrom fastapi_toolsets.crud.search import SearchConfig, get_searchable_fields, build_search_filters\n
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud","level":2,"title":"fastapi_toolsets.crud.factory.AsyncCrud","text":"
                   Bases: Generic[ModelType]
     
    Generic async CRUD operations for SQLAlchemy models.
     
    Subclass this and set the model class variable, or use CrudFactory.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.count","level":3,"title":"count(session, filters=None, *, joins=None, outer_join=False)  async classmethod","text":"
    Count records matching the filters.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] | None 
    List of SQLAlchemy filter conditions
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False 
    Returns:
     Type Description int 
    Number of matching records
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.create","level":3,"title":"create(session, obj, *, schema=None)  async classmethod","text":"
    create(\n    session: AsyncSession,\n    obj: BaseModel,\n    *,\n    schema: type[SchemaType],\n) -> Response[SchemaType]\n
    create(\n    session: AsyncSession,\n    obj: BaseModel,\n    *,\n    schema: None = ...,\n) -> ModelType\n
     
    Create a new record in the database.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required obj BaseModel 
    Pydantic model with data to create
     required schema type[BaseModel] | None 
    Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
     None 
    Returns:
     Type Description ModelType | Response[Any] 
    Created model instance, or Response[schema] when schema is given.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.cursor_paginate","level":3,"title":"cursor_paginate(session, *, cursor=None, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, order_joins=None, items_per_page=20, search=None, search_fields=None, search_column=None, order_fields=None, facet_fields=None, filter_by=None, schema)  async classmethod","text":"
    Get paginated results using cursor-based pagination.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session.
     required cursor str | None 
    Cursor string from a previous CursorPagination. Omit (or pass None) to start from the beginning.
     None filters list[Any] | None 
    List of SQLAlchemy filter conditions.
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables.
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN.
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options. Falls back to default_load_options when not provided.
     None order_by OrderByClause | None 
    Additional ordering applied after the cursor column.
     None items_per_page int 
    Number of items per page (default 20).
     20 search str | SearchConfig | None 
    Search query string or SearchConfig object.
     None search_fields Sequence[SearchFieldType] | None 
    Fields to search in (overrides class default).
     None search_column str | None 
    Restrict search to a single column key.
     None order_fields Sequence[OrderFieldType] | None 
    Fields allowed for sorting (overrides class default).
     None facet_fields Sequence[FacetFieldType] | None 
    Columns to compute distinct values for (overrides class default).
     None filter_by dict[str, Any] | BaseModel | None 
    Dict of {column_key: value} to filter by declared facet fields. Keys must match the column.key of a facet field. Scalar → equality, list → IN clause. Raises InvalidFacetFilterError for unknown keys.
     None schema type[BaseModel] 
    Optional Pydantic schema to serialize each item into.
     required 
    Returns:
     Type Description CursorPaginatedResponse[Any] 
    PaginatedResponse with CursorPagination metadata
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.cursor_paginate_params","level":3,"title":"cursor_paginate_params(*, default_page_size=20, max_page_size=100, search=True, filter=True, order=True, search_fields=None, facet_fields=None, order_fields=None, default_order_field=None, default_order='asc')  classmethod","text":"
    Return a FastAPI dependency that collects all params for :meth:cursor_paginate.
     
    Parameters:
     Name Type Description Default default_page_size int 
    Default items_per_page value.
     20 max_page_size int 
    Maximum items_per_page value.
     100 search bool 
    Enable search query parameters.
     True filter bool 
    Enable facet filter query parameters.
     True order bool 
    Enable order query parameters.
     True search_fields Sequence[SearchFieldType] | None 
    Override searchable fields.
     None facet_fields Sequence[FacetFieldType] | None 
    Override facet fields.
     None order_fields Sequence[OrderFieldType] | None 
    Override order fields.
     None default_order_field QueryableAttribute[Any] | None 
    Default field to order by when order_by is absent.
     None default_order Literal['asc', 'desc'] 
    Default sort direction.
     'asc' 
    Returns:
     Name Type Description Callable[..., Awaitable[dict[str, Any]]] 
    An async dependency that resolves to a dict ready to be unpacked
     into Callable[..., Awaitable[dict[str, Any]]] 
    meth:cursor_paginate.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.delete","level":3,"title":"delete(session, filters, *, return_response=False)  async classmethod","text":"
    delete(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    return_response: Literal[True],\n) -> Response[None]\n
    delete(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    return_response: Literal[False] = ...,\n) -> None\n
     
    Delete records from the database.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] 
    List of SQLAlchemy filter conditions
     required return_response bool 
    When True, returns Response[None] instead of None. Useful for API endpoints that expect a consistent response envelope.
     False 
    Returns:
     Type Description None | Response[None] 
    None, or Response[None] when return_response=True.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.exists","level":3,"title":"exists(session, filters, *, joins=None, outer_join=False)  async classmethod","text":"
    Check if a record exists.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] 
    List of SQLAlchemy filter conditions
     required joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False 
    Returns:
     Type Description bool 
    True if at least one record matches
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.first","level":3,"title":"first(session, filters=None, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None)  async classmethod","text":"
    first(\n    session: AsyncSession,\n    filters: list[Any] | None = None,\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: type[SchemaType],\n) -> Response[SchemaType] | None\n
    first(\n    session: AsyncSession,\n    filters: list[Any] | None = None,\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: None = ...,\n) -> ModelType | None\n
     
    Get the first matching record, or None.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] | None 
    List of SQLAlchemy filter conditions
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False with_for_update _ForUpdateMode 
    Lock the row for update
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options (e.g., selectinload)
     None schema type[BaseModel] | None 
    Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
     None 
    Returns:
     Type Description ModelType | Response[Any] | None 
    Model instance, Response[schema] when schema is given,
     ModelType | Response[Any] | None 
    or None when no record matches.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.get","level":3,"title":"get(session, filters, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None)  async classmethod","text":"
    get(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: type[SchemaType],\n) -> Response[SchemaType]\n
    get(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: None = ...,\n) -> ModelType\n
     
    Get exactly one record. Raises NotFoundError if not found.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] 
    List of SQLAlchemy filter conditions
     required joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False with_for_update _ForUpdateMode 
    Lock the row for update
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options (e.g., selectinload)
     None schema type[BaseModel] | None 
    Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
     None 
    Returns:
     Type Description ModelType | Response[Any] 
    Model instance, or Response[schema] when schema is given.
     
    Raises:
     Type Description NotFoundError 
    If no record found
     MultipleResultsFound 
    If more than one record found
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.get_multi","level":3,"title":"get_multi(session, *, filters=None, joins=None, outer_join=False, with_for_update=False, load_options=None, order_by=None, limit=None, offset=None)  async classmethod","text":"
    Get multiple records from the database.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] | None 
    List of SQLAlchemy filter conditions
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False with_for_update _ForUpdateMode 
    Lock rows for update. True for plain FOR UPDATE, \"nowait\" for FOR UPDATE NOWAIT, \"skip_locked\" for FOR UPDATE SKIP LOCKED.
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options
     None order_by OrderByClause | None 
    Column or list of columns to order by
     None limit int | None 
    Max number of rows to return
     None offset int | None 
    Rows to skip
     None 
    Returns:
     Type Description Sequence[ModelType] 
    List of model instances
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.get_or_none","level":3,"title":"get_or_none(session, filters, *, joins=None, outer_join=False, with_for_update=False, load_options=None, schema=None)  async classmethod","text":"
    get_or_none(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: type[SchemaType],\n) -> Response[SchemaType] | None\n
    get_or_none(\n    session: AsyncSession,\n    filters: list[Any],\n    *,\n    joins: JoinType | None = None,\n    outer_join: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    load_options: Sequence[ExecutableOption] | None = None,\n    schema: None = ...,\n) -> ModelType | None\n
     
    Get exactly one record, or None if not found.
     
    Like :meth:get but returns None instead of raising :class:~fastapi_toolsets.exceptions.NotFoundError when no record matches the filters.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] 
    List of SQLAlchemy filter conditions
     required joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False with_for_update _ForUpdateMode 
    Lock the row for update
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options (e.g., selectinload)
     None schema type[BaseModel] | None 
    Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
     None 
    Returns:
     Type Description ModelType | Response[Any] | None 
    Model instance, Response[schema] when schema is given,
     ModelType | Response[Any] | None 
    or None when no record matches.
     
    Raises:
     Type Description MultipleResultsFound 
    If more than one record found
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.offset_paginate","level":3,"title":"offset_paginate(session, *, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, order_joins=None, page=1, items_per_page=20, include_total=True, search=None, search_fields=None, search_column=None, order_fields=None, facet_fields=None, filter_by=None, schema)  async classmethod","text":"
    Get paginated results using offset-based pagination.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required filters list[Any] | None 
    List of SQLAlchemy filter conditions
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options
     None order_by OrderByClause | None 
    Column or list of columns to order by
     None page int 
    Page number (1-indexed)
     1 items_per_page int 
    Number of items per page
     20 include_total bool 
    When False, skip the COUNT query; pagination.total_count will be None.
     True search str | SearchConfig | None 
    Search query string or SearchConfig object
     None search_fields Sequence[SearchFieldType] | None 
    Fields to search in (overrides class default)
     None search_column str | None 
    Restrict search to a single column key.
     None order_fields Sequence[OrderFieldType] | None 
    Fields allowed for sorting (overrides class default).
     None facet_fields Sequence[FacetFieldType] | None 
    Columns to compute distinct values for (overrides class default)
     None filter_by dict[str, Any] | BaseModel | None 
    Dict of {column_key: value} to filter by declared facet fields. Keys must match the column.key of a facet field. Scalar → equality, list → IN clause. Raises InvalidFacetFilterError for unknown keys.
     None schema type[BaseModel] 
    Pydantic schema to serialize each item into.
     required 
    Returns:
     Type Description OffsetPaginatedResponse[Any] 
    PaginatedResponse with OffsetPagination metadata
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.offset_paginate_params","level":3,"title":"offset_paginate_params(*, default_page_size=20, max_page_size=100, include_total=True, search=True, filter=True, order=True, search_fields=None, facet_fields=None, order_fields=None, default_order_field=None, default_order='asc')  classmethod","text":"
    Return a FastAPI dependency that collects all params for :meth:offset_paginate.
     
    Parameters:
     Name Type Description Default default_page_size int 
    Default items_per_page value.
     20 max_page_size int 
    Maximum items_per_page value.
     100 include_total bool 
    Whether to include total count (not a query param).
     True search bool 
    Enable search query parameters.
     True filter bool 
    Enable facet filter query parameters.
     True order bool 
    Enable order query parameters.
     True search_fields Sequence[SearchFieldType] | None 
    Override searchable fields.
     None facet_fields Sequence[FacetFieldType] | None 
    Override facet fields.
     None order_fields Sequence[OrderFieldType] | None 
    Override order fields.
     None default_order_field QueryableAttribute[Any] | None 
    Default field to order by when order_by is absent.
     None default_order Literal['asc', 'desc'] 
    Default sort direction.
     'asc' 
    Returns:
     Name Type Description Callable[..., Awaitable[dict[str, Any]]] 
    An async dependency that resolves to a dict ready to be unpacked
     into Callable[..., Awaitable[dict[str, Any]]] 
    meth:offset_paginate.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.paginate","level":3,"title":"paginate(session, *, pagination_type=PaginationType.OFFSET, filters=None, joins=None, outer_join=False, load_options=None, order_by=None, order_joins=None, page=1, cursor=None, items_per_page=20, include_total=True, search=None, search_fields=None, search_column=None, order_fields=None, facet_fields=None, filter_by=None, schema)  async classmethod","text":"
    paginate(\n    session: AsyncSession,\n    *,\n    pagination_type: Literal[PaginationType.OFFSET],\n    filters: list[Any] | None = ...,\n    joins: JoinType | None = ...,\n    outer_join: bool = ...,\n    load_options: Sequence[ExecutableOption] | None = ...,\n    order_by: OrderByClause | None = ...,\n    order_joins: list[Any] | None = ...,\n    page: int = ...,\n    cursor: str | None = ...,\n    items_per_page: int = ...,\n    include_total: bool = ...,\n    search: str | SearchConfig | None = ...,\n    search_fields: Sequence[SearchFieldType] | None = ...,\n    search_column: str | None = ...,\n    order_fields: Sequence[OrderFieldType] | None = ...,\n    facet_fields: Sequence[FacetFieldType] | None = ...,\n    filter_by: dict[str, Any] | BaseModel | None = ...,\n    schema: type[BaseModel],\n) -> OffsetPaginatedResponse[Any]\n
    paginate(\n    session: AsyncSession,\n    *,\n    pagination_type: Literal[PaginationType.CURSOR],\n    filters: list[Any] | None = ...,\n    joins: JoinType | None = ...,\n    outer_join: bool = ...,\n    load_options: Sequence[ExecutableOption] | None = ...,\n    order_by: OrderByClause | None = ...,\n    order_joins: list[Any] | None = ...,\n    page: int = ...,\n    cursor: str | None = ...,\n    items_per_page: int = ...,\n    include_total: bool = ...,\n    search: str | SearchConfig | None = ...,\n    search_fields: Sequence[SearchFieldType] | None = ...,\n    search_column: str | None = ...,\n    order_fields: Sequence[OrderFieldType] | None = ...,\n    facet_fields: Sequence[FacetFieldType] | None = ...,\n    filter_by: dict[str, Any] | BaseModel | None = ...,\n    schema: type[BaseModel],\n) -> CursorPaginatedResponse[Any]\n
     
    Get paginated results using either offset or cursor pagination.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session.
     required pagination_type PaginationType 
    Pagination strategy.  Defaults to PaginationType.OFFSET.
     OFFSET filters list[Any] | None 
    List of SQLAlchemy filter conditions.
     None joins JoinType | None 
    List of (model, condition) tuples for joining related tables.
     None outer_join bool 
    Use LEFT OUTER JOIN instead of INNER JOIN.
     False load_options Sequence[ExecutableOption] | None 
    SQLAlchemy loader options.  Falls back to default_load_options when not provided.
     None order_by OrderByClause | None 
    Column or expression to order results by.
     None page int 
    Page number (1-indexed).  Only used when pagination_type is OFFSET.
     1 cursor str | None 
    Cursor token from a previous :class:.CursorPaginatedResponse.  Only used when pagination_type is CURSOR.
     None items_per_page int 
    Number of items per page (default 20).
     20 include_total bool 
    When False, skip the COUNT query; only applies when pagination_type is OFFSET.
     True search str | SearchConfig | None 
    Search query string or :class:.SearchConfig object.
     None search_fields Sequence[SearchFieldType] | None 
    Fields to search in (overrides class default).
     None search_column str | None 
    Restrict search to a single column key.
     None order_fields Sequence[OrderFieldType] | None 
    Fields allowed for sorting (overrides class default).
     None facet_fields Sequence[FacetFieldType] | None 
    Columns to compute distinct values for (overrides class default).
     None filter_by dict[str, Any] | BaseModel | None 
    Dict of {column_key: value} to filter by declared facet fields.  Keys must match the column.key of a facet field.  Scalar → equality, list → IN clause.  Raises :exc:.InvalidFacetFilterError for unknown keys.
     None schema type[BaseModel] 
    Pydantic schema to serialize each item into.
     required 
    Returns:
     Type Description OffsetPaginatedResponse[Any] | CursorPaginatedResponse[Any] 
    class:.OffsetPaginatedResponse when pagination_type is
     OffsetPaginatedResponse[Any] | CursorPaginatedResponse[Any] 
    OFFSET, :class:.CursorPaginatedResponse when it is
     OffsetPaginatedResponse[Any] | CursorPaginatedResponse[Any] 
    CURSOR.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.paginate_params","level":3,"title":"paginate_params(*, default_page_size=20, max_page_size=100, default_pagination_type=PaginationType.OFFSET, include_total=True, search=True, filter=True, order=True, search_fields=None, facet_fields=None, order_fields=None, default_order_field=None, default_order='asc')  classmethod","text":"
    Return a FastAPI dependency that collects all params for :meth:paginate.
     
    Parameters:
     Name Type Description Default default_page_size int 
    Default items_per_page value.
     20 max_page_size int 
    Maximum items_per_page value.
     100 default_pagination_type PaginationType 
    Default pagination strategy.
     OFFSET include_total bool 
    Whether to include total count (not a query param).
     True search bool 
    Enable search query parameters.
     True filter bool 
    Enable facet filter query parameters.
     True order bool 
    Enable order query parameters.
     True search_fields Sequence[SearchFieldType] | None 
    Override searchable fields.
     None facet_fields Sequence[FacetFieldType] | None 
    Override facet fields.
     None order_fields Sequence[OrderFieldType] | None 
    Override order fields.
     None default_order_field QueryableAttribute[Any] | None 
    Default field to order by when order_by is absent.
     None default_order Literal['asc', 'desc'] 
    Default sort direction.
     'asc' 
    Returns:
     Name Type Description Callable[..., Awaitable[dict[str, Any]]] 
    An async dependency that resolves to a dict ready to be unpacked
     into Callable[..., Awaitable[dict[str, Any]]] 
    meth:paginate.
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.update","level":3,"title":"update(session, obj, filters, *, exclude_unset=True, exclude_none=False, with_for_update=False, schema=None)  async classmethod","text":"
    update(\n    session: AsyncSession,\n    obj: BaseModel,\n    filters: list[Any],\n    *,\n    exclude_unset: bool = True,\n    exclude_none: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    schema: type[SchemaType],\n) -> Response[SchemaType]\n
    update(\n    session: AsyncSession,\n    obj: BaseModel,\n    filters: list[Any],\n    *,\n    exclude_unset: bool = True,\n    exclude_none: bool = False,\n    with_for_update: _ForUpdateMode = False,\n    schema: None = ...,\n) -> ModelType\n
     
    Update a record in the database.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required obj BaseModel 
    Pydantic model with update data
     required filters list[Any] 
    List of SQLAlchemy filter conditions
     required exclude_unset bool 
    Exclude fields not explicitly set in the schema
     True exclude_none bool 
    Exclude fields with None value
     False with_for_update _ForUpdateMode 
    Lock the row before updating. True for plain FOR UPDATE, \"nowait\" for FOR UPDATE NOWAIT, \"skip_locked\" for FOR UPDATE SKIP LOCKED.
     False schema type[BaseModel] | None 
    Pydantic schema to serialize the result into. When provided, the result is automatically wrapped in a Response[schema].
     None 
    Returns:
     Type Description ModelType | Response[Any] 
    Updated model instance, or Response[schema] when schema is given.
     
    Raises:
     Type Description NotFoundError 
    If no record found
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.AsyncCrud.upsert","level":3,"title":"upsert(session, obj, index_elements, *, set_=None, where=None)  async classmethod","text":"
    Create or update a record (PostgreSQL only).
     
    Uses INSERT ... ON CONFLICT for atomic upsert.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session
     required obj BaseModel 
    Pydantic model with data
     required index_elements list[str] 
    Columns for ON CONFLICT (unique constraint)
     required set_ BaseModel | None 
    Pydantic model for ON CONFLICT DO UPDATE SET
     None where WhereHavingRole | None 
    WHERE clause for ON CONFLICT DO UPDATE
     None 
    Returns:
     Type Description ModelType | None 
    Model instance
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.factory.CrudFactory","level":2,"title":"fastapi_toolsets.crud.factory.CrudFactory(model, *, base_class=AsyncCrud, searchable_fields=None, facet_fields=None, order_fields=None, m2m_fields=None, default_load_options=None, cursor_column=None)","text":"
    Create a CRUD class for a specific model.
     
    Parameters:
     Name Type Description Default model type[ModelType] 
    SQLAlchemy model class
     required base_class type[AsyncCrud[Any]] 
    Optional base class to inherit from instead of AsyncCrud. Use this to share custom methods across multiple CRUD classes while still using the factory shorthand.
     AsyncCrud searchable_fields Sequence[SearchFieldType] | None 
    Optional list of searchable fields
     None facet_fields Sequence[FacetFieldType] | None 
    Optional list of columns to compute distinct values for in paginated responses. Supports direct columns (User.status) and relationship tuples ((User.role, Role.name)). Can be overridden per call.
     None order_fields Sequence[OrderFieldType] | None 
    Optional list of model attributes that callers are allowed to order by via offset_paginate_params(). Can be overridden per call.
     None m2m_fields M2MFieldType | None 
    Optional mapping for many-to-many relationships. Maps schema field names (containing lists of IDs) to SQLAlchemy relationship attributes.
     None default_load_options Sequence[ExecutableOption] | None 
    Default SQLAlchemy loader options applied to all read queries when no explicit load_options are passed. Use this instead of lazy=\"selectin\" on the model so that loading strategy is explicit and per-CRUD. Overridden entirely (not merged) when load_options is provided at call-site.
     None cursor_column Any | None 
    Required to call cursor_paginate. Must be monotonically ordered (e.g. integer PK, UUID v7, timestamp). See the cursor pagination docs for supported column types.
     None 
    Returns:
     Type Description type[AsyncCrud[ModelType]] 
    AsyncCrud subclass bound to the model
     Example 
    from fastapi_toolsets.crud import CrudFactory\nfrom myapp.models import User, Post\n\nUserCrud = CrudFactory(User)\nPostCrud = CrudFactory(Post)\n\n# With searchable fields:\nUserCrud = CrudFactory(\n    User,\n    searchable_fields=[User.username, User.email, (User.role, Role.name)]\n)\n\n# With many-to-many fields:\n# Schema has `tag_ids: list[UUID]`, model has `tags` relationship to Tag\nPostCrud = CrudFactory(\n    Post,\n    m2m_fields={\"tag_ids\": Post.tags},\n)\n\n# With facet fields for filter dropdowns / faceted search:\nUserCrud = CrudFactory(\n    User,\n    facet_fields=[User.status, User.country, (User.role, Role.name)],\n)\n\n# With a fixed cursor column for cursor_paginate:\nPostCrud = CrudFactory(\n    Post,\n    cursor_column=Post.created_at,\n)\n\n# With default load strategy (replaces lazy=\"selectin\" on the model):\nArticleCrud = CrudFactory(\n    Article,\n    default_load_options=[selectinload(Article.category), selectinload(Article.tags)],\n)\n\n# Override default_load_options for a specific call:\narticle = await ArticleCrud.get(\n    session,\n    [Article.id == 1],\n    load_options=[selectinload(Article.category)],  # tags won't load\n)\n\n# Usage\nuser = await UserCrud.get(session, [User.id == 1])\nposts = await PostCrud.get_multi(session, filters=[Post.user_id == user.id])\n\n# Create with M2M - tag_ids are automatically resolved\npost = await PostCrud.create(session, PostCreate(title=\"Hello\", tag_ids=[id1, id2]))\n\n# With search\nresult = await UserCrud.offset_paginate(session, search=\"john\")\n\n# With joins (inner join by default):\nusers = await UserCrud.get_multi(\n    session,\n    joins=[(Post, Post.user_id == User.id)],\n    filters=[Post.published == True],\n)\n\n# With outer join:\nusers = await UserCrud.get_multi(\n    session,\n    joins=[(Post, Post.user_id == User.id)],\n    outer_join=True,\n)\n\n# With a shared custom base class:\nfrom typing import Generic, TypeVar\nfrom sqlalchemy.orm import DeclarativeBase\n\nT = TypeVar(\"T\", bound=DeclarativeBase)\n\nclass AuditedCrud(AsyncCrud[T], Generic[T]):\n    @classmethod\n    async def get_active(cls, session):\n        return await cls.get_multi(session, filters=[cls.model.is_active == True])\n\nUserCrud = CrudFactory(User, base_class=AuditedCrud)\n
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.search.SearchConfig","level":2,"title":"fastapi_toolsets.crud.search.SearchConfig  dataclass","text":"
    Advanced search configuration.
     
    Attributes:
     Name Type Description query str 
    The search string
     fields Sequence[SearchFieldType] | None 
    Fields to search (columns or tuples for relationships)
     case_sensitive bool 
    Case-sensitive search (default: False)
     match_mode Literal['any', 'all'] 
    \"any\" (OR) or \"all\" (AND) to combine fields
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.search.get_searchable_fields","level":2,"title":"fastapi_toolsets.crud.search.get_searchable_fields(model, *, include_relationships=True, max_depth=1)  cached","text":"
    Auto-detect String fields on a model and its relationships.
     
    Parameters:
     Name Type Description Default model type[DeclarativeBase] 
    SQLAlchemy model class
     required include_relationships bool 
    Include fields from many-to-one/one-to-one relationships
     True max_depth int 
    Max depth for relationship traversal (default: 1)
     1 
    Returns:
     Type Description list[SearchFieldType] 
    List of columns and tuples (relationship, column)
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/crud/#fastapi_toolsets.crud.search.build_search_filters","level":2,"title":"fastapi_toolsets.crud.search.build_search_filters(model, search, search_fields=None, default_fields=None, search_column=None)","text":"
    Build SQLAlchemy filter conditions for search.
     
    Parameters:
     Name Type Description Default model type[DeclarativeBase] 
    SQLAlchemy model class
     required search str | SearchConfig 
    Search string or SearchConfig
     required search_fields Sequence[SearchFieldType] | None 
    Fields specified per-call (takes priority)
     None default_fields Sequence[SearchFieldType] | None 
    Default fields (from ClassVar)
     None search_column str | None 
    Optional key to narrow search to a single field. Must match one of the resolved search field keys.
     None 
    Returns:
     Type Description tuple[list[ColumnElement[bool]], list[InstrumentedAttribute[Any]]] 
    Tuple of (filter_conditions, joins_needed)
     
    Raises:
     Type Description NoSearchableFieldsError 
    If no searchable field has been configured
    ","path":["Reference","crud"],"tags":[]},{"location":"reference/db/","level":1,"title":"db","text":"
    Here's the reference for all database session utilities, transaction helpers, and locking functions.
     
    You can import them directly from fastapi_toolsets.db:
     
    from fastapi_toolsets.db import (\n    LockMode,\n    advisory_lock,\n    cleanup_tables,\n    create_database,\n    create_db_dependency,\n    create_db_context,\n    get_transaction,\n    lock_tables,\n    m2m_add,\n    m2m_remove,\n    m2m_set,\n    wait_for_row_change,\n)\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.LockMode","level":2,"title":"fastapi_toolsets.db.LockMode","text":"
                   Bases: str, Enum
     
    PostgreSQL table lock modes.
     
    See: https://www.postgresql.org/docs/current/explicit-locking.html
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.create_db_dependency","level":2,"title":"fastapi_toolsets.db.create_db_dependency(session_maker)","text":"
    Create a FastAPI dependency for database sessions.
     
    Creates a dependency function that yields a session and auto-commits if a transaction is active when the request completes.
     
    Parameters:
     Name Type Description Default session_maker async_sessionmaker[_SessionT] 
    Async session factory from create_session_factory()
     required 
    Returns:
     Type Description Callable[[], AsyncGenerator[_SessionT, None]] 
    An async generator function usable with FastAPI's Depends()
     Example 
    from fastapi import Depends\nfrom sqlalchemy.ext.asyncio import AsyncSession, create_async_engine, async_sessionmaker\nfrom fastapi_toolsets.db import create_db_dependency\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False)\nget_db = create_db_dependency(SessionLocal)\n\n@app.get(\"/users\")\nasync def list_users(session: AsyncSession = Depends(get_db)):\n    ...\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.create_db_context","level":2,"title":"fastapi_toolsets.db.create_db_context(session_maker)","text":"
    Create a context manager for database sessions.
     
    Creates a context manager for use outside of FastAPI request handlers, such as in background tasks, CLI commands, or tests.
     
    Parameters:
     Name Type Description Default session_maker async_sessionmaker[_SessionT] 
    Async session factory from create_session_factory()
     required 
    Returns:
     Type Description Callable[[], AbstractAsyncContextManager[_SessionT]] 
    An async context manager function
     Example 
    from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker\nfrom fastapi_toolsets.db import create_db_context\n\nengine = create_async_engine(\"postgresql+asyncpg://...\")\nSessionLocal = async_sessionmaker(engine, expire_on_commit=False)\nget_db_context = create_db_context(SessionLocal)\n\nasync def background_task():\n    async with get_db_context() as session:\n        user = await UserCrud.get(session, [User.id == 1])\n        ...\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.get_transaction","level":2,"title":"fastapi_toolsets.db.get_transaction(session)  async","text":"
    Get a transaction context, handling nested transactions.
     
    If already in a transaction, creates a savepoint (nested transaction). Otherwise, starts a new transaction.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    AsyncSession instance
     required 
    Yields:
     Type Description AsyncGenerator[AsyncSession, None] 
    The session within the transaction context
     Example 
    async with get_transaction(session):\n    session.add(model)\n    # Auto-commits on exit, rolls back on exception\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.lock_tables","level":2,"title":"fastapi_toolsets.db.lock_tables(session_maker, tables, *, mode=LockMode.SHARE_UPDATE_EXCLUSIVE, timeout='5s')","text":"
    Lock PostgreSQL tables for the duration of a transaction.
     
    Parameters:
     Name Type Description Default session_maker async_sessionmaker[_SessionT] 
    Async session factory used to create the dedicated session.
     required tables list[type[DeclarativeBase]] 
    List of SQLAlchemy model classes to lock.
     required mode LockMode 
    Lock mode (default: SHARE UPDATE EXCLUSIVE).
     SHARE_UPDATE_EXCLUSIVE timeout str 
    Lock timeout (default: \"5s\").
     '5s' 
    Yields:
     Type Description AbstractAsyncContextManager[_SessionT] 
    The dedicated session, open within the locked transaction.
     
    Raises:
     Type Description SQLAlchemyError 
    If the lock cannot be acquired within timeout.
     Example 
    from fastapi_toolsets.db import lock_tables, LockMode\n\nasync with lock_tables(session_maker, [User, Account]) as session:\n    # Tables are locked; changes are committed when the context exits.\n    user = await UserCrud.get(session, [User.id == 1])\n    user.balance += 100\n\n# With custom lock mode\nasync with lock_tables(session_maker, [Order], mode=LockMode.EXCLUSIVE) as session:\n    await process_order(session, order_id)\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.advisory_lock","level":2,"title":"fastapi_toolsets.db.advisory_lock(session, key, *, shared=False, nowait=False, timeout=None)  async","text":"
    Acquire a PostgreSQL session-level advisory lock.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    AsyncSession instance.
     required key int | tuple[int, int] 
    Lock key — a single int (bigint) or a (int, int) pair for namespacing.
     required shared bool 
    Acquire a shared lock (multiple holders allowed). Default is exclusive.
     False nowait bool 
    Return False immediately if the lock is unavailable instead of waiting.
     False timeout str | None 
    Maximum wait time (e.g. \"5s\", \"500ms\"). Raises DBAPIError if exceeded. Ignored when nowait is True.
     None 
    Yields:
     Type Description AsyncGenerator[bool, None] 
    True if the lock was acquired, False if nowait is True and the lock
     AsyncGenerator[bool, None] 
    is already held.
     
    Raises:
     Type Description LockTimeoutError 
    If timeout is set and the lock cannot be acquired in time.
     Example 
    from fastapi_toolsets.db import advisory_lock\n\nasync with advisory_lock(session, 42):\n    ...\n\nasync with advisory_lock(session, 42, nowait=True) as acquired:\n    if not acquired:\n        raise HTTPException(409, \"Resource is locked\")\n\nasync with advisory_lock(session, 42, timeout=\"5s\"):\n    ...\n\nasync with advisory_lock(session, (1, user_id), shared=True):\n    ...\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.wait_for_row_change","level":2,"title":"fastapi_toolsets.db.wait_for_row_change(session, model, pk_value, *, columns=None, interval=0.5, timeout=None)  async","text":"
    Poll a database row until a change is detected.
     
    Queries the row every interval seconds and returns the model instance once a change is detected in any column (or only the specified columns).
     
    Parameters:
     Name Type Description Default session AsyncSession 
    AsyncSession instance
     required model type[_M] 
    SQLAlchemy model class
     required pk_value Any 
    Primary key value of the row to watch
     required columns list[str] | None 
    Optional list of column names to watch. If None, all columns      are watched.
     None interval float 
    Polling interval in seconds (default: 0.5)
     0.5 timeout float | None 
    Maximum time to wait in seconds. None means wait forever.
     None 
    Returns:
     Type Description _M 
    The refreshed model instance with updated values
     
    Raises:
     Type Description NotFoundError 
    If the row does not exist or is deleted during polling
     TimeoutError 
    If timeout expires before a change is detected
     Example 
    from fastapi_toolsets.db import wait_for_row_change\n\n# Wait for any column to change\nupdated = await wait_for_row_change(session, User, user_id)\n\n# Watch specific columns with a timeout\nupdated = await wait_for_row_change(\n    session, User, user_id,\n    columns=[\"status\", \"email\"],\n    interval=1.0,\n    timeout=30.0,\n)\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.create_database","level":2,"title":"fastapi_toolsets.db.create_database(db_name, *, server_url)  async","text":"
    Create a database.
     
    Connects to server_url using AUTOCOMMIT isolation and issues a CREATE DATABASE statement for db_name.
     
    Parameters:
     Name Type Description Default db_name str 
    Name of the database to create.
     required server_url str 
    URL used for server-level DDL (must point to an existing database on the same server).
     required Example 
    from fastapi_toolsets.db import create_database\n\nSERVER_URL = \"postgresql+asyncpg://postgres:postgres@localhost/postgres\"\nawait create_database(\"myapp_test\", server_url=SERVER_URL)\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.cleanup_tables","level":2,"title":"fastapi_toolsets.db.cleanup_tables(session, base)  async","text":"
    Truncate all tables for fast between-test cleanup.
     
    Executes a single TRUNCATE … RESTART IDENTITY CASCADE statement across every table in base's metadata, which is significantly faster than dropping and re-creating tables between tests.
     
    This is a no-op when the metadata contains no tables.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    An active async database session.
     required base type[DeclarativeBase] 
    SQLAlchemy DeclarativeBase class containing model metadata.
     required Example 
    @pytest.fixture\nasync def db_session(worker_db_url):\n    async with create_db_session(worker_db_url, Base) as session:\n        yield session\n        await cleanup_tables(session, Base)\n
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.m2m_add","level":2,"title":"fastapi_toolsets.db.m2m_add(session, instance, rel_attr, *related, ignore_conflicts=False)  async","text":"
    Insert rows into a Many-to-Many association table without loading the ORM collection.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session.
     required instance DeclarativeBase 
    The \"owner\" side model instance (e.g. the A in A.b_list).
     required rel_attr QueryableAttribute 
    The M2M relationship attribute on the model class (e.g. A.b_list).
     required *related DeclarativeBase 
    One or more related instances to associate with instance.
     () ignore_conflicts bool 
    When True, silently skip rows that already exist in the association table (ON CONFLICT DO NOTHING).
     False 
    Raises:
     Type Description TypeError 
    If rel_attr is not a Many-to-Many relationship.
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.m2m_remove","level":2,"title":"fastapi_toolsets.db.m2m_remove(session, instance, rel_attr, *related)  async","text":"
    Remove rows from a Many-to-Many association table without loading the ORM collection.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session.
     required instance DeclarativeBase 
    The \"owner\" side model instance (e.g. the A in A.b_list).
     required rel_attr QueryableAttribute 
    The M2M relationship attribute on the model class (e.g. A.b_list).
     required *related DeclarativeBase 
    One or more related instances to disassociate from instance.
     () 
    Raises:
     Type Description TypeError 
    If rel_attr is not a Many-to-Many relationship.
    ","path":["Reference","db"],"tags":[]},{"location":"reference/db/#fastapi_toolsets.db.m2m_set","level":2,"title":"fastapi_toolsets.db.m2m_set(session, instance, rel_attr, *related)  async","text":"
    Replace the entire Many-to-Many association set atomically.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    DB async session.
     required instance DeclarativeBase 
    The \"owner\" side model instance (e.g. the A in A.b_list).
     required rel_attr QueryableAttribute 
    The M2M relationship attribute on the model class (e.g. A.b_list).
     required *related DeclarativeBase 
    The new complete set of related instances.
     () 
    Raises:
     Type Description TypeError 
    If rel_attr is not a Many-to-Many relationship.
    ","path":["Reference","db"],"tags":[]},{"location":"reference/dependencies/","level":1,"title":"dependencies","text":"
    Here's the reference for the FastAPI dependency factory functions.
     
    You can import them directly from fastapi_toolsets.dependencies:
     
    from fastapi_toolsets.dependencies import PathDependency, BodyDependency\n
    ","path":["Reference","dependencies"],"tags":[]},{"location":"reference/dependencies/#fastapi_toolsets.dependencies.PathDependency","level":2,"title":"fastapi_toolsets.dependencies.PathDependency(model, field, *, session_dep, param_name=None)","text":"
    Create a dependency that fetches a DB object from a path parameter.
     
    Parameters:
     Name Type Description Default model type[ModelType] 
    SQLAlchemy model class
     required field Any 
    Model field to filter by (e.g., User.id)
     required session_dep SessionDependency 
    Session dependency function (e.g., get_db)
     required param_name str | None 
    Path parameter name (defaults to model_field, e.g., user_id)
     None 
    Returns:
     Type Description ModelType 
    A Depends() instance that resolves to the model instance
     
    Raises:
     Type Description NotFoundError 
    If no matching record is found
     Example 
    UserDep = PathDependency(User, User.id, session_dep=get_db)\n\n@router.get(\"/user/{id}\")\nasync def get(\n    user: User = UserDep,\n): ...\n
    ","path":["Reference","dependencies"],"tags":[]},{"location":"reference/dependencies/#fastapi_toolsets.dependencies.BodyDependency","level":2,"title":"fastapi_toolsets.dependencies.BodyDependency(model, field, *, session_dep, body_field)","text":"
    Create a dependency that fetches a DB object from a body field.
     
    Parameters:
     Name Type Description Default model type[ModelType] 
    SQLAlchemy model class
     required field Any 
    Model field to filter by (e.g., User.id)
     required session_dep SessionDependency 
    Session dependency function (e.g., get_db)
     required body_field str 
    Name of the field in the request body
     required 
    Returns:
     Type Description ModelType 
    A Depends() instance that resolves to the model instance
     
    Raises:
     Type Description NotFoundError 
    If no matching record is found
     Example 
    UserDep = BodyDependency(\n    User, User.ctfd_id, session_dep=get_db, body_field=\"user_id\"\n)\n\n@router.post(\"/assign\")\nasync def assign(\n    user: User = UserDep,\n): ...\n
    ","path":["Reference","dependencies"],"tags":[]},{"location":"reference/exceptions/","level":1,"title":"exceptions","text":"
    Here's the reference for all exception classes and handler utilities.
     
    You can import them directly from fastapi_toolsets.exceptions:
     
    from fastapi_toolsets.exceptions import (\n    ApiException,\n    UnauthorizedError,\n    ForbiddenError,\n    NotFoundError,\n    ConflictError,\n    NoSearchableFieldsError,\n    InvalidSearchColumnError,\n    InvalidFacetFilterError,\n    InvalidOrderFieldError,\n    PoolExhaustedError,\n    LockTimeoutError,\n    generate_error_responses,\n    init_exceptions_handlers,\n)\n
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ApiException","level":2,"title":"fastapi_toolsets.exceptions.exceptions.ApiException","text":"
                   Bases: Exception
     
    Base exception for API errors with structured response.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ApiException.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.UnauthorizedError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.UnauthorizedError","text":"
                   Bases: ApiException
     
    HTTP 401 - User is not authenticated.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.UnauthorizedError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ForbiddenError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.ForbiddenError","text":"
                   Bases: ApiException
     
    HTTP 403 - User lacks required permissions.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ForbiddenError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NotFoundError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.NotFoundError","text":"
                   Bases: ApiException
     
    HTTP 404 - Resource not found.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NotFoundError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ConflictError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.ConflictError","text":"
                   Bases: ApiException
     
    HTTP 409 - Resource conflict.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.ConflictError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError","text":"
                   Bases: ApiException
     
    Raised when search is requested but no searchable fields are available.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError.__init__","level":3,"title":"__init__(model)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default model type 
    The model class that has no searchable fields configured.
     required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidSearchColumnError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.InvalidSearchColumnError","text":"
                   Bases: ApiException
     
    Raised when search_column is not one of the configured searchable fields.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidSearchColumnError.__init__","level":3,"title":"__init__(column, valid_columns)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default column str 
    The unknown search column provided by the caller.
     required valid_columns list[str] 
    List of valid search column keys.
     required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidFacetFilterError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.InvalidFacetFilterError","text":"
                   Bases: ApiException
     
    Raised when filter_by contains a key not declared in facet_fields.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidFacetFilterError.__init__","level":3,"title":"__init__(key, valid_keys)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default key str 
    The unknown filter key provided by the caller.
     required valid_keys set[str] 
    Set of valid keys derived from the declared facet_fields.
     required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidOrderFieldError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.InvalidOrderFieldError","text":"
                   Bases: ApiException
     
    Raised when order_by contains a field not in the allowed order fields.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.InvalidOrderFieldError.__init__","level":3,"title":"__init__(field, valid_fields)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default field str 
    The unknown order field provided by the caller.
     required valid_fields list[str] 
    List of valid field names.
     required","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.PoolExhaustedError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.PoolExhaustedError","text":"
                   Bases: ApiException
     
    HTTP 503 - Database connection pool is exhausted.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.PoolExhaustedError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.LockTimeoutError","level":2,"title":"fastapi_toolsets.exceptions.exceptions.LockTimeoutError","text":"
                   Bases: ApiException
     
    HTTP 503 - A database lock could not be acquired within the timeout.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.LockTimeoutError.__init__","level":3,"title":"__init__(detail=None, *, desc=None, data=None)","text":"
    Initialize the exception.
     
    Parameters:
     Name Type Description Default detail str | None 
    Optional human-readable message
     None desc str | None 
    Optional per-instance override for the description field in the HTTP response body.
     None data Any 
    Optional per-instance override for the data field in the HTTP response body.
     None","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.exceptions.generate_error_responses","level":2,"title":"fastapi_toolsets.exceptions.exceptions.generate_error_responses(*errors)","text":"
    Generate OpenAPI response documentation for exceptions.
     
    Parameters:
     Name Type Description Default *errors type[ApiException] 
    Exception classes that inherit from ApiException.
     () 
    Returns:
     Type Description dict[int | str, dict[str, Any]] 
    Dict suitable for FastAPI's responses parameter.
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/exceptions/#fastapi_toolsets.exceptions.handler.init_exceptions_handlers","level":2,"title":"fastapi_toolsets.exceptions.handler.init_exceptions_handlers(app)","text":"
    Register exception handlers and custom OpenAPI schema on a FastAPI app.
     
    Parameters:
     Name Type Description Default app FastAPI 
    FastAPI application instance.
     required 
    Returns:
     Type Description FastAPI 
    The same FastAPI instance (for chaining).
    ","path":["Reference","exceptions"],"tags":[]},{"location":"reference/fixtures/","level":1,"title":"fixtures","text":"
    Here's the reference for the fixture registry, enums, and loading utilities.
     
    You can import them directly from fastapi_toolsets.fixtures:
     
    from fastapi_toolsets.fixtures import (\n    Context,\n    LoadStrategy,\n    Fixture,\n    FixtureRegistry,\n    load_fixtures,\n    load_fixtures_by_context,\n    get_obj_by_attr,\n)\n
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context","level":2,"title":"fastapi_toolsets.fixtures.enum.Context","text":"
                   Bases: str, Enum
     
    Predefined fixture contexts.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.BASE","level":3,"title":"BASE = 'base'  class-attribute instance-attribute","text":"
    Base fixtures loaded in all environments.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.DEVELOPMENT","level":3,"title":"DEVELOPMENT = 'development'  class-attribute instance-attribute","text":"
    Development fixtures.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.PRODUCTION","level":3,"title":"PRODUCTION = 'production'  class-attribute instance-attribute","text":"
    Production-only fixtures.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.Context.TESTING","level":3,"title":"TESTING = 'testing'  class-attribute instance-attribute","text":"
    Test fixtures.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy","level":2,"title":"fastapi_toolsets.fixtures.enum.LoadStrategy","text":"
                   Bases: str, Enum
     
    Strategy for loading fixtures into the database.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy.INSERT","level":3,"title":"INSERT = 'insert'  class-attribute instance-attribute","text":"
    Insert new records. Fails if record already exists.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy.MERGE","level":3,"title":"MERGE = 'merge'  class-attribute instance-attribute","text":"
    Insert or update based on primary key (SQLAlchemy merge).
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.enum.LoadStrategy.SKIP_EXISTING","level":3,"title":"SKIP_EXISTING = 'skip_existing'  class-attribute instance-attribute","text":"
    Insert only if record doesn't exist (based on primary key).
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.Fixture","level":2,"title":"fastapi_toolsets.fixtures.registry.Fixture  dataclass","text":"
    A fixture definition with metadata.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry","level":2,"title":"fastapi_toolsets.fixtures.registry.FixtureRegistry","text":"
    Registry for managing fixtures with dependencies.
     Example 
    from fastapi_toolsets.fixtures import FixtureRegistry, Context\n\nfixtures = FixtureRegistry()\n\n@fixtures.register\ndef roles():\n    return [\n        Role(id=1, name=\"admin\"),\n        Role(id=2, name=\"user\"),\n    ]\n\n@fixtures.register(depends_on=[\"roles\"])\ndef users():\n    return [\n        User(id=1, username=\"admin\", role_id=1),\n    ]\n\n@fixtures.register(depends_on=[\"users\"], contexts=[Context.TESTING])\ndef test_data():\n    return [\n        Post(id=1, title=\"Test\", user_id=1),\n    ]\n
     
    Fixtures with the same name may be registered for different contexts. When multiple contexts are loaded together, their instances are merged:
     
    ```python\n@fixtures.register(contexts=[Context.BASE])\ndef users():\n    return [User(id=1, username=\"admin\")]\n\n@fixtures.register(contexts=[Context.TESTING])\ndef users():\n    return [User(id=2, username=\"tester\")]\n# load_fixtures_by_context(..., Context.BASE, Context.TESTING)\n# → loads both User(admin) and User(tester) under the \"users\" name\n```\n
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.get","level":3,"title":"get(name)","text":"
    Get a fixture by name.
     
    Raises:
     Type Description KeyError 
    If no fixture with name is registered.
     ValueError 
    If the fixture has multiple context variants — use :meth:get_variants in that case.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.get_all","level":3,"title":"get_all()","text":"
    Get all registered fixtures (all variants of all names).
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.get_by_context","level":3,"title":"get_by_context(*contexts)","text":"
    Get fixtures for specific contexts.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.get_variants","level":3,"title":"get_variants(name, *contexts)","text":"
    Return all registered variants for name, optionally filtered by context.
     
    Parameters:
     Name Type Description Default name str 
    Fixture name.
     required *contexts str | Enum 
    If given, only return variants whose context set intersects with these values.  Both :class:Context enum values and plain strings are accepted.
     () 
    Returns:
     Type Description list[Fixture] 
    List of matching :class:Fixture objects (may be empty when a
     list[Fixture] 
    context filter is applied and nothing matches).
     
    Raises:
     Type Description KeyError 
    If no fixture with name is registered.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.include_registry","level":3,"title":"include_registry(registry)","text":"
    Include another FixtureRegistry in the same current FixtureRegistry.
     
    Fixtures with the same name are allowed as long as their context sets do not overlap.  Conflicting contexts raise :class:ValueError.
     
    Parameters:
     Name Type Description Default registry FixtureRegistry 
    The FixtureRegistry to include
     required 
    Raises:
     Type Description ValueError 
    If a fixture name already exists with overlapping contexts
     Example 
    registry = FixtureRegistry()\ndev_registry = FixtureRegistry()\n\n@dev_registry.register\ndef dev_data():\n    return [...]\n\nregistry.include_registry(registry=dev_registry)\n
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.register","level":3,"title":"register(func=None, *, name=None, depends_on=None, contexts=None)","text":"
    Register a fixture function.
     
    Can be used as a decorator with or without arguments.
     
    Parameters:
     Name Type Description Default func Callable[[], Sequence[DeclarativeBase]] | None 
    Fixture function returning list of model instances
     None name str | None 
    Fixture name (defaults to function name)
     None depends_on list[str] | None 
    List of fixture names this depends on
     None contexts list[str | Enum] | None 
    List of contexts this fixture belongs to.  Both :class:Context enum values and plain strings are accepted.
     None Example 
    ```python @fixtures.register def roles():     return [Role(id=1, name=\"admin\")]
     
    @fixtures.register(depends_on=[\"roles\"], contexts=[Context.TESTING]) def test_users():     return [User(id=1, username=\"test\", role_id=1)]
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.resolve_context_dependencies","level":3,"title":"resolve_context_dependencies(*contexts)","text":"
    Resolve all fixtures for contexts with dependencies.
     
    Parameters:
     Name Type Description Default *contexts str | Enum 
    Contexts to load
     () 
    Returns:
     Type Description list[str] 
    List of fixture names in load order
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.registry.FixtureRegistry.resolve_dependencies","level":3,"title":"resolve_dependencies(*names)","text":"
    Resolve fixture dependencies in topological order.
     
    When a fixture name has multiple context variants, the union of all variants' depends_on lists is used.
     
    Parameters:
     Name Type Description Default *names str 
    Fixture names to resolve
     () 
    Returns:
     Type Description list[str] 
    List of fixture names in load order (dependencies first)
     
    Raises:
     Type Description KeyError 
    If a fixture is not found
     ValueError 
    If circular dependency detected
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.utils.load_fixtures","level":2,"title":"fastapi_toolsets.fixtures.utils.load_fixtures(session, registry, *names, strategy=LoadStrategy.MERGE)  async","text":"
    Load specific fixtures by name with dependencies.
     
    All context variants of each requested fixture are loaded and merged.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    Database session
     required registry FixtureRegistry 
    Fixture registry
     required *names str 
    Fixture names to load (dependencies auto-resolved)
     () strategy LoadStrategy 
    How to handle existing records
     MERGE 
    Returns:
     Type Description dict[str, list[DeclarativeBase]] 
    Dict mapping fixture names to loaded instances
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.utils.load_fixtures_by_context","level":2,"title":"fastapi_toolsets.fixtures.utils.load_fixtures_by_context(session, registry, *contexts, strategy=LoadStrategy.MERGE)  async","text":"
    Load all fixtures for specific contexts.
     
    Parameters:
     Name Type Description Default session AsyncSession 
    Database session
     required registry FixtureRegistry 
    Fixture registry
     required *contexts str | Enum 
    Contexts to load (e.g., Context.BASE, Context.TESTING, or plain strings for custom contexts)
     () strategy LoadStrategy 
    How to handle existing records
     MERGE 
    Returns:
     Type Description dict[str, list[DeclarativeBase]] 
    Dict mapping fixture names to loaded instances
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/fixtures/#fastapi_toolsets.fixtures.utils.get_obj_by_attr","level":2,"title":"fastapi_toolsets.fixtures.utils.get_obj_by_attr(fixtures, attr_name, value)","text":"
    Get a SQLAlchemy model instance by matching an attribute value.
     
    Parameters:
     Name Type Description Default fixtures Callable[[], Sequence[ModelType]] 
    A fixture function registered via @registry.register that returns a sequence of SQLAlchemy model instances.
     required attr_name str 
    Name of the attribute to match against.
     required value Any 
    Value to match.
     required 
    Returns:
     Type Description ModelType 
    The first model instance where the attribute matches the given value.
     
    Raises:
     Type Description StopIteration 
    If no matching object is found in the fixture group.
    ","path":["Reference","fixtures"],"tags":[]},{"location":"reference/logger/","level":1,"title":"logger","text":"
    Here's the reference for the logging utilities.
     
    You can import them directly from fastapi_toolsets.logger:
     
    from fastapi_toolsets.logger import configure_logging, get_logger\n
    ","path":["Reference","logger"],"tags":[]},{"location":"reference/logger/#fastapi_toolsets.logger.configure_logging","level":2,"title":"fastapi_toolsets.logger.configure_logging(level='INFO', fmt=DEFAULT_FORMAT, logger_name=None)","text":"
    Configure logging with a stdout handler and consistent format.
     
    Sets up a :class:~logging.StreamHandler writing to stdout with the given format and level.  Also configures the uvicorn loggers so that FastAPI access logs use the same format.
     
    Calling this function multiple times is safe -- existing handlers are replaced rather than duplicated.
     
    Parameters:
     Name Type Description Default level LogLevel | int 
    Log level (e.g. \"DEBUG\", \"INFO\", or logging.DEBUG).
     'INFO' fmt str 
    Log format string.  Defaults to \"%(asctime)s - %(name)s - %(levelname)s - %(message)s\".
     DEFAULT_FORMAT logger_name str | None 
    Logger name to configure.  None (the default) configures the root logger so all loggers inherit the settings.
     None 
    Returns:
     Type Description Logger 
    The configured Logger instance.
     Example 
    from fastapi_toolsets.logger import configure_logging\n\nlogger = configure_logging(\"DEBUG\")\nlogger.info(\"Application started\")\n
    ","path":["Reference","logger"],"tags":[]},{"location":"reference/logger/#fastapi_toolsets.logger.get_logger","level":2,"title":"fastapi_toolsets.logger.get_logger(name=_SENTINEL)","text":"
    Return a logger with the given name.
     
    A thin convenience wrapper around :func:logging.getLogger that keeps logging imports consistent across the codebase.
     
    When called without arguments, the caller's __name__ is used automatically, so get_logger() in a module is equivalent to logging.getLogger(__name__).  Pass None explicitly to get the root logger.
     
    Parameters:
     Name Type Description Default name str | None 
    Logger name.  Defaults to the caller's __name__. Pass None to get the root logger.
     _SENTINEL 
    Returns:
     Type Description Logger 
    A Logger instance.
     Example 
    from fastapi_toolsets.logger import get_logger\n\nlogger = get_logger()          # uses caller's __name__\nlogger = get_logger(\"myapp\")   # explicit name\nlogger = get_logger(None)      # root logger\n
    ","path":["Reference","logger"],"tags":[]},{"location":"reference/metrics/","level":1,"title":"metrics","text":"
    Here's the reference for the Prometheus metrics registry and endpoint handler.
     
    You can import them directly from fastapi_toolsets.metrics:
     
    from fastapi_toolsets.metrics import Metric, MetricsRegistry, init_metrics\n
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.Metric","level":2,"title":"fastapi_toolsets.metrics.registry.Metric  dataclass","text":"
    A metric definition with metadata.
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry","level":2,"title":"fastapi_toolsets.metrics.registry.MetricsRegistry","text":"
    Registry for managing Prometheus metric providers and collectors.
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get","level":3,"title":"get(name)","text":"
    Return the metric instance created by a provider.
     
    Parameters:
     Name Type Description Default name str 
    The metric name (defaults to the provider function name).
     required 
    Raises:
     Type Description KeyError 
    If the metric name is unknown or init_metrics has not been called yet.
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get_all","level":3,"title":"get_all()","text":"
    Get all registered metric definitions.
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get_collectors","level":3,"title":"get_collectors()","text":"
    Get collectors (called on each scrape).
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.get_providers","level":3,"title":"get_providers()","text":"
    Get metric providers (called once at init).
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.include_registry","level":3,"title":"include_registry(registry)","text":"
    Include another :class:MetricsRegistry into this one.
     
    Parameters:
     Name Type Description Default registry MetricsRegistry 
    The registry to merge in.
     required 
    Raises:
     Type Description ValueError 
    If a metric name already exists in the current registry.
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.registry.MetricsRegistry.register","level":3,"title":"register(func=None, *, name=None, collect=False)","text":"
    Register a metric provider or collector function.
     
    Can be used as a decorator with or without arguments.
     
    Parameters:
     Name Type Description Default func Callable[..., Any] | None 
    The metric function to register.
     None name str | None 
    Metric name (defaults to function name).
     None collect bool 
    If True, the function is called on every scrape. If False (default), called once at init time.
     False","path":["Reference","metrics"],"tags":[]},{"location":"reference/metrics/#fastapi_toolsets.metrics.handler.init_metrics","level":2,"title":"fastapi_toolsets.metrics.handler.init_metrics(app, registry, *, path='/metrics')","text":"
    Register a Prometheus /metrics endpoint on a FastAPI app.
     
    Parameters:
     Name Type Description Default app FastAPI 
    FastAPI application instance.
     required registry MetricsRegistry 
    A :class:MetricsRegistry containing providers and collectors.
     required path str 
    URL path for the metrics endpoint (default /metrics).
     '/metrics' 
    Returns:
     Type Description FastAPI 
    The same FastAPI instance (for chaining).
     Example 
    from fastapi import FastAPI\nfrom fastapi_toolsets.metrics import MetricsRegistry, init_metrics\n\nmetrics = MetricsRegistry()\napp = FastAPI()\ninit_metrics(app, registry=metrics)\n
    ","path":["Reference","metrics"],"tags":[]},{"location":"reference/models/","level":1,"title":"models","text":"
    Here's the reference for the SQLAlchemy model mixins provided by the models module.
     
    You can import them directly from fastapi_toolsets.models:
     
    from fastapi_toolsets.models import (\n    EventSession,\n    ModelEvent,\n    UUIDMixin,\n    UUIDv7Mixin,\n    CreatedAtMixin,\n    UpdatedAtMixin,\n    TimestampMixin,\n    listens_for,\n)\n
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.EventSession","level":2,"title":"fastapi_toolsets.models.EventSession","text":"
                   Bases: AsyncSession
     
    AsyncSession subclass that dispatches lifecycle callbacks after commit.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.ModelEvent","level":2,"title":"fastapi_toolsets.models.ModelEvent","text":"
                   Bases: str, Enum
     
    Event types dispatched by :class:EventSession.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.UUIDMixin","level":2,"title":"fastapi_toolsets.models.UUIDMixin","text":"
    Mixin that adds a UUID primary key auto-generated by the database.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.UUIDv7Mixin","level":2,"title":"fastapi_toolsets.models.UUIDv7Mixin","text":"
    Mixin that adds a UUIDv7 primary key auto-generated by the database.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.CreatedAtMixin","level":2,"title":"fastapi_toolsets.models.CreatedAtMixin","text":"
    Mixin that adds a created_at timestamp column.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.UpdatedAtMixin","level":2,"title":"fastapi_toolsets.models.UpdatedAtMixin","text":"
    Mixin that adds an updated_at timestamp column.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.TimestampMixin","level":2,"title":"fastapi_toolsets.models.TimestampMixin","text":"
                   Bases: CreatedAtMixin, UpdatedAtMixin
     
    Mixin that combines created_at and updated_at timestamp columns.
    ","path":["Reference","models"],"tags":[]},{"location":"reference/models/#fastapi_toolsets.models.listens_for","level":2,"title":"fastapi_toolsets.models.listens_for(model_class, event_types=None)","text":"
    Register a callback for one or more model lifecycle events.
     
    Parameters:
     Name Type Description Default model_class type 
    The SQLAlchemy model class to listen on.
     required event_types list[ModelEvent] | None 
    List of :class:ModelEvent values to listen for. Defaults to all event types.
     None","path":["Reference","models"],"tags":[]},{"location":"reference/pytest/","level":1,"title":"pytest","text":"
    Here's the reference for all testing utilities and pytest fixtures.
     
    You can import them directly from fastapi_toolsets.pytest:
     
    from fastapi_toolsets.pytest import (\n    register_fixtures,\n    create_async_client,\n    create_db_session,\n    worker_database_url,\n    create_worker_database,\n    cleanup_tables,\n)\n
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.plugin.register_fixtures","level":2,"title":"fastapi_toolsets.pytest.plugin.register_fixtures(registry, namespace, *, prefix='fixture_', session_fixture='db_session', strategy=LoadStrategy.MERGE)","text":"
    Register pytest fixtures from a FixtureRegistry.
     
    Automatically creates pytest fixtures for each fixture in the registry. Dependencies are resolved via pytest fixture dependencies.
     
    Parameters:
     Name Type Description Default registry FixtureRegistry 
    The FixtureRegistry containing fixtures
     required namespace dict[str, Any] 
    The module's globals() dict to add fixtures to
     required prefix str 
    Prefix for generated fixture names (default: \"fixture_\")
     'fixture_' session_fixture str 
    Name of the db session fixture (default: \"db_session\")
     'db_session' strategy LoadStrategy 
    Loading strategy for fixtures (default: MERGE)
     MERGE 
    Returns:
     Type Description list[str] 
    List of created fixture names
     Example 
    # conftest.py\nfrom app.fixtures import fixtures\nfrom fastapi_toolsets.pytest_plugin import register_fixtures\n\nregister_fixtures(fixtures, globals())\n\n# Creates fixtures like:\n# - fixture_roles\n# - fixture_users (depends on fixture_roles if users depends on roles)\n# - fixture_posts (depends on fixture_users if posts depends on users)\n
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.utils.create_async_client","level":2,"title":"fastapi_toolsets.pytest.utils.create_async_client(app, base_url='http://test', dependency_overrides=None)  async","text":"
    Create an async httpx client for testing FastAPI applications.
     
    Parameters:
     Name Type Description Default app Any 
    FastAPI application instance.
     required base_url str 
    Base URL for requests. Defaults to \"http://test\".
     'http://test' dependency_overrides dict[Callable[..., Any], Callable[..., Any]] | None 
    Optional mapping of original dependencies to their test replacements. Applied via app.dependency_overrides before yielding and cleaned up after.
     None 
    Yields:
     Type Description AsyncGenerator[AsyncClient, None] 
    An AsyncClient configured for the app.
     Example 
    from fastapi import FastAPI\nfrom fastapi_toolsets.pytest import create_async_client\n\napp = FastAPI()\n\n@pytest.fixture\nasync def client():\n    async with create_async_client(app) as c:\n        yield c\n\nasync def test_endpoint(client: AsyncClient):\n    response = await client.get(\"/health\")\n    assert response.status_code == 200\n
     Example with dependency overrides 
    from fastapi_toolsets.pytest import create_async_client, create_db_session\nfrom app.db import get_db\n\n@pytest.fixture\nasync def db_session():\n    async with create_db_session(DATABASE_URL, Base, cleanup=True) as session:\n        yield session\n\n@pytest.fixture\nasync def client(db_session):\n    async def override():\n        yield db_session\n\n    async with create_async_client(\n        app, dependency_overrides={get_db: override}\n    ) as c:\n        yield c\n
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.utils.create_db_session","level":2,"title":"fastapi_toolsets.pytest.utils.create_db_session(database_url, base, *, echo=False, expire_on_commit=False, drop_tables=True, cleanup=False)  async","text":"
    Create a database session for testing.
     
    Creates tables before yielding the session and optionally drops them after. Each call creates a fresh engine and session for test isolation.
     
    Parameters:
     Name Type Description Default database_url str 
    Database connection URL (e.g., \"postgresql+asyncpg://...\").
     required base type[DeclarativeBase] 
    SQLAlchemy DeclarativeBase class containing model metadata.
     required echo bool 
    Enable SQLAlchemy query logging. Defaults to False.
     False expire_on_commit bool 
    Expire objects after commit. Defaults to False.
     False drop_tables bool 
    Drop tables after test. Defaults to True.
     True cleanup bool 
    Truncate all tables after test using :func:cleanup_tables. Defaults to False.
     False 
    Yields:
     Type Description AsyncGenerator[AsyncSession, None] 
    An AsyncSession ready for database operations.
     Example 
    from fastapi_toolsets.pytest import create_db_session\nfrom app.models import Base\n\nDATABASE_URL = \"postgresql+asyncpg://user:pass@localhost/test_db\"\n\n@pytest.fixture\nasync def db_session():\n    async with create_db_session(\n        DATABASE_URL, Base, cleanup=True\n    ) as session:\n        yield session\n\nasync def test_create_user(db_session: AsyncSession):\n    user = User(name=\"test\")\n    db_session.add(user)\n    await db_session.commit()\n
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.utils.worker_database_url","level":2,"title":"fastapi_toolsets.pytest.utils.worker_database_url(database_url, default_test_db)","text":"
    Derive a per-worker database URL for pytest-xdist parallel runs.
     
    Appends _{worker_name} to the database name so each xdist worker operates on its own database.  When not running under xdist, _{default_test_db} is appended instead.
     
    The worker name is read from the PYTEST_XDIST_WORKER environment variable (set automatically by xdist in each worker process).
     
    Parameters:
     Name Type Description Default database_url str 
    Original database connection URL.
     required default_test_db str 
    Suffix appended to the database name when PYTEST_XDIST_WORKER is not set.
     required 
    Returns:
     Type Description str 
    A database URL with a worker- or default-specific database name.
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/pytest/#fastapi_toolsets.pytest.utils.create_worker_database","level":2,"title":"fastapi_toolsets.pytest.utils.create_worker_database(database_url, default_test_db='test_db')  async","text":"
    Create and drop a per-worker database for pytest-xdist isolation.
     
    Derives a worker-specific database URL using :func:worker_database_url, then delegates to :func:~fastapi_toolsets.db.create_database to create and drop it.  Intended for use as a session-scoped fixture.
     
    When running under xdist the database name is suffixed with the worker name (e.g. _gw0).  Otherwise it is suffixed with default_test_db.
     
    Parameters:
     Name Type Description Default database_url str 
    Original database connection URL (used as the server connection and as the base for the worker database name).
     required default_test_db str 
    Suffix appended to the database name when PYTEST_XDIST_WORKER is not set. Defaults to \"test_db\".
     'test_db' 
    Yields:
     Type Description AsyncGenerator[str, None] 
    The worker-specific database URL.
     Example 
    from fastapi_toolsets.pytest import create_worker_database, create_db_session\n\nDATABASE_URL = \"postgresql+asyncpg://postgres:postgres@localhost/test_db\"\n\n@pytest.fixture(scope=\"session\")\nasync def worker_db_url():\n    async with create_worker_database(DATABASE_URL) as url:\n        yield url\n\n@pytest.fixture\nasync def db_session(worker_db_url):\n    async with create_db_session(\n        worker_db_url, Base, cleanup=True\n    ) as session:\n        yield session\n
    ","path":["Reference","pytest"],"tags":[]},{"location":"reference/schemas/","level":1,"title":"schemas","text":"
    Here's the reference for all response models and types provided by the schemas module.
     
    You can import them directly from fastapi_toolsets.schemas:
     
    from fastapi_toolsets.schemas import (\n    PydanticBase,\n    ResponseStatus,\n    ApiError,\n    BaseResponse,\n    Response,\n    ErrorResponse,\n    OffsetPagination,\n    CursorPagination,\n    PaginationType,\n    PaginatedResponse,\n    OffsetPaginatedResponse,\n    CursorPaginatedResponse,\n)\n
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.PydanticBase","level":2,"title":"fastapi_toolsets.schemas.PydanticBase","text":"
                   Bases: BaseModel
     
    Base class for all Pydantic models with common configuration.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.ResponseStatus","level":2,"title":"fastapi_toolsets.schemas.ResponseStatus","text":"
                   Bases: str, Enum
     
    Standard API response status.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.ApiError","level":2,"title":"fastapi_toolsets.schemas.ApiError","text":"
                   Bases: PydanticBase
     
    Structured API error definition.
     
    Used to define standard error responses with consistent format.
     
    Attributes:
     Name Type Description code int 
    HTTP status code
     msg str 
    Short error message
     desc str 
    Detailed error description
     err_code str 
    Application-specific error code (e.g., \"AUTH-401\")
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.BaseResponse","level":2,"title":"fastapi_toolsets.schemas.BaseResponse","text":"
                   Bases: PydanticBase
     
    Base response structure for all API responses.
     
    Attributes:
     Name Type Description status ResponseStatus 
    SUCCESS or FAIL
     message str 
    Human-readable message
     error_code str | None 
    Error code if status is FAIL, None otherwise
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.Response","level":2,"title":"fastapi_toolsets.schemas.Response","text":"
                   Bases: BaseResponse, Generic[DataT]
     
    Generic API response with data payload.
     Example 
    Response[UserRead](data=user, message=\"User retrieved\")\n
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.ErrorResponse","level":2,"title":"fastapi_toolsets.schemas.ErrorResponse","text":"
                   Bases: BaseResponse
     
    Error response with additional description field.
     
    Used for error responses that need more context.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.OffsetPagination","level":2,"title":"fastapi_toolsets.schemas.OffsetPagination","text":"
                   Bases: PydanticBase
     
    Pagination metadata for offset-based list responses.
     
    Attributes:
     Name Type Description total_count int | None 
    Total number of items across all pages. None when include_total=False.
     items_per_page int 
    Number of items per page
     page int 
    Current page number (1-indexed)
     has_more bool 
    Whether there are more pages
     pages int | None 
    Total number of pages
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.OffsetPagination.pages","level":3,"title":"pages  property","text":"
    Total number of pages, or None when total_count is unknown.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.CursorPagination","level":2,"title":"fastapi_toolsets.schemas.CursorPagination","text":"
                   Bases: PydanticBase
     
    Pagination metadata for cursor-based list responses.
     
    Attributes:
     Name Type Description next_cursor str | None 
    Encoded cursor for the next page, or None on the last page.
     prev_cursor str | None 
    Encoded cursor for the previous page, or None on the first page.
     items_per_page int 
    Number of items requested per page.
     has_more bool 
    Whether there is at least one more page after this one.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.PaginationType","level":2,"title":"fastapi_toolsets.schemas.PaginationType","text":"
                   Bases: str, Enum
     
    Pagination strategy selector for :meth:.AsyncCrud.paginate.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.PaginatedResponse","level":2,"title":"fastapi_toolsets.schemas.PaginatedResponse","text":"
                   Bases: BaseResponse, Generic[DataT]
     
    Paginated API response for list endpoints.
     
    Base class and return type for endpoints that support both pagination strategies.  Use :class:OffsetPaginatedResponse or :class:CursorPaginatedResponse when the strategy is fixed.
     
    When used as PaginatedResponse[T] in a return annotation, subscripting returns Annotated[Union[CursorPaginatedResponse[T], OffsetPaginatedResponse[T]], Field(discriminator=\"pagination_type\")] so FastAPI emits a proper oneOf + discriminator in the OpenAPI schema.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.OffsetPaginatedResponse","level":2,"title":"fastapi_toolsets.schemas.OffsetPaginatedResponse","text":"
                   Bases: PaginatedResponse[DataT]
     
    Paginated response with typed offset-based pagination metadata.
     
    The pagination_type field is always \"offset\" and acts as a discriminator, allowing frontend clients to narrow the union type returned by a unified paginate() endpoint.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/schemas/#fastapi_toolsets.schemas.CursorPaginatedResponse","level":2,"title":"fastapi_toolsets.schemas.CursorPaginatedResponse","text":"
                   Bases: PaginatedResponse[DataT]
     
    Paginated response with typed cursor-based pagination metadata.
     
    The pagination_type field is always \"cursor\" and acts as a discriminator, allowing frontend clients to narrow the union type returned by a unified paginate() endpoint.
    ","path":["Reference","schemas"],"tags":[]},{"location":"reference/security/","level":1,"title":"security","text":"
    Here's the reference for the authentication helpers provided by the security module.
     
    You can import them directly from fastapi_toolsets.security:
     
    from fastapi_toolsets.security import (\n    AuthSource,\n    BearerTokenAuth,\n    CookieAuth,\n    APIKeyHeaderAuth,\n    MultiAuth,\n    oauth_build_authorization_redirect,\n    oauth_decode_state,\n    oauth_encode_state,\n    oauth_fetch_userinfo,\n    oauth_generate_state_token,\n    oauth_resolve_provider_urls,\n)\n
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.AuthSource","level":2,"title":"fastapi_toolsets.security.AuthSource","text":"
                   Bases: ABC
     
    Abstract base class for authentication sources.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.AuthSource.__call__","level":3,"title":"__call__(**kwargs)  async","text":"
    FastAPI dependency dispatch.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.AuthSource.__init__","level":3,"title":"__init__()","text":"
    Set up the default FastAPI dependency signature.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.AuthSource.authenticate","level":3,"title":"authenticate(credential)  abstractmethod async","text":"
    Validate a credential and return the authenticated identity.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.AuthSource.extract","level":3,"title":"extract(request)  abstractmethod async","text":"
    Extract the raw credential from the request without validating.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth","level":2,"title":"fastapi_toolsets.security.BearerTokenAuth","text":"
                   Bases: AuthSource
     
    Bearer token authentication source.
     
    Wraps :class:fastapi.security.HTTPBearer for OpenAPI documentation. The validator is called as await validator(credential, **kwargs) where kwargs are the extra keyword arguments provided at instantiation.
     
    Parameters:
     Name Type Description Default validator Callable[..., Any] 
    Sync or async callable that receives the credential and any extra keyword arguments, and returns the authenticated identity (e.g. a User model). Should raise :class:~fastapi_toolsets.exceptions.UnauthorizedError on failure.
     required prefix str | None 
    Optional token prefix (e.g. \"user_\"). If set, only tokens whose value starts with this prefix are matched. The prefix is kept in the value passed to the validator — store and compare tokens with their prefix included. Use :meth:generate_token to create correctly-prefixed tokens. This enables multiple BearerTokenAuth instances in the same app (e.g. \"user_\" for user tokens, \"org_\" for org tokens).
     None **kwargs Any 
    Extra keyword arguments forwarded to the validator on every call (e.g. role=Role.ADMIN).
     {}","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth.__call__","level":3,"title":"__call__(**kwargs)  async","text":"
    FastAPI dependency dispatch.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth.authenticate","level":3,"title":"authenticate(credential)  async","text":"
    Validate a credential and return the identity.
     
    Calls await validator(credential, **kwargs) where kwargs are the extra keyword arguments provided at instantiation.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth.extract","level":3,"title":"extract(request)  async","text":"
    Extract the raw credential from the request without validating.
     
    Returns None if no Authorization: Bearer header is present, the token is empty, or the token does not match the configured prefix. The prefix is included in the returned value.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth.generate_token","level":3,"title":"generate_token(nbytes=32)","text":"
    Generate a secure random token for this auth source.
     
    Returns a URL-safe random token. If a prefix is configured it is prepended — the returned value is what you store in your database and return to the client as-is.
     
    Parameters:
     Name Type Description Default nbytes int 
    Number of random bytes before base64 encoding. The resulting string is ceil(nbytes * 4 / 3) characters (43 chars for the default 32 bytes). Defaults to 32.
     32 
    Returns:
     Type Description str 
    A ready-to-use token string (e.g. \"user_Xk3...\").
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.BearerTokenAuth.require","level":3,"title":"require(**kwargs)","text":"
    Return a new instance with additional (or overriding) validator kwargs.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.CookieAuth","level":2,"title":"fastapi_toolsets.security.CookieAuth","text":"
                   Bases: AuthSource
     
    Cookie-based authentication source.
     
    Wraps :class:fastapi.security.APIKeyCookie for OpenAPI documentation. Optionally signs the cookie with HMAC-SHA256 to provide stateless, tamper- proof sessions without any database entry.
     
    Parameters:
     Name Type Description Default name str 
    Cookie name.
     required validator Callable[..., Any] 
    Sync or async callable that receives the cookie value (plain, after signature verification when secret_key is set) and any extra keyword arguments, and returns the authenticated identity.
     required secret_key str | None 
    When provided, the cookie is HMAC-SHA256 signed. :meth:set_cookie embeds an expiry and signs the payload; :meth:extract verifies the signature and expiry before handing the plain value to the validator.  When None (default), the raw cookie value is passed to the validator as-is.
     None ttl int 
    Cookie lifetime in seconds (default 24 h).  Only used when secret_key is set.
     86400 secure bool 
    Set the Secure flag on the cookie so it is only transmitted over HTTPS (default True).  Set to False only in local development environments where HTTPS is unavailable.
     True **kwargs Any 
    Extra keyword arguments forwarded to the validator on every call (e.g. role=Role.ADMIN).
     {}","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.CookieAuth.__call__","level":3,"title":"__call__(**kwargs)  async","text":"
    FastAPI dependency dispatch.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.CookieAuth.delete_cookie","level":3,"title":"delete_cookie(response)","text":"
    Clear the session cookie (logout).
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.CookieAuth.require","level":3,"title":"require(**kwargs)","text":"
    Return a new instance with additional (or overriding) validator kwargs.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.CookieAuth.set_cookie","level":3,"title":"set_cookie(response, value)","text":"
    Attach the cookie to response, signing it when secret_key is set.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.APIKeyHeaderAuth","level":2,"title":"fastapi_toolsets.security.APIKeyHeaderAuth","text":"
                   Bases: AuthSource
     
    API key header authentication source.
     
    Wraps :class:fastapi.security.APIKeyHeader for OpenAPI documentation. The validator is called as await validator(api_key, **kwargs) where kwargs are the extra keyword arguments provided at instantiation.
     
    Parameters:
     Name Type Description Default name str 
    HTTP header name that carries the API key (e.g. \"X-API-Key\").
     required validator Callable[..., Any] 
    Sync or async callable that receives the API key and any extra keyword arguments, and returns the authenticated identity. Should raise :class:~fastapi_toolsets.exceptions.UnauthorizedError on failure.
     required **kwargs Any 
    Extra keyword arguments forwarded to the validator on every call (e.g. role=Role.ADMIN).
     {}","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.APIKeyHeaderAuth.__call__","level":3,"title":"__call__(**kwargs)  async","text":"
    FastAPI dependency dispatch.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.APIKeyHeaderAuth.authenticate","level":3,"title":"authenticate(credential)  async","text":"
    Validate a credential and return the identity.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.APIKeyHeaderAuth.extract","level":3,"title":"extract(request)  async","text":"
    Extract the API key from the configured header.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.APIKeyHeaderAuth.require","level":3,"title":"require(**kwargs)","text":"
    Return a new instance with additional (or overriding) validator kwargs.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.MultiAuth","level":2,"title":"fastapi_toolsets.security.MultiAuth","text":"
    Combine multiple authentication sources into a single callable.
     
    Parameters:
     Name Type Description Default *sources AuthSource 
    Auth source instances to try in order.
     ()","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.MultiAuth.require","level":3,"title":"require(**kwargs)","text":"
    Return a new :class:MultiAuth with kwargs forwarded to each source.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_resolve_provider_urls","level":2,"title":"fastapi_toolsets.security.oauth_resolve_provider_urls(discovery_url)  async","text":"
    Fetch the OIDC discovery document and return endpoint URLs.
     
    Parameters:
     Name Type Description Default discovery_url str 
    URL of the provider's /.well-known/openid-configuration.
     required 
    Returns:
     Type Description str 
    A (authorization_url, token_url, userinfo_url) tuple.
     str 
    userinfo_url is None when the provider does not advertise one.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_fetch_userinfo","level":2,"title":"fastapi_toolsets.security.oauth_fetch_userinfo(*, token_url, userinfo_url, code, client_id, client_secret, redirect_uri, required_scopes=None)  async","text":"
    Exchange an authorization code for tokens and return the userinfo payload.
     
    Parameters:
     Name Type Description Default token_url str 
    Provider's token endpoint.
     required userinfo_url str 
    Provider's userinfo endpoint.
     required code str 
    Authorization code received from the provider's callback.
     required client_id str 
    OAuth application client ID.
     required client_secret str 
    OAuth application client secret.
     required redirect_uri str 
    Redirect URI that was used in the authorization request.
     required required_scopes str | None 
    Space-separated scopes that must be present in the token response scope field (RFC 6749 §3.3).  Raises ValueError if the provider granted fewer scopes than requested.
     None 
    Returns:
     Type Description dict[str, Any] 
    The JSON payload returned by the userinfo endpoint as a plain dict.
     
    Raises:
     Type Description ValueError 
    If the provider granted a different token type than bearer or did not grant all required_scopes.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_generate_state_token","level":2,"title":"fastapi_toolsets.security.oauth_generate_state_token()","text":"
    Generate a cryptographically random CSRF token for the OAuth state parameter.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_build_authorization_redirect","level":2,"title":"fastapi_toolsets.security.oauth_build_authorization_redirect(authorization_url, *, client_id, scopes, redirect_uri, destination, state_token)","text":"
    Return an OAuth 2.0 authorization RedirectResponse.
     
    Parameters:
     Name Type Description Default authorization_url str 
    Provider's authorization endpoint.
     required client_id str 
    OAuth application client ID.
     required scopes str 
    Space-separated list of requested scopes.
     required redirect_uri str 
    URI the provider should redirect back to after authorization.
     required destination str 
    URL the user should be sent to after the full OAuth flow completes (embedded in state).
     required state_token str 
    CSRF token generated by :func:oauth_generate_state_token. Must be stored server-side (session or signed cookie) and verified via :func:oauth_decode_state on the callback endpoint (RFC 6749 §10.12).
     required 
    Returns:
     Name Type Description A RedirectResponse 
    class:~fastapi.responses.RedirectResponse to the provider's
     RedirectResponse 
    authorization page.
    ","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_encode_state","level":2,"title":"fastapi_toolsets.security.oauth_encode_state(url, state_token)","text":"
    Encode a destination URL and CSRF token into an OAuth state parameter.
     
    Parameters:
     Name Type Description Default url str 
    Post-login destination URL.
     required state_token str 
    CSRF token from :func:oauth_generate_state_token.
     required","path":["Reference","security"],"tags":[]},{"location":"reference/security/#fastapi_toolsets.security.oauth_decode_state","level":2,"title":"fastapi_toolsets.security.oauth_decode_state(state, *, expected_state_token, fallback)","text":"
    Decode and CSRF-verify an OAuth state parameter.
     
    Uses a constant-time comparison for the CSRF token to prevent timing attacks.
     
    Parameters:
     Name Type Description Default state str | None 
    Raw state query parameter from the provider's callback.
     required expected_state_token str 
    The token stored before the authorization redirect. If it does not match the decoded value, fallback is returned.
     required fallback str 
    URL to return when state is absent, malformed, or fails CSRF verification.
     required 
    Returns:
     Type Description str 
    The destination URL embedded in state, or fallback.
     Important 
    Single-use: delete the stored token from the session immediately after calling this function — whether it matched or not — so that a captured callback URL cannot be replayed.
     
    Open-redirect: validate the returned URL against a known-good origin or relative-path allowlist before issuing the final redirect. Do not forward arbitrary URLs to RedirectResponse.
    ","path":["Reference","security"],"tags":[]}]}
\ No newline at end of file