@defra/forms-model 3.0.624 → 3.0.625

package/dist/module/manage/roles.js

@@ -24,6 +24,12 @@ export const RoleScopes = {
   [Roles.FormPublisher]: [Scopes.FormDelete, Scopes.FormEdit, Scopes.FormRead, Scopes.FormPublish],
   [Roles.FormCreator]: [Scopes.FormRead, Scopes.FormEdit, Scopes.FormDelete]
 };
+export const RoleNames = {
+  [Roles.Superadmin]: 'Superadmin',
+  [Roles.Admin]: 'Admin',
+  [Roles.FormPublisher]: 'Form publisher',
+  [Roles.FormCreator]: 'Form creator'
+};
 
 /**
  * Return a unique list of scopes based on the array of roles passed in

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","FormPublisher","FormCreator","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  FormsBackup = 'forms-backup',\n  ResetSaveAndExit = 'reset-save-and-exit'\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  ],\n  [Roles.FormPublisher]: [\n    Scopes.FormDelete,\n    Scopes.FormEdit,\n    Scopes.FormRead,\n    Scopes.FormPublish\n  ],\n  [Roles.FormCreator]: [Scopes.FormRead, Scopes.FormEdit, Scopes.FormDelete]\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<string>()\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;EAAA,OAANA,MAAM;AAAA;AAalB,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,CACrB;EACD,CAACd,KAAK,CAACe,aAAa,GAAG,CACrBd,MAAM,CAACM,UAAU,EACjBN,MAAM,CAACO,QAAQ,EACfP,MAAM,CAACQ,QAAQ,EACfR,MAAM,CAACS,WAAW,CACnB;EACD,CAACV,KAAK,CAACgB,WAAW,GAAG,CAACf,MAAM,CAACQ,QAAQ,EAAER,MAAM,CAACO,QAAQ,EAAEP,MAAM,CAACM,UAAU;AAC3E,CAAC;;AAED;AACA;AACA;AACA,OAAO,SAASU,gBAAgBA,CAACC,KAAc,EAAE;EAC/C,MAAMC,QAAQ,GAAG,IAAIC,GAAG,CAAS,CAAC;EAClCF,KAAK,CAACG,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAMC,MAAM,GAAGrB,UAAU,CAACoB,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","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  FormsBackup = 'forms-backup',\n  ResetSaveAndExit = 'reset-save-and-exit'\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  ],\n  [Roles.FormPublisher]: [\n    Scopes.FormDelete,\n    Scopes.FormEdit,\n    Scopes.FormRead,\n    Scopes.FormPublish\n  ],\n  [Roles.FormCreator]: [Scopes.FormRead, Scopes.FormEdit, Scopes.FormDelete]\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;EAAA,OAANA,MAAM;AAAA;AAalB,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,CACrB;EACD,CAACd,KAAK,CAACe,aAAa,GAAG,CACrBd,MAAM,CAACM,UAAU,EACjBN,MAAM,CAACO,QAAQ,EACfP,MAAM,CAACQ,QAAQ,EACfR,MAAM,CAACS,WAAW,CACnB;EACD,CAACV,KAAK,CAACgB,WAAW,GAAG,CAACf,MAAM,CAACQ,QAAQ,EAAER,MAAM,CAACO,QAAQ,EAAEP,MAAM,CAACM,UAAU;AAC3E,CAAC;AAED,OAAO,MAAMU,SAAS,GAAG;EACvB,CAACjB,KAAK,CAACG,UAAU,GAAG,YAAY;EAChC,CAACH,KAAK,CAACM,KAAK,GAAG,OAAO;EACtB,CAACN,KAAK,CAACe,aAAa,GAAG,gBAAgB;EACvC,CAACf,KAAK,CAACgB,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,GAAGtB,UAAU,CAACqB,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/module/manage/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../../src/manage/types.ts"],"sourcesContent":["/**\n * Interface for `EntitlementRole`\n */\nexport interface EntitlementRole {\n  /**\n   * The display name\n   */\n  name: string\n\n  /**\n   * The code value\n   */\n  code: string\n\n  /**\n   * The description\n   */\n  description: string\n}\n\n/**\n * Interface for `ManageUser`\n */\nexport interface ManageUser {\n  /**\n   * The object id of the user\n   */\n  userId: string\n\n  /**\n   * The email address of the user\n   */\n  emailAddress: string\n\n  /**\n   * The role assigned to the user\n   */\n  userRole: string\n\n  /**\n   * The full name of the user for display\n   */\n  displayName?: string\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../../src/manage/types.ts"],"sourcesContent":["import { type Roles } from '~/src/manage/roles.js'\n\n/**\n * Interface for `ManageUser`\n */\nexport interface ManageUser {\n  /**\n   * The object id of the user\n   */\n  userId: string\n\n  /**\n   * The email address of the user\n   */\n  emailAddress: string\n\n  /**\n   * The role assigned to the user\n   */\n  userRole: Roles\n\n  /**\n   * The full name of the user for display\n   */\n  displayName?: string\n}\n"],"mappings":"","ignoreList":[]}

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

@@ -1 +1 @@
-{"version":3,"file":"users.js","names":[],"sources":["../../../src/manage/users.ts"],"sourcesContent":["export interface EntitlementUser {\n  /**\n   * The id of the user\n   */\n  userId: string\n\n  /**\n   * The display name (full name) of the user\n   */\n  displayName: string\n\n  /**\n   * The email addresss of the user\n   */\n  email: string\n\n  /**\n   * The roles assigned to the user\n   */\n  roles: string[]\n\n  /**\n   * The scopes assigned to the user\n   */\n  scopes: string[]\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"users.js","names":[],"sources":["../../../src/manage/users.ts"],"sourcesContent":["import { type Roles, type Scopes } from '~/src/manage/roles.js'\n\nexport interface EntitlementUser {\n  /**\n   * The id of the user\n   */\n  userId: string\n\n  /**\n   * The display name (full name) of the user\n   */\n  displayName: string\n\n  /**\n   * The email addresss of the user\n   */\n  email: string\n\n  /**\n   * The roles assigned to the user\n   */\n  roles: Roles[]\n\n  /**\n   * The scopes assigned to the user\n   */\n  scopes: Scopes[]\n}\n"],"mappings":"","ignoreList":[]}

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

@@ -22,8 +22,14 @@ export declare const RoleScopes: {
     "form-publisher": Scopes[];
     "form-creator": Scopes[];
 };
+export declare const RoleNames: {
+    superadmin: string;
+    admin: string;
+    "form-publisher": string;
+    "form-creator": string;
+};
 /**
  * Return a unique list of scopes based on the array of roles passed in
  */
-export declare function mapScopesToRoles(roles: Roles[]): string[];
+export declare function mapScopesToRoles(roles: Roles[]): Scopes[];
 //# sourceMappingURL=roles.d.ts.map

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,WAAW,iBAAiB;IAC5B,gBAAgB,wBAAwB;CACzC;AAED,eAAO,MAAM,UAAU;;;;;CAmBtB,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,WAAW,iBAAiB;IAC5B,gBAAgB,wBAAwB;CACzC;AAED,eAAO,MAAM,UAAU;;;;;CAmBtB,CAAA;AAED,eAAO,MAAM,SAAS;;;;;CAKrB,CAAA;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,YAS9C"}

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

@@ -1,20 +1,4 @@
-/**
- * Interface for `EntitlementRole`
- */
-export interface EntitlementRole {
-    /**
-     * The display name
-     */
-    name: string;
-    /**
-     * The code value
-     */
-    code: string;
-    /**
-     * The description
-     */
-    description: string;
-}
+import { type Roles } from '../manage/roles.js';
 /**
  * Interface for `ManageUser`
  */
@@ -30,7 +14,7 @@ export interface ManageUser {
     /**
      * The role assigned to the user
      */
-    userRole: string;
+    userRole: Roles;
     /**
      * The full name of the user for display
      */

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/manage/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/manage/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAElD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAA;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}

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

@@ -1,3 +1,4 @@
+import { type Roles, type Scopes } from '../manage/roles.js';
 export interface EntitlementUser {
     /**
      * The id of the user
@@ -14,10 +15,10 @@ export interface EntitlementUser {
     /**
      * The roles assigned to the user
      */
-    roles: string[];
+    roles: Roles[];
     /**
      * The scopes assigned to the user
      */
-    scopes: string[];
+    scopes: Scopes[];
 }
 //# sourceMappingURL=users.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/manage/users.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAA;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/manage/users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAE/D,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,EAAE,KAAK,EAAE,CAAA;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.624",
+  "version": "3.0.625",
   "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/manage/roles.ts

@@ -39,11 +39,18 @@ export const RoleScopes = {
   [Roles.FormCreator]: [Scopes.FormRead, Scopes.FormEdit, Scopes.FormDelete]
 }
 
+export const RoleNames = {
+  [Roles.Superadmin]: 'Superadmin',
+  [Roles.Admin]: 'Admin',
+  [Roles.FormPublisher]: 'Form publisher',
+  [Roles.FormCreator]: 'Form creator'
+}
+
 /**
  * Return a unique list of scopes based on the array of roles passed in
  */
 export function mapScopesToRoles(roles: Roles[]) {
-  const scopeSet = new Set<string>()
+  const scopeSet = new Set<Scopes>()
   roles.forEach((role) => {
     const scopes = RoleScopes[role]
     scopes.forEach((scope) => {

package/src/manage/types.ts

@@ -1,22 +1,4 @@
-/**
- * Interface for `EntitlementRole`
- */
-export interface EntitlementRole {
-  /**
-   * The display name
-   */
-  name: string
-
-  /**
-   * The code value
-   */
-  code: string
-
-  /**
-   * The description
-   */
-  description: string
-}
+import { type Roles } from '~/src/manage/roles.js'
 
 /**
  * Interface for `ManageUser`
@@ -35,7 +17,7 @@ export interface ManageUser {
   /**
    * The role assigned to the user
    */
-  userRole: string
+  userRole: Roles
 
   /**
    * The full name of the user for display

package/src/manage/users.ts

@@ -1,3 +1,5 @@
+import { type Roles, type Scopes } from '~/src/manage/roles.js'
+
 export interface EntitlementUser {
   /**
    * The id of the user
@@ -17,10 +19,10 @@ export interface EntitlementUser {
   /**
    * The roles assigned to the user
    */
-  roles: string[]
+  roles: Roles[]
 
   /**
    * The scopes assigned to the user
    */
-  scopes: string[]
+  scopes: Scopes[]
 }