@teever/ez-hook-effect 0.5.0 → 0.5.19

package/dist/index.d.ts

@@ -0,0 +1,89 @@
+/**
+ * ez-hook-effect - Discord webhook library built with Effect
+ *
+ * Type-safe, composable, and resilient Discord webhook client.
+ *
+ * @example
+ * ```ts
+ * import { Webhook, Embed, sendWebhook, WebhookServiceLive, makeConfigLayer, HttpClientLive } from "ez-hook-effect";
+ * import { Effect, Layer, pipe } from "effect";
+ *
+ * const webhook = pipe(
+ *   Webhook.make,
+ *   Webhook.setContent("Hello from Effect!"),
+ *   Webhook.build
+ * );
+ *
+ * const layer = WebhookServiceLive.pipe(
+ *   Layer.provide(makeConfigLayer("https://discord.com/api/webhooks/...")),
+ *   Layer.provide(HttpClientLive)
+ * );
+ *
+ * Effect.gen(function* () {
+ *   const msg = yield* webhook;
+ *   yield* sendWebhook(msg);
+ * }).pipe(Effect.provide(layer), Effect.runPromise);
+ * ```
+ *
+ * @packageDocumentation
+ */
+/** Error types for handling webhook failures */
+export { ConfigError, FileError, formatWebhookError, HttpError, type HttpErrorResponse, makeIssue, NetworkError, parseErrorToIssues, RateLimitError, ValidationError, type ValidationIssue, webhookErrorToLogObject, WebhookError, type WebhookErrors, } from "./errors";
+/**
+ * Configuration service and layers.
+ * Use makeConfigLayer for programmatic config or ConfigFromEnv for environment variables.
+ */
+export { Config, ConfigFromEnv, makeConfig, makeConfigLayer, parseWebhookUrl, type WebhookConfig, } from "./layers/Config";
+/**
+ * HTTP client service and layers.
+ * Provides fetch-based HTTP client with retry and rate limit support.
+ */
+export { createRetrySchedule, defaultRetryConfig, FetchHttpClient, HttpClient, HttpClientLive, type HttpRequest, type HttpResponse, makeHttpClientLayer, makeTestHttpClient, parseRateLimitHeaders, type RateLimitInfo, type RetryConfig, } from "./layers/HttpClient";
+/**
+ * Convenience layer to wire Config + HttpClient + WebhookService.
+ */
+export { makeDefaultLayer } from "./layers/Default";
+/**
+ * Embed builder namespace.
+ * Pipe-first API for building Discord embed objects.
+ *
+ * @example
+ * ```ts
+ * import { Embed } from "ez-hook-effect";
+ * import { pipe } from "effect";
+ *
+ * const embed = pipe(
+ *   Embed.make,
+ *   Embed.setTitle("Hello"),
+ *   Embed.setDescription("World"),
+ *   Embed.setColor("#5865F2"),
+ *   Embed.build
+ * );
+ * ```
+ */
+export * as Embed from "./pipes/Embed";
+/**
+ * Webhook builder namespace.
+ * Pipe-first API for building Discord webhook payloads.
+ *
+ * @example
+ * ```ts
+ * import { Webhook } from "ez-hook-effect";
+ * import { pipe } from "effect";
+ *
+ * const webhook = pipe(
+ *   Webhook.make,
+ *   Webhook.setUsername("Bot"),
+ *   Webhook.setContent("Hello!"),
+ *   Webhook.build
+ * );
+ * ```
+ */
+export * as Webhook from "./pipes/Webhook";
+/** Schema types for Discord webhook payloads */
+export * from "./schemas";
+/**
+ * Webhook service and module-level accessors.
+ * Use these with Effect.flatMap or Effect.gen for sending webhooks.
+ */
+export { deleteWebhook, getWebhook, makeWebhookService, modifyWebhook, sendWebhook, sendWebhookRaw, validateWebhook, type SendWebhookRawResult, WebhookService, WebhookServiceLive, } from "./services/WebhookService";