@omnia/fx-models 8.0.190-dev → 8.0.191-dev

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

@@ -1,10 +1,37 @@
 import "./Equals";
 import { IEquals } from "./Equals";
+import { Id } from "./Id";
 export interface GuidValue extends Partial<IEquals<{
-    guid(value: GuidValue): boolean;
+    GUID(value: GuidValue): boolean;
 }>> {
     toString: () => string;
 }
+declare const guidSymbol: unique symbol;
+/**
+ * Type alias for GUIDs, represented as a string but with nominal typing
+ * to distinguish them from regular strings.
+ */
+export type guid = Id<string, [typeof guidSymbol]>;
+/**
+ * Generates a globally unique identifier (GUID) or converts a provided string into a GUID.
+ *
+ * This function creates a new GUID if no argument is provided. If a string id is provided,
+ * it is cast to a GUID. The new GUID is generated according to the version 4 UUID standard,
+ * which uses random numbers. The format of a version 4 UUID is 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx',
+ * where 'x' is any hexadecimal digit and 'y' is one of 8, 9, A, or B.
+ *
+ * @param {string} [id] - Optional. A predefined string to be cast as a guid.
+ * @returns {guid} A new GUID if no id is provided, or the provided id cast as a guid.
+ *
+ * @example
+ * // Returns a new GUID, e.g., "f47ac10b-58cc-4372-a567-0e02b2c3d479"
+ * const newGuid = guid();
+ *
+ * @example
+ * // Casts a given string to a GUID
+ * const specificGuid = guid("123e4567-e89b-12d3-a456-426614174000");
+ */
+export declare function guid(id?: string): guid;
 /**
  * Class to create a guid
  */
@@ -12,7 +39,7 @@ export declare class Guid implements GuidValue {
     private static _empty;
     private value;
     equals: {
-        guid: (value: GuidValue) => boolean;
+        GUID: (value: GuidValue) => boolean;
     };
     static newGuid(): GuidValue;
     static get empty(): GuidValue;
@@ -22,4 +49,5 @@ export declare class Guid implements GuidValue {
     toJSON: () => string;
     valueOf(): string;
 }
-export declare function guid(value: string): GuidValue;
+export declare function GUID(value: string): GuidValue;
+export {};

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

@@ -1,13 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.guid = exports.Guid = void 0;
+exports.GUID = exports.Guid = exports.guid = void 0;
 //export interface GuidValue {
 //    :string;
 //}
 require("./Equals"); // ensure execute code in equals first
-// export interface GuidValue {
-//     toString: () => string;
-// }
+//This is the new modern implementation of guid not requiring a class
+const guidSymbol = Symbol("guid");
+/**
+ * Generates a globally unique identifier (GUID) or converts a provided string into a GUID.
+ *
+ * This function creates a new GUID if no argument is provided. If a string id is provided,
+ * it is cast to a GUID. The new GUID is generated according to the version 4 UUID standard,
+ * which uses random numbers. The format of a version 4 UUID is 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx',
+ * where 'x' is any hexadecimal digit and 'y' is one of 8, 9, A, or B.
+ *
+ * @param {string} [id] - Optional. A predefined string to be cast as a guid.
+ * @returns {guid} A new GUID if no id is provided, or the provided id cast as a guid.
+ *
+ * @example
+ * // Returns a new GUID, e.g., "f47ac10b-58cc-4372-a567-0e02b2c3d479"
+ * const newGuid = guid();
+ *
+ * @example
+ * // Casts a given string to a GUID
+ * const specificGuid = guid("123e4567-e89b-12d3-a456-426614174000");
+ */
+function guid(id) {
+    if (!id) {
+        return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, c => {
+            const r = Math.random() * 16 | 0;
+            const v = c === "x" ? r : (r & 0x3 | 0x8);
+            return v.toString(16);
+        });
+    }
+    return id;
+}
+exports.guid = guid;
 /**
  * Class to create a guid
  */
