apify-cli 0.19.3-beta.4 → 1.0.0-beta.0

package/package.json

@@ -1,116 +1,140 @@
 {
-  "name": "apify-cli",
-  "version": "0.19.3-beta.4",
-  "description": "Apify command-line interface helps you create, develop, build and run Apify actors, and manage the Apify cloud platform.",
-  "main": "index.js",
-  "scripts": {
-    "test": "cross-env APIFY_CLI_SKIP_UPDATE_CHECK=1 vitest run",
-    "test-python": "cross-env APIFY_CLI_SKIP_UPDATE_CHECK=1 vitest run -t '.*\\[python\\]'",
-    "lint": "eslint src test",
-    "lint:fix": "eslint src test --fix",
-    "commands-md": "npm run manifest && oclif-dev readme",
-    "prepare-release": "npm run commands-md && npm run prod-shrinkwrap",
-    "prod-shrinkwrap": "rm -rf node_modules && npm install --production && npm shrinkwrap",
-    "manifest": "rm -f oclif.manifest.json && oclif-dev manifest",
-    "postinstall": "node \"./src/bin/run\" check-version && node ./src/lib/community"
-  },
-  "files": [
-    "src",
-    "oclif.manifest.json",
-    "index.js",
-    "package.json"
-  ],
-  "bin": {
-    "apify": "./src/bin/run"
-  },
-  "contributors": [
-    "Jakub Drobník <jakub.drobnik@apify.com>",
-    "Jan Curn <jan@apify.com>"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/apify/apify-cli.git"
-  },
-  "keywords": [
-    "apify",
-    "client",
-    "node",
-    "command",
-    "line",
-    "bash"
-  ],
-  "author": {
-    "name": "Apify",
-    "email": "support@apify.com",
-    "url": "https://www.apify.com"
-  },
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/apify/apify-cli/issues"
-  },
-  "homepage": "https://github.com/apify/apify-cli#readme",
-  "engines": {
-    "node": ">=16.0.0"
-  },
-  "dependencies": {
-    "@apify/actor-templates": "^0.1.4",
-    "@apify/consts": "^2.23.0",
-    "@apify/input_schema": "^3.5.8",
-    "@apify/utilities": "^2.9.3",
-    "@crawlee/memory-storage": "^3.5.8",
-    "@oclif/command": "^1.8.36",
-    "@oclif/config": "^1.18.17",
-    "@oclif/core": "^2.15.0",
-    "@oclif/errors": "^1.3.6",
-    "@oclif/plugin-commands": "^2.1.0",
-    "@oclif/plugin-help": "^5.1.12",
-    "@root/walk": "^1.1.0",
-    "adm-zip": "^0.5.10",
-    "ajv": "^8.12.0",
-    "apify-client": "^2.9.0",
-    "archiver-promise": "^1.0.0",
-    "axios": "^1.6.7",
-    "chalk": "^4.1.2",
-    "computer-name": "^0.1.0",
-    "configparser": "^0.3.10",
-    "cors": "^2.8.5",
-    "detect-indent": "^6.1.0",
-    "escape-string-regexp": "^4.0.0",
-    "express": "^4.18.2",
-    "globby": "^11.1.0",
-    "handlebars": "^4.7.8",
-    "inquirer": "^7.3.3",
-    "is-ci": "^3.0.1",
-    "is-online": "^10.0.0",
-    "istextorbinary": "^8.0.0",
-    "jju": "^1.4.0",
-    "load-json-file": "^6.2.0",
-    "mime": "^3.0.0",
-    "mixpanel": "^0.18.0",
-    "open": "^8.4.0",
-    "ow": "^0.28.2",
-    "rimraf": "^3.0.2",
-    "semver": "^7.5.4",
-    "tiged": "^2.12.5",
-    "underscore": "^1.13.6",
-    "write-json-file": "^4.3.0"
-  },
-  "devDependencies": {
-    "@apify/eslint-config": "^0.4.0",
-    "@oclif/dev-cli": "^1.26.0",
-    "@oclif/test": "^2.1.0",
-    "cross-env": "^7.0.3",
-    "eslint": "^8.53.0",
-    "vitest": "^1.0.4"
-  },
-  "oclif": {
-    "bin": "apify",
-    "commands": "./src/commands",
-    "hooks": {
-      "init": [
-        "./src/hooks/init"
-      ]
+    "name": "apify-cli",
+    "version": "1.0.0-beta.0",
+    "description": "Apify command-line interface (CLI) helps you manage the Apify cloud platform and develop, build, and deploy Apify Actors.",
+    "exports": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "type": "module",
+    "scripts": {
+        "test": "vitest run",
+        "test-python": "vitest run -t '.*\\[python\\]'",
+        "lint": "eslint src test",
+        "lint:fix": "eslint src test --fix",
+        "clean": "rimraf dist",
+        "build": "npm run clean && tsc",
+        "postpack": "rimraf oclif.manifest.json",
+        "prepack": "npm run build && oclif manifest && oclif readme",
+        "prepare": "npm run build && node ./bin/run.js check-version && node ./dist/lib/community.js"
     },
-    "helpClass": "./src/lib/apify-oclif-help"
-  }
+    "files": [
+        "dist",
+        "oclif.manifest.json",
+        "bin"
+    ],
+    "bin": {
+        "apify": "./bin/run.js"
+    },
+    "contributors": [
+        "Jakub Drobník <jakub.drobnik@apify.com>",
+        "Jan Curn <jan@apify.com>"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/apify/apify-cli.git"
+    },
+    "keywords": [
+        "apify",
+        "client",
+        "node",
+        "command",
+        "line",
+        "bash"
+    ],
+    "author": {
+        "name": "Apify",
+        "email": "support@apify.com",
+        "url": "https://www.apify.com"
+    },
+    "license": "Apache-2.0",
+    "bugs": {
+        "url": "https://github.com/apify/apify-cli/issues"
+    },
+    "homepage": "https://github.com/apify/apify-cli#readme",
+    "engines": {
+        "node": ">=16.0.0"
+    },
+    "dependencies": {
+        "@apify/actor-templates": "~0.1.5",
+        "@apify/consts": "~2.26.0",
+        "@apify/input_schema": "~3.5.15",
+        "@apify/utilities": "~2.10.0",
+        "@crawlee/memory-storage": "~3.8.1",
+        "@oclif/core": "~3.20.0",
+        "@oclif/plugin-help": "~6.0.14",
+        "@root/walk": "~1.1.0",
+        "adm-zip": "~0.5.10",
+        "ajv": "~8.12.0",
+        "apify-client": "~2.9.3",
+        "archiver": "~7.0.0",
+        "axios": "~1.6.7",
+        "chalk": "~5.3.0",
+        "computer-name": "~0.1.0",
+        "configparser": "~0.3.10",
+        "cors": "~2.8.5",
+        "detect-indent": "~7.0.1",
+        "escape-string-regexp": "~5.0.0",
+        "express": "~4.18.2",
+        "globby": "~14.0.1",
+        "handlebars": "~4.7.8",
+        "inquirer": "~9.2.15",
+        "is-ci": "~3.0.1",
+        "is-online": "~10.0.0",
+        "istextorbinary": "~9.5.0",
+        "jju": "~1.4.0",
+        "load-json-file": "~7.0.1",
+        "mime": "~4.0.1",
+        "mixpanel": "~0.18.0",
+        "open": "~10.0.4",
+        "ow": "~1.1.1",
+        "rimraf": "~5.0.5",
+        "semver": "~7.6.0",
+        "tiged": "~2.12.7",
+        "underscore": "~1.13.6",
+        "write-json-file": "~5.0.0"
+    },
+    "devDependencies": {
+        "@apify/eslint-config": "^0.4.0",
+        "@apify/eslint-config-ts": "^0.4.1",
+        "@apify/tsconfig": "^0.1.0",
+        "@crawlee/types": "^3.8.1",
+        "@oclif/test": "^3.2.1",
+        "@types/adm-zip": "^0.5.5",
+        "@types/archiver": "^6.0.2",
+        "@types/chai": "^4.3.12",
+        "@types/cors": "^2.8.17",
+        "@types/express": "^4.17.21",
+        "@types/inquirer": "^9.0.7",
+        "@types/is-ci": "^3.0.4",
+        "@types/jju": "^1.4.5",
+        "@types/mime": "^3.0.4",
+        "@types/node": "^20.11.20",
+        "@types/semver": "^7.5.8",
+        "@types/underscore": "^1.11.15",
+        "@typescript-eslint/eslint-plugin": "^7.0.2",
+        "@typescript-eslint/parser": "^7.0.2",
+        "chai": "^4.4.1",
+        "eslint": "^8.57.0",
+        "oclif": "^4.4.18",
+        "tsx": "^4.7.1",
+        "typescript": "^5.3.3",
+        "vitest": "^1.3.1"
+    },
+    "oclif": {
+        "bin": "apify",
+        "dirname": "apify",
+        "commands": "./dist/commands",
+        "plugins": [
+            "@oclif/plugin-help"
+        ],
+        "hooks": {
+            "init": [
+                "./dist/hooks/init"
+            ]
+        },
+        "helpClass": "./dist/lib/apify-oclif-help"
+    },
+    "volta": {
+        "node": "20.11.1",
+        "npm": "10.5.0"
+    }
 }

