@imqueue/pg-sequelize 4.2.0

package/src/types/PaginationInput.js

@@ -0,0 +1,90 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+/*!
+ * @imqueue/pg-sequelize - Sequelize ORM refines for @imqueue
+ *
+ * I'm Queue Software Project
+ * Copyright (C) 2025  imqueue.com <support@imqueue.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * If you want to use this code in a closed source (commercial) project, you can
+ * purchase a proprietary commercial license. Please contact us at
+ * <support@imqueue.com> to get commercial licensing options.
+ */
+import { property } from '@imqueue/rpc';
+/**
+ * Where a page starts and how big it is.
+ *
+ * @remarks
+ * Turned into Sequelize's `offset`/`limit` by `query.toLimitOptions`, which treats
+ * this input as advisory rather than authoritative — see the notes on each property.
+ * A negative `limit` is the interesting case: it means "the last N rows", and it is
+ * the only reason `count` exists.
+ */
+export class PaginationInput {
+    /**
+     * Rows to skip before the page starts.
+     *
+     * @remarks
+     * Ignored when `limit` is absent or zero, since there is then no page to
+     * position. With a negative `limit` and an `offset` of zero it is computed
+     * instead — see `limit`.
+     */
+    offset;
+    /**
+     * Rows in the page. Negative counts back from the end of the set.
+     *
+     * @remarks
+     * Zero, absent or non-numeric means no pagination at all: `toLimitOptions`
+     * returns an empty options object and the query is left unbounded. That is a
+     * quiet default worth knowing about — a caller who sends `limit: 0` expecting
+     * "no rows" gets every row.
+     *
+     * A negative value takes the absolute value as the page size and, when `offset`
+     * is zero, positions the window at the end of the set: `count - limit`, clamped
+     * at zero. So `{ limit: -10, count: 1340 }` is the last ten rows. Without a
+     * `count` the offset computes to a negative number and clamps to zero, giving
+     * the FIRST ten rows rather than the last — the two properties go together.
+     */
+    limit;
+    /**
+     * Total rows in the set, used only to place a negative `limit`.
+     *
+     * @remarks
+     * Nothing validates it against the real total, and it is ignored entirely for a
+     * positive `limit`.
+     */
+    count;
+}
+__decorate([
+    property('number'),
+    __metadata("design:type", Number)
+], PaginationInput.prototype, "offset", void 0);
+__decorate([
+    property('number'),
+    __metadata("design:type", Number)
+], PaginationInput.prototype, "limit", void 0);
+__decorate([
+    property('number', true),
+    __metadata("design:type", Number)
+], PaginationInput.prototype, "count", void 0);
+//# sourceMappingURL=PaginationInput.js.map

package/src/types/index.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * @imqueue/pg-sequelize - Sequelize ORM refines for @imqueue
+ *
+ * I'm Queue Software Project
+ * Copyright (C) 2025  imqueue.com <support@imqueue.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * If you want to use this code in a closed source (commercial) project, you can
+ * purchase a proprietary commercial license. Please contact us at
+ * <support@imqueue.com> to get commercial licensing options.
+ */
+export * from './ranges/index.js';
+export * from './FieldsInput.js';
+export * from './FilterInput.js';
+export * from './PaginationInput.js';
+export * from './OrderByInput.js';
+export * from './JsonObject.js';
+export * from './DataPage.js';

package/src/types/index.js

@@ -0,0 +1,31 @@
+/*!
+ * @imqueue/pg-sequelize - Sequelize ORM refines for @imqueue
+ *
+ * I'm Queue Software Project
+ * Copyright (C) 2025  imqueue.com <support@imqueue.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * If you want to use this code in a closed source (commercial) project, you can
+ * purchase a proprietary commercial license. Please contact us at
+ * <support@imqueue.com> to get commercial licensing options.
+ */
+export * from './ranges/index.js';
+export * from './FieldsInput.js';
+export * from './FilterInput.js';
+export * from './PaginationInput.js';
+export * from './OrderByInput.js';
+export * from './JsonObject.js';
+export * from './DataPage.js';
+//# sourceMappingURL=index.js.map

