Skip to content

Commit 2ea82dd

Browse files
committed
v1.0.0-alpha rewrite
- changed organisation and package name - updated maintainers - removed previous code items - updated tools Signed-off-by: Jean-Baptiste Bianchi <jb.bianchi@neuroglia.io>
1 parent af7a343 commit 2ea82dd

File tree

177 files changed

+6227
-26113
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

177 files changed

+6227
-26113
lines changed

MAINTAINERS.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# Serverless Workflow Typescript SDK Maintainers
1+
# Serverless Workflow Org Maintainers
22

3+
* [Jean-Baptiste Bianchi](https://github.com/JBBianchi)
4+
* [Charles d'Avernas](https://github.com/cdavernas)
5+
* [Ricardo Zanini](https://github.com/ricardozanini)
6+
7+
# Serverless Workflow Org Emeritus Maintainers
38
* [Antonio Mendoza Pérez](https://github.com/antmendoza)
4-
* [Tihomir Surdilovic](https://github.com/tsurdilo)
9+
10+
# Maintainers Mailing list
11+
[cncf-serverlessws-maintainers](mailto:cncf-serverlessws-maintainers@lists.cncf.io)

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Node CI](https://github.com/serverlessworkflow/sdk-typescript/workflows/Node%20CI/badge.svg) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/serverlessworkflow/sdk-typescript)
1+
![Node CI](https://github.com/serverless-workflow/sdk/workflows/Node%20CI/badge.svg) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/serverless-workflow/sdk)
22

33
# Serverless Workflow Specification - Typescript SDK
44

@@ -14,9 +14,9 @@ With the SDK you can:
1414

1515
| Latest Releases | Conformance to spec version |
1616
| :---: | :---: |
17-
| [v1.0.0](https://github.com/serverlessworkflow/sdk-typescript/releases/) | [v0.6](https://github.com/serverlessworkflow/specification/tree/0.6.x) |
18-
| [v2.0.0](https://github.com/serverlessworkflow/sdk-typescript/releases/) | [v0.7](https://github.com/serverlessworkflow/specification/tree/0.7.x) |
19-
| [v3.0.0](https://github.com/serverlessworkflow/sdk-typescript/releases/) | [v0.8](https://github.com/serverlessworkflow/specification/tree/0.8.x) |
17+
| [v1.0.0](https://github.com/serverless-workflow/sdk/releases/) | [v0.6](https://github.com/serverlessworkflow/specification/tree/0.6.x) |
18+
| [v2.0.0](https://github.com/serverless-workflow/sdk/releases/) | [v0.7](https://github.com/serverlessworkflow/specification/tree/0.7.x) |
19+
| [v3.0.0](https://github.com/serverless-workflow/sdk/releases/) | [v0.8](https://github.com/serverlessworkflow/specification/tree/0.8.x) |
2020

2121

2222

@@ -27,7 +27,7 @@ With the SDK you can:
2727
To build the project and run tests locally:
2828

2929
```sh
30-
git clone https://github.com/serverlessworkflow/sdk-typescript.git
30+
git clone https://github.com/serverless-workflow/sdk.git
3131
cd sdk-typescript
3232
npm install && npm run build && npm run test
3333
```
@@ -41,7 +41,7 @@ npm install && npm run build && npm run test
4141
##### Version >= 4.0.0
4242
Note: Version 4.0.0 has not been released yet.
4343
```sh
44-
npm i @serverlessworkflow/sdk-typescript
44+
npm i @serverless-workflow/sdk
4545
```
4646

4747

@@ -55,7 +55,7 @@ npm i @severlessworkflow/sdk-typescript
5555
#### Create Workflow using builder API
5656

5757
```typescript
58-
import { workflowBuilder, injectstateBuilder, Specification } from '@serverlessworkflow/sdk-typescript';
58+
import { workflowBuilder, injectstateBuilder, Specification } from '@serverless-workflow/sdk';
5959

6060
const workflow: Specification.Workflow = workflowBuilder()
6161
.id("helloworld")
@@ -78,7 +78,7 @@ const workflow: Specification.Workflow = workflowBuilder()
7878
#### Create Workflow from JSON/YAML source
7979

8080
```typescript
81-
import { Specification, Workflow } from '@serverlessworkflow/sdk-typescript';
81+
import { Specification, Workflow } from '@serverless-workflow/sdk';
8282

8383
const source = `id: helloworld
8484
version: '1.0'
@@ -102,7 +102,7 @@ Where `source` can be in both JSON or YAML format.
102102
Having the following workflow instance:
103103

104104
```typescript
105-
import { workflowBuilder, injectstateBuilder, Specification } from '@serverlessworkflow/sdk-typescript';
105+
import { workflowBuilder, injectstateBuilder, Specification } from '@serverless-workflow/sdk';
106106

107107
const workflow: Specification.Workflow = workflowBuilder()
108108
.id("helloworld")
@@ -156,7 +156,7 @@ The sdk provides a way to validate if a workflow object is compliant with the se
156156
- `validate(): boolean`
157157

158158
```typescript
159-
import {WorkflowValidator, Specification} from '@serverlessworkflow/sdk-typescript';
159+
import {WorkflowValidator, Specification} from '@serverless-workflow/sdk';
160160
import {Workflow} from "./workflow";
161161

162162
const workflow = {
@@ -188,7 +188,7 @@ You can also validate parts of a workflow using `validators`:
188188

189189
```typescript
190190
import { ValidateFunction } from 'ajv';
191-
import { validators, Specification } from '@serverlessworkflow/sdk-typescript';
191+
import { validators, Specification } from '@serverless-workflow/sdk';
192192

193193
const injectionState: Specification.Injectstate = workflow.states[0];
194194
const injectionStateValidator: ValidateFunction<Specification.Injectstate> = validators.get('Injectstate');

examples/browser/index.html

Lines changed: 0 additions & 40 deletions
This file was deleted.

examples/browser/mermaid.html

Lines changed: 0 additions & 46 deletions
This file was deleted.

examples/node/index.js

Lines changed: 0 additions & 18 deletions
This file was deleted.

examples/node/index.ts

Lines changed: 0 additions & 34 deletions
This file was deleted.

examples/node/tsconfig.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)