@defra/forms-model 3.0.649 → 3.0.650

package/dist/module/form/form-metrics/enums.js

@@ -1,7 +1,13 @@
 export let FormMetricType = /*#__PURE__*/function (FormMetricType) {
-  FormMetricType["HeadlineMetric"] = "headline-metric";
+  FormMetricType["TotalsMetric"] = "totals-metric";
   FormMetricType["OverviewMetric"] = "overview-metric";
   FormMetricType["TimelineMetric"] = "timeline-metric";
   return FormMetricType;
 }({});
+export let FormMetricName = /*#__PURE__*/function (FormMetricName) {
+  FormMetricName["NewFormsCreated"] = "NewFormsCreated";
+  FormMetricName["FormsPublished"] = "FormsPublished";
+  FormMetricName["Submissions"] = "Submissions";
+  return FormMetricName;
+}({});
 //# sourceMappingURL=enums.js.map

package/dist/module/form/form-metrics/enums.js.map

@@ -1 +1 @@
-{"version":3,"file":"enums.js","names":["FormMetricType"],"sources":["../../../../src/form/form-metrics/enums.ts"],"sourcesContent":["export enum FormMetricType {\n  HeadlineMetric = 'headline-metric',\n  OverviewMetric = 'overview-metric',\n  TimelineMetric = 'timeline-metric'\n}\n"],"mappings":"AAAA,WAAYA,cAAc,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA","ignoreList":[]}
+{"version":3,"file":"enums.js","names":["FormMetricType","FormMetricName"],"sources":["../../../../src/form/form-metrics/enums.ts"],"sourcesContent":["export enum FormMetricType {\n  TotalsMetric = 'totals-metric',\n  OverviewMetric = 'overview-metric',\n  TimelineMetric = 'timeline-metric'\n}\n\nexport enum FormMetricName {\n  NewFormsCreated = 'NewFormsCreated',\n  FormsPublished = 'FormsPublished',\n  Submissions = 'Submissions'\n}\n"],"mappings":"AAAA,WAAYA,cAAc,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;AAM1B,WAAYC,cAAc,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA","ignoreList":[]}

package/dist/module/form/form-metrics/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-metrics/types.ts"],"sourcesContent":["import { type FormStatus } from '~/src/common/enums.js'\nimport { type FormMetricType } from '~/src/form/form-metrics/enums.js'\n\nexport interface FormHeadlineDetail {\n  count: number\n  countSevenDaysAgo: number\n  countThirtyDaysAgo: number\n  countOneYearAgo: number\n}\n\nexport interface FormHeadlineMetric {\n  type: FormMetricType.HeadlineMetric\n  headlineCounts: Record<string, FormHeadlineDetail>\n  updatedAt: Date\n}\n\nexport interface FormOverviewMetric {\n  type: FormMetricType.OverviewMetric\n  formId: string\n  formStatus: FormStatus\n  summaryMetrics: Record<string, number | string | string[]>\n  featureCounts: Record<string, number>\n  submissionsCount: number\n  updatedAt: Date\n}\n\nexport interface FormTimelineMetric {\n  type: FormMetricType.TimelineMetric\n  formId: string\n  formStatus: FormStatus\n  metricName: string\n  metricValue: number\n  createdAt: Date\n}\n\nexport type FormMetric =\n  | FormHeadlineMetric\n  | FormOverviewMetric\n  | FormTimelineMetric\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/form/form-metrics/types.ts"],"sourcesContent":["import { type FormStatus } from '~/src/common/enums.js'\nimport {\n  type FormMetricName,\n  type FormMetricType\n} from '~/src/form/form-metrics/enums.js'\n\nexport interface FormTotalMetric {\n  count?: number\n}\n\nexport interface FormTotalsMetric {\n  type: FormMetricType.TotalsMetric\n  last7Days?: Record<FormMetricName, FormTotalMetric>\n  prev7Days?: Record<FormMetricName, FormTotalMetric>\n  last30Days?: Record<FormMetricName, FormTotalMetric>\n  prev30Days?: Record<FormMetricName, FormTotalMetric>\n  lastYear?: Record<FormMetricName, FormTotalMetric>\n  prevYear?: Record<FormMetricName, FormTotalMetric>\n  allTime?: Record<FormMetricName, FormTotalMetric>\n  submissions?: Record<string, number>\n  updatedAt: Date\n}\n\nexport interface FormOverviewMetric {\n  type: FormMetricType.OverviewMetric\n  formId: string\n  formStatus: FormStatus\n  summaryMetrics: Record<string, number | string | string[]>\n  featureMetrics: Record<string, Map<string, number>>\n  submissionsCount: number\n  updatedAt: Date\n}\n\nexport interface FormTimelineMetric {\n  type: FormMetricType.TimelineMetric\n  formId: string\n  formStatus: FormStatus\n  metricName: string\n  metricValue: number\n  createdAt: Date\n}\n\nexport type FormMetric =\n  | FormTotalsMetric\n  | FormOverviewMetric\n  | FormTimelineMetric\n"],"mappings":"","ignoreList":[]}

