feat: export all sub-types and constants (#33)

bartveneman · web-flow · commit 4f588ea1f80a · 2025-10-13T15:56:09.000+02:00
diff --git a/src/destructure-box-shadow.ts b/src/destructure-box-shadow.ts
@@ -1,14 +1,14 @@
 import { parse, type CssNode, type Value } from 'css-tree'
 import { color_to_token } from './colors.js'
-import type { ColorToken, ColorValue } from './types.js'
+import type { ColorValue } from './types.js'
 import { namedColors as named_colors, systemColors as system_colors, colorFunctions as color_functions } from '@projectwallace/css-analyzer'
 
-type CssLength = {
+export type CssLength = {
 	value: number
 	unit: string
 }
 
-export type DestructuredShadow = {
+export type ShadowValue = {
 	color: ColorValue | undefined
 	offsetX: CssLength | undefined
 	offsetY: CssLength | undefined
@@ -17,7 +17,7 @@ export type DestructuredShadow = {
 	inset: boolean | undefined
 }
 
-function create_destructured(): DestructuredShadow {
+function create_destructured(): ShadowValue {
 	return {
 		color: undefined,
 		offsetX: undefined,
@@ -28,10 +28,10 @@ function create_destructured(): DestructuredShadow {
 	}
 }
 
-export function destructure_box_shadow(value: string): null | DestructuredShadow[] {
+export function destructure_box_shadow(value: string): null | ShadowValue[] {
 	let ast = parse(value, {
 		context: 'value',
-		positions: true
+		positions: true,
 	}) as Value
 
 	function generate(node: CssNode) {
@@ -42,7 +42,7 @@ export function destructure_box_shadow(value: string): null | DestructuredShadow
 	}
 
 	let current_shadow = create_destructured()
-	let destructured: DestructuredShadow[] = [current_shadow]
+	let destructured: ShadowValue[] = [current_shadow]
 
 	if (ast.children.size < 2) {
 		return null
@@ -59,15 +59,17 @@ export function destructure_box_shadow(value: string): null | DestructuredShadow
 				}
 				current_shadow.color = color_token
 			}
-		}
-		else if (node.type === 'Dimension' || (node.type === 'Number' && node.value === '0')) {
-			let length = node.type === 'Dimension' ? {
-				value: Number(node.value),
-				unit: node.unit
-			} : {
-				value: 0,
-				unit: 'px',
-			}
+		} else if (node.type === 'Dimension' || (node.type === 'Number' && node.value === '0')) {
+			let length =
+				node.type === 'Dimension'
+					? {
+							value: Number(node.value),
+							unit: node.unit,
+					  }
+					: {
+							value: 0,
+							unit: 'px',
+					  }
 
 			if (!current_shadow.offsetX) {
 				current_shadow.offsetX = length
@@ -78,8 +80,7 @@ export function destructure_box_shadow(value: string): null | DestructuredShadow
 			} else if (!current_shadow.spread) {
 				current_shadow.spread = length
 			}
-		}
-		else if (node.type === 'Function') {
+		} else if (node.type === 'Function') {
 			if (color_functions.has(node.name)) {
 				let color_token = color_to_token(generate(node))
 				if (color_token === null) {
@@ -93,15 +94,13 @@ export function destructure_box_shadow(value: string): null | DestructuredShadow
 				}
 				current_shadow.color = color_token
 			}
-		}
-		else if (node.type === 'Hash') {
+		} else if (node.type === 'Hash') {
 			let color_token = color_to_token(generate(node))
 			if (color_token === null) {
 				return
 			}
 			current_shadow.color = color_token
-		}
-		else if (node.type === 'Operator' && node.value === ',') {
+		} else if (node.type === 'Operator' && node.value === ',') {
 			// Start a new shadow, but only after we've made sure that the current shadow is valid
 			complete_shadow_token(current_shadow)
 			current_shadow = create_destructured()
@@ -116,15 +115,15 @@ export function destructure_box_shadow(value: string): null | DestructuredShadow
 
 const DIMENSION_ZERO = {
 	value: 0,
-	unit: 'px'
+	unit: 'px',
 }
 
 /**
  * @description
  * According to the spec every shadow MUST have an offsetX, offsetY, blur, spread and color,
  * only the inset is optional and defaults to false.
  */
-function complete_shadow_token(token: DestructuredShadow) {
+function complete_shadow_token(token: ShadowValue) {
 	if (!token.offsetX) {
 		token.offsetX = DIMENSION_ZERO
 	}
diff --git a/src/destructure-font-family.ts b/src/destructure-font-family.ts
@@ -1,7 +1,8 @@
 import { parse, type Value, type CssNode } from 'css-tree'
 import { unquote } from './unquote.js'
+import type { FontFamilyValue } from './types.js'
 
-export function destructure_font_family(value: string): string[] | undefined {
+export function destructure_font_family(value: string): FontFamilyValue | undefined {
 	if (value.toLowerCase().includes('var(')) {
 		return undefined
 	}
diff --git a/src/index.test.ts b/src/index.test.ts
@@ -1,6 +1,5 @@
 import { test, expect, describe } from 'vitest'
-import { analysis_to_tokens, css_to_tokens } from './index.js'
-import { EXTENSION_AUTHORED_AS, EXTENSION_CSS_PROPERTIES, EXTENSION_USAGE_COUNT } from './types.js'
+import { analysis_to_tokens, css_to_tokens, EXTENSION_AUTHORED_AS, EXTENSION_CSS_PROPERTIES, EXTENSION_USAGE_COUNT } from './index.js'
 import { analyze } from '@projectwallace/css-analyzer'
 
 describe('analysis_to_tokens', () => {
diff --git a/src/index.ts b/src/index.ts
@@ -23,6 +23,28 @@ import {
 } from './types.js'
 import { color_to_token } from './colors.js'
 
+export {
+	EXTENSION_AUTHORED_AS,
+	EXTENSION_USAGE_COUNT,
+	EXTENSION_CSS_PROPERTIES,
+	type Easing,
+	type CubicBezierToken,
+	type DimensionValue,
+	type DimensionToken,
+	type DurationToken,
+	type DurationValue,
+	type FontFamilyToken,
+	type NumberToken,
+	type UnparsedToken,
+	type CssAnalysis,
+	type ShadowToken,
+	type ColorSpace,
+	type ColorToken,
+	type ColorValue,
+	type ColorComponent,
+} from './types.js'
+export type { CssLength, ShadowValue } from './destructure-box-shadow.js'
+
 export function css_to_tokens(css: string) {
 	let analysis = analyze(css)
 	return analysis_to_tokens(analysis)
diff --git a/src/types.ts b/src/types.ts
@@ -1,5 +1,5 @@
 import type { analyze } from '@projectwallace/css-analyzer'
-import type { DestructuredShadow } from './destructure-box-shadow'
+import type { ShadowValue } from './destructure-box-shadow'
 
 export type CssAnalysis = ReturnType<typeof analyze>
 
@@ -11,12 +11,12 @@ export type Easing = [number, number, number, number]
 
 export type BaseToken = {
 	$extensions: {
-		[EXTENSION_AUTHORED_AS]: string,
+		[EXTENSION_AUTHORED_AS]: string
 		[EXTENSION_USAGE_COUNT]: number
 	}
 }
 
-type DurationValue = {
+export type DurationValue = {
 	value: number
 	unit: 'ms'
 }
@@ -31,7 +31,22 @@ export type UnparsedToken = BaseToken & {
 	$type?: never
 }
 
-type ColorSpace = string | 'srgb' | 'display-p3' | 'hsl' | 'hwb' | 'lab' | 'lch' | 'oklab' | 'oklch' | 'display-p3' | 'a98-rgb' | 'prophoto-rgb' | 'rec2020' | 'xyz-d65' | 'xyz-d50'
+export type ColorSpace =
+	| string
+	| 'srgb'
+	| 'display-p3'
+	| 'hsl'
+	| 'hwb'
+	| 'lab'
+	| 'lch'
+	| 'oklab'
+	| 'oklch'
+	| 'display-p3'
+	| 'a98-rgb'
+	| 'prophoto-rgb'
+	| 'rec2020'
+	| 'xyz-d65'
+	| 'xyz-d50'
 
 export type ColorComponent = number | 'none'
 
@@ -44,7 +59,7 @@ export type ColorValue = {
 
 export type ColorToken = BaseToken & {
 	$type: 'color'
-	$value: ColorValue,
+	$value: ColorValue
 	$extensions: {
 		[EXTENSION_CSS_PROPERTIES]: Array<string>
 	}
@@ -70,12 +85,14 @@ export type CubicBezierToken = BaseToken & {
 	$value: Easing
 }
 
+export type FontFamilyValue = string[]
+
 export type FontFamilyToken = BaseToken & {
 	$type: 'fontFamily'
-	$value: string[]
+	$value: FontFamilyValue
 }
 
 export type ShadowToken = BaseToken & {
 	$type: 'shadow'
-	$value: DestructuredShadow | DestructuredShadow[]
+	$value: ShadowValue | ShadowValue[]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,8 @@`
`1`	`1`	`import { parse, type Value, type CssNode } from 'css-tree'`
`2`	`2`	`import { unquote } from './unquote.js'`
	`3`	`+import type { FontFamilyValue } from './types.js'`
`3`	`4`
`4`		`-export function destructure_font_family(value: string): string[] \| undefined {`
	`5`	`+export function destructure_font_family(value: string): FontFamilyValue \| undefined {`
`5`	`6`	`if (value.toLowerCase().includes('var(')) {`
`6`	`7`	`return undefined`
`7`	`8`	`}`