@ahoo-wang/wow-client 9.2.0-rc.0

package/dist/dsl/filter/types.d.ts

@@ -0,0 +1,274 @@
+import { AggregationExpression, ComparisonOperator } from '../aggregation/types.js';
+import { DeletionState } from '../deletionState.js';
+import { FilterOperator, SearchMode, StringComparison, TimeUnit } from './operator.js';
+/**
+ * Dot-separated logical field path. The first segment is a name; later
+ * segments are names or decimal array indexes. A name may start with `@`,
+ * begins with an ASCII letter or `_`, and continues with ASCII letters,
+ * digits, `_` or `-`. Builders throw `TypeError` for any other string.
+ */
+export type QueryField<FIELDS extends string = string> = FIELDS;
+/**
+ * JSON scalar accepted as a filter value. Numbers must be finite.
+ */
+export type FilterLiteral = null | string | number | boolean;
+/**
+ * Value accepted by `EQ` and `NE`, including `null`.
+ */
+export type EqualityFilterValue = FilterLiteral;
+/**
+ * Non-null JSON scalar accepted by comparison, range and collection filters.
+ */
+export type ComparableFilterLiteral = Exclude<FilterLiteral, null>;
+/**
+ * Constant filter: `MATCH_ALL` matches everything in the query scope,
+ * `MATCH_NONE` matches nothing.
+ */
+export type MatchFilter = {
+    op: FilterOperator.MATCH_ALL | FilterOperator.MATCH_NONE;
+};
+/**
+ * Root-only filter on one system identifier: record ID, aggregate ID,
+ * tenant, owner or space.
+ */
+export type MetadataValueFilter = {
+    op: FilterOperator.ID | FilterOperator.AGGREGATE_ID | FilterOperator.TENANT_ID | FilterOperator.OWNER_ID | FilterOperator.SPACE_ID;
+    value: string;
+};
+/**
+ * Root-only filter on a non-empty set of record IDs or aggregate IDs.
+ */
+export type MetadataValuesFilter = {
+    op: FilterOperator.IDS | FilterOperator.AGGREGATE_IDS;
+    values: string[];
+};
+/**
+ * Any root-only system identifier filter.
+ */
+export type MetadataFilter = MetadataValueFilter | MetadataValuesFilter;
+/**
+ * `AND`, `OR` or `NOR` over a non-empty list of filter expressions.
+ */
+export type LogicalFilter<FIELDS extends string = string> = {
+    op: FilterOperator.AND | FilterOperator.OR | FilterOperator.NOR;
+    operands: FilterExpression<FIELDS>[];
+};
+/**
+ * `AND`, `OR` or `NOR` whose operands are all valid inside an
+ * `ELEMENT_MATCH` predicate.
+ */
+export type ElementLogicalFilter<FIELDS extends string = string> = {
+    op: FilterOperator.AND | FilterOperator.OR | FilterOperator.NOR;
+    operands: ElementFilterExpression<FIELDS>[];
+};
+/**
+ * `EQ` or `NE` on a field. The server rewrites a `null` value to `IS_NULL`
+ * or `IS_NOT_NULL`.
+ */
+export type EqualityFilter<FIELDS extends string = string> = {
+    op: FilterOperator.EQ | FilterOperator.NE;
+    field: QueryField<FIELDS>;
+    value: EqualityFilterValue;
+};
+/**
+ * `GT`, `GTE`, `LT` or `LTE` on a field against a non-null scalar.
+ */
+export type ComparisonFilter<FIELDS extends string = string> = {
+    op: FilterOperator.GT | FilterOperator.GTE | FilterOperator.LT | FilterOperator.LTE;
+    field: QueryField<FIELDS>;
+    value: ComparableFilterLiteral;
+};
+/**
+ * Literal substring, prefix or suffix match on a string field. No full-text
+ * analyzer is applied. `stringComparison` defaults to `CASE_SENSITIVE`.
+ */
+export type StringFilter<FIELDS extends string = string> = {
+    op: FilterOperator.CONTAINS | FilterOperator.STARTS_WITH | FilterOperator.ENDS_WITH;
+    field: QueryField<FIELDS>;
+    value: string;
+    stringComparison?: StringComparison;
+};
+/**
+ * `IN`, `NOT_IN` or `CONTAINS_ALL` on a field against a non-empty list of
+ * non-null scalars.
+ */
+export type CollectionFilter<FIELDS extends string = string> = {
+    op: FilterOperator.IN | FilterOperator.NOT_IN | FilterOperator.CONTAINS_ALL;
+    field: QueryField<FIELDS>;
+    values: ComparableFilterLiteral[];
+};
+/**
+ * Inclusive range on a field: `lowerBound <= field <= upperBound`.
+ */
+export type BetweenFilter<FIELDS extends string = string> = {
+    op: FilterOperator.BETWEEN;
+    field: QueryField<FIELDS>;
+    lowerBound: ComparableFilterLiteral;
+    upperBound: ComparableFilterLiteral;
+};
+/**
+ * Operand-free check of a field's null, existence, empty-collection or
+ * empty-string state.
+ */
+export type FieldPresenceFilter<FIELDS extends string = string> = {
+    op: FilterOperator.IS_EMPTY | FilterOperator.IS_EMPTY_STRING | FilterOperator.IS_NOT_EMPTY_STRING | FilterOperator.IS_NULL | FilterOperator.IS_NOT_NULL | FilterOperator.EXISTS | FilterOperator.NOT_EXISTS;
+    field: QueryField<FIELDS>;
+};
+/**
+ * Root-only filter on the deletion state of snapshots.
+ */
+export type DeletionFilter = {
+    op: FilterOperator.DELETION;
+    state: DeletionState;
+};
+/**
+ * Matches when a single element of the array `field` satisfies `predicate`.
+ * Predicate fields are relative to the element.
+ */
+export type ElementMatchFilter<FIELDS extends string = string, ELEMENT_FIELDS extends string = string> = {
+    op: FilterOperator.ELEMENT_MATCH;
+    field: QueryField<FIELDS>;
+    predicate: ElementFilterExpression<ELEMENT_FIELDS>;
+};
+/**
+ * Full-text search. Matching depends on the backend's index and analyzer.
+ * Empty `fields` means the backend's default search fields, a model-wide
+ * search, which only a record can answer; inside an `ELEMENT_MATCH` a
+ * search must name its fields: see {@link ElementSearchFilter}.
+ */
+export type SearchFilter<FIELDS extends string = string> = {
+    op: FilterOperator.SEARCH;
+    query: string;
+    fields?: QueryField<FIELDS>[];
+    /**
+     * Matching mode. Defaults to `SearchMode.TERMS`.
+     */
+    mode?: SearchMode;
+};
+/**
+ * A `SEARCH` that names at least one field: the only search an
+ * `ELEMENT_MATCH` predicate takes, with fields relative to the element.
+ * `filter.search(query, { fields: ['name'] })` builds one. Wow 9.2 and
+ * later, on a storage that lists `elements[].search` in the descriptor.
+ */
+export type ElementSearchFilter<FIELDS extends string = string> = SearchFilter<FIELDS> & {
+    fields: [QueryField<FIELDS>, ...QueryField<FIELDS>[]];
+};
+/**
+ * Options for {@link filter.search}.
+ */
+export interface SearchFilterOptions<FIELDS extends string = string> {
+    /**
+     * Fields to search. Defaults to `[]`, the backend's default search fields.
+     */
+    fields?: readonly QueryField<FIELDS>[];
+    /**
+     * Matching mode. Defaults to `SearchMode.TERMS`.
+     */
+    mode?: SearchMode;
+}
+/**
+ * Options shared by relative time filters. Unset options are omitted from
+ * the payload, except `timeUnit`, which the builders always send.
+ */
+export interface RelativeTimeFilterOptions {
+    /**
+     * Time zone that defines calendar days, e.g. `Asia/Shanghai` or `+08:00`.
+     * Defaults to the server process time zone. Must not be blank. A value
+     * that starts with an optional `UTC`, `GMT` or `UT` prefix followed by `+`
+     * or `-` must be a valid offset within +/-18:00; region IDs are checked by
+     * the server only.
+     */
+    zoneId?: string;
+    /**
+     * `java.time.format.DateTimeFormatter` pattern for fields stored as
+     * formatted strings, e.g. `yyyy-MM-dd`. Must equal the pattern declared by
+     * the query schema. Must not be blank.
+     */
+    datePattern?: string;
+    /**
+     * Unit of a numeric epoch field. Defaults to `TimeUnit.MILLISECONDS`.
+     * Ignored when `datePattern` is set.
+     */
+    timeUnit?: TimeUnit;
+}
+/**
+ * Matches times in a calendar window relative to now: `[start, end)` in the
+ * configured time zone. Weeks start on Monday.
+ */
+export type CalendarFilter<FIELDS extends string = string> = RelativeTimeFilterOptions & {
+    op: FilterOperator.TODAY | FilterOperator.TOMORROW | FilterOperator.THIS_WEEK | FilterOperator.NEXT_WEEK | FilterOperator.LAST_WEEK | FilterOperator.THIS_MONTH | FilterOperator.LAST_MONTH | FilterOperator.YESTERDAY | FilterOperator.NEXT_MONTH | FilterOperator.LAST_YEAR | FilterOperator.THIS_YEAR | FilterOperator.NEXT_YEAR;
+    field: QueryField<FIELDS>;
+};
+/**
+ * Matches times earlier than today at the local time `time`.
+ */
+export type BeforeTodayFilter<FIELDS extends string = string> = RelativeTimeFilterOptions & {
+    op: FilterOperator.BEFORE_TODAY;
+    field: QueryField<FIELDS>;
+    time: string;
+};
+/**
+ * `RECENT_DAYS` matches today and the `days - 1` previous calendar days;
+ * `EARLIER_DAYS` matches times before that window.
+ */
+export type DaysFilter<FIELDS extends string = string> = RelativeTimeFilterOptions & {
+    op: FilterOperator.RECENT_DAYS | FilterOperator.EARLIER_DAYS;
+    field: QueryField<FIELDS>;
+    days: number;
+};
+/**
+ * `BEFORE_NOW` matches times strictly before the server's `now + offset`;
+ * `AFTER_NOW` matches times strictly after it. The server reads its clock
+ * once per query, so every condition of one query compares against the same
+ * moment and a saved query never depends on the client's clock. `offset` is
+ * an ISO-8601 duration (`PT0S`, `-PT30M`, `P1DT2H`); a negative offset looks
+ * back.
+ *
+ * Needs a Wow server of 9.2.0 or later; an earlier one refuses the operator.
+ */
+export type NowFilter<FIELDS extends string = string> = RelativeTimeFilterOptions & {
+    op: FilterOperator.BEFORE_NOW | FilterOperator.AFTER_NOW;
+    field: QueryField<FIELDS>;
+    offset: string;
+};
+/**
+ * Filter expression allowed inside an `ELEMENT_MATCH` predicate. Excludes
+ * root-only filters: system identifiers, `DELETION` and a model-wide
+ * `SEARCH`; a `SEARCH` that names its fields is an element predicate. An
+ * aggregation element's filter takes no `SEARCH` at all, which
+ * {@link aggregation.element} checks when it runs.
+ */
+export type ElementFilterExpression<FIELDS extends string = string> = MatchFilter | ElementLogicalFilter<FIELDS> | EqualityFilter<FIELDS> | ComparisonFilter<FIELDS> | StringFilter<FIELDS> | CollectionFilter<FIELDS> | BetweenFilter<FIELDS> | FieldPresenceFilter<FIELDS> | ElementMatchFilter<FIELDS> | CalendarFilter<FIELDS> | BeforeTodayFilter<FIELDS> | DaysFilter<FIELDS> | NowFilter<FIELDS> | ElementSearchFilter<FIELDS>;
+/**
+ * A computed expression compared with a number; {@link filter.expression}.
+ * The expression is an {@link AggregationExpression}, such as a `DATE_DIFF`
+ * between two time fields, evaluated per record. A record whose expression
+ * has no value (an operand is absent or holds several values, or a division
+ * by zero) does not match, whatever the comparison, `NE` included.
+ *
+ * Allowed at the root, in a metric's filter and in an aggregation element's
+ * filter, but not inside `ELEMENT_MATCH`. It is an expensive operator: the
+ * descriptor lists `EXPRESSION` in `record.rootOperators` only where the
+ * server allows expensive operators. Wow 9.2 and later.
+ */
+export type ExpressionFilter<FIELDS extends string = string> = {
+    op: FilterOperator.EXPRESSION;
+    /** The per-record value compared; it reads at least one field. */
+    expression: AggregationExpression<FIELDS>;
+    /** How the value compares with `value`. */
+    comparison: ComparisonOperator;
+    /** A finite number. */
+    value: number;
+};
+/**
+ * Filter expression sent to the query API. Build values with
+ * {@link filter}.
+ */
+export type FilterExpression<FIELDS extends string = string> = MatchFilter | MetadataFilter | LogicalFilter<FIELDS> | EqualityFilter<FIELDS> | ComparisonFilter<FIELDS> | StringFilter<FIELDS> | CollectionFilter<FIELDS> | BetweenFilter<FIELDS> | FieldPresenceFilter<FIELDS> | DeletionFilter | ElementMatchFilter<FIELDS> | SearchFilter<FIELDS> | CalendarFilter<FIELDS> | BeforeTodayFilter<FIELDS> | DaysFilter<FIELDS> | NowFilter<FIELDS> | ExpressionFilter<FIELDS>;
+/**
+ * Query that carries a filter expression.
+ */
+export interface FilterCapable<FIELDS extends string = string> {
+    filter: FilterExpression<FIELDS>;
+}

