@webiny/api-headless-cms-ddb 5.34.8 → 5.35.0-beta.1

package/operations/entry/index.js

@@ -1,50 +1,32 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createEntriesStorageOperations = void 0;
-
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
 var _error = _interopRequireDefault(require("@webiny/error"));
-
 var _dataLoaders = require("./dataLoaders");
-
 var _types = require("@webiny/api-headless-cms/types");
-
 var _keys = require("./keys");
-
 var _batchWrite = require("@webiny/db-dynamodb/utils/batchWrite");
-
 var _query = require("@webiny/db-dynamodb/utils/query");
-
 var _cleanup = require("@webiny/db-dynamodb/utils/cleanup");
-
 var _cursor = require("@webiny/utils/cursor");
-
 var _zeroPad = require("@webiny/utils/zeroPad");
-
 var _apiHeadlessCms = require("@webiny/api-headless-cms");
-
 var _createFields = require("./filtering/createFields");
-
 var _filtering = require("./filtering");
-
 const createType = () => {
   return "cms.entry";
 };
-
 const createLatestType = () => {
   return `${createType()}.l`;
 };
-
 const createPublishedType = () => {
   return `${createType()}.p`;
 };
-
 const convertToStorageEntry = params => {
   const {
     model,
@@ -58,7 +40,6 @@ const convertToStorageEntry = params => {
     values
   });
 };
-
 const convertFromStorageEntry = params => {
   const {
     model,
@@ -72,12 +53,23 @@ const convertFromStorageEntry = params => {
     values
   });
 };
-
 const createEntriesStorageOperations = params => {
   const {
     entity,
     plugins
   } = params;
+  let storageOperationsCmsModelPlugin;
+  const getStorageOperationsCmsModelPlugin = () => {
+    if (storageOperationsCmsModelPlugin) {
+      return storageOperationsCmsModelPlugin;
+    }
+    storageOperationsCmsModelPlugin = plugins.oneByType(_apiHeadlessCms.StorageOperationsCmsModelPlugin.type);
+    return storageOperationsCmsModelPlugin;
+  };
+  const getStorageOperationsModel = model => {
+    const plugin = getStorageOperationsCmsModelPlugin();
+    return plugin.getModel(model);
+  };
   const dataLoaders = new _dataLoaders.DataLoadersHandler({
     entity
   });
@@ -85,34 +77,29 @@ const createEntriesStorageOperations = params => {
     collection[plugin.fieldType] = plugin;
     return collection;
   }, {});
-
   const createStorageTransformCallable = model => {
     return (field, value) => {
       const plugin = storageTransformPlugins[field.type];
-
       if (!plugin) {
         return value;
       }
-
       return plugin.fromStorage({
         model,
         field,
         value,
-
         getStoragePlugin(fieldType) {
           return storageTransformPlugins[fieldType] || storageTransformPlugins["*"];
         },
-
         plugins
       });
     };
   };
