@omnia/fx-models 8.0.124-dev → 8.0.127-dev

package/media-picker/interfaces/IMediaPickerProviderMediaHandler.d.ts

@@ -0,0 +1,58 @@
+import { MediaPickerImageScaling } from "../MediaPickerImageScaling";
+import { MediaPickerVideo } from "../MediaPickerMedia";
+import { MediaItem, ImageInformation } from "../Shared";
+/**
+ * @description interface for media picker provider, which contains the logic for **handling the media picker provider** events
+ */
+export interface IMediaPickerProviderHandler {
+    /**
+     * @description handle select media event in the provider
+     * @param media the media that gets selected in the provider
+     */
+    selectMedia: (media: MediaItem | MediaPickerVideo) => Promise<void>;
+    /**
+     * @param searchKeyword handle the search event in the provider
+     * @returns {Promise<Array<MediaItem>>} the result of the search
+     */
+    search: (searchKeyword: string) => Promise<Array<MediaItem>>;
+    /**
+     * @description handle the search more event in the provider, when the user scrolls to the bottom of the search result
+     * @param searchQueryText search query text
+     * @param lastLoadedIndex index of the last loaded item
+     * @returns {Promise<Array<MediaItem>>} the result of the search
+     */
+    searchMore: (searchQueryText: string, lastLoadedIndex: number) => Promise<Array<MediaItem>>;
+}
+export type ProcessImageOptions = {
+    needScaling: boolean;
+    imageInfo: ImageInformation;
+    scalingOptions?: MediaPickerImageScaling;
+};
+export interface IMediaPickerImageProviderHandler extends IMediaPickerProviderHandler {
+    /**
+     * @description handle the image scaling event in the provider, when the user selects the image scaling option
+     * @param imageInfo the image info of the selected image
+     * @returns {Promise<boolean>} if the image needs scaling
+     */
+    handleImageScaling: (imageInfo: ImageInformation) => Promise<boolean>;
+    /**
+     * @description check if the image supports transformation, This is because we need to handle the event when user selecting scaling options in a provider
+     * @param imageInfo the image info of the selected image
+     * @returns {boolean} if the image supports transformation
+     */
+    processImageAndAddToGallery: (options: ProcessImageOptions) => Promise<void>;
+    /**
+     * @description handle the select image event in the provider, when the provider already process the image.
+     * @param imageInfo the image info of the selected image
+     */
+    selectImageInfo: (imageInfo: ImageInformation) => Promise<void>;
+}
+export interface IMediaPickerVideoProviderHandler extends IMediaPickerProviderHandler {
+    /**
+     * @description handle the update media event in the provider, when the user updates the media in the gallery
+     * @note This will probably be used only for video providers, because in omnia the video provider will update the video, while the image transformer will transform the image **NOT** the provider
+     * @param media This will be the media that gets updated in the gallery
+     * @param id the id of the media that gets updated in gallery store
+     */
+    updateMedia: (media: MediaItem | MediaPickerVideo) => Promise<void>;
+}

package/media-picker/interfaces/IMediaPickerProviderMediaHandler.js

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

package/media-picker/interfaces/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./IImageTransformHandler";
+export * from "./IMediaPickerGalleryHandler";
+export * from "./IMediaPickerProviderMediaHandler";
+export * from "./types";

package/media-picker/interfaces/index.js

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

package/media-picker/interfaces/types.d.ts

