@wix/sdk-types 1.13.7 → 1.13.9

package/build/index.d.mts

@@ -223,6 +223,46 @@ Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<n
 */
 type EmptyObject = {[emptyObjectSymbol]?: never};
 
+/**
+Extract all optional keys from the given type.
+
+This is useful when you want to create a new type that contains different type values for the optional keys only.
+
+@example
+```
+import type {OptionalKeysOf, Except} from 'type-fest';
+
+interface User {
+	name: string;
+	surname: string;
+
+	luckyNumber?: number;
+}
+
+const REMOVE_FIELD = Symbol('remove field symbol');
+type UpdateOperation<Entity extends object> = Except<Partial<Entity>, OptionalKeysOf<Entity>> & {
+	[Key in OptionalKeysOf<Entity>]?: Entity[Key] | typeof REMOVE_FIELD;
+};
+
+const update1: UpdateOperation<User> = {
+	name: 'Alice'
+};
+
+const update2: UpdateOperation<User> = {
+	name: 'Bob',
+	luckyNumber: REMOVE_FIELD
+};
+```
+
+@category Utilities
+*/
+type OptionalKeysOf<BaseType extends object> =
+	BaseType extends unknown // For distributing `BaseType`
+		? (keyof {
+			[Key in keyof BaseType as BaseType extends Record<Key, BaseType[Key]> ? never : Key]: never
+		}) & (keyof BaseType) // Intersect with `keyof BaseType` to ensure result of `OptionalKeysOf<BaseType>` is always assignable to `keyof BaseType`
+		: never; // Should never happen
+
 /**
 Extract all required keys from the given type.
 
@@ -247,11 +287,10 @@ const validator2 = createValidation<User>('surname', value => value.length < 25)
 
 @category Utilities
 */
