@beseif-solutions/prow-core 0.3.7 → 0.3.9

package/dist/core.d.ts

@@ -20,7 +20,7 @@ export type Core = {
     lodash: lodash.LoDashStatic;
     env: Record<string, any>;
     joi: Joi.Root;
-    sources?: SourceFunctions;
+    sources: SourceFunctions;
     t: T;
 };
 type CoreOptions = {

package/dist/entities/commons.d.ts

@@ -5,14 +5,15 @@ export type CoreConfig = {
     credentials?: Record<string, any>;
     outputs?: any;
 };
-export type CoreFunction<Config extends CoreConfig = {}> = (core: Core, configuration: ({
+type Configuration<Config extends CoreConfig> = ({
     sandbox: boolean;
     organization?: string;
 } & (Config[`inputs`] extends undefined ? {} : {
     inputs: Config[`inputs`];
 }) & (Config[`credentials`] extends undefined ? {} : {
     credentials: Config[`credentials`];
-}))) => Promise<Config[`outputs`]> | Config[`outputs`];
+}));
+export type CoreFunction<Config extends CoreConfig = {}> = ((core: Core, configuration: Configuration<Config>) => Promise<Config[`outputs`]>) | ((core: Core, configuration: Configuration<Config>) => Config[`outputs`]);
 type CommonConfig = Pick<CoreConfig, `credentials`>;
 export type Common<Config extends CommonConfig = {}> = {
     id: string;

package/dist/entities/events.d.ts

@@ -58,6 +58,9 @@ export type Request = {
     body: Record<string, any>;
     raw: string;
 };
+type SourcePreferences<Config extends EventConfig> = Config[`sources`] extends string[] ? {
+    sources: Record<Config[`sources`][number], boolean>;
+} : {};
 export type ImmediateTrigger<Config extends SetupEventConfig> = CommonEvents<Config> & {
     type: `trigger`;
     immediate: true;
@@ -74,6 +77,17 @@ export type ImmediateTrigger<Config extends SetupEventConfig> = CommonEvents<Con
                 setup?: Config[`setup`];
             };
         }>;
+        check?: CoreFunction<{
+            credentials: Config[`credentials`];
+            inputs: {
+                fields: Config[`fields`];
+                link: string;
+                setup?: Config[`setup`];
+            };
+            outputs: {
+                done: boolean;
+            };
+        }>;
         unmount?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
@@ -104,7 +118,7 @@ export type ImmediateTrigger<Config extends SetupEventConfig> = CommonEvents<Con
                 fields: Config[`fields`];
                 request: Request;
                 setup?: Config[`setup`];
-            };
+            } & SourcePreferences<Config>;
             outputs: {
                 records: Config[`outputs`][];
                 flags: Partial<Record<Config[`flags`][`outputs`][number], true>>;
@@ -116,7 +130,7 @@ export type ImmediateTrigger<Config extends SetupEventConfig> = CommonEvents<Con
                 fields: Config[`fields`];
                 link: string;
                 setup?: any;
-            };
+            } & SourcePreferences<Config>;
             outputs: {
                 done: boolean;
             };
@@ -127,7 +141,7 @@ export type ImmediateTrigger<Config extends SetupEventConfig> = CommonEvents<Con
                 fields: Config[`fields`];
                 last_schedule: string;
                 limit?: number;
-            };
+            } & SourcePreferences<Config>;
             outputs: {
                 records: Config[`outputs`][];
                 flags: Partial<Record<Config[`flags`][`outputs`][number], true>>;
@@ -146,7 +160,7 @@ export type ScheduledTrigger<Config extends EventConfig> = CommonEvents<Config>
                 fields: Config[`fields`];
                 last_schedule: string;
                 limit?: number;
-            };
+            } & SourcePreferences<Config>;
             outputs: {
                 records: Config[`outputs`][];
                 flags: Partial<Record<Config[`flags`][`outputs`][number], true>>;
@@ -173,48 +187,25 @@ export type SyncAction<Config extends MemoryEventConfig> = CommonEvents<Config>
                 fields: Config[`fields`];
                 flags: Partial<Record<Config[`flags`][`inputs`][number], true>>;
                 memory?: Config[`memory`];
-            };
+            } & SourcePreferences<Config>;
             outputs: StandardOutput<Config> | MemoryOutput<Config>;
         }>;
     };
 };
