feat: add @hey-api/angular-resource plugin with Angular resource generation

- Introduced the @hey-api/angular-resource plugin to facilitate Angular resource generation.
- Implemented configuration options for generating resources as classes or functions.
- Created necessary types and interfaces for the plugin.
- Developed the plugin handler to generate Angular services based on SDK operations.
- Added auto-generated resource methods for Pet, Store, and User entities.
- Updated the plugin configuration map to include the new angular-resource plugin.
- Removed deprecated httpResource option from the client-angular plugin.

Author: max-scopp

examples/openapi-ts-angular/openapi-ts.config.ts

@@ -10,9 +10,14 @@ export default defineConfig({
   },
   plugins: [
     '@hey-api/client-angular',
+    '@tanstack/angular-query-experimental',
+    {
+      // asClass: true,
+      name: '@hey-api/angular-resource',
+    },
     '@hey-api/schemas',
     {
-      asClass: false,
+      asClass: true,
       name: '@hey-api/sdk',
     },
     {

examples/openapi-ts-angular/src/client/@hey-api/angular-resource.gen.ts

@@ -0,0 +1,289 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { Injectable, resource } from '@angular/core';
+
+import type { Options } from '../sdk.gen';
+import { Pet, Store, User } from '../sdk.gen';
+import type {
+  AddPetData,
+  CreateUserData,
+  CreateUsersWithListInputData,
+  DeleteOrderData,
+  DeletePetData,
+  DeleteUserData,
+  FindPetsByStatusData,
+  FindPetsByTagsData,
+  GetInventoryData,
+  GetOrderByIdData,
+  GetPetByIdData,
+  GetUserByNameData,
+  LoginUserData,
+  LogoutUserData,
+  PlaceOrderData,
+  UpdatePetData,
+  UpdatePetWithFormData,
+  UpdateUserData,
+  UploadFileData,
+} from '../types.gen';
+
+@Injectable({
+  providedIn: 'root',
+})
+export class PetResource {
+  /**
+   * Add a new pet to the store.
+   * Add a new pet to the store.
+   */
+  public addPet<ThrowOnError extends boolean = false>(
+    options: Options<AddPetData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Pet.addPet(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Update an existing pet.
+   * Update an existing pet by Id.
+   */
+  public updatePet<ThrowOnError extends boolean = false>(
+    options: Options<UpdatePetData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Pet.updatePet(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Finds Pets by status.
+   * Multiple status values can be provided with comma separated strings.
+   */
+  public findPetsByStatus<ThrowOnError extends boolean = false>(
+    options: Options<FindPetsByStatusData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Pet.findPetsByStatus(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * 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>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Pet.findPetsByTags(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Deletes a pet.
+   * Delete a pet.
+   */
+  public deletePet<ThrowOnError extends boolean = false>(
+    options: Options<DeletePetData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Pet.deletePet(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Find pet by ID.
+   * Returns a single pet.
+   */
+  public getPetById<ThrowOnError extends boolean = false>(
+    options: Options<GetPetByIdData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Pet.getPetById(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * 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>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Pet.updatePetWithForm(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Uploads an image.
+   * Upload image of the pet.
+   */
+  public uploadFile<ThrowOnError extends boolean = false>(
+    options: Options<UploadFileData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Pet.uploadFile(params),
+      params: () => options,
+    });
+  }
+}
+
+@Injectable({
+  providedIn: 'root',
+})
+export class StoreResource {
+  /**
+   * Returns pet inventories by status.
+   * Returns a map of status codes to quantities.
+   */
+  public getInventory<ThrowOnError extends boolean = false>(
+    options?: Options<GetInventoryData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Store.getInventory(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Place an order for a pet.
+   * Place a new order in the store.
+   */
+  public placeOrder<ThrowOnError extends boolean = false>(
+    options?: Options<PlaceOrderData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Store.placeOrder(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * 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>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Store.deleteOrder(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * 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>,
+  ) {
+    return resource({
+      loader: async ({ params }) => Store.getOrderById(params),
+      params: () => options,
+    });
+  }
+}
+
+@Injectable({
+  providedIn: 'root',
+})
+export class UserResource {
+  /**
+   * Create user.
+   * This can only be done by the logged in user.
+   */
+  public createUser<ThrowOnError extends boolean = false>(
+    options?: Options<CreateUserData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => User.createUser(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * 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>,
+  ) {
+    return resource({
+      loader: async ({ params }) => User.createUsersWithListInput(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Logs user into the system.
+   * Log into the system.
+   */
+  public loginUser<ThrowOnError extends boolean = false>(
+    options?: Options<LoginUserData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => User.loginUser(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Logs out current logged in user session.
+   * Log user out of the system.
+   */
+  public logoutUser<ThrowOnError extends boolean = false>(
+    options?: Options<LogoutUserData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => User.logoutUser(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Delete user resource.
+   * This can only be done by the logged in user.
+   */
+  public deleteUser<ThrowOnError extends boolean = false>(
+    options: Options<DeleteUserData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => User.deleteUser(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Get user by user name.
+   * Get user detail based on username.
+   */
+  public getUserByName<ThrowOnError extends boolean = false>(
+    options: Options<GetUserByNameData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => User.getUserByName(params),
+      params: () => options,
+    });
+  }
+
+  /**
+   * Update user resource.
+   * This can only be done by the logged in user.
+   */
+  public updateUser<ThrowOnError extends boolean = false>(
+    options: Options<UpdateUserData, ThrowOnError>,
+  ) {
+    return resource({
+      loader: async ({ params }) => User.updateUser(params),
+      params: () => options,
+    });
+  }
+}