feat: rename types in config

Author: s.vanriessen

src/index.ts

@@ -443,10 +443,12 @@ const getMockString = (
     prefix,
     typesPrefix = '',
     transformUnderscore: boolean,
+    newTypeNames?: Record<string, string>,
 ) => {
     const typeNameConverter = createNameConverter(typeNamesConvention, transformUnderscore);
+    const NewTypeName = newTypeNames[typeName] || typeName;
     const casedName = typeNameConverter(typeName);
-    const casedNameWithPrefix = typeNameConverter(typeName, typesPrefix);
+    const casedNameWithPrefix = typeNameConverter(NewTypeName, typesPrefix);
     const typename = addTypename ? `\n        __typename: '${typeName}',` : '';
     const typenameReturnType = addTypename ? `{ __typename: '${typeName}' } & ` : '';
 
@@ -489,6 +491,7 @@ const getImportTypes = ({
     transformUnderscore,
     enumsAsTypes,
     useTypeImports,
+    newTypeNames,
 }: {
     typeNamesConvention: NamingConvention;
     definitions: any;
@@ -499,19 +502,26 @@ const getImportTypes = ({
     transformUnderscore: boolean;
     enumsAsTypes: boolean;
     useTypeImports: boolean;
+    newTypeNames?: Record<string, string>;
 }) => {
     const typenameConverter = createNameConverter(typeNamesConvention, transformUnderscore);
     const typeImports = typesPrefix?.endsWith('.')
         ? [typesPrefix.slice(0, -1)]
         : definitions
               .filter(({ typeName }: { typeName: string }) => !!typeName)
               .map(({ typeName }: { typeName: string }) => typenameConverter(typeName, typesPrefix));
+    const renamedTypeImports = typeImports.map((type) => {
+        if (newTypeNames[type]) {
+            return `${type} as ${newTypeNames[type]}`;
+        }
+        return type;
+    });
     const enumTypes = enumsPrefix?.endsWith('.')
         ? [enumsPrefix.slice(0, -1)]
         : types.filter(({ type }) => type === 'enum').map(({ name }) => typenameConverter(name, enumsPrefix));
 
     if (!enumsAsTypes || useTypeImports) {
-        typeImports.push(...enumTypes);
+        renamedTypeImports.push(...enumTypes);
     }
 
     function onlyUnique(value, index, self) {
@@ -520,7 +530,9 @@ const getImportTypes = ({
 
     const importPrefix = `import ${useTypeImports ? 'type ' : ''}`;
 
-    return typesFile ? `${importPrefix}{ ${typeImports.filter(onlyUnique).join(', ')} } from '${typesFile}';\n` : '';
+    return typesFile
+        ? `${importPrefix}{ ${renamedTypeImports.filter(onlyUnique).join(', ')} } from '${typesFile}';\n`
+        : '';
 };
 
 type GeneratorName = keyof Casual.Casual | keyof Casual.functions | string;
@@ -564,6 +576,7 @@ export interface TypescriptMocksPluginConfig {
     useImplementingTypes?: boolean;
     defaultNullableToNull?: boolean;
     useTypeImports?: boolean;
+    newTypeNames?: Record<string, string>;
 }
 
 interface TypeItem {
@@ -614,6 +627,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
     const useImplementingTypes = config.useImplementingTypes ?? false;
     const defaultNullableToNull = config.defaultNullableToNull ?? false;
     const generatorLocale = config.locale || 'en';
+    const newTypeNames = config.newTypeNames || {};
 
     // List of types that are enums
     const types: TypeItem[] = [];
@@ -747,6 +761,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                         config.prefix,
                         config.typesPrefix,
                         transformUnderscore,
+                        newTypeNames,
                     );
                 },
             };
@@ -770,6 +785,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                         config.prefix,
                         config.typesPrefix,
                         transformUnderscore,
+                        newTypeNames,
                     );
                 },
             };
@@ -791,6 +807,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                         config.prefix,
                         config.typesPrefix,
                         transformUnderscore,
+                        newTypeNames,
                     );
                 },
             };
@@ -813,6 +830,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
         transformUnderscore: transformUnderscore,
         useTypeImports: config.useTypeImports,
         enumsAsTypes,
+        newTypeNames,
     });
     // Function that will generate the mocks.
     // We generate it after having visited because we need to distinct types from enums

tests/useTypeImports/__snapshots__/spec.ts.snap

@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`should support useTypeImports 1`] = `
-"import type { Avatar, User, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, ListType, UpdateUserInput, Mutation, Query, AbcStatus, Status, PrefixedEnum } from './types/graphql';
+"import type { Avatar, User, Partial, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, ListType, UpdateUserInput, Mutation, Query, AbcStatus, Status, PrefixedEnum } from './types/graphql';
 
 export const anAvatar = (overrides?: Partial<Avatar>): Avatar => {
     return {
@@ -25,6 +25,12 @@ export const aUser = (overrides?: Partial<User>): User => {
     };
 };
 
+export const aPartial = (overrides?: Partial<Partial>): Partial => {
+    return {
+        id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : '262c8866-bf76-4ccf-b606-2a0b4742f81f',
+    };
+};
+
 export const aWithAvatar = (overrides?: Partial<WithAvatar>): WithAvatar => {
     return {
         id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : '99f515e7-21e0-461d-b823-0d4c7f4dafc5',

tests/useTypeImports/schema.ts

@@ -22,6 +22,10 @@ export default buildSchema(/* GraphQL */ `
         prefixedEnum: Prefixed_Enum
     }
 
+    type Partial {
+        id: ID!
+    }
+
     interface WithAvatar {
         id: ID!
         avatar: Avatar

tests/useTypeImports/spec.ts

@@ -6,7 +6,20 @@ it('should support useTypeImports', async () => {
 
     expect(result).toBeDefined();
     expect(result).toContain(
-        "import type { Avatar, User, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, ListType, UpdateUserInput, Mutation, Query, AbcStatus, Status, PrefixedEnum } from './types/graphql';",
+        "import type { Avatar, User, Partial, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, ListType, UpdateUserInput, Mutation, Query, AbcStatus, Status, PrefixedEnum } from './types/graphql';",
     );
     expect(result).toMatchSnapshot();
 });
+
+it('should support useTypeImports', async () => {
+    const result = await plugin(testSchema, [], {
+        typesFile: './types/graphql.ts',
+        useTypeImports: true,
+        newTypeNames: { Partial: 'RenamedPartial' },
+    });
+
+    expect(result).toBeDefined();
+    expect(result).toContain(
+        "import type { Avatar, User, Partial as RenamedPartial, WithAvatar, CamelCaseThing, PrefixedResponse, AbcType, ListType, UpdateUserInput, Mutation, Query, AbcStatus, Status, PrefixedEnum } from './types/graphql';",
+    );
+});