@edvisor/product-language 0.10.2 → 0.10.3

package/{src/lib/helpers/numbers.ts → lib/helpers/numbers.d.ts}

@@ -1,67 +1,50 @@
-export type Hex = `#${string}`
-
-export function clamp(a: number, b: number, c: number) {
-  return Math.max(a, Math.min(b, c))
-}
-
-export function toHex(n: number, length: number): Hex {
-  return `#${n.toString(16).padStart(length, '0').toUpperCase()}`
-}
-
-export function concatHex(a: Hex, b: Hex): Hex {
-  return `#${a.slice(1) + b.slice(1)}`
-}
-
-/** given an array of boolean flags, bitwiseOr interprets them as an unsigned integer
- * 
- * ```ts
- * bitwiseOr([false, true, false, true]) => 5 // 0b0101
- * ```
- * 
- * This is useful for indexing into an enum:
- * 
- * ```ts
- * const enum Level {
- *   default = 0,
- *   info = 0,
- *   danger = 1,
- *   warning = 2
- * }
- * 
- * interface IProps {
- *  info?: boolean
- *  danger?: boolean
- *  warning?: boolean
- * }
- * 
- * function toLevel(n: number): Level {
- *   switch (n) {
- *     case Level.info: return Level.info
- *     case Level.danger: return Level.danger
- *     case Level.warning: return Level.warning
- *     default: return Level.default
- *   }
- * }
- * 
- * const level = bitwiseOr([props.info, props.danger, props.warning])
- * 
- * const levelEnum = toLevel(level)
- * ```
-*/
-export function bitwiseOr(flags: unknown[]): number {
-  return flags.reduce((mask: number, flag, i) => mask | (Number(flag) << i), 0)
-}
-
-
-/** given a number, it returns the number formed by the rightmost set bit as 1 and the 0s that comes after it
- * 
- * ```ts
- * getRightmostSetBitNumber(12) => 4 // 12(1100) => 4(100)
- * getRightmostSetBitNumber(40) => 8 // 40(101000) => 8(1000)
- * ```
- * 
- * */
-
-export function getRightmostSetBitNumber(n: number) {
-  return n & -n
-}
+export declare type Hex = `#${string}`;
+export declare function clamp(a: number, b: number, c: number): number;
+export declare function toHex(n: number, length: number): Hex;
+export declare function concatHex(a: Hex, b: Hex): Hex;
+/** given an array of boolean flags, bitwiseOr interprets them as an unsigned integer
+ *
+ * ```ts
+ * bitwiseOr([false, true, false, true]) => 5 // 0b0101
+ * ```
+ *
+ * This is useful for indexing into an enum:
+ *
+ * ```ts
+ * const enum Level {
+ *   default = 0,
+ *   info = 0,
+ *   danger = 1,
+ *   warning = 2
+ * }
+ *
+ * interface IProps {
+ *  info?: boolean
+ *  danger?: boolean
+ *  warning?: boolean
+ * }
+ *
+ * function toLevel(n: number): Level {
+ *   switch (n) {
+ *     case Level.info: return Level.info
+ *     case Level.danger: return Level.danger
+ *     case Level.warning: return Level.warning
+ *     default: return Level.default
+ *   }
+ * }
+ *
+ * const level = bitwiseOr([props.info, props.danger, props.warning])
+ *
+ * const levelEnum = toLevel(level)
+ * ```
+*/
+export declare function bitwiseOr(flags: unknown[]): number;
+/** given a number, it returns the number formed by the rightmost set bit as 1 and the 0s that comes after it
+ *
+ * ```ts
+ * getRightmostSetBitNumber(12) => 4 // 12(1100) => 4(100)
+ * getRightmostSetBitNumber(40) => 8 // 40(101000) => 8(1000)
+ * ```
+ *
+ * */
+export declare function getRightmostSetBitNumber(n: number): number;

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

@@ -0,0 +1,17 @@
+/** 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
+ */
+export declare function isNil<T>(value: T | undefined | null): value is undefined | null;
+export declare function isDefined<T>(value: T | undefined | null): value is T;
+export declare function defaultTo<T>(value: T | undefined | null, fallback: T): T;
+export declare function isEmpty<T extends {
+    length: number;
+}>(obj: T): boolean;
+/** used for evaluating tri-state logic (true | false | undefined) */
+export declare function is(pred?: boolean): boolean;
+export declare function toArray<T>(obj: T | T[] | undefined | null): T[];
+export declare function safeArray<T>(arr: T[] | undefined | null): T[];
+export declare function safeCallback<T>(f?: (e: T) => void, e?: T): void;
+export { first, isString, isFunction, uniqueId, debounce, throttle, } from 'lodash';

