@edium/halifax 1.0.0

package/dist/classes/QueryBuilder.js

@@ -0,0 +1,262 @@
+import { SqlComparison } from '../enums/SqlComparison.js';
+import { BadRequestError } from '../errors/BadRequestError.js';
+/**
+ * Returns `true` when `value` is neither `undefined` nor `null`.
+ * @param value - Value to test.
+ * @returns `true` when `value` is defined and not null.
+ */
+function isDefined(value) {
+    return value !== undefined && value !== null;
+}
+/**
+ * Replaces `?` placeholder markers with PostgreSQL-style `$1`, `$2`, … numbered parameters.
+ * @param statement - SQL string containing `?` placeholders.
+ * @returns The same SQL string with `?` replaced by `$1`, `$2`, etc. in order.
+ */
+function numberParams(statement) {
+    let i = 0;
+    return statement.replace(/\?/g, () => `$${++i}`);
+}
+/**
+ * Returns the SELECT field list, or `*` when no fields are specified.
+ * @param fields - Array of column names to include, or `undefined` for all columns.
+ * @returns A comma-separated field list, or `'*'`.
+ */
+function addFields(fields) {
+    return fields?.length ? fields.join(',') : '*';
+}
+/**
+ * Returns the `FROM <tableName>` clause.
+ * @param tableName - Target table name.
+ * @returns A `FROM <tableName>` SQL fragment.
+ * @throws {@link BadRequestError} when `tableName` is absent.
+ */
+function addFrom(tableName) {
+    if (!tableName) {
+        throw new BadRequestError('The query builder requires a table name.');
+    }
+    return `FROM ${tableName}`;
+}
+/**
+ * Returns the `ORDER BY` clause from the query options, or an empty string when no sorts are given.
+ * @param queryOptions - Query AST whose `orderBy` array is used.
+ * @returns An `ORDER BY ...` SQL fragment, or `''` when `orderBy` is absent or empty.
+ */
+function addOrderBy(queryOptions) {
+    const order = queryOptions.orderBy ?? [];
+    const orderClauses = order.map((sort) => `${sort.field} ${sort.order}`);
+    if (orderClauses.length === 0)
+        return '';
+    return `ORDER BY ${orderClauses.join(',')}`;
+}
+/**
+ * Builds the filter clause fragment for a list of {@link IQueryFilter} conditions.
+ * @param queryItems - Filter conditions to convert into SQL.
+ * @param includeParentheses - When `true`, wraps the result in parentheses (used for child groups).
+ * @returns A SQL fragment representing all conditions joined by their operators.
+ */
+function addSelectionFilter(queryItems = [], includeParentheses = false) {
+    const filterClause = [];
+    queryItems.forEach((item) => {
+        const comparison = item.comparison
+            ? item.comparison.toUpperCase()
+            : SqlComparison.Equal;
+        const operator = item.operator ? item.operator.toUpperCase() : '';
+        switch (comparison) {
+            case SqlComparison.Between:
+            case SqlComparison.NotBetween: {
+                filterClause.push(`${item.field} ${comparison} ? AND ?`);
+                break;
+            }
+            case SqlComparison.Like:
+            case SqlComparison.NotLike: {
+                filterClause.push(`${item.field} ${comparison} ?`);
+                break;
+            }
+            case SqlComparison.IsNull:
+            case SqlComparison.IsNotNull: {
+                filterClause.push(`${item.field} ${comparison}`);
+                break;
+            }
+            case SqlComparison.In:
+            case SqlComparison.NotIn: {
+                const values = Array.isArray(item.value1) ? item.value1 : [];
+                const wildcards = values.map(() => {
+                    return '?';
+                });
+                filterClause.push(`${item.field} ${comparison} (${wildcards.join(',')})`);
+                break;
+            }
+            default: {
+                filterClause.push(`${item.field} ${comparison} ?`);
+                break;
+            }
+        }
+        if (operator) {
+            filterClause.push(operator);
+        }
+        if (item.children?.length) {
+            filterClause.push(addSelectionFilter(item.children, true));
+        }
+    });
+    return includeParentheses ? `(${filterClause.join(' ')})` : filterClause.join(' ');
+}
+/**
+ * Returns an `OFFSET <value> ROWS` SQL fragment.
+ * @param value - Number of rows to skip.
+ * @returns The OFFSET clause string.
+ */
+function addOffset(value) {
+    return `OFFSET ${value} ROWS`;
+}
+/**
+ * Returns a `FETCH NEXT <value> ROWS ONLY` SQL fragment.
+ * @param value - Maximum number of rows to return.
+ * @returns The FETCH clause string.
+ */
+function addLimit(value) {
+    return `FETCH NEXT ${value} ROWS ONLY`;
+}
+/**
+ * Returns a `WHERE ...` clause, or an empty string when there are no filters.
+ * @param queryItems - Array of filter conditions, or `undefined`.
+ * @returns A `WHERE ...` SQL fragment, or `''` when `queryItems` is empty.
+ */
+function addWhere(queryItems) {
+    if (!queryItems?.length) {
+        return '';
+    }
+    return `WHERE ${addSelectionFilter(queryItems)}`;
+}
+/**
+ * Builds a `SET col = ?, ...` fragment and collects the corresponding parameter values.
+ * The `id` column is automatically excluded from the SET clause.
+ * @param update - Key-value pairs to assign (the `id` key is skipped).
+ * @returns A parameterised SET clause and its ordered bind values.
+ */
+function buildUpdate(update, idField = 'id') {
+    const setClause = ['SET'];
+    const parameters = [];
+    const keys = Object.keys(update).filter((key) => {
+        return key !== idField;
+    });
+    keys.forEach((key, index) => {
+        parameters.push(update[key]);
+        const suffix = index < keys.length - 1 ? ',' : '';
+        setClause.push(`${key} = ?${suffix}`);
+    });
+    return {
+        statement: setClause.join(' '),
+        parameters
+    };
+}
+/**
+ * Recursively extracts the ordered list of bind parameters from a filter tree.
+ * @param queryItems - Array of filter conditions to extract parameters from.
+ * @returns Flat array of bind values in the same order as the `?` placeholders in the SQL.
+ */
+function getParameters(queryItems = []) {
+    let parameters = [];
+    queryItems.forEach((item) => {
+        const comparison = item.comparison
+            ? item.comparison.toUpperCase()
+            : SqlComparison.Equal;
+        if (comparison === SqlComparison.In || comparison === SqlComparison.NotIn) {
+            parameters = parameters.concat(item.value1);
+        }
+        else if (comparison !== SqlComparison.IsNull && comparison !== SqlComparison.IsNotNull) {
+            parameters.push(item.value1);
+        }
+        if (isDefined(item.value2)) {
+            parameters.push(item.value2);
+        }
+        if (item.children?.length) {
+            parameters = parameters.concat(getParameters(item.children));
+        }
+    });
+    return parameters;
+}
+/** Generates parameterised PostgreSQL SQL statements from a query-builder AST. */
+export class QueryBuilder {
+    /**
+     * Builds a `SELECT COUNT(*) AS count FROM …` query.
+     * @param queryOptions - Query AST including table name and optional WHERE clause.
+     * @returns A parameterised SQL statement and its bind values, ready to execute.
+     */
+    static buildCountQuery(queryOptions) {
+        const statementPieces = ['SELECT'];
+        if (queryOptions.isDistinct) {
+            statementPieces.push('DISTINCT');
+        }
+        statementPieces.push('COUNT(*) AS count');
+        statementPieces.push(addFrom(queryOptions.tableName));
+        statementPieces.push(addWhere(queryOptions.where));
+        return {
+            statement: numberParams(statementPieces.filter(Boolean).join(' ')),
+            parameters: getParameters(queryOptions.where)
+        };
+    }
+    /**
+     * Builds a `SELECT … FROM … WHERE … ORDER BY … OFFSET … FETCH NEXT …` query.
+     * @param queryOptions - Full query AST including fields, pagination, sorting, and filters.
+     * @returns A parameterised SQL statement and its bind values, ready to execute.
+     */
+    static buildSelectQuery(queryOptions) {
+        const statementPieces = ['SELECT'];
+        if (queryOptions.isDistinct) {
+            statementPieces.push('DISTINCT');
+        }
+        statementPieces.push(addFields(queryOptions.fields));
+        statementPieces.push(addFrom(queryOptions.tableName));
+        statementPieces.push(addWhere(queryOptions.where));
+        statementPieces.push(addOrderBy(queryOptions));
+        if (isDefined(queryOptions.limit)) {
+            const offset = queryOptions.offset ?? 0;
+            statementPieces.push(addOffset(offset));
+            statementPieces.push(addLimit(queryOptions.limit));
+        }
+        return {
+            statement: numberParams(statementPieces.filter(Boolean).join(' ')),
+            parameters: getParameters(queryOptions.where)
+        };
+    }
+    /**
+     * Builds a `DELETE FROM … WHERE …` query, with an optional `RETURNING` clause.
+     * @param queryOptions - Query AST including table name and WHERE clause.
+     * @param returning - Column names to include in a `RETURNING` clause (e.g. `['id']`).
+     * @returns A parameterised SQL statement and its bind values, ready to execute.
+     */
+    static buildDeleteQuery(queryOptions, returning) {
+        const returningClause = returning?.length ? `RETURNING ${returning.join(', ')}` : '';
+        return {
+            statement: numberParams(['DELETE FROM', queryOptions.tableName, addWhere(queryOptions.where), returningClause]
+                .filter(Boolean)
+                .join(' ')),
+            parameters: getParameters(queryOptions.where)
+        };
+    }
+    /**
+     * Builds an `UPDATE … SET … WHERE …` query, with an optional `RETURNING` clause.
+     * @param queryOptions - Query AST including table name and WHERE clause.
+     * @param update - Key-value pairs to assign in the SET clause (`id` is excluded automatically).
+     * @param returning - Column names to include in a `RETURNING` clause (e.g. `['id']`).
+     * @returns A parameterised SQL statement and its bind values, ready to execute.
+     */
+    static buildUpdateQuery(queryOptions, update, returning, idField = 'id') {
+        const updateClause = buildUpdate(update, idField);
+        const returningClause = returning?.length ? `RETURNING ${returning.join(', ')}` : '';
+        return {
+            statement: numberParams([
+                'UPDATE',
+                queryOptions.tableName,
+                updateClause.statement,
+                addWhere(queryOptions.where),
+                returningClause
+            ]
+                .filter(Boolean)
+                .join(' ')),
+            parameters: updateClause.parameters.concat(getParameters(queryOptions.where))
+        };
+    }
+}
+//# sourceMappingURL=QueryBuilder.js.map