package/index.js

@@ -1 +0,0 @@
-module.exports = {};

package/src/bin/run

@@ -1,16 +0,0 @@
-#!/usr/bin/env node
-/* eslint-disable */
-const outputs = require('../lib/outputs');
-
-(async () => {
-    try {
-        await require('@oclif/command').run()
-    } catch (err) {
-        const exitCode = (err.oclif && err.oclif.exit !== undefined) ? err.oclif.exit : 1;
-        if (exitCode !== 0) {
-            outputs.error(err.message);
-            if (process.env.DEBUG) console.error(err);
-            process.exit(exitCode);
-        }
-    }
-})();

package/src/commands/actor/get-input.js

@@ -1,12 +0,0 @@
-const { outputInputFromDefaultStore } = require('../../lib/actor');
-const { ApifyCommand } = require('../../lib/apify_command');
-
-class GetInputCommand extends ApifyCommand {
-    async run() {
-        await outputInputFromDefaultStore();
-    }
-}
-
-GetInputCommand.description = 'Gets the actor input value from the default key-value store associated with the actor run.';
-
-module.exports = GetInputCommand;

package/src/commands/actor/get-value.js

@@ -1,23 +0,0 @@
-const { outputRecordFromDefaultStore } = require('../../lib/actor');
-const { ApifyCommand } = require('../../lib/apify_command');
-
-class GetValueCommand extends ApifyCommand {
-    async run() {
-        const { args } = this.parse(GetValueCommand);
-        const { key } = args;
-
-        await outputRecordFromDefaultStore(key);
-    }
-}
-
-GetValueCommand.description = 'Gets a value from the default key-value store associated with the actor run.';
-
-GetValueCommand.args = [
-    {
-        name: 'key',
-        required: true,
-        description: 'Key of the record in key-value store',
-    },
-];
-
-module.exports = GetValueCommand;

