@itwin/appui-react 4.0.0-dev.3 → 4.0.0-dev.6

package/lib/esm/appui-react/widgets/WidgetState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WidgetState.js","sourceRoot":"","sources":["../../../../src/appui-react/widgets/WidgetState.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,WAAW,IAAI,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAOvE;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAC,CAAC,+EAA+E","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Widget\r\n */\r\n\r\nimport { WidgetState as UIA_WidgetState } from \"@itwin/appui-abstract\";\r\n\r\n/** Widget state enum.\r\n * @beta\r\n */\r\nexport type WidgetState = UIA_WidgetState; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Widget state enum.\r\n * @beta\r\n */\r\nexport const WidgetState = UIA_WidgetState; // eslint-disable-line @typescript-eslint/no-redeclare, deprecation/deprecation\r\n"]}

package/lib/esm/appui-react/workflow/Task.d.ts

@@ -0,0 +1,48 @@
+/** @packageDocumentation
+ * @module WorkflowTask
+ */
+import { ItemDefBase } from "../shared/ItemDefBase";
+import { ItemProps } from "../shared/ItemProps";
+/** Properties for a [[Task]]
+ * @internal
+ * @deprecated in 3.0.
+ */
+export interface TaskProps extends ItemProps {
+    id: string;
+    primaryStageId: string;
+}
+/** List of Task Properties
+ * @internal
+ * @deprecated in 3.0.
+ */
+export interface TaskPropsList {
+    tasks: TaskProps[];
+}
+/** Task class.
+ * A Task is a specific piece of work to accomplish.
+ * A Task refers to a Frontstage to activate.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export declare class Task extends ItemDefBase {
+    taskId: string;
+    primaryStageId: string;
+    constructor(taskProps: TaskProps);
+    get id(): string;
+    get isActive(): boolean;
+    set isActive(_: boolean);
+    onActivated(): Promise<void>;
+}
+/** Task Manager class.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export declare class TaskManager {
+    private static _tasks;
+    static loadTasks(taskListDef: TaskPropsList): void;
+    static loadTaskDefs(taskDefs: TaskProps[]): void;
+    static loadTaskDef(taskDef: TaskProps): void;
+    static findTask(taskId: string): Task | undefined;
+    static addTask(taskId: string, task: Task): void;
+}
+//# sourceMappingURL=Task.d.ts.map

package/lib/esm/appui-react/workflow/Task.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/workflow/Task.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAGhD;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB;AAED;;;;;GAKG;AACH,qBAAa,IAAK,SAAQ,WAAW;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;gBAElB,SAAS,EAAE,SAAS;IAOhC,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED,IAAoB,QAAQ,IAAI,OAAO,CAOtC;IAED,IAAoB,QAAQ,CAAC,CAAC,EAAE,OAAO,EAEtC;IAEY,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;CAK1C;AAID;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAC,MAAM,CAA8C;WAErD,SAAS,CAAC,WAAW,EAAE,aAAa;WAIpC,YAAY,CAAC,QAAQ,EAAE,SAAS,EAAE;WAMlC,WAAW,CAAC,OAAO,EAAE,SAAS;WAK9B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;WAI1C,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI;CAGjD"}

package/lib/esm/appui-react/workflow/Task.js

@@ -0,0 +1,68 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module WorkflowTask
+ */
+/* eslint-disable deprecation/deprecation */
+import { FrontstageManager } from "../frontstage/FrontstageManager";
+import { ItemDefBase } from "../shared/ItemDefBase";
+import { WorkflowManager } from "./Workflow";
+/** Task class.
+ * A Task is a specific piece of work to accomplish.
+ * A Task refers to a Frontstage to activate.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export class Task extends ItemDefBase {
+    constructor(taskProps) {
+        super(taskProps);
+        this.taskId = taskProps.id;
+        this.primaryStageId = taskProps.primaryStageId;
+    }
+    get id() {
+        return this.taskId;
+    }
+    get isActive() {
+        let isActive = false;
+        if (WorkflowManager.activeWorkflow && WorkflowManager.activeWorkflow.activeTask === this)
+            isActive = true;
+        return isActive;
+    }
+    set isActive(_) {
+        // do nothing - needed because subclassing from ItemDefBase
+    }
+    async onActivated() {
+        const frontstage = await FrontstageManager.getFrontstageDef(this.primaryStageId);
+        if (frontstage)
+            await FrontstageManager.setActiveFrontstageDef(frontstage);
+    }
+}
+// -----------------------------------------------------------------------------
+/** Task Manager class.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export class TaskManager {
+    static loadTasks(taskListDef) {
+        this.loadTaskDefs(taskListDef.tasks);
+    }
+    static loadTaskDefs(taskDefs) {
+        taskDefs.map((taskDef, _index) => {
+            this.loadTaskDef(taskDef);
+        });
+    }
+    static loadTaskDef(taskDef) {
+        const task = new Task(taskDef);
+        this.addTask(taskDef.id, task);
+    }
+    static findTask(taskId) {
+        return this._tasks.get(taskId);
+    }
+    static addTask(taskId, task) {
+        this._tasks.set(taskId, task);
+    }
+}
+TaskManager._tasks = new Map();
+//# sourceMappingURL=Task.js.map

package/lib/esm/appui-react/workflow/Task.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Task.js","sourceRoot":"","sources":["../../../../src/appui-react/workflow/Task.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,4CAA4C;AAE5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAmB7C;;;;;GAKG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IAInC,YAAY,SAAoB;QAC9B,KAAK,CAAC,SAAS,CAAC,CAAC;QAEjB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC,cAAc,CAAC;IACjD,CAAC;IAED,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAoB,QAAQ;QAC1B,IAAI,QAAQ,GAAG,KAAK,CAAC;QAErB,IAAI,eAAe,CAAC,cAAc,IAAI,eAAe,CAAC,cAAc,CAAC,UAAU,KAAK,IAAI;YACtF,QAAQ,GAAG,IAAI,CAAC;QAElB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAoB,QAAQ,CAAC,CAAU;QACrC,2DAA2D;IAC7D,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,MAAM,UAAU,GAAG,MAAM,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACjF,IAAI,UAAU;YACZ,MAAM,iBAAiB,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAC/D,CAAC;CACF;AAED,gFAAgF;AAEhF;;;GAGG;AACH,MAAM,OAAO,WAAW;IAGf,MAAM,CAAC,SAAS,CAAC,WAA0B;QAChD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,QAAqB;QAC9C,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC/B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,OAAkB;QAC1C,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,MAAc;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,OAAO,CAAC,MAAc,EAAE,IAAU;QAC9C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChC,CAAC;;AAvBc,kBAAM,GAAsB,IAAI,GAAG,EAAgB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module WorkflowTask\r\n */\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\r\nimport { ItemProps } from \"../shared/ItemProps\";\r\nimport { WorkflowManager } from \"./Workflow\";\r\n\r\n/** Properties for a [[Task]]\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport interface TaskProps extends ItemProps {\r\n  id: string;\r\n  primaryStageId: string;\r\n}\r\n\r\n/** List of Task Properties\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport interface TaskPropsList {\r\n  tasks: TaskProps[];\r\n}\r\n\r\n/** Task class.\r\n * A Task is a specific piece of work to accomplish.\r\n * A Task refers to a Frontstage to activate.\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport class Task extends ItemDefBase {\r\n  public taskId: string;\r\n  public primaryStageId: string;\r\n\r\n  constructor(taskProps: TaskProps) {\r\n    super(taskProps);\r\n\r\n    this.taskId = taskProps.id;\r\n    this.primaryStageId = taskProps.primaryStageId;\r\n  }\r\n\r\n  public get id(): string {\r\n    return this.taskId;\r\n  }\r\n\r\n  public override get isActive(): boolean {\r\n    let isActive = false;\r\n\r\n    if (WorkflowManager.activeWorkflow && WorkflowManager.activeWorkflow.activeTask === this)\r\n      isActive = true;\r\n\r\n    return isActive;\r\n  }\r\n\r\n  public override set isActive(_: boolean) {\r\n    // do nothing - needed because subclassing from ItemDefBase\r\n  }\r\n\r\n  public async onActivated(): Promise<void> {\r\n    const frontstage = await FrontstageManager.getFrontstageDef(this.primaryStageId);\r\n    if (frontstage)\r\n      await FrontstageManager.setActiveFrontstageDef(frontstage);\r\n  }\r\n}\r\n\r\n// -----------------------------------------------------------------------------\r\n\r\n/** Task Manager class.\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport class TaskManager {\r\n  private static _tasks: Map<string, Task> = new Map<string, Task>();\r\n\r\n  public static loadTasks(taskListDef: TaskPropsList) {\r\n    this.loadTaskDefs(taskListDef.tasks);\r\n  }\r\n\r\n  public static loadTaskDefs(taskDefs: TaskProps[]) {\r\n    taskDefs.map((taskDef, _index) => {\r\n      this.loadTaskDef(taskDef);\r\n    });\r\n  }\r\n\r\n  public static loadTaskDef(taskDef: TaskProps) {\r\n    const task = new Task(taskDef);\r\n    this.addTask(taskDef.id, task);\r\n  }\r\n\r\n  public static findTask(taskId: string): Task | undefined {\r\n    return this._tasks.get(taskId);\r\n  }\r\n\r\n  public static addTask(taskId: string, task: Task) {\r\n    this._tasks.set(taskId, task);\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/workflow/Workflow.d.ts