package/dist/classes/QueryBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryBuilder.js","sourceRoot":"","sources":["../../src/classes/QueryBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAA;AAM7D;;;;GAIG;AACH,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAA;AAC9C,CAAC;AAED;;;;GAIG;AACH,SAAS,YAAY,CAAC,SAAiB;IACrC,IAAI,CAAC,GAAG,CAAC,CAAA;IACT,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAA;AAClD,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,MAA4B;IAC7C,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;AAChD,CAAC;AAED;;;;;GAKG;AACH,SAAS,OAAO,CAAC,SAAkB;IACjC,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,eAAe,CAAC,0CAA0C,CAAC,CAAA;IACvE,CAAC;IACD,OAAO,QAAQ,SAAS,EAAE,CAAA;AAC5B,CAAC;AAED;;;;GAIG;AACH,SAAS,UAAU,CAAC,YAA2B;IAC7C,MAAM,KAAK,GAAY,YAAY,CAAC,OAAO,IAAI,EAAE,CAAA;IACjD,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAW,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;IAC9E,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IACxC,OAAO,YAAY,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;AAC7C,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,aAA6B,EAAE,EAAE,kBAAkB,GAAG,KAAK;IACrF,MAAM,YAAY,GAAa,EAAE,CAAA;IAEjC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAkB,EAAQ,EAAE;QAC9C,MAAM,UAAU,GAAkB,IAAI,CAAC,UAAU;YAC/C,CAAC,CAAE,IAAI,CAAC,UAAU,CAAC,WAAW,EAAoB;YAClD,CAAC,CAAC,aAAa,CAAC,KAAK,CAAA;QACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QAEjE,QAAQ,UAAU,EAAE,CAAC;YACnB,KAAK,aAAa,CAAC,OAAO,CAAC;YAC3B,KAAK,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC9B,YAAY,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,UAAU,UAAU,CAAC,CAAA;gBACxD,MAAK;YACP,CAAC;YACD,KAAK,aAAa,CAAC,IAAI,CAAC;YACxB,KAAK,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC3B,YAAY,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,UAAU,IAAI,CAAC,CAAA;gBAClD,MAAK;YACP,CAAC;YACD,KAAK,aAAa,CAAC,MAAM,CAAC;YAC1B,KAAK,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC7B,YAAY,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,UAAU,EAAE,CAAC,CAAA;gBAChD,MAAK;YACP,CAAC;YACD,KAAK,aAAa,CAAC,EAAE,CAAC;YACtB,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;gBACzB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAA;gBAC5D,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,GAAW,EAAE;oBACxC,OAAO,GAAG,CAAA;gBACZ,CAAC,CAAC,CAAA;gBACF,YAAY,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBACzE,MAAK;YACP,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,YAAY,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,UAAU,IAAI,CAAC,CAAA;gBAClD,MAAK;YACP,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC7B,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;YAC1B,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;QAC5D,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,kBAAkB,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACpF,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,UAAU,KAAK,OAAO,CAAA;AAC/B,CAAC;AAED;;;;GAIG;AACH,SAAS,QAAQ,CAAC,KAAa;IAC7B,OAAO,cAAc,KAAK,YAAY,CAAA;AACxC,CAAC;AAED;;;;GAIG;AACH,SAAS,QAAQ,CAAC,UAAsC;IACtD,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QACxB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,OAAO,SAAS,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAA;AAClD,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,MAA+B,EAAE,OAAO,GAAG,IAAI;IAClE,MAAM,SAAS,GAAG,CAAC,KAAK,CAAC,CAAA;IACzB,MAAM,UAAU,GAAc,EAAE,CAAA;IAChC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;QAC9C,OAAO,GAAG,KAAK,OAAO,CAAA;IACxB,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,KAAa,EAAE,EAAE;QAC1C,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;QAC5B,MAAM,MAAM,GAAG,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;QACjD,SAAS,CAAC,IAAI,CAAC,GAAG,GAAG,OAAO,MAAM,EAAE,CAAC,CAAA;IACvC,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC;QAC9B,UAAU;KACX,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,aAA6B,EAAE;IACpD,IAAI,UAAU,GAAc,EAAE,CAAA;IAE9B,UAAU,CAAC,OAAO,CAAC,CAAC,IAAkB,EAAE,EAAE;QACxC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU;YAChC,CAAC,CAAE,IAAI,CAAC,UAAU,CAAC,WAAW,EAAoB;YAClD,CAAC,CAAC,aAAa,CAAC,KAAK,CAAA;QAEvB,IAAI,UAAU,KAAK,aAAa,CAAC,EAAE,IAAI,UAAU,KAAK,aAAa,CAAC,KAAK,EAAE,CAAC;YAC1E,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,MAAuB,CAAC,CAAA;QAC9D,CAAC;aAAM,IAAI,UAAU,KAAK,aAAa,CAAC,MAAM,IAAI,UAAU,KAAK,aAAa,CAAC,SAAS,EAAE,CAAC;YACzF,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC9B,CAAC;QAED,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC9B,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;YAC1B,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC9D,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,UAAU,CAAA;AACnB,CAAC;AAED,kFAAkF;AAClF,MAAM,OAAO,YAAY;IACvB;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAC,YAA2B;QACvD,MAAM,eAAe,GAAa,CAAC,QAAQ,CAAC,CAAA;QAC5C,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;YAC5B,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QACD,eAAe,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QACzC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAA;QACrD,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAA;QAElD,OAAO;YACL,SAAS,EAAE,YAAY,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClE,UAAU,EAAE,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC;SAC9C,CAAA;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,YAA2B;QACxD,MAAM,eAAe,GAAa,CAAC,QAAQ,CAAC,CAAA;QAC5C,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;YAC5B,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QACD,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAA;QACpD,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAA;QACrD,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAA;QAClD,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAA;QAE9C,IAAI,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,IAAI,CAAC,CAAA;YACvC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAA;YACvC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAM,CAAC,CAAC,CAAA;QACrD,CAAC;QAED,OAAO;YACL,SAAS,EAAE,YAAY,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClE,UAAU,EAAE,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC;SAC9C,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,YAA2B,EAAE,SAAoB;QAC9E,MAAM,eAAe,GAAG,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QACpF,OAAO;YACL,SAAS,EAAE,YAAY,CACrB,CAAC,aAAa,EAAE,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC;iBACnF,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,CAAC,GAAG,CAAC,CACb;YACD,UAAU,EAAE,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC;SAC9C,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,gBAAgB,CAC5B,YAA2B,EAC3B,MAA+B,EAC/B,SAAoB,EACpB,OAAO,GAAG,IAAI;QAEd,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACjD,MAAM,eAAe,GAAG,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QACpF,OAAO;YACL,SAAS,EAAE,YAAY,CACrB;gBACE,QAAQ;gBACR,YAAY,CAAC,SAAS;gBACtB,YAAY,CAAC,SAAS;gBACtB,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC;gBAC5B,eAAe;aAChB;iBACE,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,CAAC,GAAG,CAAC,CACb;YACD,UAAU,EAAE,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;SAC9E,CAAA;IACH,CAAC;CACF"}

