apify-client 2.20.1-beta.6 → 2.20.1-beta.8

package/dist/resource_clients/dataset.d.ts

@@ -2,56 +2,229 @@ import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
 import type { PaginatedList } from '../utils';
+/**
+ * Client for managing a specific Dataset.
+ *
+ * Datasets store structured data results from Actor runs. This client provides methods to push items,
+ * list and retrieve items, download items in various formats (JSON, CSV, Excel, etc.), and manage
+ * the dataset.
+ *
+ * @template Data - Type of items stored in the dataset
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const datasetClient = client.dataset('my-dataset-id');
+ *
+ * // Push items to the dataset
+ * await datasetClient.pushItems([
+ *   { url: 'https://example.com', title: 'Example' },
+ *   { url: 'https://test.com', title: 'Test' }
+ * ]);
+ *
+ * // List all items
+ * const { items } = await datasetClient.listItems();
+ *
+ * // Download items as CSV
+ * const buffer = await datasetClient.downloadItems('csv');
+ * ```
+ *
+ * @see https://docs.apify.com/platform/storage/dataset
+ */
 export declare class DatasetClient<Data extends Record<string | number, any> = Record<string | number, unknown>> extends ResourceClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset
+     * Gets the dataset object from the Apify API.
+     *
+     * @returns The Dataset object, or `undefined` if it does not exist
+     * @see https://docs.apify.com/api/v2/dataset-get
      */
     get(): Promise<Dataset | undefined>;
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset
+     * Updates the dataset with specified fields.
+     *
+     * @param newFields - Fields to update in the dataset
+     * @returns The updated Dataset object
+     * @see https://docs.apify.com/api/v2/dataset-put
      */
     update(newFields: DatasetClientUpdateOptions): Promise<Dataset>;
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset
+     * Deletes the dataset.
+     *
+     * @see https://docs.apify.com/api/v2/dataset-delete
      */
     delete(): Promise<void>;
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items
+     * Lists items in the dataset.
+     *
+     * Returns a paginated list of dataset items. You can use pagination parameters to retrieve
+     * specific subsets of items, and various filtering and formatting options to customize
+     * the output.
+     *
+     * @param options - Options for listing items
+     * @param options.limit - Maximum number of items to return. Default is all items.
+     * @param options.offset - Number of items to skip from the beginning. Default is 0.
+     * @param options.desc - If `true`, items are returned in descending order (newest first). Default is `false`.
+     * @param options.fields - Array of field names to include in the results. Omits all other fields.
+     * @param options.omit - Array of field names to exclude from the results.
+     * @param options.clean - If `true`, returns only non-empty items and skips hidden fields. Default is `false`.
+     * @param options.skipEmpty - If `true`, skips empty items. Default is `false`.
+     * @param options.skipHidden - If `true`, skips hidden fields (fields starting with `#`). Default is `false`.
+     * @param options.flatten - Array of field names to flatten. Nested objects are converted to dot notation (e.g., `obj.field`).
+     * @param options.unwind - Field name or array of field names to unwind. Each array value creates a separate item.
+     * @param options.view - Name of a predefined view to use for field selection.
+     * @returns A paginated list with `items`, `total` count, `offset`, `count`, and `limit`
+     * @see https://docs.apify.com/api/v2/dataset-items-get
+     *
+     * @example
+     * ```javascript
+     * // Get first 100 items
+     * const { items, total } = await client.dataset('my-dataset').listItems({ limit: 100 });
+     * console.log(`Retrieved ${items.length} of ${total} total items`);
+     *
+     * // Get items with specific fields only
+     * const { items } = await client.dataset('my-dataset').listItems({
+     *   fields: ['url', 'title'],
+     *   skipEmpty: true,
+     *   limit: 50
+     * });
+     *
+     * // Get items in descending order with pagination
+     * const { items } = await client.dataset('my-dataset').listItems({
+     *   desc: true,
+     *   offset: 100,
+     *   limit: 50
+     * });
+     * ```
      */
     listItems(options?: DatasetClientListItemOptions): Promise<PaginatedList<Data>>;
     /**
-     * Unlike `listItems` which returns a {@link PaginationList} with an array of individual
-     * dataset items, `downloadItems` returns the items serialized to the provided format.
-     * https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items
+     * Downloads dataset items in a specific format.
+     *
+     * Unlike {@link listItems} which returns a {@link PaginatedList} with an array of individual
+     * dataset items, this method returns the items serialized to the provided format
+     * (JSON, CSV, Excel, etc.) as a Buffer. Useful for exporting data for further processing.
+     *
+     * @param format - Output format: `'json'`, `'jsonl'`, `'csv'`, `'xlsx'`, `'xml'`, `'rss'`, or `'html'`
+     * @param options - Download and formatting options (extends all options from {@link listItems})
+     * @param options.attachment - If `true`, the response will have `Content-Disposition: attachment` header.
+     * @param options.bom - If `true`, adds UTF-8 BOM to the beginning of the file (useful for Excel compatibility).
+     * @param options.delimiter - CSV delimiter character. Default is `,` (comma).
+     * @param options.skipHeaderRow - If `true`, CSV export will not include the header row with field names.
+     * @param options.xmlRoot - Name of the root XML element. Default is `'items'`.
+     * @param options.xmlRow - Name of the XML element for each item. Default is `'item'`.
+     * @param options.fields - Array of field names to include in the export.
+     * @param options.omit - Array of field names to exclude from the export.
+     * @returns Buffer containing the serialized data in the specified format
+     * @see https://docs.apify.com/api/v2/dataset-items-get
+     *
+     * @example
+     * ```javascript
+     * // Download as CSV with BOM for Excel compatibility
+     * const csvBuffer = await client.dataset('my-dataset').downloadItems('csv', { bom: true });
+     * require('fs').writeFileSync('output.csv', csvBuffer);
+     *
+     * // Download as Excel with custom options
+     * const xlsxBuffer = await client.dataset('my-dataset').downloadItems('xlsx', {
+     *   fields: ['url', 'title', 'price'],
+     *   skipEmpty: true,
+     *   limit: 1000
+     * });
+     *
+     * // Download as XML with custom element names
+     * const xmlBuffer = await client.dataset('my-dataset').downloadItems('xml', {
+     *   xmlRoot: 'products',
+     *   xmlRow: 'product'
+     * });
+     * ```
      */
     downloadItems(format: DownloadItemsFormat, options?: DatasetClientDownloadItemsOptions): Promise<Buffer>;
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items
+     * Stores one or more items into the dataset.
+     *
+     * Items can be objects, strings, or arrays thereof. Each item will be stored as a separate
+     * record in the dataset. Objects are automatically serialized to JSON. If you provide an array,
+     * all items will be stored in order. This method is idempotent - calling it multiple times
+     * with the same data will not create duplicates, but will append items each time.
+     *
+     * @param items - A single item (object or string) or an array of items to store.
+     *                Objects are automatically stringified to JSON. Strings are stored as-is.
+     * @see https://docs.apify.com/api/v2/dataset-items-post
+     *
+     * @example
+     * ```javascript
+     * // Store a single object
+     * await client.dataset('my-dataset').pushItems({
+     *   url: 'https://example.com',
+     *   title: 'Example Page',
+     *   extractedAt: new Date()
+     * });
+     *
+     * // Store multiple items at once
+     * await client.dataset('my-dataset').pushItems([
+     *   { url: 'https://example.com', title: 'Example' },
+     *   { url: 'https://test.com', title: 'Test' },
+     *   { url: 'https://demo.com', title: 'Demo' }
+     * ]);
+     *
+     * // Store string items
+     * await client.dataset('my-dataset').pushItems(['item1', 'item2', 'item3']);
+     * ```
      */
     pushItems(items: Data | Data[] | string | string[]): Promise<void>;
     /**
-     * https://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get
+     * Gets statistical information about the dataset.
+     *
+     * Returns statistics for each field in the dataset, including information about
+     * data types, null counts, and value ranges.
+     *
+     * @returns Dataset statistics, or `undefined` if not available
+     * @see https://docs.apify.com/api/v2/dataset-statistics-get
      */
     getStatistics(): Promise<DatasetStatistics | undefined>;
     /**
-     * Generates a URL that can be used to access dataset items.
+     * Generates a public URL for accessing dataset items.
      *
      * If the client has permission to access the dataset's URL signing key,
-     * the URL will include a signature which will allow the link to work even without authentication.
+     * the URL will include a cryptographic signature allowing access without authentication.
+     * This is useful for sharing dataset results with external services or users.
+     *
+     * @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.limit - Maximum number of items to return.
+     * @param options.offset - Number of items to skip.
+     * @returns A public URL string for accessing the dataset items
      *
-     * You can optionally control how long the signed URL should be valid using the `expiresInSecs` option.
-     * This value sets the expiration duration in seconds from the time the URL is generated.
-     * If not provided, the URL will not expire.
+     * @example
+     * ```javascript
+     * // Create a URL that expires in 1 hour with specific fields
+     * const url = await client.dataset('my-dataset').createItemsPublicUrl({
+     *   expiresInSecs: 3600,
+     *   fields: ['url', 'title'],
+     *   limit: 100
+     * });
+     * console.log(`Share this URL: ${url}`);
      *
-     * Any other options (like `limit` or `prefix`) will be included as query parameters in the URL.
+     * // Create a permanent public URL for clean items only
+     * const url = await client.dataset('my-dataset').createItemsPublicUrl({
+     *   clean: true,
+     *   skipEmpty: true
+     * });
+     * ```
      */
     createItemsPublicUrl(options?: DatasetClientCreateItemsUrlOptions): Promise<string>;
     private _createPaginationList;
 }
