fix(renderField): use field.localized

Author: zernie

src/renderers/contentful/renderField.ts

@@ -6,5 +6,12 @@ export default function renderField(
   type: string,
   localization: boolean = false,
 ): string {
-  return renderInterfaceProperty(field.id, type, field.required, localization, field.name)
+  return renderInterfaceProperty(
+    field.id,
+    type,
+    field.required,
+    localization,
+    field.localized,
+    field.name,
+  )
 }

src/renderers/contentful/renderLocalizedTypes.ts

@@ -3,7 +3,8 @@ export default function renderLocalizedTypes(localization: boolean) {
   if (!localization) return null
 
   return `
-    export type LocalizedField<T> = Partial<Record<LOCALE_CODE, T>>
+    export type DefaultLocalizedField<T> = Record<CONTENTFUL_DEFAULT_LOCALE_CODE, T>
+    export type LocalizedField<T> = DefaultLocalizedField<T> & Partial<Record<LOCALE_CODE, T>>
   
     // We have to use our own localized version of Asset because of a bug in contentful https://github.com/contentful/contentful.js/issues/208
     export interface Asset {

src/renderers/typescript/renderInterfaceProperty.ts

@@ -3,19 +3,24 @@ export default function renderInterfaceProperty(
   type: string,
   required: boolean,
   localization: boolean,
+  localized: boolean,
   description?: string,
 ): string {
   return [
     descriptionComment(description),
     name,
     required ? "" : "?",
     ": ",
-    localization ? `LocalizedField<${type}>` : type,
+    localization ? renderLocalizedField(localized, type) : type,
     required ? "" : " | undefined",
     ";",
   ].join("")
 }
 
+function renderLocalizedField(localized: boolean, type: string) {
+  return localized ? `LocalizedField<${type}>` : `DefaultLocalizedField<${type}>`
+}
+
 function descriptionComment(description: string | undefined) {
   if (description) {
     return `/** ${description} */\n`

test/renderers/contentful/renderContentType.test.ts

@@ -18,6 +18,16 @@ describe("renderContentType()", () => {
         localized: false,
         type: "Symbol",
       },
+      {
+        id: "localizedSymbolField",
+        name: "Localized Symbol Field™",
+        required: true,
+        validations: [],
+        disabled: false,
+        omitted: false,
+        localized: true,
+        type: "Symbol",
+      },
       {
         id: "arrayField",
         name: "Array field",
@@ -60,6 +70,9 @@ describe("renderContentType()", () => {
               /** Symbol Field™ */
               symbolField?: string | undefined;
 
+              /** Localized Symbol Field™ */
+              localizedSymbolField: string;
+
               /** Array field */
               arrayField: (\\"one\\" | \\"of\\" | \\"the\\" | \\"above\\")[];
             }
@@ -112,10 +125,13 @@ describe("renderContentType()", () => {
     expect(format(renderContentType(contentType, true))).toMatchInlineSnapshot(`
       "export interface IMyContentTypeFields {
         /** Symbol Field™ */
-        symbolField?: LocalizedField<string> | undefined;
+        symbolField?: DefaultLocalizedField<string> | undefined;
+
+        /** Localized Symbol Field™ */
+        localizedSymbolField: LocalizedField<string>;
 
         /** Array field */
-        arrayField: LocalizedField<(\\"one\\" | \\"of\\" | \\"the\\" | \\"above\\")[]>;
+        arrayField: DefaultLocalizedField<(\\"one\\" | \\"of\\" | \\"the\\" | \\"above\\")[]>;
       }
 
       export interface IMyContentType extends Entry<IMyContentTypeFields> {

test/renderers/render.test.ts

@@ -130,7 +130,7 @@ describe("render()", () => {
 
       export interface IMyContentTypeFields {
         /** Array field */
-        arrayField: LocalizedField<(\\"one\\" | \\"of\\" | \\"the\\" | \\"above\\")[]>
+        arrayField: DefaultLocalizedField<(\\"one\\" | \\"of\\" | \\"the\\" | \\"above\\")[]>
       }
 
       export interface IMyContentType extends Entry<IMyContentTypeFields> {
@@ -156,7 +156,8 @@ describe("render()", () => {
 
       export type CONTENTFUL_DEFAULT_LOCALE_CODE = \\"en-US\\"
 
-      export type LocalizedField<T> = Partial<Record<LOCALE_CODE, T>>
+      export type DefaultLocalizedField<T> = Record<CONTENTFUL_DEFAULT_LOCALE_CODE, T>
+      export type LocalizedField<T> = DefaultLocalizedField<T> & Partial<Record<LOCALE_CODE, T>>
 
       // We have to use our own localized version of Asset because of a bug in contentful https://github.com/contentful/contentful.js/issues/208
       export interface Asset {

test/renderers/typescript/renderInterfaceProperty.test.ts

@@ -2,28 +2,32 @@ import renderInterfaceProperty from "../../../src/renderers/typescript/renderInt
 
 describe("renderInterfaceProperty()", () => {
   it("works with unrequired properties", () => {
-    expect(renderInterfaceProperty("property", "type", false, false).trim()).toMatchInlineSnapshot(
+    expect(renderInterfaceProperty("property", "type", false, false, false).trim()).toMatchInlineSnapshot(
       `"property?: type | undefined;"`,
     )
   })
 
   it("works with required properties", () => {
-    expect(renderInterfaceProperty("property", "type", true, false).trim()).toMatchInlineSnapshot(
+    expect(renderInterfaceProperty("property", "type", true, false, false).trim()).toMatchInlineSnapshot(
       `"property: type;"`,
     )
   })
 
   it("adds descriptions", () => {
-    expect(renderInterfaceProperty("property", "type", false, false, "Description").trim())
+    expect(renderInterfaceProperty("property", "type", false, false,  false,"Description").trim())
       .toMatchInlineSnapshot(`
       "/** Description */
       property?: type | undefined;"
     `)
   })
 
   it("supports localized fields", () => {
-    expect(renderInterfaceProperty("property", "type", false, true).trim()).toMatchInlineSnapshot(
+    expect(renderInterfaceProperty("property", "type", false, true, true).trim()).toMatchInlineSnapshot(
       `"property?: LocalizedField<type> | undefined;"`,
     )
+
+    expect(renderInterfaceProperty("property", "type", false, true, false).trim()).toMatchInlineSnapshot(
+      `"property?: DefaultLocalizedField<type> | undefined;"`,
+    )
   })
 })