-type RequiredKeysOf<BaseType extends object> = Exclude<{
-	[Key in keyof BaseType]: BaseType extends Record<Key, BaseType[Key]>
-		? Key
-		: never
-}[keyof BaseType], undefined>;
+type RequiredKeysOf<BaseType extends object> =
+	BaseType extends unknown // For distributing `BaseType`
+		? Exclude<keyof BaseType, OptionalKeysOf<BaseType>>
+		: never; // Should never happen
 
 /**
 Returns a boolean for whether the given type is `never`.
@@ -659,45 +698,6 @@ type IfAny<T, TypeIfAny = true, TypeIfNotAny = false> = (
 	IsAny<T> extends true ? TypeIfAny : TypeIfNotAny
 );
 
-/**
-Extract all optional keys from the given type.
-
-This is useful when you want to create a new type that contains different type values for the optional keys only.
-
-@example
-```
-import type {OptionalKeysOf, Except} from 'type-fest';
-
-interface User {
-	name: string;
-	surname: string;
-
-	luckyNumber?: number;
-}
-
-const REMOVE_FIELD = Symbol('remove field symbol');
-type UpdateOperation<Entity extends object> = Except<Partial<Entity>, OptionalKeysOf<Entity>> & {
-	[Key in OptionalKeysOf<Entity>]?: Entity[Key] | typeof REMOVE_FIELD;
-};
-
-const update1: UpdateOperation<User> = {
-	name: 'Alice'
-};
-
-const update2: UpdateOperation<User> = {
-	name: 'Bob',
-	luckyNumber: REMOVE_FIELD
-};
-```
-
-@category Utilities
-*/
-type OptionalKeysOf<BaseType extends object> = Exclude<{
-	[Key in keyof BaseType]: BaseType extends Record<Key, BaseType[Key]>
-		? never
-		: Key
-}[keyof BaseType], undefined>;
-
 /**
 Merges user specified options with default options.
 
@@ -759,7 +759,11 @@ type ApplyDefaultOptions<
 	IfNever<SpecifiedOptions, Defaults,
 	Simplify<Merge<Defaults, {
 		[Key in keyof SpecifiedOptions
-		as Key extends OptionalKeysOf<Options> ? undefined extends SpecifiedOptions[Key] ? never : Key : Key
+		as Key extends OptionalKeysOf<Options>
+			? Extract<SpecifiedOptions[Key], undefined> extends never
+				? Key
+				: never
+			: Key
 		]: SpecifiedOptions[Key]
 	}> & Required<Options>> // `& Required<Options>` ensures that `ApplyDefaultOptions<SomeOption, ...>` is always assignable to `Required<SomeOption>`
 	>>;
@@ -1057,4 +1061,60 @@ type IsExposed<T, Scope extends Exposure> = Scope extends 'public' ? T : globalT
     alpha: true;
 } ? T : never;
 
-export { type APIMetadata, type AmbassadorFactory, type AmbassadorFunctionDescriptor, type AmbassadorRequestOptions, type AuthenticationStrategy, type BaseEventMetadata, type BoundAuthenticationStrategy, type BuildAmbassadorFunction, type BuildDescriptors, type BuildEventDefinition, type BuildRESTFunction, type BuildServicePluginDefinition, type Descriptors, EventDefinition, type EventHandler, type EventIdentity, type ExposeFieldsBasedOnToggle, type HTTPMethod, type Host, type HostModule, type HostModuleAPI, type HttpClient, type HttpResponse, type MaybeContext, type Method, type PublicMetadata, type RESTFunctionDescriptor, type RequestContext, type RequestOptions, type RequestOptionsFactory, type RestModuleMeta, SERVICE_PLUGIN_ERROR_TYPE, type ServicePluginContract, ServicePluginDefinition, type ServicePluginMethodInput, type ServicePluginMethodMetadata };
+/**
+ * Extracts the first part of a dot-separated string.
+ * @template T - The input string type
+ * @example
+ * // Returns "foo"
+ * type Result = Head<"foo.bar.baz">
+ */
+type Head<T extends string> = T extends `${infer First}.${string}` ? First : T;
+/**
+ * Extracts everything after the first dot in a dot-separated string.
+ * Returns 'never' if there is no dot.
+ * @template T - The input string type
+ * @example
+ * // Returns "bar.baz"
+ * type Result = Tail<"foo.bar.baz">
+ */
+type Tail<T extends string> = T extends `${string}.${infer Rest}` ? Rest : never;
+/**
+ * Extracts the element type from an array type, ensuring it's non-nullable.
+ * Returns 'never' if the input type is not an array.
+ * @template T - The potential array type
+ * @example
+ * // Returns string
+ * type Result = OptionalArrayElementType<string[]>
+ */
+type OptionalArrayElementType<T> = T extends (infer U)[] ? NonNullable<U> : never;
+/**
+ * Creates a new type where specified dot-notation paths are made non-nullable,
+ * while maintaining the original structure of the object.
+ * The behavior is conditional based on the global SDK type mode.
+ * @template T - The input object type
+ * @template K - The dot-notation path(s) to make non-nullable
+ * @example
+ * // Makes user.name and user.profile.email non-nullable
+ * type Result = NonNullablePaths<MyType, "user.name" | "user.profile.email">
+ */
+type NonNullablePaths<T, K extends string> = T extends object ? {
+    [P in K & keyof T]: NonNullable<T[P] extends readonly unknown[] | null | undefined ? NonNullablePaths<OptionalArrayElementType<T[P]>, Tail<Extract<K, `${P}.${string}`>>>[] : NonNullablePaths<T[P], Tail<Extract<K, `${P}.${string}`>>>>;
+} & {
+    [P in keyof T as P extends K ? never : P]?: P extends Head<K> ? T[P] extends readonly unknown[] | null | undefined ? NonNullablePaths<OptionalArrayElementType<T[P]>, Tail<Extract<K, `${P}.${string}`>>>[] : NonNullablePaths<T[P], Tail<Extract<K, `${P}.${string}`>>> : T[P];
+} : T;
+declare global {
+    /**
+     * A global interface to set the type mode for the SDK.
+     * @example
+     * ```ts
+     * declare global {
+     *  interface SDKTypeMode {
+     *    strict: true;
+     *  }
+     * }
+     */
+    interface SDKTypeMode {
+    }
+}
+
+export { type APIMetadata, type AmbassadorFactory, type AmbassadorFunctionDescriptor, type AmbassadorRequestOptions, type AuthenticationStrategy, type BaseEventMetadata, type BoundAuthenticationStrategy, type BuildAmbassadorFunction, type BuildDescriptors, type BuildEventDefinition, type BuildRESTFunction, type BuildServicePluginDefinition, type Descriptors, EventDefinition, type EventHandler, type EventIdentity, type ExposeFieldsBasedOnToggle, type HTTPMethod, type Host, type HostModule, type HostModuleAPI, type HttpClient, type HttpResponse, type MaybeContext, type Method, type NonNullablePaths, type OptionalArrayElementType, type PublicMetadata, type RESTFunctionDescriptor, type RequestContext, type RequestOptions, type RequestOptionsFactory, type RestModuleMeta, SERVICE_PLUGIN_ERROR_TYPE, type ServicePluginContract, ServicePluginDefinition, type ServicePluginMethodInput, type ServicePluginMethodMetadata };

