Merge pull request #2236 from adevinta/feat-add-create-split-props

feat(internal-utils): add new createSplitProps util

packages/utils/internal-utils/src/create-split-props/index.ts

@@ -0,0 +1,26 @@
+type EnsureKeys<
+  ExpectedKeys extends (keyof Target)[],
+  Target,
+> = keyof Target extends ExpectedKeys[number]
+  ? unknown
+  : `Missing required keys: ${Exclude<keyof Target, ExpectedKeys[number]> & string}`
+
+export const createSplitProps =
+  <Target>() =>
+  <Keys extends (keyof Target)[], Props extends Target = Target>(
+    props: Props,
+    keys: Keys & EnsureKeys<Keys, Target>
+  ) =>
+    (keys as string[]).reduce<[Target, Omit<Props, Extract<(typeof keys)[number], string>>]>(
+      (previousValue, currentValue) => {
+        const [target, source] = previousValue
+        const key = currentValue as keyof Target & keyof typeof source
+        if (source[key] !== undefined) {
+          target[key] = source[key]
+        }
+        delete source[key]
+
+        return [target, source]
+      },
+      [{} as Target, { ...props }]
+    )

packages/utils/internal-utils/src/index.ts

@@ -3,3 +3,4 @@ export { makeVariants } from './variants'
 export * as VariantTypes from './variants/types'
 export * as variantConstants from './variants/constants'
 export { deepFind } from './react-children-utilities/deepFind'
+export { createSplitProps } from './create-split-props'