@xsai/stream-object 0.4.2 → 0.4.3

package/dist/index.d.ts

@@ -211,14 +211,14 @@ type IsTrue<T> = T extends true ? true : false;
 
 // When a distributive conditional is instantiated with `never`, the entire conditional results in `never`.
 type A = IsTrue<never>;
-//   ^? type A = never
+//=> never
 
 // If you don't want that behaviour, you can explicitly add an `IsNever` check before the distributive conditional.
 type IsTrueFixed<T> =
 	IsNever<T> extends true ? false : T extends true ? true : false;
 
 type B = IsTrueFixed<never>;
-//   ^? type B = false
+//=> false
 ```
 
 @category Type Guard
@@ -407,6 +407,46 @@ fn(someInterface as Simplify<SomeInterface>); // Good: transform an `interface`
 */
 type Simplify<T> = {[KeyType in keyof T]: T[KeyType]} & {};
 
+/**
+Returns a boolean for whether the two given types are equal.
+
+@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+
+Use-cases:
+- If you want to make a conditional branch based on the result of a comparison of two types.
+
+@example
+```
+import type {IsEqual} from 'type-fest';
+
+// This type returns a boolean for whether the given array includes the given item.
+// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
+type Includes<Value extends readonly any[], Item> =
+	Value extends readonly [Value[0], ...infer rest]
+		? IsEqual<Value[0], Item> extends true
+			? true
+			: Includes<rest, Item>
+		: false;
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsEqual<A, B> =
+	[A] extends [B]
+		? [B] extends [A]
+			? _IsEqual<A, B>
+			: false
+		: false;
+
+// This version fails the `equalWrappedTupleIntersectionToBeNeverAndNeverExpanded` test in `test-d/is-equal.ts`.
+type _IsEqual<A, B> =
+	(<G>() => G extends A & G | G ? 1 : 2) extends
+	(<G>() => G extends B & G | G ? 1 : 2)
+		? true
+		: false;
+
 /**
 Omit any index signatures from the given object type, leaving only explicitly defined properties.
 
@@ -426,7 +466,7 @@ const indexed: Record<string, unknown> = {}; // Allowed
 
 // @ts-expect-error
 const keyed: Record<'foo', unknown> = {}; // Error
-// => TS2739: Type '{}' is missing the following properties from type 'Record<"foo" | "bar", unknown>': foo, bar
+// TS2739: Type '{}' is missing the following properties from type 'Record<"foo" | "bar", unknown>': foo, bar
 ```
 
 Instead of causing a type error like the above, you can also use a [conditional type](https://www.typescriptlang.org/docs/handbook/2/conditional-types.html) to test whether a type is assignable to another:
@@ -435,12 +475,16 @@ Instead of causing a type error like the above, you can also use a [conditional
 type Indexed = {} extends Record<string, unknown>
 	? '✅ `{}` is assignable to `Record<string, unknown>`'
 	: '❌ `{}` is NOT assignable to `Record<string, unknown>`';
-// => '✅ `{}` is assignable to `Record<string, unknown>`'
+
+type IndexedResult = Indexed;
+//=> '✅ `{}` is assignable to `Record<string, unknown>`'
 
 type Keyed = {} extends Record<'foo' | 'bar', unknown>
 	? '✅ `{}` is assignable to `Record<\'foo\' | \'bar\', unknown>`'
 	: '❌ `{}` is NOT assignable to `Record<\'foo\' | \'bar\', unknown>`';
-// => "❌ `{}` is NOT assignable to `Record<'foo' | 'bar', unknown>`"
+
+type KeyedResult = Keyed;
+//=> '❌ `{}` is NOT assignable to `Record<\'foo\' | \'bar\', unknown>`'
 ```
 
 Using a [mapped type](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html#further-exploration), you can then check for each `KeyType` of `ObjectType`...
@@ -488,7 +532,7 @@ type Example = {
 };
 
 type ExampleWithoutIndexSignatures = OmitIndexSignature<Example>;
-// => { foo: 'bar'; qux?: 'baz' | undefined; }
+//=> {foo: 'bar'; qux?: 'baz'}
 ```
 
 @see {@link PickIndexSignature}
@@ -552,9 +596,9 @@ type PickIndexSignature<ObjectType> = {
 };
 
 // Merges two objects without worrying about index signatures.
-type SimpleMerge<Destination, Source> = {
+type SimpleMerge<Destination, Source> = Simplify<{
 	[Key in keyof Destination as Key extends keyof Source ? never : Key]: Destination[Key];
-} & Source;
+} & Source>;
 
 /**
 Merge two types into a new type. Keys of the second type overrides keys of the first type.
@@ -578,7 +622,7 @@ type Bar = {
 };
 
 export type FooBar = Merge<Foo, Bar>;
-// => {
+//=> {
 // 	[x: string]: unknown;
 // 	[x: number]: number;
 // 	[x: symbol]: unknown;
@@ -588,13 +632,23 @@ export type FooBar = Merge<Foo, Bar>;
 // }
 ```
 
+Note: If you want a merge type that more accurately reflects the runtime behavior of object spread or `Object.assign`, refer to the {@link ObjectMerge} type.
+
+@see {@link ObjectMerge}
 @category Object
 */
 type Merge<Destination, Source> =
-Simplify<
-	SimpleMerge<PickIndexSignature<Destination>, PickIndexSignature<Source>>
-	& SimpleMerge<OmitIndexSignature<Destination>, OmitIndexSignature<Source>>
->;
+	Destination extends unknown // For distributing `Destination`
+		? Source extends unknown // For distributing `Source`
+			? If<IsEqual<Destination, Source>, Destination, _Merge<Destination, Source>>
+			: never // Should never happen
+		: never; // Should never happen
+
+type _Merge<Destination, Source> =
+	Simplify<
+		SimpleMerge<PickIndexSignature<Destination>, PickIndexSignature<Source>>
+		& SimpleMerge<OmitIndexSignature<Destination>, OmitIndexSignature<Source>>
+	>;
 
 /**
 Merges user specified options with default options.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xsai/stream-object",
   "type": "module",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "extra-small AI SDK.",
   "author": "Moeru AI",
   "license": "MIT",
@@ -29,13 +29,13 @@
     "dist"
   ],
   "dependencies": {
-    "@xsai/stream-text": "~0.4.2",
-    "xsschema": "~0.4.2"
+    "@xsai/stream-text": "~0.4.3",
+    "xsschema": "~0.4.3"
   },
   "devDependencies": {
     "@valibot/to-json-schema": "^1.0.0",
     "best-effort-json-parser": "^1.2.1",
-    "type-fest": "^5.3.1",
+    "type-fest": "^5.4.3",
     "valibot": "^1.0.0"
   },
   "scripts": {