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

package/dist/index.d.ts

@@ -11,9 +11,9 @@ import type { ExceptionDetail } from './module/common/domain/exceptionDetail.mod
 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 { ItemChain } from './module/query/domain/chain/itemChain.model';
-import type { ProjectChain } from './module/query/domain/chain/projectChain.model';
 import type { BooleanExpr } from './module/query/domain/filter/booleanExpr.model';
 import type { Castable, CastResult, EdmTarget } from './module/query/domain/filter/castable.model';
 import type { Comparable } from './module/query/domain/filter/comparable.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, ExpandKey, ExpandNamespace, ExprFor, FieldKey, ItemChain, LambdaNamespace, Node, NumberExpr, Operators, OrderKey, OwnKeys, Predicate, PrimitiveArrayKeys, PrimitiveLambdaNamespace, ProjectChain, QueryParams, Relation, Scalar, ScalarFieldKeys, Scope, StringExpr, ToManyKeys, ToOneKeys, Unwrap, };
+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, };

package/dist/module/query/domain/chain/{projectChain.model.d.ts → expandChain.model.d.ts}

@@ -17,12 +17,12 @@ 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';
-export interface ProjectChain<T> {
-    readonly expand: ExpandNamespace<T, ProjectChain<T>>;
-    select(...keys: FieldKey<T>[]): ProjectChain<T>;
+export interface ExpandChain<T> {
+    readonly expand: ExpandNamespace<T, ExpandChain<T>>;
+    select(...keys: FieldKey<T>[]): 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.
      */
-    filter(build: (scope: Scope<T>, operators: Operators) => Predicate): ProjectChain<T>;
+    filter(build: (scope: Scope<T>, operators: Operators) => Predicate): ExpandChain<T>;
 }

package/dist/module/query/domain/chain/{projectChain.model.js → expandChain.model.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=projectChain.model.js.map
+//# sourceMappingURL=expandChain.model.js.map

package/dist/module/query/domain/chain/expandChain.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expandChain.model.js","sourceRoot":"","sources":["../../../../../src/module/query/domain/chain/expandChain.model.ts"],"names":[],"mappings":""}

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

@@ -6,7 +6,7 @@
  * relation reaches, with no build step and no `$metadata` document.
  */
 import type { EmbeddedObjectKeys, Relation, ScalarFieldKeys, ToManyKeys, ToOneKeys } from '../filter/scope.model';
-import type { ProjectChain } from './projectChain.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>;
 /**
@@ -15,7 +15,23 @@ export type ExpandKey<T> = ToOneKeys<T> | ToManyKeys<T>;
  * 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; a budget of 0 descends no further.
+ * 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];
@@ -51,6 +67,6 @@ export type OrderKey<T, D extends Budget = 3> = FieldKey<T> | ([D] extends [0] ?
  * chains at whatever level it is written.
  */
 export type ExpandNamespace<T, Self> = {
-    readonly [K in ExpandKey<T>]: (project?: (projection: ProjectChain<Relation<T, K>>) => unknown) => Self;
+    readonly [K in ExpandKey<T>]: (build?: (chain: ExpandChain<Relation<T, K>>) => unknown) => Self;
 };
 export {};

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

@@ -10,10 +10,10 @@
  * query therefore does not change this class, and a change to this class does
  * not change how the query is printed.
  *
- * `Chain<T>`, `ItemChain<T>` and `ProjectChain<T>` are three interfaces over
+ * `Chain<T>`, `ItemChain<T>` and `ExpandChain<T>` are three interfaces over
  * this one class. Only the type that a factory returns differs. `Chain<T>`
  * has every member. `ItemChain<T>` has `select`, `expand`, `toQueryString()`
- * and `toParams()`. `ProjectChain<T>` has `select`, `expand` and `filter`, the
+ * and `toParams()`. `ExpandChain<T>` has `select`, `expand` and `filter`, the
  * three options that the server accepts inside `$expand`. At runtime, every
  * instance has every member.
  */

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

@@ -33,9 +33,9 @@ class QueryChainService {
                     throw new reservedName_exception_1.ReservedNameError(property);
                 if (property === 'constructor')
                     return undefined;
-                return (projection) => {
+                return (build) => {
                     const child = new QueryChainService();
-                    projection?.(child);
+                    build?.(child);
                     this.queryState.expand.push({
                         name: property,
                         queryState: child.queryState,

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,UAAkD,EAAE,EAAE;oBAC7D,MAAM,KAAK,GAAG,IAAI,iBAAiB,EAAE,CAAC;oBACtC,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC;oBACpB,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":";;;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"}

package/package.json

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

package/dist/module/query/domain/chain/projectChain.model.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"projectChain.model.js","sourceRoot":"","sources":["../../../../../src/module/query/domain/chain/projectChain.model.ts"],"names":[],"mappings":""}