@openfin/core 42.100.36 → 42.100.42

package/out/mock-alpha.d.ts

@@ -72,6 +72,10 @@ declare type AddViewToStackOptions = {
      * Optional index within the stack to insert the view. Defaults to 0
      */
     index?: number;
+    /**
+     * How the view should be displayed in the stack. Defaults to 'focused'
+     */
+    displayState?: 'focused' | 'background';
 };
 
 /**
@@ -3069,6 +3073,7 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
  *
  */
 declare class Clipboard_2 extends Base {
+    #private;
     /**
      * Writes data into the clipboard as plain text
      * @param writeObj The object for writing data into the clipboard
@@ -3221,6 +3226,21 @@ declare class Clipboard_2 extends Base {
     getAvailableFormats(type?: OpenFin_2.ClipboardSelectionType): Promise<Array<string>>;
 }
 
+/**
+ * Permissions for {@link Clipboard} APIs.
+ */
+declare type ClipboardApiPermissions = {
+    writeText: boolean;
+    readText: boolean;
+    writeImage: boolean;
+    readImage: boolean;
+    writeHtml: boolean;
+    readHtml: boolean;
+    writeRtf: boolean;
+    readRtf: boolean;
+    write: boolean;
+};
+
 /**
  * Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
  * @interface
@@ -3888,7 +3908,17 @@ declare type ContentCreationRulesEvent = NamedEvent & {
      * The features string passed to `window.open()` converted to OpenFin window options
      */
     parsedFeatures: Partial<OpenFin_2.WindowOptions>;
-    disposition: string;
+    /**
+     * The reported disposition of the content creation request.
+     * @remarks
+     * - `default` - The default behavior of the browser.
+     * - `foreground-tab` - The content is loaded in a new tab in the foreground. This is the default behavior for `window.open()` or a link with target=_blank.
+     * - `background-tab` - The content is loaded in a new tab in the background. This is the default behavior when clicking on a link with the `ctrl` or `cmd` key pressed.
+     * - `new-window` - The content is loaded in a new window. This is the default behavior when clicking on a link with the `shift` key pressed.
+     * - `popup` - The content is loaded in a popup window. This is the result of passing popup features to `window.open()`.
+     * - `other` - The content is loaded in some other way.
+     */
+    disposition: 'default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'popup' | 'other';
 };
 
 /**
@@ -4230,8 +4260,7 @@ declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
      */
     location?: {
         id: string;
-        index?: number;
-    };
+    } & AddViewToStackOptions;
 };
 
 /**
@@ -4502,6 +4531,13 @@ declare type DomainSettings = {
     multipleMatchBehavior?: MultipleDomainMatchBehavior;
 };
 
+/**
+ * Map of preload scripts that can enable new scripts or disable options defined preloadScripts.
+ */
+declare type DomainSettingsPreloadScripts = Record<string, {
+    enabled: boolean;
+}>;
+
 /**
  * Defines domain-conditional settings for an OpenFin application.
  * @interface
@@ -8086,9 +8122,7 @@ declare type LayoutEntitiesController = {
     getParent: (id: string) => OpenFin_2.LayoutEntityDefinition | undefined;
     isRoot: (id: string) => boolean;
     exists: (entityId: string) => boolean;
-    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
-        index?: number;
-    }) => Promise<OpenFin_2.Identity>;
+    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: OpenFin_2.AddViewToStackOptions) => Promise<OpenFin_2.Identity>;
     removeViewFromStack: (stackEntityId: string, view: OpenFin_2.Identity) => Promise<void>;
     createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
         position?: OpenFin_2.LayoutPosition;
@@ -9562,6 +9596,7 @@ declare namespace OpenFin_2 {
         OpenExternalPermission,
         DeviceInfo,
         Permissions_2 as Permissions,
+        ClipboardApiPermissions,
         PlatformWindowCreationOptions,
         PlatformWindowOptions,
         PlatformViewCreationOptions,
@@ -9678,6 +9713,7 @@ declare namespace OpenFin_2 {
         StructuredContentPermissions,
         ContentPermission,
         ScreenCaptureBehavior,
+        DomainSettingsPreloadScripts,
         PerDomainSettings,
         CopyPermissions,
         PastePermissions,
@@ -10030,6 +10066,10 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    /**
+     * {@inheritdoc DomainSettingsPreloadScripts}
+     */
+    preloadScripts?: DomainSettingsPreloadScripts;
     contentProtection?: {
         /**
          * {@inheritdoc ScreenCaptureBehavior}
@@ -10074,6 +10114,7 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
 declare type Permissions_2 = {
     Application?: Partial<ApplicationPermissions>;
     System?: Partial<SystemPermissions>;
+    Clipboard?: Partial<ClipboardApiPermissions>;
     webAPIs?: WebPermission[];
     devices?: DeviceInfo[];
 };
@@ -11769,10 +11810,6 @@ declare type PrinterInfo = {
      * Printer Description
      */
     description: string;
-    /**
-     * Printer Status
-     */
-    status: number;
     /**
      * Indicates that system's default printer.
      */

package/out/mock-beta.d.ts

@@ -72,6 +72,10 @@ declare type AddViewToStackOptions = {
      * Optional index within the stack to insert the view. Defaults to 0
      */
     index?: number;
+    /**
+     * How the view should be displayed in the stack. Defaults to 'focused'
+     */
+    displayState?: 'focused' | 'background';
 };
 
 /**
@@ -3069,6 +3073,7 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
  *
  */
 declare class Clipboard_2 extends Base {
+    #private;
     /**
      * Writes data into the clipboard as plain text
      * @param writeObj The object for writing data into the clipboard
@@ -3221,6 +3226,21 @@ declare class Clipboard_2 extends Base {
     getAvailableFormats(type?: OpenFin_2.ClipboardSelectionType): Promise<Array<string>>;
 }
 
+/**
+ * Permissions for {@link Clipboard} APIs.
+ */
+declare type ClipboardApiPermissions = {
+    writeText: boolean;
+    readText: boolean;
+    writeImage: boolean;
+    readImage: boolean;
+    writeHtml: boolean;
+    readHtml: boolean;
+    writeRtf: boolean;
+    readRtf: boolean;
+    write: boolean;
+};
+
 /**
  * Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
  * @interface
@@ -3888,7 +3908,17 @@ declare type ContentCreationRulesEvent = NamedEvent & {
      * The features string passed to `window.open()` converted to OpenFin window options
      */
     parsedFeatures: Partial<OpenFin_2.WindowOptions>;
-    disposition: string;
+    /**
+     * The reported disposition of the content creation request.
+     * @remarks
+     * - `default` - The default behavior of the browser.
+     * - `foreground-tab` - The content is loaded in a new tab in the foreground. This is the default behavior for `window.open()` or a link with target=_blank.
+     * - `background-tab` - The content is loaded in a new tab in the background. This is the default behavior when clicking on a link with the `ctrl` or `cmd` key pressed.
+     * - `new-window` - The content is loaded in a new window. This is the default behavior when clicking on a link with the `shift` key pressed.
+     * - `popup` - The content is loaded in a popup window. This is the result of passing popup features to `window.open()`.
+     * - `other` - The content is loaded in some other way.
+     */
+    disposition: 'default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'popup' | 'other';
 };
 
 /**
@@ -4230,8 +4260,7 @@ declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
      */
     location?: {
         id: string;
-        index?: number;
-    };
+    } & AddViewToStackOptions;
 };
 
 /**
@@ -4502,6 +4531,13 @@ declare type DomainSettings = {
     multipleMatchBehavior?: MultipleDomainMatchBehavior;
 };
 
+/**
+ * Map of preload scripts that can enable new scripts or disable options defined preloadScripts.
+ */
+declare type DomainSettingsPreloadScripts = Record<string, {
+    enabled: boolean;
+}>;
+
 /**
  * Defines domain-conditional settings for an OpenFin application.
  * @interface
@@ -8086,9 +8122,7 @@ declare type LayoutEntitiesController = {
     getParent: (id: string) => OpenFin_2.LayoutEntityDefinition | undefined;
     isRoot: (id: string) => boolean;
     exists: (entityId: string) => boolean;
-    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
-        index?: number;
-    }) => Promise<OpenFin_2.Identity>;
+    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: OpenFin_2.AddViewToStackOptions) => Promise<OpenFin_2.Identity>;
     removeViewFromStack: (stackEntityId: string, view: OpenFin_2.Identity) => Promise<void>;
     createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
         position?: OpenFin_2.LayoutPosition;
@@ -9562,6 +9596,7 @@ declare namespace OpenFin_2 {
         OpenExternalPermission,
         DeviceInfo,
         Permissions_2 as Permissions,
+        ClipboardApiPermissions,
         PlatformWindowCreationOptions,
         PlatformWindowOptions,
         PlatformViewCreationOptions,
@@ -9678,6 +9713,7 @@ declare namespace OpenFin_2 {
         StructuredContentPermissions,
         ContentPermission,
         ScreenCaptureBehavior,
+        DomainSettingsPreloadScripts,
         PerDomainSettings,
         CopyPermissions,
         PastePermissions,
@@ -10030,6 +10066,10 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    /**
+     * {@inheritdoc DomainSettingsPreloadScripts}
+     */
+    preloadScripts?: DomainSettingsPreloadScripts;
     contentProtection?: {
         /**
          * {@inheritdoc ScreenCaptureBehavior}
@@ -10074,6 +10114,7 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
 declare type Permissions_2 = {
     Application?: Partial<ApplicationPermissions>;
     System?: Partial<SystemPermissions>;
+    Clipboard?: Partial<ClipboardApiPermissions>;
     webAPIs?: WebPermission[];
     devices?: DeviceInfo[];
 };
@@ -11769,10 +11810,6 @@ declare type PrinterInfo = {
      * Printer Description
      */
     description: string;
-    /**
-     * Printer Status
-     */
-    status: number;
     /**
      * Indicates that system's default printer.
      */

package/out/mock-public.d.ts

@@ -72,6 +72,10 @@ declare type AddViewToStackOptions = {
      * Optional index within the stack to insert the view. Defaults to 0
      */
     index?: number;
+    /**
+     * How the view should be displayed in the stack. Defaults to 'focused'
+     */
+    displayState?: 'focused' | 'background';
 };
 
 /**
@@ -3069,6 +3073,7 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
  *
  */
 declare class Clipboard_2 extends Base {
+    #private;
     /**
      * Writes data into the clipboard as plain text
      * @param writeObj The object for writing data into the clipboard
@@ -3221,6 +3226,21 @@ declare class Clipboard_2 extends Base {
     getAvailableFormats(type?: OpenFin_2.ClipboardSelectionType): Promise<Array<string>>;
 }
 
+/**
+ * Permissions for {@link Clipboard} APIs.
+ */
+declare type ClipboardApiPermissions = {
+    writeText: boolean;
+    readText: boolean;
+    writeImage: boolean;
+    readImage: boolean;
+    writeHtml: boolean;
+    readHtml: boolean;
+    writeRtf: boolean;
+    readRtf: boolean;
+    write: boolean;
+};
+
 /**
  * Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
  * @interface
@@ -3888,7 +3908,17 @@ declare type ContentCreationRulesEvent = NamedEvent & {
      * The features string passed to `window.open()` converted to OpenFin window options
      */
     parsedFeatures: Partial<OpenFin_2.WindowOptions>;
-    disposition: string;
+    /**
+     * The reported disposition of the content creation request.
+     * @remarks
+     * - `default` - The default behavior of the browser.
+     * - `foreground-tab` - The content is loaded in a new tab in the foreground. This is the default behavior for `window.open()` or a link with target=_blank.
+     * - `background-tab` - The content is loaded in a new tab in the background. This is the default behavior when clicking on a link with the `ctrl` or `cmd` key pressed.
+     * - `new-window` - The content is loaded in a new window. This is the default behavior when clicking on a link with the `shift` key pressed.
+     * - `popup` - The content is loaded in a popup window. This is the result of passing popup features to `window.open()`.
+     * - `other` - The content is loaded in some other way.
+     */
+    disposition: 'default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'popup' | 'other';
 };
 
 /**
@@ -4230,8 +4260,7 @@ declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
      */
     location?: {
         id: string;
-        index?: number;
-    };
+    } & AddViewToStackOptions;
 };
 
 /**
@@ -4502,6 +4531,13 @@ declare type DomainSettings = {
     multipleMatchBehavior?: MultipleDomainMatchBehavior;
 };
 
+/**
+ * Map of preload scripts that can enable new scripts or disable options defined preloadScripts.
+ */
+declare type DomainSettingsPreloadScripts = Record<string, {
+    enabled: boolean;
+}>;
+
 /**
  * Defines domain-conditional settings for an OpenFin application.
  * @interface
@@ -8086,9 +8122,7 @@ declare type LayoutEntitiesController = {
     getParent: (id: string) => OpenFin_2.LayoutEntityDefinition | undefined;
     isRoot: (id: string) => boolean;
     exists: (entityId: string) => boolean;
-    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
-        index?: number;
-    }) => Promise<OpenFin_2.Identity>;
+    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: OpenFin_2.AddViewToStackOptions) => Promise<OpenFin_2.Identity>;
     removeViewFromStack: (stackEntityId: string, view: OpenFin_2.Identity) => Promise<void>;
     createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
         position?: OpenFin_2.LayoutPosition;
@@ -9562,6 +9596,7 @@ declare namespace OpenFin_2 {
         OpenExternalPermission,
         DeviceInfo,
         Permissions_2 as Permissions,
+        ClipboardApiPermissions,
         PlatformWindowCreationOptions,
         PlatformWindowOptions,
         PlatformViewCreationOptions,
@@ -9678,6 +9713,7 @@ declare namespace OpenFin_2 {
         StructuredContentPermissions,
         ContentPermission,
         ScreenCaptureBehavior,
+        DomainSettingsPreloadScripts,
         PerDomainSettings,
         CopyPermissions,
         PastePermissions,
@@ -10030,6 +10066,10 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    /**
+     * {@inheritdoc DomainSettingsPreloadScripts}
+     */
+    preloadScripts?: DomainSettingsPreloadScripts;
     contentProtection?: {
         /**
          * {@inheritdoc ScreenCaptureBehavior}
@@ -10074,6 +10114,7 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
 declare type Permissions_2 = {
     Application?: Partial<ApplicationPermissions>;
     System?: Partial<SystemPermissions>;
+    Clipboard?: Partial<ClipboardApiPermissions>;
     webAPIs?: WebPermission[];
     devices?: DeviceInfo[];
 };
@@ -11769,10 +11810,6 @@ declare type PrinterInfo = {
      * Printer Description
      */
     description: string;
-    /**
-     * Printer Status
-     */
-    status: number;
     /**
      * Indicates that system's default printer.
      */

package/out/stub.d.ts

@@ -72,6 +72,10 @@ declare type AddViewToStackOptions = {
      * Optional index within the stack to insert the view. Defaults to 0
      */
     index?: number;
+    /**
+     * How the view should be displayed in the stack. Defaults to 'focused'
+     */
+    displayState?: 'focused' | 'background';
 };
 
 /**
@@ -3125,6 +3129,7 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
  *
  */
 declare class Clipboard_2 extends Base {
+    #private;
     /**
      * Writes data into the clipboard as plain text
      * @param writeObj The object for writing data into the clipboard
@@ -3277,6 +3282,21 @@ declare class Clipboard_2 extends Base {
     getAvailableFormats(type?: OpenFin_2.ClipboardSelectionType): Promise<Array<string>>;
 }
 
+/**
+ * Permissions for {@link Clipboard} APIs.
+ */
+declare type ClipboardApiPermissions = {
+    writeText: boolean;
+    readText: boolean;
+    writeImage: boolean;
+    readImage: boolean;
+    writeHtml: boolean;
+    readHtml: boolean;
+    writeRtf: boolean;
+    readRtf: boolean;
+    write: boolean;
+};
+
 /**
  * Generated when a copy operation is blocked through {@link OpenFin.DomainSettings}.
  * @interface
@@ -3947,7 +3967,17 @@ declare type ContentCreationRulesEvent = NamedEvent & {
      * The features string passed to `window.open()` converted to OpenFin window options
      */
     parsedFeatures: Partial<OpenFin_2.WindowOptions>;
-    disposition: string;
+    /**
+     * The reported disposition of the content creation request.
+     * @remarks
+     * - `default` - The default behavior of the browser.
+     * - `foreground-tab` - The content is loaded in a new tab in the foreground. This is the default behavior for `window.open()` or a link with target=_blank.
+     * - `background-tab` - The content is loaded in a new tab in the background. This is the default behavior when clicking on a link with the `ctrl` or `cmd` key pressed.
+     * - `new-window` - The content is loaded in a new window. This is the default behavior when clicking on a link with the `shift` key pressed.
+     * - `popup` - The content is loaded in a popup window. This is the result of passing popup features to `window.open()`.
+     * - `other` - The content is loaded in some other way.
+     */
+    disposition: 'default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'popup' | 'other';
 };
 
 /**
@@ -4289,8 +4319,7 @@ declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
      */
     location?: {
         id: string;
-        index?: number;
-    };
+    } & AddViewToStackOptions;
 };
 
 /**
@@ -4561,6 +4590,13 @@ declare type DomainSettings = {
     multipleMatchBehavior?: MultipleDomainMatchBehavior;
 };
 
+/**
+ * Map of preload scripts that can enable new scripts or disable options defined preloadScripts.
+ */
+declare type DomainSettingsPreloadScripts = Record<string, {
+    enabled: boolean;
+}>;
+
 /**
  * Defines domain-conditional settings for an OpenFin application.
  * @interface
@@ -8212,9 +8248,7 @@ declare type LayoutEntitiesController = {
     getParent: (id: string) => OpenFin_2.LayoutEntityDefinition | undefined;
     isRoot: (id: string) => boolean;
     exists: (entityId: string) => boolean;
-    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
-        index?: number;
-    }) => Promise<OpenFin_2.Identity>;
+    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: OpenFin_2.AddViewToStackOptions) => Promise<OpenFin_2.Identity>;
     removeViewFromStack: (stackEntityId: string, view: OpenFin_2.Identity) => Promise<void>;
     createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
         position?: OpenFin_2.LayoutPosition;
@@ -9880,6 +9914,7 @@ declare namespace OpenFin_2 {
         OpenExternalPermission,
         DeviceInfo,
         Permissions_2 as Permissions,
+        ClipboardApiPermissions,
         PlatformWindowCreationOptions,
         PlatformWindowOptions,
         PlatformViewCreationOptions,
@@ -9996,6 +10031,7 @@ declare namespace OpenFin_2 {
         StructuredContentPermissions,
         ContentPermission,
         ScreenCaptureBehavior,
+        DomainSettingsPreloadScripts,
         PerDomainSettings,
         CopyPermissions,
         PastePermissions,
@@ -10348,6 +10384,10 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    /**
+     * {@inheritdoc DomainSettingsPreloadScripts}
+     */
+    preloadScripts?: DomainSettingsPreloadScripts;
     contentProtection?: {
         /**
          * {@inheritdoc ScreenCaptureBehavior}
@@ -10392,6 +10432,7 @@ declare type PerformanceReportEvent = Performance & BaseEvent_5 & {
 declare type Permissions_2 = {
     Application?: Partial<ApplicationPermissions>;
     System?: Partial<SystemPermissions>;
+    Clipboard?: Partial<ClipboardApiPermissions>;
     webAPIs?: WebPermission[];
     devices?: DeviceInfo[];
 };
@@ -12170,10 +12211,6 @@ declare type PrinterInfo = {
      * Printer Description
      */
     description: string;
-    /**
-     * Printer Status
-     */
-    status: number;
     /**
      * Indicates that system's default printer.
      */