@webiny/api-headless-cms 0.0.0-unstable.8c4d9f045a → 0.0.0-unstable.fcdad0bc61
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/context.js +3 -7
- package/context.js.map +1 -1
- package/crud/contentEntry/afterDelete.d.ts +2 -2
- package/crud/contentEntry/afterDelete.js +2 -2
- package/crud/contentEntry/afterDelete.js.map +1 -1
- package/crud/contentEntry/beforeCreate.d.ts +2 -2
- package/crud/contentEntry/beforeCreate.js +2 -2
- package/crud/contentEntry/beforeCreate.js.map +1 -1
- package/crud/contentEntry/beforeUpdate.d.ts +2 -2
- package/crud/contentEntry/beforeUpdate.js +2 -2
- package/crud/contentEntry/beforeUpdate.js.map +1 -1
- package/crud/contentEntry/entryDataValidation.js +3 -7
- package/crud/contentEntry/entryDataValidation.js.map +1 -1
- package/crud/contentEntry/markLockedFields.js +6 -10
- package/crud/contentEntry/markLockedFields.js.map +1 -1
- package/crud/contentEntry/referenceFieldsMapping.js +3 -9
- package/crud/contentEntry/referenceFieldsMapping.js.map +1 -1
- package/crud/contentEntry.crud.d.ts +0 -2
- package/crud/contentEntry.crud.js +199 -241
- package/crud/contentEntry.crud.js.map +1 -1
- package/crud/contentModel/afterCreate.d.ts +3 -3
- package/crud/contentModel/afterCreate.js +5 -5
- package/crud/contentModel/afterCreate.js.map +1 -1
- package/crud/contentModel/afterCreateFrom.d.ts +3 -3
- package/crud/contentModel/afterCreateFrom.js +5 -5
- package/crud/contentModel/afterCreateFrom.js.map +1 -1
- package/crud/contentModel/afterDelete.d.ts +3 -3
- package/crud/contentModel/afterDelete.js +5 -5
- package/crud/contentModel/afterDelete.js.map +1 -1
- package/crud/contentModel/afterUpdate.d.ts +3 -3
- package/crud/contentModel/afterUpdate.js +5 -5
- package/crud/contentModel/afterUpdate.js.map +1 -1
- package/crud/contentModel/beforeCreate.d.ts +4 -4
- package/crud/contentModel/beforeCreate.js +10 -10
- package/crud/contentModel/beforeCreate.js.map +1 -1
- package/crud/contentModel/beforeDelete.d.ts +3 -3
- package/crud/contentModel/beforeDelete.js +6 -6
- package/crud/contentModel/beforeDelete.js.map +1 -1
- package/crud/contentModel/beforeUpdate.d.ts +3 -3
- package/crud/contentModel/beforeUpdate.js +5 -5
- package/crud/contentModel/beforeUpdate.js.map +1 -1
- package/crud/contentModel/validateModel.js +1 -1
- package/crud/contentModel/validateModelFields.js +3 -7
- package/crud/contentModel/validateModelFields.js.map +1 -1
- package/crud/contentModel.crud.js +84 -60
- package/crud/contentModel.crud.js.map +1 -1
- package/crud/contentModelGroup/beforeCreate.d.ts +2 -2
- package/crud/contentModelGroup/beforeCreate.js +3 -3
- package/crud/contentModelGroup/beforeCreate.js.map +1 -1
- package/crud/contentModelGroup/beforeDelete.d.ts +2 -2
- package/crud/contentModelGroup/beforeDelete.js +3 -3
- package/crud/contentModelGroup/beforeDelete.js.map +1 -1
- package/crud/contentModelGroup/beforeUpdate.d.ts +2 -2
- package/crud/contentModelGroup/beforeUpdate.js +2 -2
- package/crud/contentModelGroup/beforeUpdate.js.map +1 -1
- package/crud/contentModelGroup.crud.js +58 -38
- package/crud/contentModelGroup.crud.js.map +1 -1
- package/crud/index.js +3 -7
- package/crud/index.js.map +1 -1
- package/crud/settings.crud.js +3 -8
- package/crud/settings.crud.js.map +1 -1
- package/crud/system.crud.js +63 -51
- package/crud/system.crud.js.map +1 -1
- package/fieldConverters/CmsModelDefaultFieldConverterPlugin.js +1 -1
- package/fieldConverters/CmsModelObjectFieldConverterPlugin.js +17 -19
- package/fieldConverters/CmsModelObjectFieldConverterPlugin.js.map +1 -1
- package/graphql/graphQLHandlerFactory.js +1 -1
- package/graphql/index.d.ts +1 -1
- package/graphql/schema/baseContentSchema.js +5 -9
- package/graphql/schema/baseContentSchema.js.map +1 -1
- package/graphql/schema/contentEntries.js +1 -1
- package/graphql/schema/contentModels.js +19 -0
- package/graphql/schema/contentModels.js.map +1 -1
- package/graphql/schema/createFieldResolvers.js +4 -10
- package/graphql/schema/createFieldResolvers.js.map +1 -1
- package/graphql/schema/createManageResolvers.js +4 -18
- package/graphql/schema/createManageResolvers.js.map +1 -1
- package/graphql/schema/createManageSDL.js +3 -7
- package/graphql/schema/createManageSDL.js.map +1 -1
- package/graphql/schema/createPreviewResolvers.js +3 -7
- package/graphql/schema/createPreviewResolvers.js.map +1 -1
- package/graphql/schema/createReadResolvers.js +3 -7
- package/graphql/schema/createReadResolvers.js.map +1 -1
- package/graphql/schema/resolvers/manage/resolveGet.js +5 -9
- package/graphql/schema/resolvers/manage/resolveGet.js.map +1 -1
- package/graphql/schema/resolvers/preview/resolveGet.js +3 -7
- package/graphql/schema/resolvers/preview/resolveGet.js.map +1 -1
- package/graphql/schema/resolvers/read/resolveGet.js +3 -7
- package/graphql/schema/resolvers/read/resolveGet.js.map +1 -1
- package/graphqlFields/object.js +1 -1
- package/graphqlFields/ref.js +4 -8
- package/graphqlFields/ref.js.map +1 -1
- package/index.d.ts +1 -1
- package/modelManager/DefaultCmsModelManager.d.ts +7 -7
- package/modelManager/DefaultCmsModelManager.js +1 -1
- package/package.json +27 -28
- package/parameters/header.js +1 -1
- package/parameters/manual.js +7 -8
- package/parameters/manual.js.map +1 -1
- package/parameters/path.js +1 -1
- package/plugins/CmsGroupPlugin.js +1 -1
- package/plugins/CmsModelFieldConverterPlugin.js +1 -1
- package/plugins/CmsModelPlugin.d.ts +6 -2
- package/plugins/CmsModelPlugin.js +18 -13
- package/plugins/CmsModelPlugin.js.map +1 -1
- package/plugins/CmsParametersPlugin.js +1 -1
- package/plugins/StorageTransformPlugin.js +1 -1
- package/storage/object.js +3 -7
- package/storage/object.js.map +1 -1
- package/types.d.ts +267 -126
- package/types.js +0 -2
- package/types.js.map +1 -1
- package/upgrades/5.33.0/index.js +5 -9
- package/upgrades/5.33.0/index.js.map +1 -1
- package/utils/converters/Converter.js +1 -1
- package/utils/converters/ConverterCollection.d.ts +7 -0
- package/utils/converters/ConverterCollection.js +31 -7
- package/utils/converters/ConverterCollection.js.map +1 -1
- package/utils/converters/valueKeyStorageConverter.js +3 -7
- package/utils/converters/valueKeyStorageConverter.js.map +1 -1
- package/utils/createTypeName.js +1 -1
- package/utils/entryStorage.js +3 -7
- package/utils/entryStorage.js.map +1 -1
- package/utils/filterModelFields.js +5 -9
- package/utils/filterModelFields.js.map +1 -1
- package/utils/permissions.js +1 -5
- package/utils/permissions.js.map +1 -1
- package/utils/pluralizedTypeName.js +1 -1
- package/utils/renderListFilterFields.js +7 -0
- package/utils/renderListFilterFields.js.map +1 -1
- package/utils/toSlug.js +1 -1
- 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
|
|
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
|
|
802
|
+
export interface OnSystemBeforeInstallTopicParams {
|
|
804
803
|
tenant: string;
|
|
805
804
|
locale: string;
|
|
806
805
|
}
|
|
807
|
-
export interface
|
|
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
|
-
*
|
|
822
|
+
* Lifecycle events - deprecated
|
|
823
|
+
*/
|
|
824
|
+
/**
|
|
825
|
+
* @deprecated
|
|
826
|
+
*/
|
|
827
|
+
onBeforeSystemInstall: Topic<OnSystemBeforeInstallTopicParams>;
|
|
828
|
+
/**
|
|
829
|
+
* @deprecated
|
|
819
830
|
*/
|
|
820
|
-
|
|
821
|
-
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
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:
|
|
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
|
|
1387
|
+
export interface OnModelBeforeCreateTopicParams {
|
|
1345
1388
|
input: CmsModelCreateInput;
|
|
1346
1389
|
model: CmsModel;
|
|
1347
1390
|
}
|
|
1348
|
-
export interface
|
|
1391
|
+
export interface OnModelAfterCreateTopicParams {
|
|
1349
1392
|
input: CmsModelCreateInput;
|
|
1350
1393
|
model: CmsModel;
|
|
1351
1394
|
}
|
|
1352
|
-
export interface
|
|
1395
|
+
export interface OnModelBeforeCreateFromTopicParams {
|
|
1353
1396
|
input: CmsModelCreateInput;
|
|
1354
1397
|
original: CmsModel;
|
|
1355
1398
|
model: CmsModel;
|
|
1356
1399
|
}
|
|
1357
|
-
export interface
|
|
1400
|
+
export interface OnModelAfterCreateFromTopicParams {
|
|
1358
1401
|
input: CmsModelCreateInput;
|
|
1359
1402
|
original: CmsModel;
|
|
1360
1403
|
model: CmsModel;
|
|
1361
1404
|
}
|
|
1362
|
-
export interface
|
|
1405
|
+
export interface OnModelBeforeUpdateTopicParams {
|
|
1363
1406
|
input: CmsModelUpdateInput;
|
|
1364
1407
|
original: CmsModel;
|
|
1365
1408
|
model: CmsModel;
|
|
1366
1409
|
}
|
|
1367
|
-
export interface
|
|
1410
|
+
export interface OnModelAfterUpdateTopicParams {
|
|
1368
1411
|
input: CmsModelUpdateInput;
|
|
1369
1412
|
original: CmsModel;
|
|
1370
1413
|
model: CmsModel;
|
|
1371
1414
|
}
|
|
1372
|
-
export interface
|
|
1415
|
+
export interface OnModelBeforeDeleteTopicParams {
|
|
1373
1416
|
model: CmsModel;
|
|
1374
1417
|
}
|
|
1375
|
-
export interface
|
|
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
|
-
*
|
|
1492
|
+
* Lifecycle events - deprecated.
|
|
1493
|
+
*/
|
|
1494
|
+
/**
|
|
1495
|
+
* @deprecated
|
|
1440
1496
|
*/
|
|
1441
|
-
onBeforeModelCreate: Topic<
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
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" | "
|
|
1544
|
+
export declare type CmsEntryStatus = "published" | "unpublished" | "draft";
|
|
1456
1545
|
export interface CmsEntryListWhereRef {
|
|
1457
1546
|
id?: string;
|
|
1458
1547
|
id_in?: string[];
|
|
@@ -1583,100 +1672,120 @@ export interface CmsEntryMeta {
|
|
|
1583
1672
|
*/
|
|
1584
1673
|
totalCount: number;
|
|
1585
1674
|
}
|
|
1586
|
-
export interface
|
|
1675
|
+
export interface OnEntryBeforeCreateTopicParams {
|
|
1587
1676
|
input: CreateCmsEntryInput;
|
|
1588
1677
|
entry: CmsEntry;
|
|
1589
1678
|
model: StorageOperationsCmsModel;
|
|
1590
1679
|
}
|
|
1591
|
-
export interface
|
|
1680
|
+
export interface OnEntryAfterCreateTopicParams {
|
|
1592
1681
|
input: CreateCmsEntryInput;
|
|
1593
1682
|
entry: CmsEntry;
|
|
1594
1683
|
model: StorageOperationsCmsModel;
|
|
1595
1684
|
storageEntry: CmsEntry;
|
|
1596
1685
|
}
|
|
1597
|
-
export interface
|
|
1686
|
+
export interface OnEntryCreateErrorTopicParams {
|
|
1687
|
+
error: Error;
|
|
1688
|
+
input: CreateCmsEntryInput;
|
|
1689
|
+
entry: CmsEntry;
|
|
1690
|
+
model: CmsModel;
|
|
1691
|
+
}
|
|
1692
|
+
export interface OnEntryRevisionBeforeCreateTopicParams {
|
|
1598
1693
|
input: CreateFromCmsEntryInput;
|
|
1599
1694
|
entry: CmsEntry;
|
|
1600
1695
|
original: CmsEntry;
|
|
1601
1696
|
model: StorageOperationsCmsModel;
|
|
1602
1697
|
}
|
|
1603
|
-
export interface
|
|
1698
|
+
export interface OnEntryRevisionAfterCreateTopicParams {
|
|
1604
1699
|
input: CreateFromCmsEntryInput;
|
|
1605
1700
|
entry: CmsEntry;
|
|
1606
1701
|
original: CmsEntry;
|
|
1607
1702
|
model: StorageOperationsCmsModel;
|
|
1608
1703
|
storageEntry: CmsEntry;
|
|
1609
1704
|
}
|
|
1610
|
-
export interface
|
|
1705
|
+
export interface OnEntryCreateRevisionErrorTopicParams {
|
|
1706
|
+
error: Error;
|
|
1707
|
+
input: CreateFromCmsEntryInput;
|
|
1708
|
+
entry: CmsEntry;
|
|
1709
|
+
model: CmsModel;
|
|
1710
|
+
}
|
|
1711
|
+
export interface OnEntryBeforeUpdateTopicParams {
|
|
1611
1712
|
input: UpdateCmsEntryInput;
|
|
1612
1713
|
original: CmsEntry;
|
|
1613
1714
|
entry: CmsEntry;
|
|
1614
1715
|
model: StorageOperationsCmsModel;
|
|
1615
1716
|
}
|
|
1616
|
-
export interface
|
|
1717
|
+
export interface OnEntryAfterUpdateTopicParams {
|
|
1617
1718
|
input: UpdateCmsEntryInput;
|
|
1618
1719
|
original: CmsEntry;
|
|
1619
1720
|
entry: CmsEntry;
|
|
1620
1721
|
model: StorageOperationsCmsModel;
|
|
1621
1722
|
storageEntry: CmsEntry;
|
|
1622
1723
|
}
|
|
1623
|
-
export interface
|
|
1724
|
+
export interface OnEntryUpdateErrorTopicParams {
|
|
1725
|
+
error: Error;
|
|
1726
|
+
input: CreateFromCmsEntryInput;
|
|
1624
1727
|
entry: CmsEntry;
|
|
1625
|
-
model:
|
|
1728
|
+
model: CmsModel;
|
|
1626
1729
|
}
|
|
1627
|
-
export interface
|
|
1730
|
+
export interface OnEntryBeforePublishTopicParams {
|
|
1628
1731
|
entry: CmsEntry;
|
|
1629
1732
|
model: StorageOperationsCmsModel;
|
|
1630
|
-
storageEntry: CmsEntry;
|
|
1631
1733
|
}
|
|
1632
|
-
export interface
|
|
1734
|
+
export interface OnEntryAfterPublishTopicParams {
|
|
1633
1735
|
entry: CmsEntry;
|
|
1634
1736
|
model: StorageOperationsCmsModel;
|
|
1737
|
+
storageEntry: CmsEntry;
|
|
1635
1738
|
}
|
|
1636
|
-
export interface
|
|
1739
|
+
export interface OnEntryPublishErrorTopicParams {
|
|
1740
|
+
error: Error;
|
|
1637
1741
|
entry: CmsEntry;
|
|
1638
1742
|
model: StorageOperationsCmsModel;
|
|
1639
|
-
storageEntry: CmsEntry;
|
|
1640
1743
|
}
|
|
1641
|
-
export interface
|
|
1744
|
+
export interface OnEntryBeforeUnpublishTopicParams {
|
|
1642
1745
|
entry: CmsEntry;
|
|
1643
1746
|
model: StorageOperationsCmsModel;
|
|
1644
1747
|
}
|
|
1645
|
-
export interface
|
|
1748
|
+
export interface OnEntryAfterUnpublishTopicParams {
|
|
1646
1749
|
entry: CmsEntry;
|
|
1647
1750
|
model: StorageOperationsCmsModel;
|
|
1648
1751
|
storageEntry: CmsEntry;
|
|
1649
1752
|
}
|
|
1650
|
-
export interface
|
|
1753
|
+
export interface OnEntryUnpublishErrorTopicParams {
|
|
1754
|
+
error: Error;
|
|
1755
|
+
entry: CmsEntry;
|
|
1756
|
+
model: CmsModel;
|
|
1757
|
+
}
|
|
1758
|
+
export interface OnEntryBeforeDeleteTopicParams {
|
|
1651
1759
|
entry: CmsEntry;
|
|
1652
1760
|
model: StorageOperationsCmsModel;
|
|
1653
1761
|
}
|
|
1654
|
-
export interface
|
|
1762
|
+
export interface OnEntryAfterDeleteTopicParams {
|
|
1655
1763
|
entry: CmsEntry;
|
|
1656
1764
|
model: StorageOperationsCmsModel;
|
|
1657
|
-
storageEntry: CmsEntry;
|
|
1658
1765
|
}
|
|
1659
|
-
export interface
|
|
1766
|
+
export interface OnEntryDeleteErrorTopicParams {
|
|
1767
|
+
error: Error;
|
|
1660
1768
|
entry: CmsEntry;
|
|
1661
1769
|
model: StorageOperationsCmsModel;
|
|
1662
1770
|
}
|
|
1663
|
-
export interface
|
|
1771
|
+
export interface OnEntryRevisionBeforeDeleteTopicParams {
|
|
1664
1772
|
entry: CmsEntry;
|
|
1665
1773
|
model: StorageOperationsCmsModel;
|
|
1666
1774
|
}
|
|
1667
|
-
export interface
|
|
1775
|
+
export interface OnEntryRevisionAfterDeleteTopicParams {
|
|
1668
1776
|
entry: CmsEntry;
|
|
1669
1777
|
model: StorageOperationsCmsModel;
|
|
1670
1778
|
}
|
|
1671
|
-
export interface
|
|
1779
|
+
export interface OnEntryRevisionDeleteErrorTopicParams {
|
|
1780
|
+
error: Error;
|
|
1672
1781
|
entry: CmsEntry;
|
|
1673
1782
|
model: StorageOperationsCmsModel;
|
|
1674
1783
|
}
|
|
1675
|
-
export interface
|
|
1784
|
+
export interface OnEntryBeforeGetTopicParams {
|
|
1676
1785
|
model: StorageOperationsCmsModel;
|
|
1677
1786
|
where: CmsEntryListWhere;
|
|
1678
1787
|
}
|
|
1679
|
-
export interface
|
|
1788
|
+
export interface EntryBeforeListTopicParams {
|
|
1680
1789
|
where: CmsEntryListWhere;
|
|
1681
1790
|
model: StorageOperationsCmsModel;
|
|
1682
1791
|
}
|
|
@@ -1774,40 +1883,102 @@ export interface CmsEntryContext {
|
|
|
1774
1883
|
*/
|
|
1775
1884
|
unpublishEntry: (model: CmsModel, id: string) => Promise<CmsEntry>;
|
|
1776
1885
|
/**
|
|
1777
|
-
*
|
|
1886
|
+
* Get all entry revisions.
|
|
1778
1887
|
*/
|
|
1779
|
-
|
|
1888
|
+
getEntryRevisions: (model: CmsModel, id: string) => Promise<CmsEntry[]>;
|
|
1780
1889
|
/**
|
|
1781
|
-
*
|
|
1890
|
+
* Lifecyle events - deprecated.
|
|
1782
1891
|
*/
|
|
1783
|
-
requestEntryChanges: (model: CmsModel, id: string) => Promise<CmsEntry>;
|
|
1784
1892
|
/**
|
|
1785
|
-
*
|
|
1893
|
+
* @deprecated
|
|
1786
1894
|
*/
|
|
1787
|
-
|
|
1895
|
+
onBeforeEntryCreate: Topic<OnEntryBeforeCreateTopicParams>;
|
|
1896
|
+
/**
|
|
1897
|
+
* @deprecated
|
|
1898
|
+
*/
|
|
1899
|
+
onAfterEntryCreate: Topic<OnEntryAfterCreateTopicParams>;
|
|
1900
|
+
/**
|
|
1901
|
+
* @deprecated
|
|
1902
|
+
*/
|
|
1903
|
+
onBeforeEntryCreateRevision: Topic<OnEntryRevisionBeforeCreateTopicParams>;
|
|
1904
|
+
/**
|
|
1905
|
+
* @deprecated
|
|
1906
|
+
*/
|
|
1907
|
+
onAfterEntryCreateRevision: Topic<OnEntryRevisionAfterCreateTopicParams>;
|
|
1908
|
+
/**
|
|
1909
|
+
* @deprecated
|
|
1910
|
+
*/
|
|
1911
|
+
onBeforeEntryUpdate: Topic<OnEntryBeforeUpdateTopicParams>;
|
|
1912
|
+
/**
|
|
1913
|
+
* @deprecated
|
|
1914
|
+
*/
|
|
1915
|
+
onAfterEntryUpdate: Topic<OnEntryAfterUpdateTopicParams>;
|
|
1916
|
+
/**
|
|
1917
|
+
* @deprecated
|
|
1918
|
+
*/
|
|
1919
|
+
onBeforeEntryDelete: Topic<OnEntryBeforeDeleteTopicParams>;
|
|
1920
|
+
/**
|
|
1921
|
+
* @deprecated
|
|
1922
|
+
*/
|
|
1923
|
+
onAfterEntryDelete: Topic<OnEntryAfterDeleteTopicParams>;
|
|
1924
|
+
/**
|
|
1925
|
+
* @deprecated
|
|
1926
|
+
*/
|
|
1927
|
+
onBeforeEntryDeleteRevision: Topic<OnEntryRevisionBeforeDeleteTopicParams>;
|
|
1928
|
+
/**
|
|
1929
|
+
* @deprecated
|
|
1930
|
+
*/
|
|
1931
|
+
onAfterEntryDeleteRevision: Topic<OnEntryRevisionAfterDeleteTopicParams>;
|
|
1932
|
+
/**
|
|
1933
|
+
* @deprecated
|
|
1934
|
+
*/
|
|
1935
|
+
onBeforeEntryPublish: Topic<OnEntryBeforePublishTopicParams>;
|
|
1788
1936
|
/**
|
|
1789
|
-
*
|
|
1790
|
-
*/
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
|
|
1809
|
-
|
|
1810
|
-
|
|
1937
|
+
* @deprecated
|
|
1938
|
+
*/
|
|
1939
|
+
onAfterEntryPublish: Topic<OnEntryAfterPublishTopicParams>;
|
|
1940
|
+
/**
|
|
1941
|
+
* @deprecated
|
|
1942
|
+
*/
|
|
1943
|
+
onBeforeEntryUnpublish: Topic<OnEntryBeforeUnpublishTopicParams>;
|
|
1944
|
+
/**
|
|
1945
|
+
* @deprecated
|
|
1946
|
+
*/
|
|
1947
|
+
onAfterEntryUnpublish: Topic<OnEntryAfterUnpublishTopicParams>;
|
|
1948
|
+
/**
|
|
1949
|
+
* @deprecated
|
|
1950
|
+
*/
|
|
1951
|
+
onBeforeEntryGet: Topic<OnEntryBeforeGetTopicParams>;
|
|
1952
|
+
/**
|
|
1953
|
+
* @deprecated
|
|
1954
|
+
*/
|
|
1955
|
+
onBeforeEntryList: Topic<EntryBeforeListTopicParams>;
|
|
1956
|
+
/**
|
|
1957
|
+
* Lifecycle events released in 5.33.0
|
|
1958
|
+
*/
|
|
1959
|
+
onEntryBeforeCreate: Topic<OnEntryBeforeCreateTopicParams>;
|
|
1960
|
+
onEntryAfterCreate: Topic<OnEntryAfterCreateTopicParams>;
|
|
1961
|
+
onEntryCreateError: Topic<OnEntryCreateErrorTopicParams>;
|
|
1962
|
+
onEntryRevisionBeforeCreate: Topic<OnEntryRevisionBeforeCreateTopicParams>;
|
|
1963
|
+
onEntryRevisionAfterCreate: Topic<OnEntryRevisionAfterCreateTopicParams>;
|
|
1964
|
+
onEntryRevisionCreateError: Topic<OnEntryCreateRevisionErrorTopicParams>;
|
|
1965
|
+
onEntryBeforeUpdate: Topic<OnEntryBeforeUpdateTopicParams>;
|
|
1966
|
+
onEntryAfterUpdate: Topic<OnEntryAfterUpdateTopicParams>;
|
|
1967
|
+
onEntryUpdateError: Topic<OnEntryUpdateErrorTopicParams>;
|
|
1968
|
+
onEntryBeforeDelete: Topic<OnEntryBeforeDeleteTopicParams>;
|
|
1969
|
+
onEntryAfterDelete: Topic<OnEntryAfterDeleteTopicParams>;
|
|
1970
|
+
onEntryDeleteError: Topic<OnEntryDeleteErrorTopicParams>;
|
|
1971
|
+
onEntryRevisionBeforeDelete: Topic<OnEntryRevisionBeforeDeleteTopicParams>;
|
|
1972
|
+
onEntryRevisionAfterDelete: Topic<OnEntryRevisionAfterDeleteTopicParams>;
|
|
1973
|
+
onEntryRevisionDeleteError: Topic<OnEntryRevisionDeleteErrorTopicParams>;
|
|
1974
|
+
onEntryBeforePublish: Topic<OnEntryBeforePublishTopicParams>;
|
|
1975
|
+
onEntryAfterPublish: Topic<OnEntryAfterPublishTopicParams>;
|
|
1976
|
+
onEntryPublishError: Topic<OnEntryPublishErrorTopicParams>;
|
|
1977
|
+
onEntryBeforeUnpublish: Topic<OnEntryBeforeUnpublishTopicParams>;
|
|
1978
|
+
onEntryAfterUnpublish: Topic<OnEntryAfterUnpublishTopicParams>;
|
|
1979
|
+
onEntryUnpublishError: Topic<OnEntryUnpublishErrorTopicParams>;
|
|
1980
|
+
onEntryBeforeGet: Topic<OnEntryBeforeGetTopicParams>;
|
|
1981
|
+
onEntryBeforeList: Topic<EntryBeforeListTopicParams>;
|
|
1811
1982
|
}
|
|
1812
1983
|
/**
|
|
1813
1984
|
* Parameters for CmsEntryResolverFactory.
|
|
@@ -2085,26 +2256,6 @@ export interface CmsEntryStorageOperationsUnpublishParams<T extends CmsStorageEn
|
|
|
2085
2256
|
*/
|
|
2086
2257
|
storageEntry: T;
|
|
2087
2258
|
}
|
|
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
2259
|
export interface CmsEntryStorageOperationsGetByIdsParams {
|
|
2109
2260
|
ids: readonly string[];
|
|
2110
2261
|
}
|
|
@@ -2226,21 +2377,11 @@ export interface CmsEntryStorageOperations<T extends CmsStorageEntry = CmsStorag
|
|
|
2226
2377
|
* Unpublish the entry.
|
|
2227
2378
|
*/
|
|
2228
2379
|
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
2380
|
}
|
|
2238
2381
|
export declare enum CONTENT_ENTRY_STATUS {
|
|
2239
2382
|
DRAFT = "draft",
|
|
2240
2383
|
PUBLISHED = "published",
|
|
2241
|
-
UNPUBLISHED = "unpublished"
|
|
2242
|
-
CHANGES_REQUESTED = "changesRequested",
|
|
2243
|
-
REVIEW_REQUESTED = "reviewRequested"
|
|
2384
|
+
UNPUBLISHED = "unpublished"
|
|
2244
2385
|
}
|
|
2245
2386
|
export interface CmsSettingsStorageOperationsGetParams {
|
|
2246
2387
|
locale: string;
|
|
@@ -2297,7 +2438,7 @@ export interface CmsSystemStorageOperations {
|
|
|
2297
2438
|
*/
|
|
2298
2439
|
update: (params: CmsSystemStorageOperationsUpdateParams) => Promise<CmsSystem>;
|
|
2299
2440
|
}
|
|
2300
|
-
export interface HeadlessCmsStorageOperations {
|
|
2441
|
+
export interface HeadlessCmsStorageOperations<C = CmsContext> {
|
|
2301
2442
|
system: CmsSystemStorageOperations;
|
|
2302
2443
|
settings: CmsSettingsStorageOperations;
|
|
2303
2444
|
groups: CmsGroupStorageOperations;
|
|
@@ -2306,8 +2447,8 @@ export interface HeadlessCmsStorageOperations {
|
|
|
2306
2447
|
/**
|
|
2307
2448
|
* Either attach something from the storage operations or run something in it.
|
|
2308
2449
|
*/
|
|
2309
|
-
beforeInit?: (context:
|
|
2310
|
-
init?: (context:
|
|
2450
|
+
beforeInit?: (context: C) => Promise<void>;
|
|
2451
|
+
init?: (context: C) => Promise<void>;
|
|
2311
2452
|
/**
|
|
2312
2453
|
* An upgrade to run if necessary.
|
|
2313
2454
|
*/
|
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 = {}));
|