@strapi/content-manager 0.0.0-next.6d1dbc97a99dbfe8847598f6cbea3f7a1df2c89c → 0.0.0-next.6e916d54c383bac6dfc70465a86b5436a698d516

package/dist/server/history/services/lifecycles.js

@@ -0,0 +1,156 @@
+'use strict';
+
+var strapiUtils = require('@strapi/utils');
+var fp = require('lodash/fp');
+var nodeSchedule = require('node-schedule');
+var utils$1 = require('../utils.js');
+var constants = require('../constants.js');
+var utils = require('./utils.js');
+
+/**
+ * Filters out actions that should not create a history version.
+ */ const shouldCreateHistoryVersion = (context)=>{
+    // Ignore requests that are not related to the content manager
+    if (!strapi.requestContext.get()?.request.url.startsWith('/content-manager')) {
+        return false;
+    }
+    // NOTE: cannot do type narrowing with array includes
+    if (context.action !== 'create' && context.action !== 'update' && context.action !== 'clone' && context.action !== 'publish' && context.action !== 'unpublish' && context.action !== 'discardDraft') {
+        return false;
+    }
+    /**
+   * When a document is published, the draft version of the document is also updated.
+   * It creates confusion for users because they see two history versions each publish action.
+   * To avoid this, we silence the update action during a publish request,
+   * so that they only see the published version of the document in the history.
+   */ if (context.action === 'update' && strapi.requestContext.get()?.request.url.endsWith('/actions/publish')) {
+        return false;
+    }
+    // Ignore content types not created by the user
+    if (!context.contentType.uid.startsWith('api::')) {
+        return false;
+    }
+    return true;
+};
+/**
+ * Returns the content type schema (and its components schemas).
+ * Used to determine if changes were made in the content type builder since a history version was created.
+ * And therefore which fields can be restored and which cannot.
+ */ const getSchemas = (uid)=>{
+    const attributesSchema = strapi.getModel(uid).attributes;
+    // TODO: Handle nested components
+    const componentsSchemas = Object.keys(attributesSchema).reduce((currentComponentSchemas, key)=>{
+        const fieldSchema = attributesSchema[key];
+        if (fieldSchema.type === 'component') {
+            const componentSchema = strapi.getModel(fieldSchema.component).attributes;
+            return {
+                ...currentComponentSchemas,
+                [fieldSchema.component]: componentSchema
+            };
+        }
+        // Ignore anything that's not a component
+        return currentComponentSchemas;
+    }, {});
+    return {
+        schema: fp.omit(constants.FIELDS_TO_IGNORE, attributesSchema),
+        componentsSchemas
+    };
+};
+const createLifecyclesService = ({ strapi: strapi1 })=>{
+    const state = {
+        deleteExpiredJob: null,
+        isInitialized: false
+    };
+    const serviceUtils = utils.createServiceUtils({
+        strapi: strapi1
+    });
+    const { persistTablesWithPrefix } = strapi1.service('admin::persist-tables');
+    return {
+        async bootstrap () {
+            // Prevent initializing the service twice
+            if (state.isInitialized) {
+                return;
+            }
+            // Avoid data loss in case users temporarily don't have a license
+            await persistTablesWithPrefix('strapi_history_versions');
+            strapi1.documents.use(async (context, next)=>{
+                const result = await next();
+                if (!shouldCreateHistoryVersion(context)) {
+                    return result;
+                }
+                // On create/clone actions, the documentId is not available before creating the action is executed
+                const documentId = context.action === 'create' || context.action === 'clone' ? result.documentId : context.params.documentId;
+                // Apply default locale if not available in the request
+                const defaultLocale = await serviceUtils.getDefaultLocale();
+                const locales = fp.castArray(context.params?.locale || defaultLocale);
+                if (!locales.length) {
+                    return result;
+                }
+                // All schemas related to the content type
+                const uid = context.contentType.uid;
+                const schemas = getSchemas(uid);
+                const model = strapi1.getModel(uid);
+                const isLocalizedContentType = serviceUtils.isLocalizedContentType(model);
+                // Find all affected entries
+                const localeEntries = await strapi1.db.query(uid).findMany({
+                    where: {
+                        documentId,
+                        ...isLocalizedContentType ? {
+                            locale: {
+                                $in: locales
+                            }
+                        } : {},
+                        ...strapiUtils.contentTypes.hasDraftAndPublish(strapi1.contentTypes[uid]) ? {
+                            publishedAt: null
+                        } : {}
+                    },
+                    populate: serviceUtils.getDeepPopulate(uid, true)
+                });
+                await strapi1.db.transaction(async ({ onCommit })=>{
+                    // .createVersion() is executed asynchronously,
+                    // onCommit prevents creating a history version
+                    // when the transaction has already been committed
+                    onCommit(async ()=>{
+                        for (const entry of localeEntries){
+                            const status = await serviceUtils.getVersionStatus(uid, entry);
+                            await utils$1.getService(strapi1, 'history').createVersion({
+                                contentType: uid,
+                                data: fp.omit(constants.FIELDS_TO_IGNORE, entry),
+                                relatedDocumentId: documentId,
+                                locale: entry.locale,
+                                status,
+                                ...schemas
+                            });
+                        }
+                    });
+                });
+                return result;
+            });
+            // Schedule a job to delete expired history versions every day at midnight
+            state.deleteExpiredJob = nodeSchedule.scheduleJob('historyDaily', '0 0 * * *', ()=>{
+                const retentionDaysInMilliseconds = serviceUtils.getRetentionDays() * 24 * 60 * 60 * 1000;
+                const expirationDate = new Date(Date.now() - retentionDaysInMilliseconds);
+                strapi1.db.query(constants.HISTORY_VERSION_UID).deleteMany({
+                    where: {
+                        created_at: {
+                            $lt: expirationDate
+                        }
+                    }
+                }).catch((error)=>{
+                    if (error instanceof Error) {
+                        strapi1.log.error('Error deleting expired history versions', error.message);
+                    }
+                });
+            });
+            state.isInitialized = true;
+        },
+        async destroy () {
+            if (state.deleteExpiredJob) {
+                state.deleteExpiredJob.cancel();
+            }
+        }
+    };
+};
+
+exports.createLifecyclesService = createLifecyclesService;
+//# sourceMappingURL=lifecycles.js.map

