feat: can now edit page / step 's icons (#749)

* Modified models and mutations to add icon field to page and step * Modified the type files to add icon * Allows icon modification * Removed logging * refactor: improve check of args in edit page & edit step mutations --------- Co-authored-by: RenzoPrats <renzoprats@icloud.com> Co-authored-by: Antoine Hurard <antoine.reliefapps@gmail.com>

Author: 3 people

src/i18n/en.json

@@ -190,7 +190,7 @@
 }
 },
 "errors": {
-"invalidArguments": "Either name, permissions, or visibility must be provided."
+"invalidArguments": "Either name, permissions, visibility or icon must be provided to update the page."
 }
 }
 },
@@ -244,7 +244,7 @@
 },
 "edit": {
 "errors": {
-"invalidArguments": "Either name, type, content or permissions must be provided."
+"invalidArguments": "Either name, type, content, icon or permissions must be provided."
 }
 }
 },

src/models/page.model.ts

@@ -28,6 +28,7 @@ export type PageContextT = (
 export interface Page extends Document {
  kind: 'Page';
  name: string;
+ icon: string;
  createdAt: Date;
  modifiedAt: Date;
  type: string;
@@ -58,6 +59,7 @@ export interface Page extends Document {
 const pageSchema = new Schema<Page>(
  {
  name: String,
+ icon: String,
  type: {
  type: String,
  enum: Object.values(contentType),

src/models/step.model.ts

@@ -9,6 +9,7 @@ import { Workflow } from './workflow.model';
 export interface Step extends Document {
  kind: 'Step';
  name: string;
+ icon: string;
  createdAt: Date;
  modifiedAt: Date;
  type: string;
@@ -29,6 +30,7 @@ export interface Step extends Document {
 const stepSchema = new Schema<Step>(
  {
  name: String,
+ icon: String,
  type: {
  type: String,
  enum: Object.values(contentType),

src/schema/mutation/editPage.mutation.ts

@@ -9,7 +9,7 @@ import GraphQLJSON from 'graphql-type-json';
 import { contentType } from '@const/enumTypes';
 import { PageType } from '../types';
 import { Page, Workflow, Dashboard, Form } from '@models';
-import { isArray, isNil } from 'lodash';
+import { cloneDeep, isArray, isEmpty, isNil, omit } from 'lodash';
 import extendAbilityForPage from '@security/extendAbilityForPage';
 import { logger } from '@services/logger.service';
 
@@ -38,6 +38,7 @@ export default {
  args: {
  id: { type: new GraphQLNonNull(GraphQLID) },
  name: { type: GraphQLString },
+ icon: { type: GraphQLString },
  permissions: { type: GraphQLJSON },
  visible: { type: GraphQLBoolean },
  },
@@ -50,11 +51,17 @@ export default {
  context.i18next.t('common.errors.userNotLogged')
  );
  }
- // check inputs
- if (!args || (!args.name && !args.permissions && isNil(args.visible)))
+ /**
+ * Check if at least one of the required arguments is provided.
+ * Else, send error.
+ * This way, we check for the existence of keys, except id in args
+ */
+ if (isEmpty(cloneDeep(omit(args, ['id'])))) {
  throw new GraphQLError(
  context.i18next.t('mutations.page.edit.errors.invalidArguments')
  );
+ }
+
  // get data
  let page = await Page.findById(args.id);
  if (!page) {
@@ -68,19 +75,11 @@ export default {
  );
  }
 
- // update name
- /* const update: {
- modifiedAt?: Date;
- name?: string;
- } = {
- modifiedAt: new Date(),
- }; */
-
- const update: {
- name?: string;
- } = {};
-
- Object.assign(update, args.name && { name: args.name });
+ // Create update
+ const update = {
+ ...(args.name && { name: args.name }),
+ ...(args.icon && { icon: args.icon }),
+ };
 
  // Updating permissions
  const permissionsUpdate: any = {};

src/schema/mutation/editStep.mutation.ts

@@ -5,7 +5,7 @@ import {
  GraphQLError,
 } from 'graphql';
 import GraphQLJSON from 'graphql-type-json';
-import { isArray } from 'lodash';
+import { cloneDeep, isArray, isEmpty, omit } from 'lodash';
 import { contentType } from '@const/enumTypes';
 import { StepType } from '../types';
 import { Dashboard, Form, Step } from '@models';
@@ -36,6 +36,7 @@ export default {
  args: {
  id: { type: new GraphQLNonNull(GraphQLID) },
  name: { type: GraphQLString },
+ icon: { type: GraphQLString },
  type: { type: GraphQLString },
  content: { type: GraphQLID },
  permissions: { type: GraphQLJSON },
@@ -49,11 +50,12 @@ export default {
  context.i18next.t('common.errors.userNotLogged')
  );
  }
- // check inputs
- if (
- !args ||
- (!args.name && !args.type && !args.content && !args.permissions)
- ) {
+ /**
+ * Check if at least one of the required arguments is provided.
+ * Else, send error.
+ * This way, we check for the existence of keys, except id in args
+ */
+ if (isEmpty(cloneDeep(omit(args, ['id'])))) {
  throw new GraphQLError(
  context.i18next.t('mutations.step.edit.errors.invalidArguments')
  );
@@ -85,17 +87,13 @@ export default {
  );
  }
 
- // defining what to update
+ // Create update
  const update = {
- //modifiedAt: new Date(),
+ ...(args.name && { name: args.name }),
+ ...(args.icon && { icon: args.icon }),
+ ...(args.type && { type: args.type }),
+ ...(args.content && { content: args.content }),
  };
- Object.assign(
- update,
- args.name && { name: args.name },
- args.type && { type: args.type },
- args.content && { content: args.content }
- );
-
  // Updating permissions
  const permissionsUpdate: any = {};
  if (args.permissions) {

src/schema/types/page.type.ts

@@ -26,6 +26,7 @@ export const PageType = new GraphQLObjectType({
  },
  },
  name: { type: GraphQLString },
+ icon: { type: GraphQLString },
  visible: {
  type: GraphQLBoolean,
  resolve(parent) {

src/schema/types/step.type.ts

@@ -22,6 +22,7 @@ export const StepType = new GraphQLObjectType({
  },
  },
  name: { type: GraphQLString },
+ icon: { type: GraphQLString },
  createdAt: { type: GraphQLString },
  modifiedAt: { type: GraphQLString },
  type: { type: ContentEnumType },