+/**
+ * Represents a dataset storage on the Apify platform.
+ *
+ * Datasets store structured data as a sequence of items (records). Each item is a JSON object.
+ * Datasets are useful for storing results from web scraping, crawling, or data processing tasks.
+ */
 export interface Dataset {
     id: string;
     name?: string;
@@ -71,17 +244,29 @@ export interface Dataset {
     urlSigningSecretKey?: string | null;
     itemsPublicUrl: string;
 }
+/**
+ * Statistics about dataset usage and storage.
+ */
 export interface DatasetStats {
     readCount?: number;
     writeCount?: number;
     deleteCount?: number;
     storageBytes?: number;
 }
+/**
+ * Options for updating a dataset.
+ */
 export interface DatasetClientUpdateOptions {
     name?: string | null;
     title?: string;
     generalAccess?: STORAGE_GENERAL_ACCESS | null;
 }
+/**
+ * Options for listing items from a dataset.
+ *
+ * Provides various filtering, pagination, and transformation options to customize
+ * the output format and content of retrieved items.
+ */
 export interface DatasetClientListItemOptions {
     clean?: boolean;
     desc?: boolean;
@@ -96,9 +281,17 @@ export interface DatasetClientListItemOptions {
     view?: string;
     signature?: string;
 }
+/**
+ * Options for creating a public URL to access dataset items.
+ *
+ * Extends {@link DatasetClientListItemOptions} with URL expiration control.
+ */
 export interface DatasetClientCreateItemsUrlOptions extends DatasetClientListItemOptions {
     expiresInSecs?: number;
 }
+/**
+ * Supported formats for downloading dataset items.
+ */
 export declare enum DownloadItemsFormat {
     JSON = "json",
     JSONL = "jsonl",
@@ -108,6 +301,11 @@ export declare enum DownloadItemsFormat {
     XLSX = "xlsx",
     RSS = "rss"
 }
+/**
+ * Options for downloading dataset items in a specific format.
+ *
+ * Extends {@link DatasetClientListItemOptions} with format-specific options.
+ */
 export interface DatasetClientDownloadItemsOptions extends DatasetClientListItemOptions {
     attachment?: boolean;
     bom?: boolean;
@@ -116,9 +314,17 @@ export interface DatasetClientDownloadItemsOptions extends DatasetClientListItem
     xmlRoot?: string;
     xmlRow?: string;
 }
+/**
+ * Statistical information about dataset fields.
+ *
+ * Provides insights into the data structure and content of the dataset.
+ */
 export interface DatasetStatistics {
     fieldStatistics: Record<string, FieldStatistics>;
 }
+/**
+ * Statistics for a single field in a dataset.
+ */
 export interface FieldStatistics {
     min?: number;
     max?: number;

package/dist/resource_clients/dataset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataset.d.ts","sourceRoot":"","sources":["../../src/resource_clients/dataset.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAI5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAGH,cAAc,EAEjB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG9C,qBAAa,aAAa,CACtB,IAAI,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAC9E,SAAQ,cAAc;IACpB;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAIzC;;OAEG;IACG,MAAM,CAAC,SAAS,EAAE,0BAA0B,GAAG,OAAO,CAAC,OAAO,CAAC;IAMrE;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;OAEG;IACG,SAAS,CAAC,OAAO,GAAE,4BAAiC,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IA6BzF;;;;OAIG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,GAAE,iCAAsC,GAAG,OAAO,CAAC,MAAM,CAAC;IAwClH;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,IAAI,GAAG,IAAI,EAAE,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBxE;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAgB7D;;;;;;;;;;;OAWG;IACG,oBAAoB,CAAC,OAAO,GAAE,kCAAuC,GAAG,OAAO,CAAC,MAAM,CAAC;IAuC7F,OAAO,CAAC,qBAAqB;CAWhC;AAED,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,YAAY,CAAC;IACpB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC9C,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,0BAA0B;IACvC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,4BAA4B;IACzC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kCAAmC,SAAQ,4BAA4B;IACpF,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,oBAAY,mBAAmB;IAC3B,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;CACd;AAID,MAAM,WAAW,iCAAkC,SAAQ,4BAA4B;IACnF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAC9B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CACpD;AAED,MAAM,WAAW,eAAe;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB"}
+{"version":3,"file":"dataset.d.ts","sourceRoot":"","sources":["../../src/resource_clients/dataset.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAI5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAGH,cAAc,EAEjB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,aAAa,CACtB,IAAI,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAC9E,SAAQ,cAAc;IACpB;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;OAKG;IACG,GAAG,IAAI,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAIzC;;;;;;OAMG;IACG,MAAM,CAAC,SAAS,EAAE,0BAA0B,GAAG,OAAO,CAAC,OAAO,CAAC;IAMrE;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,SAAS,CAAC,OAAO,GAAE,4BAAiC,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IA6BzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,GAAE,iCAAsC,GAAG,OAAO,CAAC,MAAM,CAAC;IAwClH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,SAAS,CAAC,KAAK,EAAE,IAAI,GAAG,IAAI,EAAE,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBxE;;;;;;;;OAQG;IACG,aAAa,IAAI,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAgB7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,oBAAoB,CAAC,OAAO,GAAE,kCAAuC,GAAG,OAAO,CAAC,MAAM,CAAC;IAuC7F,OAAO,CAAC,qBAAqB;CAWhC;AAED;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,YAAY,CAAC;IACpB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC9C,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;CACjD;AAED;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B;IACzC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAmC,SAAQ,4BAA4B;IACpF,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,oBAAY,mBAAmB;IAC3B,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;CACd;AAID;;;;GAIG;AACH,MAAM,WAAW,iCAAkC,SAAQ,4BAA4B;IACnF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/resource_clients/dataset.js

@@ -6,6 +6,35 @@ const ow_1 = tslib_1.__importDefault(require("ow"));
 const utilities_1 = require("@apify/utilities");
 const resource_client_1 = require("../base/resource_client");
 const utils_1 = require("../utils");
+/**
+ * Client for managing a specific Dataset.
+ *
+ * Datasets store structured data results from Actor runs. This client provides methods to push items,
+ * list and retrieve items, download items in various formats (JSON, CSV, Excel, etc.), and manage
+ * the dataset.
+ *
+ * @template Data - Type of items stored in the dataset
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const datasetClient = client.dataset('my-dataset-id');
+ *
+ * // Push items to the dataset
+ * await datasetClient.pushItems([
+ *   { url: 'https://example.com', title: 'Example' },
+ *   { url: 'https://test.com', title: 'Test' }
+ * ]);
+ *
+ * // List all items
+ * const { items } = await datasetClient.listItems();
+ *
+ * // Download items as CSV
+ * const buffer = await datasetClient.downloadItems('csv');
+ * ```
+ *
+ * @see https://docs.apify.com/platform/storage/dataset
+ */
 class DatasetClient extends resource_client_1.ResourceClient {
     /**
      * @hidden
@@ -17,26 +46,75 @@ class DatasetClient extends resource_client_1.ResourceClient {
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset
+     * Gets the dataset object from the Apify API.
+     *
+     * @returns The Dataset object, or `undefined` if it does not exist
+     * @see https://docs.apify.com/api/v2/dataset-get
      */
     async get() {
         return this._get({}, resource_client_1.SMALL_TIMEOUT_MILLIS);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset
+     * Updates the dataset with specified fields.
+     *
+     * @param newFields - Fields to update in the dataset
+     * @returns The updated Dataset object
+     * @see https://docs.apify.com/api/v2/dataset-put
      */
     async update(newFields) {
         (0, ow_1.default)(newFields, ow_1.default.object);
         return this._update(newFields, resource_client_1.SMALL_TIMEOUT_MILLIS);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset
+     * Deletes the dataset.
+     *
+     * @see https://docs.apify.com/api/v2/dataset-delete
      */
     async delete() {
         return this._delete(resource_client_1.SMALL_TIMEOUT_MILLIS);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items
+     * Lists items in the dataset.
+     *
+     * Returns a paginated list of dataset items. You can use pagination parameters to retrieve
+     * specific subsets of items, and various filtering and formatting options to customize
+     * the output.
+     *
+     * @param options - Options for listing items
+     * @param options.limit - Maximum number of items to return. Default is all items.
+     * @param options.offset - Number of items to skip from the beginning. Default is 0.
+     * @param options.desc - If `true`, items are returned in descending order (newest first). Default is `false`.
+     * @param options.fields - Array of field names to include in the results. Omits all other fields.
+     * @param options.omit - Array of field names to exclude from the results.
+     * @param options.clean - If `true`, returns only non-empty items and skips hidden fields. Default is `false`.
+     * @param options.skipEmpty - If `true`, skips empty items. Default is `false`.
+     * @param options.skipHidden - If `true`, skips hidden fields (fields starting with `#`). Default is `false`.
+     * @param options.flatten - Array of field names to flatten. Nested objects are converted to dot notation (e.g., `obj.field`).
+     * @param options.unwind - Field name or array of field names to unwind. Each array value creates a separate item.
+     * @param options.view - Name of a predefined view to use for field selection.
+     * @returns A paginated list with `items`, `total` count, `offset`, `count`, and `limit`
+     * @see https://docs.apify.com/api/v2/dataset-items-get
+     *
+     * @example
+     * ```javascript
+     * // Get first 100 items
+     * const { items, total } = await client.dataset('my-dataset').listItems({ limit: 100 });
+     * console.log(`Retrieved ${items.length} of ${total} total items`);
+     *
+     * // Get items with specific fields only
+     * const { items } = await client.dataset('my-dataset').listItems({
+     *   fields: ['url', 'title'],
+     *   skipEmpty: true,
+     *   limit: 50
+     * });
+     *
+     * // Get items in descending order with pagination
+     * const { items } = await client.dataset('my-dataset').listItems({
+     *   desc: true,
+     *   offset: 100,
+     *   limit: 50
+     * });
+     * ```
      */
     async listItems(options = {}) {
         var _a;
@@ -63,9 +141,44 @@ class DatasetClient extends resource_client_1.ResourceClient {
         return this._createPaginationList(response, (_a = options.desc) !== null && _a !== void 0 ? _a : false);
     }
     /**
-     * Unlike `listItems` which returns a {@link PaginationList} with an array of individual
-     * dataset items, `downloadItems` returns the items serialized to the provided format.
-     * https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items
+     * Downloads dataset items in a specific format.
+     *
+     * Unlike {@link listItems} which returns a {@link PaginatedList} with an array of individual
+     * dataset items, this method returns the items serialized to the provided format
+     * (JSON, CSV, Excel, etc.) as a Buffer. Useful for exporting data for further processing.
+     *
+     * @param format - Output format: `'json'`, `'jsonl'`, `'csv'`, `'xlsx'`, `'xml'`, `'rss'`, or `'html'`
+     * @param options - Download and formatting options (extends all options from {@link listItems})
+     * @param options.attachment - If `true`, the response will have `Content-Disposition: attachment` header.
+     * @param options.bom - If `true`, adds UTF-8 BOM to the beginning of the file (useful for Excel compatibility).
+     * @param options.delimiter - CSV delimiter character. Default is `,` (comma).
+     * @param options.skipHeaderRow - If `true`, CSV export will not include the header row with field names.
+     * @param options.xmlRoot - Name of the root XML element. Default is `'items'`.
+     * @param options.xmlRow - Name of the XML element for each item. Default is `'item'`.
+     * @param options.fields - Array of field names to include in the export.
+     * @param options.omit - Array of field names to exclude from the export.
+     * @returns Buffer containing the serialized data in the specified format
+     * @see https://docs.apify.com/api/v2/dataset-items-get
+     *
+     * @example
+     * ```javascript
+     * // Download as CSV with BOM for Excel compatibility
+     * const csvBuffer = await client.dataset('my-dataset').downloadItems('csv', { bom: true });
+     * require('fs').writeFileSync('output.csv', csvBuffer);
+     *
+     * // Download as Excel with custom options
+     * const xlsxBuffer = await client.dataset('my-dataset').downloadItems('xlsx', {
+     *   fields: ['url', 'title', 'price'],
+     *   skipEmpty: true,
+     *   limit: 1000
+     * });
+     *
+     * // Download as XML with custom element names
+     * const xmlBuffer = await client.dataset('my-dataset').downloadItems('xml', {
+     *   xmlRoot: 'products',
+     *   xmlRow: 'product'
+     * });
+     * ```
      */
     async downloadItems(format, options = {}) {
         (0, ow_1.default)(format, ow_1.default.string.oneOf(validItemFormats));
@@ -102,7 +215,36 @@ class DatasetClient extends resource_client_1.ResourceClient {
         return (0, utils_1.cast)(data);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items
+     * Stores one or more items into the dataset.
+     *
+     * Items can be objects, strings, or arrays thereof. Each item will be stored as a separate
+     * record in the dataset. Objects are automatically serialized to JSON. If you provide an array,
+     * all items will be stored in order. This method is idempotent - calling it multiple times
+     * with the same data will not create duplicates, but will append items each time.
+     *
+     * @param items - A single item (object or string) or an array of items to store.
+     *                Objects are automatically stringified to JSON. Strings are stored as-is.
+     * @see https://docs.apify.com/api/v2/dataset-items-post
+     *
+     * @example
+     * ```javascript
+     * // Store a single object
+     * await client.dataset('my-dataset').pushItems({
+     *   url: 'https://example.com',
+     *   title: 'Example Page',
+     *   extractedAt: new Date()
+     * });
+     *
+     * // Store multiple items at once
+     * await client.dataset('my-dataset').pushItems([
+     *   { url: 'https://example.com', title: 'Example' },
+     *   { url: 'https://test.com', title: 'Test' },
+     *   { url: 'https://demo.com', title: 'Demo' }
+     * ]);
+     *
+     * // Store string items
+     * await client.dataset('my-dataset').pushItems(['item1', 'item2', 'item3']);
+     * ```
      */
     async pushItems(items) {
         (0, ow_1.default)(items, ow_1.default.any(ow_1.default.object, ow_1.default.string, ow_1.default.array.ofType(ow_1.default.any(ow_1.default.object, ow_1.default.string))));
@@ -119,7 +261,13 @@ class DatasetClient extends resource_client_1.ResourceClient {
         });
     }
     /**
-     * https://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get
+     * Gets statistical information about the dataset.
+     *
+     * Returns statistics for each field in the dataset, including information about
+     * data types, null counts, and value ranges.
+     *
+     * @returns Dataset statistics, or `undefined` if not available
+     * @see https://docs.apify.com/api/v2/dataset-statistics-get
      */
     async getStatistics() {
         const requestOpts = {
@@ -138,16 +286,35 @@ class DatasetClient extends resource_client_1.ResourceClient {
         return undefined;
     }
     /**
-     * Generates a URL that can be used to access dataset items.
+     * Generates a public URL for accessing dataset items.
      *
      * If the client has permission to access the dataset's URL signing key,
-     * the URL will include a signature which will allow the link to work even without authentication.
+     * the URL will include a cryptographic signature allowing access without authentication.
+     * This is useful for sharing dataset results with external services or users.
+     *
+     * @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.limit - Maximum number of items to return.
+     * @param options.offset - Number of items to skip.
+     * @returns A public URL string for accessing the dataset items
      *
-     * You can optionally control how long the signed URL should be valid using the `expiresInSecs` option.
-     * This value sets the expiration duration in seconds from the time the URL is generated.
-     * If not provided, the URL will not expire.
+     * @example
+     * ```javascript
+     * // Create a URL that expires in 1 hour with specific fields
+     * const url = await client.dataset('my-dataset').createItemsPublicUrl({
+     *   expiresInSecs: 3600,
+     *   fields: ['url', 'title'],
+     *   limit: 100
+     * });
+     * console.log(`Share this URL: ${url}`);
      *
-     * Any other options (like `limit` or `prefix`) will be included as query parameters in the URL.
+     * // Create a permanent public URL for clean items only
+     * const url = await client.dataset('my-dataset').createItemsPublicUrl({
+     *   clean: true,
+     *   skipEmpty: true
+     * });
+     * ```
      */
     async createItemsPublicUrl(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -192,6 +359,9 @@ class DatasetClient extends resource_client_1.ResourceClient {
     }
 }
 exports.DatasetClient = DatasetClient;
+/**
+ * Supported formats for downloading dataset items.
+ */
 var DownloadItemsFormat;
 (function (DownloadItemsFormat) {
     DownloadItemsFormat["JSON"] = "json";

package/dist/resource_clients/dataset.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataset.js","sourceRoot":"","sources":["../../src/resource_clients/dataset.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,gDAAsE;AAItE,6DAKiC;AAGjC,oCAAwF;AAExF,MAAa,aAEX,SAAQ,gCAAc;IACpB;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,UAAU;YACxB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,sCAAoB,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,SAAqC;QAC9C,IAAA,YAAE,EAAC,SAAS,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,sCAAoB,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,sCAAoB,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,UAAwC,EAAE;;QACtD,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC1B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACzB,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC5C,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC3C,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YACzC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC9B,UAAU,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC/B,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAE,CAAC,MAAM,EAAE,YAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC,CAAC;YAC9D,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACxB,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SAChC,CAAC,CACL,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YAC7B,OAAO,EAAE,wCAAsB;SAClC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,MAA2B,EAAE,UAA6C,EAAE;QAC5F,IAAA,YAAE,EAAC,MAAM,EAAE,YAAE,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAC9C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,UAAU,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC/B,GAAG,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACxB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC1B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC7B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACzB,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC5C,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC3C,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YACzC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC9B,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAClC,UAAU,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC/B,MAAM,EAAE,YAAE,CAAC,GAAG,CAAC,YAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC,CAAC;YACvE,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACxB,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC3B,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SAChC,CAAC,CACL,CAAC;QAEF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC;gBACjB,MAAM;gBACN,GAAG,OAAO;aACb,CAAC;YACF,WAAW,EAAE,IAAI;YACjB,OAAO,EAAE,wCAAsB;SAClC,CAAC,CAAC;QAEH,OAAO,IAAA,YAAI,EAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,KAAwC;QACpD,IAAA,YAAE,EAAC,KAAK,EAAE,YAAE,CAAC,GAAG,CAAC,YAAE,CAAC,MAAM,EAAE,YAAE,CAAC,MAAM,EAAE,YAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,GAAG,CAAC,YAAE,CAAC,MAAM,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAEvF,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACvB,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACL,cAAc,EAAE,iCAAiC;aACpD;YACD,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,kBAAkB,EAAE,IAAI,EAAE,sCAAsC;YAChE,OAAO,EAAE,uCAAqB;SACjC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa;QACf,MAAM,WAAW,GAAuB;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,OAAO,EAAE,sCAAoB;SAChC,CAAC;QACF,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzD,OAAO,IAAA,YAAI,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,4BAAoB,EAAC,GAAoB,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,oBAAoB,CAAC,UAA8C,EAAE;QACvE,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC1B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACzB,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC5C,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC3C,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YACzC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC9B,UAAU,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC/B,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAE,CAAC,MAAM,EAAE,YAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC,CAAC;YAC9D,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACxB,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SACpC,CAAC,CACL,CAAC;QAEF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QAEjC,MAAM,EAAE,aAAa,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;QAEnD,IAAI,qBAAqB,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QAE9D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,EAAE,CAAC;YAC/B,MAAM,SAAS,GAAG,MAAM,IAAA,8CAAkC,EAAC;gBACvD,UAAU,EAAE,OAAO,CAAC,EAAE;gBACtB,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;gBAChD,eAAe,EAAE,aAAa,CAAC,CAAC,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS;aACpE,CAAC,CAAC;YACH,qBAAqB,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACnE,CAAC;QAED,qBAAqB,GAAG,IAAA,6BAAqB,EAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;QAEnF,OAAO,qBAAqB,CAAC,QAAQ,EAAE,CAAC;IAC5C,CAAC;IAEO,qBAAqB,CAAC,QAAuB,EAAE,gBAAyB;;QAC5E,OAAO;YACH,KAAK,EAAE,QAAQ,CAAC,IAAI;YACpB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;YAC3D,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;YAC7D,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,8FAA8F;YAC3H,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC,EAAE,iDAAiD;YAC9G,oFAAoF;YACpF,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAA,QAAQ,CAAC,OAAO,CAAC,yBAAyB,CAAC,mCAAI,gBAAgB,CAAC;SACpF,CAAC;IACN,CAAC;CACJ;AArND,sCAqNC;AAsDD,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC3B,oCAAa,CAAA;IACb,sCAAe,CAAA;IACf,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,kCAAW,CAAA;AACf,CAAC,EARW,mBAAmB,mCAAnB,mBAAmB,QAQ9B;AAED,MAAM,gBAAgB,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"dataset.js","sourceRoot":"","sources":["../../src/resource_clients/dataset.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,gDAAsE;AAItE,6DAKiC;AAGjC,oCAAwF;AAExF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAa,aAEX,SAAQ,gCAAc;IACpB;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,UAAU;YACxB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,sCAAoB,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,SAAqC;QAC9C,IAAA,YAAE,EAAC,SAAS,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,sCAAoB,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,sCAAoB,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,KAAK,CAAC,SAAS,CAAC,UAAwC,EAAE;;QACtD,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC1B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACzB,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC5C,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC3C,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YACzC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC9B,UAAU,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC/B,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAE,CAAC,MAAM,EAAE,YAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC,CAAC;YAC9D,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACxB,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SAChC,CAAC,CACL,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YAC7B,OAAO,EAAE,wCAAsB;SAClC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,KAAK,CAAC,aAAa,CAAC,MAA2B,EAAE,UAA6C,EAAE;QAC5F,IAAA,YAAE,EAAC,MAAM,EAAE,YAAE,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAC9C,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,UAAU,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC/B,GAAG,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACxB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC1B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC7B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACzB,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC5C,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC3C,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YACzC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC9B,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAClC,UAAU,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC/B,MAAM,EAAE,YAAE,CAAC,GAAG,CAAC,YAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC,CAAC;YACvE,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACxB,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC3B,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SAChC,CAAC,CACL,CAAC;QAEF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC;gBACjB,MAAM;gBACN,GAAG,OAAO;aACb,CAAC;YACF,WAAW,EAAE,IAAI;YACjB,OAAO,EAAE,wCAAsB;SAClC,CAAC,CAAC;QAEH,OAAO,IAAA,YAAI,EAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,SAAS,CAAC,KAAwC;QACpD,IAAA,YAAE,EAAC,KAAK,EAAE,YAAE,CAAC,GAAG,CAAC,YAAE,CAAC,MAAM,EAAE,YAAE,CAAC,MAAM,EAAE,YAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,GAAG,CAAC,YAAE,CAAC,MAAM,EAAE,YAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAEvF,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACvB,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACL,cAAc,EAAE,iCAAiC;aACpD;YACD,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,kBAAkB,EAAE,IAAI,EAAE,sCAAsC;YAChE,OAAO,EAAE,uCAAqB;SACjC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa;QACf,MAAM,WAAW,GAAuB;YACpC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;YAC5B,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,OAAO,EAAE,sCAAoB;SAChC,CAAC;QACF,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzD,OAAO,IAAA,YAAI,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAA,4BAAoB,EAAC,GAAoB,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,oBAAoB,CAAC,UAA8C,EAAE;QACvE,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC1B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YACzB,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC5C,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YAC3C,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC;YACzC,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,SAAS,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC9B,UAAU,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC/B,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAE,CAAC,MAAM,EAAE,YAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAE,CAAC,MAAM,CAAC,CAAC;YAC9D,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACxB,aAAa,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;SACpC,CAAC,CACL,CAAC;QAEF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QAEjC,MAAM,EAAE,aAAa,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;QAEnD,IAAI,qBAAqB,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QAE9D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,EAAE,CAAC;YAC/B,MAAM,SAAS,GAAG,MAAM,IAAA,8CAAkC,EAAC;gBACvD,UAAU,EAAE,OAAO,CAAC,EAAE;gBACtB,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;gBAChD,eAAe,EAAE,aAAa,CAAC,CAAC,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS;aACpE,CAAC,CAAC;YACH,qBAAqB,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACnE,CAAC;QAED,qBAAqB,GAAG,IAAA,6BAAqB,EAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;QAEnF,OAAO,qBAAqB,CAAC,QAAQ,EAAE,CAAC;IAC5C,CAAC;IAEO,qBAAqB,CAAC,QAAuB,EAAE,gBAAyB;;QAC5E,OAAO;YACH,KAAK,EAAE,QAAQ,CAAC,IAAI;YACpB,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;YAC3D,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;YAC7D,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,8FAA8F;YAC3H,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC,EAAE,iDAAiD;YAC9G,oFAAoF;YACpF,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAA,QAAQ,CAAC,OAAO,CAAC,yBAAyB,CAAC,mCAAI,gBAAgB,CAAC;SACpF,CAAC;IACN,CAAC;CACJ;AA/VD,sCA+VC;AA6ED;;GAEG;AACH,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC3B,oCAAa,CAAA;IACb,sCAAe,CAAA;IACf,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,kCAAW,CAAA;AACf,CAAC,EARW,mBAAmB,mCAAnB,mBAAmB,QAQ9B;AAED,MAAM,gBAAgB,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC"}