feat: add runtime hooks for API request and response handling

[mattmess1221]

🔗 Linked issue

Related to #87 and #88

❓ Type of change

• 📖 Documentation (updates to the documentation, readme or JSDoc annotations)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

I'm marking this as a draft because some decisions need to be made about which endpoints will trigger a hook.

Should client -> server -> backend send a hook on the client and server, or just the server?

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[netlify]

✅ Deploy Preview for nuxt-api-party ready!

Name	Link
🔨 Latest commit	7053472
🔍 Latest deploy log	https://app.netlify.com/sites/nuxt-api-party/deploys/67dbc8e0b41659000845623d
😎 Deploy Preview	https://deploy-preview-89--nuxt-api-party.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[mattmess1221]

Build failures may be related to nuxt/nuxt#29263

[johannschopplich]

Another banger from you. 🤯 Thanks a lot, @mattmess1221!

[froozeify]

Those hooks are what I was looking for.

I wanted to dynamically update the Authorization headers based on the request received (i.e If defined in the request as Bearer don't change it and else I'll be adding the Basic header - for an oauth app with custom oauth server)

[margaretjoanmiller]

@froozeify did it end up working out? was going to use the hooks to set the auth token header but I'm wondering if with refresh tokens it would be more trouble than it's worth

[mattmess1221]

I managed to work around the build typechecking issues by importing directly from nitropack/runtime instead of through #imports. I'm thinking it may be a good idea to just avoid #imports altogether in the rest of the project just for consistency.

Other things I've done

• Removed hooks from server-side $api utility. I figure the user should explicitly pass any headers, fetch hooks, etc if they need to customize it from the server.
• Added dynamic hook keys based on the endpoint id for ease of registration. e.g. api-party:request will trigger for all request hooks, but api-party:request:jsonPlaceholder will only trigger for the jsonPlaceholder endpoint.

Docs probably need some work.

[johannschopplich]

@mattmess1221 Thanks a lot for the updates and patience on review. Great work! 🙏 Let's release and iterate.

Some thoughts:

• Using nitropack/runtime is fine, I agree, since the types are broken otherwise. It will be deprecated in Nitro v3, but we're long before that.
• Love the api-party:request:jsonPlaceholder approach!