1"use strict";(self.webpackChunk_cromwell_website=self.webpackChunk_cromwell_website||[]).push([[728],{8128:function(e,t,a){a.r(t),a.d(t,{frontMatter:function(){return p},contentTitle:function(){return d},metadata:function(){return m},toc:function(){return k},default:function(){return o}});var n=a(5773),r=a(808),i=(a(7378),a(5318)),l=["components"],p={title:"backend"},d="Module: backend",m={unversionedId:"api/modules/backend",id:"api/modules/backend",isDocsHomePage:!1,title:"backend",description:"CromwellCMS Backend SDK",source:"@site/docs/api/modules/backend.md",sourceDirName:"api/modules",slug:"/api/modules/backend",permalink:"/docs/api/modules/backend",tags:[],version:"current",frontMatter:{title:"backend"},sidebar:"tutorialSidebar",previous:{title:"Redirects / rewrites",permalink:"/docs/development/redirects"},next:{title:"Attribute",permalink:"/docs/api/classes/backend.Attribute"}},k=[{value:"Install",id:"install",children:[]},{value:"Use",id:"use",children:[]},{value:"Table of contents",id:"table-of-contents",children:[{value:"Classes",id:"classes",children:[]},{value:"Type aliases",id:"type-aliases",children:[]},{value:"Variables",id:"variables",children:[]},{value:"Functions",id:"functions",children:[]}]},{value:"Type aliases",id:"type-aliases-1",children:[{value:"Action",id:"action",children:[]},{value:"ActionNames",id:"actionnames",children:[]},{value:"ActionTypes",id:"actiontypes",children:[]},{value:"DeepWriteable",id:"deepwriteable",children:[]},{value:"TAllThemeConfigs",id:"tallthemeconfigs",children:[]},{value:"TAuthSettings",id:"tauthsettings",children:[]},{value:"TAuthUserInfo",id:"tauthuserinfo",children:[]},{value:"TBackendModule",id:"tbackendmodule",children:[]},{value:"TEntityMeta",id:"tentitymeta",children:[]},{value:"TGraphQLContext",id:"tgraphqlcontext",children:[]},{value:"TPluginInfo",id:"tplugininfo",children:[]},{value:"TRequestWithUser",id:"trequestwithuser",children:[]},{value:"TTokenInfo",id:"ttokeninfo",children:[]},{value:"TTokenPayload",id:"ttokenpayload",children:[]},{value:"Writeable",id:"writeable",children:[]}]},{value:"Variables",id:"variables-1",children:[{value:"CustomDateScalar",id:"customdatescalar",children:[]},{value:"GenericCms",id:"genericcms",children:[]},{value:"GenericPlugin",id:"genericplugin",children:[]},{value:"GenericTheme",id:"generictheme",children:[]},{value:"ORMEntities",id:"ormentities",children:[]},{value:"PrimitiveValueScalar",id:"primitivevaluescalar",children:[]},{value:"adminPanelMessages",id:"adminpanelmessages",children:[]},{value:"bcryptSaltRounds",id:"bcryptsaltrounds",children:[]},{value:"buildDirName",id:"builddirname",children:[]},{value:"cmsConfigFileName",id:"cmsconfigfilename",children:[]},{value:"cmsName",id:"cmsname",children:[]},{value:"cmsPackageName",id:"cmspackagename",children:[]},{value:"configFileName",id:"configfilename",children:[]},{value:"defaultCmsConfig",id:"defaultcmsconfig",children:[]},{value:"entityMetaRepository",id:"entitymetarepository",children:[]},{value:"pluginAdminBundlePath",id:"pluginadminbundlepath",children:[]},{value:"pluginAdminCjsPath",id:"pluginadmincjspath",children:[]},{value:"pluginFrontendBundlePath",id:"pluginfrontendbundlepath",children:[]},{value:"pluginFrontendCjsPath",id:"pluginfrontendcjspath",children:[]},{value:"rendererMessages",id:"renderermessages",children:[]},{value:"serverMessages",id:"servermessages",children:[]},{value:"tempDirName",id:"tempdirname",children:[]}]},{value:"Functions",id:"functions-1",children:[{value:"Roles",id:"roles",children:[]},{value:"applyBaseFilter",id:"applybasefilter",children:[]},{value:"applyGetManyFromOne",id:"applygetmanyfromone",children:[]},{value:"applyGetPaged",id:"applygetpaged",children:[]},{value:"checkEntitySlug",id:"checkentityslug",children:[]},{value:"collectPlugins",id:"collectplugins",children:[]},{value:"connectDatabase",id:"connectdatabase",children:[]},{value:"createGenericEntity",id:"creategenericentity",children:[]},{value:"findPlugin",id:"findplugin",children:[]},{value:"findTheme",id:"findtheme",children:[]},{value:"fireAction",id:"fireaction",children:[]},{value:"getAdminPanelDir",id:"getadminpaneldir",children:[]},{value:"getAdminPanelServiceBuildDir",id:"getadminpanelservicebuilddir",children:[]},{value:"getAdminPanelStartupPath",id:"getadminpanelstartuppath",children:[]},{value:"getAdminPanelStaticDir",id:"getadminpanelstaticdir",children:[]},{value:"getAdminPanelTempDir",id:"getadminpaneltempdir",children:[]},{value:"getAdminPanelWebPublicDir",id:"getadminpanelwebpublicdir",children:[]},{value:"getAdminPanelWebServiceBuildDir",id:"getadminpanelwebservicebuilddir",children:[]},{value:"getAuthSettings",id:"getauthsettings",children:[]},{value:"getBundledModulesDir",id:"getbundledmodulesdir",children:[]},{value:"getCmsConfigPath",id:"getcmsconfigpath",children:[]},{value:"getCmsConfigPathSync",id:"getcmsconfigpathsync",children:[]},{value:"getCmsEntity",id:"getcmsentity",children:[]},{value:"getCmsInfo",id:"getcmsinfo",children:[]},{value:"getCmsModuleConfig",id:"getcmsmoduleconfig",children:[]}
1,{value:"getCmsModuleInfo",id:"getcmsmoduleinfo",children:[]},{value:"getCmsSettings",id:"getcmssettings",children:[]},{value:"getCoreBackendDir",id:"getcorebackenddir",children:[]},{value:"getCoreCommonDir",id:"getcorecommondir",children:[]},{value:"getCoreFrontendDir",id:"getcorefrontenddir",children:[]},{value:"getEmailTemplate",id:"getemailtemplate",children:[]},{value:"getErrorLogPath",id:"geterrorlogpath",children:[]},{value:"getLogger",id:"getlogger",children:[]},{value:"getLogsDir",id:"getlogsdir",children:[]},{value:"getManagerDir",id:"getmanagerdir",children:[]},{value:"getManagerTempDir",id:"getmanagertempdir",children:[]},{value:"getMetaInfoPath",id:"getmetainfopath",children:[]},{value:"getMigrationsDirName",id:"getmigrationsdirname",children:[]},{value:"getModulePackage",id:"getmodulepackage",children:[]},{value:"getModuleStaticDir",id:"getmodulestaticdir",children:[]},{value:"getNodeModuleDir",id:"getnodemoduledir",children:[]},{value:"getNodeModuleDirSync",id:"getnodemoduledirsync",children:[]},{value:"getPaged",id:"getpaged",children:[]},{value:"getPluginAdminBundlePath",id:"getpluginadminbundlepath",children:[]},{value:"getPluginAdminCjsPath",id:"getpluginadmincjspath",children:[]},{value:"getPluginBackendPath",id:"getpluginbackendpath",children:[]},{value:"getPluginFrontendBundlePath",id:"getpluginfrontendbundlepath",children:[]},{value:"getPluginFrontendCjsPath",id:"getpluginfrontendcjspath",children:[]},{value:"getPluginFrontendMetaPath",id:"getpluginfrontendmetapath",children:[]},{value:"getPluginSettings",id:"getpluginsettings",children:[]},{value:"getPublicDir",id:"getpublicdir",children:[]},{value:"getPublicPluginsDir",id:"getpublicpluginsdir",children:[]},{value:"getPublicThemesDir",id:"getpublicthemesdir",children:[]},{value:"getRendererBuildDir",id:"getrendererbuilddir",children:[]},{value:"getRendererDir",id:"getrendererdir",children:[]},{value:"getRendererStartupPath",id:"getrendererstartuppath",children:[]},{value:"getRendererTempDevDir",id:"getrenderertempdevdir",children:[]},{value:"getRendererTempDir",id:"getrenderertempdir",children:[]},{value:"getServerBuildDir",id:"getserverbuilddir",children:[]},{value:"getServerBuildMonitorPath",id:"getserverbuildmonitorpath",children:[]},{value:"getServerBuildPath",id:"getserverbuildpath",children:[]},{value:"getServerBuildProxyPath",id:"getserverbuildproxypath",children:[]},{value:"getServerCachePath",id:"getservercachepath",children:[]},{value:"getServerDefaultEmailsDir",id:"getserverdefaultemailsdir",children:[]},{value:"getServerDir",id:"getserverdir",children:[]},{value:"getServerStartupPath",id:"getserverstartuppath",children:[]},{value:"getServerTempDir",id:"getservertempdir",children:[]},{value:"getServerTempEmailsDir",id:"getservertempemailsdir",children:[]},{value:"getSqlBoolStr",id:"getsqlboolstr",children:[]},{value:"getSqlLike",id:"getsqllike",children:[]},{value:"getTempDir",id:"gettempdir",children:[]},{value:"getThemeAdminPanelDir",id:"getthemeadminpaneldir",children:[]},{value:"getThemeBuildDir",id:"getthemebuilddir",children:[]},{value:"getThemeConfigs",id:"getthemeconfigs",children:[]},{value:"getThemeNextBuildDir",id:"getthemenextbuilddir",children:[]},{value:"getThemeNextBuildDirByPath",id:"getthemenextbuilddirbypath",children:[]},{value:"getThemePagesMetaPath",id:"getthemepagesmetapath",children:[]},{value:"getThemePagesVirtualPath",id:"getthemepagesvirtualpath",children:[]},{value:"getThemeRollupBuildDir",id:"getthemerollupbuilddir",children:[]},{value:"getThemeRollupBuildDirByPath",id:"getthemerollupbuilddirbypath",children:[]},{value:"getThemeTempAdminPanelDir",id:"getthemetempadminpaneldir",children:[]},{value:"getThemeTempRollupBuildDir",id:"getthemetemprollupbuilddir",children:[]},{value:"getUtilsBuildDir",id:"getutilsbuilddir",children:[]},{value:"getUtilsDir",id:"getutilsdir",children:[]},{value:"getUtilsImporterPath",id:"getutilsimporterpath",children:[]},{value:"getUtilsTempDir",id:"getutilstempdir",children:[]},{value:"graphQlAuthChecker",id:"graphqlauthchecker",children:[]},{value:"handleBaseInput",id:"handlebaseinput",children:[]},{value:"handleCustomMetaInput",id:"handlecustommetainput",children:[]},{value:"isExternalForm",id:"isexternalform",children:[]},{value:"isSimpleString",id:"issimplestring",children:[]},{value:"readCMSConfig",id:"readcmsconfig",children:[]},{value:"readCMSConfigSync",id:"readcmsconfigsync",children:[]},{value:"readCmsModules",id:"readcmsmodules",children:[]},{value:"readPackage",id:"readpackage",children:[]},{value:"readPluginsExports",id:"readpluginsexports",children:[]},{value:"registerAction",id:"registeraction",children:[]},{value:"resolvePackageJsonPath",id:"resolvepackagejsonpath",children:[]},{value:"runShellCommand",id:"runshellcommand",children:[]},{value:"savePlugin",id:"saveplugin",children:[]},{value:"savePluginSettings",id:"savepluginsettings",children:[]},{value:"sendEmail",id:"sendemail",children:[]},{value:"validateEmail",id:"validateemail",children:[]},{value:"wrapInQuotes",id:"wrapinquotes",children:[]}]}],s={toc:k};function o(e){var t=e.components,a=(0,r.Z)(e,l);return(0,i.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"module-backend"},"Module: backend"),(0,i.kt)("p",null,"CromwellCMS Backend SDK"),(0,i.kt)("p",null,"Exports backend helpers, ORM repositories and entities."),(0,i.kt)("h3",{id:"install"},"Install"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"},"npm i @cromwell/core-backend\n")),(0,i.kt)("h3",{id:"use"},"Use"),(0,i.kt)("p",null,"Example of usage"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ts"},"import { ProductRepository } from '@cromwell/core-backend';\nimport { getCustomRepository } from 'typeorm';\n\nconst products = await getCustomRepository(ProductRepository).getProducts();\n")),(0,i.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,i.kt)("h3",{id:"classes"},"Classes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.Attribute"},"Attribute")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.AttributeInput"},"AttributeInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.AttributeInstance"},"AttributeInstance")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.AttributeInstanceValue"},"AttributeInstanceValue")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.AttributeMeta"},"AttributeMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.AttributeRepository"},"AttributeRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.AttributeToProduct"},"AttributeToProduct")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.AttributeValue"},"AttributeValue")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.AttributeValueInput"},"AttributeValueInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.BaseEntityMeta"},"BaseEntityMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.BaseFilterInput"},"BaseFilterInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.BasePageEntity"},"BasePageEntity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.BasePageInput"},"BasePageInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.BasePageMeta"},"BasePageMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.BasePageMetaInput"},"BasePageMetaInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.BaseRepository"},"BaseRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CmsEntity"},"CmsEntity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.Coupon"},"Coupon")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CouponInput"},"CouponInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CouponMeta"},"CouponMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CouponRepository"},"CouponRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CreatePost"},"CreatePost")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CreateProduct"},"CreateProduct")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CreateProductCategory"},"CreateProductCategory")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CreateUser"},"CreateUser")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CustomEntity"},"CustomEntity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CustomEntityFilterInput"},"CustomEntityFilterInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CustomEntityInput"},"CustomEntityInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CustomEntityMeta"},"CustomEntityMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.CustomEntityRepository"},"CustomEntityRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.DeleteManyInput"},"DeleteManyInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.FilteredProduct"},"FilteredProduct")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.GenericPluginResolver"},"GenericPluginResolver")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.GenericThemeResolver"},"GenericThemeResolver")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.InputTag"},"InputTag")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.JwtAuthGuard"},"JwtAuthGuard")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.Order"},"Order")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.OrderFilterInput"},"OrderFilterInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.OrderInput"},"OrderInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.OrderMeta"},"OrderMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.OrderRepository"},"OrderRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PageStats"},"PageStats")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PageStatsRepository"},"PageStatsRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedCoupon"},"PagedCoupon")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedCustomEntity"},"PagedCustomEntity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedMeta"},"PagedMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedOrder"},"PagedOrder")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedParamsInput"},"PagedParamsInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedPost"},"PagedPost")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedProduct"},"PagedProduct")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedProductCategory"},"PagedProductCategory")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedProductReview"},"PagedProductReview")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedTag"},"PagedTag")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PagedUser"},"PagedUser")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PluginEntity"},"PluginEntity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PluginInput"},"PluginInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PluginRepository"},"PluginRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.Post"},"Post")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PostComment"},"PostComment")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PostFilterInput"},"PostFilterInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PostMeta"},"PostMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PostRepository"},"PostRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.Product"},"Product")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductCategory"},"ProductCategory")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductCategoryFilterInput"},"ProductCategoryFilterInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductCategoryMeta"},"ProductCategoryMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductCategoryRepository"},"ProductCategoryRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductFilterAttributes"},"ProductFilterAttributes")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductFilterInput"},"ProductFilterInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductFilterMeta"},"ProductFilterMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductMeta"},"ProductMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductRating"},"ProductRating")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductRepository"},"ProductRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductReview"},"ProductReview")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductReviewFilter"},"ProductReviewFilter")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductReviewInput"},"ProductReviewInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductReviewRepository"},"ProductReviewRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductVariant"},"ProductVariant")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductVariantInput"},"ProductVariantInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/back
1end.ProductVariantMeta"},"ProductVariantMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ProductVariantRepository"},"ProductVariantRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.PropertySearch"},"PropertySearch")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.SortByOptions"},"SortByOptions")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.Tag"},"Tag")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.TagMeta"},"TagMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.TagRepository"},"TagRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.ThemeEntity"},"ThemeEntity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.UpdatePost"},"UpdatePost")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.UpdateProduct"},"UpdateProduct")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.UpdateProductCategory"},"UpdateProductCategory")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.UpdateUser"},"UpdateUser")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.User"},"User")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.UserFilterInput"},"UserFilterInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.UserMeta"},"UserMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/classes/backend.UserRepository"},"UserRepository"))),(0,i.kt)("h3",{id:"type-aliases"},"Type aliases"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#action"},"Action")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#actionnames"},"ActionNames")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#actiontypes"},"ActionTypes")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#deepwriteable"},"DeepWriteable")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#tallthemeconfigs"},"TAllThemeConfigs")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#tauthsettings"},"TAuthSettings")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#tauthuserinfo"},"TAuthUserInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#tbackendmodule"},"TBackendModule")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#tentitymeta"},"TEntityMeta")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#tgraphqlcontext"},"TGraphQLContext")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#tplugininfo"},"TPluginInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#trequestwithuser"},"TRequestWithUser")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#ttokeninfo"},"TTokenInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#ttokenpayload"},"TTokenPayload")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#writeable"},"Writeable"))),(0,i.kt)("h3",{id:"variables"},"Variables"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#customdatescalar"},"CustomDateScalar")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#genericcms"},"GenericCms")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#genericplugin"},"GenericPlugin")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#generictheme"},"GenericTheme")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#ormentities"},"ORMEntities")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#primitivevaluescalar"},"PrimitiveValueScalar")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#adminpanelmessages"},"adminPanelMessages")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#bcryptsaltrounds"},"bcryptSaltRounds")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#builddirname"},"buildDirName")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#cmsconfigfilename"},"cmsConfigFileName")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#cmsname"},"cmsName")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#cmspackagename"},"cmsPackageName")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#configfilename"},"configFileName")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#defaultcmsconfig"},"defaultCmsConfig")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#entitymetarepository"},"entityMetaRepository")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#pluginadminbundlepath"},"pluginAdminBundlePath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#pluginadmincjspath"},"pluginAdminCjsPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#pluginfrontendbundlepath"},"pluginFrontendBundlePath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#pluginfrontendcjspath"},"pluginFrontendCjsPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#renderermessages"},"rendererMessages")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#servermessages"},"serverMessages")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#tempdirname"},"tempDirName"))),(0,i.kt)("h3",{id:"functions"},"Functions"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#roles"},"Roles")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#applybasefilter"},"applyBaseFilter")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#applygetmanyfromone"},"applyGetManyFromOne")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#applygetpaged"},"applyGetPaged")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#checkentityslug"},"checkEntitySlug")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#collectplugins"},"collectPlugins")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#connectdatabase"},"connectDatabase")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#creategenericentity"},"createGenericEntity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#findplugin"},"findPlugin")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#findtheme"},"findTheme")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#fireaction"},"fireAction")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getadminpaneldir"},"getAdminPanelDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getadminpanelservicebuilddir"},"getAdminPanelServiceBuildDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getadminpanelstartuppath"},"getAdminPanelStartupPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getadminpanelstaticdir"},"getAdminPanelStaticDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getadminpaneltempdir"},"getAdminPanelTempDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getadminpanelwebpublicdir"},"getAdminPanelWebPublicDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getadminpanelwebservicebuilddir"},"getAdminPanelWebServiceBuildDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getauthsettings"},"getAuthSettings")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getbundledmodulesdir"},"getBundledModulesDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getcmsconfigpath"},"getCmsConfigPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getcmsconfigpathsync"},"getCmsConfigPathSync")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getcmsentity"},"getCmsEntity")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getcmsinfo"},"getCmsInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getcmsmoduleconfig"}
1,"getCmsModuleConfig")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getcmsmoduleinfo"},"getCmsModuleInfo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getcmssettings"},"getCmsSettings")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getcorebackenddir"},"getCoreBackendDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getcorecommondir"},"getCoreCommonDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getcorefrontenddir"},"getCoreFrontendDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getemailtemplate"},"getEmailTemplate")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#geterrorlogpath"},"getErrorLogPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getlogger"},"getLogger")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getlogsdir"},"getLogsDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getmanagerdir"},"getManagerDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getmanagertempdir"},"getManagerTempDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getmetainfopath"},"getMetaInfoPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getmigrationsdirname"},"getMigrationsDirName")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getmodulepackage"},"getModulePackage")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getmodulestaticdir"},"getModuleStaticDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getnodemoduledir"},"getNodeModuleDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getnodemoduledirsync"},"getNodeModuleDirSync")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpaged"},"getPaged")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpluginadminbundlepath"},"getPluginAdminBundlePath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpluginadmincjspath"},"getPluginAdminCjsPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpluginbackendpath"},"getPluginBackendPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpluginfrontendbundlepath"},"getPluginFrontendBundlePath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpluginfrontendcjspath"},"getPluginFrontendCjsPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpluginfrontendmetapath"},"getPluginFrontendMetaPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpluginsettings"},"getPluginSettings")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpublicdir"},"getPublicDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpublicpluginsdir"},"getPublicPluginsDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getpublicthemesdir"},"getPublicThemesDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getrendererbuilddir"},"getRendererBuildDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getrendererdir"},"getRendererDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getrendererstartuppath"},"getRendererStartupPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getrenderertempdevdir"},"getRendererTempDevDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getrenderertempdir"},"getRendererTempDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getserverbuilddir"},"getServerBuildDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getserverbuildmonitorpath"},"getServerBuildMonitorPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getserverbuildpath"},"getServerBuildPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getserverbuildproxypath"},"getServerBuildProxyPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getservercachepath"},"getServerCachePath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getserverdefaultemailsdir"},"getServerDefaultEmailsDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getserverdir"},"getServerDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getserverstartuppath"},"getServerStartupPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getservertempdir"},"getServerTempDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getservertempemailsdir"},"getServerTempEmailsDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getsqlboolstr"},"getSqlBoolStr")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getsqllike"},"getSqlLike")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#gettempdir"},"getTempDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemeadminpaneldir"},"getThemeAdminPanelDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemebuilddir"},"getThemeBuildDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemeconfigs"},"getThemeConfigs")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemenextbuilddir"},"getThemeNextBuildDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemenextbuilddirbypath"},"getThemeNextBuildDirByPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemepagesmetapath"},"getThemePagesMetaPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemepagesvirtualpath"},"getThemePagesVirtualPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemerollupbuilddir"},"getThemeRollupBuildDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemerollupbuilddirbypath"},"getThemeRollupBuildDirByPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemetempadminpaneldir"},"getThemeTempAdminPanelDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getthemetemprollupbuilddir"},"getThemeTempRollupBuildDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getutilsbuilddir"},"getUtilsBuildDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getutilsdir"},"getUtilsDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getutilsimporterpath"},"getUtilsImporterPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#getutilstempdir"},"getUtilsTempDir")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#graphqlauthchecker"},"graphQlAuthChecker")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#handlebaseinput"},"handleBaseInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#handlecustommetainput"},"handleCustomMetaInput")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#isexternalform"},"isExternalForm")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#issimplestring"},"isSimpleString")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#readcmsconfig"},"readCMSConfig")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#readcmsconfigsync"},"readCMSConfigSync")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#readcmsmodules"},"readCmsModules")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#readpackage"},"readPackage")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#readpluginsexports"},"readPluginsExports")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#registeraction"},"registerAction")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#resolvepackagejsonpath"},"resolvePackageJsonPath")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#runshellcommand"},"runShellCommand")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#saveplugin"},"savePlugin")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#savepluginsettings"},"savePluginSettings")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#sendemail"},"sendEmail")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#validateemail"},"validateEmail")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#wrapinquotes"},"wrapInQuotes"))),(0,i.kt)("h2",{id:"type-aliases-1"},"Type aliases"),(0,i.kt)("h3",{id:"action"},"Action"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Action"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"PayloadType"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"OutputType"),">",": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PayloadType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PayloadType"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"OutputType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"output")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"OutputType"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"payload")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"PayloadType"))))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/types.ts#L25"},"system/core/backend/src/helpers/types.ts:25")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"actionnames"},"ActionNames"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ActionNames"),": keyof ",(0,i.kt)("a",{parentName:"p",href:"#actiontypes"},(0,i.kt)("inlineCode",{parentName:"a"},"ActionTypes"))),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/types.ts#L91"},"system/core/backend/src/helpers/types.ts:91")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"actiontypes"},"ActionTypes"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"ActionTypes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_attribute")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TAttribute"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_coupon")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"}
1,"TCoupon"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_custom_entity")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TCustomEntity"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_order")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TOrder"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_payment")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TOrderPaymentSession"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_post")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TPost"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_post_comment")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TPostComment"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_product")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TProduct"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_product_category")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TProductCategory"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_product_review")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TProductReview"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_tag")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TTag"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"create_user")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TUser"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_attribute")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_coupon")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_custom_entity")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_order")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_post")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_post_comment")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_product")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_product_category")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_product_review")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_tag")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"delete_user")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"install_plugin")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"install_theme")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"uninstall_plugin")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"uninstall_theme")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_attribute")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TAttribute"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_coupon")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"}
1,"TCoupon"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_custom_entity")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TCustomEntity"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_order")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TOrder"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_plugin")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_post")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TPost"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_post_comment")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TPostComment"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_product")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TProduct"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_product_category")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TProductCategory"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_product_review")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TProductReview"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_settings")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TCmsSettings"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_tag")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TTag"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_theme")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"Object"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"update_user")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#action"},(0,i.kt)("inlineCode",{parentName:"a"},"Action")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TUser"),">")))),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/types.ts#L30"},"system/core/backend/src/helpers/types.ts:30")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"deepwriteable"},"DeepWriteable"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"DeepWriteable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": { -readonly","[P in keyof T]",": DeepWriteable<T","[P]",">","}"),(0,i.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/connect-database.ts#L20"},"system/core/backend/src/helpers/connect-database.ts:20")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tallthemeconfigs"},"TAllThemeConfigs"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TAllThemeConfigs"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"themeConfig")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TThemeConfig")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"null"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"themeInfo")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TPackageCromwellConfig")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"null"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"userConfig")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TThemeConfig")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"null"))))),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/theme-config.ts#L18"},"system/core/backend/src/helpers/theme-config.ts:18")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tauthsettings"},"TAuthSettings"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TAuthSettings"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"accessSecret")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"accessTokenCookieName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"cookieSecret")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"expirationAccessTime")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"expirationRefreshTime")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"maxTokensPerUser")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"refreshSecret")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"refreshTokenCookieName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"resetPasswordAttempts")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"resetPasswordCodeExpirationAccessTime")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"serviceSecret")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/auth-settings.ts#L8"},"system/core/backend/src/helpers/auth-settings.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tauthuserinfo"},"TAuthUserInfo"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TAuthUserInfo"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"email?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"null"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"role")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TUserRole"))))),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/auth-guards.ts#L7"},"system/core/backend/src/helpers/auth-guards.ts:7")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tbackendmodule"},"TBackendModule"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TBackendModule"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"controllers?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"unknown"),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"entities?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"unknown"),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"migrations?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"unknown"),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"providers?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"unknown"),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"resolvers?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"unknown"),"[]")))),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/types.ts#L17"},"system/core/backend/src/helpers/types.ts:17")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tentitymeta"},"TEntityMeta"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TEntityMeta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"entityId?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"key?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"null"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"value?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"null"))))),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/entities/meta/base-meta.entity.ts#L4"},"system/core/backend/src/models/entities/meta/base-meta.entity.ts:4")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tgraphqlcontext"},"TGraphQLContext"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TGraphQLContext"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"user?")),(0,i.kt)("td",{parentName:"tr",
1align:"left"},(0,i.kt)("a",{parentName:"td",href:"#tauthuserinfo"},(0,i.kt)("inlineCode",{parentName:"a"},"TAuthUserInfo")))))),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/auth-guards.ts#L30"},"system/core/backend/src/helpers/auth-guards.ts:30")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tplugininfo"},"TPluginInfo"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TPluginInfo"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"adminPanelPath?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"backendPath?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"frontendPath?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"pluginDir")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"pluginName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/plugin-exports.ts#L19"},"system/core/backend/src/helpers/plugin-exports.ts:19")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"trequestwithuser"},"TRequestWithUser"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TRequestWithUser"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"FastifyRequest")," & { ",(0,i.kt)("inlineCode",{parentName:"p"},"cookies"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,i.kt)("inlineCode",{parentName:"p"},"user"),": ",(0,i.kt)("a",{parentName:"p",href:"#tauthuserinfo"},(0,i.kt)("inlineCode",{parentName:"a"},"TAuthUserInfo"))," }"),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/auth-guards.ts#L19"},"system/core/backend/src/helpers/auth-guards.ts:19")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ttokeninfo"},"TTokenInfo"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TTokenInfo"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"cookie")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"maxAge")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"token")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/auth-guards.ts#L24"},"system/core/backend/src/helpers/auth-guards.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ttokenpayload"},"TTokenPayload"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"TTokenPayload"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"role")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TUserRole"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"sub")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"username?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"null"))))),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/auth-guards.ts#L13"},"system/core/backend/src/helpers/auth-guards.ts:13")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"writeable"},"Writeable"),(0,i.kt)("p",null,"\u01ac ",(0,i.kt)("strong",{parentName:"p"},"Writeable"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",": { -readonly","[P in keyof T]",": T","[P]","}"),(0,i.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/connect-database.ts#L16"},"system/core/backend/src/helpers/connect-database.ts:16")),(0,i.kt)("h2",{id:"variables-1"},"Variables"),(0,i.kt)("h3",{id:"customdatescalar"},"CustomDateScalar"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"CustomDateScalar"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"GraphQLScalarType")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/objects/custom-date.scalar.ts#L3"},"system/core/backend/src/models/objects/custom-date.scalar.ts:3")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"genericcms"},"GenericCms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"GenericCms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"abstractResolver")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"createArgs")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"pagedEntity")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"repository")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ObjectType"),"<",(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.BaseRepository"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseRepository")),"<",(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.CmsEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"CmsEntity")),", ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.CmsEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"CmsEntity")),">",">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"updateArgs")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/generic-entities.ts#L12"},"system/core/backend/src/helpers/generic-entities.ts:12")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"genericplugin"},"GenericPlugin"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"GenericPlugin"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"abstractResolver")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"createArgs")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"pagedEntity")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"repository")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ObjectType"),"<",(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.BaseRepository"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseRepository")),"<",(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.PluginEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PluginEntity")),", ",(0,i.kt)("inlineCode",{parentName:"td"},"TPluginEntityInput"),">",">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"updateArgs")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/generic-entities.ts#L11"},"system/core/backend/src/helpers/generic-entities.ts:11")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"generictheme"},"GenericTheme"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"GenericTheme"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"abstractResolver")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"createArgs")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"pagedEntity")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"repository")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ObjectType"),"<",(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.BaseRepository"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseRepository")),"<",(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.ThemeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"ThemeEntity")),", ",(0,i.kt)("inlineCode",{parentName:"td"},"TThemeEntityInput"),">",">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"updateArgs")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/generic-entities.ts#L10"},"system/core/backend/src/helpers/generic-entities.ts:10")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ormentities"},"ORMEntities"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"ORMEntities"),": (typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.ThemeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"ThemeEntity"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.Product"},(0,i.kt)("inlineCode",{parentName:"a"},"Product"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.ProductCategory"},(0,i.kt)("inlineCode",{parentName:"a"},"ProductCategory"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.Post"},(0,i.kt)("inlineCode",{parentName:"a"},"Post"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.User"},(0,i.kt)("inlineCode",{parentName:"a"},"User"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.Attribute"},(0,i.kt)("inlineCode",{parentName:"a"},"Attribute"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.ProductReview"},(0,i.kt)("inlineCode",{parentName:"a"},"ProductReview"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.Order"},(0,i.kt)("inlineCode",{parentName:"a"},"Order"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CmsEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"CmsEntity"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.Tag"},(0,i.kt)("inlineCode",{parentName:"a"},"Tag"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.PageStats"},(0,i.kt)("inlineCode",{parentName:"a"},"PageStats")
1)," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.PostComment"},(0,i.kt)("inlineCode",{parentName:"a"},"PostComment"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.AttributeMeta"},(0,i.kt)("inlineCode",{parentName:"a"},"AttributeMeta"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.OrderMeta"},(0,i.kt)("inlineCode",{parentName:"a"},"OrderMeta"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.PostMeta"},(0,i.kt)("inlineCode",{parentName:"a"},"PostMeta"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.ProductCategoryMeta"},(0,i.kt)("inlineCode",{parentName:"a"},"ProductCategoryMeta"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.ProductMeta"},(0,i.kt)("inlineCode",{parentName:"a"},"ProductMeta"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.TagMeta"},(0,i.kt)("inlineCode",{parentName:"a"},"TagMeta"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.UserMeta"},(0,i.kt)("inlineCode",{parentName:"a"},"UserMeta"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.AttributeToProduct"},(0,i.kt)("inlineCode",{parentName:"a"},"AttributeToProduct"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.AttributeValue"},(0,i.kt)("inlineCode",{parentName:"a"},"AttributeValue"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CustomEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"CustomEntity"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CustomEntityMeta"},(0,i.kt)("inlineCode",{parentName:"a"},"CustomEntityMeta"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.Coupon"},(0,i.kt)("inlineCode",{parentName:"a"},"Coupon"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CouponMeta"},(0,i.kt)("inlineCode",{parentName:"a"},"CouponMeta"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.ProductVariant"},(0,i.kt)("inlineCode",{parentName:"a"},"ProductVariant"))," ","|"," typeof ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.ProductVariantMeta"},(0,i.kt)("inlineCode",{parentName:"a"},"ProductVariantMeta")),")[]"),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/constants.ts#L34"},"system/core/backend/src/helpers/constants.ts:34")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"primitivevaluescalar"},"PrimitiveValueScalar"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"PrimitiveValueScalar"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"GraphQLScalarType")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/objects/primitive-value.scalar.ts#L16"},"system/core/backend/src/models/objects/primitive-value.scalar.ts:16")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"adminpanelmessages"},"adminPanelMessages"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"adminPanelMessages"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onBuildEndMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onBuildErrorMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onBuildStartMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onStartErrorMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onStartMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/constants.ts#L54"},"system/core/backend/src/helpers/constants.ts:54")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"bcryptsaltrounds"},"bcryptSaltRounds"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"bcryptSaltRounds"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"10")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/auth-settings.ts#L6"},"system/core/backend/src/helpers/auth-settings.ts:6")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"builddirname"},"buildDirName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"buildDirName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"build"')),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L10"},"system/core/backend/src/helpers/paths.ts:10")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cmsconfigfilename"},"cmsConfigFileName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"cmsConfigFileName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"cmsconfig.json"')),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L12"},"system/core/backend/src/helpers/paths.ts:12")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cmsname"},"cmsName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"cmsName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"cromwell"')),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L8"},"system/core/backend/src/helpers/paths.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"cmspackagename"},"cmsPackageName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"cmsPackageName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"@cromwell/cms"')),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/constants.ts#L122"},"system/core/backend/src/helpers/constants.ts:122")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"configfilename"},"configFileName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"configFileName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L11"},"system/core/backend/src/helpers/paths.ts:11")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"defaultcmsconfig"},"defaultCmsConfig"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"defaultCmsConfig"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"TCmsConfig")),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/constants.ts#L70"},"system/core/backend/src/helpers/constants.ts:70")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"entitymetarepository"},"entityMetaRepository"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"entityMetaRepository"),": ",(0,i.kt)("inlineCode",{parentName:"p"}
1,"EntityMetaRepository")),(0,i.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/entity-meta.ts#L165"},"system/core/backend/src/helpers/entity-meta.ts:165")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"pluginadminbundlepath"},"pluginAdminBundlePath"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"pluginAdminBundlePath"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"admin/index.js"')),(0,i.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L240"},"system/core/backend/src/helpers/paths.ts:240")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"pluginadmincjspath"},"pluginAdminCjsPath"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"pluginAdminCjsPath"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"admin/cjs.js"')),(0,i.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L241"},"system/core/backend/src/helpers/paths.ts:241")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"pluginfrontendbundlepath"},"pluginFrontendBundlePath"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"pluginFrontendBundlePath"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"frontend/index.js"')),(0,i.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L238"},"system/core/backend/src/helpers/paths.ts:238")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"pluginfrontendcjspath"},"pluginFrontendCjsPath"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"pluginFrontendCjsPath"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"frontend/cjs.js"')),(0,i.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L239"},"system/core/backend/src/helpers/paths.ts:239")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"renderermessages"},"rendererMessages"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"rendererMessages"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-15"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onBuildEndMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onBuildErrorMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onBuildStartMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onStartErrorMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onStartMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/constants.ts#L46"},"system/core/backend/src/helpers/constants.ts:46")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"servermessages"},"serverMessages"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"serverMessages"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration-16"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onBuildEndMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onBuildErrorMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onBuildStartMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onStartErrorMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"onStartMessage")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/constants.ts#L62"},"system/core/backend/src/helpers/constants.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tempdirname"},"tempDirName"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"tempDirName"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L9"},"system/core/backend/src/helpers/paths.ts:9")),(0,i.kt)("h2",{id:"functions-1"},"Functions"),(0,i.kt)("h3",{id:"roles"},"Roles"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"Roles"),"(...",(0,i.kt)("inlineCode",{parentName:"p"},"roles"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"CustomDecorator"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"...roles")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TAuthRole"),"[]")))),(0,i.kt)("h4",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"CustomDecorator"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/auth-guards.ts#L34"},"system/core/backend/src/helpers/auth-guards.ts:34")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"applybasefilter"},"applyBaseFilter"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"applyBaseFilter"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TEntity"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"__namedParameters"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"SelectQueryBuilder"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TEntity"),">"),(0,i.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TEntity"))))),(0,i.kt)("h4",{id:"parameters-1"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"__namedParameters")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"__namedParameters.EntityClass?")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(...",(0,i.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.BasePageEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"BasePageEntity"))," & typeof ",(0,i.kt)("inlineCode",{parentName:"td"},"BaseEntity"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"__namedParameters.dbType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},'"mysql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mariadb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"postgres"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"cockroachdb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sqlite"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mssql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sap"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"oracle"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"cordova"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"nativescript"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"react-native"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sqljs"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mongodb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"aurora-data-api"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"aurora-data-api-pg"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"expo"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"better-sqlite3"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"capacitor"'))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"__namedParameters.entityType?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"EDBEntity"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"__namedParameters.filter")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.BaseFilterInput"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseFilterInput")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"__namedParameters.qb")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"SelectQueryBuilder"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TEntity"),">")))),(0,i.kt)("h4",{id:"returns-1"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"SelectQueryBuilder"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TEntity"),">"),(0,i.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L147"},"system/core/backend/src/helpers/base-queries.ts:147")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"applygetmanyfromone"},"applyGetManyFromOne"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"applyGetManyFromOne"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"qb"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"firstEntityName"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"firstEntityProp"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"secondEntityName"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"secondEntityId"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"SelectQueryBuilder"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,i.kt)("p",null,"Retrieve all related entities of one specified entity by id in many-to-many relationship\nE.g. get all products from a category"),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"prop"))," firstEntityName - table DB name of many"),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"prop"))," firstEntityProp - property of many that refers to relationship"),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"prop"))," secondEntityName - table DB name of one"),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"prop"))," secondEntityId - DB id of one"),(0,i.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"parameters-2"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"qb")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"SelectQueryBuilder"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"firstEntityName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"firstEntityProp")),(0,i.kt)("td",{parentName:"tr",align:"left"},"keyof ",(0,i.kt)("inlineCode",{parentName:"td"},"T"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"secondEntityName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"secondEntityId")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number"))))),(0,i.kt)("h4",{id:"returns-2"},"Returns
1"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"SelectQueryBuilder"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,i.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L37"},"system/core/backend/src/helpers/base-queries.ts:37")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"applygetpaged"},"applyGetPaged"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"applyGetPaged"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"qb"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"sortByTableName?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"SelectQueryBuilder"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,i.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"parameters-3"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"qb")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"SelectQueryBuilder"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"sortByTableName?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TPagedParams"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,i.kt)("h4",{id:"returns-3"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"SelectQueryBuilder"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,i.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L11"},"system/core/backend/src/helpers/base-queries.ts:11")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"checkentityslug"},"checkEntitySlug"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"checkEntitySlug"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"entity"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"EntityClass"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,i.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.BasePageEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"BasePageEntity")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,i.kt)("h4",{id:"parameters-4"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"entity")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"EntityClass")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(...",(0,i.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"returns-4"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,i.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L96"},"system/core/backend/src/helpers/base-queries.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"collectplugins"},"collectPlugins"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"collectPlugins"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("a",{parentName:"p",href:"#tbackendmodule"},(0,i.kt)("inlineCode",{parentName:"a"},"TBackendModule")),">"),(0,i.kt)("h4",{id:"parameters-5"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.cwd?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.updateCache?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-5"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("a",{parentName:"p",href:"#tbackendmodule"},(0,i.kt)("inlineCode",{parentName:"a"},"TBackendModule")),">"),(0,i.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/plugin-exports.ts#L76"},"system/core/backend/src/helpers/plugin-exports.ts:76")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"connectdatabase"},"connectDatabase"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"connectDatabase"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"__namedParameters"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"parameters-6"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"__namedParameters")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"__namedParameters.development?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"__namedParameters.ormConfigOverride?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,i.kt)("a",{parentName:"td",href:"#writeable"},(0,i.kt)("inlineCode",{parentName:"a"},"Writeable")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"MysqlConnectionOptions"),">",">")))),(0,i.kt)("h4",{id:"returns-6"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/connect-database.ts#L24"},"system/core/backend/src/helpers/connect-database.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"creategenericentity"},"createGenericEntity"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"createGenericEntity"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"EntityType"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"EntityInputType"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"entityName"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"EntityClass"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"InputEntityClass?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"EntityType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"EntityType"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"EntityInputType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"EntityType"))))),(0,i.kt)("h4",{id:"parameters-7"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"entityName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"EntityClass")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(...",(0,i.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,i.kt)("inlineCode",{parentName:"td"},"EntityType"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"InputEntityClass?")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(...",(0,i.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,i.kt)("inlineCode",{parentName:"td"},"EntityInputType"))))),(0,i.kt)("h4",{id:"returns-7"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"abstractResolver")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"createArgs")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"pagedEntity")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"repository")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ObjectType"),"<",(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.BaseRepository"},(0,i.kt)("inlineCode",{parentName:"a"},"BaseRepository")),"<",(0,i.kt)("inlineCode",{parentName:"td"},"EntityType"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"EntityInputType"),">",">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"updateArgs")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/create-generic-entity.ts#L10"},"system/core/backend/src/helpers/create-generic-entity.ts:10")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"findplugin"},"findPlugin"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"findPlugin"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"pluginName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TPluginEntity"),">"),(0,i.kt)("h4",{id:"parameters-8"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"pluginName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-8"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TPluginEntity"),">"),(0,i.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/plugin-settings.ts#L8"},"system/core/backend/src/helpers/plugin-settings.ts:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"findtheme"},"findTheme"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"findTheme"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"themeName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TThemeEntity"),">"),(0,i.kt)("h4",{id:"parameters-9"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"themeName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4
1",{id:"returns-9"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TThemeEntity"),">"),(0,i.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/theme-config.ts#L9"},"system/core/backend/src/helpers/theme-config.ts:9")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"fireaction"},"fireAction"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"fireAction"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"TPayload"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"TOutput"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"options"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"TOutput"),">",">"),(0,i.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,i.kt)("a",{parentName:"td",href:"#actiontypes"},(0,i.kt)("inlineCode",{parentName:"a"},"ActionTypes")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TPayload")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#actiontypes"},(0,i.kt)("inlineCode",{parentName:"a"},"ActionTypes")),"[",(0,i.kt)("inlineCode",{parentName:"td"},"T"),'][``"payload"``]')),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TOutput")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#actiontypes"},(0,i.kt)("inlineCode",{parentName:"a"},"ActionTypes")),"[",(0,i.kt)("inlineCode",{parentName:"td"},"T"),'][``"output"``]')))),(0,i.kt)("h4",{id:"parameters-10"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.actionName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"T"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.payload?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TPayload"))))),(0,i.kt)("h4",{id:"returns-10"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"TOutput"),">",">"),(0,i.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/actions.ts#L27"},"system/core/backend/src/helpers/actions.ts:27")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getadminpaneldir"},"getAdminPanelDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getAdminPanelDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-11"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L103"},"system/core/backend/src/helpers/paths.ts:103")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getadminpanelservicebuilddir"},"getAdminPanelServiceBuildDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getAdminPanelServiceBuildDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-12"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L104"},"system/core/backend/src/helpers/paths.ts:104")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getadminpanelstartuppath"},"getAdminPanelStartupPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getAdminPanelStartupPath"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-13"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L116"},"system/core/backend/src/helpers/paths.ts:116")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getadminpanelstaticdir"},"getAdminPanelStaticDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getAdminPanelStaticDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-14"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L120"},"system/core/backend/src/helpers/paths.ts:120")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getadminpaneltempdir"},"getAdminPanelTempDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getAdminPanelTempDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-15"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L108"},"system/core/backend/src/helpers/paths.ts:108")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getadminpanelwebpublicdir"},"getAdminPanelWebPublicDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getAdminPanelWebPublicDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-16"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L113"},"system/core/backend/src/helpers/paths.ts:113")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getadminpanelwebservicebuilddir"},"getAdminPanelWebServiceBuildDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getAdminPanelWebServiceBuildDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-17"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L110"},"system/core/backend/src/helpers/paths.ts:110")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getauthsettings"},"getAuthSettings"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getAuthSettings"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("a",{parentName:"p",href:"#tauthsettings"},(0,i.kt)("inlineCode",{parentName:"a"},"TAuthSettings")),">"),(0,i.kt)("h4",{id:"parameters-11"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.serverCachePath?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-18"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("a",{parentName:"p",href:"#tauthsettings"},(0,i.kt)("inlineCode",{parentName:"a"},"TAuthSettings")),">"),(0,i.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/auth-settings.ts#L24"},"system/core/backend/src/helpers/auth-settings.ts:24")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getbundledmodulesdir"},"getBundledModulesDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getBundledModulesDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-19"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L251"},"system/core/backend/src/helpers/paths.ts:251")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getcmsconfigpath"},"getCmsConfigPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getCmsConfigPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dir?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"parameters-12"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dir?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-20"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L44"},"system/core/backend/src/helpers/paths.ts:44")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getcmsconfigpathsync"},"getCmsConfigPathSync"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getCmsConfigPathSync"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dir?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"parameters-13"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dir?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-21"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"any")),(0,i.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L60"},"system/core/backend/src/helpers/paths.ts:60")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getcmsentity"},"getCmsEntity"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getCmsEntity"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CmsEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"CmsEntity")),">"),(0,i.kt)("h4",{id:"returns-22"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CmsEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"CmsEntity")),">"),(0,i.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/cms-settings.ts#L57"},"system/core/backend/src/helpers/cms-settings.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getcmsinfo"},"getCmsInfo"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getCmsInfo"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TCmsInfo"),">"),(0,i.kt)("h4",{id:"returns-23"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TCmsInfo"),">"),(0,i.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/cms-settings.ts#L104"},"system/core/backend/src/helpers/cms-settings.ts:104")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getcmsmoduleconfig"}
1,"getCmsModuleConfig"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getCmsModuleConfig"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"moduleName?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TModuleConfig"),">"),(0,i.kt)("h4",{id:"parameters-14"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"moduleName?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-24"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TModuleConfig"),">"),(0,i.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L209"},"system/core/backend/src/helpers/paths.ts:209")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getcmsmoduleinfo"},"getCmsModuleInfo"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getCmsModuleInfo"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"moduleName?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TPackageCromwellConfig"),">"),(0,i.kt)("h4",{id:"parameters-15"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"moduleName?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-25"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TPackageCromwellConfig"),">"),(0,i.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L220"},"system/core/backend/src/helpers/paths.ts:220")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getcmssettings"},"getCmsSettings"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getCmsSettings"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TCmsSettings"),">"),(0,i.kt)("h4",{id:"returns-26"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TCmsSettings"),">"),(0,i.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/cms-settings.ts#L72"},"system/core/backend/src/helpers/cms-settings.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getcorebackenddir"},"getCoreBackendDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getCoreBackendDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-27"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-64"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L78"},"system/core/backend/src/helpers/paths.ts:78")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getcorecommondir"},"getCoreCommonDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getCoreCommonDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-28"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-65"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L76"},"system/core/backend/src/helpers/paths.ts:76")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getcorefrontenddir"},"getCoreFrontendDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getCoreFrontendDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-29"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-66"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L77"},"system/core/backend/src/helpers/paths.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getemailtemplate"},"getEmailTemplate"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getEmailTemplate"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"fileName"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"props?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters-16"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"fileName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"props?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,i.kt)("h4",{id:"returns-30"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-67"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/emailing.ts#L14"},"system/core/backend/src/helpers/emailing.ts:14")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"geterrorlogpath"},"getErrorLogPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getErrorLogPath"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-31"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-68"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L80"},"system/core/backend/src/helpers/paths.ts:80")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getlogger"},"getLogger"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getLogger"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"writeToFile?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"parameters-17"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"writeToFile")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"true"))))),(0,i.kt)("h4",{id:"returns-32"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"error")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(...",(0,i.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,i.kt)("inlineCode",{parentName:"td"},"void"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"info")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(...",(0,i.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,i.kt)("inlineCode",{parentName:"td"},"void"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"log")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(...",(0,i.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,i.kt)("inlineCode",{parentName:"td"},"void"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"warn")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(...",(0,i.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,i.kt)("inlineCode",{parentName:"td"},"void"))))),(0,i.kt)("h4",{id:"defined-in-69"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/logger.ts#L17"},"system/core/backend/src/helpers/logger.ts:17")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getlogsdir"},"getLogsDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getLogsDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-33"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-70"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L79"},"system/core/backend/src/helpers/paths.ts:79")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getmanagerdir"},"getManagerDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getManagerDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-34"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-71"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L83"},"system/core/backend/src/helpers/paths.ts:83")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getmanagertempdir"},"getManagerTempDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getManagerTempDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-35"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-72"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L84"},"system/core/backend/src/helpers/paths.ts:84")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getmetainfopath"},"getMetaInfoPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getMetaInfoPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"filename"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-18"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"filename")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-36"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-73"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L236"},"system/core/backend/src/helpers/paths.ts:236")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getmigrationsdirname"},"getMigrationsDirName"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getMigrationsDirName"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dbType"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"migrations/sqlite"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"migrations/mysql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"migrations/postgres"')),(0,i.kt)("h4",{id:"parameters-19"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dbType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},'"mysql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mariadb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"postgres"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"cockroachdb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sqlite"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mssql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sap"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"oracle"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"cordova"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"nativescript"'),"
1","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"react-native"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sqljs"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mongodb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"aurora-data-api"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"aurora-data-api-pg"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"expo"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"better-sqlite3"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"capacitor"'))))),(0,i.kt)("h4",{id:"returns-37"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"migrations/sqlite"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"migrations/mysql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"migrations/postgres"')),(0,i.kt)("h4",{id:"defined-in-74"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/constants.ts#L124"},"system/core/backend/src/helpers/constants.ts:124")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getmodulepackage"},"getModulePackage"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getModulePackage"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"moduleName?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TPackageJson"),">"),(0,i.kt)("h4",{id:"parameters-20"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"moduleName?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-38"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"TPackageJson"),">"),(0,i.kt)("h4",{id:"defined-in-75"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L262"},"system/core/backend/src/helpers/paths.ts:262")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getmodulestaticdir"},"getModuleStaticDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getModuleStaticDir"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"moduleName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters-21"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"moduleName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-39"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-76"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L229"},"system/core/backend/src/helpers/paths.ts:229")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getnodemoduledir"},"getNodeModuleDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getNodeModuleDir"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"moduleName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters-22"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"moduleName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-40"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-77"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L31"},"system/core/backend/src/helpers/paths.ts:31")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getnodemoduledirsync"},"getNodeModuleDirSync"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getNodeModuleDirSync"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"moduleName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-23"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"moduleName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-41"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-78"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L22"},"system/core/backend/src/helpers/paths.ts:22")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpaged"},"getPaged"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPaged"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"qb"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"sortByTableName?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TPagedList"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,i.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"parameters-24"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"qb")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"SelectQueryBuilder"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"sortByTableName?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"params?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TPagedParams"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,i.kt)("h4",{id:"returns-42"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TPagedList"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,i.kt)("h4",{id:"defined-in-79"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L44"},"system/core/backend/src/helpers/base-queries.ts:44")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpluginadminbundlepath"},"getPluginAdminBundlePath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPluginAdminBundlePath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"distDir"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-25"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"distDir")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-43"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-80"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L245"},"system/core/backend/src/helpers/paths.ts:245")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpluginadmincjspath"},"getPluginAdminCjsPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPluginAdminCjsPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"distDir"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-26"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"distDir")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-44"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-81"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L246"},"system/core/backend/src/helpers/paths.ts:246")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpluginbackendpath"},"getPluginBackendPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPluginBackendPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"distDir"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-27"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"distDir")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-45"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-82"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L247"},"system/core/backend/src/helpers/paths.ts:247")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpluginfrontendbundlepath"},"getPluginFrontendBundlePath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPluginFrontendBundlePath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"distDir"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-28"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"distDir")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-46"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-83"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L242"},"system/core/backend/src/helpers/paths.ts:242")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpluginfrontendcjspath"},"getPluginFrontendCjsPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPluginFrontendCjsPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"distDir"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-29"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"distDir")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-47"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-84"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L243"},"system/core/backend/src/helpers/paths.ts:243")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpluginfrontendmetapath"},"getPluginFrontendMetaPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPluginFrontendMetaPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"distDir"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-30"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"distDir")),(0,i.kt)("td",{parentName:"tr",align:"left"
1},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-48"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-85"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L244"},"system/core/backend/src/helpers/paths.ts:244")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpluginsettings"},"getPluginSettings"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPluginSettings"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"pluginName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"parameters-31"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"pluginName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-49"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"defined-in-86"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/plugin-settings.ts#L26"},"system/core/backend/src/helpers/plugin-settings.ts:26")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpublicdir"},"getPublicDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPublicDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-50"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-87"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L253"},"system/core/backend/src/helpers/paths.ts:253")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpublicpluginsdir"},"getPublicPluginsDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPublicPluginsDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-51"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-88"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L254"},"system/core/backend/src/helpers/paths.ts:254")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getpublicthemesdir"},"getPublicThemesDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getPublicThemesDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-52"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-89"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L255"},"system/core/backend/src/helpers/paths.ts:255")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getrendererbuilddir"},"getRendererBuildDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getRendererBuildDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-53"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-90"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L95"},"system/core/backend/src/helpers/paths.ts:95")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getrendererdir"},"getRendererDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getRendererDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-54"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-91"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L88"},"system/core/backend/src/helpers/paths.ts:88")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getrendererstartuppath"},"getRendererStartupPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getRendererStartupPath"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-55"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-92"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L89"},"system/core/backend/src/helpers/paths.ts:89")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getrenderertempdevdir"},"getRendererTempDevDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getRendererTempDevDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-56"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-93"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L94"},"system/core/backend/src/helpers/paths.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getrenderertempdir"},"getRendererTempDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getRendererTempDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-57"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-94"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L93"},"system/core/backend/src/helpers/paths.ts:93")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getserverbuilddir"},"getServerBuildDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getServerBuildDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-58"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-95"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L131"},"system/core/backend/src/helpers/paths.ts:131")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getserverbuildmonitorpath"},"getServerBuildMonitorPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getServerBuildMonitorPath"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-59"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-96"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L143"},"system/core/backend/src/helpers/paths.ts:143")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getserverbuildpath"},"getServerBuildPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getServerBuildPath"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-60"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-97"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L135"},"system/core/backend/src/helpers/paths.ts:135")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getserverbuildproxypath"},"getServerBuildProxyPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getServerBuildProxyPath"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-61"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-98"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L139"},"system/core/backend/src/helpers/paths.ts:139")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getservercachepath"},"getServerCachePath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getServerCachePath"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-62"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-99"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L153"},"system/core/backend/src/helpers/paths.ts:153")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getserverdefaultemailsdir"},"getServerDefaultEmailsDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getServerDefaultEmailsDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"returns-63"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-100"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L149"},"system/core/backend/src/helpers/paths.ts:149")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getserverdir"},"getServerDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getServerDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-64"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-101"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L126"},"system/core/backend/src/helpers/paths.ts:126")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getserverstartuppath"},"getServerStartupPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getServerStartupPath"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-65"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-102"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L127"},"system/core/backend/src/helpers/paths.ts:127")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getservertempdir"},"getServerTempDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getServerTempDir"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dir?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-32"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dir?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-66"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-103"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L147"},"system/core/backend/src/helpers/paths.ts:147")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getservertempemailsdir"},"getServerTempEmailsDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getServerTempEmailsDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-67"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-104"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L148"},"system/core/backend/src/helpers/paths.ts:148")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getsqlboolstr"},"getSqlBoolStr"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getSqlBoolStr"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dbType"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"b"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},'"true"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"false"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"1"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"0"')),(0,i.kt)("h4",{id:"parameters-33"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dbType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},'"mysql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mariadb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"postgres"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"cockroachdb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sqlite"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mssql"')
1," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sap"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"oracle"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"cordova"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"nativescript"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"react-native"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sqljs"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mongodb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"aurora-data-api"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"aurora-data-api-pg"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"expo"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"better-sqlite3"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"capacitor"'))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"b")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,i.kt)("h4",{id:"returns-68"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},'"true"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"false"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"1"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"0"')),(0,i.kt)("h4",{id:"defined-in-105"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L130"},"system/core/backend/src/helpers/base-queries.ts:130")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getsqllike"},"getSqlLike"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getSqlLike"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dbType"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},'"ILIKE"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"LIKE"')),(0,i.kt)("h4",{id:"parameters-34"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dbType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},'"mysql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mariadb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"postgres"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"cockroachdb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sqlite"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mssql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sap"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"oracle"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"cordova"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"nativescript"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"react-native"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sqljs"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mongodb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"aurora-data-api"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"aurora-data-api-pg"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"expo"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"better-sqlite3"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"capacitor"'))))),(0,i.kt)("h4",{id:"returns-69"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},'"ILIKE"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"LIKE"')),(0,i.kt)("h4",{id:"defined-in-106"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L137"},"system/core/backend/src/helpers/base-queries.ts:137")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"gettempdir"},"getTempDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getTempDir"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dir?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-35"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dir?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-70"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-107"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L14"},"system/core/backend/src/helpers/paths.ts:14")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemeadminpaneldir"},"getThemeAdminPanelDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemeAdminPanelDir"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"themeModuleName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters-36"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"themeModuleName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-71"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-108"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L202"},"system/core/backend/src/helpers/paths.ts:202")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemebuilddir"},"getThemeBuildDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemeBuildDir"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"themeModuleName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters-37"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"themeModuleName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-72"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-109"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L170"},"system/core/backend/src/helpers/paths.ts:170")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemeconfigs"},"getThemeConfigs"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemeConfigs"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"themeName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("a",{parentName:"p",href:"#tallthemeconfigs"},(0,i.kt)("inlineCode",{parentName:"a"},"TAllThemeConfigs")),">"),(0,i.kt)("p",null,"Get currently active Theme's configs from DB"),(0,i.kt)("h4",{id:"parameters-38"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"}
1,"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"themeName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"specify Theme to get config from, otherwise it will return from an active theme")))),(0,i.kt)("h4",{id:"returns-73"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("a",{parentName:"p",href:"#tallthemeconfigs"},(0,i.kt)("inlineCode",{parentName:"a"},"TAllThemeConfigs")),">"),(0,i.kt)("h4",{id:"defined-in-110"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/theme-config.ts#L28"},"system/core/backend/src/helpers/theme-config.ts:28")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemenextbuilddir"},"getThemeNextBuildDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemeNextBuildDir"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"themeModuleName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters-39"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"themeModuleName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-74"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-111"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L189"},"system/core/backend/src/helpers/paths.ts:189")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemenextbuilddirbypath"},"getThemeNextBuildDirByPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemeNextBuildDirByPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"themeDir"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-40"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"themeDir")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-75"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-112"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L195"},"system/core/backend/src/helpers/paths.ts:195")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemepagesmetapath"},"getThemePagesMetaPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemePagesMetaPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"distDir"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-41"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"distDir")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-76"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-113"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L248"},"system/core/backend/src/helpers/paths.ts:248")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemepagesvirtualpath"},"getThemePagesVirtualPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemePagesVirtualPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"distDir"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-42"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"distDir")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-77"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-114"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L249"},"system/core/backend/src/helpers/paths.ts:249")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemerollupbuilddir"},"getThemeRollupBuildDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemeRollupBuildDir"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"themeModuleName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"parameters-43"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"themeModuleName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-78"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"defined-in-115"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L179"},"system/core/backend/src/helpers/paths.ts:179")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemerollupbuilddirbypath"},"getThemeRollupBuildDirByPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemeRollupBuildDirByPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"themeDir"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-44"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"themeDir")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-79"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-116"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L185"},"system/core/backend/src/helpers/paths.ts:185")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemetempadminpaneldir"},"getThemeTempAdminPanelDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemeTempAdminPanelDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-80"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-117"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L198"},"system/core/backend/src/helpers/paths.ts:198")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getthemetemprollupbuilddir"},"getThemeTempRollupBuildDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getThemeTempRollupBuildDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-81"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-118"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L176"},"system/core/backend/src/helpers/paths.ts:176")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getutilsbuilddir"},"getUtilsBuildDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getUtilsBuildDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-82"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-119"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L163"},"system/core/backend/src/helpers/paths.ts:163")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getutilsdir"},"getUtilsDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getUtilsDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-83"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-120"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L158"},"system/core/backend/src/helpers/paths.ts:158")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getutilsimporterpath"},"getUtilsImporterPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getUtilsImporterPath"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-84"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-121"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L159"},"system/core/backend/src/helpers/paths.ts:159")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"getutilstempdir"},"getUtilsTempDir"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"getUtilsTempDir"),"(): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"returns-85"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-122"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L167"},"system/core/backend/src/helpers/paths.ts:167")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"graphqlauthchecker"},"graphQlAuthChecker"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"graphQlAuthChecker"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"roles?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"parameters-45"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"null")," ","|"," { ",(0,i.kt)("inlineCode",{parentName:"td"},"args?"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"any"),">"," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"context?"),": ",(0,i.kt)("a",{parentName:"td",href:"#tgraphqlcontext"},(0,i.kt)("inlineCode",{parentName:"a"},"TGraphQLContext"))," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"info?"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"any")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"root?"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"any")," }")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"roles?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"TAuthRole"),"[]")))),(0,i.kt)("h4",{id:"returns-86"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-123"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/auth-guards.ts#L51"},"system/core/backend/src/helpers/auth-guards.ts:51")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"handlebaseinput"},"handleBaseInput"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"handleBaseInput"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"entity"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"input"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"parameters-46"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"entity")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.BasePageEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"BasePageEntity")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode"
1,{parentName:"td"},"input")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TBasePageEntityInput"))))),(0,i.kt)("h4",{id:"returns-87"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-124"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L62"},"system/core/backend/src/helpers/base-queries.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"handlecustommetainput"},"handleCustomMetaInput"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"handleCustomMetaInput"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"entity"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"input"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,i.kt)("inlineCode",{parentName:"td"},"Object"))))),(0,i.kt)("h4",{id:"parameters-47"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"entity")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/classes/backend.BasePageEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"BasePageEntity")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"input")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))))),(0,i.kt)("h4",{id:"returns-88"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-125"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L77"},"system/core/backend/src/helpers/base-queries.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"isexternalform"},"isExternalForm"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"isExternalForm"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"parameters-48"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"id")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-89"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-126"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L250"},"system/core/backend/src/helpers/paths.ts:250")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"issimplestring"},"isSimpleString"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"isSimpleString"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"str"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'""')),(0,i.kt)("h4",{id:"parameters-49"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"str")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-90"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'""')),(0,i.kt)("h4",{id:"defined-in-127"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L128"},"system/core/backend/src/helpers/base-queries.ts:128")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"readcmsconfig"},"readCMSConfig"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"readCMSConfig"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TCmsConfig"),">"),(0,i.kt)("p",null,"Read CMS config from file in ","[project root]","/cmsconfig.json, saves it into the store and returns"),(0,i.kt)("h4",{id:"parameters-50"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"path?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-91"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TCmsConfig"),">"),(0,i.kt)("h4",{id:"defined-in-128"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/cms-settings.ts#L39"},"system/core/backend/src/helpers/cms-settings.ts:39")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"readcmsconfigsync"},"readCMSConfigSync"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"readCMSConfigSync"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"TCmsConfig")),(0,i.kt)("p",null,"Read CMS config from file in ","[project root]","/cmsconfig.json, saves it into the store and returns"),(0,i.kt)("h4",{id:"parameters-51"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"path?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-92"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"TCmsConfig")),(0,i.kt)("h4",{id:"defined-in-129"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/cms-settings.ts#L21"},"system/core/backend/src/helpers/cms-settings.ts:21")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"readcmsmodules"},"readCmsModules"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"readCmsModules"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dir?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Object"),">"),(0,i.kt)("h4",{id:"parameters-52"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dir?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-93"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"Object"),">"),(0,i.kt)("h4",{id:"defined-in-130"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/cms-modules.ts#L7"},"system/core/backend/src/helpers/cms-modules.ts:7")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"readpackage"},"readPackage"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"readPackage"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"path"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"parameters-53"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"path")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-94"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"defined-in-131"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L257"},"system/core/backend/src/helpers/paths.ts:257")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"readpluginsexports"},"readPluginsExports"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"readPluginsExports"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("a",{parentName:"p",href:"#tplugininfo"}
1,(0,i.kt)("inlineCode",{parentName:"a"},"TPluginInfo")),"[]",">"),(0,i.kt)("h4",{id:"parameters-54"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.cwd?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-95"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("a",{parentName:"p",href:"#tplugininfo"},(0,i.kt)("inlineCode",{parentName:"a"},"TPluginInfo")),"[]",">"),(0,i.kt)("h4",{id:"defined-in-132"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/plugin-exports.ts#L29"},"system/core/backend/src/helpers/plugin-exports.ts:29")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"registeraction"},"registerAction"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"registerAction"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"TPayload"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"TOutput"),">","(",(0,i.kt)("inlineCode",{parentName:"p"},"options"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T")),(0,i.kt)("td",{parentName:"tr",align:"left"},"extends keyof ",(0,i.kt)("a",{parentName:"td",href:"#actiontypes"},(0,i.kt)("inlineCode",{parentName:"a"},"ActionTypes")),"keyof ",(0,i.kt)("a",{parentName:"td",href:"#actiontypes"},(0,i.kt)("inlineCode",{parentName:"a"},"ActionTypes")))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TPayload")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#actiontypes"},(0,i.kt)("inlineCode",{parentName:"a"},"ActionTypes")),"[",(0,i.kt)("inlineCode",{parentName:"td"},"T"),'][``"payload"``]')),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TOutput")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"#actiontypes"},(0,i.kt)("inlineCode",{parentName:"a"},"ActionTypes")),"[",(0,i.kt)("inlineCode",{parentName:"td"},"T"),'][``"output"``]')))),(0,i.kt)("h4",{id:"parameters-55"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Object"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.actionName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"T"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.pluginName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"options.action")),(0,i.kt)("td",{parentName:"tr",align:"left"},"(",(0,i.kt)("inlineCode",{parentName:"td"},"payload"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"TPayload"),") => ",(0,i.kt)("inlineCode",{parentName:"td"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"TOutput"),">")))),(0,i.kt)("h4",{id:"returns-96"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"void")),(0,i.kt)("h4",{id:"defined-in-133"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/actions.ts#L7"},"system/core/backend/src/helpers/actions.ts:7")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"resolvepackagejsonpath"},"resolvePackageJsonPath"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"resolvePackageJsonPath"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"moduleName"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-56"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"moduleName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-97"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-134"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/paths.ts#L16"},"system/core/backend/src/helpers/paths.ts:16")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"runshellcommand"},"runShellCommand"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"runShellCommand"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"command"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"cwd?"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"parameters-57"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"command")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"cwd?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-98"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,i.kt)("h4",{id:"defined-in-135"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/shell.ts#L7"},"system/core/backend/src/helpers/shell.ts:7")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"saveplugin"},"savePlugin"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"savePlugin"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"plugin"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TPluginEntity"),">"),(0,i.kt)("h4",{id:"parameters-58"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"plugin")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"TPluginEntity"))))),(0,i.kt)("h4",{id:"returns-99"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"TPluginEntity"),">"),(0,i.kt)("h4",{id:"defined-in-136"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/plugin-settings.ts#L21"},"system/core/backend/src/helpers/plugin-settings.ts:21")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"savepluginsettings"},"savePluginSettings"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"savePluginSettings"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"pluginName"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"input"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,i.kt)("h4",{id:"parameters-59"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"pluginName")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"input")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-100"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,i.kt)("h4",{id:"defined-in-137"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/plugin-settings.ts#L50"},"system/core/backend/src/helpers/plugin-settings.ts:50")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sendemail"},"sendEmail"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"sendEmail"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"addresses"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"subject"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"htmlContent"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,i.kt)("h4",{id:"parameters-60"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"addresses")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"subject")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"htmlContent")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-101"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,i.kt)("h4",{id:"defined-in-138"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/emailing.ts#L34"},"system/core/backend/src/helpers/emailing.ts:34")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"validateemail"},"validateEmail"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"validateEmail"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"email"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"parameters-61"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"email")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"any"))))),(0,i.kt)("h4",{id:"returns-102"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("h4",{id:"defined-in-139"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/validation.ts#L1"},"system/core/backend/src/helpers/validation.ts:1")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"wrapinquotes"},"wrapInQuotes"),(0,i.kt)("p",null,"\u25b8 ",(0,i.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,i.kt)("strong",{parentName:"p"},"wrapInQuotes"),"(",(0,i.kt)("inlineCode",{parentName:"p"},"dbType"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"str"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"parameters-62"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"dbType")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},'"mysql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mariadb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"postgres"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"cockroachdb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sqlite"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mssql"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sap"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"oracle"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"cordova"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"nativescript"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"react-native"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"sqljs"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"mongodb"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"aurora-data-api"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"aurora-data-api-pg"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"expo"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"better-sqlite3"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"td"},'"capacitor"'))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"str")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"returns-103"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defin
1ed-in-140"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/helpers/base-queries.ts#L142"},"system/core/backend/src/helpers/base-queries.ts:142")))}o.isMDXComponent=!0},5318:function(e,t,a){a.d(t,{Zo:function(){return k},kt:function(){return N}});var n=a(7378);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?i(Object(a),!0).forEach((function(t){r(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function p(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},i=Object.keys(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),m=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},k=function(e){var t=m(e.components);return n.createElement(d.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},o=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,k=p(e,["components","mdxType","originalType","parentName"]),o=m(a),N=r,h=o["".concat(d,".").concat(N)]||o[N]||s[N]||i;return a?n.createElement(h,l(l({ref:t},k),{},{components:a})):n.createElement(h,l({ref:t},k))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=o;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var m=2;m<i;m++)l[m]=a[m];return n.createElement.apply(null,l)}return n.createElement.apply(null,a)}o.displayName="MDXCreateElement"}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.