-
Notifications
You must be signed in to change notification settings - Fork 20
feat(wes): create Lit package for WES #149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from 14 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
697295e
chore(init): lit wes
JaeAeich bd77641
fix: setup
JaeAeich 4a02c01
feat: add create run component for wes
JaeAeich 9939319
chore: minor change
JaeAeich aa2dd87
chore: organise form data
JaeAeich c94862d
feat: add wes create component
JaeAeich ae7b9b8
Merge branch 'main' into lit/wes
JaeAeich 47ff721
chore: refactor
JaeAeich a18a2f8
Merge branch 'main' into lit/wes
JaeAeich 5b0d29c
chore: refactor and test on localhost
JaeAeich df67cc7
chore: left some files in prev commit
JaeAeich d1cba52
feat: add submit response
JaeAeich 4b9ebc0
docs: docs for WESCreateRun
JaeAeich aebb30d
chore: cleaning package and typos
JaeAeich 087fd72
Merge branch 'main' into lit/wes
JaeAeich e5d6038
fix: fix docs
JaeAeich 5b55c32
chore: reorder fields and fix labels
JaeAeich 278090b
Merge branch 'main' into lit/wes
anuragxxd b1d767b
Update form.ts
anuragxxd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
# Form Component <Badge type="warning" text="beta" /> | ||
|
||
<div class="component-name"><ecc-client-lit-ga4gh-wes-create-run></div> | ||
This component is used to create workflows runs using WES API. | ||
<ClientOnly> | ||
<div :class="isDark ? 'component-dark component' : 'component-light component'"> | ||
<ecc-client-lit-ga4gh-wes-create-run /> | ||
|
||
::: details Code Blocks | ||
::: code-group | ||
|
||
```js [HTML] | ||
import "@elixir-cloud/lit-wes"; | ||
|
||
<ecc-utils-design-form />; | ||
``` | ||
|
||
<!-- ```jsx [React] | ||
|
||
``` --> | ||
|
||
::: | ||
|
||
</div> | ||
</ClientOnly> | ||
|
||
## Importing | ||
|
||
```js [HTML] | ||
import "@elixir-cloud/lit-wes"; | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Required | Default | Type | Description | | ||
| --------------------- | -------- | ----------------------------------------- | -------- | ----------- | | ||
| [`baseURL`](#baseURL) | `false` | `https://prowes.rahtiapp.fi/ga4gh/wes/v1` | `String` | Base URL | | ||
|
||
### baseURL | ||
|
||
This property is used to give `POST` endpoint to create workflow. The provided baseURL is concatinated with `/runs` and is used as an endpoint to create a `POST` request. | ||
|
||
## Parts | ||
|
||
TODO: | ||
|
||
<!-- | Part Name | Description | | ||
| --------------- | --------------------------------------------------------------------------------- | | ||
| `` | Component's internal form. | --> | ||
|
||
## CSS Variables | ||
|
||
## Examples | ||
|
||
### With baseURL | ||
|
||
<ClientOnly> | ||
<div :class="isDark ? 'component-dark component' : 'component-light component'"> | ||
<!-- Render ecc-utils-design-form component only after the component is loaded --> | ||
<ecc-client-lit-ga4gh-wes-create-run | ||
baseURL="http://localhost:8090/ga4gh/wes/v1" | ||
/> | ||
|
||
::: details Code Blocks | ||
::: code-group | ||
|
||
```js [HTML] | ||
import "@elixir-cloud/lit-wes"; | ||
|
||
<ecc-client-lit-ga4gh-wes-create-run baseURL="http://localhost:8090/ga4gh/wes/v1" />; | ||
``` | ||
|
||
<!-- ```jsx [React] | ||
|
||
``` --> | ||
|
||
::: | ||
|
||
</div> | ||
</ClientOnly> | ||
|
||
> The baseURL provided is localhost:8090, for this to work, have a WES implementation running on PORT 8090 or locally deploy [proWES](https://github.com/elixir-cloud-aai/proWES). | ||
|
||
<script setup> | ||
import { onMounted } from "vue"; | ||
import { useData } from "vitepress"; | ||
const { isDark } = useData(); | ||
onMounted(() => { | ||
import("@elixir-cloud/lit-wes").then((module) => { | ||
renderComponent.value = false; | ||
renderComponent.value = true; | ||
document.querySelectorAll("ecc-client-lit-ga4gh-wes-create-run").forEach((element) => { | ||
element.addEventListener("form-submit", (e) => { | ||
console.log("form-submitted", e.detail); | ||
}); | ||
}); | ||
}); | ||
}); | ||
</script> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Installation | ||
|
||
`@elixir-cloud/wes` can be installed using npm as | ||
|
||
```bash | ||
npm install @elixir-cloud/lit-wes | ||
``` | ||
anuragxxd marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Introduction | ||
|
||
`@elixir-cloud/wes` package provides a collection of Web Components for interacting with [WES (Workflow Execution Service)](https://github.com/ga4gh/workflow-execution-service-schemas/blob/develop/openapi/workflow_execution_service.openapi.yaml). It offers functionalities for listing, creating, and deleting task runs. These components facilitate seamless integration and enhanced user experience when working with WES. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.