@beseif-solutions/prow-core 0.4.1 → 0.4.3

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 export { Core, core } from './core';
 export { CoreFunction, idSchema } from './entities/commons';
-export { Credentials, credentialsSchema, OAuthCredentials, oauthCredentialsSchema, SessionCredentials, sessionCredentialsSchema, StaticCredentials, staticCredentialsSchema } from './entities/credentials';
-export { Action, actionOutputSchema, actionSchema, AsyncAction, Event, eventSchema, ImmediateTrigger, immediateTriggerSchema, Request, ScheduledTrigger, scheduledTriggerSchema, SyncAction, syncActionSchema, Trigger, triggerOutputSchema, triggerSchema } from './entities/events';
+export { Credentials, OAuthCredentials, SessionCredentials, StaticCredentials, credentialsSchema, oauthCredentialsSchema, sessionCredentialsSchema, staticCredentialsSchema } from './entities/credentials';
+export { Action, AsyncAction, Event, ImmediateTrigger, Request, ScheduledTrigger, SyncAction, Trigger, actionOutputSchema, actionSchema, eventSchema, immediateTriggerSchema, scheduledTriggerSchema, syncActionSchema, triggerOutputSchema, triggerSchema } from './entities/events';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
 export { hasExpression, isExpression, split } from './minified-utils/context';
