mockpit 3.0.0 → 3.1.0

package/dist/server/system.d.ts

@@ -0,0 +1,234 @@
+import { CHROME_TOKENS } from "./themes.ts";
+import type { AnswerStanding, Ask, AskAnswer, DesignFiles, IconSetRef, Knobs, KnobValue, ProjectKit } from "./types.ts";
+export declare const CURRENT_CONTRACT = 2;
+export declare const SYSTEM_LIMITS: {
+    readonly sheet: 128000;
+    readonly tokens: 400;
+    readonly palettes: 40;
+    readonly roles: 120;
+    readonly pairs: 200;
+    readonly revisions: 30;
+    readonly classes: 200;
+    readonly fonts: 12;
+    readonly scales: 12;
+    readonly steps: 16;
+    readonly note: 300;
+    readonly summary: 400;
+};
+export type ChromeRole = (typeof CHROME_TOKENS)[number];
+export interface SystemClass {
+    name: string;
+    note: string;
+}
+export interface SystemFont {
+    family: string;
+    href?: string;
+}
+export declare const TOKEN_TYPES: readonly ["color", "dimension", "font", "weight", "number", "shadow", "duration", "easing", "text"];
+export type TokenType = (typeof TOKEN_TYPES)[number];
+export declare const TEXT_FIELDS: readonly ["font", "size", "line", "weight", "tracking"];
+export interface Token {
+    name: string;
+    type: TokenType;
+    value: string | Record<string, string>;
+    note?: string;
+    scale?: string;
+    owner?: "repo";
+}
+export interface Scale {
+    id: string;
+    family: "type" | "space";
+    prefix: string;
+    steps: string[];
+    zero: string;
+    base: number;
+    ratio: number;
+    fluid?: {
+        minWidth: number;
+        maxWidth: number;
+        maxBase: number;
+        maxRatio: number;
+    };
+}
+export interface Role {
+    name: string;
+    note: string;
+    owner?: "repo";
+}
+export type PaletteStatus = "default" | "kept" | "open" | "hidden";
+export declare const PALETTE_STATUSES: readonly PaletteStatus[];
+export interface Palette {
+    id: string;
+    label: string;
+    note: string;
+    light: Record<string, string>;
+    dark: Record<string, string>;
+    scheme?: {
+        light: "light" | "dark";
+        dark: "light" | "dark";
+    };
+    status: PaletteStatus;
+    owner?: "repo";
+}
+export interface SystemAddition {
+    knob: string;
+    value: string;
+    rev: number;
+    style: string;
+}
+export interface RepoRead {
+    detected: {
+        tailwind: boolean;
+        shadcn: boolean;
+        cssVars: number;
+        fonts: string[];
+    } | null;
+    cssVars: string;
+    tailwindCss: string;
+    strippedImports: string[];
+    designFiles: DesignFiles | null;
+    untyped?: string[];
+}
+export interface System {
+    project: string;
+    rev: number;
+    updatedAt: string;
+    sheet: {
+        css: string;
+        classes: SystemClass[];
+    } | null;
+    fonts: SystemFont[];
+    tokens: Token[];
+    scales: Scale[];
+    color: {
+        roles: Role[];
+        palettes: Palette[];
+        pairs: [string, string, number][];
+        as?: Partial<Record<ChromeRole, string>>;
+    };
+    knobs: Knobs;
+    settled: Record<string, KnobValue>;
+    additions: SystemAddition[];
+    kit: string;
+    projectKits: ProjectKit[];
+    iconSets: IconSetRef[];
+    repo: RepoRead | null;
+}
+export interface SystemRevisionHead {
+    rev: number;
+    at: string;
+    sessionId: string | null;
+    summary: string;
+}
+export declare const emptySystem: (project: string) => System;
+export declare function normalizeSystem(project: string, raw: unknown): System;
+export declare function checkName(name: unknown, what: string): string | null;
+export declare const isSafeValue: (v: unknown) => v is string;
+export declare function isColorValue(v: string): boolean;
+export declare function scaleSteps(scale: Scale): {
+    step: string;
+    min: number;
+    max: number;
+}[];
+export declare function stepValue(scale: Scale, min: number, max: number): string;
+export declare function expandScale(scale: Scale): Token[];
+export declare function deriveRepoTokens(system: System): {
+    system: System;
+    clashes: string[];
+};
+export declare function systemFromDesignSettings(project: string, raw: unknown): System;
+export interface SystemWrite {
+    sheet?: unknown;
+    classes?: unknown;
+    fonts?: unknown;
+    tokens?: unknown;
+    scales?: unknown;
+    roles?: unknown;
+    palettes?: unknown;
+    pairs?: unknown;
+    as?: unknown;
+    knobs?: unknown;
+    remove?: unknown;
+    repo?: unknown;
+    kit?: unknown;
+    projectKits?: unknown;
+    removeKits?: unknown;
+    iconSets?: unknown;
+}
+export declare const SYSTEM_WRITE_KEYS: readonly ["sheet", "classes", "fonts", "tokens", "scales", "roles", "palettes", "pairs", "as", "knobs", "remove", "repo", "kit", "projectKits", "removeKits", "iconSets"];
+export declare const oneLine: (v: string) => string;
+export declare function checkSheet(css: string): string | null;
+export interface WriteContext {
+    checkUrl(url: string): string | null;
+    checkKnobs(raw: unknown): {
+        ok: true;
+        value: Knobs;
+    } | {
+        ok: false;
+        error: string;
+    };
+    checkKit(raw: unknown): ProjectKit | string;
+    kitIds: readonly string[];
+    designKnobPaths: Map<string, string>;
+}
+export declare function applySystemWrite(current: System, write: SystemWrite, ctx: WriteContext): {
+    system: System;
+    clashes: string[];
+} | {
+    error: string;
+};
+export declare function restoreSystem(current: System, old: System, opts?: {
+    keepDecided?: boolean;
+}): {
+    system: System;
+    kept: string[];
+};
+export declare function systemDiffers(before: System, after: System): boolean;
+export declare function describeChange(before: System, after: System): string[];
+export declare function defaultPalette(system: System): Palette | null;
+export declare function activePalette(system: System, id: string | undefined): Palette | null;
+export interface SystemCss {
+    sheet: string;
+    tokens: string;
+    fonts: string[];
+    attrs: {
+        scheme?: "light" | "dark";
+        palette?: string;
+    };
+}
+export declare function systemCss(system: System, opts: {
+    mode?: "light" | "dark";
+    palette?: string;
+    contract?: number;
+}): SystemCss;
+export declare function systemAfterAnswers(system: System, asks: Ask[], answers: Record<string, AskAnswer>, standings: Record<string, AnswerStanding>): {
+    system: System;
+    changes: string[];
+} | null;
+export declare function projectKnobValues(system: System | null): Record<string, KnobValue>;
+export interface SystemExport {
+    project: string;
+    rev: number;
+    sheet: string;
+    css: string;
+    tokens: {
+        constants: Record<string, string | Record<string, string>>;
+        palettes: Record<string, {
+            label: string;
+            status: PaletteStatus;
+            light: Record<string, string>;
+            dark: Record<string, string>;
+        }>;
+    };
+    fonts: SystemFont[];
+    knobs: Record<string, KnobValue>;
+    additions: {
+        knob: string;
+        value: string;
+        style: string;
+    }[];
+}
+export declare function systemExport(system: System): SystemExport;
+export declare function systemLine(system: System, failing: number): string;
+export declare function declaredNames(system: System): Set<string>;
+export declare const hasSystemContent: (s: System | null) => boolean;