@ballistix.digital/odata-query-builder 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -12,7 +12,7 @@ import type { Scalar, Unwrap } from './module/common/domain/scalar.model';
 import { QueryBuilderException } from './module/common/exception/queryBuilder.exception';
 import type { Chain, QueryParams } from './module/query/domain/chain/chain.model';
 import type { ExpandChain } from './module/query/domain/chain/expandChain.model';
-import type { EmbeddedPathKeys, ExpandKey, ExpandNamespace, FieldKey, OrderKey } from './module/query/domain/chain/expandNamespace.model';
+import type { ExpandKey, ExpandNamespace } from './module/query/domain/chain/expandNamespace.model';
 import type { ItemChain } from './module/query/domain/chain/itemChain.model';
 import type { BooleanExpr } from './module/query/domain/filter/booleanExpr.model';
 import type { Castable, CastResult, EdmTarget } from './module/query/domain/filter/castable.model';
@@ -28,4 +28,4 @@ import { ReservedNameError } from './module/query/exception/reservedName.excepti
 import { and, maxdatetime, mindatetime, not, now, or, raw } from './module/query/service/filter/filter.facade';
 import { odataItem, odataQuery } from './module/query/service/queryChain.service';
 export { InvalidFilterError, QueryBuilderException, QueryBuilderExceptionCode, ReservedNameError, and, maxdatetime, mindatetime, not, now, odataItem, odataQuery, or, raw, };
-export type { BooleanExpr, CastResult, Castable, Chain, Comparable, DateExpr, DateInput, EdmTarget, EmbeddedObjectKeys, EmbeddedOf, EmbeddedPathKeys, ExceptionDetail, ExpandChain, ExpandKey, ExpandNamespace, ExprFor, FieldKey, ItemChain, LambdaNamespace, Node, NumberExpr, Operators, OrderKey, OwnKeys, Predicate, PrimitiveArrayKeys, PrimitiveLambdaNamespace, QueryParams, Relation, Scalar, ScalarFieldKeys, Scope, StringExpr, ToManyKeys, ToOneKeys, Unwrap, };
+export type { BooleanExpr, CastResult, Castable, Chain, Comparable, DateExpr, DateInput, EdmTarget, EmbeddedObjectKeys, EmbeddedOf, ExceptionDetail, ExpandChain, ExpandKey, ExpandNamespace, ExprFor, ItemChain, LambdaNamespace, Node, NumberExpr, Operators, OwnKeys, Predicate, PrimitiveArrayKeys, PrimitiveLambdaNamespace, QueryParams, Relation, Scalar, ScalarFieldKeys, Scope, StringExpr, ToManyKeys, ToOneKeys, Unwrap, };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAEH,oFAAuF;AAiEtF,0GAjEQ,+CAAyB,OAiER;AA9D1B,6FAAyF;AA6DxF,sGA7DQ,8CAAqB,OA6DR;AAlBtB,8FAAsF;AAiBrF,mGAjBQ,4CAAkB,OAiBR;AAhBnB,4FAAoF;AAmBnF,kGAnBQ,0CAAiB,OAmBR;AAlBlB,+EAQqD;AAWpD,oFAlBA,mBAAG,OAkBA;AACH,4FAlBA,2BAAW,OAkBA;AACX,4FAlBA,2BAAW,OAkBA;AACX,oFAlBA,mBAAG,OAkBA;AACH,oFAlBA,mBAAG,OAkBA;AAGH,mFApBA,kBAAE,OAoBA;AACF,oFApBA,mBAAG,OAoBA;AAlBJ,kFAGmD;AAYlD,0FAdA,8BAAS,OAcA;AACT,2FAdA,+BAAU,OAcA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAEH,oFAAuF;AA8DtF,0GA9DQ,+CAAyB,OA8DR;AA3D1B,6FAAyF;AA0DxF,sGA1DQ,8CAAqB,OA0DR;AAlBtB,8FAAsF;AAiBrF,mGAjBQ,4CAAkB,OAiBR;AAhBnB,4FAAoF;AAmBnF,kGAnBQ,0CAAiB,OAmBR;AAlBlB,+EAQqD;AAWpD,oFAlBA,mBAAG,OAkBA;AACH,4FAlBA,2BAAW,OAkBA;AACX,4FAlBA,2BAAW,OAkBA;AACX,oFAlBA,mBAAG,OAkBA;AACH,oFAlBA,mBAAG,OAkBA;AAGH,mFApBA,kBAAE,OAoBA;AACF,oFApBA,mBAAG,OAoBA;AAlBJ,kFAGmD;AAYlD,0FAdA,8BAAS,OAcA;AACT,2FAdA,+BAAU,OAcA"}

