@beseif-solutions/prow-core 0.2.8 → 0.3.1

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?: Record<string, any>;
+    outputs?: any;
 };
 export type CoreFunction<Config extends CoreConfig = {}> = (core: Core, configuration: ({
     sandbox: boolean;

package/dist/entities/events.d.ts

@@ -1,7 +1,7 @@
 import Joi from "joi";
 import { Field } from "../minified-utils/fields";
 import { Common, CoreConfig, CoreFunction } from "./commons";
-import { OneOrArray } from "../minified-utils/types";
+import { ObjectOrArray } from "../minified-utils/types";
 type CommonConnectableEvent<Keys extends string = string> = {
     key: Keys;
 };
@@ -35,9 +35,7 @@ type SetupEventConfig = EventConfig & {
 type MemoryEventConfig = EventConfig & {
     memory?: Record<string, any>;
 };
-type CommonEvents<Config extends EventConfig = {
-    fields: Record<string, any>;
-}> = Common<Config> & {
+type CommonEvents<Config extends EventConfig> = Common<Config> & {
     model: `event`;
     categorization: {
         department: string;
@@ -59,10 +57,7 @@ export type Request = {
     query: Record<string, any>;
     body: any;
 };
-export type ImmediateTrigger<Config extends SetupEventConfig = {
-    fields: Record<string, any>;
-    setup: Record<string, any>;
-}> = CommonEvents<Config> & {
+export type ImmediateTrigger<Config extends SetupEventConfig> = CommonEvents<Config> & {
     type: `trigger`;
     immediate: true;
     outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>];
@@ -139,9 +134,7 @@ export type ImmediateTrigger<Config extends SetupEventConfig = {
         }>;
     };
 };
-export type ScheduledTrigger<Config extends EventConfig = {
-    fields: Record<string, any>;
-}> = CommonEvents<Config> & {
+export type ScheduledTrigger<Config extends EventConfig> = CommonEvents<Config> & {
     type: `trigger`;
     immediate: false;
     outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>];
@@ -160,22 +153,15 @@ export type ScheduledTrigger<Config extends EventConfig = {
         }>;
     };
 };
-export type Trigger<Config extends EventConfig = {
-    fields: Record<string, any>;
-}> = ImmediateTrigger<Config> | ScheduledTrigger<Config>;
+export type Trigger<Config extends EventConfig = {}> = ImmediateTrigger<Config> | ScheduledTrigger<Config>;
 type StandardOutput<Config extends EventConfig> = {
-    output: OneOrArray<Config[`outputs`]>;
+    output: ObjectOrArray<Config[`outputs`]>;
     flags: Partial<Record<Config[`flags`][`outputs`][number], true>>;
 };
-type MemoryOutput<Config extends MemoryEventConfig = {
-    memory: Record<string, any>;
-}> = {
+type MemoryOutput<Config extends MemoryEventConfig> = {
     memory: Config[`memory`];
 } & (StandardOutput<Config> | {});
-export type SyncAction<Config extends MemoryEventConfig = {
-    fields: Record<string, any>;
-    memory: Record<string, any>;
-}> = CommonEvents<Config> & {
+export type SyncAction<Config extends MemoryEventConfig> = 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]>)[]];
@@ -191,10 +177,7 @@ export type SyncAction<Config extends MemoryEventConfig = {
         }>;
     };
 };
-export type AsyncAction<Config extends SetupEventConfig = {
-    fields: Record<string, any>;
-    setup: Record<string, any>;
-}> = CommonEvents<Config> & {
+export type AsyncAction<Config extends SetupEventConfig & MemoryEventConfig> = 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]>)[]];
@@ -229,9 +212,11 @@ export type AsyncAction<Config extends SetupEventConfig = {
                 flags: Partial<Record<Config[`flags`][`inputs`][number], true>>;
                 link: string;
                 setup?: Config[`setup`];
+                memory?: Config[`memory`];
             };
             outputs: {
                 done: boolean;
+                memory?: Config[`memory`];
             };
         }>;
         handle: CoreFunction<{
@@ -240,6 +225,7 @@ export type AsyncAction<Config extends SetupEventConfig = {
                 fields: Config[`fields`];
                 request: Request;
                 setup?: Config[`setup`];
+                memory?: Config[`memory`];
             };
             outputs: StandardOutput<Config>;
         }>;
@@ -249,6 +235,7 @@ export type AsyncAction<Config extends SetupEventConfig = {
                 fields: Config[`fields`];
                 link: string;
                 setup?: Config[`setup`];
+                memory?: Config[`memory`];
             };
             outputs: {
                 done: boolean;
@@ -256,12 +243,8 @@ export type AsyncAction<Config extends SetupEventConfig = {
         }>;
     };
 };
-export type Action<Config extends EventConfig = {
-    fields: Record<string, any>;
-}> = SyncAction<Config> | AsyncAction<Config>;
-export type Event<Config extends EventConfig = {
-    fields: Record<string, any>;
-}> = Action<Config> | Trigger<Config>;
+export type Action<Config extends EventConfig = {}> = SyncAction<Config> | AsyncAction<Config>;
+export type Event<Config extends EventConfig = {}> = 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/minified-utils/types.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beseif-solutions/prow-core",
-  "version": "0.2.8",
+  "version": "0.3.1",
   "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?: Record<string, any>,
