@eslint-react/shared 1.9.0 → 1.9.1-next.1

package/dist/index.d.mts

@@ -2068,14 +2068,157 @@ type Memoized<Fn extends AnyFn> = Fn &
     options: NormalizedOptions<Fn>;
   };
 
+/**
+Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
+
+@category Type
+*/
+type Primitive =
+	| null
+	| undefined
+	| string
+	| number
+	| boolean
+	| symbol
+	| bigint;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+/**
+Matches any primitive, `void`, `Date`, or `RegExp` value.
+*/
+type BuiltIns = Primitive | void | Date | RegExp;
+
+/**
+@see PartialDeep
+*/
+type PartialDeepOptions = {
+	/**
+	Whether to affect the individual elements of arrays and tuples.
+
+	@default false
+	*/
+	readonly recurseIntoArrays?: boolean;
+};
+
+/**
+Create a type from another type with all keys and nested keys set to optional.
+
+Use-cases:
+- Merging a default settings/config object with another object, the second object would be a deep partial of the default object.
+- Mocking and testing complex entities, where populating an entire object with its keys would be redundant in terms of the mock or test.
+
+@example
+```
+import type {PartialDeep} from 'type-fest';
+
+const settings: Settings = {
+	textEditor: {
+		fontSize: 14;
+		fontColor: '#000000';
+		fontWeight: 400;
+	}
+	autocomplete: false;
+	autosave: true;
+};
+
+const applySavedSettings = (savedSettings: PartialDeep<Settings>) => {
+	return {...settings, ...savedSettings};
+}
+
+settings = applySavedSettings({textEditor: {fontWeight: 500}});
+```
+
+By default, this does not affect elements in array and tuple types. You can change this by passing `{recurseIntoArrays: true}` as the second type argument:
+
+```
+import type {PartialDeep} from 'type-fest';
+
+interface Settings {
+	languages: string[];
+}
+
+const partialSettings: PartialDeep<Settings, {recurseIntoArrays: true}> = {
+	languages: [undefined]
+};
+```
+
+@category Object
+@category Array
+@category Set
+@category Map
+*/
+type PartialDeep<T, Options extends PartialDeepOptions = {}> = T extends BuiltIns | (((...arguments_: any[]) => unknown)) | (new (...arguments_: any[]) => unknown)
+	? T
+	: T extends Map<infer KeyType, infer ValueType>
+		? PartialMapDeep<KeyType, ValueType, Options>
+		: T extends Set<infer ItemType>
+			? PartialSetDeep<ItemType, Options>
+			: T extends ReadonlyMap<infer KeyType, infer ValueType>
+				? PartialReadonlyMapDeep<KeyType, ValueType, Options>
+				: T extends ReadonlySet<infer ItemType>
+					? PartialReadonlySetDeep<ItemType, Options>
+					: T extends object
+						? T extends ReadonlyArray<infer ItemType> // Test for arrays/tuples, per https://github.com/microsoft/TypeScript/issues/35156
+							? Options['recurseIntoArrays'] extends true
+								? ItemType[] extends T // Test for arrays (non-tuples) specifically
+									? readonly ItemType[] extends T // Differentiate readonly and mutable arrays
+										? ReadonlyArray<PartialDeep<ItemType | undefined, Options>>
+										: Array<PartialDeep<ItemType | undefined, Options>>
+									: PartialObjectDeep<T, Options> // Tuples behave properly
+								: T // If they don't opt into array testing, just use the original type
+							: PartialObjectDeep<T, Options>
+						: unknown;
+
+/**
+Same as `PartialDeep`, but accepts only `Map`s and as inputs. Internal helper for `PartialDeep`.
+*/
+type PartialMapDeep<KeyType, ValueType, Options extends PartialDeepOptions> = {} & Map<PartialDeep<KeyType, Options>, PartialDeep<ValueType, Options>>;
+
+/**
+Same as `PartialDeep`, but accepts only `Set`s as inputs. Internal helper for `PartialDeep`.
+*/
+type PartialSetDeep<T, Options extends PartialDeepOptions> = {} & Set<PartialDeep<T, Options>>;
+
+/**
+Same as `PartialDeep`, but accepts only `ReadonlyMap`s as inputs. Internal helper for `PartialDeep`.
+*/
+type PartialReadonlyMapDeep<KeyType, ValueType, Options extends PartialDeepOptions> = {} & ReadonlyMap<PartialDeep<KeyType, Options>, PartialDeep<ValueType, Options>>;
+
+/**
+Same as `PartialDeep`, but accepts only `ReadonlySet`s as inputs. Internal helper for `PartialDeep`.
+*/
+type PartialReadonlySetDeep<T, Options extends PartialDeepOptions> = {} & ReadonlySet<PartialDeep<T, Options>>;
+
+/**
+Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for `PartialDeep`.
+*/
+type PartialObjectDeep<ObjectType extends object, Options extends PartialDeepOptions> = {
+	[KeyType in keyof ObjectType]?: PartialDeep<ObjectType[KeyType], Options>
+};
+
 /**
  * The initial settings for "react-x".
  */
