Merge pull request #65 from contentstack/development

DX | 24-03-2025 | Release

Author: harshithad0703

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/types-generator",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Contentstack type definition generation library",
   "private": false,
   "author": "Contentstack",
@@ -29,6 +29,7 @@
   },
   "homepage": "https://github.com/contentstack/types-generator",
   "devDependencies": {
+    "@types/async": "^3.2.24",
     "@types/jest": "^29.5.14",
     "@types/lodash": "^4.17.15",
     "@types/node": "^20.17.17",
@@ -45,7 +46,8 @@
   "dependencies": {
     "@contentstack/delivery-sdk": "^4.5.0",
     "@gql2ts/from-schema": "^2.0.0-4",
-    "axios": "^1.7.9",
+    "async": "^3.2.6",
+    "axios": "^1.8.4",
     "lodash": "^4.17.21",
     "prettier": "^3.4.2"
   },

package.json

@@ -162,8 +162,7 @@ export default function (userOptions: TSGenOptions) {
       op = "[]";
 
       if (field.max_instance) {
-        const elements = new Array(field.max_instance).fill(type as any);
-        return ["[", elements.join(", "), "]"].join("");
+        return ["MaxTuple<", type, ", ", field.max_instance, ">"].join("");
       }
     }
 
@@ -215,35 +214,18 @@ export default function (userOptions: TSGenOptions) {
     return op_array(type, field);
   }
 
+  const handleGlobalField = (field: ContentstackTypes.Field): string => {
+    const referenceName = name_type(field.reference_to);
+    // Return the reference name with array brackets if the field is multiple
+    return `${referenceName}${field.multiple ? "[]" : ""}`;
+  };
+  
+
   function visit_field(field: ContentstackTypes.Field) {
     let fieldType = "";
     // Check if the field is a global field
     if (field.data_type === "global_field") {
-      // Check if the field is cached
-      const isCached = cachedGlobalFields[name_type(field.reference_to)];
-
-      // Generate the referred_content_types array
-      const referredContentTypes = [
-        {
-          title: name_type(field.reference_to),
-          uid: field.reference_to,
-        },
-      ];
-
-      // Assign the new structure for the global field
-      fieldType = `referred_content_types: ${JSON.stringify(
-        referredContentTypes
-      )}`;
-
-      // If it's a multiple field, append '[]' to the fieldType
-      if (field.multiple) {
-        fieldType += "[]";
-      }
-
-      // If the field is not cached and there is a reference, update fieldType accordingly
-      if (!isCached && field.reference_to) {
-        fieldType = type_reference(field);
-      }
+      fieldType = handleGlobalField(field);
     } else if (field.data_type === "blocks") {
       // Handle blocks type (unchanged)
       fieldType = type_modular_blocks(field);
@@ -264,18 +246,17 @@ export default function (userOptions: TSGenOptions) {
           : " | null"
         : "";
 
-    if (fieldType.startsWith("referred_content_types")) {
-      // For global_field or referred_content_types, omit field.uid in output
-      return `${fieldType}`;
-    }
     // Ensure the formatting is correct, and avoid concatenating field.uid directly to a string
     return `${field.uid}${requiredFlag}: ${fieldType}${typeModifier};`;
   }
 
   function visit_fields(schema: ContentstackTypes.Schema) {
     return schema
       .map((v) => {
-        return [options.docgen.field(v.display_name), visit_field(v)]
+        return [
+          options.docgen.field(v.display_name),
+          visit_field(v),
+        ]
           .filter((v) => v)
           .join("\n");
       })

src/generateTS/factory.ts

@@ -1,3 +1,5 @@
+import async from "async";
+import {flatMap, flatten} from 'lodash';
 import { TOKEN_TYPE } from "../constants";
 import { initializeContentstackSdk } from "../sdk/utils";
 import { GenerateTS, GenerateTSFromContentTypes } from "../types";
@@ -41,8 +43,9 @@ export const generateTS = async ({
       });
 
       const contentTypeQuery = Stack.contentType();
+      contentTypeQuery._queryParams['include_count'] = 'true';
       const globalFieldsQuery = Stack.globalField();
-      const contentTypes = await contentTypeQuery.find();
+      const contentTypes = await getContentTypes(contentTypeQuery);
       const globalFields = await globalFieldsQuery.find();
 
       const { content_types }: any = contentTypes;
@@ -163,3 +166,31 @@ export const generateTSFromContentTypes = async ({
     };
   }
 };
+
+const getContentTypes = async (contentTypeQuery: any) => {
+  try {
+    const limit = 100;
+
+    const results: any = await contentTypeQuery.find();
+
+    if (results?.count > limit) {
+      const additionalQueries = Array.from(
+        { length: Math.ceil(results.count / limit) - 1 },
+        (_, i) => {
+          return async.reflect(async () => {
+            contentTypeQuery._queryParams['skip'] = (i + 1) * limit;
+            contentTypeQuery._queryParams['limit'] = limit;
+            return contentTypeQuery.find();
+          });
+        }
+      );
+      const additionalResults: any = (await async.parallel(additionalQueries));
+      const flattenedResult = additionalResults.flatMap((res: any) => res?.value?.content_types);
+      results.content_types = flatten([flattenedResult, results.content_types]);
+    }
+
+    return results;
+  } catch (error) {
+    throw error;
+  }
+};

src/generateTS/index.ts

@@ -4,6 +4,11 @@ export const defaultInterfaces = (
   hasJsonRte?: boolean
 ) => {
   const defaultInterfaces = [
+    `type BuildTuple<T, N extends number, R extends T[] = []> =
+    R['length'] extends N ? R : BuildTuple<T, N, [...R, T]>`,
+      `type TuplePrefixes<T extends any[]> = 
+    T extends [any, ...infer Rest] ? T | TuplePrefixes<Rest extends any[] ? Rest : []> : []`,
+      `type MaxTuple<T, N extends number> = TuplePrefixes<BuildTuple<T, N>>`,
     `export interface ${prefix}PublishDetails {
             environment: string;
             locale: string;

src/generateTS/stack/builtins.ts

@@ -80,9 +80,14 @@ export async function graphqlTS({
           "Unauthorized: The apiKey, token or environment is not valid.",
       };
     } else {
+      let details = '';
+      if (error.response.data.errors[0]?.extensions?.errors?.[0]?.code === 'SCHEMA_BUILD_ERROR') {
+        error.response.data.errors[0].extensions.errors[0].details.forEach((element: {error: string}) => {
+          details += element.error + '\n'
+        });
+      }
       throw {
-        error_message:
-          error.response.data.errors[0]?.extensions?.errors[0].message,
+        error_message: details ? details : error.response.data.errors[0]?.extensions?.errors[0].message,
       };
     }
   }

src/graphqlTS/index.ts

@@ -26,17 +26,9 @@ describe("group", () => {
       /** Version */
       _version: number;
       title: string;
-      multiple_group_max_limit?: [{
+      multiple_group_max_limit?: MaxTuple<{
       number?: number | null;
-      }, {
-      number?: number | null;
-      }, {
-      number?: number | null;
-      }, {
-      number?: number | null;
-      }, {
-      number?: number | null;
-      }];
+      }, 5>;
       multiple_group?: {
       single_line?: string;
       }[];

tests/unit/tsgen/group.test.ts

@@ -30,8 +30,8 @@ describe("builtin isodate field", () => {
       date?: string | null;
       date_required: string;
       date_multiple?: string[] | null;
-      date_multiple_maxlength?: [string, string, string, string, string] | null;
-      date_required_multiple_maxlength: [string, string, string, string, string, string, string, string];
+      date_multiple_maxlength?: MaxTuple<string, 5> | null;
+      date_required_multiple_maxlength: MaxTuple<string, 8>;
       }"
     `);
   });

tests/unit/tsgen/isodate.test.ts

@@ -28,8 +28,8 @@ describe("builtin number field", () => {
       number?: number | null;
       number_required: number;
       number_multiple?: number[] | null;
-      number_multiple_max_limit?: [number, number, number, number, number, number, number, number, number, number] | null;
-      number_required_multiple_max_limit: [number, number, number];
+      number_multiple_max_limit?: MaxTuple<number, 10> | null;
+      number_required_multiple_max_limit: MaxTuple<number, 3>;
       }"
     `);
   });

tests/unit/tsgen/number.test.ts

@@ -21,7 +21,7 @@ describe("all options", () => {
       single_line_textbox_not_required?: string;
       single_line_textbox_required: string;
       single_line_textbox_multiple?: string[];
-      single_line_textbox_multiple_max_limit?: [string, string, string, string, string];
+      single_line_textbox_multiple_max_limit?: MaxTuple<string, 5>;
       }"
     `);
   });