@ahoo-wang/wow-client 10.0.0-beta.1 → 10.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/README.zh-CN.md +1 -1
- package/dist/commands.cjs +1 -1
- package/dist/commands.cjs.map +1 -1
- package/dist/commands.d.cts +1 -8
- package/dist/commands.d.ts +1 -8
- package/dist/commands.es.js +45 -51
- package/dist/commands.es.js.map +1 -1
- package/dist/dsl/aggregation/admit.cjs +1 -1
- package/dist/dsl/aggregation/admit.cjs.map +1 -1
- package/dist/dsl/aggregation/admit.es.js +73 -69
- package/dist/dsl/aggregation/admit.es.js.map +1 -1
- package/dist/dsl/aggregation/aliases.cjs +2 -0
- package/dist/dsl/aggregation/aliases.cjs.map +1 -0
- package/dist/dsl/aggregation/aliases.d.cts +2 -0
- package/dist/dsl/aggregation/aliases.d.ts +2 -0
- package/dist/dsl/aggregation/aliases.es.js +13 -0
- package/dist/dsl/aggregation/aliases.es.js.map +1 -0
- package/dist/dsl/aggregation/builders.cjs +1 -1
- package/dist/dsl/aggregation/builders.cjs.map +1 -1
- package/dist/dsl/aggregation/builders.d.cts +17 -243
- package/dist/dsl/aggregation/builders.d.ts +17 -243
- package/dist/dsl/aggregation/builders.es.js +36 -171
- package/dist/dsl/aggregation/builders.es.js.map +1 -1
- package/dist/dsl/aggregation/derived.cjs +1 -1
- package/dist/dsl/aggregation/derived.cjs.map +1 -1
- package/dist/dsl/aggregation/derived.d.cts +123 -1
- package/dist/dsl/aggregation/derived.d.ts +123 -1
- package/dist/dsl/aggregation/derived.es.js +43 -28
- package/dist/dsl/aggregation/derived.es.js.map +1 -1
- package/dist/dsl/aggregation/groups.cjs +2 -0
- package/dist/dsl/aggregation/groups.cjs.map +1 -0
- package/dist/dsl/aggregation/groups.d.cts +325 -0
- package/dist/dsl/aggregation/groups.d.ts +325 -0
- package/dist/dsl/aggregation/groups.es.js +80 -0
- package/dist/dsl/aggregation/groups.es.js.map +1 -0
- package/dist/dsl/aggregation/having.cjs +1 -1
- package/dist/dsl/aggregation/having.cjs.map +1 -1
- package/dist/dsl/aggregation/having.d.cts +63 -1
- package/dist/dsl/aggregation/having.d.ts +63 -1
- package/dist/dsl/aggregation/having.es.js +33 -30
- package/dist/dsl/aggregation/having.es.js.map +1 -1
- package/dist/dsl/aggregation/index.d.cts +4 -2
- package/dist/dsl/aggregation/index.d.ts +4 -2
- package/dist/dsl/aggregation/metrics.cjs +2 -0
- package/dist/dsl/aggregation/metrics.cjs.map +1 -0
- package/dist/dsl/aggregation/metrics.d.cts +279 -0
- package/dist/dsl/aggregation/metrics.d.ts +279 -0
- package/dist/dsl/aggregation/metrics.es.js +75 -0
- package/dist/dsl/aggregation/metrics.es.js.map +1 -0
- package/dist/dsl/aggregation/types.cjs +1 -1
- package/dist/dsl/aggregation/types.cjs.map +1 -1
- package/dist/dsl/aggregation/types.d.cts +4 -524
- package/dist/dsl/aggregation/types.d.ts +4 -524
- package/dist/dsl/aggregation/types.es.js +5 -25
- package/dist/dsl/aggregation/types.es.js.map +1 -1
- package/dist/dsl/cursorQuery.cjs +1 -1
- package/dist/dsl/cursorQuery.cjs.map +1 -1
- package/dist/dsl/cursorQuery.d.cts +18 -7
- package/dist/dsl/cursorQuery.d.ts +18 -7
- package/dist/dsl/cursorQuery.es.js +13 -12
- package/dist/dsl/cursorQuery.es.js.map +1 -1
- package/dist/dsl/descriptor.cjs +1 -1
- package/dist/dsl/descriptor.cjs.map +1 -1
- package/dist/dsl/descriptor.d.cts +17 -379
- package/dist/dsl/descriptor.d.ts +17 -379
- package/dist/dsl/descriptor.es.js +4 -31
- package/dist/dsl/descriptor.es.js.map +1 -1
- package/dist/dsl/fieldDescriptor.cjs +2 -0
- package/dist/dsl/fieldDescriptor.cjs.map +1 -0
- package/dist/dsl/fieldDescriptor.d.cts +246 -0
- package/dist/dsl/fieldDescriptor.d.ts +246 -0
- package/dist/dsl/fieldDescriptor.es.js +24 -0
- package/dist/dsl/fieldDescriptor.es.js.map +1 -0
- package/dist/dsl/filter/builders.cjs +1 -1
- package/dist/dsl/filter/builders.cjs.map +1 -1
- package/dist/dsl/filter/builders.d.cts +7 -949
- package/dist/dsl/filter/builders.d.ts +7 -949
- package/dist/dsl/filter/builders.es.js +14 -285
- package/dist/dsl/filter/builders.es.js.map +1 -1
- package/dist/dsl/filter/expressionFilter.cjs +2 -0
- package/dist/dsl/filter/expressionFilter.cjs.map +1 -0
- package/dist/dsl/filter/expressionFilter.d.cts +35 -0
- package/dist/dsl/filter/expressionFilter.d.ts +35 -0
- package/dist/dsl/filter/expressionFilter.es.js +18 -0
- package/dist/dsl/filter/expressionFilter.es.js.map +1 -0
- package/dist/dsl/filter/fieldFilters.cjs +2 -0
- package/dist/dsl/filter/fieldFilters.cjs.map +1 -0
- package/dist/dsl/filter/fieldFilters.d.cts +297 -0
- package/dist/dsl/filter/fieldFilters.d.ts +297 -0
- package/dist/dsl/filter/fieldFilters.es.js +110 -0
- package/dist/dsl/filter/fieldFilters.es.js.map +1 -0
- package/dist/dsl/filter/index.d.cts +2 -1
- package/dist/dsl/filter/index.d.ts +2 -1
- package/dist/dsl/filter/logicalFilters.cjs +2 -0
- package/dist/dsl/filter/logicalFilters.cjs.map +1 -0
- package/dist/dsl/filter/logicalFilters.d.cts +109 -0
- package/dist/dsl/filter/logicalFilters.d.ts +109 -0
- package/dist/dsl/filter/logicalFilters.es.js +36 -0
- package/dist/dsl/filter/logicalFilters.es.js.map +1 -0
- package/dist/dsl/filter/metadataFilters.cjs +2 -0
- package/dist/dsl/filter/metadataFilters.cjs.map +1 -0
- package/dist/dsl/filter/metadataFilters.d.cts +132 -0
- package/dist/dsl/filter/metadataFilters.d.ts +132 -0
- package/dist/dsl/filter/metadataFilters.es.js +56 -0
- package/dist/dsl/filter/metadataFilters.es.js.map +1 -0
- package/dist/dsl/filter/operator.cjs +1 -1
- package/dist/dsl/filter/operator.cjs.map +1 -1
- package/dist/dsl/filter/operator.d.cts +11 -9
- package/dist/dsl/filter/operator.d.ts +11 -9
- package/dist/dsl/filter/operator.es.js +1 -1
- package/dist/dsl/filter/operator.es.js.map +1 -1
- package/dist/dsl/filter/searchFilter.cjs +2 -0
- package/dist/dsl/filter/searchFilter.cjs.map +1 -0
- package/dist/dsl/filter/searchFilter.d.cts +39 -0
- package/dist/dsl/filter/searchFilter.d.ts +39 -0
- package/dist/dsl/filter/searchFilter.es.js +19 -0
- package/dist/dsl/filter/searchFilter.es.js.map +1 -0
- package/dist/dsl/filter/timeFilters.cjs +2 -0
- package/dist/dsl/filter/timeFilters.cjs.map +1 -0
- package/dist/dsl/filter/timeFilters.d.cts +290 -0
- package/dist/dsl/filter/timeFilters.d.ts +290 -0
- package/dist/dsl/filter/timeFilters.es.js +89 -0
- package/dist/dsl/filter/timeFilters.es.js.map +1 -0
- package/dist/dsl/filter/types.d.cts +4 -14
- package/dist/dsl/filter/types.d.ts +4 -14
- package/dist/dsl/filter/validate.cjs +1 -1
- package/dist/dsl/filter/validate.cjs.map +1 -1
- package/dist/dsl/filter/validate.d.cts +2 -4
- package/dist/dsl/filter/validate.d.ts +2 -4
- package/dist/dsl/filter/validate.es.js +25 -31
- package/dist/dsl/filter/validate.es.js.map +1 -1
- package/dist/dsl/queryErrorCodes.cjs +1 -1
- package/dist/dsl/queryErrorCodes.cjs.map +1 -1
- package/dist/dsl/queryErrorCodes.d.cts +0 -2
- package/dist/dsl/queryErrorCodes.d.ts +0 -2
- package/dist/dsl/queryErrorCodes.es.js +0 -1
- package/dist/dsl/queryErrorCodes.es.js.map +1 -1
- package/dist/dsl/queryFilter.cjs +2 -0
- package/dist/dsl/queryFilter.cjs.map +1 -0
- package/dist/dsl/queryFilter.d.cts +3 -0
- package/dist/dsl/queryFilter.d.ts +3 -0
- package/dist/dsl/queryFilter.es.js +9 -0
- package/dist/dsl/queryFilter.es.js.map +1 -0
- package/dist/dsl/queryable.cjs +1 -1
- package/dist/dsl/queryable.cjs.map +1 -1
- package/dist/dsl/queryable.es.js +12 -16
- package/dist/dsl/queryable.es.js.map +1 -1
- package/dist/dsl/semanticTypes.cjs +2 -0
- package/dist/dsl/semanticTypes.cjs.map +1 -0
- package/dist/dsl/semanticTypes.d.cts +128 -0
- package/dist/dsl/semanticTypes.d.ts +128 -0
- package/dist/dsl/semanticTypes.es.js +13 -0
- package/dist/dsl/semanticTypes.es.js.map +1 -0
- package/dist/dsl.cjs +1 -1
- package/dist/dsl.d.cts +2 -0
- package/dist/dsl.d.ts +2 -0
- package/dist/dsl.es.js +14 -8
- package/dist/exactJson.cjs +2 -2
- package/dist/exactJson.cjs.map +1 -1
- package/dist/exactJson.d.cts +41 -16
- package/dist/exactJson.d.ts +41 -16
- package/dist/exactJson.es.js +104 -102
- package/dist/exactJson.es.js.map +1 -1
- package/dist/frameworkErrors.cjs.map +1 -1
- package/dist/frameworkErrors.d.cts +4 -4
- package/dist/frameworkErrors.d.ts +4 -4
- package/dist/frameworkErrors.es.js.map +1 -1
- package/dist/http.cjs +1 -1
- package/dist/http.cjs.map +1 -1
- package/dist/http.d.cts +29 -9
- package/dist/http.d.ts +29 -9
- package/dist/http.es.js +24 -19
- package/dist/http.es.js.map +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.es.js +12 -12
- package/dist/manifest.cjs +1 -1
- package/dist/manifest.cjs.map +1 -1
- package/dist/manifest.d.cts +24 -0
- package/dist/manifest.d.ts +24 -0
- package/dist/manifest.es.js +34 -6
- package/dist/manifest.es.js.map +1 -1
- package/dist/manifestTypes.d.cts +16 -1
- package/dist/manifestTypes.d.ts +16 -1
- package/dist/queries.cjs +1 -1
- package/dist/queries.cjs.map +1 -1
- package/dist/queries.d.cts +18 -8
- package/dist/queries.d.ts +18 -8
- package/dist/queries.es.js +46 -35
- package/dist/queries.es.js.map +1 -1
- package/dist/routes.cjs +1 -1
- package/dist/routes.cjs.map +1 -1
- package/dist/routes.d.cts +16 -3
- package/dist/routes.d.ts +16 -3
- package/dist/routes.es.js +24 -25
- package/dist/routes.es.js.map +1 -1
- package/dist/state.cjs +1 -1
- package/dist/state.cjs.map +1 -1
- package/dist/state.d.cts +21 -19
- package/dist/state.d.ts +21 -19
- package/dist/state.es.js +27 -22
- package/dist/state.es.js.map +1 -1
- package/dist/streams.cjs +1 -1
- package/dist/streams.cjs.map +1 -1
- package/dist/streams.d.cts +14 -7
- package/dist/streams.d.ts +14 -7
- package/dist/streams.es.js +65 -50
- package/dist/streams.es.js.map +1 -1
- package/dist/testing/wire.cjs +1 -1
- package/dist/testing/wire.cjs.map +1 -1
- package/dist/testing/wire.es.js +1 -1
- package/dist/testing/wire.es.js.map +1 -1
- package/dist/wait.cjs +1 -1
- package/dist/wait.cjs.map +1 -1
- package/dist/wait.d.cts +17 -4
- package/dist/wait.d.ts +17 -4
- package/dist/wait.es.js +36 -34
- package/dist/wait.es.js.map +1 -1
- package/dist/wire.cjs +1 -1
- package/dist/wire.cjs.map +1 -1
- package/dist/wire.d.cts +75 -31
- package/dist/wire.d.ts +75 -31
- package/dist/wire.es.js +1 -3
- package/dist/wire.es.js.map +1 -1
- package/package.json +5 -5
- package/dist/dsl/filter/datePattern.cjs +0 -2
- package/dist/dsl/filter/datePattern.cjs.map +0 -1
- package/dist/dsl/filter/datePattern.d.cts +0 -8
- package/dist/dsl/filter/datePattern.d.ts +0 -8
- package/dist/dsl/filter/datePattern.es.js +0 -96
- package/dist/dsl/filter/datePattern.es.js.map +0 -1
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
import { BeforeTodayFilter, CalendarFilter, DaysFilter, NowFilter, RelativeTimeFilterOptions } from './types.cjs';
|
|
2
|
+
/** The filters on a time field: calendar periods, days relative to today, and instants relative to the server's now. */
|
|
3
|
+
export declare const timeFilters: {
|
|
4
|
+
/**
|
|
5
|
+
* Matches times within today, as the half-open range `[start, end)` in the
|
|
6
|
+
* configured time zone.
|
|
7
|
+
*
|
|
8
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
9
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
10
|
+
* @returns `{ op: 'today', field }`, plus `timeZone` when set.
|
|
11
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
12
|
+
* blank or an invalid UTC offset.
|
|
13
|
+
* @example
|
|
14
|
+
* ```typescript
|
|
15
|
+
* filter.today('state.createTime', { timeZone: 'Asia/Shanghai' });
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
today<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
19
|
+
/**
|
|
20
|
+
* Matches times earlier than today at the local time `time`
|
|
21
|
+
* (`field < today at time`) in the configured time zone.
|
|
22
|
+
*
|
|
23
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
24
|
+
* @param time - 24-hour local time: `HH:mm`, `HH:mm:ss` or `HH:mm:ss.S` with
|
|
25
|
+
* 1 to 9 fraction digits.
|
|
26
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
27
|
+
* @returns `{ op: 'before-today', field, time }`, plus `timeZone` when set.
|
|
28
|
+
* @throws TypeError If `time` is not a string in one of the formats above,
|
|
29
|
+
* `field` is not a valid query field path, or `timeZone` is blank or an
|
|
30
|
+
* invalid UTC offset.
|
|
31
|
+
* @example
|
|
32
|
+
* ```typescript
|
|
33
|
+
* filter.beforeToday('state.createTime', '12:00');
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
beforeToday<FIELDS extends string>(field: FIELDS, time: string, options?: RelativeTimeFilterOptions): BeforeTodayFilter<FIELDS>;
|
|
37
|
+
/**
|
|
38
|
+
* Matches times within tomorrow, as the half-open range `[start, end)` in the
|
|
39
|
+
* configured time zone.
|
|
40
|
+
*
|
|
41
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
42
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
43
|
+
* @returns `{ op: 'tomorrow', field }`, plus `timeZone` when set.
|
|
44
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
45
|
+
* blank or an invalid UTC offset.
|
|
46
|
+
* @example
|
|
47
|
+
* ```typescript
|
|
48
|
+
* filter.tomorrow('state.createTime');
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
tomorrow<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
52
|
+
/**
|
|
53
|
+
* Matches times within the current Monday-start week, as the half-open range `[start, end)` in the
|
|
54
|
+
* configured time zone.
|
|
55
|
+
*
|
|
56
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
57
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
58
|
+
* @returns `{ op: 'this-week', field }`, plus `timeZone` when set.
|
|
59
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
60
|
+
* blank or an invalid UTC offset.
|
|
61
|
+
* @example
|
|
62
|
+
* ```typescript
|
|
63
|
+
* filter.thisWeek('state.createTime');
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
thisWeek<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
67
|
+
/**
|
|
68
|
+
* Matches times within the next Monday-start week, as the half-open range `[start, end)` in the
|
|
69
|
+
* configured time zone.
|
|
70
|
+
*
|
|
71
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
72
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
73
|
+
* @returns `{ op: 'next-week', field }`, plus `timeZone` when set.
|
|
74
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
75
|
+
* blank or an invalid UTC offset.
|
|
76
|
+
* @example
|
|
77
|
+
* ```typescript
|
|
78
|
+
* filter.nextWeek('state.createTime');
|
|
79
|
+
* ```
|
|
80
|
+
*/
|
|
81
|
+
nextWeek<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
82
|
+
/**
|
|
83
|
+
* Matches times within the previous Monday-start week, as the half-open range `[start, end)` in the
|
|
84
|
+
* configured time zone.
|
|
85
|
+
*
|
|
86
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
87
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
88
|
+
* @returns `{ op: 'last-week', field }`, plus `timeZone` when set.
|
|
89
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
90
|
+
* blank or an invalid UTC offset.
|
|
91
|
+
* @example
|
|
92
|
+
* ```typescript
|
|
93
|
+
* filter.lastWeek('state.createTime');
|
|
94
|
+
* ```
|
|
95
|
+
*/
|
|
96
|
+
lastWeek<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
97
|
+
/**
|
|
98
|
+
* Matches times within the current calendar month, as the half-open range `[start, end)` in the
|
|
99
|
+
* configured time zone.
|
|
100
|
+
*
|
|
101
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
102
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
103
|
+
* @returns `{ op: 'this-month', field }`, plus `timeZone` when set.
|
|
104
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
105
|
+
* blank or an invalid UTC offset.
|
|
106
|
+
* @example
|
|
107
|
+
* ```typescript
|
|
108
|
+
* filter.thisMonth('state.createTime');
|
|
109
|
+
* ```
|
|
110
|
+
*/
|
|
111
|
+
thisMonth<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
112
|
+
/**
|
|
113
|
+
* Matches times within the previous calendar month, as the half-open range `[start, end)` in the
|
|
114
|
+
* configured time zone.
|
|
115
|
+
*
|
|
116
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
117
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
118
|
+
* @returns `{ op: 'last-month', field }`, plus `timeZone` when set.
|
|
119
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
120
|
+
* blank or an invalid UTC offset.
|
|
121
|
+
* @example
|
|
122
|
+
* ```typescript
|
|
123
|
+
* filter.lastMonth('state.createTime');
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
lastMonth<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
127
|
+
/**
|
|
128
|
+
* Matches times within yesterday, as the half-open range `[start, end)` in the
|
|
129
|
+
* configured time zone.
|
|
130
|
+
*
|
|
131
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
132
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
133
|
+
* @returns `{ op: 'yesterday', field }`, plus `timeZone` when set.
|
|
134
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
135
|
+
* blank or an invalid UTC offset.
|
|
136
|
+
* @example
|
|
137
|
+
* ```typescript
|
|
138
|
+
* filter.yesterday('state.createTime');
|
|
139
|
+
* ```
|
|
140
|
+
*/
|
|
141
|
+
yesterday<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
142
|
+
/**
|
|
143
|
+
* Matches times within the next calendar month, as the half-open range `[start, end)` in the
|
|
144
|
+
* configured time zone.
|
|
145
|
+
*
|
|
146
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
147
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
148
|
+
* @returns `{ op: 'next-month', field }`, plus `timeZone` when set.
|
|
149
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
150
|
+
* blank or an invalid UTC offset.
|
|
151
|
+
* @example
|
|
152
|
+
* ```typescript
|
|
153
|
+
* filter.nextMonth('state.createTime');
|
|
154
|
+
* ```
|
|
155
|
+
*/
|
|
156
|
+
nextMonth<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
157
|
+
/**
|
|
158
|
+
* Matches times within the previous calendar year, as the half-open range `[start, end)` in the
|
|
159
|
+
* configured time zone.
|
|
160
|
+
*
|
|
161
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
162
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
163
|
+
* @returns `{ op: 'last-year', field }`, plus `timeZone` when set.
|
|
164
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
165
|
+
* blank or an invalid UTC offset.
|
|
166
|
+
* @example
|
|
167
|
+
* ```typescript
|
|
168
|
+
* filter.lastYear('state.createTime');
|
|
169
|
+
* ```
|
|
170
|
+
*/
|
|
171
|
+
lastYear<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
172
|
+
/**
|
|
173
|
+
* Matches times within the current calendar year, as the half-open range `[start, end)` in the
|
|
174
|
+
* configured time zone.
|
|
175
|
+
*
|
|
176
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
177
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
178
|
+
* @returns `{ op: 'this-year', field }`, plus `timeZone` when set.
|
|
179
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
180
|
+
* blank or an invalid UTC offset.
|
|
181
|
+
* @example
|
|
182
|
+
* ```typescript
|
|
183
|
+
* filter.thisYear('state.createTime', { timeZone: 'Asia/Shanghai' });
|
|
184
|
+
* ```
|
|
185
|
+
*/
|
|
186
|
+
thisYear<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
187
|
+
/**
|
|
188
|
+
* Matches times within the next calendar year, as the half-open range `[start, end)` in the
|
|
189
|
+
* configured time zone.
|
|
190
|
+
*
|
|
191
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
192
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
193
|
+
* @returns `{ op: 'next-year', field }`, plus `timeZone` when set.
|
|
194
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
195
|
+
* blank or an invalid UTC offset.
|
|
196
|
+
* @example
|
|
197
|
+
* ```typescript
|
|
198
|
+
* filter.nextYear('state.createTime');
|
|
199
|
+
* ```
|
|
200
|
+
*/
|
|
201
|
+
nextYear<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
202
|
+
/**
|
|
203
|
+
* Matches times from the start of the day `days - 1` days ago until the end
|
|
204
|
+
* of today. `recentDays(field, 7)` covers today and the six previous days.
|
|
205
|
+
*
|
|
206
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
207
|
+
* @param days - Number of calendar days, including today; an integer from
|
|
208
|
+
* 1 to 2147483647.
|
|
209
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
210
|
+
* @returns `{ op: 'recent-days', field, days }`, plus `timeZone` when set.
|
|
211
|
+
* @throws TypeError If `days` is not an integer from 1 to 2147483647,
|
|
212
|
+
* `field` is not a valid query field path, or `timeZone` is blank or an
|
|
213
|
+
* invalid UTC offset.
|
|
214
|
+
* @example
|
|
215
|
+
* ```typescript
|
|
216
|
+
* filter.recentDays('state.createTime', 7);
|
|
217
|
+
* ```
|
|
218
|
+
*/
|
|
219
|
+
recentDays<FIELDS extends string>(field: FIELDS, days: number, options?: RelativeTimeFilterOptions): DaysFilter<FIELDS>;
|
|
220
|
+
/**
|
|
221
|
+
* Matches times before the start of the day `days - 1` days ago, that is,
|
|
222
|
+
* before the window that `recentDays` covers with the same `days`.
|
|
223
|
+
*
|
|
224
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
225
|
+
* @param days - Number of calendar days, including today; an integer from
|
|
226
|
+
* 1 to 2147483647.
|
|
227
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
228
|
+
* @returns `{ op: 'earlier-days', field, days }`, plus `timeZone` when set.
|
|
229
|
+
* @throws TypeError If `days` is not an integer from 1 to 2147483647,
|
|
230
|
+
* `field` is not a valid query field path, or `timeZone` is blank or an
|
|
231
|
+
* invalid UTC offset.
|
|
232
|
+
* @example
|
|
233
|
+
* ```typescript
|
|
234
|
+
* filter.earlierDays('state.createTime', 7);
|
|
235
|
+
* ```
|
|
236
|
+
*/
|
|
237
|
+
earlierDays<FIELDS extends string>(field: FIELDS, days: number, options?: RelativeTimeFilterOptions): DaysFilter<FIELDS>;
|
|
238
|
+
/**
|
|
239
|
+
* Matches times strictly before the server's `now + offset`
|
|
240
|
+
* (`field < now + offset`). The server reads its clock once per query,
|
|
241
|
+
* so a saved query never depends on the client's clock, and the moment is
|
|
242
|
+
* encoded the way the query schema says the field stores time: an epoch in
|
|
243
|
+
* its unit, or text in its pattern, in the zone `timeZone` names.
|
|
244
|
+
*
|
|
245
|
+
* Needs a Wow server of 9.2.0 or later; an earlier one refuses `BEFORE_NOW`.
|
|
246
|
+
*
|
|
247
|
+
* @param field - Query field path, e.g. `state.timeoutAt`.
|
|
248
|
+
* @param offset - ISO-8601 duration added to now, as
|
|
249
|
+
* `java.time.Duration.parse` reads it: days, hours, minutes and seconds,
|
|
250
|
+
* each optionally signed, e.g. `PT0S`, `-PT30M` or `P1DT2H`. A negative
|
|
251
|
+
* offset looks back. Defaults to `PT0S`, now itself.
|
|
252
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
253
|
+
* @returns `{ op: 'before-now', field, offset }`, plus `timeZone` when set.
|
|
254
|
+
* @throws TypeError If `offset` is not an ISO-8601 duration in that
|
|
255
|
+
* grammar, `field` is not a valid query field path, or `timeZone` is blank
|
|
256
|
+
* or an invalid UTC offset.
|
|
257
|
+
* @example
|
|
258
|
+
* ```typescript
|
|
259
|
+
* // Timed out: the deadline has passed.
|
|
260
|
+
* filter.beforeNow('state.timeoutAt');
|
|
261
|
+
* ```
|
|
262
|
+
*/
|
|
263
|
+
beforeNow<FIELDS extends string>(field: FIELDS, offset?: string, options?: RelativeTimeFilterOptions): NowFilter<FIELDS>;
|
|
264
|
+
/**
|
|
265
|
+
* Matches times strictly after the server's `now + offset`
|
|
266
|
+
* (`field > now + offset`). The server reads its clock once per query,
|
|
267
|
+
* so a saved query never depends on the client's clock, and the moment is
|
|
268
|
+
* encoded the way the query schema says the field stores time: an epoch in
|
|
269
|
+
* its unit, or text in its pattern, in the zone `timeZone` names.
|
|
270
|
+
*
|
|
271
|
+
* Needs a Wow server of 9.2.0 or later; an earlier one refuses `AFTER_NOW`.
|
|
272
|
+
*
|
|
273
|
+
* @param field - Query field path, e.g. `state.timeoutAt`.
|
|
274
|
+
* @param offset - ISO-8601 duration added to now, as
|
|
275
|
+
* `java.time.Duration.parse` reads it: days, hours, minutes and seconds,
|
|
276
|
+
* each optionally signed, e.g. `PT0S`, `-PT30M` or `P1DT2H`. A negative
|
|
277
|
+
* offset looks back. Defaults to `PT0S`, now itself.
|
|
278
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
279
|
+
* @returns `{ op: 'after-now', field, offset }`, plus `timeZone` when set.
|
|
280
|
+
* @throws TypeError If `offset` is not an ISO-8601 duration in that
|
|
281
|
+
* grammar, `field` is not a valid query field path, or `timeZone` is blank
|
|
282
|
+
* or an invalid UTC offset.
|
|
283
|
+
* @example
|
|
284
|
+
* ```typescript
|
|
285
|
+
* // Created in the last 30 minutes.
|
|
286
|
+
* filter.afterNow('state.createTime', '-PT30M');
|
|
287
|
+
* ```
|
|
288
|
+
*/
|
|
289
|
+
afterNow<FIELDS extends string>(field: FIELDS, offset?: string, options?: RelativeTimeFilterOptions): NowFilter<FIELDS>;
|
|
290
|
+
};
|
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
import { BeforeTodayFilter, CalendarFilter, DaysFilter, NowFilter, RelativeTimeFilterOptions } from './types.js';
|
|
2
|
+
/** The filters on a time field: calendar periods, days relative to today, and instants relative to the server's now. */
|
|
3
|
+
export declare const timeFilters: {
|
|
4
|
+
/**
|
|
5
|
+
* Matches times within today, as the half-open range `[start, end)` in the
|
|
6
|
+
* configured time zone.
|
|
7
|
+
*
|
|
8
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
9
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
10
|
+
* @returns `{ op: 'today', field }`, plus `timeZone` when set.
|
|
11
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
12
|
+
* blank or an invalid UTC offset.
|
|
13
|
+
* @example
|
|
14
|
+
* ```typescript
|
|
15
|
+
* filter.today('state.createTime', { timeZone: 'Asia/Shanghai' });
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
today<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
19
|
+
/**
|
|
20
|
+
* Matches times earlier than today at the local time `time`
|
|
21
|
+
* (`field < today at time`) in the configured time zone.
|
|
22
|
+
*
|
|
23
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
24
|
+
* @param time - 24-hour local time: `HH:mm`, `HH:mm:ss` or `HH:mm:ss.S` with
|
|
25
|
+
* 1 to 9 fraction digits.
|
|
26
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
27
|
+
* @returns `{ op: 'before-today', field, time }`, plus `timeZone` when set.
|
|
28
|
+
* @throws TypeError If `time` is not a string in one of the formats above,
|
|
29
|
+
* `field` is not a valid query field path, or `timeZone` is blank or an
|
|
30
|
+
* invalid UTC offset.
|
|
31
|
+
* @example
|
|
32
|
+
* ```typescript
|
|
33
|
+
* filter.beforeToday('state.createTime', '12:00');
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
beforeToday<FIELDS extends string>(field: FIELDS, time: string, options?: RelativeTimeFilterOptions): BeforeTodayFilter<FIELDS>;
|
|
37
|
+
/**
|
|
38
|
+
* Matches times within tomorrow, as the half-open range `[start, end)` in the
|
|
39
|
+
* configured time zone.
|
|
40
|
+
*
|
|
41
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
42
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
43
|
+
* @returns `{ op: 'tomorrow', field }`, plus `timeZone` when set.
|
|
44
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
45
|
+
* blank or an invalid UTC offset.
|
|
46
|
+
* @example
|
|
47
|
+
* ```typescript
|
|
48
|
+
* filter.tomorrow('state.createTime');
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
tomorrow<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
52
|
+
/**
|
|
53
|
+
* Matches times within the current Monday-start week, as the half-open range `[start, end)` in the
|
|
54
|
+
* configured time zone.
|
|
55
|
+
*
|
|
56
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
57
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
58
|
+
* @returns `{ op: 'this-week', field }`, plus `timeZone` when set.
|
|
59
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
60
|
+
* blank or an invalid UTC offset.
|
|
61
|
+
* @example
|
|
62
|
+
* ```typescript
|
|
63
|
+
* filter.thisWeek('state.createTime');
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
thisWeek<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
67
|
+
/**
|
|
68
|
+
* Matches times within the next Monday-start week, as the half-open range `[start, end)` in the
|
|
69
|
+
* configured time zone.
|
|
70
|
+
*
|
|
71
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
72
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
73
|
+
* @returns `{ op: 'next-week', field }`, plus `timeZone` when set.
|
|
74
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
75
|
+
* blank or an invalid UTC offset.
|
|
76
|
+
* @example
|
|
77
|
+
* ```typescript
|
|
78
|
+
* filter.nextWeek('state.createTime');
|
|
79
|
+
* ```
|
|
80
|
+
*/
|
|
81
|
+
nextWeek<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
82
|
+
/**
|
|
83
|
+
* Matches times within the previous Monday-start week, as the half-open range `[start, end)` in the
|
|
84
|
+
* configured time zone.
|
|
85
|
+
*
|
|
86
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
87
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
88
|
+
* @returns `{ op: 'last-week', field }`, plus `timeZone` when set.
|
|
89
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
90
|
+
* blank or an invalid UTC offset.
|
|
91
|
+
* @example
|
|
92
|
+
* ```typescript
|
|
93
|
+
* filter.lastWeek('state.createTime');
|
|
94
|
+
* ```
|
|
95
|
+
*/
|
|
96
|
+
lastWeek<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
97
|
+
/**
|
|
98
|
+
* Matches times within the current calendar month, as the half-open range `[start, end)` in the
|
|
99
|
+
* configured time zone.
|
|
100
|
+
*
|
|
101
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
102
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
103
|
+
* @returns `{ op: 'this-month', field }`, plus `timeZone` when set.
|
|
104
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
105
|
+
* blank or an invalid UTC offset.
|
|
106
|
+
* @example
|
|
107
|
+
* ```typescript
|
|
108
|
+
* filter.thisMonth('state.createTime');
|
|
109
|
+
* ```
|
|
110
|
+
*/
|
|
111
|
+
thisMonth<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
112
|
+
/**
|
|
113
|
+
* Matches times within the previous calendar month, as the half-open range `[start, end)` in the
|
|
114
|
+
* configured time zone.
|
|
115
|
+
*
|
|
116
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
117
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
118
|
+
* @returns `{ op: 'last-month', field }`, plus `timeZone` when set.
|
|
119
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
120
|
+
* blank or an invalid UTC offset.
|
|
121
|
+
* @example
|
|
122
|
+
* ```typescript
|
|
123
|
+
* filter.lastMonth('state.createTime');
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
lastMonth<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
127
|
+
/**
|
|
128
|
+
* Matches times within yesterday, as the half-open range `[start, end)` in the
|
|
129
|
+
* configured time zone.
|
|
130
|
+
*
|
|
131
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
132
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
133
|
+
* @returns `{ op: 'yesterday', field }`, plus `timeZone` when set.
|
|
134
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
135
|
+
* blank or an invalid UTC offset.
|
|
136
|
+
* @example
|
|
137
|
+
* ```typescript
|
|
138
|
+
* filter.yesterday('state.createTime');
|
|
139
|
+
* ```
|
|
140
|
+
*/
|
|
141
|
+
yesterday<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
142
|
+
/**
|
|
143
|
+
* Matches times within the next calendar month, as the half-open range `[start, end)` in the
|
|
144
|
+
* configured time zone.
|
|
145
|
+
*
|
|
146
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
147
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
148
|
+
* @returns `{ op: 'next-month', field }`, plus `timeZone` when set.
|
|
149
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
150
|
+
* blank or an invalid UTC offset.
|
|
151
|
+
* @example
|
|
152
|
+
* ```typescript
|
|
153
|
+
* filter.nextMonth('state.createTime');
|
|
154
|
+
* ```
|
|
155
|
+
*/
|
|
156
|
+
nextMonth<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
157
|
+
/**
|
|
158
|
+
* Matches times within the previous calendar year, as the half-open range `[start, end)` in the
|
|
159
|
+
* configured time zone.
|
|
160
|
+
*
|
|
161
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
162
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
163
|
+
* @returns `{ op: 'last-year', field }`, plus `timeZone` when set.
|
|
164
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
165
|
+
* blank or an invalid UTC offset.
|
|
166
|
+
* @example
|
|
167
|
+
* ```typescript
|
|
168
|
+
* filter.lastYear('state.createTime');
|
|
169
|
+
* ```
|
|
170
|
+
*/
|
|
171
|
+
lastYear<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
172
|
+
/**
|
|
173
|
+
* Matches times within the current calendar year, as the half-open range `[start, end)` in the
|
|
174
|
+
* configured time zone.
|
|
175
|
+
*
|
|
176
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
177
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
178
|
+
* @returns `{ op: 'this-year', field }`, plus `timeZone` when set.
|
|
179
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
180
|
+
* blank or an invalid UTC offset.
|
|
181
|
+
* @example
|
|
182
|
+
* ```typescript
|
|
183
|
+
* filter.thisYear('state.createTime', { timeZone: 'Asia/Shanghai' });
|
|
184
|
+
* ```
|
|
185
|
+
*/
|
|
186
|
+
thisYear<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
187
|
+
/**
|
|
188
|
+
* Matches times within the next calendar year, as the half-open range `[start, end)` in the
|
|
189
|
+
* configured time zone.
|
|
190
|
+
*
|
|
191
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
192
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
193
|
+
* @returns `{ op: 'next-year', field }`, plus `timeZone` when set.
|
|
194
|
+
* @throws TypeError If `field` is not a valid query field path, or `timeZone` is
|
|
195
|
+
* blank or an invalid UTC offset.
|
|
196
|
+
* @example
|
|
197
|
+
* ```typescript
|
|
198
|
+
* filter.nextYear('state.createTime');
|
|
199
|
+
* ```
|
|
200
|
+
*/
|
|
201
|
+
nextYear<FIELDS extends string>(field: FIELDS, options?: RelativeTimeFilterOptions): CalendarFilter<FIELDS>;
|
|
202
|
+
/**
|
|
203
|
+
* Matches times from the start of the day `days - 1` days ago until the end
|
|
204
|
+
* of today. `recentDays(field, 7)` covers today and the six previous days.
|
|
205
|
+
*
|
|
206
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
207
|
+
* @param days - Number of calendar days, including today; an integer from
|
|
208
|
+
* 1 to 2147483647.
|
|
209
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
210
|
+
* @returns `{ op: 'recent-days', field, days }`, plus `timeZone` when set.
|
|
211
|
+
* @throws TypeError If `days` is not an integer from 1 to 2147483647,
|
|
212
|
+
* `field` is not a valid query field path, or `timeZone` is blank or an
|
|
213
|
+
* invalid UTC offset.
|
|
214
|
+
* @example
|
|
215
|
+
* ```typescript
|
|
216
|
+
* filter.recentDays('state.createTime', 7);
|
|
217
|
+
* ```
|
|
218
|
+
*/
|
|
219
|
+
recentDays<FIELDS extends string>(field: FIELDS, days: number, options?: RelativeTimeFilterOptions): DaysFilter<FIELDS>;
|
|
220
|
+
/**
|
|
221
|
+
* Matches times before the start of the day `days - 1` days ago, that is,
|
|
222
|
+
* before the window that `recentDays` covers with the same `days`.
|
|
223
|
+
*
|
|
224
|
+
* @param field - Query field path, e.g. `state.status`.
|
|
225
|
+
* @param days - Number of calendar days, including today; an integer from
|
|
226
|
+
* 1 to 2147483647.
|
|
227
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
228
|
+
* @returns `{ op: 'earlier-days', field, days }`, plus `timeZone` when set.
|
|
229
|
+
* @throws TypeError If `days` is not an integer from 1 to 2147483647,
|
|
230
|
+
* `field` is not a valid query field path, or `timeZone` is blank or an
|
|
231
|
+
* invalid UTC offset.
|
|
232
|
+
* @example
|
|
233
|
+
* ```typescript
|
|
234
|
+
* filter.earlierDays('state.createTime', 7);
|
|
235
|
+
* ```
|
|
236
|
+
*/
|
|
237
|
+
earlierDays<FIELDS extends string>(field: FIELDS, days: number, options?: RelativeTimeFilterOptions): DaysFilter<FIELDS>;
|
|
238
|
+
/**
|
|
239
|
+
* Matches times strictly before the server's `now + offset`
|
|
240
|
+
* (`field < now + offset`). The server reads its clock once per query,
|
|
241
|
+
* so a saved query never depends on the client's clock, and the moment is
|
|
242
|
+
* encoded the way the query schema says the field stores time: an epoch in
|
|
243
|
+
* its unit, or text in its pattern, in the zone `timeZone` names.
|
|
244
|
+
*
|
|
245
|
+
* Needs a Wow server of 9.2.0 or later; an earlier one refuses `BEFORE_NOW`.
|
|
246
|
+
*
|
|
247
|
+
* @param field - Query field path, e.g. `state.timeoutAt`.
|
|
248
|
+
* @param offset - ISO-8601 duration added to now, as
|
|
249
|
+
* `java.time.Duration.parse` reads it: days, hours, minutes and seconds,
|
|
250
|
+
* each optionally signed, e.g. `PT0S`, `-PT30M` or `P1DT2H`. A negative
|
|
251
|
+
* offset looks back. Defaults to `PT0S`, now itself.
|
|
252
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
253
|
+
* @returns `{ op: 'before-now', field, offset }`, plus `timeZone` when set.
|
|
254
|
+
* @throws TypeError If `offset` is not an ISO-8601 duration in that
|
|
255
|
+
* grammar, `field` is not a valid query field path, or `timeZone` is blank
|
|
256
|
+
* or an invalid UTC offset.
|
|
257
|
+
* @example
|
|
258
|
+
* ```typescript
|
|
259
|
+
* // Timed out: the deadline has passed.
|
|
260
|
+
* filter.beforeNow('state.timeoutAt');
|
|
261
|
+
* ```
|
|
262
|
+
*/
|
|
263
|
+
beforeNow<FIELDS extends string>(field: FIELDS, offset?: string, options?: RelativeTimeFilterOptions): NowFilter<FIELDS>;
|
|
264
|
+
/**
|
|
265
|
+
* Matches times strictly after the server's `now + offset`
|
|
266
|
+
* (`field > now + offset`). The server reads its clock once per query,
|
|
267
|
+
* so a saved query never depends on the client's clock, and the moment is
|
|
268
|
+
* encoded the way the query schema says the field stores time: an epoch in
|
|
269
|
+
* its unit, or text in its pattern, in the zone `timeZone` names.
|
|
270
|
+
*
|
|
271
|
+
* Needs a Wow server of 9.2.0 or later; an earlier one refuses `AFTER_NOW`.
|
|
272
|
+
*
|
|
273
|
+
* @param field - Query field path, e.g. `state.timeoutAt`.
|
|
274
|
+
* @param offset - ISO-8601 duration added to now, as
|
|
275
|
+
* `java.time.Duration.parse` reads it: days, hours, minutes and seconds,
|
|
276
|
+
* each optionally signed, e.g. `PT0S`, `-PT30M` or `P1DT2H`. A negative
|
|
277
|
+
* offset looks back. Defaults to `PT0S`, now itself.
|
|
278
|
+
* @param options - Optional `timeZone`; see {@link RelativeTimeFilterOptions}.
|
|
279
|
+
* @returns `{ op: 'after-now', field, offset }`, plus `timeZone` when set.
|
|
280
|
+
* @throws TypeError If `offset` is not an ISO-8601 duration in that
|
|
281
|
+
* grammar, `field` is not a valid query field path, or `timeZone` is blank
|
|
282
|
+
* or an invalid UTC offset.
|
|
283
|
+
* @example
|
|
284
|
+
* ```typescript
|
|
285
|
+
* // Created in the last 30 minutes.
|
|
286
|
+
* filter.afterNow('state.createTime', '-PT30M');
|
|
287
|
+
* ```
|
|
288
|
+
*/
|
|
289
|
+
afterNow<FIELDS extends string>(field: FIELDS, offset?: string, options?: RelativeTimeFilterOptions): NowFilter<FIELDS>;
|
|
290
|
+
};
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { FilterOperator as e } from "./operator.es.js";
|
|
2
|
+
import { queryField as t } from "../field.es.js";
|
|
3
|
+
import { requireDuration as n, requireLocalTime as r, validateDays as i, validateRelativeTimeOptions as a } from "./validate.es.js";
|
|
4
|
+
// src/dsl/filter/timeFilters.ts
|
|
5
|
+
function o(e, n, r) {
|
|
6
|
+
return {
|
|
7
|
+
...a(r),
|
|
8
|
+
op: e,
|
|
9
|
+
field: t(n)
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
function s(e, n, r, o) {
|
|
13
|
+
return i(e, r), {
|
|
14
|
+
...a(o),
|
|
15
|
+
op: e,
|
|
16
|
+
field: t(n),
|
|
17
|
+
days: r
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
function c(e, r, i, o) {
|
|
21
|
+
return n(e, i), {
|
|
22
|
+
...a(o),
|
|
23
|
+
op: e,
|
|
24
|
+
field: t(r),
|
|
25
|
+
offset: i
|
|
26
|
+
};
|
|
27
|
+
}
|
|
28
|
+
var l = {
|
|
29
|
+
today(t, n = {}) {
|
|
30
|
+
return o(e.TODAY, t, n);
|
|
31
|
+
},
|
|
32
|
+
beforeToday(n, i, o = {}) {
|
|
33
|
+
let s = r(i);
|
|
34
|
+
return {
|
|
35
|
+
...a(o),
|
|
36
|
+
op: e.BEFORE_TODAY,
|
|
37
|
+
field: t(n),
|
|
38
|
+
time: s
|
|
39
|
+
};
|
|
40
|
+
},
|
|
41
|
+
tomorrow(t, n = {}) {
|
|
42
|
+
return o(e.TOMORROW, t, n);
|
|
43
|
+
},
|
|
44
|
+
thisWeek(t, n = {}) {
|
|
45
|
+
return o(e.THIS_WEEK, t, n);
|
|
46
|
+
},
|
|
47
|
+
nextWeek(t, n = {}) {
|
|
48
|
+
return o(e.NEXT_WEEK, t, n);
|
|
49
|
+
},
|
|
50
|
+
lastWeek(t, n = {}) {
|
|
51
|
+
return o(e.LAST_WEEK, t, n);
|
|
52
|
+
},
|
|
53
|
+
thisMonth(t, n = {}) {
|
|
54
|
+
return o(e.THIS_MONTH, t, n);
|
|
55
|
+
},
|
|
56
|
+
lastMonth(t, n = {}) {
|
|
57
|
+
return o(e.LAST_MONTH, t, n);
|
|
58
|
+
},
|
|
59
|
+
yesterday(t, n = {}) {
|
|
60
|
+
return o(e.YESTERDAY, t, n);
|
|
61
|
+
},
|
|
62
|
+
nextMonth(t, n = {}) {
|
|
63
|
+
return o(e.NEXT_MONTH, t, n);
|
|
64
|
+
},
|
|
65
|
+
lastYear(t, n = {}) {
|
|
66
|
+
return o(e.LAST_YEAR, t, n);
|
|
67
|
+
},
|
|
68
|
+
thisYear(t, n = {}) {
|
|
69
|
+
return o(e.THIS_YEAR, t, n);
|
|
70
|
+
},
|
|
71
|
+
nextYear(t, n = {}) {
|
|
72
|
+
return o(e.NEXT_YEAR, t, n);
|
|
73
|
+
},
|
|
74
|
+
recentDays(t, n, r = {}) {
|
|
75
|
+
return s(e.RECENT_DAYS, t, n, r);
|
|
76
|
+
},
|
|
77
|
+
earlierDays(t, n, r = {}) {
|
|
78
|
+
return s(e.EARLIER_DAYS, t, n, r);
|
|
79
|
+
},
|
|
80
|
+
beforeNow(t, n = "PT0S", r = {}) {
|
|
81
|
+
return c(e.BEFORE_NOW, t, n, r);
|
|
82
|
+
},
|
|
83
|
+
afterNow(t, n = "PT0S", r = {}) {
|
|
84
|
+
return c(e.AFTER_NOW, t, n, r);
|
|
85
|
+
}
|
|
86
|
+
};
|
|
87
|
+
export { l as timeFilters };
|
|
88
|
+
|
|
89
|
+
//# sourceMappingURL=timeFilters.es.js.map
|