@bedrock-rbx/ocale 0.1.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1 @@
1
+ {"version":3,"file":"resource-client-CaS_j3yg.mjs","names":["#hooks","#intervalMs","#maxBucketLevel","#sleep","#chain","#waitForToken","#lastCheck","#bucketLevel","#config","#hooks","#httpClient","#queues","#sleep","#getQueue"],"sources":["../src/internal/utils/is-record.ts","../src/internal/http/retry.ts","../src/internal/http/execute.ts","../src/internal/http/rate-limit-queue.ts","../src/internal/utils/try-catch.ts","../src/internal/http/fetch-client.ts","../src/internal/http/resolve-dependencies.ts","../src/internal/resource-client.ts"],"sourcesContent":["/**\n * Narrows `value` to a plain JSON-style record. Excludes arrays, class\n * instances, primitives, and `null`/`undefined`. Used by resource\n * parsers to gate property access on wire bodies whose shape isn't\n * known at compile time.\n *\n * @param value - The unknown value to narrow.\n * @returns `true` when `value` is a plain `[object Object]`.\n */\nexport function isRecord(value: unknown): value is Record<string, unknown> {\n\treturn Object.prototype.toString.call(value) === \"[object Object]\";\n}\n","import { ApiError } from \"../../errors/api-error.ts\";\nimport { RateLimitError } from \"../../errors/rate-limit.ts\";\n\n/**\n * Fully-resolved retry config shape that {@link mergeConfig} and\n * {@link shouldRetry} operate on. Fields are required because this represents\n * the post-defaulting, internal view — callers should supply every field (or\n * resolve them via a test factory / client constructor). The partial,\n * user-facing type lives on client construction options; method defaults and\n * per-request overrides use `Partial<RetryResolvable>`.\n */\nexport interface RetryResolvable {\n\t/** Roblox Open Cloud API key. */\n\treadonly apiKey: string;\n\t/** Base URL for the Open Cloud API. */\n\treadonly baseUrl: string;\n\t/** Maximum retry attempts before giving up. */\n\treadonly maxRetries: number;\n\t/** Status codes that are eligible for retry. */\n\treadonly retryableStatuses: ReadonlyArray<number>;\n\t/** Fallback delay function when no server hint is available. */\n\treadonly retryDelay: (attempt: number) => number;\n\t/** Per-request timeout in milliseconds. */\n\treadonly timeout: number;\n}\n\n/**\n * Default retry status codes for idempotent operations (read, list, update,\n * delete). Safe to retry on both rate limits and transient server errors.\n */\nexport const IDEMPOTENT_METHOD_DEFAULTS: Readonly<Pick<RetryResolvable, \"retryableStatuses\">> =\n\tObject.freeze({\n\t\tretryableStatuses: Object.freeze([429, 500, 502, 503, 504] as const),\n\t});\n\n/**\n * Default retry status codes for create operations. Retries rate limits only,\n * to prevent duplicate resources on 5xx (Roblox Open Cloud has no\n * idempotency-key support).\n */\nexport const CREATE_METHOD_DEFAULTS: Readonly<Pick<RetryResolvable, \"retryableStatuses\">> =\n\tObject.freeze({\n\t\tretryableStatuses: Object.freeze([429] as const),\n\t});\n\n/** Kind of HTTP method the merge is being performed for. */\nexport type MethodKind = \"create\" | \"idempotent\";\n\n/**\n * Options for {@link mergeConfig}.\n *\n * @template T - Concrete `RetryResolvable` subtype being merged.\n */\ninterface MergeConfigOptions<T> {\n\t/** Method-level defaults (e.g. {@link CREATE_METHOD_DEFAULTS}). */\n\treadonly methodDefaults: Partial<T>;\n\t/** Whether the method is a create or idempotent operation. */\n\treadonly methodKind: MethodKind;\n\t/** Optional per-request overrides; always win when provided. */\n\treadonly requestOptions?: Partial<T>;\n}\n\n/**\n * Options for {@link computeRetryWaitMs}.\n */\ninterface ComputeRetryWaitMsOptions {\n\t/** Zero-indexed retry attempt number. */\n\treadonly attempt: number;\n\t/** Fallback delay function when no server hint is available. */\n\treadonly retryDelay: (attempt: number) => number;\n}\n\n/**\n * Default exponential backoff: 1s → 2s → 4s → 8s → 16s → 30s (capped).\n *\n * @example\n *\n * ```ts\n * import { defaultRetryDelay } from \"./retry\";\n *\n * expect(defaultRetryDelay(0)).toBe(1000);\n * expect(defaultRetryDelay(4)).toBe(16_000);\n * expect(defaultRetryDelay(10)).toBe(30_000);\n * ```\n *\n * @param attempt - Zero-indexed retry attempt number.\n * @returns Wait duration in milliseconds.\n */\nexport function defaultRetryDelay(attempt: number): number {\n\treturn Math.min(1000 * 2 ** attempt, 30_000);\n}\n\n/**\n * Computes how long to wait before the next retry. Prefers the server's\n * suggested delay when the error is a {@link RateLimitError} with a positive\n * `retryAfterSeconds`; otherwise falls through to `retryDelay(attempt)`.\n *\n * @example\n *\n * ```ts\n * import { RateLimitError } from \"../../errors/rate-limit.ts\";\n * import { computeRetryWaitMs, defaultRetryDelay } from \"./retry\";\n *\n * const error = new RateLimitError(\"slow down\", { retryAfterSeconds: 3 });\n *\n * expect(computeRetryWaitMs(error, { attempt: 0, retryDelay: defaultRetryDelay })).toBe(\n * 3000,\n * );\n * ```\n *\n * @example\n *\n * ```ts\n * import { ApiError } from \"../../errors/api-error.ts\";\n * import { computeRetryWaitMs, defaultRetryDelay } from \"./retry\";\n *\n * const error = new ApiError(\"server error\", { statusCode: 503 });\n *\n * expect(computeRetryWaitMs(error, { attempt: 2, retryDelay: defaultRetryDelay })).toBe(\n * 4000,\n * );\n * ```\n *\n * @param error - The error returned by the failing request.\n * @param options - Retry attempt index and fallback delay function.\n * @returns Wait duration in milliseconds before the next attempt.\n */\nexport function computeRetryWaitMs(\n\terror: ApiError | RateLimitError,\n\toptions: ComputeRetryWaitMsOptions,\n): number {\n\tif (error instanceof RateLimitError && error.retryAfterSeconds > 0) {\n\t\treturn error.retryAfterSeconds * 1000;\n\t}\n\n\treturn options.retryDelay(options.attempt);\n}\n\n/**\n * Decides whether a failed request is eligible for retry under the given\n * `retryableStatuses`. Only {@link RateLimitError} (checked against 429) and\n * {@link ApiError} (checked against its `statusCode`) are retryable — network\n * errors and other failures always return `false`.\n *\n * @example\n *\n * ```ts\n * import { RateLimitError } from \"../../errors/rate-limit.ts\";\n * import { shouldRetry } from \"./retry\";\n *\n * const error = new RateLimitError(\"\", { retryAfterSeconds: 1 });\n *\n * expect(shouldRetry(error, { retryableStatuses: [429] })).toBe(true);\n * ```\n *\n * @example\n *\n * ```ts\n * import { ApiError } from \"../../errors/api-error.ts\";\n * import { shouldRetry } from \"./retry\";\n *\n * const error = new ApiError(\"\", { statusCode: 503 });\n *\n * expect(shouldRetry(error, { retryableStatuses: [429, 500, 502, 503, 504] })).toBe(\n * true,\n * );\n * ```\n *\n * @example\n *\n * ```ts\n * import { NetworkError } from \"../../errors/network-error.ts\";\n * import { shouldRetry } from \"./retry\";\n *\n * const error = new NetworkError(\"offline\");\n *\n * expect(shouldRetry(error, { retryableStatuses: [429] })).toBe(false);\n * ```\n *\n * @param error - The error returned by the failing request.\n * @param config - Object carrying the retry-eligible status list.\n * @returns `true` if the error should be retried, `false` otherwise.\n */\nexport function shouldRetry(\n\terror: unknown,\n\tconfig: { readonly retryableStatuses: ReadonlyArray<number> },\n): error is ApiError | RateLimitError {\n\tif (error instanceof RateLimitError) {\n\t\treturn config.retryableStatuses.includes(429);\n\t}\n\n\tif (error instanceof ApiError) {\n\t\treturn config.retryableStatuses.includes(error.statusCode);\n\t}\n\n\treturn false;\n}\n\n/**\n * Resolves the effective config for a single request by shallow-merging the\n * client config, method defaults, and per-request options. Precedence depends\n * on `methodKind`:\n *\n * - `\"create\"`: method defaults override client config, so client-level\n * settings cannot silently relax create-method safety. Only explicit\n * per-request `requestOptions` can.\n * - `\"idempotent\"`: client config overrides method defaults, so consumers\n * can loosen or tighten retry policy globally. `requestOptions` still wins\n * when provided.\n *\n * Array-valued fields like `retryableStatuses` are *replaced*, not extended.\n *\n * @template T - Concrete `RetryResolvable` subtype being merged.\n *\n * @example\n *\n * ```ts\n * import {\n * CREATE_METHOD_DEFAULTS,\n * defaultRetryDelay,\n * mergeConfig,\n * type RetryResolvable,\n * } from \"./retry\";\n *\n * const clientConfig: RetryResolvable = {\n * apiKey: \"k\",\n * baseUrl: \"https://apis.roblox.com\",\n * maxRetries: 3,\n * retryableStatuses: [429, 500],\n * retryDelay: defaultRetryDelay,\n * timeout: 30_000,\n * };\n *\n * const merged = mergeConfig(clientConfig, {\n * methodDefaults: CREATE_METHOD_DEFAULTS,\n * methodKind: \"create\",\n * });\n *\n * expect(merged.retryableStatuses).toStrictEqual([429]);\n * ```\n *\n * @example\n *\n * ```ts\n * import {\n * defaultRetryDelay,\n * IDEMPOTENT_METHOD_DEFAULTS,\n * mergeConfig,\n * type RetryResolvable,\n * } from \"./retry\";\n *\n * const clientConfig: RetryResolvable = {\n * apiKey: \"k\",\n * baseUrl: \"https://apis.roblox.com\",\n * maxRetries: 3,\n * retryableStatuses: [429],\n * retryDelay: defaultRetryDelay,\n * timeout: 30_000,\n * };\n *\n * const merged = mergeConfig(clientConfig, {\n * methodDefaults: IDEMPOTENT_METHOD_DEFAULTS,\n * methodKind: \"idempotent\",\n * requestOptions: { timeout: 10_000 },\n * });\n *\n * expect(merged.retryableStatuses).toStrictEqual([429]);\n * expect(merged.timeout).toBe(10_000);\n * ```\n *\n * @param clientConfig - Config frozen at client construction.\n * @param options - Method defaults, method kind, and optional per-request overrides.\n * @returns A new merged config object. Inputs are not mutated.\n */\nexport function mergeConfig<T extends RetryResolvable>(\n\tclientConfig: T,\n\toptions: MergeConfigOptions<T>,\n): T {\n\tconst { methodDefaults, methodKind, requestOptions } = options;\n\n\tswitch (methodKind) {\n\t\tcase \"create\": {\n\t\t\treturn { ...clientConfig, ...methodDefaults, ...requestOptions };\n\t\t}\n\t\tcase \"idempotent\": {\n\t\t\treturn { ...methodDefaults, ...clientConfig, ...requestOptions };\n\t\t}\n\t\tdefault: {\n\t\t\tconst exhaustive: never = methodKind;\n\t\t\tthrow new Error(`Unexpected methodKind: ${String(exhaustive)}`);\n\t\t}\n\t}\n}\n","import type { OpenCloudError } from \"../../errors/base.ts\";\nimport type { Result } from \"../../types.ts\";\nimport type { SleepFunc } from \"../utils/sleep.ts\";\nimport { computeRetryWaitMs, type RetryResolvable, shouldRetry } from \"./retry.ts\";\nimport type { HttpRequest, HttpResponse, OpenCloudHooks } from \"./types.ts\";\n\n/** A transport callback: takes a request, returns a classified Result. */\ntype SendFunc = (request: HttpRequest) => Promise<Result<HttpResponse, OpenCloudError>>;\n\n/**\n * Inputs to {@link executeWithRetry} bundled as an options object to keep the\n * function signature narrow.\n */\ninterface ExecuteOptions {\n\t/** Fully-resolved retry config (post-merge). */\n\treadonly config: RetryResolvable;\n\t/** Client-level observability hooks. */\n\treadonly hooks: OpenCloudHooks;\n\t/** Transport callback. May be pre-wrapped by a rate-limit queue. */\n\treadonly send: SendFunc;\n\t/** Injectable sleep (tests pass a fake). */\n\treadonly sleep: SleepFunc;\n}\n\n/**\n * Retry-aware orchestration loop. Coordinates a single logical request,\n * looping over `options.send` until it succeeds, the error is non-retryable,\n * or `options.config.maxRetries` is exhausted. Fires observability hooks\n * at each transition. Domain- and queue-agnostic: `send` may be any\n * callback, including one wrapped by a rate-limit queue.\n *\n * @param request - The immutable request to send.\n * @param options - The transport callback, resolved config, hooks, and sleep.\n * @returns The first success, or the final error after retries are exhausted.\n */\nexport async function executeWithRetry(\n\trequest: HttpRequest,\n\toptions: ExecuteOptions,\n): Promise<Result<HttpResponse, OpenCloudError>> {\n\tconst { config, hooks, send, sleep } = options;\n\n\tasync function attempt(): Promise<Result<HttpResponse, OpenCloudError>> {\n\t\thooks.onRequest?.(request);\n\t\treturn send(request);\n\t}\n\n\tlet result = await attempt();\n\n\tfor (let retry = 0; retry < config.maxRetries; retry++) {\n\t\tif (result.success || !shouldRetry(result.err, config)) {\n\t\t\treturn result;\n\t\t}\n\n\t\tconst { err } = result;\n\t\thooks.onRetry?.(retry + 1, err);\n\t\tconst waitMs = computeRetryWaitMs(err, { attempt: retry, retryDelay: config.retryDelay });\n\t\thooks.onRateLimit?.(waitMs);\n\t\tawait sleep(waitMs);\n\n\t\tresult = await attempt();\n\t}\n\n\treturn result;\n}\n","import type { SleepFunc } from \"../utils/sleep.ts\";\nimport type { OpenCloudHooks } from \"./types.ts\";\n\n/**\n * Identifies and bounds a single Roblox Open Cloud operation for rate\n * limiting, e.g. `{ operationKey: \"game-passes.create\", maxPerSecond: 5 }`.\n */\nexport interface OperationLimit {\n\t/** Maximum sustained request rate in requests per second. */\n\treadonly maxPerSecond: number;\n\t/**\n\t * Stable identifier for the operation (e.g. \"game-passes.create\"). Not\n\t * consumed by the queue itself; callers use it to key per-operation\n\t * queues in a registry (see GamePassesClient).\n\t */\n\treadonly operationKey: string;\n}\n\n/**\n * Token-bucket rate limiter for a single `(apiKey, operation)` pair. Every\n * call to `acquire` consumes one token; when the bucket is empty the call\n * waits until a token regenerates before invoking the task. Burst capacity\n * equals `maxPerSecond`, refilling at `maxPerSecond` tokens per second.\n *\n * Implemented as a leaky bucket tracking drain debt in ms. `#lastCheck`\n * advances by `waitMs` after every sleep so the algorithm stays correct\n * whether or not the injected sleep moves `Date.now()` forward.\n */\nexport class RateLimitQueue {\n\treadonly #hooks: OpenCloudHooks;\n\treadonly #intervalMs: number;\n\treadonly #maxBucketLevel: number;\n\treadonly #sleep: SleepFunc;\n\n\t#bucketLevel = 0;\n\t#chain: Promise<void> = Promise.resolve();\n\t#lastCheck: number = Date.now();\n\n\t/**\n\t * Creates a rate-limit queue bound to a single operation.\n\t *\n\t * @param limit - The operation key and its per-second request ceiling.\n\t * @param hooks - Observability callbacks; `onRateLimit` fires when the\n\t * bucket is empty and a sleep is about to start.\n\t * @param sleep - Injectable sleep (tests pass a fake).\n\t */\n\tconstructor(limit: OperationLimit, hooks: OpenCloudHooks, sleep: SleepFunc) {\n\t\tthis.#intervalMs = 1000 / limit.maxPerSecond;\n\t\tthis.#maxBucketLevel = limit.maxPerSecond * this.#intervalMs;\n\t\tthis.#hooks = hooks;\n\t\tthis.#sleep = sleep;\n\t}\n\n\t/**\n\t * Waits for a token — sleeping and firing `hooks.onRateLimit` if the\n\t * bucket is empty — then executes `task`. Concurrent callers are\n\t * serialized at token acquisition; tasks themselves run independently\n\t * once their token is secured.\n\t *\n\t * @param task - The request to run once a token is available.\n\t * @returns The value produced by `task`.\n\t */\n\tpublic async acquire<T>(task: () => Promise<T>): Promise<T> {\n\t\tconst myTurn = this.#chain.then(async () => this.#waitForToken());\n\t\tthis.#chain = myTurn;\n\t\tawait myTurn;\n\t\treturn task();\n\t}\n\n\tasync #waitForToken(): Promise<void> {\n\t\tconst now = Math.max(Date.now(), this.#lastCheck);\n\t\tconst drained = Math.max(0, this.#bucketLevel - (now - this.#lastCheck));\n\t\tthis.#lastCheck = now;\n\n\t\tif (drained + this.#intervalMs <= this.#maxBucketLevel) {\n\t\t\tthis.#bucketLevel = drained + this.#intervalMs;\n\t\t\treturn;\n\t\t}\n\n\t\tconst waitMs = drained + this.#intervalMs - this.#maxBucketLevel;\n\t\tthis.#hooks.onRateLimit?.(waitMs);\n\t\tawait this.#sleep(waitMs);\n\t\tthis.#bucketLevel = this.#maxBucketLevel;\n\t\tthis.#lastCheck = now + waitMs;\n\t}\n}\n","import type { Result } from \"../../types.ts\";\n\n/**\n * Wraps a promise into a {@link Result}, catching rejections.\n *\n * @template T - The resolved value type.\n * @param promise - The promise to wrap.\n * @returns A Result containing the resolved value or the rejection error.\n */\nexport async function tryCatch<T>(promise: Promise<T>): Promise<Result<T>> {\n\ttry {\n\t\tconst data = await promise;\n\t\treturn { data, success: true };\n\t} catch (err) {\n\t\treturn { err: err instanceof Error ? err : new Error(String(err)), success: false };\n\t}\n}\n","import { ApiError } from \"../../errors/api-error.ts\";\nimport type { OpenCloudError } from \"../../errors/base.ts\";\nimport { NetworkError } from \"../../errors/network-error.ts\";\nimport { RateLimitError } from \"../../errors/rate-limit.ts\";\nimport type { Result } from \"../../types.ts\";\nimport { tryCatch } from \"../utils/try-catch.ts\";\nimport type { HttpClient, HttpRequest, HttpResponse, RequestConfig } from \"./types.ts\";\n\n/**\n * Converts a `Headers` object to a plain record with lowercased keys.\n *\n * @param headers - The `Headers` instance to convert.\n * @returns A record mapping lowercased header names to their values.\n */\nexport function headersToRecord(headers: Headers): Record<string, string> {\n\treturn Object.fromEntries(headers);\n}\n\n/**\n * Permissively extracts a top-level `errorCode` string field from a\n * response body.\n *\n * @param body - The parsed response body (unknown shape).\n * @returns The `errorCode` string if present, otherwise `undefined`.\n */\nexport function extractErrorCode(body: unknown): string | undefined {\n\tif (body === null || typeof body !== \"object\") {\n\t\treturn undefined;\n\t}\n\n\tconst errorCode: unknown = Reflect.get(body, \"errorCode\");\n\treturn typeof errorCode === \"string\" ? errorCode : undefined;\n}\n\n/**\n * Parses the `x-ratelimit-reset` header value into seconds.\n *\n * @param headerValue - The raw header value, or `undefined` if missing.\n * @returns The number of seconds to wait, or 0 if missing/invalid.\n */\nexport function parseRetryAfterSeconds(headerValue: string | undefined): number {\n\tconst parsed = Number(headerValue);\n\tif (Number.isNaN(parsed)) {\n\t\treturn 0;\n\t}\n\n\treturn Math.max(0, Math.floor(parsed));\n}\n\n/**\n * Joins the base URL from config with the relative path from the request.\n *\n * @param request - The HTTP request containing the relative URL.\n * @param config - The request config containing the base URL.\n * @returns The fully-qualified URL string.\n */\nexport function buildUrl(request: HttpRequest, config: RequestConfig): string {\n\tconst base = config.baseUrl.endsWith(\"/\") ? config.baseUrl.slice(0, -1) : config.baseUrl;\n\treturn `${base}${request.url}`;\n}\n\n/**\n * Constructs the `RequestInit` options for a `fetch` call.\n *\n * @param request - The HTTP request to build options for.\n * @param config - The request config containing API key and timeout.\n * @returns A `RequestInit` object ready for `fetch`.\n */\nexport function buildFetchOptions(request: HttpRequest, config: RequestConfig): RequestInit {\n\tconst headers = new Headers({\n\t\t\"x-api-key\": config.apiKey,\n\t});\n\n\tconst options: RequestInit = {\n\t\theaders,\n\t\tmethod: request.method,\n\t};\n\n\tif (request.body instanceof FormData) {\n\t\toptions.body = request.body;\n\t} else if (request.body instanceof Uint8Array) {\n\t\theaders.set(\"content-type\", \"application/octet-stream\");\n\t\toptions.body = request.body;\n\t} else if (request.body !== undefined) {\n\t\theaders.set(\"content-type\", \"application/json\");\n\t\toptions.body = JSON.stringify(request.body);\n\t}\n\n\tif (request.headers !== undefined) {\n\t\tfor (const [name, value] of Object.entries(request.headers)) {\n\t\t\tif (name.toLowerCase() === \"x-api-key\") {\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\theaders.set(name, value);\n\t\t}\n\t}\n\n\tif (config.timeout !== undefined) {\n\t\toptions.signal = AbortSignal.timeout(config.timeout);\n\t}\n\n\treturn options;\n}\n\n/**\n * Creates an {@link HttpClient} backed by the Fetch API.\n *\n * @param fetchFunc - The fetch implementation to use. Defaults to `globalThis.fetch`.\n * @returns An HttpClient that classifies responses into typed Results.\n */\nexport function createFetchHttpClient(\n\tfetchFunc: (url: string, init: RequestInit) => Promise<Response> = globalThis.fetch,\n): HttpClient {\n\treturn {\n\t\tasync request(\n\t\t\thttpRequest: HttpRequest,\n\t\t\tconfig: RequestConfig,\n\t\t): Promise<Result<HttpResponse, OpenCloudError>> {\n\t\t\tconst url = buildUrl(httpRequest, config);\n\t\t\tconst options = buildFetchOptions(httpRequest, config);\n\n\t\t\tconst fetchResult = await tryCatch(fetchFunc(url, options));\n\t\t\tif (!fetchResult.success) {\n\t\t\t\treturn {\n\t\t\t\t\terr: new NetworkError(\"Network request failed\", { cause: fetchResult.err }),\n\t\t\t\t\tsuccess: false,\n\t\t\t\t};\n\t\t\t}\n\n\t\t\treturn classifyResponse(fetchResult.data);\n\t\t},\n\t};\n}\n\nfunction createApiError(status: number, body: unknown): ApiError {\n\treturn new ApiError(`HTTP ${status}`, {\n\t\tcode: extractErrorCode(body),\n\t\tstatusCode: status,\n\t});\n}\n\n/**\n * Classifies a fetch `Response` into a typed `Result`.\n *\n * @param response - The raw fetch Response to classify.\n * @returns A Result containing an HttpResponse on success or an OpenCloudError on failure.\n */\nfunction createRateLimitError(response: Response): RateLimitError {\n\treturn new RateLimitError(\"Rate limited\", {\n\t\tretryAfterSeconds: parseRetryAfterSeconds(\n\t\t\tresponse.headers.get(\"x-ratelimit-reset\") ?? undefined,\n\t\t),\n\t});\n}\n\nasync function readResponseBody(response: Response): Promise<Result<unknown, OpenCloudError>> {\n\ttry {\n\t\tconst text = await response.text();\n\t\treturn { data: text === \"\" ? undefined : JSON.parse(text), success: true };\n\t} catch {\n\t\treturn {\n\t\t\terr: new ApiError(\"Failed to parse response body\", { statusCode: response.status }),\n\t\t\tsuccess: false,\n\t\t};\n\t}\n}\n\nasync function classifyResponse(response: Response): Promise<Result<HttpResponse, OpenCloudError>> {\n\tif (response.status === 429) {\n\t\treturn { err: createRateLimitError(response), success: false };\n\t}\n\n\tconst bodyResult = await readResponseBody(response);\n\tif (!bodyResult.success) {\n\t\treturn bodyResult;\n\t}\n\n\tif (response.status >= 300) {\n\t\treturn { err: createApiError(response.status, bodyResult.data), success: false };\n\t}\n\n\treturn {\n\t\tdata: {\n\t\t\tbody: bodyResult.data,\n\t\t\theaders: headersToRecord(response.headers),\n\t\t\tstatus: response.status,\n\t\t},\n\t\tsuccess: true,\n\t};\n}\n","import { setTimeout } from \"node:timers/promises\";\n\nimport type { HttpClient, SleepFunc } from \"../../client/types.ts\";\nimport { createFetchHttpClient } from \"./fetch-client.ts\";\n\n/**\n * Options accepted by {@link resolveDependencies}. Mirrors the test-seam\n * subset of the public client options.\n */\ninterface ResolveDependenciesOptions {\n\t/** Test seam: custom {@link HttpClient}. Defaults to a fetch-backed client. */\n\treadonly httpClient?: HttpClient | undefined;\n\t/** Test seam: custom {@link SleepFunc}. Defaults to a `setTimeout`-backed sleep. */\n\treadonly sleep?: SleepFunc | undefined;\n}\n\n/**\n * Fully-populated dependency set consumed by resource client constructors.\n */\ninterface ResolvedDependencies {\n\t/** Concrete {@link HttpClient} implementation. */\n\treadonly httpClient: HttpClient;\n\t/** Concrete {@link SleepFunc} implementation. */\n\treadonly sleep: SleepFunc;\n}\n\n/**\n * Resolves the concrete HTTP client and sleep implementation a resource\n * client should use. Falls back to the fetch-backed HTTP client and the\n * default `setTimeout`-based sleep when the caller omits the test seams.\n *\n * Extracted so resource client constructors can keep their dependency\n * resolution logic in a single, unit-testable place; this makes the\n * default branches easy to cover without stubbing globals like `fetch`.\n *\n * @param options - Optional {@link HttpClient} and {@link SleepFunc} test seams.\n * @returns A {@link ResolvedDependencies} with defaults applied.\n */\nexport function resolveDependencies(options: ResolveDependenciesOptions): ResolvedDependencies {\n\treturn {\n\t\thttpClient: options.httpClient ?? createFetchHttpClient(),\n\t\tsleep: options.sleep ?? setTimeout,\n\t};\n}\n","import type { Except } from \"type-fest\";\n\nimport type {\n\tHttpClient,\n\tHttpRequest,\n\tHttpResponse,\n\tOpenCloudClientOptions,\n\tOpenCloudHooks,\n\tRequestOptions,\n\tSleepFunc,\n} from \"../client/types.ts\";\nimport { ApiError } from \"../errors/api-error.ts\";\nimport type { OpenCloudError } from \"../errors/base.ts\";\nimport { PermissionError } from \"../errors/permission-error.ts\";\nimport type { Result } from \"../types.ts\";\nimport { executeWithRetry } from \"./http/execute.ts\";\nimport { type OperationLimit, RateLimitQueue } from \"./http/rate-limit-queue.ts\";\nimport { resolveDependencies } from \"./http/resolve-dependencies.ts\";\nimport {\n\tdefaultRetryDelay,\n\tIDEMPOTENT_METHOD_DEFAULTS,\n\tmergeConfig,\n\ttype MethodKind,\n\ttype RetryResolvable,\n} from \"./http/retry.ts\";\n\n/**\n * Describes a single resource method's shape for dispatch through\n * `ResourceClient.execute`. Each resource client declares one module-level\n * constant per public method; that constant binds the four resource-specific\n * values (request builder, response parser, retry-policy method kind,\n * operation-level rate limit) and flows through `execute` uniformly.\n *\n * @template P - The resource-specific parameter shape the builder\n * accepts.\n * @template T - The resource-specific parsed success type the parser\n * produces.\n */\nexport interface ResourceMethodSpec<P, T> {\n\t/**\n\t * Builds the pure {@link HttpRequest} for a single call. Returns a\n\t * {@link Result} so a builder can short-circuit with a local error\n\t * (typically a {@link OpenCloudError} subclass such as `ValidationError`)\n\t * before any HTTP, queue, or retry work happens. Builders that cannot\n\t * fail wrap their return as `{ data: request, success: true }`.\n\t */\n\treadonly buildRequest: (parameters: P) => Result<HttpRequest, OpenCloudError>;\n\t/** Method-level retry defaults merged into the resolved config. */\n\treadonly methodDefaults: Partial<RetryResolvable>;\n\t/**\n\t * Method kind, controlling merge precedence: `\"create\"` lets method\n\t * defaults win over client config so create safety cannot be relaxed\n\t * silently; `\"idempotent\"` lets client config win over method defaults\n\t * so consumers can loosen retry globally.\n\t */\n\treadonly methodKind: MethodKind;\n\t/** Operation-level rate limit, keyed into the client's per-key queue map. */\n\treadonly operationLimit: OperationLimit;\n\t/**\n\t * Converts the full {@link HttpResponse} into the resource-specific\n\t * parsed shape. Takes the whole response (body, status, headers) so\n\t * future parsers can read headers without widening the signature.\n\t */\n\treadonly parse: (response: HttpResponse) => Result<T, OpenCloudError>;\n\t/**\n\t * Open Cloud scopes the API key or OAuth token must carry for this\n\t * method, sourced from the vendored OpenAPI schema's `x-roblox-scopes`.\n\t * When set, a 401 or 403 ApiError from the upstream call is upgraded to\n\t * a {@link PermissionError} carrying these scopes alongside\n\t * {@link OperationLimit.operationKey}, so callers can name the missing\n\t * scope instead of just the HTTP status. Optional so test specs and\n\t * not-yet-wired resources can opt out.\n\t */\n\treadonly requiredScopes?: ReadonlyArray<string>;\n}\n\n/**\n * Single-argument bundle consumed by `ResourceClient.execute`: the per-method\n * spec, the resource-specific parameters, and optional per-request config\n * overrides.\n *\n * @template P - The resource-specific parameter shape the builder accepts.\n * @template T - The resource-specific parsed success type the parser produces.\n */\ninterface ExecuteCall<P, T> {\n\t/** Optional per-request config overrides. */\n\treadonly options?: RequestOptions | undefined;\n\t/** Resource-specific request parameters. */\n\treadonly parameters: P;\n\t/** Per-method binding of builder, parser, method kind, and operation limit. */\n\treadonly spec: ResourceMethodSpec<P, T>;\n}\n\n/**\n * Wraps an infallible request build as a {@link Result}-returning\n * `buildRequest` callback compatible with {@link ResourceMethodSpec}.\n * Use from a resource client whose builder cannot fail; resource clients\n * with local validation should construct the {@link Result} directly.\n *\n * @param request - The pre-built {@link HttpRequest}.\n * @returns A success Result wrapping the request.\n */\nexport function okRequest(request: HttpRequest): Result<HttpRequest, OpenCloudError> {\n\treturn { data: request, success: true };\n}\n\n/**\n * A {@link ResourceMethodSpec.parse} implementation for endpoints that return\n * no business payload on success (such as `DELETE` and reorder operations).\n * Surfaces `undefined` data and never inspects the response body.\n *\n * @returns A success Result with `undefined` data.\n */\nexport function parseEmptyResponse(): Result<undefined, OpenCloudError> {\n\treturn { data: undefined, success: true };\n}\n\nconst CLIENT_DEFAULTS = Object.freeze({\n\tbaseUrl: \"https://apis.roblox.com\",\n\tmaxRetries: 3,\n\tretryableStatuses: IDEMPOTENT_METHOD_DEFAULTS.retryableStatuses,\n\tretryDelay: defaultRetryDelay,\n\ttimeout: 30_000,\n} satisfies Except<RetryResolvable, \"apiKey\">);\n\n/**\n * Internal orchestrator shared by every Open Cloud resource client. Holds\n * the frozen client config, observability hooks, injected HTTP client and\n * sleep, and the per-effective-key rate-limit queue registry. Resource\n * classes compose one instance and dispatch every public method through\n * {@link ResourceClient.execute} with a per-method {@link ResourceMethodSpec}.\n * Not exported from any package subpath; reachable only via sibling\n * `src/resources/**` modules in this package.\n */\nexport class ResourceClient {\n\treadonly #config: Readonly<RetryResolvable>;\n\treadonly #hooks: OpenCloudHooks;\n\treadonly #httpClient: HttpClient;\n\treadonly #queues = new Map<string, RateLimitQueue>();\n\treadonly #sleep: SleepFunc;\n\n\t/**\n\t * Creates a new {@link ResourceClient}. Resolves the injected HTTP\n\t * client and sleep (defaulting to fetch + `setTimeout`) and freezes the\n\t * merged client config so subsequent calls cannot mutate it.\n\t *\n\t * @param options - Client-level configuration including the API key\n\t * and optional construction-time test seams.\n\t */\n\tconstructor(options: OpenCloudClientOptions) {\n\t\tconst { apiKey, hooks, httpClient, sleep, ...overrides } = options;\n\t\tconst resolved = resolveDependencies({ httpClient, sleep });\n\t\tthis.#httpClient = resolved.httpClient;\n\t\tthis.#sleep = resolved.sleep;\n\t\tthis.#hooks = hooks ?? {};\n\t\tthis.#config = Object.freeze({\n\t\t\t...CLIENT_DEFAULTS,\n\t\t\tapiKey,\n\t\t\t...overrides,\n\t\t});\n\t}\n\n\t/**\n\t * Dispatches a single resource-method call. Merges the frozen client\n\t * config with the method's `methodDefaults` and the caller's optional\n\t * per-request `options`, routes through the effective-apiKey rate-limit\n\t * queue, runs the retry loop, and finally parses the response with the\n\t * spec's parser.\n\t *\n\t * @param call - The per-method spec, resource-specific parameters, and\n\t * optional per-request overrides.\n\t * @returns The parsed success payload or the {@link OpenCloudError} that\n\t * caused the request to fail. Never throws.\n\t */\n\tpublic async execute<P, T>(call: ExecuteCall<P, T>): Promise<Result<T, OpenCloudError>> {\n\t\tconst { options, parameters, spec } = call;\n\t\tconst merged = mergeConfig(this.#config, {\n\t\t\tmethodDefaults: spec.methodDefaults,\n\t\t\tmethodKind: spec.methodKind,\n\t\t\trequestOptions: options ?? {},\n\t\t});\n\t\tconst requestResult = spec.buildRequest(parameters);\n\t\tif (!requestResult.success) {\n\t\t\treturn requestResult;\n\t\t}\n\n\t\tconst requestConfig = {\n\t\t\tapiKey: merged.apiKey,\n\t\t\tbaseUrl: merged.baseUrl,\n\t\t\ttimeout: merged.timeout,\n\t\t};\n\t\tconst queue = this.#getQueue(merged.apiKey, spec.operationLimit);\n\t\tconst httpResult = await queue.acquire(async () => {\n\t\t\treturn executeWithRetry(requestResult.data, {\n\t\t\t\tconfig: merged,\n\t\t\t\thooks: this.#hooks,\n\t\t\t\tsend: async (toSend) => this.#httpClient.request(toSend, requestConfig),\n\t\t\t\tsleep: this.#sleep,\n\t\t\t});\n\t\t});\n\t\tif (!httpResult.success) {\n\t\t\treturn { err: enrichPermissionError(httpResult.err, spec), success: false };\n\t\t}\n\n\t\treturn spec.parse(httpResult.data);\n\t}\n\n\t#getQueue(apiKey: string, limit: OperationLimit): RateLimitQueue {\n\t\tconst key = `${apiKey}::${limit.operationKey}`;\n\t\tconst existing = this.#queues.get(key);\n\t\tif (existing !== undefined) {\n\t\t\treturn existing;\n\t\t}\n\n\t\tconst queue = new RateLimitQueue(limit, this.#hooks, this.#sleep);\n\t\tthis.#queues.set(key, queue);\n\t\treturn queue;\n\t}\n}\n\nfunction enrichPermissionError<P, T>(\n\terr: OpenCloudError,\n\tspec: ResourceMethodSpec<P, T>,\n): OpenCloudError {\n\tif (spec.requiredScopes === undefined) {\n\t\treturn err;\n\t}\n\n\tif (err instanceof PermissionError) {\n\t\treturn err;\n\t}\n\n\tif (!(err instanceof ApiError)) {\n\t\treturn err;\n\t}\n\n\tif (err.statusCode !== 401 && err.statusCode !== 403) {\n\t\treturn err;\n\t}\n\n\treturn new PermissionError(err.message, {\n\t\tcause: err.cause,\n\t\tcode: err.code,\n\t\toperationKey: spec.operationLimit.operationKey,\n\t\trequiredScopes: spec.requiredScopes,\n\t\tstatusCode: err.statusCode,\n\t});\n}\n"],"mappings":";;;;;;;;;;;;AASA,SAAgB,SAAS,OAAkD;AAC1E,QAAO,OAAO,UAAU,SAAS,KAAK,MAAM,KAAK;;;;;;;;ACoBlD,MAAa,6BACZ,OAAO,OAAO,EACb,mBAAmB,OAAO,OAAO;CAAC;CAAK;CAAK;CAAK;CAAK;CAAI,CAAU,EACpE,CAAC;;;;;;AAOH,MAAa,yBACZ,OAAO,OAAO,EACb,mBAAmB,OAAO,OAAO,CAAC,IAAI,CAAU,EAChD,CAAC;;;;;;;;;;;;;;;;;AA6CH,SAAgB,kBAAkB,SAAyB;AAC1D,QAAO,KAAK,IAAI,MAAO,KAAK,SAAS,IAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsC7C,SAAgB,mBACf,OACA,SACS;AACT,KAAI,iBAAiB,kBAAkB,MAAM,oBAAoB,EAChE,QAAO,MAAM,oBAAoB;AAGlC,QAAO,QAAQ,WAAW,QAAQ,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgD3C,SAAgB,YACf,OACA,QACqC;AACrC,KAAI,iBAAiB,eACpB,QAAO,OAAO,kBAAkB,SAAS,IAAI;AAG9C,KAAI,iBAAiB,SACpB,QAAO,OAAO,kBAAkB,SAAS,MAAM,WAAW;AAG3D,QAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+ER,SAAgB,YACf,cACA,SACI;CACJ,MAAM,EAAE,gBAAgB,YAAY,mBAAmB;AAEvD,SAAQ,YAAR;EACC,KAAK,SACJ,QAAO;GAAE,GAAG;GAAc,GAAG;GAAgB,GAAG;GAAgB;EAEjE,KAAK,aACJ,QAAO;GAAE,GAAG;GAAgB,GAAG;GAAc,GAAG;GAAgB;EAEjE,QAEC,OAAM,IAAI,MAAM,0BAA0B,OADhB,WACkC,GAAG;;;;;;;;;;;;;;;;AC9PlE,eAAsB,iBACrB,SACA,SACgD;CAChD,MAAM,EAAE,QAAQ,OAAO,MAAM,UAAU;CAEvC,eAAe,UAAyD;AACvE,QAAM,YAAY,QAAQ;AAC1B,SAAO,KAAK,QAAQ;;CAGrB,IAAI,SAAS,MAAM,SAAS;AAE5B,MAAK,IAAI,QAAQ,GAAG,QAAQ,OAAO,YAAY,SAAS;AACvD,MAAI,OAAO,WAAW,CAAC,YAAY,OAAO,KAAK,OAAO,CACrD,QAAO;EAGR,MAAM,EAAE,QAAQ;AAChB,QAAM,UAAU,QAAQ,GAAG,IAAI;EAC/B,MAAM,SAAS,mBAAmB,KAAK;GAAE,SAAS;GAAO,YAAY,OAAO;GAAY,CAAC;AACzF,QAAM,cAAc,OAAO;AAC3B,QAAM,MAAM,OAAO;AAEnB,WAAS,MAAM,SAAS;;AAGzB,QAAO;;;;;;;;;;;;;;AClCR,IAAa,iBAAb,MAA4B;CAC3B;CACA;CACA;CACA;CAEA,eAAe;CACf,SAAwB,QAAQ,SAAS;CACzC,aAAqB,KAAK,KAAK;;;;;;;;;CAU/B,YAAY,OAAuB,OAAuB,OAAkB;AAC3E,QAAA,aAAmB,MAAO,MAAM;AAChC,QAAA,iBAAuB,MAAM,eAAe,MAAA;AAC5C,QAAA,QAAc;AACd,QAAA,QAAc;;;;;;;;;;;CAYf,MAAa,QAAW,MAAoC;EAC3D,MAAM,SAAS,MAAA,MAAY,KAAK,YAAY,MAAA,cAAoB,CAAC;AACjE,QAAA,QAAc;AACd,QAAM;AACN,SAAO,MAAM;;CAGd,OAAA,eAAqC;EACpC,MAAM,MAAM,KAAK,IAAI,KAAK,KAAK,EAAE,MAAA,UAAgB;EACjD,MAAM,UAAU,KAAK,IAAI,GAAG,MAAA,eAAqB,MAAM,MAAA,WAAiB;AACxE,QAAA,YAAkB;AAElB,MAAI,UAAU,MAAA,cAAoB,MAAA,gBAAsB;AACvD,SAAA,cAAoB,UAAU,MAAA;AAC9B;;EAGD,MAAM,SAAS,UAAU,MAAA,aAAmB,MAAA;AAC5C,QAAA,MAAY,cAAc,OAAO;AACjC,QAAM,MAAA,MAAY,OAAO;AACzB,QAAA,cAAoB,MAAA;AACpB,QAAA,YAAkB,MAAM;;;;;;;;;;;;AC1E1B,eAAsB,SAAY,SAAyC;AAC1E,KAAI;AAEH,SAAO;GAAE,MADI,MAAM;GACJ,SAAS;GAAM;UACtB,KAAK;AACb,SAAO;GAAE,KAAK,eAAe,QAAQ,MAAM,IAAI,MAAM,OAAO,IAAI,CAAC;GAAE,SAAS;GAAO;;;;;;;;;;;ACArF,SAAgB,gBAAgB,SAA0C;AACzE,QAAO,OAAO,YAAY,QAAQ;;;;;;;;;AAUnC,SAAgB,iBAAiB,MAAmC;AACnE,KAAI,SAAS,QAAQ,OAAO,SAAS,SACpC;CAGD,MAAM,YAAqB,QAAQ,IAAI,MAAM,YAAY;AACzD,QAAO,OAAO,cAAc,WAAW,YAAY,KAAA;;;;;;;;AASpD,SAAgB,uBAAuB,aAAyC;CAC/E,MAAM,SAAS,OAAO,YAAY;AAClC,KAAI,OAAO,MAAM,OAAO,CACvB,QAAO;AAGR,QAAO,KAAK,IAAI,GAAG,KAAK,MAAM,OAAO,CAAC;;;;;;;;;AAUvC,SAAgB,SAAS,SAAsB,QAA+B;AAE7E,QAAO,GADM,OAAO,QAAQ,SAAS,IAAI,GAAG,OAAO,QAAQ,MAAM,GAAG,GAAG,GAAG,OAAO,UAChE,QAAQ;;;;;;;;;AAU1B,SAAgB,kBAAkB,SAAsB,QAAoC;CAC3F,MAAM,UAAU,IAAI,QAAQ,EAC3B,aAAa,OAAO,QACpB,CAAC;CAEF,MAAM,UAAuB;EAC5B;EACA,QAAQ,QAAQ;EAChB;AAED,KAAI,QAAQ,gBAAgB,SAC3B,SAAQ,OAAO,QAAQ;UACb,QAAQ,gBAAgB,YAAY;AAC9C,UAAQ,IAAI,gBAAgB,2BAA2B;AACvD,UAAQ,OAAO,QAAQ;YACb,QAAQ,SAAS,KAAA,GAAW;AACtC,UAAQ,IAAI,gBAAgB,mBAAmB;AAC/C,UAAQ,OAAO,KAAK,UAAU,QAAQ,KAAK;;AAG5C,KAAI,QAAQ,YAAY,KAAA,EACvB,MAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,QAAQ,QAAQ,EAAE;AAC5D,MAAI,KAAK,aAAa,KAAK,YAC1B;AAGD,UAAQ,IAAI,MAAM,MAAM;;AAI1B,KAAI,OAAO,YAAY,KAAA,EACtB,SAAQ,SAAS,YAAY,QAAQ,OAAO,QAAQ;AAGrD,QAAO;;;;;;;;AASR,SAAgB,sBACf,YAAmE,WAAW,OACjE;AACb,QAAO,EACN,MAAM,QACL,aACA,QACgD;EAIhD,MAAM,cAAc,MAAM,SAAS,UAHvB,SAAS,aAAa,OAAO,EACzB,kBAAkB,aAAa,OAAO,CAEI,CAAC;AAC3D,MAAI,CAAC,YAAY,QAChB,QAAO;GACN,KAAK,IAAI,aAAa,0BAA0B,EAAE,OAAO,YAAY,KAAK,CAAC;GAC3E,SAAS;GACT;AAGF,SAAO,iBAAiB,YAAY,KAAK;IAE1C;;AAGF,SAAS,eAAe,QAAgB,MAAyB;AAChE,QAAO,IAAI,SAAS,QAAQ,UAAU;EACrC,MAAM,iBAAiB,KAAK;EAC5B,YAAY;EACZ,CAAC;;;;;;;;AASH,SAAS,qBAAqB,UAAoC;AACjE,QAAO,IAAI,eAAe,gBAAgB,EACzC,mBAAmB,uBAClB,SAAS,QAAQ,IAAI,oBAAoB,IAAI,KAAA,EAC7C,EACD,CAAC;;AAGH,eAAe,iBAAiB,UAA8D;AAC7F,KAAI;EACH,MAAM,OAAO,MAAM,SAAS,MAAM;AAClC,SAAO;GAAE,MAAM,SAAS,KAAK,KAAA,IAAY,KAAK,MAAM,KAAK;GAAE,SAAS;GAAM;SACnE;AACP,SAAO;GACN,KAAK,IAAI,SAAS,iCAAiC,EAAE,YAAY,SAAS,QAAQ,CAAC;GACnF,SAAS;GACT;;;AAIH,eAAe,iBAAiB,UAAmE;AAClG,KAAI,SAAS,WAAW,IACvB,QAAO;EAAE,KAAK,qBAAqB,SAAS;EAAE,SAAS;EAAO;CAG/D,MAAM,aAAa,MAAM,iBAAiB,SAAS;AACnD,KAAI,CAAC,WAAW,QACf,QAAO;AAGR,KAAI,SAAS,UAAU,IACtB,QAAO;EAAE,KAAK,eAAe,SAAS,QAAQ,WAAW,KAAK;EAAE,SAAS;EAAO;AAGjF,QAAO;EACN,MAAM;GACL,MAAM,WAAW;GACjB,SAAS,gBAAgB,SAAS,QAAQ;GAC1C,QAAQ,SAAS;GACjB;EACD,SAAS;EACT;;;;;;;;;;;;;;;;ACvJF,SAAgB,oBAAoB,SAA2D;AAC9F,QAAO;EACN,YAAY,QAAQ,cAAc,uBAAuB;EACzD,OAAO,QAAQ,SAAS;EACxB;;;;;;;;;;;;;AC4DF,SAAgB,UAAU,SAA2D;AACpF,QAAO;EAAE,MAAM;EAAS,SAAS;EAAM;;;;;;;;;AAUxC,SAAgB,qBAAwD;AACvE,QAAO;EAAE,MAAM,KAAA;EAAW,SAAS;EAAM;;AAG1C,MAAM,kBAAkB,OAAO,OAAO;CACrC,SAAS;CACT,YAAY;CACZ,mBAAmB,2BAA2B;CAC9C,YAAY;CACZ,SAAS;CACT,CAA6C;;;;;;;;;;AAW9C,IAAa,iBAAb,MAA4B;CAC3B;CACA;CACA;CACA,0BAAmB,IAAI,KAA6B;CACpD;;;;;;;;;CAUA,YAAY,SAAiC;EAC5C,MAAM,EAAE,QAAQ,OAAO,YAAY,OAAO,GAAG,cAAc;EAC3D,MAAM,WAAW,oBAAoB;GAAE;GAAY;GAAO,CAAC;AAC3D,QAAA,aAAmB,SAAS;AAC5B,QAAA,QAAc,SAAS;AACvB,QAAA,QAAc,SAAS,EAAE;AACzB,QAAA,SAAe,OAAO,OAAO;GAC5B,GAAG;GACH;GACA,GAAG;GACH,CAAC;;;;;;;;;;;;;;CAeH,MAAa,QAAc,MAA6D;EACvF,MAAM,EAAE,SAAS,YAAY,SAAS;EACtC,MAAM,SAAS,YAAY,MAAA,QAAc;GACxC,gBAAgB,KAAK;GACrB,YAAY,KAAK;GACjB,gBAAgB,WAAW,EAAE;GAC7B,CAAC;EACF,MAAM,gBAAgB,KAAK,aAAa,WAAW;AACnD,MAAI,CAAC,cAAc,QAClB,QAAO;EAGR,MAAM,gBAAgB;GACrB,QAAQ,OAAO;GACf,SAAS,OAAO;GAChB,SAAS,OAAO;GAChB;EAED,MAAM,aAAa,MADL,MAAA,SAAe,OAAO,QAAQ,KAAK,eAAe,CACjC,QAAQ,YAAY;AAClD,UAAO,iBAAiB,cAAc,MAAM;IAC3C,QAAQ;IACR,OAAO,MAAA;IACP,MAAM,OAAO,WAAW,MAAA,WAAiB,QAAQ,QAAQ,cAAc;IACvE,OAAO,MAAA;IACP,CAAC;IACD;AACF,MAAI,CAAC,WAAW,QACf,QAAO;GAAE,KAAK,sBAAsB,WAAW,KAAK,KAAK;GAAE,SAAS;GAAO;AAG5E,SAAO,KAAK,MAAM,WAAW,KAAK;;CAGnC,UAAU,QAAgB,OAAuC;EAChE,MAAM,MAAM,GAAG,OAAO,IAAI,MAAM;EAChC,MAAM,WAAW,MAAA,OAAa,IAAI,IAAI;AACtC,MAAI,aAAa,KAAA,EAChB,QAAO;EAGR,MAAM,QAAQ,IAAI,eAAe,OAAO,MAAA,OAAa,MAAA,MAAY;AACjE,QAAA,OAAa,IAAI,KAAK,MAAM;AAC5B,SAAO;;;AAIT,SAAS,sBACR,KACA,MACiB;AACjB,KAAI,KAAK,mBAAmB,KAAA,EAC3B,QAAO;AAGR,KAAI,eAAe,gBAClB,QAAO;AAGR,KAAI,EAAE,eAAe,UACpB,QAAO;AAGR,KAAI,IAAI,eAAe,OAAO,IAAI,eAAe,IAChD,QAAO;AAGR,QAAO,IAAI,gBAAgB,IAAI,SAAS;EACvC,OAAO,IAAI;EACX,MAAM,IAAI;EACV,cAAc,KAAK,eAAe;EAClC,gBAAgB,KAAK;EACrB,YAAY,IAAI;EAChB,CAAC"}
@@ -0,0 +1,18 @@
1
+ //#region src/internal/utils/to-blob.ts
2
+ /**
3
+ * Wraps a binary value as a {@link Blob}, copying `Uint8Array` input into a
4
+ * fresh `Blob` so the originating buffer cannot be mutated between request
5
+ * build and send. `Blob` input is returned as-is so MIME-type metadata is
6
+ * preserved.
7
+ *
8
+ * @param value - Binary data to convert.
9
+ * @returns The supplied `Blob`, or a new `Blob` wrapping a defensive copy.
10
+ */
11
+ function toBlob(value) {
12
+ if (value instanceof Blob) return value;
13
+ return new Blob([new Uint8Array(value)]);
14
+ }
15
+ //#endregion
16
+ export { toBlob as t };
17
+
18
+ //# sourceMappingURL=to-blob-1BtHsDGK.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"to-blob-1BtHsDGK.mjs","names":[],"sources":["../src/internal/utils/to-blob.ts"],"sourcesContent":["/**\n * Wraps a binary value as a {@link Blob}, copying `Uint8Array` input into a\n * fresh `Blob` so the originating buffer cannot be mutated between request\n * build and send. `Blob` input is returned as-is so MIME-type metadata is\n * preserved.\n *\n * @param value - Binary data to convert.\n * @returns The supplied `Blob`, or a new `Blob` wrapping a defensive copy.\n */\nexport function toBlob(value: Blob | Uint8Array): Blob {\n\tif (value instanceof Blob) {\n\t\treturn value;\n\t}\n\n\treturn new Blob([new Uint8Array(value)]);\n}\n"],"mappings":";;;;;;;;;;AASA,SAAgB,OAAO,OAAgC;AACtD,KAAI,iBAAiB,KACpB,QAAO;AAGR,QAAO,IAAI,KAAK,CAAC,IAAI,WAAW,MAAM,CAAC,CAAC"}
@@ -0,0 +1,214 @@
1
+ //#region src/errors/base.d.ts
2
+ /**
3
+ * Base error class for all Open Cloud SDK errors.
4
+ *
5
+ * All specific error types (RateLimitError, ApiError, NetworkError)
6
+ * extend this class, enabling `instanceof OpenCloudError` checks.
7
+ */
8
+ declare class OpenCloudError extends Error {
9
+ override readonly name: string;
10
+ }
11
+ //#endregion
12
+ //#region src/internal/utils/sleep.d.ts
13
+ /** Injectable sleep function signature for testing. */
14
+ type SleepFunc = (ms: number) => Promise<void>;
15
+ //#endregion
16
+ //#region src/types.d.ts
17
+ /**
18
+ * Discriminated union for explicit error handling.
19
+ *
20
+ * Every SDK client method returns `Promise<Result<T, OpenCloudError>>`.
21
+ * Errors are never thrown; they are returned as `{ err, success: false }`.
22
+ *
23
+ * @template T - The success value type.
24
+ * @template E - The error type (defaults to `Error`).
25
+ *
26
+ * @example
27
+ *
28
+ * ```ts
29
+ * import type { Result } from "@bedrock-rbx/ocale";
30
+ *
31
+ * function parseAge(input: string): Result<number, Error> {
32
+ * const age = Number(input);
33
+ * return Number.isFinite(age)
34
+ * ? { data: age, success: true }
35
+ * : { err: new Error(`Not a number: ${input}`), success: false };
36
+ * }
37
+ *
38
+ * const ok = parseAge("42");
39
+ * if (ok.success) {
40
+ * // ok.data is narrowed to number here; value is 42
41
+ * expect(ok.data).toBe(42);
42
+ * }
43
+ *
44
+ * const bad = parseAge("nope");
45
+ * if (!bad.success) {
46
+ * // bad.err is narrowed to Error here; message mentions the input
47
+ * expect(bad.err.message).toContain("Not a number");
48
+ * }
49
+ * ```
50
+ */
51
+ type Result<T, E = Error> = {
52
+ data: T;
53
+ success: true;
54
+ } | {
55
+ err: E;
56
+ success: false;
57
+ };
58
+ /**
59
+ * One page of a cursor-paginated SDK response.
60
+ *
61
+ * `list`-style methods on resource clients (for example
62
+ * `GamePassesClient.list`) return a {@link Result} wrapping a `Page<T>`.
63
+ * `nextPageToken` carries the cursor for the next page when one exists,
64
+ * or `undefined` on the last page; the SDK normalizes the wire's
65
+ * `null`-vs-absent variants to `undefined` so callers only ever see one
66
+ * shape.
67
+ *
68
+ * @template T - The public item type for the listed resource.
69
+ *
70
+ * @example
71
+ *
72
+ * ```ts
73
+ * import type { Page } from "@bedrock-rbx/ocale";
74
+ *
75
+ * const middle: Page<string> = { items: ["a", "b"], nextPageToken: "cursor" };
76
+ * expect(middle.items).toEqual(["a", "b"]);
77
+ * expect(middle.nextPageToken).toBe("cursor");
78
+ *
79
+ * const last: Page<string> = { items: ["c"], nextPageToken: undefined };
80
+ * expect(last.items).toEqual(["c"]);
81
+ * expect(last.nextPageToken).toBeUndefined();
82
+ * ```
83
+ */
84
+ interface Page<T> {
85
+ /** Items in this page, in the order returned by the API. */
86
+ readonly items: ReadonlyArray<T>;
87
+ /** Cursor for the next page; `undefined` on the last page. */
88
+ readonly nextPageToken: string | undefined;
89
+ }
90
+ //#endregion
91
+ //#region src/client/types.d.ts
92
+ /**
93
+ * A normalized HTTP request to send to the Roblox Open Cloud API.
94
+ */
95
+ interface HttpRequest {
96
+ /** The request body. */
97
+ readonly body?: HttpRequestBody;
98
+ /**
99
+ * Caller-supplied request headers. Applied after the transport sets
100
+ * `x-api-key` and any body-driven `Content-Type`, so a caller-supplied
101
+ * header replaces the transport's default.
102
+ */
103
+ readonly headers?: Readonly<Record<string, string>>;
104
+ /** The HTTP method. */
105
+ readonly method: "DELETE" | "GET" | "PATCH" | "POST";
106
+ /** Relative path, e.g. `/game-passes/v1/universes/123/...`. */
107
+ readonly url: string;
108
+ }
109
+ /**
110
+ * A normalized HTTP response from the Roblox Open Cloud API.
111
+ */
112
+ interface HttpResponse {
113
+ /**
114
+ * The parsed response body. `undefined` when the response had an empty
115
+ * body (for example HTTP 204 No Content, or any other status where the
116
+ * server returned no payload).
117
+ */
118
+ readonly body: unknown;
119
+ /** Response headers with lowercased keys. */
120
+ readonly headers: Readonly<Record<string, string>>;
121
+ /** The HTTP status code. */
122
+ readonly status: number;
123
+ }
124
+ /**
125
+ * Per-request configuration passed to {@link HttpClient.request}.
126
+ */
127
+ interface RequestConfig {
128
+ /** The Roblox Open Cloud API key. */
129
+ readonly apiKey: string;
130
+ /** Base URL for the API, e.g. `https://apis.roblox.com`. */
131
+ readonly baseUrl: string;
132
+ /** Optional request timeout in milliseconds. */
133
+ readonly timeout?: number;
134
+ }
135
+ /**
136
+ * HTTP transport abstraction. Implementations classify every response into
137
+ * a typed {@link Result}.
138
+ */
139
+ interface HttpClient {
140
+ /** Sends an HTTP request and classifies the response. */
141
+ request(request: HttpRequest, config: RequestConfig): Promise<Result<HttpResponse, OpenCloudError>>;
142
+ }
143
+ /**
144
+ * Client-level observability hooks. All hooks are notification-only and
145
+ * fire-and-forget; they cannot alter retry behaviour.
146
+ */
147
+ interface OpenCloudHooks {
148
+ /** Fired before the SDK sleeps for a computed retry or rate-limit wait. */
149
+ readonly onRateLimit?: (waitMs: number) => void;
150
+ /** Fired before each HTTP attempt (including retries). */
151
+ readonly onRequest?: (request: HttpRequest) => void;
152
+ /** Fired before a retry is attempted. `attempt` is 1-indexed. */
153
+ readonly onRetry?: (attempt: number, error: OpenCloudError) => void;
154
+ }
155
+ /**
156
+ * Options accepted by every resource client constructor. Cross-cutting
157
+ * configuration that applies to all requests made through the client instance.
158
+ */
159
+ interface OpenCloudClientOptions {
160
+ /** The Roblox Open Cloud API key used as the default for every request. */
161
+ readonly apiKey: string;
162
+ /** Base URL for the Open Cloud API. Defaults to `https://apis.roblox.com`. */
163
+ readonly baseUrl?: string;
164
+ /** Optional observability hooks. */
165
+ readonly hooks?: OpenCloudHooks;
166
+ /**
167
+ * Plug in a custom {@link HttpClient} to wrap or replace the default
168
+ * fetch-backed transport. Useful for wrapping `fetch` with tracing
169
+ * or metrics, routing through a custom proxy, or feeding the SDK
170
+ * from a recorded-fixture or replay layer. Most consumers leave this
171
+ * unset and use the default.
172
+ */
173
+ readonly httpClient?: HttpClient;
174
+ /** Maximum retry attempts. Defaults to `3`. */
175
+ readonly maxRetries?: number;
176
+ /**
177
+ * Status codes eligible for retry. Defaults to the idempotent-method set
178
+ * `[429, 500, 502, 503, 504]`. Resource clients may tighten this per
179
+ * method (e.g. `create` only retries `429`).
180
+ */
181
+ readonly retryableStatuses?: ReadonlyArray<number>;
182
+ /** Fallback delay function used when no server hint is available. */
183
+ readonly retryDelay?: (attempt: number) => number;
184
+ /**
185
+ * Plug in a custom {@link SleepFunc} used between retry attempts and
186
+ * for rate-limit waits. Useful for integrating with a custom
187
+ * scheduler or virtual clock. Most consumers leave this unset and
188
+ * use the default `setTimeout`-backed sleep.
189
+ */
190
+ readonly sleep?: SleepFunc;
191
+ /** Per-request timeout in milliseconds. Defaults to `30_000`. */
192
+ readonly timeout?: number;
193
+ }
194
+ /**
195
+ * Per-request override shape. Any subset of the overridable client options
196
+ * may be supplied for a single request; omitted fields fall through to the
197
+ * client-level defaults.
198
+ */
199
+ type RequestOptions = Partial<Pick<OpenCloudClientOptions, "apiKey" | "baseUrl" | "maxRetries" | "retryableStatuses" | "retryDelay" | "timeout">>;
200
+ /**
201
+ * Supported request body types.
202
+ *
203
+ * - `FormData` for multipart uploads (Content-Type set automatically by fetch).
204
+ * - `Record<string, unknown>` for JSON bodies (serialized with `JSON.stringify`).
205
+ * - `Uint8Array<ArrayBuffer>` for raw binary uploads (default Content-Type is
206
+ * `application/octet-stream`; override via {@link HttpRequest.headers}).
207
+ * `SharedArrayBuffer`-backed views are not accepted by `fetch`; wrap them
208
+ * via `new Uint8Array(bytes)` to obtain an `ArrayBuffer`-backed copy.
209
+ * - `undefined` for requests without a body (GET, DELETE).
210
+ */
211
+ type HttpRequestBody = FormData | Record<string, unknown> | Uint8Array<ArrayBuffer> | undefined;
212
+ //#endregion
213
+ 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 };
214
+ //# sourceMappingURL=types-YCTsM8Qd.d.mts.map
@@ -0,0 +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"}