@mirohq/design-system-types 0.8.0 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @mirohq-internal/design-system-types
 
+## 0.10.0
+
+### Minor Changes
+
+- [#617](https://github.com/miroapp-dev/design-system/pull/617) [`9ea14f4a`](https://github.com/miroapp-dev/design-system/commit/9ea14f4a48ab87d13c0a38e37186fb50ea642b02) Thanks [@ivanbanov](https://github.com/ivanbanov)! - Added two new types:
+
+  _OneOrMore_: creates a type that can be a single value or an array of that value.
+
+  ```ts
+  type Result = OneOrMore<number>
+  // number | number[]
+  ```
+
+  _MergeUnion_: merges two types by combining their properties. Overlapping properties result in a union of their values.
+
+  ```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.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

package/package.json

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

package/src/global.d.ts

@@ -1,7 +1,30 @@
+/**
+ * Convert a type into a union of the value itself with null and undefined.
+ *
+ * @example
+ * type Text = string
+ * type Result = Nullable<Text>
+ *
+ * result: string | null | undefined
+ */
 export type Nullable<T> = T | null | undefined
 
+/**
+ * A type that can be a number or a string representation of a number.
+ *
+ * @example
+ * type Num<X extends Numeric> = X
+ * type Result = Num<1 | '1'>
+ */
 export type Numeric = number | `${number}`
 
+/**
+ * A type that can be a boolean or a string representation of a boolean.
+ *
+ * @example
+ * type Bool<X extends Booleanish> = X
+ * type Result = Bool<true | 'true'>
+ */
 export type Booleanish = boolean | `${boolean}`
 
 /**
@@ -31,3 +54,46 @@ export type ExtractValidKeys<T> = T extends string | number | boolean | symbol
 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>
+
+/**
+ * Convert a type into a union of the value itself and an array of the value.
+ *
+ * @example
+ * type Result = OneOrMore<number>
+ * number | number[]
+ */
+type OneOrMore<T> = T | T[]
+
+/**
+ * Converts a union type into an intersection type.
+ *
+ * @example
+ * type Union = { foo: number } | { bar: string }
+ * type Result = UnionToIntersection<Union>
+ * { foo: number } & { bar: string }
+ */
+type UnionToIntersection<U> = (U extends any ? (x: U) => any : never) extends (
+  x: infer I
+) => any
+  ? I
+  : never