package/dist/dsl/filter/validate.cjs

@@ -0,0 +1,2 @@
+const e=require("./operator.cjs"),t=require("./datePattern.cjs");var n=/^([01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?$/,r=/^(?:UTC|GMT|UT)?[+-](\d{1,2}|\d{4}|\d{6}|\d{2}:\d{2}|\d{2}:\d{2}:\d{2})$/,i=/^(?:UTC|GMT|UT)?[+-]/,a=/^[-+]?P(?=.*[0-9])(?:[-+]?[0-9]+D)?(?:T(?=[-+]?[0-9])(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]{0,9})?S)?)?$/i;function o(e,t){if(!(e===null?t:typeof e==`string`||typeof e==`boolean`||typeof e==`number`&&Number.isFinite(e)))throw TypeError(`Filter value must be a JSON scalar.`);return e}function s(e,t){if(typeof t!=`string`)throw TypeError(`${e} must be a string.`);return t}function c(t){if(t!==e.StringComparison.CASE_SENSITIVE&&t!==e.StringComparison.CASE_INSENSITIVE)throw TypeError(`String comparison is invalid: [${String(t)}].`)}function l(e,t){if(t.length===0)throw TypeError(`${e} cannot be empty.`);if(t.some(e=>e==null))throw TypeError(`${e} cannot contain null.`)}function u(e){let t=r.exec(e);if(!t)return!1;let n=t[1],[i,a=0,o=0]=(n.includes(`:`)?n.split(`:`):n.length<=2?[n]:[n.slice(0,2),n.slice(2,4),n.slice(4,6)]).map(Number);return a<=59&&o<=59&&(i<18||i===18&&a===0&&o===0)}function d({zoneId:n,datePattern:r,timeUnit:a=e.TimeUnit.MILLISECONDS}){if(n!==void 0){if(typeof n!=`string`||!n.trim())throw TypeError(`zoneId cannot be blank.`);if(i.test(n)&&!u(n))throw TypeError(`zoneId is invalid: [${n}].`)}if(r!==void 0&&t.validateDatePattern(r),!Object.values(e.TimeUnit).includes(a))throw TypeError(`timeUnit is invalid: [${String(a)}].`);return{...n===void 0?{}:{zoneId:n},...r===void 0?{}:{datePattern:r},timeUnit:a}}function f(e,t){if(!Number.isInteger(t)||t<1||t>2147483647)throw TypeError(`${e} days must be a positive JVM Int.`)}function p(e,t){if(typeof t!=`string`||!a.test(t))throw TypeError(`${e} offset must be an ISO-8601 duration such as PT0S or -PT30M.`);return t}function m(e){if(typeof e!=`string`||!n.test(e))throw TypeError(`BEFORE_TODAY time is invalid.`);return e}exports.filterLiteral=o,exports.requireDuration=p,exports.requireLocalTime=m,exports.requireNonEmpty=l,exports.requiredString=s,exports.validateDays=f,exports.validateRelativeTimeOptions=d,exports.validateStringComparison=c;
+//# sourceMappingURL=validate.cjs.map

