@distilled.cloud/doppler 0.0.0 → 1.0.0-rc.9

package/src/credentials.ts

@@ -0,0 +1,61 @@
+/**
+ * Doppler credentials — hand-written.
+ *
+ * The `Credentials` service holds an *effect* that resolves the current
+ * credentials on every request (the protocol layer resolves it per request
+ * on the calling fiber). Auth is a Doppler API token sent as
+ * `Authorization: Bearer <token>`.
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+import { ConfigError } from "@distilled.cloud/core/errors";
+
+export const DEFAULT_API_BASE_URL = "https://api.doppler.com";
+
+export interface Config {
+  readonly apiKey: Redacted.Redacted<string>;
+  readonly apiBaseUrl: string;
+}
+
+export class Credentials extends Context.Service<
+  Credentials,
+  Effect.Effect<Config>
+>()("DopplerCredentials") {}
+
+/** Layer from a plain API token + optional base URL. */
+export const fromApiKey = (config: {
+  readonly apiKey: string;
+  readonly apiBaseUrl?: string;
+}): Layer.Layer<Credentials> =>
+  Layer.succeed(
+    Credentials,
+    Effect.succeed({
+      apiKey: Redacted.make(config.apiKey),
+      apiBaseUrl: config.apiBaseUrl ?? DEFAULT_API_BASE_URL,
+    }),
+  );
+
+/**
+ * Reads DOPPLER_TOKEN or DOPPLER_API_KEY (required) and
+ * DOPPLER_API_BASE_URL (optional).
+ */
+export const CredentialsFromEnv: Layer.Layer<Credentials> = Layer.succeed(
+  Credentials,
+  Effect.gen(function* () {
+    const apiKey = process.env.DOPPLER_TOKEN ?? process.env.DOPPLER_API_KEY;
+
+    if (!apiKey) {
+      return yield* new ConfigError({
+        message:
+          "DOPPLER_TOKEN (or DOPPLER_API_KEY) environment variable is required",
+      });
+    }
+
+    return {
+      apiKey: Redacted.make(apiKey),
+      apiBaseUrl: process.env.DOPPLER_API_BASE_URL ?? DEFAULT_API_BASE_URL,
+    };
+  }).pipe(Effect.orDie),
+);

package/src/errors.ts

@@ -0,0 +1,50 @@
+/**
+ * Doppler-specific error types.
+ *
+ * Re-exports the common HTTP errors from core and adds the Doppler fallback
+ * errors. Note the generated service module additionally defines its own
+ * per-status matcher classes (BadRequest/NotFound/…) for the statuses each
+ * operation declares — those share `_tag`s with the core classes here, so
+ * `catchTag` works against either.
+ */
+export {
+  BadGateway,
+  BadRequest,
+  Conflict,
+  ConfigError,
+  Forbidden,
+  GatewayTimeout,
+  InternalServerError,
+  Locked,
+  NotFound,
+  ServiceUnavailable,
+  TooManyRequests,
+  Unauthorized,
+  UnprocessableEntity,
+  HTTP_STATUS_MAP,
+  DEFAULT_ERRORS,
+  API_ERRORS,
+} from "@distilled.cloud/core/errors";
+export type { DefaultErrors } from "@distilled.cloud/core/errors";
+
+import * as Schema from "effect/Schema";
+import * as Category from "@distilled.cloud/core/category";
+
+/** Unknown Doppler error — returned when nothing else matches the failure. */
+export class UnknownDopplerError extends Schema.TaggedError<UnknownDopplerError>()(
+  "UnknownDopplerError",
+  {
+    code: Schema.optional(Schema.String),
+    message: Schema.optional(Schema.String),
+    body: Schema.Unknown,
+  },
+).pipe(Category.withServerError) {}
+
+/** Schema parse error wrapper. */
+export class DopplerParseError extends Schema.TaggedError<DopplerParseError>()(
+  "DopplerParseError",
+  {
+    body: Schema.Unknown,
+    cause: Schema.Unknown,
+  },
+).pipe(Category.withParseError) {}

package/src/index.ts

@@ -0,0 +1,32 @@
+/**
+ * @distilled.cloud/doppler — Doppler SDK for Effect.
+ *
+ * `./services` is generated by `scripts/generate.ts` from the Smithy model
+ * in `.generated-specs` (written by `scripts/convert.ts` from the OpenAPI
+ * spec assembled from https://docs.doppler.com/llms.txt). Everything else
+ * in this folder is hand-written.
+ *
+ * @example
+ * ```ts
+ * import * as Doppler from "@distilled.cloud/doppler";
+ *
+ * const projects = yield* Doppler.Services.doppler.projectsList({});
+ * ```
+ */
+export * from "./credentials.ts";
+export * from "./errors.ts";
+export * as T from "./traits.ts";
+export {
+  DopplerProtocol,
+  type DopplerOpError,
+  type DopplerOpContext,
+} from "./protocol.ts";
+export { paginateCursor } from "./pagination.ts";
+export * as Retry from "./retry.ts";
+export * as Services from "./services/index.ts";
+// Operations (and their request/response types) are importable straight off
+// the package root. The service-local typed error classes shadow the
+// same-named shared ones from ./errors.ts — the ops actually raise the
+// service-local classes.
+export * from "./services/doppler.ts";
+export { BadRequest, Conflict, NotFound } from "./services/doppler.ts";

package/src/pagination.ts

@@ -0,0 +1,7 @@
+/**
+ * Doppler pagination — hand-written.
+ *
+ * Most Doppler lists are page/per_page. Generated operations that the
+ * converter stamps as cursor-mode pass core's {@link paginateCursor}.
+ */
+export { paginateCursor } from "@distilled.cloud/core/pagination";

