@usefidel/contracts 0.4.0 → 0.6.0

package/dist/onboarding-config.d.ts

@@ -63,3 +63,39 @@ export declare function nameFromUrl(url: string): string;
  * output the user copies, so it is fixed, not incidental.
  */
 export declare function buildDsConfigJson(existingRaw: Record<string, unknown> | null, dsSelections: DsSelection[]): string;
+/**
+ * The GitHub Actions workflow `fidel init` writes to `.github/workflows/`.
+ *
+ * Here for the same reason as the builders above: the onboarding UI shows this
+ * text for a user to copy, and `fidel init` writes it. If the two disagree, a
+ * user commits a workflow that does not match the one we told them to use.
+ *
+ * A plain constant rather than a builder because init writes it identically on
+ * both branches — the Figma and design-system flows share one workflow.
+ *
+ * The trailing newline is intentional and asserted; the file ends with one.
+ */
+export declare const WORKFLOW_YAML = "name: Design Validation\non:\n  pull_request:\n    types: [opened, synchronize]\n\npermissions:\n  contents: read\n  pull-requests: write\n  id-token: write\n\njobs:\n  fidel:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - uses: usefidel/fidel-action@v1\n";
+/** One frame chosen in `fidel init`'s Figma picker. */
+export interface Selection {
+    nodeId: string;
+    name: string;
+    page: string;
+    width: number;
+    height: number;
+    url: string;
+}
+/**
+ * Figma branch: write `checks[]`.
+ *
+ * `viewport` is emitted ONLY when the frame is not 1440x900, and only when the
+ * dimensions are real positive integers — a Selection missing width/height makes
+ * Math.round() return NaN, which serializes to null, and
+ * `viewport: {width: null, height: null}` is rejected outright by the
+ * marketplace Action's own validator. The CLI must never write a config our own
+ * Action refuses to load.
+ *
+ * Already-serialized checks from an existing fidel.config.json arrive on a
+ * re-run carrying `figma`/`url` and no `nodeId`; they pass straight through.
+ */
+export declare function buildConfigJson(selections: Selection[], fileKey: string): string;

package/dist/onboarding-config.js

@@ -82,3 +82,81 @@ export function buildDsConfigJson(existingRaw, dsSelections) {
     out.designSystemChecks = merged;
     return JSON.stringify(out, null, 2) + "\n";
 }
+/**
+ * The GitHub Actions workflow `fidel init` writes to `.github/workflows/`.
+ *
+ * Here for the same reason as the builders above: the onboarding UI shows this
+ * text for a user to copy, and `fidel init` writes it. If the two disagree, a
+ * user commits a workflow that does not match the one we told them to use.
+ *
+ * A plain constant rather than a builder because init writes it identically on
+ * both branches — the Figma and design-system flows share one workflow.
+ *
+ * The trailing newline is intentional and asserted; the file ends with one.
+ */
+export const WORKFLOW_YAML = `name: Design Validation
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+permissions:
+  contents: read
+  pull-requests: write
+  id-token: write
+
+jobs:
+  fidel:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: usefidel/fidel-action@v1
+`;
+/** `https://www.figma.com/design/<key>/?node-id=<a-b>` — Figma wants dashes, not colons. */
+function buildFigmaFrameUrl(fileKey, nodeId) {
+    const dashNodeId = nodeId.replace(/:/g, '-');
+    return `https://www.figma.com/design/${fileKey}/?node-id=${dashNodeId}`;
+}
+/**
+ * Figma branch: write `checks[]`.
+ *
+ * `viewport` is emitted ONLY when the frame is not 1440x900, and only when the
+ * dimensions are real positive integers — a Selection missing width/height makes
+ * Math.round() return NaN, which serializes to null, and
+ * `viewport: {width: null, height: null}` is rejected outright by the
+ * marketplace Action's own validator. The CLI must never write a config our own
+ * Action refuses to load.
+ *
+ * Already-serialized checks from an existing fidel.config.json arrive on a
+ * re-run carrying `figma`/`url` and no `nodeId`; they pass straight through.
+ */
+export function buildConfigJson(selections, fileKey) {
+    const checks = selections.map((s) => {
+        // Already-serialized checks from an existing fidel.config.json come through
+        // here on a re-run: they carry `figma`/`url` and have NO `nodeId`. Passing
+        // them to buildFigmaFrameUrl() would throw on `nodeId.replace`. Pass them
+        // straight through — they're already in output shape.
+        if (s.nodeId === undefined && s.figma !== undefined) {
+            return s;
+        }
+        const check = {
+            name: s.name,
+            figma: buildFigmaFrameUrl(fileKey, s.nodeId),
+            url: s.url,
+        };
+        // A Selection missing width/height makes Math.round() return NaN, which
+        // serializes to `null` — and `viewport: { width: null, height: null }` is
+        // rejected outright by the marketplace Action's own validator
+        // (config.ts requirePositiveInteger → "must be a positive integer").
+        // Our CLI must never write a config our Action refuses to load. When the
+        // dimensions aren't real positive integers, omit `viewport` entirely: an
+        // absent viewport means the 1440x900 default, which is the right fallback.
+        const w = Math.round(s.width);
+        const h = Math.round(s.height);
+        const hasRealDimensions = Number.isInteger(w) && w > 0 && Number.isInteger(h) && h > 0;
+        if (hasRealDimensions && (w !== 1440 || h !== 900)) {
+            check.viewport = { width: w, height: h };
+        }
+        return check;
+    });
+    return JSON.stringify({ checks }, null, 2) + '\n';
+}

package/package.json

@@ -7,7 +7,7 @@
     "The source of truth still lives in the monorepo at packages/contracts/."
   ],
   "name": "@usefidel/contracts",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Shared, code-free contracts between Fidel surfaces. Run-error taxonomy, theme-intake wire types, and the canonical fidel.config.json builders.",
   "license": "UNLICENSED",
   "private": false,