@webiny/api-headless-cms 0.0.0-unstable.990c3ab1b6 → 0.0.0-unstable.d16f688daf

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.
Files changed (310) hide show
  1. package/context.js +15 -0
  2. package/context.js.map +1 -1
  3. package/crud/contentEntry/afterDelete.js +5 -0
  4. package/crud/contentEntry/afterDelete.js.map +1 -1
  5. package/crud/contentEntry/beforeCreate.js +3 -0
  6. package/crud/contentEntry/beforeCreate.js.map +1 -1
  7. package/crud/contentEntry/beforeUpdate.js +3 -0
  8. package/crud/contentEntry/beforeUpdate.js.map +1 -1
  9. package/crud/contentEntry/entryDataValidation.js +40 -1
  10. package/crud/contentEntry/entryDataValidation.js.map +1 -1
  11. package/crud/contentEntry/markLockedFields.js +30 -4
  12. package/crud/contentEntry/markLockedFields.js.map +1 -1
  13. package/crud/contentEntry/referenceFieldsMapping.js +68 -10
  14. package/crud/contentEntry/referenceFieldsMapping.js.map +1 -1
  15. package/crud/contentEntry/searchableFields.d.ts +9 -0
  16. package/crud/contentEntry/searchableFields.js +83 -0
  17. package/crud/contentEntry/searchableFields.js.map +1 -0
  18. package/crud/contentEntry.crud.js +190 -50
  19. package/crud/contentEntry.crud.js.map +1 -1
  20. package/crud/contentModel/afterCreate.js +2 -0
  21. package/crud/contentModel/afterCreate.js.map +1 -1
  22. package/crud/contentModel/afterCreateFrom.js +2 -0
  23. package/crud/contentModel/afterCreateFrom.js.map +1 -1
  24. package/crud/contentModel/afterDelete.js +2 -0
  25. package/crud/contentModel/afterDelete.js.map +1 -1
  26. package/crud/contentModel/afterUpdate.js +2 -0
  27. package/crud/contentModel/afterUpdate.js.map +1 -1
  28. package/crud/contentModel/beforeCreate.js +32 -4
  29. package/crud/contentModel/beforeCreate.js.map +1 -1
  30. package/crud/contentModel/beforeDelete.js +10 -0
  31. package/crud/contentModel/beforeDelete.js.map +1 -1
  32. package/crud/contentModel/beforeUpdate.js +5 -0
  33. package/crud/contentModel/beforeUpdate.js.map +1 -1
  34. package/crud/contentModel/contentModelManagerFactory.js +7 -0
  35. package/crud/contentModel/contentModelManagerFactory.js.map +1 -1
  36. package/crud/contentModel/createFieldModels.js +6 -0
  37. package/crud/contentModel/createFieldModels.js.map +1 -1
  38. package/crud/contentModel/createFieldStorageId.js +7 -1
  39. package/crud/contentModel/createFieldStorageId.js.map +1 -1
  40. package/crud/contentModel/fieldIdValidation.js +5 -0
  41. package/crud/contentModel/fieldIdValidation.js.map +1 -1
  42. package/crud/contentModel/idValidation.js +5 -0
  43. package/crud/contentModel/idValidation.js.map +1 -1
  44. package/crud/contentModel/models.js +20 -1
  45. package/crud/contentModel/models.js.map +1 -1
  46. package/crud/contentModel/systemFields.js.map +1 -1
  47. package/crud/contentModel/validateLayout.js +8 -0
  48. package/crud/contentModel/validateLayout.js.map +1 -1
  49. package/crud/contentModel/validateModel.js +8 -0
  50. package/crud/contentModel/validateModel.js.map +1 -1
  51. package/crud/contentModel/validateModelFields.js +97 -33
  52. package/crud/contentModel/validateModelFields.js.map +1 -1
  53. package/crud/contentModel.crud.js +251 -121
  54. package/crud/contentModel.crud.js.map +1 -1
  55. package/crud/contentModelGroup/beforeCreate.js +12 -0
  56. package/crud/contentModelGroup/beforeCreate.js.map +1 -1
  57. package/crud/contentModelGroup/beforeDelete.js +8 -0
  58. package/crud/contentModelGroup/beforeDelete.js.map +1 -1
  59. package/crud/contentModelGroup/beforeUpdate.js +5 -0
  60. package/crud/contentModelGroup/beforeUpdate.js.map +1 -1
  61. package/crud/contentModelGroup.crud.js +74 -7
  62. package/crud/contentModelGroup.crud.js.map +1 -1
  63. package/crud/index.js +16 -0
  64. package/crud/index.js.map +1 -1
  65. package/crud/settings.crud.js +12 -0
  66. package/crud/settings.crud.js.map +1 -1
  67. package/crud/system.crud.js +37 -2
  68. package/crud/system.crud.js.map +1 -1
  69. package/fieldConverters/CmsModelDefaultFieldConverterPlugin.js +13 -0
  70. package/fieldConverters/CmsModelDefaultFieldConverterPlugin.js.map +1 -1
  71. package/fieldConverters/CmsModelDynamicZoneFieldConverterPlugin.d.ts +11 -0
  72. package/fieldConverters/CmsModelDynamicZoneFieldConverterPlugin.js +239 -0
  73. package/fieldConverters/CmsModelDynamicZoneFieldConverterPlugin.js.map +1 -0
  74. package/fieldConverters/CmsModelObjectFieldConverterPlugin.js +53 -0
  75. package/fieldConverters/CmsModelObjectFieldConverterPlugin.js.map +1 -1
  76. package/fieldConverters/index.d.ts +2 -1
  77. package/fieldConverters/index.js +7 -1
  78. package/fieldConverters/index.js.map +1 -1
  79. package/graphql/buildSchemaPlugins.js +9 -5
  80. package/graphql/buildSchemaPlugins.js.map +1 -1
  81. package/graphql/graphQLHandlerFactory.js +86 -17
  82. package/graphql/graphQLHandlerFactory.js.map +1 -1
  83. package/graphql/index.d.ts +1 -1
  84. package/graphql/index.js +8 -1
  85. package/graphql/index.js.map +1 -1
  86. package/graphql/schema/baseContentSchema.js +10 -2
  87. package/graphql/schema/baseContentSchema.js.map +1 -1
  88. package/graphql/schema/contentEntries.js +42 -2
  89. package/graphql/schema/contentEntries.js.map +1 -1
  90. package/graphql/schema/contentModelGroups.js +19 -2
  91. package/graphql/schema/contentModelGroups.js.map +1 -1
  92. package/graphql/schema/contentModels.js +41 -6
  93. package/graphql/schema/contentModels.js.map +1 -1
  94. package/graphql/schema/createFieldResolvers.d.ts +1 -1
  95. package/graphql/schema/createFieldResolvers.js +30 -8
  96. package/graphql/schema/createFieldResolvers.js.map +1 -1
  97. package/graphql/schema/createManageResolvers.js +26 -0
  98. package/graphql/schema/createManageResolvers.js.map +1 -1
  99. package/graphql/schema/createManageSDL.js +19 -5
  100. package/graphql/schema/createManageSDL.js.map +1 -1
  101. package/graphql/schema/createPreviewResolvers.js +10 -0
  102. package/graphql/schema/createPreviewResolvers.js.map +1 -1
  103. package/graphql/schema/createReadResolvers.js +10 -0
  104. package/graphql/schema/createReadResolvers.js.map +1 -1
  105. package/graphql/schema/createReadSDL.js +15 -3
  106. package/graphql/schema/createReadSDL.js.map +1 -1
  107. package/graphql/schema/resolvers/commonFieldResolvers.js +2 -0
  108. package/graphql/schema/resolvers/commonFieldResolvers.js.map +1 -1
  109. package/graphql/schema/resolvers/manage/resolveCreate.js +3 -0
  110. package/graphql/schema/resolvers/manage/resolveCreate.js.map +1 -1
  111. package/graphql/schema/resolvers/manage/resolveCreateFrom.js +3 -0
  112. package/graphql/schema/resolvers/manage/resolveCreateFrom.js.map +1 -1
  113. package/graphql/schema/resolvers/manage/resolveDelete.js +6 -0
  114. package/graphql/schema/resolvers/manage/resolveDelete.js.map +1 -1
  115. package/graphql/schema/resolvers/manage/resolveGet.js +16 -0
  116. package/graphql/schema/resolvers/manage/resolveGet.js.map +1 -1
  117. package/graphql/schema/resolvers/manage/resolveGetByIds.js +3 -0
  118. package/graphql/schema/resolvers/manage/resolveGetByIds.js.map +1 -1
  119. package/graphql/schema/resolvers/manage/resolveGetRevisions.js +3 -0
  120. package/graphql/schema/resolvers/manage/resolveGetRevisions.js.map +1 -1
  121. package/graphql/schema/resolvers/manage/resolveList.js +3 -0
  122. package/graphql/schema/resolvers/manage/resolveList.js.map +1 -1
  123. package/graphql/schema/resolvers/manage/resolvePublish.js +3 -0
  124. package/graphql/schema/resolvers/manage/resolvePublish.js.map +1 -1
  125. package/graphql/schema/resolvers/manage/resolveRepublish.js +3 -0
  126. package/graphql/schema/resolvers/manage/resolveRepublish.js.map +1 -1
  127. package/graphql/schema/resolvers/manage/resolveUnpublish.js +3 -0
  128. package/graphql/schema/resolvers/manage/resolveUnpublish.js.map +1 -1
  129. package/graphql/schema/resolvers/manage/resolveUpdate.js +3 -0
  130. package/graphql/schema/resolvers/manage/resolveUpdate.js.map +1 -1
  131. package/graphql/schema/resolvers/preview/resolveGet.js +8 -0
  132. package/graphql/schema/resolvers/preview/resolveGet.js.map +1 -1
  133. package/graphql/schema/resolvers/preview/resolveList.js +3 -0
  134. package/graphql/schema/resolvers/preview/resolveList.js.map +1 -1
  135. package/graphql/schema/resolvers/read/resolveGet.js +8 -0
  136. package/graphql/schema/resolvers/read/resolveGet.js.map +1 -1
  137. package/graphql/schema/resolvers/read/resolveList.js +3 -0
  138. package/graphql/schema/resolvers/read/resolveList.js.map +1 -1
  139. package/graphql/schema/schemaPlugins.js +19 -5
  140. package/graphql/schema/schemaPlugins.js.map +1 -1
  141. package/graphql/system.js +14 -1
  142. package/graphql/system.js.map +1 -1
  143. package/graphqlFields/boolean.js +12 -0
  144. package/graphqlFields/boolean.js.map +1 -1
  145. package/graphqlFields/datetime.js +17 -0
  146. package/graphqlFields/datetime.js.map +1 -1
  147. package/graphqlFields/dynamicZone/dynamicZoneField.d.ts +2 -0
  148. package/graphqlFields/dynamicZone/dynamicZoneField.js +234 -0
  149. package/graphqlFields/dynamicZone/dynamicZoneField.js.map +1 -0
  150. package/graphqlFields/dynamicZone/dynamicZoneStorage.d.ts +3 -0
  151. package/graphqlFields/dynamicZone/dynamicZoneStorage.js +79 -0
  152. package/graphqlFields/dynamicZone/dynamicZoneStorage.js.map +1 -0
  153. package/graphqlFields/dynamicZone/index.d.ts +2 -0
  154. package/graphqlFields/dynamicZone/index.js +21 -0
  155. package/graphqlFields/dynamicZone/index.js.map +1 -0
  156. package/graphqlFields/file.js +8 -0
  157. package/graphqlFields/file.js.map +1 -1
  158. package/graphqlFields/helpers.js +10 -0
  159. package/graphqlFields/helpers.js.map +1 -1
  160. package/graphqlFields/index.d.ts +1 -1
  161. package/graphqlFields/index.js +14 -1
  162. package/graphqlFields/index.js.map +1 -1
  163. package/graphqlFields/longText.js +10 -0
  164. package/graphqlFields/longText.js.map +1 -1
  165. package/graphqlFields/number.js +16 -0
  166. package/graphqlFields/number.js.map +1 -1
  167. package/graphqlFields/object.js +148 -68
  168. package/graphqlFields/object.js.map +1 -1
  169. package/graphqlFields/ref.js +77 -61
  170. package/graphqlFields/ref.js.map +1 -1
  171. package/graphqlFields/richText.js +9 -0
  172. package/graphqlFields/richText.js.map +1 -1
  173. package/graphqlFields/text.js +11 -0
  174. package/graphqlFields/text.js.map +1 -1
  175. package/index.d.ts +2 -2
  176. package/index.js +22 -1
  177. package/index.js.map +1 -1
  178. package/modelManager/DefaultCmsModelManager.js +16 -0
  179. package/modelManager/DefaultCmsModelManager.js.map +1 -1
  180. package/modelManager/index.js +4 -0
  181. package/modelManager/index.js.map +1 -1
  182. package/package.json +25 -24
  183. package/parameters/context.js +4 -0
  184. package/parameters/context.js.map +1 -1
  185. package/parameters/header.js +11 -0
  186. package/parameters/header.js.map +1 -1
  187. package/parameters/index.js +8 -0
  188. package/parameters/index.js.map +1 -1
  189. package/parameters/manual.js +8 -1
  190. package/parameters/manual.js.map +1 -1
  191. package/parameters/path.js +11 -0
  192. package/parameters/path.js.map +1 -1
  193. package/plugins/CmsGroupPlugin.js +8 -0
  194. package/plugins/CmsGroupPlugin.js.map +1 -1
  195. package/plugins/CmsModelFieldConverterPlugin.d.ts +2 -2
  196. package/plugins/CmsModelFieldConverterPlugin.js +5 -0
  197. package/plugins/CmsModelFieldConverterPlugin.js.map +1 -1
  198. package/plugins/CmsModelPlugin.js +38 -2
  199. package/plugins/CmsModelPlugin.js.map +1 -1
  200. package/plugins/CmsParametersPlugin.js +7 -0
  201. package/plugins/CmsParametersPlugin.js.map +1 -1
  202. package/plugins/StorageTransformPlugin.d.ts +11 -11
  203. package/plugins/StorageTransformPlugin.js +9 -0
  204. package/plugins/StorageTransformPlugin.js.map +1 -1
  205. package/plugins/index.js +10 -0
  206. package/plugins/index.js.map +1 -1
  207. package/storage/default.js +3 -0
  208. package/storage/default.js.map +1 -1
  209. package/storage/object.js +23 -2
  210. package/storage/object.js.map +1 -1
  211. package/types.d.ts +185 -42
  212. package/types.js +112 -7
  213. package/types.js.map +1 -1
  214. package/upgrades/5.33.0/index.js +26 -3
  215. package/upgrades/5.33.0/index.js.map +1 -1
  216. package/upgrades/index.js +3 -0
  217. package/upgrades/index.js.map +1 -1
  218. package/utils/access.js +25 -11
  219. package/utils/access.js.map +1 -1
  220. package/utils/converters/Converter.js +13 -0
  221. package/utils/converters/Converter.js.map +1 -1
  222. package/utils/converters/ConverterCollection.js +38 -11
  223. package/utils/converters/ConverterCollection.js.map +1 -1
  224. package/utils/converters/valueKeyStorageConverter.js +26 -0
  225. package/utils/converters/valueKeyStorageConverter.js.map +1 -1
  226. package/utils/createTypeFromFields.d.ts +15 -0
  227. package/utils/createTypeFromFields.js +75 -0
  228. package/utils/createTypeFromFields.js.map +1 -0
  229. package/utils/createTypeName.js +11 -1
  230. package/utils/createTypeName.js.map +1 -1
  231. package/utils/entryStorage.js +38 -19
  232. package/utils/entryStorage.js.map +1 -1
  233. package/utils/filterAsync.js +5 -0
  234. package/utils/filterAsync.js.map +1 -1
  235. package/utils/filterModelFields.js +9 -3
  236. package/utils/filterModelFields.js.map +1 -1
  237. package/utils/getBaseFieldType.d.ts +4 -0
  238. package/utils/getBaseFieldType.js +12 -0
  239. package/utils/getBaseFieldType.js.map +1 -0
  240. package/utils/getEntryTitle.js +9 -0
  241. package/utils/getEntryTitle.js.map +1 -1
  242. package/utils/getSchemaFromFieldPlugins.js +6 -2
  243. package/utils/getSchemaFromFieldPlugins.js.map +1 -1
  244. package/utils/ownership.js +8 -0
  245. package/utils/ownership.js.map +1 -1
  246. package/utils/permissions.js +23 -8
  247. package/utils/permissions.js.map +1 -1
  248. package/utils/pluralizedTypeName.js +6 -0
  249. package/utils/pluralizedTypeName.js.map +1 -1
  250. package/utils/renderFields.js +11 -1
  251. package/utils/renderFields.js.map +1 -1
  252. package/utils/renderGetFilterFields.js +19 -3
  253. package/utils/renderGetFilterFields.js.map +1 -1
  254. package/utils/renderInputFields.js +11 -1
  255. package/utils/renderInputFields.js.map +1 -1
  256. package/utils/renderListFilterFields.js +13 -2
  257. package/utils/renderListFilterFields.js.map +1 -1
  258. package/utils/renderSortEnum.js +10 -1
  259. package/utils/renderSortEnum.js.map +1 -1
  260. package/utils/toSlug.js +4 -0
  261. package/utils/toSlug.js.map +1 -1
  262. package/validators/dateGte.js +7 -0
  263. package/validators/dateGte.js.map +1 -1
  264. package/validators/dateLte.js +7 -0
  265. package/validators/dateLte.js.map +1 -1
  266. package/validators/dynamicZone.d.ts +2 -0
  267. package/validators/dynamicZone.js +24 -0
  268. package/validators/dynamicZone.js.map +1 -0
  269. package/validators/gte.js +8 -0
  270. package/validators/gte.js.map +1 -1
  271. package/validators/in.js +8 -0
  272. package/validators/in.js.map +1 -1
  273. package/validators/index.js +18 -1
  274. package/validators/index.js.map +1 -1
  275. package/validators/lte.js +8 -0
  276. package/validators/lte.js.map +1 -1
  277. package/validators/maxLength.js +8 -0
  278. package/validators/maxLength.js.map +1 -1
  279. package/validators/minLength.js +8 -0
  280. package/validators/minLength.js.map +1 -1
  281. package/validators/pattern.js +9 -0
  282. package/validators/pattern.js.map +1 -1
  283. package/validators/patternPlugins/email.js +2 -0
  284. package/validators/patternPlugins/email.js.map +1 -1
  285. package/validators/patternPlugins/index.js +8 -0
  286. package/validators/patternPlugins/index.js.map +1 -1
  287. package/validators/patternPlugins/lowerCase.js +2 -0
  288. package/validators/patternPlugins/lowerCase.js.map +1 -1
  289. package/validators/patternPlugins/lowerCaseSpace.js +2 -0
  290. package/validators/patternPlugins/lowerCaseSpace.js.map +1 -1
  291. package/validators/patternPlugins/upperCase.js +2 -0
  292. package/validators/patternPlugins/upperCase.js.map +1 -1
  293. package/validators/patternPlugins/upperCaseSpace.js +2 -0
  294. package/validators/patternPlugins/upperCaseSpace.js.map +1 -1
  295. package/validators/patternPlugins/url.js +2 -0
  296. package/validators/patternPlugins/url.js.map +1 -1
  297. package/validators/required.js +5 -0
  298. package/validators/required.js.map +1 -1
  299. package/validators/timeGte.js +8 -0
  300. package/validators/timeGte.js.map +1 -1
  301. package/validators/timeLte.js +8 -0
  302. package/validators/timeLte.js.map +1 -1
  303. package/validators/unique.js +7 -0
  304. package/validators/unique.js.map +1 -1
  305. package/graphql/schema/resolvers/manage/resolveRequestChanges.d.ts +0 -7
  306. package/graphql/schema/resolvers/manage/resolveRequestChanges.js +0 -21
  307. package/graphql/schema/resolvers/manage/resolveRequestChanges.js.map +0 -1
  308. package/graphql/schema/resolvers/manage/resolveRequestReview.d.ts +0 -7
  309. package/graphql/schema/resolvers/manage/resolveRequestReview.js +0 -21
  310. package/graphql/schema/resolvers/manage/resolveRequestReview.js.map +0 -1
