@bridge-ds/core 0.5.1 → 0.7.0

package/bridge.config.schema.json

@@ -664,6 +664,75 @@
           "description": "auto or on-demand."
         }
       }
+    },
+    "products": {
+      "type": "array",
+      "minItems": 1,
+      "description": "The apps that consume the design system. Bridge Studio groups branches by product, and the CLI and MCP server tell which product a folder or a repository is. A branch belongs to the product its pull request label names (product: <key>), else to the first product whose folder holds one of its changed files, else to the default product. Leave it out to keep the Admin demo and the Library.",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "key",
+          "name"
+        ],
+        "properties": {
+          "key": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9-]*$",
+            "description": "Stable id made of lowercase letters, digits and dashes. The pull request label product: <key> names it."
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The name people read, such as Admin demo."
+          },
+          "repo": {
+            "type": "string",
+            "pattern": "^[\\w.-]+/[\\w.-]+$",
+            "description": "owner/name when the product lives in another GitHub repository."
+          },
+          "path": {
+            "type": "string",
+            "pattern": "^(?!/)(?!(.*/)?\\.\\.(/|$)).+$",
+            "description": "Folder of this repository that holds the product, relative to the root, such as apps/admin. No leading slash and no '..'."
+          },
+          "preview": {
+            "type": "string",
+            "pattern": "^https?://",
+            "description": "Preview URL pattern, with the same placeholders as previews.apps: {branch}, {rawBranch}, {pr}, {sha} and {sha7}."
+          },
+          "framework": {
+            "type": "string",
+            "description": "The framework the product is built with: react, vue, angular, svelte, astro or other.",
+            "examples": [
+              "react",
+              "vue",
+              "angular",
+              "svelte",
+              "astro",
+              "other"
+            ]
+          },
+          "default": {
+            "type": "boolean",
+            "description": "The product a branch belongs to when nothing else matches: the library. At most one. Without one, the last product is the default."
+          }
+        }
+      },
+      "default": [
+        {
+          "key": "admin",
+          "name": "Admin demo",
+          "path": "apps/admin",
+          "framework": "react"
+        },
+        {
+          "key": "library",
+          "name": "Library",
+          "default": true
+        }
+      ]
     }
   }
 }

package/dist/branch-actions.d.ts

@@ -0,0 +1,70 @@
+import type { GitHubClient, Review } from './github-client';
+import { type MergeMethod, type MissingApproval } from './review-gate';
+/** Merges a branch at the head the person saw (GitHub refuses when it moved meanwhile). Studio's Merge button: squash. */
+export declare function mergeOnGitHub(gh: GitHubClient, input: {
+    number: number;
+    headSha: string;
+    method?: MergeMethod | undefined;
+}): Promise<{
+    sha: string;
+}>;
+/** Where an owner override stopped: GitHub refused the reason comment (nothing merged), or the merge itself. */
+export declare class OverrideMergeError extends Error {
+    readonly stage: 'comment' | 'merge';
+    readonly cause?: unknown | undefined;
+    readonly commentUrl?: string | undefined;
+    constructor(stage: 'comment' | 'merge', message: string, cause?: unknown | undefined, commentUrl?: string | undefined);
+}
+/**
+ * Merge as owner override: posts the reason on the branch first (the audit trail History reads back), then merges
+ * with the first merge method the repository allows. When GitHub refuses the merge, the comment is edited to say
+ * "Merge refused by GitHub ... Not merged", so the trail never claims a merge that did not happen. The caller checks
+ * the gate first (mergeGate: overridable) and the reason (overrideReasonProblem).
+ */
+export declare function overrideMergeOnGitHub(gh: GitHubClient, input: {
+    number: number;
+    headSha: string;
+    login: string;
+    reason: string;
+    missing: MissingApproval[];
+    method: MergeMethod;
+}): Promise<{
+    sha: string;
+    commentUrl: string;
+    comment: string;
+}>;
+export type ReviewEvent = 'APPROVE' | 'REQUEST_CHANGES' | 'COMMENT';
+/** Approve, request changes or comment, on the head the reviewer saw. Changes and comments need a text. */
+export declare function reviewOnGitHub(gh: GitHubClient, input: {
+    number: number;
+    event: ReviewEvent;
+    body?: string | undefined;
+    headSha?: string | undefined;
+}): Promise<Review>;
+/** A comment on the branch's conversation. */
+export declare function commentOnGitHub(gh: GitHubClient, n: number, body: string): Promise<{
+    id: number;
+    url: string;
+}>;
+/**
+ * "Ask someone else to review": requests the review from `others` (core reviewersToAsk) and takes the viewer off the
+ * requested reviewers when GitHub had them on it. Throws how to fix it when nobody else can.
+ */
+export declare function askOthersToReviewOnGitHub(gh: GitHubClient, input: {
+    number: number;
+    others: string[];
+    viewer?: string | null | undefined;
+    viewerRequested?: boolean | undefined;
+}): Promise<string[]>;
+/** Closes a branch without merging it. Its work stays on GitHub and it can be reopened. */
+export declare function closeOnGitHub(gh: GitHubClient, n: number): Promise<void>;
+/** Reopens a closed branch (GitHub refuses when its branch was deleted). */
+export declare function reopenOnGitHub(gh: GitHubClient, n: number): Promise<void>;
+/** Only the author or someone with write access to the repository adds to a branch. */
+export declare function canAddTo(p: {
+    user: {
+        login: string;
+    } | null;
+}, viewer: string | null | undefined, write: boolean): boolean;
+/** The comment posted on the branch, so reviewers see what was added and from where. */
+export declare function addedComment(paths: string[], viewer: string | null | undefined, from?: string): string;

package/dist/combine-branches.d.ts

@@ -0,0 +1,41 @@
+import type { GitHubClient } from './github-client';
+import { type ChangeEdits, type CombinePicks } from './token-combine';
+export declare const MIN_TOGETHER = 2;
+export declare const MAX_TOGETHER = 4;
+/**
+ * Whether a change only edits tokens: token files under the tokens root, the contrast gate and release notes
+ * (changesets). Anything else is code. No file read yet (or none) is not a token change.
+ */
+export declare function onlyTokens(files: string[], tokensRoot: string): boolean;
+/** Token files a change edits, relative to the tokens root. */
+export declare function tokenFilesOf(files: string[], tokensRoot: string): string[];
+/** A list of changes in an address: "101,118,120" (commas stay readable). */
+export declare const changeList: (numbers: number[]) => string;
+/**
+ * The admin demo with the Bridge toolbar on the combination: production (no preview holds all of them), the tokens
+ * applied live. `bridge-use` carries the picks.
+ */
+export declare function tryTogetherUrl(admin: string, numbers: number[], picks: CombinePicks): string;
+/** GitHub lists at most 300 files per compare: past that, a branch cannot be read whole, so it is not combined. */
+export declare const COMBINE_COMPARE_LIMIT = 300;
+export interface CombineBranch {
+    number: number;
+    title: string;
+    /** Only token files (and release notes): it can be combined. */
+    tokens: boolean;
+    /** Its own token edits; null for a code change. */
+    edits: ChangeEdits | null;
+}
+/**
+ * One branch as the combination needs it: one compare against the default branch (the files it edits since it
+ * started, and where it started), then its token files at its start and now. Without a token the client reads the
+ * public raw host, so visitors spend no API read on file contents.
+ */
+export declare function readCombineBranch(gh: GitHubClient, pull: {
+    number: number;
+    title: string;
+    headSha: string;
+}, opts: {
+    base: string;
+    tokensRoot: string;
+}): Promise<CombineBranch>;