@bedrock-rbx/ocale 0.1.0-beta.1 → 0.1.0-beta.2

package/dist/storage.mjs

@@ -0,0 +1,371 @@
+import { i as ApiError } from "./rate-limit-CKfuhxT1.mjs";
+import { t as isDateTimeString } from "./is-date-time-string-Cuf1TaSC.mjs";
+import { a as IDEMPOTENT_METHOD_DEFAULTS, i as CREATE_METHOD_DEFAULTS, n as okRequest, o as isRecord, r as parseEmptyResponse, t as ResourceClient } from "./resource-client-Wi4Mwqy5.mjs";
+//#region src/domains/cloud-v2/memory-store-queues/builders.ts
+/**
+* Builds a `POST` request for the Open Cloud
+* `Cloud_CreateMemoryStoreQueueItem` endpoint. Serializes the optional
+* `ttl` field as a Google protobuf `Duration` string in seconds (`"30s"`)
+* to match the wire contract.
+*
+* @param parameters - Universe and queue identifiers, the opaque payload,
+*   and optional priority and TTL.
+* @returns A pure {@link HttpRequest} describing the enqueue call.
+*/
+function buildEnqueueRequest(parameters) {
+	const { data, priority, queueId, ttl, universeId } = parameters;
+	const body = { data };
+	if (priority !== void 0) body["priority"] = priority;
+	if (ttl !== void 0) body["ttl"] = `${ttl}s`;
+	return {
+		body,
+		headers: { "content-type": "application/json" },
+		method: "POST",
+		url: `/cloud/v2/universes/${universeId}/memory-store/queues/${queueId}/items`
+	};
+}
+/**
+* Builds a `GET` request for the Open Cloud
+* `Cloud_ReadMemoryStoreQueueItems` endpoint. The `:read` suffix is a
+* custom-method marker; the call is HTTP `GET` despite the AIP-136
+* convention that custom methods use `POST`. Parameters travel as query
+* string only; there is no request body.
+*
+* `invisibilityWindow` is serialized as a Google protobuf `Duration`
+* string in seconds (`"30s"`), matching the wire contract.
+*
+* @param parameters - Universe and queue identifiers, plus optional
+*   `count`, `allOrNothing`, and `invisibilityWindow`.
+* @returns A pure {@link HttpRequest} describing the dequeue call.
+*/
+function buildDequeueRequest(parameters) {
+	const query = new URLSearchParams();
+	if (parameters.count !== void 0) query.append("count", String(parameters.count));
+	if (parameters.allOrNothing !== void 0) query.append("allOrNothing", String(parameters.allOrNothing));
+	if (parameters.invisibilityWindow !== void 0) query.append("invisibilityWindow", `${parameters.invisibilityWindow}s`);
+	const queryString = query.toString();
+	const { queueId, universeId } = parameters;
+	const base = `/cloud/v2/universes/${universeId}/memory-store/queues/${queueId}/items:read`;
+	return {
+		method: "GET",
+		url: queryString === "" ? base : `${base}?${queryString}`
+	};
+}
+/**
+* Builds a `POST` request for the Open Cloud
+* `Cloud_DiscardMemoryStoreQueueItems` endpoint. The request body uses
+* `{ readId }`, matching the schema (the dequeue *response* uses `id`,
+* but the discard *request* matches the schema and is not patched).
+*
+* @param parameters - Universe and queue identifiers, plus the
+*   `readId` returned from a prior dequeue.
+* @returns A pure {@link HttpRequest} describing the discard call.
+*/
+function buildDiscardRequest(parameters) {
+	const { queueId, readId, universeId } = parameters;
+	return {
+		body: { readId },
+		headers: { "content-type": "application/json" },
+		method: "POST",
+		url: `/cloud/v2/universes/${universeId}/memory-store/queues/${queueId}/items:discard`
+	};
+}
+//#endregion
+//#region src/domains/cloud-v2/memory-store-queues/operations.ts
+const ENQUEUE_PER_MINUTE = 1e6;
+const SECONDS_PER_MINUTE = 60;
+/**
+* Per-second request ceiling for enqueueing a memory-store queue item,
+* from the Open Cloud OpenAPI schema (1,000,000 requests per minute per
+* API key owner). Keyed independently from the dequeue and discard
+* operations so the three do not share a queue; upstream quota
+* accounting is documented per-operation, and the conservative default
+* is fewer cross-method contention surprises.
+*/
+const ENQUEUE_OPERATION_LIMIT = Object.freeze({
+	maxPerSecond: ENQUEUE_PER_MINUTE / SECONDS_PER_MINUTE,
+	operationKey: "memory-store-queues.enqueue"
+});
+/**
+* Scopes required to enqueue a memory-store queue item, sourced from
+* `x-roblox-scopes` on the `Cloud_CreateMemoryStoreQueueItem` operation
+* in the vendored OpenAPI schema.
+*/
+const ENQUEUE_REQUIRED_SCOPES = Object.freeze(["memory-store.queue:add"]);
+/**
+* Per-second request ceiling for dequeueing memory-store queue items,
+* from the Open Cloud OpenAPI schema (1,000,000 requests per minute
+* per API key owner). Keyed independently from enqueue and discard.
+*/
+const DEQUEUE_OPERATION_LIMIT = Object.freeze({
+	maxPerSecond: 1e6 / SECONDS_PER_MINUTE,
+	operationKey: "memory-store-queues.dequeue"
+});
+/**
+* Scopes required to dequeue memory-store queue items, sourced from
+* `x-roblox-scopes` on the `Cloud_ReadMemoryStoreQueueItems` operation
+* in the vendored OpenAPI schema.
+*/
+const DEQUEUE_REQUIRED_SCOPES = Object.freeze(["memory-store.queue:dequeue"]);
+/**
+* Per-second request ceiling for discarding (acknowledging) memory-store
+* queue items, from the Open Cloud OpenAPI schema (1,000,000 requests
+* per minute per API key owner). Keyed independently from enqueue and
+* dequeue.
+*/
+const DISCARD_OPERATION_LIMIT = Object.freeze({
+	maxPerSecond: 1e6 / SECONDS_PER_MINUTE,
+	operationKey: "memory-store-queues.discard"
+});
+/**
+* Scopes required to discard memory-store queue items, sourced from
+* `x-roblox-scopes` on the `Cloud_DiscardMemoryStoreQueueItems`
+* operation in the vendored OpenAPI schema.
+*/
+const DISCARD_REQUIRED_SCOPES = Object.freeze(["memory-store.queue:discard"]);
+//#endregion
+//#region src/domains/cloud-v2/memory-store-queues/parsers.ts
+const PATH_PATTERN = /^cloud\/v2\/universes\/(\d+)\/memory-store\/queues\/([^/]+)\/items\/([^/]+)$/;
+const MALFORMED_QUEUE_ITEM_MESSAGE = "Malformed memory-store queue item response";
+const MALFORMED_DEQUEUE_MESSAGE = "Malformed memory-store dequeue response";
+/**
+* Parses a successful memory-store queue-item response body (the
+* `Cloud_CreateMemoryStoreQueueItem` happy path) into the public
+* {@link QueueItem} shape.
+*
+* @param response - The full {@link HttpResponse} from the Open Cloud API.
+* @returns A success result wrapping the parsed {@link QueueItem}, or an
+*   {@link ApiError} when the body does not match the wire schema.
+*/
+function parseQueueItemResponse(response) {
+	const item = wireBodyToQueueItem(response.body);
+	if (item === void 0) return malformedQueueItem(response.status);
+	return {
+		data: item,
+		success: true
+	};
+}
+/**
+* Parses a successful `Cloud_ReadMemoryStoreQueueItems` response body
+* into the public {@link DequeueResult} shape. Each item in the
+* `queueItems` array is validated through the same path-and-shape
+* checks as {@link parseQueueItemResponse}; a malformed entry rejects
+* the whole response.
+*
+* @param response - The full {@link HttpResponse} from the Open Cloud API.
+* @returns A success result wrapping the parsed {@link DequeueResult},
+*   or an {@link ApiError} when the response shape is wrong.
+*/
+function parseDequeueResponse(response) {
+	const { body, status: statusCode } = response;
+	if (!isRecord(body)) return malformedDequeue(statusCode);
+	const { id, queueItems } = body;
+	if (typeof id !== "string" || !Array.isArray(queueItems)) return malformedDequeue(statusCode);
+	const items = queueItems.map(wireBodyToQueueItem);
+	if (!items.every(isQueueItem)) return malformedDequeue(statusCode);
+	return {
+		data: {
+			items,
+			readId: id
+		},
+		success: true
+	};
+}
+function isQueueItemWire(body) {
+	if (!isRecord(body)) return false;
+	const { data, expireTime, path, priority } = body;
+	return typeof path === "string" && isDateTimeString(expireTime) && data !== void 0 && data !== null && (priority === void 0 || priority === null || typeof priority === "number");
+}
+function wireBodyToQueueItem(body) {
+	if (!isQueueItemWire(body)) return;
+	const match = PATH_PATTERN.exec(body.path);
+	const universeId = match?.[1];
+	const queueId = match?.[2];
+	const id = match?.[3];
+	if (universeId === void 0 || queueId === void 0 || id === void 0) return;
+	return {
+		id,
+		data: body.data,
+		expiresAt: new Date(body.expireTime),
+		priority: body.priority ?? void 0,
+		queueId,
+		universeId
+	};
+}
+function malformedQueueItem(statusCode) {
+	return {
+		err: new ApiError(MALFORMED_QUEUE_ITEM_MESSAGE, { statusCode }),
+		success: false
+	};
+}
+function isQueueItem(item) {
+	return item !== void 0;
+}
+function malformedDequeue(statusCode) {
+	return {
+		err: new ApiError(MALFORMED_DEQUEUE_MESSAGE, { statusCode }),
+		success: false
+	};
+}
+//#endregion
+//#region src/resources/storage/queues-group.ts
+function makeSpec(spec) {
+	return Object.freeze(spec);
+}
+const ENQUEUE_SPEC = makeSpec({
+	buildRequest: (parameters) => okRequest(buildEnqueueRequest(parameters)),
+	methodDefaults: CREATE_METHOD_DEFAULTS,
+	methodKind: "create",
+	operationLimit: ENQUEUE_OPERATION_LIMIT,
+	parse: parseQueueItemResponse,
+	requiredScopes: ENQUEUE_REQUIRED_SCOPES
+});
+const DEQUEUE_SPEC = makeSpec({
+	buildRequest: (parameters) => okRequest(buildDequeueRequest(parameters)),
+	methodDefaults: CREATE_METHOD_DEFAULTS,
+	methodKind: "create",
+	operationLimit: DEQUEUE_OPERATION_LIMIT,
+	parse: parseDequeueResponse,
+	requiredScopes: DEQUEUE_REQUIRED_SCOPES
+});
+const DISCARD_SPEC = makeSpec({
+	buildRequest: (parameters) => okRequest(buildDiscardRequest(parameters)),
+	methodDefaults: IDEMPOTENT_METHOD_DEFAULTS,
+	methodKind: "idempotent",
+	operationLimit: DISCARD_OPERATION_LIMIT,
+	parse: parseEmptyResponse,
+	requiredScopes: DISCARD_REQUIRED_SCOPES
+});
+/**
+* Operation Group on `StorageClient` that exposes the memory-store
+* queue endpoints. Queues are FIFO collections of opaque JSON values
+* with optional priority and TTL; consumers enqueue items, dequeue
+* them in batches, and acknowledge processed batches with a read
+* identifier.
+*/
+var MemoryStoreQueuesGroup = class {
+	#inner;
+	/**
+	* Wraps the shared {@link ResourceClient} so the Operation Group
+	* routes calls through the same retry, hooks, and rate-limit queues
+	* as the rest of the parent client.
+	*
+	* @param inner - The shared {@link ResourceClient} owned by the
+	*   parent client.
+	*/
+	constructor(inner) {
+		this.#inner = inner;
+	}
+	/**
+	* Dequeues up to `count` items from the front of the queue. Items
+	* returned become invisible to subsequent reads for
+	* `invisibilityWindow` seconds (default 30 server-side); they
+	* reappear once the window elapses unless acknowledged via
+	* `discard` with the returned `readId`.
+	*
+	* On 5xx, dequeue does not retry: the server may have set
+	* invisibility on a batch before the response failed, so a retry
+	* would return a *different* batch and the first one is lost until
+	* the window expires. Callers that can detect duplicates externally
+	* may opt back into 5xx retry per call by passing `retryableStatuses`
+	* on `options`.
+	*
+	* @param parameters - Universe and queue identifiers, plus optional
+	*   `count`, `allOrNothing`, and `invisibilityWindow`.
+	* @param options - Optional per-request overrides.
+	* @returns A {@link Result} wrapping the parsed {@link DequeueResult}
+	*   or the {@link OpenCloudError} that caused the request to fail.
+	*/
+	async dequeue(parameters, options) {
+		return this.#inner.execute({
+			options,
+			parameters,
+			spec: DEQUEUE_SPEC
+		});
+	}
+	/**
+	* Acknowledges a dequeued batch of items, removing them from the
+	* queue permanently. Pass the `readId` returned from the prior
+	* `dequeue` call. Without `discard`, the items reappear once the
+	* invisibility window elapses.
+	*
+	* The call is idempotent: a second `discard` with the same `readId`
+	* is a no-op once the batch has been acknowledged. The retry policy
+	* therefore retries both 429 and 5xx.
+	*
+	* @param parameters - Universe and queue identifiers, plus the
+	*   `readId` returned from a prior dequeue.
+	* @param options - Optional per-request overrides.
+	* @returns A {@link Result} wrapping `undefined` on success (the
+	*   server returns an empty body) or the {@link OpenCloudError}
+	*   that caused the request to fail.
+	*/
+	async discard(parameters, options) {
+		return this.#inner.execute({
+			options,
+			parameters,
+			spec: DISCARD_SPEC
+		});
+	}
+	/**
+	* Enqueues a single item onto a memory-store queue. The queue is
+	* auto-created on first use; the queue identifier is any string the
+	* caller picks. Items with higher `priority` values are dequeued
+	* first; equal priorities preserve insertion order. Items expire
+	* and are removed automatically after `ttl` seconds, or after a
+	* server-default lifetime when omitted.
+	*
+	* @param parameters - Universe and queue identifiers, the opaque
+	*   payload, and optional `priority` and `ttl`.
+	* @param options - Optional per-request overrides (e.g. A different
+	*   {@link OpenCloudClientOptions.apiKey} for this call only).
+	* @returns A {@link Result} wrapping the parsed {@link QueueItem} or
+	*   the {@link OpenCloudError} that caused the request to fail.
+	*/
+	async enqueue(parameters, options) {
+		return this.#inner.execute({
+			options,
+			parameters,
+			spec: ENQUEUE_SPEC
+		});
+	}
+};
+//#endregion
+//#region src/resources/storage/client.ts
+/**
+* Public client for the Roblox Open Cloud `Data and memory stores`
+* Feature. Today it covers memory-store queues via the
+* {@link StorageClient.queues} Operation Group; future Operation
+* Groups for sorted maps and data stores slot in as siblings on the
+* same client.
+*
+* Every method returns a `Result` so callers handle failure
+* explicitly; no thrown error ever escapes the client.
+*
+* @example
+*
+* ```ts
+* import { StorageClient } from "@bedrock-rbx/ocale/storage";
+*
+* const client = new StorageClient({ apiKey: "your-key" });
+* expect(client).toBeInstanceOf(StorageClient);
+* ```
+*/
+var StorageClient = class {
+	/** Memory-store queue Operation Group. */
+	queues;
+	/**
+	* Creates a new {@link StorageClient}. Configuration is frozen on
+	* construction; per-request overrides are accepted on each method.
+	*
+	* @param options - Client-level configuration including the API key.
+	*/
+	constructor(options) {
+		const inner = new ResourceClient(options);
+		this.queues = new MemoryStoreQueuesGroup(inner);
+	}
+};
+//#endregion
+export { StorageClient };
+
+//# sourceMappingURL=storage.mjs.map