-declare const INITIAL_ESLINT_REACT_SETTINGS: ESLintReactSettings;
+declare const INITIAL_ESLINT_REACT_SETTINGS: {
+    readonly skipImportCheck: true;
+};
 /**
  * The default ESLint settings for "react-x".
  */
-declare const DEFAULT_ESLINT_REACT_SETTINGS: ESLintReactSettings;
+declare const DEFAULT_ESLINT_REACT_SETTINGS: {
+    readonly additionalHooks: {
+        readonly useLayoutEffect: ["useIsomorphicLayoutEffect"];
+    };
+    readonly polymorphicPropName: "as";
+    readonly skipImportCheck: true;
+    readonly version: "detect";
+};
 /**
  * This is an expanded version of `CustomComponent` with all shorthand properties expanded.
  * @internal
@@ -2107,14 +2250,14 @@ declare function defineSettings(settings: ESLintReactSettings): {};
  * @param data The data object.
  * @returns settings The settings.
  */
-declare function decodeSettings(data: unknown): ESLintReactSettings;
+declare const decodeSettings: Memoized<(data: unknown) => ESLintReactSettings>;
 /**
  * Unsafely casts settings from a data object from `context.settings`.
  * @internal
  * @param data The data object.
  * @returns settings The settings.
  */
-declare function unsafeCastSettings(data: unknown): ESLintReactSettings;
+declare function unsafeCastSettings(data: unknown): PartialDeep<ESLintReactSettings>;
 /**
  * Expands the settings by converting all shorthand properties to their full form.
  * @param settings The settings.

package/dist/index.d.ts

@@ -2068,14 +2068,157 @@ type Memoized<Fn extends AnyFn> = Fn &
     options: NormalizedOptions<Fn>;
   };
 
+/**
+Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
+
+@category Type
+*/
+type Primitive =
+	| null
+	| undefined
+	| string
+	| number
+	| boolean
+	| symbol
+	| bigint;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+/**
+Matches any primitive, `void`, `Date`, or `RegExp` value.
+*/
+type BuiltIns = Primitive | void | Date | RegExp;
+
+/**
+@see PartialDeep
+*/
+type PartialDeepOptions = {
+	/**
+	Whether to affect the individual elements of arrays and tuples.
+
+	@default false
+	*/
+	readonly recurseIntoArrays?: boolean;
+};
+
+/**
+Create a type from another type with all keys and nested keys set to optional.
+
+Use-cases:
+- Merging a default settings/config object with another object, the second object would be a deep partial of the default object.
+- Mocking and testing complex entities, where populating an entire object with its keys would be redundant in terms of the mock or test.
+
+@example
+```
+import type {PartialDeep} from 'type-fest';
+
+const settings: Settings = {
+	textEditor: {
+		fontSize: 14;
+		fontColor: '#000000';
+		fontWeight: 400;
+	}
+	autocomplete: false;
+	autosave: true;
+};
+
+const applySavedSettings = (savedSettings: PartialDeep<Settings>) => {
+	return {...settings, ...savedSettings};
+}
+
+settings = applySavedSettings({textEditor: {fontWeight: 500}});
+```
+
+By default, this does not affect elements in array and tuple types. You can change this by passing `{recurseIntoArrays: true}` as the second type argument:
+
+```
+import type {PartialDeep} from 'type-fest';
+
+interface Settings {
+	languages: string[];
+}
+
+const partialSettings: PartialDeep<Settings, {recurseIntoArrays: true}> = {
+	languages: [undefined]
+};
+```
+
+@category Object
+@category Array
+@category Set
+@category Map
+*/
+type PartialDeep<T, Options extends PartialDeepOptions = {}> = T extends BuiltIns | (((...arguments_: any[]) => unknown)) | (new (...arguments_: any[]) => unknown)
+	? T
+	: T extends Map<infer KeyType, infer ValueType>
+		? PartialMapDeep<KeyType, ValueType, Options>
+		: T extends Set<infer ItemType>
+			? PartialSetDeep<ItemType, Options>
+			: T extends ReadonlyMap<infer KeyType, infer ValueType>
+				? PartialReadonlyMapDeep<KeyType, ValueType, Options>
+				: T extends ReadonlySet<infer ItemType>
+					? PartialReadonlySetDeep<ItemType, Options>
+					: T extends object
+						? T extends ReadonlyArray<infer ItemType> // Test for arrays/tuples, per https://github.com/microsoft/TypeScript/issues/35156
+							? Options['recurseIntoArrays'] extends true
+								? ItemType[] extends T // Test for arrays (non-tuples) specifically
+									? readonly ItemType[] extends T // Differentiate readonly and mutable arrays
+										? ReadonlyArray<PartialDeep<ItemType | undefined, Options>>
+										: Array<PartialDeep<ItemType | undefined, Options>>
+									: PartialObjectDeep<T, Options> // Tuples behave properly
+								: T // If they don't opt into array testing, just use the original type
+							: PartialObjectDeep<T, Options>
+						: unknown;
+
+/**
+Same as `PartialDeep`, but accepts only `Map`s and as inputs. Internal helper for `PartialDeep`.
+*/
+type PartialMapDeep<KeyType, ValueType, Options extends PartialDeepOptions> = {} & Map<PartialDeep<KeyType, Options>, PartialDeep<ValueType, Options>>;
+
+/**
+Same as `PartialDeep`, but accepts only `Set`s as inputs. Internal helper for `PartialDeep`.
+*/
+type PartialSetDeep<T, Options extends PartialDeepOptions> = {} & Set<PartialDeep<T, Options>>;
+
+/**
+Same as `PartialDeep`, but accepts only `ReadonlyMap`s as inputs. Internal helper for `PartialDeep`.
+*/
+type PartialReadonlyMapDeep<KeyType, ValueType, Options extends PartialDeepOptions> = {} & ReadonlyMap<PartialDeep<KeyType, Options>, PartialDeep<ValueType, Options>>;
+
+/**
+Same as `PartialDeep`, but accepts only `ReadonlySet`s as inputs. Internal helper for `PartialDeep`.
+*/
+type PartialReadonlySetDeep<T, Options extends PartialDeepOptions> = {} & ReadonlySet<PartialDeep<T, Options>>;
+
+/**
+Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for `PartialDeep`.
+*/
+type PartialObjectDeep<ObjectType extends object, Options extends PartialDeepOptions> = {
+	[KeyType in keyof ObjectType]?: PartialDeep<ObjectType[KeyType], Options>
+};
+
 /**
  * The initial settings for "react-x".
  */
