Proposal: Separating Fetch Layer and Query Builder within ODataQuery Class

[mildronize]

Overview

This work is fantastic work for make a query builder for Odata Specification. Moreover, the current implementation of the ODataQuery class is a significant step in providing a type-safe query builder for OData specifications. However, there are specific use cases where direct request execution with query parameters from the fetch function is not desirable. This enhancement aims to split the Fetch layer and Query Builder functionalities within the ODataQuery class to cater to diverse usage scenarios.

Background

During my research on OData-related npm libraries, I found that this library is one of the most type-safe methods for generating OData queries. However, my use case involves working with the Azure Table Storage library, which requires filter expressions in a specific format.

Existing Solutions

There are existing npm libraries, such as bodia-uz/odata-filter-builder and jaredmahan/odata-query-builder, that generate filter expressions. However, both lack type safety.

Proposed Changes

The proposed enhancement involves splitting the Fetch layer and Query Builder functionalities. The goal is to maintain the type safety provided by the existing query builder while allowing users more flexibility in constructing and handling requests.

Expected Behavior

// Create a type-safe filter expression
const result = ODataExpression.forV4<User>()
    .filter((p) => p.firstName.$equals("john"))
    .build();

console.log(results); 
// Output: { "$filter": "firstName eq 'john'", ... }

This enhancement aims to provide a cleaner separation of concerns within the ODataQuery class, facilitating a more modular and adaptable architecture.

[mildronize]

Due to PR #28 is already merged, this issue should be closed.

[mildronize]

@cbrianball do you have any chance to release this PR.

[cbrianball]

@mildronize I released it about 3 weeks ago, are you not able to use it? https://www.npmjs.com/package/ts-odata-client/v/2.0.2

[mildronize]

Sorry, i confuse it thank you.

[mildronize]

I can use it now, thank you,