@defra/forms-model 3.0.529 → 3.0.530

package/dist/module/index.js

@@ -15,6 +15,7 @@ export * from "./form/form-editor/index.js";
 export * from "./form/form-editor/preview/index.js";
 export * from "./form/form-manager/types.js";
 export * from "./form/form-manager/errors.js";
+export * from "./manage/roles.js";
 export * from "./manage/users.js";
 export * from "./pages/index.js";
 export * from "./utils/helpers.js";

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/enums.js'\nexport * from '~/src/common/random-id.js'\nexport * from '~/src/common/schema.js'\nexport * from '~/src/common/pagination/index.js'\nexport * from '~/src/common/search/index.js'\nexport * from '~/src/common/sorting/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-definition/types.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/form/form-editor/index.js'\nexport * from '~/src/form/form-editor/preview/index.js'\nexport * from '~/src/form/form-manager/types.js'\nexport * from '~/src/form/form-manager/errors.js'\nexport * from '~/src/manage/users.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\nexport * from '~/src/form/form-audit/index.js'\nexport * from '~/src/form/form-audit/enums.js'\n\nexport type * from '~/src/common/types.js'\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/common/search/types.js'\nexport type * from '~/src/common/sorting/types.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\nexport type * from '~/src/form/form-submission/types.js'\nexport type * from '~/src/form/form-editor/preview/types.js'\nexport type * from '~/src/form/form-editor/types.js'\nexport type * from '~/src/form/form-editor/macros/types.js'\nexport type * from '~/src/form/form-audit/types.js'\nexport type * from '~/src/manage/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export * from '~/src/common/enums.js'\nexport * from '~/src/common/random-id.js'\nexport * from '~/src/common/schema.js'\nexport * from '~/src/common/pagination/index.js'\nexport * from '~/src/common/search/index.js'\nexport * from '~/src/common/sorting/index.js'\nexport * from '~/src/components/index.js'\nexport * from '~/src/conditions/index.js'\nexport * from '~/src/form/form-definition/index.js'\nexport * from '~/src/form/form-definition/types.js'\nexport * from '~/src/form/form-metadata/index.js'\nexport * from '~/src/form/form-submission/index.js'\nexport * from '~/src/form/utils/index.js'\nexport * from '~/src/form/form-editor/index.js'\nexport * from '~/src/form/form-editor/preview/index.js'\nexport * from '~/src/form/form-manager/types.js'\nexport * from '~/src/form/form-manager/errors.js'\nexport * from '~/src/manage/roles.js'\nexport * from '~/src/manage/users.js'\nexport * from '~/src/pages/index.js'\nexport * from '~/src/utils/helpers.js'\nexport * from '~/src/utils/markdown.js'\nexport * from '~/src/form/form-audit/index.js'\nexport * from '~/src/form/form-audit/enums.js'\n\nexport type * from '~/src/common/types.js'\nexport type * from '~/src/common/pagination/types.js'\nexport type * from '~/src/common/search/types.js'\nexport type * from '~/src/common/sorting/types.js'\nexport type * from '~/src/components/types.js'\nexport type * from '~/src/conditions/types.js'\nexport type * from '~/src/form/form-definition/types.js'\nexport type * from '~/src/form/form-metadata/types.js'\nexport type * from '~/src/form/form-submission/types.js'\nexport type * from '~/src/form/form-editor/preview/types.js'\nexport type * from '~/src/form/form-editor/types.js'\nexport type * from '~/src/form/form-editor/macros/types.js'\nexport type * from '~/src/form/form-audit/types.js'\nexport type * from '~/src/manage/types.js'\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}

package/dist/module/manage/roles.js

@@ -0,0 +1,34 @@
+export let Roles = /*#__PURE__*/function (Roles) {
+  Roles["Admin"] = "admin";
+  Roles["FormCreator"] = "form-creator";
+  return Roles;
+}({});
+export let Scopes = /*#__PURE__*/function (Scopes) {
+  Scopes["FormDelete"] = "form-delete";
+  Scopes["FormEdit"] = "form-edit";
+  Scopes["FormRead"] = "form-read";
+  Scopes["FormPublish"] = "form-publish";
+  Scopes["UserCreate"] = "user-create";
+  Scopes["UserDelete"] = "user-delete";
+  Scopes["UserEdit"] = "user-edit";
+  return Scopes;
+}({});
+export const RoleScopes = {
+  [Roles.Admin]: Object.entries(Scopes).map(x => x[1]),
+  [Roles.FormCreator]: [Scopes.FormRead, Scopes.FormEdit]
+};
+
+/**
+ * Return a unique list of scopes based on the array of roles passed in
+ */
+export function mapScopesToRoles(roles) {
+  const scopeSet = new Set();
+  roles.forEach(role => {
+    const scopes = RoleScopes[role];
+    scopes.forEach(scope => {
+      scopeSet.add(scope);
+    });
+  });
+  return Array.from(scopeSet);
+}
+//# sourceMappingURL=roles.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"roles.js","names":["Roles","Scopes","RoleScopes","Admin","Object","entries","map","x","FormCreator","FormRead","FormEdit","mapScopesToRoles","roles","scopeSet","Set","forEach","role","scopes","scope","add","Array","from"],"sources":["../../../src/manage/roles.ts"],"sourcesContent":["export enum Roles {\n  Admin = 'admin',\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}\n\nexport const RoleScopes = {\n  [Roles.Admin]: Object.entries(Scopes).map((x) => x[1]),\n  [Roles.FormCreator]: [Scopes.FormRead, Scopes.FormEdit]\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;EAAA,OAALA,KAAK;AAAA;AAKjB,WAAYC,MAAM,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;AAUlB,OAAO,MAAMC,UAAU,GAAG;EACxB,CAACF,KAAK,CAACG,KAAK,GAAGC,MAAM,CAACC,OAAO,CAACJ,MAAM,CAAC,CAACK,GAAG,CAAEC,CAAC,IAAKA,CAAC,CAAC,CAAC,CAAC,CAAC;EACtD,CAACP,KAAK,CAACQ,WAAW,GAAG,CAACP,MAAM,CAACQ,QAAQ,EAAER,MAAM,CAACS,QAAQ;AACxD,CAAC;;AAED;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAACC,KAAc,EAAE;EAC/C,MAAMC,QAAQ,GAAG,IAAIC,GAAG,CAAS,CAAC;EAClCF,KAAK,CAACG,OAAO,CAAEC,IAAI,IAAK;IACtB,MAAMC,MAAM,GAAGf,UAAU,CAACc,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/index.d.ts