-export { alter, Condition, extract, Field, fieldSchema, fieldsSchema, File, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
-export { DEFAULT_LOCALE, i18n, LocalizedField, LocalizedProperties, localizeFields, localizeGroup, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
+export { Condition, Field, File, SelectFieldChoice, ValidationResult, alter, extract, fieldSchema, fieldsSchema, validate } from './minified-utils/fields';
+export { DEFAULT_LOCALE, LocalizedField, LocalizedProperties, i18n, localizeFields, localizeGroup, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
 export { Properties } from './minified-utils/properties';
 export { Protocol } from './minified-utils/protocol';

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

@@ -11,7 +11,6 @@ type Common = {
     required?: boolean;
     as_password?: boolean;
     show?: boolean;
-    show_label?: boolean;
     t?: string;
 } & ({
     as_array?: false;
@@ -20,7 +19,7 @@ type Common = {
     array_min?: number;
     array_max?: number;
     array_length?: number;
-});
+}) & Record<`experimental_${string}`, any>;
 export type Field<Extend = Record<never, never>> = Common & InputField<Extend>;
 type InputField<Extend = Record<never, never>> = (AnyInputField<Extend> | StringInputField<Extend> | NumberInputField<Extend> | BooleanInputField<Extend> | DateTimeInputField<Extend> | DateInputField<Extend> | TimeInputField<Extend> | DictInputField<Extend> | FileInputField<Extend>) & Extend;
 type Any = string | number | boolean | Any[] | {
@@ -102,6 +101,7 @@ type SelectField<Values = string | number | boolean | File, Extend = Record<neve
 export type SelectFieldChoice<Values = string | number | boolean | File, Extend = Record<never, never>> = {
     key: string;
     value: Values;
+    group?: string;
 } & Extend;
 type CustomDisplayTextField = {
     format: `textarea` | `rich-text` | `markdown`;

package/dist/minified-utils/fields.js

@@ -20,7 +20,6 @@ const commonFieldSchema = () => joi_1.default.object({
     required: joi_1.default.bool(),
     as_password: joi_1.default.bool(),
     show: joi_1.default.bool(),
-    show_label: joi_1.default.bool().default(true),
     t: joi_1.default.string(),
     as_array: joi_1.default.bool(),
     array_min: joi_1.default.when(`as_array`, {
@@ -38,7 +37,8 @@ const commonFieldSchema = () => joi_1.default.object({
         then: joi_1.default.number(),
         otherwise: joi_1.default.forbidden(),
     }),
-});
+}).concat(joi_1.default.object()
+    .pattern(joi_1.default.string().regex(/^experimental_/), joi_1.default.any()));
 const types = [`any`, `string`, `number`, `boolean`, `date`, `datetime`, `time`, `dict`, `file`];
 const inputFieldBaseSchema = () => joi_1.default.object({
     type: joi_1.default.string().required()
@@ -49,6 +49,7 @@ const inputFieldBaseSchema = () => joi_1.default.object({
 const choiceSchema = (type) => joi_1.default.object({
     key: joi_1.default.string().required(),
     value: type.required(),
+    group: joi_1.default.string(),
 }).unknown();
 const choicesSchema = (type) => joi_1.default.alternatives(joi_1.default.string(), joi_1.default.array().min(1)
     .items(choiceSchema(type)));
@@ -185,7 +186,8 @@ const fileReplacer = (field) => ({
         },
     ],
     default: field.default,
-    ...lodash_1.default.pick(field, [`altered_by`, `disabled`, `required`, `as_password`, `show`, `show_label`, `as_array`, `array_min`, `array_max`, `array_length`]),
+    ...lodash_1.default.pick(field, [`altered_by`, `disabled`, `required`, `as_password`, `show`, `as_array`, `array_min`, `array_max`, `array_length`]),
+    ...Object.assign({}, ...Object.entries(field).map(([k, v]) => k.startsWith(`experimental_`) ? { [k]: v } : {})),
 });
 const fileInputFieldSchema = () => joi_1.default.object({
     default: defaultSchema(fileSchema()),

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

@@ -7,6 +7,7 @@ import { Source } from '../entities/source';
 export type LocalizedField = {
     label: string;
     help: string;
+    ui?: Record<string, any>;
 };
 export type LocalizedProperties = {
     name: string;

package/dist/minified-utils/locales.js

@@ -98,6 +98,7 @@ const localizeField = (t, element, field, recursive = {}) => {
     const root = field.t || recursive.t || `${element}.fields`;
     field.label = t(`${root}.${key}.label`, { fallback: true });
     field.help = t(`${root}.${key}.help`);
+    field.ui = t(`${root}.${key}.ui`, { fallback: true, optional: true }) || {};
     if (field.type === `dict` && field.items) {
         field.items = field.items.map((f) => localizeField(t, element, f, { parent: `${key}.items`, t: field.t }));
     }
@@ -106,6 +107,16 @@ const localizeField = (t, element, field, recursive = {}) => {
             ...fc,
             label: t(`${root}.${key}.choices.${fc.key}.label`, { fallback: true }),
             help: t(`${root}.${key}.choices.${fc.key}.help`),
+            ui: {
+                ...t(`${root}.${key}.choices.${fc.key}.ui`, { fallback: true, optional: true }) || {},
+                ...fc.group && {
+                    group: {
+                        key: fc.group,
+                        label: t(`${root}.${key}.groups.${fc.group}.label`, { fallback: true }),
+                        help: t(`${root}.${key}.groups.${fc.group}.help`),
+                    },
+                },
+            },
         }));
     }
     return field;

package/package.json

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

package/src/entities/events.ts

@@ -322,8 +322,6 @@ export const asyncActionSchema = () =>
       .min(1)
       .required(),
     functions: Joi.object({
-      // mount: Joi.function(),
-      // unmount: Joi.function(),
       execute: Joi.function().required(),
       handle: Joi.function().required(),
       fire: Joi.function(),

package/src/index.ts

@@ -1,11 +1,11 @@
 export { Core, core } from './core';
 export { CoreFunction, idSchema } from './entities/commons';
-export { Credentials, credentialsSchema, OAuthCredentials, oauthCredentialsSchema, SessionCredentials, sessionCredentialsSchema, StaticCredentials, staticCredentialsSchema } from './entities/credentials';
-export { Action, actionOutputSchema, actionSchema, AsyncAction, Event, eventSchema, ImmediateTrigger, immediateTriggerSchema, Request, ScheduledTrigger, scheduledTriggerSchema, SyncAction, syncActionSchema, Trigger, triggerOutputSchema, triggerSchema } from './entities/events';
+export { Credentials, OAuthCredentials, SessionCredentials, StaticCredentials, credentialsSchema, oauthCredentialsSchema, sessionCredentialsSchema, staticCredentialsSchema } from './entities/credentials';
+export { Action, AsyncAction, Event, ImmediateTrigger, Request, ScheduledTrigger, SyncAction, Trigger, actionOutputSchema, actionSchema, eventSchema, immediateTriggerSchema, scheduledTriggerSchema, syncActionSchema, triggerOutputSchema, triggerSchema } from './entities/events';
 export { Provider, providerSchema } from './entities/provider';
 export { Source } from './entities/source';
 export { hasExpression, isExpression, split } from './minified-utils/context';
-export { alter, Condition, extract, Field, fieldSchema, fieldsSchema, File, SelectFieldChoice, validate, ValidationResult } from './minified-utils/fields';
-export { DEFAULT_LOCALE, i18n, LocalizedField, LocalizedProperties, localizeFields, localizeGroup, localizeInputs, localizeOutputs, localizeProperties } from './minified-utils/locales';
+export { Condition, Field, File, SelectFieldChoice, ValidationResult, alter, extract, fieldSchema, fieldsSchema, validate } from './minified-utils/fields';
+export { DEFAULT_LOCALE, LocalizedField, LocalizedProperties, i18n, 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/fields.ts

@@ -16,7 +16,6 @@ type Common = {
   required?: boolean,
   as_password?: boolean,
   show?: boolean,
-  show_label?: boolean,
   t?: string,
 } & ({
   as_array?: false,
@@ -25,7 +24,10 @@ type Common = {
   array_min?: number,
   array_max?: number,
   array_length?: number,
-});
+})
+  // experimental properties for custom front features
+  & Record<`experimental_${string}`, any>
+  ;
 
 export type Field<Extend = Record<never, never>> = Common & InputField<Extend>;
 
@@ -154,6 +156,7 @@ type SelectField<Values = string | number | boolean | File, Extend = Record<neve
 export type SelectFieldChoice<Values = string | number | boolean | File, Extend = Record<never, never>> = {
   key: string,
   value: Values,
+  group?: string,
 } & Extend;
 
 /* custom display configuration */
@@ -194,7 +197,6 @@ const commonFieldSchema = () =>
     required: Joi.bool(),
     as_password: Joi.bool(),
     show: Joi.bool(),
-    show_label: Joi.bool().default(true),
     t: Joi.string(),
     as_array: Joi.bool(),
     array_min: Joi.when(`as_array`, {
@@ -212,7 +214,8 @@ const commonFieldSchema = () =>
       then: Joi.number(),
       otherwise: Joi.forbidden(),
     }),
-  });
+  }).concat(Joi.object() // experimental properties for custom front features
+    .pattern(Joi.string().regex(/^experimental_/), Joi.any()));
 
 const types = [`any`, `string`, `number`, `boolean`, `date`, `datetime`, `time`, `dict`, `file`];
 
@@ -229,6 +232,7 @@ const choiceSchema = (type: Joi.Schema) =>
   Joi.object({
     key: Joi.string().required(),
     value: type.required(),
+    group: Joi.string(),
   }).unknown();
 
 const choicesSchema = (type: Joi.Schema) =>
@@ -398,7 +402,8 @@ const fileReplacer = (field: Common & FileInputField): Field => ({
     },
   ],
   default: field.default,
-  ..._.pick(field, [`altered_by`, `disabled`, `required`, `as_password`, `show`, `show_label`, `as_array`, `array_min`, `array_max`, `array_length`]),
+  ..._.pick(field, [`altered_by`, `disabled`, `required`, `as_password`, `show`, `as_array`, `array_min`, `array_max`, `array_length`]),
+  ...Object.assign({}, ...Object.entries(field).map(([k, v]) => k.startsWith(`experimental_`) ? { [k]: v } : {})),
 }) as Field;
 
 const fileInputFieldSchema = () =>

package/src/minified-utils/locales.ts

@@ -11,6 +11,7 @@ import { Source } from '../entities/source';
 export type LocalizedField = {
   label: string,
   help: string,
+  ui?: Record<string, any>,
 };
 
 export type LocalizedProperties = {
@@ -142,14 +143,25 @@ const localizeField = (
 
   field.label = t(`${root}.${key}.label`, { fallback: true });
   field.help = t(`${root}.${key}.help`);
+  field.ui = t(`${root}.${key}.ui`, { fallback: true, optional: true }) || {};
 
   if (field.type === `dict` && field.items) {
     field.items = field.items.map((f) => localizeField(t, element, f, { parent: `${key}.items`, t: field.t }));
   } else if (`format` in field && field.format === `select` && _.isArray(field.choices)) {
-    field.choices = field.choices.map((fc: SelectFieldChoice<any, LocalizedField>) => ({
+    field.choices = field.choices.map((fc: SelectFieldChoice<any, {}>): SelectFieldChoice<any, LocalizedField> => ({
       ...fc,
       label: t(`${root}.${key}.choices.${fc.key}.label`, { fallback: true }),
       help: t(`${root}.${key}.choices.${fc.key}.help`),
+      ui: {
+        ...t(`${root}.${key}.choices.${fc.key}.ui`, { fallback: true, optional: true }) || {},
+        ...fc.group && {
+          group: {
+            key: fc.group,
+            label: t(`${root}.${key}.groups.${fc.group}.label`, { fallback: true }),
+            help: t(`${root}.${key}.groups.${fc.group}.help`),
+          },
+        },
+      },
     }));
   }