@shortcut-cli/shortcut-cli 3.4.0 → 3.5.0

package/README.md

@@ -18,6 +18,7 @@ This is a community-driven command line interface for [Shortcut](https://shortcu
     -   [Epics](#epics)
     -   [Workflows](#workflows)
     -   [Projects](#projects)
+    -   [API](#api)
 -   [Development](#development)
 -   [Acknowledgments](#acknowledgments)
 
@@ -74,6 +75,7 @@ SHORTCUT_API_TOKEN=foobar short story 3300
     epics           list epics and their states
     projects        list or search projects
     workspace       list stories matching saved workspace query
+    api             make a request to the Shortcut API
     help [cmd]      display help for [cmd]
 ```
 
@@ -354,6 +356,29 @@ Templating variables:
     -h, --help           output usage information
 ```
 
+### API
+
+```
+  Usage: short api <path> [options]
+
+  Make a request to the Shortcut API.
+
+
+  Options:
+
+    -X, --method <method>      The HTTP method to use. (default: "GET")
+    -H, --header <header>      Add a header to the request (e.g., "Content-Type: application/json"). Can be specified multiple times.
+    -f, --raw-field <key=value>  Add a string parameter. Can be specified multiple times.
+    -h, --help                 output usage information
+
+
+  Examples:
+    $ short api /search/iterations -f page_size=10 -f query=123
+    $ short api /stories -X POST -f 'name=My new story' -f project_id=123
+    # jq can be used to shorten the response output.
+    $ short api /search/iterations -f page_size=10 -f query=123 | jq '.data[] | {id, name}'
+```
+
 ## Development
 
 You can use TypeScript watcher which will recompile your code automatically:

package/build/_virtual/rolldown_runtime.js

@@ -0,0 +1,25 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+exports.__toESM = __toESM;

package/build/bin/short-api.js

@@ -0,0 +1,78 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.js');
+const require_lib_spinner = require('../lib/spinner.js');
+const require_lib_client = require('../lib/client.js');
+const commander = require_rolldown_runtime.__toESM(require("commander"));
+const debug = require_rolldown_runtime.__toESM(require("debug"));
+
+//#region src/bin/short-api.ts
+const debug$1 = (0, debug.default)("short-api");
+const log = console.log;
+const logError = console.error;
+const spin = require_lib_spinner.default();
+const parseKeyVal = (input, separator = "=") => {
+	const parts = input.split(separator);
+	const key = parts.shift();
+	const value = parts.join(separator);
+	return [key, value];
+};
+const collect = (val, memo) => {
+	memo.push(val);
+	return memo;
+};
+const program = commander.default.description("Make a request to the Shortcut API.").arguments("<path>").option("-X, --method <method>", "The HTTP method to use.", "GET").option("-H, --header <header>", "Add a header to the request (e.g., \"Content-Type: application/json\"). Can be specified multiple times.", collect, []).option("-f, --raw-field <key=value>", "Add a string parameter. Can be specified multiple times.", collect, []).on("--help", () => {
+	log("");
+	log("Examples:");
+	log(`  $ short api /search/iterations -f page_size=10 -f query=123`);
+	log(`  $ short api /stories -X POST -f 'name=My new story' -f project_id=123`);
+	log("  # jq can be used to shorten the response output.");
+	log(`  $ short api /search/iterations -f page_size=10 -f query=123 | jq '.data[] | {id, name}'`);
+}).parse(process.argv);
+const main = async () => {
+	const [path] = program.args;
+	if (!path) {
+		logError("Error path argument is required");
+		program.help();
+		process.exit(1);
+	}
+	const method = (program.method || "GET").toUpperCase();
+	const headers = {};
+	const params = {};
+	if (program.header) program.header.forEach((h) => {
+		const [key, value] = parseKeyVal(h, ":");
+		headers[key] = value;
+		debug$1(`adding header: ${key}: ${value}`);
+	});
+	if (program.rawField) program.rawField.forEach((f) => {
+		const [key, value] = parseKeyVal(f);
+		params[key] = value;
+		debug$1(`adding raw field: ${key}: ${value}`);
+	});
+	const requestOptions = {
+		path: "/api/v3" + (path.startsWith("/") ? "" : "/") + path,
+		method,
+		headers
+	};
+	const bodyMethods = [
+		"POST",
+		"PUT",
+		"PATCH"
+	];
+	if (bodyMethods.includes(method)) {
+		requestOptions.body = params;
+		if (!headers["Content-Type"]) headers["Content-Type"] = "application/json";
+	} else requestOptions.query = params;
+	try {
+		debug$1("request options:", requestOptions);
+		spin.start();
+		const response = await require_lib_client.default.request(requestOptions);
+		spin.stop(true);
+		log(JSON.stringify(response.data, null, 2));
+	} catch (err) {
+		spin.stop(true);
+		logError("Error calling API:", err.response ? JSON.stringify(err.response.data, null, 2) : err.message);
+		process.exit(1);
+	}
+};
+main();
+
+//#endregion