@@ -33,7 +62,7 @@ class Guid {
     constructor(guid) {
         this.value = "";
         this.equals = {
-            guid: (value) => {
+            GUID: (value) => {
                 return this.toString() === value.toString();
             }
         };
@@ -71,10 +100,10 @@ if (globalThis.omnia) {
 }
 // will make Guid class to static class to prevent new Guid instance later on
 // now expose new function to create guid
-function guid(value) {
+function GUID(value) {
     if (!Guid.isValid(value)) {
         throw `The string '${value}' is not a valid Guid`;
     }
     return value;
 }
-exports.guid = guid;
+exports.GUID = GUID;

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

@@ -0,0 +1,3 @@
+export type Id<T, Name> = T & {
+    readonly __type: Name;
+};

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

@@ -1,10 +1,10 @@
 import { OmniaToken } from "./Tokens";
-import { Guid, GuidValue } from "./Guid";
+import { guid } from "./Guid";
 import { TenantIdentifier } from "./Tenant";
 import { ActorId } from "./hub";
 export interface OmniaSharedBootstrapData {
-    uiThreadId: GuidValue;
-    workerThreadId: GuidValue;
+    uiThreadId: guid;
+    workerThreadId: guid;
     customDomain?: string;
     defaultDomain: string;
     routePrefixes: string[];
@@ -13,10 +13,10 @@ export interface OmniaSharedBootstrapData {
      * The tokenKey is only avilable if we are running ITP or Dev intent
      */
     tokenKey?: OmniaToken;
-    tokenRef: GuidValue;
+    tokenRef: guid;
     identity: string;
     hubActorId?: ActorId;
-    licenses: Array<Guid>;
+    licenses: Array<guid>;
     hubDev?: boolean;
     realtimeDevPort?: string;
     tenant: TenantIdentifier;

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

@@ -1,4 +1,4 @@
-import { GuidValue } from "./Guid";
+import { guid } from "./Guid";
 export declare abstract class RealtimeChannel {
     /**
      * Construct a unique channel id that can be targeted to users who are set to be in that channel on the client
@@ -11,16 +11,16 @@ export declare abstract class RealtimeData<TRealtimeChannel extends RealtimeChan
     private _value;
     get channel(): TRealtimeChannel;
     get value(): TRealtimeData;
-    abstract getId(): GuidValue;
+    abstract getId(): guid;
     constructor(channel: TRealtimeChannel, value?: TRealtimeData);
 }
 export type RealtimeChannelUpdateTypes = "activate" | "deactivate";
 export interface RealtimeChannelUpdateMessage extends RealtimChannelMessage {
-    threadId: GuidValue;
+    threadId: guid;
     type: RealtimeChannelUpdateTypes;
 }
 export interface RealtimeSendMessage extends RealtimChannelMessage {
-    dataId: GuidValue;
+    dataId: guid;
     data: any;
 }
 export interface RealtimChannelMessage {

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

@@ -1,4 +1,4 @@
-import { Guid } from "../Guid";
+import { guid } from "../Guid";
 import { RealtimeChannel, RealtimeData } from "../Realtime";
 export declare class SocialRealtimeChannel extends RealtimeChannel {
     getId(): string;
@@ -9,5 +9,5 @@ export interface SocialRealtimeMessage {
 }
 export declare class SocialRealtimeData extends RealtimeData<SocialRealtimeChannel, SocialRealtimeMessage> {
     constructor(channel: SocialRealtimeChannel);
-    getId(): Guid;
+    getId(): guid;
 }

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

@@ -14,7 +14,7 @@ class SocialRealtimeData extends Realtime_1.RealtimeData {
         super(channel);
     }
     getId() {
-        return new Guid_1.Guid("445350a8-4565-4a94-ba01-a05dd2cccca6");
+        return (0, Guid_1.guid)("445350a8-4565-4a94-ba01-a05dd2cccca6");
     }
 }
 exports.SocialRealtimeData = SocialRealtimeData;

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

@@ -1,15 +1,15 @@
 import { ChannelId } from "./ActivityChannel";
 import { ActivityRenderer, ActivityRendererReference } from "./ActivityRenderer";
-import { StronglyTypedId } from "../../StronglyTypedId";
-import { GuidValue } from "../../Guid";
+import { Id } from "../../Id";
 import { DynamicState } from "../../DynamicState";
 import { ActorActivityCategory } from "./ActorActivity";
 import { TemporaryFileId } from "../fileupload";
 import { ActorId } from "../actors";
-export type ActivityId = StronglyTypedId<number, "ActivityId">;
+import { guid } from "../../Guid";
+export type ActivityId = Id<number, "ActivityId">;
 export declare function ActivityId(id: number): ActivityId;
-export type ActivityTypeId = StronglyTypedId<GuidValue, "ActivityTypeId">;
-export declare function ActivityTypeId(id: GuidValue): ActivityTypeId;
+export type ActivityTypeId = Id<guid, "ActivityTypeId">;
+export declare function ActivityTypeId(id: guid): ActivityTypeId;
 export interface Activity<TRenderState = DynamicState> extends ActivityBase {
     id: ActivityId;
     state: TRenderState;
@@ -37,7 +37,7 @@ export interface ActivityRenderState<TActivityState = DynamicState, TIdentitySta
     identity: TIdentityState;
 }
 export interface SourceRelatedHubProperty extends HubProperty {
-    propertySourceId: GuidValue;
+    propertySourceId: guid;
 }
 export interface HubProperty {
     name: string;

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

@@ -1,5 +1,5 @@
-import { StronglyTypedId } from "../../StronglyTypedId";
-export type ChannelId = StronglyTypedId<number, "ChannelId">;
+import { Id } from "../../Id";
+export type ChannelId = Id<number, "ChannelId">;
 export declare function ChannelId(id: number): ChannelId;
 export interface ActivityChannel {
     id: ChannelId;

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

@@ -1,7 +1,7 @@
 import { GuidValue } from "../../Guid";
-import { StronglyTypedId } from "../../StronglyTypedId";
+import { Id } from "../../Id";
 import { VelcronAppDefinition } from "../../velcron";
-export type ActivityRendererId = StronglyTypedId<string, "ActivityRendererId">;
+export type ActivityRendererId = Id<string, "ActivityRendererId">;
 export declare function ActivityRendererId(id: GuidValue): ActivityRendererId;
 export interface ActivityRendererReference {
     id: ActivityRendererId;

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

@@ -1,6 +1,6 @@
-import { StronglyTypedId } from "../../StronglyTypedId";
+import { Id } from "../../Id";
 import { ActorId } from "../actors";
-export type SubscriptionId = StronglyTypedId<string, "SubscriptionId">;
+export type SubscriptionId = Id<string, "SubscriptionId">;
 export declare function SubscriptionId(id: string): SubscriptionId;
 export interface SubscriptionInformation extends ActorSubscription {
     title: Record<string, string>;

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

@@ -1,6 +1,6 @@
-import { StronglyTypedId } from "../../StronglyTypedId";
+import { Id } from "../../Id";
 import { ExternalActorId } from "./ExternalActorId";
-export type ActorId = StronglyTypedId<number, "ActorId">;
+export type ActorId = Id<number, "ActorId">;
 export declare function ActorId(id: number): ActorId;
 export interface ActorWithBag<TBag> extends Actor {
     bag: TBag;

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

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

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

@@ -1,3 +1,3 @@
-import { StronglyTypedId } from "../../StronglyTypedId";
-export type FileOwnerId = StronglyTypedId<string, "FileOwnerId">;
+import { Id } from "../../Id";
+export type FileOwnerId = Id<string, "FileOwnerId">;
 export declare function FileOwnerId(id: string): FileOwnerId;

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

@@ -1,4 +1,4 @@
 import { GuidValue } from "../../Guid";
-import { StronglyTypedId } from "../../StronglyTypedId";
-export type TemporaryFileId = StronglyTypedId<GuidValue, "TemporaryFileId">;
+import { Id } from "../../Id";
+export type TemporaryFileId = Id<GuidValue, "TemporaryFileId">;
 export declare function TemporaryFileId(id: GuidValue): TemporaryFileId;

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

@@ -1,10 +1,10 @@
-import { GuidValue } from "../../Guid";
+import { guid } from "../../Guid";
 import { ExternalActorId } from "../actors/ExternalActorId";
 import { SourceRelatedHubProperty } from "../activities";
 export declare class HubExternalIdentityProperty implements SourceRelatedHubProperty {
     private externalIdentityId;
     constructor(externalIdentityId: ExternalActorId);
-    get propertySourceId(): GuidValue;
+    get propertySourceId(): guid;
     get name(): string;
     get values(): string[];
 }

package/internal-do-not-import-from-here/shared/models/hub/targeting/ExternalIdentityProperty.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HubExternalIdentityProperty = void 0;
+const Guid_1 = require("../../Guid");
 const HubSource_1 = require("./HubSource");
 class HubExternalIdentityProperty {
     constructor(externalIdentityId) {
         this.externalIdentityId = externalIdentityId;
     }
     get propertySourceId() {
-        return HubSource_1.HubSource.Id;
+        return (0, Guid_1.guid)(HubSource_1.HubSource.Id);
     }
     get name() {
         return "identity";

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

@@ -13,7 +13,7 @@ export * from "./Realtime";
 export * from "./OmniaSharedBootstrapData";
 export * from "./StringExtensions";
 export * from "./DynamicState";
-export * from "./StronglyTypedId";
+export * from "./Id";
 export * from "./theming";
 export * from "./hub";
 export * from "./velcron";

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

@@ -17,7 +17,7 @@ tslib_1.__exportStar(require("./Realtime"), exports);
 tslib_1.__exportStar(require("./OmniaSharedBootstrapData"), exports);
 tslib_1.__exportStar(require("./StringExtensions"), exports);
 tslib_1.__exportStar(require("./DynamicState"), exports);
-tslib_1.__exportStar(require("./StronglyTypedId"), exports);
+tslib_1.__exportStar(require("./Id"), exports);
 tslib_1.__exportStar(require("./theming"), exports);
 tslib_1.__exportStar(require("./hub"), exports);
 tslib_1.__exportStar(require("./velcron"), exports);

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

@@ -4,7 +4,7 @@ import { TypographyValue } from "./Typography";
 export interface BoxDimensions extends Spacing {
 }
 import { TypographyBlueprint } from "./Typography";
-import { GuidValue, VelcronAppDefinition } from "@omnia/fx-models";
+import { GuidValue, VelcronAppDefinition, VelcronRendererReference } from "@omnia/fx-models";
 export interface Blueprints {
     name?: string;
 }
@@ -90,6 +90,7 @@ export interface ButtonBlueprint extends Blueprint {
     alterCase?: boolean;
     text?: TextBlueprint;
     icon?: IconBlueprint;
+    definition?: VelcronAppDefinition | VelcronRendererReference;
 }
 export interface ButtonBlueprints extends Blueprints {
     text: {

package/internal-do-not-import-from-here/shared/models/velcron/VelcronReference.d.ts

@@ -1,7 +1,7 @@
 import { GuidValue } from "../Guid";
-import { StronglyTypedId } from "../StronglyTypedId";
+import { Id } from "../Id";
 import { VelcronAppDefinition } from "./VelcronDefinition";
-export type VelcronRendererId = StronglyTypedId<string, "VelcronRendererId">;
+export type VelcronRendererId = Id<string, "VelcronRendererId">;
 export declare function VelcronRendererId(id: GuidValue): VelcronRendererId;
 export interface VelcronRendererResolverReference {
     id: VelcronRendererId;

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

@@ -1,4 +1,4 @@
-import { VelcronOnUpdatedEvent, VelcronOnClosedEvent, VelcronOnCloseRequestedEvent, VelcronOnPressEvent, VelcronSpacing, VelcronStyling, VelcronCustomComponentDefinition, VelcronAppDefinition, VelcronRendererResolverReference, EventHook, Future, TextBlueprint, VelcronBindableProp, VelcronEditor, ContainerBlueprint, BackgroundDefinition, ContainerVariant } from "@omnia/fx-models/internal-do-not-import-from-here/shared/models";
+import { VelcronOnUpdatedEvent, VelcronOnClosedEvent, VelcronOnCloseRequestedEvent, VelcronOnPressEvent, VelcronSpacing, VelcronStyling, VelcronCustomComponentDefinition, VelcronAppDefinition, VelcronRendererResolverReference, EventHook, Future, TextBlueprint, VelcronBindableProp, VelcronEditor, ContainerBlueprint, BackgroundDefinition, ContainerVariant, IconBlueprint } from "@omnia/fx-models/internal-do-not-import-from-here/shared/models";
 import { VelcroncomponentArrayType, VelcronPrimitiveType } from "./VelcronTypes";
 import { AssignOperators, VelcronHorizontalAlignments, VelcronIconTypes, VelcronActionTypes, VelcronVerticalAlignments } from "./Enums";
 import { DynamicState, VelcronDefinition, VelcronEffects, useVelcronThemingStore } from "..";
@@ -274,6 +274,7 @@ export interface VelcronIconDefinition extends VelcronDefinition, VelcronColorSt
     icon: string;
     size?: VelcronBindableProp<number>;
     events?: VelcronOnPressEvent;
+    blueprint?: VelcronBindableProp<IconBlueprint>;
 }
 export interface VelcronMarkdownDefinition extends VelcronDefinition, VelcronColorStyling, VelcronTextStyling {
     type: "markdown";

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

@@ -1,6 +1,13 @@
 import { BackgroundDefinition, ContainerBlueprint, ContainerVariant, TextBlueprint, TypographySize, TypographyType, VelcronSpacing } from "@omnia/fx-models/internal-do-not-import-from-here/shared/models";
 import { VelcronImageRatios } from "./VelcronDefinitions";
 export interface VelcronState {
+    states?: {
+        active?: boolean;
+    };
+    component?: {
+        title: string;
+        icon: string;
+    };
     images?: VelcronImagesState;
     container?: {
         maxWidth?: number;
@@ -94,6 +101,13 @@ export declare const VelcronStateMapping: {
     };
 };
 export declare const VelcronStateBinding: {
+    states: {
+        active: string;
+    };
+    component: {
+        title: string;
+        icon: string;
+    };
     container: {
         maxWidth: string;
         minHeight: string;

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

@@ -56,6 +56,13 @@ exports.VelcronStateMapping = {
     },
 };
 exports.VelcronStateBinding = {
+    states: {
+        active: "states.active",
+    },
+    component: {
+        title: (0, models_1.velcronBind)("$state.component.title"),
+        icon: (0, models_1.velcronBind)("$state.component.icon"),
+    },
     container: {
         maxWidth: (0, models_1.velcronBind)("$state.container.maxWidth"),
         minHeight: (0, models_1.velcronBind)("$state.container.minHeight"),

package/package.json

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

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

@@ -1,3 +0,0 @@
-export type StronglyTypedId<T, Name extends string> = T & {
-    __type: Name;
-};