@mobx-ecosystem/mobx-form 2.0.2

package/README.md

@@ -0,0 +1,7 @@
+## Installation
+```bash
+npm install @mobx-ecosystem/mobx-form mobx
+
+
+yarn add @mobx-ecosystem/mobx-form mobx
+```

package/dist/configure-form.d.ts

@@ -0,0 +1,9 @@
+export type ValidateFunction = (fieldValues: Record<string, unknown>, validationSchema: unknown) => Promise<Record<string, string>>;
+export declare let validate: ValidateFunction | undefined;
+export interface ConfigurationForm {
+    validation: {
+        validate: ValidateFunction;
+    };
+}
+export declare const configureForm: (configuration: ConfigurationForm) => void;
+export declare const _checkConfiguration: () => void;

package/dist/field-service.d.ts

@@ -0,0 +1,26 @@
+type FieldOptionsType = {
+    onError?: boolean;
+};
+type Nullable<T> = T | null;
+export declare class FieldService<T> {
+    _serviceType: string;
+    _initValue?: Nullable<T>;
+    _value?: Nullable<T>;
+    _error?: string;
+    validate?(): Promise<void>;
+    _disabled: boolean;
+    options?: FieldOptionsType;
+    constructor(initValue?: T, options?: FieldOptionsType);
+    get initValue(): Nullable<T> | undefined;
+    set initValue(initValue: Nullable<T> | undefined);
+    get value(): Nullable<T> | undefined;
+    set value(value: Nullable<T> | undefined);
+    get error(): string | undefined;
+    set error(error: string | undefined);
+    get disabled(): boolean;
+    set disabled(disabled: boolean);
+    get isValid(): boolean;
+    get isInit(): boolean;
+    get props(): any;
+}
+export {};

package/dist/form-service.d.ts

