@webiny/api-headless-cms 5.40.0-beta.2 → 5.40.0-beta.4

package/crud/contentEntry.crud.js

@@ -18,12 +18,8 @@ var _searchableFields = require("./contentEntry/searchableFields");
 var _filterAsync = require("../utils/filterAsync");
 var _constants = require("../constants");
 var _entryDataFactories = require("./contentEntry/entryDataFactories");
-const createSort = sort => {
-  if (Array.isArray(sort) && sort.filter(Boolean).length > 0) {
-    return sort;
-  }
-  return ["revisionCreatedOn_DESC"];
-};
+var _useCases = require("./contentEntry/useCases");
+var _ContentEntryTraverser = require("../utils/contentEntryTraverser/ContentEntryTraverser");
 const createContentEntryCrud = params => {
   const {
     storageOperations,
@@ -90,6 +86,13 @@ const createContentEntryCrud = params => {
   const onEntryAfterDelete = (0, _pubsub.createTopic)("cms.onEntryAfterDelete");
   const onEntryDeleteError = (0, _pubsub.createTopic)("cms.onEntryDeleteError");
 
+  /**
+   * Restore from bin
+   */
+  const onEntryBeforeRestoreFromBin = (0, _pubsub.createTopic)("cms.onEntryBeforeRestoreFromBin");
+  const onEntryAfterRestoreFromBin = (0, _pubsub.createTopic)("cms.onEntryAfterRestoreFromBin");
+  const onEntryRestoreFromBinError = (0, _pubsub.createTopic)("cms.onEntryRestoreFromBinError");
+
   /**
    * Delete revision
    */
@@ -130,55 +133,141 @@ const createContentEntryCrud = params => {
   });
 
   /**
-   * A helper to delete the entire entry.
+   * List entries
    */
-  const deleteEntryHelper = async params => {
-    const {
-      model,
-      entry
-    } = params;
-    try {
-      await onEntryBeforeDelete.publish({
-        entry,
-        model
-      });
-      await storageOperations.entries.delete(model, {
-        entry
-      });
-      await onEntryAfterDelete.publish({
-        entry,
-        model
-      });
-    } catch (ex) {
-      await onEntryDeleteError.publish({
-        entry,
-        model,
-        error: ex
-      });
-      throw new _error.default(ex.message || "Could not delete entry.", ex.code || "DELETE_ERROR", {
-        entry
-      });
-    }
-  };
+  const {
+    listEntriesUseCase,
+    listLatestUseCase,
+    listDeletedUseCase,
+    listPublishedUseCase,
+    getEntryUseCase
+  } = (0, _useCases.listEntriesUseCases)({
+    operation: storageOperations.entries["list"],
+    accessControl,
+    topics: {
+      onEntryBeforeList
+    },
+    context,
+    getIdentity: getSecurityIdentity
+  });
+
   /**
-   * A helper to get entries by revision IDs
+   * Get entries by ids
    */
-  const getEntriesByIds = async (model, ids) => {
-    return context.benchmark.measure("headlessCms.crud.entries.getEntriesByIds", async () => {
-      await accessControl.ensureCanAccessEntry({
-        model
-      });
-      const entries = await storageOperations.entries.getByIds(model, {
-        ids
-      });
-      return (0, _filterAsync.filterAsync)(entries, async entry => {
-        return accessControl.canAccessEntry({
-          model,
-          entry
-        });
-      });
-    });
-  };
+  const {
+    getEntriesByIdsUseCase
+  } = (0, _useCases.getEntriesByIdsUseCases)({
+    operation: storageOperations.entries.getByIds,
+    accessControl
+  });
+
+  /**
+   * Get latest entries by ids
+   */
+  const {
+    getLatestEntriesByIdsUseCase
+  } = (0, _useCases.getLatestEntriesByIdsUseCases)({
+    operation: storageOperations.entries.getLatestByIds,
+    accessControl
+  });
+
+  /**
+   * Get published entries by ids
+   */
+  const {
+    getPublishedEntriesByIdsUseCase
+  } = (0, _useCases.getPublishedEntriesByIdsUseCases)({
+    operation: storageOperations.entries.getPublishedByIds,
+    accessControl
+  });
+
+  /**
+   * Get revisions by entryId
+   */
+  const {
+    getRevisionsByEntryIdUseCase
+  } = (0, _useCases.getRevisionsByEntryIdUseCases)({
+    operation: storageOperations.entries.getRevisions,
+    accessControl
+  });
+
+  /**
+   * Get revision by id
+   */
+  const {
+    getRevisionByIdUseCase
+  } = (0, _useCases.getRevisionByIdUseCases)({
+    operation: storageOperations.entries.getRevisionById
+  });
+
+  /**
+   * Get latest revision by entryId
+   */
+  const {
+    getLatestRevisionByEntryIdUseCase,
+    getLatestRevisionByEntryIdWithDeletedUseCase,
+    getLatestRevisionByEntryIdDeletedUseCase
+  } = (0, _useCases.getLatestRevisionByEntryIdUseCases)({
+    operation: storageOperations.entries.getLatestRevisionByEntryId
+  });
+
+  /**
+   * Get previous revision by entryId
+   */
+  const {
+    getPreviousRevisionByEntryIdUseCase
+  } = (0, _useCases.getPreviousRevisionByEntryIdUseCases)({
+    operation: storageOperations.entries.getPreviousRevision
+  });
+
+  /**
+   * Get published revision by entryId
+   */
+  const {
+    getPublishedRevisionByEntryIdUseCase
+  } = (0, _useCases.getPublishedRevisionByEntryIdUseCases)({
+    operation: storageOperations.entries.getPublishedRevisionByEntryId
+  });
+
+  /**
+   * Delete entry
+   */
+  const {
+    deleteEntryUseCase,
+    moveEntryToBinUseCase,
+    deleteEntryOperation
+  } = (0, _useCases.deleteEntryUseCases)({
+    deleteOperation: storageOperations.entries.delete,
+    moveToBinOperation: storageOperations.entries.moveToBin,
+    getEntry: getLatestRevisionByEntryIdUseCase,
+    getEntryWithDeleted: getLatestRevisionByEntryIdWithDeletedUseCase,
+    getIdentity: getSecurityIdentity,
+    topics: {
+      onEntryBeforeDelete,
+      onEntryAfterDelete,
+      onEntryDeleteError
+    },
+    accessControl,
+    context
+  });
+
+  /**
+   * Restore entry from bin
+   */
+  const {
+    restoreEntryFromBinUseCase
+  } = (0, _useCases.restoreEntryFromBinUseCases)({
+    restoreOperation: storageOperations.entries.restoreFromBin,
+    getEntry: getLatestRevisionByEntryIdDeletedUseCase,
+    getIdentity: getSecurityIdentity,
+    topics: {
+      onEntryBeforeRestoreFromBin,
+      onEntryAfterRestoreFromBin,
+      onEntryRestoreFromBinError
+    },
+    accessControl,
+    context
+  });
   const getEntryById = async (model, id) => {
     const where = {
       id
@@ -187,148 +276,14 @@ const createContentEntryCrud = params => {
       where,
       model
     });
-    const [entry] = await getEntriesByIds(model, [id]);
+    const [entry] = await getEntriesByIdsUseCase.execute(model, {
+      ids: [id]
+    });
     if (!entry) {
       throw new _handlerGraphql.NotFoundError(`Entry by ID "${id}" not found.`);
     }
     return entry;
   };
-  const getPublishedEntriesByIds = async (model, ids) => {
-    await accessControl.ensureCanAccessEntry({
-      model
-    });
-    const entries = await storageOperations.entries.getPublishedByIds(model, {
-      ids
-    });
-    return (0, _filterAsync.filterAsync)(entries, async entry => {
-      return accessControl.canAccessEntry({
-        model,
-        entry
-      });
-    });
-  };
-  const getLatestEntriesByIds = async (model, ids) => {
-    await accessControl.ensureCanAccessEntry({
-      model
-    });
-    const entries = await storageOperations.entries.getLatestByIds(model, {
-      ids
-    });
-    return (0, _filterAsync.filterAsync)(entries, async entry => {
-      return accessControl.canAccessEntry({
-        model,
-        entry
-      });
-    });
-  };
-  const getEntry = async (model, params) => {
-    await accessControl.ensureCanAccessEntry({
-      model
-    });
-    const {
-      where,
-      sort
-    } = params;
-    await onEntryBeforeGet.publish({
-      where,
-      model
-    });
-    const [items] = await listEntries(model, {
-      where,
-      sort,
-      limit: 1
-    });
-    const item = items.shift();
-    if (!item) {
-      throw new _handlerGraphql.NotFoundError(`Entry not found!`);
-    }
-    return item;
-  };
-  const getEntryRevisions = async (model, entryId) => {
-    return storageOperations.entries.getRevisions(model, {
-      id: entryId
-    });
-  };
-  const listEntries = async (model, params) => {
-    await accessControl.ensureCanAccessEntry({
-      model
-    });
-    const {
-      where: initialWhere,
-      limit: initialLimit
-    } = params;
-    const limit = initialLimit && initialLimit > 0 ? initialLimit : 50;
-    const where = {
-      ...initialWhere
-    };
-    /**
-     * Possibly only get records which are owned by current user.
-     * Or if searching for the owner set that value - in the case that user can see other entries than their own.
-     */
-    if (await accessControl.canAccessOnlyOwnedEntries({
-      model
-    })) {
-      where.createdBy = getSecurityIdentity().id;
-    }
-
-    /**
-     * Where must contain either latest or published keys.
-     * We cannot list entries without one of those
-     */
-    if (where.latest && where.published) {
-      throw new _error.default("Cannot list entries that are both published and latest.", "LIST_ENTRIES_ERROR", {
-        where
-      });
-    } else if (!where.latest && !where.published) {
-      throw new _error.default("Cannot list entries if we do not have latest or published defined.", "LIST_ENTRIES_ERROR", {
-        where
-      });
-    }
-    const fields = (0, _searchableFields.getSearchableFields)({
-      fields: model.fields,
-      plugins: context.plugins,
-      input: params.fields || []
-    });
-    try {
-      await onEntryBeforeList.publish({
-        where,
-        model
-      });
-      const {
-        hasMoreItems,
-        totalCount,
-        cursor,
-        items
-      } = await storageOperations.entries.list(model, {
-        ...params,
-        sort: createSort(params.sort),
-        limit,
-        where,
-        fields
-      });
-      const meta = {
-        hasMoreItems,
-        totalCount,
-        /**
-         * Cursor should be null if there are no more items to load.
-         * Just make sure of that, disregarding what is returned from the storageOperations.entries.list method.
-         */
-        cursor: hasMoreItems ? cursor : null
-      };
-      return [items, meta];
-    } catch (ex) {
-      throw new _error.default("Error while fetching entries from storage.", "LIST_ENTRIES_ERROR", {
-        params,
-        error: {
-          message: ex.message,
-          code: ex.code,
-          data: ex.data
-        },
-        model,
-        fields
-      });
-    }
-  };
   const createEntry = async (model, rawInput, options) => {
     await accessControl.ensureCanAccessEntry({
       model,
@@ -398,10 +353,10 @@ const createContentEntryCrud = params => {
     const {
       id: uniqueId
     } = (0, _utils.parseIdentifier)(sourceId);
-    const originalStorageEntry = await storageOperations.entries.getRevisionById(model, {
+    const originalStorageEntry = await getRevisionByIdUseCase.execute(model, {
       id: sourceId
     });
-    const latestStorageEntry = await storageOperations.entries.getLatestRevisionByEntryId(model, {
+    const latestStorageEntry = await getLatestRevisionByEntryIdUseCase.execute(model, {
       id: uniqueId
     });
     if (!originalStorageEntry) {
@@ -483,7 +438,7 @@ const createContentEntryCrud = params => {
     /**
      * The entry we are going to update.
      */
-    const originalStorageEntry = await storageOperations.entries.getRevisionById(model, {
+    const originalStorageEntry = await getRevisionByIdUseCase.execute(model, {
       id
     });
     if (!originalStorageEntry) {
@@ -560,7 +515,7 @@ const createContentEntryCrud = params => {
       /**
        * The entry we are going to update.
        */
-      const originalStorageEntry = await storageOperations.entries.getRevisionById(model, {
+      const originalStorageEntry = await getRevisionByIdUseCase.execute(model, {
         id
       });
       if (!originalStorageEntry) {
@@ -590,7 +545,7 @@ const createContentEntryCrud = params => {
     /**
      * The entry we are going to move to another folder.
      */
-    const originalStorageEntry = await storageOperations.entries.getRevisionById(model, {
+    const originalStorageEntry = await getRevisionByIdUseCase.execute(model, {
       id
     });
     if (!originalStorageEntry) {
@@ -645,7 +600,7 @@ const createContentEntryCrud = params => {
     /**
      * Fetch the entry from the storage.
      */
-    const originalStorageEntry = await storageOperations.entries.getRevisionById(model, {
+    const originalStorageEntry = await getRevisionByIdUseCase.execute(model, {
       id
     });
     if (!originalStorageEntry) {
@@ -718,13 +673,13 @@ const createContentEntryCrud = params => {
       id: entryId,
       version
     } = (0, _utils.parseIdentifier)(revisionId);
-    const storageEntryToDelete = await storageOperations.entries.getRevisionById(model, {
+    const storageEntryToDelete = await getRevisionByIdUseCase.execute(model, {
       id: revisionId
     });
-    const latestStorageEntry = await storageOperations.entries.getLatestRevisionByEntryId(model, {
+    const latestStorageEntry = await getLatestRevisionByEntryIdUseCase.execute(model, {
       id: entryId
     });
-    const storagePreviousEntry = await storageOperations.entries.getPreviousRevision(model, {
+    const storagePreviousEntry = await getPreviousRevisionByEntryIdUseCase.execute(model, {
       entryId,
       version: version
     });
@@ -744,8 +699,7 @@ const createContentEntryCrud = params => {
      * to run full delete with hooks. In this case, `deleteRevision` hooks are not fired.
      */
     if (entryToDelete.id === latestEntryRevisionId && !storagePreviousEntry) {
-      return await deleteEntryHelper({
-        model,
+      return await deleteEntryOperation.execute(model, {
         entry: entryToDelete
       });
     }
@@ -877,59 +831,25 @@ const createContentEntryCrud = params => {
       });
     }
   };
-  const deleteEntry = async (model, id, options) => {
-    await accessControl.ensureCanAccessEntry({
-      model,
-      rwd: "d"
-    });
+  const deleteEntry = async (model, id, options = {}) => {
     const {
-      force
-    } = options || {};
-    const storageEntry = await storageOperations.entries.getLatestRevisionByEntryId(model, {
-      id
-    });
+      permanently = true
+    } = options;
+
     /**
-     * If there is no entry, and we do not force the deletion, just throw an error.
+     * If the 'permanently' flag is set to false, the entry must be moved to the bin; otherwise, deleted.
      */
-    if (!storageEntry && !force) {
-      throw new _handlerGraphql.NotFoundError(`Entry "${id}" was not found!`);
+    if (!permanently) {
+      return await moveEntryToBinUseCase.execute(model, id, options);
     }
-    /**
-     * In the case we are forcing the deletion, we do not need the storageEntry to exist as it might be an error when loading single database record.
-     *
-     * This happens, sometimes, in the Elasticsearch system as the entry might get deleted from the DynamoDB but not from the Elasticsearch.
-     * This is due to high load on the Elasticsearch at the time of the deletion.
-     */
-    //
-    else if (!storageEntry && force) {
-      const {
-        id: entryId
-      } = (0, _utils.parseIdentifier)(id);
-      return await deleteEntryHelper({
-        model,
-        entry: {
-          id,
-          entryId
-        }
-      });
-    }
-    const entry = await (0, _entryStorage.entryFromStorageTransform)(context, model, storageEntry);
-    await accessControl.ensureCanAccessEntry({
-      model,
-      entry,
-      rwd: "d"
-    });
-    return await deleteEntryHelper({
-      model,
-      entry
-    });
+    return await deleteEntryUseCase.execute(model, id, options);
   };
   const publishEntry = async (model, id) => {
     await accessControl.ensureCanAccessEntry({
       model,
       pw: "p"
     });
-    const originalStorageEntry = await storageOperations.entries.getRevisionById(model, {
+    const originalStorageEntry = await getRevisionByIdUseCase.execute(model, {
       id
     });
     if (!originalStorageEntry) {
@@ -943,7 +863,7 @@ const createContentEntryCrud = params => {
     });
 
     // We need the latest entry to get the latest entry-level meta fields.
-    const latestStorageEntry = await storageOperations.entries.getLatestRevisionByEntryId(model, {
+    const latestStorageEntry = await getLatestRevisionByEntryIdUseCase.execute(model, {
       id: originalEntry.entryId
     });
     if (!latestStorageEntry) {
@@ -1002,7 +922,7 @@ const createContentEntryCrud = params => {
     const {
       id: entryId
     } = (0, _utils.parseIdentifier)(id);
-    const originalStorageEntry = await storageOperations.entries.getPublishedRevisionByEntryId(model, {
+    const originalStorageEntry = await getPublishedRevisionByEntryIdUseCase.execute(model, {
       id: entryId
     });
     if (!originalStorageEntry) {
@@ -1123,7 +1043,17 @@ const createContentEntryCrud = params => {
       });
     }
   };
+  const getEntryTraverser = async modelId => {
+    const modelAstConverter = context.cms.getModelToAstConverter();
+    const model = await context.cms.getModel(modelId);
+    if (!model) {
+      throw new Error(`Missing "${modelId}" model!`);
+    }
+    const modelAst = modelAstConverter.toAst(model);
+    return new _ContentEntryTraverser.ContentEntryTraverser(modelAst);
+  };
   return {
+    getEntryTraverser,
     onEntryBeforeCreate,
     onEntryAfterCreate,
     onEntryCreateError,
@@ -1139,6 +1069,9 @@ const createContentEntryCrud = params => {
     onEntryBeforeDelete,
     onEntryAfterDelete,
     onEntryDeleteError,
+    onEntryBeforeRestoreFromBin,
+    onEntryAfterRestoreFromBin,
+    onEntryRestoreFromBinError,
     onEntryRevisionBeforeDelete,
     onEntryRevisionAfterDelete,
     onEntryRevisionDeleteError,
@@ -1156,7 +1089,13 @@ const createContentEntryCrud = params => {
     /**
      * Get entries by exact revision IDs from the database.
      */
-    getEntriesByIds,
+    async getEntriesByIds(model, ids) {
+      return context.benchmark.measure("headlessCms.crud.entries.getEntriesByIds", async () => {
+        return getEntriesByIdsUseCase.execute(model, {
+          ids
+        });
+      });
+    },
     /**
      * Get a single entry by revision ID from the database.
      */
@@ -1170,7 +1109,9 @@ const createContentEntryCrud = params => {
      */
     async getPublishedEntriesByIds(model, ids) {
       return context.benchmark.measure("headlessCms.crud.entries.getPublishedEntriesByIds", async () => {
-        return getPublishedEntriesByIds(model, ids);
+        return getPublishedEntriesByIdsUseCase.execute(model, {
+          ids
+        });
       });
     },
     /**
@@ -1178,22 +1119,24 @@ const createContentEntryCrud = params => {
      */
     async getLatestEntriesByIds(model, ids) {
       return context.benchmark.measure("headlessCms.crud.entries.getLatestEntriesByIds", async () => {
-        return getLatestEntriesByIds(model, ids);
+        return getLatestEntriesByIdsUseCase.execute(model, {
+          ids
+        });
       });
     },
     async getEntryRevisions(model, entryId) {
       return context.benchmark.measure("headlessCms.crud.entries.getEntryRevisions", async () => {
-        return getEntryRevisions(model, entryId);
+        return getRevisionsByEntryIdUseCase.execute(model, {
+          id: entryId
+        });
       });
     },
     /**
-     * TODO determine if this method is required at all.
-     *
      * @internal
      */
     async getEntry(model, params) {
       return context.benchmark.measure("headlessCms.crud.entries.getEntry", async () => {
-        return getEntry(model, params);
+        return await getEntryUseCase.execute(model, params);
       });
     },
     /**
@@ -1203,29 +1146,22 @@ const createContentEntryCrud = params => {
      */
     async listEntries(model, params) {
       return context.benchmark.measure("headlessCms.crud.entries.listEntries", async () => {
-        return listEntries(model, params);
+        return await listEntriesUseCase.execute(model, params);
       });
     },
     async listLatestEntries(model, params) {
-      const where = params?.where || {};
-      return this.listEntries(model, {
-        sort: ["createdOn_DESC"],
-        ...(params || {}),
-        where: {
-          ...where,
-          latest: true
-        }
+      return context.benchmark.measure("headlessCms.crud.entries.listLatestEntries", async () => {
+        return await listLatestUseCase.execute(model, params);
+      });
+    },
+    async listDeletedEntries(model, params) {
+      return context.benchmark.measure("headlessCms.crud.entries.listDeletedEntries", async () => {
+        return await listDeletedUseCase.execute(model, params);
       });
     },
     async listPublishedEntries(model, params) {
-      const where = params?.where || {};
-      return this.listEntries(model, {
-        sort: ["createdOn_DESC"],
-        ...(params || {}),
-        where: {
-          ...where,
-          published: true
-        }
+      return context.benchmark.measure("headlessCms.crud.entries.listPublishedEntries", async () => {
+        return await listPublishedUseCase.execute(model, params);
       });
     },
     async createEntry(model, input, options) {
@@ -1272,6 +1208,11 @@ const createContentEntryCrud = params => {
         return deleteEntry(model, entryId, options);
       });
     },
+    async restoreEntryFromBin(model, entryId) {
+      return context.benchmark.measure("headlessCms.crud.entries.restoreEntryFromBin", async () => {
+        return await restoreEntryFromBinUseCase.execute(model, entryId);
+      });
+    },
     async deleteMultipleEntries(model, ids) {
       return context.benchmark.measure("headlessCms.crud.entries.deleteMultipleEntries", async () => {
         return deleteMultipleEntries(model, ids);