-export type AsyncAction<Config extends SetupEventConfig & MemoryEventConfig> = CommonEvents<Config> & {
+export type AsyncAction<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]>)[]];
     async: true;
     functions: {
-        mount?: CoreFunction<{
-            credentials: Config[`credentials`];
-            inputs: {
-                fields: Config[`fields`];
-                link: string;
-            };
-            outputs: {
-                done: boolean;
-                setup?: Config[`setup`];
-            };
-        }>;
-        unmount?: CoreFunction<{
-            credentials: Config[`credentials`];
-            inputs: {
-                fields: Config[`fields`];
-                link: string;
-                setup?: Config[`setup`];
-            };
-            outputs: {
-                done: boolean;
-            };
-        }>;
         execute: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
                 fields: Config[`fields`];
                 flags: Partial<Record<Config[`flags`][`inputs`][number], true>>;
                 link: string;
-                setup?: Config[`setup`];
                 memory?: Config[`memory`];
-            };
+            } & SourcePreferences<Config>;
             outputs: {
                 done: boolean;
                 memory?: Config[`memory`];
@@ -225,9 +216,8 @@ export type AsyncAction<Config extends SetupEventConfig & MemoryEventConfig> = C
             inputs: {
                 fields: Config[`fields`];
                 request: Request;
-                setup?: Config[`setup`];
                 memory?: Config[`memory`];
-            };
+            } & SourcePreferences<Config>;
             outputs: StandardOutput<Config>;
         }>;
         fire?: CoreFunction<{
@@ -235,9 +225,8 @@ export type AsyncAction<Config extends SetupEventConfig & MemoryEventConfig> = C
             inputs: {
                 fields: Config[`fields`];
                 link: string;
-                setup?: Config[`setup`];
                 memory?: Config[`memory`];
-            };
+            } & SourcePreferences<Config>;
             outputs: {
                 done: boolean;
             };

package/dist/entities/events.js

@@ -67,6 +67,7 @@ const immediateTriggerSchema = () => joi_1.default.object({
         .required(),
     functions: joi_1.default.object({
         mount: joi_1.default.function(),
+        check: joi_1.default.function(),
         unmount: joi_1.default.function(),
         challenge: joi_1.default.function(),
         handle: joi_1.default.function().required(),
@@ -108,8 +109,6 @@ const asyncActionSchema = () => joi_1.default.object({
         .min(1)
         .required(),
     functions: joi_1.default.object({
-        mount: joi_1.default.function(),
-        unmount: joi_1.default.function(),
         execute: joi_1.default.function().required(),
         handle: joi_1.default.function().required(),
         fire: joi_1.default.function(),

package/package.json

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

package/src/core.ts

@@ -30,7 +30,7 @@ export type Core = {
   lodash: lodash.LoDashStatic,
   env: Record<string, any>,
   joi: Joi.Root,
-  sources?: SourceFunctions,
+  sources: SourceFunctions,
   t: T,
 };
 

package/src/entities/commons.ts

@@ -7,7 +7,7 @@ export type CoreConfig = {
   outputs?: any,
 };
 
-export type CoreFunction<Config extends CoreConfig = {}> = (core: Core, configuration: ({
+type Configuration<Config extends CoreConfig> = ({
   sandbox: boolean,
   organization?: string,
 } & (
@@ -20,8 +20,11 @@ export type CoreFunction<Config extends CoreConfig = {}> = (core: Core, configur
     {} :
     { credentials: Config[`credentials`] }
   )
-)) => Promise<Config[`outputs`]> | Config[`outputs`];
+);
 
+export type CoreFunction<Config extends CoreConfig = {}> =
+  ((core: Core, configuration: Configuration<Config>) => Promise<Config[`outputs`]>)
+  | ((core: Core, configuration: Configuration<Config>) => Config[`outputs`]);
 
 type CommonConfig = Pick<CoreConfig, `credentials`>;
 

package/src/entities/events.ts

@@ -70,6 +70,11 @@ export type Request = {
   raw: string,
 };
 
+type SourcePreferences<Config extends EventConfig> =
+  Config[`sources`] extends string[]
+  ? { sources: Record<Config[`sources`][number], boolean> }
+  : {};
+
 export type ImmediateTrigger<Config extends SetupEventConfig> = CommonEvents<Config> & {
   type: `trigger`,
   immediate: true,
@@ -80,6 +85,11 @@ export type ImmediateTrigger<Config extends SetupEventConfig> = CommonEvents<Con
       inputs: { fields: Config[`fields`], link: string },
       outputs: { done: boolean, setup?: Config[`setup`] },
     }>,
+    check?: CoreFunction<{
+      credentials: Config[`credentials`],
+      inputs: { fields: Config[`fields`], link: string, setup?: Config[`setup`] },
+      outputs: { done: boolean },
+    }>,
     unmount?: CoreFunction<{
       credentials: Config[`credentials`],
       inputs: { fields: Config[`fields`], link: string, setup?: Config[`setup`] },
@@ -92,17 +102,17 @@ export type ImmediateTrigger<Config extends SetupEventConfig> = CommonEvents<Con
     }>,
     handle: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], request: Request, setup?: Config[`setup`] },
+      inputs: { fields: Config[`fields`], request: Request, setup?: Config[`setup`] } & SourcePreferences<Config>,
       outputs: { records: Config[`outputs`][], flags: Partial<Record<Config[`flags`][`outputs`][number], true>> },
     }>,
     fire?: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], link: string, setup?: any },
+      inputs: { fields: Config[`fields`], link: string, setup?: any } & SourcePreferences<Config>,
       outputs: { done: boolean },
     }>,
     poll?: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], last_schedule: string, limit?: number },
+      inputs: { fields: Config[`fields`], last_schedule: string, limit?: number } & SourcePreferences<Config>,
       outputs: { records: Config[`outputs`][], flags: Partial<Record<Config[`flags`][`outputs`][number], true>> },
     }>,
   },
