Merge pull request #97 from Adammatthiesen/update

Author: hkbertoson

.changeset/four-trains-argue.md

@@ -0,0 +1,27 @@
+---
+"astro-turnstile": patch
+---
+
+[Fix/Docs]: 
+
+- Update Type `AstroTurnstileOptions` to reflect the correct default values by switching from `z.infer` to a `typeof Schema._input` which properly shows the type as it would be used by the enduser
+
+```ts
+// Previously
+type AstroTurnstileOptions = {
+    endpointPath: string;
+    disableClientScript: boolean;
+    disableDevToolbar: boolean;
+    verbose: boolean;
+}
+
+// Now
+type AstroTurnstileOptions = {
+    endpointPath?: string | undefined;
+    disableClientScript?: boolean | undefined;
+    disableDevToolbar?: boolean | undefined;
+    verbose?: boolean | undefined;
+} | undefined
+```
+
+- Update readme to include instructions and more information about what is available to users from the integration

package/README.md

@@ -68,10 +68,80 @@ export default defineConfig({
 
 ### Configuration
 
+#### `.env` File
+
 You will need to add these 2 values to your `.env` file:
 
-- `siteKey` (required): Your Turnstile site key
-- `secretKey` (required): Your Turnstile secret key - this should be kept secret
+- `TURNSTILE_SITE_KEY` (required): Your Turnstile site key
+- `TURNSTILE_SECRET_KEY` (required): Your Turnstile secret key - this should be kept secret
+
+#### Astro Config Options
+
+**`verbose`**
+- Type: `boolean`
+- Default: `false`
+
+Enable verbose logging.
+
+**`disableClientScript`**
+- Type: `boolean`
+- Default: `false`
+
+Disable the client-side script injection.
+
+By default, the client-side script is injected into the Astro project on every page. In some cases, you may want to disable this behavior, and manually inject the script where needed. This option allows you to disable the client-side script injection.
+
+Note: If you disable the client-side script injection, you will need to manually inject the Turnstile client-side script into your Astro project.
+
+**`disableDevToolbar`**
+- Type: `boolean`
+- Default: `false`
+
+Disable the Astro Turnstile Dev Toolbar App.
+
+**`endpointPath`**
+- Type: `string`
+- Default: `/verify`
+
+The path to the injected Turnstile API endpoint.
+
+### Usage
+
+The following components are made available to the end user:
+
+- **`TurnstileWidget`** - The main widget component for displaying the Turnstile captcha field in forms
+  - Available Props:
+    - **`theme`**: 
+      - Type: `"auto"` | `"light"` | `"dark"` | `undefined`
+      - Default: `"auto"`
+    - **`size`**: 
+      - Type: `"normal"` | `"compact"` | `"flexible"` | `undefined`
+      - Default: `"normal"`
+    - **`margin`**: 
+      - Type: `string` | `undefined`
+      - Default: `"0.5rem"`
+
+- `TurnstileForm` - A helper form element that assists you in building your forms with Turnstile verification built in
+  - Available Props:
+    - (All the props from Widget)
+    - **`enctype`**
+      - Type: `"multipart/form-data"` | `"application/x-www-form-urlencoded"` | `"submit"` | `undefined`
+      - Default: `"application/x-www-form-urlencoded"`
+    - **`action`**
+      - Type: `string` | `null` | `undefined`
+    - **`method`**
+      - Type: `string` | `null` | `undefined`
+
+These components can be accessed by either of the following methods:
+
+```ts
+// Option 1: Runtime virtual module
+import { TurnstileWidget, TurnstileForm } from 'astro-turnstile:components';
+
+// Option 2: Direct package exports
+import { TurnstileWidget, TurnstileForm } from 'astro-turnstile/components';
+
+```
 
 ## Contributing
 

package/src/schema.ts

@@ -109,4 +109,9 @@ export const AstroTurnstileOptionsSchema = z
 /**
  * Astro-Turnstile configuration options type.
  */
-export type AstroTurnstileOptions = z.infer<typeof AstroTurnstileOptionsSchema>;
+export type AstroTurnstileOptions = typeof AstroTurnstileOptionsSchema._input;
+
+/**
+ * Astro-Turnstile configuration options type used by the `virtual:astro-turnstile/config` module.
+ */
+export type AstroTurnstileConfig = z.infer<typeof AstroTurnstileOptionsSchema>;

package/src/stubs.ts

@@ -12,7 +12,7 @@ config.addSingleLineNote(
 // Add the module to the file
 config.addModule("virtual:astro-turnstile/config", {
 	defaultExport: {
-		typeDef: `import("${name}/schema").AstroTurnstileOptions`,
+		typeDef: `import("${name}/schema").AstroTurnstileConfig`,
 		singleLineDescription: "The Turnstile configuration options",
 	},
 });