@hatchet-dev/typescript-sdk 0.1.23 → 0.1.25

package/clients/event/event-client.d.ts

@@ -2,10 +2,17 @@ import { Channel, ClientFactory } from 'nice-grpc';
 import { EventsServiceClient } from '../../protoc/events/events';
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
+export declare enum LogLevel {
+    INFO = "INFO",
+    WARN = "WARN",
+    ERROR = "ERROR",
+    DEBUG = "DEBUG"
+}
 export declare class EventClient {
     config: ClientConfig;
     client: EventsServiceClient;
     logger: Logger;
     constructor(config: ClientConfig, channel: Channel, factory: ClientFactory);
     push<T>(type: string, input: T): Promise<import("../../protoc/events/events").Event>;
+    putLog(stepRunId: string, log: string, level?: LogLevel): void;
 }

package/clients/event/event-client.js

@@ -1,12 +1,30 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventClient = void 0;
+exports.EventClient = exports.LogLevel = void 0;
 const events_1 = require("../../protoc/events/events");
 const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error"));
 const logger_1 = require("../../util/logger");
+const retrier_1 = require("../../util/retrier");
+// eslint-disable-next-line no-shadow
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["INFO"] = "INFO";
+    LogLevel["WARN"] = "WARN";
+    LogLevel["ERROR"] = "ERROR";
+    LogLevel["DEBUG"] = "DEBUG";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
 class EventClient {
     constructor(config, channel, factory) {
         this.config = config;
@@ -28,5 +46,22 @@ class EventClient {
             throw new hatchet_error_1.default(e.message);
         }
     }
+    putLog(stepRunId, log, level) {
+        const createdAt = new Date();
+        try {
+            (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () {
+                return this.client.putLog({
+                    stepRunId,
+                    createdAt,
+                    message: log,
+                    level: level || LogLevel.INFO,
+                });
+            }), this.logger);
+        }
+        catch (e) {
+            // log a warning, but this is not a fatal error
+            this.logger.warn(`Could not put log: ${e.message}`);
+        }
+    }
 }
 exports.EventClient = EventClient;

package/clients/rest/generated/Api.d.ts

@@ -1,6 +1,24 @@
-import { APIMeta, AcceptInviteRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreatePullRequestFromStepRun, CreateTenantInviteRequest, CreateTenantRequest, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, GetStepRunDiffResponse, LinkGithubRepositoryRequest, ListAPIMetaIntegration, ListAPITokensResponse, ListGithubAppInstallationsResponse, ListGithubBranchesResponse, ListGithubReposResponse, ListPullRequestsResponse, PullRequestState, RejectInviteRequest, ReplayEventRequest, RerunStepRunRequest, StepRun, Tenant, TenantInvite, TenantInviteList, TenantMemberList, TriggerWorkflowRunRequest, UpdateTenantInviteRequest, User, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, Worker, WorkerList, Workflow, WorkflowID, WorkflowList, WorkflowRun, WorkflowRunList, WorkflowVersion, WorkflowVersionDefinition } from './data-contracts';
+import { APIMeta, AcceptInviteRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreatePullRequestFromStepRun, CreateTenantInviteRequest, CreateTenantRequest, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, GetStepRunDiffResponse, LinkGithubRepositoryRequest, ListAPIMetaIntegration, ListAPITokensResponse, ListGithubAppInstallationsResponse, ListGithubBranchesResponse, ListGithubReposResponse, ListPullRequestsResponse, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, PullRequestState, RejectInviteRequest, ReplayEventRequest, RerunStepRunRequest, StepRun, Tenant, TenantInvite, TenantInviteList, TenantMemberList, TriggerWorkflowRunRequest, UpdateTenantInviteRequest, User, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, Worker, WorkerList, Workflow, WorkflowID, WorkflowList, WorkflowRun, WorkflowRunList, WorkflowVersion, WorkflowVersionDefinition } from './data-contracts';
 import { HttpClient, RequestParams } from './http-client';
 export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * @description Gets the readiness status
+     *
+     * @tags Healthcheck
+     * @name ReadinessGet
+     * @summary Get readiness
+     * @request GET:/api/ready
+     */
+    readinessGet: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Gets the liveness status
+     *
+     * @tags Healthcheck
+     * @name LivenessGet
+     * @summary Get liveness
+     * @request GET:/api/live
+     */
+    livenessGet: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * @description Gets metadata for the Hatchet instance
      *
