@0xmonaco/types 1.0.62 → 1.0.64

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.
@@ -170,12 +170,13 @@ export interface GetPaginatedOrdersParams {
170
170
  * - Non-empty: an opaque cursor from a previous response's
171
171
  * `nextPageToken`; results resume immediately after that position.
172
172
  *
173
- * In either cursor-walk state (empty or non-empty), `page` is ignored, the
174
- * response omits exact totals (`total`/`totalPages`/`page` are 0), and
175
- * results cover full order history — hot and archived rows merged —
176
- * unlike page-number mode, which only ever sees recent history. Clients
177
- * that need complete order history must use the cursor form (pass `""` to
178
- * start, then follow `nextPageToken`) rather than `page`.
173
+ * In either cursor-walk state (empty or non-empty), `page` is ignored (it
174
+ * comes back as 0), but `total` and `totalPages` ARE populated — bounded by
175
+ * the server count ceiling, see `totalCapped`. Results cover full order
176
+ * history — hot and archived rows merged — unlike page-number mode, which
177
+ * only ever sees recent history. Clients that need complete order history
178
+ * must use the cursor form (pass `""` to start, then follow `nextPageToken`)
179
+ * rather than `page`.
179
180
  */
180
181
  pageToken?: string;
181
182
  }
@@ -186,10 +187,9 @@ export interface GetPaginatedOrdersResponse {
186
187
  /** Array of historical orders from PostgreSQL (paginated) */
187
188
  orders: Order[];
188
189
  /**
189
- * Total number of orders matching the query.
190
- *
191
- * @deprecated Only populated by legacy page-number (offset) responses; 0 in
192
- * cursor mode, which has no exact total. Walk `nextPageToken` instead.
190
+ * Total number of orders matching the query, populated in BOTH pagination
191
+ * modes and bounded by the server count ceiling — see `totalCapped`. When
192
+ * `totalCapped` is `true` this is a lower bound (at least this many exist).
193
193
  */
194
194
  total: number;
195
195
  /**
@@ -202,10 +202,9 @@ export interface GetPaginatedOrdersResponse {
202
202
  /** Number of orders per page */
203
203
  pageSize: number;
204
204
  /**
205
- * Total number of pages.
206
- *
207
- * @deprecated Only populated by legacy page-number (offset) responses; 0 in
208
- * cursor mode, which has no exact total. Walk `nextPageToken` instead.
205
+ * Total number of pages at this `pageSize`, populated in BOTH pagination
206
+ * modes and bounded by the server count ceiling — see `totalCapped`. A lower
207
+ * bound when `totalCapped` is `true`.
209
208
  */
210
209
  totalPages: number;
211
210
  /**
@@ -223,6 +222,13 @@ export interface GetPaginatedOrdersResponse {
223
222
  * history.
224
223
  */
225
224
  nextPageToken: string;
225
+ /**
226
+ * `true` when MORE than the server ceiling of orders matched, so the count
227
+ * stopped at the ceiling and `total` / `totalPages` are a lower bound (more
228
+ * than `total` orders exist). `false` when `total` is the exact count —
229
+ * including exactly the ceiling, which is still reported exactly.
230
+ */
231
+ totalCapped: boolean;
226
232
  }
227
233
  /**
228
234
  * Response from getting a single order by ID
@@ -6288,8 +6288,7 @@ export interface components {
6288
6288
  orders?: components["schemas"]["GetOrderResponse"][] | null;
6289
6289
  /**
6290
6290
  * Format: uint32
6291
- * @deprecated
6292
- * @description Deprecated: total number of orders matching the filter (legacy offset mode only; 0 in cursor mode)
6291
+ * @description Total number of orders matching the filter, populated in both pagination modes; bounded by the server ceiling — a lower bound when totalCapped is true.
6293
6292
  * @example 150
6294
6293
  */
6295
6294
  total?: number | null;
@@ -6308,8 +6307,7 @@ export interface components {
6308
6307
  pageSize?: number | null;
6309
6308
  /**
6310
6309
  * Format: uint32
6311
- * @deprecated
6312
- * @description Deprecated: total number of pages (legacy offset mode only; 0 in cursor mode)
6310
+ * @description Total number of pages at this pageSize, populated in both pagination modes; bounded by the server ceiling — a lower bound when totalCapped is true.
6313
6311
  * @example 8
6314
6312
  */
6315
6313
  totalPages?: number | null;
@@ -6329,6 +6327,11 @@ export interface components {
6329
6327
  * means page-number mode does not participate in cursor continuation.
6330
6328
  */
6331
6329
  nextPageToken?: string | null;
6330
+ /**
6331
+ * @description True when more than the server ceiling of orders matched, so the count stopped at the ceiling and total/totalPages are a lower bound (more than total exist). False when total is the exact count, including exactly the ceiling.
6332
+ * @example false
6333
+ */
6334
+ totalCapped?: boolean | null;
6332
6335
  };
6333
6336
  ListPendingWithdrawalsResponse: {
6334
6337
  withdrawals?: components["schemas"]["PendingWithdrawal"][] | null;
@@ -12650,13 +12653,14 @@ export interface operations {
12650
12653
  * - Non-empty: an opaque cursor from a previous response's
12651
12654
  * `next_page_token`; results resume immediately after that position.
12652
12655
  *
12653
- * In either cursor-walk state (empty or non-empty), `page` is ignored, the
12654
- * response omits exact totals (total/total_pages/page are 0), and results
12655
- * cover full order history — hot and archived rows merged — unlike
12656
- * page-number mode, which only ever sees recent history. Clients that need
12657
- * complete order history must use the cursor form (start with an empty
12658
- * string, then follow next_page_token) rather than `page`. Filters and
12659
- * orderBy must match the request that produced the token.
12656
+ * In either cursor-walk state (empty or non-empty), `page` is ignored (it
12657
+ * comes back as 0), but `total` and `total_pages` ARE populated — bounded by
12658
+ * the server count ceiling, see `total_capped`. Results cover full order
12659
+ * history — hot and archived rows merged — unlike page-number mode, which
12660
+ * only ever sees recent history. Clients that need complete order history
12661
+ * must use the cursor form (start with an empty string, then follow
12662
+ * next_page_token) rather than `page`. Filters and orderBy must match the
12663
+ * request that produced the token.
12660
12664
  */
12661
12665
  pageToken?: string;
12662
12666
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@0xmonaco/types",
3
- "version": "1.0.62",
3
+ "version": "1.0.64",
4
4
  "type": "module",
5
5
  "homepage": "https://docs.0xmonaco.com/sdk/typescript",
6
6
  "main": "./dist/index.js",
@@ -16,7 +16,7 @@
16
16
  "lint": "biome lint ."
17
17
  },
18
18
  "dependencies": {
19
- "@0xmonaco/contracts": "1.0.62",
19
+ "@0xmonaco/contracts": "1.0.64",
20
20
  "zod": "^4.1.12"
21
21
  },
22
22
  "peerDependencies": {