@serverlessworkflow/sdk 1.0.0-alpha5.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/esm/index.esm.js +2040 -1121
- package/esm/index.esm.js.map +1 -1
- package/esm/index.esm.min.js +7 -7
- package/esm/index.esm.min.js.map +1 -1
- package/lib/generated/builders/any-event-consumption-strategy-until-builder.d.ts +14 -0
- package/lib/generated/builders/any-event-consumption-strategy-until-builder.d.ts.map +1 -0
- package/lib/generated/builders/any-event-until-consumed-builder.d.ts +14 -0
- package/lib/generated/builders/any-event-until-consumed-builder.d.ts.map +1 -0
- package/lib/generated/builders/container-lifetime-builder.d.ts +14 -0
- package/lib/generated/builders/container-lifetime-builder.d.ts.map +1 -0
- package/lib/generated/builders/error-filter-builder.d.ts +14 -0
- package/lib/generated/builders/error-filter-builder.d.ts.map +1 -0
- package/lib/generated/builders/event-data-builder.d.ts +14 -0
- package/lib/generated/builders/event-data-builder.d.ts.map +1 -0
- package/lib/generated/builders/http-body-builder.d.ts +14 -0
- package/lib/generated/builders/http-body-builder.d.ts.map +1 -0
- package/lib/generated/builders/http-headers-builder.d.ts +14 -0
- package/lib/generated/builders/http-headers-builder.d.ts.map +1 -0
- package/lib/generated/builders/http-query-builder.d.ts +14 -0
- package/lib/generated/builders/http-query-builder.d.ts.map +1 -0
- package/lib/generated/builders/index.d.ts +11 -6
- package/lib/generated/builders/index.d.ts.map +1 -1
- package/lib/generated/builders/raise-task-error-builder.d.ts +14 -0
- package/lib/generated/builders/raise-task-error-builder.d.ts.map +1 -0
- package/lib/generated/builders/subscription-iterator-builder.d.ts +14 -0
- package/lib/generated/builders/subscription-iterator-builder.d.ts.map +1 -0
- package/lib/generated/builders/task-timeout-builder.d.ts +14 -0
- package/lib/generated/builders/task-timeout-builder.d.ts.map +1 -0
- package/lib/generated/classes/any-event-consumption-strategy-until.d.ts +39 -0
- package/lib/generated/classes/any-event-consumption-strategy-until.d.ts.map +1 -0
- package/lib/generated/classes/any-event-consumption-strategy.d.ts.map +1 -1
- package/lib/generated/classes/any-event-until-consumed.d.ts +39 -0
- package/lib/generated/classes/any-event-until-consumed.d.ts.map +1 -0
- package/lib/generated/classes/async-api-arguments.d.ts +5 -0
- package/lib/generated/classes/async-api-arguments.d.ts.map +1 -1
- package/lib/generated/classes/call-async-api.d.ts.map +1 -1
- package/lib/generated/classes/catch-errors.d.ts +0 -5
- package/lib/generated/classes/catch-errors.d.ts.map +1 -1
- package/lib/generated/classes/container-lifetime.d.ts +39 -0
- package/lib/generated/classes/container-lifetime.d.ts.map +1 -0
- package/lib/generated/classes/container.d.ts.map +1 -1
- package/lib/generated/classes/error-filter.d.ts +44 -0
- package/lib/generated/classes/error-filter.d.ts.map +1 -0
- package/lib/generated/classes/event-consumption-strategy.d.ts.map +1 -1
- package/lib/generated/classes/event-data.d.ts +44 -0
- package/lib/generated/classes/event-data.d.ts.map +1 -0
- package/lib/generated/classes/http-body.d.ts +44 -0
- package/lib/generated/classes/http-body.d.ts.map +1 -0
- package/lib/generated/classes/http-headers.d.ts +44 -0
- package/lib/generated/classes/http-headers.d.ts.map +1 -0
- package/lib/generated/classes/http-query.d.ts +44 -0
- package/lib/generated/classes/http-query.d.ts.map +1 -0
- package/lib/generated/classes/index.d.ts +11 -6
- package/lib/generated/classes/index.d.ts.map +1 -1
- package/lib/generated/classes/listen-task.d.ts.map +1 -1
- package/lib/generated/classes/raise-task-error.d.ts +44 -0
- package/lib/generated/classes/raise-task-error.d.ts.map +1 -0
- package/lib/generated/classes/subscription-iterator.d.ts +39 -0
- package/lib/generated/classes/subscription-iterator.d.ts.map +1 -0
- package/lib/generated/classes/task-timeout.d.ts +39 -0
- package/lib/generated/classes/task-timeout.d.ts.map +1 -0
- package/lib/generated/classes/task.d.ts.map +1 -1
- package/lib/generated/definitions/specification.d.ts +105 -44
- package/lib/generated/definitions/specification.d.ts.map +1 -1
- package/lib/generated/validation/validation-pointers.d.ts +11 -6
- package/lib/generated/validation/validation-pointers.d.ts.map +1 -1
- package/package.json +2 -2
- package/systemjs/index.systemjs.js +2039 -1120
- package/systemjs/index.systemjs.js.map +1 -1
- package/systemjs/index.systemjs.min.js +4 -4
- package/systemjs/index.systemjs.min.js.map +1 -1
- package/umd/index.umd.js +2050 -1126
- package/umd/index.umd.js.map +1 -1
- package/umd/index.umd.min.js +4 -4
- package/umd/index.umd.min.js.map +1 -1
- package/lib/generated/builders/raise-task-raise-error-builder.d.ts +0 -14
- package/lib/generated/builders/raise-task-raise-error-builder.d.ts.map +0 -1
- package/lib/generated/builders/task-base-timeout-builder.d.ts +0 -14
- package/lib/generated/builders/task-base-timeout-builder.d.ts.map +0 -1
- package/lib/generated/builders/with-async-api-payload-builder.d.ts +0 -14
- package/lib/generated/builders/with-async-api-payload-builder.d.ts.map +0 -1
- package/lib/generated/builders/with-http-body-builder.d.ts +0 -14
- package/lib/generated/builders/with-http-body-builder.d.ts.map +0 -1
- package/lib/generated/builders/with-http-headers-builder.d.ts +0 -14
- package/lib/generated/builders/with-http-headers-builder.d.ts.map +0 -1
- package/lib/generated/builders/with-http-query-builder.d.ts +0 -14
- package/lib/generated/builders/with-http-query-builder.d.ts.map +0 -1
- package/lib/generated/classes/raise-task-raise-error.d.ts +0 -44
- package/lib/generated/classes/raise-task-raise-error.d.ts.map +0 -1
- package/lib/generated/classes/task-base-timeout.d.ts +0 -39
- package/lib/generated/classes/task-base-timeout.d.ts.map +0 -1
- package/lib/generated/classes/with-async-api-payload.d.ts +0 -44
- package/lib/generated/classes/with-async-api-payload.d.ts.map +0 -1
- package/lib/generated/classes/with-http-body.d.ts +0 -44
- package/lib/generated/classes/with-http-body.d.ts.map +0 -1
- package/lib/generated/classes/with-http-headers.d.ts +0 -44
- package/lib/generated/classes/with-http-headers.d.ts.map +0 -1
- package/lib/generated/classes/with-http-query.d.ts +0 -44
- package/lib/generated/classes/with-http-query.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ The npm [`@serverlessworkflow/sdk`](https://www.npmjs.com/package/@serverlesswor
|
|
|
14
14
|
|
|
15
15
|
| Latest Releases | Conformance to Spec Version |
|
|
16
16
|
| :---: | :---: |
|
|
17
|
-
| [v1.0.0
|
|
17
|
+
| [v1.0.0.\*](https://github.com/serverlessworkflow/sdk-typescript/releases/) | [v1.0.0](https://github.com/serverlessworkflow/specification) |
|
|
18
18
|
|
|
19
19
|
> [!WARNING]
|
|
20
20
|
> Previous versions of the SDK were published with a typo in the scope:
|
|
@@ -60,7 +60,7 @@ The `validate` function is directly exported and can be used as `validate('Workf
|
|
|
60
60
|
|
|
61
61
|
### Installation
|
|
62
62
|
> [!NOTE]
|
|
63
|
-
> Version v1.0.0
|
|
63
|
+
> Version v1.0.0.\* has not been released yet.
|
|
64
64
|
|
|
65
65
|
```sh
|
|
66
66
|
npm install @serverlessworkflow/sdk
|
|
@@ -77,7 +77,7 @@ import { Classes } from '@serverlessworkflow/sdk';
|
|
|
77
77
|
// const text = await fetch('https://myserver.com/my-workflow-definition.json');
|
|
78
78
|
const text = `
|
|
79
79
|
document:
|
|
80
|
-
dsl: 1.0.0
|
|
80
|
+
dsl: 1.0.0
|
|
81
81
|
name: test
|
|
82
82
|
version: 1.0.0
|
|
83
83
|
namespace: default
|
|
@@ -98,7 +98,7 @@ import { Classes, Specification, validate } from '@serverlessworkflow/sdk';
|
|
|
98
98
|
// Simply cast an object:
|
|
99
99
|
const workflowDefinition = {
|
|
100
100
|
document: {
|
|
101
|
-
dsl: '1.0.0
|
|
101
|
+
dsl: '1.0.0',
|
|
102
102
|
name: 'test',
|
|
103
103
|
version: '1.0.0',
|
|
104
104
|
namespace: 'default',
|
|
@@ -134,7 +134,7 @@ import { Classes, validate } from '@serverlessworkflow/sdk';
|
|
|
134
134
|
// Simply use the constructor
|
|
135
135
|
const workflowDefinition = new Classes.Workflow({
|
|
136
136
|
document: {
|
|
137
|
-
dsl: '1.0.0
|
|
137
|
+
dsl: '1.0.0',
|
|
138
138
|
name: 'test',
|
|
139
139
|
version: '1.0.0',
|
|
140
140
|
namespace: 'default',
|
|
@@ -177,7 +177,7 @@ import { documentBuilder, setTaskBuilder, taskListBuilder, workflowBuilder } fro
|
|
|
177
177
|
const workflowDefinition = workflowBuilder(/*workflowDefinitionObject*/)
|
|
178
178
|
.document(
|
|
179
179
|
documentBuilder()
|
|
180
|
-
.dsl('1.0.0
|
|
180
|
+
.dsl('1.0.0')
|
|
181
181
|
.name('test')
|
|
182
182
|
.version('1.0.0')
|
|
183
183
|
.namespace('default')
|