@aurodesignsystem/auro-library 5.14.0 → 5.14.2

package/dist/bin/generateDocs.mjs

@@ -0,0 +1,152 @@
+import{createRequire as __auroCreateRequire}from'node:module';const require=__auroCreateRequire(import.meta.url);
+import {
+  require_markdown_magic
+} from "../_chunks/chunk-V7YBXHAI.mjs";
+import {
+  __toESM
+} from "../_chunks/chunk-TDFKN2EP.mjs";
+
+// src/bin/generateDocs.mjs
+var import_markdown_magic = __toESM(require_markdown_magic(), 1);
+import { fileURLToPath } from "node:url";
+import fs from "fs";
+import https from "https";
+import path from "path";
+var packageRoot = fileURLToPath(new URL("../../", import.meta.url));
+var readmeTemplateUrl = "https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README.md";
+var dirDocTemplates = "./docTemplates";
+var readmeFilePath = dirDocTemplates + "/README.md";
+function nameExtraction() {
+  const packageJson = fs.readFileSync("package.json", "utf8", (err, data) => {
+    if (err) {
+      console.log("ERROR: Unable to read package.json file", err);
+    }
+  });
+  const pName = JSON.parse(packageJson).name;
+  const pVersion = JSON.parse(packageJson).version;
+  const pdtVersion = JSON.parse(packageJson).peerDependencies["@aurodesignsystem/design-tokens"].substring(1);
+  const wcssVersion = JSON.parse(packageJson).peerDependencies["@aurodesignsystem/webcorestylesheets"].substring(1);
+  const npmStart = pName.indexOf("@");
+  const namespaceStart = pName.indexOf("/");
+  const nameStart = pName.indexOf("-");
+  const result = {
+    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: pVersion,
+    tokensVersion: pdtVersion,
+    wcssVersion
+  };
+  return result;
+}
+function formatTemplateFileContents(content, destination) {
+  const nameExtractionData = nameExtraction();
+  let result = content;
+  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" });
+}
+function formatApiTableContents(content, destination) {
+  const nameExtractionData = nameExtraction();
+  const wcName = nameExtractionData.namespace + "-" + nameExtractionData.name;
+  let result = content;
+  result = result.replace(
+    /\r\n|\r|\n####\s`([a-zA-Z]*)`/g,
+    `\r
+#### <a name="$1"></a>\`$1\`<a href="#" style="float: right; font-size: 1rem; font-weight: 100;">back to top</a>`
+  ).replace(/\r\n|\r|\n\|\s`([a-zA-Z]*)`/g, "\r\n| [$1](#$1)").replace(/\| \[\]\(#\)/g, "");
+  fs.writeFileSync(destination, result, { encoding: "utf8" });
+  fs.readFile("./demo/apiExamples.md", "utf8", (err, data) => {
+    formatTemplateFileContents(data, "./demo/apiExamples.md");
+  });
+}
+function processReadme() {
+  const callback = (updatedContent, outputConfig) => {
+    if (fs.existsSync("./README.md")) {
+      fs.readFile("./README.md", "utf8", (err, data) => {
+        formatTemplateFileContents(data, "./README.md");
+      });
+    } else {
+      console.log("ERROR: ./README.md file is missing");
+    }
+  };
+  const config = {
+    matchWord: "AURO-GENERATED-CONTENT",
+    outputDir: "./"
+  };
+  const markdownPath = path.join(packageRoot, "docTemplates/README.md");
+  (0, import_markdown_magic.default)(markdownPath, config, callback);
+}
+function processDemo() {
+  const callback = (updatedContent, outputConfig) => {
+    if (fs.existsSync("./demo/demo.md")) {
+      fs.readFile("./demo/demo.md", "utf8", (err, data) => {
+        formatTemplateFileContents(data, "./demo/demo.md");
+      });
+    } else {
+      console.log("ERROR: ./demo/demo.md file is missing");
+    }
+  };
+  const configDemo = {
+    matchWord: "AURO-GENERATED-CONTENT",
+    outputDir: "./demo"
+  };
+  const markdownPath = path.join(packageRoot, "docs/partials/demo.md");
+  (0, import_markdown_magic.default)(markdownPath, configDemo, callback);
+}
+function processApiExamples() {
+  const callback = (updatedContent, outputConfig) => {
+    if (fs.existsSync("./demo/apiExamples.md")) {
+      fs.readFile("./demo/apiExamples.md", "utf8", (err, data) => {
+        formatApiTableContents(data, "./demo/apiExamples.md");
+      });
+    } else {
+      console.log("ERROR: ./demo/apiExamples.md file is missing");
+    }
+  };
+  const config = {
+    matchWord: "AURO-GENERATED-CONTENT",
+    outputDir: "./demo"
+  };
+  const markdownPath = path.join(packageRoot, "docs/partials/apiExamples.md");
+  (0, import_markdown_magic.default)(markdownPath, config, callback);
+}
+function copyReadmeLocally() {
+  if (!fs.existsSync(dirDocTemplates)) {
+    fs.mkdirSync(dirDocTemplates);
+  }
+  if (!fs.existsSync(readmeFilePath)) {
+    fs.writeFile(readmeFilePath, "", (err) => {
+      if (err) {
+        console.log("ERROR: Unable to create README.md file.", err);
+      }
+    });
+  }
+  https.get(readmeTemplateUrl, (response) => {
+    const writeTemplate = response.pipe(fs.createWriteStream(readmeFilePath));
+    writeTemplate.on("finish", () => {
+      processReadme();
+    });
+  }).on("error", (err) => {
+    console.log("ERROR: Unable to fetch README.md file from server.", err);
+  });
+}
+copyReadmeLocally();
+processApiExamples();
+processDemo();

package/dist/bin/generateDocs_index.mjs

@@ -0,0 +1,152 @@
+import{createRequire as __auroCreateRequire}from'node:module';const require=__auroCreateRequire(import.meta.url);
+import {
+  require_markdown_magic
+} from "../_chunks/chunk-V7YBXHAI.mjs";
+import {
+  __toESM
+} from "../_chunks/chunk-TDFKN2EP.mjs";
+
+// src/bin/generateDocs_index.mjs
+var import_markdown_magic = __toESM(require_markdown_magic(), 1);
+import { fileURLToPath } from "node:url";
+import fs from "fs";
+import https from "https";
+import path from "path";
+var packageRoot = fileURLToPath(new URL("../../", import.meta.url));
+var readmeTemplateUrl = "https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README.md";
+var dirDocTemplates = "./docTemplates";
+var readmeFilePath = dirDocTemplates + "/README.md";
+function nameExtraction() {
+  const packageJson = fs.readFileSync("package.json", "utf8", (err, data) => {
+    if (err) {
+      console.log("ERROR: Unable to read package.json file", err);
+    }
+  });
+  const pName = JSON.parse(packageJson).name;
+  const pVersion = JSON.parse(packageJson).version;
+  const pdtVersion = JSON.parse(packageJson).peerDependencies["@aurodesignsystem/design-tokens"].substring(1);
+  const wcssVersion = JSON.parse(packageJson).peerDependencies["@aurodesignsystem/webcorestylesheets"].substring(1);
+  const npmStart = pName.indexOf("@");
+  const namespaceStart = pName.indexOf("/");
+  const nameStart = pName.indexOf("-");
+  const result = {
+    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: pVersion,
+    tokensVersion: pdtVersion,
+    wcssVersion
+  };
+  return result;
+}
+function formatTemplateFileContents(content, destination) {
+  const nameExtractionData = nameExtraction();
+  let result = content;
+  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" });
+}
+function formatApiTableContents(content, destination) {
+  const nameExtractionData = nameExtraction();
+  const wcName = nameExtractionData.namespace + "-" + nameExtractionData.name;
+  let result = content;
+  result = result.replace(
+    /\r\n|\r|\n####\s`([a-zA-Z]*)`/g,
+    `\r
+#### <a name="$1"></a>\`$1\`<a href="#" style="float: right; font-size: 1rem; font-weight: 100;">back to top</a>`
+  ).replace(/\r\n|\r|\n\|\s`([a-zA-Z]*)`/g, "\r\n| [$1](#$1)").replace(/\| \[\]\(#\)/g, "");
+  fs.writeFileSync(destination, result, { encoding: "utf8" });
+  fs.readFile("./demo/apiExamples.md", "utf8", (err, data) => {
+    formatTemplateFileContents(data, "./demo/apiExamples.md");
+  });
+}
+function processReadme() {
+  const callback = (updatedContent, outputConfig) => {
+    if (fs.existsSync("./README.md")) {
+      fs.readFile("./README.md", "utf8", (err, data) => {
+        formatTemplateFileContents(data, "./README.md");
+      });
+    } else {
+      console.log("ERROR: ./README.md file is missing");
+    }
+  };
+  const config = {
+    matchWord: "AURO-GENERATED-CONTENT",
+    outputDir: "./"
+  };
+  const markdownPath = path.join(packageRoot, "docTemplates/README.md");
+  (0, import_markdown_magic.default)(markdownPath, config, callback);
+}
+function processDemo() {
+  const callback = (updatedContent, outputConfig) => {
+    if (fs.existsSync("./demo/index.md")) {
+      fs.readFile("./demo/index.md", "utf8", (err, data) => {
+        formatTemplateFileContents(data, "./demo/index.md");
+      });
+    } else {
+      console.log("ERROR: ./demo/index.md file is missing");
+    }
+  };
+  const configDemo = {
+    matchWord: "AURO-GENERATED-CONTENT",
+    outputDir: "./demo"
+  };
+  const markdownPath = path.join(packageRoot, "docs/partials/index.md");
+  (0, import_markdown_magic.default)(markdownPath, configDemo, callback);
+}
+function processApiExamples() {
+  const callback = (updatedContent, outputConfig) => {
+    if (fs.existsSync("./demo/apiExamples.md")) {
+      fs.readFile("./demo/apiExamples.md", "utf8", (err, data) => {
+        formatApiTableContents(data, "./demo/apiExamples.md");
+      });
+    } else {
+      console.log("ERROR: ./demo/apiExamples.md file is missing");
+    }
+  };
+  const config = {
+    matchWord: "AURO-GENERATED-CONTENT",
+    outputDir: "./demo"
+  };
+  const markdownPath = path.join(packageRoot, "docs/partials/apiExamples.md");
+  (0, import_markdown_magic.default)(markdownPath, config, callback);
+}
+function copyReadmeLocally() {
+  if (!fs.existsSync(dirDocTemplates)) {
+    fs.mkdirSync(dirDocTemplates);
+  }
+  if (!fs.existsSync(readmeFilePath)) {
+    fs.writeFile(readmeFilePath, "", (err) => {
+      if (err) {
+        console.log("ERROR: Unable to create README.md file.", err);
+      }
+    });
+  }
+  https.get(readmeTemplateUrl, (response) => {
+    const writeTemplate = response.pipe(fs.createWriteStream(readmeFilePath));
+    writeTemplate.on("finish", () => {
+      processReadme();
+    });
+  }).on("error", (err) => {
+    console.log("ERROR: Unable to fetch README.md file from server.", err);
+  });
+}
+copyReadmeLocally();
+processApiExamples();
+processDemo();

package/dist/build/generateDocs.mjs

@@ -0,0 +1,18 @@
+import{createRequire as __auroCreateRequire}from'node:module';const require=__auroCreateRequire(import.meta.url);
+import {
+  processDocFiles
+} from "../_chunks/chunk-H7YO7ERJ.mjs";
+import "../_chunks/chunk-UY4SIQT6.mjs";
+import "../_chunks/chunk-RKBXVLA5.mjs";
+import {
+  Logger
+} from "../_chunks/chunk-2MOEVVSZ.mjs";
+import "../_chunks/chunk-V7YBXHAI.mjs";
+import "../_chunks/chunk-TDFKN2EP.mjs";
+
+// src/build/generateDocs.mjs
+processDocFiles().then(() => {
+  Logger.log("Docs processed successfully");
+}).catch((err) => {
+  Logger.error(`Error processing docs: ${err.message}`);
+});

package/dist/build/generateReadme.mjs

@@ -0,0 +1,49 @@
+import{createRequire as __auroCreateRequire}from'node:module';const require=__auroCreateRequire(import.meta.url);
+import {
+  AuroLibraryUtils
+} from "../_chunks/chunk-2MOEVVSZ.mjs";
+import {
+  require_markdown_magic
+} from "../_chunks/chunk-V7YBXHAI.mjs";
+import {
+  __toESM
+} from "../_chunks/chunk-TDFKN2EP.mjs";
+
+// src/build/generateReadme.mjs
+var import_markdown_magic = __toESM(require_markdown_magic(), 1);
+import * as fs from "fs";
+var dirDocs = "./docs";
+var readmeFilePath = dirDocs + "/README.md";
+var auroLibraryUtils = new AuroLibraryUtils();
+function processReadme() {
+  const callback = () => {
+    if (fs.existsSync("./README.md")) {
+      fs.readFile("./README.md", "utf8", (err, data) => {
+        auroLibraryUtils.formatFileContents(data, "./README.md");
+      });
+    } else {
+      console.log("ERROR: ./README.md file is missing");
+    }
+  };
+  const config = {
+    matchWord: "AURO-GENERATED-CONTENT",
+    outputDir: "./"
+  };
+  const markdownPath = "./docs/README.md";
+  (0, import_markdown_magic.default)(markdownPath, config, callback);
+  fs.copyFileSync(readmeFilePath, "./README.md");
+}
+function copyReadmeLocally() {
+  if (!fs.existsSync(dirDocs)) {
+    fs.mkdirSync(dirDocs);
+  }
+  if (!fs.existsSync(readmeFilePath)) {
+    fs.writeFile(readmeFilePath, "", (err) => {
+      if (err) {
+        console.log("ERROR: Unable to create README.md file.", err);
+      }
+    });
+  }
+  processReadme();
+}
+copyReadmeLocally();