feat(google/firestore/v1): onboard a new library#8859
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new package, @google-cloud/firestore-api, containing the auto-generated Node.js client for both the Cloud Firestore data and admin APIs. The review feedback highlights that several files (including package.json, README.md, and webpack.config.js) incorrectly describe the package as solely an admin client or contain incorrect links. The reviewer recommends updating the upstream generator templates for the auto-generated files and provides specific code suggestions to correct the package description and webpack library name.
| { | ||
| "name": "@google-cloud/firestore-api", | ||
| "version": "0.1.0", | ||
| "description": "Admin client for Node.js", |
There was a problem hiding this comment.
The description "Admin client for Node.js" is too narrow. This package (@google-cloud/firestore-api) contains both the main Firestore data client APIs (v1 and v1beta1) and the admin APIs. It should be updated to be more comprehensive.
| "description": "Admin client for Node.js", | |
| "description": "Cloud Firestore API client for Node.js", |
| A comprehensive list of changes in each version may be found in | ||
| [the CHANGELOG][homepage_changelog]. | ||
|
|
||
| * [Cloud Firestore API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/admin/latest) |
There was a problem hiding this comment.
The API reference link points to the admin reference (reference/admin/latest) instead of the correct reference for this package (reference/firestore-api/latest). Since this README is auto-generated, please update the generator configuration or templates upstream to use the correct reference instead of editing this file manually.
References
- Do not manually edit auto-generated files to fix typos or make other changes, as these edits will be overwritten during the next regeneration. Instead, apply the fixes upstream in the generator or templates.
| [homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-firestore-admin/samples | ||
| [homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-firestore-admin/CHANGELOG.md | ||
| [homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-firestore-admin |
There was a problem hiding this comment.
The generated links at the bottom of the README point to google-firestore-admin instead of google-cloud-firestore-api. This will result in broken links or point users to the wrong package's samples and changelog. Please update the generator configuration or templates upstream to use the correct package directory packages/google-cloud-firestore-api instead of editing this file manually.
References
- Do not manually edit auto-generated files to fix typos or make other changes, as these edits will be overwritten during the next regeneration. Instead, apply the fixes upstream in the generator or templates.
| output: { | ||
| library: 'FirestoreAdmin', | ||
| filename: './firestore-admin.js', | ||
| }, |
There was a problem hiding this comment.
The webpack configuration is using FirestoreAdmin and firestore-admin.js as the library name and output filename. Since this package is @google-cloud/firestore-api (which contains both admin and data APIs), the webpack output should be updated to reflect the package name.
| output: { | |
| library: 'FirestoreAdmin', | |
| filename: './firestore-admin.js', | |
| }, | |
| output: { | |
| library: 'FirestoreApi', | |
| filename: './firestore-api.js', | |
| }, |
1 participant
No description provided.