Skip to content

fix: Global fields get the same key name in custom Content Type #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aman19K merged 2 commits into from
Mar 21, 2025
Merged

fix: Global fields get the same key name in custom Content Type #67

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50f30d5
fix: Global fields get the same key name in custom Content Type
aman19K Mar 21, 2025
515a1f8
fix: test cases
aman19K Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 12 additions & 30 deletions src/generateTS/factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,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);
Expand All @@ -263,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");
})
Expand Down