@compiled/react 0.16.4 → 0.16.5

package/dist/browser/create-strict-api/index.d.ts

@@ -9,7 +9,9 @@ type EnforceSchema<TObject> = {
 type PickObjects<TObject> = {
     [P in keyof TObject]: TObject[P] extends Record<string, unknown> ? TObject[P] : never;
 };
-interface CompiledAPI<TSchema> {
+type CSSStyles<TSchema extends CompiledSchema> = StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>;
+type CSSMapStyles<TSchema extends CompiledSchema> = Record<string, CSSStyles<TSchema>>;
+interface CompiledAPI<TSchema extends CompiledSchema> {
     /**
      * ## CSS
      *
@@ -25,7 +27,7 @@ interface CompiledAPI<TSchema> {
      * <div css={redText} />
      * ```
      */
-    css(styles: StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>): StrictCSSProperties;
+    css(styles: CSSStyles<TSchema>): StrictCSSProperties;
     /**
      * ## CSS Map
      *
@@ -42,8 +44,8 @@ interface CompiledAPI<TSchema> {
      * <div css={styles.solid} />
      * ```
      */
-    cssMap<TStyles extends Record<string, StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>>>(styles: TStyles): {
-        readonly [P in keyof TStyles]: CompiledStyles<TStyles[P]>;
+    cssMap<TStylesMap extends CSSMapStyles<TSchema>>(styles: CSSMapStyles<TSchema>): {
+        readonly [P in keyof TStylesMap]: CompiledStyles<TStylesMap[P]>;
     };
     /**
      * ## CX

package/dist/cjs/create-strict-api/index.d.ts

@@ -9,7 +9,9 @@ type EnforceSchema<TObject> = {
 type PickObjects<TObject> = {
     [P in keyof TObject]: TObject[P] extends Record<string, unknown> ? TObject[P] : never;
 };
-interface CompiledAPI<TSchema> {
+type CSSStyles<TSchema extends CompiledSchema> = StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>;
+type CSSMapStyles<TSchema extends CompiledSchema> = Record<string, CSSStyles<TSchema>>;
+interface CompiledAPI<TSchema extends CompiledSchema> {
     /**
      * ## CSS
      *
@@ -25,7 +27,7 @@ interface CompiledAPI<TSchema> {
      * <div css={redText} />
      * ```
      */
-    css(styles: StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>): StrictCSSProperties;
+    css(styles: CSSStyles<TSchema>): StrictCSSProperties;
     /**
      * ## CSS Map
      *
@@ -42,8 +44,8 @@ interface CompiledAPI<TSchema> {
      * <div css={styles.solid} />
      * ```
      */
-    cssMap<TStyles extends Record<string, StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>>>(styles: TStyles): {
-        readonly [P in keyof TStyles]: CompiledStyles<TStyles[P]>;
+    cssMap<TStylesMap extends CSSMapStyles<TSchema>>(styles: CSSMapStyles<TSchema>): {
+        readonly [P in keyof TStylesMap]: CompiledStyles<TStylesMap[P]>;
     };
     /**
      * ## CX

package/dist/esm/create-strict-api/index.d.ts

@@ -9,7 +9,9 @@ type EnforceSchema<TObject> = {
 type PickObjects<TObject> = {
     [P in keyof TObject]: TObject[P] extends Record<string, unknown> ? TObject[P] : never;
 };
-interface CompiledAPI<TSchema> {
+type CSSStyles<TSchema extends CompiledSchema> = StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>;
+type CSSMapStyles<TSchema extends CompiledSchema> = Record<string, CSSStyles<TSchema>>;
+interface CompiledAPI<TSchema extends CompiledSchema> {
     /**
      * ## CSS
      *
@@ -25,7 +27,7 @@ interface CompiledAPI<TSchema> {
      * <div css={redText} />
      * ```
      */
-    css(styles: StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>): StrictCSSProperties;
+    css(styles: CSSStyles<TSchema>): StrictCSSProperties;
     /**
      * ## CSS Map
      *
@@ -42,8 +44,8 @@ interface CompiledAPI<TSchema> {
      * <div css={styles.solid} />
      * ```
      */
-    cssMap<TStyles extends Record<string, StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>>>(styles: TStyles): {
-        readonly [P in keyof TStyles]: CompiledStyles<TStyles[P]>;
+    cssMap<TStylesMap extends CSSMapStyles<TSchema>>(styles: CSSMapStyles<TSchema>): {
+        readonly [P in keyof TStylesMap]: CompiledStyles<TStylesMap[P]>;
     };
     /**
      * ## CX

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compiled/react",
-  "version": "0.16.4",
+  "version": "0.16.5",
   "description": "A familiar and performant compile time CSS-in-JS library for React.",
   "keywords": [
     "compiled",

package/src/create-strict-api/__tests__/__fixtures__/strict-api.ts

@@ -1,4 +1,4 @@
-import { createStrictAPI } from '@compiled/react';
+import { createStrictAPI } from '../../index';
 
 const { css, XCSSProp, cssMap, cx } = createStrictAPI<{
   '&:hover': {

package/src/create-strict-api/__tests__/index.test.tsx

@@ -86,6 +86,56 @@ describe('createStrictAPI()', () => {
 
       expect(getByTestId('div')).toHaveCompiledCss('all', 'inherit');
     });
+
+    it('should type error with css properties not in the style scope', () => {
+      // NOTE: These are split into mutliple `css()` calls to ensure the type errors are not hidden
+      // as only one will error at a time when combined into one query
+
+      const bgStyles = css({
+        fontWeight: 'bold', // just a valid property to ensure the `extends` keyword isn't working as intended
+        // @ts-expect-error - Object literal may only specify known properties, and 'bg' does not exist in type …
+        bg: 'red',
+      });
+
+      const colourStyles = css({
+        fontWeight: 'bold', // just a valid property to ensure the `extends` keyword isn't working as intended
+        // @ts-expect-error - Object literal may only specify known properties, and 'colour' does not exist in type …
+        colour: 'var(--ds-text)',
+      });
+
+      const hoverStyles = css({
+        fontWeight: 'bold', // just a valid property to ensure the `extends` keyword isn't working as intended
+        '&:hover': {
+          fontWeight: 'bold', // just a valid property to ensure the `extends` keyword isn't working as intended
+          // @ts-expect-error - Object literal may only specify known properties, and 'colour' does not exist in type …
+          colour: 'var(--ds-text-hover)',
+        },
+      });
+
+      const invalidPsuedoStyles = css({
+        fontWeight: 'bold', // just a valid property to ensure the `extends` keyword isn't working as intended
+        // @ts-expect-error - bject literal may only specify known properties, and ''&:invalid-pseudo'' does not exist in type …
+        '&:invalid-pseudo': {
+          color: 'var(--ds-text)',
+        },
+      });
+
+      const { getByTestId } = render(
+        <div css={[bgStyles, colourStyles, hoverStyles, invalidPsuedoStyles]} data-testid="div" />
+      );
+
+      expect(getByTestId('div')).toHaveCompiledCss('font-weight', 'bold');
+      expect(getByTestId('div')).toHaveCompiledCss('font-weight', 'bold', {
+        target: ':hover',
+      });
+
+      // These still get compiled to css, even if they're not valid
+      expect(getByTestId('div')).toHaveCompiledCss('bg', 'red');
+      expect(getByTestId('div')).toHaveCompiledCss('colour', 'var(--ds-text)');
+      expect(getByTestId('div')).toHaveCompiledCss('colour', 'var(--ds-text-hover)', {
+        target: ':hover',
+      });
+    });
   });
 
   describe('cssMap()', () => {
@@ -152,6 +202,72 @@ describe('createStrictAPI()', () => {
 
       expect(getByTestId('div')).toHaveCompiledCss('val', 'ok', { target: ':hover' });
     });
+
+    it('should type error with css properties not in the style scope', () => {
+      // NOTE: These are split into mutliple `css()` calls to ensure the type errors are not hidden
+      // as only one will error at a time when combined into one query
+
+      const bgStyles = cssMap({
+        primary: {
+          fontWeight: 'bold', // just a valid property to ensure the `extends` keyword isn't working as intended
+          // @ts-expect-error - Object literal may only specify known properties, and 'bg' does not exist in type …
+          bg: 'red',
+        },
+      });
+
+      const colourStyles = cssMap({
+        primary: {
+          fontWeight: 'bold', // just a valid property to ensure the `extends` keyword isn't working as intended
+          // @ts-expect-error - Object literal may only specify known properties, and 'colour' does not exist in type …
+          colour: 'var(--ds-text)',
+        },
+      });
+
+      const hoverStyles = cssMap({
+        primary: {
+          fontWeight: 'bold', // just a valid property to ensure the `extends` keyword isn't working as intended
+          '&:hover': {
+            fontWeight: 'bold', // just a valid property to ensure the `extends` keyword isn't working as intended
+            // @ts-expect-error - Object literal may only specify known properties, and 'colour' does not exist in type …
+            colour: 'var(--ds-text-hover)',
+          },
+        },
+      });
+
+      const invalidPsuedoStyles = cssMap({
+        primary: {
+          fontWeight: 'bold', // just a valid property to ensure the `extends` keyword isn't working as intended
+          // @ts-expect-error - bject literal may only specify known properties, and ''&:invalid-pseudo'' does not exist in type …
+          '&:invalid-pseudo': {
+            color: 'var(--ds-text)',
+          },
+        },
+      });
+
+      const { getByTestId } = render(
+        <div
+          css={[
+            bgStyles.primary,
+            colourStyles.primary,
+            hoverStyles.primary,
+            invalidPsuedoStyles.primary,
+          ]}
+          data-testid="div"
+        />
+      );
+
+      expect(getByTestId('div')).toHaveCompiledCss('font-weight', 'bold');
+      expect(getByTestId('div')).toHaveCompiledCss('font-weight', 'bold', {
+        target: ':hover',
+      });
+
+      // These still get compiled to css, even if they're not valid
+      expect(getByTestId('div')).toHaveCompiledCss('bg', 'red');
+      expect(getByTestId('div')).toHaveCompiledCss('colour', 'var(--ds-text)');
+      expect(getByTestId('div')).toHaveCompiledCss('colour', 'var(--ds-text-hover)', {
+        target: ':hover',
+      });
+    });
   });
 
   describe('XCSSProp', () => {

package/src/create-strict-api/index.ts

@@ -18,7 +18,12 @@ type PickObjects<TObject> = {
   [P in keyof TObject]: TObject[P] extends Record<string, unknown> ? TObject[P] : never;
 };
 
-interface CompiledAPI<TSchema> {
+type CSSStyles<TSchema extends CompiledSchema> = StrictCSSProperties &
+  PseudosDeclarations &
+  EnforceSchema<TSchema>;
+type CSSMapStyles<TSchema extends CompiledSchema> = Record<string, CSSStyles<TSchema>>;
+
+interface CompiledAPI<TSchema extends CompiledSchema> {
   /**
    * ## CSS
    *
@@ -34,9 +39,7 @@ interface CompiledAPI<TSchema> {
    * <div css={redText} />
    * ```
    */
-  css(
-    styles: StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>
-  ): StrictCSSProperties;
+  css(styles: CSSStyles<TSchema>): StrictCSSProperties;
   /**
    * ## CSS Map
    *
@@ -53,15 +56,12 @@ interface CompiledAPI<TSchema> {
    * <div css={styles.solid} />
    * ```
    */
-  cssMap<
-    TStyles extends Record<
-      string,
-      StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>
-    >
-  >(
-    styles: TStyles
+  cssMap<TStylesMap extends CSSMapStyles<TSchema>>(
+    // NOTE: This should match the generic `TStylesMap extends …` as we want this arg to strictly satisfy this type, not just extend it.
+    // The "extends" functionality is to infer and build the return type, this is to enforce the input type.
+    styles: CSSMapStyles<TSchema>
   ): {
-    readonly [P in keyof TStyles]: CompiledStyles<TStyles[P]>;
+    readonly [P in keyof TStylesMap]: CompiledStyles<TStylesMap[P]>;
   };
   /**
    * ## CX