@@ -0,0 +1,153 @@
+/** @packageDocumentation
+ * @module WorkflowTask
+ */
+import { UiEvent } from "@itwin/core-react";
+import { ItemDefBase } from "../shared/ItemDefBase";
+import { ItemProps } from "../shared/ItemProps";
+import { Task } from "./Task";
+/** Properties for a [[Workflow]].
+ * @internal
+ * @deprecated in 3.0.
+ */
+export interface WorkflowProps extends ItemProps {
+    id: string;
+    defaultTaskId: string;
+    tasks: string[];
+    isDefault?: boolean;
+}
+/** Workflow Properties List definition.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export interface WorkflowPropsList {
+    defaultWorkflowId: string;
+    workflows: WorkflowProps[];
+}
+/** Workflow class.
+ * A Workflow is a defined sequence of tasks used to accomplish a goal.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export declare class Workflow extends ItemDefBase {
+    /** Id of the Workflow */
+    workflowId: string;
+    /** Default Task Id */
+    defaultTaskId: string;
+    /** Active Task Id */
+    activeTaskId: string | null;
+    /** Indicates whether this Workflow is the default */
+    isDefault: boolean;
+    private _taskIds;
+    private _tasks;
+    constructor(workflowDef: WorkflowProps);
+    /** Gets the Id of the Workflow. */
+    get id(): string;
+    /** Gets the active Task. */
+    get activeTask(): Task | undefined;
+    /** Gets a Task with a given Id.
+     * @param taskId Id of the Task to get
+     */
+    getTask(taskId: string): Task | undefined;
+    /** Gets the last active Task. If no Task is active, it returns the default Task.
+     */
+    get lastActiveTask(): Task | undefined;
+    /** Determines if the Workflow is active.
+     */
+    get isActive(): boolean;
+    set isActive(_: boolean);
+    /** Sets a Task as active.
+     * @param task  The Task to set as active
+     */
+    setActiveTask(task: Task): Promise<void>;
+    /** Gets an array of sorted Tasks in the Workflow. */
+    getSortedTasks(): Task[];
+}
+/** Workflow Activated Event Args class.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export interface WorkflowActivatedEventArgs {
+    workflowId?: string;
+    workflow?: Workflow;
+}
+/** Workflow Activated Event class.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export declare class WorkflowActivatedEvent extends UiEvent<WorkflowActivatedEventArgs> {
+}
+/** Task Activated Event Args class.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export interface TaskActivatedEventArgs {
+    taskId?: string;
+    task?: Task;
+    workflowId: string;
+    workflow: Workflow;
+}
+/** Task Activated Event class.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export declare class TaskActivatedEvent extends UiEvent<TaskActivatedEventArgs> {
+}
+/** Workflow Manager class.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export declare class WorkflowManager {
+    private static _workflows;
+    private static _activeWorkflow;
+    private static _defaultWorkflowId;
+    /** Get Workflow Activated event. */
+    static readonly onWorkflowActivatedEvent: WorkflowActivatedEvent;
+    /** Get Task Activated event. */
+    static readonly onTaskActivatedEvent: TaskActivatedEvent;
+    /** Loads one or more Workflows.
+     * @param workflowPropsList  the list of Workflows to load
+     */
+    static loadWorkflows(workflowPropsList: WorkflowPropsList): void;
+    private static loadWorkflowDefs;
+    /** Loads a Workflow.
+     * @param workflowProps  Properties of the Workflow to load
+     */
+    static loadWorkflow(workflowProps: WorkflowProps): void;
+    /** Adds a Workflow.
+     * @param workflowId  Id of the Workflow to add
+     * @param workflow    The Workflow to add
+     */
+    static addWorkflow(workflowId: string, workflow: Workflow): void;
+    /** Finds a Workflow with a given Id.
+     * @param workflowId  Id of the Workflow to find
+     * @returns The Workflow if found, or undefined if not found
+     */
+    static findWorkflow(workflowId: string): Workflow | undefined;
+    /** Sets the active Workflow
+     * @param workflow  The Workflow to set as active
+     */
+    static setActiveWorkflow(workflow: Workflow | undefined): void;
+    /** Sets the active Workflow and Task
+     * @param workflow  The Workflow to set as active
+     * @param task      The Task to set as active
+     */
+    static setActiveWorkflowAndTask(workflow: Workflow, task: Task): Promise<void>;
+    /** Gets the active Workflow */
+    static get activeWorkflow(): Workflow | undefined;
+    /** Gets the active Workflow id */
+    static get activeWorkflowId(): string;
+    /** Gets the active Task */
+    static get activeTask(): Task | undefined;
+    /** Gets the active Task id */
+    static get activeTaskId(): string;
+    /** Gets the Id of the default Workflow */
+    static get defaultWorkflowId(): string;
+    /** Sets the Id of the default Workflow */
+    static setDefaultWorkflowId(id: string): void;
+    /** Removes a Workflow
+     * @param workflow  The Workflow to remove
+     */
+    static removeWorkflow(workflow: Workflow): boolean;
+    static getSortedWorkflows(): Workflow[];
+}
+//# sourceMappingURL=Workflow.d.ts.map

