@sproutsocial/racine 11.1.1 → 11.1.2-badge-update.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 11.1.2
+
+### Patch Changes
+
+- 81f95bc: Add flow support for newer colors in theme
+
 ## 11.1.1
 
 ### Patch Changes

package/__flow__/Badge/constants.js

@@ -0,0 +1,48 @@
+//@flow
+
+const defaultPurple = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.purple",
+};
+
+const suggestion = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.blue",
+};
+
+const passive = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.neutral",
+};
+
+const primary = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.blue",
+};
+
+const secondary = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.yellow",
+};
+
+const common = {
+  color: "colors.text.inverse",
+  background: "colors.aqua.600",
+};
+
+const approval = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.orange",
+};
+
+//Deprecated former "types"
+
+export const legacyBadgeColors = {
+  primary,
+  secondary,
+  passive,
+  common,
+  approval,
+  default: defaultPurple,
+  suggestion,
+};

package/__flow__/Badge/index.js

@@ -1,43 +1,69 @@
 // @flow
 import * as React from "react";
+import Icon from "../Icon";
 import Container from "./styles";
+import Box from "../Box";
 
 type TypeProps = {
+  children?: React.Node,
+  /** DEPRECATED: Use children instead of text */
   text: React.Node,
-  type:
-    | "primary"
-    | "secondary"
-    | "passive"
-    | "common"
-    | "approval"
-    | "default"
-    | "suggestion",
-  size: "default" | "small",
+  size?: "small" | "large" | "default",
+  badgeColor?:
+    | "green"
+    | "blue"
+    | "purple"
+    | "yellow"
+    | "orange"
+    | "red"
+    | "neutral",
+  iconName?: string,
+  /** DEPRECATED: Possibly only used for testing. Refrain from using at all if possible. (optional) */
   tip?: React.Node,
+  /** DEPRECATED: The legacy method of choosing a theme. Use badgeColor instead. (optional) */
+  type?: string,
 };
 