package/lib/helpers/slots.d.ts

@@ -0,0 +1,17 @@
+import { CSSProperties, PureComponent, ReactElement, ReactNode } from 'react';
+import { FC, PropsWithChildren } from './generic-types';
+export declare const isSlotOfType: <T extends typeof Slot>(type: T | FC<{}, {}>) => (obj?: any) => obj is T;
+export declare class Slot<T = unknown> extends PureComponent<PropsWithChildren<T>> {
+    render(): PropsWithChildren<T>["children"] | undefined;
+}
+export declare class StylableSlot extends Slot {
+    render(): JSX.Element;
+}
+/** gets children that are _not_ slots */
+export declare function getOtherChildren(children?: ReactNode): ReactNode[];
+export declare function getSlots<T extends typeof Slot>(slot: T, children?: ReactNode): ReactElement[];
+export declare function getSlot<T extends typeof Slot>(slot: T, children?: ReactNode): ReactElement;
+/** given a ReactElement, like a child, apply the given props to it */
+export declare function applyProps<T>(element: ReactElement<T>, props: Partial<T>): ReactElement;
+/** given a ReactElement, like a child, apply the given styles to it, merging with the existing styles */
+export declare function applyStyle(element: ReactElement, style: CSSProperties): ReactElement;

package/lib/helpers/strings.d.ts

@@ -0,0 +1 @@
+export declare const toKebabCase: (str: string) => string;

package/lib/helpers/useInputElementState.d.ts

@@ -0,0 +1,30 @@
+declare type IInputElementState<T> = [
+    T | undefined,
+    (change: T) => void
+];
+/**
+ *
+ * This hook is to help implement a common pattern:
+ *
+ * <input onChange={doSomething} /> // uncontrolled
+ * <input value={1} /> // should be marked read only
+ * <input value={state} onChange={setState} /> // controlled
+ *
+ * I've reimplemented this logic a few times, but now I have a nice helper :D
+ *
+ * const [state, setState] = useInputElementState({
+ *   value: props.value,
+ *   defaultValue: props.defaultValue, // the value to use if value is undefined
+ *   onChange: props.onChange,
+ * })
+ *
+ * if you give it nothing, you get state, setState for internal state management (uncontrolled input)
+ * if you give it value only, you get a warning
+ * if you give it value and onChange, state management if deferred to the parent (controlled input)
+ */
+export declare function useInputElementState<T>(props: {
+    value?: T;
+    defaultValue?: T;
+    onChange?: (change: T) => void;
+}): IInputElementState<T>;
+export {};

package/lib/helpers/useKeyDown.d.ts

@@ -0,0 +1 @@
+export declare function useKeyDown(targetKey: string, handler: () => void): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edvisor/product-language",
-  "version": "0.10.2",
+  "version": "0.10.3",
   "license": "MIT",
   "description": "Edvisor.io product-language components",
   "repository": "https://github.com/edvisor-io/front-end/",
@@ -8,7 +8,7 @@
     "@types/jest-axe": "^3.5.4"
   },
   "scripts": {
-    "release": "release-it --disable-metrics --npm.skipChecks"
+    "release": "release-it --disable-metrics"
   },
   "peerDependencies": {
     "release": "*",
@@ -17,5 +17,30 @@
     "styled-components": "*",
     "lodash": "*",
     "@storybook/addon-docs": "*"
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true
+    },
+    "npm": {
+      "publish": false
+    },
+    "publishConfig": {
+      "registry": "https://registry.npmjs.org"
+    }
+  },
+  "module": "./index.js",
+  "main": "./index.js",
+  "type": "module",
+  "types": "./index.d.ts",
+  "dependencies": {
+    "react-multi-date-picker": "^3.3.4",
+    "recharts": "^2.1.16",
+    "react-compound-slider": "^3.4.0",
+    "react-window": "^1.8.8"
   }
 }

package/.babelrc

@@ -1,12 +0,0 @@
-{
-  "presets": [
-    [
-      "@nrwl/react/babel",
-      {
-        "runtime": "automatic",
-        "useBuiltIns": "usage"
-      }
-    ]
-  ],
-  "plugins": [["styled-components", { "pure": true, "ssr": true }]]
-}

package/.eslintrc.json

