effect-inngest 0.3.0-beta.0 → 0.3.0-beta.1

package/README.md

@@ -459,7 +459,7 @@ const ProcessOrder = InngestFunction.make("process-order", {
   debounce: { period: Duration.seconds(5) },
   idempotency: "event.data.orderId",
   timeouts: { finish: Duration.hours(1) },
-  cancelOn: [{ event: "order/cancelled", if: "event.data.orderId == async.data.orderId" }],
+  cancelOn: [{ event: OrderCancelled, if: "event.data.orderId == async.data.orderId" }],
   priority: { run: "event.data.isPremium ? 100 : 0" },
 });
 ```

package/dist/Client.d.ts

@@ -7,7 +7,7 @@ import * as _$effect_Cause0 from "effect/Cause";
 
 //#region src/Client.d.ts
 declare namespace Client_d_exports {
-  export { CheckpointApiError, CheckpointRetrySchedule, CheckpointingOption, ClientConfig, EventPayload, InngestClient, InngestConfig, layer, layerConfig, layerFromEnv };
+  export { CheckpointApiError, CheckpointRetrySchedule, CheckpointingOption, ClientConfig, ClientMode, EventPayload, InngestClient, InngestClientService, InngestConfig, SendEventError, SendEventResponse, TypeId, layer, layerConfig, layerFromEnv };
 }
 /**
  * @since 0.1.0
@@ -212,4 +212,4 @@ declare const layerConfig: (config: Config.Wrap<ClientConfig>) => Layer.Layer<In
  */
 declare const layerFromEnv: Layer.Layer<InngestClient | InngestConfig, Config.ConfigError, HttpClient.HttpClient>;
 //#endregion
-export { CheckpointApiError, CheckpointRetrySchedule, type CheckpointingOption, ClientConfig, Client_d_exports, EventPayload, InngestClient, InngestConfig, layer, layerConfig, layerFromEnv };
+export { CheckpointApiError, CheckpointRetrySchedule, type CheckpointingOption, ClientConfig, ClientMode, Client_d_exports, EventPayload, InngestClient, InngestClientService, InngestConfig, SendEventError, SendEventResponse, TypeId, layer, layerConfig, layerFromEnv };

package/dist/Client.js

@@ -16,6 +16,8 @@ var Client_exports = /* @__PURE__ */ __exportAll({
 	EventPayload: () => EventPayload,
 	InngestClient: () => InngestClient,
 	InngestConfig: () => InngestConfig,
+	SendEventError: () => SendEventError,
+	TypeId: () => TypeId,
 	layer: () => layer,
 	layerConfig: () => layerConfig,
 	layerFromEnv: () => layerFromEnv
@@ -203,4 +205,4 @@ const layerFromEnv = layerConfig(Config.all({
 	signingKeyFallback: Config.string("INNGEST_SIGNING_KEY_FALLBACK").pipe(Config.option, Config.map(Option.getOrUndefined))
 }));
 //#endregion
-export { CheckpointApiError, CheckpointRetrySchedule, Client_exports, EventPayload, InngestClient, InngestConfig, layer, layerConfig, layerFromEnv };
+export { CheckpointApiError, CheckpointRetrySchedule, Client_exports, EventPayload, InngestClient, InngestConfig, SendEventError, TypeId, layer, layerConfig, layerFromEnv };

package/dist/Event.d.ts

@@ -3,7 +3,7 @@ import { MakeOptions } from "effect/Schema";
 
 //#region src/Event.d.ts
 declare namespace Event_d_exports {
-  export { EventData, EventDefinition, EventEnvelope, EventType, isEventSchema, make };
+  export { EventData, EventDefinition, EventEnvelope, EventOptions, EventType, TypeId, isEventSchema, make };
 }
 declare const TypeId: unique symbol;
 interface EventOptions extends MakeOptions {
@@ -40,4 +40,4 @@ declare function make<const Name extends string>(name: Name): EventDefinition<Na
 declare function make<const Name extends string, const DataSchema extends Schema.Top>(name: Name, schema: DataSchema): EventDefinition<Name, DataSchema>;
 declare const isEventSchema: (value: unknown) => value is EventDefinition;
 //#endregion
-export { EventDefinition, EventType, Event_d_exports };
+export { EventData, EventDefinition, EventEnvelope, EventOptions, EventType, Event_d_exports, TypeId, isEventSchema, make };

package/dist/Event.js

@@ -10,6 +10,7 @@ import { Predicate, Schema } from "effect";
 * @since 0.1.0
 */
 var Event_exports = /* @__PURE__ */ __exportAll({
+	TypeId: () => TypeId,
 	isEventSchema: () => isEventSchema,
 	make: () => make
 });
@@ -43,4 +44,4 @@ function make(name, schema = Schema.Struct({})) {
 }
 const isEventSchema = (value) => Schema.isSchema(value) && Predicate.hasProperty(value, TypeId);
 //#endregion
-export { Event_exports, make };
+export { Event_exports, TypeId, isEventSchema, make };

package/dist/Function.d.ts

@@ -5,7 +5,7 @@ import { Pipeable } from "effect/Pipeable";
 
 //#region src/Function.d.ts
 declare namespace Function_d_exports {
-  export { CheckpointingOption, CronTrigger, EventTrigger, FunctionOptions, InngestFunction, Trigger, TriggerInput, TypeId, make };
+  export { BatchEventsOption, CancellationOption, CheckpointingOption, ConcurrencyOption, CronTrigger, DebounceOption, EventSchema, EventTrigger, FunctionOptions, FunctionRegistration, InngestFunction, PriorityOption, RateLimitOption, RegistrationConfig, Retries, SingletonOption, ThrottleOption, TimeoutsOption, Trigger, TriggerInput, TypeId, make };
 }
 /**
  * @since 0.1.0
@@ -196,7 +196,7 @@ interface CancellationOption {
   /**
    * The name of the event that should cancel the function run.
    */
-  readonly event: string;
+  readonly event: EventSchema;
   /**
    * The expression that must evaluate to true in order to cancel the function run. There
    * are two variables available in this expression:
@@ -442,4 +442,4 @@ declare function make<const Tag extends string, T extends TriggerInput, S extend
   readonly success: S;
 } & O): InngestFunction<Tag, NormalizeTriggers<T>, S, O>;
 //#endregion
-export { type CheckpointingOption, CronTrigger, EventTrigger, FunctionOptions, Function_d_exports, InngestFunction, Trigger, TriggerInput, TypeId, make };
+export { BatchEventsOption, CancellationOption, type CheckpointingOption, ConcurrencyOption, CronTrigger, DebounceOption, EventSchema, EventTrigger, FunctionOptions, FunctionRegistration, Function_d_exports, InngestFunction, PriorityOption, RateLimitOption, RegistrationConfig, Retries, SingletonOption, ThrottleOption, TimeoutsOption, Trigger, TriggerInput, TypeId, make };

package/dist/Function.js

@@ -32,7 +32,7 @@ const Proto = {
 		else triggers.push({ cron: t.cron });
 		const opts = this.options;
 		const cancel = opts.cancelOn?.map((c) => ({
-			event: c.event,
+			event: c.event.identifier,
 			if: c.if,
 			timeout: c.timeout ? encodeDuration(c.timeout) : void 0
 		}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "effect-inngest",
-  "version": "0.3.0-beta.0",
+  "version": "0.3.0-beta.1",
   "description": "Native Effect client library for Inngest - build durable, type-safe workflows",
   "keywords": [
     "background-jobs",
@@ -42,6 +42,10 @@
       "types": "./dist/Client.d.ts",
       "import": "./src/Client.ts"
     },
+    "./Event": {
+      "types": "./dist/Event.d.ts",
+      "import": "./src/Event.ts"
+    },
     "./Events": {
       "types": "./dist/Events.d.ts",
       "import": "./src/Events.ts"
@@ -71,6 +75,10 @@
         "types": "./dist/Client.d.ts",
         "import": "./dist/Client.js"
       },
+      "./Event": {
+        "types": "./dist/Event.d.ts",
+        "import": "./dist/Event.js"
+      },
       "./Events": {
         "types": "./dist/Events.d.ts",
         "import": "./dist/Events.js"

package/src/Client.ts

@@ -17,21 +17,21 @@ export { CheckpointApiError } from "./internal/checkpoint.js";
  * @category type ids
  * @internal
  */
-const TypeId: unique symbol = Symbol.for("effect-inngest/Client");
+export const TypeId: unique symbol = Symbol.for("effect-inngest/Client");
 
 /**
  * @since 0.1.0
  * @category type ids
  * @internal
  */
-type TypeId = typeof TypeId;
+export type TypeId = typeof TypeId;
 
 const DEFAULT_EVENT_BASE_URL = "https://inn.gs/";
 const DEFAULT_API_BASE_URL = "https://api.inngest.com/";
 const DEFAULT_DEV_SERVER_URL = "http://localhost:8288/";
 const SDK_VERSION = "2.0.0";
 
-type ClientMode = "dev" | "cloud";
+export type ClientMode = "dev" | "cloud";
 
 export interface ClientConfig {
   /**
@@ -147,15 +147,15 @@ const SendEventResponse = Schema.Struct({
   status: Schema.optional(Schema.Number),
 });
 
-type EventPayload = typeof EventPayload.Type;
-type SendEventResponse = typeof SendEventResponse.Type;
+export type EventPayload = typeof EventPayload.Type;
+export type SendEventResponse = typeof SendEventResponse.Type;
 
-class SendEventError extends Schema.TaggedErrorClass<SendEventError>()("SendEventError", {
+export class SendEventError extends Schema.TaggedErrorClass<SendEventError>()("SendEventError", {
   message: Schema.String,
   events: Schema.Array(Schema.String),
 }) {}
 
-interface InngestClientService {
+export interface InngestClientService {
   readonly [TypeId]: TypeId;
   readonly config: ClientConfig;
   readonly mode: ClientMode;

package/src/Event.ts

@@ -9,9 +9,9 @@
 import { Predicate, Schema } from "effect";
 import type { MakeOptions } from "effect/Schema";
 
-const TypeId: unique symbol = Symbol.for("effect-inngest/Event");
+export const TypeId: unique symbol = Symbol.for("effect-inngest/Event");
 
-interface EventOptions extends MakeOptions {
+export interface EventOptions extends MakeOptions {
   readonly id?: string;
   readonly ts?: number;
   readonly v?: string;

package/src/Function.ts

@@ -22,7 +22,7 @@ export const TypeId: unique symbol = Symbol.for("effect-inngest/Function");
  */
 export type TypeId = typeof TypeId;
 
-type EventSchema = InngestEvent.EventDefinition;
+export type EventSchema = InngestEvent.EventDefinition;
 
 /**
  * An event-based trigger configuration.
@@ -59,7 +59,7 @@ export type Trigger<E extends EventSchema = EventSchema> = EventTrigger<E> | Cro
  */
 export type TriggerInput<E extends EventSchema = EventSchema> = Trigger<E> | ReadonlyArray<Trigger<E>>;
 
-interface ConcurrencyOption {
+export interface ConcurrencyOption {
   /**
    * The concurrency limit for this option, adding a limit on how many concurrent
    * steps can execute at once.
@@ -90,7 +90,7 @@ interface ConcurrencyOption {
   readonly scope?: "fn" | "env" | "account";
 }
 
-interface RateLimitOption {
+export interface RateLimitOption {
   /**
    * An optional key to use for rate limiting, similar to idempotency.
    */
@@ -107,7 +107,7 @@ interface RateLimitOption {
   readonly period: Duration.Input;
 }
 
-interface ThrottleOption {
+export interface ThrottleOption {
   /**
    * An optional expression which returns a throttling key for controlling throttling.
    * Every unique key is its own throttle limit. Event data may be used within this
@@ -135,7 +135,7 @@ interface ThrottleOption {
   readonly burst?: number;
 }
 
-interface DebounceOption {
+export interface DebounceOption {
   /**
    * An optional key to use for debouncing.
    */
@@ -154,7 +154,7 @@ interface DebounceOption {
   readonly timeout?: Duration.Input;
 }
 
-interface BatchEventsOption {
+export interface BatchEventsOption {
   /**
    * The maximum number of events to be consumed in one batch.
    */
@@ -178,7 +178,7 @@ interface BatchEventsOption {
   readonly if?: string;
 }
 
-interface PriorityOption {
+export interface PriorityOption {
   /**
    * An expression to use to determine the priority of a function run. The
    * expression can return a number between `-600` and `600`, where `600`
@@ -189,7 +189,7 @@ interface PriorityOption {
   readonly run?: string;
 }
 
-interface TimeoutsOption {
+export interface TimeoutsOption {
   /**
    * Start represents the timeout for starting a function. If the time
    * between scheduling and starting a function exceeds this value, the
@@ -208,7 +208,7 @@ interface TimeoutsOption {
   readonly finish?: Duration.Input;
 }
 
-interface SingletonOption {
+export interface SingletonOption {
   /**
    * An optional key expression used to scope singleton execution.
    * Each unique key has its own singleton lock. Event data can be referenced,
@@ -224,11 +224,11 @@ interface SingletonOption {
   readonly mode: "skip" | "cancel";
 }
 
-interface CancellationOption {
+export interface CancellationOption {
   /**
    * The name of the event that should cancel the function run.
    */
-  readonly event: string;
+  readonly event: EventSchema;
 
   /**
    * The expression that must evaluate to true in order to cancel the function run. There
@@ -246,7 +246,7 @@ interface CancellationOption {
   readonly timeout?: Duration.Input;
 }
 
-type Retries = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20;
+export type Retries = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20;
 
 /**
  * @since 0.1.0
@@ -343,12 +343,12 @@ export interface FunctionOptions {
   readonly checkpointing?: CheckpointingOption;
 }
 
-interface RegistrationConfig {
+export interface RegistrationConfig {
   readonly appId: string;
   readonly url: string;
 }
 
-interface FunctionRegistration {
+export interface FunctionRegistration {
   readonly id: string;
   readonly name: string;
   readonly triggers: ReadonlyArray<{
@@ -481,7 +481,7 @@ const Proto = {
 
     const opts = this.options;
     const cancel = opts.cancelOn?.map((c) => ({
-      event: c.event,
+      event: c.event.identifier,
       if: c.if,
       timeout: c.timeout ? encodeDuration(c.timeout) : undefined,
     }));