@generazioneai/genquery 0.1.0

package/dist/parsed.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Normalized, validated form of a GenQuery. Adapters operate on these types,
+ * which means each adapter only sees one canonical shape per concept (no more
+ * "string or object" unions).
+ */
+import type { NumericOp, SortOrder, StringSearchMode } from "./types";
+export interface ParsedStringSearch {
+    mode: StringSearchMode;
+    contained: boolean;
+    caseSensitive: boolean;
+    value: string;
+}
+export interface ParsedNumberSearch {
+    op: NumericOp;
+    value: number;
+}
+export type ParsedDateSearch = {
+    kind: "exact";
+    value: Date;
+} | {
+    kind: "range";
+    before?: Date;
+    after?: Date;
+};
+export interface ParsedBoolSearch {
+    value: boolean;
+}
+export interface ParsedEnumSearch {
+    value: string;
+}
+export interface ParsedNullCheck {
+    /** `true` → IS NULL, `false` → IS NOT NULL. */
+    isNull: boolean;
+}
+export interface ParsedEmptyCheck {
+    /** `true` → IS NULL OR = '', `false` → IS NOT NULL AND <> ''. String-only. */
+    isEmpty: boolean;
+}
+export type RelationOp = "some" | "every" | "none";
+export type ParsedFieldCondition = {
+    kind: "string";
+    field: string;
+    search: ParsedStringSearch;
+} | {
+    kind: "number";
+    field: string;
+    search: ParsedNumberSearch;
+} | {
+    kind: "bool";
+    field: string;
+    search: ParsedBoolSearch;
+} | {
+    kind: "date";
+    field: string;
+    search: ParsedDateSearch;
+} | {
+    kind: "enum";
+    field: string;
+    search: ParsedEnumSearch;
+} | {
+    kind: "null";
+    field: string;
+    check: ParsedNullCheck;
+} | {
+    kind: "empty";
+    field: string;
+    check: ParsedEmptyCheck;
+} | {
+    kind: "relation";
+    field: string;
+    targetEntity: string;
+    op: RelationOp;
+    nested: ParsedSearchBy;
+};
+export interface ParsedSearchBy {
+    /** Conditions joined by AND. */
+    conditions: ParsedFieldCondition[];
+    /**
+     * Each element is itself a full searchBy; elements are OR-ed together, and
+     * the resulting OR group is AND-ed with `conditions`.
+     */
+    or: ParsedSearchBy[];
+}
+export interface ParsedOrderBy {
+    field: string;
+    order: SortOrder;
+}
+export type ParsedSelect = {
+    kind: "all";
+} | {
+    kind: "none";
+} | {
+    kind: "fields";
+    fields: string[];
+};
+export type ParsedIncludeRelation = {
+    kind: "all";
+} | {
+    kind: "fields";
+    fields: string[];
+};
+export type ParsedInclude = {
+    kind: "none";
+} | {
+    kind: "all";
+} | {
+    kind: "map";
+    relations: Record<string, ParsedIncludeRelation>;
+};
+export type ParsedPagination = {
+    kind: "all";
+} | {
+    kind: "first";
+} | {
+    kind: "page";
+    page: number;
+    perPage: number;
+};
+export interface ParsedQuery {
+    rootEntity: string;
+    orderBy?: ParsedOrderBy;
+    searchBy?: ParsedSearchBy;
+    include: ParsedInclude;
+    select: ParsedSelect;
+    pagination: ParsedPagination;
+}
+//# sourceMappingURL=parsed.d.ts.map

package/dist/parsed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsed.d.ts","sourceRoot":"","sources":["../src/parsed.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEtE,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,gBAAgB,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,SAAS,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,IAAI,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,IAAI,CAAC;IAAC,KAAK,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAEnD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,+CAA+C;IAC/C,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,8EAA8E;IAC9E,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAC5B;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAA;CAAE,GAC7D;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAA;CAAE,GAC7D;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,gBAAgB,CAAA;CAAE,GACzD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,gBAAgB,CAAA;CAAE,GACzD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,gBAAgB,CAAA;CAAE,GACzD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,eAAe,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,gBAAgB,CAAA;CAAE,GACzD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,EAAE,EAAE,UAAU,CAAC;IACf,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEN,MAAM,WAAW,cAAc;IAC7B,gCAAgC;IAChC,UAAU,EAAE,oBAAoB,EAAE,CAAC;IACnC;;;OAGG;IACH,EAAE,EAAE,cAAc,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,MAAM,YAAY,GACpB;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GACf;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAEzC,MAAM,MAAM,qBAAqB,GAC7B;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GACf;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAEzC,MAAM,MAAM,aAAa,GACrB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GACf;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CAAE,CAAC;AAEtE,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GACf;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpD,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,OAAO,EAAE,aAAa,CAAC;IACvB,MAAM,EAAE,YAAY,CAAC;IACrB,UAAU,EAAE,gBAAgB,CAAC;CAC9B"}

package/dist/parsed.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Normalized, validated form of a GenQuery. Adapters operate on these types,
+ * which means each adapter only sees one canonical shape per concept (no more
+ * "string or object" unions).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=parsed.js.map

