@shipeasy/openapi 1.6.0 → 2.2.0

package/dist/operations/gates.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 gateOperations: Operation[];
-
-export { gateOperations };

package/dist/operations/gates.js

@@ -1,132 +0,0 @@
-// src/operations/util.ts
-var num = (i, k) => i[k] === void 0 ? void 0 : i[k];
-
-// src/operations/gates.ts
-var ROLLOUT_DESC = "Rollout percentage, 0\u2013100 (converted to basis points internally).";
-var RULES_DESC = `Targeting rules as a JSON array, e.g. '[{"attr":"plan","op":"eq","value":"pro"}]'. AND-combined.`;
-var STACK_DESC = "Gatekeeper stack as a JSON array of ordered first-match-wins tiers (condition/rollout steps, rolloutPct in basis points). Takes precedence over flat rules/rollout. Pass to express internal \u222A beta \u222A public in one gate.";
-var gateOperations = [
-  {
-    group: ["release", "flags"],
-    name: "list",
-    mutates: false,
-    summary: "List all feature gates",
-    description: "Return every feature gate in the project (name, enabled, rollout %), ordered by most recently updated.",
-    params: [],
-    examples: [{ run: "shipeasy release flags list" }],
-    run: (client) => client.gates.listAll()
-  },
-  {
-    group: ["release", "flags"],
-    name: "create",
-    mutates: true,
-    summary: "Create a feature gate",
-    description: "Create a feature gate. A flat gate is `rules` + a single `rollout` %. For tiered rollouts (e.g. 'US @ 50% \u2192 bots @ 30% \u2192 everyone else @ 10%') pass `stack` \u2014 an ordered list of steps evaluated first-match-wins; flat `rules`/`rollout` are then ignored.",
-    params: [
-      { name: "name", type: "string", description: "Gate key (lowercase, digits, _/-).", required: true, positional: true },
-      { name: "rollout", type: "number", description: ROLLOUT_DESC },
-      { name: "rules", type: "json", description: RULES_DESC },
-      { name: "salt", type: "string", description: "Override hash salt (immutable after create)." },
-      { name: "stack", type: "json", description: STACK_DESC }
-    ],
-    examples: [
-      { note: "Off by default; flip it on later", run: "shipeasy release flags create checkout-v2" },
-      {
-        note: "Roll out to 25% of pro-plan users",
-        run: `shipeasy release flags create new-ui --rollout 25 --rules '[{"attr":"plan","op":"eq","value":"pro"}]'`
-      }
-    ],
-    run: (client, i) => client.gates.create({
-      name: i.name,
-      rollout_pct: Math.round((num(i, "rollout") ?? 0) * 100),
-      // Validated at runtime by gateCreateSchema.parse inside gates.create().
-      rules: i.rules ?? [],
-      ...i.salt ? { salt: i.salt } : {},
-      ...i.stack ? { stack: i.stack } : {}
-    })
-  },
-  {
-    group: ["release", "flags"],
-    name: "update",
-    mutates: true,
-    summary: "Update a gate's rollout, rules, stack, or enabled flag",
-    description: "Update a feature gate's rollout, rules, gatekeeper stack, or enabled flag. Pass `stack` to replace the tiered rollout wholesale; array fields replace, they do not merge.",
-    params: [
-      { name: "name", type: "string", description: "Gate name to update.", required: true, positional: true },
-      { name: "rollout", type: "number", description: ROLLOUT_DESC },
-      { name: "rules", type: "json", description: RULES_DESC + " Replaces the existing rules wholesale." },
-      { name: "stack", type: "json", description: STACK_DESC + " Pass null to revert to flat evaluation." },
-      { name: "enabled", type: "boolean", description: "Master switch \u2014 false forces the gate off for every caller." }
-    ],
-    examples: [{ note: "Ramp to 50%", run: "shipeasy release flags update checkout-v2 --rollout 50" }],
-    run: async (client, i) => {
-      const gate = await client.gates.resolve(i.name);
-      const patch = {};
-      const rollout = num(i, "rollout");
-      if (rollout !== void 0) patch.rollout_pct = Math.round(rollout * 100);
-      if (i.rules !== void 0) patch.rules = i.rules;
-      if (i.stack !== void 0) patch.stack = i.stack;
-      if (i.enabled !== void 0) patch.enabled = i.enabled;
-      return client.gates.update(gate.id, patch);
-    }
-  },
-  {
-    group: ["release", "flags"],
-    name: "enable",
-    mutates: true,
-    summary: "Enable a feature gate",
-    description: "Set `enabled: true`, preserving the current rollout %.",
-    params: [{ name: "name", type: "string", description: "Gate name.", required: true, positional: true }],
-    examples: [{ run: "shipeasy release flags enable checkout-v2" }],
-    run: async (client, i) => {
-      const gate = await client.gates.resolve(i.name);
-      return client.gates.enable(gate.id);
-    }
-  },
-  {
-    group: ["release", "flags"],
-    name: "disable",
-    mutates: true,
-    summary: "Disable a feature gate (kill switch)",
-    description: "Set `enabled: false` so the gate evaluates to `false` for every caller regardless of rules/rollout.",
-    params: [{ name: "name", type: "string", description: "Gate name.", required: true, positional: true }],
-    examples: [{ run: "shipeasy release flags disable checkout-v2" }],
-    run: async (client, i) => {
-      const gate = await client.gates.resolve(i.name);
-      return client.gates.disable(gate.id);
-    }
-  },
-  {
-    group: ["release", "flags"],
-    name: "rollout",
-    mutates: true,
-    summary: "Set rollout percentage (0\u2013100)",
-    description: "Resolve the gate by name and set its rollout percentage (0\u2013100).",
-    params: [
-      { name: "name", type: "string", description: "Gate name.", required: true, positional: true },
-      { name: "pct", type: "number", description: "Rollout percentage, 0\u2013100.", required: true, positional: true }
-    ],
-    examples: [
-      { note: "Ramp to 50%", run: "shipeasy release flags rollout checkout-v2 50" },
-      { note: "Instant kill \u2014 set to 0", run: "shipeasy release flags rollout checkout-v2 0" }
-    ],
-    run: (client, i) => client.gates.setRollout(i.name, num(i, "pct"))
-  },
-  {
-    group: ["release", "flags"],
-    name: "archive",
-    mutates: true,
-    summary: "Archive a feature gate",
-    description: "Archive (soft-delete) a feature gate by name. Refuses if a running experiment references it as a targeting gate.",
-    params: [{ name: "name", type: "string", description: "Gate name.", required: true, positional: true }],
-    examples: [{ run: "shipeasy release flags archive checkout-v2" }],
-    run: async (client, i) => {
-      const gate = await client.gates.resolve(i.name);
-      await client.gates.delete(gate.id);
-      return { ok: true, archived: i.name };
-    }
-  }
-];
-export {
-  gateOperations
-};

