@edvisor/product-language 0.2.0 → 0.3.1

package/src/lib/foundations/typography/typography.tsx

@@ -1,97 +0,0 @@
-import { css } from 'styled-components'
-import { getTextAspect, ITextAspectProps } from './text-aspect-flags'
-import { FontWeight, FontSize, LineHeight } from './constants'
-import { is } from '@helpers'
-
-export type ITextProps = ITextAspectProps & { emphasis?: boolean }
-
-const LightText = css` 
-  color: ${getTextAspect({ light: true })};
-`
-
-const Base = css<ITextProps>`
-  color: ${(props) => getTextAspect(props)};
-  font-family: 'Inter';
-`
-
-const Display = css<ITextProps>`
-  ${Base}
-  font-weight: ${FontWeight.Regular};
-  font-size: ${FontSize.g};
-  line-height: ${LineHeight.f};
-`
-
-const Heading1 = css<ITextProps>`
-  ${Base}
-  font-weight: ${FontWeight.SemiBold};
-  font-size: ${FontSize.f};
-  line-height: ${LineHeight.e};
-`
-
-const Heading2 = css<ITextProps>`
-  ${Heading1}
-  font-size: ${FontSize.e};
-  line-height: ${LineHeight.d};
-`
-
-const Heading3 = css<ITextProps>`
-  ${Heading1}
-  font-size: ${FontSize.c};
-  line-height: ${LineHeight.c};
-`
-
-const Heading4 = css<ITextProps>`
-  ${Heading1}
-  font-size: ${FontSize.b};
-  line-height: ${LineHeight.b};
-`
-
-const BodyLarge = css<ITextProps>`
-  ${Base}
-  font-weight: ${({ emphasis }) => is(emphasis) ? FontWeight.SemiBold : FontWeight.Regular};
-  font-size: ${FontSize.d};
-  line-height: ${LineHeight.d};
-`
-
-const Body = css<ITextProps>`
-  ${BodyLarge}
-  font-weight: ${({ emphasis }) => is(emphasis) ? FontWeight.Medium : FontWeight.Regular};
-  font-size: ${FontSize.b};
-  line-height: ${LineHeight.b};
-`
-
-const Caption = css<ITextProps>`
-  ${BodyLarge}
-  font-size: ${FontSize.a};
-  line-height: ${LineHeight.a};
-`
-
-const Label1 = css<ITextProps>`
-  ${BodyLarge}
-  font-weight: ${({ emphasis }) => is(emphasis) ? FontWeight.Medium : FontWeight.Regular};
-  font-size: ${FontSize.b};
-  line-height: ${LineHeight.b};
-`
-
-const Label2 = css<ITextProps>`
-  ${BodyLarge}
-  font-size: ${FontSize.a};
-  line-height: ${LineHeight.a};
-`
-
-export const Typography = {
-  Display,
-  Heading1,
-  Heading2,
-  Heading3,
-  Heading4,
-  BodyLarge,
-  Body,
-  Caption,
-  Label1,
-  Label2,
-}
-
-export const _Typography = {
-  LightText,
-}

package/src/lib/helpers/generic-types.ts

@@ -1,44 +0,0 @@
-// eslint-disable-next-line no-restricted-syntax
-import React, { FC as FunctionComponent, ForwardRefExoticComponent, ForwardRefRenderFunction, PropsWithChildren as PWC, PropsWithoutRef, RefAttributes } from 'react'
-import { Slot } from './slots'
-
-/** @see https://stackoverflow.com/a/49725198/29182 */
-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;
-}
-
-export type Values<T> = T[keyof T];
-
-export type PropsWithChildren<T = unknown> = PWC<T>
-
-// Our FC type adds the ability to specify sub-components such as Slots
-// also, just good to wrap imports from 3rd parties in general
-export type FC<
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  P = {}, 
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  E extends { [x: symbol]: FunctionComponent<PropsWithChildren> | typeof Slot } = {}
-> = FunctionComponent<P> 
-  & { 
-    [key in keyof E]: E[key]
-  }
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-type ExtensibleForwardRef<T, P = {}, E = {}> = ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>>
-  & {
-    [key in keyof E]: E[key]
-  }
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-export function forwardRef<T, P = {}, E = {}>(render: ForwardRefRenderFunction<T, P>): ExtensibleForwardRef<T, P, E> {
-  return React.forwardRef(render) as ExtensibleForwardRef<T, P, E>
-}

