@aurodesignsystem/auro-library 5.14.1 → 5.14.2

package/dist/_chunks/chunk-2MOEVVSZ.mjs

@@ -0,0 +1,308 @@
+import{createRequire as __auroCreateRequire}from'node:module';const require=__auroCreateRequire(import.meta.url);
+
+// scripts/utils/ansiColors.mjs
+var ESC = "\x1B";
+var RESET_COLOR = `${ESC}[39m`;
+var BOLD_ON = `${ESC}[1m`;
+var BOLD_OFF = `${ESC}[22m`;
+function colorEnabled() {
+  const { FORCE_COLOR, NO_COLOR, TERM } = process.env;
+  if (FORCE_COLOR !== void 0) {
+    return FORCE_COLOR !== "0" && FORCE_COLOR !== "false";
+  }
+  if (NO_COLOR) {
+    return false;
+  }
+  if (TERM === "dumb") {
+    return false;
+  }
+  return Boolean(process.stdout?.isTTY);
+}
+function toRgb(hexColor) {
+  if (typeof hexColor !== "string") {
+    return null;
+  }
+  const raw = hexColor.replace(/^#/u, "");
+  const expanded = raw.length === 3 ? raw.split("").map((channel) => channel + channel).join("") : raw;
+  if (!/^[0-9a-f]{6}$/iu.test(expanded)) {
+    return null;
+  }
+  return [
+    Number.parseInt(expanded.slice(0, 2), 16),
+    Number.parseInt(expanded.slice(2, 4), 16),
+    Number.parseInt(expanded.slice(4, 6), 16)
+  ];
+}
+function hex(hexColor) {
+  const rgb = toRgb(hexColor);
+  const paint = (text, bold) => {
+    const body = `${text}`;
+    if (!rgb || body === "" || !colorEnabled()) {
+      return body;
+    }
+    const color = `${ESC}[38;2;${rgb[0]};${rgb[1]};${rgb[2]}m`;
+    const open = bold ? `${color}${BOLD_ON}` : color;
+    const close = bold ? `${BOLD_OFF}${RESET_COLOR}` : RESET_COLOR;
+    return `${open}${body.replace(/(\r?\n)/gu, `${close}$1${open}`)}${close}`;
+  };
+  const colorize = (text) => paint(text, false);
+  colorize.bold = (text) => paint(text, true);
+  return colorize;
+}
+
+// scripts/utils/logger.mjs
+var Logger = class _Logger {
+  /**
+   * Logs out messages in a readable format.
+   * @param {String} message - Message to be logged.
+   * @param {false | "info" | "success" | "error" | "warn"} status - Status that determines the color of the logged message.
+   * @param {Boolean} section - If true, adds a box around the message for readability.
+   */
+  static auroLogger(message, status, section) {
+    if (status !== false) {
+      const infoColor = "#0096FF";
+      const successColor = "#4CBB17";
+      const errorColor = "#ff0000";
+      const warningColor = "#FFA500";
+      let color;
+      if (status === "info") {
+        color = infoColor;
+      } else if (status === "success") {
+        color = successColor;
+      } else if (status === "error") {
+        color = errorColor;
+      } else if (status === "warn") {
+        color = warningColor;
+      }
+      if (section) {
+        console.log(
+          hex(color)(
+            "\u256D \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256E\n"
+          )
+        );
+      }
+      console.log(hex(color)(message));
+      if (section) {
+        console.log(
+          hex(color)(
+            "\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500\u256F"
+          )
+        );
+      }
+    } else {
+      if (section) {
+        console.log(
+          "\u256D \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256E\n"
+        );
+      }
+      console.log(message);
+      if (section) {
+        console.log(
+          "\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500\u256F"
+        );
+      }
+    }
+  }
+  static log(message, section = false) {
+    _Logger.auroLogger(message, false, section);
+  }
+  static info(message, section = false) {
+    _Logger.auroLogger(message, "info", section);
+  }
+  static warn(message, section = false) {
+    _Logger.auroLogger(message, "warn", section);
+  }
+  static success(message, section = false) {
+    _Logger.auroLogger(message, "success", section);
+  }
+  static error(message, section = false) {
+    _Logger.auroLogger(message, "error", section);
+  }
+};
+
+// scripts/utils/auroLibraryUtils.mjs
+import * as fs from "fs";
+import * as path from "path";
+import { fileURLToPath } from "url";
+var AuroLibraryUtils = class {
+  getDirname() {
+    return fileURLToPath(import.meta.url);
+  }
+  get getProjectRootPath() {
+    const currentDir = this.getDirname();
+    if (!currentDir.includes("node_modules")) {
+      Logger.warn(
+        `Unable to determine best project root as node_modules 
+is not in the directory path.
+
+Assuming - "${currentDir}"`,
+        true
+      );
+      return currentDir;
+    }
+    return currentDir.split("node_modules")[0];
+  }
+  /**
+   * Copies and pastes all files in a source directory into a destination directory.
+   * @param {String} srcDir - File path of directory to copy from.
+   * @param {String} destDir - File path of directory to paste files into.
+   * @param {Boolean} removeFiles - If true, removes all files in destination directory before pasting files.
+   */
+  copyDirectory(srcDir, destDir, removeFiles) {
+    if (!fs.existsSync(srcDir)) {
+      this.auroLogger(
+        `Source directory ${srcDir} does not exist`,
+        "error",
+        false
+      );
+    } else {
+      if (removeFiles && fs.existsSync(destDir)) {
+        const destFiles = fs.readdirSync(destDir);
+        let filesRemoved = 0;
+        destFiles.forEach((file) => {
+          const filePath = path.join(destDir, file);
+          fs.unlinkSync(filePath);
+          this.auroLogger(`Removed file: ${file}`, "success", false);
+          filesRemoved += 1;
+        });
+        if (filesRemoved > 0) {
+          this.auroLogger(`Removed ${filesRemoved} files`, "success", false);
+        }
+      }
+      if (!fs.existsSync(destDir)) {
+        fs.mkdirSync(destDir);
+      }
+      const files = fs.readdirSync(srcDir);
+      files.forEach((file) => {
+        const sourceFilePath = path.join(srcDir, file);
+        const destFilePath = path.join(destDir, file);
+        const stat = fs.statSync(sourceFilePath);
+        if (stat.isDirectory()) {
+          this.copyDirectory(srcDir, destDir, removeFiles);
+        } else {
+          fs.copyFileSync(sourceFilePath, destFilePath);
+          fs.readFile(destFilePath, "utf8", (err, data) => {
+            this.formatFileContents(data, destFilePath);
+          });
+          this.auroLogger(`Copied file: ${file}`, "success");
+        }
+      });
+    }
+  }
+  /**
+   * Logs out messages in a readable format.
+   * @param {String} message - Message to be logged.
+   * @param {"info" | "success" | "error"} status - Status that determines the color of the logged message.
+   * @param {Boolean} section - If true, adds a box around the message for readability.
+   */
+  auroLogger(message, status, section) {
+    if (status) {
+      const infoColor = "#0096FF";
+      const successColor = "#4CBB17";
+      const errorColor = "#ff0000";
+      let color;
+      if (status === "info") {
+        color = infoColor;
+      } else if (status === "success") {
+        color = successColor;
+      } else if (status === "error") {
+        color = errorColor;
+      }
+      if (section) {
+        console.log(
+          hex(color)(
+            "\u256D \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256E\n"
+          )
+        );
+      }
+      console.log(hex(color)(message));
+      if (section) {
+        console.log(
+          hex(color)(
+            "\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500\u256F"
+          )
+        );
+      }
+    } else {
+      if (section) {
+        console.log(
+          "\u256D \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256E\n"
+        );
+      }
+      console.log(message);
+      if (section) {
+        console.log(
+          "\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500 \u2500\u256F"
+        );
+      }
+    }
+  }
+  /**
+   * Extracts NPM VERSION, BRANCH NAME, NPM, NAMESPACE, and NAME from package.json.
+   * @returns {Object} result - Object containing data from package.json.
+   */
+  nameExtraction() {
+    let packageJson = fs.readFileSync("package.json", "utf8", (err) => {
+      if (err) {
+        console.log("ERROR: Unable to read package.json file", err);
+      }
+    });
+    packageJson = JSON.parse(packageJson);
+    const pName = packageJson.name;
+    const npmStart = pName.indexOf("@");
+    const namespaceStart = pName.indexOf("/");
+    const nameStart = pName.indexOf("-");
+    return {
+      abstractNodeVersion: packageJson.engines.node.substring(2),
+      branchName: packageJson.release.branch,
+      npm: pName.substring(npmStart, namespaceStart),
+      namespace: pName.substring(namespaceStart + 1, nameStart),
+      namespaceCap: pName.substring(namespaceStart + 1)[0].toUpperCase() + pName.substring(namespaceStart + 2, nameStart),
+      name: pName.substring(nameStart + 1),
+      nameCap: pName.substring(nameStart + 1)[0].toUpperCase() + pName.substring(nameStart + 2),
+      version: packageJson.version,
+      tokensVersion: packageJson.peerDependencies?.["@aurodesignsystem/design-tokens"]?.substring(1) ?? "",
+      wcssVersion: packageJson.peerDependencies?.["@aurodesignsystem/webcorestylesheets"]?.substring(1) ?? ""
+    };
+  }
+  /**
+   * Replace all instances of [abstractNodeVersion], [branchName], [npm], [name], [Name], [namespace] and [Namespace] accordingly.
+   * @param {String} content - The content to be formatted.
+   * @param {String} destination - The location to write the formatted content.
+   * @returns {void}
+   */
+  formatFileContents(content, destination) {
+    const nameExtractionData = this.nameExtraction();
+    let result = content;
+    result = result.replace(
+      /\[abstractNodeVersion]/g,
+      nameExtractionData.abstractNodeVersion
+    );
+    result = result.replace(/\[branchName]/g, nameExtractionData.branchName);
+    result = result.replace(/\[npm]/g, nameExtractionData.npm);
+    result = result.replace(/\[name](?!\()/g, nameExtractionData.name);
+    result = result.replace(/\[Name](?!\()/g, nameExtractionData.nameCap);
+    result = result.replace(/\[namespace]/g, nameExtractionData.namespace);
+    result = result.replace(/\[Namespace]/g, nameExtractionData.namespaceCap);
+    result = result.replace(/\[Version]/g, nameExtractionData.version);
+    result = result.replace(/\[dtVersion]/g, nameExtractionData.tokensVersion);
+    result = result.replace(/\[wcssVersion]/g, nameExtractionData.wcssVersion);
+    result = result.replace(/(\r\n|\r|\n)[\s]+(\r\n|\r|\n)/g, "\r\n\r\n");
+    result = result.replace(/>(\r\n|\r|\n){2,}/g, ">\r\n");
+    result = result.replace(/>(\r\n|\r|\n)```/g, ">\r\n\r\n```");
+    result = result.replace(
+      />(\r\n|\r|\n){2,}```(\r\n|\r|\n)/g,
+      ">\r\n```\r\n"
+    );
+    result = result.replace(
+      /([^(\r\n|\r|\n)])(\r?\n|\r(?!\n))+#/g,
+      "$1\r\n\r\n#"
+    );
+    fs.writeFileSync(destination, result, { encoding: "utf8" });
+  }
+};
+
+export {
+  Logger,
+  AuroLibraryUtils
+};

package/dist/_chunks/chunk-H7YO7ERJ.mjs

@@ -0,0 +1,69 @@
+import{createRequire as __auroCreateRequire}from'node:module';const require=__auroCreateRequire(import.meta.url);
+import {
+  fromAuroComponentRoot,
+  generateReadmeUrl,
+  processContentForFile,
+  templateFiller
+} from "./chunk-UY4SIQT6.mjs";
+import {
+  Logger
+} from "./chunk-2MOEVVSZ.mjs";
+
+// src/build/processors/defaultDocsProcessor.mjs
+var defaultDocsProcessorConfig = {
+  overwriteLocalCopies: true,
+  remoteReadmeVersion: "master",
+  // eslint-disable-next-line no-warning-comments
+  // TODO: remove this variant when all components are updated to use latest auro-library
+  // AND the default README.md is updated to use the new paths
+  remoteReadmeVariant: "_updated_paths"
+};
+var fileConfigs = (config) => [
+  // README.md
+  {
+    identifier: "README.md",
+    input: {
+      remoteUrl: generateReadmeUrl(
+        config.remoteReadmeVersion,
+        config.remoteReadmeVariant
+      ),
+      fileName: fromAuroComponentRoot("/docTemplates/README.md"),
+      overwrite: config.overwriteLocalCopies
+    },
+    output: fromAuroComponentRoot("/README.md")
+  },
+  // index.md
+  {
+    identifier: "index.md",
+    input: fromAuroComponentRoot("/docs/partials/index.md"),
+    output: fromAuroComponentRoot("/demo/index.md"),
+    mdMagicConfig: {
+      output: {
+        directory: fromAuroComponentRoot("/demo")
+      }
+    }
+  },
+  // api.md
+  {
+    identifier: "api.md",
+    input: fromAuroComponentRoot("/docs/partials/api.md"),
+    output: fromAuroComponentRoot("/demo/api.md"),
+    preProcessors: [templateFiller.formatApiTable]
+  }
+];
+async function processDocFiles(config = defaultDocsProcessorConfig) {
+  await templateFiller.extractNames();
+  for (const fileConfig of fileConfigs(config)) {
+    try {
+      await processContentForFile(fileConfig);
+    } catch (err) {
+      Logger.error(`Error processing ${fileConfig.identifier}: ${err.message}`);
+    }
+  }
+}
+
+export {
+  defaultDocsProcessorConfig,
+  fileConfigs,
+  processDocFiles
+};

package/dist/_chunks/chunk-JLCAYVRX.mjs

@@ -0,0 +1,84 @@
+import{createRequire as __auroCreateRequire}from'node:module';const require=__auroCreateRequire(import.meta.url);
+import {
+  fromAuroComponentRoot,
+  generateWCGeneratorUrl,
+  processContentForFile,
+  templateFiller
+} from "./chunk-UY4SIQT6.mjs";
+import {
+  Logger
+} from "./chunk-2MOEVVSZ.mjs";
+
+// src/build/processors/defaultDotGithubSync.mjs
+var DOT_GITHUB_PATH = ".github";
+var ISSUE_TEMPLATE_PATH = `${DOT_GITHUB_PATH}/ISSUE_TEMPLATE`;
+var defaultGitHubSyncConfig = {
+  overwriteLocalCopies: true,
+  generatorTemplateVersion: "master"
+};
+var defaultGitHubTemplateFiles = (config = defaultGitHubSyncConfig) => [
+  // bug_report.yml
+  {
+    identifier: "bug_report.yml",
+    input: {
+      remoteUrl: generateWCGeneratorUrl(
+        config.generatorTemplateVersion,
+        `templates/${ISSUE_TEMPLATE_PATH}/bug_report.yml`
+      ),
+      fileName: fromAuroComponentRoot(
+        `docTemplates/${ISSUE_TEMPLATE_PATH}/bug_report.yml`
+      ),
+      overwrite: config.overwriteLocalCopies
+    },
+    output: fromAuroComponentRoot(`${ISSUE_TEMPLATE_PATH}/bug_report.yml`)
+  },
+  // config.yml
+  {
+    identifier: "config.yml",
+    input: {
+      remoteUrl: generateWCGeneratorUrl(
+        config.generatorTemplateVersion,
+        `templates/${ISSUE_TEMPLATE_PATH}/config.yml`
+      ),
+      fileName: fromAuroComponentRoot(
+        `docTemplates/${ISSUE_TEMPLATE_PATH}/config.yml`
+      ),
+      overwrite: config.overwriteLocalCopies
+    },
+    output: fromAuroComponentRoot(`${ISSUE_TEMPLATE_PATH}/config.yml`)
+  },
+  // PULL_REQUEST_TEMPLATE.md
+  {
+    identifier: "PULL_REQUEST_TEMPLATE.md",
+    input: {
+      remoteUrl: generateWCGeneratorUrl(
+        config.generatorTemplateVersion,
+        `templates/${DOT_GITHUB_PATH}/PULL_REQUEST_TEMPLATE.md`
+      ),
+      fileName: fromAuroComponentRoot(
+        `docTemplates/${DOT_GITHUB_PATH}/PULL_REQUEST_TEMPLATE.md`
+      ),
+      overwrite: config.overwriteLocalCopies
+    },
+    output: fromAuroComponentRoot(
+      `${DOT_GITHUB_PATH}/PULL_REQUEST_TEMPLATE.md`
+    )
+  }
+];
+async function syncGithubFiles(config = defaultGitHubSyncConfig) {
+  await templateFiller.extractNames();
+  for (const file of defaultGitHubTemplateFiles(config)) {
+    try {
+      Logger.log(`Processing file: ${file.identifier}`);
+      await processContentForFile(file);
+    } catch (error) {
+      Logger.error(
+        `Error processing file: ${file.identifier}, ${error.message}`
+      );
+    }
+  }
+}
+
+export {
+  syncGithubFiles
+};