feat(): support instantiateModalStack

etc/runtime.api.md

@@ -244,6 +244,9 @@ export interface ImagesFactory {
     get(name: string): string;
 }
 
+// @public (undocumented)
+export function instantiateModalStack(initialIndex?: number): ModalStack;
+
 // @public @deprecated (undocumented)
 export function isLoggedIn(): boolean | undefined;
 
@@ -276,6 +279,14 @@ export interface MatchOptions {
 // @public
 export function matchPath(pathname: string, options: MatchPathOptions): MatchResult | null;
 
+// @public (undocumented)
+export interface ModalStack {
+    // (undocumented)
+    pull: () => void;
+    // (undocumented)
+    push: () => number;
+}
+
 // @public (undocumented)
 function mountUseBrick({ renderRoot, rendererContext, scopedStores }: RenderUseBrickResult, element: HTMLElement): MountUseBrickResult;
 

packages/runtime/src/ModalStack.spec.ts

@@ -0,0 +1,47 @@
+import type { instantiateModalStack as _instantiateModalStack } from "./ModalStack.js";
+
+const defaultInitialIndex = 1000;
+
+describe("instantiateModalStack", () => {
+  let instantiateModalStack: typeof _instantiateModalStack;
+
+  beforeEach(() => {
+    jest.isolateModules(() => {
+      ({ instantiateModalStack } = require("./ModalStack.js"));
+    });
+  });
+
+  test("should push a new index onto the stack and return the correct value", () => {
+    const stack = instantiateModalStack();
+    const result = stack.push();
+    expect(result).toBe(defaultInitialIndex);
+  });
+
+  test("should increment the index correctly on multiple stack pushes", () => {
+    const stack1 = instantiateModalStack();
+    const stack2 = instantiateModalStack();
+    const stack3 = instantiateModalStack();
+
+    const result1 = stack1.push();
+    const result2 = stack2.push();
+    expect(result1).toBe(defaultInitialIndex);
+    expect(result2).toBe(defaultInitialIndex + 1);
+
+    stack1.pull();
+    const result3 = stack3.push();
+    expect(result3).toBe(defaultInitialIndex + 2);
+  });
+
+  test("should handle pushes without pull", () => {
+    const stack = instantiateModalStack();
+    const result1 = stack.push();
+    const result2 = stack.push();
+    expect(result1).toBe(defaultInitialIndex);
+    expect(result2).toBe(defaultInitialIndex);
+  });
+
+  test("should respect param of initialIndex", () => {
+    const stack = instantiateModalStack(10);
+    expect(stack.push()).toBe(10);
+  });
+});

packages/runtime/src/ModalStack.ts

@@ -0,0 +1,29 @@
+const stack: number[] = [];
+
+export interface ModalStack {
+  push: () => number;
+  pull: () => void;
+}
+
+export function instantiateModalStack(initialIndex = 1000): ModalStack {
+  let index = -1;
+  const pull = (): void => {
+    if (index > -1) {
+      const found = stack.indexOf(index);
+      // Assert: found should always be greater than -1
+      // istanbul ignore else
+      if (found > -1) {
+        stack.splice(found, 1);
+      }
+    }
+  };
+  const push = (): number => {
+    // Handle pushes without pull
+    pull();
+    // Find the next available index
+    index = (stack[stack.length - 1] ?? -1) + 1;
+    stack.push(index);
+    return index + initialIndex;
+  };
+  return { push, pull };
+}

packages/runtime/src/index.ts

@@ -40,3 +40,4 @@ export { Notification, type NotificationOptions } from "./Notification.js";
 export { Dialog, type DialogOptions } from "./Dialog.js";
 export * from "./getV2RuntimeFromDll.js";
 export { setUIVersion } from "./setUIVersion.js";
+export * from "./ModalStack.js";