fix(imports): self references (#23)

When a type references itself in one of the fields, no self referencing imports should be added. Fixes #19
contentful-userland · Sep 10, 2020 · 1be9c35 · 1be9c35
1 parent fb4dcec
commit 1be9c35
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 4 deletions.
diff --git a/src/cf-definitions-builder.ts b/src/cf-definitions-builder.ts
@@ -140,7 +140,8 @@ export default class CFDefinitionsBuilder {
             moduleSpecifier: '@contentful/rich-text-types',
             namespaceImport: 'CFRichTextTypes',
         });
-        file.addImportDeclarations(propertyImports(field));
+
+        file.addImportDeclarations(propertyImports(field, file.getBaseNameWithoutExtension()));
     };
 
     private mergeFile = (mergeFileName = 'ContentTypes'): SourceFile => {

diff --git a/src/cf-property-imports.ts b/src/cf-property-imports.ts
@@ -9,12 +9,18 @@ const moduleImport = (module: string) => ({
     ],
 });
 
-export const propertyImports = (field: Field): OptionalKind<ImportDeclarationStructure>[] => {
+export const propertyImports = (field: Field, ignoreModule?: string): OptionalKind<ImportDeclarationStructure>[] => {
+    const filterIgnoredModule = (name: string) => ignoreModule !== moduleName(name);
+
     if (field.type === 'Link' && field.linkType === 'Entry') {
-        return linkContentTypeValidations(field).map(moduleImport);
+        return linkContentTypeValidations(field)
+            .filter(filterIgnoredModule)
+            .map(moduleImport);
     }
     if (field.type === 'Array' && field.items) {
-        return linkContentTypeValidations(field.items).map(moduleImport);
+        return linkContentTypeValidations(field.items)
+            .filter(filterIgnoredModule)
+            .map(moduleImport);
     }
     return [];
 };
diff --git a/test/cf-definitions-builder.test.ts b/test/cf-definitions-builder.test.ts
@@ -402,4 +402,48 @@ describe('A Contentful definitions builder', () => {
             export { TypeSysId, TypeSysIdFields } from "./TypeSysId";
             `));
     });
+
+  it('can self-reference', async () => {
+    builder.appendType(modelType);
+    builder.appendType({
+      id: 'rootId',
+      name: 'Root Name',
+      sys: {
+        id: 'myType',
+        type: 'ContentType',
+      }, fields: [
+        {
+          id: 'linkFieldId',
+          name: 'Linked entry Field',
+          type: 'Link',
+          localized: false,
+          required: false,
+          validations: [
+            {
+              linkContentType: [
+                'myType',
+              ],
+            },
+          ],
+          disabled: false,
+          omitted: false,
+          linkType: 'Entry',
+        },
+      ],
+    });
+
+    await builder.write(fixturesPath);
+
+    const result2 = await fs.readFile(path.resolve(fixturesPath, 'TypeMyType.ts'));
+
+    expect('\n' + result2.toString()).to.equal(stripIndent(`
+                import * as Contentful from "contentful";
+                
+                export interface TypeMyTypeFields {
+                    linkFieldId?: Contentful.Entry<TypeMyTypeFields>;
+                }
+
+                export type TypeMyType = Contentful.Entry<TypeMyTypeFields>;
+                `));
+  });
 });