package/dist/module/query/domain/chain/chain.model.d.ts

@@ -6,20 +6,28 @@
  */
 import type { Predicate } from '../filter/node.model';
 import type { Operators } from '../filter/operators.model';
-import type { Scope } from '../filter/scope.model';
+import type { ColumnExpr, ScalarFieldKeys, Scope, SelectScope } from '../filter/scope.model';
 import type { StringExpr } from '../filter/stringExpr.model';
-import type { ExpandNamespace, FieldKey, OrderKey } from './expandNamespace.model';
+import type { ExpandNamespace } from './expandNamespace.model';
 /** A flat `{ $option: value }` map, for a caller that serialises its own URL. */
 export type QueryParams = Record<string, string>;
 export interface Chain<T> {
     readonly expand: ExpandNamespace<T, Chain<T>>;
-    select(...keys: FieldKey<T>[]): Chain<T>;
+    /** Own columns, by name. */
+    select(...keys: ScalarFieldKeys<T>[]): Chain<T>;
+    /** Own columns and embedded leaves: `select((v) => [v.id, v.address.city])`. */
+    select(columns: (scope: SelectScope<T>) => ColumnExpr | readonly ColumnExpr[]): Chain<T>;
     /** Repeated calls AND together. */
     filter(build: (scope: Scope<T>, operators: Operators) => Predicate): Chain<T>;
     /** `$search` + its mandatory `$searchColumns`, as one verb. */
     search(term: string, columns: (scope: Scope<T>) => StringExpr | readonly StringExpr[]): Chain<T>;
-    /** Sorts on an own column, an embedded leaf, or a to-one relation path. */
-    orderBy(key: OrderKey<T>, direction?: 'asc' | 'desc'): Chain<T>;
+    /** Sorts on an own column, by name. */
+    orderBy(key: ScalarFieldKeys<T>, direction?: 'asc' | 'desc'): Chain<T>;
+    /**
+     * Sorts on the column the callback reads: an embedded leaf, or a column at
+     * any depth of to-one relations: `orderBy((v) => v.owner.organisation.code)`.
+     */
+    orderBy(column: (scope: Scope<T>) => ColumnExpr, direction?: 'asc' | 'desc'): Chain<T>;
     top(count: number): Chain<T>;
     skip(count: number): Chain<T>;
     count(on?: boolean): Chain<T>;

package/dist/module/query/domain/chain/expandChain.model.d.ts

@@ -15,11 +15,14 @@
  */
 import type { Predicate } from '../filter/node.model';
 import type { Operators } from '../filter/operators.model';
-import type { Scope } from '../filter/scope.model';
-import type { ExpandNamespace, FieldKey } from './expandNamespace.model';
+import type { ColumnExpr, ScalarFieldKeys, Scope, SelectScope } from '../filter/scope.model';
+import type { ExpandNamespace } from './expandNamespace.model';
 export interface ExpandChain<T> {
     readonly expand: ExpandNamespace<T, ExpandChain<T>>;
-    select(...keys: FieldKey<T>[]): ExpandChain<T>;
+    /** Own columns, by name. */
+    select(...keys: ScalarFieldKeys<T>[]): ExpandChain<T>;
+    /** Own columns and embedded leaves: `select((v) => [v.id, v.address.city])`. */
+    select(columns: (scope: SelectScope<T>) => ColumnExpr | readonly ColumnExpr[]): ExpandChain<T>;
     /**
      * `$expand=rel($filter=…)`. The scope is the EXPANDED entity, so paths are
      * written relative to it, not to the root. Repeated calls AND together.

package/dist/module/query/domain/chain/expandNamespace.model.d.ts

@@ -5,63 +5,10 @@
  * relations `_embedded` declares, each callback typed to the entity that
  * relation reaches, with no build step and no `$metadata` document.
  */
-import type { EmbeddedObjectKeys, Relation, ScalarFieldKeys, ToManyKeys, ToOneKeys } from '../filter/scope.model';
+import type { Relation, ToManyKeys, ToOneKeys } from '../filter/scope.model';
 import type { ExpandChain } from './expandChain.model';
 /** Every expandable relation name of a DTO. A real allowlist. */
 export type ExpandKey<T> = ToOneKeys<T> | ToManyKeys<T>;
-/**
- * The budget a path type spends, one unit per segment it descends.
- *
- * A DTO graph is cyclic — `ProjectDto` reaches itself through `parent` — so a
- * path type that recursed freely would never terminate and TypeScript would
- * answer TS2589. Indexing `Down` with the remaining budget yields the budget
- * one segment deeper; `[D] extends [0]` stops the descent.
- *
- * The budget also sets what a caller can write. `OrderKey` (default 3) admits
- * up to three to-one hops; `EmbeddedPathKeys` (default 2) admits three object
- * segments before the leaf. A deeper path is a compile error, which
- * `test/types/err/orderBy.err.ts` pins.
- *
- * ```ts
- * orderBy('owner/organisation/code')          // 2 to-one hops: compiles
- * orderBy('parent/parent/parent/name')        // 3 to-one hops: compiles, the default budget
- * orderBy('parent/parent/parent/parent/name') // 4 to-one hops: TS2345, past the budget
- * // Down[3] is 2, Down[1] is 0, and at 0 the path stops.
- * ```
- *
- * To allow a deeper path, raise the default `D` and move the pinned case to
- * `test/types/ok/`. Each extra unit multiplies the key strings TypeScript
- * builds, so compile time grows.
- */
-type Budget = 0 | 1 | 2 | 3;
-type Down = [never, 0, 1, 2, 3];
-/**
- * Every leaf path an embedded object of a DTO exposes: `address/city`,
- * `address/geo/lat`, `address/supplier/name`.
- *
- * The budget admits three object segments before the leaf, which is one more
- * than any embedded the dialect models nests.
- */
-export type EmbeddedPathKeys<T, D extends Budget = 2> = {
-    [K in EmbeddedObjectKeys<T>]: `${K}/${ScalarFieldKeys<NonNullable<T[K]>>}` | ([D] extends [0] ? never : `${K}/${EmbeddedPathKeys<NonNullable<T[K]>, Down[D]>}`);
-}[EmbeddedObjectKeys<T>];
-/**
- * Every selectable column of a DTO: its own scalar columns, plus the leaf paths
- * of its embedded objects. `_embedded` is excluded, and an embedded object is
- * not selectable on its own — only its leaves are.
- */
-export type FieldKey<T> = ScalarFieldKeys<T> | EmbeddedPathKeys<T>;
-/**
- * Every sortable key of a DTO: everything `FieldKey` admits, plus the same set
- * reached across up to three to-one relation hops (`owner/email`,
- * `owner/organisation/code`, `parent/parent/parent/name`).
- *
- * A to-many relation is never a sort key — the server has no single row to sort
- * by — so only `ToOneKeys` opens a hop.
- */
-export type OrderKey<T, D extends Budget = 3> = FieldKey<T> | ([D] extends [0] ? never : {
-    [K in ToOneKeys<T>]: `${K}/${OrderKey<Relation<T, K>, Down[D]>}`;
-}[ToOneKeys<T>]);
 /**
  * `Self` is the chain the call returns, so `expand.a(...).expand.b(...)`
  * chains at whatever level it is written.
@@ -69,4 +16,3 @@ export type OrderKey<T, D extends Budget = 3> = FieldKey<T> | ([D] extends [0] ?
 export type ExpandNamespace<T, Self> = {
     readonly [K in ExpandKey<T>]: (build?: (chain: ExpandChain<Relation<T, K>>) => unknown) => Self;
 };
-export {};

package/dist/module/query/domain/chain/itemChain.model.d.ts

@@ -5,11 +5,15 @@
  * `$count` and `$search` have nothing to act on. Only the shaping options are
  * offered.
  */
+import type { ColumnExpr, ScalarFieldKeys, SelectScope } from '../filter/scope.model';
 import type { QueryParams } from './chain.model';
-import type { ExpandNamespace, FieldKey } from './expandNamespace.model';
+import type { ExpandNamespace } from './expandNamespace.model';
 export interface ItemChain<T> {
     readonly expand: ExpandNamespace<T, ItemChain<T>>;
-    select(...keys: FieldKey<T>[]): ItemChain<T>;
+    /** Own columns, by name. */
+    select(...keys: ScalarFieldKeys<T>[]): ItemChain<T>;
+    /** Own columns and embedded leaves: `select((v) => [v.id, v.address.city])`. */
+    select(columns: (scope: SelectScope<T>) => ColumnExpr | readonly ColumnExpr[]): ItemChain<T>;
     toQueryString(): string;
     /**
      * The same query as separate parts, with the transport escaping undone, for

package/dist/module/query/domain/filter/scope.model.d.ts

@@ -92,3 +92,19 @@ export type Scope<T> = {
 } & {
     readonly [K in Exclude<ToManyKeys<T>, OwnKeys<T>>]: LambdaNamespace<Relation<T, K>>;
 };
+/**
+ * One column, as a `select` or `orderBy` callback returns it. A to-one
+ * relation reads as a `Scope` and a to-many as a `LambdaNamespace`, so neither
+ * fits.
+ */
+export type ColumnExpr = StringExpr<string> | NumberExpr<number | bigint> | DateExpr | BooleanExpr;
+/**
+ * What a `select` callback reads: own columns and embedded objects, never a
+ * relation. A relation column comes through `$expand`, so `owner/email` is
+ * not a `$select` path.
+ */
+export type SelectScope<T> = {
+    readonly [K in ScalarFieldKeys<T>]: ExprFor<T[K]>;
+} & {
+    readonly [K in EmbeddedObjectKeys<T>]: SelectScope<NonNullable<T[K]>>;
+};

package/dist/module/query/service/filter/filter.facade.d.ts

@@ -20,3 +20,7 @@ export declare const buildFilterPredicate: (build: (scope: unknown, operators: O
  * so an empty column list is rejected before the query is ever emitted.
  */
 export declare const pickSearchColumns: (term: string, columns: (scope: unknown) => Node | readonly Node[]) => SearchState;
+/** Run one `.orderBy()` callback and return the path of the column it picks. */
+export declare const pickOrderColumn: (column: (scope: unknown) => unknown) => string;
+/** Run one `.select()` callback and return the paths of the columns it picks. */
+export declare const pickSelectColumns: (columns: (scope: unknown) => unknown) => string[];

package/dist/module/query/service/filter/filter.facade.js

@@ -1,15 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pickSearchColumns = exports.buildFilterPredicate = exports.raw = exports.mindatetime = exports.maxdatetime = exports.now = exports.not = exports.or = exports.and = void 0;
+exports.pickSelectColumns = exports.pickOrderColumn = exports.pickSearchColumns = exports.buildFilterPredicate = exports.raw = exports.mindatetime = exports.maxdatetime = exports.now = exports.not = exports.or = exports.and = void 0;
 /**
  * The only file that other code imports from the filter stage: the combinators
- * a caller writes, and the two entry functions that run a caller's callback
+ * a caller writes, and the four entry functions that run a caller's callback
  * against a fresh scope.
  *
  * A scope proxy never leaves this stage as itself. `buildFilterPredicate`
  * hands one to the callback and returns the predicate that comes back;
- * `pickSearchColumns` hands one out and returns plain text. Nothing outside
- * the stage therefore has to know that a scope is a Proxy at all.
+ * `pickSearchColumns`, `pickOrderColumn` and `pickSelectColumns` hand one out
+ * and return plain text. Nothing outside the stage therefore has to know that
+ * a scope is a Proxy at all.
  */
 const escape_util_1 = require("../../../common/util/escape.util");
 const invalidFilter_exception_1 = require("../../exception/invalidFilter.exception");
@@ -59,21 +60,28 @@ exports.buildFilterPredicate = buildFilterPredicate;
  * so an empty column list is rejected before the query is ever emitted.
  */
 const pickSearchColumns = (term, columns) => {
-    const picked = columns((0, scopeProxy_util_1.rootScope)());
-    const list = Array.isArray(picked) ? picked : [picked];
-    if (list.length === 0)
+    const paths = columnPaths(columns((0, scopeProxy_util_1.rootScope)()), '$searchColumns');
+    if (paths.length === 0)
         throw new invalidFilter_exception_1.InvalidFilterError('$search needs at least one column');
-    return {
-        term: (0, escape_util_1.escapeBareValue)(term),
-        columns: list.map(searchColumnPath),
-    };
+    return { term: (0, escape_util_1.escapeBareValue)(term), columns: paths };
 };
 exports.pickSearchColumns = pickSearchColumns;
-/** `$searchColumns` takes plain property paths — a function call is a 400. */
-const searchColumnPath = (value) => {
+/** Run one `.orderBy()` callback and return the path of the column it picks. */
+const pickOrderColumn = (column) => columnPath(column((0, scopeProxy_util_1.rootScope)()), '$orderby');
+exports.pickOrderColumn = pickOrderColumn;
+/** Run one `.select()` callback and return the paths of the columns it picks. */
+const pickSelectColumns = (columns) => columnPaths(columns((0, scopeProxy_util_1.rootScope)()), '$select');
+exports.pickSelectColumns = pickSelectColumns;
+/** One column or a list of them, as a callback returns it. */
+const columnPaths = (picked, option) => (Array.isArray(picked) ? picked : [picked]).map((column) => columnPath(column, option));
+/**
+ * `$searchColumns`, `$orderby` and `$select` take plain property paths: a
+ * function call is a 400.
+ */
+const columnPath = (value, option) => {
     const node = (0, scopeProxy_util_1.nodeOf)(value);
     if (node === undefined || node.text === '' || /[(),']/.test(node.text))
-        throw new invalidFilter_exception_1.InvalidFilterError('$searchColumns takes property paths only, not expressions');
+        throw new invalidFilter_exception_1.InvalidFilterError(`${option} takes property paths only, not expressions`);
     return node.text;
 };
 //# sourceMappingURL=filter.facade.js.map

package/dist/module/query/service/filter/filter.facade.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter.facade.js","sourceRoot":"","sources":["../../../../../src/module/query/service/filter/filter.facade.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACH,kEAAmE;AAKnE,qFAA6E;AAC7E,iEAAgE;AAChE,qEAA0E;AAC1E,uEAI2C;AAEpC,MAAM,GAAG,GAAG,CAAC,GAAG,UAAuB,EAAa,EAAE,CAC5D,IAAA,wBAAO,EAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AADf,QAAA,GAAG,OACY;AACrB,MAAM,EAAE,GAAG,CAAC,GAAG,UAAuB,EAAa,EAAE,CAC3D,IAAA,wBAAO,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AADd,QAAA,EAAE,MACY;AACpB,MAAM,GAAG,GAAG,CAAC,SAAoB,EAAa,EAAE;AACtD,wEAAwE;AACxE,IAAI,8BAAa,CAAC,QAAQ,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC;AAFjC,QAAA,GAAG,OAE8B;AACvC,MAAM,GAAG,GAAG,GAAa,EAAE,CAAC,IAAA,8BAAY,EAAC,IAAI,6BAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;AAAnE,QAAA,GAAG,OAAgE;AACzE,MAAM,WAAW,GAAG,GAAa,EAAE,CACzC,IAAA,8BAAY,EAAC,IAAI,6BAAc,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;AADzC,QAAA,WAAW,eAC8B;AAC/C,MAAM,WAAW,GAAG,GAAa,EAAE,CACzC,IAAA,8BAAY,EAAC,IAAI,6BAAc,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;AADzC,QAAA,WAAW,eAC8B;AAC/C,MAAM,GAAG,GAAG,CAAC,eAAuB,EAAa,EAAE,CACzD,IAAI,8BAAa,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;AAD7B,QAAA,GAAG,OAC0B;AAE1C,oDAAoD;AACpD,MAAM,SAAS,GAAc;IAC5B,GAAG,EAAH,WAAG;IACH,EAAE,EAAF,UAAE;IACF,GAAG,EAAH,WAAG;IACH,GAAG,EAAH,WAAG;IACH,WAAW,EAAX,mBAAW;IACX,WAAW,EAAX,mBAAW;IACX,GAAG,EAAH,WAAG;CACH,CAAC;AAEF;;;;GAIG;AACI,MAAM,oBAAoB,GAAG,CACnC,KAA0D,EAC9C,EAAE;IACd,MAAM,SAAS,GAAG,KAAK,CAAC,IAAA,2BAAS,GAAE,EAAE,SAAS,CAAC,CAAC;IAChD,IAAI,CAAC,CAAC,SAAS,YAAY,8BAAa,CAAC;QACxC,MAAM,IAAI,4CAAkB,CAC3B,8DAA8D,CAC9D,CAAC;IACH,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AATW,QAAA,oBAAoB,wBAS/B;AAEF;;;GAGG;AACI,MAAM,iBAAiB,GAAG,CAChC,IAAY,EACZ,OAAmD,EACrC,EAAE;IAChB,MAAM,MAAM,GAAG,OAAO,CAAC,IAAA,2BAAS,GAAE,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAc,CAAC,CAAC;IAC/D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QACpB,MAAM,IAAI,4CAAkB,CAAC,mCAAmC,CAAC,CAAC;IACnE,OAAO;QACN,IAAI,EAAE,IAAA,6BAAe,EAAC,IAAI,CAAC;QAC3B,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC;KACnC,CAAC;AACH,CAAC,CAAC;AAZW,QAAA,iBAAiB,qBAY5B;AAEF,8EAA8E;AAC9E,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAU,EAAE;IACnD,MAAM,IAAI,GAAG,IAAA,wBAAM,EAAC,KAAK,CAAC,CAAC;IAC3B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QACrE,MAAM,IAAI,4CAAkB,CAC3B,2DAA2D,CAC3D,CAAC;IACH,OAAO,IAAI,CAAC,IAAI,CAAC;AAClB,CAAC,CAAC"}
+{"version":3,"file":"filter.facade.js","sourceRoot":"","sources":["../../../../../src/module/query/service/filter/filter.facade.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;GAUG;AACH,kEAAmE;AAKnE,qFAA6E;AAC7E,iEAAgE;AAChE,qEAA0E;AAC1E,uEAI2C;AAEpC,MAAM,GAAG,GAAG,CAAC,GAAG,UAAuB,EAAa,EAAE,CAC5D,IAAA,wBAAO,EAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AADf,QAAA,GAAG,OACY;AACrB,MAAM,EAAE,GAAG,CAAC,GAAG,UAAuB,EAAa,EAAE,CAC3D,IAAA,wBAAO,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AADd,QAAA,EAAE,MACY;AACpB,MAAM,GAAG,GAAG,CAAC,SAAoB,EAAa,EAAE;AACtD,wEAAwE;AACxE,IAAI,8BAAa,CAAC,QAAQ,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC;AAFjC,QAAA,GAAG,OAE8B;AACvC,MAAM,GAAG,GAAG,GAAa,EAAE,CAAC,IAAA,8BAAY,EAAC,IAAI,6BAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;AAAnE,QAAA,GAAG,OAAgE;AACzE,MAAM,WAAW,GAAG,GAAa,EAAE,CACzC,IAAA,8BAAY,EAAC,IAAI,6BAAc,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;AADzC,QAAA,WAAW,eAC8B;AAC/C,MAAM,WAAW,GAAG,GAAa,EAAE,CACzC,IAAA,8BAAY,EAAC,IAAI,6BAAc,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;AADzC,QAAA,WAAW,eAC8B;AAC/C,MAAM,GAAG,GAAG,CAAC,eAAuB,EAAa,EAAE,CACzD,IAAI,8BAAa,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;AAD7B,QAAA,GAAG,OAC0B;AAE1C,oDAAoD;AACpD,MAAM,SAAS,GAAc;IAC5B,GAAG,EAAH,WAAG;IACH,EAAE,EAAF,UAAE;IACF,GAAG,EAAH,WAAG;IACH,GAAG,EAAH,WAAG;IACH,WAAW,EAAX,mBAAW;IACX,WAAW,EAAX,mBAAW;IACX,GAAG,EAAH,WAAG;CACH,CAAC;AAEF;;;;GAIG;AACI,MAAM,oBAAoB,GAAG,CACnC,KAA0D,EAC9C,EAAE;IACd,MAAM,SAAS,GAAG,KAAK,CAAC,IAAA,2BAAS,GAAE,EAAE,SAAS,CAAC,CAAC;IAChD,IAAI,CAAC,CAAC,SAAS,YAAY,8BAAa,CAAC;QACxC,MAAM,IAAI,4CAAkB,CAC3B,8DAA8D,CAC9D,CAAC;IACH,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AATW,QAAA,oBAAoB,wBAS/B;AAEF;;;GAGG;AACI,MAAM,iBAAiB,GAAG,CAChC,IAAY,EACZ,OAAmD,EACrC,EAAE;IAChB,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,IAAA,2BAAS,GAAE,CAAC,EAAE,gBAAgB,CAAC,CAAC;IAClE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QACrB,MAAM,IAAI,4CAAkB,CAAC,mCAAmC,CAAC,CAAC;IACnE,OAAO,EAAE,IAAI,EAAE,IAAA,6BAAe,EAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AACxD,CAAC,CAAC;AARW,QAAA,iBAAiB,qBAQ5B;AAEF,gFAAgF;AACzE,MAAM,eAAe,GAAG,CAAC,MAAmC,EAAU,EAAE,CAC9E,UAAU,CAAC,MAAM,CAAC,IAAA,2BAAS,GAAE,CAAC,EAAE,UAAU,CAAC,CAAC;AADhC,QAAA,eAAe,mBACiB;AAE7C,iFAAiF;AAC1E,MAAM,iBAAiB,GAAG,CAChC,OAAoC,EACzB,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,IAAA,2BAAS,GAAE,CAAC,EAAE,SAAS,CAAC,CAAC;AAF/C,QAAA,iBAAiB,qBAE8B;AAI5D,8DAA8D;AAC9D,MAAM,WAAW,GAAG,CAAC,MAAe,EAAE,MAAkB,EAAY,EAAE,CACrE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAC1D,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAC1B,CAAC;AAEH;;;GAGG;AACH,MAAM,UAAU,GAAG,CAAC,KAAc,EAAE,MAAkB,EAAU,EAAE;IACjE,MAAM,IAAI,GAAG,IAAA,wBAAM,EAAC,KAAK,CAAC,CAAC;IAC3B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QACrE,MAAM,IAAI,4CAAkB,CAC3B,GAAG,MAAM,6CAA6C,CACtD,CAAC;IACH,OAAO,IAAI,CAAC,IAAI,CAAC;AAClB,CAAC,CAAC"}

package/dist/module/query/service/queryChain.service.d.ts

@@ -3,9 +3,10 @@
  * one member per OData system query option. This file also exports the two
  * factories a caller starts from: `odataQuery()` and `odataItem()`.
  *
- * Each member only writes to `this.queryState`. `buildFilterPredicate()` and
- * `pickSearchColumns()` in `service/filter/filter.facade.ts` build the filter
- * and search text. `emitQueryString()` and `emitQueryParams()` in
+ * Each member only writes to `this.queryState`. `buildFilterPredicate()`,
+ * `pickSearchColumns()`, `pickOrderColumn()` and `pickSelectColumns()` in
+ * `service/filter/filter.facade.ts` build the filter, search, sort and select
+ * text. `emitQueryString()` and `emitQueryParams()` in
  * `service/emit/emit.facade.ts` print the state. A change to the printed
  * query therefore does not change this class, and a change to this class does
  * not change how the query is printed.
@@ -37,10 +38,10 @@ export declare class QueryChainService {
      * `Proxy` works here.
      */
     get expand(): unknown;
-    select(...keys: string[]): this;
+    select(...keys: string[] | [(scope: unknown) => unknown]): this;
     filter(build: (scope: unknown, operators: Operators) => Predicate): this;
     search(term: string, columns: (scope: unknown) => Node | readonly Node[]): this;
-    orderBy(key: string, direction?: 'asc' | 'desc'): this;
+    orderBy(key: string | ((scope: unknown) => unknown), direction?: 'asc' | 'desc'): this;
     top(count: number): this;
     skip(count: number): this;
     count(on?: boolean): this;

package/dist/module/query/service/queryChain.service.js

@@ -47,7 +47,10 @@ class QueryChainService {
         });
     }
     select(...keys) {
-        this.queryState.select.push(...keys);
+        const [first] = keys;
+        this.queryState.select.push(...(typeof first === 'function'
+            ? (0, filter_facade_1.pickSelectColumns)(first)
+            : keys));
         return this;
     }
     filter(build) {
@@ -59,7 +62,8 @@ class QueryChainService {
         return this;
     }
     orderBy(key, direction = 'asc') {
-        this.queryState.orderBy.push(`${key} ${direction}`);
+        const path = typeof key === 'string' ? key : (0, filter_facade_1.pickOrderColumn)(key);
+        this.queryState.orderBy.push(`${path} ${direction}`);
         return this;
     }
     top(count) {

package/dist/module/query/service/queryChain.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"queryChain.service.js","sourceRoot":"","sources":["../../../../src/module/query/service/queryChain.service.ts"],"names":[],"mappings":";;;AAwBA,kFAA0E;AAC1E,gFAAwE;AACxE,oDAAsE;AACtE,0DAGgC;AAEhC,MAAa,iBAAiB;IACpB,UAAU,GAAe;QACjC,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;KACX,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,IAAI,MAAM;QACT,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAA4B,EAAE;YAChE,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;gBAC1B,IAAI,OAAO,QAAQ,KAAK,QAAQ;oBAAE,OAAO,SAAS,CAAC;gBACnD,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,QAAQ;oBAC/C,MAAM,IAAI,0CAAiB,CAAC,QAAQ,CAAC,CAAC;gBACvC,IAAI,QAAQ,KAAK,aAAa;oBAAE,OAAO,SAAS,CAAC;gBACjD,OAAO,CAAC,KAA6C,EAAE,EAAE;oBACxD,MAAM,KAAK,GAAG,IAAI,iBAAiB,EAAE,CAAC;oBACtC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;oBACf,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC;wBAC3B,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE,KAAK,CAAC,UAAU;qBAC5B,CAAC,CAAC;oBACH,OAAO,IAAI,CAAC;gBACb,CAAC,CAAC;YACH,CAAC;YACD,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,QAAQ,KAAK,QAAQ;SACxD,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,GAAG,IAAc;QACvB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,CAAC,KAA0D;QAChE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,oCAAoB,EAAC,KAAK,CAAC,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,CACL,IAAY,EACZ,OAAmD;QAEnD,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,IAAA,iCAAiB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACb,CAAC;IAED,OAAO,CAAC,GAAW,EAAE,YAA4B,KAAK;QACrD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,SAAS,EAAE,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,GAAG,CAAC,KAAa;QAChB,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,CAAC,KAAa;QACjB,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,KAAK,CAAC,EAAE,GAAG,IAAI;QACd,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,aAAa;QACZ,OAAO,IAAA,6BAAe,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED,QAAQ;QACP,OAAO,IAAA,6BAAe,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;CACD;AAtFD,8CAsFC;AAED,yFAAyF;AACzF,MAAM,aAAa,GAAG,CAAC,IAAoB,EAAE,KAAa,EAAU,EAAE;IACrE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC;QAC5C,MAAM,IAAI,4CAAkB,CAC3B,GAAG,KAAK,mBAAmB,IAAI,gDAAgD,EAC/E,IAAI,CACJ,CAAC;IACH,OAAO,KAAK,CAAC;AACd,CAAC,CAAC;AAEF,wDAAwD;AACjD,MAAM,UAAU,GAAG,GAAgB,EAAE,CAC3C,IAAI,iBAAiB,EAAyB,CAAC;AADnC,QAAA,UAAU,cACyB;AAEhD,2DAA2D;AACpD,MAAM,SAAS,GAAG,GAAoB,EAAE,CAC9C,IAAI,iBAAiB,EAA6B,CAAC;AADvC,QAAA,SAAS,aAC8B"}
+{"version":3,"file":"queryChain.service.js","sourceRoot":"","sources":["../../../../src/module/query/service/queryChain.service.ts"],"names":[],"mappings":";;;AAyBA,kFAA0E;AAC1E,gFAAwE;AACxE,oDAAsE;AACtE,0DAKgC;AAEhC,MAAa,iBAAiB;IACpB,UAAU,GAAe;QACjC,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;KACX,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,IAAI,MAAM;QACT,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAA4B,EAAE;YAChE,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;gBAC1B,IAAI,OAAO,QAAQ,KAAK,QAAQ;oBAAE,OAAO,SAAS,CAAC;gBACnD,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,QAAQ;oBAC/C,MAAM,IAAI,0CAAiB,CAAC,QAAQ,CAAC,CAAC;gBACvC,IAAI,QAAQ,KAAK,aAAa;oBAAE,OAAO,SAAS,CAAC;gBACjD,OAAO,CAAC,KAA6C,EAAE,EAAE;oBACxD,MAAM,KAAK,GAAG,IAAI,iBAAiB,EAAE,CAAC;oBACtC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;oBACf,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC;wBAC3B,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE,KAAK,CAAC,UAAU;qBAC5B,CAAC,CAAC;oBACH,OAAO,IAAI,CAAC;gBACb,CAAC,CAAC;YACH,CAAC;YACD,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,QAAQ,KAAK,QAAQ;SACxD,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,GAAG,IAA8C;QACvD,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAC1B,GAAG,CAAC,OAAO,KAAK,KAAK,UAAU;YAC9B,CAAC,CAAC,IAAA,iCAAiB,EAAC,KAAK,CAAC;YAC1B,CAAC,CAAE,IAAiB,CAAC,CACtB,CAAC;QACF,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,CAAC,KAA0D;QAChE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,oCAAoB,EAAC,KAAK,CAAC,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,CACL,IAAY,EACZ,OAAmD;QAEnD,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,IAAA,iCAAiB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACb,CAAC;IAED,OAAO,CACN,GAA2C,EAC3C,YAA4B,KAAK;QAEjC,MAAM,IAAI,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAA,+BAAe,EAAC,GAAG,CAAC,CAAC;QAClE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,SAAS,EAAE,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,GAAG,CAAC,KAAa;QAChB,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,CAAC,KAAa;QACjB,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,KAAK,CAAC,EAAE,GAAG,IAAI;QACd,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,aAAa;QACZ,OAAO,IAAA,6BAAe,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED,QAAQ;QACP,OAAO,IAAA,6BAAe,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;CACD;AA/FD,8CA+FC;AAED,yFAAyF;AACzF,MAAM,aAAa,GAAG,CAAC,IAAoB,EAAE,KAAa,EAAU,EAAE;IACrE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC;QAC5C,MAAM,IAAI,4CAAkB,CAC3B,GAAG,KAAK,mBAAmB,IAAI,gDAAgD,EAC/E,IAAI,CACJ,CAAC;IACH,OAAO,KAAK,CAAC;AACd,CAAC,CAAC;AAEF,wDAAwD;AACjD,MAAM,UAAU,GAAG,GAAgB,EAAE,CAC3C,IAAI,iBAAiB,EAAyB,CAAC;AADnC,QAAA,UAAU,cACyB;AAEhD,2DAA2D;AACpD,MAAM,SAAS,GAAG,GAAoB,EAAE,CAC9C,IAAI,iBAAiB,EAA6B,CAAC;AADvC,QAAA,SAAS,aAC8B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ballistix.digital/odata-query-builder",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Typed, fluent OData v4 query-string builder for the dialect @ballistix.digital/typeorm-extensions serves.",
   "license": "MIT",
   "repository": {