nestable-tailwind-variants 0.1.4 → 0.2.0

package/dist/types.d.ts

@@ -1,17 +1,110 @@
-import { extendTailwindMerge } from 'tailwind-merge';
-export type TWMergeConfig = Parameters<typeof extendTailwindMerge>[0];
-export interface NTVConfig {
+import type { ClassNameValue as ClassValue, extendTailwindMerge } from 'tailwind-merge';
+export type { ClassValue };
+/**
+ * Union type for class prop - ensures only one of class or className is used.
+ * This prevents ambiguity when passing class names to components.
+ */
+export type ClassProp = {
+    class?: ClassValue;
+    className?: never;
+} | {
+    class?: never;
+    className?: ClassValue;
+};
+/**
+ * Props type constraint for NTV style functions.
+ * Props are either boolean flags or string variant selections.
+ */
+export interface NtvProps {
+}
+/**
+ * Merge all properties from a union type into a single object type.
+ * Combines props from multiple style functions by creating unions of their values.
+ */
+type MergeUnion<T> = {
+    [K in T extends unknown ? keyof T : never]: T extends unknown ? K extends keyof T ? T[K] : never : never;
+};
+/**
+ * Extract and merge props types from an array of style functions.
+ * Used by mergeNtv to create a combined props type.
+ */
+export type MergeStyleFunctionProps<T extends readonly StyleFunction<any>[]> = MergeUnion<{
+    [K in keyof T]: T[K] extends StyleFunction<infer P> ? P : never;
+}[number]>;
+/**
+ * Make all properties optional and allow undefined values.
+ * Ensures proper handling of missing props in style functions.
+ */
+type PartialWithUndefined<T> = {
+    [K in keyof T]?: T[K] | undefined;
+};
+/**
+ * Flatten intersection types for better IDE display.
+ */
+type Simplify<T> = {
+    [K in keyof T]: T[K];
+};
+/**
+ * Function signature for style generators.
+ * Accepts optional props and returns a string of class names.
+ */
+export type StyleFunction<TProps> = (props?: Simplify<PartialWithUndefined<TProps> & ClassProp>) => string;
+/**
+ * Boolean scheme entry - class value or nested scheme with conditions.
+ */
+type BooleanSchemeEntry<TProps extends NtvProps> = ClassValue | (SchemeFor<TProps> & {
+    $default?: ClassValue;
+});
+/**
+ * Variant scheme entry - maps variant values to class values or nested schemes.
+ */
+type VariantSchemeEntry<TVariant extends string, TProps extends NtvProps> = {
+    [V in TVariant]?: ClassValue | (SchemeFor<TProps> & {
+        $default?: ClassValue;
+    });
+} & {
+    $default?: ClassValue;
+};
+/**
+ * Scheme conditions based on the props type.
+ * Maps each prop to its appropriate scheme entry type.
+ */
+type SchemeConditions<TProps extends NtvProps> = {
+    [K in keyof TProps & string]?: TProps[K] extends boolean ? BooleanSchemeEntry<TProps> : TProps[K] extends string ? VariantSchemeEntry<TProps[K], TProps> : never;
+};
+/**
+ * Main scheme type for NTV style definitions.
+ * Validated against TProps to ensure type safety.
+ */
+export type SchemeFor<TProps extends NtvProps> = {
+    $base?: ClassValue;
+    $default?: ClassValue;
+} & SchemeConditions<TProps>;
+/**
+ * Runtime scheme interface for NTV style definitions.
+ * Untyped version used for JavaScript or when types aren't available.
+ */
+export interface NtvScheme {
+    $base?: ClassValue;
+    $default?: ClassValue;
+    [key: string]: unknown;
+}
+export type TwMergeConfig = Parameters<typeof extendTailwindMerge>[0];
+/**
+ * Configuration options for NTV function behavior.
+ */
+export interface NtvOptions {
     /**
-     * Whether to use `tailwind-merge` to resolve conflicting Tailwind classes.
+     * Whether to merge the class names with `tailwind-merge` library.
+     * It's avoid to have duplicate tailwind classes. (Recommended)
      * @see https://github.com/dcastil/tailwind-merge
      * @default true
      */
     twMerge?: boolean;
     /**
-     * Custom configuration for `tailwind-merge`.
+     * The config object for `tailwind-merge` library.
      * @see https://github.com/dcastil/tailwind-merge/blob/main/docs/configuration.md
      */
-    twMergeConfig?: TWMergeConfig;
+    twMergeConfig?: TwMergeConfig;
 }
-export type StyleFunction<P = Record<string, unknown>> = (props: Partial<P>) => string;
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAErD,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEtE,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,IAAI,UAAU,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAExF,YAAY,EAAE,UAAU,EAAE,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,SAAS,GACjB;IAAE,KAAK,CAAC,EAAE,UAAU,CAAC;IAAC,SAAS,CAAC,EAAE,KAAK,CAAA;CAAE,GACzC;IAAE,KAAK,CAAC,EAAE,KAAK,CAAC;IAAC,SAAS,CAAC,EAAE,UAAU,CAAA;CAAE,CAAC;AAE9C;;;GAGG;AAEH,MAAM,WAAW,QAAQ;CAAG;AAE5B;;;GAGG;AACH,KAAK,UAAU,CAAC,CAAC,IAAI;KAClB,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,MAAM,CAAC,GAAG,KAAK,GAAG,CAAC,SAAS,OAAO,GACzD,CAAC,SAAS,MAAM,CAAC,GACf,CAAC,CAAC,CAAC,CAAC,GACJ,KAAK,GACP,KAAK;CACV,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,SAAS,aAAa,CAAC,GAAG,CAAC,EAAE,IAAI,UAAU,CACvF;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAChE,CAAC,MAAM,CAAC,CACV,CAAC;AAEF;;;GAGG;AACH,KAAK,oBAAoB,CAAC,CAAC,IAAI;KAC5B,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS;CAClC,CAAC;AAEF;;GAEG;AACH,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,MAAM,IAAI,CAClC,KAAK,CAAC,EAAE,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,KACvD,MAAM,CAAC;AAEZ;;GAEG;AACH,KAAK,kBAAkB,CAAC,MAAM,SAAS,QAAQ,IAC3C,UAAU,GACV,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC;AAEpD;;GAEG;AACH,KAAK,kBAAkB,CAAC,QAAQ,SAAS,MAAM,EAAE,MAAM,SAAS,QAAQ,IAAI;KACzE,CAAC,IAAI,QAAQ,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,UAAU,CAAA;KAAE,CAAC;CAC/E,GAAG;IAAE,QAAQ,CAAC,EAAE,UAAU,CAAA;CAAE,CAAC;AAE9B;;;GAGG;AACH,KAAK,gBAAgB,CAAC,MAAM,SAAS,QAAQ,IAAI;KAC9C,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,OAAO,GACpD,kBAAkB,CAAC,MAAM,CAAC,GAC1B,MAAM,CAAC,CAAC,CAAC,SAAS,MAAM,GACtB,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GACrC,KAAK;CACZ,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,MAAM,SAAS,QAAQ,IAAI;IAC/C,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,QAAQ,CAAC,EAAE,UAAU,CAAC;CACvB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAE7B;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B"}

package/dist/types.js

@@ -1,2 +1,2 @@
-import { extendTailwindMerge } from 'tailwind-merge';
+export {};
 //# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nestable-tailwind-variants",
-  "version": "0.1.4",
-  "description": "A variant styling library for Tailwind CSS that expresses complex style combinations through nested condition definitions instead of flat `compoundVariants` patterns.",
+  "version": "0.2.0",
+  "description": "Tailwind CSS variant library with nestable conditions for compound styling instead of flat compoundVariants.",
   "homepage": "https://github.com/yuheiy/nestable-tailwind-variants#readme",
   "bugs": {
     "url": "https://github.com/yuheiy/nestable-tailwind-variants/issues"
@@ -26,9 +26,10 @@
   "devDependencies": {
     "@commitlint/cli": "^20.3.1",
     "@commitlint/config-conventional": "^20.3.1",
-    "bumpp": "^10.3.2",
+    "bumpp": "^10.4.0",
+    "knip": "^5.82.0",
     "lint-staged": "^16.2.7",
-    "oxfmt": "^0.24.0",
+    "oxfmt": "^0.25.0",
     "oxlint": "^1.39.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.17",
@@ -46,14 +47,15 @@
     }
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -p tsconfig.build.json",
     "clean": "git clean -fx dist/",
     "format": "oxfmt",
     "format:check": "oxfmt --check",
+    "knip": "knip",
     "lint": "oxlint",
     "lint:fix": "oxlint --fix",
     "release": "bumpp -r",
-    "test": "vitest",
+    "test": "vitest --run",
     "typecheck": "tsc --noEmit"
   }
 }