package/src/commands/actor/index.js

@@ -1,13 +0,0 @@
-const { Command } = require('@oclif/command');
-
-const { showHelpForCommand } = require('../../lib/utils');
-
-class ActorIndexCommand extends Command {
-    async run() {
-        showHelpForCommand('actor');
-    }
-}
-
-ActorIndexCommand.description = 'Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.\n';
-
-module.exports = ActorIndexCommand;

package/src/commands/actor/push-data.js

@@ -1,44 +0,0 @@
-const { getApifyStorageClient, getDefaultStorageId, APIFY_STORAGE_TYPES } = require('../../lib/actor');
-const { ApifyCommand } = require('../../lib/apify_command');
-
-class PushDataCommand extends ApifyCommand {
-    async init() {
-        await super.init();
-        // Read data from stdin of the command
-        this.stdin = await this.readStdin(process.stdin);
-    }
-
-    async run() {
-        const { args } = this.parse(PushDataCommand);
-        const { item } = args;
-
-        const apifyClient = getApifyStorageClient();
-        const defaultStoreId = getDefaultStorageId(APIFY_STORAGE_TYPES.DATASET);
-        const data = item || this.stdin;
-        let parsedData;
-        try {
-            parsedData = JSON.parse(data);
-        } catch (err) {
-            throw new Error(`Failed to parse data as JSON string: ${err.message}`);
-        }
-
-        await apifyClient.dataset(defaultStoreId).pushItems(parsedData);
-    }
-}
-
-PushDataCommand.description = 'Stores an object or an array of objects to the default dataset of the actor run.\n'
-    + 'It is possible to pass data using item argument or stdin.\n'
-    + 'Passing data using argument:\n'
-    + '$ apify actor:push-data {"foo": "bar"}\n'
-    + 'Passing data using stdin with pipe:\n'
-    + '$ cat ./test.json | apify actor:push-data\n';
-
-PushDataCommand.args = [
-    {
-        name: 'item',
-        required: false,
-        description: 'JSON string with one object or array of objects containing data to be stored in the default dataset.',
-    },
-];
-
-module.exports = PushDataCommand;