package/build/index.d.ts

@@ -223,6 +223,46 @@ Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<n
 */
 type EmptyObject = {[emptyObjectSymbol]?: never};
 
+/**
+Extract all optional keys from the given type.
+
+This is useful when you want to create a new type that contains different type values for the optional keys only.
+
+@example
+```
+import type {OptionalKeysOf, Except} from 'type-fest';
+
+interface User {
+	name: string;
+	surname: string;
+
+	luckyNumber?: number;
+}
+
+const REMOVE_FIELD = Symbol('remove field symbol');
+type UpdateOperation<Entity extends object> = Except<Partial<Entity>, OptionalKeysOf<Entity>> & {
+	[Key in OptionalKeysOf<Entity>]?: Entity[Key] | typeof REMOVE_FIELD;
+};
+
+const update1: UpdateOperation<User> = {
+	name: 'Alice'
+};
+
+const update2: UpdateOperation<User> = {
+	name: 'Bob',
+	luckyNumber: REMOVE_FIELD
+};
+```
+
+@category Utilities
+*/
+type OptionalKeysOf<BaseType extends object> =
+	BaseType extends unknown // For distributing `BaseType`
+		? (keyof {
+			[Key in keyof BaseType as BaseType extends Record<Key, BaseType[Key]> ? never : Key]: never
+		}) & (keyof BaseType) // Intersect with `keyof BaseType` to ensure result of `OptionalKeysOf<BaseType>` is always assignable to `keyof BaseType`
+		: never; // Should never happen
+
 /**
 Extract all required keys from the given type.
 
@@ -247,11 +287,10 @@ const validator2 = createValidation<User>('surname', value => value.length < 25)
 
 @category Utilities
 */
