@axinom/mosaic-graphql-codegen-plugins 0.6.0-rc.9 → 0.6.0

package/dist/generate-bulk-edit-ui-config/generate-bulk-edit-ui-config.d.ts

@@ -2,6 +2,7 @@ import { PluginFunction } from '@graphql-codegen/plugin-helpers';
 export interface BulkEditPluginConfig {
     addKey?: string;
     removeKey?: string;
+    clearKey?: string;
     setKey?: string;
     filterKey?: string;
 }

package/dist/generate-bulk-edit-ui-config/generate-bulk-edit-ui-config.js

@@ -5,6 +5,7 @@ const change_case_all_1 = require("change-case-all");
 const plugin = (schema, _documents, config) => {
     const addKey = config.addKey || 'relatedEntitiesToAdd';
     const removeKey = config.removeKey || 'relatedEntitiesToRemove';
+    const clearKey = config.clearKey || 'relatedEntitiesToClear';
     const setKey = config.setKey || 'set';
     const filterKey = config.filterKey || 'filter';
     const mutationType = schema.getMutationType();
@@ -32,8 +33,15 @@ const plugin = (schema, _documents, config) => {
                     break;
             }
         });
+        // Check for related entities to clear and set clearable and clearValue accordingly
+        if (mutation.args.some((a) => a.name === clearKey)) {
+            const clearArg = mutation.args.find((a) => a.name === clearKey);
+            if (clearArg) {
+                formFieldsConfig = resolveClearValues(typesMap[clearArg.type.toString()].getFields(), formFieldsConfig, removeKey);
+            }
+        }
         if (Object.keys(formFieldsConfig).length > 0) {
-            return `export const ${(0, change_case_all_1.pascalCase)(mutationName)}FormFieldsConfig = { mutation: '${mutationName}', keys: { add: '${addKey}', remove: '${removeKey}', set: '${setKey}', filter: '${filterKey}' }, fields: ${JSON.stringify(formFieldsConfig, null, 2)}};`;
+            return `export const ${(0, change_case_all_1.pascalCase)(mutationName)}FormFieldsConfig = { mutation: '${mutationName}', keys: { add: '${addKey}', remove: '${removeKey}', clear: '${clearKey}', set: '${setKey}', filter: '${filterKey}' }, fields: ${JSON.stringify(formFieldsConfig, null, 2)}};`;
         }
     });
     return ['/** Bulk Edit Configurations **/', ...configs]
@@ -77,3 +85,17 @@ function resolveFields(fields, action, postfix = '') {
     });
     return resultingFields;
 }
+// If relatedEntitiesToClear contains a field make the clearable field true on the corresponding relatedEntitiesToRemove field.
+function resolveClearValues(fields, fieldMap, action) {
+    const resultingFields = Object.assign({}, fieldMap);
+    Object.keys(fields).forEach((fieldName) => {
+        Object.keys(fieldMap).map((fieldMapFieldName) => {
+            const field = fieldMap[fieldMapFieldName];
+            if (field.originalFieldName === fieldName && field.action === action) {
+                resultingFields[fieldMapFieldName].clearable = true;
+                resultingFields[fieldMapFieldName].clearValue = [];
+            }
+        });
+    });
+    return resultingFields;
+}

package/dist/generate-bulk-edit-ui-config/model.d.ts

@@ -0,0 +1,24 @@
+export interface BulkEditFieldConfig {
+    type: string | {
+        [key: string]: unknown;
+    }[];
+    label: string;
+    originalFieldName: string;
+    action: string;
+    clearable?: boolean;
+    clearValue?: unknown;
+}
+export interface BulkEditFieldConfigMap {
+    [key: string]: BulkEditFieldConfig;
+}
+export interface BulkEditConfig {
+    mutation: string;
+    keys?: {
+        add: string;
+        remove: string;
+        clear: string;
+        set: string;
+        filter: string;
+    };
+    fields: BulkEditFieldConfigMap;
+}

