@ui0/theme 0.0.0-stage → 0.1.0

package/src/contracts/typography/typography.types.ts

@@ -0,0 +1,90 @@
+// ---------------------------------------------------------------------------
+// CONTRACT TEMPLATE - a skeleton for new theme contracts, consumed by
+// scripts/gen-contract.ts in the templates package:
+//
+//   pnpm contract:gen
+//
+// The generator copies this folder into <package>/src/contracts/<name>/
+// (the theme package ships the contracts folder), substituting typography /
+// Typography / typography / t in file bodies and names. After generation:
+//
+//   1. add the contract to src/contracts/index.ts (registry)
+//   2. add <kebab>Generator to src/generator.ts (contractGenerators)
+//   3. fill in the prop values / appearance config below
+//
+// The package itself stays unaware of the contract - types land in the
+// registries via interface merging only.
+// ---------------------------------------------------------------------------
+import type { LiteralUnion, MaybeUnits, Numberish } from '@ui0/types'
+
+// 1. the values the prop accepts - the logical utility class names from
+//    typography.module.css (hashed onto the theme's setter classes)
+export type TypographyProp = LiteralUnion<
+  | 'fw100'
+  | 'fw200'
+  | 'fw300'
+  | 'fw400'
+  | 'fw500'
+  | 'fw600'
+  | 'fw700'
+  | 'fw800'
+  | 'fw900'
+  | 'tt-uppercase'
+  | 'tt-lowercase'
+  | 'tt-capitalize'
+  | 'tt-none'
+  | 'tt-full'
+  | 'tt-full-size-kana'
+  | 'ta-center'
+  | 'ta-end'
+  | 'ta-justify'
+  | 'ta-left'
+  | 'ta-match-parent'
+  | 'ta-right'
+  | 'ta-start'
+  | 'to-mixed'
+  | 'to-sideways'
+  | 'to-sideways-right'
+  | 'to-use-glyph-orientation'
+  | 'to-upright'
+  | 'tw-nowrap'
+  | 'tw-wrap'
+  | 'tw-balance'
+  | 'tw-pretty'
+  | 'tw-stable'
+>
+
+// 2. the props this contract supplies to components
+export interface TypographyProps {
+  typography?: TypographyProp
+}
+
+// 3. the contract's settings inside a theme preset (appearance config) -
+//    what the generator turns into css vars
+export interface TypographyThemeAppearanceConfig {
+  /** e.g. a base value the generator emits as a css var */
+  fontSize?: MaybeUnits
+
+  // base of h6?
+  fontSizeHeading?: MaybeUnits
+  headingRatio?: number
+}
+export interface TypographyContractSettings {
+  /** e.g. a base value the generator emits as a css var */
+  fontSize?: MaybeUnits
+
+  // base of h6?
+  fontSizeHeading?: MaybeUnits
+  headingRatio?: number
+}
+
+// 4. registration: announces this contract to the package registries.
+declare module '@ui0/types/theme' {
+  interface Ui0ThemePresetAppearanceConfig {
+    typography?: TypographyThemeAppearanceConfig
+  }
+  interface Ui0ThemeContractSettings {
+    typography?: TypographyContractSettings
+  }
+  interface Ui0ThemeContracts extends TypographyProps {}
+}