@kollors/deep-json-server 1.0.0-alpha.1 → 1.0.0-alpha.3

package/dist/src/query/filter.js

@@ -1,84 +1,86 @@
-import { isEqual, isObject, isSafeKey, toArray } from '../utils.js';
-const FIELD_OPERATOR_NAMES = ['contains', 'endsWith', 'eq', 'every', 'gt', 'gte', 'in', 'lt', 'lte', 'ne', 'none', 'not', 'some', 'startsWith'];
-const FIELD_OPERATORS = new Set(FIELD_OPERATOR_NAMES);
-const NUMBER_PATTERN = /^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/;
-const isFieldOperator = (value) => FIELD_OPERATORS.has(value);
-const isFilterEqual = (left, right) => {
-    if (isEqual(left, right)) {
-        return true;
-    }
-    if (typeof left === 'number' && typeof right === 'string' && NUMBER_PATTERN.test(right)) {
-        // Query parameters are strings, so numeric strings must match stored numbers.
-        return left === Number(right);
-    }
-    return typeof right === 'number' && typeof left === 'string' && NUMBER_PATTERN.test(left) && right === Number(left);
-};
-const isComparable = (value) => typeof value === 'number' || typeof value === 'string';
-const matchesOperator = (field, operator, expectedValue) => {
-    switch (operator) {
-        case 'contains':
-            return typeof field === 'string' ? field.toLowerCase().includes(String(expectedValue).toLowerCase()) : Array.isArray(field) && field.some((value) => isFilterEqual(value, expectedValue));
-        case 'endsWith':
-            return typeof field === 'string' && field.toLowerCase().endsWith(String(expectedValue).toLowerCase());
-        case 'eq':
-            return isFilterEqual(field, expectedValue);
-        case 'every':
-            return Array.isArray(field) && field.every((value) => matchesValue(value, expectedValue));
-        case 'gt':
-            return isComparable(field) && isComparable(expectedValue) && field > expectedValue;
-        case 'gte':
-            return isComparable(field) && isComparable(expectedValue) && field >= expectedValue;
-        case 'in': {
-            const expectedValues = toArray(expectedValue);
-            return Array.isArray(field)
-                ? field.some((value) => expectedValues.some((expectedItem) => isFilterEqual(value, expectedItem)))
-                : expectedValues.some((expectedItem) => isFilterEqual(field, expectedItem));
+import { isEqual, isObject } from '../utils.js';
+import { operatorsFor } from './contract.js';
+import { badQuery, childrenOf } from './options.js';
+const comparable = (value) => typeof value === 'string' || typeof value === 'number';
+const equal = (left, right) => isEqual(left, right);
+function condition(node, input, depth) {
+    if (!isObject(input) || depth > 32)
+        badQuery('Field filter must contain operators with depth at most 32');
+    if (!node.many && (node.relation || node.base === 'object'))
+        return compileWhere(node, input, depth);
+    const operators = operatorsFor(node);
+    const predicates = Object.entries(input).map(([operator, value]) => {
+        const operand = operators[operator];
+        if (!Object.hasOwn(operators, operator))
+            badQuery(`Invalid operator ${operator} for ${node.type}`);
+        if (operand === 'condition') {
+            const nested = condition(node, value, depth + 1);
+            return (field) => !nested(field);
         }
-        case 'lt':
-            return isComparable(field) && isComparable(expectedValue) && field < expectedValue;
-        case 'lte':
-            return isComparable(field) && isComparable(expectedValue) && field <= expectedValue;
-        case 'ne':
-            return !isFilterEqual(field, expectedValue);
-        case 'none':
-            return Array.isArray(field) && !field.some((value) => matchesValue(value, expectedValue));
-        case 'not':
-            return !matchesValue(field, expectedValue);
-        case 'some':
-            return Array.isArray(field) && field.some((value) => matchesValue(value, expectedValue));
-        case 'startsWith':
-            return typeof field === 'string' && field.toLowerCase().startsWith(String(expectedValue).toLowerCase());
-        default:
-            return false;
-    }
-};
-function matchesValue(field, condition) {
-    if (!isObject(condition)) {
-        return isFilterEqual(field, condition);
-    }
-    const conditionEntries = Object.entries(condition);
-    const operatorEntries = conditionEntries.filter((entry) => isFieldOperator(entry[0]));
-    const nestedEntries = conditionEntries.filter(([key]) => !isFieldOperator(key));
-    if (!operatorEntries.every(([operator, expectedValue]) => matchesOperator(field, operator, expectedValue))) {
-        return false;
-    }
-    return nestedEntries.length === 0 || (isObject(field) && matchesWhere(field, Object.fromEntries(nestedEntries)));
-}
-export function matchesWhere(value, where) {
-    if (!isObject(value) || !isObject(where)) {
-        return false;
-    }
-    return Object.entries(where).every(([key, condition]) => {
-        if (key === 'and') {
-            return Array.isArray(condition) && condition.every((nestedWhere) => matchesWhere(value, nestedWhere));
+        if (operand === 'element') {
+            const nested = condition({ ...node, many: false }, value, depth + 1);
+            return (field) => Array.isArray(field) && (operator === 'every' ? field.every(nested) : operator === 'none' ? !field.some(nested) : field.some(nested));
+        }
+        const values = operand === 'values' ? value : [value];
+        if (!Array.isArray(values))
+            badQuery(`Invalid value for ${operator}`);
+        const nullable = ['eq', 'ne', 'in'].includes(operator);
+        for (const candidate of values) {
+            if (candidate === null && nullable)
+                continue;
+            const base = operand === 'text' ? 'string' : node.base;
+            if (typeof candidate !== base || (typeof candidate === 'number' && !Number.isFinite(candidate)))
+                badQuery(`Invalid value for ${operator}`);
+            if ((operand === 'value' || operand === 'values') && node.enum && !node.enum.some((v) => equal(v, candidate)))
+                badQuery(`Invalid enum value for ${operator}`);
+        }
+        switch (operator) {
+            case 'eq':
+                return (field) => equal(field, value);
+            case 'ne':
+                return (field) => !equal(field, value);
+            case 'in':
+                return (field) => (Array.isArray(field) ? field : [field]).some((item) => values.some((v) => equal(item, v)));
+            case 'contains':
+                return (field) => (typeof field === 'string' ? field.toLowerCase().includes(String(value).toLowerCase()) : Array.isArray(field) && field.some((v) => equal(v, value)));
+            case 'startsWith':
+                return (field) => typeof field === 'string' && field.toLowerCase().startsWith(String(value).toLowerCase());
+            case 'endsWith':
+                return (field) => typeof field === 'string' && field.toLowerCase().endsWith(String(value).toLowerCase());
+            case 'gt':
+                return (field) => comparable(field) && comparable(value) && field > value;
+            case 'gte':
+                return (field) => comparable(field) && comparable(value) && field >= value;
+            case 'lt':
+                return (field) => comparable(field) && comparable(value) && field < value;
+            default:
+                return (field) => comparable(field) && comparable(value) && field <= value;
         }
-        if (key === 'or') {
-            return Array.isArray(condition) && condition.length > 0 && condition.some((nestedWhere) => matchesWhere(value, nestedWhere));
+    });
+    return (value) => predicates.every((predicate) => predicate(value));
+}
+export function compileWhere(node, input, depth = 0) {
+    if (!isObject(input) || depth > 32)
+        badQuery('where must be an object with depth at most 32');
+    const predicates = Object.entries(input).map(([key, value]) => {
+        if (key === 'and' || key === 'or') {
+            if (!Array.isArray(value) || (key === 'or' && !value.length))
+                badQuery(`Invalid ${key}`);
+            const nested = value.map((item) => compileWhere(node, item, depth + 1));
+            return (field) => (key === 'and' ? nested.every((p) => p(field)) : nested.some((p) => p(field)));
         }
         if (key === 'not') {
-            return isObject(condition) && !matchesWhere(value, condition);
+            const nested = compileWhere(node, value, depth + 1);
+            return (field) => !nested(field);
         }
-        return isSafeKey(key) && matchesValue(value[key], condition);
+        const child = childrenOf(node)[key];
+        if (!Object.hasOwn(childrenOf(node), key) || child.writeOnly)
+            badQuery(`Unknown or inaccessible filter field ${key}`);
+        if (child.mixed)
+            badQuery(`Field ${key} has inconsistent types; provide an explicit schema`);
+        const nested = condition(child, value, depth + 1);
+        return (field) => isObject(field) && nested(Object.hasOwn(field, key) ? field[key] : undefined);
     });
+    return (value) => isObject(value) && predicates.every((predicate) => predicate(value));
 }
 //# sourceMappingURL=filter.js.map

package/dist/src/query/filter.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter.js","sourceRoot":"","sources":["../../../src/query/filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEpE,MAAM,oBAAoB,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAU,CAAC;AAIzJ,MAAM,eAAe,GAAG,IAAI,GAAG,CAAS,oBAAoB,CAAC,CAAC;AAC9D,MAAM,cAAc,GAAG,+CAA+C,CAAC;AAEvE,MAAM,eAAe,GAAG,CAAC,KAAa,EAA0B,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AAE9F,MAAM,aAAa,GAAG,CAAC,IAAa,EAAE,KAAc,EAAW,EAAE;IAC/D,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACxF,8EAA8E;QAC9E,OAAO,IAAI,KAAK,MAAM,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC;AACtH,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAc,EAA4B,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAE1H,MAAM,eAAe,GAAG,CAAC,KAAc,EAAE,QAAuB,EAAE,aAAsB,EAAW,EAAE;IACnG,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,UAAU;YACb,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;QAC5L,KAAK,UAAU;YACb,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QACxG,KAAK,IAAI;YACP,OAAO,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAC7C,KAAK,OAAO;YACV,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;QAC5F,KAAK,IAAI;YACP,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,aAAa,CAAC,IAAI,KAAK,GAAG,aAAa,CAAC;QACrF,KAAK,KAAK;YACR,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,aAAa,CAAC,IAAI,KAAK,IAAI,aAAa,CAAC;QACtF,KAAK,IAAI,EAAE,CAAC;YACV,MAAM,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;YAE9C,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBACzB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;gBAClG,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;QAChF,CAAC;QACD,KAAK,IAAI;YACP,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,aAAa,CAAC,IAAI,KAAK,GAAG,aAAa,CAAC;QACrF,KAAK,KAAK;YACR,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,aAAa,CAAC,IAAI,KAAK,IAAI,aAAa,CAAC;QACtF,KAAK,IAAI;YACP,OAAO,CAAC,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAC9C,KAAK,MAAM;YACT,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;QAC5F,KAAK,KAAK;YACR,OAAO,CAAC,YAAY,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAC7C,KAAK,MAAM;YACT,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;QAC3F,KAAK,YAAY;YACf,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1G;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC,CAAC;AAEF,SAAS,YAAY,CAAC,KAAc,EAAE,SAAkB;IACtD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACzB,OAAO,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACnD,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAqC,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzH,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC;IAEhF,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC;QAC3G,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,aAAa,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AACnH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAc,EAAE,KAAc;IACzD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE;QACtD,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC;QACxG,CAAC;QAED,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC;QAC/H,CAAC;QAED,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;YAClB,OAAO,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAChE,CAAC;QAED,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"filter.js","sourceRoot":"","sources":["../../../src/query/filter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAGpD,MAAM,UAAU,GAAG,CAAC,KAAc,EAA4B,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AACxH,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,KAAc,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACtE,SAAS,SAAS,CAAC,IAAU,EAAE,KAAc,EAAE,KAAa;IAC1D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,EAAE;QAAE,QAAQ,CAAC,2DAA2D,CAAC,CAAC;IAC1G,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC;QAAE,OAAO,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACrG,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAa,EAAE;QAC5E,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC;YAAE,QAAQ,CAAC,oBAAoB,QAAQ,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QACnG,IAAI,OAAO,KAAK,WAAW,EAAE,CAAC;YAC5B,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YACjD,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QACD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YACrE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1J,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACtD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,QAAQ,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAC;QACtE,MAAM,QAAQ,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACvD,KAAK,MAAM,SAAS,IAAI,MAAM,EAAE,CAAC;YAC/B,IAAI,SAAS,KAAK,IAAI,IAAI,QAAQ;gBAAE,SAAS;YAC7C,MAAM,IAAI,GAAG,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACvD,IAAI,OAAO,SAAS,KAAK,IAAI,IAAI,CAAC,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;gBAAE,QAAQ,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAC;YAC3I,IAAI,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;gBAAE,QAAQ,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC;QAChK,CAAC;QACD,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,IAAI;gBACP,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACxC,KAAK,IAAI;gBACP,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACzC,KAAK,IAAI;gBACP,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAChH,KAAK,UAAU;gBACb,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YACzK,KAAK,YAAY;gBACf,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAC7G,KAAK,UAAU;gBACb,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAC3G,KAAK,IAAI;gBACP,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,KAAK,CAAC;YAC5E,KAAK,KAAK;gBACR,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,KAAK,CAAC;YAC7E,KAAK,IAAI;gBACP,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,KAAK,CAAC;YAC5E;gBACE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,KAAK,CAAC;QAC/E,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AACtE,CAAC;AACD,MAAM,UAAU,YAAY,CAAC,IAAU,EAAE,KAAc,EAAE,KAAK,GAAG,CAAC;IAChE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,EAAE;QAAE,QAAQ,CAAC,+CAA+C,CAAC,CAAC;IAC9F,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAa,EAAE;QACvE,IAAI,GAAG,KAAK,KAAK,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;gBAAE,QAAQ,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC;YACzF,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;YACxE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACnG,CAAC;QACD,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;YAClB,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YACpD,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QACD,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,KAAK,CAAC,SAAS;YAAE,QAAQ,CAAC,wCAAwC,GAAG,EAAE,CAAC,CAAC;QACtH,IAAI,KAAK,CAAC,KAAK;YAAE,QAAQ,CAAC,SAAS,GAAG,qDAAqD,CAAC,CAAC;QAC7F,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;QAClD,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAClG,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AACzF,CAAC"}

package/dist/src/query/options.d.ts

@@ -1,4 +1,4 @@
-import type { Entity, Node } from '../model.js';
+import type { Node } from '../model.js';
 export interface Order {
     field: string;
     direction: 'ASC' | 'DESC';
@@ -12,20 +12,7 @@ export interface ListOptions {
     order?: Order[];
     pager?: Pager;
 }
-export interface Scope {
-    [key: string]: Scope | null;
-}
-export interface RestOptions extends ListOptions {
-    scope: Scope;
-    nested: Record<string, ListOptions>;
-}
-export declare const ownScope: Scope;
 export declare function badQuery(message: string): never;
-export declare function parseScope(value: unknown): Scope;
-export declare function parseRestOptions(query: unknown, list: boolean): RestOptions;
 export declare function childrenOf(node: Node): Record<string, Node>;
 export declare function nodeAt(node: Node, path: string, scalarOnly?: boolean): Node;
 export declare function sortableFields(node: Node, prefix?: string): string[];
-export declare function validateScope(node: Node, scope: Scope, depth?: number): void;
-export declare function validateNested(root: Node, scope: Scope, nested: Record<string, ListOptions>): void;
-export declare const selectionEntity: (entity: Entity, node: Node) => Entity;

package/dist/src/query/options.js

@@ -1,77 +1,7 @@
+import { domainError } from '../errors.js';
 import { pathParts } from '../model.js';
-import { createHttpError, isObject } from '../utils.js';
-export const ownScope = { '*': null };
 export function badQuery(message) {
-    throw createHttpError(400, message);
-}
-export function parseScope(value) {
-    if (value === undefined)
-        return ownScope;
-    if (typeof value !== 'string' || !value.length || value.length > 10000)
-        badQuery('scope must be a nonempty string of at most 10000 characters');
-    let index = 0;
-    function parse(depth) {
-        if (depth > 32)
-            badQuery('scope is too deep');
-        const result = Object.create(null);
-        while (index < value.length) {
-            const match = /^(\*|[A-Za-z][A-Za-z0-9_]*)/.exec(value.slice(index));
-            if (!match)
-                badQuery('Invalid scope syntax');
-            const key = match[1];
-            if (key !== '*')
-                pathParts(key);
-            index += key.length;
-            let child = null;
-            if (value[index] === '(') {
-                if (key === '*')
-                    badQuery('Wildcard cannot have a selection');
-                index++;
-                child = parse(depth + 1);
-                if (value[index++] !== ')')
-                    badQuery('Unclosed scope selection');
-            }
-            if (Object.hasOwn(result, key))
-                badQuery(`Duplicate scope field ${key}`);
-            result[key] = child;
-            if (value[index] !== ',')
-                break;
-            index++;
-            if (index === value.length)
-                badQuery('Trailing scope comma');
-        }
-        if (!Object.keys(result).length)
-            badQuery('Empty scope selection');
-        return result;
-    }
-    const result = parse(0);
-    if (index !== value.length)
-        badQuery('Invalid scope syntax');
-    return result;
-}
-export function parseRestOptions(query, list) {
-    if (!isObject(query))
-        badQuery('Invalid query');
-    const allowed = list ? ['scope', 'nested', 'where', 'order', 'pager'] : ['scope', 'nested'];
-    for (const key of Object.keys(query))
-        if (!allowed.includes(key))
-            badQuery(`Unknown query parameter ${key}`);
-    const result = { scope: parseScope(query.scope), nested: {} };
-    for (const key of ['where', 'order', 'pager', 'nested']) {
-        if (query[key] === undefined)
-            continue;
-        if (typeof query[key] !== 'string')
-            badQuery(`${key} must occur once and contain JSON`);
-        try {
-            result[key] = JSON.parse(query[key]);
-        }
-        catch {
-            badQuery(`Invalid JSON in ${key}`);
-        }
-    }
-    if (!isObject(result.nested))
-        badQuery('nested must be an object');
-    return result;
+    throw domainError('INVALID_QUERY', message);
 }
 export function childrenOf(node) {
     return node.relation?.root.children ?? node.children;
@@ -81,8 +11,10 @@ export function nodeAt(node, path, scalarOnly = false) {
     const parts = pathParts(path);
     parts.forEach((part, index) => {
         const child = childrenOf(current)[part];
-        if (!child || child.writeOnly)
+        if (!Object.hasOwn(childrenOf(current), part) || child.writeOnly)
             badQuery(`Unknown or inaccessible field ${path}`);
+        if (child.mixed)
+            badQuery(`Field ${path} has inconsistent types; provide an explicit schema`);
         if (scalarOnly && (child.many || child.relation || (index === parts.length - 1 && child.base === 'object')))
             badQuery(`Cannot sort by ${path}`);
         current = child;
@@ -91,45 +23,10 @@ export function nodeAt(node, path, scalarOnly = false) {
 }
 export function sortableFields(node, prefix = '') {
     return Object.entries(childrenOf(node)).flatMap(([key, child]) => {
-        if (child.writeOnly || child.many || child.relation)
+        if (child.writeOnly || child.mixed || child.many || child.relation)
             return [];
         const path = prefix + key;
         return child.base === 'object' ? sortableFields(child, `${path}.`) : [path];
     });
 }
-export function validateScope(node, scope, depth = 0) {
-    if (depth > 32)
-        badQuery('scope is too deep');
-    for (const [key, selection] of Object.entries(scope)) {
-        if (key === '*')
-            continue;
-        const child = childrenOf(node)[key];
-        if (!child || child.writeOnly)
-            badQuery(`Unknown or inaccessible scope field ${key}`);
-        if (selection) {
-            if (!child.relation && child.base !== 'object')
-                badQuery(`Scalar field ${key} cannot have a selection`);
-            validateScope(child, selection, depth + 1);
-        }
-    }
-}
-export function validateNested(root, scope, nested) {
-    for (const [path, options] of Object.entries(nested)) {
-        const node = nodeAt(root, path);
-        if (!node.many || (!node.relation && node.base !== 'object'))
-            badQuery(`nested.${path} must address an object list`);
-        if (!isObject(options) || Object.keys(options).some((k) => !['where', 'order', 'pager'].includes(k)))
-            badQuery(`Invalid nested options at ${path}`);
-        let current = root;
-        let selection = scope;
-        for (const key of pathParts(path)) {
-            const child = childrenOf(current)[key];
-            if (!Object.hasOwn(selection, key) && !(Object.hasOwn(selection, '*') && !child.relation))
-                badQuery(`nested path ${path} is not selected by scope`);
-            selection = Object.hasOwn(selection, key) ? (selection[key] ?? ownScope) : ownScope;
-            current = child;
-        }
-    }
-}
-export const selectionEntity = (entity, node) => node.relation ?? entity;
 //# sourceMappingURL=options.js.map

package/dist/src/query/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/query/options.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAqBxD,MAAM,CAAC,MAAM,QAAQ,GAAU,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AAC7C,MAAM,UAAU,QAAQ,CAAC,OAAe;IACtC,MAAM,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACtC,CAAC;AACD,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK;QAAE,QAAQ,CAAC,6DAA6D,CAAC,CAAC;IAChJ,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,SAAS,KAAK,CAAC,KAAa;QAC1B,IAAI,KAAK,GAAG,EAAE;YAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAU,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1C,OAAO,KAAK,GAAI,KAAgB,CAAC,MAAM,EAAE,CAAC;YACxC,MAAM,KAAK,GAAG,6BAA6B,CAAC,IAAI,CAAE,KAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YACjF,IAAI,CAAC,KAAK;gBAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;YAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACrB,IAAI,GAAG,KAAK,GAAG;gBAAE,SAAS,CAAC,GAAG,CAAC,CAAC;YAChC,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC;YACpB,IAAI,KAAK,GAAiB,IAAI,CAAC;YAC/B,IAAK,KAAgB,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC;gBACrC,IAAI,GAAG,KAAK,GAAG;oBAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;gBAC9D,KAAK,EAAE,CAAC;gBACR,KAAK,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;gBACzB,IAAK,KAAgB,CAAC,KAAK,EAAE,CAAC,KAAK,GAAG;oBAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;YAC/E,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;gBAAE,QAAQ,CAAC,yBAAyB,GAAG,EAAE,CAAC,CAAC;YACzE,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACpB,IAAK,KAAgB,CAAC,KAAK,CAAC,KAAK,GAAG;gBAAE,MAAM;YAC5C,KAAK,EAAE,CAAC;YACR,IAAI,KAAK,KAAM,KAAgB,CAAC,MAAM;gBAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;QAC3E,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM;YAAE,QAAQ,CAAC,uBAAuB,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM;QAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IAC7D,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,UAAU,gBAAgB,CAAC,KAAc,EAAE,IAAa;IAC5D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5F,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,QAAQ,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;IAC7G,MAAM,MAAM,GAAgB,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAC3E,KAAK,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAU,EAAE,CAAC;QACjE,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS;YAAE,SAAS;QACvC,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ;YAAE,QAAQ,CAAC,GAAG,GAAG,mCAAmC,CAAC,CAAC;QACxF,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAU,CAAC;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,QAAQ,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;QAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;AACvD,CAAC;AACD,MAAM,UAAU,MAAM,CAAC,IAAU,EAAE,IAAY,EAAE,UAAU,GAAG,KAAK;IACjE,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC5B,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,SAAS;YAAE,QAAQ,CAAC,iCAAiC,IAAI,EAAE,CAAC,CAAC;QACjF,IAAI,UAAU,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;YAAE,QAAQ,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC;QAChJ,OAAO,GAAG,KAAK,CAAC;IAClB,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC;AACjB,CAAC;AACD,MAAM,UAAU,cAAc,CAAC,IAAU,EAAE,MAAM,GAAG,EAAE;IACpD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC/D,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QAC/D,MAAM,IAAI,GAAG,MAAM,GAAG,GAAG,CAAC;QAC1B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;AACL,CAAC;AACD,MAAM,UAAU,aAAa,CAAC,IAAU,EAAE,KAAY,EAAE,KAAK,GAAG,CAAC;IAC/D,IAAI,KAAK,GAAG,EAAE;QAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC9C,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACrD,IAAI,GAAG,KAAK,GAAG;YAAE,SAAS;QAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,SAAS;YAAE,QAAQ,CAAC,uCAAuC,GAAG,EAAE,CAAC,CAAC;QACtF,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;gBAAE,QAAQ,CAAC,gBAAgB,GAAG,0BAA0B,CAAC,CAAC;YACxG,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;AACH,CAAC;AACD,MAAM,UAAU,cAAc,CAAC,IAAU,EAAE,KAAY,EAAE,MAAmC;IAC1F,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC;YAAE,QAAQ,CAAC,UAAU,IAAI,8BAA8B,CAAC,CAAC;QACrH,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAAE,QAAQ,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;QACpJ,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;YACvC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;gBAAE,QAAQ,CAAC,eAAe,IAAI,2BAA2B,CAAC,CAAC;YACpJ,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;YACpF,OAAO,GAAG,KAAK,CAAC;QAClB,CAAC;IACH,CAAC;AACH,CAAC;AACD,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,IAAU,EAAU,EAAE,CAAC,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC"}
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/query/options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAcxC,MAAM,UAAU,QAAQ,CAAC,OAAe;IACtC,MAAM,WAAW,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;AAC9C,CAAC;AACD,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;AACvD,CAAC;AACD,MAAM,UAAU,MAAM,CAAC,IAAU,EAAE,IAAY,EAAE,UAAU,GAAG,KAAK;IACjE,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC5B,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,SAAS;YAAE,QAAQ,CAAC,iCAAiC,IAAI,EAAE,CAAC,CAAC;QACpH,IAAI,KAAK,CAAC,KAAK;YAAE,QAAQ,CAAC,SAAS,IAAI,qDAAqD,CAAC,CAAC;QAC9F,IAAI,UAAU,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;YAAE,QAAQ,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC;QAChJ,OAAO,GAAG,KAAK,CAAC;IAClB,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC;AACjB,CAAC;AACD,MAAM,UAAU,cAAc,CAAC,IAAU,EAAE,MAAM,GAAG,EAAE;IACpD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC/D,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QAC9E,MAAM,IAAI,GAAG,MAAM,GAAG,GAAG,CAAC;QAC1B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/src/relation-metadata.d.ts

@@ -5,6 +5,5 @@ export interface RelationMetadata {
     sourceResource: string;
     targetResource: string;
 }
-export declare const getRelationKeys: (...names: string[]) => string[];
 export declare const resolveRelationResource: (resourceNames: string[], relation: string, sourceResource: string) => string | undefined;
 export declare const getRelationMetadata: (key: string, resourceNames: string[], sourceResource: string) => RelationMetadata | undefined;

package/dist/src/relation-metadata.js

@@ -1,6 +1,5 @@
 import { singularize } from './utils.js';
 const SELF_RELATIONS = new Set(['child', 'children', 'parent', 'parents']);
-export const getRelationKeys = (...names) => [...new Set(names.flatMap((name) => [`${name}Id`, `${name}Ids`]))];
 export const resolveRelationResource = (resourceNames, relation, sourceResource) => {
     const resource = resourceNames.find((resourceName) => resourceName === relation) ?? resourceNames.find((resourceName) => singularize(resourceName) === relation);
     if (resource != null) {

package/dist/src/relation-metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"relation-metadata.js","sourceRoot":"","sources":["../../src/relation-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AAU3E,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAG,KAAe,EAAY,EAAE,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,IAAI,EAAE,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpI,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,aAAuB,EAAE,QAAgB,EAAE,cAAsB,EAAsB,EAAE;IAC/H,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,KAAK,QAAQ,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,QAAQ,CAAC,CAAC;IAEjK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7G,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,GAAW,EAAE,aAAuB,EAAE,cAAsB,EAAgC,EAAE;IAChI,yEAAyE;IACzE,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAE1C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;IACnC,MAAM,MAAM,GAAG,MAAM,KAAK,KAAK,CAAC;IAChC,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAClI,MAAM,cAAc,GAAG,uBAAuB,CAAC,aAAa,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;IAE5F,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO;QACL,MAAM;QACN,YAAY;QACZ,mBAAmB,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc;QAC/F,cAAc;QACd,cAAc;KACf,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"relation-metadata.js","sourceRoot":"","sources":["../../src/relation-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AAU3E,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,aAAuB,EAAE,QAAgB,EAAE,cAAsB,EAAsB,EAAE;IAC/H,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,KAAK,QAAQ,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,QAAQ,CAAC,CAAC;IAEjK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7G,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,GAAW,EAAE,aAAuB,EAAE,cAAsB,EAAgC,EAAE;IAChI,yEAAyE;IACzE,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAE1C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;IACnC,MAAM,MAAM,GAAG,MAAM,KAAK,KAAK,CAAC;IAChC,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAClI,MAAM,cAAc,GAAG,uBAAuB,CAAC,aAAa,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;IAE5F,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO;QACL,MAAM;QACN,YAAY;QACZ,mBAAmB,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc;QAC/F,cAAc;QACd,cAAc;KACf,CAAC;AACJ,CAAC,CAAC"}

package/dist/src/rest/options.d.ts

@@ -0,0 +1,14 @@
+import type { Node } from '../model.js';
+import { type ListOptions } from '../query/options.js';
+export interface Scope {
+    [key: string]: Scope | null;
+}
+export interface RestOptions extends ListOptions {
+    scope: Scope;
+    nested: Record<string, ListOptions>;
+}
+export declare const ownScope: Scope;
+export declare function parseScope(value: unknown): Scope;
+export declare function parseRestOptions(query: unknown, list: boolean): RestOptions;
+export declare function validateScope(node: Node, scope: Scope, depth?: number): void;
+export declare function validateNested(root: Node, scope: Scope, nested: Record<string, ListOptions>): void;

package/dist/src/rest/options.js

@@ -0,0 +1,108 @@
+import { pathParts } from '../model.js';
+import { badQuery, childrenOf, nodeAt } from '../query/options.js';
+import { isObject } from '../utils.js';
+export const ownScope = { '*': null };
+export function parseScope(value) {
+    if (value === undefined)
+        return ownScope;
+    if (typeof value !== 'string' || !value.length || value.length > 10000)
+        badQuery('scope must be a nonempty string of at most 10000 characters');
+    let index = 0;
+    function parse(depth) {
+        if (depth > 32)
+            badQuery('scope is too deep');
+        const result = Object.create(null);
+        while (index < value.length) {
+            const match = /^(\*|[A-Za-z][A-Za-z0-9_]*)/.exec(value.slice(index));
+            if (!match)
+                badQuery('Invalid scope syntax');
+            const key = match[1];
+            if (key !== '*')
+                pathParts(key);
+            index += key.length;
+            let child = null;
+            if (value[index] === '(') {
+                if (key === '*')
+                    badQuery('Wildcard cannot have a selection');
+                index++;
+                child = parse(depth + 1);
+                if (value[index++] !== ')')
+                    badQuery('Unclosed scope selection');
+            }
+            if (Object.hasOwn(result, key))
+                badQuery(`Duplicate scope field ${key}`);
+            result[key] = child;
+            if (value[index] !== ',')
+                break;
+            index++;
+            if (index === value.length)
+                badQuery('Trailing scope comma');
+        }
+        if (!Object.keys(result).length)
+            badQuery('Empty scope selection');
+        return result;
+    }
+    const result = parse(0);
+    if (index !== value.length)
+        badQuery('Invalid scope syntax');
+    return result;
+}
+export function parseRestOptions(query, list) {
+    if (!isObject(query))
+        badQuery('Invalid query');
+    const allowed = list ? ['scope', 'nested', 'where', 'order', 'pager'] : ['scope', 'nested'];
+    for (const key of Object.keys(query))
+        if (!allowed.includes(key))
+            badQuery(`Unknown query parameter ${key}`);
+    const result = { scope: parseScope(query.scope), nested: {} };
+    for (const key of ['where', 'order', 'pager', 'nested']) {
+        if (query[key] === undefined)
+            continue;
+        if (typeof query[key] !== 'string')
+            badQuery(`${key} must occur once and contain JSON`);
+        try {
+            result[key] = JSON.parse(query[key]);
+        }
+        catch {
+            badQuery(`Invalid JSON in ${key}`);
+        }
+    }
+    if (!isObject(result.nested))
+        badQuery('nested must be an object');
+    return result;
+}
+export function validateScope(node, scope, depth = 0) {
+    if (depth > 32)
+        badQuery('scope is too deep');
+    for (const [key, selection] of Object.entries(scope)) {
+        if (key === '*')
+            continue;
+        const child = childrenOf(node)[key];
+        if (!Object.hasOwn(childrenOf(node), key) || child.writeOnly)
+            badQuery(`Unknown or inaccessible scope field ${key}`);
+        if (selection) {
+            if (!child.relation && child.base !== 'object')
+                badQuery(`Scalar field ${key} cannot have a selection`);
+            validateScope(child, selection, depth + 1);
+        }
+    }
+}
+export function validateNested(root, scope, nested) {
+    for (const [path, options] of Object.entries(nested)) {
+        const node = nodeAt(root, path);
+        if (!node.many || (!node.relation && node.base !== 'object'))
+            badQuery(`nested.${path} must address an object list`);
+        if (!isObject(options) || Object.keys(options).some((k) => !['where', 'order', 'pager'].includes(k)))
+            badQuery(`Invalid nested options at ${path}`);
+        let current = root;
+        let selection = scope;
+        for (const key of pathParts(path)) {
+            const child = childrenOf(current)[key];
+            if (!Object.hasOwn(selection, key) && !(Object.hasOwn(selection, '*') && !child.relation))
+                badQuery(`nested path ${path} is not selected by scope`);
+            selection = Object.hasOwn(selection, key) ? (selection[key] ?? ownScope) : ownScope;
+            current = child;
+        }
+    }
+}
+//# sourceMappingURL=options.js.map

package/dist/src/rest/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/rest/options.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAoB,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAQvC,MAAM,CAAC,MAAM,QAAQ,GAAU,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AAC7C,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK;QAAE,QAAQ,CAAC,6DAA6D,CAAC,CAAC;IAChJ,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,SAAS,KAAK,CAAC,KAAa;QAC1B,IAAI,KAAK,GAAG,EAAE;YAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAU,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1C,OAAO,KAAK,GAAI,KAAgB,CAAC,MAAM,EAAE,CAAC;YACxC,MAAM,KAAK,GAAG,6BAA6B,CAAC,IAAI,CAAE,KAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YACjF,IAAI,CAAC,KAAK;gBAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;YAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACrB,IAAI,GAAG,KAAK,GAAG;gBAAE,SAAS,CAAC,GAAG,CAAC,CAAC;YAChC,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC;YACpB,IAAI,KAAK,GAAiB,IAAI,CAAC;YAC/B,IAAK,KAAgB,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC;gBACrC,IAAI,GAAG,KAAK,GAAG;oBAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;gBAC9D,KAAK,EAAE,CAAC;gBACR,KAAK,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;gBACzB,IAAK,KAAgB,CAAC,KAAK,EAAE,CAAC,KAAK,GAAG;oBAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;YAC/E,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;gBAAE,QAAQ,CAAC,yBAAyB,GAAG,EAAE,CAAC,CAAC;YACzE,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACpB,IAAK,KAAgB,CAAC,KAAK,CAAC,KAAK,GAAG;gBAAE,MAAM;YAC5C,KAAK,EAAE,CAAC;YACR,IAAI,KAAK,KAAM,KAAgB,CAAC,MAAM;gBAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;QAC3E,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM;YAAE,QAAQ,CAAC,uBAAuB,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM;QAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IAC7D,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,UAAU,gBAAgB,CAAC,KAAc,EAAE,IAAa;IAC5D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5F,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,QAAQ,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;IAC7G,MAAM,MAAM,GAAgB,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAC3E,KAAK,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAU,EAAE,CAAC;QACjE,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS;YAAE,SAAS;QACvC,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ;YAAE,QAAQ,CAAC,GAAG,GAAG,mCAAmC,CAAC,CAAC;QACxF,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAU,CAAC;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,QAAQ,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;QAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,UAAU,aAAa,CAAC,IAAU,EAAE,KAAY,EAAE,KAAK,GAAG,CAAC;IAC/D,IAAI,KAAK,GAAG,EAAE;QAAE,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC9C,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACrD,IAAI,GAAG,KAAK,GAAG;YAAE,SAAS;QAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,KAAK,CAAC,SAAS;YAAE,QAAQ,CAAC,uCAAuC,GAAG,EAAE,CAAC,CAAC;QACrH,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;gBAAE,QAAQ,CAAC,gBAAgB,GAAG,0BAA0B,CAAC,CAAC;YACxG,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;AACH,CAAC;AACD,MAAM,UAAU,cAAc,CAAC,IAAU,EAAE,KAAY,EAAE,MAAmC;IAC1F,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC;YAAE,QAAQ,CAAC,UAAU,IAAI,8BAA8B,CAAC,CAAC;QACrH,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAAE,QAAQ,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;QACpJ,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;YACvC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;gBAAE,QAAQ,CAAC,eAAe,IAAI,2BAA2B,CAAC,CAAC;YACpJ,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;YACpF,OAAO,GAAG,KAAK,CAAC;QAClB,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/src/rest/projection.d.ts

@@ -0,0 +1,6 @@
+import { type Engine, type PreparedList, type Ref } from '../engine.js';
+import type { Entity } from '../model.js';
+import type { JsonObject } from '../types.js';
+import { type RestOptions, type Scope } from './options.js';
+export declare function validateRest(engine: Engine, entity: Entity, options: RestOptions): Map<string, PreparedList>;
+export declare function project(engine: Engine, ref: Ref, scope?: Scope, nested?: RestOptions['nested'], prefix?: string, plans?: Map<string, PreparedList>): JsonObject;

package/dist/src/rest/projection.js

@@ -0,0 +1,38 @@
+import { isRef, resolveField } from '../engine.js';
+import { childrenOf, nodeAt } from '../query/options.js';
+import { ownScope, validateNested, validateScope } from './options.js';
+export function validateRest(engine, entity, options) {
+    validateScope(entity.root, options.scope);
+    validateNested(entity.root, options.scope, options.nested);
+    return new Map(Object.entries(options.nested).map(([path, nested]) => [path, engine.prepareOptions(nodeAt(entity.root, path), nested)]));
+}
+export function project(engine, ref, scope = ownScope, nested = {}, prefix = '', plans = new Map()) {
+    const output = Object.create(null);
+    const children = childrenOf(ref.node);
+    for (const [key, node] of Object.entries(children)) {
+        if (node.writeOnly || (!Object.hasOwn(scope, key) && !(Object.hasOwn(scope, '*') && !node.relation)))
+            continue;
+        const value = resolveField(ref, node);
+        const selection = Object.hasOwn(scope, key) ? (scope[key] ?? ownScope) : ownScope;
+        const path = prefix + key;
+        if (value === undefined)
+            continue;
+        if (isRef(value))
+            output[key] = project(engine, value, selection, nested, `${path}.`, plans);
+        else if (Array.isArray(value) && value.every(isRef) && (value.length > 0 || node.relation || node.base === 'object')) {
+            const prepared = plans.get(path) ?? engine.prepareOptions(node, nested[path]);
+            plans.set(path, prepared);
+            const page = engine.list(value, node, nested[path], prepared);
+            output[key] = { data: page.data.map((v) => project(engine, v, selection, nested, `${path}.`, plans)), total: page.total };
+        }
+        else
+            output[key] = structuredClone(value);
+    }
+    // Schemaless REST includes all raw fields, including fields absent in earlier records.
+    if (!ref.context.model.explicit && scope['*'] === null)
+        for (const [key, value] of Object.entries(ref.value))
+            if (!Object.hasOwn(output, key) && !children[key]?.relation)
+                output[key] = structuredClone(value);
+    return output;
+}
+//# sourceMappingURL=projection.js.map

package/dist/src/rest/projection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projection.js","sourceRoot":"","sources":["../../../src/rest/projection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,KAAK,EAA+B,YAAY,EAAE,MAAM,cAAc,CAAC;AAE7F,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,EAAE,QAAQ,EAAgC,cAAc,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACrG,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc,EAAE,OAAoB;IAC/E,aAAa,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1C,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3I,CAAC;AACD,MAAM,UAAU,OAAO,CAAC,MAAc,EAAE,GAAQ,EAAE,KAAK,GAAU,QAAQ,EAAE,MAAM,GAA0B,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,KAAK,GAAG,IAAI,GAAG,EAAwB;IACjK,MAAM,MAAM,GAAe,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACtC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnD,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAAE,SAAS;QAC/G,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClF,MAAM,IAAI,GAAG,MAAM,GAAG,GAAG,CAAC;QAC1B,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,KAAK,CAAC,KAAK,CAAC;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC;aACxF,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;YACrH,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAC9E,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAc,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;YACvE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QAC5H,CAAC;;YAAM,MAAM,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,KAAK,CAAc,CAAC;IAC3D,CAAC;IACD,uFAAuF;IACvF,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI;QACpD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ;gBAAE,MAAM,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IAC1J,OAAO,MAAM,CAAC;AAChB,CAAC"}