@ballistix.digital/odata-query-builder 0.7.0 → 0.9.0

package/dist/module/query/util/filter/literal.util.js

@@ -1,81 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.literal = exports.parenthesiseArithmetic = exports.ExpressionNode = void 0;
-/**
- * `ExpressionNode`, the node behind every non-boolean expression, and
- * `literal()`, which turns a JS value into the OData text of that literal.
- *
- * `parenthesiseArithmetic` wraps an arithmetic expression (`a add 1`) in
- * parentheses when it is used as an operand of another arithmetic operator
- * (`mul`), so `(a add 1) mul 2` parses the way the caller wrote it rather than
- * as `a add (1 mul 2)`.
- */
-const invalidFilter_exception_1 = require("../../exception/invalidFilter.exception");
-const escape_util_1 = require("./escape.util");
-const scopeProxy_util_1 = require("./scopeProxy.util");
-class ExpressionNode {
-    text;
-    depth;
-    arithmetic;
-    constructor(text, 
-    /** lambda nesting level, for deterministic alias letters */
-    depth, 
-    /** true for `a add 1`: needs parentheses as an operand of `mul`. */
-    arithmetic = false) {
-        this.text = text;
-        this.depth = depth;
-        this.arithmetic = arithmetic;
-    }
-}
-exports.ExpressionNode = ExpressionNode;
-/** `a add 1` used as an operand of `mul` must become `(a add 1)`. */
-const parenthesiseArithmetic = (node) => node.arithmetic ? `(${node.text})` : node.text;
-exports.parenthesiseArithmetic = parenthesiseArithmetic;
-const isLuxonLike = (value) => typeof value === 'object' &&
-    value !== null &&
-    typeof value.toISO === 'function';
-/**
- * @param allowNull `in()` accepts a null member (`in (2024,null)` is a legal
- * set test); every other position rejects it — `eq(null)` must look nothing
- * like "no filter", so `isNull()`/`isNotNull()` are the only way to test for null.
- * `undefined` is never a literal, in any position: it means "nothing was
- * passed", not "the value is null", and reaching this function with it is
- * only possible through an `any`/`as never` cast around the type layer.
- */
-const literal = (value, allowNull = false) => {
-    if (value === undefined)
-        throw new invalidFilter_exception_1.InvalidFilterError('undefined is not an OData literal; omit the comparison entirely, or use isNull()/isNotNull() to test for null');
-    if (value === null) {
-        if (allowNull)
-            return 'null';
-        throw new invalidFilter_exception_1.InvalidFilterError('null is not an OData literal here; use isNull()/isNotNull() to test for null, or in() to allow it as a set member');
-    }
-    const node = (0, scopeProxy_util_1.nodeOf)(value);
-    if (node)
-        return (0, exports.parenthesiseArithmetic)(node);
-    if (typeof value === 'string')
-        return (0, escape_util_1.quote)(value);
-    if (typeof value === 'boolean')
-        return value ? 'true' : 'false';
-    if (typeof value === 'bigint')
-        return value.toString();
-    if (typeof value === 'number') {
-        if (!Number.isFinite(value))
-            throw new invalidFilter_exception_1.InvalidFilterError(`${value} is not an OData number literal`, String(value));
-        return String(value);
-    }
-    if (value instanceof Date) {
-        if (Number.isNaN(value.getTime()))
-            throw new invalidFilter_exception_1.InvalidFilterError('an invalid Date has no ISO literal');
-        return (0, escape_util_1.quote)(value.toISOString());
-    }
-    if (isLuxonLike(value)) {
-        const isoText = value.toISO();
-        if (isoText === null)
-            throw new invalidFilter_exception_1.InvalidFilterError('an invalid DateTime has no ISO literal');
-        return (0, escape_util_1.quote)(isoText);
-    }
-    throw new invalidFilter_exception_1.InvalidFilterError(`${Object.prototype.toString.call(value)} is not an OData literal`);
-};
-exports.literal = literal;
-//# sourceMappingURL=literal.util.js.map

