From 534a2bf647c0ab641497d4b50afcef2a361903ff Mon Sep 17 00:00:00 2001 From: martmull Date: Wed, 12 Nov 2025 10:42:55 +0100 Subject: [PATCH] Rename sdk utils (#15766) As title --- .../activity-summary/package.json | 2 +- .../ai-meeting-transcript/package.json | 2 +- .../hacktoberfest-2025/fireflies/package.json | 2 +- .../last-email-interaction/package.json | 2 +- .../application/package.json | 2 +- .../mailchimp-synchronizer/package.json | 2 +- .../meeting-transcript/package.json | 2 +- .../rollup-engine/package.json | 2 +- .../stripe-synchronizer/package.json | 2 +- .../hacktoberfest-2025/webmetic/package.json | 2 +- packages/twenty-apps/hello-world/package.json | 2 +- .../hello-world/src/objects/postCard.ts | 40 +++++++++---------- .../base-application-project/package.json | 2 +- .../field-metadata/composite-fields.ts | 24 ++++------- .../field-metadata/field-metadata-type.ts | 1 - .../application/field-metadata/field-type.ts | 1 + ...tadata.decorator.ts => field.decorator.ts} | 2 +- packages/twenty-sdk/src/application/index.ts | 30 +++++--------- ...base-object-metadata.ts => base-object.ts} | 2 +- 19 files changed, 54 insertions(+), 70 deletions(-) delete mode 100644 packages/twenty-sdk/src/application/field-metadata/field-metadata-type.ts create mode 100644 packages/twenty-sdk/src/application/field-metadata/field-type.ts rename packages/twenty-sdk/src/application/field-metadata/{field-metadata.decorator.ts => field.decorator.ts} (92%) rename packages/twenty-sdk/src/application/object-metadata/{base-object-metadata.ts => base-object.ts} (86%) diff --git a/packages/twenty-apps/hacktoberfest-2025/activity-summary/package.json b/packages/twenty-apps/hacktoberfest-2025/activity-summary/package.json index 3cf2b6cdd3..732afd7af0 100644 --- a/packages/twenty-apps/hacktoberfest-2025/activity-summary/package.json +++ b/packages/twenty-apps/hacktoberfest-2025/activity-summary/package.json @@ -9,7 +9,7 @@ }, "packageManager": "yarn@4.9.2", "dependencies": { - "twenty-sdk": "^0.0.3" + "twenty-sdk": "0.0.3" }, "devDependencies": { "@types/node": "^24.7.2" diff --git a/packages/twenty-apps/hacktoberfest-2025/ai-meeting-transcript/package.json b/packages/twenty-apps/hacktoberfest-2025/ai-meeting-transcript/package.json index a38ccd66e1..a50b565ad9 100644 --- a/packages/twenty-apps/hacktoberfest-2025/ai-meeting-transcript/package.json +++ b/packages/twenty-apps/hacktoberfest-2025/ai-meeting-transcript/package.json @@ -11,7 +11,7 @@ "dependencies": { "axios": "^1.12.2", "openai": "^4.28.0", - "twenty-sdk": "^0.0.3" + "twenty-sdk": "0.0.3" }, "devDependencies": { "@types/node": "^24.7.2" diff --git a/packages/twenty-apps/hacktoberfest-2025/fireflies/package.json b/packages/twenty-apps/hacktoberfest-2025/fireflies/package.json index 72a8f79a0b..f17f487b0a 100644 --- a/packages/twenty-apps/hacktoberfest-2025/fireflies/package.json +++ b/packages/twenty-apps/hacktoberfest-2025/fireflies/package.json @@ -16,7 +16,7 @@ "dependencies": { "axios": "^1.13.1", "dotenv": "^16.3.1", - "twenty-sdk": "^0.0.3" + "twenty-sdk": "0.0.3" }, "devDependencies": { "@types/jest": "^29.5.5", diff --git a/packages/twenty-apps/hacktoberfest-2025/last-email-interaction/package.json b/packages/twenty-apps/hacktoberfest-2025/last-email-interaction/package.json index d61e24601f..cabc642f44 100644 --- a/packages/twenty-apps/hacktoberfest-2025/last-email-interaction/package.json +++ b/packages/twenty-apps/hacktoberfest-2025/last-email-interaction/package.json @@ -10,7 +10,7 @@ "packageManager": "yarn@4.9.2", "dependencies": { "axios": "^1.12.2", - "twenty-sdk": "^0.0.4" + "twenty-sdk": "0.0.4" }, "devDependencies": { "@types/node": "^24.7.2" diff --git a/packages/twenty-apps/hacktoberfest-2025/linkedin-browser-extension/application/package.json b/packages/twenty-apps/hacktoberfest-2025/linkedin-browser-extension/application/package.json index eda607c771..12748fbd3a 100644 --- a/packages/twenty-apps/hacktoberfest-2025/linkedin-browser-extension/application/package.json +++ b/packages/twenty-apps/hacktoberfest-2025/linkedin-browser-extension/application/package.json @@ -9,7 +9,7 @@ }, "packageManager": "yarn@4.9.2", "dependencies": { - "twenty-sdk": "^0.0.3" + "twenty-sdk": "0.0.3" }, "devDependencies": { "@types/node": "^24.7.2" diff --git a/packages/twenty-apps/hacktoberfest-2025/mailchimp-synchronizer/package.json b/packages/twenty-apps/hacktoberfest-2025/mailchimp-synchronizer/package.json index 654f8a3e3c..cc32cc6054 100644 --- a/packages/twenty-apps/hacktoberfest-2025/mailchimp-synchronizer/package.json +++ b/packages/twenty-apps/hacktoberfest-2025/mailchimp-synchronizer/package.json @@ -10,7 +10,7 @@ "packageManager": "yarn@4.9.2", "dependencies": { "axios": "^1.13.2", - "twenty-sdk": "^0.0.4" + "twenty-sdk": "0.0.4" }, "devDependencies": { "@types/node": "^24.7.2" diff --git a/packages/twenty-apps/hacktoberfest-2025/meeting-transcript/package.json b/packages/twenty-apps/hacktoberfest-2025/meeting-transcript/package.json index 9462915bd4..c02c388c7f 100644 --- a/packages/twenty-apps/hacktoberfest-2025/meeting-transcript/package.json +++ b/packages/twenty-apps/hacktoberfest-2025/meeting-transcript/package.json @@ -16,7 +16,7 @@ "dependencies": { "axios": "^1.7.0", "openai": "^4.67.0", - "twenty-sdk": "^0.0.3" + "twenty-sdk": "0.0.3" }, "devDependencies": { "@types/node": "^24.7.2", diff --git a/packages/twenty-apps/hacktoberfest-2025/rollup-engine/package.json b/packages/twenty-apps/hacktoberfest-2025/rollup-engine/package.json index 2945b14c6a..67672cfd68 100644 --- a/packages/twenty-apps/hacktoberfest-2025/rollup-engine/package.json +++ b/packages/twenty-apps/hacktoberfest-2025/rollup-engine/package.json @@ -13,7 +13,7 @@ "setup:metadata": "node scripts/setup-company-rollup-fields.mjs" }, "dependencies": { - "twenty-sdk": "^0.0.3" + "twenty-sdk": "0.0.3" }, "devDependencies": { "@types/node": "^24.7.2", diff --git a/packages/twenty-apps/hacktoberfest-2025/stripe-synchronizer/package.json b/packages/twenty-apps/hacktoberfest-2025/stripe-synchronizer/package.json index daaf361ee7..58ed8f0d89 100644 --- a/packages/twenty-apps/hacktoberfest-2025/stripe-synchronizer/package.json +++ b/packages/twenty-apps/hacktoberfest-2025/stripe-synchronizer/package.json @@ -10,7 +10,7 @@ "packageManager": "yarn@4.9.2", "dependencies": { "axios": "^1.13.2", - "twenty-sdk": "^0.0.4" + "twenty-sdk": "0.0.4" }, "devDependencies": { "@types/node": "^24.7.2" diff --git a/packages/twenty-apps/hacktoberfest-2025/webmetic/package.json b/packages/twenty-apps/hacktoberfest-2025/webmetic/package.json index d7e70d1265..64c2fc5d40 100644 --- a/packages/twenty-apps/hacktoberfest-2025/webmetic/package.json +++ b/packages/twenty-apps/hacktoberfest-2025/webmetic/package.json @@ -10,7 +10,7 @@ "packageManager": "yarn@4.9.2", "dependencies": { "axios": "^1.12.2", - "twenty-sdk": "^0.0.3" + "twenty-sdk": "0.0.3" }, "devDependencies": { "@types/node": "^24.7.2" diff --git a/packages/twenty-apps/hello-world/package.json b/packages/twenty-apps/hello-world/package.json index 76bbcd7164..1954a9fcab 100644 --- a/packages/twenty-apps/hello-world/package.json +++ b/packages/twenty-apps/hello-world/package.json @@ -10,7 +10,7 @@ "packageManager": "yarn@4.9.2", "dependencies": { "axios": "^1.12.2", - "twenty-sdk": "^0.0.5" + "twenty-sdk": "0.0.5" }, "devDependencies": { "@types/node": "^24.7.2" diff --git a/packages/twenty-apps/hello-world/src/objects/postCard.ts b/packages/twenty-apps/hello-world/src/objects/postCard.ts index b3f2789a29..c915c9aaa5 100644 --- a/packages/twenty-apps/hello-world/src/objects/postCard.ts +++ b/packages/twenty-apps/hello-world/src/objects/postCard.ts @@ -1,10 +1,10 @@ import { - BaseObjectMetadata, - FieldMetadata, - ObjectMetadata, - FieldMetadataType, - type FullNameMetadata, - type AddressMetadata, + BaseObject, + Field, + ObjectMetadata as Object, + FieldType, + type FullNameField, + type AddressField, } from 'twenty-sdk/application'; enum PostCardStatus { @@ -14,7 +14,7 @@ enum PostCardStatus { RETURNED = 'RETURNED', } -@ObjectMetadata({ +@Object({ universalIdentifier: '54b589ca-eeed-4950-a176-358418b85c05', nameSingular: 'postCard', namePlural: 'postCards', @@ -23,35 +23,35 @@ enum PostCardStatus { description: ' A post card object', icon: 'IconMail', }) -export class PostCard extends BaseObjectMetadata { - @FieldMetadata({ +export class PostCard extends BaseObject { + @Field({ universalIdentifier: '58a0a314-d7ea-4865-9850-7fb84e72f30b', - type: FieldMetadataType.TEXT, + type: FieldType.TEXT, label: 'Content', description: "Postcard's content", icon: 'IconAbc', }) content: string; - @FieldMetadata({ + @Field({ universalIdentifier: 'c6aa31f3-da76-4ac6-889f-475e226009ac', - type: FieldMetadataType.FULL_NAME, + type: FieldType.FULL_NAME, label: 'Recipient name', icon: 'IconUser', }) - recipientName: FullNameMetadata; + recipientName: FullNameField; - @FieldMetadata({ + @Field({ universalIdentifier: '95045777-a0ad-49ec-98f9-22f9fc0c8266', - type: FieldMetadataType.ADDRESS, + type: FieldType.ADDRESS, label: 'Recipient address', icon: 'IconHome', }) - recipientAddress: AddressMetadata; + recipientAddress: AddressField; - @FieldMetadata({ + @Field({ universalIdentifier: '87b675b8-dd8c-4448-b4ca-20e5a2234a1e', - type: FieldMetadataType.SELECT, + type: FieldType.SELECT, label: 'Status', icon: 'IconSend', defaultValue: `'${PostCardStatus.DRAFT}'`, @@ -86,9 +86,9 @@ export class PostCard extends BaseObjectMetadata { // notes?: string // optional internal notes or comments - @FieldMetadata({ + @Field({ universalIdentifier: 'e06abe72-5b44-4e7f-93be-afc185a3c433', - type: FieldMetadataType.DATE_TIME, + type: FieldType.DATE_TIME, label: 'Delivered at', icon: 'IconCheck', isNullable: true, diff --git a/packages/twenty-cli/src/constants/base-application-project/package.json b/packages/twenty-cli/src/constants/base-application-project/package.json index f74b0c4003..f38c1835af 100644 --- a/packages/twenty-cli/src/constants/base-application-project/package.json +++ b/packages/twenty-cli/src/constants/base-application-project/package.json @@ -9,7 +9,7 @@ }, "packageManager": "yarn@4.9.2", "dependencies": { - "twenty-sdk": "^0.0.3" + "twenty-sdk": "0.0.5" }, "devDependencies": { "@types/node": "^24.7.2" diff --git a/packages/twenty-sdk/src/application/field-metadata/composite-fields.ts b/packages/twenty-sdk/src/application/field-metadata/composite-fields.ts index 2db9cce0c0..24ba452317 100644 --- a/packages/twenty-sdk/src/application/field-metadata/composite-fields.ts +++ b/packages/twenty-sdk/src/application/field-metadata/composite-fields.ts @@ -1,18 +1,10 @@ export { - actorCompositeType, - ActorMetadata, - addressCompositeType, - AddressMetadata, - currencyCompositeType, - CurrencyMetadata, - emailsCompositeType, - EmailsMetadata, - fullNameCompositeType, - FullNameMetadata, - linksCompositeType, - LinksMetadata, - phonesCompositeType, - PhonesMetadata, - richTextV2CompositeType, - RichTextV2Metadata, + ActorMetadata as ActorField, + AddressMetadata as AddressField, + CurrencyMetadata as CurrencyField, + EmailsMetadata as EmailsField, + FullNameMetadata as FullNameField, + LinksMetadata as LinksField, + PhonesMetadata as PhonesField, + RichTextV2Metadata as RichTextField, } from 'twenty-shared/types'; diff --git a/packages/twenty-sdk/src/application/field-metadata/field-metadata-type.ts b/packages/twenty-sdk/src/application/field-metadata/field-metadata-type.ts deleted file mode 100644 index f465b97d66..0000000000 --- a/packages/twenty-sdk/src/application/field-metadata/field-metadata-type.ts +++ /dev/null @@ -1 +0,0 @@ -export { FieldMetadataType } from 'twenty-shared/types'; diff --git a/packages/twenty-sdk/src/application/field-metadata/field-type.ts b/packages/twenty-sdk/src/application/field-metadata/field-type.ts new file mode 100644 index 0000000000..f415595e0a --- /dev/null +++ b/packages/twenty-sdk/src/application/field-metadata/field-type.ts @@ -0,0 +1 @@ +export { FieldMetadataType as FieldType } from 'twenty-shared/types'; diff --git a/packages/twenty-sdk/src/application/field-metadata/field-metadata.decorator.ts b/packages/twenty-sdk/src/application/field-metadata/field.decorator.ts similarity index 92% rename from packages/twenty-sdk/src/application/field-metadata/field-metadata.decorator.ts rename to packages/twenty-sdk/src/application/field-metadata/field.decorator.ts index d796d81484..324f2ef06e 100644 --- a/packages/twenty-sdk/src/application/field-metadata/field-metadata.decorator.ts +++ b/packages/twenty-sdk/src/application/field-metadata/field.decorator.ts @@ -24,7 +24,7 @@ type FieldOptions< isNullable?: boolean; }; -export const FieldMetadata = ( +export const Field = ( _: FieldOptions, ): PropertyDecorator => { return () => {}; diff --git a/packages/twenty-sdk/src/application/index.ts b/packages/twenty-sdk/src/application/index.ts index da1791fb9c..765663d97a 100644 --- a/packages/twenty-sdk/src/application/index.ts +++ b/packages/twenty-sdk/src/application/index.ts @@ -9,26 +9,18 @@ export type { ApplicationConfig } from './application-config'; export { - actorCompositeType, - ActorMetadata, - addressCompositeType, - AddressMetadata, - currencyCompositeType, - CurrencyMetadata, - emailsCompositeType, - EmailsMetadata, - fullNameCompositeType, - FullNameMetadata, - linksCompositeType, - LinksMetadata, - phonesCompositeType, - PhonesMetadata, - richTextV2CompositeType, - RichTextV2Metadata, + ActorField, + AddressField, + CurrencyField, + EmailsField, + FullNameField, + LinksField, + PhonesField, + RichTextField, } from './field-metadata/composite-fields'; -export { FieldMetadataType } from './field-metadata/field-metadata-type'; -export { FieldMetadata } from './field-metadata/field-metadata.decorator'; -export { BaseObjectMetadata } from './object-metadata/base-object-metadata'; +export { FieldType } from './field-metadata/field-type'; +export { Field } from './field-metadata/field.decorator'; +export { BaseObject } from './object-metadata/base-object'; export { ObjectMetadata } from './object-metadata/object-metadata.decorator'; export type { ServerlessFunctionConfig } from './serverless-function-config'; export type { SyncableEntityOptions } from './syncable-entity-options.type'; diff --git a/packages/twenty-sdk/src/application/object-metadata/base-object-metadata.ts b/packages/twenty-sdk/src/application/object-metadata/base-object.ts similarity index 86% rename from packages/twenty-sdk/src/application/object-metadata/base-object-metadata.ts rename to packages/twenty-sdk/src/application/object-metadata/base-object.ts index b01794a4b8..872ccaed92 100644 --- a/packages/twenty-sdk/src/application/object-metadata/base-object-metadata.ts +++ b/packages/twenty-sdk/src/application/object-metadata/base-object.ts @@ -1,4 +1,4 @@ -export abstract class BaseObjectMetadata { +export abstract class BaseObject { id: string; name: string;