@bedrock-rbx/ocale 0.3.4 → 0.5.0
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 +10 -5
- package/dist/assets.d.mts +64 -0
- package/dist/assets.d.mts.map +1 -0
- package/dist/assets.mjs +301 -0
- package/dist/assets.mjs.map +1 -0
- package/dist/badge-insufficient-funds-BLFvQZt1.mjs +91 -0
- package/dist/badge-insufficient-funds-BLFvQZt1.mjs.map +1 -0
- package/dist/badges.d.mts +359 -196
- package/dist/badges.d.mts.map +1 -1
- package/dist/badges.mjs +493 -59
- package/dist/badges.mjs.map +1 -1
- package/dist/capacity-admission-Ce2V9QNb.d.mts +347 -0
- package/dist/capacity-admission-Ce2V9QNb.d.mts.map +1 -0
- package/dist/{data.generated-B2ceLfSn.d.mts → data.generated-B4Fztv_7.d.mts} +23 -25
- package/dist/data.generated-B4Fztv_7.d.mts.map +1 -0
- package/dist/developer-products.d.mts +207 -194
- package/dist/developer-products.d.mts.map +1 -1
- package/dist/developer-products.mjs +125 -39
- package/dist/developer-products.mjs.map +1 -1
- package/dist/game-passes.d.mts +206 -211
- package/dist/game-passes.d.mts.map +1 -1
- package/dist/game-passes.mjs +35 -36
- package/dist/game-passes.mjs.map +1 -1
- package/dist/index.d.mts +947 -366
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +324 -12
- package/dist/index.mjs.map +1 -1
- package/dist/is-date-time-string-C91G44SI.mjs +19 -0
- package/dist/is-date-time-string-C91G44SI.mjs.map +1 -0
- package/dist/locales.d.mts +28 -2
- package/dist/locales.d.mts.map +1 -0
- package/dist/locales.mjs +24 -3
- package/dist/locales.mjs.map +1 -1
- package/dist/luau-execution.d.mts +154 -157
- package/dist/luau-execution.d.mts.map +1 -1
- package/dist/luau-execution.mjs +15 -16
- package/dist/luau-execution.mjs.map +1 -1
- package/dist/{network-error-DR9FX5hb.mjs → network-error-P4An7nUB.mjs} +48 -14
- package/dist/network-error-P4An7nUB.mjs.map +1 -0
- package/dist/places.d.mts +258 -186
- package/dist/places.d.mts.map +1 -1
- package/dist/places.mjs +187 -35
- package/dist/places.mjs.map +1 -1
- package/dist/{poll-timeout-3PXLsabj.mjs → poll-timeout-BCxgN97O.mjs} +4 -6
- package/dist/{poll-timeout-3PXLsabj.mjs.map → poll-timeout-BCxgN97O.mjs.map} +1 -1
- package/dist/{polling-helpers-CoVhsC33.mjs → polling-helpers-BtEYR5dN.mjs} +260 -105
- package/dist/polling-helpers-BtEYR5dN.mjs.map +1 -0
- package/dist/{price-information-B0tkOoAX.mjs → price-information--d6GZAcp.mjs} +3 -4
- package/dist/{price-information-B0tkOoAX.mjs.map → price-information--d6GZAcp.mjs.map} +1 -1
- package/dist/resource-client-CF8SPsV8.d.mts +162 -0
- package/dist/resource-client-CF8SPsV8.d.mts.map +1 -0
- package/dist/{resource-client-rqTMkBeR.mjs → resource-client-Cm_bPcCs.mjs} +589 -197
- package/dist/resource-client-Cm_bPcCs.mjs.map +1 -0
- package/dist/retry-DYxm_eBU.d.mts +225 -0
- package/dist/retry-DYxm_eBU.d.mts.map +1 -0
- package/dist/{retry-BlX4tUnT.mjs → retry-Dv5TsY9O.mjs} +312 -54
- package/dist/retry-Dv5TsY9O.mjs.map +1 -0
- package/dist/{signatures-JF-7Psce.mjs → signatures-CtJ7jfVN.mjs} +2 -3
- package/dist/{signatures-JF-7Psce.mjs.map → signatures-CtJ7jfVN.mjs.map} +1 -1
- package/dist/storage.d.mts +333 -344
- package/dist/storage.d.mts.map +1 -1
- package/dist/storage.mjs +39 -40
- package/dist/storage.mjs.map +1 -1
- package/dist/testing.d.mts +369 -434
- package/dist/testing.d.mts.map +1 -1
- package/dist/testing.mjs +18 -33
- package/dist/testing.mjs.map +1 -1
- package/dist/{to-blob-RPqMBuft.mjs → to-blob-Bqu7bmlE.mjs} +2 -3
- package/dist/{to-blob-RPqMBuft.mjs.map → to-blob-Bqu7bmlE.mjs.map} +1 -1
- package/dist/types-Z4abDJfK.d.mts +501 -0
- package/dist/types-Z4abDJfK.d.mts.map +1 -0
- package/dist/universes.d.mts +619 -436
- package/dist/universes.d.mts.map +1 -1
- package/dist/universes.mjs +432 -79
- package/dist/universes.mjs.map +1 -1
- package/dist/{validation-B_Zs1So2.mjs → validation-kaTLLAD1.mjs} +3 -4
- package/dist/{validation-B_Zs1So2.mjs.map → validation-kaTLLAD1.mjs.map} +1 -1
- package/dist/wire-DDG87I-d.d.mts +39 -0
- package/dist/wire-DDG87I-d.d.mts.map +1 -0
- package/package.json +15 -14
- package/dist/capacity-admission-IDO3fcUC.d.mts +0 -369
- package/dist/capacity-admission-IDO3fcUC.d.mts.map +0 -1
- package/dist/data.generated-B2ceLfSn.d.mts.map +0 -1
- package/dist/network-error-DR9FX5hb.mjs.map +0 -1
- package/dist/polling-helpers-CoVhsC33.mjs.map +0 -1
- package/dist/resource-client-B6NeFXUv.d.mts +0 -164
- package/dist/resource-client-B6NeFXUv.d.mts.map +0 -1
- package/dist/resource-client-rqTMkBeR.mjs.map +0 -1
- package/dist/retry-BlX4tUnT.mjs.map +0 -1
- package/dist/retry-war_-9tb.d.mts +0 -373
- package/dist/retry-war_-9tb.d.mts.map +0 -1
- package/dist/types-CvYh4SPC.d.mts +0 -386
- package/dist/types-CvYh4SPC.d.mts.map +0 -1
- package/dist/wire-D3K-a-UP.d.mts +0 -37
- package/dist/wire-D3K-a-UP.d.mts.map +0 -1
package/dist/storage.d.mts
CHANGED
|
@@ -1,52 +1,50 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { t as ResourceClient } from "./resource-client-
|
|
3
|
-
|
|
4
|
-
//#region src/domains/cloud-v2/memory-store-queues/types.d.ts
|
|
1
|
+
import { c as OpenCloudClientOptions, d as RequestOptions, g as OpenCloudError, m as Result } from "./types-Z4abDJfK.mjs";
|
|
2
|
+
import { t as ResourceClient } from "./resource-client-CF8SPsV8.mjs";
|
|
5
3
|
/**
|
|
6
|
-
* Caller-supplied input for the `enqueue` method on `StorageClient.queues`.
|
|
7
|
-
* Mirrors `Cloud_CreateMemoryStoreQueueItem` on the Open Cloud API.
|
|
8
|
-
*
|
|
9
|
-
* @since 0.1.0
|
|
10
|
-
*/
|
|
4
|
+
* Caller-supplied input for the `enqueue` method on `StorageClient.queues`.
|
|
5
|
+
* Mirrors `Cloud_CreateMemoryStoreQueueItem` on the Open Cloud API.
|
|
6
|
+
*
|
|
7
|
+
* @since 0.1.0
|
|
8
|
+
*/
|
|
11
9
|
interface EnqueueQueueItemParameters {
|
|
12
10
|
/**
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
11
|
+
* Opaque queue payload. Round-trips as JSON, including nested `null`
|
|
12
|
+
* values inside objects and arrays. The top-level value cannot be
|
|
13
|
+
* `null`: the server rejects null payloads with a 400, so the type
|
|
14
|
+
* forbids it at compile time.
|
|
15
|
+
*/
|
|
18
16
|
readonly data: Exclude<JSONValue, null>;
|
|
19
17
|
/**
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
18
|
+
* Optional priority. Higher values are dequeued first; equal priorities
|
|
19
|
+
* preserve insertion order. Omitted entries are inserted at the back of
|
|
20
|
+
* the queue.
|
|
21
|
+
*/
|
|
24
22
|
readonly priority?: number;
|
|
25
23
|
/** Stringified queue identifier; the queue is auto-created on first use. */
|
|
26
24
|
readonly queueId: string;
|
|
27
25
|
/**
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
26
|
+
* Optional time-to-live in seconds. After this many seconds the item is
|
|
27
|
+
* automatically removed from the queue. Omitted entries inherit the
|
|
28
|
+
* server-default TTL.
|
|
29
|
+
*/
|
|
32
30
|
readonly ttl?: number;
|
|
33
31
|
/** Stringified ID of the universe that owns the queue. */
|
|
34
32
|
readonly universeId: string;
|
|
35
33
|
}
|
|
36
34
|
/**
|
|
37
|
-
* Parsed representation of a memory-store queue item, as returned by the
|
|
38
|
-
* Open Cloud `Cloud_CreateMemoryStoreQueueItem` and (inside the array)
|
|
39
|
-
* `Cloud_ReadMemoryStoreQueueItems` endpoints.
|
|
40
|
-
*
|
|
41
|
-
* @since 0.1.0
|
|
42
|
-
*/
|
|
35
|
+
* Parsed representation of a memory-store queue item, as returned by the
|
|
36
|
+
* Open Cloud `Cloud_CreateMemoryStoreQueueItem` and (inside the array)
|
|
37
|
+
* `Cloud_ReadMemoryStoreQueueItems` endpoints.
|
|
38
|
+
*
|
|
39
|
+
* @since 0.1.0
|
|
40
|
+
*/
|
|
43
41
|
interface QueueItem {
|
|
44
42
|
/** Server-generated item identifier, parsed from the wire `path`. */
|
|
45
43
|
readonly id: string;
|
|
46
44
|
/**
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
45
|
+
* Opaque queue payload. Nested `null` values inside the JSON shape are
|
|
46
|
+
* preserved verbatim; only the top level is constrained.
|
|
47
|
+
*/
|
|
50
48
|
readonly data: Exclude<JSONValue, null>;
|
|
51
49
|
/** Timestamp at which the server removes the item from the queue. */
|
|
52
50
|
readonly expiresAt: Date;
|
|
@@ -58,28 +56,28 @@ interface QueueItem {
|
|
|
58
56
|
readonly universeId: string;
|
|
59
57
|
}
|
|
60
58
|
/**
|
|
61
|
-
* Caller-supplied input for the `dequeue` method on
|
|
62
|
-
* `StorageClient.queues`. Mirrors `Cloud_ReadMemoryStoreQueueItems`.
|
|
63
|
-
*
|
|
64
|
-
* @since 0.1.0
|
|
65
|
-
*/
|
|
59
|
+
* Caller-supplied input for the `dequeue` method on
|
|
60
|
+
* `StorageClient.queues`. Mirrors `Cloud_ReadMemoryStoreQueueItems`.
|
|
61
|
+
*
|
|
62
|
+
* @since 0.1.0
|
|
63
|
+
*/
|
|
66
64
|
interface DequeueQueueItemsParameters {
|
|
67
65
|
/**
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
66
|
+
* If `true`, the server returns 404 when fewer than `count` items
|
|
67
|
+
* are available. Defaults to `false`, in which case the server
|
|
68
|
+
* returns whatever subset is currently at the front of the queue.
|
|
69
|
+
*/
|
|
72
70
|
readonly allOrNothing?: boolean;
|
|
73
71
|
/**
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
72
|
+
* Number of items to read from the front of the queue. Defaults to
|
|
73
|
+
* `1`; values above `200` are clamped server-side.
|
|
74
|
+
*/
|
|
77
75
|
readonly count?: number;
|
|
78
76
|
/**
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
77
|
+
* Number of seconds the dequeued items remain invisible to
|
|
78
|
+
* subsequent reads. Items not acknowledged via `discard` reappear
|
|
79
|
+
* once the window elapses. Defaults to `30` seconds server-side.
|
|
80
|
+
*/
|
|
83
81
|
readonly invisibilityWindow?: number;
|
|
84
82
|
/** Stringified queue identifier. */
|
|
85
83
|
readonly queueId: string;
|
|
@@ -87,31 +85,31 @@ interface DequeueQueueItemsParameters {
|
|
|
87
85
|
readonly universeId: string;
|
|
88
86
|
}
|
|
89
87
|
/**
|
|
90
|
-
* Parsed result of a successful `Cloud_ReadMemoryStoreQueueItems`
|
|
91
|
-
* response. The `readId` value must be passed to a subsequent
|
|
92
|
-
* `discard` call to acknowledge the items; otherwise the items reappear
|
|
93
|
-
* once the invisibility window elapses.
|
|
94
|
-
*
|
|
95
|
-
* @since 0.1.0
|
|
96
|
-
*/
|
|
88
|
+
* Parsed result of a successful `Cloud_ReadMemoryStoreQueueItems`
|
|
89
|
+
* response. The `readId` value must be passed to a subsequent
|
|
90
|
+
* `discard` call to acknowledge the items; otherwise the items reappear
|
|
91
|
+
* once the invisibility window elapses.
|
|
92
|
+
*
|
|
93
|
+
* @since 0.1.0
|
|
94
|
+
*/
|
|
97
95
|
interface DequeueResult {
|
|
98
96
|
/** Items dequeued from the front of the queue, in dequeue order. */
|
|
99
97
|
readonly items: ReadonlyArray<QueueItem>;
|
|
100
98
|
/**
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
99
|
+
* Identifier of the dequeue operation. Pass this to `discard` to
|
|
100
|
+
* remove the items from the queue permanently.
|
|
101
|
+
*/
|
|
104
102
|
readonly readId: string;
|
|
105
103
|
}
|
|
106
104
|
/**
|
|
107
|
-
* Caller-supplied input for the `discard` method on
|
|
108
|
-
* `StorageClient.queues`. Mirrors `Cloud_DiscardMemoryStoreQueueItems`.
|
|
109
|
-
* Acknowledging a `readId` removes the dequeued batch from the queue
|
|
110
|
-
* permanently; without `discard`, the items reappear once their
|
|
111
|
-
* invisibility window elapses.
|
|
112
|
-
*
|
|
113
|
-
* @since 0.1.0
|
|
114
|
-
*/
|
|
105
|
+
* Caller-supplied input for the `discard` method on
|
|
106
|
+
* `StorageClient.queues`. Mirrors `Cloud_DiscardMemoryStoreQueueItems`.
|
|
107
|
+
* Acknowledging a `readId` removes the dequeued batch from the queue
|
|
108
|
+
* permanently; without `discard`, the items reappear once their
|
|
109
|
+
* invisibility window elapses.
|
|
110
|
+
*
|
|
111
|
+
* @since 0.1.0
|
|
112
|
+
*/
|
|
115
113
|
interface DiscardQueueItemsParameters {
|
|
116
114
|
/** Stringified queue identifier. */
|
|
117
115
|
readonly queueId: string;
|
|
@@ -120,16 +118,14 @@ interface DiscardQueueItemsParameters {
|
|
|
120
118
|
/** Stringified ID of the universe that owns the queue. */
|
|
121
119
|
readonly universeId: string;
|
|
122
120
|
}
|
|
123
|
-
//#endregion
|
|
124
|
-
//#region src/domains/cloud-v2/memory-store-sorted-maps/types.d.ts
|
|
125
121
|
/**
|
|
126
|
-
* Discriminated union describing a sorted-map item's sort key. The
|
|
127
|
-
* server contract requires at most one of `stringSortKey` or
|
|
128
|
-
* `numericSortKey`; the union surfaces that constraint at the type
|
|
129
|
-
* level so callers cannot accidentally set both.
|
|
130
|
-
*
|
|
131
|
-
* @since 0.1.0
|
|
132
|
-
*/
|
|
122
|
+
* Discriminated union describing a sorted-map item's sort key. The
|
|
123
|
+
* server contract requires at most one of `stringSortKey` or
|
|
124
|
+
* `numericSortKey`; the union surfaces that constraint at the type
|
|
125
|
+
* level so callers cannot accidentally set both.
|
|
126
|
+
*
|
|
127
|
+
* @since 0.1.0
|
|
128
|
+
*/
|
|
133
129
|
type SortKey = {
|
|
134
130
|
readonly kind: "numeric";
|
|
135
131
|
readonly value: number;
|
|
@@ -138,127 +134,127 @@ type SortKey = {
|
|
|
138
134
|
readonly value: string;
|
|
139
135
|
};
|
|
140
136
|
/**
|
|
141
|
-
* Caller-supplied input for the `create` method on
|
|
142
|
-
* `StorageClient.sortedMaps`. Mirrors
|
|
143
|
-
* `Cloud_CreateMemoryStoreSortedMapItem` on the Open Cloud API.
|
|
144
|
-
*
|
|
145
|
-
* @since 0.1.0
|
|
146
|
-
*/
|
|
137
|
+
* Caller-supplied input for the `create` method on
|
|
138
|
+
* `StorageClient.sortedMaps`. Mirrors
|
|
139
|
+
* `Cloud_CreateMemoryStoreSortedMapItem` on the Open Cloud API.
|
|
140
|
+
*
|
|
141
|
+
* @since 0.1.0
|
|
142
|
+
*/
|
|
147
143
|
interface CreateSortedMapItemParameters {
|
|
148
144
|
/**
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
145
|
+
* Caller-supplied item identifier. The server stores items
|
|
146
|
+
* case-sensitively; the value is URL-encoded by the builder.
|
|
147
|
+
*/
|
|
152
148
|
readonly itemId: string;
|
|
153
149
|
/** Stringified sorted-map identifier. */
|
|
154
150
|
readonly mapId: string;
|
|
155
151
|
/** Optional sort key driving the item's position in the map. */
|
|
156
152
|
readonly sortKey?: SortKey;
|
|
157
153
|
/**
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
154
|
+
* Optional time-to-live in seconds. After this many seconds the
|
|
155
|
+
* item is automatically removed. Omitted entries inherit the
|
|
156
|
+
* server-default TTL.
|
|
157
|
+
*/
|
|
162
158
|
readonly ttl?: number;
|
|
163
159
|
/** Stringified ID of the universe that owns the sorted map. */
|
|
164
160
|
readonly universeId: string;
|
|
165
161
|
/**
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
162
|
+
* Opaque item payload. May be any JSON value, including `null`,
|
|
163
|
+
* matching the protobuf `Value` contract on the wire.
|
|
164
|
+
*/
|
|
169
165
|
readonly value: JSONValue;
|
|
170
166
|
}
|
|
171
167
|
/**
|
|
172
|
-
* Caller-supplied input for the `list` method on
|
|
173
|
-
* `StorageClient.sortedMaps`. Mirrors
|
|
174
|
-
* `Cloud_ListMemoryStoreSortedMapItems` on the Open Cloud API. All
|
|
175
|
-
* paging and filtering parameters are optional; omitting them returns
|
|
176
|
-
* up to one item server-side (`maxPageSize` defaults to `1`).
|
|
177
|
-
*
|
|
178
|
-
* @since 0.1.0
|
|
179
|
-
*/
|
|
168
|
+
* Caller-supplied input for the `list` method on
|
|
169
|
+
* `StorageClient.sortedMaps`. Mirrors
|
|
170
|
+
* `Cloud_ListMemoryStoreSortedMapItems` on the Open Cloud API. All
|
|
171
|
+
* paging and filtering parameters are optional; omitting them returns
|
|
172
|
+
* up to one item server-side (`maxPageSize` defaults to `1`).
|
|
173
|
+
*
|
|
174
|
+
* @since 0.1.0
|
|
175
|
+
*/
|
|
180
176
|
interface ListSortedMapItemsParameters {
|
|
181
177
|
/**
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
178
|
+
* Optional CEL filter on `id` and `sortKey`. The server supports
|
|
179
|
+
* `<`, `>`, and `&&` operators only; other operators are rejected
|
|
180
|
+
* server-side with a validation error.
|
|
181
|
+
*/
|
|
186
182
|
readonly filter?: string;
|
|
187
183
|
/** Stringified sorted-map identifier. */
|
|
188
184
|
readonly mapId: string;
|
|
189
185
|
/**
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
186
|
+
* Maximum items per page. Capped at `100` server-side; values above
|
|
187
|
+
* the cap are clamped. Defaults to `1` when omitted.
|
|
188
|
+
*/
|
|
193
189
|
readonly maxPageSize?: number;
|
|
194
190
|
/**
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
191
|
+
* Sort order. The server supports the `id` field only, with an
|
|
192
|
+
* optional ` desc` suffix.
|
|
193
|
+
*/
|
|
198
194
|
readonly orderBy?: string;
|
|
199
195
|
/**
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
196
|
+
* Page token returned by a previous call. When supplied, all other
|
|
197
|
+
* parameters must match the previous call exactly.
|
|
198
|
+
*/
|
|
203
199
|
readonly pageToken?: string;
|
|
204
200
|
/** Stringified ID of the universe that owns the sorted map. */
|
|
205
201
|
readonly universeId: string;
|
|
206
202
|
}
|
|
207
203
|
/**
|
|
208
|
-
* Parsed representation of a sorted-map item, as returned by every
|
|
209
|
-
* sorted-map operation that yields a single item.
|
|
210
|
-
*
|
|
211
|
-
* @since 0.1.0
|
|
212
|
-
*/
|
|
204
|
+
* Parsed representation of a sorted-map item, as returned by every
|
|
205
|
+
* sorted-map operation that yields a single item.
|
|
206
|
+
*
|
|
207
|
+
* @since 0.1.0
|
|
208
|
+
*/
|
|
213
209
|
interface SortedMapItem {
|
|
214
210
|
/** Item identifier, parsed from the wire `path`. */
|
|
215
211
|
readonly id: string;
|
|
216
212
|
/**
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
213
|
+
* Server-generated etag for optimistic concurrency. Surfaced for
|
|
214
|
+
* caller inspection; the SDK does not yet emit an `If-Match` header
|
|
215
|
+
* for conditional update or delete.
|
|
216
|
+
*/
|
|
221
217
|
readonly etag: string;
|
|
222
218
|
/** Timestamp at which the server removes the item from the map. */
|
|
223
219
|
readonly expiresAt: Date;
|
|
224
220
|
/** Stringified sorted-map identifier, parsed from the wire `path`. */
|
|
225
221
|
readonly mapId: string;
|
|
226
222
|
/**
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
223
|
+
* Parsed sort key, or `undefined` when the item has none. The server
|
|
224
|
+
* contract is one-of: a response carrying both `stringSortKey` and
|
|
225
|
+
* `numericSortKey` is rejected as malformed.
|
|
226
|
+
*/
|
|
231
227
|
readonly sortKey: SortKey | undefined;
|
|
232
228
|
/** Stringified universe identifier, parsed from the wire `path`. */
|
|
233
229
|
readonly universeId: string;
|
|
234
230
|
/**
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
231
|
+
* Opaque item payload. Round-trips as JSON, including nested `null`
|
|
232
|
+
* values inside objects and arrays, and `null` at the top level.
|
|
233
|
+
*/
|
|
238
234
|
readonly value: JSONValue;
|
|
239
235
|
}
|
|
240
236
|
/**
|
|
241
|
-
* Parsed result of a successful `Cloud_ListMemoryStoreSortedMapItems`
|
|
242
|
-
* response.
|
|
243
|
-
*
|
|
244
|
-
* @since 0.1.0
|
|
245
|
-
*/
|
|
237
|
+
* Parsed result of a successful `Cloud_ListMemoryStoreSortedMapItems`
|
|
238
|
+
* response.
|
|
239
|
+
*
|
|
240
|
+
* @since 0.1.0
|
|
241
|
+
*/
|
|
246
242
|
interface ListSortedMapItemsResult {
|
|
247
243
|
/** Items returned in the current page, ordered per `orderBy`. */
|
|
248
244
|
readonly items: ReadonlyArray<SortedMapItem>;
|
|
249
245
|
/**
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
246
|
+
* Page token for the next call, or `undefined` when no more pages
|
|
247
|
+
* exist. Pass back through `pageToken` to retrieve the next page.
|
|
248
|
+
*/
|
|
253
249
|
readonly nextPageToken: string | undefined;
|
|
254
250
|
}
|
|
255
251
|
/**
|
|
256
|
-
* Caller-supplied input for the `delete` method on
|
|
257
|
-
* `StorageClient.sortedMaps`. Mirrors
|
|
258
|
-
* `Cloud_DeleteMemoryStoreSortedMapItem` on the Open Cloud API.
|
|
259
|
-
*
|
|
260
|
-
* @since 0.1.0
|
|
261
|
-
*/
|
|
252
|
+
* Caller-supplied input for the `delete` method on
|
|
253
|
+
* `StorageClient.sortedMaps`. Mirrors
|
|
254
|
+
* `Cloud_DeleteMemoryStoreSortedMapItem` on the Open Cloud API.
|
|
255
|
+
*
|
|
256
|
+
* @since 0.1.0
|
|
257
|
+
*/
|
|
262
258
|
interface DeleteSortedMapItemParameters {
|
|
263
259
|
/** Caller-supplied item identifier. URL-encoded by the builder. */
|
|
264
260
|
readonly itemId: string;
|
|
@@ -268,12 +264,12 @@ interface DeleteSortedMapItemParameters {
|
|
|
268
264
|
readonly universeId: string;
|
|
269
265
|
}
|
|
270
266
|
/**
|
|
271
|
-
* Caller-supplied input for the `get` method on
|
|
272
|
-
* `StorageClient.sortedMaps`. Mirrors
|
|
273
|
-
* `Cloud_GetMemoryStoreSortedMapItem` on the Open Cloud API.
|
|
274
|
-
*
|
|
275
|
-
* @since 0.1.0
|
|
276
|
-
*/
|
|
267
|
+
* Caller-supplied input for the `get` method on
|
|
268
|
+
* `StorageClient.sortedMaps`. Mirrors
|
|
269
|
+
* `Cloud_GetMemoryStoreSortedMapItem` on the Open Cloud API.
|
|
270
|
+
*
|
|
271
|
+
* @since 0.1.0
|
|
272
|
+
*/
|
|
277
273
|
interface GetSortedMapItemParameters {
|
|
278
274
|
/** Caller-supplied item identifier. URL-encoded by the builder. */
|
|
279
275
|
readonly itemId: string;
|
|
@@ -283,253 +279,246 @@ interface GetSortedMapItemParameters {
|
|
|
283
279
|
readonly universeId: string;
|
|
284
280
|
}
|
|
285
281
|
/**
|
|
286
|
-
* Caller-supplied input for the `update` method on
|
|
287
|
-
* `StorageClient.sortedMaps`. Mirrors
|
|
288
|
-
* `Cloud_UpdateMemoryStoreSortedMapItem` on the Open Cloud API. Body
|
|
289
|
-
* fields (`value`, `ttl`, `sortKey`) are optional under PATCH
|
|
290
|
-
* semantics; omitted fields are left unchanged on the server.
|
|
291
|
-
*
|
|
292
|
-
* @since 0.1.0
|
|
293
|
-
*/
|
|
282
|
+
* Caller-supplied input for the `update` method on
|
|
283
|
+
* `StorageClient.sortedMaps`. Mirrors
|
|
284
|
+
* `Cloud_UpdateMemoryStoreSortedMapItem` on the Open Cloud API. Body
|
|
285
|
+
* fields (`value`, `ttl`, `sortKey`) are optional under PATCH
|
|
286
|
+
* semantics; omitted fields are left unchanged on the server.
|
|
287
|
+
*
|
|
288
|
+
* @since 0.1.0
|
|
289
|
+
*/
|
|
294
290
|
interface UpdateSortedMapItemParameters {
|
|
295
291
|
/**
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
292
|
+
* When `true`, the server creates the item if it does not exist
|
|
293
|
+
* instead of returning 404. Travels as the `allowMissing` query
|
|
294
|
+
* string parameter.
|
|
295
|
+
*/
|
|
300
296
|
readonly allowMissing?: boolean;
|
|
301
297
|
/** Caller-supplied item identifier. URL-encoded by the builder. */
|
|
302
298
|
readonly itemId: string;
|
|
303
299
|
/** Stringified sorted-map identifier. */
|
|
304
300
|
readonly mapId: string;
|
|
305
301
|
/**
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
302
|
+
* Replacement sort key. Either kind of {@link SortKey} resets the
|
|
303
|
+
* field on the wire; omit the field to leave the existing sort key
|
|
304
|
+
* untouched.
|
|
305
|
+
*/
|
|
310
306
|
readonly sortKey?: SortKey;
|
|
311
307
|
/**
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
308
|
+
* Replacement time-to-live in seconds. Omitted entries leave the
|
|
309
|
+
* existing TTL unchanged.
|
|
310
|
+
*/
|
|
315
311
|
readonly ttl?: number;
|
|
316
312
|
/** Stringified ID of the universe that owns the sorted map. */
|
|
317
313
|
readonly universeId: string;
|
|
318
314
|
/**
|
|
319
|
-
|
|
320
|
-
|
|
315
|
+
* Replacement value. Omitted entries leave the existing value unchanged.
|
|
316
|
+
*/
|
|
321
317
|
readonly value?: JSONValue;
|
|
322
318
|
}
|
|
323
|
-
//#endregion
|
|
324
|
-
//#region src/resources/storage/queues-group.d.ts
|
|
325
319
|
/**
|
|
326
|
-
* Operation Group on `StorageClient` that exposes the memory-store
|
|
327
|
-
* queue endpoints. Queues are FIFO collections of opaque JSON values
|
|
328
|
-
* with optional priority and TTL; consumers enqueue items, dequeue
|
|
329
|
-
* them in batches, and acknowledge processed batches with a read
|
|
330
|
-
* identifier.
|
|
331
|
-
*/
|
|
320
|
+
* Operation Group on `StorageClient` that exposes the memory-store
|
|
321
|
+
* queue endpoints. Queues are FIFO collections of opaque JSON values
|
|
322
|
+
* with optional priority and TTL; consumers enqueue items, dequeue
|
|
323
|
+
* them in batches, and acknowledge processed batches with a read
|
|
324
|
+
* identifier.
|
|
325
|
+
*/
|
|
332
326
|
declare class MemoryStoreQueuesGroup {
|
|
333
327
|
#private;
|
|
334
328
|
/**
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
329
|
+
* Wraps the shared {@link ResourceClient} so the Operation Group
|
|
330
|
+
* routes calls through the same retry, hooks, and rate-limit queues
|
|
331
|
+
* as the rest of the parent client.
|
|
332
|
+
*
|
|
333
|
+
* @param inner - The shared {@link ResourceClient} owned by the
|
|
334
|
+
* parent client.
|
|
335
|
+
*/
|
|
342
336
|
constructor(inner: ResourceClient);
|
|
343
337
|
/**
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
338
|
+
* Dequeues up to `count` items from the front of the queue. Items
|
|
339
|
+
* returned become invisible to subsequent reads for
|
|
340
|
+
* `invisibilityWindow` seconds (default 30 server-side); they
|
|
341
|
+
* reappear once the window elapses unless acknowledged via
|
|
342
|
+
* `discard` with the returned `readId`.
|
|
343
|
+
*
|
|
344
|
+
* On 5xx, dequeue does not retry: the server may have set
|
|
345
|
+
* invisibility on a batch before the response failed, so a retry
|
|
346
|
+
* would return a *different* batch and the first one is lost until
|
|
347
|
+
* the window expires. Callers that can detect duplicates externally
|
|
348
|
+
* may opt back into 5xx retry per call by passing `retryableStatuses`
|
|
349
|
+
* on `options`.
|
|
350
|
+
*
|
|
351
|
+
* @param parameters - Universe and queue identifiers, plus optional
|
|
352
|
+
* `count`, `allOrNothing`, and `invisibilityWindow`.
|
|
353
|
+
* @param options - Optional per-request overrides.
|
|
354
|
+
* @returns A {@link Result} wrapping the parsed {@link DequeueResult}
|
|
355
|
+
* or the {@link OpenCloudError} that caused the request to fail.
|
|
356
|
+
*/
|
|
363
357
|
dequeue(parameters: DequeueQueueItemsParameters, options?: RequestOptions): Promise<Result<DequeueResult, OpenCloudError>>;
|
|
364
358
|
/**
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
359
|
+
* Acknowledges a dequeued batch of items, removing them from the
|
|
360
|
+
* queue permanently. Pass the `readId` returned from the prior
|
|
361
|
+
* `dequeue` call. Without `discard`, the items reappear once the
|
|
362
|
+
* invisibility window elapses.
|
|
363
|
+
*
|
|
364
|
+
* The call is idempotent: a second `discard` with the same `readId`
|
|
365
|
+
* is a no-op once the batch has been acknowledged. The retry policy
|
|
366
|
+
* therefore retries both 429 and 5xx.
|
|
367
|
+
*
|
|
368
|
+
* @param parameters - Universe and queue identifiers, plus the
|
|
369
|
+
* `readId` returned from a prior dequeue.
|
|
370
|
+
* @param options - Optional per-request overrides.
|
|
371
|
+
* @returns A {@link Result} wrapping `undefined` on success (the
|
|
372
|
+
* server returns an empty body) or the {@link OpenCloudError}
|
|
373
|
+
* that caused the request to fail.
|
|
374
|
+
*/
|
|
381
375
|
discard(parameters: DiscardQueueItemsParameters, options?: RequestOptions): Promise<Result<undefined, OpenCloudError>>;
|
|
382
376
|
/**
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
377
|
+
* Enqueues a single item onto a memory-store queue. The queue is
|
|
378
|
+
* auto-created on first use; the queue identifier is any string the
|
|
379
|
+
* caller picks. Items with higher `priority` values are dequeued
|
|
380
|
+
* first; equal priorities preserve insertion order. Items expire
|
|
381
|
+
* and are removed automatically after `ttl` seconds, or after a
|
|
382
|
+
* server-default lifetime when omitted.
|
|
383
|
+
*
|
|
384
|
+
* @param parameters - Universe and queue identifiers, the opaque
|
|
385
|
+
* payload, and optional `priority` and `ttl`.
|
|
386
|
+
* @param options - Optional per-request overrides (e.g. A different
|
|
387
|
+
* {@link OpenCloudClientOptions.credential} for this call only).
|
|
388
|
+
* @returns A {@link Result} wrapping the parsed {@link QueueItem} or
|
|
389
|
+
* the {@link OpenCloudError} that caused the request to fail.
|
|
390
|
+
*/
|
|
397
391
|
enqueue(parameters: EnqueueQueueItemParameters, options?: RequestOptions): Promise<Result<QueueItem, OpenCloudError>>;
|
|
398
392
|
}
|
|
399
|
-
//#endregion
|
|
400
|
-
//#region src/resources/storage/sorted-maps-group.d.ts
|
|
401
393
|
/**
|
|
402
|
-
* Operation Group on `StorageClient` that exposes the memory-store
|
|
403
|
-
* sorted-map endpoints. Sorted maps are ordered collections of
|
|
404
|
-
* (id, value, sortKey) triples; consumers create, read, update, list,
|
|
405
|
-
* and delete items keyed by a caller-supplied identifier and ordered
|
|
406
|
-
* by an optional string or numeric sort key.
|
|
407
|
-
*/
|
|
394
|
+
* Operation Group on `StorageClient` that exposes the memory-store
|
|
395
|
+
* sorted-map endpoints. Sorted maps are ordered collections of
|
|
396
|
+
* (id, value, sortKey) triples; consumers create, read, update, list,
|
|
397
|
+
* and delete items keyed by a caller-supplied identifier and ordered
|
|
398
|
+
* by an optional string or numeric sort key.
|
|
399
|
+
*/
|
|
408
400
|
declare class MemoryStoreSortedMapsGroup {
|
|
409
401
|
#private;
|
|
410
402
|
/**
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
403
|
+
* Wraps the shared {@link ResourceClient} so the Operation Group
|
|
404
|
+
* routes calls through the same retry, hooks, and rate-limit queues
|
|
405
|
+
* as the rest of the parent client.
|
|
406
|
+
*
|
|
407
|
+
* @param inner - The shared {@link ResourceClient} owned by the
|
|
408
|
+
* parent client.
|
|
409
|
+
*/
|
|
418
410
|
constructor(inner: ResourceClient);
|
|
419
411
|
/**
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
412
|
+
* Creates a single item in a sorted map. The sorted map is
|
|
413
|
+
* auto-created on first use; the map identifier is any string the
|
|
414
|
+
* caller picks. Items are keyed by `itemId` (case-sensitive) and
|
|
415
|
+
* ordered by an optional `sortKey`. Items expire and are removed
|
|
416
|
+
* automatically after `ttl` seconds, or after a server-default
|
|
417
|
+
* lifetime when omitted.
|
|
418
|
+
*
|
|
419
|
+
* On 5xx, create does not retry: Roblox Open Cloud has no
|
|
420
|
+
* idempotency-key support, so a retry of a transient failure risks
|
|
421
|
+
* producing a duplicate item.
|
|
422
|
+
*
|
|
423
|
+
* @param parameters - Universe, sorted-map, item identifiers, the
|
|
424
|
+
* value to store, and optional `sortKey` and `ttl`.
|
|
425
|
+
* @param options - Optional per-request overrides (e.g. A different
|
|
426
|
+
* {@link OpenCloudClientOptions.credential} for this call only).
|
|
427
|
+
* @returns A {@link Result} wrapping the parsed {@link SortedMapItem}
|
|
428
|
+
* or the {@link OpenCloudError} that caused the request to fail.
|
|
429
|
+
*/
|
|
438
430
|
create(parameters: CreateSortedMapItemParameters, options?: RequestOptions): Promise<Result<SortedMapItem, OpenCloudError>>;
|
|
439
431
|
/**
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
432
|
+
* Removes a single item from a sorted map. The call is idempotent:
|
|
433
|
+
* a second `delete` against the same item is a no-op once the
|
|
434
|
+
* server has dropped the row. The retry policy retries both 429
|
|
435
|
+
* and 5xx.
|
|
436
|
+
*
|
|
437
|
+
* @param parameters - Universe, sorted-map, and item identifiers.
|
|
438
|
+
* @param options - Optional per-request overrides.
|
|
439
|
+
* @returns A {@link Result} wrapping `undefined` on success or the
|
|
440
|
+
* {@link OpenCloudError} that caused the request to fail.
|
|
441
|
+
*/
|
|
450
442
|
delete(parameters: DeleteSortedMapItemParameters, options?: RequestOptions): Promise<Result<undefined, OpenCloudError>>;
|
|
451
443
|
/**
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
444
|
+
* Reads a single item from a sorted map. Returns the parsed
|
|
445
|
+
* {@link SortedMapItem} with the server-recorded `etag` for use in
|
|
446
|
+
* subsequent conditional updates (once the SDK begins emitting
|
|
447
|
+
* `If-Match`; see the package README).
|
|
448
|
+
*
|
|
449
|
+
* @param parameters - Universe, sorted-map, and item identifiers.
|
|
450
|
+
* @param options - Optional per-request overrides.
|
|
451
|
+
* @returns A {@link Result} wrapping the parsed {@link SortedMapItem}
|
|
452
|
+
* or the {@link OpenCloudError} that caused the request to fail.
|
|
453
|
+
*/
|
|
462
454
|
get(parameters: GetSortedMapItemParameters, options?: RequestOptions): Promise<Result<SortedMapItem, OpenCloudError>>;
|
|
463
455
|
/**
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
456
|
+
* Lists items in a sorted map. The server caps `maxPageSize` at
|
|
457
|
+
* `100` and defaults it to `1` when omitted, so callers explicitly
|
|
458
|
+
* pass `maxPageSize` to retrieve more than a single item per page.
|
|
459
|
+
* The `filter` parameter accepts a CEL expression on `id` and
|
|
460
|
+
* `sortKey` (operators `<`, `>`, `&&` only).
|
|
461
|
+
*
|
|
462
|
+
* @param parameters - Universe and sorted-map identifiers, plus
|
|
463
|
+
* optional pagination and filter parameters.
|
|
464
|
+
* @param options - Optional per-request overrides.
|
|
465
|
+
* @returns A {@link Result} wrapping the parsed
|
|
466
|
+
* {@link ListSortedMapItemsResult} or the {@link OpenCloudError}
|
|
467
|
+
* that caused the request to fail.
|
|
468
|
+
*/
|
|
477
469
|
list(parameters: ListSortedMapItemsParameters, options?: RequestOptions): Promise<Result<ListSortedMapItemsResult, OpenCloudError>>;
|
|
478
470
|
/**
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
471
|
+
* Updates a sorted-map item under PATCH semantics: omitted body
|
|
472
|
+
* fields are left unchanged on the server, supplied fields replace
|
|
473
|
+
* their existing values. Passing `allowMissing: true` creates the
|
|
474
|
+
* item when no row exists instead of returning 404.
|
|
475
|
+
*
|
|
476
|
+
* Retries 5xx because PATCH with the same body produces the same
|
|
477
|
+
* server state.
|
|
478
|
+
*
|
|
479
|
+
* @param parameters - Universe, sorted-map, and item identifiers,
|
|
480
|
+
* plus any subset of `value`, `ttl`, `sortKey`, and
|
|
481
|
+
* `allowMissing`.
|
|
482
|
+
* @param options - Optional per-request overrides.
|
|
483
|
+
* @returns A {@link Result} wrapping the parsed {@link SortedMapItem}
|
|
484
|
+
* or the {@link OpenCloudError} that caused the request to fail.
|
|
485
|
+
*/
|
|
494
486
|
update(parameters: UpdateSortedMapItemParameters, options?: RequestOptions): Promise<Result<SortedMapItem, OpenCloudError>>;
|
|
495
487
|
}
|
|
496
|
-
//#endregion
|
|
497
|
-
//#region src/resources/storage/client.d.ts
|
|
498
488
|
/**
|
|
499
|
-
* Public client for the Roblox Open Cloud `Data and memory stores`
|
|
500
|
-
* Feature. Today it covers memory-store queues via the
|
|
501
|
-
* {@link StorageClient.queues} Operation Group and memory-store sorted
|
|
502
|
-
* maps via the {@link StorageClient.sortedMaps} Operation Group; a
|
|
503
|
-
* future data-stores Operation Group slots in as a sibling on the same
|
|
504
|
-
* client.
|
|
505
|
-
*
|
|
506
|
-
* Every method returns a `Result` so callers handle failure
|
|
507
|
-
* explicitly; no thrown error ever escapes the client.
|
|
508
|
-
*
|
|
509
|
-
* @since 0.1.0
|
|
510
|
-
*
|
|
511
|
-
* @example
|
|
512
|
-
*
|
|
513
|
-
* ```ts
|
|
514
|
-
* import { StorageClient } from "@bedrock-rbx/ocale/storage";
|
|
515
|
-
*
|
|
516
|
-
* const client = new StorageClient({ apiKey: "your-key" });
|
|
517
|
-
* expect(client).toBeInstanceOf(StorageClient);
|
|
518
|
-
* ```
|
|
519
|
-
*/
|
|
520
|
-
declare class StorageClient {
|
|
489
|
+
* Public client for the Roblox Open Cloud `Data and memory stores`
|
|
490
|
+
* Feature. Today it covers memory-store queues via the
|
|
491
|
+
* {@link StorageClient.queues} Operation Group and memory-store sorted
|
|
492
|
+
* maps via the {@link StorageClient.sortedMaps} Operation Group; a
|
|
493
|
+
* future data-stores Operation Group slots in as a sibling on the same
|
|
494
|
+
* client.
|
|
495
|
+
*
|
|
496
|
+
* Every method returns a `Result` so callers handle failure
|
|
497
|
+
* explicitly; no thrown error ever escapes the client.
|
|
498
|
+
*
|
|
499
|
+
* @since 0.1.0
|
|
500
|
+
*
|
|
501
|
+
* @example
|
|
502
|
+
*
|
|
503
|
+
* ```ts
|
|
504
|
+
* import { StorageClient } from "@bedrock-rbx/ocale/storage";
|
|
505
|
+
*
|
|
506
|
+
* const client = new StorageClient({ credential: { apiKey: "your-key", kind: "apiKey" } });
|
|
507
|
+
* expect(client).toBeInstanceOf(StorageClient);
|
|
508
|
+
* ```
|
|
509
|
+
*/
|
|
510
|
+
export declare class StorageClient {
|
|
521
511
|
/** Memory-store queue Operation Group. */
|
|
522
512
|
readonly queues: MemoryStoreQueuesGroup;
|
|
523
513
|
/** Memory-store sorted-map Operation Group. */
|
|
524
514
|
readonly sortedMaps: MemoryStoreSortedMapsGroup;
|
|
525
515
|
/**
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
516
|
+
* Creates a new {@link StorageClient}. Configuration is frozen on
|
|
517
|
+
* construction; per-request overrides are accepted on each method.
|
|
518
|
+
*
|
|
519
|
+
* @param options - Client-level configuration including the API key.
|
|
520
|
+
*/
|
|
531
521
|
constructor(options: OpenCloudClientOptions);
|
|
532
522
|
}
|
|
533
|
-
|
|
534
|
-
export { type CreateSortedMapItemParameters, type DeleteSortedMapItemParameters, type DequeueQueueItemsParameters, type DequeueResult, type DiscardQueueItemsParameters, type EnqueueQueueItemParameters, type GetSortedMapItemParameters, type ListSortedMapItemsParameters, type ListSortedMapItemsResult, type QueueItem, type SortKey, type SortedMapItem, StorageClient, type UpdateSortedMapItemParameters };
|
|
523
|
+
export type { CreateSortedMapItemParameters, DeleteSortedMapItemParameters, DequeueQueueItemsParameters, DequeueResult, DiscardQueueItemsParameters, EnqueueQueueItemParameters, GetSortedMapItemParameters, ListSortedMapItemsParameters, ListSortedMapItemsResult, QueueItem, SortKey, SortedMapItem, UpdateSortedMapItemParameters };
|
|
535
524
|
//# sourceMappingURL=storage.d.mts.map
|