@spark-ui/theme-utils 2.3.1 → 2.4.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.4.0](https://github.com/adevinta/spark/compare/@spark-ui/theme-utils@2.3.2...@spark-ui/theme-utils@2.4.0) (2023-02-24)
+
+### Features
+
+- **cli-utils:** flattened cli args for theme config ([ccb13de](https://github.com/adevinta/spark/commit/ccb13de785f2d6d2f8893bdff83b032af6416a38))
+
+## [2.3.2](https://github.com/adevinta/spark/compare/@spark-ui/theme-utils@2.3.1...@spark-ui/theme-utils@2.3.2) (2023-02-24)
+
+**Note:** Version bump only for package @spark-ui/theme-utils
+
 ## [2.3.1](https://github.com/adevinta/spark/compare/@spark-ui/theme-utils@2.3.0...@spark-ui/theme-utils@2.3.1) (2023-02-24)
 
 **Note:** Version bump only for package @spark-ui/theme-utils

package/dist/createTheme.d.ts

@@ -1,9 +1,9 @@
 import { type Theme } from './types';
 /**
- * Create a custom theme by merging the default theme with a partial custom theme passed as an argument.
+ * Creates a custom theme by merging the default theme with a partial custom theme passed as an argument.
  *
- * @param theme - A partial theme object of type Partial<Theme> which holds the theme values that need to be customized or overridden
- * @param fromTheme - Use this argument if you want to derivate your theme from another theme (instead of Spark's default theme)
+ * @param {Partial<Theme>} theme - A partial theme object which holds the theme values that need to be customized or overridden. When a category is included in the `theme` parameter, all of the category's tokens must be overridden.
+ * @param {Theme} [fromTheme=defaultTheme] - (Optional) A theme object from which to derive the new custom theme (instead of Spark's `defaultTheme`)
  *
  * @example
  *

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { createTheme } from './createTheme';
 export { defaultTheme } from './defaultTheme';
 export { defaultThemeDark } from './defaultThemeDark';
-export type { Theme } from './types';
+export type { Theme, ThemeConfig } from './types';

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import { RequireAtLeastOne } from 'type-fest';
 export interface Theme {
     screens: {
         sm: string;
@@ -181,3 +182,8 @@ export interface Theme {
         tooltip: number;
     };
 }
+export interface ThemeConfig {
+    tailwindThemeConfigPath: string;
+    tailwindCSSPath: string;
+    themes: RequireAtLeastOne<Record<string, Theme>, 'default'>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spark-ui/theme-utils",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "package for managing Spark theme configuration",
   "publishConfig": {
     "access": "public"
@@ -20,5 +20,5 @@
     "url": "git@github.com:adevinta/spark.git",
     "directory": "packages/utils/theme"
   },
-  "gitHead": "ef9e9e64bcaf2c2527725d995c9329c5672ac82b"
+  "gitHead": "f21e13f33295a0f0c73726c2f46732993bdf9d72"
 }