@crowdstrike/tailwind-toucan-base 3.2.0 → 3.2.1

package/{src/theme-data.d.ts → index.d.ts}

@@ -1,4 +1,5 @@
-declare let ThemeData = {
+// Strict type for the themes.json structure
+      interface ThemeData {
   "themes": {
     "dark": {
       "cssSelector": ".theme-dark",
@@ -2705,6 +2706,47 @@ declare let ThemeData = {
       ]
     }
   }
-};
+}
 
-      export default ThemeData;
+      // Full Built CSS
+      declare module '@crowdstrike/tailwind-toucan-base/index.css';
+      declare module '@crowdstrike/tailwind-toucan-base/toucan.css';
+
+
+      // Raw Theme JSON -- also available as theme-data.js
+      declare module '@crowdstrike/tailwind-toucan-base/themes' {
+        export = ThemeData;
+      }
+      declare module '@crowdstrike/tailwind-toucan-base/themes.json' {
+        export = ThemeData;
+      }
+
+      // Tailwind Config
+      declare module '@crowdstrike/tailwind-toucan-base';
+
+      declare module '@crowdstrike/tailwind-toucan-base/theme-data' {
+        /**
+          * Utility type which describes the shape and properties of a particular color.
+          */
+        export interface ColorInfo {
+          category: string[];
+          hasAlpha: boolean;
+          rgbFill: string;
+          fill: {
+            r: number;
+            g: number;
+            b: number;
+            a: number;
+          };
+          name: string;
+          value: string;
+        }
+
+        const _ThemeData: ThemeData;
+
+        /**
+          * The data from the generated theme.json document containing all of the
+          * Toucan colors, shadows, etc
+          */
+        export default _ThemeData;
+      }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdstrike/tailwind-toucan-base",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "private": false,
   "description": "Tailwind preset for CrowdStrike's Toucan design system",
   "repository": "https://github.com/CrowdStrike/tailwind-toucan-base",
@@ -9,6 +9,7 @@
   "main": "src/tailwind.config.js",
   "files": [
     "src",
+    "index.d.ts",
     "index.css",
     "themes.json",
     "toucan.css"
@@ -21,11 +22,17 @@
   },
   "typesVersions": {
     "*": {
-      "types": [
-        "./src/types.d.ts"
+      "*": [
+        "./index.d.ts"
+      ],
+      "themes": [
+        "./index.d.ts"
+      ],
+      "themes.json": [
+        "./index.d.ts"
       ],
       "theme-data": [
-        "./src/theme-data.d.ts"
+        "./index.d.ts"
       ]
     }
   },
@@ -48,7 +55,7 @@
   },
   "devDependencies": {
     "@figma-export/cli": "4.4.0",
-    "@nullvoxpopuli/eslint-configs": "2.2.33",
+    "@nullvoxpopuli/eslint-configs": "2.2.34",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
     "@types/fs-extra": "^9.0.13",
@@ -64,7 +71,7 @@
     "semantic-release": "^19.0.3",
     "tailwind-config-viewer": "^1.7.1",
     "typescript": "^4.7.4",
-    "vitest": "0.17.0"
+    "vitest": "0.18.0"
   },
   "engines": {
     "node": ">=14.15.0"
@@ -88,7 +95,7 @@
   },
   "packageManager": "pnpm@7.5.0",
   "volta": {
-    "node": "16.15.0",
+    "node": "16.16.0",
     "yarn": "1.22.19",
     "npm": "8.13.2"
   }

package/src/types.d.ts

@@ -1,48 +0,0 @@
-/**
- * Generic loosley typed version of the strict types provided by
- * ```ts
- * import type ThemeData from '@crowdstrike/tailwind-toucan-base/theme-data';
- * ```
- */
-export interface ColorInfo {
-  category: string[];
-  hasAlpha: boolean;
-  rgbFill: string;
-  fill: {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-  };
-  name: string;
-  value: string;
-}
-
-/**
- * Generic loosley typed version of the strict types provided by
- * ```ts
- * import type ThemeData from '@crowdstrike/tailwind-toucan-base/theme-data';
- * ```
- */
-export interface Theme {
-  colors: ColorInfo[];
-  cssSelector: string;
-  shadows: Array<{
-    name: string;
-    effects: string[];
-  }>;
-}
-
-/**
- * Generic loosley typed version of the strict types provided by
- * ```ts
- * import type ThemeData from '@crowdstrike/tailwind-toucan-base/theme-data';
- * ```
- */
-export interface ThemeData {
-  aliases: { name: string; value: string }[];
-  themes: {
-    dark: Theme;
-    light: Theme;
-  };
-}