-type RequiredKeysOf<BaseType extends object> = Exclude<{
-	[Key in keyof BaseType]: BaseType extends Record<Key, BaseType[Key]>
-		? Key
-		: never
-}[keyof BaseType], undefined>;
+type RequiredKeysOf<BaseType extends object> =
+	BaseType extends unknown // For distributing `BaseType`
+		? Exclude<keyof BaseType, OptionalKeysOf<BaseType>>
+		: never; // Should never happen
 
 /**
 Returns a boolean for whether the given type is `never`.
@@ -659,45 +698,6 @@ type IfAny<T, TypeIfAny = true, TypeIfNotAny = false> = (
 	IsAny<T> extends true ? TypeIfAny : TypeIfNotAny
 );
 
-/**
-Extract all optional keys from the given type.
-
-This is useful when you want to create a new type that contains different type values for the optional keys only.
-
-@example
-```
-import type {OptionalKeysOf, Except} from 'type-fest';
-
-interface User {
-	name: string;
-	surname: string;
-
-	luckyNumber?: number;
-}
-
-const REMOVE_FIELD = Symbol('remove field symbol');
-type UpdateOperation<Entity extends object> = Except<Partial<Entity>, OptionalKeysOf<Entity>> & {
-	[Key in OptionalKeysOf<Entity>]?: Entity[Key] | typeof REMOVE_FIELD;
-};
-
-const update1: UpdateOperation<User> = {
-	name: 'Alice'
-};
-
-const update2: UpdateOperation<User> = {
-	name: 'Bob',
-	luckyNumber: REMOVE_FIELD
-};
-```
-
-@category Utilities
-*/
-type OptionalKeysOf<BaseType extends object> = Exclude<{
-	[Key in keyof BaseType]: BaseType extends Record<Key, BaseType[Key]>
-		? never
-		: Key
-}[keyof BaseType], undefined>;
-
 /**
 Merges user specified options with default options.
 
@@ -759,7 +759,11 @@ type ApplyDefaultOptions<
 	IfNever<SpecifiedOptions, Defaults,
 	Simplify<Merge<Defaults, {
 		[Key in keyof SpecifiedOptions
-		as Key extends OptionalKeysOf<Options> ? undefined extends SpecifiedOptions[Key] ? never : Key : Key
+		as Key extends OptionalKeysOf<Options>
+			? Extract<SpecifiedOptions[Key], undefined> extends never
+				? Key
+				: never
+			: Key
 		]: SpecifiedOptions[Key]
 	}> & Required<Options>> // `& Required<Options>` ensures that `ApplyDefaultOptions<SomeOption, ...>` is always assignable to `Required<SomeOption>`
 	>>;
@@ -1057,4 +1061,60 @@ type IsExposed<T, Scope extends Exposure> = Scope extends 'public' ? T : globalT
     alpha: true;
 } ? T : never;
 
-export { type APIMetadata, type AmbassadorFactory, type AmbassadorFunctionDescriptor, type AmbassadorRequestOptions, type AuthenticationStrategy, type BaseEventMetadata, type BoundAuthenticationStrategy, type BuildAmbassadorFunction, type BuildDescriptors, type BuildEventDefinition, type BuildRESTFunction, type BuildServicePluginDefinition, type Descriptors, EventDefinition, type EventHandler, type EventIdentity, type ExposeFieldsBasedOnToggle, type HTTPMethod, type Host, type HostModule, type HostModuleAPI, type HttpClient, type HttpResponse, type MaybeContext, type Method, type PublicMetadata, type RESTFunctionDescriptor, type RequestContext, type RequestOptions, type RequestOptionsFactory, type RestModuleMeta, SERVICE_PLUGIN_ERROR_TYPE, type ServicePluginContract, ServicePluginDefinition, type ServicePluginMethodInput, type ServicePluginMethodMetadata };
+/**
+ * Extracts the first part of a dot-separated string.
+ * @template T - The input string type
+ * @example
+ * // Returns "foo"
+ * type Result = Head<"foo.bar.baz">
+ */
+type Head<T extends string> = T extends `${infer First}.${string}` ? First : T;
+/**
+ * Extracts everything after the first dot in a dot-separated string.
+ * Returns 'never' if there is no dot.
+ * @template T - The input string type
+ * @example
+ * // Returns "bar.baz"
+ * type Result = Tail<"foo.bar.baz">
+ */
+type Tail<T extends string> = T extends `${string}.${infer Rest}` ? Rest : never;
+/**
+ * Extracts the element type from an array type, ensuring it's non-nullable.
+ * Returns 'never' if the input type is not an array.
+ * @template T - The potential array type
+ * @example
+ * // Returns string
+ * type Result = OptionalArrayElementType<string[]>
+ */
+type OptionalArrayElementType<T> = T extends (infer U)[] ? NonNullable<U> : never;
+/**
+ * Creates a new type where specified dot-notation paths are made non-nullable,
+ * while maintaining the original structure of the object.
+ * The behavior is conditional based on the global SDK type mode.
+ * @template T - The input object type
+ * @template K - The dot-notation path(s) to make non-nullable
+ * @example
+ * // Makes user.name and user.profile.email non-nullable
+ * type Result = NonNullablePaths<MyType, "user.name" | "user.profile.email">
+ */
+type NonNullablePaths<T, K extends string> = T extends object ? {
+    [P in K & keyof T]: NonNullable<T[P] extends readonly unknown[] | null | undefined ? NonNullablePaths<OptionalArrayElementType<T[P]>, Tail<Extract<K, `${P}.${string}`>>>[] : NonNullablePaths<T[P], Tail<Extract<K, `${P}.${string}`>>>>;
+} & {
+    [P in keyof T as P extends K ? never : P]?: P extends Head<K> ? T[P] extends readonly unknown[] | null | undefined ? NonNullablePaths<OptionalArrayElementType<T[P]>, Tail<Extract<K, `${P}.${string}`>>>[] : NonNullablePaths<T[P], Tail<Extract<K, `${P}.${string}`>>> : T[P];
+} : T;
+declare global {
+    /**
+     * A global interface to set the type mode for the SDK.
+     * @example
+     * ```ts
+     * declare global {
+     *  interface SDKTypeMode {
+     *    strict: true;
+     *  }
+     * }
+     */
+    interface SDKTypeMode {
+    }
+}
+
+export { type APIMetadata, type AmbassadorFactory, type AmbassadorFunctionDescriptor, type AmbassadorRequestOptions, type AuthenticationStrategy, type BaseEventMetadata, type BoundAuthenticationStrategy, type BuildAmbassadorFunction, type BuildDescriptors, type BuildEventDefinition, type BuildRESTFunction, type BuildServicePluginDefinition, type Descriptors, EventDefinition, type EventHandler, type EventIdentity, type ExposeFieldsBasedOnToggle, type HTTPMethod, type Host, type HostModule, type HostModuleAPI, type HttpClient, type HttpResponse, type MaybeContext, type Method, type NonNullablePaths, type OptionalArrayElementType, type PublicMetadata, type RESTFunctionDescriptor, type RequestContext, type RequestOptions, type RequestOptionsFactory, type RestModuleMeta, SERVICE_PLUGIN_ERROR_TYPE, type ServicePluginContract, ServicePluginDefinition, type ServicePluginMethodInput, type ServicePluginMethodMetadata };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk-types",
-  "version": "1.13.7",
+  "version": "1.13.9",
   "license": "MIT",
   "author": {
     "name": "Ronny Ringel",
@@ -20,7 +20,7 @@
   },
   "scripts": {
     "build": "tsup",
-    "test": ":",
+    "test": "tsup --config tsup.test.config.ts",
     "lint": "eslint --max-warnings=0 .",
     "typecheck": "tsc --noEmit"
   },
@@ -31,12 +31,12 @@
     "@wix/monitoring-types": "^0.9.0"
   },
   "devDependencies": {
-    "@types/node": "^20.17.28",
+    "@types/node": "^20.17.30",
     "eslint": "^8.57.1",
     "eslint-config-sdk": "0.0.0",
     "tsup": "^7.3.0",
-    "type-fest": "^4.38.0",
-    "typescript": "^5.8.2"
+    "type-fest": "^4.39.1",
+    "typescript": "^5.8.3"
   },
   "eslintConfig": {
     "extends": "sdk"
@@ -58,5 +58,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "5688a2fb60ca00fdff1bb2246ee2332e1797a484df1b74e7181de008"
+  "falconPackageHash": "2fa1b5c41ad68972714dbbca1ce6e7c9151222df65273708160b69b8"
 }