package/dist/dsl/filter/validate.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.cjs","names":["StringComparison","TimeUnit","require_operator","require_datePattern","LOCAL_TIME_PATTERN","OFFSET_ZONE_PATTERN","OFFSET_ZONE_CANDIDATE_PATTERN","DURATION_PATTERN","filterLiteral","value","nullable","requiredString","name","validateStringComparison","comparison","requireNonEmpty","values","isValidOffsetZone","match","zoneId","offset","hours","minutes","seconds","validateRelativeTimeOptions","datePattern","timeUnit","validateDays","days","operator","requireDuration","requireLocalTime","time"],"sources":["../../../src/dsl/filter/validate.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// Internal: not re-exported by filter/index.ts. The argument checks the\n// filter builders share.\nimport { validateDatePattern } from './datePattern.js';\nimport { StringComparison, TimeUnit, type FilterOperator } from './operator.js';\nimport type { FilterLiteral, RelativeTimeFilterOptions } from './types.js';\n\nconst LOCAL_TIME_PATTERN =\n  /^([01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\\.[0-9]{1,9})?)?$/;\nconst OFFSET_ZONE_PATTERN =\n  /^(?:UTC|GMT|UT)?[+-](\\d{1,2}|\\d{4}|\\d{6}|\\d{2}:\\d{2}|\\d{2}:\\d{2}:\\d{2})$/;\nconst OFFSET_ZONE_CANDIDATE_PATTERN = /^(?:UTC|GMT|UT)?[+-]/;\n// java.time.Duration.parse: signed days, hours, minutes and seconds (up to\n// nine fraction digits after `.` or `,`), at least one of them, in that order,\n// case-insensitive. Weeks, months and years are not durations.\nconst DURATION_PATTERN =\n  /^[-+]?P(?=.*[0-9])(?:[-+]?[0-9]+D)?(?:T(?=[-+]?[0-9])(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]{0,9})?S)?)?$/i;\n\nexport function filterLiteral<T extends FilterLiteral>(\n  value: T,\n  nullable: boolean,\n): T {\n  const valid =\n    value === null\n      ? nullable\n      : typeof value === 'string' ||\n        typeof value === 'boolean' ||\n        (typeof value === 'number' && Number.isFinite(value));\n  if (!valid) {\n    throw new TypeError('Filter value must be a JSON scalar.');\n  }\n  return value;\n}\n\nexport function requiredString(name: string, value: string): string {\n  if (typeof value !== 'string') {\n    throw new TypeError(`${name} must be a string.`);\n  }\n  return value;\n}\n\nexport function validateStringComparison(comparison: StringComparison): void {\n  if (\n    comparison !== StringComparison.CASE_SENSITIVE &&\n    comparison !== StringComparison.CASE_INSENSITIVE\n  ) {\n    throw new TypeError(\n      `String comparison is invalid: [${String(comparison)}].`,\n    );\n  }\n}\n\nexport function requireNonEmpty(\n  name: string,\n  values: readonly unknown[],\n): void {\n  if (values.length === 0) {\n    throw new TypeError(`${name} cannot be empty.`);\n  }\n  if (values.some(value => value === null || value === undefined)) {\n    throw new TypeError(`${name} cannot contain null.`);\n  }\n}\n\nfunction isValidOffsetZone(zoneId: string): boolean {\n  const match = OFFSET_ZONE_PATTERN.exec(zoneId);\n  if (!match) return false;\n  const offset = match[1];\n  const parts = offset.includes(':')\n    ? offset.split(':')\n    : offset.length <= 2\n      ? [offset]\n      : [offset.slice(0, 2), offset.slice(2, 4), offset.slice(4, 6)];\n  const [hours, minutes = 0, seconds = 0] = parts.map(Number);\n  return (\n    minutes <= 59 &&\n    seconds <= 59 &&\n    (hours < 18 || (hours === 18 && minutes === 0 && seconds === 0))\n  );\n}\n\nexport function validateRelativeTimeOptions({\n  zoneId,\n  datePattern,\n  timeUnit = TimeUnit.MILLISECONDS,\n}: RelativeTimeFilterOptions): RelativeTimeFilterOptions & {\n  timeUnit: TimeUnit;\n} {\n  if (zoneId !== undefined) {\n    if (typeof zoneId !== 'string' || !zoneId.trim()) {\n      throw new TypeError('zoneId cannot be blank.');\n    }\n    if (\n      OFFSET_ZONE_CANDIDATE_PATTERN.test(zoneId) &&\n      !isValidOffsetZone(zoneId)\n    ) {\n      throw new TypeError(`zoneId is invalid: [${zoneId}].`);\n    }\n  }\n  if (datePattern !== undefined) {\n    validateDatePattern(datePattern);\n  }\n  if (!Object.values(TimeUnit).includes(timeUnit)) {\n    throw new TypeError(`timeUnit is invalid: [${String(timeUnit)}].`);\n  }\n  return {\n    ...(zoneId === undefined ? {} : { zoneId }),\n    ...(datePattern === undefined ? {} : { datePattern }),\n    timeUnit,\n  };\n}\n\nexport function validateDays(operator: FilterOperator, days: number): void {\n  if (!Number.isInteger(days) || days < 1 || days > 2_147_483_647) {\n    throw new TypeError(`${operator} days must be a positive JVM Int.`);\n  }\n}\n\n/**\n * Admits the ISO-8601 duration `BEFORE_NOW` and `AFTER_NOW` add to the\n * server's now, in the grammar `java.time.Duration.parse` accepts. A value\n * too large for a `Duration` is left to the server.\n */\nexport function requireDuration(\n  operator: FilterOperator,\n  offset: string,\n): string {\n  if (typeof offset !== 'string' || !DURATION_PATTERN.test(offset)) {\n    throw new TypeError(\n      `${operator} offset must be an ISO-8601 duration such as PT0S or -PT30M.`,\n    );\n  }\n  return offset;\n}\n\n/** Admits the 24-hour local time `BEFORE_TODAY` compares against. */\nexport function requireLocalTime(time: string): string {\n  if (typeof time !== 'string' || !LOCAL_TIME_PATTERN.test(time)) {\n    throw new TypeError('BEFORE_TODAY time is invalid.');\n  }\n  return time;\n}\n"],"mappings":"iEAmBA,IAAMI,EACJ,mEACIC,EACJ,2EACIC,EAAgC,uBAIhCC,EACJ,kIAEF,SAAgBC,EACd,EACA,EACG,CAOH,GAAI,EALFC,IAAU,KACNC,EACA,OAAOD,GAAU,UACjB,OAAOA,GAAU,WAChB,OAAOA,GAAU,UAAY,OAAO,SAASA,CAAK,GAEvD,MAAU,UAAU,qCAAqC,EAE3D,OAAOA,CACT,CAEA,SAAgBE,EAAe,EAAc,EAAuB,CAClE,GAAI,OAAOF,GAAU,SACnB,MAAU,UAAU,GAAGG,EAAK,mBAAmB,EAEjD,OAAOH,CACT,CAEA,SAAgBI,EAAyB,EAAoC,CAC3E,GACEC,IAAed,EAAAA,iBAAiB,gBAChCc,IAAed,EAAAA,iBAAiB,iBAEhC,MAAU,UACR,kCAAkC,OAAOc,CAAU,EAAE,GACvD,CAEJ,CAEA,SAAgBC,EACd,EACA,EACM,CACN,GAAIC,EAAO,SAAW,EACpB,MAAU,UAAU,GAAGJ,EAAK,kBAAkB,EAEhD,GAAII,EAAO,KAAK,GAASP,GAAU,IAA2B,EAC5D,MAAU,UAAU,GAAGG,EAAK,sBAAsB,CAEtD,CAEA,SAASK,EAAkB,EAAyB,CAClD,IAAMC,EAAQb,EAAoB,KAAKc,CAAM,EAC7C,GAAI,CAACD,EAAO,MAAO,GACnB,IAAME,EAASF,EAAM,GAMf,CAACG,EAAOC,EAAU,EAAGC,EAAU,IALvBH,EAAO,SAAS,GAAG,EAC7BA,EAAO,MAAM,GAAG,EAChBA,EAAO,QAAU,EACf,CAACA,CAAM,EACP,CAACA,EAAO,MAAM,EAAG,CAAC,EAAGA,EAAO,MAAM,EAAG,CAAC,EAAGA,EAAO,MAAM,EAAG,CAAC,CAAC,EAAA,CACjB,IAAI,MAAM,EAC1D,OACEE,GAAW,IACXC,GAAW,KACVF,EAAQ,IAAOA,IAAU,IAAMC,IAAY,GAAKC,IAAY,EAEjE,CAEA,SAAgBC,EAA4B,CAC1C,SACA,cACA,WAAWvB,EAAAA,SAAS,cAGpB,CACA,GAAIkB,IAAW,IAAA,GAAW,CACxB,GAAI,OAAOA,GAAW,UAAY,CAACA,EAAO,KAAK,EAC7C,MAAU,UAAU,yBAAyB,EAE/C,GACEb,EAA8B,KAAKa,CAAM,GACzC,CAACF,EAAkBE,CAAM,EAEzB,MAAU,UAAU,uBAAuBA,EAAO,GAAG,CAEzD,CAIA,GAHIM,IAAgB,IAAA,IAClBtB,EAAA,oBAAoBsB,CAAW,EAE7B,CAAC,OAAO,OAAOxB,EAAAA,QAAQ,CAAC,CAAC,SAASyB,CAAQ,EAC5C,MAAU,UAAU,yBAAyB,OAAOA,CAAQ,EAAE,GAAG,EAEnE,MAAO,CACL,GAAIP,IAAW,IAAA,GAAY,CAAC,EAAI,CAAE,QAAO,EACzC,GAAIM,IAAgB,IAAA,GAAY,CAAC,EAAI,CAAE,aAAY,EACnD,UACF,CACF,CAEA,SAAgBE,EAAa,EAA0B,EAAoB,CACzE,GAAI,CAAC,OAAO,UAAUC,CAAI,GAAKA,EAAO,GAAKA,EAAO,WAChD,MAAU,UAAU,GAAGC,EAAS,kCAAkC,CAEtE,CAOA,SAAgBC,EACd,EACA,EACQ,CACR,GAAI,OAAOV,GAAW,UAAY,CAACb,EAAiB,KAAKa,CAAM,EAC7D,MAAU,UACR,GAAGS,EAAS,6DACd,EAEF,OAAOT,CACT,CAGA,SAAgBW,EAAiB,EAAsB,CACrD,GAAI,OAAOC,GAAS,UAAY,CAAC5B,EAAmB,KAAK4B,CAAI,EAC3D,MAAU,UAAU,+BAA+B,EAErD,OAAOA,CACT"}

