@dixy-ui/themes 0.0.0-stage → 0.1.0-beta.1

package/dist/theme-schema.d.ts

@@ -0,0 +1,453 @@
+type Infer<S> = S extends {
+    readonly enum: readonly (infer E)[];
+} ? E : S extends {
+    readonly properties: infer P;
+} ? {
+    readonly [K in keyof P]: Infer<P[K]>;
+} : S extends {
+    readonly type: "number" | "integer";
+} ? number : string;
+/** This closed JSON Schema also supplies TypeScript types, validation and control metadata. */
+export declare const themeDocumentSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly schemaVersion: {
+            readonly enum: readonly [6];
+        };
+        readonly id: {
+            readonly type: "string";
+            readonly minLength: 3;
+            readonly maxLength: 100;
+            readonly pattern: "^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 80;
+            readonly pattern: "\\S";
+        };
+        readonly revision: {
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly maximum: 2147483647;
+        };
+        readonly foundations: {
+            readonly type: "object";
+            readonly properties: {
+                readonly accentColor: {
+                    readonly enum: readonly ["neutral", "slate", "gray", "zinc", "stone", "taupe", "mauve", "mist", "olive", "sage", "sand", "tomato", "red", "ruby", "crimson", "rose", "pink", "fuchsia", "plum", "purple", "violet", "iris", "indigo", "blue", "sky", "cyan", "teal", "emerald", "jade", "green", "grass", "lime", "mint", "yellow", "amber", "orange", "brown", "bronze", "gold"];
+                };
+                readonly customAccent: {
+                    readonly enum: readonly [false, true];
+                };
+                readonly lightness: {
+                    readonly type: "number";
+                    readonly title: string;
+                    readonly minimum: number;
+                    readonly maximum: number;
+                };
+                readonly chroma: {
+                    readonly type: "number";
+                    readonly title: string;
+                    readonly minimum: number;
+                    readonly maximum: number;
+                };
+                readonly hue: {
+                    readonly type: "number";
+                    readonly title: string;
+                    readonly minimum: number;
+                    readonly maximum: number;
+                };
+                readonly neutralColor: {
+                    readonly enum: readonly ["neutral", "slate", "gray", "zinc", "stone", "taupe", "mauve", "mist", "olive", "sage", "sand"];
+                };
+                readonly radius: {
+                    readonly enum: ("none" | "full" | "lg" | "md" | "sm")[];
+                };
+                readonly density: {
+                    readonly enum: ("default" | "compact" | "comfortable")[];
+                };
+                readonly material: {
+                    readonly enum: readonly ["matte", "glossy", "soft", "metal", "paper"];
+                };
+                readonly componentFinish: {
+                    readonly enum: readonly ["inherit", "matte", "glossy", "soft", "metal", "paper"];
+                };
+                readonly shape: {
+                    readonly enum: readonly ["rounded", "pill", "square"];
+                };
+                readonly appearance: {
+                    readonly enum: readonly ["light", "dark"];
+                };
+                readonly bodyFont: {
+                    readonly enum: readonly ["inter", "grotesk", "system", "serif", "mono", "fraunces", "deco", "pixel", "techno", "rounded", "lcd", "plex", "archivo", "neon", "mincho", "gothic", "playfair", "caveat", "bricolage", "terminal", "jetbrains", "manrope", "figtree", "cormorant"];
+                };
+                readonly headingFont: {
+                    readonly enum: readonly ["inter", "grotesk", "system", "serif", "mono", "fraunces", "deco", "pixel", "techno", "rounded", "lcd", "plex", "archivo", "neon", "mincho", "gothic", "playfair", "caveat", "bricolage", "terminal", "jetbrains", "manrope", "figtree", "cormorant"];
+                };
+                readonly border: {
+                    readonly enum: readonly [1, 2];
+                };
+                readonly depth: {
+                    readonly enum: readonly ["none", "raised", "floating"];
+                };
+                readonly ornament: {
+                    readonly enum: readonly ["quiet", "balanced", "expressive"];
+                };
+                readonly relief: {
+                    readonly enum: readonly [0, 1, 2];
+                };
+                readonly effects: {
+                    readonly enum: readonly ["static", "backdrop", "reduced"];
+                };
+            };
+            readonly required: string[];
+            readonly additionalProperties: false;
+        };
+        readonly recipes: {
+            readonly type: "object";
+            readonly properties: {
+                readonly material: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly id: {
+                            readonly enum: ("botanical-paper" | "pixel-enamel" | "gunmetal" | "ceramic" | "prismatic-glass" | "atelier-paper" | "sea-glass" | "candy-clay" | "lacquer-brass" | "titanium" | "frosted-porcelain" | "scrapbook-paper" | "cyanotype" | "riso-paper" | "wet-asphalt" | "washi" | "station-enamel" | "phosphor-glass" | "ansi-term" | "poster-stock" | "glazed-tile" | "concrete" | "atomic-laminate" | "hologram" | "painted-steel" | "gold-foil" | "marigold-silk" | "red-paper" | "fiesta-paper" | "powder-wash" | "wool" | "liquid-glass")[];
+                        };
+                        readonly version: {
+                            readonly enum: readonly [1];
+                        };
+                        readonly parameters: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly surfaceMix: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly darkSurfaceMix: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly sheen: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly cushion: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly inkTint: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly textureScale: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly lightAngle: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly backdropBlur: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly backdropSaturate: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                            };
+                            readonly required: string[];
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly required: string[];
+                    readonly additionalProperties: false;
+                };
+                readonly frame: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly id: {
+                            readonly enum: ("none" | "coral" | "forest" | "cushion" | "deco" | "drafting" | "riso" | "neon" | "sumi" | "transit" | "crt" | "panes" | "swiss" | "azulejo" | "formwork" | "atomic" | "hud" | "hazard" | "orbit" | "rangoli" | "papercut" | "picado" | "gulal" | "knit" | "liquid" | "glass" | "pixel" | "halo" | "ceramic" | "rails" | "stitch" | "chamfer")[];
+                        };
+                        readonly version: {
+                            readonly enum: readonly [1];
+                        };
+                        readonly ornament: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly style: {
+                                    readonly enum: ("Woodland mix" | "Wild ivy" | "Fern grove" | "Willow canopy" | "Oak & moss" | "Spring growth" | "Ginkgo fans" | "Maple grove" | "Eucalyptus" | "Olive branch" | "Clover meadow" | "Wildflower hedge" | "Piped petals" | "Twisted rope" | "Candy pebbles" | "Ribbon folds" | "Tidal ribbons" | "Seafoam beads" | "Glass droplets" | "Quiet currents" | "Fine filigree" | "Art deco" | "Hammered edge" | "Quiet gilding" | "Dimensioned" | "Ruler ticks" | "Construction lines" | "Quiet draft" | "Misprint" | "Halftone" | "Taped corners" | "Clean stamp" | "Tube outline" | "Broken tubes" | "Sign shapes" | "Low hum" | "Bamboo" | "Plum blossom" | "Dry brush" | "Ensō" | "Line map" | "Station roundels" | "Platform edge" | "Quiet line" | "Box corners" | "Status line" | "Raster ticks" | "Quiet cursor" | "Pane titles" | "Key hints" | "Split panes" | "Bare panes" | "Crop marks" | "Red block" | "Grid ticks" | "Bare grid" | "Corner tiles" | "Border run" | "Floral rosette" | "Single tile" | "Tie holes" | "Stencil marks" | "Board seams" | "Bare concrete" | "Starbursts" | "Boomerangs" | "Orbit atoms" | "Lone star" | "Target brackets" | "Telemetry" | "Reticle" | "Clean brackets" | "Hazard stripes" | "Rivet seams" | "Cargo stencils" | "Clean plate" | "Orbit rings" | "Gold foil" | "Star field" | "Single orbit" | "Rangoli corners" | "Diya row" | "Marigold string" | "Single diya" | "Lanterns" | "Scallop edge" | "Cloud scrolls" | "Single lantern" | "Bunting" | "Marigold garland" | "Paper confetti" | "Short string" | "Powder clouds" | "Splashes" | "Speckle dust" | "Soft haze" | "Fair Isle band" | "Snowflakes" | "Cable stitch" | "Plain rib" | "Specular rim" | "Refraction" | "Light catch" | "Clear")[];
+                                };
+                                readonly canopy: {
+                                    readonly enum: readonly ["Scattered trails", "Corner cascades", "Overhead boughs", "Long tendrils", "Open crown"];
+                                };
+                                readonly stem: {
+                                    readonly enum: readonly ["Twining vines", "Woody branches", "Tender shoots", "Mossy roots"];
+                                };
+                                readonly density: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly cornerDensity: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly canopyDepth: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly variation: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly scale: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly stemWeight: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly motion: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly seed: {
+                                    readonly type: "integer";
+                                    readonly title: "Variation seed";
+                                    readonly minimum: 1;
+                                    readonly maximum: 9999;
+                                };
+                            };
+                            readonly required: string[];
+                            readonly additionalProperties: false;
+                        };
+                        readonly parameters: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly width: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly paddingTop: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly paddingInline: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly paddingBottom: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly inset: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly cornerVariation: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                                readonly cornerScale: {
+                                    readonly type: "number";
+                                    readonly title: string;
+                                    readonly minimum: number;
+                                    readonly maximum: number;
+                                };
+                            };
+                            readonly required: string[];
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly required: string[];
+                    readonly additionalProperties: false;
+                };
+            };
+            readonly required: string[];
+            readonly additionalProperties: false;
+        };
+        readonly character: {
+            readonly type: "object";
+            readonly properties: {
+                readonly controls: {
+                    readonly enum: readonly ["standard", "botanical", "pixel", "instrument", "hardware", "glass", "stitched", "pearl", "clay", "brass", "chrome", "halo"];
+                };
+                readonly motion: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly style: {
+                            readonly enum: readonly ["standard", "snappy", "stepped", "springy", "weighted", "drift"];
+                        };
+                        readonly press: {
+                            readonly type: "number";
+                            readonly title: string;
+                            readonly minimum: number;
+                            readonly maximum: number;
+                        };
+                        readonly tempo: {
+                            readonly type: "number";
+                            readonly title: string;
+                            readonly minimum: number;
+                            readonly maximum: number;
+                        };
+                    };
+                    readonly required: string[];
+                    readonly additionalProperties: false;
+                };
+                readonly type: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly headingCase: {
+                            readonly enum: readonly ["none", "uppercase", "small-caps"];
+                        };
+                        readonly headingTracking: {
+                            readonly type: "number";
+                            readonly title: string;
+                            readonly minimum: number;
+                            readonly maximum: number;
+                        };
+                        readonly headingWeight: {
+                            readonly enum: readonly [300, 400, 500, 600, 700, 800, 900];
+                        };
+                        readonly numerals: {
+                            readonly enum: readonly ["proportional", "tabular", "oldstyle"];
+                        };
+                    };
+                    readonly required: string[];
+                    readonly additionalProperties: false;
+                };
+                readonly states: {
+                    readonly enum: readonly ["standard", "led", "marching", "inlay", "glow", "stamp"];
+                };
+                readonly details: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly focus: {
+                            readonly enum: readonly ["ring", "double", "dashed", "glow", "offset"];
+                        };
+                        readonly divider: {
+                            readonly enum: readonly ["line", "dashed", "dotted", "double", "groove"];
+                        };
+                        readonly selection: {
+                            readonly enum: readonly ["accent", "inverse", "highlighter"];
+                        };
+                        readonly scrollbar: {
+                            readonly enum: readonly ["native", "thin", "accent"];
+                        };
+                        readonly iconStroke: {
+                            readonly type: "number";
+                            readonly title: string;
+                            readonly minimum: number;
+                            readonly maximum: number;
+                        };
+                    };
+                    readonly required: string[];
+                    readonly additionalProperties: false;
+                };
+                readonly backdrop: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly pattern: {
+                            readonly enum: readonly ["none", "grid", "scanlines", "sunburst", "caustics", "fibre", "dots", "topo", "halftone"];
+                        };
+                        readonly intensity: {
+                            readonly type: "number";
+                            readonly title: string;
+                            readonly minimum: number;
+                            readonly maximum: number;
+                        };
+                        readonly scale: {
+                            readonly type: "number";
+                            readonly title: string;
+                            readonly minimum: number;
+                            readonly maximum: number;
+                        };
+                    };
+                    readonly required: string[];
+                    readonly additionalProperties: false;
+                };
+                readonly chrome: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly titlebar: {
+                            readonly enum: readonly ["none", "grip", "caption", "gradient", "tab", "glass", "chrome"];
+                        };
+                        readonly edge: {
+                            readonly enum: readonly ["line", "bevel", "double", "pill", "stepped"];
+                        };
+                        readonly well: {
+                            readonly enum: readonly ["none", "lcd", "recessed", "tinted", "paper", "glass", "sunken"];
+                        };
+                        readonly corners: {
+                            readonly enum: readonly ["inherit", "pixel", "notched", "round"];
+                        };
+                    };
+                    readonly required: string[];
+                    readonly additionalProperties: false;
+                };
+            };
+            readonly required: string[];
+            readonly additionalProperties: false;
+        };
+    };
+    readonly required: string[];
+    readonly additionalProperties: false;
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+};
+export type ThemeDocument = Infer<typeof themeDocumentSchema>;
+export type ThemeFoundations = ThemeDocument["foundations"];
+export interface ThemeDocumentIssue {
+    path: string;
+    message: string;
+}
+export declare class ThemeDocumentError extends Error {
+    readonly issues: readonly ThemeDocumentIssue[];
+    constructor(issues: readonly ThemeDocumentIssue[]);
+}
+export declare function parseThemeDocument(input: unknown): ThemeDocument;
+export {};