@shipeasy/openapi 1.6.0 → 2.1.0

package/dist/operations/killswitches.d.ts

@@ -1,28 +0,0 @@
-import { Operation } from './types.js';
-import '../resources/index.js';
-import 'zod/v4/core';
-import 'zod';
-import '../resources/attributes.js';
-import '../transport.js';
-import '../resources/i18n.js';
-import '../resources/projects.js';
-import '../resources/ops.js';
-import '../resources/events.js';
-import '../resources/metrics.js';
-import '../resources/alert-rules.js';
-import '../schemas/alert-rules.js';
-import '../resources/killswitches.js';
-import '../schemas/killswitches.js';
-import '../schemas/pagination.js';
-import '../resources/universes.js';
-import '../schemas/universes.js';
-import '../resources/configs.js';
-import '../schemas/configs.js';
-import '../resources/experiments.js';
-import '../schemas/experiments.js';
-import '../resources/gates.js';
-import '../schemas/gates.js';
-
-declare const killswitchOperations: Operation[];
-
-export { killswitchOperations };

package/dist/operations/killswitches.js

@@ -1,126 +0,0 @@
-// src/operations/util.ts
-var str = (i, k) => i[k] === void 0 ? void 0 : i[k];
-var bool = (i, k) => i[k] === void 0 ? void 0 : i[k];
-
-// src/operations/killswitches.ts
-var GROUP = ["release", "killswitch"];
-var ENVS = ["dev", "staging", "prod"];
-var killswitchOperations = [
-  {
-    group: GROUP,
-    name: "list",
-    mutates: false,
-    summary: "List all kill switches",
-    description: "Return every kill switch with its per-env default value and switch count.",
-    params: [],
-    examples: [{ run: "shipeasy release killswitch list" }],
-    run: (client) => client.killswitches.listAll()
-  },
-  {
-    group: GROUP,
-    name: "create",
-    mutates: true,
-    summary: "Create a kill switch",
-    description: "Create a kill switch (a static `{ value, switches }` config shipped in the flags KV blob). Name must be `folder.name`. Switches take precedence over `value` for that switch_key.",
-    params: [
-      { name: "name", type: "string", description: "`folder.name` \u2014 two lowercase segments.", required: true, positional: true },
-      { name: "description", type: "string", description: "Optional description." },
-      { name: "value", type: "boolean", description: "Default value (true|false). Defaults to false." },
-      { name: "switches", type: "json", description: "JSON object of { switch_key: bool }; takes precedence over value." }
-    ],
-    examples: [
-      { note: "Default OFF", run: "shipeasy release killswitch create payments.stripe-gateway" },
-      { note: "Pre-seed per-key switches", run: `shipeasy release killswitch create payments.stripe-gateway --switches '{"refunds":true,"payouts":false}'` }
-    ],
-    run: (client, i) => client.killswitches.create({
-      name: i.name,
-      description: str(i, "description"),
-      value: bool(i, "value") ?? false,
-      switches: i.switches
-    })
-  },
-  {
-    group: GROUP,
-    name: "update",
-    mutates: true,
-    summary: "Update a kill switch's default value, switches map, or description",
-    description: "Patch a kill switch. `switches` replaces the map wholesale; pass an empty description to clear it.",
-    params: [
-      { name: "name", type: "string", description: "Kill switch name.", required: true, positional: true },
-      { name: "value", type: "boolean", description: "Default value (true|false)." },
-      { name: "switches", type: "json", description: "JSON { switch_key: bool } \u2014 replaces wholesale." },
-      { name: "description", type: "string", description: "Description (empty string clears it)." }
-    ],
-    examples: [{ note: "Flip the default ON", run: "shipeasy release killswitch update payments.stripe-gateway --value true" }],
-    run: async (client, i) => {
-      const k = await client.killswitches.resolve(i.name);
-      const patch = {};
-      if (i.value !== void 0) patch.value = i.value;
-      if (i.switches !== void 0) patch.switches = i.switches;
-      if (i.description !== void 0) patch.description = i.description === "" ? null : i.description;
-      return client.killswitches.update(k.id, patch);
-    }
-  },
-  {
-    group: GROUP,
-    name: "set",
-    mutates: true,
-    summary: "Set one switch entry on one env",
-    description: "Set or update a single named switch on one environment (default `prod`), leaving the rest untouched.",
-    params: [
-      { name: "name", type: "string", description: "Kill switch name.", required: true, positional: true },
-      { name: "switchKey", type: "string", description: "Switch key to set.", required: true, positional: true },
-      { name: "value", type: "boolean", description: "true|false.", required: true, positional: true },
-      { name: "env", type: "string", description: `Env: ${ENVS.join(" | ")} (default prod).`, enum: ENVS }
-    ],
-    examples: [
-      { note: "Kill refunds in prod", run: "shipeasy release killswitch set payments.stripe-gateway refunds true" },
-      { note: "Target staging instead", run: "shipeasy release killswitch set payments.stripe-gateway refunds true --env staging" }
-    ],
-    run: async (client, i) => {
-      const k = await client.killswitches.resolve(i.name);
-      return client.killswitches.setSwitch(k.id, {
-        env: str(i, "env") ?? "prod",
-        switchKey: i.switchKey,
-        value: i.value
-      });
-    }
-  },
-  {
-    group: GROUP,
-    name: "unset",
-    mutates: true,
-    summary: "Remove one switch entry from one env",
-    description: "Remove a single named switch from one environment (default `prod`), reverting it to the default.",
-    params: [
-      { name: "name", type: "string", description: "Kill switch name.", required: true, positional: true },
-      { name: "switchKey", type: "string", description: "Switch key to remove.", required: true, positional: true },
-      { name: "env", type: "string", description: `Env: ${ENVS.join(" | ")} (default prod).`, enum: ENVS }
-    ],
-    examples: [{ run: "shipeasy release killswitch unset payments.stripe-gateway refunds" }],
-    run: async (client, i) => {
-      const k = await client.killswitches.resolve(i.name);
-      return client.killswitches.unsetSwitch(k.id, {
-        env: str(i, "env") ?? "prod",
-        switchKey: i.switchKey
-      });
-    }
-  },
-  {
-    group: GROUP,
-    name: "archive",
-    mutates: true,
-    summary: "Archive a kill switch",
-    description: "Archive (soft-delete) a kill switch by name.",
-    params: [{ name: "name", type: "string", description: "Kill switch name.", required: true, positional: true }],
-    examples: [{ run: "shipeasy release killswitch archive payments.stripe-gateway" }],
-    run: async (client, i) => {
-      const k = await client.killswitches.resolve(i.name);
-      await client.killswitches.delete(k.id);
-      return { ok: true, archived: i.name };
-    }
-  }
-];
-export {
-  killswitchOperations
-};

