apify 4.0.0-beta.15 → 4.0.0-beta.17

package/dist/apify_storage_client.d.ts

@@ -31,6 +31,18 @@ export declare const pushDataChargingContext: AsyncLocalStorage<PpeAwarePushData
  * first (when one exists on the platform) and fall back to a name otherwise —
  * otherwise crawlee's `resolveStorageIdentifier` treats every string as a name
  * and the SDK would silently create a new storage named like the passed id.
+ *
+ * `Actor` wires this up automatically; construct it directly only to use Apify
+ * platform storage with crawlee's storage classes outside of `Actor` — e.g. to
+ * read another run's output with an explicit token:
+ *
+ * ```ts
+ * import { ApifyClient, ApifyStorageClient, Dataset } from 'apify';
+ *
+ * const client = new ApifyClient({ token });
+ * const dataset = await Dataset.open(datasetId, { storageClient: new ApifyStorageClient(client) });
+ * const { items } = await dataset.getData();
+ * ```
  */
 export declare class ApifyStorageClient implements StorageClient {
     private readonly client;

package/dist/apify_storage_client.js

@@ -53,6 +53,27 @@ class PpeAwareDatasetClient extends ApifyDatasetClient {
             context.chargeResult === undefined ? result : mergeChargeResults(context.chargeResult, result);
     }
 }
+// crawlee v4's `StorageClient` sub-client interfaces use different method names
+// than `apify-client`'s resource clients (`getValue`/`getRecord`,
+// `pushData`/`pushItems`, `getData`/`listItems`, `getMetadata`/`get`,
+// `drop`/`delete`). `adapt` wraps a client in a name-remapping proxy: `renames`
+// aliases the differing methods and `overrides` replaces the few whose return
+// shape differs; everything else — identically-named methods and the
+// pay-per-event marker symbol — passes straight through.
+//
+// `purge()` has no apify-client equivalent and isn't needed on the platform
+// (a run's storages are already fresh), so it's a no-op.
+const noPurge = { purge: async () => { } };
+function adapt(client, renames, overrides = {}) {
+    return new Proxy(client, {
+        get(target, prop) {
+            if (typeof prop === 'string' && prop in overrides)
+                return overrides[prop];
+            const value = Reflect.get(target, (typeof prop === 'string' && renames[prop]) || prop, target);
+            return typeof value === 'function' ? value.bind(target) : value;
+        },
+    });
+}
 /**
  * Bridges `apify-client`'s synchronous resource accessors (`dataset(id)`,
  * `keyValueStore(id)`, `requestQueue(id, options?)`) to crawlee v4's
@@ -67,6 +88,18 @@ class PpeAwareDatasetClient extends ApifyDatasetClient {
  * first (when one exists on the platform) and fall back to a name otherwise —
  * otherwise crawlee's `resolveStorageIdentifier` treats every string as a name
  * and the SDK would silently create a new storage named like the passed id.
+ *
+ * `Actor` wires this up automatically; construct it directly only to use Apify
+ * platform storage with crawlee's storage classes outside of `Actor` — e.g. to
+ * read another run's output with an explicit token:
+ *
+ * ```ts
+ * import { ApifyClient, ApifyStorageClient, Dataset } from 'apify';
+ *
+ * const client = new ApifyClient({ token });
+ * const dataset = await Dataset.open(datasetId, { storageClient: new ApifyStorageClient(client) });
+ * const { items } = await dataset.getData();
+ * ```
  */
 export class ApifyStorageClient {
     client;
@@ -85,19 +118,34 @@ export class ApifyStorageClient {
     }
     async createDatasetClient(options) {
         const id = await this.resolveId(options, 'Dataset');
-        const datasetClient = this.chargingDatasetClient(id) ?? this.client.dataset(id);
-        // apify-client's resource clients overlap with `@crawlee/types`' shapes
-        // but don't implement the v4-added members (`getMetadata`,
-        // `getRecordPublicUrl`), so cast through.
-        return datasetClient;
+        const client = this.chargingDatasetClient(id) ?? this.client.dataset(id);
+        return adapt(client, {
+            getMetadata: 'get',
+            drop: 'delete',
+            pushData: 'pushItems',
+            getData: 'listItems',
+        }, noPurge);
     }
     async createKeyValueStoreClient(options) {
         const id = await this.resolveId(options, 'KeyValueStore');
-        return this.client.keyValueStore(id);
+        const client = this.client.keyValueStore(id);
+        return adapt(client, {
+            getMetadata: 'get',
+            getValue: 'getRecord',
+            setValue: 'setRecord',
+            deleteValue: 'deleteRecord',
+            drop: 'delete',
+            getPublicUrl: 'getRecordPublicUrl',
+        }, {
+            ...noPurge,
+            // crawlee expects an array; apify-client returns `{ items }`.
+            listKeys: async (opts) => (await client.listKeys(opts)).items,
+        });
     }
     async createRequestQueueClient(options) {
         const id = await this.resolveId(options, 'RequestQueue');
-        return this.client.requestQueue(id, options?.clientKey ? { clientKey: options.clientKey } : undefined);
+        const client = this.client.requestQueue(id, options?.clientKey ? { clientKey: options.clientKey } : undefined);
+        return adapt(client, { getMetadata: 'get', drop: 'delete' }, noPurge);
     }
     /**
      * Returns a charging-aware dataset client when `id` is the run's default

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './actor.js';
+export { ApifyStorageClient } from './apify_storage_client.js';
 export type { OpenStorageOptions, StorageAlias, StorageId, StorageName, StorageIdentifier, StorageIdentifierWithoutAlias, } from './storage.js';
 export { ChargeOptions, ChargeResult, ActorPricingInfo, ChargingManager } from './charging.js';
 export * from './configuration.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from './actor.js';
+export { ApifyStorageClient } from './apify_storage_client.js';
 export { ChargingManager } from './charging.js';
 export * from './configuration.js';
 export * from './proxy_configuration.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify",
-  "version": "4.0.0-beta.15",
+  "version": "4.0.0-beta.17",
   "description": "The scalable web crawling and scraping library for JavaScript/Node.js. Enables development of data extraction and web automation jobs (not only) with headless Chrome and Puppeteer.",
   "engines": {
     "node": ">=22.0.0"