@omnia/fx-models 8.0.20-vnext → 8.0.22-vnext

package/Exposes.d.ts

@@ -116,6 +116,7 @@ export * from "./auth";
 export * from "./sidepanel";
 export * from "./componentproptypes";
 export * from "./oxide";
+export * from "./docs";
 export * from "./FilePicker";
 export * from "./FileIdentifier";
 export * from "./UserAgent";

package/Exposes.js

@@ -128,6 +128,7 @@ tslib_1.__exportStar(require("./auth"), exports);
 tslib_1.__exportStar(require("./sidepanel"), exports);
 tslib_1.__exportStar(require("./componentproptypes"), exports);
 tslib_1.__exportStar(require("./oxide"), exports);
+tslib_1.__exportStar(require("./docs"), exports);
 //************************************************************************************ */
 // End of folder exports
 //************************************************************************************ */

package/Extends.d.ts

@@ -3,10 +3,10 @@ export interface IOmniaFxApi {
 export interface IExtend {
     fx: IOmniaFxApi;
 }
-export interface IOmniaFxApiManifest {
+export interface IOmniaFxExtendApiManifest {
 }
 export interface IExtendApiManifest {
-    fx: IOmniaFxApiManifest;
+    fx: IOmniaFxExtendApiManifest;
 }
 export interface ApiPath {
     path?: string;

package/IPropertiesApi.d.ts

@@ -35,7 +35,7 @@ declare module "./Extends" {
             implementation: Promise<IEnterprisePropertiesImplementationRegistration>;
         };
     }
-    interface IOmniaFxApiManifest {
+    interface IOmniaFxExtendApiManifest {
         properties: {
             registration: ApiPath;
             implementation: IExtendApiManifestWithConfiguration<GuidValue>;

package/Layout.d.ts

@@ -1,4 +1,4 @@
-import { MultilingualString, ThemeDefinition, IIcon, SpacingSettings, IconPickerModel, WebComponentDefinition, OmniaBlock, GuidValue, RadialGradientShapes, HorizontalAlignments, BlockTitleSettings, LayoutItemActions, LayoutEditorModes, BlockRenderingModes, TabbedDisplayModes, TabbedIconPositions, LayoutDrawerTabs, ILayoutCanvasDefinitionBuilder, MediaPickerImage, IMessageBusTopicSubscription, MediaPickerStorageProviderContext, OmniaBackendRuntimes, OmniaClientRuntimes, LayoutCanvasModes } from ".";
+import { MultilingualString, ThemeDefinition, IIcon, SpacingSettings, IconPickerModel, WebComponentDefinition, OmniaBlock, GuidValue, RadialGradientShapes, HorizontalAlignments, BlockTitleSettings, LayoutItemActions, LayoutEditorModes, BlockRenderingModes, TabbedDisplayModes, TabbedIconPositions, LayoutDrawerTabs, ILayoutCanvasDefinitionBuilder, MediaPickerImage, IMessageBusTopicSubscription, MediaPickerStorageProviderContext, OmniaBackendRuntimes, OmniaClientRuntimes, LayoutCanvasModes, ColorSchemaTypes, BlueprintTypes } from ".";
 import { MessageBusTopicMediator } from "../";
 import { TargetingFilterProperty } from "../sp";
 import { ShapeDividerSettings } from "./ShapeDividerSettingsModel";
@@ -65,6 +65,8 @@ export interface LayoutItemSettings {
     hidden?: boolean;
     css: string;
     customCssClasses: string;
+    colorSchemaType?: ColorSchemaTypes;
+    blueprintType?: BlueprintTypes;
 }
 export interface LinearGradientBackground extends BackgroundSettings {
     degrees: number;

package/ManifestIds.d.ts

@@ -148,6 +148,7 @@ export declare class OmniaWebComponentManifests {
     static get FxUxInputToken(): Guid;
     static get FxUxIconpicker(): Guid;
     static get FxUxJourney(): Guid;
+    static get OBtn(): Guid;
     static get FxUxMenuBlade(): Guid;
     static get FxUxWizard(): Guid;
     static get FxUxPeoplePicker(): Guid;

package/ManifestIds.js

@@ -460,6 +460,9 @@ class OmniaWebComponentManifests {
     static get FxUxJourney() {
         return new models_1.Guid("c362ce2d-88bf-493e-9581-d88a858fcae9");
     }
+    static get OBtn() {
+        return new models_1.Guid("678a52a5-101d-4149-8d47-754aeae5f9f6");
+    }
     static get FxUxMenuBlade() {
         return new models_1.Guid("f3b4f675-c04e-45b1-a767-f98daabc0dc7");
     }

package/TokenDefinition.d.ts

@@ -47,7 +47,7 @@ declare module "./Extends" {
             providers: Promise<ITokenProviderRegistration>;
         };
     }
-    interface IOmniaFxApiManifest {
+    interface IOmniaFxExtendApiManifest {
         tokens: {
             registrations: ApiPath;
             providers: IExtendApiManifestWithConfiguration<TokenManifestConfiguration>;

package/componentproptypes/ThemeableComponents.d.ts

@@ -1,4 +1,5 @@
 export interface ThemeableComponentProps {
     colorSchemaType?: any;
     container?: any;
+    colors?: any;
 }

package/docs/Api.d.ts

@@ -0,0 +1,37 @@
+type Doc = {
+    type: string;
+    description: string;
+};
+export type ComponentDoc = {
+    props?: {
+        [name: string]: Doc;
+    };
+    models?: {
+        [name: string]: Doc;
+    };
+    slots?: {
+        [name: string]: Doc;
+    };
+    emits?: {
+        [name: string]: Doc;
+    };
+};
+export interface IComponentDocRegistrationApi {
+    register(elmentName: string, doc: ComponentDoc): void;
+    getComponentRegistrations(): {
+        [elmentName: string]: ComponentDoc;
+    };
+}
+declare module "../Extends" {
+    interface IOmniaFxApi {
+        docs: {
+            registrations: Promise<IComponentDocRegistrationApi>;
+        };
+    }
+    interface IOmniaFxExtendApiManifest {
+        docs: {
+            registrations: ApiPath;
+        };
+    }
+}
+export {};

package/docs/Api.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/docs/index.d.ts

@@ -0,0 +1 @@
+export * from "./Api";

package/docs/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./Api"), exports);

package/enterprise-glossary/EnterpriseGlossaryApis.d.ts

@@ -24,7 +24,7 @@ declare module "../Extends" {
             providers: Promise<IEnterpriseGlossaryInformationApi>;
         };
     }
-    interface IOmniaFxApiManifest {
+    interface IOmniaFxExtendApiManifest {
         enterpriseGlossary: {
             registrations: ApiPath;
             providers: IExtendApiManifestWithConfiguration<EnterpriseGlossaryInformationProviderId>;

package/internal-do-not-import-from-here/shared/models/theming/BlueprintDefinition.d.ts

@@ -1,4 +1,5 @@
 import { Guid } from "../Guid";
+import { TypographyDefinition } from "./TypographyDefinition";
 export interface BoxDimensions {
     top: number;
     right: number;
@@ -8,8 +9,15 @@ export interface BoxDimensions {
 export interface BoxBorder extends BoxDimensions {
     color: string;
 }
+export interface BluePrintDefinitions {
+    default: BlueprintDefinition;
+    variant1: BlueprintDefinition;
+    variant2: BlueprintDefinition;
+    variant3: BlueprintDefinition;
+}
 export interface BlueprintDefinition {
     id: Guid;
+    typography: TypographyDefinition;
     button?: {
         borderRadius?: BoxDimensions;
     };

package/internal-do-not-import-from-here/shared/models/theming/ThemeDefinitionV2.d.ts

@@ -1,6 +1,5 @@
 import { Guid } from "../Guid";
-import { BlueprintDefinition } from "./BlueprintDefinition";
-import { TypographyDefinition } from "./TypographyDefinition";
+import { BluePrintDefinitions } from "./BlueprintDefinition";
 export interface ColorTypeResult<resultType> {
     base: resultType;
     baseTone: resultType;
@@ -29,14 +28,7 @@ export interface ColorSchema {
     container: ColorDefinition;
     onContainer: ColorDefinition;
 }
-export interface ColorGroup {
-    dark: ColorSchema;
-    light: ColorSchema;
-}
-export interface ThemeDefinitionV2 {
-    id: Guid;
-    name: string;
-    dark: boolean;
+export interface ColorSchemas {
     primary: ColorSchema;
     secondary: ColorSchema;
     accent1: ColorSchema;
@@ -46,10 +38,19 @@ export interface ThemeDefinitionV2 {
     background: ColorSchema;
     error: ColorSchema;
     info: ColorSchema;
-    typography: TypographyDefinition;
-    blueprint: BlueprintDefinition;
 }
-export type ColorSchemaType = ColorSchemaTypes.primary | ColorSchemaTypes.secondary | ColorSchemaTypes.accent1 | ColorSchemaTypes.accent2 | ColorSchemaTypes.accent3 | ColorSchemaTypes.neutral | ColorSchemaTypes.background | ColorSchemaTypes.error | ColorSchemaTypes.info;
+export interface ColorGroup {
+    dark: ColorSchema;
+    light: ColorSchema;
+}
+export interface ThemeDefinitionV2 {
+    id: Guid;
+    name: string;
+    dark: boolean;
+    colors: ColorSchemas;
+    blueprints: BluePrintDefinitions;
+}
+export type ColorSchemaType = "primary" | "secondary" | "accent1" | "accent2" | "accent3" | "neutral" | "background" | "error" | "info";
 export declare enum ColorSchemaTypes {
     primary = "primary",
     secondary = "secondary",
@@ -61,7 +62,14 @@ export declare enum ColorSchemaTypes {
     error = "error",
     info = "info"
 }
-export type ColorType = ColorTypes.base | ColorTypes.onBase | ColorTypes.container | ColorTypes.onContainer;
+export type BlueprintType = "default" | "variant1" | "variant2" | "variant3";
+export declare enum BlueprintTypes {
+    default = "default",
+    variant1 = "variant1",
+    variant2 = "variant2",
+    variant3 = "variant3"
+}
+export type ColorType = "base" | "onBase" | "container" | "onContainer";
 export declare enum ColorTypes {
     base = "base",
     onBase = "onBase",

package/internal-do-not-import-from-here/shared/models/theming/ThemeDefinitionV2.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ColorTypes = exports.ColorSchemaTypes = void 0;
+exports.ColorTypes = exports.BlueprintTypes = exports.ColorSchemaTypes = void 0;
 var ColorSchemaTypes;
 (function (ColorSchemaTypes) {
     ColorSchemaTypes["primary"] = "primary";
@@ -13,14 +13,17 @@ var ColorSchemaTypes;
     ColorSchemaTypes["error"] = "error";
     ColorSchemaTypes["info"] = "info";
 })(ColorSchemaTypes = exports.ColorSchemaTypes || (exports.ColorSchemaTypes = {}));
+var BlueprintTypes;
+(function (BlueprintTypes) {
+    BlueprintTypes["default"] = "default";
+    BlueprintTypes["variant1"] = "variant1";
+    BlueprintTypes["variant2"] = "variant2";
+    BlueprintTypes["variant3"] = "variant3";
+})(BlueprintTypes = exports.BlueprintTypes || (exports.BlueprintTypes = {}));
 var ColorTypes;
 (function (ColorTypes) {
     ColorTypes["base"] = "base";
-    //baseTone = "baseTone",
     ColorTypes["onBase"] = "onBase";
-    //onBaseTone = "onBaseTone",
     ColorTypes["container"] = "container";
-    //containerTone = "containerTone",
     ColorTypes["onContainer"] = "onContainer";
-    //onContainerTone = "onContainerTone",
 })(ColorTypes = exports.ColorTypes || (exports.ColorTypes = {}));

package/internal-do-not-import-from-here/shared/models/theming/TypographyDefinition.d.ts

@@ -19,7 +19,7 @@ export interface TypographyTypeBreakPoint {
     size: number;
     lineHeight: number;
 }
-export type TypographyType = TypographyTypes.h1 | TypographyTypes.h2 | TypographyTypes.h3 | TypographyTypes.text | TypographyTypes.caption | TypographyTypes.link;
+export type TypographyType = "h1" | "h2" | "h3" | "text" | "caption" | "link";
 export declare enum TypographyTypes {
     h1 = "h1",
     h2 = "h2",

package/internal-do-not-import-from-here/shared/models/theming/UseThemeMethods.d.ts

@@ -1,7 +1,9 @@
-import { ColorDefinition, ColorSchemaType, ColorSchemaTypes, ColorType, ColorTypes, ThemeDefinitionV2 } from "./ThemeDefinitionV2";
+import { ThemeDefinitionInstance } from "@omnia/fx/ux";
+import { BlueprintType, BlueprintTypes, ColorDefinition, ColorSchemaType, ColorSchemaTypes, ColorType, ColorTypes } from "./ThemeDefinitionV2";
 import { TypographyType, TypographyTypeDefinition, TypographyTypes } from "./TypographyDefinition";
-export declare const useThemeMethods: (themedefinition: ThemeDefinitionV2) => {
+export declare const useThemeMethods: (getThemeDefinition: () => ThemeDefinitionInstance) => {
     colorSchema: (colorSchemaType: ColorSchemaTypes | ColorSchemaType) => import("./ThemeDefinitionV2").ColorSchema;
+    blueprint: (blueprintType: BlueprintTypes | BlueprintType) => import("./BlueprintDefinition").BlueprintDefinition;
     typography: (typographyType: TypographyTypes | TypographyType) => TypographyTypeDefinition;
     color: (colorSchemaType: ColorSchemaTypes | ColorSchemaType, colorType: ColorTypes | ColorType) => string;
     colorDefinition: (colorSchemaType: ColorSchemaTypes | ColorSchemaType, colorType: ColorTypes | ColorType) => ColorDefinition;

package/internal-do-not-import-from-here/shared/models/theming/UseThemeMethods.js

@@ -3,54 +3,69 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useThemeMethods = void 0;
 const ThemeDefinitionV2_1 = require("./ThemeDefinitionV2");
 const TypographyDefinition_1 = require("./TypographyDefinition");
-const useThemeMethods = (themedefinition) => {
+const useThemeMethods = (getThemeDefinition) => {
     const colorSchema = (colorSchemaType) => {
         if (colorSchemaType === ThemeDefinitionV2_1.ColorSchemaTypes.primary) {
-            return themedefinition.primary;
+            return getThemeDefinition().colors.primary;
         }
         else if (colorSchemaType === ThemeDefinitionV2_1.ColorSchemaTypes.secondary) {
-            return themedefinition.secondary;
+            return getThemeDefinition().colors.secondary;
         }
         else if (colorSchemaType === ThemeDefinitionV2_1.ColorSchemaTypes.accent1) {
-            return themedefinition.accent1;
+            return getThemeDefinition().colors.accent1;
         }
         else if (colorSchemaType === ThemeDefinitionV2_1.ColorSchemaTypes.accent2) {
-            return themedefinition.accent2;
+            return getThemeDefinition().colors.accent2;
         }
         else if (colorSchemaType === ThemeDefinitionV2_1.ColorSchemaTypes.accent3) {
-            return themedefinition.accent3;
+            return getThemeDefinition().colors.accent3;
         }
         else if (colorSchemaType === ThemeDefinitionV2_1.ColorSchemaTypes.background) {
-            return themedefinition.background;
+            return getThemeDefinition().colors.background;
         }
         else if (colorSchemaType === ThemeDefinitionV2_1.ColorSchemaTypes.neutral) {
-            return themedefinition.neutral;
+            return getThemeDefinition().colors.neutral;
         }
         else if (colorSchemaType === ThemeDefinitionV2_1.ColorSchemaTypes.error) {
-            return themedefinition.error;
+            return getThemeDefinition().colors.error;
         }
-        return themedefinition.background;
+        return getThemeDefinition().colors.background;
+    };
+    const blueprint = (blueprintType) => {
+        if (blueprintType === ThemeDefinitionV2_1.BlueprintTypes.default) {
+            return getThemeDefinition().blueprints.default;
+        }
+        else if (blueprintType === ThemeDefinitionV2_1.BlueprintTypes.variant1) {
+            return getThemeDefinition().blueprints.variant1;
+        }
+        else if (blueprintType === ThemeDefinitionV2_1.BlueprintTypes.variant2) {
+            return getThemeDefinition().blueprints.variant2;
+        }
+        else if (blueprintType === ThemeDefinitionV2_1.BlueprintTypes.variant3) {
+            return getThemeDefinition().blueprints.variant3;
+        }
+        return getThemeDefinition().blueprints.default;
     };
     const typography = (typographyType) => {
         if (typographyType === TypographyDefinition_1.TypographyTypes.h1) {
-            return themedefinition.typography.h1;
+            return getThemeDefinition().blueprints.default.typography.h1;
         }
         else if (typographyType === TypographyDefinition_1.TypographyTypes.h2) {
-            return themedefinition.typography.h2;
+            return getThemeDefinition().blueprints.default.typography.h2;
         }
         else if (typographyType === TypographyDefinition_1.TypographyTypes.h3) {
-            return themedefinition.typography.h3;
+            return getThemeDefinition().blueprints.default.typography.h3;
         }
         else if (typographyType === TypographyDefinition_1.TypographyTypes.caption) {
-            return themedefinition.typography.caption;
+            return getThemeDefinition().blueprints.default.typography.caption;
         }
         else if (typographyType === TypographyDefinition_1.TypographyTypes.link) {
-            return themedefinition.typography.link;
+            return getThemeDefinition().blueprints.default.typography.link;
         }
         else if (typographyType === TypographyDefinition_1.TypographyTypes.text) {
-            return themedefinition.typography.text;
+            return getThemeDefinition().blueprints.default.typography.text;
         }
-        return themedefinition.typography.text;
+        return getThemeDefinition().blueprints.default.typography.text;
     };
     const color = (colorSchemaType, colorType) => {
         const mappedColorSchema = colorSchema(colorSchemaType);
@@ -109,6 +124,7 @@ const useThemeMethods = (themedefinition) => {
     };
     return {
         colorSchema,
+        blueprint,
         typography,
         color,
         colorDefinition,

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

@@ -148,7 +148,7 @@ export interface VelcronIcon {
     name: string;
 }
 export interface VelcronAppDefinition extends VelcronDefinitionBase {
-    type: "App";
+    type: "Velcron";
     body?: Array<VelcronDefinition>;
     events?: VelcronOnLoadEvent & VelcronOnPressEvent;
     actions?: {

package/oxide/TreeView.d.ts

@@ -1,10 +1,10 @@
 import { IIcon } from "@omnia/fx-models";
 export interface TreeViewItem<TValue = any> {
-    id: string;
-    value: TValue;
+    key?: string;
+    value?: TValue;
     title: string;
-    icon: IIcon;
-    active: boolean;
-    expanded: boolean;
-    children: TreeViewItem[];
+    icon?: IIcon;
+    active?: boolean;
+    expanded?: boolean;
+    children?: TreeViewItem[];
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@omnia/fx-models",
   "license": "MIT",
-  "version": "8.0.20-vnext",
+  "version": "8.0.22-vnext",
   "description": "Provide Omnia Fx Models Stuffs.",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/richtext-editor-extensions/BoldExtension.d.ts

@@ -2,7 +2,7 @@ import { ToolbarProperties } from "./ToolbarProperties";
 import { EditorCommand } from "./EditorCommand";
 import { EditorMenuBar } from "./EditorMenuBar";
 export interface BoldCommand extends EditorCommand {
-    bold?: () => void;
+    toggleBold?: () => void;
 }
 export interface BoldMenuBar extends EditorMenuBar<BoldCommand> {
 }

package/ux/UxApi.d.ts

@@ -6,7 +6,7 @@ declare module "../Extends" {
     interface IOmniaFxApi {
         ux: IOmniaUxApi;
     }
-    interface IOmniaFxApiManifest {
+    interface IOmniaFxExtendApiManifest {
         ux: IOmniaUxExtendApiManifest;
     }
 }