package/dist/operations/mcp-adapter.d.ts

@@ -1,35 +0,0 @@
-import { AdminClient } from '../resources/index.js';
-import { Operation, McpTool } from './types.js';
-import 'zod/v4/core';
-import 'zod';
-import '../resources/attributes.js';
-import '../transport.js';
-import '../resources/i18n.js';
-import '../resources/projects.js';
-import '../resources/ops.js';
-import '../resources/events.js';
-import '../resources/metrics.js';
-import '../resources/alert-rules.js';
-import '../schemas/alert-rules.js';
-import '../resources/killswitches.js';
-import '../schemas/killswitches.js';
-import '../schemas/pagination.js';
-import '../resources/universes.js';
-import '../schemas/universes.js';
-import '../resources/configs.js';
-import '../schemas/configs.js';
-import '../resources/experiments.js';
-import '../schemas/experiments.js';
-import '../resources/gates.js';
-import '../schemas/gates.js';
-
-/** Project the registry onto the MCP `tools/list` catalog — one tool per operation. */
-declare function operationsToMcpTools(ops: Operation[]): McpTool[];
-/**
- * Build the `tools/call` dispatch map keyed by MCP tool name. Each entry
- * coerces the raw `arguments` and runs the op against the admin client —
- * replacing the hand-written 60-branch if/else in `mcp/src/server.ts`.
- */
-declare function operationsToDispatch(ops: Operation[]): Record<string, (client: AdminClient, args: Record<string, unknown>) => Promise<unknown>>;
-
-export { operationsToDispatch, operationsToMcpTools };

