@aurodesignsystem/auro-formkit 1.6.0-beta.4

package/components/checkbox/node_modules/chalk/source/vendor/supports-color/index.js

@@ -0,0 +1,182 @@
+import process from 'node:process';
+import os from 'node:os';
+import tty from 'node:tty';
+
+// From: https://github.com/sindresorhus/has-flag/blob/main/index.js
+/// function hasFlag(flag, argv = globalThis.Deno?.args ?? process.argv) {
+function hasFlag(flag, argv = globalThis.Deno ? globalThis.Deno.args : process.argv) {
+	const prefix = flag.startsWith('-') ? '' : (flag.length === 1 ? '-' : '--');
+	const position = argv.indexOf(prefix + flag);
+	const terminatorPosition = argv.indexOf('--');
+	return position !== -1 && (terminatorPosition === -1 || position < terminatorPosition);
+}
+
+const {env} = process;
+
+let flagForceColor;
+if (
+	hasFlag('no-color')
+	|| hasFlag('no-colors')
+	|| hasFlag('color=false')
+	|| hasFlag('color=never')
+) {
+	flagForceColor = 0;
+} else if (
+	hasFlag('color')
+	|| hasFlag('colors')
+	|| hasFlag('color=true')
+	|| hasFlag('color=always')
+) {
+	flagForceColor = 1;
+}
+
+function envForceColor() {
+	if ('FORCE_COLOR' in env) {
+		if (env.FORCE_COLOR === 'true') {
+			return 1;
+		}
+
+		if (env.FORCE_COLOR === 'false') {
+			return 0;
+		}
+
+		return env.FORCE_COLOR.length === 0 ? 1 : Math.min(Number.parseInt(env.FORCE_COLOR, 10), 3);
+	}
+}
+
+function translateLevel(level) {
+	if (level === 0) {
+		return false;
+	}
+
+	return {
+		level,
+		hasBasic: true,
+		has256: level >= 2,
+		has16m: level >= 3,
+	};
+}
+
+function _supportsColor(haveStream, {streamIsTTY, sniffFlags = true} = {}) {
+	const noFlagForceColor = envForceColor();
+	if (noFlagForceColor !== undefined) {
+		flagForceColor = noFlagForceColor;
+	}
+
+	const forceColor = sniffFlags ? flagForceColor : noFlagForceColor;
+
+	if (forceColor === 0) {
+		return 0;
+	}
+
+	if (sniffFlags) {
+		if (hasFlag('color=16m')
+			|| hasFlag('color=full')
+			|| hasFlag('color=truecolor')) {
+			return 3;
+		}
+
+		if (hasFlag('color=256')) {
+			return 2;
+		}
+	}
+
+	// Check for Azure DevOps pipelines.
+	// Has to be above the `!streamIsTTY` check.
+	if ('TF_BUILD' in env && 'AGENT_NAME' in env) {
+		return 1;
+	}
+
+	if (haveStream && !streamIsTTY && forceColor === undefined) {
+		return 0;
+	}
+
+	const min = forceColor || 0;
+
+	if (env.TERM === 'dumb') {
+		return min;
+	}
+
+	if (process.platform === 'win32') {
+		// Windows 10 build 10586 is the first Windows release that supports 256 colors.
+		// Windows 10 build 14931 is the first release that supports 16m/TrueColor.
+		const osRelease = os.release().split('.');
+		if (
+			Number(osRelease[0]) >= 10
+			&& Number(osRelease[2]) >= 10_586
+		) {
+			return Number(osRelease[2]) >= 14_931 ? 3 : 2;
+		}
+
+		return 1;
+	}
+
+	if ('CI' in env) {
+		if ('GITHUB_ACTIONS' in env || 'GITEA_ACTIONS' in env) {
+			return 3;
+		}
+
+		if (['TRAVIS', 'CIRCLECI', 'APPVEYOR', 'GITLAB_CI', 'BUILDKITE', 'DRONE'].some(sign => sign in env) || env.CI_NAME === 'codeship') {
+			return 1;
+		}
+
+		return min;
+	}
+
+	if ('TEAMCITY_VERSION' in env) {
+		return /^(9\.(0*[1-9]\d*)\.|\d{2,}\.)/.test(env.TEAMCITY_VERSION) ? 1 : 0;
+	}
+
+	if (env.COLORTERM === 'truecolor') {
+		return 3;
+	}
+
+	if (env.TERM === 'xterm-kitty') {
+		return 3;
+	}
+
+	if ('TERM_PROGRAM' in env) {
+		const version = Number.parseInt((env.TERM_PROGRAM_VERSION || '').split('.')[0], 10);
+
+		switch (env.TERM_PROGRAM) {
+			case 'iTerm.app': {
+				return version >= 3 ? 3 : 2;
+			}
+
+			case 'Apple_Terminal': {
+				return 2;
+			}
+			// No default
+		}
+	}
+
+	if (/-256(color)?$/i.test(env.TERM)) {
+		return 2;
+	}
+
+	if (/^screen|^xterm|^vt100|^vt220|^rxvt|color|ansi|cygwin|linux/i.test(env.TERM)) {
+		return 1;
+	}
+
+	if ('COLORTERM' in env) {
+		return 1;
+	}
+
+	return min;
+}
+
+export function createSupportsColor(stream, options = {}) {
+	const level = _supportsColor(stream, {
+		streamIsTTY: stream && stream.isTTY,
+		...options,
+	});
+
+	return translateLevel(level);
+}
+
+const supportsColor = {
+	stdout: createSupportsColor({isTTY: tty.isatty(1)}),
+	stderr: createSupportsColor({isTTY: tty.isatty(2)}),
+};
+
+export default supportsColor;