package/dist/parsed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parsed.js","sourceRoot":"","sources":["../src/parsed.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/dist/parser.d.ts

@@ -0,0 +1,5 @@
+import { type Schema } from "./schema";
+import type { GenQueryInput } from "./types";
+import type { ParsedQuery } from "./parsed";
+export declare function parseQuery(input: GenQueryInput, schema: Schema, rootEntity: string): ParsedQuery;
+//# sourceMappingURL=parser.d.ts.map

package/dist/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,KAAK,MAAM,EAEZ,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAEV,aAAa,EAMd,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAUV,WAAW,EAIZ,MAAM,UAAU,CAAC;AA+hBlB,wBAAgB,UAAU,CACxB,KAAK,EAAE,aAAa,EACpB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,GACjB,WAAW,CAwCb"}

package/dist/parser.js

@@ -0,0 +1,404 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseQuery = parseQuery;
+const errors_1 = require("./errors");
+const datetime_1 = require("./datetime");
+const schema_1 = require("./schema");
+const STRING_MODES = [
+    "splitword",
+    "exact",
+    "nativeregex",
+];
+const NUMERIC_OPS = [">", "<", ">=", "<=", "=="];
+const PRESENCE_CHECK_KEYS = ["isNull", "isEmpty"];
+/**
+ * Detect a presence-check wrapper: a plain object whose keys are all drawn
+ * from `PRESENCE_CHECK_KEYS`. Returns `false` for objects mixing presence
+ * keys with other keys so per-type parsers can report a more specific error.
+ */
+function isPresenceCheckObject(v) {
+    if (!isPlainObject(v))
+        return false;
+    const keys = Object.keys(v);
+    if (keys.length === 0)
+        return false;
+    return keys.every((k) => PRESENCE_CHECK_KEYS.includes(k));
+}
+function parsePresenceCheck(raw, path) {
+    const out = {};
+    for (const key of PRESENCE_CHECK_KEYS) {
+        const v = raw[key];
+        if (v === undefined)
+            continue;
+        if (typeof v !== "boolean") {
+            throw new errors_1.QueryValidationError(`Presence check: '${key}' must be a boolean`, `${path}.${key}`);
+        }
+        if (key === "isNull")
+            out.null = { isNull: v };
+        else
+            out.empty = { isEmpty: v };
+    }
+    // isPresenceCheckObject guarantees at least one key, so `out` is non-empty.
+    return out;
+}
+function isPlainObject(v) {
+    return (v !== null &&
+        typeof v === "object" &&
+        !Array.isArray(v) &&
+        !(v instanceof Date));
+}
+function parseStringSearch(raw, path) {
+    if (typeof raw === "string") {
+        return {
+            mode: "splitword",
+            contained: false,
+            caseSensitive: false,
+            value: raw,
+        };
+    }
+    if (!isPlainObject(raw)) {
+        throw new errors_1.QueryValidationError("Expected string or string-search object", path);
+    }
+    const value = raw.value;
+    if (typeof value !== "string") {
+        throw new errors_1.QueryValidationError("String search: 'value' must be a string", `${path}.value`);
+    }
+    let mode = "splitword";
+    if (raw.mode !== undefined) {
+        if (typeof raw.mode !== "string" || !STRING_MODES.includes(raw.mode)) {
+            throw new errors_1.QueryValidationError(`String search: 'mode' must be one of ${STRING_MODES.join(", ")}`, `${path}.mode`);
+        }
+        mode = raw.mode;
+    }
+    else if (typeof raw.type === "string") {
+        // The spec example uses `type: "exact"` instead of `mode`. Accept both.
+        if (!STRING_MODES.includes(raw.type)) {
+            throw new errors_1.QueryValidationError(`String search: 'type' must be one of ${STRING_MODES.join(", ")}`, `${path}.type`);
+        }
+        mode = raw.type;
+    }
+    const contained = raw.contained === undefined ? false : Boolean(raw.contained);
+    const caseSensitive = raw.caseSensitive === undefined ? false : Boolean(raw.caseSensitive);
+    return { mode, contained, caseSensitive, value };
+}
+function parseNumberSearch(raw, path) {
+    if (typeof raw === "number") {
+        return { op: "==", value: raw };
+    }
+    if (!isPlainObject(raw)) {
+        throw new errors_1.QueryValidationError("Expected number or numeric-comparison object", path);
+    }
+    const value = raw.value;
+    if (typeof value !== "number" || !Number.isFinite(value)) {
+        throw new errors_1.QueryValidationError("Numeric comparison: 'value' must be a finite number", `${path}.value`);
+    }
+    if (raw.type !== undefined) {
+        throw new errors_1.QueryValidationError("Numeric comparison: 'type' is not a valid key. Use 'operation' instead.", `${path}.type`);
+    }
+    let op = "==";
+    if (raw.operation !== undefined) {
+        if (typeof raw.operation !== "string" ||
+            !NUMERIC_OPS.includes(raw.operation)) {
+            throw new errors_1.QueryValidationError(`Numeric comparison: 'operation' must be one of ${NUMERIC_OPS.join(", ")}`, `${path}.operation`);
+        }
+        op = raw.operation;
+    }
+    return { op, value };
+}
+function isDateRange(v) {
+    if (!isPlainObject(v))
+        return false;
+    const keys = Object.keys(v);
+    if (keys.length === 0)
+        return false;
+    return keys.every((k) => k === "before" || k === "after");
+}
+function parseDateSearch(raw, path) {
+    if (isDateRange(raw)) {
+        const out = { kind: "range" };
+        if (raw.before !== undefined) {
+            out.before = (0, datetime_1.parseDateTime)(raw.before, `${path}.before`);
+        }
+        if (raw.after !== undefined) {
+            out.after = (0, datetime_1.parseDateTime)(raw.after, `${path}.after`);
+        }
+        if (out.before === undefined && out.after === undefined) {
+            throw new errors_1.QueryValidationError("Date range must contain at least one of 'before' or 'after'", path);
+        }
+        return out;
+    }
+    if ((0, datetime_1.looksLikeDateTime)(raw)) {
+        return { kind: "exact", value: (0, datetime_1.parseDateTime)(raw, path) };
+    }
+    throw new errors_1.QueryValidationError("Expected ISO datetime, datetime object, or { before, after } range", path);
+}
+const RELATION_OPS = ["some", "every", "none"];
+/**
+ * Detect the explicit-wrapper form for a relation filter and split it into one
+ * entry per cardinality op. Returns `null` if the value is a plain SearchBy
+ * (implicit `some`). Throws if the wrapper contains unknown keys.
+ */
+function parseRelationWrapper(value) {
+    if (!isPlainObject(value))
+        return null;
+    const keys = Object.keys(value);
+    const hasOp = keys.some((k) => RELATION_OPS.includes(k));
+    if (!hasOp)
+        return null;
+    const unknown = keys.find((k) => !RELATION_OPS.includes(k));
+    if (unknown !== undefined) {
+        throw new errors_1.QueryValidationError(`Unknown relation filter operator '${unknown}'. Expected 'some', 'every', or 'none'.`, unknown);
+    }
+    const result = [];
+    for (const op of RELATION_OPS) {
+        const nestedValue = value[op];
+        if (nestedValue !== undefined)
+            result.push({ op, nestedValue });
+    }
+    return result;
+}
+function parseSearchBy(raw, schema, entityName, path) {
+    if (!isPlainObject(raw)) {
+        throw new errors_1.QueryValidationError("searchBy must be an object", path);
+    }
+    const entity = (0, schema_1.getEntity)(schema, entityName);
+    const conditions = [];
+    const or = [];
+    for (const [key, value] of Object.entries(raw)) {
+        const fieldPath = `${path}.${key}`;
+        if (key === "OR") {
+            if (!Array.isArray(value)) {
+                throw new errors_1.QueryValidationError("OR must be an array", fieldPath);
+            }
+            value.forEach((item, idx) => {
+                or.push(parseSearchBy(item, schema, entityName, `${fieldPath}[${idx}]`));
+            });
+            continue;
+        }
+        const fieldDef = entity.fields[key];
+        const relationDef = entity.relations?.[key];
+        if (fieldDef) {
+            conditions.push(...parseLeafConditions(key, fieldDef, value, fieldPath));
+            continue;
+        }
+        if (relationDef) {
+            const wrapperOps = parseRelationWrapper(value);
+            if (wrapperOps) {
+                for (const { op, nestedValue } of wrapperOps) {
+                    conditions.push({
+                        kind: "relation",
+                        field: key,
+                        targetEntity: relationDef.target,
+                        op,
+                        nested: parseSearchBy(nestedValue, schema, relationDef.target, `${fieldPath}.${op}`),
+                    });
+                }
+            }
+            else {
+                conditions.push({
+                    kind: "relation",
+                    field: key,
+                    targetEntity: relationDef.target,
+                    op: "some",
+                    nested: parseSearchBy(value, schema, relationDef.target, fieldPath),
+                });
+            }
+            continue;
+        }
+        throw new errors_1.QueryValidationError(`Unknown field or relation '${key}' on entity '${entityName}'`, fieldPath);
+    }
+    return { conditions, or };
+}
+function parseLeafConditions(field, def, value, path) {
+    // Presence check (`isNull` on any primitive, `isEmpty` on strings only).
+    // Detect before per-type parsing so e.g. `{ isNull: true }` on a string
+    // field doesn't get rejected as a malformed StringSearchObjectInput.
+    // Both keys may coexist and AND together (the parsed output is one
+    // condition per key, and conditions naturally AND).
+    if (isPresenceCheckObject(value)) {
+        const parsed = parsePresenceCheck(value, path);
+        if (parsed.null && !def.nullable) {
+            throw new errors_1.QueryValidationError(`isNull is only valid on nullable fields; field '${field}' is not nullable`, path);
+        }
+        if (parsed.empty && def.type !== "string") {
+            throw new errors_1.QueryValidationError(`isEmpty is only valid on string fields; field '${field}' is ${def.type}`, path);
+        }
+        const out = [];
+        if (parsed.null)
+            out.push({ kind: "null", field, check: parsed.null });
+        if (parsed.empty)
+            out.push({ kind: "empty", field, check: parsed.empty });
+        return out;
+    }
+    return [parseLeafConditionTyped(field, def, value, path)];
+}
+function parseLeafConditionTyped(field, def, value, path) {
+    switch (def.type) {
+        case "string":
+            return {
+                kind: "string",
+                field,
+                search: parseStringSearch(value, path),
+            };
+        case "number":
+            return {
+                kind: "number",
+                field,
+                search: parseNumberSearch(value, path),
+            };
+        case "boolean":
+            if (typeof value !== "boolean") {
+                throw new errors_1.QueryValidationError(`Field '${field}' is boolean; expected true or false`, path);
+            }
+            return { kind: "bool", field, search: { value } };
+        case "date":
+            return {
+                kind: "date",
+                field,
+                search: parseDateSearch(value, path),
+            };
+        case "enum": {
+            if (typeof value !== "string") {
+                throw new errors_1.QueryValidationError(`Field '${field}' is enum; expected a string`, path);
+            }
+            if (!def.values.includes(value)) {
+                throw new errors_1.QueryValidationError(`Field '${field}' must be one of: ${def.values.join(", ")}`, path);
+            }
+            return { kind: "enum", field, search: { value } };
+        }
+        default:
+            throw new errors_1.QueryValidationError(`Unsupported field type '${def.type}'`, path);
+    }
+}
+function parseOrderBy(raw, entity, path) {
+    if (typeof raw === "string") {
+        if (!entity.fields[raw]) {
+            throw new errors_1.QueryValidationError(`orderBy field '${raw}' is not a known field of '${entity.name}'`, path);
+        }
+        return { field: raw, order: "desc" };
+    }
+    if (!isPlainObject(raw)) {
+        throw new errors_1.QueryValidationError("orderBy must be a string or object", path);
+    }
+    const field = raw.field;
+    if (typeof field !== "string") {
+        throw new errors_1.QueryValidationError("orderBy.field is required and must be a string", `${path}.field`);
+    }
+    if (!entity.fields[field]) {
+        throw new errors_1.QueryValidationError(`orderBy field '${field}' is not a known field of '${entity.name}'`, `${path}.field`);
+    }
+    const order = raw.order ?? "desc";
+    if (order !== "asc" && order !== "desc") {
+        throw new errors_1.QueryValidationError(`orderBy.order must be 'asc' or 'desc'`, `${path}.order`);
+    }
+    return { field, order };
+}
+function parseSelect(raw, entity, path) {
+    if (raw === "all")
+        return { kind: "all" };
+    if (raw === "none")
+        return { kind: "none" };
+    if (!isPlainObject(raw)) {
+        throw new errors_1.QueryValidationError("select must be 'all', 'none', or an object", path);
+    }
+    const fields = [];
+    for (const [k, v] of Object.entries(raw)) {
+        if (v !== true)
+            continue;
+        if (!entity.fields[k]) {
+            throw new errors_1.QueryValidationError(`select: '${k}' is not a known field of '${entity.name}'`, `${path}.${k}`);
+        }
+        fields.push(k);
+    }
+    return { kind: "fields", fields };
+}
+function parseInclude(raw, entity, schema, path) {
+    if (raw === "none")
+        return { kind: "none" };
+    if (raw === "all")
+        return { kind: "all" };
+    if (!isPlainObject(raw)) {
+        throw new errors_1.QueryValidationError("include must be 'all', 'none', or an object", path);
+    }
+    const relations = {};
+    for (const [relName, spec] of Object.entries(raw)) {
+        const relDef = entity.relations?.[relName];
+        if (!relDef) {
+            throw new errors_1.QueryValidationError(`include: '${relName}' is not a known relation of '${entity.name}'`, `${path}.${relName}`);
+        }
+        if (spec === "all") {
+            relations[relName] = { kind: "all" };
+            continue;
+        }
+        if (!isPlainObject(spec)) {
+            throw new errors_1.QueryValidationError(`include.${relName} must be 'all' or an object`, `${path}.${relName}`);
+        }
+        const targetEntity = (0, schema_1.getEntity)(schema, relDef.target);
+        const fields = [];
+        for (const [k, v] of Object.entries(spec)) {
+            if (v !== true)
+                continue;
+            if (!targetEntity.fields[k]) {
+                throw new errors_1.QueryValidationError(`include.${relName}.${k} is not a known field of '${targetEntity.name}'`, `${path}.${relName}.${k}`);
+            }
+            fields.push(k);
+        }
+        relations[relName] = { kind: "fields", fields };
+    }
+    return { kind: "map", relations };
+}
+function parsePagination(raw, path) {
+    if (raw === "all")
+        return { kind: "all" };
+    if (raw === "first")
+        return { kind: "first" };
+    if (!isPlainObject(raw)) {
+        throw new errors_1.QueryValidationError("pagination must be 'all', 'first', or an object", path);
+    }
+    const pageRaw = raw.page;
+    const perPageRaw = raw.perPage;
+    const page = pageRaw === undefined ? 0 : Number(pageRaw);
+    const perPage = perPageRaw === undefined ? 20 : Number(perPageRaw);
+    if (!Number.isInteger(page) || page < 0) {
+        throw new errors_1.QueryValidationError("pagination.page must be a non-negative integer", `${path}.page`);
+    }
+    if (!Number.isInteger(perPage) || perPage <= 0) {
+        throw new errors_1.QueryValidationError("pagination.perPage must be a positive integer", `${path}.perPage`);
+    }
+    return { kind: "page", page, perPage };
+}
+// Avoid leaning on a circular type import in parseLeafCondition's signature.
+// (The helper above is intentionally typed loosely; this re-export is the
+// public signature.)
+function parseQuery(input, schema, rootEntity) {
+    if (input === null ||
+        typeof input !== "object" ||
+        Array.isArray(input) ||
+        input instanceof Date) {
+        throw new errors_1.QueryValidationError("query must be an object", "");
+    }
+    const entity = (0, schema_1.getEntity)(schema, rootEntity);
+    const parsed = {
+        rootEntity,
+        include: { kind: "none" },
+        select: { kind: "all" },
+        pagination: { kind: "all" },
+    };
+    if (input.orderBy !== undefined) {
+        parsed.orderBy = parseOrderBy(input.orderBy, entity, "orderBy");
+    }
+    if (input.searchBy !== undefined) {
+        parsed.searchBy = parseSearchBy(input.searchBy, schema, rootEntity, "searchBy");
+    }
+    if (input.include !== undefined) {
+        parsed.include = parseInclude(input.include, entity, schema, "include");
+    }
+    if (input.select !== undefined) {
+        parsed.select = parseSelect(input.select, entity, "select");
+    }
+    if (input.pagination !== undefined) {
+        parsed.pagination = parsePagination(input.pagination, "pagination");
+    }
+    return parsed;
+}
+//# sourceMappingURL=parser.js.map

