Skip to content

Use optional types in typescript types generator #195

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

Closed
wants to merge 2 commits into from
Closed

Use optional types in typescript types generator #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4155bf
fix: make not required fields optional in typescript
apperside Sep 6, 2025
9834394
feat: add handling for missing relatedTable in relationship attributes
apperside Sep 6, 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
13 changes: 13 additions & 0 deletions lib/commands/types.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,19 @@ const typesCommand = actionRunner(async (rawOutputDirectory, {language, strict})
relatedCollection: relatedTable
};
}
// Handle relationship attributes missing relatedTable/relatedCollection
if (column.type === 'relationship' && !column.relatedCollection && column.twoWayKey) {
// Try to find the related collection by looking for a collection that has the twoWayKey attribute
const relatedTable = tables.find(table =>
table.columns && table.columns.some(col => col.key === column.twoWayKey)
);
if (relatedTable) {
return {
...column,
relatedCollection: relatedTable.$id
};
}
}
return column;
})
};
Expand Down
10 changes: 6 additions & 4 deletions lib/type-generation/languages/typescript.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ class TypeScript extends LanguageMeta {
type = "boolean";
break;
case AttributeType.RELATIONSHIP:
if (!attribute.relatedCollection) {
console.warn(`Relationship attribute '${attribute.key}' is missing relatedCollection field. This usually indicates malformed relationship data.`,attribute);
type = "any";
break;
}
const relatedCollection = collections.find(c => c.$id === attribute.relatedCollection);
if (!relatedCollection) {
throw new Error(`Related collection with ID '${attribute.relatedCollection}' not found.`);
Expand All @@ -44,9 +49,6 @@ class TypeScript extends LanguageMeta {
if (attribute.array) {
type += "[]";
}
if (!attribute.required && attribute.default === null) {
type += " | null";
}
return type;
}

Expand Down Expand Up @@ -90,7 +92,7 @@ export enum <%- toPascalCase(attribute.key) %> {
<% for (const [index, collection] of Object.entries(collections)) { -%>
export type <%- toPascalCase(collection.name) %> = Models.Row & {
<% for (const attribute of collection.attributes) { -%>
<%- strict ? toCamelCase(attribute.key) : attribute.key %>: <%- getType(attribute, collections) %>;
<%- strict ? toCamelCase(attribute.key) : attribute.key %><%- attribute.required ? '' : '?' %>: <%- getType(attribute, collections) %>;
<% } -%>
}<% if (index < collections.length - 1) { %>
<% } %>
Expand Down