@gnosticdev/hono-actions 2.0.10 → 2.0.11

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
 ```
 
@@ -18,12 +18,15 @@ This package requires:
 
 - `astro`: ^5.13.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.
@@ -382,6 +338,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

package/dist/actions.d.ts

@@ -7,7 +7,7 @@ import { MergeSchemaPath } from 'hono/types';
 /**
  * Standard error codes for actions
  */
-type ActionErrorCode = 'INPUT_VALIDATION_ERROR' | 'EXTERNAL_API_ERROR' | 'INTERNAL_SERVER_ERROR' | 'UNKNOWN_ERROR' | 'LOCATION_NOT_FOUND' | 'SESSION_NOT_FOUND';
+type ActionErrorCode = 'INPUT_VALIDATION_ERROR' | 'EXTERNAL_API_ERROR' | 'INTERNAL_SERVER_ERROR' | 'UNKNOWN_ERROR' | 'LOCATION_NOT_FOUND' | 'SESSION_NOT_FOUND' | (string & {});
 declare class HonoActionError<TMessage extends string, TCode extends ActionErrorCode, TIssue = any> extends Error {
     code: TCode;
     issue?: TIssue;
@@ -42,7 +42,7 @@ interface HonoEnv {
     Bindings: Bindings;
     Variables: Variables;
 }
-type HonoActionSchema = z.ZodTypeAny;
+type HonoActionSchema = z.ZodType<any, z.ZodTypeDef, any>;
 /**
  * Merge each action key into its route path.
  *

package/dist/index.js

@@ -248,7 +248,9 @@ var integration_default = defineIntegration({
         "astro:config:setup": async (params) => {
           const { logger, injectRoute, createCodegenDir, config } = params;
           const root = config.root.pathname;
-          const absPatterns = ACTION_PATTERNS.map((p) => path.join(root, p));
+          const absPatterns = ACTION_PATTERNS.map(
+            (p) => path.join(root, p)
+          );
           const files = await glob(absPatterns, {
             expandDirectories: false,
             absolute: true
@@ -270,7 +272,10 @@ ${ACTION_PATTERNS.map((p) => ` - ${p}`).join("\n")}`
             `Found actions: ${path.relative(root, resolvedActionsPath)}`
           );
           const codeGenDir = createCodegenDir();
-          const routerPathAbs = path.join(codeGenDir.pathname, "router.ts");
+          const routerPathAbs = path.join(
+            codeGenDir.pathname,
+            "router.ts"
+          );
           const relFromGenToActions = path.relative(codeGenDir.pathname, resolvedActionsPath).split(path.sep).join("/");
           const adapter = params.config.adapter?.name;
           if (!adapter) {
@@ -292,10 +297,20 @@ ${ACTION_PATTERNS.map((p) => ` - ${p}`).join("\n")}`
             adapter
           });
           await fs.writeFile(routerPathAbs, routerContent, "utf-8");
-          const astroHandlerPathAbs = path.join(codeGenDir.pathname, "api.ts");
+          const astroHandlerPathAbs = path.join(
+            codeGenDir.pathname,
+            "api.ts"
+          );
           const astroHandlerContent = generateAstroHandler(adapter);
-          await fs.writeFile(astroHandlerPathAbs, astroHandlerContent, "utf-8");
-          const clientPathAbs = path.join(codeGenDir.pathname, "client.ts");
+          await fs.writeFile(
+            astroHandlerPathAbs,
+            astroHandlerContent,
+            "utf-8"
+          );
+          const clientPathAbs = path.join(
+            codeGenDir.pathname,
+            "client.ts"
+          );
           if (!config.site) {
             logger.warn(
               "No site url found in astro config, add one if you want to use the hono client with SSR"
@@ -316,9 +331,15 @@ ${ACTION_PATTERNS.map((p) => ` - ${p}`).join("\n")}`
             entrypoint: astroHandlerPathAbs,
             prerender: false
           });
-          logger.info(`\u2705 Hono Actions route mounted at ${basePath}/[...slug]`);
+          logger.info(
+            `\u2705 Hono Actions route mounted at ${basePath}/[...slug]`
+          );
         },
-        "astro:config:done": async ({ injectTypes, config, logger }) => {
+        "astro:config:done": async ({
+          injectTypes,
+          config,
+          logger
+        }) => {
           const adapter = config.adapter?.name;
           if (!adapter) {
             logger.warn("No adapter found...");

package/package.json

@@ -61,5 +61,5 @@
   },
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "2.0.10"
+  "version": "2.0.11"
 }