@bedrock-rbx/ocale 0.1.0-beta.9 → 0.1.1

package/dist/{polling-BMrYajok.d.mts → polling-rj0dGREg.d.mts}

@@ -1,10 +1,12 @@
-import { s as RequestOptions } from "./types-CwtZT1ek.mjs";
+import { s as RequestOptions } from "./types-CRiJg5EQ.mjs";
 
 //#region src/domains/cloud-v2/luau-execution-tasks/types.d.ts
 /**
 * Caller-supplied input for submitting a Luau Execution task against a
 * place's head version. Submitting against a specific place version uses
 * {@link SubmitAtVersionParameters} instead.
+*
+* @since 0.1.0
 */
 interface SubmitAtHeadParameters {
   /**
@@ -30,6 +32,8 @@ interface SubmitAtHeadParameters {
 * Caller-supplied input for submitting a Luau Execution task against a
 * specific place version. Submitting against the head version uses
 * {@link SubmitAtHeadParameters} instead.
+*
+* @since 0.1.0
 */
 interface SubmitAtVersionParameters {
   /**
@@ -59,6 +63,8 @@ interface SubmitAtVersionParameters {
 * returned by the server, and the get builder consumes it to construct
 * the maximal GET URL. `versionId` and `sessionId` are `undefined` when
 * the response `path` did not include those segments.
+*
+* @since 0.1.0
 */
 interface LuauExecutionTaskRef {
   /** Stringified place ID. */
@@ -75,6 +81,8 @@ interface LuauExecutionTaskRef {
 /**
 * Caller-supplied input for fetching a Luau Execution task's current
 * state.
+*
+* @since 0.1.0
 */
 interface GetParameters {
   /** Reference to the task to fetch, typically returned by submit. */
@@ -90,6 +98,8 @@ interface GetParameters {
 * Discriminated variant carrying every state in which the task has not
 * yet produced output or an error: queued for execution, currently
 * executing, or cancelled by the caller.
+*
+* @since 0.1.0
 */
 interface InProgressTask extends LuauExecutionTaskBase {
   /** Discriminator: the task is queued, processing, or cancelled. */
@@ -100,6 +110,8 @@ interface InProgressTask extends LuauExecutionTaskBase {
 * server populates `output.results` with the Luau `return` values from
 * the script run, serialized as JSON; entries that were not
 * JSON-serializable (e.g., Roblox `Instance`s) appear as `null`.
+*
+* @since 0.1.0
 */
 interface CompleteTask extends LuauExecutionTaskBase {
   /**
@@ -118,6 +130,8 @@ interface CompleteTask extends LuauExecutionTaskBase {
 * human-readable message describing the failure. The
 * `ERROR_CODE_UNSPECIFIED` wire sentinel is rejected by the parser, so
 * `code` is narrowed here to the four substantive error categories.
+*
+* @since 0.1.0
 */
 interface FailedTask extends LuauExecutionTaskBase {
   /** The categorical error code and message that caused the task to fail. */
@@ -137,6 +151,8 @@ interface FailedTask extends LuauExecutionTaskBase {
 /**
 * Public, discriminated representation of a Luau Execution session
 * task. The variants are mutually exclusive on `state`.
+*
+* @since 0.1.0
 */
 type LuauExecutionTask = CompleteTask | FailedTask | InProgressTask;
 /**
@@ -178,6 +194,8 @@ interface LuauExecutionTaskBase {
 /**
 * Caller-supplied input for listing the structured log messages produced
 * by a previously-submitted Luau execution task.
+*
+* @since 0.1.0
 */
 interface ListLogsParameters {
   /**
@@ -198,6 +216,8 @@ interface ListLogsParameters {
 * A single structured log message produced by a Luau execution task.
 * The `createTime` field is a raw ISO timestamp string, not a
 * {@link Date}, so it can be serialized without conversion.
+*
+* @since 0.1.0
 */
 interface LogMessage {
   /** ISO timestamp when the log message was produced. */
@@ -215,6 +235,8 @@ interface LogMessage {
 * Chunks are flattened by the parser; consumers see a single ordered
 * array. When `nextPageToken` is present, pass it to the next
 * `listLogs` call to retrieve the following page.
+*
+* @since 0.1.0
 */
 interface LogPage {
   /** Flattened, ordered list of log messages from this page. */
@@ -227,27 +249,64 @@ interface LogPage {
 }
 //#endregion
 //#region src/resources/luau-execution/polling.d.ts
-/** Public options accepted by `pollUntilDone` and `runUntilDone` on both client surfaces. */
+/**
+* Default poll cadence as a function of elapsed wall-clock time since
+* polling began. Polls quickly while a task is young so short runs resolve
+* snappily, then eases off so a long run leaves rate-limit headroom for
+* newer tasks: 0-20s is 500ms, 20-60s is 1000ms, 60s+ is 5000ms.
+*
+* @since 0.1.0
+*
+* @example
+* ```ts
+* import { defaultPollDelay } from "@bedrock-rbx/ocale/luau-execution";
+*
+* expect(defaultPollDelay(0)).toBe(500);
+* expect(defaultPollDelay(30_000)).toBe(1000);
+* expect(defaultPollDelay(120_000)).toBe(5000);
+* ```
+*
+* @param elapsedMs - Milliseconds elapsed since polling started.
+* @returns The delay in milliseconds to wait before the next poll.
+*/
+declare function defaultPollDelay(elapsedMs: number): number;
+/**
+* Public options accepted by `pollUntilDone` and `runUntilDone` on both client surfaces.
+*
+* @since 0.1.0
+*/
 type PollUntilDoneOptions = PollOptions & RequestOptions;
 /** Caller-supplied polling-loop options; all fields optional. */
 interface PollOptions {
-  /** Returns the sleep duration for a given zero-indexed attempt. Defaults to {@link defaultRetryDelay}. */
-  readonly pollDelay?: (attempt: number) => number;
+  /**
+  * Consecutive transient transport failures tolerated before the loop gives
+  * up. Defaults to {@link DEFAULT_POLL_FAILURE_CAP}. A successful poll resets
+  * the count.
+  */
+  readonly maxConsecutivePollFailures?: number;
+  /** Returns the sleep duration given ms elapsed since polling started. Defaults to {@link defaultPollDelay}. */
+  readonly pollDelay?: (elapsedMs: number) => number;
   /** When aborted, the loop returns {@link PollAbortedError} rather than continuing. */
   readonly signal?: AbortSignal;
   /** Total wall-clock budget in ms before the loop returns {@link PollTimeoutError}. */
   readonly timeoutMs?: number;
 }
 /**
-* Core polling loop. Calls `deps.fetch()` repeatedly, sleeping
-* `pollDelay(attempt)` ms between iterations, until a terminal state
-* is observed, the wall-clock budget is exhausted, or an `AbortSignal`
-* fires. Returns the terminal task on success.
-*
-* @param deps - Injected fetch, now, and sleep callbacks.
-* @param options - Optional poll delay, timeout, and abort signal.
-* @returns The terminal task, or an error if aborted, timed out, or the transport fails.
+* Defaults the per-request `timeout` to the effective poll budget when the
+* caller has not set one. A luau-execution submit and each poll `get` normally
+* answer in well under a second (the submit endpoint enqueues the task without
+* waiting for it to run), so the only job of a per-request deadline here is to
+* bound a black-hole connection. Leaving these requests on the client-wide 30s
+* default (tuned for snappy CRUD) turns a slow-but-alive backend into a
+* self-abort, an error the retry layer never retries by construction, before
+* the loop's wall-clock budget is ever consulted. Deriving the deadline from
+* `timeoutMs` keeps a single request alive exactly as long as the caller
+* already agreed to wait for the whole operation, so the backend can answer or
+* surface a retryable status instead.
+*
+* @param options - The caller's poll and per-request options.
+* @returns The options with `timeout` filled from the budget when it was unset.
 */
 //#endregion
-export { CompleteTask as a, InProgressTask as c, SubmitAtHeadParameters as d, SubmitAtVersionParameters as f, LogPage as i, LuauExecutionTask as l, ListLogsParameters as n, FailedTask as o, LogMessage as r, GetParameters as s, PollUntilDoneOptions as t, LuauExecutionTaskRef as u };
-//# sourceMappingURL=polling-BMrYajok.d.mts.map
+export { LogPage as a, GetParameters as c, LuauExecutionTaskRef as d, SubmitAtHeadParameters as f, LogMessage as i, InProgressTask as l, defaultPollDelay as n, CompleteTask as o, SubmitAtVersionParameters as p, ListLogsParameters as r, FailedTask as s, PollUntilDoneOptions as t, LuauExecutionTask as u };
+//# sourceMappingURL=polling-rj0dGREg.d.mts.map

package/dist/polling-rj0dGREg.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polling-rj0dGREg.d.mts","names":[],"sources":["../src/domains/cloud-v2/luau-execution-tasks/types.ts","../src/domains/cloud-v2/luau-execution-task-logs/types.ts","../src/resources/luau-execution/polling.ts"],"mappings":";;;;;;AAOA;;;;UAAiB,sBAAA;;;;;WAKP,WAAA;EAaA;EAAA,SAXA,kBAAA;EAqBV;EAAA,SAnBU,OAAA;;WAEA,MAAA;;;;;WAKA,cAAA;;WAEA,UAAA;AAAA;AA8BA;AAYV;;;;;;AAZU,UApBO,yBAAA;;;;AA0CP;WArCA,WAAA;EA8CO;EAAA,SA5CP,kBAAA;EA8CK;EAAA,SA5CL,OAAA;;WAEA,MAAA;EAgDA;AAAA;AAUV;;EAVU,SA3CA,cAAA;EAqD8B;EAAA,SAnD9B,UAAA;EAgEV;EAAA,SA9DU,SAAA;AAAA;;;;;;;;;;UAYO,oBAAA;;WAEP,OAAA;EAwDA;EAAA,SAtDA,SAAA;EAiEO;EAAA,SA/DP,MAAA;EA+D0B;EAAA,SA7D1B,UAAA;;WAEA,SAAA;AAAA;;;AA6EA;AASV;;;UA7EiB,aAAA;;WAEP,GAAA,EAAK,oBAAA;EA2E6C;;;;;EAAA,SArElD,IAAA;AAAA;AAqEkD;;;;;;;AAAA,UA3D3C,cAAA,SAAuB,qBAAA;;WAE9B,KAAA;AAAA;;;;;;;;;UAWO,YAAA,SAAqB,qBAAA;EAgF5B;;;;AC3LV;ED2LU,SA1EA,MAAA;IAAA,SAAmB,OAAA,EAAS,aAAA,CAAc,SAAA;EAAA;;WAE1C,KAAA;AAAA;;;ACtGK;AAUf;;;;;UDuGiB,UAAA,SAAmB,qBAAA;;WAE1B,KAAA;IChGA;AAWV;;;;;IAXU,SDuGC,IAAA,0FC1FuB;IAAA,SDgGvB,OAAA;EAAA;EC3FD;EAAA,SD8FA,KAAA;AAAA;;AEnGV;;;;AAAiC;KF4GrB,iBAAA,GAAoB,YAAA,GAAe,UAAA,GAAa,cAAA;;;;AE5EX;AAAA;UFmFvC,qBAAA;;;;;WAKA,WAAA;;;;;AEzEA;WF+EA,eAAA;;WAEA,SAAA,GAAY,IAAA;;WAEZ,kBAAA;;WAEA,GAAA,EAAK,oBAAA;;;;;;WAML,cAAA;;WAEA,SAAA,GAAY,IAAA;;WAEZ,IAAA;AAAA;;;;AA9LV;;;;;UCGiB,kBAAA;;;;;;WAMP,QAAA;EDmBV;;;;EAAA,SCdU,SAAA;;WAEA,GAAA,EAAK,oBAAA;AAAA;;;;;ADgCL;AAYV;;UClCiB,UAAA;EDkCA;EAAA,SChCP,UAAA;;WAEA,OAAA;;;;ADwCA;WCnCA,WAAA;AAAA;;;;;;;ADoDA;AAUV;UCnDiB,OAAA;;WAEP,QAAA,EAAU,aAAA,CAAc,UAAA;EDmDxB;AAWV;;;EAXU,SC9CA,aAAA;AAAA;;;;;;;;;;ADnCA;AAUV;;;;;;;;;;;;iBEoBgB,gBAAA,CAAiB,SAAA;AFiDjC;;;;AAEU;AAFV,KEjBY,oBAAA,GAAuB,WAAA,GAAc,cAAA;;UAGvC,WAAA;;;;;;WAMA,0BAAA;;WAEA,SAAA,IAAa,SAAA;;WAEb,MAAA,GAAS,WAAA;;WAET,SAAA;AAAA;AFkCV;;;;;;;;;;AAkBU;AASV"}

package/dist/{price-information-DIrvwCmd.mjs → price-information-C4gC2CMZ.mjs}

@@ -1,4 +1,4 @@
-import { s as isRecord } from "./resource-client-D6Efj9fU.mjs";
+import { i as isRecord } from "./resource-client-CIAkS2xQ.mjs";
 //#region src/internal/price-information.ts
 /**
 * Narrows `value` to {@link PriceInformationLike} for a given feature literal
@@ -39,4 +39,4 @@ function copyPriceInformation(wire) {
 //#endregion
 export { isPriceInformationLike as n, copyPriceInformation as t };
 
-//# sourceMappingURL=price-information-DIrvwCmd.mjs.map
+//# sourceMappingURL=price-information-C4gC2CMZ.mjs.map

package/dist/{price-information-DIrvwCmd.mjs.map → price-information-C4gC2CMZ.mjs.map}

@@ -1 +1 @@
-{"version":3,"file":"price-information-DIrvwCmd.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"}
+{"version":3,"file":"price-information-C4gC2CMZ.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;CACnC,IAAI,CAAC,SAAS,KAAK,GAClB,OAAO;CAGR,MAAM,eAAe,MAAM,0BAA0B,KAAA;CACrD,IAAI,iBAAiB,KAAA,KAAa,OAAO,iBAAiB,UACzD,OAAO;CAGR,MAAM,WAAW,MAAM;CACvB,IAAI,CAAC,MAAM,QAAQ,QAAQ,GAC1B,OAAO;CAGR,KAAK,MAAM,WAAW,UACrB,IAAI,CAAC,UAAU,OAAO,GACrB,OAAO;CAIT,OAAO;AACR;;;;;;;;;;AAWA,SAAgB,qBACf,MAC0B;CAC1B,OAAO;EACN,qBAAqB,KAAK,uBAAuB,KAAA;EACjD,iBAAiB,CAAC,GAAG,KAAK,eAAe;CAC1C;AACD"}

package/dist/{rate-limit-D1q2Js-z.mjs → rate-limit-Dh2leqaB.mjs}

@@ -4,6 +4,8 @@
 *
 * All specific error types (RateLimitError, ApiError, NetworkError)
 * extend this class, enabling `instanceof OpenCloudError` checks.
+*
+* @since 0.1.0
 */
 var OpenCloudError = class extends Error {
 	name = "OpenCloudError";
@@ -14,6 +16,8 @@ var OpenCloudError = class extends Error {
 * Thrown when the Roblox Open Cloud API returns a non-2xx response
 * that is not a rate limit (429).
 *
+* @since 0.1.0
+*
 * @example
 *
 * ```ts
@@ -37,30 +41,61 @@ var OpenCloudError = class extends Error {
 var ApiError = class extends OpenCloudError {
 	code;
 	details;
+	elapsedMs;
+	gatewaySummary;
+	method;
 	name = "ApiError";
+	responseHeaders;
 	statusCode;
+	url;
 	/**
 	* Creates a new ApiError.
 	*
 	* @param message - Human-readable error description.
 	* @param options - Error options including status code, optional error
-	*   code, and the parsed response body when present.
+	*   code, the parsed response body when present, and the request context
+	*   (method, url, elapsed time, allowlisted response headers) when built by
+	*   the transport.
 	*/
 	constructor(message, options) {
 		super(message, options);
 		this.statusCode = options.statusCode;
 		this.code = options.code;
 		this.details = options.details;
+		this.method = options.method;
+		this.url = options.url;
+		this.elapsedMs = options.elapsedMs;
+		this.responseHeaders = options.responseHeaders;
+		this.gatewaySummary = options.gatewaySummary;
 	}
 };
 //#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).
+* the Roblox Open Cloud API (e.g., DNS resolution failure, connection reset).
+* The `method` and `url` name the failing call so a transport failure that
+* survives every retry can be diagnosed; the underlying transport error is
+* carried on `cause`.
+*
+* @since 0.1.0
 */
 var NetworkError = class extends OpenCloudError {
+	method;
 	name = "NetworkError";
+	url;
+	/**
+	* Creates a new NetworkError.
+	*
+	* @param message - Human-readable error description.
+	* @param options - Error options including the optional `cause` and the
+	*   `method` / `url` of the request that failed.
+	*/
+	constructor(message, options) {
+		super(message, options);
+		this.method = options?.method;
+		this.url = options?.url;
+	}
 };
 //#endregion
 //#region src/errors/rate-limit.ts
@@ -68,6 +103,8 @@ var NetworkError = class extends OpenCloudError {
 * Thrown when the Roblox Open Cloud API returns a 429 Too Many Requests response.
 * Contains the server-suggested retry delay.
 *
+* @since 0.1.0
+*
 * @example
 *
 * ```ts
@@ -82,8 +119,14 @@ var NetworkError = class extends OpenCloudError {
 * ```
 */
 var RateLimitError = class extends OpenCloudError {
+	/** Parsed 429 response body, or `undefined` when none was carried. */
+	details;
 	name = "RateLimitError";
+	/** Requests left in the throttled window, or `undefined` if not reported. */
+	remaining;
 	retryAfterSeconds;
+	/** HTTP status code that produced the error, or `undefined` if not set. */
+	statusCode;
 	/**
 	* Creates a new RateLimitError.
 	*
@@ -93,9 +136,12 @@ var RateLimitError = class extends OpenCloudError {
 	constructor(message, options) {
 		super(message, options);
 		this.retryAfterSeconds = options.retryAfterSeconds;
+		this.remaining = options.remaining;
+		this.details = options.details;
+		this.statusCode = options.statusCode;
 	}
 };
 //#endregion
 export { OpenCloudError as i, NetworkError as n, ApiError as r, RateLimitError as t };
 
-//# sourceMappingURL=rate-limit-D1q2Js-z.mjs.map
+//# sourceMappingURL=rate-limit-Dh2leqaB.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limit-Dh2leqaB.mjs","names":[],"sources":["../src/errors/base.ts","../src/errors/api-error.ts","../src/errors/network-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 *\n * @since 0.1.0\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 *\n * @since 0.1.0\n */\nexport interface ApiErrorOptions extends ErrorOptions {\n\t/** Optional machine-readable error code from the API. */\n\tcode?: string | undefined;\n\t/** Parsed response body, when present. */\n\tdetails?: JSONValue | undefined;\n\t/**\n\t * Wall-clock time the request was in flight before this error, in\n\t * milliseconds. Present for errors built by the transport; a long elapsed\n\t * time on an intermittent failure points at a load or timeout correlation.\n\t */\n\telapsedMs?: number | undefined;\n\t/**\n\t * Human-readable summary extracted from an HTML gateway error page, set when\n\t * the error body was such a page (an HAProxy-style load-balancer rejection)\n\t * rather than an Open Cloud response. When present, the raw HTML is not\n\t * retained on {@link ApiError.details}.\n\t */\n\tgatewaySummary?: string | undefined;\n\t/** HTTP method of the request that produced this error. */\n\tmethod?: string | undefined;\n\t/**\n\t * Allowlisted response headers useful for diagnosis and escalation (request\n\t * ids, edge/server identifiers). The full header set is never retained, to\n\t * avoid surfacing anything sensitive and to keep errors light.\n\t */\n\tresponseHeaders?: Readonly<Record<string, string>> | undefined;\n\t/** HTTP status code from the API response. */\n\tstatusCode: number;\n\t/** Fully-qualified URL of the request that produced this error. */\n\turl?: string | undefined;\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 * @since 0.1.0\n *\n * @example\n *\n * ```ts\n * import { ApiError } from \"@bedrock-rbx/ocale\";\n *\n * const error = new ApiError(\"HTTP 404: Pass not found (code NotFound)\", {\n *     code: \"NotFound\",\n *     details: { errorCode: \"NotFound\", message: \"Pass not found\" },\n *     statusCode: 404,\n * });\n *\n * expect(error).toBeInstanceOf(ApiError);\n * expect(error.statusCode).toBe(404);\n * expect(error.code).toBe(\"NotFound\");\n * expect(error.details).toEqual({\n *     errorCode: \"NotFound\",\n *     message: \"Pass not found\",\n * });\n * ```\n */\nexport class ApiError extends OpenCloudError {\n\tpublic readonly code: string | undefined;\n\tpublic readonly details: JSONValue | undefined;\n\tpublic readonly elapsedMs: number | undefined;\n\tpublic readonly gatewaySummary: string | undefined;\n\tpublic readonly method: string | undefined;\n\tpublic override readonly name: string = \"ApiError\";\n\tpublic readonly responseHeaders: Readonly<Record<string, string>> | undefined;\n\tpublic readonly statusCode: number;\n\tpublic readonly url: string | undefined;\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, optional error\n\t *   code, the parsed response body when present, and the request context\n\t *   (method, url, elapsed time, allowlisted response headers) when built by\n\t *   the transport.\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\tthis.details = options.details;\n\t\tthis.method = options.method;\n\t\tthis.url = options.url;\n\t\tthis.elapsedMs = options.elapsedMs;\n\t\tthis.responseHeaders = options.responseHeaders;\n\t\tthis.gatewaySummary = options.gatewaySummary;\n\t}\n}\n","import { OpenCloudError } from \"./base.ts\";\n\n/**\n * Options for constructing a {@link NetworkError}.\n *\n * @since 0.1.0\n */\nexport interface NetworkErrorOptions extends ErrorOptions {\n\t/** HTTP method of the request that failed. */\n\tmethod?: string | undefined;\n\t/** Fully-qualified URL of the request that failed. */\n\turl?: string | undefined;\n}\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 reset).\n * The `method` and `url` name the failing call so a transport failure that\n * survives every retry can be diagnosed; the underlying transport error is\n * carried on `cause`.\n *\n * @since 0.1.0\n */\nexport class NetworkError extends OpenCloudError {\n\tpublic readonly method: string | undefined;\n\tpublic override readonly name: string = \"NetworkError\";\n\tpublic readonly url: string | undefined;\n\n\t/**\n\t * Creates a new NetworkError.\n\t *\n\t * @param message - Human-readable error description.\n\t * @param options - Error options including the optional `cause` and the\n\t *   `method` / `url` of the request that failed.\n\t */\n\tconstructor(message: string, options?: NetworkErrorOptions) {\n\t\tsuper(message, options);\n\t\tthis.method = options?.method;\n\t\tthis.url = options?.url;\n\t}\n}\n","import { OpenCloudError } from \"./base.ts\";\n\n/**\n * Options for constructing a {@link RateLimitError}.\n *\n * @since 0.1.0\n */\nexport interface RateLimitErrorOptions extends ErrorOptions {\n\t/**\n\t * Parsed 429 response body, when present. Holds the server's throttle\n\t * explanation (JSON when the body parses, otherwise the truncated raw\n\t * text) so a rate limit stays diagnosable from the error alone.\n\t */\n\tdetails?: JSONValue | undefined;\n\t/**\n\t * Requests still allowed in the throttled window, read from\n\t * `x-ratelimit-remaining` (the most-constrained window). `undefined` when\n\t * the header is absent or carries no finite numeric token; parsed\n\t * independently of `x-ratelimit-reset`, so a valid value survives a\n\t * non-numeric reset. Typically `0` on a genuine 429.\n\t */\n\tremaining?: number | undefined;\n\t/** Seconds to wait before retrying the request. */\n\tretryAfterSeconds: number;\n\t/**\n\t * HTTP status code that produced the error. Always `429` when minted by the\n\t * SDK transport; `undefined` when constructed without one.\n\t */\n\tstatusCode?: number | undefined;\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 * @since 0.1.0\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\t/** Parsed 429 response body, or `undefined` when none was carried. */\n\tpublic readonly details: JSONValue | undefined;\n\tpublic override readonly name = \"RateLimitError\";\n\t/** Requests left in the throttled window, or `undefined` if not reported. */\n\tpublic readonly remaining: number | undefined;\n\tpublic readonly retryAfterSeconds: number;\n\t/** HTTP status code that produced the error, or `undefined` if not set. */\n\tpublic readonly statusCode: number | undefined;\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\tthis.remaining = options.remaining;\n\t\tthis.details = options.details;\n\t\tthis.statusCode = options.statusCode;\n\t}\n}\n"],"mappings":";;;;;;;;;AAQA,IAAa,iBAAb,cAAoC,MAAM;CACzC,OAAwC;AACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACuDA,IAAa,WAAb,cAA8B,eAAe;CAC5C;CACA;CACA;CACA;CACA;CACA,OAAwC;CACxC;CACA;CACA;;;;;;;;;;CAWA,YAAY,SAAiB,SAA0B;EACtD,MAAM,SAAS,OAAO;EACtB,KAAK,aAAa,QAAQ;EAC1B,KAAK,OAAO,QAAQ;EACpB,KAAK,UAAU,QAAQ;EACvB,KAAK,SAAS,QAAQ;EACtB,KAAK,MAAM,QAAQ;EACnB,KAAK,YAAY,QAAQ;EACzB,KAAK,kBAAkB,QAAQ;EAC/B,KAAK,iBAAiB,QAAQ;CAC/B;AACD;;;;;;;;;;;;ACzEA,IAAa,eAAb,cAAkC,eAAe;CAChD;CACA,OAAwC;CACxC;;;;;;;;CASA,YAAY,SAAiB,SAA+B;EAC3D,MAAM,SAAS,OAAO;EACtB,KAAK,SAAS,SAAS;EACvB,KAAK,MAAM,SAAS;CACrB;AACD;;;;;;;;;;;;;;;;;;;;;;ACUA,IAAa,iBAAb,cAAoC,eAAe;;CAElD;CACA,OAAgC;;CAEhC;CACA;;CAEA;;;;;;;CAQA,YAAY,SAAiB,SAAgC;EAC5D,MAAM,SAAS,OAAO;EACtB,KAAK,oBAAoB,QAAQ;EACjC,KAAK,YAAY,QAAQ;EACzB,KAAK,UAAU,QAAQ;EACvB,KAAK,aAAa,QAAQ;CAC3B;AACD"}