@beseif-solutions/prow-core 0.0.39 → 0.2.0

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>
     | {}
@@ -62,8 +61,8 @@ type StringInputField<Extend = Record<never, never>> = {
   pattern?: `email` | `uri`,
 } & (
     | SelectField<string, Extend>
-    | TextareaField
-    | RichTextField
+    | CustomDisplayTextField
+    | IDETextField
     | {}
   );
 
@@ -74,7 +73,7 @@ type NumberInputField<Extend = Record<never, never>> = {
   max?: number,
 } & (
     | { float: true, decimals?: number }
-    | { float: false }
+    | { float?: false }
   ) & (
     | SelectField<number, Extend>
     | {}
@@ -155,14 +154,14 @@ export type SelectFieldChoice<Values = string | number | boolean | File, Extend
   value: Values,
 } & Extend;
 
-/* textarea configuration */
-type TextareaField = {
-  format: `textarea`,
+/* custom display configuration */
+type CustomDisplayTextField = {
+  format: `textarea` | `rich-text` | `markdown`,
 };
 
-/* rich text configuration */
-type RichTextField = {
-  format: `rich-text`,
+type IDETextField = {
+  format: `code`,
+  language?: string, // language for code highlighting
 };
 
 type ValidationExtended = {
@@ -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`, {
@@ -275,12 +274,17 @@ const stringInputFieldSchema = () =>
   })
     .concat(
       Joi.object({
-        format: Joi.string().valid(`select`, `textarea`, `rich-text`),
+        format: Joi.string().valid(`select`, `textarea`, `rich-text`, `markdown`, `code`),
         choices: Joi.when(`format`, {
           is: `select`,
           then: choicesSchema(Joi.string()).required(),
           otherwise: Joi.forbidden(),
         }),
+        language: Joi.when(`format`, {
+          is: `code`,
+          then: Joi.string(),
+          otherwise: Joi.forbidden(),
+        }),
       })
     );
 
@@ -385,7 +389,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 +461,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();
@@ -506,11 +512,15 @@ const getSimpleFieldSchema = (field: Field) => {
       typeSchema = Joi.number();
       if (field.min) { typeSchema = (typeSchema as NumberSchema).min(field.min); }
       if (field.max) { typeSchema = (typeSchema as NumberSchema).max(field.max); }
-      if (field.float) {
-        typeSchema = (typeSchema as NumberSchema).precision(field.decimals || 2);
-      } else {
-        typeSchema = (typeSchema as NumberSchema).precision(0);
+      // don't check precision if float is not set
+      if (typeof field.float === `boolean`) {
+        if (field.float) {
+          typeSchema = (typeSchema as NumberSchema).precision(field.decimals || 2);
+        } else {
+          typeSchema = (typeSchema as NumberSchema).precision(0);
+        }
       }
+
       break;
     case `dict`:
       if (field.items) { throw new Error(`No simple field`); }
@@ -563,8 +573,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 +604,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 +647,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 +699,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 +732,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/src/minified-utils/protocol.ts

@@ -55,7 +55,7 @@ const commandSchema = Joi.alternatives(
 );
 
 const API_SOURCES = (provider: Provider, configuration: Protocol.SourcesConfiguration, context: { organization: string, workspace: number }): SourceFunctions => ({
-  register: async (source, data) => {
+  register: async (source, sandbox, data) => {
     try {
       const { data: [created] } = await axios.post(`/api/v1/sources`, {
         organization: context.organization,
@@ -63,6 +63,7 @@ const API_SOURCES = (provider: Provider, configuration: Protocol.SourcesConfigur
         provider: provider.id,
         version: provider.version,
         source: source,
+        sandbox: sandbox,
         data: data,
         created_date: moment().format(`YYYY-MM-DDTHH:mm:ssZ`),
       }, {
@@ -75,7 +76,7 @@ const API_SOURCES = (provider: Provider, configuration: Protocol.SourcesConfigur
       return { id: created.uuid };
     } catch (e) { throw e; }
   },
-  unregister: async (source, id) => {
+  unregister: async (source, sandbox, id) => {
     try {
       const { data: [get] } = await axios.post(`/api/v1/sources/list`, {
         organization: context.organization,
@@ -83,6 +84,7 @@ const API_SOURCES = (provider: Provider, configuration: Protocol.SourcesConfigur
         provider: provider.id,
         version: provider.version,
         source: source,
+        sandbox: sandbox,
         uuid: id,
       }, {
         baseURL: configuration.host,
@@ -100,7 +102,7 @@ const API_SOURCES = (provider: Provider, configuration: Protocol.SourcesConfigur
       });
     } catch (e) { throw e; }
   },
-  consume: async (source) => {
+  consume: async (source, sandbox) => {
     try {
       const { data: sources } = await axios.post(`/api/v1/sources/list`, {
         organization: context.organization,
@@ -108,6 +110,7 @@ const API_SOURCES = (provider: Provider, configuration: Protocol.SourcesConfigur
         provider: provider.id,
         version: provider.version,
         source: source,
+        sandbox: sandbox,
       }, {
         baseURL: configuration.host,
         headers: {

package/src/minified-utils/types.ts

@@ -15,4 +15,6 @@ export type DeepPartial<T extends Record<string, any>> = {
 export type AsyncReturnType<T extends (...args: any[]) => any> =
   T extends (...args: any[]) => Promise<infer U> ? U :
   T extends (...args: any[]) => infer U ? U :
-  any;
+  any;
+
+export type OneOrArray<T> = T | T[];

package/tsconfig.json

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