@trigger.dev/sdk 2.0.0-next.19 → 2.0.0-next.20

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as zod from 'zod';
-import { z } from 'zod';
+import { z, ZodObject } from 'zod';
 
 /**
  * Represents different log levels.
@@ -810,6 +810,53 @@ declare const RawEventSchema: z.ZodObject<{
 }>;
 /** The event you wish to send to Trigger a Job */
 type SendEvent = z.input<typeof RawEventSchema>;
+/** The event that was sent */
+declare const ApiEventLogSchema: z.ZodObject<{
+    /** The `id` of the event that was sent.
+     */
+    id: z.ZodString;
+    /** The `name` of the event that was sent. */
+    name: z.ZodString;
+    /** The `payload` of the event that was sent */
+    payload: z.ZodType<DeserializedJson, z.ZodTypeDef, DeserializedJson>;
+    /** The `context` of the event that was sent. Is `undefined` if no context was
+        set when sending the event. */
+    context: z.ZodNullable<z.ZodOptional<z.ZodType<DeserializedJson, z.ZodTypeDef, DeserializedJson>>>;
+    /** The `timestamp` of the event that was sent */
+    timestamp: z.ZodDate;
+    /** The timestamp when the event will be delivered to any matching Jobs. Is
+        `undefined` if `deliverAt` or `deliverAfter` wasn't set when sending the
+        event. */
+    deliverAt: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
+    /** The timestamp when the event was delivered. Is `undefined` if `deliverAt`
+        or `deliverAfter` were set when sending the event. */
+    deliveredAt: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name: string;
+    payload: ((string | number | boolean | {
+        [key: string]: DeserializedJson;
+    } | DeserializedJson[]) & (string | number | boolean | {
+        [key: string]: DeserializedJson;
+    } | DeserializedJson[] | undefined)) | null;
+    timestamp: Date;
+    context?: DeserializedJson | undefined;
+    deliverAt?: Date | null | undefined;
+    deliveredAt?: Date | null | undefined;
+}, {
+    id: string;
+    name: string;
+    payload: ((string | number | boolean | {
+        [key: string]: DeserializedJson;
+    } | DeserializedJson[]) & (string | number | boolean | {
+        [key: string]: DeserializedJson;
+    } | DeserializedJson[] | undefined)) | null;
+    timestamp: Date;
+    context?: DeserializedJson | undefined;
+    deliverAt?: Date | null | undefined;
+    deliveredAt?: Date | null | undefined;
+}>;
+type ApiEventLog = z.infer<typeof ApiEventLogSchema>;
 /** Options to control the delivery of the event */
 declare const SendEventOptionsSchema: z.ZodObject<{
     /** An optional Date when you want the event to trigger Jobs. The event will
@@ -3138,6 +3185,37 @@ declare const FetchRetryOptionsSchema: z.ZodRecord<z.ZodString, z.ZodDiscriminat
   */
 type FetchRetryOptions = z.infer<typeof FetchRetryOptionsSchema>;
 
+declare const GetRunOptionsWithTaskDetailsSchema: ZodObject<{
+    subtasks: z.ZodOptional<z.ZodBoolean>;
+    cursor: z.ZodOptional<z.ZodString>;
+    take: z.ZodOptional<z.ZodNumber>;
+    taskdetails: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    subtasks?: boolean | undefined;
+    cursor?: string | undefined;
+    take?: number | undefined;
+    taskdetails?: boolean | undefined;
+}, {
+    subtasks?: boolean | undefined;
+    cursor?: string | undefined;
+    take?: number | undefined;
+    taskdetails?: boolean | undefined;
+}>;
+type GetRunOptionsWithTaskDetails = z.infer<typeof GetRunOptionsWithTaskDetailsSchema>;
+declare const GetRunsOptionsSchema: ZodObject<{
+    /** You can use this to get more tasks, if there are more than are returned in a single batch @default undefined */
+    cursor: z.ZodOptional<z.ZodString>;
+    /** How many runs you want to return in one go, max 50. @default 20 */
+    take: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    cursor?: string | undefined;
+    take?: number | undefined;
+}, {
+    cursor?: string | undefined;
+    take?: number | undefined;
+}>;
+type GetRunsOptions = z.infer<typeof GetRunsOptionsSchema>;
+
 type ApiClientOptions = {
     apiKey?: string;
     apiUrl?: string;
@@ -3302,6 +3380,46 @@ declare class ApiClient {
         scopes?: string[] | undefined;
         additionalFields?: Record<string, string> | undefined;
     } | undefined>;
+    getEvent(eventId: string): Promise<{
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        runs: {
+            id: string;
+            status: "PENDING" | "CANCELED" | "SUCCESS" | "QUEUED" | "WAITING_ON_CONNECTIONS" | "PREPROCESSING" | "STARTED" | "FAILURE" | "TIMED_OUT" | "ABORTED";
+            startedAt?: Date | null | undefined;
+            completedAt?: Date | null | undefined;
+        }[];
+    }>;
+    getRun(runId: string, options?: GetRunOptionsWithTaskDetails): Promise<{
+        id: string;
+        startedAt: Date | null;
+        completedAt: Date | null;
+        status: "PENDING" | "CANCELED" | "SUCCESS" | "QUEUED" | "WAITING_ON_CONNECTIONS" | "PREPROCESSING" | "STARTED" | "FAILURE" | "TIMED_OUT" | "ABORTED";
+        tasks: {
+            id: string;
+            name: string;
+            icon: string | null;
+            startedAt: Date | null;
+            completedAt: Date | null;
+            status: "PENDING" | "WAITING" | "RUNNING" | "COMPLETED" | "ERRORED" | "CANCELED";
+            displayKey: string | null;
+        }[];
+        updatedAt: Date | null;
+        output?: any;
+        nextCursor?: string | undefined;
+    }>;
+    getRuns(jobSlug: string, options?: GetRunsOptions): Promise<{
+        runs: {
+            id: string;
+            startedAt: Date | null;
+            completedAt: Date | null;
+            status: "PENDING" | "CANCELED" | "SUCCESS" | "QUEUED" | "WAITING_ON_CONNECTIONS" | "PREPROCESSING" | "STARTED" | "FAILURE" | "TIMED_OUT" | "ABORTED";
+            updatedAt: Date | null;
+        }[];
+        nextCursor?: string | undefined;
+    }>;
 }
 
 interface TriggerContext {
@@ -3686,6 +3804,46 @@ declare class TriggerClient {
     unregisterSchedule(id: string, key: string): Promise<{
         ok: boolean;
     }>;
+    getEvent(eventId: string): Promise<{
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        runs: {
+            id: string;
+            status: "PENDING" | "CANCELED" | "SUCCESS" | "QUEUED" | "WAITING_ON_CONNECTIONS" | "PREPROCESSING" | "STARTED" | "FAILURE" | "TIMED_OUT" | "ABORTED";
+            startedAt?: Date | null | undefined;
+            completedAt?: Date | null | undefined;
+        }[];
+    }>;
+    getRun(runId: string, options?: GetRunOptionsWithTaskDetails): Promise<{
+        id: string;
+        startedAt: Date | null;
+        completedAt: Date | null;
+        status: "PENDING" | "CANCELED" | "SUCCESS" | "QUEUED" | "WAITING_ON_CONNECTIONS" | "PREPROCESSING" | "STARTED" | "FAILURE" | "TIMED_OUT" | "ABORTED";
+        tasks: {
+            id: string;
+            name: string;
+            icon: string | null;
+            startedAt: Date | null;
+            completedAt: Date | null;
+            status: "PENDING" | "WAITING" | "RUNNING" | "COMPLETED" | "ERRORED" | "CANCELED";
+            displayKey: string | null;
+        }[];
+        updatedAt: Date | null;
+        output?: any;
+        nextCursor?: string | undefined;
+    }>;
+    getRuns(jobSlug: string, options?: GetRunsOptions): Promise<{
+        runs: {
+            id: string;
+            startedAt: Date | null;
+            completedAt: Date | null;
+            status: "PENDING" | "CANCELED" | "SUCCESS" | "QUEUED" | "WAITING_ON_CONNECTIONS" | "PREPROCESSING" | "STARTED" | "FAILURE" | "TIMED_OUT" | "ABORTED";
+            updatedAt: Date | null;
+        }[];
+        nextCursor?: string | undefined;
+    }>;
     authorized(apiKey?: string | null): "authorized" | "unauthorized" | "missing-client" | "missing-header";
     apiKey(): string | undefined;
     defineJob<TTrigger extends Trigger<EventSpecification<any>>, TIntegrations extends Record<string, TriggerIntegration<IntegrationClient<any, any>>> = {}>(options: JobOptions<TTrigger, TIntegrations>): Job<TTrigger, TIntegrations>;
@@ -4293,6 +4451,8 @@ declare class CanceledWithTaskError {
 declare function isTriggerError(err: unknown): err is ResumeWithTaskError | RetryWithTaskError | CanceledWithTaskError;
 
 type Task = ServerTask;
+
+type SentEvent = ApiEventLog;
 declare function redactString(strings: TemplateStringsArray, ...interpolations: string[]): RedactString;
 
-export { AuthenticatedTask, ClientFactory, CronTrigger, DynamicIntervalOptions, DynamicSchedule, DynamicTrigger, DynamicTriggerOptions, EventFilter, EventSpecification, EventSpecificationExample, EventTrigger, EventTypeFromSpecification, ExternalSource, ExternalSourceParams, ExternalSourceTrigger, ExternalSourceTriggerOptions, HandlerEvent, HttpSourceEvent, IO, IOLogger, IOOptions, IOTask, IOWithIntegrations, IntegrationClient, IntervalTrigger, Job, JobOptions, Logger, MissingConnectionNotification, MissingConnectionResolvedNotification, NormalizedRequest, PreprocessResults, RedactString, Task, TaskLogger, Trigger, TriggerClient, TriggerClientOptions, TriggerContext, TriggerEventType, TriggerIntegration, TriggerPreprocessContext, authenticatedTask, cronTrigger, eventTrigger, intervalTrigger, isTriggerError, missingConnectionNotification, missingConnectionResolvedNotification, omit, redactString };
+export { AuthenticatedTask, ClientFactory, CronTrigger, DynamicIntervalOptions, DynamicSchedule, DynamicTrigger, DynamicTriggerOptions, EventFilter, EventSpecification, EventSpecificationExample, EventTrigger, EventTypeFromSpecification, ExternalSource, ExternalSourceParams, ExternalSourceTrigger, ExternalSourceTriggerOptions, HandlerEvent, HttpSourceEvent, IO, IOLogger, IOOptions, IOTask, IOWithIntegrations, IntegrationClient, IntervalTrigger, Job, JobOptions, Logger, MissingConnectionNotification, MissingConnectionResolvedNotification, NormalizedRequest, PreprocessResults, RedactString, SentEvent, Task, TaskLogger, Trigger, TriggerClient, TriggerClientOptions, TriggerContext, TriggerEventType, TriggerIntegration, TriggerPreprocessContext, authenticatedTask, cronTrigger, eventTrigger, intervalTrigger, isTriggerError, missingConnectionNotification, missingConnectionResolvedNotification, omit, redactString };

package/dist/index.js

@@ -968,6 +968,75 @@ var FetchOperationSchema = import_zod11.z.object({
   retry: import_zod11.z.record(FetchRetryStrategySchema).optional()
 });
 
+// ../internal/src/schemas/events.ts
+var import_zod13 = require("zod");
+
+// ../internal/src/schemas/runs.ts
+var import_zod12 = require("zod");
+var RunStatusSchema = import_zod12.z.union([
+  import_zod12.z.literal("PENDING"),
+  import_zod12.z.literal("QUEUED"),
+  import_zod12.z.literal("WAITING_ON_CONNECTIONS"),
+  import_zod12.z.literal("PREPROCESSING"),
+  import_zod12.z.literal("STARTED"),
+  import_zod12.z.literal("SUCCESS"),
+  import_zod12.z.literal("FAILURE"),
+  import_zod12.z.literal("TIMED_OUT"),
+  import_zod12.z.literal("ABORTED"),
+  import_zod12.z.literal("CANCELED")
+]);
+var RunTaskSchema = import_zod12.z.object({
+  id: import_zod12.z.string(),
+  displayKey: import_zod12.z.string().nullable(),
+  status: TaskStatusSchema,
+  name: import_zod12.z.string(),
+  icon: import_zod12.z.string().nullable(),
+  startedAt: import_zod12.z.coerce.date().nullable(),
+  completedAt: import_zod12.z.coerce.date().nullable()
+});
+var GetRunOptionsSchema = import_zod12.z.object({
+  subtasks: import_zod12.z.boolean().optional(),
+  cursor: import_zod12.z.string().optional(),
+  take: import_zod12.z.number().optional()
+});
+var GetRunOptionsWithTaskDetailsSchema = GetRunOptionsSchema.extend({
+  taskdetails: import_zod12.z.boolean().optional()
+});
+var RunSchema = import_zod12.z.object({
+  id: import_zod12.z.string(),
+  status: RunStatusSchema,
+  startedAt: import_zod12.z.coerce.date().nullable(),
+  updatedAt: import_zod12.z.coerce.date().nullable(),
+  completedAt: import_zod12.z.coerce.date().nullable()
+});
+var GetRunSchema = RunSchema.extend({
+  output: import_zod12.z.any().optional(),
+  tasks: import_zod12.z.array(RunTaskSchema),
+  nextCursor: import_zod12.z.string().optional()
+});
+var GetRunsOptionsSchema = import_zod12.z.object({
+  cursor: import_zod12.z.string().optional(),
+  take: import_zod12.z.number().optional()
+});
+var GetRunsSchema = import_zod12.z.object({
+  runs: RunSchema.array(),
+  nextCursor: import_zod12.z.string().optional()
+});
+
+// ../internal/src/schemas/events.ts
+var GetEventSchema = import_zod13.z.object({
+  id: import_zod13.z.string(),
+  name: import_zod13.z.string(),
+  createdAt: import_zod13.z.coerce.date(),
+  updatedAt: import_zod13.z.coerce.date(),
+  runs: import_zod13.z.array(import_zod13.z.object({
+    id: import_zod13.z.string(),
+    status: RunStatusSchema,
+    startedAt: import_zod13.z.coerce.date().optional().nullable(),
+    completedAt: import_zod13.z.coerce.date().optional().nullable()
+  }))
+});
+
 // ../internal/src/utils.ts
 function deepMergeFilters(filter, other) {
   const result = {
@@ -1026,9 +1095,22 @@ var currentDate = {
   }
 };
 
+// ../internal/src/searchParams.ts
+function urlWithSearchParams(url, params) {
+  if (!params) {
+    return url;
+  }
+  const urlObj = new URL(url);
+  for (const [key, value] of Object.entries(params)) {
+    urlObj.searchParams.append(key, String(value));
+  }
+  return urlObj.toString();
+}
+__name(urlWithSearchParams, "urlWithSearchParams");
+
 // src/apiClient.ts
-var import_zod12 = require("zod");
 var import_node_fetch = __toESM(require("node-fetch"));
+var import_zod14 = require("zod");
 var _apiUrl, _options, _logger, _apiKey, apiKey_fn;
 var ApiClient = class {
   constructor(options) {
@@ -1197,8 +1279,8 @@ var ApiClient = class {
     __privateGet(this, _logger).debug("unregistering schedule", {
       id
     });
-    const response = await zodfetch(import_zod12.z.object({
-      ok: import_zod12.z.boolean()
+    const response = await zodfetch(import_zod14.z.object({
+      ok: import_zod14.z.boolean()
     }), `${__privateGet(this, _apiUrl)}/api/v1/${client}/schedules/${id}/registrations/${encodeURIComponent(key)}`, {
       method: "DELETE",
       headers: {
@@ -1224,6 +1306,42 @@ var ApiClient = class {
     });
     return response;
   }
+  async getEvent(eventId) {
+    const apiKey = await __privateMethod(this, _apiKey, apiKey_fn).call(this);
+    __privateGet(this, _logger).debug("Getting Event", {
+      eventId
+    });
+    return await zodfetch(GetEventSchema, `${__privateGet(this, _apiUrl)}/api/v1/events/${eventId}`, {
+      method: "GET",
+      headers: {
+        Authorization: `Bearer ${apiKey}`
+      }
+    });
+  }
+  async getRun(runId, options) {
+    const apiKey = await __privateMethod(this, _apiKey, apiKey_fn).call(this);
+    __privateGet(this, _logger).debug("Getting Run", {
+      runId
+    });
+    return await zodfetch(GetRunSchema, urlWithSearchParams(`${__privateGet(this, _apiUrl)}/api/v1/runs/${runId}`, options), {
+      method: "GET",
+      headers: {
+        Authorization: `Bearer ${apiKey}`
+      }
+    });
+  }
+  async getRuns(jobSlug, options) {
+    const apiKey = await __privateMethod(this, _apiKey, apiKey_fn).call(this);
+    __privateGet(this, _logger).debug("Getting Runs", {
+      jobSlug
+    });
+    return await zodfetch(GetRunsSchema, urlWithSearchParams(`${__privateGet(this, _apiUrl)}/api/v1/jobs/${jobSlug}/runs`, options), {
+      method: "GET",
+      headers: {
+        Authorization: `Bearer ${apiKey}`
+      }
+    });
+  }
 };
 __name(ApiClient, "ApiClient");
 _apiUrl = new WeakMap();
@@ -2315,6 +2433,15 @@ var TriggerClient = class {
   async unregisterSchedule(id, key) {
     return __privateGet(this, _client).unregisterSchedule(this.id, id, key);
   }
+  async getEvent(eventId) {
+    return __privateGet(this, _client).getEvent(eventId);
+  }
+  async getRun(runId, options) {
+    return __privateGet(this, _client).getRun(runId, options);
+  }
+  async getRuns(jobSlug, options) {
+    return __privateGet(this, _client).getRuns(jobSlug, options);
+  }
   authorized(apiKey) {
     if (typeof apiKey !== "string") {
       return "missing-header";