@hexclave/shared 1.0.0

package/dist/esm/utils/objects.d.ts

@@ -0,0 +1,59 @@
+//#region src/utils/objects.d.ts
+declare function isNotNull<T>(value: T): value is NonNullable<T>;
+type DeepPartial<T> = T extends object ? (T extends any[] ? { [P in keyof T]: DeepPartial<T[P]> } : { [P in keyof T]?: DeepPartial<T[P]> }) : T;
+type DeepRequired<T> = T extends object ? { [P in keyof T]-?: DeepRequired<T[P]> } : T;
+type DeepRequiredOrUndefined<T> = T extends object ? { [P in keyof { [K in keyof T]-?: K }]: DeepRequiredOrUndefined<T[P]> } : T;
+/**
+ * Assumes both objects are primitives, arrays, or non-function plain objects, and compares them deeply.
+ *
+ * Note that since they are assumed to be plain objects, this function does not compare prototypes.
+ */
+declare function deepPlainEquals<T>(obj1: T, obj2: unknown, options?: {
+  ignoreUndefinedValues?: boolean;
+}): obj2 is T;
+declare function isCloneable<T>(obj: T): obj is Exclude<T, symbol | Function>;
+declare function shallowClone<T extends object>(obj: T): T;
+declare function deepPlainClone<T>(obj: T): T;
+type DeepMerge<T, U> = U extends any ? DeepMergeNonDistributive<T, U> : never;
+type DeepMergeNonDistributive<T, U> = Omit<T, keyof U> & Omit<U, keyof T> & DeepMergeInner<Pick<T, keyof U & keyof T>, Pick<U, keyof U & keyof T>>;
+type DeepMergeInner<T, U> = { [K in { [Ki in keyof U]-?: Ki }[keyof U]]: undefined extends U[K] ? K extends keyof T ? T[K] extends object ? Exclude<U[K], undefined> extends object ? DeepMerge<T[K], Exclude<U[K], undefined>> : T[K] | Exclude<U[K], undefined> : T[K] | Exclude<U[K], undefined> : Exclude<U[K], undefined> : K extends keyof T ? T[K] extends object ? U[K] extends object ? DeepMerge<T[K], U[K]> : U[K] : U[K] : U[K] };
+declare function deepMerge<T extends {}, U extends {}>(baseObj: T, mergeObj: U): DeepMerge<T, U>;
+type DeepOmit<T, U> = T extends object ? { [K in keyof T]: K extends keyof U ? (T[K] extends U[K] ? undefined : T[K]) : T[K] } : (T extends U ? undefined : T);
+declare function typedEntries<T extends {}>(obj: T): [Exclude<keyof T, number>, T[keyof T]][];
+declare function typedFromEntries<K extends PropertyKey, V>(entries: (readonly [K, V])[]): Record<K, V>;
+declare function typedKeys<T extends {}>(obj: T): (Exclude<keyof T, number>)[];
+declare function typedValues<T extends {}>(obj: T): T[keyof T][];
+declare function typedAssign<T extends {}, U extends {}>(target: T, source: U): T & U;
+type FilterUndefined<T> = { [k in keyof T as (undefined extends T[k] ? (T[k] extends undefined | void ? never : k) : never)]+?: T[k] & ({} | null) } & { [k in keyof T as (undefined extends T[k] ? never : k)]: T[k] & ({} | null) };
+/**
+ * Returns a new object with all undefined values removed. Useful when spreading optional parameters on an object, as
+ * TypeScript's `Partial<XYZ>` type allows `undefined` values.
+ */
+declare function filterUndefined<T extends object>(obj: T): FilterUndefined<T>;
+type FilterUndefinedOrNull<T> = FilterUndefined<{ [k in keyof T]: null extends T[k] ? NonNullable<T[k]> | undefined : T[k] }>;
+/**
+ * Returns a new object with all undefined and null values removed. Useful when spreading optional parameters on an object, as
+ * TypeScript's `Partial<XYZ>` type allows `undefined` values.
+ */
+declare function filterUndefinedOrNull<T extends object>(obj: T): FilterUndefinedOrNull<T>;
+type DeepFilterUndefined<T> = T extends object ? FilterUndefined<{ [K in keyof T]: DeepFilterUndefined<T[K]> }> : T;
+declare function deepFilterUndefined<T extends object>(obj: T): DeepFilterUndefined<T>;
+declare function pick<T extends {}, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
+declare function omit<T extends {}, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+declare function split<T extends {}, K extends keyof T>(obj: T, keys: K[]): [Pick<T, K>, Omit<T, K>];
+declare function mapValues<T extends object, U>(obj: T, fn: (value: T extends (infer E)[] ? E : T[keyof T], key: keyof T) => U): Record<keyof T, U>;
+declare function sortKeys<T extends object>(obj: T): T;
+declare function deepSortKeys<T extends object>(obj: T): T;
+declare function set<T extends object, K extends PropertyKey = keyof T>(obj: T, key: K, value: T[K & keyof T]): void;
+declare function get<T extends object, K extends PropertyKey = keyof T>(obj: T, key: K): T[K & keyof T];
+declare function getOrUndefined<T extends object, K extends PropertyKey = keyof T>(obj: T, key: K): T[K & keyof T] | undefined;
+declare function has<T extends object, K extends PropertyKey = keyof T>(obj: T, key: K): obj is T & { [k in K & keyof T]: unknown };
+declare function hasAndNotUndefined<T extends object, K extends keyof T>(obj: T, key: K): obj is T & { [k in K]: Exclude<T[K], undefined> };
+declare function deleteKey<T extends object, K extends keyof T>(obj: T, key: K): void;
+/**
+ * Returns true iff the value is an object or a function, but not null.
+ */
+declare function isObjectLike(value: unknown): value is object | Function;
+//#endregion
+export { DeepFilterUndefined, DeepMerge, DeepOmit, DeepPartial, DeepRequired, DeepRequiredOrUndefined, FilterUndefined, FilterUndefinedOrNull, deepFilterUndefined, deepMerge, deepPlainClone, deepPlainEquals, deepSortKeys, deleteKey, filterUndefined, filterUndefinedOrNull, get, getOrUndefined, has, hasAndNotUndefined, isCloneable, isNotNull, isObjectLike, mapValues, omit, pick, set, shallowClone, sortKeys, split, typedAssign, typedEntries, typedFromEntries, typedKeys, typedValues };
+//# sourceMappingURL=objects.d.ts.map