package/dist/storage.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.mjs","names":["#inner"],"sources":["../src/domains/cloud-v2/memory-store-queues/builders.ts","../src/domains/cloud-v2/memory-store-queues/operations.ts","../src/domains/cloud-v2/memory-store-queues/parsers.ts","../src/resources/storage/queues-group.ts","../src/resources/storage/client.ts"],"sourcesContent":["import type { HttpRequest } from \"../../../client/types.ts\";\nimport type {\n\tDequeueQueueItemsParameters,\n\tDiscardQueueItemsParameters,\n\tEnqueueQueueItemParameters,\n} from \"./types.ts\";\n\n/**\n * Builds a `POST` request for the Open Cloud\n * `Cloud_CreateMemoryStoreQueueItem` endpoint. Serializes the optional\n * `ttl` field as a Google protobuf `Duration` string in seconds (`\"30s\"`)\n * to match the wire contract.\n *\n * @param parameters - Universe and queue identifiers, the opaque payload,\n *   and optional priority and TTL.\n * @returns A pure {@link HttpRequest} describing the enqueue call.\n */\nexport function buildEnqueueRequest(parameters: EnqueueQueueItemParameters): HttpRequest {\n\tconst { data, priority, queueId, ttl, universeId } = parameters;\n\tconst body: Record<string, unknown> = { data };\n\tif (priority !== undefined) {\n\t\tbody[\"priority\"] = priority;\n\t}\n\n\tif (ttl !== undefined) {\n\t\tbody[\"ttl\"] = `${ttl}s`;\n\t}\n\n\treturn {\n\t\tbody,\n\t\theaders: { \"content-type\": \"application/json\" },\n\t\tmethod: \"POST\",\n\t\turl: `/cloud/v2/universes/${universeId}/memory-store/queues/${queueId}/items`,\n\t};\n}\n\n/**\n * Builds a `GET` request for the Open Cloud\n * `Cloud_ReadMemoryStoreQueueItems` endpoint. The `:read` suffix is a\n * custom-method marker; the call is HTTP `GET` despite the AIP-136\n * convention that custom methods use `POST`. Parameters travel as query\n * string only; there is no request body.\n *\n * `invisibilityWindow` is serialized as a Google protobuf `Duration`\n * string in seconds (`\"30s\"`), matching the wire contract.\n *\n * @param parameters - Universe and queue identifiers, plus optional\n *   `count`, `allOrNothing`, and `invisibilityWindow`.\n * @returns A pure {@link HttpRequest} describing the dequeue call.\n */\nexport function buildDequeueRequest(parameters: DequeueQueueItemsParameters): HttpRequest {\n\tconst query = new URLSearchParams();\n\tif (parameters.count !== undefined) {\n\t\tquery.append(\"count\", String(parameters.count));\n\t}\n\n\tif (parameters.allOrNothing !== undefined) {\n\t\tquery.append(\"allOrNothing\", String(parameters.allOrNothing));\n\t}\n\n\tif (parameters.invisibilityWindow !== undefined) {\n\t\tquery.append(\"invisibilityWindow\", `${parameters.invisibilityWindow}s`);\n\t}\n\n\tconst queryString = query.toString();\n\tconst { queueId, universeId } = parameters;\n\tconst base = `/cloud/v2/universes/${universeId}/memory-store/queues/${queueId}/items:read`;\n\treturn {\n\t\tmethod: \"GET\",\n\t\turl: queryString === \"\" ? base : `${base}?${queryString}`,\n\t};\n}\n\n/**\n * Builds a `POST` request for the Open Cloud\n * `Cloud_DiscardMemoryStoreQueueItems` endpoint. The request body uses\n * `{ readId }`, matching the schema (the dequeue *response* uses `id`,\n * but the discard *request* matches the schema and is not patched).\n *\n * @param parameters - Universe and queue identifiers, plus the\n *   `readId` returned from a prior dequeue.\n * @returns A pure {@link HttpRequest} describing the discard call.\n */\nexport function buildDiscardRequest(parameters: DiscardQueueItemsParameters): HttpRequest {\n\tconst { queueId, readId, universeId } = parameters;\n\treturn {\n\t\tbody: { readId },\n\t\theaders: { \"content-type\": \"application/json\" },\n\t\tmethod: \"POST\",\n\t\turl: `/cloud/v2/universes/${universeId}/memory-store/queues/${queueId}/items:discard`,\n\t};\n}\n","import type { OperationLimit } from \"../../../internal/http/rate-limit-queue.ts\";\n\nconst ENQUEUE_PER_MINUTE = 1_000_000;\nconst SECONDS_PER_MINUTE = 60;\n\n/**\n * Per-second request ceiling for enqueueing a memory-store queue item,\n * from the Open Cloud OpenAPI schema (1,000,000 requests per minute per\n * API key owner). Keyed independently from the dequeue and discard\n * operations so the three do not share a queue; upstream quota\n * accounting is documented per-operation, and the conservative default\n * is fewer cross-method contention surprises.\n */\nexport const ENQUEUE_OPERATION_LIMIT: OperationLimit = Object.freeze({\n\tmaxPerSecond: ENQUEUE_PER_MINUTE / SECONDS_PER_MINUTE,\n\toperationKey: \"memory-store-queues.enqueue\",\n});\n\n/**\n * Scopes required to enqueue a memory-store queue item, sourced from\n * `x-roblox-scopes` on the `Cloud_CreateMemoryStoreQueueItem` operation\n * in the vendored OpenAPI schema.\n */\nexport const ENQUEUE_REQUIRED_SCOPES: ReadonlyArray<string> = Object.freeze([\n\t\"memory-store.queue:add\",\n]);\n\nconst DEQUEUE_PER_MINUTE = 1_000_000;\n\n/**\n * Per-second request ceiling for dequeueing memory-store queue items,\n * from the Open Cloud OpenAPI schema (1,000,000 requests per minute\n * per API key owner). Keyed independently from enqueue and discard.\n */\nexport const DEQUEUE_OPERATION_LIMIT: OperationLimit = Object.freeze({\n\tmaxPerSecond: DEQUEUE_PER_MINUTE / SECONDS_PER_MINUTE,\n\toperationKey: \"memory-store-queues.dequeue\",\n});\n\n/**\n * Scopes required to dequeue memory-store queue items, sourced from\n * `x-roblox-scopes` on the `Cloud_ReadMemoryStoreQueueItems` operation\n * in the vendored OpenAPI schema.\n */\nexport const DEQUEUE_REQUIRED_SCOPES: ReadonlyArray<string> = Object.freeze([\n\t\"memory-store.queue:dequeue\",\n]);\n\nconst DISCARD_PER_MINUTE = 1_000_000;\n\n/**\n * Per-second request ceiling for discarding (acknowledging) memory-store\n * queue items, from the Open Cloud OpenAPI schema (1,000,000 requests\n * per minute per API key owner). Keyed independently from enqueue and\n * dequeue.\n */\nexport const DISCARD_OPERATION_LIMIT: OperationLimit = Object.freeze({\n\tmaxPerSecond: DISCARD_PER_MINUTE / SECONDS_PER_MINUTE,\n\toperationKey: \"memory-store-queues.discard\",\n});\n\n/**\n * Scopes required to discard memory-store queue items, sourced from\n * `x-roblox-scopes` on the `Cloud_DiscardMemoryStoreQueueItems`\n * operation in the vendored OpenAPI schema.\n */\nexport const DISCARD_REQUIRED_SCOPES: ReadonlyArray<string> = Object.freeze([\n\t\"memory-store.queue:discard\",\n]);\n","import type { HttpResponse } from \"../../../client/types.ts\";\nimport { ApiError } from \"../../../errors/api-error.ts\";\nimport { isDateTimeString } from \"../../../internal/utils/is-date-time-string.ts\";\nimport { isRecord } from \"../../../internal/utils/is-record.ts\";\nimport type { Result } from \"../../../types.ts\";\nimport type { DequeueResult, QueueItem } from \"./types.ts\";\nimport type { MemoryStoreQueueItemWire } from \"./wire.ts\";\n\nconst PATH_PATTERN = /^cloud\\/v2\\/universes\\/(\\d+)\\/memory-store\\/queues\\/([^/]+)\\/items\\/([^/]+)$/;\nconst MALFORMED_QUEUE_ITEM_MESSAGE = \"Malformed memory-store queue item response\";\nconst MALFORMED_DEQUEUE_MESSAGE = \"Malformed memory-store dequeue response\";\n\n/**\n * Parses a successful memory-store queue-item response body (the\n * `Cloud_CreateMemoryStoreQueueItem` happy path) into the public\n * {@link QueueItem} shape.\n *\n * @param response - The full {@link HttpResponse} from the Open Cloud API.\n * @returns A success result wrapping the parsed {@link QueueItem}, or an\n *   {@link ApiError} when the body does not match the wire schema.\n */\nexport function parseQueueItemResponse(response: HttpResponse): Result<QueueItem, ApiError> {\n\tconst item = wireBodyToQueueItem(response.body);\n\tif (item === undefined) {\n\t\treturn malformedQueueItem(response.status);\n\t}\n\n\treturn { data: item, success: true };\n}\n\n/**\n * Parses a successful `Cloud_ReadMemoryStoreQueueItems` response body\n * into the public {@link DequeueResult} shape. Each item in the\n * `queueItems` array is validated through the same path-and-shape\n * checks as {@link parseQueueItemResponse}; a malformed entry rejects\n * the whole response.\n *\n * @param response - The full {@link HttpResponse} from the Open Cloud API.\n * @returns A success result wrapping the parsed {@link DequeueResult},\n *   or an {@link ApiError} when the response shape is wrong.\n */\nexport function parseDequeueResponse(response: HttpResponse): Result<DequeueResult, ApiError> {\n\tconst { body, status: statusCode } = response;\n\tif (!isRecord(body)) {\n\t\treturn malformedDequeue(statusCode);\n\t}\n\n\tconst { id, queueItems } = body;\n\tif (typeof id !== \"string\" || !Array.isArray(queueItems)) {\n\t\treturn malformedDequeue(statusCode);\n\t}\n\n\tconst items = queueItems.map(wireBodyToQueueItem);\n\tif (!items.every(isQueueItem)) {\n\t\treturn malformedDequeue(statusCode);\n\t}\n\n\treturn { data: { items, readId: id }, success: true };\n}\n\nfunction isQueueItemWire(body: unknown): body is MemoryStoreQueueItemWire {\n\tif (!isRecord(body)) {\n\t\treturn false;\n\t}\n\n\tconst { data, expireTime, path, priority } = body;\n\treturn (\n\t\ttypeof path === \"string\" &&\n\t\tisDateTimeString(expireTime) &&\n\t\tdata !== undefined &&\n\t\tdata !== null &&\n\t\t(priority === undefined || priority === null || typeof priority === \"number\")\n\t);\n}\n\nfunction wireBodyToQueueItem(body: unknown): QueueItem | undefined {\n\tif (!isQueueItemWire(body)) {\n\t\treturn undefined;\n\t}\n\n\tconst match = PATH_PATTERN.exec(body.path);\n\tconst universeId = match?.[1];\n\tconst queueId = match?.[2];\n\tconst id = match?.[3];\n\tif (universeId === undefined || queueId === undefined || id === undefined) {\n\t\treturn undefined;\n\t}\n\n\treturn {\n\t\tid,\n\t\tdata: body.data,\n\t\texpiresAt: new Date(body.expireTime),\n\t\tpriority: body.priority ?? undefined,\n\t\tqueueId,\n\t\tuniverseId,\n\t};\n}\n\nfunction malformedQueueItem(statusCode: number): Result<QueueItem, ApiError> {\n\treturn {\n\t\terr: new ApiError(MALFORMED_QUEUE_ITEM_MESSAGE, { statusCode }),\n\t\tsuccess: false,\n\t};\n}\n\nfunction isQueueItem(item: QueueItem | undefined): item is QueueItem {\n\treturn item !== undefined;\n}\n\nfunction malformedDequeue(statusCode: number): Result<DequeueResult, ApiError> {\n\treturn {\n\t\terr: new ApiError(MALFORMED_DEQUEUE_MESSAGE, { statusCode }),\n\t\tsuccess: false,\n\t};\n}\n","import type { OpenCloudClientOptions, RequestOptions } from \"../../client/types.ts\";\nimport {\n\tbuildDequeueRequest,\n\tbuildDiscardRequest,\n\tbuildEnqueueRequest,\n} from \"../../domains/cloud-v2/memory-store-queues/builders.ts\";\nimport {\n\tDEQUEUE_OPERATION_LIMIT,\n\tDEQUEUE_REQUIRED_SCOPES,\n\tDISCARD_OPERATION_LIMIT,\n\tDISCARD_REQUIRED_SCOPES,\n\tENQUEUE_OPERATION_LIMIT,\n\tENQUEUE_REQUIRED_SCOPES,\n} from \"../../domains/cloud-v2/memory-store-queues/operations.ts\";\nimport {\n\tparseDequeueResponse,\n\tparseQueueItemResponse,\n} from \"../../domains/cloud-v2/memory-store-queues/parsers.ts\";\nimport type {\n\tDequeueQueueItemsParameters,\n\tDequeueResult,\n\tDiscardQueueItemsParameters,\n\tEnqueueQueueItemParameters,\n\tQueueItem,\n} from \"../../domains/cloud-v2/memory-store-queues/types.ts\";\nimport type { OpenCloudError } from \"../../errors/base.ts\";\nimport { CREATE_METHOD_DEFAULTS, IDEMPOTENT_METHOD_DEFAULTS } from \"../../internal/http/retry.ts\";\nimport {\n\tokRequest,\n\tparseEmptyResponse,\n\ttype ResourceClient,\n\ttype ResourceMethodSpec,\n} from \"../../internal/resource-client.ts\";\nimport type { Result } from \"../../types.ts\";\n\nfunction makeSpec<P, R>(spec: ResourceMethodSpec<P, R>): ResourceMethodSpec<P, R> {\n\treturn Object.freeze(spec);\n}\n\nconst ENQUEUE_SPEC = makeSpec<EnqueueQueueItemParameters, QueueItem>({\n\tbuildRequest: (parameters) => okRequest(buildEnqueueRequest(parameters)),\n\tmethodDefaults: CREATE_METHOD_DEFAULTS,\n\tmethodKind: \"create\",\n\toperationLimit: ENQUEUE_OPERATION_LIMIT,\n\tparse: parseQueueItemResponse,\n\trequiredScopes: ENQUEUE_REQUIRED_SCOPES,\n});\n\n// Dequeue uses HTTP GET but mutates server state via the invisibility\n// window. Retrying a 5xx where the server set invisibility before\n// failing the response would lose the original batch (it stays\n// invisible until the window elapses) and return a different one. So\n// the retry policy mirrors `create`: only 429, never 5xx.\nconst DEQUEUE_SPEC = makeSpec<DequeueQueueItemsParameters, DequeueResult>({\n\tbuildRequest: (parameters) => okRequest(buildDequeueRequest(parameters)),\n\tmethodDefaults: CREATE_METHOD_DEFAULTS,\n\tmethodKind: \"create\",\n\toperationLimit: DEQUEUE_OPERATION_LIMIT,\n\tparse: parseDequeueResponse,\n\trequiredScopes: DEQUEUE_REQUIRED_SCOPES,\n});\n\nconst DISCARD_SPEC = makeSpec<DiscardQueueItemsParameters, undefined>({\n\tbuildRequest: (parameters) => okRequest(buildDiscardRequest(parameters)),\n\tmethodDefaults: IDEMPOTENT_METHOD_DEFAULTS,\n\tmethodKind: \"idempotent\",\n\toperationLimit: DISCARD_OPERATION_LIMIT,\n\tparse: parseEmptyResponse,\n\trequiredScopes: DISCARD_REQUIRED_SCOPES,\n});\n\n/**\n * Operation Group on `StorageClient` that exposes the memory-store\n * queue endpoints. Queues are FIFO collections of opaque JSON values\n * with optional priority and TTL; consumers enqueue items, dequeue\n * them in batches, and acknowledge processed batches with a read\n * identifier.\n */\nexport class MemoryStoreQueuesGroup {\n\treadonly #inner: ResourceClient;\n\n\t/**\n\t * Wraps the shared {@link ResourceClient} so the Operation Group\n\t * routes calls through the same retry, hooks, and rate-limit queues\n\t * as the rest of the parent client.\n\t *\n\t * @param inner - The shared {@link ResourceClient} owned by the\n\t *   parent client.\n\t */\n\tconstructor(inner: ResourceClient) {\n\t\tthis.#inner = inner;\n\t}\n\n\t/**\n\t * Dequeues up to `count` items from the front of the queue. Items\n\t * returned become invisible to subsequent reads for\n\t * `invisibilityWindow` seconds (default 30 server-side); they\n\t * reappear once the window elapses unless acknowledged via\n\t * `discard` with the returned `readId`.\n\t *\n\t * On 5xx, dequeue does not retry: the server may have set\n\t * invisibility on a batch before the response failed, so a retry\n\t * would return a *different* batch and the first one is lost until\n\t * the window expires. Callers that can detect duplicates externally\n\t * may opt back into 5xx retry per call by passing `retryableStatuses`\n\t * on `options`.\n\t *\n\t * @param parameters - Universe and queue identifiers, plus optional\n\t *   `count`, `allOrNothing`, and `invisibilityWindow`.\n\t * @param options - Optional per-request overrides.\n\t * @returns A {@link Result} wrapping the parsed {@link DequeueResult}\n\t *   or the {@link OpenCloudError} that caused the request to fail.\n\t */\n\tpublic async dequeue(\n\t\tparameters: DequeueQueueItemsParameters,\n\t\toptions?: RequestOptions,\n\t): Promise<Result<DequeueResult, OpenCloudError>> {\n\t\treturn this.#inner.execute({ options, parameters, spec: DEQUEUE_SPEC });\n\t}\n\n\t/**\n\t * Acknowledges a dequeued batch of items, removing them from the\n\t * queue permanently. Pass the `readId` returned from the prior\n\t * `dequeue` call. Without `discard`, the items reappear once the\n\t * invisibility window elapses.\n\t *\n\t * The call is idempotent: a second `discard` with the same `readId`\n\t * is a no-op once the batch has been acknowledged. The retry policy\n\t * therefore retries both 429 and 5xx.\n\t *\n\t * @param parameters - Universe and queue identifiers, plus the\n\t *   `readId` returned from a prior dequeue.\n\t * @param options - Optional per-request overrides.\n\t * @returns A {@link Result} wrapping `undefined` on success (the\n\t *   server returns an empty body) or the {@link OpenCloudError}\n\t *   that caused the request to fail.\n\t */\n\tpublic async discard(\n\t\tparameters: DiscardQueueItemsParameters,\n\t\toptions?: RequestOptions,\n\t): Promise<Result<undefined, OpenCloudError>> {\n\t\treturn this.#inner.execute({ options, parameters, spec: DISCARD_SPEC });\n\t}\n\n\t/**\n\t * Enqueues a single item onto a memory-store queue. The queue is\n\t * auto-created on first use; the queue identifier is any string the\n\t * caller picks. Items with higher `priority` values are dequeued\n\t * first; equal priorities preserve insertion order. Items expire\n\t * and are removed automatically after `ttl` seconds, or after a\n\t * server-default lifetime when omitted.\n\t *\n\t * @param parameters - Universe and queue identifiers, the opaque\n\t *   payload, and optional `priority` and `ttl`.\n\t * @param options - Optional per-request overrides (e.g. A different\n\t *   {@link OpenCloudClientOptions.apiKey} for this call only).\n\t * @returns A {@link Result} wrapping the parsed {@link QueueItem} or\n\t *   the {@link OpenCloudError} that caused the request to fail.\n\t */\n\tpublic async enqueue(\n\t\tparameters: EnqueueQueueItemParameters,\n\t\toptions?: RequestOptions,\n\t): Promise<Result<QueueItem, OpenCloudError>> {\n\t\treturn this.#inner.execute({ options, parameters, spec: ENQUEUE_SPEC });\n\t}\n}\n","import type { OpenCloudClientOptions } from \"../../client/types.ts\";\nimport { ResourceClient } from \"../../internal/resource-client.ts\";\nimport { MemoryStoreQueuesGroup } from \"./queues-group.ts\";\n\n/**\n * Public client for the Roblox Open Cloud `Data and memory stores`\n * Feature. Today it covers memory-store queues via the\n * {@link StorageClient.queues} Operation Group; future Operation\n * Groups for sorted maps and data stores slot in as siblings on the\n * same client.\n *\n * Every method returns a `Result` so callers handle failure\n * explicitly; no thrown error ever escapes the client.\n *\n * @example\n *\n * ```ts\n * import { StorageClient } from \"@bedrock-rbx/ocale/storage\";\n *\n * const client = new StorageClient({ apiKey: \"your-key\" });\n * expect(client).toBeInstanceOf(StorageClient);\n * ```\n */\nexport class StorageClient {\n\t/** Memory-store queue Operation Group. */\n\tpublic readonly queues: MemoryStoreQueuesGroup;\n\n\t/**\n\t * Creates a new {@link StorageClient}. Configuration is frozen on\n\t * construction; per-request overrides are accepted on each method.\n\t *\n\t * @param options - Client-level configuration including the API key.\n\t */\n\tconstructor(options: OpenCloudClientOptions) {\n\t\tconst inner = new ResourceClient(options);\n\t\tthis.queues = new MemoryStoreQueuesGroup(inner);\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;AAiBA,SAAgB,oBAAoB,YAAqD;CACxF,MAAM,EAAE,MAAM,UAAU,SAAS,KAAK,eAAe;CACrD,MAAM,OAAgC,EAAE,MAAM;AAC9C,KAAI,aAAa,KAAA,EAChB,MAAK,cAAc;AAGpB,KAAI,QAAQ,KAAA,EACX,MAAK,SAAS,GAAG,IAAI;AAGtB,QAAO;EACN;EACA,SAAS,EAAE,gBAAgB,oBAAoB;EAC/C,QAAQ;EACR,KAAK,uBAAuB,WAAW,uBAAuB,QAAQ;EACtE;;;;;;;;;;;;;;;;AAiBF,SAAgB,oBAAoB,YAAsD;CACzF,MAAM,QAAQ,IAAI,iBAAiB;AACnC,KAAI,WAAW,UAAU,KAAA,EACxB,OAAM,OAAO,SAAS,OAAO,WAAW,MAAM,CAAC;AAGhD,KAAI,WAAW,iBAAiB,KAAA,EAC/B,OAAM,OAAO,gBAAgB,OAAO,WAAW,aAAa,CAAC;AAG9D,KAAI,WAAW,uBAAuB,KAAA,EACrC,OAAM,OAAO,sBAAsB,GAAG,WAAW,mBAAmB,GAAG;CAGxE,MAAM,cAAc,MAAM,UAAU;CACpC,MAAM,EAAE,SAAS,eAAe;CAChC,MAAM,OAAO,uBAAuB,WAAW,uBAAuB,QAAQ;AAC9E,QAAO;EACN,QAAQ;EACR,KAAK,gBAAgB,KAAK,OAAO,GAAG,KAAK,GAAG;EAC5C;;;;;;;;;;;;AAaF,SAAgB,oBAAoB,YAAsD;CACzF,MAAM,EAAE,SAAS,QAAQ,eAAe;AACxC,QAAO;EACN,MAAM,EAAE,QAAQ;EAChB,SAAS,EAAE,gBAAgB,oBAAoB;EAC/C,QAAQ;EACR,KAAK,uBAAuB,WAAW,uBAAuB,QAAQ;EACtE;;;;ACxFF,MAAM,qBAAqB;AAC3B,MAAM,qBAAqB;;;;;;;;;AAU3B,MAAa,0BAA0C,OAAO,OAAO;CACpE,cAAc,qBAAqB;CACnC,cAAc;CACd,CAAC;;;;;;AAOF,MAAa,0BAAiD,OAAO,OAAO,CAC3E,yBACA,CAAC;;;;;;AASF,MAAa,0BAA0C,OAAO,OAAO;CACpE,cAR0B,MAQS;CACnC,cAAc;CACd,CAAC;;;;;;AAOF,MAAa,0BAAiD,OAAO,OAAO,CAC3E,6BACA,CAAC;;;;;;;AAUF,MAAa,0BAA0C,OAAO,OAAO;CACpE,cAT0B,MASS;CACnC,cAAc;CACd,CAAC;;;;;;AAOF,MAAa,0BAAiD,OAAO,OAAO,CAC3E,6BACA,CAAC;;;AC5DF,MAAM,eAAe;AACrB,MAAM,+BAA+B;AACrC,MAAM,4BAA4B;;;;;;;;;;AAWlC,SAAgB,uBAAuB,UAAqD;CAC3F,MAAM,OAAO,oBAAoB,SAAS,KAAK;AAC/C,KAAI,SAAS,KAAA,EACZ,QAAO,mBAAmB,SAAS,OAAO;AAG3C,QAAO;EAAE,MAAM;EAAM,SAAS;EAAM;;;;;;;;;;;;;AAcrC,SAAgB,qBAAqB,UAAyD;CAC7F,MAAM,EAAE,MAAM,QAAQ,eAAe;AACrC,KAAI,CAAC,SAAS,KAAK,CAClB,QAAO,iBAAiB,WAAW;CAGpC,MAAM,EAAE,IAAI,eAAe;AAC3B,KAAI,OAAO,OAAO,YAAY,CAAC,MAAM,QAAQ,WAAW,CACvD,QAAO,iBAAiB,WAAW;CAGpC,MAAM,QAAQ,WAAW,IAAI,oBAAoB;AACjD,KAAI,CAAC,MAAM,MAAM,YAAY,CAC5B,QAAO,iBAAiB,WAAW;AAGpC,QAAO;EAAE,MAAM;GAAE;GAAO,QAAQ;GAAI;EAAE,SAAS;EAAM;;AAGtD,SAAS,gBAAgB,MAAiD;AACzE,KAAI,CAAC,SAAS,KAAK,CAClB,QAAO;CAGR,MAAM,EAAE,MAAM,YAAY,MAAM,aAAa;AAC7C,QACC,OAAO,SAAS,YAChB,iBAAiB,WAAW,IAC5B,SAAS,KAAA,KACT,SAAS,SACR,aAAa,KAAA,KAAa,aAAa,QAAQ,OAAO,aAAa;;AAItE,SAAS,oBAAoB,MAAsC;AAClE,KAAI,CAAC,gBAAgB,KAAK,CACzB;CAGD,MAAM,QAAQ,aAAa,KAAK,KAAK,KAAK;CAC1C,MAAM,aAAa,QAAQ;CAC3B,MAAM,UAAU,QAAQ;CACxB,MAAM,KAAK,QAAQ;AACnB,KAAI,eAAe,KAAA,KAAa,YAAY,KAAA,KAAa,OAAO,KAAA,EAC/D;AAGD,QAAO;EACN;EACA,MAAM,KAAK;EACX,WAAW,IAAI,KAAK,KAAK,WAAW;EACpC,UAAU,KAAK,YAAY,KAAA;EAC3B;EACA;EACA;;AAGF,SAAS,mBAAmB,YAAiD;AAC5E,QAAO;EACN,KAAK,IAAI,SAAS,8BAA8B,EAAE,YAAY,CAAC;EAC/D,SAAS;EACT;;AAGF,SAAS,YAAY,MAAgD;AACpE,QAAO,SAAS,KAAA;;AAGjB,SAAS,iBAAiB,YAAqD;AAC9E,QAAO;EACN,KAAK,IAAI,SAAS,2BAA2B,EAAE,YAAY,CAAC;EAC5D,SAAS;EACT;;;;AC9EF,SAAS,SAAe,MAA0D;AACjF,QAAO,OAAO,OAAO,KAAK;;AAG3B,MAAM,eAAe,SAAgD;CACpE,eAAe,eAAe,UAAU,oBAAoB,WAAW,CAAC;CACxE,gBAAgB;CAChB,YAAY;CACZ,gBAAgB;CAChB,OAAO;CACP,gBAAgB;CAChB,CAAC;AAOF,MAAM,eAAe,SAAqD;CACzE,eAAe,eAAe,UAAU,oBAAoB,WAAW,CAAC;CACxE,gBAAgB;CAChB,YAAY;CACZ,gBAAgB;CAChB,OAAO;CACP,gBAAgB;CAChB,CAAC;AAEF,MAAM,eAAe,SAAiD;CACrE,eAAe,eAAe,UAAU,oBAAoB,WAAW,CAAC;CACxE,gBAAgB;CAChB,YAAY;CACZ,gBAAgB;CAChB,OAAO;CACP,gBAAgB;CAChB,CAAC;;;;;;;;AASF,IAAa,yBAAb,MAAoC;CACnC;;;;;;;;;CAUA,YAAY,OAAuB;AAClC,QAAA,QAAc;;;;;;;;;;;;;;;;;;;;;;CAuBf,MAAa,QACZ,YACA,SACiD;AACjD,SAAO,MAAA,MAAY,QAAQ;GAAE;GAAS;GAAY,MAAM;GAAc,CAAC;;;;;;;;;;;;;;;;;;;CAoBxE,MAAa,QACZ,YACA,SAC6C;AAC7C,SAAO,MAAA,MAAY,QAAQ;GAAE;GAAS;GAAY,MAAM;GAAc,CAAC;;;;;;;;;;;;;;;;;CAkBxE,MAAa,QACZ,YACA,SAC6C;AAC7C,SAAO,MAAA,MAAY,QAAQ;GAAE;GAAS;GAAY,MAAM;GAAc,CAAC;;;;;;;;;;;;;;;;;;;;;;;;AC5IzE,IAAa,gBAAb,MAA2B;;CAE1B;;;;;;;CAQA,YAAY,SAAiC;EAC5C,MAAM,QAAQ,IAAI,eAAe,QAAQ;AACzC,OAAK,SAAS,IAAI,uBAAuB,MAAM"}

