@wix/sdk-types 1.12.2 → 1.12.4

package/build/index.d.mts

@@ -12,6 +12,10 @@ type Host<Environment = unknown> = {
         }>;
     };
     environment?: Environment;
+    /**
+     * Optional name of the environment, use for logging
+     */
+    name?: string;
     /**
      * Optional bast url to use for API requests, for example `www.wixapis.com`
      */
@@ -311,6 +315,72 @@ type Except<ObjectType, KeysType extends keyof ObjectType, Options extends Excep
 	? Partial<Record<KeysType, never>>
 	: {});
 
+/**
+Returns a boolean for whether the given type is `never`.
+
+@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
+@link https://stackoverflow.com/a/53984913/10292952
+@link https://www.zhenghao.io/posts/ts-never
+
+Useful in type utilities, such as checking if something does not occur.
+
+@example
+```
+import type {IsNever, And} from 'type-fest';
+
+// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
+type AreStringsEqual<A extends string, B extends string> =
+	And<
+		IsNever<Exclude<A, B>> extends true ? true : false,
+		IsNever<Exclude<B, A>> extends true ? true : false
+	>;
+
+type EndIfEqual<I extends string, O extends string> =
+	AreStringsEqual<I, O> extends true
+		? never
+		: void;
+
+function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
+	if (input === output) {
+		process.exit(0);
+	}
+}
+
+endIfEqual('abc', 'abc');
+//=> never
+
+endIfEqual('abc', '123');
+//=> void
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsNever<T> = [T] extends [never] ? true : false;
+
+/**
+An if-else-like type that resolves depending on whether the given type is `never`.
+
+@see {@link IsNever}
+
+@example
+```
+import type {IfNever} from 'type-fest';
+
+type ShouldBeTrue = IfNever<never>;
+//=> true
+
+type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
+//=> 'bar'
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
+	IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
+);
+
 /**
 Extract the keys from a type where the value type of the key extends the given `Condition`.
 
@@ -343,21 +413,19 @@ type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
 
 @category Object
 */
-type ConditionalKeys<Base, Condition> = NonNullable<
-// Wrap in `NonNullable` to strip away the `undefined` type from the produced union.
+type ConditionalKeys<Base, Condition> =
 {
 	// Map through all the keys of the given base type.
-	[Key in keyof Base]:
+	[Key in keyof Base]-?:
 	// Pick only keys with types extending the given `Condition` type.
 	Base[Key] extends Condition
-	// Retain this key since the condition passes.
-		? Key
+	// Retain this key
+	// If the value for the key extends never, only include it if `Condition` also extends never
+		? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
 	// Discard this key since the condition fails.
 		: never;
-
 	// Convert the produced object into a union type of the keys which passed the conditional test.
-}[keyof Base]
->;
+}[keyof Base];
 
 /**
 Exclude keys from a shape that matches the given `Condition`.

package/build/index.d.ts

@@ -12,6 +12,10 @@ type Host<Environment = unknown> = {
         }>;
     };
     environment?: Environment;
+    /**
+     * Optional name of the environment, use for logging
+     */
+    name?: string;
     /**
      * Optional bast url to use for API requests, for example `www.wixapis.com`
      */
@@ -311,6 +315,72 @@ type Except<ObjectType, KeysType extends keyof ObjectType, Options extends Excep
 	? Partial<Record<KeysType, never>>
 	: {});
 
+/**
+Returns a boolean for whether the given type is `never`.
+
+@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
+@link https://stackoverflow.com/a/53984913/10292952
+@link https://www.zhenghao.io/posts/ts-never
+
+Useful in type utilities, such as checking if something does not occur.
+
+@example
+```
+import type {IsNever, And} from 'type-fest';
+
+// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
+type AreStringsEqual<A extends string, B extends string> =
+	And<
+		IsNever<Exclude<A, B>> extends true ? true : false,
+		IsNever<Exclude<B, A>> extends true ? true : false
+	>;
+
+type EndIfEqual<I extends string, O extends string> =
+	AreStringsEqual<I, O> extends true
+		? never
+		: void;
+
+function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
+	if (input === output) {
+		process.exit(0);
+	}
+}
+
+endIfEqual('abc', 'abc');
+//=> never
+
+endIfEqual('abc', '123');
+//=> void
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsNever<T> = [T] extends [never] ? true : false;
+
+/**
+An if-else-like type that resolves depending on whether the given type is `never`.
+
+@see {@link IsNever}
+
+@example
+```
+import type {IfNever} from 'type-fest';
+
+type ShouldBeTrue = IfNever<never>;
+//=> true
+
+type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
+//=> 'bar'
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
+	IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
+);
+
 /**
 Extract the keys from a type where the value type of the key extends the given `Condition`.
 
@@ -343,21 +413,19 @@ type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
 
 @category Object
 */
-type ConditionalKeys<Base, Condition> = NonNullable<
-// Wrap in `NonNullable` to strip away the `undefined` type from the produced union.
+type ConditionalKeys<Base, Condition> =
 {
 	// Map through all the keys of the given base type.
-	[Key in keyof Base]:
+	[Key in keyof Base]-?:
 	// Pick only keys with types extending the given `Condition` type.
 	Base[Key] extends Condition
-	// Retain this key since the condition passes.
-		? Key
+	// Retain this key
+	// If the value for the key extends never, only include it if `Condition` also extends never
+		? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
 	// Discard this key since the condition fails.
 		: never;
-
 	// Convert the produced object into a union type of the keys which passed the conditional test.
-}[keyof Base]
->;
+}[keyof Base];
 
 /**
 Exclude keys from a shape that matches the given `Condition`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk-types",
-  "version": "1.12.2",
+  "version": "1.12.4",
   "license": "UNLICENSED",
   "author": {
     "name": "Ronny Ringel",
@@ -12,8 +12,7 @@
   "sideEffects": false,
   "types": "build/index.d.ts",
   "files": [
-    "build",
-    "enable-all-context-types.d.ts"
+    "build"
   ],
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -29,12 +28,12 @@
     "*.{js,ts}": "yarn lint"
   },
   "devDependencies": {
-    "@types/node": "^20.10.6",
-    "eslint": "^8.56.0",
+    "@types/node": "^20.17.1",
+    "eslint": "^8.57.1",
     "eslint-config-sdk": "0.0.0",
     "tsup": "^7.3.0",
-    "type-fest": "^4.9.0",
-    "typescript": "^5.3.3"
+    "type-fest": "^4.26.1",
+    "typescript": "^5.6.3"
   },
   "yoshiFlowLibrary": {
     "buildEsmWithBabel": true
@@ -59,5 +58,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "d792d8c125ad82e0e2f2102bf625213e93dd91dfc8255b91a58a222a"
+  "falconPackageHash": "8469d4de3131c4bcc8fc47df34db04866cf00b50a23e8a32eb180346"
 }

package/enable-all-context-types.d.ts

@@ -1,8 +0,0 @@
-// eslint-disable-next-line require-extensions/require-extensions
-import type { Host } from './build/index.d.ts';
-
-declare global {
-  interface ContextualClient {
-    host: Host;
-  }
-}