package/src/commands/actor/set-value.js

@@ -1,63 +0,0 @@
-const { flags: flagsHelper } = require('@oclif/command');
-
-const { getApifyStorageClient, getDefaultStorageId, APIFY_STORAGE_TYPES } = require('../../lib/actor');
-const { ApifyCommand } = require('../../lib/apify_command');
-
-class SetValueCommand extends ApifyCommand {
-    async init() {
-        await super.init();
-        // Read data from stdin of the command
-        this.stdin = process.stdin;
-    }
-
-    async run() {
-        const { args, flags } = this.parse(SetValueCommand);
-        const { stdin } = this;
-        const { key, value } = args;
-        const { contentType = 'application/json; charset=utf-8' } = flags;
-
-        // NOTE: If user pass value as argument and data on stdin same time. We use the value from argument.
-        const recordValue = value || stdin;
-        const apifyClient = await getApifyStorageClient();
-        const storeClient = apifyClient.keyValueStore(getDefaultStorageId(APIFY_STORAGE_TYPES.KEY_VALUE_STORE));
-        if (recordValue === undefined || recordValue === null) {
-            await storeClient.deleteRecord(key);
-        } else {
-            await storeClient.setRecord({ key, value: recordValue, contentType });
-        }
-    }
-}
-
-SetValueCommand.description = 'Sets or removes record into the default key-value store associated with the Actor run.\n'
-    + 'It is possible to pass data using argument or stdin.\n'
-    + 'Passing data using argument:\n'
-    + '$ apify actor:set-value KEY my-value\n'
-    + 'Passing data using stdin with pipe:\n'
-    + '$ cat ./my-text-file.txt | apify actor:set-value KEY --contentType text/plain\n';
-
-SetValueCommand.args = [
-    {
-        name: 'key',
-        required: true,
-        description: 'Key of the record in key-value store.',
-    },
-    {
-        // TODO: It can be path of the file where value is store. We can add it in the next version.
-        name: 'value',
-        required: false,
-        description: 'Record data, which can be one of the following values:\n'
-            + '- If empty, the record in the key-value store is deleted.\n'
-            + '- If no `contentType` flag is specified, value is expected to be any JSON string value.\n'
-            + '- If options.contentType is set, value is taken as is.',
-    },
-];
-
-SetValueCommand.flags = {
-    contentType: flagsHelper.string({
-        char: 'c',
-        description: 'Specifies a custom MIME content type of the record. By default "application/json" is used.',
-        required: false,
-    }),
-};
-
-module.exports = SetValueCommand;

package/src/commands/call.js