package/src/protocol.ts

@@ -0,0 +1,91 @@
+/**
+ * DopplerProtocol — hand-written.
+ *
+ * Doppler speaks plain bearer-authenticated JSON REST (no response envelope),
+ * so the whole protocol is one `makeRestProtocol` call from
+ * `core/protocol-rest`:
+ *
+ *   request:  credentials → `Authorization: Bearer <token>` + base URL
+ *             (default https://api.doppler.com), resolved from the
+ *             calling fiber on every request
+ *
+ *   response: 2xx JSON is the payload (sensitive members delivered as
+ *             `Redacted`); non-2xx `{ messages?: string[], message? }`
+ *             bodies map to the operation's typed error classes by status,
+ *             then the shared HTTP-status classes, then
+ *             {@link UnknownDopplerError}.
+ */
+import * as Effect from "effect/Effect";
+import type * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+import type * as HttpClient from "effect/unstable/http/HttpClient";
+import type * as HttpClientError from "effect/unstable/http/HttpClientError";
+import type * as API from "@distilled.cloud/core/api";
+import { makeRestProtocol } from "@distilled.cloud/core/protocol-rest";
+import type { API_ERRORS, ConfigError } from "@distilled.cloud/core/errors";
+import { Credentials, type Config } from "./credentials.ts";
+import { UnknownDopplerError } from "./errors.ts";
+
+/**
+ * Error channel shared by every generated Doppler operation. Generated
+ * service files annotate operations with `API.OperationMethod<I, O,
+ * DopplerOpError, DopplerOpContext>` explicitly so the compiler never
+ * infers these back out of the schema generics.
+ */
+export type DopplerOpError =
+  | InstanceType<(typeof API_ERRORS)[number]>
+  | UnknownDopplerError
+  | ConfigError
+  | HttpClientError.HttpClientError;
+
+/** Context (requirements) shared by every generated Doppler operation. */
+export type DopplerOpContext = Credentials | HttpClient.HttpClient;
+
+export const DopplerProtocol: Layer.Layer<API.Protocol> =
+  makeRestProtocol<Config>({
+    // The Credentials service holds an effect — resolving it here (per
+    // request, on the calling fiber) picks up context-provided credentials.
+    credentials: Effect.gen(function* () {
+      const resolve = yield* Credentials;
+      return yield* resolve;
+    }),
+    baseUrl: (creds) => creds.apiBaseUrl,
+    headers: (creds) => ({
+      Authorization: `Bearer ${Redacted.value(creds.apiKey)}`,
+    }),
+    // Doppler's error body is `{ messages?: string[], message?: string,
+    // success?: boolean }`. The factory's default envelope covers `message`;
+    // `messages[0]` is the form most endpoints actually send.
+    errorEnvelope: (body) => {
+      if (body === null || typeof body !== "object") return undefined;
+      const rec = body as Record<string, unknown>;
+      const code =
+        typeof rec.code === "string"
+          ? rec.code
+          : typeof rec.error === "string"
+            ? rec.error
+            : undefined;
+      const fromMessages = Array.isArray(rec.messages)
+        ? rec.messages.find((m) => typeof m === "string")
+        : undefined;
+      const message =
+        typeof rec.message === "string"
+          ? rec.message
+          : typeof fromMessages === "string"
+            ? fromMessages
+            : undefined;
+      if (code === undefined && message === undefined) return undefined;
+      return { code, message };
+    },
+    unknownError: ({ code, message, body }) =>
+      new UnknownDopplerError({
+        code:
+          typeof code === "string"
+            ? code
+            : code !== undefined
+              ? String(code)
+              : undefined,
+        message,
+        body,
+      }),
+  });

package/src/retry.ts

@@ -0,0 +1,54 @@
+/**
+ * Doppler retry configuration.
+ *
+ * Defines the per-SDK `Retry` Context.Service tag that generated operations
+ * wire into `API.make`. Callers can install a blanket retry policy at the
+ * layer level and have every Doppler API call below it pick it up:
+ *
+ * @example
+ * ```ts
+ * import * as Doppler from "@distilled.cloud/doppler";
+ *
+ * myEffect.pipe(Doppler.Retry.transient);
+ * Effect.provide(myEffect, Layer.succeed(Doppler.Retry.Retry, customPolicy));
+ * ```
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import {
+  type Policy,
+  throttlingFactory,
+  transientFactory,
+} from "@distilled.cloud/core/retry";
+
+export {
+  type Options,
+  type Factory,
+  type Policy,
+  makeDefault,
+  jittered,
+  capped,
+  throttlingOptions,
+  transientOptions,
+  throttlingFactory,
+  transientFactory,
+} from "@distilled.cloud/core/retry";
+
+/** Context tag for configuring retry behavior of Doppler API calls. */
+export class Retry extends Context.Service<Retry, Policy>()("DopplerRetry") {}
+
+/** Provides a custom retry policy to every Doppler API call below it. */
+export const policy = (optionsOrFactory: Policy) =>
+  Effect.provide(Layer.succeed(Retry, optionsOrFactory));
+
+/** Disables all automatic retries. */
+export const none = Effect.provide(
+  Layer.succeed(Retry, { while: () => false }),
+);
+
+/** Apply the throttling retry policy (retries throttling errors indefinitely). */
+export const throttling = policy(throttlingFactory);
+
+/** Apply the transient retry policy (retries all transient errors indefinitely). */
+export const transient = policy(transientFactory);