[{"data":1,"prerenderedAt":1370},["ShallowReactive",2],{"navigation_docs":3,"-contribute-writing-a-module-testing":587,"-contribute-writing-a-module-testing-surround":1365},[4,50,155,441,504],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":49},"Get Started","i-lucide-rocket","\u002Fget-started","1.get-started",[10,15,20,25,30,35,40,45],{"title":11,"path":12,"stem":13,"icon":14},"Introduction","\u002Fget-started\u002Fintroduction","1.get-started\u002F1.introduction","i-lucide-house",{"title":16,"path":17,"stem":18,"icon":19},"Installation","\u002Fget-started\u002Finstallation","1.get-started\u002F2.installation","i-lucide-download",{"title":21,"path":22,"stem":23,"icon":24},"Project structure","\u002Fget-started\u002Fproject-structure","1.get-started\u002F3.project-structure","i-lucide-folder-tree",{"title":26,"path":27,"stem":28,"icon":29},"Configuration","\u002Fget-started\u002Fconfiguration","1.get-started\u002F4.configuration","i-lucide-settings",{"title":31,"path":32,"stem":33,"icon":34},"Authentication","\u002Fget-started\u002Fauthentication","1.get-started\u002F5.authentication","i-lucide-lock",{"title":36,"path":37,"stem":38,"icon":39},"Adding modules","\u002Fget-started\u002Fadding-modules","1.get-started\u002F6.adding-modules","i-lucide-puzzle",{"title":41,"path":42,"stem":43,"icon":44},"Database","\u002Fget-started\u002Fdatabase","1.get-started\u002F7.database","i-lucide-database",{"title":46,"path":47,"stem":48,"icon":6},"Deployment","\u002Fget-started\u002Fdeployment","1.get-started\u002F8.deployment",false,{"title":51,"icon":52,"path":53,"stem":54,"children":55,"page":49},"Guide","i-lucide-book-open","\u002Fguide","2.guide",[56,90,115,125],{"title":57,"icon":49,"path":58,"stem":59,"children":60,"page":49},"Concepts","\u002Fguide\u002Fconcepts","2.guide\u002F1.concepts",[61,66,71,76,80,85],{"title":62,"path":63,"stem":64,"icon":65},"Architecture","\u002Fguide\u002Fconcepts\u002Farchitecture","2.guide\u002F1.concepts\u002F1.architecture","i-lucide-blocks",{"title":67,"path":68,"stem":69,"icon":70},"Access control","\u002Fguide\u002Fconcepts\u002Fauth-and-scopes","2.guide\u002F1.concepts\u002F2.auth-and-scopes","i-lucide-shield-check",{"title":72,"path":73,"stem":74,"icon":75},"Extension points","\u002Fguide\u002Fconcepts\u002Fextension-points","2.guide\u002F1.concepts\u002F3.extension-points","i-lucide-plug",{"title":77,"path":78,"stem":79,"icon":44},"Database extensions","\u002Fguide\u002Fconcepts\u002Fdatabase-extensions","2.guide\u002F1.concepts\u002F4.database-extensions",{"title":81,"path":82,"stem":83,"icon":84},"Identity","\u002Fguide\u002Fconcepts\u002Fidentity","2.guide\u002F1.concepts\u002F5.identity","i-lucide-fingerprint",{"title":86,"path":87,"stem":88,"icon":89},"Glossary","\u002Fguide\u002Fconcepts\u002Fglossary","2.guide\u002F1.concepts\u002F6.glossary","i-lucide-book-a",{"title":91,"icon":49,"path":92,"stem":93,"children":94,"page":49},"UX patterns","\u002Fguide\u002Fux-patterns","2.guide\u002F2.ux-patterns",[95,100,105,110],{"title":96,"path":97,"stem":98,"icon":99},"Layouts and navigation","\u002Fguide\u002Fux-patterns\u002Flayouts-and-navigation","2.guide\u002F2.ux-patterns\u002F1.layouts-and-navigation","i-lucide-layout-template",{"title":101,"path":102,"stem":103,"icon":104},"Pages","\u002Fguide\u002Fux-patterns\u002Fpages","2.guide\u002F2.ux-patterns\u002F2.pages","i-lucide-table",{"title":106,"path":107,"stem":108,"icon":109},"Forms and actions","\u002Fguide\u002Fux-patterns\u002Fforms-and-actions","2.guide\u002F2.ux-patterns\u002F3.forms-and-actions","i-lucide-square-pen",{"title":111,"path":112,"stem":113,"icon":114},"Text and formatting","\u002Fguide\u002Fux-patterns\u002Ftext-and-formatting","2.guide\u002F2.ux-patterns\u002F4.text-and-formatting","i-lucide-type",{"title":116,"icon":49,"path":117,"stem":118,"children":119,"page":49},"Best practices","\u002Fguide\u002Fbest-practices","2.guide\u002F3.best-practices",[120],{"title":121,"path":122,"stem":123,"icon":124},"HTTP routes","\u002Fguide\u002Fbest-practices\u002Fhttp-routes","2.guide\u002F3.best-practices\u002F1.http-routes","i-lucide-route",{"title":126,"icon":49,"path":127,"stem":128,"children":129,"page":49},"Going further","\u002Fguide\u002Fgoing-further","2.guide\u002F4.going-further",[130,135,140,145,150],{"title":131,"path":132,"stem":133,"icon":134},"Use your own OAuth server","\u002Fguide\u002Fgoing-further\u002Fown-oauth-server","2.guide\u002F4.going-further\u002F1.own-oauth-server","i-lucide-key-round",{"title":136,"path":137,"stem":138,"icon":139},"Create an OAuth application","\u002Fguide\u002Fgoing-further\u002Foauth-application","2.guide\u002F4.going-further\u002F2.oauth-application","i-lucide-app-window",{"title":141,"path":142,"stem":143,"icon":144},"Signing keys","\u002Fguide\u002Fgoing-further\u002Fsigning-keys","2.guide\u002F4.going-further\u002F3.signing-keys","i-lucide-key-square",{"title":146,"path":147,"stem":148,"icon":149},"Stripe setup","\u002Fguide\u002Fgoing-further\u002Fstripe-setup","2.guide\u002F4.going-further\u002F4.stripe-setup","i-lucide-credit-card",{"title":151,"path":152,"stem":153,"icon":154},"Migrate to the permission model","\u002Fguide\u002Fgoing-further\u002Fmigrate-access-control","2.guide\u002F4.going-further\u002F5.migrate-access-control","i-lucide-arrow-right-left",{"title":156,"icon":157,"path":158,"stem":159,"children":160},"Modules","i-lucide-boxes","\u002Fmodules","3.modules",[161,163,244,273,320,375],{"title":156,"path":158,"stem":162},"3.modules\u002Findex",{"title":81,"icon":49,"path":164,"stem":165,"children":166,"page":49},"\u002Fmodules\u002Fidentity","3.modules\u002F1.identity",[167,190,194,198,220,224,240],{"title":168,"path":169,"stem":170,"children":171},"Auth","\u002Fmodules\u002Fidentity\u002Fauth","3.modules\u002F1.identity\u002F1.auth\u002Findex",[172,174,178,182,186],{"title":173,"path":169,"stem":170},"Overview",{"title":175,"path":176,"stem":177},"Server API","\u002Fmodules\u002Fidentity\u002Fauth\u002Fserver","3.modules\u002F1.identity\u002F1.auth\u002F2.server",{"title":179,"path":180,"stem":181},"Reference","\u002Fmodules\u002Fidentity\u002Fauth\u002Freference","3.modules\u002F1.identity\u002F1.auth\u002F3.reference",{"title":183,"path":184,"stem":185},"Client mode","\u002Fmodules\u002Fidentity\u002Fauth\u002Fclient-mode","3.modules\u002F1.identity\u002F1.auth\u002F4.client-mode",{"title":187,"path":188,"stem":189},"OAuth providers","\u002Fmodules\u002Fidentity\u002Fauth\u002Foauth-providers","3.modules\u002F1.identity\u002F1.auth\u002F5.oauth-providers",{"title":191,"path":192,"stem":193},"Users","\u002Fmodules\u002Fidentity\u002Fusers","3.modules\u002F1.identity\u002F2.users",{"title":195,"path":196,"stem":197},"Account","\u002Fmodules\u002Fidentity\u002Faccount","3.modules\u002F1.identity\u002F3.account",{"title":199,"path":200,"stem":201,"children":202},"Authorization","\u002Fmodules\u002Fidentity\u002Fauthorization","3.modules\u002F1.identity\u002F4.authorization\u002Findex",[203,204,208,212,216],{"title":173,"path":200,"stem":201},{"title":205,"path":206,"stem":207},"Roles and requirements","\u002Fmodules\u002Fidentity\u002Fauthorization\u002Froles-and-requirements","3.modules\u002F1.identity\u002F4.authorization\u002F2.roles-and-requirements",{"title":209,"path":210,"stem":211},"Policies","\u002Fmodules\u002Fidentity\u002Fauthorization\u002Fpolicies","3.modules\u002F1.identity\u002F4.authorization\u002F3.policies",{"title":213,"path":214,"stem":215},"Client","\u002Fmodules\u002Fidentity\u002Fauthorization\u002Fclient","3.modules\u002F1.identity\u002F4.authorization\u002F4.client",{"title":217,"path":218,"stem":219},"Admin","\u002Fmodules\u002Fidentity\u002Fauthorization\u002Fadmin","3.modules\u002F1.identity\u002F4.authorization\u002F5.admin",{"title":221,"path":222,"stem":223},"Preferences","\u002Fmodules\u002Fidentity\u002Fpreferences","3.modules\u002F1.identity\u002F5.preferences",{"title":225,"path":226,"stem":227,"children":228},"OAuth Server","\u002Fmodules\u002Fidentity\u002Foauth-server","3.modules\u002F1.identity\u002F6.oauth-server\u002Findex",[229,230,233,237],{"title":173,"path":226,"stem":227},{"title":175,"path":231,"stem":232},"\u002Fmodules\u002Fidentity\u002Foauth-server\u002Fserver","3.modules\u002F1.identity\u002F6.oauth-server\u002F2.server",{"title":234,"path":235,"stem":236},"Hooks","\u002Fmodules\u002Fidentity\u002Foauth-server\u002Fhooks","3.modules\u002F1.identity\u002F6.oauth-server\u002F3.hooks",{"title":179,"path":238,"stem":239},"\u002Fmodules\u002Fidentity\u002Foauth-server\u002Froutes-and-clients","3.modules\u002F1.identity\u002F6.oauth-server\u002F4.routes-and-clients",{"title":241,"path":242,"stem":243},"OAuth Resource","\u002Fmodules\u002Fidentity\u002Foauth-resource","3.modules\u002F1.identity\u002F8.oauth-resource",{"title":245,"icon":49,"path":246,"stem":247,"children":248,"page":49},"Commerce","\u002Fmodules\u002Fcommerce","3.modules\u002F2.commerce",[249,253,257],{"title":250,"path":251,"stem":252},"Stripe","\u002Fmodules\u002Fcommerce\u002Fstripe","3.modules\u002F2.commerce\u002F1.stripe",{"title":254,"path":255,"stem":256},"Payments","\u002Fmodules\u002Fcommerce\u002Fpayments","3.modules\u002F2.commerce\u002F2.payments",{"title":258,"path":259,"stem":260,"children":261},"Subscriptions","\u002Fmodules\u002Fcommerce\u002Fsubscriptions","3.modules\u002F2.commerce\u002F3.subscriptions\u002Findex",[262,263,266,270],{"title":173,"path":259,"stem":260},{"title":175,"path":264,"stem":265},"\u002Fmodules\u002Fcommerce\u002Fsubscriptions\u002Fserver","3.modules\u002F2.commerce\u002F3.subscriptions\u002F2.server",{"title":267,"path":268,"stem":269},"App","\u002Fmodules\u002Fcommerce\u002Fsubscriptions\u002Fapp","3.modules\u002F2.commerce\u002F3.subscriptions\u002F3.app",{"title":179,"path":271,"stem":272},"\u002Fmodules\u002Fcommerce\u002Fsubscriptions\u002Freference","3.modules\u002F2.commerce\u002F3.subscriptions\u002F4.reference",{"title":274,"icon":49,"path":275,"stem":276,"children":277,"page":49},"Features","\u002Fmodules\u002Ffeatures","3.modules\u002F3.features",[278,293,312,316],{"title":279,"path":280,"stem":281,"children":282},"Events","\u002Fmodules\u002Ffeatures\u002Fevents","3.modules\u002F3.features\u002F1.events\u002Findex",[283,284,287,290],{"title":173,"path":280,"stem":281},{"title":175,"path":285,"stem":286},"\u002Fmodules\u002Ffeatures\u002Fevents\u002Fserver","3.modules\u002F3.features\u002F1.events\u002F2.server",{"title":267,"path":288,"stem":289},"\u002Fmodules\u002Ffeatures\u002Fevents\u002Fapp","3.modules\u002F3.features\u002F1.events\u002F3.app",{"title":179,"path":291,"stem":292},"\u002Fmodules\u002Ffeatures\u002Fevents\u002Freference","3.modules\u002F3.features\u002F1.events\u002F4.reference",{"title":294,"path":295,"stem":296,"children":297},"Forms","\u002Fmodules\u002Ffeatures\u002Fforms","3.modules\u002F3.features\u002F2.forms\u002Findex",[298,299,303,306,309],{"title":173,"path":295,"stem":296},{"title":300,"path":301,"stem":302},"Definition","\u002Fmodules\u002Ffeatures\u002Fforms\u002Fdefinition","3.modules\u002F3.features\u002F2.forms\u002F2.definition",{"title":175,"path":304,"stem":305},"\u002Fmodules\u002Ffeatures\u002Fforms\u002Fserver","3.modules\u002F3.features\u002F2.forms\u002F3.server",{"title":267,"path":307,"stem":308},"\u002Fmodules\u002Ffeatures\u002Fforms\u002Fapp","3.modules\u002F3.features\u002F2.forms\u002F4.app",{"title":179,"path":310,"stem":311},"\u002Fmodules\u002Ffeatures\u002Fforms\u002Freference","3.modules\u002F3.features\u002F2.forms\u002F5.reference",{"title":313,"path":314,"stem":315},"Cookie Consent","\u002Fmodules\u002Ffeatures\u002Fcookie-consent","3.modules\u002F3.features\u002F3.cookie-consent",{"title":317,"path":318,"stem":319},"MCP","\u002Fmodules\u002Ffeatures\u002Fmcp","3.modules\u002F3.features\u002F4.mcp",{"title":321,"icon":49,"path":322,"stem":323,"children":324,"page":49},"Interface","\u002Fmodules\u002Finterface","3.modules\u002F4.interface",[325,350,353,357,361],{"title":326,"path":327,"stem":328,"children":329},"UI","\u002Fmodules\u002Finterface\u002Fui","3.modules\u002F4.interface\u002F1.ui\u002Findex",[330,331,335,339,343,347],{"title":173,"path":327,"stem":328},{"title":332,"path":333,"stem":334},"Page components","\u002Fmodules\u002Finterface\u002Fui\u002Fpage-components","3.modules\u002F4.interface\u002F1.ui\u002F2.page-components",{"title":336,"path":337,"stem":338},"App shell","\u002Fmodules\u002Finterface\u002Fui\u002Fapp-shell","3.modules\u002F4.interface\u002F1.ui\u002F3.app-shell",{"title":340,"path":341,"stem":342},"Form inputs","\u002Fmodules\u002Finterface\u002Fui\u002Fform-inputs","3.modules\u002F4.interface\u002F1.ui\u002F4.form-inputs",{"title":344,"path":345,"stem":346},"Composables and helpers","\u002Fmodules\u002Finterface\u002Fui\u002Fcomposables","3.modules\u002F4.interface\u002F1.ui\u002F5.composables",{"title":179,"path":348,"stem":349},"\u002Fmodules\u002Finterface\u002Fui\u002Freference","3.modules\u002F4.interface\u002F1.ui\u002F6.reference",{"title":217,"path":351,"stem":352},"\u002Fmodules\u002Finterface\u002Fadmin","3.modules\u002F4.interface\u002F2.admin",{"title":354,"path":355,"stem":356},"Menu","\u002Fmodules\u002Finterface\u002Fmenu","3.modules\u002F4.interface\u002F3.menu",{"title":358,"path":359,"stem":360},"Widget","\u002Fmodules\u002Finterface\u002Fwidget","3.modules\u002F4.interface\u002F4.widget",{"title":362,"path":363,"stem":364,"children":365},"Mobile","\u002Fmodules\u002Finterface\u002Fmobile","3.modules\u002F4.interface\u002F5.mobile\u002Findex",[366,367,371],{"title":173,"path":363,"stem":364},{"title":368,"path":369,"stem":370},"CLI and devices","\u002Fmodules\u002Finterface\u002Fmobile\u002Fcli-and-devices","3.modules\u002F4.interface\u002F5.mobile\u002F2.cli-and-devices",{"title":372,"path":373,"stem":374},"Splash screen","\u002Fmodules\u002Finterface\u002Fmobile\u002Fsplash-screen","3.modules\u002F4.interface\u002F5.mobile\u002F3.splash-screen",{"title":376,"icon":49,"path":377,"stem":378,"children":379,"page":49},"Platform","\u002Fmodules\u002Fplatform","3.modules\u002F5.platform",[380,402,406,423],{"title":381,"path":382,"stem":383,"children":384},"Module Kit","\u002Fmodules\u002Fplatform\u002Fmodule-kit","3.modules\u002F5.platform\u002F1.module-kit\u002Findex",[385,386,390,394,398],{"title":173,"path":382,"stem":383},{"title":387,"path":388,"stem":389},"Server toolkit","\u002Fmodules\u002Fplatform\u002Fmodule-kit\u002Fserver-toolkit","3.modules\u002F5.platform\u002F1.module-kit\u002F2.server-toolkit",{"title":391,"path":392,"stem":393},"Registries and menus","\u002Fmodules\u002Fplatform\u002Fmodule-kit\u002Fregistries-and-menus","3.modules\u002F5.platform\u002F1.module-kit\u002F3.registries-and-menus",{"title":395,"path":396,"stem":397},"Translations","\u002Fmodules\u002Fplatform\u002Fmodule-kit\u002Fi18n","3.modules\u002F5.platform\u002F1.module-kit\u002F4.i18n",{"title":399,"path":400,"stem":401},"Database helpers","\u002Fmodules\u002Fplatform\u002Fmodule-kit\u002Fdatabase","3.modules\u002F5.platform\u002F1.module-kit\u002F5.database",{"title":403,"path":404,"stem":405},"Notify","\u002Fmodules\u002Fplatform\u002Fnotify","3.modules\u002F5.platform\u002F2.notify",{"title":407,"path":408,"stem":409,"children":410},"Email Templates","\u002Fmodules\u002Fplatform\u002Femail-templates","3.modules\u002F5.platform\u002F3.email-templates\u002Findex",[411,412,416,419],{"title":173,"path":408,"stem":409},{"title":413,"path":414,"stem":415},"Email components","\u002Fmodules\u002Fplatform\u002Femail-templates\u002Fcomponents","3.modules\u002F5.platform\u002F3.email-templates\u002F2.components",{"title":175,"path":417,"stem":418},"\u002Fmodules\u002Fplatform\u002Femail-templates\u002Fserver","3.modules\u002F5.platform\u002F3.email-templates\u002F3.server",{"title":420,"path":421,"stem":422},"Module emails","\u002Fmodules\u002Fplatform\u002Femail-templates\u002Fmodule-emails","3.modules\u002F5.platform\u002F3.email-templates\u002F4.module-emails",{"title":424,"path":425,"stem":426,"children":427},"Base Layer","\u002Fmodules\u002Fplatform\u002Fbase-layer","3.modules\u002F5.platform\u002F4.base-layer\u002Findex",[428,429,433,437],{"title":173,"path":425,"stem":426},{"title":430,"path":431,"stem":432},"Content collections","\u002Fmodules\u002Fplatform\u002Fbase-layer\u002Fcontent-collections","3.modules\u002F5.platform\u002F4.base-layer\u002F2.content-collections",{"title":434,"path":435,"stem":436},"Layouts and routing","\u002Fmodules\u002Fplatform\u002Fbase-layer\u002Flayouts-and-routing","3.modules\u002F5.platform\u002F4.base-layer\u002F3.layouts-and-routing",{"title":438,"path":439,"stem":440},"Composables and utils","\u002Fmodules\u002Fplatform\u002Fbase-layer\u002Fcomposables-and-utils","3.modules\u002F5.platform\u002F4.base-layer\u002F4.composables-and-utils",{"title":442,"icon":443,"path":444,"stem":445,"children":446,"page":49},"Examples","i-lucide-code-xml","\u002Fexamples","4.examples",[447,466,476],{"title":448,"icon":49,"path":449,"stem":450,"children":451,"page":49},"Starters","\u002Fexamples\u002Fstarters","4.examples\u002F1.starters",[452,456,461],{"title":453,"path":454,"stem":455,"icon":6},"Workspace starter","\u002Fexamples\u002Fstarters\u002Fworkspace","4.examples\u002F1.starters\u002F1.workspace",{"title":457,"path":458,"stem":459,"icon":460},"Mobile starter","\u002Fexamples\u002Fstarters\u002Fmobile","4.examples\u002F1.starters\u002F2.mobile","i-lucide-smartphone",{"title":462,"path":463,"stem":464,"icon":465},"Standalone mobile starter","\u002Fexamples\u002Fstarters\u002Fmobile-standalone","4.examples\u002F1.starters\u002F3.mobile-standalone","i-lucide-tablet-smartphone",{"title":467,"icon":49,"path":468,"stem":469,"children":470,"page":49},"Apps","\u002Fexamples\u002Fapps","4.examples\u002F2.apps",[471],{"title":472,"path":473,"stem":474,"icon":475},"Frigear website app","\u002Fexamples\u002Fapps\u002Ffrigear-nu-website","4.examples\u002F2.apps\u002F1.frigear-nu-website","i-lucide-layout-dashboard",{"title":477,"icon":49,"path":478,"stem":479,"children":480,"page":49},"Tasks","\u002Fexamples\u002Ftasks","4.examples\u002F3.tasks",[481,485,489,494,499],{"title":482,"path":483,"stem":484,"icon":70},"Protect a route","\u002Fexamples\u002Ftasks\u002Fprotect-a-route","4.examples\u002F3.tasks\u002F1.protect-a-route",{"title":486,"path":487,"stem":488,"icon":475},"Add an admin page","\u002Fexamples\u002Ftasks\u002Fadd-an-admin-page","4.examples\u002F3.tasks\u002F2.add-an-admin-page",{"title":490,"path":491,"stem":492,"icon":493},"Sell event tickets","\u002Fexamples\u002Ftasks\u002Fsell-event-tickets","4.examples\u002F3.tasks\u002F3.sell-event-tickets","i-lucide-ticket",{"title":495,"path":496,"stem":497,"icon":498},"Build a form","\u002Fexamples\u002Ftasks\u002Fbuild-a-form","4.examples\u002F3.tasks\u002F4.build-a-form","i-lucide-clipboard-list",{"title":500,"path":501,"stem":502,"icon":503},"Send an email","\u002Fexamples\u002Ftasks\u002Fsend-an-email","4.examples\u002F3.tasks\u002F5.send-an-email","i-lucide-mail",{"title":505,"icon":506,"path":507,"stem":508,"children":509,"page":49},"Contribute","i-lucide-git-pull-request","\u002Fcontribute","5.contribute",[510,513,518,544,549,552,556,571],{"title":173,"path":511,"stem":512,"icon":506},"\u002Fcontribute\u002Foverview","5.contribute\u002F1.overview",{"title":514,"path":515,"stem":516,"icon":517},"Local development","\u002Fcontribute\u002Flocal-development","5.contribute\u002F2.local-development","i-lucide-terminal",{"title":519,"icon":49,"path":520,"stem":521,"children":522,"page":49},"Writing a module","\u002Fcontribute\u002Fwriting-a-module","5.contribute\u002F3.writing-a-module",[523,527,532,536,541],{"title":524,"path":525,"stem":526,"icon":39},"Scaffold a module","\u002Fcontribute\u002Fwriting-a-module\u002Fscaffold","5.contribute\u002F3.writing-a-module\u002F1.scaffold",{"title":528,"path":529,"stem":530,"icon":531},"Setup checklist","\u002Fcontribute\u002Fwriting-a-module\u002Fsetup-checklist","5.contribute\u002F3.writing-a-module\u002F2.setup-checklist","i-lucide-list-checks",{"title":533,"path":534,"stem":535,"icon":44},"Database tables","\u002Fcontribute\u002Fwriting-a-module\u002Fdatabase-tables","5.contribute\u002F3.writing-a-module\u002F3.database-tables",{"title":537,"path":538,"stem":539,"icon":540},"Testing","\u002Fcontribute\u002Fwriting-a-module\u002Ftesting","5.contribute\u002F3.writing-a-module\u002F4.testing","i-lucide-flask-conical",{"title":67,"path":542,"stem":543,"icon":70},"\u002Fcontribute\u002Fwriting-a-module\u002Faccess-control","5.contribute\u002F3.writing-a-module\u002F5.access-control",{"title":545,"path":546,"stem":547,"icon":548},"Publishing","\u002Fcontribute\u002Fpublishing","5.contribute\u002F4.publishing","i-lucide-package-check",{"title":448,"path":550,"stem":551,"icon":6},"\u002Fcontribute\u002Fstarters","5.contribute\u002F5.starters",{"title":553,"path":554,"stem":555,"icon":52},"Documentation","\u002Fcontribute\u002Fdocumentation","5.contribute\u002F6.documentation",{"title":557,"icon":49,"path":558,"stem":559,"children":560,"page":49},"Tooling","\u002Fcontribute\u002Ftooling","5.contribute\u002F7.tooling",[561,566],{"title":562,"path":563,"stem":564,"icon":565},"CLI","\u002Fcontribute\u002Ftooling\u002Fcli","5.contribute\u002F7.tooling\u002F1.cli","i-lucide-square-terminal",{"title":567,"path":568,"stem":569,"icon":570},"ESLint config","\u002Fcontribute\u002Ftooling\u002Feslint-config","5.contribute\u002F7.tooling\u002F2.eslint-config","i-lucide-spell-check",{"title":572,"icon":49,"path":573,"stem":574,"children":575},"Decisions","\u002Fcontribute\u002Fdecisions","5.contribute\u002F8.decisions\u002Findex",[576,578,583],{"title":572,"path":573,"stem":574,"icon":577},"i-lucide-scale",{"title":579,"path":580,"stem":581,"icon":582},"Session lifetimes per OAuth client","\u002Fcontribute\u002Fdecisions\u002Foauth-token-lifetimes","5.contribute\u002F8.decisions\u002F1.oauth-token-lifetimes","i-lucide-timer",{"title":584,"path":585,"stem":586,"icon":70},"One permission model","\u002Fcontribute\u002Fdecisions\u002Fpermission-model","5.contribute\u002F8.decisions\u002F2.permission-model",{"id":588,"title":537,"body":589,"description":1358,"extension":1359,"links":1360,"meta":1361,"navigation":1362,"path":538,"seo":1363,"stem":539,"__hash__":1364},"docs\u002F5.contribute\u002F3.writing-a-module\u002F4.testing.md",{"type":590,"value":591,"toc":1345},"minimark",[592,605,610,806,1065,1068,1101,1108,1112,1115,1164,1190,1194,1230,1238,1263,1267,1284,1288,1330,1334,1341],[593,594,595,596,600,601,604],"p",{},"This page is for module authors: how to boot your module in a test, test routes that need a database or a signed-in\nuser, and finish before a release. Tests run with Vitest and ",[597,598,599],"code",{},"@nuxt\u002Ftest-utils"," against test fixtures. A test fixture\nis a minimal Nuxt app under ",[597,602,603],{},"test\u002Ffixtures\u002F"," that installs your module from source, so a test can boot it.",[606,607,609],"h2",{"id":608},"write-a-test","Write a test",[611,612,618],"pre",{"className":613,"code":614,"filename":615,"language":616,"meta":617,"style":617},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import MyModule from '..\u002F..\u002F..\u002Fsrc\u002Fmodule'\n\nexport default defineNuxtConfig({\n  modules: ['@nuxthub\u002Fcore', MyModule],\n  runtimeConfig: { session: { password: 'a-test-only-session-password-at-least-32-chars' } },\n  hub: { db: { dialect: 'sqlite', driver: 'libsql', applyMigrationsDuringBuild: false } },\n})\n","test\u002Ffixtures\u002Fbasic\u002Fnuxt.config.ts","ts","",[597,619,620,647,654,673,703,739,797],{"__ignoreMap":617},[621,622,625,629,633,636,640,644],"span",{"class":623,"line":624},"line",1,[621,626,628],{"class":627},"s7zQu","import",[621,630,632],{"class":631},"sTEyZ"," MyModule ",[621,634,635],{"class":627},"from",[621,637,639],{"class":638},"sMK4o"," '",[621,641,643],{"class":642},"sfazB","..\u002F..\u002F..\u002Fsrc\u002Fmodule",[621,645,646],{"class":638},"'\n",[621,648,650],{"class":623,"line":649},2,[621,651,653],{"emptyLinePlaceholder":652},true,"\n",[621,655,657,660,663,667,670],{"class":623,"line":656},3,[621,658,659],{"class":627},"export",[621,661,662],{"class":627}," default",[621,664,666],{"class":665},"s2Zo4"," defineNuxtConfig",[621,668,669],{"class":631},"(",[621,671,672],{"class":638},"{\n",[621,674,676,680,683,686,689,692,694,697,700],{"class":623,"line":675},4,[621,677,679],{"class":678},"swJcz","  modules",[621,681,682],{"class":638},":",[621,684,685],{"class":631}," [",[621,687,688],{"class":638},"'",[621,690,691],{"class":642},"@nuxthub\u002Fcore",[621,693,688],{"class":638},[621,695,696],{"class":638},",",[621,698,699],{"class":631}," MyModule]",[621,701,702],{"class":638},",\n",[621,704,706,709,711,714,717,719,721,724,726,728,731,733,736],{"class":623,"line":705},5,[621,707,708],{"class":678},"  runtimeConfig",[621,710,682],{"class":638},[621,712,713],{"class":638}," {",[621,715,716],{"class":678}," session",[621,718,682],{"class":638},[621,720,713],{"class":638},[621,722,723],{"class":678}," password",[621,725,682],{"class":638},[621,727,639],{"class":638},[621,729,730],{"class":642},"a-test-only-session-password-at-least-32-chars",[621,732,688],{"class":638},[621,734,735],{"class":638}," }",[621,737,738],{"class":638}," },\n",[621,740,742,745,747,749,752,754,756,759,761,763,766,768,770,773,775,777,780,782,784,787,789,793,795],{"class":623,"line":741},6,[621,743,744],{"class":678},"  hub",[621,746,682],{"class":638},[621,748,713],{"class":638},[621,750,751],{"class":678}," db",[621,753,682],{"class":638},[621,755,713],{"class":638},[621,757,758],{"class":678}," dialect",[621,760,682],{"class":638},[621,762,639],{"class":638},[621,764,765],{"class":642},"sqlite",[621,767,688],{"class":638},[621,769,696],{"class":638},[621,771,772],{"class":678}," driver",[621,774,682],{"class":638},[621,776,639],{"class":638},[621,778,779],{"class":642},"libsql",[621,781,688],{"class":638},[621,783,696],{"class":638},[621,785,786],{"class":678}," applyMigrationsDuringBuild",[621,788,682],{"class":638},[621,790,792],{"class":791},"sfNiH"," false",[621,794,735],{"class":638},[621,796,738],{"class":638},[621,798,800,803],{"class":623,"line":799},7,[621,801,802],{"class":638},"}",[621,804,805],{"class":631},")\n",[611,807,810],{"className":613,"code":808,"filename":809,"language":616,"meta":617,"style":617},"import { fileURLToPath } from 'node:url'\nimport { describe, expect, it } from 'vitest'\nimport { $fetch, setup } from '@nuxt\u002Ftest-utils\u002Fe2e'\n\ndescribe('my-module', async () => {\n  await setup({ rootDir: fileURLToPath(new URL('.\u002Ffixtures\u002Fbasic', import.meta.url)) })\n\n  it('renders', async () => {\n    expect(await $fetch('\u002F')).toContain('basic')\n  })\n})\n","test\u002Fbasic.test.ts",[597,811,812,833,863,888,892,921,980,984,1009,1050,1058],{"__ignoreMap":617},[621,813,814,816,818,821,823,826,828,831],{"class":623,"line":624},[621,815,628],{"class":627},[621,817,713],{"class":638},[621,819,820],{"class":631}," fileURLToPath",[621,822,735],{"class":638},[621,824,825],{"class":627}," from",[621,827,639],{"class":638},[621,829,830],{"class":642},"node:url",[621,832,646],{"class":638},[621,834,835,837,839,842,844,847,849,852,854,856,858,861],{"class":623,"line":649},[621,836,628],{"class":627},[621,838,713],{"class":638},[621,840,841],{"class":631}," describe",[621,843,696],{"class":638},[621,845,846],{"class":631}," expect",[621,848,696],{"class":638},[621,850,851],{"class":631}," it",[621,853,735],{"class":638},[621,855,825],{"class":627},[621,857,639],{"class":638},[621,859,860],{"class":642},"vitest",[621,862,646],{"class":638},[621,864,865,867,869,872,874,877,879,881,883,886],{"class":623,"line":656},[621,866,628],{"class":627},[621,868,713],{"class":638},[621,870,871],{"class":631}," $fetch",[621,873,696],{"class":638},[621,875,876],{"class":631}," setup",[621,878,735],{"class":638},[621,880,825],{"class":627},[621,882,639],{"class":638},[621,884,885],{"class":642},"@nuxt\u002Ftest-utils\u002Fe2e",[621,887,646],{"class":638},[621,889,890],{"class":623,"line":675},[621,891,653],{"emptyLinePlaceholder":652},[621,893,894,897,899,901,904,906,908,912,915,918],{"class":623,"line":705},[621,895,896],{"class":665},"describe",[621,898,669],{"class":631},[621,900,688],{"class":638},[621,902,903],{"class":642},"my-module",[621,905,688],{"class":638},[621,907,696],{"class":638},[621,909,911],{"class":910},"spNyl"," async",[621,913,914],{"class":638}," ()",[621,916,917],{"class":910}," =>",[621,919,920],{"class":638}," {\n",[621,922,923,926,928,930,933,936,938,940,942,945,948,950,952,955,957,959,962,965,968,970,973,976,978],{"class":623,"line":741},[621,924,925],{"class":627},"  await",[621,927,876],{"class":665},[621,929,669],{"class":678},[621,931,932],{"class":638},"{",[621,934,935],{"class":678}," rootDir",[621,937,682],{"class":638},[621,939,820],{"class":665},[621,941,669],{"class":678},[621,943,944],{"class":638},"new",[621,946,947],{"class":665}," URL",[621,949,669],{"class":678},[621,951,688],{"class":638},[621,953,954],{"class":642},".\u002Ffixtures\u002Fbasic",[621,956,688],{"class":638},[621,958,696],{"class":638},[621,960,961],{"class":627}," import",[621,963,964],{"class":638},".",[621,966,967],{"class":631},"meta",[621,969,964],{"class":638},[621,971,972],{"class":631},"url",[621,974,975],{"class":678},")) ",[621,977,802],{"class":638},[621,979,805],{"class":678},[621,981,982],{"class":623,"line":799},[621,983,653],{"emptyLinePlaceholder":652},[621,985,987,990,992,994,997,999,1001,1003,1005,1007],{"class":623,"line":986},8,[621,988,989],{"class":665},"  it",[621,991,669],{"class":678},[621,993,688],{"class":638},[621,995,996],{"class":642},"renders",[621,998,688],{"class":638},[621,1000,696],{"class":638},[621,1002,911],{"class":910},[621,1004,914],{"class":638},[621,1006,917],{"class":910},[621,1008,920],{"class":638},[621,1010,1012,1015,1017,1020,1022,1024,1026,1029,1031,1034,1036,1039,1041,1043,1046,1048],{"class":623,"line":1011},9,[621,1013,1014],{"class":665},"    expect",[621,1016,669],{"class":678},[621,1018,1019],{"class":627},"await",[621,1021,871],{"class":665},[621,1023,669],{"class":678},[621,1025,688],{"class":638},[621,1027,1028],{"class":642},"\u002F",[621,1030,688],{"class":638},[621,1032,1033],{"class":678},"))",[621,1035,964],{"class":638},[621,1037,1038],{"class":665},"toContain",[621,1040,669],{"class":678},[621,1042,688],{"class":638},[621,1044,1045],{"class":642},"basic",[621,1047,688],{"class":638},[621,1049,805],{"class":678},[621,1051,1053,1056],{"class":623,"line":1052},10,[621,1054,1055],{"class":638},"  }",[621,1057,805],{"class":678},[621,1059,1061,1063],{"class":623,"line":1060},11,[621,1062,802],{"class":638},[621,1064,805],{"class":631},[593,1066,1067],{},"Run it from the repository root, never from inside the package:",[611,1069,1073],{"className":1070,"code":1071,"language":1072,"meta":617,"style":617},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","pnpm --filter @frigear-nu\u002Fmy-module lint\npnpm --filter @frigear-nu\u002Fmy-module test\n","bash",[597,1074,1075,1090],{"__ignoreMap":617},[621,1076,1077,1081,1084,1087],{"class":623,"line":624},[621,1078,1080],{"class":1079},"sBMFI","pnpm",[621,1082,1083],{"class":642}," --filter",[621,1085,1086],{"class":642}," @frigear-nu\u002Fmy-module",[621,1088,1089],{"class":642}," lint\n",[621,1091,1092,1094,1096,1098],{"class":623,"line":649},[621,1093,1080],{"class":1079},[621,1095,1083],{"class":642},[621,1097,1086],{"class":642},[621,1099,1100],{"class":642}," test\n",[1102,1103,1104,1105,964],"tip",{},"Every test fixture is built and booted on CI, at 15 to 130 seconds each. Reuse an existing one of the package when you\ncan, and put tests that need no Nuxt server under ",[597,1106,1107],{},"test\u002Funit\u002F",[606,1109,1111],{"id":1110},"test-with-a-database","Test with a database",[593,1113,1114],{},"A test fixture whose tests touch the database needs committed migrations for the merged schema. That is your tables,\nplus the columns every extending module adds.",[1116,1117,1118,1123,1130,1134,1143,1150],"steps",{},[1119,1120,1122],"h3",{"id":1121},"add-the-modules-to-the-test-fixture","Add the modules to the test fixture",[593,1124,1125,1126,1129],{},"List them in its ",[597,1127,1128],{},"nuxt.config.ts",", with a test-only session password and a local libsql database.",[1119,1131,1133],{"id":1132},"generate-its-migrations","Generate its migrations",[593,1135,1136,1137,1142],{},"Run the command in\n",[1138,1139,1141],"a",{"href":1140},"\u002Fcontribute\u002Fwriting-a-module\u002Fdatabase-tables#generate-test-fixture-migrations","Generate test fixture migrations"," and\ncommit the result.",[1119,1144,1146,1147],{"id":1145},"boot-it-with-dev-true","Boot it with ",[597,1148,1149],{},"dev: true",[593,1151,1152,1153,1155,1156,1159,1160,1163],{},"Pass ",[597,1154,1149],{}," to ",[597,1157,1158],{},"setup()",", so NuxtHub applies the committed migrations on startup. Delete only the test fixture's\nown ",[597,1161,1162],{},".data"," folder before the suite and after it, so repeated runs do not fail on duplicate users.",[593,1165,1166,1167,1170,1171,1174,1175,1178,1179,1182,1183,1186,1187,964],{},"Working examples are the ",[597,1168,1169],{},"admin-db",", ",[597,1172,1173],{},"magic-link-db"," and ",[597,1176,1177],{},"verified-email-change"," test fixtures of ",[597,1180,1181],{},"packages\u002Fusers",", and\n",[597,1184,1185],{},"auth-db"," of ",[597,1188,1189],{},"packages\u002Fauth",[606,1191,1193],{"id":1192},"test-signed-in-routes","Test signed-in routes",[593,1195,1196,1197,1170,1200,1203,1204,1207,1208,1211,1212,1215,1216,1219,1220,1222,1223,1226,1227,964],{},"A module whose routes call ",[597,1198,1199],{},"authorize",[597,1201,1202],{},"requireAuth"," or ",[597,1205,1206],{},"requireUser"," lists ",[597,1209,1210],{},"@frigear-nu\u002Fauth"," in\n",[597,1213,1214],{},"moduleDependencies"," and in ",[597,1217,1218],{},"package.json",". ",[597,1221,1206],{}," also needs ",[597,1224,1225],{},"@frigear-nu\u002Fusers",". Roles for the test users\ncome from a role provider in the fixture: see ",[1138,1228,67],{"href":1229},"\u002Fcontribute\u002Fwriting-a-module\u002Faccess-control#test-it",[1231,1232,1233,1234,1237],"warning",{},"Every test fixture that includes such a module needs the ",[597,1235,1236],{},"auth_user_tokens"," migration. A column added by an extending\nmodule without a matching migration makes every write to its table fail. The symptom is a missing session cookie,\nnot disabled sign-in.",[1239,1240,1241,1257],"ul",{},[1242,1243,1244,1248,1249,1252,1253,1256],"li",{},[1245,1246,1247],"strong",{},"Registration."," Email and password sign-up needs ",[597,1250,1251],{},"authentication.settings.password",", which is on by default. It\nturns on the sign-in and registration APIs. ",[597,1254,1255],{},"settings.pages.register"," only adds the page.",[1242,1258,1259,1262],{},[1245,1260,1261],{},"Assertions."," Check the registration status and response body before you check the session cookie.",[606,1264,1266],{"id":1265},"test-api-routes","Test API routes",[593,1268,1269,1272,1273,1276,1277,1280,1281,1283],{},[597,1270,1271],{},"apiClient({ cookie?, bearer? })"," calls a route with a session cookie or a bearer token.\n",[597,1274,1275],{},"expectApiError(promise, status, code?)"," checks an error response. Both come from ",[597,1278,1279],{},"@frigear-nu\u002Fmodule-kit\u002Ftesting",".\n",[1138,1282,121],{"href":122}," has the conventions they check.",[606,1285,1287],{"id":1286},"document-and-release","Document and release",[1239,1289,1290,1303,1319],{},[1242,1291,1292,1295,1296,1298,1299,1302],{},[1245,1293,1294],{},"Document it."," Add the module page as ",[1138,1297,553],{"href":554}," describes, and a row in the root\n",[597,1300,1301],{},"README.md"," package list.",[1242,1304,1305,1308,1309,1312,1313,1219,1316,1318],{},[1245,1306,1307],{},"Release it."," Copy a sibling's ",[597,1310,1311],{},".release-it.json",", change the package name and tag, and add the package to\n",[597,1314,1315],{},"release.yml",[1138,1317,545],{"href":546}," has the steps.",[1242,1320,1321,1324,1325,1329],{},[1245,1322,1323],{},"Check it."," Run the checks in ",[1138,1326,1328],{"href":1327},"\u002Fcontribute\u002Foverview#conventions","Conventions"," before you open a pull request.",[606,1331,1333],{"id":1332},"next-steps","Next steps",[1239,1335,1336],{},[1242,1337,1338,1340],{},[1138,1339,545],{"href":546}," – release the module to npm.",[1342,1343,1344],"style",{},"html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sfNiH, html code.shiki .sfNiH{--shiki-light:#FF5370;--shiki-default:#FF9CAC;--shiki-dark:#FF9CAC}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}",{"title":617,"searchDepth":649,"depth":649,"links":1346},[1347,1348,1354,1355,1356,1357],{"id":608,"depth":649,"text":609},{"id":1110,"depth":649,"text":1111,"children":1349},[1350,1351,1352],{"id":1121,"depth":656,"text":1122},{"id":1132,"depth":656,"text":1133},{"id":1145,"depth":656,"text":1353},"Boot it with dev: true",{"id":1192,"depth":649,"text":1193},{"id":1265,"depth":649,"text":1266},{"id":1286,"depth":649,"text":1287},{"id":1332,"depth":649,"text":1333},"Test a Frigear module with Vitest and test fixtures, including database and sign-in tests, then document and release it.","md",null,{},{"icon":540},{"title":537,"description":1358},"5IaqiJ3_UvGIB88ZlTeK88gCKO-inKWZxUTnSFrFf-Y",[1366,1368],{"title":533,"path":534,"stem":535,"description":1367,"icon":44,"children":-1},"Add a table to your module or columns to another module's table, in both dialects, with test fixture migrations.",{"title":67,"path":542,"stem":543,"description":1369,"icon":70,"children":-1},"Declare a module's permissions, scopes and roles with defineAccess, register them with registerAccess, add role requirements and policies, and test them with a role provider in a fixture.",1794503151805]