-
-  const create = async (model, params) => {
+  const create = async (initialModel, params) => {
     const {
       entry,
       storageEntry: initialStorageEntry
     } = params;
+    const model = getStorageOperationsModel(initialModel);
     const partitionKey = (0, _keys.createPartitionKey)({
       id: entry.id,
       locale: model.locale,
@@ -127,9 +114,8 @@ const createEntriesStorageOperations = params => {
     /**
      * We need to:
      *  - create new main entry item
-     *  - create new or update latest entry item
+     *  - create new or update the latest entry item
      */
-
     const items = [entity.putBatch((0, _objectSpread2.default)((0, _objectSpread2.default)({}, storageEntry), {}, {
       locked,
       PK: partitionKey,
@@ -145,10 +131,10 @@ const createEntriesStorageOperations = params => {
       GSI1_PK: (0, _keys.createGSIPartitionKey)(model, "L"),
       GSI1_SK: (0, _keys.createGSISortKey)(storageEntry)
     }))];
+
     /**
      * We need to create published entry if
      */
-
     if (isPublished) {
       items.push(entity.putBatch((0, _objectSpread2.default)((0, _objectSpread2.default)({}, storageEntry), {}, {
         locked,
@@ -159,7 +145,6 @@ const createEntriesStorageOperations = params => {
         GSI1_SK: (0, _keys.createGSISortKey)(storageEntry)
       })));
     }
-
     try {
       await (0, _batchWrite.batchWriteAll)({
         table: entity.table,
@@ -174,15 +159,14 @@ const createEntriesStorageOperations = params => {
         entry
       });
     }
-
     return initialStorageEntry;
   };
-
-  const createRevisionFrom = async (model, params) => {
+  const createRevisionFrom = async (initialModel, params) => {
     const {
       entry,
       storageEntry: initialStorageEntry
     } = params;
+    const model = getStorageOperationsModel(initialModel);
     const partitionKey = (0, _keys.createPartitionKey)({
       id: entry.id,
       locale: model.locale,
@@ -197,7 +181,6 @@ const createEntriesStorageOperations = params => {
      *  - create the main entry item
      *  - update the last entry item to a current one
      */
-
     const items = [entity.putBatch((0, _objectSpread2.default)((0, _objectSpread2.default)({}, storageEntry), {}, {
       PK: partitionKey,
       SK: (0, _keys.createRevisionSortKey)(storageEntry),
@@ -211,7 +194,6 @@ const createEntriesStorageOperations = params => {
       GSI1_PK: (0, _keys.createGSIPartitionKey)(model, "L"),
       GSI1_SK: (0, _keys.createGSISortKey)(storageEntry)
     }))];
-
     try {
       await (0, _batchWrite.batchWriteAll)({
         table: entity.table,
@@ -230,16 +212,14 @@ const createEntriesStorageOperations = params => {
     /**
      * There are no modifications on the entry created so just return the data.
      */
-
-
     return initialStorageEntry;
   };
-
-  const update = async (model, params) => {
+  const update = async (initialModel, params) => {
     const {
       entry,
       storageEntry: initialStorageEntry
     } = params;
+    const model = getStorageOperationsModel(initialModel);
     const partitionKey = (0, _keys.createPartitionKey)({
       id: entry.id,
       locale: model.locale,
@@ -257,7 +237,6 @@ const createEntriesStorageOperations = params => {
      *  - update the current entry
      *  - update the latest entry if the current entry is the latest one
      */
-
     items.push(entity.putBatch((0, _objectSpread2.default)((0, _objectSpread2.default)({}, storageEntry), {}, {
       locked,
       PK: partitionKey,
@@ -266,7 +245,6 @@ const createEntriesStorageOperations = params => {
       GSI1_PK: (0, _keys.createGSIPartitionKey)(model, "A"),
       GSI1_SK: (0, _keys.createGSISortKey)(storageEntry)
     })));
-
     if (isPublished) {
       items.push(entity.putBatch((0, _objectSpread2.default)((0, _objectSpread2.default)({}, storageEntry), {}, {
         locked,
@@ -277,13 +255,11 @@ const createEntriesStorageOperations = params => {
         GSI1_SK: (0, _keys.createGSISortKey)(storageEntry)
       })));
     }
+
     /**
-     * We need the latest entry to update it as well if neccessary.
+     * We need the latest entry to update it as well if necessary.
      */
-
-
     const latestStorageEntry = await getLatestRevisionByEntryId(model, entry);
-
     if (latestStorageEntry && latestStorageEntry.id === entry.id) {
       items.push(entity.putBatch((0, _objectSpread2.default)((0, _objectSpread2.default)({}, storageEntry), {}, {
         locked,
@@ -294,7 +270,6 @@ const createEntriesStorageOperations = params => {
         GSI1_SK: (0, _keys.createGSISortKey)(entry)
       })));
     }
-
     try {
       await (0, _batchWrite.batchWriteAll)({
         table: entity.table,
@@ -312,11 +287,11 @@ const createEntriesStorageOperations = params => {
       });
     }
   };
-
-  const deleteEntry = async (model, params) => {
+  const deleteEntry = async (initialModel, params) => {
     const {
       entry
     } = params;
+    const model = getStorageOperationsModel(initialModel);
     const queryAllParams = {
       entity,
       partitionKey: (0, _keys.createPartitionKey)({
@@ -329,7 +304,6 @@ const createEntriesStorageOperations = params => {
       }
     };
     let records = [];
-
     try {
       records = await (0, _query.queryAll)(queryAllParams);
     } catch (ex) {
@@ -338,14 +312,12 @@ const createEntriesStorageOperations = params => {
         entry
       });
     }
-
     const items = records.map(item => {
       return entity.deleteBatch({
         PK: item.PK,
         SK: item.SK
       });
     });
-
     try {
       await (0, _batchWrite.batchWriteAll)({
         table: entity.table,
@@ -362,13 +334,13 @@ const createEntriesStorageOperations = params => {
       });
     }
   };
-
-  const deleteRevision = async (model, params) => {
+  const deleteRevision = async (initialModel, params) => {
     const {
       entry,
       latestEntry,
       latestStorageEntry: initialLatestStorageEntry
     } = params;
+    const model = getStorageOperationsModel(initialModel);
     const partitionKey = (0, _keys.createPartitionKey)({
       id: entry.id,
       locale: model.locale,
@@ -379,17 +351,16 @@ const createEntriesStorageOperations = params => {
       SK: (0, _keys.createRevisionSortKey)(entry)
     })];
     const publishedStorageEntry = await getPublishedRevisionByEntryId(model, entry);
+
     /**
      * If revision we are deleting is the published one as well, we need to delete those records as well.
      */
-
     if (publishedStorageEntry && entry.id === publishedStorageEntry.id) {
       items.push(entity.deleteBatch({
         PK: partitionKey,
         SK: (0, _keys.createPublishedSortKey)()
       }));
     }
-
     if (initialLatestStorageEntry) {
       const latestStorageEntry = convertToStorageEntry({
         storageEntry: initialLatestStorageEntry,
@@ -403,7 +374,6 @@ const createEntriesStorageOperations = params => {
         GSI1_SK: (0, _keys.createGSISortKey)(latestStorageEntry)
       })));
     }
-
     try {
       await (0, _batchWrite.batchWriteAll)({
         table: entity.table,
@@ -420,59 +390,53 @@ const createEntriesStorageOperations = params => {
       });
     }
   };
-
-  const getLatestRevisionByEntryId = async (model, params) => {
+  const getLatestRevisionByEntryId = async (initialModel, params) => {
+    const model = getStorageOperationsModel(initialModel);
     const items = await dataLoaders.getLatestRevisionByEntryId({
       model,
       ids: [params.id]
     });
     const item = items.shift() || null;
-
     if (!item) {
       return null;
     }
-
     return convertFromStorageEntry({
       storageEntry: item,
       model
     });
   };
-
-  const getPublishedRevisionByEntryId = async (model, params) => {
+  const getPublishedRevisionByEntryId = async (initialModel, params) => {
+    const model = getStorageOperationsModel(initialModel);
     const items = await dataLoaders.getPublishedRevisionByEntryId({
       model,
       ids: [params.id]
     });
     const item = items.shift() || null;
-
     if (!item) {
       return null;
     }
-
     return convertFromStorageEntry({
       storageEntry: item,
       model
     });
   };
-
-  const getRevisionById = async (model, params) => {
+  const getRevisionById = async (initialModel, params) => {
+    const model = getStorageOperationsModel(initialModel);
     const items = await dataLoaders.getRevisionById({
       model,
       ids: [params.id]
     });
     const item = items.shift() || null;
-
     if (!item) {
       return null;
     }
-
     return convertFromStorageEntry({
       storageEntry: item,
       model
     });
   };
-
-  const getRevisions = async (model, params) => {
+  const getRevisions = async (initialModel, params) => {
+    const model = getStorageOperationsModel(initialModel);
     const items = await dataLoaders.getAllEntryRevisions({
       model,
       ids: [params.id]
@@ -484,8 +448,8 @@ const createEntriesStorageOperations = params => {
       });
     });
   };
-
-  const getByIds = async (model, params) => {
+  const getByIds = async (initialModel, params) => {
+    const model = getStorageOperationsModel(initialModel);
     const items = await dataLoaders.getRevisionById({
       model,
       ids: params.ids
@@ -497,8 +461,8 @@ const createEntriesStorageOperations = params => {
       });
     });
   };
-
-  const getLatestByIds = async (model, params) => {
+  const getLatestByIds = async (initialModel, params) => {
+    const model = getStorageOperationsModel(initialModel);
     const items = await dataLoaders.getLatestRevisionByEntryId({
       model,
       ids: params.ids
@@ -510,8 +474,8 @@ const createEntriesStorageOperations = params => {
       });
     });
   };
-
-  const getPublishedByIds = async (model, params) => {
+  const getPublishedByIds = async (initialModel, params) => {
+    const model = getStorageOperationsModel(initialModel);
     const items = await dataLoaders.getPublishedRevisionByEntryId({
       model,
       ids: params.ids
@@ -523,8 +487,8 @@ const createEntriesStorageOperations = params => {
       });
     });
   };
-
-  const getPreviousRevision = async (model, params) => {
+  const getPreviousRevision = async (initialModel, params) => {
+    const model = getStorageOperationsModel(initialModel);
     const {
       entryId,
       version
@@ -538,7 +502,6 @@ const createEntriesStorageOperations = params => {
       }),
       options: {
         lt: `REV#${(0, _zeroPad.zeroPad)(version)}`,
-
         /**
          * We need to have extra checks because DynamoDB will return published or latest record if there is no REV# record.
          */
@@ -552,15 +515,12 @@ const createEntriesStorageOperations = params => {
         reverse: true
       }
     };
-
     try {
       const result = await (0, _query.queryOne)(queryParams);
       const storageEntry = (0, _cleanup.cleanupItem)(entity, result);
-
       if (!storageEntry) {
         return null;
       }
-
       return convertFromStorageEntry({
         storageEntry,
         model
@@ -574,8 +534,8 @@ const createEntriesStorageOperations = params => {
       }));
     }
   };
-
-  const list = async (model, params) => {
+  const list = async (initialModel, params) => {
+    const model = getStorageOperationsModel(initialModel);
     const {
       limit: initialLimit = 10,
       where: initialWhere,
@@ -595,7 +555,6 @@ const createEntriesStorageOperations = params => {
       }
     };
     let storageEntries = [];
-
     try {
       storageEntries = await (0, _query.queryAll)(queryAllParams);
     } catch (ex) {
@@ -605,7 +564,6 @@ const createEntriesStorageOperations = params => {
         options: queryAllParams.options
       });
     }
-
     if (storageEntries.length === 0) {
       return {
         hasMoreItems: false,
@@ -614,7 +572,6 @@ const createEntriesStorageOperations = params => {
         items: []
       };
     }
-
     const where = (0, _objectSpread2.default)({}, initialWhere);
     delete where["published"];
     delete where["latest"];
@@ -622,7 +579,6 @@ const createEntriesStorageOperations = params => {
      * We need an object containing field, transformers and paths.
      * Just build it here and pass on into other methods that require it to avoid mapping multiple times.
      */
-
     const modelFields = (0, _createFields.createFields)({
       plugins,
       fields: model.fields
@@ -633,24 +589,20 @@ const createEntriesStorageOperations = params => {
      *
      * This is always being done, but at least its in parallel.
      */
-
     const records = await Promise.all(storageEntries.map(async storageEntry => {
       const entry = convertFromStorageEntry({
         storageEntry,
         model
       });
-
       for (const field of model.fields) {
         entry.values[field.fieldId] = await fromStorage(field, entry.values[field.fieldId]);
       }
-
       return entry;
     }));
     /**
      * Filter the read items via the code.
      * It will build the filters out of the where input and transform the values it is using.
      */
-
     const filteredItems = (0, _filtering.filter)({
       items: records,
       where,
@@ -662,11 +614,11 @@ const createEntriesStorageOperations = params => {
       }
     });
     const totalCount = filteredItems.length;
+
     /**
      * Sorting is also done via the code.
      * It takes the sort input and sorts by it via the lodash sortBy method.
      */
-
     const sortedItems = (0, _filtering.sort)({
       model,
       plugins,
@@ -682,7 +634,6 @@ const createEntriesStorageOperations = params => {
      * Although we do not need a cursor here, we will use it as such to keep it standardized.
      * Number is simply encoded.
      */
-
     const cursor = totalCount > start + limit ? (0, _cursor.encodeCursor)(`${start + limit}`) : null;
     return {
       hasMoreItems,
@@ -691,8 +642,8 @@ const createEntriesStorageOperations = params => {
       items: (0, _cleanup.cleanupItems)(entity, slicedItems)
     };
   };
-
-  const get = async (model, params) => {
+  const get = async (initialModel, params) => {
+    const model = getStorageOperationsModel(initialModel);
     const {
       items
     } = await list(model, (0, _objectSpread2.default)((0, _objectSpread2.default)({}, params), {}, {
@@ -700,21 +651,21 @@ const createEntriesStorageOperations = params => {
     }));
     return items.shift() || null;
   };
-
-  const publish = async (model, params) => {
+  const publish = async (initialModel, params) => {
     const {
       entry,
       storageEntry: initialStorageEntry
     } = params;
+    const model = getStorageOperationsModel(initialModel);
     const partitionKey = (0, _keys.createPartitionKey)({
       id: entry.id,
       locale: model.locale,
       tenant: model.tenant
     });
+
     /**
-     * We need the latest and published entries to see if something needs to be updated along side the publishing one.
+     * We need the latest and published entries to see if something needs to be updated alongside the publishing one.
      */
-
     const initialLatestStorageEntry = await getLatestRevisionByEntryId(model, entry);
     const initialPublishedStorageEntry = await getPublishedRevisionByEntryId(model, entry);
     const storageEntry = convertToStorageEntry({
@@ -725,10 +676,9 @@ const createEntriesStorageOperations = params => {
      * We need to update:
      *  - current entry revision sort key
      *  - published sort key
-     *  - latest sort key - if entry updated is actually latest
+     *  - the latest sort key - if entry updated is actually latest
      *  - previous published entry to unpublished status - if any previously published entry
      */
-
     const items = [entity.putBatch((0, _objectSpread2.default)((0, _objectSpread2.default)({}, storageEntry), {}, {
       PK: partitionKey,
       SK: (0, _keys.createRevisionSortKey)(entry),
@@ -742,7 +692,6 @@ const createEntriesStorageOperations = params => {
       GSI1_PK: (0, _keys.createGSIPartitionKey)(model, "P"),
       GSI1_SK: (0, _keys.createGSISortKey)(entry)
     }))];
-
     if (initialLatestStorageEntry && entry.id === initialLatestStorageEntry.id) {
       items.push(entity.putBatch((0, _objectSpread2.default)((0, _objectSpread2.default)({}, storageEntry), {}, {
         PK: partitionKey,
@@ -752,7 +701,6 @@ const createEntriesStorageOperations = params => {
         GSI1_SK: (0, _keys.createGSISortKey)(entry)
       })));
     }
-
     if (initialPublishedStorageEntry && initialPublishedStorageEntry.id !== entry.id) {
       const publishedStorageEntry = convertToStorageEntry({
         storageEntry: initialPublishedStorageEntry,
@@ -767,7 +715,6 @@ const createEntriesStorageOperations = params => {
         GSI1_SK: (0, _keys.createGSISortKey)(publishedStorageEntry)
       })));
     }
-
     try {
       await (0, _batchWrite.batchWriteAll)({
         table: entity.table,
@@ -785,12 +732,12 @@ const createEntriesStorageOperations = params => {
       });
     }
   };
-
-  const unpublish = async (model, params) => {
+  const unpublish = async (initialModel, params) => {
     const {
       entry,
       storageEntry: initialStorageEntry
     } = params;
+    const model = getStorageOperationsModel(initialModel);
     const partitionKey = (0, _keys.createPartitionKey)({
       id: entry.id,
       locale: model.locale,
@@ -804,9 +751,8 @@ const createEntriesStorageOperations = params => {
      * We need to:
      *  - delete currently published entry
      *  - update current entry revision with new data
-     *  - update latest entry status - if entry being unpublished is latest
+     *  - update the latest entry status - if entry being unpublished is latest
      */
-
     const items = [entity.deleteBatch({
       PK: partitionKey,
       SK: (0, _keys.createPublishedSortKey)()
@@ -817,12 +763,11 @@ const createEntriesStorageOperations = params => {
       GSI1_PK: (0, _keys.createGSIPartitionKey)(model, "A"),
       GSI1_SK: (0, _keys.createGSISortKey)(entry)
     }))];
+
     /**
-     * We need the latest entry to see if something needs to be updated along side the unpublishing one.
+     * We need the latest entry to see if something needs to be updated alongside the unpublishing one.
      */
-
     const latestStorageEntry = await getLatestRevisionByEntryId(model, entry);
-
     if (latestStorageEntry && entry.id === latestStorageEntry.id) {
       items.push(entity.putBatch((0, _objectSpread2.default)((0, _objectSpread2.default)({}, storageEntry), {}, {
         PK: partitionKey,
@@ -832,7 +777,6 @@ const createEntriesStorageOperations = params => {
         GSI1_SK: (0, _keys.createGSISortKey)(entry)
       })));
     }
-
     try {
       await (0, _batchWrite.batchWriteAll)({
         table: entity.table,
@@ -849,7 +793,6 @@ const createEntriesStorageOperations = params => {
       });
     }
   };
-
   return {
     create,
     createRevisionFrom,
@@ -870,5 +813,4 @@ const createEntriesStorageOperations = params => {
     unpublish
   };
 };
-
 exports.createEntriesStorageOperations = createEntriesStorageOperations;