@beseif-solutions/prow-core 1.5.0 → 1.6.0

package/dist/entities/commons.d.ts

@@ -3,7 +3,7 @@ import { Core } from "../core";
 export type CoreConfig = {
     inputs?: Record<string, any>;
     credentials?: Record<string, any>;
-    outputs?: any;
+    outputs?: Record<string, any> | any[];
 };
 type Configuration<Config extends CoreConfig> = ({
     sandbox: boolean;

package/dist/entities/events.d.ts

@@ -48,7 +48,10 @@ type CommonEvents<Config extends EventConfig> = Common<Config> & {
     credentials: string[];
     sandbox: boolean;
     fields: Field[];
-    examples: Config[`outputs`][];
+    examples: {
+        data: Config[`outputs`];
+        flags: Partial<Record<Config[`flags`][`outputs`][number], true>>;
+    }[];
     sources?: SourceConnection<Config[`sources`][number]>[];
 };
 export type Request = {
@@ -209,7 +212,7 @@ export type DebounceableImmediateTrigger<Config extends SetupEventConfig> = Comm
             };
             outputs: {
                 done: boolean;
-                response?: any;
+                response: string;
             };
         }>;
         handle: CoreFunction<{

package/dist/entities/events.js

@@ -33,7 +33,12 @@ const commonEventsSchema = () => joi_1.default.object({
     credentials: joi_1.default.array().items((0, commons_1.idSchema)().optional()).required().min(0),
     sandbox: joi_1.default.bool().required(),
     fields: (0, validation_1.fieldsSchema)().required(),
-    examples: joi_1.default.array(),
+    examples: joi_1.default.array().items(joi_1.default.object({
+        data: joi_1.default.alternatives(joi_1.default.array(), joi_1.default.object()).required(),
+        flags: joi_1.default.object()
+            .pattern(joi_1.default.string(), joi_1.default.valid(true))
+            .required(),
+    })),
     sources: joi_1.default.array().items(joi_1.default.object({
         role: joi_1.default.valid(`subscriber`, `consumer`).required(),
         id: (0, commons_1.idSchema)(),

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { Core, core, SourceFunctions, StorageFunctions } from './core';
 export { CoreFunction, idSchema } from './entities/commons';
 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 { Action, actionOutputSchema, actionSchema, AsyncAction, Event, eventSchema, ImmediateTrigger, DebounceableImmediateTrigger, immediateTriggerSchema, Request, ScheduledTrigger, scheduledTriggerSchema, SyncAction, syncActionSchema, Trigger, triggerOutputSchema, triggerSchema } from './entities/events';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
 export { getPath, hasExpression, isDynamic, isExpression, split } from './minified-utils/context';

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

@@ -6,12 +6,16 @@ export type Condition = {
 export type CommonField = {
     key: string;
     altered_by?: Condition[];
-    disabled?: boolean;
-    required?: boolean;
     as_password?: boolean;
+    disabled?: boolean;
     show?: boolean;
     t?: string;
 } & ({
+    required: true;
+} | {
+    required?: false;
+    additional?: boolean;
+}) & ({
     as_array?: false;
 } | {
     as_array: true;

package/dist/minified-utils/validation.js

@@ -16,10 +16,15 @@ const conditionSchema = () => joi_1.default.object({
 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(),
+    required: joi_1.default.bool(),
+    disabled: joi_1.default.bool(),
     show: joi_1.default.bool(),
+    additional: joi_1.default.when(`required`, {
+        is: false,
+        then: joi_1.default.bool(),
+        otherwise: joi_1.default.forbidden(),
+    }),
     t: joi_1.default.string(),
     as_array: joi_1.default.bool(),
     array_min: joi_1.default.when(`as_array`, {

package/package.json

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

package/src/entities/commons.ts

@@ -4,7 +4,7 @@ import { Core } from "../core";
 export type CoreConfig = {
   inputs?: Record<string, any>,
   credentials?: Record<string, any>,
-  outputs?: any,
+  outputs?: Record<string, any> | any[],
 };
 
 type Configuration<Config extends CoreConfig> = ({

package/src/entities/events.ts

@@ -59,7 +59,10 @@ type CommonEvents<Config extends EventConfig> = Common<Config> & {
   credentials: string[],
   sandbox: boolean,
   fields: Field[],
-  examples: Config[`outputs`][],
+  examples: {
+    data: Config[`outputs`],
+    flags: Partial<Record<Config[`flags`][`outputs`][number], true>>,
+  }[],
   sources?: SourceConnection<Config[`sources`][number]>[],
 };
 
@@ -147,7 +150,7 @@ export type DebounceableImmediateTrigger<Config extends SetupEventConfig> = Comm
     debounce: CoreFunction<{
       credentials: Config[`credentials`],
       inputs: { fields: Config[`fields`], request: Request, setup?: Config[`setup`] },
-      outputs: { done: boolean, response?: any },
+      outputs: { done: boolean, response: string },
     }>,
     handle: CoreFunction<{
       credentials: Config[`credentials`],
@@ -274,7 +277,15 @@ const commonEventsSchema = () =>
     credentials: Joi.array().items(idSchema().optional()).required().min(0),
     sandbox: Joi.bool().required(),
     fields: fieldsSchema().required(),
-    examples: Joi.array(),
+    examples: Joi.array().items(Joi.object({
+      data: Joi.alternatives(
+        Joi.array(),
+        Joi.object(),
+      ).required(),
+      flags: Joi.object()
+        .pattern(Joi.string(), Joi.valid(true))
+        .required(),
+    })),
     sources: Joi.array().items(
       Joi.object({
         role: Joi.valid(`subscriber`, `consumer`).required(),

package/src/index.ts

@@ -1,7 +1,7 @@
 export { Core, core, SourceFunctions, StorageFunctions } from './core';
 export { CoreFunction, idSchema } from './entities/commons';
 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 { Action, actionOutputSchema, actionSchema, AsyncAction, Event, eventSchema, ImmediateTrigger, DebounceableImmediateTrigger, immediateTriggerSchema, Request, ScheduledTrigger, scheduledTriggerSchema, SyncAction, syncActionSchema, Trigger, triggerOutputSchema, triggerSchema } from './entities/events';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
 export { getPath, hasExpression, isDynamic, isExpression, split } from './minified-utils/context';

package/src/minified-utils/fields.ts

@@ -8,19 +8,21 @@ export type Condition = {
 export type CommonField = {
   key: string,
   altered_by?: Condition[],
-  disabled?: boolean,
-  required?: boolean,
   as_password?: boolean,
+  disabled?: boolean,
   show?: boolean,
   t?: string,
-} & ({
-  as_array?: false,
-} | {
-  as_array: true,
-  array_min?: number,
-  array_max?: number,
-  array_length?: number,
-})
+} & (
+    | { required: true }
+    | { required?: false, additional?: boolean }
+  ) & ({
+    as_array?: false,
+  } | {
+    as_array: true,
+    array_min?: number,
+    array_max?: number,
+    array_length?: number,
+  })
   // experimental properties for custom front features
   & Record<`experimental_${string}`, any>
   ;

package/src/minified-utils/validation.ts

@@ -29,10 +29,15 @@ const commonFieldSchema = () =>
   Joi.object({
     key: Joi.string().required(),
     altered_by: Joi.array().items(conditionSchema()),
-    disabled: Joi.bool(),
-    required: Joi.bool(),
     as_password: Joi.bool(),
+    required: Joi.bool(),
+    disabled: Joi.bool(),
     show: Joi.bool(),
+    additional: Joi.when(`required`, {
+      is: false,
+      then: Joi.bool(),
+      otherwise: Joi.forbidden(),
+    }),
     t: Joi.string(),
     as_array: Joi.bool(),
     array_min: Joi.when(`as_array`, {