@beseif-solutions/prow-core 0.0.39 → 0.1.0

package/dist/entities/events.d.ts

@@ -26,8 +26,11 @@ type EventConfig = Pick<CoreConfig, `credentials` | `outputs`> & {
         outputs: string[];
     };
     sources?: string[];
+    fields?: Record<string, any>;
 };
-type CommonEvents<Config extends EventConfig = {}> = Common<Config> & {
+type CommonEvents<Config extends EventConfig = {
+    fields: Record<string, any>;
+}> = Common<Config> & {
     model: `event`;
     categorization: {
         department: string;
@@ -49,7 +52,9 @@ export type Request = {
     query: Record<string, string>;
     body: any;
 };
-export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Config> & {
+export type ImmediateTrigger<Config extends EventConfig = {
+    fields: Record<string, any>;
+}> = CommonEvents<Config> & {
     type: `trigger`;
     immediate: true;
     outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>];
@@ -57,7 +62,7 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         mount?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 link: string;
             };
             outputs: {
@@ -68,7 +73,7 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         unmount?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 link: string;
                 setup?: any;
             };
@@ -79,7 +84,7 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         challenge?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 link: string;
                 request: Request;
                 setup?: any;
@@ -92,7 +97,7 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         handle: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 request: Request;
                 setup?: any;
             };
@@ -104,7 +109,7 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         fire?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 link: string;
                 setup?: any;
             };
@@ -115,7 +120,7 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         poll?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 last_schedule?: string;
                 limit?: number;
             };
@@ -126,7 +131,9 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         }>;
     };
 };
-export type ScheduledTrigger<Config extends EventConfig = {}> = CommonEvents<Config> & {
+export type ScheduledTrigger<Config extends EventConfig = {
+    fields: Record<string, any>;
+}> = CommonEvents<Config> & {
     type: `trigger`;
     immediate: false;
     outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>];
@@ -134,7 +141,7 @@ export type ScheduledTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         poll: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 last_schedule?: string;
                 limit?: number;
             };
@@ -145,8 +152,12 @@ export type ScheduledTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         }>;
     };
 };
-export type Trigger<Config extends EventConfig = {}> = ImmediateTrigger<Config> | ScheduledTrigger<Config>;
-export type Action<Config extends EventConfig = {}> = CommonEvents<Config> & {
+export type Trigger<Config extends EventConfig = {
+    fields: Record<string, any>;
+}> = ImmediateTrigger<Config> | ScheduledTrigger<Config>;
+export type Action<Config extends EventConfig = {
+    fields: Record<string, any>;
+}> = CommonEvents<Config> & {
     type: `action`;
     inputs: [DefaultConnectableEvent<Config[`flags`][`inputs`][number]>, ...AdditionalConnectableEvent<Config[`flags`][`inputs`][number]>[]];
     outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>, ...(AdditionalConnectableEvent<Config[`flags`][`outputs`][number]> | ErrorConnectableEvent<Config[`flags`][`outputs`][number]>)[]];
@@ -154,7 +165,7 @@ export type Action<Config extends EventConfig = {}> = CommonEvents<Config> & {
         execute: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 flags: Partial<Record<Config[`flags`][`inputs`][number], true>>;
             };
             outputs: {
@@ -164,7 +175,9 @@ export type Action<Config extends EventConfig = {}> = CommonEvents<Config> & {
         }>;
     };
 };
-export type Event<Config extends EventConfig = {}> = Action<Config> | Trigger<Config>;
+export type Event<Config extends EventConfig = {
+    fields: Record<string, any>;
+}> = Action<Config> | Trigger<Config>;
 export declare const scheduledTriggerSchema: () => Joi.ObjectSchema<any>;
 export declare const immediateTriggerSchema: () => Joi.ObjectSchema<any>;
 export declare const triggerSchema: () => Joi.AlternativesSchema<any>;

package/dist/index.d.ts

