@keysdown/form-wrapper 0.0.5 → 0.0.7

package/README.md

@@ -12,12 +12,33 @@
 npm install @keysdown/form-wrapper --save
 ```
 
+## Importing
+
+```js
+import {createForm} from '@keysdown/form-wrapper'
+
+const form = ref(createForm({
+    first_name: null,
+    last_name: null,
+    username: null
+}))
+
+// Or
+
+import FormWrapper from '@keysdown/form-wrapper'
+
+const form = ref(new FormWrapper({
+    first_name: null,
+    last_name: null,
+    username: null
+}))
+```
+
 ## Basic example
 
 Basic example using Vue.
 
 ```vue
-
 <template>
   <form @submit.prevent="submit">
     <input type="text" v-model="form.first_name"/>
@@ -30,9 +51,9 @@ Basic example using Vue.
 <script setup lang="ts">
   import axios from 'axios'
   import {ref} from 'vue'
-  import Form from '@keysdown/form-wrapper'
+  import {createForm} from '@keysdown/form-wrapper'
 
-  const form = ref(Form({
+  const form = ref(createForm({
     first_name: null,
     last_name: null,
     username: null
@@ -73,9 +94,9 @@ Basic example with validation using Vue.
 <script setup lang="ts">
   import axios from 'axios'
   import {ref} from 'vue'
-  import Form from '@keysdown/form-wrapper'
+  import {createForm} from '@keysdown/form-wrapper'
 
-  const form = ref(Form({
+  const form = ref(createForm({
     first_name: {
       value: null,
       rules: ['required'],
@@ -179,7 +200,7 @@ form.addFields({
 Method used when you want to fill in several form fields at once.
 
 ```js
-const form = Form({
+const form = createForm({
     username: null
 })
 
@@ -197,7 +218,7 @@ console.log(form.values()) // {username: 'keysdown'}
 Method used when you want to remove a field from the form.
 
 ```js
-const form = Form({
+const form = createForm({
     username: null
 })
 
@@ -213,7 +234,7 @@ console.log(form.values()) // {}
 Method used to remove multiple fields to the form.
 
 ```js
-const form = Form({
+const form = createForm({
     username: null
 })
 
@@ -229,7 +250,7 @@ console.log(form.values()) // {}
 Method used to reset all form values to original state.
 
 ```js
-const form = Form({
+const form = createForm({
     username: null
 })
 
@@ -247,7 +268,7 @@ console.log(form.values()) // {username: null}
 Method used to change the form loading state.
 
 ```js
-const form = Form({
+const form = createForm({
     username: null
 })
 
@@ -267,7 +288,7 @@ console.log(form.awaiting) // false
 Method used to validate the entire form or a specific field.
 
 ```js
- const form = Form({
+ const form = createForm({
     username: {
         value: null,
         rules: ['required'],
@@ -301,7 +322,7 @@ form.validate()
 Method used to validate a specific field.
 
 ```js
- const form = Form({
+ const form = createForm({
     username: {
         value: null,
         rules: ['required'],
@@ -335,7 +356,7 @@ form.validate('username')
 Method used to validate the entire form.
 
 ```js
- const form = Form({
+ const form = createForm({
     username: {
         value: null,
         rules: ['required'],
@@ -371,7 +392,7 @@ form.validate()
 Method used to access all form values in json format.
 
 ```js
- const form = Form({
+ const form = createForm({
     username: null
 })
 
@@ -385,7 +406,7 @@ axios.post('some-api', form.values())
 Method used to access all form values as form data.
 
 ```js
- const form = Form({
+ const form = createForm({
     username: null
 })
 

package/dist/form-wrapper.d.ts

@@ -0,0 +1,6 @@
+export * from './main'
+export {}
+import FormWrapper from './main'
+export default FormWrapper
+export * from './main'
+export {}

package/dist/main.d.ts

@@ -1,4 +1,3 @@
-import { Form } from './core/Form';
-declare const createForm: (data: any) => Form;
-export { createForm };
-export default Form;
+import { Form as FormWrapper } from './core/Form';
+export declare const createForm: (data: any) => FormWrapper;
+export default FormWrapper;

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@keysdown/form-wrapper",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "type": "module",
   "files": [
     "dist/*"
   ],
   "main": "./dist/form-wrapper.umd.cjs",
   "module": "./dist/form-wrapper.js",
-  "types": "./dist/main.d.ts",
+  "types": "./dist/form-wrapper.d.ts",
   "exports": {
     ".": {
       "import": "./dist/form-wrapper.js",
       "require": "./dist/form-wrapper.umd.cjs",
-      "types": "./dist/main.d.ts"
+      "types": "./dist/form-wrapper.d.ts"
     }
   },
   "scripts": {