@@ -1,131 +0,0 @@
-const { ACT_JOB_STATUSES } = require('@apify/consts');
-const { flags: flagsHelper } = require('@oclif/command');
-const mime = require('mime');
-
-const { ApifyCommand } = require('../lib/apify_command');
-const { LOCAL_CONFIG_PATH } = require('../lib/consts');
-const outputs = require('../lib/outputs');
-const { getLocalConfig, getLoggedClientOrThrow,
-    getLocalUserInfo, getLocalInput, outputJobLog } = require('../lib/utils');
-
-// TODO: Show full error messages and HTTP codes, this is not great:
-// jan:testx$ apify call help
-// Run: Calling act help...
-// Error: [record-not-found]
-
-class CallCommand extends ApifyCommand {
-    async run() {
-        const { args, flags } = this.parse(CallCommand);
-        const localConfig = getLocalConfig() || {};
-        const apifyClient = await getLoggedClientOrThrow();
-        const userInfo = await getLocalUserInfo();
-        const usernameOrId = userInfo.username || userInfo.id;
-
-        const forceActorId = args.actorId;
-        let actorId;
-        if (forceActorId) {
-            const actor = await apifyClient.actor(forceActorId).get();
-            if (!actor) throw new Error(`Cannot find Actor with ID '${forceActorId}' in your account.`);
-            actorId = actor.username ? `${actor.username}/${actor.name}` : actor.id;
-        } else {
-            actorId = `${usernameOrId}/${localConfig.name}`;
-            const actor = await apifyClient.actor(actorId).get();
-            if (!actor) {
-                throw new Error(`Cannot find actor with ID '${actorId}' `
-                    + 'in your account. Call "apify push" to push this actor to Apify platform.');
-            }
-        }
-
-        const runOpts = {
-            waitForFinish: 2, // NOTE: We need to wait some time to Apify open stream and we can create connection
-        };
-        const waitForFinishMillis = Number.isNaN(flags.waitForFinish)
-            ? undefined
-            : parseInt(flags.waitForFinish, 10) * 1000;
-
-        ['build', 'timeout', 'memory'].forEach((opt) => {
-            if (flags[opt]) runOpts[opt] = flags[opt];
-        });
-
-        // Get input for act
-        const localInput = getLocalInput();
-
-        outputs.run(`Calling actor ${actorId}`);
-
-        let run;
-        try {
-            if (localInput) {
-                // TODO: For some reason we cannot pass json as buffer with right contentType into apify-client.
-                // It will save malformed JSON which looks like buffer as INPUT.
-                // We need to fix this in v1 during removing call under actor namespace.
-                const input = mime.getExtension(localInput.contentType) === 'json' ? JSON.parse(localInput.body.toString('utf-8')) : localInput.body;
-                run = await apifyClient.actor(actorId).start(input, { ...runOpts, contentType: localInput.contentType });
-            } else {
-                run = await apifyClient.actor(actorId).start(null, runOpts);
-            }
-        } catch (err) {
-            // TODO: Better error message in apify-client-js
-            if (err.type === 'record-not-found') throw new Error(`Actor ${args.actorId} not found!`);
-            else throw err;
-        }
-
-        try {
-            await outputJobLog(run, waitForFinishMillis);
-        } catch (err) {
-            outputs.warning('Can not get log:');
-            console.error(err);
-        }
-
-        run = await apifyClient.run(run.id).get();
-
-        outputs.link('Actor run detail', `https://console.apify.com/actors/${run.actId}#/runs/${run.id}`);
-
-        if (run.status === ACT_JOB_STATUSES.SUCCEEDED) {
-            outputs.success('Actor finished.');
-        } else if (run.status === ACT_JOB_STATUSES.RUNNING) {
-            outputs.warning('Actor is still running!');
-        } else {
-            outputs.error('Actor failed!');
-        }
-    }
-}
-
-CallCommand.description = 'Runs a specific actor remotely on the Apify cloud platform.\n'
-    + 'The Actor is run under your current Apify account. Therefore you need to be logged in by calling "apify login". '
-    + 'It takes input for the Actor from the default local key-value store by default.';
-
-CallCommand.flags = {
-    build: flagsHelper.string({
-        char: 'b',
-        description: 'Tag or number of the build to run (e.g. "latest" or "1.2.34").',
-        required: false,
-    }),
-    timeout: flagsHelper.string({
-        char: 't',
-        description: 'Timeout for the actor run in seconds. Zero value means there is no timeout.',
-        required: false,
-        parse: (input) => parseInt(input, 10),
-    }),
-    memory: flagsHelper.string({
-        char: 'm',
-        description: 'Amount of memory allocated for the actor run, in megabytes.',
-        required: false,
-        parse: (input) => parseInt(input, 10),
-    }),
-    'wait-for-finish': flagsHelper.string({
-        char: 'w',
-        description: 'Seconds for waiting to run to finish, if no value passed, it waits forever.',
-        required: false,
-    }),
-};
-
-CallCommand.args = [
-    {
-        name: 'actorId',
-        required: false,
-        description: 'Name or ID of the actor to run (e.g. "apify/hello-world" or "E2jjCZBezvAZnX8Rb"). '
-            + `If not provided, the command runs the remote actor specified in the "${LOCAL_CONFIG_PATH}" file.`,
-    },
-];
-
-module.exports = CallCommand;

package/src/commands/check-version.js

@@ -1,28 +0,0 @@
-const { flags: flagsHelper } = require('@oclif/command');
-
-const { ApifyCommand } = require('../lib/apify_command');
-const { checkLatestVersion } = require('../lib/version_check');
-
-class CheckVersionCommand extends ApifyCommand {
-    async run() {
-        const { flags } = this.parse(CheckVersionCommand);
-
-        checkLatestVersion(flags.enforceUpdate);
-    }
-}
-
-CheckVersionCommand.description = 'Checks that installed Apify CLI version is up to date.';
-
-CheckVersionCommand.flags = {
-    'enforce-update': flagsHelper.boolean({
-        char: 'e',
-        description: '[Optional] Enforce version update from NPM',
-        required: false,
-    }),
-};
-
-CheckVersionCommand.hidden = true;
-
-CheckVersionCommand.aliases = ['cv'];
-
-module.exports = CheckVersionCommand;