@beseif-solutions/prow-core 0.0.39 → 0.2.0

package/dist/core.d.ts

@@ -5,14 +5,14 @@ import moment from "moment-timezone";
 import { FromCatalog, FromDirectory, T } from "./minified-utils/locales";
 type SyncOrAsync<T> = T | Promise<T>;
 export type SourceFunctions = {
-    register: <T>(source: string, data: T) => SyncOrAsync<{
+    register: <T>(source: string, sandbox: boolean, data: T) => SyncOrAsync<{
         id: string;
     }>;
-    consume: <T>(source: string) => SyncOrAsync<{
+    consume: <T>(source: string, sandbox: boolean) => SyncOrAsync<{
         id: string;
         data: T;
     }[]>;
-    unregister: (source: string, id: string) => SyncOrAsync<void>;
+    unregister: (source: string, sandbox: boolean, id: string) => SyncOrAsync<void>;
 };
 export type Core = {
     axios: AxiosStatic;

package/dist/entities/commons.d.ts

@@ -12,7 +12,7 @@ export type CoreFunction<Config extends CoreConfig = {}> = (core: Core, configur
     inputs: Config[`inputs`];
 }) & (Config[`credentials`] extends undefined ? {} : {
     credentials: Config[`credentials`];
-}))) => Promise<Config[`outputs`]>;
+}))) => Promise<Config[`outputs`]> | Config[`outputs`];
 type CommonConfig = Pick<CoreConfig, `credentials`>;
 export type Common<Config extends CommonConfig = {}> = {
     id: string;

package/dist/entities/events.d.ts

@@ -1,6 +1,7 @@
 import Joi from "joi";
 import { Field } from "../minified-utils/fields";
 import { Common, CoreConfig, CoreFunction } from "./commons";
+import { OneOrArray } from "../minified-utils/types";
 type CommonConnectableEvent<Keys extends string = string> = {
     key: Keys;
 };
@@ -26,8 +27,17 @@ type EventConfig = Pick<CoreConfig, `credentials` | `outputs`> & {
         outputs: string[];
     };
     sources?: string[];
+    fields?: Record<string, any>;
 };
-type CommonEvents<Config extends EventConfig = {}> = Common<Config> & {
+type SetupEventConfig = EventConfig & {
+    setup?: Record<string, any>;
+};
+type MemoryEventConfig = EventConfig & {
+    memory?: Record<string, any>;
+};
+type CommonEvents<Config extends EventConfig = {
+    fields: Record<string, any>;
+}> = Common<Config> & {
     model: `event`;
     categorization: {
         department: string;
@@ -49,7 +59,10 @@ export type Request = {
     query: Record<string, string>;
     body: any;
 };
-export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Config> & {
+export type ImmediateTrigger<Config extends SetupEventConfig = {
+    fields: Record<string, any>;
+    setup: Record<string, any>;
+}> = CommonEvents<Config> & {
     type: `trigger`;
     immediate: true;
     outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>];
@@ -57,20 +70,20 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         mount?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 link: string;
             };
             outputs: {
                 done: boolean;
-                setup?: any;
+                setup?: Config[`setup`];
             };
         }>;
         unmount?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 link: string;
-                setup?: any;
+                setup?: Config[`setup`];
             };
             outputs: {
                 done: boolean;
@@ -79,10 +92,10 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         challenge?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 link: string;
                 request: Request;
-                setup?: any;
+                setup?: Config[`setup`];
             };
             outputs: {
                 done: boolean;
@@ -92,9 +105,9 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         handle: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 request: Request;
-                setup?: any;
+                setup?: Config[`setup`];
             };
             outputs: {
                 records: Config[`outputs`][];
@@ -104,7 +117,7 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         fire?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 link: string;
                 setup?: any;
             };
@@ -115,7 +128,7 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         poll?: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 last_schedule?: string;
                 limit?: number;
             };
@@ -126,7 +139,9 @@ export type ImmediateTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         }>;
     };
 };
-export type ScheduledTrigger<Config extends EventConfig = {}> = CommonEvents<Config> & {
+export type ScheduledTrigger<Config extends EventConfig = {
+    fields: Record<string, any>;
+}> = CommonEvents<Config> & {
     type: `trigger`;
     immediate: false;
     outputs: [DefaultConnectableEvent<Config[`flags`][`outputs`][number]>];
@@ -134,7 +149,7 @@ export type ScheduledTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         poll: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 last_schedule?: string;
                 limit?: number;
             };
@@ -145,8 +160,22 @@ export type ScheduledTrigger<Config extends EventConfig = {}> = CommonEvents<Con
         }>;
     };
 };
