@edvisor/product-language 0.3.0 → 0.3.1

package/src/assets/svg/example_icon.svg

@@ -1,3 +0,0 @@
-<svg width="16" height="18" viewBox="0 0 16 18" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path d="M14.3751 15.6444H1.62507C1.12228 15.6444 0.714355 16.0527 0.714355 16.5559C0.714355 17.0902 1.12228 17.5 1.62507 17.5H14.3751C14.8779 17.5 15.2858 17.0917 15.2858 16.5885C15.2858 16.0846 14.8798 15.6444 14.3751 15.6444ZM12.1932 7.16719L8.91078 10.6583V1.41451C8.91078 0.908303 8.50476 0.5 8.00007 0.5C7.49538 0.5 7.08936 0.908304 7.08936 1.41147V10.6552L3.80585 7.16719C3.62674 6.97366 3.38503 6.8788 3.14293 6.8788C2.91882 6.8788 2.69478 6.96068 2.51909 7.12681C2.15268 7.47095 2.13507 8.04777 2.47996 8.41433L7.33711 13.5788C7.68098 13.9467 8.31916 13.9467 8.66296 13.5788L13.5201 8.41433C13.8652 8.04766 13.8474 7.47099 13.481 7.12681C13.1152 6.78013 12.5385 6.76496 12.1932 7.16719Z" fill="#6B7280"/>
-</svg>

package/src/assets/svg/example_icon_white.svg

@@ -1,3 +0,0 @@
-<svg width="16" height="18" viewBox="0 0 16 18" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path d="M14.3751 15.6444H1.62507C1.12228 15.6444 0.714355 16.0527 0.714355 16.5559C0.714355 17.0902 1.12228 17.5 1.62507 17.5H14.3751C14.8779 17.5 15.2858 17.0917 15.2858 16.5885C15.2858 16.0846 14.8798 15.6444 14.3751 15.6444ZM12.1932 7.16719L8.91078 10.6583V1.41451C8.91078 0.908303 8.50476 0.5 8.00007 0.5C7.49538 0.5 7.08936 0.908304 7.08936 1.41147V10.6552L3.80585 7.16719C3.62674 6.97366 3.38503 6.8788 3.14293 6.8788C2.91882 6.8788 2.69478 6.96068 2.51909 7.12681C2.15268 7.47095 2.13507 8.04777 2.47996 8.41433L7.33711 13.5788C7.68098 13.9467 8.31916 13.9467 8.66296 13.5788L13.5201 8.41433C13.8652 8.04766 13.8474 7.47099 13.481 7.12681C13.1152 6.78013 12.5385 6.76496 12.1932 7.16719Z" fill="white"/>
-</svg>

package/src/assets/svg/spinner.svg

@@ -1,3 +0,0 @@
-<svg width="16" height="18" viewBox="0 0 16 18" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path fill-rule="evenodd" clip-rule="evenodd" d="M9 2.09302C5.18538 2.09302 2.09302 5.18538 2.09302 9C2.09302 12.8146 5.18538 15.907 9 15.907C9.57797 15.907 10.0465 16.3755 10.0465 16.9535C10.0465 17.5315 9.57797 18 9 18C4.02944 18 0 13.9706 0 9C0 4.02944 4.02944 0 9 0C11.5884 0 13.9229 1.09405 15.5635 2.84196C15.959 3.26339 15.938 3.92567 15.5166 4.3212C15.0951 4.71674 14.4329 4.69575 14.0373 4.27432C12.7759 2.93035 10.9866 2.09302 9 2.09302Z" fill="#6B7280"/>
-</svg>

package/src/assets/svg/spinner_white.svg

@@ -1,3 +0,0 @@
-<svg width="16" height="18" viewBox="0 0 16 18" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path fill-rule="evenodd" clip-rule="evenodd" d="M9 2.09302C5.18538 2.09302 2.09302 5.18538 2.09302 9C2.09302 12.8146 5.18538 15.907 9 15.907C9.57797 15.907 10.0465 16.3755 10.0465 16.9535C10.0465 17.5315 9.57797 18 9 18C4.02944 18 0 13.9706 0 9C0 4.02944 4.02944 0 9 0C11.5884 0 13.9229 1.09405 15.5635 2.84196C15.959 3.26339 15.938 3.92567 15.5166 4.3212C15.0951 4.71674 14.4329 4.69575 14.0373 4.27432C12.7759 2.93035 10.9866 2.09302 9 2.09302Z" fill="white"/>
-</svg>

