@aurodesignsystem-dev/auro-formkit 0.0.0-pr593.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+### Changelog
+
+You can view a history of changes to this repository on the releases page:
+
+https://github.com/AlaskaAirlines/auro-formkit/releases

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,2 @@
+Alaska Airlines Auro Design System
+Copyright 2024 Alaska Airlines, Inc. or its affiliates. All Rights Reserved.

package/README.md

@@ -0,0 +1,314 @@
+<!--
+The README.md file is a compiled document. No edits should be made directly to this file.
+
+README.md is created by running `npm run build:docs:kit`.
+
+The following sections are editable by making changes to the following files:
+
+| SECTION                | DESCRIPTION                                       | FILE LOCATION                       |
+|------------------------|---------------------------------------------------|-------------------------------------|
+| Description            | Description of the component                      | `./docs/partials/description.md`    |
+| Use Cases              | Examples for when to use this component           | `./docs/partials/useCases.md`       |
+| Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
+| Component Example Code | HTML sample code of the components use            | `./apiExamples/basic.html`          |
+-->
+
+# Auro Formkit
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
+<!-- The below content is automatically added from ./docs/partials/description.md -->
+
+## Description
+
+`auro-formkit` is a collection of web components that can be used to build forms.
+
+It is a monorepo that contains the following components:
+
+- `auro-checkbox`
+    - `auro-checkbox-group`
+- `auro-combobox`
+- `auro-counter`
+    - `auro-counter-group`
+- `auro-datepicker`
+- `auro-dropdown`
+- `auro-form`
+- `auro-input`
+- `auro-menu`
+    - `auro-menu-option`
+- `auro-radio`
+    - `auro-radio-group`
+- `auro-select`
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Install
+
+<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall_esm.md) -->
+[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-formkit/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-formkit/actions/workflows/testPublish.yml)
+[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-formkit?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-formkit)
+[![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-formkit?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
+![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge)
+
+```shell
+$ npm i @aurodesignsystem/auro-formkit
+```
+
+Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this [stack overflow](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.
+
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Getting Started
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/gettingStarted.md) -->
+<!-- The below content is automatically added from ./docs/partials/gettingStarted.md -->
+To start using the Auro Formkit components, follow the instructions below:
+
+### Usage
+
+You can use Auro Formkit components in your project in two ways: automatic or custom registration.
+
+#### Automatic Registration
+
+For automatic registration, simply import the component:
+
+```javascript
+import "@aurodesignsystem/auro-formkit/auro-checkbox";
+```
+
+This will automatically register both the `<auro-checkbox>` and the included `<auro-checkbox-group>` component for use in your project. Note that not all Auro Formkit components have sub-components. Be sure to check the documentation for each component to understand its specific usage and registration requirements.
+
+#### Custom Registration
+
+If you prefer to register the component with a custom name, you can call the component class directly to create a custom registration:
+
+```javascript
+import { AuroCheckbox, AuroCheckboxGroup } from "@aurodesignsystem/auro-formkit/auro-checkbox/class";
+
+AuroCheckbox.register('custom-checkbox');
+AuroCheckbox.register('custom-checkbox-group');
+```
+
+This will register the component as `<custom-checkbox>` and `<custom-checkbox-group>`.
+
+#### TypeScript Module Resolution
+
+When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
+
+```json
+{
+    "compilerOptions": {
+        "moduleResolution": "bundler"
+    }
+}
+```
+
+This configuration enables proper module resolution for the component's TypeScript files.
+
+### Basic HTML Example
+
+Here is an example of how to use the Auro Checkbox component in your HTML:
+
+`index.html -> <head>`
+
+```html
+<script type="module">
+    import "@aurodesignsystem/auro-formkit/auro-checkbox";
+</script>
+```
+
+`index.html -> <body>`
+
+```html
+<auro-checkbox-group>
+    <span slot="legend">
+        Form label goes here
+    </span>
+    <auro-checkbox value="value1" name="basic" id="checkbox-basic1">
+        Checkbox option
+    </auro-checkbox>
+    <auro-checkbox value="value2" name="basic" id="checkbox-basic2" checked>
+        Checkbox option two
+    </auro-checkbox>
+</auro-checkbox-group>
+```
+
+By following these steps, you can easily integrate Auro Formkit components into your project.
+<!-- AURO-GENERATED-CONTENT:END -->
+
+### Design Token CSS Custom Property dependency
+
+<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
+The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
+
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Development
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/developmentDescription.md) -->
+<!-- The below content is automatically added from ./docs/partials/developmentDescription.md -->
+
+### Filtering
+
+Running the `dev` command will open a `localhost` development server for all components in the monorepo at once.
+
+To only develop a single component, use the `--filter` flag:
+
+```shell
+npx turbo dev --filter=@aurodesignsystem/auro-input
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+
+### Start development environment
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/localhost.md) -->
+<!-- The below content is automatically added from ./docs/partials/localhost.md -->
+
+## Local Development
+<!-- AURO-GENERATED-CONTENT:END -->
+
+### Testing
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/testing.md) -->
+<!-- The below content is automatically added from ./docs/partials/testing.md -->
+```
+npm run test
+```
+
+#### Port configuration
+
+Turbo will attempt to test components in parallel which will lead to port conflicts.
+
+Setting the `concurrency` to `1` will prevent Turbo from running tests in parallel:
+
+```
+"test": "turbo run test --concurrency=1",
+```
+
+`turbo.json`does not support `--concurrency` yet. See [this issue](https://github.com/vercel/turborepo/discussions/7493).
+<!-- AURO-GENERATED-CONTENT:END -->
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
+<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
+
+## Turborepo Overview
+
+This monorepo is managed using [Turborepo](https://turborepo.org/).
+
+### Managing dependencies
+
+#### Best practices for dependency installation
+
+When you install a dependency in a component or package in `auro-formkit`, you should install it directly in the package that uses it. 
+
+The package's `package.json` will have every dependency that it needs. This is true for both external and internal dependencies.
+
+### Types of Dependencies by Source
+
+#### External Dependencies
+- These are packages fetched from the `npm` registry (e.g., Lit, Rollup, Sass)
+- Declared in `package.json` using exact versions or version ranges
+- Installed in `node_modules` during `npm install` or `yarn install`
+
+#### Internal Dependencies
+- These are packages from within the `auro-formkit` monorepo
+- Allow sharing code between different packages in your repository
+- Example: The `@aurodesignsystem/combobox` package might depend on `@auro-formkit/input`
+- Must be declared in `package.json` just like external dependencies
+- Use workspace protocols (e.g., `"workspace:*"` or `"workspace:^1.0.0"`)
+
+### Types of Dependencies by Purpose
+
+#### Dependencies (`dependencies`)
+- Required for the package to function in production
+- Example:
+  ```json
+  {
+    "dependencies": {
+      "lit.js": "^3.0.0",                    // External dependency
+      "@auro-formkit/input": "workspace:*"  // Internal dependency
+    }
+  }
+  ```
+
+#### Peer Dependencies (`peerDependencies`)
+- Packages that your library expects the consuming application to provide
+- Common for plugins or UI component libraries
+- Example:
+  ```json
+  {
+    "peerDependencies": {
+      "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
+      "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
+    }
+  }
+  ```
+
+### Development Dependencies (`devDependencies`)
+- Only needed during development, testing, or building
+- Not included in the production bundle
+- Example:
+  ```json
+  {
+    "devDependencies": {
+      "typescript": "^5.0.0",
+      "@open-wc/testing": "^4.0.0"  // Internal dev dependency
+    }
+  }
+  ```
+
+## Example: Component Dependencies
+
+Let's use `@auro-formki/combobox` as an example to illustrate these concepts:
+
+```json
+{
+  "name": "@auro-formkit/combobox",
+  "dependencies": {
+    // Internal dependencies
+    "@aurodesignsystem/auro-dropdown": "*",     // Required UI component
+    "@aurodesignsystem/auro-input": "*",        // Required UI component
+
+    // External dependencies
+    "@alaskaairux/icons": "^5.3.0",  // Required UI component
+    "lit": "^3.2.1"                   // Framework
+  },
+  "peerDependencies": {
+    "@aurodesignsystem/design-tokens": "^4.12.1",
+    "@aurodesignsystem/webcorestylesheets": "^5.1.2"
+  },
+  "devDependencies": {
+    // Build utilities
+    "rollup": "^4.24.4",
+    "@auro-formkit/build-tools": "*",
+  }
+}
+```
+
+This structure ensures that:
+1. The package explicitly declares all its dependencies
+2. Internal dependencies are properly tracked and versioned
+3. Development tools are separated from production dependencies
+4. Peer dependencies are clearly communicated to consumers
+
+- External dependencies come from the `npm` registry.
+
+- Internal dependencies let you share functionality within your repository.
+
+This practice has several benefits:
+
+- **Improved clarity:** It's easier to understand what a package depends on when its dependencies are listed in its `package.json`. Developers working in the repository can see at a glance what dependencies are used within the package.
+
+- **Enhanced flexibility:** In a monorepo at scale, it can be unrealistic to expect each package to use the same version of an external dependency.
+
+- **Better caching ability:** If you install too many dependencies in the root of your repository, you'll be changing the workspace root whenever you add, update, or delete a dependency, leading to unnecessary cache misses.
+
+- **Pruning unused dependencies:** When dependencies are installed in the packages that they are meant for, Turborepo can read your lockfile and remove dependencies that aren't used in the packages you need.
+
+For more information, see the [Turborepo docs](https://turbo.build/repo/docs/crafting-your-repository/managing-dependencies).
+
+### Root `package.json`
+
+The only dependencies that belong in the root `package.json` are **tools for managing the repository**.
+
+Some examples of dependencies that make sense to install in the root are `turbo`, `husky`, or `stylelint`.
+
+Conversely, dependencies Auro components rely on should be installed in their respective packages, such as `Lit`, `Rollup`, or other `auro-formkit` dependencies.
+<!-- AURO-GENERATED-CONTENT:END -->

package/components/bibtemplate/dist/auro-bibtemplate.d.ts

@@ -0,0 +1,39 @@
+export class AuroBibtemplate extends LitElement {
+    static get styles(): import("lit").CSSResult[];
+    static get properties(): {
+        isFullscreen: {
+            type: BooleanConstructor;
+            reflect: boolean;
+        };
+        large: {
+            type: BooleanConstructor;
+            reflect: boolean;
+        };
+    };
+    /**
+     * This will register this element with the browser.
+     * @param {string} [name="auro-bibtemplate"] - The name of element that you want to register to.
+     *
+     * @example
+     * AuroCheckbox.register("custom-bibtemplate") // this will register this element to <custom-bibtemplate/>
+     *
+     */
+    static register(name?: string): void;
+    large: boolean;
+    iconTag: any;
+    headerTag: any;
+    /**
+     * Prevents scrolling of the body when touching empty areas of the component.
+     * @param {Event} event - The touchmove event.
+     * @returns {void}
+     */
+    preventBodyScroll(event: Event): void;
+    onCloseButtonClick(): void;
+    /**
+     * Exposes CSS parts for styling from parent components.
+     * @returns {void}
+     */
+    exposeCssParts(): void;
+    render(): import("lit-html").TemplateResult;
+}
+import { LitElement } from "lit";

package/components/bibtemplate/dist/headerVersion.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "4.0.1";
+export default _default;

package/components/bibtemplate/dist/iconVersion.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "8.0.2";
+export default _default;

package/components/bibtemplate/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { AuroBibtemplate };
+import { AuroBibtemplate } from './auro-bibtemplate.js';