package/dist/module/query/util/filter/literal.util.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"literal.util.js","sourceRoot":"","sources":["../../../../../src/module/query/util/filter/literal.util.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;GAQG;AACH,qFAA6E;AAC7E,+CAAsC;AACtC,uDAA2C;AAE3C,MAAa,cAAc;IAEhB;IAEA;IAEA;IALV,YACU,IAAY;IACrB,4DAA4D;IACnD,KAAa;IACtB,oEAAoE;IAC3D,aAAsB,KAAK;QAJ3B,SAAI,GAAJ,IAAI,CAAQ;QAEZ,UAAK,GAAL,KAAK,CAAQ;QAEb,eAAU,GAAV,UAAU,CAAiB;IAClC,CAAC;CACJ;AARD,wCAQC;AAED,qEAAqE;AAC9D,MAAM,sBAAsB,GAAG,CAAC,IAAoB,EAAU,EAAE,CACtE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;AADnC,QAAA,sBAAsB,0BACa;AAEhD,MAAM,WAAW,GAAG,CAAC,KAAc,EAAuC,EAAE,CAC3E,OAAO,KAAK,KAAK,QAAQ;IACzB,KAAK,KAAK,IAAI;IACd,OAAQ,KAA6B,CAAC,KAAK,KAAK,UAAU,CAAC;AAE5D;;;;;;;GAOG;AACI,MAAM,OAAO,GAAG,CAAC,KAAc,EAAE,SAAS,GAAG,KAAK,EAAU,EAAE;IACpE,IAAI,KAAK,KAAK,SAAS;QACtB,MAAM,IAAI,4CAAkB,CAC3B,+GAA+G,CAC/G,CAAC;IACH,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACpB,IAAI,SAAS;YAAE,OAAO,MAAM,CAAC;QAC7B,MAAM,IAAI,4CAAkB,CAC3B,mHAAmH,CACnH,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,IAAA,wBAAM,EAAC,KAAK,CAAC,CAAC;IAC3B,IAAI,IAAI;QAAE,OAAO,IAAA,8BAAsB,EAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAA,mBAAK,EAAC,KAAK,CAAC,CAAC;IACnD,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;IAChE,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;IACvD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC1B,MAAM,IAAI,4CAAkB,CAC3B,GAAG,KAAK,iCAAiC,EACzC,MAAM,CAAC,KAAK,CAAC,CACb,CAAC;QACH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;IACD,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC3B,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAChC,MAAM,IAAI,4CAAkB,CAAC,oCAAoC,CAAC,CAAC;QACpE,OAAO,IAAA,mBAAK,EAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,OAAO,KAAK,IAAI;YACnB,MAAM,IAAI,4CAAkB,CAAC,wCAAwC,CAAC,CAAC;QACxE,OAAO,IAAA,mBAAK,EAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,IAAI,4CAAkB,CAC3B,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAClE,CAAC;AACH,CAAC,CAAC;AAtCW,QAAA,OAAO,WAsClB"}

package/dist/module/query/util/filter/scopeProxy.util.d.ts

@@ -1,22 +0,0 @@
-import { ExpressionNode } from './literal.util';
-/** The node behind a scope proxy, or `undefined` for a plain value. */
-export declare const nodeOf: (value: unknown) => ExpressionNode | undefined;
-/**
- * `createMember(node)` is a value; `createMember(node, parent, name)` is a
- * member of `parent` that has not yet decided whether it is a path segment or
- * a function call.
- *
- * The target is an arrow function so the proxy is callable. An arrow function
- * has no `prototype`, and its `name`/`length` are configurable, so no Proxy
- * invariant forces a value through — a DTO column called `name` or `length`
- * still reaches the trap.
- *
- * `v.name.eq('x')` on `rootScope()` gives `name eq 'x'`. See
- * docs/maintainer/architecture.md, How `Proxy` works here.
- */
-export declare const createMember: (node: ExpressionNode, parent?: ExpressionNode, name?: string) => any;
-/**
- * The filter scope of an entity: an empty path at lambda depth 0. An expanded
- * entity is filtered relative to itself, so it takes the same empty root.
- */
-export declare const rootScope: () => any;

