drf-react-by-schema 0.20.10 → 0.21.1

package/dist/hooks/useWhyDidYouUpdate.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = require("react");
+function useWhyDidYouUpdate(name, props) {
+    const previousProps = (0, react_1.useRef)({});
+    (0, react_1.useEffect)(() => {
+        if (previousProps.current) {
+            const allKeys = new Set([...Object.keys(previousProps.current), ...Object.keys(props)]);
+            const changes = {};
+            allKeys.forEach((key) => {
+                var _a, _b;
+                if (((_a = previousProps.current) === null || _a === void 0 ? void 0 : _a[key]) !== props[key]) {
+                    changes[key] = {
+                        from: (_b = previousProps.current) === null || _b === void 0 ? void 0 : _b[key],
+                        to: props[key],
+                    };
+                }
+            });
+            if (Object.keys(changes).length > 0) {
+                console.log('[why-did-you-update]', name, changes);
+            }
+        }
+        previousProps.current = props;
+    });
+}
+exports.default = useWhyDidYouUpdate;

package/dist/utils.d.ts

@@ -1,17 +1,18 @@
 import { GridFilterModel } from '@mui/x-data-grid';
-import { Choice, ChoiceValue, ExtraValidators, GenericValue, GridEnrichedBySchemaColDef, Item, SchemaType } from './@types';
+import { Choice, ChoiceValue, ExtraValidators, Field, FormFieldLayout, GenericValue, GridEnrichedBySchemaColDef, Item, SchemaType } from './@types';
 export declare const emptyByType: GenericValue;
 export declare const getChoiceByValue: (value: ChoiceValue, choices: Choice[] | undefined) => string | null | undefined;
 export declare const populateValues: ({ data, schema }: {
     data: Item;
     schema: SchemaType;
 }) => Item;
