Skip to content

Release 2.1.6 #96

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
tim-fabian merged 3 commits into from
Jan 18, 2026
Merged

Release 2.1.6 #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f9cfb8
fixed property naming in automatc entity file generation
tim-fabian Jan 18, 2026
4c958df
updated package-lock
tim-fabian Jan 18, 2026
2be97bf
Merge pull request #95 from Service-Soft/94-generateentityfiles-uses-…
tim-fabian Jan 18, 2026
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
10 changes: 5 additions & 5 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "zibri",
"version": "2.1.5",
"version": "2.1.6",
"main": "./dist/cjs/index.js",
"types": "./dist/cjs/index.d.ts",
"module": "./dist/esm/index.mjs",
Expand Down
6 changes: 3 additions & 3 deletions src/entity/generation/generate-entity-file.function.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import { getEntityFileName } from './get-entity-file-name.function';
import { EntityGenerationProvider } from './providers/entity-generation-provider.interface';
import { OpenApiReferenceObject, OpenApiSchemaObject, OpenApiSchemas } from '../../open-api';
import { toCamelCase, toPascalCase } from '../../utilities';
import { toPascalCase } from '../../utilities';
import { addImportStatement } from '../../utilities/add-import-statement.function';

/**
Expand Down Expand Up @@ -79,11 +79,11 @@ export function generateEntityFile(
const decoratorLines: string[] = mapSchemaToDecoratorLines(propSchema, propName, provider.prefix, isRequired, type);

if (!isRef) {
lines.push('', ...decoratorLines, ` ${toCamelCase(propName)}${optional}: ${type};`);
lines.push('', ...decoratorLines, ` '${propName}'${optional}: ${type};`);
continue;
}

lines.push('', ...decoratorLines, ` ${toCamelCase(propName)}${optional}: ${getEntityName(provider.prefix, type)};`);
lines.push('', ...decoratorLines, ` '${propName}'${optional}: ${getEntityName(provider.prefix, type)};`);
addImportStatement(
lines,
{
Expand Down
86 changes: 42 additions & 44 deletions src/entity/generation/generate-entity-files-for-provider.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ function findFile(files: FileToGenerate[], className: string): FileToGenerate |
function expectDecoratorAboveProperty(
fileContent: string,
decoratorRegex: RegExp,
propName: string,
propNameRegex = new RegExp(`\\b${propName}[!?]:`)
propNameRegex: RegExp
): void {
// Match a decorator block immediately followed by the property line.
// Allows optional single blank line between decorator and property (be tolerant),
Expand Down Expand Up @@ -66,8 +65,8 @@ describe('generateEntityFiles', () => {
const petContent: string = petFile.lines.join('\n');

// required fields should be marked (e.g. name! and photoUrls!)
expect(petContent).toMatch(/\bname[!?]:/);
expect(petContent).toMatch(/\bphotoUrls[!?]:/);
expect(petContent).toContain('\'name\'!:');
expect(petContent).toContain('\'photoUrls\'!:');

// status enum should be present (contains one of the enum values)
expect(petContent).toMatch(/available|pending|sold/);
Expand Down Expand Up @@ -113,15 +112,15 @@ describe('generateEntityFiles', () => {
const content: string = file.lines.join('\n');

// name is required -> should have '!' and @Property.string() immediately above
expect(content).toMatch(/\bname!:/);
expectDecoratorAboveProperty(content, /@Property\.string\(\)/, 'name');
expect(content).toContain('\'name\'!:');
expectDecoratorAboveProperty(content, /@Property\.string\(\)/, /'name'!:/);

// note is optional -> @Property.string({ required: false }) must be right above `note?:`
expect(content).toMatch(/\bnote\?:/);
expectDecoratorAboveProperty(content, /@Property\.string\({\s*required:\s*false\s*}\)/, 'note');
expect(content).toMatch('\'note\'?:');
expectDecoratorAboveProperty(content, /@Property\.string\({\s*required:\s*false\s*}\)/, /'note'\?:/);

// created -> date decorator right above created property
expectDecoratorAboveProperty(content, /@Property\.date\(\)/, 'created');
expectDecoratorAboveProperty(content, /@Property\.date\(\)/, /'created'!:/);
});

it('number/integer and boolean map to @Property.number/@Property.boolean', async () => {
Expand Down Expand Up @@ -154,16 +153,16 @@ describe('generateEntityFiles', () => {
const content: string = file.lines.join('\n');

// count required -> number decorator + '!'
expect(content).toMatch(/\bcount!:/);
expectDecoratorAboveProperty(content, /@Property\.number\(\)/, 'count');
expect(content).toContain('\'count\'!:');
expectDecoratorAboveProperty(content, /@Property\.number\(\)/, /'count'!:/);

// ratio optional -> number decorator with required:false immediately above ratio property
expect(content).toMatch(/\bratio\?:/);
expectDecoratorAboveProperty(content, /@Property\.number\({\s*required:\s*false\s*}\)/, 'ratio');
expect(content).toContain('\'ratio\'?:');
expectDecoratorAboveProperty(content, /@Property\.number\({\s*required:\s*false\s*}\)/, /'ratio'\?:/);

// flag required -> boolean decorator + '!'
expect(content).toMatch(/\bflag!:/);
expectDecoratorAboveProperty(content, /@Property\.boolean\(\)/, 'flag');
expect(content).toContain('\'flag\'!:');
expectDecoratorAboveProperty(content, /@Property\.boolean\(\)/, /'flag'!:/);
});

it('array of primitives uses @Property.array with item type', async () => {
Expand Down Expand Up @@ -195,12 +194,12 @@ describe('generateEntityFiles', () => {
const content: string = file.lines.join('\n');

// tags required => property signature with ! and decorator items: { type: 'string' }
expect(content).toMatch(/\btags!:/);
expectDecoratorAboveProperty(content, /@Property\.array\([^)]*items:\s*{\s*type:\s*'string'\s*}[^)]*\)/, 'tags');
expect(content).toContain('\'tags\'!:');
expectDecoratorAboveProperty(content, /@Property\.array\([^)]*items:\s*{\s*type:\s*'string'\s*}[^)]*\)/, /'tags'!:/);

// counts optional => items type integer -> mapped to 'number' in decorator and required:false
expect(content).toMatch(/\bcounts\?:/);
expectDecoratorAboveProperty(content, /@Property\.array\([^)]*required:\s*false[^)]*items:\s*{\s*type:\s*'number'\s*}[^)]*\)/, 'counts');
expect(content).toContain('\'counts\'?:');
expectDecoratorAboveProperty(content, /@Property\.array\([^)]*required:\s*false[^)]*items:\s*{\s*type:\s*'number'\s*}[^)]*\)/, /'counts'\?:/);
});

it('array of inline objects uses schema.title for generated name and preserves property metadata', async () => {
Expand Down Expand Up @@ -256,13 +255,12 @@ describe('generateEntityFiles', () => {
const childContent: string = childFile.lines.join('\n');

// parent should reference child type in property signature
expect(parentContent).toMatch(new RegExp(`\\bparts!:\\s*${childClass}\\[\\]`));

expect(parentContent).toContain(`'parts'!: ${childClass}`);
// parent decorator must reference cls: () => ChildClass directly above parts
expectDecoratorAboveProperty(
parentContent,
new RegExp(`@Property\\.array\\([^)]*type:\\s*'object'[^)]*cls:\\s*\\(\\)\\s*=>\\s*${childClass}[^)]*\\)`),
'parts'
/'parts'!:/
);

// parent file should import the child (simple presence of the child class name in imports)
Expand All @@ -271,15 +269,15 @@ describe('generateEntityFiles', () => {

// child file: check class name and decorator placement for required fields
expect(childContent).toContain(`export class ${childClass}`);
expect(childContent).toMatch(/\bid!:/); // required id
expectDecoratorAboveProperty(childContent, /@Property\.string\(\)/, 'id');
expect(childContent).toContain('\'id\'!:'); // required id
expectDecoratorAboveProperty(childContent, /@Property\.string\(\)/, /'id'!:/);

// createdAt uses date-time -> date decorator and required
expect(childContent).toMatch(/\bcreatedAt!:/);
expectDecoratorAboveProperty(childContent, /@Property\.date\(\)/, 'createdAt');
expect(childContent).toContain('\'createdAt\'!:');
expectDecoratorAboveProperty(childContent, /@Property\.date\(\)/, /'createdAt'!:/);

// amount mapped to number decorator
expectDecoratorAboveProperty(childContent, /@Property\.number\({\s*required:\s*false\s*}\)/, 'amount');
expectDecoratorAboveProperty(childContent, /@Property\.number\({\s*required:\s*false\s*}\)/, /'amount'\?:/);

// enum values should appear in the generated type (or decorator metadata)
expect(childContent).toMatch(/'ok'\s*|\s*'bad'/);
Expand Down Expand Up @@ -334,11 +332,11 @@ describe('generateEntityFiles', () => {
expectDecoratorAboveProperty(
hostContent,
new RegExp(`@Property\\.object\\([^)]*cls:\\s*\\(\\)\\s*=>\\s*${refedClass}[^)]*\\)`),
'other'
/'other'!:/
);

// host property should be typed to the referenced class
expect(hostContent).toMatch(new RegExp(`\\bother!:\\s*${refedClass}\\b`));
expect(hostContent).toContain(`'other'!: ${refedClass}`);

// import line for the refed class should be present
const importLinePresent: boolean = hostFile.lines.some(l => l.includes('import') && l.includes(refedClass));
Expand Down Expand Up @@ -366,10 +364,10 @@ describe('generateEntityFiles', () => {
title: 'CreateUserPayload', // generator should prefer this title
properties: {
id: { type: 'integer', format: 'int64' },
email: { type: 'string', format: 'date-time' },
date: { type: 'string', format: 'date-time' },
role: { type: 'string', enum: ['admin', 'user'] }
},
required: ['id', 'email']
required: ['id', 'date']
}
}
}
Expand All @@ -396,17 +394,17 @@ describe('generateEntityFiles', () => {

// class name and required markers
expect(content).toContain(`export class ${childClass}`);
expect(content).toMatch(/\bid!:/); // id required
expectDecoratorAboveProperty(content, /@Property\.number\(\)/, 'id');
expect(content).toContain('\'id\'!:'); // id required
expectDecoratorAboveProperty(content, /@Property\.number\(\)/, /'id'!:/);

// email required -> date decorator
expect(content).toMatch(/\bemail!:/);
expectDecoratorAboveProperty(content, /@Property\.date\(\)/, 'email');
// date required -> date decorator
expect(content).toContain('\'date\'!:');
expectDecoratorAboveProperty(content, /@Property\.date\(\)/, /'date'!:/);

// role optional -> union literal present and decorator above property (optional)
expect(content).toMatch(/'admin'\s*\|\s*'user'/);
expect(content).toMatch(/\brole\?:/);
expectDecoratorAboveProperty(content, /@Property\.string\({\s*required:\s*false\s*}\)/, 'role');
expect(content).toContain('\'role\'?:');
expectDecoratorAboveProperty(content, /@Property\.string\({\s*required:\s*false\s*}\)/, /'role'\?:/);

// index export present (kebab-case)
const kebabPrefix: string = toKebabCase(provider.prefix);
Expand Down Expand Up @@ -459,17 +457,17 @@ describe('generateEntityFiles', () => {

// class name and required markers
expect(content).toContain(`export class ${childClass}`);
expect(content).toMatch(/\bid!:/); // id required
expectDecoratorAboveProperty(content, /@Property\.number\(\)/, 'id');
expect(content).toContain('\'id\'!:');
expectDecoratorAboveProperty(content, /@Property\.number\(\)/, /'id'!:/);

// name required -> string decorator
expect(content).toMatch(/\bname!:/);
expectDecoratorAboveProperty(content, /@Property\.string\(\)/, 'name');
expect(content).toContain('\'name\'!:');
expectDecoratorAboveProperty(content, /@Property\.string\(\)/, /'name'!:/);

// status enum optional -> union literal present and decorator above property (optional)
expect(content).toMatch(/'available'\s*\|\s*'pending'\s*\|\s*'sold'/);
expect(content).toMatch(/\bstatus\?:/);
expectDecoratorAboveProperty(content, /@Property\.string\({\s*required:\s*false\s*}\)/, 'status');
expect(content).toContain('\'status\'?:');
expectDecoratorAboveProperty(content, /@Property\.string\({\s*required:\s*false\s*}\)/, /'status'\?:/);

// index export present (kebab-case)
const kebabPrefix: string = toKebabCase(provider.prefix);
Expand Down