feat: add support for path params is useMutate

src/Get.tsx

@@ -57,7 +57,7 @@ export interface Meta {
 /**
  * Props for the <Get /> component.
  */
-export interface GetProps<TData, TError, TQueryParams> {
+export interface GetProps<TData, TError, TQueryParams, TPathParams> {
   /**
    * The path at which to request data,
    * typically composed by parent Gets or the RestfulProvider.
@@ -78,6 +78,10 @@ export interface GetProps<TData, TError, TQueryParams> {
   children: (data: TData | null, states: States<TData, TError>, actions: Actions<TData>, meta: Meta) => React.ReactNode;
   /** Options passed into the fetch call. */
   requestOptions?: RestfulReactProviderProps["requestOptions"];
+  /**
+   * Query parameters
+   */
+  pathParams?: TPathParams;
   /**
    * Query parameters
    */
@@ -142,11 +146,11 @@ export interface GetState<TData, TError> {
  * is a named class because it is useful in
  * debugging.
  */
-class ContextlessGet<TData, TError, TQueryParams> extends React.Component<
-  GetProps<TData, TError, TQueryParams> & InjectedProps,
+class ContextlessGet<TData, TError, TQueryParams, TPathParams = unknown> extends React.Component<
+  GetProps<TData, TError, TQueryParams, TPathParams> & InjectedProps,
   Readonly<GetState<TData, TError>>
 > {
-  constructor(props: GetProps<TData, TError, TQueryParams> & InjectedProps) {
+  constructor(props: GetProps<TData, TError, TQueryParams, TPathParams> & InjectedProps) {
     super(props);
 
     if (typeof props.debounce === "object") {
@@ -184,7 +188,7 @@ class ContextlessGet<TData, TError, TQueryParams> extends React.Component<
     }
   }
 
-  public componentDidUpdate(prevProps: GetProps<TData, TError, TQueryParams>) {
+  public componentDidUpdate(prevProps: GetProps<TData, TError, TQueryParams, TPathParams>) {
     const { base, parentPath, path, resolve, queryParams } = prevProps;
     if (
       base !== this.props.base ||
@@ -335,8 +339,8 @@ class ContextlessGet<TData, TError, TQueryParams> extends React.Component<
  * in order to provide new `parentPath` props that contain
  * a segment of the path, creating composable URLs.
  */
-function Get<TData = any, TError = any, TQueryParams = { [key: string]: any }>(
-  props: GetProps<TData, TError, TQueryParams>,
+function Get<TData = any, TError = any, TQueryParams = { [key: string]: any }, TPathParams = unknown>(
+  props: GetProps<TData, TError, TQueryParams, TPathParams>,
 ) {
   return (
     <RestfulReactConsumer>

src/Mutate.tsx

@@ -44,7 +44,7 @@ export interface Meta {
 /**
  * Props for the <Mutate /> component.
  */
-export interface MutateProps<TData, TError, TQueryParams, TRequestBody, TPathParams = unknown> {
+export interface MutateProps<TData, TError, TQueryParams, TRequestBody, TPathParams> {
   /**
    * The path at which to request data,
    * typically composed by parents or the RestfulProvider.
@@ -268,9 +268,13 @@ class ContextlessMutate<TData, TError, TQueryParams, TRequestBody, TPathParams =
  * in order to provide new `parentPath` props that contain
  * a segment of the path, creating composable URLs.
  */
-function Mutate<TData = any, TError = any, TQueryParams = { [key: string]: any }, TRequestBody = any>(
-  props: MutateProps<TData, TError, TQueryParams, TRequestBody>,
-) {
+function Mutate<
+  TData = any,
+  TError = any,
+  TQueryParams = { [key: string]: any },
+  TRequestBody = any,
+  TPathParams = unknown
+>(props: MutateProps<TData, TError, TQueryParams, TRequestBody, TPathParams>) {
   return (
     <RestfulReactConsumer>
       {contextProps => (

src/Poll.tsx

@@ -52,11 +52,11 @@ interface Actions {
 /**
  * Props that can control the Poll component.
  */
-export interface PollProps<TData, TError, TQueryParams> {
+export interface PollProps<TData, TError, TQueryParams, TPathParams> {
   /**
    * What path are we polling on?
    */
-  path: GetProps<TData, TError, TQueryParams>["path"];
+  path: GetProps<TData, TError, TQueryParams, TPathParams>["path"];
   /**
    * A function that gets polled data, the current
    * states, meta information, and various actions
@@ -89,19 +89,19 @@ export interface PollProps<TData, TError, TQueryParams> {
    * Are we going to wait to start the poll?
    * Use this with { start, stop } actions.
    */
-  lazy?: GetProps<TData, TError, TQueryParams>["lazy"];
+  lazy?: GetProps<TData, TError, TQueryParams, TPathParams>["lazy"];
   /**
    * Should the data be transformed in any way?
    */
   resolve?: (data: any, prevData: TData | null) => TData;
   /**
    * We can request foreign URLs with this prop.
    */
-  base?: GetProps<TData, TError, TQueryParams>["base"];
+  base?: GetProps<TData, TError, TQueryParams, TPathParams>["base"];
   /**
    * Any options to be passed to this request.
    */
-  requestOptions?: GetProps<TData, TError, TQueryParams>["requestOptions"];
+  requestOptions?: GetProps<TData, TError, TQueryParams, TPathParams>["requestOptions"];
   /**
    * Query parameters
    */
@@ -155,8 +155,8 @@ export interface PollState<TData, TError> {
 /**
  * The <Poll /> component without context.
  */
-class ContextlessPoll<TData, TError, TQueryParams> extends React.Component<
-  PollProps<TData, TError, TQueryParams> & InjectedProps,
+class ContextlessPoll<TData, TError, TQueryParams, TPathParams = unknown> extends React.Component<
+  PollProps<TData, TError, TQueryParams, TPathParams> & InjectedProps,
   Readonly<PollState<TData, TError>>
 > {
   public readonly state: Readonly<PollState<TData, TError>> = {
@@ -339,8 +339,8 @@ class ContextlessPoll<TData, TError, TQueryParams> extends React.Component<
   }
 }
 
-function Poll<TData = any, TError = any, TQueryParams = { [key: string]: any }>(
-  props: PollProps<TData, TError, TQueryParams>,
+function Poll<TData = any, TError = any, TQueryParams = { [key: string]: any }, TPathParams = unknown>(
+  props: PollProps<TData, TError, TQueryParams, TPathParams>,
 ) {
   // Compose Contexts to allow for URL nesting
   return (

src/scripts/import-open-api.ts

@@ -384,7 +384,7 @@ export const generateRestfulComponent = (
     verb === "get"
       ? `${needAResponseComponent ? componentName + "Response" : responseTypes}, ${errorTypes}, ${
           queryParamsType ? componentName + "QueryParams" : "void"
-        }`
+        }, ${paramsInPath.length ? componentName + "PathParams" : "void"}`
       : `${needAResponseComponent ? componentName + "Response" : responseTypes}, ${errorTypes}, ${
           queryParamsType ? componentName + "QueryParams" : "void"
         }, ${
@@ -393,7 +393,7 @@ export const generateRestfulComponent = (
             : needARequestBodyComponent
             ? componentName + "RequestBody"
             : requestBodyTypes
-        }`;
+        }, ${paramsInPath.length ? componentName + "PathParams" : "void"}`;
 
   const genericsTypesForHooksProps =
     verb === "get"
@@ -451,7 +451,7 @@ export interface ${componentName}RequestBody ${requestBodyTypes}
   }
 export type ${componentName}Props = Omit<${Component}Props<${genericsTypes}>, "path"${
     verb === "get" ? "" : ` | "verb"`
-  }>${paramsInPath.length ? ` & {${paramsTypes}}` : ""};
+  }>${paramsInPath.length ? ` & ${componentName}PathParams` : ""};
 
 ${description}export const ${componentName} = (${
     paramsInPath.length ? `{${paramsInPath.join(", ")}, ...props}` : "props"
@@ -482,7 +482,11 @@ ${description}export const use${componentName} = (${
     paramsInPath.length ? `{${paramsInPath.join(", ")}, ...props}` : "props"
   }: Use${componentName}Props) => use${Component}<${genericsTypes}>(${
     verb === "get" ? "" : `"${verb.toUpperCase()}", `
-  }${paramsInPath.length ? `({ ${paramsInPath.join(", ")} }) => \`${route}\`` : `\`${route}\``}, { ${
+  }${
+    paramsInPath.length
+      ? `({ ${paramsInPath.join(", ")} }: ${componentName}PathParams) => \`${route}\``
+      : `\`${route}\``
+  }, { ${
     customPropsEntries.length
       ? `{ ${customPropsEntries
           .map(([key, value]) => `${key}:${reactPropsValueToObjectValue(value || "")}`)

src/scripts/tests/__snapshots__/import-open-api.test.ts.snap

@@ -72,7 +72,7 @@ export interface FindPetsQueryParams {
   limit?: number;
 }
 
-export type FindPetsProps = Omit<GetProps<Pet[], Error, FindPetsQueryParams>, \\"path\\">;
+export type FindPetsProps = Omit<GetProps<Pet[], Error, FindPetsQueryParams, void>, \\"path\\">;
 
 /**
  * Returns all pets from the system that the user has access to
@@ -82,7 +82,7 @@ export type FindPetsProps = Omit<GetProps<Pet[], Error, FindPetsQueryParams>, \\
  * 
  */
 export const FindPets = (props: FindPetsProps) => (
-  <Get<Pet[], Error, FindPetsQueryParams>
+  <Get<Pet[], Error, FindPetsQueryParams, void>
     path={\`/pets\`}
     {...props}
   />
@@ -97,16 +97,16 @@ export type UseFindPetsProps = Omit<UseGetProps<Pet[], FindPetsQueryParams, void
  * Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
  * 
  */
-export const useFindPets = (props: UseFindPetsProps) => useGet<Pet[], Error, FindPetsQueryParams>(\`/pets\`, { ...props });
+export const useFindPets = (props: UseFindPetsProps) => useGet<Pet[], Error, FindPetsQueryParams, void>(\`/pets\`, { ...props });
 
 
-export type AddPetProps = Omit<MutateProps<Pet, Error, void, NewPet>, \\"path\\" | \\"verb\\">;
+export type AddPetProps = Omit<MutateProps<Pet, Error, void, NewPet, void>, \\"path\\" | \\"verb\\">;
 
 /**
  * Creates a new pet in the store.  Duplicates are allowed
  */
 export const AddPet = (props: AddPetProps) => (
-  <Mutate<Pet, Error, void, NewPet>
+  <Mutate<Pet, Error, void, NewPet, void>
     verb=\\"POST\\"
     path={\`/pets\`}
     {...props}
@@ -118,20 +118,20 @@ export type UseAddPetProps = Omit<UseMutateProps<Pet, void, NewPet, void>, \\"pa
 /**
  * Creates a new pet in the store.  Duplicates are allowed
  */
-export const useAddPet = (props: UseAddPetProps) => useMutate<Pet, Error, void, NewPet>(\\"POST\\", \`/pets\`, { ...props });
+export const useAddPet = (props: UseAddPetProps) => useMutate<Pet, Error, void, NewPet, void>(\\"POST\\", \`/pets\`, { ...props });
 
 
 export interface FindPetByIdPathParams {
   id: number
 }
 
-export type FindPetByIdProps = Omit<GetProps<Pet, Error, void>, \\"path\\"> & {id: number};
+export type FindPetByIdProps = Omit<GetProps<Pet, Error, void, FindPetByIdPathParams>, \\"path\\"> & FindPetByIdPathParams;
 
 /**
  * Returns a user based on a single ID, if the user does not have access to the pet
  */
 export const FindPetById = ({id, ...props}: FindPetByIdProps) => (
-  <Get<Pet, Error, void>
+  <Get<Pet, Error, void, FindPetByIdPathParams>
     path={\`/pets/\${id}\`}
     {...props}
   />
@@ -142,16 +142,16 @@ export type UseFindPetByIdProps = Omit<UseGetProps<Pet, void, FindPetByIdPathPar
 /**
  * Returns a user based on a single ID, if the user does not have access to the pet
  */
-export const useFindPetById = ({id, ...props}: UseFindPetByIdProps) => useGet<Pet, Error, void>(({ id }) => \`/pets/\${id}\`, { pathParams: { id }, ...props });
+export const useFindPetById = ({id, ...props}: UseFindPetByIdProps) => useGet<Pet, Error, void, FindPetByIdPathParams>(({ id }: FindPetByIdPathParams) => \`/pets/\${id}\`, { pathParams: { id }, ...props });
 
 
-export type DeletePetProps = Omit<MutateProps<void, Error, void, number>, \\"path\\" | \\"verb\\">;
+export type DeletePetProps = Omit<MutateProps<void, Error, void, number, void>, \\"path\\" | \\"verb\\">;
 
 /**
  * deletes a single pet based on the ID supplied
  */
 export const DeletePet = (props: DeletePetProps) => (
-  <Mutate<void, Error, void, number>
+  <Mutate<void, Error, void, number, void>
     verb=\\"DELETE\\"
     path={\`/pets\`}
     {...props}
@@ -163,20 +163,20 @@ export type UseDeletePetProps = Omit<UseMutateProps<void, void, number, void>, \
 /**
  * deletes a single pet based on the ID supplied
  */
-export const useDeletePet = (props: UseDeletePetProps) => useMutate<void, Error, void, number>(\\"DELETE\\", \`/pets\`, { ...props });
+export const useDeletePet = (props: UseDeletePetProps) => useMutate<void, Error, void, number, void>(\\"DELETE\\", \`/pets\`, { ...props });
 
 
 export interface UpdatePetPathParams {
   id: number
 }
 
-export type UpdatePetProps = Omit<MutateProps<Pet, Error, void, UpdatePetRequestRequestBody>, \\"path\\" | \\"verb\\"> & {id: number};
+export type UpdatePetProps = Omit<MutateProps<Pet, Error, void, UpdatePetRequestRequestBody, UpdatePetPathParams>, \\"path\\" | \\"verb\\"> & UpdatePetPathParams;
 
 /**
  * Updates a pet in the store.
  */
 export const UpdatePet = ({id, ...props}: UpdatePetProps) => (
-  <Mutate<Pet, Error, void, UpdatePetRequestRequestBody>
+  <Mutate<Pet, Error, void, UpdatePetRequestRequestBody, UpdatePetPathParams>
     verb=\\"PATCH\\"
     path={\`/pets/\${id}\`}
     {...props}
@@ -188,7 +188,7 @@ export type UseUpdatePetProps = Omit<UseMutateProps<Pet, void, UpdatePetRequestR
 /**
  * Updates a pet in the store.
  */
-export const useUpdatePet = ({id, ...props}: UseUpdatePetProps) => useMutate<Pet, Error, void, UpdatePetRequestRequestBody>(\\"PATCH\\", ({ id }) => \`/pets/\${id}\`, { pathParams: { id }, ...props });
+export const useUpdatePet = ({id, ...props}: UseUpdatePetProps) => useMutate<Pet, Error, void, UpdatePetRequestRequestBody, UpdatePetPathParams>(\\"PATCH\\", ({ id }: UpdatePetPathParams) => \`/pets/\${id}\`, { pathParams: { id }, ...props });
 
 "
 `;