-export declare function buildGenericYupValidationSchema({ data, schema, many, skipFields, extraValidators, }: {
+export declare function buildGenericYupValidationSchema({ data, schema, many, skipFields, extraValidators, uiFields, }: {
     data: Item;
     schema: SchemaType;
     many?: boolean;
     skipFields?: string[];
     extraValidators?: ExtraValidators;
+    uiFields?: string[];
 }): any;
 export declare const errorProps: ({ errors, fieldKey, fieldKeyProp, index, }: {
     errors: Item;
@@ -38,4 +39,6 @@ export declare function initViewColumns({ schema, columns, customColumnOperation
 export declare function shouldMemoUpdate<T extends object>(prevProps: Readonly<T>, nextProps: Readonly<T>): boolean;
 export declare const convertToFormData: (data: Item) => FormData;
 export declare function formatFileSize(bytes: number): string;
+export declare function getFieldsFromFieldsLayout(fieldsLayout: FormFieldLayout[]): string[];
+export declare function isFieldRequired(fieldSchema: Field, isInForm?: boolean): boolean;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGnD,OAAO,EACL,MAAM,EACN,WAAW,EACX,eAAe,EAEf,YAAY,EAEZ,0BAA0B,EAC1B,IAAI,EACJ,UAAU,EACX,MAAM,UAAU,CAAC;AAElB,eAAO,MAAM,WAAW,EAAE,YAyBzB,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,OAAO,WAAW,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,8BASjF,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,kBAAkB;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,SA8ClF,CAAC;AA0DF,wBAAgB,+BAA+B,CAAC,EAC9C,IAAI,EACJ,MAAM,EACN,IAAY,EACZ,UAAe,EACf,eAAe,GAChB,EAAE;IACD,IAAI,EAAE,IAAI,CAAC;IACX,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,OAyEA;AAED,eAAO,MAAM,UAAU,GAAI,4CAKxB;IACD,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;;;CAkBA,CAAC;AAEF,eAAO,MAAM,QAAQ,cAEpB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,IAAI,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,YAK7D,CAAC;AAEF,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,YAQtE;AAED,eAAO,MAAM,gBAAgB,GAAI,MAAM,MAAM,WAqB5C,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,mDA0B7E;AAED,eAAO,MAAM,eAAe,GAAI,KAAK,MAAM,EAAE,sBAAoB,WAWhE,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,MAAM,MAAM,GAAG,IAAI,WAa1C,CAAC;AAEF,wBAAgB,gBAAgB,CAC9B,aAAa,EAAE,eAAe,GAAG,SAAS,EAC1C,MAAM,EAAE,eAAe,GAAG,SAAS,OAyBpC;AAED,wBAAsB,eAAe,CAAC,EACpC,MAAM,EACN,OAAO,EACP,sBAAsB,GACvB,EAAE;IACD,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,0BAA0B,EAAE,CAAC;IACtC,sBAAsB,CAAC,EAAE,CACvB,CAAC,EAAE,0BAA0B,KAC1B,0BAA0B,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;CACvE,gBAoGA;AA0CD,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAC/C,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EACtB,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,GACrB,OAAO,CAwCT;AAED,eAAO,MAAM,iBAAiB,GAAI,MAAM,IAAI,KAAG,QAuB9C,CAAC;AAEF,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,UAgB3C"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGnD,OAAO,EACL,MAAM,EACN,WAAW,EACX,eAAe,EACf,KAAK,EACL,eAAe,EACf,YAAY,EAEZ,0BAA0B,EAC1B,IAAI,EACJ,UAAU,EACX,MAAM,UAAU,CAAC;AAElB,eAAO,MAAM,WAAW,EAAE,YAyBzB,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,OAAO,WAAW,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,8BASjF,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,kBAAkB;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,SA8ClF,CAAC;AA0DF,wBAAgB,+BAA+B,CAAC,EAC9C,IAAI,EACJ,MAAM,EACN,IAAY,EACZ,UAAe,EACf,eAAe,EACf,QAAQ,GACT,EAAE;IACD,IAAI,EAAE,IAAI,CAAC;IACX,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB,OA0EA;AAED,eAAO,MAAM,UAAU,GAAI,4CAKxB;IACD,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;;;CAkBA,CAAC;AAEF,eAAO,MAAM,QAAQ,cAEpB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,IAAI,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,YAK7D,CAAC;AAEF,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,YAQtE;AAED,eAAO,MAAM,gBAAgB,GAAI,MAAM,MAAM,WAqB5C,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,mDA0B7E;AAED,eAAO,MAAM,eAAe,GAAI,KAAK,MAAM,EAAE,sBAAoB,WAWhE,CAAC;AAEF,eAAO,MAAM,OAAO,GAAI,MAAM,MAAM,GAAG,IAAI,WAa1C,CAAC;AAEF,wBAAgB,gBAAgB,CAC9B,aAAa,EAAE,eAAe,GAAG,SAAS,EAC1C,MAAM,EAAE,eAAe,GAAG,SAAS,OAyBpC;AAED,wBAAsB,eAAe,CAAC,EACpC,MAAM,EACN,OAAO,EACP,sBAAsB,GACvB,EAAE;IACD,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,0BAA0B,EAAE,CAAC;IACtC,sBAAsB,CAAC,EAAE,CACvB,CAAC,EAAE,0BAA0B,KAC1B,0BAA0B,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;CACvE,gBAoGA;AA0CD,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAC/C,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EACtB,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,GACrB,OAAO,CAwCT;AAED,eAAO,MAAM,iBAAiB,GAAI,MAAM,IAAI,KAAG,QAuB9C,CAAC;AAEF,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,UAgB3C;AAED,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,eAAe,EAAE,YAwBxE;AAED,wBAAgB,eAAe,CAAC,WAAW,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,OAAO,WAYrE"}

package/dist/utils.js

@@ -53,6 +53,8 @@ exports.mergeFilterItems = mergeFilterItems;
 exports.initViewColumns = initViewColumns;
 exports.shouldMemoUpdate = shouldMemoUpdate;
 exports.formatFileSize = formatFileSize;
+exports.getFieldsFromFieldsLayout = getFieldsFromFieldsLayout;
+exports.isFieldRequired = isFieldRequired;
 const dayjs_1 = __importDefault(require("dayjs"));
 const Yup = __importStar(require("yup"));
 const string_mask_1 = __importDefault(require("string-mask"));
@@ -100,7 +102,7 @@ const populateValues = ({ data, schema }) => {
         if (key === 'id' && (0, exports.isTmpId)(data[key])) {
             continue;
         }
-        if (!data[key]) {
+        if (!data[key] && data[key] !== false && data[key] !== 0) {
             values[key] = (0, exports.emptyByType)(field);
             continue;
         }
@@ -193,27 +195,28 @@ const getYupValidator = (type) => {
     }
     return yupFunc.transform((v) => (v === '' ? null : v)).nullable();
 };
-function buildGenericYupValidationSchema({ data, schema, many = false, skipFields = [], extraValidators, }) {
+function buildGenericYupValidationSchema({ data, schema, many = false, skipFields = [], extraValidators, uiFields, }) {
     const yupValidator = {};
     for (const entry of Object.entries(schema)) {
-        const [key, field] = entry;
-        if (!data || !(key in data) || key === 'id' || skipFields.includes(key)) {
+        const [field, fieldSchema] = entry;
+        if (!data || !(field in data) || field === 'id' || skipFields.includes(field)) {
             continue;
         }
         // OneToMany or ManyToMany:
-        if (field.type === 'field' && field.child) {
-            yupValidator[key] =
-                extraValidators && key in extraValidators
-                    ? extraValidators[key]
+        if (fieldSchema.type === 'field' && fieldSchema.child) {
+            yupValidator[field] =
+                extraValidators && field in extraValidators
+                    ? extraValidators[field]
                     : buildGenericYupValidationSchema({
-                        schema: field.child.children,
+                        schema: fieldSchema.child.children,
                         many: true,
-                        data: data[key],
+                        data: data[field],
+                        uiFields,
                     });
             continue;
         }
         // Nested Object:
-        if (field.type === 'nested object' && field.children) {
+        if (fieldSchema.type === 'nested object' && fieldSchema.children) {
             // yupValidator[key] = buildGenericYupValidationSchema({
             //     schema: field.children,
             //     many: false,
@@ -225,28 +228,28 @@ function buildGenericYupValidationSchema({ data, schema, many = false, skipField
             // }
             // continue;
         }
-        yupValidator[key] =
-            extraValidators && key in extraValidators
-                ? extraValidators[key]
-                : getYupValidator(field.type);
-        if (field.required || field.model_required) {
-            yupValidator[key] = yupValidator[key].required('Este campo é obrigatório');
+        yupValidator[field] =
+            extraValidators && field in extraValidators
+                ? extraValidators[field]
+                : getYupValidator(fieldSchema.type);
+        if (isFieldRequired(fieldSchema, (uiFields || []).includes(field))) {
+            yupValidator[field] = yupValidator[field].required('Este campo é obrigatório');
         }
-        if (field.max_length && field.type === 'string') {
-            yupValidator[key] = yupValidator[key].max(parseInt(field.max_length), `Este campo só pode ter no máximo ${field.max_length} caracteres`);
+        if (fieldSchema.max_length && fieldSchema.type === 'string') {
+            yupValidator[field] = yupValidator[field].max(parseInt(fieldSchema.max_length), `Este campo só pode ter no máximo ${fieldSchema.max_length} caracteres`);
         }
-        if (field.max_digits && field.type === 'decimal') {
-            const maxDigits = field.max_digits;
-            yupValidator[key] = yupValidator[key].test('len', `Este número pode ter no máximo ${maxDigits} dígitos`, (val) => {
+        if (fieldSchema.max_digits && fieldSchema.type === 'decimal') {
+            const maxDigits = fieldSchema.max_digits;
+            yupValidator[field] = yupValidator[field].test('len', `Este número pode ter no máximo ${maxDigits} dígitos`, (val) => {
                 if (!val) {
                     return true;
                 }
                 return val.toString().length <= maxDigits;
             });
         }
-        if (!field.read_only && field.validators_regex) {
-            for (const validator of field.validators_regex) {
-                yupValidator[key] = yupValidator[key].matches(validator.regex, validator.message);
+        if (!fieldSchema.read_only && fieldSchema.validators_regex) {
+            for (const validator of fieldSchema.validators_regex) {
+                yupValidator[field] = yupValidator[field].matches(validator.regex, validator.message);
             }
         }
     }
@@ -595,3 +598,39 @@ function formatFileSize(bytes) {
     });
     return `${formattedValue} ${units[i]}`;
 }
+function getFieldsFromFieldsLayout(fieldsLayout) {
+    const fields = [];
+    for (const section of fieldsLayout) {
+        if (!section.rows) {
+            continue;
+        }
+        for (const row of section.rows) {
+            if (typeof row === 'string') {
+                fields.push(row);
+                continue;
+            }
+            if (Array.isArray(row)) {
+                for (const field of row) {
+                    if (typeof field === 'string') {
+                        fields.push(field);
+                        continue;
+                    }
+                }
+                continue;
+            }
+        }
+    }
+    return fields;
+}
+function isFieldRequired(fieldSchema, isInForm) {
+    if (fieldSchema === null || fieldSchema === void 0 ? void 0 : fieldSchema.required) {
+        return true;
+    }
+    if (fieldSchema === null || fieldSchema === void 0 ? void 0 : fieldSchema.model_required) {
+        return true;
+    }
+    if ((fieldSchema === null || fieldSchema === void 0 ? void 0 : fieldSchema.ui_required) && (typeof isInForm === 'undefined' || isInForm === true)) {
+        return true;
+    }
+    return false;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drf-react-by-schema",
-  "version": "0.20.10",
+  "version": "0.21.1",
   "description": "Components and Tools for building a React App having Django Rest Framework (DRF) as server",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",