planbgmbh / flinkey-web-components Goto Github PK

Is your feature request related to a problem? Please describe.
Actually only Prettier is used in the project. Therefore several "code issues" can still occur. E.g. lines in files that are too long.

Describe the solution you'd like
As a flinkey Web Components contributor, I would like to have ESLint integrated in the project and workflows so that code is formatted accordingly.

Additional context
Stencil ESLint

Describe the bug
With the current Tailwind configuration, not all functionalities are working. Re-configuration of the Stencil and Tailwind files are needed in order to use all possible features that Tailwind offers.

To Reproduce
Steps to reproduce the behavior:
None

Expected behavior
When using Tailwind on the project, we should have access to all possible functionalities.

Screenshots
None

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
No additional context

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
As a flinkey Web Components consumer, I would like to have the possibility to try the web components out and I would like to have good documentation provided as Storybook. The Storybook should be available threw GitHub pages which is deployed via Build & Publish workflow.

Additional context
Storybook
GitHub Pages
Build & Publish workflow

See Community settings.

Is your feature request related to a problem? Please describe.
No, it's not.

Describe the solution you'd like
As a flinkey integration partner I want to have the possibility to easily integrate install/uninstall product to/from car into my solution without building entire new UI for it.

Additional context
flinkey API Endpoints we need to use:

