jitsu-cli 2.14.0-beta.77 → 2.14.0-beta.85

package/src/commands/default-workspace.ts

@@ -0,0 +1,44 @@
+import { ApiClient, ApiError } from "../lib/api-client";
+import { authFilePath, readAuthFile, resolveAuth, updateAuthFile } from "../lib/auth-file";
+import { red } from "../lib/chalk-code-highlight";
+
+export type DefaultWorkspaceOpts = {
+  host?: string;
+  apikey?: string;
+};
+
+export async function setDefaultWorkspace(idOrSlug: string, opts: DefaultWorkspaceOpts) {
+  try {
+    const auth = resolveAuth(opts);
+    const client = new ApiClient(auth);
+    let workspace: { id: string; slug?: string; name?: string };
+    try {
+      workspace = await client.request({
+        method: "GET",
+        path: `/api/workspace/${encodeURIComponent(idOrSlug)}`,
+      });
+    } catch (e) {
+      if (e instanceof ApiError && e.status === 404) {
+        throw new Error(`Workspace '${idOrSlug}' not found (or you don't have access)`);
+      }
+      throw e;
+    }
+    updateAuthFile({ defaultWorkspace: workspace.id });
+    const label = workspace.slug ? `${workspace.slug} (${workspace.id})` : workspace.id;
+    console.log(`Default workspace set to ${label}.`);
+    console.log(`Saved to ${authFilePath()}.`);
+  } catch (e) {
+    console.error(red(`Error: ${e instanceof Error ? e.message : String(e)}`));
+    process.exit(1);
+  }
+}
+
+export async function unsetDefaultWorkspace() {
+  const file = readAuthFile();
+  if (!file?.defaultWorkspace) {
+    console.log("No default workspace is set.");
+    return;
+  }
+  updateAuthFile({ defaultWorkspace: undefined });
+  console.log("Default workspace unset.");
+}

package/src/commands/spec.ts

@@ -0,0 +1,32 @@
+import { Command } from "commander";
+import { red } from "../lib/chalk-code-highlight";
+import { normalizeHost, readAuthFile, resolveAuth } from "../lib/auth-file";
+import { fetchSpec } from "../lib/spec";
+import { DEFAULT_OUTPUT, SUPPORTED_OUTPUTS, print } from "../lib/renderer";
+
+export function buildSpecCommand(): Command {
+  return new Command("spec")
+    .description("Print the live OpenAPI spec served at /api/spec")
+    .option("-o, --output <format>", `Output format: ${SUPPORTED_OUTPUTS.join(", ")}`, DEFAULT_OUTPUT)
+    .option("-h, --host <host>", "Jitsu host (overrides ~/.jitsu/jitsu-cli.json)")
+    .option("-k, --apikey <api-key>", "API key (overrides ~/.jitsu/jitsu-cli.json)")
+    .action(async (opts: { output?: string; host?: string; apikey?: string }) => {
+      try {
+        // Pass a placeholder apikey if missing — /api/spec is public, but resolveAuth
+        // expects an apikey. Fall back to a synthetic one if user has no auth file.
+        const auth = (() => {
+          try {
+            return resolveAuth(opts);
+          } catch {
+            const host = opts.host ?? readAuthFile()?.host ?? "https://use.jitsu.com";
+            return { host: normalizeHost(host), apikey: "anonymous" };
+          }
+        })();
+        const spec = await fetchSpec(auth);
+        print(spec, opts.output);
+      } catch (e) {
+        console.error(red(`Error: ${e instanceof Error ? e.message : String(e)}`));
+        process.exit(1);
+      }
+    });
+}

package/src/index.ts

@@ -8,12 +8,27 @@ import { test } from "./commands/test";
 
 import { jitsuCliVersion, jitsuCliPackageName } from "./lib/version";
 import { whoami } from "./commands/whoami";
+import { buildConfigCommand } from "./commands/config";
+import { buildSpecCommand } from "./commands/spec";
+import { setDefaultWorkspace, unsetDefaultWorkspace } from "./commands/default-workspace";
+import { preprocessArgv } from "./lib/body-fields";
 
-console.log(figlet.textSync("Jitsu CLI", { horizontalLayout: "full" }));
+// Pull ad-hoc body field flags (--name=val, --credentials.password=...) out of argv
+// before Commander parses it. Reserved option names are left in place.
+process.argv = preprocessArgv(process.argv);
+
+// Figlet banner is decorative — write it to stderr so `jitsu config ... -o json | jq`
+// works without filtering. Skip it entirely when stdout is being piped or for spec output
+// (which is also typically piped to other tools).
+const isPipedStdout = !process.stdout.isTTY;
+if (!isPipedStdout) {
+  process.stderr.write(figlet.textSync("Jitsu CLI", { horizontalLayout: "full" }) + "\n");
+}
 
 const p = new Command();
 
