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

package/dist/index.d.mts

@@ -1,47 +1,6 @@
-import { a as OpenCloudHooks, c as Page, d as OpenCloudError, i as OpenCloudClientOptions, l as Result, n as HttpRequest, o as RequestConfig, r as HttpResponse, s as RequestOptions, t as HttpClient, u as SleepFunc } from "./types-YCTsM8Qd.mjs";
+import { a as OpenCloudHooks, c as Page, d as OpenCloudError, i as OpenCloudClientOptions, l as Result, n as HttpRequest, o as RequestConfig, r as HttpResponse, s as RequestOptions, t as HttpClient, u as SleepFunc } from "./types-DUzm6maA.mjs";
+import { i as ApiErrorOptions, n as RateLimitErrorOptions, r as ApiError, t as RateLimitError } from "./rate-limit-BSbFNSGT.mjs";
 
-//#region src/errors/api-error.d.ts
-/**
-* Options for constructing an {@link ApiError}.
-*/
-interface ApiErrorOptions extends ErrorOptions {
-  /** Optional machine-readable error code from the API. */
-  code?: string | undefined;
-  /** HTTP status code from the API response. */
-  statusCode: number;
-}
-/**
-* 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");
-* ```
-*/
-declare class ApiError extends OpenCloudError {
-  readonly code: string | undefined;
-  override readonly name: string;
-  readonly statusCode: number;
-  /**
-  * Creates a new ApiError.
-  *
-  * @param message - Human-readable error description.
-  * @param options - Error options including status code and optional error code.
-  */
-  constructor(message: string, options: ApiErrorOptions);
-}
-//#endregion
 //#region src/errors/network-error.d.ts
 /**
 * Thrown when a network-level failure prevents the request from reaching
@@ -106,41 +65,93 @@ declare class PermissionError extends ApiError {
   constructor(message: string, options: PermissionErrorOptions);
 }
 //#endregion
-//#region src/errors/rate-limit.d.ts
+//#region src/errors/poll-aborted.d.ts
 /**
-* Options for constructing a {@link RateLimitError}.
+* Options for constructing a {@link PollAbortedError}.
 */