@@ -115,7 +125,7 @@ export type ScheduledTrigger<Config extends EventConfig> = CommonEvents<Config>
   functions: {
     poll: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], last_schedule: string, limit?: number },
+      inputs: { fields: Config[`fields`], last_schedule: string, limit?: number } & SourcePreferences<Config>,
       outputs: { records: Config[`outputs`][], flags: Partial<Record<Config[`flags`][`outputs`][number], true>> },
     }>,
   },
@@ -139,41 +149,31 @@ export type SyncAction<Config extends MemoryEventConfig> = CommonEvents<Config>
   functions: {
     execute: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], flags: Partial<Record<Config[`flags`][`inputs`][number], true>>, memory?: Config[`memory`] },
+      inputs: { fields: Config[`fields`], flags: Partial<Record<Config[`flags`][`inputs`][number], true>>, memory?: Config[`memory`] } & SourcePreferences<Config>,
       outputs: StandardOutput<Config> | MemoryOutput<Config>,
     }>,
   },
 };
 
-export type AsyncAction<Config extends SetupEventConfig & MemoryEventConfig> = CommonEvents<Config> & {
+export type AsyncAction<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]>)[]],
   async: true,
   functions: {
-    mount?: CoreFunction<{
-      credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], link: string },
-      outputs: { done: boolean, setup?: Config[`setup`] },
-    }>,
-    unmount?: CoreFunction<{
-      credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], link: string, setup?: Config[`setup`] },
-      outputs: { done: boolean },
-    }>,
     execute: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], flags: Partial<Record<Config[`flags`][`inputs`][number], true>>, link: string, setup?: Config[`setup`], memory?: Config[`memory`] },
+      inputs: { fields: Config[`fields`], flags: Partial<Record<Config[`flags`][`inputs`][number], true>>, link: string, memory?: Config[`memory`] } & SourcePreferences<Config>,
       outputs: { done: boolean, memory?: Config[`memory`] },
     }>,
     handle: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], request: Request, setup?: Config[`setup`], memory?: Config[`memory`] },
+      inputs: { fields: Config[`fields`], request: Request, memory?: Config[`memory`] } & SourcePreferences<Config>,
       outputs: StandardOutput<Config>,
     }>,
     fire?: CoreFunction<{
       credentials: Config[`credentials`],
-      inputs: { fields: Config[`fields`], link: string, setup?: Config[`setup`], memory?: Config[`memory`] },
+      inputs: { fields: Config[`fields`], link: string, memory?: Config[`memory`] } & SourcePreferences<Config>,
       outputs: { done: boolean },
     }>,
   },
@@ -260,6 +260,7 @@ export const immediateTriggerSchema = () =>
       .required(),
     functions: Joi.object({
       mount: Joi.function(),
+      check: Joi.function(),
       unmount: Joi.function(),
       challenge: Joi.function(),
       handle: Joi.function().required(),
@@ -318,8 +319,8 @@ export const asyncActionSchema = () =>
       .min(1)
       .required(),
     functions: Joi.object({
-      mount: Joi.function(),
-      unmount: Joi.function(),
+      // mount: Joi.function(),
+      // unmount: Joi.function(),
       execute: Joi.function().required(),
       handle: Joi.function().required(),
       fire: Joi.function(),