package/dist/server/history/services/lifecycles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycles.js","sources":["../../../../server/src/history/services/lifecycles.ts"],"sourcesContent":["import type { Core, Modules, UID } from '@strapi/types';\nimport { contentTypes } from '@strapi/utils';\n\nimport { omit, castArray } from 'lodash/fp';\n\nimport { scheduleJob } from 'node-schedule';\n\nimport { getService } from '../utils';\nimport { FIELDS_TO_IGNORE, HISTORY_VERSION_UID } from '../constants';\n\nimport type { CreateHistoryVersion } from '../../../../shared/contracts/history-versions';\nimport { createServiceUtils } from './utils';\n\n/**\n * Filters out actions that should not create a history version.\n */\nconst shouldCreateHistoryVersion = (\n  context: Modules.Documents.Middleware.Context\n): context is Modules.Documents.Middleware.Context & {\n  action: 'create' | 'update' | 'clone' | 'publish' | 'unpublish' | 'discardDraft';\n  contentType: UID.CollectionType;\n} => {\n  // Ignore requests that are not related to the content manager\n  if (!strapi.requestContext.get()?.request.url.startsWith('/content-manager')) {\n    return false;\n  }\n\n  // NOTE: cannot do type narrowing with array includes\n  if (\n    context.action !== 'create' &&\n    context.action !== 'update' &&\n    context.action !== 'clone' &&\n    context.action !== 'publish' &&\n    context.action !== 'unpublish' &&\n    context.action !== 'discardDraft'\n  ) {\n    return false;\n  }\n\n  /**\n   * When a document is published, the draft version of the document is also updated.\n   * It creates confusion for users because they see two history versions each publish action.\n   * To avoid this, we silence the update action during a publish request,\n   * so that they only see the published version of the document in the history.\n   */\n  if (\n    context.action === 'update' &&\n    strapi.requestContext.get()?.request.url.endsWith('/actions/publish')\n  ) {\n    return false;\n  }\n\n  // Ignore content types not created by the user\n  if (!context.contentType.uid.startsWith('api::')) {\n    return false;\n  }\n\n  return true;\n};\n\n/**\n * Returns the content type schema (and its components schemas).\n * Used to determine if changes were made in the content type builder since a history version was created.\n * And therefore which fields can be restored and which cannot.\n */\nconst getSchemas = (uid: UID.CollectionType) => {\n  const attributesSchema = strapi.getModel(uid).attributes;\n\n  // TODO: Handle nested components\n  const componentsSchemas = Object.keys(attributesSchema).reduce(\n    (currentComponentSchemas, key) => {\n      const fieldSchema = attributesSchema[key];\n\n      if (fieldSchema.type === 'component') {\n        const componentSchema = strapi.getModel(fieldSchema.component).attributes;\n        return {\n          ...currentComponentSchemas,\n          [fieldSchema.component]: componentSchema,\n        };\n      }\n\n      // Ignore anything that's not a component\n      return currentComponentSchemas;\n    },\n    {} as CreateHistoryVersion['componentsSchemas']\n  );\n\n  return {\n    schema: omit(FIELDS_TO_IGNORE, attributesSchema) as CreateHistoryVersion['schema'],\n    componentsSchemas,\n  };\n};\n\nconst createLifecyclesService = ({ strapi }: { strapi: Core.Strapi }) => {\n  const state: {\n    deleteExpiredJob: ReturnType<typeof scheduleJob> | null;\n    isInitialized: boolean;\n  } = {\n    deleteExpiredJob: null,\n    isInitialized: false,\n  };\n\n  const serviceUtils = createServiceUtils({ strapi });\n  const { persistTablesWithPrefix } = strapi.service('admin::persist-tables');\n\n  return {\n    async bootstrap() {\n      // Prevent initializing the service twice\n      if (state.isInitialized) {\n        return;\n      }\n\n      // Avoid data loss in case users temporarily don't have a license\n      await persistTablesWithPrefix('strapi_history_versions');\n\n      strapi.documents.use(async (context, next) => {\n        const result = (await next()) as any;\n\n        if (!shouldCreateHistoryVersion(context)) {\n          return result;\n        }\n\n        // On create/clone actions, the documentId is not available before creating the action is executed\n        const documentId =\n          context.action === 'create' || context.action === 'clone'\n            ? result.documentId\n            : context.params.documentId;\n\n        // Apply default locale if not available in the request\n        const defaultLocale = await serviceUtils.getDefaultLocale();\n        const locales = castArray(context.params?.locale || defaultLocale);\n        if (!locales.length) {\n          return result;\n        }\n\n        // All schemas related to the content type\n        const uid = context.contentType.uid;\n        const schemas = getSchemas(uid);\n        const model = strapi.getModel(uid);\n\n        const isLocalizedContentType = serviceUtils.isLocalizedContentType(model);\n\n        // Find all affected entries\n        const localeEntries = await strapi.db.query(uid).findMany({\n          where: {\n            documentId,\n            ...(isLocalizedContentType ? { locale: { $in: locales } } : {}),\n            ...(contentTypes.hasDraftAndPublish(strapi.contentTypes[uid])\n              ? { publishedAt: null }\n              : {}),\n          },\n          populate: serviceUtils.getDeepPopulate(uid, true /* use database syntax */),\n        });\n\n        await strapi.db.transaction(async ({ onCommit }) => {\n          // .createVersion() is executed asynchronously,\n          // onCommit prevents creating a history version\n          // when the transaction has already been committed\n          onCommit(async () => {\n            for (const entry of localeEntries) {\n              const status = await serviceUtils.getVersionStatus(uid, entry);\n\n              await getService(strapi, 'history').createVersion({\n                contentType: uid,\n                data: omit(FIELDS_TO_IGNORE, entry) as Modules.Documents.AnyDocument,\n                relatedDocumentId: documentId,\n                locale: entry.locale,\n                status,\n                ...schemas,\n              });\n            }\n          });\n        });\n\n        return result;\n      });\n\n      // Schedule a job to delete expired history versions every day at midnight\n      state.deleteExpiredJob = scheduleJob('historyDaily', '0 0 * * *', () => {\n        const retentionDaysInMilliseconds = serviceUtils.getRetentionDays() * 24 * 60 * 60 * 1000;\n        const expirationDate = new Date(Date.now() - retentionDaysInMilliseconds);\n\n        strapi.db\n          .query(HISTORY_VERSION_UID)\n          .deleteMany({\n            where: {\n              created_at: {\n                $lt: expirationDate,\n              },\n            },\n          })\n          .catch((error) => {\n            if (error instanceof Error) {\n              strapi.log.error('Error deleting expired history versions', error.message);\n            }\n          });\n      });\n\n      state.isInitialized = true;\n    },\n\n    async destroy() {\n      if (state.deleteExpiredJob) {\n        state.deleteExpiredJob.cancel();\n      }\n    },\n  };\n};\n\nexport { createLifecyclesService };\n"],"names":["shouldCreateHistoryVersion","context","strapi","requestContext","get","request","url","startsWith","action","endsWith","contentType","uid","getSchemas","attributesSchema","getModel","attributes","componentsSchemas","Object","keys","reduce","currentComponentSchemas","key","fieldSchema","type","componentSchema","component","schema","omit","FIELDS_TO_IGNORE","createLifecyclesService","state","deleteExpiredJob","isInitialized","serviceUtils","createServiceUtils","persistTablesWithPrefix","service","bootstrap","documents","use","next","result","documentId","params","defaultLocale","getDefaultLocale","locales","castArray","locale","length","schemas","model","isLocalizedContentType","localeEntries","db","query","findMany","where","$in","contentTypes","hasDraftAndPublish","publishedAt","populate","getDeepPopulate","transaction","onCommit","entry","status","getVersionStatus","getService","createVersion","data","relatedDocumentId","scheduleJob","retentionDaysInMilliseconds","getRetentionDays","expirationDate","Date","now","HISTORY_VERSION_UID","deleteMany","created_at","$lt","catch","error","Error","log","message","destroy","cancel"],"mappings":";;;;;;;;;AAaA;;IAGA,MAAMA,6BAA6B,CACjCC,OAAAA,GAAAA;;IAMA,IAAI,CAACC,OAAOC,cAAc,CAACC,GAAG,EAAIC,EAAAA,OAAAA,CAAQC,GAAIC,CAAAA,UAAAA,CAAW,kBAAqB,CAAA,EAAA;QAC5E,OAAO,KAAA;AACT;;IAGA,IACEN,OAAAA,CAAQO,MAAM,KAAK,QAAA,IACnBP,QAAQO,MAAM,KAAK,QACnBP,IAAAA,OAAAA,CAAQO,MAAM,KAAK,WACnBP,OAAQO,CAAAA,MAAM,KAAK,SAAA,IACnBP,OAAQO,CAAAA,MAAM,KAAK,WACnBP,IAAAA,OAAAA,CAAQO,MAAM,KAAK,cACnB,EAAA;QACA,OAAO,KAAA;AACT;AAEA;;;;;AAKC,MACD,IACEP,OAAAA,CAAQO,MAAM,KAAK,QACnBN,IAAAA,MAAAA,CAAOC,cAAc,CAACC,GAAG,EAAA,EAAIC,OAAQC,CAAAA,GAAAA,CAAIG,SAAS,kBAClD,CAAA,EAAA;QACA,OAAO,KAAA;AACT;;IAGA,IAAI,CAACR,QAAQS,WAAW,CAACC,GAAG,CAACJ,UAAU,CAAC,OAAU,CAAA,EAAA;QAChD,OAAO,KAAA;AACT;IAEA,OAAO,IAAA;AACT,CAAA;AAEA;;;;IAKA,MAAMK,aAAa,CAACD,GAAAA,GAAAA;AAClB,IAAA,MAAME,gBAAmBX,GAAAA,MAAAA,CAAOY,QAAQ,CAACH,KAAKI,UAAU;;IAGxD,MAAMC,iBAAAA,GAAoBC,OAAOC,IAAI,CAACL,kBAAkBM,MAAM,CAC5D,CAACC,uBAAyBC,EAAAA,GAAAA,GAAAA;QACxB,MAAMC,WAAAA,GAAcT,gBAAgB,CAACQ,GAAI,CAAA;QAEzC,IAAIC,WAAAA,CAAYC,IAAI,KAAK,WAAa,EAAA;AACpC,YAAA,MAAMC,kBAAkBtB,MAAOY,CAAAA,QAAQ,CAACQ,WAAYG,CAAAA,SAAS,EAAEV,UAAU;YACzE,OAAO;AACL,gBAAA,GAAGK,uBAAuB;gBAC1B,CAACE,WAAAA,CAAYG,SAAS,GAAGD;AAC3B,aAAA;AACF;;QAGA,OAAOJ,uBAAAA;AACT,KAAA,EACA,EAAC,CAAA;IAGH,OAAO;AACLM,QAAAA,MAAAA,EAAQC,QAAKC,0BAAkBf,EAAAA,gBAAAA,CAAAA;AAC/BG,QAAAA;AACF,KAAA;AACF,CAAA;AAEA,MAAMa,uBAA0B,GAAA,CAAC,EAAE3B,MAAAA,EAAAA,OAAM,EAA2B,GAAA;AAClE,IAAA,MAAM4B,KAGF,GAAA;QACFC,gBAAkB,EAAA,IAAA;QAClBC,aAAe,EAAA;AACjB,KAAA;AAEA,IAAA,MAAMC,eAAeC,wBAAmB,CAAA;QAAEhC,MAAAA,EAAAA;AAAO,KAAA,CAAA;AACjD,IAAA,MAAM,EAAEiC,uBAAuB,EAAE,GAAGjC,OAAAA,CAAOkC,OAAO,CAAC,uBAAA,CAAA;IAEnD,OAAO;QACL,MAAMC,SAAAA,CAAAA,GAAAA;;YAEJ,IAAIP,KAAAA,CAAME,aAAa,EAAE;AACvB,gBAAA;AACF;;AAGA,YAAA,MAAMG,uBAAwB,CAAA,yBAAA,CAAA;AAE9BjC,YAAAA,OAAAA,CAAOoC,SAAS,CAACC,GAAG,CAAC,OAAOtC,OAASuC,EAAAA,IAAAA,GAAAA;AACnC,gBAAA,MAAMC,SAAU,MAAMD,IAAAA,EAAAA;gBAEtB,IAAI,CAACxC,2BAA2BC,OAAU,CAAA,EAAA;oBACxC,OAAOwC,MAAAA;AACT;;AAGA,gBAAA,MAAMC,UACJzC,GAAAA,OAAAA,CAAQO,MAAM,KAAK,YAAYP,OAAQO,CAAAA,MAAM,KAAK,OAAA,GAC9CiC,OAAOC,UAAU,GACjBzC,OAAQ0C,CAAAA,MAAM,CAACD,UAAU;;gBAG/B,MAAME,aAAAA,GAAgB,MAAMX,YAAAA,CAAaY,gBAAgB,EAAA;AACzD,gBAAA,MAAMC,OAAUC,GAAAA,YAAAA,CAAU9C,OAAQ0C,CAAAA,MAAM,EAAEK,MAAUJ,IAAAA,aAAAA,CAAAA;gBACpD,IAAI,CAACE,OAAQG,CAAAA,MAAM,EAAE;oBACnB,OAAOR,MAAAA;AACT;;AAGA,gBAAA,MAAM9B,GAAMV,GAAAA,OAAAA,CAAQS,WAAW,CAACC,GAAG;AACnC,gBAAA,MAAMuC,UAAUtC,UAAWD,CAAAA,GAAAA,CAAAA;gBAC3B,MAAMwC,KAAAA,GAAQjD,OAAOY,CAAAA,QAAQ,CAACH,GAAAA,CAAAA;gBAE9B,MAAMyC,sBAAAA,GAAyBnB,YAAamB,CAAAA,sBAAsB,CAACD,KAAAA,CAAAA;;gBAGnE,MAAME,aAAAA,GAAgB,MAAMnD,OAAOoD,CAAAA,EAAE,CAACC,KAAK,CAAC5C,GAAK6C,CAAAA,CAAAA,QAAQ,CAAC;oBACxDC,KAAO,EAAA;AACLf,wBAAAA,UAAAA;AACA,wBAAA,GAAIU,sBAAyB,GAAA;4BAAEJ,MAAQ,EAAA;gCAAEU,GAAKZ,EAAAA;AAAQ;AAAE,yBAAA,GAAI,EAAE;AAC9D,wBAAA,GAAIa,yBAAaC,kBAAkB,CAAC1D,QAAOyD,YAAY,CAAChD,IAAI,CACxD,GAAA;4BAAEkD,WAAa,EAAA;AAAK,yBAAA,GACpB;AACN,qBAAA;oBACAC,QAAU7B,EAAAA,YAAAA,CAAa8B,eAAe,CAACpD,GAAK,EAAA,IAAA;AAC9C,iBAAA,CAAA;gBAEA,MAAMT,OAAAA,CAAOoD,EAAE,CAACU,WAAW,CAAC,OAAO,EAAEC,QAAQ,EAAE,GAAA;;;;oBAI7CA,QAAS,CAAA,UAAA;wBACP,KAAK,MAAMC,SAASb,aAAe,CAAA;AACjC,4BAAA,MAAMc,MAAS,GAAA,MAAMlC,YAAamC,CAAAA,gBAAgB,CAACzD,GAAKuD,EAAAA,KAAAA,CAAAA;AAExD,4BAAA,MAAMG,kBAAWnE,CAAAA,OAAAA,EAAQ,SAAWoE,CAAAA,CAAAA,aAAa,CAAC;gCAChD5D,WAAaC,EAAAA,GAAAA;AACb4D,gCAAAA,IAAAA,EAAM5C,QAAKC,0BAAkBsC,EAAAA,KAAAA,CAAAA;gCAC7BM,iBAAmB9B,EAAAA,UAAAA;AACnBM,gCAAAA,MAAAA,EAAQkB,MAAMlB,MAAM;AACpBmB,gCAAAA,MAAAA;AACA,gCAAA,GAAGjB;AACL,6BAAA,CAAA;AACF;AACF,qBAAA,CAAA;AACF,iBAAA,CAAA;gBAEA,OAAOT,MAAAA;AACT,aAAA,CAAA;;AAGAX,YAAAA,KAAAA,CAAMC,gBAAgB,GAAG0C,wBAAY,CAAA,cAAA,EAAgB,WAAa,EAAA,IAAA;AAChE,gBAAA,MAAMC,8BAA8BzC,YAAa0C,CAAAA,gBAAgB,EAAK,GAAA,EAAA,GAAK,KAAK,EAAK,GAAA,IAAA;AACrF,gBAAA,MAAMC,cAAiB,GAAA,IAAIC,IAAKA,CAAAA,IAAAA,CAAKC,GAAG,EAAKJ,GAAAA,2BAAAA,CAAAA;AAE7CxE,gBAAAA,OAAAA,CAAOoD,EAAE,CACNC,KAAK,CAACwB,6BAAAA,CAAAA,CACNC,UAAU,CAAC;oBACVvB,KAAO,EAAA;wBACLwB,UAAY,EAAA;4BACVC,GAAKN,EAAAA;AACP;AACF;iBAEDO,CAAAA,CAAAA,KAAK,CAAC,CAACC,KAAAA,GAAAA;AACN,oBAAA,IAAIA,iBAAiBC,KAAO,EAAA;AAC1BnF,wBAAAA,OAAAA,CAAOoF,GAAG,CAACF,KAAK,CAAC,yCAAA,EAA2CA,MAAMG,OAAO,CAAA;AAC3E;AACF,iBAAA,CAAA;AACJ,aAAA,CAAA;AAEAzD,YAAAA,KAAAA,CAAME,aAAa,GAAG,IAAA;AACxB,SAAA;QAEA,MAAMwD,OAAAA,CAAAA,GAAAA;YACJ,IAAI1D,KAAAA,CAAMC,gBAAgB,EAAE;gBAC1BD,KAAMC,CAAAA,gBAAgB,CAAC0D,MAAM,EAAA;AAC/B;AACF;AACF,KAAA;AACF;;;;"}

package/dist/server/history/services/lifecycles.mjs

@@ -0,0 +1,154 @@
+import { contentTypes } from '@strapi/utils';
+import { castArray, omit } from 'lodash/fp';
+import { scheduleJob } from 'node-schedule';
+import { getService } from '../utils.mjs';
+import { FIELDS_TO_IGNORE, HISTORY_VERSION_UID } from '../constants.mjs';
+import { createServiceUtils } from './utils.mjs';
+
+/**
+ * Filters out actions that should not create a history version.
+ */ const shouldCreateHistoryVersion = (context)=>{
+    // Ignore requests that are not related to the content manager
+    if (!strapi.requestContext.get()?.request.url.startsWith('/content-manager')) {
+        return false;
+    }
+    // NOTE: cannot do type narrowing with array includes
+    if (context.action !== 'create' && context.action !== 'update' && context.action !== 'clone' && context.action !== 'publish' && context.action !== 'unpublish' && context.action !== 'discardDraft') {
+        return false;
+    }
+    /**
+   * When a document is published, the draft version of the document is also updated.
+   * It creates confusion for users because they see two history versions each publish action.
+   * To avoid this, we silence the update action during a publish request,
+   * so that they only see the published version of the document in the history.
+   */ if (context.action === 'update' && strapi.requestContext.get()?.request.url.endsWith('/actions/publish')) {
+        return false;
+    }
+    // Ignore content types not created by the user
+    if (!context.contentType.uid.startsWith('api::')) {
+        return false;
+    }
+    return true;
+};
+/**
+ * Returns the content type schema (and its components schemas).
+ * Used to determine if changes were made in the content type builder since a history version was created.
+ * And therefore which fields can be restored and which cannot.
+ */ const getSchemas = (uid)=>{
+    const attributesSchema = strapi.getModel(uid).attributes;
+    // TODO: Handle nested components
+    const componentsSchemas = Object.keys(attributesSchema).reduce((currentComponentSchemas, key)=>{
+        const fieldSchema = attributesSchema[key];
+        if (fieldSchema.type === 'component') {
+            const componentSchema = strapi.getModel(fieldSchema.component).attributes;
+            return {
+                ...currentComponentSchemas,
+                [fieldSchema.component]: componentSchema
+            };
+        }
+        // Ignore anything that's not a component
+        return currentComponentSchemas;
+    }, {});
+    return {
+        schema: omit(FIELDS_TO_IGNORE, attributesSchema),
+        componentsSchemas
+    };
+};
+const createLifecyclesService = ({ strapi: strapi1 })=>{
+    const state = {
+        deleteExpiredJob: null,
+        isInitialized: false
+    };
+    const serviceUtils = createServiceUtils({
+        strapi: strapi1
+    });
+    const { persistTablesWithPrefix } = strapi1.service('admin::persist-tables');
+    return {
+        async bootstrap () {
+            // Prevent initializing the service twice
+            if (state.isInitialized) {
+                return;
+            }
+            // Avoid data loss in case users temporarily don't have a license
+            await persistTablesWithPrefix('strapi_history_versions');
+            strapi1.documents.use(async (context, next)=>{
+                const result = await next();
+                if (!shouldCreateHistoryVersion(context)) {
+                    return result;
+                }
+                // On create/clone actions, the documentId is not available before creating the action is executed
+                const documentId = context.action === 'create' || context.action === 'clone' ? result.documentId : context.params.documentId;
+                // Apply default locale if not available in the request
+                const defaultLocale = await serviceUtils.getDefaultLocale();
+                const locales = castArray(context.params?.locale || defaultLocale);
+                if (!locales.length) {
+                    return result;
+                }
+                // All schemas related to the content type
+                const uid = context.contentType.uid;
+                const schemas = getSchemas(uid);
+                const model = strapi1.getModel(uid);
+                const isLocalizedContentType = serviceUtils.isLocalizedContentType(model);
+                // Find all affected entries
+                const localeEntries = await strapi1.db.query(uid).findMany({
+                    where: {
+                        documentId,
+                        ...isLocalizedContentType ? {
+                            locale: {
+                                $in: locales
+                            }
+                        } : {},
+                        ...contentTypes.hasDraftAndPublish(strapi1.contentTypes[uid]) ? {
+                            publishedAt: null
+                        } : {}
+                    },
+                    populate: serviceUtils.getDeepPopulate(uid, true)
+                });
+                await strapi1.db.transaction(async ({ onCommit })=>{
+                    // .createVersion() is executed asynchronously,
+                    // onCommit prevents creating a history version
+                    // when the transaction has already been committed
+                    onCommit(async ()=>{
+                        for (const entry of localeEntries){
+                            const status = await serviceUtils.getVersionStatus(uid, entry);
+                            await getService(strapi1, 'history').createVersion({
+                                contentType: uid,
+                                data: omit(FIELDS_TO_IGNORE, entry),
+                                relatedDocumentId: documentId,
+                                locale: entry.locale,
+                                status,
+                                ...schemas
+                            });
+                        }
+                    });
+                });
+                return result;
+            });
+            // Schedule a job to delete expired history versions every day at midnight
+            state.deleteExpiredJob = scheduleJob('historyDaily', '0 0 * * *', ()=>{
+                const retentionDaysInMilliseconds = serviceUtils.getRetentionDays() * 24 * 60 * 60 * 1000;
+                const expirationDate = new Date(Date.now() - retentionDaysInMilliseconds);
+                strapi1.db.query(HISTORY_VERSION_UID).deleteMany({
+                    where: {
+                        created_at: {
+                            $lt: expirationDate
+                        }
+                    }
+                }).catch((error)=>{
+                    if (error instanceof Error) {
+                        strapi1.log.error('Error deleting expired history versions', error.message);
+                    }
+                });
+            });
+            state.isInitialized = true;
+        },
+        async destroy () {
+            if (state.deleteExpiredJob) {
+                state.deleteExpiredJob.cancel();
+            }
+        }
+    };
+};
+
+export { createLifecyclesService };
+//# sourceMappingURL=lifecycles.mjs.map

package/dist/server/history/services/lifecycles.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"lifecycles.mjs","sources":["../../../../server/src/history/services/lifecycles.ts"],"sourcesContent":["import type { Core, Modules, UID } from '@strapi/types';\nimport { contentTypes } from '@strapi/utils';\n\nimport { omit, castArray } from 'lodash/fp';\n\nimport { scheduleJob } from 'node-schedule';\n\nimport { getService } from '../utils';\nimport { FIELDS_TO_IGNORE, HISTORY_VERSION_UID } from '../constants';\n\nimport type { CreateHistoryVersion } from '../../../../shared/contracts/history-versions';\nimport { createServiceUtils } from './utils';\n\n/**\n * Filters out actions that should not create a history version.\n */\nconst shouldCreateHistoryVersion = (\n  context: Modules.Documents.Middleware.Context\n): context is Modules.Documents.Middleware.Context & {\n  action: 'create' | 'update' | 'clone' | 'publish' | 'unpublish' | 'discardDraft';\n  contentType: UID.CollectionType;\n} => {\n  // Ignore requests that are not related to the content manager\n  if (!strapi.requestContext.get()?.request.url.startsWith('/content-manager')) {\n    return false;\n  }\n\n  // NOTE: cannot do type narrowing with array includes\n  if (\n    context.action !== 'create' &&\n    context.action !== 'update' &&\n    context.action !== 'clone' &&\n    context.action !== 'publish' &&\n    context.action !== 'unpublish' &&\n    context.action !== 'discardDraft'\n  ) {\n    return false;\n  }\n\n  /**\n   * When a document is published, the draft version of the document is also updated.\n   * It creates confusion for users because they see two history versions each publish action.\n   * To avoid this, we silence the update action during a publish request,\n   * so that they only see the published version of the document in the history.\n   */\n  if (\n    context.action === 'update' &&\n    strapi.requestContext.get()?.request.url.endsWith('/actions/publish')\n  ) {\n    return false;\n  }\n\n  // Ignore content types not created by the user\n  if (!context.contentType.uid.startsWith('api::')) {\n    return false;\n  }\n\n  return true;\n};\n\n/**\n * Returns the content type schema (and its components schemas).\n * Used to determine if changes were made in the content type builder since a history version was created.\n * And therefore which fields can be restored and which cannot.\n */\nconst getSchemas = (uid: UID.CollectionType) => {\n  const attributesSchema = strapi.getModel(uid).attributes;\n\n  // TODO: Handle nested components\n  const componentsSchemas = Object.keys(attributesSchema).reduce(\n    (currentComponentSchemas, key) => {\n      const fieldSchema = attributesSchema[key];\n\n      if (fieldSchema.type === 'component') {\n        const componentSchema = strapi.getModel(fieldSchema.component).attributes;\n        return {\n          ...currentComponentSchemas,\n          [fieldSchema.component]: componentSchema,\n        };\n      }\n\n      // Ignore anything that's not a component\n      return currentComponentSchemas;\n    },\n    {} as CreateHistoryVersion['componentsSchemas']\n  );\n\n  return {\n    schema: omit(FIELDS_TO_IGNORE, attributesSchema) as CreateHistoryVersion['schema'],\n    componentsSchemas,\n  };\n};\n\nconst createLifecyclesService = ({ strapi }: { strapi: Core.Strapi }) => {\n  const state: {\n    deleteExpiredJob: ReturnType<typeof scheduleJob> | null;\n    isInitialized: boolean;\n  } = {\n    deleteExpiredJob: null,\n    isInitialized: false,\n  };\n\n  const serviceUtils = createServiceUtils({ strapi });\n  const { persistTablesWithPrefix } = strapi.service('admin::persist-tables');\n\n  return {\n    async bootstrap() {\n      // Prevent initializing the service twice\n      if (state.isInitialized) {\n        return;\n      }\n\n      // Avoid data loss in case users temporarily don't have a license\n      await persistTablesWithPrefix('strapi_history_versions');\n\n      strapi.documents.use(async (context, next) => {\n        const result = (await next()) as any;\n\n        if (!shouldCreateHistoryVersion(context)) {\n          return result;\n        }\n\n        // On create/clone actions, the documentId is not available before creating the action is executed\n        const documentId =\n          context.action === 'create' || context.action === 'clone'\n            ? result.documentId\n            : context.params.documentId;\n\n        // Apply default locale if not available in the request\n        const defaultLocale = await serviceUtils.getDefaultLocale();\n        const locales = castArray(context.params?.locale || defaultLocale);\n        if (!locales.length) {\n          return result;\n        }\n\n        // All schemas related to the content type\n        const uid = context.contentType.uid;\n        const schemas = getSchemas(uid);\n        const model = strapi.getModel(uid);\n\n        const isLocalizedContentType = serviceUtils.isLocalizedContentType(model);\n\n        // Find all affected entries\n        const localeEntries = await strapi.db.query(uid).findMany({\n          where: {\n            documentId,\n            ...(isLocalizedContentType ? { locale: { $in: locales } } : {}),\n            ...(contentTypes.hasDraftAndPublish(strapi.contentTypes[uid])\n              ? { publishedAt: null }\n              : {}),\n          },\n          populate: serviceUtils.getDeepPopulate(uid, true /* use database syntax */),\n        });\n\n        await strapi.db.transaction(async ({ onCommit }) => {\n          // .createVersion() is executed asynchronously,\n          // onCommit prevents creating a history version\n          // when the transaction has already been committed\n          onCommit(async () => {\n            for (const entry of localeEntries) {\n              const status = await serviceUtils.getVersionStatus(uid, entry);\n\n              await getService(strapi, 'history').createVersion({\n                contentType: uid,\n                data: omit(FIELDS_TO_IGNORE, entry) as Modules.Documents.AnyDocument,\n                relatedDocumentId: documentId,\n                locale: entry.locale,\n                status,\n                ...schemas,\n              });\n            }\n          });\n        });\n\n        return result;\n      });\n\n      // Schedule a job to delete expired history versions every day at midnight\n      state.deleteExpiredJob = scheduleJob('historyDaily', '0 0 * * *', () => {\n        const retentionDaysInMilliseconds = serviceUtils.getRetentionDays() * 24 * 60 * 60 * 1000;\n        const expirationDate = new Date(Date.now() - retentionDaysInMilliseconds);\n\n        strapi.db\n          .query(HISTORY_VERSION_UID)\n          .deleteMany({\n            where: {\n              created_at: {\n                $lt: expirationDate,\n              },\n            },\n          })\n          .catch((error) => {\n            if (error instanceof Error) {\n              strapi.log.error('Error deleting expired history versions', error.message);\n            }\n          });\n      });\n\n      state.isInitialized = true;\n    },\n\n    async destroy() {\n      if (state.deleteExpiredJob) {\n        state.deleteExpiredJob.cancel();\n      }\n    },\n  };\n};\n\nexport { createLifecyclesService };\n"],"names":["shouldCreateHistoryVersion","context","strapi","requestContext","get","request","url","startsWith","action","endsWith","contentType","uid","getSchemas","attributesSchema","getModel","attributes","componentsSchemas","Object","keys","reduce","currentComponentSchemas","key","fieldSchema","type","componentSchema","component","schema","omit","FIELDS_TO_IGNORE","createLifecyclesService","state","deleteExpiredJob","isInitialized","serviceUtils","createServiceUtils","persistTablesWithPrefix","service","bootstrap","documents","use","next","result","documentId","params","defaultLocale","getDefaultLocale","locales","castArray","locale","length","schemas","model","isLocalizedContentType","localeEntries","db","query","findMany","where","$in","contentTypes","hasDraftAndPublish","publishedAt","populate","getDeepPopulate","transaction","onCommit","entry","status","getVersionStatus","getService","createVersion","data","relatedDocumentId","scheduleJob","retentionDaysInMilliseconds","getRetentionDays","expirationDate","Date","now","HISTORY_VERSION_UID","deleteMany","created_at","$lt","catch","error","Error","log","message","destroy","cancel"],"mappings":";;;;;;;AAaA;;IAGA,MAAMA,6BAA6B,CACjCC,OAAAA,GAAAA;;IAMA,IAAI,CAACC,OAAOC,cAAc,CAACC,GAAG,EAAIC,EAAAA,OAAAA,CAAQC,GAAIC,CAAAA,UAAAA,CAAW,kBAAqB,CAAA,EAAA;QAC5E,OAAO,KAAA;AACT;;IAGA,IACEN,OAAAA,CAAQO,MAAM,KAAK,QAAA,IACnBP,QAAQO,MAAM,KAAK,QACnBP,IAAAA,OAAAA,CAAQO,MAAM,KAAK,WACnBP,OAAQO,CAAAA,MAAM,KAAK,SAAA,IACnBP,OAAQO,CAAAA,MAAM,KAAK,WACnBP,IAAAA,OAAAA,CAAQO,MAAM,KAAK,cACnB,EAAA;QACA,OAAO,KAAA;AACT;AAEA;;;;;AAKC,MACD,IACEP,OAAAA,CAAQO,MAAM,KAAK,QACnBN,IAAAA,MAAAA,CAAOC,cAAc,CAACC,GAAG,EAAA,EAAIC,OAAQC,CAAAA,GAAAA,CAAIG,SAAS,kBAClD,CAAA,EAAA;QACA,OAAO,KAAA;AACT;;IAGA,IAAI,CAACR,QAAQS,WAAW,CAACC,GAAG,CAACJ,UAAU,CAAC,OAAU,CAAA,EAAA;QAChD,OAAO,KAAA;AACT;IAEA,OAAO,IAAA;AACT,CAAA;AAEA;;;;IAKA,MAAMK,aAAa,CAACD,GAAAA,GAAAA;AAClB,IAAA,MAAME,gBAAmBX,GAAAA,MAAAA,CAAOY,QAAQ,CAACH,KAAKI,UAAU;;IAGxD,MAAMC,iBAAAA,GAAoBC,OAAOC,IAAI,CAACL,kBAAkBM,MAAM,CAC5D,CAACC,uBAAyBC,EAAAA,GAAAA,GAAAA;QACxB,MAAMC,WAAAA,GAAcT,gBAAgB,CAACQ,GAAI,CAAA;QAEzC,IAAIC,WAAAA,CAAYC,IAAI,KAAK,WAAa,EAAA;AACpC,YAAA,MAAMC,kBAAkBtB,MAAOY,CAAAA,QAAQ,CAACQ,WAAYG,CAAAA,SAAS,EAAEV,UAAU;YACzE,OAAO;AACL,gBAAA,GAAGK,uBAAuB;gBAC1B,CAACE,WAAAA,CAAYG,SAAS,GAAGD;AAC3B,aAAA;AACF;;QAGA,OAAOJ,uBAAAA;AACT,KAAA,EACA,EAAC,CAAA;IAGH,OAAO;AACLM,QAAAA,MAAAA,EAAQC,KAAKC,gBAAkBf,EAAAA,gBAAAA,CAAAA;AAC/BG,QAAAA;AACF,KAAA;AACF,CAAA;AAEA,MAAMa,uBAA0B,GAAA,CAAC,EAAE3B,MAAAA,EAAAA,OAAM,EAA2B,GAAA;AAClE,IAAA,MAAM4B,KAGF,GAAA;QACFC,gBAAkB,EAAA,IAAA;QAClBC,aAAe,EAAA;AACjB,KAAA;AAEA,IAAA,MAAMC,eAAeC,kBAAmB,CAAA;QAAEhC,MAAAA,EAAAA;AAAO,KAAA,CAAA;AACjD,IAAA,MAAM,EAAEiC,uBAAuB,EAAE,GAAGjC,OAAAA,CAAOkC,OAAO,CAAC,uBAAA,CAAA;IAEnD,OAAO;QACL,MAAMC,SAAAA,CAAAA,GAAAA;;YAEJ,IAAIP,KAAAA,CAAME,aAAa,EAAE;AACvB,gBAAA;AACF;;AAGA,YAAA,MAAMG,uBAAwB,CAAA,yBAAA,CAAA;AAE9BjC,YAAAA,OAAAA,CAAOoC,SAAS,CAACC,GAAG,CAAC,OAAOtC,OAASuC,EAAAA,IAAAA,GAAAA;AACnC,gBAAA,MAAMC,SAAU,MAAMD,IAAAA,EAAAA;gBAEtB,IAAI,CAACxC,2BAA2BC,OAAU,CAAA,EAAA;oBACxC,OAAOwC,MAAAA;AACT;;AAGA,gBAAA,MAAMC,UACJzC,GAAAA,OAAAA,CAAQO,MAAM,KAAK,YAAYP,OAAQO,CAAAA,MAAM,KAAK,OAAA,GAC9CiC,OAAOC,UAAU,GACjBzC,OAAQ0C,CAAAA,MAAM,CAACD,UAAU;;gBAG/B,MAAME,aAAAA,GAAgB,MAAMX,YAAAA,CAAaY,gBAAgB,EAAA;AACzD,gBAAA,MAAMC,OAAUC,GAAAA,SAAAA,CAAU9C,OAAQ0C,CAAAA,MAAM,EAAEK,MAAUJ,IAAAA,aAAAA,CAAAA;gBACpD,IAAI,CAACE,OAAQG,CAAAA,MAAM,EAAE;oBACnB,OAAOR,MAAAA;AACT;;AAGA,gBAAA,MAAM9B,GAAMV,GAAAA,OAAAA,CAAQS,WAAW,CAACC,GAAG;AACnC,gBAAA,MAAMuC,UAAUtC,UAAWD,CAAAA,GAAAA,CAAAA;gBAC3B,MAAMwC,KAAAA,GAAQjD,OAAOY,CAAAA,QAAQ,CAACH,GAAAA,CAAAA;gBAE9B,MAAMyC,sBAAAA,GAAyBnB,YAAamB,CAAAA,sBAAsB,CAACD,KAAAA,CAAAA;;gBAGnE,MAAME,aAAAA,GAAgB,MAAMnD,OAAOoD,CAAAA,EAAE,CAACC,KAAK,CAAC5C,GAAK6C,CAAAA,CAAAA,QAAQ,CAAC;oBACxDC,KAAO,EAAA;AACLf,wBAAAA,UAAAA;AACA,wBAAA,GAAIU,sBAAyB,GAAA;4BAAEJ,MAAQ,EAAA;gCAAEU,GAAKZ,EAAAA;AAAQ;AAAE,yBAAA,GAAI,EAAE;AAC9D,wBAAA,GAAIa,aAAaC,kBAAkB,CAAC1D,QAAOyD,YAAY,CAAChD,IAAI,CACxD,GAAA;4BAAEkD,WAAa,EAAA;AAAK,yBAAA,GACpB;AACN,qBAAA;oBACAC,QAAU7B,EAAAA,YAAAA,CAAa8B,eAAe,CAACpD,GAAK,EAAA,IAAA;AAC9C,iBAAA,CAAA;gBAEA,MAAMT,OAAAA,CAAOoD,EAAE,CAACU,WAAW,CAAC,OAAO,EAAEC,QAAQ,EAAE,GAAA;;;;oBAI7CA,QAAS,CAAA,UAAA;wBACP,KAAK,MAAMC,SAASb,aAAe,CAAA;AACjC,4BAAA,MAAMc,MAAS,GAAA,MAAMlC,YAAamC,CAAAA,gBAAgB,CAACzD,GAAKuD,EAAAA,KAAAA,CAAAA;AAExD,4BAAA,MAAMG,UAAWnE,CAAAA,OAAAA,EAAQ,SAAWoE,CAAAA,CAAAA,aAAa,CAAC;gCAChD5D,WAAaC,EAAAA,GAAAA;AACb4D,gCAAAA,IAAAA,EAAM5C,KAAKC,gBAAkBsC,EAAAA,KAAAA,CAAAA;gCAC7BM,iBAAmB9B,EAAAA,UAAAA;AACnBM,gCAAAA,MAAAA,EAAQkB,MAAMlB,MAAM;AACpBmB,gCAAAA,MAAAA;AACA,gCAAA,GAAGjB;AACL,6BAAA,CAAA;AACF;AACF,qBAAA,CAAA;AACF,iBAAA,CAAA;gBAEA,OAAOT,MAAAA;AACT,aAAA,CAAA;;AAGAX,YAAAA,KAAAA,CAAMC,gBAAgB,GAAG0C,WAAY,CAAA,cAAA,EAAgB,WAAa,EAAA,IAAA;AAChE,gBAAA,MAAMC,8BAA8BzC,YAAa0C,CAAAA,gBAAgB,EAAK,GAAA,EAAA,GAAK,KAAK,EAAK,GAAA,IAAA;AACrF,gBAAA,MAAMC,cAAiB,GAAA,IAAIC,IAAKA,CAAAA,IAAAA,CAAKC,GAAG,EAAKJ,GAAAA,2BAAAA,CAAAA;AAE7CxE,gBAAAA,OAAAA,CAAOoD,EAAE,CACNC,KAAK,CAACwB,mBAAAA,CAAAA,CACNC,UAAU,CAAC;oBACVvB,KAAO,EAAA;wBACLwB,UAAY,EAAA;4BACVC,GAAKN,EAAAA;AACP;AACF;iBAEDO,CAAAA,CAAAA,KAAK,CAAC,CAACC,KAAAA,GAAAA;AACN,oBAAA,IAAIA,iBAAiBC,KAAO,EAAA;AAC1BnF,wBAAAA,OAAAA,CAAOoF,GAAG,CAACF,KAAK,CAAC,yCAAA,EAA2CA,MAAMG,OAAO,CAAA;AAC3E;AACF,iBAAA,CAAA;AACJ,aAAA,CAAA;AAEAzD,YAAAA,KAAAA,CAAME,aAAa,GAAG,IAAA;AACxB,SAAA;QAEA,MAAMwD,OAAAA,CAAAA,GAAAA;YACJ,IAAI1D,KAAAA,CAAMC,gBAAgB,EAAE;gBAC1BD,KAAMC,CAAAA,gBAAgB,CAAC0D,MAAM,EAAA;AAC/B;AACF;AACF,KAAA;AACF;;;;"}

