Merge pull request #2572 from max-scopp/fix/2557-allow-undefined-options

Author: mrlubos

.changeset/sweet-dragons-reflect.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix(angular): allow `httpResource` to skip requests when `undefined` is returned

examples/openapi-ts-angular-common/src/client/@angular/common/http/resources.gen.ts

@@ -70,85 +70,103 @@ export class PetServiceResources {
    * Add a new pet to the store.
    */
   public addPet<ThrowOnError extends boolean = false>(
-    options: () => Options<AddPetData, ThrowOnError>,
+    options: () => Options<AddPetData, ThrowOnError> | undefined,
   ) {
-    return httpResource<AddPetResponse>(() => addPetRequest(options()));
+    return httpResource<AddPetResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? addPetRequest(opts) : undefined;
+    });
   }
 
   /**
    * Update an existing pet.
    * Update an existing pet by Id.
    */
   public updatePet<ThrowOnError extends boolean = false>(
-    options: () => Options<UpdatePetData, ThrowOnError>,
+    options: () => Options<UpdatePetData, ThrowOnError> | undefined,
   ) {
-    return httpResource<UpdatePetResponse>(() => updatePetRequest(options()));
+    return httpResource<UpdatePetResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? updatePetRequest(opts) : undefined;
+    });
   }
 
   /**
    * Finds Pets by status.
    * Multiple status values can be provided with comma separated strings.
    */
   public findPetsByStatus<ThrowOnError extends boolean = false>(
-    options: () => Options<FindPetsByStatusData, ThrowOnError>,
+    options: () => Options<FindPetsByStatusData, ThrowOnError> | undefined,
   ) {
-    return httpResource<FindPetsByStatusResponse>(() =>
-      findPetsByStatusRequest(options()),
-    );
+    return httpResource<FindPetsByStatusResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? findPetsByStatusRequest(opts) : undefined;
+    });
   }
 
   /**
    * Finds Pets by tags.
    * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
    */
   public findPetsByTags<ThrowOnError extends boolean = false>(
-    options: () => Options<FindPetsByTagsData, ThrowOnError>,
+    options: () => Options<FindPetsByTagsData, ThrowOnError> | undefined,
   ) {
-    return httpResource<FindPetsByTagsResponse>(() =>
-      findPetsByTagsRequest(options()),
-    );
+    return httpResource<FindPetsByTagsResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? findPetsByTagsRequest(opts) : undefined;
+    });
   }
 
   /**
    * Deletes a pet.
    * Delete a pet.
    */
   public deletePet<ThrowOnError extends boolean = false>(
-    options: () => Options<DeletePetData, ThrowOnError>,
+    options: () => Options<DeletePetData, ThrowOnError> | undefined,
   ) {
-    return httpResource<unknown>(() => deletePetRequest(options()));
+    return httpResource<unknown>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? deletePetRequest(opts) : undefined;
+    });
   }
 
   /**
    * Find pet by ID.
    * Returns a single pet.
    */
   public getPetById<ThrowOnError extends boolean = false>(
-    options: () => Options<GetPetByIdData, ThrowOnError>,
+    options: () => Options<GetPetByIdData, ThrowOnError> | undefined,
   ) {
-    return httpResource<GetPetByIdResponse>(() => getPetByIdRequest(options()));
+    return httpResource<GetPetByIdResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? getPetByIdRequest(opts) : undefined;
+    });
   }
 
   /**
    * Updates a pet in the store with form data.
    * Updates a pet resource based on the form data.
    */
   public updatePetWithForm<ThrowOnError extends boolean = false>(
-    options: () => Options<UpdatePetWithFormData, ThrowOnError>,
+    options: () => Options<UpdatePetWithFormData, ThrowOnError> | undefined,
   ) {
-    return httpResource<UpdatePetWithFormResponse>(() =>
-      updatePetWithFormRequest(options()),
-    );
+    return httpResource<UpdatePetWithFormResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? updatePetWithFormRequest(opts) : undefined;
+    });
   }
 
   /**
    * Uploads an image.
    * Upload image of the pet.
    */
   public uploadFile<ThrowOnError extends boolean = false>(
-    options: () => Options<UploadFileData, ThrowOnError>,
+    options: () => Options<UploadFileData, ThrowOnError> | undefined,
   ) {
-    return httpResource<UploadFileResponse>(() => uploadFileRequest(options()));
+    return httpResource<UploadFileResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? uploadFileRequest(opts) : undefined;
+    });
   }
 }
 
