Merge pull request #146 from finos/dev

Update main from dev

Author: aaronreed708

.github/workflows/npm.yml

@@ -0,0 +1,32 @@
+name: Publish to NPM
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - 'docs/**'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    # use 'if' to prevent endless looping with npm package commit
+    if: "!startsWith(github.event.head_commit.message, '[RELEASE]')"
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - run: git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
+      - run: git config user.name "$GITHUB_ACTOR"
+      # prepend '[RELEASE]' so that it can be detected above to prevent looping
+      #  this is a commit to main that can be ignored by this GitHub action
+      #  use 'patch' to update only the last digit in the version (e.g. 1.1.?)
+      - run: npm version patch -m "[RELEASE] %s"
+      - run: git push
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish --access=public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CONTRIBUTE.md

@@ -5,14 +5,32 @@ This document provides guidance for how YOU can collaborate with our project com
 
 This document describes the contribution process and governance policies of the FINOS Accessibility Theme Builder project. The project is also governed by the [Linux Foundation Antitrust Policy](https://www.linuxfoundation.org/antitrust-policy/), and the FINOS [IP Policy](https://community.finos.org/assets/files/IP-Policy-9b1cd5f6c1d682e073c3c15224fc6d86.pdf), [Code of Conduct](https://community.finos.org/docs/governance/code-of-conduct), [Collaborative Principles](https://community.finos.org/docs/governance/collaborative-principles/), and [Meeting Procedures](https://community.finos.org/docs/governance/meeting-procedures/).
 
+## Reporting Issues
+
+We welcome any feedback on the quality, stability or performance of Theme Builder.  If you see incorrect behavior or would like to suggest ways to improve Theme Builder, please use these guidelines to create an issue in GitHub.
+1. Please [check](https://github.com/finos/a11y-theme-builder/issues) whether there is already an open issue related to your experience/feedback. If there is, join the discussion and contribute any observations or information that may not already be present in the issue.
+2. If there isn't already a relevant issue, create one, describing your experience with Theme Builder.
+    1. Add appropriate tag for project -> [`SDK`, `theme builder app`]
+        * SDK - performs calculations, creates and populates CSS variables, generates CSS and JSON output
+        * theme builder app - the application that the user interacts with
+    3. Add appropriate tag for type of issue -> [`bug`, `enhancement`]
+    4. (optional) Add tag for required specialties -> [`design thinking`, `project management`, `question`, `documentation`]
+    5. Set `Projects` field to `ThemeBuilder`
+4. If you would like to contribute designs, code, testing or resources toward resolving the issue, please note that in the issue.
+5. Respond to any questions or suggestions raised in the issue by other community members.
+6. We will triage all new issues at our next community meeting if you would like to offer more information as we prioritize your issue.  Click to see more [meeting information](https://github.com/finos/a11y-theme-builder/wiki/Communication#meetings).
+
 ## Contribution Process
 
 Before making a contribution, please take the following steps:
-1. Check whether there's already an open issue related to your proposed contribution. If there is, join the discussion and propose your contribution there.
-2. If there isn't already a relevant issue, create one, describing your contribution and the problem you're trying to solve.
-3. Respond to any questions or suggestions raised in the issue by other developers.
-4. Fork the project repository and prepare your proposed contribution.
-5. Submit a pull request.
+1. Check whether there's already an open issue related to your proposed contribution as described above.  If not, follow instructions above to create an issue with all relevant information.
+2. Respond to any questions or suggestions raised in the issue by other developers.
+3. Fork the project repository and prepare your proposed contribution.  All contributions should be created using the latest code from the upstream dev branch.
+    1. In commit messages, reference associated issue.  For example, `commit -m "finos/a11y-theme-builder#111: corrected button behavior"`
+    2. When your changes are ready, be sure to update your branch with the latest upstream dev branch to ensure code will merge correctly.
+    3. Retest your contribution with latest updates.
+4. Submit a pull request.
+    * All pull requests should be made to merge into the upstream dev branch.
 
 NOTE: All contributors must have a contributor license agreement (CLA) on file with FINOS before their pull requests will be merged. Please review the FINOS [contribution requirements](https://community.finos.org/docs/governance/Software-Projects/contribution-compliance-requirements) and submit (or have your employer submit) the required CLA before submitting a pull request.
 
@@ -29,9 +47,9 @@ This section includes ways to get started with your open source project. Include
   * Link: https://github.com/finos/a11y-theme-builder/discussions
 * Slack
   * Used for questions to project maintainers or for private chat.
-  * Link: https://a11y-l464962.slack.com
+  * Link: https://join.slack.com/t/finos-lf/shared_invite/zt-24pxubwxi-vKczbM0pWYnltCRoOCDpFQ
 * Blog/Wiki
-  * Link: https://github.com/finos/a11y-theme-builder/wiki 
+  * Link: https://github.com/finos/a11y-theme-builder/wiki
 
 ## Community 
 Participating in our project community spans a variety of activities:

TUTORIAL.md

@@ -7,15 +7,15 @@ The following is a tutorial of how to use this SDK in order to generate code whi
    To create a ThemeBuilder without persistent storage:
 
    ```
-   import { ThemeBuilder } from "a11y-theme-builder-sdk";
+   import { ThemeBuilder } from "@finos/a11y-theme-builder-sdk";
    ...
    const myThemeBuilder = await ThemeBuilder.create();
    ```
 
    To create a ThemeBuilder with persistent storage, create a class which implements the [Storage interface](./src/storage/interface.ts) and pass an instance of your object to the create method as follows:
 
    ```
-   import { ThemeBuilder, Storage } from "a11y-theme-builder-sdk";
+   import { ThemeBuilder, Storage } from "@finos/a11y-theme-builder-sdk";
    ...
    const myStorageObject = new MyStorageObject();  // MyStorageObject implements the 'Storage' interface
    const myThemeBuilder = await ThemeBuilder.create({storage: myStorageObject});

package-lock.json

@@ -1,6 +1,6 @@
 {
-  "name": "a11y-theme-builder-sdk",
-  "version": "0.0.22",
+  "name": "@finos/a11y-theme-builder-sdk",
+  "version": "1.0.0",
   "description": "Accessibility Theme Builder SDK",
   "author": "Keith Smith <KeithSmith@discover.com>",
   "license": "Apache-2.0",

package.json

@@ -227,6 +227,8 @@ export class ColorTheme extends Node implements IColorTheme {
         this.primary = new PropertyColorShade("Primary", true, this, opts);
         this.secondary = new PropertyColorShade("Secondary", true, this, opts);
         this.tertiary = new PropertyColorShade("Tertiary", true, this, opts);
+        this.secondary.addDependency(this.primary);
+        this.tertiary.addDependency(this.secondary);
         this.lightModeBackground = new PropertyColorPair("Light Mode Background", true, this, []);
         this.lightModeBackground.addDependency(this.primary);
         this.darkModeBackground = new PropertyColorPair("Dark Mode Background", true, this, []);

src/atoms/colorThemes.ts

@@ -50,7 +50,7 @@ export class TypographyStyling extends Node {
             getSelectables: this.getFontFamilySelectables.bind(this),
             getDefaultValue: this.getFontFamilyDefaultSelectableValue.bind(this),
         });
-        this.fontSize = new PropertyFontRange("Font Size", false, this, 0, 128, defaultFontSize);
+        this.fontSize = new PropertyFontRange("Font Size", false, this, 0, 256, defaultFontSize);
         this.fontWeight = new PropertyNumberSelectable("Font Weight", false, this, [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000], defaultFontWeight);
         this.lineHeight = new PropertyPercentageSelectable("Line Height", false, this, [130, 160], defaultLineHeight);
         this.letterSpacing = new PropertyPixelRange("Character Spacing", false, this, -2, 10, defaultLetterSpacing);