sinfactura-types 1.8.2 → 1.8.3
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/dist/api.d.ts +32 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -5,7 +5,38 @@ declare global {
|
|
|
5
5
|
message: string | null;
|
|
6
6
|
data: T;
|
|
7
7
|
ConsumedCapacity?: Record<string, string | number>;
|
|
8
|
-
|
|
8
|
+
/**
|
|
9
|
+
* Either a DynamoDB key object or an opaque, already-encoded cursor string,
|
|
10
|
+
* depending on the endpoint (api#1983):
|
|
11
|
+
*
|
|
12
|
+
* - **Key object** — a handler surfacing a raw page cursor from its own
|
|
13
|
+
* `Query` (`GET /products`, `/customers`, `/invoices`, `/users`,
|
|
14
|
+
* `/notifications`, `/logs`, the platform MP log endpoints). Key attributes
|
|
15
|
+
* are `S` or `N`, so a value can be a NUMBER whenever the query rides a
|
|
16
|
+
* GSI with a numeric sort key: `GET /invoices`' date branch (`PK-dated`)
|
|
17
|
+
* yields `{ PK, SK, dated }` with a numeric `dated`, and `GET /products`'
|
|
18
|
+
* list branch (`PK-updatedAt`) likewise. Previously typed
|
|
19
|
+
* `Record<string, string>`, which those endpoints never actually matched.
|
|
20
|
+
* - **Opaque string** — a base64url cursor the caller round-trips back
|
|
21
|
+
* unparsed as `?startKey=`. `GET /suppliers?mode=invoices` and
|
|
22
|
+
* `mode=invoiceFiles` emit this: their cursor is derived from the last
|
|
23
|
+
* RETURNED row, never from a raw `LastEvaluatedKey`, which can skip rows.
|
|
24
|
+
*
|
|
25
|
+
* Consumers must not assume this is enumerable — treat the string form as
|
|
26
|
+
* opaque and pass it straight back.
|
|
27
|
+
*/
|
|
28
|
+
LastEvaluatedKey?: string | Record<string, string | number>;
|
|
29
|
+
/**
|
|
30
|
+
* Set by endpoints whose result was capped before the query was exhausted,
|
|
31
|
+
* i.e. rows are genuinely missing (api#1983). Emitted today by
|
|
32
|
+
* `GET /reports?mode=sales` and `mode=supplier-invoices`.
|
|
33
|
+
*
|
|
34
|
+
* Distinct from `LastEvaluatedKey`: an endpoint can be truncated with NO
|
|
35
|
+
* cursor to continue from, so `truncated: true` is not "fetch the next page",
|
|
36
|
+
* it is "this answer is incomplete". Fiscal exports never set it — they fail
|
|
37
|
+
* the request instead, because a short fiscal file must not be returned at all.
|
|
38
|
+
*/
|
|
39
|
+
truncated?: boolean;
|
|
9
40
|
}
|
|
10
41
|
}
|
|
11
42
|
export {};
|