@@ -161,45 +179,51 @@ export class StoreServiceResources {
    * Returns a map of status codes to quantities.
    */
   public getInventory<ThrowOnError extends boolean = false>(
-    options?: () => Options<GetInventoryData, ThrowOnError>,
+    options?: () => Options<GetInventoryData, ThrowOnError> | undefined,
   ) {
-    return httpResource<GetInventoryResponse>(() =>
-      getInventoryRequest(options ? options() : undefined),
-    );
+    return httpResource<GetInventoryResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? getInventoryRequest(opts) : undefined;
+    });
   }
 
   /**
    * Place an order for a pet.
    * Place a new order in the store.
    */
   public placeOrder<ThrowOnError extends boolean = false>(
-    options?: () => Options<PlaceOrderData, ThrowOnError>,
+    options?: () => Options<PlaceOrderData, ThrowOnError> | undefined,
   ) {
-    return httpResource<PlaceOrderResponse>(() =>
-      placeOrderRequest(options ? options() : undefined),
-    );
+    return httpResource<PlaceOrderResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? placeOrderRequest(opts) : undefined;
+    });
   }
 
   /**
    * Delete purchase order by identifier.
    * For valid response try integer IDs with value < 1000. Anything above 1000 or non-integers will generate API errors.
    */
   public deleteOrder<ThrowOnError extends boolean = false>(
-    options: () => Options<DeleteOrderData, ThrowOnError>,
+    options: () => Options<DeleteOrderData, ThrowOnError> | undefined,
   ) {
-    return httpResource<unknown>(() => deleteOrderRequest(options()));
+    return httpResource<unknown>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? deleteOrderRequest(opts) : undefined;
+    });
   }
 
   /**
    * Find purchase order by ID.
    * For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.
    */
   public getOrderById<ThrowOnError extends boolean = false>(
-    options: () => Options<GetOrderByIdData, ThrowOnError>,
+    options: () => Options<GetOrderByIdData, ThrowOnError> | undefined,
   ) {
-    return httpResource<GetOrderByIdResponse>(() =>
-      getOrderByIdRequest(options()),
-    );
+    return httpResource<GetOrderByIdResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? getOrderByIdRequest(opts) : undefined;
+    });
   }
 }
 
@@ -212,78 +236,91 @@ export class UserServiceResources {
    * This can only be done by the logged in user.
    */
   public createUser<ThrowOnError extends boolean = false>(
-    options?: () => Options<CreateUserData, ThrowOnError>,
+    options?: () => Options<CreateUserData, ThrowOnError> | undefined,
   ) {
-    return httpResource<CreateUserResponse>(() =>
-      createUserRequest(options ? options() : undefined),
-    );
+    return httpResource<CreateUserResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? createUserRequest(opts) : undefined;
+    });
   }
 
   /**
    * Creates list of users with given input array.
    * Creates list of users with given input array.
    */
   public createUsersWithListInput<ThrowOnError extends boolean = false>(
-    options?: () => Options<CreateUsersWithListInputData, ThrowOnError>,
+    options?: () =>
+      | Options<CreateUsersWithListInputData, ThrowOnError>
+      | undefined,
   ) {
-    return httpResource<CreateUsersWithListInputResponse>(() =>
-      createUsersWithListInputRequest(options ? options() : undefined),
-    );
+    return httpResource<CreateUsersWithListInputResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? createUsersWithListInputRequest(opts) : undefined;
+    });
   }
 
   /**
    * Logs user into the system.
    * Log into the system.
    */
   public loginUser<ThrowOnError extends boolean = false>(
-    options?: () => Options<LoginUserData, ThrowOnError>,
+    options?: () => Options<LoginUserData, ThrowOnError> | undefined,
   ) {
-    return httpResource<LoginUserResponse>(() =>
-      loginUserRequest(options ? options() : undefined),
-    );
+    return httpResource<LoginUserResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? loginUserRequest(opts) : undefined;
+    });
   }
 
   /**
    * Logs out current logged in user session.
    * Log user out of the system.
    */
   public logoutUser<ThrowOnError extends boolean = false>(
-    options?: () => Options<LogoutUserData, ThrowOnError>,
+    options?: () => Options<LogoutUserData, ThrowOnError> | undefined,
   ) {
-    return httpResource<unknown>(() =>
-      logoutUserRequest(options ? options() : undefined),
-    );
+    return httpResource<unknown>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? logoutUserRequest(opts) : undefined;
+    });
   }
 
   /**
    * Delete user resource.
    * This can only be done by the logged in user.
    */
   public deleteUser<ThrowOnError extends boolean = false>(
-    options: () => Options<DeleteUserData, ThrowOnError>,
+    options: () => Options<DeleteUserData, ThrowOnError> | undefined,
   ) {
-    return httpResource<unknown>(() => deleteUserRequest(options()));
+    return httpResource<unknown>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? deleteUserRequest(opts) : undefined;
+    });
   }
 
   /**
    * Get user by user name.
    * Get user detail based on username.
    */
   public getUserByName<ThrowOnError extends boolean = false>(
-    options: () => Options<GetUserByNameData, ThrowOnError>,
+    options: () => Options<GetUserByNameData, ThrowOnError> | undefined,
   ) {
-    return httpResource<GetUserByNameResponse>(() =>
-      getUserByNameRequest(options()),
-    );
+    return httpResource<GetUserByNameResponse>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? getUserByNameRequest(opts) : undefined;
+    });
   }
 
   /**
    * Update user resource.
    * This can only be done by the logged in user.
    */
   public updateUser<ThrowOnError extends boolean = false>(
-    options: () => Options<UpdateUserData, ThrowOnError>,
+    options: () => Options<UpdateUserData, ThrowOnError> | undefined,
   ) {
-    return httpResource<unknown>(() => updateUserRequest(options()));
+    return httpResource<unknown>(() => {
+      const opts = options ? options() : undefined;
+      return opts ? updateUserRequest(opts) : undefined;
+    });
   }
 }