@hatchet-dev/typescript-sdk 0.2.1 → 0.3.0

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

@@ -15,4 +15,5 @@ export declare class EventClient {
     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;
+    putStream(stepRunId: string, data: string | Uint8Array): void;
 }

package/clients/event/event-client.js

@@ -65,5 +65,31 @@ class EventClient {
             this.logger.warn(`Could not put log: ${e.message}`);
         }
     }
+    putStream(stepRunId, data) {
+        const createdAt = new Date();
+        let dataBytes;
+        if (typeof data === 'string') {
+            dataBytes = new TextEncoder().encode(data);
+        }
+        else if (data instanceof Uint8Array) {
+            dataBytes = data;
+        }
+        else {
+            throw new Error('Invalid data type. Expected string or Uint8Array.');
+        }
+        try {
+            (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () {
+                return this.client.putStreamEvent({
+                    stepRunId,
+                    createdAt,
+                    message: dataBytes,
+                });
+            }), 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/listener/listener-client.d.ts

@@ -11,6 +11,7 @@ export declare enum RunEventType {
     STEP_RUN_EVENT_TYPE_FAILED = "STEP_RUN_EVENT_TYPE_FAILED",
     STEP_RUN_EVENT_TYPE_CANCELLED = "STEP_RUN_EVENT_TYPE_CANCELLED",
     STEP_RUN_EVENT_TYPE_TIMED_OUT = "STEP_RUN_EVENT_TYPE_TIMED_OUT",
+    STEP_RUN_EVENT_TYPE_STREAM = "STEP_RUN_EVENT_TYPE_STREAM",
     WORKFLOW_RUN_EVENT_TYPE_STARTED = "WORKFLOW_RUN_EVENT_TYPE_STARTED",
     WORKFLOW_RUN_EVENT_TYPE_COMPLETED = "WORKFLOW_RUN_EVENT_TYPE_COMPLETED",
     WORKFLOW_RUN_EVENT_TYPE_FAILED = "WORKFLOW_RUN_EVENT_TYPE_FAILED",

package/clients/listener/listener-client.js

@@ -52,6 +52,7 @@ var RunEventType;
     RunEventType["STEP_RUN_EVENT_TYPE_FAILED"] = "STEP_RUN_EVENT_TYPE_FAILED";
     RunEventType["STEP_RUN_EVENT_TYPE_CANCELLED"] = "STEP_RUN_EVENT_TYPE_CANCELLED";
     RunEventType["STEP_RUN_EVENT_TYPE_TIMED_OUT"] = "STEP_RUN_EVENT_TYPE_TIMED_OUT";
+    RunEventType["STEP_RUN_EVENT_TYPE_STREAM"] = "STEP_RUN_EVENT_TYPE_STREAM";
     RunEventType["WORKFLOW_RUN_EVENT_TYPE_STARTED"] = "WORKFLOW_RUN_EVENT_TYPE_STARTED";
     RunEventType["WORKFLOW_RUN_EVENT_TYPE_COMPLETED"] = "WORKFLOW_RUN_EVENT_TYPE_COMPLETED";
     RunEventType["WORKFLOW_RUN_EVENT_TYPE_FAILED"] = "WORKFLOW_RUN_EVENT_TYPE_FAILED";
@@ -64,6 +65,7 @@ const stepEventTypeMap = {
     [dispatcher_1.ResourceEventType.RESOURCE_EVENT_TYPE_FAILED]: RunEventType.STEP_RUN_EVENT_TYPE_FAILED,
     [dispatcher_1.ResourceEventType.RESOURCE_EVENT_TYPE_CANCELLED]: RunEventType.STEP_RUN_EVENT_TYPE_CANCELLED,
     [dispatcher_1.ResourceEventType.RESOURCE_EVENT_TYPE_TIMED_OUT]: RunEventType.STEP_RUN_EVENT_TYPE_TIMED_OUT,
+    [dispatcher_1.ResourceEventType.RESOURCE_EVENT_TYPE_STREAM]: RunEventType.STEP_RUN_EVENT_TYPE_STREAM,
     [dispatcher_1.ResourceEventType.RESOURCE_EVENT_TYPE_UNKNOWN]: undefined,
     [dispatcher_1.ResourceEventType.UNRECOGNIZED]: undefined,
 };
@@ -74,6 +76,7 @@ const workflowEventTypeMap = {
     [dispatcher_1.ResourceEventType.RESOURCE_EVENT_TYPE_CANCELLED]: RunEventType.WORKFLOW_RUN_EVENT_TYPE_CANCELLED,
     [dispatcher_1.ResourceEventType.RESOURCE_EVENT_TYPE_TIMED_OUT]: RunEventType.WORKFLOW_RUN_EVENT_TYPE_TIMED_OUT,
     [dispatcher_1.ResourceEventType.RESOURCE_EVENT_TYPE_UNKNOWN]: undefined,
+    [dispatcher_1.ResourceEventType.RESOURCE_EVENT_TYPE_STREAM]: undefined,
     [dispatcher_1.ResourceEventType.UNRECOGNIZED]: undefined,
 };
 const resourceTypeMap = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [

package/protoc/dispatcher/dispatcher.d.ts

@@ -42,6 +42,7 @@ export declare enum ResourceEventType {
     RESOURCE_EVENT_TYPE_FAILED = 3,
     RESOURCE_EVENT_TYPE_CANCELLED = 4,
     RESOURCE_EVENT_TYPE_TIMED_OUT = 5,
+    RESOURCE_EVENT_TYPE_STREAM = 6,
     UNRECOGNIZED = -1
 }
 export declare function resourceEventTypeFromJSON(object: any): ResourceEventType;

package/protoc/dispatcher/dispatcher.js

@@ -203,6 +203,7 @@ var ResourceEventType;
     ResourceEventType[ResourceEventType["RESOURCE_EVENT_TYPE_FAILED"] = 3] = "RESOURCE_EVENT_TYPE_FAILED";
     ResourceEventType[ResourceEventType["RESOURCE_EVENT_TYPE_CANCELLED"] = 4] = "RESOURCE_EVENT_TYPE_CANCELLED";
     ResourceEventType[ResourceEventType["RESOURCE_EVENT_TYPE_TIMED_OUT"] = 5] = "RESOURCE_EVENT_TYPE_TIMED_OUT";
+    ResourceEventType[ResourceEventType["RESOURCE_EVENT_TYPE_STREAM"] = 6] = "RESOURCE_EVENT_TYPE_STREAM";
     ResourceEventType[ResourceEventType["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
 })(ResourceEventType || (exports.ResourceEventType = ResourceEventType = {}));
 function resourceEventTypeFromJSON(object) {
@@ -225,6 +226,9 @@ function resourceEventTypeFromJSON(object) {
         case 5:
         case 'RESOURCE_EVENT_TYPE_TIMED_OUT':
             return ResourceEventType.RESOURCE_EVENT_TYPE_TIMED_OUT;
+        case 6:
+        case 'RESOURCE_EVENT_TYPE_STREAM':
+            return ResourceEventType.RESOURCE_EVENT_TYPE_STREAM;
         case -1:
         case 'UNRECOGNIZED':
         default:
@@ -246,6 +250,8 @@ function resourceEventTypeToJSON(object) {
             return 'RESOURCE_EVENT_TYPE_CANCELLED';
         case ResourceEventType.RESOURCE_EVENT_TYPE_TIMED_OUT:
             return 'RESOURCE_EVENT_TYPE_TIMED_OUT';
+        case ResourceEventType.RESOURCE_EVENT_TYPE_STREAM:
+            return 'RESOURCE_EVENT_TYPE_STREAM';
         case ResourceEventType.UNRECOGNIZED:
         default:
             return 'UNRECOGNIZED';

package/protoc/events/events.d.ts

@@ -27,6 +27,18 @@ export interface PutLogRequest {
 }
 export interface PutLogResponse {
 }
+export interface PutStreamEventRequest {
+    /** the step run id for the request */
+    stepRunId: string;
+    /** when the stream event was created */
+    createdAt: Date | undefined;
+    /** the stream event message */
+    message: Uint8Array;
+    /** associated stream event metadata */
+    metadata: string;
+}
+export interface PutStreamEventResponse {
+}
 export interface PushEventRequest {
     /** the key for the event */
     key: string;
@@ -63,6 +75,22 @@ export declare const PutLogResponse: {
     create(base?: DeepPartial<PutLogResponse>): PutLogResponse;
     fromPartial(_: DeepPartial<PutLogResponse>): PutLogResponse;
 };
+export declare const PutStreamEventRequest: {
+    encode(message: PutStreamEventRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PutStreamEventRequest;
+    fromJSON(object: any): PutStreamEventRequest;
+    toJSON(message: PutStreamEventRequest): unknown;
+    create(base?: DeepPartial<PutStreamEventRequest>): PutStreamEventRequest;
+    fromPartial(object: DeepPartial<PutStreamEventRequest>): PutStreamEventRequest;
+};
+export declare const PutStreamEventResponse: {
+    encode(_: PutStreamEventResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PutStreamEventResponse;
+    fromJSON(_: any): PutStreamEventResponse;
+    toJSON(_: PutStreamEventResponse): unknown;
+    create(base?: DeepPartial<PutStreamEventResponse>): PutStreamEventResponse;
+    fromPartial(_: DeepPartial<PutStreamEventResponse>): PutStreamEventResponse;
+};
 export declare const PushEventRequest: {
     encode(message: PushEventRequest, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): PushEventRequest;
@@ -150,17 +178,41 @@ export declare const EventsServiceDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly putStreamEvent: {
+            readonly name: "PutStreamEvent";
+            readonly requestType: {
+                encode(message: PutStreamEventRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): PutStreamEventRequest;
+                fromJSON(object: any): PutStreamEventRequest;
+                toJSON(message: PutStreamEventRequest): unknown;
+                create(base?: DeepPartial<PutStreamEventRequest>): PutStreamEventRequest;
+                fromPartial(object: DeepPartial<PutStreamEventRequest>): PutStreamEventRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(_: PutStreamEventResponse, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): PutStreamEventResponse;
+                fromJSON(_: any): PutStreamEventResponse;
+                toJSON(_: PutStreamEventResponse): unknown;
+                create(base?: DeepPartial<PutStreamEventResponse>): PutStreamEventResponse;
+                fromPartial(_: DeepPartial<PutStreamEventResponse>): PutStreamEventResponse;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
     };
 };
 export interface EventsServiceImplementation<CallContextExt = {}> {
     push(request: PushEventRequest, context: CallContext & CallContextExt): Promise<DeepPartial<Event>>;
     replaySingleEvent(request: ReplayEventRequest, context: CallContext & CallContextExt): Promise<DeepPartial<Event>>;
     putLog(request: PutLogRequest, context: CallContext & CallContextExt): Promise<DeepPartial<PutLogResponse>>;
+    putStreamEvent(request: PutStreamEventRequest, context: CallContext & CallContextExt): Promise<DeepPartial<PutStreamEventResponse>>;
 }
 export interface EventsServiceClient<CallOptionsExt = {}> {
     push(request: DeepPartial<PushEventRequest>, options?: CallOptions & CallOptionsExt): Promise<Event>;
     replaySingleEvent(request: DeepPartial<ReplayEventRequest>, options?: CallOptions & CallOptionsExt): Promise<Event>;
     putLog(request: DeepPartial<PutLogRequest>, options?: CallOptions & CallOptionsExt): Promise<PutLogResponse>;
+    putStreamEvent(request: DeepPartial<PutStreamEventRequest>, options?: CallOptions & CallOptionsExt): Promise<PutStreamEventResponse>;
 }
 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.PushEventRequest = exports.PutLogResponse = exports.PutLogRequest = exports.Event = exports.protobufPackage = void 0;
+exports.EventsServiceDefinition = exports.ReplayEventRequest = exports.PushEventRequest = exports.PutStreamEventResponse = exports.PutStreamEventRequest = 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 = '';
@@ -284,6 +284,138 @@ exports.PutLogResponse = {
         return message;
     },
 };
+function createBasePutStreamEventRequest() {
+    return { stepRunId: '', createdAt: undefined, message: new Uint8Array(0), metadata: '' };
+}
+exports.PutStreamEventRequest = {
+    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.length !== 0) {
+            writer.uint32(26).bytes(message.message);
+        }
+        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 = createBasePutStreamEventRequest();
+        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.bytes();
+                    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) ? bytesFromBase64(object.message) : new Uint8Array(0),
+            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.length !== 0) {
+            obj.message = base64FromBytes(message.message);
+        }
+        if (message.metadata !== '') {
+            obj.metadata = message.metadata;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.PutStreamEventRequest.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b, _c, _d;
+        const message = createBasePutStreamEventRequest();
+        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 : new Uint8Array(0);
+        message.metadata = (_d = object.metadata) !== null && _d !== void 0 ? _d : '';
+        return message;
+    },
+};
+function createBasePutStreamEventResponse() {
+    return {};
+}
+exports.PutStreamEventResponse = {
+    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 = createBasePutStreamEventResponse();
+        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.PutStreamEventResponse.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(_) {
+        const message = createBasePutStreamEventResponse();
+        return message;
+    },
+};
 function createBasePushEventRequest() {
     return { key: '', payload: '', eventTimestamp: undefined };
 }
@@ -446,8 +578,41 @@ exports.EventsServiceDefinition = {
             responseStream: false,
             options: {},
         },
+        putStreamEvent: {
+            name: 'PutStreamEvent',
+            requestType: exports.PutStreamEventRequest,
+            requestStream: false,
+            responseType: exports.PutStreamEventResponse,
+            responseStream: false,
+            options: {},
+        },
     },
 };
+function bytesFromBase64(b64) {
+    if (globalThis.Buffer) {
+        return Uint8Array.from(globalThis.Buffer.from(b64, 'base64'));
+    }
+    else {
+        const bin = globalThis.atob(b64);
+        const arr = new Uint8Array(bin.length);
+        for (let i = 0; i < bin.length; ++i) {
+            arr[i] = bin.charCodeAt(i);
+        }
+        return arr;
+    }
+}
+function base64FromBytes(arr) {
+    if (globalThis.Buffer) {
+        return globalThis.Buffer.from(arr).toString('base64');
+    }
+    else {
+        const bin = [];
+        arr.forEach((byte) => {
+            bin.push(globalThis.String.fromCharCode(byte));
+        });
+        return globalThis.btoa(bin.join(''));
+    }
+}
 function toTimestamp(date) {
     const seconds = Math.trunc(date.getTime() / 1000);
     const nanos = (date.getTime() % 1000) * 1000000;

package/step.d.ts

@@ -59,6 +59,7 @@ export declare class Context<T, K> {
     workflowRunId(): string;
     playground(name: string, defaultValue?: string): string;
     log(message: string, level?: LogLevel): void;
+    putStream(data: string | Uint8Array): Promise<void>;
     spawnWorkflow<P = unknown>(workflowName: string, input: T, key?: string): ChildWorkflowRef<P>;
 }
 export type StepRunFunction<T, K> = (ctx: Context<T, K>) => Promise<NextStep> | NextStep | void;

package/step.js

@@ -182,6 +182,17 @@ class Context {
         }
         this.client.event.putLog(stepRunId, message, level);
     }
+    putStream(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { stepRunId } = this.action;
+            if (!stepRunId) {
+                // log a warning
+                this.logger.warn('cannot log from context without stepRunId');
+                return;
+            }
+            yield this.client.event.putStream(stepRunId, data);
+        });
+    }
     spawnWorkflow(workflowName, input, key) {
         const { workflowRunId, stepRunId } = this.action;
         const childWorkflowRunIdPromise = this.client.admin.run_workflow(workflowName, input, {