@beseif-solutions/prow-core 0.4.5 → 1.0.0

package/dist/entities/commons.d.ts

@@ -7,6 +7,7 @@ export type CoreConfig = {
 };
 type Configuration<Config extends CoreConfig> = ({
     sandbox: boolean;
+    context?: string;
     organization?: string;
 } & (Config[`inputs`] extends undefined ? {} : {
     inputs: Config[`inputs`];
@@ -19,7 +20,7 @@ type CommonConfig = Pick<CoreConfig, `credentials`> & {
 };
 export type Common<Config extends CommonConfig = {}> = {
     id: Config[`id`] extends string ? Config[`id`] : string;
-    helpers?: Record<string, CoreFunction<{
+    helpers: Record<string, CoreFunction<{
         credentials: Config[`credentials`];
         inputs: any;
         outputs: any;

package/dist/entities/commons.js

@@ -11,6 +11,7 @@ exports.idSchema = idSchema;
 const commonSchema = () => joi_1.default.object({
     id: (0, exports.idSchema)(),
     helpers: joi_1.default.object()
-        .pattern(joi_1.default.string(), joi_1.default.function()),
+        .pattern(joi_1.default.string(), joi_1.default.function())
+        .required(),
 });
 exports.commonSchema = commonSchema;

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 export { Core, core } from './core';
 export { CoreFunction, idSchema } from './entities/commons';
-export { Credentials, OAuthCredentials, SessionCredentials, StaticCredentials, credentialsSchema, oauthCredentialsSchema, sessionCredentialsSchema, staticCredentialsSchema } from './entities/credentials';
-export { Action, AsyncAction, Event, ImmediateTrigger, Request, ScheduledTrigger, SyncAction, Trigger, actionOutputSchema, actionSchema, eventSchema, immediateTriggerSchema, scheduledTriggerSchema, syncActionSchema, triggerOutputSchema, triggerSchema } from './entities/events';
+export { Credentials, credentialsSchema, OAuthCredentials, oauthCredentialsSchema, SessionCredentials, sessionCredentialsSchema, StaticCredentials, staticCredentialsSchema } from './entities/credentials';
+export { Action, actionOutputSchema, actionSchema, AsyncAction, Event, eventSchema, ImmediateTrigger, immediateTriggerSchema, Request, ScheduledTrigger, scheduledTriggerSchema, SyncAction, syncActionSchema, Trigger, triggerOutputSchema, triggerSchema } from './entities/events';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
-export { hasExpression, isExpression, split } from './minified-utils/context';
-export { Condition, Field, File, SelectFieldChoice, ValidationResult, alter, extract, fieldSchema, fieldsSchema, validate } from './minified-utils/fields';
-export { DEFAULT_LOCALE, LocalizedField, LocalizedProperties, i18n, localizeFields, localizeGroup, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
+export { getPath, hasExpression, isDynamic, isExpression, split } from './minified-utils/context';
+export { alter, Condition, extract, Field, fieldSchema, fieldsSchema, File, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
+export { DEFAULT_LOCALE, 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.DEFAULT_LOCALE = exports.validate = exports.fieldsSchema = exports.fieldSchema = exports.extract = exports.alter = exports.split = exports.isExpression = exports.hasExpression = exports.providerSchema = exports.triggerSchema = exports.triggerOutputSchema = exports.syncActionSchema = 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.DEFAULT_LOCALE = exports.validate = exports.fieldsSchema = exports.fieldSchema = exports.extract = exports.alter = exports.split = exports.isExpression = exports.isDynamic = exports.hasExpression = exports.getPath = exports.providerSchema = exports.triggerSchema = exports.triggerOutputSchema = exports.syncActionSchema = 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");
@@ -22,7 +22,9 @@ 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 context_1 = require("./minified-utils/context");
+Object.defineProperty(exports, "getPath", { enumerable: true, get: function () { return context_1.getPath; } });
 Object.defineProperty(exports, "hasExpression", { enumerable: true, get: function () { return context_1.hasExpression; } });
+Object.defineProperty(exports, "isDynamic", { enumerable: true, get: function () { return context_1.isDynamic; } });
 Object.defineProperty(exports, "isExpression", { enumerable: true, get: function () { return context_1.isExpression; } });
 Object.defineProperty(exports, "split", { enumerable: true, get: function () { return context_1.split; } });
 var fields_1 = require("./minified-utils/fields");

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

@@ -2,8 +2,17 @@ import { Field } from "./fields";
 export declare const isExpression: (value: any) => boolean;
 export declare const hasExpression: (value: any) => boolean;
 export declare const split: (value: string) => string[];
+export declare const getPath: (expression: string) => string;
+type Dynamic = {
+    array: any[];
+    mapping: Record<string, {
+        type: `property` | `literal`;
+        value: any;
+    }>;
+};
+export declare const isDynamic: (data: any, processed: boolean) => data is Dynamic;
 declare class Context {
-    readonly resolve: (field: Field, source: any, data: Record<string, any>) => any;
+    readonly resolve: (field: Field, source: any, data: Record<string, any>, depth?: number) => any;
 }
 declare const context: Context;
 export default context;

package/dist/minified-utils/context.js

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.split = exports.hasExpression = exports.isExpression = void 0;
+exports.isDynamic = exports.getPath = exports.split = exports.hasExpression = exports.isExpression = void 0;
 const lodash_1 = __importDefault(require("lodash"));
+const joi_1 = __importDefault(require("joi"));
 const IS_EXPRESSION_REGEX = /^{{2,3}[^}]+}{2,3}$/;
 const isExpression = (value) => typeof value === `string` ? IS_EXPRESSION_REGEX.test(value) : false;
 exports.isExpression = isExpression;
@@ -14,35 +15,45 @@ exports.hasExpression = hasExpression;
 const SPLIT_REGEX = /{{2,3}[^}]+}{2,3}|[^{}]+/g;
 const split = (value) => typeof value === `string` ? Array.from(value.match(SPLIT_REGEX) || []) : [];
 exports.split = split;
+const getPath = (expression) => expression.replace(/^{+/g, ``).replace(/}+$/g, ``);
+exports.getPath = getPath;
+const isDynamic = (data, processed) => {
+    const schema = joi_1.default.object({
+        array: (processed ? joi_1.default.array() : joi_1.default.string()).required(),
+        mapping: joi_1.default.object()
+            .pattern(joi_1.default.string(), joi_1.default.object({
+            type: joi_1.default.string().valid(`property`, `literal`).required(),
+            value: joi_1.default.any().allow(null, ``).required(),
+        })).required(),
+    });
+    const { error } = schema.validate(data);
+    return !error;
+};
+exports.isDynamic = isDynamic;
+const MAX_RESOLVE_DEPTH = 10;
 class Context {
     constructor() {
-        this.resolve = (field, source, data) => {
-            if (lodash_1.default.isNull(source) || lodash_1.default.isUndefined(source)) {
+        this.resolve = (field, source, data, depth = 0) => {
+            if (lodash_1.default.isNull(source) || lodash_1.default.isUndefined(source) || depth >= MAX_RESOLVE_DEPTH) {
                 return source;
             }
             let serialized = false;
             let unresolved;
-            if ((lodash_1.default.isObject(source) || lodash_1.default.isArray(source)) && field.type === `dict` && !field.items) {
+            const dynamicSource = (0, exports.isDynamic)(source, false);
+            if ((lodash_1.default.isObject(source) || lodash_1.default.isArray(source)) && field.type === `dict` && (!field.items || dynamicSource)) {
                 serialized = true;
                 unresolved = JSON.stringify(source);
             }
             else if (typeof source === `string`) {
                 unresolved = source;
             }
-            else {
-                return source;
-            }
             if (!unresolved || !(0, exports.hasExpression)(unresolved)) {
                 return source;
             }
             const clonedData = lodash_1.default.cloneDeep(data);
-            const parts = (0, exports.split)(unresolved);
             let resolved = unresolved;
-            for (const expression of parts) {
-                if (!(0, exports.isExpression)(expression)) {
-                    continue;
-                }
-                const path = expression.replace(/^{+/g, ``).replace(/}+$/g, ``);
+            if ((0, exports.isExpression)(unresolved)) {
+                const path = (0, exports.getPath)(unresolved);
                 if (lodash_1.default.has(clonedData, path)) {
                     const get = lodash_1.default.get(clonedData, path);
                     const shouldInfer = field.as_array && lodash_1.default.isArray(get)
@@ -52,25 +63,60 @@ class Context {
                         || field.type === `string` && typeof get === `string`
                         || field.type === `boolean` && typeof get === `boolean`
                         || field.type === `any`;
-                    if (unresolved === expression && shouldInfer) {
+                    if (shouldInfer) {
                         resolved = get;
-                        break;
                     }
                     else {
-                        if (serialized) {
-                            resolved = resolved.replace(`"${expression}"`, lodash_1.default.isObject(get) ? JSON.stringify(get) : `"${get}"`);
-                        }
-                        resolved = resolved.replace(expression, get);
+                        resolved = lodash_1.default.toString(get);
                     }
                 }
                 else {
-                    resolved = resolved.replace(expression, ``);
+                    resolved = ``;
+                }
+            }
+            else {
+                const parts = (0, exports.split)(unresolved);
+                for (const expression of parts) {
+                    if (!(0, exports.isExpression)(expression)) {
+                        continue;
+                    }
+                    const path = (0, exports.getPath)(expression);
+                    if (lodash_1.default.has(clonedData, path)) {
+                        const get = lodash_1.default.get(clonedData, path);
+                        if (serialized) {
+                            resolved = resolved.replace(`"${expression}"`, (lodash_1.default.isObject(get) || lodash_1.default.isString(get)) ? JSON.stringify(get) : get);
+                        }
+                        resolved = resolved.replace(expression, lodash_1.default.toString(get));
+                    }
+                    else {
+                        resolved = resolved.replace(expression, ``);
+                    }
                 }
             }
             const parsed = serialized ? JSON.parse(resolved) : resolved;
-            return (typeof resolved === `string` ? resolved : JSON.stringify(resolved)).includes(`{{`) ?
-                this.resolve(field, parsed, clonedData)
+            const response = (typeof resolved === `string` ? resolved : JSON.stringify(resolved)).includes(`{{`) ?
+                this.resolve(field, parsed, clonedData, depth + 1)
                 : parsed;
+            if (dynamicSource && (0, exports.isDynamic)(response, true)) {
+                const dynamic = [];
+                for (const i of response.array) {
+                    const item = {};
+                    for (const [key, map] of Object.entries(response.mapping)) {
+                        if (map.type === `property`) {
+                            const prop = lodash_1.default.get(i, map.value);
+                            if (typeof prop !== `undefined`) {
+                                item[key] = prop;
+                            }
+                        }
+                        else if (map.type === `literal`) {
+                            item[key] = map.value;
+                        }
+                    }
+                    dynamic.push(item);
+                }
+                return dynamic;
+            }
+            return response;
         };
     }
 }

package/package.json

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

package/src/entities/commons.ts

@@ -9,6 +9,7 @@ export type CoreConfig = {
 
 type Configuration<Config extends CoreConfig> = ({
   sandbox: boolean,
+  context?: string,
   organization?: string,
 } & (
     Config[`inputs`] extends undefined ?
@@ -30,7 +31,7 @@ type CommonConfig = Pick<CoreConfig, `credentials`> & { id?: string };
 
 export type Common<Config extends CommonConfig = {}> = {
   id: Config[`id`] extends string ? Config[`id`] : string,
-  helpers?: Record<string, CoreFunction<{ credentials: Config[`credentials`], inputs: any, outputs: any }>>,
+  helpers: Record<string, CoreFunction<{ credentials: Config[`credentials`], inputs: any, outputs: any }>>,
 };
 
 export const idSchema = () =>
@@ -41,5 +42,6 @@ export const commonSchema = () =>
   Joi.object({
     id: idSchema(),
     helpers: Joi.object()
-      .pattern(Joi.string(), Joi.function()),
+      .pattern(Joi.string(), Joi.function())
+      .required(),
   });

package/src/index.ts

@@ -1,11 +1,11 @@
 export { Core, core } from './core';
 export { CoreFunction, idSchema } from './entities/commons';
-export { Credentials, OAuthCredentials, SessionCredentials, StaticCredentials, credentialsSchema, oauthCredentialsSchema, sessionCredentialsSchema, staticCredentialsSchema } from './entities/credentials';
-export { Action, AsyncAction, Event, ImmediateTrigger, Request, ScheduledTrigger, SyncAction, Trigger, actionOutputSchema, actionSchema, eventSchema, immediateTriggerSchema, scheduledTriggerSchema, syncActionSchema, triggerOutputSchema, triggerSchema } from './entities/events';
+export { Credentials, credentialsSchema, OAuthCredentials, oauthCredentialsSchema, SessionCredentials, sessionCredentialsSchema, StaticCredentials, staticCredentialsSchema } from './entities/credentials';
+export { Action, actionOutputSchema, actionSchema, AsyncAction, Event, eventSchema, ImmediateTrigger, immediateTriggerSchema, Request, ScheduledTrigger, scheduledTriggerSchema, SyncAction, syncActionSchema, Trigger, triggerOutputSchema, triggerSchema } from './entities/events';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
-export { hasExpression, isExpression, split } from './minified-utils/context';
-export { Condition, Field, File, SelectFieldChoice, ValidationResult, alter, extract, fieldSchema, fieldsSchema, validate } from './minified-utils/fields';
-export { DEFAULT_LOCALE, LocalizedField, LocalizedProperties, i18n, localizeFields, localizeGroup, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
+export { getPath, hasExpression, isDynamic, isExpression, split } from './minified-utils/context';
+export { alter, Condition, extract, Field, fieldSchema, fieldsSchema, File, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
+export { DEFAULT_LOCALE, i18n, LocalizedField, LocalizedProperties, localizeFields, localizeGroup, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
 export { Properties } from './minified-utils/properties';
-export { Protocol } from './minified-utils/protocol';
+export { Protocol } from './minified-utils/protocol';

package/src/minified-utils/context.ts

@@ -1,5 +1,6 @@
 import _ from "lodash";
 import { Field } from "./fields";
+import Joi from "joi";
 
 const IS_EXPRESSION_REGEX = /^{{2,3}[^}]+}{2,3}$/;
 export const isExpression = (value: any) =>
@@ -13,35 +14,60 @@ const SPLIT_REGEX = /{{2,3}[^}]+}{2,3}|[^{}]+/g;
 export const split = (value: string) =>
   typeof value === `string` ? Array.from(value.match(SPLIT_REGEX) || []) : [];
 
+export const getPath = (expression: string) =>
+  expression.replace(/^{+/g, ``).replace(/}+$/g, ``);
+
+type Dynamic = {
+  array: any[],
+  mapping: Record<string, {
+    type: `property` | `literal`,
+    value: any,
+  }>,
+};
+
+export const isDynamic = (data: any, processed: boolean): data is Dynamic => {
+  const schema = Joi.object({
+    array: (processed ? Joi.array() : Joi.string()).required(),
+    mapping: Joi.object()
+      .pattern(Joi.string(), Joi.object({
+        type: Joi.string().valid(`property`, `literal`).required(),
+        value: Joi.any().allow(null, ``).required(),
+      })).required(),
+  });
+
+  const { error } = schema.validate(data);
+  return !error;
+};
+
+const MAX_RESOLVE_DEPTH = 10;
+
 class Context {
 
-  public readonly resolve = (field: Field, source: any, data: Record<string, any>) => {
-    if (_.isNull(source) || _.isUndefined(source)) { return source; }
+  public readonly resolve = (field: Field, source: any, data: Record<string, any>, depth = 0) => {
+    if (_.isNull(source) || _.isUndefined(source) || depth >= MAX_RESOLVE_DEPTH) { return source; }
 
     let serialized = false;
     let unresolved: string;
-    if ((_.isObject(source) || _.isArray(source)) && field.type === `dict` && !field.items) {
+
+    const dynamicSource = isDynamic(source, false);
+
+    if ((_.isObject(source) || _.isArray(source)) && field.type === `dict` && (!field.items || dynamicSource)) {
       serialized = true;
       unresolved = JSON.stringify(source);
     } else if (typeof source === `string`) {
       unresolved = source;
-    } else { return source; }
+    }
 
     if (!unresolved || !hasExpression(unresolved)) { return source; }
 
     const clonedData = _.cloneDeep(data);
 
-    const parts = split(unresolved);
-
     let resolved: any = unresolved;
-    for (const expression of parts) {
-      if (!isExpression(expression)) { continue; }
-
-      const path = expression.replace(/^{+/g, ``).replace(/}+$/g, ``);
-
+    if (isExpression(unresolved)) {
+      // full expression
+      const path = getPath(unresolved);
       if (_.has(clonedData, path)) {
         const get = _.get(clonedData, path);
-
         const shouldInfer =
           field.as_array && _.isArray(get)
           || field.type === `dict` && _.isObject(get)
@@ -51,23 +77,55 @@ class Context {
           || field.type === `boolean` && typeof get === `boolean`
           || field.type === `any`;
 
-        if (unresolved === expression && shouldInfer) {
+        if (shouldInfer) {
           resolved = get;
-          break;
         } else {
-          if (serialized) { resolved = resolved.replace(`"${expression}"`, _.isObject(get) ? JSON.stringify(get) : `"${get}"`); }
-          resolved = resolved.replace(expression, get);
-
+          resolved = _.toString(get);
         }
-      } else { resolved = resolved.replace(expression, ``); }
+      } else { resolved = ``; }
+    } else {
+      // partial expression
+      const parts = split(unresolved);
+      for (const expression of parts) {
+        if (!isExpression(expression)) { continue; }
+
+        const path = getPath(expression);
+        if (_.has(clonedData, path)) {
+          const get = _.get(clonedData, path);
+          if (serialized) { resolved = resolved.replace(`"${expression}"`, (_.isObject(get) || _.isString(get)) ? JSON.stringify(get) : get); }
+          resolved = resolved.replace(expression, _.toString(get));
+        } else { resolved = resolved.replace(expression, ``); }
+      }
     }
 
     const parsed = serialized ? JSON.parse(resolved) : resolved;
 
-    // recursive resolution
-    return (typeof resolved === `string` ? resolved : JSON.stringify(resolved)).includes(`{{`) ?
-      this.resolve(field, parsed, clonedData)
+    const response = (typeof resolved === `string` ? resolved : JSON.stringify(resolved)).includes(`{{`) ?
+      this.resolve(field, parsed, clonedData, depth + 1)
       : parsed;
+
+    // check dynamic arrays
+    if (dynamicSource && isDynamic(response, true)) {
+      const dynamic = [];
+      for (const i of response.array) {
+        const item: Record<string, any> = {};
+        for (const [key, map] of Object.entries(response.mapping)) {
+          if (map.type === `property`) {
+            const prop = _.get(i, map.value);
+            if (typeof prop !== `undefined`) { item[key] = prop; }
+          } else if (map.type === `literal`) {
+            item[key] = map.value;
+          }
+        }
+        dynamic.push(item);
+      }
+
+      return dynamic;
+    }
+
+
+    // recursive resolution
+    return response;
   };
 
 }