@@ -0,0 +1,55 @@
+import { GuidValue } from "@omnia/fx/internal-do-not-import-from-here/shared";
+import { MediaPickerRenditionData } from "../MediaPickerImageRendition";
+import { MediaPickerImageTransformationResult } from "../MediaPickerImageTransformationResult";
+import { MediaPickerImage, MediaPickerVideo, MediaPickerMedia } from "../MediaPickerMedia";
+import { MediaPickerProvider } from "../MediaPickerProvider";
+import { MediaPickerTransformedBase64Image } from "../MediaPickerTransformedBase64Image";
+import { IIcon } from "../../Icon";
+export type MediaPickerMediaItem = MediaPickerImage | MediaPickerVideo | MediaPickerMedia;
+export type MediaGallery = Array<MediaPickerMediaItem>;
+export type ImageMetaData = {
+    [imageId: string]: {
+        renditions: Array<MediaPickerRenditionData>;
+        imageTransformationSource: MediaPickerTransformedBase64Image;
+    };
+};
+export type MediaPickerActionButton = {
+    text: string;
+    show: boolean;
+    onClick: any;
+    icon?: string;
+    iconLeft?: boolean;
+    loading?: boolean;
+    highLighted?: boolean;
+    leftAligned?: boolean;
+};
+export type MediaState = {
+    id: GuidValue;
+    isVideo: boolean;
+    isChanged: boolean;
+    media?: MediaPickerMediaItem;
+    transformerInfo?: MediaPickerImageTransformationResult;
+    isNew: boolean;
+    convertingFromBase64ToMediaPicker: boolean;
+    provider?: MediaPickerProvider;
+    index?: number;
+};
+export type MenuItem = {
+    menuItemId: GuidValue;
+    title?: string;
+    icon: IIcon;
+    connectedProvider: MediaPickerProvider;
+};
+export type MediaResult = {
+    index: number;
+    media: MediaPickerMediaItem;
+};
+export type MediaPickerMessage = {
+    message: string;
+    icon?: IIcon;
+};
+export type ImageRendition = {
+    mediaStateId: GuidValue;
+    mediaPickerRenditionData: MediaPickerRenditionData[];
+    sourceImage: MediaPickerTransformedBase64Image;
+};

package/media-picker/interfaces/types.js

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

package/oxide/SharedSettings.d.ts

@@ -1,7 +1,13 @@
+import { TabsBlueprint } from "../Exposes";
 export interface ExpansionPanelSharedSettings {
     variant?: string;
     toned?: boolean;
 }
