@procedures/client 0.39.0 → 0.41.0

package/src/procedures/core/object.ts

@@ -2,7 +2,7 @@
  * Object Procedures
  *
  * Object manipulation operations for procedure aggregation.
- * All procedures are namespaced under "client" (e.g., client.get, client.set).
+ * The namespace of all these procedures is "client": for example client.get and client.set.
  */
 
 import { z } from "zod";

package/src/procedures/core/string.ts

@@ -2,7 +2,7 @@
  * String Procedures
  *
  * String manipulation operations for procedure aggregation.
- * All procedures are namespaced under "client" (e.g., client.concat, client.split).
+ * The namespace of all these procedures is "client": for example client.concat and client.split.
  */
 
 import { z } from "zod";

package/src/procedures/core/type.ts

@@ -2,7 +2,7 @@
  * Type Procedures
  *
  * Type checking and coercion operations for procedure aggregation.
- * All procedures are namespaced under "client" (e.g., client.typeof, client.isArray).
+ * The namespace of all these procedures is "client": for example client.typeof and client.isArray.
  */
 
 import { z } from "zod";

package/src/procedures/define-procedure.ts

@@ -575,7 +575,7 @@ export const deleteProcedureProcedure: Procedure<
     // A code procedure stays (deep dive CORE-3: before, delete only forgot the runtime record)
     if (!isRuntimeDefined(existing)) {
       throw new Error(
-        `procedure.delete removes only a procedure that procedure.define made: ${input.path.join(".")} is a code procedure.`
+        `procedure.delete removes only a procedure that procedure.define made: ${pathToKey(input.path)} is a code procedure.`
       );
     }
     return { deleted: registry.unregister(input.path) };

package/src/procedures/module.ts

@@ -21,7 +21,7 @@
 import { PROCEDURE_REGISTRY, ProcedureRegistry, RegistryError } from "./registry.js";
 import { coreProcedures } from "./core/index.js";
 import { metaProcedures as definitionProcedures } from "./define-procedure.js";
-import type { AnyProcedure, ProcedureModule, RegistrationOptions } from "./types.js";
+import { pathToKey, type AnyProcedure, type ProcedureModule, type RegistrationOptions } from "./types.js";
 
 /**
  * The procedures of `@procedures/client`: the control flow (`client.chain`, `client.map` and the
@@ -121,7 +121,7 @@ export function registerModules(
       if (existing && !options?.override) {
         if (existing.handler === procedure.handler) continue;
         throw new RegistryError(
-          `Two modules give the procedure ${path.join(".")}: the second one is ${module.name ?? "a module without a name"}`,
+          `Two modules give the procedure ${pathToKey(path)}: the second one is ${module.name ?? "a module without a name"}`,
           path
         );
       }

package/src/procedures/ref.ts

@@ -234,7 +234,7 @@ export function lookupOutputRef(refPath: string, scope: RefScope | undefined): {
 /**
  * Resolve an output reference within a scope.
  *
- * @param refPath - The reference path (e.g., "stageName.value" or "$last.value")
+ * @param refPath - The reference path (for example "stageName.value" or "$last.value")
  * @param scope - The current scope to resolve within
  * @returns The resolved value, or undefined if not found
  */
@@ -434,12 +434,12 @@ export function getRefName(ref: AnyProcedureRef): string | undefined {
 }
 
 /**
- * Check if a procedure reference should be executed in the given context.
+ * This function tells if a procedure reference runs at this time in the given context.
  *
  * @param ref - The procedure reference to check
  * @param contextStack - Stack of named contexts (innermost first)
  * @param isParentContext - Whether we're checking from a parent procedure
- * @returns true if the ref should be executed now
+ * @returns true if the ref runs at this time
  */
 export function shouldExecuteRef(
   ref: AnyProcedureRef,
@@ -503,7 +503,7 @@ export class ProcedureRefBuilder<TInput = unknown, TOutput = unknown> {
   }
 
   /**
-   * Set when this reference should be executed.
+   * This method sets when this reference runs.
    * @param when - "$immediate", "$never", "$parent", or a named context
    */
   when(when: ProcedureWhen): this {

package/src/procedures/types.ts

@@ -293,7 +293,7 @@ export interface RepositoryProvider {
  * Contains request metadata and service access.
  */
 export interface ProcedureContext {
-  /** Request metadata (auth, tracing, etc.) */
+  /** The request metadata, for example the authentication and the trace. */
   metadata: Record<string, unknown>;
 
   /** Abort signal for cancellation */
@@ -593,7 +593,7 @@ export interface Procedure<
 
   /**
    * Whether this procedure supports streaming (multi-yield).
-   * When true, the handler is expected to be a generator that may yield multiple times.
+   * When true, the handler is a generator that can yield more than one time.
    * When false or undefined, the procedure yields exactly once.
    *
    * This is a capability declaration - callers can still consume