@beseif-solutions/prow-core 0.3.1 → 0.3.3

package/dist/core.d.ts

@@ -1,6 +1,6 @@
-import { AxiosStatic } from "axios";
+import { AxiosInstance } from "axios";
 import Joi from "joi";
-import { LoDashStatic } from "lodash";
+import lodash from "lodash";
 import moment from "moment-timezone";
 import { FromCatalog, FromDirectory, T } from "./minified-utils/locales";
 type SyncOrAsync<T> = T | Promise<T>;
@@ -15,9 +15,9 @@ export type SourceFunctions = {
     unregister: (source: string, sandbox: boolean, id: string) => SyncOrAsync<void>;
 };
 export type Core = {
-    axios: AxiosStatic;
+    axios: AxiosInstance;
     moment: typeof moment;
-    lodash: LoDashStatic;
+    lodash: lodash.LoDashStatic;
     env: Record<string, any>;
     joi: Joi.Root;
     sources?: SourceFunctions;
@@ -28,5 +28,5 @@ type CoreOptions = {
     sources?: SourceFunctions;
     localization: FromDirectory | FromCatalog;
 };
-export declare const core: (options: CoreOptions) => Core;
+export declare const core: (options: CoreOptions) => Promise<Core>;
 export {};

package/dist/core.js

@@ -20,8 +20,10 @@ const FALLBACK_SOURCES = {
         throw new Error(`Sources not available: valid implementation not provided`);
     },
 };