package/src/types/ranges/DateRange.d.ts

@@ -0,0 +1,27 @@
+import { type IRange } from './IRange.js';
+/**
+ * A range between two dates, as an `@imqueue/rpc` type.
+ *
+ * @remarks
+ * Accepts a `Date` or an ISO-8601 string on either bound, because a remote caller
+ * has only the string — a `Date` does not survive JSON.
+ *
+ * Used through the `Range`-suffix convention rather than by naming the column
+ * directly: filter `<column>Range` and `query.withRangeFilters` moves it onto
+ * `<column>`. Passing both forms for one column throws a `TypeError` rather than
+ * silently preferring one.
+ *
+ * @example
+ * ```typescript
+ * // reservations whose `duration` column falls inside the window
+ * const filter = {
+ *     durationRange: { start: '2026-08-01', end: '2026-08-31' },
+ * } as FilterInput;
+ * ```
+ */
+export declare class DateRange implements IRange {
+    /** Start of the range — a `Date`, or an ISO-8601 string from a remote caller. */
+    start: string | Date;
+    /** End of the range — a `Date`, or an ISO-8601 string from a remote caller. */
+    end: string | Date;
+}

package/src/types/ranges/DateRange.js

@@ -0,0 +1,69 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+/*!
+ * @imqueue/pg-sequelize - Sequelize ORM refines for @imqueue
+ *
+ * I'm Queue Software Project
+ * Copyright (C) 2025  imqueue.com <support@imqueue.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * If you want to use this code in a closed source (commercial) project, you can
+ * purchase a proprietary commercial license. Please contact us at
+ * <support@imqueue.com> to get commercial licensing options.
+ */
+import { property } from '@imqueue/rpc';
+import {} from './IRange.js';
+/**
+ * A range between two dates, as an `@imqueue/rpc` type.
+ *
+ * @remarks
+ * Accepts a `Date` or an ISO-8601 string on either bound, because a remote caller
+ * has only the string — a `Date` does not survive JSON.
+ *
+ * Used through the `Range`-suffix convention rather than by naming the column
+ * directly: filter `<column>Range` and `query.withRangeFilters` moves it onto
+ * `<column>`. Passing both forms for one column throws a `TypeError` rather than
+ * silently preferring one.
+ *
+ * @example
+ * ```typescript
+ * // reservations whose `duration` column falls inside the window
+ * const filter = {
+ *     durationRange: { start: '2026-08-01', end: '2026-08-31' },
+ * } as FilterInput;
+ * ```
+ */
+export class DateRange {
+    /** Start of the range — a `Date`, or an ISO-8601 string from a remote caller. */
+    start;
+    /** End of the range — a `Date`, or an ISO-8601 string from a remote caller. */
+    end;
+}
+__decorate([
+    property('string | Date'),
+    __metadata("design:type", Object)
+], DateRange.prototype, "start", void 0);
+__decorate([
+    property('string | Date'),
+    __metadata("design:type", Object)
+], DateRange.prototype, "end", void 0);
+//# sourceMappingURL=DateRange.js.map

package/src/types/ranges/IRange.d.ts

@@ -0,0 +1,47 @@
+/*!
+ * @imqueue/pg-sequelize - Sequelize ORM refines for @imqueue
+ *
+ * I'm Queue Software Project
+ * Copyright (C) 2025  imqueue.com <support@imqueue.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * If you want to use this code in a closed source (commercial) project, you can
+ * purchase a proprietary commercial license. Please contact us at
+ * <support@imqueue.com> to get commercial licensing options.
+ */
+/**
+ * The shape every range filter shares: a start and an end.
+ *
+ * @remarks
+ * `query.withRangeFilters` recognises a range by exactly these two keys, in either
+ * order, on a filter property whose name ends in `Range`. So the property NAMES are
+ * the contract — an object with any other key set is left alone and filtered as an
+ * ordinary value.
+ *
+ * The convention it implements: a caller filters `durationRange` and the helper
+ * rewrites it onto the real `duration` column. Sending both `duration` and
+ * `durationRange` is an error rather than a merge — see
+ * {@link DateRange} for the worked example.
+ *
+ * Deliberately untyped at `any`, so a range of anything Postgres supports can
+ * implement it; {@link DateRange} and {@link NumericRange} are the two the package
+ * ships.
+ */
+export interface IRange {
+    /** Lower bound of the range. */
+    start: any;
+    /** Upper bound of the range. */
+    end: any;
+}