-p.name(jitsuCliPackageName).description("CLI command to create, test and deploy extensions for Jitsu Next");
+p.name(jitsuCliPackageName).description("Jitsu CLI — manage workspaces, configuration objects, and extensions");
+
 p.command("init")
   .description("Initialize a new Jitsu extension project")
   .arguments("[dir]")
@@ -31,19 +46,6 @@ p.command("test")
   .option("-d, --dir <dir>", "the directory of project. (Optional). By default, current directory is used")
   .action(test);
 
-// p.command("run")
-//   .description("Check extensions on provided event, config and persistent storage state")
-//   .option("-d, --dir <dir>", "the directory of project. (Optional). By default, current directory is used")
-//   .option(
-//     "-n, --name <name>",
-//     "name of function file to check (optional). Required if multiple functions are defined in project"
-//   )
-//   .option("-t, --type <type>", "entity type to run", "function")
-//   .requiredOption("-e, --event <file_or_json>", "path to file with event json or event json as a string")
-//   .option("-p, --props <file_or_json>", "path to file with config json or config json as a string. (Optional)")
-//   .option("-s, --store <file_or_json>", "path to file with state json or state json as a string. (Optional)")
-//   .action(run);
-
 p.command("whoami")
   .description("Check if current user is logged in. Shows user's info if logged in")
   .option("-h, --host <host>", "Jitsu host or base url", "https://use.jitsu.com")
@@ -56,6 +58,7 @@ p.command("login")
   .option("-h, --host <host>", "Jitsu host or base url", "https://use.jitsu.com")
   .option("-k, --apikey <api-key>", "Jitsu user's Api Key. (Optional). Disables interactive login.")
   .action(login);
+
 p.command("logout").description("Logout").option("-f, --force", "Do not ask for confirmation").action(logout);
 
 p.command("deploy")
@@ -75,9 +78,23 @@ p.command("deploy")
   .option("-n, --name <name...>", "limit deploy to provided entities only. (Optional)")
   .action(deploy);
 
-//version
+p.command("set-default-workspace")
+  .description(
+    "Save a default workspace to ~/.jitsu/jitsu-cli.json. Subsequent `jitsu config` commands use it when -w is omitted."
+  )
+  .argument("<id-or-slug>", "Workspace id or slug")
+  .option("-h, --host <host>", "Jitsu host (overrides ~/.jitsu/jitsu-cli.json)")
+  .option("-k, --apikey <api-key>", "API key in form keyId:secret (overrides ~/.jitsu/jitsu-cli.json)")
+  .action(setDefaultWorkspace);
+
+p.command("unset-default-workspace")
+  .description("Remove the saved default workspace from ~/.jitsu/jitsu-cli.json")
+  .action(unsetDefaultWorkspace);
+
+p.addCommand(buildConfigCommand());
+p.addCommand(buildSpecCommand());
+
 p.version(jitsuCliPackageName + " " + jitsuCliVersion, "-v, --version");
-//help
 p.helpOption("--help", "display help for command");
 
 p.parse();

package/src/lib/api-client.ts