package/dist/parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":";;AA8jBA,gCA4CC;AA1mBD,qCAAgD;AAChD,yCAA8D;AAC9D,qCAKkB;AA0BlB,MAAM,YAAY,GAAgC;IAChD,WAAW;IACX,OAAO;IACP,aAAa;CACd,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAE1D,MAAM,mBAAmB,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAU,CAAC;AAG3D;;;;GAIG;AACH,SAAS,qBAAqB,CAC5B,CAAU;IAEV,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACpC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACpC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CACrB,mBAAyC,CAAC,QAAQ,CAAC,CAAC,CAAC,CACvD,CAAC;AACJ,CAAC;AAOD,SAAS,kBAAkB,CACzB,GAA4B,EAC5B,IAAY;IAEZ,MAAM,GAAG,GAAwB,EAAE,CAAC;IACpC,KAAK,MAAM,GAAG,IAAI,mBAAmB,EAAE,CAAC;QACtC,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,KAAK,SAAS;YAAE,SAAS;QAC9B,IAAI,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,6BAAoB,CAC5B,oBAAoB,GAAG,qBAAqB,EAC5C,GAAG,IAAI,IAAI,GAAG,EAAE,CACjB,CAAC;QACJ,CAAC;QACD,IAAI,GAAG,KAAK,QAAQ;YAAE,GAAG,CAAC,IAAI,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;;YAC1C,GAAG,CAAC,KAAK,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAClC,CAAC;IACD,4EAA4E;IAC5E,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,aAAa,CAAC,CAAU;IAC/B,OAAO,CACL,CAAC,KAAK,IAAI;QACV,OAAO,CAAC,KAAK,QAAQ;QACrB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,CACrB,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,GAAY,EACZ,IAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO;YACL,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,KAAK;YAChB,aAAa,EAAE,KAAK;YACpB,KAAK,EAAE,GAAG;SACX,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,6BAAoB,CAC5B,yCAAyC,EACzC,IAAI,CACL,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IACxB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,6BAAoB,CAC5B,yCAAyC,EACzC,GAAG,IAAI,QAAQ,CAChB,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,GAAqB,WAAW,CAAC;IACzC,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAwB,CAAC,EAAE,CAAC;YACzF,MAAM,IAAI,6BAAoB,CAC5B,wCAAwC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EACjE,GAAG,IAAI,OAAO,CACf,CAAC;QACJ,CAAC;QACD,IAAI,GAAG,GAAG,CAAC,IAAwB,CAAC;IACtC,CAAC;SAAM,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACxC,wEAAwE;QACxE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAwB,CAAC,EAAE,CAAC;YACzD,MAAM,IAAI,6BAAoB,CAC5B,wCAAwC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EACjE,GAAG,IAAI,OAAO,CACf,CAAC;QACJ,CAAC;QACD,IAAI,GAAG,GAAG,CAAC,IAAwB,CAAC;IACtC,CAAC;IAED,MAAM,SAAS,GACb,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC/D,MAAM,aAAa,GACjB,GAAG,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEvE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;AACnD,CAAC;AAED,SAAS,iBAAiB,CAAC,GAAY,EAAE,IAAY;IACnD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAClC,CAAC;IACD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,6BAAoB,CAC5B,8CAA8C,EAC9C,IAAI,CACL,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IACxB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,6BAAoB,CAC5B,qDAAqD,EACrD,GAAG,IAAI,QAAQ,CAChB,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,6BAAoB,CAC5B,yEAAyE,EACzE,GAAG,IAAI,OAAO,CACf,CAAC;IACJ,CAAC;IACD,IAAI,EAAE,GAA6B,IAAI,CAAC;IACxC,IAAI,GAAG,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAChC,IACE,OAAO,GAAG,CAAC,SAAS,KAAK,QAAQ;YACjC,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAqC,CAAC,EAChE,CAAC;YACD,MAAM,IAAI,6BAAoB,CAC5B,kDAAkD,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAC1E,GAAG,IAAI,YAAY,CACpB,CAAC;QACJ,CAAC;QACD,EAAE,GAAG,GAAG,CAAC,SAAqC,CAAC;IACjD,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;AACvB,CAAC;AAED,SAAS,WAAW,CAAC,CAAU;IAC7B,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACpC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACpC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,OAAO,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,eAAe,CAAC,GAAY,EAAE,IAAY;IACjD,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,GAAG,GAAqB,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QAChD,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC7B,GAAG,CAAC,MAAM,GAAG,IAAA,wBAAa,EAAC,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC5B,GAAG,CAAC,KAAK,GAAG,IAAA,wBAAa,EAAC,GAAG,CAAC,KAAK,EAAE,GAAG,IAAI,QAAQ,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACxD,MAAM,IAAI,6BAAoB,CAC5B,6DAA6D,EAC7D,IAAI,CACL,CAAC;QACJ,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IACD,IAAI,IAAA,4BAAiB,EAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAA,wBAAa,EAAC,GAAY,EAAE,IAAI,CAAC,EAAE,CAAC;IACrE,CAAC;IACD,MAAM,IAAI,6BAAoB,CAC5B,oEAAoE,EACpE,IAAI,CACL,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAU,CAAC;AAGxD;;;;GAIG;AACH,SAAS,oBAAoB,CAC3B,KAAc;IAEd,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACvC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAE,YAAkC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAChF,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACxB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CACvB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAE,YAAkC,CAAC,QAAQ,CAAC,CAAC,CAAC,CACxD,CAAC;IACF,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,6BAAoB,CAC5B,qCAAqC,OAAO,yCAAyC,EACrF,OAAO,CACR,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAwD,EAAE,CAAC;IACvE,KAAK,MAAM,EAAE,IAAI,YAAY,EAAE,CAAC;QAC9B,MAAM,WAAW,GAAI,KAAiC,CAAC,EAAE,CAAC,CAAC;QAC3D,IAAI,WAAW,KAAK,SAAS;YAAE,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CACpB,GAAY,EACZ,MAAc,EACd,UAAkB,EAClB,IAAY;IAEZ,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,6BAAoB,CAC5B,4BAA4B,EAC5B,IAAI,CACL,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,IAAA,kBAAS,EAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC7C,MAAM,UAAU,GAA2B,EAAE,CAAC;IAC9C,MAAM,EAAE,GAAqB,EAAE,CAAC;IAEhC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,MAAM,SAAS,GAAG,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC;QAEnC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,6BAAoB,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAC;YACnE,CAAC;YACD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;gBAC1B,EAAE,CAAC,IAAI,CACL,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,SAAS,IAAI,GAAG,GAAG,CAAC,CAChE,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5C,IAAI,QAAQ,EAAE,CAAC;YACb,UAAU,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;YACzE,SAAS;QACX,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,UAAU,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;YAC/C,IAAI,UAAU,EAAE,CAAC;gBACf,KAAK,MAAM,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,UAAU,EAAE,CAAC;oBAC7C,UAAU,CAAC,IAAI,CAAC;wBACd,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE,GAAG;wBACV,YAAY,EAAE,WAAW,CAAC,MAAM;wBAChC,EAAE;wBACF,MAAM,EAAE,aAAa,CACnB,WAAW,EACX,MAAM,EACN,WAAW,CAAC,MAAM,EAClB,GAAG,SAAS,IAAI,EAAE,EAAE,CACrB;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,IAAI,CAAC;oBACd,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,GAAG;oBACV,YAAY,EAAE,WAAW,CAAC,MAAM;oBAChC,EAAE,EAAE,MAAM;oBACV,MAAM,EAAE,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC;iBACpE,CAAC,CAAC;YACL,CAAC;YACD,SAAS;QACX,CAAC;QAED,MAAM,IAAI,6BAAoB,CAC5B,8BAA8B,GAAG,gBAAgB,UAAU,GAAG,EAC9D,SAAS,CACV,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,mBAAmB,CAC1B,KAAa,EACb,GAAoB,EACpB,KAAc,EACd,IAAY;IAEZ,yEAAyE;IACzE,wEAAwE;IACxE,qEAAqE;IACrE,mEAAmE;IACnE,oDAAoD;IACpD,IAAI,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC/C,IAAI,MAAM,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YACjC,MAAM,IAAI,6BAAoB,CAC5B,mDAAmD,KAAK,mBAAmB,EAC3E,IAAI,CACL,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC1C,MAAM,IAAI,6BAAoB,CAC5B,kDAAkD,KAAK,QAAQ,GAAG,CAAC,IAAI,EAAE,EACzE,IAAI,CACL,CAAC;QACJ,CAAC;QACD,MAAM,GAAG,GAA2B,EAAE,CAAC;QACvC,IAAI,MAAM,CAAC,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACvE,IAAI,MAAM,CAAC,KAAK;YAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAC1E,OAAO,GAAG,CAAC;IACb,CAAC;IACD,OAAO,CAAC,uBAAuB,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,uBAAuB,CAC9B,KAAa,EACb,GAAoB,EACpB,KAAc,EACd,IAAY;IAEZ,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,QAAQ;YACX,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,KAAK;gBACL,MAAM,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC;aACvC,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,KAAK;gBACL,MAAM,EAAE,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC;aACvC,CAAC;QACJ,KAAK,SAAS;YACZ,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,IAAI,6BAAoB,CAC5B,UAAU,KAAK,sCAAsC,EACrD,IAAI,CACL,CAAC;YACJ,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC;QACpD,KAAK,MAAM;YACT,OAAO;gBACL,IAAI,EAAE,MAAM;gBACZ,KAAK;gBACL,MAAM,EAAE,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC;aACrC,CAAC;QACJ,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,MAAM,IAAI,6BAAoB,CAC5B,UAAU,KAAK,8BAA8B,EAC7C,IAAI,CACL,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,6BAAoB,CAC5B,UAAU,KAAK,qBAAqB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAC3D,IAAI,CACL,CAAC;YACJ,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC;QACpD,CAAC;QACD;YACE,MAAM,IAAI,6BAAoB,CAC5B,2BAA4B,GAAwB,CAAC,IAAI,GAAG,EAC5D,IAAI,CACL,CAAC;IACN,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CACnB,GAAiB,EACjB,MAAwB,EACxB,IAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,6BAAoB,CAC5B,kBAAkB,GAAG,8BAA8B,MAAM,CAAC,IAAI,GAAG,EACjE,IAAI,CACL,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IACvC,CAAC;IACD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,6BAAoB,CAAC,oCAAoC,EAAE,IAAI,CAAC,CAAC;IAC7E,CAAC;IACD,MAAM,KAAK,GAAI,GAA+B,CAAC,KAAK,CAAC;IACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,6BAAoB,CAC5B,gDAAgD,EAChD,GAAG,IAAI,QAAQ,CAChB,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,6BAAoB,CAC5B,kBAAkB,KAAK,8BAA8B,MAAM,CAAC,IAAI,GAAG,EACnE,GAAG,IAAI,QAAQ,CAChB,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAI,GAA+B,CAAC,KAAK,IAAI,MAAM,CAAC;IAC/D,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QACxC,MAAM,IAAI,6BAAoB,CAC5B,uCAAuC,EACvC,GAAG,IAAI,QAAQ,CAChB,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC1B,CAAC;AAED,SAAS,WAAW,CAClB,GAAgB,EAChB,MAAwB,EACxB,IAAY;IAEZ,IAAI,GAAG,KAAK,KAAK;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC1C,IAAI,GAAG,KAAK,MAAM;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC5C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,6BAAoB,CAC5B,4CAA4C,EAC5C,IAAI,CACL,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,KAAK,IAAI;YAAE,SAAS;QACzB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,6BAAoB,CAC5B,YAAY,CAAC,8BAA8B,MAAM,CAAC,IAAI,GAAG,EACzD,GAAG,IAAI,IAAI,CAAC,EAAE,CACf,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AACpC,CAAC;AAED,SAAS,YAAY,CACnB,GAAiB,EACjB,MAAwB,EACxB,MAAc,EACd,IAAY;IAEZ,IAAI,GAAG,KAAK,MAAM;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC5C,IAAI,GAAG,KAAK,KAAK;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC1C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,6BAAoB,CAC5B,6CAA6C,EAC7C,IAAI,CACL,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAA0C,EAAE,CAAC;IAC5D,KAAK,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAClD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,6BAAoB,CAC5B,aAAa,OAAO,iCAAiC,MAAM,CAAC,IAAI,GAAG,EACnE,GAAG,IAAI,IAAI,OAAO,EAAE,CACrB,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACnB,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YACrC,SAAS;QACX,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,6BAAoB,CAC5B,WAAW,OAAO,6BAA6B,EAC/C,GAAG,IAAI,IAAI,OAAO,EAAE,CACrB,CAAC;QACJ,CAAC;QACD,MAAM,YAAY,GAAG,IAAA,kBAAS,EAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACtD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,KAAK,IAAI;gBAAE,SAAS;YACzB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,6BAAoB,CAC5B,WAAW,OAAO,IAAI,CAAC,6BAA6B,YAAY,CAAC,IAAI,GAAG,EACxE,GAAG,IAAI,IAAI,OAAO,IAAI,CAAC,EAAE,CAC1B,CAAC;YACJ,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;QACD,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAClD,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;AACpC,CAAC;AAED,SAAS,eAAe,CACtB,GAAoB,EACpB,IAAY;IAEZ,IAAI,GAAG,KAAK,KAAK;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC1C,IAAI,GAAG,KAAK,OAAO;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAC9C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,6BAAoB,CAC5B,iDAAiD,EACjD,IAAI,CACL,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAI,GAA+B,CAAC,IAAI,CAAC;IACtD,MAAM,UAAU,GAAI,GAA+B,CAAC,OAAO,CAAC;IAC5D,MAAM,IAAI,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACzD,MAAM,OAAO,GAAG,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACnE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,6BAAoB,CAC5B,gDAAgD,EAChD,GAAG,IAAI,OAAO,CACf,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,6BAAoB,CAC5B,+CAA+C,EAC/C,GAAG,IAAI,UAAU,CAClB,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AACzC,CAAC;AAED,6EAA6E;AAC7E,0EAA0E;AAC1E,qBAAqB;AACrB,SAAgB,UAAU,CACxB,KAAoB,EACpB,MAAc,EACd,UAAkB;IAElB,IACE,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACpB,KAAK,YAAY,IAAI,EACrB,CAAC;QACD,MAAM,IAAI,6BAAoB,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,MAAM,GAAG,IAAA,kBAAS,EAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAE7C,MAAM,MAAM,GAAgB;QAC1B,UAAU;QACV,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;QACzB,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QACvB,UAAU,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;KAC5B,CAAC;IAEF,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,CAAC,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAClE,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,CAAC,QAAQ,GAAG,aAAa,CAC7B,KAAK,CAAC,QAAQ,EACd,MAAM,EACN,UAAU,EACV,UAAU,CACX,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,CAAC,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACnC,MAAM,CAAC,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/schema.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Schema describes what fields and relations exist on each entity, so the
+ * parser can validate queries and the adapter can produce correct joins and
+ * conditions. The schema is intentionally ORM-agnostic.
+ */
+export type FieldType = "string" | "number" | "boolean" | "date" | "enum";
+interface BaseFieldDefinition {
+    /**
+     * Override the database column name. Defaults to the field key.
+     * Adapters may ignore this if they rely on ORM metadata (TypeORM uses the
+     * entity's own column mapping).
+     */
+    column?: string;
+    /**
+     * Whether the column accepts NULL. Defaults to `false`. The parser uses this
+     * to reject `{ isNull }` presence checks on non-nullable fields. With
+     * `schemaFromTypeORM`, this is auto-populated from `ColumnMetadata.isNullable`.
+     */
+    nullable?: boolean;
+}
+export type FieldDefinition = (BaseFieldDefinition & {
+    type: "string" | "number" | "boolean" | "date";
+}) | EnumFieldDefinition;
+export interface EnumFieldDefinition extends BaseFieldDefinition {
+    type: "enum";
+    /** Allowed enum values. The parser rejects anything not in this list. */
+    values: readonly string[];
+}
+export interface RelationDefinition {
+    /** Name of the related entity in the schema's `entities` map. */
+    target: string;
+    /** Cardinality. Currently informational; defaults to "many". */
+    kind?: "one" | "many";
+}
+export interface EntityDefinition {
+    /** Logical name of the entity (matches the key in `Schema.entities`). */
+    name: string;
+    fields: Record<string, FieldDefinition>;
+    relations?: Record<string, RelationDefinition>;
+    /**
+     * Primary key field name. Used to give relations a stable identity in
+     * adapter output. Defaults to "id".
+     */
+    primaryKey?: string;
+}
+export interface Schema {
+    entities: Record<string, EntityDefinition>;
+}
+export declare class SchemaError extends Error {
+    constructor(message: string);
+}
+export declare function getEntity(schema: Schema, name: string): EntityDefinition;
+export declare function getField(schema: Schema, entityName: string, field: string): FieldDefinition | undefined;
+export declare function getRelation(schema: Schema, entityName: string, field: string): RelationDefinition | undefined;
+export declare function primaryKeyOf(entity: EntityDefinition): string;
+export {};
+//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1E,UAAU,mBAAmB;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,eAAe,GACvB,CAAC,mBAAmB,GAAG;IAAE,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAA;CAAE,CAAC,GAC1E,mBAAmB,CAAC;AAExB,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAC;IACf,gEAAgE;IAChE,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACxC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC/C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,MAAM;IACrB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CAC5C;AAED,qBAAa,WAAY,SAAQ,KAAK;gBACxB,OAAO,EAAE,MAAM;CAI5B;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAMxE;AAED,wBAAgB,QAAQ,CACtB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,eAAe,GAAG,SAAS,CAE7B;AAED,wBAAgB,WAAW,CACzB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,kBAAkB,GAAG,SAAS,CAEhC;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAE7D"}