@omnia/fx-models 8.0.23-vnext → 8.0.24-dev

package/internal-do-not-import-from-here/velcron/core/models/VelcronDefinitions.d.ts

@@ -1,61 +1,64 @@
-import { VelcronComponentDescriptor } from "./VelcronDescriptors";
-import { VelcronEvent, VelcronOnChangedEvent, VelcronOnClosedEvent, VelcronOnCloseRequestedEvent, VelcronOnLoadEvent, VelcronOnPressEvent } from "./VelcronEvents";
+import { VelcronEvent, VelcronOnUpdatedEvent, VelcronOnClosedEvent, VelcronOnCloseRequestedEvent, VelcronOnEditModeEvent, VelcronOnLoadEvent, VelcronOnPressEvent } from "./VelcronEvents";
 import { VelcroncomponentArrayType, VelcronPrimitiveType } from "./VelcronTypes";
-import { AssignOperators, VelcronHorizontalAlignments, VelcronIconTypes, VelcronActionTypes, VerticalAlignments } from "./Enums";
-import { ColorSchema, ColorSchemaType, ColorSchemaTypes, useVelcronThemingStore } from "..";
+import { AssignOperators, VelcronHorizontalAlignments, VelcronIconTypes, VelcronActionTypes, VelcronVerticalAlignments } from "./Enums";
+import { DynamicState, VelcronPropertyEditor, 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;
+    customComponent?: boolean;
 }
 export interface BuiltInComponentRenderers {
-    "View": unknown;
-    "Card": unknown;
-    "Text": unknown;
-    "Image": unknown;
-    "Button": unknown;
-    "TextInput": unknown;
-    "ProgressCircle": unknown;
-    "WebView": unknown;
-    "CustomComponent": unknown;
-    "Dialog": unknown;
-    "FlexView": unknown;
-    "Icon": unknown;
-    "Chip": unknown;
+    "velcron": unknown;
+    "view": unknown;
+    "card": unknown;
+    "text": unknown;
+    "image": unknown;
+    "button": unknown;
+    "text-input": unknown;
+    "progress-circle": unknown;
+    "web-view": unknown;
+    "custom-component": unknown;
+    "dialog": unknown;
+    "icon": unknown;
+    "chip": unknown;
+    "markdown": unknown;
+    "slot": unknown;
+    "property": unknown;
+    "checkbox": unknown;
 }
 export interface ColorSchemaReference {
     name: string;
     schema: string;
 }
