@omnia/velcron 8.0.91-vnext → 8.0.92-dev

package/models/VelcronDefinitions.d.ts

@@ -1,19 +1,23 @@
-import { VelcronEvent, VelcronOnUpdatedEvent, VelcronOnClosedEvent, VelcronOnCloseRequestedEvent, VelcronOnEditModeEvent, VelcronOnLoadEvent, VelcronOnPressEvent } from "./VelcronEvents";
+import { VelcronOnUpdatedEvent, VelcronOnClosedEvent, VelcronOnCloseRequestedEvent, VelcronOnPressEvent, VelcronSpacing, VelcronStyling, VelcronCustomComponentDefinition, VelcronAppDefinition } from "@omnia/velcron/internal-do-not-import-from-here/shared/models";
 import { VelcroncomponentArrayType, VelcronPrimitiveType } from "./VelcronTypes";
 import { AssignOperators, VelcronHorizontalAlignments, VelcronIconTypes, VelcronActionTypes, VelcronVerticalAlignments } from "./Enums";
-import { VelcronPropertyEditor, useVelcronThemingStore } from "..";
+import { ActivityRendererReference, DynamicState, VelcronDefinition, useVelcronThemingStore } from "..";
+import { GuidValue, PropertyConfiguration, PropertyValue, PropertyDefinition, PropertySetupBase } from "@omnia/fx/models";
 import { useVelcronColorSchemaStore } from "../stores/VelcronColorSchema";
