@beseif-solutions/prow-core 0.3.10 → 0.3.11

package/dist/index.d.ts

@@ -5,6 +5,6 @@ export { Action, actionOutputSchema, actionSchema, AsyncAction, Event, eventSche
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
 export { alter, Condition, 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 { DEFAULT_LOCALE, 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.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;
+exports.Protocol = exports.Properties = exports.localizeProperties = exports.localizeOutputs = exports.localizeInputs = exports.localizeGroup = exports.localizeFields = exports.i18n = exports.DEFAULT_LOCALE = 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");
@@ -28,6 +28,7 @@ Object.defineProperty(exports, "fieldSchema", { enumerable: true, get: function
 Object.defineProperty(exports, "fieldsSchema", { enumerable: true, get: function () { return fields_1.fieldsSchema; } });
 Object.defineProperty(exports, "validate", { enumerable: true, get: function () { return fields_1.validate; } });
 var locales_1 = require("./minified-utils/locales");
+Object.defineProperty(exports, "DEFAULT_LOCALE", { enumerable: true, get: function () { return locales_1.DEFAULT_LOCALE; } });
 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; } });

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

@@ -11,10 +11,13 @@ export type LocalizedField = {
 export type LocalizedProperties = {
     name: string;
     description: string;
+    help?: Record<string, string>;
 };
 type TOptions = {
     fallback?: boolean;
+    optional?: boolean;
 };
+export declare const DEFAULT_LOCALE = "en";
 export declare const validateDirectory: (directory: string) => boolean;
 type Common = {
     locale?: string;
@@ -27,7 +30,7 @@ export type FromDirectory = Common & {
     locale?: string;
     write?: boolean;
 };
-export type T = (code: string, opts?: TOptions) => string;
+export type T = <S = string>(code: string, opts?: TOptions) => S;
 export declare const i18n: (options: FromCatalog | FromDirectory) => {
     t: T;
     i18n: I18n.I18n;

package/dist/minified-utils/locales.js

@@ -3,12 +3,12 @@ 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.localizeGroup = exports.localizeProperties = exports.localizeFields = exports.i18n = exports.validateDirectory = void 0;
+exports.localizeOutputs = exports.localizeInputs = exports.localizeGroup = exports.localizeProperties = exports.localizeFields = exports.i18n = exports.validateDirectory = exports.DEFAULT_LOCALE = void 0;
 const i18n_1 = __importDefault(require("i18n"));
 const lodash_1 = __importDefault(require("lodash"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
-const DEFAULT_LOCALE = `en`;
+exports.DEFAULT_LOCALE = `en`;
 const validateDirectory = (directory) => {
     try {
         if (!fs_1.default.existsSync(directory)) {
@@ -31,47 +31,57 @@ exports.validateDirectory = validateDirectory;
 const i18n = (options) => {
     try {
         const common = {
-            defaultLocale: DEFAULT_LOCALE,
+            defaultLocale: exports.DEFAULT_LOCALE,
             objectNotation: true,
             autoReload: false,
             missingKeyFn: () => ``,
         };
-        const requestedLocale = options.locale || DEFAULT_LOCALE;
-        let i18nInstance;
+        const requestedLocale = options.locale || exports.DEFAULT_LOCALE;
+        let configuration;
         let activeLocale;
         if (`directory` in options) {
             if (!(0, exports.validateDirectory)(options.directory)) {
                 throw new Error(`Invalid directory: ${options.directory}`);
             }
             const availableLocales = fs_1.default.readdirSync(options.directory).map((file) => path_1.default.basename(file, path_1.default.extname(file)));
-            activeLocale = availableLocales.includes(requestedLocale) ? requestedLocale : DEFAULT_LOCALE;
-            i18nInstance = new i18n_1.default.I18n({
+            activeLocale = availableLocales.includes(requestedLocale) ? requestedLocale : exports.DEFAULT_LOCALE;
+            configuration = {
                 ...common,
                 locales: availableLocales,
                 directory: options.directory,
                 updateFiles: options.write,
                 syncFiles: true,
-            });
+            };
         }
         else if (`catalog` in options) {
             activeLocale = requestedLocale;
-            i18nInstance = new i18n_1.default.I18n({
+            configuration = {
                 ...common,
                 locales: [requestedLocale],
                 staticCatalog: {
                     [requestedLocale]: options.catalog,
                 },
-            });
+            };
         }
         else {
             throw new Error(`Invalid options provided for i18n function`);
         }
+        const i18nInstance = new i18n_1.default.I18n(configuration);
         i18nInstance.setLocale(activeLocale);
         return {
             t: (code, opts = {}) => {
+                if (opts.optional) {
+                    i18nInstance.configure({
+                        ...configuration,
+                        missingKeyFn: () => undefined,
+                    });
+                }
                 let response = i18nInstance.__(code);
                 if (!response && opts.fallback) {
-                    response = i18nInstance.__({ phrase: code, locale: DEFAULT_LOCALE });
+                    response = i18nInstance.__({ phrase: code, locale: exports.DEFAULT_LOCALE });
+                }
+                if (opts.optional) {
+                    i18nInstance.configure(configuration);
                 }
                 return response;
             },
@@ -107,10 +117,14 @@ const localizeFields = (t, element) => {
     return response;
 };
 exports.localizeFields = localizeFields;
-const localizeProperties = (t, element) => ({
-    name: t(`${element.id}.name`, { fallback: true }),
-    description: t(`${element.id}.description`),
-});
+const localizeProperties = (t, element) => {
+    const help = t(`${element.id}.help`, { fallback: true, optional: true });
+    return {
+        name: t(`${element.id}.name`, { fallback: true }),
+        description: t(`${element.id}.description`),
+        ...help && { help: help },
+    };
+};
 exports.localizeProperties = localizeProperties;
 const localizeGroup = (t, element) => ({
     name: t(`ui.groups.${element.ui.group}.name`, { fallback: true }),

package/package.json

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

package/src/index.ts

@@ -5,6 +5,6 @@ export { Action, actionOutputSchema, actionSchema, AsyncAction, Event, eventSche
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
 export { alter, Condition, 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 { DEFAULT_LOCALE, 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

@@ -16,11 +16,12 @@ export type LocalizedField = {
 export type LocalizedProperties = {
   name: string,
   description: string,
+  help?: Record<string, string>,
 };
 
-type TOptions = { fallback?: boolean };
+type TOptions = { fallback?: boolean, optional?: boolean };
 
-const DEFAULT_LOCALE = `en`;
+export const DEFAULT_LOCALE = `en`;
 
 export const validateDirectory = (directory: string): boolean => {
   try {
@@ -54,7 +55,7 @@ export type FromDirectory = Common & {
   write?: boolean,
 };
 
-export type T = (code: string, opts?: TOptions) => string;
+export type T = <S = string>(code: string, opts?: TOptions) => S;
 
 export const i18n = (options: FromCatalog | FromDirectory): { t: T, i18n: I18n.I18n } => {
   try {
@@ -68,7 +69,7 @@ export const i18n = (options: FromCatalog | FromDirectory): { t: T, i18n: I18n.I
 
     const requestedLocale = options.locale || DEFAULT_LOCALE;
 
-    let i18nInstance: I18n.I18n;
+    let configuration: I18n.ConfigurationOptions;
     let activeLocale: string;
     if (`directory` in options) {
       // validate directory
@@ -79,36 +80,50 @@ export const i18n = (options: FromCatalog | FromDirectory): { t: T, i18n: I18n.I
       activeLocale = availableLocales.includes(requestedLocale) ? requestedLocale : DEFAULT_LOCALE;
 
       // create i18n instance
-      i18nInstance = new I18n.I18n({
+      configuration = {
         ...common,
         locales: availableLocales,
         directory: options.directory,
         updateFiles: options.write,
         syncFiles: true,
-      });
+      };
     } else if (`catalog` in options) {
       // get active locale
       activeLocale = requestedLocale;
 
       // create i18n instance
-      i18nInstance = new I18n.I18n({
+      configuration = {
         ...common,
         locales: [requestedLocale],
         staticCatalog: {
           [requestedLocale]: options.catalog,
         },
-      });
+      };
     } else { throw new Error(`Invalid options provided for i18n function`); }
 
+    const i18nInstance = new I18n.I18n(configuration);
     i18nInstance.setLocale(activeLocale);
 
     return {
       t: (code: string, opts: TOptions = {}) => {
+
+        if (opts.optional) {
+          i18nInstance.configure({
+            ...configuration,
+            missingKeyFn: () => undefined,
+          });
+        }
+
         let response = i18nInstance.__(code);
         if (!response && opts.fallback) {
           response = i18nInstance.__({ phrase: code, locale: DEFAULT_LOCALE });
         }
-        return response;
+
+        if (opts.optional) {
+          i18nInstance.configure(configuration);
+        }
+
+        return response as any;
       },
       i18n: i18nInstance,
     };
@@ -152,10 +167,14 @@ export const localizeFields = (
 export const localizeProperties = (
   t: ReturnType<typeof i18n>[`t`],
   element: Action | Trigger | Credentials | Provider | Source,
-): LocalizedProperties => ({
-  name: t(`${element.id}.name`, { fallback: true }),
-  description: t(`${element.id}.description`),
-});
+): LocalizedProperties => {
+  const help = t<Record<string, any>>(`${element.id}.help`, { fallback: true, optional: true });
+  return {
+    name: t(`${element.id}.name`, { fallback: true }),
+    description: t(`${element.id}.description`),
+    ...help && { help: help },
+  };
+};
 
 export const localizeGroup = (
   t: ReturnType<typeof i18n>[`t`],