package/dist/generate-bulk-edit-ui-config/model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axinom/mosaic-graphql-codegen-plugins",
-  "version": "0.6.0-rc.9",
+  "version": "0.6.0",
   "description": "Library of graphql-codegen plugins for Mosaic workflows",
   "scripts": {
     "dev": "tsc -w",
@@ -44,5 +44,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d66c3eee2242f84ff7357b0ec00c721a9cf9134e"
+  "gitHead": "9482bdb8e36edf78e1a64c53e9b9f5bdfff9eac1"
 }

package/src/generate-bulk-edit-ui-config/generate-bulk-edit-ui-config.spec.ts

@@ -81,7 +81,7 @@ describe('generate-bulk-edit-ui-config plugin', () => {
     expect(result).toContain('export const BulkEditEntityFormFieldsConfig');
     expect(result).toContain("mutation: 'bulkEditEntity'");
     expect(result).toContain(
-      "keys: { add: 'relatedEntitiesToAdd', remove: 'relatedEntitiesToRemove', set: 'set', filter: 'filter' }",
+      "keys: { add: 'relatedEntitiesToAdd', remove: 'relatedEntitiesToRemove', clear: 'relatedEntitiesToClear', set: 'set', filter: 'filter' }",
     );
 
     // Validate the config contains proper JSON structure for fields
@@ -289,6 +289,7 @@ describe('generate-bulk-edit-ui-config plugin', () => {
     const customConfig: Partial<BulkEditPluginConfig> = {
       addKey: 'customAdd',
       removeKey: 'customRemove',
+      clearKey: 'customClear',
       setKey: 'customSet',
       filterKey: 'customFilter',
     };
@@ -376,4 +377,146 @@ describe('generate-bulk-edit-ui-config plugin', () => {
     // Restore console.warn
     consoleWarnSpy.mockRestore();
   });
+
+  it('should handle relatedEntitiesToClear and set clearable flags on remove fields', () => {
+    const ClearableEntitiesInputType = new GraphQLInputObjectType({
+      name: 'ClearableEntitiesInput',
+      fields: {
+        assignee: { type: GraphQLString },
+        tags: { type: GraphQLString },
+      },
+    });
+
+    const RelatedEntitiesInputType = new GraphQLInputObjectType({
+      name: 'RelatedEntitiesInput',
+      fields: {
+        assignee: { type: GraphQLString },
+        tags: { type: GraphQLString },
+        reviewer: { type: GraphQLString },
+      },
+    });
+
+    const SetInputType = new GraphQLInputObjectType({
+      name: 'SetInput',
+      fields: {
+        status: { type: GraphQLString },
+      },
+    });
+
+    const MutationTypeWithClear = new GraphQLObjectType({
+      name: 'Mutation',
+      fields: {
+        bulkEditWithClear: {
+          type: GraphQLString,
+          args: {
+            relatedEntitiesToAdd: { type: RelatedEntitiesInputType },
+            relatedEntitiesToRemove: { type: RelatedEntitiesInputType },
+            relatedEntitiesToClear: { type: ClearableEntitiesInputType },
+            set: { type: SetInputType },
+          },
+        },
+      },
+    });
+
+    const schemaWithClear = new GraphQLSchema({
+      query: new GraphQLObjectType({
+        name: 'Query',
+        fields: { dummy: { type: GraphQLString } },
+      }),
+      mutation: MutationTypeWithClear,
+      types: [
+        RelatedEntitiesInputType,
+        ClearableEntitiesInputType,
+        SetInputType,
+      ],
+    });
+
+    const result = plugin(schemaWithClear, [], {}) as string;
+
+    // Check that the config is generated
+    expect(result).toContain('BulkEditWithClearFormFieldsConfig');
+
+    // Parse the result to verify the clearable flags
+    const fieldsMatch = result.match(/fields: (\{[\s\S]*?\})\};/);
+    expect(fieldsMatch).toBeTruthy();
+
+    const fieldsJson = JSON.parse(fieldsMatch![1]);
+
+    // Fields that appear in relatedEntitiesToClear should have clearable: true
+    expect(fieldsJson.assigneeRemove).toHaveProperty('clearable', true);
+    expect(fieldsJson.assigneeRemove).toHaveProperty('clearValue', []);
+    expect(fieldsJson.tagsRemove).toHaveProperty('clearable', true);
+    expect(fieldsJson.tagsRemove).toHaveProperty('clearValue', []);
+
+    // Field that does NOT appear in relatedEntitiesToClear should not have clearable
+    expect(fieldsJson.reviewerRemove).not.toHaveProperty('clearable');
+    expect(fieldsJson.reviewerRemove).not.toHaveProperty('clearValue');
+  });
+
+  it('should use custom clearKey from config', () => {
+    const ClearableEntitiesInputType = new GraphQLInputObjectType({
+      name: 'ClearableEntitiesInput',
+      fields: {
+        assignee: { type: GraphQLString },
+      },
+    });
+
+    const RelatedEntitiesInputType = new GraphQLInputObjectType({
+      name: 'RelatedEntitiesInput',
+      fields: {
+        assignee: { type: GraphQLString },
+      },
+    });
+
+    const SetInputType = new GraphQLInputObjectType({
+      name: 'SetInput',
+      fields: {
+        status: { type: GraphQLString },
+      },
+    });
+
+    const MutationTypeWithCustomClear = new GraphQLObjectType({
+      name: 'Mutation',
+      fields: {
+        bulkEditCustomClear: {
+          type: GraphQLString,
+          args: {
+            relatedEntitiesToAdd: { type: RelatedEntitiesInputType },
+            relatedEntitiesToRemove: { type: RelatedEntitiesInputType },
+            customClearKey: { type: ClearableEntitiesInputType },
+            set: { type: SetInputType },
+          },
+        },
+      },
+    });
+
+    const schemaWithCustomClear = new GraphQLSchema({
+      query: new GraphQLObjectType({
+        name: 'Query',
+        fields: { dummy: { type: GraphQLString } },
+      }),
+      mutation: MutationTypeWithCustomClear,
+      types: [
+        RelatedEntitiesInputType,
+        ClearableEntitiesInputType,
+        SetInputType,
+      ],
+    });
+
+    const customConfig: Partial<BulkEditPluginConfig> = {
+      clearKey: 'customClearKey',
+    };
+
+    const result = plugin(schemaWithCustomClear, [], customConfig) as string;
+
+    // Parse the result to verify the clearable flags were set with custom key
+    const fieldsMatch = result.match(/fields: (\{[\s\S]*?\})\};/);
+    expect(fieldsMatch).toBeTruthy();
+
+    const fieldsJson = JSON.parse(fieldsMatch![1]);
+
+    // Field that appears in customClearKey should have clearable: true
+    expect(fieldsJson.assigneeRemove).toHaveProperty('clearable', true);
+    expect(fieldsJson.assigneeRemove).toHaveProperty('clearValue', []);
+  });
 });