@@ -15,6 +15,7 @@ export * from './form/form-editor/index.js';
 export * from './form/form-editor/preview/index.js';
 export * from './form/form-manager/types.js';
 export * from './form/form-manager/errors.js';
+export * from './manage/roles.js';
 export * from './manage/users.js';
 export * from './pages/index.js';
 export * from './utils/helpers.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAE9C,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,yCAAyC,CAAA;AAC5D,mBAAmB,iCAAiC,CAAA;AACpD,mBAAmB,wCAAwC,CAAA;AAC3D,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,uBAAuB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kCAAkC,CAAA;AAChD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,qCAAqC,CAAA;AACnD,cAAc,qCAAqC,CAAA;AACnD,cAAc,mCAAmC,CAAA;AACjD,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,iCAAiC,CAAA;AAC/C,cAAc,yCAAyC,CAAA;AACvD,cAAc,kCAAkC,CAAA;AAChD,cAAc,mCAAmC,CAAA;AACjD,cAAc,uBAAuB,CAAA;AACrC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAE9C,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,+BAA+B,CAAA;AAClD,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,mCAAmC,CAAA;AACtD,mBAAmB,qCAAqC,CAAA;AACxD,mBAAmB,yCAAyC,CAAA;AAC5D,mBAAmB,iCAAiC,CAAA;AACpD,mBAAmB,wCAAwC,CAAA;AAC3D,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,uBAAuB,CAAA"}

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

@@ -0,0 +1,22 @@
+export declare enum Roles {
+    Admin = "admin",
+    FormCreator = "form-creator"
+}
+export declare enum Scopes {
+    FormDelete = "form-delete",
+    FormEdit = "form-edit",
+    FormRead = "form-read",
+    FormPublish = "form-publish",
+    UserCreate = "user-create",
+    UserDelete = "user-delete",
+    UserEdit = "user-edit"
+}
+export declare const RoleScopes: {
+    admin: Scopes[];
+    "form-creator": Scopes[];
+};
+/**
+ * Return a unique list of scopes based on the array of roles passed in
+ */
+export declare function mapScopesToRoles(roles: Roles[]): string[];
+//# sourceMappingURL=roles.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../../../src/manage/roles.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK;IACf,KAAK,UAAU;IACf,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;CACvB;AAED,eAAO,MAAM,UAAU;;;CAGtB,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.529",
+  "version": "3.0.530",
   "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/index.ts

@@ -15,6 +15,7 @@ export * from '~/src/form/form-editor/index.js'
 export * from '~/src/form/form-editor/preview/index.js'
 export * from '~/src/form/form-manager/types.js'
 export * from '~/src/form/form-manager/errors.js'
+export * from '~/src/manage/roles.js'
 export * from '~/src/manage/users.js'
 export * from '~/src/pages/index.js'
 export * from '~/src/utils/helpers.js'

package/src/manage/roles.ts

@@ -0,0 +1,33 @@
+export enum Roles {
+  Admin = 'admin',
+  FormCreator = 'form-creator'
+}
+
+export enum Scopes {
+  FormDelete = 'form-delete',
+  FormEdit = 'form-edit',
+  FormRead = 'form-read',
+  FormPublish = 'form-publish',
+  UserCreate = 'user-create',
+  UserDelete = 'user-delete',
+  UserEdit = 'user-edit'
+}
+
+export const RoleScopes = {
+  [Roles.Admin]: Object.entries(Scopes).map((x) => x[1]),
+  [Roles.FormCreator]: [Scopes.FormRead, Scopes.FormEdit]
+}
+
+/**
+ * Return a unique list of scopes based on the array of roles passed in
+ */
+export function mapScopesToRoles(roles: Roles[]) {
+  const scopeSet = new Set<string>()
+  roles.forEach((role) => {
+    const scopes = RoleScopes[role]
+    scopes.forEach((scope) => {
+      scopeSet.add(scope)
+    })
+  })
+  return Array.from(scopeSet)
+}