-export default class Badge extends React.Component<TypeProps> {
-  static defaultProps = {
-    type: "primary",
-    size: "default",
-  };
-
-  render() {
-    const { size, type, tip, text, ...rest } = this.props;
-
-    return (
-      <Container
-        type={type}
-        small={size === "small"}
-        data-tip={tip}
-        data-qa-badge={text || ""}
-        data-qa-badge-type={type}
-        data-qa-badge-tip={tip || ""}
-        // $FlowIssue - upgrade v0.112.0
-        {...rest}
-      >
-        {text}
-      </Container>
+const Badge = ({
+  children,
+  text,
+  iconName,
+  type,
+  tip,
+  size = "small",
+  badgeColor = "blue",
+  ...rest
+}: TypeProps) => {
+  if (children && text) {
+    throw new Error(
+      "can't use both `children` and `text` props. Text is deprecated, consider using children."
     );
   }
-}
+
+  return (
+    <Container
+      {...rest}
+      // size previously included default, which currently maps to small.  Once consumers have updated this can be simplified.
+      size={size === "default" ? "large" : size}
+      badgeColor={badgeColor}
+      data-tip={tip}
+      data-qa-badge={text || ""}
+      data-qa-badge-type={type}
+      data-qa-badge-tip={tip || ""}
+      type={type && type}
+    >
+      <Box display="flex" alignItems="center" JustifyContent="center">
+        {iconName ? (
+          <Icon
+            mr={200}
+            name={iconName}
+            size={size === "small" ? "mini" : "default"}
+          />
+        ) : null}
+        {children || text}
+      </Box>
+    </Container>
+  );
+};
+
+export default Badge;

package/__flow__/Badge/index.stories.js

@@ -1,53 +1,40 @@
 import React from "react";
-import { text } from "@storybook/addon-knobs";
 import Badge from "./index";
+import Box from "../Box";
+import Numeral from "../Numeral";
+import Text from "../Text";
+import Stack from "../Stack";
 
 export default {
   title: "Badge",
 };
 
 export const permutations = () => (
-  <>
-    <Badge
-      text={text("text", "Test")}
-      type="default"
-      size={text("size", "small")}
-    />
-    <Badge text={text("text", "Test")} size={text("size", "small")} />
-    <Badge
-      text={text("text", "Test")}
-      type="secondary"
-      size={text("size", "small")}
-    />
-    <Badge
-      text={text("text", "Test")}
-      type="passive"
-      size={text("size", "small")}
-    />
-    <Badge
-      text={text("text", "Test")}
-      type="common"
-      size={text("size", "small")}
-    />
-    <Badge
-      text={text("text", "Test")}
-      type="approval"
-      size={text("size", "small")}
-    />
-    <Badge
-      text={text("text", "Test")}
-      type="suggestion"
-      size={text("size", "small")}
-    />
-
-    <Badge text={text("text", "Test")} type="default" />
-    <Badge text={text("text", "Test")} />
-    <Badge text={text("text", "Test")} type="secondary" />
-    <Badge text={text("text", "Test")} type="passive" />
-    <Badge text={text("text", "Test")} type="common" />
-    <Badge text={text("text", "Test")} type="approval" />
-    <Badge text={text("text", "Test")} type="suggestion" />
-  </>
+  <Stack space={450}>
+    <Box display="flex" alignItems="center">
+      <Badge badgeColor="green">Badge</Badge>
+      <Badge>Badge</Badge>
+      <Badge badgeColor="purple">Badge</Badge>
+      <Badge badgeColor="yellow">Badge</Badge>
+      <Badge badgeColor="orange">Badge</Badge>
+      <Badge badgeColor="red">Badge</Badge>
+      <Badge badgeColor="neutral" iconName="atom">
+        Badge
+      </Badge>
+      <Badge bg="chartreuse" color="crimson">
+        Radical overrides!
+      </Badge>
+    </Box>
+    <Box display="flex" alignItems="center">
+      <Badge size="large" type="secondary" iconName="sparkles">
+        Supports legacy types
+      </Badge>
+      <Badge size="large">
+        <Numeral fontWeight="bold" number={1569241} />
+        <Text ml={200}>and children!</Text>
+      </Badge>
+    </Box>
+  </Stack>
 );
 
 permutations.story = {

package/__flow__/Badge/index.test.js

@@ -3,48 +3,50 @@ import Badge from "./";
 import { render } from "../utils/react-testing-library";
 import "jest-styled-components";
 
-describe("Racine Badge", () => {
-  it("should render with default props", () => {
-    const { getByText, getByDataQaLabel } = render(<Badge text="Test" />);
+describe("Badge...", () => {
+  it("...should render with default props", () => {
+    const { getByText } = render(<Badge>Test</Badge>);
     expect(getByText("Test")).toBeTruthy();
-    expect(getByDataQaLabel({ "badge-type": "primary" })).toBeTruthy();
+    expect(getByText("Test").closest("span")).toHaveStyleRule(
+      "padding",
+      "0px 4px"
+    );
+    expect(getByText("Test").closest("span")).toHaveStyleRule(
+      "background",
+      "#dcf2ff"
+    );
   });
 
-  it("should render with correct size styling", () => {
-    const { getByText } = render(<Badge text="Test" size="small" />);
-    expect(getByText("Test")).toHaveStyleRule("padding", "4px 8px");
+  it("...should render with correct size styling", () => {
+    const { getByText } = render(<Badge size="large">Test</Badge>);
+    expect(getByText("Test").closest("span")).toHaveStyleRule("padding", "8px");
   });
 
-  it("should render with secondary type", () => {
-    const { getByText, getByDataQaLabel } = render(
-      <Badge text="Test" type="secondary" />
-    );
+  it("...should render with legacy type", () => {
+    const { getByText } = render(<Badge type="secondary">Test</Badge>);
     expect(getByText("Test")).toBeTruthy();
-    expect(getByDataQaLabel({ "badge-type": "secondary" })).toBeTruthy();
-  });
-
-  it("should render with passive type", () => {
-    const { getByText, getByDataQaLabel } = render(
-      <Badge text="Test" type="passive" />
+    expect(getByText("Test").closest("span")).toHaveStyleRule(
+      "color",
+      "#364141"
+    );
+    expect(getByText("Test").closest("span")).toHaveStyleRule(
+      "background",
+      "#fdefcd"
     );
-    expect(getByText("Test")).toBeTruthy();
-    expect(getByDataQaLabel({ "badge-type": "passive" })).toBeTruthy();
   });
 
-  it("should render with common type", () => {
-    const { getByText, getByDataQaLabel } = render(
-      <Badge text="Test" type="common" />
-    );
+  it("...should render with a badge color", () => {
+    const { getByText } = render(<Badge badgeColor="purple">Test</Badge>);
     expect(getByText("Test")).toBeTruthy();
-    expect(getByDataQaLabel({ "badge-type": "common" })).toBeTruthy();
+    expect(getByText("Test").closest("span")).toHaveStyleRule(
+      "background",
+      "#eaeaf9"
+    );
   });
 
-  it("should render with approval type", () => {
-    const { getByText, getByDataQaLabel } = render(
-      <Badge text="Test" type="approval" />
-    );
-    expect(getByText("Test")).toBeTruthy();
-    expect(getByDataQaLabel({ "badge-type": "approval" })).toBeTruthy();
+  it("...should render with an icon", () => {
+    const { container } = render(<Badge iconName="sparkles">Test</Badge>);
+    expect(container.querySelector("svg")).toBeTruthy();
   });
   it("should render with suggestion type", () => {
     const { getByText, getByDataQaLabel } = render(
@@ -54,9 +56,9 @@ describe("Racine Badge", () => {
     expect(getByDataQaLabel({ "badge-type": "suggestion" })).toBeTruthy();
   });
 
-  it("should render with tooltip class", () => {
+  it("...should render with tooltip class", () => {
     const { getByText, getByDataQaLabel } = render(
-      <Badge text="Test" tip="test tip" />
+      <Badge tip="test tip">Test</Badge>
     );
     expect(getByText("Test")).toBeTruthy();
     expect(getByDataQaLabel({ "badge-tip": "test tip" })).toBeTruthy();

package/__flow__/Badge/styles.js

@@ -1,51 +1,31 @@
 //@flow
-import styled, { css, type StyledComponent } from "styled-components";
+import styled, { type StyledComponent } from "styled-components";
 import { COMMON } from "../utils/system-props";
-import { themeGet } from "@styled-system/theme-get";
-
 import type { TypeTheme } from "../types/theme.flow";
-
-const colors = {
-  primary: "colors.neutral.0",
-  secondary: "colors.neutral.800",
-  passive: "colors.neutral.800",
-  common: "colors.neutral.0",
-  approval: "colors.neutral.800",
-  default: "colors.neutral.0",
-  suggestion: "colors.neutral.900",
-};
-
-const backgroundColors = {
-  primary: "colors.blue.700",
-  secondary: "colors.yellow.500",
-  passive: "colors.neutral.200",
-  common: "colors.aqua.600",
-  approval: "colors.orange.300",
-  default: "colors.purple.700",
-  suggestion: "colors.blue.300",
-};
+import { themeGet } from "@styled-system/theme-get";
+import { legacyBadgeColors } from "./constants";
 
 // eslint-disable-next-line prettier/prettier
-const Container: StyledComponent<{type: "primary" | "secondary" | "passive" | "common" | "approval" | "default" | "suggestion", small: boolean, ...}, TypeTheme, *> = styled.span`
+const Container: StyledComponent<{type: ?string, badgeColor: string, size: string, ...}, TypeTheme, *> = styled.span`
+  font-family: ${(p) => p.theme.fontFamily};
+  ${(p) =>
+    p.size === "small" ? p.theme.typography[100] : p.theme.typography[200]};
+  border-radius: 9999px;
+  line-height: 16px;
   display: inline-block;
-  text-align: center;
-  border-radius: 50px;
-  font-family: ${(props) => props.theme.fontFamily};
-
-  padding: ${(props) =>
-    props.small
-      ? `${props.theme.space[200]} ${props.theme.space[300]}`
-      : `${props.theme.space[300]} ${props.theme.space[350]}`};
-
-  ${(props) =>
-    props.small ? props.theme.typography[100] : props.theme.typography[200]}
-
-  ${(props) => css`
-    color: ${themeGet(colors[props.type])(props)};
-    background: ${themeGet(backgroundColors[props.type])(props)};
-  `}
-
-  ${COMMON}
+  color: ${(p) =>
+    p.type
+      ? themeGet(legacyBadgeColors[p.type].color)
+      : p.theme.colors.text.body};
+  background: ${(p) =>
+    p.type
+      ? themeGet(legacyBadgeColors[p.type].background)
+      : p.theme.colors.container.background.decorative[p.badgeColor]};
+  padding: ${(p) =>
+    p.size === "small"
+      ? `${p.theme.space[0]} ${p.theme.space[200]}`
+      : `${p.theme.space[300]}`};
+  ${COMMON};
 `;
 
 export default Container;

package/__flow__/themes/dark/theme.js

@@ -229,6 +229,7 @@ const colors = {
     map: datavizPalette.DATAVIZ_COLORS_MAP,
     list: datavizPalette.DATAVIZ_COLORS_LIST,
   },
+  // Remove this in a future version in favor of the above object
   ...datavizPalette,
 };
 

package/__flow__/themes/light/literal-colors.js

@@ -15,6 +15,7 @@ const literalColors = {
     "800": COLORS.COLOR_NEUTRAL_800,
     "900": COLORS.COLOR_NEUTRAL_900,
     "1000": COLORS.COLOR_NEUTRAL_1000,
+    "1100": COLORS.COLOR_NEUTRAL_1100,
   },
   green: {
     "0": COLORS.COLOR_GREEN_0,
@@ -42,6 +43,7 @@ const literalColors = {
     "800": COLORS.COLOR_RED_800,
     "900": COLORS.COLOR_RED_900,
     "1000": COLORS.COLOR_RED_1000,
+    "1100": COLORS.COLOR_RED_1100,
   },
   blue: {
     "0": COLORS.COLOR_BLUE_0,

package/__flow__/themes/light/theme.js

@@ -256,6 +256,7 @@ const colors = {
     list: datavizPalette.DATAVIZ_COLORS_LIST,
   },
   ...literalColors,
+  // Remove this in a future version in favor of the above object
   ...datavizPalette,
 };
 

package/__flow__/types/theme.colors.flow.js

@@ -1,6 +1,7 @@
 // @flow strict-local
 
 import literalColors from "../themes/light/literal-colors";
+import { datavizPalette } from "../themes/light/dataviz-palette";
 
 type TypeAppColors = {|
   app: {
@@ -170,6 +171,7 @@ type TypeIconColors = {|
     danger: string,
     info: string,
     opportunity: string,
+    applied: string,
     positive_sentiment: string,
     negative_sentiment: string,
     neutral_sentiment: string,
@@ -204,6 +206,28 @@ type TypeListItemColors = {|
   },
 |};
 
+type TypeOverlayColors = {|
+  overlay: {
+    background: {
+      base: string,
+    },
+    text: {
+      base: string,
+    },
+    icon: {
+      base: string,
+    },
+  },
+|};
+
+type TypeElevationColors = {|
+  elevation: {
+    base: string,
+  },
+|};
+
+type TypeDatavizColors = typeof datavizPalette;
+
 type TypeNetworkColors = {|
   network: {
     twitter: string,
@@ -245,6 +269,9 @@ export type TypeColors = {
   ...TypeIconColors,
   ...TypeFormColors,
   ...TypeListItemColors,
+  ...TypeOverlayColors,
+  ...TypeElevationColors,
+  ...TypeDatavizColors,
   ...TypeNetworkColors,
   ...TypeLiteralColors,
 };

package/bin/buildNpm.js

@@ -0,0 +1,58 @@
+/**
+ * This file handles the generation of an .npmrc with Jfrog credentials during the CI process.
+ * It replicates the local configuration requirements of a developer running `yarn` on their machine
+ * If run locally please do not commit your auth credentials
+ */
+const fs = require("fs");
+const https = require("https");
+const { exit } = require("process");
+
+const { ARTIFACTORY_KEY, CI } = process.env;
+
+// Check if we're in CI context, otherwise skip the process
+if (!CI) {
+  exit();
+}
+
+const options = {
+  hostname: "sproutsocial.jfrog.io",
+  path: "/artifactory/api/npm/auth",
+  method: "GET",
+  headers: {
+    "X-JFrog-Art-Api": ARTIFACTORY_KEY,
+  },
+};
+
+const req = https.request(options, (res) => {
+  console.log(`statusCode: ${res.statusCode}`);
+
+  // Call our auth endpoint with environment credentials
+  res.on("data", (data) => {
+    // Writes out an .npmrc file with the response
+    fs.writeFile(".npmrc", data, (err) => {
+      if (err) console.log(err);
+      else {
+        console.log(".npmrc generated successfully!");
+      }
+    });
+
+    // Once the file is created we append the registry info
+    fs.appendFile(
+      ".npmrc",
+      "registry=https://sproutsocial.jfrog.io/artifactory/api/npm/npm_virtual",
+      function (err) {
+        if (err) throw err;
+        console.log("Registry Config Added!");
+      }
+    );
+
+    // Finally, we set permissions for the file so that netlify recognizes it
+    fs.chmodSync(".npmrc", "0600");
+  });
+});
+
+req.on("error", (error) => {
+  console.error(error);
+});
+
+req.end();

package/commonjs/Avatar/index.js

@@ -15,6 +15,9 @@ var _Image = _interopRequireDefault(require("../Image"));
 
 var _Text = _interopRequireDefault(require("../Text"));
 
+var _excluded = ["fontSize"],
+    _excluded2 = ["appearance", "name", "src", "variant", "type", "size", "bg", "color"];
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
@@ -27,12 +30,12 @@ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) r
 
 var AvatarText = (0, _styledComponents.default)(function (_ref) {
   var fontSize = _ref.fontSize,
-      rest = _objectWithoutPropertiesLoose(_ref, ["fontSize"]);
+      rest = _objectWithoutPropertiesLoose(_ref, _excluded);
 
   return /*#__PURE__*/React.createElement(_Text.default, rest);
 }).withConfig({
   displayName: "Avatar__AvatarText",
-  componentId: "yx873f-0"
+  componentId: "sc-yx873f-0"
 })(["font-size:", "px;color:", "px;"], function (props) {
   return props.fontSize;
 }, function (props) {
@@ -40,7 +43,7 @@ var AvatarText = (0, _styledComponents.default)(function (_ref) {
 });
 var Container = (0, _styledComponents.default)(_Box.default).withConfig({
   displayName: "Avatar__Container",
-  componentId: "yx873f-1"
+  componentId: "sc-yx873f-1"
 })(["", ""], function (_ref2) {
   var theme = _ref2.theme,
       type = _ref2.type,
@@ -75,7 +78,7 @@ var Avatar = function Avatar(_ref3) {
       size = _ref3$size === void 0 ? "40px" : _ref3$size,
       bg = _ref3.bg,
       color = _ref3.color,
-      rest = _objectWithoutPropertiesLoose(_ref3, ["appearance", "name", "src", "variant", "type", "size", "bg", "color"]);
+      rest = _objectWithoutPropertiesLoose(_ref3, _excluded2);
 
   var _useState = (0, React.useState)(false),
       imageFailedLoading = _useState[0],

package/commonjs/Badge/constants.js

@@ -0,0 +1,43 @@
+"use strict";
+
+exports.__esModule = true;
+exports.legacyBadgeColors = void 0;
+var defaultPurple = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.purple"
+};
+var suggestion = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.blue"
+};
+var passive = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.neutral"
+};
+var primary = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.blue"
+};
+var secondary = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.yellow"
+};
+var common = {
+  color: "colors.text.inverse",
+  background: "colors.aqua.600"
+};
+var approval = {
+  color: "colors.text.body",
+  background: "colors.container.background.decorative.orange"
+}; //Deprecated former "types"
+
+var legacyBadgeColors = {
+  primary: primary,
+  secondary: secondary,
+  passive: passive,
+  common: common,
+  approval: approval,
+  default: defaultPurple,
+  suggestion: suggestion
+};
+exports.legacyBadgeColors = legacyBadgeColors;