@toggld/node 0.1.0 → 0.3.0

package/dist/types-RmWNnA7-.d.mts

@@ -1,85 +0,0 @@
-//#region ../spec/src/index.d.ts
-/**
- * A resolved flag value. OpenFeature permits `boolean | string | number |
- * structure`; we model the union as JSON, which also covers arrays and null for
- * "object" typed flags.
- */
-type FlagValue = null | boolean | number | string | ReadonlyArray<FlagValue> | {
-  readonly [key: string]: FlagValue;
-};
-/**
- * Flag metadata: "arbitrary properties, with keys of type string, and values of
- * type boolean, string, or number." (Requirement 2.2.10)
- */
-type MetadataValue = string | number | boolean;
-type FlagMetadata = {
-  readonly [key: string]: MetadataValue;
-};
-/**
- * An OpenFeature evaluation context: an optional `targetingKey` identifying the
- * subject (Requirement 3.1.1) plus arbitrary custom JSON-valued attributes
- * (Requirement 3.1.2).
- */
-type EvaluationContext = {
-  readonly [attribute: string]: FlagValue;
-};
-/**
- * Resolution reasons. (Requirement 2.2.5)
- */
-type Reason = "STATIC" | "DEFAULT" | "TARGETING_MATCH" | "SPLIT" | "CACHED" | "DISABLED" | "UNKNOWN" | "STALE" | "ERROR";
-/**
- * OpenFeature error codes.
- * @see https://openfeature.dev/specification/types
- */
-type ErrorCode = "PROVIDER_NOT_READY" | "PROVIDER_FATAL" | "FLAG_NOT_FOUND" | "PARSE_ERROR" | "TYPE_MISMATCH" | "TARGETING_KEY_MISSING" | "INVALID_CONTEXT" | "GENERAL";
-//#endregion
-//#region src/internal/types.d.ts
-/** Configuration for a {@link https://toggld.io Toggld} client. */
-interface ToggldClientOptions {
-  /**
-   * An **evaluation** (or management) API key, sent as `Authorization: Bearer
-   * <sdkKey>`. The key is scoped to one tenant + environment server-side, so a
-   * client always evaluates against exactly that environment.
-   */
-  readonly sdkKey: string;
-  /**
-   * Base URL of the flag API, e.g. `https://toggld-api.example.workers.dev` or
-   * `http://localhost:3000` in local development. No trailing path — the client
-   * appends the OFREP routes (`/ofrep/v1/...`).
-   */
-  readonly endpoint: string;
-  /**
-   * Attributes merged into the evaluation context of **every** request, under
-   * any per-call context (per-call attributes win on key collision). Handy for
-   * process-wide dimensions such as `region` or `serviceVersion`.
-   */
-  readonly defaultContext?: EvaluationContext;
-  /** Per-request timeout in milliseconds. Default `5000`. */
-  readonly timeoutMs?: number;
-  /**
-   * Custom `fetch` implementation. Defaults to the global `fetch`. Useful for
-   * tests, proxies, or injecting retries/instrumentation.
-   */
-  readonly fetch?: typeof globalThis.fetch;
-}
-/**
- * The outcome of evaluating a single flag — OpenFeature "evaluation details"
- * with a value typed to the requested flag type. Mirrors {@link
- * https://openfeature.dev/specification/sections/evaluation-details}.
- *
- * On any abnormal evaluation (network failure, unknown flag, type mismatch, a
- * server-reported error) the call still resolves: `value` holds the caller's
- * default, `reason` is `"ERROR"`, and `errorCode`/`errorMessage` describe what
- * went wrong. Evaluation never throws.
- */
-interface EvaluationDetails<T extends FlagValue> {
-  readonly flagKey: string;
-  readonly value: T;
-  readonly variant: string | undefined;
-  readonly reason: Reason;
-  readonly errorCode: ErrorCode | undefined;
-  readonly errorMessage: string | undefined;
-  readonly flagMetadata: FlagMetadata;
-}
-//#endregion
-export { FlagMetadata as a, EvaluationContext as i, ToggldClientOptions as n, FlagValue as o, ErrorCode as r, Reason as s, EvaluationDetails as t };