@@ -1,147 +0,0 @@
-{
-  "extends": ["plugin:@nrwl/nx/react", "../../.eslintrc.json"],
-  "ignorePatterns": ["!**/*"],
-  "plugins": [
-    "no-null"
-  ],
-  "overrides": [
-    {
-      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
-      "rules": {
-        "semi": ["error", "never"],
-        "quotes": ["error", "single"],
-        "no-console": "warn",
-        "react/jsx-no-useless-fragment": ["warn", { "allowExpressions": true }], 
-        "no-null/no-null": 2,
-        "no-duplicate-case": "warn",
-        "no-restricted-syntax": [
-          "error",
-          {
-            "selector": "ImportDeclaration[source.value=/[^@]foundations/i]",
-            "message": "Import from @foundations instead of using a relative path"
-          },
-          {
-            "selector": "ImportDeclaration[source.value=/react/i] ImportSpecifier[imported.name=/FC/]",
-            "message": "Use `import { FC } from '@helpers'` instead"
-          },
-          {
-            "selector": "ImportDeclaration[source.value=/react/i] ImportSpecifier[imported.name=/PropsWithChildren/]",
-            "message": "Use `import { PropsWithChildren } from '@helpers'` instead"
-          },
-          {
-            "selector": "ImportDeclaration[source.value=/react/i] ImportSpecifier[imported.name=/forwardRef/]",
-            "message": "Use `import { forwardRef } from '@helpers'` instead"
-          },
-          {
-            "selector": "ImportDeclaration[source.value=/testing-library/i] ImportSpecifier[imported.name=/fireEvent/]",
-            "message": "Prefer `import userEvent from '@testing-library/user-event'` wherever possible.\n@see: https://edvisorio.atlassian.net/wiki/spaces/ENG/pages/235307017/First+contact+with+Testing+Library#Handling-Events"
-          },
-          {
-            "selector": "Literal[value=/[^&]#[a-zA-Z0-9]{1,6}/i]",
-            "message": "No hex literals, please import constants from @foundations"
-          },
-          {
-            "selector": "Literal[value=/padding.*: ([0-9]|')/i]",
-            "message": "No string pixel values for css padding, please import Padding from @foundations"
-          },
-          {
-            "selector": "TemplateElement[value.cooked=/[^&]#[a-zA-Z0-9]{1,6}/i]",
-            "message": "No hex literals, please import constants from @foundations"
-          },
-          {
-            "selector": "TemplateElement[value.cooked=/padding.*: ([0-9]|')/i]",
-            "message": "No ad-hoc padding, please import { Padding } from '@foundations'"
-          },
-          {
-            "selector": "TemplateElement[value.cooked=/margin.*: ([0-9]|')/i]",
-            "message": "No ad-hoc margins, please import { Margin } from '@foundations'"
-          }
-        ]
-      }
-    },
-    {
-      "files": ["*.ts", "*.tsx"],
-      "parserOptions": {
-        "project": ["packages/product-language/tsconfig.*?.json", "packages/product-language/.storybook/tsconfig.json"]
-      },
-      "rules": {
-        "no-shadow": "off",
-        "@typescript-eslint/no-shadow": "warn",
-        "@typescript-eslint/no-explicit-any": "error",
-        "@typescript-eslint/no-invalid-void-type": "error",
-        "@typescript-eslint/ban-types": ["error", {
-          "types": {
-            "null": "Use 'undefined' instead of 'null'",
-            "React.FC": "Use `import { FC } from '@helpers'` instead",
-            "React.PropsWithChildren": "Use `import { PropsWithChildren } from '@helpers'` instead",
-            "React.forwardRef": "Use `import { forwardRef } from '@helpers'` instead"
-          }
-        }],
-        "@typescript-eslint/strict-boolean-expressions": ["error", {
-          "allowString": false,
-          "allowNumber": false,
-          "allowNullableObject": false
-        }]
-      }
-    },
-    {
-      "files": ["*.tsx"],
-      "parserOptions": {
-        "project": ["packages/product-language/tsconfig.*?.json"]
-      },
-      "rules": {
-        "no-restricted-syntax": [
-          "error",
-          {
-            "selector": "FunctionDeclaration[id.name=/^[A-Z]/]",
-            "message": "Components should be declared `const MyComponent: FC<IProps> = (props) => {`"
-          },
-          {
-            "selector": "ImportDeclaration[source.value=/[^@]foundations/i]",
-            "message": "Import from @foundations instead of using a relative path"
-          },
-          {
-            "selector": "ImportDeclaration[source.value=/react/i] ImportSpecifier[imported.name=/FC/]",
-            "message": "Use `import { FC } from '@helpers'` instead"
-          },
-          {
-            "selector": "ImportDeclaration[source.value=/react/i] ImportSpecifier[imported.name=/PropsWithChildren/]",
-            "message": "Use `import { Props } from '@helpers'` instead"
-          },
-          {
-            "selector": "ImportDeclaration[source.value=/react/i] ImportSpecifier[imported.name=/forwardRef/]",
-            "message": "Use `import { forwardRef } from '@helpers'` instead"
-          },
-          {
-            "selector": "ImportDeclaration[source.value=/testing-library/i] ImportSpecifier[imported.name=/fireEvent/]",
-            "message": "Prefer `import userEvent from '@testing-library/user-event'` wherever possible.\n@see: https://edvisorio.atlassian.net/wiki/spaces/ENG/pages/235307017/First+contact+with+Testing+Library#Handling-Events"
-          },
-          {
-            "selector": "Literal[value=/[^&]#[a-zA-Z0-9]{1,6}/i]",
-            "message": "No hex literals, please import constants from @foundations"
-          },
-          {
-            "selector": "Literal[value=/padding.*: ([0-9]|')/i]",
-            "message": "No string pixel values for css padding, please import Padding from @foundations"
-          },
-          {
-            "selector": "TemplateElement[value.cooked=/[^&]#[a-zA-Z0-9]{1,6}/i]",
-            "message": "No hex literals, please import constants from @foundations"
-          },
-          {
-            "selector": "TemplateElement[value.cooked=/padding.*: ([0-9]|')/i]",
-            "message": "No ad-hoc padding, please import { Padding } from '@foundations'"
-          },
-          {
-            "selector": "TemplateElement[value.cooked=/margin.*: ([0-9]|')/i]",
-            "message": "No ad-hoc margins, please import { Margin } from '@foundations'"
-          }
-        ]
-      }
-    },
-    {
-      "files": ["*.js", "*.jsx"],
-      "rules": {}
-    }
-  ]
-}