package/lib/esm/appui-react/workflow/Workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Workflow.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/workflow/Workflow.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,OAAO,EAAE,IAAI,EAAe,MAAM,QAAQ,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED;;;;GAIG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,yBAAyB;IAClB,UAAU,EAAE,MAAM,CAAC;IAC1B,sBAAsB;IACf,aAAa,EAAE,MAAM,CAAC;IAC7B,qBAAqB;IACd,YAAY,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC1C,qDAAqD;IAC9C,SAAS,EAAE,OAAO,CAAC;IAE1B,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,MAAM,CAA8C;gBAEhD,WAAW,EAAE,aAAa;IAgBtC,mCAAmC;IACnC,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED,4BAA4B;IAC5B,IAAW,UAAU,IAAI,IAAI,GAAG,SAAS,CAKxC;IAED;;OAEG;IACI,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAIhD;OACG;IACH,IAAW,cAAc,IAAI,IAAI,GAAG,SAAS,CAM5C;IAED;OACG;IACH,IAAoB,QAAQ,IAAI,OAAO,CAOtC;IAED,IAAoB,QAAQ,CAAC,CAAC,EAAE,OAAO,EAEtC;IAED;;OAEG;IACU,aAAa,CAAC,IAAI,EAAE,IAAI;IAMrC,qDAAqD;IAC9C,cAAc,IAAI,IAAI,EAAE;CAgBhC;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,OAAO,CAAC,0BAA0B,CAAC;CAAI;AAEnF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,kBAAmB,SAAQ,OAAO,CAAC,sBAAsB,CAAC;CAAI;AAE3E;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAC,UAAU,CAAsD;IAC/E,OAAO,CAAC,MAAM,CAAC,eAAe,CAAuB;IACrD,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAS;IAE1C,oCAAoC;IACpC,gBAAuB,wBAAwB,yBAAgC;IAC/E,gCAAgC;IAChC,gBAAuB,oBAAoB,qBAA4B;IAEvE;;OAEG;WACW,aAAa,CAAC,iBAAiB,EAAE,iBAAiB;IAKhE,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAM/B;;OAEG;WACW,YAAY,CAAC,aAAa,EAAE,aAAa;IAKvD;;;OAGG;WACW,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;IAIhE;;;OAGG;WACW,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAIpE;;OAEG;WACW,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI;IAKrE;;;OAGG;WACiB,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAU3F,+BAA+B;IAC/B,WAAkB,cAAc,IAAI,QAAQ,GAAG,SAAS,CAEvD;IAED,kCAAkC;IAClC,WAAkB,gBAAgB,IAAI,MAAM,CAI3C;IAED,2BAA2B;IAC3B,WAAkB,UAAU,IAAI,IAAI,GAAG,SAAS,CAI/C;IAED,8BAA8B;IAC9B,WAAkB,YAAY,IAAI,MAAM,CAOvC;IAED,0CAA0C;IAC1C,WAAkB,iBAAiB,IAAI,MAAM,CAE5C;IAED,0CAA0C;WAC5B,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAIpD;;OAEG;WACW,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;WAe3C,kBAAkB,IAAI,QAAQ,EAAE;CAgB/C"}

package/lib/esm/appui-react/workflow/Workflow.js