package/dist/dsl/filter/validate.d.cts

@@ -0,0 +1,18 @@
+import { StringComparison, TimeUnit, FilterOperator } from './operator.cjs';
+import { FilterLiteral, RelativeTimeFilterOptions } from './types.cjs';
+export declare function filterLiteral<T extends FilterLiteral>(value: T, nullable: boolean): T;
+export declare function requiredString(name: string, value: string): string;
+export declare function validateStringComparison(comparison: StringComparison): void;
+export declare function requireNonEmpty(name: string, values: readonly unknown[]): void;
+export declare function validateRelativeTimeOptions({ zoneId, datePattern, timeUnit, }: RelativeTimeFilterOptions): RelativeTimeFilterOptions & {
+    timeUnit: TimeUnit;
+};
+export declare function validateDays(operator: FilterOperator, days: number): void;
+/**
+ * Admits the ISO-8601 duration `BEFORE_NOW` and `AFTER_NOW` add to the
+ * server's now, in the grammar `java.time.Duration.parse` accepts. A value
+ * too large for a `Duration` is left to the server.
+ */
+export declare function requireDuration(operator: FilterOperator, offset: string): string;
+/** Admits the 24-hour local time `BEFORE_TODAY` compares against. */
+export declare function requireLocalTime(time: string): string;

package/dist/dsl/filter/validate.d.ts

@@ -0,0 +1,18 @@
+import { StringComparison, TimeUnit, FilterOperator } from './operator.js';
+import { FilterLiteral, RelativeTimeFilterOptions } from './types.js';
+export declare function filterLiteral<T extends FilterLiteral>(value: T, nullable: boolean): T;
+export declare function requiredString(name: string, value: string): string;
+export declare function validateStringComparison(comparison: StringComparison): void;
+export declare function requireNonEmpty(name: string, values: readonly unknown[]): void;
+export declare function validateRelativeTimeOptions({ zoneId, datePattern, timeUnit, }: RelativeTimeFilterOptions): RelativeTimeFilterOptions & {
+    timeUnit: TimeUnit;
+};
+export declare function validateDays(operator: FilterOperator, days: number): void;
+/**
+ * Admits the ISO-8601 duration `BEFORE_NOW` and `AFTER_NOW` add to the
+ * server's now, in the grammar `java.time.Duration.parse` accepts. A value
+ * too large for a `Duration` is left to the server.
+ */
+export declare function requireDuration(operator: FilterOperator, offset: string): string;
+/** Admits the 24-hour local time `BEFORE_TODAY` compares against. */
+export declare function requireLocalTime(time: string): string;

package/dist/dsl/filter/validate.es.js

@@ -0,0 +1,56 @@
+import { StringComparison as e, TimeUnit as t } from "./operator.es.js";
+import { validateDatePattern as n } from "./datePattern.es.js";
+//#region src/dsl/filter/validate.ts
+var r = /^([01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?$/, i = /^(?:UTC|GMT|UT)?[+-](\d{1,2}|\d{4}|\d{6}|\d{2}:\d{2}|\d{2}:\d{2}:\d{2})$/, a = /^(?:UTC|GMT|UT)?[+-]/, o = /^[-+]?P(?=.*[0-9])(?:[-+]?[0-9]+D)?(?:T(?=[-+]?[0-9])(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]{0,9})?S)?)?$/i;
+function s(e, t) {
+	if (!(e === null ? t : typeof e == "string" || typeof e == "boolean" || typeof e == "number" && Number.isFinite(e))) throw TypeError("Filter value must be a JSON scalar.");
+	return e;
+}
+function c(e, t) {
+	if (typeof t != "string") throw TypeError(`${e} must be a string.`);
+	return t;
+}
+function l(t) {
+	if (t !== e.CASE_SENSITIVE && t !== e.CASE_INSENSITIVE) throw TypeError(`String comparison is invalid: [${String(t)}].`);
+}
+function u(e, t) {
+	if (t.length === 0) throw TypeError(`${e} cannot be empty.`);
+	if (t.some((e) => e == null)) throw TypeError(`${e} cannot contain null.`);
+}
+function d(e) {
+	let t = i.exec(e);
+	if (!t) return !1;
+	let n = t[1], [r, a = 0, o = 0] = (n.includes(":") ? n.split(":") : n.length <= 2 ? [n] : [
+		n.slice(0, 2),
+		n.slice(2, 4),
+		n.slice(4, 6)
+	]).map(Number);
+	return a <= 59 && o <= 59 && (r < 18 || r === 18 && a === 0 && o === 0);
+}
+function f({ zoneId: e, datePattern: r, timeUnit: i = t.MILLISECONDS }) {
+	if (e !== void 0) {
+		if (typeof e != "string" || !e.trim()) throw TypeError("zoneId cannot be blank.");
+		if (a.test(e) && !d(e)) throw TypeError(`zoneId is invalid: [${e}].`);
+	}
+	if (r !== void 0 && n(r), !Object.values(t).includes(i)) throw TypeError(`timeUnit is invalid: [${String(i)}].`);
+	return {
+		...e === void 0 ? {} : { zoneId: e },
+		...r === void 0 ? {} : { datePattern: r },
+		timeUnit: i
+	};
+}
+function p(e, t) {
+	if (!Number.isInteger(t) || t < 1 || t > 2147483647) throw TypeError(`${e} days must be a positive JVM Int.`);
+}
+function m(e, t) {
+	if (typeof t != "string" || !o.test(t)) throw TypeError(`${e} offset must be an ISO-8601 duration such as PT0S or -PT30M.`);
+	return t;
+}
+function h(e) {
+	if (typeof e != "string" || !r.test(e)) throw TypeError("BEFORE_TODAY time is invalid.");
+	return e;
+}
+//#endregion
+export { s as filterLiteral, m as requireDuration, h as requireLocalTime, u as requireNonEmpty, c as requiredString, p as validateDays, f as validateRelativeTimeOptions, l as validateStringComparison };
+
+//# sourceMappingURL=validate.es.js.map

