@bedrock-rbx/ocale 0.1.0-beta.1

package/dist/places.mjs

@@ -0,0 +1,403 @@
+import { i as ApiError } from "./rate-limit-BBU_4xnZ.mjs";
+import { t as ValidationError } from "./validation-CTZzJhmd.mjs";
+import { i as CREATE_METHOD_DEFAULTS, o as isRecord, t as ResourceClient } from "./resource-client-CaS_j3yg.mjs";
+//#region src/domains/cloud-v2/places/builders.ts
+const NON_UPDATABLE_KEYS = new Set(["placeId", "universeId"]);
+/**
+* Builds a `PATCH` request for the Open Cloud "update place" endpoint.
+* Derives the `updateMask` query string from the keys present on
+* `parameters` (excluding the identifiers) and emits a JSON body
+* containing those same fields.
+*
+* @param parameters - The universe and place identifiers plus the fields
+*   to update.
+* @returns A success result wrapping the request, or a
+*   {@link ValidationError} when no updatable fields were supplied.
+*/
+function buildUpdateRequest(parameters) {
+	const fieldKeys = extractUpdateFieldKeys(parameters);
+	if (fieldKeys.length === 0) return {
+		err: new ValidationError("Update must include at least one field", { code: "empty_update" }),
+		success: false
+	};
+	const body = Object.fromEntries(fieldKeys.map((key) => [key, Reflect.get(parameters, key)]));
+	const updateMask = fieldKeys.join(",");
+	const { placeId, universeId } = parameters;
+	return {
+		data: {
+			body,
+			headers: { "content-type": "application/json" },
+			method: "PATCH",
+			url: `/cloud/v2/universes/${universeId}/places/${placeId}?updateMask=${updateMask}`
+		},
+		success: true
+	};
+}
+function extractUpdateFieldKeys(parameters) {
+	return Object.keys(parameters).filter((key) => !NON_UPDATABLE_KEYS.has(key));
+}
+/**
+* Per-second request ceiling for updating a place, from the Open Cloud
+* OpenAPI schema (100 requests per minute per API key owner). Keyed
+* independently from the publish operation so publish and update do
+* not share a queue; upstream quota accounting is not documented as
+* shared and the conservative default is fewer cross-method
+* contention surprises.
+*/
+const UPDATE_OPERATION_LIMIT = Object.freeze({
+	maxPerSecond: 100 / 60,
+	operationKey: "places.update"
+});
+/**
+* Scopes required to update a place's metadata, sourced from
+* `x-roblox-scopes` on the `Cloud_UpdatePlace` operation in the vendored
+* OpenAPI schema.
+*/
+const UPDATE_REQUIRED_SCOPES = Object.freeze(["universe.place:write"]);
+//#endregion
+//#region src/domains/cloud-v2/places/parsers.ts
+const MALFORMED_PLACE_MESSAGE = "Malformed place response";
+/**
+* Parses a successful Open Cloud `Place` response body into the public
+* {@link Place} shape.
+*
+* @param response - The full {@link HttpResponse} from the Open Cloud API.
+* @returns A success result wrapping the parsed {@link Place}, or an
+*   {@link ApiError} when the body does not match the wire schema.
+*/
+function parsePlaceResponse(response) {
+	const { body, status: statusCode } = response;
+	if (!isPlaceWire(body)) return malformedPlace(statusCode);
+	const match = /^universes\/(\d+)\/places\/(\d+)$/.exec(body.path);
+	const universeId = match?.[1];
+	const id = match?.[2];
+	if (id === void 0 || universeId === void 0) return malformedPlace(statusCode);
+	return {
+		data: toPlace({
+			id,
+			body,
+			universeId
+		}),
+		success: true
+	};
+}
+function malformedPlace(statusCode) {
+	return {
+		err: new ApiError(MALFORMED_PLACE_MESSAGE, { statusCode }),
+		success: false
+	};
+}
+function toPlace(args) {
+	const { id, body, universeId } = args;
+	return {
+		id,
+		createdAt: new Date(body.createTime),
+		description: body.description,
+		displayName: body.displayName,
+		root: body.root ?? false,
+		serverSize: body.serverSize ?? void 0,
+		universeId,
+		universeRuntimeCreation: body.universeRuntimeCreation ?? false,
+		updatedAt: new Date(body.updateTime)
+	};
+}
+function hasValidPlaceRequired(body) {
+	return typeof body["path"] === "string" && typeof body["createTime"] === "string" && typeof body["updateTime"] === "string" && typeof body["displayName"] === "string" && typeof body["description"] === "string";
+}
+function isOptionalBoolean(value) {
+	return value === void 0 || value === null || typeof value === "boolean";
+}
+function hasValidPlaceOptional(body) {
+	const serverSize = body["serverSize"] ?? void 0;
+	return (serverSize === void 0 || typeof serverSize === "number") && isOptionalBoolean(body["root"]) && isOptionalBoolean(body["universeRuntimeCreation"]);
+}
+function isPlaceWire(body) {
+	return isRecord(body) && hasValidPlaceRequired(body) && hasValidPlaceOptional(body);
+}
+//#endregion
+//#region src/domains/universes/places/signatures.ts
+/**
+* Magic-byte prefix every Roblox binary place file (`.rbxl`) starts with.
+* The first 8 bytes spell out `<roblox!` in ASCII; the remaining 6 bytes
+* (`\x89\xff\r\n\x1a\n`) are the binary-format marker that distinguishes a
+* binary place file from the XML form (`.rbxlx`), whose ASCII-only header
+* begins with `<roblox `.
+*/
+const RBXL_SIGNATURE = new Uint8Array([
+	60,
+	114,
+	111,
+	98,
+	108,
+	111,
+	120,
+	33,
+	137,
+	255,
+	13,
+	10,
+	26,
+	10
+]);
+/**
+* Magic-byte prefix every Roblox XML place file (`.rbxlx`) starts with.
+* Equivalent to the ASCII string `<roblox ` (note the trailing space): a
+* well-formed rbxlx file opens with `<roblox` followed by attributes, while
+* an rbxl file uses `<roblox!` (exclamation mark) as the eighth byte. The
+* trailing space is what proves the file is the XML variant rather than
+* the binary one.
+*/
+const RBXLX_SIGNATURE = new Uint8Array([
+	60,
+	114,
+	111,
+	98,
+	108,
+	111,
+	120,
+	32
+]);
+/**
+* Reports whether `body` begins with `signature`. A pure byte-prefix check
+* with no allocation; used by the place builder to disambiguate `.rbxl` and
+* `.rbxlx` payloads against their declared `format`.
+*
+* @param body - The caller-supplied place file bytes.
+* @param signature - One of the frozen signature constants from this module.
+* @returns `true` if every byte of `signature` matches `body[0..signature.length]`.
+*/
+function matchesSignature(body, signature) {
+	for (const [index, expected] of signature.entries()) if (body[index] !== expected) return false;
+	return true;
+}
+//#endregion
+//#region src/domains/universes/places/builders.ts
+const CONTENT_TYPE_BY_FORMAT = {
+	rbxl: "application/octet-stream",
+	rbxlx: "application/xml"
+};
+/**
+* Builds a `POST` request for the Open Cloud "publish place version"
+* endpoint. Performs two local validations before producing any
+* {@link HttpRequest}: a non-empty body check and a magic-byte check
+* that the bytes' actual format matches `parameters.format`.
+*
+* @param parameters - Universe and place identifiers, the place file
+*   bytes, and the declared `format` of those bytes.
+* @param versionType - `"Published"` for `publish()`, `"Saved"` for
+*   `save()`; baked into the `?versionType=` query string.
+* @returns A success result wrapping the request on success, or a
+*   {@link ValidationError} when the body is empty or its magic bytes
+*   disagree with `parameters.format`.
+*/
+function buildPublishRequest(parameters, versionType) {
+	const { body, format, placeId, universeId } = parameters;
+	if (body.length === 0) return {
+		err: new ValidationError("Place body is empty", { code: "empty_body" }),
+		success: false
+	};
+	if (!matchesSignature(body, format === "rbxl" ? RBXL_SIGNATURE : RBXLX_SIGNATURE)) return {
+		err: new ValidationError(`Place body does not match the declared "${format}" format`, { code: "format_mismatch" }),
+		success: false
+	};
+	return {
+		data: {
+			body,
+			headers: { "content-type": CONTENT_TYPE_BY_FORMAT[format] },
+			method: "POST",
+			url: `/universes/v1/${universeId}/places/${placeId}/versions?versionType=${versionType}`
+		},
+		success: true
+	};
+}
+//#endregion
+//#region src/domains/universes/places/operations.ts
+/**
+* Per-second request ceiling for publishing or saving a place version,
+* from the Open Cloud OpenAPI schema (30 requests per minute, expressed
+* here as `0.5` per second). The publish and save methods both reference
+* this constant so that a single per-API-key queue serves both, matching
+* Roblox's server-side accounting which counts both call types against
+* the same per-minute quota.
+*/
+const PUBLISH_OPERATION_LIMIT = Object.freeze({
+	maxPerSecond: .5,
+	operationKey: "places.publishVersion"
+});
+/**
+* Scopes required to publish or save a place version, sourced from
+* `x-roblox-scopes` on the `Places_CreatePlaceVersionApiKey` operation
+* in the vendored OpenAPI schema.
+*/
+const PUBLISH_REQUIRED_SCOPES = Object.freeze(["universe-places:write"]);
+//#endregion
+//#region src/domains/universes/places/parsers.ts
+/**
+* Parses a successful publish-version response into the public
+* {@link PlaceVersion} shape. The Roblox endpoint sometimes returns the
+* JSON-shaped body under a `text/plain` `Content-Type`, so the body may
+* arrive either pre-decoded as a JSON object or still in its raw string
+* form; both are accepted here.
+*
+* @param response - The full {@link HttpResponse} from the Open Cloud API.
+* @returns A success result wrapping the parsed {@link PlaceVersion}, or
+*   an {@link ApiError} when the body is malformed or its `versionNumber`
+*   field is missing/wrong-typed.
+*/
+function parsePublishResponse(response) {
+	const { body, status: statusCode } = response;
+	const decodeResult = decodeBody(body, statusCode);
+	if (!decodeResult.success) return decodeResult;
+	if (!isPlaceVersionWire(decodeResult.data)) return {
+		err: new ApiError("Malformed publish response", { statusCode }),
+		success: false
+	};
+	return {
+		data: { versionNumber: decodeResult.data.versionNumber },
+		success: true
+	};
+}
+function decodeBody(body, statusCode) {
+	if (typeof body !== "string") return {
+		data: body,
+		success: true
+	};
+	try {
+		return {
+			data: JSON.parse(body),
+			success: true
+		};
+	} catch {
+		return {
+			err: new ApiError("Malformed publish response", { statusCode }),
+			success: false
+		};
+	}
+}
+function isPlaceVersionWire(value) {
+	if (!isRecord(value)) return false;
+	return typeof value["versionNumber"] === "number";
+}
+//#endregion
+//#region src/resources/places/client.ts
+function makeSpec(versionType) {
+	return Object.freeze({
+		buildRequest: (parameters) => buildPublishRequest(parameters, versionType),
+		methodDefaults: CREATE_METHOD_DEFAULTS,
+		methodKind: "create",
+		operationLimit: PUBLISH_OPERATION_LIMIT,
+		parse: parsePublishResponse,
+		requiredScopes: PUBLISH_REQUIRED_SCOPES
+	});
+}
+const PUBLISH_SPEC = makeSpec("Published");
+const SAVE_SPEC = makeSpec("Saved");
+const UPDATE_SPEC = Object.freeze({
+	buildRequest: buildUpdateRequest,
+	methodDefaults: {},
+	methodKind: "idempotent",
+	operationLimit: UPDATE_OPERATION_LIMIT,
+	parse: parsePlaceResponse,
+	requiredScopes: UPDATE_REQUIRED_SCOPES
+});
+/**
+* Public client for the Roblox Open Cloud `Place` resource. Covers
+* place-version publishing (`publish`, `save`) and place-configuration
+* updates (`update`). Wires the request builders, the injected
+* {@link OpenCloudClientOptions.httpClient}, and the response parsers
+* into a single ergonomic surface. Every method returns a {@link Result}
+* so callers handle failure explicitly; no thrown {@link OpenCloudError}
+* ever escapes the client.
+*
+* Publishing or saving a 5xx-failed place version is not retried
+* automatically: Roblox does not support idempotency keys, so a retry
+* could publish a duplicate version unnoticed. Callers that *can* detect
+* duplicates externally may opt back into 5xx retry per-call by passing
+* `retryableStatuses` on the second argument. The `update` method, by
+* contrast, is idempotent and retries both 429 and 5xx automatically.
+*
+* @example
+*
+* ```ts
+* import { PlacesClient } from "@bedrock-rbx/ocale/places";
+*
+* const client = new PlacesClient({ apiKey: "your-key" });
+* expect(client).toBeInstanceOf(PlacesClient);
+* ```
+*/
+var PlacesClient = class {
+	#inner;
+	/**
+	* Creates a new {@link PlacesClient}. Configuration is frozen on
+	* construction; per-request overrides are accepted on each method.
+	*
+	* @param options - Client-level configuration including the API key.
+	*/
+	constructor(options) {
+		this.#inner = new ResourceClient(options);
+	}
+	/**
+	* Publishes a new live version of a place.
+	*
+	* @param parameters - Universe and place identifiers, the place file
+	*   bytes, and their declared `format`.
+	* @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 PlaceVersion}
+	*   or the {@link OpenCloudError} that caused the request to fail.
+	*/
+	async publish(parameters, options) {
+		return this.#inner.execute({
+			options,
+			parameters,
+			spec: PUBLISH_SPEC
+		});
+	}
+	/**
+	* Saves a new draft version of a place. Identical to {@link publish}
+	* except the resulting version is not made live; consumers can list or
+	* promote it later. Shares a single per-API-key rate-limit queue with
+	* `publish` because Roblox attributes both calls to the same per-minute
+	* quota.
+	*
+	* @param parameters - Universe and place identifiers, the place file
+	*   bytes, and their declared `format`.
+	* @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 PlaceVersion}
+	*   or the {@link OpenCloudError} that caused the request to fail.
+	*/
+	async save(parameters, options) {
+		return this.#inner.execute({
+			options,
+			parameters,
+			spec: SAVE_SPEC
+		});
+	}
+	/**
+	* Partially updates a place's configuration. The fields supplied on
+	* `parameters` (excluding the identifiers) are forwarded to the
+	* server via a Google-style `updateMask`; unmentioned fields are
+	* left untouched. The universe's root place is the canonical place
+	* to update when changing a universe's description or display name:
+	* both are derived server-side from the root place.
+	*
+	* @param parameters - The universe and place identifiers and the
+	*   fields to update. At least one writable field must be supplied.
+	* @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 Place} or
+	*   the {@link OpenCloudError} that caused the request to fail.
+	*/
+	async update(parameters, options) {
+		return this.#inner.execute({
+			options,
+			parameters,
+			spec: UPDATE_SPEC
+		});
+	}
+};
+//#endregion
+export { PlacesClient };
+
+//# sourceMappingURL=places.mjs.map