-declare const INITIAL_ESLINT_REACT_SETTINGS: ESLintReactSettings;
+declare const INITIAL_ESLINT_REACT_SETTINGS: {
+    readonly skipImportCheck: true;
+};
 /**
  * The default ESLint settings for "react-x".
  */
-declare const DEFAULT_ESLINT_REACT_SETTINGS: ESLintReactSettings;
+declare const DEFAULT_ESLINT_REACT_SETTINGS: {
+    readonly additionalHooks: {
+        readonly useLayoutEffect: ["useIsomorphicLayoutEffect"];
+    };
+    readonly polymorphicPropName: "as";
+    readonly skipImportCheck: true;
+    readonly version: "detect";
+};
 /**
  * This is an expanded version of `CustomComponent` with all shorthand properties expanded.
  * @internal
@@ -2107,14 +2250,14 @@ declare function defineSettings(settings: ESLintReactSettings): {};
  * @param data The data object.
  * @returns settings The settings.
  */
-declare function decodeSettings(data: unknown): ESLintReactSettings;
+declare const decodeSettings: Memoized<(data: unknown) => ESLintReactSettings>;
 /**
  * Unsafely casts settings from a data object from `context.settings`.
  * @internal
  * @param data The data object.
  * @returns settings The settings.
  */
-declare function unsafeCastSettings(data: unknown): ESLintReactSettings;
+declare function unsafeCastSettings(data: unknown): PartialDeep<ESLintReactSettings>;
 /**
  * Expands the settings by converting all shorthand properties to their full form.
  * @param settings The settings.

package/dist/index.js

@@ -930,17 +930,14 @@ var DEFAULT_ESLINT_REACT_SETTINGS = {
 function defineSettings(settings) {
   return parse(ESLintSettingsSchema, settings)["react-x"] ?? {};
 }
-function decodeSettings(data) {
+var decodeSettings = createMemoizedFunction((data) => {
   return {
     ...INITIAL_ESLINT_REACT_SETTINGS,
     ...parse(ESLintSettingsSchema, data)["react-x"] ?? {}
   };
-}
+}, { isEqual: (a, b) => a === b });
 function unsafeCastSettings(data) {
-  return {
-    ...INITIAL_ESLINT_REACT_SETTINGS,
-    ...data["react-x"] ?? {}
-  };
+  return data?.["react-x"] ?? {};
 }
 var expandSettings = createMemoizedFunction(
   (settings) => {

package/dist/index.mjs

@@ -924,17 +924,14 @@ var DEFAULT_ESLINT_REACT_SETTINGS = {
 function defineSettings(settings) {
   return parse(ESLintSettingsSchema, settings)["react-x"] ?? {};
 }
-function decodeSettings(data) {
+var decodeSettings = createMemoizedFunction((data) => {
   return {
     ...INITIAL_ESLINT_REACT_SETTINGS,
     ...parse(ESLintSettingsSchema, data)["react-x"] ?? {}
   };
-}
+}, { isEqual: (a, b) => a === b });
 function unsafeCastSettings(data) {
-  return {
-    ...INITIAL_ESLINT_REACT_SETTINGS,
-    ...data["react-x"] ?? {}
-  };
+  return data?.["react-x"] ?? {};
 }
 var expandSettings = createMemoizedFunction(
   (settings) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "1.9.0",
+  "version": "1.9.1-next.1",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {