@brightspace-ui/core 2.155.1 → 2.156.0

package/README.md

@@ -110,15 +110,23 @@ npm run lint:style
 
 ### Testing
 
+To run the full suite of tests:
+
 ```shell
-# lint, unit tests and axe tests
 npm test
+```
 
+Alternatively, tests can be selectively run:
+
+```shell
 # unit tests
-npm run test:headless
+npm run test:unit
 
-# debug or run a subset of local unit tests
-npm run test:headless:watch
+# aXe accessibility tests
+npm run test:axe
+
+# translations tests
+npm run test:translations
 ```
 
 Note: The axe tests require `prefers-reduced-motion` emulation to be turned on in the dev console if debugging in a local browser.
@@ -133,44 +141,11 @@ npm run test:vdiff
 npm run test:vdiff golden
 ```
 
-## Versioning & Releasing
-
-> TL;DR: Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`. Read on for more details...
-
-The [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) is called from the `release.yml` GitHub Action workflow to handle version changes and releasing.
-
-### Version Changes
-
-All version changes should obey [semantic versioning](https://semver.org/) rules:
-1. **MAJOR** version when you make incompatible API changes,
-2. **MINOR** version when you add functionality in a backwards compatible manner, and
-3. **PATCH** version when you make backwards compatible bug fixes.
-
-The next version number will be determined from the commit messages since the previous release. Our semantic-release configuration uses the [Angular convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) when analyzing commits:
-* Commits which are prefixed with `fix:` or `perf:` will trigger a `patch` release. Example: `fix: validate input before using`
-* Commits which are prefixed with `feat:` will trigger a `minor` release. Example: `feat: add toggle() method`
-* To trigger a MAJOR release, include `BREAKING CHANGE:` with a space or two newlines in the footer of the commit message
-* Other suggested prefixes which will **NOT** trigger a release: `build:`, `ci:`, `docs:`, `style:`, `refactor:` and `test:`. Example: `docs: adding README for new component`
-
-To revert a change, add the `revert:` prefix to the original commit message. This will cause the reverted change to be omitted from the release notes. Example: `revert: fix: validate input before using`.
-
-### Releases
-
-When a release is triggered, it will:
-* Update the version in `package.json`
-* Tag the commit
-* Create a GitHub release (including release notes)
-* Deploy a new package to NPM
-
-### Releasing from Maintenance Branches
-
-Occasionally you'll want to backport a feature or bug fix to an older release. `semantic-release` refers to these as [maintenance branches](https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#maintenance-branches).
+### Versioning and Releasing
 
-Maintenance branch names should be of the form: `+([0-9])?(.{+([0-9]),x}).x`.
+This repo is configured to use `semantic-release`. Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`.
 
-Regular expressions are complicated, but this essentially means branch names should look like:
-* `1.15.x` for patch releases on top of the `1.15` release (after version `1.16` exists)
-* `2.x` for feature releases on top of the `2` release (after version `3` exists)
+To learn how to create major releases and release from maintenance branches, refer to the [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) documentation.
 
 ## Future Enhancements
 

package/components/html-block/README.md

@@ -89,7 +89,7 @@ Examples are provided to display how user-authored math can be embedded within y
 
 ### Add Context Automatically to Demos and Tests
 
-You can automatically set-up the `mathjax` context for demo pages and unit tests when using `@web/dev-server` and `@web/test-runner` by adding the following plugin to your configuration.
+You can automatically set-up the `mathjax` context for demo pages and unit tests when using `@web/dev-server` by adding the following plugin to your configuration.
 
 ```javascript
 export default {
@@ -110,3 +110,12 @@ export default {
   ...
 }
 ```
+
+For tests using `@brightspace-ui/testing`, pass in the following option:
+
+```javascript
+const elem = await fixture(
+  html`<d2l-html-block html="..."></d2l-html-block>`,
+  { mathjax: { renderLatex: true } }
+);
+```

package/mixins/provider/README.md

@@ -4,10 +4,10 @@ The `ProviderMixin` and `RequesterMixin` can be used to create a DI-like system
 
 ## Usage
 
-Apply the `ProviderMixin` to the component that will be responsible for providing some data to components that request it:
+Apply the `ProviderMixin` to the component that will be responsible for providing some data to components that request it. Optionally, the `ProviderDelegate` class can be used to specify a function that will provide the value when requested. 
 
 ```js
-import { ProviderMixin } from '@brightspace-ui/core/mixins/provider/provider-mixin.js';
+import { ProviderMixin, ProviderDelegate } from '@brightspace-ui/core/mixins/provider/provider-mixin.js';
 
 class InterestingFactProvider extends ProviderMixin(LitElement) {
 	constructor() {
@@ -15,6 +15,8 @@ class InterestingFactProvider extends ProviderMixin(LitElement) {
 		this.provideInstance('d2l-interesting-fact-string', 'Olives are not the same as fish');
 		this.provideInstance('d2l-interesting-fact-object', { fact: 'Olives are not the same as fish' });
 		this.provideInstance('d2l-interesting-fact-function', x => `${x} are not the same as fish`);
+		this.provideInstance('d2l-interesting-fact-delegate', new ProviderDelegate(() => 'Olives are not the same as fish'));
+		this.provideInstance('d2l-interesting-fact-async-delegate', new ProviderDelegate(() => new Promise(...)));
 	}
 }
 ```

package/mixins/provider/provider-mixin.js

@@ -1,9 +1,20 @@
+export class ProviderDelegate {
+	constructor(delegate) {
+		this.delegate = delegate;
+	}
+}
+
 export function provideInstance(node, key, obj) {
 	if (!node._providerInstances) {
 		node._providerInstances = new Map();
 		node.addEventListener('d2l-request-instance', e => {
 			if (node._providerInstances.has(e.detail.key)) {
-				e.detail.instance = node._providerInstances.get(e.detail.key);
+				const instance = node._providerInstances.get(e.detail.key);
+				if (instance instanceof ProviderDelegate) {
+					e.detail.instance = instance.delegate();
+				} else {
+					e.detail.instance = instance;
+				}
 				e.stopPropagation();
 			}
 		});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brightspace-ui/core",
-  "version": "2.155.1",
+  "version": "2.156.0",
   "description": "A collection of accessible, free, open-source web components for building Brightspace applications",
   "type": "module",
   "repository": "https://github.com/BrightspaceUI/core.git",
@@ -18,10 +18,9 @@
     "lint:eslint": "eslint . --ext .js,.html --ignore-path .gitignore",
     "lint:style": "stylelint \"**/*.{js,html}\" --ignore-path .gitignore",
     "start": "web-dev-server --node-resolve --watch --open",
-    "test": "npm run lint && npm run test:translations && npm run test:headless && npm run test:axe",
+    "test": "npm run lint && npm run test:translations && npm run test:unit && npm run test:axe",
     "test:axe": "d2l-test-runner aXe",
-    "test:headless": "d2l-test-runner",
-    "test:headless:watch": "d2l-test-runner --watch",
+    "test:unit": "d2l-test-runner",
     "test:translations": "mfv -e -s en -p ./lang/ -i untranslated",
     "test:vdiff": "d2l-test-runner vdiff"
   },
@@ -52,7 +51,6 @@
     "@rollup/plugin-node-resolve": "^15",
     "@rollup/plugin-replace": "^5",
     "@web/dev-server": "^0.2",
-    "@web/test-runner": "^0.16",
     "axe-core": "^4",
     "chalk": "^5",
     "eslint": "^8",