Enable Notes list in SDK

Author: it-baron

src/__tests__/notesClient.test.ts

@@ -3,7 +3,7 @@
 import assert from 'node:assert/strict';
 import test from 'node:test';
 import type { AuthModule } from '../auth/types.js';
-import type { ProjectNote } from '../notes/notesTypes.js';
+import type { ProjectNote, ProjectNoteHeader } from '../notes/notesTypes.js';
 import { diskd } from '../sdk/diskd.js';
 
 type FetchCall = { readonly url: string; readonly init?: RequestInit };
@@ -24,6 +24,16 @@ const stubNote: ProjectNote = {
   updatedAt: '2026-05-16T10:00:00.000Z',
 };
 
+const stubHeader: ProjectNoteHeader = {
+  id: NOTE_ID,
+  projectId: PROJECT_ID,
+  name: 'Architecture note',
+  contentPreview: '# Architecture',
+  params: { pin: false, order: 0 },
+  createdAt: '2026-05-16T10:00:00.000Z',
+  updatedAt: '2026-05-16T10:00:00.000Z',
+};
+
 /** Build a deterministic auth module so Notes client tests assert SDK headers. */
 const makeAuth = (): AuthModule => ({
   signIn: async () => {},
@@ -118,6 +128,34 @@ test('notes.read sends GET with noteId path param and bound projectId query', as
   );
 });
 
+test('notes.list sends GET with bound projectId query and returns headers', async () => {
+  /* REQUIREMENT enabling:dev/platform-api/sdk -- Notes list uses the project-scoped project-notes API. */
+  const url = 'http://app-service:3000';
+
+  await withFetchMock(
+    () =>
+      new Response(JSON.stringify([stubHeader]), {
+        status: 200,
+        headers: { 'Content-Type': 'application/json' },
+      }),
+    async (calls) => {
+      const client = diskd.platform.notes({
+        auth: makeAuth(),
+        scope: { scopeType: 'project', projectId: PROJECT_ID },
+        url,
+      });
+      const result = await client.list();
+
+      assert.deepEqual(result, [stubHeader]);
+      assert.equal(
+        calls[0]?.url,
+        `http://app-service:3000/api/project-notes?projectId=${PROJECT_ID}`
+      );
+      assert.equal(calls[0]?.init?.method, 'GET');
+    }
+  );
+});
+
 test('notes client throws on HTTP error with parsed message', async () => {
   const url = 'http://app-service:3000';
 

src/browser/index.ts

@@ -74,6 +74,7 @@ export type { DriveClient, DrivePathEntry, DrivePathType } from '../drive/types.
 export type {
   CreateProjectNoteParams,
   ProjectNote,
+  ProjectNoteHeader,
   ProjectNoteMetadata,
   ProjectNoteParams,
   ProjectNotesClient,

src/index.ts

@@ -383,6 +383,7 @@ export { createProjectNotesClient } from './notes/notes.js';
 export type {
   CreateProjectNoteParams,
   ProjectNote,
+  ProjectNoteHeader,
   ProjectNoteMetadata,
   ProjectNoteParams,
   ProjectNotesClient,

src/notes/notes.ts

@@ -1,7 +1,12 @@
 import type { AuthModule } from '../auth/types.js';
 import { resolveDiskdGatewayUrl } from '../env/baseUrl.js';
 import { buildQuery, type HttpMethod, httpRequest, resolveAuthHeaders } from '../sdk/http.js';
-import type { CreateProjectNoteParams, ProjectNote, ProjectNotesClient } from './notesTypes.js';
+import type {
+  CreateProjectNoteParams,
+  ProjectNote,
+  ProjectNoteHeader,
+  ProjectNotesClient,
+} from './notesTypes.js';
 
 // ---------------------------------------------------------------------------
 // Client factory
@@ -59,5 +64,12 @@ export const createProjectNotesClient = (params: {
         `/api/project-notes/${encId(noteId)}${buildQuery([['projectId', params.projectId]])}`
       );
     },
+
+    list: async (): Promise<readonly ProjectNoteHeader[]> => {
+      return request<readonly ProjectNoteHeader[]>(
+        'GET',
+        `/api/project-notes${buildQuery([['projectId', params.projectId]])}`
+      );
+    },
   };
 };

src/notes/notesTypes.ts

@@ -27,6 +27,16 @@ export type ProjectNote = {
   readonly updatedAt: string;
 };
 
+export type ProjectNoteHeader = {
+  readonly id: string;
+  readonly projectId: string;
+  readonly name: string;
+  readonly contentPreview: string;
+  readonly params: ProjectNoteParams;
+  readonly createdAt: string;
+  readonly updatedAt: string;
+};
+
 // -- Scope and params --
 
 export type ProjectNotesScopeRef = {
@@ -56,4 +66,6 @@ export type ProjectNotesClient = {
   readonly create: (params: CreateProjectNoteParams) => Promise<ProjectNote>;
   /** GET /api/project-notes/:noteId -- read a Drive-backed project note. */
   readonly read: (noteId: string) => Promise<ProjectNote>;
+  /** GET /api/project-notes -- list Drive-backed project note headers. */
+  readonly list: () => Promise<readonly ProjectNoteHeader[]>;
 };