package/src/generate-bulk-edit-ui-config/generate-bulk-edit-ui-config.ts

@@ -2,18 +2,16 @@
 import { PluginFunction } from '@graphql-codegen/plugin-helpers';
 import { capitalCase, pascalCase } from 'change-case-all';
 import { GraphQLFieldMap, GraphQLList, GraphQLObjectType } from 'graphql';
+import { BulkEditFieldConfigMap } from './model';
 
 export interface BulkEditPluginConfig {
   addKey?: string;
   removeKey?: string;
+  clearKey?: string;
   setKey?: string;
   filterKey?: string;
 }
 
-interface Data {
-  [key: string]: unknown;
-}
-
 export const plugin: PluginFunction<Partial<BulkEditPluginConfig>> = (
   schema,
   _documents,
@@ -21,6 +19,7 @@ export const plugin: PluginFunction<Partial<BulkEditPluginConfig>> = (
 ) => {
   const addKey = config.addKey || 'relatedEntitiesToAdd';
   const removeKey = config.removeKey || 'relatedEntitiesToRemove';
+  const clearKey = config.clearKey || 'relatedEntitiesToClear';
   const setKey = config.setKey || 'set';
   const filterKey = config.filterKey || 'filter';
 
@@ -39,7 +38,7 @@ export const plugin: PluginFunction<Partial<BulkEditPluginConfig>> = (
   const configs = Object.keys(mutations).map((mutationName) => {
     const mutation = mutations[mutationName];
 
-    let formFieldsConfig = {};
+    let formFieldsConfig: BulkEditFieldConfigMap = {};
 
     mutation.args.map((arg) => {
       switch (arg.name.toString()) {
@@ -75,10 +74,23 @@ export const plugin: PluginFunction<Partial<BulkEditPluginConfig>> = (
       }
     });
 
+    // Check for related entities to clear and set clearable and clearValue accordingly
+    if (mutation.args.some((a) => a.name === clearKey)) {
+      const clearArg = mutation.args.find((a) => a.name === clearKey);
+
+      if (clearArg) {
+        formFieldsConfig = resolveClearValues(
+          (typesMap[clearArg.type.toString()] as GraphQLObjectType).getFields(),
+          formFieldsConfig,
+          removeKey,
+        );
+      }
+    }
+
     if (Object.keys(formFieldsConfig).length > 0) {
       return `export const ${pascalCase(
         mutationName,
-      )}FormFieldsConfig = { mutation: '${mutationName}', keys: { add: '${addKey}', remove: '${removeKey}', set: '${setKey}', filter: '${filterKey}' }, fields: ${JSON.stringify(
+      )}FormFieldsConfig = { mutation: '${mutationName}', keys: { add: '${addKey}', remove: '${removeKey}', clear: '${clearKey}', set: '${setKey}', filter: '${filterKey}' }, fields: ${JSON.stringify(
         formFieldsConfig,
         null,
         2,
@@ -95,19 +107,19 @@ function resolveFields(
   fields: GraphQLFieldMap<any, any>,
   action: string,
   postfix = '',
-): Data {
-  const resultingFields: Data = {};
+): BulkEditFieldConfigMap {
+  const resultingFields: BulkEditFieldConfigMap = {};
   Object.keys(fields).map((fieldName) => {
     const field = fields[fieldName];
 
-    let type: string | Data[] = field.type.toString();
+    let type: string | BulkEditFieldConfigMap[] = field.type.toString();
 
     try {
       // Handle list of composite types
       const fields = (field.type as GraphQLList<any>).ofType?.getFields?.();
 
       if (fields && typeof fields === 'object') {
-        const compositeType: Data = {};
+        const compositeType: BulkEditFieldConfigMap = {};
 
         Object.keys(fields).forEach((key) => {
           const name = fields[key].name;
@@ -139,3 +151,25 @@ function resolveFields(
 
   return resultingFields;
 }
+
+// If relatedEntitiesToClear contains a field make the clearable field true on the corresponding relatedEntitiesToRemove field.
+function resolveClearValues(
+  fields: GraphQLFieldMap<any, any>,
+  fieldMap: BulkEditFieldConfigMap,
+  action: string,
+): BulkEditFieldConfigMap {
+  const resultingFields: BulkEditFieldConfigMap = { ...fieldMap };
+
+  Object.keys(fields).forEach((fieldName) => {
+    Object.keys(fieldMap).map((fieldMapFieldName) => {
+      const field = fieldMap[fieldMapFieldName];
+
+      if (field.originalFieldName === fieldName && field.action === action) {
+        resultingFields[fieldMapFieldName].clearable = true;
+        resultingFields[fieldMapFieldName].clearValue = [];
+      }
+    });
+  });
+
+  return resultingFields;
+}

package/src/generate-bulk-edit-ui-config/model.ts

@@ -0,0 +1,25 @@
+// TODO: Duplicate of libs/ui/src/components/BulkEdit/BulkEdit.models.ts - consider moving to a shared location
+export interface BulkEditFieldConfig {
+  type: string | { [key: string]: unknown }[];
+  label: string;
+  originalFieldName: string;
+  action: string;
+  clearable?: boolean;
+  clearValue?: unknown;
+}
+
+export interface BulkEditFieldConfigMap {
+  [key: string]: BulkEditFieldConfig;
+}
+
+export interface BulkEditConfig {
+  mutation: string;
+  keys?: {
+    add: string;
+    remove: string;
+    clear: string;
+    set: string;
+    filter: string;
+  };
+  fields: BulkEditFieldConfigMap;
+}