package/dist/operations/i18n.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 i18nOperations: Operation[];
-
-export { i18nOperations };

package/dist/operations/i18n.js

@@ -1,121 +0,0 @@
-// src/operations/util.ts
-var str = (i, k) => i[k] === void 0 ? void 0 : i[k];
-
-// src/operations/i18n.ts
-var I18N = ["i18n"];
-var PROFILES = ["i18n", "profiles"];
-var DRAFTS = ["i18n", "drafts"];
-var i18nOperations = [
-  {
-    group: PROFILES,
-    name: "list",
-    mutates: false,
-    summary: "List i18n locale profiles",
-    description: "List the project's i18n locale profiles (name, default locale, locales).",
-    params: [],
-    examples: [{ run: "shipeasy i18n profiles list" }],
-    run: (client) => client.i18n.listProfiles()
-  },
-  {
-    group: PROFILES,
-    name: "create",
-    mutates: true,
-    summary: "Create an i18n locale profile",
-    description: "Create an i18n profile (e.g. 'en:prod', 'fr:prod') with one or more locales.",
-    params: [
-      { name: "name", type: "string", description: "Profile name.", required: true, positional: true },
-      { name: "locales", type: "json", description: `Locales as a JSON array, e.g. '["fr","fr-CA"]'. Defaults to ["en"].` },
-      { name: "defaultLocale", type: "string", description: "Default locale (defaults to the first locale)." }
-    ],
-    examples: [
-      { run: "shipeasy i18n profiles create en:prod" },
-      { note: "Multiple locales with a default", run: `shipeasy i18n profiles create fr:prod --locales '["fr","fr-CA"]' --default-locale fr` }
-    ],
-    run: (client, i) => {
-      const locales = i.locales ?? ["en"];
-      return client.i18n.createProfile({
-        name: i.name,
-        locales,
-        default_locale: str(i, "defaultLocale") ?? locales[0]
-      });
-    }
-  },
-  {
-    group: I18N,
-    name: "push",
-    mutates: true,
-    summary: "Add new i18n keys (insert-only)",
-    description: "Add NEW keys to a profile. Insert-only \u2014 existing keys are never overwritten (use `i18n update` to change a value). Keys are a JSON array of {key,value}.",
-    params: [
-      { name: "profile", type: "string", description: "Profile name (e.g. 'en:prod').", required: true },
-      { name: "keys", type: "json", description: `Keys as a JSON array, e.g. '[{"key":"home.cta","value":"Get started"}]'.`, required: true },
-      { name: "chunk", type: "string", description: "Logical grouping for the keys. Defaults to 'default'." }
-    ],
-    examples: [
-      { note: "Add keys to a profile", run: `shipeasy i18n push --profile en:prod --keys '[{"key":"home.cta","value":"Get started"}]'` }
-    ],
-    run: async (client, i) => {
-      const profile = await client.i18n.resolveProfile(i.profile);
-      return client.i18n.pushKeys({
-        profile_id: profile.id,
-        chunk: str(i, "chunk") ?? "default",
-        keys: i.keys
-      });
-    }
-  },
-  {
-    group: I18N,
-    name: "update",
-    mutates: true,
-    summary: "Update one i18n key's value",
-    description: "Change the value of a single existing key (the only overwrite path; `push` only adds). One key per call.",
-    params: [
-      { name: "key", type: "string", description: "Key name.", required: true, positional: true },
-      { name: "value", type: "string", description: "New value.", required: true, positional: true },
-      { name: "profile", type: "string", description: "Profile name (e.g. 'en:prod').", required: true },
-      { name: "description", type: "string", description: "Optional description to store with the key." }
-    ],
-    examples: [
-      { note: "Change one key's value", run: "shipeasy i18n update home.cta 'Get started' --profile en:prod" }
-    ],
-    run: async (client, i) => {
-      const profile = await client.i18n.resolveProfile(i.profile);
-      return client.i18n.updateKeyByName(profile.id, i.key, {
-        value: i.value,
-        ...i.description !== void 0 ? { description: i.description } : {}
-      });
-    }
-  },
-  {
-    group: I18N,
-    name: "publish",
-    mutates: true,
-    summary: "Publish a profile chunk to the CDN",
-    description: "Publish a profile chunk (rebuilds the KV manifest and purges the CDN).",
-    params: [
-      { name: "profile", type: "string", description: "Profile name (e.g. 'en:prod').", required: true },
-      { name: "chunk", type: "string", description: "Chunk to publish. Defaults to 'default'." }
-    ],
-    examples: [
-      { note: "Publish the default chunk", run: "shipeasy i18n publish --profile en:prod" },
-      { note: "Publish a specific chunk", run: "shipeasy i18n publish --profile fr:prod --chunk marketing" }
-    ],
-    run: async (client, i) => {
-      const profile = await client.i18n.resolveProfile(i.profile);
-      return client.i18n.publish(profile.id, { chunk: str(i, "chunk") ?? "default" });
-    }
-  },
-  {
-    group: DRAFTS,
-    name: "list",
-    mutates: false,
-    summary: "List staged i18n drafts",
-    description: "List staged translation drafts. Replaces the `drafts` kind of the deleted MCP generic read.",
-    params: [],
-    examples: [{ run: "shipeasy i18n drafts list" }],
-    run: (client) => client.i18n.listDrafts()
-  }
-];
-export {
-  i18nOperations
-};