@@ -0,0 +1,231 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module WorkflowTask
+ */
+/* eslint-disable deprecation/deprecation */
+import { Logger } from "@itwin/core-bentley";
+import { UiEvent } from "@itwin/core-react";
+import { ItemDefBase } from "../shared/ItemDefBase";
+import { UiFramework } from "../UiFramework";
+import { TaskManager } from "./Task";
+/** Workflow class.
+ * A Workflow is a defined sequence of tasks used to accomplish a goal.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export class Workflow extends ItemDefBase {
+    constructor(workflowDef) {
+        super(workflowDef);
+        /** Active Task Id */
+        this.activeTaskId = null;
+        this._tasks = new Map();
+        this.workflowId = workflowDef.id;
+        this.defaultTaskId = workflowDef.defaultTaskId;
+        this._taskIds = workflowDef.tasks;
+        this.isDefault = (workflowDef.isDefault !== undefined) ? workflowDef.isDefault : true;
+        this._taskIds.map((taskId, _index) => {
+            const task = TaskManager.findTask(taskId);
+            // istanbul ignore else
+            if (task)
+                this._tasks.set(taskId, task);
+        });
+    }
+    /** Gets the Id of the Workflow. */
+    get id() {
+        return this.workflowId;
+    }
+    /** Gets the active Task. */
+    get activeTask() {
+        if (!this.activeTaskId)
+            return undefined;
+        return this._tasks.get(this.activeTaskId);
+    }
+    /** Gets a Task with a given Id.
+     * @param taskId Id of the Task to get
+     */
+    getTask(taskId) {
+        return this._tasks.get(taskId);
+    }
+    /** Gets the last active Task. If no Task is active, it returns the default Task.
+     */
+    get lastActiveTask() {
+        if (!this.activeTaskId) {
+            return this.getTask(this.defaultTaskId);
+        }
+        return this.getTask(this.activeTaskId);
+    }
+    /** Determines if the Workflow is active.
+     */
+    get isActive() {
+        let isActive = false;
+        if (WorkflowManager.activeWorkflow === this)
+            isActive = true;
+        return isActive;
+    }
+    set isActive(_) {
+        // do nothing - needed because subclassing from ItemDefBase
+    }
+    /** Sets a Task as active.
+     * @param task  The Task to set as active
+     */
+    async setActiveTask(task) {
+        this.activeTaskId = task.taskId;
+        await task.onActivated();
+        WorkflowManager.onTaskActivatedEvent.emit({ task, taskId: task.id, workflow: this, workflowId: this.id });
+    }
+    /** Gets an array of sorted Tasks in the Workflow. */
+    getSortedTasks() {
+        const sortedTasks = new Array();
+        for (const key of this._tasks.keys()) {
+            const task = this._tasks.get(key);
+            // istanbul ignore else
+            if (task && task.isVisible) // eslint-disable-line deprecation/deprecation
+                sortedTasks.push(task);
+        }
+        sortedTasks.sort((a, b) => {
+            return a.label.localeCompare(b.label);
+        });
+        return sortedTasks;
+    }
+}
+/** Workflow Activated Event class.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export class WorkflowActivatedEvent extends UiEvent {
+}
+/** Task Activated Event class.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export class TaskActivatedEvent extends UiEvent {
+}
+/** Workflow Manager class.
+ * @internal
+ * @deprecated in 3.0.
+ */
+export class WorkflowManager {
+    /** Loads one or more Workflows.
+     * @param workflowPropsList  the list of Workflows to load
+     */
+    static loadWorkflows(workflowPropsList) {
+        this.setDefaultWorkflowId(workflowPropsList.defaultWorkflowId);
+        WorkflowManager.loadWorkflowDefs(workflowPropsList.workflows);
+    }
+    static loadWorkflowDefs(workflowDefs) {
+        workflowDefs.map((workflowProps) => {
+            WorkflowManager.loadWorkflow(workflowProps);
+        });
+    }
+    /** Loads a Workflow.
+     * @param workflowProps  Properties of the Workflow to load
+     */
+    static loadWorkflow(workflowProps) {
+        const workflow = new Workflow(workflowProps);
+        WorkflowManager.addWorkflow(workflowProps.id, workflow);
+    }
+    /** Adds a Workflow.
+     * @param workflowId  Id of the Workflow to add
+     * @param workflow    The Workflow to add
+     */
+    static addWorkflow(workflowId, workflow) {
+        this._workflows.set(workflowId, workflow);
+    }
+    /** Finds a Workflow with a given Id.
+     * @param workflowId  Id of the Workflow to find
+     * @returns The Workflow if found, or undefined if not found
+     */
+    static findWorkflow(workflowId) {
+        return this._workflows.get(workflowId);
+    }
+    /** Sets the active Workflow
+     * @param workflow  The Workflow to set as active
+     */
+    static setActiveWorkflow(workflow) {
+        this._activeWorkflow = workflow;
+        WorkflowManager.onWorkflowActivatedEvent.emit({ workflow, workflowId: workflow ? workflow.id : undefined });
+    }
+    /** Sets the active Workflow and Task
+     * @param workflow  The Workflow to set as active
+     * @param task      The Task to set as active
+     */
+    static async setActiveWorkflowAndTask(workflow, task) {
+        // istanbul ignore else
+        if (!workflow.isActive)
+            this.setActiveWorkflow(workflow);
+        // istanbul ignore else
+        if (!task.isActive)
+            await workflow.setActiveTask(task);
+    }
+    /** Gets the active Workflow */
+    static get activeWorkflow() {
+        return this._activeWorkflow;
+    }
+    /** Gets the active Workflow id */
+    static get activeWorkflowId() {
+        if (this._activeWorkflow !== undefined)
+            return this._activeWorkflow.id;
+        return "";
+    }
+    /** Gets the active Task */
+    static get activeTask() {
+        if (this._activeWorkflow !== undefined)
+            return this._activeWorkflow.activeTask;
+        return undefined;
+    }
+    /** Gets the active Task id */
+    static get activeTaskId() {
+        if (this._activeWorkflow !== undefined) {
+            // istanbul ignore else
+            if (this._activeWorkflow.activeTask)
+                return this._activeWorkflow.activeTask.id;
+        }
+        return "";
+    }
+    /** Gets the Id of the default Workflow */
+    static get defaultWorkflowId() {
+        return this._defaultWorkflowId;
+    }
+    /** Sets the Id of the default Workflow */
+    static setDefaultWorkflowId(id) {
+        this._defaultWorkflowId = id;
+    }
+    /** Removes a Workflow
+     * @param workflow  The Workflow to remove
+     */
+    static removeWorkflow(workflow) {
+        const id = workflow.id;
+        let result = false;
+        if (this._workflows.get(id)) {
+            this._workflows.delete(id);
+            result = true;
+        }
+        else {
+            Logger.logError(UiFramework.loggerCategory(this), `removeWorkflow: Workflow with id '${id}' not found`);
+            result = false;
+        }
+        return result;
+    }
+    static getSortedWorkflows() {
+        const sortedWorkflows = new Array();
+        for (const key of this._workflows.keys()) {
+            const workflow = this._workflows.get(key);
+            // istanbul ignore else
+            if (workflow)
+                sortedWorkflows.push(workflow);
+        }
+        sortedWorkflows.sort((a, b) => {
+            return a.label.localeCompare(b.label);
+        });
+        return sortedWorkflows;
+    }
+}
+WorkflowManager._workflows = new Map();
+/** Get Workflow Activated event. */
+WorkflowManager.onWorkflowActivatedEvent = new WorkflowActivatedEvent();
+/** Get Task Activated event. */
+WorkflowManager.onTaskActivatedEvent = new TaskActivatedEvent();
+//# sourceMappingURL=Workflow.js.map

