[{"data":1,"prerenderedAt":1999},["ShallowReactive",2],{"navigation_docs":3,"-contribute-writing-a-module-setup-checklist":587,"-contribute-writing-a-module-setup-checklist-surround":1994},[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":528,"body":589,"description":1987,"extension":1988,"links":1989,"meta":1990,"navigation":1991,"path":529,"seo":1992,"stem":530,"__hash__":1993},"docs\u002F5.contribute\u002F3.writing-a-module\u002F2.setup-checklist.md",{"type":590,"value":591,"toc":1981},"minimark",[592,609,614,625,866,983,1047,1054,1057,1794,1797,1951,1955,1977],[593,594,595,596,599,600,604,605,608],"p",{},"This page is for module authors with a package from ",[597,598,524],"a",{"href":525},". It\ncovers the two parts of ",[601,602,603],"code",{},"src\u002Fmodule.ts"," that every module has: the modules it depends on, and the ",[601,606,607],{},"setup()"," that\nregisters its pages, routes, translations and tables.",[610,611,613],"h2",{"id":612},"declare-dependencies","Declare dependencies",[593,615,616,617,620,621,624],{},"List every module yours needs in ",[601,618,619],{},"moduleDependencies",". Nuxt then installs and orders them, so the\n",[597,622,623],{"href":87},"host app"," lists only your module.",[626,627,632],"pre",{"className":628,"code":629,"language":630,"meta":631,"style":631},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","export default defineNuxtModule\u003CModuleOptions>({\n  meta: { name: '@frigear-nu\u002Fmy-module', configKey: 'myModule' },\n  moduleDependencies: {\n    '@nuxthub\u002Fcore': { version: '>=0.10' },\n    '@frigear-nu\u002Fmodule-kit': { version: '>=0.0.1' },\n    '@frigear-nu\u002Fauth': { version: '>=0.0.1' },\n    '@frigear-nu\u002Fmenu': { version: '>=0.0.1', optional: true },\n  },\n  \u002F\u002F ...\n})\n","ts","",[601,633,634,668,714,725,754,781,807,844,850,857],{"__ignoreMap":631},[635,636,639,643,646,650,654,658,661,665],"span",{"class":637,"line":638},"line",1,[635,640,642],{"class":641},"s7zQu","export",[635,644,645],{"class":641}," default",[635,647,649],{"class":648},"s2Zo4"," defineNuxtModule",[635,651,653],{"class":652},"sMK4o","\u003C",[635,655,657],{"class":656},"sBMFI","ModuleOptions",[635,659,660],{"class":652},">",[635,662,664],{"class":663},"sTEyZ","(",[635,666,667],{"class":652},"{\n",[635,669,671,675,678,681,684,686,689,693,696,699,702,704,706,709,711],{"class":637,"line":670},2,[635,672,674],{"class":673},"swJcz","  meta",[635,676,677],{"class":652},":",[635,679,680],{"class":652}," {",[635,682,683],{"class":673}," name",[635,685,677],{"class":652},[635,687,688],{"class":652}," '",[635,690,692],{"class":691},"sfazB","@frigear-nu\u002Fmy-module",[635,694,695],{"class":652},"'",[635,697,698],{"class":652},",",[635,700,701],{"class":673}," configKey",[635,703,677],{"class":652},[635,705,688],{"class":652},[635,707,708],{"class":691},"myModule",[635,710,695],{"class":652},[635,712,713],{"class":652}," },\n",[635,715,717,720,722],{"class":637,"line":716},3,[635,718,719],{"class":673},"  moduleDependencies",[635,721,677],{"class":652},[635,723,724],{"class":652}," {\n",[635,726,728,731,734,736,738,740,743,745,747,750,752],{"class":637,"line":727},4,[635,729,730],{"class":652},"    '",[635,732,733],{"class":673},"@nuxthub\u002Fcore",[635,735,695],{"class":652},[635,737,677],{"class":652},[635,739,680],{"class":652},[635,741,742],{"class":673}," version",[635,744,677],{"class":652},[635,746,688],{"class":652},[635,748,749],{"class":691},">=0.10",[635,751,695],{"class":652},[635,753,713],{"class":652},[635,755,757,759,762,764,766,768,770,772,774,777,779],{"class":637,"line":756},5,[635,758,730],{"class":652},[635,760,761],{"class":673},"@frigear-nu\u002Fmodule-kit",[635,763,695],{"class":652},[635,765,677],{"class":652},[635,767,680],{"class":652},[635,769,742],{"class":673},[635,771,677],{"class":652},[635,773,688],{"class":652},[635,775,776],{"class":691},">=0.0.1",[635,778,695],{"class":652},[635,780,713],{"class":652},[635,782,784,786,789,791,793,795,797,799,801,803,805],{"class":637,"line":783},6,[635,785,730],{"class":652},[635,787,788],{"class":673},"@frigear-nu\u002Fauth",[635,790,695],{"class":652},[635,792,677],{"class":652},[635,794,680],{"class":652},[635,796,742],{"class":673},[635,798,677],{"class":652},[635,800,688],{"class":652},[635,802,776],{"class":691},[635,804,695],{"class":652},[635,806,713],{"class":652},[635,808,810,812,815,817,819,821,823,825,827,829,831,833,836,838,842],{"class":637,"line":809},7,[635,811,730],{"class":652},[635,813,814],{"class":673},"@frigear-nu\u002Fmenu",[635,816,695],{"class":652},[635,818,677],{"class":652},[635,820,680],{"class":652},[635,822,742],{"class":673},[635,824,677],{"class":652},[635,826,688],{"class":652},[635,828,776],{"class":691},[635,830,695],{"class":652},[635,832,698],{"class":652},[635,834,835],{"class":673}," optional",[635,837,677],{"class":652},[635,839,841],{"class":840},"sfNiH"," true",[635,843,713],{"class":652},[635,845,847],{"class":637,"line":846},8,[635,848,849],{"class":652},"  },\n",[635,851,853],{"class":637,"line":852},9,[635,854,856],{"class":855},"sHwdD","  \u002F\u002F ...\n",[635,858,860,863],{"class":637,"line":859},10,[635,861,862],{"class":652},"}",[635,864,865],{"class":663},")\n",[867,868,869,889],"table",{},[870,871,872],"thead",{},[873,874,875,879,884],"tr",{},[876,877,878],"th",{},"Kind",[876,880,881,882],{},"In ",[601,883,619],{},[876,885,881,886],{},[601,887,888],{},"package.json",[890,891,892,917,942],"tbody",{},[873,893,894,898,903],{},[895,896,897],"td",{},"Required",[895,899,900],{},[601,901,902],{},"{ version: '>=0.0.1' }",[895,904,905,908,909,912,913,916],{},[601,906,907],{},"dependencies"," with ",[601,910,911],{},"workspace:^"," (not ",[601,914,915],{},"workspace:*",", which publishes an exact version).",[873,918,919,922,927],{},[895,920,921],{},"Optional",[895,923,924],{},[601,925,926],{},"{ version: '>=0.0.1', optional: true }",[895,928,929,930,933,934,937,938,941],{},"An optional ",[601,931,932],{},"peerDependencies"," entry (with ",[601,935,936],{},"peerDependenciesMeta",") and a ",[601,939,940],{},"devDependencies"," entry, so tests can use it.",[873,943,944,966,969],{},[895,945,946,947,950,951,950,954,950,957,950,959,950,962,965],{},"Nuxt toolchain (",[601,948,949],{},"nuxt",", ",[601,952,953],{},"@nuxt\u002Fkit",[601,955,956],{},"@nuxt\u002Fui",[601,958,733],{},[601,960,961],{},"drizzle-orm",[601,963,964],{},"vitest",", ...)",[895,967,968],{},"-",[895,970,971,974,975,978,979,982],{},[601,972,973],{},"catalog:",", from the ",[601,976,977],{},"catalog"," of the root ",[601,980,981],{},"pnpm-workspace.yaml",".",[984,985,986,994,1007,1031],"ul",{},[987,988,989,993],"li",{},[990,991,992],"strong",{},"The catalog."," Every package shares one copy of each toolchain package. A version of its own per package\nmultiplies the installed Nuxt copies and slows every boot.",[987,995,996,999,1000,1003,1004,1006],{},[990,997,998],{},"Module Kit always."," Its entry provides the ",[601,1001,1002],{},"useModuleT"," auto-import. Add ",[601,1005,733],{}," only when the module has\ntables.",[987,1008,1009,1012,1013,1016,1017,1019,1020,1023,1024,1027,1028,982],{},[990,1010,1011],{},"Optional modules."," An installed optional module is set up before yours, so ",[601,1014,1015],{},"hasNuxtModule('@frigear-nu\u002Fmenu')"," in\n",[601,1018,607],{}," does not depend on the order of the host app's ",[601,1021,1022],{},"modules",". Guard every use of it. Load its helpers with a\ndynamic ",[601,1025,1026],{},"import()"," inside the guard, for example ",[601,1029,1030],{},"await import('@frigear-nu\u002Fwidget\u002Futils')",[987,1032,1033,1036,1037,1039,1040,1042,1043,1046],{},[990,1034,1035],{},"Options."," ",[601,1038,619],{}," may be a function of ",[601,1041,949],{}," when a dependency depends on options, as\n",[601,1044,1045],{},"@frigear-nu\u002Fusers"," does for MCP.",[610,1048,1050,1051,1053],{"id":1049},"the-setup-checklist","The ",[601,1052,607],{}," checklist",[593,1055,1056],{},"Most modules call the same helpers, in this order:",[626,1058,1060],{"className":628,"code":1059,"language":630,"meta":631,"style":631},"import { addServerImportsDir, createResolver, defineNuxtModule } from '@nuxt\u002Fkit'\nimport {\n  addModulePages,\n  addModuleRoutes,\n  inlineModuleRuntime,\n  registerDatabaseTable,\n  registerLocales,\n  registerModule,\n  registerTailwindSource,\n  resolvePagePath,\n} from '@frigear-nu\u002Fmodule-kit\u002Futils'\n\nconst MODULE_NAME = '@frigear-nu\u002Fmy-module'\n\nexport default defineNuxtModule\u003CModuleOptions>({\n  \u002F\u002F meta, defaults, moduleDependencies ...\n  setup(options, nuxt) {\n    const resolver = createResolver(import.meta.url)\n\n    \u002F\u002F 0. Bundling and server auto-imports of .\u002Fruntime, also when the module is installed from npm.\n    inlineModuleRuntime(nuxt, resolver)\n\n    \u002F\u002F 1. Make the module known to the rest of the app.\n    registerModule(MODULE_NAME, nuxt)\n\n    \u002F\u002F 2. Classes used in the module's components must be generated by Tailwind.\n    registerTailwindSource(nuxt, resolver.resolve('.\u002Fruntime\u002Fapp'))\n\n    \u002F\u002F 3. Translations: da.json and en.json, namespaced by module.\n    registerLocales(nuxt, resolver.resolve('.\u002Fruntime\u002Fi18n\u002Flang'))\n\n    \u002F\u002F 4. Pages are opt-in or overridable through settings.pages.*.\n    addModulePages(MODULE_NAME, resolver, [\n      {\n        name: 'my-module',\n        path: resolvePagePath(options.settings?.pages?.index, '\u002Fmy-module'),\n        file: '.\u002Fruntime\u002Fapp\u002Fpages\u002Findex.vue',\n      },\n    ])\n\n    \u002F\u002F 5. Server routes and server auto-imports.\n    addServerImportsDir(resolver.resolve('.\u002Fruntime\u002Fserver\u002Futils'))\n    addModuleRoutes(resolver, [\n      { method: 'get', path: 'things', file: 'things.get' },\n      { method: 'get', path: '\u002Fapi\u002Fadmin\u002Fmy-module\u002Fthings', file: 'admin\u002Fthings.get' },\n    ], { base: '\u002Fapi\u002Fmy-module' })\n\n    \u002F\u002F 6. Tables: a plain drizzle file per dialect. No `name`, nothing to await.\n    registerDatabaseTable(nuxt, {\n      resolver,\n      schema: dialect => `.\u002Fruntime\u002Fserver\u002Fdb\u002Fschema.${dialect}`,\n    })\n  },\n})\n",[601,1061,1062,1094,1100,1108,1115,1122,1129,1136,1143,1150,1157,1171,1178,1197,1202,1221,1227,1249,1279,1284,1290,1306,1311,1317,1334,1339,1345,1376,1381,1387,1416,1421,1427,1446,1452,1469,1513,1530,1536,1542,1547,1553,1579,1593,1641,1684,1710,1715,1721,1735,1743,1774,1782,1787],{"__ignoreMap":631},[635,1063,1064,1067,1069,1072,1074,1077,1079,1081,1084,1087,1089,1091],{"class":637,"line":638},[635,1065,1066],{"class":641},"import",[635,1068,680],{"class":652},[635,1070,1071],{"class":663}," addServerImportsDir",[635,1073,698],{"class":652},[635,1075,1076],{"class":663}," createResolver",[635,1078,698],{"class":652},[635,1080,649],{"class":663},[635,1082,1083],{"class":652}," }",[635,1085,1086],{"class":641}," from",[635,1088,688],{"class":652},[635,1090,953],{"class":691},[635,1092,1093],{"class":652},"'\n",[635,1095,1096,1098],{"class":637,"line":670},[635,1097,1066],{"class":641},[635,1099,724],{"class":652},[635,1101,1102,1105],{"class":637,"line":716},[635,1103,1104],{"class":663},"  addModulePages",[635,1106,1107],{"class":652},",\n",[635,1109,1110,1113],{"class":637,"line":727},[635,1111,1112],{"class":663},"  addModuleRoutes",[635,1114,1107],{"class":652},[635,1116,1117,1120],{"class":637,"line":756},[635,1118,1119],{"class":663},"  inlineModuleRuntime",[635,1121,1107],{"class":652},[635,1123,1124,1127],{"class":637,"line":783},[635,1125,1126],{"class":663},"  registerDatabaseTable",[635,1128,1107],{"class":652},[635,1130,1131,1134],{"class":637,"line":809},[635,1132,1133],{"class":663},"  registerLocales",[635,1135,1107],{"class":652},[635,1137,1138,1141],{"class":637,"line":846},[635,1139,1140],{"class":663},"  registerModule",[635,1142,1107],{"class":652},[635,1144,1145,1148],{"class":637,"line":852},[635,1146,1147],{"class":663},"  registerTailwindSource",[635,1149,1107],{"class":652},[635,1151,1152,1155],{"class":637,"line":859},[635,1153,1154],{"class":663},"  resolvePagePath",[635,1156,1107],{"class":652},[635,1158,1160,1162,1164,1166,1169],{"class":637,"line":1159},11,[635,1161,862],{"class":652},[635,1163,1086],{"class":641},[635,1165,688],{"class":652},[635,1167,1168],{"class":691},"@frigear-nu\u002Fmodule-kit\u002Futils",[635,1170,1093],{"class":652},[635,1172,1174],{"class":637,"line":1173},12,[635,1175,1177],{"emptyLinePlaceholder":1176},true,"\n",[635,1179,1181,1185,1188,1191,1193,1195],{"class":637,"line":1180},13,[635,1182,1184],{"class":1183},"spNyl","const",[635,1186,1187],{"class":663}," MODULE_NAME ",[635,1189,1190],{"class":652},"=",[635,1192,688],{"class":652},[635,1194,692],{"class":691},[635,1196,1093],{"class":652},[635,1198,1200],{"class":637,"line":1199},14,[635,1201,1177],{"emptyLinePlaceholder":1176},[635,1203,1205,1207,1209,1211,1213,1215,1217,1219],{"class":637,"line":1204},15,[635,1206,642],{"class":641},[635,1208,645],{"class":641},[635,1210,649],{"class":648},[635,1212,653],{"class":652},[635,1214,657],{"class":656},[635,1216,660],{"class":652},[635,1218,664],{"class":663},[635,1220,667],{"class":652},[635,1222,1224],{"class":637,"line":1223},16,[635,1225,1226],{"class":855},"  \u002F\u002F meta, defaults, moduleDependencies ...\n",[635,1228,1230,1233,1235,1239,1241,1244,1247],{"class":637,"line":1229},17,[635,1231,1232],{"class":673},"  setup",[635,1234,664],{"class":652},[635,1236,1238],{"class":1237},"sHdIc","options",[635,1240,698],{"class":652},[635,1242,1243],{"class":1237}," nuxt",[635,1245,1246],{"class":652},")",[635,1248,724],{"class":652},[635,1250,1252,1255,1258,1261,1263,1265,1267,1269,1272,1274,1277],{"class":637,"line":1251},18,[635,1253,1254],{"class":1183},"    const",[635,1256,1257],{"class":663}," resolver",[635,1259,1260],{"class":652}," =",[635,1262,1076],{"class":648},[635,1264,664],{"class":673},[635,1266,1066],{"class":641},[635,1268,982],{"class":652},[635,1270,1271],{"class":663},"meta",[635,1273,982],{"class":652},[635,1275,1276],{"class":663},"url",[635,1278,865],{"class":673},[635,1280,1282],{"class":637,"line":1281},19,[635,1283,1177],{"emptyLinePlaceholder":1176},[635,1285,1287],{"class":637,"line":1286},20,[635,1288,1289],{"class":855},"    \u002F\u002F 0. Bundling and server auto-imports of .\u002Fruntime, also when the module is installed from npm.\n",[635,1291,1293,1296,1298,1300,1302,1304],{"class":637,"line":1292},21,[635,1294,1295],{"class":648},"    inlineModuleRuntime",[635,1297,664],{"class":673},[635,1299,949],{"class":663},[635,1301,698],{"class":652},[635,1303,1257],{"class":663},[635,1305,865],{"class":673},[635,1307,1309],{"class":637,"line":1308},22,[635,1310,1177],{"emptyLinePlaceholder":1176},[635,1312,1314],{"class":637,"line":1313},23,[635,1315,1316],{"class":855},"    \u002F\u002F 1. Make the module known to the rest of the app.\n",[635,1318,1320,1323,1325,1328,1330,1332],{"class":637,"line":1319},24,[635,1321,1322],{"class":648},"    registerModule",[635,1324,664],{"class":673},[635,1326,1327],{"class":663},"MODULE_NAME",[635,1329,698],{"class":652},[635,1331,1243],{"class":663},[635,1333,865],{"class":673},[635,1335,1337],{"class":637,"line":1336},25,[635,1338,1177],{"emptyLinePlaceholder":1176},[635,1340,1342],{"class":637,"line":1341},26,[635,1343,1344],{"class":855},"    \u002F\u002F 2. Classes used in the module's components must be generated by Tailwind.\n",[635,1346,1348,1351,1353,1355,1357,1359,1361,1364,1366,1368,1371,1373],{"class":637,"line":1347},27,[635,1349,1350],{"class":648},"    registerTailwindSource",[635,1352,664],{"class":673},[635,1354,949],{"class":663},[635,1356,698],{"class":652},[635,1358,1257],{"class":663},[635,1360,982],{"class":652},[635,1362,1363],{"class":648},"resolve",[635,1365,664],{"class":673},[635,1367,695],{"class":652},[635,1369,1370],{"class":691},".\u002Fruntime\u002Fapp",[635,1372,695],{"class":652},[635,1374,1375],{"class":673},"))\n",[635,1377,1379],{"class":637,"line":1378},28,[635,1380,1177],{"emptyLinePlaceholder":1176},[635,1382,1384],{"class":637,"line":1383},29,[635,1385,1386],{"class":855},"    \u002F\u002F 3. Translations: da.json and en.json, namespaced by module.\n",[635,1388,1390,1393,1395,1397,1399,1401,1403,1405,1407,1409,1412,1414],{"class":637,"line":1389},30,[635,1391,1392],{"class":648},"    registerLocales",[635,1394,664],{"class":673},[635,1396,949],{"class":663},[635,1398,698],{"class":652},[635,1400,1257],{"class":663},[635,1402,982],{"class":652},[635,1404,1363],{"class":648},[635,1406,664],{"class":673},[635,1408,695],{"class":652},[635,1410,1411],{"class":691},".\u002Fruntime\u002Fi18n\u002Flang",[635,1413,695],{"class":652},[635,1415,1375],{"class":673},[635,1417,1419],{"class":637,"line":1418},31,[635,1420,1177],{"emptyLinePlaceholder":1176},[635,1422,1424],{"class":637,"line":1423},32,[635,1425,1426],{"class":855},"    \u002F\u002F 4. Pages are opt-in or overridable through settings.pages.*.\n",[635,1428,1430,1433,1435,1437,1439,1441,1443],{"class":637,"line":1429},33,[635,1431,1432],{"class":648},"    addModulePages",[635,1434,664],{"class":673},[635,1436,1327],{"class":663},[635,1438,698],{"class":652},[635,1440,1257],{"class":663},[635,1442,698],{"class":652},[635,1444,1445],{"class":673}," [\n",[635,1447,1449],{"class":637,"line":1448},34,[635,1450,1451],{"class":652},"      {\n",[635,1453,1455,1458,1460,1462,1465,1467],{"class":637,"line":1454},35,[635,1456,1457],{"class":673},"        name",[635,1459,677],{"class":652},[635,1461,688],{"class":652},[635,1463,1464],{"class":691},"my-module",[635,1466,695],{"class":652},[635,1468,1107],{"class":652},[635,1470,1472,1475,1477,1480,1482,1484,1486,1489,1492,1495,1497,1500,1502,1504,1507,1509,1511],{"class":637,"line":1471},36,[635,1473,1474],{"class":673},"        path",[635,1476,677],{"class":652},[635,1478,1479],{"class":648}," resolvePagePath",[635,1481,664],{"class":673},[635,1483,1238],{"class":663},[635,1485,982],{"class":652},[635,1487,1488],{"class":663},"settings",[635,1490,1491],{"class":652},"?.",[635,1493,1494],{"class":663},"pages",[635,1496,1491],{"class":652},[635,1498,1499],{"class":663},"index",[635,1501,698],{"class":652},[635,1503,688],{"class":652},[635,1505,1506],{"class":691},"\u002Fmy-module",[635,1508,695],{"class":652},[635,1510,1246],{"class":673},[635,1512,1107],{"class":652},[635,1514,1516,1519,1521,1523,1526,1528],{"class":637,"line":1515},37,[635,1517,1518],{"class":673},"        file",[635,1520,677],{"class":652},[635,1522,688],{"class":652},[635,1524,1525],{"class":691},".\u002Fruntime\u002Fapp\u002Fpages\u002Findex.vue",[635,1527,695],{"class":652},[635,1529,1107],{"class":652},[635,1531,1533],{"class":637,"line":1532},38,[635,1534,1535],{"class":652},"      },\n",[635,1537,1539],{"class":637,"line":1538},39,[635,1540,1541],{"class":673},"    ])\n",[635,1543,1545],{"class":637,"line":1544},40,[635,1546,1177],{"emptyLinePlaceholder":1176},[635,1548,1550],{"class":637,"line":1549},41,[635,1551,1552],{"class":855},"    \u002F\u002F 5. Server routes and server auto-imports.\n",[635,1554,1556,1559,1561,1564,1566,1568,1570,1572,1575,1577],{"class":637,"line":1555},42,[635,1557,1558],{"class":648},"    addServerImportsDir",[635,1560,664],{"class":673},[635,1562,1563],{"class":663},"resolver",[635,1565,982],{"class":652},[635,1567,1363],{"class":648},[635,1569,664],{"class":673},[635,1571,695],{"class":652},[635,1573,1574],{"class":691},".\u002Fruntime\u002Fserver\u002Futils",[635,1576,695],{"class":652},[635,1578,1375],{"class":673},[635,1580,1582,1585,1587,1589,1591],{"class":637,"line":1581},43,[635,1583,1584],{"class":648},"    addModuleRoutes",[635,1586,664],{"class":673},[635,1588,1563],{"class":663},[635,1590,698],{"class":652},[635,1592,1445],{"class":673},[635,1594,1596,1599,1602,1604,1606,1609,1611,1613,1616,1618,1620,1623,1625,1627,1630,1632,1634,1637,1639],{"class":637,"line":1595},44,[635,1597,1598],{"class":652},"      {",[635,1600,1601],{"class":673}," method",[635,1603,677],{"class":652},[635,1605,688],{"class":652},[635,1607,1608],{"class":691},"get",[635,1610,695],{"class":652},[635,1612,698],{"class":652},[635,1614,1615],{"class":673}," path",[635,1617,677],{"class":652},[635,1619,688],{"class":652},[635,1621,1622],{"class":691},"things",[635,1624,695],{"class":652},[635,1626,698],{"class":652},[635,1628,1629],{"class":673}," file",[635,1631,677],{"class":652},[635,1633,688],{"class":652},[635,1635,1636],{"class":691},"things.get",[635,1638,695],{"class":652},[635,1640,713],{"class":652},[635,1642,1644,1646,1648,1650,1652,1654,1656,1658,1660,1662,1664,1667,1669,1671,1673,1675,1677,1680,1682],{"class":637,"line":1643},45,[635,1645,1598],{"class":652},[635,1647,1601],{"class":673},[635,1649,677],{"class":652},[635,1651,688],{"class":652},[635,1653,1608],{"class":691},[635,1655,695],{"class":652},[635,1657,698],{"class":652},[635,1659,1615],{"class":673},[635,1661,677],{"class":652},[635,1663,688],{"class":652},[635,1665,1666],{"class":691},"\u002Fapi\u002Fadmin\u002Fmy-module\u002Fthings",[635,1668,695],{"class":652},[635,1670,698],{"class":652},[635,1672,1629],{"class":673},[635,1674,677],{"class":652},[635,1676,688],{"class":652},[635,1678,1679],{"class":691},"admin\u002Fthings.get",[635,1681,695],{"class":652},[635,1683,713],{"class":652},[635,1685,1687,1690,1692,1694,1697,1699,1701,1704,1706,1708],{"class":637,"line":1686},46,[635,1688,1689],{"class":673},"    ]",[635,1691,698],{"class":652},[635,1693,680],{"class":652},[635,1695,1696],{"class":673}," base",[635,1698,677],{"class":652},[635,1700,688],{"class":652},[635,1702,1703],{"class":691},"\u002Fapi\u002Fmy-module",[635,1705,695],{"class":652},[635,1707,1083],{"class":652},[635,1709,865],{"class":673},[635,1711,1713],{"class":637,"line":1712},47,[635,1714,1177],{"emptyLinePlaceholder":1176},[635,1716,1718],{"class":637,"line":1717},48,[635,1719,1720],{"class":855},"    \u002F\u002F 6. Tables: a plain drizzle file per dialect. No `name`, nothing to await.\n",[635,1722,1724,1727,1729,1731,1733],{"class":637,"line":1723},49,[635,1725,1726],{"class":648},"    registerDatabaseTable",[635,1728,664],{"class":673},[635,1730,949],{"class":663},[635,1732,698],{"class":652},[635,1734,724],{"class":652},[635,1736,1738,1741],{"class":637,"line":1737},50,[635,1739,1740],{"class":663},"      resolver",[635,1742,1107],{"class":652},[635,1744,1746,1749,1751,1754,1757,1760,1763,1766,1769,1772],{"class":637,"line":1745},51,[635,1747,1748],{"class":648},"      schema",[635,1750,677],{"class":652},[635,1752,1753],{"class":1237}," dialect",[635,1755,1756],{"class":1183}," =>",[635,1758,1759],{"class":652}," `",[635,1761,1762],{"class":691},".\u002Fruntime\u002Fserver\u002Fdb\u002Fschema.",[635,1764,1765],{"class":652},"${",[635,1767,1768],{"class":663},"dialect",[635,1770,1771],{"class":652},"}`",[635,1773,1107],{"class":652},[635,1775,1777,1780],{"class":637,"line":1776},52,[635,1778,1779],{"class":652},"    }",[635,1781,865],{"class":673},[635,1783,1785],{"class":637,"line":1784},53,[635,1786,849],{"class":652},[635,1788,1790,1792],{"class":637,"line":1789},54,[635,1791,862],{"class":652},[635,1793,865],{"class":663},[593,1795,1796],{},"Why each call is there:",[984,1798,1799,1820,1840,1871,1907,1939],{},[987,1800,1801,1036,1804,1807,1808,1811,1812,1815,1816,1819],{},[990,1802,1803],{},"Names.",[601,1805,1806],{},"registerModule"," takes the full package name. ",[601,1809,1810],{},"moduleUrl"," and ",[601,1813,1814],{},"moduleApiUrl"," take the short name\n(",[601,1817,1818],{},"'my-module'",") and kebab-case it into the path.",[987,1821,1822,1827,1828,1831,1832,1835,1836,1839],{},[990,1823,1824,982],{},[601,1825,1826],{},"inlineModuleRuntime"," Call it in every module with a ",[601,1829,1830],{},"runtime"," folder. Nitro auto-imports only into the\n",[601,1833,1834],{},"node_modules"," files of layers. Without it, an installed module's server code that uses auto-imports, such as\n",[601,1837,1838],{},"useNitroApp",", fails in the host app, and its virtual modules do not resolve.",[987,1841,1842,1845,1846,1848,1849,1852,1853,1856,1857,1859,1860,1863,1864,1866,1867,1870],{},[990,1843,1844],{},"App imports."," App code in ",[601,1847,1830],{}," (components, composables, plugins, pages) imports from ",[601,1850,1851],{},"#imports",":\n",[601,1854,1855],{},"import { computed, useModuleT } from '#imports'",". Nuxt does not auto-import into a module in ",[601,1858,1834],{},". The\n",[601,1861,1862],{},"no-undef"," rule of ",[597,1865,567],{"href":568}," fails the lint when an import is missing.\nNames from optional modules come from your own ",[601,1868,1869],{},"addOptionalImports"," virtual module instead.",[987,1872,1873,1876,1877,1880,1881,950,1884,1107,1887,950,1890,1893,1894,1897,1898,1900,1901,1903,1904,1906],{},[990,1874,1875],{},"Access control."," Register what your routes check with ",[601,1878,1879],{},"addPermission"," (plus ",[601,1882,1883],{},"addScope",[601,1885,1886],{},"addRole",[601,1888,1889],{},"addRoleRequirement",[601,1891,1892],{},"addPolicies"," as needed) and check it with ",[601,1895,1896],{},"authorize",", not the session helpers. List\n",[601,1899,788],{}," in ",[601,1902,619],{},". ",[597,1905,67],{"href":542}," covers it.",[987,1908,1909,1912,1913,1916,1917,1920,1921,1924,1925,1928,1929,1932,1933,1936,1937,982],{},[990,1910,1911],{},"Routes."," Register every route through one ",[601,1914,1915],{},"addModuleRoutes"," call. ",[601,1918,1919],{},"file"," is relative to\n",[601,1922,1923],{},".\u002Fruntime\u002Fserver\u002Froutes\u002F",", and ",[601,1926,1927],{},"path"," is joined onto ",[601,1930,1931],{},"base"," unless it starts with ",[601,1934,1935],{},"\u002F",". Every module's API follows\nthe same URL, error and response rules, in ",[597,1938,121],{"href":122},[987,1940,1941,1944,1945,1948,1949,982],{},[990,1942,1943],{},"Optional areas."," Menus, widgets and admin pages come from optional modules. Use ",[601,1946,1947],{},"addOptionalMenuSource"," and the\nguarded imports in ",[597,1950,381],{"href":382},[610,1952,1954],{"id":1953},"next-steps","Next steps",[984,1956,1957,1962,1967,1972],{},[987,1958,1959,1961],{},[597,1960,533],{"href":534}," – add the module's tables.",[987,1963,1964,1966],{},[597,1965,121],{"href":122}," – shape the routes you just registered.",[987,1968,1969,1971],{},[597,1970,67],{"href":542}," – register the module's permissions.",[987,1973,1974,1976],{},[597,1975,537],{"href":538}," – boot the module in a test fixture.",[1978,1979,1980],"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 .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sfNiH, html code.shiki .sfNiH{--shiki-light:#FF5370;--shiki-default:#FF9CAC;--shiki-dark:#FF9CAC}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}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 .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}",{"title":631,"searchDepth":670,"depth":670,"links":1982},[1983,1984,1986],{"id":612,"depth":670,"text":613},{"id":1049,"depth":670,"text":1985},"The setup() checklist",{"id":1953,"depth":670,"text":1954},"Declare a module's dependencies and write its setup() with the module-kit helpers, in order.","md",null,{},{"icon":531},{"title":528,"description":1987},"PLC_0As0T4j1DQ62NYpJidT6ww2gNTNsjF6CFNPiIHw",[1995,1997],{"title":524,"path":525,"stem":526,"description":1996,"icon":39,"children":-1},"Create a new Frigear module package in the Frigear repository, with its folder layout and package.json.",{"title":533,"path":534,"stem":535,"description":1998,"icon":44,"children":-1},"Add a table to your module or columns to another module's table, in both dialects, with test fixture migrations.",1794503153260]