package/dist/dsl/filter/validate.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.es.js","names":["LOCAL_TIME_PATTERN","OFFSET_ZONE_PATTERN","OFFSET_ZONE_CANDIDATE_PATTERN","DURATION_PATTERN","filterLiteral","value","nullable","requiredString","name","validateStringComparison","comparison","StringComparison","requireNonEmpty","values","isValidOffsetZone","match","zoneId","offset","hours","minutes","seconds","validateRelativeTimeOptions","TimeUnit","datePattern","validateDatePattern","timeUnit","validateDays","days","operator","requireDuration","requireLocalTime","time"],"sources":["../../../src/dsl/filter/validate.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// Internal: not re-exported by filter/index.ts. The argument checks the\n// filter builders share.\nimport { validateDatePattern } from './datePattern.js';\nimport { StringComparison, TimeUnit, type FilterOperator } from './operator.js';\nimport type { FilterLiteral, RelativeTimeFilterOptions } from './types.js';\n\nconst LOCAL_TIME_PATTERN =\n  /^([01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\\.[0-9]{1,9})?)?$/;\nconst OFFSET_ZONE_PATTERN =\n  /^(?:UTC|GMT|UT)?[+-](\\d{1,2}|\\d{4}|\\d{6}|\\d{2}:\\d{2}|\\d{2}:\\d{2}:\\d{2})$/;\nconst OFFSET_ZONE_CANDIDATE_PATTERN = /^(?:UTC|GMT|UT)?[+-]/;\n// java.time.Duration.parse: signed days, hours, minutes and seconds (up to\n// nine fraction digits after `.` or `,`), at least one of them, in that order,\n// case-insensitive. Weeks, months and years are not durations.\nconst DURATION_PATTERN =\n  /^[-+]?P(?=.*[0-9])(?:[-+]?[0-9]+D)?(?:T(?=[-+]?[0-9])(?:[-+]?[0-9]+H)?(?:[-+]?[0-9]+M)?(?:[-+]?[0-9]+(?:[.,][0-9]{0,9})?S)?)?$/i;\n\nexport function filterLiteral<T extends FilterLiteral>(\n  value: T,\n  nullable: boolean,\n): T {\n  const valid =\n    value === null\n      ? nullable\n      : typeof value === 'string' ||\n        typeof value === 'boolean' ||\n        (typeof value === 'number' && Number.isFinite(value));\n  if (!valid) {\n    throw new TypeError('Filter value must be a JSON scalar.');\n  }\n  return value;\n}\n\nexport function requiredString(name: string, value: string): string {\n  if (typeof value !== 'string') {\n    throw new TypeError(`${name} must be a string.`);\n  }\n  return value;\n}\n\nexport function validateStringComparison(comparison: StringComparison): void {\n  if (\n    comparison !== StringComparison.CASE_SENSITIVE &&\n    comparison !== StringComparison.CASE_INSENSITIVE\n  ) {\n    throw new TypeError(\n      `String comparison is invalid: [${String(comparison)}].`,\n    );\n  }\n}\n\nexport function requireNonEmpty(\n  name: string,\n  values: readonly unknown[],\n): void {\n  if (values.length === 0) {\n    throw new TypeError(`${name} cannot be empty.`);\n  }\n  if (values.some(value => value === null || value === undefined)) {\n    throw new TypeError(`${name} cannot contain null.`);\n  }\n}\n\nfunction isValidOffsetZone(zoneId: string): boolean {\n  const match = OFFSET_ZONE_PATTERN.exec(zoneId);\n  if (!match) return false;\n  const offset = match[1];\n  const parts = offset.includes(':')\n    ? offset.split(':')\n    : offset.length <= 2\n      ? [offset]\n      : [offset.slice(0, 2), offset.slice(2, 4), offset.slice(4, 6)];\n  const [hours, minutes = 0, seconds = 0] = parts.map(Number);\n  return (\n    minutes <= 59 &&\n    seconds <= 59 &&\n    (hours < 18 || (hours === 18 && minutes === 0 && seconds === 0))\n  );\n}\n\nexport function validateRelativeTimeOptions({\n  zoneId,\n  datePattern,\n  timeUnit = TimeUnit.MILLISECONDS,\n}: RelativeTimeFilterOptions): RelativeTimeFilterOptions & {\n  timeUnit: TimeUnit;\n} {\n  if (zoneId !== undefined) {\n    if (typeof zoneId !== 'string' || !zoneId.trim()) {\n      throw new TypeError('zoneId cannot be blank.');\n    }\n    if (\n      OFFSET_ZONE_CANDIDATE_PATTERN.test(zoneId) &&\n      !isValidOffsetZone(zoneId)\n    ) {\n      throw new TypeError(`zoneId is invalid: [${zoneId}].`);\n    }\n  }\n  if (datePattern !== undefined) {\n    validateDatePattern(datePattern);\n  }\n  if (!Object.values(TimeUnit).includes(timeUnit)) {\n    throw new TypeError(`timeUnit is invalid: [${String(timeUnit)}].`);\n  }\n  return {\n    ...(zoneId === undefined ? {} : { zoneId }),\n    ...(datePattern === undefined ? {} : { datePattern }),\n    timeUnit,\n  };\n}\n\nexport function validateDays(operator: FilterOperator, days: number): void {\n  if (!Number.isInteger(days) || days < 1 || days > 2_147_483_647) {\n    throw new TypeError(`${operator} days must be a positive JVM Int.`);\n  }\n}\n\n/**\n * Admits the ISO-8601 duration `BEFORE_NOW` and `AFTER_NOW` add to the\n * server's now, in the grammar `java.time.Duration.parse` accepts. A value\n * too large for a `Duration` is left to the server.\n */\nexport function requireDuration(\n  operator: FilterOperator,\n  offset: string,\n): string {\n  if (typeof offset !== 'string' || !DURATION_PATTERN.test(offset)) {\n    throw new TypeError(\n      `${operator} offset must be an ISO-8601 duration such as PT0S or -PT30M.`,\n    );\n  }\n  return offset;\n}\n\n/** Admits the 24-hour local time `BEFORE_TODAY` compares against. */\nexport function requireLocalTime(time: string): string {\n  if (typeof time !== 'string' || !LOCAL_TIME_PATTERN.test(time)) {\n    throw new TypeError('BEFORE_TODAY time is invalid.');\n  }\n  return time;\n}\n"],"mappings":";;;AAmBA,IAAMA,IACJ,oEACIC,IACJ,4EACIC,IAAgC,wBAIhCC,IACJ;AAEF,SAAgBC,EACd,GACA,GACG;CAOH,IAAI,EALFC,MAAU,OACNC,IACA,OAAOD,KAAU,YACjB,OAAOA,KAAU,aAChB,OAAOA,KAAU,YAAY,OAAO,SAASA,CAAK,IAEvD,MAAU,UAAU,qCAAqC;CAE3D,OAAOA;AACT;AAEA,SAAgBE,EAAe,GAAc,GAAuB;CAClE,IAAI,OAAOF,KAAU,UACnB,MAAU,UAAU,GAAGG,EAAK,mBAAmB;CAEjD,OAAOH;AACT;AAEA,SAAgBI,EAAyB,GAAoC;CAC3E,IACEC,MAAeC,EAAiB,kBAChCD,MAAeC,EAAiB,kBAEhC,MAAU,UACR,kCAAkC,OAAOD,CAAU,EAAE,GACvD;AAEJ;AAEA,SAAgBE,EACd,GACA,GACM;CACN,IAAIC,EAAO,WAAW,GACpB,MAAU,UAAU,GAAGL,EAAK,kBAAkB;CAEhD,IAAIK,EAAO,MAAK,MAASR,KAAU,IAA2B,GAC5D,MAAU,UAAU,GAAGG,EAAK,sBAAsB;AAEtD;AAEA,SAASM,EAAkB,GAAyB;CAClD,IAAMC,IAAQd,EAAoB,KAAKe,CAAM;CAC7C,IAAI,CAACD,GAAO,OAAO;CACnB,IAAME,IAASF,EAAM,IAMf,CAACG,GAAOC,IAAU,GAAGC,IAAU,MALvBH,EAAO,SAAS,GAAG,IAC7BA,EAAO,MAAM,GAAG,IAChBA,EAAO,UAAU,IACf,CAACA,CAAM,IACP;EAACA,EAAO,MAAM,GAAG,CAAC;EAAGA,EAAO,MAAM,GAAG,CAAC;EAAGA,EAAO,MAAM,GAAG,CAAC;CAAC,EAAA,CACjB,IAAI,MAAM;CAC1D,OACEE,KAAW,MACXC,KAAW,OACVF,IAAQ,MAAOA,MAAU,MAAMC,MAAY,KAAKC,MAAY;AAEjE;AAEA,SAAgBC,EAA4B,EAC1C,WACA,gBACA,cAAWC,EAAS,gBAGpB;CACA,IAAIN,MAAW,KAAA,GAAW;EACxB,IAAI,OAAOA,KAAW,YAAY,CAACA,EAAO,KAAK,GAC7C,MAAU,UAAU,yBAAyB;EAE/C,IACEd,EAA8B,KAAKc,CAAM,KACzC,CAACF,EAAkBE,CAAM,GAEzB,MAAU,UAAU,uBAAuBA,EAAO,GAAG;CAEzD;CAIA,IAHIO,MAAgB,KAAA,KAClBC,EAAoBD,CAAW,GAE7B,CAAC,OAAO,OAAOD,CAAQ,CAAC,CAAC,SAASG,CAAQ,GAC5C,MAAU,UAAU,yBAAyB,OAAOA,CAAQ,EAAE,GAAG;CAEnE,OAAO;EACL,GAAIT,MAAW,KAAA,IAAY,CAAC,IAAI,EAAE,UAAO;EACzC,GAAIO,MAAgB,KAAA,IAAY,CAAC,IAAI,EAAE,eAAY;EACnD;CACF;AACF;AAEA,SAAgBG,EAAa,GAA0B,GAAoB;CACzE,IAAI,CAAC,OAAO,UAAUC,CAAI,KAAKA,IAAO,KAAKA,IAAO,YAChD,MAAU,UAAU,GAAGC,EAAS,kCAAkC;AAEtE;AAOA,SAAgBC,EACd,GACA,GACQ;CACR,IAAI,OAAOZ,KAAW,YAAY,CAACd,EAAiB,KAAKc,CAAM,GAC7D,MAAU,UACR,GAAGW,EAAS,6DACd;CAEF,OAAOX;AACT;AAGA,SAAgBa,EAAiB,GAAsB;CACrD,IAAI,OAAOC,KAAS,YAAY,CAAC/B,EAAmB,KAAK+B,CAAI,GAC3D,MAAU,UAAU,+BAA+B;CAErD,OAAOA;AACT"}

