Skip to content

Commit

Permalink
v1.0.0-alpha rewrite
Browse files Browse the repository at this point in the history
- changed organisation and package name
- updated maintainers
- removed previous code items
- updated tools

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>
  • Loading branch information
JBBianchi committed Jul 24, 2024
1 parent af7a343 commit 2ea82dd
Show file tree
Hide file tree
Showing 177 changed files with 6,227 additions and 26,113 deletions.
11 changes: 9 additions & 2 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Serverless Workflow Typescript SDK Maintainers
# Serverless Workflow Org Maintainers

* [Jean-Baptiste Bianchi](https://github.com/JBBianchi)
* [Charles d'Avernas](https://github.com/cdavernas)
* [Ricardo Zanini](https://github.com/ricardozanini)

# Serverless Workflow Org Emeritus Maintainers
* [Antonio Mendoza Pérez](https://github.com/antmendoza)
* [Tihomir Surdilovic](https://github.com/tsurdilo)

# Maintainers Mailing list
[cncf-serverlessws-maintainers](mailto:[email protected])
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![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)
![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)

# Serverless Workflow Specification - Typescript SDK

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

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



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

```sh
git clone https://github.com/serverlessworkflow/sdk-typescript.git
git clone https://github.com/serverless-workflow/sdk.git
cd sdk-typescript
npm install && npm run build && npm run test
```
Expand All @@ -41,7 +41,7 @@ npm install && npm run build && npm run test
##### Version >= 4.0.0
Note: Version 4.0.0 has not been released yet.
```sh
npm i @serverlessworkflow/sdk-typescript
npm i @serverless-workflow/sdk
```


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

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

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

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

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

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

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

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

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

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

const injectionState: Specification.Injectstate = workflow.states[0];
const injectionStateValidator: ValidateFunction<Specification.Injectstate> = validators.get('Injectstate');
Expand Down
40 changes: 0 additions & 40 deletions examples/browser/index.html

This file was deleted.

46 changes: 0 additions & 46 deletions examples/browser/mermaid.html

This file was deleted.

18 changes: 0 additions & 18 deletions examples/node/index.js

This file was deleted.

34 changes: 0 additions & 34 deletions examples/node/index.ts

This file was deleted.

3 changes: 0 additions & 3 deletions examples/node/tsconfig.json

This file was deleted.

Loading

0 comments on commit 2ea82dd

Please sign in to comment.