nestable-tailwind-variants 0.1.3 → 0.2.0

package/dist/resolver.js

@@ -0,0 +1,52 @@
+function isObject(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+/**
+ * Resolves conditions from scheme based on provided props to generate class values.
+ *
+ * $default behavior:
+ * - If no conditions match at a level, that level's $default is applied
+ * - If a variant matches, only the nested evaluation result is used
+ * - When no conditions match, $defaults accumulate from each unmatched level
+ */
+export function resolveConditions({ $default, ...conditions }, props) {
+    const classes = [];
+    let hasMatchedCondition = false;
+    function addClasses(value) {
+        if (isObject(value)) {
+            classes.push(...resolveConditions(value, props));
+        }
+        else {
+            classes.push(value);
+        }
+    }
+    for (const [key, value] of Object.entries(conditions)) {
+        const propValue = props[key];
+        if (propValue === '$default') {
+            throw new Error(`The value "$default" cannot be passed as a runtime value for "${key}". "$default" is a reserved keyword.`);
+        }
+        // Boolean conditions (isXxx or allowsXxx)
+        if (/^is[A-Z]/.test(key) || /^allows[A-Z]/.test(key)) {
+            if (propValue) {
+                hasMatchedCondition = true;
+                addClasses(value);
+            }
+            continue;
+        }
+        // Variant conditions (nested objects)
+        if (isObject(value)) {
+            if (typeof propValue === 'string' && propValue in value) {
+                hasMatchedCondition = true;
+                addClasses(value[propValue]);
+            }
+            else {
+                classes.push(value['$default']);
+            }
+        }
+    }
+    if (!hasMatchedCondition) {
+        classes.unshift($default);
+    }
+    return classes;
+}
+//# sourceMappingURL=resolver.js.map

package/dist/resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.js","sourceRoot":"","sources":["../src/resolver.ts"],"names":[],"mappings":"AAEA,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,EAAE,QAAQ,EAAE,GAAG,UAAU,EAA2B,EACpD,KAA8B;IAE9B,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,IAAI,mBAAmB,GAAG,KAAK,CAAC;IAEhC,SAAS,UAAU,CAAC,KAAc;QAChC,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,KAAmB,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACtD,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAE7B,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,iEAAiE,GAAG,sCAAsC,CAC3G,CAAC;QACJ,CAAC;QAED,0CAA0C;QAC1C,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACrD,IAAI,SAAS,EAAE,CAAC;gBACd,mBAAmB,GAAG,IAAI,CAAC;gBAC3B,UAAU,CAAC,KAAK,CAAC,CAAC;YACpB,CAAC;YACD,SAAS;QACX,CAAC;QAED,sCAAsC;QACtC,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;gBACxD,mBAAmB,GAAG,IAAI,CAAC;gBAC3B,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAe,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACzB,OAAO,CAAC,OAAO,CAAC,QAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,110 @@
+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 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;
+    /**
+     * The config object for `tailwind-merge` library.
+     * @see https://github.com/dcastil/tailwind-merge/blob/main/docs/configuration.md
+     */
+    twMergeConfig?: TwMergeConfig;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"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.3",
-  "description": "A variant styling library for Tailwind CSS that supports nested condition definitions.",
+  "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,17 +26,18 @@
   "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.23.0",
-    "oxlint": "^1.38.0",
+    "oxfmt": "^0.25.0",
+    "oxlint": "^1.39.0",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.16",
+    "vitest": "^4.0.17",
     "node": "runtime:^24.12.0"
   },
   "lint-staged": {
     "*": "oxfmt --no-error-on-unmatched-pattern",
-    "*.{js,jsx,ts,tsx,mjs,cjs}": "pnpm run lint"
+    "*.{js,jsx,ts,tsx,mjs,cjs}": "node --run lint"
   },
   "devEngines": {
     "runtime": {
@@ -46,13 +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"
   }
 }