• Get cars (also note that there's OData querying available for this endpoint)
• Get products (also note that there's OData querying available for this endpoint)
• Install product into car
• Uninstall product from car

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
The Build & Publish workflow should set the date for the new GitHub release.

Additional context
See workflow file.

Is your feature request related to a problem? Please describe.
I may want to view the table by e.g. descending serial number.

Describe the solution you'd like
As a flinkey Web Components consumer, I would like to have the possibility to sort by columns of the table (ascending and descending). Note: the developer integrating the component should have the option to enable or disable the sorting functionality.

Additional context

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
As a flinkey Web Components contributor, I would like to make sure to have a branch with proper name created. Therefore I would like to have branch name validation included into PR validation workflow.

Additional context
See workflow file.

Decide what's the best way for us to create the Web Components.

• run prettier (linting)
• run unit tests
• run e2e tests

• use changes of CHANGELOG.md for release
• create release with build artifact

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
The PR Validation workflow should make sure the changelog file's content has changed and has expected content format.

Additional context
Changelog
PR validation workflow
Format:

## Added

- ...
- ...
- ...

## Changed

- ...
- ...
- ...

## Fixed

- ...
- ...
- ...

## Removed

- ...
- ...
- ...

[Link to GitHub issue](https://github.com/PlanBGmbH/flinkey-web-components/issues/<issue-number>)

In the further process of development we need to add a GitHub Actions pipeline that:

• builds our Web Components
• tests our Web Components (unit & e2e tests)
• publishes the updated Web Components to NPM

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
As a flinkey Web Components consumer, I would like to see same keywords in package.json and on GitHub repo start page.

Additional context
No additional context.

Describe the bug
Dependabot creates pull requests that bump version(s) of web components package dependency/ies but it doesn't also bump version of web components itself. Therefore validation workflow ends up with an error.

Expected behavior
We should only do web components version validation when workflow is not triggered by Dependabot.

Is your feature request related to a problem? Please describe.
No, it's not.

Describe the solution you'd like
As a flinkey integration partner I want to have the possibility to easily integrate assign/unassign service to/from product into my solution without building entire new UI for it.

Additional context
flinkey API Endpoints we need to use:

• Get services (also note that there's OData querying available for this endpoint)
• Get products (also note that there's OData querying available for this endpoint)
• Pair service with product
• Unlink service from product

Describe the bug
When the Build & Publish workflow creates a GitHub release, the content of the created GitHub release is not correct when there is for example a backtick in the markdown of the changelog file.

To Reproduce
Steps to reproduce the behavior:

1. Run all jobs of a Build & Publish workflow run
2. Go to Releases
3. See latest release description -> difference between changelog file content and GitHub release description (if changelog file contains a backtick)

Expected behavior
The Build & Publish workflow should correctly copy the entire changelog file's content to the GitHub release description.

Screenshots
No screenshots.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
See workflow file.

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
Extract the "Prepare GitHub release" script of Build & Publish workflow into separate script file and reference this file in the Build & Publish workflow.

Additional context
See workflow file.

Update all project dependencies (node version in pipeline and NPM packages of Stencil project). Also fix vulnerabilities.

We should do a brainstorming regarding which Web Components to create first.

Is your feature request related to a problem? Please describe.
If there are lots of products, I need to search for the entry I'm looking for manually via scrolling threw the pages of the table.

Describe the solution you'd like
As a flinkey Web Components consumer, I would like to have the possibility to globally search over all fields of the table. Note: the developer integrating the component should have the option to enable or disable the contains filter functionality.

Additional context

Is your feature request related to a problem? Please describe.
No, it's not.

Describe the solution you'd like
As a flinkey integration partner I would like to have a collection of basic project information in the README. The README should therefore consist of the following information:

• Include Build & Publish pipeline status badge
• MIT license badge
• NPM version badge
• Give brief introduction to the project
• Give usage introduction (use keyfob catalog component as an example)

Additional context
There's no additional context.

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
As a flinkey Web Components consumer, I would like to have an example of how to integrate the flinkey Web Components into a React application.

Additional context
There's not additional context.

Describe the bug
Sometimes in GitHub Actions workflows (Validate and Build & Release) the E2E test step fails due to invalid JSON that could not be parsed.

To Reproduce
Not reproducible. The error just sometimes occurs.

Expected behavior
E2E tests are able to parse JSON and then run properly.

Screenshots

See Community settings.

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
As a flinkey Web Components consumer, I would like to have a reduced amount of license occurrences in README file. The license badge should link to GitHub repository LICENSE file.

Additional context
There's no additional context.

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
Extract the package version update script of Build & Publish workflow into separate script file and reference this file in the Build & Publish workflow.

Additional context
See workflow file.

GitHub release should have artifact with exact same content of new NPM package version.
Firstly publish to NPM. After that call: http://registry.npmjs.org/@planbgmbh/flinkey-web-components/{version}
From there get the value of JSON field "tarball". "Convert" tarball to ZIP.

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
As a flinkey Web Components consumer, I would like to have the possibility to provide custom texts for static text resources (e.g. table headers) to the web components.

Additional context
There's no additional context.

Is your feature request related to a problem? Please describe.
No, it's not.

Describe the solution you'd like
As a project maintainer and/or contributor, I'd like to use TailwindCSS as a CSS framework, in order to style my components in an organized, scalable and fast way.

Additional context
There's no additional context.

@ChristophBo May add your ideas here in conversation.

See Community standards.

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
As a contributor of the flinkey Web Components, I would like to see in package.json which node and npm versions I should use.

Additional context
See npm Docs

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
As flinkey Web Components contributor, I would like to have access to basic common setup:

• Globals TS class
• Shared Tailwind CSS file
• fetch API wrappers

Additional context
There's no additional context.

Is your feature request related to a problem? Please describe.
If there are lots of entries to load this would slow down the component.

Describe the solution you'd like
As a flinkey Web Components consumer, I would like to have the possibility to view paginated entries so that the performance of the table is good. Note: the developer integrating the component should have the option to enable or disable the pagination functionality.

Additional context

Is your feature request related to a problem? Please describe.
No, it's not.

Describe the solution you'd like
As a flinkey integration partner I want to have the possibility to easily integrate the Keyfob catalog into my solution without building entire new UI for it.

Additional context
flinkey Box -> Click on button "KEYFOB OVERVIEW"
Get brands
Get keys of brand

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
Extract the "Create GitHub release artifact" script of Build & Publish workflow into separate script file and reference this file in the Build & Publish workflow.

Additional context
See workflow file.

See Community settings.

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
Extract the version validation script of PR validation workflow into separate script file and reference this file in the PR validation workflow.

Additional context
See workflow file.

Do a research what's the best way for us to create the Web Components.

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
As a flinkey Web Components consumer, I would like to have an example of how to integrate the flinkey Web Components into an Angular application.

Additional context
There's not additional context.

Is your feature request related to a problem? Please describe.
No, it is not.

Describe the solution you'd like
Extract the dependabot committer/author validation script of PR validation workflow into separate script file and reference this file in the PR validation workflow.

Additional context
See workflow file.