feat(codegen): support contentful v7.14.2 and above

Contentful changed their typings for `space` in a minor version update, meaning that users of this library had incorrect types. BREAKING CHANGE: Drops compatibility with `contentful` versions lower than 7.14.2 Closes #26 but blocked by contentful/contentful.js#398
intercom · Apr 16, 2020 · 1a81de3 · 1a81de3
1 parent 8c1f1cd
commit 1a81de3
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 30 deletions.
diff --git a/src/renderers/contentful/renderContentType.ts b/src/renderers/contentful/renderContentType.ts
@@ -65,6 +65,9 @@ function renderSys(sys: Sys) {
       createdAt: string;
       updatedAt: string;
       locale: string;
+      space: {
+        sys: SpaceLink;
+      }
       contentType: {
         sys: {
           id: '${sys.id}';

diff --git a/src/renderers/contentful/renderContentfulImports.ts b/src/renderers/contentful/renderContentfulImports.ts
@@ -3,15 +3,15 @@ export default function renderContentfulImports(localization: boolean = false):
     return `
     // THIS FILE IS AUTOMATICALLY GENERATED. DO NOT MODIFY IT.
 
-    import { Entry } from 'contentful'
+    import { Entry, SpaceLink } from 'contentful'
     import { Document } from '@contentful/rich-text-types'
   `
   }
 
   return `
     // THIS FILE IS AUTOMATICALLY GENERATED. DO NOT MODIFY IT.
 
-    import { Asset, Entry } from 'contentful'
+    import { Asset, Entry, SpaceLink } from 'contentful'
     import { Document } from '@contentful/rich-text-types'
   `
 }
diff --git a/test/renderers/contentful/renderContentType.test.ts b/test/renderers/contentful/renderContentType.test.ts
@@ -56,31 +56,32 @@ describe("renderContentType()", () => {
 
   it("works with miscellaneous field types", () => {
     expect(format(renderContentType(contentType, false))).toMatchInlineSnapshot(`
-            "export interface IMyContentTypeFields {
-              /** Symbol Field™ */
-              symbolField?: string | undefined;
+      "export interface IMyContentTypeFields {
+        /** Symbol Field™ */
+        symbolField?: string | undefined;
 
-              /** Array field */
-              arrayField: (\\"one\\" | \\"of\\" | \\"the\\" | \\"above\\")[];
-            }
+        /** Array field */
+        arrayField: (\\"one\\" | \\"of\\" | \\"the\\" | \\"above\\")[];
+      }
 
-            export interface IMyContentType extends Entry<IMyContentTypeFields> {
-              sys: {
-                id: string,
-                type: string,
-                createdAt: string,
-                updatedAt: string,
-                locale: string,
-                contentType: {
-                  sys: {
-                    id: \\"myContentType\\",
-                    linkType: \\"ContentType\\",
-                    type: \\"Link\\"
-                  }
-                }
-              };
-            }"
-        `)
+      export interface IMyContentType extends Entry<IMyContentTypeFields> {
+        sys: {
+          id: string,
+          type: string,
+          createdAt: string,
+          updatedAt: string,
+          locale: string,
+          space: SpaceLink,
+          contentType: {
+            sys: {
+              id: \\"myContentType\\",
+              linkType: \\"ContentType\\",
+              type: \\"Link\\"
+            }
+          }
+        };
+      }"
+    `)
   })
 
   it("supports descriptions", () => {
@@ -96,6 +97,7 @@ describe("renderContentType()", () => {
           createdAt: string,
           updatedAt: string,
           locale: string,
+          space: SpaceLink,
           contentType: {
             sys: {
               id: \\"myContentType\\",
@@ -125,6 +127,7 @@ describe("renderContentType()", () => {
           createdAt: string,
           updatedAt: string,
           locale: string,
+          space: SpaceLink,
           contentType: {
             sys: {
               id: \\"myContentType\\",

diff --git a/test/renderers/contentful/renderContentfulImports.test.ts b/test/renderers/contentful/renderContentfulImports.test.ts
@@ -6,7 +6,7 @@ describe("renderContentfulImports()", () => {
     expect(format(renderContentfulImports())).toMatchInlineSnapshot(`
       "// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT MODIFY IT.
 
-      import { Asset, Entry } from \\"contentful\\";
+      import { Asset, Entry, SpaceLink } from \\"contentful\\";
       import { Document } from \\"@contentful/rich-text-types\\";"
     `)
   })
@@ -15,7 +15,7 @@ describe("renderContentfulImports()", () => {
     expect(format(renderContentfulImports(true))).toMatchInlineSnapshot(`
       "// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT MODIFY IT.
 
-      import { Entry } from \\"contentful\\";
+      import { Entry, SpaceLink } from \\"contentful\\";
       import { Document } from \\"@contentful/rich-text-types\\";"
     `)
   })

diff --git a/test/renderers/render.test.ts b/test/renderers/render.test.ts
@@ -55,7 +55,7 @@ describe("render()", () => {
     expect(await render(contentTypes, locales)).toMatchInlineSnapshot(`
       "// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT MODIFY IT.
 
-      import { Asset, Entry } from \\"contentful\\"
+      import { Asset, Entry, SpaceLink } from \\"contentful\\"
       import { Document } from \\"@contentful/rich-text-types\\"
 
       export interface IMyContentTypeFields {
@@ -70,6 +70,9 @@ describe("render()", () => {
           createdAt: string
           updatedAt: string
           locale: string
+          space: {
+            sys: SpaceLink
+          }
           contentType: {
             sys: {
               id: \\"myContentType\\"
@@ -125,7 +128,7 @@ describe("render()", () => {
     expect(await render(contentTypes, locales, { localization: true })).toMatchInlineSnapshot(`
       "// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT MODIFY IT.
 
-      import { Entry } from \\"contentful\\"
+      import { Entry, SpaceLink } from \\"contentful\\"
       import { Document } from \\"@contentful/rich-text-types\\"
 
       export interface IMyContentTypeFields {
@@ -140,6 +143,9 @@ describe("render()", () => {
           createdAt: string
           updatedAt: string
           locale: string
+          space: {
+            sys: SpaceLink
+          }
           contentType: {
             sys: {
               id: \\"myContentType\\"
@@ -187,7 +193,7 @@ describe("render()", () => {
     expect(await render(contentTypes, locales, { namespace: "Codegen" })).toMatchInlineSnapshot(`
       "// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT MODIFY IT.
 
-      import { Asset, Entry } from \\"contentful\\"
+      import { Asset, Entry, SpaceLink } from \\"contentful\\"
       import { Document } from \\"@contentful/rich-text-types\\"
 
       declare namespace Codegen {
@@ -203,6 +209,9 @@ describe("render()", () => {
             createdAt: string
             updatedAt: string
             locale: string
+            space: {
+              sys: SpaceLink
+            }
             contentType: {
               sys: {
                 id: \\"myContentType\\"