@coveo/quantic 3.33.0 → 3.33.2

package/README.md

@@ -17,7 +17,7 @@
 
 [Salesforce cli](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm#sfdx_setup_install_cli_npm)
 
-- Run `npm install --global @salesforce/cli@2.x`
+- Run `pnpm add --global @salesforce/cli@2.x`
 - Optional: [Setup CLI autocomplete](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_autocomplete.htm)
 
 ### Update SFDX CLI Plugins
@@ -46,7 +46,7 @@ Optionally install the [VSCode Salesforce Extension Pack](https://marketplace.vi
 
 - Make sure you are at the root of `packages/quantic`.
 
-- Run `npm run setup:examples`.
+- Run `pnpm run setup:examples`.
 
 This command will create two scratch orgs for you:
 
@@ -69,7 +69,7 @@ Or you can run the individual commands below.
 #### Create a Default Scratch Org
 
 - Make sure you are in the `packages/quantic` root folder.
-- Run this command to create the default scratch org. `npm run scratch:create`.
+- Run this command to create the default scratch org. `pnpm run scratch:create`.
 - In VS Code, press Command + Shift P, enter sfdx, and select SFDX: Create a Default Scratch Org.
 - You can also run this command from the command line. `sf org create scratch --set-default --definition-file config/lws-enabled-scratch-def.json --alias Quantic__LWS_enabled`
 - `Quantic__LWS_enabled` is an alias for the scratch org that you can use in other Salesforce CLI commands. You can create any alias that you like.
@@ -87,7 +87,7 @@ Example components are available as Salesforce communities (Digital Experiences)
 To set up both communities in scratch orgs, run:
 
 ```bash
-npm run setup:examples
+pnpm run setup:examples
 ```
 
 This script creates, configures, and deploys everything required to have fully working examples in **two scratch orgs**:
@@ -110,15 +110,15 @@ https://your-salesforce-lws-disabled-scratch-org-instance.force.com/examples
 Once the community has been deployed, you can deploy the `main` or `example` components to a specific org only when needed by running the corresponding commands:
 
 ```bash
-npm run deploy:main --target-org Quantic__LWS_enabled
-npm run deploy:examples --target-org Quantic__LWS_enabled
+pnpm run deploy:main --target-org Quantic__LWS_enabled
+pnpm run deploy:examples --target-org Quantic__LWS_enabled
 ```
 
 You can replace Quantic\_\_LWS_enabled with your target org alias. For example:
 
 ```bash
-npm run deploy:main --target-org MyCustomOrg
-npm run deploy:examples --target-org MyCustomOrg
+pnpm run deploy:main --target-org MyCustomOrg
+pnpm run deploy:examples --target-org MyCustomOrg
 ```
 
 ### Run Playwright for Quantic Components
@@ -130,19 +130,19 @@ npm run deploy:examples --target-org MyCustomOrg
 To run Playwright tests, run:
 
 ```bash
-npm run e2e:playwright
+pnpm run e2e:playwright
 ```
 
 To run Playwright tests only for the scratch org where LWS is enabled, run:
 
 ```bash
-npm run e2e:playwright:lws-enabled
+pnpm run e2e:playwright:lws-enabled
 ```
 
 To run Playwright tests only for the scratch org where LWS is disabled, run:
 
 ```bash
-npm run e2e:playwright:lws-disabled
+pnpm run e2e:playwright:lws-disabled
 ```
 
 ### Run LWC unit tests for Quantic Components
@@ -150,20 +150,20 @@ npm run e2e:playwright:lws-disabled
 To run LWC unit tests directly in your console, run:
 
 ```bash
-npm run test:unit
+pnpm run test:unit
 ```
 
 To run specific file/components LWC unit tests directly in your console, run:
 
 ```bash
-npm run test:unit -p force-app/main/default/lwc/nameOfComponent/
+pnpm run test:unit -p force-app/main/default/lwc/nameOfComponent/
 ```
 
 ## Use Quantic From Source
 
-After you have cloned the repository and have run `npm install`, run the following commands:
+After you have cloned the repository and have run `pnpm install`, run the following commands:
 
-- `npm run build`
+- `pnpm run build`
 - `sf project deploy start --source-dir force-app/main/default`
 
 ## Other Useful Commands

package/force-app/main/default/lwc/quanticAriaLive/__tests__/quanticAriaLive.test.js

@@ -0,0 +1,106 @@
+import {cleanup, buildCreateTestComponent, flushPromises} from 'c/testUtils';
+import QuanticAriaLive from 'c/quanticAriaLive';
+
+const createTestComponent = buildCreateTestComponent(
+  QuanticAriaLive,
+  'c-quantic-aria-live'
+);
+
+describe('c-quantic-aria-live', () => {
+  afterEach(() => {
+    cleanup();
+  });
+
+  describe('registerRegion', () => {
+    it('should register a new region with default values', async () => {
+      const element = createTestComponent();
+      element.registerRegion('testRegion');
+      await flushPromises();
+
+      const region = element.shadowRoot.querySelector(
+        '[data-key="testRegion"]'
+      );
+      expect(region).not.toBeNull();
+      expect(region.getAttribute('aria-live')).toBe('polite');
+      expect(region.textContent).toBe('');
+    });
+
+    it('should register a new region with assertive set to true', async () => {
+      const element = createTestComponent();
+      element.registerRegion('testRegion', true);
+      await flushPromises();
+
+      const region = element.shadowRoot.querySelector(
+        '[data-key="testRegion"]'
+      );
+      expect(region).not.toBeNull();
+      expect(region.getAttribute('aria-live')).toBe('assertive');
+      expect(region.textContent).toBe('');
+    });
+
+    it('should not overwrite an existing region', async () => {
+      const element = createTestComponent();
+      element.registerRegion('testRegion');
+      element.registerRegion('testRegion', true);
+      await flushPromises();
+
+      const region = element.shadowRoot.querySelector(
+        '[data-key="testRegion"]'
+      );
+      expect(region).not.toBeNull();
+      expect(region.getAttribute('aria-live')).toBe('polite'); // Should not override the initial aria-live attribute
+      expect(region.textContent).toBe('');
+    });
+  });
+
+  describe('updateMessage', () => {
+    it('should update the message and assertive property of an existing region', async () => {
+      const element = createTestComponent();
+      await flushPromises();
+      element.registerRegion('testRegion');
+      element.updateMessage('testRegion', 'New message', true);
+      await flushPromises();
+
+      const region = element.shadowRoot.querySelector(
+        '[data-key="testRegion"]'
+      );
+      expect(region).not.toBeNull();
+      expect(region.getAttribute('aria-live')).toBe('assertive');
+      expect(region.textContent).toBe('New message');
+    });
+
+    it('should create a new region if it does not exist', async () => {
+      const element = createTestComponent();
+      element.updateMessage('newRegion', 'Hello world', false);
+      await flushPromises();
+
+      const region = element.shadowRoot.querySelector('[data-key="newRegion"]');
+      expect(region).not.toBeNull();
+      expect(region.getAttribute('aria-live')).toBe('polite');
+      expect(region.textContent).toBe('Hello world');
+    });
+  });
+
+  describe('when multiple regions are registered', () => {
+    it('should correctly handle multiple regions', async () => {
+      const element = createTestComponent();
+      element.registerRegion('region1');
+      element.updateMessage('region1', 'Message 1', true);
+      element.registerRegion('region2');
+      element.updateMessage('region2', 'Message 2');
+      await flushPromises();
+
+      const regions = element.shadowRoot.querySelectorAll('[data-key]');
+      expect(regions.length).toBe(2);
+      const region1 = element.shadowRoot.querySelector('[data-key="region1"]');
+      expect(region1).not.toBeNull();
+      expect(region1.getAttribute('aria-live')).toBe('assertive');
+      expect(region1.textContent).toBe('Message 1');
+
+      const region2 = element.shadowRoot.querySelector('[data-key="region2"]');
+      expect(region2).not.toBeNull();
+      expect(region2.getAttribute('aria-live')).toBe('polite');
+      expect(region2.textContent).toBe('Message 2');
+    });
+  });
+});