package/dist/places.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"places.mjs","names":["#inner"],"sources":["../src/domains/cloud-v2/places/builders.ts","../src/domains/cloud-v2/places/operations.ts","../src/domains/cloud-v2/places/parsers.ts","../src/domains/universes/places/signatures.ts","../src/domains/universes/places/builders.ts","../src/domains/universes/places/operations.ts","../src/domains/universes/places/parsers.ts","../src/resources/places/client.ts"],"sourcesContent":["import type { HttpRequest } from \"../../../client/types.ts\";\nimport { ValidationError } from \"../../../errors/validation.ts\";\nimport type { Result } from \"../../../types.ts\";\nimport type { UpdatePlaceParameters } from \"./types.ts\";\n\nconst NON_UPDATABLE_KEYS: ReadonlySet<string> = new Set([\"placeId\", \"universeId\"]);\n\n/**\n * Builds a `PATCH` request for the Open Cloud \"update place\" endpoint.\n * Derives the `updateMask` query string from the keys present on\n * `parameters` (excluding the identifiers) and emits a JSON body\n * containing those same fields.\n *\n * @param parameters - The universe and place identifiers plus the fields\n *   to update.\n * @returns A success result wrapping the request, or a\n *   {@link ValidationError} when no updatable fields were supplied.\n */\nexport function buildUpdateRequest(\n\tparameters: UpdatePlaceParameters,\n): Result<HttpRequest, ValidationError> {\n\tconst fieldKeys = extractUpdateFieldKeys(parameters);\n\n\tif (fieldKeys.length === 0) {\n\t\treturn {\n\t\t\terr: new ValidationError(\"Update must include at least one field\", {\n\t\t\t\tcode: \"empty_update\",\n\t\t\t}),\n\t\t\tsuccess: false,\n\t\t};\n\t}\n\n\tconst body = Object.fromEntries(\n\t\tfieldKeys.map((key): readonly [string, unknown] => [key, Reflect.get(parameters, key)]),\n\t);\n\tconst updateMask = fieldKeys.join(\",\");\n\tconst { placeId, universeId } = parameters;\n\treturn {\n\t\tdata: {\n\t\t\tbody,\n\t\t\theaders: { \"content-type\": \"application/json\" },\n\t\t\tmethod: \"PATCH\",\n\t\t\turl: `/cloud/v2/universes/${universeId}/places/${placeId}?updateMask=${updateMask}`,\n\t\t},\n\t\tsuccess: true,\n\t};\n}\n\nfunction extractUpdateFieldKeys(parameters: UpdatePlaceParameters): ReadonlyArray<string> {\n\treturn Object.keys(parameters).filter((key) => !NON_UPDATABLE_KEYS.has(key));\n}\n","import type { OperationLimit } from \"../../../internal/http/rate-limit-queue.ts\";\n\nconst UPDATE_PER_MINUTE = 100;\nconst SECONDS_PER_MINUTE = 60;\n\n/**\n * Per-second request ceiling for updating a place, from the Open Cloud\n * OpenAPI schema (100 requests per minute per API key owner). Keyed\n * independently from the publish operation so publish and update do\n * not share a queue; upstream quota accounting is not documented as\n * shared and the conservative default is fewer cross-method\n * contention surprises.\n */\nexport const UPDATE_OPERATION_LIMIT: OperationLimit = Object.freeze({\n\tmaxPerSecond: UPDATE_PER_MINUTE / SECONDS_PER_MINUTE,\n\toperationKey: \"places.update\",\n});\n\n/**\n * Scopes required to update a place's metadata, sourced from\n * `x-roblox-scopes` on the `Cloud_UpdatePlace` operation in the vendored\n * OpenAPI schema.\n */\nexport const UPDATE_REQUIRED_SCOPES: ReadonlyArray<string> = Object.freeze([\n\t\"universe.place:write\",\n]);\n","import type { HttpResponse } from \"../../../client/types.ts\";\nimport { ApiError } from \"../../../errors/api-error.ts\";\nimport { isRecord } from \"../../../internal/utils/is-record.ts\";\nimport type { Result } from \"../../../types.ts\";\nimport type { Place } from \"./types.ts\";\nimport type { PlaceWire } from \"./wire.ts\";\n\nconst MALFORMED_PLACE_MESSAGE = \"Malformed place response\";\n\ninterface ToPlaceArgs {\n\treadonly id: string;\n\treadonly body: PlaceWire;\n\treadonly universeId: string;\n}\n\n/**\n * Parses a successful Open Cloud `Place` response body into the public\n * {@link Place} shape.\n *\n * @param response - The full {@link HttpResponse} from the Open Cloud API.\n * @returns A success result wrapping the parsed {@link Place}, or an\n *   {@link ApiError} when the body does not match the wire schema.\n */\nexport function parsePlaceResponse(response: HttpResponse): Result<Place, ApiError> {\n\tconst { body, status: statusCode } = response;\n\n\tif (!isPlaceWire(body)) {\n\t\treturn malformedPlace(statusCode);\n\t}\n\n\tconst match = /^universes\\/(\\d+)\\/places\\/(\\d+)$/.exec(body.path);\n\tconst universeId = match?.[1];\n\tconst id = match?.[2];\n\tif (id === undefined || universeId === undefined) {\n\t\treturn malformedPlace(statusCode);\n\t}\n\n\treturn { data: toPlace({ id, body, universeId }), success: true };\n}\n\nfunction malformedPlace(statusCode: number): Result<Place, ApiError> {\n\treturn {\n\t\terr: new ApiError(MALFORMED_PLACE_MESSAGE, { statusCode }),\n\t\tsuccess: false,\n\t};\n}\n\nfunction toPlace(args: ToPlaceArgs): Place {\n\tconst { id, body, universeId } = args;\n\treturn {\n\t\tid,\n\t\tcreatedAt: new Date(body.createTime),\n\t\tdescription: body.description,\n\t\tdisplayName: body.displayName,\n\t\troot: body.root ?? false,\n\t\tserverSize: body.serverSize ?? undefined,\n\t\tuniverseId,\n\t\tuniverseRuntimeCreation: body.universeRuntimeCreation ?? false,\n\t\tupdatedAt: new Date(body.updateTime),\n\t};\n}\n\nfunction hasValidPlaceRequired(body: Record<string, unknown>): boolean {\n\treturn (\n\t\ttypeof body[\"path\"] === \"string\" &&\n\t\ttypeof body[\"createTime\"] === \"string\" &&\n\t\ttypeof body[\"updateTime\"] === \"string\" &&\n\t\ttypeof body[\"displayName\"] === \"string\" &&\n\t\ttypeof body[\"description\"] === \"string\"\n\t);\n}\n\nfunction isOptionalBoolean(value: unknown): boolean {\n\treturn value === undefined || value === null || typeof value === \"boolean\";\n}\n\nfunction hasValidPlaceOptional(body: Record<string, unknown>): boolean {\n\tconst serverSize = body[\"serverSize\"] ?? undefined;\n\treturn (\n\t\t(serverSize === undefined || typeof serverSize === \"number\") &&\n\t\tisOptionalBoolean(body[\"root\"]) &&\n\t\tisOptionalBoolean(body[\"universeRuntimeCreation\"])\n\t);\n}\n\nfunction isPlaceWire(body: unknown): body is PlaceWire {\n\treturn isRecord(body) && hasValidPlaceRequired(body) && hasValidPlaceOptional(body);\n}\n","/**\n * Magic-byte prefix every Roblox binary place file (`.rbxl`) starts with.\n * The first 8 bytes spell out `<roblox!` in ASCII; the remaining 6 bytes\n * (`\\x89\\xff\\r\\n\\x1a\\n`) are the binary-format marker that distinguishes a\n * binary place file from the XML form (`.rbxlx`), whose ASCII-only header\n * begins with `<roblox `.\n */\nexport const RBXL_SIGNATURE: Readonly<Uint8Array<ArrayBuffer>> = new Uint8Array([\n\t0x3c, 0x72, 0x6f, 0x62, 0x6c, 0x6f, 0x78, 0x21, 0x89, 0xff, 0x0d, 0x0a, 0x1a, 0x0a,\n]);\n\n/**\n * Magic-byte prefix every Roblox XML place file (`.rbxlx`) starts with.\n * Equivalent to the ASCII string `<roblox ` (note the trailing space): a\n * well-formed rbxlx file opens with `<roblox` followed by attributes, while\n * an rbxl file uses `<roblox!` (exclamation mark) as the eighth byte. The\n * trailing space is what proves the file is the XML variant rather than\n * the binary one.\n */\nexport const RBXLX_SIGNATURE: Readonly<Uint8Array<ArrayBuffer>> = new Uint8Array([\n\t0x3c, 0x72, 0x6f, 0x62, 0x6c, 0x6f, 0x78, 0x20,\n]);\n\n/**\n * Reports whether `body` begins with `signature`. A pure byte-prefix check\n * with no allocation; used by the place builder to disambiguate `.rbxl` and\n * `.rbxlx` payloads against their declared `format`.\n *\n * @param body - The caller-supplied place file bytes.\n * @param signature - One of the frozen signature constants from this module.\n * @returns `true` if every byte of `signature` matches `body[0..signature.length]`.\n */\nexport function matchesSignature(\n\tbody: Uint8Array,\n\tsignature: Readonly<Uint8Array<ArrayBuffer>>,\n): boolean {\n\tfor (const [index, expected] of signature.entries()) {\n\t\tif (body[index] !== expected) {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\treturn true;\n}\n","import type { HttpRequest } from \"../../../client/types.ts\";\nimport { ValidationError } from \"../../../errors/validation.ts\";\nimport type { Result } from \"../../../types.ts\";\nimport { matchesSignature, RBXL_SIGNATURE, RBXLX_SIGNATURE } from \"./signatures.ts\";\nimport type { PublishParameters } from \"./types.ts\";\n\n/**\n * Whether a publish call writes a live (`Published`) or draft (`Saved`)\n * version. Surfaces only as the `versionType` query string on the\n * underlying HTTP request.\n */\ntype VersionType = \"Published\" | \"Saved\";\n\nconst CONTENT_TYPE_BY_FORMAT: Readonly<Record<PublishParameters[\"format\"], string>> = {\n\trbxl: \"application/octet-stream\",\n\trbxlx: \"application/xml\",\n};\n\n/**\n * Builds a `POST` request for the Open Cloud \"publish place version\"\n * endpoint. Performs two local validations before producing any\n * {@link HttpRequest}: a non-empty body check and a magic-byte check\n * that the bytes' actual format matches `parameters.format`.\n *\n * @param parameters - Universe and place identifiers, the place file\n *   bytes, and the declared `format` of those bytes.\n * @param versionType - `\"Published\"` for `publish()`, `\"Saved\"` for\n *   `save()`; baked into the `?versionType=` query string.\n * @returns A success result wrapping the request on success, or a\n *   {@link ValidationError} when the body is empty or its magic bytes\n *   disagree with `parameters.format`.\n */\nexport function buildPublishRequest(\n\tparameters: PublishParameters,\n\tversionType: VersionType,\n): Result<HttpRequest, ValidationError> {\n\tconst { body, format, placeId, universeId } = parameters;\n\n\tif (body.length === 0) {\n\t\treturn {\n\t\t\terr: new ValidationError(\"Place body is empty\", { code: \"empty_body\" }),\n\t\t\tsuccess: false,\n\t\t};\n\t}\n\n\tconst expectedSignature = format === \"rbxl\" ? RBXL_SIGNATURE : RBXLX_SIGNATURE;\n\tif (!matchesSignature(body, expectedSignature)) {\n\t\treturn {\n\t\t\terr: new ValidationError(`Place body does not match the declared \"${format}\" format`, {\n\t\t\t\tcode: \"format_mismatch\",\n\t\t\t}),\n\t\t\tsuccess: false,\n\t\t};\n\t}\n\n\treturn {\n\t\tdata: {\n\t\t\tbody,\n\t\t\theaders: { \"content-type\": CONTENT_TYPE_BY_FORMAT[format] },\n\t\t\tmethod: \"POST\",\n\t\t\turl: `/universes/v1/${universeId}/places/${placeId}/versions?versionType=${versionType}`,\n\t\t},\n\t\tsuccess: true,\n\t};\n}\n","import type { OperationLimit } from \"../../../internal/http/rate-limit-queue.ts\";\n\n/**\n * Per-second request ceiling for publishing or saving a place version,\n * from the Open Cloud OpenAPI schema (30 requests per minute, expressed\n * here as `0.5` per second). The publish and save methods both reference\n * this constant so that a single per-API-key queue serves both, matching\n * Roblox's server-side accounting which counts both call types against\n * the same per-minute quota.\n */\nexport const PUBLISH_OPERATION_LIMIT: OperationLimit = Object.freeze({\n\tmaxPerSecond: 0.5,\n\toperationKey: \"places.publishVersion\",\n});\n\n/**\n * Scopes required to publish or save a place version, sourced from\n * `x-roblox-scopes` on the `Places_CreatePlaceVersionApiKey` operation\n * in the vendored OpenAPI schema.\n */\nexport const PUBLISH_REQUIRED_SCOPES: ReadonlyArray<string> = Object.freeze([\n\t\"universe-places:write\",\n]);\n","import type { HttpResponse } from \"../../../client/types.ts\";\nimport { ApiError } from \"../../../errors/api-error.ts\";\nimport { isRecord } from \"../../../internal/utils/is-record.ts\";\nimport type { Result } from \"../../../types.ts\";\nimport type { PlaceVersion } from \"./types.ts\";\nimport type { PlaceVersionWire } from \"./wire.ts\";\n\n/**\n * Parses a successful publish-version response into the public\n * {@link PlaceVersion} shape. The Roblox endpoint sometimes returns the\n * JSON-shaped body under a `text/plain` `Content-Type`, so the body may\n * arrive either pre-decoded as a JSON object or still in its raw string\n * form; both are accepted here.\n *\n * @param response - The full {@link HttpResponse} from the Open Cloud API.\n * @returns A success result wrapping the parsed {@link PlaceVersion}, or\n *   an {@link ApiError} when the body is malformed or its `versionNumber`\n *   field is missing/wrong-typed.\n */\nexport function parsePublishResponse(response: HttpResponse): Result<PlaceVersion, ApiError> {\n\tconst { body, status: statusCode } = response;\n\n\tconst decodeResult = decodeBody(body, statusCode);\n\tif (!decodeResult.success) {\n\t\treturn decodeResult;\n\t}\n\n\tif (!isPlaceVersionWire(decodeResult.data)) {\n\t\treturn {\n\t\t\terr: new ApiError(\"Malformed publish response\", { statusCode }),\n\t\t\tsuccess: false,\n\t\t};\n\t}\n\n\treturn {\n\t\tdata: { versionNumber: decodeResult.data.versionNumber },\n\t\tsuccess: true,\n\t};\n}\n\nfunction decodeBody(body: unknown, statusCode: number): Result<unknown, ApiError> {\n\tif (typeof body !== \"string\") {\n\t\treturn { data: body, success: true };\n\t}\n\n\ttry {\n\t\treturn { data: JSON.parse(body), success: true };\n\t} catch {\n\t\treturn {\n\t\t\terr: new ApiError(\"Malformed publish response\", { statusCode }),\n\t\t\tsuccess: false,\n\t\t};\n\t}\n}\n\nfunction isPlaceVersionWire(value: unknown): value is PlaceVersionWire {\n\tif (!isRecord(value)) {\n\t\treturn false;\n\t}\n\n\treturn typeof value[\"versionNumber\"] === \"number\";\n}\n","import type { OpenCloudClientOptions, RequestOptions } from \"../../client/types.ts\";\nimport { buildUpdateRequest } from \"../../domains/cloud-v2/places/builders.ts\";\nimport {\n\tUPDATE_OPERATION_LIMIT,\n\tUPDATE_REQUIRED_SCOPES,\n} from \"../../domains/cloud-v2/places/operations.ts\";\nimport { parsePlaceResponse } from \"../../domains/cloud-v2/places/parsers.ts\";\nimport type { Place, UpdatePlaceParameters } from \"../../domains/cloud-v2/places/types.ts\";\nimport { buildPublishRequest } from \"../../domains/universes/places/builders.ts\";\nimport {\n\tPUBLISH_OPERATION_LIMIT,\n\tPUBLISH_REQUIRED_SCOPES,\n} from \"../../domains/universes/places/operations.ts\";\nimport { parsePublishResponse } from \"../../domains/universes/places/parsers.ts\";\nimport type { PlaceVersion, PublishParameters } from \"../../domains/universes/places/types.ts\";\nimport type { OpenCloudError } from \"../../errors/base.ts\";\nimport { CREATE_METHOD_DEFAULTS } from \"../../internal/http/retry.ts\";\nimport { ResourceClient, type ResourceMethodSpec } from \"../../internal/resource-client.ts\";\nimport type { Result } from \"../../types.ts\";\n\nfunction makeSpec(\n\tversionType: \"Published\" | \"Saved\",\n): ResourceMethodSpec<PublishParameters, PlaceVersion> {\n\treturn Object.freeze({\n\t\tbuildRequest: (parameters: PublishParameters) =>\n\t\t\tbuildPublishRequest(parameters, versionType),\n\t\tmethodDefaults: CREATE_METHOD_DEFAULTS,\n\t\tmethodKind: \"create\",\n\t\toperationLimit: PUBLISH_OPERATION_LIMIT,\n\t\tparse: parsePublishResponse,\n\t\trequiredScopes: PUBLISH_REQUIRED_SCOPES,\n\t});\n}\n\nconst PUBLISH_SPEC = makeSpec(\"Published\");\nconst SAVE_SPEC = makeSpec(\"Saved\");\n\nconst UPDATE_SPEC: ResourceMethodSpec<UpdatePlaceParameters, Place> = Object.freeze({\n\tbuildRequest: buildUpdateRequest,\n\tmethodDefaults: {},\n\tmethodKind: \"idempotent\",\n\toperationLimit: UPDATE_OPERATION_LIMIT,\n\tparse: parsePlaceResponse,\n\trequiredScopes: UPDATE_REQUIRED_SCOPES,\n});\n\n/**\n * Public client for the Roblox Open Cloud `Place` resource. Covers\n * place-version publishing (`publish`, `save`) and place-configuration\n * updates (`update`). Wires the request builders, the injected\n * {@link OpenCloudClientOptions.httpClient}, and the response parsers\n * into a single ergonomic surface. Every method returns a {@link Result}\n * so callers handle failure explicitly; no thrown {@link OpenCloudError}\n * ever escapes the client.\n *\n * Publishing or saving a 5xx-failed place version is not retried\n * automatically: Roblox does not support idempotency keys, so a retry\n * could publish a duplicate version unnoticed. Callers that *can* detect\n * duplicates externally may opt back into 5xx retry per-call by passing\n * `retryableStatuses` on the second argument. The `update` method, by\n * contrast, is idempotent and retries both 429 and 5xx automatically.\n *\n * @example\n *\n * ```ts\n * import { PlacesClient } from \"@bedrock-rbx/ocale/places\";\n *\n * const client = new PlacesClient({ apiKey: \"your-key\" });\n * expect(client).toBeInstanceOf(PlacesClient);\n * ```\n */\nexport class PlacesClient {\n\treadonly #inner: ResourceClient;\n\n\t/**\n\t * Creates a new {@link PlacesClient}. 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\tthis.#inner = new ResourceClient(options);\n\t}\n\n\t/**\n\t * Publishes a new live version of a place.\n\t *\n\t * @param parameters - Universe and place identifiers, the place file\n\t *   bytes, and their declared `format`.\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 PlaceVersion}\n\t *   or the {@link OpenCloudError} that caused the request to fail.\n\t */\n\tpublic async publish(\n\t\tparameters: PublishParameters,\n\t\toptions?: RequestOptions,\n\t): Promise<Result<PlaceVersion, OpenCloudError>> {\n\t\treturn this.#inner.execute({ options, parameters, spec: PUBLISH_SPEC });\n\t}\n\n\t/**\n\t * Saves a new draft version of a place. Identical to {@link publish}\n\t * except the resulting version is not made live; consumers can list or\n\t * promote it later. Shares a single per-API-key rate-limit queue with\n\t * `publish` because Roblox attributes both calls to the same per-minute\n\t * quota.\n\t *\n\t * @param parameters - Universe and place identifiers, the place file\n\t *   bytes, and their declared `format`.\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 PlaceVersion}\n\t *   or the {@link OpenCloudError} that caused the request to fail.\n\t */\n\tpublic async save(\n\t\tparameters: PublishParameters,\n\t\toptions?: RequestOptions,\n\t): Promise<Result<PlaceVersion, OpenCloudError>> {\n\t\treturn this.#inner.execute({ options, parameters, spec: SAVE_SPEC });\n\t}\n\n\t/**\n\t * Partially updates a place's configuration. The fields supplied on\n\t * `parameters` (excluding the identifiers) are forwarded to the\n\t * server via a Google-style `updateMask`; unmentioned fields are\n\t * left untouched. The universe's root place is the canonical place\n\t * to update when changing a universe's description or display name:\n\t * both are derived server-side from the root place.\n\t *\n\t * @param parameters - The universe and place identifiers and the\n\t *   fields to update. At least one writable field must be supplied.\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 Place} or\n\t *   the {@link OpenCloudError} that caused the request to fail.\n\t */\n\tpublic async update(\n\t\tparameters: UpdatePlaceParameters,\n\t\toptions?: RequestOptions,\n\t): Promise<Result<Place, OpenCloudError>> {\n\t\treturn this.#inner.execute({ options, parameters, spec: UPDATE_SPEC });\n\t}\n}\n"],"mappings":";;;;AAKA,MAAM,qBAA0C,IAAI,IAAI,CAAC,WAAW,aAAa,CAAC;;;;;;;;;;;;AAalF,SAAgB,mBACf,YACuC;CACvC,MAAM,YAAY,uBAAuB,WAAW;AAEpD,KAAI,UAAU,WAAW,EACxB,QAAO;EACN,KAAK,IAAI,gBAAgB,0CAA0C,EAClE,MAAM,gBACN,CAAC;EACF,SAAS;EACT;CAGF,MAAM,OAAO,OAAO,YACnB,UAAU,KAAK,QAAoC,CAAC,KAAK,QAAQ,IAAI,YAAY,IAAI,CAAC,CAAC,CACvF;CACD,MAAM,aAAa,UAAU,KAAK,IAAI;CACtC,MAAM,EAAE,SAAS,eAAe;AAChC,QAAO;EACN,MAAM;GACL;GACA,SAAS,EAAE,gBAAgB,oBAAoB;GAC/C,QAAQ;GACR,KAAK,uBAAuB,WAAW,UAAU,QAAQ,cAAc;GACvE;EACD,SAAS;EACT;;AAGF,SAAS,uBAAuB,YAA0D;AACzF,QAAO,OAAO,KAAK,WAAW,CAAC,QAAQ,QAAQ,CAAC,mBAAmB,IAAI,IAAI,CAAC;;;;;;;;;;ACpC7E,MAAa,yBAAyC,OAAO,OAAO;CACnE,cAZyB,MACC;CAY1B,cAAc;CACd,CAAC;;;;;;AAOF,MAAa,yBAAgD,OAAO,OAAO,CAC1E,uBACA,CAAC;;;AClBF,MAAM,0BAA0B;;;;;;;;;AAgBhC,SAAgB,mBAAmB,UAAiD;CACnF,MAAM,EAAE,MAAM,QAAQ,eAAe;AAErC,KAAI,CAAC,YAAY,KAAK,CACrB,QAAO,eAAe,WAAW;CAGlC,MAAM,QAAQ,oCAAoC,KAAK,KAAK,KAAK;CACjE,MAAM,aAAa,QAAQ;CAC3B,MAAM,KAAK,QAAQ;AACnB,KAAI,OAAO,KAAA,KAAa,eAAe,KAAA,EACtC,QAAO,eAAe,WAAW;AAGlC,QAAO;EAAE,MAAM,QAAQ;GAAE;GAAI;GAAM;GAAY,CAAC;EAAE,SAAS;EAAM;;AAGlE,SAAS,eAAe,YAA6C;AACpE,QAAO;EACN,KAAK,IAAI,SAAS,yBAAyB,EAAE,YAAY,CAAC;EAC1D,SAAS;EACT;;AAGF,SAAS,QAAQ,MAA0B;CAC1C,MAAM,EAAE,IAAI,MAAM,eAAe;AACjC,QAAO;EACN;EACA,WAAW,IAAI,KAAK,KAAK,WAAW;EACpC,aAAa,KAAK;EAClB,aAAa,KAAK;EAClB,MAAM,KAAK,QAAQ;EACnB,YAAY,KAAK,cAAc,KAAA;EAC/B;EACA,yBAAyB,KAAK,2BAA2B;EACzD,WAAW,IAAI,KAAK,KAAK,WAAW;EACpC;;AAGF,SAAS,sBAAsB,MAAwC;AACtE,QACC,OAAO,KAAK,YAAY,YACxB,OAAO,KAAK,kBAAkB,YAC9B,OAAO,KAAK,kBAAkB,YAC9B,OAAO,KAAK,mBAAmB,YAC/B,OAAO,KAAK,mBAAmB;;AAIjC,SAAS,kBAAkB,OAAyB;AACnD,QAAO,UAAU,KAAA,KAAa,UAAU,QAAQ,OAAO,UAAU;;AAGlE,SAAS,sBAAsB,MAAwC;CACtE,MAAM,aAAa,KAAK,iBAAiB,KAAA;AACzC,SACE,eAAe,KAAA,KAAa,OAAO,eAAe,aACnD,kBAAkB,KAAK,QAAQ,IAC/B,kBAAkB,KAAK,2BAA2B;;AAIpD,SAAS,YAAY,MAAkC;AACtD,QAAO,SAAS,KAAK,IAAI,sBAAsB,KAAK,IAAI,sBAAsB,KAAK;;;;;;;;;;;AC/EpF,MAAa,iBAAoD,IAAI,WAAW;CAC/E;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAC9E,CAAC;;;;;;;;;AAUF,MAAa,kBAAqD,IAAI,WAAW;CAChF;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAC1C,CAAC;;;;;;;;;;AAWF,SAAgB,iBACf,MACA,WACU;AACV,MAAK,MAAM,CAAC,OAAO,aAAa,UAAU,SAAS,CAClD,KAAI,KAAK,WAAW,SACnB,QAAO;AAIT,QAAO;;;;AC7BR,MAAM,yBAAgF;CACrF,MAAM;CACN,OAAO;CACP;;;;;;;;;;;;;;;AAgBD,SAAgB,oBACf,YACA,aACuC;CACvC,MAAM,EAAE,MAAM,QAAQ,SAAS,eAAe;AAE9C,KAAI,KAAK,WAAW,EACnB,QAAO;EACN,KAAK,IAAI,gBAAgB,uBAAuB,EAAE,MAAM,cAAc,CAAC;EACvE,SAAS;EACT;AAIF,KAAI,CAAC,iBAAiB,MADI,WAAW,SAAS,iBAAiB,gBACjB,CAC7C,QAAO;EACN,KAAK,IAAI,gBAAgB,2CAA2C,OAAO,WAAW,EACrF,MAAM,mBACN,CAAC;EACF,SAAS;EACT;AAGF,QAAO;EACN,MAAM;GACL;GACA,SAAS,EAAE,gBAAgB,uBAAuB,SAAS;GAC3D,QAAQ;GACR,KAAK,iBAAiB,WAAW,UAAU,QAAQ,wBAAwB;GAC3E;EACD,SAAS;EACT;;;;;;;;;;;;ACrDF,MAAa,0BAA0C,OAAO,OAAO;CACpE,cAAc;CACd,cAAc;CACd,CAAC;;;;;;AAOF,MAAa,0BAAiD,OAAO,OAAO,CAC3E,wBACA,CAAC;;;;;;;;;;;;;;;ACHF,SAAgB,qBAAqB,UAAwD;CAC5F,MAAM,EAAE,MAAM,QAAQ,eAAe;CAErC,MAAM,eAAe,WAAW,MAAM,WAAW;AACjD,KAAI,CAAC,aAAa,QACjB,QAAO;AAGR,KAAI,CAAC,mBAAmB,aAAa,KAAK,CACzC,QAAO;EACN,KAAK,IAAI,SAAS,8BAA8B,EAAE,YAAY,CAAC;EAC/D,SAAS;EACT;AAGF,QAAO;EACN,MAAM,EAAE,eAAe,aAAa,KAAK,eAAe;EACxD,SAAS;EACT;;AAGF,SAAS,WAAW,MAAe,YAA+C;AACjF,KAAI,OAAO,SAAS,SACnB,QAAO;EAAE,MAAM;EAAM,SAAS;EAAM;AAGrC,KAAI;AACH,SAAO;GAAE,MAAM,KAAK,MAAM,KAAK;GAAE,SAAS;GAAM;SACzC;AACP,SAAO;GACN,KAAK,IAAI,SAAS,8BAA8B,EAAE,YAAY,CAAC;GAC/D,SAAS;GACT;;;AAIH,SAAS,mBAAmB,OAA2C;AACtE,KAAI,CAAC,SAAS,MAAM,CACnB,QAAO;AAGR,QAAO,OAAO,MAAM,qBAAqB;;;;ACxC1C,SAAS,SACR,aACsD;AACtD,QAAO,OAAO,OAAO;EACpB,eAAe,eACd,oBAAoB,YAAY,YAAY;EAC7C,gBAAgB;EAChB,YAAY;EACZ,gBAAgB;EAChB,OAAO;EACP,gBAAgB;EAChB,CAAC;;AAGH,MAAM,eAAe,SAAS,YAAY;AAC1C,MAAM,YAAY,SAAS,QAAQ;AAEnC,MAAM,cAAgE,OAAO,OAAO;CACnF,cAAc;CACd,gBAAgB,EAAE;CAClB,YAAY;CACZ,gBAAgB;CAChB,OAAO;CACP,gBAAgB;CAChB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BF,IAAa,eAAb,MAA0B;CACzB;;;;;;;CAQA,YAAY,SAAiC;AAC5C,QAAA,QAAc,IAAI,eAAe,QAAQ;;;;;;;;;;;;CAa1C,MAAa,QACZ,YACA,SACgD;AAChD,SAAO,MAAA,MAAY,QAAQ;GAAE;GAAS;GAAY,MAAM;GAAc,CAAC;;;;;;;;;;;;;;;;CAiBxE,MAAa,KACZ,YACA,SACgD;AAChD,SAAO,MAAA,MAAY,QAAQ;GAAE;GAAS;GAAY,MAAM;GAAW,CAAC;;;;;;;;;;;;;;;;;CAkBrE,MAAa,OACZ,YACA,SACyC;AACzC,SAAO,MAAA,MAAY,QAAQ;GAAE;GAAS;GAAY,MAAM;GAAa,CAAC"}

