apify-client 3.0.0-beta.36 → 3.0.0-beta.38

package/dist/resource_clients/dataset.d.ts

@@ -4,6 +4,18 @@ import { ResourceClient } from '../base/resource_client.js';
 import type { Dataset, DatasetStatistics } from '../models.js';
 import type { TimeoutOptions } from '../timeouts.js';
 import type { PaginatedIterator, PaginationOptions } from '../utils.js';
+/**
+ * Supported formats for downloading dataset items.
+ */
+export declare enum DownloadItemsFormat {
+    JSON = "json",
+    JSONL = "jsonl",
+    XML = "xml",
+    HTML = "html",
+    CSV = "csv",
+    XLSX = "xlsx",
+    RSS = "rss"
+}
 export type { Dataset, DatasetStatistics, DatasetStats, FieldStatistics } from '../models.js';
 /**
  * Client for managing a specific Dataset.
@@ -211,6 +223,7 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
      * @param options - URL generation options (extends all options from {@link listItems})
      * @param options.expiresInSecs - Number of seconds until the signed URL expires. If omitted, the URL never expires.
      * @param options.fields - Array of field names to include in the response.
+     * @param options.format - Format of the items served by the URL. Defaults to `json`.
      * @param options.limit - Maximum number of items to return.
      * @param options.offset - Number of items to skip.
      * @param options.timeoutSecs - Timeout for the API request that fetches the dataset. Default is `'long'`.
@@ -280,25 +293,18 @@ export interface DatasetClientListItemOptions extends PaginationOptions, Timeout
 /**
  * Options for creating a public URL to access dataset items.
  *
- * Extends {@link DatasetClientListItemOptions} with URL expiration control, minus `chunkSize` (it only
+ * Extends {@link DatasetClientListItemOptions} with output format and URL expiration control, minus `chunkSize` (it only
  * sizes a client-side iteration) and `signature` (this method produces one).
  * @since Added in 2.16.0
  */
 export interface DatasetClientCreateItemsUrlOptions extends Omit<DatasetClientListItemOptions, 'chunkSize' | 'signature'> {
+    /**
+     * Format of the items served by the URL. Defaults to `json`.
+     * @since Added in 2.26.0
+     */
+    format?: `${DownloadItemsFormat}`;
     expiresInSecs?: number;
 }
-/**
- * Supported formats for downloading dataset items.
- */
-export declare enum DownloadItemsFormat {
-    JSON = "json",
-    JSONL = "jsonl",
-    XML = "xml",
-    HTML = "html",
-    CSV = "csv",
-    XLSX = "xlsx",
-    RSS = "rss"
-}
 /**
  * Options for downloading dataset items in a specific format.
  *

package/dist/resource_clients/dataset.js

@@ -4,6 +4,20 @@ import { ResourceClient } from '../base/resource_client.js';
 import * as schemas from '../schemas.js';
 import { timeoutOptionsSchema, timeoutOptionsShape } from '../timeouts.js';
 import { anyObjectSchema, applyQueryParamsToUrl, cast, isNonArrayObject, paginationOptionsShape, parseArgument, parseResponse, SCANNED_COUNT, } from '../utils.js';
+/**
+ * Supported formats for downloading dataset items.
+ */
+export var DownloadItemsFormat;
+(function (DownloadItemsFormat) {
+    DownloadItemsFormat["JSON"] = "json";
+    DownloadItemsFormat["JSONL"] = "jsonl";
+    DownloadItemsFormat["XML"] = "xml";
+    DownloadItemsFormat["HTML"] = "html";
+    DownloadItemsFormat["CSV"] = "csv";
+    DownloadItemsFormat["XLSX"] = "xlsx";
+    DownloadItemsFormat["RSS"] = "rss";
+})(DownloadItemsFormat || (DownloadItemsFormat = {}));
+const itemFormatSchema = z.enum(DownloadItemsFormat);
 // A predicate, not a `z.object()` arm, which would walk and copy every key of every pushed item.
 const itemSchema = z.custom(isNonArrayObject, 'Expected an object');
 const listItemsOptionsSchema = z.strictObject({
@@ -52,6 +66,7 @@ const createItemsPublicUrlOptionsSchema = z.strictObject({
     desc: z.boolean().optional(),
     flatten: z.array(z.string()).optional(),
     fields: z.array(z.string()).optional(),
+    format: itemFormatSchema.optional(),
     omit: z.array(z.string()).optional(),
     limit: z.number().min(0).optional(),
     offset: z.number().min(0).optional(),
@@ -335,6 +350,7 @@ export class DatasetClient extends ResourceClient {
      * @param options - URL generation options (extends all options from {@link listItems})
      * @param options.expiresInSecs - Number of seconds until the signed URL expires. If omitted, the URL never expires.
      * @param options.fields - Array of field names to include in the response.
+     * @param options.format - Format of the items served by the URL. Defaults to `json`.
      * @param options.limit - Maximum number of items to return.
      * @param options.offset - Number of items to skip.
      * @param options.timeoutSecs - Timeout for the API request that fetches the dataset. Default is `'long'`.
@@ -392,19 +408,3 @@ export class DatasetClient extends ResourceClient {
         });
     }
 }
-/**
- * Supported formats for downloading dataset items.
- */
-export var DownloadItemsFormat;
-(function (DownloadItemsFormat) {
-    DownloadItemsFormat["JSON"] = "json";
-    DownloadItemsFormat["JSONL"] = "jsonl";
-    DownloadItemsFormat["XML"] = "xml";
-    DownloadItemsFormat["HTML"] = "html";
-    DownloadItemsFormat["CSV"] = "csv";
-    DownloadItemsFormat["XLSX"] = "xlsx";
-    DownloadItemsFormat["RSS"] = "rss";
-})(DownloadItemsFormat || (DownloadItemsFormat = {}));
-const validItemFormats = [...new Set(Object.values(DownloadItemsFormat).map((item) => item.toLowerCase()))];
-// Declared below `validItemFormats` because it references it at module load time.
-const itemFormatSchema = z.enum(validItemFormats);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "3.0.0-beta.36",
+  "version": "3.0.0-beta.38",
   "description": "Apify API client for JavaScript",
   "engines": {
     "node": ">=22.0.0"