{"id":21294083,"url":"https://github.com/alaskaairlines/auro-library","last_synced_at":"2026-04-02T20:35:12.399Z","repository":{"id":169180158,"uuid":"644107124","full_name":"AlaskaAirlines/auro-library","owner":"AlaskaAirlines","description":"Library of shared auro workflows, scripts, and utilities.","archived":false,"fork":false,"pushed_at":"2026-03-31T23:30:43.000Z","size":1015,"stargazers_count":1,"open_issues_count":14,"forks_count":3,"subscribers_count":8,"default_branch":"main","last_synced_at":"2026-04-01T01:24:48.641Z","etag":null,"topics":["actions","auro","design-system","utilities"],"latest_commit_sha":null,"homepage":"https://auro.alaskaair.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlaskaAirlines.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-05-22T20:41:42.000Z","updated_at":"2026-03-31T23:29:33.000Z","dependencies_parsed_at":"2026-01-07T15:05:23.692Z","dependency_job_id":null,"html_url":"https://github.com/AlaskaAirlines/auro-library","commit_stats":null,"previous_names":["alaskaairlines/auro-library"],"tags_count":102,"template":false,"template_full_name":null,"purl":"pkg:github/AlaskaAirlines/auro-library","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlaskaAirlines%2Fauro-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlaskaAirlines%2Fauro-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlaskaAirlines%2Fauro-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlaskaAirlines%2Fauro-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlaskaAirlines","download_url":"https://codeload.github.com/AlaskaAirlines/auro-library/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlaskaAirlines%2Fauro-library/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31315999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","auro","design-system","utilities"],"created_at":"2024-11-21T13:57:41.372Z","updated_at":"2026-04-02T20:35:12.383Z","avatar_url":"https://github.com/AlaskaAirlines.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Auro-Library\n\n\u003c!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) --\u003e\n\u003c!-- The below content is automatically added from ./../docs/partials/description.md --\u003e\nThis repository holds shared scripts, utilities, and workflows utilized across repositories along the Auro Design System.\n\u003c!-- AURO-GENERATED-CONTENT:END --\u003e\n\n## Scripts\n\n### Publish Surge Demo\n\n\u003c!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/publishDemo.md) --\u003e\n\u003c!-- The below content is automatically added from ./../docs/partials/publishDemo.md --\u003e\nThis is an automated workflow that utilizes GitHub Actions to generate surge demos. Upon making any change to a PR a comment will be added or updated on the PR with a link to the demo similar to the following:\n\n```md\nSurge demo deployment succeeded! 🚀🚀🚀\n\n[Auro Web Component Generator](https://surge.sh/)\n```\n\nThis workflow utilizes the file `./scripts/config/useBundles.js` to update the demo HTML files to use the bundled versions of components so that they can be supported staticly in surge.\n\nIn order to add this functionality to an auro component you just need to add the following snippet into the `publishDemo.yml` file in the `./.github/workflows` directory.\n\n```yml\nname: Deploy Demo\n\non:\n  pull_request:\n    branches: [ main ]\n\n\njobs:\n  call-publish-demo-workflow:\n    uses: AlaskaAirlines/auro-library/.github/workflows/publishDemo.yml@main\n    secrets:\n      SURGE_TOKEN: ${{secrets.AURO_SURGE_TOKEN}}\n```\n\n\u003e Note: This will only work properly in components located in the \"AlaskaAirlines\" organization due to a dependency on the org-wide Actions secret `AURO_SURGE_TOKEN`.\n\nAfterwards you will want to make sure to update the script tags you want replaced with bundles in your `./demo/*.html` files with the `data-demo-scripts=\"true\"` attribute.\n\n```diff\n--    \u003cscript type=\"module\" src=\"../index.js\"\u003e\u003c/script\u003e\n++    \u003cscript type=\"module\" src=\"../index.js\" data-demo-script=\"true\"\u003e\u003c/script\u003e\n```\n\n\u003e Note: If you fail to do this, the components will fail to register in your demo.\n\u003c!-- AURO-GENERATED-CONTENT:END --\u003e\n\n---\n\n### Surge Demo Teardown\n\n\u003c!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/demoTeardown.md) --\u003e\n\u003c!-- The below content is automatically added from ./../docs/partials/demoTeardown.md --\u003e\nThis workflow works to automatically delete and clear any surge demos that have been active for more than 2+ months. Surge in theory allows us to have an infinite amount of active pages but by clearing unused and stale demos we can keep our Surge account more organized in the future.\n\n\u003e Note: This workflow executes on a monthly cronjob on the first of each month.\n\nIn order to clear all our surge projects we rely on [this GitHub Action](https://github.com/marketplace/actions/surge-sh-teardown) to handle the deletion logic.\n\u003c!-- AURO-GENERATED-CONTENT:END --\u003e\n\n---\n\n### Dependency Tag Versioning\n\n\u003c!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/dependencyTagVersioning.md) --\u003e\n\u003c!-- The below content is automatically added from ./../docs/partials/dependencyTagVersioning.md --\u003e\nThis is a two part utility for the purpose of generating a custom string for dependency component tag naming. This is important to prevent [version conflicts](https://www.thinktecture.com/en/web-components/web-components-flaws/#elementor-toc__heading-anchor-0) when multiple versions of a given Auro component may be loaded on a single page.\n\n_Note: The example configuration used below in all code samples assumes `auro-dropdown` is the dependency component. Substitute any Auro component in the example code as needed._\n\n#### Part 1: The Build\n\n##### Configuration\n\n1. Create a new file `./scripts/version.js` with the following content:\n\n```js\nconst versionWriter = require(\"./versionWriter\"); // need to update this with the right path when used from node_modules\n\nversionWriter.writeDepVersionFile('@aurodesignsystem/auro-dropdown'); // duplicate this line for each Auro dependency.\n```\n\n2. Add the following script to the component `package.json` file:\n\n```json\n\"build:version\": \"node scripts/version.js\"\n```\n\n3. The `build:version` script in `package.json` should be added as the first step of the `build` script.\n\n```json\n\"build\": \"npm-run-all build:version ... etc.\",\n```\n\n##### Execution\n\nOnce configuration is complete, execute `npm run build`. This must be done once before `npm run dev` when developing locally. When Auro dependencies are initially installed or updated to new versions then `npm run build:version` or a complete `npm run build` must be executed.\n\nUpon execution of `build:version`, for each Auro dependency defined in the `./scripts/version.js` file, a new JS file will be created that contains the installed version of the dependency.\n\nFor example, following these steps:\n1. Run `npm i @aurodesignsystem/auro-dropdown@1.0.0`\n2. add the following to the `./scripts/version.js` script file:\n```js\nversionWriter.writeDepVersionFile('@aurodesignsystem/auro-dropdown');\n```\n3. Run `npm run build`\n\nWill result in:\n- A new file created: `./src/dropdownVersion.js`\n- File content will export the version of the component installed. In this case:\n`export default '1.0.0'`\n\n#### Part 2: The Runtime\n\n##### Configuration\n\nIn the main component JS file located in the `./src` directory add the following:\n\n```js\nimport { AuroDependencyVersioning } from \"../scripts/dependencyTagVersioning.mjs\";\nimport { AuroDropdown } from '@aurodesignsystem/auro-dropdown/src/auro-dropdown.js';\nimport dropdownVersion from './dropdownVersion';\n```\n\nIn the components constructor add the following:\n\n```js\nconst versioning = new AuroDependencyVersioning();\nthis.dropdownTag = versioning.generateTag('auro-dropdown', dropdownVersion, AuroDropdown);\n```\n\nIn the component properties add the following:\n\n```js\n/**\n * @private\n */\ndropdownTag: { type: Object }\n```\n\n##### Usage\n\nThe new dynamically named version of `auro-dropdown` may now be used in your component template as follows:\n\n```js\nrender() {\n  return html`\n    \u003cdiv\u003e\n      \u003c${this.dropdownTag}\u003e\u003c/${this.dropdownTag}\u003e\n    \u003c/div\u003e\n  `;\n}\n```\n\nWhen the component is rendered during runtime the DOM will now show up as follows:\n\n```html\n\u003cdiv\u003e\n  \u003cauro-dropdown_1_0_0\u003e\u003c/auro-dropdown_1_0_0\u003e\n\u003c/div\u003e\n```\n\n_Note: the numbers attached in the tag name will match the version of the dependency that was installed._\n\n##### Accessing the dynamically named element with JS\n\nThe dynamic component is accessible using a the following string in a JS query selector:\n```js\nthis.dropdownTag._$litStatic$\n```\n\n```js\nfirstUpdated() {\n  this.dropdown = this.shadowRoot.querySelector(this.dropdownTag._$litStatic$);\n};\n```\n\u003c!-- AURO-GENERATED-CONTENT:END --\u003e\n\n---\n\n### Sync All Templates\n\n\u003c!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/syncAllTemplates.md) --\u003e\n\u003c!-- The below content is automatically added from ./../docs/partials/syncAllTemplates.md --\u003e\n### How to Run the `syncAllTemplates.mjs` Script\n\nTo run the `syncAllTemplates.mjs` script, you will need to add a new node script into the linked component and point that to the `syncAllTemplates.mjs` file. You can individually run the workflow configurations by pointing to the `syncAllTemplates.mjs` file and adding a `--github` parameter after the path. The same can be done for the linter configurations by adding a `--linters` parameter.\n\n#### Example Calls\n\n```\n// Default\n\"syncTemplates\": \"./node_modules/@aurodesignsystem/auro-library/scripts/config/syncAllTemplates.mjs\"\n```\n\n```\n// Only sync github workflow templates\n\"syncTemplates\": \"./node_modules/@aurodesignsystem/auro-library/scripts/config/syncAllTemplates.mjs --github\"\n```\n\n```\n// Only sync linter configuration templates\n\"syncTemplates\": \"./node_modules/@aurodesignsystem/auro-library/scripts/config/syncAllTemplates.mjs --linters\"\n```\n\u003c!-- AURO-GENERATED-CONTENT:END --\u003e\n\n\n---\n\n### Prep to build api.md\n\n\u003c!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/generateWcaComponent.md) --\u003e\n\u003c!-- The below content is automatically added from ./../docs/partials/generateWcaComponent.md --\u003e\n# How to Run the `generateWcaComponent.mjs` Script\n\nTo run the `generateWcaComponent.mjs` script, you need to provide the file paths for the components you want to process with WCA. This script should be executed only once after adding a new component to the project. Upon running the script, `.js` files will be generated in the `scripts/wca` folder.\n\n## Example Calls\n\n```json\n// Common case: 1 component in 1 project\n\"build:api:prepare\": \"node ./node_modules/@aurodesignsystem/auro-library/scripts/generateWcaComponent.mjs 'src/auro-flight.js'\"\n```\n\n```\n// multiple components in 1 project\n\"build:api:prepare\": \"node ./node_modules/@aurodesignsystem/auro-library/scripts/config/syncAllTemplates.mjs 'src/auro-flight*.js'\"\n```\n\u003c!-- AURO-GENERATED-CONTENT:END --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falaskaairlines%2Fauro-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falaskaairlines%2Fauro-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falaskaairlines%2Fauro-library/lists"}