@gnosticdev/hono-actions 2.0.10 → 2.1.0

package/README.md

@@ -5,10 +5,10 @@ Define server actions with built-in validation, error handling, and a pre-built
 ## Installation
 
 ```bash
-npm install @gnosticdev/hono-actions
-# or
-pnpm add @gnosticdev/hono-actions
-# or
+# with astro cli
+astro add @gnosticdev/hono-actions
+
+# package manager (npm, pnpm, bun, etc.)
 bun add @gnosticdev/hono-actions
 ```
 
@@ -16,14 +16,17 @@ bun add @gnosticdev/hono-actions
 
 This package requires:
 
-- `astro`: ^5.13.0
+- `astro`: ^5.13.0 or ^6.0.0
+
+> [!IMPORTANT]
+> For typescript, make sure you set `strictNullChecks` to `true`, or extend `astro/tsconfigs/strict(est)` in your `tsconfig.json`
 
 ## Supported Adapters
 
 This integration works with all supported Astro adapters:
 
 - `@astrojs/cloudflare`
-- `@astrojs/node`
+- `@astrojs/node` (standalone mode only)
 - `@astrojs/vercel`
 - `@astrojs/netlify`
 
@@ -33,7 +36,7 @@ This integration works with all supported Astro adapters:
 
 The integration works with all Astro adapters. Here are examples for each:
 
-#### Cloudflare
+#### Cloudflare/Vercel/Netlify Adapter
 
 ```typescript
 // astro.config.ts
@@ -43,7 +46,7 @@ import honoActions from '@gnosticdev/hono-actions'
 
 export default defineConfig({
   output: 'server',
-  adapter: cloudflare(),
+  adapter: cloudflare() // vercel() or netlify(),
   integrations: [
     honoActions({
       basePath: '/api', // Optional: default is '/api'
@@ -53,7 +56,9 @@ export default defineConfig({
 })
 ```
 
-#### Node.js
+#### Node.js Adapter
+
+Node.js adapter only supports the 'standalone' mode.
 
 ```typescript
 // astro.config.ts
@@ -64,65 +69,23 @@ import honoActions from '@gnosticdev/hono-actions'
 export default defineConfig({
   output: 'server',
   adapter: node({
-    mode: 'standalone' // or 'middleware'
+    mode: 'standalone'
   }),
   integrations: [
-    honoActions({
-      basePath: '/api', // Optional: default is '/api'
-      actionsPath: 'src/server/actions.ts' // Optional: custom path to your actions file
-    })
-  ]
-})
-```
-
-#### Vercel
-
-```typescript
-// astro.config.ts
-import { defineConfig } from 'astro/config'
-import vercel from '@astrojs/vercel/serverless'
-import honoActions from '@gnosticdev/hono-actions'
-
-export default defineConfig({
-  output: 'server',
-  adapter: vercel(),
-  integrations: [
-    honoActions({
-      basePath: '/api', // Optional: default is '/api'
-      actionsPath: 'src/server/actions.ts' // Optional: custom path to your actions file
-    })
-  ]
-})
-```
-
-#### Netlify
-
-```typescript
-// astro.config.ts
-import { defineConfig } from 'astro/config'
-import netlify from '@astrojs/netlify'
-import honoActions from '@gnosticdev/hono-actions'
-
-export default defineConfig({
-  output: 'server',
-  adapter: netlify(),
-  integrations: [
-    honoActions({
-      basePath: '/api', // Optional: default is '/api'
-      actionsPath: 'src/server/actions.ts' // Optional: custom path to your actions file
-    })
+    honoActions()
   ]
 })
 ```
 
 ### 2. Create your actions file
 
-If not using a custom actions path, create a file at one of these locations:
+Create a file at one of these locations, or use the `actionsPath` option to specify a custom path:
 
 - `src/server/actions.ts`
 - `src/hono/actions.ts`
 - `src/hono/index.ts`
 - `src/hono.ts`
+- `src/hono-actions.ts`
 
 ## Usage
 
@@ -132,7 +95,6 @@ import { defineHonoAction type HonoEnv } from '@gnosticdev/hono-actions/actions'
 import { z } from 'astro/zod'
 import { Hono } from 'hono'
 
-// Define a POST action with Zod validation (no `path` option is used anymore)
 export const myAction = defineHonoAction({
   schema: z.object({
     name: z.string()
@@ -239,12 +201,6 @@ const handleSubmit = async (formData: FormData) => {
 }
 ```
 
-## Advanced Usage
-
-### Using AsyncLocalStorage with Custom Hono Instances
-
-For advanced use cases involving request-scoped data and custom Hono instances, see [docs/async_hooks.md](./docs/async_hooks.md).
-
 ## Augmenting Type Interfaces
 
 When using this library, you may need to augment the type interfaces to add custom types for your environment bindings, Hono context variables, or Astro locals. This is especially important when using the Cloudflare adapter.
@@ -253,6 +209,8 @@ When using this library, you may need to augment the type interfaces to add cust
 
 When using the `@astrojs/cloudflare` adapter, the library automatically exports Cloudflare runtime types. However, it assumes that Cloudflare types have been generated by Wrangler via the `wrangler types` command, which creates an `Env` interface that is automatically added to `HonoEnv['Bindings']`.
 
+For Astro 6 and newer, use the matching Astro 6 adapter majors (`@astrojs/cloudflare` v13+, `@astrojs/node` v10+, `@astrojs/vercel` v10+, `@astrojs/netlify` v7+).
+
 To generate Cloudflare types:
 
 ```bash
@@ -382,6 +340,12 @@ If you get module resolution errors during development:
 1. Try clearing your node_modules and reinstalling
 2. Make sure you're using compatible versions of the peer dependencies
 
+## Advanced Usage
+
+### Using AsyncLocalStorage with Custom Hono Instances
+
+For advanced use cases involving request-scoped data and custom Hono instances, see [docs/async_hooks.md](./docs/async_hooks.md).
+
 ## License
 
 MIT