package/.release-it.json

@@ -1,17 +0,0 @@
-{
-  "git": {
-    "requireCleanWorkingDir": false,
-    "commitMessage": "chore: release ${version}  [skip ci]",
-    "tagName": "v${version}"
-  },
-  "github": {
-    "release": true,
-    "tokenRef": "BOB"
-  },
-  "npm": {
-    "publish": true
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  }
-}

package/.storybook/main.js

@@ -1,57 +0,0 @@
-const rootMain = require('../../../.storybook/main')
-const path = require('path')
-const webpack = require('webpack')
-
-// we can't import from our design-system here
-// so I'm replicating the constant
-// eslint-disable-next-line no-restricted-syntax
-const backgroundDefault = '#F3F4F6'
-
-module.exports = {
-  ...rootMain,
-
-  core: { ...rootMain.core, builder: 'webpack5' },
-
-  stories: [
-    ...rootMain.stories,
-    '../src/lib/**/*.stories.mdx',
-    '../src/lib/**/*.stories.@(js|jsx|ts|tsx)',
-  ],
-  addons: [...rootMain.addons, '@nrwl/react/plugins/storybook'],
-  staticDirs: [{from: '../src/assets', to:'/public'}],
-  webpackFinal: async (config, { configType }) => {
-    // apply any global webpack configs that might have been specified in .storybook/main.js
-    if (rootMain.webpackFinal) {
-      config = await rootMain.webpackFinal(config, { configType })
-    }
-
-    config.plugins.push(
-      new webpack.ProvidePlugin({
-        Buffer: ['buffer', 'Buffer'],
-      }),
-    )
-
-    config.module.rules.push({
-      test: /\.(png|woff|woff2|eot|ttf|svg)$/,
-      use: [
-        {
-          loader: require.resolve('file-loader'),
-          options: {
-            name: '[name].[ext]'
-          }
-        }
-      ],
-      include: path.resolve(__dirname, '../')
-    })
-
-    return config
-  },
-  previewHead: (head) => `
-  ${head}
-  <style>
-    html, body {
-      background: ${backgroundDefault};
-    }
-  </style>
-`,
-}

package/.storybook/manager.js

@@ -1,7 +0,0 @@
-import { addons } from '@storybook/addons'
-
-addons.setConfig({
-  sidebar: {
-    showRoots: true,
-  },
-})

package/.storybook/preview.js

@@ -1,15 +0,0 @@
-import { liveDecorator } from 'storybook-addon-jarle-monaco'
-
-export const parameters = {
-  actions: { argTypesRegex: '^on[A-Z].*' },
-  controls: {
-    matchers: {
-      color: /(background|color)$/i,
-      date: /Date$/,
-    },
-  },
-}
-
-export const decorators = [
-  liveDecorator
-]

package/.storybook/tsconfig.json