package/dist/module/manage/roles.js

@@ -19,11 +19,12 @@ export let Scopes = /*#__PURE__*/function (Scopes) {
   Scopes["ResetSaveAndExit"] = "reset-save-and-exit";
   Scopes["DeadLetterQueues"] = "dead-letter-queues";
   Scopes["FormsInspect"] = "forms-inspect";
+  Scopes["FormsReport"] = "forms-report";
   return Scopes;
 }({});
 export const RoleScopes = {
   [Roles.Superadmin]: Object.values(Scopes),
-  [Roles.Admin]: [Scopes.FormDelete, Scopes.FormEdit, Scopes.FormRead, Scopes.FormPublish, Scopes.UserCreate, Scopes.UserDelete, Scopes.UserEdit, Scopes.FormsFeedback, Scopes.FormsFeedbackAllForms],
+  [Roles.Admin]: [Scopes.FormDelete, Scopes.FormEdit, Scopes.FormRead, Scopes.FormPublish, Scopes.UserCreate, Scopes.UserDelete, Scopes.UserEdit, Scopes.FormsFeedback, Scopes.FormsFeedbackAllForms, Scopes.FormsReport],
   [Roles.FormPublisher]: [Scopes.FormDelete, Scopes.FormEdit, Scopes.FormRead, Scopes.FormPublish, Scopes.FormsFeedback],
   [Roles.FormCreator]: [Scopes.FormRead, Scopes.FormEdit, Scopes.FormDelete, Scopes.FormsFeedback]
 };

package/dist/module/manage/roles.js.map