package/src/types/ranges/IRange.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IRange.js.map

package/src/types/ranges/NumericRange.d.ts

@@ -0,0 +1,19 @@
+import { type IRange } from './IRange.js';
+/**
+ * A range between two numbers, as an `@imqueue/rpc` type.
+ *
+ * @remarks
+ * The numeric counterpart of {@link DateRange}, and used the same way: filter
+ * `<column>Range` and `query.withRangeFilters` rewrites it onto `<column>`.
+ *
+ * @example
+ * ```typescript
+ * const filter = { priceRange: { start: 10, end: 100 } } as FilterInput;
+ * ```
+ */
+export declare class NumericRange implements IRange {
+    /** Lower bound of the range. */
+    start: number;
+    /** Upper bound of the range. */
+    end: number;
+}

package/src/types/ranges/NumericRange.js

@@ -0,0 +1,61 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+/*!
+ * @imqueue/pg-sequelize - Sequelize ORM refines for @imqueue
+ *
+ * I'm Queue Software Project
+ * Copyright (C) 2025  imqueue.com <support@imqueue.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * If you want to use this code in a closed source (commercial) project, you can
+ * purchase a proprietary commercial license. Please contact us at
+ * <support@imqueue.com> to get commercial licensing options.
+ */
+import { property } from '@imqueue/rpc';
+import {} from './IRange.js';
+/**
+ * A range between two numbers, as an `@imqueue/rpc` type.
+ *
+ * @remarks
+ * The numeric counterpart of {@link DateRange}, and used the same way: filter
+ * `<column>Range` and `query.withRangeFilters` rewrites it onto `<column>`.
+ *
+ * @example
+ * ```typescript
+ * const filter = { priceRange: { start: 10, end: 100 } } as FilterInput;
+ * ```
+ */
+export class NumericRange {
+    /** Lower bound of the range. */
+    start;
+    /** Upper bound of the range. */
+    end;
+}
+__decorate([
+    property('number'),
+    __metadata("design:type", Number)
+], NumericRange.prototype, "start", void 0);
+__decorate([
+    property('number'),
+    __metadata("design:type", Number)
+], NumericRange.prototype, "end", void 0);
+//# sourceMappingURL=NumericRange.js.map

package/src/types/ranges/index.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * @imqueue/pg-sequelize - Sequelize ORM refines for @imqueue
+ *
+ * I'm Queue Software Project
+ * Copyright (C) 2025  imqueue.com <support@imqueue.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * If you want to use this code in a closed source (commercial) project, you can
+ * purchase a proprietary commercial license. Please contact us at
+ * <support@imqueue.com> to get commercial licensing options.
+ */
+export * from './IRange.js';
+export * from './DateRange.js';
+export * from './NumericRange.js';

package/src/types/ranges/index.js

@@ -0,0 +1,27 @@
+/*!
+ * @imqueue/pg-sequelize - Sequelize ORM refines for @imqueue
+ *
+ * I'm Queue Software Project
+ * Copyright (C) 2025  imqueue.com <support@imqueue.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * If you want to use this code in a closed source (commercial) project, you can
+ * purchase a proprietary commercial license. Please contact us at
+ * <support@imqueue.com> to get commercial licensing options.
+ */
+export * from './IRange.js';
+export * from './DateRange.js';
+export * from './NumericRange.js';
+//# sourceMappingURL=index.js.map