@@ -0,0 +1,64 @@
+import { AuthInfo } from "./auth-file";
+
+export type ApiRequest = {
+  method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+  path: string;
+  query?: Record<string, string | number | boolean | undefined | null>;
+  body?: unknown;
+};
+
+export class ApiError extends Error {
+  status: number;
+  payload: unknown;
+  constructor(status: number, message: string, payload: unknown) {
+    super(message);
+    this.status = status;
+    this.payload = payload;
+  }
+}
+
+export class ApiClient {
+  constructor(private auth: AuthInfo) {}
+
+  url(path: string, query?: ApiRequest["query"]): string {
+    const base = this.auth.host;
+    const p = path.startsWith("/") ? path : `/${path}`;
+    if (!query) return `${base}${p}`;
+    const qs = Object.entries(query)
+      .filter(([, v]) => v !== undefined && v !== null && v !== "")
+      .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`)
+      .join("&");
+    return qs ? `${base}${p}?${qs}` : `${base}${p}`;
+  }
+
+  async request<T = unknown>(req: ApiRequest): Promise<T> {
+    const method = req.method ?? "GET";
+    const headers: Record<string, string> = {
+      Accept: "application/json",
+      Authorization: `Bearer ${this.auth.apikey}`,
+    };
+    let body: string | undefined;
+    if (req.body !== undefined) {
+      headers["Content-Type"] = "application/json";
+      body = JSON.stringify(req.body);
+    }
+    const res = await fetch(this.url(req.path, req.query), { method, headers, body });
+    const text = await res.text();
+    let parsed: unknown = text;
+    if (text && res.headers.get("content-type")?.includes("application/json")) {
+      try {
+        parsed = JSON.parse(text);
+      } catch {
+        // fall through with raw text
+      }
+    }
+    if (!res.ok) {
+      const msg =
+        (parsed && typeof parsed === "object" && "message" in (parsed as any)
+          ? String((parsed as any).message)
+          : undefined) ?? `HTTP ${res.status} ${method} ${req.path}`;
+      throw new ApiError(res.status, msg, parsed);
+    }
+    return parsed as T;
+  }
+}

package/src/lib/auth-file.ts

@@ -0,0 +1,83 @@
+import * as fs from "fs";
+import { mkdirSync, readFileSync, writeFileSync } from "fs";
+import { homedir } from "os";
+
+export type AuthInfo = { host: string; apikey: string };
+
+export type AuthFile = {
+  host?: string;
+  apikey?: string;
+  defaultWorkspace?: string;
+};
+
+const DEFAULT_HOST = "https://use.jitsu.com";
+
+export function authFilePath(): string {
+  return `${homedir()}/.jitsu/jitsu-cli.json`;
+}
+
+export function readAuthFile(): AuthFile | undefined {
+  const path = authFilePath();
+  if (!fs.existsSync(path)) return undefined;
+  return JSON.parse(readFileSync(path, { encoding: "utf-8" }));
+}
+
+// Merge `patch` into the existing auth file, creating the file (and parent dir)
+// if necessary. Setting a field to `undefined` removes it.
+export function updateAuthFile(patch: Partial<AuthFile>): AuthFile {
+  const path = authFilePath();
+  const existing = readAuthFile() ?? {};
+  const next: AuthFile = { ...existing };
+  for (const [k, v] of Object.entries(patch)) {
+    if (v === undefined) delete (next as any)[k];
+    else (next as any)[k] = v;
+  }
+  mkdirSync(`${homedir()}/.jitsu`, { recursive: true });
+  writeFileSync(path, JSON.stringify(next, null, 2));
+  return next;
+}
+
+export function readDefaultWorkspace(): string | undefined {
+  return readAuthFile()?.defaultWorkspace;
+}
+
+// Resolve host + apikey for an authenticated CLI command. Order of precedence:
+//   1. --host / --apikey flags
+//   2. ~/.jitsu/jitsu-cli.json
+//   3. JITSU_HOST / JITSU_APIKEY env vars
+//   4. https://use.jitsu.com (host only)
+export function resolveAuth(opts: { host?: string; apikey?: string }): AuthInfo {
+  let host = opts.host;
+  let apikey = opts.apikey;
+
+  if (!host || !apikey) {
+    const file = readAuthFile();
+    if (file) {
+      if (!host) host = file.host;
+      if (!apikey) apikey = file.apikey;
+    }
+  }
+
+  if (!host) host = process.env.JITSU_HOST;
+  if (!apikey) apikey = process.env.JITSU_APIKEY;
+  if (!host) host = DEFAULT_HOST;
+
+  if (!apikey) {
+    throw new Error("Not authenticated. Run `jitsu login`, set JITSU_APIKEY, or pass --apikey <key>.");
+  }
+
+  return { host: normalizeHost(host), apikey };
+}
+
+export function normalizeHost(host: string): string {
+  let url = host;
+  if (!url.startsWith("http")) {
+    if (url.startsWith("localhost") || /^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+/.test(url)) {
+      url = "http://" + url;
+    } else {
+      url = "https://" + url;
+    }
+  }
+  if (url.endsWith("/")) url = url.slice(0, -1);
+  return url;
+}

package/src/lib/body-builder.ts

@@ -0,0 +1,68 @@
+import * as fs from "fs";
+import yaml from "js-yaml";
+import { parseScalar, setDottedPath } from "./dotted";
+
+export type BodySources = {
+  // Path to a yaml/json file. `-` means stdin.
+  file?: string;
+  // Inline JSON string (full body or partial).
+  json?: string;
+  // Already-parsed dotted-path fields, e.g. { "credentials.password": "secret" }.
+  fields?: Record<string, string>;
+};
+
+// Builds a single request body by merging (deep) sources in this order:
+//   1. -f / --file
+//   2. --json
+//   3. dotted-path flags
+// Later sources override earlier ones at the leaf level. Arrays are replaced, not concatenated.
+// Returns undefined if no source is provided.
+export function buildBody(sources: BodySources): unknown {
+  const layers: any[] = [];
+  if (sources.file) layers.push(loadFile(sources.file));
+  if (sources.json) layers.push(parseInlineJson(sources.json));
+  if (sources.fields && Object.keys(sources.fields).length > 0) {
+    const obj: any = {};
+    for (const [path, raw] of Object.entries(sources.fields)) {
+      setDottedPath(obj, path, parseScalar(raw));
+    }
+    layers.push(obj);
+  }
+  if (layers.length === 0) return undefined;
+  return layers.reduce((acc, layer) => deepMerge(acc, layer), {});
+}
+
+function loadFile(path: string): unknown {
+  const text = path === "-" ? fs.readFileSync(0, "utf-8") : fs.readFileSync(path, "utf-8");
+  // js-yaml's safeLoad handles JSON too (JSON is valid YAML). But trim first — empty file is null.
+  const parsed = yaml.load(text);
+  if (parsed === null || parsed === undefined) {
+    throw new Error(`File ${path} parsed as empty`);
+  }
+  return parsed;
+}
+
+function parseInlineJson(s: string): unknown {
+  try {
+    return JSON.parse(s);
+  } catch (e) {
+    throw new Error(`--json value is not valid JSON: ${(e as Error).message}`);
+  }
+}
+
+function isPlainObject(v: unknown): v is Record<string, unknown> {
+  return typeof v === "object" && v !== null && !Array.isArray(v);
+}
+
+function deepMerge(target: any, source: any): any {
+  if (!isPlainObject(target) || !isPlainObject(source)) return source;
+  const out: any = { ...target };
+  for (const [k, v] of Object.entries(source)) {
+    if (isPlainObject(v) && isPlainObject(out[k])) {
+      out[k] = deepMerge(out[k], v);
+    } else {
+      out[k] = v;
+    }
+  }
+  return out;
+}

package/src/lib/body-fields.ts

@@ -0,0 +1,61 @@
+// Pre-extracts body field flags from process.argv before Commander parses it.
+//
+// Why: we want users to write `--credentials.password=secret` and `--destinationType=postgres`
+// as ad-hoc body fields, but Commander would reject unknown options. The simplest robust
+// solution is to filter argv: anything matching `--<name>=<value>` whose head segment is NOT
+// a reserved Commander option is captured here, and the rest is left for Commander.
+//
+// Single global stash is fine because the CLI runs one command per process.
+
+// Reserved option names — any `--name=value` whose head is in this set is left for Commander.
+// Everything else becomes a body field (top-level for flat names, nested for dotted ones).
+const RESERVED = new Set([
+  "workspace",
+  "output",
+  "host",
+  "apikey",
+  "file",
+  "json",
+  "cascade",
+  "strict",
+  "from",
+  "to",
+  "help",
+  "version",
+]);
+
+const fields: Record<string, string> = {};
+
+// Activate body-field extraction only for the `config` command group. Otherwise the
+// preprocessor would steal flags from `deploy --type=function --name=foo` etc.
+function shouldExtract(argv: string[]): boolean {
+  for (let i = 2; i < argv.length; i++) {
+    const a = argv[i];
+    if (a.startsWith("-")) continue;
+    return a === "config";
+  }
+  return false;
+}
+
+export function preprocessArgv(argv: string[]): string[] {
+  if (!shouldExtract(argv)) return argv;
+  const out: string[] = [];
+  for (const arg of argv) {
+    const m = /^--([a-zA-Z][\w.-]*)=([\s\S]*)$/.exec(arg);
+    if (m) {
+      const head = m[1].split(".")[0];
+      if (!RESERVED.has(head)) {
+        fields[m[1]] = m[2];
+        continue;
+      }
+    }
+    out.push(arg);
+  }
+  return out;
+}
+
+export function consumeBodyFields(): Record<string, string> {
+  const copy = { ...fields };
+  for (const k of Object.keys(fields)) delete fields[k];
+  return copy;
+}

package/src/lib/dotted.ts

@@ -0,0 +1,43 @@
+// Parse a value string from a dotted-path flag.
+// Heuristic: if it parses cleanly as JSON and starts with `[`, `{`, `"`, or is a
+// number/boolean/null literal, take the JSON value. Otherwise treat as a plain string.
+// This lets users pass arrays/objects without quoting hell while keeping bare strings
+// (`--name=foo`) working without quoting them as `"foo"`.
+export function parseScalar(raw: string): unknown {
+  if (raw === "") return "";
+  const trimmed = raw.trim();
+  const first = trimmed[0];
+  const looksLikeJson =
+    first === "{" ||
+    first === "[" ||
+    first === '"' ||
+    trimmed === "true" ||
+    trimmed === "false" ||
+    trimmed === "null" ||
+    /^-?\d/.test(trimmed);
+  if (looksLikeJson) {
+    try {
+      return JSON.parse(trimmed);
+    } catch {
+      // fall through to string
+    }
+  }
+  return raw;
+}
+
+// Build an object by setting `path` (e.g. "credentials.password") to `value`.
+// Numeric path segments (`a.0.b`) are NOT special — kept as object keys. If you
+// need arrays, pass them as JSON values (e.g. --keys='["a","b"]').
+export function setDottedPath(target: any, path: string, value: unknown): any {
+  const parts = path.split(".");
+  let node = target;
+  for (let i = 0; i < parts.length - 1; i++) {
+    const key = parts[i];
+    if (node[key] == null || typeof node[key] !== "object" || Array.isArray(node[key])) {
+      node[key] = {};
+    }
+    node = node[key];
+  }
+  node[parts[parts.length - 1]] = value;
+  return target;
+}

package/src/lib/renderer.ts

@@ -0,0 +1,44 @@
+import yaml from "js-yaml";
+
+export interface Renderer {
+  format: string;
+  render(value: unknown): string;
+}
+
+const renderers: Record<string, Renderer> = {
+  yaml: {
+    format: "yaml",
+    render(value) {
+      if (value === undefined) return "";
+      // skipInvalid drops things like undefined/functions silently.
+      // noRefs avoids YAML anchors (`&id001`) which confuse readers and most YAML consumers.
+      return yaml.dump(value, { skipInvalid: true, noRefs: true, sortKeys: false, lineWidth: 120 });
+    },
+  },
+  json: {
+    format: "json",
+    render(value) {
+      return JSON.stringify(value, null, 2) + "\n";
+    },
+  },
+};
+
+export const SUPPORTED_OUTPUTS = Object.keys(renderers);
+export const DEFAULT_OUTPUT = "yaml";
+
+export function getRenderer(format?: string): Renderer {
+  const key = (format ?? DEFAULT_OUTPUT).toLowerCase();
+  const r = renderers[key];
+  if (!r) {
+    throw new Error(`Unsupported output format '${format}'. Supported: ${SUPPORTED_OUTPUTS.join(", ")}`);
+  }
+  return r;
+}
+
+export function registerRenderer(r: Renderer) {
+  renderers[r.format.toLowerCase()] = r;
+}
+
+export function print(value: unknown, format?: string) {
+  process.stdout.write(getRenderer(format).render(value));
+}

package/src/lib/spec.ts

@@ -0,0 +1,32 @@
+import { ApiClient } from "./api-client";
+import { AuthInfo } from "./auth-file";
+
+// Minimal subset of OpenAPI 3 we use. Avoids a runtime dep on openapi-types.
+export type OpenApiSpec = {
+  openapi?: string;
+  info?: { title?: string; version?: string; description?: string };
+  paths?: Record<string, Record<string, OpenApiOperation>>;
+  components?: { schemas?: Record<string, any> };
+};
+export type OpenApiOperation = {
+  summary?: string;
+  description?: string;
+  tags?: string[];
+  parameters?: any[];
+  requestBody?: any;
+  responses?: Record<string, any>;
+};
+
+export async function fetchSpec(auth: AuthInfo): Promise<OpenApiSpec> {
+  // /api/spec is public — no auth required, but reusing the client keeps host handling consistent.
+  const client = new ApiClient(auth);
+  return client.request<OpenApiSpec>({ method: "GET", path: "/api/spec" });
+}
+
+// Resolves the operation that matches a (templated) path + method, e.g.
+//   ("/api/{workspaceId}/config/{type}", "post") → operation node with summary/description.
+export function findOperation(spec: OpenApiSpec, path: string, method: string): OpenApiOperation | undefined {
+  const item = spec.paths?.[path];
+  if (!item) return undefined;
+  return item[method.toLowerCase()];
+}