feat: add memoization and update types

Adds memoization and updates types to comply with alpha version of @dash-ui/styles

BREAKING CHANGE: `styles` instances are now required as a first argument in the initializer

Author: jaredLunde

README.md

@@ -39,7 +39,7 @@ npm i @dash-ui/mq
 import mq from "@dash-ui/mq";
 import { styles } from "@dash-ui/styles";
 
-const breakpoint = mq({
+const breakpoint = mq(styles, {
   // 0px
   sm: "only screen and (min-width: 0em)",
   // 560px
@@ -87,7 +87,7 @@ import mq from "@dash-ui/mq";
 import { styles } from "@dash-ui/styles";
 
 // Creates the stored media queries
-const breakpoint = mq({
+const breakpoint = mq(styles, {
   sm: "only screen and (min-width: 0em)",
   mq: "only screen and (min-width: 35em)",
   lg: "only screen and (min-width: 80em)",
@@ -145,65 +145,33 @@ const Component = () => (
 ```typescript
 function mq<
   Tokens extends DashTokens = DashTokens,
+  Themes extends DashThemes = DashThemes,
   QueryNames extends string = string
 >(
+  styles: Styles<Tokens, Themes>,
   mediaQueries: MediaQueries<QueryNames>
-): MediaQueryCssCallback<QueryNames, Tokens>;
-function mq<
-  Tokens extends DashTokens = DashTokens,
-  QueryNames extends string = string
->(
-  mediaQueries: MediaQueries<QueryNames>
-): MediaQueryNameCallback<QueryNames, Tokens>;
+): {
+  (queryName: QueryNames): string;
+  (queryName: MediaQueryObject<QueryNames, Tokens, Themes>): (
+    tokens: TokensUnion<Tokens, Themes>
+  ) => string;
+};
 ```
 
 | Argument     | Type                                   | Required? | Description                           |
 | ------------ | -------------------------------------- | --------- | ------------------------------------- |
+| styles       | `styles`                               | Yes       | A Dash `styles` instance              |
 | mediaQueries | `{readonly [K in QueryNames]: string}` | Yes       | A map of media query name/query pairs |
 
 #### Returns
 
 ```typescript
 // When a `string` is provided as the `mediaQueries` argument, this
 // will return a `MediaQueryNameCallback`, otherwise a `MediaQueryCssCallback`
+function mqStyles(queryName: QueryNames): string;
 function mqStyles(
-  queryName: QueryNames | MediaQueryObject<QueryNames, Tokens>
-): MediaQueryNameCallback | MediaQueryCssCallback;
-```
-
-### MediaQueryNameCallback
-
-A function that returns a media query string e.g. `"@media only screen and (min-width: 0em)"`.
-
-```typescript
-type MediaQueryNameCallback<
-  QueryNames extends string,
-  Tokens extends DashTokens = DashTokens
-> = (queryName: QueryNames | MediaQueryObject<QueryNames, Tokens>) => string;
-```
-
-### MediaQueryCssCallback
-
-A style callback which can be provided to any [`@dash-ui/styles`](https://github.com/dash-ui/styles)
-functions that accept one. i.e. `styles()`, `styles.one()`, `styles.cls()`, and `styles.insertGlobal()`
-
-```typescript
-type MediaQueryCssCallback<
-  QueryNames extends string,
-  Tokens extends DashTokens = DashTokens
-> = (
-  queryName: QueryNames | MediaQueryObject<QueryNames, Tokens>
-) => (tokens: Tokens) => string;
-
-export type MediaQueryObject<
-  QueryNames extends string,
-  Tokens extends DashTokens = DashTokens
-> = {
-  readonly [K in QueryNames | "default"]?:
-    | string
-    | StyleObject
-    | StyleCallback<Tokens>;
-};
+  queryName: MediaQueryObject<QueryNames, Tokens, Themes>
+): (tokens: TokensUnion<Tokens, Themes>) => string;
 ```
 
 ## LICENSE

package.json

@@ -110,7 +110,7 @@
   "devDependencies": {
     "@commitlint/cli": "latest",
     "@commitlint/config-conventional": "latest",
-    "@dash-ui/styles": "^0.8.0",
+    "@dash-ui/styles": "^1.0.0-alpha.1",
     "@semantic-release/changelog": "^6.0.0",
     "@semantic-release/git": "^10.0.0",
     "@swc-node/core": "^1.6.0",
@@ -126,11 +126,20 @@
     "prettier": "latest",
     "typescript": "latest"
   },
+  "peerDependencies": {
+    "@dash-ui/styles": ">=1.0.0-alpha.1"
+  },
   "release": {
     "branches": [
       "main",
-      "next",
-      "alpha"
+      {
+        "name": "next",
+        "prerelease": true
+      },
+      {
+        "name": "alpha",
+        "prerelease": true
+      }
     ],
     "plugins": [
       "@semantic-release/commit-analyzer",