drf-react-by-schema 0.2.2 → 0.3.1

package/src/utils.ts

@@ -1,321 +0,0 @@
-import * as Yup from 'yup';
-import { GridActionsColDef, GridColDef } from '@mui/x-data-grid';
-
-export type Id = string | number;
-export type Item = Record<string, any>;
-export type SchemaType = Record<string, Field>;
-export interface Choice {
-    value: string | number,
-    display_name: string
-};
-type FieldChild = Record<string, SchemaType>;
-export interface Field {
-    type: string,
-    child?: FieldChild,
-    children?: SchemaType,
-    model_default?: any,
-    model_required?: boolean
-    choices?: Choice[],
-    max_length?: number | string,
-    label: string,
-    read_only?: boolean
-};
-interface GridBySchemaColDef extends GridColDef {
-    isIndexField?: boolean,
-    creatable?: boolean,
-    orderable?: boolean,
-    patternFormat?: string
-};
-interface GridActionsBySchemaColDef extends GridActionsColDef {
-    isIndexField?: boolean,
-    creatable?: boolean,
-    orderable?: boolean,
-    patternFormat?: string
-};
-export type GridEnrichedBySchemaColDef = GridBySchemaColDef | GridActionsBySchemaColDef;
-
-export const emptyByType: any = (field:Field, forDatabase:boolean = false) => {
-    if (field.model_default) {
-        return field.model_default;
-    }
-    switch (field.type) {
-    case 'nested object':
-        // emptyByType must be an empty object for the database, but must be null for the mui-autocomplete component. So I had to make this ugly hack here, when we're preparing to sendo to the database:
-        return forDatabase ? {} : null;
-    case 'field':
-        if (field.child) {
-            return [];
-        }
-        return (forDatabase)
-            ? undefined
-            : null;
-    case 'string':
-    case 'email':
-        return '';
-    case 'integer':
-        return 0;
-    case 'array':
-        return [];
-    default:
-        return null;
-    }
-};
-
-export const getChoiceByValue = (
-    value:number | string,
-    choices:Choice[] | undefined
-) => {
-    if (!choices) {
-        return null;
-    }
-    for (const choice of choices) {
-        if (choice.value === value) {
-            return choice.display_name;
-        }
-    }
-};
-
-export const populateValues = ({
-    model,
-    data,
-    schema
-}: {
-    model:string,
-    data:Item,
-    schema:SchemaType
-}) => {
-    const values:Record<string, any> = {};
-    for (const entry of Object.entries(schema)) {
-        const [key, field] = entry;
-        if (key === 'id' && isTmpId(data[key])) {
-            continue;
-        }
-
-        if (!data[key]) {
-            values[key] = emptyByType(field);
-            continue;
-        }
-
-        if (field.type === 'field' && field.child) {
-            if (Array.isArray(data[key])) {
-                const arValues = [];
-                for (const row of data[key]) {
-                    const value = populateValues({
-                        model,
-                        data: row,
-                        schema: field.child.children
-                    });
-                    arValues.push(value);
-                }
-                values[key] = arValues;
-                continue;
-            }
-
-            values[key] = populateValues({
-                model,
-                data: data[key],
-                schema: field.child.children
-            });
-            continue;
-        }
-
-        if (field.type === 'choice') {
-            values[key] = data[key]
-                ? {
-                    value: data[key],
-                    display_name: getChoiceByValue(data[key], field.choices)
-                }
-                : emptyByType(field);
-            continue;
-        }
-
-        values[key] = data[key];
-    }
-    // console.log(values);
-    return values;
-};
-
-const getYupValidator = (type:string) => {
-    let yupFunc;
-    try {
-        switch (type) {
-        case 'slug':
-            yupFunc = Yup.string();
-            break;
-        case 'email':
-            yupFunc = Yup.string().email('Este campo deve ser um e-mail válido.');
-            break;
-        case 'integer':
-            yupFunc = Yup.number().integer('Este campo deve ser um número inteiro');
-            break;
-        case 'choice':
-            yupFunc = Yup.object();
-            break;
-        case 'field':
-            yupFunc = Yup.mixed();
-            break;
-        case 'nested object':
-            yupFunc = Yup.object();
-            break;
-        case 'date':
-            yupFunc = Yup.date();
-            break;
-        case 'string':
-            yupFunc = Yup.string();
-            break;
-        case 'number':
-            yupFunc = Yup.number();
-            break;
-        case 'boolean':
-            yupFunc = Yup.boolean();
-            break;
-        case 'array':
-            yupFunc = Yup.array();
-            break;
-        case 'object':
-            yupFunc = Yup.object();
-            break;
-        default:
-            yupFunc = Yup.string();
-            break;
-        }
-    } catch (e) {
-        yupFunc = Yup.string();
-    }
-    return yupFunc.nullable();
-};
-
-export const buildGenericYupValidationSchema = ({
-    data,
-    schema,
-    many = false,
-    skipFields = [],
-    extraValidators = {}
-}:{
-    data:Item,
-    schema:SchemaType,
-    many?:boolean,
-    skipFields?: string[],
-    extraValidators?:Item
-}) => {
-    const yupValidator:Record<string, any> = {};
-    for (const entry of Object.entries(schema)) {
-        const [key, field] = entry;
-
-        if (!data || !(key in data) || key === 'id' || skipFields.includes(key)) {
-            continue;
-        }
-
-        // console.log({ key, field, data: data[key] });
-
-        // OneToMany or ManyToMany:
-        if (field.type === 'field' && field.child) {
-            yupValidator[key] = buildGenericYupValidationSchema({
-                schema: field.child.children,
-                many: true,
-                data: data[key],
-                extraValidators: Object.prototype.hasOwnProperty.call(extraValidators, key)
-                    ? extraValidators[key]
-                    : {}
-            });
-            continue;
-        }
-
-        // Nested Object:
-        if (field.type === 'nested object' && field.children) {
-            // yupValidator[key] = buildGenericYupValidationSchema({
-            //     schema: field.children,
-            //     many: false,
-            //     data: data[key],
-            //     extraValidators: Object.prototype.hasOwnProperty.call(extraValidators, key)
-            //         ? extraValidators[key]
-            //         : {}
-            // });
-            // if (!field.model_required) {
-            //     yupValidator[key] = yupValidator[key].nullable();
-            // }
-            // continue;
-        }
-
-        yupValidator[key] = Object.prototype.hasOwnProperty.call(extraValidators, key)
-            ? extraValidators[key]
-            : getYupValidator(field.type);
-
-        if (field.model_required) {
-            yupValidator[key] = yupValidator[key].required('Este campo é obrigatório');
-        }
-        if (field.max_length) {
-            yupValidator[key] = yupValidator[key].max(parseInt(field.max_length as string), `Este campo só pode ter no máximo ${field.max_length} caracteres`);
-        }
-    }
-    // console.log({ yupValidator });
-    return (many)
-        ? Yup.array().of(Yup.object().shape(yupValidator))
-        : Yup.object().shape(yupValidator);
-};
-
-export const errorProps = ({
-    type,
-    errors,
-    fieldKey,
-    fieldKeyProp,
-    index
-}: {
-    type:string,
-    errors:Item,
-    fieldKey:string,
-    fieldKeyProp:string,
-    index?:number
-}) => {
-    let error;
-    let helperText;
-    if (index) {
-        const hasErrors = errors && errors[fieldKey] && errors[fieldKey][index] && Boolean(errors[fieldKey][index][fieldKeyProp]);
-        error = hasErrors;
-        helperText = hasErrors ? errors[fieldKey][index][fieldKeyProp].message : null;
-        return { error, helperText };
-    }
-
-    const hasErrors = errors && errors[fieldKey] && Boolean(errors[fieldKey][fieldKeyProp]);
-    error = hasErrors;
-    helperText = hasErrors ? errors[fieldKey][fieldKeyProp].message : null;
-    return { error, helperText };
-};
-
-export const getTmpId = () => {
-    return 'tmp' + Math.floor(Math.random() * 1000000);
-};
-
-export const isTmpId = (id:string | number | undefined | null) => {
-    if (!id) {
-        return true;
-    }
-    return id.toString().substr(0, 3) === 'tmp';
-};
-
-export const reducer = (state:Record<string, any>, newState:Record<string, any>) => {
-    return { ...state, ...newState };
-};
-
-export const getPatternFormat = (type:string) => {
-    let format = '';
-    switch (type) {
-    case 'telefone':
-    case 'fone':
-    case 'phone':
-    case 'contact':
-    case 'contato':
-        format = '(##)#####-####';
-        break;
-    case 'cpf':
-        format = '###.###.###-##';
-        break;
-    case 'cnpj':
-        format = '##.###.###/####-##';
-        break;
-    case 'cep':
-        format = '##.###-###';
-        break;
-    }
-    return format;
-};