package/components/checkbox/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@auro-formkit/auro-checkbox",
+  "version": "4.1.0",
+  "description": "auro-checkbox HTML custom element",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AlaskaAirlines/auro-checkbox"
+  },
+  "dependencies": {
+    "@alaskaairux/icons": "^4.44.1",
+    "chalk": "^5.3.0",
+    "lit": "^3.2.1"
+  },
+  "peerDependencies": {
+    "@aurodesignsystem/design-tokens": "^4.12.1",
+    "@aurodesignsystem/webcorestylesheets": "^5.1.2"
+  },
+  "devDependencies": {
+    "@auro-formkit/build-tools": "*",
+    "@auro-formkit/config": "*",
+    "@auro-formkit/form-validation": "*",
+    "@auro-formkit/typescript": "*",
+    "@aurodesignsystem/design-tokens": "^4.12.1",
+    "@aurodesignsystem/webcorestylesheets": "^5.1.2",
+    "@rollup/plugin-node-resolve": "^15.3.0",
+    "rollup": "^4.24.0",
+    "rollup-plugin-serve": "^2.0.3",
+    "wc-sass-render": "^1.4.0",
+    "web-component-analyzer": "^2.0.0"
+  },
+  "overrides": {
+    "wc-sass-render": {
+      "sass": "$sass"
+    }
+  },
+  "nodemonConfig": {
+    "ignore": [
+      "*-css.js",
+      "*.css"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "run-s build:sass bundler build:docs types",
+    "build:sass": "sass --no-source-map --load-path=../../node_modules \"./src/styles/:./src/styles/\"",
+    "build:watch": "nodemon -e scss,js --watch src --ignore \"*.css\" --ignore \"*-css.js\" --exec \"npm run build\"",
+    "bundler": "rollup -c node:@auro-formkit/config/rollup",
+    "build:docs": "wca analyze 'scripts/wca/*.js' --outFiles docs/api.md; node ../../packages/build-tools/src/docProcessor.mjs --component checkbox",
+    "clean": "rm -rf dist build",
+    "dev": "web-dev-server",
+    "postCss:component": "node ../../node_modules/@aurodesignsystem/auro-library/scripts/build/postCss.mjs",
+    "sass:render": "sass-render --load-path=../../node_modules 'src/**/*.css' -t ../../node_modules/@aurodesignsystem/auro-library/scripts/build/staticStyles-template.js",
+    "serve": "web-dev-server",
+    "test": "wtr --config \"../../packages/config/src/web-test-runner.config.mjs\" --coverage",
+    "test:watch": "wtr --watch",
+    "types": "tsc --project tsconfig.json",
+    "lint": "npm-run-all scssLint esLint",
+    "scssLint": "stylelint \"./src/**/*.scss\"",
+    "esLint": "eslint \"./src/**/*.js\""
+  }
+}

package/components/checkbox/src/auro-checkbox-group.js