package/dist/core/crudRouter.d.ts

@@ -0,0 +1,36 @@
+import { type AuthStrategy } from '../auth/AuthStrategy.js';
+import { type ResourceDefinition } from '../core/types.js';
+import type { HttpServer } from '../core/types.js';
+/** Options for {@link registerCrudApi} / {@link createExpressCrudRouter}. */
+export interface CrudApiOptions {
+    /** Auth strategy used for all routes. Defaults to {@link AllowAllAuthStrategy}. */
+    authStrategy?: AuthStrategy;
+    /** Path segment for the query-builder POST route (default: `'query-builder'`). */
+    queryBuilderPath?: string;
+    /** Path for the query-builder preview route (default: `'/query-builder/preview'`). */
+    previewQueryBuilderPath?: string;
+}
+/**
+ * Converts any thrown value to a structured `{ status, code, message, details }` object.
+ * {@link HttpError} subclasses preserve their status; all other errors become 500.
+ * @param error - The caught value to normalise (may be any type).
+ * @returns A plain object with `status`, `code`, `message`, and optional `details`.
+ */
+export declare function normalizeError(error: unknown): {
+    status: number;
+    code: string;
+    message: string;
+    details?: unknown;
+};
+/**
+ * Registers all CRUD routes for every resource on the given HTTP server.
+ *
+ * Routes are controlled by `resource.permissions` merged with {@link defaultCrudPermissions}.
+ * A global query-builder preview endpoint is also registered at `previewQueryBuilderPath`.
+ *
+ * @param server - The HTTP server adapter to register routes on (e.g. {@link ExpressHttpServer}).
+ * @param resources - Resource definitions to wire up as CRUD endpoints.
+ * @param options - Auth strategy, query-builder path overrides, and preview path overrides.
+ */
+export declare function registerCrudApi(server: HttpServer, resources: ResourceDefinition[], options?: CrudApiOptions): void;
+//# sourceMappingURL=crudRouter.d.ts.map

package/dist/core/crudRouter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crudRouter.d.ts","sourceRoot":"","sources":["../../src/core/crudRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,KAAK,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAYhF,OAAO,EAA2C,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAClG,OAAO,KAAK,EAA6B,UAAU,EAAE,MAAM,iBAAiB,CAAA;AA6C5E,6EAA6E;AAC7E,MAAM,WAAW,cAAc;IAC7B,mFAAmF;IACnF,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,kFAAkF;IAClF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,sFAAsF;IACtF,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC;AAeD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG;IAC9C,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAaA;AAwID;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,UAAU,EAClB,SAAS,EAAE,kBAAkB,EAAE,EAC/B,OAAO,GAAE,cAAmB,GAC3B,IAAI,CA2ON"}