feat(form): omit from state

packages/forms/src/components-control/form-utils/view-state.ts

@@ -1,10 +1,10 @@
-import {AstroGlobal} from 'astro';
+import { AstroGlobal } from 'astro';
 import superjson from 'superjson';
-import {parseFormData} from '../../form-tools/post.js';
-import {FormsSettings, getFormOptions} from '../../settings.js';
-import {BindForm} from './bind-form.js';
+import { parseFormData } from '../../form-tools/post.js';
+import { FormsSettings, getFormOptions } from '../../settings.js';
+import { BindForm } from './bind-form.js';
 import snappy from 'snappy';
-import {getSomeProps} from '../props-utils.js';
+import { getSomeProps, omitProps } from '../props-utils.js';
 import crypto from 'crypto';
 
 const CRYPTO_ALGORITHM = 'aes-256-ctr';
@@ -25,6 +25,10 @@ export default class ViewStateManager {
         return this._astro.props.state ?? true;
     }
 
+    get omitProps() {
+        return this._astro.props.omitState;
+    }
+
     get useState() {
         return this.stateProp && this._astro.request.method === 'POST';
     }
@@ -51,7 +55,7 @@ export default class ViewStateManager {
     private async _parseState() {
         try {
             const state = await this._extractStateFromForm();
-            if(state == null) return;
+            if (state == null) return;
 
             const [iv, content] = state.split('.');
 
@@ -80,7 +84,9 @@ export default class ViewStateManager {
 
     public async createViewState(): Promise<string> {
         const data = {
-            bind: getSomeProps(this._bind.__getState(), this.stateProp),
+            bind: this.omitProps ?
+                omitProps(this._bind.__getState(), this.omitProps):
+                getSomeProps(this._bind.__getState(), this.stateProp),
             elements: this._elementsState
         };
 

packages/forms/src/components-control/props-utils.ts

@@ -21,3 +21,20 @@ export function getSomeProps(object: any, props: string[] | true) {
     }
     return result;
 }
+
+/**
+ * Omit properties from an object, any property that starts with an underscore or is in the props array will be omitted
+ */
+export function omitProps(object: any, props: string[] | true) {
+    if (props === true) {
+        return {};
+    }
+
+    const result = {...object};
+    for (const prop in object) {
+        if(props.includes(prop) || prop[0] === '_'){
+            delete result[prop];
+        }
+    }
+    return result;
+}

packages/forms/src/components/form/BindForm.astro

@@ -7,6 +7,7 @@ import Bind from '../../components-control/form-utils/bind-form.js';
 export interface Props {
     bind?: ReturnType<typeof Bind>;
     state?: boolean | string[];
+    omitState?: string[];
 }
 
 const {viewStates} = getContext(Astro, '@astro-utils/forms');
@@ -29,6 +30,7 @@ await asyncContext(() => Astro.slots.render('default'), Astro, {name: '@astro-ut
 
 let htmlSolt = await asyncContext(() => Astro.slots.render('default'), Astro, {name: '@astro-utils/forms', context, lock: "bindForm"});
 bind.__finishFormValidation();
+
 for (const func of context.executeAfter) {
     await (func as any)();
 }