@wix/sdk-types 1.13.2 → 1.13.3

package/build/index.d.mts

@@ -324,6 +324,26 @@ type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
 
 const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
 //=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+
+// The `Omit` utility type doesn't work when omitting specific keys from objects containing index signatures.
+
+// Consider the following example:
+
+type UserData = {
+	[metadata: string]: string;
+	email: string;
+	name: string;
+	role: 'admin' | 'user';
+};
+
+// `Omit` clearly doesn't behave as expected in this case:
+type PostPayload = Omit<UserData, 'email'>;
+//=> type PostPayload = { [x: string]: string; [x: number]: string; }
+
+// In situations like this, `Except` works better.
+// It simply removes the `email` key while preserving all the other keys.
+type PostPayload = Except<UserData, 'email'>;
+//=> type PostPayload = { [x: string]: string; name: string; role: 'admin' | 'user'; }
 ```
 
 @category Object

package/build/index.d.ts

@@ -324,6 +324,26 @@ type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
 
 const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
 //=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+
+// The `Omit` utility type doesn't work when omitting specific keys from objects containing index signatures.
+
+// Consider the following example:
+
+type UserData = {
+	[metadata: string]: string;
+	email: string;
+	name: string;
+	role: 'admin' | 'user';
+};
+
+// `Omit` clearly doesn't behave as expected in this case:
+type PostPayload = Omit<UserData, 'email'>;
+//=> type PostPayload = { [x: string]: string; [x: number]: string; }
+
+// In situations like this, `Except` works better.
+// It simply removes the `email` key while preserving all the other keys.
+type PostPayload = Except<UserData, 'email'>;
+//=> type PostPayload = { [x: string]: string; name: string; role: 'admin' | 'user'; }
 ```
 
 @category Object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk-types",
-  "version": "1.13.2",
+  "version": "1.13.3",
   "license": "MIT",
   "author": {
     "name": "Ronny Ringel",
@@ -28,14 +28,14 @@
     "*.{js,ts}": "yarn lint"
   },
   "dependencies": {
-    "@wix/monitoring-types": "^0.4.0"
+    "@wix/monitoring-types": "^0.5.0"
   },
   "devDependencies": {
-    "@types/node": "^20.17.14",
+    "@types/node": "^20.17.16",
     "eslint": "^8.57.1",
     "eslint-config-sdk": "0.0.0",
     "tsup": "^7.3.0",
-    "type-fest": "^4.32.0",
+    "type-fest": "^4.33.0",
     "typescript": "^5.7.3"
   },
   "eslintConfig": {
@@ -58,5 +58,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "064a672bede000fa0e2ae8b96591ca62a3af58270c85f6321951226e"
+  "falconPackageHash": "ecd26712dd5524abf019711997e58ed00e009f82b0840ed1379ee76b"
 }