diff --git a/404.html b/404.html index b9af17b..35149dc 100644 --- a/404.html +++ b/404.html @@ -4,8 +4,8 @@ NestJS CLS - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/api.html b/api.html index ee3cb19..0b3b18f 100644 --- a/api.html +++ b/api.html @@ -4,8 +4,8 @@ API | NestJS CLS - - + +
Skip to main content

API

diff --git a/api/module-options.html b/api/module-options.html index 471e670..b2d6ea8 100644 --- a/api/module-options.html +++ b/api/module-options.html @@ -4,8 +4,8 @@ Module Options | NestJS CLS - - + +

Module Options

diff --git a/api/service-interface.html b/api/service-interface.html index b9fed12..e01f0fd 100644 --- a/api/service-interface.html +++ b/api/service-interface.html @@ -4,8 +4,8 @@ Service Interface | NestJS CLS - - + +

Service Interface

diff --git a/assets/js/2d4cceda.5696927d.js b/assets/js/2d4cceda.5696927d.js new file mode 100644 index 0000000..7dbc107 --- /dev/null +++ b/assets/js/2d4cceda.5696927d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunknestjs_cls_docs=self.webpackChunknestjs_cls_docs||[]).push([[285],{2599:(e,n,t)=>{t.d(n,{Z:()=>i});t(7378);var a=t(624);const s={tabItem:"tabItem_wHwb"};var r=t(4246);function i(e){let{children:n,hidden:t,className:i}=e;return(0,r.jsx)("div",{role:"tabpanel",className:(0,a.Z)(s.tabItem,i),hidden:t,children:n})}},8447:(e,n,t)=>{t.d(n,{Z:()=>w});var a=t(7378),s=t(624),r=t(9169),i=t(3620),l=t(9749),o=t(8981),c=t(56),u=t(8796);function d(e){return a.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function p(e){const{values:n,children:t}=e;return(0,a.useMemo)((()=>{const e=n??function(e){return d(e).map((e=>{let{props:{value:n,label:t,attributes:a,default:s}}=e;return{value:n,label:t,attributes:a,default:s}}))}(t);return function(e){const n=(0,c.l)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[n,t])}function h(e){let{value:n,tabValues:t}=e;return t.some((e=>e.value===n))}function m(e){let{queryString:n=!1,groupId:t}=e;const s=(0,i.k6)(),r=function(e){let{queryString:n=!1,groupId:t}=e;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!t)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return t??null}({queryString:n,groupId:t});return[(0,o._X)(r),(0,a.useCallback)((e=>{if(!r)return;const n=new URLSearchParams(s.location.search);n.set(r,e),s.replace({...s.location,search:n.toString()})}),[r,s])]}function g(e){const{defaultValue:n,queryString:t=!1,groupId:s}=e,r=p(e),[i,o]=(0,a.useState)((()=>function(e){let{defaultValue:n,tabValues:t}=e;if(0===t.length)throw new Error("Docusaurus error: the component requires at least one children component");if(n){if(!h({value:n,tabValues:t}))throw new Error(`Docusaurus error: The has a defaultValue "${n}" but none of its children has the corresponding value. Available values are: ${t.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return n}const a=t.find((e=>e.default))??t[0];if(!a)throw new Error("Unexpected error: 0 tabValues");return a.value}({defaultValue:n,tabValues:r}))),[c,d]=m({queryString:t,groupId:s}),[g,x]=function(e){let{groupId:n}=e;const t=function(e){return e?`docusaurus.tab.${e}`:null}(n),[s,r]=(0,u.Nk)(t);return[s,(0,a.useCallback)((e=>{t&&r.set(e)}),[t,r])]}({groupId:s}),b=(()=>{const e=c??g;return h({value:e,tabValues:r})?e:null})();(0,l.Z)((()=>{b&&o(b)}),[b]);return{selectedValue:i,selectValue:(0,a.useCallback)((e=>{if(!h({value:e,tabValues:r}))throw new Error(`Can't select invalid tab value=${e}`);o(e),d(e),x(e)}),[d,x,r]),tabValues:r}}var x=t(362);const b={tabList:"tabList_J5MA",tabItem:"tabItem_l0OV"};var f=t(4246);function j(e){let{className:n,block:t,selectedValue:a,selectValue:i,tabValues:l}=e;const o=[],{blockElementScrollPositionUntilNextRender:c}=(0,r.o5)(),u=e=>{const n=e.currentTarget,t=o.indexOf(n),s=l[t].value;s!==a&&(c(n),i(s))},d=e=>{let n=null;switch(e.key){case"Enter":u(e);break;case"ArrowRight":{const t=o.indexOf(e.currentTarget)+1;n=o[t]??o[0];break}case"ArrowLeft":{const t=o.indexOf(e.currentTarget)-1;n=o[t]??o[o.length-1];break}}n?.focus()};return(0,f.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,s.Z)("tabs",{"tabs--block":t},n),children:l.map((e=>{let{value:n,label:t,attributes:r}=e;return(0,f.jsx)("li",{role:"tab",tabIndex:a===n?0:-1,"aria-selected":a===n,ref:e=>o.push(e),onKeyDown:d,onClick:u,...r,className:(0,s.Z)("tabs__item",b.tabItem,r?.className,{"tabs__item--active":a===n}),children:t??n},n)}))})}function v(e){let{lazy:n,children:t,selectedValue:s}=e;const r=(Array.isArray(t)?t:[t]).filter(Boolean);if(n){const e=r.find((e=>e.props.value===s));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return(0,f.jsx)("div",{className:"margin-top--md",children:r.map(((e,n)=>(0,a.cloneElement)(e,{key:n,hidden:e.props.value!==s})))})}function y(e){const n=g(e);return(0,f.jsxs)("div",{className:(0,s.Z)("tabs-container",b.tabList),children:[(0,f.jsx)(j,{...e,...n}),(0,f.jsx)(v,{...e,...n})]})}function w(e){const n=(0,x.Z)();return(0,f.jsx)(y,{...e,children:d(e.children)},String(n))}},2822:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>c,toc:()=>d});var a=t(4246),s=t(1670),r=t(8447),i=t(2599);const l={},o="Prisma adapter",c={id:"plugins/available-plugins/transactional/prisma-adapter",title:"Prisma adapter",description:"Installation",source:"@site/docs/06_plugins/01_available-plugins/01-transactional/01-prisma-adapter.md",sourceDirName:"06_plugins/01_available-plugins/01-transactional",slug:"/plugins/available-plugins/transactional/prisma-adapter",permalink:"/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter",draft:!1,unlisted:!1,editUrl:"https://github.com/Papooch/nestjs-cls/tree/main/docs/docs/06_plugins/01_available-plugins/01-transactional/01-prisma-adapter.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{},sidebar:"documentationSidebar",previous:{title:"@nestjs-cls/transactional",permalink:"/nestjs-cls/plugins/available-plugins/transactional/"},next:{title:"Knex adapter",permalink:"/nestjs-cls/plugins/available-plugins/transactional/knex-adapter"}},u={},d=[{value:"Installation",id:"installation",level:2},{value:"Registration",id:"registration",level:2},{value:"Typing & usage",id:"typing--usage",level:2},{value:"Example",id:"example",level:2},{value:"Custom client type",id:"custom-client-type",level:2}];function p(e){const n={admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"prisma-adapter",children:"Prisma adapter"}),"\n",(0,a.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,a.jsxs)(r.Z,{children:[(0,a.jsx)(i.Z,{value:"npm",label:"npm",default:!0,children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"npm install @nestjs-cls/transactional-adapter-prisma\n"})})}),(0,a.jsx)(i.Z,{value:"yarn",label:"yarn",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"yarn add @nestjs-cls/transactional-adapter-prisma\n"})})}),(0,a.jsx)(i.Z,{value:"pnpm",label:"pnpm",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"pnpm add @nestjs-cls/transactional-adapter-prisma\n"})})})]}),"\n",(0,a.jsx)(n.h2,{id:"registration",children:"Registration"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"ClsModule.forRoot({\n plugins: [\n new ClsPluginTransactional({\n imports: [\n // module in which the PrismaClient is provided\n PrismaModule\n ],\n adapter: new TransactionalAdapterPrisma({\n // the injection token of the PrismaClient\n prismaInjectionToken: PrismaService,\n }),\n }),\n ],\n}),\n"})}),"\n",(0,a.jsx)(n.admonition,{type:"important",children:(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"prismaInjectionToken"})," is the token under which an instance of ",(0,a.jsx)(n.code,{children:"PrismaClient"})," provided. Usually, in Nest, this the custom ",(0,a.jsx)(n.code,{children:"PrismaService"})," class which ",(0,a.jsx)(n.code,{children:"extends PrismaClient"})," and is exported from a custom module."]})}),"\n",(0,a.jsx)(n.h2,{id:"typing--usage",children:"Typing & usage"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"tx"})," property on the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," refers to the transactional ",(0,a.jsx)(n.code,{children:"PrismaClient"})," instance when used in a transactional context. It is the instance that is passed to the ",(0,a.jsx)(n.code,{children:"prisma.$transaction(( tx ) => { ... })"})," callback."]}),"\n",(0,a.jsxs)(n.p,{children:["Outside of a transactional context, it refers to the regular ",(0,a.jsx)(n.code,{children:"PrismaClient"})," instance (but is typed as the transactional one)."]}),"\n",(0,a.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="user.service.ts"',children:"@Injectable()\nclass UserService {\n constructor(private readonly userRepository: UserRepository) {}\n\n @Transactional()\n async runTransaction() {\n // highlight-start\n // both methods are executed in the same transaction\n const user = await this.userRepository.createUser('John');\n const foundUser = await this.userRepository.getUserById(r1.id);\n // highlight-end\n assert(foundUser.id === user.id);\n }\n}\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="user.repository.ts"',children:"@Injectable()\nclass UserRepository {\n constructor(\n private readonly txHost: TransactionHost,\n ) {}\n\n async getUserById(id: number) {\n // highlight-start\n // txHost.tx is typed as the transactional PrismaClient\n return this.txHost.tx.user.findUnique({ where: { id } });\n // highlight-end\n }\n\n async createUser(name: string) {\n return this.txHost.tx.user.create({\n data: { name: name, email: `${name}@email.com` },\n });\n }\n}\n"})}),"\n",(0,a.jsx)(n.h2,{id:"custom-client-type",children:"Custom client type"}),"\n",(0,a.jsxs)("small",{children:["Since ",(0,a.jsx)(n.code,{children:"1.1.0"})]}),"\n",(0,a.jsxs)(n.p,{children:["By default, the adapter assumes that the Prisma client is available as ",(0,a.jsx)(n.code,{children:"@prisma/client"}),". If you have a different setup, or you use some Prisma client ",(0,a.jsx)(n.em,{children:"extensions"}),", you can provide a custom type for the client as a generic parameter of the adapter."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"TransactionalAdapterPrisma;\n"})}),"\n",(0,a.jsxs)(n.p,{children:["This type will need to be used whenever you inject the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," or ",(0,a.jsx)(n.code,{children:"Transaction"})]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"private readonly txHost: TransactionHost>\n"})}),"\n",(0,a.jsx)(n.p,{children:"Which becomes pretty verbose, so it's recommended to create a custom type alias for the adapter."}),"\n",(0,a.jsxs)(n.admonition,{type:"important",children:[(0,a.jsxs)(n.p,{children:["Please make sure you set up the module with the ",(0,a.jsx)(n.em,{children:"custom"})," prisma client and not the default one,\notherwise you would get a runtime error."]}),(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"new ClsPluginTransactional({\n imports: [\n // module in which the PrismaClient is provided\n PrismaModule\n ],\n adapter: new TransactionalAdapterPrisma({\n // the injection token of the PrismaClient\n // highlight-start\n prismaInjectionToken: CUSTOM_PRISMA_CLIENT_TOKEN,\n // highlight-end\n }),\n}),\n"})})]})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},1670:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>i});var a=t(7378);const s={},r=a.createContext(s);function i(e){const n=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2d4cceda.d3e58082.js b/assets/js/2d4cceda.d3e58082.js deleted file mode 100644 index befca4e..0000000 --- a/assets/js/2d4cceda.d3e58082.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunknestjs_cls_docs=self.webpackChunknestjs_cls_docs||[]).push([[285],{2599:(e,n,t)=>{t.d(n,{Z:()=>i});t(7378);var a=t(624);const r={tabItem:"tabItem_wHwb"};var s=t(4246);function i(e){let{children:n,hidden:t,className:i}=e;return(0,s.jsx)("div",{role:"tabpanel",className:(0,a.Z)(r.tabItem,i),hidden:t,children:n})}},8447:(e,n,t)=>{t.d(n,{Z:()=>w});var a=t(7378),r=t(624),s=t(9169),i=t(3620),l=t(9749),o=t(8981),c=t(56),u=t(8796);function d(e){return a.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function p(e){const{values:n,children:t}=e;return(0,a.useMemo)((()=>{const e=n??function(e){return d(e).map((e=>{let{props:{value:n,label:t,attributes:a,default:r}}=e;return{value:n,label:t,attributes:a,default:r}}))}(t);return function(e){const n=(0,c.l)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[n,t])}function h(e){let{value:n,tabValues:t}=e;return t.some((e=>e.value===n))}function m(e){let{queryString:n=!1,groupId:t}=e;const r=(0,i.k6)(),s=function(e){let{queryString:n=!1,groupId:t}=e;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!t)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return t??null}({queryString:n,groupId:t});return[(0,o._X)(s),(0,a.useCallback)((e=>{if(!s)return;const n=new URLSearchParams(r.location.search);n.set(s,e),r.replace({...r.location,search:n.toString()})}),[s,r])]}function g(e){const{defaultValue:n,queryString:t=!1,groupId:r}=e,s=p(e),[i,o]=(0,a.useState)((()=>function(e){let{defaultValue:n,tabValues:t}=e;if(0===t.length)throw new Error("Docusaurus error: the component requires at least one children component");if(n){if(!h({value:n,tabValues:t}))throw new Error(`Docusaurus error: The has a defaultValue "${n}" but none of its children has the corresponding value. Available values are: ${t.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return n}const a=t.find((e=>e.default))??t[0];if(!a)throw new Error("Unexpected error: 0 tabValues");return a.value}({defaultValue:n,tabValues:s}))),[c,d]=m({queryString:t,groupId:r}),[g,b]=function(e){let{groupId:n}=e;const t=function(e){return e?`docusaurus.tab.${e}`:null}(n),[r,s]=(0,u.Nk)(t);return[r,(0,a.useCallback)((e=>{t&&s.set(e)}),[t,s])]}({groupId:r}),f=(()=>{const e=c??g;return h({value:e,tabValues:s})?e:null})();(0,l.Z)((()=>{f&&o(f)}),[f]);return{selectedValue:i,selectValue:(0,a.useCallback)((e=>{if(!h({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);o(e),d(e),b(e)}),[d,b,s]),tabValues:s}}var b=t(362);const f={tabList:"tabList_J5MA",tabItem:"tabItem_l0OV"};var v=t(4246);function x(e){let{className:n,block:t,selectedValue:a,selectValue:i,tabValues:l}=e;const o=[],{blockElementScrollPositionUntilNextRender:c}=(0,s.o5)(),u=e=>{const n=e.currentTarget,t=o.indexOf(n),r=l[t].value;r!==a&&(c(n),i(r))},d=e=>{let n=null;switch(e.key){case"Enter":u(e);break;case"ArrowRight":{const t=o.indexOf(e.currentTarget)+1;n=o[t]??o[0];break}case"ArrowLeft":{const t=o.indexOf(e.currentTarget)-1;n=o[t]??o[o.length-1];break}}n?.focus()};return(0,v.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,r.Z)("tabs",{"tabs--block":t},n),children:l.map((e=>{let{value:n,label:t,attributes:s}=e;return(0,v.jsx)("li",{role:"tab",tabIndex:a===n?0:-1,"aria-selected":a===n,ref:e=>o.push(e),onKeyDown:d,onClick:u,...s,className:(0,r.Z)("tabs__item",f.tabItem,s?.className,{"tabs__item--active":a===n}),children:t??n},n)}))})}function j(e){let{lazy:n,children:t,selectedValue:r}=e;const s=(Array.isArray(t)?t:[t]).filter(Boolean);if(n){const e=s.find((e=>e.props.value===r));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return(0,v.jsx)("div",{className:"margin-top--md",children:s.map(((e,n)=>(0,a.cloneElement)(e,{key:n,hidden:e.props.value!==r})))})}function y(e){const n=g(e);return(0,v.jsxs)("div",{className:(0,r.Z)("tabs-container",f.tabList),children:[(0,v.jsx)(x,{...e,...n}),(0,v.jsx)(j,{...e,...n})]})}function w(e){const n=(0,b.Z)();return(0,v.jsx)(y,{...e,children:d(e.children)},String(n))}},2822:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>u,contentTitle:()=>o,default:()=>h,frontMatter:()=>l,metadata:()=>c,toc:()=>d});var a=t(4246),r=t(1670),s=t(8447),i=t(2599);const l={},o="Prisma adapter",c={id:"plugins/available-plugins/transactional/prisma-adapter",title:"Prisma adapter",description:"Installation",source:"@site/docs/06_plugins/01_available-plugins/01-transactional/01-prisma-adapter.md",sourceDirName:"06_plugins/01_available-plugins/01-transactional",slug:"/plugins/available-plugins/transactional/prisma-adapter",permalink:"/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter",draft:!1,unlisted:!1,editUrl:"https://github.com/Papooch/nestjs-cls/tree/main/docs/docs/06_plugins/01_available-plugins/01-transactional/01-prisma-adapter.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{},sidebar:"documentationSidebar",previous:{title:"@nestjs-cls/transactional",permalink:"/nestjs-cls/plugins/available-plugins/transactional/"},next:{title:"Knex adapter",permalink:"/nestjs-cls/plugins/available-plugins/transactional/knex-adapter"}},u={},d=[{value:"Installation",id:"installation",level:2},{value:"Registration",id:"registration",level:2},{value:"Typing & usage",id:"typing--usage",level:2},{value:"Example",id:"example",level:2},{value:"Caveats",id:"caveats",level:2}];function p(e){const n={admonition:"admonition",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"prisma-adapter",children:"Prisma adapter"}),"\n",(0,a.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,a.jsxs)(s.Z,{children:[(0,a.jsx)(i.Z,{value:"npm",label:"npm",default:!0,children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"npm install @nestjs-cls/transactional-adapter-prisma\n"})})}),(0,a.jsx)(i.Z,{value:"yarn",label:"yarn",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"yarn add @nestjs-cls/transactional-adapter-prisma\n"})})}),(0,a.jsx)(i.Z,{value:"pnpm",label:"pnpm",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"pnpm add @nestjs-cls/transactional-adapter-prisma\n"})})})]}),"\n",(0,a.jsx)(n.h2,{id:"registration",children:"Registration"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"ClsModule.forRoot({\n plugins: [\n new ClsPluginTransactional({\n imports: [\n // module in which the PrismaClient is provided\n PrismaModule\n ],\n adapter: new TransactionalAdapterPrisma({\n // the injection token of the PrismaClient\n prismaInjectionToken: PrismaService,\n }),\n }),\n ],\n}),\n"})}),"\n",(0,a.jsx)(n.admonition,{type:"important",children:(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"prismaInjectionToken"})," is the token under which an instance of ",(0,a.jsx)(n.code,{children:"PrismaClient"})," provided. Usually, in Nest, this the custom ",(0,a.jsx)(n.code,{children:"PrismaService"})," class which ",(0,a.jsx)(n.code,{children:"extends PrismaClient"})," and is exported from a custom module."]})}),"\n",(0,a.jsx)(n.h2,{id:"typing--usage",children:"Typing & usage"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"tx"})," property on the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," refers to the transactional ",(0,a.jsx)(n.code,{children:"PrismaClient"})," instance when used in a transactional context. It is the instance that is passed to the ",(0,a.jsx)(n.code,{children:"prisma.$transaction(( tx ) => { ... })"})," callback."]}),"\n",(0,a.jsxs)(n.p,{children:["Outside of a transactional context, it refers to the regular ",(0,a.jsx)(n.code,{children:"PrismaClient"})," instance (but is typed as the transactional one)."]}),"\n",(0,a.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="user.service.ts"',children:"@Injectable()\nclass UserService {\n constructor(private readonly userRepository: UserRepository) {}\n\n @Transactional()\n async runTransaction() {\n // highlight-start\n // both methods are executed in the same transaction\n const user = await this.userRepository.createUser('John');\n const foundUser = await this.userRepository.getUserById(r1.id);\n // highlight-end\n assert(foundUser.id === user.id);\n }\n}\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="user.repository.ts"',children:"@Injectable()\nclass UserRepository {\n constructor(\n private readonly txHost: TransactionHost,\n ) {}\n\n async getUserById(id: number) {\n // highlight-start\n // txHost.tx is typed as the transactional PrismaClient\n return this.txHost.tx.user.findUnique({ where: { id } });\n // highlight-end\n }\n\n async createUser(name: string) {\n return this.txHost.tx.user.create({\n data: { name: name, email: `${name}@email.com` },\n });\n }\n}\n"})}),"\n",(0,a.jsx)(n.h2,{id:"caveats",children:"Caveats"}),"\n",(0,a.jsxs)(n.p,{children:["Since Prisma generates its own client to ",(0,a.jsx)(n.code,{children:"node_modules"}),", this plugin works with the assumption that the types for the client are available as ",(0,a.jsx)(n.code,{children:"@prisma/client"}),". If you have a different setup, you might need to use ",(0,a.jsx)(n.code,{children:"declare module '@prisma/client'"})," to make typescript happy."]})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},1670:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>i});var a=t(7378);const r={},s=a.createContext(r);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/739a1e5f.06dcb2e4.js b/assets/js/739a1e5f.5aa79772.js similarity index 53% rename from assets/js/739a1e5f.06dcb2e4.js rename to assets/js/739a1e5f.5aa79772.js index 71c5ac8..4ecceb0 100644 --- a/assets/js/739a1e5f.06dcb2e4.js +++ b/assets/js/739a1e5f.5aa79772.js @@ -1 +1 @@ -"use strict";(self.webpackChunknestjs_cls_docs=self.webpackChunknestjs_cls_docs||[]).push([[180],{2599:(e,n,t)=>{t.d(n,{Z:()=>i});t(7378);var a=t(624);const s={tabItem:"tabItem_wHwb"};var r=t(4246);function i(e){let{children:n,hidden:t,className:i}=e;return(0,r.jsx)("div",{role:"tabpanel",className:(0,a.Z)(s.tabItem,i),hidden:t,children:n})}},8447:(e,n,t)=>{t.d(n,{Z:()=>w});var a=t(7378),s=t(624),r=t(9169),i=t(3620),c=t(9749),o=t(8981),l=t(56),d=t(8796);function h(e){return a.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function u(e){const{values:n,children:t}=e;return(0,a.useMemo)((()=>{const e=n??function(e){return h(e).map((e=>{let{props:{value:n,label:t,attributes:a,default:s}}=e;return{value:n,label:t,attributes:a,default:s}}))}(t);return function(e){const n=(0,l.l)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[n,t])}function p(e){let{value:n,tabValues:t}=e;return t.some((e=>e.value===n))}function x(e){let{queryString:n=!1,groupId:t}=e;const s=(0,i.k6)(),r=function(e){let{queryString:n=!1,groupId:t}=e;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!t)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return t??null}({queryString:n,groupId:t});return[(0,o._X)(r),(0,a.useCallback)((e=>{if(!r)return;const n=new URLSearchParams(s.location.search);n.set(r,e),s.replace({...s.location,search:n.toString()})}),[r,s])]}function j(e){const{defaultValue:n,queryString:t=!1,groupId:s}=e,r=u(e),[i,o]=(0,a.useState)((()=>function(e){let{defaultValue:n,tabValues:t}=e;if(0===t.length)throw new Error("Docusaurus error: the component requires at least one children component");if(n){if(!p({value:n,tabValues:t}))throw new Error(`Docusaurus error: The has a defaultValue "${n}" but none of its children has the corresponding value. Available values are: ${t.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return n}const a=t.find((e=>e.default))??t[0];if(!a)throw new Error("Unexpected error: 0 tabValues");return a.value}({defaultValue:n,tabValues:r}))),[l,h]=x({queryString:t,groupId:s}),[j,m]=function(e){let{groupId:n}=e;const t=function(e){return e?`docusaurus.tab.${e}`:null}(n),[s,r]=(0,d.Nk)(t);return[s,(0,a.useCallback)((e=>{t&&r.set(e)}),[t,r])]}({groupId:s}),g=(()=>{const e=l??j;return p({value:e,tabValues:r})?e:null})();(0,c.Z)((()=>{g&&o(g)}),[g]);return{selectedValue:i,selectValue:(0,a.useCallback)((e=>{if(!p({value:e,tabValues:r}))throw new Error(`Can't select invalid tab value=${e}`);o(e),h(e),m(e)}),[h,m,r]),tabValues:r}}var m=t(362);const g={tabList:"tabList_J5MA",tabItem:"tabItem_l0OV"};var f=t(4246);function b(e){let{className:n,block:t,selectedValue:a,selectValue:i,tabValues:c}=e;const o=[],{blockElementScrollPositionUntilNextRender:l}=(0,r.o5)(),d=e=>{const n=e.currentTarget,t=o.indexOf(n),s=c[t].value;s!==a&&(l(n),i(s))},h=e=>{let n=null;switch(e.key){case"Enter":d(e);break;case"ArrowRight":{const t=o.indexOf(e.currentTarget)+1;n=o[t]??o[0];break}case"ArrowLeft":{const t=o.indexOf(e.currentTarget)-1;n=o[t]??o[o.length-1];break}}n?.focus()};return(0,f.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,s.Z)("tabs",{"tabs--block":t},n),children:c.map((e=>{let{value:n,label:t,attributes:r}=e;return(0,f.jsx)("li",{role:"tab",tabIndex:a===n?0:-1,"aria-selected":a===n,ref:e=>o.push(e),onKeyDown:h,onClick:d,...r,className:(0,s.Z)("tabs__item",g.tabItem,r?.className,{"tabs__item--active":a===n}),children:t??n},n)}))})}function v(e){let{lazy:n,children:t,selectedValue:s}=e;const r=(Array.isArray(t)?t:[t]).filter(Boolean);if(n){const e=r.find((e=>e.props.value===s));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return(0,f.jsx)("div",{className:"margin-top--md",children:r.map(((e,n)=>(0,a.cloneElement)(e,{key:n,hidden:e.props.value!==s})))})}function T(e){const n=j(e);return(0,f.jsxs)("div",{className:(0,s.Z)("tabs-container",g.tabList),children:[(0,f.jsx)(b,{...e,...n}),(0,f.jsx)(v,{...e,...n})]})}function w(e){const n=(0,m.Z)();return(0,f.jsx)(T,{...e,children:h(e.children)},String(n))}},7518:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>l,toc:()=>h});var a=t(4246),s=t(1670),r=t(8447),i=t(2599);const c={},o="@nestjs-cls/transactional",l={id:"plugins/available-plugins/transactional/index",title:"@nestjs-cls/transactional",description:"The Transactional plugin for nestjs-cls provides a generic interface that can be used to wrap any function call in",source:"@site/docs/06_plugins/01_available-plugins/01-transactional/index.md",sourceDirName:"06_plugins/01_available-plugins/01-transactional",slug:"/plugins/available-plugins/transactional/",permalink:"/nestjs-cls/plugins/available-plugins/transactional/",draft:!1,unlisted:!1,editUrl:"https://github.com/Papooch/nestjs-cls/tree/main/docs/docs/06_plugins/01_available-plugins/01-transactional/index.md",tags:[],version:"current",frontMatter:{},sidebar:"documentationSidebar",previous:{title:"Available Plugins",permalink:"/nestjs-cls/plugins/available-plugins/"},next:{title:"Prisma adapter",permalink:"/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter"}},d={},h=[{value:"Installation",id:"installation",level:2},{value:"Example",id:"example",level:2},{value:"Plugin registration",id:"plugin-registration",level:3},{value:"Using the TransactionHost",id:"using-the-transactionhost",level:3},{value:"Using the @Transactional decorator",id:"using-the-transactional-decorator",level:3},{value:"Using the @InjectTransaction decorator",id:"using-the-injecttransaction-decorator",level:3},{value:"Passing transaction options",id:"passing-transaction-options",level:3},{value:"Transaction propagation",id:"transaction-propagation",level:3},{value:"ClsPluginTransactional Interface",id:"clsplugintransactional-interface",level:2},{value:"TransactionHost Interface",id:"transactionhost-interface",level:2},{value:"Transactional decorator interface",id:"transactional-decorator-interface",level:3},{value:"Multiple databases",id:"multiple-databases",level:2},{value:"Registration",id:"registration",level:3},{value:"Usage",id:"usage",level:3}];function u(e){const n={a:"a",admonition:"admonition",br:"br",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"nestjs-clstransactional",children:"@nestjs-cls/transactional"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.em,{children:"Transactional"})," plugin for ",(0,a.jsx)(n.code,{children:"nestjs-cls"})," provides a generic interface that can be used to wrap any function call in\na CLS-enabled transaction by storing the transaction reference in the CLS context."]}),"\n",(0,a.jsx)(n.p,{children:"The transaction reference can be then retrieved in any other service and refer to the same transaction without having to pass it around."}),"\n",(0,a.jsxs)(n.p,{children:["The plugin is designed to be database-agnostic and can be used with any database library that supports transactions (via adapters). At the expense of using a ",(0,a.jsx)(n.a,{href:"#using-the-transactionhost",children:"minimal wrapper"}),", it deliberately ",(0,a.jsx)(n.strong,{children:"does not require any monkey-patching"})," of the underlying library."]}),"\n",(0,a.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,a.jsxs)(r.Z,{children:[(0,a.jsx)(i.Z,{value:"npm",label:"npm",default:!0,children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"npm install @nestjs-cls/transactional\n"})})}),(0,a.jsx)(i.Z,{value:"yarn",label:"yarn",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"yarn add @nestjs-cls/transactional\n"})})}),(0,a.jsx)(i.Z,{value:"pnpm",label:"pnpm",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"pnpm add @nestjs-cls/transactional\n"})})})]}),"\n",(0,a.jsx)(n.p,{children:"The plugin works in conjunction with various adapters that provide the actual transactional logic and types for the underlying database library, so you'll need to install one of those as well."}),"\n",(0,a.jsx)(n.p,{children:"Adapters for the following libraries are available:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["Prisma (see ",(0,a.jsx)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter",children:"@nestjs-cls/transactional-adapter-prisma"}),")"]}),"\n",(0,a.jsxs)(n.li,{children:["Knex (see ",(0,a.jsx)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/knex-adapter",children:"@nestjs-cls/transactional-adapter-knex"}),")"]}),"\n",(0,a.jsxs)(n.li,{children:["Kysely (see ",(0,a.jsx)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/kysely-adapter",children:"@nestjs-cls/transactional-adapter-knex"}),")"]}),"\n",(0,a.jsxs)(n.li,{children:["Pg-promise (see ",(0,a.jsx)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/pg-promise-adapter",children:"@nestjs-cls/transactional-adapter-pg-promise"}),")"]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["Adapters ",(0,a.jsx)(n.em,{children:"will not"})," be implemented for the following libraries:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["TypeORM (since a more fully-featured ",(0,a.jsx)(n.a,{href:"https://github.com/Aliheym/typeorm-transactional",children:"community package already exists"}),")"]}),"\n",(0,a.jsxs)(n.li,{children:["Sequelize (since it already includes a ",(0,a.jsx)(n.a,{href:"https://sequelize.org/docs/v6/other-topics/transactions/#automatically-pass-transactions-to-all-queries",children:"built-in CLS-enabled transaction support"}),")"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,a.jsxs)(n.p,{children:["For this example, we'll use the ",(0,a.jsx)(n.code,{children:"prisma"})," library and the ",(0,a.jsxs)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter",children:[(0,a.jsx)(n.code,{children:"@nestjs-cls/transactional-adapter-prisma"})," adapter"]}),". Later, you'll learn how to ",(0,a.jsx)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/creating-custom-adapter",children:"create your own adapter"}),"."]}),"\n",(0,a.jsxs)(n.p,{children:["Suppose we already have a ",(0,a.jsx)(n.code,{children:"PrismaModule"})," which provides a ",(0,a.jsx)(n.code,{children:"PrismaClient"})," instance and two other services ",(0,a.jsx)(n.code,{children:"UserService"})," and ",(0,a.jsx)(n.code,{children:"AccountService"})," which we'd like to make transactional."]}),"\n",(0,a.jsx)(n.h3,{id:"plugin-registration",children:"Plugin registration"}),"\n",(0,a.jsxs)(n.p,{children:["To add register the transactional plugin with ",(0,a.jsx)(n.code,{children:"nestjs-cls"}),", we need to pass it to the ",(0,a.jsx)(n.code,{children:"forRoot"})," method of the ",(0,a.jsx)(n.code,{children:"ClsModule"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="app.module.ts"',children:"import { ClsModule } from 'nestjs-cls';\nimport { ClsPluginTransactional } from '@nestjs-cls/transactional';\nimport { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';\n// ... other imports\n\n@Module({\n imports: [\n PrismaModule,\n ClsModule.forRoot({\n plugins: [\n // highlight-start\n new ClsPluginTransactional({\n // if PrismaModule is not global, we need to make it available to the plugin\n imports: [PrismaModule],\n adapter: new TransactionalAdapterPrisma({\n // each adapter has its own options, see the adapter docs for more info\n prismaInjectionToken: PrismaClient,\n }),\n }),\n // highlight-end\n ],\n }),\n ],\n providers: [UserService, AccountService],\n})\nexport class AppModule {}\n"})}),"\n",(0,a.jsxs)(n.p,{children:["This registers a ",(0,a.jsx)(n.code,{children:"TransactionHost"})," provider in the global context which can be used to start a new transaction and retrieve the current transaction reference."]}),"\n",(0,a.jsxs)(n.h3,{id:"using-the-transactionhost",children:["Using the ",(0,a.jsx)(n.code,{children:"TransactionHost"})]}),"\n",(0,a.jsxs)(n.p,{children:["Now that we have the plugin registered, we can use the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," to start a new transaction and retrieve the current transaction reference."]}),"\n",(0,a.jsxs)(n.p,{children:["Suppose that any time we create an ",(0,a.jsx)(n.code,{children:"User"}),", we want to create an ",(0,a.jsx)(n.code,{children:"Account"})," for them as well and both operations must either succeed or fail. We can use the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," to start a new transaction and retrieve the current transaction reference."]}),"\n",(0,a.jsxs)(n.p,{children:["The type argument on the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," makes sure that the ",(0,a.jsx)(n.code,{children:"tx"})," property is typed correctly and the ",(0,a.jsx)(n.code,{children:"withTransaction"})," method returns the correct type. This is ensured by the implementation of the adapter:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="user.service.ts"',children:"import { TransactionHost } from '@nestjs-cls/transactional';\nimport { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';\n// ... other imports\n\n@Injectable()\nclass UserService {\n constructor(\n // highlight-start\n private readonly txHost: TransactionHost,\n // highlight-end\n private readonly accountService: AccountService,\n ) {}\n\n async createUser(name: string): Promise {\n return this.txHost.withTransaction(async () => {\n const user = await this.txHost.tx.user.create({ data: { name } });\n await this.accountService.createAccountForUser(user.id);\n return user;\n });\n }\n}\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="account.service.ts"',children:"import { TransactionHost } from '@nestjs-cls/transactional';\nimport { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';\n// ... other imports\n\n@Injectable()\nclass AccountService {\n constructor(\n private readonly txHost: TransactionHost,\n ) {}\n\n async createAccountForUser(id: number): Promise {\n return this.txHost.tx.user.create({\n data: { userId: id, number: Math.random() },\n });\n }\n}\n"})}),"\n",(0,a.jsx)(n.admonition,{type:"note",children:(0,a.jsxs)(n.p,{children:["Notice that we never used either raw ",(0,a.jsx)(n.code,{children:"PrismaClient"})," or the ",(0,a.jsx)(n.code,{children:"prisma.$transaction"})," directly. This is because the adapter takes care of that for us, otherwise the transaction would not be propagated in the CLS context."]})}),"\n",(0,a.jsxs)(n.h3,{id:"using-the-transactional-decorator",children:["Using the ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator"]}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator can be used to wrap a method call in the ",(0,a.jsx)(n.code,{children:"withTransaction"})," call implicitly. This saves a lot of boilerplate code and makes the code more readable."]}),"\n",(0,a.jsxs)(n.p,{children:["Using the decorator, we can change the ",(0,a.jsx)(n.code,{children:"createUser"})," method like so without changing the behavior:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="user.service.ts"',children:"import { TransactionHost, Transactional } from '@nestjs-cls/transactional';\nimport { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';\n// ... other imports\n\n@Injectable()\nclass UserService {\n constructor(\n private readonly txHost: TransactionHost,\n private readonly accountService: AccountService,\n ) {}\n\n @Transactional()\n async createUser(name: string): Promise {\n const user = await this.txHost.tx.user.create({ data: { name } });\n await this.accountService.createAccountForUser(user.id);\n return user;\n }\n}\n"})}),"\n",(0,a.jsxs)(n.h3,{id:"using-the-injecttransaction-decorator",children:["Using the ",(0,a.jsx)(n.code,{children:"@InjectTransaction"})," decorator"]}),"\n",(0,a.jsxs)("small",{children:["since ",(0,a.jsx)(n.code,{children:"v2.2.0"})]}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"@InjectTransaction"})," decorator can be used to inject a ",(0,a.jsx)(n.a,{href:"/nestjs-cls/features-and-use-cases/proxy-providers",children:"Proxy Provider"})," of the Transaction instance (the ",(0,a.jsx)(n.code,{children:"tx"})," property of the ",(0,a.jsx)(n.code,{children:"TransactionHost"}),") directly as a dependency."]}),"\n",(0,a.jsxs)(n.p,{children:["This is useful when you don't want to inject the entire ",(0,a.jsx)(n.code,{children:"TransactionHost"})," and only need the transaction instance itself. For example when you're migrating an existing codebase and don't want to change all database calls to use ",(0,a.jsx)(n.code,{children:"txHost.tx"}),"."]}),"\n",(0,a.jsxs)(n.p,{children:["The type argument of ",(0,a.jsx)(n.code,{children:"Transaction"})," behaves silimarly to the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," type argument, and ensures that the transaction instance is typed correctly."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="account.service.ts"',children:"import { InjectTransaction, Transaction, Transactional } from '@nestjs-cls/transactional';\nimport { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';\n// ... other imports\n\n@Injectable()\nclass AccountService {\n constructor(\n // highlight-start\n @InjectTransaction()\n private readonly tx: Transaction,\n // highlight-end\n ) {}\n\n async createAccountForUser(id: number): Promise {\n return this.txHost.tx.create({\n data: { userId: id, number: Math.random() },\n });\n }\n}\n"})}),"\n",(0,a.jsxs)(n.admonition,{type:"note",children:[(0,a.jsxs)(n.p,{children:["This feature must be explicitly enabled with the ",(0,a.jsx)(n.code,{children:"enableTransactionProxy: true"})," option of the ",(0,a.jsx)(n.code,{children:"ClsPluginTransactional"})," constructor."]}),(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"new ClsPluginTransactional({\n imports: [PrismaModule],\n adapter: new TransactionalAdapterPrisma({\n prismaInjectionToken: PrismaClient,\n }),\n // highlight-start\n enableTransactionProxy: true,\n // highlight-end\n}),\n"})})]}),"\n",(0,a.jsx)(n.h3,{id:"passing-transaction-options",children:"Passing transaction options"}),"\n",(0,a.jsxs)(n.p,{children:["The both the ",(0,a.jsx)(n.code,{children:"withTransaction"})," method and the ",(0,a.jsx)(n.code,{children:"Transactional"})," decorator accepts an optional ",(0,a.jsx)(n.code,{children:"TransactionOptions"})," object as the first argument. This object can be used to configure the transaction, for example to set the isolation level or the timeout."]}),"\n",(0,a.jsxs)(n.p,{children:["The type of the object is provided by the adapter, so to enforce the correct type, you need to pass the adapter type argument to the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," or to the ",(0,a.jsx)(n.code,{children:"Transactional"})," decorator."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"// highlight-start\n@Transactional({ isolationLevel: 'Serializable' })\n// highlight-end\nasync createUser(name: string): Promise {\n const user = await this.txHost.tx.user.create({ data: { name } });\n await this.accountService.createAccountForUser(user.id);\n return user;\n}\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"async createUser(name: string): Promise {\n // highlight-start\n return this.txHost.withTransaction({ isolationLevel: 'Serializable' }, async () => {\n // highlight-end\n const user = await this.txHost.tx.user.create({ data: { name } });\n await this.accountService.createAccountForUser(user.id);\n return user;\n });\n}\n"})}),"\n",(0,a.jsx)(n.h3,{id:"transaction-propagation",children:"Transaction propagation"}),"\n",(0,a.jsxs)(n.p,{children:["Similar to how the ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator work in ",(0,a.jsx)(n.a,{href:"https://www.baeldung.com/spring-transactional-propagation-isolation",children:"Spring"})," and other similar frameworks. The ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator and the ",(0,a.jsx)(n.code,{children:"withTransaction"})," method accept an optional ",(0,a.jsx)(n.code,{children:"propagation"})," option as the ",(0,a.jsx)(n.em,{children:"first parameter"})," which can be used to configure how the transaction should be propagated."]}),"\n",(0,a.jsxs)(n.p,{children:["The propagation option is controlled by the ",(0,a.jsx)(n.code,{children:"Propagation"})," enum, which has the following values:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"Required"})})}),":\n(",(0,a.jsx)(n.strong,{children:"default"}),") Reuse the existing transaction or create a new one if none exists."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"RequiresNew"})})}),":\nCreate a new transaction even if one already exists."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"NotSupported"})})}),":\nRun without a transaction even if one exists."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"Mandatory"})})}),":\nReuse an existing transaction, throw an exception otherwise"]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"Never"})})}),":\nThrow an exception if an existing transaction exists, otherwise create a new one"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["This parameter comes ",(0,a.jsx)(n.em,{children:"before"})," the ",(0,a.jsx)(n.code,{children:"TransactionOptions"})," object, if one is provided. The default behavior when a nested transaction decorator is encountered if no propagation option is provided, is to reuse the existing transaction or create a new one if none exists, which is the same as the ",(0,a.jsx)(n.code,{children:"Required"})," propagation option."]}),"\n",(0,a.jsx)(n.p,{children:"Example:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="user.service.ts"',children:"@Injectable()\nclass UserService {\n constructor(\n private readonly txHost: TransactionHost,\n private readonly accountService: AccountService,\n ) {}\n\n @Transactional(\n // highlight-start\n // Propagation.RequiresNew will always create a new transaction\n // even if one already exists.\n Propagation.RequiresNew,\n // highlight-end\n )\n async createUser(name: string): Promise {\n const user = await this.txHost.tx.user.create({ data: { name } });\n await this.accountService.createAccountForUser(user.id);\n return user;\n }\n}\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="account.service.ts"',children:"@Injectable()\nclass AccountService {\n constructor(\n private readonly txHost: TransactionHost,\n ) {}\n\n @Transactional(\n // highlight-start\n // Propagation.Mandatory enforces that an existing transaction is reused,\n // otherwise an exception is thrown.\n Propagation.Mandatory,\n // When a propagation option is provided,\n // the transaction options are passed as the second parameter.\n {\n isolationLevel: 'Serializable',\n },\n // highlight-end\n )\n async createAccountForUser(id: number): Promise {\n return this.txHost.tx.user.create({\n data: { userId: id, number: Math.random() },\n });\n }\n}\n"})}),"\n",(0,a.jsx)(n.h2,{id:"clsplugintransactional-interface",children:"ClsPluginTransactional Interface"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"ClsPluginTransactional"})," constructor takes an options object with the following properties:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"imports"})})}),(0,a.jsx)(n.code,{children:": any[]"}),(0,a.jsx)(n.br,{}),"\n","An array of NestJS modules that should be imported for the plugin to work. If the dependencies are available in the global context, this is not necessary."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"adapter"})})}),(0,a.jsx)(n.code,{children:": TransactionalAdapter"}),(0,a.jsx)(n.br,{}),"\n","An instance of the adapter that should be used for the plugin."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"enableTransactionProxy"})})}),(0,a.jsx)(n.code,{children:": boolean"})," (default: ",(0,a.jsx)(n.code,{children:"false"}),")",(0,a.jsx)(n.br,{}),"\n","Whether to enable injecting the Transaction instance directly using ",(0,a.jsx)(n.a,{href:"#using-the-injecttransaction-decorator",children:(0,a.jsx)(n.code,{children:"@InjectTransaction()"})})]}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"transactionhost-interface",children:"TransactionHost Interface"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"TransactionHost"})," interface is the main working interface of the plugin. It provides the following API:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"tx"})})}),(0,a.jsx)(n.code,{children:": Transaction"}),(0,a.jsx)(n.br,{}),"\n","Reference to the currently active transaction. Depending on the adapter implementation for the underlying database library, this can be either a transaction client instance, a transaction object or a transaction ID. If no transaction is active, refers to the default non-transactional client instance (or undefined transaction ID)."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"withTransaction"})})}),(0,a.jsx)(n.code,{children:"(callback: Promise): Promise"}),(0,a.jsx)(n.br,{}),"\n",(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"withTransaction"})})}),(0,a.jsx)(n.code,{children:"(options, callback): Promise"}),(0,a.jsx)(n.br,{}),"\n",(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"withTransaction"})})}),(0,a.jsx)(n.code,{children:"(propagation, callback): Promise"}),(0,a.jsx)(n.br,{}),"\n",(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"withTransaction"})})}),(0,a.jsx)(n.code,{children:"(propagation, options, callback): Promise"}),(0,a.jsx)(n.br,{}),"\n","Runs the callback in a transaction. Optionally takes ",(0,a.jsx)(n.code,{children:"Propagation"})," and ",(0,a.jsx)(n.code,{children:"TransactionOptions"})," as the first one or two parameters."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"withoutTransaction"})})}),(0,a.jsx)(n.code,{children:"(callback): Promise"}),(0,a.jsx)(n.br,{}),"\n","Runs the callback without a transaction (even if one is active in the parent scope)."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"isTransactionActive"})})}),(0,a.jsx)(n.code,{children:"(): boolean"}),(0,a.jsx)(n.br,{}),"\n","Returns whether a CLS-managed transaction is active in the current scope."]}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(n.h3,{id:"transactional-decorator-interface",children:"Transactional decorator interface"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator can be used to wrap a method call in the ",(0,a.jsx)(n.code,{children:"withTransaction"})," call implicitly. It has the following call signatures:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"@Transactional"})})}),(0,a.jsx)(n.code,{children:"()"})]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"@Transactional"})})}),(0,a.jsx)(n.code,{children:"(propagation)"})]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"@Transactional"})})}),(0,a.jsx)(n.code,{children:"(options)"})]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"@Transactional"})})}),(0,a.jsx)(n.code,{children:"(propagation, options)"})]}),"\n"]}),"\n",(0,a.jsx)(n.p,{children:"Or when using named connections:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"@Transactional"})})}),(0,a.jsx)(n.code,{children:"(connectionName, propagation?, options?)"})]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"multiple-databases",children:"Multiple databases"}),"\n",(0,a.jsxs)(n.p,{children:["Similar to other ",(0,a.jsx)(n.code,{children:"@nestjs/"})," libraries, the ",(0,a.jsx)(n.code,{children:"@nestjs-cls/transactional"})," plugin can be used to manage transactions for multiple database connections, or even multiple database libraries altogether."]}),"\n",(0,a.jsx)(n.h3,{id:"registration",children:"Registration"}),"\n",(0,a.jsxs)(n.p,{children:["To use multiple connections, register multiple instances of the ",(0,a.jsx)(n.code,{children:"ClsPluginTransactional"}),", each with an unique ",(0,a.jsx)(n.code,{children:"connectionName"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"ClsModule.forRoot({\n plugins: [\n new ClsPluginTransactional({\n // highlight-start\n connectionName: 'prisma-connection',\n // highlight-end\n imports: [PrismaModule],\n adapter: new TransactionalAdapterPrisma({\n prismaInjectionToken: PrismaClient,\n }),\n }),\n new ClsPluginTransactional({\n // highlight-start\n connectionName: 'knex-connection',\n // highlight-end\n imports: [KnexModule],\n adapter: new TransactionalAdapterKnex({\n knexInstanceToken: KNEX,\n }),\n }),\n ],\n}),\n"})}),"\n",(0,a.jsx)(n.p,{children:"This works for any number of connections and any number of database libraries."}),"\n",(0,a.jsx)(n.h3,{id:"usage",children:"Usage"}),"\n",(0,a.jsxs)(n.p,{children:["To use the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," for a specific connection, you ",(0,a.jsx)(n.em,{children:"need to"})," use ",(0,a.jsx)(n.code,{children:"@InjectTransactionHost('connectionName')"})," decorator to inject the ",(0,a.jsx)(n.code,{children:"TransactionHost"}),". Otherwise Nest will try to inject the default unnamed instance which will result in an injection error."]}),"\n",(0,a.jsxs)(n.p,{children:["Similarly, the ",(0,a.jsx)(n.code,{children:"@InjectTransaction"})," decorator accepts the connection name as the first argument."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"@Injectable()\nclass UserService {\n constructor(\n // highlight-start\n @InjectTransactionHost('prisma-connection')\n // highlight-end\n private readonly txHost: TransactionHost,\n // highlight-start\n @InjectTransaction('prisma-connection')\n // highlight-end\n private readonly tx: Transaction,\n ) {}\n\n // ...\n}\n"})}),"\n",(0,a.jsxs)(n.admonition,{type:"note",children:[(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"@InjectTransactionHost('connectionName')"})," is a short for ",(0,a.jsx)(n.code,{children:"@Inject(getTransactionHostToken('connectionName'))"}),". The ",(0,a.jsx)(n.code,{children:"getTransactionHostToken"})," function is useful for when you need to mock the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," in unit tests."]}),(0,a.jsxs)(n.p,{children:["Similarly, ",(0,a.jsx)(n.code,{children:"@InjectTransaction('connectionName')"})," is a short for ",(0,a.jsx)(n.code,{children:"@Inject(getTransactionToken('connectionName'))"}),"."]})]}),"\n",(0,a.jsxs)(n.p,{children:["In a similar fashion, using the ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator requires the ",(0,a.jsx)(n.code,{children:"connectionName"})," to be passed as the first argument."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"// highlight-start\n@Transactional('prisma-connection')\n// highlight-end\nasync createUser(name: string): Promise {\n await this.accountService.createAccountForUser(user.id);\n return user;\n}\n"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},1670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var a=t(7378);const s={},r=a.createContext(s);function i(e){const n=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunknestjs_cls_docs=self.webpackChunknestjs_cls_docs||[]).push([[180],{2599:(e,n,t)=>{t.d(n,{Z:()=>i});t(7378);var a=t(624);const s={tabItem:"tabItem_wHwb"};var r=t(4246);function i(e){let{children:n,hidden:t,className:i}=e;return(0,r.jsx)("div",{role:"tabpanel",className:(0,a.Z)(s.tabItem,i),hidden:t,children:n})}},8447:(e,n,t)=>{t.d(n,{Z:()=>w});var a=t(7378),s=t(624),r=t(9169),i=t(3620),c=t(9749),o=t(8981),l=t(56),d=t(8796);function h(e){return a.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function u(e){const{values:n,children:t}=e;return(0,a.useMemo)((()=>{const e=n??function(e){return h(e).map((e=>{let{props:{value:n,label:t,attributes:a,default:s}}=e;return{value:n,label:t,attributes:a,default:s}}))}(t);return function(e){const n=(0,l.l)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[n,t])}function p(e){let{value:n,tabValues:t}=e;return t.some((e=>e.value===n))}function x(e){let{queryString:n=!1,groupId:t}=e;const s=(0,i.k6)(),r=function(e){let{queryString:n=!1,groupId:t}=e;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!t)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return t??null}({queryString:n,groupId:t});return[(0,o._X)(r),(0,a.useCallback)((e=>{if(!r)return;const n=new URLSearchParams(s.location.search);n.set(r,e),s.replace({...s.location,search:n.toString()})}),[r,s])]}function j(e){const{defaultValue:n,queryString:t=!1,groupId:s}=e,r=u(e),[i,o]=(0,a.useState)((()=>function(e){let{defaultValue:n,tabValues:t}=e;if(0===t.length)throw new Error("Docusaurus error: the component requires at least one children component");if(n){if(!p({value:n,tabValues:t}))throw new Error(`Docusaurus error: The has a defaultValue "${n}" but none of its children has the corresponding value. Available values are: ${t.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return n}const a=t.find((e=>e.default))??t[0];if(!a)throw new Error("Unexpected error: 0 tabValues");return a.value}({defaultValue:n,tabValues:r}))),[l,h]=x({queryString:t,groupId:s}),[j,m]=function(e){let{groupId:n}=e;const t=function(e){return e?`docusaurus.tab.${e}`:null}(n),[s,r]=(0,d.Nk)(t);return[s,(0,a.useCallback)((e=>{t&&r.set(e)}),[t,r])]}({groupId:s}),g=(()=>{const e=l??j;return p({value:e,tabValues:r})?e:null})();(0,c.Z)((()=>{g&&o(g)}),[g]);return{selectedValue:i,selectValue:(0,a.useCallback)((e=>{if(!p({value:e,tabValues:r}))throw new Error(`Can't select invalid tab value=${e}`);o(e),h(e),m(e)}),[h,m,r]),tabValues:r}}var m=t(362);const g={tabList:"tabList_J5MA",tabItem:"tabItem_l0OV"};var f=t(4246);function b(e){let{className:n,block:t,selectedValue:a,selectValue:i,tabValues:c}=e;const o=[],{blockElementScrollPositionUntilNextRender:l}=(0,r.o5)(),d=e=>{const n=e.currentTarget,t=o.indexOf(n),s=c[t].value;s!==a&&(l(n),i(s))},h=e=>{let n=null;switch(e.key){case"Enter":d(e);break;case"ArrowRight":{const t=o.indexOf(e.currentTarget)+1;n=o[t]??o[0];break}case"ArrowLeft":{const t=o.indexOf(e.currentTarget)-1;n=o[t]??o[o.length-1];break}}n?.focus()};return(0,f.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,s.Z)("tabs",{"tabs--block":t},n),children:c.map((e=>{let{value:n,label:t,attributes:r}=e;return(0,f.jsx)("li",{role:"tab",tabIndex:a===n?0:-1,"aria-selected":a===n,ref:e=>o.push(e),onKeyDown:h,onClick:d,...r,className:(0,s.Z)("tabs__item",g.tabItem,r?.className,{"tabs__item--active":a===n}),children:t??n},n)}))})}function v(e){let{lazy:n,children:t,selectedValue:s}=e;const r=(Array.isArray(t)?t:[t]).filter(Boolean);if(n){const e=r.find((e=>e.props.value===s));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return(0,f.jsx)("div",{className:"margin-top--md",children:r.map(((e,n)=>(0,a.cloneElement)(e,{key:n,hidden:e.props.value!==s})))})}function T(e){const n=j(e);return(0,f.jsxs)("div",{className:(0,s.Z)("tabs-container",g.tabList),children:[(0,f.jsx)(b,{...e,...n}),(0,f.jsx)(v,{...e,...n})]})}function w(e){const n=(0,m.Z)();return(0,f.jsx)(T,{...e,children:h(e.children)},String(n))}},7518:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>o,default:()=>p,frontMatter:()=>c,metadata:()=>l,toc:()=>h});var a=t(4246),s=t(1670),r=t(8447),i=t(2599);const c={},o="@nestjs-cls/transactional",l={id:"plugins/available-plugins/transactional/index",title:"@nestjs-cls/transactional",description:"The Transactional plugin for nestjs-cls provides a generic interface that can be used to wrap any function call in",source:"@site/docs/06_plugins/01_available-plugins/01-transactional/index.md",sourceDirName:"06_plugins/01_available-plugins/01-transactional",slug:"/plugins/available-plugins/transactional/",permalink:"/nestjs-cls/plugins/available-plugins/transactional/",draft:!1,unlisted:!1,editUrl:"https://github.com/Papooch/nestjs-cls/tree/main/docs/docs/06_plugins/01_available-plugins/01-transactional/index.md",tags:[],version:"current",frontMatter:{},sidebar:"documentationSidebar",previous:{title:"Available Plugins",permalink:"/nestjs-cls/plugins/available-plugins/"},next:{title:"Prisma adapter",permalink:"/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter"}},d={},h=[{value:"Installation",id:"installation",level:2},{value:"Example",id:"example",level:2},{value:"Plugin registration",id:"plugin-registration",level:3},{value:"Using the TransactionHost",id:"using-the-transactionhost",level:3},{value:"Using the @Transactional decorator",id:"using-the-transactional-decorator",level:3},{value:"Using the @InjectTransaction decorator",id:"using-the-injecttransaction-decorator",level:3},{value:"Passing transaction options",id:"passing-transaction-options",level:3},{value:"Transaction propagation",id:"transaction-propagation",level:3},{value:"ClsPluginTransactional Interface",id:"clsplugintransactional-interface",level:2},{value:"TransactionHost Interface",id:"transactionhost-interface",level:2},{value:"Transactional decorator interface",id:"transactional-decorator-interface",level:3},{value:"Multiple databases",id:"multiple-databases",level:2},{value:"Registration",id:"registration",level:3},{value:"Usage",id:"usage",level:3}];function u(e){const n={a:"a",admonition:"admonition",br:"br",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"nestjs-clstransactional",children:"@nestjs-cls/transactional"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.em,{children:"Transactional"})," plugin for ",(0,a.jsx)(n.code,{children:"nestjs-cls"})," provides a generic interface that can be used to wrap any function call in\na CLS-enabled transaction by storing the transaction reference in the CLS context."]}),"\n",(0,a.jsx)(n.p,{children:"The transaction reference can be then retrieved in any other service and refer to the same transaction without having to pass it around."}),"\n",(0,a.jsxs)(n.p,{children:["The plugin is designed to be database-agnostic and can be used with any database library that supports transactions (via adapters). At the expense of using a ",(0,a.jsx)(n.a,{href:"#using-the-transactionhost",children:"minimal wrapper"}),", it deliberately ",(0,a.jsx)(n.strong,{children:"does not require any monkey-patching"})," of the underlying library."]}),"\n",(0,a.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,a.jsxs)(r.Z,{children:[(0,a.jsx)(i.Z,{value:"npm",label:"npm",default:!0,children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"npm install @nestjs-cls/transactional\n"})})}),(0,a.jsx)(i.Z,{value:"yarn",label:"yarn",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"yarn add @nestjs-cls/transactional\n"})})}),(0,a.jsx)(i.Z,{value:"pnpm",label:"pnpm",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"pnpm add @nestjs-cls/transactional\n"})})})]}),"\n",(0,a.jsx)(n.p,{children:"The plugin works in conjunction with various adapters that provide the actual transactional logic and types for the underlying database library, so you'll need to install one of those as well."}),"\n",(0,a.jsx)(n.p,{children:"Adapters for the following libraries are available:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["Prisma (see ",(0,a.jsx)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter",children:"@nestjs-cls/transactional-adapter-prisma"}),")"]}),"\n",(0,a.jsxs)(n.li,{children:["Knex (see ",(0,a.jsx)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/knex-adapter",children:"@nestjs-cls/transactional-adapter-knex"}),")"]}),"\n",(0,a.jsxs)(n.li,{children:["Kysely (see ",(0,a.jsx)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/kysely-adapter",children:"@nestjs-cls/transactional-adapter-knex"}),")"]}),"\n",(0,a.jsxs)(n.li,{children:["Pg-promise (see ",(0,a.jsx)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/pg-promise-adapter",children:"@nestjs-cls/transactional-adapter-pg-promise"}),")"]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["Adapters ",(0,a.jsx)(n.em,{children:"will not"})," be implemented for the following libraries:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["TypeORM (since a more fully-featured ",(0,a.jsx)(n.a,{href:"https://github.com/Aliheym/typeorm-transactional",children:"community package already exists"}),")"]}),"\n",(0,a.jsxs)(n.li,{children:["Sequelize (since it already includes a ",(0,a.jsx)(n.a,{href:"https://sequelize.org/docs/v6/other-topics/transactions/#automatically-pass-transactions-to-all-queries",children:"built-in CLS-enabled transaction support"}),")"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,a.jsxs)(n.p,{children:["For this example, we'll use the ",(0,a.jsx)(n.code,{children:"prisma"})," library and the ",(0,a.jsxs)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter",children:[(0,a.jsx)(n.code,{children:"@nestjs-cls/transactional-adapter-prisma"})," adapter"]}),". Later, you'll learn how to ",(0,a.jsx)(n.a,{href:"/nestjs-cls/plugins/available-plugins/transactional/creating-custom-adapter",children:"create your own adapter"}),"."]}),"\n",(0,a.jsxs)(n.p,{children:["Suppose we already have a ",(0,a.jsx)(n.code,{children:"PrismaModule"})," which provides a ",(0,a.jsx)(n.code,{children:"PrismaClient"})," instance and two other services ",(0,a.jsx)(n.code,{children:"UserService"})," and ",(0,a.jsx)(n.code,{children:"AccountService"})," which we'd like to make transactional."]}),"\n",(0,a.jsx)(n.h3,{id:"plugin-registration",children:"Plugin registration"}),"\n",(0,a.jsxs)(n.p,{children:["To add register the transactional plugin with ",(0,a.jsx)(n.code,{children:"nestjs-cls"}),", we need to pass it to the ",(0,a.jsx)(n.code,{children:"forRoot"})," method of the ",(0,a.jsx)(n.code,{children:"ClsModule"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="app.module.ts"',children:"import { ClsModule } from 'nestjs-cls';\nimport { ClsPluginTransactional } from '@nestjs-cls/transactional';\nimport { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';\n// ... other imports\n\n@Module({\n imports: [\n PrismaModule,\n ClsModule.forRoot({\n plugins: [\n // highlight-start\n new ClsPluginTransactional({\n // if PrismaModule is not global, we need to make it available to the plugin\n imports: [PrismaModule],\n adapter: new TransactionalAdapterPrisma({\n // each adapter has its own options, see the adapter docs for more info\n prismaInjectionToken: PrismaClient,\n }),\n }),\n // highlight-end\n ],\n }),\n ],\n providers: [UserService, AccountService],\n})\nexport class AppModule {}\n"})}),"\n",(0,a.jsxs)(n.p,{children:["This registers a ",(0,a.jsx)(n.code,{children:"TransactionHost"})," provider in the global context which can be used to start a new transaction and retrieve the current transaction reference."]}),"\n",(0,a.jsxs)(n.h3,{id:"using-the-transactionhost",children:["Using the ",(0,a.jsx)(n.code,{children:"TransactionHost"})]}),"\n",(0,a.jsxs)(n.p,{children:["Now that we have the plugin registered, we can use the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," to start a new transaction and retrieve the current transaction reference."]}),"\n",(0,a.jsxs)(n.p,{children:["Suppose that any time we create an ",(0,a.jsx)(n.code,{children:"User"}),", we want to create an ",(0,a.jsx)(n.code,{children:"Account"})," for them as well and both operations must either succeed or fail. We can use the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," to start a new transaction and retrieve the current transaction reference."]}),"\n",(0,a.jsxs)(n.p,{children:["The type argument on the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," makes sure that the ",(0,a.jsx)(n.code,{children:"tx"})," property is typed correctly and the ",(0,a.jsx)(n.code,{children:"withTransaction"})," method returns the correct type. This is ensured by the implementation of the adapter:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="user.service.ts"',children:"import { TransactionHost } from '@nestjs-cls/transactional';\nimport { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';\n// ... other imports\n\n@Injectable()\nclass UserService {\n constructor(\n // highlight-start\n private readonly txHost: TransactionHost,\n // highlight-end\n private readonly accountService: AccountService,\n ) {}\n\n async createUser(name: string): Promise {\n return this.txHost.withTransaction(async () => {\n const user = await this.txHost.tx.user.create({ data: { name } });\n await this.accountService.createAccountForUser(user.id);\n return user;\n });\n }\n}\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="account.service.ts"',children:"import { TransactionHost } from '@nestjs-cls/transactional';\nimport { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';\n// ... other imports\n\n@Injectable()\nclass AccountService {\n constructor(\n private readonly txHost: TransactionHost,\n ) {}\n\n async createAccountForUser(id: number): Promise {\n return this.txHost.tx.user.create({\n data: { userId: id, number: Math.random() },\n });\n }\n}\n"})}),"\n",(0,a.jsx)(n.admonition,{type:"note",children:(0,a.jsxs)(n.p,{children:["Notice that we never used either raw ",(0,a.jsx)(n.code,{children:"PrismaClient"})," or the ",(0,a.jsx)(n.code,{children:"prisma.$transaction"})," directly. This is because the adapter takes care of that for us, otherwise the transaction would not be propagated in the CLS context."]})}),"\n",(0,a.jsxs)(n.h3,{id:"using-the-transactional-decorator",children:["Using the ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator"]}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator can be used to wrap a method call in the ",(0,a.jsx)(n.code,{children:"withTransaction"})," call implicitly. This saves a lot of boilerplate code and makes the code more readable."]}),"\n",(0,a.jsxs)(n.p,{children:["Using the decorator, we can change the ",(0,a.jsx)(n.code,{children:"createUser"})," method like so without changing the behavior:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="user.service.ts"',children:"import { TransactionHost, Transactional } from '@nestjs-cls/transactional';\nimport { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';\n// ... other imports\n\n@Injectable()\nclass UserService {\n constructor(\n private readonly txHost: TransactionHost,\n private readonly accountService: AccountService,\n ) {}\n\n @Transactional()\n async createUser(name: string): Promise {\n const user = await this.txHost.tx.user.create({ data: { name } });\n await this.accountService.createAccountForUser(user.id);\n return user;\n }\n}\n"})}),"\n",(0,a.jsxs)(n.h3,{id:"using-the-injecttransaction-decorator",children:["Using the ",(0,a.jsx)(n.code,{children:"@InjectTransaction"})," decorator"]}),"\n",(0,a.jsxs)("small",{children:["since ",(0,a.jsx)(n.code,{children:"v2.2.0"})]}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"@InjectTransaction"})," decorator can be used to inject a ",(0,a.jsx)(n.a,{href:"/nestjs-cls/features-and-use-cases/proxy-providers",children:"Proxy Provider"})," of the Transaction instance (the ",(0,a.jsx)(n.code,{children:"tx"})," property of the ",(0,a.jsx)(n.code,{children:"TransactionHost"}),") directly as a dependency."]}),"\n",(0,a.jsxs)(n.p,{children:["This is useful when you don't want to inject the entire ",(0,a.jsx)(n.code,{children:"TransactionHost"})," and only need the transaction instance itself. For example when you're migrating an existing codebase and don't want to change all database calls to use ",(0,a.jsx)(n.code,{children:"txHost.tx"}),"."]}),"\n",(0,a.jsxs)(n.p,{children:["The type argument of ",(0,a.jsx)(n.code,{children:"Transaction"})," behaves silimarly to the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," type argument, and ensures that the transaction instance is typed correctly."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="account.service.ts"',children:"import { InjectTransaction, Transaction, Transactional } from '@nestjs-cls/transactional';\nimport { TransactionalAdapterPrisma } from '@nestjs-cls/transactional-adapter-prisma';\n// ... other imports\n\n@Injectable()\nclass AccountService {\n constructor(\n // highlight-start\n @InjectTransaction()\n private readonly tx: Transaction,\n // highlight-end\n ) {}\n\n async createAccountForUser(id: number): Promise {\n return this.txHost.tx.create({\n data: { userId: id, number: Math.random() },\n });\n }\n}\n"})}),"\n",(0,a.jsxs)(n.admonition,{type:"important",children:[(0,a.jsxs)(n.p,{children:["When a transaction is not active, the ",(0,a.jsx)(n.code,{children:"Transaction"})," instance refers to the default non-transactional instance. However, if the CLS context is ",(0,a.jsx)(n.em,{children:"not active"}),", the ",(0,a.jsx)(n.code,{children:"Transaction"})," instance will be ",(0,a.jsx)(n.code,{children:"undefined"})," instead, which could cause runtime errors."]}),(0,a.jsxs)(n.p,{children:["Therefore, this feature works reliably only when the CLS context is active ",(0,a.jsx)(n.em,{children:"prior to starting the transaction"}),", which should be the case in most cases, however, for that reason, this is an opt-in feature that must be explicitly enabled with the ",(0,a.jsx)(n.code,{children:"enableTransactionProxy: true"})," option of the ",(0,a.jsx)(n.code,{children:"ClsPluginTransactional"})," constructor."]}),(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"new ClsPluginTransactional({\n imports: [PrismaModule],\n adapter: new TransactionalAdapterPrisma({\n prismaInjectionToken: PrismaClient,\n }),\n // highlight-start\n enableTransactionProxy: true,\n // highlight-end\n}),\n"})})]}),"\n",(0,a.jsx)(n.h3,{id:"passing-transaction-options",children:"Passing transaction options"}),"\n",(0,a.jsxs)(n.p,{children:["The both the ",(0,a.jsx)(n.code,{children:"withTransaction"})," method and the ",(0,a.jsx)(n.code,{children:"Transactional"})," decorator accepts an optional ",(0,a.jsx)(n.code,{children:"TransactionOptions"})," object as the first argument. This object can be used to configure the transaction, for example to set the isolation level or the timeout."]}),"\n",(0,a.jsxs)(n.p,{children:["The type of the object is provided by the adapter, so to enforce the correct type, you need to pass the adapter type argument to the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," or to the ",(0,a.jsx)(n.code,{children:"Transactional"})," decorator."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"// highlight-start\n@Transactional({ isolationLevel: 'Serializable' })\n// highlight-end\nasync createUser(name: string): Promise {\n const user = await this.txHost.tx.user.create({ data: { name } });\n await this.accountService.createAccountForUser(user.id);\n return user;\n}\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"async createUser(name: string): Promise {\n // highlight-start\n return this.txHost.withTransaction({ isolationLevel: 'Serializable' }, async () => {\n // highlight-end\n const user = await this.txHost.tx.user.create({ data: { name } });\n await this.accountService.createAccountForUser(user.id);\n return user;\n });\n}\n"})}),"\n",(0,a.jsx)(n.h3,{id:"transaction-propagation",children:"Transaction propagation"}),"\n",(0,a.jsxs)(n.p,{children:["Similar to how the ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator work in ",(0,a.jsx)(n.a,{href:"https://www.baeldung.com/spring-transactional-propagation-isolation",children:"Spring"})," and other similar frameworks. The ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator and the ",(0,a.jsx)(n.code,{children:"withTransaction"})," method accept an optional ",(0,a.jsx)(n.code,{children:"propagation"})," option as the ",(0,a.jsx)(n.em,{children:"first parameter"})," which can be used to configure how the transaction should be propagated."]}),"\n",(0,a.jsxs)(n.p,{children:["The propagation option is controlled by the ",(0,a.jsx)(n.code,{children:"Propagation"})," enum, which has the following values:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"Required"})})}),":\n(",(0,a.jsx)(n.strong,{children:"default"}),") Reuse the existing transaction or create a new one if none exists."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"RequiresNew"})})}),":\nCreate a new transaction even if one already exists."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"NotSupported"})})}),":\nRun without a transaction even if one exists."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"Mandatory"})})}),":\nReuse an existing transaction, throw an exception otherwise"]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"Never"})})}),":\nThrow an exception if an existing transaction exists, otherwise create a new one"]}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["This parameter comes ",(0,a.jsx)(n.em,{children:"before"})," the ",(0,a.jsx)(n.code,{children:"TransactionOptions"})," object, if one is provided. The default behavior when a nested transaction decorator is encountered if no propagation option is provided, is to reuse the existing transaction or create a new one if none exists, which is the same as the ",(0,a.jsx)(n.code,{children:"Required"})," propagation option."]}),"\n",(0,a.jsx)(n.p,{children:"Example:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="user.service.ts"',children:"@Injectable()\nclass UserService {\n constructor(\n private readonly txHost: TransactionHost,\n private readonly accountService: AccountService,\n ) {}\n\n @Transactional(\n // highlight-start\n // Propagation.RequiresNew will always create a new transaction\n // even if one already exists.\n Propagation.RequiresNew,\n // highlight-end\n )\n async createUser(name: string): Promise {\n const user = await this.txHost.tx.user.create({ data: { name } });\n await this.accountService.createAccountForUser(user.id);\n return user;\n }\n}\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",metastring:'title="account.service.ts"',children:"@Injectable()\nclass AccountService {\n constructor(\n private readonly txHost: TransactionHost,\n ) {}\n\n @Transactional(\n // highlight-start\n // Propagation.Mandatory enforces that an existing transaction is reused,\n // otherwise an exception is thrown.\n Propagation.Mandatory,\n // When a propagation option is provided,\n // the transaction options are passed as the second parameter.\n {\n isolationLevel: 'Serializable',\n },\n // highlight-end\n )\n async createAccountForUser(id: number): Promise {\n return this.txHost.tx.user.create({\n data: { userId: id, number: Math.random() },\n });\n }\n}\n"})}),"\n",(0,a.jsx)(n.h2,{id:"clsplugintransactional-interface",children:"ClsPluginTransactional Interface"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"ClsPluginTransactional"})," constructor takes an options object with the following properties:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"imports"})})}),(0,a.jsx)(n.code,{children:": any[]"}),(0,a.jsx)(n.br,{}),"\n","An array of NestJS modules that should be imported for the plugin to work. If the dependencies are available in the global context, this is not necessary."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"adapter"})})}),(0,a.jsx)(n.code,{children:": TransactionalAdapter"}),(0,a.jsx)(n.br,{}),"\n","An instance of the adapter that should be used for the plugin."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"enableTransactionProxy"})})}),(0,a.jsx)(n.code,{children:": boolean"})," (default: ",(0,a.jsx)(n.code,{children:"false"}),")",(0,a.jsx)(n.br,{}),"\n","Whether to enable injecting the Transaction instance directly using ",(0,a.jsx)(n.a,{href:"#using-the-injecttransaction-decorator",children:(0,a.jsx)(n.code,{children:"@InjectTransaction()"})})]}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"transactionhost-interface",children:"TransactionHost Interface"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"TransactionHost"})," interface is the main working interface of the plugin. It provides the following API:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"tx"})})}),(0,a.jsx)(n.code,{children:": Transaction"}),(0,a.jsx)(n.br,{}),"\n","Reference to the currently active transaction. Depending on the adapter implementation for the underlying database library, this can be either a transaction client instance, a transaction object or a transaction ID. If no transaction is active, refers to the default non-transactional client instance (or undefined transaction ID)."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"withTransaction"})})}),(0,a.jsx)(n.code,{children:"(callback: Promise): Promise"}),(0,a.jsx)(n.br,{}),"\n",(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"withTransaction"})})}),(0,a.jsx)(n.code,{children:"(options, callback): Promise"}),(0,a.jsx)(n.br,{}),"\n",(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"withTransaction"})})}),(0,a.jsx)(n.code,{children:"(propagation, callback): Promise"}),(0,a.jsx)(n.br,{}),"\n",(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"withTransaction"})})}),(0,a.jsx)(n.code,{children:"(propagation, options, callback): Promise"}),(0,a.jsx)(n.br,{}),"\n","Runs the callback in a transaction. Optionally takes ",(0,a.jsx)(n.code,{children:"Propagation"})," and ",(0,a.jsx)(n.code,{children:"TransactionOptions"})," as the first one or two parameters."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"withoutTransaction"})})}),(0,a.jsx)(n.code,{children:"(callback): Promise"}),(0,a.jsx)(n.br,{}),"\n","Runs the callback without a transaction (even if one is active in the parent scope)."]}),"\n"]}),"\n",(0,a.jsxs)(n.li,{children:["\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"isTransactionActive"})})}),(0,a.jsx)(n.code,{children:"(): boolean"}),(0,a.jsx)(n.br,{}),"\n","Returns whether a CLS-managed transaction is active in the current scope."]}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(n.h3,{id:"transactional-decorator-interface",children:"Transactional decorator interface"}),"\n",(0,a.jsxs)(n.p,{children:["The ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator can be used to wrap a method call in the ",(0,a.jsx)(n.code,{children:"withTransaction"})," call implicitly. It has the following call signatures:"]}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"@Transactional"})})}),(0,a.jsx)(n.code,{children:"()"})]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"@Transactional"})})}),(0,a.jsx)(n.code,{children:"(propagation)"})]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"@Transactional"})})}),(0,a.jsx)(n.code,{children:"(options)"})]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"@Transactional"})})}),(0,a.jsx)(n.code,{children:"(propagation, options)"})]}),"\n"]}),"\n",(0,a.jsx)(n.p,{children:"Or when using named connections:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:(0,a.jsx)(n.em,{children:(0,a.jsx)(n.code,{children:"@Transactional"})})}),(0,a.jsx)(n.code,{children:"(connectionName, propagation?, options?)"})]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"multiple-databases",children:"Multiple databases"}),"\n",(0,a.jsxs)(n.p,{children:["Similar to other ",(0,a.jsx)(n.code,{children:"@nestjs/"})," libraries, the ",(0,a.jsx)(n.code,{children:"@nestjs-cls/transactional"})," plugin can be used to manage transactions for multiple database connections, or even multiple database libraries altogether."]}),"\n",(0,a.jsx)(n.h3,{id:"registration",children:"Registration"}),"\n",(0,a.jsxs)(n.p,{children:["To use multiple connections, register multiple instances of the ",(0,a.jsx)(n.code,{children:"ClsPluginTransactional"}),", each with an unique ",(0,a.jsx)(n.code,{children:"connectionName"}),":"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"ClsModule.forRoot({\n plugins: [\n new ClsPluginTransactional({\n // highlight-start\n connectionName: 'prisma-connection',\n // highlight-end\n imports: [PrismaModule],\n adapter: new TransactionalAdapterPrisma({\n prismaInjectionToken: PrismaClient,\n }),\n }),\n new ClsPluginTransactional({\n // highlight-start\n connectionName: 'knex-connection',\n // highlight-end\n imports: [KnexModule],\n adapter: new TransactionalAdapterKnex({\n knexInstanceToken: KNEX,\n }),\n }),\n ],\n}),\n"})}),"\n",(0,a.jsx)(n.p,{children:"This works for any number of connections and any number of database libraries."}),"\n",(0,a.jsx)(n.h3,{id:"usage",children:"Usage"}),"\n",(0,a.jsxs)(n.p,{children:["To use the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," for a specific connection, you ",(0,a.jsx)(n.em,{children:"need to"})," use ",(0,a.jsx)(n.code,{children:"@InjectTransactionHost('connectionName')"})," decorator to inject the ",(0,a.jsx)(n.code,{children:"TransactionHost"}),". Otherwise Nest will try to inject the default unnamed instance which will result in an injection error."]}),"\n",(0,a.jsxs)(n.p,{children:["Similarly, the ",(0,a.jsx)(n.code,{children:"@InjectTransaction"})," decorator accepts the connection name as the first argument."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"@Injectable()\nclass UserService {\n constructor(\n // highlight-start\n @InjectTransactionHost('prisma-connection')\n // highlight-end\n private readonly txHost: TransactionHost,\n // highlight-start\n @InjectTransaction('prisma-connection')\n // highlight-end\n private readonly tx: Transaction,\n ) {}\n\n // ...\n}\n"})}),"\n",(0,a.jsxs)(n.admonition,{type:"note",children:[(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"@InjectTransactionHost('connectionName')"})," is a short for ",(0,a.jsx)(n.code,{children:"@Inject(getTransactionHostToken('connectionName'))"}),". The ",(0,a.jsx)(n.code,{children:"getTransactionHostToken"})," function is useful for when you need to mock the ",(0,a.jsx)(n.code,{children:"TransactionHost"})," in unit tests."]}),(0,a.jsxs)(n.p,{children:["Similarly, ",(0,a.jsx)(n.code,{children:"@InjectTransaction('connectionName')"})," is a short for ",(0,a.jsx)(n.code,{children:"@Inject(getTransactionToken('connectionName'))"}),"."]})]}),"\n",(0,a.jsxs)(n.p,{children:["In a similar fashion, using the ",(0,a.jsx)(n.code,{children:"@Transactional"})," decorator requires the ",(0,a.jsx)(n.code,{children:"connectionName"})," to be passed as the first argument."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"// highlight-start\n@Transactional('prisma-connection')\n// highlight-end\nasync createUser(name: string): Promise {\n await this.accountService.createAccountForUser(user.id);\n return user;\n}\n"})})]})}function p(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},1670:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>i});var a=t(7378);const s={},r=a.createContext(s);function i(e){const n=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/main.99d546c9.js b/assets/js/main.165fda6b.js similarity index 99% rename from assets/js/main.99d546c9.js rename to assets/js/main.165fda6b.js index 54457e3..383aa3f 100644 --- a/assets/js/main.99d546c9.js +++ b/assets/js/main.165fda6b.js @@ -1,2 +1,2 @@ -/*! For license information please see main.99d546c9.js.LICENSE.txt */ -(self.webpackChunknestjs_cls_docs=self.webpackChunknestjs_cls_docs||[]).push([[179],{3512:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});n(7378);var r=n(1237),a=n.n(r),o=n(6887);const i={"075c86f0":[()=>n.e(506).then(n.bind(n,9658)),"@site/docs/10_migration-guide/01_v3x-v4x.md",9658],"15a3970d":[()=>Promise.all([n.e(532),n.e(769)]).then(n.bind(n,1950)),"@site/docs/06_plugins/01_available-plugins/01-transactional/04-pg-promise-adapter.md",1950],17896441:[()=>Promise.all([n.e(532),n.e(918)]).then(n.bind(n,8135)),"@theme/DocItem",8135],"18c15bff":[()=>n.e(399).then(n.bind(n,6752)),"@site/docs/02_setting-up-cls-context/05_using_cls_run.md",6752],"1cd7469c":[()=>n.e(665).then(n.t.bind(n,3769,19)),"/media/papooch/Storage/Ondra/Stuff/Projects/Node/nestjs-cls/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",3769],"2d4cceda":[()=>Promise.all([n.e(532),n.e(285)]).then(n.bind(n,2822)),"@site/docs/06_plugins/01_available-plugins/01-transactional/01-prisma-adapter.md",2822],"3ac8ff5d":[()=>n.e(332).then(n.bind(n,4760)),"@site/docs/01_introduction/03_how-it-works.md",4760],"3b39bba3":[()=>Promise.all([n.e(532),n.e(546)]).then(n.bind(n,7309)),"@site/docs/01_introduction/01_installation.md",7309],"4998a0a4":[()=>n.e(872).then(n.bind(n,5436)),"@site/docs/03_features-and-use-cases/05_type-safety-and-type-inference.md",5436],"4c9a797e":[()=>n.e(720).then(n.bind(n,5875)),"@site/docs/04_api/index.md",5875],"57c14adc":[()=>n.e(507).then(n.bind(n,3253)),"@site/docs/05_considerations/01_security.md",3253],"592cbe55":[()=>n.e(437).then(n.bind(n,652)),"@site/docs/03_features-and-use-cases/06_proxy-providers.md",652],"5e2b3edd":[()=>Promise.all([n.e(532),n.e(844)]).then(n.bind(n,3943)),"@site/docs/06_plugins/01_available-plugins/01-transactional/03-kysely-adapter.md",3943],"5e95c892":[()=>n.e(661).then(n.bind(n,32)),"@theme/DocsRoot",32],"6212613f":[()=>n.e(849).then(n.bind(n,2867)),"@site/docs/03_features-and-use-cases/02_additional-cls-setup.md",2867],"6bb5cc7f":[()=>n.e(499).then(n.bind(n,6035)),"@site/docs/03_features-and-use-cases/03_breaking-out-of-di.md",6035],"6fbaaecb":[()=>n.e(979).then(n.bind(n,726)),"@site/docs/10_migration-guide/index.md",726],"739a1e5f":[()=>Promise.all([n.e(532),n.e(180)]).then(n.bind(n,7518)),"@site/docs/06_plugins/01_available-plugins/01-transactional/index.md",7518],82070906:[()=>n.e(336).then(n.bind(n,2935)),"@site/docs/07_testing/index.md",2935],"86ea57e0":[()=>n.e(202).then(n.bind(n,5737)),"@site/docs/01_introduction/index.md",5737],"935f2afb":[()=>n.e(53).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],"94e5e920":[()=>n.e(575).then(n.bind(n,9257)),"@site/docs/05_considerations/index.md",9257],"97d55a5e":[()=>n.e(823).then(n.bind(n,6274)),"@site/docs/04_api/02_module-options.md",6274],a2c1fdb7:[()=>n.e(776).then(n.bind(n,5308)),"@site/docs/02_setting-up-cls-context/index.md",5308],a7bd4aaa:[()=>n.e(518).then(n.bind(n,2922)),"@theme/DocVersionRoot",2922],a886e75a:[()=>n.e(466).then(n.bind(n,877)),"@site/docs/06_plugins/01_available-plugins/01-transactional/10-creating-custom-adapter.md",877],a8d12efa:[()=>n.e(55).then(n.bind(n,9446)),"@site/docs/03_features-and-use-cases/04_usage-outside-of-web-request.md",9446],a94703ab:[()=>Promise.all([n.e(532),n.e(368)]).then(n.bind(n,552)),"@theme/DocRoot",552],ae4976f8:[()=>n.e(93).then(n.bind(n,5934)),"@site/docs/02_setting-up-cls-context/01_using-a-middleware.md",5934],b09df872:[()=>n.e(246).then(n.bind(n,8625)),"@site/docs/02_setting-up-cls-context/03_using-an-interceptor.md",8625],b67d68ed:[()=>n.e(241).then(n.bind(n,5575)),"@site/docs/06_plugins/02_plugin-api.md",5575],b787da23:[()=>n.e(126).then(n.bind(n,9622)),"@site/docs/05_considerations/02_compatibility.md",9622],baa2f4d8:[()=>n.e(423).then(n.bind(n,8711)),"@site/docs/10_migration-guide/02_v2x-v3x.md",8711],d459cca2:[()=>n.e(47).then(n.bind(n,2041)),"@site/docs/02_setting-up-cls-context/02_using-a-guard.md",2041],df604e10:[()=>n.e(775).then(n.bind(n,1763)),"@site/docs/04_api/01_service-interface.md",1763],e2112352:[()=>n.e(826).then(n.bind(n,1267)),"@site/docs/06_plugins/01_available-plugins/index.md",1267],e83b8e0a:[()=>n.e(446).then(n.bind(n,5834)),"@site/docs/06_plugins/index.md",5834],eb9c95da:[()=>n.e(715).then(n.bind(n,8258)),"@site/docs/02_setting-up-cls-context/04_using-a-decorator.md",8258],eca1a52a:[()=>n.e(873).then(n.bind(n,5638)),"@site/docs/01_introduction/02_quick-start.md",5638],ef9f7d37:[()=>n.e(990).then(n.bind(n,2098)),"@site/docs/03_features-and-use-cases/index.md",2098],f83e606a:[()=>n.e(104).then(n.bind(n,8472)),"@site/docs/03_features-and-use-cases/01_request-id.md",8472],fde5f810:[()=>Promise.all([n.e(532),n.e(738)]).then(n.bind(n,7636)),"@site/docs/06_plugins/01_available-plugins/01-transactional/02-knex-adapter.md",7636]};var l=n(4246);function s(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,l.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,l.jsx)("p",{children:String(t)}),(0,l.jsx)("div",{children:(0,l.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,l.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,l.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,l.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,l.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var c=n(7308),u=n(2729);function d(e,t){if("*"===e)return a()({loading:s,loader:()=>n.e(765).then(n.bind(n,765)),modules:["@theme/NotFound"],webpack:()=>[765],render(e,t){const n=e.default;return(0,l.jsx)(u.z,{value:{plugin:{name:"native",id:"default"}},children:(0,l.jsx)(n,{...t})})}});const r=o[`${e}-${t}`],d={},p=[],f=[],m=(0,c.Z)(r);return Object.entries(m).forEach((e=>{let[t,n]=e;const r=i[n];r&&(d[t]=r[0],p.push(r[1]),f.push(r[2]))})),a().Map({loading:s,loader:d,modules:p,webpack:()=>f,render(t,n){const a=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const o=r.default;if(!o)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof o&&"function"!=typeof o||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{o[e]=r[e]}));let i=a;const l=n.split(".");l.slice(0,-1).forEach((e=>{i=i[e]})),i[l[l.length-1]]=o}));const o=a.__comp;delete a.__comp;const i=a.__context;return delete a.__context,(0,l.jsx)(u.z,{value:i,children:(0,l.jsx)(o,{...a,...n})})}})}const p=[{path:"/nestjs-cls/",component:d("/nestjs-cls/","460"),routes:[{path:"/nestjs-cls/",component:d("/nestjs-cls/","b1d"),routes:[{path:"/nestjs-cls/",component:d("/nestjs-cls/","15b"),routes:[{path:"/nestjs-cls/api",component:d("/nestjs-cls/api","212"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/api/module-options",component:d("/nestjs-cls/api/module-options","77a"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/api/service-interface",component:d("/nestjs-cls/api/service-interface","0da"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/considerations",component:d("/nestjs-cls/considerations","416"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/considerations/compatibility",component:d("/nestjs-cls/considerations/compatibility","10c"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/considerations/security",component:d("/nestjs-cls/considerations/security","54f"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/features-and-use-cases",component:d("/nestjs-cls/features-and-use-cases","1da"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/features-and-use-cases/additional-cls-setup",component:d("/nestjs-cls/features-and-use-cases/additional-cls-setup","d4a"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/features-and-use-cases/breaking-out-of-di",component:d("/nestjs-cls/features-and-use-cases/breaking-out-of-di","38a"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/features-and-use-cases/proxy-providers",component:d("/nestjs-cls/features-and-use-cases/proxy-providers","53b"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/features-and-use-cases/request-id",component:d("/nestjs-cls/features-and-use-cases/request-id","b90"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/features-and-use-cases/type-safety-and-type-inference",component:d("/nestjs-cls/features-and-use-cases/type-safety-and-type-inference","88f"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/features-and-use-cases/usage-outside-of-web-request",component:d("/nestjs-cls/features-and-use-cases/usage-outside-of-web-request","9b7"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/introduction/how-it-works",component:d("/nestjs-cls/introduction/how-it-works","a84"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/introduction/installation",component:d("/nestjs-cls/introduction/installation","885"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/introduction/quick-start",component:d("/nestjs-cls/introduction/quick-start","cf1"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/migration-guide",component:d("/nestjs-cls/migration-guide","225"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/migration-guide/v2x-v3x",component:d("/nestjs-cls/migration-guide/v2x-v3x","553"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/migration-guide/v3x-v4x",component:d("/nestjs-cls/migration-guide/v3x-v4x","09e"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/plugins",component:d("/nestjs-cls/plugins","3b3"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/plugins/available-plugins",component:d("/nestjs-cls/plugins/available-plugins","3a5"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/plugins/available-plugins/transactional",component:d("/nestjs-cls/plugins/available-plugins/transactional","927"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/plugins/available-plugins/transactional/creating-custom-adapter",component:d("/nestjs-cls/plugins/available-plugins/transactional/creating-custom-adapter","09b"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/plugins/available-plugins/transactional/knex-adapter",component:d("/nestjs-cls/plugins/available-plugins/transactional/knex-adapter","79d"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/plugins/available-plugins/transactional/kysely-adapter",component:d("/nestjs-cls/plugins/available-plugins/transactional/kysely-adapter","508"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/plugins/available-plugins/transactional/pg-promise-adapter",component:d("/nestjs-cls/plugins/available-plugins/transactional/pg-promise-adapter","d86"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter",component:d("/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter","b91"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/plugins/plugin-api",component:d("/nestjs-cls/plugins/plugin-api","8c2"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/setting-up-cls-context",component:d("/nestjs-cls/setting-up-cls-context","e63"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/setting-up-cls-context/using_cls_run",component:d("/nestjs-cls/setting-up-cls-context/using_cls_run","361"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/setting-up-cls-context/using-a-decorator",component:d("/nestjs-cls/setting-up-cls-context/using-a-decorator","cc5"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/setting-up-cls-context/using-a-guard",component:d("/nestjs-cls/setting-up-cls-context/using-a-guard","8c0"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/setting-up-cls-context/using-a-middleware",component:d("/nestjs-cls/setting-up-cls-context/using-a-middleware","ad9"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/setting-up-cls-context/using-an-interceptor",component:d("/nestjs-cls/setting-up-cls-context/using-an-interceptor","393"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/testing",component:d("/nestjs-cls/testing","a1e"),exact:!0,sidebar:"documentationSidebar"},{path:"/nestjs-cls/",component:d("/nestjs-cls/","c45"),exact:!0,sidebar:"documentationSidebar"}]}]}]},{path:"*",component:d("*")}]},3210:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,t:()=>i});var r=n(7378),a=n(4246);const o=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,a.jsx)(o.Provider,{value:n,children:t})}},9921:(e,t,n)=>{"use strict";var r=n(7378),a=n(7634),o=n(4289),i=n(2883),l=n(5894);const s=[n(142),n(3887),n(8833),n(6222)];var c=n(3512),u=n(3620),d=n(5473),p=n(4246);function f(e){let{children:t}=e;return(0,p.jsx)(p.Fragment,{children:t})}var m=n(2750),g=n(9939),h=n(1847),y=n(9899),b=n(8836),v=n(9699),w=n(1706),k=n(2064),x=n(2615),S=n(4386);function E(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,g.Z)(),r=(0,v.l)(),a=n[e].htmlLang,o=e=>e.replace("-","_");return(0,p.jsxs)(m.Z,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,p.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,p.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,p.jsx)("meta",{property:"og:locale",content:o(a)}),Object.values(n).filter((e=>a!==e.htmlLang)).map((e=>(0,p.jsx)("meta",{property:"og:locale:alternate",content:o(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function C(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,g.Z)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,g.Z)(),{pathname:r}=(0,u.TH)();return e+(0,x.applyTrailingSlash)((0,h.Z)(r),{trailingSlash:n,baseUrl:t})}(),a=t?`${n}${t}`:r;return(0,p.jsxs)(m.Z,{children:[(0,p.jsx)("meta",{property:"og:url",content:a}),(0,p.jsx)("link",{rel:"canonical",href:a})]})}function _(){const{i18n:{currentLocale:e}}=(0,g.Z)(),{metadata:t,image:n}=(0,y.L)();return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsxs)(m.Z,{children:[(0,p.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,p.jsx)("body",{className:w.h})]}),n&&(0,p.jsx)(b.d,{image:n}),(0,p.jsx)(C,{}),(0,p.jsx)(E,{}),(0,p.jsx)(S.Z,{tag:k.HX,locale:e}),(0,p.jsx)(m.Z,{children:t.map(((e,t)=>(0,p.jsx)("meta",{...e},t)))})]})}const j=new Map;function T(e){if(j.has(e.pathname))return{...e,pathname:j.get(e.pathname)};if((0,d.f)(c.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return j.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return j.set(e.pathname,t),{...e,pathname:t}}var N=n(3210),R=n(2014),A=n(9749);function L(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r{const r=t.default?.[e]??t[e];return r?.(...n)}));return()=>a.forEach((e=>e?.()))}const P=function(e){let{children:t,location:n,previousLocation:r}=e;return(0,A.Z)((()=>{r!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const r=t.pathname===n.pathname,a=t.hash===n.hash,o=t.search===n.search;if(r&&a&&!o)return;const{hash:i}=t;if(i){const e=decodeURIComponent(i.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:r}),L("onRouteDidUpdate",{previousLocation:r,location:n}))}),[r,n]),t};function O(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.f)(c.Z,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class I extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=l.Z.canUseDOM?L("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=L("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),O(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return(0,p.jsx)(P,{previousLocation:this.previousLocation,location:t,children:(0,p.jsx)(u.AW,{location:t,render:()=>e})})}}const D=I,M="__docusaurus-base-url-issue-banner-container",F="__docusaurus-base-url-issue-banner",z="__docusaurus-base-url-issue-banner-suggestion-container";function B(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '${M}';\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();const a=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;a?.appendChild(r)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var K=n(7308);const Y=new Set,J=new Set,X=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,ee={prefetch(e){if(!(e=>!X()&&!J.has(e)&&!Y.has(e))(e))return!1;Y.add(e);const t=(0,d.f)(c.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(V).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,K.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Q(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!X()&&!J.has(e))(e)&&(J.add(e),O(e))},te=Object.freeze(ee),ne=Boolean(!0);if(l.Z.canUseDOM){window.docusaurus=te;const e=document.getElementById("__docusaurus"),t=(0,p.jsx)(i.B6,{children:(0,p.jsx)(o.VK,{children:(0,p.jsx)(W,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},l=()=>{if(ne)r.startTransition((()=>{a.hydrateRoot(e,t,{onRecoverableError:n})}));else{const o=a.createRoot(e,{onRecoverableError:n});r.startTransition((()=>{o.render(t)}))}};O(window.location.pathname).then(l)}},2014:(e,t,n)=>{"use strict";n.d(t,{_:()=>d,M:()=>p});var r=n(7378),a=n(6809);const o=JSON.parse('{"docusaurus-lunr-search":{"default":{"fileNames":{"searchDoc":"search-doc-1708545741984.json","lunrIndex":"lunr-index-1708545741984.json"}}},"docusaurus-plugin-content-docs":{"default":{"path":"/nestjs-cls/","versions":[{"name":"current","label":"Next","isLast":true,"path":"/nestjs-cls/","mainDocId":"introduction/index","docs":[{"id":"api/index","path":"/nestjs-cls/api/","sidebar":"documentationSidebar"},{"id":"api/module-options","path":"/nestjs-cls/api/module-options","sidebar":"documentationSidebar"},{"id":"api/service-interface","path":"/nestjs-cls/api/service-interface","sidebar":"documentationSidebar"},{"id":"considerations/compatibility","path":"/nestjs-cls/considerations/compatibility","sidebar":"documentationSidebar"},{"id":"considerations/index","path":"/nestjs-cls/considerations/","sidebar":"documentationSidebar"},{"id":"considerations/security","path":"/nestjs-cls/considerations/security","sidebar":"documentationSidebar"},{"id":"features-and-use-cases/additional-cls-setup","path":"/nestjs-cls/features-and-use-cases/additional-cls-setup","sidebar":"documentationSidebar"},{"id":"features-and-use-cases/breaking-out-of-di","path":"/nestjs-cls/features-and-use-cases/breaking-out-of-di","sidebar":"documentationSidebar"},{"id":"features-and-use-cases/index","path":"/nestjs-cls/features-and-use-cases/","sidebar":"documentationSidebar"},{"id":"features-and-use-cases/proxy-providers","path":"/nestjs-cls/features-and-use-cases/proxy-providers","sidebar":"documentationSidebar"},{"id":"features-and-use-cases/request-id","path":"/nestjs-cls/features-and-use-cases/request-id","sidebar":"documentationSidebar"},{"id":"features-and-use-cases/type-safety-and-type-inference","path":"/nestjs-cls/features-and-use-cases/type-safety-and-type-inference","sidebar":"documentationSidebar"},{"id":"features-and-use-cases/usage-outside-of-web-request","path":"/nestjs-cls/features-and-use-cases/usage-outside-of-web-request","sidebar":"documentationSidebar"},{"id":"introduction/how-it-works","path":"/nestjs-cls/introduction/how-it-works","sidebar":"documentationSidebar"},{"id":"introduction/index","path":"/nestjs-cls/","sidebar":"documentationSidebar"},{"id":"introduction/installation","path":"/nestjs-cls/introduction/installation","sidebar":"documentationSidebar"},{"id":"introduction/quick-start","path":"/nestjs-cls/introduction/quick-start","sidebar":"documentationSidebar"},{"id":"migration-guide/index","path":"/nestjs-cls/migration-guide/","sidebar":"documentationSidebar"},{"id":"migration-guide/v2x-v3x","path":"/nestjs-cls/migration-guide/v2x-v3x","sidebar":"documentationSidebar"},{"id":"migration-guide/v3x-v4x","path":"/nestjs-cls/migration-guide/v3x-v4x","sidebar":"documentationSidebar"},{"id":"plugins/available-plugins/index","path":"/nestjs-cls/plugins/available-plugins/","sidebar":"documentationSidebar"},{"id":"plugins/available-plugins/transactional/creating-custom-adapter","path":"/nestjs-cls/plugins/available-plugins/transactional/creating-custom-adapter","sidebar":"documentationSidebar"},{"id":"plugins/available-plugins/transactional/index","path":"/nestjs-cls/plugins/available-plugins/transactional/","sidebar":"documentationSidebar"},{"id":"plugins/available-plugins/transactional/knex-adapter","path":"/nestjs-cls/plugins/available-plugins/transactional/knex-adapter","sidebar":"documentationSidebar"},{"id":"plugins/available-plugins/transactional/kysely-adapter","path":"/nestjs-cls/plugins/available-plugins/transactional/kysely-adapter","sidebar":"documentationSidebar"},{"id":"plugins/available-plugins/transactional/pg-promise-adapter","path":"/nestjs-cls/plugins/available-plugins/transactional/pg-promise-adapter","sidebar":"documentationSidebar"},{"id":"plugins/available-plugins/transactional/prisma-adapter","path":"/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter","sidebar":"documentationSidebar"},{"id":"plugins/index","path":"/nestjs-cls/plugins/","sidebar":"documentationSidebar"},{"id":"plugins/plugin-api","path":"/nestjs-cls/plugins/plugin-api","sidebar":"documentationSidebar"},{"id":"setting-up-cls-context/index","path":"/nestjs-cls/setting-up-cls-context/","sidebar":"documentationSidebar"},{"id":"setting-up-cls-context/using_cls_run","path":"/nestjs-cls/setting-up-cls-context/using_cls_run","sidebar":"documentationSidebar"},{"id":"setting-up-cls-context/using-a-decorator","path":"/nestjs-cls/setting-up-cls-context/using-a-decorator","sidebar":"documentationSidebar"},{"id":"setting-up-cls-context/using-a-guard","path":"/nestjs-cls/setting-up-cls-context/using-a-guard","sidebar":"documentationSidebar"},{"id":"setting-up-cls-context/using-a-middleware","path":"/nestjs-cls/setting-up-cls-context/using-a-middleware","sidebar":"documentationSidebar"},{"id":"setting-up-cls-context/using-an-interceptor","path":"/nestjs-cls/setting-up-cls-context/using-an-interceptor","sidebar":"documentationSidebar"},{"id":"testing/index","path":"/nestjs-cls/testing/","sidebar":"documentationSidebar"}],"draftIds":[],"sidebars":{"documentationSidebar":{"link":{"path":"/nestjs-cls/","label":"Introduction"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var l=n(7529);const s=JSON.parse('{"docusaurusVersion":"3.1.0","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.1.0"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.1.0"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.1.0"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.1.0"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.1.0"},"docusaurus-lunr-search":{"type":"package","name":"docusaurus-lunr-search","version":"3.3.2"}}}');var c=n(4246);const u={siteConfig:a.default,siteMetadata:s,globalData:o,i18n:i,codeTranslations:l},d=r.createContext(u);function p(e){let{children:t}=e;return(0,c.jsx)(d.Provider,{value:u,children:t})}},5526:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7378),a=n(5894),o=n(2750),i=n(2615),l=n(9145),s=n(4246);function c(e){let{error:t,tryAgain:n}=e;return(0,s.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,s.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,s.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,s.jsx)(u,{error:t})]})}function u(e){let{error:t}=e;const n=(0,i.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,s.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function d(e){let{error:t,tryAgain:n}=e;return(0,s.jsxs)(f,{fallback:()=>(0,s.jsx)(c,{error:t,tryAgain:n}),children:[(0,s.jsx)(o.Z,{children:(0,s.jsx)("title",{children:"Page Error"})}),(0,s.jsx)(l.Z,{children:(0,s.jsx)(c,{error:t,tryAgain:n})})]})}const p=e=>(0,s.jsx)(d,{...e});class f extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??p)(e)}return e??null}}},5894:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,a={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},2750:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(7378);var r=n(2883),a=n(4246);function o(e){return(0,a.jsx)(r.ql,{...e})}},5237:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7378),a=n(4289),o=n(2615),i=n(9939),l=n(4715),s=n(5894),c=n(5741),u=n(1847),d=n(4246);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:m,isActive:g,"data-noBrokenLinkCheck":h,autoAddBaseUrl:y=!0,...b}=e;const{siteConfig:{trailingSlash:v,baseUrl:w}}=(0,i.Z)(),{withBaseUrl:k}=(0,u.C)(),x=(0,c.Z)(),S=(0,r.useRef)(null);(0,r.useImperativeHandle)(t,(()=>S.current));const E=p||f;const C=(0,l.Z)(E),_=E?.replace("pathname://","");let j=void 0!==_?(T=_,y&&(e=>e.startsWith("/"))(T)?k(T):T):void 0;var T;j&&C&&(j=(0,o.applyTrailingSlash)(j,{trailingSlash:v,baseUrl:w}));const N=(0,r.useRef)(!1),R=n?a.OL:a.rU,A=s.Z.canUseIntersectionObserver,L=(0,r.useRef)(),P=()=>{N.current||null==j||(window.docusaurus.preload(j),N.current=!0)};(0,r.useEffect)((()=>(!A&&C&&null!=j&&window.docusaurus.prefetch(j),()=>{A&&L.current&&L.current.disconnect()})),[L,j,A,C]);const O=j?.startsWith("#")??!1,I=!j||!C||O;return I||h||x.collectLink(j),I?(0,d.jsx)("a",{ref:S,href:j,...E&&!C&&{target:"_blank",rel:"noopener noreferrer"},...b}):(0,d.jsx)(R,{...b,onMouseEnter:P,onTouchStart:P,innerRef:e=>{S.current=e,A&&e&&C&&(L.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(L.current.unobserve(e),L.current.disconnect(),null!=j&&window.docusaurus.prefetch(j))}))})),L.current.observe(e))},to:j,...n&&{isActive:g,activeClassName:m}})}const f=r.forwardRef(p)},7419:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c,I:()=>s});var r=n(7378),a=n(4246);function o(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var i=n(7529);function l(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return i[t??n]??n??t}function s(e,t){let{message:n,id:r}=e;return o(l({message:n,id:r}),t)}function c(e){let{children:t,id:n,values:r}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const i=l({message:t,id:n});return(0,a.jsx)(a.Fragment,{children:o(i,r)})}},5167:(e,t,n)=>{"use strict";n.d(t,{m:()=>r});const r="default"},4715:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!r(e)}n.d(t,{Z:()=>a,b:()=>r})},1847:(e,t,n)=>{"use strict";n.d(t,{C:()=>i,Z:()=>l});var r=n(7378),a=n(9939),o=n(4715);function i(){const{siteConfig:{baseUrl:e,url:t}}=(0,a.Z)(),n=(0,r.useCallback)(((n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:a=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,o.b)(n))return n;if(a)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const l=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+l:l}(t,e,n,r)),[t,e]);return{withBaseUrl:n}}function l(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(e,t)}},5741:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i});var r=n(7378);n(4246);const a=r.createContext({collectAnchor:()=>{},collectLink:()=>{}}),o=()=>(0,r.useContext)(a);function i(){return o()}},9939:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7378),a=n(2014);function o(){return(0,r.useContext)(a._)}},353:(e,t,n)=>{"use strict";n.d(t,{OD:()=>o,eZ:()=>i});var r=n(9939),a=n(5167);function o(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,r.Z)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}function i(e,t,n){void 0===t&&(t=a.m),void 0===n&&(n={});const r=o(e),i=r?.[t];if(!i&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return i}},362:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7378),a=n(3210);function o(){return(0,r.useContext)(a._)}},9749:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});var r=n(7378);const a=n(5894).Z.canUseDOM?r.useLayoutEffect:r.useEffect},7308:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function a(e){const t={};return function e(n,a){Object.entries(n).forEach((n=>{let[o,i]=n;const l=a?`${a}.${o}`:o;r(i)?e(i,l):t[l]=i}))}(e),t}},2729:(e,t,n)=>{"use strict";n.d(t,{_:()=>o,z:()=>i});var r=n(7378),a=n(4246);const o=r.createContext(null);function i(e){let{children:t,value:n}=e;const i=r.useContext(o),l=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...n?.data};return{plugin:t.plugin,data:r}}({parent:i,value:n})),[i,n]);return(0,a.jsx)(o.Provider,{value:l,children:t})}},4924:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>f,gA:()=>u,_r:()=>s,Jo:()=>m,zh:()=>c,yW:()=>p,gB:()=>d});var r=n(3620),a=n(353);const o=e=>e.versions.find((e=>e.isLast));function i(e,t){const n=function(e,t){const n=o(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})))}(e,t),a=n?.docs.find((e=>!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:a,alternateDocVersions:a?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(a.id):{}}}const l={},s=()=>(0,a.OD)("docusaurus-plugin-content-docs")??l,c=e=>(0,a.eZ)("docusaurus-plugin-content-docs",e,{failfast:!0});function u(e){void 0===e&&(e={});const t=s(),{pathname:n}=(0,r.TH)();return function(e,t,n){void 0===n&&(n={});const a=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),o=a?{pluginId:a[0],pluginData:a[1]}:void 0;if(!o&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return o}(t,n,e)}function d(e){return c(e).versions}function p(e){const t=c(e);return o(t)}function f(e){const t=c(e),{pathname:n}=(0,r.TH)();return i(t,n)}function m(e){const t=c(e),{pathname:n}=(0,r.TH)();return function(e,t){const n=o(e);return{latestDocSuggestion:i(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},8833:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>o});var r=n(8504),a=n.n(r);a().configure({showSpinner:!1});const o={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{a().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){a().done()}}},3887:(e,t,n)=>{"use strict";n.r(t);var r=n(6101),a=n(6809);!function(e){const{themeConfig:{prism:t}}=a.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{"php"===e&&n(3109),n(3392)(`./prism-${e}`)})),delete globalThis.Prism}(r.p1)},8825:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});n(7378);var r=n(624),a=n(7419),o=n(9899),i=n(5237),l=n(5741);const s={anchorWithStickyNavbar:"anchorWithStickyNavbar_JmGV",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_pMLv"};var c=n(4246);function u(e){let{as:t,id:n,...u}=e;const d=(0,l.Z)(),{navbar:{hideOnScroll:p}}=(0,o.L)();if("h1"===t||!n)return(0,c.jsx)(t,{...u,id:void 0});d.collectAnchor(n);const f=(0,a.I)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof u.children?u.children:n});return(0,c.jsxs)(t,{...u,className:(0,r.Z)("anchor",p?s.anchorWithHideOnScrollNavbar:s.anchorWithStickyNavbar,u.className),id:n,children:[u.children,(0,c.jsx)(i.Z,{className:"hash-link",to:`#${n}`,"aria-label":f,title:f,children:"\u200b"})]})}},1858:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(7378);const r={iconExternalLink:"iconExternalLink_nPrP"};var a=n(4246);function o(e){let{width:t=13.5,height:n=13.5}=e;return(0,a.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:r.iconExternalLink,children:(0,a.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},9145:(e,t,n)=>{"use strict";n.d(t,{Z:()=>vt});var r=n(7378),a=n(624),o=n(5526),i=n(8836),l=n(3620),s=n(7419),c=n(6847),u=n(4246);const d="__docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){const e=(0,r.useRef)(null),{action:t}=(0,l.k6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,c.S)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const m=(0,s.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function g(e){const t=e.children??m,{containerRef:n,onClick:r}=f();return(0,u.jsx)("div",{ref:n,role:"region","aria-label":m,children:(0,u.jsx)("a",{...e,href:`#${d}`,onClick:r,children:t})})}var h=n(5854),y=n(1706);const b={skipToContent:"skipToContent_oPtH"};function v(){return(0,u.jsx)(g,{className:b.skipToContent})}var w=n(9899),k=n(4234);function x(e){let{width:t=21,height:n=21,color:r="currentColor",strokeWidth:a=1.2,className:o,...i}=e;return(0,u.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...i,children:(0,u.jsx)("g",{stroke:r,strokeWidth:a,children:(0,u.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const S={closeButton:"closeButton_J5rP"};function E(e){return(0,u.jsx)("button",{type:"button","aria-label":(0,s.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,a.Z)("clean-btn close",S.closeButton,e.className),children:(0,u.jsx)(x,{width:14,height:14,strokeWidth:3.1})})}const C={content:"content_bSb_"};function _(e){const{announcementBar:t}=(0,w.L)(),{content:n}=t;return(0,u.jsx)("div",{...e,className:(0,a.Z)(C.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const j={announcementBar:"announcementBar_zJRd",announcementBarPlaceholder:"announcementBarPlaceholder_NpUd",announcementBarClose:"announcementBarClose_Jjdj",announcementBarContent:"announcementBarContent_t7IR"};function T(){const{announcementBar:e}=(0,w.L)(),{isActive:t,close:n}=(0,k.nT)();if(!t)return null;const{backgroundColor:r,textColor:a,isCloseable:o}=e;return(0,u.jsxs)("div",{className:j.announcementBar,style:{backgroundColor:r,color:a},role:"banner",children:[o&&(0,u.jsx)("div",{className:j.announcementBarPlaceholder}),(0,u.jsx)(_,{className:j.announcementBarContent}),o&&(0,u.jsx)(E,{onClick:n,className:j.announcementBarClose})]})}var N=n(9067),R=n(9169);var A=n(3879),L=n(197);const P=r.createContext(null);function O(e){let{children:t}=e;const n=function(){const e=(0,N.e)(),t=(0,L.HY)(),[n,a]=(0,r.useState)(!1),o=null!==t.component,i=(0,A.D9)(o);return(0,r.useEffect)((()=>{o&&!i&&a(!0)}),[o,i]),(0,r.useEffect)((()=>{o?e.shown||a(!0):a(!1)}),[e.shown,o]),(0,r.useMemo)((()=>[n,a]),[n])}();return(0,u.jsx)(P.Provider,{value:n,children:t})}function I(e){if(e.component){const t=e.component;return(0,u.jsx)(t,{...e.props})}}function D(){const e=(0,r.useContext)(P);if(!e)throw new A.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)((()=>n(!1)),[n]),o=(0,L.HY)();return(0,r.useMemo)((()=>({shown:t,hide:a,content:I(o)})),[a,o,t])}function M(e){let{header:t,primaryMenu:n,secondaryMenu:r}=e;const{shown:o}=D();return(0,u.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,u.jsxs)("div",{className:(0,a.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":o}),children:[(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:r})]})]})}var F=n(4561),z=n(362);function B(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function $(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}const U={toggle:"toggle_ki11",toggleButton:"toggleButton_MMFG",darkToggleIcon:"darkToggleIcon_U96C",lightToggleIcon:"lightToggleIcon_lgto",toggleButtonDisabled:"toggleButtonDisabled_Uw7m"};function q(e){let{className:t,buttonClassName:n,value:r,onChange:o}=e;const i=(0,z.Z)(),l=(0,s.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===r?(0,s.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,s.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,u.jsx)("div",{className:(0,a.Z)(U.toggle,t),children:(0,u.jsxs)("button",{className:(0,a.Z)("clean-btn",U.toggleButton,!i&&U.toggleButtonDisabled,n),type:"button",onClick:()=>o("dark"===r?"light":"dark"),disabled:!i,title:l,"aria-label":l,"aria-live":"polite",children:[(0,u.jsx)(B,{className:(0,a.Z)(U.toggleIcon,U.lightToggleIcon)}),(0,u.jsx)($,{className:(0,a.Z)(U.toggleIcon,U.darkToggleIcon)})]})})}const H=r.memo(q),Z={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_m8pZ"};function G(e){let{className:t}=e;const n=(0,w.L)().navbar.style,r=(0,w.L)().colorMode.disableSwitch,{colorMode:a,setColorMode:o}=(0,F.I)();return r?null:(0,u.jsx)(H,{className:t,buttonClassName:"dark"===n?Z.darkNavbarColorModeToggle:void 0,value:a,onChange:o})}var W=n(8340);function V(){return(0,u.jsx)(W.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function Q(){const e=(0,N.e)();return(0,u.jsx)("button",{type:"button","aria-label":(0,s.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,u.jsx)(x,{color:"var(--ifm-color-emphasis-600)"})})}function K(){return(0,u.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,u.jsx)(V,{}),(0,u.jsx)(G,{className:"margin-right--md"}),(0,u.jsx)(Q,{})]})}var Y=n(5237),J=n(1847),X=n(4715);function ee(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var te=n(1858);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:r,href:a,label:o,html:i,isDropdownLink:l,prependBaseUrlToHref:s,...c}=e;const d=(0,J.Z)(r),p=(0,J.Z)(t),f=(0,J.Z)(a,{forcePrependBaseUrl:!0}),m=o&&a&&!(0,X.Z)(a),g=i?{dangerouslySetInnerHTML:{__html:i}}:{children:(0,u.jsxs)(u.Fragment,{children:[o,m&&(0,u.jsx)(te.Z,{...l&&{width:12,height:12}})]})};return a?(0,u.jsx)(Y.Z,{href:s?f:a,...c,...g}):(0,u.jsx)(Y.Z,{to:d,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?ee(n,t.pathname):t.pathname.startsWith(p)},...c,...g})}function re(e){let{className:t,isDropdownItem:n=!1,...r}=e;const o=(0,u.jsx)(ne,{className:(0,a.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...r});return n?(0,u.jsx)("li",{children:o}):o}function ae(e){let{className:t,isDropdownItem:n,...r}=e;return(0,u.jsx)("li",{className:"menu__list-item",children:(0,u.jsx)(ne,{className:(0,a.Z)("menu__link",t),...r})})}function oe(e){let{mobile:t=!1,position:n,...r}=e;const a=t?ae:re;return(0,u.jsx)(a,{...r,activeClassName:r.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var ie=n(4229),le=n(6440),se=n(9939);const ce={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_MJ1i"};function ue(e,t){return e.some((e=>function(e,t){return!!(0,le.Mg)(e.to,t)||!!ee(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function de(e){let{items:t,position:n,className:o,onClick:i,...l}=e;const s=(0,r.useRef)(null),[c,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{s.current&&!s.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[s]),(0,u.jsxs)("div",{ref:s,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":c}),children:[(0,u.jsx)(ne,{"aria-haspopup":"true","aria-expanded":c,role:"button",href:l.to?void 0:"#",className:(0,a.Z)("navbar__link",o),...l,onClick:l.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!c))},children:l.children??l.label}),(0,u.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,r.createElement)(Ae,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function pe(e){let{items:t,className:n,position:o,onClick:i,...s}=e;const c=function(){const{siteConfig:{baseUrl:e}}=(0,se.Z)(),{pathname:t}=(0,l.TH)();return t.replace(e,"/")}(),d=ue(t,c),{collapsed:p,toggleCollapsed:f,setCollapsed:m}=(0,ie.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&m(!d)}),[c,d,m]),(0,u.jsxs)("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":p}),children:[(0,u.jsx)(ne,{role:"button",className:(0,a.Z)(ce.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...s,onClick:e=>{e.preventDefault(),f()},children:s.children??s.label}),(0,u.jsx)(ie.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:p,children:t.map(((e,t)=>(0,r.createElement)(Ae,{mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active",...e,key:t})))})]})}function fe(e){let{mobile:t=!1,...n}=e;const r=t?pe:de;return(0,u.jsx)(r,{...n})}var me=n(9699);function ge(e){let{width:t=20,height:n=20,...r}=e;return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...r,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const he="iconLanguage_kvP7";function ye(e){var t,n,r="";if("string"==typeof e||"number"==typeof e)r+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;t{if(!e.state?.highlightState||0===e.state.highlightState.wordToHighlight.length)return;o(e.state.highlightState);const{highlightState:n,...r}=e.state;t.replace({...e,state:r})}),[e.state?.highlightState,t,e]),(0,r.useEffect)((()=>{if(0===a.wordToHighlight.length)return;const e=document.getElementsByTagName("article")[0]??document.getElementsByTagName("main")[0];if(!e)return;const t=new(ke())(e),n={ignoreJoiners:!0};return t.mark(a.wordToHighlight,n),()=>t.unmark(n)}),[a,n]),null}const Se=e=>{const t=(0,r.useRef)(!1),a=(0,r.useRef)(null),[o,i]=(0,r.useState)(!1),s=(0,l.k6)(),{siteConfig:c={}}=(0,se.Z)(),d=(c.plugins||[]).find((e=>Array.isArray(e)&&"string"==typeof e[0]&&e[0].includes("docusaurus-lunr-search"))),p=(0,z.Z)(),{baseUrl:f}=c,m=d&&d[1]?.assetUrl||f,g=(0,ve.eZ)("docusaurus-lunr-search"),h=()=>{t.current||(Promise.all([fetch(`${m}${g.fileNames.searchDoc}`).then((e=>e.json())),fetch(`${m}${g.fileNames.lunrIndex}`).then((e=>e.json())),Promise.all([n.e(49),n.e(471)]).then(n.bind(n,2082)),Promise.all([n.e(532),n.e(807)]).then(n.bind(n,7807))]).then((e=>{let[t,n,{default:r}]=e;const{searchDocs:a,options:o}=t;a&&0!==a.length&&(((e,t,n,r)=>{new n({searchDocs:e,searchIndex:t,baseUrl:f,inputSelector:"#search_input_react",handleSelected:(e,t,n)=>{const a=n.url||"/";document.createElement("a").href=a,e.setVal(""),t.target.blur();let o="";if(r.highlightResult)try{const e=(n.text||n.subcategory||n.title).match(new RegExp("\\w*","g"));if(e&&e.length>0){const t=document.createElement("div");t.innerHTML=e[0],o=t.textContent}}catch(i){console.log(i)}s.push(a,{highlightState:{wordToHighlight:o}})},maxHits:r.maxHits})})(a,n,r,o),i(!0))})),t.current=!0)},y=(0,r.useCallback)((t=>{a.current.contains(t.target)||a.current.focus(),e.handleSearchBarToggle&&e.handleSearchBarToggle(!e.isSearchBarExpanded)}),[e.isSearchBarExpanded]);let b;return p&&(h(),b=window.navigator.platform.startsWith("Mac")?"Search \u2318+K":"Search Ctrl+K"),(0,u.jsxs)("div",{className:"navbar__search",children:[(0,u.jsx)("span",{"aria-label":"expand searchbar",role:"button",className:be("search-icon",{"search-icon-hidden":e.isSearchBarExpanded}),onClick:y,onKeyDown:y,tabIndex:0}),(0,u.jsx)("input",{id:"search_input_react",type:"search",placeholder:o?b:"Loading...","aria-label":"Search",className:be("navbar__search-input",{"search-bar-expanded":e.isSearchBarExpanded},{"search-bar":!e.isSearchBarExpanded}),onClick:h,onMouseOver:h,onFocus:y,onBlur:y,ref:a,disabled:!o}),(0,u.jsx)(xe,{})]},"search-box")},Ee={navbarSearchContainer:"navbarSearchContainer_bzqh"};function Ce(e){let{children:t,className:n}=e;return(0,u.jsx)("div",{className:(0,a.Z)(n,Ee.navbarSearchContainer),children:t})}var _e=n(4924),je=n(7470);var Te=n(8072);const Ne=e=>e.docs.find((t=>t.id===e.mainDocId));const Re={default:oe,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:r,queryString:a="",...o}=e;const{i18n:{currentLocale:i,locales:c,localeConfigs:d}}=(0,se.Z)(),p=(0,me.l)(),{search:f,hash:m}=(0,l.TH)(),g=[...n,...c.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${m}${a}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...r],h=t?(0,s.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return(0,u.jsx)(fe,{...o,mobile:t,label:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(ge,{className:he}),h]}),items:g})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,u.jsx)(Ce,{className:n,children:(0,u.jsx)(Se,{})})},dropdown:fe,html:function(e){let{value:t,className:n,mobile:r=!1,isDropdownItem:o=!1}=e;const i=o?"li":"div";return(0,u.jsx)(i,{className:(0,a.Z)({navbar__item:!r&&!o,"menu__list-item":r},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:r,...a}=e;const{activeDoc:o}=(0,_e.Iw)(r),i=(0,je.vY)(t,r),l=o?.path===i?.path;return null===i||i.unlisted&&!l?null:(0,u.jsx)(oe,{exact:!0,...a,isActive:()=>l||!!o?.sidebar&&o.sidebar===i.sidebar,label:n??i.id,to:i.path})},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:r,...a}=e;const{activeDoc:o}=(0,_e.Iw)(r),i=(0,je.oz)(t,r).link;if(!i)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,u.jsx)(oe,{exact:!0,...a,isActive:()=>o?.sidebar===t,label:n??i.label,to:i.path})},docsVersion:function(e){let{label:t,to:n,docsPluginId:r,...a}=e;const o=(0,je.lO)(r)[0],i=t??o.label,l=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(o).path;return(0,u.jsx)(oe,{...a,label:i,to:l})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:r,dropdownItemsBefore:a,dropdownItemsAfter:o,...i}=e;const{search:c,hash:d}=(0,l.TH)(),p=(0,_e.Iw)(n),f=(0,_e.gB)(n),{savePreferredVersionName:m}=(0,Te.J)(n),g=[...a,...f.map((e=>{const t=p.alternateDocVersions[e.name]??Ne(e);return{label:e.label,to:`${t.path}${c}${d}`,isActive:()=>e===p.activeVersion,onClick:()=>m(e.name)}})),...o],h=(0,je.lO)(n)[0],y=t&&g.length>1?(0,s.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):h.label,b=t&&g.length>1?void 0:Ne(h).path;return g.length<=1?(0,u.jsx)(oe,{...i,mobile:t,label:y,to:b,isActive:r?()=>!1:void 0}):(0,u.jsx)(fe,{...i,mobile:t,label:y,to:b,items:g,isActive:r?()=>!1:void 0})}};function Ae(e){let{type:t,...n}=e;const r=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),a=Re[r];if(!a)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,u.jsx)(a,{...n})}function Le(){const e=(0,N.e)(),t=(0,w.L)().navbar.items;return(0,u.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,r.createElement)(Ae,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function Pe(e){return(0,u.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,u.jsx)(s.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function Oe(){const e=0===(0,w.L)().navbar.items.length,t=D();return(0,u.jsxs)(u.Fragment,{children:[!e&&(0,u.jsx)(Pe,{onClick:()=>t.hide()}),t.content]})}function Ie(){const e=(0,N.e)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?(0,u.jsx)(M,{header:(0,u.jsx)(K,{}),primaryMenu:(0,u.jsx)(Le,{}),secondaryMenu:(0,u.jsx)(Oe,{})}):null}const De={navbarHideable:"navbarHideable_hhpl",navbarHidden:"navbarHidden_nmcs"};function Me(e){return(0,u.jsx)("div",{role:"presentation",...e,className:(0,a.Z)("navbar-sidebar__backdrop",e.className)})}function Fe(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,w.L)(),i=(0,N.e)(),{navbarRef:l,isNavbarVisible:d}=function(e){const[t,n]=(0,r.useState)(e),a=(0,r.useRef)(!1),o=(0,r.useRef)(0),i=(0,r.useCallback)((e=>{null!==e&&(o.current=e.getBoundingClientRect().height)}),[]);return(0,R.RF)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=l?n(!1):i+c{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return a.current=!0,void n(!1);n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return(0,u.jsxs)("nav",{ref:l,"aria-label":(0,s.I)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,a.Z)("navbar","navbar--fixed-top",n&&[De.navbarHideable,!d&&De.navbarHidden],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":i.shown}),children:[t,(0,u.jsx)(Me,{onClick:i.toggle}),(0,u.jsx)(Ie,{})]})}var ze=n(2615);const Be={errorBoundaryError:"errorBoundaryError_WE6Q",errorBoundaryFallback:"errorBoundaryFallback_bdJX"};function $e(e){return(0,u.jsx)("button",{type:"button",...e,children:(0,u.jsx)(s.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function Ue(e){let{error:t}=e;const n=(0,ze.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,u.jsx)("p",{className:Be.errorBoundaryError,children:n})}class qe extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const He="right";function Ze(e){let{width:t=30,height:n=30,className:r,...a}=e;return(0,u.jsx)("svg",{className:r,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...a,children:(0,u.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function Ge(){const{toggle:e,shown:t}=(0,N.e)();return(0,u.jsx)("button",{onClick:e,"aria-label":(0,s.I)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,u.jsx)(Ze,{})})}const We={colorModeToggle:"colorModeToggle_Hewu"};function Ve(e){let{items:t}=e;return(0,u.jsx)(u.Fragment,{children:t.map(((e,t)=>(0,u.jsx)(qe,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,u.jsx)(Ae,{...e})},t)))})}function Qe(e){let{left:t,right:n}=e;return(0,u.jsxs)("div",{className:"navbar__inner",children:[(0,u.jsx)("div",{className:"navbar__items",children:t}),(0,u.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function Ke(){const e=(0,N.e)(),t=(0,w.L)().navbar.items,[n,r]=function(e){function t(e){return"left"===(e.position??He)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),a=t.find((e=>"search"===e.type));return(0,u.jsx)(Qe,{left:(0,u.jsxs)(u.Fragment,{children:[!e.disabled&&(0,u.jsx)(Ge,{}),(0,u.jsx)(V,{}),(0,u.jsx)(Ve,{items:n})]}),right:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(Ve,{items:r}),(0,u.jsx)(G,{className:We.colorModeToggle}),!a&&(0,u.jsx)(Ce,{children:(0,u.jsx)(Se,{})})]})})}function Ye(){return(0,u.jsx)(Fe,{children:(0,u.jsx)(Ke,{})})}function Je(e){let{item:t}=e;const{to:n,href:r,label:a,prependBaseUrlToHref:o,...i}=t,l=(0,J.Z)(n),s=(0,J.Z)(r,{forcePrependBaseUrl:!0});return(0,u.jsxs)(Y.Z,{className:"footer__link-item",...r?{href:o?s:r}:{to:l},...i,children:[a,r&&!(0,X.Z)(r)&&(0,u.jsx)(te.Z,{})]})}function Xe(e){let{item:t}=e;return t.html?(0,u.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)("li",{className:"footer__item",children:(0,u.jsx)(Je,{item:t})},t.href??t.to)}function et(e){let{column:t}=e;return(0,u.jsxs)("div",{className:"col footer__col",children:[(0,u.jsx)("div",{className:"footer__title",children:t.title}),(0,u.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,u.jsx)(Xe,{item:e},t)))})]})}function tt(e){let{columns:t}=e;return(0,u.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,u.jsx)(et,{column:e},t)))})}function nt(){return(0,u.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function rt(e){let{item:t}=e;return t.html?(0,u.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)(Je,{item:t})}function at(e){let{links:t}=e;return(0,u.jsx)("div",{className:"footer__links text--center",children:(0,u.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,u.jsxs)(r.Fragment,{children:[(0,u.jsx)(rt,{item:e}),t.length!==n+1&&(0,u.jsx)(nt,{})]},n)))})})}function ot(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,u.jsx)(tt,{columns:t}):(0,u.jsx)(at,{links:t})}var it=n(1412);const lt={footerLogoLink:"footerLogoLink_tutC"};function st(e){let{logo:t}=e;const{withBaseUrl:n}=(0,J.C)(),r={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,u.jsx)(it.Z,{className:(0,a.Z)("footer__logo",t.className),alt:t.alt,sources:r,width:t.width,height:t.height,style:t.style})}function ct(e){let{logo:t}=e;return t.href?(0,u.jsx)(Y.Z,{href:t.href,className:lt.footerLogoLink,target:t.target,children:(0,u.jsx)(st,{logo:t})}):(0,u.jsx)(st,{logo:t})}function ut(e){let{copyright:t}=e;return(0,u.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function dt(e){let{style:t,links:n,logo:r,copyright:o}=e;return(0,u.jsx)("footer",{className:(0,a.Z)("footer",{"footer--dark":"dark"===t}),children:(0,u.jsxs)("div",{className:"container container-fluid",children:[n,(r||o)&&(0,u.jsxs)("div",{className:"footer__bottom text--center",children:[r&&(0,u.jsx)("div",{className:"margin-bottom--sm",children:r}),o]})]})})}function pt(){const{footer:e}=(0,w.L)();if(!e)return null;const{copyright:t,links:n,logo:r,style:a}=e;return(0,u.jsx)(dt,{style:a,links:n&&n.length>0&&(0,u.jsx)(ot,{links:n}),logo:r&&(0,u.jsx)(ct,{logo:r}),copyright:t&&(0,u.jsx)(ut,{copyright:t})})}const ft=r.memo(pt),mt=(0,A.Qc)([F.S,k.pl,R.OC,Te.L5,i.VC,function(e){let{children:t}=e;return(0,u.jsx)(L.n2,{children:(0,u.jsx)(N.M,{children:(0,u.jsx)(O,{children:t})})})}]);function gt(e){let{children:t}=e;return(0,u.jsx)(mt,{children:t})}var ht=n(8825);function yt(e){let{error:t,tryAgain:n}=e;return(0,u.jsx)("main",{className:"container margin-vert--xl",children:(0,u.jsx)("div",{className:"row",children:(0,u.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,u.jsx)(ht.Z,{as:"h1",className:"hero__title",children:(0,u.jsx)(s.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,u.jsx)("div",{className:"margin-vert--lg",children:(0,u.jsx)($e,{onClick:n,className:"button button--primary shadow--lw"})}),(0,u.jsx)("hr",{}),(0,u.jsx)("div",{className:"margin-vert--md",children:(0,u.jsx)(Ue,{error:t})})]})})})}const bt={mainWrapper:"mainWrapper_MB5r"};function vt(e){const{children:t,noFooter:n,wrapperClassName:r,title:l,description:s}=e;return(0,y.t)(),(0,u.jsxs)(gt,{children:[(0,u.jsx)(i.d,{title:l,description:s}),(0,u.jsx)(v,{}),(0,u.jsx)(T,{}),(0,u.jsx)(Ye,{}),(0,u.jsx)("div",{id:d,className:(0,a.Z)(h.k.wrapper.main,bt.mainWrapper,r),children:(0,u.jsx)(o.Z,{fallback:e=>(0,u.jsx)(yt,{...e}),children:t})}),!n&&(0,u.jsx)(ft,{})]})}},8340:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});n(7378);var r=n(5237),a=n(1847),o=n(9939),i=n(9899),l=n(1412),s=n(4246);function c(e){let{logo:t,alt:n,imageClassName:r}=e;const o={light:(0,a.Z)(t.src),dark:(0,a.Z)(t.srcDark||t.src)},i=(0,s.jsx)(l.Z,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return r?(0,s.jsx)("div",{className:r,children:i}):i}function u(e){const{siteConfig:{title:t}}=(0,o.Z)(),{navbar:{title:n,logo:l}}=(0,i.L)(),{imageClassName:u,titleClassName:d,...p}=e,f=(0,a.Z)(l?.href||"/"),m=n?"":t,g=l?.alt??m;return(0,s.jsxs)(r.Z,{to:f,...p,...l?.target&&{target:l.target},children:[l&&(0,s.jsx)(c,{logo:l,alt:g,imageClassName:u}),null!=n&&(0,s.jsx)("b",{className:d,children:n})]})}},4386:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});n(7378);var r=n(2750),a=n(4246);function o(e){let{locale:t,version:n,tag:o}=e;const i=t;return(0,a.jsxs)(r.Z,{children:[t&&(0,a.jsx)("meta",{name:"docusaurus_locale",content:t}),n&&(0,a.jsx)("meta",{name:"docusaurus_version",content:n}),o&&(0,a.jsx)("meta",{name:"docusaurus_tag",content:o}),i&&(0,a.jsx)("meta",{name:"docsearch:language",content:i}),n&&(0,a.jsx)("meta",{name:"docsearch:version",content:n}),o&&(0,a.jsx)("meta",{name:"docsearch:docusaurus_tag",content:o})]})}},1412:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});var r=n(7378),a=n(624),o=n(362),i=n(4561);const l={themedComponent:"themedComponent_siVc","themedComponent--light":"themedComponent--light_hHel","themedComponent--dark":"themedComponent--dark_yETr"};var s=n(4246);function c(e){let{className:t,children:n}=e;const c=(0,o.Z)(),{colorMode:u}=(0,i.I)();return(0,s.jsx)(s.Fragment,{children:(c?"dark"===u?["dark"]:["light"]:["light","dark"]).map((e=>{const o=n({theme:e,className:(0,a.Z)(t,l.themedComponent,l[`themedComponent--${e}`])});return(0,s.jsx)(r.Fragment,{children:o},e)}))})}function u(e){const{sources:t,className:n,alt:r,...a}=e;return(0,s.jsx)(c,{className:n,children:e=>{let{theme:n,className:o}=e;return(0,s.jsx)("img",{src:t[n],alt:r,className:o,...a})}})}},4229:(e,t,n)=>{"use strict";n.d(t,{u:()=>c,z:()=>y});var r=n(7378),a=n(5894),o=n(9749),i=n(5122),l=n(4246);const s="ease-in-out";function c(e){let{initialState:t}=e;const[n,a]=(0,r.useState)(t??!1),o=(0,r.useCallback)((()=>{a((e=>!e))}),[]);return{collapsed:n,setCollapsed:a,toggleCollapsed:o}}const u={display:"none",overflow:"hidden",height:"0px"},d={display:"block",overflow:"visible",height:"auto"};function p(e,t){const n=t?u:d;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function f(e){let{collapsibleRef:t,collapsed:n,animation:a}=e;const o=(0,r.useRef)(!1);(0,r.useEffect)((()=>{const e=t.current;function r(){const t=e.scrollHeight,n=a?.duration??function(e){if((0,i.n)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${a?.easing??s}`,height:`${t}px`}}function l(){const t=r();e.style.transition=t.transition,e.style.height=t.height}if(!o.current)return p(e,n),void(o.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(l(),requestAnimationFrame((()=>{e.style.height=u.height,e.style.overflow=u.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{l()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,a])}function m(e){if(!a.Z.canUseDOM)return e?u:d}function g(e){let{as:t="div",collapsed:n,children:a,animation:o,onCollapseTransitionEnd:i,className:s,disableSSRStyle:c}=e;const u=(0,r.useRef)(null);return f({collapsibleRef:u,collapsed:n,animation:o}),(0,l.jsx)(t,{ref:u,style:c?void 0:m(n),onTransitionEnd:e=>{"height"===e.propertyName&&(p(u.current,n),i?.(n))},className:s,children:a})}function h(e){let{collapsed:t,...n}=e;const[a,i]=(0,r.useState)(!t),[s,c]=(0,r.useState)(t);return(0,o.Z)((()=>{t||i(!0)}),[t]),(0,o.Z)((()=>{a&&c(t)}),[a,t]),a?(0,l.jsx)(g,{...n,collapsed:s}):null}function y(e){let{lazy:t,...n}=e;const r=t?h:g;return(0,l.jsx)(r,{...n})}},4234:(e,t,n)=>{"use strict";n.d(t,{nT:()=>g,pl:()=>m});var r=n(7378),a=n(362),o=n(8796),i=n(3879),l=n(9899),s=n(4246);const c=(0,o.WA)("docusaurus.announcement.dismiss"),u=(0,o.WA)("docusaurus.announcement.id"),d=()=>"true"===c.get(),p=e=>c.set(String(e)),f=r.createContext(null);function m(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,l.L)(),t=(0,a.Z)(),[n,o]=(0,r.useState)((()=>!!t&&d()));(0,r.useEffect)((()=>{o(d())}),[]);const i=(0,r.useCallback)((()=>{p(!0),o(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=u.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;u.set(t),r&&p(!1),!r&&d()||o(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return(0,s.jsx)(f.Provider,{value:n,children:t})}function g(){const e=(0,r.useContext)(f);if(!e)throw new i.i6("AnnouncementBarProvider");return e}},4561:(e,t,n)=>{"use strict";n.d(t,{I:()=>y,S:()=>h});var r=n(7378),a=n(5894),o=n(3879),i=n(8796),l=n(9899),s=n(4246);const c=r.createContext(void 0),u="theme",d=(0,i.WA)(u),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,m=e=>a.Z.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),g=e=>{d.set(f(e))};function h(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,l.L)(),[a,o]=(0,r.useState)(m(e));(0,r.useEffect)((()=>{t&&d.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:a=!0}=r;t?(o(t),a&&g(t)):(o(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),d.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(a))}),[a]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==u)return;const t=d.get();null!==t&&i(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const s=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||s.current?s.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:a,setColorMode:i,get isDarkTheme(){return a===p.dark},setLightTheme(){i(p.light)},setDarkTheme(){i(p.dark)}})),[a,i])}();return(0,s.jsx)(c.Provider,{value:n,children:t})}function y(){const e=(0,r.useContext)(c);if(null==e)throw new o.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},8072:(e,t,n)=>{"use strict";n.d(t,{J:()=>v,L5:()=>y});var r=n(7378),a=n(4924),o=n(5167),i=n(9899),l=n(7470),s=n(3879),c=n(8796),u=n(4246);const d=e=>`docs-preferred-version-${e}`,p={save:(e,t,n)=>{(0,c.WA)(d(e),{persistence:t}).set(n)},read:(e,t)=>(0,c.WA)(d(e),{persistence:t}).get(),clear:(e,t)=>{(0,c.WA)(d(e),{persistence:t}).del()}},f=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const m=r.createContext(null);function g(){const e=(0,a._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[o,l]=(0,r.useState)((()=>f(n)));(0,r.useEffect)((()=>{l(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function a(e){const t=p.read(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(p.clear(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,a(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[o,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){p.save(e,t,n),l((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function h(e){let{children:t}=e;const n=g();return(0,u.jsx)(m.Provider,{value:n,children:t})}function y(e){let{children:t}=e;return l.cE?(0,u.jsx)(h,{children:t}):(0,u.jsx)(u.Fragment,{children:t})}function b(){const e=(0,r.useContext)(m);if(!e)throw new s.i6("DocsPreferredVersionContextProvider");return e}function v(e){void 0===e&&(e=o.m);const t=(0,a.zh)(e),[n,i]=b(),{preferredVersionName:l}=n[e];return{preferredVersion:t.versions.find((e=>e.name===l))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}},8774:(e,t,n)=>{"use strict";n.d(t,{V:()=>c,b:()=>s});var r=n(7378),a=n(3879),o=n(4246);const i=Symbol("EmptyContext"),l=r.createContext(i);function s(e){let{children:t,name:n,items:a}=e;const i=(0,r.useMemo)((()=>n&&a?{name:n,items:a}:null),[n,a]);return(0,o.jsx)(l.Provider,{value:i,children:t})}function c(){const e=(0,r.useContext)(l);if(e===i)throw new a.i6("DocsSidebarProvider");return e}},2885:(e,t,n)=>{"use strict";n.d(t,{E:()=>s,q:()=>l});var r=n(7378),a=n(3879),o=n(4246);const i=r.createContext(null);function l(e){let{children:t,version:n}=e;return(0,o.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(null===e)throw new a.i6("DocsVersionProvider");return e}},9067:(e,t,n)=>{"use strict";n.d(t,{M:()=>p,e:()=>f});var r=n(7378),a=n(197),o=n(7980),i=n(8981),l=n(9899),s=n(3879),c=n(4246);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,a.HY)(),{items:t}=(0,l.L)().navbar;return 0===t.length&&!e.component}(),t=(0,o.i)(),n=!e&&"mobile"===t,[s,c]=(0,r.useState)(!1);(0,i.Rb)((()=>{if(s)return c(!1),!1}));const u=(0,r.useCallback)((()=>{c((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&c(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:s})),[e,n,u,s])}function p(e){let{children:t}=e;const n=d();return(0,c.jsx)(u.Provider,{value:n,children:t})}function f(){const e=r.useContext(u);if(void 0===e)throw new s.i6("NavbarMobileSidebarProvider");return e}},197:(e,t,n)=>{"use strict";n.d(t,{HY:()=>s,Zo:()=>c,n2:()=>l});var r=n(7378),a=n(3879),o=n(4246);const i=r.createContext(null);function l(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return(0,o.jsx)(i.Provider,{value:n,children:t})}function s(){const e=(0,r.useContext)(i);if(!e)throw new a.i6("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:n}=e;const o=(0,r.useContext)(i);if(!o)throw new a.i6("NavbarSecondaryMenuContentProvider");const[,l]=o,s=(0,a.Ql)(n);return(0,r.useEffect)((()=>{l({component:t,props:s})}),[l,t,s]),(0,r.useEffect)((()=>()=>l({component:null,props:null})),[l]),null}},1706:(e,t,n)=>{"use strict";n.d(t,{h:()=>a,t:()=>o});var r=n(7378);const a="navigation-with-keyboard";function o(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(a),"mousedown"===e.type&&document.body.classList.remove(a)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},7980:(e,t,n)=>{"use strict";n.d(t,{i:()=>l});var r=n(7378),a=n(5894);const o={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function l(e){let{desktopBreakpoint:t=i}=void 0===e?{}:e;const[n,l]=(0,r.useState)((()=>"ssr"));return(0,r.useEffect)((()=>{function e(){l(function(e){if(!a.Z.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>e?o.desktop:o.mobile}(t))}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[t]),n}},5854:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{}}},5122:(e,t,n)=>{"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{n:()=>r})},7470:(e,t,n)=>{"use strict";n.d(t,{LM:()=>f,SN:()=>E,_F:()=>h,cE:()=>p,f:()=>b,lO:()=>k,oz:()=>x,s1:()=>w,vY:()=>S});var r=n(7378),a=n(3620),o=n(5473),i=n(4924),l=n(8072),s=n(2885),c=n(8774),u=n(56),d=n(6440);const p=!!i._r;function f(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=f(t);if(e)return e}}(e):void 0:e.href}const m=(e,t)=>void 0!==e&&(0,d.Mg)(e,t),g=(e,t)=>e.some((e=>h(e,t)));function h(e,t){return"link"===e.type?m(e.href,t):"category"===e.type&&(m(e.href,t)||g(e.items,t))}function y(e,t){switch(e.type){case"category":return h(e,t)||e.items.some((e=>y(e,t)));case"link":return!e.unlisted||h(e,t);default:return!0}}function b(e,t){return(0,r.useMemo)((()=>e.filter((e=>y(e,t)))),[e,t])}function v(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const a=[];return function e(t){for(const o of t)if("category"===o.type&&((0,d.Mg)(o.href,n)||e(o.items))||"link"===o.type&&(0,d.Mg)(o.href,n)){return r&&"category"!==o.type||a.unshift(o),!0}return!1}(t),a}function w(){const e=(0,c.V)(),{pathname:t}=(0,a.TH)(),n=(0,i.gA)()?.pluginData.breadcrumbs;return!1!==n&&e?v({sidebarItems:e.items,pathname:t}):null}function k(e){const{activeVersion:t}=(0,i.Iw)(e),{preferredVersion:n}=(0,l.J)(e),a=(0,i.yW)(e);return(0,r.useMemo)((()=>(0,u.j)([t,n,a].filter(Boolean))),[t,n,a])}function x(e,t){const n=k(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return r[1]}),[e,n])}function S(e,t){const n=k(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${n.length>1?"s":""} "${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,u.j)(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function E(e){let{route:t}=e;const n=(0,a.TH)(),r=(0,s.E)(),i=t.routes,l=i.find((e=>(0,a.LX)(n.pathname,e)));if(!l)return null;const c=l.sidebar,u=c?r.docsSidebars[c]:void 0;return{docElement:(0,o.H)(i),sidebarName:c,sidebarItems:u}}},8981:(e,t,n)=>{"use strict";n.d(t,{Rb:()=>i,_X:()=>l});var r=n(7378),a=n(3620),o=n(3879);function i(e){!function(e){const t=(0,a.k6)(),n=(0,o.zX)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}function l(e){return function(e){const t=(0,a.k6)();return(0,r.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}},56:(e,t,n)=>{"use strict";function r(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,r)=>e.findIndex((e=>t(e,n)))!==r))}function a(e){return Array.from(new Set(e))}n.d(t,{j:()=>a,l:()=>r})},8836:(e,t,n)=>{"use strict";n.d(t,{FG:()=>f,d:()=>d,VC:()=>m});var r=n(7378),a=n(624),o=n(2750),i=n(2729);function l(){const e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var s=n(1847),c=n(9939);var u=n(4246);function d(e){let{title:t,description:n,keywords:r,image:a,children:i}=e;const l=function(e){const{siteConfig:t}=(0,c.Z)(),{title:n,titleDelimiter:r}=t;return e?.trim().length?`${e.trim()} ${r} ${n}`:n}(t),{withBaseUrl:d}=(0,s.C)(),p=a?d(a,{absolute:!0}):void 0;return(0,u.jsxs)(o.Z,{children:[t&&(0,u.jsx)("title",{children:l}),t&&(0,u.jsx)("meta",{property:"og:title",content:l}),n&&(0,u.jsx)("meta",{name:"description",content:n}),n&&(0,u.jsx)("meta",{property:"og:description",content:n}),r&&(0,u.jsx)("meta",{name:"keywords",content:Array.isArray(r)?r.join(","):r}),p&&(0,u.jsx)("meta",{property:"og:image",content:p}),p&&(0,u.jsx)("meta",{name:"twitter:image",content:p}),i]})}const p=r.createContext(void 0);function f(e){let{className:t,children:n}=e;const i=r.useContext(p),l=(0,a.Z)(i,t);return(0,u.jsxs)(p.Provider,{value:l,children:[(0,u.jsx)(o.Z,{children:(0,u.jsx)("html",{className:l})}),n]})}function m(e){let{children:t}=e;const n=l(),r=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const o=`plugin-id-${n.plugin.id}`;return(0,u.jsx)(f,{className:(0,a.Z)(r,o),children:t})}},3879:(e,t,n)=>{"use strict";n.d(t,{D9:()=>l,Qc:()=>u,Ql:()=>c,i6:()=>s,zX:()=>i});var r=n(7378),a=n(9749),o=n(4246);function i(e){const t=(0,r.useRef)(e);return(0,a.Z)((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function l(e){const t=(0,r.useRef)();return(0,a.Z)((()=>{t.current=e})),t.current}class s extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function u(e){return t=>{let{children:n}=t;return(0,o.jsx)(o.Fragment,{children:e.reduceRight(((e,t)=>(0,o.jsx)(t,{children:e})),n)})}}},6440:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>i,Ns:()=>l});var r=n(7378),a=n(3512),o=n(9939);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function l(){const{baseUrl:e}=(0,o.Z)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function a(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(a).flatMap((e=>e.routes??[])))}(n)}({routes:a.Z,baseUrl:e})),[e])}},9169:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>g,OC:()=>u,RF:()=>f,o5:()=>m});var r=n(7378),a=n(5894),o=n(362),i=n(9749),l=n(3879),s=n(4246);const c=r.createContext(void 0);function u(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return(0,s.jsx)(c.Provider,{value:n,children:t})}function d(){const e=(0,r.useContext)(c);if(null==e)throw new l.i6("ScrollControllerProvider");return e}const p=()=>a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function f(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=d(),a=(0,r.useRef)(p()),o=(0,l.zX)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=p();o(e,a.current),a.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[o,n,...t])}function m(){const e=d(),t=function(){const e=(0,r.useRef)({elem:null,top:0}),t=(0,r.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,r.useCallback)((()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const r=t.getBoundingClientRect().top-n;return r&&window.scrollBy({left:0,top:r}),e.current={elem:null,top:0},{restored:0!==r}}),[]);return(0,r.useMemo)((()=>({save:t,restore:n})),[n,t])}(),n=(0,r.useRef)(void 0),a=(0,r.useCallback)((r=>{t.save(r),e.disableScrollEvents(),n.current=()=>{const{restored:r}=t.restore();if(n.current=void 0,r){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,i.Z)((()=>{queueMicrotask((()=>n.current?.()))})),{blockElementScrollPositionUntilNextRender:a}}function g(){const e=(0,r.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const a=document.documentElement.scrollTop;(n&&a>e||!n&&at&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},2064:(e,t,n)=>{"use strict";n.d(t,{HX:()=>r,os:()=>a});n(9939);const r="default";function a(e,t){return`docs-${e}-${t}`}},8796:(e,t,n)=>{"use strict";n.d(t,{Nk:()=>u,WA:()=>c});var r=n(7378);const a="localStorage";function o(e){let{key:t,oldValue:n,newValue:r,storage:a}=e;if(n===r)return;const o=document.createEvent("StorageEvent");o.initStorageEvent("storage",!1,!1,t,n,r,window.location.href,a),window.dispatchEvent(o)}function i(e){if(void 0===e&&(e=a),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,l||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),l=!0),null}var t}let l=!1;const s={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function c(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(e);const n=i(t?.persistence);return null===n?s:{get:()=>{try{return n.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{const r=n.getItem(e);n.setItem(e,t),o({key:e,oldValue:r,newValue:t,storage:n})}catch(r){console.error(`Docusaurus storage error, can't set ${e}=${t}`,r)}},del:()=>{try{const t=n.getItem(e);n.removeItem(e),o({key:e,oldValue:t,newValue:null,storage:n})}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}},listen:t=>{try{const r=r=>{r.storageArea===n&&r.key===e&&t(r)};return window.addEventListener("storage",r),()=>window.removeEventListener("storage",r)}catch(r){return console.error(`Docusaurus storage error, can't listen for changes of key=${e}`,r),()=>{}}}}}function u(e,t){const n=(0,r.useRef)((()=>null===e?s:c(e,t))).current(),a=(0,r.useCallback)((e=>"undefined"==typeof window?()=>{}:n.listen(e)),[n]);return[(0,r.useSyncExternalStore)(a,(()=>"undefined"==typeof window?null:n.get()),(()=>null)),n]}},9699:(e,t,n)=>{"use strict";n.d(t,{l:()=>i});var r=n(9939),a=n(3620),o=n(2615);function i(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:i,currentLocale:l}}=(0,r.Z)(),{pathname:s}=(0,a.TH)(),c=(0,o.applyTrailingSlash)(s,{trailingSlash:n,baseUrl:e}),u=l===i?e:e.replace(`/${l}/`,"/"),d=c.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:r}=e;return`${r?t:""}${function(e){return e===i?`${u}`:`${u}${e}/`}(n)}${d}`}}}},6847:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(7378),a=n(3620),o=n(3879);function i(e){const t=(0,a.TH)(),n=(0,o.D9)(t),i=(0,o.zX)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},9899:(e,t,n)=>{"use strict";n.d(t,{L:()=>a});var r=n(9939);function a(){return(0,r.Z)().siteConfig.themeConfig}},4454:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[a]=e.split(/[#?]/),o="/"===a||a===r?a:(i=a,n?function(e){return e.endsWith("/")?e:`${e}/`}(i):function(e){return e.endsWith("/")?e.slice(0,-1):e}(i));var i;return e.replace(a,o)}},6824:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...e(t.cause)]:[t]}},2615:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var a=n(4454);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(a).default}});var o=n(6824);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return o.getErrorCausalChain}})},5036:(e,t,n)=>{"use strict";n.d(t,{lX:()=>w,q_:()=>_,ob:()=>f,PP:()=>T,Ep:()=>p});var r=n(2685);function a(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,r=n+1,a=e.length;r=0;p--){var f=i[p];"."===f?o(i,p):".."===f?(o(i,p),d++):d&&(o(i,p),d--)}if(!c)for(;d--;d)i.unshift("..");!c||""===i[0]||i[0]&&a(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};var l=n(2215);function s(e){return"/"===e.charAt(0)?e:"/"+e}function c(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function p(e){var t=e.pathname,n=e.search,r=e.hash,a=t||"/";return n&&"?"!==n&&(a+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(a+="#"===r.charAt(0)?r:"#"+r),a}function f(e,t,n,a){var o;"string"==typeof e?(o=function(e){var t=e||"/",n="",r="",a=t.indexOf("#");-1!==a&&(r=t.substr(a),t=t.substr(0,a));var o=t.indexOf("?");return-1!==o&&(n=t.substr(o),t=t.substr(0,o)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),o.state=t):(void 0===(o=(0,r.Z)({},e)).pathname&&(o.pathname=""),o.search?"?"!==o.search.charAt(0)&&(o.search="?"+o.search):o.search="",o.hash?"#"!==o.hash.charAt(0)&&(o.hash="#"+o.hash):o.hash="",void 0!==t&&void 0===o.state&&(o.state=t));try{o.pathname=decodeURI(o.pathname)}catch(l){throw l instanceof URIError?new URIError('Pathname "'+o.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):l}return n&&(o.key=n),a?o.pathname?"/"!==o.pathname.charAt(0)&&(o.pathname=i(o.pathname,a.pathname)):o.pathname=a.pathname:o.pathname||(o.pathname="/"),o}function m(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,a){if(null!=e){var o="function"==typeof e?e(t,n):e;"string"==typeof o?"function"==typeof r?r(o,a):a(!0):a(!1!==o)}else a(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,a):n.push(a),d({action:r,location:a,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",a=f(e,t,g(),w.location);u.confirmTransitionTo(a,r,n,(function(e){e&&(w.entries[w.index]=a,d({action:r,location:a}))}))},go:v,goBack:function(){v(-1)},goForward:function(){v(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(9185),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},o={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},l={};function s(e){return r.isMemo(e)?i:l[e.$$typeof]||a}l[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},l[r.Memo]=i;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var a=f(n);a&&a!==m&&e(t,a,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var l=s(t),g=s(n),h=0;h{"use strict";e.exports=function(e,t,n,r,a,o,i,l){if(!e){var s;if(void 0===t)s=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var c=[n,r,a,o,i,l],u=0;(s=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw s.framesToPop=1,s}}},5182:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},8312:function(e){e.exports=function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n1&&void 0!==arguments[1])||arguments[1],a=arguments.length>2&&void 0!==arguments[2]?arguments[2]:[],o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:5e3;t(this,e),this.ctx=n,this.iframes=r,this.exclude=a,this.iframesTimeout=o}return n(e,[{key:"getContexts",value:function(){var e=[];return(void 0!==this.ctx&&this.ctx?NodeList.prototype.isPrototypeOf(this.ctx)?Array.prototype.slice.call(this.ctx):Array.isArray(this.ctx)?this.ctx:"string"==typeof this.ctx?Array.prototype.slice.call(document.querySelectorAll(this.ctx)):[this.ctx]:[]).forEach((function(t){var n=e.filter((function(e){return e.contains(t)})).length>0;-1!==e.indexOf(t)||n||e.push(t)})),e}},{key:"getIframeContents",value:function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:function(){},r=void 0;try{var a=e.contentWindow;if(r=a.document,!a||!r)throw new Error("iframe inaccessible")}catch(o){n()}r&&t(r)}},{key:"isIframeBlank",value:function(e){var t="about:blank",n=e.getAttribute("src").trim();return e.contentWindow.location.href===t&&n!==t&&n}},{key:"observeIframeLoad",value:function(e,t,n){var r=this,a=!1,o=null,i=function i(){if(!a){a=!0,clearTimeout(o);try{r.isIframeBlank(e)||(e.removeEventListener("load",i),r.getIframeContents(e,t,n))}catch(l){n()}}};e.addEventListener("load",i),o=setTimeout(i,this.iframesTimeout)}},{key:"onIframeReady",value:function(e,t,n){try{"complete"===e.contentWindow.document.readyState?this.isIframeBlank(e)?this.observeIframeLoad(e,t,n):this.getIframeContents(e,t,n):this.observeIframeLoad(e,t,n)}catch(r){n()}}},{key:"waitForIframes",value:function(e,t){var n=this,r=0;this.forEachIframe(e,(function(){return!0}),(function(e){r++,n.waitForIframes(e.querySelector("html"),(function(){--r||t()}))}),(function(e){e||t()}))}},{key:"forEachIframe",value:function(t,n,r){var a=this,o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},i=t.querySelectorAll("iframe"),l=i.length,s=0;i=Array.prototype.slice.call(i);var c=function(){--l<=0&&o(s)};l||c(),i.forEach((function(t){e.matches(t,a.exclude)?c():a.onIframeReady(t,(function(e){n(t)&&(s++,r(e)),c()}),c)}))}},{key:"createIterator",value:function(e,t,n){return document.createNodeIterator(e,t,n,!1)}},{key:"createInstanceOnIframe",value:function(t){return new e(t.querySelector("html"),this.iframes)}},{key:"compareNodeIframe",value:function(e,t,n){if(e.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_PRECEDING){if(null===t)return!0;if(t.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_FOLLOWING)return!0}return!1}},{key:"getIteratorNode",value:function(e){var t=e.previousNode();return{prevNode:t,node:(null===t||e.nextNode())&&e.nextNode()}}},{key:"checkIframeFilter",value:function(e,t,n,r){var a=!1,o=!1;return r.forEach((function(e,t){e.val===n&&(a=t,o=e.handled)})),this.compareNodeIframe(e,t,n)?(!1!==a||o?!1===a||o||(r[a].handled=!0):r.push({val:n,handled:!0}),!0):(!1===a&&r.push({val:n,handled:!1}),!1)}},{key:"handleOpenIframes",value:function(e,t,n,r){var a=this;e.forEach((function(e){e.handled||a.getIframeContents(e.val,(function(e){a.createInstanceOnIframe(e).forEachNode(t,n,r)}))}))}},{key:"iterateThroughNodes",value:function(e,t,n,r,a){for(var o=this,i=this.createIterator(t,e,r),l=[],s=[],c=void 0,u=void 0,d=function(){var e=o.getIteratorNode(i);return u=e.prevNode,c=e.node};d();)this.iframes&&this.forEachIframe(t,(function(e){return o.checkIframeFilter(c,u,e,l)}),(function(t){o.createInstanceOnIframe(t).forEachNode(e,(function(e){return s.push(e)}),r)})),s.push(c);s.forEach((function(e){n(e)})),this.iframes&&this.handleOpenIframes(l,e,n,r),a()}},{key:"forEachNode",value:function(e,t,n){var r=this,a=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},o=this.getContexts(),i=o.length;i||a(),o.forEach((function(o){var l=function(){r.iterateThroughNodes(e,o,t,n,(function(){--i<=0&&a()}))};r.iframes?r.waitForIframes(o,l):l()}))}}],[{key:"matches",value:function(e,t){var n="string"==typeof t?[t]:t,r=e.matches||e.matchesSelector||e.msMatchesSelector||e.mozMatchesSelector||e.oMatchesSelector||e.webkitMatchesSelector;if(r){var a=!1;return n.every((function(t){return!r.call(e,t)||(a=!0,!1)})),a}return!1}}]),e}(),o=function(){function o(e){t(this,o),this.ctx=e,this.ie=!1;var n=window.navigator.userAgent;(n.indexOf("MSIE")>-1||n.indexOf("Trident")>-1)&&(this.ie=!0)}return n(o,[{key:"log",value:function(t){var n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"debug",r=this.opt.log;this.opt.debug&&"object"===(void 0===r?"undefined":e(r))&&"function"==typeof r[n]&&r[n]("mark.js: "+t)}},{key:"escapeStr",value:function(e){return e.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g,"\\$&")}},{key:"createRegExp",value:function(e){return"disabled"!==this.opt.wildcards&&(e=this.setupWildcardsRegExp(e)),e=this.escapeStr(e),Object.keys(this.opt.synonyms).length&&(e=this.createSynonymsRegExp(e)),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),this.opt.diacritics&&(e=this.createDiacriticsRegExp(e)),e=this.createMergedBlanksRegExp(e),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.createJoinersRegExp(e)),"disabled"!==this.opt.wildcards&&(e=this.createWildcardsRegExp(e)),e=this.createAccuracyRegExp(e)}},{key:"createSynonymsRegExp",value:function(e){var t=this.opt.synonyms,n=this.opt.caseSensitive?"":"i",r=this.opt.ignoreJoiners||this.opt.ignorePunctuation.length?"\0":"";for(var a in t)if(t.hasOwnProperty(a)){var o=t[a],i="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(a):this.escapeStr(a),l="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(o):this.escapeStr(o);""!==i&&""!==l&&(e=e.replace(new RegExp("("+this.escapeStr(i)+"|"+this.escapeStr(l)+")","gm"+n),r+"("+this.processSynomyms(i)+"|"+this.processSynomyms(l)+")"+r))}return e}},{key:"processSynomyms",value:function(e){return(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),e}},{key:"setupWildcardsRegExp",value:function(e){return(e=e.replace(/(?:\\)*\?/g,(function(e){return"\\"===e.charAt(0)?"?":"\x01"}))).replace(/(?:\\)*\*/g,(function(e){return"\\"===e.charAt(0)?"*":"\x02"}))}},{key:"createWildcardsRegExp",value:function(e){var t="withSpaces"===this.opt.wildcards;return e.replace(/\u0001/g,t?"[\\S\\s]?":"\\S?").replace(/\u0002/g,t?"[\\S\\s]*?":"\\S*")}},{key:"setupIgnoreJoinersRegExp",value:function(e){return e.replace(/[^(|)\\]/g,(function(e,t,n){var r=n.charAt(t+1);return/[(|)\\]/.test(r)||""===r?e:e+"\0"}))}},{key:"createJoinersRegExp",value:function(e){var t=[],n=this.opt.ignorePunctuation;return Array.isArray(n)&&n.length&&t.push(this.escapeStr(n.join(""))),this.opt.ignoreJoiners&&t.push("\\u00ad\\u200b\\u200c\\u200d"),t.length?e.split(/\u0000+/).join("["+t.join("")+"]*"):e}},{key:"createDiacriticsRegExp",value:function(e){var t=this.opt.caseSensitive?"":"i",n=this.opt.caseSensitive?["a\xe0\xe1\u1ea3\xe3\u1ea1\u0103\u1eb1\u1eaf\u1eb3\u1eb5\u1eb7\xe2\u1ea7\u1ea5\u1ea9\u1eab\u1ead\xe4\xe5\u0101\u0105","A\xc0\xc1\u1ea2\xc3\u1ea0\u0102\u1eb0\u1eae\u1eb2\u1eb4\u1eb6\xc2\u1ea6\u1ea4\u1ea8\u1eaa\u1eac\xc4\xc5\u0100\u0104","c\xe7\u0107\u010d","C\xc7\u0106\u010c","d\u0111\u010f","D\u0110\u010e","e\xe8\xe9\u1ebb\u1ebd\u1eb9\xea\u1ec1\u1ebf\u1ec3\u1ec5\u1ec7\xeb\u011b\u0113\u0119","E\xc8\xc9\u1eba\u1ebc\u1eb8\xca\u1ec0\u1ebe\u1ec2\u1ec4\u1ec6\xcb\u011a\u0112\u0118","i\xec\xed\u1ec9\u0129\u1ecb\xee\xef\u012b","I\xcc\xcd\u1ec8\u0128\u1eca\xce\xcf\u012a","l\u0142","L\u0141","n\xf1\u0148\u0144","N\xd1\u0147\u0143","o\xf2\xf3\u1ecf\xf5\u1ecd\xf4\u1ed3\u1ed1\u1ed5\u1ed7\u1ed9\u01a1\u1edf\u1ee1\u1edb\u1edd\u1ee3\xf6\xf8\u014d","O\xd2\xd3\u1ece\xd5\u1ecc\xd4\u1ed2\u1ed0\u1ed4\u1ed6\u1ed8\u01a0\u1ede\u1ee0\u1eda\u1edc\u1ee2\xd6\xd8\u014c","r\u0159","R\u0158","s\u0161\u015b\u0219\u015f","S\u0160\u015a\u0218\u015e","t\u0165\u021b\u0163","T\u0164\u021a\u0162","u\xf9\xfa\u1ee7\u0169\u1ee5\u01b0\u1eeb\u1ee9\u1eed\u1eef\u1ef1\xfb\xfc\u016f\u016b","U\xd9\xda\u1ee6\u0168\u1ee4\u01af\u1eea\u1ee8\u1eec\u1eee\u1ef0\xdb\xdc\u016e\u016a","y\xfd\u1ef3\u1ef7\u1ef9\u1ef5\xff","Y\xdd\u1ef2\u1ef6\u1ef8\u1ef4\u0178","z\u017e\u017c\u017a","Z\u017d\u017b\u0179"]:["a\xe0\xe1\u1ea3\xe3\u1ea1\u0103\u1eb1\u1eaf\u1eb3\u1eb5\u1eb7\xe2\u1ea7\u1ea5\u1ea9\u1eab\u1ead\xe4\xe5\u0101\u0105A\xc0\xc1\u1ea2\xc3\u1ea0\u0102\u1eb0\u1eae\u1eb2\u1eb4\u1eb6\xc2\u1ea6\u1ea4\u1ea8\u1eaa\u1eac\xc4\xc5\u0100\u0104","c\xe7\u0107\u010dC\xc7\u0106\u010c","d\u0111\u010fD\u0110\u010e","e\xe8\xe9\u1ebb\u1ebd\u1eb9\xea\u1ec1\u1ebf\u1ec3\u1ec5\u1ec7\xeb\u011b\u0113\u0119E\xc8\xc9\u1eba\u1ebc\u1eb8\xca\u1ec0\u1ebe\u1ec2\u1ec4\u1ec6\xcb\u011a\u0112\u0118","i\xec\xed\u1ec9\u0129\u1ecb\xee\xef\u012bI\xcc\xcd\u1ec8\u0128\u1eca\xce\xcf\u012a","l\u0142L\u0141","n\xf1\u0148\u0144N\xd1\u0147\u0143","o\xf2\xf3\u1ecf\xf5\u1ecd\xf4\u1ed3\u1ed1\u1ed5\u1ed7\u1ed9\u01a1\u1edf\u1ee1\u1edb\u1edd\u1ee3\xf6\xf8\u014dO\xd2\xd3\u1ece\xd5\u1ecc\xd4\u1ed2\u1ed0\u1ed4\u1ed6\u1ed8\u01a0\u1ede\u1ee0\u1eda\u1edc\u1ee2\xd6\xd8\u014c","r\u0159R\u0158","s\u0161\u015b\u0219\u015fS\u0160\u015a\u0218\u015e","t\u0165\u021b\u0163T\u0164\u021a\u0162","u\xf9\xfa\u1ee7\u0169\u1ee5\u01b0\u1eeb\u1ee9\u1eed\u1eef\u1ef1\xfb\xfc\u016f\u016bU\xd9\xda\u1ee6\u0168\u1ee4\u01af\u1eea\u1ee8\u1eec\u1eee\u1ef0\xdb\xdc\u016e\u016a","y\xfd\u1ef3\u1ef7\u1ef9\u1ef5\xffY\xdd\u1ef2\u1ef6\u1ef8\u1ef4\u0178","z\u017e\u017c\u017aZ\u017d\u017b\u0179"],r=[];return e.split("").forEach((function(a){n.every((function(n){if(-1!==n.indexOf(a)){if(r.indexOf(n)>-1)return!1;e=e.replace(new RegExp("["+n+"]","gm"+t),"["+n+"]"),r.push(n)}return!0}))})),e}},{key:"createMergedBlanksRegExp",value:function(e){return e.replace(/[\s]+/gim,"[\\s]+")}},{key:"createAccuracyRegExp",value:function(e){var t=this,n="!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~\xa1\xbf",r=this.opt.accuracy,a="string"==typeof r?r:r.value,o="string"==typeof r?[]:r.limiters,i="";switch(o.forEach((function(e){i+="|"+t.escapeStr(e)})),a){case"partially":default:return"()("+e+")";case"complementary":return"()([^"+(i="\\s"+(i||this.escapeStr(n)))+"]*"+e+"[^"+i+"]*)";case"exactly":return"(^|\\s"+i+")("+e+")(?=$|\\s"+i+")"}}},{key:"getSeparatedKeywords",value:function(e){var t=this,n=[];return e.forEach((function(e){t.opt.separateWordSearch?e.split(" ").forEach((function(e){e.trim()&&-1===n.indexOf(e)&&n.push(e)})):e.trim()&&-1===n.indexOf(e)&&n.push(e)})),{keywords:n.sort((function(e,t){return t.length-e.length})),length:n.length}}},{key:"isNumeric",value:function(e){return Number(parseFloat(e))==e}},{key:"checkRanges",value:function(e){var t=this;if(!Array.isArray(e)||"[object Object]"!==Object.prototype.toString.call(e[0]))return this.log("markRanges() will only accept an array of objects"),this.opt.noMatch(e),[];var n=[],r=0;return e.sort((function(e,t){return e.start-t.start})).forEach((function(e){var a=t.callNoMatchOnInvalidRanges(e,r),o=a.start,i=a.end;a.valid&&(e.start=o,e.length=i-o,n.push(e),r=i)})),n}},{key:"callNoMatchOnInvalidRanges",value:function(e,t){var n=void 0,r=void 0,a=!1;return e&&void 0!==e.start?(r=(n=parseInt(e.start,10))+parseInt(e.length,10),this.isNumeric(e.start)&&this.isNumeric(e.length)&&r-t>0&&r-n>0?a=!0:(this.log("Ignoring invalid or overlapping range: "+JSON.stringify(e)),this.opt.noMatch(e))):(this.log("Ignoring invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:n,end:r,valid:a}}},{key:"checkWhitespaceRanges",value:function(e,t,n){var r=void 0,a=!0,o=n.length,i=t-o,l=parseInt(e.start,10)-i;return(r=(l=l>o?o:l)+parseInt(e.length,10))>o&&(r=o,this.log("End range automatically set to the max value of "+o)),l<0||r-l<0||l>o||r>o?(a=!1,this.log("Invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)):""===n.substring(l,r).replace(/\s+/g,"")&&(a=!1,this.log("Skipping whitespace only range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:l,end:r,valid:a}}},{key:"getTextNodes",value:function(e){var t=this,n="",r=[];this.iterator.forEachNode(NodeFilter.SHOW_TEXT,(function(e){r.push({start:n.length,end:(n+=e.textContent).length,node:e})}),(function(e){return t.matchesExclude(e.parentNode)?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT}),(function(){e({value:n,nodes:r})}))}},{key:"matchesExclude",value:function(e){return a.matches(e,this.opt.exclude.concat(["script","style","title","head","html"]))}},{key:"wrapRangeInTextNode",value:function(e,t,n){var r=this.opt.element?this.opt.element:"mark",a=e.splitText(t),o=a.splitText(n-t),i=document.createElement(r);return i.setAttribute("data-markjs","true"),this.opt.className&&i.setAttribute("class",this.opt.className),i.textContent=a.textContent,a.parentNode.replaceChild(i,a),o}},{key:"wrapRangeInMappedTextNode",value:function(e,t,n,r,a){var o=this;e.nodes.every((function(i,l){var s=e.nodes[l+1];if(void 0===s||s.start>t){if(!r(i.node))return!1;var c=t-i.start,u=(n>i.end?i.end:n)-i.start,d=e.value.substr(0,i.start),p=e.value.substr(u+i.start);if(i.node=o.wrapRangeInTextNode(i.node,c,u),e.value=d+p,e.nodes.forEach((function(t,n){n>=l&&(e.nodes[n].start>0&&n!==l&&(e.nodes[n].start-=u),e.nodes[n].end-=u)})),n-=u,a(i.node.previousSibling,i.start),!(n>i.end))return!1;t=i.end}return!0}))}},{key:"wrapMatches",value:function(e,t,n,r,a){var o=this,i=0===t?0:t+1;this.getTextNodes((function(t){t.nodes.forEach((function(t){t=t.node;for(var a=void 0;null!==(a=e.exec(t.textContent))&&""!==a[i];)if(n(a[i],t)){var l=a.index;if(0!==i)for(var s=1;s{"use strict";n.r(t)},142:(e,t,n)=>{"use strict";n.r(t)},8504:function(e,t,n){var r,a;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function a(e,t,n){return en?n:e}function o(e){return 100*(-1+e)}function i(e,t,n){var a;return(a="translate3d"===r.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,a}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=a(e,r.minimum,1),n.status=1===e?null:e;var o=n.render(!t),c=o.querySelector(r.barSelector),u=r.speed,d=r.easing;return o.offsetWidth,l((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(c,i(e,u,d)),1===e?(s(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){s(o,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*a(Math.random()*t,.1,.95)),t=a(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var a,i=t.querySelector(r.barSelector),l=e?"-100":o(n.status||0),c=document.querySelector(r.parent);return s(i,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(a=t.querySelector(r.spinnerSelector))&&f(a),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var l=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),s=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,a=e.length,o=t.charAt(0).toUpperCase()+t.slice(1);a--;)if((r=e[a]+o)in n)return r;return t}function a(e){return e=n(e),t[e]||(t[e]=r(e))}function o(e,t,n){t=a(t),e.style[t]=n}return function(e,t){var n,r,a=arguments;if(2==a.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&o(e,n,r);else o(e,a[1],a[2])}}();function c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(a="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=a)},9911:e=>{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},3916:(e,t,n)=>{const r=n(9911),a=n(4587),o=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...o,...Object.keys(Prism.languages)];a(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(3392).resolve(t)],delete Prism.languages[e],n(3392)(t),o.add(e)}))}i.silent=!1,e.exports=i},3109:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,o){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof o&&!o(e))return e;for(var a,l=i.length;-1!==n.code.indexOf(a=t(r,l));)++l;return i[l]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,o=Object.keys(n.tokenStack);!function i(l){for(var s=0;s=o.length);s++){var c=l[s];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=o[a],d=n.tokenStack[u],p="string"==typeof c?c:c.content,f=t(r,u),m=p.indexOf(f);if(m>-1){++a;var g=p.substring(0,m),h=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),y=p.substring(m+f.length),b=[];g&&b.push.apply(b,i([g])),b.push(h),y&&b.push.apply(b,i([y])),"string"==typeof c?l.splice.apply(l,[s,1].concat(b)):c.content=b}}else c.content&&i(c.content)}return l}(n.tokens)}}}})}(Prism)},3392:(e,t,n)=>{var r={"./":3916};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=3392},4587:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var l={},s=e[r];if(s){function c(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in l))for(var i in a(t,o),l[t]=!0,n[t])l[i]=!0}t(s.require,c),t(s.optional,c),t(s.modify,c)}n[r]=l,o.pop()}}return function(e){var t=n[e];return t||(a(e,r),t=n[e]),t}}function a(e){for(var t in e)return!0;return!1}return function(o,i,l){var s=function(e){var t={};for(var n in e){var r=e[n];for(var a in r)if("meta"!=a){var o=r[a];t[a]="string"==typeof o?{title:o}:o}}return t}(o),c=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var a in n={},e){var o=e[a];t(o&&o.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+a+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+a+" because it is a component.");n[t]=a}))}return n[r]||r}}(s);i=i.map(c),l=(l||[]).map(c);var u=n(i),d=n(l);i.forEach((function e(n){var r=s[n];t(r&&r.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var p,f=r(s),m=u;a(m);){for(var g in p={},m){var h=s[g];t(h&&h.modify,(function(e){e in d&&(p[e]=!0)}))}for(var y in d)if(!(y in u))for(var b in f(y))if(b in u){p[y]=!0;break}for(var v in m=p)u[v]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,a){var o=a?a.series:void 0,i=a?a.parallel:e,l={},s={};function c(e){if(e in l)return l[e];s[e]=!0;var a,u=[];for(var d in t(e))d in n&&u.push(d);if(0===u.length)a=r(e);else{var p=i(u.map((function(e){var t=c(e);return delete s[e],t})));o?a=o(p,(function(){return r(e)})):r(e)}return l[e]=a}for(var u in n)c(u);var d=[];for(var p in s)d.push(l[p]);return i(d)}(f,u,t,n)}};return w}}();e.exports=t},8772:(e,t,n)=>{"use strict";var r=n(331);function a(){}function o(){}o.resetWarningCache=a,e.exports=function(){function e(e,t,n,a,o,i){if(i!==r){var l=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw l.name="Invariant Violation",l}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:o,resetWarningCache:a};return n.PropTypes=n,n}},3615:(e,t,n)=>{e.exports=n(8772)()},331:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},3577:(e,t,n)=>{"use strict";var r=n(7378),a=n(3637);function o(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n