rozod 6.7.1 → 6.8.0

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpoint = exports.hbaClient = void 0;
+exports.endpoint = exports.OperationSchema = exports.hbaClient = void 0;
 exports.configureServer = configureServer;
 exports.clearServerConfig = clearServerConfig;
 exports.getServerConfig = getServerConfig;
@@ -14,6 +14,8 @@ exports.fetchApi = fetchApi;
 exports.fetchApiSplit = fetchApiSplit;
 exports.fetchApiPages = fetchApiPages;
 exports.fetchApiPagesGenerator = fetchApiPagesGenerator;
+exports.pollOperation = pollOperation;
+exports.fetchApiOperation = fetchApiOperation;
 const zod_1 = require("zod");
 const cache_1 = require("./cache");
 const roblox_bat_1 = require("roblox-bat");
@@ -78,6 +80,10 @@ function prepareRequestUrl(endpoint, extendedParams) {
         if (key === 'body' || usedPathParams.has(key))
             continue;
         const value = paramsObject[key];
+        // An unset optional parameter must be omitted, not serialized as the literal
+        // string "undefined"/"null" (which the API would reject as an invalid value).
+        if (value === undefined || value === null)
+            continue;
         const serializationMethod = endpoint.serializationMethod?.[key];
         // Handle exploded arrays by creating separate query params for each element
         if (Array.isArray(value) && serializationMethod?.explode) {
@@ -971,3 +977,110 @@ async function* fetchApiPagesGenerator(endpoint, initialParams, requestOptions,
         cursor = nextCursor;
     }
 }
+/**
+ * Roblox Open Cloud long-running operation envelope. Endpoints such as
+ * `generateThumbnail` / `generateAsset` return this instead of the final
+ * result: `done` is false until the work completes, at which point `response`
+ * holds the payload. Fields are optional because the API omits `response`
+ * (and sometimes `done`) while the operation is still in progress.
+ */
+exports.OperationSchema = zod_1.z.object({
+    path: zod_1.z.string(),
+    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+    done: zod_1.z.boolean().optional(),
+    error: zod_1.z
+        .object({
+        code: zod_1.z.number().optional(),
+        message: zod_1.z.string().optional(),
+        details: zod_1.z.array(zod_1.z.any()).optional(),
+    })
+        .partial()
+        .optional(),
+    response: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+});
+function sleep(ms, signal) {
+    return new Promise((resolve, reject) => {
+        if (signal?.aborted) {
+            reject(signal.reason ?? new Error('Aborted'));
+            return;
+        }
+        const timer = setTimeout(() => {
+            signal?.removeEventListener('abort', onAbort);
+            resolve();
+        }, ms);
+        const onAbort = () => {
+            clearTimeout(timer);
+            reject(signal?.reason ?? new Error('Aborted'));
+        };
+        signal?.addEventListener('abort', onAbort, { once: true });
+    });
+}
+function buildOperationUrl(endpoint, operationPath, options) {
+    const base = (options?.baseUrl ?? endpoint.baseUrl).replace(/\/+$/, '');
+    let prefix = options?.pathPrefix;
+    if (prefix === undefined) {
+        // Derive the version prefix by locating the operation path's leading segment
+        // within the originating endpoint's path (e.g. `/cloud/v2/users/:id:generate…` → `/cloud/v2`).
+        const firstSegment = operationPath.replace(/^\/+/, '').split('/')[0];
+        const marker = '/' + firstSegment + '/';
+        const idx = firstSegment ? endpoint.path.indexOf(marker) : -1;
+        prefix = idx > 0 ? endpoint.path.slice(0, idx) : '';
+    }
+    const cleanPrefix = prefix ? '/' + prefix.replace(/^\/+|\/+$/g, '') : '';
+    const cleanPath = operationPath.replace(/^\/+/, '');
+    return `${base}${cleanPrefix}/${cleanPath}`;
+}
+function isZodSchema(value) {
+    return typeof value?.safeParse === 'function';
+}
+async function pollOperation(endpoint, operation, resultSchemaOrOptions, maybeOptions = {}) {
+    const explicitSchema = isZodSchema(resultSchemaOrOptions) ? resultSchemaOrOptions : undefined;
+    const options = explicitSchema ? maybeOptions : (resultSchemaOrOptions ?? {});
+    const schema = explicitSchema ?? endpoint.resultResponse;
+    const interval = options.interval ?? 1000;
+    const timeout = options.timeout ?? 30000;
+    const deadline = Date.now() + timeout;
+    const finish = (op) => {
+        if (op.error && (op.error.message || op.error.code)) {
+            throw new Error(op.error.message ?? `Operation failed with code ${op.error.code}`);
+        }
+        return schema ? schema.parse(op.response) : op.response;
+    };
+    if (operation.done) {
+        return finish(operation);
+    }
+    const url = buildOperationUrl(endpoint, operation.path, options);
+    const pollEndpoint = {
+        method: 'GET',
+        path: '',
+        baseUrl: url,
+        requestFormat: 'json',
+        parameters: {},
+        response: exports.OperationSchema,
+        errors: [],
+    };
+    while (true) {
+        await sleep(interval, options.signal);
+        const polled = (await fetchApi(pollEndpoint, {}, {
+            ...options.requestOptions,
+            throwOnError: true,
+        }));
+        if (polled.done) {
+            return finish(polled);
+        }
+        if (Date.now() >= deadline) {
+            throw new Error(`Operation "${operation.path}" did not complete within ${timeout}ms`);
+        }
+    }
+}
+async function fetchApiOperation(endpoint, params, resultSchemaOrOptions, maybeOptions = {}) {
+    const explicitSchema = isZodSchema(resultSchemaOrOptions) ? resultSchemaOrOptions : undefined;
+    const options = explicitSchema ? maybeOptions : (resultSchemaOrOptions ?? {});
+    const operation = (await fetchApi(endpoint, params, {
+        ...options.requestOptions,
+        throwOnError: true,
+    }));
+    return explicitSchema
+        ? pollOperation(endpoint, operation, explicitSchema, options)
+        : pollOperation(endpoint, operation, options);
+}

package/lib/opencloud/v1/asset-permissions.d.ts

@@ -27,4 +27,4 @@ export declare const patchAssetPermissionsApiV1AssetsPermissions: import("../.."
     }[] | null | undefined;
     assetIds?: number[] | null | undefined;
     enableDeepAccessCheck?: boolean | undefined;
-}>;
+}, undefined>;