@@ -0,0 +1,58 @@
+import { FieldService } from './field-service';
+export declare class FormService<T extends Record<string, FieldService<unknown>>> {
+    fields: T;
+    validationSchema?: unknown;
+    constructor(fields: T, validationSchema?: unknown);
+    /***
+     * Validate the form
+     *
+     * *Configure this method with configureForm from mobx-form
+     */
+    validate: () => Promise<void>;
+    /**
+     * Return field keys
+     */
+    get keys(): string[];
+    /**
+     * Check each field if its isValid = true
+     */
+    get isValid(): boolean;
+    /**
+     * Check each field if its isInit = false
+     */
+    get isTouched(): boolean;
+    /**
+     * Check if isTouched = true && isValid = true
+     */
+    get canBeSubmitted(): boolean;
+    /**
+     *
+     * @returns Object of field values
+     */
+    getValues: () => Record<string, unknown>;
+    /**
+     * Set field values to init values
+     */
+    setValuesAsInit: () => void;
+    /**
+     * Set field errors to undefined
+     */
+    resetErrors: () => void;
+    /**
+     * Set errors for fields
+     * @param errors object of string which provides errors for fields
+     */
+    setErrors(errors: Record<string, string>): void;
+    /**
+     * Reset fields to their own initial values
+     */
+    reset: () => void;
+    /**
+     * Pass true to the property 'disabled'
+     */
+    disable: () => void;
+    /**
+     * Pass false to the property 'disabled'
+     */
+    enable: () => void;
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './field-service';
+export * from './form-service';
+export * from './configure-form';

package/dist/index.js

@@ -0,0 +1 @@
+import{isEqual as e}from"lodash";import{makeAutoObservable as t}from"mobx";var r=function(){return r=Object.assign||function(e){for(var t,r=1,n=arguments.length;r<n;r++)for(var i in t=arguments[r])Object.prototype.hasOwnProperty.call(t,i)&&(e[i]=t[i]);return e},r.apply(this,arguments)};function n(e,t,r,n){return new(r||(r=Promise))((function(i,o){function u(e){try{s(n.next(e))}catch(e){o(e)}}function a(e){try{s(n.throw(e))}catch(e){o(e)}}function s(e){var t;e.done?i(e.value):(t=e.value,t instanceof r?t:new r((function(e){e(t)}))).then(u,a)}s((n=n.apply(e,t||[])).next())}))}function i(e,t){var r,n,i,o,u={label:0,sent:function(){if(1&i[0])throw i[1];return i[1]},trys:[],ops:[]};return o={next:a(0),throw:a(1),return:a(2)},"function"==typeof Symbol&&(o[Symbol.iterator]=function(){return this}),o;function a(a){return function(s){return function(a){if(r)throw new TypeError("Generator is already executing.");for(;o&&(o=0,a[0]&&(u=0)),u;)try{if(r=1,n&&(i=2&a[0]?n.return:a[0]?n.throw||((i=n.return)&&i.call(n),0):n.next)&&!(i=i.call(n,a[1])).done)return i;switch(n=0,i&&(a=[2&a[0],i.value]),a[0]){case 0:case 1:i=a;break;case 4:return u.label++,{value:a[1],done:!1};case 5:u.label++,n=a[1],a=[0];continue;case 7:a=u.ops.pop(),u.trys.pop();continue;default:if(!(i=u.trys,(i=i.length>0&&i[i.length-1])||6!==a[0]&&2!==a[0])){u=0;continue}if(3===a[0]&&(!i||a[1]>i[0]&&a[1]<i[3])){u.label=a[1];break}if(6===a[0]&&u.label<i[1]){u.label=i[1],i=a;break}if(i&&u.label<i[2]){u.label=i[2],u.ops.push(a);break}i[2]&&u.ops.pop(),u.trys.pop();continue}a=t.call(e,u)}catch(e){a=[6,e],n=0}finally{r=i=0}if(5&a[0])throw a[1];return{value:a[0]?a[1]:void 0,done:!0}}([a,s])}}}var o,u=function(){function n(e,r){this._serviceType="field-service",this._disabled=!1,t(this),this.initValue=e,this.options=r}return Object.defineProperty(n.prototype,"initValue",{get:function(){return this._initValue},set:function(e){this._initValue=e,this._value=e,this.validate&&this.validate()},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"value",{get:function(){return this._value},set:function(e){this._value=e},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"error",{get:function(){return this._error},set:function(e){this._error=e},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"disabled",{get:function(){return this._disabled},set:function(e){this._disabled=e},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"isValid",{get:function(){return!this._error},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"isInit",{get:function(){return null!==(t=this.value)&&"object"==typeof t?e(this.value,this._initValue):this._value===this._initValue;var t},enumerable:!1,configurable:!0}),Object.defineProperty(n.prototype,"props",{get:function(){var e,t=this,n={value:this.value,error:this.error,disabled:this.disabled};return(null===(e=this.options)||void 0===e?void 0:e.onError)&&(n=r(r({},n),{onError:function(e){t.error=t.error||(null==e?void 0:e.toString())}})),r(r({},n),{onChange:function(e,r){t.value=r,t.validate&&t.validate()}})},enumerable:!1,configurable:!0}),n}(),a=function(e){o=e.validation.validate},s=function(){if(!o)throw new Error("You must define configureForm to configure mobx-form")},l=function(){function e(e,r){var u=this;this.validate=function(){return n(u,void 0,void 0,(function(){var e,t;return i(this,(function(r){switch(r.label){case 0:return e=this.getValues(),[4,null==o?void 0:o(e,this.validationSchema)];case 1:return(t=r.sent())&&0!=Object.keys(t||[]).length?this.setErrors(t):this.resetErrors(),[2]}}))}))},this.getValues=function(){var e={};return u.keys.forEach((function(t){e[t]=u.fields[t].value})),e},this.setValuesAsInit=function(){u.keys.forEach((function(e){u.fields[e].initValue=u.fields[e].value}))},this.resetErrors=function(){u.keys.forEach((function(e){return u.fields[e].error=void 0}))},this.reset=function(){u.keys.forEach((function(e){return u.fields[e].value=u.fields[e].initValue})),u.validate()},this.disable=function(){u.keys.forEach((function(e){return u.fields[e].disabled=!0}))},this.enable=function(){u.keys.forEach((function(e){return u.fields[e].disabled=!1}))},s(),t(this),this.fields=e,this.validationSchema=r,this.keys.forEach((function(e){u.fields[e].validate=u.validate}))}return Object.defineProperty(e.prototype,"keys",{get:function(){return Object.keys(this.fields)},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"isValid",{get:function(){var e=this;return this.keys.every((function(t){return e.fields[t].isValid}))},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"isTouched",{get:function(){var e=this;return this.keys.some((function(t){return!e.fields[t].isInit}))},enumerable:!1,configurable:!0}),Object.defineProperty(e.prototype,"canBeSubmitted",{get:function(){return this.isTouched&&this.isValid},enumerable:!1,configurable:!0}),e.prototype.setErrors=function(e){var t=this;this.keys.forEach((function(r){t.fields[r].error=null==e?void 0:e[r]}))},e}();export{u as FieldService,l as FormService,s as _checkConfiguration,a as configureForm,o as validate};

package/dist/utils/check-types.d.ts

@@ -0,0 +1,7 @@
+export declare const isObject: (obj: unknown) => obj is Record<string, unknown>;
+export declare const isInteger: (obj: unknown) => boolean;
+export declare const isString: (obj: unknown) => boolean;
+export declare const isBlob: (obj: unknown) => boolean;
+export declare const isFile: (obj: unknown) => boolean;
+export declare const isNumber: (value: unknown) => boolean;
+export declare const isBoolean: (value: unknown) => boolean;

package/dist/utils/form.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './form';
+export * from './check-types';

package/package.json

@@ -0,0 +1,63 @@
+{
+  "type": "module",
+  "name": "@mobx-ecosystem/mobx-form",
+  "private": false,
+  "version": "2.0.2",
+  "description": "provides the ability to use forms with validation in MobX stores",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "dev": "tsc --watch",
+    "_clear": "rimraf dist",
+    "tsc": "tsc",
+    "_make-bundle": "rollup -c",
+    "build": "run-s _clear _make-bundle",
+    "pub": "yarn build && yarn publish --access public",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "mobx-formik",
+    "mobx-forms",
+    "form",
+    "mobx-form"
+  ],
+  "author": "RudikS",
+  "license": "MIT",
+  "peerDependencies": {
+    "mobx": "^4 || ^5 || ^6"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-terser": "^0.4.0",
+    "@rollup/plugin-typescript": "^11.1.0",
+    "@types/lodash": "^4.14.192",
+    "mobx": "^6.9.0",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^5.0.0",
+    "rollup": "^3.20.2",
+    "rollup-plugin-dts": "^5.3.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "tslib": "^2.5.0",
+    "typescript": "^5.0.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/RudikS-git/mobx-ecosystem"
+  },
+  "dependencies": {
+    "lodash": "^4.17.21"
+  }
+}