package/types.d.ts CHANGED
@@ -135,7 +135,7 @@ export interface CmsModelField {
135
135
  * A type of the field.
136
136
  * We are defining our built-in fields, so people know which are available by the default.
137
137
  */
138
- type: "boolean" | "datetime" | "file" | "long-text" | "number" | "object" | "ref" | "rich-text" | "text" | string;
138
+ type: "boolean" | "datetime" | "file" | "long-text" | "number" | "object" | "ref" | "rich-text" | "text" | "dynamicZone" | string;
139
139
  /**
140
140
  * A unique storage ID for storing actual values.
141
141
  * Must in form of a-zA-Z0-9@a-zA-Z0-9@a-zA-Z0-9.
@@ -195,6 +195,10 @@ export interface CmsModelField {
195
195
  *
196
196
  */
197
197
  multipleValues?: boolean;
198
+ /**
199
+ * Fields can be tagged to give them contextual meaning.
200
+ */
201
+ tags?: string[];
198
202
  /**
199
203
  * Any user defined settings.
200
204
  *
@@ -202,18 +206,42 @@ export interface CmsModelField {
202
206
  */
203
207
  settings?: CmsModelFieldSettings;
204
208
  }
209
+ export interface CmsDynamicZoneTemplate {
210
+ id: string;
211
+ name: string;
212
+ gqlTypeName: string;
213
+ description: string;
214
+ icon: string;
215
+ fields: CmsModelField[];
216
+ layout: string[][];
217
+ validation: CmsModelFieldValidation[];
218
+ }
219
+ /**
220
+ * A definition for dynamic-zone field to show possible type of the field in settings.
221
+ */
222
+ export interface CmsModelDynamicZoneField extends CmsModelField {
223
+ /**
224
+ * Settings object for the field. Contains `templates` property.
225
+ */
226
+ settings: {
227
+ templates: CmsDynamicZoneTemplate[];
228
+ };
229
+ }
205
230
  /**
206
231
  * Used for our internal functionality.
207
232
  */
