@mirohq/design-system-types 0.7.0 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # @mirohq-internal/design-system-types
 
+## 0.9.0
+
+### Minor Changes
+
+- [#611](https://github.com/miroapp-dev/design-system/pull/611) [`7ff8d5da`](https://github.com/miroapp-dev/design-system/commit/7ff8d5da5df65eeb28d1b6b3b0e6c12bacee97e1) Thanks [@ivanbanov](https://github.com/ivanbanov)! - Added new type MergeUnion.
+
+  Example
+
+  ```ts
+  type TypeA = { foo: number; bar: string }
+  type TypeB = { bar: boolean; baz: number }
+  type Result = MergeUnion<TypeA, TypeB>
+  // { foo: number, bar: string | boolean, baz: number }
+  ```
+
+## 0.8.0
+
+### Minor Changes
+
+- [#606](https://github.com/miroapp-dev/design-system/pull/606) [`1053d1fc`](https://github.com/miroapp-dev/design-system/commit/1053d1fc7d972cbf43e869b220af1c56719a77c7) Thanks [@ivanbanov](https://github.com/ivanbanov)! - Added new type OmitFromUnion.
+
+  Example
+
+  ```ts
+  type Union = { foo: true; x: 1 } | { bar: false; x: 2 }
+  type Result = OmitFromUnion<Union, 'x'>
+  // { foo: true } | { bar: false }
+  ```
+
+### Patch Changes
+
+- [#606](https://github.com/miroapp-dev/design-system/pull/606) [`1053d1fc`](https://github.com/miroapp-dev/design-system/commit/1053d1fc7d972cbf43e869b220af1c56719a77c7) Thanks [@ivanbanov](https://github.com/ivanbanov)! - Fixed styled component types to handle extended components returning union types.
+
+  ```tsx
+  const UnionComponent = (
+    props:
+      | { id: string; hidden?: never }
+      | { hidden: boolean; name: string }
+  ): JSX.Element => <div {...props} />
+
+  const StyledComponent = styled(UnionComponent)
+
+  // Before
+  // fail hidden and name were stripped out
+  <StyledComponent hidden name='foo' />
+
+  // Now
+  // the component will properly infer the right type
+  <StyledComponent id='foo' />
+  <StyledComponent hidden name='foo' />
+  ```
+
 ## 0.7.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mirohq/design-system-types",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "",
   "author": "Miro",
   "types": "src/index.d.ts",

package/src/global.d.ts

@@ -6,7 +6,57 @@ export type Booleanish = boolean | `${boolean}`
 
 /**
  * Extracts valid key properties from object.
+ *
+ * @example
+ * Extract valid keys from an object
+ *
+ * type Obj = 1 | 'foo' | { bar: true } | true
+ * type Result = ExtractValidKeys<Obj>
+ * 1 | 'foo' | true
  */
 export type ExtractValidKeys<T> = T extends string | number | boolean | symbol
   ? T
   : never
+
+/**
+ * Removes specified keys from a union type.
+ *
+ * @example
+ * Remove 'x' key from the union type
+ *
+ * type Union = { foo: true, x: 1 } | { bar: false, x: 2 }
+ * type Result = OmitFromUnion<Union, 'x'>
+ * { foo: true } | { bar: false }
+ */
+export type OmitFromUnion<T, K extends keyof any> = T extends any
+  ? Omit<T, K>
+  : never
+
+/**
+ * Merges two types into a new type by combining their properties.
+ * If a property exists in both types, the resulting type will have the union of their values.
+ * If a property exists in only one type, the resulting type will have the value of that property.
+ * If a property exists in both types but has different types, the resulting type will have the union of their types.
+ * Any properties that exist in the second type but not in the first type will be included in the resulting type.
+ *
+ * @example
+ * Merge two types
+ *
+ * type TypeA = { foo: number, bar: string }
+ * type TypeB = { bar: boolean, baz: number }
+ *
+ * type Result = MergeUnion<TypeA, TypeB>
+ * { foo: number, bar: string | boolean, baz: number }
+ */
+export type MergeUnion<T, U> = {
+  [K in keyof T]: K extends keyof U ? U[K] | T[K] : T[K]
+} & OmitFromUnion<U, keyof T>
+
+export interface TypeA {
+  foo: number
+  bar: string
+}
+export interface TypeB {
+  foo: boolean
+  qux: number
+}

package/src/index.d.ts

@@ -1,3 +1,2 @@
-export * from './scales'
 export * from './global'
 export * from './react'