-export type Trigger<Config extends EventConfig = {}> = ImmediateTrigger<Config> | ScheduledTrigger<Config>;
-export type Action<Config extends EventConfig = {}> = CommonEvents<Config> & {
+export type Trigger<Config extends EventConfig = {
+    fields: Record<string, any>;
+}> = ImmediateTrigger<Config> | ScheduledTrigger<Config>;
+type StandardOutput<Config extends EventConfig> = {
+    output: OneOrArray<Config[`outputs`]>;
+    flags: Partial<Record<Config[`flags`][`outputs`][number], true>>;
+};
+type MemoryOutput<Config extends MemoryEventConfig = {
+    memory: Record<string, any>;
+}> = {
+    memory: Config[`memory`];
+} & (StandardOutput<Config> | {});
+export type Action<Config extends MemoryEventConfig = {
+    fields: Record<string, any>;
+    memory: Record<string, any>;
+}> = 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]>)[]];
@@ -154,22 +183,89 @@ export type Action<Config extends EventConfig = {}> = CommonEvents<Config> & {
         execute: CoreFunction<{
             credentials: Config[`credentials`];
             inputs: {
-                fields: Record<string, any>;
+                fields: Config[`fields`];
                 flags: Partial<Record<Config[`flags`][`inputs`][number], true>>;
+                memory?: Config[`memory`];
+            };
+            outputs: StandardOutput<Config> | MemoryOutput<Config>;
+        }>;
+    };
+};
+export type AsyncAction<Config extends SetupEventConfig = {
+    fields: Record<string, any>;
+    setup: Record<string, any>;
+}> = 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: {
-                output: Config[`outputs`];
-                flags: Partial<Record<Config[`flags`][`outputs`][number], true>>;
+                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>>;
+                setup?: Config[`setup`];
+            };
+            outputs: {
+                done: boolean;
+                setup?: Config[`setup`];
+            };
+        }>;
+        handle: CoreFunction<{
+            credentials: Config[`credentials`];
+            inputs: {
+                fields: Config[`fields`];
+                request: Request;
+                setup?: Config[`setup`];
+            };
+            outputs: StandardOutput<Config>;
+        }>;
+        fire?: CoreFunction<{
+            credentials: Config[`credentials`];
+            inputs: {
+                fields: Config[`fields`];
+                link: string;
+                setup?: Config[`setup`];
+            };
+            outputs: {
+                done: boolean;
             };
         }>;
     };
 };
-export type Event<Config extends EventConfig = {}> = Action<Config> | Trigger<Config>;
+export type Event<Config extends EventConfig = {
+    fields: Record<string, any>;
+}> = 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>;
-export declare const actionSchema: () => Joi.ObjectSchema<any>;
+export declare const syncActionSchema: () => Joi.ObjectSchema<any>;
+export declare const asyncActionSchema: () => Joi.ObjectSchema<any>;
+export declare const actionSchema: () => Joi.AlternativesSchema<any>;
 export declare const eventSchema: () => Joi.AlternativesSchema<any>;
 export declare const triggerOutputSchema: () => Joi.ObjectSchema<any>;
-export declare const actionOutputSchema: () => Joi.ObjectSchema<any>;
+export declare const actionOutputSchema: () => Joi.AlternativesSchema<any>;
 export {};

package/dist/entities/events.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.actionOutputSchema = exports.triggerOutputSchema = exports.eventSchema = exports.actionSchema = exports.triggerSchema = exports.immediateTriggerSchema = exports.scheduledTriggerSchema = void 0;
+exports.actionOutputSchema = exports.triggerOutputSchema = exports.eventSchema = exports.actionSchema = exports.asyncActionSchema = exports.syncActionSchema = exports.triggerSchema = exports.immediateTriggerSchema = exports.scheduledTriggerSchema = void 0;
 const joi_1 = __importDefault(require("joi"));
 const fields_1 = require("../minified-utils/fields");
 const commons_1 = require("./commons");
