martmull
40eef5c464
# Summary
- Introduces a new, flexible folder structure for Twenty SDK
applications using file suffix-based entity detection
- Adds defineApp, defineFunction, defineObject, and defineRole helper
functions with built-in validation
- Refactors manifest loading to use jiti runtime evaluation for
TypeScript config files
- Separates validation logic into dedicated module with comprehensive
error reporting
# New Application Folder Structure
Applications now use a convention-over-configuration approach where
entities are detected by their file suffix, allowing flexible
organization within the src/app/ folder.
# Required Structure
my-app/
├── package.json
├── yarn.lock
└── src/
├── app/
│ └── application.config.ts # Required - main application configuration
└── utils/ # Optional - handler implementations & utilities
# Entity Detection by File Suffix
- *.object.ts - Custom object definitions
- *.function.ts - Serverless function definitions
- *.role.ts - Role definitions
# Supported Folder Organizations
## Traditional (by type):
src/app/
├── application.config.ts
├── objects/
│ └── postCard.object.ts
├── functions/
│ └── createPostCard.function.ts
└── roles/
└── admin.role.ts
## Feature-based:
src/app/
├── application.config.ts
└── post-card/
├── postCard.object.ts
├── createPostCard.function.ts
└── postCardAdmin.role.ts
## Flat:
src/app/
├── application.config.ts
├── postCard.object.ts
├── createPostCard.function.ts
└── admin.role.ts
# New Helper Functions
## defineApp(config)
import { defineApp } from 'twenty-sdk';
export default defineApp({
universalIdentifier: '4ec0391d-...',
displayName: 'My App',
description: 'App description',
icon: 'IconWorld',
});
## defineObject(config)
import { defineObject, FieldType } from 'twenty-sdk';
export default defineObject({
universalIdentifier: '54b589ca-...',
nameSingular: 'postCard',
namePlural: 'postCards',
labelSingular: 'Post Card',
labelPlural: 'Post Cards',
icon: 'IconMail',
fields: [
{
universalIdentifier: '58a0a314-...',
type: FieldType.TEXT,
name: 'content',
label: 'Content',
},
],
});
## defineFunction(config)
import { defineFunction } from 'twenty-sdk';
import { myHandler } from '../utils/my-handler';
export default defineFunction({
universalIdentifier: 'e56d363b-...',
name: 'My Function',
handler: myHandler,
triggers: [
{
universalIdentifier: 'c9f84c8d-...',
type: 'route',
path: '/my-route',
httpMethod: 'POST',
},
],
});
## defineRole(config)
import { defineRole, PermissionFlag } from 'twenty-sdk';
export default defineRole({
universalIdentifier: 'b648f87b-...',
label: 'App User',
objectPermissions: [
{
objectNameSingular: 'postCard',
canReadObjectRecords: true,
},
],
permissionFlags: [PermissionFlag.UPLOAD_FILE],
});
# Test plan
- Verify npx twenty app sync works with new folder structure
- Verify npx twenty app dev works with new folder structure
- Verify validation errors display correctly for invalid configs
- Verify all three folder organization styles work (traditional,
feature-based, flat)
- Run existing E2E tests to ensure backward compatibility
65 lines
2.0 KiB
TypeScript
65 lines
2.0 KiB
TypeScript
import { getNewObjectFileContent } from '@/cli/utils/get-new-object-file-content';
|
|
|
|
describe('getNewObjectFileContent', () => {
|
|
it('should return proper object file using defineObject', () => {
|
|
const result = getNewObjectFileContent({
|
|
data: {
|
|
nameSingular: 'company',
|
|
namePlural: 'companies',
|
|
labelSingular: 'Company',
|
|
labelPlural: 'Companies',
|
|
},
|
|
name: 'company',
|
|
});
|
|
|
|
// Verify it uses defineObject
|
|
expect(result).toContain("import { defineObject } from 'twenty-sdk'");
|
|
expect(result).toContain('export default defineObject({');
|
|
|
|
// Verify object properties
|
|
expect(result).toContain("nameSingular: 'company'");
|
|
expect(result).toContain("namePlural: 'companies'");
|
|
expect(result).toContain("labelSingular: 'Company'");
|
|
expect(result).toContain("labelPlural: 'Companies'");
|
|
expect(result).toContain("icon: 'IconBox'");
|
|
expect(result).toContain('fields: [');
|
|
|
|
// Verify it has a universalIdentifier (UUID format)
|
|
expect(result).toMatch(
|
|
/universalIdentifier: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'/,
|
|
);
|
|
});
|
|
|
|
it('should generate unique UUIDs for each object', () => {
|
|
const result1 = getNewObjectFileContent({
|
|
data: {
|
|
nameSingular: 'company',
|
|
namePlural: 'companies',
|
|
labelSingular: 'Company',
|
|
labelPlural: 'Companies',
|
|
},
|
|
name: 'company',
|
|
});
|
|
|
|
const result2 = getNewObjectFileContent({
|
|
data: {
|
|
nameSingular: 'person',
|
|
namePlural: 'people',
|
|
labelSingular: 'Person',
|
|
labelPlural: 'People',
|
|
},
|
|
name: 'person',
|
|
});
|
|
|
|
// Extract UUIDs
|
|
const uuidRegex =
|
|
/universalIdentifier: '([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})'/;
|
|
const uuid1 = result1.match(uuidRegex)?.[1];
|
|
const uuid2 = result2.match(uuidRegex)?.[1];
|
|
|
|
expect(uuid1).toBeDefined();
|
|
expect(uuid2).toBeDefined();
|
|
expect(uuid1).not.toBe(uuid2);
|
|
});
|
|
});
|