package/dist/operations/index.d.ts

@@ -1,63 +0,0 @@
-import '../transport.js';
-import '../schemas/pagination.js';
-import '../resources/index.js';
-import '../resources/metrics.js';
-import '../resources/events.js';
-import '../resources/ops.js';
-import '../resources/projects.js';
-import '../resources/i18n.js';
-import '../resources/attributes.js';
-import '../resources/gates.js';
-import '../resources/killswitches.js';
-import '../resources/experiments.js';
-import '../resources/configs.js';
-import '../resources/universes.js';
-import '../resources/alert-rules.js';
-import { Operation } from './types.js';
-export { CliContext, CommandLike, McpTool, OpExample, OpInput, Param, ParamType, opCli, opId, opMcpName } from './types.js';
-export { coerceInput } from './coerce.js';
-export { mountOperations } from './cli-adapter.js';
-export { operationsToDispatch, operationsToMcpTools } from './mcp-adapter.js';
-export { renderOperationsMarkdown } from './docs.js';
-export { gateOperations } from './gates.js';
-export { killswitchOperations } from './killswitches.js';
-export { configOperations } from './configs.js';
-export { experimentOperations } from './experiments.js';
-export { universeOperations } from './universes.js';
-export { METRIC_GRAMMAR, metricOperations } from './metrics.js';
-export { eventOperations } from './events.js';
-export { opsOperations } from './ops.js';
-export { projectOperations } from './projects.js';
-export { i18nOperations } from './i18n.js';
-export { attributeOperations } from './attributes.js';
-export { docsOperations } from './sdk-docs.js';
-import '../schemas/gates.js';
-import '../schemas/universes.js';
-import 'zod';
-import 'zod/v4/core';
-import '../schemas/alert-rules.js';
-import '../schemas/killswitches.js';
-import '../schemas/configs.js';
-import '../schemas/experiments.js';
-
-/**
- * Operation registry + surface adapters.
- *
- * One declarative `Operation[]` per resource drives three surfaces:
- *   - CLI    — `mountOperations(group, ops, ctx)` builds commander subcommands.
- *   - MCP    — `operationsToMcpTools(ops)` + `operationsToDispatch(ops)`.
- *   - Docs   — `renderOperationsMarkdown(ops)`.
- *
- * The `release` module was the pilot; the registry now spans the whole
- * migratable surface (doc 21 §A2/§A3): metrics, events, ops (queue + alert
- * rules), projects, i18n (API parts), attributes, and SDK-docs. What stays
- * permanently hand-written in the fs-having consumers: i18n fs/AST ops, SDK key
- * minting, `detect_project`, and auth login/logout/bind.
- */
-
-/** The `release` module — feature flags, kill switches, configs, experiments, universes. */
-declare const RELEASE_OPERATIONS: Operation[];
-/** Every operation across every registry-driven module. Adapters iterate this. */
-declare const ALL_OPERATIONS: Operation[];
-
-export { ALL_OPERATIONS, Operation, RELEASE_OPERATIONS };