@eide/foir-cli 0.21.1 → 0.22.0

package/dist/cli.js

@@ -2,7 +2,7 @@
 
 // src/cli.ts
 import { config } from "dotenv";
-import { resolve as resolve6, dirname as dirname4 } from "path";
+import { resolve as resolve7, dirname as dirname4 } from "path";
 import { fileURLToPath } from "url";
 import { createRequire } from "module";
 import { Command } from "commander";
@@ -303,13 +303,13 @@ function withErrorHandler(optsFn, fn) {
 // src/commands/login.ts
 async function findAvailablePort(start, end) {
   for (let port = start; port <= end; port++) {
-    const available = await new Promise((resolve7) => {
+    const available = await new Promise((resolve8) => {
       const server = http.createServer();
       server.listen(port, () => {
         server.close();
-        resolve7(true);
+        resolve8(true);
       });
-      server.on("error", () => resolve7(false));
+      server.on("error", () => resolve8(false));
     });
     if (available) return port;
   }
@@ -347,7 +347,7 @@ async function loginAction(globalOpts) {
   const state = crypto.randomBytes(16).toString("hex");
   const port = await findAvailablePort(9876, 9900);
   const redirectUri = `http://localhost:${port}/callback`;
-  const authCode = await new Promise((resolve7, reject) => {
+  const authCode = await new Promise((resolve8, reject) => {
     let timeoutId;
     const server = http.createServer((req, res) => {
       const url = new URL(req.url, `http://localhost:${port}`);
@@ -386,7 +386,7 @@ async function loginAction(globalOpts) {
         );
         server.closeAllConnections();
         server.close();
-        resolve7(code);
+        resolve8(code);
       }
     });
     server.listen(port);
@@ -2131,6 +2131,11 @@ import {
   UpdateLocaleRequestSchema,
   DeleteLocaleRequestSchema,
   DeleteSettingRequestSchema,
+  GetDesignTokensRequestSchema,
+  UpdateDesignTokensRequestSchema,
+  PublishDesignTokensRequestSchema,
+  UnpublishDesignTokensRequestSchema,
+  GetDesignTokensPublishStatusRequestSchema,
   GetNavPreferencesRequestSchema,
   UpdateNavPreferencesRequestSchema,
   ListRecentlyOpenedRequestSchema,
@@ -2317,6 +2322,39 @@ function createSettingsMethods(client) {
       );
       return resp.profileSchema ?? null;
     },
+    // ── Design Tokens ─────────────────────────────────────────
+    async getDesignTokens(params = {}) {
+      const resp = await client.getDesignTokens(
+        create7(GetDesignTokensRequestSchema, {
+          channel: params.channel === "draft" ? 2 : 1
+        })
+      );
+      return resp.tokens ?? null;
+    },
+    async updateDesignTokens(document) {
+      const resp = await client.updateDesignTokens(
+        create7(UpdateDesignTokensRequestSchema, { document })
+      );
+      return resp.tokens ?? null;
+    },
+    async publishDesignTokens() {
+      const resp = await client.publishDesignTokens(
+        create7(PublishDesignTokensRequestSchema, {})
+      );
+      return resp;
+    },
+    async unpublishDesignTokens() {
+      const resp = await client.unpublishDesignTokens(
+        create7(UnpublishDesignTokensRequestSchema, {})
+      );
+      return resp.tokens ?? null;
+    },
+    async getDesignTokensPublishStatus() {
+      const resp = await client.getDesignTokensPublishStatus(
+        create7(GetDesignTokensPublishStatusRequestSchema, {})
+      );
+      return resp.status ?? null;
+    },
     async getCustomerResolutionAttributes(customerId) {
       return client.getCustomerResolutionAttributes(
         create7(GetCustomerResolutionAttributesRequestSchema, { customerId })
@@ -4841,6 +4879,8 @@ async function reconcileConfig(client, configId, manifest, options = {}) {
     authProviders: zeroCounts(),
     placementsUpdated: false,
     profileSchemaUpdated: false,
+    designTokensUpdated: false,
+    designTokensPublished: false,
     apiKeys: [],
     apps: zeroCounts(),
     updatedModelIds: [],
@@ -4858,6 +4898,7 @@ async function reconcileConfig(client, configId, manifest, options = {}) {
   await reconcileAuthProviders(client, manifest.authProviders ?? [], summary);
   await reconcilePlacements(client, configId, manifest.placements ?? [], summary);
   await reconcileProfileSchema(client, manifest, summary);
+  await reconcileDesignTokens(client, manifest, summary, options.publishDesignTokens ?? false);
   await reconcileApiKeys(
     client,
     manifest.key,
@@ -5270,6 +5311,18 @@ async function reconcileProfileSchema(client, manifest, summary) {
   });
   summary.profileSchemaUpdated = true;
 }
+async function reconcileDesignTokens(client, manifest, summary, publishAfterApply) {
+  const tokens = manifest.designTokens;
+  if (!tokens) return;
+  await client.settings.updateDesignTokens(
+    tokens
+  );
+  summary.designTokensUpdated = true;
+  if (publishAfterApply) {
+    await client.settings.publishDesignTokens();
+    summary.designTokensPublished = true;
+  }
+}
 async function reconcileApiKeys(client, configKey, apiKeys, summary, rotateKeys) {
   if (apiKeys.length === 0) return;
   const existing = await client.identity.listApiKeys({ limit: 200 });
@@ -5553,6 +5606,10 @@ function printSummary(summary) {
   if (summary.profileSchemaUpdated) {
     lines.push("  Profile:      schema updated");
   }
+  if (summary.designTokensUpdated) {
+    const detail = summary.designTokensPublished ? "applied & published" : "applied (draft)";
+    lines.push(`  Design tokens: ${detail}`);
+  }
   if (lines.length > 0) {
     for (const line of lines) {
       console.log(line);
@@ -5572,6 +5629,10 @@ function registerPushCommand(program2, globalOpts) {
     "--publish",
     "Promote updated models, operations, auth providers, and profile schema to the published channel after the push. New resources auto-publish; this flag covers updates, which are otherwise left as drafts.",
     false
+  ).option(
+    "--publish-tokens",
+    "Promote applied design tokens to the published channel after the push. Without this flag, tokens land on the draft channel and the storefront keeps serving the last published snapshot.",
+    false
   ).option("--env <path>", "Path to .env file (default: .env)").action(
     withErrorHandler(
       globalOpts,
@@ -5631,7 +5692,8 @@ function registerPushCommand(program2, globalOpts) {
             rotateKeys: opts.rotateKeys ?? false,
             tenantId: resolved?.project.tenantId,
             projectId: resolved?.project.id,
-            force: opts.force ?? false
+            force: opts.force ?? false,
+            publishDesignTokens: opts.publishTokens ?? false
           });
         } catch (e) {
           if (e instanceof PushConflictError) {
@@ -5860,6 +5922,17 @@ function registerPullCommand(program2, globalOpts) {
         }
         const configDataNoInteg = { ...configData };
         delete configDataNoInteg.apps;
+        let designTokens;
+        try {
+          const dt = await client.settings.getDesignTokens({
+            channel: "draft"
+          });
+          const doc = dt?.document;
+          if (doc && Object.keys(doc).length > 0) {
+            designTokens = doc;
+          }
+        } catch {
+        }
         const configDataNoProject = { ...configDataNoInteg };
         delete configDataNoProject.project;
         const manifest = {
@@ -5871,7 +5944,8 @@ function registerPullCommand(program2, globalOpts) {
           ...config2.connectionDomain ? { operationBaseUrl: config2.connectionDomain } : {},
           ...projectBlock ? { project: projectBlock } : {},
           ...configDataNoProject,
-          ...apps ? { apps } : {}
+          ...apps ? { apps } : {},
+          ...designTokens ? { designTokens } : {}
         };
         delete manifest.force;
         const jsonContent = JSON.stringify(manifest, null, 2);
@@ -5951,6 +6025,7 @@ export default defineConfig(${jsonContent});
         if (schedules.length > 0) parts.push(`${schedules.length} schedule(s)`);
         if (authProviders.length > 0) parts.push(`${authProviders.length} auth provider(s)`);
         if (configData.customerProfileSchema) parts.push("customer profile schema");
+        if (designTokens) parts.push("design tokens");
         if (apps) {
           parts.push(`${Object.keys(apps).length} app(s)`);
         }
@@ -7815,6 +7890,112 @@ function registerSettingsCommands(program2, globalOpts) {
   );
 }
 
+// src/commands/design-tokens.ts
+import { existsSync as existsSync6, readFileSync as readFileSync2 } from "fs";
+import { resolve as resolve6 } from "path";
+import chalk12 from "chalk";
+function registerDesignTokensCommands(program2, globalOpts) {
+  const tokens = program2.command("design-tokens").description("Manage project design tokens (W3C-formatted)");
+  tokens.command("get").description("Print the current design tokens document").option("--channel <channel>", "draft | published", "draft").option(
+    "--resolved",
+    "Print the server-resolved view instead of the raw document"
+  ).action(
+    withErrorHandler(globalOpts, async (cmdOpts) => {
+      const opts = globalOpts();
+      const client = await createPlatformClient(opts);
+      const channel = cmdOpts.channel === "published" ? "published" : "draft";
+      const result = await client.settings.getDesignTokens({ channel });
+      if (!result) {
+        console.log("{}");
+        return;
+      }
+      if (cmdOpts.resolved) {
+        console.log(JSON.stringify(result.resolved ?? {}, null, 2));
+        return;
+      }
+      const doc = result.document ?? {};
+      console.log(JSON.stringify(doc, null, 2));
+    })
+  );
+  tokens.command("apply <path>").description("Apply a W3C-formatted JSON design tokens document").option("--publish", "Also publish after applying").action(
+    withErrorHandler(
+      globalOpts,
+      async (path3, cmdOpts) => {
+        const opts = globalOpts();
+        const client = await createPlatformClient(opts);
+        const abs = resolve6(process.cwd(), path3);
+        if (!existsSync6(abs)) {
+          throw new Error(`File not found: ${abs}`);
+        }
+        let parsed;
+        try {
+          parsed = JSON.parse(readFileSync2(abs, "utf-8"));
+        } catch (err) {
+          throw new Error(
+            `Invalid JSON in ${abs}: ${err instanceof Error ? err.message : String(err)}`
+          );
+        }
+        await client.settings.updateDesignTokens(parsed);
+        success(`Design tokens applied (draft) from ${path3}`);
+        if (cmdOpts.publish) {
+          const resp = await client.settings.publishDesignTokens();
+          success("Design tokens published");
+          if (resp.breakingChanges && resp.breakingChanges.length > 0) {
+            console.log(chalk12.yellow("\nBreaking changes:"));
+            for (const c of resp.breakingChanges) {
+              console.log(`  ${c.severity} ${c.path}: ${c.description}`);
+            }
+          }
+        }
+      }
+    )
+  );
+  tokens.command("publish").description("Promote the draft tokens to the published channel").action(
+    withErrorHandler(globalOpts, async () => {
+      const opts = globalOpts();
+      const client = await createPlatformClient(opts);
+      const resp = await client.settings.publishDesignTokens();
+      success("Design tokens published");
+      if (resp.breakingChanges && resp.breakingChanges.length > 0) {
+        console.log(chalk12.yellow("\nBreaking changes:"));
+        for (const c of resp.breakingChanges) {
+          console.log(`  ${c.severity} ${c.path}: ${c.description}`);
+        }
+      }
+    })
+  );
+  tokens.command("unpublish").description("Remove the published tokens snapshot").action(
+    withErrorHandler(globalOpts, async () => {
+      const opts = globalOpts();
+      const client = await createPlatformClient(opts);
+      await client.settings.unpublishDesignTokens();
+      success("Design tokens unpublished");
+    })
+  );
+  tokens.command("status").description("Show draft / published version status").action(
+    withErrorHandler(globalOpts, async () => {
+      const opts = globalOpts();
+      const client = await createPlatformClient(opts);
+      const status = await client.settings.getDesignTokensPublishStatus();
+      if (!status) {
+        console.log("No design tokens yet.");
+        return;
+      }
+      if (status.hasPendingChanges) {
+        console.log(chalk12.yellow("\u25CF Pending changes"));
+      } else {
+        console.log(chalk12.green("\u25CF Up to date"));
+      }
+      if (status.breakingChanges && status.breakingChanges.length > 0) {
+        console.log(chalk12.yellow("\nPending changes:"));
+        for (const c of status.breakingChanges) {
+          console.log(`  ${c.severity} ${c.path}: ${c.description}`);
+        }
+      }
+    })
+  );
+}
+
 // src/commands/variant-catalog.ts
 import { VariantCatalogEntrySchema } from "@eide/foir-proto-ts/settings/v1/settings_pb";
 function registerVariantCatalogCommands(program2, globalOpts) {
@@ -8537,7 +8718,7 @@ function classToLabel(n) {
 }
 
 // src/commands/secrets.ts
-import { existsSync as existsSync6 } from "fs";
+import { existsSync as existsSync7 } from "fs";
 import { promises as fs5 } from "fs";
 import { resolve as resolvePath } from "path";
 function registerSecretsCommands(program2, globalOpts) {
@@ -8837,14 +9018,14 @@ var PLAINTEXT_CONFIG_NAMES = [
 ];
 async function resolveSecretsConfigPath(explicit) {
   if (explicit) {
-    if (!existsSync6(explicit)) {
+    if (!existsSync7(explicit)) {
       throw new Error(`Secrets config not found: ${explicit}`);
     }
     return resolvePath(explicit);
   }
   for (const name of SECRETS_CONFIG_NAMES) {
     const path3 = resolvePath(process.cwd(), name);
-    if (existsSync6(path3)) return path3;
+    if (existsSync7(path3)) return path3;
   }
   throw new Error(
     `No secrets config found. Looked for: ${SECRETS_CONFIG_NAMES.join(", ")}.`
@@ -8852,14 +9033,14 @@ async function resolveSecretsConfigPath(explicit) {
 }
 async function resolvePlaintextPath(explicit) {
   if (explicit) {
-    if (!existsSync6(explicit)) {
+    if (!existsSync7(explicit)) {
       throw new Error(`Plaintext file not found: ${explicit}`);
     }
     return resolvePath(explicit);
   }
   for (const name of PLAINTEXT_CONFIG_NAMES) {
     const path3 = resolvePath(process.cwd(), name);
-    if (existsSync6(path3)) return path3;
+    if (existsSync7(path3)) return path3;
   }
   return null;
 }
@@ -8942,7 +9123,7 @@ function formatPushPlan(plan, opts) {
 // src/cli.ts
 var __filename = fileURLToPath(import.meta.url);
 var __dirname = dirname4(__filename);
-config({ path: resolve6(__dirname, "../.env.local") });
+config({ path: resolve7(__dirname, "../.env.local") });
 var require2 = createRequire(import.meta.url);
 var { version } = require2("../package.json");
 var program = new Command();
@@ -8981,6 +9162,7 @@ registerApiKeysCommands(program, getGlobalOpts);
 registerAuthProvidersCommands(program, getGlobalOpts);
 registerLocalesCommands(program, getGlobalOpts);
 registerSettingsCommands(program, getGlobalOpts);
+registerDesignTokensCommands(program, getGlobalOpts);
 registerVariantCatalogCommands(program, getGlobalOpts);
 registerFilesCommands(program, getGlobalOpts);
 registerNotesCommands(program, getGlobalOpts);

package/dist/lib/config-helpers.d.ts

@@ -338,6 +338,27 @@ interface ApplyConfigProjectInput {
      */
     settings?: ApplyConfigProjectSettingsInput;
 }
+/**
+ * W3C Design Tokens Format Module document. The CLI applies this
+ * verbatim — references like "{font.size.display1}" are preserved on
+ * disk so renames in one place propagate to consumers. The platform's
+ * resolver runs at write time and rejects cycles or unknown references.
+ *
+ * See foir-docs/content/platform/design-tokens.md for the full shape.
+ */
+interface ApplyConfigDesignTokensInput {
+    color?: Record<string, unknown>;
+    font?: {
+        family?: Record<string, unknown>;
+        weight?: Record<string, unknown>;
+        size?: Record<string, unknown>;
+        lineHeight?: Record<string, unknown>;
+        letterSpacing?: Record<string, unknown>;
+    };
+    typography?: Record<string, unknown>;
+    /** Escape hatch for forward-compatible W3C groups (`spacing`, `border`, …). */
+    [key: string]: unknown;
+}
 interface ApplyConfigInput {
     key: string;
     name: string;
@@ -361,6 +382,12 @@ interface ApplyConfigInput {
     apiKeys?: ApplyConfigApiKeyInput[];
     /** Per-project app declarations, keyed by app name. */
     apps?: Record<string, AppInput>;
+    /**
+     * W3C-formatted design tokens document for this project. Reconciled by
+     * `foir push` — the document is applied verbatim to the draft channel.
+     * Add `--publish-tokens` to promote draft → published in the same push.
+     */
+    designTokens?: ApplyConfigDesignTokensInput;
     [key: string]: unknown;
 }
 /** Define a complete config manifest. */
@@ -371,6 +398,13 @@ declare function defineModel(model: ApplyConfigModelInput): ApplyConfigModelInpu
 declare function defineField(field: FieldDefinitionInput): FieldDefinitionInput;
 /** Define a select field — requires `optionModelKey` pointing to a model whose records become options. */
 declare function defineSelectField(field: SelectFieldDefinitionInput): FieldDefinitionInput;
+/**
+ * Define a W3C design tokens document. Pure pass-through that gives
+ * IntelliSense for the supported groups (`color`, `font.*`,
+ * `typography`); the type permits arbitrary additional groups for
+ * forward compatibility.
+ */
+declare function defineDesignTokens(tokens: ApplyConfigDesignTokensInput): ApplyConfigDesignTokensInput;
 /** Define an enum field — config-only choice from inline `{label, value}` options. */
 declare function defineEnumField(field: EnumFieldDefinitionInput): FieldDefinitionInput;
 /** Define an operation with type safety. */
@@ -419,4 +453,4 @@ interface FoirSecretsConfig {
  */
 declare function defineSecrets(config: FoirSecretsConfig): FoirSecretsConfig;
 
-export { type AppInput, type AppPlacementFieldChoiceInput, type AppSinkMappingInput, type AppSourceMappingInput, type ApplyConfigApiKeyInput, type ApplyConfigAuthProviderInput, type ApplyConfigHookInput, type ApplyConfigInput, type ApplyConfigModelInput, type ApplyConfigOperationInput, type ApplyConfigPlacementInput, type ApplyConfigProjectInput, type ApplyConfigProjectSettingsInput, type ApplyConfigScheduleInput, type ApplyConfigSegmentInput, type EnumFieldConfig, type EnumFieldDefinitionInput, type EnumFieldOption, type ExpressionPrecondition, type FieldDefinitionInput, type FoirSecretsConfig, type Precondition, type QuotaRule, type SecretDeclaration, type SecretOwnerKind, type SegmentPrecondition, type SelectFieldConfig, type SelectFieldDefinitionInput, defineAuthProvider, defineConfig, defineEnumField, defineField, defineHook, defineModel, defineOperation, definePlacement, defineSchedule, defineSecrets, defineSegment, defineSelectField };
+export { type AppInput, type AppPlacementFieldChoiceInput, type AppSinkMappingInput, type AppSourceMappingInput, type ApplyConfigApiKeyInput, type ApplyConfigAuthProviderInput, type ApplyConfigDesignTokensInput, type ApplyConfigHookInput, type ApplyConfigInput, type ApplyConfigModelInput, type ApplyConfigOperationInput, type ApplyConfigPlacementInput, type ApplyConfigProjectInput, type ApplyConfigProjectSettingsInput, type ApplyConfigScheduleInput, type ApplyConfigSegmentInput, type EnumFieldConfig, type EnumFieldDefinitionInput, type EnumFieldOption, type ExpressionPrecondition, type FieldDefinitionInput, type FoirSecretsConfig, type Precondition, type QuotaRule, type SecretDeclaration, type SecretOwnerKind, type SegmentPrecondition, type SelectFieldConfig, type SelectFieldDefinitionInput, defineAuthProvider, defineConfig, defineDesignTokens, defineEnumField, defineField, defineHook, defineModel, defineOperation, definePlacement, defineSchedule, defineSecrets, defineSegment, defineSelectField };

package/dist/lib/config-helpers.js

@@ -11,6 +11,9 @@ function defineField(field) {
 function defineSelectField(field) {
   return field;
 }
+function defineDesignTokens(tokens) {
+  return tokens;
+}
 function defineEnumField(field) {
   return field;
 }
@@ -38,6 +41,7 @@ function defineSecrets(config) {
 export {
   defineAuthProvider,
   defineConfig,
+  defineDesignTokens,
   defineEnumField,
   defineField,
   defineHook,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eide/foir-cli",
-  "version": "0.21.1",
+  "version": "0.22.0",
   "description": "Universal platform CLI for Foir platform",
   "type": "module",
   "publishConfig": {
@@ -50,7 +50,7 @@
     "@bufbuild/protovalidate": "^1.1.1",
     "@connectrpc/connect": "^2.0.0",
     "@connectrpc/connect-node": "^2.0.0",
-    "@eide/foir-proto-ts": "^0.55.0",
+    "@eide/foir-proto-ts": "^0.59.0",
     "chalk": "^5.3.0",
     "commander": "^12.1.0",
     "dotenv": "^16.4.5",