@devramps/sdk-typescript 0.1.0 → 0.1.2

package/README.md

@@ -1,11 +1,11 @@
-# @devramps/step-sdk
+# @devramps/@devramps/sdk-typescript
 
 SDK for building custom deployment steps for DevRamps. Create simple one-shot steps or polling steps for long-running operations, with optional approval workflows.
 
 ## Installation
 
 ```bash
-npm install @devramps/step-sdk
+npm install @devramps/sdk-typescript
 ```
 
 ## Requirements
@@ -20,7 +20,7 @@ npm install @devramps/step-sdk
 A simple step runs once and returns a result.
 
 ```typescript
-import { SimpleStep, Step, StepOutputs, StepRegistry } from "@devramps/step-sdk";
+import { SimpleStep, Step, StepOutputs, StepRegistry } from "@devramps/@devramps/sdk-typescript";
 import { z } from "zod";
 
 // Define your input schema
@@ -54,7 +54,7 @@ StepRegistry.run([DeployStep]);
 A polling step is used for long-running operations that need status checks.
 
 ```typescript
-import { PollingStep, Step, StepOutputs, StepRegistry } from "@devramps/step-sdk";
+import { PollingStep, Step, StepOutputs, StepRegistry } from "@devramps/@devramps/sdk-typescript";
 import { z } from "zod";
 
 const BuildSchema = z.object({
@@ -109,7 +109,7 @@ Steps can require approval before execution by overriding the `prepare` method.
 ### Simple Step with Approval
 
 ```typescript
-import { SimpleStep, Step, StepOutputs, ApprovalContext } from "@devramps/step-sdk";
+import { SimpleStep, Step, StepOutputs, ApprovalContext } from "@devramps/@devramps/sdk-typescript";
 import { z } from "zod";
 
 const DeleteUserSchema = z.object({
@@ -146,7 +146,7 @@ class DeleteUserStep extends SimpleStep<DeleteUserParams> {
 ### Polling Step with Approval
 
 ```typescript
-import { PollingStep, Step, StepOutputs, ApprovalContext } from "@devramps/step-sdk";
+import { PollingStep, Step, StepOutputs, ApprovalContext } from "@devramps/@devramps/sdk-typescript";
 import { z } from "zod";
 
 const ProductionDeploySchema = z.object({
@@ -202,7 +202,7 @@ class ProductionDeployStep extends PollingStep<ProductionDeployParams, DeploySta
 The SDK provides helper functions for creating step outputs:
 
 ```typescript
-import { StepOutputs } from "@devramps/step-sdk";
+import { StepOutputs } from "@devramps/@devramps/sdk-typescript";
 
 // Success with optional data
 StepOutputs.success();
@@ -247,7 +247,7 @@ The `@Step` decorator adds metadata to your step class:
 The registry handles CLI argument parsing and step execution:
 
 ```typescript
-import { StepRegistry } from "@devramps/step-sdk";
+import { StepRegistry } from "@devramps/@devramps/sdk-typescript";
 
 // Register all your steps
 StepRegistry.run([
@@ -372,7 +372,7 @@ import {
   StepOutputs,
   StepRegistry,
   ApprovalContext,
-} from "@devramps/step-sdk";
+} from "@devramps/@devramps/sdk-typescript";
 import { z } from "zod";
 
 // Schema definitions

package/dist/output/step-output.d.ts

@@ -2,275 +2,103 @@ import z from "zod";
 export declare const ApprovalContextSchema: z.ZodObject<{
     approved: z.ZodLiteral<true>;
     approverId: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    approved: true;
-    approverId: string;
-}, {
-    approved: true;
-    approverId: string;
-}>;
+}, z.core.$strip>;
 export type ApprovalContext = z.infer<typeof ApprovalContextSchema>;
 declare const FailedOutputSchema: z.ZodObject<{
     status: z.ZodLiteral<"FAILED">;
     error: z.ZodString;
     errorCode: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}>;
+}, z.core.$strip>;
 declare const SuccessOutputSchema: z.ZodObject<{
     status: z.ZodLiteral<"SUCCESS">;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-}, "strip", z.ZodTypeAny, {
-    status: "SUCCESS";
-    data?: Record<string, any> | undefined;
-}, {
-    status: "SUCCESS";
-    data?: Record<string, any> | undefined;
-}>;
+}, z.core.$strip>;
 export type FailedOutput = z.infer<typeof FailedOutputSchema>;
 export type SuccessOutput = z.infer<typeof SuccessOutputSchema>;
 declare const ApprovalRequiredOutputSchema: z.ZodObject<{
     status: z.ZodLiteral<"APPROVAL_REQUIRED">;
     approvalRequest: z.ZodObject<{
         message: z.ZodString;
-        approvers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        approvers: z.ZodOptional<z.ZodArray<z.ZodString>>;
         metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    }, {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    status: "APPROVAL_REQUIRED";
-    approvalRequest: {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    };
-}, {
-    status: "APPROVAL_REQUIRED";
-    approvalRequest: {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    };
-}>;
-export declare const PrepareOutputSchema: z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const PrepareOutputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     status: z.ZodLiteral<"APPROVAL_REQUIRED">;
     approvalRequest: z.ZodObject<{
         message: z.ZodString;
-        approvers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        approvers: z.ZodOptional<z.ZodArray<z.ZodString>>;
         metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    }, {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    status: "APPROVAL_REQUIRED";
-    approvalRequest: {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    };
-}, {
-    status: "APPROVAL_REQUIRED";
-    approvalRequest: {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    };
-}>, z.ZodObject<{
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
     status: z.ZodLiteral<"FAILED">;
     error: z.ZodString;
     errorCode: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}>]>;
+}, z.core.$strip>], "status">;
 export type ApprovalRequiredOutput = z.infer<typeof ApprovalRequiredOutputSchema>;
 export type PrepareOutput = z.infer<typeof PrepareOutputSchema>;
