@remit/api-http-client 0.0.19 → 0.0.21

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types.gen.ts +28 -21
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remit/api-http-client",
3
- "version": "0.0.19",
3
+ "version": "0.0.21",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": "./index.ts",
package/types.gen.ts CHANGED
@@ -707,7 +707,7 @@ export type RemitImapCreateFilterInput = {
707
707
  */
708
708
  actionLabelId: string;
709
709
  /**
710
- * Mailbox matched messages are moved into — exclusive action, since a message lives in exactly one mailbox (RFC 034 Decision 3.1). On conflict between filters, the one with the latest ruleChangedAt wins. `"None"` means no move action.
710
+ * Mailbox matched messages are moved into — exclusive action, since a message lives in exactly one mailbox (RFC 034 Decision 3.1). On conflict between filters, the one with the latest actionChangedAt wins. `"None"` means no move action.
711
711
  */
712
712
  actionMailboxId: string;
713
713
  /**
@@ -1029,9 +1029,13 @@ export type RemitImapFilterResponse = {
1029
1029
  */
1030
1030
  readonly hasAnchor: boolean;
1031
1031
  /**
1032
- * Epoch seconds, written only when the predicate (literalClauses, hasAnchor) or the action (actionLabelId, actionMailboxId) changes — never on a cosmetic rename. Backs most-recently-changed-filter-wins precedence for the exclusive move action (RFC 034 Decision 3.2). Distinct from ElectroDB's own updatedAt, which bumps on any write.
1032
+ * Epoch seconds, written whenever the predicate, the action, the scope, or the expiry changes (reader #266) — never on a cosmetic rename. This is the broad "the user asserted something new about this rule" signal the settings UI uses to decide whether to re-offer a lapsed filter's back-application. It is deliberately NOT the precedence signal for the exclusive move action — see actionChangedAt for that (RFC 034 Decision 3.2, reader #384). Distinct from ElectroDB's own updatedAt, which bumps on any write.
1033
1033
  */
1034
1034
  readonly ruleChangedAt: number;
1035
+ /**
1036
+ * Epoch seconds, written only when the predicate (literalClauses, hasAnchor) or the action (actionLabelId, actionMailboxId) changes — never on scope, expiresAt, or a cosmetic rename. Backs most-recently-changed-filter-wins precedence for the exclusive move action (RFC 034 Decision 3.2). Split out from ruleChangedAt (reader #384): extending a filter's expiry or flipping its scope changes its lifecycle, not what it matches or does, so it must not promote the filter to move-winner.
1037
+ */
1038
+ readonly actionChangedAt: number;
1035
1039
  /**
1036
1040
  * How literalClauses combine. Meaningless when literalClauses is empty.
1037
1041
  */
@@ -1045,7 +1049,7 @@ export type RemitImapFilterResponse = {
1045
1049
  */
1046
1050
  actionLabelId: string;
1047
1051
  /**
1048
- * Mailbox matched messages are moved into — exclusive action, since a message lives in exactly one mailbox (RFC 034 Decision 3.1). On conflict between filters, the one with the latest ruleChangedAt wins. `"None"` means no move action.
1052
+ * Mailbox matched messages are moved into — exclusive action, since a message lives in exactly one mailbox (RFC 034 Decision 3.1). On conflict between filters, the one with the latest actionChangedAt wins. `"None"` means no move action.
1049
1053
  */
1050
1054
  actionMailboxId: string;
1051
1055
  readonly createdAt: number;
@@ -2157,10 +2161,10 @@ export type RemitImapThreadMessageResponse = {
2157
2161
 
2158
2162
  /**
2159
2163
  * Aggregate response for `searchThreads`. Carries the matching rows (`items`), a
2160
- * pagination `continuationToken`, and an optional `count` of matches within the
2161
- * server-capped window. `items` is omitted when `results=false` (count-only);
2162
- * `count` is present only when `count=true`. Thread-specific so the shared
2163
- * `ResultList<T>` (7 endpoints) stays untouched.
2164
+ * pagination `continuationToken`, and an optional `count` of every message the
2165
+ * query matches. `items` is omitted when `results=false` (count-only); `count` is
2166
+ * present only when `count=true`. Thread-specific so the shared `ResultList<T>`
2167
+ * (7 endpoints) stays untouched.
2164
2168
  */
2165
2169
  export type RemitImapThreadSearchResponse = {
2166
2170
  /**
@@ -2172,7 +2176,7 @@ export type RemitImapThreadSearchResponse = {
2172
2176
  */
2173
2177
  continuationToken?: String800;
2174
2178
  /**
2175
- * Number of matches within the server-capped window. Present only when `count=true`.
2179
+ * How many messages the query matches, over the whole mailbox and independent of `limit`. Present only when `count=true`. With `senderTrust` or `dkimMismatch` in the query the count is over the enriched window instead, since those are resolved off the row.
2176
2180
  */
2177
2181
  count?: number;
2178
2182
  };
@@ -2307,10 +2311,13 @@ export type RemitImapUpdateAddressInput = {
2307
2311
  * Input for updating a filter (RFC 034, reader #266). The name, predicate,
2308
2312
  * action, scope, and expiresAt are all updatable; `ttl` is always
2309
2313
  * server-derived from `scope`/`expiresAt`, never client-supplied, and
2310
- * `state`/`hasAnchor`/`ruleChangedAt`/`filterId` are server-derived too. A
2311
- * patch touching the predicate, the action, `scope`, or `expiresAt` bumps
2312
- * `ruleChangedAt`; a name-only rename never does (RFC 034 Decision 3.2, reader
2313
- * #266).
2314
+ * `state`/`hasAnchor`/`ruleChangedAt`/`actionChangedAt`/`filterId` are
2315
+ * server-derived too. A patch touching the predicate, the action, `scope`, or
2316
+ * `expiresAt` bumps `ruleChangedAt`; a name-only rename never does (RFC 034
2317
+ * Decision 3.2, reader #266). Only a patch touching the predicate or the
2318
+ * action bumps `actionChangedAt`, the narrower signal exclusive-move
2319
+ * precedence reads (reader #384) — a scope/expiresAt-only edit leaves it
2320
+ * untouched.
2314
2321
  *
2315
2322
  * The semantic anchor has no field here at all — it is set once, from
2316
2323
  * `anchorMessageId`, only on `CreateFilterInput`. Repointing an anchor would
@@ -2344,7 +2351,7 @@ export type RemitImapUpdateFilterInput = {
2344
2351
  */
2345
2352
  actionLabelId?: string;
2346
2353
  /**
2347
- * Mailbox matched messages are moved into — exclusive action, since a message lives in exactly one mailbox (RFC 034 Decision 3.1). On conflict between filters, the one with the latest ruleChangedAt wins. `"None"` means no move action.
2354
+ * Mailbox matched messages are moved into — exclusive action, since a message lives in exactly one mailbox (RFC 034 Decision 3.1). On conflict between filters, the one with the latest actionChangedAt wins. `"None"` means no move action.
2348
2355
  */
2349
2356
  actionMailboxId?: string;
2350
2357
  };
@@ -2637,7 +2644,7 @@ export type RemitImapFilterResponseWritable = {
2637
2644
  */
2638
2645
  actionLabelId: string;
2639
2646
  /**
2640
- * Mailbox matched messages are moved into — exclusive action, since a message lives in exactly one mailbox (RFC 034 Decision 3.1). On conflict between filters, the one with the latest ruleChangedAt wins. `"None"` means no move action.
2647
+ * Mailbox matched messages are moved into — exclusive action, since a message lives in exactly one mailbox (RFC 034 Decision 3.1). On conflict between filters, the one with the latest actionChangedAt wins. `"None"` means no move action.
2641
2648
  */
2642
2649
  actionMailboxId: string;
2643
2650
  };
@@ -2756,10 +2763,10 @@ export type RemitImapThreadMessageResponseWritable = {
2756
2763
 
2757
2764
  /**
2758
2765
  * Aggregate response for `searchThreads`. Carries the matching rows (`items`), a
2759
- * pagination `continuationToken`, and an optional `count` of matches within the
2760
- * server-capped window. `items` is omitted when `results=false` (count-only);
2761
- * `count` is present only when `count=true`. Thread-specific so the shared
2762
- * `ResultList<T>` (7 endpoints) stays untouched.
2766
+ * pagination `continuationToken`, and an optional `count` of every message the
2767
+ * query matches. `items` is omitted when `results=false` (count-only); `count` is
2768
+ * present only when `count=true`. Thread-specific so the shared `ResultList<T>`
2769
+ * (7 endpoints) stays untouched.
2763
2770
  */
2764
2771
  export type RemitImapThreadSearchResponseWritable = {
2765
2772
  /**
@@ -2771,7 +2778,7 @@ export type RemitImapThreadSearchResponseWritable = {
2771
2778
  */
2772
2779
  continuationToken?: String800;
2773
2780
  /**
2774
- * Number of matches within the server-capped window. Present only when `count=true`.
2781
+ * How many messages the query matches, over the whole mailbox and independent of `limit`. Present only when `count=true`. With `senderTrust` or `dkimMismatch` in the query the count is over the enriched window instead, since those are resolved off the row.
2775
2782
  */
2776
2783
  count?: number;
2777
2784
  };
@@ -3415,7 +3422,7 @@ export type ThreadOperationsSearchThreadsData = {
3415
3422
  */
3416
3423
  dkimMismatch?: boolean;
3417
3424
  /**
3418
- * Include a count of matches within the server-capped window.
3425
+ * Include how many messages the query matches. Counted over the whole mailbox, independent of `limit`.
3419
3426
  */
3420
3427
  count?: boolean;
3421
3428
  /**
@@ -3423,7 +3430,7 @@ export type ThreadOperationsSearchThreadsData = {
3423
3430
  */
3424
3431
  results?: boolean;
3425
3432
  /**
3426
- * Caller-set recency window, capped server-side at 500. Bounds the read.
3433
+ * Page size for the rows returned, capped server-side at 500. Bounds the read, not the `count`.
3427
3434
  */
3428
3435
  limit?: number;
3429
3436
  };