@paroicms/public-server-lib 0.56.6 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/types.to.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"./common-schema-json-types":{"imports":[{"from":"./site-schema-json-types","namedMembers":[{"name":"JtFieldType"},{"name":"JtLabelLocales"}]}],"namedTypes":[{"name":"JtInternalCommonSchema","exported":true,"docComment":"The common schema is currently an internal file. Here is its typing.","kind":"interface","properties":[{"name":"ParoiCMSSiteSchemaFormatVersion","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"This is the version of the schema engine."},{"name":"languages","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"docComment":"Specify the list of 2-letters language codes that can be used in the websites.\n\n@example [\"en\", \"fr\"]`"},{"name":"siteFields","type":{"kind":"array","itemType":{"kind":"importedRef","refName":"JtFieldType"}},"docComment":"The common fields of any websites. They are currently: `[\"title\", \"contactEmail\", \"favicon\", \"ogImage\"]`."}]},{"name":"JtInternalCommonSchemaTranslations","exported":true,"kind":"interface","properties":[{"name":"languageLabel","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"siteFields","type":{"kind":"interface","indexSignature":{"keyName":"fieldName","keyType":"string","type":{"kind":"importedRef","refName":"JtLabelLocales"}}},"optional":true}]}]},"./configuration-types":{"namedTypes":[{"name":"JtConfiguration","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtSingleSiteConfiguration"},{"kind":"localRef","refName":"JtMultisiteConfiguration"}]},{"name":"JtConfigurationBase","exported":true,"kind":"interface","properties":[{"name":"thisServer","type":{"kind":"localRef","refName":"JtDeprecatedThisServerConf"},"optional":true,"docComment":"@deprecated Move the sub-properties in the parent."},{"name":"port","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"It is required except if the legacy `thisServer` is still used."},{"name":"hostname","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true},{"name":"publicProtocol","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"http"},{"kind":"literal","literal":"https"}]},"optional":true,"docComment":"Default is `\"http\"`."},{"name":"publicPort","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"boPort","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"@deprecated Use adminUiPort instead."},{"name":"adminUiPort","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"allowRobots","type":{"kind":"name","group":"primitive","refName":"boolean"}},{"name":"enableCache","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"immutableAssets","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"cacheTimeToIdle","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"literal","literal":"disabled"},{"kind":"literal","literal":"infinite"}]},"optional":true,"docComment":"For example: `\"14d\"`."},{"name":"clearCacheAfterStart","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"clearImageCacheAfterStart","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"log","type":{"kind":"localRef","refName":"JtLogConf"},"optional":true,"docComment":"@deprecated Replace `log.level` by `logLevel`, and `log.file` by `logFile`."},{"name":"logLevel","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"silent"},{"kind":"literal","literal":"error"},{"kind":"literal","literal":"warn"},{"kind":"literal","literal":"info"},{"kind":"literal","literal":"stats"},{"kind":"literal","literal":"debug"},{"kind":"literal","literal":"trace"}]},"optional":true},{"name":"logFile","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"Omit for stdout."},{"name":"graphqlDevTools","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"generateMissingDatabases","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"googleAuth","type":{"kind":"localRef","refName":"JtGoogleAuthConf"},"optional":true},{"name":"awsSesMail","type":{"kind":"localRef","refName":"JtDeprecatedAwsSesMailConf"},"optional":true,"docComment":"@deprecated Use \"@paroicms/send-mail-aws-ses-plugin\" configuration instead"},{"name":"googleRecaptcha","type":{"kind":"localRef","refName":"JtDeprecatedGoogleRecaptchaConf"},"optional":true,"docComment":"@deprecated Use \"@paroicms/contact-form-plugin\" configuration instead"},{"name":"imageProcessor","type":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtImageProcessorConf"},{"kind":"localRef","refName":"JtLegacyImageProcessorConf"}]},"optional":true},{"name":"devAccount","type":{"kind":"localRef","refName":"JtLocalDevAccountConf"},"optional":true,"docComment":"@deprecated Use localDevAccount instead"},{"name":"localDevAccount","type":{"kind":"localRef","refName":"JtLocalDevAccountConf"},"optional":true},{"name":"platformAdminAccounts","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtPlatformAdminAccountConf"}},"optional":true},{"name":"plugins","type":{"kind":"composite","op":"union","types":[{"kind":"array","itemType":{"kind":"localRef","refName":"JtPluginStaticConfiguration"}},{"kind":"localRef","refName":"JtDeprecatedPluginConfigurations"}]},"optional":true},{"name":"httpRedirections","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtHttpRedirection"}},"optional":true}]},{"name":"JtHttpRedirection","exported":true,"kind":"interface","properties":[{"name":"fromFqdn","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"to","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"mapPaths","type":{"kind":"interface","indexSignature":{"keyName":"fromRegex","keyType":"string","type":{"kind":"name","group":"primitive","refName":"string"}}},"optional":true},{"name":"preservePath","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true}]},{"name":"JtSingleSiteConfiguration","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtConfigurationBase"},{"kind":"interface","properties":[{"name":"singleSite","type":{"kind":"localRef","refName":"JtSingleSiteConf"}}]}]},{"name":"JtMultisiteConfiguration","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtConfigurationBase"},{"kind":"interface","properties":[{"name":"platform","type":{"kind":"interface","properties":[{"name":"dataDir","type":{"kind":"name","group":"primitive","refName":"string"}}]}},{"name":"sitePacks","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtSitePackOrLegacyConf"}}}]}]},{"name":"JtDeprecatedThisServerConf","exported":true,"kind":"interface","properties":[{"name":"port","type":{"kind":"name","group":"primitive","refName":"number"}},{"name":"publicPort","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"boPublicPort","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"hostName","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"name","group":"primitive","refName":"null"}]},"optional":true},{"name":"https","type":{"kind":"name","group":"primitive","refName":"boolean"}}]},{"name":"JtLogConf","exported":true,"kind":"interface","properties":[{"name":"level","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"silent"},{"kind":"literal","literal":"error"},{"kind":"literal","literal":"warn"},{"kind":"literal","literal":"info"},{"kind":"literal","literal":"stats"},{"kind":"literal","literal":"debug"},{"kind":"literal","literal":"trace"}]}},{"name":"file","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"Omit for stdout."}]},{"name":"JtSingleSiteConf","exported":true,"kind":"interface","properties":[{"name":"siteDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"dataDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"cacheDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"backupDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"fqdn","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"redirectWww","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"trusted","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"allowUnsafeLogin","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"Enable auto-login via URL parameter (unsafe, for dev/demo sites only)"}]},{"name":"JtSitePackOrLegacyConf","exported":true,"kind":"composite","op":"union","types":[{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtSitePackConf"},{"kind":"localRef","refName":"JtLegacyFqdnSitePackConf"},{"kind":"localRef","refName":"JtLegacySubDomainSitePackConf"}]}]},{"name":"JtSitePackConf","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtFqdnSitePackConf"},{"kind":"localRef","refName":"JtSubDomainSitePackConf"}]},{"name":"JtSitePackConfBase","exported":true,"kind":"interface","properties":[{"name":"packName","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"sitesDir","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true},{"name":"dataDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"cacheDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"backupDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"redirectWww","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"trusted","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"allowUnsafeLogin","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"Enable auto-login via URL parameter (unsafe, for dev/demo sites only)"}]},{"name":"JtFqdnSitePackConf","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtSitePackConfBase"},{"kind":"interface","properties":[{"name":"serveOn","type":{"kind":"literal","literal":"fqdn"}}]}]},{"name":"JtSubDomainSitePackConf","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtSitePackConfBase"},{"kind":"interface","properties":[{"name":"serveOn","type":{"kind":"literal","literal":"subDomain"}},{"name":"parentDomain","type":{"kind":"name","group":"primitive","refName":"string"}}]}]},{"name":"JtLegacyFqdnSitePackConf","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtSitePackConfBase"},{"kind":"interface","properties":[{"name":"serveAs","type":{"kind":"literal","literal":"fqdn"},"docComment":"@deprecated Renamed to `serveOn`"}]}]},{"name":"JtLegacySubDomainSitePackConf","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtSitePackConfBase"},{"kind":"interface","properties":[{"name":"serveAs","type":{"kind":"literal","literal":"subDomain"},"docComment":"@deprecated Renamed to `serveOn`"},{"name":"parentDomain","type":{"kind":"name","group":"primitive","refName":"string"}}]}]},{"name":"JtGoogleAuthConf","exported":true,"kind":"interface","properties":[{"name":"disabled","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"fqdn","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"clientId","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"clientSecret","type":{"kind":"name","group":"primitive","refName":"string"}}]},{"name":"JtDeprecatedAwsSesMailConf","exported":true,"docComment":"@deprecated Use \"@paroicms/send-mail-aws-ses-plugin\" configuration instead","kind":"interface","properties":[{"name":"disabled","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"from","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"accessKeyId","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"secretAccessKey","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"region","type":{"kind":"name","group":"primitive","refName":"string"}}]},{"name":"JtDeprecatedGoogleRecaptchaConf","exported":true,"docComment":"@deprecated Use \"@paroicms/contact-form-plugin\" configuration instead","kind":"interface","properties":[{"name":"disabled","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"siteKey","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"secretKey","type":{"kind":"name","group":"primitive","refName":"string"}}]},{"name":"JtImageProcessorConf","exported":true,"kind":"interface","properties":[{"name":"cpuCoresPerFile","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"allowConcurrency","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true}]},{"name":"JtLegacyImageProcessorConf","exported":true,"kind":"interface","properties":[{"name":"cpuCoresPerFile","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"oneSharpAtATime","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true}]},{"name":"JtLocalDevAccountConf","exported":true,"kind":"interface","properties":[{"name":"email","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"password","type":{"kind":"name","group":"primitive","refName":"string"}}]},{"name":"JtPlatformAdminAccountConf","exported":true,"kind":"interface","properties":[{"name":"email","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}}]},{"name":"JtPluginStaticConfiguration","exported":true,"kind":"interface","properties":[{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"disabled","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"platform","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"configuration","type":{"kind":"interface","indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"name","group":"ts","refName":"unknown"}}},"optional":true}]},{"name":"JtDeprecatedPluginConfigurations","exported":true,"docComment":"@deprecated Use JtPluginConfiguration[] instead","kind":"interface","indexSignature":{"keyName":"pluginName","keyType":"string","type":{"kind":"interface","indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"name","group":"ts","refName":"unknown"}}}}}]},"./site-schema-json-types":{"namedTypes":[{"name":"JtSiteSchema","exported":true,"docComment":"This properties are part of a site schema, and part of the internal library as well.","kind":"interface","properties":[{"name":"ParoiCMSSiteSchemaFormatVersion","type":{"kind":"literal","literal":"10"},"docComment":"This is the version of the schema engine."},{"name":"languages","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"docComment":"Specify the list of 2-letters language codes (ISO 639-1) of the website. Use 3-letters codes (ISO 639-3) for languages that doesn't have a 2-letters code (\"qya\", etc.). It's possible but not recommanded to use 5-letters codes with regions (IETF BCP 47, for example \"fr-FR\"). Every language is allowed. The first language is the primary language of the website.\n@example `[\"en\", \"fr\"]`"},{"name":"languageRoutingMode","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"prefixSecondary"},{"kind":"literal","literal":"prefixAll"},{"kind":"literal","literal":"auto"}]},"optional":true,"docComment":"Routing mode for multilingual sites. Default is \"auto\".\n- \"auto\": behaves like \"prefixSecondary\" for unilingual sites, \"prefixAll\" for multilingual sites\n- \"prefixAll\": all languages are prefixed in URLs\n- \"prefixSecondary\": all languages but the first are prefixed in URLs"},{"name":"plugins","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"localRef","refName":"JtPluginRef"}]}},"optional":true,"docComment":"List of plugins that are used in the schema.\n@example [\"@paroicms/tiptap-editor-plugin\"]"},{"name":"configuration","type":{"kind":"localRef","refName":"JtSiteConfiguration"},"optional":true},{"name":"nodeTypes","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtNodeType"}},"optional":true,"docComment":"Types of documents, parts that will be handled on the site."},{"name":"fieldTypes","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtFieldType"}},"optional":true,"docComment":"A library of fields."},{"name":"mediaPolicies","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtMediaPolicy"}},"optional":true,"docComment":"Media policies"},{"name":"imageQualityPolicy","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtImageCompressionQualityPolicyStep"}},"optional":true,"docComment":"We can set the image compression quality here. The list must be ordered from the lowest area\nto the highest."}]},{"name":"JtPluginRef","exported":true,"kind":"interface","properties":[{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"disabled","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"configuration","type":{"kind":"localRef","refName":"JtPluginConfFromSchema"},"optional":true}]},{"name":"JtPluginConfFromSchema","exported":true,"kind":"interface","indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"name","group":"ts","refName":"unknown"}}},{"name":"JtSiteConfiguration","exported":true,"kind":"interface","properties":[{"name":"adminUi","type":{"kind":"interface","properties":[{"name":"enableMetaKeywords","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true}]},"optional":true}]},{"name":"JtNodeType","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtSiteType"},{"kind":"localRef","refName":"JtDocumentType"},{"kind":"localRef","refName":"JtPartType"}]},{"name":"JtSiteType","exported":true,"kind":"interface","properties":[{"name":"typeName","type":{"kind":"literal","literal":"_site"},"optional":true,"docComment":"Can be omitted. Its default value is `\"_site\"`."},{"name":"kind","type":{"kind":"literal","literal":"site"}},{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true,"docComment":"The site fields. They will be appended to the required fields: `[\"access\", \"title\", \"contactEmail\", \"favicon\", \"ogImage\"]`.\n\n@example `[\"logo\", \"slogan\", \"phone\"]`"}]},{"name":"JtDocumentType","exported":true,"docComment":"A document is another name for a web page, with a path in the URL.","kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtRoutingDocumentType"},{"kind":"localRef","refName":"JtRegularDocumentType"}]},{"name":"JtDocumentTypeBase","exported":true,"kind":"interface","properties":[{"name":"typeName","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"The type name is the identifier of the document type."},{"name":"kind","type":{"kind":"literal","literal":"document"}},{"name":"ogType","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"@see [Open Graph Protocol](https://ogp.me/)\n@example `\"article\"`"},{"name":"jsonLdType","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"The schema.org type for JSON-LD structured data.\nAllowed values: `\"Article\"`, `\"BlogPosting\"`, `\"AboutPage\"`, `\"ContactPage\"`,\n`\"SearchResultsPage\"`, `\"CollectionPage\"`, `\"ProfilePage\"`."},{"name":"withFeaturedImage","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"If `true`, the document will have a featured image. Most of the time, documents like\nsearch-page, contact-page, the home page, don't need a featured image. But other documents\ndoes."},{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true,"docComment":"The fields in the document. Items in this list can be either field types or predefined field\ntype names."},{"name":"mediaPolicy","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"The name of the media policy."},{"name":"lists","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtListType"}},"optional":true,"docComment":"Lists of parts in the document."},{"name":"routingChildren","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"optional":true,"docComment":"Type names of child routing documents."},{"name":"regularChildren","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"optional":true,"docComment":"Type names of child regular documents."},{"name":"regularChildrenSorting","type":{"kind":"localRef","refName":"JtSorting"},"optional":true,"docComment":"The sorting order of regular children. It is required when `children` is defined.\nExamples: `\"title asc\"`, `\"publishDate desc\"`, `\"manual\"`."},{"name":"childLimit","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"The maximum number of children."},{"name":"hasFrontendApp","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"If `true`, the document will serve a SPA. It means that all the child routes will be handled by\nthe document.\n\nThis property is not compatible with `routingChildren`, `regularChildren`, `redirectTo`\nproperties. Also, if the document type is regular, then sibling regular document types must not\nhave routing or regular children."},{"name":"useUrlQuery","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"If `true`, then the url query will be exposed to the liquid templates. By default it's better\nto not enable it, then the same content will be served from the cache for all the URL query\nvalues."},{"name":"cluster","type":{"kind":"localRef","refName":"JtClusterType"},"optional":true,"docComment":"Cluster configuration for this document type."},{"name":"adminUi","type":{"kind":"localRef","refName":"JtDocumentAdminUiSettings"},"optional":true}]},{"name":"JtClusterType","exported":true,"kind":"interface","properties":[{"name":"autoCreate","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"Determine if the routing documents of the cluster should be automatically created when the root\ndocument is created."}]},{"name":"JtSorting","exported":true,"kind":"composite","op":"union","types":[{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},{"kind":"literal","literal":"manual"},{"kind":"name","group":"primitive","refName":"string"}]},{"name":"JtRoutingDocumentType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtDocumentTypeBase"},{"kind":"interface","properties":[{"name":"documentKind","type":{"kind":"literal","literal":"routing"}},{"name":"redirectTo","type":{"kind":"literal","literal":"parent"},"optional":true,"docComment":"Value `\"parent\"` means that the document is just a hierarchy parent for other documents. But it\nhas no content itself.\n\nThis value is ignored in the home page type."},{"name":"route","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"localRef","refName":"JtTranslatedStrings"}]},"optional":true,"docComment":"The `route` of a routing document contains a kind of _directory name_ (one per language) that\nwill be the last part of the document URL path.\n\nThis value is ignored in the home page type."}]}]},{"name":"JtTranslatedStrings","exported":true,"kind":"interface","indexSignature":{"keyName":"language","keyType":"string","type":{"kind":"name","group":"primitive","refName":"string"}}},{"name":"JtDocumentAdminUiSettings","exported":true,"kind":"interface","properties":[{"name":"defaultTab","type":{"kind":"localRef","refName":"JtDocumentTabName"},"optional":true,"docComment":"Default value is `\"auto\"`."},{"name":"menuPlacement","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"default"},{"kind":"literal","literal":"popup"}]},"optional":true,"docComment":"Used by routing documents only. Default value is `\"default\"`."}]},{"name":"JtDocumentTabName","exported":true,"kind":"composite","op":"union","types":[{"kind":"literal","literal":"auto"},{"kind":"literal","literal":"edit"},{"kind":"literal","literal":"childDocuments"},{"kind":"literal","literal":"parts"}]},{"name":"JtRegularDocumentType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtDocumentTypeBase"},{"kind":"interface","properties":[{"name":"documentKind","type":{"kind":"literal","literal":"regular"}},{"name":"route","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"Available values are: `\":relativeId-:slug\"`, `\":yyyy/:mm/:dd/:relativeId-:slug\"`, `\":slug\"`,\nand `\":relativeId\"`."},{"name":"relativeIdGenerator","type":{"kind":"localRef","refName":"JtRelativeIdGeneratorType"},"optional":true},{"name":"autoPublish","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"Value `true` means that the document will be automatically published without being a\ndraft before. Useful for taxonomy terms, like tags or categories."}]}]},{"name":"JtRelativeIdGeneratorType","exported":true,"kind":"array","itemType":{"kind":"name","group":"ts","refName":"any"}},{"name":"JtSubListType","exported":true,"kind":"interface","properties":[{"name":"parts","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"docComment":"Type names of the parts in the list."},{"name":"sorting","type":{"kind":"localRef","refName":"JtSorting"},"docComment":"How to sort the list. Example: `\"manual\"`."},{"name":"limit","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"The maximum number of parts in the list."}]},{"name":"JtListType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtSubListType"},{"kind":"interface","properties":[{"name":"listName","type":{"kind":"name","group":"primitive","refName":"string"}}]}]},{"name":"JtPartType","exported":true,"kind":"interface","properties":[{"name":"typeName","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"The type name is the identifier of the part type."},{"name":"kind","type":{"kind":"literal","literal":"part"}},{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true},{"name":"list","type":{"kind":"localRef","refName":"JtSubListType"},"optional":true,"docComment":"If the part type can have children parts, then it's a sub-list."},{"name":"mediaPolicy","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true}]},{"name":"JtFieldType","exported":true,"kind":"composite","op":"union","types":[{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtMainDbFieldType"},{"kind":"localRef","refName":"JtMediaDbFieldType"},{"kind":"localRef","refName":"JtLabelingFieldType"},{"kind":"localRef","refName":"JtPartFieldType"}]}]},{"name":"JtFieldTypeBase","exported":true,"kind":"interface","properties":[{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"withGallery","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"useAsDefaultImage","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"renderAs","type":{"kind":"literal","literal":"html"},"optional":true},{"name":"useAsExcerpt","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"plugin","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"A plugin name. For example: `@paroicms/tiptap-editor-plugin`."},{"name":"adminUi","type":{"kind":"localRef","refName":"JtFieldAdminUiSettings"},"optional":true,"docComment":"UI settings in the admin-ui."}]},{"name":"JtFieldAdminUiSettings","exported":true,"kind":"interface","properties":[{"name":"showInCard","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"boolean"},{"kind":"literal","literal":"auto"}]},"optional":true,"docComment":"Default is `\"auto\"`."}],"indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"name","group":"ts","refName":"any"}}},{"name":"JtLocalizableFieldTypeBase","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtFieldTypeBase"},{"kind":"interface","properties":[{"name":"localized","type":{"kind":"name","group":"primitive","refName":"boolean"},"docComment":"If `true`, then each translation will have its own value. Otherwise, the value is shared\nbetween all translations."},{"name":"normalizeTypography","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"This property should be set to `true` for real textual field types, like an html body or a\nlabel.\n\nNote: Its value has no effect when `localized` is `false`."}]}]},{"name":"JtLabelingFieldType","exported":true,"docComment":"The field type represents a labeling link between the current node, and a term from a taxonomy.","kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtFieldTypeBase"},{"kind":"interface","properties":[{"name":"localized","type":{"kind":"literal","literal":false}},{"name":"storedAs","type":{"kind":"literal","literal":"labeling"}},{"name":"taxonomy","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"It's the type name of a routing document. Regular documents that are child of this routing\ndocument will be the terms of the taxonomy.\n\nNotice: Any routing point can be used as a taxonomy. Terms are always regular documents."},{"name":"multiple","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"If `true`, multiple terms can be selected. Otherwise, only one term can be selected."}]}]},{"name":"JtPartFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"partField"}},{"name":"partType","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"The type name of the part that this field wraps."}]}]},{"name":"JtMainDbFieldType","exported":true,"kind":"composite","op":"union","types":[{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtNumberFieldType"},{"kind":"localRef","refName":"JtBooleanFieldType"},{"kind":"localRef","refName":"JtDateFieldType"},{"kind":"localRef","refName":"JtDateTimeFieldType"},{"kind":"localRef","refName":"JtTimeFieldType"},{"kind":"localRef","refName":"JtStringFieldType"},{"kind":"localRef","refName":"JtJsonFieldType"}]}]},{"name":"JtNumberFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"number"}},{"name":"currency","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true},{"name":"enum","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"number"}},"optional":true}]}]},{"name":"JtBooleanFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"boolean"}}]}]},{"name":"JtDateFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"date"}}]}]},{"name":"JtDateTimeFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"dateTime"}}]}]},{"name":"JtTimeFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"time"}}]}]},{"name":"JtStringFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"text"},{"kind":"literal","literal":"varchar"}]}},{"name":"dataType","type":{"kind":"literal","literal":"string"}},{"name":"multiline","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"enum","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"optional":true}]}]},{"name":"JtJsonFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"text"},{"kind":"literal","literal":"varchar"}]}},{"name":"dataType","type":{"kind":"literal","literal":"json"}}]}]},{"name":"JtMediaDbFieldType","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtGalleryFieldType"},{"kind":"localRef","refName":"JtMediaFieldType"}]},{"name":"JtGalleryFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"mediaHandle"}},{"name":"dataType","type":{"kind":"literal","literal":"gallery"}},{"name":"accept","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"refuse","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true}]}]},{"name":"JtMediaFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"mediaHandle"}},{"name":"dataType","type":{"kind":"literal","literal":"media"}},{"name":"accept","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"refuse","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true}]}]},{"name":"JtMediaPolicy","exported":true,"docComment":"These properties define the rules that are applied to medias.","kind":"interface","properties":[{"name":"policyName","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"The internal name of the policy.\n@example `\"myPolicyName\"`"},{"name":"mediaLimitPerDocument","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Max media limit uploaded in a document.\n@example `10`"},{"name":"mediaLimitPerPart","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Max media limit uploaded in a part.\n@example `10`"},{"name":"attachedDocument","type":{"kind":"localRef","refName":"JtAttachedDocumentPolicy"},"optional":true,"docComment":"Rules about non-image medias (like PDF files)."},{"name":"image","type":{"kind":"localRef","refName":"JtImagePolicy"},"optional":true,"docComment":"Rules about images."}]},{"name":"JtAttachedDocumentPolicy","exported":true,"docComment":"These properties define the rules that are applied to\ndocument uploaded in document and document part","kind":"interface","properties":[{"name":"siteWeightLimitB","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Size limit in bytes.\n@example `2000000`"}]},{"name":"JtImagePolicy","exported":true,"docComment":"These properties define the rules that are applied to\nimages contained in document and document part","kind":"interface","properties":[{"name":"weightLimitB","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Size limit in bytes.\n@example `2000000`"},{"name":"areaLimitPx","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Maximum area (width × height, in pixels) of an image.\n@example `2000000`"}]},{"name":"JtImageCompressionQualityPolicyStep","exported":true,"docComment":"These properties define the rules applied to image\ncompression across all sites","kind":"interface","properties":[{"name":"areaLimitPx","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"The quality will apply for image with area smaller than this value.\n@example `600000`"},{"name":"quality","type":{"kind":"name","group":"primitive","refName":"number"},"docComment":"Webp quality loss, in percents.\n@example `80`"}]},{"name":"JtSiteSchemaTranslations","exported":true,"kind":"interface","properties":[{"name":"siteTheme","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true},{"name":"nodeTypes","type":{"kind":"interface","indexSignature":{"keyName":"typeName","keyType":"string","type":{"kind":"localRef","refName":"JtLabelLocales"}}},"optional":true},{"name":"fieldTypes","type":{"kind":"interface","indexSignature":{"keyName":"fieldName","keyType":"string","type":{"kind":"localRef","refName":"JtLabelLocales"}}},"optional":true}]},{"name":"JtLabelLocales","exported":true,"kind":"interface","indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"localRef","refName":"JtLabelLocales"}]}}}]},"./theme-json-types":{"namedTypes":[{"name":"JtThemeConf","exported":true,"kind":"interface","properties":[{"name":"pixelRatio","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Default value is `1`."},{"name":"fTextImages","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}}}]}]}}
|
|
1
|
+
{"./common-schema-json-types":{"imports":[{"from":"./site-schema-json-types","namedMembers":[{"name":"JtFieldType"},{"name":"JtLabelLocales"}]}],"namedTypes":[{"name":"JtInternalCommonSchema","exported":true,"docComment":"The common schema is currently an internal file. Here is its typing.","kind":"interface","properties":[{"name":"ParoiCMSSiteSchemaFormatVersion","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"This is the version of the schema engine."},{"name":"languages","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"docComment":"Specify the list of 2-letters language codes that can be used in the websites.\n\n@example [\"en\", \"fr\"]`"},{"name":"siteFields","type":{"kind":"array","itemType":{"kind":"importedRef","refName":"JtFieldType"}},"docComment":"The common fields of any websites. They are currently: `[\"title\", \"contactEmail\", \"favicon\", \"ogImage\"]`."}]},{"name":"JtInternalCommonSchemaTranslations","exported":true,"kind":"interface","properties":[{"name":"languageLabel","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"siteFields","type":{"kind":"interface","indexSignature":{"keyName":"fieldName","keyType":"string","type":{"kind":"importedRef","refName":"JtLabelLocales"}}},"optional":true}]}]},"./configuration-types":{"namedTypes":[{"name":"JtConfiguration","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtSingleSiteConfiguration"},{"kind":"localRef","refName":"JtMultisiteConfiguration"}]},{"name":"JtConfigurationBase","exported":true,"kind":"interface","properties":[{"name":"port","type":{"kind":"name","group":"primitive","refName":"number"}},{"name":"hostname","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true},{"name":"publicProtocol","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"http"},{"kind":"literal","literal":"https"}]},"optional":true,"docComment":"Default is `\"http\"`."},{"name":"publicPort","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"adminUiPort","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"allowRobots","type":{"kind":"name","group":"primitive","refName":"boolean"}},{"name":"enableCache","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"immutableAssets","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"cacheTimeToIdle","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"literal","literal":"disabled"},{"kind":"literal","literal":"infinite"}]},"optional":true,"docComment":"For example: `\"14d\"`."},{"name":"clearCacheAfterStart","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"clearImageCacheAfterStart","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"logLevel","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"silent"},{"kind":"literal","literal":"error"},{"kind":"literal","literal":"warn"},{"kind":"literal","literal":"info"},{"kind":"literal","literal":"stats"},{"kind":"literal","literal":"debug"},{"kind":"literal","literal":"trace"}]},"optional":true},{"name":"logFile","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"Omit for stdout."},{"name":"graphqlDevTools","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"generateMissingDatabases","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"googleAuth","type":{"kind":"localRef","refName":"JtGoogleAuthConf"},"optional":true},{"name":"imageProcessor","type":{"kind":"localRef","refName":"JtImageProcessorConf"},"optional":true},{"name":"localDevAccount","type":{"kind":"localRef","refName":"JtLocalDevAccountConf"},"optional":true},{"name":"platformAdminAccounts","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtPlatformAdminAccountConf"}},"optional":true},{"name":"plugins","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtPluginStaticConfiguration"}},"optional":true},{"name":"httpRedirections","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtHttpRedirection"}},"optional":true}]},{"name":"JtHttpRedirection","exported":true,"kind":"interface","properties":[{"name":"fromFqdn","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"to","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"mapPaths","type":{"kind":"interface","indexSignature":{"keyName":"fromRegex","keyType":"string","type":{"kind":"name","group":"primitive","refName":"string"}}},"optional":true},{"name":"preservePath","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true}]},{"name":"JtSingleSiteConfiguration","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtConfigurationBase"},{"kind":"interface","properties":[{"name":"singleSite","type":{"kind":"localRef","refName":"JtSingleSiteConf"}}]}]},{"name":"JtMultisiteConfiguration","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtConfigurationBase"},{"kind":"interface","properties":[{"name":"platform","type":{"kind":"interface","properties":[{"name":"dataDir","type":{"kind":"name","group":"primitive","refName":"string"}}]}},{"name":"sitePacks","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtSitePackConf"}}}]}]},{"name":"JtSingleSiteConf","exported":true,"kind":"interface","properties":[{"name":"siteDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"dataDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"cacheDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"backupDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"fqdn","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"redirectWww","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"trusted","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"allowUnsafeLogin","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"Enable auto-login via URL parameter (unsafe, for dev/demo sites only)"}]},{"name":"JtSitePackConf","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtFqdnSitePackConf"},{"kind":"localRef","refName":"JtSubDomainSitePackConf"}]},{"name":"JtSitePackConfBase","exported":true,"kind":"interface","properties":[{"name":"packName","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"sitesDir","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true},{"name":"dataDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"cacheDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"backupDir","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"redirectWww","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"trusted","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"allowUnsafeLogin","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"Enable auto-login via URL parameter (unsafe, for dev/demo sites only)"}]},{"name":"JtFqdnSitePackConf","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtSitePackConfBase"},{"kind":"interface","properties":[{"name":"serveOn","type":{"kind":"literal","literal":"fqdn"}}]}]},{"name":"JtSubDomainSitePackConf","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtSitePackConfBase"},{"kind":"interface","properties":[{"name":"serveOn","type":{"kind":"literal","literal":"subDomain"}},{"name":"parentDomain","type":{"kind":"name","group":"primitive","refName":"string"}}]}]},{"name":"JtGoogleAuthConf","exported":true,"kind":"interface","properties":[{"name":"disabled","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"fqdn","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"clientId","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"clientSecret","type":{"kind":"name","group":"primitive","refName":"string"}}]},{"name":"JtImageProcessorConf","exported":true,"kind":"interface","properties":[{"name":"cpuCoresPerFile","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"allowConcurrency","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true}]},{"name":"JtLocalDevAccountConf","exported":true,"kind":"interface","properties":[{"name":"email","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"password","type":{"kind":"name","group":"primitive","refName":"string"}}]},{"name":"JtPlatformAdminAccountConf","exported":true,"kind":"interface","properties":[{"name":"email","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}}]},{"name":"JtPluginStaticConfiguration","exported":true,"kind":"interface","properties":[{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"disabled","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"platform","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"configuration","type":{"kind":"interface","indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"name","group":"ts","refName":"unknown"}}},"optional":true}]}]},"./site-schema-json-types":{"namedTypes":[{"name":"JtSiteSchema","exported":true,"docComment":"This properties are part of a site schema, and part of the internal library as well.","kind":"interface","properties":[{"name":"ParoiCMSSiteSchemaFormatVersion","type":{"kind":"literal","literal":"10"},"docComment":"This is the version of the schema engine."},{"name":"languages","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"docComment":"Specify the list of 2-letters language codes (ISO 639-1) of the website. Use 3-letters codes (ISO 639-3) for languages that doesn't have a 2-letters code (\"qya\", etc.). It's possible but not recommanded to use 5-letters codes with regions (IETF BCP 47, for example \"fr-FR\"). Every language is allowed. The first language is the primary language of the website.\n@example `[\"en\", \"fr\"]`"},{"name":"languageRoutingMode","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"prefixSecondary"},{"kind":"literal","literal":"prefixAll"},{"kind":"literal","literal":"auto"}]},"optional":true,"docComment":"Routing mode for multilingual sites. Default is \"auto\".\n- \"auto\": behaves like \"prefixSecondary\" for unilingual sites, \"prefixAll\" for multilingual sites\n- \"prefixAll\": all languages are prefixed in URLs\n- \"prefixSecondary\": all languages but the first are prefixed in URLs"},{"name":"plugins","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"localRef","refName":"JtPluginRef"}]}},"optional":true,"docComment":"List of plugins that are used in the schema.\n@example [\"@paroicms/tiptap-editor-plugin\"]"},{"name":"configuration","type":{"kind":"localRef","refName":"JtSiteConfiguration"},"optional":true},{"name":"nodeTypes","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtNodeType"}},"optional":true,"docComment":"Types of documents, parts that will be handled on the site."},{"name":"fieldTypes","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtFieldType"}},"optional":true,"docComment":"A library of fields."},{"name":"mediaPolicies","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtMediaPolicy"}},"optional":true,"docComment":"Media policies"},{"name":"imageQualityPolicy","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtImageCompressionQualityPolicyStep"}},"optional":true,"docComment":"We can set the image compression quality here. The list must be ordered from the lowest area\nto the highest."}]},{"name":"JtPluginRef","exported":true,"kind":"interface","properties":[{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"disabled","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"configuration","type":{"kind":"localRef","refName":"JtPluginConfFromSchema"},"optional":true}]},{"name":"JtPluginConfFromSchema","exported":true,"kind":"interface","indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"name","group":"ts","refName":"unknown"}}},{"name":"JtSiteConfiguration","exported":true,"kind":"interface","properties":[{"name":"adminUi","type":{"kind":"interface","properties":[{"name":"enableMetaKeywords","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true}]},"optional":true}]},{"name":"JtNodeType","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtSiteType"},{"kind":"localRef","refName":"JtDocumentType"},{"kind":"localRef","refName":"JtPartType"}]},{"name":"JtSiteType","exported":true,"kind":"interface","properties":[{"name":"typeName","type":{"kind":"literal","literal":"_site"},"optional":true,"docComment":"Can be omitted. Its default value is `\"_site\"`."},{"name":"kind","type":{"kind":"literal","literal":"site"}},{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true,"docComment":"The site fields. They will be appended to the required fields: `[\"access\", \"title\", \"contactEmail\", \"favicon\", \"ogImage\"]`.\n\n@example `[\"logo\", \"slogan\", \"phone\"]`"}]},{"name":"JtDocumentType","exported":true,"docComment":"A document is another name for a web page, with a path in the URL.","kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtRoutingDocumentType"},{"kind":"localRef","refName":"JtRegularDocumentType"}]},{"name":"JtDocumentTypeBase","exported":true,"kind":"interface","properties":[{"name":"typeName","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"The type name is the identifier of the document type."},{"name":"kind","type":{"kind":"literal","literal":"document"}},{"name":"ogType","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"@see [Open Graph Protocol](https://ogp.me/)\n@example `\"article\"`"},{"name":"jsonLdType","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"The schema.org type for JSON-LD structured data.\nAllowed values: `\"Article\"`, `\"BlogPosting\"`, `\"AboutPage\"`, `\"ContactPage\"`,\n`\"SearchResultsPage\"`, `\"CollectionPage\"`, `\"ProfilePage\"`."},{"name":"withFeaturedImage","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"If `true`, the document will have a featured image. Most of the time, documents like\nsearch-page, contact-page, the home page, don't need a featured image. But other documents\ndoes."},{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true,"docComment":"The fields in the document. Items in this list can be either field types or predefined field\ntype names."},{"name":"mediaPolicy","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"The name of the media policy."},{"name":"lists","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JtListType"}},"optional":true,"docComment":"Lists of parts in the document."},{"name":"routingChildren","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"optional":true,"docComment":"Type names of child routing documents."},{"name":"regularChildren","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"optional":true,"docComment":"Type names of child regular documents."},{"name":"regularChildrenSorting","type":{"kind":"localRef","refName":"JtSorting"},"optional":true,"docComment":"The sorting order of regular children. It is required when `children` is defined.\nExamples: `\"title asc\"`, `\"publishDate desc\"`, `\"manual\"`."},{"name":"childLimit","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"The maximum number of children."},{"name":"hasFrontendApp","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"If `true`, the document will serve a SPA. It means that all the child routes will be handled by\nthe document.\n\nThis property is not compatible with `routingChildren`, `regularChildren`, `redirectTo`\nproperties. Also, if the document type is regular, then sibling regular document types must not\nhave routing or regular children."},{"name":"useUrlQuery","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"If `true`, then the url query will be exposed to the liquid templates. By default it's better\nto not enable it, then the same content will be served from the cache for all the URL query\nvalues."},{"name":"cluster","type":{"kind":"localRef","refName":"JtClusterType"},"optional":true,"docComment":"Cluster configuration for this document type."},{"name":"adminUi","type":{"kind":"localRef","refName":"JtDocumentAdminUiSettings"},"optional":true}]},{"name":"JtClusterType","exported":true,"kind":"interface","properties":[{"name":"autoCreate","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"Determine if the routing documents of the cluster should be automatically created when the root\ndocument is created."}]},{"name":"JtSorting","exported":true,"kind":"composite","op":"union","types":[{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},{"kind":"literal","literal":"manual"},{"kind":"name","group":"primitive","refName":"string"}]},{"name":"JtRoutingDocumentType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtDocumentTypeBase"},{"kind":"interface","properties":[{"name":"documentKind","type":{"kind":"literal","literal":"routing"}},{"name":"redirectTo","type":{"kind":"literal","literal":"parent"},"optional":true,"docComment":"Value `\"parent\"` means that the document is just a hierarchy parent for other documents. But it\nhas no content itself.\n\nThis value is ignored in the home page type."},{"name":"route","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"localRef","refName":"JtTranslatedStrings"}]},"optional":true,"docComment":"The `route` of a routing document contains a kind of _directory name_ (one per language) that\nwill be the last part of the document URL path.\n\nThis value is ignored in the home page type."}]}]},{"name":"JtTranslatedStrings","exported":true,"kind":"interface","indexSignature":{"keyName":"language","keyType":"string","type":{"kind":"name","group":"primitive","refName":"string"}}},{"name":"JtDocumentAdminUiSettings","exported":true,"kind":"interface","properties":[{"name":"defaultTab","type":{"kind":"localRef","refName":"JtDocumentTabName"},"optional":true,"docComment":"Default value is `\"auto\"`."},{"name":"menuPlacement","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"default"},{"kind":"literal","literal":"popup"}]},"optional":true,"docComment":"Used by routing documents only. Default value is `\"default\"`."}]},{"name":"JtDocumentTabName","exported":true,"kind":"composite","op":"union","types":[{"kind":"literal","literal":"auto"},{"kind":"literal","literal":"edit"},{"kind":"literal","literal":"childDocuments"},{"kind":"literal","literal":"parts"}]},{"name":"JtRegularDocumentType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtDocumentTypeBase"},{"kind":"interface","properties":[{"name":"documentKind","type":{"kind":"literal","literal":"regular"}},{"name":"route","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"Available values are: `\":relativeId-:slug\"`, `\":yyyy/:mm/:dd/:relativeId-:slug\"`, `\":slug\"`,\nand `\":relativeId\"`."},{"name":"relativeIdGenerator","type":{"kind":"localRef","refName":"JtRelativeIdGeneratorType"},"optional":true},{"name":"autoPublish","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"Value `true` means that the document will be automatically published without being a\ndraft before. Useful for taxonomy terms, like tags or categories."}]}]},{"name":"JtRelativeIdGeneratorType","exported":true,"kind":"array","itemType":{"kind":"name","group":"ts","refName":"any"}},{"name":"JtSubListType","exported":true,"kind":"interface","properties":[{"name":"parts","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"docComment":"Type names of the parts in the list."},{"name":"sorting","type":{"kind":"localRef","refName":"JtSorting"},"docComment":"How to sort the list. Example: `\"manual\"`."},{"name":"limit","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"The maximum number of parts in the list."}]},{"name":"JtListType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtSubListType"},{"kind":"interface","properties":[{"name":"listName","type":{"kind":"name","group":"primitive","refName":"string"}}]}]},{"name":"JtPartType","exported":true,"kind":"interface","properties":[{"name":"typeName","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"The type name is the identifier of the part type."},{"name":"kind","type":{"kind":"literal","literal":"part"}},{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true},{"name":"list","type":{"kind":"localRef","refName":"JtSubListType"},"optional":true,"docComment":"If the part type can have children parts, then it's a sub-list."},{"name":"mediaPolicy","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true}]},{"name":"JtFieldType","exported":true,"kind":"composite","op":"union","types":[{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtMainDbFieldType"},{"kind":"localRef","refName":"JtMediaDbFieldType"},{"kind":"localRef","refName":"JtLabelingFieldType"},{"kind":"localRef","refName":"JtPartFieldType"}]}]},{"name":"JtFieldTypeBase","exported":true,"kind":"interface","properties":[{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"withGallery","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"useAsDefaultImage","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"renderAs","type":{"kind":"literal","literal":"html"},"optional":true},{"name":"useAsExcerpt","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"plugin","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"A plugin name. For example: `@paroicms/tiptap-editor-plugin`."},{"name":"adminUi","type":{"kind":"localRef","refName":"JtFieldAdminUiSettings"},"optional":true,"docComment":"UI settings in the admin-ui."}]},{"name":"JtFieldAdminUiSettings","exported":true,"kind":"interface","properties":[{"name":"showInCard","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"boolean"},{"kind":"literal","literal":"auto"}]},"optional":true,"docComment":"Default is `\"auto\"`."}],"indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"name","group":"ts","refName":"any"}}},{"name":"JtLocalizableFieldTypeBase","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtFieldTypeBase"},{"kind":"interface","properties":[{"name":"localized","type":{"kind":"name","group":"primitive","refName":"boolean"},"docComment":"If `true`, then each translation will have its own value. Otherwise, the value is shared\nbetween all translations."},{"name":"normalizeTypography","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"This property should be set to `true` for real textual field types, like an html body or a\nlabel.\n\nNote: Its value has no effect when `localized` is `false`."}]}]},{"name":"JtLabelingFieldType","exported":true,"docComment":"The field type represents a labeling link between the current node, and a term from a taxonomy.","kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtFieldTypeBase"},{"kind":"interface","properties":[{"name":"localized","type":{"kind":"literal","literal":false}},{"name":"storedAs","type":{"kind":"literal","literal":"labeling"}},{"name":"taxonomy","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"It's the type name of a routing document. Regular documents that are child of this routing\ndocument will be the terms of the taxonomy.\n\nNotice: Any routing point can be used as a taxonomy. Terms are always regular documents."},{"name":"multiple","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"If `true`, multiple terms can be selected. Otherwise, only one term can be selected."}]}]},{"name":"JtPartFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"partField"}},{"name":"partType","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"The type name of the part that this field wraps."}]}]},{"name":"JtMainDbFieldType","exported":true,"kind":"composite","op":"union","types":[{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtNumberFieldType"},{"kind":"localRef","refName":"JtBooleanFieldType"},{"kind":"localRef","refName":"JtDateFieldType"},{"kind":"localRef","refName":"JtDateTimeFieldType"},{"kind":"localRef","refName":"JtTimeFieldType"},{"kind":"localRef","refName":"JtStringFieldType"},{"kind":"localRef","refName":"JtJsonFieldType"}]}]},{"name":"JtNumberFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"number"}},{"name":"currency","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true},{"name":"enum","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"number"}},"optional":true}]}]},{"name":"JtBooleanFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"boolean"}}]}]},{"name":"JtDateFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"date"}}]}]},{"name":"JtDateTimeFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"dateTime"}}]}]},{"name":"JtTimeFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"time"}}]}]},{"name":"JtStringFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"text"},{"kind":"literal","literal":"varchar"}]}},{"name":"dataType","type":{"kind":"literal","literal":"string"}},{"name":"multiline","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"enum","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"optional":true}]}]},{"name":"JtJsonFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"text"},{"kind":"literal","literal":"varchar"}]}},{"name":"dataType","type":{"kind":"literal","literal":"json"}}]}]},{"name":"JtMediaDbFieldType","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JtGalleryFieldType"},{"kind":"localRef","refName":"JtMediaFieldType"}]},{"name":"JtGalleryFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"mediaHandle"}},{"name":"dataType","type":{"kind":"literal","literal":"gallery"}},{"name":"accept","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"refuse","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true}]}]},{"name":"JtMediaFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JtLocalizableFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"mediaHandle"}},{"name":"dataType","type":{"kind":"literal","literal":"media"}},{"name":"accept","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"refuse","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true}]}]},{"name":"JtMediaPolicy","exported":true,"docComment":"These properties define the rules that are applied to medias.","kind":"interface","properties":[{"name":"policyName","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"The internal name of the policy.\n@example `\"myPolicyName\"`"},{"name":"mediaLimitPerDocument","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Max media limit uploaded in a document.\n@example `10`"},{"name":"mediaLimitPerPart","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Max media limit uploaded in a part.\n@example `10`"},{"name":"attachedDocument","type":{"kind":"localRef","refName":"JtAttachedDocumentPolicy"},"optional":true,"docComment":"Rules about non-image medias (like PDF files)."},{"name":"image","type":{"kind":"localRef","refName":"JtImagePolicy"},"optional":true,"docComment":"Rules about images."}]},{"name":"JtAttachedDocumentPolicy","exported":true,"docComment":"These properties define the rules that are applied to\ndocument uploaded in document and document part","kind":"interface","properties":[{"name":"siteWeightLimitB","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Size limit in bytes.\n@example `2000000`"}]},{"name":"JtImagePolicy","exported":true,"docComment":"These properties define the rules that are applied to\nimages contained in document and document part","kind":"interface","properties":[{"name":"weightLimitB","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Size limit in bytes.\n@example `2000000`"},{"name":"areaLimitPx","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Maximum area (width × height, in pixels) of an image.\n@example `2000000`"}]},{"name":"JtImageCompressionQualityPolicyStep","exported":true,"docComment":"These properties define the rules applied to image\ncompression across all sites","kind":"interface","properties":[{"name":"areaLimitPx","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"The quality will apply for image with area smaller than this value.\n@example `600000`"},{"name":"quality","type":{"kind":"name","group":"primitive","refName":"number"},"docComment":"Webp quality loss, in percents.\n@example `80`"}]},{"name":"JtSiteSchemaTranslations","exported":true,"kind":"interface","properties":[{"name":"siteTheme","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true},{"name":"nodeTypes","type":{"kind":"interface","indexSignature":{"keyName":"typeName","keyType":"string","type":{"kind":"localRef","refName":"JtLabelLocales"}}},"optional":true},{"name":"fieldTypes","type":{"kind":"interface","indexSignature":{"keyName":"fieldName","keyType":"string","type":{"kind":"localRef","refName":"JtLabelLocales"}}},"optional":true}]},{"name":"JtLabelLocales","exported":true,"kind":"interface","indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"localRef","refName":"JtLabelLocales"}]}}}]},"./theme-json-types":{"namedTypes":[{"name":"JtThemeConf","exported":true,"kind":"interface","properties":[{"name":"pixelRatio","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Default value is `1`."},{"name":"fTextImages","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}}}]}]}}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@paroicms/public-server-lib",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Common utilitaries for paroicms plugins (backend side).",
|
|
5
5
|
"author": "Paroi Team",
|
|
6
6
|
"repository": {
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
"dev": "tsc --watch --preserveWatchOutput"
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@paroicms/internal-anywhere-lib": "1.39.
|
|
27
|
-
"@paroicms/public-anywhere-lib": "0.
|
|
28
|
-
"@paroicms/script-lib": "0.
|
|
26
|
+
"@paroicms/internal-anywhere-lib": "1.39.7",
|
|
27
|
+
"@paroicms/public-anywhere-lib": "1.0.0",
|
|
28
|
+
"@paroicms/script-lib": "1.0.0",
|
|
29
29
|
"@typeonly/validator": "~1.1.2",
|
|
30
30
|
"arktype": "~2.2.1"
|
|
31
31
|
},
|
|
@@ -1,24 +1,13 @@
|
|
|
1
1
|
export type JtConfiguration = JtSingleSiteConfiguration | JtMultisiteConfiguration;
|
|
2
2
|
|
|
3
3
|
export interface JtConfigurationBase {
|
|
4
|
-
|
|
5
|
-
* @deprecated Move the sub-properties in the parent.
|
|
6
|
-
*/
|
|
7
|
-
thisServer?: JtDeprecatedThisServerConf;
|
|
8
|
-
/**
|
|
9
|
-
* It is required except if the legacy `thisServer` is still used.
|
|
10
|
-
*/
|
|
11
|
-
port?: number;
|
|
4
|
+
port: number;
|
|
12
5
|
hostname?: string;
|
|
13
6
|
/**
|
|
14
7
|
* Default is `"http"`.
|
|
15
8
|
*/
|
|
16
9
|
publicProtocol?: "http" | "https";
|
|
17
10
|
publicPort?: number;
|
|
18
|
-
/**
|
|
19
|
-
* @deprecated Use adminUiPort instead.
|
|
20
|
-
*/
|
|
21
|
-
boPort?: number;
|
|
22
11
|
adminUiPort?: number;
|
|
23
12
|
|
|
24
13
|
allowRobots: boolean;
|
|
@@ -30,10 +19,6 @@ export interface JtConfigurationBase {
|
|
|
30
19
|
cacheTimeToIdle?: string | "disabled" | "infinite";
|
|
31
20
|
clearCacheAfterStart?: boolean;
|
|
32
21
|
clearImageCacheAfterStart?: boolean;
|
|
33
|
-
/**
|
|
34
|
-
* @deprecated Replace `log.level` by `logLevel`, and `log.file` by `logFile`.
|
|
35
|
-
*/
|
|
36
|
-
log?: JtLogConf;
|
|
37
22
|
logLevel?: "silent" | "error" | "warn" | "info" | "stats" | "debug" | "trace";
|
|
38
23
|
/**
|
|
39
24
|
* Omit for stdout.
|
|
@@ -42,16 +27,10 @@ export interface JtConfigurationBase {
|
|
|
42
27
|
graphqlDevTools?: boolean;
|
|
43
28
|
generateMissingDatabases?: boolean;
|
|
44
29
|
googleAuth?: JtGoogleAuthConf;
|
|
45
|
-
|
|
46
|
-
awsSesMail?: JtDeprecatedAwsSesMailConf;
|
|
47
|
-
/** @deprecated Use "@paroicms/contact-form-plugin" configuration instead */
|
|
48
|
-
googleRecaptcha?: JtDeprecatedGoogleRecaptchaConf;
|
|
49
|
-
imageProcessor?: JtImageProcessorConf | JtLegacyImageProcessorConf;
|
|
50
|
-
/** @deprecated Use localDevAccount instead */
|
|
51
|
-
devAccount?: JtLocalDevAccountConf;
|
|
30
|
+
imageProcessor?: JtImageProcessorConf;
|
|
52
31
|
localDevAccount?: JtLocalDevAccountConf;
|
|
53
32
|
platformAdminAccounts?: JtPlatformAdminAccountConf[];
|
|
54
|
-
plugins?: JtPluginStaticConfiguration[]
|
|
33
|
+
plugins?: JtPluginStaticConfiguration[];
|
|
55
34
|
httpRedirections?: JtHttpRedirection[];
|
|
56
35
|
}
|
|
57
36
|
|
|
@@ -72,23 +51,7 @@ export interface JtMultisiteConfiguration extends JtConfigurationBase {
|
|
|
72
51
|
platform: {
|
|
73
52
|
dataDir: string;
|
|
74
53
|
};
|
|
75
|
-
sitePacks:
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
export interface JtDeprecatedThisServerConf {
|
|
79
|
-
port: number;
|
|
80
|
-
publicPort?: number;
|
|
81
|
-
boPublicPort?: number;
|
|
82
|
-
hostName?: string | null;
|
|
83
|
-
https: boolean;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
export interface JtLogConf {
|
|
87
|
-
level: "silent" | "error" | "warn" | "info" | "stats" | "debug" | "trace";
|
|
88
|
-
/**
|
|
89
|
-
* Omit for stdout.
|
|
90
|
-
*/
|
|
91
|
-
file?: string;
|
|
54
|
+
sitePacks: JtSitePackConf[];
|
|
92
55
|
}
|
|
93
56
|
|
|
94
57
|
export interface JtSingleSiteConf {
|
|
@@ -104,11 +67,6 @@ export interface JtSingleSiteConf {
|
|
|
104
67
|
allowUnsafeLogin?: boolean;
|
|
105
68
|
}
|
|
106
69
|
|
|
107
|
-
export type JtSitePackOrLegacyConf =
|
|
108
|
-
| JtSitePackConf
|
|
109
|
-
| JtLegacyFqdnSitePackConf
|
|
110
|
-
| JtLegacySubDomainSitePackConf;
|
|
111
|
-
|
|
112
70
|
export type JtSitePackConf = JtFqdnSitePackConf | JtSubDomainSitePackConf;
|
|
113
71
|
|
|
114
72
|
export interface JtSitePackConfBase {
|
|
@@ -133,17 +91,6 @@ export interface JtSubDomainSitePackConf extends JtSitePackConfBase {
|
|
|
133
91
|
parentDomain: string;
|
|
134
92
|
}
|
|
135
93
|
|
|
136
|
-
export interface JtLegacyFqdnSitePackConf extends JtSitePackConfBase {
|
|
137
|
-
/** @deprecated Renamed to `serveOn` */
|
|
138
|
-
serveAs: "fqdn";
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
export interface JtLegacySubDomainSitePackConf extends JtSitePackConfBase {
|
|
142
|
-
/** @deprecated Renamed to `serveOn` */
|
|
143
|
-
serveAs: "subDomain";
|
|
144
|
-
parentDomain: string;
|
|
145
|
-
}
|
|
146
|
-
|
|
147
94
|
export interface JtGoogleAuthConf {
|
|
148
95
|
disabled?: boolean;
|
|
149
96
|
fqdn: string;
|
|
@@ -151,32 +98,11 @@ export interface JtGoogleAuthConf {
|
|
|
151
98
|
clientSecret: string;
|
|
152
99
|
}
|
|
153
100
|
|
|
154
|
-
/** @deprecated Use "@paroicms/send-mail-aws-ses-plugin" configuration instead */
|
|
155
|
-
export interface JtDeprecatedAwsSesMailConf {
|
|
156
|
-
disabled?: boolean;
|
|
157
|
-
from: string;
|
|
158
|
-
accessKeyId: string;
|
|
159
|
-
secretAccessKey: string;
|
|
160
|
-
region: string;
|
|
161
|
-
}
|
|
162
|
-
|
|
163
|
-
/** @deprecated Use "@paroicms/contact-form-plugin" configuration instead */
|
|
164
|
-
export interface JtDeprecatedGoogleRecaptchaConf {
|
|
165
|
-
disabled?: boolean;
|
|
166
|
-
siteKey: string;
|
|
167
|
-
secretKey: string;
|
|
168
|
-
}
|
|
169
|
-
|
|
170
101
|
export interface JtImageProcessorConf {
|
|
171
102
|
cpuCoresPerFile?: number;
|
|
172
103
|
allowConcurrency?: boolean;
|
|
173
104
|
}
|
|
174
105
|
|
|
175
|
-
export interface JtLegacyImageProcessorConf {
|
|
176
|
-
cpuCoresPerFile?: number;
|
|
177
|
-
oneSharpAtATime?: boolean;
|
|
178
|
-
}
|
|
179
|
-
|
|
180
106
|
export interface JtLocalDevAccountConf {
|
|
181
107
|
email: string;
|
|
182
108
|
name: string;
|
|
@@ -196,10 +122,3 @@ export interface JtPluginStaticConfiguration {
|
|
|
196
122
|
[key: string]: unknown;
|
|
197
123
|
};
|
|
198
124
|
}
|
|
199
|
-
|
|
200
|
-
/** @deprecated Use JtPluginConfiguration[] instead */
|
|
201
|
-
export interface JtDeprecatedPluginConfigurations {
|
|
202
|
-
[pluginName: string]: {
|
|
203
|
-
[key: string]: unknown;
|
|
204
|
-
};
|
|
205
|
-
}
|
|
@@ -119,8 +119,6 @@ export interface BackendPluginInitService extends PluginStaticConfiguration {
|
|
|
119
119
|
): void;
|
|
120
120
|
registerRenderingHook(hookName: "fieldPreprocessor", handler: RenderingHookHandler): void;
|
|
121
121
|
setPublicApiHandler(handler: PublicApiHandler): void;
|
|
122
|
-
/** @deprecated Use `registerHeadTags` instead. */
|
|
123
|
-
addHeadTag(...htmlTags: string[]): void;
|
|
124
122
|
registerHeadTags(handler: HeadTagsHandler): void;
|
|
125
123
|
registeredSite: RegisteredSite;
|
|
126
124
|
pluginAssetsUrl: string;
|
|
@@ -22,22 +22,9 @@ export interface TpHomePayload {
|
|
|
22
22
|
export interface TpSitePayload {
|
|
23
23
|
kind: "site";
|
|
24
24
|
fqdn: string;
|
|
25
|
-
/** @deprecated Use `home.baseUrl` instead */
|
|
26
|
-
url: string;
|
|
27
25
|
assetsUrl: string;
|
|
28
26
|
field: { [fieldName: string]: unknown };
|
|
29
27
|
home: TpHomePayload;
|
|
30
|
-
/** @deprecated Use `home.language` instead */
|
|
31
|
-
language: string;
|
|
32
|
-
/** @deprecated Use `home.languageLabel` instead */
|
|
33
|
-
languageLabel: string;
|
|
34
|
-
|
|
35
|
-
/** @deprecated */
|
|
36
|
-
fields: { [fieldName: string]: unknown };
|
|
37
|
-
/** @deprecated */
|
|
38
|
-
configuration: unknown;
|
|
39
|
-
/** @deprecated */
|
|
40
|
-
recaptchaKey?: string;
|
|
41
28
|
}
|
|
42
29
|
|
|
43
30
|
export interface TpClusterPayload {
|
|
@@ -90,10 +77,6 @@ export interface TpDocValues {
|
|
|
90
77
|
|
|
91
78
|
export interface TpDocPayload extends TpDocValues {
|
|
92
79
|
kind: "routingDocument" | "regularDocument" | "term";
|
|
93
|
-
/** @deprecated */
|
|
94
|
-
leafType: string;
|
|
95
|
-
/** @deprecated */
|
|
96
|
-
leafId: string;
|
|
97
80
|
id: string;
|
|
98
81
|
languageLabel: string;
|
|
99
82
|
url: string;
|
|
@@ -104,24 +87,10 @@ export interface TpDocPayload extends TpDocValues {
|
|
|
104
87
|
listSize: {
|
|
105
88
|
[listName: string]: number;
|
|
106
89
|
};
|
|
107
|
-
/** @deprecated */
|
|
108
|
-
defaultImageId?: string;
|
|
109
90
|
defaultImage?: TpImage;
|
|
110
|
-
/** @deprecated */
|
|
111
|
-
featuredImageId?: string;
|
|
112
91
|
featuredImage?: TpImage;
|
|
113
92
|
field: TpFieldValues;
|
|
114
|
-
/** @deprecated */
|
|
115
|
-
fields: TpFieldValues;
|
|
116
93
|
translations: TpDocTranslation[];
|
|
117
|
-
/** deprecated */
|
|
118
|
-
labeling: undefined;
|
|
119
|
-
/** deprecated */
|
|
120
|
-
singleLabeling: undefined;
|
|
121
|
-
/** deprecated */
|
|
122
|
-
flaggedWith: undefined;
|
|
123
|
-
/** deprecated */
|
|
124
|
-
flaggedWithOne: undefined;
|
|
125
94
|
og: TpOgValues;
|
|
126
95
|
jsonLd: TpJsonLdPayload;
|
|
127
96
|
breadcrumb: TpBreadcrumbItem[];
|
|
@@ -134,8 +103,6 @@ export interface TpDocPayload extends TpDocValues {
|
|
|
134
103
|
* Child routing document identifiers. Available on routing document only.
|
|
135
104
|
*/
|
|
136
105
|
routing?: TpRoutingClusterNode;
|
|
137
|
-
/** @deprecated Use `routing` instead */
|
|
138
|
-
routingIds?: TpRoutingClusterNode;
|
|
139
106
|
/** Lazy loaded */
|
|
140
107
|
cluster: TpClusterPayload;
|
|
141
108
|
}
|
|
@@ -173,22 +140,10 @@ export interface TpPartValues {
|
|
|
173
140
|
|
|
174
141
|
export interface TpPart extends TpPartValues {
|
|
175
142
|
kind: "part";
|
|
176
|
-
/** @deprecated */
|
|
177
|
-
leafId: string;
|
|
178
|
-
/** @deprecated */
|
|
179
|
-
leafType: string;
|
|
180
143
|
id: string;
|
|
181
|
-
/** @deprecated */
|
|
182
|
-
num: number;
|
|
183
|
-
/** @deprecated */
|
|
184
|
-
defaultImageId?: string;
|
|
185
144
|
defaultImage?: TpImage;
|
|
186
|
-
/** @deprecated */
|
|
187
|
-
featuredImageId?: string;
|
|
188
145
|
featuredImage?: TpImage;
|
|
189
146
|
field: TpFieldValues;
|
|
190
|
-
/** @deprecated */
|
|
191
|
-
fields: TpFieldValues;
|
|
192
147
|
typeLabel: string;
|
|
193
148
|
parts?: TpPart[];
|
|
194
149
|
}
|