-export declare const RunOutputSchema: z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+export declare const RunOutputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     status: z.ZodLiteral<"SUCCESS">;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-}, "strip", z.ZodTypeAny, {
-    status: "SUCCESS";
-    data?: Record<string, any> | undefined;
-}, {
-    status: "SUCCESS";
-    data?: Record<string, any> | undefined;
-}>, z.ZodObject<{
+}, z.core.$strip>, z.ZodObject<{
     status: z.ZodLiteral<"FAILED">;
     error: z.ZodString;
     errorCode: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}>]>;
+}, z.core.$strip>], "status">;
 export type RunOutput = z.infer<typeof RunOutputSchema>;
-export declare const TriggerOutputSchema: z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+export declare const TriggerOutputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     status: z.ZodLiteral<"TRIGGERED">;
     pollingState: z.ZodRecord<z.ZodString, z.ZodAny>;
-}, "strip", z.ZodTypeAny, {
-    status: "TRIGGERED";
-    pollingState: Record<string, any>;
-}, {
-    status: "TRIGGERED";
-    pollingState: Record<string, any>;
-}>, z.ZodObject<{
+}, z.core.$strip>, z.ZodObject<{
     status: z.ZodLiteral<"FAILED">;
     error: z.ZodString;
     errorCode: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}>]>;
+}, z.core.$strip>], "status">;
 export type TriggeredOutput<TPollingState = Record<string, unknown>> = {
     status: "TRIGGERED";
     pollingState: TPollingState;
 };
 export type TriggerOutput<TPollingState = Record<string, unknown>> = TriggeredOutput<TPollingState> | FailedOutput;
-export declare const PollOutputSchema: z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+export declare const PollOutputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     status: z.ZodLiteral<"POLL_AGAIN">;
     pollingState: z.ZodRecord<z.ZodString, z.ZodAny>;
     retryAfterMs: z.ZodOptional<z.ZodNumber>;
-}, "strip", z.ZodTypeAny, {
-    status: "POLL_AGAIN";
-    pollingState: Record<string, any>;
-    retryAfterMs?: number | undefined;
-}, {
-    status: "POLL_AGAIN";
-    pollingState: Record<string, any>;
-    retryAfterMs?: number | undefined;
-}>, z.ZodObject<{
+}, z.core.$strip>, z.ZodObject<{
     status: z.ZodLiteral<"SUCCESS">;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-}, "strip", z.ZodTypeAny, {
-    status: "SUCCESS";
-    data?: Record<string, any> | undefined;
-}, {
-    status: "SUCCESS";
-    data?: Record<string, any> | undefined;
-}>, z.ZodObject<{
+}, z.core.$strip>, z.ZodObject<{
     status: z.ZodLiteral<"FAILED">;
     error: z.ZodString;
     errorCode: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}>]>;
+}, z.core.$strip>], "status">;
 export type PollAgainOutput<TPollingState = Record<string, unknown>> = {
     status: "POLL_AGAIN";
     pollingState: TPollingState;
     retryAfterMs?: number;
 };
 export type PollOutput<TPollingState = Record<string, unknown>> = PollAgainOutput<TPollingState> | SuccessOutput | FailedOutput;