-export interface VelcronState {
-    colorSchemas?: {
-        [key: string]: ColorSchemaReference;
-    };
-}
 export interface OnItemRenderedHookResult {
     cssClass: string;
     containerRenderer?: VelcronContainerRenderer;
 }
 export interface VelcronRenderContext {
     id?: string;
-    rootContext: VelcronState;
-    currentContext: VelcronState;
+    rootContext: DynamicState;
+    currentContext: DynamicState;
     theming?: ReturnType<typeof useVelcronThemingStore>;
-    colorSchemaType?: ColorSchemaTypes | ColorSchemaType;
-    colorSchema?: ColorSchema;
+    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 +70,7 @@ export interface VelcronRenderContextHooks {
     dialogVisibilityChanged?: ((visible: boolean) => void);
     onItemSelected?: ((item: VelcronDefinition) => void);
     onItemRendered?: ((item: VelcronDefinition) => OnItemRenderedHookResult);
+    onItemCreatedProps?: ((item: VelcronDefinition) => object);
 }
 export interface VelcronContainerRenderer {
     definition: VelcronDefinition;
@@ -108,18 +112,35 @@ export interface VelcronDefinitionBase {
      */
     key?: string;
 }
-export interface VelcronCustomThemeSettings {
-    colorSchema?: string;
-    color?: string;
-    opacity?: number;
-}
-export interface VelcronDefinition extends VelcronDefinitionBase {
+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 {
+    margin?: VelcronSpacing;
+    padding?: VelcronSpacing;
+}
+export interface VelcronColorStyling {
+    colorSchemaType?: string;
+    colorType?: string;
+    filled?: boolean;
+    toned?: boolean;
+    color?: string;
+}
+export interface VelcronTextStyling {
+    text: string;
+    placeholder?: string;
+    typography?: string;
+    size?: string;
+}
 export interface VelcronStyling {
     margin?: number;
     marginTop?: number;
@@ -138,131 +159,169 @@ export interface VelcronCardStyling extends VelcronStyling {
     elevation: number;
 }
 export interface VelcronSpacing {
-    top: number;
-    right: number;
-    bottom: number;
-    left: number;
+    top?: number | string;
+    right?: number | string;
+    bottom?: number | string;
+    left?: number | string;
 }
 export interface VelcronIcon {
     type: VelcronIconTypes;
     name: string;
 }
-export interface VelcronAppDefinition extends VelcronDefinitionBase {
-    type: "Velcron";
+export interface VelcronAppDefinition<TState extends DynamicState = DynamicState> extends VelcronDefinitionBase {
+    type: "velcron";
+    version?: string;
+    name?: string;
     body?: Array<VelcronDefinition>;
-    events?: VelcronOnLoadEvent & VelcronOnPressEvent;
+    events?: VelcronOnLoadEvent & VelcronOnEditModeEvent;
     actions?: {
-        [name: string]: [];
+        [name: string]: Array<string>;
     };
     components?: Array<VelcronCustomComponentDefinition>;
-    state?: VelcronState;
+    propEditors?: Array<VelcronPropertyEditor>;
+    state?: TState;
     computed?: {
-        [name: string]: [];
+        [name: string]: Array<string>;
     };
 }
 export interface VelcronComponentDefinition extends VelcronDefinition {
     type: string;
-    events: VelcronOnPressEvent;
+    events?: any;
+    properties?: {
+        [name: string]: any;
+    };
+    icon?: any;
+}
+export interface VelcronRenderProp {
+    required?: boolean;
+    defaultValue?: any;
 }
 /*** Built-in Components *********************************************************************/
-export interface VelcronViewDefinition extends VelcronDefinition {
-    type: "View";
-    style?: VelcronStyling;
+export interface VelcronViewDefinition extends VelcronDefinition, VelcronColorStyling {
+    type: "view";
     events?: VelcronOnPressEvent;
+    direction?: VelcronBindableProp<"row" | "column" | "row-reverse" | "column-reverse">;
+    columnStyle?: object;
+    hAlign?: VelcronHorizontalAlignments;
+    vAlign?: VelcronVerticalAlignments;
+    grow?: number;
+    absolute?: VelcronSpacing;
+    border?: VelcronBorder;
+    borderRadius?: VelcronDimensions;
+    width?: number | string;
+    minWidth?: number | string;
+    height?: number | string;
+    minHeight?: number | string;
 }
-export interface VelcronCardDefinition extends VelcronDefinition, VelcronCustomThemeSettings {
-    type: "Card";
+export interface VelcronCardDefinition extends VelcronDefinition, VelcronColorStyling {
+    type: "card";
     style?: VelcronCardStyling;
     footer?: Array<VelcronDefinition>;
     events?: VelcronOnPressEvent;
 }
-export interface VelcronTextDefinition extends VelcronDefinition {
-    type: "Text";
-    text: string;
-    color?: string;
-    lineClamp: number;
-    noWrap: boolean;
-    typography?: string;
-    events?: VelcronOnPressEvent;
+export interface VelcronTextDefinition extends VelcronDefinitionWithEditMode, VelcronColorStyling, VelcronTextStyling {
+    type: "text";
+    editLabel?: VelcronBindableProp;
+    lineClamp?: number;
+    noWrap?: boolean;
+    events?: VelcronOnPressEvent & VelcronOnUpdatedEvent;
 }
 export declare enum VelcronImageRatios {
-    square = 1,
-    landscape = 2
+    square = "square",
+    landscape = "landscape"
 }
 export interface VelcronImageDefinition extends VelcronDefinition {
-    type: "Image";
-    source: string;
-    ratio: VelcronImageRatios;
+    type: "image";
+    url?: VelcronBindableProp<string>;
+    bind?: VelcronBindableProp<string>;
+    ratio?: VelcronImageRatios | string;
+    cover?: VelcronBindableProp<boolean>;
     borderRadius?: VelcronDimensions;
     events?: VelcronOnPressEvent;
 }
 export interface VelcronButtonDefinition extends VelcronDefinition {
-    type: "Button";
+    type: "button";
     text: string;
-    color: string;
     icon?: VelcronIcon;
     disabled?: boolean;
     events?: VelcronOnPressEvent;
 }
 export interface VelcronTextInputDefinition extends VelcronDefinition {
-    type: "TextInput";
+    type: "text-input";
     label?: string;
     bind: string;
     initialValue?: string;
-    events: VelcronOnChangedEvent;
+    events: VelcronOnUpdatedEvent;
 }
 export interface VelcronProgressCircleDefinition extends VelcronDefinition {
-    type: "ProgressCircle";
+    type: "progress-circle";
     events?: VelcronOnPressEvent;
 }
 export interface VelcronWebViewDefinition extends VelcronDefinition {
-    type: "WebView";
+    type: "web-view";
     source: string;
 }
 export interface VelcronDialogDefinition extends VelcronDefinition {
-    type: "Dialog";
+    type: "dialog";
     title: string;
     visible: string;
     events?: VelcronOnCloseRequestedEvent & VelcronOnClosedEvent;
 }
-export interface VelcronIconDefinition extends VelcronDefinition, VelcronCustomThemeSettings {
-    type: "Icon";
+export interface VelcronIconDefinition extends VelcronDefinition, VelcronColorStyling {
+    type: "icon";
     icon: string;
-    background?: boolean;
-    size?: number;
+    size?: VelcronBindableProp<number>;
     events?: VelcronOnPressEvent;
 }
-export interface VelcronFlexViewDefinition extends VelcronDefinition, VelcronCustomThemeSettings {
-    type: "FlexView";
-    column?: boolean;
-    body: Array<VelcronDefinition>;
-    columnStyle?: object;
-    horizontalAlignment?: VelcronHorizontalAlignments;
-    verticalAlignment?: VerticalAlignments;
-    grow?: number;
-    border?: VelcronBorder;
-    borderRadius?: VelcronDimensions;
-    width: string;
+export interface VelcronMarkdownDefinition extends VelcronDefinitionWithEditMode, VelcronColorStyling, VelcronTextStyling {
+    type: "markdown";
+    events: VelcronOnUpdatedEvent;
 }
 export interface VelcronDimensions {
-    top: number;
-    right: number;
-    bottom: number;
-    left: number;
+    top: number | string;
+    right: number | string;
+    bottom: number | string;
+    left: number | string;
 }
 export interface VelcronBorder extends VelcronDimensions {
-    color: string;
+    colorType?: string;
+    toned?: boolean;
+    opacity?: number;
 }
-export interface VelcronChipDefinition extends VelcronDefinition, VelcronCustomThemeSettings {
-    type: "Chip";
+export interface VelcronChipDefinition extends VelcronDefinition {
+    type: "chip";
     text: string;
     icon?: VelcronIcon;
     disabled?: boolean;
     events?: VelcronOnPressEvent;
 }
-/*** Custom Components ***********************************************************************/
-export type VelcronCustomComponentDefinition = VelcronComponentDescriptor & VelcronComponentDefinition;
+export interface VelcronSlotDefinition extends VelcronDefinition {
+    type: "slot";
+    bind: VelcronBindableProp<string>;
+}
+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 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 type VelcronAppRendererProps = VelcronRenderProps<VelcronAppDefinition> & {
+    rootApp: boolean;
+};
+export {};

package/internal-do-not-import-from-here/velcron/core/models/VelcronDefinitions.js

@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VelcronImageRatios = void 0;
 var VelcronImageRatios;
 (function (VelcronImageRatios) {
-    VelcronImageRatios[VelcronImageRatios["square"] = 1] = "square";
-    VelcronImageRatios[VelcronImageRatios["landscape"] = 2] = "landscape";
+    VelcronImageRatios["square"] = "square";
+    VelcronImageRatios["landscape"] = "landscape";
 })(VelcronImageRatios = exports.VelcronImageRatios || (exports.VelcronImageRatios = {}));

package/internal-do-not-import-from-here/velcron/core/models/VelcronEvents.d.ts

@@ -4,8 +4,11 @@ export type VelcronOnPressEvent = {
 export type VelcronOnLoadEvent = {
     onLoaded?: Array<string>;
 };
-export type VelcronOnChangedEvent = {
-    onChanged?: Array<string>;
+export type VelcronOnEditModeEvent = {
+    onEditMode?: Array<string>;
+};
+export type VelcronOnUpdatedEvent = {
+    onUpdated?: Array<string>;
 };
 export type VelcronOnCloseRequestedEvent = {
     onCloseRequested?: Array<string>;

package/internal-do-not-import-from-here/velcron/core/models/VelcronPropertyEditorDefinitions.d.ts

@@ -0,0 +1,229 @@
+import { TypographySize, TypographyType, VelcronImageRatios } 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;
+    multiple?: boolean;
+    component?: unknown;
+}
+export interface BuiltInPropertyEditors {
+    text: unknown;
+    slider: unknown;
+    switch: unknown;
+    alignment: unknown;
+    color: unknown;
+    markdown: unknown;
+    icon: unknown;
+    image: unknown;
+    typography: 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",
+    switch = "switch",
+    alignment = "alignment",
+    color = "color",
+    markdown = "markdown",
+    icon = "icon",
+    image = "image",
+    typography = "typography",
+    "color-schema-type" = "color-schema-type"
+}
+export interface VelcronSliderPropertyEditorSettings {
+    min: number;
+    max: number;
+    step: number;
+}
+export interface VelcronTypographyEditorSettings {
+    type: "title" | "text";
+}
+export interface VelcronSliderPropertyEditor extends VelcronPropertyEditor<VelcronSliderPropertyEditorSettings> {
+    type: "slider";
+}
+export interface VelcronTextPropertyEditor extends VelcronPropertyEditor<any> {
+    type: "text";
+}
+export interface VelcronEnterprisePropertyEditor extends VelcronPropertyEditor<any> {
+    type: "enterprise-property";
+}
+export interface VelcronTypographyPropertyEditor extends VelcronPropertyEditor<VelcronTypographyEditorSettings> {
+    type: "typography";
+}
+export interface VelcronSwitchPropertyEditor extends VelcronPropertyEditor<any> {
+    type: "switch";
+}
+export interface VelcronAlignmentPropertyEditor extends VelcronPropertyEditor<any> {
+    type: "alignment";
+}
+export interface VelcronColorPropertyEditor extends VelcronPropertyEditor<any> {
+    type: "color";
+}
+export interface VelcronColorSchemaPropertyEditor extends VelcronPropertyEditor<any> {
+    type: "color-schema-type";
+}
+export interface VelcronIconPropertyEditor extends VelcronPropertyEditor<any> {
+    type: "icon";
+}
+export interface VelcronMarkdownPropertyEditor extends VelcronPropertyEditor<any> {
+    type: "markdown";
+}
+export interface VelcronImagePropertyEditor extends VelcronPropertyEditor<any> {
+    type: "image";
+}
+export interface VelcronState {
+    images?: VelcronImagesState;
+    styling?: VelcronStylingState;
+    colorSchemas?: VelcronColorSchemasState;
+    content?: VelcronContentState;
+    header?: VelcronHeaderState;
+    properties?: VelcronPropertiesState;
+}
+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 {
+    caption?: VelcronTextState;
+    main?: VelcronTextState;
+    title?: VelcronTextState;
+    summary?: VelcronTextState;
+}
+export interface VelcronPropertiesState {
+    user: any;
+    mappings: Array<any>;
+}
+export interface VelcronImagesState {
+    main?: VelcronImageState;
+}
+export interface VelcronImageState {
+    url?: string;
+    ratio?: VelcronImageRatios;
+    caption?: VelcronTextState;
+}
+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;
+    };
+};
+export declare const VelcronHeaderStateBinding: {
+    title: {
+        text: string;
+        placeholder: string;
+        typography: {
+            editor: any;
+            type: any;
+            size: any;
+            toned: any;
+        };
+    };
+    icon: string;
+};
+export declare const VelcronContentStateBinding: {
+    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;
+        };
+    };
+};
+export declare const VelcronColorSchemasStateBinding: {
+    main: {
+        type: string;
+        filled: string;
+    };
+};
+export declare const VelcronStateBinding: {
+    colorSchemas: {
+        main: {
+            type: string;
+            filled: string;
+        };
+    };
+    images: {
+        main: {
+            editor: string;
+            url: string;
+            ratio: string;
+            caption: string;
+        };
+    };
+    content: {
+        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;
+            };
+        };
+    };
+    header: {
+        title: {
+            text: string;
+            placeholder: string;
+            typography: {
+                editor: any;
+                type: any;
+                size: any;
+                toned: any;
+            };
+        };
+        icon: string;
+    };
+};