package/styleguide.config.js

@@ -1,13 +0,0 @@
-const path = require('path');
-const glob = require('glob');
-
-module.exports = {
-  title: 'Styleguides for DRF React By Schema Package',
-  styleguideDir: 'public',
-  components: [
-    'src/components/*.tsx',
-    'src/context/*.tsx'
-  ],
-  resolver: require('react-docgen').resolver.findAllComponentDefinitions,
-  propsParser: require('react-docgen-typescript').withDefaultConfig({ propFilter: { skipPropsWithoutDoc: false } }).parse
-};

package/tsconfig.json

@@ -1,104 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig to read more about this file */
-
-    /* Projects */
-    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
-    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
-    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
-    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
-    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
-    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
-
-    /* Language and Environment */
-    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
-    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
-    "jsx": "react",                                /* Specify what JSX code is generated. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
-    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
-    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
-    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
-
-    /* Modules */
-    "module": "commonjs",                                /* Specify what module code is generated. */
-    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
-    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
-    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
-    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
-    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
-    // "resolveJsonModule": true,                        /* Enable importing .json files. */
-    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
-
-    /* JavaScript Support */
-    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
-    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
-    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
-
-    /* Emit */
-    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
-    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
-    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
-    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    "outDir": "./dist",                             /* Specify an output folder for all emitted files. */
-    // "removeComments": true,                           /* Disable emitting comments. */
-    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
-    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
-    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
-    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
-    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
-    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
-    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
-    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
-    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
-    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
-    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
-    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
-    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
-
-    /* Interop Constraints */
-    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
-    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
-    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
-    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
-
-    /* Type Checking */
-    "strict": true,                                      /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
-    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
-    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
-    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
-    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
-    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
-    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
-    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
-    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
-    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
-    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
-    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
-    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
-    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
-    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
-    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
-    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
-
-    /* Completeness */
-    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
-  },
-  "include": ["src/**/*"]
-}

package/webpack.config.js

@@ -1,24 +0,0 @@
-var path = require('path');
-
-module.exports = {
-  entry: {
-      bundle: ['./src/index.ts'],
-  },
-  context: path.resolve(__dirname),
-  output: {
-    filename: 'bundle.js',
-    path: path.join(__dirname, 'temp')
-  },
-  module: {
-    rules: [
-      {
-        test: /\.tsx?$/,
-        loader: 'ts-loader',
-        exclude: /node_modules/,
-      }
-    ]
-  },
-  resolve: {
-    extensions: [".tsx", ".ts", ".js"]
-  }
-};