package/dist/composeNtv.d.ts

@@ -1,47 +0,0 @@
-import type { NTVConfig, StyleFunction } from './types.js';
-type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-type ExtractProps<T> = T extends StyleFunction<infer P> ? P : never;
-/**
- * Creates a customized `composeNtv` function with the specified options.
- *
- * @example
- * ```ts
- * // Disable tailwind-merge
- * const composeNtvNoMerge = createComposeNtv({ twMerge: false });
- *
- * // With custom tailwind-merge config
- * const customComposeNtv = createComposeNtv({
- *   twMergeConfig: {
- *     extend: {
- *       theme: {
- *         shadow: ['100', '200', '300'],
- *       },
- *     },
- *   },
- * });
- * ```
- */
-export declare function createComposeNtv(options?: NTVConfig): <T extends StyleFunction[]>(...fns: T) => StyleFunction<UnionToIntersection<ExtractProps<T[number]>>>;
-/**
- * Composes multiple style functions into a single function.
- *
- * @example
- * ```ts
- * const baseButton = ntv<{ size?: 'sm' | 'lg' }>({
- *   default: 'rounded font-medium',
- *   size: { sm: 'px-2 py-1 text-sm', lg: 'px-4 py-2 text-lg' },
- * });
- *
- * const coloredButton = ntv<{ variant?: 'primary' | 'secondary' }>({
- *   variant: { primary: 'bg-blue-500 text-white', secondary: 'bg-gray-200' },
- * });
- *
- * const button = composeNtv(baseButton, coloredButton);
- *
- * button({ size: 'lg', variant: 'primary' });
- * // => 'rounded font-medium px-4 py-2 text-lg bg-blue-500 text-white'
- * ```
- */
-export declare const composeNtv: <T extends StyleFunction[]>(...fns: T) => StyleFunction<UnionToIntersection<ExtractProps<T[number]>>>;
-export {};
-//# sourceMappingURL=composeNtv.d.ts.map