package/dist/module/query/util/filter/scopeProxy.util.js

@@ -1,93 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.rootScope = exports.createMember = exports.nodeOf = void 0;
-/**
- * The JavaScript built-in class `Proxy` behind a filter scope: `createMember`, `rootScope`, and
- * `nodeOf` — the one place a node comes back out of a proxy.
- *
- * THE COLLISION PROBLEM AND ITS FIX
- * ---------------------------------
- * At runtime a property name carries no type, so `a.year` is ambiguous: the
- * `year()` date function, or a column actually called `year`. A single
- * "methods first, path second" Proxy has to guess, and guesses wrong on every
- * entity with a column named `year`, `name`, `length` or `date`.
- *
- * The fix: a property read NEVER resolves a function. Reading `x.foo` always
- * returns a *member* — a callable proxy that remembers (parent node, "foo").
- *   - Read further from it     -> "foo" was a path segment: `parent/foo`.
- *   - CALL it                  -> "foo" was a function: `foo(parent)`.
- * A path segment is never called and a function is never left uncalled, so the
- * two roles are told apart by syntax the caller already writes. A column named
- * `year` therefore works, and so does `year()` over a sibling column, in the
- * same expression.
- *
- * The node itself is reachable only through a Symbol, which no DTO key can be.
- *
- * The import back into `filterFunction.util.ts` is a real (not type-only)
- * cycle, and so is `literal.util.ts`'s import back into this file. Both are
- * safe because nothing here runs at module load: a trap body is entered when a
- * caller builds a filter, long after every module has finished loading.
- */
-const invalidFilter_exception_1 = require("../../exception/invalidFilter.exception");
-const reservedName_exception_1 = require("../../exception/reservedName.exception");
-const filterFunction_util_1 = require("./filterFunction.util");
-const literal_util_1 = require("./literal.util");
-/** The only key that reads a node. A DTO key can never be a symbol. */
-const NODE = Symbol('odata.node');
-/** The node behind a scope proxy, or `undefined` for a plain value. */
-const nodeOf = (value) => typeof value === 'function' || (typeof value === 'object' && value !== null)
-    ? value[NODE]
-    : undefined;
-exports.nodeOf = nodeOf;
-/**
- * `createMember(node)` is a value; `createMember(node, parent, name)` is a
- * member of `parent` that has not yet decided whether it is a path segment or
- * a function call.
- *
- * The target is an arrow function so the proxy is callable. An arrow function
- * has no `prototype`, and its `name`/`length` are configurable, so no Proxy
- * invariant forces a value through — a DTO column called `name` or `length`
- * still reaches the trap.
- *
- * `v.name.eq('x')` on `rootScope()` gives `name eq 'x'`. See
- * docs/maintainer/architecture.md, How `Proxy` works here.
- */
-const createMember = (node, parent, name) => 
-// The target is never invoked: the `apply` trap owns every call. It only
-// has to BE callable, so the Proxy accepts an `apply` trap at all.
-new Proxy(/* istanbul ignore next */ (() => undefined), {
-    get(_target, property) {
-        if (property === NODE)
-            return node;
-        if (typeof property !== 'string')
-            return undefined;
-        // Reserved names THROW rather than return undefined, so `await q`,
-        // `JSON.stringify(q)` and an implicit `${q}`/arithmetic coercion fail
-        // loudly instead of silently — the last two would otherwise reach
-        // `apply` as a call to a function named `toString`/`valueOf` that the
-        // OData function table does not know, a confusing error to land on.
-        if (property === 'then' ||
-            property === 'toJSON' ||
-            property === 'toString' ||
-            property === 'valueOf')
-            throw new reservedName_exception_1.ReservedNameError(property);
-        return (0, exports.createMember)(new literal_util_1.ExpressionNode(node.text ? `${node.text}/${property}` : property, node.depth), node, property);
-    },
-    apply(_target, _thisArgument, callArguments) {
-        if (parent === undefined || name === undefined)
-            throw new invalidFilter_exception_1.InvalidFilterError(`"${node.text}" is a property path, not a function`, node.text);
-        const method = (0, filterFunction_util_1.filterFunction)(name);
-        if (method === undefined)
-            throw new invalidFilter_exception_1.InvalidFilterError(`${name}() is not an OData filter function served by this API`, name);
-        return method(parent, callArguments);
-    },
-    has: (_target, property) => typeof property === 'string',
-});
-exports.createMember = createMember;
-/**
- * The filter scope of an entity: an empty path at lambda depth 0. An expanded
- * entity is filtered relative to itself, so it takes the same empty root.
- */
-const rootScope = () => (0, exports.createMember)(new literal_util_1.ExpressionNode('', 0));
-exports.rootScope = rootScope;
-//# sourceMappingURL=scopeProxy.util.js.map

