github-action-readme-generator 1.10.10 → 1.11.0

package/dist/mjs/sections/update-branding.js.map

@@ -1 +1 @@
-{"version":3,"file":"update-branding.js","sourceRoot":"","sources":["../../../src/sections/update-branding.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,4BAA4B,EAAE,WAAW,EAAsB,MAAM,iBAAiB,CAAC;AAEhG,OAAO,OAAO,MAAM,qBAAqB,CAAC;AAC1C,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAgB1C;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAe,EACf,IAA+B,EAC/B,OAA6B;IAE7B,MAAM,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;IAClC,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAgC;IAC/D,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;IACzF,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,4BAA4B,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CACb,sCAAsC,IAAI,yCAAyC,CACpF,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,KAAK,CACb,sCAAsC,IAAI,kDAAkD,CAC7F,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAc,EAAE,QAAgB,KAAK;IACrE,kCAAkC;IAClC,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC5B,GAAG,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAChC,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,+CAA+C;IAC/C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;IAC/C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAkB,CAAC;IACxE,MAAM,MAAM,GAAG,aAAa,OAAO,YAAY,KAAK,uCAAuC,QAAQ,UAAU,KAAK,OAAO,CAAC;IAE1H,IAAI,OAAO,EAAE,CAAC;QACZ,GAAG,CAAC,IAAI,CAAC,4CAA4C,QAAQ,EAAE,CAAC,CAAC;QACjE,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAkB,CAAC;QAClE,MAAM,IAAI,GAAG,GAAG,QAAQ,GAAG,KAAK,EAAE,CAAC;QACnC,IAAI,GAAG,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,GAAG,CAAC,KAAK,CAAC,6EAA6E,CAAC,CAAC;IACzF,OAAO,wCAAwC,MAAM,MAAM,CAAC;AAC9D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,YAA2B,EAC3B,MAAc;IAEd,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IAEtC,GAAG,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAErE,GAAG,CAAC,KAAK,EAAE,CAAC;IACZ,wDAAwD;IACxD,MAAM,UAAU,GAAG,KAAK,CAAC;IACzB,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACtD,MAAM,CAAC,YAAY,CAAC,aAAa,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACzD,IAAI,OAAO,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;QAC9B,GAAG,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAC;IACnD,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,GAAG,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;IAC5B,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["import type { FeatherIconNames } from 'feather-icons';\n\nimport type { BrandColors } from '../constants.js';\nimport { GITHUB_ACTIONS_OMITTED_ICONS, isValidIcon, type ReadmeSection } from '../constants.js';\nimport type Inputs from '../inputs.js';\nimport LogTask from '../logtask/index.js';\nimport SVGEditor from '../svg-editor.mjs';\n\n/**\n * Wiith thanks to\n * https://github.com/haya14busa/github-action-brandings/blob/master/main.js\n * for the urls to the branding images.\n */\n\ntype Maybe<T> = T | undefined;\n\nexport interface IBranding {\n  alt: string;\n  img: string;\n  url?: string;\n}\n\n/**\n * Generates a svg branding image.\n * example:\n * ```ts\n * generateSvgImage('/path/to/file.svg', 'home', 'red')\n * ```\n *\n * @param svgPath - The path to where the svg file will be saved\n * @param icon - The icon name from the feather-icons list\n * @param bgcolor - The background color of the circle behind the icon\n */\nexport function generateSvgImage(\n  svgPath: string,\n  icon: Partial<FeatherIconNames>,\n  bgcolor: Partial<BrandColors>,\n): void {\n  const svgEditor = new SVGEditor();\n  svgEditor.generateSvgImage(svgPath, icon, bgcolor);\n}\n\n/**\n * This function returns a valid icon name based on the provided branding.\n * If the branding is undefined or not a valid icon name, an error is thrown.\n * It checks if the branding icon is present in the GITHUB_ACTIONS_BRANDING_ICONS set,\n * and if so, returns the corresponding feather icon key array.\n * If the branding icon is present in the GITHUB_ACTIONS_OMITTED_ICONS set,\n * an error is thrown specifying that the icon is part of the omitted icons list.\n * If the branding icon is not a valid icon from the feather-icons list, an error is thrown.\n * @param brand - The branding object\n * @returns The corresponding feather icon key array\n * @throws Error if the branding icon is undefined, not a valid icon name, or part of the omitted icons list\n */\nexport function getValidIconName(icon?: Partial<FeatherIconNames>): FeatherIconNames {\n  if (!icon) {\n    throw new Error(`No valid branding icon name found: action.yml branding is undefined`);\n  }\n\n  if (isValidIcon(icon)) {\n    return icon;\n  }\n\n  if (GITHUB_ACTIONS_OMITTED_ICONS.has(icon)) {\n    throw new Error(\n      `No valid branding icon name found: ${icon} is part of the list of omitted icons. `,\n    );\n  }\n\n  throw new Error(\n    `No valid branding icon name found: ${icon} is not a valid icon from the feather-icons list`,\n  );\n}\n\n/**\n * This function generates an HTML image markup with branding information.\n * It takes inputs and an optional width parameter.\n * If the branding_svg_path is provided, it generates an action.yml branding image for the specified icon and color.\n * Otherwise, it returns an error message.\n *\n * @param inputs - The inputs instance with data for the function.\n * @param width - The width of the image (default is '15%').\n * @returns The HTML image markup with branding information or an error message.\n */\nexport function generateImgMarkup(inputs: Inputs, width: string = '15%'): string {\n  // Create a log task for debugging\n  const log = new LogTask('generateImgMarkup');\n  if (!inputs.action.branding) {\n    log.info('No branding section');\n    return '';\n  }\n  // Get the branding information from the inputs\n  const { icon, color } = inputs.action.branding;\n  const iconName = getValidIconName(icon);\n  const svgPath = inputs.config.get('branding_svg_path') as Maybe<string>;\n  const result = `<img src=\"${svgPath}\" width=\"${width}\" align=\"center\" alt=\"branding<icon:${iconName} color:${color}>\" />`;\n\n  if (svgPath) {\n    log.info(`Generating action.yml branding image for ${iconName}`);\n    const svg = inputs.config.get('image_generated') as Maybe<string>;\n    const hash = `${iconName}${color}`;\n    if (svg && hash.localeCompare(svg) !== 0) {\n      generateSvgImage(svgPath, iconName, color);\n      inputs.config.set('image_generated', hash);\n    }\n    return result;\n  }\n  log.error(`No branding_svg_path provided or it is empty string, can't create the file!`);\n  return `<!-- ERROR: no branding path found = ${result} -->`;\n}\n\n/**\n * This is a TypeScript function named \"updateBranding\" that takes in a sectionToken string and an object of inputs.\n * It exports the function as the default export.\n * The function logs the brand details from the inputs, starts a log task, generates image markup,\n * updates a section in the readme editor using the sectionToken and content, and logs success or failure messages.\n *\n * @param sectionToken - The sectionToken string that is used to identify the section in the readme editor.\n * @param inputs - The inputs object that contains data for the function.\n */\nexport default function updateBranding(\n  sectionToken: ReadmeSection,\n  inputs: Inputs,\n): Record<string, string> {\n  const log = new LogTask(sectionToken);\n\n  log.info(`Brand details: ${JSON.stringify(inputs.action.branding)}`);\n\n  log.start();\n  /** create <img  /> markup with an image width of 15% */\n  const imageWidth = '15%';\n  const content = generateImgMarkup(inputs, imageWidth);\n  inputs.readmeEditor.updateSection(sectionToken, content);\n  if (content && content !== '') {\n    log.success('branding svg successfully created');\n  } else {\n    log.fail('branding svg failed to be created');\n  }\n\n  const ret: Record<string, string> = {};\n  ret[sectionToken] = content;\n  return ret;\n}\n"]}
+{"version":3,"file":"update-branding.js","sourceRoot":"","sources":["../../../src/sections/update-branding.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,4BAA4B,EAAE,WAAW,EAAsB,MAAM,iBAAiB,CAAC;AAEhG,OAAO,OAAO,MAAM,qBAAqB,CAAC;AAC1C,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAgB1C;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAe,EACf,IAA+B,EAC/B,OAA6B;IAE7B,MAAM,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;IAClC,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAgC;IAC/D,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;IACzF,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,4BAA4B,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CACb,sCAAsC,IAAI,yCAAyC,CACpF,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,KAAK,CACb,sCAAsC,IAAI,kDAAkD,CAC7F,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAc,EAAE,KAAK,GAAW,KAAK;IACrE,kCAAkC;IAClC,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC5B,GAAG,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAChC,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,+CAA+C;IAC/C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;IAC/C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAkB,CAAC;IACxE,MAAM,MAAM,GAAG,aAAa,OAAO,YAAY,KAAK,uCAAuC,QAAQ,UAAU,KAAK,OAAO,CAAC;IAE1H,IAAI,OAAO,EAAE,CAAC;QACZ,GAAG,CAAC,IAAI,CAAC,4CAA4C,QAAQ,EAAE,CAAC,CAAC;QACjE,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAkB,CAAC;QAClE,MAAM,IAAI,GAAG,GAAG,QAAQ,GAAG,KAAK,EAAE,CAAC;QACnC,IAAI,GAAG,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,GAAG,CAAC,KAAK,CAAC,6EAA6E,CAAC,CAAC;IACzF,OAAO,wCAAwC,MAAM,MAAM,CAAC;AAC9D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,YAA2B,EAC3B,MAAc;IAEd,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IAEtC,GAAG,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAErE,GAAG,CAAC,KAAK,EAAE,CAAC;IACZ,wDAAwD;IACxD,MAAM,UAAU,GAAG,KAAK,CAAC;IACzB,MAAM,OAAO,GAAG,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACtD,MAAM,CAAC,YAAY,CAAC,aAAa,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACzD,IAAI,OAAO,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;QAC9B,GAAG,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAC;IACnD,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,GAAG,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;IAC5B,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["import type { FeatherIconNames } from 'feather-icons';\n\nimport type { BrandColors } from '../constants.js';\nimport { GITHUB_ACTIONS_OMITTED_ICONS, isValidIcon, type ReadmeSection } from '../constants.js';\nimport type Inputs from '../inputs.js';\nimport LogTask from '../logtask/index.js';\nimport SVGEditor from '../svg-editor.mjs';\n\n/**\n * Wiith thanks to\n * https://github.com/haya14busa/github-action-brandings/blob/master/main.js\n * for the urls to the branding images.\n */\n\ntype Maybe<T> = T | undefined;\n\nexport interface IBranding {\n  alt: string;\n  img: string;\n  url?: string;\n}\n\n/**\n * Generates a svg branding image.\n * example:\n * ```ts\n * generateSvgImage('/path/to/file.svg', 'home', 'red')\n * ```\n *\n * @param svgPath - The path to where the svg file will be saved\n * @param icon - The icon name from the feather-icons list\n * @param bgcolor - The background color of the circle behind the icon\n */\nexport function generateSvgImage(\n  svgPath: string,\n  icon: Partial<FeatherIconNames>,\n  bgcolor: Partial<BrandColors>,\n): void {\n  const svgEditor = new SVGEditor();\n  svgEditor.generateSvgImage(svgPath, icon, bgcolor);\n}\n\n/**\n * This function returns a valid icon name based on the provided branding.\n * If the branding is undefined or not a valid icon name, an error is thrown.\n * It checks if the branding icon is present in the GITHUB_ACTIONS_BRANDING_ICONS set,\n * and if so, returns the corresponding feather icon key array.\n * If the branding icon is present in the GITHUB_ACTIONS_OMITTED_ICONS set,\n * an error is thrown specifying that the icon is part of the omitted icons list.\n * If the branding icon is not a valid icon from the feather-icons list, an error is thrown.\n * @param brand - The branding object\n * @returns The corresponding feather icon key array\n * @throws Error if the branding icon is undefined, not a valid icon name, or part of the omitted icons list\n */\nexport function getValidIconName(icon?: Partial<FeatherIconNames>): FeatherIconNames {\n  if (!icon) {\n    throw new Error(`No valid branding icon name found: action.yml branding is undefined`);\n  }\n\n  if (isValidIcon(icon)) {\n    return icon;\n  }\n\n  if (GITHUB_ACTIONS_OMITTED_ICONS.has(icon)) {\n    throw new Error(\n      `No valid branding icon name found: ${icon} is part of the list of omitted icons. `,\n    );\n  }\n\n  throw new Error(\n    `No valid branding icon name found: ${icon} is not a valid icon from the feather-icons list`,\n  );\n}\n\n/**\n * This function generates an HTML image markup with branding information.\n * It takes inputs and an optional width parameter.\n * If the branding_svg_path is provided, it generates an action.yml branding image for the specified icon and color.\n * Otherwise, it returns an error message.\n *\n * @param inputs - The inputs instance with data for the function.\n * @param width - The width of the image (default is '15%').\n * @returns The HTML image markup with branding information or an error message.\n */\nexport function generateImgMarkup(inputs: Inputs, width: string = '15%'): string {\n  // Create a log task for debugging\n  const log = new LogTask('generateImgMarkup');\n  if (!inputs.action.branding) {\n    log.info('No branding section');\n    return '';\n  }\n  // Get the branding information from the inputs\n  const { icon, color } = inputs.action.branding;\n  const iconName = getValidIconName(icon);\n  const svgPath = inputs.config.get('branding_svg_path') as Maybe<string>;\n  const result = `<img src=\"${svgPath}\" width=\"${width}\" align=\"center\" alt=\"branding<icon:${iconName} color:${color}>\" />`;\n\n  if (svgPath) {\n    log.info(`Generating action.yml branding image for ${iconName}`);\n    const svg = inputs.config.get('image_generated') as Maybe<string>;\n    const hash = `${iconName}${color}`;\n    if (svg && hash.localeCompare(svg) !== 0) {\n      generateSvgImage(svgPath, iconName, color);\n      inputs.config.set('image_generated', hash);\n    }\n    return result;\n  }\n  log.error(`No branding_svg_path provided or it is empty string, can't create the file!`);\n  return `<!-- ERROR: no branding path found = ${result} -->`;\n}\n\n/**\n * This is a TypeScript function named \"updateBranding\" that takes in a sectionToken string and an object of inputs.\n * It exports the function as the default export.\n * The function logs the brand details from the inputs, starts a log task, generates image markup,\n * updates a section in the readme editor using the sectionToken and content, and logs success or failure messages.\n *\n * @param sectionToken - The sectionToken string that is used to identify the section in the readme editor.\n * @param inputs - The inputs object that contains data for the function.\n */\nexport default function updateBranding(\n  sectionToken: ReadmeSection,\n  inputs: Inputs,\n): Record<string, string> {\n  const log = new LogTask(sectionToken);\n\n  log.info(`Brand details: ${JSON.stringify(inputs.action.branding)}`);\n\n  log.start();\n  /** create <img  /> markup with an image width of 15% */\n  const imageWidth = '15%';\n  const content = generateImgMarkup(inputs, imageWidth);\n  inputs.readmeEditor.updateSection(sectionToken, content);\n  if (content && content !== '') {\n    log.success('branding svg successfully created');\n  } else {\n    log.fail('branding svg failed to be created');\n  }\n\n  const ret: Record<string, string> = {};\n  ret[sectionToken] = content;\n  return ret;\n}\n"]}

package/dist/mjs/svg-editor.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"svg-editor.mjs","sourceRoot":"","sources":["../../src/svg-editor.mts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAGlC,OAAO,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAoC,MAAM,QAAQ,CAAC,CAAC,oBAAoB;AAGhG,OAAO,EACL,gCAAgC,EAChC,mBAAmB,EACnB,kBAAkB,EAClB,8BAA8B,EAC9B,6BAA6B,EAC7B,YAAY,EACZ,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,OAAO,MAAM,oBAAoB,CAAC;AAEzC;;GAEG;AAEH,MAAM,CAAC,OAAO,OAAO,SAAS;IACpB,GAAG,CAAU;IAEb,MAAM,CAAa;IAEnB,MAAM,CAAa;IAEnB,QAAQ,CAAe;IAE/B;;OAEG;IACH;QACE,IAAI,CAAC,GAAG,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,CAAC;YAChC,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;YACjC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACjB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,eAAe,CAAc,CAAC;YAC3D,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,OAA2B,EAC3B,OAAkC,kBAAkB,EACpD,UAAgC,mBAAmB;QAEnD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACtC,OAAO;QACT,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,6BAA6B,EAAE,CAAC,CAAC;YAC9E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;YAC5C,OAAO;QACT,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,8BAA8B,EAAE,CAAC,CAAC;YAC3E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YACxC,OAAO;QACT,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,OAAO,OAAO,eAAe,OAAO,GAAG,CAAC,CAAC;QAC9E,iBAAiB;QACjB,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,uBAAuB;QACvB,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE1D,iBAAiB;QACjB,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAEvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,OAAe,EAAE,UAAkB;QAC9C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,OAAO,EAAE,CAAC,CAAC;QACjD,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE;YAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAChB,IAAsB,EACtB,KAAkB,EAClB,eAAuB,GAAG;QAE1B,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QAC7B,kBAAkB;QAClB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,GAAG,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YACnC,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpC,GAAG,CAAC,KAAK,CAAC,uBAAuB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEpD,MAAM,CAAC,KAAK,EAAE,CAAC;QAEf,0DAA0D;QAC1D,MAAM;aACH,IAAI,CAAC,gCAAgC,EAAE,gCAAgC,CAAC;aACxE,OAAO,CAAC,OAAO,YAAY,IAAI,YAAY,EAAE,CAAC;aAC9C,IAAI,CAAC,MAAM,CAAC,CAAC;QAEhB,+DAA+D;QAC/D,MAAM,UAAU,GAAG,YAAY,GAAG,CAAC,CAAC;QACpC,MAAM;aACH,MAAM,CAAC,KAAK,CAAC;aACb,IAAI,CAAC,KAAK,CAAC;aACX,MAAM,CAAC,UAAU,CAAC;aAClB,EAAE,CAAC,UAAU,CAAC;aACd,EAAE,CAAC,UAAU,CAAC;aACd,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAExB,wDAAwD;QACxD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACrC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAEtF,gEAAgE;QAChE,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;QACtC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEzC,oDAAoD;QACpD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,CAAC;QAED,6DAA6D;QAC7D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAE9D,2BAA2B;QAC3B,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAEpC,qEAAqE;QACrE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAEhC,6DAA6D;QAC7D,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAErC,8BAA8B;QAC9B,OAAO,CAAC,wDAAwD,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CACxF,IAAI,CACL,CAAC;IACJ,CAAC;CACF","sourcesContent":["/**\n * This TypeScript code imports necessary modules and defines a class named 'SVGEditor' for generating SVG images.\n * The class has methods for initializing the SVG window, generating SVG content, and writing SVG files.\n * It utilizes various packages such as 'fs', 'path', '@svgdotjs/svg.js', 'feather-icons', and 'svgdom' for SVG manipulation and file operations.\n * The class also defines interfaces for badges and brand colors.\n */\n\nimport * as fs from 'node:fs';\nimport * as path from 'node:path';\n\nimport type { Container } from '@svgdotjs/svg.js';\nimport { registerWindow, SVG } from '@svgdotjs/svg.js';\nimport type { FeatherIconNames } from 'feather-icons';\nimport * as feather from 'feather-icons';\nimport { createSVGWindow, type SVGDocument, type SVGWindow } from 'svgdom'; /// main-module.js';\n\nimport type { BrandColors } from './constants.js';\nimport {\n  brandingSquareEdgeLengthInPixels,\n  DEFAULT_BRAND_COLOR,\n  DEFAULT_BRAND_ICON,\n  GITHUB_ACTIONS_BRANDING_COLORS,\n  GITHUB_ACTIONS_BRANDING_ICONS,\n  isValidColor,\n  isValidIcon,\n} from './constants.js';\nimport LogTask from './logtask/index.js';\n\n/**\n * Utility class for generating SVG images.\n */\n\nexport default class SVGEditor {\n  private log: LogTask;\n\n  private window?: SVGWindow;\n\n  private canvas?: Container;\n\n  private document?: SVGDocument;\n\n  /**\n   * Initializes a new SVGEditor instance.\n   */\n  constructor() {\n    this.log = new LogTask('SVGEditor');\n  }\n\n  /**\n   * Initializes the SVG window, document, and canvas if not already set up.\n   */\n  initSVG(): void {\n    if (!this.window) {\n      this.window = createSVGWindow();\n      const { document } = this.window;\n      registerWindow(this.window, document);\n      if (!this.canvas) {\n        this.canvas = SVG(document.documentElement) as Container;\n      }\n    }\n  }\n\n  /**\n   * Generates a branded SVG image.\n   * @param {string | undefined} svgPath - Path to write the generated SVG file to.\n   * @param {Partial<FeatherIconNames>} icon - Name of the icon to use.\n   * @param {Partial<BrandColors>} bgcolor - Background color for the image.\n   * @returns {Promise<void>} A promise that resolves when the image is generated.\n   */\n  generateSvgImage(\n    svgPath: string | undefined,\n    icon: Partial<FeatherIconNames> = DEFAULT_BRAND_ICON,\n    bgcolor: Partial<BrandColors> = DEFAULT_BRAND_COLOR\n  ): void {\n    if (!svgPath || svgPath.length === 0) {\n      this.log.debug('No svgPath provided');\n      return;\n    }\n\n    if (!isValidIcon(icon)) {\n      this.log.error(`Valid Branding Icon Names: ${GITHUB_ACTIONS_BRANDING_ICONS}`);\n      this.log.fail(`Invalid icon name: ${icon}`);\n      return;\n    }\n    if (!isValidColor(bgcolor)) {\n      this.log.error(`Valid Branding Colors: ${GITHUB_ACTIONS_BRANDING_COLORS}`);\n      this.log.fail('Invalid branding color');\n      return;\n    }\n    this.log.info(`SVG to generate ${icon} at ${svgPath} with color ${bgcolor}.`);\n    // Initialize SVG\n    this.initSVG();\n    // Generate SVG content\n    const svgContent = this.generateSVGContent(icon, bgcolor);\n\n    // Write SVG file\n    this.writeSVGFile(svgPath, svgContent);\n\n    this.log.debug('SVG image generated successfully');\n  }\n\n  /**\n   * Writes the SVG xml to disk.\n   * @param {string} svgPath - File path to save the SVG to.\n   * @param {string} svgContent - The XML for the SVG file.\n   */\n  writeSVGFile(svgPath: string, svgContent: string): void {\n    fs.mkdirSync(path.dirname(svgPath), { recursive: true });\n    this.log.debug(`Writing SVG file to ${svgPath}`);\n    fs.writeFile(svgPath, svgContent, 'utf8', () => {\n      return this.log.debug(`SVG image generated: ${svgPath}`);\n    });\n  }\n\n  /**\n   * Generates the SVG content for the branding image.\n   * @param {FeatherIconNames} icon - Name of the icon to use.\n   * @param {BrandColors} color - Background color for the image.\n   * @param {number} outerViewBox - Size of the canvas for the image.\n   * @returns {string} The generated SVG content.\n   */\n  generateSVGContent(\n    icon: FeatherIconNames,\n    color: BrandColors,\n    outerViewBox: number = 100\n  ): string {\n    const { canvas, log } = this;\n    // Validate canvas\n    if (!canvas) {\n      log.fail('Canvas not initialized');\n      return '';\n    }\n\n    const svgData = feather.icons[icon];\n    log.debug(`SVG data to ingest: ${svgData.toSvg()}`);\n\n    canvas.clear();\n\n    // Create a canvas that is `outerViewBox` x `outerViewBox`\n    canvas\n      .size(brandingSquareEdgeLengthInPixels, brandingSquareEdgeLengthInPixels)\n      .viewbox(`0 0 ${outerViewBox} ${outerViewBox}`)\n      .fill('none');\n\n    // Create a 'color' circle that touches the edges of the canvas\n    const circleSize = outerViewBox / 2;\n    canvas\n      .circle('50%')\n      .fill(color)\n      .radius(circleSize)\n      .cx(circleSize)\n      .cy(circleSize)\n      .stroke({ width: 0 });\n\n    // Create an svg box that is half the size of the parent\n    const iconsvgOuter = canvas.nested();\n    iconsvgOuter.attr('overflow', 'visible').height('50%').width('50%').x('25%').y('25%');\n\n    // create a nested svg and add the feather-icon paths to the svg\n    const iconsvg = iconsvgOuter.nested();\n    iconsvg.id('icon').svg(svgData.contents);\n\n    // Append all of the attributes from the fether-icon\n    for (const attr of Object.keys(svgData.attrs)) {\n      iconsvg.attr(attr, svgData.attrs[attr]);\n    }\n\n    // invert the stroke color if it matches the background color\n    iconsvg.stroke(color.startsWith('white') ? 'white' : 'black');\n\n    // remove the edge clipping\n    iconsvg.attr('overflow', 'visible');\n\n    // Make the viewbox of the svg match the exact dimensions of the icon\n    iconsvg.viewbox(iconsvg.bbox());\n\n    // Make the svg icon center itself vertically and horozonally\n    iconsvg.height('auto').width('auto');\n\n    // return the xml file content\n    return ['<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>', canvas.svg(), '\\n'].join(\n      '\\n'\n    );\n  }\n}\n"]}
+{"version":3,"file":"svg-editor.mjs","sourceRoot":"","sources":["../../src/svg-editor.mts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAGlC,OAAO,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAoC,MAAM,QAAQ,CAAC,CAAC,oBAAoB;AAGhG,OAAO,EACL,gCAAgC,EAChC,mBAAmB,EACnB,kBAAkB,EAClB,8BAA8B,EAC9B,6BAA6B,EAC7B,YAAY,EACZ,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,OAAO,MAAM,oBAAoB,CAAC;AAEzC;;GAEG;AAEH,MAAM,CAAC,OAAO,OAAO,SAAS;IACpB,GAAG,CAAU;IAEb,MAAM,CAAa;IAEnB,MAAM,CAAa;IAEnB,QAAQ,CAAe;IAE/B;;OAEG;IACH;QACE,IAAI,CAAC,GAAG,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,CAAC;YAChC,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;YACjC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACjB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,eAAe,CAAc,CAAC;YAC3D,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,OAA2B,EAC3B,IAAI,GAA8B,kBAAkB,EACpD,OAAO,GAAyB,mBAAmB;QAEnD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACtC,OAAO;QACT,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,6BAA6B,EAAE,CAAC,CAAC;YAC9E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;YAC5C,OAAO;QACT,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,8BAA8B,EAAE,CAAC,CAAC;YAC3E,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YACxC,OAAO;QACT,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,OAAO,OAAO,eAAe,OAAO,GAAG,CAAC,CAAC;QAC9E,iBAAiB;QACjB,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,uBAAuB;QACvB,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE1D,iBAAiB;QACjB,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAEvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,OAAe,EAAE,UAAkB;QAC9C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,OAAO,EAAE,CAAC,CAAC;QACjD,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE;YAC7C,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAChB,IAAsB,EACtB,KAAkB,EAClB,YAAY,GAAW,GAAG;QAE1B,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QAC7B,kBAAkB;QAClB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,GAAG,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YACnC,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpC,GAAG,CAAC,KAAK,CAAC,uBAAuB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEpD,MAAM,CAAC,KAAK,EAAE,CAAC;QAEf,0DAA0D;QAC1D,MAAM;aACH,IAAI,CAAC,gCAAgC,EAAE,gCAAgC,CAAC;aACxE,OAAO,CAAC,OAAO,YAAY,IAAI,YAAY,EAAE,CAAC;aAC9C,IAAI,CAAC,MAAM,CAAC,CAAC;QAEhB,+DAA+D;QAC/D,MAAM,UAAU,GAAG,YAAY,GAAG,CAAC,CAAC;QACpC,MAAM;aACH,MAAM,CAAC,KAAK,CAAC;aACb,IAAI,CAAC,KAAK,CAAC;aACX,MAAM,CAAC,UAAU,CAAC;aAClB,EAAE,CAAC,UAAU,CAAC;aACd,EAAE,CAAC,UAAU,CAAC;aACd,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAExB,wDAAwD;QACxD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACrC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAEtF,gEAAgE;QAChE,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;QACtC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEzC,oDAAoD;QACpD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9C,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,CAAC;QAED,6DAA6D;QAC7D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAE9D,2BAA2B;QAC3B,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAEpC,qEAAqE;QACrE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAEhC,6DAA6D;QAC7D,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAErC,8BAA8B;QAC9B,OAAO,CAAC,wDAAwD,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CACxF,IAAI,CACL,CAAC;IACJ,CAAC;CACF","sourcesContent":["/**\n * This TypeScript code imports necessary modules and defines a class named 'SVGEditor' for generating SVG images.\n * The class has methods for initializing the SVG window, generating SVG content, and writing SVG files.\n * It utilizes various packages such as 'fs', 'path', '@svgdotjs/svg.js', 'feather-icons', and 'svgdom' for SVG manipulation and file operations.\n * The class also defines interfaces for badges and brand colors.\n */\n\nimport * as fs from 'node:fs';\nimport * as path from 'node:path';\n\nimport type { Container } from '@svgdotjs/svg.js';\nimport { registerWindow, SVG } from '@svgdotjs/svg.js';\nimport type { FeatherIconNames } from 'feather-icons';\nimport * as feather from 'feather-icons';\nimport { createSVGWindow, type SVGDocument, type SVGWindow } from 'svgdom'; /// main-module.js';\n\nimport type { BrandColors } from './constants.js';\nimport {\n  brandingSquareEdgeLengthInPixels,\n  DEFAULT_BRAND_COLOR,\n  DEFAULT_BRAND_ICON,\n  GITHUB_ACTIONS_BRANDING_COLORS,\n  GITHUB_ACTIONS_BRANDING_ICONS,\n  isValidColor,\n  isValidIcon,\n} from './constants.js';\nimport LogTask from './logtask/index.js';\n\n/**\n * Utility class for generating SVG images.\n */\n\nexport default class SVGEditor {\n  private log: LogTask;\n\n  private window?: SVGWindow;\n\n  private canvas?: Container;\n\n  private document?: SVGDocument;\n\n  /**\n   * Initializes a new SVGEditor instance.\n   */\n  constructor() {\n    this.log = new LogTask('SVGEditor');\n  }\n\n  /**\n   * Initializes the SVG window, document, and canvas if not already set up.\n   */\n  initSVG(): void {\n    if (!this.window) {\n      this.window = createSVGWindow();\n      const { document } = this.window;\n      registerWindow(this.window, document);\n      if (!this.canvas) {\n        this.canvas = SVG(document.documentElement) as Container;\n      }\n    }\n  }\n\n  /**\n   * Generates a branded SVG image.\n   * @param {string | undefined} svgPath - Path to write the generated SVG file to.\n   * @param {Partial<FeatherIconNames>} icon - Name of the icon to use.\n   * @param {Partial<BrandColors>} bgcolor - Background color for the image.\n   * @returns {Promise<void>} A promise that resolves when the image is generated.\n   */\n  generateSvgImage(\n    svgPath: string | undefined,\n    icon: Partial<FeatherIconNames> = DEFAULT_BRAND_ICON,\n    bgcolor: Partial<BrandColors> = DEFAULT_BRAND_COLOR\n  ): void {\n    if (!svgPath || svgPath.length === 0) {\n      this.log.debug('No svgPath provided');\n      return;\n    }\n\n    if (!isValidIcon(icon)) {\n      this.log.error(`Valid Branding Icon Names: ${GITHUB_ACTIONS_BRANDING_ICONS}`);\n      this.log.fail(`Invalid icon name: ${icon}`);\n      return;\n    }\n    if (!isValidColor(bgcolor)) {\n      this.log.error(`Valid Branding Colors: ${GITHUB_ACTIONS_BRANDING_COLORS}`);\n      this.log.fail('Invalid branding color');\n      return;\n    }\n    this.log.info(`SVG to generate ${icon} at ${svgPath} with color ${bgcolor}.`);\n    // Initialize SVG\n    this.initSVG();\n    // Generate SVG content\n    const svgContent = this.generateSVGContent(icon, bgcolor);\n\n    // Write SVG file\n    this.writeSVGFile(svgPath, svgContent);\n\n    this.log.debug('SVG image generated successfully');\n  }\n\n  /**\n   * Writes the SVG xml to disk.\n   * @param {string} svgPath - File path to save the SVG to.\n   * @param {string} svgContent - The XML for the SVG file.\n   */\n  writeSVGFile(svgPath: string, svgContent: string): void {\n    fs.mkdirSync(path.dirname(svgPath), { recursive: true });\n    this.log.debug(`Writing SVG file to ${svgPath}`);\n    fs.writeFile(svgPath, svgContent, 'utf8', () => {\n      return this.log.debug(`SVG image generated: ${svgPath}`);\n    });\n  }\n\n  /**\n   * Generates the SVG content for the branding image.\n   * @param {FeatherIconNames} icon - Name of the icon to use.\n   * @param {BrandColors} color - Background color for the image.\n   * @param {number} outerViewBox - Size of the canvas for the image.\n   * @returns {string} The generated SVG content.\n   */\n  generateSVGContent(\n    icon: FeatherIconNames,\n    color: BrandColors,\n    outerViewBox: number = 100\n  ): string {\n    const { canvas, log } = this;\n    // Validate canvas\n    if (!canvas) {\n      log.fail('Canvas not initialized');\n      return '';\n    }\n\n    const svgData = feather.icons[icon];\n    log.debug(`SVG data to ingest: ${svgData.toSvg()}`);\n\n    canvas.clear();\n\n    // Create a canvas that is `outerViewBox` x `outerViewBox`\n    canvas\n      .size(brandingSquareEdgeLengthInPixels, brandingSquareEdgeLengthInPixels)\n      .viewbox(`0 0 ${outerViewBox} ${outerViewBox}`)\n      .fill('none');\n\n    // Create a 'color' circle that touches the edges of the canvas\n    const circleSize = outerViewBox / 2;\n    canvas\n      .circle('50%')\n      .fill(color)\n      .radius(circleSize)\n      .cx(circleSize)\n      .cy(circleSize)\n      .stroke({ width: 0 });\n\n    // Create an svg box that is half the size of the parent\n    const iconsvgOuter = canvas.nested();\n    iconsvgOuter.attr('overflow', 'visible').height('50%').width('50%').x('25%').y('25%');\n\n    // create a nested svg and add the feather-icon paths to the svg\n    const iconsvg = iconsvgOuter.nested();\n    iconsvg.id('icon').svg(svgData.contents);\n\n    // Append all of the attributes from the fether-icon\n    for (const attr of Object.keys(svgData.attrs)) {\n      iconsvg.attr(attr, svgData.attrs[attr]);\n    }\n\n    // invert the stroke color if it matches the background color\n    iconsvg.stroke(color.startsWith('white') ? 'white' : 'black');\n\n    // remove the edge clipping\n    iconsvg.attr('overflow', 'visible');\n\n    // Make the viewbox of the svg match the exact dimensions of the icon\n    iconsvg.viewbox(iconsvg.bbox());\n\n    // Make the svg icon center itself vertically and horozonally\n    iconsvg.height('auto').width('auto');\n\n    // return the xml file content\n    return ['<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>', canvas.svg(), '\\n'].join(\n      '\\n'\n    );\n  }\n}\n"]}

package/dist/types/Action.d.ts

@@ -0,0 +1,154 @@
+/**
+ * This class represents the metadata of a GitHub action defined in the action.yml file.
+ * It provides properties and methods for accessing and manipulating the metadata.
+ * [Further reading on the metadata can be found here](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs)
+ */
+import { type Branding } from './constants.js';
+import LogTask from './logtask/index.js';
+/**
+ * Represents an input for the action.
+ */
+export type Input = {
+    /** Description of the input */
+    description: string;
+    /** Whether the input is required */
+    required?: boolean;
+    /** Default value for the input */
+    default?: string;
+    /** Optional If the input parameter is used, this string is this.logged as a warning message. You can use this warning to notify users that the input is deprecated and mention any alternatives. */
+    deprecationMessage?: string;
+};
+/**
+ * Represents an output for the action.
+ */
+export interface Output {
+    /** Description of the output */
+    description?: string;
+    value?: string;
+}
+type CompositeAction = 'composite';
+type ContainerAction = 'docker';
+type JavascriptAction = `Node${string}` | `node${string}`;
+/**
+ * Defines the runs property for container actions.
+ */
+type RunsContainer = {
+    using: ContainerAction;
+    image: string;
+    args?: string[];
+    'pre-entrypoint'?: string;
+    'post-entrypoint'?: string;
+    entrypoint?: string;
+};
+/**
+ * Defines the runs property for JavaScript actions.
+ */
+type RunsJavascript = {
+    /** The runner used to execute the action */
+    using: JavascriptAction;
+    /** The entrypoint file for the action */
+    main: string;
+    pre?: string;
+    'pre-if'?: string;
+    'post-if'?: string;
+    post?: string;
+};
+/**
+ * Defines the steps property for composite actions.
+ */
+type Steps = {
+    shell?: string;
+    if?: string;
+    run?: string;
+    name?: string;
+    id?: string;
+    'working-directory'?: string;
+    env: {
+        [key: string]: string;
+    };
+};
+/**
+ * Defines the runs property for composite actions.
+ */
+type RunsComposite = {
+    /** The runner used to execute the action */
+    using: CompositeAction;
+    steps: Steps;
+};
+export type ActionType = RunsContainer | RunsJavascript | RunsComposite;
+/**
+ * Defines how the action is run.
+ */
+export type ActionYaml = {
+    name: string;
+    author?: string;
+    /** Description of the action */
+    description: string;
+    /** Branding information */
+    branding?: Branding;
+    /** Input definitions */
+    inputs?: {
+        [key: string]: Input;
+    };
+    /** Output definitions */
+    outputs?: {
+        [key: string]: Output;
+    };
+    /** How the action is run */
+    runs: ActionType;
+    /** Path to the action */
+    path: string;
+};
+/**
+ * Parses and represents metadata from action.yml.
+ */
+export default class Action implements ActionYaml {
+    static validate(obj: unknown): obj is ActionType;
+    log: LogTask;
+    /** Name of the action */
+    name: string;
+    author?: string;
+    /** Description of the action */
+    description: string;
+    /** Branding information */
+    branding?: Branding;
+    /** Input definitions */
+    inputs?: {
+        [key: string]: Input;
+    };
+    /** Output definitions */
+    outputs?: {
+        [key: string]: Output;
+    };
+    /** How the action is run */
+    runs: ActionType;
+    /** Path to the action */
+    path: string;
+    /** the original file content */
+    rawYamlString: string;
+    /**
+     * Creates a new instance of the Action class by loading and parsing action.yml.
+     *
+     * @param actionPath The path to the action.yml file.
+     */
+    constructor(actionPath: string, log?: LogTask);
+    loadActionFrom(actionPath: string): ActionYaml;
+    /**
+    * Gets the value of an input.
+    }
+  
+    /**
+     * Gets the default value for an input.
+     *
+     * @param inputName The name of the input.
+     * @returns The default value if defined,or undefined
+     */
+    inputDefault(inputName: string): string | boolean | undefined;
+    /**
+     * Stringifies the action back to YAML.
+     *
+     * @returns The YAML string for debugging.
+     */
+    stringify(): string;
+}
+export {};

package/dist/types/config.d.ts

@@ -0,0 +1,47 @@
+/**
+ * This TypeScript code imports the necessary modules and defines two interfaces: `Versioning` and `Paths`.
+ * It also defines a class named `GHActionDocsConfig` that represents the configuration for generating GitHub Actions documentation.
+ * The class has properties that correspond to the configuration options and a method `loadInputs` to load the configuration from the provided `Inputs` object.
+ * The class also has a method `save` to save the configuration to a file.
+ */
+import type Inputs from './inputs.js';
+/**
+ * Represents the versioning configuration for GitHub Actions documentation.
+ */
+export interface Versioning {
+    enabled?: boolean;
+    prefix?: string;
+    override?: string;
+    branch?: string;
+    badge?: string;
+}
+/**
+ * Represents the paths configuration for GitHub Actions documentation.
+ */
+export interface Paths {
+    action: string;
+    readme: string;
+}
+/**
+ * Represents the configuration for generating GitHub Actions documentation.
+ */
+export declare class GHActionDocsConfig {
+    owner?: string;
+    repo?: string;
+    title_prefix?: string;
+    title?: string;
+    paths?: Paths;
+    branding_svg_path?: string;
+    versioning?: Versioning;
+    prettier?: boolean;
+    /**
+     * Loads the configuration from the provided `Inputs` object.
+     * @param {Inputs} inputs - The `Inputs` object containing the configuration values.
+     */
+    loadInputs(inputs: Inputs): void;
+    /**
+     * Saves the configuration to a file. If the file exists, it will be overwritten.
+     * @param {string} configPath - The path to the configuration file.
+     */
+    save(configPath: string): Promise<void>;
+}

package/dist/types/constants.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Represents the Feather icon names.
+ */
+import type { FeatherIconNames } from 'feather-icons';
+/**
+ * Represents the sections of the README.
+ */
+export declare const README_SECTIONS: readonly ['title', 'branding', 'description', 'usage', 'inputs', 'outputs', 'contents', 'badges'];
+/**
+ * Represents a single section of the README.
+ */
+export type ReadmeSection = (typeof README_SECTIONS)[number];
+/**
+ * Represents the file name for the configuration file.
+ */
+export declare const configFileName = ".ghadocs.json";
+/**
+ * Enumerates the keys for the configuration options.
+ */
+/**
+ * Valid version source options for determining action version.
+ */
+export declare const VERSION_SOURCES: readonly ['git-tag', 'git-branch', 'git-sha', 'package-json', 'explicit'];
+/**
+ * Type for version source options.
+ */
+export type VersionSource = (typeof VERSION_SOURCES)[number];
+/**
+ * Checks if the given value is a valid version source.
+ */
+export declare function isValidVersionSource(value: string): value is VersionSource;
+export declare enum ConfigKeys {
+    Owner = "owner",
+    Repo = "repo",
+    TitlePrefix = "title_prefix",
+    Prettier = "prettier",
+    Save = "save",
+    pathsAction = "paths:action",
+    pathsReadme = "paths:readme",
+    BrandingSvgPath = "branding_svg_path",
+    BrandingAsTitlePrefix = "branding_as_title_prefix",
+    VersioningEnabled = "versioning:enabled",
+    VersioningOverride = "versioning:override",
+    VersioningPrefix = "versioning:prefix",
+    VersioningBranch = "versioning:branch",
+    VersioningSource = "versioning:source",
+    IncludeGithubVersionBadge = "versioning:badge",
+    DebugNconf = "debug:nconf",
+    DebugReadme = "debug:readme",
+    DebugConfig = "debug:config",
+    DebugAction = "debug:action",
+    DebugGithub = "debug:github"
+}
+/**
+ * Represents the edge length (in pixels) for the branding square.
+ */
+export declare const brandingSquareEdgeLengthInPixels = 50;
+/**
+ * Represents the default brand color.
+ */
+export declare const DEFAULT_BRAND_COLOR = "blue";
+/**
+ * Represents the default brand icon.
+ */
+export declare const DEFAULT_BRAND_ICON = "activity";
+/**
+ * Represents the markup for center alignment.
+ */
+export declare const ALIGNMENT_MARKUP = "<div align=\"center\">";
+/**
+ * Represents the set of icons that are omitted in GitHub Actions branding.
+ */
+export declare const GITHUB_ACTIONS_OMITTED_ICONS: Set<string>;
+/**
+ * Represents the set of icons available for GitHub Actions branding.
+ */
+export declare const GITHUB_ACTIONS_BRANDING_ICONS: Set<string>;
+/**
+ * Represents the available colors for GitHub Actions branding.
+ */
+export declare const GITHUB_ACTIONS_BRANDING_COLORS: readonly ['white', 'yellow', 'blue', 'green', 'orange', 'red', 'purple', 'gray-dark'];
+/**
+ * Represents the available brand colors.
+ */
+export type BrandColors = (typeof GITHUB_ACTIONS_BRANDING_COLORS)[number];
+/**
+ * Checks if the given icon is valid for GitHub Actions branding.
+ * @param {Partial<FeatherIconNames>} icon - The icon to validate.
+ * @returns A boolean indicating if the icon is valid.
+ */
+export declare function isValidIcon(icon: Partial<FeatherIconNames>): icon is FeatherIconNames;
+/**
+ * Checks if the given color is valid for GitHub Actions branding.
+ * @param {Partial<BrandColors>} color - The color to validate.
+ * @returns A boolean indicating if the color is valid.
+ */
+export declare function isValidColor(color: Partial<BrandColors>): color is BrandColors;
+/**
+ * Represents the branding information for the action.
+ */
+export interface Branding {
+    /** Color for the action branding */
+    color: Partial<BrandColors>;
+    icon: Partial<FeatherIconNames>;
+}

package/dist/types/errors/error-type.d.ts

@@ -0,0 +1,7 @@
+export declare enum ErrorType {
+    FILE = "file",
+    SCHEMA = "schema",
+    VALIDATION = "validation",
+    INPUTS = "inputs",
+    URL = "url"
+}

package/dist/types/errors/is-error.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Type guard to check if an `unknown` value is an `Error` object.
+ *
+ * @param value - The value to check.
+ *
+ * @returns `true` if the value is an `Error` object, otherwise `false`.
+ */
+export declare const isError: (value: unknown) => value is Error;

package/dist/types/helpers.d.ts

@@ -0,0 +1,93 @@
+import { context } from '@actions/github';
+import type Inputs from './inputs.js';
+import LogTask from './logtask/index.js';
+import { type Nullable } from './util.js';
+type Context = typeof context;
+/**
+ * Returns the input value if it is not empty, otherwise returns undefined.
+ * @param value - The input value to check.
+ * @returns The input value if it is not empty, otherwise undefined.
+ */
+export declare function undefinedOnEmpty(value: string | undefined): string | undefined;
+/**
+ * Returns the basename of the given path.
+ * @param pathStr - The path to extract the basename from.
+ * @returns The basename of the path.
+ */
+export declare function basename(pathStr: string): string | undefined;
+/**
+ * Removes the "refs/heads/" or "refs/tags/" prefix from the given path.
+ *
+ * @param pathStr - The path to remove the prefix from
+ * @returns The path without the prefix, or null if path is empty
+ */
+export declare function stripRefs(pathStr: string): string | null;
+/**
+ * Converts the given text to title case.
+ * @param text - The text to convert.
+ * @returns The text converted to title case.
+ * @throws {TypeError} If the input is not a string.
+ */
+export declare function titlecase(text: string): string | undefined;
+/**
+ * Parses the given text and converts it to title case, replacing underscores and dashes with spaces.
+ * @param text - The text to parse and convert.
+ * @returns The parsed text converted to title case.
+ */
+export declare function prefixParser(text: string | undefined): string | undefined;
+/**
+ * Wraps the given text into multiple lines with a maximum width of 80 characters.
+ * @param text - The text to wrap.
+ * @param content - The array to store the wrapped lines.
+ * @param prepend - The string to prepend to each wrapped line.
+ * @returns The array of wrapped lines.
+ */
+export declare function wrapText(text: string | undefined, content: string[], prepend?: string): string[];
+/**
+ * Represents a repository with owner and repo properties.
+ */
+export interface Repo {
+    owner: string;
+    repo: string;
+}
+export declare function readFile(filename: string): string;
+export declare function repoObjFromRepoName(repository: Nullable<string>, log: LogTask, from?: string): Nullable<Repo>;
+export declare const remoteGitUrlPattern: RegExp;
+/**
+ * Finds the repository information from the input, context, environment variables, or git configuration.
+ * @param inputRepo - The input repository string.
+ * @param context - The GitHub context object.
+ * @param baseDir - Optional base directory to look for .git/config (defaults to CWD).
+ * @returns The repository information (owner and repo) or null if not found.
+ */
+export declare function repositoryFinder(inputRepo: Nullable<string>, context: Nullable<Context>, baseDir?: string): Repo | null;
+/**
+ * Returns the default branch of the git repository.
+ * @returns The default branch.
+ */
+/**
+ * Gets the default branch for the Git repository.
+ *
+ * @returns The name of the default branch.
+ */
+export declare function getDefaultGitBranch(): string;
+/**
+ * Formats the given value as a column header.
+ * @param value - The value to format.
+ * @returns The formatted column header.
+ */
+export declare function columnHeader(value: string): string;
+/**
+ * Formats the given value as a row header in HTML.
+ *
+ * Removes formatting from the string and converts it to bold code style.
+ *
+ * @param value - The string to format as a header
+ * @returns The formatted row header string wrapped in bold and code tags
+ */
+export declare function rowHeader(value: string): string;
+export declare function getCurrentVersionString(inputs: Inputs): string;
+export declare function indexOfRegex(str: string, providedRegex: RegExp): number;
+export declare function lastIndexOfRegex(str: string, providedRegex: RegExp): number;
+export declare function isObject(value: unknown): value is object;
+export {};