feat: Add projects to credentials list response (#25384)

BGZStephen · web-flow · commit fb3fe5fb3518 · 2026-02-06T11:43:29.000Z
diff --git a/packages/cli/src/public-api/v1/handlers/credentials/__tests__/credentials.service.test.ts b/packages/cli/src/public-api/v1/handlers/credentials/__tests__/credentials.service.test.ts
@@ -9,13 +9,79 @@ import type { GenericValue, IDataObject, INodeProperties } from 'n8n-workflow';
 import { CredentialsService } from '@/credentials/credentials.service';
 import type { IDependency } from '@/public-api/types';
 
-import { toJsonSchema, updateCredential } from '../credentials.service';
+import { buildSharedForCredential, toJsonSchema, updateCredential } from '../credentials.service';
 
 // Set up real Cipher with mocked InstanceSettings for encryption
 const cipher = new Cipher(mock<InstanceSettings>({ encryptionKey: 'test-encryption-key' }));
 Container.set(Cipher, cipher);
 
 describe('CredentialsService', () => {
+	describe('buildSharedForCredential', () => {
+		it('returns one shared entry when credential is shared with one project', () => {
+			const createdAt = new Date('2024-01-01T00:00:00.000Z');
+			const updatedAt = new Date('2024-01-02T00:00:00.000Z');
+			const credential = {
+				shared: [
+					{
+						role: 'credential:owner',
+						createdAt,
+						updatedAt,
+						project: { id: 'proj-1', name: 'My Project' },
+					},
+				],
+			} as unknown as CredentialsEntity;
+			expect(buildSharedForCredential(credential)).toEqual([
+				{
+					id: 'proj-1',
+					name: 'My Project',
+					role: 'credential:owner',
+					createdAt,
+					updatedAt,
+				},
+			]);
+		});
+
+		it('returns multiple shared entries and skips shared entries without project', () => {
+			const createdAt1 = new Date('2024-01-01T00:00:00.000Z');
+			const updatedAt1 = new Date('2024-01-02T00:00:00.000Z');
+			const createdAt2 = new Date('2024-02-01T00:00:00.000Z');
+			const updatedAt2 = new Date('2024-02-02T00:00:00.000Z');
+			const credential = {
+				shared: [
+					{
+						role: 'credential:owner',
+						createdAt: createdAt1,
+						updatedAt: updatedAt1,
+						project: { id: 'proj-1', name: 'Project One' },
+					},
+					{ role: 'credential:user', createdAt: createdAt2, updatedAt: updatedAt2, project: null },
+					{
+						role: 'credential:user',
+						createdAt: createdAt2,
+						updatedAt: updatedAt2,
+						project: { id: 'proj-2', name: 'Project Two' },
+					},
+				],
+			} as unknown as CredentialsEntity;
+			expect(buildSharedForCredential(credential)).toEqual([
+				{
+					id: 'proj-1',
+					name: 'Project One',
+					role: 'credential:owner',
+					createdAt: createdAt1,
+					updatedAt: updatedAt1,
+				},
+				{
+					id: 'proj-2',
+					name: 'Project Two',
+					role: 'credential:user',
+					createdAt: createdAt2,
+					updatedAt: updatedAt2,
+				},
+			]);
+		});
+	});
+
 	describe('toJsonSchema', () => {
 		it('should create separate conditionals for different values of the same dependant field', () => {
 			// This test simulates the JWT auth credential scenario where
diff --git a/packages/cli/src/public-api/v1/handlers/credentials/credentials.handler.ts b/packages/cli/src/public-api/v1/handlers/credentials/credentials.handler.ts
@@ -18,6 +18,7 @@ import {
 	validCredentialsPropertiesForUpdate,
 } from './credentials.middleware';
 import {
+	buildSharedForCredential,
 	CredentialsIsNotUpdatableError,
 	getCredentials,
 	getSharedCredentials,
@@ -45,17 +46,41 @@ export = {
 			req: CredentialRequest.GetAll,
 			res: express.Response,
 		): Promise<
-			express.Response<{ data: Partial<CredentialsEntity>[]; nextCursor: string | null }>
+			express.Response<{
+				data: Array<{
+					id: string;
+					name: string;
+					type: string;
+					createdAt: Date;
+					updatedAt: Date;
+					shared: ReturnType<typeof buildSharedForCredential>;
+				}>;
+				nextCursor: string | null;
+			}>
 		> => {
 			const offset = Number(req.query.offset) || 0;
 			const limit = Math.min(Number(req.query.limit) || 100, 250);
 
-			const [credentials, count] = await Container.get(CredentialsRepository).findManyAndCount({
+			const repo = Container.get(CredentialsRepository);
+			const [credentials, count] = await repo.findAndCount({
 				take: limit,
 				skip: offset,
+				select: ['id', 'name', 'type', 'createdAt', 'updatedAt'],
+				relations: ['shared', 'shared.project'],
+				order: { createdAt: 'DESC' },
 			});
 
-			const data = sanitizeCredentials(credentials);
+			const data = credentials.map((credential: CredentialsEntity) => {
+				const shared = buildSharedForCredential(credential);
+				return {
+					id: credential.id,
+					name: credential.name,
+					type: credential.type,
+					createdAt: credential.createdAt,
+					updatedAt: credential.updatedAt,
+					shared,
+				};
+			});
 
 			return res.json({
 				data,
diff --git a/packages/cli/src/public-api/v1/handlers/credentials/credentials.service.ts b/packages/cli/src/public-api/v1/handlers/credentials/credentials.service.ts
@@ -27,6 +27,37 @@ import type { IDependency, IJsonSchema } from '../../../types';
 
 export class CredentialsIsNotUpdatableError extends BaseError {}
 
+/**
+ * Shared entry for credential list: project id/name plus sharing role and timestamps.
+ * Derived from credential.shared (SharedCredentials + Project), limited to these fields.
+ */
+export type CredentialListSharedItem = {
+	id: string;
+	name: string;
+	role: string;
+	createdAt: Date;
+	updatedAt: Date;
+};
+
+/**
+ * Build the shared array for a credential list item from credential.shared.
+ * Each entry has id, name from the project and role, createdAt, updatedAt from the shared relation.
+ */
+export function buildSharedForCredential(
+	credential: CredentialsEntity,
+): CredentialListSharedItem[] {
+	const shared = credential.shared;
+	return shared
+		.filter((sh) => typeof sh.project?.id === 'string')
+		.map((sh) => ({
+			id: sh.project.id,
+			name: sh.project.name,
+			role: sh.role,
+			createdAt: sh.createdAt,
+			updatedAt: sh.updatedAt,
+		}));
+}
+
 export async function getCredentials(credentialId: string): Promise<ICredentialsDb | null> {
 	return await Container.get(CredentialsRepository).findOneBy({ id: credentialId });
 }
diff --git a/packages/cli/src/public-api/v1/handlers/credentials/spec/schemas/credentialList.yml b/packages/cli/src/public-api/v1/handlers/credentials/spec/schemas/credentialList.yml
@@ -3,7 +3,7 @@ properties:
   data:
     type: array
     items:
-      $ref: './create-credential-response.yml'
+      $ref: './credentialListItem.yml'
   nextCursor:
     type: string
     description: Paginate through credentials by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection.
diff --git a/packages/cli/src/public-api/v1/handlers/credentials/spec/schemas/credentialListItem.yml b/packages/cli/src/public-api/v1/handlers/credentials/spec/schemas/credentialListItem.yml
@@ -0,0 +1,11 @@
+allOf:
+  - $ref: './create-credential-response.yml'
+  - type: object
+    required:
+      - shared
+    properties:
+      shared:
+        type: array
+        description: Shared entries (project id, name, role, createdAt, updatedAt) from the credential's shared relation
+        items:
+          $ref: './credentialSharedItem.yml'
diff --git a/packages/cli/src/public-api/v1/handlers/credentials/spec/schemas/credentialSharedItem.yml b/packages/cli/src/public-api/v1/handlers/credentials/spec/schemas/credentialSharedItem.yml
@@ -0,0 +1,25 @@
+type: object
+required:
+  - id
+  - name
+  - role
+  - createdAt
+  - updatedAt
+properties:
+  id:
+    type: string
+    description: Project ID
+  name:
+    type: string
+    description: Project name
+  role:
+    type: string
+    description: Role of the credential in this project (e.g. credential:owner)
+  createdAt:
+    type: string
+    format: date-time
+    description: When the credential was shared with this project
+  updatedAt:
+    type: string
+    format: date-time
+    description: When the sharing was last updated
diff --git a/packages/cli/test/integration/public-api/credentials.test.ts b/packages/cli/test/integration/public-api/credentials.test.ts
@@ -190,14 +190,33 @@ describe('GET /credentials', () => {
 		expect(Array.isArray(response.body.data)).toBe(true);
 		expect(response.body.data.length).toBe(2);
 
+		const allowedListItemKeys = ['createdAt', 'id', 'name', 'shared', 'type', 'updatedAt'];
 		response.body.data.forEach((item: Record<string, unknown>) => {
+			expect(Object.keys(item).sort()).toEqual(allowedListItemKeys);
 			expect(item).toHaveProperty('id');
 			expect(item).toHaveProperty('name');
 			expect(item).toHaveProperty('type');
 			expect(item).toHaveProperty('createdAt');
 			expect(item).toHaveProperty('updatedAt');
-			expect(item).not.toHaveProperty('data');
-			expect(item).not.toHaveProperty('shared');
+			expect(item).toHaveProperty('shared');
+			expect(Array.isArray((item as { shared: unknown }).shared)).toBe(true);
+			(
+				item as {
+					shared: {
+						id: string;
+						name: string;
+						role: string;
+						createdAt: string;
+						updatedAt: string;
+					}[];
+				}
+			).shared.forEach((entry) => {
+				expect(entry).toHaveProperty('id');
+				expect(entry).toHaveProperty('name');
+				expect(entry).toHaveProperty('role');
+				expect(entry).toHaveProperty('createdAt');
+				expect(entry).toHaveProperty('updatedAt');
+			});
 		});
 		expect(response.body.data).toContainEqual(
 			expect.objectContaining({ id: saved1.id, name: saved1.name }),
