@beseif-solutions/prow-core 0.0.33 → 0.0.35

package/dist/entities/commons.js

@@ -5,7 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.commonSchema = exports.idSchema = void 0;
 const joi_1 = __importDefault(require("joi"));
-const idSchema = () => joi_1.default.string().required().regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/);
+const idSchema = () => joi_1.default.string().required().regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/)
+    .invalid(`ui`);
 exports.idSchema = idSchema;
 const commonSchema = () => joi_1.default.object({
     id: (0, exports.idSchema)(),

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,11 +1,10 @@
 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';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
 export { extract, Field, fieldSchema, fieldsSchema, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
-export { i18n, localizeFields, localizeInputs, localizeOutputs, localizeProperties, LocalizedField, LocalizedProperties } from './minified-utils/locales';
+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,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.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;
 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");
@@ -30,6 +28,7 @@ Object.defineProperty(exports, "validate", { enumerable: true, get: function ()
 var locales_1 = require("./minified-utils/locales");
 Object.defineProperty(exports, "i18n", { enumerable: true, get: function () { return locales_1.i18n; } });
 Object.defineProperty(exports, "localizeFields", { enumerable: true, get: function () { return locales_1.localizeFields; } });
+Object.defineProperty(exports, "localizeGroup", { enumerable: true, get: function () { return locales_1.localizeGroup; } });
 Object.defineProperty(exports, "localizeInputs", { enumerable: true, get: function () { return locales_1.localizeInputs; } });
 Object.defineProperty(exports, "localizeOutputs", { enumerable: true, get: function () { return locales_1.localizeOutputs; } });
 Object.defineProperty(exports, "localizeProperties", { enumerable: true, get: function () { return locales_1.localizeProperties; } });

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

@@ -34,6 +34,7 @@ export declare const i18n: (options: FromCatalog | FromDirectory) => {
 };
 export declare const localizeFields: (t: ReturnType<typeof i18n>[`t`], element: Action | Trigger | StaticCredentials | SessionCredentials | Source) => Field<LocalizedField>[];
 export declare const localizeProperties: (t: ReturnType<typeof i18n>[`t`], element: Action | Trigger | Credentials | Provider | Source) => LocalizedProperties;
+export declare const localizeGroup: (t: ReturnType<typeof i18n>[`t`], element: Action | Trigger) => LocalizedProperties;
 export declare const localizeInputs: (t: ReturnType<typeof i18n>[`t`], element: Action) => (ConnectableEvent & LocalizedProperties)[];
 export declare const localizeOutputs: (t: ReturnType<typeof i18n>[`t`], element: Action | Trigger) => (ConnectableEvent & LocalizedProperties)[];
 export {};

package/dist/minified-utils/locales.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.localizeOutputs = exports.localizeInputs = exports.localizeProperties = exports.localizeFields = exports.i18n = exports.validateDirectory = void 0;
+exports.localizeOutputs = exports.localizeInputs = exports.localizeGroup = exports.localizeProperties = exports.localizeFields = exports.i18n = exports.validateDirectory = void 0;
 const i18n_1 = __importDefault(require("i18n"));
 const lodash_1 = __importDefault(require("lodash"));
 const fs_1 = __importDefault(require("fs"));
@@ -112,6 +112,11 @@ const localizeProperties = (t, element) => ({
     description: t(`${element.id}.description`),
 });
 exports.localizeProperties = localizeProperties;
+const localizeGroup = (t, element) => ({
+    name: t(`ui.groups.${element.ui.group}.name`, { fallback: true }),
+    description: t(`ui.groups.${element.ui.group}.description`),
+});
+exports.localizeGroup = localizeGroup;
 const localizeConnectable = (t, element, type) => {
     const response = [];
     if (element[type] && element[type].length > 0) {

package/package.json

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

package/src/entities/commons.ts

@@ -31,7 +31,8 @@ export type Common<Config extends CommonConfig = {}> = {
 };
 
 export const idSchema = () =>
-  Joi.string().required().regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/);
+  Joi.string().required().regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/)
+    .invalid(`ui`);
 
 export const commonSchema = () =>
   Joi.object({

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,11 +1,10 @@
 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';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
 export { extract, Field, fieldSchema, fieldsSchema, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
-export { i18n, localizeFields, localizeInputs, localizeOutputs, localizeProperties, LocalizedField, LocalizedProperties } from './minified-utils/locales';
+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/src/minified-utils/locales.ts

@@ -157,6 +157,14 @@ export const localizeProperties = (
   description: t(`${element.id}.description`),
 });
 
+export const localizeGroup = (
+  t: ReturnType<typeof i18n>[`t`],
+  element: Action | Trigger,
+): LocalizedProperties => ({
+  name: t(`ui.groups.${element.ui.group}.name`, { fallback: true }),
+  description: t(`ui.groups.${element.ui.group}.description`),
+});
+
 const localizeConnectable = (
   t: ReturnType<typeof i18n>[`t`],
   element: Action | Trigger,

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; }
-};