-import { useVelcronBlueprintStore } from "../stores/VelcronBlueprint";
 export interface ResolvedComponentRenderer {
     component: unknown;
     definition: VelcronDefinition;
     customComponent?: boolean;
 }
 export interface BuiltInComponentRenderers {
-    "view": unknown;
+    "velcron": unknown;
+    "flex": unknown;
+    "row": unknown;
+    "column": unknown;
     "card": unknown;
     "text": unknown;
     "image": unknown;
+    "video": unknown;
     "button": unknown;
     "text-input": unknown;
     "progress-circle": unknown;
@@ -24,12 +28,15 @@ export interface BuiltInComponentRenderers {
     "chip": unknown;
     "markdown": unknown;
     "slot": unknown;
+    "property": unknown;
+    "checkbox": unknown;
+    "reference": unknown;
+    "radio": unknown;
 }
 export interface ColorSchemaReference {
     name: string;
     schema: string;
 }
-export type DynamicState = object;
 export interface OnItemRenderedHookResult {
     cssClass: string;
     containerRenderer?: VelcronContainerRenderer;
@@ -40,21 +47,21 @@ export interface VelcronRenderContext {
     currentContext: DynamicState;
     theming?: ReturnType<typeof useVelcronThemingStore>;
     colors?: ReturnType<typeof useVelcronColorSchemaStore>;
-    blueprints?: ReturnType<typeof useVelcronBlueprintStore>;
     actions?: {
-        [name: string]: [];
+        [name: string]: Array<string>;
     };
     components?: Array<VelcronCustomComponentDefinition>;
     properties?: {
         [name: string]: VelcronPrimitiveType | VelcroncomponentArrayType;
     };
     computed?: {
-        [name: string]: [];
+        [name: string]: Array<string>;
     };
     parent?: VelcronRenderContext;
     hooks?: VelcronRenderContextHooks;
     eventHandlers?: VelcronRenderContextEventHandlers;
     editMode?: boolean;
+    disposers: Array<() => void>;
 }
 export interface VelcronRenderContextEventHandlers {
     receiving?: {
@@ -67,6 +74,7 @@ export interface VelcronRenderContextHooks {
     onItemSelected?: ((item: VelcronDefinition) => void);
     onItemRendered?: ((item: VelcronDefinition) => OnItemRenderedHookResult);
     onItemCreatedProps?: ((item: VelcronDefinition) => object);
+    onLoadReference?: ((reference: ActivityRendererReference) => Promise<VelcronDefinition>);
 }
 export interface VelcronContainerRenderer {
     definition: VelcronDefinition;
@@ -91,38 +99,11 @@ export interface VelcronActionWithCondition extends VelcronActionWithAutoAwait {
     trueAction: VelcronAction;
     falseAction: VelcronAction;
 }
-/**
- * Velcron definition base
- */
-export interface VelcronDefinitionBase {
-    /**
-     * The component type
-     */
-    type: string;
-    /**
-     * Custom friendly name of the definition
-     */
-    name?: string;
-    /**
-     * Used for render cache if not specified we auto set it.
-     */
-    key?: string;
-}
-export interface VelcronDefinition extends VelcronDefinitionBase, VelcronDimensionStyling {
-    body?: Array<VelcronDefinition>;
-    style?: VelcronStyling;
-    foreach?: string;
-    if?: string;
-    events?: VelcronEvent;
-}
 export type VelcronBindableProp<TPropType = string> = TPropType | string;
 export interface VelcronDefinitionWithEditMode extends VelcronDefinition {
     edit?: VelcronBindableProp<boolean>;
     bind?: VelcronBindableProp;
 }
-interface VelcronDimensionStyling {
-    padding?: VelcronSpacing;
-}
 export interface VelcronColorStyling {
     colorSchemaType?: string;
     colorType?: string;
@@ -132,75 +113,54 @@ export interface VelcronColorStyling {
 }
 export interface VelcronTextStyling {
     text: string;
+    placeholder?: string;
     typography?: string;
     size?: string;
 }
-export interface VelcronStyling {
-    margin?: number;
-    marginTop?: number;
-    marginRight?: number;
-    marginBottom?: number;
-    marginLeft?: number;
-    padding?: number;
-    paddingTop?: number;
-    paddingRight?: number;
-    paddingBottom?: number;
-    paddingLeft?: number;
-    height?: number | string;
-    width?: number | string;
-}
 export interface VelcronCardStyling extends VelcronStyling {
     elevation: number;
 }
-export interface VelcronSpacing {
-    top?: number | string;
-    right?: number | string;
-    bottom?: number | string;
-    left?: number | string;
-}
 export interface VelcronIcon {
     type: VelcronIconTypes;
     name: string;
 }
-export interface VelcronAppDefinition<TState extends DynamicState = DynamicState> extends VelcronDefinitionBase {
-    type: "velcron";
-    version: string;
-    name: string;
-    body?: Array<VelcronDefinition>;
-    events?: VelcronOnLoadEvent & VelcronOnEditModeEvent;
-    actions?: {
-        [name: string]: [];
-    };
-    components?: Array<VelcronCustomComponentDefinition>;
-    propEditors?: Array<VelcronPropertyEditor>;
-    state?: TState;
-    computed?: {
-        [name: string]: [];
-    };
-}
-export interface VelcronComponentDefinition extends VelcronDefinition {
-    type: string;
-    events: any;
-    properties: [];
-    icon: any;
+export interface VelcronRenderProp {
+    required?: boolean;
+    defaultValue?: any;
 }
 /*** Built-in Components *********************************************************************/
-export interface VelcronViewDefinition extends VelcronDefinition, VelcronColorStyling {
-    type: "view";
+export interface VelcronFlexDefinition extends VelcronDefinition, VelcronColorStyling {
+    type: "flex";
     events?: VelcronOnPressEvent;
-    direction?: "row" | "column" | "row-reverse" | "column-reverse" | string;
-    columnStyle?: object;
-    horizontalAlignment?: VelcronHorizontalAlignments;
-    verticalAlignment?: VelcronVerticalAlignments;
-    grow?: number;
-    absolute?: VelcronSpacing;
     border?: VelcronBorder;
     borderRadius?: VelcronDimensions;
+}
+export interface VelcronFlexRowDefinition extends VelcronDefinition, VelcronColorStyling {
+    type: "row";
+    events?: VelcronOnPressEvent;
+    direction?: VelcronBindableProp<"row" | "row-reverse">;
+    absolute?: VelcronSpacing;
+    hideOverflow?: boolean;
+    wrap?: boolean;
+    gapX?: number | string;
+    gapY?: number | string;
+    alignX?: VelcronHorizontalAlignments;
+    alignY?: VelcronVerticalAlignments;
+    grow?: number | "default";
     width?: number | string;
     minWidth?: number | string;
     height?: number | string;
     minHeight?: number | string;
 }
+export interface VelcronFlexColumnDefinition extends VelcronDefinition, VelcronColorStyling {
+    type: "column";
+    events?: VelcronOnPressEvent;
+    grow?: number;
+    alignY?: VelcronVerticalAlignments;
+    absolute?: VelcronSpacing;
+    width?: number | string;
+    minWidth?: number | string;
+}
 export interface VelcronCardDefinition extends VelcronDefinition, VelcronColorStyling {
     type: "card";
     style?: VelcronCardStyling;
@@ -220,18 +180,30 @@ export declare enum VelcronImageRatios {
 }
 export interface VelcronImageDefinition extends VelcronDefinition {
     type: "image";
-    source: string;
-    ratio: VelcronImageRatios | string;
+    url?: VelcronBindableProp<string>;
+    bind?: VelcronBindableProp<string>;
+    ratio?: VelcronImageRatios | string;
+    width?: number | string;
+    height?: number | string;
     cover?: VelcronBindableProp<boolean>;
     borderRadius?: VelcronDimensions;
     events?: VelcronOnPressEvent;
 }
+export interface VelcronVideoDefinition extends VelcronDefinition {
+    type: "video";
+    url?: VelcronBindableProp<string>;
+    bind?: VelcronBindableProp<string>;
+    aspectRatio?: VelcronBindableProp<"16:9" | "4:3" | "1:1">;
+    autoplay?: VelcronBindableProp<boolean>;
+    muted?: VelcronBindableProp<boolean>;
+}
 export interface VelcronButtonDefinition extends VelcronDefinition {
     type: "button";
     text: string;
     icon?: VelcronIcon;
     disabled?: boolean;
     events?: VelcronOnPressEvent;
+    size?: string;
 }
 export interface VelcronTextInputDefinition extends VelcronDefinition {
     type: "text-input";
@@ -271,7 +243,10 @@ export interface VelcronDimensions {
     left: number | string;
 }
 export interface VelcronBorder extends VelcronDimensions {
-    color: string;
+    colorType?: string;
+    toned?: boolean;
+    opacity?: number;
+    width?: number;
 }
 export interface VelcronChipDefinition extends VelcronDefinition {
     type: "chip";
@@ -282,12 +257,41 @@ export interface VelcronChipDefinition extends VelcronDefinition {
 }
 export interface VelcronSlotDefinition extends VelcronDefinition {
     type: "slot";
-    bind: string;
-    value: VelcroncomponentArrayType;
+    bind: VelcronBindableProp<string>;
+}
+export interface VelcronReferencefinition extends VelcronDefinition {
+    type: "reference";
+    to: ActivityRendererReference;
+}
+export interface VelcronPropertyDefinition extends VelcronDefinition {
+    type: "property";
+    bind: VelcronBindableProp<string>;
+}
+export interface VelcronCheckboxDefinition extends VelcronDefinition {
+    type: "checkbox";
+    label: VelcronBindableProp<string>;
+    value: string;
+    bind: VelcronBindableProp<string>;
+    disabled: VelcronBindableProp<boolean>;
+    events: VelcronOnUpdatedEvent;
+}
+export interface VelcronRadioDefinition extends VelcronDefinition {
+    type: "radio";
+    label: VelcronBindableProp<string>;
+    value: string;
+    bind: VelcronBindableProp<string>;
+    disabled: VelcronBindableProp<boolean>;
+    events: VelcronOnUpdatedEvent;
+}
+export interface VelcronPropertyDefinitionValue {
+    definitionId: GuidValue;
+    value: PropertyValue;
+    configuration: PropertyConfiguration<PropertyDefinition<any, any, any, PropertySetupBase>>;
 }
-export type VelcronCustomComponentDefinition = VelcronComponentDefinition;
 export type VelcronRenderProps<TDefinition> = {
     definition: TDefinition;
     renderContext: VelcronRenderContext;
 };
-export {};
+export type VelcronAppRendererProps = VelcronRenderProps<VelcronAppDefinition> & {
+    rootApp: boolean;
+};

package/models/VelcronDefinitions.js

@@ -5,4 +5,4 @@ var VelcronImageRatios;
 (function (VelcronImageRatios) {
     VelcronImageRatios["square"] = "square";
     VelcronImageRatios["landscape"] = "landscape";
-})(VelcronImageRatios = exports.VelcronImageRatios || (exports.VelcronImageRatios = {}));
+})(VelcronImageRatios || (exports.VelcronImageRatios = VelcronImageRatios = {}));

package/models/VelcronPropertyEditorDefinitions.d.ts

@@ -1,16 +1,7 @@
-import { VelcronImageRatios } from "@omnia/fx-models";
+import { TypographySize, TypographyType, VelcronImageRatios, VelcronPropertyEditor, VelcronSpacing } from "@omnia/fx-models";
 export interface ResolvedPropertyEditor {
     editor: VelcronPropertyEditor;
 }
-export interface VelcronPropertyEditor<TSettings = any> {
-    name?: string;
-    category?: string;
-    type: BuiltInPropertyEditorType | string;
-    settings?: TSettings;
-    stateMapping?: string;
-    propertyMapping?: boolean;
-    component?: unknown;
-}
 export interface BuiltInPropertyEditors {
     text: unknown;
     slider: unknown;
@@ -21,9 +12,9 @@ export interface BuiltInPropertyEditors {
     icon: unknown;
     image: unknown;
     typography: unknown;
+    spacing: unknown;
     "color-schema-type": unknown;
 }
-export type BuiltInPropertyEditorType = "text" | "slider" | "switch" | "alignment" | "color" | "markdown" | "icon" | "image" | "typography" | "color-schema-type";
 export declare enum BuiltInPropertyEditorTypes {
     text = "text",
     slider = "slider",
@@ -34,6 +25,7 @@ export declare enum BuiltInPropertyEditorTypes {
     icon = "icon",
     image = "image",
     typography = "typography",
+    spacing = "spacing",
     "color-schema-type" = "color-schema-type"
 }
 export interface VelcronSliderPropertyEditorSettings {
@@ -41,13 +33,29 @@ export interface VelcronSliderPropertyEditorSettings {
     max: number;
     step: number;
 }
+export interface VelcronTypographyEditorSettings {
+    type: "title" | "text";
+}
+export interface VelcronMarkdownEditorSettings {
+    placeholder: string;
+}
+export interface VelcronSpacingEditorSettings {
+    individualSelection: boolean;
+}
+export interface VelcronTextEditorSettings {
+    type: TypographyType;
+    placeholder: string;
+}
 export interface VelcronSliderPropertyEditor extends VelcronPropertyEditor<VelcronSliderPropertyEditorSettings> {
     type: "slider";
 }
-export interface VelcronTextPropertyEditor extends VelcronPropertyEditor<any> {
+export interface VelcronTextPropertyEditor extends VelcronPropertyEditor<VelcronTextEditorSettings> {
     type: "text";
 }
-export interface VelcronTypographyPropertyEditor extends VelcronPropertyEditor<any> {
+export interface VelcronEnterprisePropertyEditor extends VelcronPropertyEditor<any> {
+    type: "enterprise-property";
+}
+export interface VelcronTypographyPropertyEditor extends VelcronPropertyEditor<VelcronTypographyEditorSettings> {
     type: "typography";
 }
 export interface VelcronSwitchPropertyEditor extends VelcronPropertyEditor<any> {
@@ -65,19 +73,261 @@ export interface VelcronColorSchemaPropertyEditor extends VelcronPropertyEditor<
 export interface VelcronIconPropertyEditor extends VelcronPropertyEditor<any> {
     type: "icon";
 }
-export interface VelcronMarkdownPropertyEditor extends VelcronPropertyEditor<any> {
+export interface VelcronMarkdownPropertyEditor extends VelcronPropertyEditor<VelcronMarkdownEditorSettings> {
     type: "markdown";
 }
 export interface VelcronImagePropertyEditor extends VelcronPropertyEditor<any> {
     type: "image";
 }
+export interface VelcronSpacingPropertyEditor extends VelcronPropertyEditor<VelcronSpacingEditorSettings> {
+    type: "spacing";
+}
+export interface VelcronState {
+    images?: VelcronImagesState;
+    styling?: VelcronStylingState;
+    colorSchemas?: VelcronColorSchemasState;
+    content?: VelcronContentState;
+    header?: VelcronHeaderState;
+    properties?: VelcronPropertiesState;
+    spacing?: VelcronSpacingState;
+}
+export interface VelcronSpacingState {
+    chrome?: VelcronSpacing;
+}
+export interface VelcronHeaderState {
+    title?: VelcronTextState;
+    icon?: string;
+}
+export interface VelcronTextState {
+    text?: string;
+    placeholder?: string;
+    typography?: VelcronTypographyState;
+}
+export interface VelcronTypographyState {
+    type?: TypographyType;
+    size?: TypographySize;
+    toned?: boolean;
+}
 export interface VelcronContentState {
-    content: {
-        caption?: string;
-        main?: string;
-    };
+    caption?: VelcronTextState;
+    main?: VelcronTextState;
+    title?: VelcronTextState;
+    summary?: VelcronTextState;
+}
+export interface VelcronPropertiesState {
+    user: any;
+    mappings: Array<any>;
+}
+export interface VelcronImagesState {
+    main?: VelcronImageState;
+    alt1?: VelcronImageState;
+    alt2?: VelcronImageState;
 }
 export interface VelcronImageState {
     url?: string;
     ratio?: VelcronImageRatios;
+    caption?: VelcronTextState;
+    width?: number;
+    height?: number;
+}
+export interface VelcronStylingState {
+}
+export interface VelcronColorSchemasState {
+    main: VelcronColorSchemaState;
 }
+export interface VelcronColorSchemaState {
+    type?: string;
+    filled?: boolean;
+}
+export declare const VelcronImagesStateBinding: {
+    main: {
+        editor: string;
+        url: string;
+        ratio: string;
+        caption: string;
+        width: string;
+        height: string;
+    };
+    alt1: {
+        editor: string;
+        url: string;
+        ratio: string;
+        caption: string;
+        width: string;
+        height: string;
+    };
+    alt2: {
+        editor: string;
+        url: string;
+        ratio: string;
+        caption: string;
+        width: string;
+        height: string;
+    };
+};
+export declare const VelcronHeaderStateBinding: {
+    title: {
+        text: string;
+        placeholder: string;
+        typography: {
+            editor: any;
+            type: any;
+            size: any;
+            toned: any;
+        };
+    };
+    icon: string;
+};
+export declare const VelcronContentStateBinding: {
+    title: {
+        text: string;
+        placeholder: string;
+        typography: {
+            editor: any;
+            type: any;
+            size: any;
+            toned: any;
+        };
+    };
+    main: {
+        text: string;
+        placeholder: string;
+        typography: {
+            editor: any;
+            type: any;
+            size: any;
+            toned: any;
+        };
+    };
+    caption: {
+        text: string;
+        placeholder: string;
+        typography: {
+            editor: any;
+            type: any;
+            size: any;
+            toned: any;
+        };
+    };
+    summary: {
+        text: string;
+        placeholder: string;
+        typography: {
+            editor: any;
+            type: any;
+            size: any;
+            toned: any;
+        };
+    };
+};
+export declare const VelcronColorSchemasStateBinding: {
+    main: {
+        type: string;
+        filled: string;
+    };
+};
+export declare const VelcronSpacingStateBinding: {
+    chrome: {
+        top: string;
+        right: string;
+        bottom: string;
+        left: string;
+    };
+};
+export declare const VelcronStateBinding: {
+    colorSchemas: {
+        main: {
+            type: string;
+            filled: string;
+        };
+    };
+    images: {
+        main: {
+            editor: string;
+            url: string;
+            ratio: string;
+            caption: string;
+            width: string;
+            height: string;
+        };
+        alt1: {
+            editor: string;
+            url: string;
+            ratio: string;
+            caption: string;
+            width: string;
+            height: string;
+        };
+        alt2: {
+            editor: string;
+            url: string;
+            ratio: string;
+            caption: string;
+            width: string;
+            height: string;
+        };
+    };
+    content: {
+        title: {
+            text: string;
+            placeholder: string;
+            typography: {
+                editor: any;
+                type: any;
+                size: any;
+                toned: any;
+            };
+        };
+        main: {
+            text: string;
+            placeholder: string;
+            typography: {
+                editor: any;
+                type: any;
+                size: any;
+                toned: any;
+            };
+        };
+        caption: {
+            text: string;
+            placeholder: string;
+            typography: {
+                editor: any;
+                type: any;
+                size: any;
+                toned: any;
+            };
+        };
+        summary: {
+            text: string;
+            placeholder: string;
+            typography: {
+                editor: any;
+                type: any;
+                size: any;
+                toned: any;
+            };
+        };
+    };
+    header: {
+        title: {
+            text: string;
+            placeholder: string;
+            typography: {
+                editor: any;
+                type: any;
+                size: any;
+                toned: any;
+            };
+        };
+        icon: string;
+    };
+    spacing: {
+        chrome: {
+            top: string;
+            right: string;
+            bottom: string;
+            left: string;
+        };
+    };
+};