fix: Add instructions for peerDependencies (#27)

* Add instructions for peerDependencies

* ci: Format code

* ci: Generate code

* Move section down

* Move section up

* Fix typo

* Collapse sections

---------

Co-authored-by: Seam Bot <[email protected]>

Author: razor-x

README.md

@@ -22,11 +22,17 @@ The underlying HTTP client is [Axios].
 
 [Seam]: https://www.seam.co/
 [Seam Docs]: https://docs.seam.co/latest/
+[seamapi]: https://www.npmjs.com/package/seamapi
 [@seamapi/types]: https://github.com/seamapi/types/
 [Axios]: https://axios-http.com/
 
 ## Installation
 
+_This is a low-level package meant for applications and libraries with particular dependency requirements.
+Before using this package, ensure you understand the installation and updating instructions.
+This SDK is entirely contained in the [seamapi] package. Seam recommends using that package instead
+for simpler dependency management._
+
 Add this as a dependency to your project using [npm] with
 
 ```
@@ -35,6 +41,36 @@ $ npm install @seamapi/http
 
 [npm]: https://www.npmjs.com/
 
+### Optional Peer Dependencies for TypeScript
+
+This package has optional peer dependencies for TypeScript users.
+Recent versions of npm will automatically install peer dependencies by default.
+For those users, no additional steps are necessary for full TypeScript support,
+however users should still explicitly install the latest types (see the next section).
+
+Other package managers require peer dependencies to be added manually.
+Refer to any warnings generated by your package manager
+about missing peer dependencies and install them as needed.
+Refer to the next section for keeping the types updated.
+
+#### Keeping up with the latest types
+
+This package depends on [@seamapi/types] for the latest TypeScript types.
+New versions of this package are generally not released when new types are published.
+Unless your project frequently runs a blanket `npm update`,
+the types will become outdated with the Seam API over time.
+Thus, users of this package should explicitly install the types
+
+```
+$ npm install @seamapi/types
+```
+
+and update them when consuming new API features:
+
+```
+$ npm install @seamapi/http@latest
+```
+
 ## Usage
 
 ```ts

package-lock.json

@@ -84,7 +84,7 @@
     "npm": ">= 8.1.0"
   },
   "peerDependencies": {
-    "@seamapi/types": "^1.0.0",
+    "@seamapi/types": "^1.58.0",
     "type-fest": "^4.0.0"
   },
   "peerDependenciesMeta": {
@@ -98,11 +98,11 @@
   "dependencies": {
     "axios": "^1.5.0",
     "axios-better-stacktrace": "^2.1.5",
-    "axios-retry": "^3.8.1",
-    "@seamapi/types": "^1.44.1"
+    "axios-retry": "^3.8.1"
   },
   "devDependencies": {
     "@seamapi/fake-seam-connect": "^1.43.0",
+    "@seamapi/types": "^1.58.0",
     "@types/eslint": "^8.44.2",
     "@types/node": "^18.11.18",
     "ava": "^5.0.1",