-export declare const StepOutputSchema: z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+export declare const StepOutputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     status: z.ZodLiteral<"SUCCESS">;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-}, "strip", z.ZodTypeAny, {
-    status: "SUCCESS";
-    data?: Record<string, any> | undefined;
-}, {
-    status: "SUCCESS";
-    data?: Record<string, any> | undefined;
-}>, z.ZodObject<{
+}, z.core.$strip>, z.ZodObject<{
     status: z.ZodLiteral<"FAILED">;
     error: z.ZodString;
     errorCode: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}, {
-    error: string;
-    status: "FAILED";
-    errorCode?: string | undefined;
-}>, z.ZodObject<{
+}, z.core.$strip>, z.ZodObject<{
     status: z.ZodLiteral<"APPROVAL_REQUIRED">;
     approvalRequest: z.ZodObject<{
         message: z.ZodString;
-        approvers: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        approvers: z.ZodOptional<z.ZodArray<z.ZodString>>;
         metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    }, {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    status: "APPROVAL_REQUIRED";
-    approvalRequest: {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    };
-}, {
-    status: "APPROVAL_REQUIRED";
-    approvalRequest: {
-        message: string;
-        approvers?: string[] | undefined;
-        metadata?: Record<string, any> | undefined;
-    };
-}>, z.ZodObject<{
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
     status: z.ZodLiteral<"TRIGGERED">;
     pollingState: z.ZodRecord<z.ZodString, z.ZodAny>;
-}, "strip", z.ZodTypeAny, {
-    status: "TRIGGERED";
-    pollingState: Record<string, any>;
-}, {
-    status: "TRIGGERED";
-    pollingState: Record<string, any>;
-}>, z.ZodObject<{
+}, z.core.$strip>, z.ZodObject<{
     status: z.ZodLiteral<"POLL_AGAIN">;
     pollingState: z.ZodRecord<z.ZodString, z.ZodAny>;
     retryAfterMs: z.ZodOptional<z.ZodNumber>;
-}, "strip", z.ZodTypeAny, {
-    status: "POLL_AGAIN";
-    pollingState: Record<string, any>;
-    retryAfterMs?: number | undefined;
-}, {
-    status: "POLL_AGAIN";
-    pollingState: Record<string, any>;
-    retryAfterMs?: number | undefined;
-}>]>;
+}, z.core.$strip>], "status">;
 export type StepOutput = z.infer<typeof StepOutputSchema>;
 export declare const StepOutputs: {
     success(data?: Record<string, unknown>): SuccessOutput;

package/dist/registry/step-registry.d.ts

@@ -1,45 +1,17 @@
 import z from "zod";
 import type { StepClass } from "../base/base-step";
-export declare const StepRegistryInputSchema: z.ZodDiscriminatedUnion<"job", [z.ZodObject<{
+export declare const StepRegistryInputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     job: z.ZodLiteral<"EXECUTE">;
     type: z.ZodString;
     params: z.ZodRecord<z.ZodString, z.ZodAny>;
     approvalContext: z.ZodOptional<z.ZodObject<{
         approved: z.ZodLiteral<true>;
         approverId: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        approved: true;
-        approverId: string;
-    }, {
-        approved: true;
-        approverId: string;
-    }>>;
+    }, z.core.$strip>>;
     pollingState: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-}, "strip", z.ZodTypeAny, {
-    params: Record<string, any>;
-    type: string;
-    job: "EXECUTE";
-    pollingState?: Record<string, any> | undefined;
-    approvalContext?: {
-        approved: true;
-        approverId: string;
-    } | undefined;
-}, {
-    params: Record<string, any>;
-    type: string;
-    job: "EXECUTE";
-    pollingState?: Record<string, any> | undefined;
-    approvalContext?: {
-        approved: true;
-        approverId: string;
-    } | undefined;
-}>, z.ZodObject<{
+}, z.core.$strip>, z.ZodObject<{
     job: z.ZodLiteral<"SYNTHESIZE-METADATA">;
-}, "strip", z.ZodTypeAny, {
-    job: "SYNTHESIZE-METADATA";
-}, {
-    job: "SYNTHESIZE-METADATA";
-}>]>;
+}, z.core.$strip>], "job">;
 export type StepRegistryInput = z.infer<typeof StepRegistryInputSchema>;
 export declare class StepRegistry {
     private steps;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devramps/sdk-typescript",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "SDK for building custom deployment steps for DevRamps",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -51,20 +51,21 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "minimist": "^1.2.8",
-    "zod": "^3.23.8"
+    "minimist": "^1.2.8"
   },
   "peerDependencies": {
-    "typescript": ">=5.0.0"
+    "typescript": ">=5.0.0",
+    "zod": "^4.3.4"
   },
   "devDependencies": {
     "@eslint/js": "^9.17.0",
     "@types/minimist": "^1.2.5",
     "@types/node": "^22.10.0",
-    "@vitest/coverage-v8": "^2.1.0",
+    "@vitest/coverage-v8": "^4.0.16",
     "eslint": "^9.17.0",
     "typescript": "^5.7.0",
     "typescript-eslint": "^8.18.0",
-    "vitest": "^2.1.0"
+    "vitest": "^4.0.16",
+    "zod": "^4.3.4"
   }
 }