@edvisor/product-language 0.1.1 → 0.2.0

package/src/lib/helpers/slots.tsx

@@ -0,0 +1,76 @@
+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

@@ -0,0 +1,47 @@
+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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,35 @@
+{
+  "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

@@ -0,0 +1,28 @@
+{
+  "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

@@ -0,0 +1,21 @@
+{
+  "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"
+  ]
+}

package/index.d.ts

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