package/dist/dsl/pagination.cjs

@@ -0,0 +1,2 @@
+var e=Object.freeze({index:1,size:10});function t({index:t=e.index,size:n=e.size}={}){return{index:t,size:n}}exports.DEFAULT_PAGINATION=e,exports.pagination=t;
+//# sourceMappingURL=pagination.cjs.map

package/dist/dsl/pagination.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.cjs","names":["DEFAULT_PAGINATION","pagination"],"sources":["../../src/dsl/pagination.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * Interface for pagination information.\n *\n * Page number, starting from 1\n * Page size\n */\nexport interface Pagination {\n  index: number;\n  size: number;\n}\n\n/**\n * Default pagination configuration.\n * Page index starts at 1, page size is 10. Frozen: the factories copy it.\n */\nexport const DEFAULT_PAGINATION: Readonly<Pagination> = Object.freeze({\n  index: 1,\n  size: 10,\n});\n\n/**\n * Creates a Pagination object with the provided parameters.\n *\n * This function is a factory for creating Pagination objects, which represent\n * pagination information including page index and page size. It provides default\n * values for optional properties while allowing customization of index and size.\n *\n * @param options - The pagination options. Optional.\n * @param options.index - The page index, starting from 1. Defaults to DEFAULT_PAGINATION.index.\n * @param options.size - The page size. Defaults to DEFAULT_PAGINATION.size.\n * @returns A Pagination object with the specified parameters\n */\nexport function pagination({\n  index = DEFAULT_PAGINATION.index,\n  size = DEFAULT_PAGINATION.size,\n}: Partial<Pagination> = {}): Pagination {\n  return {\n    index,\n    size,\n  };\n}\n"],"mappings":"AA4BA,IAAaA,EAA2C,OAAO,OAAO,CACpE,MAAO,EACP,KAAM,EACR,CAAC,EAcD,SAAgBC,EAAW,CACzB,QAAQD,EAAmB,MAC3B,OAAOA,EAAmB,MACH,CAAC,EAAe,CACvC,MAAO,CACL,QACA,MACF,CACF"}

package/dist/dsl/pagination.d.cts

@@ -0,0 +1,28 @@
+/**
+ * Interface for pagination information.
+ *
+ * Page number, starting from 1
+ * Page size
+ */
+export interface Pagination {
+    index: number;
+    size: number;
+}
+/**
+ * Default pagination configuration.
+ * Page index starts at 1, page size is 10. Frozen: the factories copy it.
+ */
+export declare const DEFAULT_PAGINATION: Readonly<Pagination>;
+/**
+ * Creates a Pagination object with the provided parameters.
+ *
+ * This function is a factory for creating Pagination objects, which represent
+ * pagination information including page index and page size. It provides default
+ * values for optional properties while allowing customization of index and size.
+ *
+ * @param options - The pagination options. Optional.
+ * @param options.index - The page index, starting from 1. Defaults to DEFAULT_PAGINATION.index.
+ * @param options.size - The page size. Defaults to DEFAULT_PAGINATION.size.
+ * @returns A Pagination object with the specified parameters
+ */
+export declare function pagination({ index, size, }?: Partial<Pagination>): Pagination;

package/dist/dsl/pagination.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Interface for pagination information.
+ *
+ * Page number, starting from 1
+ * Page size
+ */
+export interface Pagination {
+    index: number;
+    size: number;
+}
+/**
+ * Default pagination configuration.
+ * Page index starts at 1, page size is 10. Frozen: the factories copy it.
+ */
+export declare const DEFAULT_PAGINATION: Readonly<Pagination>;
+/**
+ * Creates a Pagination object with the provided parameters.
+ *
+ * This function is a factory for creating Pagination objects, which represent
+ * pagination information including page index and page size. It provides default
+ * values for optional properties while allowing customization of index and size.
+ *
+ * @param options - The pagination options. Optional.
+ * @param options.index - The page index, starting from 1. Defaults to DEFAULT_PAGINATION.index.
+ * @param options.size - The page size. Defaults to DEFAULT_PAGINATION.size.
+ * @returns A Pagination object with the specified parameters
+ */
+export declare function pagination({ index, size, }?: Partial<Pagination>): Pagination;

package/dist/dsl/pagination.es.js

@@ -0,0 +1,15 @@
+//#region src/dsl/pagination.ts
+var e = Object.freeze({
+	index: 1,
+	size: 10
+});
+function t({ index: t = e.index, size: n = e.size } = {}) {
+	return {
+		index: t,
+		size: n
+	};
+}
+//#endregion
+export { e as DEFAULT_PAGINATION, t as pagination };
+
+//# sourceMappingURL=pagination.es.js.map

