@openfin/core 46.100.65 → 46.100.66

package/out/mock-public.d.ts

@@ -4676,6 +4676,54 @@ declare type CustomRequestHeaders = {
 
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
+export declare type DefaultColorChannelId = keyof typeof defaultColorChannels;
+
+/**
+ * The default FDC3 user channels advertised by the Interop Broker.
+ */
+export declare const defaultColorChannels: {
+    readonly 'fdc3.channel.1': {
+        readonly name: "Channel 1";
+        readonly color: "red";
+        readonly glyph: "1";
+    };
+    readonly 'fdc3.channel.2': {
+        readonly name: "Channel 2";
+        readonly color: "orange";
+        readonly glyph: "2";
+    };
+    readonly 'fdc3.channel.3': {
+        readonly name: "Channel 3";
+        readonly color: "yellow";
+        readonly glyph: "3";
+    };
+    readonly 'fdc3.channel.4': {
+        readonly name: "Channel 4";
+        readonly color: "green";
+        readonly glyph: "4";
+    };
+    readonly 'fdc3.channel.5': {
+        readonly name: "Channel 5";
+        readonly color: "cyan";
+        readonly glyph: "5";
+    };
+    readonly 'fdc3.channel.6': {
+        readonly name: "Channel 6";
+        readonly color: "blue";
+        readonly glyph: "6";
+    };
+    readonly 'fdc3.channel.7': {
+        readonly name: "Channel 7";
+        readonly color: "magenta";
+        readonly glyph: "7";
+    };
+    readonly 'fdc3.channel.8': {
+        readonly name: "Channel 8";
+        readonly color: "purple";
+        readonly glyph: "8";
+    };
+};
+
 /**
  * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
@@ -7048,17 +7096,19 @@ declare type InteropActionLoggingOption = {
  *          "interopBrokerConfiguration": {
  *              "contextGroups": [
  *                  {
- *                      "id": "green",
+ *                      "id": "fdc3.channel.4",
  *                      "displayMetadata": {
- *                          "color": "#00CC88",
- *                          "name": "green"
+ *                          "color": "green",
+ *                          "name": "Channel 4",
+ *                          "glyph": "4"
  *                      }
  *                  },
  *                  {
- *                      "id": "purple",
+ *                      "id": "fdc3.channel.8",
  *                      "displayMetadata": {
- *                          "color": "#8C61FF",
- *                          "name": "purple"
+ *                          "color": "purple",
+ *                          "name": "Channel 8",
+ *                          "glyph": "8"
  *                      }
  *                  },
  *              ]
@@ -7192,7 +7242,7 @@ declare class InteropBroker extends Base {
      * @param joinContextGroupOptions - Id of the Context Group and identity of the entity to join to the group.
      * @param senderIdentity - Identity of the client sender.
      */
-    joinContextGroup({ contextGroupId, target }: {
+    joinContextGroup({ contextGroupId: requestedContextGroupId, target }: {
         contextGroupId: string;
         target?: OpenFin_2.ClientIdentity | OpenFin_2.Identity;
     }, senderIdentity: OpenFin_2.ClientIdentity): Promise<void>;
@@ -7203,7 +7253,7 @@ declare class InteropBroker extends Base {
      * @param addClientToContextGroupOptions - Contains the contextGroupId
      * @param clientIdentity - Identity of the client sender.
      */
-    addClientToContextGroup({ contextGroupId }: {
+    addClientToContextGroup({ contextGroupId: requestedContextGroupId }: {
         contextGroupId: string;
     }, clientIdentity: OpenFin_2.ClientIdentity): Promise<void>;
     /**
@@ -7616,6 +7666,8 @@ declare class InteropBroker extends Base {
     };
     private getClientState;
     private static toObject;
+    private normalizeContextGroupStates;
+    private normalizeContextGroupId;
     static checkContextIntegrity: (context: OpenFin_2.Context) => {
         isValid: true;
     } | {
@@ -7843,7 +7895,7 @@ declare class InteropClient extends Base {
      *
      * getLastFocusedView()
      *     .then(lastFocusedViewIdentity => {
-     *         joinViewToContextGroup('red', lastFocusedViewIdentity)
+     *         joinViewToContextGroup('fdc3.channel.1', lastFocusedViewIdentity)
      *     })
      * ```
      */
@@ -7878,7 +7930,7 @@ declare class InteropClient extends Base {
      *
      * @example
      * ```js
-     * fin.me.interop.getAllClientsInContextGroup('red')
+     * fin.me.interop.getAllClientsInContextGroup('fdc3.channel.1')
      *     .then(clientsInContextGroup => {
      *         console.log(clientsInContextGroup)
      *     })
@@ -7893,7 +7945,7 @@ declare class InteropClient extends Base {
      *
      * @example
      * ```js
-     * fin.me.interop.getInfoForContextGroup('red')
+     * fin.me.interop.getInfoForContextGroup('fdc3.channel.1')
      *     .then(contextGroupInfo => {
      *         console.log(contextGroupInfo.displayMetadata.name)
      *         console.log(contextGroupInfo.displayMetadata.color)
@@ -7950,12 +8002,12 @@ declare class InteropClient extends Base {
      *
      * @example
      * ```js
-     * await fin.me.interop.joinContextGroup('yellow');
+     * await fin.me.interop.joinContextGroup('fdc3.channel.3');
      * await fin.me.interop.setContext({ type: 'instrument', id: { ticker: 'FOO' }});
      * const currentContext = await fin.me.interop.getCurrentContext();
      *
      * // with a specific context
-     * await fin.me.interop.joinContextGroup('yellow');
+     * await fin.me.interop.joinContextGroup('fdc3.channel.3');
      * await fin.me.interop.setContext({ type: 'country', id: { ISOALPHA3: 'US' }});
      * await fin.me.interop.setContext({ type: 'instrument', id: { ticker: 'FOO' }});
      * const currentContext = await fin.me.interop.getCurrentContext('country');
@@ -8117,7 +8169,7 @@ declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionE
  */
 declare type InteropConfig = {
     /**
-     * Context Group for the client. (green, yellow, red, etc.).
+     * Context Group ID for the client (for example, `fdc3.channel.4`).
      */
     currentContextGroup?: string | null;
     /**
@@ -8166,7 +8218,7 @@ declare class InteropModule extends Base {
      * @example
      * ```js
      * const interopConfig = {
-     *     currentContextGroup: 'green'
+     *     currentContextGroup: 'fdc3.channel.4'
      * }
      *
      * const interopBroker = await fin.Interop.init('openfin');
@@ -9270,6 +9322,20 @@ declare type LayoutSyncApi = {
     updateAccessibilityOptions(options: Partial<LayoutAccessibilityOptions>): void;
 };
 
+declare type LegacyColorChannelId = keyof typeof legacyColorChannelIds;
+
+declare const legacyColorChannelIds: {
+    readonly red: "fdc3.channel.1";
+    readonly orange: "fdc3.channel.2";
+    readonly yellow: "fdc3.channel.3";
+    readonly green: "fdc3.channel.4";
+    readonly teal: "fdc3.channel.5";
+    readonly blue: "fdc3.channel.6";
+    readonly pink: "fdc3.channel.7";
+    readonly indigo: "fdc3.channel.8";
+    readonly purple: "fdc3.channel.8";
+};
+
 /**
  * @interface
  */
@@ -9454,6 +9520,10 @@ declare type Manifest = {
     experimentalExtensionPolicyBlockedHosts?: {
         hosts: string[];
     };
+    /**
+     * Chromium extensions to install and enable for this application.
+     */
+    extensions?: ManifestExtension[];
     licenseKey: string;
     offlineAccess?: boolean;
     platform?: PlatformOptions;
@@ -9507,6 +9577,27 @@ declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
     type: 'manifest-changed';
 };
 
+/**
+ * Chromium extension entry in an application configuration.
+ *
+ * @interface
+ */
+declare type ManifestExtension = {
+    /** Chromium extension ID. */
+    id: string;
+    /** Extension server URL used to install the extension. */
+    serverURL: string;
+    /**
+     * Rules declaring where this extension may inject content scripts into
+     * non-tab surfaces (for example the AI Center). Omit or leave empty to keep
+     * the extension restricted to browser tabs — identical to historic
+     * behavior. A wildcard pattern in `match` grants blanket coverage.
+     * `matchOptions` behaves as it does for domain settings. Intended for
+     * security extensions rather than extensions that add visible UI.
+     */
+    nonTabInjections?: NonTabInjectionRule[];
+};
+
 /**
  * @interface
  */
@@ -10297,6 +10388,40 @@ declare type NonPropagatedWebContentsEvent = never;
  */
 declare type NonPropagatedWindowEvent = never;
 
+/**
+ * Rule permitting a Chromium extension to inject content scripts into non-tab
+ * web content whose URL matches the given patterns.
+ *
+ * Match patterns use the same Chromium
+ * [match pattern](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns)
+ * syntax as {@link DomainSettingsRule}. Omitting `matchOptions` uses the same
+ * default scheme-matching behavior as domain settings.
+ *
+ * @interface
+ */
+declare type NonTabInjectionRule = {
+    /**
+     * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns)
+     * specifying the content locations where the extension may inject outside
+     * browser tabs. An empty array grants no permission. A wildcard grants
+     * blanket coverage of all content locations.
+     */
+    match: string[];
+    /**
+     * Options to use when comparing URIs to the `match` patterns. Behaves as
+     * {@link DomainSettingsRule.matchOptions} / {@link RuleMatchOptions}.
+     */
+    matchOptions?: RuleMatchOptions;
+};
+
+/**
+ * Converts a legacy color-named channel ID to its canonical FDC3 user-channel ID.
+ * The removed legacy gray channel resolves to no channel.
+ */
+export declare function normalizeColorChannelId<T extends string>(colorChannelId: T): NormalizedColorChannelId<T>;
+
+declare type NormalizedColorChannelId<T extends string> = string extends T ? string | undefined : T extends 'gray' ? undefined : T extends LegacyColorChannelId ? (typeof legacyColorChannelIds)[T] : T;
+
 /* Excluded from this release type: NotCloseRequested */
 
 declare type NotificationEvent = {
@@ -10605,6 +10730,8 @@ declare namespace OpenFin_2 {
         ThemeColorsMap,
         ThemeColorId,
         ThemePalette,
+        NonTabInjectionRule,
+        ManifestExtension,
         Manifest,
         LayoutContent,
         LayoutItemConfig,

package/out/stub.d.ts

@@ -4804,6 +4804,54 @@ declare type CustomRequestHeaders = {
 
 declare type DataChannelReadyState = RTCDataChannel['readyState'];
 
+export declare type DefaultColorChannelId = keyof typeof defaultColorChannels;
+
+/**
+ * The default FDC3 user channels advertised by the Interop Broker.
+ */
+export declare const defaultColorChannels: {
+    readonly 'fdc3.channel.1': {
+        readonly name: "Channel 1";
+        readonly color: "red";
+        readonly glyph: "1";
+    };
+    readonly 'fdc3.channel.2': {
+        readonly name: "Channel 2";
+        readonly color: "orange";
+        readonly glyph: "2";
+    };
+    readonly 'fdc3.channel.3': {
+        readonly name: "Channel 3";
+        readonly color: "yellow";
+        readonly glyph: "3";
+    };
+    readonly 'fdc3.channel.4': {
+        readonly name: "Channel 4";
+        readonly color: "green";
+        readonly glyph: "4";
+    };
+    readonly 'fdc3.channel.5': {
+        readonly name: "Channel 5";
+        readonly color: "cyan";
+        readonly glyph: "5";
+    };
+    readonly 'fdc3.channel.6': {
+        readonly name: "Channel 6";
+        readonly color: "blue";
+        readonly glyph: "6";
+    };
+    readonly 'fdc3.channel.7': {
+        readonly name: "Channel 7";
+        readonly color: "magenta";
+        readonly glyph: "7";
+    };
+    readonly 'fdc3.channel.8': {
+        readonly name: "Channel 8";
+        readonly color: "purple";
+        readonly glyph: "8";
+    };
+};
+
 /**
  * @deprecated Use {@link OpenFin.DomainSettings} instead.
  * @interface
@@ -7229,17 +7277,19 @@ declare type InteropActionLoggingOption = {
  *          "interopBrokerConfiguration": {
  *              "contextGroups": [
  *                  {
- *                      "id": "green",
+ *                      "id": "fdc3.channel.4",
  *                      "displayMetadata": {
- *                          "color": "#00CC88",
- *                          "name": "green"
+ *                          "color": "green",
+ *                          "name": "Channel 4",
+ *                          "glyph": "4"
  *                      }
  *                  },
  *                  {
- *                      "id": "purple",
+ *                      "id": "fdc3.channel.8",
  *                      "displayMetadata": {
- *                          "color": "#8C61FF",
- *                          "name": "purple"
+ *                          "color": "purple",
+ *                          "name": "Channel 8",
+ *                          "glyph": "8"
  *                      }
  *                  },
  *              ]
@@ -7376,7 +7426,7 @@ declare class InteropBroker extends Base {
      * @param joinContextGroupOptions - Id of the Context Group and identity of the entity to join to the group.
      * @param senderIdentity - Identity of the client sender.
      */
-    joinContextGroup({ contextGroupId, target }: {
+    joinContextGroup({ contextGroupId: requestedContextGroupId, target }: {
         contextGroupId: string;
         target?: OpenFin_2.ClientIdentity | OpenFin_2.Identity;
     }, senderIdentity: OpenFin_2.ClientIdentity): Promise<void>;
@@ -7387,7 +7437,7 @@ declare class InteropBroker extends Base {
      * @param addClientToContextGroupOptions - Contains the contextGroupId
      * @param clientIdentity - Identity of the client sender.
      */
-    addClientToContextGroup({ contextGroupId }: {
+    addClientToContextGroup({ contextGroupId: requestedContextGroupId }: {
         contextGroupId: string;
     }, clientIdentity: OpenFin_2.ClientIdentity): Promise<void>;
     /**
@@ -7800,6 +7850,8 @@ declare class InteropBroker extends Base {
     };
     private getClientState;
     private static toObject;
+    private normalizeContextGroupStates;
+    private normalizeContextGroupId;
     static checkContextIntegrity: (context: OpenFin_2.Context) => {
         isValid: true;
     } | {
@@ -8030,7 +8082,7 @@ declare class InteropClient extends Base {
      *
      * getLastFocusedView()
      *     .then(lastFocusedViewIdentity => {
-     *         joinViewToContextGroup('red', lastFocusedViewIdentity)
+     *         joinViewToContextGroup('fdc3.channel.1', lastFocusedViewIdentity)
      *     })
      * ```
      */
@@ -8065,7 +8117,7 @@ declare class InteropClient extends Base {
      *
      * @example
      * ```js
-     * fin.me.interop.getAllClientsInContextGroup('red')
+     * fin.me.interop.getAllClientsInContextGroup('fdc3.channel.1')
      *     .then(clientsInContextGroup => {
      *         console.log(clientsInContextGroup)
      *     })
@@ -8080,7 +8132,7 @@ declare class InteropClient extends Base {
      *
      * @example
      * ```js
-     * fin.me.interop.getInfoForContextGroup('red')
+     * fin.me.interop.getInfoForContextGroup('fdc3.channel.1')
      *     .then(contextGroupInfo => {
      *         console.log(contextGroupInfo.displayMetadata.name)
      *         console.log(contextGroupInfo.displayMetadata.color)
@@ -8137,12 +8189,12 @@ declare class InteropClient extends Base {
      *
      * @example
      * ```js
-     * await fin.me.interop.joinContextGroup('yellow');
+     * await fin.me.interop.joinContextGroup('fdc3.channel.3');
      * await fin.me.interop.setContext({ type: 'instrument', id: { ticker: 'FOO' }});
      * const currentContext = await fin.me.interop.getCurrentContext();
      *
      * // with a specific context
-     * await fin.me.interop.joinContextGroup('yellow');
+     * await fin.me.interop.joinContextGroup('fdc3.channel.3');
      * await fin.me.interop.setContext({ type: 'country', id: { ISOALPHA3: 'US' }});
      * await fin.me.interop.setContext({ type: 'instrument', id: { ticker: 'FOO' }});
      * const currentContext = await fin.me.interop.getCurrentContext('country');
@@ -8309,7 +8361,7 @@ declare type InteropClientOnDisconnectionListener = (InteropBrokerDisconnectionE
  */
 declare type InteropConfig = {
     /**
-     * Context Group for the client. (green, yellow, red, etc.).
+     * Context Group ID for the client (for example, `fdc3.channel.4`).
      */
     currentContextGroup?: string | null;
     /**
@@ -8358,7 +8410,7 @@ declare class InteropModule extends Base {
      * @example
      * ```js
      * const interopConfig = {
-     *     currentContextGroup: 'green'
+     *     currentContextGroup: 'fdc3.channel.4'
      * }
      *
      * const interopBroker = await fin.Interop.init('openfin');
@@ -9654,6 +9706,20 @@ declare type LayoutSyncApi = {
     updateAccessibilityOptions(options: Partial<LayoutAccessibilityOptions>): void;
 };
 
+declare type LegacyColorChannelId = keyof typeof legacyColorChannelIds;
+
+declare const legacyColorChannelIds: {
+    readonly red: "fdc3.channel.1";
+    readonly orange: "fdc3.channel.2";
+    readonly yellow: "fdc3.channel.3";
+    readonly green: "fdc3.channel.4";
+    readonly teal: "fdc3.channel.5";
+    readonly blue: "fdc3.channel.6";
+    readonly pink: "fdc3.channel.7";
+    readonly indigo: "fdc3.channel.8";
+    readonly purple: "fdc3.channel.8";
+};
+
 /**
  * @interface
  */
@@ -9838,6 +9904,10 @@ declare type Manifest = {
     experimentalExtensionPolicyBlockedHosts?: {
         hosts: string[];
     };
+    /**
+     * Chromium extensions to install and enable for this application.
+     */
+    extensions?: ManifestExtension[];
     licenseKey: string;
     offlineAccess?: boolean;
     platform?: PlatformOptions;
@@ -9891,6 +9961,27 @@ declare type ManifestChangedEvent = BaseEvents.IdentityEvent & {
     type: 'manifest-changed';
 };
 
+/**
+ * Chromium extension entry in an application configuration.
+ *
+ * @interface
+ */
+declare type ManifestExtension = {
+    /** Chromium extension ID. */
+    id: string;
+    /** Extension server URL used to install the extension. */
+    serverURL: string;
+    /**
+     * Rules declaring where this extension may inject content scripts into
+     * non-tab surfaces (for example the AI Center). Omit or leave empty to keep
+     * the extension restricted to browser tabs — identical to historic
+     * behavior. A wildcard pattern in `match` grants blanket coverage.
+     * `matchOptions` behaves as it does for domain settings. Intended for
+     * security extensions rather than extensions that add visible UI.
+     */
+    nonTabInjections?: NonTabInjectionRule[];
+};
+
 /**
  * @interface
  */
@@ -10693,6 +10784,40 @@ declare type NonPropagatedWebContentsEvent = never;
  */
 declare type NonPropagatedWindowEvent = never;
 
+/**
+ * Rule permitting a Chromium extension to inject content scripts into non-tab
+ * web content whose URL matches the given patterns.
+ *
+ * Match patterns use the same Chromium
+ * [match pattern](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns)
+ * syntax as {@link DomainSettingsRule}. Omitting `matchOptions` uses the same
+ * default scheme-matching behavior as domain settings.
+ *
+ * @interface
+ */
+declare type NonTabInjectionRule = {
+    /**
+     * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns)
+     * specifying the content locations where the extension may inject outside
+     * browser tabs. An empty array grants no permission. A wildcard grants
+     * blanket coverage of all content locations.
+     */
+    match: string[];
+    /**
+     * Options to use when comparing URIs to the `match` patterns. Behaves as
+     * {@link DomainSettingsRule.matchOptions} / {@link RuleMatchOptions}.
+     */
+    matchOptions?: RuleMatchOptions;
+};
+
+/**
+ * Converts a legacy color-named channel ID to its canonical FDC3 user-channel ID.
+ * The removed legacy gray channel resolves to no channel.
+ */
+export declare function normalizeColorChannelId<T extends string>(colorChannelId: T): NormalizedColorChannelId<T>;
+
+declare type NormalizedColorChannelId<T extends string> = string extends T ? string | undefined : T extends 'gray' ? undefined : T extends LegacyColorChannelId ? (typeof legacyColorChannelIds)[T] : T;
+
 /**
  * @internal
  *
@@ -11014,6 +11139,8 @@ declare namespace OpenFin_2 {
         ThemeColorsMap,
         ThemeColorId,
         ThemePalette,
+        NonTabInjectionRule,
+        ManifestExtension,
         Manifest,
         LayoutContent,
         LayoutItemConfig,