@devramps/sdk-typescript 0.1.0 → 0.1.1
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 +9 -9
- package/package.json +5 -4
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
# @devramps/
|
|
1
|
+
# @devramps/@devramps/sdk-typescript
|
|
2
2
|
|
|
3
3
|
SDK for building custom deployment steps for DevRamps. Create simple one-shot steps or polling steps for long-running operations, with optional approval workflows.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @devramps/
|
|
8
|
+
npm install @devramps/sdk-typescript
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Requirements
|
|
@@ -20,7 +20,7 @@ npm install @devramps/step-sdk
|
|
|
20
20
|
A simple step runs once and returns a result.
|
|
21
21
|
|
|
22
22
|
```typescript
|
|
23
|
-
import { SimpleStep, Step, StepOutputs, StepRegistry } from "@devramps/
|
|
23
|
+
import { SimpleStep, Step, StepOutputs, StepRegistry } from "@devramps/@devramps/sdk-typescript";
|
|
24
24
|
import { z } from "zod";
|
|
25
25
|
|
|
26
26
|
// Define your input schema
|
|
@@ -54,7 +54,7 @@ StepRegistry.run([DeployStep]);
|
|
|
54
54
|
A polling step is used for long-running operations that need status checks.
|
|
55
55
|
|
|
56
56
|
```typescript
|
|
57
|
-
import { PollingStep, Step, StepOutputs, StepRegistry } from "@devramps/
|
|
57
|
+
import { PollingStep, Step, StepOutputs, StepRegistry } from "@devramps/@devramps/sdk-typescript";
|
|
58
58
|
import { z } from "zod";
|
|
59
59
|
|
|
60
60
|
const BuildSchema = z.object({
|
|
@@ -109,7 +109,7 @@ Steps can require approval before execution by overriding the `prepare` method.
|
|
|
109
109
|
### Simple Step with Approval
|
|
110
110
|
|
|
111
111
|
```typescript
|
|
112
|
-
import { SimpleStep, Step, StepOutputs, ApprovalContext } from "@devramps/
|
|
112
|
+
import { SimpleStep, Step, StepOutputs, ApprovalContext } from "@devramps/@devramps/sdk-typescript";
|
|
113
113
|
import { z } from "zod";
|
|
114
114
|
|
|
115
115
|
const DeleteUserSchema = z.object({
|
|
@@ -146,7 +146,7 @@ class DeleteUserStep extends SimpleStep<DeleteUserParams> {
|
|
|
146
146
|
### Polling Step with Approval
|
|
147
147
|
|
|
148
148
|
```typescript
|
|
149
|
-
import { PollingStep, Step, StepOutputs, ApprovalContext } from "@devramps/
|
|
149
|
+
import { PollingStep, Step, StepOutputs, ApprovalContext } from "@devramps/@devramps/sdk-typescript";
|
|
150
150
|
import { z } from "zod";
|
|
151
151
|
|
|
152
152
|
const ProductionDeploySchema = z.object({
|
|
@@ -202,7 +202,7 @@ class ProductionDeployStep extends PollingStep<ProductionDeployParams, DeploySta
|
|
|
202
202
|
The SDK provides helper functions for creating step outputs:
|
|
203
203
|
|
|
204
204
|
```typescript
|
|
205
|
-
import { StepOutputs } from "@devramps/
|
|
205
|
+
import { StepOutputs } from "@devramps/@devramps/sdk-typescript";
|
|
206
206
|
|
|
207
207
|
// Success with optional data
|
|
208
208
|
StepOutputs.success();
|
|
@@ -247,7 +247,7 @@ The `@Step` decorator adds metadata to your step class:
|
|
|
247
247
|
The registry handles CLI argument parsing and step execution:
|
|
248
248
|
|
|
249
249
|
```typescript
|
|
250
|
-
import { StepRegistry } from "@devramps/
|
|
250
|
+
import { StepRegistry } from "@devramps/@devramps/sdk-typescript";
|
|
251
251
|
|
|
252
252
|
// Register all your steps
|
|
253
253
|
StepRegistry.run([
|
|
@@ -372,7 +372,7 @@ import {
|
|
|
372
372
|
StepOutputs,
|
|
373
373
|
StepRegistry,
|
|
374
374
|
ApprovalContext,
|
|
375
|
-
} from "@devramps/
|
|
375
|
+
} from "@devramps/@devramps/sdk-typescript";
|
|
376
376
|
import { z } from "zod";
|
|
377
377
|
|
|
378
378
|
// Schema definitions
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@devramps/sdk-typescript",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "SDK for building custom deployment steps for DevRamps",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.js",
|
|
@@ -51,15 +51,16 @@
|
|
|
51
51
|
"node": ">=18.0.0"
|
|
52
52
|
},
|
|
53
53
|
"dependencies": {
|
|
54
|
-
"minimist": "^1.2.8"
|
|
55
|
-
"zod": "^3.23.8"
|
|
54
|
+
"minimist": "^1.2.8"
|
|
56
55
|
},
|
|
57
56
|
"peerDependencies": {
|
|
58
|
-
"typescript": ">=5.0.0"
|
|
57
|
+
"typescript": ">=5.0.0",
|
|
58
|
+
"zod": "^3.0.0"
|
|
59
59
|
},
|
|
60
60
|
"devDependencies": {
|
|
61
61
|
"@eslint/js": "^9.17.0",
|
|
62
62
|
"@types/minimist": "^1.2.5",
|
|
63
|
+
"zod": "^3.23.8",
|
|
63
64
|
"@types/node": "^22.10.0",
|
|
64
65
|
"@vitest/coverage-v8": "^2.1.0",
|
|
65
66
|
"eslint": "^9.17.0",
|