@trigger.dev/sdk 2.2.6 → 2.2.7

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _trigger_dev_core from '@trigger.dev/core';
-import { RunTaskBodyInput, CompleteTaskBodyV2Input, FailTaskBodyInput, SendEvent, SendEventOptions, StatusUpdate, UpdateTriggerSourceBodyV2, TriggerSource, RegisterTriggerBodyV2, RegisterSourceEventV2, ScheduleMetadata, GetRunOptionsWithTaskDetails, GetRunsOptions, InvokeOptions, EphemeralEventDispatcherRequestBody, LogLevel, RuntimeEnvironmentType, DisplayProperty, TriggerMetadata, EventFilter, HttpEndpointMetadata, RequestFilter, Prettify, HandleTriggerSource, Logger, RegisterTriggerSource, SerializableJson, ConnectionAuth, NormalizedResponse, HttpSourceResponseMetadata, IntervalOptions, CronOptions, ScheduledPayload, DeserializedJson, ServerTask, CachedTask, InitialStatusUpdate, FetchRequestInit, FetchRetryOptions, FetchTimeoutOptions, FetchPollOperation, RunTaskOptions, IntegrationMetadata, QueueOptions, IntegrationConfig, JobMetadata, RunNotification, MissingConnectionNotificationPayload, MissingConnectionResolvedNotificationPayload, ErrorWithStack, ApiEventLog, RedactString } from '@trigger.dev/core';
+import { RunTaskBodyInput, CompleteTaskBodyV2Input, FailTaskBodyInput, SendEvent, SendEventOptions, StatusUpdate, UpdateTriggerSourceBodyV2, TriggerSource, RegisterTriggerBodyV2, RegisterSourceEventV2, ScheduleMetadata, GetRunOptionsWithTaskDetails, GetRunsOptions, InvokeOptions, EphemeralEventDispatcherRequestBody, LogLevel, RuntimeEnvironmentType, DisplayProperty, TriggerMetadata, EventFilter, SuccessfulRunNotification, FailedRunNotification, HttpEndpointMetadata, RequestFilter, Prettify, HandleTriggerSource, Logger, RegisterTriggerSource, SerializableJson, ConnectionAuth, NormalizedResponse, HttpSourceResponseMetadata, IntervalOptions, CronOptions, ScheduledPayload, DeserializedJson, ServerTask, CachedTask, InitialStatusUpdate, FetchRequestInit, FetchRetryOptions, FetchTimeoutOptions, FetchPollOperation, RunTaskOptions, IntegrationMetadata, QueueOptions, IntegrationConfig, JobMetadata, RunNotification, MissingConnectionNotificationPayload, MissingConnectionResolvedNotificationPayload, ErrorWithStack, ApiEventLog, RedactString } from '@trigger.dev/core';
 export { ConnectionAuth, DisplayProperty, EventFilter, Logger, NormalizedRequest, OverridableRunTaskOptions, Prettify, RedactString, RegisteredOptionsDiff, RunTaskOptions, SourceEventOption } from '@trigger.dev/core';
 import * as zod from 'zod';
 import { z, ZodType, TypeOf } from 'zod';
@@ -730,6 +730,48 @@ declare class TriggerStatus {
     }>;
 }
 
