deepline 0.3.422 → 0.3.424

package/dist/bundling-sources/shared_libs/plays/authoring-contract.ts

@@ -131,26 +131,27 @@ export const PLAY_AUTHORING_CONTRACT_CHANGELOG =
 
 /**
  * Customer-visible runtime capabilities that are not expressible as one
- * `ctx.*` signature. The generated authoring reference renders this inventory
+ * `deepline.*` signature. The generated authoring reference renders this inventory
  * directly; add a row here alongside any new supported runtime global or
  * execution-boundary guarantee.
  */
 export const PLAY_AUTHORING_RUNTIME_CAPABILITIES = [
   {
     capability: 'Durable external I/O',
-    surface: '`ctx.fetch`, `ctx.tools.execute`, `ctx.step`, `ctx.runPlay`',
+    surface:
+      '`deepline.fetch`, `deepline.tools.execute`, `deepline.step`, `deepline.runPlay`',
     contract:
-      'Use a `ctx.*` primitive for external work. Each primitive owns durable receipt identity and replay; raw I/O in an authored handler does not.',
+      'Use a `deepline.*` primitive for external work. Each primitive owns durable receipt identity and replay; raw I/O in play code does not.',
   },
   {
     capability: 'Web Crypto',
     surface: '`crypto.subtle`',
     contract:
-      'WebCrypto is available for standards-based signing, verification, encryption, and key import. Keep private material in `ctx.secrets`. `docs-examples/sdk-v2/github-app-jwt.play.ts` is an edition-10 compatibility example; edition 11 allows transient fetches only for read-only methods, so do not copy its credential-returning POST into new source.',
+      'WebCrypto is available for standards-based signing, verification, encryption, and key import. Keep private material in `deepline.secrets`. `docs-examples/sdk-v2/github-app-jwt.play.ts` is an edition-10 compatibility example; edition 11 allows transient fetches only for read-only methods, so do not copy its credential-returning POST into new source.',
   },
   {
     capability: 'Workspace secrets',
-    surface: '`ctx.secrets.get`, `.bearer`, `.header`',
+    surface: '`deepline.secrets.get`, `.bearer`, `.header`',
     contract:
       'Declare the secret at the Play boundary, read it only at runtime, and never return or log it. Secret-bearing HTTP requests require HTTPS.',
   },
@@ -850,7 +851,7 @@ export type PlayAuthoringBindings<TInput = Record<string, unknown>> = {
   /**
    * Play-level sandbox settings. The default deadline is 30 minutes; set a
    * static `timeout` such as `"90m"` or `"2h"` for a bounded batch, up to 4h.
-   * This is distinct from `ctx.tools.execute({ timeoutMs })`, which limits one
+   * This is distinct from `deepline.tools.execute({ timeoutMs })`, which limits one
    * provider-call transport rather than the whole Play.
    */
   runtime?: {
@@ -892,7 +893,7 @@ export type PlayToolCallOptions = Omit<
   'id' | 'tool' | 'input'
 >;
 
-/** @deprecated Pass a SQL string directly to ctx.customerDb.query. */
+/** @deprecated Pass a SQL string directly to deepline.customerDb.query. */
 export type PlaySqlQuery = {
   readonly kind: 'sql.query';
   readonly text: string;
@@ -903,7 +904,7 @@ declare const PLAY_SECRET_HANDLE_BRAND: unique symbol;
 declare const PLAY_SECRET_PROMISE_BRAND: unique symbol;
 /**
  * An opaque reference to a workspace secret used by legacy authoring-contract
- * editions. New Plays receive plaintext strings from `ctx.secrets.get`.
+ * editions. New Plays receive plaintext strings from `deepline.secrets.get`.
  *
  * @sdkReference runtime 176 SecretHandle
  */
@@ -916,14 +917,14 @@ export type PlaySecretHandle = {
   /** Always throws. A secret handle is deliberately not serializable. */
   toJSON(): never;
 };
-/** A secret-reading promise returned only by `ctx.secrets.get`. */
+/** A secret-reading promise returned only by `deepline.secrets.get`. */
 export type PlaySecretPromise = Promise<string> & {
   readonly [PLAY_SECRET_PROMISE_BRAND]: never;
 };
 /** An opaque legacy secret handle retained for earlier Play artifacts. */
 export type PlaySecretValue = PlaySecretHandle;
 /**
- * One resolved authentication scheme, built by `ctx.secrets.bearer` or `ctx.secrets.header` and attached to a request through `init.auth`.
+ * One resolved authentication scheme, built by `deepline.secrets.bearer` or `deepline.secrets.header` and attached to a request through `init.auth`.
  *
  * @sdkReference runtime 177 SecretAuth
  */
@@ -938,7 +939,7 @@ export type PlaySecretAuth = {
 /** One or more resolved authentication schemes for an outbound request. */
 export type PlaySecretAuthInput = PlaySecretAuth | readonly PlaySecretAuth[];
 /**
- * The `init` accepted by `ctx.fetch`. Same shape as `RequestInit` plus `auth`.
+ * The `init` accepted by `deepline.fetch`. Same shape as `RequestInit` plus `auth`.
  *
  * @sdkReference runtime 174 SecretAwareRequestInit
  */
@@ -946,7 +947,7 @@ export type PlaySecretAwareRequestInit = Omit<RequestInit, 'headers'> & {
   /** Ordinary request headers, recorded in the durable receipt with any resolved Play secret value redacted. Prefer `auth` for credentials: it enforces HTTPS and keeps the auth header out of the receipt. */
   headers?: HeadersInit;
   /**
-   * One or more credentialed headers for this request. Pass a single `ctx.secrets` auth for the common case, or an array when an API requires multiple credentialed headers. Auth-helper requests require HTTPS and omit the credential from the durable receipt. Each auth entry must target a distinct header.
+   * One or more credentialed headers for this request. Pass a single `deepline.secrets` auth for the common case, or an array when an API requires multiple credentialed headers. Auth-helper requests require HTTPS and omit the credential from the durable receipt. Each auth entry must target a distinct header.
    */
   auth?: PlaySecretAuthInput;
 };
@@ -1007,7 +1008,7 @@ export type PlayAuthoringStepResolver<Row, Value, TContext> = (
 export type PlayAuthoringDatasetColumnRunInput<Row, Value, TContext> = {
   /** Current row, including previously computed columns. */
   readonly row: Row;
-  /** Runtime context for tool, Play, fetch, and log calls. */
+  /** The play runtime, the same object as `deepline`. */
   readonly ctx: TContext;
   /** Zero-based row index for this dataset run. */
   readonly index: number;
@@ -1267,7 +1268,7 @@ export type PlayAuthoringReferenceLike<
   | { readonly playName: string; readonly name?: string }
   | { readonly name: string; readonly playName?: string }
 ) & {
-  /** Type-only input carrier used by ctx.runPlayAsync. */
+  /** Type-only input carrier used by deepline.runPlayAsync. */
   readonly __inputType?: TInput;
 };
 
@@ -1368,7 +1369,7 @@ export type PlayAuthoringRuntimeStepOptions = {
 };
 
 /**
- * Durable freshness for one `ctx.fetch` call. The key identifies the request;
+ * Durable freshness for one `deepline.fetch` call. The key identifies the request;
  * `staleAfterSeconds` controls when that completed request may be reused across
  * Play runs. Edition 11 requires an explicit choice: `null` reuses indefinitely,
  * `0` executes on every new run, and a positive whole number sets the maximum
@@ -1444,27 +1445,27 @@ export type PlayAuthoringRunScope = {
 export const PLAY_AUTHORING_DOCUMENTATION = {
   fetchBatching: {
     warning:
-      'A static ctx.fetch key inside a loop is a warning because every iteration must still have distinct method, URL, body, or safe headers. One durable receipt must never stand in for every request.',
+      'A static deepline.fetch key inside a loop is a warning because every iteration must still have distinct method, URL, body, or safe headers. One durable receipt must never stand in for every request.',
     guidance:
-      'Keep the static fetch label. For a mutating batch, make the body distinct and use a replay-stable external Idempotency-Key such as `${ctx.run.id}:signals:${batchIndex}`.',
+      'Keep the static fetch label. For a mutating batch, make the body distinct and use a replay-stable external Idempotency-Key such as `${deepline.run.id}:signals:${batchIndex}`.',
   },
   runId: {
     semantics:
-      'ctx.run.id is stable while Deepline retries or resumes one durable run. A separately submitted run receives a new id.',
+      'deepline.run.id is stable while Deepline retries or resumes one durable run. A separately submitted run receives a new id.',
     use: 'Use it when deriving an external idempotency key for a sequence of batches.',
   },
   staticCallKeys: {
     constraint:
-      'Durable call keys — the ctx.fetch key, the ctx.dataset key, the ctx.step id — must be static string literals. The key names a durable receipt, so check, publish, and replay have to agree on it before the body runs. A key computed at runtime cannot be resolved at check time and is rejected.',
+      'Durable call keys — the deepline.fetch key, the deepline.dataset key, the deepline.step id — must be static string literals. The key names a durable receipt, so check, publish, and replay have to agree on it before the body runs. A key computed at runtime cannot be resolved at check time and is rejected.',
     consequence:
       'This is an architectural constraint, not a style rule. A play cannot loop over a computed key, so it cannot page a large table with a helper like page(pageNumber). Unrolling one literal key per page is not a design at any real page count.',
     workaround:
-      'Push the aggregation server-side and call it once: a SQL function, a view, or a provider endpoint that returns the whole result. Keep unrolled literal keys only for a handful of genuinely distinct calls. To fan out over rows, use ctx.dataset with a static key — the per-row receipt identity comes from the row, not from the key.',
+      'Push the aggregation server-side and call it once: a SQL function, a view, or a provider endpoint that returns the whole result. Keep unrolled literal keys only for a handful of genuinely distinct calls. To fan out over rows, use deepline.dataset with a static key — the per-row receipt identity comes from the row, not from the key.',
   },
 } as const;
 
 /**
- * Shown when a ctx.fetch key is present but not statically resolvable. Named
+ * Shown when a deepline.fetch key is present but not statically resolvable. Named
  * separately so the field registry, the check hint, and the generated
  * reference cannot drift from one another.
  */
@@ -1479,14 +1480,14 @@ export interface PlayAuthoringRuntimeContext<
     /**
      * Read current workspace plan benefits. Execution rechecks admission;
      * this read is fresh and is not a durable receipt.
-     * @sdkReference runtime 179 ctx.billing.entitlements()
+     * @sdkReference runtime 179 deepline.billing.entitlements()
      */
     entitlements(): Promise<BillingEntitlements>;
   };
 
   /**
    * Load a staged CSV file as a durable dataset handle.
-   * @sdkReference runtime 040 ctx.csv(path, options)
+   * @sdkReference runtime 040 deepline.csv(path, options)
    */
   csv<T = Record<string, unknown>>(
     path: string | PlayAuthoringCsvInput<T & object>,
@@ -1495,7 +1496,7 @@ export interface PlayAuthoringRuntimeContext<
 
   /**
    * Create a persisted row dataset and define durable output columns.
-   * @sdkReference runtime 060 ctx.dataset(key, items)
+   * @sdkReference runtime 060 deepline.dataset(key, items)
    */
   dataset<TSource extends PlayDatasetInput<object>>(
     key: string,
@@ -1506,7 +1507,7 @@ export interface PlayAuthoringRuntimeContext<
     PlayAuthoringRuntimeContext<TListGetter>
   >;
 
-  /** @deprecated `ctx.map(...)` was replaced by `ctx.dataset(...)`. */
+  /** @deprecated `map(...)` was replaced by `dataset(...)`. */
   map<TSource extends PlayDatasetInput<object>>(
     key: string,
     items: TSource,
@@ -1524,7 +1525,7 @@ export interface PlayAuthoringRuntimeContext<
   tools: {
     /**
      * Execute a provider tool through the terminal-result cache contract.
-     * @sdkReference runtime 150 ctx.tools.execute(request)
+     * @sdkReference runtime 150 deepline.tools.execute(request)
      */
     execute<TOutput = PlayLooseObject>(
       request: PlayToolExecutionRequest,
@@ -1559,7 +1560,7 @@ export interface PlayAuthoringRuntimeContext<
 
   /**
    * Execute one reusable step program against a scalar input.
-   * @sdkReference runtime 180 ctx.runSteps(program, input, options)
+   * @sdkReference runtime 180 deepline.runSteps(program, input, options)
    */
   runSteps<TInput extends Record<string, unknown>, TOutput>(
     program: PlayAuthoringRunnableStepProgram<
@@ -1572,7 +1573,7 @@ export interface PlayAuthoringRuntimeContext<
 
   /**
    * Create one scalar durable checkpoint.
-   * @sdkReference runtime 130 ctx.step(id, fn)
+   * @sdkReference runtime 130 deepline.step(id, fn)
    */
   step<T>(
     id: string,
@@ -1583,7 +1584,7 @@ export interface PlayAuthoringRuntimeContext<
   /**
    * Execute a guarded HTTP request. Edition 11 requires an explicit freshness choice; only GET, HEAD, and OPTIONS can retain completed responses. Mutating methods must use `staleAfterSeconds: 0`; the choice governs only the completed call receipt, never dataset/request identity. Failed requests do not publish completed cache entries. A headers timeout leaves an upstream write's outcome unknown and does not establish whether its body was sent. The transport does not automatically retry that timed-out write, but a later invocation can execute it again. Mutating requests require provider-supported idempotency with the same key retained across retries and replay. Deadlines are platform-controlled; callers may cancel through `init.signal`. Pass `{ transient: true }` only on GET, HEAD, and OPTIONS when the response must not be retained in a receipt or checkpoint; edition 11 rejects transient writes. Edition 5+ throws `CtxFetchHttpError` for non-2xx; catch it only when the Play intentionally recovers, otherwise let it fail the Play. Editions 1–4 retain their previous response projections.
    *
-   * @sdkReference runtime 170 ctx.fetch(key, url, init)
+   * @sdkReference runtime 170 deepline.fetch(key, url, init)
    */
   fetch(
     key: string,
@@ -1596,7 +1597,7 @@ export interface PlayAuthoringRuntimeContext<
     /**
      * Read an allowed workspace secret inside the running Play; do not log or return it. Declare uppercase names in top-level `secrets`.
      *
-     * @sdkReference runtime 171 ctx.secrets.get(name)
+     * @sdkReference runtime 171 deepline.secrets.get(name)
      */
     get(name: string): PlaySecretPromise;
     /**
@@ -1604,7 +1605,7 @@ export interface PlayAuthoringRuntimeContext<
      * its direct promise remains accepted for source compatibility, while other
      * promises are rejected.
      *
-     * @sdkReference runtime 172 ctx.secrets.bearer(secret)
+     * @sdkReference runtime 172 deepline.secrets.bearer(secret)
      */
     bearer(
       secret: string | PlaySecretPromise | PlaySecretHandle,
@@ -1613,7 +1614,7 @@ export interface PlayAuthoringRuntimeContext<
      * Send a credential as a named header, for APIs that do not use bearer
      * tokens — `x-api-key`, `apikey`, `private-token`, and similar.
      *
-     * @sdkReference runtime 173 ctx.secrets.header(header, secret)
+     * @sdkReference runtime 173 deepline.secrets.header(header, secret)
      */
     header(
       header: string,
@@ -1623,7 +1624,7 @@ export interface PlayAuthoringRuntimeContext<
 
   /**
    * Compose another Play inline under a stable call key.
-   * @sdkReference runtime 140 ctx.runPlay(key, playRef, input, options)
+   * @sdkReference runtime 140 deepline.runPlay(key, playRef, input, options)
    */
   runPlay<TOutput = unknown>(
     key: string,
@@ -1634,14 +1635,14 @@ export interface PlayAuthoringRuntimeContext<
 
   /**
    * Admit an independent scalar Play Run and return its durable identity after scheduler admission, before child completion.
-   * @sdkReference runtime 141 ctx.runPlayAsync(key, playRef, input, options)
+   * @sdkReference runtime 141 deepline.runPlayAsync(key, playRef, input, options)
    */
   runPlayAsync<TInput extends Record<string, unknown>>(
     /** Replay-stable identity for this launch site and row scope. */
     key: string,
-    /** Independently published Play name or definePlay handle carrying its input type. */
+    /** Independently published Play name, or an imported play carrying its input type. */
     playRef: PlayAuthoringReferenceLike<TInput>,
-    /** Input checked against the referenced definePlay handle when available. */
+    /** Input checked against the imported play when available. */
     input: NoInfer<TInput>,
     /** Human-readable launch purpose recorded in the parent's step history. */
     options: PlayAuthoringAsyncCallOptions,