package/dist/operations/mcp-adapter.js

@@ -1,94 +0,0 @@
-// src/transport.ts
-var ApiError = class extends Error {
-  constructor(message, status) {
-    super(message);
-    this.status = status;
-    this.name = "ApiError";
-  }
-  status;
-};
-
-// src/operations/coerce.ts
-function coerceValue(param, raw) {
-  if (raw === void 0 || raw === null) return void 0;
-  switch (param.type) {
-    case "number": {
-      const n = typeof raw === "number" ? raw : Number(raw);
-      if (!Number.isFinite(n)) throw new ApiError(`--${param.name} must be a number`, 400);
-      return n;
-    }
-    case "boolean":
-      return raw === true || raw === "true" || raw === "1";
-    case "json":
-      if (typeof raw !== "string") return raw;
-      try {
-        return JSON.parse(raw);
-      } catch {
-        throw new ApiError(`--${param.name} must be valid JSON`, 400);
-      }
-    case "string":
-    default: {
-      const s = String(raw);
-      if (param.enum && !param.enum.includes(s)) {
-        throw new ApiError(`--${param.name} must be one of: ${param.enum.join(", ")}`, 400);
-      }
-      return s;
-    }
-  }
-}
-function coerceInput(op, raw) {
-  const out = {};
-  for (const param of op.params) {
-    const value = coerceValue(param, raw[param.name]);
-    if (value === void 0) {
-      if (param.required) throw new ApiError(`${param.name} is required`, 400);
-      continue;
-    }
-    out[param.name] = value;
-  }
-  return out;
-}
-
-// src/operations/types.ts
-var opMcpName = (op) => [...op.group, op.name].join("_");
-
-// src/operations/mcp-adapter.ts
-function jsonType(t) {
-  switch (t) {
-    case "number":
-      return "number";
-    case "boolean":
-      return "boolean";
-    case "json":
-    case "string":
-    default:
-      return "string";
-  }
-}
-function operationsToMcpTools(ops) {
-  return ops.map((op) => {
-    const properties = {};
-    const required = [];
-    for (const p of op.params) {
-      properties[p.name] = { type: jsonType(p.type), description: p.description };
-      if (p.enum) properties[p.name].enum = p.enum;
-      if (p.required) required.push(p.name);
-    }
-    return {
-      name: opMcpName(op),
-      description: op.description,
-      inputSchema: { type: "object", ...required.length ? { required } : {}, properties }
-    };
-  });
-}
-function operationsToDispatch(ops) {
-  const map = {};
-  for (const op of ops) {
-    map[opMcpName(op)] = async (client, args) => op.run(client, coerceInput(op, args ?? {}));
-  }
-  return map;
-}
-export {
-  operationsToDispatch,
-  operationsToMcpTools
-};

package/dist/operations/metrics.d.ts