@@ -0,0 +1,319 @@
+// Copyright (c) 2020 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
+// See LICENSE in the project root for license information.
+
+// ---------------------------------------------------------------------
+
+/* eslint-disable max-lines */
+
+import { LitElement, html } from "lit";
+import { classMap } from 'lit/directives/class-map.js';
+
+import AuroFormValidation from '@auro-formkit/form-validation';
+import AuroLibraryRuntimeUtils from '@aurodesignsystem/auro-library/scripts/utils/runtimeUtils.mjs';
+
+// Import the processed CSS file into the scope of the component
+import styleCss from "./styles/auro-checkbox-group-css.js";
+import colorCss from "./styles/colorGroup-css.js";
+import tokensCss from "./styles/tokens-css.js";
+
+/**
+ * The auro-checkbox-group element is a wrapper for auro-checkbox element.
+ *
+ * @attr {String} validity - Specifies the `validityState` this element is in.
+ * @attr {String} setCustomValidity - Sets a custom help text message to display for all validityStates.
+ * @attr {String} setCustomValidityCustomError - Custom help text message to display when validity = `customError`.
+ * @attr {String} setCustomValidityValueMissing - Custom help text message to display when validity = `valueMissing`.
+ * @attr {String} error - When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value.
+ * @attr {Boolean} noValidate - If set, disables auto-validation on blur.
+ * @attr {Boolean} required - Populates the `required` attribute on the element. Used for client-side validation.
+ * @attr {Boolean} horizontal - If set, checkboxes will be aligned horizontally.
+ * @slot {HTMLSlotElement} legend - Allows for the legend to be overridden.
+ * @slot {HTMLSlotElement} optionalLabel - Allows for the optional label to be overridden.
+ * @slot {HTMLSlotElement} helpText - Allows for the helper text to be overridden.
+ * @event auroFormElement-validated - Notifies that the `validity` and `errorMessage` values have changed.
+ */
+
+export class AuroCheckboxGroup extends LitElement {
+  constructor() {
+    super();
+
+    this.validity = undefined;
+    this.value = undefined;
+    this.disabled = undefined;
+    this.required = false;
+    this.horizontal = false;
+
+    /**
+     * @private
+     */
+    this.index = 0;
+
+    /**
+     * @private
+     */
+    this.maxNumber = 3;
+
+    /**
+     * @private
+     */
+    this.validation = new AuroFormValidation();
+
+    /**
+     * @private
+     */
+    this.runtimeUtils = new AuroLibraryRuntimeUtils();
+  }
+
+  static get styles() {
+    return [
+      styleCss,
+      colorCss,
+      tokensCss
+    ];
+  }
+
+  static get properties() {
+    return {
+      disabled: {
+        type: Boolean,
+        reflect: true
+      },
+      horizontal: {
+        type: Boolean,
+        reflect: true
+      },
+      value: {
+        type: Array
+      },
+      noValidate: {
+        type: Boolean,
+        reflect: true
+      },
+      required: {
+        type: Boolean,
+        reflect: true
+      },
+      error: {
+        type: String,
+        reflect: true
+      },
+      setCustomValidity: {
+        type: String
+      },
+      setCustomValidityCustomError: {
+        type: String
+      },
+      setCustomValidityValueMissing: {
+        type: String
+      },
+      validity: {
+        type: String,
+        reflect: true
+      }
+    };
+  }
+
+  /**
+   * This will register this element with the browser.
+   * @param {string} [name="auro-checkbox-group"] - The name of element that you want to register to.
+   *
+   * @example
+   * AuroCheckboxGroup.register("custom-checkbox-group") // this will register this element to <custom-checkbox-group/>
+   *
+   */
+  static register(name = "auro-checkbox-group") {
+    AuroLibraryRuntimeUtils.prototype.registerComponent(name, AuroCheckboxGroup);
+  }
+
+  connectedCallback() {
+    super.connectedCallback();
+    this.handleItems();
+  }
+
+  /**
+   * Helper method to handle checkbox value changing.
+   * @private
+   * @param {String} value - The value of the checkbox.
+   * @param {Boolean} selected - The checked state of the checkbox.
+   * @returns {void}
+   */
+  handleValueUpdate(value, selected) {
+    if (selected) {
+      // add if it isn't already in the value list
+      if (!this.value.includes(value)) {
+        this.value.push(value);
+      }
+    } else if (this.value.indexOf(value) > -1) { // eslint-disable-line no-magic-numbers
+      // remove if it is in the value list
+      const index = this.value.indexOf(value);
+
+      this.value.splice(index, 1);
+    }
+
+    this.dispatchEvent(new CustomEvent('input', {
+      bubbles: true,
+      cancelable: false,
+      composed: true,
+    }));
+
+    this.validation.validate(this, true);
+  }
+
+  firstUpdated() {
+    // Add the tag name as an attribute if it is different than the component name
+    this.runtimeUtils.handleComponentTagRename(this, 'auro-checkbox-group');
+
+    // must declare this function as a variable to correctly pass the reference to the removeEventListener
+    const checkFocusWithin = function(evt) {
+      if (document.auroCheckboxGroupActive && !document.auroCheckboxGroupActive.contains(evt.target)) {
+        // if focus has left the group, cleanup and validate
+        document.auroCheckboxGroupActive.focusWithin = false;
+        window.removeEventListener('focusin', checkFocusWithin);
+        document.removeEventListener('click', checkFocusWithin);
+        // execute the validation
+        document.auroCheckboxGroupActive.validation.validate(document.auroCheckboxGroupActive);
+      }
+    };
+
+    this.addEventListener('auroCheckbox-focusin', () => {
+      if (!this.value) {
+        this.value = [];
+      }
+
+      // handle click outside the group
+      if (!this.focusWithin) {
+        document.addEventListener('click', checkFocusWithin);
+      }
+
+      this.focusWithin = true;
+    });
+
+    this.addEventListener('auroCheckbox-focusout', () => {
+      document.auroCheckboxGroupActive = this;
+
+      // Only add the focusWithin check event listener once as you move focus through the options
+      if (this.focusWithin) {
+        window.addEventListener('focusin', checkFocusWithin);
+      } else {
+        this.focusWithin = true;
+      }
+    });
+
+    this.addEventListener('auroCheckbox-input', (evt) => {
+      this.handleValueUpdate(evt.target.value, evt.target.checked);
+    });
+  }
+
+  /**
+   * Helper method that handles the state of preselected checkboxes.
+   * @private
+   * @returns {void}
+   */
+  handlePreselectedItems() {
+    let preSelectedValues = false;
+
+    this.items.forEach((item) => {
+      if (item.hasAttribute('checked') && this.value === undefined) {
+        preSelectedValues = true;
+      }
+    });
+
+    if (preSelectedValues) {
+      if (!this.value) {
+        this.value = [];
+      }
+
+      this.items.forEach((item) => {
+        this.handleValueUpdate(item.getAttribute('value'), Boolean(item.hasAttribute('checked')));
+      });
+    }
+  }
+
+  /**
+   * Helper method that handles the state of checkboxes.
+   * @private
+   * @returns {void}
+   */
+  handleItems() {
+    const groupTagName = this.tagName.toLowerCase();
+    const checkboxTagName = groupTagName.substring(0, groupTagName.indexOf('-group'));
+
+    this.items = Array.from(this.querySelectorAll(checkboxTagName));
+
+    this.handlePreselectedItems();
+
+    this.validation.validate(this);
+  }
+
+  /**
+   * LitElement lifecycle method. Called after the DOM has been updated.
+   * @param {Map<string, any>} changedProperties - Keys are the names of changed properties, values are the corresponding previous values.
+   * @returns {void}
+   */
+  updated(changedProperties) {
+    if (changedProperties.has('disabled')) {
+      this.items.forEach((el) => {
+        if (this.disabled) {
+          el.setAttribute('disabled', true);
+        } else {
+          el.removeAttribute('disabled');
+        }
+      });
+    }
+
+    if (changedProperties.has('validity')) {
+      this.items.forEach((el) => {
+        if (this.validity && this.validity !== 'valid') {
+          el.setAttribute('error', true);
+        } else {
+          el.removeAttribute('error');
+        }
+      });
+    }
+
+    if (changedProperties.has('required')) {
+      if (this.required) {
+        this.setAttribute('aria-required', true);
+      } else {
+        this.removeAttribute('aria-required');
+      }
+    }
+
+    if (changedProperties.has('error')) {
+      if (this.error) {
+        this.setAttribute('aria-invalid', true);
+      } else {
+        this.removeAttribute('aria-invalid');
+      }
+
+      this.validation.validate(this, true);
+    }
+  }
+
+  render() {
+    const groupClasses = {
+      'displayFlex': this.horizontal && this.items.length <= this.maxNumber
+    };
+
+    return html`
+      <fieldset class="${classMap(groupClasses)}">
+        ${this.required
+          ? html`<legend><slot name="legend"></slot></legend>`
+          : html`<legend><slot name="legend"></slot> (optional)</legend>`
+        }
+        <slot @slotchange=${this.handleItems}></slot>
+      </fieldset>
+
+      ${!this.validity || this.validity === undefined || this.validity === 'valid'
+        ? html`
+          <p class="checkboxGroupElement-helpText" part="helpText">
+            <slot name="helpText"></slot>
+          </p>`
+        : html`
+          <p class="checkboxGroupElement-helpText" role="alert" aria-live="assertive" part="helpText">
+            ${this.setCustomValidity}
+          </p>`
+      }
+    `;
+  }
+}