package/src/lib/helpers/index.ts

@@ -1,6 +0,0 @@
-export * from './safe-navigation'
-export * from './slots'
-export * from './generic-types'
-export * from './numbers'
-export * from './nothing'
-export * from './strings'

package/src/lib/helpers/nothing.tsx

@@ -1,18 +0,0 @@
-import { FC, PropsWithChildren } from './generic-types'
-import { isDefined } from './safe-navigation'
-
-// eslint-disable-next-line no-null/no-null
-export const Nothing: FC = () => null
-
-export function maybeRender<T>(prop: T, JSX: JSX.Element) {
-  return isDefined(prop) && Boolean(prop) ? JSX : <Nothing />
-}
-
-interface IIfProps {
-  is: unknown
-}
-
-export const If: FC<PropsWithChildren<IIfProps>> = (props) => {
-  // eslint-disable-next-line react/jsx-no-useless-fragment
-  return maybeRender(props.is, <>{props.children}</>)
-}

package/src/lib/helpers/safe-navigation.ts

@@ -1,34 +0,0 @@
-
-/** even though we have null disabled in the repo,
- * I still would not want isNil to skip checking null
- * it is for juuuuust in case a third party sends us a null
- * or something, and the types are not correct
- */
-
-/* eslint-disable no-null/no-null */
-/* eslint-disable @typescript-eslint/ban-types */
-
-export function isNil<T>(value: T | undefined | null): value is undefined | null {
-  return value === null || value === undefined
-}
-
-export function isDefined<T>(value: T | undefined | null): value is T {
-  return !isNil(value)
-}
-
-export function defaultTo<T>(value: T | undefined | null, fallback: T): T {
-  return isDefined(value) ? value : fallback
-}
-
-export function isEmpty<T extends { length: number }>(obj: T) {
-  return obj.length < 1
-}
-
-/** used for evaluating tri-state logic (true | false | undefined) */
-export function is (pred?: boolean): boolean {
-  return isDefined(pred) && pred
-}
-
-export function safeArray<T>(arr: T[] | undefined | null): T[] {
-  return isDefined(arr) ? arr : []
-}

package/src/lib/helpers/slots.tsx

