Improve return type for readById and readByQuery

Author: ComfortablyCoding

src/feed/feed.test.ts

@@ -49,7 +49,7 @@ describe('Feed', () => {
 		it('Calls the /$metadata endpoint for $metadata', () => {
 			feed.$metadata();
 
-			expect(feed.request).toBeCalledWith('/$metadata',{});
+			expect(feed.request).toBeCalledWith('/$metadata', {});
 		});
 	});
 
@@ -58,14 +58,14 @@ describe('Feed', () => {
 			vi.mocked(feed.request);
 
 			await feed.readById('/Property', 123);
-			expect(feed.request).toHaveBeenCalledWith('/Property(123)',{});
+			expect(feed.request).toHaveBeenCalledWith('/Property(123)', {});
 		});
 
 		it('Constructs singleton key query for string with qoutes', async () => {
 			vi.mocked(feed.request);
 
 			await feed.readById('/Property', '123');
-			expect(feed.request).toHaveBeenCalledWith("/Property('123')",{});
+			expect(feed.request).toHaveBeenCalledWith("/Property('123')", {});
 		});
 	});
 
@@ -98,7 +98,7 @@ describe('Feed', () => {
 				query: {
 					$filter: 'ListingPrice eq 200000 ',
 					$top: '1000',
-					$skip:"4000"
+					$skip: '4000',
 				},
 			});
 

src/feed/feed.ts

@@ -2,9 +2,11 @@ import type { $Fetch, FetchError } from 'ofetch';
 import { $fetch } from 'ofetch';
 import { getQuery, parsePath, parseQuery, stringifyQuery } from 'ufo';
 import type {
+	FeedMultiResponse,
 	FeedOptions,
 	FeedRequestOptions,
 	FeedResponse,
+	FeedSingleResponse,
 	TransportError,
 	TransportResponse,
 } from '../types/index.js';
@@ -28,11 +30,10 @@ export class Feed {
 	}
 
 	$metadata(query?: string) {
+		const requestOptions: Partial<FeedRequestOptions> = {};
 
-		const requestOptions:Partial<FeedRequestOptions> = {};
-
-		if(query){
-			requestOptions['query'] = parseQuery(query)
+		if (query) {
+			requestOptions['query'] = parseQuery(query);
 		}
 
 		return this.request('/$metadata', requestOptions) as unknown as string;
@@ -41,15 +42,15 @@ export class Feed {
 	async *readByQuery<V extends Record<string, unknown>>(
 		resource: string,
 		query?: string,
-	): AsyncGenerator<FeedResponse<V>> {
+	): AsyncGenerator<FeedMultiResponse<V>> {
 		let url: null | string = resource;
 
 		let q = query;
 
 		do {
 			const readResponse = (await this.request<V>(url || resource, {
 				query: parseQuery(q),
-			})) as FeedResponse<V>;
+			})) as FeedMultiResponse<V>;
 
 			url = null;
 			if (readResponse && 'nextLink' in readResponse) {
@@ -65,17 +66,16 @@ export class Feed {
 		resource: string,
 		id: string | number,
 		query?: string,
-	): Promise<FeedResponse<V>> {
+	): Promise<FeedSingleResponse<V>> {
 		const resourceId = `(${typeof id === 'string' ? `'${id}'` : id})`;
 
+		const requestOptions: Partial<FeedRequestOptions> = {};
 
-		const requestOptions:Partial<FeedRequestOptions> = {};
-
-		if(query){
-			requestOptions['query'] = parseQuery(query)
+		if (query) {
+			requestOptions['query'] = parseQuery(query);
 		}
 
-		return this.request<V>(resource + resourceId, requestOptions) as unknown as FeedResponse<V>;
+		return this.request<V>(resource + resourceId, requestOptions) as unknown as FeedSingleResponse<V>;
 	}
 
 	async request<R extends Record<string, unknown>>(

src/types/feed.ts

@@ -40,15 +40,15 @@ export interface FeedBaseResponse {
 	count?: string | number;
 }
 
-export interface FeedMultiResponse<V> extends FeedBaseResponse {
+export interface FeedMultiResponse<V extends Record<string, unknown>> extends FeedBaseResponse {
 	values: V[];
 }
 
-export interface FeedSingleResponse<V> extends FeedBaseResponse {
+export interface FeedSingleResponse<V extends Record<string, unknown>> extends FeedBaseResponse {
 	value: V;
 }
 
-export type FeedResponse<V> = FeedMultiResponse<V> | FeedSingleResponse<V>;
+export type FeedResponse<V extends Record<string, unknown>> = FeedMultiResponse<V> | FeedSingleResponse<V>;
 
 export interface FeedOptions {
 	http: FeedHttpOptions;