package/dist/esm/utils/objects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.d.ts","names":[],"sources":["../../../src/utils/objects.tsx"],"mappings":";iBAKgB,SAAA,GAAA,CAAa,KAAA,EAAO,CAAA,GAAI,KAAA,IAAS,WAAA,CAAY,CAAA;AAAA,KAajD,WAAA,MAAiB,CAAA,mBAAoB,CAAA,+BAAgC,CAAA,GAAI,WAAA,CAAY,CAAA,CAAE,CAAA,qBAAsB,CAAA,IAAK,WAAA,CAAY,CAAA,CAAE,CAAA,QAAS,CAAA;AAAA,KACzI,YAAA,MAAkB,CAAA,gCAAiC,CAAA,KAAM,YAAA,CAAa,CAAA,CAAE,CAAA,OAAQ,CAAA;AAAA,KAChF,uBAAA,MAA6B,CAAA,8CAA+C,CAAA,KAAM,CAAA,KAAK,uBAAA,CAAwB,CAAA,CAAE,CAAA,OAAQ,CAAA;;;;AAFrI;;iBAUgB,eAAA,GAAA,CAAmB,IAAA,EAAM,CAAA,EAAG,IAAA,WAAe,OAAA;EAAW,qBAAA;AAAA,IAAyC,IAAA,IAAQ,CAAA;AAAA,iBA+DvG,WAAA,GAAA,CAAe,GAAA,EAAK,CAAA,GAAI,GAAA,IAAO,OAAA,CAAQ,CAAA,WAAY,QAAA;AAAA,iBAInD,YAAA,kBAAA,CAA+B,GAAA,EAAK,CAAA,GAAI,CAAA;AAAA,iBAYxC,cAAA,GAAA,CAAkB,GAAA,EAAK,CAAA,GAAI,CAAA;AAAA,KAuC/B,SAAA,SAAkB,CAAA,eAAgB,wBAAA,CAAyB,CAAA,EAAG,CAAA;AAAA,KACrE,wBAAA,SAAiC,IAAA,CAAK,CAAA,QAAS,CAAA,IAAK,IAAA,CAAK,CAAA,QAAS,CAAA,IAAK,cAAA,CAAe,IAAA,CAAK,CAAA,QAAS,CAAA,SAAU,CAAA,GAAI,IAAA,CAAK,CAAA,QAAS,CAAA,SAAU,CAAA;AAAA,KAC1I,cAAA,gCACkB,CAAA,KAAM,EAAA,SAAW,CAAA,sBAClB,CAAA,CAAE,CAAA,IAChB,CAAA,eAAgB,CAAA,GACZ,CAAA,CAAE,CAAA,mBACE,OAAA,CAAQ,CAAA,CAAE,CAAA,+BACN,SAAA,CAAU,CAAA,CAAE,CAAA,GAAI,OAAA,CAAQ,CAAA,CAAE,CAAA,iBAC1B,CAAA,CAAE,CAAA,IAAK,OAAA,CAAQ,CAAA,CAAE,CAAA,gBACrB,CAAA,CAAE,CAAA,IAAK,OAAA,CAAQ,CAAA,CAAE,CAAA,gBACrB,OAAA,CAAQ,CAAA,CAAE,CAAA,gBACd,CAAA,eAAgB,CAAA,GACZ,CAAA,CAAE,CAAA,mBACE,CAAA,CAAE,CAAA,mBACE,SAAA,CAAU,CAAA,CAAE,CAAA,GAAI,CAAA,CAAE,CAAA,KAClB,CAAA,CAAE,CAAA,IACN,CAAA,CAAE,CAAA,IACN,CAAA,CAAE,CAAA;AAAA,iBAEE,SAAA,4BAAA,CAAsC,OAAA,EAAS,CAAA,EAAG,QAAA,EAAU,CAAA,GAAI,SAAA,CAAU,CAAA,EAAG,CAAA;AAAA,KA8FjF,QAAA,SAAiB,CAAA,gCAAiC,CAAA,GAAI,CAAA,eAAgB,CAAA,IAAK,CAAA,CAAE,CAAA,UAAW,CAAA,CAAE,CAAA,gBAAiB,CAAA,CAAE,CAAA,KAAM,CAAA,CAAE,CAAA,OAAQ,CAAA,SAAU,CAAA,eAAgB,CAAA;AAAA,iBAEnJ,YAAA,cAAA,CAA2B,GAAA,EAAK,CAAA,IAAK,OAAA,OAAc,CAAA,WAAY,CAAA,OAAQ,CAAA;AAAA,iBAkBvE,gBAAA,WAA2B,WAAA,IAAA,CAAgB,OAAA,aAAoB,CAAA,EAAG,CAAA,OAAQ,MAAA,CAAO,CAAA,EAAG,CAAA;AAAA,iBAuBpF,SAAA,cAAA,CAAwB,GAAA,EAAK,CAAA,IAAK,OAAA,OAAc,CAAA;AAAA,iBAahD,WAAA,cAAA,CAA0B,GAAA,EAAK,CAAA,GAAI,CAAA,OAAQ,CAAA;AAAA,iBAyB3C,WAAA,4BAAA,CAAwC,MAAA,EAAQ,CAAA,EAAG,MAAA,EAAQ,CAAA,GAAI,CAAA,GAAI,CAAA;AAAA,KAuBvE,eAAA,oBACM,CAAA,uBAAwB,CAAA,CAAE,CAAA,KAAM,CAAA,CAAE,CAAA,qCAAsC,CAAA,eAAgB,CAAA,CAAE,CAAA,kCAC1F,CAAA,uBAAwB,CAAA,CAAE,CAAA,YAAa,CAAA,IAAK,CAAA,CAAE,CAAA;;;;AA3VhE;iBAiWgB,eAAA,kBAAA,CAAkC,GAAA,EAAK,CAAA,GAAI,eAAA,CAAgB,CAAA;AAAA,KAY/D,qBAAA,MAA2B,eAAA,eAA8B,CAAA,gBAAiB,CAAA,CAAE,CAAA,IAAK,WAAA,CAAY,CAAA,CAAE,CAAA,iBAAkB,CAAA,CAAE,CAAA;;;;;iBAM/G,qBAAA,kBAAA,CAAwC,GAAA,EAAK,CAAA,GAAI,qBAAA,CAAsB,CAAA;AAAA,KAQ3E,mBAAA,MAAyB,CAAA,kBAAmB,eAAA,eAA8B,CAAA,GAAI,mBAAA,CAAoB,CAAA,CAAE,CAAA,QAAS,CAAA;AAAA,iBAGzG,mBAAA,kBAAA,CAAsC,GAAA,EAAK,CAAA,GAAI,mBAAA,CAAoB,CAAA;AAAA,iBAOnE,IAAA,+BAAmC,CAAA,CAAA,CAAG,GAAA,EAAK,CAAA,EAAG,IAAA,EAAM,CAAA,KAAM,IAAA,CAAK,CAAA,EAAG,CAAA;AAAA,iBAYlE,IAAA,+BAAmC,CAAA,CAAA,CAAG,GAAA,EAAK,CAAA,EAAG,IAAA,EAAM,CAAA,KAAM,IAAA,CAAK,CAAA,EAAG,CAAA;AAAA,iBAalE,KAAA,+BAAoC,CAAA,CAAA,CAAG,GAAA,EAAK,CAAA,EAAG,IAAA,EAAM,CAAA,MAAO,IAAA,CAAK,CAAA,EAAG,CAAA,GAAI,IAAA,CAAK,CAAA,EAAG,CAAA;AAAA,iBAYhF,SAAA,qBAAA,CAA+B,GAAA,EAAK,CAAA,EAAG,EAAA,GAAK,KAAA,EAAO,CAAA,uBAAwB,CAAA,GAAI,CAAA,OAAQ,CAAA,GAAI,GAAA,QAAW,CAAA,KAAM,CAAA,GAAI,MAAA,OAAa,CAAA,EAAG,CAAA;AAAA,iBAWhI,QAAA,kBAAA,CAA2B,GAAA,EAAK,CAAA,GAAI,CAAA;AAAA,iBAyCpC,YAAA,kBAAA,CAA+B,GAAA,EAAK,CAAA,GAAI,CAAA;AAAA,iBAmCxC,GAAA,6BAAgC,WAAA,SAAoB,CAAA,CAAA,CAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,CAAA,EAAG,KAAA,EAAO,CAAA,CAAE,CAAA,SAAU,CAAA;AAAA,iBAK1F,GAAA,6BAAgC,WAAA,SAAoB,CAAA,CAAA,CAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,CAAA,GAAI,CAAA,CAAE,CAAA,SAAU,CAAA;AAAA,iBAOpF,cAAA,6BAA2C,WAAA,SAAoB,CAAA,CAAA,CAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,CAAA,GAAI,CAAA,CAAE,CAAA,SAAU,CAAA;AAAA,iBAK/F,GAAA,6BAAgC,WAAA,SAAoB,CAAA,CAAA,CAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,CAAA,GAAI,GAAA,IAAO,CAAA,WAAY,CAAA,SAAU,CAAA;AAAA,iBAcrG,kBAAA,mCAAqD,CAAA,CAAA,CAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,CAAA,GAAI,GAAA,IAAO,CAAA,WAAY,CAAA,GAAI,OAAA,CAAQ,CAAA,CAAE,CAAA;AAAA,iBAI1G,SAAA,mCAA4C,CAAA,CAAA,CAAG,GAAA,EAAK,CAAA,EAAG,GAAA,EAAK,CAAA;;;;iBAW5D,YAAA,CAAa,KAAA,YAAiB,KAAA,aAAkB,QAAA"}