package/dist/price-information-CmpscMc4.mjs

@@ -0,0 +1,42 @@
+import { o as isRecord } from "./resource-client-CaS_j3yg.mjs";
+//#region src/internal/price-information.ts
+/**
+* Narrows `value` to {@link PriceInformationLike} for a given feature literal
+* union by delegating per-element validation to the supplied `isFeature`
+* predicate.
+*
+* @template F - The pricing-feature literal union the caller wants to narrow to.
+* @param value - Unknown wire value to validate.
+* @param isFeature - Type guard for a single `enabledFeatures` element.
+* @returns `true` when `value` is a record whose `defaultPriceInRobux` is a
+*   number, `null`, or absent and whose `enabledFeatures` is an array of
+*   values that all satisfy `isFeature`.
+*/
+function isPriceInformationLike(value, isFeature) {
+	if (!isRecord(value)) return false;
+	const defaultPrice = value["defaultPriceInRobux"] ?? void 0;
+	if (defaultPrice !== void 0 && typeof defaultPrice !== "number") return false;
+	const features = value["enabledFeatures"];
+	if (!Array.isArray(features)) return false;
+	for (const feature of features) if (!isFeature(feature)) return false;
+	return true;
+}
+/**
+* Returns a fresh {@link PriceInformationLike} value with a new
+* `enabledFeatures` array, so the caller can hand the result on without
+* exposing the wire object's internal storage.
+*
+* @template F - The pricing-feature literal union of the input.
+* @param wire - Already-validated wire shape.
+* @returns A new record with the same defaults and a copied feature array.
+*/
+function copyPriceInformation(wire) {
+	return {
+		defaultPriceInRobux: wire.defaultPriceInRobux ?? void 0,
+		enabledFeatures: [...wire.enabledFeatures]
+	};
+}
+//#endregion
+export { isPriceInformationLike as n, copyPriceInformation as t };
+
+//# sourceMappingURL=price-information-CmpscMc4.mjs.map

