@beseif-solutions/prow-core 0.0.29 → 0.0.30

package/dist/index.d.ts

@@ -6,5 +6,6 @@ export { Action, actionOutputSchema, actionSchema, Event, eventSchema, Immediate
 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 } from './minified-utils/locales';
+export { i18n, localizeFields, localizeInputs, localizeOutputs, localizeProperties, LocalizedField, LocalizedProperties } 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.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.getCategories = 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");
@@ -35,3 +35,5 @@ Object.defineProperty(exports, "localizeOutputs", { enumerable: true, get: funct
 Object.defineProperty(exports, "localizeProperties", { enumerable: true, get: function () { return locales_1.localizeProperties; } });
 var properties_1 = require("./minified-utils/properties");
 Object.defineProperty(exports, "Properties", { enumerable: true, get: function () { return properties_1.Properties; } });
+var protocol_1 = require("./minified-utils/protocol");
+Object.defineProperty(exports, "Protocol", { enumerable: true, get: function () { return protocol_1.Protocol; } });

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

@@ -3,11 +3,12 @@ import { Credentials, SessionCredentials, StaticCredentials } from '../entities/
 import { Action, ConnectableEvent, Trigger } from '../entities/events';
 import { Field } from './fields';
 import { Provider } from '../entities/provider';
-type LocalizedField = {
+import { Source } from '../entities/source';
+export type LocalizedField = {
     label: string;
     help: string;
 };
-type LocalizedProperties = {
+export type LocalizedProperties = {
     name: string;
     description: string;
 };
@@ -31,8 +32,8 @@ export declare const i18n: (options: FromCatalog | FromDirectory) => {
     t: T;
     i18n: I18n.I18n;
 };
-export declare const localizeFields: (t: ReturnType<typeof i18n>[`t`], element: Action | Trigger | StaticCredentials | SessionCredentials) => Field<LocalizedField>[];
-export declare const localizeProperties: (t: ReturnType<typeof i18n>[`t`], element: Action | Trigger | Credentials | Provider) => LocalizedProperties;
+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 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/protocol.d.ts

@@ -0,0 +1,42 @@
+import { Provider } from "../entities/provider";
+export declare class Protocol {
+    private readonly provider;
+    constructor(provider: Provider);
+    evaluate: (req: Protocol.Command) => Promise<any>;
+}
+export declare namespace Protocol {
+    type Model = `action` | `trigger` | `credentials`;
+    type Invoke = {
+        command: `invoke`;
+        model: Protocol.Model;
+        id: string;
+        params: {
+            function: string;
+            configuration: Record<string, any>;
+        };
+        context: {
+            environment: Record<string, any>;
+            localization: {
+                locale: string;
+                catalog: Record<string, any>;
+            };
+        };
+    };
+    type CredentialList = {
+        command: `list:credentials`;
+    };
+    type ActionList = {
+        command: `list:actions`;
+    };
+    type TriggerList = {
+        command: `list:triggers`;
+    };
+    type SourceList = {
+        command: `list:sources`;
+    };
+    type LocaleList = {
+        command: `list:locales`;
+        locale: string;
+    };
+    type Command = Invoke | CredentialList | ActionList | TriggerList | SourceList | LocaleList;
+}

package/dist/minified-utils/protocol.js

@@ -0,0 +1,111 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Protocol = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+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(),
+    id: joi_1.default.string().required(),
+    params: joi_1.default.object({
+        function: joi_1.default.string().required(),
+        configuration: joi_1.default.object().required(),
+    }).required(),
+    context: joi_1.default.object({
+        environment: joi_1.default.object().required(),
+        localization: joi_1.default.object({
+            locale: joi_1.default.string().required(),
+            catalog: joi_1.default.object().required(),
+        }).required(),
+    }).required(),
+}).required();
+const credentialListSchema = joi_1.default.object({
+    command: joi_1.default.string().valid(`list:credentials`).required(),
+}).required();
+const actionListSchema = joi_1.default.object({
+    command: joi_1.default.string().valid(`list:actions`).required(),
+}).required();
+const triggerListSchema = joi_1.default.object({
+    command: joi_1.default.string().valid(`list:triggers`).required(),
+}).required();
+const sourceListSchema = joi_1.default.object({
+    command: joi_1.default.string().valid(`list:sources`).required(),
+}).required();
+const localeListSchema = joi_1.default.object({
+    command: joi_1.default.string().valid(`list:locales`).required(),
+    locale: joi_1.default.string().required(),
+}).required();
+const commandSchema = joi_1.default.alternatives(invokeSchema, credentialListSchema, actionListSchema, triggerListSchema, sourceListSchema, localeListSchema);
+class Protocol {
+    constructor(provider) {
+        this.evaluate = async (req) => {
+            try {
+                const validation = commandSchema.validate(req);
+                if (validation.error) {
+                    throw new Error(`Invalid request: ${validation.error.message}`);
+                }
+                let response;
+                switch (req.command) {
+                    case `list:actions`:
+                        response = Object.values(this.provider.actions || {});
+                        break;
+                    case `list:triggers`:
+                        response = Object.values(this.provider.triggers || {});
+                        break;
+                    case `list:credentials`:
+                        response = Object.values(this.provider.credentials || {});
+                        break;
+                    case `list:sources`:
+                        response = Object.values(this.provider.sources || {});
+                        break;
+                    case `list:locales`:
+                        const i18nInstance = (0, locales_1.i18n)({ directory: `node_modules/prow-hubspot-repository/locales` });
+                        response = i18nInstance.i18n.getLocales().map((l) => {
+                            i18nInstance.i18n.setLocale(l);
+                            return {
+                                code: l,
+                                catalog: i18nInstance.i18n.getCatalog(),
+                            };
+                        });
+                        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 f = lodash_1.default.get(mEvent, req.params.function);
+                        if (!f || typeof f !== `function`) {
+                            throw new Error(`Invalid function ${req.params.function}`);
+                        }
+                        const invokeInstance = (0, core_1.core)({
+                            env: req.context.environment,
+                            localization: req.context.localization,
+                        });
+                        response = await f(invokeInstance, req.params.configuration);
+                        break;
+                    default:
+                        throw new Error(`Invalid command`);
+                }
+                return response;
+            }
+            catch (e) {
+                throw e;
+            }
+        };
+        const providerValidation = (0, provider_1.providerSchema)().validate(provider);
+        if (providerValidation.error) {
+            throw new Error(`Invalid provider for protocol`);
+        }
+        this.provider = provider;
+    }
+}
+exports.Protocol = Protocol;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beseif-solutions/prow-core",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "description": "Prow core functionalities and classes",
   "main": "dist/index.js",
   "scripts": {
@@ -17,7 +17,6 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@types/express": "^4.17.21",
     "axios": "^1.7.7",
     "dotenv": "^16.4.5",
     "handlebars": "^4.7.8",

package/src/index.ts

@@ -6,5 +6,6 @@ export { Action, actionOutputSchema, actionSchema, Event, eventSchema, Immediate
 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 } from './minified-utils/locales';
+export { i18n, localizeFields, localizeInputs, localizeOutputs, localizeProperties, LocalizedField, LocalizedProperties } from './minified-utils/locales';
 export { Properties } from './minified-utils/properties';
+export { Protocol } from './minified-utils/protocol';

package/src/minified-utils/locales.ts

@@ -6,13 +6,14 @@ import { Credentials, SessionCredentials, StaticCredentials } from '../entities/
 import { Action, ConnectableEvent, Trigger } from '../entities/events';
 import { Field, SelectFieldChoice } from './fields';
 import { Provider } from '../entities/provider';
+import { Source } from '../entities/source';
 
-type LocalizedField = {
+export type LocalizedField = {
   label: string,
   help: string,
 };
 
-type LocalizedProperties = {
+export type LocalizedProperties = {
   name: string,
   description: string,
 };
@@ -139,7 +140,7 @@ const localizeField = (
 
 export const localizeFields = (
   t: ReturnType<typeof i18n>[`t`],
-  element: Action | Trigger | StaticCredentials | SessionCredentials,
+  element: Action | Trigger | StaticCredentials | SessionCredentials | Source,
 ): Field<LocalizedField>[] => {
   const response: Field<LocalizedField>[] = [];
   if (element[`fields`] && element[`fields`].length > 0) {
@@ -150,7 +151,7 @@ export const localizeFields = (
 
 export const localizeProperties = (
   t: ReturnType<typeof i18n>[`t`],
-  element: Action | Trigger | Credentials | Provider,
+  element: Action | Trigger | Credentials | Provider | Source,
 ): LocalizedProperties => ({
   name: t(`${element.id}.name`, { fallback: true }),
   description: t(`${element.id}.description`),

package/src/minified-utils/protocol.ts

@@ -0,0 +1,164 @@
+import _ from "lodash";
+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(),
+  id: Joi.string().required(),
+  params: Joi.object({
+    function: Joi.string().required(),
+    configuration: Joi.object().required(),
+  }).required(),
+  context: Joi.object({
+    environment: Joi.object().required(),
+    localization: Joi.object({
+      locale: Joi.string().required(),
+      catalog: Joi.object().required(),
+    }).required(),
+  }).required(),
+}).required();
+
+const credentialListSchema = Joi.object({
+  command: Joi.string().valid(`list:credentials`).required(),
+}).required();
+
+const actionListSchema = Joi.object({
+  command: Joi.string().valid(`list:actions`).required(),
+}).required();
+
+const triggerListSchema = Joi.object({
+  command: Joi.string().valid(`list:triggers`).required(),
+}).required();
+
+const sourceListSchema = Joi.object({
+  command: Joi.string().valid(`list:sources`).required(),
+}).required();
+
+const localeListSchema = Joi.object({
+  command: Joi.string().valid(`list:locales`).required(),
+  locale: Joi.string().required(),
+}).required();
+
+const commandSchema = Joi.alternatives(
+  invokeSchema,
+  credentialListSchema,
+  actionListSchema,
+  triggerListSchema,
+  sourceListSchema,
+  localeListSchema,
+);
+
+export class Protocol {
+
+  private readonly provider: Provider;
+
+  constructor(provider: Provider) {
+    const providerValidation = providerSchema().validate(provider);
+    if (providerValidation.error) { throw new Error(`Invalid provider for protocol`); }
+    this.provider = provider;
+  }
+
+  public evaluate = async (req: Protocol.Command): Promise<any> => {
+    try {
+      const validation = commandSchema.validate(req);
+      if (validation.error) { throw new Error(`Invalid request: ${validation.error.message}`); }
+
+      let response: any;
+      switch (req.command) {
+        case `list:actions`:
+          response = Object.values(this.provider.actions || {});
+          break;
+        case `list:triggers`:
+          response = Object.values(this.provider.triggers || {});
+          break;
+        case `list:credentials`:
+          response = Object.values(this.provider.credentials || {});
+          break;
+        case `list:sources`:
+          response = Object.values(this.provider.sources || {});
+          break;
+        case `list:locales`:
+          const i18nInstance = i18n({ directory: `node_modules/prow-hubspot-repository/locales` });
+          response = i18nInstance.i18n.getLocales().map((l) => {
+            i18nInstance.i18n.setLocale(l);
+            return {
+              code: l,
+              catalog: i18nInstance.i18n.getCatalog(),
+            };
+          });
+          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 f = _.get(mEvent, req.params.function);
+          if (!f || typeof f !== `function`) { throw new Error(`Invalid function ${req.params.function}`); }
+
+          const invokeInstance = core({
+            env: req.context.environment,
+            localization: req.context.localization,
+          });
+
+          response = await f(invokeInstance, req.params.configuration);
+          break;
+        default:
+          throw new Error(`Invalid command`);
+      }
+
+      return response;
+    } catch (e) { throw e; }
+  };
+}
+
+export namespace Protocol {
+
+  export type Model = `action` | `trigger` | `credentials`;
+
+  export type Invoke = {
+    command: `invoke`,
+    model: Protocol.Model,
+    id: string,
+    params: {
+      function: string,
+      configuration: Record<string, any>,
+    },
+    context: {
+      environment: Record<string, any>,
+      localization: {
+        locale: string,
+        catalog: Record<string, any>,
+      },
+    },
+  };
+
+  export type CredentialList = {
+    command: `list:credentials`,
+  };
+
+  export type ActionList = {
+    command: `list:actions`,
+  };
+
+  export type TriggerList = {
+    command: `list:triggers`,
+  };
+
+  export type SourceList = {
+    command: `list:sources`,
+  };
+
+  export type LocaleList = {
+    command: `list:locales`,
+    locale: string,
+  };
+
+  export type Command = Invoke | CredentialList | ActionList | TriggerList | SourceList | LocaleList;
+}