apify 4.0.0-beta.23 → 4.0.0-beta.24

package/README.md

@@ -5,6 +5,8 @@
 [![Chat on discord](https://img.shields.io/discord/801163717915574323?label=discord)](https://discord.gg/jyEM2PRvMU)
 [![Build Status](https://github.com/apify/apify-sdk-js/actions/workflows/test-and-release.yaml/badge.svg?branch=master)](https://github.com/apify/apify-sdk-js/actions/workflows/test-and-release.yaml)
 
+`apify` is the official SDK for building [Apify Actors](https://docs.apify.com/platform/actors) in JavaScript and TypeScript. It handles the Actor lifecycle, storage access, platform events, proxy configuration, and more.
+
 ## Quick Start
 
 This short tutorial will set you up to start using Apify SDK in a minute or two.
@@ -33,7 +35,27 @@ await Actor.setValue('OUTPUT', {
 await Actor.exit();
 ```
 
-> You can also install the [`crawlee`](https://npmjs.org/crawlee) module, as it now provides the crawlers that were previously exported by Apify SDK. If you don't plan to use crawlers in your Actors, then you don't need to install it. Keep in mind that neither `playwright` nor `puppeteer` are bundled with `crawlee` in order to reduce install size and allow greater flexibility. That's why we manually install it with NPM. You can choose one, both, or neither. For more information and example please check [`documentation.`](https://docs.apify.com/sdk/js/docs/concepts/actor-lifecycle#running-crawlee-code-as-an-actor)
+> You can also install the [`crawlee`](https://www.npmjs.com/package/crawlee) module, as it now provides the crawlers that were previously exported by Apify SDK. If you don't plan to use crawlers in your Actors, then you don't need to install it. Keep in mind that neither `playwright` nor `puppeteer` are bundled with `crawlee` in order to reduce install size and allow greater flexibility. That's why we manually install it with NPM. You can choose one, both, or neither. For more information and example please check [`documentation.`](https://docs.apify.com/sdk/js/docs/concepts/actor-lifecycle#running-crawlee-code-as-an-actor)
+
+## What are Actors?
+
+Actors are serverless programs that can do almost anything. From simple scripts and web scrapers to complex automation workflows, AI agents, or even always-on services that expose HTTP endpoints.
+
+They can run either locally or on the Apify platform, where you can scale their execution, monitor runs, schedule tasks, integrate them with other services, or even publish and monetize them. If you're new to Apify, learn more about the platform in the [Apify documentation](https://docs.apify.com/platform/about).
+
+For more context, read the [Actor whitepaper](https://whitepaper.actor/).
+
+## What you can build
+
+Almost any Node.js project can become an Actor, including projects for:
+
+- **Web scraping and crawling** - The SDK works seamlessly with [Crawlee](https://crawlee.dev), which makes Apify a natural place to deploy and scale your crawlers. Start from a ready-made [Cheerio](https://apify.com/templates/js-crawlee-cheerio) template.
+- **Browser automation** - Drive a real browser with [Playwright](https://playwright.dev), [Puppeteer](https://pptr.dev), or [Selenium](https://apify.com/apify/example-selenium) to automate tasks, fill in forms, or test web apps.
+- **AI agents** - Host agents built with your framework of choice. Ready-made Actor templates cover [LangChain](https://apify.com/templates/js-langchain), [LangGraph](https://apify.com/templates/js-langgraph-agent), [BeeAI](https://apify.com/templates/ts-beeai-agent), and [Mastra](https://apify.com/templates/ts-mastraai).
+- **MCP servers** - Deploy an MCP server as an Actor and make its tools available to any MCP client. See the [MCP server](https://apify.com/templates/ts-mcp-empty) and [MCP proxy](https://apify.com/templates/ts-mcp-proxy) templates.
+- **Web servers and APIs** - Run a web server inside an Actor to serve HTTP requests, for example to expose your scraper as a live API. See the [Standby](https://apify.com/templates/js-standby) templates.
+
+Whatever you build, the Apify SDK doesn't lock you into a particular framework. Bring the libraries you already use, and let Apify run your project in the cloud.
 
 ## Support
 

package/dist/actor.d.ts

@@ -180,7 +180,7 @@ export interface ApifyEnv {
     logLevel: string | null;
     logFormat: string | null;
     /**
-     * Origin for the Actor run, i.e. how it was started. See [here](https://docs.apify.com/sdk/python/reference/enum/MetaOrigin)
+     * Origin for the Actor run, i.e. how it was started. See [here](https://docs.apify.com/platform/actors/running/runs-and-builds#origin)
      * for more details. (APIFY_META_ORIGIN)
      */
     metaOrigin: string | null;
@@ -1393,9 +1393,12 @@ export declare class Actor<Data extends Dictionary = Dictionary> {
     private createApifyStorageBackend;
     private _ensureActorInit;
     /**
-     * Get time remaining from the Actor run timeout. Returns `undefined` if not on an Apify platform or the current
-     * run was started without a timeout.
+     * Get time remaining from the Actor run timeout in seconds, rounded up to whole seconds with minimum value of 1 second.
+     *
+     * The API treats a 0 second timeout as no timeout, the minimum acceptable timeout is 1 second.
+     *
+     * Returns `undefined` if not on the Apify platform or the current run was started without a timeout.
      */
-    private getRemainingTime;
+    private getRemainingTimeSecs;
     private inferDefaultsFromInputSchema;
 }

package/dist/actor.js

@@ -367,7 +367,7 @@ export class Actor {
      * @ignore
      */
     async call(actorId, input, options = {}) {
-        const timeout = options.timeout === 'inherit' ? this.getRemainingTime() : options.timeout;
+        const timeout = options.timeout === 'inherit' ? this.getRemainingTimeSecs() : options.timeout;
         const { token, ...rest } = options;
         const client = token ? this.newClient({ token }) : this.apifyClient;
         return client.actor(actorId).call(input, { ...rest, timeout });
@@ -397,7 +397,7 @@ export class Actor {
      * @ignore
      */
     async start(actorId, input, options = {}) {
-        const timeout = options.timeout === 'inherit' ? this.getRemainingTime() : options.timeout;
+        const timeout = options.timeout === 'inherit' ? this.getRemainingTimeSecs() : options.timeout;
         const { token, ...rest } = options;
         const client = token ? this.newClient({ token }) : this.apifyClient;
         return client.actor(actorId).start(input, { ...rest, timeout });
@@ -454,7 +454,7 @@ export class Actor {
      * @ignore
      */
     async callTask(taskId, input, options = {}) {
-        const timeout = options.timeout === 'inherit' ? this.getRemainingTime() : options.timeout;
+        const timeout = options.timeout === 'inherit' ? this.getRemainingTimeSecs() : options.timeout;
         const { token, ...rest } = options;
         const client = token ? this.newClient({ token }) : this.apifyClient;
         return client.task(taskId).call(input, { ...rest, timeout });
@@ -1641,13 +1641,17 @@ export class Actor {
         ].join('\n'));
     }
     /**
-     * Get time remaining from the Actor run timeout. Returns `undefined` if not on an Apify platform or the current
-     * run was started without a timeout.
+     * Get time remaining from the Actor run timeout in seconds, rounded up to whole seconds with minimum value of 1 second.
+     *
+     * The API treats a 0 second timeout as no timeout, the minimum acceptable timeout is 1 second.
+     *
+     * Returns `undefined` if not on the Apify platform or the current run was started without a timeout.
      */
-    getRemainingTime() {
+    getRemainingTimeSecs() {
         const env = this.getEnv();
+        const MINIMUM_API_TIMEOUT_SECS = 1;
         if (this.isAtHome() && env.timeoutAt !== null) {
-            return env.timeoutAt.getTime() - Date.now();
+            return Math.max(Math.ceil((env.timeoutAt.getTime() - Date.now()) / 1000), MINIMUM_API_TIMEOUT_SECS);
         }
         log.warning('Using `inherit` argument is only possible when the Actor is running on the Apify platform and when the ' +
             'timeout for the Actor run is set.');

package/dist/charging.d.ts

@@ -76,6 +76,11 @@ export declare class ChargingManager {
      */
     init(): Promise<void>;
     private ensureChargingLogDatasetOnPlatform;
+    /**
+     * Whether {@link ChargingManager.init} has run. All charging operations (including
+     * {@link ChargingManager.getPricingInfo}) require an initialized manager.
+     */
+    get isInitialized(): boolean;
     /**
      * Get information about the pricing for this Actor.
      */

package/dist/charging.js

@@ -133,6 +133,13 @@ export class ChargingManager {
         await defaultStore.setValue(this.PLATFORM_CHARGING_LOG_DATASET_ID_KEY, dataset.id);
         return dataset.id;
     }
+    /**
+     * Whether {@link ChargingManager.init} has run. All charging operations (including
+     * {@link ChargingManager.getPricingInfo}) require an initialized manager.
+     */
+    get isInitialized() {
+        return this.chargingState !== undefined;
+    }
     /**
      * Get information about the pricing for this Actor.
      */

package/dist/configuration.d.ts

@@ -110,7 +110,7 @@ export interface Configuration extends ApifyResolvedConfigValues {
  * `actorId` | `ACTOR_ID` | -
  * `actorRunId` | `ACTOR_RUN_ID` | -
  * `actorTaskId` | `ACTOR_TASK_ID` | -
- * `apiBaseUrl` | `APIFY_API_BASE_URL` | `'https://api.apify.com'`
+ * `apiBaseUrl` | `APIFY_API_BASE_URL` | `'https://api.apify.com/'`
  * `containerPort` | `ACTOR_WEB_SERVER_PORT` | `4321`
  * `containerUrl` | `ACTOR_WEB_SERVER_URL` | `'http://localhost:4321'`
  * `inputKey` | `ACTOR_INPUT_KEY` | `'INPUT'`

package/dist/configuration.js

@@ -49,7 +49,7 @@ export const apifyConfigFields = {
     actorId: field(z.string().optional(), [ACTOR_ENV_VARS.ID, APIFY_ENV_VARS.ACTOR_ID]),
     actorRunId: field(z.string().optional(), [ACTOR_ENV_VARS.RUN_ID, APIFY_ENV_VARS.ACTOR_RUN_ID]),
     actorTaskId: field(z.string().optional(), [ACTOR_ENV_VARS.TASK_ID, APIFY_ENV_VARS.ACTOR_TASK_ID]),
-    apiBaseUrl: field(z.string().default('https://api.apify.com'), APIFY_ENV_VARS.API_BASE_URL),
+    apiBaseUrl: field(z.string().default('https://api.apify.com/'), APIFY_ENV_VARS.API_BASE_URL),
     apiPublicBaseUrl: field(z.string().default('https://api.apify.com'), APIFY_ENV_VARS.API_PUBLIC_BASE_URL),
     containerPort: field(coerceNumber.default(+LOCAL_ACTOR_ENV_VARS[ACTOR_ENV_VARS.WEB_SERVER_PORT]), [
         ACTOR_ENV_VARS.WEB_SERVER_PORT,
@@ -136,7 +136,7 @@ export const apifyConfigFields = {
  * `actorId` | `ACTOR_ID` | -
  * `actorRunId` | `ACTOR_RUN_ID` | -
  * `actorTaskId` | `ACTOR_TASK_ID` | -
- * `apiBaseUrl` | `APIFY_API_BASE_URL` | `'https://api.apify.com'`
+ * `apiBaseUrl` | `APIFY_API_BASE_URL` | `'https://api.apify.com/'`
  * `containerPort` | `ACTOR_WEB_SERVER_PORT` | `4321`
  * `containerUrl` | `ACTOR_WEB_SERVER_URL` | `'http://localhost:4321'`
  * `inputKey` | `ACTOR_INPUT_KEY` | `'INPUT'`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify",
-  "version": "4.0.0-beta.23",
+  "version": "4.0.0-beta.24",
   "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"
@@ -57,7 +57,7 @@
     "@apify/datastructures": "^2.0.3",
     "@apify/input_secrets": "^1.2.0",
     "@apify/log": "^2.4.3",
-    "@apify/timeout": "^0.3.0",
+    "@apify/timeout": "^0.4.0",
     "@apify/utilities": "^2.13.0",
     "@crawlee/core": "^4.0.0-beta.115",
     "@crawlee/types": "^4.0.0-beta.115",
@@ -69,8 +69,8 @@
     "zod": "^4.0.0"
   },
   "devDependencies": {
-    "@apify/oxlint-config": "^0.2.5",
-    "@apify/tsconfig": "^0.1.2",
+    "@apify/oxlint-config": "^0.3.0",
+    "@apify/tsconfig": "^0.2.0",
     "@commitlint/config-conventional": "^21.0.0",
     "@playwright/browser-chromium": "^1.60.0",
     "@types/content-type": "^1.1.8",
@@ -83,8 +83,8 @@
     "globby": "^16.0.0",
     "husky": "^9.1.7",
     "lint-staged": "^17.0.0",
-    "oxfmt": "0.52.0",
-    "oxlint": "1.67.0",
+    "oxfmt": "0.63.0",
+    "oxlint": "1.78.0",
     "oxlint-tsgolint": "0.22.0",
     "playwright": "^1.60.0",
     "puppeteer": "^25.0.0",