+export interface TabSharedSettings {
+    blueprint?: TabsBlueprint;
+    selectedIndex?: number;
+    tabRegistrations?: number;
+}
 export interface ListItemSharedSettings {
     variant?: string;
     toned?: boolean;

package/package.json

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

package/properties/definitions/IdentityPropertyDefinition.d.ts

@@ -1,5 +1,6 @@
-import { Guid } from "@omnia/fx-models/internal-do-not-import-from-here/shared/models";
+import { Guid } from "@omnia/fx/internal-do-not-import-from-here/shared";
 import { LockStatusExcludeChildren, PropertyLockStatusType } from "../../../ux";
+import { PrincipalTypes } from "../../Enums";
 import { PropertyDefinition, PropertyDisplaySettingsBase, PropertyEditorSettingsBase } from "../PropertyDefinition";
 import { IdentityPropertyValue } from "../values";
 export declare class IdentityPropertyDisplaySettings extends PropertyDisplaySettingsBase {
@@ -11,6 +12,7 @@ export declare class IdentityPropertyDisplaySettings extends PropertyDisplaySett
 export declare class IdentityPropertyEditorSettings extends PropertyEditorSettingsBase {
     locks?: PropertyLockStatusType<Omit<IdentityPropertyEditorSettings, "locks">>;
     multiple?: boolean;
+    type?: PrincipalTypes;
 }
 export declare const identityPropertyDefinitionId: Guid;
 export declare class IdentityPropertyDefinition extends PropertyDefinition<IdentityPropertyValue, IdentityPropertyDisplaySettings, IdentityPropertyEditorSettings> {

package/properties/definitions/IdentityPropertyDefinition.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IdentityPropertyDefinition = exports.identityPropertyDefinitionId = exports.IdentityPropertyEditorSettings = exports.IdentityPropertyDisplaySettings = void 0;
-const models_1 = require("@omnia/fx-models/internal-do-not-import-from-here/shared/models");
+const shared_1 = require("@omnia/fx/internal-do-not-import-from-here/shared");
 const PropertyDefinition_1 = require("../PropertyDefinition");
 class IdentityPropertyDisplaySettings extends PropertyDefinition_1.PropertyDisplaySettingsBase {
 }
@@ -9,7 +9,7 @@ exports.IdentityPropertyDisplaySettings = IdentityPropertyDisplaySettings;
 class IdentityPropertyEditorSettings extends PropertyDefinition_1.PropertyEditorSettingsBase {
 }
 exports.IdentityPropertyEditorSettings = IdentityPropertyEditorSettings;
-exports.identityPropertyDefinitionId = new models_1.Guid("4dfc3b66-a203-447d-8f64-171f47e5b63a");
+exports.identityPropertyDefinitionId = new shared_1.Guid("4dfc3b66-a203-447d-8f64-171f47e5b63a");
 class IdentityPropertyDefinition extends PropertyDefinition_1.PropertyDefinition {
     constructor() {
         super(...arguments);

package/internal-do-not-import-from-here/shared/models/hub/ExternalIdentityId.d.ts

@@ -1,2 +0,0 @@
-import { StronglyTypedId } from "../StronglyTypedId";
-export type ExternalIdentityId = StronglyTypedId<string, "ExternalIdentityId">;

package/internal-do-not-import-from-here/shared/models/hub/activities/ActivitySender.d.ts

@@ -1,15 +0,0 @@
-import { StronglyTypedId } from "../../StronglyTypedId";
-export type ActivitySenderId = StronglyTypedId<number, "ActivitySenderId">;
-export declare function ActivitySenderId(id: number): ActivitySenderId;
-export interface ActivitySenderWithBag<TBag> extends ActivitySender {
-    bag: TBag;
-}
-export interface ActivitySender extends ActivitySenderBase {
-    id: ActivitySenderId;
-    imageUrl: string;
-}
-export interface ActivitySenderBase {
-    name: Record<string, string>;
-    description: Record<string, string>;
-    externalId: string;
-}

package/internal-do-not-import-from-here/shared/models/hub/activities/ActivitySender.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActivitySenderId = void 0;
-function ActivitySenderId(id) { return id; }
-exports.ActivitySenderId = ActivitySenderId;

package/internal-do-not-import-from-here/shared/models/hub/activities/IdentityActivity.d.ts

@@ -1,40 +0,0 @@
-import { DynamicState } from "../../DynamicState";
-import { Activity, ActivityId } from "./Activity";
-import { ChannelId } from "./ActivityChannel";
-import { ActivitySender, ActivitySenderId } from "./ActivitySender";
-export declare enum IdentityActivityStatus {
-    new = 0,
-    read = 1,
-    completed = 2
-}
-export declare enum IdentityActivityCategory {
-    none = 0,
-    important = 1,
-    todo = 2,
-    snoozed = 3,
-    bookmarked = 4
-}
-export interface IdentityActivityBase {
-    activityId: ActivityId;
-    status: IdentityActivityStatus;
-    category: IdentityActivityCategory;
-}
-export interface IdentityActivity<TRenderState extends DynamicState, TState extends DynamicState> extends IdentityActivityBase {
-    activity: Activity<TRenderState>;
-    state?: TState;
-}
-export interface IdentityActivityWithJson extends IdentityActivityBase {
-    stateJson: string;
-}
-export interface NewActivitiesBySenderBase {
-    count: number;
-    senderId: ActivitySenderId;
-}
-export interface NewActivitiesBySender extends NewActivitiesBySenderBase {
-    sender: ActivitySender;
-    channelId: ChannelId;
-}
-export interface ActivityCategoryCount {
-    category: IdentityActivityCategory;
-    count: number;
-}

package/internal-do-not-import-from-here/shared/models/hub/activities/IdentityActivity.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IdentityActivityCategory = exports.IdentityActivityStatus = void 0;
-var IdentityActivityStatus;
-(function (IdentityActivityStatus) {
-    IdentityActivityStatus[IdentityActivityStatus["new"] = 0] = "new";
-    IdentityActivityStatus[IdentityActivityStatus["read"] = 1] = "read";
-    IdentityActivityStatus[IdentityActivityStatus["completed"] = 2] = "completed";
-})(IdentityActivityStatus || (exports.IdentityActivityStatus = IdentityActivityStatus = {}));
-var IdentityActivityCategory;
-(function (IdentityActivityCategory) {
-    IdentityActivityCategory[IdentityActivityCategory["none"] = 0] = "none";
-    IdentityActivityCategory[IdentityActivityCategory["important"] = 1] = "important";
-    IdentityActivityCategory[IdentityActivityCategory["todo"] = 2] = "todo";
-    IdentityActivityCategory[IdentityActivityCategory["snoozed"] = 3] = "snoozed";
-    IdentityActivityCategory[IdentityActivityCategory["bookmarked"] = 4] = "bookmarked";
-})(IdentityActivityCategory || (exports.IdentityActivityCategory = IdentityActivityCategory = {}));
-// Usage
-//   const activity1: IdentityActivity<SomeRenderState> = {
-//     activity: {
-//       // Initialize your Activity here
-//     },
-//     state: {
-//       // Initialize your State here
-//     },
-//   };
-//   const activity2: IdentityActivity<SomeRenderState, SomeState> = {
-//     activity: {
-//       // Initialize your Activity here
-//     },
-//     state: {
-//       // Initialize your State here
-//     },
-//   };
-//   const activity3: IdentityActivityWithJson = {
-//     activityId: 22,
-//     status: IdentityActivityStatus.unRead,
-//     stateJson: "someJson",
-//   };

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

@@ -1,93 +0,0 @@
-import { BackgroundDefinition, FillDefinition } from "./ThemeDefinitionV2";
-import { ChromeDefinition } from "./ChromeDefinition";
-import { SpacingDefinition, SpacingSettings } from "./SpacingSetting";
-import { TypographyDefinition, TypographyValue } from "./TypographyDefinition";
-export interface BoxDimensions extends SpacingSettings {
-}
-export interface ChromeBluePrintDefinitions {
-    default: ChromeDefinition;
-    variant1: ChromeDefinition;
-    variant2: ChromeDefinition;
-    variant3: ChromeDefinition;
-}
-export type BlueprintType = "chrome" | "typography" | "spacing" | "component";
-export type ChromeBlueprintVariants = "default" | "variant1" | "variant2" | "variant3";
-export type TypographyBlueprintVariants = "default" | "variant1";
-export type SpacingBlueprintVariants = "default";
-export interface BlueprintDefinition {
-    type: BlueprintType;
-    name: string;
-}
-export interface ChromeBlueprint extends BlueprintDefinition {
-    type: "chrome";
-    default: ChromeDefinition;
-    variant1?: ChromeDefinition;
-    variant2?: ChromeDefinition;
-    variant3?: ChromeDefinition;
-}
-export interface TypographyBlueprint extends BlueprintDefinition {
-    type: "typography";
-    default: TypographyDefinition;
-    variant1?: TypographyDefinition;
-}
-export interface SpacingBlueprint extends BlueprintDefinition {
-    type: "spacing";
-    default: SpacingItemBluePrintDefinition;
-}
-export interface ComponentBlueprint extends BlueprintDefinition {
-    type: "component";
-    buttons?: {
-        high: {
-            regular: ButtonBlueprint;
-            icon: ButtonBlueprint;
-        };
-        medium: {
-            regular: ButtonBlueprint;
-            icon: ButtonBlueprint;
-        };
-        low: {
-            regular: ButtonBlueprint;
-            icon: ButtonBlueprint;
-        };
-    };
-}
-export interface SpacingItemBluePrintDefinition {
-    layout: SpacingDefinition;
-    inner: SpacingDefinition;
-}
-export type SpacingBlueprintTypes = "inner" | "layout";
-export type WebBlueprintItemDefintionType = "button" | "searchbox" | "text" | "icon";
-export declare enum WebBlueprintItemDefintionTypes {
-    button = "button",
-    searchbox = "searchbox"
-}
-export type VelcronBlueprintDefintionType = "button";
-export declare enum VelcronBlueprintDefintionTypes {
-    button = "button"
-}
-export interface BlueprintItemDefinition {
-    type: VelcronBlueprintDefintionType | WebBlueprintItemDefintionType;
-}
-export interface SearchBoxBlueprint extends BlueprintItemDefinition {
-    type: "searchbox";
-    borderRadius?: BoxDimensions;
-    variant?: "outlined" | "solo" | "regular" | "plain" | "underlined";
-}
-export interface ButtonBlueprint extends BlueprintItemDefinition {
-    type: "button";
-    padding?: SpacingSettings;
-    background?: BackgroundDefinition;
-    alterCase?: boolean;
-    text?: TextBlueprint;
-    icon?: IconBlueprint;
-}
-export interface TextBlueprint extends BlueprintItemDefinition {
-    type: "text";
-    color?: FillDefinition;
-    typography?: TypographyValue;
-}
-export interface IconBlueprint extends BlueprintItemDefinition {
-    type: "icon";
-    color?: FillDefinition;
-    size?: number;
-}

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

@@ -1,30 +0,0 @@
-import { Guid } from "../Guid";
-export interface Spacing {
-    top?: number;
-    right?: number;
-    bottom?: number;
-    left?: number;
-}
-export interface SpacingSettings {
-    top?: number | SpacingType;
-    right?: number | SpacingType;
-    bottom?: number | SpacingType;
-    left?: number | SpacingType;
-}
-export interface SpacingDefinition {
-    name: string;
-    id: Guid;
-    xs: number;
-    s: number;
-    m: number;
-    l: number;
-    xl: number;
-}
-export type SpacingType = "xs" | "s" | "m" | "l" | "xl";
-export declare enum SpacingTypes {
-    xs = "xs",
-    s = "s",
-    m = "m",
-    l = "l",
-    xl = "xl"
-}