+  outputs?: any,
 };
 
 export type CoreFunction<Config extends CoreConfig = {}> = (core: Core, configuration: ({

package/src/entities/events.ts

@@ -1,7 +1,7 @@
 import Joi from "joi";
 import { Field, fieldsSchema } from "../minified-utils/fields";
 import { Common, commonSchema, CoreConfig, CoreFunction, idSchema } from "./commons";
-import { OneOrArray } from "../minified-utils/types";
+import { ObjectOrArray } from "../minified-utils/types";
 
 type CommonConnectableEvent<Keys extends string = string> = {
   key: Keys,
@@ -45,7 +45,7 @@ type MemoryEventConfig = EventConfig & {
   memory?: Record<string, any>,
 };
 
-type CommonEvents<Config extends EventConfig = { fields: Record<string, any> }> = Common<Config> & {
+type CommonEvents<Config extends EventConfig> = Common<Config> & {
   model: `event`,
   categorization: {
     department: string,
@@ -69,7 +69,7 @@ export type Request = {
   body: any,
 };
 
-export type ImmediateTrigger<Config extends SetupEventConfig = { fields: Record<string, any>, setup: Record<string, any> }> = CommonEvents<Config> & {
+export type ImmediateTrigger<Config extends SetupEventConfig> = CommonEvents<Config> & {
   type: `trigger`,
   immediate: true,
   outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>],
@@ -107,7 +107,7 @@ export type ImmediateTrigger<Config extends SetupEventConfig = { fields: Record<
   },
 };
 
-export type ScheduledTrigger<Config extends EventConfig = { fields: Record<string, any> }> = CommonEvents<Config> & {
+export type ScheduledTrigger<Config extends EventConfig> = CommonEvents<Config> & {
   type: `trigger`,
   immediate: false,
   outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>],
@@ -120,18 +120,18 @@ export type ScheduledTrigger<Config extends EventConfig = { fields: Record<strin
   },
 };
 
-export type Trigger<Config extends EventConfig = { fields: Record<string, any> }> =
+export type Trigger<Config extends EventConfig = {}> =
   | ImmediateTrigger<Config>
   | ScheduledTrigger<Config>;
 
 type StandardOutput<Config extends EventConfig> =
-  { output: OneOrArray<Config[`outputs`]>, flags: Partial<Record<Config[`flags`][`outputs`][number], true>> };
+  { output: ObjectOrArray<Config[`outputs`]>, flags: Partial<Record<Config[`flags`][`outputs`][number], true>> };
 
-type MemoryOutput<Config extends MemoryEventConfig = { memory: Record<string, any> }> = {
+type MemoryOutput<Config extends MemoryEventConfig> = {
   memory: Config[`memory`],
 } & (StandardOutput<Config> | {});
 
-export type SyncAction<Config extends MemoryEventConfig = { fields: Record<string, any>, memory: Record<string, any> }> = CommonEvents<Config> & {
+export type SyncAction<Config extends MemoryEventConfig> = 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]>)[]],
@@ -144,7 +144,7 @@ export type SyncAction<Config extends MemoryEventConfig = { fields: Record<strin
   },
 };
 
-export type AsyncAction<Config extends SetupEventConfig = { fields: Record<string, any>, setup: Record<string, any> }> = CommonEvents<Config> & {
+export type AsyncAction<Config extends SetupEventConfig & MemoryEventConfig> = 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]>)[]],
@@ -162,26 +162,26 @@ export type AsyncAction<Config extends SetupEventConfig = { fields: Record<strin
     }>,
     execute: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], flags: Partial<Record<Config[`flags`][`inputs`][number], true>>, link: string, setup?: Config[`setup`] },
-      outputs: { done: boolean },
+      inputs: { fields: Config[`fields`], flags: Partial<Record<Config[`flags`][`inputs`][number], true>>, link: string, setup?: Config[`setup`], memory?: Config[`memory`] },
+      outputs: { done: boolean, memory?: Config[`memory`] },
     }>,
     handle: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], request: Request, setup?: Config[`setup`] },
+      inputs: { fields: Config[`fields`], request: Request, setup?: Config[`setup`], memory?: Config[`memory`] },
       outputs: StandardOutput<Config>,
     }>,
     fire?: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], link: string, setup?: Config[`setup`] },
+      inputs: { fields: Config[`fields`], link: string, setup?: Config[`setup`], memory?: Config[`memory`] },
       outputs: { done: boolean },
     }>,
   },
 };
-export type Action<Config extends EventConfig = { fields: Record<string, any> }> =
+export type Action<Config extends EventConfig = {}> =
   | SyncAction<Config>
   | AsyncAction<Config>;
 
-export type Event<Config extends EventConfig = { fields: Record<string, any> }> =
+export type Event<Config extends EventConfig = {}> =
   | Action<Config>
   | Trigger<Config>;
 

package/src/minified-utils/types.ts

@@ -17,4 +17,7 @@ export type AsyncReturnType<T extends (...args: any[]) => any> =
   T extends (...args: any[]) => infer U ? U :
   any;
 
-export type OneOrArray<T> = T | T[];
+export type ObjectOrArray<T> =
+  T extends any[] ? T
+  : T extends Record<string, any> ? T | T[]
+  : T[];