@bridge-ds/core 0.11.0 → 0.12.0

package/dist/storybook.d.ts

@@ -0,0 +1,94 @@
+/** One index entry, normalised across versions. */
+export interface StorybookEntry {
+    id: string;
+    /** Sidebar path, `/`-separated ("Forms/Button"). */
+    title: string;
+    /** Story or docs page name ("Primary", "Docs"). */
+    name: string;
+    type: 'story' | 'docs';
+    /** Storybook 9+ marks test entries `test`; stories are `story`. Absent before. */
+    subtype?: string;
+    importPath: string;
+    tags: string[];
+    exportName?: string;
+    componentPath?: string;
+}
+/** Entries that share a title: one component (or one docs-only page such as "Intro"). */
+export interface StorybookComponent {
+    title: string;
+    /** Last segment of the title ("Button" for "Forms/Button"). */
+    name: string;
+    /** Segments before the name (["Forms"]); empty at the root. */
+    group: string[];
+    /** Story entries in index order (test entries excluded). */
+    stories: StorybookEntry[];
+    docs: StorybookEntry[];
+    /** Union of the entries' tags, sorted. */
+    tags: string[];
+}
+export type StorybookIndexSource = 'index.json' | 'stories.json';
+export interface StorybookIndex {
+    /** The index's `v` field. */
+    version: number;
+    source: StorybookIndexSource;
+    entries: StorybookEntry[];
+    /** Grouped by title, sorted by title. */
+    components: StorybookComponent[];
+}
+export type StorybookErrorCode = 'invalid-url' | 'not-found' | 'not-json' | 'private' | 'empty' | 'http' | 'network';
+export declare class StorybookIndexError extends Error {
+    readonly code: StorybookErrorCode;
+    readonly status?: number | undefined;
+    constructor(code: StorybookErrorCode, message: string, status?: number | undefined);
+}
+/** Groups entries by title. Test entries (subtype `test`) stay out of `stories`. */
+export declare function groupStorybookComponents(entries: StorybookEntry[]): StorybookComponent[];
+/**
+ * Parses an `index.json` (v4, v5) or `stories.json` (v3) body. Throws StorybookIndexError: `private` for a
+ * Chromatic login answer, `empty` when the body has no readable entries.
+ */
+export declare function parseStorybookIndex(json: unknown, source?: StorybookIndexSource): StorybookIndex;
+/**
+ * The base address of a Storybook from what a person pastes: trims, drops the query and hash
+ * (`?path=/story/...`), a trailing `index.html` / `iframe.html` / `index.json` / `stories.json`, and trailing slashes.
+ * Throws `invalid-url` unless it is http(s); https is required except on localhost.
+ */
+export declare function normalizeStorybookUrl(input: string): string;
+/** The index files to try, in order. */
+export declare const storybookIndexUrls: (base: string) => {
+    url: string;
+    source: StorybookIndexSource;
+}[];
+export interface StorybookIframeOptions {
+    /** `story` (default) or `docs`. */
+    viewMode?: 'story' | 'docs';
+    /** Toolbar globals (`globals=brand:ocean;theme:dark`), in insertion order. */
+    globals?: Record<string, string>;
+    /** Story args (`args=label:Save`). */
+    args?: Record<string, string>;
+}
+/** URL of one story (or docs page) rendered alone: `<base>/iframe.html?id=<id>&viewMode=story[&globals=..][&args=..]`. */
+export declare function storybookIframeUrl(base: string, id: string, o?: StorybookIframeOptions): string;
+/** URL of a story or docs page in the full Storybook UI (sidebar and toolbar). */
+export declare function storybookManagerUrl(base: string, id: string, viewMode?: 'story' | 'docs'): string;
+export type StorybookFetch = (url: string, init?: {
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+}) => Promise<{
+    ok: boolean;
+    status: number;
+    headers: {
+        get(name: string): string | null;
+    };
+    text(): Promise<string>;
+}>;
+export interface FetchStorybookIndexOptions {
+    fetch?: StorybookFetch;
+    signal?: AbortSignal;
+}
+/**
+ * Reads a Storybook's index: `index.json`, then `stories.json`. A 404, an HTML answer (static hosts that fall back
+ * to index.html) or a body without entries moves on to the next file; the first readable index wins. Throws
+ * StorybookIndexError with the most telling failure (`private` before `not-json` before `not-found`).
+ */
+export declare function fetchStorybookIndex(base: string, o?: FetchStorybookIndexOptions): Promise<StorybookIndex>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bridge-ds/core",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "type": "module",
   "description": "Bridge core: bridge.config.json, DTCG token loading (tiers and layered modes), alias resolution, WCAG contrast, diffs, minimal-diff edits, PR body, the shared risk tier classifier, changesets and a fetch-based GitHub client. No Figma API, no DOM; Node-only helpers (git, reading a product folder) under @bridge-ds/core/node; the adoption audit under @bridge-ds/core/audit.",
   "license": "MIT",