@paroicms/server 0.154.2 → 1.0.0
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/README.md +4 -0
- package/dist/types.to.json +1 -1
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -13,6 +13,10 @@ npm i
|
|
|
13
13
|
npm run dev
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
+
## Documentation
|
|
17
|
+
|
|
18
|
+
Here is a draft of the [documention for `site-schema.json` files](https://gitlab.com/paroi/opensource/paroicms/-/blob/main/documentation/json-of-site-schema/interfaces/JsonOfSiteSchema.md).
|
|
19
|
+
|
|
16
20
|
## Contribute
|
|
17
21
|
|
|
18
22
|
Please start with [the instructions in our monorepo](https://gitlab.com/paroi/opensource/paroicms#how-to-contribute).
|
package/dist/types.to.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"./configuration-types":{"namedTypes":[{"name":"Configuration","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"SingleSiteConfiguration"},{"kind":"localRef","refName":"MultiSiteConfiguration"}]},{"name":"ConfigurationBase","exported":true,"kind":"interface","properties":[{"name":"thisServer","type":{"kind":"localRef","refName":"ThisServerConf"}},{"name":"log","type":{"kind":"localRef","refName":"LogConf"}},{"name":"allowRobots","type":{"kind":"name","group":"primitive","refName":"boolean"}},{"name":"immutableAssets","type":{"kind":"name","group":"primitive","refName":"boolean"}},{"name":"cacheTimeToIdle","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"literal","literal":"disabled"},{"kind":"literal","literal":"infinite"}]},"docComment":"For example: `\"14d\"`."},{"name":"clearCacheAfterStart","type":{"kind":"name","group":"primitive","refName":"boolean"}},{"name":"clearImageCacheAfterStart","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"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":"GoogleAuth"},"optional":true},{"name":"awsSesMail","type":{"kind":"localRef","refName":"AwsSesMailConf"},"optional":true},{"name":"googleRecaptcha","type":{"kind":"localRef","refName":"GoogleRecaptchaConf"},"optional":true},{"name":"imageProcessor","type":{"kind":"localRef","refName":"ImageProcessorConf"},"optional":true},{"name":"devAccount","type":{"kind":"localRef","refName":"DevAccount"},"optional":true},{"name":"platformAdminAccounts","type":{"kind":"array","itemType":{"kind":"localRef","refName":"PlatformAdminAccount"}},"optional":true}]},{"name":"SingleSiteConfiguration","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"ConfigurationBase"},{"kind":"interface","properties":[{"name":"singleSite","type":{"kind":"localRef","refName":"SingleSiteConf"}}]}]},{"name":"MultiSiteConfiguration","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"ConfigurationBase"},{"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":"SitePackConf"}}}]}]},{"name":"ThisServerConf","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":"LogConf","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":"SingleSiteConf","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":"SitePackConf","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"FqdnSitePackConf"},{"kind":"localRef","refName":"SubDomainSitePackConf"}]},{"name":"SitePackConfBase","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":"FqdnSitePackConf","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"SitePackConfBase"},{"kind":"interface","properties":[{"name":"serveAs","type":{"kind":"literal","literal":"fqdn"}}]}]},{"name":"SubDomainSitePackConf","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"SitePackConfBase"},{"kind":"interface","properties":[{"name":"serveAs","type":{"kind":"literal","literal":"subDomain"}},{"name":"parentDomain","type":{"kind":"name","group":"primitive","refName":"string"}}]}]},{"name":"GoogleAuth","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":"AwsSesMailConf","exported":true,"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":"GoogleRecaptchaConf","exported":true,"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":"ImageProcessorConf","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":"DevAccount","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":"PlatformAdminAccount","exported":true,"kind":"interface","properties":[{"name":"email","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}}]}]},"./l10n-types":{"namedTypes":[{"name":"JsonOfLanguageSchemaLocales","exported":true,"kind":"interface","properties":[{"name":"siteFieldLib","type":{"kind":"interface","indexSignature":{"keyName":"fieldName","keyType":"string","type":{"kind":"localRef","refName":"JsonOfLabelLocales"}}},"optional":true},{"name":"sectionFieldLib","type":{"kind":"interface","indexSignature":{"keyName":"fieldName","keyType":"string","type":{"kind":"localRef","refName":"JsonOfLabelLocales"}}},"optional":true},{"name":"site","type":{"kind":"interface","properties":[{"name":"fields","type":{"kind":"interface","indexSignature":{"keyName":"fieldName","keyType":"string","type":{"kind":"localRef","refName":"JsonOfLabelLocales"}}},"optional":true}]},"optional":true},{"name":"documentTypes","type":{"kind":"interface","indexSignature":{"keyName":"leafType","keyType":"string","type":{"kind":"localRef","refName":"JsonOfLabelLocales"}}},"optional":true},{"name":"partTypes","type":{"kind":"interface","indexSignature":{"keyName":"leafType","keyType":"string","type":{"kind":"localRef","refName":"JsonOfLabelLocales"}}},"optional":true}]},{"name":"JsonOfLabelLocales","exported":true,"kind":"interface","indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"localRef","refName":"JsonOfLabelLocales"}]}}}]},"./site-schema-json-types":{"namedTypes":[{"name":"JsonOfCommonSchema","exported":true,"kind":"interface","properties":[{"name":"schemaEngineVersion","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"langs","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}}},{"name":"site","type":{"kind":"interface","properties":[{"name":"fields","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfFieldType"}}}]}}]},{"name":"JsonOfSiteSchemaBase","exported":true,"kind":"interface","properties":[{"name":"schemaEngineVersion","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"langs","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}}},{"name":"useModules","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"optional":true},{"name":"site","type":{"kind":"localRef","refName":"JsonOfSiteDataSchema"},"optional":true},{"name":"partTypes","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfPartSchema"}},"optional":true},{"name":"mediaPolicies","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfMediaPolicy"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true},{"name":"imageQualityPolicy","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfImageCompressionQualityPolicy"}},"optional":true}]},{"name":"JsonOfSiteDataSchema","exported":true,"kind":"interface","properties":[{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true}]},{"name":"JsonOfSiteSchema","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfSiteSchemaBase"},{"kind":"interface","properties":[{"name":"siteFieldLib","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true},{"name":"sectionFieldLib","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true},{"name":"documentTypes","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfDocumentType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true,"docComment":"If missing, then `[\"home\"]` is taken by default."}]}]},{"name":"JsonOfSiteSchemaModule","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfSiteSchemaBase"},{"kind":"interface","properties":[{"name":"siteFieldLib","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfFieldType"}},"optional":true},{"name":"sectionFieldLib","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfFieldType"}},"optional":true},{"name":"documentTypes","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfModuleDocumentType"}},"optional":true}]}]},{"name":"JsonOfModuleDocumentType","exported":true,"kind":"interface","properties":[{"name":"leafType","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"route","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"interface","indexSignature":{"keyName":"lang","keyType":"string","type":{"kind":"name","group":"primitive","refName":"string"}}}]},"optional":true},{"name":"relativeIdGenerator","type":{"kind":"array","itemType":{"kind":"name","group":"ts","refName":"any"}},"optional":true},{"name":"children","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"optional":true},{"name":"childOrdering","type":{"kind":"localRef","refName":"JsonOfChildOrdering"},"optional":true},{"name":"childLimit","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"partLists","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfPartListSchema"}},"optional":true},{"name":"useTaxonomies","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfUseTaxonomy"}},"optional":true},{"name":"withData","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true},{"name":"mediaPolicy","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true},{"name":"ogType","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true},{"name":"autoPublish","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true}]},{"name":"JsonOfChildOrdering","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":"JsonOfDocumentType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfModuleDocumentType"},{"kind":"interface","properties":[{"name":"from","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true}]}]},{"name":"JsonOfPartListSchema","exported":true,"kind":"interface","properties":[{"name":"listName","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"orderBy","type":{"kind":"literal","literal":"manual"}},{"name":"partLeafTypes","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}}},{"name":"partLimit","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true}]},{"name":"JsonOfPartSchema","exported":true,"kind":"interface","properties":[{"name":"leafType","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"withData","type":{"kind":"name","group":"primitive","refName":"boolean"}},{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true},{"name":"mediaPolicy","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true}]},{"name":"JsonOfUseTaxonomy","exported":true,"kind":"interface","properties":[{"name":"leafType","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"relation","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"single"},{"kind":"literal","literal":"multiple"}]}},{"name":"withLeadTerm","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"single"},{"kind":"literal","literal":"multiple"}]},"optional":true}]},{"name":"JsonOfFieldType","exported":true,"kind":"composite","op":"union","types":[{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfVarcharFieldType"},{"kind":"localRef","refName":"JsonOfTextFieldType"},{"kind":"localRef","refName":"JsonOfLeafMediaFieldType"},{"kind":"localRef","refName":"JsonOfLeafGalleryFieldType"}]}]},{"name":"JsonOfFieldTypeBase","exported":true,"kind":"interface","properties":[{"name":"storedOn","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"leaf"},{"kind":"literal","literal":"section"}]}},{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}}]},{"name":"JsonOfVarcharFieldType","exported":true,"kind":"composite","op":"union","types":[{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfStringVarcharFieldType"},{"kind":"localRef","refName":"JsonOfNumberVarcharFieldType"},{"kind":"localRef","refName":"JsonOfBooleanVarcharFieldType"}]}]},{"name":"JsonOfStringVarcharFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"string"}}]}]},{"name":"JsonOfNumberVarcharFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"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":"JsonOfBooleanVarcharFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"boolean"}}]}]},{"name":"JsonOfTextFieldType","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFTextFieldType"},{"kind":"localRef","refName":"JsonOfJsonFieldType"}]},{"name":"JsonOfFTextFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"text"}},{"name":"dataType","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"quillDelta"},{"kind":"literal","literal":"html"}]}},{"name":"useAsExcerpt","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"useAsDefaultImage","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"withGallery","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"name":"backOffice","type":{"kind":"localRef","refName":"JsonOfFTextFieldBackOffice"},"optional":true}]}]},{"name":"JsonOfJsonFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"text"}},{"name":"dataType","type":{"kind":"literal","literal":"json"}}]}]},{"name":"JsonOfFTextFieldBackOffice","exported":true,"kind":"interface","properties":[{"name":"editorRows","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true}]},{"name":"JsonOfGalleryFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"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":"JsonOfLeafGalleryFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfGalleryFieldType"},{"kind":"interface","properties":[{"name":"useAsDefaultImage","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true}]}]},{"name":"JsonOfMediaFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"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":"JsonOfLeafMediaFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfMediaFieldType"},{"kind":"interface","properties":[{"name":"useAsDefaultImage","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true}]}]},{"name":"JsonOfMediaPolicy","exported":true,"kind":"interface","properties":[{"name":"policyName","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"mediaLimitPerDocument","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"mediaLimitPerPart","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"attachedDocument","type":{"kind":"localRef","refName":"JsonOfAttachedDocumentPolicy"},"optional":true},{"name":"image","type":{"kind":"localRef","refName":"JsonOfImagePolicy"},"optional":true}]},{"name":"JsonOfAttachedDocumentPolicy","exported":true,"kind":"interface","properties":[{"name":"siteWeightLimitB","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true}]},{"name":"JsonOfImagePolicy","exported":true,"kind":"interface","properties":[{"name":"weightLimitB","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"areaLimitPx","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true}]},{"name":"JsonOfImageCompressionQualityPolicy","exported":true,"kind":"interface","properties":[{"name":"areaLimitPx","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true},{"name":"quality","type":{"kind":"name","group":"primitive","refName":"number"}}]}]},"./theme-json-types":{"namedTypes":[{"name":"JsonOfThemeConf","exported":true,"kind":"interface","properties":[{"name":"fTextImages","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}}}]}]}}
|
|
1
|
+
{"./configuration-types":{"namedTypes":[{"name":"Configuration","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"SingleSiteConfiguration"},{"kind":"localRef","refName":"MultiSiteConfiguration"}]},{"name":"ConfigurationBase","exported":true,"kind":"interface","properties":[{"name":"thisServer","type":{"kind":"localRef","refName":"ThisServerConf"}},{"name":"log","type":{"kind":"localRef","refName":"LogConf"}},{"name":"allowRobots","type":{"kind":"name","group":"primitive","refName":"boolean"}},{"name":"immutableAssets","type":{"kind":"name","group":"primitive","refName":"boolean"}},{"name":"cacheTimeToIdle","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"literal","literal":"disabled"},{"kind":"literal","literal":"infinite"}]},"docComment":"For example: `\"14d\"`."},{"name":"clearCacheAfterStart","type":{"kind":"name","group":"primitive","refName":"boolean"}},{"name":"clearImageCacheAfterStart","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true},{"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":"GoogleAuth"},"optional":true},{"name":"awsSesMail","type":{"kind":"localRef","refName":"AwsSesMailConf"},"optional":true},{"name":"googleRecaptcha","type":{"kind":"localRef","refName":"GoogleRecaptchaConf"},"optional":true},{"name":"imageProcessor","type":{"kind":"localRef","refName":"ImageProcessorConf"},"optional":true},{"name":"devAccount","type":{"kind":"localRef","refName":"DevAccount"},"optional":true},{"name":"platformAdminAccounts","type":{"kind":"array","itemType":{"kind":"localRef","refName":"PlatformAdminAccount"}},"optional":true}]},{"name":"SingleSiteConfiguration","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"ConfigurationBase"},{"kind":"interface","properties":[{"name":"singleSite","type":{"kind":"localRef","refName":"SingleSiteConf"}}]}]},{"name":"MultiSiteConfiguration","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"ConfigurationBase"},{"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":"SitePackConf"}}}]}]},{"name":"ThisServerConf","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":"LogConf","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":"SingleSiteConf","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":"SitePackConf","exported":true,"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"FqdnSitePackConf"},{"kind":"localRef","refName":"SubDomainSitePackConf"}]},{"name":"SitePackConfBase","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":"FqdnSitePackConf","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"SitePackConfBase"},{"kind":"interface","properties":[{"name":"serveAs","type":{"kind":"literal","literal":"fqdn"}}]}]},{"name":"SubDomainSitePackConf","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"SitePackConfBase"},{"kind":"interface","properties":[{"name":"serveAs","type":{"kind":"literal","literal":"subDomain"}},{"name":"parentDomain","type":{"kind":"name","group":"primitive","refName":"string"}}]}]},{"name":"GoogleAuth","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":"AwsSesMailConf","exported":true,"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":"GoogleRecaptchaConf","exported":true,"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":"ImageProcessorConf","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":"DevAccount","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":"PlatformAdminAccount","exported":true,"kind":"interface","properties":[{"name":"email","type":{"kind":"name","group":"primitive","refName":"string"}},{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"}}]}]},"./l10n-types":{"namedTypes":[{"name":"JsonOfLanguageSchemaLocales","exported":true,"kind":"interface","properties":[{"name":"siteFieldLib","type":{"kind":"interface","indexSignature":{"keyName":"fieldName","keyType":"string","type":{"kind":"localRef","refName":"JsonOfLabelLocales"}}},"optional":true},{"name":"sectionFieldLib","type":{"kind":"interface","indexSignature":{"keyName":"fieldName","keyType":"string","type":{"kind":"localRef","refName":"JsonOfLabelLocales"}}},"optional":true},{"name":"site","type":{"kind":"interface","properties":[{"name":"fields","type":{"kind":"interface","indexSignature":{"keyName":"fieldName","keyType":"string","type":{"kind":"localRef","refName":"JsonOfLabelLocales"}}},"optional":true}]},"optional":true},{"name":"documentTypes","type":{"kind":"interface","indexSignature":{"keyName":"leafType","keyType":"string","type":{"kind":"localRef","refName":"JsonOfLabelLocales"}}},"optional":true},{"name":"partTypes","type":{"kind":"interface","indexSignature":{"keyName":"leafType","keyType":"string","type":{"kind":"localRef","refName":"JsonOfLabelLocales"}}},"optional":true}]},{"name":"JsonOfLabelLocales","exported":true,"kind":"interface","indexSignature":{"keyName":"key","keyType":"string","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"localRef","refName":"JsonOfLabelLocales"}]}}}]},"./site-schema-json-types":{"namedTypes":[{"name":"JsonOfCommonSchema","exported":true,"docComment":"The common schema is currently an internal file. Here is its typing.","kind":"interface","properties":[{"name":"schemaEngineVersion","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"This is the version of the schema engine."},{"name":"langs","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":"site","type":{"kind":"interface","properties":[{"name":"fields","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfFieldType"}}}]}}]},{"name":"JsonOfSiteSchemaBase","exported":true,"docComment":"This properties are part of a site schema, and part of the internal library as well.","kind":"interface","properties":[{"name":"schemaEngineVersion","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"This is the version of the schema engine."},{"name":"langs","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"docComment":"Specify the list of 2-letters language codes of the website. The first language is the default language.\n\n@example `[\"en\", \"fr\"]`"},{"name":"useModules","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"optional":true,"docComment":"Allows you to load other configuration schema in module form\n@example [\"media-policies\", \"simple-page\"]"},{"name":"site","type":{"kind":"localRef","refName":"JsonOfSiteDataSchema"},"optional":true},{"name":"partTypes","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfPartSchema"}},"optional":true,"docComment":"The different parts that can be used in documents."},{"name":"mediaPolicies","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfMediaPolicy"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true,"docComment":"Media policies"},{"name":"imageQualityPolicy","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfImageCompressionQualityPolicy"}},"optional":true,"docComment":"We can set the image compression quality here. The list must be ordered from the lowest area\nto the highest.\n@example\n```json\n{\n \"areaLimitPx\": 120000,\n \"quality\": 90\n},\n{\n \"areaLimitPx\": 750000,\n \"quality\": 80\n},\n{\n \"quality\": 70\n}\n```"}]},{"name":"JsonOfSiteDataSchema","exported":true,"kind":"interface","properties":[{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true,"docComment":"The fields of the site. They will be added to the required fields `[\"title\", \"contactEmail\", \"favicon\", \"ogImage\"]`.\n\n@example `[\"logo\", \"slogan\", \"phone\"]`"}]},{"name":"JsonOfSiteSchema","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfSiteSchemaBase"},{"kind":"interface","properties":[{"name":"siteFieldLib","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true},{"name":"sectionFieldLib","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true},{"name":"documentTypes","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfDocumentType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true,"docComment":"If missing, then `[\"home\"]` is taken by default."}]}]},{"name":"JsonOfSiteSchemaModule","exported":true,"docComment":"The site schema module","kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfSiteSchemaBase"},{"kind":"interface","properties":[{"name":"siteFieldLib","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfFieldType"}},"optional":true,"docComment":"Allows you to specify the different fields to add as site properties.\n\nParoiCMS is a dynamic CMS; then it does not impose a structure regarding the\nsite configuration values. As an example of configuration data, we have the\ntitle, logo, slogan, contacts etc...\n\n@see {@link JsonOfFieldType}"},{"name":"sectionFieldLib","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfFieldType"}},"optional":true,"docComment":"Allows you to specify the different fields of a document\n\nThe structure of a document is not imposed. You can choose to\nhave for your document to have the following fields: title, content, media gallery.\n@see {@link JsonOfFieldType}\n@see {@link JsonOfModuleDocumentType}"},{"name":"documentTypes","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfModuleDocumentType"}},"optional":true,"docComment":"Allows you to add the different types of documents that will be handled on the site.\n@see {@link JsonOfModuleDocumentType}"}]}]},{"name":"JsonOfModuleDocumentType","exported":true,"docComment":"A document is a web page. For example, a block article, a service, or a contact page is\na document. What all these elements have in common is that they can be edited in the back-office\nand published on the public site.","kind":"interface","properties":[{"name":"leafType","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"This is the identifier of the document type."},{"name":"route","type":{"kind":"composite","op":"union","types":[{"kind":"name","group":"primitive","refName":"string"},{"kind":"interface","indexSignature":{"keyName":"lang","keyType":"string","type":{"kind":"name","group":"primitive","refName":"string"}}}]},"optional":true,"docComment":"@example\n```json\n \"route\": {\n \"en\": \"posts\",\n \"fr\": \"articles\"\n },\n```"},{"name":"relativeIdGenerator","type":{"kind":"array","itemType":{"kind":"name","group":"ts","refName":"any"}},"optional":true,"docComment":"@example `[\"default\", 6]`"},{"name":"children","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"optional":true,"docComment":"Types of children that are allowed for the document."},{"name":"childOrdering","type":{"kind":"localRef","refName":"JsonOfChildOrdering"},"optional":true,"docComment":"We define how to order the children here."},{"name":"childLimit","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"The maximum number of children."},{"name":"partLists","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfPartListSchema"}},"optional":true,"docComment":"The lists of parts in the document."},{"name":"useTaxonomies","type":{"kind":"array","itemType":{"kind":"localRef","refName":"JsonOfUseTaxonomy"}},"optional":true,"docComment":"The list of taxonomies used in the document."},{"name":"withData","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"Value `false` means that the document is just a hierarchy parent for other documents. But it\nhas no content itself."},{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true,"docComment":"The list of fields in the document."},{"name":"mediaPolicy","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"The name of the media policy."},{"name":"ogType","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"@see[Open Graph Protocol](https://ogp.me/)\n@example `\"article\"`"},{"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."}]},{"name":"JsonOfChildOrdering","exported":true,"docComment":"Child odering method.\n@default \"manual\"","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":"JsonOfDocumentType","exported":true,"docComment":"Document type","kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfModuleDocumentType"},{"kind":"interface","properties":[{"name":"from","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true}]}]},{"name":"JsonOfPartListSchema","exported":true,"docComment":"This is the definition of a list of parts.","kind":"interface","properties":[{"name":"listName","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"This is the identifier of the part list."},{"name":"orderBy","type":{"kind":"literal","literal":"manual"},"docComment":"Only `\"manual\"` is currently supported."},{"name":"partLeafTypes","type":{"kind":"array","itemType":{"kind":"name","group":"primitive","refName":"string"}},"docComment":"Part types that can be in the list."},{"name":"partLimit","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"Maximum number of parts in the list."}]},{"name":"JsonOfPartSchema","exported":true,"docComment":"This is part schema","kind":"interface","properties":[{"name":"leafType","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"This is the identifier of the part type."},{"name":"withData","type":{"kind":"name","group":"primitive","refName":"boolean"},"docComment":"Always `true`."},{"name":"fields","type":{"kind":"array","itemType":{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFieldType"},{"kind":"name","group":"primitive","refName":"string"}]}},"optional":true,"docComment":"The list of fields in the part."},{"name":"mediaPolicy","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"Give the name of the media policy, if there is one."}]},{"name":"JsonOfUseTaxonomy","exported":true,"docComment":"This object reprensents a link to a taxonomy. A taxonomy is a document type.","kind":"interface","properties":[{"name":"leafType","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"This is the identifier of the taxonomy's document type."},{"name":"relation","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"single"},{"kind":"literal","literal":"multiple"}]},"docComment":"A _single_ relation means that the document can only have one term. A _multiple_ relation\nmeans that the document can have multiple terms."},{"name":"withLeadTerm","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"single"},{"kind":"literal","literal":"multiple"}]},"optional":true,"docComment":"A _lead term_ is a term that is shown first."}]},{"name":"JsonOfFieldType","exported":true,"docComment":"This is field type. It can be varchar, text, leafMedia, leafGallery.\n@see {@link JsonOfVarcharFieldType}\n@see {@link JsonOfTextFieldType}\n@see {@link JsonOfLeafMediaFieldType}\n@see {@link JsonOfLeafGalleryFieldType}","kind":"composite","op":"union","types":[{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfVarcharFieldType"},{"kind":"localRef","refName":"JsonOfTextFieldType"},{"kind":"localRef","refName":"JsonOfLeafMediaFieldType"},{"kind":"localRef","refName":"JsonOfLeafGalleryFieldType"}]}]},{"name":"JsonOfFieldTypeBase","exported":true,"docComment":"This is the base type for other types: varchar text, leafMedia, leafGallery.\n@see {@link JsonOfVarcharFieldType}\n@see {@link JsonOfTextFieldType}\n@see {@link JsonOfLeafMediaFieldType}\n@see {@link JsonOfLeafGalleryFieldType}","kind":"interface","properties":[{"name":"storedOn","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"leaf"},{"kind":"literal","literal":"section"}]},"docComment":"The field value can be attached to\n- `leaf`: all the translations of the same document will share the same value\n- `section`: each translation will have its own value."},{"name":"name","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"The field name."}]},{"name":"JsonOfVarcharFieldType","exported":true,"docComment":"This is the base type for data varchar types: stringVarchar, numberVarchar, booleanVarchar\n@see {@link JsonOfStringVarcharFieldType}\n@see {@link JsonOfNumberVarcharFieldType}\n@see {@link JsonOfBooleanVarcharFieldType}","kind":"composite","op":"union","types":[{"kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfStringVarcharFieldType"},{"kind":"localRef","refName":"JsonOfNumberVarcharFieldType"},{"kind":"localRef","refName":"JsonOfBooleanVarcharFieldType"}]}]},{"name":"JsonOfStringVarcharFieldType","exported":true,"docComment":"This is string type with varchar data type","kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"string"}}]}]},{"name":"JsonOfNumberVarcharFieldType","exported":true,"docComment":"This is number type with varchar data type","kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"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,"docComment":"@example `\"EUR\"`"}]}]},{"name":"JsonOfBooleanVarcharFieldType","exported":true,"docComment":"This is boolean type with varchar data type","kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"varchar"}},{"name":"dataType","type":{"kind":"literal","literal":"boolean"}}]}]},{"name":"JsonOfTextFieldType","exported":true,"docComment":"@see {@link JsonOfFTextFieldType}\n@see {@link JsonOfJsonFieldType}","kind":"composite","op":"union","types":[{"kind":"localRef","refName":"JsonOfFTextFieldType"},{"kind":"localRef","refName":"JsonOfJsonFieldType"}]},{"name":"JsonOfFTextFieldType","exported":true,"docComment":"Formatted Text field (with HTML content).","kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"text"}},{"name":"dataType","type":{"kind":"composite","op":"union","types":[{"kind":"literal","literal":"quillDelta"},{"kind":"literal","literal":"html"}]}},{"name":"useAsExcerpt","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"\n@example"},{"name":"useAsDefaultImage","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"\n@example"},{"name":"withGallery","type":{"kind":"name","group":"primitive","refName":"boolean"},"optional":true,"docComment":"\n@example"},{"name":"backOffice","type":{"kind":"localRef","refName":"JsonOfFTextFieldBackOffice"},"optional":true,"docComment":"\n@example"}]}]},{"name":"JsonOfJsonFieldType","exported":true,"docComment":"This is JSON type","kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"text"}},{"name":"dataType","type":{"kind":"literal","literal":"json"}}]}]},{"name":"JsonOfFTextFieldBackOffice","exported":true,"docComment":"This is the back office properties of a formatted text field (ie. a text editor).","kind":"interface","properties":[{"name":"editorRows","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true}]},{"name":"JsonOfGalleryFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"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":"JsonOfLeafGalleryFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfGalleryFieldType"},{"kind":"interface","properties":[{"name":"useAsDefaultImage","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"\n@example"}]}]},{"name":"JsonOfMediaFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfFieldTypeBase"},{"kind":"interface","properties":[{"name":"storedAs","type":{"kind":"literal","literal":"mediaHandle"},"docComment":"\n@example"},{"name":"dataType","type":{"kind":"literal","literal":"media"},"docComment":"\n@example"},{"name":"accept","type":{"kind":"name","group":"primitive","refName":"string"},"docComment":"\n@example"},{"name":"refuse","type":{"kind":"name","group":"primitive","refName":"string"},"optional":true,"docComment":"\n@example"}]}]},{"name":"JsonOfLeafMediaFieldType","exported":true,"kind":"composite","op":"intersection","types":[{"kind":"localRef","refName":"JsonOfMediaFieldType"},{"kind":"interface","properties":[{"name":"useAsDefaultImage","type":{"kind":"name","group":"primitive","refName":"number"},"optional":true,"docComment":"\n@example"}]}]},{"name":"JsonOfMediaPolicy","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":"JsonOfAttachedDocumentPolicy"},"optional":true,"docComment":"Rules about non-image medias (like PDF files)."},{"name":"image","type":{"kind":"localRef","refName":"JsonOfImagePolicy"},"optional":true,"docComment":"Rules about images."}]},{"name":"JsonOfAttachedDocumentPolicy","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":"JsonOfImagePolicy","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":"JsonOfImageCompressionQualityPolicy","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`"}]}]},"./theme-json-types":{"namedTypes":[{"name":"JsonOfThemeConf","exported":true,"kind":"interface","properties":[{"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/server",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "The ParoiCMS server",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"cms",
|
|
@@ -47,13 +47,13 @@
|
|
|
47
47
|
"@nestjs/throttler": "~5.1.2",
|
|
48
48
|
"@paroi/async-lib": "~0.1.2",
|
|
49
49
|
"@paroi/data-formatters-lib": "~0.1.2",
|
|
50
|
-
"@paroicms/anywhere-lib": "0.
|
|
51
|
-
"@paroicms/bo": "0.
|
|
52
|
-
"@paroicms/server-database-media-storage": "0.
|
|
53
|
-
"@paroicms/server-image-cache-engine": "0.
|
|
54
|
-
"@paroicms/server-lib": "0.
|
|
55
|
-
"@paroicms/server-text-cache-system": "0.
|
|
56
|
-
"@paroicms/site-app": "0.
|
|
50
|
+
"@paroicms/anywhere-lib": "1.0.0",
|
|
51
|
+
"@paroicms/bo": "1.0.0",
|
|
52
|
+
"@paroicms/server-database-media-storage": "1.0.0",
|
|
53
|
+
"@paroicms/server-image-cache-engine": "1.0.0",
|
|
54
|
+
"@paroicms/server-lib": "1.0.0",
|
|
55
|
+
"@paroicms/server-text-cache-system": "1.0.0",
|
|
56
|
+
"@paroicms/site-app": "1.0.0",
|
|
57
57
|
"@typeonly/validator": "~0.6.0",
|
|
58
58
|
"archiver": "~6.0.1",
|
|
59
59
|
"bcrypt": "~5.1.0",
|