@ls-stack/utils 3.14.0 → 3.15.0

package/lib/typingFnUtils.cjs

@@ -25,8 +25,10 @@ __export(typingFnUtils_exports, {
   isObjKey: () => isObjKey,
   isSubTypeOf: () => isSubTypeOf,
   narrowStringToUnion: () => narrowStringToUnion,
+  typeOnRightExtendsLeftType: () => typeOnRightExtendsLeftType,
   typedObjectEntries: () => typedObjectEntries,
-  typedObjectKeys: () => typedObjectKeys
+  typedObjectKeys: () => typedObjectKeys,
+  unionsAreTheSame: () => unionsAreTheSame
 });
 module.exports = __toCommonJS(typingFnUtils_exports);
 function asNonPartial(obj) {
@@ -47,12 +49,15 @@ function narrowStringToUnion(key, union) {
   }
   return void 0;
 }
-function isSubTypeOf() {
+function typeOnRightExtendsLeftType() {
   return void 0;
 }
+var isSubTypeOf = typeOnRightExtendsLeftType;
 function isObjKey(key, obj) {
   return typeof key === "string" && key in obj;
 }
+function unionsAreTheSame(_diff) {
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   asNonPartial,
@@ -60,6 +65,8 @@ function isObjKey(key, obj) {
   isObjKey,
   isSubTypeOf,
   narrowStringToUnion,
+  typeOnRightExtendsLeftType,
   typedObjectEntries,
-  typedObjectKeys
+  typedObjectKeys,
+  unionsAreTheSame
 });

package/lib/typingFnUtils.d.cts

@@ -18,10 +18,33 @@ declare function narrowStringToUnion<const T extends string>(key: string | undef
  * @template SubType - The type that should extend BaseType
  * @returns {unknown} Returns undefined, only used for type checking
  */
-declare function isSubTypeOf<BaseType, SubType extends BaseType>(): unknown;
+declare function typeOnRightExtendsLeftType<BaseType, SubType extends BaseType>(): unknown;
+/** @deprecated use typeOnRightExtendsLeftType instead */
+declare const isSubTypeOf: typeof typeOnRightExtendsLeftType;
 /**
  * Type helper to narrow a string to a key of an object.
  */
 declare function isObjKey<T extends Record<string, unknown>>(key: unknown, obj: T): key is keyof T;
+type UnionDiff<T, U> = [
+    T
+] extends [U] ? [
+    U
+] extends [T] ? null : {
+    onRightHasExtra: Exclude<U, T>;
+} : [U] extends [T] ? {
+    onRightHasMissing: Exclude<T, U>;
+} : {
+    onRightHasExtra: Exclude<U, T>;
+    onRightHasMissing: Exclude<T, U>;
+};
+/**
+ * Type helper to compare two union types and determine their relationship.
+ *
+ * @template T - The first union type (left side)
+ * @template U - The second union type (right side)
+ * @param _diff - null if unions are identical, or an object describing the difference
+ * @returns void - This function is only used for type checking
+ */
+declare function unionsAreTheSame<T, U>(_diff: UnionDiff<T, U>): void;
 
-export { asNonPartial, asType, isObjKey, isSubTypeOf, narrowStringToUnion, typedObjectEntries, typedObjectKeys };
+export { asNonPartial, asType, isObjKey, isSubTypeOf, narrowStringToUnion, typeOnRightExtendsLeftType, typedObjectEntries, typedObjectKeys, unionsAreTheSame };

package/lib/typingFnUtils.d.ts

@@ -18,10 +18,33 @@ declare function narrowStringToUnion<const T extends string>(key: string | undef
  * @template SubType - The type that should extend BaseType
  * @returns {unknown} Returns undefined, only used for type checking
  */
-declare function isSubTypeOf<BaseType, SubType extends BaseType>(): unknown;
+declare function typeOnRightExtendsLeftType<BaseType, SubType extends BaseType>(): unknown;
+/** @deprecated use typeOnRightExtendsLeftType instead */
+declare const isSubTypeOf: typeof typeOnRightExtendsLeftType;
 /**
  * Type helper to narrow a string to a key of an object.
  */
 declare function isObjKey<T extends Record<string, unknown>>(key: unknown, obj: T): key is keyof T;
+type UnionDiff<T, U> = [
+    T
+] extends [U] ? [
+    U
+] extends [T] ? null : {
+    onRightHasExtra: Exclude<U, T>;
+} : [U] extends [T] ? {
+    onRightHasMissing: Exclude<T, U>;
+} : {
+    onRightHasExtra: Exclude<U, T>;
+    onRightHasMissing: Exclude<T, U>;
+};
+/**
+ * Type helper to compare two union types and determine their relationship.
+ *
+ * @template T - The first union type (left side)
+ * @template U - The second union type (right side)
+ * @param _diff - null if unions are identical, or an object describing the difference
+ * @returns void - This function is only used for type checking
+ */
+declare function unionsAreTheSame<T, U>(_diff: UnionDiff<T, U>): void;
 
-export { asNonPartial, asType, isObjKey, isSubTypeOf, narrowStringToUnion, typedObjectEntries, typedObjectKeys };
+export { asNonPartial, asType, isObjKey, isSubTypeOf, narrowStringToUnion, typeOnRightExtendsLeftType, typedObjectEntries, typedObjectKeys, unionsAreTheSame };

package/lib/typingFnUtils.js

@@ -17,18 +17,23 @@ function narrowStringToUnion(key, union) {
   }
   return void 0;
 }
-function isSubTypeOf() {
+function typeOnRightExtendsLeftType() {
   return void 0;
 }
+var isSubTypeOf = typeOnRightExtendsLeftType;
 function isObjKey(key, obj) {
   return typeof key === "string" && key in obj;
 }
+function unionsAreTheSame(_diff) {
+}
 export {
   asNonPartial,
   asType,
   isObjKey,
   isSubTypeOf,
   narrowStringToUnion,
+  typeOnRightExtendsLeftType,
   typedObjectEntries,
-  typedObjectKeys
+  typedObjectKeys,
+  unionsAreTheSame
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ls-stack/utils",
   "description": "Typescript utils",
-  "version": "3.14.0",
+  "version": "3.15.0",
   "license": "MIT",
   "files": [
     "lib"