@beseif-solutions/prow-core 0.0.22 → 0.0.24

package/dist/core.d.ts

@@ -1,14 +1,14 @@
 import axios from "axios";
 import _ from "lodash";
 import moment from "moment-timezone";
-import { Env } from "./minified-utils/env";
+import { Properties } from "./minified-utils/properties";
 import { i18n } from "./minified-utils/locales";
 import Joi from "joi";
 export type Core = {
     axios: typeof axios;
     moment: typeof moment;
     lodash: typeof _;
-    env: Env;
+    env: Properties;
     t: ReturnType<typeof i18n>[`t`];
     joi: typeof Joi;
 };

package/dist/core.js

@@ -8,7 +8,7 @@ const axios_1 = __importDefault(require("axios"));
 const lodash_1 = __importDefault(require("lodash"));
 const moment_timezone_1 = __importDefault(require("moment-timezone"));
 const proxy_1 = require("./minified-utils/proxy");
-const env_1 = require("./minified-utils/env");
+const properties_1 = require("./minified-utils/properties");
 const locales_1 = require("./minified-utils/locales");
 const path_1 = __importDefault(require("path"));
 const joi_1 = __importDefault(require("joi"));
@@ -39,7 +39,7 @@ const core = (options) => ({
     }),
     moment: moment_timezone_1.default,
     lodash: lodash_1.default,
-    env: new env_1.Env(options.path),
+    env: new properties_1.Properties(options.path, `.env`),
     t: (0, locales_1.i18n)(path_1.default.join(options.path, `/locales`), { locale: options.locale }).t,
     joi: joi_1.default,
 });

package/dist/entities/category.js

@@ -11,7 +11,7 @@ const getCategories = async () => {
         if (!data || typeof data !== `string`) {
             throw new Error(`Could not obtain category list`);
         }
-        return data.split(`\n`).map((d) => d.trim());
+        return data.split(`\n`).map((d) => d.trim()).filter((d) => d);
     }
     catch (e) {
         throw e;

package/dist/entities/credentials.d.ts

@@ -10,6 +10,7 @@ type CommonCredentials<Config extends CredentialsConfig = {}> = Common<Config> &
             credentials: Config[`credentials`];
             inputs: undefined;
             outputs: {
+                username?: string;
                 valid: boolean;
             };
         }>;
@@ -71,6 +72,16 @@ export type SessionCredentials<Config extends CredentialsConfig = {}> = CommonCr
                 credentials: Config[`credentials`];
             };
         }>;