@@ -79,7 +79,7 @@ const immediateTriggerSchema = () => joi_1.default.object({
 exports.immediateTriggerSchema = immediateTriggerSchema;
 const triggerSchema = () => joi_1.default.alternatives((0, exports.scheduledTriggerSchema)(), (0, exports.immediateTriggerSchema)());
 exports.triggerSchema = triggerSchema;
-const actionSchema = () => joi_1.default.object({
+const syncActionSchema = () => joi_1.default.object({
     type: joi_1.default.valid(`action`).required(),
     inputs: joi_1.default.array()
         .items(defaultConnectableEventSchema().required(), additionalConnectableEventSchema())
@@ -95,6 +95,30 @@ const actionSchema = () => joi_1.default.object({
 })
     .concat((0, commons_1.commonSchema)())
     .concat(commonEventsSchema());
+exports.syncActionSchema = syncActionSchema;
+const asyncActionSchema = () => joi_1.default.object({
+    type: joi_1.default.valid(`action`).required(),
+    async: joi_1.default.valid(true).required(),
+    inputs: joi_1.default.array()
+        .items(defaultConnectableEventSchema().required(), additionalConnectableEventSchema())
+        .min(1)
+        .required(),
+    outputs: joi_1.default.array()
+        .items(defaultConnectableEventSchema().required(), errorConnectableEventSchema().optional(), additionalConnectableEventSchema().optional())
+        .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(),
+    }).required(),
+})
+    .concat((0, commons_1.commonSchema)())
+    .concat(commonEventsSchema());
+exports.asyncActionSchema = asyncActionSchema;
+const actionSchema = () => joi_1.default.alternatives((0, exports.syncActionSchema)(), (0, exports.asyncActionSchema)());
 exports.actionSchema = actionSchema;
 const eventSchema = () => joi_1.default.alternatives((0, exports.triggerSchema)(), (0, exports.actionSchema)());
 exports.eventSchema = eventSchema;
@@ -106,10 +130,15 @@ const triggerOutputSchema = () => joi_1.default.object({
         .required(),
 });
 exports.triggerOutputSchema = triggerOutputSchema;
-const actionOutputSchema = () => joi_1.default.object({
+const actionOutputSchema = () => joi_1.default.alternatives(joi_1.default.object({
     output: 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(),
-});
+}), joi_1.default.object({
+    memory: joi_1.default.object().required(),
+    output: joi_1.default.alternatives(joi_1.default.array(), joi_1.default.object()),
+    flags: joi_1.default.object()
+        .pattern(joi_1.default.string(), joi_1.default.valid(true)),
+}).and(`output`, `flags`));
 exports.actionOutputSchema = actionOutputSchema;

package/dist/entities/source.d.ts

@@ -3,6 +3,7 @@ import { Field } from "../minified-utils/fields";
 import { Common } from "./commons";
 export type Source = Common & {
     model: "source";
+    sandbox: boolean;
     fields: Field[];
 };
 export declare const sourceSchema: () => Joi.ObjectSchema<any>;

package/dist/entities/source.js

@@ -9,6 +9,7 @@ const fields_1 = require("../minified-utils/fields");
 const commons_1 = require("./commons");
 const sourceSchema = () => joi_1.default.object({
     model: joi_1.default.valid(`source`).required(),
+    sandbox: joi_1.default.boolean().required(),
     fields: (0, fields_1.fieldsSchema)().required().min(1),
 }).concat((0, commons_1.commonSchema)());
 exports.sourceSchema = sourceSchema;

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 export { Core, core } from './core';
 export { CoreFunction, idSchema } from './entities/commons';
 export { Credentials, credentialsSchema, OAuthCredentials, oauthCredentialsSchema, SessionCredentials, sessionCredentialsSchema, StaticCredentials, staticCredentialsSchema } from './entities/credentials';
-export { Action, actionOutputSchema, actionSchema, Event, eventSchema, ImmediateTrigger, immediateTriggerSchema, Request, ScheduledTrigger, scheduledTriggerSchema, Trigger, triggerOutputSchema, triggerSchema } from './entities/events';
+export { Action, actionOutputSchema, actionSchema, AsyncAction, Event, eventSchema, ImmediateTrigger, immediateTriggerSchema, Request, ScheduledTrigger, scheduledTriggerSchema, syncActionSchema, Trigger, triggerOutputSchema, triggerSchema } from './entities/events';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
-export { extract, Field, fieldSchema, fieldsSchema, File, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
+export { alter, extract, Field, fieldSchema, fieldsSchema, File, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
 export { 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.validate = exports.fieldsSchema = exports.fieldSchema = exports.extract = exports.providerSchema = exports.triggerSchema = exports.triggerOutputSchema = 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.validate = exports.fieldsSchema = exports.fieldSchema = exports.extract = exports.alter = 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");
@@ -16,11 +16,13 @@ Object.defineProperty(exports, "actionSchema", { enumerable: true, get: function
 Object.defineProperty(exports, "eventSchema", { enumerable: true, get: function () { return events_1.eventSchema; } });
 Object.defineProperty(exports, "immediateTriggerSchema", { enumerable: true, get: function () { return events_1.immediateTriggerSchema; } });
 Object.defineProperty(exports, "scheduledTriggerSchema", { enumerable: true, get: function () { return events_1.scheduledTriggerSchema; } });
+Object.defineProperty(exports, "syncActionSchema", { enumerable: true, get: function () { return events_1.syncActionSchema; } });
 Object.defineProperty(exports, "triggerOutputSchema", { enumerable: true, get: function () { return events_1.triggerOutputSchema; } });
 Object.defineProperty(exports, "triggerSchema", { enumerable: true, get: function () { return events_1.triggerSchema; } });
 var provider_1 = require("./entities/provider");
 Object.defineProperty(exports, "providerSchema", { enumerable: true, get: function () { return provider_1.providerSchema; } });
 var fields_1 = require("./minified-utils/fields");
+Object.defineProperty(exports, "alter", { enumerable: true, get: function () { return fields_1.alter; } });
 Object.defineProperty(exports, "extract", { enumerable: true, get: function () { return fields_1.extract; } });
 Object.defineProperty(exports, "fieldSchema", { enumerable: true, get: function () { return fields_1.fieldSchema; } });
 Object.defineProperty(exports, "fieldsSchema", { enumerable: true, get: function () { return fields_1.fieldsSchema; } });

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

@@ -1,18 +1,16 @@
 import Joi from "joi";
-import { OneOf } from "./types";
 import { Where } from "./where";
 export type Condition = {
     condition: Where;
-} & OneOf<{
     overrides: Partial<Field>;
-    show: boolean;
-}>;
+};
 type Common = {
     key: string;
     altered_by?: Condition[];
     disabled?: boolean;
     required?: boolean;
     as_password?: boolean;
+    show?: boolean;
     show_label?: boolean;
 } & ({
     as_array?: false;
@@ -30,6 +28,7 @@ type Any = string | number | boolean | Any[] | {
 type AnyInputField<Extend = Record<never, never>> = {
     type: `any`;
     default?: Any | Any[];
+    allow_nullish?: boolean;
 } & (SelectField<Any, Extend> | {});
 type StringInputField<Extend = Record<never, never>> = {
     type: `string`;
@@ -39,7 +38,7 @@ type StringInputField<Extend = Record<never, never>> = {
     max?: number;
     regexp?: string;
     pattern?: `email` | `uri`;
-} & (SelectField<string, Extend> | TextareaField | RichTextField | {});
+} & (SelectField<string, Extend> | CustomDisplayTextField | IDETextField | {});
 type NumberInputField<Extend = Record<never, never>> = {
     type: `number`;
     default?: number | number[];
@@ -49,7 +48,7 @@ type NumberInputField<Extend = Record<never, never>> = {
     float: true;
     decimals?: number;
 } | {
-    float: false;
+    float?: false;
 }) & (SelectField<number, Extend> | {});
 type BooleanInputField<Extend = Record<never, never>> = {
     type: `boolean`;
@@ -102,11 +101,12 @@ export type SelectFieldChoice<Values = string | number | boolean | File, Extend
     key: string;
     value: Values;
 } & Extend;
-type TextareaField = {
-    format: `textarea`;
+type CustomDisplayTextField = {
+    format: `textarea` | `rich-text` | `markdown`;
 };
-type RichTextField = {
-    format: `rich-text`;
+type IDETextField = {
+    format: `code`;
+    language?: string;
 };
 type ValidationExtended = {
     original: any;
@@ -127,6 +127,7 @@ export type ValidationResult<Extended = Record<string, never>> = {
     valid: boolean;
     fields: Field<Extended & ValidationExtended>[];
 };
+export declare const alter: (field: Field, relative: string, data: Record<string, any>) => Field<Record<never, never>>;
 export declare const validate: <I>(fields: Field<I>[], data: Record<string, any>, options?: {
     secure?: boolean;
     break?: boolean;