-interface RateLimitErrorOptions extends ErrorOptions {
-  /** Seconds to wait before retrying the request. */
-  retryAfterSeconds: number;
+interface PollAbortedErrorOptions extends ErrorOptions {
+  /** Whatever `AbortSignal.reason` was at the moment of abort. */
+  readonly reason?: unknown;
 }
 /**
-* Thrown when the Roblox Open Cloud API returns a 429 Too Many Requests response.
-* Contains the server-suggested retry delay.
+* Returned when `pollUntilDone` is interrupted by an `AbortSignal` before
+* a terminal task state is reached. The `reason` field mirrors
+* `AbortSignal.reason` so callers can distinguish intentional cancellation
+* from unexpected abort sources.
 *
 * @example
 *
 * ```ts
-* import { RateLimitError } from "@bedrock-rbx/ocale";
+* import { PollAbortedError } from "@bedrock-rbx/ocale";
 *
-* const error = new RateLimitError("Too many requests", {
-*     retryAfterSeconds: 30,
+* const error = new PollAbortedError("polling was aborted", {
+*     reason: "user cancelled",
 * });
 *
-* expect(error).toBeInstanceOf(RateLimitError);
-* expect(error.retryAfterSeconds).toBe(30);
+* expect(error).toBeInstanceOf(PollAbortedError);
+* expect(error.reason).toBe("user cancelled");
 * ```
 */
-declare class RateLimitError extends OpenCloudError {
-  override readonly name = "RateLimitError";
-  readonly retryAfterSeconds: number;
+declare class PollAbortedError extends OpenCloudError {
+  override readonly name: string;
+  readonly reason?: unknown;
   /**
-  * Creates a new RateLimitError.
+  * Creates a new PollAbortedError.
   *
-  * @param message - Human-readable error description.
-  * @param options - Error options including the retry delay.
+  * @param message - Human-readable description of the abort.
+  * @param options - Error options including the abort reason.
+  */
+  constructor(message: string, options?: PollAbortedErrorOptions);
+}
+//#endregion
+//#region src/errors/poll-timeout.d.ts
+/**
+* Options for {@link PollTimeoutError}. The `T` type parameter captures the
+* resource-specific task variant the caller polled for; defaults to `unknown`
+* so the class can be reused by future Resources without forcing a parallel
+* hierarchy.
+*
+* @template T - Resource-specific task type being polled.
+*/
+interface PollTimeoutErrorOptions<T = unknown> extends ErrorOptions {
+  /** Last task observed before the timeout budget was exhausted. */
+  readonly lastObservedTask?: T | undefined;
+  /** Total wall-clock budget supplied by the caller, in ms. */
+  readonly timeoutMs: number;
+}
+/**
+* Returned when `pollUntilDone` exhausts its wall-clock budget without
+* observing a terminal task state. Carries the last task polled so callers
+* can inspect state and decide whether to retry with a fresh budget.
+*
+* @template T - Resource-specific task type being polled.
+*
+* @example
+*
+* ```ts
+* import { PollTimeoutError } from "@bedrock-rbx/ocale";
+*
+* const error = new PollTimeoutError("polling timed out after 5 s", {
+*     lastObservedTask: { state: "PROCESSING" as const },
+*     timeoutMs: 5000,
+* });
+*
+* expect(error).toBeInstanceOf(PollTimeoutError);
+* expect(error.timeoutMs).toBe(5000);
+* expect(error.lastObservedTask).toStrictEqual({ state: "PROCESSING" });
+* ```
+*/
+declare class PollTimeoutError<T = unknown> extends OpenCloudError {
+  readonly lastObservedTask: T | undefined;
+  override readonly name: string;
+  readonly timeoutMs: number;
+  /**
+  * Creates a new PollTimeoutError.
+  *
+  * @param message - Human-readable description of the timeout.
+  * @param options - Error options including the budget and last-observed task.
   */
-  constructor(message: string, options: RateLimitErrorOptions);
+  constructor(message: string, options: PollTimeoutErrorOptions<T>);
 }
 //#endregion
 //#region src/errors/validation.d.ts
@@ -149,7 +160,7 @@ declare class RateLimitError extends OpenCloudError {
 * exhaustively `switch` over this union so TypeScript will refuse to compile
 * if a new variant is added without a handler.
 */
-type ValidationErrorCode = "empty_body" | "empty_image_ids" | "empty_update" | "format_mismatch" | "invalid_image_id";
+type ValidationErrorCode = "empty_body" | "empty_image_ids" | "empty_update" | "format_mismatch" | "incomplete_ref" | "invalid_image_id";
 /**
 * Options for constructing a {@link ValidationError}.
 */
@@ -187,5 +198,5 @@ declare class ValidationError extends OpenCloudError {
   constructor(message: string, options: ValidationErrorOptions);
 }
 //#endregion
-export { ApiError, type ApiErrorOptions, type HttpClient, type HttpRequest, type HttpResponse, NetworkError, type OpenCloudClientOptions, OpenCloudError, type OpenCloudHooks, type Page, PermissionError, type PermissionErrorOptions, RateLimitError, type RateLimitErrorOptions, type RequestConfig, type RequestOptions, type Result, type SleepFunc, ValidationError, type ValidationErrorCode, type ValidationErrorOptions };
+export { ApiError, type ApiErrorOptions, type HttpClient, type HttpRequest, type HttpResponse, NetworkError, type OpenCloudClientOptions, OpenCloudError, type OpenCloudHooks, type Page, PermissionError, type PermissionErrorOptions, PollAbortedError, type PollAbortedErrorOptions, PollTimeoutError, type PollTimeoutErrorOptions, RateLimitError, type RateLimitErrorOptions, type RequestConfig, type RequestOptions, type Result, type SleepFunc, ValidationError, type ValidationErrorCode, type ValidationErrorOptions };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/errors/api-error.ts","../src/errors/network-error.ts","../src/errors/permission-error.ts","../src/errors/rate-limit.ts","../src/errors/validation.ts"],"mappings":";;;;;AAKA;UAAiB,eAAA,SAAwB,YAAA;;EAExC,IAAA;;EAEA,UAAA;AAAA;;;AAsBD;;;;;;;;;;;;;;;;;cAAa,QAAA,SAAiB,cAAA;EAAA,SACb,IAAA;EAAA,kBACS,IAAA;EAAA,SACT,UAAA;EC3BS;;;;ACF1B;;EFqCC,WAAA,CAAY,OAAA,UAAiB,OAAA,EAAS,eAAA;AAAA;;;;;AArCvC;;cCCa,YAAA,SAAqB,cAAA;EAAA,kBACR,IAAA;AAAA;;;;;ADF1B;UEAiB,sBAAA,SAA+B,eAAA;;;;;;EAM/C,YAAA;EFFA;AAsBD;;;;EEdC,cAAA,EAAgB,aAAA;AAAA;;;;;;;;;;;;ADXjB;;;;;;;;ACDA;;;;cAsCa,eAAA,SAAwB,QAAA;EAAA,kBACX,IAAA;EAAA,SACT,YAAA;EAAA,SACA,cAAA,EAAgB,aAAA;;;AAHjC;;;;;EAYC,WAAA,CAAY,OAAA,UAAiB,OAAA,EAAS,sBAAA;AAAA;;;;;AFlDvC;UGAiB,qBAAA,SAA8B,YAAA;;EAE9C,iBAAA;AAAA;;;;;AHwBD;;;;;;;;;;;;;cGJa,cAAA,SAAuB,cAAA;EAAA,kBACV,IAAA;EAAA,SACT,iBAAA;;AFvBjB;;;;;EE+BC,WAAA,CAAY,OAAA,UAAiB,OAAA,EAAS,qBAAA;AAAA;;;;;AHhCvC;;;KIEY,mBAAA;;;;UAUK,sBAAA,SAA+B,YAAA;EJR/C;EIUA,IAAA,EAAM,mBAAA;AAAA;;;;;;;;;;;;;;;;AHbP;;;cGkCa,eAAA,SAAwB,cAAA;EAAA,SACpB,IAAA,EAAM,mBAAA;EAAA,kBACG,IAAA;;;AFrC1B;;;;EE6CC,WAAA,CAAY,OAAA,UAAiB,OAAA,EAAS,sBAAA;AAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/errors/network-error.ts","../src/errors/permission-error.ts","../src/errors/poll-aborted.ts","../src/errors/poll-timeout.ts","../src/errors/validation.ts"],"mappings":";;;;;;;AAMA;cAAa,YAAA,SAAqB,cAAA;EAAA,kBACR,IAAA;AAAA;;;;;;UCFT,sBAAA,SAA+B,eAAA;EDCnC;;;;;ECKZ,YAAA;;AAND;;;;EAYC,cAAA,EAAgB,aAAA;AAAA;;;;;AA0BjB;;;;;;;;;;;;;;;;;;;cAAa,eAAA,SAAwB,QAAA;EAAA,kBACX,IAAA;EAAA,SACT,YAAA;EAAA,SACA,cAAA,EAAgB,aAAA;ECzChB;;;;AAwBjB;;;ED0BC,WAAA,CAAY,OAAA,UAAiB,OAAA,EAAS,sBAAA;AAAA;;;;;;UClDtB,uBAAA,SAAgC,YAAA;EFCpC;EAAA,SECH,MAAA;AAAA;;;;;ADFV;;;;;;;;;;AAsCA;;;;;cCda,gBAAA,SAAyB,cAAA;EAAA,kBACZ,IAAA;EAAA,SACT,MAAA;;;;;;;EAQhB,WAAA,CAAY,OAAA,UAAiB,OAAA,GAAS,uBAAA;AAAA;;;;;;AFjCvC;;;;;UGIiB,uBAAA,sBAA6C,YAAA;;WAEpD,gBAAA,GAAmB,CAAA;EFP7B;EAAA,SESU,SAAA;AAAA;;;;;;;;AF6BV;;;;;;;;;;;;;;;cEJa,gBAAA,sBAAsC,cAAA;EAAA,SAClC,gBAAA,EAAkB,CAAA;EAAA,kBACT,IAAA;EAAA,SACT,SAAA;;;;ADrCjB;;;EC6CC,WAAA,CAAY,OAAA,UAAiB,OAAA,EAAS,uBAAA,CAAwB,CAAA;AAAA;;;;;;AH5C/D;;KICY,mBAAA;;;;UAWK,sBAAA,SAA+B,YAAA;;EAE/C,IAAA,EAAM,mBAAA;AAAA;;;;;;;;;AHuBP;;;;;;;;;;cGFa,eAAA,SAAwB,cAAA;EAAA,SACpB,IAAA,EAAM,mBAAA;EAAA,kBACG,IAAA;;;;;;;EAQzB,WAAA,CAAY,OAAA,UAAiB,OAAA,EAAS,sBAAA;AAAA"}

package/dist/index.mjs

@@ -1,3 +1,4 @@
-import { a as OpenCloudError, i as ApiError, n as PermissionError, r as NetworkError, t as RateLimitError } from "./rate-limit-BBU_4xnZ.mjs";
-import { t as ValidationError } from "./validation-CTZzJhmd.mjs";
-export { ApiError, NetworkError, OpenCloudError, PermissionError, RateLimitError, ValidationError };
+import { a as OpenCloudError, i as ApiError, n as PermissionError, r as NetworkError, t as RateLimitError } from "./rate-limit-CKfuhxT1.mjs";
+import { n as PollAbortedError, t as PollTimeoutError } from "./poll-timeout-BdUcWv52.mjs";
+import { t as ValidationError } from "./validation-VImVHzxg.mjs";
+export { ApiError, NetworkError, OpenCloudError, PermissionError, PollAbortedError, PollTimeoutError, RateLimitError, ValidationError };

package/dist/is-date-time-string-Ds8Ew-Xa.mjs

@@ -0,0 +1,19 @@
+//#region src/internal/utils/is-date-time-string.ts
+/**
+* Narrows `value` to a string that parses to a real {@link Date} via the
+* `Date(string)` constructor. Used by resource parsers to gate
+* `format: date-time` wire fields before handing them to `new Date(...)`,
+* which silently produces an `Invalid Date` for invalid input.
+*
+* @param value - The unknown wire value to validate.
+* @returns `true` when `value` is a string and `new Date(value).getTime()`
+*   is not `NaN`.
+*/
+function isDateTimeString(value) {
+	if (typeof value !== "string") return false;
+	return !Number.isNaN(new Date(value).getTime());
+}
+//#endregion
+export { isDateTimeString as t };
+
+//# sourceMappingURL=is-date-time-string-Ds8Ew-Xa.mjs.map

package/dist/is-date-time-string-Ds8Ew-Xa.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-date-time-string-Ds8Ew-Xa.mjs","names":[],"sources":["../src/internal/utils/is-date-time-string.ts"],"sourcesContent":["/**\n * Narrows `value` to a string that parses to a real {@link Date} via the\n * `Date(string)` constructor. Used by resource parsers to gate\n * `format: date-time` wire fields before handing them to `new Date(...)`,\n * which silently produces an `Invalid Date` for invalid input.\n *\n * @param value - The unknown wire value to validate.\n * @returns `true` when `value` is a string and `new Date(value).getTime()`\n *   is not `NaN`.\n */\nexport function isDateTimeString(value: unknown): value is string {\n\tif (typeof value !== \"string\") {\n\t\treturn false;\n\t}\n\n\treturn !Number.isNaN(new Date(value).getTime());\n}\n"],"mappings":";;;;;;;;;;;AAUA,SAAgB,iBAAiB,OAAiC;AACjE,KAAI,OAAO,UAAU,SACpB,QAAO;AAGR,QAAO,CAAC,OAAO,MAAM,IAAI,KAAK,MAAM,CAAC,SAAS,CAAC"}

package/dist/locales.d.mts

@@ -0,0 +1,2 @@
+import { i as RobloxLocale, n as RobloxCreatorLocale, r as RobloxLanguageCode, t as ROBLOX_CREATOR_LOCALES } from "./data.generated-DOaDx6J0.mjs";
+export { ROBLOX_CREATOR_LOCALES, type RobloxCreatorLocale, type RobloxLanguageCode, type RobloxLocale };