@salesforce/plugin-api 1.1.0

package/oclif.manifest.json

@@ -0,0 +1,130 @@
+{
+  "commands": {
+    "api:request:rest": {
+      "aliases": [],
+      "args": {
+        "endpoint": {
+          "description": "Salesforce API endpoint",
+          "name": "endpoint",
+          "required": true
+        }
+      },
+      "examples": [
+        "- List information about limits in the org with alias \"my-org\":\n\n  <%= config.bin %> <%= command.id %> 'limits' --target-org my-org\n\n- List all endpoints\n\n  <%= config.bin %> <%= command.id %> '/'\n\n- Get the response in XML format by specifying the \"Accept\" HTTP header:\n\n  <%= config.bin %> <%= command.id %> 'limits' --target-org my-org --header 'Accept: application/xml'\n\n- POST to create an Account object\n\n  <%= config.bin %> <%= command.id %> 'sobjects/account' --body \"{\\\"Name\\\" : \\\"Account from REST API\\\",\\\"ShippingCity\\\" : \\\"Boise\\\"}\" --method POST\n\n- or with a file 'info.json' containing\n\n```json\n{\n  \"Name\": \"Demo\",\n  \"ShippingCity\": \"Boise\"\n}\n```\n\n<%= config.bin %> <%= command.id %> 'sobjects/account' --body info.json --method POST\n\n- Update object\n\n  <%= config.bin %> <%= command.id %> 'sobjects/account/<Account ID>' --body \"{\\\"BillingCity\\\": \\\"San Francisco\\\"}\" --method PATCH"
+      ],
+      "flags": {
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "include": {
+          "char": "i",
+          "exclusive": [
+            "stream-to-file"
+          ],
+          "name": "include",
+          "summary": "Include the HTTP response status and headers in the output.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "method": {
+          "char": "X",
+          "name": "method",
+          "summary": "HTTP method for the request.",
+          "default": "GET",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "GET",
+            "POST",
+            "PUT",
+            "PATCH",
+            "HEAD",
+            "DELETE",
+            "OPTIONS",
+            "TRACE"
+          ],
+          "type": "option"
+        },
+        "header": {
+          "char": "H",
+          "name": "header",
+          "summary": "HTTP header in \"key:value\" format.",
+          "hasDynamicHelp": false,
+          "helpValue": "key:value",
+          "multiple": true,
+          "type": "option"
+        },
+        "stream-to-file": {
+          "char": "S",
+          "exclusive": [
+            "include"
+          ],
+          "name": "stream-to-file",
+          "summary": "Stream responses to a file.",
+          "hasDynamicHelp": false,
+          "helpValue": "Example: report.xlsx",
+          "multiple": false,
+          "type": "option"
+        },
+        "body": {
+          "name": "body",
+          "summary": "File to use as the body for the request. Specify \"-\" to read from standard input; specify \"\" for an empty body.",
+          "hasDynamicHelp": false,
+          "helpValue": "file",
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "api:request:rest",
+      "pluginAlias": "@salesforce/plugin-api",
+      "pluginName": "@salesforce/plugin-api",
+      "pluginType": "core",
+      "state": "beta",
+      "strict": true,
+      "summary": "Make an authenticated HTTP request to Salesforce REST API and print the response.",
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "api",
+        "request",
+        "rest.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "api:request:rest",
+        "request:api:rest",
+        "request:rest:api",
+        "api:rest:request",
+        "rest:api:request",
+        "rest:request:api"
+      ]
+    }
+  },
+  "version": "1.1.0"
+}

package/package.json