package/lib/esm/appui-react/workflow/Workflow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Workflow.js","sourceRoot":"","sources":["../../../../src/appui-react/workflow/Workflow.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,4CAA4C;AAE5C,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAQ,WAAW,EAAE,MAAM,QAAQ,CAAC;AAsB3C;;;;GAIG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAavC,YAAY,WAA0B;QACpC,KAAK,CAAC,WAAW,CAAC,CAAC;QATrB,qBAAqB;QACd,iBAAY,GAAkB,IAAI,CAAC;QAKlC,WAAM,GAAsB,IAAI,GAAG,EAAgB,CAAC;QAK1D,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,aAAa,CAAC;QAC/C,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,KAAK,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,CAAC,WAAW,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;QAEtF,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,MAAc,EAAE,EAAE;YACnD,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC1C,uBAAuB;YACvB,IAAI,IAAI;gBACN,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,mCAAmC;IACnC,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,4BAA4B;IAC5B,IAAW,UAAU;QACnB,IAAI,CAAC,IAAI,CAAC,YAAY;YACpB,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,MAAc;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;OACG;IACH,IAAW,cAAc;QACvB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACzC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACzC,CAAC;IAED;OACG;IACH,IAAoB,QAAQ;QAC1B,IAAI,QAAQ,GAAG,KAAK,CAAC;QAErB,IAAI,eAAe,CAAC,cAAc,KAAK,IAAI;YACzC,QAAQ,GAAG,IAAI,CAAC;QAElB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAoB,QAAQ,CAAC,CAAU;QACrC,2DAA2D;IAC7D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,aAAa,CAAC,IAAU;QACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC;QAChC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QACzB,eAAe,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED,qDAAqD;IAC9C,cAAc;QACnB,MAAM,WAAW,GAAG,IAAI,KAAK,EAAQ,CAAC;QAEtC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE;YACpC,MAAM,IAAI,GAAqB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpD,uBAAuB;YACvB,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,8CAA8C;gBACxE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC1B;QAED,WAAW,CAAC,IAAI,CAAC,CAAC,CAAO,EAAE,CAAO,EAAE,EAAE;YACpC,OAAO,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;CACF;AAWD;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,OAAmC;CAAI;AAcnF;;;GAGG;AACH,MAAM,OAAO,kBAAmB,SAAQ,OAA+B;CAAI;AAE3E;;;GAGG;AACH,MAAM,OAAO,eAAe;IAU1B;;OAEG;IACI,MAAM,CAAC,aAAa,CAAC,iBAAoC;QAC9D,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;QAC/D,eAAe,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,YAA6B;QAC3D,YAAY,CAAC,GAAG,CAAC,CAAC,aAA4B,EAAE,EAAE;YAChD,eAAe,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,YAAY,CAAC,aAA4B;QACrD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,CAAC;QAC7C,eAAe,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,UAAkB,EAAE,QAAkB;QAC9D,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,YAAY,CAAC,UAAkB;QAC3C,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB,CAAC,QAA8B;QAC5D,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC;QAChC,eAAe,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IAC9G,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,QAAkB,EAAE,IAAU;QACzE,uBAAuB;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ;YACpB,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEnC,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,+BAA+B;IACxB,MAAM,KAAK,cAAc;QAC9B,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,kCAAkC;IAC3B,MAAM,KAAK,gBAAgB;QAChC,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS;YACpC,OAAO,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;QACjC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,2BAA2B;IACpB,MAAM,KAAK,UAAU;QAC1B,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS;YACpC,OAAO,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC;QACzC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,8BAA8B;IACvB,MAAM,KAAK,YAAY;QAC5B,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;YACtC,uBAAuB;YACvB,IAAI,IAAI,CAAC,eAAe,CAAC,UAAU;gBACjC,OAAO,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;SAC7C;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,0CAA0C;IACnC,MAAM,KAAK,iBAAiB;QACjC,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,oBAAoB,CAAC,EAAU;QAC3C,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC7C,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAC;QACvB,IAAI,MAAM,GAAG,KAAK,CAAC;QAEnB,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YAC3B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC3B,MAAM,GAAG,IAAI,CAAC;SACf;aAAM;YACL,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,qCAAqC,EAAE,aAAa,CAAC,CAAC;YACxG,MAAM,GAAG,KAAK,CAAC;SAChB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,MAAM,CAAC,kBAAkB;QAC9B,MAAM,eAAe,GAAG,IAAI,KAAK,EAAY,CAAC;QAE9C,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE;YACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1C,uBAAuB;YACvB,IAAI,QAAQ;gBACV,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAClC;QAED,eAAe,CAAC,IAAI,CAAC,CAAC,CAAW,EAAE,CAAW,EAAE,EAAE;YAChD,OAAO,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;;AA7Ic,0BAAU,GAA0B,IAAI,GAAG,EAAoB,CAAC;AAI/E,oCAAoC;AACb,wCAAwB,GAAG,IAAI,sBAAsB,EAAE,CAAC;AAC/E,gCAAgC;AACT,oCAAoB,GAAG,IAAI,kBAAkB,EAAE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module WorkflowTask\r\n */\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { UiEvent } from \"@itwin/core-react\";\r\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\r\nimport { ItemProps } from \"../shared/ItemProps\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { Task, TaskManager } from \"./Task\";\r\n\r\n/** Properties for a [[Workflow]].\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport interface WorkflowProps extends ItemProps {\r\n  id: string;\r\n  defaultTaskId: string;\r\n  tasks: string[];\r\n  isDefault?: boolean;\r\n}\r\n\r\n/** Workflow Properties List definition.\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport interface WorkflowPropsList {\r\n  defaultWorkflowId: string;\r\n  workflows: WorkflowProps[];\r\n}\r\n\r\n/** Workflow class.\r\n * A Workflow is a defined sequence of tasks used to accomplish a goal.\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport class Workflow extends ItemDefBase {\r\n  /** Id of the Workflow */\r\n  public workflowId: string;\r\n  /** Default Task Id */\r\n  public defaultTaskId: string;\r\n  /** Active Task Id */\r\n  public activeTaskId: string | null = null;\r\n  /** Indicates whether this Workflow is the default */\r\n  public isDefault: boolean;\r\n\r\n  private _taskIds: string[];\r\n  private _tasks: Map<string, Task> = new Map<string, Task>();\r\n\r\n  constructor(workflowDef: WorkflowProps) {\r\n    super(workflowDef);\r\n\r\n    this.workflowId = workflowDef.id;\r\n    this.defaultTaskId = workflowDef.defaultTaskId;\r\n    this._taskIds = workflowDef.tasks;\r\n    this.isDefault = (workflowDef.isDefault !== undefined) ? workflowDef.isDefault : true;\r\n\r\n    this._taskIds.map((taskId: string, _index: number) => {\r\n      const task = TaskManager.findTask(taskId);\r\n      // istanbul ignore else\r\n      if (task)\r\n        this._tasks.set(taskId, task);\r\n    });\r\n  }\r\n\r\n  /** Gets the Id of the Workflow. */\r\n  public get id(): string {\r\n    return this.workflowId;\r\n  }\r\n\r\n  /** Gets the active Task. */\r\n  public get activeTask(): Task | undefined {\r\n    if (!this.activeTaskId)\r\n      return undefined;\r\n\r\n    return this._tasks.get(this.activeTaskId);\r\n  }\r\n\r\n  /** Gets a Task with a given Id.\r\n   * @param taskId Id of the Task to get\r\n   */\r\n  public getTask(taskId: string): Task | undefined {\r\n    return this._tasks.get(taskId);\r\n  }\r\n\r\n  /** Gets the last active Task. If no Task is active, it returns the default Task.\r\n   */\r\n  public get lastActiveTask(): Task | undefined {\r\n    if (!this.activeTaskId) {\r\n      return this.getTask(this.defaultTaskId);\r\n    }\r\n\r\n    return this.getTask(this.activeTaskId);\r\n  }\r\n\r\n  /** Determines if the Workflow is active.\r\n   */\r\n  public override get isActive(): boolean {\r\n    let isActive = false;\r\n\r\n    if (WorkflowManager.activeWorkflow === this)\r\n      isActive = true;\r\n\r\n    return isActive;\r\n  }\r\n\r\n  public override set isActive(_: boolean) {\r\n    // do nothing - needed because subclassing from ItemDefBase\r\n  }\r\n\r\n  /** Sets a Task as active.\r\n   * @param task  The Task to set as active\r\n   */\r\n  public async setActiveTask(task: Task) {\r\n    this.activeTaskId = task.taskId;\r\n    await task.onActivated();\r\n    WorkflowManager.onTaskActivatedEvent.emit({ task, taskId: task.id, workflow: this, workflowId: this.id });\r\n  }\r\n\r\n  /** Gets an array of sorted Tasks in the Workflow. */\r\n  public getSortedTasks(): Task[] {\r\n    const sortedTasks = new Array<Task>();\r\n\r\n    for (const key of this._tasks.keys()) {\r\n      const task: Task | undefined = this._tasks.get(key);\r\n      // istanbul ignore else\r\n      if (task && task.isVisible) // eslint-disable-line deprecation/deprecation\r\n        sortedTasks.push(task);\r\n    }\r\n\r\n    sortedTasks.sort((a: Task, b: Task) => {\r\n      return a.label.localeCompare(b.label);\r\n    });\r\n\r\n    return sortedTasks;\r\n  }\r\n}\r\n\r\n/** Workflow Activated Event Args class.\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport interface WorkflowActivatedEventArgs {\r\n  workflowId?: string;\r\n  workflow?: Workflow;\r\n}\r\n\r\n/** Workflow Activated Event class.\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport class WorkflowActivatedEvent extends UiEvent<WorkflowActivatedEventArgs> { }\r\n\r\n/** Task Activated Event Args class.\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport interface TaskActivatedEventArgs {\r\n  taskId?: string;\r\n  task?: Task;\r\n\r\n  workflowId: string;\r\n  workflow: Workflow;\r\n}\r\n\r\n/** Task Activated Event class.\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport class TaskActivatedEvent extends UiEvent<TaskActivatedEventArgs> { }\r\n\r\n/** Workflow Manager class.\r\n * @internal\r\n * @deprecated in 3.0.\r\n */\r\nexport class WorkflowManager {\r\n  private static _workflows: Map<string, Workflow> = new Map<string, Workflow>();\r\n  private static _activeWorkflow: Workflow | undefined;\r\n  private static _defaultWorkflowId: string;\r\n\r\n  /** Get Workflow Activated event. */\r\n  public static readonly onWorkflowActivatedEvent = new WorkflowActivatedEvent();\r\n  /** Get Task Activated event. */\r\n  public static readonly onTaskActivatedEvent = new TaskActivatedEvent();\r\n\r\n  /** Loads one or more Workflows.\r\n   * @param workflowPropsList  the list of Workflows to load\r\n   */\r\n  public static loadWorkflows(workflowPropsList: WorkflowPropsList) {\r\n    this.setDefaultWorkflowId(workflowPropsList.defaultWorkflowId);\r\n    WorkflowManager.loadWorkflowDefs(workflowPropsList.workflows);\r\n  }\r\n\r\n  private static loadWorkflowDefs(workflowDefs: WorkflowProps[]) {\r\n    workflowDefs.map((workflowProps: WorkflowProps) => {\r\n      WorkflowManager.loadWorkflow(workflowProps);\r\n    });\r\n  }\r\n\r\n  /** Loads a Workflow.\r\n   * @param workflowProps  Properties of the Workflow to load\r\n   */\r\n  public static loadWorkflow(workflowProps: WorkflowProps) {\r\n    const workflow = new Workflow(workflowProps);\r\n    WorkflowManager.addWorkflow(workflowProps.id, workflow);\r\n  }\r\n\r\n  /** Adds a Workflow.\r\n   * @param workflowId  Id of the Workflow to add\r\n   * @param workflow    The Workflow to add\r\n   */\r\n  public static addWorkflow(workflowId: string, workflow: Workflow) {\r\n    this._workflows.set(workflowId, workflow);\r\n  }\r\n\r\n  /** Finds a Workflow with a given Id.\r\n   * @param workflowId  Id of the Workflow to find\r\n   * @returns The Workflow if found, or undefined if not found\r\n   */\r\n  public static findWorkflow(workflowId: string): Workflow | undefined {\r\n    return this._workflows.get(workflowId);\r\n  }\r\n\r\n  /** Sets the active Workflow\r\n   * @param workflow  The Workflow to set as active\r\n   */\r\n  public static setActiveWorkflow(workflow: Workflow | undefined): void {\r\n    this._activeWorkflow = workflow;\r\n    WorkflowManager.onWorkflowActivatedEvent.emit({ workflow, workflowId: workflow ? workflow.id : undefined });\r\n  }\r\n\r\n  /** Sets the active Workflow and Task\r\n   * @param workflow  The Workflow to set as active\r\n   * @param task      The Task to set as active\r\n   */\r\n  public static async setActiveWorkflowAndTask(workflow: Workflow, task: Task): Promise<void> {\r\n    // istanbul ignore else\r\n    if (!workflow.isActive)\r\n      this.setActiveWorkflow(workflow);\r\n\r\n    // istanbul ignore else\r\n    if (!task.isActive)\r\n      await workflow.setActiveTask(task);\r\n  }\r\n\r\n  /** Gets the active Workflow */\r\n  public static get activeWorkflow(): Workflow | undefined {\r\n    return this._activeWorkflow;\r\n  }\r\n\r\n  /** Gets the active Workflow id */\r\n  public static get activeWorkflowId(): string {\r\n    if (this._activeWorkflow !== undefined)\r\n      return this._activeWorkflow.id;\r\n    return \"\";\r\n  }\r\n\r\n  /** Gets the active Task */\r\n  public static get activeTask(): Task | undefined {\r\n    if (this._activeWorkflow !== undefined)\r\n      return this._activeWorkflow.activeTask;\r\n    return undefined;\r\n  }\r\n\r\n  /** Gets the active Task id */\r\n  public static get activeTaskId(): string {\r\n    if (this._activeWorkflow !== undefined) {\r\n      // istanbul ignore else\r\n      if (this._activeWorkflow.activeTask)\r\n        return this._activeWorkflow.activeTask.id;\r\n    }\r\n    return \"\";\r\n  }\r\n\r\n  /** Gets the Id of the default Workflow */\r\n  public static get defaultWorkflowId(): string {\r\n    return this._defaultWorkflowId;\r\n  }\r\n\r\n  /** Sets the Id of the default Workflow */\r\n  public static setDefaultWorkflowId(id: string): void {\r\n    this._defaultWorkflowId = id;\r\n  }\r\n\r\n  /** Removes a Workflow\r\n   * @param workflow  The Workflow to remove\r\n   */\r\n  public static removeWorkflow(workflow: Workflow): boolean {\r\n    const id = workflow.id;\r\n    let result = false;\r\n\r\n    if (this._workflows.get(id)) {\r\n      this._workflows.delete(id);\r\n      result = true;\r\n    } else {\r\n      Logger.logError(UiFramework.loggerCategory(this), `removeWorkflow: Workflow with id '${id}' not found`);\r\n      result = false;\r\n    }\r\n\r\n    return result;\r\n  }\r\n\r\n  public static getSortedWorkflows(): Workflow[] {\r\n    const sortedWorkflows = new Array<Workflow>();\r\n\r\n    for (const key of this._workflows.keys()) {\r\n      const workflow = this._workflows.get(key);\r\n      // istanbul ignore else\r\n      if (workflow)\r\n        sortedWorkflows.push(workflow);\r\n    }\r\n\r\n    sortedWorkflows.sort((a: Workflow, b: Workflow) => {\r\n      return a.label.localeCompare(b.label);\r\n    });\r\n\r\n    return sortedWorkflows;\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/zones/FrameworkZone.d.ts