+        refresh?: CoreFunction<{
+            credentials: Config[`credentials`];
+            inputs: {
+                fields: Record<string, any>;
+            };
+            outputs: {
+                username?: string;
+                credentials: Config[`credentials`];
+            };
+        }>;
     };
 };
 export type StaticCredentials<Config extends CredentialsConfig = {}> = CommonCredentials<Config> & {

package/dist/entities/credentials.js

@@ -30,6 +30,7 @@ const sessionCredentialsSchema = () => joi_1.default.object({
     type: joi_1.default.valid(`session`).required(),
     functions: joi_1.default.object({
         connect: joi_1.default.function().required(),
+        refresh: joi_1.default.function(),
     }).required(),
 })
     .concat(commonCredentialsSchema())

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export { Action, Event, ImmediateTrigger, ScheduledTrigger, Trigger, actionSchem
 export { Provider, providerSchema } from './entities/provider';
 export { Field, SelectFieldChoice, ValidationResult, extract, fieldSchema, fieldsSchema, validate } from './minified-utils/fields';
 export { i18n, localizeFields, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
+export { Properties } from './minified-utils/properties';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.localizeProperties = exports.localizeOutputs = exports.localizeInputs = exports.localizeFields = exports.i18n = exports.validate = exports.fieldsSchema = exports.fieldSchema = exports.extract = exports.providerSchema = exports.triggerSchema = exports.scheduledTriggerSchema = exports.immediateTriggerSchema = exports.eventSchema = exports.actionSchema = exports.sessionCredentialsSchema = exports.staticCredentialsSchema = exports.oauthCredentialsSchema = exports.credentialsSchema = exports.idSchema = exports.getCategories = exports.core = void 0;
+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.scheduledTriggerSchema = exports.immediateTriggerSchema = exports.eventSchema = exports.actionSchema = exports.sessionCredentialsSchema = exports.staticCredentialsSchema = 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");
@@ -31,3 +31,5 @@ Object.defineProperty(exports, "localizeFields", { enumerable: true, get: functi
 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; } });
+var properties_1 = require("./minified-utils/properties");
+Object.defineProperty(exports, "Properties", { enumerable: true, get: function () { return properties_1.Properties; } });

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

@@ -0,0 +1,8 @@
+export declare class Properties {
+    private readonly filepath;
+    private readonly properties;
+    private readonly getFile;
+    constructor(root: string, filename: any);
+    readonly read: (name: string, unknown?: boolean) => Promise<string>;
+    readonly write: (name: string, value: string) => Promise<void>;
+}

package/dist/minified-utils/{env.js → properties.js}

@@ -3,15 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Env = void 0;
+exports.Properties = void 0;
 const dotenv_1 = require("dotenv");
 const fs_1 = require("fs");
 const lodash_1 = __importDefault(require("lodash"));
 const path_1 = __importDefault(require("path"));
-const readline_1 = require("readline");
-class Env {
-    constructor(root) {
-        this.getEnv = (flag) => {
+class Properties {
+    constructor(root, filename) {
+        this.getFile = (flag) => {
             try {
                 const fd = (0, fs_1.openSync)(this.filepath, flag);
                 const buffer = (0, fs_1.readFileSync)(fd);
@@ -22,19 +21,12 @@ class Env {
                 throw e;
             }
         };
-        this.read = async (name, options = {}) => {
+        this.read = async (name, unknown = false) => {
             try {
-                let value;
-                if (!lodash_1.default.has(this.env, name)) {
-                    if (!options.create) {
-                        throw new Error(`Environment variable not found: ${name}`);
-                    }
-                    value = await this.prompt(`${name}: `);
-                    await this.write(name, value);
-                }
-                else {
-                    value = lodash_1.default.get(this.env, name);
+                if (!lodash_1.default.has(this.properties, name) && !unknown) {
+                    throw new Error(`Environment variable not found: ${name}`);
                 }
+                const value = lodash_1.default.get(this.properties, name, undefined);
                 return value;
             }
             catch (e) {
@@ -44,10 +36,10 @@ class Env {
         this.write = async (name, value) => {
             try {
                 const fd = (0, fs_1.openSync)(this.filepath, `w`);
-                this.env[name] = value;
+                this.properties[name] = value;
                 const arr = [];
-                for (const key of Object.keys(this.env)) {
-                    arr.push(`${key}=${this.env[key]}`);
+                for (const key of Object.keys(this.properties)) {
+                    arr.push(`${key}=${this.properties[key]}`);
                 }
                 const buffer = Buffer.from(arr.join(`\n`));
                 (0, fs_1.writeSync)(fd, buffer, 0, buffer.length);
@@ -57,35 +49,19 @@ class Env {
                 throw e;
             }
         };
-        this.prompt = async (text) => new Promise(async (resolve, reject) => {
-            try {
-                const stdin = (0, readline_1.createInterface)({
-                    input: process.stdin,
-                    output: process.stdout,
-                });
-                stdin.on(`close`, () => { reject(`Aborted`); });
-                stdin.question(text, (answer) => {
-                    resolve(answer);
-                    stdin.close();
-                });
-            }
-            catch (e) {
-                reject(e.message || e);
-            }
-        });
         if (path_1.default.isAbsolute(root)) {
-            this.filepath = path_1.default.resolve(root, `.env`);
+            this.filepath = path_1.default.resolve(root, filename);
         }
         else {
             const absolute = process.cwd();
-            this.filepath = path_1.default.resolve(absolute, root, `.env`);
+            this.filepath = path_1.default.resolve(absolute, root, filename);
         }
         try {
-            this.env = this.getEnv(`r`);
+            this.properties = this.getFile(`r`);
         }
         catch (e) {
             if (e?.code === `ENOENT`) {
-                this.env = this.getEnv(`w`);
+                this.properties = this.getFile(`w`);
             }
             else {
                 throw e;
@@ -93,4 +69,4 @@ class Env {
         }
     }
 }
-exports.Env = Env;
+exports.Properties = Properties;

package/package.json

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

package/src/core.ts

@@ -2,7 +2,7 @@ import axios, { AxiosError, AxiosResponse } from "axios";
 import _ from "lodash";
 import moment from "moment-timezone";
 import { accessProxy, logProxy, ProxyLogs } from "./minified-utils/proxy";
-import { Env } from "./minified-utils/env";
+import { Properties } from "./minified-utils/properties";
 import { i18n } from "./minified-utils/locales";
 import path from "path";
 import Joi from "joi";
@@ -11,7 +11,7 @@ export type Core = {
   axios: typeof axios,
   moment: typeof moment,
   lodash: typeof _,
-  env: Env,
+  env: Properties,
   t: ReturnType<typeof i18n>[`t`],
   joi: typeof Joi,
 };
@@ -50,7 +50,7 @@ export const core = (options: CoreOptions): Core => ({
   }),
   moment: moment,
   lodash: _,
-  env: new Env(options.path),
+  env: new Properties(options.path, `.env`),
   t: i18n(path.join(options.path, `/locales`), { locale: options.locale }).t,
   joi: Joi,
 });

package/src/entities/category.ts

@@ -4,6 +4,6 @@ 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());
+    return data.split(`\n`).map((d) => d.trim()).filter((d) => d);
   } catch (e) { throw e; }
 };

package/src/entities/credentials.ts

@@ -11,7 +11,10 @@ type CommonCredentials<Config extends CredentialsConfig = {}> = Common<Config> &
     check: CoreFunction<{
       credentials: Config[`credentials`],
       inputs: undefined,
-      outputs: { valid: boolean },
+      outputs: {
+        username?: string,
+        valid: boolean,
+      },
     }>,
   },
 };
@@ -66,14 +69,14 @@ export type SessionCredentials<Config extends CredentialsConfig = {}> = CommonCr
         credentials: Config[`credentials`],
       },
     }>,
-    // refresh: CoreFunction<{
-    //   credentials: Config[`credentials`],
-    //   inputs: undefined,
-    //   outputs: {
-    //     username?: string,
-    //     credentials: Config[`credentials`],
-    //   },
-    // }>,
+    refresh?: CoreFunction<{
+      credentials: Config[`credentials`],
+      inputs: { fields: Record<string, any> },
+      outputs: {
+        username?: string,
+        credentials: Config[`credentials`],
+      },
+    }>,
   },
 };
 
@@ -112,6 +115,7 @@ export const sessionCredentialsSchema = () =>
     type: Joi.valid(`session`).required(),
     functions: Joi.object({
       connect: Joi.function().required(),
+      refresh: Joi.function(),
     }).required(),
   })
     .concat(commonCredentialsSchema())

package/src/index.ts

@@ -5,4 +5,5 @@ export { Credentials, OAuthCredentials, StaticCredentials, SessionCredentials, c
 export { Action, Event, ImmediateTrigger, ScheduledTrigger, Trigger, actionSchema, eventSchema, immediateTriggerSchema, scheduledTriggerSchema, triggerSchema } from './entities/events';
 export { Provider, providerSchema } from './entities/provider';
 export { Field, SelectFieldChoice, ValidationResult, extract, fieldSchema, fieldsSchema, validate } from './minified-utils/fields';
-export { i18n, localizeFields, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
+export { i18n, localizeFields, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
+export { Properties } from './minified-utils/properties';

package/src/minified-utils/properties.ts

@@ -0,0 +1,61 @@
+import { DotenvParseOutput, parse } from "dotenv";
+import { closeSync, openSync, readFileSync, writeSync } from "fs";
+import _ from "lodash";
+import path from "path";
+
+export class Properties {
+
+  private readonly filepath: string;
+  private readonly properties: DotenvParseOutput;
+
+  private readonly getFile = (flag: `w` | `r`): DotenvParseOutput => {
+    try {
+      const fd = openSync(this.filepath, flag);
+      const buffer = readFileSync(fd);
+      const parsed = parse(buffer);
+      return parsed;
+    } catch (e) { throw e; }
+  };
+
+  constructor(root: string, filename) {
+    if (path.isAbsolute(root)) {
+      this.filepath = path.resolve(root, filename);
+    } else {
+      const absolute = process.cwd();
+      this.filepath = path.resolve(absolute, root, filename);
+    }
+
+    try {
+      this.properties = this.getFile(`r`);
+    } catch (e) {
+      if (e?.code === `ENOENT`) {
+        this.properties = this.getFile(`w`);
+      } else { throw e; }
+    }
+  }
+
+  public readonly read = async (name: string, unknown = false): Promise<string> => {
+    try {
+      if (!_.has(this.properties, name) && !unknown) { throw new Error(`Environment variable not found: ${name}`); }
+      const value = _.get(this.properties, name, undefined);
+      return value;
+    } catch (e) { throw e; }
+  };
+
+  public readonly write = async (name: string, value: string): Promise<void> => {
+    try {
+      const fd = openSync(this.filepath, `w`);
+
+      this.properties[name] = value;
+
+      const arr: string[] = [];
+      for (const key of Object.keys(this.properties)) {
+        arr.push(`${key}=${this.properties[key]}`);
+      }
+
+      const buffer = Buffer.from(arr.join(`\n`));
+      writeSync(fd, buffer, 0, buffer.length);
+      closeSync(fd);
+    } catch (e) { throw e; }
+  };
+}

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

@@ -1,13 +0,0 @@
-type ReadOptions = {
-    create?: boolean;
-};
-export declare class Env {
-    private readonly filepath;
-    private readonly env;
-    private readonly getEnv;
-    constructor(root: string);
-    readonly read: (name: string, options?: ReadOptions) => Promise<string>;
-    readonly write: (name: string, value: string) => Promise<void>;
-    private readonly prompt;
-}
-export {};

package/src/minified-utils/env.ts

@@ -1,90 +0,0 @@
-import { DotenvParseOutput, parse } from "dotenv";
-import { closeSync, openSync, readFileSync, writeSync } from "fs";
-import _ from "lodash";
-import path from "path";
-import { createInterface } from "readline";
-
-type ReadOptions = {
-  create?: boolean,
-};
-
-export class Env {
-
-  private readonly filepath: string;
-  private readonly env: DotenvParseOutput;
-
-  private readonly getEnv = (flag: `w` | `r`): DotenvParseOutput => {
-    try {
-      const fd = openSync(this.filepath, flag);
-      const buffer = readFileSync(fd);
-      const parsed = parse(buffer);
-      return parsed;
-    } catch (e) { throw e; }
-  };
-
-  constructor(root: string) {
-    if (path.isAbsolute(root)) {
-      this.filepath = path.resolve(root, `.env`);
-    } else {
-      const absolute = process.cwd();
-      this.filepath = path.resolve(absolute, root, `.env`);
-    }
-
-    try {
-      this.env = this.getEnv(`r`);
-    } catch (e) {
-      if (e?.code === `ENOENT`) {
-        this.env = this.getEnv(`w`);
-      } else { throw e; }
-    }
-  }
-
-  public readonly read = async (name: string, options: ReadOptions = {}): Promise<string> => {
-    try {
-      let value: string;
-      if (!_.has(this.env, name)) {
-        if (!options.create) { throw new Error(`Environment variable not found: ${name}`); }
-        value = await this.prompt(`${name}: `);
-        await this.write(name, value);
-      } else {
-        value = _.get(this.env, name);
-      }
-
-      return value;
-    } catch (e) { throw e; }
-  };
-
-  public readonly write = async (name: string, value: string): Promise<void> => {
-    try {
-      const fd = openSync(this.filepath, `w`);
-
-      this.env[name] = value;
-
-      const arr: string[] = [];
-      for (const key of Object.keys(this.env)) {
-        arr.push(`${key}=${this.env[key]}`);
-      }
-
-      const buffer = Buffer.from(arr.join(`\n`));
-      writeSync(fd, buffer, 0, buffer.length);
-      closeSync(fd);
-    } catch (e) { throw e; }
-  };
-
-  private readonly prompt = async (text: string): Promise<string> =>
-    new Promise(async (resolve, reject) => {
-      try {
-        const stdin = createInterface({
-          input: process.stdin,
-          output: process.stdout,
-        });
-
-        stdin.on(`close`, () => { reject(`Aborted`); });
-        stdin.question(text, (answer) => {
-          resolve(answer);
-          stdin.close();
-        });
-      } catch (e) { reject(e.message || e); }
-    });
-
-}