feat: update entry.getMany to include releasev2 params [DX-203] (#2685)

* chore: getMany first attempt

* chore: new integrations test file added (from Michael)

* chore: type fixes implemented

* chore: test shell added to entry-integration.test.ts

* chore: tests implemented with necessary unimplemented release metadata tests commented out

* chore: prettier fix

* fix: entry integration scope removed from test script

* chore: prettier fix

* fix: version logic cleaned up and test query modified

* chore: prettier fix

Author: tylerpina

lib/adapters/REST/endpoints/entry.ts

@@ -55,10 +55,14 @@ export const getPublished: RestEndpoint<'Entry', 'getPublished'> = <
 
 export const getMany: RestEndpoint<'Entry', 'getMany'> = <T extends KeyValueMap = KeyValueMap>(
   http: AxiosInstance,
-  params: GetSpaceEnvironmentParams & QueryParams,
+  params: GetSpaceEnvironmentParams & QueryParams & { releaseId?: string },
   rawData?: unknown,
   headers?: RawAxiosRequestHeaders
 ) => {
+  if (params.releaseId) {
+    params.query = { ...params.query, 'release[lte]': params.releaseId }
+  }
+
   return raw.get<CollectionProp<EntryProps<T>>>(
     http,
     `/spaces/${params.spaceId}/environments/${params.environmentId}/entries`,

lib/common-types.ts

@@ -1597,8 +1597,8 @@ export type MRActions = {
       return: CollectionProp<EntryProps<any>>
     }
     getMany: {
-      params: GetSpaceEnvironmentParams & QueryParams
-      return: CollectionProp<EntryProps<any>>
+      params: GetSpaceEnvironmentParams & QueryParams & { releaseId?: string }
+      return: CollectionProp<EntryProps<any, any>>
     }
     get: {
       params: GetReleaseEntryParams & QueryParams

lib/plain/common-types.ts

@@ -276,10 +276,25 @@ export type PlainClientAPI = {
       headers?: RawAxiosRequestHeaders
     ): Promise<CollectionProp<EntryProps<T>>>
     getMany<T extends KeyValueMap = KeyValueMap>(
-      params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>,
+      params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & { releaseId?: string }>,
       rawData?: unknown,
       headers?: RawAxiosRequestHeaders
-    ): Promise<CollectionProp<EntryProps<T>>>
+    ): Promise<
+      CollectionProp<
+        EntryProps<
+          T,
+          {
+            release: {
+              sys: {
+                type: 'Link'
+                linkType: 'Entry' | 'Asset'
+                id: string
+              }
+            }
+          }
+        >
+      >
+    >
     get<T extends KeyValueMap = KeyValueMap>(
       params: OptionalDefaults<GetReleaseEntryParams>,
       rawData?: unknown,

package.json

@@ -45,7 +45,7 @@
     "test:types": "npx vitest --project types --run",
     "test:unit-watch": "npx vitest --project unit",
     "test:integration": "npx vitest --project integration --run --no-file-parallelism",
-    "test:integration-watch": "npx vitest --project integration --no-file-parallelism",
+    "test:integration-watch": "npx vitest --project integration --no-file-parallelism entry-integration",
     "test:browser": "npx playwright install && npx vitest --project browser-unit --run && npx vitest --project browser-integration --run",
     "test:version": "grep -r \"0.0.0-determined-by-semantic-release\" ./dist > /dev/null && echo \"version 0.0.0-determined-by-semantic-release found in output\" && exit 1 || exit 0",
     "test:size": "size-limit",

test/integration/entry-integration.test.ts

@@ -717,8 +717,10 @@ describe('Entry Api', () => {
     })
   })
 
+  //test releasev2 entry logic
   describe('read plainClientApi with releaseId', () => {
     let entry: EntryProps
+    let entry2: EntryProps
     let release: ReleaseProps
     let createEntryClient: PlainClientAPI
 
@@ -742,6 +744,17 @@ describe('Entry Api', () => {
         }
       )
 
+      entry2 = await createEntryClient.entry.create(
+        { ...defaultParams, contentTypeId: TestDefaults.contentType.withCrossSpaceReferenceId },
+        {
+          fields: {
+            title: {
+              'en-US': 'Test Entry for Release',
+            },
+          },
+        }
+      )
+
       release = await createEntryClient.release.create(defaultParams, {
         title: 'Test Release',
         entities: {
@@ -751,8 +764,13 @@ describe('Entry Api', () => {
               entity: makeLink('Entry', entry.sys.id),
               action: 'publish',
             },
+            {
+              entity: makeLink('Entry', entry2.sys.id),
+              action: 'publish',
+            },
           ],
         },
+        startDate: '2025-08-28T10:00:000Z',
       })
     })
 
@@ -768,6 +786,20 @@ describe('Entry Api', () => {
     })
 
     describe('releaseId is provided in params, but not in default params', () => {
+      //the entry.getMany API endpoint currently does not return release metadata
+      test('entry.getMany works', async () => {
+        const response = await createEntryClient.entry.getMany({
+          query: {
+            'release[lte]': release.sys.id,
+            order: '-sys.createdAt',
+          },
+        })
+        expect(response.items[0].sys.id).toEqual(entry2.sys.id)
+        expect(response.items[1].sys.id).toEqual(entry.sys.id)
+        //expect(response.items[0].sys.release.sys.id).toEqual(release.sys.id)
+        //expect(response.items[1].sys.release.sys.id).toEqual(release.sys.id)
+      })
+
       test('entry.get works', async () => {
         const fetchedEntry = await createEntryClient.entry.get({
           entryId: entry.sys.id,
@@ -787,6 +819,18 @@ describe('Entry Api', () => {
         })
       })
 
+      test('entry.getMany works', async () => {
+        const response = await createEntryClient.entry.getMany({
+          query: {
+            order: '-sys.createdAt',
+          },
+        })
+        expect(response.items[0].sys.id).toEqual(entry2.sys.id)
+        expect(response.items[1].sys.id).toEqual(entry.sys.id)
+        //expect(response.items[0].sys.release.sys.id).toEqual(release.sys.id)
+        //expect(response.items[1].sys.release.sys.id).toEqual(release.sys.id)
+      })
+
       test('entry.get works', async () => {
         const fetchedEntry = await createEntryClient.entry.get({
           entryId: entry.sys.id,