[{"data":1,"prerenderedAt":2287},["ShallowReactive",2],{"navigation_docs":3,"-modules-platform-notify":587,"-modules-platform-notify-surround":2282},[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":403,"body":589,"description":2276,"extension":2277,"links":2278,"meta":2279,"navigation":1414,"path":404,"seo":2280,"stem":405,"__hash__":2281},"docs\u002F3.modules\u002F5.platform\u002F2.notify.md",{"type":590,"value":591,"toc":2256},"minimark",[592,600,617,622,657,661,695,699,922,938,942,949,1063,1074,1077,1088,1230,1233,1237,1240,1322,1534,1538,1560,1564,1575,2051,2055,2058,2141,2145,2170,2173,2178,2231,2235,2252],[593,594,595,596,599],"p",{},"Modules send email, such as a sign-in link or a receipt, without choosing an email service. Notify is where your app\npicks how email, SMS and simple notifications are delivered, per environment. For emails designed with Vue components,\nadd ",[597,598,407],"a",{"href":408}," on top.",[593,601,602,603,607,608,616],{},"The package is ",[604,605,606],"code",{},"@frigear-nu\u002Fnotify",". In-app toasts are not part of it: use\n",[597,609,613],{"href":610,"rel":611},"https:\u002F\u002Fui.nuxt.com\u002Fcomposables\u002Fuse-toast",[612],"nofollow",[604,614,615],{},"useToast()"," from Nuxt UI.",[618,619,621],"h2",{"id":620},"what-you-get","What you get",[623,624,625,651],"ul",{},[626,627,628,632],"li",{},[629,630,631],"strong",{},"Composables and helpers.",[623,633,634,641,648],{},[626,635,636,637,640],{},"Server functions that send an email, an SMS or a simple notification, auto-imported in\n",[597,638,639],{"href":87},"Nitro",".",[626,642,643,644,647],{},"A ",[604,645,646],{},"log"," driver that prints each notification instead of sending it. On by default.",[626,649,650],{},"Email drivers for Resend, Amazon SES and Cloudflare Email Service, or a driver file of your own. Opt-in.",[626,652,653,656],{},[629,654,655],{},"Emails."," None of its own. It sends what other modules build.",[658,659],"module-runtime",{":server":660},"true",[662,663,664,667,668,671,672,675,676,678,679,681,682,684,685,687,688,691,692,694],"note",{},[629,665,666],{},"Installed for you:"," nothing.\n",[629,669,670],{},"You add:"," nothing, unless you configure drivers; then add it to ",[604,673,674],{},"modules",". ",[597,677,168],{"href":169}," (server\nmode), ",[597,680,191],{"href":192},", ",[597,683,294],{"href":295},",\n",[597,686,258],{"href":259}," and Email Templates install Notify.\n",[629,689,690],{},"Optional:"," ",[597,693,407],{"href":408},", to render emails from Vue templates.",[618,696,698],{"id":697},"quick-setup","Quick setup",[700,701,702,707,732,739,745,896,907,911],"steps",{},[703,704,706],"h3",{"id":705},"install-the-module","Install the module",[708,709,714],"pre",{"className":710,"code":711,"language":712,"meta":713,"style":713},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","pnpm add @frigear-nu\u002Fnotify\n","bash","",[604,715,716],{"__ignoreMap":713},[717,718,721,725,729],"span",{"class":719,"line":720},"line",1,[717,722,724],{"class":723},"sBMFI","pnpm",[717,726,728],{"class":727},"sfazB"," add",[717,730,731],{"class":727}," @frigear-nu\u002Fnotify\n",[703,733,735,736],{"id":734},"configure-it-in-nuxtconfigts","Configure it in ",[604,737,738],{},"nuxt.config.ts",[593,740,741,742,744],{},"List Notify in ",[604,743,674],{}," only to configure it. This setup sends email through Resend and SMS through your own driver:",[708,746,750],{"className":747,"code":748,"filename":738,"language":749,"meta":713,"style":713},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","export default defineNuxtConfig({\n  modules: ['@frigear-nu\u002Fnotify'],\n  notify: {\n    email: { driver: 'resend' },\n    sms: { driver: '~\u002Fserver\u002Futils\u002Ftwilio-sms-driver' },\n    simple: { driver: 'log' },\n  },\n})\n","ts",[604,751,752,773,798,809,836,859,881,887],{"__ignoreMap":713},[717,753,754,758,761,765,769],{"class":719,"line":720},[717,755,757],{"class":756},"s7zQu","export",[717,759,760],{"class":756}," default",[717,762,764],{"class":763},"s2Zo4"," defineNuxtConfig",[717,766,768],{"class":767},"sTEyZ","(",[717,770,772],{"class":771},"sMK4o","{\n",[717,774,776,780,783,786,789,791,793,796],{"class":719,"line":775},2,[717,777,779],{"class":778},"swJcz","  modules",[717,781,782],{"class":771},":",[717,784,785],{"class":767}," [",[717,787,788],{"class":771},"'",[717,790,606],{"class":727},[717,792,788],{"class":771},[717,794,795],{"class":767},"]",[717,797,684],{"class":771},[717,799,801,804,806],{"class":719,"line":800},3,[717,802,803],{"class":778},"  notify",[717,805,782],{"class":771},[717,807,808],{"class":771}," {\n",[717,810,812,815,817,820,823,825,828,831,833],{"class":719,"line":811},4,[717,813,814],{"class":778},"    email",[717,816,782],{"class":771},[717,818,819],{"class":771}," {",[717,821,822],{"class":778}," driver",[717,824,782],{"class":771},[717,826,827],{"class":771}," '",[717,829,830],{"class":727},"resend",[717,832,788],{"class":771},[717,834,835],{"class":771}," },\n",[717,837,839,842,844,846,848,850,852,855,857],{"class":719,"line":838},5,[717,840,841],{"class":778},"    sms",[717,843,782],{"class":771},[717,845,819],{"class":771},[717,847,822],{"class":778},[717,849,782],{"class":771},[717,851,827],{"class":771},[717,853,854],{"class":727},"~\u002Fserver\u002Futils\u002Ftwilio-sms-driver",[717,856,788],{"class":771},[717,858,835],{"class":771},[717,860,862,865,867,869,871,873,875,877,879],{"class":719,"line":861},6,[717,863,864],{"class":778},"    simple",[717,866,782],{"class":771},[717,868,819],{"class":771},[717,870,822],{"class":778},[717,872,782],{"class":771},[717,874,827],{"class":771},[717,876,646],{"class":727},[717,878,788],{"class":771},[717,880,835],{"class":771},[717,882,884],{"class":719,"line":883},7,[717,885,886],{"class":771},"  },\n",[717,888,890,893],{"class":719,"line":889},8,[717,891,892],{"class":771},"}",[717,894,895],{"class":767},")\n",[897,898,899,900,903,904,906],"caution",{},"Store the API tokens and keys as secrets of your ",[597,901,902],{"href":87},"hosting platform",", never in\n",[604,905,738],{},". Anyone who has them can send email as you.",[703,908,910],{"id":909},"set-the-environment-variables","Set the environment variables",[593,912,913,914,917,918,640],{},"Set ",[604,915,916],{},"NUXT_NOTIFY_EMAIL_FROM"," and the credentials of your email driver, listed under\n",[597,919,921],{"href":920},"#environment-variables","Environment variables",[923,924,927,930,931,933,934,937],"callout",{"color":925,"icon":926},"success","i-lucide-check",[629,928,929],{},"What you should see:"," with the ",[604,932,646],{}," driver, the server console prints ",[604,935,936],{},"[notify] Dispatching notification:"," and\nthe notification. With a real driver, the email arrives.",[618,939,941],{"id":940},"options","Options",[593,943,944,945,948],{},"Options go under the ",[604,946,947],{},"notify"," key. Each notification type has its own driver, and only the configured driver is\nloaded.",[950,951,952,971],"table",{},[953,954,955],"thead",{},[956,957,958,962,965,968],"tr",{},[959,960,961],"th",{},"Option",[959,963,964],{},"Type",[959,966,967],{},"Default",[959,969,970],{},"Purpose",[972,973,974,998,1022,1045],"tbody",{},[956,975,976,982,987,992],{},[977,978,979],"td",{},[604,980,981],{},"email.driver",[977,983,984],{},[604,985,986],{},"'log' | 'resend' | 'ses' | 'cloudflare' | string",[977,988,989],{},[604,990,991],{},"'log'",[977,993,994,995,640],{},"A built-in name, or a path to a file whose default export is an ",[604,996,997],{},"EmailDriver",[956,999,1000,1005,1010,1014],{},[977,1001,1002],{},[604,1003,1004],{},"sms.driver",[977,1006,1007],{},[604,1008,1009],{},"'log' | string",[977,1011,1012],{},[604,1013,991],{},[977,1015,1016,1018,1019,640],{},[604,1017,991],{},", or a path to a file whose default export is an ",[604,1020,1021],{},"SMSDriver",[956,1023,1024,1029,1033,1037],{},[977,1025,1026],{},[604,1027,1028],{},"simple.driver",[977,1030,1031],{},[604,1032,1009],{},[977,1034,1035],{},[604,1036,991],{},[977,1038,1039,1041,1042,640],{},[604,1040,991],{},", or a path to a file whose default export is a ",[604,1043,1044],{},"SimpleDriver",[956,1046,1047,1052,1057,1060],{},[977,1048,1049],{},[604,1050,1051],{},"push.driver",[977,1053,1054],{},[604,1055,1056],{},"string",[977,1058,1059],{},"none",[977,1061,1062],{},"Reserved. Typed, but not implemented.",[593,1064,1065,1069,1070,1073],{},[629,1066,1067],{},[604,1068,981],{}," set to a built-in name only sets the default. ",[604,1071,1072],{},"NUXT_NOTIFY_EMAIL_DRIVER"," overrides it at runtime. A\npath to a file is fixed at build time.",[703,1075,921],{"id":1076},"environment-variables",[593,1078,1079,1080,1083,1084,1087],{},"The built-in email drivers are read from ",[604,1081,1082],{},"runtimeConfig.notify.email"," at runtime, so each environment can use another\nservice without a rebuild. They use plain ",[604,1085,1086],{},"fetch",", with no dependencies. SES requests are signed with AWS Signature\nVersion 4 through Web Crypto.",[950,1089,1090,1102],{},[953,1091,1092],{},[956,1093,1094,1097,1100],{},[959,1095,1096],{},"Variable",[959,1098,1099],{},"Used by",[959,1101,970],{},[972,1103,1104,1128,1143,1155,1171,1183,1195,1207,1219],{},[956,1105,1106,1110,1113],{},[977,1107,1108],{},[604,1109,1072],{},[977,1111,1112],{},"all",[977,1114,1115,1117,1118,681,1120,1123,1124,1127],{},[604,1116,646],{}," (default), ",[604,1119,830],{},[604,1121,1122],{},"ses"," or ",[604,1125,1126],{},"cloudflare",". Any other value throws when sending.",[956,1129,1130,1134,1137],{},[977,1131,1132],{},[604,1133,916],{},[977,1135,1136],{},"resend, ses, cloudflare",[977,1138,1139,1140,640],{},"The sender, such as ",[604,1141,1142],{},"Frigear \u003Cno-reply@frigear.nu>",[956,1144,1145,1150,1152],{},[977,1146,1147],{},[604,1148,1149],{},"NUXT_NOTIFY_EMAIL_RESEND_API_TOKEN",[977,1151,830],{},[977,1153,1154],{},"API token.",[956,1156,1157,1162,1164],{},[977,1158,1159],{},[604,1160,1161],{},"NUXT_NOTIFY_EMAIL_SES_REGION",[977,1163,1122],{},[977,1165,1166,1167,1170],{},"AWS region, such as ",[604,1168,1169],{},"eu-west-1",". Uses the SES v2 API.",[956,1172,1173,1178,1180],{},[977,1174,1175],{},[604,1176,1177],{},"NUXT_NOTIFY_EMAIL_SES_ACCESS_KEY_ID",[977,1179,1122],{},[977,1181,1182],{},"Access key id.",[956,1184,1185,1190,1192],{},[977,1186,1187],{},[604,1188,1189],{},"NUXT_NOTIFY_EMAIL_SES_SECRET_ACCESS_KEY",[977,1191,1122],{},[977,1193,1194],{},"Secret access key.",[956,1196,1197,1202,1204],{},[977,1198,1199],{},[604,1200,1201],{},"NUXT_NOTIFY_EMAIL_SES_SESSION_TOKEN",[977,1203,1122],{},[977,1205,1206],{},"Optional, for temporary credentials.",[956,1208,1209,1214,1216],{},[977,1210,1211],{},[604,1212,1213],{},"NUXT_NOTIFY_EMAIL_CLOUDFLARE_ACCOUNT_ID",[977,1215,1126],{},[977,1217,1218],{},"Cloudflare account id (Email Service).",[956,1220,1221,1226,1228],{},[977,1222,1223],{},[604,1224,1225],{},"NUXT_NOTIFY_EMAIL_CLOUDFLARE_API_TOKEN",[977,1227,1126],{},[977,1229,1154],{},[593,1231,1232],{},"A missing credential fails the send, with an error that names the variable to set.",[618,1234,1236],{"id":1235},"server","Server",[593,1238,1239],{},"The dispatch functions and the definers are auto-imported in server code wherever the module is installed.",[950,1241,1242,1252],{},[953,1243,1244],{},[956,1245,1246,1249],{},[959,1247,1248],{},"Function",[959,1250,1251],{},"Signature",[972,1253,1254,1266,1278,1290,1306],{},[956,1255,1256,1261],{},[977,1257,1258],{},[604,1259,1260],{},"dispatchEmailNotification",[977,1262,1263],{},[604,1264,1265],{},"(notification: EmailNotification) => Promise\u003Cvoid>",[956,1267,1268,1273],{},[977,1269,1270],{},[604,1271,1272],{},"dispatchSMSNotification",[977,1274,1275],{},[604,1276,1277],{},"(notification: SMSNotification) => Promise\u003Cvoid>",[956,1279,1280,1285],{},[977,1281,1282],{},[604,1283,1284],{},"dispatchSimpleNotification",[977,1286,1287],{},[604,1288,1289],{},"(notification: SimpleNotification) => Promise\u003Cvoid>",[956,1291,1292,1303],{},[977,1293,1294,681,1297,681,1300],{},[604,1295,1296],{},"defineEmailNotification",[604,1298,1299],{},"defineSMSNotification",[604,1301,1302],{},"defineSimpleNotification",[977,1304,1305],{},"Typed helpers that return the notification unchanged.",[956,1307,1308,1319],{},[977,1309,1310,681,1313,681,1316],{},[604,1311,1312],{},"defineEmailDriver",[604,1314,1315],{},"defineSMSDriver",[604,1317,1318],{},"defineSimpleDriver",[977,1320,1321],{},"Typed helpers that return the driver unchanged.",[708,1323,1325],{"className":747,"code":1324,"language":749,"meta":713,"style":713},"await dispatchEmailNotification({\n  to: user.email,\n  subject: 'Welcome!',\n  body: '\u003Cp>Thanks for signing up.\u003C\u002Fp>',\n  text: 'Thanks for signing up.',\n})\n\nawait dispatchSMSNotification({\n  to: user.phone,\n  body: 'Your verification code is 123456.',\n})\n\nawait dispatchSimpleNotification({\n  title: 'New signup',\n  text: `${user.email} just signed up.`,\n})\n",[604,1326,1327,1339,1356,1372,1388,1404,1410,1416,1427,1443,1459,1466,1471,1483,1500,1527],{"__ignoreMap":713},[717,1328,1329,1332,1335,1337],{"class":719,"line":720},[717,1330,1331],{"class":756},"await",[717,1333,1334],{"class":763}," dispatchEmailNotification",[717,1336,768],{"class":767},[717,1338,772],{"class":771},[717,1340,1341,1344,1346,1349,1351,1354],{"class":719,"line":775},[717,1342,1343],{"class":778},"  to",[717,1345,782],{"class":771},[717,1347,1348],{"class":767}," user",[717,1350,640],{"class":771},[717,1352,1353],{"class":767},"email",[717,1355,684],{"class":771},[717,1357,1358,1361,1363,1365,1368,1370],{"class":719,"line":800},[717,1359,1360],{"class":778},"  subject",[717,1362,782],{"class":771},[717,1364,827],{"class":771},[717,1366,1367],{"class":727},"Welcome!",[717,1369,788],{"class":771},[717,1371,684],{"class":771},[717,1373,1374,1377,1379,1381,1384,1386],{"class":719,"line":811},[717,1375,1376],{"class":778},"  body",[717,1378,782],{"class":771},[717,1380,827],{"class":771},[717,1382,1383],{"class":727},"\u003Cp>Thanks for signing up.\u003C\u002Fp>",[717,1385,788],{"class":771},[717,1387,684],{"class":771},[717,1389,1390,1393,1395,1397,1400,1402],{"class":719,"line":838},[717,1391,1392],{"class":778},"  text",[717,1394,782],{"class":771},[717,1396,827],{"class":771},[717,1398,1399],{"class":727},"Thanks for signing up.",[717,1401,788],{"class":771},[717,1403,684],{"class":771},[717,1405,1406,1408],{"class":719,"line":861},[717,1407,892],{"class":771},[717,1409,895],{"class":767},[717,1411,1412],{"class":719,"line":883},[717,1413,1415],{"emptyLinePlaceholder":1414},true,"\n",[717,1417,1418,1420,1423,1425],{"class":719,"line":889},[717,1419,1331],{"class":756},[717,1421,1422],{"class":763}," dispatchSMSNotification",[717,1424,768],{"class":767},[717,1426,772],{"class":771},[717,1428,1430,1432,1434,1436,1438,1441],{"class":719,"line":1429},9,[717,1431,1343],{"class":778},[717,1433,782],{"class":771},[717,1435,1348],{"class":767},[717,1437,640],{"class":771},[717,1439,1440],{"class":767},"phone",[717,1442,684],{"class":771},[717,1444,1446,1448,1450,1452,1455,1457],{"class":719,"line":1445},10,[717,1447,1376],{"class":778},[717,1449,782],{"class":771},[717,1451,827],{"class":771},[717,1453,1454],{"class":727},"Your verification code is 123456.",[717,1456,788],{"class":771},[717,1458,684],{"class":771},[717,1460,1462,1464],{"class":719,"line":1461},11,[717,1463,892],{"class":771},[717,1465,895],{"class":767},[717,1467,1469],{"class":719,"line":1468},12,[717,1470,1415],{"emptyLinePlaceholder":1414},[717,1472,1474,1476,1479,1481],{"class":719,"line":1473},13,[717,1475,1331],{"class":756},[717,1477,1478],{"class":763}," dispatchSimpleNotification",[717,1480,768],{"class":767},[717,1482,772],{"class":771},[717,1484,1486,1489,1491,1493,1496,1498],{"class":719,"line":1485},14,[717,1487,1488],{"class":778},"  title",[717,1490,782],{"class":771},[717,1492,827],{"class":771},[717,1494,1495],{"class":727},"New signup",[717,1497,788],{"class":771},[717,1499,684],{"class":771},[717,1501,1503,1505,1507,1510,1513,1515,1517,1519,1522,1525],{"class":719,"line":1502},15,[717,1504,1392],{"class":778},[717,1506,782],{"class":771},[717,1508,1509],{"class":771}," `${",[717,1511,1512],{"class":767},"user",[717,1514,640],{"class":771},[717,1516,1353],{"class":767},[717,1518,892],{"class":771},[717,1520,1521],{"class":727}," just signed up.",[717,1523,1524],{"class":771},"`",[717,1526,684],{"class":771},[717,1528,1530,1532],{"class":719,"line":1529},16,[717,1531,892],{"class":771},[717,1533,895],{"class":767},[703,1535,1537],{"id":1536},"templates","Templates",[593,1539,1540,1541,1543,1544,1547,1548,1551,1552,1555,1556,1559],{},"Notify renders no templates itself. ",[604,1542,1260],{}," calls the ",[604,1545,1546],{},"notify:email"," hook before the driver runs,\nwhere Email Templates renders ",[604,1549,1550],{},"notification.template",". Without a renderer, ",[604,1553,1554],{},"subject"," and ",[604,1557,1558],{},"body"," are sent as built.",[703,1561,1563],{"id":1562},"types","Types",[593,1565,1566,1567,1570,1571,1574],{},"The types are exported from ",[604,1568,1569],{},"@frigear-nu\u002Fnotify\u002Ftypes",". The package root re-exports the notification, driver and\n",[604,1572,1573],{},"ModuleOptions"," types.",[708,1576,1578],{"className":747,"code":1577,"language":749,"meta":713,"style":713},"interface EmailNotification\u003CM = NotificationMeta> {\n  to: string | string[]\n  subject: string\n  \u002F** HTML body. *\u002F\n  body: string\n  \u002F** Optional plain-text body. *\u002F\n  text?: string\n  \u002F** Address replies go to (the `Reply-To` header). *\u002F\n  replyTo?: string\n  \u002F** Template to render instead of subject\u002Fbody\u002Ftext, when a renderer is installed. *\u002F\n  template?: { name: string, props?: Record\u003Cstring, unknown>, locale?: string }\n  meta?: M\n}\n\ninterface SMSNotification\u003CM = NotificationMeta> {\n  to: string | string[]\n  body: string\n  meta?: M\n}\n\ninterface SimpleNotification\u003CM = Record\u003Cstring, unknown>> {\n  title: string\n  text: string\n  \u002F** Optional URL to open when the notification is clicked. *\u002F\n  url?: string\n  meta?: M\n}\n\ntype NotificationMeta\u003CAdditionalMeta = Record\u003Cstring, unknown>> = { driver?: string } & AdditionalMeta\n\ntype EmailDriver = (notification: EmailNotification) => Promise\u003Cvoid> | void\ntype SMSDriver = (notification: SMSNotification) => Promise\u003Cvoid> | void\ntype SimpleDriver = (notification: SimpleNotification) => Promise\u003Cvoid> | void\n",[604,1579,1580,1606,1623,1632,1638,1646,1651,1660,1665,1674,1679,1728,1738,1743,1747,1766,1780,1789,1798,1803,1808,1837,1846,1855,1861,1871,1880,1885,1890,1936,1941,1983,2017],{"__ignoreMap":713},[717,1581,1582,1586,1589,1592,1595,1598,1601,1604],{"class":719,"line":720},[717,1583,1585],{"class":1584},"spNyl","interface",[717,1587,1588],{"class":723}," EmailNotification",[717,1590,1591],{"class":771},"\u003C",[717,1593,1594],{"class":723},"M",[717,1596,1597],{"class":771}," =",[717,1599,1600],{"class":723}," NotificationMeta",[717,1602,1603],{"class":771},">",[717,1605,808],{"class":771},[717,1607,1608,1610,1612,1615,1618,1620],{"class":719,"line":775},[717,1609,1343],{"class":778},[717,1611,782],{"class":771},[717,1613,1614],{"class":723}," string",[717,1616,1617],{"class":771}," |",[717,1619,1614],{"class":723},[717,1621,1622],{"class":767},"[]\n",[717,1624,1625,1627,1629],{"class":719,"line":800},[717,1626,1360],{"class":778},[717,1628,782],{"class":771},[717,1630,1631],{"class":723}," string\n",[717,1633,1634],{"class":719,"line":811},[717,1635,1637],{"class":1636},"sHwdD","  \u002F** HTML body. *\u002F\n",[717,1639,1640,1642,1644],{"class":719,"line":838},[717,1641,1376],{"class":778},[717,1643,782],{"class":771},[717,1645,1631],{"class":723},[717,1647,1648],{"class":719,"line":861},[717,1649,1650],{"class":1636},"  \u002F** Optional plain-text body. *\u002F\n",[717,1652,1653,1655,1658],{"class":719,"line":883},[717,1654,1392],{"class":778},[717,1656,1657],{"class":771},"?:",[717,1659,1631],{"class":723},[717,1661,1662],{"class":719,"line":889},[717,1663,1664],{"class":1636},"  \u002F** Address replies go to (the `Reply-To` header). *\u002F\n",[717,1666,1667,1670,1672],{"class":719,"line":1429},[717,1668,1669],{"class":778},"  replyTo",[717,1671,1657],{"class":771},[717,1673,1631],{"class":723},[717,1675,1676],{"class":719,"line":1445},[717,1677,1678],{"class":1636},"  \u002F** Template to render instead of subject\u002Fbody\u002Ftext, when a renderer is installed. *\u002F\n",[717,1680,1681,1684,1686,1688,1691,1693,1695,1698,1701,1703,1706,1708,1710,1712,1715,1718,1721,1723,1725],{"class":719,"line":1461},[717,1682,1683],{"class":778},"  template",[717,1685,1657],{"class":771},[717,1687,819],{"class":771},[717,1689,1690],{"class":778}," name",[717,1692,782],{"class":771},[717,1694,1614],{"class":723},[717,1696,1697],{"class":771},",",[717,1699,1700],{"class":778}," props",[717,1702,1657],{"class":771},[717,1704,1705],{"class":723}," Record",[717,1707,1591],{"class":771},[717,1709,1056],{"class":723},[717,1711,1697],{"class":771},[717,1713,1714],{"class":723}," unknown",[717,1716,1717],{"class":771},">,",[717,1719,1720],{"class":778}," locale",[717,1722,1657],{"class":771},[717,1724,1614],{"class":723},[717,1726,1727],{"class":771}," }\n",[717,1729,1730,1733,1735],{"class":719,"line":1468},[717,1731,1732],{"class":778},"  meta",[717,1734,1657],{"class":771},[717,1736,1737],{"class":723}," M\n",[717,1739,1740],{"class":719,"line":1473},[717,1741,1742],{"class":771},"}\n",[717,1744,1745],{"class":719,"line":1485},[717,1746,1415],{"emptyLinePlaceholder":1414},[717,1748,1749,1751,1754,1756,1758,1760,1762,1764],{"class":719,"line":1502},[717,1750,1585],{"class":1584},[717,1752,1753],{"class":723}," SMSNotification",[717,1755,1591],{"class":771},[717,1757,1594],{"class":723},[717,1759,1597],{"class":771},[717,1761,1600],{"class":723},[717,1763,1603],{"class":771},[717,1765,808],{"class":771},[717,1767,1768,1770,1772,1774,1776,1778],{"class":719,"line":1529},[717,1769,1343],{"class":778},[717,1771,782],{"class":771},[717,1773,1614],{"class":723},[717,1775,1617],{"class":771},[717,1777,1614],{"class":723},[717,1779,1622],{"class":767},[717,1781,1783,1785,1787],{"class":719,"line":1782},17,[717,1784,1376],{"class":778},[717,1786,782],{"class":771},[717,1788,1631],{"class":723},[717,1790,1792,1794,1796],{"class":719,"line":1791},18,[717,1793,1732],{"class":778},[717,1795,1657],{"class":771},[717,1797,1737],{"class":723},[717,1799,1801],{"class":719,"line":1800},19,[717,1802,1742],{"class":771},[717,1804,1806],{"class":719,"line":1805},20,[717,1807,1415],{"emptyLinePlaceholder":1414},[717,1809,1811,1813,1816,1818,1820,1822,1824,1826,1828,1830,1832,1835],{"class":719,"line":1810},21,[717,1812,1585],{"class":1584},[717,1814,1815],{"class":723}," SimpleNotification",[717,1817,1591],{"class":771},[717,1819,1594],{"class":723},[717,1821,1597],{"class":771},[717,1823,1705],{"class":723},[717,1825,1591],{"class":771},[717,1827,1056],{"class":723},[717,1829,1697],{"class":771},[717,1831,1714],{"class":723},[717,1833,1834],{"class":771},">>",[717,1836,808],{"class":771},[717,1838,1840,1842,1844],{"class":719,"line":1839},22,[717,1841,1488],{"class":778},[717,1843,782],{"class":771},[717,1845,1631],{"class":723},[717,1847,1849,1851,1853],{"class":719,"line":1848},23,[717,1850,1392],{"class":778},[717,1852,782],{"class":771},[717,1854,1631],{"class":723},[717,1856,1858],{"class":719,"line":1857},24,[717,1859,1860],{"class":1636},"  \u002F** Optional URL to open when the notification is clicked. *\u002F\n",[717,1862,1864,1867,1869],{"class":719,"line":1863},25,[717,1865,1866],{"class":778},"  url",[717,1868,1657],{"class":771},[717,1870,1631],{"class":723},[717,1872,1874,1876,1878],{"class":719,"line":1873},26,[717,1875,1732],{"class":778},[717,1877,1657],{"class":771},[717,1879,1737],{"class":723},[717,1881,1883],{"class":719,"line":1882},27,[717,1884,1742],{"class":771},[717,1886,1888],{"class":719,"line":1887},28,[717,1889,1415],{"emptyLinePlaceholder":1414},[717,1891,1893,1896,1898,1900,1903,1905,1907,1909,1911,1913,1915,1917,1919,1921,1923,1925,1927,1930,1933],{"class":719,"line":1892},29,[717,1894,1895],{"class":1584},"type",[717,1897,1600],{"class":723},[717,1899,1591],{"class":771},[717,1901,1902],{"class":723},"AdditionalMeta",[717,1904,1597],{"class":771},[717,1906,1705],{"class":723},[717,1908,1591],{"class":771},[717,1910,1056],{"class":723},[717,1912,1697],{"class":771},[717,1914,1714],{"class":723},[717,1916,1834],{"class":771},[717,1918,1597],{"class":771},[717,1920,819],{"class":771},[717,1922,822],{"class":778},[717,1924,1657],{"class":771},[717,1926,1614],{"class":723},[717,1928,1929],{"class":771}," }",[717,1931,1932],{"class":771}," &",[717,1934,1935],{"class":723}," AdditionalMeta\n",[717,1937,1939],{"class":719,"line":1938},30,[717,1940,1415],{"emptyLinePlaceholder":1414},[717,1942,1944,1946,1949,1951,1954,1958,1960,1962,1965,1968,1971,1973,1976,1978,1980],{"class":719,"line":1943},31,[717,1945,1895],{"class":1584},[717,1947,1948],{"class":723}," EmailDriver",[717,1950,1597],{"class":771},[717,1952,1953],{"class":771}," (",[717,1955,1957],{"class":1956},"sHdIc","notification",[717,1959,782],{"class":771},[717,1961,1588],{"class":723},[717,1963,1964],{"class":771},")",[717,1966,1967],{"class":1584}," =>",[717,1969,1970],{"class":723}," Promise",[717,1972,1591],{"class":771},[717,1974,1975],{"class":723},"void",[717,1977,1603],{"class":771},[717,1979,1617],{"class":771},[717,1981,1982],{"class":723}," void\n",[717,1984,1986,1988,1991,1993,1995,1997,1999,2001,2003,2005,2007,2009,2011,2013,2015],{"class":719,"line":1985},32,[717,1987,1895],{"class":1584},[717,1989,1990],{"class":723}," SMSDriver",[717,1992,1597],{"class":771},[717,1994,1953],{"class":771},[717,1996,1957],{"class":1956},[717,1998,782],{"class":771},[717,2000,1753],{"class":723},[717,2002,1964],{"class":771},[717,2004,1967],{"class":1584},[717,2006,1970],{"class":723},[717,2008,1591],{"class":771},[717,2010,1975],{"class":723},[717,2012,1603],{"class":771},[717,2014,1617],{"class":771},[717,2016,1982],{"class":723},[717,2018,2020,2022,2025,2027,2029,2031,2033,2035,2037,2039,2041,2043,2045,2047,2049],{"class":719,"line":2019},33,[717,2021,1895],{"class":1584},[717,2023,2024],{"class":723}," SimpleDriver",[717,2026,1597],{"class":771},[717,2028,1953],{"class":771},[717,2030,1957],{"class":1956},[717,2032,782],{"class":771},[717,2034,1815],{"class":723},[717,2036,1964],{"class":771},[717,2038,1967],{"class":1584},[717,2040,1970],{"class":723},[717,2042,1591],{"class":771},[717,2044,1975],{"class":723},[717,2046,1603],{"class":771},[717,2048,1617],{"class":771},[717,2050,1982],{"class":723},[703,2052,2054],{"id":2053},"custom-driver","Custom driver",[593,2056,2057],{},"A driver is a function that delivers one notification. Point the driver option at a file whose default export is that\nfunction:",[708,2059,2062],{"className":747,"code":2060,"filename":2061,"language":749,"meta":713,"style":713},"import type { EmailDriver } from '@frigear-nu\u002Fnotify\u002Ftypes'\n\nconst sendWithResend: EmailDriver = async (notification) => {\n  \u002F\u002F call your provider with notification.to \u002F subject \u002F body \u002F text \u002F replyTo\n}\n\nexport default sendWithResend\n","server\u002Futils\u002Fresend-email-driver.ts",[604,2063,2064,2088,2092,2119,2124,2128,2132],{"__ignoreMap":713},[717,2065,2066,2069,2072,2074,2076,2078,2081,2083,2085],{"class":719,"line":720},[717,2067,2068],{"class":756},"import",[717,2070,2071],{"class":756}," type",[717,2073,819],{"class":771},[717,2075,1948],{"class":767},[717,2077,1929],{"class":771},[717,2079,2080],{"class":756}," from",[717,2082,827],{"class":771},[717,2084,1569],{"class":727},[717,2086,2087],{"class":771},"'\n",[717,2089,2090],{"class":719,"line":775},[717,2091,1415],{"emptyLinePlaceholder":1414},[717,2093,2094,2097,2100,2102,2104,2106,2109,2111,2113,2115,2117],{"class":719,"line":800},[717,2095,2096],{"class":1584},"const",[717,2098,2099],{"class":767}," sendWithResend",[717,2101,782],{"class":771},[717,2103,1948],{"class":723},[717,2105,1597],{"class":771},[717,2107,2108],{"class":1584}," async",[717,2110,1953],{"class":771},[717,2112,1957],{"class":1956},[717,2114,1964],{"class":771},[717,2116,1967],{"class":1584},[717,2118,808],{"class":771},[717,2120,2121],{"class":719,"line":811},[717,2122,2123],{"class":1636},"  \u002F\u002F call your provider with notification.to \u002F subject \u002F body \u002F text \u002F replyTo\n",[717,2125,2126],{"class":719,"line":838},[717,2127,1742],{"class":771},[717,2129,2130],{"class":719,"line":861},[717,2131,1415],{"emptyLinePlaceholder":1414},[717,2133,2134,2136,2138],{"class":719,"line":883},[717,2135,757],{"class":756},[717,2137,760],{"class":756},[717,2139,2140],{"class":767}," sendWithResend\n",[703,2142,2144],{"id":2143},"store-types","Store types",[593,2146,2147,2149,2150,1555,2153,2156,2157,681,2160,684,2163,1555,2166,2169],{},[604,2148,1569],{}," also exports ",[604,2151,2152],{},"StoredNotification",[604,2154,2155],{},"NotificationStore",", a contract with ",[604,2158,2159],{},"put",[604,2161,2162],{},"get",[604,2164,2165],{},"list",[604,2167,2168],{},"delete"," for keeping notifications. Nothing in the module uses a store yet, and dispatch records nothing.",[618,2171,234],{"id":2172},"hooks",[593,2174,2175,2176,640],{},"A renderer such as Email Templates listens to these ",[597,2177,2172],{"href":87},[950,2179,2180,2193],{},[953,2181,2182],{},[956,2183,2184,2187,2190],{},[959,2185,2186],{},"Hook",[959,2188,2189],{},"When",[959,2191,2192],{},"Payload",[972,2194,2195,2211],{},[956,2196,2197,2202,2205],{},[977,2198,2199,2201],{},[604,2200,1546],{}," (Nitro)",[977,2203,2204],{},"An email is about to go to the driver.",[977,2206,2207,2210],{},[604,2208,2209],{},"{ notification }",", replaceable",[956,2212,2213,2219,2222],{},[977,2214,2215,2218],{},[604,2216,2217],{},"notify:email:templates"," (Nuxt)",[977,2220,2221],{},"A renderer collects the template folders that modules ship.",[977,2223,2224,2227,2228],{},[604,2225,2226],{},"EmailTemplateSource[]",": push ",[604,2229,2230],{},"{ dir }",[618,2232,2234],{"id":2233},"next-steps","Next steps",[623,2236,2237,2242,2247],{},[626,2238,2239,2241],{},[597,2240,407],{"href":408}," – render your emails from Vue components with your branding.",[626,2243,2244,2246],{},[597,2245,500],{"href":501}," – send your first email from a server route.",[626,2248,2249,2251],{},[597,2250,46],{"href":47}," – set the driver's secrets on your hosting platform.",[2253,2254,2255],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}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 .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 .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 .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}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 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":713,"searchDepth":775,"depth":775,"links":2257},[2258,2259,2265,2268,2274,2275],{"id":620,"depth":775,"text":621},{"id":697,"depth":775,"text":698,"children":2260},[2261,2262,2264],{"id":705,"depth":800,"text":706},{"id":734,"depth":800,"text":2263},"Configure it in nuxt.config.ts",{"id":909,"depth":800,"text":910},{"id":940,"depth":775,"text":941,"children":2266},[2267],{"id":1076,"depth":800,"text":921},{"id":1235,"depth":775,"text":1236,"children":2269},[2270,2271,2272,2273],{"id":1536,"depth":800,"text":1537},{"id":1562,"depth":800,"text":1563},{"id":2053,"depth":800,"text":2054},{"id":2143,"depth":800,"text":2144},{"id":2172,"depth":775,"text":234},{"id":2233,"depth":775,"text":2234},"Send email, SMS and simple notifications from any module, with the delivery service chosen once by your app.","md",null,{},{"title":403,"description":2276},"4hVIxZmXUVOKZ0Ydu5fyemU6Mr7nRdZ9ZOkM1GpeBfg",[2283,2285],{"title":399,"path":400,"stem":401,"description":2284,"children":-1},"Give your module tables, add columns to another module's table, ship both dialects and commit migrations.",{"title":173,"path":408,"stem":409,"description":2286,"children":-1},"Design your app's emails, and the emails modules send, as Vue components with your own branding.",1794503145571]