package/dist/dsl/pagination.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.es.js","names":["DEFAULT_PAGINATION","pagination"],"sources":["../../src/dsl/pagination.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * Interface for pagination information.\n *\n * Page number, starting from 1\n * Page size\n */\nexport interface Pagination {\n  index: number;\n  size: number;\n}\n\n/**\n * Default pagination configuration.\n * Page index starts at 1, page size is 10. Frozen: the factories copy it.\n */\nexport const DEFAULT_PAGINATION: Readonly<Pagination> = Object.freeze({\n  index: 1,\n  size: 10,\n});\n\n/**\n * Creates a Pagination object with the provided parameters.\n *\n * This function is a factory for creating Pagination objects, which represent\n * pagination information including page index and page size. It provides default\n * values for optional properties while allowing customization of index and size.\n *\n * @param options - The pagination options. Optional.\n * @param options.index - The page index, starting from 1. Defaults to DEFAULT_PAGINATION.index.\n * @param options.size - The page size. Defaults to DEFAULT_PAGINATION.size.\n * @returns A Pagination object with the specified parameters\n */\nexport function pagination({\n  index = DEFAULT_PAGINATION.index,\n  size = DEFAULT_PAGINATION.size,\n}: Partial<Pagination> = {}): Pagination {\n  return {\n    index,\n    size,\n  };\n}\n"],"mappings":";AA4BA,IAAaA,IAA2C,OAAO,OAAO;CACpE,OAAO;CACP,MAAM;AACR,CAAC;AAcD,SAAgBC,EAAW,EACzB,WAAQD,EAAmB,OAC3B,UAAOA,EAAmB,SACH,CAAC,GAAe;CACvC,OAAO;EACL;EACA;CACF;AACF"}

package/dist/dsl/projection.cjs

@@ -0,0 +1,2 @@
+const e=require("./field.cjs");function t({include:t,exclude:n}={}){return{include:t?.map(e.queryField),exclude:n?.map(e.queryField)}}exports.projection=t;
+//# sourceMappingURL=projection.cjs.map

package/dist/dsl/projection.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"projection.cjs","names":["queryField","require_field","projection","include","exclude"],"sources":["../../src/dsl/projection.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { queryField } from './field.js';\n\n/**\n * Interface for field projection.\n */\nexport interface Projection<FIELDS extends string = string> {\n  include?: FIELDS[];\n  exclude?: FIELDS[];\n}\n\n/**\n * Creates a Projection object with the provided parameters.\n *\n * This function is a factory for creating Projection objects, which represent\n * field projection specifications for queries. It allows specifying which fields\n * to include or exclude in query results.\n *\n * @param options - The projection options. Defaults to none, which includes\n *   every field.\n * @param options.include - Array of field names to include in the projection. Optional.\n * @param options.exclude - Array of field names to exclude from the projection. Optional.\n * @returns A Projection object with the specified parameters\n */\nexport function projection<FIELDS extends string = string>({\n  include,\n  exclude,\n}: Projection<FIELDS> = {}): Projection<FIELDS> {\n  // Kotlin holds these as `QueryField`, which refuses a path its pattern does\n  // not match. A projection entry is a path like any other. Both keys stay\n  // present whether or not they were given: the shape this factory returns is\n  // its own contract, and validating a path is no reason to change it.\n  return {\n    include: include?.map(queryField),\n    exclude: exclude?.map(queryField),\n  };\n}\n\n/**\n * Interface for objects that support field projection.\n */\nexport interface ProjectionCapable<FIELDS extends string = string> {\n  projection?: Projection<FIELDS>;\n}\n"],"mappings":"+BAoCA,SAAgBE,EAA2C,CACzD,UACA,WACsB,CAAC,EAAuB,CAK9C,MAAO,CACL,QAASC,GAAS,IAAIH,EAAAA,UAAU,EAChC,QAASI,GAAS,IAAIJ,EAAAA,UAAU,CAClC,CACF"}

package/dist/dsl/projection.d.cts

@@ -0,0 +1,27 @@
+/**
+ * Interface for field projection.
+ */
+export interface Projection<FIELDS extends string = string> {
+    include?: FIELDS[];
+    exclude?: FIELDS[];
+}
+/**
+ * Creates a Projection object with the provided parameters.
+ *
+ * This function is a factory for creating Projection objects, which represent
+ * field projection specifications for queries. It allows specifying which fields
+ * to include or exclude in query results.
+ *
+ * @param options - The projection options. Defaults to none, which includes
+ *   every field.
+ * @param options.include - Array of field names to include in the projection. Optional.
+ * @param options.exclude - Array of field names to exclude from the projection. Optional.
+ * @returns A Projection object with the specified parameters
+ */
+export declare function projection<FIELDS extends string = string>({ include, exclude, }?: Projection<FIELDS>): Projection<FIELDS>;
+/**
+ * Interface for objects that support field projection.
+ */
+export interface ProjectionCapable<FIELDS extends string = string> {
+    projection?: Projection<FIELDS>;
+}

package/dist/dsl/projection.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Interface for field projection.
+ */
+export interface Projection<FIELDS extends string = string> {
+    include?: FIELDS[];
+    exclude?: FIELDS[];
+}
+/**
+ * Creates a Projection object with the provided parameters.
+ *
+ * This function is a factory for creating Projection objects, which represent
+ * field projection specifications for queries. It allows specifying which fields
+ * to include or exclude in query results.
+ *
+ * @param options - The projection options. Defaults to none, which includes
+ *   every field.
+ * @param options.include - Array of field names to include in the projection. Optional.
+ * @param options.exclude - Array of field names to exclude from the projection. Optional.
+ * @returns A Projection object with the specified parameters
+ */
+export declare function projection<FIELDS extends string = string>({ include, exclude, }?: Projection<FIELDS>): Projection<FIELDS>;
+/**
+ * Interface for objects that support field projection.
+ */
+export interface ProjectionCapable<FIELDS extends string = string> {
+    projection?: Projection<FIELDS>;
+}

package/dist/dsl/projection.es.js

@@ -0,0 +1,12 @@
+import { queryField as e } from "./field.es.js";
+//#region src/dsl/projection.ts
+function t({ include: t, exclude: n } = {}) {
+	return {
+		include: t?.map(e),
+		exclude: n?.map(e)
+	};
+}
+//#endregion
+export { t as projection };
+
+//# sourceMappingURL=projection.es.js.map