package/dist/server/history/services/utils.js

@@ -0,0 +1,281 @@
+'use strict';
+
+var fp = require('lodash/fp');
+var strapiUtils = require('@strapi/utils');
+var constants = require('../constants.js');
+
+const DEFAULT_RETENTION_DAYS = 90;
+const createServiceUtils = ({ strapi })=>{
+    /**
+   * @description
+   * Get the difference between the version schema and the content type schema
+   */ const getSchemaAttributesDiff = (versionSchemaAttributes, contentTypeSchemaAttributes)=>{
+        // Omit the same fields that were omitted when creating a history version
+        const sanitizedContentTypeSchemaAttributes = fp.omit(constants.FIELDS_TO_IGNORE, contentTypeSchemaAttributes);
+        const reduceDifferenceToAttributesObject = (diffKeys, source)=>{
+            return diffKeys.reduce((previousAttributesObject, diffKey)=>{
+                previousAttributesObject[diffKey] = source[diffKey];
+                return previousAttributesObject;
+            }, {});
+        };
+        const versionSchemaKeys = Object.keys(versionSchemaAttributes);
+        const contentTypeSchemaAttributesKeys = Object.keys(sanitizedContentTypeSchemaAttributes);
+        // The attribute is new if it's on the content type schema but not on the version schema
+        const uniqueToContentType = fp.difference(contentTypeSchemaAttributesKeys, versionSchemaKeys);
+        const added = reduceDifferenceToAttributesObject(uniqueToContentType, sanitizedContentTypeSchemaAttributes);
+        // The attribute was removed or renamed if it's on the version schema but not on the content type schema
+        const uniqueToVersion = fp.difference(versionSchemaKeys, contentTypeSchemaAttributesKeys);
+        const removed = reduceDifferenceToAttributesObject(uniqueToVersion, versionSchemaAttributes);
+        return {
+            added,
+            removed
+        };
+    };
+    /**
+   * @description
+   * Gets the value to set for a relation when restoring a document
+   * @returns
+   * The relation if it exists or null
+   */ const getRelationRestoreValue = async (versionRelationData, attribute)=>{
+        if (Array.isArray(versionRelationData)) {
+            if (versionRelationData.length === 0) return versionRelationData;
+            const existingAndMissingRelations = await Promise.all(versionRelationData.map((relation)=>{
+                return strapi.documents(attribute.target).findOne({
+                    documentId: relation.documentId,
+                    locale: relation.locale || undefined
+                });
+            }));
+            return existingAndMissingRelations.filter((relation)=>relation !== null);
+        }
+        return strapi.documents(attribute.target).findOne({
+            documentId: versionRelationData.documentId,
+            locale: versionRelationData.locale || undefined
+        });
+    };
+    /**
+   * @description
+   * Gets the value to set for a media asset when restoring a document
+   * @returns
+   * The media asset if it exists or null
+   */ const getMediaRestoreValue = async (versionRelationData)=>{
+        if (Array.isArray(versionRelationData)) {
+            const existingAndMissingMedias = await Promise.all(versionRelationData.map((media)=>{
+                return strapi.db.query('plugin::upload.file').findOne({
+                    where: {
+                        id: media.id
+                    }
+                });
+            }));
+            return existingAndMissingMedias.filter((media)=>media != null);
+        }
+        return strapi.db.query('plugin::upload.file').findOne({
+            where: {
+                id: versionRelationData.id
+            }
+        });
+    };
+    const localesService = strapi.plugin('i18n')?.service('locales');
+    const i18nContentTypeService = strapi.plugin('i18n')?.service('content-types');
+    const getDefaultLocale = async ()=>localesService ? localesService.getDefaultLocale() : null;
+    const isLocalizedContentType = (model)=>i18nContentTypeService ? i18nContentTypeService.isLocalizedContentType(model) : false;
+    /**
+   *
+   * @description
+   * Creates a dictionary of all locales available
+   */ const getLocaleDictionary = async ()=>{
+        if (!localesService) return {};
+        const locales = await localesService.find() || [];
+        return locales.reduce((acc, locale)=>{
+            acc[locale.code] = {
+                name: locale.name,
+                code: locale.code
+            };
+            return acc;
+        }, {});
+    };
+    /**
+   *
+   * @description
+   * Gets the number of retention days defined on the license or configured by the user
+   */ const getRetentionDays = ()=>{
+        const featureConfig = strapi.ee.features.get('cms-content-history');
+        const licenseRetentionDays = typeof featureConfig === 'object' && featureConfig?.options.retentionDays;
+        const userRetentionDays = strapi.config.get('admin.history.retentionDays');
+        // Allow users to override the license retention days, but not to increase it
+        if (userRetentionDays && userRetentionDays < licenseRetentionDays) {
+            return userRetentionDays;
+        }
+        // User didn't provide retention days value, use the license or fallback to default
+        return Math.min(licenseRetentionDays, DEFAULT_RETENTION_DAYS);
+    };
+    const getVersionStatus = async (contentTypeUid, document)=>{
+        const documentMetadataService = strapi.plugin('content-manager').service('document-metadata');
+        const meta = await documentMetadataService.getMetadata(contentTypeUid, document);
+        return documentMetadataService.getStatus(document, meta.availableStatus);
+    };
+    /**
+   * Lists all the fields of a component, excepts those that will be populated.
+   * The goal is to exclude the ID, because when restoring a component,
+   * referencing an ID for a component db row that was deleted creates an error.
+   * So we never store component IDs to ensure they're re-created while restoring a version.
+   */ const getComponentFields = (componentUID)=>{
+        return Object.entries(strapi.getModel(componentUID).attributes).reduce((fieldsAcc, [key, attribute])=>{
+            if (![
+                'relation',
+                'media',
+                'component',
+                'dynamiczone'
+            ].includes(attribute.type)) {
+                fieldsAcc.push(key);
+            }
+            return fieldsAcc;
+        }, []);
+    };
+    /**
+   * @description
+   * Creates a populate object that looks for all the relations that need
+   * to be saved in history, and populates only the fields needed to later retrieve the content.
+   *
+   * @param uid - The content type UID
+   * @param useDatabaseSyntax - Whether to use the database syntax for populate, defaults to false
+   */ const getDeepPopulate = (uid, useDatabaseSyntax = false)=>{
+        const model = strapi.getModel(uid);
+        const attributes = Object.entries(model.attributes);
+        const fieldSelector = useDatabaseSyntax ? 'select' : 'fields';
+        return attributes.reduce((acc, [attributeName, attribute])=>{
+            switch(attribute.type){
+                case 'relation':
+                    {
+                        // TODO: Support polymorphic relations
+                        const isMorphRelation = attribute.relation.toLowerCase().startsWith('morph');
+                        if (isMorphRelation) {
+                            break;
+                        }
+                        const isVisible = strapiUtils.contentTypes.isVisibleAttribute(model, attributeName);
+                        if (isVisible) {
+                            acc[attributeName] = {
+                                [fieldSelector]: [
+                                    'documentId',
+                                    'locale',
+                                    'publishedAt'
+                                ]
+                            };
+                        }
+                        break;
+                    }
+                case 'media':
+                    {
+                        acc[attributeName] = {
+                            [fieldSelector]: [
+                                'id'
+                            ]
+                        };
+                        break;
+                    }
+                case 'component':
+                    {
+                        const populate = getDeepPopulate(attribute.component);
+                        acc[attributeName] = {
+                            populate,
+                            [fieldSelector]: getComponentFields(attribute.component)
+                        };
+                        break;
+                    }
+                case 'dynamiczone':
+                    {
+                        // Use fragments to populate the dynamic zone components
+                        const populatedComponents = (attribute.components || []).reduce((acc, componentUID)=>{
+                            acc[componentUID] = {
+                                populate: getDeepPopulate(componentUID),
+                                [fieldSelector]: getComponentFields(componentUID)
+                            };
+                            return acc;
+                        }, {});
+                        acc[attributeName] = {
+                            on: populatedComponents
+                        };
+                        break;
+                    }
+            }
+            return acc;
+        }, {});
+    };
+    /**
+   * @description
+   * Builds a response object for relations containing the related data and a count of missing relations
+   */ const buildMediaResponse = async (values)=>{
+        return values// Until we implement proper pagination, limit relations to an arbitrary amount
+        .slice(0, 25).reduce(async (currentRelationDataPromise, entry)=>{
+            const currentRelationData = await currentRelationDataPromise;
+            // Entry can be null if it's a toOne relation
+            if (!entry) {
+                return currentRelationData;
+            }
+            const relatedEntry = await strapi.db.query('plugin::upload.file').findOne({
+                where: {
+                    id: entry.id
+                }
+            });
+            if (relatedEntry) {
+                currentRelationData.results.push(relatedEntry);
+            } else {
+                // The related content has been deleted
+                currentRelationData.meta.missingCount += 1;
+            }
+            return currentRelationData;
+        }, Promise.resolve({
+            results: [],
+            meta: {
+                missingCount: 0
+            }
+        }));
+    };
+    /**
+   * @description
+   * Builds a response object for media containing the media assets data and a count of missing media assets
+   */ const buildRelationReponse = async (values, attributeSchema)=>{
+        return values// Until we implement proper pagination, limit relations to an arbitrary amount
+        .slice(0, 25).reduce(async (currentRelationDataPromise, entry)=>{
+            const currentRelationData = await currentRelationDataPromise;
+            // Entry can be null if it's a toOne relation
+            if (!entry) {
+                return currentRelationData;
+            }
+            const relatedEntry = await strapi.documents(attributeSchema.target).findOne({
+                documentId: entry.documentId,
+                locale: entry.locale || undefined
+            });
+            if (relatedEntry) {
+                currentRelationData.results.push({
+                    ...relatedEntry,
+                    status: await getVersionStatus(attributeSchema.target, relatedEntry)
+                });
+            } else {
+                // The related content has been deleted
+                currentRelationData.meta.missingCount += 1;
+            }
+            return currentRelationData;
+        }, Promise.resolve({
+            results: [],
+            meta: {
+                missingCount: 0
+            }
+        }));
+    };
+    return {
+        getSchemaAttributesDiff,
+        getRelationRestoreValue,
+        getMediaRestoreValue,
+        getDefaultLocale,
+        isLocalizedContentType,
+        getLocaleDictionary,
+        getRetentionDays,
+        getVersionStatus,
+        getDeepPopulate,
+        buildMediaResponse,
+        buildRelationReponse
+    };
+};
+
+exports.createServiceUtils = createServiceUtils;
+//# sourceMappingURL=utils.js.map