package/dist/module/query/util/filter/scopeProxy.util.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"scopeProxy.util.js","sourceRoot":"","sources":["../../../../../src/module/query/util/filter/scopeProxy.util.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qFAA6E;AAC7E,mFAA2E;AAC3E,+DAAuD;AACvD,iDAAgD;AAEhD,uEAAuE;AACvE,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;AAElC,uEAAuE;AAChE,MAAM,MAAM,GAAG,CAAC,KAAc,EAA8B,EAAE,CACpE,OAAO,KAAK,KAAK,UAAU,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;IAC3E,CAAC,CAAG,KAAiC,CAAC,IAAI,CAAgC;IAC1E,CAAC,CAAC,SAAS,CAAC;AAHD,QAAA,MAAM,UAGL;AAEd;;;;;;;;;;;;GAYG;AACI,MAAM,YAAY,GAAG,CAC3B,IAAoB,EACpB,MAAuB,EACvB,IAAa,EACP,EAAE;AACR,yEAAyE;AACzE,mEAAmE;AACnE,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,CAAsB,EAAE;IAC5E,GAAG,CAAC,OAAO,EAAE,QAAQ;QACpB,IAAI,QAAQ,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QACnC,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QACnD,mEAAmE;QACnE,sEAAsE;QACtE,kEAAkE;QAClE,sEAAsE;QACtE,oEAAoE;QACpE,IACC,QAAQ,KAAK,MAAM;YACnB,QAAQ,KAAK,QAAQ;YACrB,QAAQ,KAAK,UAAU;YACvB,QAAQ,KAAK,SAAS;YAEtB,MAAM,IAAI,0CAAiB,CAAC,QAAQ,CAAC,CAAC;QACvC,OAAO,IAAA,oBAAY,EAClB,IAAI,6BAAc,CACjB,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,EACjD,IAAI,CAAC,KAAK,CACV,EACD,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IACD,KAAK,CAAC,OAAO,EAAE,aAAa,EAAE,aAAwB;QACrD,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS;YAC7C,MAAM,IAAI,4CAAkB,CAC3B,IAAI,IAAI,CAAC,IAAI,sCAAsC,EACnD,IAAI,CAAC,IAAI,CACT,CAAC;QACH,MAAM,MAAM,GAAG,IAAA,oCAAc,EAAC,IAAI,CAAC,CAAC;QACpC,IAAI,MAAM,KAAK,SAAS;YACvB,MAAM,IAAI,4CAAkB,CAC3B,GAAG,IAAI,uDAAuD,EAC9D,IAAI,CACJ,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACtC,CAAC;IACD,GAAG,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,OAAO,QAAQ,KAAK,QAAQ;CACxD,CAAC,CAAC;AA/CS,QAAA,YAAY,gBA+CrB;AAEJ;;;GAGG;AACI,MAAM,SAAS,GAAG,GAAQ,EAAE,CAAC,IAAA,oBAAY,EAAC,IAAI,6BAAc,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AAA/D,QAAA,SAAS,aAAsD"}