@strapi/review-workflows 5.12.1 → 5.12.2

package/dist/server/services/document-service-middleware.mjs

@@ -0,0 +1,128 @@
+import { errors } from '@strapi/utils';
+import { isNil } from 'lodash/fp';
+import { ENTITY_STAGE_ATTRIBUTE } from '../constants/workflows.mjs';
+import { WORKFLOW_UPDATE_STAGE } from '../constants/webhook-events.mjs';
+import { getService } from '../utils/index.mjs';
+
+/**
+ * Get the stage information of an entity
+ * @param {String} uid
+ * @param {Number} id
+ * @returns {Object}
+ */ const getEntityStage = async (uid, id, params)=>{
+    const entity = await strapi.documents(uid).findOne({
+        ...params,
+        documentId: id,
+        status: 'draft',
+        populate: {
+            [ENTITY_STAGE_ATTRIBUTE]: {
+                populate: {
+                    workflow: true
+                }
+            }
+        }
+    });
+    return entity?.[ENTITY_STAGE_ATTRIBUTE] ?? {};
+};
+/**
+ * Ensures the entity is assigned to the default workflow stage
+ */ const assignStageOnCreate = async (ctx, next)=>{
+    if (ctx.action !== 'create' && ctx.action !== 'clone') {
+        return next();
+    }
+    /**
+   * Content types can have assigned workflows,
+   * if the CT has one, assign a default value to the stage attribute if it's not present
+   */ const workflow = await getService('workflows').getAssignedWorkflow(ctx.contentType.uid, {
+        populate: 'stages'
+    });
+    if (!workflow) {
+        return next();
+    }
+    const data = ctx.params.data;
+    // Assign the default stage if the entity doesn't have one
+    if (ctx.params?.data && isNil(data[ENTITY_STAGE_ATTRIBUTE])) {
+        data[ENTITY_STAGE_ATTRIBUTE] = {
+            id: workflow.stages[0].id
+        };
+    }
+    return next();
+};
+const handleStageOnUpdate = async (ctx, next)=>{
+    if (ctx.action !== 'update') {
+        return next();
+    }
+    const { documentId } = ctx.params;
+    const data = ctx.params.data;
+    if (isNil(data?.[ENTITY_STAGE_ATTRIBUTE])) {
+        delete data?.[ENTITY_STAGE_ATTRIBUTE];
+        return next();
+    }
+    /**
+   * Get last stage of the entity
+   */ const previousStage = await getEntityStage(ctx.contentType.uid, documentId, ctx.params);
+    const result = await next();
+    if (!result) {
+        return result;
+    }
+    // @ts-expect-error
+    const updatedStage = result?.[ENTITY_STAGE_ATTRIBUTE];
+    // Stage might be null if field is not populated
+    if (updatedStage && previousStage?.id && previousStage.id !== updatedStage.id) {
+        const model = strapi.getModel(ctx.contentType.uid);
+        strapi.eventHub.emit(WORKFLOW_UPDATE_STAGE, {
+            model: model.modelName,
+            uid: model.uid,
+            // TODO v6: Rename to "entry", which is what is used for regular CRUD updates
+            entity: {
+                // @ts-expect-error
+                id: result?.id,
+                documentId,
+                // @ts-expect-error
+                locale: result?.locale,
+                status: 'draft'
+            },
+            workflow: {
+                id: previousStage.workflow.id,
+                stages: {
+                    from: {
+                        id: previousStage.id,
+                        name: previousStage.name
+                    },
+                    to: {
+                        id: updatedStage.id,
+                        name: updatedStage.name
+                    }
+                }
+            }
+        });
+    }
+    return next();
+};
+/**
+ * Check if the entity is at the required stage before publish
+ */ const checkStageBeforePublish = async (ctx, next)=>{
+    if (ctx.action !== 'publish') {
+        return next();
+    }
+    const workflow = await getService('workflows').getAssignedWorkflow(ctx.contentType.uid, {
+        populate: 'stageRequiredToPublish'
+    });
+    if (!workflow || !workflow.stageRequiredToPublish) {
+        return next();
+    }
+    const { documentId } = ctx.params;
+    const entryStage = await getEntityStage(ctx.contentType.uid, documentId, ctx.params);
+    if (entryStage.id !== workflow.stageRequiredToPublish.id) {
+        throw new errors.ValidationError('Entry is not at the required stage to publish');
+    }
+    return next();
+};
+var documentServiceMiddleware = (()=>({
+        assignStageOnCreate,
+        handleStageOnUpdate,
+        checkStageBeforePublish
+    }));
+
+export { documentServiceMiddleware as default };
+//# sourceMappingURL=document-service-middleware.mjs.map

