@webiny/api-headless-cms 0.0.0-unstable.8c4d9f045a → 0.0.0-unstable.d4f203fa97

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 (134) hide show
  1. package/context.js +3 -7
  2. package/context.js.map +1 -1
  3. package/crud/contentEntry/afterDelete.d.ts +2 -2
  4. package/crud/contentEntry/afterDelete.js +2 -2
  5. package/crud/contentEntry/afterDelete.js.map +1 -1
  6. package/crud/contentEntry/beforeCreate.d.ts +2 -2
  7. package/crud/contentEntry/beforeCreate.js +2 -2
  8. package/crud/contentEntry/beforeCreate.js.map +1 -1
  9. package/crud/contentEntry/beforeUpdate.d.ts +2 -2
  10. package/crud/contentEntry/beforeUpdate.js +2 -2
  11. package/crud/contentEntry/beforeUpdate.js.map +1 -1
  12. package/crud/contentEntry/entryDataValidation.js +3 -7
  13. package/crud/contentEntry/entryDataValidation.js.map +1 -1
  14. package/crud/contentEntry/markLockedFields.js +6 -10
  15. package/crud/contentEntry/markLockedFields.js.map +1 -1
  16. package/crud/contentEntry/referenceFieldsMapping.js +3 -9
  17. package/crud/contentEntry/referenceFieldsMapping.js.map +1 -1
  18. package/crud/contentEntry.crud.d.ts +0 -2
  19. package/crud/contentEntry.crud.js +199 -241
  20. package/crud/contentEntry.crud.js.map +1 -1
  21. package/crud/contentModel/afterCreate.d.ts +3 -3
  22. package/crud/contentModel/afterCreate.js +5 -5
  23. package/crud/contentModel/afterCreate.js.map +1 -1
  24. package/crud/contentModel/afterCreateFrom.d.ts +3 -3
  25. package/crud/contentModel/afterCreateFrom.js +5 -5
  26. package/crud/contentModel/afterCreateFrom.js.map +1 -1
  27. package/crud/contentModel/afterDelete.d.ts +3 -3
  28. package/crud/contentModel/afterDelete.js +5 -5
  29. package/crud/contentModel/afterDelete.js.map +1 -1
  30. package/crud/contentModel/afterUpdate.d.ts +3 -3
  31. package/crud/contentModel/afterUpdate.js +5 -5
  32. package/crud/contentModel/afterUpdate.js.map +1 -1
  33. package/crud/contentModel/beforeCreate.d.ts +4 -4
  34. package/crud/contentModel/beforeCreate.js +10 -10
  35. package/crud/contentModel/beforeCreate.js.map +1 -1
  36. package/crud/contentModel/beforeDelete.d.ts +3 -3
  37. package/crud/contentModel/beforeDelete.js +6 -6
  38. package/crud/contentModel/beforeDelete.js.map +1 -1
  39. package/crud/contentModel/beforeUpdate.d.ts +3 -3
  40. package/crud/contentModel/beforeUpdate.js +5 -5
  41. package/crud/contentModel/beforeUpdate.js.map +1 -1
  42. package/crud/contentModel/validateModel.js +1 -1
  43. package/crud/contentModel/validateModelFields.js +3 -7
  44. package/crud/contentModel/validateModelFields.js.map +1 -1
  45. package/crud/contentModel.crud.js +84 -60
  46. package/crud/contentModel.crud.js.map +1 -1
  47. package/crud/contentModelGroup/beforeCreate.d.ts +2 -2
  48. package/crud/contentModelGroup/beforeCreate.js +3 -3
  49. package/crud/contentModelGroup/beforeCreate.js.map +1 -1
  50. package/crud/contentModelGroup/beforeDelete.d.ts +2 -2
  51. package/crud/contentModelGroup/beforeDelete.js +3 -3
  52. package/crud/contentModelGroup/beforeDelete.js.map +1 -1
  53. package/crud/contentModelGroup/beforeUpdate.d.ts +2 -2
  54. package/crud/contentModelGroup/beforeUpdate.js +2 -2
  55. package/crud/contentModelGroup/beforeUpdate.js.map +1 -1
  56. package/crud/contentModelGroup.crud.js +58 -38
  57. package/crud/contentModelGroup.crud.js.map +1 -1
  58. package/crud/index.js +3 -7
  59. package/crud/index.js.map +1 -1
  60. package/crud/settings.crud.js +3 -8
  61. package/crud/settings.crud.js.map +1 -1
  62. package/crud/system.crud.js +63 -51
  63. package/crud/system.crud.js.map +1 -1
  64. package/fieldConverters/CmsModelDefaultFieldConverterPlugin.js +1 -1
  65. package/fieldConverters/CmsModelObjectFieldConverterPlugin.js +17 -19
  66. package/fieldConverters/CmsModelObjectFieldConverterPlugin.js.map +1 -1
  67. package/graphql/graphQLHandlerFactory.js +1 -1
  68. package/graphql/index.d.ts +1 -1
  69. package/graphql/schema/baseContentSchema.js +5 -9
  70. package/graphql/schema/baseContentSchema.js.map +1 -1
  71. package/graphql/schema/contentEntries.js +1 -1
  72. package/graphql/schema/contentModels.js +19 -0
  73. package/graphql/schema/contentModels.js.map +1 -1
  74. package/graphql/schema/createFieldResolvers.js +4 -10
  75. package/graphql/schema/createFieldResolvers.js.map +1 -1
  76. package/graphql/schema/createManageResolvers.js +4 -18
  77. package/graphql/schema/createManageResolvers.js.map +1 -1
  78. package/graphql/schema/createManageSDL.js +6 -8
  79. package/graphql/schema/createManageSDL.js.map +1 -1
  80. package/graphql/schema/createPreviewResolvers.js +3 -7
  81. package/graphql/schema/createPreviewResolvers.js.map +1 -1
  82. package/graphql/schema/createReadResolvers.js +3 -7
  83. package/graphql/schema/createReadResolvers.js.map +1 -1
  84. package/graphql/schema/resolvers/manage/resolveGet.js +5 -9
  85. package/graphql/schema/resolvers/manage/resolveGet.js.map +1 -1
  86. package/graphql/schema/resolvers/preview/resolveGet.js +3 -7
  87. package/graphql/schema/resolvers/preview/resolveGet.js.map +1 -1
  88. package/graphql/schema/resolvers/read/resolveGet.js +3 -7
  89. package/graphql/schema/resolvers/read/resolveGet.js.map +1 -1
  90. package/graphqlFields/number.js +4 -0
  91. package/graphqlFields/number.js.map +1 -1
  92. package/graphqlFields/object.js +1 -1
  93. package/graphqlFields/ref.js +4 -8
  94. package/graphqlFields/ref.js.map +1 -1
  95. package/index.d.ts +1 -1
  96. package/modelManager/DefaultCmsModelManager.d.ts +7 -7
  97. package/modelManager/DefaultCmsModelManager.js +1 -1
  98. package/package.json +27 -28
  99. package/parameters/header.js +1 -1
  100. package/parameters/manual.js +7 -8
  101. package/parameters/manual.js.map +1 -1
  102. package/parameters/path.js +1 -1
  103. package/plugins/CmsGroupPlugin.js +1 -1
  104. package/plugins/CmsModelFieldConverterPlugin.js +1 -1
  105. package/plugins/CmsModelPlugin.d.ts +6 -2
  106. package/plugins/CmsModelPlugin.js +18 -13
  107. package/plugins/CmsModelPlugin.js.map +1 -1
  108. package/plugins/CmsParametersPlugin.js +1 -1
  109. package/plugins/StorageTransformPlugin.js +1 -1
  110. package/storage/object.js +3 -7
  111. package/storage/object.js.map +1 -1
  112. package/types.d.ts +274 -127
  113. package/types.js +0 -2
  114. package/types.js.map +1 -1
  115. package/upgrades/5.33.0/index.js +5 -9
  116. package/upgrades/5.33.0/index.js.map +1 -1
  117. package/utils/converters/Converter.js +1 -1
  118. package/utils/converters/ConverterCollection.d.ts +7 -0
  119. package/utils/converters/ConverterCollection.js +31 -7
  120. package/utils/converters/ConverterCollection.js.map +1 -1
  121. package/utils/converters/valueKeyStorageConverter.js +3 -7
  122. package/utils/converters/valueKeyStorageConverter.js.map +1 -1
  123. package/utils/createTypeName.js +1 -1
  124. package/utils/entryStorage.js +3 -7
  125. package/utils/entryStorage.js.map +1 -1
  126. package/utils/filterModelFields.js +5 -9
  127. package/utils/filterModelFields.js.map +1 -1
  128. package/utils/permissions.js +1 -5
  129. package/utils/permissions.js.map +1 -1
  130. package/utils/pluralizedTypeName.js +1 -1
  131. package/utils/renderListFilterFields.js +7 -0
  132. package/utils/renderListFilterFields.js.map +1 -1
  133. package/utils/toSlug.js +1 -1
  134. package/validators/unique.js +1 -1