@@ -1 +1 @@
-{"version":3,"file":"roles.js","names":["Roles","Scopes","RoleScopes","Superadmin","Object","values","Admin","FormDelete","FormEdit","FormRead","FormPublish","UserCreate","UserDelete","UserEdit","FormsFeedback","FormsFeedbackAllForms","FormPublisher","FormCreator","RoleNames","mapScopesToRoles","roles","scopeSet","Set","forEach","role","scopes","scope","add","Array","from"],"sources":["../../../src/manage/roles.ts"],"sourcesContent":["export enum Roles {\n  Superadmin = 'superadmin',\n  Admin = 'admin',\n  FormPublisher = 'form-publisher',\n  FormCreator = 'form-creator'\n}\n\nexport enum Scopes {\n  FormDelete = 'form-delete',\n  FormEdit = 'form-edit',\n  FormRead = 'form-read',\n  FormPublish = 'form-publish',\n  UserCreate = 'user-create',\n  UserDelete = 'user-delete',\n  UserEdit = 'user-edit',\n  FormsFeedback = 'forms-feedback',\n  FormsFeedbackAllForms = 'forms-feedback-all-forms',\n  FormsBackup = 'forms-backup',\n  ResetSaveAndExit = 'reset-save-and-exit',\n  DeadLetterQueues = 'dead-letter-queues',\n  FormsInspect = 'forms-inspect'\n}\n\nexport const RoleScopes = {\n  [Roles.Superadmin]: Object.values(Scopes),\n  [Roles.Admin]: [\n    Scopes.FormDelete,\n    Scopes.FormEdit,\n    Scopes.FormRead,\n    Scopes.FormPublish,\n    Scopes.UserCreate,\n    Scopes.UserDelete,\n    Scopes.UserEdit,\n    Scopes.FormsFeedback,\n    Scopes.FormsFeedbackAllForms\n  ],\n  [Roles.FormPublisher]: [\n    Scopes.FormDelete,\n    Scopes.FormEdit,\n    Scopes.FormRead,\n    Scopes.FormPublish,\n    Scopes.FormsFeedback\n  ],\n  [Roles.FormCreator]: [\n    Scopes.FormRead,\n    Scopes.FormEdit,\n    Scopes.FormDelete,\n    Scopes.FormsFeedback\n  ]\n}\n\nexport const RoleNames = {\n  [Roles.Superadmin]: 'Superadmin',\n  [Roles.Admin]: 'Admin',\n  [Roles.FormPublisher]: 'Form publisher',\n  [Roles.FormCreator]: 'Form creator'\n}\n\n/**\n * Return a unique list of scopes based on the array of roles passed in\n */\nexport function mapScopesToRoles(roles: Roles[]) {\n  const scopeSet = new Set<Scopes>()\n  roles.forEach((role) => {\n    const scopes = RoleScopes[role]\n    scopes.forEach((scope) => {\n      scopeSet.add(scope)\n    })\n  })\n  return Array.from(scopeSet)\n}\n"],"mappings":"AAAA,WAAYA,KAAK,0BAALA,KAAK;EAALA,KAAK;EAALA,KAAK;EAALA,KAAK;EAALA,KAAK;EAAA,OAALA,KAAK;AAAA;AAOjB,WAAYC,MAAM,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AAgBlB,OAAO,MAAMC,UAAU,GAAG;EACxB,CAACF,KAAK,CAACG,UAAU,GAAGC,MAAM,CAACC,MAAM,CAACJ,MAAM,CAAC;EACzC,CAACD,KAAK,CAACM,KAAK,GAAG,CACbL,MAAM,CAACM,UAAU,EACjBN,MAAM,CAACO,QAAQ,EACfP,MAAM,CAACQ,QAAQ,EACfR,MAAM,CAACS,WAAW,EAClBT,MAAM,CAACU,UAAU,EACjBV,MAAM,CAACW,UAAU,EACjBX,MAAM,CAACY,QAAQ,EACfZ,MAAM,CAACa,aAAa,EACpBb,MAAM,CAACc,qBAAqB,CAC7B;EACD,CAACf,KAAK,CAACgB,aAAa,GAAG,CACrBf,MAAM,CAACM,UAAU,EACjBN,MAAM,CAACO,QAAQ,EACfP,MAAM,CAACQ,QAAQ,EACfR,MAAM,CAACS,WAAW,EAClBT,MAAM,CAACa,aAAa,CACrB;EACD,CAACd,KAAK,CAACiB,WAAW,GAAG,CACnBhB,MAAM,CAACQ,QAAQ,EACfR,MAAM,CAACO,QAAQ,EACfP,MAAM,CAACM,UAAU,EACjBN,MAAM,CAACa,aAAa;AAExB,CAAC;AAED,OAAO,MAAMI,SAAS,GAAG;EACvB,CAAClB,KAAK,CAACG,UAAU,GAAG,YAAY;EAChC,CAACH,KAAK,CAACM,KAAK,GAAG,OAAO;EACtB,CAACN,KAAK,CAACgB,aAAa,GAAG,gBAAgB;EACvC,CAAChB,KAAK,CAACiB,WAAW,GAAG;AACvB,CAAC;;AAED;AACA;AACA;AACA,OAAO,SAASE,gBAAgBA,CAACC,KAAc,EAAE;EAC/C,MAAMC,QAAQ,GAAG,IAAIC,GAAG,CAAS,CAAC;EAClCF,KAAK,CAACG,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAMC,MAAM,GAAGvB,UAAU,CAACsB,IAAI,CAAC;IAC/BC,MAAM,CAACF,OAAO,CAAEG,KAAK,IAAK;MACxBL,QAAQ,CAACM,GAAG,CAACD,KAAK,CAAC;IACrB,CAAC,CAAC;EACJ,CAAC,CAAC;EACF,OAAOE,KAAK,CAACC,IAAI,CAACR,QAAQ,CAAC;AAC7B","ignoreList":[]}
+{"version":3,"file":"roles.js","names":["Roles","Scopes","RoleScopes","Superadmin","Object","values","Admin","FormDelete","FormEdit","FormRead","FormPublish","UserCreate","UserDelete","UserEdit","FormsFeedback","FormsFeedbackAllForms","FormsReport","FormPublisher","FormCreator","RoleNames","mapScopesToRoles","roles","scopeSet","Set","forEach","role","scopes","scope","add","Array","from"],"sources":["../../../src/manage/roles.ts"],"sourcesContent":["export enum Roles {\n  Superadmin = 'superadmin',\n  Admin = 'admin',\n  FormPublisher = 'form-publisher',\n  FormCreator = 'form-creator'\n}\n\nexport enum Scopes {\n  FormDelete = 'form-delete',\n  FormEdit = 'form-edit',\n  FormRead = 'form-read',\n  FormPublish = 'form-publish',\n  UserCreate = 'user-create',\n  UserDelete = 'user-delete',\n  UserEdit = 'user-edit',\n  FormsFeedback = 'forms-feedback',\n  FormsFeedbackAllForms = 'forms-feedback-all-forms',\n  FormsBackup = 'forms-backup',\n  ResetSaveAndExit = 'reset-save-and-exit',\n  DeadLetterQueues = 'dead-letter-queues',\n  FormsInspect = 'forms-inspect',\n  FormsReport = 'forms-report'\n}\n\nexport const RoleScopes = {\n  [Roles.Superadmin]: Object.values(Scopes),\n  [Roles.Admin]: [\n    Scopes.FormDelete,\n    Scopes.FormEdit,\n    Scopes.FormRead,\n    Scopes.FormPublish,\n    Scopes.UserCreate,\n    Scopes.UserDelete,\n    Scopes.UserEdit,\n    Scopes.FormsFeedback,\n    Scopes.FormsFeedbackAllForms,\n    Scopes.FormsReport\n  ],\n  [Roles.FormPublisher]: [\n    Scopes.FormDelete,\n    Scopes.FormEdit,\n    Scopes.FormRead,\n    Scopes.FormPublish,\n    Scopes.FormsFeedback\n  ],\n  [Roles.FormCreator]: [\n    Scopes.FormRead,\n    Scopes.FormEdit,\n    Scopes.FormDelete,\n    Scopes.FormsFeedback\n  ]\n}\n\nexport const RoleNames = {\n  [Roles.Superadmin]: 'Superadmin',\n  [Roles.Admin]: 'Admin',\n  [Roles.FormPublisher]: 'Form publisher',\n  [Roles.FormCreator]: 'Form creator'\n}\n\n/**\n * Return a unique list of scopes based on the array of roles passed in\n */\nexport function mapScopesToRoles(roles: Roles[]) {\n  const scopeSet = new Set<Scopes>()\n  roles.forEach((role) => {\n    const scopes = RoleScopes[role]\n    scopes.forEach((scope) => {\n      scopeSet.add(scope)\n    })\n  })\n  return Array.from(scopeSet)\n}\n"],"mappings":"AAAA,WAAYA,KAAK,0BAALA,KAAK;EAALA,KAAK;EAALA,KAAK;EAALA,KAAK;EAALA,KAAK;EAAA,OAALA,KAAK;AAAA;AAOjB,WAAYC,MAAM,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AAiBlB,OAAO,MAAMC,UAAU,GAAG;EACxB,CAACF,KAAK,CAACG,UAAU,GAAGC,MAAM,CAACC,MAAM,CAACJ,MAAM,CAAC;EACzC,CAACD,KAAK,CAACM,KAAK,GAAG,CACbL,MAAM,CAACM,UAAU,EACjBN,MAAM,CAACO,QAAQ,EACfP,MAAM,CAACQ,QAAQ,EACfR,MAAM,CAACS,WAAW,EAClBT,MAAM,CAACU,UAAU,EACjBV,MAAM,CAACW,UAAU,EACjBX,MAAM,CAACY,QAAQ,EACfZ,MAAM,CAACa,aAAa,EACpBb,MAAM,CAACc,qBAAqB,EAC5Bd,MAAM,CAACe,WAAW,CACnB;EACD,CAAChB,KAAK,CAACiB,aAAa,GAAG,CACrBhB,MAAM,CAACM,UAAU,EACjBN,MAAM,CAACO,QAAQ,EACfP,MAAM,CAACQ,QAAQ,EACfR,MAAM,CAACS,WAAW,EAClBT,MAAM,CAACa,aAAa,CACrB;EACD,CAACd,KAAK,CAACkB,WAAW,GAAG,CACnBjB,MAAM,CAACQ,QAAQ,EACfR,MAAM,CAACO,QAAQ,EACfP,MAAM,CAACM,UAAU,EACjBN,MAAM,CAACa,aAAa;AAExB,CAAC;AAED,OAAO,MAAMK,SAAS,GAAG;EACvB,CAACnB,KAAK,CAACG,UAAU,GAAG,YAAY;EAChC,CAACH,KAAK,CAACM,KAAK,GAAG,OAAO;EACtB,CAACN,KAAK,CAACiB,aAAa,GAAG,gBAAgB;EACvC,CAACjB,KAAK,CAACkB,WAAW,GAAG;AACvB,CAAC;;AAED;AACA;AACA;AACA,OAAO,SAASE,gBAAgBA,CAACC,KAAc,EAAE;EAC/C,MAAMC,QAAQ,GAAG,IAAIC,GAAG,CAAS,CAAC;EAClCF,KAAK,CAACG,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAMC,MAAM,GAAGxB,UAAU,CAACuB,IAAI,CAAC;IAC/BC,MAAM,CAACF,OAAO,CAAEG,KAAK,IAAK;MACxBL,QAAQ,CAACM,GAAG,CAACD,KAAK,CAAC;IACrB,CAAC,CAAC;EACJ,CAAC,CAAC;EACF,OAAOE,KAAK,CAACC,IAAI,CAACR,QAAQ,CAAC;AAC7B","ignoreList":[]}