package/lib/opencloud/v1/assets.d.ts

@@ -80,7 +80,7 @@ export declare const postAssets: import("../..").EndpointGeneric<{}, {
         };
     };
     fileContent: File;
-}>;
+}, undefined>;
 /**
  * **Get Asset** · `BETA`
  *
@@ -123,7 +123,7 @@ export declare const getAssetsAssetId: import("../..").EndpointGeneric<{
         title: string;
         uri: string;
     };
-}, undefined>;
+}, undefined, undefined>;
 /**
  * **Update Asset** · `BETA`
  *
@@ -209,7 +209,7 @@ export declare const patchAssetsAssetId: import("../..").EndpointGeneric<{
         };
     } | undefined;
     fileContent?: File | undefined;
-}>;
+}, undefined>;
 /**
  * **Archive Asset** · `BETA`
  *
@@ -250,7 +250,7 @@ export declare const postAssetsAssetIdArchive: import("../..").EndpointGeneric<{
         title: string;
         uri: string;
     };
-}, undefined>;
+}, undefined, undefined>;
 /**
  * **Restore Asset** · `BETA`
  *
@@ -291,7 +291,7 @@ export declare const postAssetsAssetIdRestore: import("../..").EndpointGeneric<{
         title: string;
         uri: string;
     };
-}, undefined>;
+}, undefined, undefined>;
 /**
  * **List Asset Versions** · `BETA`
  *
@@ -321,7 +321,7 @@ export declare const getAssetsAssetIdVersions: import("../..").EndpointGeneric<{
         moderationState: string;
     };
     published: boolean;
-}[], undefined>;
+}[], undefined, undefined>;
 /**
  * **Rollback Asset Version** · `BETA`
  *
@@ -352,7 +352,7 @@ export declare const postAssetsAssetIdVersionsRollback: import("../..").Endpoint
     published: boolean;
 }, {
     assetVersion: string;
-}>;
+}, undefined>;
 /**
  * **Get Asset Version** · `BETA`
  *
@@ -380,7 +380,7 @@ export declare const getAssetsAssetIdVersionsVersionNumber: import("../..").Endp
         moderationState: string;
     };
     published: boolean;
-}, undefined>;
+}, undefined, undefined>;
 /**
  * **Get Operation** · `BETA`
  *
@@ -429,4 +429,4 @@ export declare const getOperationsOperationId: import("../..").EndpointGeneric<{
             uri: string;
         };
     };
-}, undefined>;
+}, undefined, undefined>;

package/lib/opencloud/v1/datastores-ordered.d.ts

@@ -30,7 +30,7 @@ export declare const getUniversesUniverseIdOrderedDataStoresOrderedDataStoreScop
         value: number;
     }[];
     nextPageToken: string;
-}, undefined>;
+}, undefined, undefined>;
 /**
  * **Create** · `BETA`
  *
@@ -57,7 +57,7 @@ export declare const postUniversesUniverseIdOrderedDataStoresOrderedDataStoreSco
     value: number;
 }, {
     value: number;
-}>;
+}, undefined>;
 /**
  * **Get** · `BETA`
  *
@@ -81,7 +81,7 @@ export declare const getUniversesUniverseIdOrderedDataStoresOrderedDataStoreScop
     path: string;
     id: string;
     value: number;
-}, undefined>;
+}, undefined, undefined>;
 /**
  * **Delete** · `BETA`
  *
@@ -101,7 +101,7 @@ export declare const deleteUniversesUniverseIdOrderedDataStoresOrderedDataStoreS
     scope: string;
     orderedDataStore: string;
     entry: string;
-}, void, undefined>;
+}, void, undefined, undefined>;
 /**
  * **Update** · `BETA`
  *
@@ -130,7 +130,7 @@ export declare const patchUniversesUniverseIdOrderedDataStoresOrderedDataStoreSc
     value: number;
 }, {
     value?: number | undefined;
-}>;
+}, undefined>;
 /**
  * **Increment** · `BETA`
  *
@@ -159,4 +159,4 @@ export declare const postUniversesUniverseIdOrderedDataStoresOrderedDataStoreSco
     value: number;
 }, {
     amount: number;
-}>;
+}, undefined>;

package/lib/opencloud/v1/datastores.d.ts

@@ -24,7 +24,7 @@ export declare const getUniversesUniverseIdDatastores: import("../..").EndpointG
         createdTime: string | null;
     }[];
     nextPageCursor: string | null;
-}, undefined>;
+}, undefined, undefined>;
 /**
  * **List Entries** · `BETA`
  *
@@ -57,7 +57,7 @@ export declare const getUniversesUniverseIdDatastoresDatastoreEntries: import(".
 }, {
     keys: string[];
     nextPageCursor: string | null;
-}, undefined>;
+}, undefined, undefined>;
 /**
  * **Get Entry** · `BETA`
  *
@@ -101,7 +101,7 @@ export declare const getUniversesUniverseIdDatastoresDatastoreEntriesEntry: impo
     datastoreName?: string | null | undefined;
     scope?: string | null | undefined;
     entryKey?: string | null | undefined;
-}, Record<string, never>, undefined>;
+}, Record<string, never>, undefined, undefined>;
 /**
  * **Set Entry** · `BETA`
  *
@@ -136,7 +136,7 @@ export declare const postUniversesUniverseIdDatastoresDatastoreEntriesEntry: imp
     "roblox-entry-attributes"?: string | null | undefined;
     "roblox-entry-userids"?: string | null | undefined;
     "content-md5"?: string | null | undefined;
-}, void, string>;
+}, void, string, undefined>;
 /**
  * **Delete Entry** · `BETA`
  *
@@ -158,7 +158,7 @@ export declare const deleteUniversesUniverseIdDatastoresDatastoreEntriesEntry: i
     datastoreName?: string | null | undefined;
     scope?: string | null | undefined;
     entryKey?: string | null | undefined;
-}, void, undefined>;
+}, void, undefined, undefined>;
 /**
  * **Increment Entry** · `BETA`
  *
@@ -206,7 +206,7 @@ export declare const postUniversesUniverseIdDatastoresDatastoreEntriesEntryIncre
     "roblox-entry-attributes"?: string | null | undefined;
     "roblox-entry-userids"?: string | null | undefined;
     incrementBy?: number | undefined;
-}, Record<string, never>, undefined>;
+}, Record<string, never>, undefined, undefined>;
 /**
  * **List Entry Versions** · `BETA`
  *
@@ -238,7 +238,7 @@ export declare const getUniversesUniverseIdDatastoresDatastoreEntriesEntryVersio
     scope?: string | null | undefined;
     entryKey?: string | null | undefined;
     sortOrder?: string | null | undefined;
-}, void, undefined>;
+}, void, undefined, undefined>;
 /**
  * **Get Entry Version** · `BETA`
  *
@@ -282,4 +282,4 @@ export declare const getUniversesUniverseIdDatastoresDatastoreEntriesEntryVersio
     scope?: string | null | undefined;
     entryKey?: string | null | undefined;
     versionId?: string | null | undefined;
-}, Record<string, never>, undefined>;
+}, Record<string, never>, undefined, undefined>;

package/lib/opencloud/v1/developer-products.d.ts

@@ -33,7 +33,7 @@ export declare const postDeveloperProductsV2UniversesUniverseIdDeveloperProducts
     price?: number | null | undefined;
     imageFile?: File | null | undefined;
     isRegionalPricingEnabled?: boolean | null | undefined;
-}>;
+}, undefined>;
 /**
  * `BETA`
  *
@@ -58,7 +58,7 @@ export declare const patchDeveloperProductsV2UniversesUniverseIdDeveloperProduct
     imageFile?: File | null | undefined;
     isRegionalPricingEnabled?: boolean | null | undefined;
     storePageEnabled?: boolean | null | undefined;
-}>;
+}, undefined>;
 /**
  * `BETA`
  *
@@ -88,7 +88,7 @@ export declare const getDeveloperProductsV2UniversesUniverseIdDeveloperProductsP
     isImmutable: boolean;
     createdTimestamp: string;
     updatedTimestamp: string;
-}, undefined>;
+}, undefined, undefined>;
 /**
  * `BETA`
  *
@@ -123,4 +123,4 @@ export declare const getDeveloperProductsV2UniversesUniverseIdDeveloperProductsC
         updatedTimestamp: string;
     }[];
     nextPageToken: string | null;
-}, undefined>;
+}, undefined, undefined>;

package/lib/opencloud/v1/game-passes.d.ts

@@ -30,7 +30,7 @@ export declare const postGamePassesV1UniversesUniverseIdGamePasses: import("../.
     isForSale?: boolean | null | undefined;
     price?: number | null | undefined;
     isRegionalPricingEnabled?: boolean | null | undefined;
-}>;
+}, undefined>;
 /**
  * `BETA`
  *
@@ -54,7 +54,7 @@ export declare const patchGamePassesV1UniversesUniverseIdGamePassesGamePassId: i
     isForSale?: boolean | null | undefined;
     price?: number | null | undefined;
     isRegionalPricingEnabled?: boolean | null | undefined;
-}>;
+}, undefined>;
 /**
  * `BETA`
  *
@@ -81,7 +81,7 @@ export declare const getGamePassesV1UniversesUniverseIdGamePassesGamePassIdCreat
         defaultPriceInRobux: number | null;
         enabledFeatures: ("Invalid" | "PriceOptimization" | "UserFixedPrice" | "RegionalPricing")[];
     } | null;
-}, undefined>;
+}, undefined, undefined>;
 /**
  * `BETA`
  *
@@ -113,4 +113,4 @@ export declare const getGamePassesV1UniversesUniverseIdGamePassesCreator: import
         } | null;
     }[];
     nextPageToken: string | null;
-}, undefined>;
+}, undefined, undefined>;

package/lib/opencloud/v1/messaging.d.ts

@@ -16,4 +16,4 @@ export declare const postUniversesUniverseIdTopicsTopic: import("../..").Endpoin
     topic: string | null;
 }, void, {
     message: string | null;
-}>;
+}, undefined>;

package/lib/opencloud/v1/open-eval.d.ts

@@ -23,7 +23,7 @@ export declare const postOpenEvalApiV1Eval: import("../..").EndpointGeneric<{},
         model_version?: string | null | undefined;
         api_key?: string | null | undefined;
     } | undefined;
-}>;
+}, undefined>;
 /**
  * `BETA`
  *
@@ -64,4 +64,4 @@ export declare const getOpenEvalApiV1EvalRecordsJobId: import("../..").EndpointG
     fullLogs?: string | null | undefined;
     evalSucceeded?: string | null | undefined;
     createUtc?: string | null | undefined;
-}, undefined>;
+}, undefined, undefined>;

package/lib/opencloud/v1/secrets-store.d.ts

@@ -37,7 +37,7 @@ export declare const postCloudV2UniversesUniverseIdSecrets: import("../..").Endp
     domain: string | null;
     create_time: string | null;
     update_time: string | null;
-}>;
+}, undefined>;
 /**
  * `BETA`
  *
@@ -69,7 +69,7 @@ export declare const getCloudV2UniversesUniverseIdSecrets: import("../..").Endpo
     }[] | null;
     nextPageCursor: string | null;
     previousPageCursor: string | null;
-}, undefined>;
+}, undefined, undefined>;
 /**
  * `BETA`
  *
@@ -113,7 +113,7 @@ export declare const patchCloudV2UniversesUniverseIdSecretsSecretId: import("../
     domain?: string | null | undefined;
     create_time?: string | null | undefined;
     update_time?: string | null | undefined;
-}>;
+}, undefined>;
 /**
  * `BETA`
  *
@@ -133,7 +133,7 @@ This operation is irreversible. Make sure you no longer need the secret before d
 export declare const deleteCloudV2UniversesUniverseIdSecretsSecretId: import("../..").EndpointGeneric<{
     universeId: number;
     secretId: string;
-}, void, undefined>;
+}, void, undefined, undefined>;
 /**
  * `BETA`
  *
@@ -165,4 +165,4 @@ export declare const getCloudV2UniversesUniverseIdSecretsPublicKey: import("../.
     domain: string | null;
     create_time: string | null;
     update_time: string | null;
-}, undefined>;
+}, undefined, undefined>;

package/lib/opencloud/v1/toolbox.d.ts

@@ -115,7 +115,7 @@ export declare const getToolboxServiceV2AssetsSearch: import("../..").EndpointGe
     }[] | null;
     totalResults: number;
     filteredKeyword: string | null;
-} | null, undefined>;
+} | null, undefined, undefined>;
 /**
  * `BETA`
  *
@@ -174,4 +174,4 @@ export declare const getToolboxServiceV2AssetsId: import("../..").EndpointGeneri
         updateTime: string | null;
         categoryPath: string | null;
     } | null;
-} | null, undefined>;
+} | null, undefined, undefined>;

package/lib/opencloud/v1/universes.d.ts

@@ -15,4 +15,4 @@ export declare const postUniverseIdPlacesPlaceIdVersions: import("../..").Endpoi
     universeId: number;
     placeId: number;
     versionType?: string | null | undefined;
-}, void, undefined>;
+}, void, undefined, undefined>;