@cloudflare/workers-types 4.20260408.1 → 4.20260409.1

package/2022-03-21/index.d.ts

@@ -12000,6 +12000,140 @@ declare module "cloudflare:email" {
   };
   export { _EmailMessage as EmailMessage };
 }
+/**
+ * Evaluation context for targeting rules.
+ * Keys are attribute names (e.g. "userId", "country"), values are the attribute values.
+ */
+type EvaluationContext = Record<string, string | number | boolean>;
+interface EvaluationDetails<T> {
+  flagKey: string;
+  value: T;
+  variant?: string | undefined;
+  reason?: string | undefined;
+  errorCode?: string | undefined;
+  errorMessage?: string | undefined;
+}
+interface FlagEvaluationError extends Error {}
+/**
+ * Feature flags binding for evaluating feature flags from a Cloudflare Workers script.
+ *
+ * @example
+ * ```typescript
+ * // Get a boolean flag value with a default
+ * const enabled = await env.FLAGS.getBooleanValue('my-feature', false);
+ *
+ * // Get a flag value with evaluation context for targeting
+ * const variant = await env.FLAGS.getStringValue('experiment', 'control', {
+ *   userId: 'user-123',
+ *   country: 'US',
+ * });
+ *
+ * // Get full evaluation details including variant and reason
+ * const details = await env.FLAGS.getBooleanDetails('my-feature', false);
+ * console.log(details.variant, details.reason);
+ * ```
+ */
+declare abstract class Flags {
+  /**
+   * Get a flag value without type checking.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Optional default value returned when evaluation fails.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  get(
+    flagKey: string,
+    defaultValue?: unknown,
+    context?: EvaluationContext,
+  ): Promise<unknown>;
+  /**
+   * Get a boolean flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getBooleanValue(
+    flagKey: string,
+    defaultValue: boolean,
+    context?: EvaluationContext,
+  ): Promise<boolean>;
+  /**
+   * Get a string flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getStringValue(
+    flagKey: string,
+    defaultValue: string,
+    context?: EvaluationContext,
+  ): Promise<string>;
+  /**
+   * Get a number flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getNumberValue(
+    flagKey: string,
+    defaultValue: number,
+    context?: EvaluationContext,
+  ): Promise<number>;
+  /**
+   * Get an object flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getObjectValue<T extends object>(
+    flagKey: string,
+    defaultValue: T,
+    context?: EvaluationContext,
+  ): Promise<T>;
+  /**
+   * Get a boolean flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getBooleanDetails(
+    flagKey: string,
+    defaultValue: boolean,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<boolean>>;
+  /**
+   * Get a string flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getStringDetails(
+    flagKey: string,
+    defaultValue: string,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<string>>;
+  /**
+   * Get a number flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getNumberDetails(
+    flagKey: string,
+    defaultValue: number,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<number>>;
+  /**
+   * Get an object flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getObjectDetails<T extends object>(
+    flagKey: string,
+    defaultValue: T,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<T>>;
+}
 /**
  * Hello World binding to serve as an explanatory example. DO NOT USE
  */
@@ -13838,6 +13972,11 @@ declare namespace TailStream {
     readonly tag?: string;
     readonly message?: string;
   }
+  interface TracePreviewInfo {
+    readonly id: string;
+    readonly slug: string;
+    readonly name: string;
+  }
   interface Onset {
     readonly type: "onset";
     readonly attributes: Attribute[];
@@ -13849,6 +13988,7 @@ declare namespace TailStream {
     readonly scriptName?: string;
     readonly scriptTags?: string[];
     readonly scriptVersion?: ScriptVersion;
+    readonly preview?: TracePreviewInfo;
     readonly info:
       | FetchEventInfo
       | ConnectEventInfo

package/2022-03-21/index.ts

@@ -12016,6 +12016,140 @@ export declare type EmailExportedHandler<Env = unknown, Props = unknown> = (
   env: Env,
   ctx: ExecutionContext<Props>,
 ) => void | Promise<void>;
+/**
+ * Evaluation context for targeting rules.
+ * Keys are attribute names (e.g. "userId", "country"), values are the attribute values.
+ */
+export type EvaluationContext = Record<string, string | number | boolean>;
+export interface EvaluationDetails<T> {
+  flagKey: string;
+  value: T;
+  variant?: string | undefined;
+  reason?: string | undefined;
+  errorCode?: string | undefined;
+  errorMessage?: string | undefined;
+}
+export interface FlagEvaluationError extends Error {}
+/**
+ * Feature flags binding for evaluating feature flags from a Cloudflare Workers script.
+ *
+ * @example
+ * ```typescript
+ * // Get a boolean flag value with a default
+ * const enabled = await env.FLAGS.getBooleanValue('my-feature', false);
+ *
+ * // Get a flag value with evaluation context for targeting
+ * const variant = await env.FLAGS.getStringValue('experiment', 'control', {
+ *   userId: 'user-123',
+ *   country: 'US',
+ * });
+ *
+ * // Get full evaluation details including variant and reason
+ * const details = await env.FLAGS.getBooleanDetails('my-feature', false);
+ * console.log(details.variant, details.reason);
+ * ```
+ */
+export declare abstract class Flags {
+  /**
+   * Get a flag value without type checking.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Optional default value returned when evaluation fails.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  get(
+    flagKey: string,
+    defaultValue?: unknown,
+    context?: EvaluationContext,
+  ): Promise<unknown>;
+  /**
+   * Get a boolean flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getBooleanValue(
+    flagKey: string,
+    defaultValue: boolean,
+    context?: EvaluationContext,
+  ): Promise<boolean>;
+  /**
+   * Get a string flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getStringValue(
+    flagKey: string,
+    defaultValue: string,
+    context?: EvaluationContext,
+  ): Promise<string>;
+  /**
+   * Get a number flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getNumberValue(
+    flagKey: string,
+    defaultValue: number,
+    context?: EvaluationContext,
+  ): Promise<number>;
+  /**
+   * Get an object flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getObjectValue<T extends object>(
+    flagKey: string,
+    defaultValue: T,
+    context?: EvaluationContext,
+  ): Promise<T>;
+  /**
+   * Get a boolean flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getBooleanDetails(
+    flagKey: string,
+    defaultValue: boolean,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<boolean>>;
+  /**
+   * Get a string flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getStringDetails(
+    flagKey: string,
+    defaultValue: string,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<string>>;
+  /**
+   * Get a number flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getNumberDetails(
+    flagKey: string,
+    defaultValue: number,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<number>>;
+  /**
+   * Get an object flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getObjectDetails<T extends object>(
+    flagKey: string,
+    defaultValue: T,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<T>>;
+}
 /**
  * Hello World binding to serve as an explanatory example. DO NOT USE
  */
@@ -13795,6 +13929,11 @@ export declare namespace TailStream {
     readonly tag?: string;
     readonly message?: string;
   }
+  interface TracePreviewInfo {
+    readonly id: string;
+    readonly slug: string;
+    readonly name: string;
+  }
   interface Onset {
     readonly type: "onset";
     readonly attributes: Attribute[];
@@ -13806,6 +13945,7 @@ export declare namespace TailStream {
     readonly scriptName?: string;
     readonly scriptTags?: string[];
     readonly scriptVersion?: ScriptVersion;
+    readonly preview?: TracePreviewInfo;
     readonly info:
       | FetchEventInfo
       | ConnectEventInfo

package/2022-08-04/index.d.ts

@@ -12001,6 +12001,140 @@ declare module "cloudflare:email" {
   };
   export { _EmailMessage as EmailMessage };
 }
+/**
+ * Evaluation context for targeting rules.
+ * Keys are attribute names (e.g. "userId", "country"), values are the attribute values.
+ */
+type EvaluationContext = Record<string, string | number | boolean>;
+interface EvaluationDetails<T> {
+  flagKey: string;
+  value: T;
+  variant?: string | undefined;
+  reason?: string | undefined;
+  errorCode?: string | undefined;
+  errorMessage?: string | undefined;
+}
+interface FlagEvaluationError extends Error {}
+/**
+ * Feature flags binding for evaluating feature flags from a Cloudflare Workers script.
+ *
+ * @example
+ * ```typescript
+ * // Get a boolean flag value with a default
+ * const enabled = await env.FLAGS.getBooleanValue('my-feature', false);
+ *
+ * // Get a flag value with evaluation context for targeting
+ * const variant = await env.FLAGS.getStringValue('experiment', 'control', {
+ *   userId: 'user-123',
+ *   country: 'US',
+ * });
+ *
+ * // Get full evaluation details including variant and reason
+ * const details = await env.FLAGS.getBooleanDetails('my-feature', false);
+ * console.log(details.variant, details.reason);
+ * ```
+ */
+declare abstract class Flags {
+  /**
+   * Get a flag value without type checking.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Optional default value returned when evaluation fails.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  get(
+    flagKey: string,
+    defaultValue?: unknown,
+    context?: EvaluationContext,
+  ): Promise<unknown>;
+  /**
+   * Get a boolean flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getBooleanValue(
+    flagKey: string,
+    defaultValue: boolean,
+    context?: EvaluationContext,
+  ): Promise<boolean>;
+  /**
+   * Get a string flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getStringValue(
+    flagKey: string,
+    defaultValue: string,
+    context?: EvaluationContext,
+  ): Promise<string>;
+  /**
+   * Get a number flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getNumberValue(
+    flagKey: string,
+    defaultValue: number,
+    context?: EvaluationContext,
+  ): Promise<number>;
+  /**
+   * Get an object flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getObjectValue<T extends object>(
+    flagKey: string,
+    defaultValue: T,
+    context?: EvaluationContext,
+  ): Promise<T>;
+  /**
+   * Get a boolean flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getBooleanDetails(
+    flagKey: string,
+    defaultValue: boolean,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<boolean>>;
+  /**
+   * Get a string flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getStringDetails(
+    flagKey: string,
+    defaultValue: string,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<string>>;
+  /**
+   * Get a number flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getNumberDetails(
+    flagKey: string,
+    defaultValue: number,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<number>>;
+  /**
+   * Get an object flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getObjectDetails<T extends object>(
+    flagKey: string,
+    defaultValue: T,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<T>>;
+}
 /**
  * Hello World binding to serve as an explanatory example. DO NOT USE
  */
@@ -13839,6 +13973,11 @@ declare namespace TailStream {
     readonly tag?: string;
     readonly message?: string;
   }
+  interface TracePreviewInfo {
+    readonly id: string;
+    readonly slug: string;
+    readonly name: string;
+  }
   interface Onset {
     readonly type: "onset";
     readonly attributes: Attribute[];
@@ -13850,6 +13989,7 @@ declare namespace TailStream {
     readonly scriptName?: string;
     readonly scriptTags?: string[];
     readonly scriptVersion?: ScriptVersion;
+    readonly preview?: TracePreviewInfo;
     readonly info:
       | FetchEventInfo
       | ConnectEventInfo

package/2022-08-04/index.ts

@@ -12017,6 +12017,140 @@ export declare type EmailExportedHandler<Env = unknown, Props = unknown> = (
   env: Env,
   ctx: ExecutionContext<Props>,
 ) => void | Promise<void>;
+/**
+ * Evaluation context for targeting rules.
+ * Keys are attribute names (e.g. "userId", "country"), values are the attribute values.
+ */
+export type EvaluationContext = Record<string, string | number | boolean>;
+export interface EvaluationDetails<T> {
+  flagKey: string;
+  value: T;
+  variant?: string | undefined;
+  reason?: string | undefined;
+  errorCode?: string | undefined;
+  errorMessage?: string | undefined;
+}
+export interface FlagEvaluationError extends Error {}
+/**
+ * Feature flags binding for evaluating feature flags from a Cloudflare Workers script.
+ *
+ * @example
+ * ```typescript
+ * // Get a boolean flag value with a default
+ * const enabled = await env.FLAGS.getBooleanValue('my-feature', false);
+ *
+ * // Get a flag value with evaluation context for targeting
+ * const variant = await env.FLAGS.getStringValue('experiment', 'control', {
+ *   userId: 'user-123',
+ *   country: 'US',
+ * });
+ *
+ * // Get full evaluation details including variant and reason
+ * const details = await env.FLAGS.getBooleanDetails('my-feature', false);
+ * console.log(details.variant, details.reason);
+ * ```
+ */
+export declare abstract class Flags {
+  /**
+   * Get a flag value without type checking.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Optional default value returned when evaluation fails.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  get(
+    flagKey: string,
+    defaultValue?: unknown,
+    context?: EvaluationContext,
+  ): Promise<unknown>;
+  /**
+   * Get a boolean flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getBooleanValue(
+    flagKey: string,
+    defaultValue: boolean,
+    context?: EvaluationContext,
+  ): Promise<boolean>;
+  /**
+   * Get a string flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getStringValue(
+    flagKey: string,
+    defaultValue: string,
+    context?: EvaluationContext,
+  ): Promise<string>;
+  /**
+   * Get a number flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getNumberValue(
+    flagKey: string,
+    defaultValue: number,
+    context?: EvaluationContext,
+  ): Promise<number>;
+  /**
+   * Get an object flag value.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getObjectValue<T extends object>(
+    flagKey: string,
+    defaultValue: T,
+    context?: EvaluationContext,
+  ): Promise<T>;
+  /**
+   * Get a boolean flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getBooleanDetails(
+    flagKey: string,
+    defaultValue: boolean,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<boolean>>;
+  /**
+   * Get a string flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getStringDetails(
+    flagKey: string,
+    defaultValue: string,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<string>>;
+  /**
+   * Get a number flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getNumberDetails(
+    flagKey: string,
+    defaultValue: number,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<number>>;
+  /**
+   * Get an object flag value with full evaluation details.
+   * @param flagKey The key of the flag to evaluate.
+   * @param defaultValue Default value returned when evaluation fails or the flag type does not match.
+   * @param context Optional evaluation context for targeting rules.
+   */
+  getObjectDetails<T extends object>(
+    flagKey: string,
+    defaultValue: T,
+    context?: EvaluationContext,
+  ): Promise<EvaluationDetails<T>>;
+}
 /**
  * Hello World binding to serve as an explanatory example. DO NOT USE
  */
@@ -13796,6 +13930,11 @@ export declare namespace TailStream {
     readonly tag?: string;
     readonly message?: string;
   }
+  interface TracePreviewInfo {
+    readonly id: string;
+    readonly slug: string;
+    readonly name: string;
+  }
   interface Onset {
     readonly type: "onset";
     readonly attributes: Attribute[];
@@ -13807,6 +13946,7 @@ export declare namespace TailStream {
     readonly scriptName?: string;
     readonly scriptTags?: string[];
     readonly scriptVersion?: ScriptVersion;
+    readonly preview?: TracePreviewInfo;
     readonly info:
       | FetchEventInfo
       | ConnectEventInfo