@@ -0,0 +1,44 @@
+/** @packageDocumentation
+ * @module Zone
+ */
+import * as React from "react";
+import { CommonProps, RectangleProps } from "@itwin/core-react";
+import { DisabledResizeHandles, DraggedWidgetManagerProps, WidgetManagerProps, WidgetZoneId, ZoneManagerProps, ZoneTargetType } from "@itwin/appui-layout-react";
+import { TargetChangeHandler, WidgetChangeHandler } from "../frontstage/FrontstageComposer";
+import { WidgetTabs } from "../widgets/WidgetStack";
+/** Properties for the [[FrameworkZone]] component.
+ * @internal
+ */
+export interface FrameworkZoneProps extends CommonProps {
+    activeTabIndex: number;
+    disabledResizeHandles: DisabledResizeHandles | undefined;
+    draggedWidget: DraggedWidgetManagerProps | undefined;
+    dropTarget: ZoneTargetType | undefined;
+    fillZone?: boolean;
+    getWidgetContentRef: (id: WidgetZoneId) => React.Ref<HTMLDivElement>;
+    isHidden: boolean;
+    isInFooterMode: boolean;
+    openWidgetId: WidgetZoneId | undefined;
+    targetChangeHandler: TargetChangeHandler;
+    targetedBounds?: RectangleProps;
+    widget: WidgetManagerProps | undefined;
+    widgetElement: React.ReactNode;
+    widgetChangeHandler: WidgetChangeHandler;
+    widgetTabs: WidgetTabs;
+    zone: ZoneManagerProps;
+}
+/** FrameworkZone React component.
+ * @internal
+ */
+export declare class FrameworkZone extends React.PureComponent<FrameworkZoneProps> {
+    render(): React.ReactNode;
+    private _getWidget;
+}
+/** @internal */
+export declare const getFloatingZoneBounds: (props: ZoneManagerProps) => RectangleProps;
+/** @internal */
+export declare const getFloatingZoneStyle: (props: ZoneManagerProps) => {
+    zIndex: number;
+    position: "relative";
+} | undefined;
+//# sourceMappingURL=FrameworkZone.d.ts.map