@@ -397,6 +415,35 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     stepRunUpdateCreatePr: (stepRun: string, data: CreatePullRequestFromStepRun, params?: RequestParams) => Promise<import("axios").AxiosResponse<CreatePullRequestFromStepRun, any>>;
+    /**
+     * @description Lists log lines for a step run.
+     *
+     * @tags Log
+     * @name LogLineList
+     * @summary List log lines
+     * @request GET:/api/v1/step-runs/{step-run}/logs
+     * @secure
+     */
+    logLineList: (stepRun: string, query?: {
+        /**
+         * The number to skip
+         * @format int64
+         */
+        offset?: number;
+        /**
+         * The number to limit by
+         * @format int64
+         */
+        limit?: number;
+        /** A list of levels to filter by */
+        levels?: LogLineLevelField;
+        /** The search query to filter for */
+        search?: LogLineSearch;
+        /** What to order by */
+        orderByField?: LogLineOrderByField;
+        /** The order direction */
+        orderByDirection?: LogLineOrderByDirection;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<LogLineList, any>>;
     /**
      * @description Get the diff for a step run between the most recent run and the first run.
      *

package/clients/rest/generated/Api.js

@@ -15,6 +15,24 @@ const http_client_1 = require("./http-client");
 class Api extends http_client_1.HttpClient {
     constructor() {
         super(...arguments);
+        /**
+         * @description Gets the readiness status
+         *
+         * @tags Healthcheck
+         * @name ReadinessGet
+         * @summary Get readiness
+         * @request GET:/api/ready
+         */
+        this.readinessGet = (params = {}) => this.request(Object.assign({ path: `/api/ready`, method: 'GET' }, params));
+        /**
+         * @description Gets the liveness status
+         *
+         * @tags Healthcheck
+         * @name LivenessGet
+         * @summary Get liveness
+         * @request GET:/api/live
+         */
+        this.livenessGet = (params = {}) => this.request(Object.assign({ path: `/api/live`, method: 'GET' }, params));
         /**
          * @description Gets metadata for the Hatchet instance
          *
@@ -366,6 +384,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.stepRunUpdateCreatePr = (stepRun, data, params = {}) => this.request(Object.assign({ path: `/api/v1/step-runs/${stepRun}/create-pr`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Lists log lines for a step run.
+         *
+         * @tags Log
+         * @name LogLineList
+         * @summary List log lines
+         * @request GET:/api/v1/step-runs/{step-run}/logs
+         * @secure
+         */
+        this.logLineList = (stepRun, query, params = {}) => this.request(Object.assign({ path: `/api/v1/step-runs/${stepRun}/logs`, method: 'GET', query: query, secure: true, format: 'json' }, params));
         /**
          * @description Get the diff for a step run between the most recent run and the first run.
          *

package/clients/rest/generated/data-contracts.d.ts

@@ -597,3 +597,33 @@ export declare enum PullRequestState {
     Open = "open",
     Closed = "closed"
 }
+export interface LogLine {
+    /**
+     * The creation date of the log line.
+     * @format date-time
+     */
+    createdAt: string;
+    /** The log message. */
+    message: string;
+    /** The log metadata. */
+    metadata: object;
+}
+export declare enum LogLineLevel {
+    DEBUG = "DEBUG",
+    INFO = "INFO",
+    WARN = "WARN",
+    ERROR = "ERROR"
+}
+export interface LogLineList {
+    pagination?: PaginationResponse;
+    rows?: LogLine[];
+}
+export declare enum LogLineOrderByField {
+    CreatedAt = "createdAt"
+}
+export declare enum LogLineOrderByDirection {
+    Asc = "asc",
+    Desc = "desc"
+}
+export type LogLineSearch = string;
+export type LogLineLevelField = LogLineLevel[];

package/clients/rest/generated/data-contracts.js

@@ -10,7 +10,7 @@
  * ---------------------------------------------------------------
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PullRequestState = exports.StepRunStatus = exports.JobRunStatus = exports.WorkflowRunStatus = exports.EventOrderByDirection = exports.EventOrderByField = exports.TenantMemberRole = void 0;
+exports.LogLineOrderByDirection = exports.LogLineOrderByField = exports.LogLineLevel = exports.PullRequestState = exports.StepRunStatus = exports.JobRunStatus = exports.WorkflowRunStatus = exports.EventOrderByDirection = exports.EventOrderByField = exports.TenantMemberRole = void 0;
 var TenantMemberRole;
 (function (TenantMemberRole) {
     TenantMemberRole["OWNER"] = "OWNER";
@@ -57,3 +57,19 @@ var PullRequestState;
     PullRequestState["Open"] = "open";
     PullRequestState["Closed"] = "closed";
 })(PullRequestState || (exports.PullRequestState = PullRequestState = {}));
+var LogLineLevel;
+(function (LogLineLevel) {
+    LogLineLevel["DEBUG"] = "DEBUG";
+    LogLineLevel["INFO"] = "INFO";
+    LogLineLevel["WARN"] = "WARN";
+    LogLineLevel["ERROR"] = "ERROR";
+})(LogLineLevel || (exports.LogLineLevel = LogLineLevel = {}));
+var LogLineOrderByField;
+(function (LogLineOrderByField) {
+    LogLineOrderByField["CreatedAt"] = "createdAt";
+})(LogLineOrderByField || (exports.LogLineOrderByField = LogLineOrderByField = {}));
+var LogLineOrderByDirection;
+(function (LogLineOrderByDirection) {
+    LogLineOrderByDirection["Asc"] = "asc";
+    LogLineOrderByDirection["Desc"] = "desc";
+})(LogLineOrderByDirection || (exports.LogLineOrderByDirection = LogLineOrderByDirection = {}));

package/clients/worker/worker.js

@@ -100,7 +100,7 @@ class Worker {
     handleStartStepRun(action) {
         const { actionId } = action;
         try {
-            const context = new step_1.Context(action, this.client.dispatcher);
+            const context = new step_1.Context(action, this.client.dispatcher, this.client.event);
             this.contexts[action.stepRunId] = context;
             const step = this.action_registry[actionId];
             if (!step) {
@@ -149,7 +149,7 @@ class Worker {
     handleStartGroupKeyRun(action) {
         const { actionId } = action;
         try {
-            const context = new step_1.Context(action, this.client.dispatcher);
+            const context = new step_1.Context(action, this.client.dispatcher, this.client.event);
             const key = action.getGroupKeyRunId;
             this.contexts[key] = context;
             this.logger.debug(`Starting group key run ${key}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.1.23",
+  "version": "0.1.25",
   "description": "Background task orchestration & visibility for developers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -38,6 +38,7 @@
     "worker:playground": "npm run exec -- ./examples/playground.ts",
     "worker:retries": "npm run exec -- ./examples/retries-worker.ts",
     "worker:multi-workflow": "npm run exec -- ./examples/multi-workflow.ts",
+    "worker:logger": "npm run exec -- ./examples/logger.ts",
     "api": "npm run exec -- ./examples/api.ts",
     "prepublish": "cp package.json dist/package.json;",
     "publish:ci": "rm -rf ./dist && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks",

package/protoc/events/events.d.ts

@@ -13,6 +13,20 @@ export interface Event {
     /** when the event was generated */
     eventTimestamp: Date | undefined;
 }
+export interface PutLogRequest {
+    /** the step run id for the request */
+    stepRunId: string;
+    /** when the log line was created */
+    createdAt: Date | undefined;
+    /** the log line message */
+    message: string;
+    /** the log line level */
+    level?: string | undefined;
+    /** associated log line metadata */
+    metadata: string;
+}
+export interface PutLogResponse {
+}
 export interface PushEventRequest {
     /** the key for the event */
     key: string;
@@ -43,6 +57,22 @@ export declare const Event: {
     create(base?: DeepPartial<Event>): Event;
     fromPartial(object: DeepPartial<Event>): Event;
 };
+export declare const PutLogRequest: {
+    encode(message: PutLogRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PutLogRequest;
+    fromJSON(object: any): PutLogRequest;
+    toJSON(message: PutLogRequest): unknown;
+    create(base?: DeepPartial<PutLogRequest>): PutLogRequest;
+    fromPartial(object: DeepPartial<PutLogRequest>): PutLogRequest;
+};
+export declare const PutLogResponse: {
+    encode(_: PutLogResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PutLogResponse;
+    fromJSON(_: any): PutLogResponse;
+    toJSON(_: PutLogResponse): unknown;
+    create(base?: DeepPartial<PutLogResponse>): PutLogResponse;
+    fromPartial(_: DeepPartial<PutLogResponse>): PutLogResponse;
+};
 export declare const PushEventRequest: {
     encode(message: PushEventRequest, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): PushEventRequest;
@@ -146,17 +176,41 @@ export declare const EventsServiceDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly putLog: {
+            readonly name: "PutLog";
+            readonly requestType: {
+                encode(message: PutLogRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): PutLogRequest;
+                fromJSON(object: any): PutLogRequest;
+                toJSON(message: PutLogRequest): unknown;
+                create(base?: DeepPartial<PutLogRequest>): PutLogRequest;
+                fromPartial(object: DeepPartial<PutLogRequest>): PutLogRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(_: PutLogResponse, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): PutLogResponse;
+                fromJSON(_: any): PutLogResponse;
+                toJSON(_: PutLogResponse): unknown;
+                create(base?: DeepPartial<PutLogResponse>): PutLogResponse;
+                fromPartial(_: DeepPartial<PutLogResponse>): PutLogResponse;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
     };
 };
 export interface EventsServiceImplementation<CallContextExt = {}> {
     push(request: PushEventRequest, context: CallContext & CallContextExt): Promise<DeepPartial<Event>>;
     list(request: ListEventRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ListEventResponse>>;
     replaySingleEvent(request: ReplayEventRequest, context: CallContext & CallContextExt): Promise<DeepPartial<Event>>;
+    putLog(request: PutLogRequest, context: CallContext & CallContextExt): Promise<DeepPartial<PutLogResponse>>;
 }
 export interface EventsServiceClient<CallOptionsExt = {}> {
     push(request: DeepPartial<PushEventRequest>, options?: CallOptions & CallOptionsExt): Promise<Event>;
     list(request: DeepPartial<ListEventRequest>, options?: CallOptions & CallOptionsExt): Promise<ListEventResponse>;
     replaySingleEvent(request: DeepPartial<ReplayEventRequest>, options?: CallOptions & CallOptionsExt): Promise<Event>;
+    putLog(request: DeepPartial<PutLogRequest>, options?: CallOptions & CallOptionsExt): Promise<PutLogResponse>;
 }
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {

package/protoc/events/events.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventsServiceDefinition = exports.ReplayEventRequest = exports.ListEventResponse = exports.ListEventRequest = exports.PushEventRequest = exports.Event = exports.protobufPackage = void 0;
+exports.EventsServiceDefinition = exports.ReplayEventRequest = exports.ListEventResponse = exports.ListEventRequest = exports.PushEventRequest = exports.PutLogResponse = exports.PutLogRequest = exports.Event = exports.protobufPackage = void 0;
 const _m0 = __importStar(require("protobufjs/minimal"));
 const timestamp_1 = require("../google/protobuf/timestamp");
 exports.protobufPackage = "";
@@ -136,6 +136,152 @@ exports.Event = {
         return message;
     },
 };
+function createBasePutLogRequest() {
+    return { stepRunId: "", createdAt: undefined, message: "", level: undefined, metadata: "" };
+}
+exports.PutLogRequest = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.stepRunId !== "") {
+            writer.uint32(10).string(message.stepRunId);
+        }
+        if (message.createdAt !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.createdAt), writer.uint32(18).fork()).ldelim();
+        }
+        if (message.message !== "") {
+            writer.uint32(26).string(message.message);
+        }
+        if (message.level !== undefined) {
+            writer.uint32(34).string(message.level);
+        }
+        if (message.metadata !== "") {
+            writer.uint32(42).string(message.metadata);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBasePutLogRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.stepRunId = reader.string();
+                    continue;
+                case 2:
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.createdAt = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                case 3:
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.message = reader.string();
+                    continue;
+                case 4:
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.level = reader.string();
+                    continue;
+                case 5:
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.metadata = reader.string();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            stepRunId: isSet(object.stepRunId) ? globalThis.String(object.stepRunId) : "",
+            createdAt: isSet(object.createdAt) ? fromJsonTimestamp(object.createdAt) : undefined,
+            message: isSet(object.message) ? globalThis.String(object.message) : "",
+            level: isSet(object.level) ? globalThis.String(object.level) : undefined,
+            metadata: isSet(object.metadata) ? globalThis.String(object.metadata) : "",
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.stepRunId !== "") {
+            obj.stepRunId = message.stepRunId;
+        }
+        if (message.createdAt !== undefined) {
+            obj.createdAt = message.createdAt.toISOString();
+        }
+        if (message.message !== "") {
+            obj.message = message.message;
+        }
+        if (message.level !== undefined) {
+            obj.level = message.level;
+        }
+        if (message.metadata !== "") {
+            obj.metadata = message.metadata;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.PutLogRequest.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b, _c, _d, _e;
+        const message = createBasePutLogRequest();
+        message.stepRunId = (_a = object.stepRunId) !== null && _a !== void 0 ? _a : "";
+        message.createdAt = (_b = object.createdAt) !== null && _b !== void 0 ? _b : undefined;
+        message.message = (_c = object.message) !== null && _c !== void 0 ? _c : "";
+        message.level = (_d = object.level) !== null && _d !== void 0 ? _d : undefined;
+        message.metadata = (_e = object.metadata) !== null && _e !== void 0 ? _e : "";
+        return message;
+    },
+};
+function createBasePutLogResponse() {
+    return {};
+}
+exports.PutLogResponse = {
+    encode(_, writer = _m0.Writer.create()) {
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBasePutLogResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(_) {
+        return {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.PutLogResponse.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(_) {
+        const message = createBasePutLogResponse();
+        return message;
+    },
+};
 function createBasePushEventRequest() {
     return { key: "", payload: "", eventTimestamp: undefined };
 }
@@ -415,6 +561,14 @@ exports.EventsServiceDefinition = {
             responseStream: false,
             options: {},
         },
+        putLog: {
+            name: "PutLog",
+            requestType: exports.PutLogRequest,
+            requestStream: false,
+            responseType: exports.PutLogResponse,
+            responseStream: false,
+            options: {},
+        },
     },
 };
 function toTimestamp(date) {

package/step.d.ts

@@ -1,6 +1,8 @@
 import * as z from 'zod';
 import { Action } from './clients/dispatcher/action-listener';
 import { DispatcherClient } from './clients/dispatcher/dispatcher-client';
+import { EventClient, LogLevel } from './clients/event/event-client';
+import { Logger } from './util/logger';
 export declare const CreateStepSchema: z.ZodObject<{
     name: z.ZodString;
     parents: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -33,8 +35,10 @@ export declare class Context<T, K> {
     controller: AbortController;
     action: Action;
     client: DispatcherClient;
+    eventClient: EventClient;
     overridesData: Record<string, any>;
-    constructor(action: Action, client: DispatcherClient);
+    logger: Logger;
+    constructor(action: Action, client: DispatcherClient, eventClient: EventClient);
     stepOutput(step: string): NextStep;
     triggeredByEvent(): boolean;
     workflowInput(): T;
@@ -42,6 +46,7 @@ export declare class Context<T, K> {
     stepName(): string;
     workflowRunId(): string;
     playground(name: string, defaultValue?: string): string;
+    log(message: string, level?: LogLevel): void;
 }
 export type StepRunFunction<T, K> = (ctx: Context<T, K>) => Promise<NextStep> | NextStep | void;
 export interface CreateStep<T, K> extends z.infer<typeof CreateStepSchema> {

package/step.js

@@ -30,6 +30,8 @@ exports.Context = exports.CreateStepSchema = void 0;
 const hatchet_error_1 = __importDefault(require("./util/errors/hatchet-error"));
 const z = __importStar(require("zod"));
 const workflow_1 = require("./workflow");
+const logger_1 = require("./util/logger");
+const parse_1 = require("./util/parse");
 exports.CreateStepSchema = z.object({
     name: z.string(),
     parents: z.array(z.string()).optional(),
@@ -37,14 +39,16 @@ exports.CreateStepSchema = z.object({
     retries: z.number().optional(),
 });
 class Context {
-    constructor(action, client) {
+    constructor(action, client, eventClient) {
         this.controller = new AbortController();
         this.overridesData = {};
         try {
-            const data = JSON.parse(JSON.parse(action.actionPayload));
+            const data = (0, parse_1.parseJSON)(action.actionPayload);
             this.data = data;
             this.action = action;
             this.client = client;
+            this.eventClient = eventClient;
+            this.logger = new logger_1.Logger(`Context Logger`, client.config.log_level);
             // if this is a getGroupKeyRunId, the data is the workflow input
             if (action.getGroupKeyRunId !== '') {
                 this.input = data;
@@ -95,5 +99,14 @@ class Context {
         });
         return defaultValue;
     }
+    log(message, level) {
+        const { stepRunId } = this.action;
+        if (!stepRunId) {
+            // log a warning
+            this.logger.warn('cannot log from context without stepRunId');
+            return;
+        }
+        this.eventClient.putLog(stepRunId, message, level);
+    }
 }
 exports.Context = Context;

package/util/parse.d.ts

@@ -0,0 +1 @@
+export declare function parseJSON(json: string): any;

package/util/parse.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseJSON = void 0;
+function parseJSON(json) {
+    try {
+        const firstParse = JSON.parse(json);
+        // Hatchet engine versions <=0.14.0 return JSON as a quoted string which needs to be parsed again.
+        // This is a workaround for that issue, but will not be needed in future versions.
+        try {
+            return JSON.parse(firstParse);
+        }
+        catch (e) {
+            return firstParse;
+        }
+    }
+    catch (e) {
+        throw new Error(`Could not parse JSON: ${e.message}`);
+    }
+}
+exports.parseJSON = parseJSON;