update API

Author: tlabaj

packages/react-icons/src/createIcon.tsx

@@ -14,20 +14,26 @@ export interface IconDefinitionBase {
   svgClassName?: string;
 }
 
-/** Icon metadata using the current `svgPathData` field name. */
-export interface IconDefinitionWithSvgPathData extends IconDefinitionBase {
-  svgPathData: string | SVGPathObject[];
-}
-
 /**
- * @deprecated Use {@link IconDefinitionWithSvgPathData} with `svgPathData` instead.
+ * SVG path content for one icon variant (default or rh-ui). At runtime at least one of
+ * `svgPathData` or `svgPath` must be set; if both are present, `svgPathData` is used.
  */
-export interface IconDefinitionWithSvgPath extends IconDefinitionBase {
-  svgPath: string | SVGPathObject[];
+export interface IconDefinition extends IconDefinitionBase {
+  svgPathData?: string | SVGPathObject[];
+  /**
+   * @deprecated Use {@link IconDefinition.svgPathData} instead.
+   */
+  svgPath?: string | SVGPathObject[];
 }
 
-/** Describes SVG path content for one icon variant (default or rh-ui). */
-export type IconDefinition = IconDefinitionWithSvgPathData | IconDefinitionWithSvgPath;
+/** Narrows {@link IconDefinition} to the preferred shape with required `svgPathData`. */
+export type IconDefinitionWithSvgPathData = Required<Pick<IconDefinition, 'svgPathData'>> & IconDefinition;
+
+/**
+ * @deprecated Use {@link IconDefinition} with `svgPathData` instead.
+ * Narrows {@link IconDefinition} to the legacy shape with required `svgPath`.
+ */
+export type IconDefinitionWithSvgPath = Required<Pick<IconDefinition, 'svgPath'>> & IconDefinition;
 
 /** When passing `icon` or `rhUiIcon` keys (nested form), `icon` is required at runtime. */
 export interface CreateIconProps {