package/dist/price-information-CmpscMc4.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"price-information-CmpscMc4.mjs","names":[],"sources":["../src/internal/price-information.ts"],"sourcesContent":["import { isRecord } from \"./utils/is-record.ts\";\n\n/**\n * Wire shape shared by every Roblox commerce resource that carries a\n * `priceInformation` block (game passes, developer products, ...). Resources\n * vary in the literal set their `enabledFeatures` may contain, so the feature\n * type is left as a parameter `F`.\n *\n * @template F - The string-literal union for this resource's pricing-feature flags.\n */\nexport interface PriceInformationLike<F extends string> {\n\t/** Default Robux price; `undefined` when the schema returns null. */\n\treadonly defaultPriceInRobux: number | undefined;\n\t/** Enabled pricing feature flags, in the order returned by the API. */\n\treadonly enabledFeatures: ReadonlyArray<F>;\n}\n\n/**\n * Narrows `value` to {@link PriceInformationLike} for a given feature literal\n * union by delegating per-element validation to the supplied `isFeature`\n * predicate.\n *\n * @template F - The pricing-feature literal union the caller wants to narrow to.\n * @param value - Unknown wire value to validate.\n * @param isFeature - Type guard for a single `enabledFeatures` element.\n * @returns `true` when `value` is a record whose `defaultPriceInRobux` is a\n *   number, `null`, or absent and whose `enabledFeatures` is an array of\n *   values that all satisfy `isFeature`.\n */\nexport function isPriceInformationLike<F extends string>(\n\tvalue: unknown,\n\tisFeature: (candidate: unknown) => candidate is F,\n): value is PriceInformationLike<F> {\n\tif (!isRecord(value)) {\n\t\treturn false;\n\t}\n\n\tconst defaultPrice = value[\"defaultPriceInRobux\"] ?? undefined;\n\tif (defaultPrice !== undefined && typeof defaultPrice !== \"number\") {\n\t\treturn false;\n\t}\n\n\tconst features = value[\"enabledFeatures\"];\n\tif (!Array.isArray(features)) {\n\t\treturn false;\n\t}\n\n\tfor (const feature of features) {\n\t\tif (!isFeature(feature)) {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\treturn true;\n}\n\n/**\n * Returns a fresh {@link PriceInformationLike} value with a new\n * `enabledFeatures` array, so the caller can hand the result on without\n * exposing the wire object's internal storage.\n *\n * @template F - The pricing-feature literal union of the input.\n * @param wire - Already-validated wire shape.\n * @returns A new record with the same defaults and a copied feature array.\n */\nexport function copyPriceInformation<F extends string>(\n\twire: PriceInformationLike<F>,\n): PriceInformationLike<F> {\n\treturn {\n\t\tdefaultPriceInRobux: wire.defaultPriceInRobux ?? undefined,\n\t\tenabledFeatures: [...wire.enabledFeatures],\n\t};\n}\n"],"mappings":";;;;;;;;;;;;;;AA6BA,SAAgB,uBACf,OACA,WACmC;AACnC,KAAI,CAAC,SAAS,MAAM,CACnB,QAAO;CAGR,MAAM,eAAe,MAAM,0BAA0B,KAAA;AACrD,KAAI,iBAAiB,KAAA,KAAa,OAAO,iBAAiB,SACzD,QAAO;CAGR,MAAM,WAAW,MAAM;AACvB,KAAI,CAAC,MAAM,QAAQ,SAAS,CAC3B,QAAO;AAGR,MAAK,MAAM,WAAW,SACrB,KAAI,CAAC,UAAU,QAAQ,CACtB,QAAO;AAIT,QAAO;;;;;;;;;;;AAYR,SAAgB,qBACf,MAC0B;AAC1B,QAAO;EACN,qBAAqB,KAAK,uBAAuB,KAAA;EACjD,iBAAiB,CAAC,GAAG,KAAK,gBAAgB;EAC1C"}

package/dist/rate-limit-BBU_4xnZ.mjs

@@ -0,0 +1,135 @@
+//#region src/errors/base.ts
+/**
+* Base error class for all Open Cloud SDK errors.
+*
+* All specific error types (RateLimitError, ApiError, NetworkError)
+* extend this class, enabling `instanceof OpenCloudError` checks.
+*/
+var OpenCloudError = class extends Error {
+	name = "OpenCloudError";
+};
+//#endregion
+//#region src/errors/api-error.ts
+/**
+* Thrown when the Roblox Open Cloud API returns a non-2xx response
+* that is not a rate limit (429).
+*
+* @example
+*
+* ```ts
+* import { ApiError } from "@bedrock-rbx/ocale";
+*
+* const error = new ApiError("Game pass not found", {
+*     code: "NotFound",
+*     statusCode: 404,
+* });
+*
+* expect(error).toBeInstanceOf(ApiError);
+* expect(error.statusCode).toBe(404);
+* expect(error.code).toBe("NotFound");
+* ```
+*/
+var ApiError = class extends OpenCloudError {
+	code;
+	name = "ApiError";
+	statusCode;
+	/**
+	* Creates a new ApiError.
+	*
+	* @param message - Human-readable error description.
+	* @param options - Error options including status code and optional error code.
+	*/
+	constructor(message, options) {
+		super(message, options);
+		this.statusCode = options.statusCode;
+		this.code = options.code;
+	}
+};
+//#endregion
+//#region src/errors/network-error.ts
+/**
+* Thrown when a network-level failure prevents the request from reaching
+* the Roblox Open Cloud API (e.g., DNS resolution failure, connection timeout).
+*/
+var NetworkError = class extends OpenCloudError {
+	name = "NetworkError";
+};
+//#endregion
+//#region src/errors/permission-error.ts
+/**
+* Thrown when the Roblox Open Cloud API returns a 401 or 403 for an operation
+* whose required scopes are known. Subclass of {@link ApiError} carrying the
+* scope strings the caller's credential is missing plus the operation key, so
+* a CLI consumer can tell the user exactly which scope to grant on their API
+* key.
+*
+* @example
+*
+* ```ts
+* import { PermissionError } from "@bedrock-rbx/ocale";
+*
+* const error = new PermissionError("HTTP 403", {
+*     operationKey: "developer-products.create",
+*     requiredScopes: ["creator-store-product:write"],
+*     statusCode: 403,
+* });
+*
+* expect(error).toBeInstanceOf(PermissionError);
+* expect(error.requiredScopes).toStrictEqual(["creator-store-product:write"]);
+* expect(error.operationKey).toBe("developer-products.create");
+* ```
+*/
+var PermissionError = class extends ApiError {
+	name = "PermissionError";
+	operationKey;
+	requiredScopes;
+	/**
+	* Creates a new PermissionError.
+	*
+	* @param message - Human-readable error description.
+	* @param options - Error options including status code, the operation key,
+	*   and the scopes the caller's credential must carry.
+	*/
+	constructor(message, options) {
+		super(message, options);
+		this.operationKey = options.operationKey;
+		this.requiredScopes = options.requiredScopes;
+	}
+};
+//#endregion
+//#region src/errors/rate-limit.ts
+/**
+* Thrown when the Roblox Open Cloud API returns a 429 Too Many Requests response.
+* Contains the server-suggested retry delay.
+*
+* @example
+*
+* ```ts
+* import { RateLimitError } from "@bedrock-rbx/ocale";
+*
+* const error = new RateLimitError("Too many requests", {
+*     retryAfterSeconds: 30,
+* });
+*
+* expect(error).toBeInstanceOf(RateLimitError);
+* expect(error.retryAfterSeconds).toBe(30);
+* ```
+*/
+var RateLimitError = class extends OpenCloudError {
+	name = "RateLimitError";
+	retryAfterSeconds;
+	/**
+	* Creates a new RateLimitError.
+	*
+	* @param message - Human-readable error description.
+	* @param options - Error options including the retry delay.
+	*/
+	constructor(message, options) {
+		super(message, options);
+		this.retryAfterSeconds = options.retryAfterSeconds;
+	}
+};
+//#endregion
+export { OpenCloudError as a, ApiError as i, PermissionError as n, NetworkError as r, RateLimitError as t };
+
+//# sourceMappingURL=rate-limit-BBU_4xnZ.mjs.map

