@compiled/react 0.16.4 → 0.16.6

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> & TStylesMap): {
+        readonly [P in keyof TStylesMap]: CompiledStyles<TStylesMap[P]>;
     };
     /**
      * ## CX

package/dist/browser/create-strict-api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/create-strict-api/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAuB,EAAE,EAA0B,MAAM,cAAc,CAAC;AA+J/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO;QACL,GAAG;YACD,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;QACD,MAAM;YACJ,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;QACD,EAAE;QACF,QAAQ;YACN,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/create-strict-api/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAuB,EAAE,EAA0B,MAAM,cAAc,CAAC;AAiK/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO;QACL,GAAG;YACD,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;QACD,MAAM;YACJ,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;QACD,EAAE;QACF,QAAQ;YACN,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;KACF,CAAC;AACJ,CAAC"}

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> & TStylesMap): {
+        readonly [P in keyof TStylesMap]: CompiledStyles<TStylesMap[P]>;
     };
     /**
      * ## CX

package/dist/cjs/create-strict-api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/create-strict-api/index.ts"],"names":[],"mappings":";;;AACA,0CAAwD;AACxD,4CAA+E;AA+J/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,SAAgB,eAAe;IAC7B,OAAO;QACL,GAAG;YACD,MAAM,IAAA,8BAAsB,GAAE,CAAC;QACjC,CAAC;QACD,MAAM;YACJ,MAAM,IAAA,8BAAsB,GAAE,CAAC;QACjC,CAAC;QACD,EAAE,EAAF,cAAE;QACF,QAAQ;YACN,MAAM,IAAA,8BAAsB,GAAE,CAAC;QACjC,CAAC;KACF,CAAC;AACJ,CAAC;AAbD,0CAaC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/create-strict-api/index.ts"],"names":[],"mappings":";;;AACA,0CAAwD;AACxD,4CAA+E;AAiK/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,SAAgB,eAAe;IAC7B,OAAO;QACL,GAAG;YACD,MAAM,IAAA,8BAAsB,GAAE,CAAC;QACjC,CAAC;QACD,MAAM;YACJ,MAAM,IAAA,8BAAsB,GAAE,CAAC;QACjC,CAAC;QACD,EAAE,EAAF,cAAE;QACF,QAAQ;YACN,MAAM,IAAA,8BAAsB,GAAE,CAAC;QACjC,CAAC;KACF,CAAC;AACJ,CAAC;AAbD,0CAaC"}

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> & TStylesMap): {
+        readonly [P in keyof TStylesMap]: CompiledStyles<TStylesMap[P]>;
     };
     /**
      * ## CX

package/dist/esm/create-strict-api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/create-strict-api/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAuB,EAAE,EAA0B,MAAM,cAAc,CAAC;AA+J/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO;QACL,GAAG;YACD,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;QACD,MAAM;YACJ,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;QACD,EAAE;QACF,QAAQ;YACN,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/create-strict-api/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAuB,EAAE,EAA0B,MAAM,cAAc,CAAC;AAiK/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO;QACL,GAAG;YACD,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;QACD,MAAM;YACJ,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;QACD,EAAE;QACF,QAAQ;YACN,MAAM,sBAAsB,EAAE,CAAC;QACjC,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compiled/react",
-  "version": "0.16.4",
+  "version": "0.16.6",
   "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,9 +202,215 @@ 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', () => {
+    it('should allow valid values from cssMap', () => {
+      function Button({ xcss }: { xcss: ReturnType<typeof XCSSProp<'background', never>> }) {
+        return <button data-testid="button" className={xcss} />;
+      }
+
+      const styles = cssMap({ bg: { background: 'var(--ds-surface)' } });
+      const { getByTestId } = render(<Button xcss={styles.bg} />);
+
+      expect(getByTestId('button')).toHaveCompiledCss('background', 'var(--ds-surface)');
+    });
+
+    it('should disallow invalid values from cssMap', () => {
+      function Button({ xcss }: { xcss: ReturnType<typeof XCSSProp<'background', never>> }) {
+        return <button data-testid="button" className={xcss} />;
+      }
+
+      const styles = cssMap({ bg: { accentColor: 'red' } });
+      const { getByTestId } = render(
+        <Button
+          // @ts-expect-error — Type 'CompiledStyles<{ accentColor: "red"; }>' is not assignable to type ...
+          xcss={styles.bg}
+        />
+      );
+
+      expect(getByTestId('button')).toHaveCompiledCss('accent-color', 'red');
+    });
+
+    it('should allow constrained background and pseudo', () => {
+      function Button({ xcss }: { xcss: ReturnType<typeof XCSSProp<'background', '&:hover'>> }) {
+        return <button data-testid="button" className={xcss} />;
+      }
+
+      const styles = cssMap({
+        primary: {
+          background: 'var(--ds-surface)',
+          '&:hover': { background: 'var(--ds-surface-hover)' },
+        },
+      });
+
+      const { getByTestId } = render(<Button xcss={styles.primary} />);
+
+      expect(getByTestId('button')).toHaveCompiledCss('background', 'var(--ds-surface)');
+    });
+
+    it('should type error on a partially invalid declaration', () => {
+      function Button({ xcss }: { xcss: ReturnType<typeof XCSSProp<'background', '&:hover'>> }) {
+        return <button data-testid="button" className={xcss} />;
+      }
+
+      const styles = cssMap({
+        bad: {
+          // @ts-expect-error — Property 'bad' is incompatible with index signature.
+          foo: 'bar',
+          color: 'var(--ds-text)',
+        },
+      });
+
+      const { getByTestId } = render(
+        <Button
+          // @ts-expect-error — Type 'CompiledStyles<{ foo: string; color: "var(--ds-text)"; }>' is not assignable to type
+          xcss={styles.bad}
+        />
+      );
+
+      expect(getByTestId('button')).toHaveCompiledCss('color', 'var(--ds-text)');
+    });
+
+    it('should error with values not in the strict `CompiledAPI`', () => {
+      function Button({
+        xcss,
+      }: {
+        xcss: ReturnType<typeof XCSSProp<'background' | 'color', '&:hover'>>;
+      }) {
+        return <button data-testid="button" className={xcss} />;
+      }
+
+      const styles = cssMap({
+        primary: {
+          // @ts-expect-error -- This is not in the `createStrictAPI` schema—this should be a css variable.
+          color: 'red',
+          background: 'var(--ds-surface)',
+          '&:hover': { background: 'var(--ds-surface-hover)' },
+        },
+      });
+
+      const { getByTestId } = render(
+        <Button
+          // @ts-expect-error -- Errors because `color` conflicts with the `XCSSProp` schema–`color` should be a css variable.
+          xcss={styles.primary}
+        />
+      );
+
+      expect(getByTestId('button')).toHaveCompiledCss('background', 'var(--ds-surface)');
+    });
+
+    it('should error with properties not in the `XCSSProp`', () => {
+      function Button({ xcss }: { xcss: ReturnType<typeof XCSSProp<'color', '&:focus'>> }) {
+        return <button data-testid="button" className={xcss} />;
+      }
+
+      const styles = cssMap({
+        primary: {
+          background: 'var(--ds-surface)',
+          '&:hover': { background: 'var(--ds-surface-hover)' },
+        },
+      });
+
+      const { getByTestId } = render(
+        <Button
+          // @ts-expect-error -- Errors because `background` + `&:hover` are not in the `XCSSProp` schema.
+          xcss={styles.primary}
+        />
+      );
+
+      expect(getByTestId('button')).toHaveCompiledCss('background', 'var(--ds-surface)');
+    });
+
+    it('should error with invalid values', () => {
+      function Button({ xcss }: { xcss: ReturnType<typeof XCSSProp<'background', '&:hover'>> }) {
+        return <button data-testid="button" className={xcss} />;
+      }
+
+      const styles = cssMap({
+        primary: {
+          // @ts-expect-error -- Fails because `foo` is not assignable to our CSSProperties whatsoever.
+          foo: 'bar',
+          background: 'var(--ds-surface)',
+          '&:hover': {
+            // This does not fail, but would if the above was removed; this should be tested in raw `cssMap` fully.
+            foo: 'bar',
+            background: 'var(--ds-surface-hover)',
+          },
+        },
+      });
+
+      const { getByTestId } = render(<Button xcss={styles.primary} />);
+
+      expect(getByTestId('button')).toHaveCompiledCss('background', 'var(--ds-surface)');
+    });
+
     it('should allow valid values', () => {
       function Button({ xcss }: { xcss: ReturnType<typeof XCSSProp<'background', never>> }) {
         return <button data-testid="button" className={xcss} />;

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

@@ -18,7 +18,13 @@ 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 +40,7 @@ interface CompiledAPI<TSchema> {
    * <div css={redText} />
    * ```
    */
-  css(
-    styles: StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>
-  ): StrictCSSProperties;
+  css(styles: CSSStyles<TSchema>): StrictCSSProperties;
   /**
    * ## CSS Map
    *
@@ -53,15 +57,13 @@ interface CompiledAPI<TSchema> {
    * <div css={styles.solid} />
    * ```
    */
-  cssMap<
-    TStyles extends Record<
-      string,
-      StrictCSSProperties & PseudosDeclarations & EnforceSchema<TSchema>
-    >
-  >(
-    styles: TStyles
+  cssMap<TStylesMap extends CSSMapStyles<TSchema>>(
+    // We intersection type the generic both with the concrete type and the generic to ensure the output has the generic applied.
+    // Without both it would either have the input arg not have excess property check kick in allowing unexpected values or
+    // have all values set as the output making usage with XCSSProp have type violations unexpectedly.
+    styles: CSSMapStyles<TSchema> & TStylesMap
   ): {
-    readonly [P in keyof TStyles]: CompiledStyles<TStyles[P]>;
+    readonly [P in keyof TStylesMap]: CompiledStyles<TStylesMap[P]>;
   };
   /**
    * ## CX