@@ -4,7 +4,7 @@ export { Credentials, credentialsSchema, OAuthCredentials, oauthCredentialsSchem
 export { Action, actionOutputSchema, actionSchema, Event, eventSchema, ImmediateTrigger, immediateTriggerSchema, Request, ScheduledTrigger, scheduledTriggerSchema, Trigger, triggerOutputSchema, triggerSchema } from './entities/events';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
-export { extract, Field, fieldSchema, fieldsSchema, File, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
+export { alter, extract, Field, fieldSchema, fieldsSchema, File, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
 export { i18n, LocalizedField, LocalizedProperties, localizeFields, localizeGroup, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
 export { Properties } from './minified-utils/properties';
 export { Protocol } from './minified-utils/protocol';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Protocol = exports.Properties = exports.localizeProperties = exports.localizeOutputs = exports.localizeInputs = exports.localizeGroup = exports.localizeFields = exports.i18n = exports.validate = exports.fieldsSchema = exports.fieldSchema = exports.extract = exports.providerSchema = exports.triggerSchema = exports.triggerOutputSchema = exports.scheduledTriggerSchema = exports.immediateTriggerSchema = exports.eventSchema = exports.actionSchema = exports.actionOutputSchema = exports.staticCredentialsSchema = exports.sessionCredentialsSchema = exports.oauthCredentialsSchema = exports.credentialsSchema = exports.idSchema = exports.core = void 0;
+exports.Protocol = exports.Properties = exports.localizeProperties = exports.localizeOutputs = exports.localizeInputs = exports.localizeGroup = exports.localizeFields = exports.i18n = exports.validate = exports.fieldsSchema = exports.fieldSchema = exports.extract = exports.alter = exports.providerSchema = exports.triggerSchema = exports.triggerOutputSchema = exports.scheduledTriggerSchema = exports.immediateTriggerSchema = exports.eventSchema = exports.actionSchema = exports.actionOutputSchema = exports.staticCredentialsSchema = exports.sessionCredentialsSchema = exports.oauthCredentialsSchema = exports.credentialsSchema = exports.idSchema = exports.core = void 0;
 var core_1 = require("./core");
 Object.defineProperty(exports, "core", { enumerable: true, get: function () { return core_1.core; } });
 var commons_1 = require("./entities/commons");
@@ -21,6 +21,7 @@ Object.defineProperty(exports, "triggerSchema", { enumerable: true, get: functio
 var provider_1 = require("./entities/provider");
 Object.defineProperty(exports, "providerSchema", { enumerable: true, get: function () { return provider_1.providerSchema; } });
 var fields_1 = require("./minified-utils/fields");
+Object.defineProperty(exports, "alter", { enumerable: true, get: function () { return fields_1.alter; } });
 Object.defineProperty(exports, "extract", { enumerable: true, get: function () { return fields_1.extract; } });
 Object.defineProperty(exports, "fieldSchema", { enumerable: true, get: function () { return fields_1.fieldSchema; } });
 Object.defineProperty(exports, "fieldsSchema", { enumerable: true, get: function () { return fields_1.fieldsSchema; } });

package/dist/minified-utils/fields.d.ts

@@ -1,18 +1,16 @@
 import Joi from "joi";
-import { OneOf } from "./types";
 import { Where } from "./where";
 export type Condition = {
     condition: Where;
-} & OneOf<{
     overrides: Partial<Field>;
-    show: boolean;
-}>;
+};
 type Common = {
     key: string;
     altered_by?: Condition[];
     disabled?: boolean;
     required?: boolean;
     as_password?: boolean;
+    show?: boolean;
     show_label?: boolean;
 } & ({
     as_array?: false;
@@ -30,6 +28,7 @@ type Any = string | number | boolean | Any[] | {
 type AnyInputField<Extend = Record<never, never>> = {
     type: `any`;
     default?: Any | Any[];
+    allow_nullish?: boolean;
 } & (SelectField<Any, Extend> | {});
 type StringInputField<Extend = Record<never, never>> = {
     type: `string`;
@@ -127,6 +126,7 @@ export type ValidationResult<Extended = Record<string, never>> = {
     valid: boolean;
     fields: Field<Extended & ValidationExtended>[];
 };
+export declare const alter: (field: Field, relative: string, data: Record<string, any>) => Field<Record<never, never>>;
 export declare const validate: <I>(fields: Field<I>[], data: Record<string, any>, options?: {
     secure?: boolean;
     break?: boolean;

package/dist/minified-utils/fields.js

@@ -3,23 +3,23 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extract = exports.validate = exports.fieldsSchema = exports.fieldSchema = void 0;
+exports.extract = exports.validate = exports.alter = exports.fieldsSchema = exports.fieldSchema = void 0;
 const joi_1 = __importDefault(require("joi"));
 const lodash_1 = __importDefault(require("lodash"));
 const moment_timezone_1 = __importDefault(require("moment-timezone"));
 const context_1 = __importDefault(require("./context"));
 const where_1 = require("./where");
 const conditionSchema = () => joi_1.default.object({
-    condition: joi_1.default.object(),
-    overrides: joi_1.default.object(),
-    show: joi_1.default.bool(),
-}).xor(`overrides`, `show`);
+    condition: joi_1.default.object().required(),
+    overrides: joi_1.default.object().required(),
+});
 const commonFieldSchema = () => joi_1.default.object({
     key: joi_1.default.string().required(),
     altered_by: joi_1.default.array().items(conditionSchema()),
     disabled: joi_1.default.bool(),
     required: joi_1.default.bool(),
     as_password: joi_1.default.bool(),
+    show: joi_1.default.bool(),
     show_label: joi_1.default.bool().default(true),
     as_array: joi_1.default.bool(),
     array_min: joi_1.default.when(`as_array`, {
@@ -173,7 +173,7 @@ const fileReplacer = (field) => ({
         },
     ],
     default: field.default,
-    ...lodash_1.default.pick(field, [`altered_by`, `disabled`, `required`, `as_password`, `show_label`, `as_array`, `array_min`, `array_max`, `array_length`]),
+    ...lodash_1.default.pick(field, [`altered_by`, `disabled`, `required`, `as_password`, `show`, `show_label`, `as_array`, `array_min`, `array_max`, `array_length`]),
 });
 const fileInputFieldSchema = () => joi_1.default.object({
     default: defaultSchema(fileSchema()),
@@ -235,6 +235,9 @@ const getSimpleFieldSchema = (field) => {
     switch (field.type) {
         case `any`:
             typeSchema = anySchema();
+            if (field.allow_nullish) {
+                typeSchema = typeSchema.allow(null, ``, 0, undefined);
+            }
             break;
         case `boolean`:
             typeSchema = joi_1.default.bool();
@@ -366,10 +369,13 @@ const getObjectFieldSchema = (field, items) => {
     return getGeneralSchema(field, schema);
 };
 const getGeneralSchema = (field, schema) => {
+    if (field.required) {
+        schema = schema.required();
+    }
     if (field.disabled) {
         schema = schema.forbidden();
     }
-    return field.required ? schema.required() : schema;
+    return schema;
 };
 const convertPath = (parts) => parts.map((p, i) => typeof p === `string` ? (i === 0 ? p : `.${p}`) : `[${p}]`).join(``);
 const secure = async (field, validation) => field.as_password ? lodash_1.default.omit(validation, [`value`, `original`]) : validation;
@@ -389,9 +395,31 @@ const relative_condition = (condition, relative) => {
         throw e;
     }
 };
+const alter = (field, relative, data) => {
+    const cloned = lodash_1.default.cloneDeep(field);
+    for (const alteration of cloned.altered_by) {
+        const condition = relative_condition(alteration.condition, relative);
+        const matches = (0, where_1.where)(data, [condition]);
+        if (matches) {
+            lodash_1.default.assign(cloned, alteration.overrides);
+        }
+    }
+    return cloned;
+};
+exports.alter = alter;
 const recursive_schema = async (field, data, options) => {
     try {
-        const newField = field.type === `file` ? fileReplacer(field) : lodash_1.default.cloneDeep(field);
+        let newField = lodash_1.default.cloneDeep(field);
+        if (newField.altered_by?.length > 0) {
+            newField = (0, exports.alter)(newField, options.relative, data);
+            if (options.alter) {
+                delete newField.altered_by;
+            }
+        }
+        const alteredField = lodash_1.default.cloneDeep(newField);
+        if (newField.type === `file`) {
+            newField = fileReplacer(newField);
+        }
         const relativeKey = options.relative ?
             options.relative.endsWith(`]`) ?
                 options.array ? options.relative : `${options.relative}.${newField.key}`
@@ -405,7 +433,7 @@ const recursive_schema = async (field, data, options) => {
             const itemSchemas = [];
             if (lodash_1.default.isArray(resolved)) {
                 for (let i = 0; i < (resolved || []).length; i++) {
-                    const itemSchema = await recursive_schema(lodash_1.default.omit(newField, [`as_array`, `array_min`, `array_max`, `array_length`]), data, { relative: `${relativeKey}[${i}]`, array: true, context: options.context });
+                    const { schema: itemSchema } = await recursive_schema(lodash_1.default.omit(newField, [`as_array`, `array_min`, `array_max`, `array_length`]), data, { alter: false, relative: `${relativeKey}[${i}]`, array: true, context: options.context });
                     if (itemSchema) {
                         itemSchemas.push(itemSchema);
                     }
@@ -414,16 +442,17 @@ const recursive_schema = async (field, data, options) => {
             calculatedSchema = getArrayFieldSchema(newField, itemSchemas);
         }
         else if (newField.type === `dict` && newField.items) {
-            const itemSchemas = [];
+            const items = [];
             if (lodash_1.default.isObject(resolved)) {
                 for (const item of newField.items) {
-                    const itemSchema = await recursive_schema(item, data, { relative: relativeKey, context: options.context });
-                    if (itemSchema) {
-                        itemSchemas.push({ key: item.key, schema: itemSchema });
+                    const recursive = await recursive_schema(item, data, { alter: options.alter && true, relative: relativeKey, context: options.context });
+                    if (recursive) {
+                        items.push({ key: item.key, schema: recursive.schema, field: recursive.field });
                     }
                 }
             }
-            calculatedSchema = getObjectFieldSchema(newField, itemSchemas);
+            calculatedSchema = getObjectFieldSchema(newField, items);
+            newField.items = items.map((i) => i.field);
         }
         else {
             calculatedSchema = getSimpleFieldSchema(newField);
@@ -431,27 +460,14 @@ const recursive_schema = async (field, data, options) => {
         if (!calculatedSchema) {
             throw new Error(`Could not resolve schema for field ${newField.key}`);
         }
-        if (newField.altered_by?.length > 0) {
-            let hide = false;
-            for (const alteration of newField.altered_by) {
-                const condition = relative_condition(alteration.condition, options.relative);
-                const matches = (0, where_1.where)(data, [condition]);
-                if (matches) {
-                    if (`overrides` in alteration) {
-                        lodash_1.default.assign(newField, alteration.overrides);
-                    }
-                    else if (`show` in alteration) {
-                        hide = !alteration.show;
-                    }
-                }
-            }
-            delete newField.altered_by;
-            if (hide) {
-                lodash_1.default.unset(data, relativeKey);
-                return;
-            }
+        if (typeof newField.show === `boolean` && !newField.show) {
+            lodash_1.default.unset(data, relativeKey);
+            return;
         }
-        return calculatedSchema;
+        else if (newField.disabled) {
+            lodash_1.default.unset(data, relativeKey);
+        }
+        return { schema: calculatedSchema, field: field.type === `file` ? alteredField : newField };
     }
     catch (e) {
         throw e;
@@ -463,12 +479,15 @@ const validate_internal = async (fields, data, options) => {
         for (const field of fields) {
             const value = lodash_1.default.get(data, field.key, field.default);
             const cloned = lodash_1.default.cloneDeep(data);
-            const schema = await recursive_schema(field, cloned, { context: options.context });
+            const recursive = await recursive_schema(field, cloned, { alter: true, context: options.context });
+            if (!recursive) {
+                continue;
+            }
             const resolved = lodash_1.default.get(cloned, field.key, field.default);
             let validation;
             let error;
             try {
-                validation = await schema.validateAsync(resolved, { abortEarly: false });
+                validation = await recursive.schema.validateAsync(resolved, { abortEarly: false });
             }
             catch (e) {
                 error = e;
@@ -495,7 +514,7 @@ const validate_internal = async (fields, data, options) => {
             }
             response.valid && (response.valid = error ? false : true);
             response.fields.push({
-                ...field,
+                ...recursive.field,
                 ...options.secure ? await secure(field, extended) : extended,
             });
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beseif-solutions/prow-core",
-  "version": "0.0.39",
+  "version": "0.1.0",
   "description": "Prow core functionalities and classes",
   "main": "dist/index.js",
   "scripts": {

package/src/entities/events.ts

@@ -33,9 +33,10 @@ type EventConfig = Pick<CoreConfig, `credentials` | `outputs`> & {
     outputs: string[],
   },
   sources?: string[],
+  fields?: Record<string, any>,
 };
 
-type CommonEvents<Config extends EventConfig = {}> = Common<Config> & {
+type CommonEvents<Config extends EventConfig = { fields: Record<string, any> }> = Common<Config> & {
   model: `event`,
   categorization: {
     department: string,
@@ -59,75 +60,75 @@ export type Request = {
   body: any,
 };
 
-export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Config> & {
+export type ImmediateTrigger<Config extends EventConfig = { fields: Record<string, any> }> = CommonEvents<Config> & {
   type: `trigger`,
   immediate: true,
   outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>],
   functions: {
     mount?: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Record<string, any>, link: string },
+      inputs: { fields: Config[`fields`], link: string },
       outputs: { done: boolean, setup?: any },
     }>,
     unmount?: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Record<string, any>, link: string, setup?: any },
+      inputs: { fields: Config[`fields`], link: string, setup?: any },
       outputs: { done: boolean },
     }>,
     challenge?: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Record<string, any>, link: string, request: Request, setup?: any },
+      inputs: { fields: Config[`fields`], link: string, request: Request, setup?: any },
       outputs: { done: boolean, response?: any },
     }>,
     handle: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Record<string, any>, request: Request, setup?: any },
+      inputs: { fields: Config[`fields`], request: Request, setup?: any },
       outputs: { records: Config[`outputs`][], flags: Partial<Record<Config[`flags`][`outputs`][number], true>> },
     }>,
     fire?: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Record<string, any>, link: string, setup?: any },
+      inputs: { fields: Config[`fields`], link: string, setup?: any },
       outputs: { done: boolean },
     }>,
     poll?: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Record<string, any>, last_schedule?: string, limit?: number },
+      inputs: { fields: Config[`fields`], last_schedule?: string, limit?: number },
       outputs: { records: Config[`outputs`][], flags: Partial<Record<Config[`flags`][`outputs`][number], true>> },
     }>,
   },
 };
 
-export type ScheduledTrigger<Config extends EventConfig = {}> = CommonEvents<Config> & {
+export type ScheduledTrigger<Config extends EventConfig = { fields: Record<string, any> }> = CommonEvents<Config> & {
   type: `trigger`,
   immediate: false,
   outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>],
   functions: {
     poll: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Record<string, any>, last_schedule?: string, limit?: number },
+      inputs: { fields: Config[`fields`], last_schedule?: string, limit?: number },
       outputs: { records: Config[`outputs`][], flags: Partial<Record<Config[`flags`][`outputs`][number], true>> },
     }>,
   },
 };
 
-export type Trigger<Config extends EventConfig = {}> =
+export type Trigger<Config extends EventConfig = { fields: Record<string, any> }> =
   | ImmediateTrigger<Config>
   | ScheduledTrigger<Config>;
 
-export type Action<Config extends EventConfig = {}> = CommonEvents<Config> & {
+export type Action<Config extends EventConfig = { fields: Record<string, any> }> = CommonEvents<Config> & {
   type: `action`,
   inputs: [DefaultConnectableEvent<Config[`flags`][`inputs`][number]>, ...AdditionalConnectableEvent<Config[`flags`][`inputs`][number]>[]],
   outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>, ...(AdditionalConnectableEvent<Config[`flags`][`outputs`][number]> | ErrorConnectableEvent<Config[`flags`][`outputs`][number]>)[]],
   functions: {
     execute: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Record<string, any>, flags: Partial<Record<Config[`flags`][`inputs`][number], true>> },
+      inputs: { fields: Config[`fields`], flags: Partial<Record<Config[`flags`][`inputs`][number], true>> },
       outputs: { output: Config[`outputs`], flags: Partial<Record<Config[`flags`][`outputs`][number], true>> },
     }>,
   },
 };
 
-export type Event<Config extends EventConfig = {}> =
+export type Event<Config extends EventConfig = { fields: Record<string, any> }> =
   | Action<Config>
   | Trigger<Config>;
 

package/src/index.ts

@@ -4,7 +4,7 @@ export { Credentials, credentialsSchema, OAuthCredentials, oauthCredentialsSchem
 export { Action, actionOutputSchema, actionSchema, Event, eventSchema, ImmediateTrigger, immediateTriggerSchema, Request, ScheduledTrigger, scheduledTriggerSchema, Trigger, triggerOutputSchema, triggerSchema } from './entities/events';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
-export { extract, Field, fieldSchema, fieldsSchema, File, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
+export { alter, extract, Field, fieldSchema, fieldsSchema, File, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
 export { i18n, LocalizedField, LocalizedProperties, localizeFields, localizeGroup, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
 export { Properties } from './minified-utils/properties';
 export { Protocol } from './minified-utils/protocol';

package/src/minified-utils/fields.ts

@@ -2,15 +2,12 @@ import Joi, { DateSchema, NumberSchema, StringSchema } from "joi";
 import _ from "lodash";
 import moment from "moment-timezone";
 import context from "./context";
-import { OneOf } from "./types";
 import { where, Where } from "./where";
 
 export type Condition = {
   condition: Where,
-} & OneOf<{
   overrides: Partial<Field>,
-  show: boolean,
-}>;
+};
 
 type Common = {
   key: string,
@@ -18,6 +15,7 @@ type Common = {
   disabled?: boolean,
   required?: boolean,
   as_password?: boolean,
+  show?: boolean,
   show_label?: boolean,
 } & ({
   as_array?: false,
@@ -47,6 +45,7 @@ type Any = string | number | boolean | Any[] | { [key: string]: Any };
 type AnyInputField<Extend = Record<never, never>> = {
   type: `any`,
   default?: Any | Any[],
+  allow_nullish?: boolean, // allow null values
 } & (
     | SelectField<Any, Extend>
     | {}
@@ -181,10 +180,9 @@ type ValidationExtended = {
 
 const conditionSchema = () =>
   Joi.object({
-    condition: Joi.object(),
-    overrides: Joi.object(),
-    show: Joi.bool(),
-  }).xor(`overrides`, `show`);
+    condition: Joi.object().required(),
+    overrides: Joi.object().required(),
+  });
 
 const commonFieldSchema = () =>
   Joi.object({
@@ -193,6 +191,7 @@ const commonFieldSchema = () =>
     disabled: Joi.bool(),
     required: Joi.bool(),
     as_password: Joi.bool(),
+    show: Joi.bool(),
     show_label: Joi.bool().default(true),
     as_array: Joi.bool(),
     array_min: Joi.when(`as_array`, {
@@ -385,7 +384,7 @@ const fileReplacer = (field: Common & FileInputField): Field => ({
     },
   ],
   default: field.default,
-  ..._.pick(field, [`altered_by`, `disabled`, `required`, `as_password`, `show_label`, `as_array`, `array_min`, `array_max`, `array_length`]),
+  ..._.pick(field, [`altered_by`, `disabled`, `required`, `as_password`, `show`, `show_label`, `as_array`, `array_min`, `array_max`, `array_length`]),
 }) as Field;
 
 const fileInputFieldSchema = () =>
@@ -457,6 +456,8 @@ const getSimpleFieldSchema = (field: Field) => {
   switch (field.type) {
     case `any`:
       typeSchema = anySchema();
+      // allow null values for any type
+      if (field.allow_nullish) { typeSchema = typeSchema.allow(null, ``, 0, undefined); }
       break;
     case `boolean`:
       typeSchema = Joi.bool();
@@ -563,8 +564,9 @@ const getObjectFieldSchema = (field: Field, items: { key: string, schema: Joi.Sc
 };
 
 const getGeneralSchema = (field: Field, schema: Joi.Schema): Joi.Schema => {
+  if (field.required) { schema = schema.required(); }
   if (field.disabled) { schema = schema.forbidden(); }
-  return field.required ? schema.required() : schema;
+  return schema;
 };
 
 const convertPath = (parts: (string | number)[]): string =>
@@ -593,10 +595,33 @@ const relative_condition = (condition: Where, relative: string): typeof conditio
   } catch (e) { throw e; }
 };
 
-const recursive_schema = async (field: Field, data: Record<string, any>, options: { relative?: string, array?: boolean, context: Record<string, any> }): Promise<Joi.Schema> => {
+export const alter = (field: Field, relative: string, data: Record<string, any>) => {
+  const cloned = _.cloneDeep(field);
+  for (const alteration of cloned.altered_by) {
+    const condition = relative_condition(alteration.condition, relative);
+
+    const matches = where(data, [condition]);
+    if (matches) { _.assign(cloned, alteration.overrides); }
+  }
+  return cloned;
+};
+
+const recursive_schema = async (field: Field, data: Record<string, any>, options: { alter: boolean, relative?: string, array?: boolean, context: Record<string, any> }): Promise<{ schema: Joi.Schema, field: Field }> => {
   try {
+    let newField: Field = _.cloneDeep(field);
+
+    // alterations over already resolved data (previous fields)
+    if (newField.altered_by?.length > 0) {
+      newField = alter(newField, options.relative, data);
+
+      // remove altered_by only if it's not an array -> array alterations must be kept for front-end rendering
+      if (options.alter) { delete newField.altered_by; }
+    }
+
+    const alteredField: Field = _.cloneDeep(newField);
+
     // ÑAPA: if the field is a file, replace it
-    const newField = field.type === `file` ? fileReplacer(field) : _.cloneDeep(field);
+    if (newField.type === `file`) { newField = fileReplacer(newField); }
 
     const relativeKey = options.relative ?
       options.relative.endsWith(`]`) ?
@@ -613,61 +638,45 @@ const recursive_schema = async (field: Field, data: Record<string, any>, options
     // get schema for field with data
     let calculatedSchema: Joi.Schema;
     if (newField.as_array && resolved) {
-
       const itemSchemas: Joi.Schema[] = [];
       if (_.isArray(resolved)) {
         for (let i = 0; i < (resolved || []).length; i++) {
-          const itemSchema = await recursive_schema(
+          const { schema: itemSchema } = await recursive_schema(
             _.omit(newField, [`as_array`, `array_min`, `array_max`, `array_length`]) as Field,
-            data, { relative: `${relativeKey}[${i}]`, array: true, context: options.context });
+            data, { alter: false, relative: `${relativeKey}[${i}]`, array: true, context: options.context });
           if (itemSchema) { itemSchemas.push(itemSchema); }
         }
       }
 
       calculatedSchema = getArrayFieldSchema(newField, itemSchemas);
     } else if (newField.type === `dict` && newField.items) {
-      const itemSchemas: { key: string, schema: Joi.Schema }[] = [];
+      const items: { key: string, schema: Joi.Schema, field: Field }[] = [];
 
       if (_.isObject(resolved)) {
         for (const item of newField.items) {
-          const itemSchema = await recursive_schema(item, data, { relative: relativeKey, context: options.context });
-          if (itemSchema) { itemSchemas.push({ key: item.key, schema: itemSchema }); }
+          const recursive = await recursive_schema(item, data, { alter: options.alter && true, relative: relativeKey, context: options.context });
+          if (recursive) { items.push({ key: item.key, schema: recursive.schema, field: recursive.field }); }
         }
       }
 
-      calculatedSchema = getObjectFieldSchema(newField, itemSchemas);
+      calculatedSchema = getObjectFieldSchema(newField, items);
+      newField.items = items.map((i) => i.field);
     } else {
       calculatedSchema = getSimpleFieldSchema(newField);
     }
 
     if (!calculatedSchema) { throw new Error(`Could not resolve schema for field ${newField.key}`); }
 
-    // alterations over data
-    if (newField.altered_by?.length > 0) {
-      let hide = false;
-      for (const alteration of newField.altered_by) {
-        const condition = relative_condition(alteration.condition, options.relative);
-
-        const matches = where(data, [condition]);
-        if (matches) {
-          if (`overrides` in alteration) {
-            _.assign(newField, alteration.overrides);
-          } else if (`show` in alteration) {
-            hide = !alteration.show;
-          }
-        }
-      }
-
-      delete newField.altered_by;
-
-      if (hide) {
-        // if the field is hidden, we don't need to validate it
-        _.unset(data, relativeKey);
-        return;
-      }
+    if (typeof newField.show === `boolean` && !newField.show) {
+      // if the field is hidden, we don't need to validate it
+      _.unset(data, relativeKey);
+      return;
+    } else if (newField.disabled) {
+      // TODO: check this
+      _.unset(data, relativeKey);
     }
 
-    return calculatedSchema;
+    return { schema: calculatedSchema, field: field.type === `file` ? alteredField : newField };
   } catch (e) { throw e; }
 };
 
@@ -681,14 +690,15 @@ const validate_internal = async (fields: Field[], data: Record<string, any>, opt
 
       const cloned = _.cloneDeep(data);
 
-      const schema = await recursive_schema(field, cloned, { context: options.context });
+      const recursive = await recursive_schema(field, cloned, { alter: true, context: options.context });
+      if (!recursive) { continue; }
 
       const resolved = _.get(cloned, field.key, field.default);
 
       let validation: any;
       let error: any;
       try {
-        validation = await schema.validateAsync(resolved, { abortEarly: false });
+        validation = await recursive.schema.validateAsync(resolved, { abortEarly: false });
       } catch (e) { error = e; }
 
       let extended: ValidationExtended;
@@ -713,7 +723,7 @@ const validate_internal = async (fields: Field[], data: Record<string, any>, opt
 
       response.valid &&= error ? false : true;
       response.fields.push({
-        ...field as any,
+        ...recursive.field as any,
         ...options.secure ? await secure(field, extended) : extended,
       });
 

package/tsconfig.json

@@ -11,10 +11,9 @@
     "declaration": true
   },
   "include": [
-    "src/**/*.ts",
+    "src/**/*.ts"
   ],
   "exclude": [
-    "./test",
     "node_modules",
     "dist/**/*.js"
   ]