Skip to content

The open alternative to Salesforce, designed for AI.

feat(object-metadata): allow updating readability through the metadata API (#26427)

martmullceb7854e2609
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
index e97b0d15ff0..1c438bfcb49 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
@@ -4797,6 +4797,7 @@ input UpdateObjectPayload {
isLabelSyncedWithName: Boolean
isSearchable: Boolean
openRecordIn: ObjectOpenRecordIn
+ readability: MetadataReadability
translations: [MetadataTranslationOverrideInput!]
}
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.ts b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
index ff839dcabbb..feca18b3563 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
@@ -7688,7 +7688,7 @@ export interface UpdateOneObjectInput {update: UpdateObjectPayload,
/** The id of the object to update */
id: Scalars['UUID']}
-export interface UpdateObjectPayload {labelSingular?: (Scalars['String'] | null),labelPlural?: (Scalars['String'] | null),nameSingular?: (Scalars['String'] | null),namePlural?: (Scalars['String'] | null),description?: (Scalars['String'] | null),icon?: (Scalars['String'] | null),shortcut?: (Scalars['String'] | null),color?: (Scalars['String'] | null),isActive?: (Scalars['Boolean'] | null),labelIdentifierFieldMetadataId?: (Scalars['UUID'] | null),imageIdentifierFieldMetadataId?: (Scalars['UUID'] | null),isLabelSyncedWithName?: (Scalars['Boolean'] | null),isSearchable?: (Scalars['Boolean'] | null),openRecordIn?: (ObjectOpenRecordIn | null),translations?: (MetadataTranslationOverrideInput[] | null)}
+export interface UpdateObjectPayload {labelSingular?: (Scalars['String'] | null),labelPlural?: (Scalars['String'] | null),nameSingular?: (Scalars['String'] | null),namePlural?: (Scalars['String'] | null),description?: (Scalars['String'] | null),icon?: (Scalars['String'] | null),shortcut?: (Scalars['String'] | null),color?: (Scalars['String'] | null),isActive?: (Scalars['Boolean'] | null),labelIdentifierFieldMetadataId?: (Scalars['UUID'] | null),imageIdentifierFieldMetadataId?: (Scalars['UUID'] | null),isLabelSyncedWithName?: (Scalars['Boolean'] | null),isSearchable?: (Scalars['Boolean'] | null),openRecordIn?: (ObjectOpenRecordIn | null),readability?: (MetadataReadability | null),translations?: (MetadataTranslationOverrideInput[] | null)}
export interface MetadataTranslationOverrideInput {locale: Scalars['String'],property: Scalars['String'],value?: (Scalars['String'] | null)}
diff --git a/packages/twenty-client-sdk/src/metadata/generated/types.ts b/packages/twenty-client-sdk/src/metadata/generated/types.ts
index af4238c4d27..f9c329e96b3 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/types.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/types.ts
@@ -12282,6 +12282,9 @@ export default {
"openRecordIn": [
24
],
+ "readability": [
+ 25
+ ],
"translations": [
490
],
diff --git a/packages/twenty-front/src/generated-metadata/graphql.ts b/packages/twenty-front/src/generated-metadata/graphql.ts
index 6a3b0dcc329..dd8522fe06b 100644
--- a/packages/twenty-front/src/generated-metadata/graphql.ts
+++ b/packages/twenty-front/src/generated-metadata/graphql.ts
@@ -6500,6 +6500,7 @@ export type UpdateObjectPayload = {
namePlural?: InputMaybe<Scalars['String']['input']>;
nameSingular?: InputMaybe<Scalars['String']['input']>;
openRecordIn?: InputMaybe<ObjectOpenRecordIn>;
+ readability?: InputMaybe<MetadataReadability>;
shortcut?: InputMaybe<Scalars['String']['input']>;
translations?: InputMaybe<Array<MetadataTranslationOverrideInput>>;
};
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-object-metadata/constants/flat-object-metadata-editable-properties.constant.ts b/packages/twenty-server/src/engine/metadata-modules/flat-object-metadata/constants/flat-object-metadata-editable-properties.constant.ts
index c876f87a198..9577f6e8c29 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-object-metadata/constants/flat-object-metadata-editable-properties.constant.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-object-metadata/constants/flat-object-metadata-editable-properties.constant.ts
@@ -15,6 +15,7 @@ export const FLAT_OBJECT_METADATA_EDITABLE_PROPERTIES = {
'nameSingular',
'labelIdentifierFieldMetadataId',
'imageIdentifierFieldMetadataId',
+ 'readability',
],
standard: [
'color',
diff --git a/packages/twenty-server/src/engine/metadata-modules/object-metadata/constants/updatable-object-readabilities.constant.ts b/packages/twenty-server/src/engine/metadata-modules/object-metadata/constants/updatable-object-readabilities.constant.ts
new file mode 100644
index 00000000000..0bb0052ddcf
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/object-metadata/constants/updatable-object-readabilities.constant.ts
@@ -0,0 +1,8 @@
+import { MetadataReadability } from 'twenty-shared/types';
+
+// SYSTEM and APPLICATION lock records away from workspace users, and INHERITED
+// needs parent fields this API cannot set yet, so those stay manifest-only
+export const UPDATABLE_OBJECT_READABILITIES = [
+ MetadataReadability.OPEN,
+ MetadataReadability.PRIVATE,
+] as const;
diff --git a/packages/twenty-server/src/engine/metadata-modules/object-metadata/dtos/update-object.input.ts b/packages/twenty-server/src/engine/metadata-modules/object-metadata/dtos/update-object.input.ts
index 07a3d3b515b..bcf2adef9d8 100644
--- a/packages/twenty-server/src/engine/metadata-modules/object-metadata/dtos/update-object.input.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/object-metadata/dtos/update-object.input.ts
@@ -1,19 +1,22 @@
import { Field, InputType } from '@nestjs/graphql';
import { Type } from 'class-transformer';
-import { ObjectOpenRecordIn } from 'twenty-shared/types';
+import { MetadataReadability, ObjectOpenRecordIn } from 'twenty-shared/types';
import {
IsBoolean,
IsEnum,
+ IsIn,
IsNotEmpty,
IsOptional,
IsString,
IsUUID,
+ ValidateIf,
ValidateNested,
} from 'class-validator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
import { IsValidMetadataName } from 'src/engine/decorators/metadata/is-valid-metadata-name.decorator';
+import { UPDATABLE_OBJECT_READABILITIES } from 'src/engine/metadata-modules/object-metadata/constants/updatable-object-readabilities.constant';
import { MetadataTranslationOverrideInput } from 'src/engine/metadata-modules/metadata-translation/dtos/metadata-translation-override.input';
@InputType()
@@ -90,6 +93,11 @@ export class UpdateObjectPayload {
@Field(() => ObjectOpenRecordIn, { nullable: true })
openRecordIn?: ObjectOpenRecordIn;
+ @IsIn(UPDATABLE_OBJECT_READABILITIES)
+ @ValidateIf((_, value) => value !== undefined)
+ @Field(() => MetadataReadability, { nullable: true })
+ readability?: MetadataReadability;
+
@Type(() => MetadataTranslationOverrideInput)
@ValidateNested({ each: true })
@IsOptional()
diff --git a/packages/twenty-server/test/integration/metadata/suites/object-metadata/update-one-object-metadata-readability.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/object-metadata/update-one-object-metadata-readability.integration-spec.ts
new file mode 100644
index 00000000000..078d67c9806
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/object-metadata/update-one-object-metadata-readability.integration-spec.ts
@@ -0,0 +1,149 @@
+import { createOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/create-one-object-metadata.util';
+import { deleteOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/delete-one-object-metadata.util';
+import { findManyObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/find-many-object-metadata.util';
+import { updateOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/update-one-object-metadata.util';
+import { jestExpectToBeDefined } from 'test/utils/jest-expect-to-be-defined.util.test';
+import { MetadataReadability } from 'twenty-shared/types';
+
+describe('Object metadata readability update', () => {
+ let customObjectMetadataId: string;
+
+ beforeAll(async () => {
+ const { data } = await createOneObjectMetadata({
+ expectToFail: false,
+ input: {
+ labelPlural: 'Readability Tests',
+ labelSingular: 'Readability Test',
+ namePlural: 'readabilityTests',
+ nameSingular: 'readabilityTest',
+ },
+ });
+
+ customObjectMetadataId = data.createOneObject.id;
+ });
+
+ afterAll(async () => {
+ await updateOneObjectMetadata({
+ expectToFail: false,
+ input: {
+ idToUpdate: customObjectMetadataId,
+ updatePayload: { isActive: false },
+ },
+ });
+ await deleteOneObjectMetadata({
+ input: { idToDelete: customObjectMetadataId },
+ });
+ });
+
+ it('should update the readability of a custom object', async () => {
+ const { data: privateData } = await updateOneObjectMetadata({
+ expectToFail: false,
+ input: {
+ idToUpdate: customObjectMetadataId,
+ updatePayload: { readability: MetadataReadability.PRIVATE },
+ },
+ gqlFields: `
+ id
+ readability
+ `,
+ });
+
+ expect(privateData.updateOneObject.readability).toBe(
+ MetadataReadability.PRIVATE,
+ );
+
+ const { data: openData } = await updateOneObjectMetadata({
+ expectToFail: false,
+ input: {
+ idToUpdate: customObjectMetadataId,
+ updatePayload: { readability: MetadataReadability.OPEN },
+ },
+ gqlFields: `
+ id
+ readability
+ `,
+ });
+
+ expect(openData.updateOneObject.readability).toBe(MetadataReadability.OPEN);
+ });
+
+ it.each([
+ MetadataReadability.SYSTEM,
+ MetadataReadability.APPLICATION,
+ MetadataReadability.INHERITED,
+ ])(
+ 'should reject setting readability to %s',
+ async (readability) => {
+ const { errors } = await updateOneObjectMetadata({
+ expectToFail: true,
+ input: {
+ idToUpdate: customObjectMetadataId,
+ updatePayload: { readability },
+ },
+ });
+
+ expect(errors?.[0]?.message).toContain(
+ 'readability must be one of the following values',
+ );
+ },
+ );
+
+ it('should reject an unknown readability value', async () => {
+ const { errors } = await updateOneObjectMetadata({
+ expectToFail: true,
+ input: {
+ idToUpdate: customObjectMetadataId,
+ updatePayload: {
+ readability: 'NOT_A_READABILITY' as MetadataReadability,
+ },
+ },
+ });
+
+ expect(errors).toBeDefined();
+ });
+
+ it('should reject a null readability', async () => {
+ const { errors } = await updateOneObjectMetadata({
+ expectToFail: true,
+ input: {
+ idToUpdate: customObjectMetadataId,
+ updatePayload: {
+ readability: null as unknown as MetadataReadability,
+ },
+ },
+ });
+
+ expect(errors?.[0]?.message).toContain(
+ 'readability must be one of the following values',
+ );
+ });
+
+ it('should reject a readability update on a standard object', async () => {
+ const { objects } = await findManyObjectMetadata({
+ expectToFail: false,
+ input: { filter: {}, paging: { first: 100 } },
+ gqlFields: `
+ id
+ nameSingular
+ `,
+ });
+
+ const companyObject = objects.find(
+ (object) => object.nameSingular === 'company',
+ );
+
+ jestExpectToBeDefined(companyObject);
+
+ const { errors } = await updateOneObjectMetadata({
+ expectToFail: true,
+ input: {
+ idToUpdate: companyObject.id,
+ updatePayload: { readability: MetadataReadability.PRIVATE },
+ },
+ });
+
+ expect(errors?.[0]?.message).toContain(
+ 'Cannot edit standard object metadata properties: readability',
+ );
+ });
+});