package/dist/composeNtv.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"composeNtv.d.ts","sourceRoot":"","sources":["../src/composeNtv.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3D,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CACjF,CAAC,EAAE,MAAM,CAAC,KACP,IAAI,GACL,CAAC,GACD,KAAK,CAAC;AAEV,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,GAAE,SAAc,IAS3B,CAAC,SAAS,aAAa,EAAE,EAClD,GAAG,KAAK,CAAC,KACR,aAAa,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAG/D;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,UAAU,GA3BM,CAAC,SAAS,aAAa,EAAE,UAC1C,CAAC,KACR,aAAa,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAyBnB,CAAC"}

package/dist/composeNtv.js

@@ -1,55 +0,0 @@
-import { extendTailwindMerge, twMerge } from 'tailwind-merge';
-import { joinClasses } from './utils.js';
-/**
- * Creates a customized `composeNtv` function with the specified options.
- *
- * @example
- * ```ts
- * // Disable tailwind-merge
- * const composeNtvNoMerge = createComposeNtv({ twMerge: false });
- *
- * // With custom tailwind-merge config
- * const customComposeNtv = createComposeNtv({
- *   twMergeConfig: {
- *     extend: {
- *       theme: {
- *         shadow: ['100', '200', '300'],
- *       },
- *     },
- *   },
- * });
- * ```
- */
-export function createComposeNtv(options = {}) {
-    const { twMerge: useTwMerge = true, twMergeConfig } = options;
-    const mergeClasses = useTwMerge
-        ? twMergeConfig
-            ? extendTailwindMerge(twMergeConfig)
-            : twMerge
-        : joinClasses;
-    return function composeNtv(...fns) {
-        return (props) => mergeClasses(...fns.map((fn) => fn(props)));
-    };
-}
-/**
- * Composes multiple style functions into a single function.
- *
- * @example
- * ```ts
- * const baseButton = ntv<{ size?: 'sm' | 'lg' }>({
- *   default: 'rounded font-medium',
- *   size: { sm: 'px-2 py-1 text-sm', lg: 'px-4 py-2 text-lg' },
- * });
- *
- * const coloredButton = ntv<{ variant?: 'primary' | 'secondary' }>({
- *   variant: { primary: 'bg-blue-500 text-white', secondary: 'bg-gray-200' },
- * });
- *
- * const button = composeNtv(baseButton, coloredButton);
- *
- * button({ size: 'lg', variant: 'primary' });
- * // => 'rounded font-medium px-4 py-2 text-lg bg-blue-500 text-white'
- * ```
- */
-export const composeNtv = createComposeNtv();
-//# sourceMappingURL=composeNtv.js.map

package/dist/composeNtv.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"composeNtv.js","sourceRoot":"","sources":["../src/composeNtv.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAE9D,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAUzC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,gBAAgB,CAAC,UAAqB,EAAE;IACtD,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAE9D,MAAM,YAAY,GAAG,UAAU;QAC7B,CAAC,CAAC,aAAa;YACb,CAAC,CAAC,mBAAmB,CAAC,aAAa,CAAC;YACpC,CAAC,CAAC,OAAO;QACX,CAAC,CAAC,WAAW,CAAC;IAEhB,OAAO,SAAS,UAAU,CACxB,GAAG,GAAM;QAET,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,EAAE,CAAC"}

package/dist/utils.d.ts

@@ -1,2 +0,0 @@
-export declare function joinClasses(...classes: string[]): string;
-//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAExD"}

package/dist/utils.js

@@ -1,4 +0,0 @@
-export function joinClasses(...classes) {
-    return classes.join(' ');
-}
-//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,WAAW,CAAC,GAAG,OAAiB;IAC9C,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC"}