feat(cred-req/endpoints): add support for requesting credentials by endpoints

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makehq/sdk",
-    "version": "1.6.0",
+    "version": "1.6.1",
     "description": "Make TypeScript SDK",
     "license": "MIT",
     "author": "Make",

src/endpoints/credential-requests.tools.ts

@@ -1,5 +1,6 @@
 import type { Make } from '../make.js';
 import type { MakeTool } from '../tools.js';
+import type { CredentialSelection } from './credential-requests.js';
 
 export const tools: MakeTool[] = [
     {
@@ -198,7 +199,15 @@ export const tools: MakeTool[] = [
                                 type: 'array',
                                 description:
                                     'Array of module IDs to request from the user, for example: ["WatchDirectMessages", "WatchFiles"]. ' +
-                                    'Use ["*"] to select all modules for the given application.',
+                                    'Use ["*"] to select all modules for the given application. At least one of appModules or appEndpoints must be specified (both may be provided together).',
+                                minItems: 1,
+                                items: { type: 'string' },
+                            },
+                            appEndpoints: {
+                                type: 'array',
+                                description:
+                                    'Array of Endpoint Names that the credential will be used to access, for example: ["GetUser", "ListFiles"]. ' +
+                                    'Use ["*"] to select all endpoints for the given application. At least one of appModules or appEndpoints must be specified (both may be provided together).',
                                 minItems: 1,
                                 items: { type: 'string' },
                             },
@@ -217,7 +226,7 @@ export const tools: MakeTool[] = [
                                 description: 'Description for this credential to be displayed in the Request view.',
                             },
                         },
-                        required: ['appName', 'appModules'],
+                        required: ['appName'],
                     },
                 },
             },
@@ -236,13 +245,7 @@ export const tools: MakeTool[] = [
                 name?: string;
                 description?: string;
                 teamId: number;
-                credentials: {
-                    appName: string;
-                    appModules: string[];
-                    appVersion?: number;
-                    nameOverride?: string;
-                    description?: string;
-                }[];
+                credentials: CredentialSelection[];
             },
         ) => {
             return await make.credentialRequests.createAction(args);

src/endpoints/credential-requests.ts

@@ -110,14 +110,9 @@ export type CreateCredentialRequestBody = {
     provider: Record<string, JSONValue>;
 };
 
-/**
- * Represents an app/module selection to derive credentials from.
- */
-export type CredentialSelection = {
+type CredentialSelectionBase = {
     /** Name of the application to request credentials for */
     appName: string;
-    /** Array of module IDs to include. Use ["*"] to select all modules with credentials. */
-    appModules: string[];
     /** Version of the application. Defaults to the latest available version if not provided. */
     appVersion?: number;
     /** Optional name override for the credential when created in the platform */
@@ -126,6 +121,26 @@ export type CredentialSelection = {
     description?: string;
 };
 
+/**
+ * Represents an app/module selection to derive credentials from.
+ * At least one of `appModules` or `appEndpoints` must be specified (both may be provided together).
+ */
+export type CredentialSelection = CredentialSelectionBase &
+    (
+        | {
+              /** Array of module IDs to include. Use ["*"] to select all modules with credentials. */
+              appModules: string[];
+              /** Array of Endpoint Names that the credential will be used to access. Use ["*"] to select all endpoints. */
+              appEndpoints?: string[];
+          }
+        | {
+              /** Array of module IDs to include. Use ["*"] to select all modules with credentials. */
+              appModules?: string[];
+              /** Array of Endpoint Names that the credential will be used to access. Use ["*"] to select all endpoints. */
+              appEndpoints: string[];
+          }
+    );
+
 /**
  * Body for creating a credential action
  */

test/credential-requests.integration.test.ts

@@ -120,6 +120,24 @@ describe('Integration: CredentialRequests', () => {
         expect(requests.some(r => r.id === actionRequestId)).toBe(false);
     });
 
+    it('Should create a credential action using appEndpoints', async () => {
+        const action = await make.credentialRequests.createAction({
+            teamId: MAKE_TEAM,
+            credentials: [
+                {
+                    appName: 'http',
+                    appEndpoints: ['*'],
+                    appVersion: 3,
+                },
+            ],
+        });
+        expect(action.request.id).toBeDefined();
+        expect(action.publicUri).toBeDefined();
+        expect(action.request.teamId).toBe(MAKE_TEAM);
+
+        await make.credentialRequests.delete(action.request.id);
+    });
+
     it('Should create a credential action with name and description', async () => {
         const action = await make.credentialRequests.createAction({
             teamId: MAKE_TEAM,

test/credential-requests.spec.ts

@@ -213,6 +213,40 @@ describe('Endpoints: CredentialRequests', () => {
         });
     });
 
+    it('Should create a credential action with appEndpoints', async () => {
+        const body = {
+            teamId: 123,
+            credentials: [
+                {
+                    appName: 'http',
+                    appEndpoints: ['GetUser', 'ListFiles'],
+                    appVersion: 3,
+                },
+            ],
+        };
+
+        mockFetch('POST https://make.local/api/v2/credential-requests/actions/create', createActionMock, req => {
+            expect(req.body).toStrictEqual(body);
+            expect(req.headers.get('content-type')).toBe('application/json');
+        });
+
+        const result = await make.credentialRequests.createAction({
+            teamId: 123,
+            credentials: [
+                {
+                    appName: 'http',
+                    appEndpoints: ['GetUser', 'ListFiles'],
+                    appVersion: 3,
+                },
+            ],
+        });
+
+        expect(result).toStrictEqual({
+            request: createActionMock.request,
+            publicUri: createActionMock.publicUri,
+        });
+    });
+
     it('Should create a credential request by connection/key types', async () => {
         const body = {
             teamId: 123,