@edvisor/product-language 0.10.2 → 0.10.3

package/src/README.md

@@ -1,61 +0,0 @@
-Directory Structure
-===================
-
-Manifest Files (index.ts)
--------------------------
-
-RWC, and now product-language, export components to be consumed by another system. Their API is a list of components that they export, and this API is declared in src/index.ts the “root manifest”.
-
-```ts
-// src/index.ts 
-export * from 'src/components'
-export * from 'src/foundations'
-```
-
-And then things get… recursive.
-
-The “components” directory is a module that exports components to be consumed by another system. It’s API is the list of components it exports, and this API is declared in src/components/index.ts
-
-```ts
-// src/components/index.ts
-export * from 'src/components/atoms'
-export * from 'src/components/molecules'
-```
-
-The “molecules” directory is a module that exports components to be consumed by another system. It’s API is the list of components it exports, and this API is declared in src/components/molecules/index.ts
-
-```ts
-// src/components/molecules/index.ts
-export * from 'src/components/molecules/button
-export * from 'src/components/molecules/card
-export * from 'src/components/molecules/input-field
-```
-
-The “button” directory is a module that exports components to be consumed by another system. It’s API is the list of components it exports, and this API is declared in src/components/molecules/button/index.ts
-
-This file, this index.ts file is the public API or public interface of the button module. A public interface should only expose public things. Private things should not be exported. So for example:
-
-```ts
-// src/components/molecules/button/index.ts
-
-export * from './stories' // NOPE! this is not public
-export * from './components' // Nope! don't expose implementation details
-
-// in most cases, this is all you need
-export * from './Button.tsx'
-```
-
-Within the Button module, we have to be careful to remember that these index files are the public api they are not to be consumed internally. So for example in a storybook file:
-
-```ts
-// src/components/molecules/button/stories/button.stories.mdx
-
-import { Button } from '../index' // Nope!
-import { Button } from '../Button' // yes!
-```
-
-Importing from the index file within the module that index file describes is a potential problem, it can cause cyclic dependencies which can be hard to debug.
-
-On a similar note: your stories and tests folders don’t need index files at all. They are just there to provide a place to put helpers specific to the stories and tests for the component. They are not modules that export components for other systems to use, so they do not need an index.ts file.
-
-On the other hand, the components folder in the Button module should have an index.ts file since it exposes a list of components that Button consumes. Doing this also makes it easier to lift a helper component from the Button module to a shared place if you discover you’ve created a helpful shared component.

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,26 +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};
-  }
-`
-
-/** when using playground with a card inside we style it in night mode */
-export const OverflowPlayground = styled(Playground)`
-  margin-bottom: ${Margin.xxl};
-  overflow: visible !important;
-
-  > div {
-    overflow: visible;
-  }
-`

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.test.tsx

@@ -1,93 +0,0 @@
-import { render, screen } from '@testing-library/react'
-import userEvent from '@testing-library/user-event'
-import { AlertBanner } from './alert-banner'
-
-
-describe('Alert banner tests', () => {
-  it('should render the alert banner when attribute open is true', async () => {
-    render (
-      <AlertBanner
-        open={true}
-        onClose={() => { return }}
-      >
-        Alert Banner
-      </AlertBanner>
-    )
-    expect(screen.getByRole('alert')).toBeInTheDocument()
-  })
-  it('should not render the close button by default', async () => {
-    const handleClose = jest.fn()
-
-    render (
-      <AlertBanner
-        open={true}
-        onClose={handleClose}
-      >
-        Alert Banner
-      </AlertBanner>
-    )
-
-    expect(handleClose).not.toHaveBeenCalled()
-    const closeButton = screen.queryByLabelText('Close')
-    expect(closeButton).not.toBeInTheDocument()
-
-  })
-  it('should render the close button and handle the close function', async () => {
-    const handleClose = jest.fn()
-
-    render (
-      <AlertBanner
-        open={true}
-        onClose={handleClose}
-        dismissible={true}
-      >
-        Alert Banner
-      </AlertBanner>
-    )
-
-    expect(handleClose).not.toHaveBeenCalled()
-    const closeButton = screen.getByLabelText('Close')
-    expect(closeButton).toBeInTheDocument()
-    await userEvent.click(closeButton)
-    expect(handleClose).toHaveBeenCalled()
-
-  })
-  it('should render the primary action button and handle event after click', async () => {
-    const handlePrimaryButtonClick = jest.fn()
-
-    render (
-      <AlertBanner
-        primaryButtonLabel="Do thing!"
-        onPrimaryAction={handlePrimaryButtonClick}
-      >
-        Alert Banner
-      </AlertBanner>
-    )
-
-    expect(handlePrimaryButtonClick).not.toHaveBeenCalled()
-    const primaryButton = screen.getByText('Do thing!')
-    expect(primaryButton).toBeInTheDocument()
-    await userEvent.click(primaryButton)
-    expect(handlePrimaryButtonClick).toHaveBeenCalled()
-
-  })
-  it('should render the secondary action button and handle event after click', async () => {
-    const handleSecondaryButtonClick = jest.fn()
-
-    render (
-      <AlertBanner
-        secondaryButtonLabel="Do other thing!"
-        onSecondaryAction={handleSecondaryButtonClick}
-      >
-        Alert Banner
-      </AlertBanner>
-    )
-
-    expect(handleSecondaryButtonClick).not.toHaveBeenCalled()
-    const primaryButton = screen.getByText('Do other thing!')
-    expect(primaryButton).toBeInTheDocument()
-    await userEvent.click(primaryButton)
-    expect(handleSecondaryButtonClick).toHaveBeenCalled()
-
-  })
-})

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

@@ -1,117 +0,0 @@
-import styled from 'styled-components'
-import { FC, Hex, is, isDefined, Nothing, PropsWithChildren, safeCallback } from '@helpers'
-import { AlertLevelProps, getBackgroundColor, getBorderColor, getIcon } from './alert-level-flags'
-import { Gap, Padding } from '@foundations'
-import { CardFrame } from 'components/card/atoms'
-import { IconMinor } from 'components/icon'
-import { Button } from 'components/molecules/button'
-import { Body} from 'components/typography'
-interface IAlertBannerProps extends PropsWithChildren {
-  dismissible?: boolean
-  className?: string
-  open?: boolean
-  primaryButtonLabel?: string
-  secondaryButtonLabel?: string
-  onPrimaryAction?: () => void
-  onSecondaryAction?: () => void
-  onClose?: () => void
-}
-
-export type AlertBannerProps = IAlertBannerProps & AlertLevelProps
-
-const InCardFrame = styled(CardFrame).attrs({ as: 'div' })<{ background: Hex, border: Hex}>`
-  display: flex;
-  padding: ${Padding.m};
-  width: fill-available;
-  position: relative;
-  flex-wrap: wrap;
-  background: ${({ background }) => background};
-  border: 1px solid ${({ border }) => border};
-`
-
-const IconContainer = styled.div<{ iconColor: Hex }>`
-  width: fit-content;
-  svg[role='icon'] {
-    position: initial;
-    path {
-      fill: ${(props) => props.iconColor};
-    }
-  }
-`
-
-const AlertFooter = styled.footer`
-  width: 100%;
-  padding: ${Padding.m} ${Padding.xl} ${Padding.none} ;
-  bottom: 0;
-  box-sizing: border-box;
-  display: flex;
-  gap: ${Gap.xs};
-`
-
-const Content = styled(Body)`
-  padding-left: ${Padding.m};
-  flex: 1;
-  overflow: auto;
-`
-
-const CloseButton = styled(IconMinor.Xmark)`
-  cursor: pointer;
-  position: absolute;
-  top: 12px;
-  right: 12px;
-  border-radius: 3px;
-`
-
-export const AlertBanner: FC<AlertBannerProps> = (props) => {
-  const {
-    open = true,
-    dismissible = false,
-    primaryButtonLabel,
-    secondaryButtonLabel,
-    onPrimaryAction,
-    onSecondaryAction,
-    onClose,
-  } = props
-
-  const background = getBackgroundColor(props)
-  const border = getBorderColor(props)
-
-  const { icon: LevelIcon, color: iconColor }  = getIcon(props)
-
-  const handleClose = () => {
-    safeCallback(onClose)
-  }
-
-  if(!is(open)) {
-    return <Nothing />
-  }
-
-  return (
-    <InCardFrame role="alert" background={background} border={border}  className={props.className}>
-      <IconContainer iconColor={iconColor}>
-        <LevelIcon></LevelIcon>
-      </IconContainer>
-      <Content>
-        {props.children}
-      </Content>
-      { is(dismissible)
-        ? <CloseButton aria-label="Close" onClick={handleClose}></CloseButton>
-        : <Nothing></Nothing>
-      }
-
-      { isDefined(primaryButtonLabel) || isDefined(secondaryButtonLabel)
-        ? <AlertFooter>
-          { isDefined(primaryButtonLabel)
-            ? <Button outline onClick={onPrimaryAction} name="alert-banner-primary-button">{primaryButtonLabel}</Button>
-            : <Nothing />
-          }
-          { isDefined(secondaryButtonLabel)
-            ? <Button plain subtle onClick={onSecondaryAction} name="alert-banner-secondary-button">{secondaryButtonLabel}</Button>
-            : <Nothing />
-          }
-        </AlertFooter>
-        : <Nothing />
-      }
-    </InCardFrame>
-  )
-}

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

@@ -1,101 +0,0 @@
-// this file was generated, but it is safe to modify
-import { Borders, Surface, Icons } from '@foundations'
-import { bitwiseOr, Hex, MappedEnum, RequireOnlyOne, PropsWithChildren } from '@helpers'
-import { ComponentType } from 'react'
-import { Icon } from '../icon'
-
-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,
-}
-
-const AlertLevelIcons = {
-  [AlertLevel.neutral]: { icon: Icon.CircleInfo, color: Icons.Default },
-  [AlertLevel.info]: { icon: Icon.CircleInfo, color: Icons.Highlight },
-  [AlertLevel.success]: { icon: Icon.CircleCheck, color: Icons.Success },
-  [AlertLevel.warning]: { icon: Icon.TriangleExclamation, color: Icons.Warning },
-  [AlertLevel.critical]: { icon: Icon.DiamondExclamation, color: Icons.Critical },
-}
-
-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,
-      ])
-    )
-  ]
-}
-
-export function getIcon(props: AlertLevelProps): { icon: ComponentType, color: Hex } {
-  return AlertLevelIcons[
-    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/alert-banner/storybook/alert-banner.stories.mdx

@@ -1,67 +0,0 @@
-import { Canvas, Meta, Story } from '@storybook/addon-docs';
-import { Card, SpaceBetween } from '@components'
-import {
-  SimpleAlertBanner,
-  TypeVariantAlertBanner,
-  DismissibleAlertBanner,
-  ActionsAlertBanner
-} from './components'
-
-import { AlertBanner } from '../alert-banner'
-import { Heading3, Body } from '../../typography'
-
-<Meta title="Components/AlertBanner" component={AlertBanner}/>
-
-
-# Alert Banner
-• Alert Banners informs user about important changes or persistent conditions.
-Use this component if you need to communicate to users in a prominent way.
-
-For more details, check out the component page on [Figma](https://www.figma.com/file/ue1CurHfZ426o2T2l8Dk64/Edvisor-Product-Language?node-id=1082%3A1049&t=lBbNjmK8G41XPGz9-0)
-
-
-## How to use
-
-```javascript
-// Import the component
-import { AlertBanner } from './index'
-
-
-// Render the component sending the parameters
-<AlertBanner default>
-  <div> Content </div>
-</AlertBanner>
-
-```
-
-### Simple Alert Banner
-<SimpleAlertBanner />
-
-
-
-### Alert Banner with different type
-The possible values are `neutral` \| `info` \| `success` \| `warning` \| `critical`
-<TypeVariantAlertBanner />
-
-
-### Dismissible alert banner
-
-<DismissibleAlertBanner/>
-
-### Alert banner with action buttons
-<ActionsAlertBanner />
-
-
-## API
-
-| Name                                                        | Type         | Description                                               |
-| ----------------------------------------------------- ----- | ------------ | --------------------------------------------------------- |
-| `dismissible?`                                              | `boolean`    | Defines if the user can dismiss alert                     |
-| `className?`                                                | `string`     | Class to be attached to the Container                     |
-| `open?`                                                     | `boolean`    | Defines if the alert is visible on screen                 |
-| `primaryButtonLabel?`                                       | `boolean`    | Text on the primary button                                |
-| `secondaryButtonLabel?`                                     | `boolean`    | Text on the secondary button                              |
-| `onPrimaryAction?`                                          | `() => void` | Primary button event handler function                     |
-| `onSecondaryAction?`                                        | `() => void` | Secondary button event handler function                   |
-| `onClose?`                                                  | `() => void` | Callback function invoked to close the alert banner       |
-| `neutral` \| `info` \| `success` \| `warning` \| `critical` | boolean      | Define the color and icons of the alert                   |