@@ -1,76 +0,0 @@
-import { Children, PureComponent, ReactElement, ReactNode } from 'react'
-import { PropsWithChildren } from './generic-types'
-import { isDefined, isNil } from './safe-navigation'
-
-/** 
- * @TODO these aren't quiiiiite right
- * 
- * They all say they return ReactNode but I feel like JSX.Element or something
- * is more accurate? The child type needs to include _anything react can render_
- * but it should also allow the caller to cloneElement on the results so that
- * they can do stuff like
- * 
- * const sections = getSlots(Section, children)
- *  .map((el, i) => i === 0 ? cloneElement(el, { first: true }) : el)
- * 
- * Right? I want this...
- * */
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function isReactElement (obj?: any): obj is ReactElement {
-  // eslint-disable-next-line no-prototype-builtins
-  return isDefined(obj) && obj.hasOwnProperty('type')
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const isSlotOfType = <T extends typeof Slot>(type: T) => (obj?: any): obj is T => {
-  return isDefined(obj) && isReactElement(obj) && (Object.getPrototypeOf(obj.type) === type || obj.type === type)
-}
-
-const findSlotByType = <T extends typeof Slot>(type: T, children?: ReactNode): ReactNode => {
-  return Children.toArray(children).find(isSlotOfType(type))
-}
-
-const filterSlotByType = <T extends typeof Slot>(type: T, children?: ReactNode): ReactNode[] => {
-  return Children.toArray(children).filter(isSlotOfType(type))
-}
-
-export class Slot<T = unknown> extends PureComponent<PropsWithChildren<T>> {
-  override render () {
-    return this.props.children
-  }
-}
-
-export function getChildren(children?: ReactNode): ReactNode[] {
-  return Children.toArray(children).filter((child) => !isSlotOfType(Slot)(child))
-}
-
-export function getSlots<T extends typeof Slot>(slot: T, children?: ReactNode): ReactNode[] {
-  const result = filterSlotByType(slot, children)
-
-  if (isNil(result)) {
-    return []
-  }
-
-  return result
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function hasProps (obj: any): obj is { props: { children: ReactNode }} {
-  // eslint-disable-next-line no-prototype-builtins
-  return isDefined(obj) && obj.hasOwnProperty('props')
-}
-
-export function getSlot<T extends typeof Slot>(slot: T, children?: ReactNode): ReactNode {
-  const result = findSlotByType(slot, children)
-
-  if (isNil(result)) {
-    return undefined
-  }
-
-  if (hasProps(result)) {
-    return result
-  }
-
-  return result
-}

package/src/lib/helpers/strings.test.ts

@@ -1,47 +0,0 @@
-import { toKebabCase } from './strings'
-
-describe('strings', () => {
-  describe('toKebabCase', () => {
-    it('sends camel case to kebab case', () => {
-      const result = toKebabCase('helloMyFriends')
-
-      expect(result).toBe('hello-my-friends')
-    })
-    
-    it('sends leading caps to kebab case', () => {
-      const result = toKebabCase('HelloMyFriends')
-
-      expect(result).toBe('hello-my-friends')
-    })
-
-    it('respects numbers', () => {
-      const result = toKebabCase('Section1IsGood')
-
-      expect(result).toBe('section-1-is-good')
-    })
-    
-    it('respects leading and trailing numbers', () => {
-      const result = toKebabCase('1Section1')
-
-      expect(result).toBe('1-section-1')
-    })
-
-    it('removes non-alphanumeric characters, such as whitespace and punctuation', () => {
-      const result = toKebabCase('Help Text. Lorem Ipsum')
-
-      expect(result).toBe('help-text-lorem-ipsum')
-    })
-
-    it('removes leading and trailing nonsense', () => {
-      const result = toKebabCase('__Foo_Bar__')
-
-      expect(result).toBe('foo-bar')
-    })
-
-    it('removes leading and trailing whitespace', () => {
-      const result = toKebabCase(' . Foo_Bar_ _ . ')
-
-      expect(result).toBe('foo-bar')
-    })
-  })
-})

package/src/lib/helpers/strings.ts

@@ -1,16 +0,0 @@
-import { isDefined } from './safe-navigation'
-
-export const toKebabCase = (str: string) => {
-  return isDefined(str)
-    ? str
-        .replace(/[^a-zA-Z0-9\\-]/g, ' ')
-        .replace(/([a-z])([A-Z])/g, '$1-$2')
-        .replace(/([0-9]+)(.*)/g, '$1-$2')
-        .replace(/(.*)([0-9]+)/g, '$1-$2')
-        .replace(/^[\s_]+/g, '')
-        .replace(/[\s_]+$/g, '')
-        .replace(/[\s_]+/g, '-')
-        .replace(/[^a-zA-Z0-9\\-]/g, '')
-        .toLowerCase()
-    : ''
-}

package/tsconfig.json

@@ -1,35 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "jsx": "react-jsx",
-    "allowJs": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "noImplicitOverride": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "baseUrl": "./src/lib",
-    "paths": {
-      "@components": ["components/index.ts"],
-      "@foundations": ["foundations/index.ts"],
-      "@helpers": ["helpers/index.ts"],
-      "@stories": ["../helpers/index.ts"],
-    },
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    },
-    {
-      "path": "./.storybook/tsconfig.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,28 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "types": ["node"]
-  },
-  "files": [
-    "../../node_modules/@nrwl/react/typings/cssmodule.d.ts",
-    "../../node_modules/@nrwl/react/typings/image.d.ts"
-  ],
-  "exclude": [
-    "jest.config.ts",
-    "jest.setup.ts",
-    "src/helpers/**",
-    "**/storybook/**",
-    "**/stories/**",
-    "**/*.stories.*",
-    "**/*.spec.ts",
-    "**/*.test.ts",
-    "**/*.spec.tsx",
-    "**/*.test.tsx",
-    "**/*.spec.js",
-    "**/*.test.js",
-    "**/*.spec.jsx",
-    "**/*.test.jsx",
-  ],
-  "include": ["**/*.js", "**/*.jsx", "**/*.ts", "**/*.tsx"]
-}

package/tsconfig.spec.json

@@ -1,21 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "module": "commonjs",
-    "types": ["jest", "node"]
-  },
-  "include": [
-    "jest.config.ts",
-    "jest.setup.ts",
-    "**/*.test.ts",
-    "**/*.spec.ts",
-    "**/*.test.tsx",
-    "**/*.spec.tsx",
-    "**/*.test.js",
-    "**/*.spec.js",
-    "**/*.test.jsx",
-    "**/*.spec.jsx",
-    "**/*.d.ts"
-  ]
-}