package/dist/types-BZ0959rh.d.mts

@@ -0,0 +1,149 @@
+//#region src/domains/cloud-v2/luau-execution-tasks/types.d.ts
+/**
+* Caller-supplied input for submitting a Luau Execution task against a
+* place's head version. Submitting against a specific place version uses
+* {@link SubmitAtVersionParameters} instead.
+*/
+interface SubmitAtHeadParameters {
+  /** Stringified ID of the place to run the script against. */
+  readonly placeId: string;
+  /** Luau source to execute. */
+  readonly script: string;
+  /**
+  * Wall-clock limit in seconds. The task fails when the script does not
+  * complete within this duration. Server default is 5 minutes.
+  */
+  readonly timeoutSeconds?: number;
+  /** Stringified ID of the universe that owns the place. */
+  readonly universeId: string;
+}
+/**
+* Caller-supplied input for submitting a Luau Execution task against a
+* specific place version. Submitting against the head version uses
+* {@link SubmitAtHeadParameters} instead.
+*/
+interface SubmitAtVersionParameters {
+  /** Stringified ID of the place to run the script against. */
+  readonly placeId: string;
+  /** Luau source to execute. */
+  readonly script: string;
+  /**
+  * Wall-clock limit in seconds. The task fails when the script does not
+  * complete within this duration. Server default is 5 minutes.
+  */
+  readonly timeoutSeconds?: number;
+  /** Stringified ID of the universe that owns the place. */
+  readonly universeId: string;
+  /** Stringified ID of the place version the script targets. */
+  readonly versionId: string;
+}
+/**
+* Five-field reference to a Luau Execution session task. The parser
+* extracts this from any of the four x-aep-resource `path` formats
+* returned by the server, and the get builder consumes it to construct
+* the maximal GET URL. `versionId` and `sessionId` are `undefined` when
+* the response `path` did not include those segments.
+*/
+interface LuauExecutionTaskRef {
+  /** Stringified place ID. */
+  readonly placeId: string;
+  /** Stringified luau-execution-session ID, when carried by the path. */
+  readonly sessionId?: string | undefined;
+  /** Stringified luau-execution-session-task ID. */
+  readonly taskId: string;
+  /** Stringified universe ID. */
+  readonly universeId: string;
+  /** Stringified place version ID, when carried by the path. */
+  readonly versionId?: string | undefined;
+}
+/**
+* Caller-supplied input for fetching a Luau Execution task's current
+* state.
+*/
+interface GetParameters {
+  /** Reference to the task to fetch, typically returned by submit. */
+  readonly ref: LuauExecutionTaskRef;
+  /**
+  * View controls how much of the task body the server returns. The
+  * server defaults to BASIC (excludes `script`) when no view is sent;
+  * `FULL` includes every field.
+  */
+  readonly view?: "BASIC" | "FULL";
+}
+/**
+* Discriminated variant carrying every state in which the task has not
+* yet produced output or an error: queued for execution, currently
+* executing, or cancelled by the caller.
+*/
+interface InProgressTask extends LuauExecutionTaskBase {
+  /** Discriminator: the task is queued, processing, or cancelled. */
+  readonly state: "CANCELLED" | "PROCESSING" | "QUEUED";
+}
+/**
+* Discriminated variant carrying the script's return values. The
+* server populates `output.results` with the Luau `return` values from
+* the script run, serialized as JSON; entries that were not
+* JSON-serializable (e.g., Roblox `Instance`s) appear as `null`.
+*/
+interface CompleteTask extends LuauExecutionTaskBase {
+  /**
+  * JSON projection of the script's return values, in order. The total
+  * serialized size of this array is bounded by the server-enforced
+  * 4 MB output limit.
+  */
+  readonly output: {
+    readonly results: ReadonlyArray<JSONValue>;
+  };
+  /** Discriminator: the task ran to completion and produced output. */
+  readonly state: "COMPLETE";
+}
+/**
+* Discriminated variant carrying the categorical error code and a
+* human-readable message describing the failure. The
+* `ERROR_CODE_UNSPECIFIED` wire sentinel is rejected by the parser, so
+* `code` is narrowed here to the four substantive error categories.
+*/
+interface FailedTask extends LuauExecutionTaskBase {
+  /** The categorical error code and message that caused the task to fail. */
+  readonly error: {
+    /**
+    * `SCRIPT_ERROR` for unhandled Luau errors, `DEADLINE_EXCEEDED`
+    * when the script outran its timeout, `OUTPUT_SIZE_LIMIT_EXCEEDED`
+    * when the return values exceeded 4 MB, or `INTERNAL_ERROR` for
+    * server-side faults.
+    */
+    readonly code: "DEADLINE_EXCEEDED" | "INTERNAL_ERROR" | "OUTPUT_SIZE_LIMIT_EXCEEDED" | "SCRIPT_ERROR"; /** Human-readable description of the failure. */
+    readonly message: string;
+  };
+  /** Discriminator: the task ran but failed before producing output. */
+  readonly state: "FAILED";
+}
+/**
+* Public, discriminated representation of a Luau Execution session
+* task. The variants are mutually exclusive on `state`.
+*/
+type LuauExecutionTask = CompleteTask | FailedTask | InProgressTask;
+/**
+* Common fields surfaced on every {@link LuauExecutionTask} variant.
+* Variant-specific fields (`output` for COMPLETE, `error` for FAILED)
+* live on the variants themselves.
+*/
+interface LuauExecutionTaskBase {
+  /** Timestamp when the task was created. */
+  readonly createdAt: Date;
+  /** Round-trip-safe reference to this task. */
+  readonly ref: LuauExecutionTaskRef;
+  /**
+  * Wall-clock execution limit in seconds, as supplied at submit time.
+  * Surfaces `undefined` when the request did not set a timeout (the
+  * server applies its 5-minute default in that case).
+  */
+  readonly timeoutSeconds?: number | undefined;
+  /** Timestamp of the most recent state change. */
+  readonly updatedAt: Date;
+  /** Identifier of the user that owns the API key used to create this task. */
+  readonly user: string;
+}
+//#endregion
+export { LuauExecutionTask as a, SubmitAtVersionParameters as c, InProgressTask as i, FailedTask as n, LuauExecutionTaskRef as o, GetParameters as r, SubmitAtHeadParameters as s, CompleteTask as t };
+//# sourceMappingURL=types-BZ0959rh.d.mts.map

