@trackunit/shared-utils 0.0.23 → 0.0.28-alpha-9c359562be.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/shared-utils",
-  "version": "0.0.23",
+  "version": "0.0.28-alpha-9c359562be.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/typeUtils.d.ts

@@ -29,4 +29,27 @@ type Truthy<T> = T extends false | "" | 0 | null | undefined ? never : T;
  *
  */
 export declare const truthy: <T>(value: T) => value is Truthy<T>;
+/**
+ * Constructs a type by excluding specified keys from another type in a homomorphic manner.
+ * Homomorphic types maintain the same shape as the original type but exclude specified keys.
+ * For example works correctly on descriminated unions whereas Omit messes up the type.
+ * https://github.com/microsoft/TypeScript/issues/54451
+ *
+ * @template T - The original type.
+ * @template K - The keys to be excluded from the original type.
+ * @property {T} P - The resulting type excluding the keys specified by K while preserving the original structure.
+ */
+export type MappedOmit<T, K extends keyof T> = {
+    [P in keyof T as P extends K ? never : P]: T[P];
+};
+/**
+ * Creates a new type by making a specific property optional within the original type.
+ *
+ * @template BaseType - The original type from which a property will be made optional.
+ * @template OptionalProp - The key of the property to be made optional.
+ * @param {BaseType} obj - The object whose property needs to be made optional.
+ * @param {OptionalProp} propKey - The key of the property to be made optional.
+ * @returns {Omit<BaseType, OptionalProp> & Partial<Pick<BaseType, OptionalProp>>} - A type with the specified property made optional.
+ */
+export type MakePropertyOptional<BaseType, OptionalProp extends keyof BaseType> = MappedOmit<BaseType, OptionalProp> & Partial<Pick<BaseType, OptionalProp>>;
 export {};