+type EventMap = {
+  [key: string]: (...args: any[]) => void
+}
+
+/**
+ * Type-safe event emitter.
+ *
+ * Use it like this:
+ *
+ * ```typescript
+ * type MyEvents = {
+ *   error: (error: Error) => void;
+ *   message: (from: string, content: string) => void;
+ * }
+ *
+ * const myEmitter = new EventEmitter() as TypedEmitter<MyEvents>;
+ *
+ * myEmitter.emit("error", "x")  // <- Will catch this type error;
+ * ```
+ */
+interface TypedEventEmitter<Events extends EventMap> {
+  addListener<E extends keyof Events> (event: E, listener: Events[E]): this
+  on<E extends keyof Events> (event: E, listener: Events[E]): this
+  once<E extends keyof Events> (event: E, listener: Events[E]): this
+  prependListener<E extends keyof Events> (event: E, listener: Events[E]): this
+  prependOnceListener<E extends keyof Events> (event: E, listener: Events[E]): this
+
+  off<E extends keyof Events>(event: E, listener: Events[E]): this
+  removeAllListeners<E extends keyof Events> (event?: E): this
+  removeListener<E extends keyof Events> (event: E, listener: Events[E]): this
+
+  emit<E extends keyof Events> (event: E, ...args: Parameters<Events[E]>): boolean
+  // The sloppy `eventNames()` return type is to mitigate type incompatibilities - see #5
+  eventNames (): (keyof Events | string | symbol)[]
+  rawListeners<E extends keyof Events> (event: E): Events[E][]
+  listeners<E extends keyof Events> (event: E): Events[E][]
+  listenerCount<E extends keyof Events> (event: E): number
+
+  getMaxListeners (): number
+  setMaxListeners (maxListeners: number): this
+}
+
 interface TriggerContext {
     /** Job metadata */
     job: {
@@ -916,6 +958,11 @@ declare function waitForEventSchema(schema: z.ZodTypeAny): z.ZodObject<{
     context?: any;
     accountId?: string | undefined;
 }>;
+type NotificationEvents = {
+    runSucceeeded: (notification: SuccessfulRunNotification<any>) => void;
+    runFailed: (notification: FailedRunNotification) => void;
+};
+type NotificationsEventEmitter = TypedEventEmitter<NotificationEvents>;
 
 type HttpEndpointOptions<TEventSpecification extends EventSpecification<any>> = {
     id: string;
@@ -1373,6 +1420,7 @@ declare class TriggerClient {
     #private;
     id: string;
     constructor(options: Prettify<TriggerClientOptions>);
+    on: <E extends keyof NotificationEvents>(event: E, listener: NotificationEvents[E]) => NotificationsEventEmitter;
     handleRequest(request: Request, timeOrigin?: number): Promise<NormalizedResponse>;
     defineJob<TTrigger extends Trigger<EventSpecification<any>>, TIntegrations extends Record<string, TriggerIntegration> = {}, TOutput extends any = any>(options: JobOptions<TTrigger, TIntegrations, TOutput>): Job<TTrigger, TIntegrations, TOutput>;
     defineAuthResolver(integration: TriggerIntegration, resolver: TriggerAuthResolver): TriggerClient;
@@ -2097,6 +2145,8 @@ type JobOptions<TTrigger extends Trigger<EventSpecification<any>>, TIntegrations
      * @param context An object that contains information about the Organization, Job, Run and more.
      */
     run: (payload: TriggerEventType<TTrigger>, io: IOWithIntegrations<TIntegrations>, context: TriggerContext) => Promise<TOutput>;
+    onSuccess?: (notification: SuccessfulRunNotification<TOutput, TriggerEventType<TTrigger>>) => void;
+    onFailure?: (notification: FailedRunNotification<TriggerEventType<TTrigger>>) => void;
 };
 type JobPayload<TJob> = TJob extends Job<Trigger<EventSpecification<infer TEvent>>, any> ? TEvent : never;
 type JobIO<TJob> = TJob extends Job<any, infer TIntegrations> ? IOWithIntegrations<TIntegrations> : never;
@@ -2416,4 +2466,4 @@ type Task = ServerTask;
 type SentEvent = ApiEventLog;
 declare function redactString(strings: TemplateStringsArray, ...interpolations: string[]): RedactString;
 
-export { AuthResolverResult, BackgroundFetchResponse, CronTrigger, DynamicIntervalOptions, DynamicSchedule, DynamicTrigger, DynamicTriggerOptions, EventSpecification, EventSpecificationExample, EventSpecificationExampleSchema, EventTrigger, EventTypeFromSpecification, ExternalSource, ExternalSourceParams, ExternalSourceTrigger, ExternalSourceTriggerOptions, HandlerEvent, HttpSourceEvent, IO, IOLogger, IOOptions, IOStats, IOTask, IOWithIntegrations, IntegrationTaskKey, IntervalTrigger, InvokeTrigger, JSONOutputSerializer, Job, JobIO, JobOptions, JobPayload, Json, MissingConnectionNotification, MissingConnectionResolvedNotification, OutputSerializer, PreprocessResults, RunTaskErrorCallback, SchemaParser, SchemaParserIssue, SchemaParserResult, SentEvent, Task, TaskLogger, Trigger, TriggerAuthResolver, TriggerClient, TriggerClientOptions, TriggerContext, TriggerEventType, TriggerIntegration, TriggerInvokeType, TriggerOptionRecord, TriggerPayload, TriggerPreprocessContext, VerifyResult, WaitForEventResult, cronTrigger, eventTrigger, intervalTrigger, invokeTrigger, isTriggerError, missingConnectionNotification, missingConnectionResolvedNotification, omit, redactString, retry, verifyHmacSha256, verifyRequestSignature, waitForEventSchema };
+export { AuthResolverResult, BackgroundFetchResponse, CronTrigger, DynamicIntervalOptions, DynamicSchedule, DynamicTrigger, DynamicTriggerOptions, EventSpecification, EventSpecificationExample, EventSpecificationExampleSchema, EventTrigger, EventTypeFromSpecification, ExternalSource, ExternalSourceParams, ExternalSourceTrigger, ExternalSourceTriggerOptions, HandlerEvent, HttpSourceEvent, IO, IOLogger, IOOptions, IOStats, IOTask, IOWithIntegrations, IntegrationTaskKey, IntervalTrigger, InvokeTrigger, JSONOutputSerializer, Job, JobIO, JobOptions, JobPayload, Json, MissingConnectionNotification, MissingConnectionResolvedNotification, NotificationEvents, NotificationsEventEmitter, OutputSerializer, PreprocessResults, RunTaskErrorCallback, SchemaParser, SchemaParserIssue, SchemaParserResult, SentEvent, Task, TaskLogger, Trigger, TriggerAuthResolver, TriggerClient, TriggerClientOptions, TriggerContext, TriggerEventType, TriggerIntegration, TriggerInvokeType, TriggerOptionRecord, TriggerPayload, TriggerPreprocessContext, VerifyResult, WaitForEventResult, cronTrigger, eventTrigger, intervalTrigger, invokeTrigger, isTriggerError, missingConnectionNotification, missingConnectionResolvedNotification, omit, redactString, retry, verifyHmacSha256, verifyRequestSignature, waitForEventSchema };

package/dist/index.js

@@ -2397,8 +2397,11 @@ var DynamicSchedule = class {
 };
 __name(DynamicSchedule, "DynamicSchedule");
 
+// src/triggerClient.ts
+var import_node_events = __toESM(require("events"));
+
 // package.json
-var version = "2.2.6";
+var version = "2.2.7";
 
 // src/triggerClient.ts
 var registerSourceEvent = {
@@ -2408,7 +2411,7 @@ var registerSourceEvent = {
   icon: "register-source",
   parsePayload: import_core8.RegisterSourceEventSchemaV2.parse
 };
-var _options4, _registeredJobs, _registeredSources, _registeredHttpSourceHandlers, _registeredDynamicTriggers, _jobMetadataByDynamicTriggers, _registeredSchedules, _registeredHttpEndpoints, _authResolvers, _client2, _internalLogger, _preprocessRun, preprocessRun_fn, _executeJob, executeJob_fn, _convertErrorToExecutionResponse, convertErrorToExecutionResponse_fn, _createRunContext, createRunContext_fn, _createPreprocessRunContext, createPreprocessRunContext_fn, _handleHttpSourceRequest, handleHttpSourceRequest_fn, _handleHttpEndpointRequestForResponse, handleHttpEndpointRequestForResponse_fn, _resolveConnections, resolveConnections_fn, _resolveConnection, resolveConnection_fn, _buildJobsIndex, buildJobsIndex_fn, _buildJobIndex, buildJobIndex_fn, _buildJobIntegrations, buildJobIntegrations_fn, _buildJobIntegration, buildJobIntegration_fn, _logIOStats, logIOStats_fn, _standardResponseHeaders, standardResponseHeaders_fn;
+var _options4, _registeredJobs, _registeredSources, _registeredHttpSourceHandlers, _registeredDynamicTriggers, _jobMetadataByDynamicTriggers, _registeredSchedules, _registeredHttpEndpoints, _authResolvers, _eventEmitter, _client2, _internalLogger, _preprocessRun, preprocessRun_fn, _executeJob, executeJob_fn, _convertErrorToExecutionResponse, convertErrorToExecutionResponse_fn, _createRunContext, createRunContext_fn, _createPreprocessRunContext, createPreprocessRunContext_fn, _handleHttpSourceRequest, handleHttpSourceRequest_fn, _handleHttpEndpointRequestForResponse, handleHttpEndpointRequestForResponse_fn, _resolveConnections, resolveConnections_fn, _resolveConnection, resolveConnection_fn, _buildJobsIndex, buildJobsIndex_fn, _buildJobIndex, buildJobIndex_fn, _buildJobIntegrations, buildJobIntegrations_fn, _buildJobIntegration, buildJobIntegration_fn, _logIOStats, logIOStats_fn, _standardResponseHeaders, standardResponseHeaders_fn, _serializeRunMetadata, serializeRunMetadata_fn, _deliverSuccessfulRunNotification, deliverSuccessfulRunNotification_fn, _deliverFailedRunNotification, deliverFailedRunNotification_fn;
 var TriggerClient = class {
   constructor(options) {
     __privateAdd(this, _preprocessRun);
@@ -2426,6 +2429,9 @@ var TriggerClient = class {
     __privateAdd(this, _buildJobIntegration);
     __privateAdd(this, _logIOStats);
     __privateAdd(this, _standardResponseHeaders);
+    __privateAdd(this, _serializeRunMetadata);
+    __privateAdd(this, _deliverSuccessfulRunNotification);
+    __privateAdd(this, _deliverFailedRunNotification);
     __privateAdd(this, _options4, void 0);
     __privateAdd(this, _registeredJobs, {});
     __privateAdd(this, _registeredSources, {});
@@ -2435,8 +2441,10 @@ var TriggerClient = class {
     __privateAdd(this, _registeredSchedules, {});
     __privateAdd(this, _registeredHttpEndpoints, {});
     __privateAdd(this, _authResolvers, {});
+    __privateAdd(this, _eventEmitter, new import_node_events.default());
     __privateAdd(this, _client2, void 0);
     __privateAdd(this, _internalLogger, void 0);
+    __publicField(this, "on", __privateGet(this, _eventEmitter).on.bind(__privateGet(this, _eventEmitter)));
     this.id = options.id;
     __privateSet(this, _options4, options);
     __privateSet(this, _client2, new ApiClient(__privateGet(this, _options4)));
@@ -2613,10 +2621,12 @@ var TriggerClient = class {
           version: job.version,
           triggerVersion
         });
+        const standardHeaders = __privateMethod(this, _standardResponseHeaders, standardResponseHeaders_fn).call(this, timeOrigin);
+        standardHeaders["x-trigger-run-metadata"] = __privateMethod(this, _serializeRunMetadata, serializeRunMetadata_fn).call(this, job);
         return {
           status: 200,
           body: results,
-          headers: __privateMethod(this, _standardResponseHeaders, standardResponseHeaders_fn).call(this, timeOrigin)
+          headers: standardHeaders
         };
       }
       case "PREPROCESS_RUN": {
@@ -2754,6 +2764,22 @@ var TriggerClient = class {
           headers: __privateMethod(this, _standardResponseHeaders, standardResponseHeaders_fn).call(this, timeOrigin)
         };
       }
+      case "RUN_NOTIFICATION": {
+        const rawJson = await request.json();
+        const runNotification = rawJson;
+        if (runNotification.ok) {
+          await __privateMethod(this, _deliverSuccessfulRunNotification, deliverSuccessfulRunNotification_fn).call(this, runNotification);
+        } else {
+          await __privateMethod(this, _deliverFailedRunNotification, deliverFailedRunNotification_fn).call(this, runNotification);
+        }
+        return {
+          status: 200,
+          body: {
+            ok: true
+          },
+          headers: __privateMethod(this, _standardResponseHeaders, standardResponseHeaders_fn).call(this, timeOrigin)
+        };
+      }
     }
     return {
       status: 405,
@@ -2975,6 +3001,7 @@ _jobMetadataByDynamicTriggers = new WeakMap();
 _registeredSchedules = new WeakMap();
 _registeredHttpEndpoints = new WeakMap();
 _authResolvers = new WeakMap();
+_eventEmitter = new WeakMap();
 _client2 = new WeakMap();
 _internalLogger = new WeakMap();
 _preprocessRun = new WeakSet();
@@ -3504,6 +3531,45 @@ standardResponseHeaders_fn = /* @__PURE__ */ __name(function(start) {
     "X-Trigger-Request-Timing": `dur=${performance.now() - start / 1e3}`
   };
 }, "#standardResponseHeaders");
+_serializeRunMetadata = new WeakSet();
+serializeRunMetadata_fn = /* @__PURE__ */ __name(function(job4) {
+  const metadata = {};
+  if (__privateGet(this, _eventEmitter).listenerCount("runSucceeeded") > 0 || typeof job4.options.onSuccess === "function") {
+    metadata["successSubscription"] = true;
+  }
+  if (__privateGet(this, _eventEmitter).listenerCount("runFailed") > 0 || typeof job4.options.onFailure === "function") {
+    metadata["failedSubscription"] = true;
+  }
+  return JSON.stringify(metadata);
+}, "#serializeRunMetadata");
+_deliverSuccessfulRunNotification = new WeakSet();
+deliverSuccessfulRunNotification_fn = /* @__PURE__ */ __name(async function(notification) {
+  __privateGet(this, _internalLogger).debug("delivering successful run notification", {
+    notification
+  });
+  __privateGet(this, _eventEmitter).emit("runSucceeeded", notification);
+  const job = __privateGet(this, _registeredJobs)[notification.job.id];
+  if (!job) {
+    return;
+  }
+  if (typeof job.options.onSuccess === "function") {
+    await job.options.onSuccess(notification);
+  }
+}, "#deliverSuccessfulRunNotification");
+_deliverFailedRunNotification = new WeakSet();
+deliverFailedRunNotification_fn = /* @__PURE__ */ __name(async function(notification1) {
+  __privateGet(this, _internalLogger).debug("delivering failed run notification", {
+    notification: notification1
+  });
+  __privateGet(this, _eventEmitter).emit("runFailed", notification1);
+  const job = __privateGet(this, _registeredJobs)[notification1.job.id];
+  if (!job) {
+    return;
+  }
+  if (typeof job.options.onFailure === "function") {
+    await job.options.onFailure(notification1);
+  }
+}, "#deliverFailedRunNotification");
 function dynamicTriggerRegisterSourceJobId(id) {
   return `register-dynamic-trigger-${id}`;
 }