@@ -0,0 +1,207 @@
+{
+    "name": "@salesforce/plugin-api",
+    "description": "A plugin to call API endpoints via CLI commands",
+    "version": "1.1.0",
+    "author": "Salesforce",
+    "bugs": "https://github.com/forcedotcom/cli/issues",
+    "dependencies": {
+        "@oclif/core": "^4",
+        "@salesforce/core": "^8.4.0",
+        "@salesforce/kit": "^3.2.1",
+        "@salesforce/sf-plugins-core": "^11.3.2",
+        "ansis": "^3.3.2",
+        "got": "^13.0.0",
+        "proxy-agent": "^6.4.0"
+    },
+    "devDependencies": {
+        "@oclif/plugin-command-snapshot": "^5.2.12",
+        "@salesforce/cli-plugins-testkit": "^5.3.25",
+        "@salesforce/dev-scripts": "^10.2.9",
+        "@salesforce/plugin-command-reference": "^3.1.16",
+        "eslint-plugin-sf-plugin": "^1.20.4",
+        "nock": "^13.5.4",
+        "oclif": "^4.14.19",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.5.4"
+    },
+    "engines": {
+        "node": ">=18.0.0"
+    },
+    "files": [
+        "/lib",
+        "/messages",
+        "/npm-shrinkwrap.json",
+        "/oclif.lock",
+        "/oclif.manifest.json",
+        "/schemas"
+    ],
+    "homepage": "https://github.com/salesforcecli/plugin-api",
+    "keywords": [
+        "force",
+        "salesforce",
+        "salesforcedx",
+        "sf",
+        "sf-plugin",
+        "sfdx",
+        "sfdx-plugin"
+    ],
+    "license": "BSD-3-Clause",
+    "oclif": {
+        "commands": "./lib/commands",
+        "bin": "sf",
+        "topicSeparator": " ",
+        "devPlugins": [
+            "@oclif/plugin-help",
+            "@oclif/plugin-command-snapshot",
+            "@salesforce/plugin-command-reference"
+        ],
+        "topics": {
+            "api": {
+                "description": "commands to send and interact with API calls"
+            }
+        },
+        "flexibleTaxonomy": true
+    },
+    "repository": "salesforcecli/plugin-api",
+    "scripts": {
+        "build": "wireit",
+        "clean": "sf-clean",
+        "clean-all": "sf-clean all",
+        "compile": "wireit",
+        "docs": "sf-docs",
+        "format": "wireit",
+        "link-check": "wireit",
+        "lint": "wireit",
+        "postpack": "sf-clean --ignore-signing-artifacts",
+        "prepack": "sf-prepack",
+        "prepare": "sf-install",
+        "test": "wireit",
+        "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+        "test:only": "wireit",
+        "version": "oclif readme"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "wireit": {
+        "build": {
+            "dependencies": [
+                "compile",
+                "lint"
+            ]
+        },
+        "compile": {
+            "command": "tsc -p . --pretty --incremental",
+            "files": [
+                "src/**/*.ts",
+                "**/tsconfig.json",
+                "messages/**"
+            ],
+            "output": [
+                "lib/**",
+                "*.tsbuildinfo"
+            ],
+            "clean": "if-file-deleted"
+        },
+        "format": {
+            "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
+            "files": [
+                "src/**/*.ts",
+                "test/**/*.ts",
+                "schemas/**/*.json",
+                "command-snapshot.json",
+                ".prettier*"
+            ],
+            "output": []
+        },
+        "lint": {
+            "command": "eslint src test --color --cache --cache-location .eslintcache",
+            "files": [
+                "src/**/*.ts",
+                "test/**/*.ts",
+                "messages/**",
+                "**/.eslint*",
+                "**/tsconfig.json"
+            ],
+            "output": []
+        },
+        "test:compile": {
+            "command": "tsc -p \"./test\" --pretty",
+            "files": [
+                "test/**/*.ts",
+                "**/tsconfig.json"
+            ],
+            "output": []
+        },
+        "test": {
+            "dependencies": [
+                "test:compile",
+                "test:only",
+                "test:command-reference",
+                "test:deprecation-policy",
+                "lint",
+                "test:json-schema",
+                "link-check"
+            ]
+        },
+        "test:only": {
+            "command": "nyc mocha \"test/**/*.test.ts\"",
+            "env": {
+                "FORCE_COLOR": "2"
+            },
+            "files": [
+                "test/**/*.ts",
+                "src/**/*.ts",
+                "**/tsconfig.json",
+                ".mocha*",
+                "!*.nut.ts",
+                ".nycrc"
+            ],
+            "output": []
+        },
+        "test:command-reference": {
+            "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" commandreference:generate --erroronwarnings",
+            "files": [
+                "src/**/*.ts",
+                "messages/**",
+                "package.json"
+            ],
+            "output": [
+                "tmp/root"
+            ]
+        },
+        "test:deprecation-policy": {
+            "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" snapshot:compare",
+            "files": [
+                "src/**/*.ts"
+            ],
+            "output": [],
+            "dependencies": [
+                "compile"
+            ]
+        },
+        "test:json-schema": {
+            "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" schema:compare",
+            "files": [
+                "src/**/*.ts",
+                "schemas"
+            ],
+            "output": []
+        },
+        "link-check": {
+            "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"**/*.md\" --skip \"CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|%s\" --markdown --retry --directory-listing --verbosity error",
+            "files": [
+                "./*.md",
+                "./!(CHANGELOG).md",
+                "messages/**/*.md"
+            ],
+            "output": []
+        }
+    },
+    "exports": "./lib/index.js",
+    "type": "module",
+    "sfdx": {
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-api/1.1.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-api/1.1.0.sig"
+    }
+}