package/dist/types/form/form-metrics/enums.d.ts

@@ -1,6 +1,11 @@
 export declare enum FormMetricType {
-    HeadlineMetric = "headline-metric",
+    TotalsMetric = "totals-metric",
     OverviewMetric = "overview-metric",
     TimelineMetric = "timeline-metric"
 }
+export declare enum FormMetricName {
+    NewFormsCreated = "NewFormsCreated",
+    FormsPublished = "FormsPublished",
+    Submissions = "Submissions"
+}
 //# sourceMappingURL=enums.d.ts.map

package/dist/types/form/form-metrics/enums.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metrics/enums.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACxB,cAAc,oBAAoB;IAClC,cAAc,oBAAoB;IAClC,cAAc,oBAAoB;CACnC"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metrics/enums.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACxB,YAAY,kBAAkB;IAC9B,cAAc,oBAAoB;IAClC,cAAc,oBAAoB;CACnC;AAED,oBAAY,cAAc;IACxB,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,WAAW,gBAAgB;CAC5B"}

package/dist/types/form/form-metrics/types.d.ts

@@ -1,14 +1,18 @@
 import { type FormStatus } from '../../common/enums.js';
-import { type FormMetricType } from '../../form/form-metrics/enums.js';
-export interface FormHeadlineDetail {
-    count: number;
-    countSevenDaysAgo: number;
-    countThirtyDaysAgo: number;
-    countOneYearAgo: number;
+import { type FormMetricName, type FormMetricType } from '../../form/form-metrics/enums.js';
+export interface FormTotalMetric {
+    count?: number;
 }
-export interface FormHeadlineMetric {
-    type: FormMetricType.HeadlineMetric;
-    headlineCounts: Record<string, FormHeadlineDetail>;
+export interface FormTotalsMetric {
+    type: FormMetricType.TotalsMetric;
+    last7Days?: Record<FormMetricName, FormTotalMetric>;
+    prev7Days?: Record<FormMetricName, FormTotalMetric>;
+    last30Days?: Record<FormMetricName, FormTotalMetric>;
+    prev30Days?: Record<FormMetricName, FormTotalMetric>;
+    lastYear?: Record<FormMetricName, FormTotalMetric>;
+    prevYear?: Record<FormMetricName, FormTotalMetric>;
+    allTime?: Record<FormMetricName, FormTotalMetric>;
+    submissions?: Record<string, number>;
     updatedAt: Date;
 }
 export interface FormOverviewMetric {
@@ -16,7 +20,7 @@ export interface FormOverviewMetric {
     formId: string;
     formStatus: FormStatus;
     summaryMetrics: Record<string, number | string | string[]>;
-    featureCounts: Record<string, number>;
+    featureMetrics: Record<string, Map<string, number>>;
     submissionsCount: number;
     updatedAt: Date;
 }
@@ -28,5 +32,5 @@ export interface FormTimelineMetric {
     metricValue: number;
     createdAt: Date;
 }
-export type FormMetric = FormHeadlineMetric | FormOverviewMetric | FormTimelineMetric;
+export type FormMetric = FormTotalsMetric | FormOverviewMetric | FormTimelineMetric;
 //# sourceMappingURL=types.d.ts.map

package/dist/types/form/form-metrics/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metrics/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,kCAAkC,CAAA;AAEtE,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,iBAAiB,EAAE,MAAM,CAAA;IACzB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;IACnC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;IAClD,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC1D,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,MAAM,UAAU,GAClB,kBAAkB,GAClB,kBAAkB,GAClB,kBAAkB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/form/form-metrics/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,cAAc,EACpB,MAAM,kCAAkC,CAAA;AAEzC,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,cAAc,CAAC,YAAY,CAAA;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,CAAA;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,CAAA;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,CAAA;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,CAAA;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,CAAA;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,CAAA;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC,cAAc,EAAE,eAAe,CAAC,CAAA;IACjD,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACpC,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC1D,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IACnD,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC,cAAc,CAAA;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,CAAA"}

package/dist/types/manage/roles.d.ts

@@ -17,7 +17,8 @@ export declare enum Scopes {
     FormsBackup = "forms-backup",
     ResetSaveAndExit = "reset-save-and-exit",
     DeadLetterQueues = "dead-letter-queues",
-    FormsInspect = "forms-inspect"
+    FormsInspect = "forms-inspect",
+    FormsReport = "forms-report"
 }
 export declare const RoleScopes: {
     superadmin: Scopes[];

package/dist/types/manage/roles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../../../src/manage/roles.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK;IACf,UAAU,eAAe;IACzB,KAAK,UAAU;IACf,aAAa,mBAAmB;IAChC,WAAW,iBAAiB;CAC7B;AAED,oBAAY,MAAM;IAChB,UAAU,gBAAgB;IAC1B,QAAQ,cAAc;IACtB,QAAQ,cAAc;IACtB,WAAW,iBAAiB;IAC5B,UAAU,gBAAgB;IAC1B,UAAU,gBAAgB;IAC1B,QAAQ,cAAc;IACtB,aAAa,mBAAmB;IAChC,qBAAqB,6BAA6B;IAClD,WAAW,iBAAiB;IAC5B,gBAAgB,wBAAwB;IACxC,gBAAgB,uBAAuB;IACvC,YAAY,kBAAkB;CAC/B;AAED,eAAO,MAAM,UAAU;;;;;CA0BtB,CAAA;AAED,eAAO,MAAM,SAAS;;;;;CAKrB,CAAA;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,YAS9C"}
+{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../../../src/manage/roles.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK;IACf,UAAU,eAAe;IACzB,KAAK,UAAU;IACf,aAAa,mBAAmB;IAChC,WAAW,iBAAiB;CAC7B;AAED,oBAAY,MAAM;IAChB,UAAU,gBAAgB;IAC1B,QAAQ,cAAc;IACtB,QAAQ,cAAc;IACtB,WAAW,iBAAiB;IAC5B,UAAU,gBAAgB;IAC1B,UAAU,gBAAgB;IAC1B,QAAQ,cAAc;IACtB,aAAa,mBAAmB;IAChC,qBAAqB,6BAA6B;IAClD,WAAW,iBAAiB;IAC5B,gBAAgB,wBAAwB;IACxC,gBAAgB,uBAAuB;IACvC,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;CAC7B;AAED,eAAO,MAAM,UAAU;;;;;CA2BtB,CAAA;AAED,eAAO,MAAM,SAAS;;;;;CAKrB,CAAA;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,YAS9C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.649",
+  "version": "3.0.650",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "types": "dist/types/index.d.ts",

package/src/form/form-metrics/enums.ts

@@ -1,5 +1,11 @@
 export enum FormMetricType {
-  HeadlineMetric = 'headline-metric',
+  TotalsMetric = 'totals-metric',
   OverviewMetric = 'overview-metric',
   TimelineMetric = 'timeline-metric'
 }
+
+export enum FormMetricName {
+  NewFormsCreated = 'NewFormsCreated',
+  FormsPublished = 'FormsPublished',
+  Submissions = 'Submissions'
+}

package/src/form/form-metrics/types.ts

@@ -1,16 +1,23 @@
 import { type FormStatus } from '~/src/common/enums.js'
-import { type FormMetricType } from '~/src/form/form-metrics/enums.js'
+import {
+  type FormMetricName,
+  type FormMetricType
+} from '~/src/form/form-metrics/enums.js'
 
-export interface FormHeadlineDetail {
-  count: number
-  countSevenDaysAgo: number
-  countThirtyDaysAgo: number
-  countOneYearAgo: number
+export interface FormTotalMetric {
+  count?: number
 }
 
-export interface FormHeadlineMetric {
-  type: FormMetricType.HeadlineMetric
-  headlineCounts: Record<string, FormHeadlineDetail>
+export interface FormTotalsMetric {
+  type: FormMetricType.TotalsMetric
+  last7Days?: Record<FormMetricName, FormTotalMetric>
+  prev7Days?: Record<FormMetricName, FormTotalMetric>
+  last30Days?: Record<FormMetricName, FormTotalMetric>
+  prev30Days?: Record<FormMetricName, FormTotalMetric>
+  lastYear?: Record<FormMetricName, FormTotalMetric>
+  prevYear?: Record<FormMetricName, FormTotalMetric>
+  allTime?: Record<FormMetricName, FormTotalMetric>
+  submissions?: Record<string, number>
   updatedAt: Date
 }
 
@@ -19,7 +26,7 @@ export interface FormOverviewMetric {
   formId: string
   formStatus: FormStatus
   summaryMetrics: Record<string, number | string | string[]>
-  featureCounts: Record<string, number>
+  featureMetrics: Record<string, Map<string, number>>
   submissionsCount: number
   updatedAt: Date
 }
@@ -34,6 +41,6 @@ export interface FormTimelineMetric {
 }
 
 export type FormMetric =
-  | FormHeadlineMetric
+  | FormTotalsMetric
   | FormOverviewMetric
   | FormTimelineMetric

package/src/manage/roles.ts

@@ -18,7 +18,8 @@ export enum Scopes {
   FormsBackup = 'forms-backup',
   ResetSaveAndExit = 'reset-save-and-exit',
   DeadLetterQueues = 'dead-letter-queues',
-  FormsInspect = 'forms-inspect'
+  FormsInspect = 'forms-inspect',
+  FormsReport = 'forms-report'
 }
 
 export const RoleScopes = {
@@ -32,7 +33,8 @@ export const RoleScopes = {
     Scopes.UserDelete,
     Scopes.UserEdit,
     Scopes.FormsFeedback,
-    Scopes.FormsFeedbackAllForms
+    Scopes.FormsFeedbackAllForms,
+    Scopes.FormsReport
   ],
   [Roles.FormPublisher]: [
     Scopes.FormDelete,