@@ -1,30 +0,0 @@
-import { Operation } from './types.js';
-import '../resources/index.js';
-import 'zod/v4/core';
-import 'zod';
-import '../resources/attributes.js';
-import '../transport.js';
-import '../resources/i18n.js';
-import '../resources/projects.js';
-import '../resources/ops.js';
-import '../resources/events.js';
-import '../resources/metrics.js';
-import '../resources/alert-rules.js';
-import '../schemas/alert-rules.js';
-import '../resources/killswitches.js';
-import '../schemas/killswitches.js';
-import '../schemas/pagination.js';
-import '../resources/universes.js';
-import '../schemas/universes.js';
-import '../resources/configs.js';
-import '../schemas/configs.js';
-import '../resources/experiments.js';
-import '../schemas/experiments.js';
-import '../resources/gates.js';
-import '../schemas/gates.js';
-
-/** The metric query DSL grammar — the single source for `metrics grammar` on every surface. */
-declare const METRIC_GRAMMAR = "Shipeasy metric query DSL\n=========================\n\nQuery        := AggFunc \"(\" Selector (\",\" Identifier)? \")\" GroupBy?\nAggFunc      := count_users | count | sum | avg | min | max | unique |\n                p50 | p75 | p90 | p95 | p99 | p999 |\n                retention_<N>d            (N in 1..90)\nSelector     := Identifier (\"{\" Filter (\",\" Filter)* \",\"? \"}\")?\nFilter       := Identifier MatchOp StringLiteral\nMatchOp      := \"=\" | \"!=\" | \"=~\" | \"!~\"\nStringLiteral := double-quoted, supports \\\" and \\\\\nGroupBy      := (\"by\" | \"without\") \"(\" Identifier (\",\" Identifier)* \",\"? \")\"\n\nExamples\n--------\n  count_users(checkout_completed)\n  sum(purchase{country=\"US\"}, amount)\n  p99(req_dur{route=~\"/api/.*\"}, ms) by (route, status)\n  retention_7d(session_start)\n  avg(req_dur{tier!=\"free\"}, ms) without (region)\n\nNotes\n-----\n- One event selector per query (no formulas).\n- \"count\" maps to count_events (per-row count); \"count_users\" is uniq-by-user.\n- For experiments, \"by (label)\" is ignored \u2014 per-user reducer is applied.\n- Filter values must be quoted strings, even for numeric labels (they are coerced).\n- Filter labels and value labels must be declared on the source event.\n";
-declare const metricOperations: Operation[];
-
-export { METRIC_GRAMMAR, metricOperations };

package/dist/operations/metrics.js

