inferred-types 0.52.1 → 0.52.3

package/dist/types/string-literals/character-sets/css/color.d.ts

@@ -1,9 +1,11 @@
 import { HexadecimalChar } from "../Hexadecimal";
 import { OptionalSpace } from "../OptionalSpace";
 import { CSS_NAMED_COLORS } from "inferred-types/constants";
+import { TwColorWithLuminosity } from "../tw";
 export type CssNamedColors = typeof CSS_NAMED_COLORS[number];
 export type CssColorModel = "rgb" | "hsl" | "hsb" | "lab" | "oklch";
-export type CssColorSpace = "srgb" | "srgb-linear" | "p3-display" | "rec2020" | "a98-rgb" | "prophoto-rgb" | "xyz" | "xyz-d50" | "xyz-d65";
+export type CssColorSpace = "srgb" | "srgb-linear" | "display-p3" | "rec2020" | "a98-rgb" | "prophoto-rgb" | "xyz" | "xyz-d50" | "xyz-d65" | "hsl" | "hwb" | "lch" | "oklch";
+export type CssColorSpacePrimary = "srgb" | "display-p3" | "rec2020" | "hsl" | "hwb" | "lch" | "oklch";
 export type CssRgb = `rgb(${number} ${number} ${number})` | `rgb(${number},${OptionalSpace}${number},${OptionalSpace}${number})`;
 export type CssRgba = `rgba(${number} ${number} ${number})` | `rgba(${number},${OptionalSpace}${number},${OptionalSpace}${number})`;
 /**
@@ -41,5 +43,18 @@ export type CssColor = CssNamedColors | CssHexColor | CssRgb | CssRgba | CssOkLc
  * **Related:** `CssColorSpace`, `ColorFnValue`, `ColorFnOptOpacity`
  */
 export type CssColorFn<TColorSpace extends CssColorSpace = CssColorSpace, TV1 extends ColorFnValue = ColorFnValue, TV2 extends ColorFnValue = ColorFnValue, TV3 extends ColorFnValue = ColorFnValue, TOp extends ColorFnOptOpacity = ColorFnOptOpacity> = `color(${TColorSpace} ${TV1} ${TV2} ${TV3})${TOp}` | `color(${CssColor} from ${TColorSpace} ${TV1} ${TV2} ${TV3})${TOp}`;
+export type CssColorMix = `color-mix(in ${CssColorSpace}, ${CssColor}${string})`;
+export type CssColorMixLight = `color-mix(in ${CssColorSpacePrimary}, ${string})`;
+/**
+ * **ColorParam**
+ *
+ * A union of color options which might be presented as user input. It includes:
+ *
+ * - all CSS named colors
+ * - any valid CSS hex color
+ * - any Tailwind Color/Luminosity pairing
+ * - a `color-mix(...)` color
+ */
+export type ColorParam = CssNamedColors | CssHexColor | TwColorWithLuminosity | CssColorMixLight;
 export {};
 //# sourceMappingURL=color.d.ts.map

