@beseif-solutions/prow-core 0.0.32 → 0.0.34

package/dist/entities/events.d.ts

@@ -29,7 +29,14 @@ type EventConfig = Pick<CoreConfig, `credentials` | `outputs`> & {
 };
 type CommonEvents<Config extends EventConfig = {}> = Common<Config> & {
     model: `event`;
-    category: string;
+    categorization: {
+        department: string;
+        category: string;
+    };
+    ui: {
+        group: string;
+        icon?: string;
+    };
     credentials: string[];
     sandbox: boolean;
     fields: Field[];

package/dist/entities/events.js

@@ -22,7 +22,14 @@ const additionalConnectableEventSchema = () => joi_1.default.object({})
     .concat(commonConnectableEventSchema());
 const commonEventsSchema = () => joi_1.default.object({
     model: joi_1.default.valid(`event`).required(),
-    category: joi_1.default.string().required(),
+    categorization: joi_1.default.object({
+        department: joi_1.default.string().required(),
+        category: joi_1.default.string().required(),
+    }).required(),
+    ui: joi_1.default.object({
+        group: joi_1.default.string().required(),
+        icon: joi_1.default.string(),
+    }).required(),
     credentials: joi_1.default.array().items((0, commons_1.idSchema)().optional()).required().min(0),
     sandbox: joi_1.default.bool().required(),
     fields: (0, fields_1.fieldsSchema)().required(),

package/dist/entities/provider.d.ts

@@ -5,10 +5,9 @@ import { Source } from "./source";
 export type Provider = {
     id: string;
     model: `provider`;
-    categories: string[];
     credentials: Record<string, Credentials>;
     triggers: Record<string, Trigger>;
     actions: Record<string, Action>;
-    sources?: Record<string, Source>;
+    sources: Record<string, Source>;
 };
 export declare const providerSchema: () => Joi.ObjectSchema<any>;

package/dist/entities/provider.js

@@ -12,7 +12,6 @@ const source_1 = require("./source");
 const providerSchema = () => joi_1.default.object({
     id: (0, commons_1.idSchema)(),
     model: joi_1.default.valid(`provider`).required(),
-    categories: joi_1.default.array().items(joi_1.default.string()).min(1).required(),
     credentials: joi_1.default.object()
         .pattern((0, commons_1.idSchema)(), (0, credentials_1.credentialsSchema)())
         .required(),
@@ -23,6 +22,7 @@ const providerSchema = () => joi_1.default.object({
         .pattern((0, commons_1.idSchema)(), (0, events_1.actionSchema)())
         .required(),
     sources: joi_1.default.object()
-        .pattern((0, commons_1.idSchema)(), (0, source_1.sourceSchema)()),
+        .pattern((0, commons_1.idSchema)(), (0, source_1.sourceSchema)())
+        .required(),
 });
 exports.providerSchema = providerSchema;

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 export { Core, core } from './core';
-export { getCategories } from './entities/category';
 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';

package/dist/index.js

@@ -1,10 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Protocol = exports.Properties = exports.localizeProperties = exports.localizeOutputs = exports.localizeInputs = 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.getCategories = exports.core = void 0;
+exports.Protocol = exports.Properties = exports.localizeProperties = exports.localizeOutputs = exports.localizeInputs = 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;
 var core_1 = require("./core");
 Object.defineProperty(exports, "core", { enumerable: true, get: function () { return core_1.core; } });
-var category_1 = require("./entities/category");
-Object.defineProperty(exports, "getCategories", { enumerable: true, get: function () { return category_1.getCategories; } });
 var commons_1 = require("./entities/commons");
 Object.defineProperty(exports, "idSchema", { enumerable: true, get: function () { return commons_1.idSchema; } });
 var credentials_1 = require("./entities/credentials");

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

@@ -6,7 +6,7 @@ export declare class Protocol {
     evaluate: (req: Protocol.Command) => Promise<any>;
 }
 export declare namespace Protocol {
-    type Model = `action` | `trigger` | `credentials`;
+    type Model = `action` | `trigger` | `credential`;
     type Invoke = {
         command: `invoke`;
         model: Protocol.Model;

package/dist/minified-utils/protocol.js

@@ -4,14 +4,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Protocol = void 0;
+const joi_1 = __importDefault(require("joi"));
 const lodash_1 = __importDefault(require("lodash"));
+const core_1 = require("../core");
 const provider_1 = require("../entities/provider");
 const locales_1 = require("./locales");
-const core_1 = require("../core");
-const joi_1 = __importDefault(require("joi"));
 const invokeSchema = joi_1.default.object({
     command: joi_1.default.string().valid(`invoke`).required(),
-    model: joi_1.default.string().valid(`action`, `trigger`, `credentials`).required(),
+    model: joi_1.default.string().valid(`action`, `trigger`, `credential`).required(),
     id: joi_1.default.string().required(),
     params: joi_1.default.object({
         function: joi_1.default.string().required(),
@@ -49,16 +49,21 @@ class Protocol {
                 if (validation.error) {
                     throw new Error(`Invalid request: ${validation.error.message}`);
                 }
+                const serialize = (elem) => ({
+                    ...lodash_1.default.omit(elem, [`functions`, `helpers`]),
+                    functions: Object.keys(elem.functions),
+                    helpers: Object.keys(elem.helpers),
+                });
                 let response;
                 switch (req.command) {
                     case `list:actions`:
-                        response = Object.values(this.provider.actions || {});
+                        response = Object.values(this.provider.actions || {}).map(serialize);
                         break;
                     case `list:triggers`:
-                        response = Object.values(this.provider.triggers || {});
+                        response = Object.values(this.provider.triggers || {}).map(serialize);
                         break;
                     case `list:credentials`:
-                        response = Object.values(this.provider.credentials || {});
+                        response = Object.values(this.provider.credentials || {}).map(serialize);
                         break;
                     case `list:sources`:
                         response = Object.values(this.provider.sources || {});
@@ -74,22 +79,20 @@ class Protocol {
                         });
                         break;
                     case `invoke`:
-                        const mEvent = lodash_1.default.get(this.provider, `${req.model}s.${req.id}`);
-                        if (!mEvent) {
-                            return {
-                                status: 404,
-                                body: JSON.stringify({ error: `Could not find ${req.model} with ID ${req.id}` }),
-                            };
+                        const elem = lodash_1.default.get(this.provider, `${req.model}s.${req.id}`);
+                        if (!elem) {
+                            throw new Error(`Could not find ${req.model} with ID ${req.id}`);
                         }
-                        const f = lodash_1.default.get(mEvent, req.params.function);
-                        if (!f || typeof f !== `function`) {
+                        const func = lodash_1.default.get(elem, req.params.function);
+                        if (!func || typeof func !== `function`) {
                             throw new Error(`Invalid function ${req.params.function}`);
                         }
                         const invokeInstance = (0, core_1.core)({
                             env: req.context.environment,
                             localization: req.context.localization,
+                            sources: null,
                         });
-                        response = await f(invokeInstance, req.params.configuration);
+                        response = await func(invokeInstance, req.params.configuration);
                         break;
                     default:
                         throw new Error(`Invalid command`);

package/package.json

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

package/src/entities/events.ts

@@ -37,7 +37,14 @@ type EventConfig = Pick<CoreConfig, `credentials` | `outputs`> & {
 
 type CommonEvents<Config extends EventConfig = {}> = Common<Config> & {
   model: `event`,
-  category: string,
+  categorization: {
+    department: string,
+    category: string,
+  },
+  ui: {
+    group: string,
+    icon?: string,
+  },
   credentials: string[],
   sandbox: boolean,
   fields: Field[],
@@ -143,7 +150,14 @@ const additionalConnectableEventSchema = () =>
 const commonEventsSchema = () =>
   Joi.object({
     model: Joi.valid(`event`).required(),
-    category: Joi.string().required(),
+    categorization: Joi.object({
+      department: Joi.string().required(),
+      category: Joi.string().required(),
+    }).required(),
+    ui: Joi.object({
+      group: Joi.string().required(),
+      icon: Joi.string(),
+    }).required(),
     credentials: Joi.array().items(idSchema().optional()).required().min(0),
     sandbox: Joi.bool().required(),
     fields: fieldsSchema().required(),

package/src/entities/provider.ts

@@ -7,18 +7,16 @@ import { Source, sourceSchema } from "./source";
 export type Provider = {
   id: string,
   model: `provider`,
-  categories: string[],
   credentials: Record<string, Credentials>,
   triggers: Record<string, Trigger>,
   actions: Record<string, Action>,
-  sources?: Record<string, Source>,
+  sources: Record<string, Source>,
 };
 
 export const providerSchema = () =>
   Joi.object({
     id: idSchema(),
     model: Joi.valid(`provider`).required(),
-    categories: Joi.array().items(Joi.string()).min(1).required(),
     credentials: Joi.object()
       .pattern(idSchema(), credentialsSchema())
       .required(),
@@ -29,5 +27,6 @@ export const providerSchema = () =>
       .pattern(idSchema(), actionSchema())
       .required(),
     sources: Joi.object()
-      .pattern(idSchema(), sourceSchema()),
+      .pattern(idSchema(), sourceSchema())
+      .required(),
   });

package/src/index.ts

@@ -1,5 +1,4 @@
 export { Core, core } from './core';
-export { getCategories } from './entities/category';
 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';

package/src/minified-utils/protocol.ts

@@ -1,12 +1,14 @@
+import Joi from "joi";
 import _ from "lodash";
+import { core } from "../core";
+import { Credentials } from "../entities/credentials";
+import { Action, Trigger } from "../entities/events";
 import { Provider, providerSchema } from "../entities/provider";
 import { i18n } from "./locales";
-import { core } from "../core";
-import Joi from "joi";
 
 const invokeSchema = Joi.object({
   command: Joi.string().valid(`invoke`).required(),
-  model: Joi.string().valid(`action`, `trigger`, `credentials`).required(),
+  model: Joi.string().valid(`action`, `trigger`, `credential`).required(),
   id: Joi.string().required(),
   params: Joi.object({
     function: Joi.string().required(),
@@ -67,16 +69,22 @@ export class Protocol {
       const validation = commandSchema.validate(req);
       if (validation.error) { throw new Error(`Invalid request: ${validation.error.message}`); }
 
+      const serialize = (elem: Action | Trigger | Credentials) => ({
+        ..._.omit(elem, [`functions`, `helpers`]),
+        functions: Object.keys(elem.functions),
+        helpers: Object.keys(elem.helpers),
+      });
+
       let response: any;
       switch (req.command) {
         case `list:actions`:
-          response = Object.values(this.provider.actions || {});
+          response = Object.values(this.provider.actions || {}).map(serialize);
           break;
         case `list:triggers`:
-          response = Object.values(this.provider.triggers || {});
+          response = Object.values(this.provider.triggers || {}).map(serialize);
           break;
         case `list:credentials`:
-          response = Object.values(this.provider.credentials || {});
+          response = Object.values(this.provider.credentials || {}).map(serialize);
           break;
         case `list:sources`:
           response = Object.values(this.provider.sources || {});
@@ -92,23 +100,20 @@ export class Protocol {
           });
           break;
         case `invoke`:
-          const mEvent = _.get(this.provider, `${req.model}s.${req.id}`);
-          if (!mEvent) {
-            return {
-              status: 404,
-              body: JSON.stringify({ error: `Could not find ${req.model} with ID ${req.id}` }),
-            };
-          }
+          const elem = _.get(this.provider, `${req.model}s.${req.id}`);
+          if (!elem) { throw new Error(`Could not find ${req.model} with ID ${req.id}`); }
 
-          const f = _.get(mEvent, req.params.function);
-          if (!f || typeof f !== `function`) { throw new Error(`Invalid function ${req.params.function}`); }
+          const func = _.get(elem, req.params.function);
+          if (!func || typeof func !== `function`) { throw new Error(`Invalid function ${req.params.function}`); }
 
           const invokeInstance = core({
             env: req.context.environment,
             localization: req.context.localization,
+            // TODO: sources
+            sources: null,
           });
 
-          response = await f(invokeInstance, req.params.configuration);
+          response = await func(invokeInstance, req.params.configuration);
           break;
         default:
           throw new Error(`Invalid command`);
@@ -121,7 +126,7 @@ export class Protocol {
 
 export namespace Protocol {
 
-  export type Model = `action` | `trigger` | `credentials`;
+  export type Model = `action` | `trigger` | `credential`;
 
   export type Invoke = {
     command: `invoke`,

package/dist/entities/category.d.ts

@@ -1 +0,0 @@
-export declare const getCategories: () => Promise<string[]>;

package/dist/entities/category.js

@@ -1,20 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCategories = void 0;
-const axios_1 = __importDefault(require("axios"));
-const getCategories = async () => {
-    try {
-        const { data } = await axios_1.default.get(`https://dev-beseif.s3.eu-west-1.amazonaws.com/prow/categories.txt`);
-        if (!data || typeof data !== `string`) {
-            throw new Error(`Could not obtain category list`);
-        }
-        return data.split(`\n`).map((d) => d.trim()).filter((d) => d);
-    }
-    catch (e) {
-        throw e;
-    }
-};
-exports.getCategories = getCategories;

package/src/entities/category.ts

@@ -1,9 +0,0 @@
-import axios from "axios";
-
-export const getCategories = async (): Promise<string[]> => {
-  try {
-    const { data } = await axios.get(`https://dev-beseif.s3.eu-west-1.amazonaws.com/prow/categories.txt`);
-    if (!data || typeof data !== `string`) { throw new Error(`Could not obtain category list`); }
-    return data.split(`\n`).map((d) => d.trim()).filter((d) => d);
-  } catch (e) { throw e; }
-};