@bitfab/sdk 0.31.0 → 0.32.0

package/dist/index.d.cts

@@ -629,6 +629,10 @@ declare class BitfabOpenAIAgentHandler {
  * `env.databaseUrl` (and friends) to pick up the per-trace branch URL the
  * Bitfab service resolved from the source trace's snapshot reference.
  *
+ * The constructor takes how each branch should be sized and warmed. That lives
+ * here rather than on the replay options because the settings only mean
+ * anything for a replay that has an environment.
+ *
  * Outside replay, accessing `env.databaseUrl` throws. Customer code uses
  * the env only on the replay path; live request code keeps reading
  * `process.env.DATABASE_URL` the normal way.
@@ -649,7 +653,42 @@ interface ReplayEnvironmentSnapshot {
     region?: string;
     traceId: string;
 }
+/**
+ * Per-lease settings for the DB-snapshot branch a replay item runs against.
+ * Passed to the `ReplayEnvironment` constructor, since branching only happens
+ * for a replay that has an environment.
+ */
+interface DbBranchOptions {
+    /**
+     * Autoscaling floor for the branch's compute, in Neon Compute Units (0.25 to
+     * 56). Omit to keep the mirror project's own default. Raise it when the
+     * mirror is provisioned smaller than the database it stands in for, so
+     * replay latency reflects your code rather than a cold, undersized branch.
+     */
+    minCu?: number;
+    /**
+     * Autoscaling ceiling for the branch's compute, in Neon Compute Units.
+     * Setting it equal to `minCu` pins the size, which keeps items comparable:
+     * otherwise a later item can run against an endpoint that has already
+     * scaled up and post a better number for the same code.
+     */
+    maxCu?: number;
+    /**
+     * SQL that warms the branch's cache. The server appends it to the branch's
+     * readiness check, so it runs BEFORE your function sees the lease and its
+     * time is not charged to the replayed call. Invalid SQL fails the lease
+     * rather than silently leaving the branch cold.
+     */
+    warmupSql?: string;
+}
 declare class ReplayEnvironment {
+    /**
+     * The branch settings this environment was constructed with, readable
+     * anywhere. Every other accessor reports the lease the server resolved and
+     * is therefore replay-only.
+     */
+    readonly dbBranch: DbBranchOptions;
+    constructor(options?: DbBranchOptions);
     /**
      * The per-trace branch URL for the item currently being replayed.
      * Throws if read outside a replay item.
@@ -698,33 +737,6 @@ declare class ReplayEnvironment {
  */
 
 type MockStrategy = "none" | "all" | "marked";
-/**
- * Per-lease settings for the DB-snapshot branch a replay item runs against.
- * Only read when `environment` is set, since that is what turns branching on.
- */
-interface DbBranchOptions {
-    /**
-     * Autoscaling floor for the branch's compute, in Neon Compute Units (0.25 to
-     * 56). Omit to keep the mirror project's own default. Raise it when the
-     * mirror is provisioned smaller than the database it stands in for, so
-     * replay latency reflects your code rather than a cold, undersized branch.
-     */
-    minCu?: number;
-    /**
-     * Autoscaling ceiling for the branch's compute, in Neon Compute Units.
-     * Setting it equal to `minCu` pins the size, which keeps items comparable:
-     * otherwise a later item can run against an endpoint that has already
-     * scaled up and post a better number for the same code.
-     */
-    maxCu?: number;
-    /**
-     * SQL that warms the branch's cache. The server appends it to the branch's
-     * readiness check, so it runs BEFORE your function sees the lease and its
-     * time is not charged to the replayed call. Invalid SQL fails the lease
-     * rather than silently leaving the branch cold.
-     */
-    warmupSql?: string;
-}
 interface ReplayOptions {
     /**
      * Maximum number of traces to replay (1-100, default 5). Ignored when
@@ -770,11 +782,10 @@ interface ReplayOptions {
      * Per-trace environment. When the source trace carries a DB branching
      * snapshot, the SDK populates `environment.databaseUrl` before invoking
      * `fn` for that item and resets it after. Customer code reads from the
-     * environment to pick up the per-trace branch URL.
+     * environment to pick up the per-trace branch URL. Compute size and cache
+     * warm-up for each branch are configured on the environment's constructor.
      */
     environment?: ReplayEnvironment;
-    /** Compute size and cache warm-up for the per-item DB snapshot branch. */
-    dbBranch?: DbBranchOptions;
     /** Group ID to associate this replay with an experiment group for live streaming in Studio. */
     experimentGroupId?: string;
     /**
@@ -1843,7 +1854,7 @@ declare class BitfabFunction {
 /**
  * SDK version from package.json (injected at build time)
  */
-declare const __version__ = "0.31.0";
+declare const __version__ = "0.32.0";
 
 /**
  * Constants for the Bitfab SDK.

package/dist/index.d.ts

@@ -629,6 +629,10 @@ declare class BitfabOpenAIAgentHandler {
  * `env.databaseUrl` (and friends) to pick up the per-trace branch URL the
  * Bitfab service resolved from the source trace's snapshot reference.
  *
+ * The constructor takes how each branch should be sized and warmed. That lives
+ * here rather than on the replay options because the settings only mean
+ * anything for a replay that has an environment.
+ *
  * Outside replay, accessing `env.databaseUrl` throws. Customer code uses
  * the env only on the replay path; live request code keeps reading
  * `process.env.DATABASE_URL` the normal way.
@@ -649,7 +653,42 @@ interface ReplayEnvironmentSnapshot {
     region?: string;
     traceId: string;
 }
+/**
+ * Per-lease settings for the DB-snapshot branch a replay item runs against.
+ * Passed to the `ReplayEnvironment` constructor, since branching only happens
+ * for a replay that has an environment.
+ */
+interface DbBranchOptions {
+    /**
+     * Autoscaling floor for the branch's compute, in Neon Compute Units (0.25 to
+     * 56). Omit to keep the mirror project's own default. Raise it when the
+     * mirror is provisioned smaller than the database it stands in for, so
+     * replay latency reflects your code rather than a cold, undersized branch.
+     */
+    minCu?: number;
+    /**
+     * Autoscaling ceiling for the branch's compute, in Neon Compute Units.
+     * Setting it equal to `minCu` pins the size, which keeps items comparable:
+     * otherwise a later item can run against an endpoint that has already
+     * scaled up and post a better number for the same code.
+     */
+    maxCu?: number;
+    /**
+     * SQL that warms the branch's cache. The server appends it to the branch's
+     * readiness check, so it runs BEFORE your function sees the lease and its
+     * time is not charged to the replayed call. Invalid SQL fails the lease
+     * rather than silently leaving the branch cold.
+     */
+    warmupSql?: string;
+}
 declare class ReplayEnvironment {
+    /**
+     * The branch settings this environment was constructed with, readable
+     * anywhere. Every other accessor reports the lease the server resolved and
+     * is therefore replay-only.
+     */
+    readonly dbBranch: DbBranchOptions;
+    constructor(options?: DbBranchOptions);
     /**
      * The per-trace branch URL for the item currently being replayed.
      * Throws if read outside a replay item.
@@ -698,33 +737,6 @@ declare class ReplayEnvironment {
  */
 
 type MockStrategy = "none" | "all" | "marked";
-/**
- * Per-lease settings for the DB-snapshot branch a replay item runs against.
- * Only read when `environment` is set, since that is what turns branching on.
- */
-interface DbBranchOptions {
-    /**
-     * Autoscaling floor for the branch's compute, in Neon Compute Units (0.25 to
-     * 56). Omit to keep the mirror project's own default. Raise it when the
-     * mirror is provisioned smaller than the database it stands in for, so
-     * replay latency reflects your code rather than a cold, undersized branch.
-     */
-    minCu?: number;
-    /**
-     * Autoscaling ceiling for the branch's compute, in Neon Compute Units.
-     * Setting it equal to `minCu` pins the size, which keeps items comparable:
-     * otherwise a later item can run against an endpoint that has already
-     * scaled up and post a better number for the same code.
-     */
-    maxCu?: number;
-    /**
-     * SQL that warms the branch's cache. The server appends it to the branch's
-     * readiness check, so it runs BEFORE your function sees the lease and its
-     * time is not charged to the replayed call. Invalid SQL fails the lease
-     * rather than silently leaving the branch cold.
-     */
-    warmupSql?: string;
-}
 interface ReplayOptions {
     /**
      * Maximum number of traces to replay (1-100, default 5). Ignored when
@@ -770,11 +782,10 @@ interface ReplayOptions {
      * Per-trace environment. When the source trace carries a DB branching
      * snapshot, the SDK populates `environment.databaseUrl` before invoking
      * `fn` for that item and resets it after. Customer code reads from the
-     * environment to pick up the per-trace branch URL.
+     * environment to pick up the per-trace branch URL. Compute size and cache
+     * warm-up for each branch are configured on the environment's constructor.
      */
     environment?: ReplayEnvironment;
-    /** Compute size and cache warm-up for the per-item DB snapshot branch. */
-    dbBranch?: DbBranchOptions;
     /** Group ID to associate this replay with an experiment group for live streaming in Studio. */
     experimentGroupId?: string;
     /**
@@ -1843,7 +1854,7 @@ declare class BitfabFunction {
 /**
  * SDK version from package.json (injected at build time)
  */
-declare const __version__ = "0.31.0";
+declare const __version__ = "0.32.0";
 
 /**
  * Constants for the Bitfab SDK.

package/dist/index.js

@@ -14,12 +14,12 @@ import {
   flushTraces,
   getCurrentSpan,
   getCurrentTrace
-} from "./chunk-A7K5JOBV.js";
+} from "./chunk-YZZO475T.js";
 import {
   BITFAB_PROGRESS_PREFIX,
   BitfabError,
   reportReplayProgress
-} from "./chunk-6UJ3E3H5.js";
+} from "./chunk-NMNVPON4.js";
 export {
   BITFAB_PROGRESS_PREFIX,
   Bitfab,

package/dist/node.cjs

@@ -531,14 +531,15 @@ __export(replay_exports, {
   replay: () => replay,
   reportReplayProgress: () => reportReplayProgress
 });
-function resolveDbBranchSettings(dbBranch) {
-  if (!dbBranch) {
+function resolveDbBranchSettings(environment) {
+  if (!environment) {
     return void 0;
   }
+  const { minCu, maxCu, warmupSql } = environment.dbBranch;
   const settings = {
-    ...dbBranch.minCu === void 0 ? {} : { minCu: dbBranch.minCu },
-    ...dbBranch.maxCu === void 0 ? {} : { maxCu: dbBranch.maxCu },
-    ...dbBranch.warmupSql === void 0 ? {} : { warmupSql: dbBranch.warmupSql }
+    ...minCu === void 0 ? {} : { minCu },
+    ...maxCu === void 0 ? {} : { maxCu },
+    ...warmupSql === void 0 ? {} : { warmupSql }
   };
   return Object.keys(settings).length === 0 ? void 0 : settings;
 }
@@ -792,7 +793,7 @@ async function replay(httpClient, serviceUrl, traceFunctionKey, fn, options, reg
     options?.experimentGroupId,
     options?.datasetId,
     options?.graderIds,
-    resolveDbBranchSettings(options?.dbBranch)
+    resolveDbBranchSettings(options?.environment)
   );
   const mockStrategy = options?.mock ?? "marked";
   const maxConcurrency = options?.maxConcurrency ?? 10;
@@ -986,7 +987,7 @@ registerAsyncLocalStorageClass(
 );
 
 // src/version.generated.ts
-var __version__ = "0.31.0";
+var __version__ = "0.32.0";
 
 // src/constants.ts
 var DEFAULT_SERVICE_URL = "https://bitfab.ai";
@@ -3082,6 +3083,9 @@ init_replayContext();
 // src/replayEnvironment.ts
 init_replayContext();
 var ReplayEnvironment = class {
+  constructor(options = {}) {
+    this.dbBranch = { ...options };
+  }
   /**
    * The per-trace branch URL for the item currently being replayed.
    * Throws if read outside a replay item.