package/dist/dsl/projection.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projection.es.js","names":["projection","include","queryField","exclude"],"sources":["../../src/dsl/projection.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { queryField } from './field.js';\n\n/**\n * Interface for field projection.\n */\nexport interface Projection<FIELDS extends string = string> {\n  include?: FIELDS[];\n  exclude?: FIELDS[];\n}\n\n/**\n * Creates a Projection object with the provided parameters.\n *\n * This function is a factory for creating Projection objects, which represent\n * field projection specifications for queries. It allows specifying which fields\n * to include or exclude in query results.\n *\n * @param options - The projection options. Defaults to none, which includes\n *   every field.\n * @param options.include - Array of field names to include in the projection. Optional.\n * @param options.exclude - Array of field names to exclude from the projection. Optional.\n * @returns A Projection object with the specified parameters\n */\nexport function projection<FIELDS extends string = string>({\n  include,\n  exclude,\n}: Projection<FIELDS> = {}): Projection<FIELDS> {\n  // Kotlin holds these as `QueryField`, which refuses a path its pattern does\n  // not match. A projection entry is a path like any other. Both keys stay\n  // present whether or not they were given: the shape this factory returns is\n  // its own contract, and validating a path is no reason to change it.\n  return {\n    include: include?.map(queryField),\n    exclude: exclude?.map(queryField),\n  };\n}\n\n/**\n * Interface for objects that support field projection.\n */\nexport interface ProjectionCapable<FIELDS extends string = string> {\n  projection?: Projection<FIELDS>;\n}\n"],"mappings":";;AAoCA,SAAgBA,EAA2C,EACzD,YACA,eACsB,CAAC,GAAuB;CAK9C,OAAO;EACL,SAASC,GAAS,IAAIC,CAAU;EAChC,SAASC,GAAS,IAAID,CAAU;CAClC;AACF"}

package/dist/dsl/queryable.cjs

@@ -0,0 +1,2 @@
+const e=require("./filter/builders.cjs"),t=require("./pagination.cjs");function n(t){if(t===null)throw TypeError(`filter cannot be null.`);return t??e.filter.matchAll()}function r({filter:e,projection:t,sort:r}={}){return{filter:n(e),projection:t,sort:r}}function i({filter:e,projection:t,sort:r,limit:i}={}){return{filter:n(e),projection:t,sort:r,limit:i}}function a({filter:e,projection:r,sort:i,pagination:a={...t.DEFAULT_PAGINATION}}={}){return{filter:n(e),projection:r,sort:i,pagination:a}}function o({total:e,list:t=[]}={}){return{total:e??t.length,list:t}}exports.listQuery=i,exports.pagedList=o,exports.pagedQuery=a,exports.singleQuery=r;
+//# sourceMappingURL=queryable.cjs.map

package/dist/dsl/queryable.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryable.cjs","names":["filter","filters","DEFAULT_PAGINATION","require_builders","require_pagination","queryFilter","filter$1","singleQuery","filter","listQuery","pagedQuery","pagedList","total","list"],"sources":["../../src/dsl/queryable.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  filter as filters,\n  type FilterCapable,\n  type FilterExpression,\n} from './filter/index.js';\nimport { type SortCapable } from './sort.js';\nimport { DEFAULT_PAGINATION, type Pagination } from './pagination.js';\nimport { type ProjectionCapable } from './projection.js';\n\n/** A query that filters, projects and sorts with Wow's `FilterExpression`. */\nexport interface FilterQueryable<FIELDS extends string = string>\n  extends\n    FilterCapable<FIELDS>,\n    ProjectionCapable<FIELDS>,\n    SortCapable<FIELDS> {}\n\n/** The body of a `single` query: the first match of the filter, or nothing. */\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport interface FilterSingleQuery<\n  FIELDS extends string = string,\n> extends FilterQueryable<FIELDS> {}\n\n/** The body of a `list` or `listStream` query. */\nexport interface FilterListQuery<\n  FIELDS extends string = string,\n> extends FilterQueryable<FIELDS> {\n  /**\n   * The most rows to return. The client sends no default: absent (or 0)\n   * leaves the choice to the server, and what the server does depends on its\n   * version.\n   *\n   * - Wow 9.1.5 and later apply the server's default list size over HTTP\n   *   (100 unless the server configures another).\n   * - Wow 8.11 to 9.1.3 reject the query with `IllegalArgument: HTTP list\n   *   query limit[0] must be between 1 and …` (HTTP 400 for a list, the error\n   *   event that ends a list stream), so pass `limit` explicitly against\n   *   those servers.\n   *\n   * Wow 8.11 and later also refuse a value above the server's maximum list\n   * size (1000 by default).\n   */\n  limit?: number;\n}\n\n/** The body of a `paged` query. */\nexport interface FilterPagedQuery<\n  FIELDS extends string = string,\n> extends FilterQueryable<FIELDS> {\n  pagination?: Pagination;\n}\n\n/** What `singleQuery`, `listQuery` and `pagedQuery` take in common. */\ntype QueryOptions<FIELDS extends string = string> = Partial<\n  FilterQueryable<FIELDS>\n>;\n\nfunction queryFilter<FIELDS extends string>(\n  filter: FilterExpression<FIELDS> | undefined,\n): FilterExpression<FIELDS> {\n  if (filter === null) {\n    throw new TypeError('filter cannot be null.');\n  }\n  return filter ?? filters.matchAll();\n}\n\n/**\n * Builds the body of a `single` query.\n *\n * @param options.filter - What to match. Defaults to `filter.matchAll()`.\n * @param options.projection - Which fields to return. Optional.\n * @param options.sort - Which match counts as the first. Optional.\n * @throws TypeError when `filter` is `null`.\n *\n * @example\n * ```typescript\n * singleQuery({ filter: filter.eq('status', 'ACTIVE') });\n * ```\n */\nexport function singleQuery<FIELDS extends string = string>({\n  filter,\n  projection,\n  sort,\n}: QueryOptions<FIELDS> = {}): FilterSingleQuery<FIELDS> {\n  return { filter: queryFilter(filter), projection, sort };\n}\n\n/**\n * Builds the body of a `list` or `listStream` query.\n *\n * @param options.filter - What to match. Defaults to `filter.matchAll()`.\n * @param options.projection - Which fields to return. Optional.\n * @param options.sort - The order of the rows. Optional.\n * @param options.limit - The most rows to return. Absent is sent as absent:\n *   Wow 9.1.5 and later apply the server's default list size, Wow 8.11 to\n *   9.1.3 reject the query, so pass it for those servers; see\n *   {@link FilterListQuery.limit}.\n * @throws TypeError when `filter` is `null`.\n *\n * @example\n * ```typescript\n * listQuery({ filter: filter.eq('status', 'ACTIVE'), limit: 20 });\n * ```\n */\nexport function listQuery<FIELDS extends string = string>({\n  filter,\n  projection,\n  sort,\n  limit,\n}: QueryOptions<FIELDS> & { limit?: number } = {}): FilterListQuery<FIELDS> {\n  return { filter: queryFilter(filter), projection, sort, limit };\n}\n\n/**\n * Builds the body of a `paged` query.\n *\n * @param options.filter - What to match. Defaults to `filter.matchAll()`.\n * @param options.projection - Which fields to return. Optional.\n * @param options.sort - The order of the rows. Optional.\n * @param options.pagination - Which page. Defaults to a copy of\n *   {@link DEFAULT_PAGINATION}: the first page of ten.\n * @throws TypeError when `filter` is `null`.\n *\n * @example\n * ```typescript\n * pagedQuery({ filter: filter.matchAll(), pagination: { index: 2, size: 20 } });\n * ```\n */\nexport function pagedQuery<FIELDS extends string = string>({\n  filter,\n  projection,\n  sort,\n  pagination = { ...DEFAULT_PAGINATION },\n}: QueryOptions<FIELDS> & {\n  pagination?: Pagination;\n} = {}): FilterPagedQuery<FIELDS> {\n  return { filter: queryFilter(filter), projection, sort, pagination };\n}\n\n/** One page of a `paged` query: its rows, and how many match in total. */\nexport interface PagedList<T> {\n  total: number;\n  list: T[];\n}\n\n/**\n * Builds a `PagedList`, for a placeholder page or a test double.\n *\n * @param options.total - How many rows match in total. Defaults to the length\n *   of `list`.\n * @param options.list - The rows of this page. Defaults to a new empty array.\n */\nexport function pagedList<T>({\n  total,\n  list = [],\n}: Partial<PagedList<T>> = {}): PagedList<T> {\n  return { total: total ?? list.length, list };\n}\n"],"mappings":"uEAqEA,SAASK,EACP,EAC0B,CAC1B,GAAIL,IAAW,KACb,MAAU,UAAU,wBAAwB,EAE9C,OAAOA,GAAUC,EAAAA,OAAQ,SAAS,CACpC,CAeA,SAAgBM,EAA4C,CAC1D,SACA,aACA,QACwB,CAAC,EAA8B,CACvD,MAAO,CAAE,OAAQF,EAAYG,CAAM,EAAG,aAAY,MAAK,CACzD,CAmBA,SAAgBC,EAA0C,CACxD,SACA,aACA,OACA,SAC6C,CAAC,EAA4B,CAC1E,MAAO,CAAE,OAAQJ,EAAYG,CAAM,EAAG,aAAY,OAAM,OAAM,CAChE,CAiBA,SAAgBE,EAA2C,CACzD,SACA,aACA,OACA,aAAa,CAAE,GAAGR,EAAAA,kBAAmB,GAGnC,CAAC,EAA6B,CAChC,MAAO,CAAE,OAAQG,EAAYG,CAAM,EAAG,aAAY,OAAM,YAAW,CACrE,CAeA,SAAgBG,EAAa,CAC3B,QACA,OAAO,CAAC,GACiB,CAAC,EAAiB,CAC3C,MAAO,CAAE,MAAOC,GAASC,EAAK,OAAQ,MAAK,CAC7C"}