@@ -1,114 +0,0 @@
-// src/operations/util.ts
-var num = (i, k) => i[k] === void 0 ? void 0 : i[k];
-var str = (i, k) => i[k] === void 0 ? void 0 : i[k];
-
-// src/operations/metrics.ts
-var GROUP = ["metrics"];
-var METRIC_GRAMMAR = `Shipeasy metric query DSL
-=========================
-
-Query        := AggFunc "(" Selector ("," Identifier)? ")" GroupBy?
-AggFunc      := count_users | count | sum | avg | min | max | unique |
-                p50 | p75 | p90 | p95 | p99 | p999 |
-                retention_<N>d            (N in 1..90)
-Selector     := Identifier ("{" Filter ("," Filter)* ","? "}")?
-Filter       := Identifier MatchOp StringLiteral
-MatchOp      := "=" | "!=" | "=~" | "!~"
-StringLiteral := double-quoted, supports \\" and \\\\
-GroupBy      := ("by" | "without") "(" Identifier ("," Identifier)* ","? ")"
-
-Examples
---------
-  count_users(checkout_completed)
-  sum(purchase{country="US"}, amount)
-  p99(req_dur{route=~"/api/.*"}, ms) by (route, status)
-  retention_7d(session_start)
-  avg(req_dur{tier!="free"}, ms) without (region)
-
-Notes
------
-- One event selector per query (no formulas).
-- "count" maps to count_events (per-row count); "count_users" is uniq-by-user.
-- For experiments, "by (label)" is ignored \u2014 per-user reducer is applied.
-- Filter values must be quoted strings, even for numeric labels (they are coerced).
-- Filter labels and value labels must be declared on the source event.
-`;
-var metricOperations = [
-  {
-    group: GROUP,
-    name: "grammar",
-    mutates: false,
-    summary: "Print the metric query DSL grammar",
-    description: "Return the full metric query DSL grammar \u2014 aggregation functions, event selectors, label filters, and group-by. A pure op: it ignores the client and never hits the API.",
-    params: [],
-    examples: [{ run: "shipeasy metrics grammar" }],
-    run: async () => ({ grammar: METRIC_GRAMMAR })
-  },
-  {
-    group: GROUP,
-    name: "list",
-    mutates: false,
-    summary: "List all metrics",
-    description: "Return every metric in the project (name, folder, source event, aggregation).",
-    params: [],
-    examples: [{ run: "shipeasy metrics list" }],
-    run: (client) => client.metrics.list()
-  },
-  {
-    group: GROUP,
-    name: "show",
-    mutates: false,
-    summary: "Show one metric",
-    description: "Resolve a metric by id, id-prefix, or name and return its full detail.",
-    params: [{ name: "metric", type: "string", description: "Metric id or name.", required: true, positional: true }],
-    examples: [{ run: "shipeasy metrics show checkouts" }],
-    run: (client, i) => client.metrics.resolve(i.metric)
-  },
-  {
-    group: GROUP,
-    name: "create",
-    mutates: true,
-    summary: "Create a metric",
-    description: "Create an event-backed metric. Pass the query as the DSL string (`query`) or the typed IR form (`queryIr`). `event` must match the event the query references. Run `metrics grammar` for the DSL syntax.",
-    params: [
-      { name: "name", type: "string", description: "Metric name.", required: true, positional: true },
-      { name: "event", type: "string", description: "Source event name (must equal the query's event).", required: true },
-      { name: "query", type: "string", description: "Query DSL string, e.g. 'sum(purchase, amount)'." },
-      { name: "queryIr", type: "json", description: "Typed IR JSON (alternative to query)." },
-      { name: "folder", type: "string", description: "Folder to file the metric under." },
-      { name: "winsorize", type: "number", description: "Winsorize percentile (1\u201399). Defaults to 99." },
-      { name: "mde", type: "number", description: "Min detectable effect (0\u20131)." }
-    ],
-    examples: [
-      { note: "Unique users who completed checkout", run: "shipeasy metrics create checkouts --event checkout_completed --query 'count_users(checkout_completed)'" },
-      { note: "p99 latency grouped by route", run: `shipeasy metrics create api-latency --event req_dur --query 'p99(req_dur{route=~"/api/.*"}, ms) by (route)'` }
-    ],
-    run: (client, i) => client.metrics.create({
-      name: i.name,
-      event_name: i.event,
-      folder: str(i, "folder") ?? null,
-      winsorize_pct: num(i, "winsorize") ?? 99,
-      min_detectable_effect: num(i, "mde") ?? null,
-      ...i.query ? { query: i.query } : {},
-      ...i.queryIr ? { query_ir: i.queryIr } : {}
-    })
-  },
-  {
-    group: GROUP,
-    name: "archive",
-    mutates: true,
-    summary: "Archive a metric",
-    description: "Archive (soft-delete) a metric by id or name.",
-    params: [{ name: "metric", type: "string", description: "Metric id or name.", required: true, positional: true }],
-    examples: [{ run: "shipeasy metrics archive checkouts" }],
-    run: async (client, i) => {
-      const m = await client.metrics.resolve(i.metric);
-      await client.metrics.delete(m.id);
-      return { ok: true, archived: m.name };
-    }
-  }
-];
-export {
-  METRIC_GRAMMAR,
-  metricOperations
-};

package/dist/operations/ops.d.ts

@@ -1,28 +0,0 @@
-import { Operation } from './types.js';
-import '../resources/index.js';
-import 'zod/v4/core';
-import 'zod';
-import '../resources/attributes.js';
-import '../transport.js';
-import '../resources/i18n.js';
-import '../resources/projects.js';
-import '../resources/ops.js';
-import '../resources/events.js';
-import '../resources/metrics.js';
-import '../resources/alert-rules.js';
-import '../schemas/alert-rules.js';
-import '../resources/killswitches.js';
-import '../schemas/killswitches.js';
-import '../schemas/pagination.js';
-import '../resources/universes.js';
-import '../schemas/universes.js';
-import '../resources/configs.js';
-import '../schemas/configs.js';
-import '../resources/experiments.js';
-import '../schemas/experiments.js';
-import '../resources/gates.js';
-import '../schemas/gates.js';
-
-declare const opsOperations: Operation[];
-
-export { opsOperations };