package/dist/types/string-literals/character-sets/css/color.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/css/color.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D,MAAM,MAAM,cAAc,GAAG,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAE7D,MAAM,MAAM,aAAa,GACvB,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,OAAO,CAAC;AAEV,MAAM,MAAM,aAAa,GACvB,MAAM,GACN,aAAa,GACb,YAAY,GACZ,SAAS,GACT,SAAS,GACT,cAAc,GACd,KAAK,GACL,SAAS,GACT,SAAS,CAAC;AAGZ,MAAM,MAAM,MAAM,GAChB,OAAO,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GACpC,OAAO,MAAM,IAAI,aAAa,GAAG,MAAM,IAAI,aAAa,GAAG,MAAM,GAAG,CAAC;AAGvE,MAAM,MAAM,OAAO,GACjB,QAAQ,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GACrC,QAAQ,MAAM,IAAI,aAAa,GAAG,MAAM,IAAI,aAAa,GAAG,MAAM,GAAG,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,MAAM,GAChB,OAAO,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GACpC,OAAO,MAAM,IAAI,aAAa,GAAG,MAAM,IAAI,aAAa,GAAG,MAAM,GAAG,CAAC;AAGvE;;GAEG;AACH,MAAM,MAAM,MAAM,GAChB,OAAO,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GACpC,OAAO,MAAM,IAAI,aAAa,GAAG,MAAM,IAAI,aAAa,GAAG,MAAM,GAAG,CAAC;AAGvE,KAAK,eAAe,GAAG,GAAG,GAAG,EAAE,CAAC;AAEhC;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAClB,SAAS,MAAM,GAAG,eAAe,IAAI,MAAM,GAAG,eAAe,IAAI,MAAM,GAAG,CAAA;AAE5E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,eAAe,GAAG,eAAe,GAAG,MAAM,EAAE,CAAC;AAG3E,MAAM,MAAM,YAAY,GAAG,GAAG,MAAM,EAAE,GAAG,GAAG,MAAM,GAAG,GAAG,MAAM,CAAC;AAC/D,MAAM,MAAM,iBAAiB,GAAG,EAAE,GAAG,MAAM,MAAM,EAAE,CAAA;AAEnD;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAClB,cAAc,GACd,WAAW,GACX,MAAM,GACN,OAAO,GACP,QAAQ,GACR,MAAM,GACN,MAAM,GACN,SAAS,MAAM,GAAG,CAAC;AAErB;;;;GAIG;AACH,MAAM,MAAM,UAAU,CACpB,WAAW,SAAS,aAAa,GAAG,aAAa,EACjD,GAAG,SAAS,YAAY,GAAG,YAAY,EACvC,GAAG,SAAS,YAAY,GAAG,YAAY,EACvC,GAAG,SAAS,YAAY,GAAG,YAAY,EACvC,GAAG,SAAS,iBAAiB,GAAG,iBAAiB,IAEjD,SAAS,WAAW,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE,GAClD,SAAS,QAAQ,SAAS,WAAW,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC"}
+{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/css/color.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAC;AAE9C,MAAM,MAAM,cAAc,GAAG,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAE7D,MAAM,MAAM,aAAa,GACvB,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,OAAO,CAAC;AAEV,MAAM,MAAM,aAAa,GACvB,MAAM,GACN,aAAa,GACb,YAAY,GACZ,SAAS,GACT,SAAS,GACT,cAAc,GACd,KAAK,GACL,SAAS,GACT,SAAS,GACT,KAAK,GACL,KAAK,GACL,KAAK,GACL,OAAO,CAAC;AAEV,MAAM,MAAM,oBAAoB,GAC9B,MAAM,GACN,YAAY,GACZ,SAAS,GACT,KAAK,GACL,KAAK,GACL,KAAK,GACL,OAAO,CAAC;AAGV,MAAM,MAAM,MAAM,GAChB,OAAO,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GACpC,OAAO,MAAM,IAAI,aAAa,GAAG,MAAM,IAAI,aAAa,GAAG,MAAM,GAAG,CAAC;AAGvE,MAAM,MAAM,OAAO,GACjB,QAAQ,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GACrC,QAAQ,MAAM,IAAI,aAAa,GAAG,MAAM,IAAI,aAAa,GAAG,MAAM,GAAG,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,MAAM,GAChB,OAAO,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GACpC,OAAO,MAAM,IAAI,aAAa,GAAG,MAAM,IAAI,aAAa,GAAG,MAAM,GAAG,CAAC;AAGvE;;GAEG;AACH,MAAM,MAAM,MAAM,GAChB,OAAO,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,GACpC,OAAO,MAAM,IAAI,aAAa,GAAG,MAAM,IAAI,aAAa,GAAG,MAAM,GAAG,CAAC;AAGvE,KAAK,eAAe,GAAG,GAAG,GAAG,EAAE,CAAC;AAEhC;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAClB,SAAS,MAAM,GAAG,eAAe,IAAI,MAAM,GAAG,eAAe,IAAI,MAAM,GAAG,CAAA;AAE5E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,eAAe,GAAG,eAAe,GAAG,MAAM,EAAE,CAAC;AAG3E,MAAM,MAAM,YAAY,GAAG,GAAG,MAAM,EAAE,GAAG,GAAG,MAAM,GAAG,GAAG,MAAM,CAAC;AAC/D,MAAM,MAAM,iBAAiB,GAAG,EAAE,GAAG,MAAM,MAAM,EAAE,CAAA;AAEnD;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAClB,cAAc,GACd,WAAW,GACX,MAAM,GACN,OAAO,GACP,QAAQ,GACR,MAAM,GACN,MAAM,GACN,SAAS,MAAM,GAAG,CAAC;AAKrB;;;;GAIG;AACH,MAAM,MAAM,UAAU,CACpB,WAAW,SAAS,aAAa,GAAG,aAAa,EACjD,GAAG,SAAS,YAAY,GAAG,YAAY,EACvC,GAAG,SAAS,YAAY,GAAG,YAAY,EACvC,GAAG,SAAS,YAAY,GAAG,YAAY,EACvC,GAAG,SAAS,iBAAiB,GAAG,iBAAiB,IAEjD,SAAS,WAAW,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE,GAClD,SAAS,QAAQ,SAAS,WAAW,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;AAItE,MAAM,MAAM,WAAW,GAAG,gBAAgB,aAAa,KAAK,QAAQ,GAAG,MAAM,GAAG,CAAC;AAEjF,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,oBAAoB,KAAK,MAAM,GAAG,CAAC;AAElF;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,WAAW,GAAG,qBAAqB,GAAG,gBAAgB,CAAC"}

package/dist/types/string-literals/character-sets/css/functions.d.ts

@@ -0,0 +1,32 @@
+import { CssColor } from "./color";
+import { CssSizing } from "./sizing";
+export type CssVar = `var(--${string})`;
+/**
+ * A CSS variable declaration with a [fallback](https://developer.mozilla.org/en-US/docs/Web/CSS/var#syntax)
+ * choice or choices.
+ */
+export type CssVarWithFallback = `var(--${string}, ${CssVar | CssColor})`;
+/**
+ * The CSS `translate()` function
+ */
+export type CssTranslate = `translate(${CssSizing})` | `translate(0)` | `translate(${CssSizing}, ${CssSizing})`;
+/**
+ * The CSS [`round()`](https://developer.mozilla.org/en-US/docs/Web/CSS/round) function
+ */
+export type CssRound = `round(${CssVar}, ${CssSizing})` | `round(${"up" | "down" | "nearest" | "to-zero"}, ${CssVar | CssSizing}, ${string})`;
+/**
+ * The CSS [clamp](https://developer.mozilla.org/en-US/docs/Web/CSS/clamp) function
+ */
+export type CssClamp = `clamp(${CssSizing}, ${string}, ${string})`;
+/**
+ * The CSS [calc()](https://developer.mozilla.org/en-US/docs/Web/CSS/calc) function.
+ *
+ * ```css
+ * calc(100% - 80px)
+ * calc(100px * sin(pi / 2))
+ * calc(var(--hue) + 180)
+ * lch(from aquamarine l c calc(h + 180))
+ * ```
+ */
+export type CssCalc = `calc(${CssSizing | CssVarWithFallback}${string})`;
+//# sourceMappingURL=functions.d.ts.map

package/dist/types/string-literals/character-sets/css/functions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/css/functions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAErC,MAAM,MAAM,MAAM,GAAG,SAAS,MAAM,GAAG,CAAC;AAExC;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,MAAM,KAAK,MAAM,GAAG,QAAQ,GAAG,CAAC;AAG1E;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,aAAa,SAAS,GAAG,GAAG,cAAc,GAAG,aAAa,SAAS,KAAK,SAAS,GAAG,CAAA;AAE/G;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,SAAS,MAAM,KAAK,SAAS,GAAG,GACrD,SAAS,IAAI,GAAC,MAAM,GAAC,SAAS,GAAC,SAAS,KAAK,MAAM,GAAG,SAAS,KAAK,MAAM,GAAG,CAAA;AAE/E;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,SAAS,SAAS,KAAK,MAAM,KAAK,MAAM,GAAG,CAAC;AAEnE;;;;;;;;;GASG;AACH,MAAM,MAAM,OAAO,GAAG,QAAQ,SAAS,GAAG,kBAAkB,GAAG,MAAM,GAAG,CAAC"}

package/dist/types/string-literals/character-sets/css/functions.js

@@ -0,0 +1 @@
+export {};

package/dist/types/string-literals/character-sets/css/index.d.ts

@@ -10,4 +10,5 @@ export * from "./object";
 export * from "./overflow";
 export * from "./global";
 export * from "./html-element";
+export * from "./functions";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/string-literals/character-sets/css/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/css/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/css/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC"}

package/dist/types/string-literals/character-sets/css/index.js

@@ -10,3 +10,4 @@ export * from "./object";
 export * from "./overflow";
 export * from "./global";
 export * from "./html-element";
+export * from "./functions";

package/dist/types/string-literals/character-sets/css/sizing.d.ts

@@ -1,10 +1,19 @@
 export type SizingUnits = `px` | `em` | `rem` | `ch` | `vh` | `svh` | `dvh` | `lvh` | `vw` | `lvw` | `svw` | `dvw` | `fr`;
 type VariableSizing = `var(${string})${SizingUnits}` | `var(${string})` | `calc(${string})${SizingUnits}` | `calc(${string})` | `min(${string})${SizingUnits}` | `min(${string})` | `max(${string})${SizingUnits}` | `max(${string})` | `minmax(${string})${SizingUnits}` | `minmax(${string})`;
 /**
- * provides a string literal which is intended to describe the
- * "size" of any CSS property (whether using static values or
- * CSS variables)
+ * A strong type for allowed CSS sizing options.
+ *
+ * **Related:** `CssSizingLight`
  */
 export type CssSizing = `${number}${SizingUnits}` | `${number}%` | VariableSizing;
+/**
+ * A strong type for allowed CSS sizing options.
+ *
+ * - unlike `CssSizing` this type doesn't allow `VariableSizing` where a **var(...)** expression
+ * is then followed by a sizing unit.
+ * - this reduces complexity considerably while fiitting most use cases as you can still have
+ * CSS variables like `var(--foobar)` in this type.
+ */
+export type CssSizingLight = `${number}${SizingUnits}` | `${number}%`;
 export {};
 //# sourceMappingURL=sizing.d.ts.map

package/dist/types/string-literals/character-sets/css/sizing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sizing.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/css/sizing.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GACrB,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,IAAI,CAAC;AAEP,KAAK,cAAc,GACjB,OAAO,MAAM,IAAI,WAAW,EAAE,GAC9B,OAAO,MAAM,GAAG,GAChB,QAAQ,MAAM,IAAI,WAAW,EAAE,GAC/B,QAAQ,MAAM,GAAG,GACjB,OAAO,MAAM,IAAI,WAAW,EAAE,GAC9B,OAAO,MAAM,GAAG,GAChB,OAAO,MAAM,IAAI,WAAW,EAAE,GAC9B,OAAO,MAAM,GAAG,GAChB,UAAU,MAAM,IAAI,WAAW,EAAE,GACjC,UAAU,MAAM,GAAG,CAAC;AAGtB;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,GAAG,MAAM,GAAG,WAAW,EAAE,GAAG,GAAG,MAAM,GAAG,GAAG,cAAc,CAAC"}
+{"version":3,"file":"sizing.d.ts","sourceRoot":"","sources":["../../../../../src/types/string-literals/character-sets/css/sizing.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GACrB,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,IAAI,CAAC;AAEP,KAAK,cAAc,GACjB,OAAO,MAAM,IAAI,WAAW,EAAE,GAC9B,OAAO,MAAM,GAAG,GAChB,QAAQ,MAAM,IAAI,WAAW,EAAE,GAC/B,QAAQ,MAAM,GAAG,GACjB,OAAO,MAAM,IAAI,WAAW,EAAE,GAC9B,OAAO,MAAM,GAAG,GAChB,OAAO,MAAM,IAAI,WAAW,EAAE,GAC9B,OAAO,MAAM,GAAG,GAChB,UAAU,MAAM,IAAI,WAAW,EAAE,GACjC,UAAU,MAAM,GAAG,CAAC;AAGtB;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,GAAG,MAAM,GAAG,WAAW,EAAE,GAAG,GAAG,MAAM,GAAG,GAAG,cAAc,CAAC;AAGlF;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,MAAM,GAAG,WAAW,EAAE,GAAG,GAAG,MAAM,GAAG,CAAC"}

package/dist/types/string-literals/character-sets/tw/TwColor.d.ts

@@ -46,7 +46,7 @@ export type TwColorWithLuminosityOpacity = `${TwColorWithLuminosity}/${number}`;
  * **TwColorOption**
  *
  * A [TailwindCSS](https://tailwindcss.com/docs/customizing-colors) color
- * option which optionally can include
+ * option which requires luminosity but optionally can include opacity too
  */
 export type TwColorOption = TwColorWithLuminosity | TwColorWithLuminosityOpacity;
 export type TwLuminosityLookup = Mutable<typeof TW_LUMINOSITY>;