package/dist/rate-limit-BBU_4xnZ.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limit-BBU_4xnZ.mjs","names":[],"sources":["../src/errors/base.ts","../src/errors/api-error.ts","../src/errors/network-error.ts","../src/errors/permission-error.ts","../src/errors/rate-limit.ts"],"sourcesContent":["/**\n * Base error class for all Open Cloud SDK errors.\n *\n * All specific error types (RateLimitError, ApiError, NetworkError)\n * extend this class, enabling `instanceof OpenCloudError` checks.\n */\nexport class OpenCloudError extends Error {\n\tpublic override readonly name: string = \"OpenCloudError\";\n}\n","import { OpenCloudError } from \"./base.ts\";\n\n/**\n * Options for constructing an {@link ApiError}.\n */\nexport interface ApiErrorOptions extends ErrorOptions {\n\t/** Optional machine-readable error code from the API. */\n\tcode?: string | undefined;\n\t/** HTTP status code from the API response. */\n\tstatusCode: number;\n}\n\n/**\n * Thrown when the Roblox Open Cloud API returns a non-2xx response\n * that is not a rate limit (429).\n *\n * @example\n *\n * ```ts\n * import { ApiError } from \"@bedrock-rbx/ocale\";\n *\n * const error = new ApiError(\"Game pass not found\", {\n *     code: \"NotFound\",\n *     statusCode: 404,\n * });\n *\n * expect(error).toBeInstanceOf(ApiError);\n * expect(error.statusCode).toBe(404);\n * expect(error.code).toBe(\"NotFound\");\n * ```\n */\nexport class ApiError extends OpenCloudError {\n\tpublic readonly code: string | undefined;\n\tpublic override readonly name: string = \"ApiError\";\n\tpublic readonly statusCode: number;\n\n\t/**\n\t * Creates a new ApiError.\n\t *\n\t * @param message - Human-readable error description.\n\t * @param options - Error options including status code and optional error code.\n\t */\n\tconstructor(message: string, options: ApiErrorOptions) {\n\t\tsuper(message, options);\n\t\tthis.statusCode = options.statusCode;\n\t\tthis.code = options.code;\n\t}\n}\n","import { OpenCloudError } from \"./base.ts\";\n\n/**\n * Thrown when a network-level failure prevents the request from reaching\n * the Roblox Open Cloud API (e.g., DNS resolution failure, connection timeout).\n */\nexport class NetworkError extends OpenCloudError {\n\tpublic override readonly name: string = \"NetworkError\";\n}\n","import { ApiError, type ApiErrorOptions } from \"./api-error.ts\";\n\n/**\n * Options for constructing a {@link PermissionError}.\n */\nexport interface PermissionErrorOptions extends ApiErrorOptions {\n\t/**\n\t * Stable identifier of the Open Cloud operation that returned the\n\t * permission failure (matches `OperationLimit.operationKey`, e.g.\n\t * `\"developer-products.create\"`).\n\t */\n\toperationKey: string;\n\t/**\n\t * Scope strings the API key or OAuth token must carry for the failing\n\t * operation, sourced from the vendored OpenAPI schema's `x-roblox-scopes`\n\t * for that operationId.\n\t */\n\trequiredScopes: ReadonlyArray<string>;\n}\n\n/**\n * Thrown when the Roblox Open Cloud API returns a 401 or 403 for an operation\n * whose required scopes are known. Subclass of {@link ApiError} carrying the\n * scope strings the caller's credential is missing plus the operation key, so\n * a CLI consumer can tell the user exactly which scope to grant on their API\n * key.\n *\n * @example\n *\n * ```ts\n * import { PermissionError } from \"@bedrock-rbx/ocale\";\n *\n * const error = new PermissionError(\"HTTP 403\", {\n *     operationKey: \"developer-products.create\",\n *     requiredScopes: [\"creator-store-product:write\"],\n *     statusCode: 403,\n * });\n *\n * expect(error).toBeInstanceOf(PermissionError);\n * expect(error.requiredScopes).toStrictEqual([\"creator-store-product:write\"]);\n * expect(error.operationKey).toBe(\"developer-products.create\");\n * ```\n */\nexport class PermissionError extends ApiError {\n\tpublic override readonly name: string = \"PermissionError\";\n\tpublic readonly operationKey: string;\n\tpublic readonly requiredScopes: ReadonlyArray<string>;\n\n\t/**\n\t * Creates a new PermissionError.\n\t *\n\t * @param message - Human-readable error description.\n\t * @param options - Error options including status code, the operation key,\n\t *   and the scopes the caller's credential must carry.\n\t */\n\tconstructor(message: string, options: PermissionErrorOptions) {\n\t\tsuper(message, options);\n\t\tthis.operationKey = options.operationKey;\n\t\tthis.requiredScopes = options.requiredScopes;\n\t}\n}\n","import { OpenCloudError } from \"./base.ts\";\n\n/**\n * Options for constructing a {@link RateLimitError}.\n */\nexport interface RateLimitErrorOptions extends ErrorOptions {\n\t/** Seconds to wait before retrying the request. */\n\tretryAfterSeconds: number;\n}\n\n/**\n * Thrown when the Roblox Open Cloud API returns a 429 Too Many Requests response.\n * Contains the server-suggested retry delay.\n *\n * @example\n *\n * ```ts\n * import { RateLimitError } from \"@bedrock-rbx/ocale\";\n *\n * const error = new RateLimitError(\"Too many requests\", {\n *     retryAfterSeconds: 30,\n * });\n *\n * expect(error).toBeInstanceOf(RateLimitError);\n * expect(error.retryAfterSeconds).toBe(30);\n * ```\n */\nexport class RateLimitError extends OpenCloudError {\n\tpublic override readonly name = \"RateLimitError\";\n\tpublic readonly retryAfterSeconds: number;\n\n\t/**\n\t * Creates a new RateLimitError.\n\t *\n\t * @param message - Human-readable error description.\n\t * @param options - Error options including the retry delay.\n\t */\n\tconstructor(message: string, options: RateLimitErrorOptions) {\n\t\tsuper(message, options);\n\t\tthis.retryAfterSeconds = options.retryAfterSeconds;\n\t}\n}\n"],"mappings":";;;;;;;AAMA,IAAa,iBAAb,cAAoC,MAAM;CACzC,OAAwC;;;;;;;;;;;;;;;;;;;;;;;ACwBzC,IAAa,WAAb,cAA8B,eAAe;CAC5C;CACA,OAAwC;CACxC;;;;;;;CAQA,YAAY,SAAiB,SAA0B;AACtD,QAAM,SAAS,QAAQ;AACvB,OAAK,aAAa,QAAQ;AAC1B,OAAK,OAAO,QAAQ;;;;;;;;;ACvCtB,IAAa,eAAb,cAAkC,eAAe;CAChD,OAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;ACoCzC,IAAa,kBAAb,cAAqC,SAAS;CAC7C,OAAwC;CACxC;CACA;;;;;;;;CASA,YAAY,SAAiB,SAAiC;AAC7D,QAAM,SAAS,QAAQ;AACvB,OAAK,eAAe,QAAQ;AAC5B,OAAK,iBAAiB,QAAQ;;;;;;;;;;;;;;;;;;;;;;AC/BhC,IAAa,iBAAb,cAAoC,eAAe;CAClD,OAAgC;CAChC;;;;;;;CAQA,YAAY,SAAiB,SAAgC;AAC5D,QAAM,SAAS,QAAQ;AACvB,OAAK,oBAAoB,QAAQ"}