package/dist/types-BZ0959rh.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-BZ0959rh.d.mts","names":[],"sources":["../src/domains/cloud-v2/luau-execution-tasks/types.ts"],"mappings":";;AAKA;;;;UAAiB,sBAAA;;WAEP,OAAA;;WAEA,MAAA;EAOA;AAQV;;;EARU,SAFA,cAAA;;WAEA,UAAA;AAAA;;;;;AA+BV;UAvBiB,yBAAA;;WAEP,OAAA;;WAEA,MAAA;;;;;WAKA,cAAA;EA+BV;EAAA,SA7BU,UAAA;;WAEA,SAAA;AAAA;;;;;AA2CV;;;UAjCiB,oBAAA;EAmCP;EAAA,SAjCA,OAAA;EA0CO;EAAA,SAxCP,SAAA;;WAEA,MAAA;;WAEA,UAAA;EAoC4B;EAAA,SAlC5B,SAAA;AAAA;;;;;UAOO,aAAA;EAmCP;EAAA,SAjCA,GAAA,EAAK,oBAAA;EA0CE;;;;;EAAA,SApCP,IAAA;AAAA;;;;AA6DV;;UArDiB,cAAA,SAAuB,qBAAA;;WAE9B,KAAA;AAAA;;;;;;;UASO,YAAA,SAAqB,qBAAA;EA0CsB;;;;;EAAA,SApClD,MAAA;IAAA,SAAmB,OAAA,EAAS,aAAA,CAAc,SAAA;EAAA;;WAE1C,KAAA;AAAA;;;;;;;UASO,UAAA,SAAmB,qBAAA;;WAE1B,KAAA;;;;;;;aAOC,IAAA;aAMA,OAAA;EAAA;;WAGD,KAAA;AAAA;;;;;KAOE,iBAAA,GAAoB,YAAA,GAAe,UAAA,GAAa,cAAA;;;;;;UAOlD,qBAAA;;WAEA,SAAA,EAAW,IAAA;;WAEX,GAAA,EAAK,oBAAA;;;;;;WAML,cAAA;;WAEA,SAAA,EAAW,IAAA;;WAEX,IAAA;AAAA"}