208
233
  export interface CmsModelFieldWithParent extends CmsModelField {
209
234
  parent?: CmsModelFieldWithParent | null;
210
235
  }
236
+ export interface CmsModelDynamicZoneFieldWithParent extends CmsModelDynamicZoneField {
237
+ parent?: CmsModelDynamicZoneFieldWithParent | null;
238
+ }
211
239
  /**
212
240
  * A definition for dateTime field to show possible type of the field in settings.
213
241
  */
214
242
  export interface CmsModelDateTimeField extends CmsModelField {
215
243
  /**
216
- * Settings object for the field. Contains type property.
244
+ * Settings object for the field. Contains `type` property.
217
245
  */
218
246
  settings: {
219
247
  type: "time" | "date" | "dateTimeWithoutTimezone" | "dateTimeWithTimezone";
@@ -401,6 +429,10 @@ export interface CmsModel {
401
429
  * ```
402
430
  */
403
431
  layout: string[][];
432
+ /**
433
+ * Models can be tagged to give them contextual meaning.
434
+ */
435
+ tags?: string[];
404
436
  /**
405
437
  * List of locked fields. Updated when entry is saved and a field has been used.
406
438
  */
@@ -437,25 +469,40 @@ export interface CmsModelFieldDefinition {
437
469
  fields: string;
438
470
  typeDefs?: string;
439
471
  }
440
- interface CmsModelFieldToGraphQLCreateResolverParams {
472
+ interface CmsModelFieldToGraphQLCreateResolverParams<TField> {
441
473
  models: CmsModel[];
442
474
  model: CmsModel;
443
475
  graphQLType: string;
444
- field: CmsModelField;
476
+ field: TField;
445
477
  createFieldResolvers: any;
446
478
  }
447
- export interface CmsModelFieldToGraphQLCreateResolver {
448
- (params: CmsModelFieldToGraphQLCreateResolverParams): GraphQLFieldResolver | {
479
+ export interface CmsModelFieldToGraphQLCreateResolver<TField = CmsModelField> {
480
+ (params: CmsModelFieldToGraphQLCreateResolverParams<TField>): GraphQLFieldResolver | {
449
481
  resolver: GraphQLFieldResolver | null;
450
482
  typeResolvers: Resolvers<CmsContext>;
451
483
  } | false;
452
484
  }
485
+ export interface CmsModelFieldToGraphQLPluginValidateChildFieldsValidateParams<TField extends CmsModelField = CmsModelField> {
486
+ fields: TField[];
487
+ originalFields: TField[];
488
+ }
489
+ export interface CmsModelFieldToGraphQLPluginValidateChildFieldsValidate {
490
+ (params: CmsModelFieldToGraphQLPluginValidateChildFieldsValidateParams): void;
491
+ }
492
+ export interface CmsModelFieldToGraphQLPluginValidateChildFieldsParams<TField extends CmsModelField = CmsModelField> {
493
+ field: TField;
494
+ originalField?: TField;
495
+ validate: CmsModelFieldToGraphQLPluginValidateChildFieldsValidate;
496
+ }
497
+ export interface CmsModelFieldToGraphQLPluginValidateChildFields<TField extends CmsModelField = CmsModelField> {
498
+ (params: CmsModelFieldToGraphQLPluginValidateChildFieldsParams<TField>): void;
499
+ }
453
500
  /**
454
501
  * @category Plugin
455
502
  * @category ModelField
456
503
  * @category GraphQL
457
504
  */
458
- export interface CmsModelFieldToGraphQLPlugin extends Plugin {
505
+ export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = CmsModelField> extends Plugin {
459
506
  /**
460
507
  * A plugin type
461
508
  */
@@ -509,7 +556,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
509
556
  */
510
557
  createStorageId?: (params: {
511
558
  model: CmsModel;
512
- field: CmsModelField;
559
+ field: TField;
513
560
  }) => string | null | undefined;
514
561
  /**
515
562
  * Read API methods.
@@ -528,7 +575,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
528
575
  */
529
576
  createGetFilters?(params: {
530
577
  model: CmsModel;
531
- field: CmsModelField;
578
+ field: TField;
532
579
  }): string;
533
580
  /**
534
581
  * Definition for list filtering for GraphQL.
@@ -548,7 +595,8 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
548
595
  */
549
596
  createListFilters?(params: {
550
597
  model: CmsModel;
551
- field: CmsModelField;
598
+ field: TField;
599
+ plugins: CmsFieldTypePlugins;
552
600
  }): string;
553
601
  /**
554
602
  * Definition of the field type for GraphQL - be aware if multiple values is selected.
@@ -567,12 +615,12 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
567
615
  */
568
616
  createTypeField(params: {
569
617
  model: CmsModel;
570
- field: CmsModelField;
618
+ field: TField;
571
619
  fieldTypePlugins: CmsFieldTypePlugins;
572
620
  }): CmsModelFieldDefinition | string | null;
573
621
  /**
574
622
  * Definition for field resolver.
575
- * By default it is simple return of the `instance.values[storageId]` but if required, users can define their own.
623
+ * By default, it is simple return of the `instance.values[storageId]` but if required, users can define their own.
576
624
  *
577
625
  * ```ts
578
626
  * read: {
@@ -584,7 +632,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
584
632
  * }
585
633
  * ```
586
634
  */
587
- createResolver?: CmsModelFieldToGraphQLCreateResolver;
635
+ createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;
588
636
  /**
589
637
  * Read API schema definitions for the field and resolvers for them.
590
638
  *
@@ -627,7 +675,8 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
627
675
  */
628
676
  createListFilters?: (params: {
629
677
  model: CmsModel;
630
- field: CmsModelField;
678
+ field: TField;
679
+ plugins: CmsFieldTypePlugins;
631
680
  }) => string;
632
681
  /**
633
682
  * Manage API schema definitions for the field and resolvers for them. Probably similar to `read.createSchema`.
@@ -666,7 +715,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
666
715
  */
667
716
  createTypeField: (params: {
668
717
  model: CmsModel;
669
- field: CmsModelField;
718
+ field: TField;
670
719
  fieldTypePlugins: CmsFieldTypePlugins;
671
720
  }) => CmsModelFieldDefinition | string | null;
672
721
  /**
@@ -686,12 +735,12 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
686
735
  */
687
736
  createInputField: (params: {
688
737
  model: CmsModel;
689
- field: CmsModelField;
738
+ field: TField;
690
739
  fieldTypePlugins: CmsFieldTypePlugins;
691
740
  }) => CmsModelFieldDefinition | string | null;
692
741
  /**
693
742
  * Definition for field resolver.
694
- * By default it is simple return of the `instance.values[storageId]` but if required, users can define their own.
743
+ * By default, it is simple return of the `instance.values[storageId]` but if required, users can define their own.
695
744
  *
696
745
  * ```ts
697
746
  * manage: {
@@ -703,8 +752,13 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
703
752
  * }
704
753
  * ```
705
754
  */
706
- createResolver?: CmsModelFieldToGraphQLCreateResolver;
755
+ createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;
707
756
  };
757
+ /**
758
+ *
759
+ * @param field
760
+ */
761
+ validateChildFields?: CmsModelFieldToGraphQLPluginValidateChildFields<TField>;
708
762
  }
709
763
  /**
710
764
  * Check for content model locked field.
@@ -743,7 +797,7 @@ export interface CmsFieldTypePlugins {
743
797
  [key: string]: CmsModelFieldToGraphQLPlugin;
744
798
  }
745
799
  /**
746
- * A interface describing the reference to a user that created some data in the database.
800
+ * An interface describing the reference to a user that created some data in the database.
747
801
  *
748
802
  * @category General
749
803
  */
@@ -837,7 +891,7 @@ export declare type CmsSystemContext = {
837
891
  onSystemInstallError: Topic<OnSystemInstallErrorTopicParams>;
838
892
  };
839
893
  /**
840
- * A GraphQL params.data parameter received when creating content model group.
894
+ * A GraphQL `params.data` parameter received when creating content model group.
841
895
  *
842
896
  * @category CmsGroup
843
897
  * @category GraphQL params
@@ -849,7 +903,7 @@ export interface CmsGroupCreateInput {
849
903
  icon: string;
850
904
  }
851
905
  /**
852
- * A GraphQL params.data parameter received when updating content model group.
906
+ * A GraphQL `params.data` parameter received when updating content model group.
853
907
  *
854
908
  * @category CmsGroup
855
909
  * @category GraphQL params
@@ -919,7 +973,7 @@ export interface CmsGroup {
919
973
  isPrivate?: boolean;
920
974
  }
921
975
  /**
922
- * A data.where parameter received when listing content model groups.
976
+ * A `data.where` parameter received when listing content model groups.
923
977
  *
924
978
  * @category CmsGroup
925
979
  * @category GraphQL params
@@ -945,6 +999,15 @@ export interface OnGroupBeforeCreateTopicParams {
945
999
  export interface OnGroupAfterCreateTopicParams {
946
1000
  group: CmsGroup;
947
1001
  }
1002
+ /**
1003
+ * @category CmsGroup
1004
+ * @category Topic
1005
+ */
1006
+ export interface OnGroupCreateErrorTopicParams {
1007
+ input: CmsGroupCreateInput;
1008
+ group: CmsGroup;
1009
+ error: Error;
1010
+ }
948
1011
  /**
949
1012
  * @category CmsGroup
950
1013
  * @category Topic
@@ -961,6 +1024,16 @@ export interface OnGroupAfterUpdateTopicParams {
961
1024
  original: CmsGroup;
962
1025
  group: CmsGroup;
963
1026
  }
1027
+ /**
1028
+ * @category CmsGroup
1029
+ * @category Topic
1030
+ */
1031
+ export interface OnGroupUpdateErrorTopicParams {
1032
+ input: CmsGroupUpdateInput;
1033
+ original: CmsGroup;
1034
+ group: CmsGroup;
1035
+ error: Error;
1036
+ }
964
1037
  /**
965
1038
  * @category CmsGroup
966
1039
  * @category Topic
@@ -975,6 +1048,14 @@ export interface OnGroupBeforeDeleteTopicParams {
975
1048
  export interface OnGroupAfterDeleteTopicParams {
976
1049
  group: CmsGroup;
977
1050
  }
1051
+ /**
1052
+ * @category CmsGroup
1053
+ * @category Topic
1054
+ */
1055
+ export interface OnGroupDeleteErrorTopicParams {
1056
+ group: CmsGroup;
1057
+ error: Error;
1058
+ }
978
1059
  /**
979
1060
  * Cms Group in context.
980
1061
  *
@@ -1038,10 +1119,13 @@ export interface CmsGroupContext {
1038
1119
  */
1039
1120
  onGroupBeforeCreate: Topic<OnGroupBeforeCreateTopicParams>;
1040
1121
  onGroupAfterCreate: Topic<OnGroupAfterCreateTopicParams>;
1122
+ onGroupCreateError: Topic<OnGroupCreateErrorTopicParams>;
1041
1123
  onGroupBeforeUpdate: Topic<OnGroupBeforeUpdateTopicParams>;
1042
1124
  onGroupAfterUpdate: Topic<OnGroupAfterUpdateTopicParams>;
1125
+ onGroupUpdateError: Topic<OnGroupUpdateErrorTopicParams>;
1043
1126
  onGroupBeforeDelete: Topic<OnGroupBeforeDeleteTopicParams>;
1044
1127
  onGroupAfterDelete: Topic<OnGroupAfterDeleteTopicParams>;
1128
+ onGroupDeleteError: Topic<OnGroupDeleteErrorTopicParams>;
1045
1129
  }
1046
1130
  /**
1047
1131
  * Definition for content model field validator.
@@ -1060,7 +1144,7 @@ export interface CmsModelFieldValidation {
1060
1144
  };
1061
1145
  }
1062
1146
  /**
1063
- * A GraphQL params.data parameter received when creating content model.
1147
+ * A GraphQL `params.data` parameter received when creating content model.
1064
1148
  *
1065
1149
  * @category GraphQL params
1066
1150
  * @category CmsModel
@@ -1097,6 +1181,10 @@ export interface CmsModelCreateInput {
1097
1181
  * ```
1098
1182
  */
1099
1183
  layout?: string[][];
1184
+ /**
1185
+ * Models can be tagged to give them contextual meaning.
1186
+ */
1187
+ tags?: string[];
1100
1188
  /**
1101
1189
  * The field that is being displayed as entry title.
1102
1190
  * It is picked as first available text field. Or user can select own field.
@@ -1104,7 +1192,7 @@ export interface CmsModelCreateInput {
1104
1192
  titleFieldId?: string;
1105
1193
  }
1106
1194
  /**
1107
- * A GraphQL params.data parameter received when creating content model from existing model.
1195
+ * A GraphQL `params.data` parameter received when creating content model from existing model.
1108
1196
  *
1109
1197
  * @category GraphQL params
1110
1198
  * @category CmsModel
@@ -1150,6 +1238,10 @@ export interface CmsModelFieldInput {
1150
1238
  * Text to display in the field.
1151
1239
  */
1152
1240
  placeholderText?: string;
1241
+ /**
1242
+ * Fields can be tagged to give them contextual meaning.
1243
+ */
1244
+ tags?: string[];
1153
1245
  /**
1154
1246
  * Are multiple values allowed?
1155
1247
  */
@@ -1176,7 +1268,7 @@ export interface CmsModelFieldInput {
1176
1268
  settings?: Record<string, any>;
1177
1269
  }
1178
1270
  /**
1179
- * A GraphQL params.data parameter received when updating content model.
1271
+ * A GraphQL `params.data` parameter received when updating content model.
1180
1272
  *
1181
1273
  * @category GraphQL params
1182
1274
  * @category CmsModel
@@ -1258,7 +1350,7 @@ export interface CmsEntryValues {
1258
1350
  export interface CmsEntry<T = CmsEntryValues> {
1259
1351
  /**
1260
1352
  * A version of the webiny this entry was created with.
1261
- * This can be used when upgrading the system so we know which entries to update.
1353
+ * This can be used when upgrading the system, so we know which entries to update.
1262
1354
  */
1263
1355
  webinyVersion: string;
1264
1356
  /**
@@ -1328,10 +1420,10 @@ export interface CmsEntry<T = CmsEntryValues> {
1328
1420
  /**
1329
1421
  * Settings for the given entry.
1330
1422
  *
1331
- * Introduced with Advanced Publishing Workflow - will be always inserted after this PR is merged.
1332
- * Be aware that when accessing properties in it on old systems - it will break if not checked first.
1423
+ * Introduced with Advanced Publishing Workflow. Will always be inserted once this PR is merged.
1424
+ * Be aware that when accessing properties in it on old systems, it will break if not checked first.
1333
1425
  *
1334
- * Available only on the Manage API in entry GraphQL type meta.data property.
1426
+ * Available only on the Manage API in entry GraphQL type `meta.data` property.
1335
1427
  */
1336
1428
  meta?: {
1337
1429
  [key: string]: any;
@@ -1364,7 +1456,7 @@ export interface CmsModelManager {
1364
1456
  */
1365
1457
  getPublishedByIds: (ids: string[]) => Promise<CmsEntry[]>;
1366
1458
  /**
1367
- * Get a list of latest entries by the ID list.
1459
+ * Get a list of the latest entries by the ID list.
1368
1460
  */
1369
1461
  getLatestByIds: (ids: string[]) => Promise<CmsEntry[]>;
1370
1462
  /**
@@ -1372,18 +1464,21 @@ export interface CmsModelManager {
1372
1464
  */
1373
1465
  get: (id: string) => Promise<CmsEntry>;
1374
1466
  /**
1375
- * Create a entry.
1467
+ * Create an entry.
1376
1468
  */
1377
1469
  create: (data: CreateCmsEntryInput) => Promise<CmsEntry>;
1378
1470
  /**
1379
- * Update a entry.
1471
+ * Update an entry.
1380
1472
  */
1381
1473
  update: (id: string, data: UpdateCmsEntryInput) => Promise<CmsEntry>;
1382
1474
  /**
1383
- * Delete a entry.
1475
+ * Delete an entry.
1384
1476
  */
1385
1477
  delete: (id: string) => Promise<void>;
1386
1478
  }
1479
+ /**
1480
+ * Create
1481
+ */
1387
1482
  export interface OnModelBeforeCreateTopicParams {
1388
1483
  input: CmsModelCreateInput;
1389
1484
  model: CmsModel;
@@ -1392,6 +1487,14 @@ export interface OnModelAfterCreateTopicParams {
1392
1487
  input: CmsModelCreateInput;
1393
1488
  model: CmsModel;
1394
1489
  }
1490
+ export interface OnModelCreateErrorTopicParams {
1491
+ input: CmsModelCreateInput;
1492
+ model: CmsModel;
1493
+ error: Error;
1494
+ }
1495
+ /**
1496
+ * Create From / Clone
1497
+ */
1395
1498
  export interface OnModelBeforeCreateFromTopicParams {
1396
1499
  input: CmsModelCreateInput;
1397
1500
  original: CmsModel;
@@ -1402,6 +1505,15 @@ export interface OnModelAfterCreateFromTopicParams {
1402
1505
  original: CmsModel;
1403
1506
  model: CmsModel;
1404
1507
  }
1508
+ export interface OnModelCreateFromErrorParams {
1509
+ input: CmsModelCreateInput;
1510
+ original: CmsModel;
1511
+ model: CmsModel;
1512
+ error: Error;
1513
+ }
1514
+ /**
1515
+ * Update
1516
+ */
1405
1517
  export interface OnModelBeforeUpdateTopicParams {
1406
1518
  input: CmsModelUpdateInput;
1407
1519
  original: CmsModel;
@@ -1412,15 +1524,35 @@ export interface OnModelAfterUpdateTopicParams {
1412
1524
  original: CmsModel;
1413
1525
  model: CmsModel;
1414
1526
  }
1527
+ export interface OnModelUpdateErrorTopicParams {
1528
+ input: CmsModelUpdateInput;
1529
+ original: CmsModel;
1530
+ model: CmsModel;
1531
+ error: Error;
1532
+ }
1533
+ /**
1534
+ * Delete
1535
+ */
1415
1536
  export interface OnModelBeforeDeleteTopicParams {
1416
1537
  model: CmsModel;
1417
1538
  }
1418
1539
  export interface OnModelAfterDeleteTopicParams {
1419
1540
  model: CmsModel;
1420
1541
  }
1542
+ export interface OnModelDeleteErrorTopicParams {
1543
+ model: CmsModel;
1544
+ error: Error;
1545
+ }
1546
+ /**
1547
+ * Initialize
1548
+ */
1421
1549
  export interface OnModelInitializeParams {
1422
1550
  model: CmsModel;
1551
+ data: Record<string, any>;
1423
1552
  }
1553
+ /**
1554
+ *
1555
+ */
1424
1556
  export interface CmsModelUpdateDirectParams {
1425
1557
  model: CmsModel;
1426
1558
  original: CmsModel;
@@ -1467,9 +1599,9 @@ export interface CmsModelContext {
1467
1599
  *
1468
1600
  * Primary idea behind this is creating the index, for the code models, in the ES.
1469
1601
  */
1470
- initializeModel: (modelId: string) => Promise<boolean>;
1602
+ initializeModel: (modelId: string, data: Record<string, any>) => Promise<boolean>;
1471
1603
  /**
1472
- * Get a instance of CmsModelManager for given content modelId.
1604
+ * Get an instance of CmsModelManager for given content modelId.
1473
1605
  *
1474
1606
  * @see CmsModelManager
1475
1607
  *
@@ -1528,12 +1660,16 @@ export interface CmsModelContext {
1528
1660
  */
1529
1661
  onModelBeforeCreate: Topic<OnModelBeforeCreateTopicParams>;
1530
1662
  onModelAfterCreate: Topic<OnModelAfterCreateTopicParams>;
1663
+ onModelCreateError: Topic<OnModelCreateErrorTopicParams>;
1531
1664
  onModelBeforeCreateFrom: Topic<OnModelBeforeCreateFromTopicParams>;
1532
1665
  onModelAfterCreateFrom: Topic<OnModelAfterCreateFromTopicParams>;
1666
+ onModelCreateFromError: Topic<OnModelCreateFromErrorParams>;
1533
1667
  onModelBeforeUpdate: Topic<OnModelBeforeUpdateTopicParams>;
1534
1668
  onModelAfterUpdate: Topic<OnModelAfterUpdateTopicParams>;
1669
+ onModelUpdateError: Topic<OnModelUpdateErrorTopicParams>;
1535
1670
  onModelBeforeDelete: Topic<OnModelBeforeDeleteTopicParams>;
1536
1671
  onModelAfterDelete: Topic<OnModelAfterDeleteTopicParams>;
1672
+ onModelDeleteError: Topic<OnModelDeleteErrorTopicParams>;
1537
1673
  onModelInitialize: Topic<OnModelInitializeParams>;
1538
1674
  }
1539
1675
  /**
@@ -1619,7 +1755,12 @@ export interface CmsEntryListWhere {
1619
1755
  /**
1620
1756
  * This is to allow querying by any content model field defined by the user.
1621
1757
  */
1622
- [key: string]: any | CmsEntryListWhereRef;
1758
+ [key: string]: string | number | boolean | undefined | string[] | number[] | null | CmsEntryListWhere[] | CmsEntryListWhere | CmsEntryListWhereRef;
1759
+ /**
1760
+ * To allow querying via nested queries, we added the AND / OR properties.
1761
+ */
1762
+ AND?: CmsEntryListWhere[];
1763
+ OR?: CmsEntryListWhere[];
1623
1764
  }
1624
1765
  /**
1625
1766
  * Entry listing sort.
@@ -1705,6 +1846,7 @@ export interface OnEntryRevisionAfterCreateTopicParams {
1705
1846
  export interface OnEntryCreateRevisionErrorTopicParams {
1706
1847
  error: Error;
1707
1848
  input: CreateFromCmsEntryInput;
1849
+ original: CmsEntry;
1708
1850
  entry: CmsEntry;
1709
1851
  model: CmsModel;
1710
1852
  }
@@ -1834,7 +1976,7 @@ export interface CmsEntryContext {
1834
1976
  */
1835
1977
  listEntries: (model: CmsModel, params: CmsEntryListParams) => Promise<[CmsEntry[], CmsEntryMeta]>;
1836
1978
  /**
1837
- * Lists latest entries. Used for manage API.
1979
+ * Lists the latest entries. Used for manage API.
1838
1980
  */
1839
1981
  listLatestEntries: (model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry[], CmsEntryMeta]>;
1840
1982
  /**
@@ -2022,13 +2164,13 @@ export interface BaseCmsSecurityPermission extends SecurityPermission {
2022
2164
  */
2023
2165
  export interface CmsModelPermission extends BaseCmsSecurityPermission {
2024
2166
  /**
2025
- * A object representing `key: model.modelId` values where key is locale code.
2167
+ * An object representing `key: model.modelId` values where key is locale code.
2026
2168
  */
2027
2169
  models?: {
2028
2170
  [key: string]: string[];
2029
2171
  };
2030
2172
  /**
2031
- * A object representing `key: group.id` values where key is locale code.
2173
+ * {locale: groupId[]} map, where key is a locale code.
2032
2174
  */
2033
2175
  groups?: {
2034
2176
  [key: string]: string[];
@@ -2042,7 +2184,7 @@ export interface CmsModelPermission extends BaseCmsSecurityPermission {
2042
2184
  */
2043
2185
  export interface CmsGroupPermission extends BaseCmsSecurityPermission {
2044
2186
  /**
2045
- * A object representing `key: group.id` values where key is locale code.
2187
+ * {locale: groupId[]} map, where key is a locale code.
2046
2188
  */
2047
2189
  groups?: {
2048
2190
  [key: string]: string[];
@@ -2057,13 +2199,13 @@ export interface CmsGroupPermission extends BaseCmsSecurityPermission {
2057
2199
  export interface CmsEntryPermission extends BaseCmsSecurityPermission {
2058
2200
  pw?: string;
2059
2201
  /**
2060
- * A object representing `key: model.modelId` values where key is locale code.
2202
+ * An object representing `key: model.modelId` values where key is locale code.
2061
2203
  */
2062
2204
  models?: {
2063
2205
  [key: string]: string[];
2064
2206
  };
2065
2207
  /**
2066
- * A object representing `key: group.id` values where key is locale code.
2208
+ * {locale: groupId[]} map, where key is a locale code.
2067
2209
  */
2068
2210
  groups?: {
2069
2211
  [key: string]: string[];
@@ -2439,6 +2581,7 @@ export interface CmsSystemStorageOperations {
2439
2581
  update: (params: CmsSystemStorageOperationsUpdateParams) => Promise<CmsSystem>;
2440
2582
  }
2441
2583
  export interface HeadlessCmsStorageOperations<C = CmsContext> {
2584
+ name: string;
2442
2585
  system: CmsSystemStorageOperations;
2443
2586
  settings: CmsSettingsStorageOperations;
2444
2587
  groups: CmsGroupStorageOperations;