package/types.d.ts CHANGED
@@ -1,7 +1,6 @@
1
1
  import { Plugin } from "@webiny/plugins/types";
2
2
  import { I18NContext, I18NLocale } from "@webiny/api-i18n/types";
3
3
  import { Context } from "@webiny/api/types";
4
- import { TenancyContext } from "@webiny/api-tenancy/types";
5
4
  import { GraphQLFieldResolver, GraphQLSchemaDefinition, Resolvers } from "@webiny/handler-graphql/types";
6
5
  import { SecurityPermission } from "@webiny/api-security/types";
7
6
  import { DbContext } from "@webiny/handler-db/types";
@@ -45,7 +44,7 @@ export interface HeadlessCms extends CmsSettingsContext, CmsSystemContext, CmsGr
45
44
  *
46
45
  * @category Context
47
46
  */
48
- export interface CmsContext extends Context, DbContext, I18NContext, FileManagerContext, TenancyContext {
47
+ export interface CmsContext extends Context, DbContext, I18NContext, FileManagerContext {
49
48
  cms: HeadlessCms;
50
49
  }
51
50
  interface CmsModelFieldPredefinedValuesValue {
@@ -800,11 +799,16 @@ export interface CmsSettingsContext {
800
799
  */
801
800
  getModelLastChange: () => Promise<Date>;
802
801
  }
803
- export interface BeforeInstallTopicParams {
802
+ export interface OnSystemBeforeInstallTopicParams {
804
803
  tenant: string;
805
804
  locale: string;
806
805
  }
807
- export interface AfterInstallTopicParams {
806
+ export interface OnSystemAfterInstallTopicParams {
807
+ tenant: string;
808
+ locale: string;
809
+ }
810
+ export interface OnSystemInstallErrorTopicParams {
811
+ error: Error;
808
812
  tenant: string;
809
813
  locale: string;
810
814
  }
@@ -815,10 +819,22 @@ export declare type CmsSystemContext = {
815
819
  installSystem: () => Promise<void>;
816
820
  upgradeSystem: (version: string) => Promise<boolean>;
817
821
  /**
818
- * Events
822
+ * Lifecycle events - deprecated
823
+ */
824
+ /**
825
+ * @deprecated
826
+ */
827
+ onBeforeSystemInstall: Topic<OnSystemBeforeInstallTopicParams>;
828
+ /**
829
+ * @deprecated
819
830
  */
820
- onBeforeSystemInstall: Topic<BeforeInstallTopicParams>;
821
- onAfterSystemInstall: Topic<AfterInstallTopicParams>;
831
+ onAfterSystemInstall: Topic<OnSystemAfterInstallTopicParams>;
832
+ /**
833
+ * Released in 5.34.0
834
+ */
835
+ onSystemBeforeInstall: Topic<OnSystemBeforeInstallTopicParams>;
836
+ onSystemAfterInstall: Topic<OnSystemAfterInstallTopicParams>;
837
+ onSystemInstallError: Topic<OnSystemInstallErrorTopicParams>;
822
838
  };
823
839
  /**
824
840
  * A GraphQL params.data parameter received when creating content model group.
@@ -919,21 +935,21 @@ export interface CmsGroupListParams {
919
935
  * @category CmsGroup
920
936
  * @category Topic
921
937
  */
922
- export interface BeforeGroupCreateTopicParams {
938
+ export interface OnGroupBeforeCreateTopicParams {
923
939
  group: CmsGroup;
924
940
  }
925
941
  /**
926
942
  * @category CmsGroup
927
943
  * @category Topic
928
944
  */
929
- export interface AfterGroupCreateTopicParams {
945
+ export interface OnGroupAfterCreateTopicParams {
930
946
  group: CmsGroup;
931
947
  }
932
948
  /**
933
949
  * @category CmsGroup
934
950
  * @category Topic
935
951
  */
936
- export interface BeforeGroupUpdateTopicParams {
952
+ export interface OnGroupBeforeUpdateTopicParams {
937
953
  original: CmsGroup;
938
954
  group: CmsGroup;
939
955
  }
@@ -941,7 +957,7 @@ export interface BeforeGroupUpdateTopicParams {
941
957
  * @category CmsGroup
942
958
  * @category Topic
943
959
  */
944
- export interface AfterGroupUpdateTopicParams {
960
+ export interface OnGroupAfterUpdateTopicParams {
945
961
  original: CmsGroup;
946
962
  group: CmsGroup;
947
963
  }
@@ -949,14 +965,14 @@ export interface AfterGroupUpdateTopicParams {
949
965
  * @category CmsGroup
950
966
  * @category Topic
951
967
  */
952
- export interface BeforeGroupDeleteTopicParams {
968
+ export interface OnGroupBeforeDeleteTopicParams {
953
969
  group: CmsGroup;
954
970
  }
955
971
  /**
956
972
  * @category CmsGroup
957
973
  * @category Topic
958
974
  */
959
- export interface AfterGroupDeleteTopicParams {
975
+ export interface OnGroupAfterDeleteTopicParams {
960
976
  group: CmsGroup;
961
977
  }
962
978
  /**
@@ -991,14 +1007,41 @@ export interface CmsGroupContext {
991
1007
  */
992
1008
  clearGroupsCache: () => void;
993
1009
  /**
994
- * Events.
1010
+ * Lifecycle events - deprecated
1011
+ */
1012
+ /**
1013
+ * @deprecated
1014
+ */
1015
+ onBeforeGroupCreate: Topic<OnGroupBeforeCreateTopicParams>;
1016
+ /**
1017
+ * @deprecated
1018
+ */
1019
+ onAfterGroupCreate: Topic<OnGroupAfterCreateTopicParams>;
1020
+ /**
1021
+ * @deprecated
995
1022
  */
996
- onBeforeGroupCreate: Topic<BeforeGroupCreateTopicParams>;
997
- onAfterGroupCreate: Topic<AfterGroupCreateTopicParams>;
998
- onBeforeGroupUpdate: Topic<BeforeGroupUpdateTopicParams>;
999
- onAfterGroupUpdate: Topic<AfterGroupUpdateTopicParams>;
1000
- onBeforeGroupDelete: Topic<BeforeGroupDeleteTopicParams>;
1001
- onAfterGroupDelete: Topic<AfterGroupDeleteTopicParams>;
1023
+ onBeforeGroupUpdate: Topic<OnGroupBeforeUpdateTopicParams>;
1024
+ /**
1025
+ * @deprecated
1026
+ */
1027
+ onAfterGroupUpdate: Topic<OnGroupAfterUpdateTopicParams>;
1028
+ /**
1029
+ * @deprecated
1030
+ */
1031
+ onBeforeGroupDelete: Topic<OnGroupBeforeDeleteTopicParams>;
1032
+ /**
1033
+ * @deprecated
1034
+ */
1035
+ onAfterGroupDelete: Topic<OnGroupAfterDeleteTopicParams>;
1036
+ /**
1037
+ * Lifecycle events released in 5.33.0
1038
+ */
1039
+ onGroupBeforeCreate: Topic<OnGroupBeforeCreateTopicParams>;
1040
+ onGroupAfterCreate: Topic<OnGroupAfterCreateTopicParams>;
1041
+ onGroupBeforeUpdate: Topic<OnGroupBeforeUpdateTopicParams>;
1042
+ onGroupAfterUpdate: Topic<OnGroupAfterUpdateTopicParams>;
1043
+ onGroupBeforeDelete: Topic<OnGroupBeforeDeleteTopicParams>;
1044
+ onGroupAfterDelete: Topic<OnGroupAfterDeleteTopicParams>;
1002
1045
  }
1003
1046
  /**
1004
1047
  * Definition for content model field validator.
@@ -1212,7 +1255,7 @@ export interface CmsEntryValues {
1212
1255
  * @category Database model
1213
1256
  * @category CmsEntry
1214
1257
  */
1215
- export interface CmsEntry {
1258
+ export interface CmsEntry<T = CmsEntryValues> {
1216
1259
  /**
1217
1260
  * A version of the webiny this entry was created with.
1218
1261
  * This can be used when upgrading the system so we know which entries to update.
@@ -1281,7 +1324,7 @@ export interface CmsEntry {
1281
1324
  *
1282
1325
  * @see CmsModelField
1283
1326
  */
1284
- values: CmsEntryValues;
1327
+ values: T;
1285
1328
  /**
1286
1329
  * Settings for the given entry.
1287
1330
  *
@@ -1341,38 +1384,41 @@ export interface CmsModelManager {
1341
1384
  */
1342
1385
  delete: (id: string) => Promise<void>;
1343
1386
  }
1344
- export interface BeforeModelCreateTopicParams {
1387
+ export interface OnModelBeforeCreateTopicParams {
1345
1388
  input: CmsModelCreateInput;
1346
1389
  model: CmsModel;
1347
1390
  }
1348
- export interface AfterModelCreateTopicParams {
1391
+ export interface OnModelAfterCreateTopicParams {
1349
1392
  input: CmsModelCreateInput;
1350
1393
  model: CmsModel;
1351
1394
  }
1352
- export interface BeforeModelCreateFromTopicParams {
1395
+ export interface OnModelBeforeCreateFromTopicParams {
1353
1396
  input: CmsModelCreateInput;
1354
1397
  original: CmsModel;
1355
1398
  model: CmsModel;
1356
1399
  }
1357
- export interface AfterModelCreateFromTopicParams {
1400
+ export interface OnModelAfterCreateFromTopicParams {
1358
1401
  input: CmsModelCreateInput;
1359
1402
  original: CmsModel;
1360
1403
  model: CmsModel;
1361
1404
  }
1362
- export interface BeforeModelUpdateTopicParams {
1405
+ export interface OnModelBeforeUpdateTopicParams {
1363
1406
  input: CmsModelUpdateInput;
1364
1407
  original: CmsModel;
1365
1408
  model: CmsModel;
1366
1409
  }
1367
- export interface AfterModelUpdateTopicParams {
1410
+ export interface OnModelAfterUpdateTopicParams {
1368
1411
  input: CmsModelUpdateInput;
1369
1412
  original: CmsModel;
1370
1413
  model: CmsModel;
1371
1414
  }
1372
- export interface BeforeModelDeleteTopicParams {
1415
+ export interface OnModelBeforeDeleteTopicParams {
1373
1416
  model: CmsModel;
1374
1417
  }
1375
- export interface AfterModelDeleteTopicParams {
1418
+ export interface OnModelAfterDeleteTopicParams {
1419
+ model: CmsModel;
1420
+ }
1421
+ export interface OnModelInitializeParams {
1376
1422
  model: CmsModel;
1377
1423
  }
1378
1424
  export interface CmsModelUpdateDirectParams {
@@ -1415,6 +1461,13 @@ export interface CmsModelContext {
1415
1461
  * Delete content model. Should not allow deletion if there are entries connected to it.
1416
1462
  */
1417
1463
  deleteModel: (modelId: string) => Promise<void>;
1464
+ /**
1465
+ * Possibility for users to trigger the model initialization.
1466
+ * They can hook into it and do what ever they want to.
1467
+ *
1468
+ * Primary idea behind this is creating the index, for the code models, in the ES.
1469
+ */
1470
+ initializeModel: (modelId: string) => Promise<boolean>;
1418
1471
  /**
1419
1472
  * Get a instance of CmsModelManager for given content modelId.
1420
1473
  *
@@ -1436,23 +1489,59 @@ export interface CmsModelContext {
1436
1489
  */
1437
1490
  clearModelsCache: () => void;
1438
1491
  /**
1439
- * Events.
1492
+ * Lifecycle events - deprecated.
1493
+ */
1494
+ /**
1495
+ * @deprecated
1440
1496
  */
1441
- onBeforeModelCreate: Topic<BeforeModelCreateTopicParams>;
1442
- onAfterModelCreate: Topic<AfterModelCreateTopicParams>;
1443
- onBeforeModelCreateFrom: Topic<BeforeModelCreateFromTopicParams>;
1444
- onAfterModelCreateFrom: Topic<AfterModelCreateFromTopicParams>;
1445
- onBeforeModelUpdate: Topic<BeforeModelUpdateTopicParams>;
1446
- onAfterModelUpdate: Topic<AfterModelUpdateTopicParams>;
1447
- onBeforeModelDelete: Topic<BeforeModelDeleteTopicParams>;
1448
- onAfterModelDelete: Topic<AfterModelDeleteTopicParams>;
1497
+ onBeforeModelCreate: Topic<OnModelBeforeCreateTopicParams>;
1498
+ /**
1499
+ * @deprecated
1500
+ */
1501
+ onAfterModelCreate: Topic<OnModelAfterCreateTopicParams>;
1502
+ /**
1503
+ * @deprecated
1504
+ */
1505
+ onBeforeModelCreateFrom: Topic<OnModelBeforeCreateFromTopicParams>;
1506
+ /**
1507
+ * @deprecated
1508
+ */
1509
+ onAfterModelCreateFrom: Topic<OnModelAfterCreateFromTopicParams>;
1510
+ /**
1511
+ * @deprecated
1512
+ */
1513
+ onBeforeModelUpdate: Topic<OnModelBeforeUpdateTopicParams>;
1514
+ /**
1515
+ * @deprecated
1516
+ */
1517
+ onAfterModelUpdate: Topic<OnModelAfterUpdateTopicParams>;
1518
+ /**
1519
+ * @deprecated
1520
+ */
1521
+ onBeforeModelDelete: Topic<OnModelBeforeDeleteTopicParams>;
1522
+ /**
1523
+ * @deprecated
1524
+ */
1525
+ onAfterModelDelete: Topic<OnModelAfterDeleteTopicParams>;
1526
+ /**
1527
+ * Lifecycle events - released in 5.33.0
1528
+ */
1529
+ onModelBeforeCreate: Topic<OnModelBeforeCreateTopicParams>;
1530
+ onModelAfterCreate: Topic<OnModelAfterCreateTopicParams>;
1531
+ onModelBeforeCreateFrom: Topic<OnModelBeforeCreateFromTopicParams>;
1532
+ onModelAfterCreateFrom: Topic<OnModelAfterCreateFromTopicParams>;
1533
+ onModelBeforeUpdate: Topic<OnModelBeforeUpdateTopicParams>;
1534
+ onModelAfterUpdate: Topic<OnModelAfterUpdateTopicParams>;
1535
+ onModelBeforeDelete: Topic<OnModelBeforeDeleteTopicParams>;
1536
+ onModelAfterDelete: Topic<OnModelAfterDeleteTopicParams>;
1537
+ onModelInitialize: Topic<OnModelInitializeParams>;
1449
1538
  }
1450
1539
  /**
1451
1540
  * Available statuses for content entry.
1452
1541
  *
1453
1542
  * @category CmsEntry
1454
1543
  */
1455
- export declare type CmsEntryStatus = "published" | "unpublished" | "reviewRequested" | "changesRequested" | "draft";
1544
+ export declare type CmsEntryStatus = "published" | "unpublished" | "draft";
1456
1545
  export interface CmsEntryListWhereRef {
1457
1546
  id?: string;
1458
1547
  id_in?: string[];
@@ -1530,7 +1619,12 @@ export interface CmsEntryListWhere {
1530
1619
  /**
1531
1620
  * This is to allow querying by any content model field defined by the user.
1532
1621
  */
1533
- [key: string]: any | CmsEntryListWhereRef;
1622
+ [key: string]: string | number | boolean | undefined | string[] | number[] | null | CmsEntryListWhere[] | CmsEntryListWhereRef;
1623
+ /**
1624
+ * To allow querying via nested queries, we added the AND / OR properties.
1625
+ */
1626
+ AND?: CmsEntryListWhere[];
1627
+ OR?: CmsEntryListWhere[];
1534
1628
  }
1535
1629
  /**
1536
1630
  * Entry listing sort.
@@ -1583,100 +1677,120 @@ export interface CmsEntryMeta {
1583
1677
  */
1584
1678
  totalCount: number;
1585
1679
  }
1586
- export interface BeforeEntryCreateTopicParams {
1680
+ export interface OnEntryBeforeCreateTopicParams {
1587
1681
  input: CreateCmsEntryInput;
1588
1682
  entry: CmsEntry;
1589
1683
  model: StorageOperationsCmsModel;
1590
1684
  }
1591
- export interface AfterEntryCreateTopicParams {
1685
+ export interface OnEntryAfterCreateTopicParams {
1592
1686
  input: CreateCmsEntryInput;
1593
1687
  entry: CmsEntry;
1594
1688
  model: StorageOperationsCmsModel;
1595
1689
  storageEntry: CmsEntry;
1596
1690
  }
1597
- export interface BeforeEntryCreateRevisionTopicParams {
1691
+ export interface OnEntryCreateErrorTopicParams {
1692
+ error: Error;
1693
+ input: CreateCmsEntryInput;
1694
+ entry: CmsEntry;
1695
+ model: CmsModel;
1696
+ }
1697
+ export interface OnEntryRevisionBeforeCreateTopicParams {
1598
1698
  input: CreateFromCmsEntryInput;
1599
1699
  entry: CmsEntry;
1600
1700
  original: CmsEntry;
1601
1701
  model: StorageOperationsCmsModel;
1602
1702
  }
1603
- export interface AfterEntryCreateRevisionTopicParams {
1703
+ export interface OnEntryRevisionAfterCreateTopicParams {
1604
1704
  input: CreateFromCmsEntryInput;
1605
1705
  entry: CmsEntry;
1606
1706
  original: CmsEntry;
1607
1707
  model: StorageOperationsCmsModel;
1608
1708
  storageEntry: CmsEntry;
1609
1709
  }
1610
- export interface BeforeEntryUpdateTopicParams {
1710
+ export interface OnEntryCreateRevisionErrorTopicParams {
1711
+ error: Error;
1712
+ input: CreateFromCmsEntryInput;
1713
+ entry: CmsEntry;
1714
+ model: CmsModel;
1715
+ }
1716
+ export interface OnEntryBeforeUpdateTopicParams {
1611
1717
  input: UpdateCmsEntryInput;
1612
1718
  original: CmsEntry;
1613
1719
  entry: CmsEntry;
1614
1720
  model: StorageOperationsCmsModel;
1615
1721
  }
1616
- export interface AfterEntryUpdateTopicParams {
1722
+ export interface OnEntryAfterUpdateTopicParams {
1617
1723
  input: UpdateCmsEntryInput;
1618
1724
  original: CmsEntry;
1619
1725
  entry: CmsEntry;
1620
1726
  model: StorageOperationsCmsModel;
1621
1727
  storageEntry: CmsEntry;
1622
1728
  }
1623
- export interface BeforeEntryPublishTopicParams {
1729
+ export interface OnEntryUpdateErrorTopicParams {
1730
+ error: Error;
1731
+ input: CreateFromCmsEntryInput;
1624
1732
  entry: CmsEntry;
1625
- model: StorageOperationsCmsModel;
1733
+ model: CmsModel;
1626
1734
  }
1627
- export interface AfterEntryPublishTopicParams {
1735
+ export interface OnEntryBeforePublishTopicParams {
1628
1736
  entry: CmsEntry;
1629
1737
  model: StorageOperationsCmsModel;
1630
- storageEntry: CmsEntry;
1631
1738
  }
1632
- export interface BeforeEntryUnpublishTopicParams {
1739
+ export interface OnEntryAfterPublishTopicParams {
1633
1740
  entry: CmsEntry;
1634
1741
  model: StorageOperationsCmsModel;
1742
+ storageEntry: CmsEntry;
1635
1743
  }
1636
- export interface AfterEntryUnpublishTopicParams {
1744
+ export interface OnEntryPublishErrorTopicParams {
1745
+ error: Error;
1637
1746
  entry: CmsEntry;
1638
1747
  model: StorageOperationsCmsModel;
1639
- storageEntry: CmsEntry;
1640
1748
  }
1641
- export interface BeforeEntryRequestChangesTopicParams {
1749
+ export interface OnEntryBeforeUnpublishTopicParams {
1642
1750
  entry: CmsEntry;
1643
1751
  model: StorageOperationsCmsModel;
1644
1752
  }
1645
- export interface AfterEntryRequestChangesTopicParams {
1753
+ export interface OnEntryAfterUnpublishTopicParams {
1646
1754
  entry: CmsEntry;
1647
1755
  model: StorageOperationsCmsModel;
1648
1756
  storageEntry: CmsEntry;
1649
1757
  }
1650
- export interface BeforeEntryRequestReviewTopicParams {
1758
+ export interface OnEntryUnpublishErrorTopicParams {
1759
+ error: Error;
1760
+ entry: CmsEntry;
1761
+ model: CmsModel;
1762
+ }
1763
+ export interface OnEntryBeforeDeleteTopicParams {
1651
1764
  entry: CmsEntry;
1652
1765
  model: StorageOperationsCmsModel;
1653
1766
  }
1654
- export interface AfterEntryRequestReviewTopicParams {
1767
+ export interface OnEntryAfterDeleteTopicParams {
1655
1768
  entry: CmsEntry;
1656
1769
  model: StorageOperationsCmsModel;
1657
- storageEntry: CmsEntry;
1658
1770
  }
1659
- export interface BeforeEntryDeleteTopicParams {
1771
+ export interface OnEntryDeleteErrorTopicParams {
1772
+ error: Error;
1660
1773
  entry: CmsEntry;
1661
1774
  model: StorageOperationsCmsModel;
1662
1775
  }
1663
- export interface AfterEntryDeleteTopicParams {
1776
+ export interface OnEntryRevisionBeforeDeleteTopicParams {
1664
1777
  entry: CmsEntry;
1665
1778
  model: StorageOperationsCmsModel;
1666
1779
  }
1667
- export interface BeforeEntryDeleteRevisionTopicParams {
1780
+ export interface OnEntryRevisionAfterDeleteTopicParams {
1668
1781
  entry: CmsEntry;
1669
1782
  model: StorageOperationsCmsModel;
1670
1783
  }
1671
- export interface AfterEntryDeleteRevisionTopicParams {
1784
+ export interface OnEntryRevisionDeleteErrorTopicParams {
1785
+ error: Error;
1672
1786
  entry: CmsEntry;
1673
1787
  model: StorageOperationsCmsModel;
1674
1788
  }
1675
- export interface BeforeEntryGetTopicParams {
1789
+ export interface OnEntryBeforeGetTopicParams {
1676
1790
  model: StorageOperationsCmsModel;
1677
1791
  where: CmsEntryListWhere;
1678
1792
  }
1679
- export interface BeforeEntryListTopicParams {
1793
+ export interface EntryBeforeListTopicParams {
1680
1794
  where: CmsEntryListWhere;
1681
1795
  model: StorageOperationsCmsModel;
1682
1796
  }
@@ -1774,40 +1888,102 @@ export interface CmsEntryContext {
1774
1888
  */
1775
1889
  unpublishEntry: (model: CmsModel, id: string) => Promise<CmsEntry>;
1776
1890
  /**
1777
- * Request a review for the entry.
1891
+ * Get all entry revisions.
1778
1892
  */
1779
- requestEntryReview: (model: CmsModel, id: string) => Promise<CmsEntry>;
1893
+ getEntryRevisions: (model: CmsModel, id: string) => Promise<CmsEntry[]>;
1780
1894
  /**
1781
- * Request changes for the entry.
1895
+ * Lifecyle events - deprecated.
1782
1896
  */
1783
- requestEntryChanges: (model: CmsModel, id: string) => Promise<CmsEntry>;
1784
1897
  /**
1785
- * Get all entry revisions.
1898
+ * @deprecated
1786
1899
  */
1787
- getEntryRevisions: (model: CmsModel, id: string) => Promise<CmsEntry[]>;
1900
+ onBeforeEntryCreate: Topic<OnEntryBeforeCreateTopicParams>;
1901
+ /**
1902
+ * @deprecated
1903
+ */
1904
+ onAfterEntryCreate: Topic<OnEntryAfterCreateTopicParams>;
1905
+ /**
1906
+ * @deprecated
1907
+ */
1908
+ onBeforeEntryCreateRevision: Topic<OnEntryRevisionBeforeCreateTopicParams>;
1909
+ /**
1910
+ * @deprecated
1911
+ */
1912
+ onAfterEntryCreateRevision: Topic<OnEntryRevisionAfterCreateTopicParams>;
1913
+ /**
1914
+ * @deprecated
1915
+ */
1916
+ onBeforeEntryUpdate: Topic<OnEntryBeforeUpdateTopicParams>;
1917
+ /**
1918
+ * @deprecated
1919
+ */
1920
+ onAfterEntryUpdate: Topic<OnEntryAfterUpdateTopicParams>;
1921
+ /**
1922
+ * @deprecated
1923
+ */
1924
+ onBeforeEntryDelete: Topic<OnEntryBeforeDeleteTopicParams>;
1925
+ /**
1926
+ * @deprecated
1927
+ */
1928
+ onAfterEntryDelete: Topic<OnEntryAfterDeleteTopicParams>;
1929
+ /**
1930
+ * @deprecated
1931
+ */
1932
+ onBeforeEntryDeleteRevision: Topic<OnEntryRevisionBeforeDeleteTopicParams>;
1933
+ /**
1934
+ * @deprecated
1935
+ */
1936
+ onAfterEntryDeleteRevision: Topic<OnEntryRevisionAfterDeleteTopicParams>;
1937
+ /**
1938
+ * @deprecated
1939
+ */
1940
+ onBeforeEntryPublish: Topic<OnEntryBeforePublishTopicParams>;
1788
1941
  /**
1789
- * Events.
1790
- */
1791
- onBeforeEntryCreate: Topic<BeforeEntryCreateTopicParams>;
1792
- onAfterEntryCreate: Topic<AfterEntryCreateTopicParams>;
1793
- onBeforeEntryCreateRevision: Topic<BeforeEntryCreateRevisionTopicParams>;
1794
- onAfterEntryCreateRevision: Topic<AfterEntryCreateRevisionTopicParams>;
1795
- onBeforeEntryUpdate: Topic<BeforeEntryUpdateTopicParams>;
1796
- onAfterEntryUpdate: Topic<AfterEntryUpdateTopicParams>;
1797
- onBeforeEntryDelete: Topic<BeforeEntryDeleteTopicParams>;
1798
- onAfterEntryDelete: Topic<AfterEntryDeleteTopicParams>;
1799
- onBeforeEntryDeleteRevision: Topic<BeforeEntryDeleteRevisionTopicParams>;
1800
- onAfterEntryDeleteRevision: Topic<AfterEntryDeleteRevisionTopicParams>;
1801
- onBeforeEntryPublish: Topic<BeforeEntryPublishTopicParams>;
1802
- onAfterEntryPublish: Topic<AfterEntryPublishTopicParams>;
1803
- onBeforeEntryUnpublish: Topic<BeforeEntryUnpublishTopicParams>;
1804
- onAfterEntryUnpublish: Topic<AfterEntryUnpublishTopicParams>;
1805
- onBeforeEntryRequestChanges: Topic<BeforeEntryRequestChangesTopicParams>;
1806
- onAfterEntryRequestChanges: Topic<AfterEntryRequestChangesTopicParams>;
1807
- onBeforeEntryRequestReview: Topic<BeforeEntryRequestReviewTopicParams>;
1808
- onAfterEntryRequestReview: Topic<AfterEntryRequestReviewTopicParams>;
1809
- onBeforeEntryGet: Topic<BeforeEntryGetTopicParams>;
1810
- onBeforeEntryList: Topic<BeforeEntryListTopicParams>;
1942
+ * @deprecated
1943
+ */
1944
+ onAfterEntryPublish: Topic<OnEntryAfterPublishTopicParams>;
1945
+ /**
1946
+ * @deprecated
1947
+ */
1948
+ onBeforeEntryUnpublish: Topic<OnEntryBeforeUnpublishTopicParams>;
1949
+ /**
1950
+ * @deprecated
1951
+ */
1952
+ onAfterEntryUnpublish: Topic<OnEntryAfterUnpublishTopicParams>;
1953
+ /**
1954
+ * @deprecated
1955
+ */
1956
+ onBeforeEntryGet: Topic<OnEntryBeforeGetTopicParams>;
1957
+ /**
1958
+ * @deprecated
1959
+ */
1960
+ onBeforeEntryList: Topic<EntryBeforeListTopicParams>;
1961
+ /**
1962
+ * Lifecycle events released in 5.33.0
1963
+ */
1964
+ onEntryBeforeCreate: Topic<OnEntryBeforeCreateTopicParams>;
1965
+ onEntryAfterCreate: Topic<OnEntryAfterCreateTopicParams>;
1966
+ onEntryCreateError: Topic<OnEntryCreateErrorTopicParams>;
1967
+ onEntryRevisionBeforeCreate: Topic<OnEntryRevisionBeforeCreateTopicParams>;
1968
+ onEntryRevisionAfterCreate: Topic<OnEntryRevisionAfterCreateTopicParams>;
1969
+ onEntryRevisionCreateError: Topic<OnEntryCreateRevisionErrorTopicParams>;
1970
+ onEntryBeforeUpdate: Topic<OnEntryBeforeUpdateTopicParams>;
1971
+ onEntryAfterUpdate: Topic<OnEntryAfterUpdateTopicParams>;
1972
+ onEntryUpdateError: Topic<OnEntryUpdateErrorTopicParams>;
1973
+ onEntryBeforeDelete: Topic<OnEntryBeforeDeleteTopicParams>;
1974
+ onEntryAfterDelete: Topic<OnEntryAfterDeleteTopicParams>;
1975
+ onEntryDeleteError: Topic<OnEntryDeleteErrorTopicParams>;
1976
+ onEntryRevisionBeforeDelete: Topic<OnEntryRevisionBeforeDeleteTopicParams>;
1977
+ onEntryRevisionAfterDelete: Topic<OnEntryRevisionAfterDeleteTopicParams>;
1978
+ onEntryRevisionDeleteError: Topic<OnEntryRevisionDeleteErrorTopicParams>;
1979
+ onEntryBeforePublish: Topic<OnEntryBeforePublishTopicParams>;
1980
+ onEntryAfterPublish: Topic<OnEntryAfterPublishTopicParams>;
1981
+ onEntryPublishError: Topic<OnEntryPublishErrorTopicParams>;
1982
+ onEntryBeforeUnpublish: Topic<OnEntryBeforeUnpublishTopicParams>;
1983
+ onEntryAfterUnpublish: Topic<OnEntryAfterUnpublishTopicParams>;
1984
+ onEntryUnpublishError: Topic<OnEntryUnpublishErrorTopicParams>;
1985
+ onEntryBeforeGet: Topic<OnEntryBeforeGetTopicParams>;
1986
+ onEntryBeforeList: Topic<EntryBeforeListTopicParams>;
1811
1987
  }
1812
1988
  /**
1813
1989
  * Parameters for CmsEntryResolverFactory.
@@ -2085,26 +2261,6 @@ export interface CmsEntryStorageOperationsUnpublishParams<T extends CmsStorageEn
2085
2261
  */
2086
2262
  storageEntry: T;
2087
2263
  }
2088
- export interface CmsEntryStorageOperationsRequestChangesParams<T extends CmsStorageEntry = CmsStorageEntry> {
2089
- /**
2090
- * Entry data updated with the required properties.
2091
- */
2092
- entry: CmsEntry;
2093
- /**
2094
- * Entry that is prepared for the storageOperations, with the transformations.
2095
- */
2096
- storageEntry: T;
2097
- }
2098
- export interface CmsEntryStorageOperationsRequestReviewParams<T extends CmsStorageEntry = CmsStorageEntry> {
2099
- /**
2100
- * Entry that is prepared for the storageOperations.
2101
- */
2102
- entry: CmsEntry;
2103
- /**
2104
- * Entry that is prepared for the storageOperations, with the transformations.
2105
- */
2106
- storageEntry: T;
2107
- }
2108
2264
  export interface CmsEntryStorageOperationsGetByIdsParams {
2109
2265
  ids: readonly string[];
2110
2266
  }
@@ -2226,21 +2382,11 @@ export interface CmsEntryStorageOperations<T extends CmsStorageEntry = CmsStorag
2226
2382
  * Unpublish the entry.
2227
2383
  */
2228
2384
  unpublish: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsUnpublishParams<T>) => Promise<T>;
2229
- /**
2230
- * Request changes the entry.
2231
- */
2232
- requestChanges: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsRequestChangesParams<T>) => Promise<T>;
2233
- /**
2234
- * Request review the entry.
2235
- */
2236
- requestReview: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsRequestReviewParams<T>) => Promise<CmsEntry>;
2237
2385
  }
2238
2386
  export declare enum CONTENT_ENTRY_STATUS {
2239
2387
  DRAFT = "draft",
2240
2388
  PUBLISHED = "published",
2241
- UNPUBLISHED = "unpublished",
2242
- CHANGES_REQUESTED = "changesRequested",
2243
- REVIEW_REQUESTED = "reviewRequested"
2389
+ UNPUBLISHED = "unpublished"
2244
2390
  }
2245
2391
  export interface CmsSettingsStorageOperationsGetParams {
2246
2392
  locale: string;
@@ -2297,7 +2443,8 @@ export interface CmsSystemStorageOperations {
2297
2443
  */
2298
2444
  update: (params: CmsSystemStorageOperationsUpdateParams) => Promise<CmsSystem>;
2299
2445
  }
2300
- export interface HeadlessCmsStorageOperations {
2446
+ export interface HeadlessCmsStorageOperations<C = CmsContext> {
2447
+ name: string;
2301
2448
  system: CmsSystemStorageOperations;
2302
2449
  settings: CmsSettingsStorageOperations;
2303
2450
  groups: CmsGroupStorageOperations;
@@ -2306,8 +2453,8 @@ export interface HeadlessCmsStorageOperations {
2306
2453
  /**
2307
2454
  * Either attach something from the storage operations or run something in it.
2308
2455
  */
2309
- beforeInit?: (context: CmsContext) => Promise<void>;
2310
- init?: (context: CmsContext) => Promise<void>;
2456
+ beforeInit?: (context: C) => Promise<void>;
2457
+ init?: (context: C) => Promise<void>;
2311
2458
  /**
2312
2459
  * An upgrade to run if necessary.
2313
2460
  */
package/types.js CHANGED
@@ -413,6 +413,4 @@ exports.CONTENT_ENTRY_STATUS = CONTENT_ENTRY_STATUS;
413
413
  CONTENT_ENTRY_STATUS["DRAFT"] = "draft";
414
414
  CONTENT_ENTRY_STATUS["PUBLISHED"] = "published";
415
415
  CONTENT_ENTRY_STATUS["UNPUBLISHED"] = "unpublished";
416
- CONTENT_ENTRY_STATUS["CHANGES_REQUESTED"] = "changesRequested";
417
- CONTENT_ENTRY_STATUS["REVIEW_REQUESTED"] = "reviewRequested";
418
416
  })(CONTENT_ENTRY_STATUS || (exports.CONTENT_ENTRY_STATUS = CONTENT_ENTRY_STATUS = {}));