package/lib/esm/appui-react/zones/FrameworkZone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FrameworkZone.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/zones/FrameworkZone.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EACL,qBAAqB,EAAE,yBAAyB,EAAmB,kBAAkB,EAAE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EACtI,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAE5F,OAAO,EAAe,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAIjE;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,qBAAqB,GAAG,SAAS,CAAC;IACzD,aAAa,EAAE,yBAAyB,GAAG,SAAS,CAAC;IACrD,UAAU,EAAE,cAAc,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,mBAAmB,EAAE,CAAC,EAAE,EAAE,YAAY,KAAK,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACrE,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,EAAE,YAAY,GAAG,SAAS,CAAC;IACvC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACvC,aAAa,EAAE,KAAK,CAAC,SAAS,CAAC;IAC/B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC;IACxD,MAAM,IAAI,KAAK,CAAC,SAAS;IAsCzC,OAAO,CAAC,UAAU;CA2BnB;AAED,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,UAAW,gBAAgB,mBAE5D,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,UAAW,gBAAgB;;;aAK3D,CAAC"}

package/lib/esm/appui-react/zones/FrameworkZone.js

@@ -0,0 +1,47 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Zone
+ */
+import * as React from "react";
+import { Zone as NZ_Zone, } from "@itwin/appui-layout-react";
+import { SafeAreaContext } from "../safearea/SafeAreaContext";
+import { WidgetStack } from "../widgets/WidgetStack";
+import { Outline } from "./Outline";
+import { ZoneTargets } from "../dragdrop/ZoneTargets";
+/** FrameworkZone React component.
+ * @internal
+ */
+export class FrameworkZone extends React.PureComponent {
+    render() {
+        const zIndexStyle = getFloatingZoneStyle(this.props.zone);
+        const floatingBounds = getFloatingZoneBounds(this.props.zone);
+        return (React.createElement(SafeAreaContext.Consumer, null, (safeAreaInsets) => (React.createElement("span", { style: zIndexStyle },
+            React.createElement(NZ_Zone, { bounds: floatingBounds, className: this.props.className, style: this.props.style, isFloating: !!this.props.zone.floating, isHidden: this.props.isHidden, isInFooterMode: this.props.isInFooterMode, id: this.props.zone.id, safeAreaInsets: safeAreaInsets }, this._getWidget()),
+            React.createElement(NZ_Zone, { bounds: this.props.zone.bounds, id: this.props.zone.id, isInFooterMode: this.props.isInFooterMode, safeAreaInsets: safeAreaInsets },
+                React.createElement(ZoneTargets, { zoneId: this.props.zone.id, dropTarget: this.props.dropTarget, targetChangeHandler: this.props.targetChangeHandler })),
+            React.createElement(Outline, { bounds: this.props.targetedBounds })))));
+    }
+    _getWidget() {
+        const widget = this.props.widget;
+        if (!widget)
+            return null;
+        if (this.props.widgetElement !== undefined)
+            return this.props.widgetElement;
+        return (React.createElement(WidgetStack, { activeTabIndex: this.props.activeTabIndex, disabledResizeHandles: this.props.disabledResizeHandles, draggedWidget: this.props.draggedWidget, fillZone: this.props.fillZone || this.props.zone.isLayoutChanged, getWidgetContentRef: this.props.getWidgetContentRef, horizontalAnchor: widget.horizontalAnchor, isCollapsed: false, isFloating: !!this.props.zone.floating, isInStagePanel: false, openWidgetId: this.props.openWidgetId, verticalAnchor: widget.verticalAnchor, widgets: this.props.zone.widgets, widgetTabs: this.props.widgetTabs, widgetChangeHandler: this.props.widgetChangeHandler }));
+    }
+}
+/** @internal */
+export const getFloatingZoneBounds = (props) => {
+    return props.floating ? props.floating.bounds : props.bounds;
+};
+/** @internal */
+export const getFloatingZoneStyle = (props) => {
+    return props.floating ? {
+        zIndex: props.floating.stackId,
+        position: "relative",
+    } : undefined;
+};
+//# sourceMappingURL=FrameworkZone.js.map