Allow calling service.read with ref (#361)

CHANGELOG.md

@@ -6,7 +6,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ## Version 0.9.0 - tbd
 ### Added
-- Adds missing properties for `log` in `cds.env`
+- Added missing properties for `log` in `cds.env`
+- Added overload for `service.read` to be called with a `ref`
 
 ### Fixed
 

apis/services.d.ts

@@ -8,6 +8,7 @@ import { EventContext } from './events'
 import { Request } from './events'
 import { ReadableStream } from 'node:stream/web'
 import { _TODO } from './internal/util'
+import { ref } from './cqn'
 
 type Key = number | string | any
 
@@ -21,6 +22,7 @@ export class QueryAPI {
   read: {
     <T extends ArrayConstructable>(entity: T, key?: Key): Awaitable<SELECT<T>, InstanceType<T>>,
     <T>(entity: linked.Definition | string, key?: Key): SELECT<T>,
+    (entity: ref, key?: Key): SELECT<unknown>,
   }
 
   /**

test/typescript/apis/project/cds-services.ts

@@ -59,6 +59,8 @@ await srv.delete(Books)
 await srv.delete(Books, 'ID')
 await srv.delete(Books).where({ id: 123 })
 await srv.upsert({}).into(Books)
+await srv.read({} as unknown as cds.ref)
+await srv.read({} as unknown as cds.ref, 42)
 
 await cds.read(Books, 'ID')
 await cds.create(Books)
@@ -69,6 +71,8 @@ await cds.update(Books, 'ID')
 await cds.delete(Books)
 await cds.delete(Books, 'ID')
 await cds.delete(Books).where({ id: 123 })
+await cds.read({} as unknown as cds.ref)
+await cds.read({} as unknown as cds.ref, 42)
 // GAP: has to be added in runtime, then types, then re-enable this test
 // await cds.upsert({}).into(Books)