@trayai/tray-sync-cli 1.0.4 → 1.0.6

package/README.md

@@ -1,5 +1,8 @@
 # tray-sync-cli
-CLI tool to clone tray projects and related assets on local machine which then can be used with version control system or promoted to different tray environment
+
+#### Tray CLI tool allows users to
+- General-purpose, authenticated proxy to the Tray API
+- Clone, review and promote Tray projects and related assets on a local machine or a version controlled pipeline
 
 ## Requirements
 
@@ -43,7 +46,8 @@ Decide which workspace you're pulling *from* (the source) and which one you're p
 - Source: `DEV_ORG`
 - Target: `PROD_ORG`
 
-You'll need each workspace's ID and region, and a Tray API token with access to it.
+
+You'll need each workspace's ID and region, and a Tray API token with access to it. 📚 Learn how to create tokens for your [workspace (recommended)](https://tray.ai/documentation/platform/enterprise-core/organisation-management/api-users-tokens#enabling-workspace-admins-to-generate-tokens) / [account](https://tray.ai/documentation/platform/enterprise-core/organisation-management/api-users-tokens) here.
 
 ### 2. Create a local directory for this project
 

package/dist/cli.js

@@ -10,22 +10,37 @@ import { projectCommand } from "./commands/project.js";
 import { envCommand } from "./commands/env.js";
 import { authCommand } from "./commands/auth.js";
 import { promoteCommand } from "./commands/promote.js";
+import { apiCommand } from "./commands/api/api.js";
+import { isApiEnabled } from "./lib/apiAuth.js";
 import { BANNER } from "./views/banner.js";
+import { TrayHelp } from "./views/help.js";
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const pkg = JSON.parse(readFileSync(path.join(__dirname, "..", "package.json"), "utf8"));
+Command.prototype.createHelp = () => new TrayHelp();
 const program = new Command();
+const description = `⭐ Mirror Tray projects to local files, promote them between Tray environments${isApiEnabled() ? ', and run general-purpose API requests' : ''}\n📚 Readme available at https://www.npmjs.com/package/@trayai/tray-sync-cli`;
 program
     .name("tray")
-    .description("Mirror Tray projects to local files and promote them between Tray environments")
+    .description(description)
     .version(pkg.version, "-v, --version")
+    .helpCommand(false)
     .addHelpText("beforeAll", (context) => (context.command === program ? BANNER : ""));
-program.addCommand(initCommand);
-program.addCommand(pullCommand);
-program.addCommand(statusCommand);
-program.addCommand(projectCommand);
-program.addCommand(envCommand);
-program.addCommand(authCommand);
-program.addCommand(promoteCommand);
+for (const cmd of [
+    initCommand,
+    pullCommand,
+    statusCommand,
+    projectCommand,
+    envCommand,
+    authCommand,
+    promoteCommand,
+]) {
+    cmd.helpGroup("Local project management");
+    program.addCommand(cmd);
+}
+if (isApiEnabled()) {
+    apiCommand.helpGroup("General-purpose API (growing)");
+    program.addCommand(apiCommand);
+}
 program.parseAsync(process.argv).catch((err) => {
     const message = err instanceof Error ? err.message : String(err);
     console.error(message);

package/dist/commands/api/api.js

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+export const apiCommand = new Command("api").description("Direct, authenticated access to the Tray API");
+//# sourceMappingURL=api.js.map

package/dist/lib/apiAuth.js

@@ -0,0 +1,27 @@
+import { REGIONS, PUBLIC_REGIONS } from "./regionParsing.js";
+import { describeRegion } from "./regionDisplay.js";
+export function resolveApiToken(options) {
+    const { tokenFlag, env = process.env } = options;
+    if (tokenFlag)
+        return tokenFlag;
+    if (env.TRAY_API_TOKEN)
+        return env.TRAY_API_TOKEN;
+    throw new Error("No API token provided. Pass -t/--token <token> or set TRAY_API_TOKEN.");
+}
+export function resolveApiRegion(options) {
+    const { regionFlag, env = process.env } = options;
+    if (regionFlag)
+        return regionFlag;
+    const envRegion = env.TRAY_API_REGION;
+    if (envRegion) {
+        if (!REGIONS.includes(envRegion)) {
+            throw new Error(`TRAY_API_REGION="${envRegion}" is not a supported region. Must be one of: ${PUBLIC_REGIONS.map(describeRegion).join(", ")}.`);
+        }
+        return envRegion;
+    }
+    throw new Error("No region provided. Pass -r/--region <region> or set TRAY_API_REGION.");
+}
+export function isApiEnabled(env = process.env) {
+    return env.TRAY_CLI_API_ENABLE === "true";
+}
+//# sourceMappingURL=apiAuth.js.map

package/dist/views/help.js

@@ -0,0 +1,25 @@
+import { Help } from "commander";
+import ansis from "ansis";
+export const COMMAND_COLOR = "#5FD4D4";
+export class TrayHelp extends Help {
+    styleTitle(str) {
+        return ansis.bold(str.replace(/:$/, "").toUpperCase());
+    }
+    styleSubcommandText(str) {
+        return str === "[command]" ? str : ansis.hex(COMMAND_COLOR)(str);
+    }
+    styleCommandText(str) {
+        return ansis.hex(COMMAND_COLOR)(str);
+    }
+    styleUsage(str) {
+        return `\n  $ ${super.styleUsage(str)}`;
+    }
+    formatHelp(cmd, helper) {
+        const full = super.formatHelp(cmd, helper).replace(/^(.*?) \n/, "$1\n");
+        if (helper.commandDescription(cmd).length === 0)
+            return full;
+        const [usageBlock, descriptionBlock, ...rest] = full.split("\n\n");
+        return [descriptionBlock, usageBlock, ...rest].join("\n\n");
+    }
+}
+//# sourceMappingURL=help.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayai/tray-sync-cli",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "CLI tool to clone Tray projects and related assets to a local directory, and promote them between Tray environments",
   "bin": {
     "tray": "dist/cli.js"
@@ -22,7 +22,7 @@
     "build": "rm -rf dist && tsc -p tsconfig.json && chmod +x dist/cli.js",
     "prepack": "npm run build",
     "pretest": "tsc -p tsconfig.test.json",
-    "test": "node --test dist-test/test/**/*.test.js",
+    "test": "node --test \"dist-test/test/**/*.test.js\"",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "build-and-reinstall": "npm uninstall -g @trayai/tray-sync-cli --silent || true; npm run build && npm pack --silent | xargs -I{} sh -c 'npm install -g ./{} && rm ./{}'"
   },