Merge pull request #70 from alexandredev3/fix/typings

fix: useModal show handle no longer making every prop optional and add NiceModa.show component props generic

Author: supnate

src/index.tsx

@@ -209,11 +209,12 @@ const getModalId = (modal: string | React.FC<any>): string => {
 
 /** omit id and partial all required props */
 type NiceModalArgs<T> = T extends keyof JSX.IntrinsicElements | React.JSXElementConstructor<any>
-  ? Partial<Omit<React.ComponentProps<T>, 'id'>>
+  ? Omit<React.ComponentProps<T>, 'id'>
   : Record<string, unknown>;
 
 export function show<T extends any, C extends React.FC>(modal: C, args?: Omit<React.ComponentProps<C>, 'id'>): Promise<T>;
 export function show<T extends any>(modal: string, args?: Record<string, unknown>): Promise<T>;
+export function show<T extends any, P extends any>(modal: string, args: P): Promise<T>;
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export function show(modal: React.FC<any> | string, args?: NiceModalArgs<React.FC<any>> | Record<string, unknown>) {
   const modalId = getModalId(modal);
@@ -275,11 +276,20 @@ const setFlags = (modalId: string, flags: Record<string, unknown>): void => {
   dispatch(setModalFlags(modalId, flags));
 };
 export function useModal(): NiceModalHandler;
-export function useModal<T extends string>(modal: T, args?: Record<string, unknown>): NiceModalHandler;
-export function useModal<T extends React.FC<any>>(
+export function useModal(modal: string, args?: Record<string, unknown>): NiceModalHandler;
+export function useModal<
+  T extends React.FC<any>,
+  ComponentProps extends NiceModalArgs<T>,
+  PreparedProps extends Partial<ComponentProps> = {},
+  RemainingProps = Omit<ComponentProps, keyof PreparedProps> & Partial<ComponentProps>
+>(
   modal: T,
-  args?: NiceModalArgs<T>,
-): NiceModalHandler<NiceModalArgs<T>>;
+  args?: PreparedProps
+): Omit<NiceModalHandler, 'show'> & {
+  show: { [K in keyof RemainingProps]: RemainingProps[K] extends Exclude<RemainingProps[keyof RemainingProps], undefined> ? K : never }[keyof RemainingProps] extends undefined
+  ? (args?: RemainingProps) => Promise<unknown>
+  : (args: RemainingProps) => Promise<unknown>
+};
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export function useModal(modal?: any, args?: any): any {
   const modals = useContext(NiceModalContext);
@@ -389,7 +399,7 @@ export const create = <P extends {}>(Comp: React.ComponentType<P>): React.FC<P &
 };
 
 // All registered modals will be rendered in modal placeholder
-export const register = <T extends React.FC<any>>(id: string, comp: T, props?: NiceModalArgs<T>): void => {
+export const register = <T extends React.FC<any>>(id: string, comp: T, props?: Partial<NiceModalArgs<T>>): void => {
   if (!MODAL_REGISTRY[id]) {
     MODAL_REGISTRY[id] = { comp, props };
   } else {