package/dist/{types-YCTsM8Qd.d.mts → types-Cp8w8uwA.d.mts}

@@ -211,4 +211,4 @@ type RequestOptions = Partial<Pick<OpenCloudClientOptions, "apiKey" | "baseUrl"
 type HttpRequestBody = FormData | Record<string, unknown> | Uint8Array<ArrayBuffer> | undefined;
 //#endregion
 export { OpenCloudHooks as a, Page as c, OpenCloudError as d, OpenCloudClientOptions as i, Result as l, HttpRequest as n, RequestConfig as o, HttpResponse as r, RequestOptions as s, HttpClient as t, SleepFunc as u };
-//# sourceMappingURL=types-YCTsM8Qd.d.mts.map
+//# sourceMappingURL=types-Cp8w8uwA.d.mts.map

package/dist/{types-YCTsM8Qd.d.mts.map → types-Cp8w8uwA.d.mts.map}

@@ -1 +1 @@
-{"version":3,"file":"types-YCTsM8Qd.d.mts","names":[],"sources":["../src/errors/base.ts","../src/internal/utils/sleep.ts","../src/types.ts","../src/client/types.ts"],"mappings":";;AAMA;;;;;cAAa,cAAA,SAAuB,KAAA;EAAA,kBACV,IAAA;AAAA;;;;KCNd,SAAA,IAAa,EAAA,aAAe,OAAA;;;;ADKxC;;;;;;;;ACLA;;;;;;;;ACiCA;;;;;;;;;;;;;;;;;KAAY,MAAA,QAAc,KAAA;EAAW,IAAA,EAAM,CAAA;EAAG,OAAA;AAAA;EAAoB,GAAA,EAAK,CAAA;EAAG,OAAA;AAAA;;;;;;;ACzB1E;;;;;;;;;;;;;;;;;AAkBA;;;UDmCiB,IAAA;;WAEP,KAAA,EAAO,aAAA,CAAc,CAAA;;WAErB,aAAA;AAAA;;;;;;UCzDO,WAAA;;WAEP,IAAA,GAAO,eAAA;EFVL;;;;;EAAA,SEgBF,OAAA,GAAU,QAAA,CAAS,MAAA;;WAEnB,MAAA;EDeE;EAAA,SCbF,GAAA;AAAA;;;;UAMO,YAAA;;;;;;WAMP,IAAA;;WAEA,OAAA,EAAS,QAAA,CAAS,MAAA;;WAElB,MAAA;AAAA;ADyBV;;;AAAA,UCnBiB,aAAA;;WAEP,MAAA;;WAEA,OAAA;;WAEA,OAAA;AAAA;;;;AAxCV;UA+CiB,UAAA;;EAEhB,OAAA,CACC,OAAA,EAAS,WAAA,EACT,MAAA,EAAQ,aAAA,GACN,OAAA,CAAQ,MAAA,CAAO,YAAA,EAAc,cAAA;AAAA;;;;;UAOhB,cAAA;;WAEP,WAAA,IAAe,MAAA;;WAEf,SAAA,IAAa,OAAA,EAAS,WAAA;;WAEtB,OAAA,IAAW,OAAA,UAAiB,KAAA,EAAO,cAAA;AAAA;AA/C7C;;;;AAAA,UAsDiB,sBAAA;;WAEP,MAAA;;WAEA,OAAA;;WAEA,KAAA,GAAQ,cAAA;EA5ClB;;;;;;;EAAA,SAoDU,UAAA,GAAa,UAAA;EA9Cb;EAAA,SAgDA,UAAA;EAzCO;;;;;EAAA,SA+CP,iBAAA,GAAoB,aAAA;;WAEpB,UAAA,IAAc,OAAA;;;;;;;WAOd,KAAA,GAAQ,SAAA;;WAER,OAAA;AAAA;;;;AA9CV;;KAsDY,cAAA,GAAiB,OAAA,CAC5B,IAAA,CACC,sBAAA;;;;;;;;;;;;KAgBG,eAAA,GAAkB,QAAA,GAAW,MAAA,oBAA0B,UAAA,CAAW,WAAA"}
+{"version":3,"file":"types-Cp8w8uwA.d.mts","names":[],"sources":["../src/errors/base.ts","../src/internal/utils/sleep.ts","../src/types.ts","../src/client/types.ts"],"mappings":";;AAMA;;;;;cAAa,cAAA,SAAuB,KAAA;EAAA,kBACV,IAAA;AAAA;;;;KCNd,SAAA,IAAa,EAAA,aAAe,OAAA;;;;ADKxC;;;;;;;;ACLA;;;;;;;;ACiCA;;;;;;;;;;;;;;;;;KAAY,MAAA,QAAc,KAAA;EAAW,IAAA,EAAM,CAAA;EAAG,OAAA;AAAA;EAAoB,GAAA,EAAK,CAAA;EAAG,OAAA;AAAA;;;;;;;ACzB1E;;;;;;;;;;;;;;;;;AAkBA;;;UDmCiB,IAAA;;WAEP,KAAA,EAAO,aAAA,CAAc,CAAA;;WAErB,aAAA;AAAA;;;;;;UCzDO,WAAA;;WAEP,IAAA,GAAO,eAAA;EFVL;;;;;EAAA,SEgBF,OAAA,GAAU,QAAA,CAAS,MAAA;;WAEnB,MAAA;EDeE;EAAA,SCbF,GAAA;AAAA;;;;UAMO,YAAA;;;;;;WAMP,IAAA;;WAEA,OAAA,EAAS,QAAA,CAAS,MAAA;;WAElB,MAAA;AAAA;ADyBV;;;AAAA,UCnBiB,aAAA;;WAEP,MAAA;;WAEA,OAAA;;WAEA,OAAA;AAAA;;;;AAxCV;UA+CiB,UAAA;;EAEhB,OAAA,CACC,OAAA,EAAS,WAAA,EACT,MAAA,EAAQ,aAAA,GACN,OAAA,CAAQ,MAAA,CAAO,YAAA,EAAc,cAAA;AAAA;;;;;UAOhB,cAAA;;WAEP,WAAA,IAAe,MAAA;;WAEf,SAAA,IAAa,OAAA,EAAS,WAAA;;WAEtB,OAAA,IAAW,OAAA,UAAiB,KAAA,EAAO,cAAA;AAAA;AA/C7C;;;;AAAA,UAsDiB,sBAAA;;WAEP,MAAA;;WAEA,OAAA;;WAEA,KAAA,GAAQ,cAAA;EA5ClB;;;;;;;EAAA,SAoDU,UAAA,GAAa,UAAA;EA9Cb;EAAA,SAgDA,UAAA;EAzCO;;;;;EAAA,SA+CP,iBAAA,GAAoB,aAAA;;WAEpB,UAAA,IAAc,OAAA;;;;;;;WAOd,KAAA,GAAQ,SAAA;;WAER,OAAA;AAAA;;;;AA9CV;;KAsDY,cAAA,GAAiB,OAAA,CAC5B,IAAA,CACC,sBAAA;;;;;;;;;;;;KAgBG,eAAA,GAAkB,QAAA,GAAW,MAAA,oBAA0B,UAAA,CAAW,WAAA"}