@@ -1,30 +0,0 @@
-{
-  "extends": "../tsconfig.json",
-  "compilerOptions": {
-    "emitDecoratorMetadata": true,
-    "outDir": "",
-    "noEmit": true
-  },
-  "files": [
-    "../../../node_modules/@nrwl/react/typings/styled-jsx.d.ts",
-    "../../../node_modules/@nrwl/react/typings/cssmodule.d.ts",
-    "../../../node_modules/@nrwl/react/typings/image.d.ts"
-  ],
-
-  "exclude": [
-    "../**/*.spec.ts",
-    "../**/*.spec.js",
-    "../**/*.spec.tsx",
-    "../**/*.spec.jsx"
-  ],
-  "include": [
-    "../src/**/storybook/*",
-    "../src/**/stories/*",
-    "../src/**/*.stories.ts",
-    "../src/**/*.stories.js",
-    "../src/**/*.stories.jsx",
-    "../src/**/*.stories.tsx",
-    "../src/**/*.stories.mdx",
-    "*.js"
-  ]
-}

package/jest.config.ts

@@ -1,15 +0,0 @@
-/* eslint-disable */
-export default {
-  displayName: 'product-language',
-  preset: '../../jest.preset.js',
-  transform: {
-    '^.+\\.[tj]sx?$': 'babel-jest',
-  },
-  moduleNameMapper: {
-    '^.+\\.(jpg|ico|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2)$': '<rootDir>/fileTransformer.js',
-    '^.+\\.(css)$': 'identity-obj-proxy',//we can remove if we dont have css files
-  },
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
-  coverageDirectory: '../../coverage/packages/product-language',
-  setupFilesAfterEnv: ['./jest.setup.ts'],
-};

package/jest.setup.ts

@@ -1,2 +0,0 @@
-import '@testing-library/jest-dom'
-import 'jest-axe/extend-expect'

package/project.json

@@ -1,98 +0,0 @@
-{
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/product-language/src",
-  "projectType": "library",
-  "tags": [],
-  "targets": {
-    "build": {
-      "executor": "@nrwl/web:rollup",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "dist/packages/product-language",
-        "tsConfig": "packages/product-language/tsconfig.lib.json",
-        "project": "packages/product-language/package.json",
-        "entryFile": "packages/product-language/src/index.ts",
-        "external": ["react/jsx-runtime"],
-        "rollupConfig": "@nrwl/react/plugins/bundle-rollup",
-        "compiler": "babel",
-        "assets": [
-          {
-            "glob": "packages/product-language/README.md",
-            "input": ".",
-            "output": "."
-          }
-        ],
-        "updateBuildableProjectDepsInPackageJson": true,
-        "buildableProjectDepsInPackageJsonType": "dependencies"
-      }
-    },
-    "dev": {
-      "executor": "@nrwl/web:rollup",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "watch": true,
-        "outputPath": "../react-web-client/product-language",
-        "tsConfig": "packages/product-language/tsconfig.lib.json",
-        "project": "packages/product-language/package.json",
-        "entryFile": "packages/product-language/src/index.ts",
-        "external": ["react/jsx-runtime"],
-        "rollupConfig": "@nrwl/react/plugins/bundle-rollup",
-        "compiler": "babel",
-        "assets": [
-          {
-            "glob": "packages/product-language/README.md",
-            "input": ".",
-            "output": "."
-          }
-        ]
-      }
-    },
-    "lint": {
-      "executor": "@nrwl/linter:eslint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": ["packages/product-language/**/*.{ts,tsx,js,jsx}"]
-      }
-    },
-    "test": {
-      "executor": "@nrwl/jest:jest",
-      "outputs": ["coverage/packages/product-language"],
-      "options": {
-        "jestConfig": "packages/product-language/jest.config.ts",
-        "passWithNoTests": true
-      }
-    },
-    "storybook": {
-      "executor": "@nrwl/storybook:storybook",
-      "options": {
-        "uiFramework": "@storybook/react",
-        "tsConfig": "packages/product-language/tsconfig.storybook.json",
-        "port": 4400,
-        "config": {
-          "configFolder": "packages/product-language/.storybook"
-        }
-      },
-      "configurations": {
-        "ci": {
-          "quiet": true
-        }
-      }
-    },
-    "build-storybook": {
-      "executor": "@nrwl/storybook:build",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "uiFramework": "@storybook/react",
-        "outputPath": "dist/storybook/product-language",
-        "config": {
-          "configFolder": "packages/product-language/.storybook"
-        }
-      },
-      "configurations": {
-        "ci": {
-          "quiet": true
-        }
-      }
-    }
-  }
-}