-const core = (options) => ({
-    axios: axios_1.default,
+const core = async (options) => ({
+    axios: axios_1.default.create({
+        adapter: axios_1.default.getAdapter(`http`),
+    }),
     moment: moment_timezone_1.default,
     lodash: lodash_1.default,
     env: options.env || {},

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

@@ -38,6 +38,7 @@ type StringInputField<Extend = Record<never, never>> = {
     max?: number;
     regexp?: string;
     pattern?: `email` | `uri`;
+    allow_empty?: boolean;
 } & (SelectField<string, Extend> | CustomDisplayTextField | IDETextField | {});
 type NumberInputField<Extend = Record<never, never>> = {
     type: `number`;

package/dist/minified-utils/fields.js

@@ -79,6 +79,7 @@ const stringInputFieldSchema = () => joi_1.default.object({
     max: joi_1.default.number(),
     regexp: joi_1.default.string(),
     pattern: joi_1.default.string().valid(`email`, `uri`),
+    allow_empty: joi_1.default.bool().default(false),
 })
     .concat(joi_1.default.object({
     format: joi_1.default.string().valid(`select`, `textarea`, `rich-text`, `markdown`, `code`),
@@ -164,6 +165,7 @@ const fileSchema = () => joi_1.default.object({
 const fileReplacer = (field) => ({
     key: field.key,
     type: `dict`,
+    unknown: true,
     items: [
         {
             key: `name`,
@@ -256,10 +258,10 @@ const getSimpleFieldSchema = (field) => {
             if (field.length) {
                 typeSchema = typeSchema.length(field.length);
             }
-            if (field.min) {
+            if (field.min > 0) {
                 typeSchema = typeSchema.min(field.min);
             }
-            else {
+            else if (field.allow_empty) {
                 typeSchema = typeSchema.allow(``);
             }
             if (field.max) {
@@ -454,7 +456,9 @@ const recursive_schema = async (field, data, options) => {
             : newField.key;
         const value = lodash_1.default.get(data, relativeKey, newField.default);
         const resolved = context_1.default.resolve(newField, value, options.context);
-        lodash_1.default.set(data, relativeKey, resolved);
+        if (typeof resolved !== `undefined`) {
+            lodash_1.default.set(data, relativeKey, resolved);
+        }
         let calculatedSchema;
         if (newField.as_array) {
             const noArrayField = lodash_1.default.omit(newField, [`as_array`, `array_min`, `array_max`, `array_length`]);
@@ -474,12 +478,10 @@ const recursive_schema = async (field, data, options) => {
                 let genericItemSchema;
                 if (noArrayField.type === `dict` && noArrayField.items) {
                     const items = [];
-                    if (lodash_1.default.isObject(resolved)) {
-                        for (const item of noArrayField.items) {
-                            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 });
-                            }
+                    for (const item of noArrayField.items) {
+                        const recursive = await recursive_schema(item, data, { alter: options.alter && true, relative: `${relativeKey}[0]`, context: options.context });
+                        if (recursive) {
+                            items.push({ key: item.key, schema: recursive.schema, field: recursive.field });
                         }
                     }
                     genericItemSchema = getObjectFieldSchema(noArrayField, items);
@@ -493,12 +495,10 @@ const recursive_schema = async (field, data, options) => {
         }
         else if (newField.type === `dict` && newField.items) {
             const items = [];
-            if (lodash_1.default.isObject(resolved)) {
-                for (const item of newField.items) {
-                    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 });
-                    }
+            for (const item of newField.items) {
+                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, items);

package/package.json

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

package/src/core.ts

@@ -1,6 +1,6 @@
-import axios, { AxiosStatic } from "axios";
+import axios, { AxiosInstance } from "axios";
 import Joi from "joi";
-import _, { LoDashStatic } from "lodash";
+import lodash from "lodash";
 import moment from "moment-timezone";
 import { FromCatalog, FromDirectory, i18n, T } from "./minified-utils/locales";
 
@@ -25,9 +25,9 @@ const FALLBACK_SOURCES: SourceFunctions = {
 };
 
 export type Core = {
-  axios: AxiosStatic,
+  axios: AxiosInstance,
   moment: typeof moment,
-  lodash: LoDashStatic,
+  lodash: lodash.LoDashStatic,
   env: Record<string, any>,
   joi: Joi.Root,
   sources?: SourceFunctions,
@@ -41,10 +41,13 @@ type CoreOptions = {
 };
 
 /* eslint-disable @typescript-eslint/unbound-method */
-export const core = (options: CoreOptions): Core => ({
-  axios: axios,
+export const core = async (options: CoreOptions): Promise<Core> => ({
+  // explicit adapter for NodeJS -> avoid DOM errors
+  axios: axios.create({
+    adapter: axios.getAdapter(`http`),
+  }),
   moment: moment,
-  lodash: _,
+  lodash: lodash,
   env: options.env || {},
   joi: Joi,
   sources: options.sources || FALLBACK_SOURCES,

package/src/minified-utils/fields.ts

@@ -59,6 +59,7 @@ type StringInputField<Extend = Record<never, never>> = {
   max?: number,
   regexp?: string,
   pattern?: `email` | `uri`,
+  allow_empty?: boolean,
 } & (
     | SelectField<string, Extend>
     | CustomDisplayTextField
@@ -275,6 +276,7 @@ const stringInputFieldSchema = () =>
     max: Joi.number(),
     regexp: Joi.string(),
     pattern: Joi.string().valid(`email`, `uri`),
+    allow_empty: Joi.bool().default(false),
   })
     .concat(
       Joi.object({
@@ -375,6 +377,7 @@ const fileSchema = () => Joi.object({
 const fileReplacer = (field: Common & FileInputField): Field => ({
   key: field.key,
   type: `dict`,
+  unknown: true,
   items: [
     {
       key: `name`,
@@ -474,9 +477,9 @@ const getSimpleFieldSchema = (field: Field) => {
     case `string`:
       typeSchema = Joi.string();
       if (field.length) { typeSchema = (typeSchema as StringSchema).length(field.length); }
-      if (field.min) {
+      if (field.min > 0) {
         typeSchema = (typeSchema as StringSchema).min(field.min);
-      } else {
+      } else if (field.allow_empty) {
         typeSchema = typeSchema.allow(``);
       }
       if (field.max) { typeSchema = (typeSchema as StringSchema).max(field.max); }
@@ -658,9 +661,9 @@ const recursive_schema = async (field: Field, data: Record<string, any>, options
 
     const value = _.get(data, relativeKey, newField.default);
 
-    // resolve value with context (even if it's not valid)
+    // resolve value with context (even if it's not valid - omit undefined)
     const resolved = context.resolve(newField, value, options.context);
-    _.set(data, relativeKey, resolved);
+    if (typeof resolved !== `undefined`) { _.set(data, relativeKey, resolved); }
 
     // get schema for field with data
     let calculatedSchema: Joi.Schema;
@@ -682,11 +685,9 @@ const recursive_schema = async (field: Field, data: Record<string, any>, options
         if (noArrayField.type === `dict` && noArrayField.items) {
           const items: { key: string, schema: Joi.Schema, field: Field }[] = [];
 
-          if (_.isObject(resolved)) {
-            for (const item of noArrayField.items) {
-              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 }); }
-            }
+          for (const item of noArrayField.items) {
+            const recursive = await recursive_schema(item, data, { alter: options.alter && true, relative: `${relativeKey}[0]`, context: options.context });
+            if (recursive) { items.push({ key: item.key, schema: recursive.schema, field: recursive.field }); }
           }
 
           genericItemSchema = getObjectFieldSchema(noArrayField, items);
@@ -700,11 +701,9 @@ const recursive_schema = async (field: Field, data: Record<string, any>, options
     } else if (newField.type === `dict` && newField.items) {
       const items: { key: string, schema: Joi.Schema, field: Field }[] = [];
 
-      if (_.isObject(resolved)) {
-        for (const item of newField.items) {
-          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 }); }
-        }
+      for (const item of newField.items) {
+        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, items);