@aurodesignsystem/auro-library 2.6.2 → 2.7.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Semantic Release Automated Changelog
 
+# [2.7.0](https://github.com/AlaskaAirlines/auro-library/compare/v2.6.3...v2.7.0) (2024-08-21)
+
+
+### Features
+
+* add registerComponent function ([fc3a135](https://github.com/AlaskaAirlines/auro-library/commit/fc3a135f5fad8e3b5fc022f2e0f38443b11681fc))
+
+## [2.6.3](https://github.com/AlaskaAirlines/auro-library/compare/v2.6.2...v2.6.3) (2024-08-07)
+
+
+### Bug Fixes
+
+* **readme:** update generateDocs script for dynamic readme support [#57](https://github.com/AlaskaAirlines/auro-library/issues/57) ([f3c3092](https://github.com/AlaskaAirlines/auro-library/commit/f3c3092f4c9cc61dcc9f4b55cb5f63be4127c6de))
+
 ## [2.6.2](https://github.com/AlaskaAirlines/auro-library/compare/v2.6.1...v2.6.2) (2024-08-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurodesignsystem/auro-library",
-  "version": "2.6.2",
+  "version": "2.7.0",
   "description": "This repository holds shared scripts, utilities, and workflows utilized across repositories along the Auro Design System.",
   "repository": {
     "type": "git",

package/scripts/build/generateDocs.mjs

@@ -10,10 +10,23 @@ const auroLibraryUtils = new AuroLibraryUtils();
 
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
-const readmeTemplateUrl = 'https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_esm.md';
 const dirDocTemplates = './docTemplates';
 const readmeFilePath = dirDocTemplates + '/README.md';
 
+// List of components that do not support ESM to determine which README to use
+const nonEsmComponents = ['combobox', 'datepicker', 'menu', 'pane', 'select'];
+
+function generateReadmeUrl() {
+  let nameExtractionData = nameExtraction();
+  let esmString = '';
+
+  if (!nonEsmComponents.includes(nameExtractionData.name)) {
+    esmString = '_esm';
+  }
+
+  return 'https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README' + esmString + '.md';
+}
+
 /**
  * Extract NPM, NAMESPACE and NAME from package.json
  */
@@ -25,12 +38,12 @@ function nameExtraction() {
     }
   })
 
-  packageJson = JSON.parse(packageJson); 
-
+  packageJson = JSON.parse(packageJson);
+  
   let pName = packageJson.name;
   let pVersion = packageJson.version;
-  let pdtVersion = packageJson.peerDependencies['\@aurodesignsystem/design-tokens'].substring(1)
-  let wcssVersion = packageJson.peerDependencies['\@aurodesignsystem/webcorestylesheets'].substring(1)
+  let pdtVersion = packageJson.peerDependencies['\@aurodesignsystem/design-tokens'].substring(1);
+  let wcssVersion = packageJson.peerDependencies['\@aurodesignsystem/webcorestylesheets'].substring(1);
 
   let npmStart = pName.indexOf('@');
   let namespaceStart = pName.indexOf('/');
@@ -46,7 +59,7 @@ function nameExtraction() {
     'tokensVersion': pdtVersion,
     'wcssVersion': wcssVersion
   };
- }
+}
 
 /**
  * Replace all instances of [npm], [name], [Name], [namespace] and [Namespace] accordingly
@@ -183,7 +196,6 @@ function processApiExamples() {
  * */
 
 function copyReadmeLocally() {
-
   if (!fs.existsSync(dirDocTemplates)){
     fs.mkdirSync(dirDocTemplates);
   }
@@ -196,7 +208,7 @@ function copyReadmeLocally() {
     });
   }
 
-  https.get(readmeTemplateUrl, function(response) {
+  https.get(generateReadmeUrl(), function(response) {
     let writeTemplate = response.pipe(fs.createWriteStream(readmeFilePath));
 
     writeTemplate.on('finish', () => {
@@ -214,3 +226,4 @@ function copyReadmeLocally() {
 copyReadmeLocally();
 processApiExamples();
 processDemo();
+

package/scripts/utils/runtimeUtils.mjs

@@ -8,6 +8,19 @@
 export default class AuroLibraryRuntimeUtils {
 
   /* eslint-disable jsdoc/require-param */
+
+  /**
+   * This will register a new custom element with the browser.
+   * @param {String} name - The name of the custom element.
+   * @param {Object} componentClass - The class to register as a custom element.
+   * @returns {void}
+   */
+  registerComponent(name, componentClass) {
+    if (!customElements.get(name)) {
+      customElements.define(name, class extends componentClass {});
+    }
+  }
+
   /**
    * Finds and returns the closest HTML Element based on a selector.
    * @returns {void}