@openfin/fdc3-api 42.100.40 → 42.100.43

package/out/fdc3-api-alpha.d.ts

@@ -69,6 +69,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';
 };
 
 /**
@@ -3901,7 +3905,17 @@ declare type ContentCreationRulesEvent = NamedEvent & {
      * The features string passed to `window.open()` converted to OpenFin window options
      */
     parsedFeatures: Partial<OpenFin.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';
 };
 
 /**
@@ -4243,8 +4257,7 @@ declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
      */
     location?: {
         id: string;
-        index?: number;
-    };
+    } & AddViewToStackOptions;
 };
 
 /**
@@ -8451,9 +8464,7 @@ declare type LayoutEntitiesController = {
     getParent: (id: string) => OpenFin.LayoutEntityDefinition | undefined;
     isRoot: (id: string) => boolean;
     exists: (entityId: string) => boolean;
-    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
-        index?: number;
-    }) => Promise<OpenFin.Identity>;
+    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
     removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
     createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
         position?: OpenFin.LayoutPosition;

package/out/fdc3-api-beta.d.ts

@@ -69,6 +69,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';
 };
 
 /**
@@ -3901,7 +3905,17 @@ declare type ContentCreationRulesEvent = NamedEvent & {
      * The features string passed to `window.open()` converted to OpenFin window options
      */
     parsedFeatures: Partial<OpenFin.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';
 };
 
 /**
@@ -4243,8 +4257,7 @@ declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
      */
     location?: {
         id: string;
-        index?: number;
-    };
+    } & AddViewToStackOptions;
 };
 
 /**
@@ -8451,9 +8464,7 @@ declare type LayoutEntitiesController = {
     getParent: (id: string) => OpenFin.LayoutEntityDefinition | undefined;
     isRoot: (id: string) => boolean;
     exists: (entityId: string) => boolean;
-    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
-        index?: number;
-    }) => Promise<OpenFin.Identity>;
+    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
     removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
     createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
         position?: OpenFin.LayoutPosition;

package/out/fdc3-api-public.d.ts

@@ -69,6 +69,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';
 };
 
 /**
@@ -3901,7 +3905,17 @@ declare type ContentCreationRulesEvent = NamedEvent & {
      * The features string passed to `window.open()` converted to OpenFin window options
      */
     parsedFeatures: Partial<OpenFin.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';
 };
 
 /**
@@ -4243,8 +4257,7 @@ declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
      */
     location?: {
         id: string;
-        index?: number;
-    };
+    } & AddViewToStackOptions;
 };
 
 /**
@@ -8451,9 +8464,7 @@ declare type LayoutEntitiesController = {
     getParent: (id: string) => OpenFin.LayoutEntityDefinition | undefined;
     isRoot: (id: string) => boolean;
     exists: (entityId: string) => boolean;
-    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
-        index?: number;
-    }) => Promise<OpenFin.Identity>;
+    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
     removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
     createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
         position?: OpenFin.LayoutPosition;

package/out/fdc3-api.d.ts

@@ -69,6 +69,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';
 };
 
 /**
@@ -3960,7 +3964,17 @@ declare type ContentCreationRulesEvent = NamedEvent & {
      * The features string passed to `window.open()` converted to OpenFin window options
      */
     parsedFeatures: Partial<OpenFin.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';
 };
 
 /**
@@ -4302,8 +4316,7 @@ declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
      */
     location?: {
         id: string;
-        index?: number;
-    };
+    } & AddViewToStackOptions;
 };
 
 /**
@@ -8577,9 +8590,7 @@ declare type LayoutEntitiesController = {
     getParent: (id: string) => OpenFin.LayoutEntityDefinition | undefined;
     isRoot: (id: string) => boolean;
     exists: (entityId: string) => boolean;
-    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: {
-        index?: number;
-    }) => Promise<OpenFin.Identity>;
+    addViewToStack: (stackEntityId: string, viewCreationOrReference: ViewCreationOrReference, viewInsertionOptions?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
     removeViewFromStack: (stackEntityId: string, view: OpenFin.Identity) => Promise<void>;
     createAdjacentStack: (targetId: string, views: ViewCreationOrReference[], stackCreationOptions?: {
         position?: OpenFin.LayoutPosition;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "42.100.40",
+    "version": "42.100.43",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.md",
     "private": false,