@shipeasy/openapi 1.5.0 → 1.6.0

package/dist/operations/i18n.js

@@ -0,0 +1,121 @@
+// 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

@@ -0,0 +1,63 @@
+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 };