package/dist/server/services/document-service-middleware.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-service-middleware.mjs","sources":["../../../server/src/services/document-service-middleware.ts"],"sourcesContent":["import type { Modules } from '@strapi/types';\nimport { errors } from '@strapi/utils';\n\nimport { isNil } from 'lodash/fp';\nimport { ENTITY_STAGE_ATTRIBUTE } from '../constants/workflows';\nimport { WORKFLOW_UPDATE_STAGE } from '../constants/webhook-events';\nimport { getService } from '../utils';\n\ntype Middleware = Modules.Documents.Middleware.Middleware;\n\n/**\n * Get the stage information of an entity\n * @param {String} uid\n * @param {Number} id\n * @returns {Object}\n */\nconst getEntityStage = async (uid: any, id: any, params: any) => {\n  const entity = await strapi.documents(uid).findOne({\n    ...params,\n    documentId: id,\n    status: 'draft',\n    populate: {\n      [ENTITY_STAGE_ATTRIBUTE]: {\n        populate: {\n          workflow: true,\n        },\n      },\n    },\n  });\n\n  return entity?.[ENTITY_STAGE_ATTRIBUTE] ?? {};\n};\n\n/**\n * Ensures the entity is assigned to the default workflow stage\n */\nconst assignStageOnCreate: Middleware = async (ctx, next) => {\n  if (ctx.action !== 'create' && ctx.action !== 'clone') {\n    return next();\n  }\n\n  /**\n   * Content types can have assigned workflows,\n   * if the CT has one, assign a default value to the stage attribute if it's not present\n   */\n  const workflow = await getService('workflows').getAssignedWorkflow(ctx.contentType.uid, {\n    populate: 'stages',\n  });\n\n  if (!workflow) {\n    return next();\n  }\n\n  const data = ctx.params.data as Record<string, any>;\n\n  // Assign the default stage if the entity doesn't have one\n  if (ctx.params?.data && isNil(data[ENTITY_STAGE_ATTRIBUTE])) {\n    data[ENTITY_STAGE_ATTRIBUTE] = { id: workflow.stages[0].id };\n  }\n\n  return next();\n};\n\nconst handleStageOnUpdate: Middleware = async (ctx, next) => {\n  if (ctx.action !== 'update') {\n    return next();\n  }\n\n  const { documentId } = ctx.params;\n  const data = ctx.params.data as any;\n\n  if (isNil(data?.[ENTITY_STAGE_ATTRIBUTE])) {\n    delete data?.[ENTITY_STAGE_ATTRIBUTE];\n    return next();\n  }\n\n  /**\n   * Get last stage of the entity\n   */\n  const previousStage = await getEntityStage(ctx.contentType.uid, documentId, ctx.params);\n\n  const result = await next();\n\n  if (!result) {\n    return result;\n  }\n\n  // @ts-expect-error\n  const updatedStage = result?.[ENTITY_STAGE_ATTRIBUTE];\n\n  // Stage might be null if field is not populated\n  if (updatedStage && previousStage?.id && previousStage.id !== updatedStage.id) {\n    const model = strapi.getModel(ctx.contentType.uid);\n\n    strapi.eventHub.emit(WORKFLOW_UPDATE_STAGE, {\n      model: model.modelName,\n      uid: model.uid,\n      // TODO v6: Rename to \"entry\", which is what is used for regular CRUD updates\n      entity: {\n        // @ts-expect-error\n        id: result?.id,\n        documentId,\n        // @ts-expect-error\n        locale: result?.locale,\n        status: 'draft',\n      },\n      workflow: {\n        id: previousStage.workflow.id,\n        stages: {\n          from: {\n            id: previousStage.id,\n            name: previousStage.name,\n          },\n          to: {\n            id: updatedStage.id,\n            name: updatedStage.name,\n          },\n        },\n      },\n    });\n  }\n\n  return next();\n};\n\n/**\n * Check if the entity is at the required stage before publish\n */\nconst checkStageBeforePublish: Middleware = async (ctx, next) => {\n  if (ctx.action !== 'publish') {\n    return next();\n  }\n\n  const workflow = await getService('workflows').getAssignedWorkflow(ctx.contentType.uid, {\n    populate: 'stageRequiredToPublish',\n  });\n\n  if (!workflow || !workflow.stageRequiredToPublish) {\n    return next();\n  }\n\n  const { documentId } = ctx.params;\n  const entryStage = await getEntityStage(ctx.contentType.uid, documentId, ctx.params);\n\n  if (entryStage.id !== workflow.stageRequiredToPublish.id) {\n    throw new errors.ValidationError('Entry is not at the required stage to publish');\n  }\n\n  return next();\n};\n\nexport default () => ({\n  assignStageOnCreate,\n  handleStageOnUpdate,\n  checkStageBeforePublish,\n});\n"],"names":["getEntityStage","uid","id","params","entity","strapi","documents","findOne","documentId","status","populate","ENTITY_STAGE_ATTRIBUTE","workflow","assignStageOnCreate","ctx","next","action","getService","getAssignedWorkflow","contentType","data","isNil","stages","handleStageOnUpdate","previousStage","result","updatedStage","model","getModel","eventHub","emit","WORKFLOW_UPDATE_STAGE","modelName","locale","from","name","to","checkStageBeforePublish","stageRequiredToPublish","entryStage","errors","ValidationError"],"mappings":";;;;;;AAUA;;;;;AAKC,IACD,MAAMA,cAAAA,GAAiB,OAAOC,GAAAA,EAAUC,EAASC,EAAAA,MAAAA,GAAAA;AAC/C,IAAA,MAAMC,SAAS,MAAMC,MAAAA,CAAOC,SAAS,CAACL,GAAAA,CAAAA,CAAKM,OAAO,CAAC;AACjD,QAAA,GAAGJ,MAAM;QACTK,UAAYN,EAAAA,EAAAA;QACZO,MAAQ,EAAA,OAAA;QACRC,QAAU,EAAA;AACR,YAAA,CAACC,yBAAyB;gBACxBD,QAAU,EAAA;oBACRE,QAAU,EAAA;AACZ;AACF;AACF;AACF,KAAA,CAAA;AAEA,IAAA,OAAOR,MAAQ,GAACO,sBAAuB,CAAA,IAAI,EAAC;AAC9C,CAAA;AAEA;;IAGA,MAAME,mBAAkC,GAAA,OAAOC,GAAKC,EAAAA,IAAAA,GAAAA;AAClD,IAAA,IAAID,IAAIE,MAAM,KAAK,YAAYF,GAAIE,CAAAA,MAAM,KAAK,OAAS,EAAA;QACrD,OAAOD,IAAAA,EAAAA;AACT;AAEA;;;MAIA,MAAMH,QAAW,GAAA,MAAMK,UAAW,CAAA,WAAA,CAAA,CAAaC,mBAAmB,CAACJ,GAAIK,CAAAA,WAAW,CAAClB,GAAG,EAAE;QACtFS,QAAU,EAAA;AACZ,KAAA,CAAA;AAEA,IAAA,IAAI,CAACE,QAAU,EAAA;QACb,OAAOG,IAAAA,EAAAA;AACT;AAEA,IAAA,MAAMK,IAAON,GAAAA,GAAAA,CAAIX,MAAM,CAACiB,IAAI;;IAG5B,IAAIN,GAAAA,CAAIX,MAAM,EAAEiB,IAAAA,IAAQC,MAAMD,IAAI,CAACT,uBAAuB,CAAG,EAAA;QAC3DS,IAAI,CAACT,uBAAuB,GAAG;AAAET,YAAAA,EAAAA,EAAIU,QAASU,CAAAA,MAAM,CAAC,CAAA,CAAE,CAACpB;AAAG,SAAA;AAC7D;IAEA,OAAOa,IAAAA,EAAAA;AACT,CAAA;AAEA,MAAMQ,mBAAAA,GAAkC,OAAOT,GAAKC,EAAAA,IAAAA,GAAAA;IAClD,IAAID,GAAAA,CAAIE,MAAM,KAAK,QAAU,EAAA;QAC3B,OAAOD,IAAAA,EAAAA;AACT;AAEA,IAAA,MAAM,EAAEP,UAAU,EAAE,GAAGM,IAAIX,MAAM;AACjC,IAAA,MAAMiB,IAAON,GAAAA,GAAAA,CAAIX,MAAM,CAACiB,IAAI;AAE5B,IAAA,IAAIC,KAAMD,CAAAA,IAAAA,GAAOT,sBAAAA,CAAuB,CAAG,EAAA;QACzC,OAAOS,IAAAA,GAAOT,sBAAuB,CAAA;QACrC,OAAOI,IAAAA,EAAAA;AACT;AAEA;;MAGA,MAAMS,aAAgB,GAAA,MAAMxB,cAAec,CAAAA,GAAAA,CAAIK,WAAW,CAAClB,GAAG,EAAEO,UAAYM,EAAAA,GAAAA,CAAIX,MAAM,CAAA;AAEtF,IAAA,MAAMsB,SAAS,MAAMV,IAAAA,EAAAA;AAErB,IAAA,IAAI,CAACU,MAAQ,EAAA;QACX,OAAOA,MAAAA;AACT;;IAGA,MAAMC,YAAAA,GAAeD,MAAQ,GAACd,sBAAuB,CAAA;;IAGrD,IAAIe,YAAAA,IAAgBF,eAAetB,EAAMsB,IAAAA,aAAAA,CAActB,EAAE,KAAKwB,YAAAA,CAAaxB,EAAE,EAAE;AAC7E,QAAA,MAAMyB,QAAQtB,MAAOuB,CAAAA,QAAQ,CAACd,GAAIK,CAAAA,WAAW,CAAClB,GAAG,CAAA;AAEjDI,QAAAA,MAAAA,CAAOwB,QAAQ,CAACC,IAAI,CAACC,qBAAuB,EAAA;AAC1CJ,YAAAA,KAAAA,EAAOA,MAAMK,SAAS;AACtB/B,YAAAA,GAAAA,EAAK0B,MAAM1B,GAAG;;YAEdG,MAAQ,EAAA;;AAENF,gBAAAA,EAAAA,EAAIuB,MAAQvB,EAAAA,EAAAA;AACZM,gBAAAA,UAAAA;;AAEAyB,gBAAAA,MAAAA,EAAQR,MAAQQ,EAAAA,MAAAA;gBAChBxB,MAAQ,EAAA;AACV,aAAA;YACAG,QAAU,EAAA;gBACRV,EAAIsB,EAAAA,aAAAA,CAAcZ,QAAQ,CAACV,EAAE;gBAC7BoB,MAAQ,EAAA;oBACNY,IAAM,EAAA;AACJhC,wBAAAA,EAAAA,EAAIsB,cAActB,EAAE;AACpBiC,wBAAAA,IAAAA,EAAMX,cAAcW;AACtB,qBAAA;oBACAC,EAAI,EAAA;AACFlC,wBAAAA,EAAAA,EAAIwB,aAAaxB,EAAE;AACnBiC,wBAAAA,IAAAA,EAAMT,aAAaS;AACrB;AACF;AACF;AACF,SAAA,CAAA;AACF;IAEA,OAAOpB,IAAAA,EAAAA;AACT,CAAA;AAEA;;IAGA,MAAMsB,uBAAsC,GAAA,OAAOvB,GAAKC,EAAAA,IAAAA,GAAAA;IACtD,IAAID,GAAAA,CAAIE,MAAM,KAAK,SAAW,EAAA;QAC5B,OAAOD,IAAAA,EAAAA;AACT;IAEA,MAAMH,QAAAA,GAAW,MAAMK,UAAAA,CAAW,WAAaC,CAAAA,CAAAA,mBAAmB,CAACJ,GAAIK,CAAAA,WAAW,CAAClB,GAAG,EAAE;QACtFS,QAAU,EAAA;AACZ,KAAA,CAAA;AAEA,IAAA,IAAI,CAACE,QAAAA,IAAY,CAACA,QAAAA,CAAS0B,sBAAsB,EAAE;QACjD,OAAOvB,IAAAA,EAAAA;AACT;AAEA,IAAA,MAAM,EAAEP,UAAU,EAAE,GAAGM,IAAIX,MAAM;IACjC,MAAMoC,UAAAA,GAAa,MAAMvC,cAAAA,CAAec,GAAIK,CAAAA,WAAW,CAAClB,GAAG,EAAEO,UAAYM,EAAAA,GAAAA,CAAIX,MAAM,CAAA;AAEnF,IAAA,IAAIoC,WAAWrC,EAAE,KAAKU,SAAS0B,sBAAsB,CAACpC,EAAE,EAAE;QACxD,MAAM,IAAIsC,MAAOC,CAAAA,eAAe,CAAC,+CAAA,CAAA;AACnC;IAEA,OAAO1B,IAAAA,EAAAA;AACT,CAAA;AAEA,gCAAe,CAAA,KAAO;AACpBF,QAAAA,mBAAAA;AACAU,QAAAA,mBAAAA;AACAc,QAAAA;AACF,KAAA,CAAC;;;;"}

package/dist/server/services/index.js

@@ -0,0 +1,24 @@
+'use strict';
+
+var workflows = require('./workflows.js');
+var stages = require('./stages.js');
+var stagePermissions = require('./stage-permissions.js');
+var assignees = require('./assignees.js');
+var validation = require('./validation.js');
+var index = require('./metrics/index.js');
+var weeklyMetrics = require('./metrics/weekly-metrics.js');
+var documentServiceMiddleware = require('./document-service-middleware.js');
+
+var services = {
+    workflows,
+    stages,
+    'stage-permissions': stagePermissions,
+    assignees,
+    validation: validation,
+    'document-service-middlewares': documentServiceMiddleware,
+    'workflow-metrics': index.default,
+    'workflow-weekly-metrics': weeklyMetrics
+};
+
+module.exports = services;
+//# sourceMappingURL=index.js.map

package/dist/server/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../server/src/services/index.ts"],"sourcesContent":["import workflows from './workflows';\nimport stages from './stages';\nimport stagePermissions from './stage-permissions';\nimport assignees from './assignees';\nimport reviewWorkflowsValidation from './validation';\nimport reviewWorkflowsMetrics from './metrics';\nimport reviewWorkflowsWeeklyMetrics from './metrics/weekly-metrics';\nimport documentServiceMiddleware from './document-service-middleware';\n\nexport default {\n  workflows,\n  stages,\n  'stage-permissions': stagePermissions,\n  assignees,\n  validation: reviewWorkflowsValidation,\n  'document-service-middlewares': documentServiceMiddleware,\n  'workflow-metrics': reviewWorkflowsMetrics,\n  'workflow-weekly-metrics': reviewWorkflowsWeeklyMetrics,\n};\n"],"names":["workflows","stages","stagePermissions","assignees","validation","reviewWorkflowsValidation","documentServiceMiddleware","reviewWorkflowsMetrics","reviewWorkflowsWeeklyMetrics"],"mappings":";;;;;;;;;;;AASA,eAAe;AACbA,IAAAA,SAAAA;AACAC,IAAAA,MAAAA;IACA,mBAAqBC,EAAAA,gBAAAA;AACrBC,IAAAA,SAAAA;IACAC,UAAYC,EAAAA,UAAAA;IACZ,8BAAgCC,EAAAA,yBAAAA;IAChC,kBAAoBC,EAAAA,aAAAA;IACpB,yBAA2BC,EAAAA;AAC7B,CAAE;;;;"}

package/dist/server/services/index.mjs

@@ -0,0 +1,22 @@
+import workflows from './workflows.mjs';
+import stages from './stages.mjs';
+import stagePermissions from './stage-permissions.mjs';
+import assignees from './assignees.mjs';
+import reviewWorkflowsValidation from './validation.mjs';
+import reviewWorkflowsMetrics from './metrics/index.mjs';
+import reviewWorkflowsWeeklyMetrics from './metrics/weekly-metrics.mjs';
+import documentServiceMiddleware from './document-service-middleware.mjs';
+
+var services = {
+    workflows,
+    stages,
+    'stage-permissions': stagePermissions,
+    assignees,
+    validation: reviewWorkflowsValidation,
+    'document-service-middlewares': documentServiceMiddleware,
+    'workflow-metrics': reviewWorkflowsMetrics,
+    'workflow-weekly-metrics': reviewWorkflowsWeeklyMetrics
+};
+
+export { services as default };
+//# sourceMappingURL=index.mjs.map

package/dist/server/services/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../../../server/src/services/index.ts"],"sourcesContent":["import workflows from './workflows';\nimport stages from './stages';\nimport stagePermissions from './stage-permissions';\nimport assignees from './assignees';\nimport reviewWorkflowsValidation from './validation';\nimport reviewWorkflowsMetrics from './metrics';\nimport reviewWorkflowsWeeklyMetrics from './metrics/weekly-metrics';\nimport documentServiceMiddleware from './document-service-middleware';\n\nexport default {\n  workflows,\n  stages,\n  'stage-permissions': stagePermissions,\n  assignees,\n  validation: reviewWorkflowsValidation,\n  'document-service-middlewares': documentServiceMiddleware,\n  'workflow-metrics': reviewWorkflowsMetrics,\n  'workflow-weekly-metrics': reviewWorkflowsWeeklyMetrics,\n};\n"],"names":["workflows","stages","stagePermissions","assignees","validation","reviewWorkflowsValidation","documentServiceMiddleware","reviewWorkflowsMetrics","reviewWorkflowsWeeklyMetrics"],"mappings":";;;;;;;;;AASA,eAAe;AACbA,IAAAA,SAAAA;AACAC,IAAAA,MAAAA;IACA,mBAAqBC,EAAAA,gBAAAA;AACrBC,IAAAA,SAAAA;IACAC,UAAYC,EAAAA,yBAAAA;IACZ,8BAAgCC,EAAAA,yBAAAA;IAChC,kBAAoBC,EAAAA,sBAAAA;IACpB,yBAA2BC,EAAAA;AAC7B,CAAE;;;;"}

package/dist/server/services/metrics/index.js

@@ -0,0 +1,67 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+require('@strapi/types');
+
+const sendDidCreateStage = async ()=>{
+    strapi.telemetry.send('didCreateStage', {});
+};
+const sendDidEditStage = async ()=>{
+    strapi.telemetry.send('didEditStage', {});
+};
+const sendDidDeleteStage = async ()=>{
+    strapi.telemetry.send('didDeleteStage', {});
+};
+const sendDidChangeEntryStage = async ()=>{
+    strapi.telemetry.send('didChangeEntryStage', {});
+};
+const sendDidCreateWorkflow = async (workflowId, hasRequiredStageToPublish)=>{
+    strapi.telemetry.send('didCreateWorkflow', {
+        workflowId,
+        hasRequiredStageToPublish
+    });
+};
+const sendDidEditWorkflow = async (workflowId, hasRequiredStageToPublish)=>{
+    strapi.telemetry.send('didEditWorkflow', {
+        workflowId,
+        hasRequiredStageToPublish
+    });
+};
+const sendDidEditAssignee = async (fromId, toId)=>{
+    strapi.telemetry.send('didEditAssignee', {
+        from: fromId,
+        to: toId
+    });
+};
+const sendDidSendReviewWorkflowPropertiesOnceAWeek = async (numberOfActiveWorkflows, avgStagesCount, maxStagesCount, activatedContentTypes)=>{
+    strapi.telemetry.send('didSendReviewWorkflowPropertiesOnceAWeek', {
+        groupProperties: {
+            numberOfActiveWorkflows,
+            avgStagesCount,
+            maxStagesCount,
+            activatedContentTypes
+        }
+    });
+};
+var reviewWorkflowsMetrics = {
+    sendDidCreateStage,
+    sendDidEditStage,
+    sendDidDeleteStage,
+    sendDidChangeEntryStage,
+    sendDidCreateWorkflow,
+    sendDidEditWorkflow,
+    sendDidSendReviewWorkflowPropertiesOnceAWeek,
+    sendDidEditAssignee
+};
+
+exports.default = reviewWorkflowsMetrics;
+exports.sendDidChangeEntryStage = sendDidChangeEntryStage;
+exports.sendDidCreateStage = sendDidCreateStage;
+exports.sendDidCreateWorkflow = sendDidCreateWorkflow;
+exports.sendDidDeleteStage = sendDidDeleteStage;
+exports.sendDidEditAssignee = sendDidEditAssignee;
+exports.sendDidEditStage = sendDidEditStage;
+exports.sendDidEditWorkflow = sendDidEditWorkflow;
+exports.sendDidSendReviewWorkflowPropertiesOnceAWeek = sendDidSendReviewWorkflowPropertiesOnceAWeek;
+//# sourceMappingURL=index.js.map

package/dist/server/services/metrics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../../server/src/services/metrics/index.ts"],"sourcesContent":["import '@strapi/types';\n\nexport const sendDidCreateStage = async () => {\n  strapi.telemetry.send('didCreateStage', {});\n};\n\nexport const sendDidEditStage = async () => {\n  strapi.telemetry.send('didEditStage', {});\n};\n\nexport const sendDidDeleteStage = async () => {\n  strapi.telemetry.send('didDeleteStage', {});\n};\n\nexport const sendDidChangeEntryStage = async () => {\n  strapi.telemetry.send('didChangeEntryStage', {});\n};\n\nexport const sendDidCreateWorkflow = async (\n  workflowId: string,\n  hasRequiredStageToPublish: boolean\n) => {\n  strapi.telemetry.send('didCreateWorkflow', { workflowId, hasRequiredStageToPublish });\n};\n\nexport const sendDidEditWorkflow = async (\n  workflowId: string,\n  hasRequiredStageToPublish: boolean\n) => {\n  strapi.telemetry.send('didEditWorkflow', { workflowId, hasRequiredStageToPublish });\n};\n\nexport const sendDidEditAssignee = async (fromId: any, toId: any) => {\n  strapi.telemetry.send('didEditAssignee', { from: fromId, to: toId });\n};\n\nexport const sendDidSendReviewWorkflowPropertiesOnceAWeek = async (\n  numberOfActiveWorkflows: number,\n  avgStagesCount: number,\n  maxStagesCount: number,\n  activatedContentTypes: number\n) => {\n  strapi.telemetry.send('didSendReviewWorkflowPropertiesOnceAWeek', {\n    groupProperties: {\n      numberOfActiveWorkflows,\n      avgStagesCount,\n      maxStagesCount,\n      activatedContentTypes,\n    },\n  });\n};\n\nexport default {\n  sendDidCreateStage,\n  sendDidEditStage,\n  sendDidDeleteStage,\n  sendDidChangeEntryStage,\n  sendDidCreateWorkflow,\n  sendDidEditWorkflow,\n  sendDidSendReviewWorkflowPropertiesOnceAWeek,\n  sendDidEditAssignee,\n};\n"],"names":["sendDidCreateStage","strapi","telemetry","send","sendDidEditStage","sendDidDeleteStage","sendDidChangeEntryStage","sendDidCreateWorkflow","workflowId","hasRequiredStageToPublish","sendDidEditWorkflow","sendDidEditAssignee","fromId","toId","from","to","sendDidSendReviewWorkflowPropertiesOnceAWeek","numberOfActiveWorkflows","avgStagesCount","maxStagesCount","activatedContentTypes","groupProperties"],"mappings":";;;;;;MAEaA,kBAAqB,GAAA,UAAA;AAChCC,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,kBAAkB,EAAC,CAAA;AAC3C;MAEaC,gBAAmB,GAAA,UAAA;AAC9BH,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,gBAAgB,EAAC,CAAA;AACzC;MAEaE,kBAAqB,GAAA,UAAA;AAChCJ,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,kBAAkB,EAAC,CAAA;AAC3C;MAEaG,uBAA0B,GAAA,UAAA;AACrCL,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,uBAAuB,EAAC,CAAA;AAChD;AAEO,MAAMI,qBAAwB,GAAA,OACnCC,UACAC,EAAAA,yBAAAA,GAAAA;AAEAR,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,mBAAqB,EAAA;AAAEK,QAAAA,UAAAA;AAAYC,QAAAA;AAA0B,KAAA,CAAA;AACrF;AAEO,MAAMC,mBAAsB,GAAA,OACjCF,UACAC,EAAAA,yBAAAA,GAAAA;AAEAR,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,iBAAmB,EAAA;AAAEK,QAAAA,UAAAA;AAAYC,QAAAA;AAA0B,KAAA,CAAA;AACnF;AAEO,MAAME,mBAAsB,GAAA,OAAOC,MAAaC,EAAAA,IAAAA,GAAAA;AACrDZ,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,iBAAmB,EAAA;QAAEW,IAAMF,EAAAA,MAAAA;QAAQG,EAAIF,EAAAA;AAAK,KAAA,CAAA;AACpE;AAEaG,MAAAA,4CAAAA,GAA+C,OAC1DC,uBAAAA,EACAC,gBACAC,cACAC,EAAAA,qBAAAA,GAAAA;AAEAnB,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,0CAA4C,EAAA;QAChEkB,eAAiB,EAAA;AACfJ,YAAAA,uBAAAA;AACAC,YAAAA,cAAAA;AACAC,YAAAA,cAAAA;AACAC,YAAAA;AACF;AACF,KAAA,CAAA;AACF;AAEA,6BAAe;AACbpB,IAAAA,kBAAAA;AACAI,IAAAA,gBAAAA;AACAC,IAAAA,kBAAAA;AACAC,IAAAA,uBAAAA;AACAC,IAAAA,qBAAAA;AACAG,IAAAA,mBAAAA;AACAM,IAAAA,4CAAAA;AACAL,IAAAA;AACF,CAAE;;;;;;;;;;;;"}

package/dist/server/services/metrics/index.mjs

@@ -0,0 +1,55 @@
+import '@strapi/types';
+
+const sendDidCreateStage = async ()=>{
+    strapi.telemetry.send('didCreateStage', {});
+};
+const sendDidEditStage = async ()=>{
+    strapi.telemetry.send('didEditStage', {});
+};
+const sendDidDeleteStage = async ()=>{
+    strapi.telemetry.send('didDeleteStage', {});
+};
+const sendDidChangeEntryStage = async ()=>{
+    strapi.telemetry.send('didChangeEntryStage', {});
+};
+const sendDidCreateWorkflow = async (workflowId, hasRequiredStageToPublish)=>{
+    strapi.telemetry.send('didCreateWorkflow', {
+        workflowId,
+        hasRequiredStageToPublish
+    });
+};
+const sendDidEditWorkflow = async (workflowId, hasRequiredStageToPublish)=>{
+    strapi.telemetry.send('didEditWorkflow', {
+        workflowId,
+        hasRequiredStageToPublish
+    });
+};
+const sendDidEditAssignee = async (fromId, toId)=>{
+    strapi.telemetry.send('didEditAssignee', {
+        from: fromId,
+        to: toId
+    });
+};
+const sendDidSendReviewWorkflowPropertiesOnceAWeek = async (numberOfActiveWorkflows, avgStagesCount, maxStagesCount, activatedContentTypes)=>{
+    strapi.telemetry.send('didSendReviewWorkflowPropertiesOnceAWeek', {
+        groupProperties: {
+            numberOfActiveWorkflows,
+            avgStagesCount,
+            maxStagesCount,
+            activatedContentTypes
+        }
+    });
+};
+var reviewWorkflowsMetrics = {
+    sendDidCreateStage,
+    sendDidEditStage,
+    sendDidDeleteStage,
+    sendDidChangeEntryStage,
+    sendDidCreateWorkflow,
+    sendDidEditWorkflow,
+    sendDidSendReviewWorkflowPropertiesOnceAWeek,
+    sendDidEditAssignee
+};
+
+export { reviewWorkflowsMetrics as default, sendDidChangeEntryStage, sendDidCreateStage, sendDidCreateWorkflow, sendDidDeleteStage, sendDidEditAssignee, sendDidEditStage, sendDidEditWorkflow, sendDidSendReviewWorkflowPropertiesOnceAWeek };
+//# sourceMappingURL=index.mjs.map

package/dist/server/services/metrics/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../../../../server/src/services/metrics/index.ts"],"sourcesContent":["import '@strapi/types';\n\nexport const sendDidCreateStage = async () => {\n  strapi.telemetry.send('didCreateStage', {});\n};\n\nexport const sendDidEditStage = async () => {\n  strapi.telemetry.send('didEditStage', {});\n};\n\nexport const sendDidDeleteStage = async () => {\n  strapi.telemetry.send('didDeleteStage', {});\n};\n\nexport const sendDidChangeEntryStage = async () => {\n  strapi.telemetry.send('didChangeEntryStage', {});\n};\n\nexport const sendDidCreateWorkflow = async (\n  workflowId: string,\n  hasRequiredStageToPublish: boolean\n) => {\n  strapi.telemetry.send('didCreateWorkflow', { workflowId, hasRequiredStageToPublish });\n};\n\nexport const sendDidEditWorkflow = async (\n  workflowId: string,\n  hasRequiredStageToPublish: boolean\n) => {\n  strapi.telemetry.send('didEditWorkflow', { workflowId, hasRequiredStageToPublish });\n};\n\nexport const sendDidEditAssignee = async (fromId: any, toId: any) => {\n  strapi.telemetry.send('didEditAssignee', { from: fromId, to: toId });\n};\n\nexport const sendDidSendReviewWorkflowPropertiesOnceAWeek = async (\n  numberOfActiveWorkflows: number,\n  avgStagesCount: number,\n  maxStagesCount: number,\n  activatedContentTypes: number\n) => {\n  strapi.telemetry.send('didSendReviewWorkflowPropertiesOnceAWeek', {\n    groupProperties: {\n      numberOfActiveWorkflows,\n      avgStagesCount,\n      maxStagesCount,\n      activatedContentTypes,\n    },\n  });\n};\n\nexport default {\n  sendDidCreateStage,\n  sendDidEditStage,\n  sendDidDeleteStage,\n  sendDidChangeEntryStage,\n  sendDidCreateWorkflow,\n  sendDidEditWorkflow,\n  sendDidSendReviewWorkflowPropertiesOnceAWeek,\n  sendDidEditAssignee,\n};\n"],"names":["sendDidCreateStage","strapi","telemetry","send","sendDidEditStage","sendDidDeleteStage","sendDidChangeEntryStage","sendDidCreateWorkflow","workflowId","hasRequiredStageToPublish","sendDidEditWorkflow","sendDidEditAssignee","fromId","toId","from","to","sendDidSendReviewWorkflowPropertiesOnceAWeek","numberOfActiveWorkflows","avgStagesCount","maxStagesCount","activatedContentTypes","groupProperties"],"mappings":";;MAEaA,kBAAqB,GAAA,UAAA;AAChCC,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,kBAAkB,EAAC,CAAA;AAC3C;MAEaC,gBAAmB,GAAA,UAAA;AAC9BH,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,gBAAgB,EAAC,CAAA;AACzC;MAEaE,kBAAqB,GAAA,UAAA;AAChCJ,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,kBAAkB,EAAC,CAAA;AAC3C;MAEaG,uBAA0B,GAAA,UAAA;AACrCL,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,uBAAuB,EAAC,CAAA;AAChD;AAEO,MAAMI,qBAAwB,GAAA,OACnCC,UACAC,EAAAA,yBAAAA,GAAAA;AAEAR,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,mBAAqB,EAAA;AAAEK,QAAAA,UAAAA;AAAYC,QAAAA;AAA0B,KAAA,CAAA;AACrF;AAEO,MAAMC,mBAAsB,GAAA,OACjCF,UACAC,EAAAA,yBAAAA,GAAAA;AAEAR,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,iBAAmB,EAAA;AAAEK,QAAAA,UAAAA;AAAYC,QAAAA;AAA0B,KAAA,CAAA;AACnF;AAEO,MAAME,mBAAsB,GAAA,OAAOC,MAAaC,EAAAA,IAAAA,GAAAA;AACrDZ,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,iBAAmB,EAAA;QAAEW,IAAMF,EAAAA,MAAAA;QAAQG,EAAIF,EAAAA;AAAK,KAAA,CAAA;AACpE;AAEaG,MAAAA,4CAAAA,GAA+C,OAC1DC,uBAAAA,EACAC,gBACAC,cACAC,EAAAA,qBAAAA,GAAAA;AAEAnB,IAAAA,MAAAA,CAAOC,SAAS,CAACC,IAAI,CAAC,0CAA4C,EAAA;QAChEkB,eAAiB,EAAA;AACfJ,YAAAA,uBAAAA;AACAC,YAAAA,cAAAA;AACAC,YAAAA,cAAAA;AACAC,YAAAA;AACF;AACF,KAAA,CAAA;AACF;AAEA,6BAAe;AACbpB,IAAAA,kBAAAA;AACAI,IAAAA,gBAAAA;AACAC,IAAAA,kBAAAA;AACAC,IAAAA,uBAAAA;AACAC,IAAAA,qBAAAA;AACAG,IAAAA,mBAAAA;AACAM,IAAAA,4CAAAA;AACAL,IAAAA;AACF,CAAE;;;;"}

package/dist/server/services/metrics/weekly-metrics.js

@@ -0,0 +1,84 @@
+'use strict';
+
+var fp = require('lodash/fp');
+var dateFns = require('date-fns');
+var index = require('../../utils/index.js');
+
+const ONE_WEEK = 7 * 24 * 60 * 60 * 1000;
+const getWeeklyCronScheduleAt = (date)=>`${date.getSeconds()} ${date.getMinutes()} ${date.getHours()} * * ${date.getDay()}`;
+var reviewWorkflowsWeeklyMetrics = (({ strapi })=>{
+    const metrics = index.getService('workflow-metrics', {
+        strapi
+    });
+    const workflowsService = index.getService('workflows', {
+        strapi
+    });
+    const getMetricsStoreValue = async ()=>{
+        const value = await strapi.store.get({
+            type: 'plugin',
+            name: 'ee',
+            key: 'metrics'
+        });
+        return fp.defaultTo({}, value);
+    };
+    const setMetricsStoreValue = (value)=>strapi.store.set({
+            type: 'plugin',
+            name: 'ee',
+            key: 'metrics',
+            value
+        });
+    return {
+        async computeMetrics () {
+            // There will never be more than 200 workflow, so we can safely fetch them all
+            const workflows = await workflowsService.find({
+                populate: 'stages'
+            });
+            const stagesCount = fp.flow(fp.map('stages'), fp.map(fp.size))(workflows);
+            const contentTypesCount = fp.flow(fp.map('contentTypes'), fp.map(fp.size))(workflows);
+            return {
+                numberOfActiveWorkflows: fp.size(workflows),
+                avgStagesCount: fp.mean(stagesCount),
+                maxStagesCount: fp.max(stagesCount),
+                activatedContentTypes: fp.sum(contentTypesCount)
+            };
+        },
+        async sendMetrics () {
+            const computedMetrics = await this.computeMetrics();
+            metrics.sendDidSendReviewWorkflowPropertiesOnceAWeek(computedMetrics);
+            const metricsInfoStored = await getMetricsStoreValue();
+            // @ts-expect-error metricsInfoStored can use spread
+            await setMetricsStoreValue({
+                ...metricsInfoStored,
+                lastWeeklyUpdate: new Date().getTime()
+            });
+        },
+        async ensureWeeklyStoredCronSchedule () {
+            const metricsInfoStored = await getMetricsStoreValue();
+            const { weeklySchedule: currentSchedule, lastWeeklyUpdate } = metricsInfoStored;
+            const now = new Date();
+            let weeklySchedule = currentSchedule;
+            if (!currentSchedule || !lastWeeklyUpdate || lastWeeklyUpdate + ONE_WEEK < now.getTime()) {
+                weeklySchedule = getWeeklyCronScheduleAt(dateFns.add(now, {
+                    seconds: 15
+                }));
+                await setMetricsStoreValue({
+                    ...metricsInfoStored,
+                    weeklySchedule
+                });
+            }
+            return weeklySchedule;
+        },
+        async registerCron () {
+            const weeklySchedule = await this.ensureWeeklyStoredCronSchedule();
+            strapi.cron.add({
+                reviewWorkflowsWeekly: {
+                    task: this.sendMetrics.bind(this),
+                    options: weeklySchedule
+                }
+            });
+        }
+    };
+});
+
+module.exports = reviewWorkflowsWeeklyMetrics;
+//# sourceMappingURL=weekly-metrics.js.map

package/dist/server/services/metrics/weekly-metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weekly-metrics.js","sources":["../../../../server/src/services/metrics/weekly-metrics.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\nimport { flow, map, sum, size, mean, max, defaultTo } from 'lodash/fp';\nimport { add } from 'date-fns';\nimport { getService } from '../../utils';\n\nconst ONE_WEEK = 7 * 24 * 60 * 60 * 1000;\n\nconst getWeeklyCronScheduleAt = (date: Date) =>\n  `${date.getSeconds()} ${date.getMinutes()} ${date.getHours()} * * ${date.getDay()}`;\n\nexport default ({ strapi }: { strapi: Core.Strapi }) => {\n  const metrics = getService('workflow-metrics', { strapi });\n  const workflowsService = getService('workflows', { strapi });\n\n  const getMetricsStoreValue = async () => {\n    const value = await strapi.store.get({ type: 'plugin', name: 'ee', key: 'metrics' });\n    return defaultTo({}, value);\n  };\n\n  const setMetricsStoreValue = (value: unknown) =>\n    strapi.store.set({ type: 'plugin', name: 'ee', key: 'metrics', value });\n\n  return {\n    async computeMetrics() {\n      // There will never be more than 200 workflow, so we can safely fetch them all\n      const workflows = await workflowsService.find({ populate: 'stages' });\n\n      const stagesCount = flow(\n        map('stages'), // Number of stages per workflow\n        map(size)\n      )(workflows);\n\n      const contentTypesCount = flow(\n        map('contentTypes'), // Number of content types per workflow\n        map(size)\n      )(workflows);\n\n      return {\n        numberOfActiveWorkflows: size(workflows),\n        avgStagesCount: mean(stagesCount),\n        maxStagesCount: max(stagesCount),\n        activatedContentTypes: sum(contentTypesCount),\n      };\n    },\n\n    async sendMetrics() {\n      const computedMetrics = await this.computeMetrics();\n      metrics.sendDidSendReviewWorkflowPropertiesOnceAWeek(computedMetrics);\n\n      const metricsInfoStored = await getMetricsStoreValue();\n      // @ts-expect-error metricsInfoStored can use spread\n      await setMetricsStoreValue({ ...metricsInfoStored, lastWeeklyUpdate: new Date().getTime() });\n    },\n\n    async ensureWeeklyStoredCronSchedule() {\n      const metricsInfoStored: any = await getMetricsStoreValue();\n      const { weeklySchedule: currentSchedule, lastWeeklyUpdate } = metricsInfoStored;\n\n      const now = new Date();\n      let weeklySchedule = currentSchedule;\n\n      if (!currentSchedule || !lastWeeklyUpdate || lastWeeklyUpdate + ONE_WEEK < now.getTime()) {\n        weeklySchedule = getWeeklyCronScheduleAt(add(now, { seconds: 15 }));\n        await setMetricsStoreValue({ ...metricsInfoStored, weeklySchedule });\n      }\n\n      return weeklySchedule;\n    },\n\n    async registerCron() {\n      const weeklySchedule = await this.ensureWeeklyStoredCronSchedule();\n\n      strapi.cron.add({\n        reviewWorkflowsWeekly: {\n          task: this.sendMetrics.bind(this),\n          options: weeklySchedule,\n        },\n      });\n    },\n  };\n};\n"],"names":["ONE_WEEK","getWeeklyCronScheduleAt","date","getSeconds","getMinutes","getHours","getDay","strapi","metrics","getService","workflowsService","getMetricsStoreValue","value","store","get","type","name","key","defaultTo","setMetricsStoreValue","set","computeMetrics","workflows","find","populate","stagesCount","flow","map","size","contentTypesCount","numberOfActiveWorkflows","avgStagesCount","mean","maxStagesCount","max","activatedContentTypes","sum","sendMetrics","computedMetrics","sendDidSendReviewWorkflowPropertiesOnceAWeek","metricsInfoStored","lastWeeklyUpdate","Date","getTime","ensureWeeklyStoredCronSchedule","weeklySchedule","currentSchedule","now","add","seconds","registerCron","cron","reviewWorkflowsWeekly","task","bind","options"],"mappings":";;;;;;AAKA,MAAMA,QAAW,GAAA,CAAA,GAAI,EAAK,GAAA,EAAA,GAAK,EAAK,GAAA,IAAA;AAEpC,MAAMC,uBAAAA,GAA0B,CAACC,IAC/B,GAAA,CAAC,EAAEA,IAAKC,CAAAA,UAAU,EAAG,CAAA,CAAC,EAAED,IAAAA,CAAKE,UAAU,EAAG,CAAA,CAAC,EAAEF,IAAAA,CAAKG,QAAQ,EAAA,CAAG,KAAK,EAAEH,IAAAA,CAAKI,MAAM,EAAA,CAAG,CAAC;AAErF,mCAAe,CAAA,CAAC,EAAEC,MAAM,EAA2B,GAAA;IACjD,MAAMC,OAAAA,GAAUC,iBAAW,kBAAoB,EAAA;AAAEF,QAAAA;AAAO,KAAA,CAAA;IACxD,MAAMG,gBAAAA,GAAmBD,iBAAW,WAAa,EAAA;AAAEF,QAAAA;AAAO,KAAA,CAAA;AAE1D,IAAA,MAAMI,oBAAuB,GAAA,UAAA;AAC3B,QAAA,MAAMC,QAAQ,MAAML,MAAAA,CAAOM,KAAK,CAACC,GAAG,CAAC;YAAEC,IAAM,EAAA,QAAA;YAAUC,IAAM,EAAA,IAAA;YAAMC,GAAK,EAAA;AAAU,SAAA,CAAA;QAClF,OAAOC,YAAAA,CAAU,EAAIN,EAAAA,KAAAA,CAAAA;AACvB,KAAA;AAEA,IAAA,MAAMO,uBAAuB,CAACP,KAAAA,GAC5BL,OAAOM,KAAK,CAACO,GAAG,CAAC;YAAEL,IAAM,EAAA,QAAA;YAAUC,IAAM,EAAA,IAAA;YAAMC,GAAK,EAAA,SAAA;AAAWL,YAAAA;AAAM,SAAA,CAAA;IAEvE,OAAO;QACL,MAAMS,cAAAA,CAAAA,GAAAA;;AAEJ,YAAA,MAAMC,SAAY,GAAA,MAAMZ,gBAAiBa,CAAAA,IAAI,CAAC;gBAAEC,QAAU,EAAA;AAAS,aAAA,CAAA;AAEnE,YAAA,MAAMC,WAAcC,GAAAA,OAAAA,CAClBC,MAAI,CAAA,QAAA,CAAA,EACJA,OAAIC,OACJN,CAAAA,CAAAA,CAAAA,SAAAA,CAAAA;AAEF,YAAA,MAAMO,iBAAoBH,GAAAA,OAAAA,CACxBC,MAAI,CAAA,cAAA,CAAA,EACJA,OAAIC,OACJN,CAAAA,CAAAA,CAAAA,SAAAA,CAAAA;YAEF,OAAO;AACLQ,gBAAAA,uBAAAA,EAAyBF,OAAKN,CAAAA,SAAAA,CAAAA;AAC9BS,gBAAAA,cAAAA,EAAgBC,OAAKP,CAAAA,WAAAA,CAAAA;AACrBQ,gBAAAA,cAAAA,EAAgBC,MAAIT,CAAAA,WAAAA,CAAAA;AACpBU,gBAAAA,qBAAAA,EAAuBC,MAAIP,CAAAA,iBAAAA;AAC7B,aAAA;AACF,SAAA;QAEA,MAAMQ,WAAAA,CAAAA,GAAAA;AACJ,YAAA,MAAMC,eAAkB,GAAA,MAAM,IAAI,CAACjB,cAAc,EAAA;AACjDb,YAAAA,OAAAA,CAAQ+B,4CAA4C,CAACD,eAAAA,CAAAA;AAErD,YAAA,MAAME,oBAAoB,MAAM7B,oBAAAA,EAAAA;;AAEhC,YAAA,MAAMQ,oBAAqB,CAAA;AAAE,gBAAA,GAAGqB,iBAAiB;gBAAEC,gBAAkB,EAAA,IAAIC,OAAOC,OAAO;AAAG,aAAA,CAAA;AAC5F,SAAA;QAEA,MAAMC,8BAAAA,CAAAA,GAAAA;AACJ,YAAA,MAAMJ,oBAAyB,MAAM7B,oBAAAA,EAAAA;AACrC,YAAA,MAAM,EAAEkC,cAAgBC,EAAAA,eAAe,EAAEL,gBAAgB,EAAE,GAAGD,iBAAAA;AAE9D,YAAA,MAAMO,MAAM,IAAIL,IAAAA,EAAAA;AAChB,YAAA,IAAIG,cAAiBC,GAAAA,eAAAA;YAErB,IAAI,CAACA,mBAAmB,CAACL,gBAAAA,IAAoBA,mBAAmBzC,QAAW+C,GAAAA,GAAAA,CAAIJ,OAAO,EAAI,EAAA;gBACxFE,cAAiB5C,GAAAA,uBAAAA,CAAwB+C,YAAID,GAAK,EAAA;oBAAEE,OAAS,EAAA;AAAG,iBAAA,CAAA,CAAA;AAChE,gBAAA,MAAM9B,oBAAqB,CAAA;AAAE,oBAAA,GAAGqB,iBAAiB;AAAEK,oBAAAA;AAAe,iBAAA,CAAA;AACpE;YAEA,OAAOA,cAAAA;AACT,SAAA;QAEA,MAAMK,YAAAA,CAAAA,GAAAA;AACJ,YAAA,MAAML,cAAiB,GAAA,MAAM,IAAI,CAACD,8BAA8B,EAAA;YAEhErC,MAAO4C,CAAAA,IAAI,CAACH,GAAG,CAAC;gBACdI,qBAAuB,EAAA;AACrBC,oBAAAA,IAAAA,EAAM,IAAI,CAAChB,WAAW,CAACiB,IAAI,CAAC,IAAI,CAAA;oBAChCC,OAASV,EAAAA;AACX;AACF,aAAA,CAAA;AACF;AACF,KAAA;AACF,CAAA;;;;"}

package/dist/server/services/metrics/weekly-metrics.mjs

@@ -0,0 +1,82 @@
+import { flow, map, size, mean, max, sum, defaultTo } from 'lodash/fp';
+import { add } from 'date-fns';
+import { getService } from '../../utils/index.mjs';
+
+const ONE_WEEK = 7 * 24 * 60 * 60 * 1000;
+const getWeeklyCronScheduleAt = (date)=>`${date.getSeconds()} ${date.getMinutes()} ${date.getHours()} * * ${date.getDay()}`;
+var reviewWorkflowsWeeklyMetrics = (({ strapi })=>{
+    const metrics = getService('workflow-metrics', {
+        strapi
+    });
+    const workflowsService = getService('workflows', {
+        strapi
+    });
+    const getMetricsStoreValue = async ()=>{
+        const value = await strapi.store.get({
+            type: 'plugin',
+            name: 'ee',
+            key: 'metrics'
+        });
+        return defaultTo({}, value);
+    };
+    const setMetricsStoreValue = (value)=>strapi.store.set({
+            type: 'plugin',
+            name: 'ee',
+            key: 'metrics',
+            value
+        });
+    return {
+        async computeMetrics () {
+            // There will never be more than 200 workflow, so we can safely fetch them all
+            const workflows = await workflowsService.find({
+                populate: 'stages'
+            });
+            const stagesCount = flow(map('stages'), map(size))(workflows);
+            const contentTypesCount = flow(map('contentTypes'), map(size))(workflows);
+            return {
+                numberOfActiveWorkflows: size(workflows),
+                avgStagesCount: mean(stagesCount),
+                maxStagesCount: max(stagesCount),
+                activatedContentTypes: sum(contentTypesCount)
+            };
+        },
+        async sendMetrics () {
+            const computedMetrics = await this.computeMetrics();
+            metrics.sendDidSendReviewWorkflowPropertiesOnceAWeek(computedMetrics);
+            const metricsInfoStored = await getMetricsStoreValue();
+            // @ts-expect-error metricsInfoStored can use spread
+            await setMetricsStoreValue({
+                ...metricsInfoStored,
+                lastWeeklyUpdate: new Date().getTime()
+            });
+        },
+        async ensureWeeklyStoredCronSchedule () {
+            const metricsInfoStored = await getMetricsStoreValue();
+            const { weeklySchedule: currentSchedule, lastWeeklyUpdate } = metricsInfoStored;
+            const now = new Date();
+            let weeklySchedule = currentSchedule;
+            if (!currentSchedule || !lastWeeklyUpdate || lastWeeklyUpdate + ONE_WEEK < now.getTime()) {
+                weeklySchedule = getWeeklyCronScheduleAt(add(now, {
+                    seconds: 15
+                }));
+                await setMetricsStoreValue({
+                    ...metricsInfoStored,
+                    weeklySchedule
+                });
+            }
+            return weeklySchedule;
+        },
+        async registerCron () {
+            const weeklySchedule = await this.ensureWeeklyStoredCronSchedule();
+            strapi.cron.add({
+                reviewWorkflowsWeekly: {
+                    task: this.sendMetrics.bind(this),
+                    options: weeklySchedule
+                }
+            });
+        }
+    };
+});
+
+export { reviewWorkflowsWeeklyMetrics as default };
+//# sourceMappingURL=weekly-metrics.mjs.map

package/dist/server/services/metrics/weekly-metrics.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"weekly-metrics.mjs","sources":["../../../../server/src/services/metrics/weekly-metrics.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\nimport { flow, map, sum, size, mean, max, defaultTo } from 'lodash/fp';\nimport { add } from 'date-fns';\nimport { getService } from '../../utils';\n\nconst ONE_WEEK = 7 * 24 * 60 * 60 * 1000;\n\nconst getWeeklyCronScheduleAt = (date: Date) =>\n  `${date.getSeconds()} ${date.getMinutes()} ${date.getHours()} * * ${date.getDay()}`;\n\nexport default ({ strapi }: { strapi: Core.Strapi }) => {\n  const metrics = getService('workflow-metrics', { strapi });\n  const workflowsService = getService('workflows', { strapi });\n\n  const getMetricsStoreValue = async () => {\n    const value = await strapi.store.get({ type: 'plugin', name: 'ee', key: 'metrics' });\n    return defaultTo({}, value);\n  };\n\n  const setMetricsStoreValue = (value: unknown) =>\n    strapi.store.set({ type: 'plugin', name: 'ee', key: 'metrics', value });\n\n  return {\n    async computeMetrics() {\n      // There will never be more than 200 workflow, so we can safely fetch them all\n      const workflows = await workflowsService.find({ populate: 'stages' });\n\n      const stagesCount = flow(\n        map('stages'), // Number of stages per workflow\n        map(size)\n      )(workflows);\n\n      const contentTypesCount = flow(\n        map('contentTypes'), // Number of content types per workflow\n        map(size)\n      )(workflows);\n\n      return {\n        numberOfActiveWorkflows: size(workflows),\n        avgStagesCount: mean(stagesCount),\n        maxStagesCount: max(stagesCount),\n        activatedContentTypes: sum(contentTypesCount),\n      };\n    },\n\n    async sendMetrics() {\n      const computedMetrics = await this.computeMetrics();\n      metrics.sendDidSendReviewWorkflowPropertiesOnceAWeek(computedMetrics);\n\n      const metricsInfoStored = await getMetricsStoreValue();\n      // @ts-expect-error metricsInfoStored can use spread\n      await setMetricsStoreValue({ ...metricsInfoStored, lastWeeklyUpdate: new Date().getTime() });\n    },\n\n    async ensureWeeklyStoredCronSchedule() {\n      const metricsInfoStored: any = await getMetricsStoreValue();\n      const { weeklySchedule: currentSchedule, lastWeeklyUpdate } = metricsInfoStored;\n\n      const now = new Date();\n      let weeklySchedule = currentSchedule;\n\n      if (!currentSchedule || !lastWeeklyUpdate || lastWeeklyUpdate + ONE_WEEK < now.getTime()) {\n        weeklySchedule = getWeeklyCronScheduleAt(add(now, { seconds: 15 }));\n        await setMetricsStoreValue({ ...metricsInfoStored, weeklySchedule });\n      }\n\n      return weeklySchedule;\n    },\n\n    async registerCron() {\n      const weeklySchedule = await this.ensureWeeklyStoredCronSchedule();\n\n      strapi.cron.add({\n        reviewWorkflowsWeekly: {\n          task: this.sendMetrics.bind(this),\n          options: weeklySchedule,\n        },\n      });\n    },\n  };\n};\n"],"names":["ONE_WEEK","getWeeklyCronScheduleAt","date","getSeconds","getMinutes","getHours","getDay","strapi","metrics","getService","workflowsService","getMetricsStoreValue","value","store","get","type","name","key","defaultTo","setMetricsStoreValue","set","computeMetrics","workflows","find","populate","stagesCount","flow","map","size","contentTypesCount","numberOfActiveWorkflows","avgStagesCount","mean","maxStagesCount","max","activatedContentTypes","sum","sendMetrics","computedMetrics","sendDidSendReviewWorkflowPropertiesOnceAWeek","metricsInfoStored","lastWeeklyUpdate","Date","getTime","ensureWeeklyStoredCronSchedule","weeklySchedule","currentSchedule","now","add","seconds","registerCron","cron","reviewWorkflowsWeekly","task","bind","options"],"mappings":";;;;AAKA,MAAMA,QAAW,GAAA,CAAA,GAAI,EAAK,GAAA,EAAA,GAAK,EAAK,GAAA,IAAA;AAEpC,MAAMC,uBAAAA,GAA0B,CAACC,IAC/B,GAAA,CAAC,EAAEA,IAAKC,CAAAA,UAAU,EAAG,CAAA,CAAC,EAAED,IAAAA,CAAKE,UAAU,EAAG,CAAA,CAAC,EAAEF,IAAAA,CAAKG,QAAQ,EAAA,CAAG,KAAK,EAAEH,IAAAA,CAAKI,MAAM,EAAA,CAAG,CAAC;AAErF,mCAAe,CAAA,CAAC,EAAEC,MAAM,EAA2B,GAAA;IACjD,MAAMC,OAAAA,GAAUC,WAAW,kBAAoB,EAAA;AAAEF,QAAAA;AAAO,KAAA,CAAA;IACxD,MAAMG,gBAAAA,GAAmBD,WAAW,WAAa,EAAA;AAAEF,QAAAA;AAAO,KAAA,CAAA;AAE1D,IAAA,MAAMI,oBAAuB,GAAA,UAAA;AAC3B,QAAA,MAAMC,QAAQ,MAAML,MAAAA,CAAOM,KAAK,CAACC,GAAG,CAAC;YAAEC,IAAM,EAAA,QAAA;YAAUC,IAAM,EAAA,IAAA;YAAMC,GAAK,EAAA;AAAU,SAAA,CAAA;QAClF,OAAOC,SAAAA,CAAU,EAAIN,EAAAA,KAAAA,CAAAA;AACvB,KAAA;AAEA,IAAA,MAAMO,uBAAuB,CAACP,KAAAA,GAC5BL,OAAOM,KAAK,CAACO,GAAG,CAAC;YAAEL,IAAM,EAAA,QAAA;YAAUC,IAAM,EAAA,IAAA;YAAMC,GAAK,EAAA,SAAA;AAAWL,YAAAA;AAAM,SAAA,CAAA;IAEvE,OAAO;QACL,MAAMS,cAAAA,CAAAA,GAAAA;;AAEJ,YAAA,MAAMC,SAAY,GAAA,MAAMZ,gBAAiBa,CAAAA,IAAI,CAAC;gBAAEC,QAAU,EAAA;AAAS,aAAA,CAAA;AAEnE,YAAA,MAAMC,WAAcC,GAAAA,IAAAA,CAClBC,GAAI,CAAA,QAAA,CAAA,EACJA,IAAIC,IACJN,CAAAA,CAAAA,CAAAA,SAAAA,CAAAA;AAEF,YAAA,MAAMO,iBAAoBH,GAAAA,IAAAA,CACxBC,GAAI,CAAA,cAAA,CAAA,EACJA,IAAIC,IACJN,CAAAA,CAAAA,CAAAA,SAAAA,CAAAA;YAEF,OAAO;AACLQ,gBAAAA,uBAAAA,EAAyBF,IAAKN,CAAAA,SAAAA,CAAAA;AAC9BS,gBAAAA,cAAAA,EAAgBC,IAAKP,CAAAA,WAAAA,CAAAA;AACrBQ,gBAAAA,cAAAA,EAAgBC,GAAIT,CAAAA,WAAAA,CAAAA;AACpBU,gBAAAA,qBAAAA,EAAuBC,GAAIP,CAAAA,iBAAAA;AAC7B,aAAA;AACF,SAAA;QAEA,MAAMQ,WAAAA,CAAAA,GAAAA;AACJ,YAAA,MAAMC,eAAkB,GAAA,MAAM,IAAI,CAACjB,cAAc,EAAA;AACjDb,YAAAA,OAAAA,CAAQ+B,4CAA4C,CAACD,eAAAA,CAAAA;AAErD,YAAA,MAAME,oBAAoB,MAAM7B,oBAAAA,EAAAA;;AAEhC,YAAA,MAAMQ,oBAAqB,CAAA;AAAE,gBAAA,GAAGqB,iBAAiB;gBAAEC,gBAAkB,EAAA,IAAIC,OAAOC,OAAO;AAAG,aAAA,CAAA;AAC5F,SAAA;QAEA,MAAMC,8BAAAA,CAAAA,GAAAA;AACJ,YAAA,MAAMJ,oBAAyB,MAAM7B,oBAAAA,EAAAA;AACrC,YAAA,MAAM,EAAEkC,cAAgBC,EAAAA,eAAe,EAAEL,gBAAgB,EAAE,GAAGD,iBAAAA;AAE9D,YAAA,MAAMO,MAAM,IAAIL,IAAAA,EAAAA;AAChB,YAAA,IAAIG,cAAiBC,GAAAA,eAAAA;YAErB,IAAI,CAACA,mBAAmB,CAACL,gBAAAA,IAAoBA,mBAAmBzC,QAAW+C,GAAAA,GAAAA,CAAIJ,OAAO,EAAI,EAAA;gBACxFE,cAAiB5C,GAAAA,uBAAAA,CAAwB+C,IAAID,GAAK,EAAA;oBAAEE,OAAS,EAAA;AAAG,iBAAA,CAAA,CAAA;AAChE,gBAAA,MAAM9B,oBAAqB,CAAA;AAAE,oBAAA,GAAGqB,iBAAiB;AAAEK,oBAAAA;AAAe,iBAAA,CAAA;AACpE;YAEA,OAAOA,cAAAA;AACT,SAAA;QAEA,MAAMK,YAAAA,CAAAA,GAAAA;AACJ,YAAA,MAAML,cAAiB,GAAA,MAAM,IAAI,CAACD,8BAA8B,EAAA;YAEhErC,MAAO4C,CAAAA,IAAI,CAACH,GAAG,CAAC;gBACdI,qBAAuB,EAAA;AACrBC,oBAAAA,IAAAA,EAAM,IAAI,CAAChB,WAAW,CAACiB,IAAI,CAAC,IAAI,CAAA;oBAChCC,OAASV,EAAAA;AACX;AACF,aAAA,CAAA;AACF;AACF,KAAA;AACF,CAAA;;;;"}

package/dist/server/services/stage-permissions.js

@@ -0,0 +1,59 @@
+'use strict';
+
+var fp = require('lodash/fp');
+var utils = require('@strapi/utils');
+var index = require('../utils/index.js');
+var workflows = require('../constants/workflows.js');
+
+const { ApplicationError } = utils.errors;
+const validActions = [
+    workflows.STAGE_TRANSITION_UID
+];
+var stagePermissions = (({ strapi })=>{
+    const roleService = index.getAdminService('role');
+    const permissionService = index.getAdminService('permission');
+    return {
+        async register ({ roleId, action, fromStage }) {
+            if (!validActions.includes(action)) {
+                throw new ApplicationError(`Invalid action ${action}`);
+            }
+            const permissions = await roleService.addPermissions(roleId, [
+                {
+                    action,
+                    actionParameters: {
+                        from: fromStage
+                    }
+                }
+            ]);
+            // TODO: Filter response
+            return permissions;
+        },
+        async registerMany (permissions) {
+            return utils.async.map(permissions, this.register);
+        },
+        async unregister (permissions) {
+            const permissionIds = permissions.map(fp.prop('id'));
+            await permissionService.deleteByIds(permissionIds);
+        },
+        can (action, fromStage) {
+            const requestState = strapi.requestContext.get()?.state;
+            if (!requestState) {
+                return false;
+            }
+            // Override permissions for super admin
+            const userRoles = requestState.user?.roles;
+            if (userRoles?.some((role)=>role.code === 'strapi-super-admin')) {
+                return true;
+            }
+            return requestState.userAbility.can({
+                name: action,
+                params: {
+                    from: fromStage
+                }
+            });
+        }
+    };
+});
+
+module.exports = stagePermissions;
+//# sourceMappingURL=stage-permissions.js.map

package/dist/server/services/stage-permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-permissions.js","sources":["../../../server/src/services/stage-permissions.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\nimport { prop } from 'lodash/fp';\nimport { async, errors } from '@strapi/utils';\nimport { getService, getAdminService } from '../utils';\nimport { STAGE_TRANSITION_UID } from '../constants/workflows';\n\nconst { ApplicationError } = errors;\nconst validActions = [STAGE_TRANSITION_UID];\n\nexport default ({ strapi }: { strapi: Core.Strapi }) => {\n  const roleService = getAdminService('role');\n  const permissionService = getAdminService('permission');\n\n  return {\n    async register({ roleId, action, fromStage }: any) {\n      if (!validActions.includes(action)) {\n        throw new ApplicationError(`Invalid action ${action}`);\n      }\n      const permissions = await roleService.addPermissions(roleId, [\n        {\n          action,\n          actionParameters: {\n            from: fromStage,\n          },\n        },\n      ]);\n\n      // TODO: Filter response\n      return permissions;\n    },\n    async registerMany(permissions: any) {\n      return async.map(permissions, this.register);\n    },\n    async unregister(permissions: any) {\n      const permissionIds = permissions.map(prop('id'));\n      await permissionService.deleteByIds(permissionIds);\n    },\n    can(action: any, fromStage: any) {\n      const requestState = strapi.requestContext.get()?.state;\n\n      if (!requestState) {\n        return false;\n      }\n\n      // Override permissions for super admin\n      const userRoles = requestState.user?.roles;\n      if (userRoles?.some((role: any) => role.code === 'strapi-super-admin')) {\n        return true;\n      }\n\n      return requestState.userAbility.can({\n        name: action,\n        params: { from: fromStage },\n      });\n    },\n  };\n};\n"],"names":["ApplicationError","errors","validActions","STAGE_TRANSITION_UID","strapi","roleService","getAdminService","permissionService","register","roleId","action","fromStage","includes","permissions","addPermissions","actionParameters","from","registerMany","async","map","unregister","permissionIds","prop","deleteByIds","can","requestState","requestContext","get","state","userRoles","user","roles","some","role","code","userAbility","name","params"],"mappings":";;;;;;;AAMA,MAAM,EAAEA,gBAAgB,EAAE,GAAGC,YAAAA;AAC7B,MAAMC,YAAe,GAAA;AAACC,IAAAA;AAAqB,CAAA;AAE3C,uBAAe,CAAA,CAAC,EAAEC,MAAM,EAA2B,GAAA;AACjD,IAAA,MAAMC,cAAcC,qBAAgB,CAAA,MAAA,CAAA;AACpC,IAAA,MAAMC,oBAAoBD,qBAAgB,CAAA,YAAA,CAAA;IAE1C,OAAO;AACL,QAAA,MAAME,UAAS,EAAEC,MAAM,EAAEC,MAAM,EAAEC,SAAS,EAAO,EAAA;AAC/C,YAAA,IAAI,CAACT,YAAAA,CAAaU,QAAQ,CAACF,MAAS,CAAA,EAAA;AAClC,gBAAA,MAAM,IAAIV,gBAAiB,CAAA,CAAC,eAAe,EAAEU,OAAO,CAAC,CAAA;AACvD;AACA,YAAA,MAAMG,WAAc,GAAA,MAAMR,WAAYS,CAAAA,cAAc,CAACL,MAAQ,EAAA;AAC3D,gBAAA;AACEC,oBAAAA,MAAAA;oBACAK,gBAAkB,EAAA;wBAChBC,IAAML,EAAAA;AACR;AACF;AACD,aAAA,CAAA;;YAGD,OAAOE,WAAAA;AACT,SAAA;AACA,QAAA,MAAMI,cAAaJ,WAAgB,EAAA;AACjC,YAAA,OAAOK,YAAMC,GAAG,CAACN,WAAa,EAAA,IAAI,CAACL,QAAQ,CAAA;AAC7C,SAAA;AACA,QAAA,MAAMY,YAAWP,WAAgB,EAAA;AAC/B,YAAA,MAAMQ,aAAgBR,GAAAA,WAAAA,CAAYM,GAAG,CAACG,OAAK,CAAA,IAAA,CAAA,CAAA;YAC3C,MAAMf,iBAAAA,CAAkBgB,WAAW,CAACF,aAAAA,CAAAA;AACtC,SAAA;QACAG,GAAId,CAAAA,CAAAA,MAAW,EAAEC,SAAc,EAAA;AAC7B,YAAA,MAAMc,YAAerB,GAAAA,MAAAA,CAAOsB,cAAc,CAACC,GAAG,EAAIC,EAAAA,KAAAA;AAElD,YAAA,IAAI,CAACH,YAAc,EAAA;gBACjB,OAAO,KAAA;AACT;;YAGA,MAAMI,SAAAA,GAAYJ,YAAaK,CAAAA,IAAI,EAAEC,KAAAA;AACrC,YAAA,IAAIF,WAAWG,IAAK,CAAA,CAACC,OAAcA,IAAKC,CAAAA,IAAI,KAAK,oBAAuB,CAAA,EAAA;gBACtE,OAAO,IAAA;AACT;AAEA,YAAA,OAAOT,YAAaU,CAAAA,WAAW,CAACX,GAAG,CAAC;gBAClCY,IAAM1B,EAAAA,MAAAA;gBACN2B,MAAQ,EAAA;oBAAErB,IAAML,EAAAA;AAAU;AAC5B,aAAA,CAAA;AACF;AACF,KAAA;AACF,CAAA;;;;"}