@brightspace-ui/intl 3.31.5 → 3.32.0

package/README.md

@@ -272,6 +272,17 @@ const separator = getSeparator({ nonBreaking: true }); // -> ',\xa0' in en-US
 Options:
 - **nonBreaking**: a Boolean flag, whether to use non-breaking spaces instead of standard spaces; default is `false`
 
+## Terminology
+
+Use `getTerminology` to get terminology values defined by `d2l.Languages.Terminology.*` config variables.
+
+```javascript
+import { getTerminology, TerminologyKey } from '@brightspace-ui/intl/lib/terminology.js';
+
+// Get the terminology value defined by the d2l.Languages.Terminology.Educator config variable
+const educatorTerminology = getTerminology(TerminologyKey.Educator);
+```
+
 ## Language Localization
 
 The `Localize` class allows text to be displayed in the user's preferred language.

package/lib/document-locale-settings.js

@@ -4,6 +4,11 @@ const DEFAULTS = {
 	pseudoLocalization: {},
 	_fallbackLanguage: null,
 	overrides: {},
+	terminology: {
+		educator: 'teacher',
+		moduleHierarchy: 'module',
+		outcomes: 'standards'
+	},
 	timezone: { name: '', identifier: '' },
 	oslo: { batch: null, collection: null, version: null }
 };
@@ -83,6 +88,7 @@ export class DocumentLocaleSettings {
 		this._languageInitial ??= this._language;
 		this.fallbackLanguage = host.getAttribute('data-lang-default');
 		this.overrides = this._tryParseHtmlElemAttr('data-intl-overrides', DEFAULTS.overrides);
+		this.terminology = this._tryParseHtmlElemAttr('data-terminology', DEFAULTS.terminology);
 		this.timezone = this._tryParseHtmlElemAttr('data-timezone', DEFAULTS.timezone);
 		this.pseudoLocalization = this._tryParseHtmlElemAttr('data-pseudo-localization', DEFAULTS.pseudoLocalization);
 		this.oslo = this._tryParseHtmlElemAttr('data-oslo', DEFAULTS.oslo);
@@ -98,6 +104,9 @@ export class DocumentLocaleSettings {
 				this.fallbackLanguage = host.getAttribute('data-lang-default');
 			} else if (mutation.attributeName === 'data-intl-overrides') {
 				this.overrides = this._tryParseHtmlElemAttr('data-intl-overrides', DEFAULTS.overrides);
+			} else if (mutation.attributeName === 'data-terminology') {
+				this.terminology = this._tryParseHtmlElemAttr('data-terminology', DEFAULTS.terminology);
+				localeAttributeChange = true;
 			} else if (mutation.attributeName === 'data-timezone') {
 				this.timezone = this._tryParseHtmlElemAttr('data-timezone', DEFAULTS.timezone);
 				localeAttributeChange = true;

package/lib/terminology.js

@@ -0,0 +1,20 @@
+import { getDocumentLocaleSettings } from './common.js';
+
+export const TerminologyKey = Object.freeze({
+	LearningOutcomes: 'outcomes',
+	Educator: 'educator',
+	ModuleHierarchy: 'moduleHierarchy'
+});
+
+export function getTerminology(key) {
+	if (!key) {
+		throw new TypeError('Terminology key is required.');
+	}
+	if (!Object.values(TerminologyKey).includes(key)) {
+		throw new TypeError(`Invalid terminology key "${key}".`);
+	}
+
+	const terminology = getDocumentLocaleSettings().terminology;
+
+	return terminology[key];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brightspace-ui/intl",
-  "version": "3.31.5",
+  "version": "3.32.0",
   "description": "Internationalization APIs for number, date, time and file size formatting and parsing in D2L Brightspace.",
   "main": "lib/number.js",
   "type": "module",