package/src/helpers/index.ts

@@ -1,4 +0,0 @@
-// these are helpers used for development, they are not included in the build
-
-export * from './talesOf'
-export * from './playground'

package/src/helpers/playground.ts

@@ -1,16 +0,0 @@
-import styled from 'styled-components'
-import { Playground } from 'storybook-addon-jarle-monaco'
-import { Margin, Surface, Text } from '@foundations'
-export { Playground } from 'storybook-addon-jarle-monaco'
-
-/** when using playground with a card inside we style it in night mode */
-export const CardPlayground = styled(Playground)`
-  background: ${Surface.Neutral.Default};
-
-  margin-bottom: ${Margin.xxl};
-
-  > div:nth-of-type(2) {
-    background: ${Surface.Default.Inverse};
-    color: ${Text.OnPrimary};
-  }
-`

package/src/helpers/talesOf.tsx

@@ -1,42 +0,0 @@
-import { storiesOf as _storiesOf } from '@storybook/react'
-import { StoryFn } from '@storybook/addons'
-import { isDefined, isNil } from '@helpers'
-import { StoryFnReactReturnType } from '@storybook/react/dist/ts3.9/client/preview/types'
-
-const DIRECTORY_BASE_PATH = 'packages/product-language/src/lib/'
-
-const getStoryPath = (filepath: string) => {
-  const path = filepath.split('/')
-
-  return isDefined(path)
-    ? path
-        .slice(0, path.length - 1) // remove the filename
-        .join('/')
-        .replace(DIRECTORY_BASE_PATH, '') // remove the base path
-    : 'misc'
-}
-
-function getStoryTitle (filepath: string, storyName? : string): string {
-  const path = filepath.split('/')
-
-  const nameFromPath = isDefined(path) ? path.pop()?.split('.').shift() : undefined
-
-  if (isNil(nameFromPath)) return 'Base'
-
-  if (isDefined(storyName)) return `${nameFromPath}/${storyName}`
-
-  return nameFromPath
-}
-
-export type StoryComponent = StoryFn<StoryFnReactReturnType>
-
-export function talesOf (filepath: string, module: NodeModule, Storybook?: StoryComponent, storyName?: string) {
-  if (isNil(Storybook)) {
-    return _storiesOf(getStoryPath(filepath), module)
-  }
-
-  const title = getStoryTitle(filepath, storyName)
-
-  return _storiesOf(getStoryPath(filepath), module)
-    .add(title, Storybook)
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './lib/components'
-export * from './lib/foundations'

package/src/lib/components/README.md

@@ -1,49 +0,0 @@
-Components
-==========
-
-This folder contains the components that will be exported from the Product Language and used in the front-end.
-
-```
-/src
-  /lib
-    /components
-      /alert-banner
-      /card
-      index.ts
-```
-
-The index.ts file is a manifest and anything in the manifest will be available the clients.
-
-```
-/src
-  /lib
-    /components
-      /alert-banner
-      /card
-        /components
-        /helpers
-        index.tsx
-        card.tsx
-        card.stories.tsx
-        card.spec.ts
-      index.ts
-```
-
-inside of any component, like `card` you will find another index.ts file. This is a manifest and it should only declare the main file of the component as an export:
-
-```ts
-export * from './card'
-```
-
-None of the specs, stories, sub-components, helpers, or any other kind of thing should appear in the manifest. Using manifests like this allows us to give each component a rich eco-system of helpers and sub-components without needing to move everything to a global scope.
-
-For example, here is a helper in card/helpers.ts
-
-```ts
-// this is not a real helper, just an example
-export function makeCardTitle (title: string) {
-  return `Card: ${title}`
-}
-```
-
-This helper is obviously tightly coupled to the card "concern". It should not be declared in a global helpers file, that wouldn't make sense and it would lower cohesion in the app. In addition, it should not be exported from the manifest, since it is not intended for the client to use it.

package/src/lib/components/alert-banner/alert-banner.tsx

@@ -1,34 +0,0 @@
-import styled from 'styled-components'
-import { FC, Hex, PropsWithChildren } from '@helpers'
-import { AlertLevelProps, getBackgroundColor, getBorderColor } from './alert-level-flags'
-import { Padding } from '@foundations'
-import { CardFrame } from 'components/card/atoms'
-
-interface IAlertBannerProps extends PropsWithChildren {
-  /** @TODO can we get some examples of alert banner in card from figma? */
-  inCard?: boolean
-  dismissible?: boolean
-  className?: string
-}
-
-export type AlertBannerProps = IAlertBannerProps & AlertLevelProps
-
-const InCardFrame = styled(CardFrame).attrs({ as: 'div' })<{ background: Hex, border: Hex }>`
-  display: inline-block;
-  padding: ${Padding.m};
-  width: fill-available;
-
-  background: ${({ background }) => background};
-  border: 1px solid ${({ border }) => border};
-`
-
-export const AlertBanner: FC<AlertBannerProps> = (props) => {
-  const background = getBackgroundColor(props)
-  const border = getBorderColor(props)
-
-  return (
-    <InCardFrame background={background} border={border} className={props.className}>
-      {props.children}
-    </InCardFrame>
-  )
-}

package/src/lib/components/alert-banner/alert-level-flags.ts

@@ -1,77 +0,0 @@
-// this file was generated, but it is safe to modify
-import { Borders, Surface } from '@foundations'
-import { bitwiseOr, Hex, MappedEnum, RequireOnlyOne, PropsWithChildren } from '@helpers'
-
-const enum AlertLevel {
-  neutral = 1,
-  info = 2,
-  success = 4,
-  warning = 8,
-  critical = 16,
-}
-
-type AlertLevels<T> = MappedEnum<typeof AlertLevel, T>
-
-function toAlertLevel(n: number): AlertLevel {
-  switch (n) {
-    case AlertLevel.neutral:
-      return AlertLevel.neutral
-    case AlertLevel.info:
-      return AlertLevel.info
-    case AlertLevel.success:
-      return AlertLevel.success
-    case AlertLevel.warning:
-      return AlertLevel.warning
-    case AlertLevel.critical:
-      return AlertLevel.critical
-    default:
-      return AlertLevel.neutral
-  }
-}
-
-export type AlertLevelProps = Partial<RequireOnlyOne<AlertLevels<boolean>>> &
-  PropsWithChildren
-
-const AlertLevelBackgroundColors = {
-  [AlertLevel.neutral]: Surface.Neutral.Subdued,
-  [AlertLevel.info]: Surface.Highlight.Subdued,
-  [AlertLevel.success]: Surface.Success.Subdued,
-  [AlertLevel.warning]: Surface.Warning.Subdued,
-  [AlertLevel.critical]: Surface.Critical.Subdued,
-}
-
-const AlertLevelBorderColors = {
-  [AlertLevel.neutral]: Borders.Default.Default,
-  [AlertLevel.info]: Borders.Highlight.Subdued,
-  [AlertLevel.success]: Borders.Success.Subdued,
-  [AlertLevel.warning]: Borders.Warning.Subdued,
-  [AlertLevel.critical]: Borders.Critical.Subdued,
-}
-
-export function getBackgroundColor(props: AlertLevelProps): Hex {
-  return AlertLevelBackgroundColors[
-    toAlertLevel(
-      bitwiseOr([
-        props.neutral,
-        props.info,
-        props.success,
-        props.warning,
-        props.critical,
-      ])
-    )
-  ]
-}
-
-export function getBorderColor(props: AlertLevelProps): Hex {
-  return AlertLevelBorderColors[
-    toAlertLevel(
-      bitwiseOr([
-        props.neutral,
-        props.info,
-        props.success,
-        props.warning,
-        props.critical,
-      ])
-    )
-  ]
-}

package/src/lib/components/alert-banner/index.ts

@@ -1 +0,0 @@
-export * from './alert-banner'

package/src/lib/components/badge/badge-type-flags.ts

@@ -1,72 +0,0 @@
-// this file was generated, but it is safe to modify
-import { Hex, PropsWithChildren } from '@helpers'
-import { Surface } from '@foundations'
-
-const enum BadgeType {
-  neutral = 1,
-  info = 2,
-  success = 4,
-  warning = 8,
-  critical = 16,
-}
-
-export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<
-T,
-Exclude<keyof T, Keys>
-> &
-{
-  [K in Keys]-?: Required<Pick<T, K>> &
-    Partial<Record<Exclude<Keys, K>, undefined>>;
-}[Keys];
-
-export type MappedEnum<E, T> = {
-  [key in keyof E]: T;
-}
-
-type BadgeTypes<T> = MappedEnum<typeof BadgeType, T>
-
-function toBadgeType(n: number): BadgeType {
-  switch (n) {
-    case BadgeType.neutral:
-      return BadgeType.neutral
-    case BadgeType.info:
-      return BadgeType.info
-    case BadgeType.success:
-      return BadgeType.success
-    case BadgeType.warning:
-      return BadgeType.warning
-    case BadgeType.critical:
-      return BadgeType.critical
-    default:
-      return BadgeType.neutral
-  }
-}
-
-const BadgeTypeColors = {
-  [BadgeType.neutral]: Surface.Neutral.Default,
-  [BadgeType.info]: Surface.Highlight.Default,
-  [BadgeType.success]: Surface.Success.Default,
-  [BadgeType.warning]: Surface.Warning.Default,
-  [BadgeType.critical]: Surface.Critical.Default,
-}
-
-export type BadgeTypeProps = Partial<RequireOnlyOne<BadgeTypes<boolean>>> &
-  PropsWithChildren
-
-function bitwiseOr(flags: unknown[]): number {
-  return flags.reduce((mask: number, flag, i) => mask | (Number(flag) << i), 0)
-}
-
-export function getColor(props: BadgeTypeProps): Hex {
-  return BadgeTypeColors[
-    toBadgeType(
-      bitwiseOr([
-        props.neutral,
-        props.info,
-        props.success,
-        props.warning,
-        props.critical,
-      ])
-    )
-  ]
-}

package/src/lib/components/badge/badge.test.tsx

@@ -1,29 +0,0 @@
-import { render } from '@testing-library/react'
-import { Badge } from './badge'
-
-describe('Badge', () => {
-  it('should render Neutral Badge successfully', () => {
-    const { baseElement } = render(<Badge neutral>Neutral</Badge>)
-    expect(baseElement).toBeTruthy()
-  })
-
-  it('should render Informational Badge successfully', () => {
-    const { baseElement } = render(<Badge info>Informational</Badge>)
-    expect(baseElement).toBeTruthy()
-  })
-
-  it('should render Warning Badge successfully', () => {
-    const { baseElement } = render(<Badge warning>Warning</Badge>)
-    expect(baseElement).toBeTruthy()
-  })
-
-  it('should render Success Badge successfully', () => {
-    const { baseElement } = render(<Badge success>Success</Badge>)
-    expect(baseElement).toBeTruthy()
-  })
-
-  it('should render Critical Badge successfully', () => {
-    const { baseElement } = render(<Badge critical>Critical</Badge>)
-    expect(baseElement).toBeTruthy()
-  })
-})

package/src/lib/components/badge/badge.tsx

@@ -1,22 +0,0 @@
-import styled from 'styled-components'
-import { Padding } from '@foundations'
-import { BadgeTypeProps, getColor } from './badge-type-flags'
-import { FC, PropsWithChildren } from '@helpers'
-import { Label } from 'components/typography'
-
-const BadgeFrame = styled(Label)<{color: string}>`
-  background: ${props => props.color};
-  display: flex;
-  align-items:center;
-  padding: ${Padding.xxxs} ${Padding.xs};
-  border-radius:10px;
-  height: fit-content;
-`
-
-type IBadgeProps = BadgeTypeProps & PropsWithChildren
-
-export const Badge: FC<IBadgeProps> = (props) => {
-  const color = getColor(props)
-
-  return <BadgeFrame color={color}>{props.children}</BadgeFrame>
-}

package/src/lib/components/badge/index.ts

@@ -1 +0,0 @@
-export * from './badge'

package/src/lib/components/badge/stories/badge.stories.mdx

@@ -1,44 +0,0 @@
-import { Badge } from '../badge'
-import { Meta } from '@storybook/addon-docs'
-import { BadgeExample } from './components'
-
-<Meta
-  title="Components/Badge"
-  component={Badge}
-/>
-
-# Badge
-
-This is an atom.
-
-For more details, check out the component page on [Figma](https://www.figma.com/file/ue1CurHfZ426o2T2l8Dk64/Edvisor-Product-Language?node-id=1008%3A1257)
-
-## How to use
-
-```tsx
-import { Badge } from '@edvisor/product-language'
-
-<Badge>Contents</Badge>
-```
-
-### Attitudes
-
-The badge can be rendered with various attitudes.
-
-<BadgeExample />
-
-## API
-
-| Name        | Type      | Description               |
-| ----------- | --------- | ------------------------- |
-| `neutral?`  | `boolean` | renders the neutral badge |
-| `info?`     | `boolean` | renders the info badge    |
-| `warning?`  | `boolean` | renders the info warning  |
-| `success?`  | `boolean` | renders the info success  |
-| `critical?` | `boolean` | renders the info critical |
-
-## Changelog
-
-### [0.0.0]
- - adopt the preferred storybook style
- - removed a containing div, adjusted styles to match figma

package/src/lib/components/badge/stories/components.tsx

@@ -1,49 +0,0 @@
-import { Margin } from '@foundations'
-import { Flex } from 'components/layout'
-import { Heading1 } from 'components/typography'
-import { Playground } from 'storybook-addon-jarle-monaco'
-import styled from 'styled-components'
-import { Badge } from '../badge'
-
-const Heading = styled(Heading1)`
-  margin-bottom: ${Margin.none};
-  margin-right: ${Margin.s};
-`
-
-const Header = styled(Flex)`
-  margin-bottom: ${Margin.l};
-  align-items: center;
-`
-
-export const BadgeExample = () => (
-  <Playground
-    code={`
-<>
-  <Header>
-    <Heading>Booking &#x23;1123</Heading>
-    <Badge warning>Pending</Badge>
-  </Header>
-  <Header>
-    <Heading>Booking &#x23;1124</Heading>
-    <Badge success>Accepted</Badge>
-  </Header>
-  <Header>
-    <Heading>Booking &#x23;1125</Heading>
-    <Badge info>Processing</Badge>
-  </Header>
-  <Header>
-    <Heading>Booking &#x23;1126</Heading>
-    <Badge critical>Declined</Badge>
-  </Header>
-</>
-    `}
-    providerProps={{
-      renderAsComponent: true,
-      scope: {
-        Badge,
-        Heading,
-        Header,
-      },
-    }}
-  />
-)

package/src/lib/components/card/atoms/index.ts

@@ -1 +0,0 @@
-export * from './card-frame'

package/src/lib/components/card/card.test.tsx

@@ -1,162 +0,0 @@
-import { Margin } from '@foundations'
-import { render, screen } from '@testing-library/react'
-import userEvent from '@testing-library/user-event'
-import styled from 'styled-components'
-
-import { Card } from './card'
-
-describe('Card', () => {
-  it('renders with the heading', () => {
-    render(
-      <Card heading='Heading'>Contents</Card>
-    )
-
-    expect(screen.getByRole('heading')).toBeInTheDocument()
-    expect(screen.getByText('Heading')).toBeInTheDocument()
-    expect(screen.getByText('Contents')).toBeInTheDocument()
-  })
-
-  it('renders without the heading', () => {
-    render(
-      <Card>Contents</Card>
-    )
-
-    expect(screen.queryByRole('heading')).not.toBeInTheDocument()
-    expect(screen.getByText('Contents')).toBeInTheDocument()
-  })
-
-  /** 
-   * this test just ensures that the programmer did not
-   * forget to add className? to the props and then pass
-   * it to the wrapping element so that users downstream
-   * can style the component
-   */
-  it('accepts styles', () => {
-    const NiceCard = styled(Card)`
-      margin-bottom: ${Margin.l};
-    `
-
-    const { container } = render(<NiceCard>Contents</NiceCard>)
-
-    expect(container.firstChild).toHaveStyle(`margin-bottom: ${Margin.l}`)
-    expect(screen.getByText('Contents')).toBeInTheDocument()
-  })
-
-  describe('slots', () => {
-    it('renders no regions if it has no headings', () => {
-      render(
-        <Card>Contents</Card>
-      )
-
-      expect(screen.queryByRole('region')).not.toBeInTheDocument()
-      expect(screen.getByText('Contents')).toBeInTheDocument()
-    })
-
-    it('renders one region if the card has a heading', () => {
-      render(
-        <Card heading='Heading'>Contents</Card>
-      )
-
-      expect(screen.getByRole('region')).toBeInTheDocument()
-      expect(screen.getAllByRole('region').length).toBe(1)
-      expect(screen.getByText('Contents')).toBeInTheDocument()
-    })
-
-    it('renders one region per heading', () => {
-      render(
-        <Card heading='Heading'>
-          <Card.Section heading='Subheading 1'>Section 1</Card.Section>
-          <Card.Section heading='Subheading 2'>Section 2</Card.Section>
-          <Card.Section>Section 3</Card.Section>
-          <Card.Section>Section 4</Card.Section>
-        </Card>
-      )
-
-      expect(screen.getAllByRole('region').length).toBe(3)
-    })
-
-    it('renders all the given sections', () => {
-      render(
-        <Card heading='Heading'>
-          <Card.Section heading='Subheading 1'>Section 1</Card.Section>
-          <Card.Section heading='Subheading 2'>Section 2</Card.Section>
-          <Card.Section>Section 3</Card.Section>
-          <Card.Section>Section 4</Card.Section>
-        </Card>
-      )
-
-      expect(screen.getByText('Section 1')).toBeInTheDocument()
-      expect(screen.getByText('Section 2')).toBeInTheDocument()
-      expect(screen.getByText('Section 3')).toBeInTheDocument()
-      expect(screen.getByText('Section 4')).toBeInTheDocument()
-    })
-
-    it('does not render plain children if you give it sections', () => {
-      render(
-        <Card>
-          <Card.Section>Section 1</Card.Section>
-          <div data-testid='plain-children'>PLAIN CHILDREN</div>
-        </Card>
-      )
-
-      expect(screen.getByText('Section 1')).toBeInTheDocument()
-      expect(screen.queryByTestId('plain-children')).not.toBeInTheDocument()
-    })
-
-    it('renders the heading actions if there is a heading', () => {
-      render(
-        <Card heading='Heading'>
-          <Card.Section>Section 1</Card.Section>
-          <Card.HeadingAction>
-            <button>Click Me</button>
-          </Card.HeadingAction>
-        </Card>
-      )
-
-      expect(screen.getByRole('button')).toBeInTheDocument()
-    })
-
-    it('does not render heading actions if there is no heading', () => {
-      render(
-        <Card>
-          <Card.Section>Section 1</Card.Section>
-          <Card.HeadingAction>
-            <button>Click Me</button>
-          </Card.HeadingAction>
-        </Card>
-      )
-
-      expect(screen.queryByRole('button')).not.toBeInTheDocument()
-    })
-
-    it('renders the controls when they are provided', () => {
-      render(
-        <Card heading='Heading'>
-          <Card.Section>Section 1</Card.Section>
-          <Card.Controls>
-            <button>Click Me</button>
-          </Card.Controls>
-        </Card>
-      )
-
-      expect(screen.getByRole('button')).toBeInTheDocument()
-    })
-
-    it('does not stop the user from clicking the controls', async () => {
-      const handleClick = jest.fn()
-
-      render(
-        <Card heading='Heading'>
-          <Card.Section>Section 1</Card.Section>
-          <Card.Controls>
-            <button onClick={handleClick}>Click Me</button>
-          </Card.Controls>
-        </Card>
-      )
-
-      await userEvent.click(screen.getByText('Click Me'))
-  
-      expect(handleClick).toHaveBeenCalledTimes(1)
-    })
-  })
-})