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