@emeryld/rrroutes-client 1.2.7 → 1.3.0

package/dist/routesV3.client.types.d.ts

@@ -53,16 +53,27 @@ export type RouteClientDebugEvent = (RouteClientDebugEventBase & {
 });
 /** Logger signature invoked when debug logging is enabled. */
 export type RouteClientDebugLogger = (event: RouteClientDebugEvent) => void;
-/** Toggle-specific configuration controlling which events log and whether verbose details are included. */
+/**
+ * Toggle-specific configuration controlling which debug events log, whether verbose details
+ * are emitted, and which named endpoints are allowed to log.
+ */
 export type RouteClientDebugToggleOptions<Names extends string = string> = Partial<Record<RouteClientDebugEvent['type'], boolean>> & {
     /** When true, include verbose metadata (same as `mode === 'complete'`). */
     verbose?: boolean;
     /** Optional logger override used instead of the default console logger. */
     logger?: RouteClientDebugLogger;
-    /** Limit logs to endpoints whose debug name is contained in this allow-list. */
+    /**
+     * Limit logs to endpoints whose debug name is contained in this allow-list.
+     * Provide the counterpart by passing `meta: { name: '<value>' }` as the third argument to `client.build`.
+     */
     only?: Names[];
 };
-/** Toggle or customize debug logging produced by the client. */
+/**
+ * Toggle or customize debug logging produced by the client.
+ * - Pass `true`/`'minimal'`/`'complete'` for simple modes.
+ * - Provide a custom logger function to redirect events.
+ * - Supply an object to enable individual event types, flip verbose mode, and/or limit logs via `only`.
+ */
 export type RouteClientDebugOptions<Names extends string = string> = boolean | RouteClientDebugLogger | RouteClientDebugMode | RouteClientDebugToggleOptions<Names>;
 /** Optional runtime environment; when set to 'production' logging is disabled. */
 export type RouteClientEnvironment = 'development' | 'production' | (string & {});
@@ -80,7 +91,10 @@ export type RouteClientOptions<Names extends string = string> = {
     getNextCursor?: (page: unknown) => Cursor;
     /** Optional debug logger for verbose insights (supports minimal/complete modes). */
     debug?: RouteClientDebugOptions<Names>;
-    /** Optional environment hint used to silence logging in production. */
+    /**
+     * Optional environment hint used to silence logging in production.
+     * When set to `'production'`, all debug logging is disabled regardless of the `debug` option.
+     */
     environment?: RouteClientEnvironment;
 };
 type OutputOf<L extends AnyLeaf> = InferOutput<L>;
@@ -93,6 +107,10 @@ export type MutationFetchArgs<L extends AnyLeaf> = [...ArgsTuple<L>, BodyOf<L>];
 export type MutationFetcher<L extends AnyLeaf> = (...args: MutationFetchArgs<L>) => Promise<OutputOf<L>>;
 /** Optional metadata provided when building a helper (used for debug filtering). */
 export type BuildMeta<Names extends string = string> = {
+    /**
+     * Logical name assigned to the built endpoint (e.g., the screen or feature name).
+     * Combine with `debug.only` to limit which endpoints emit logs.
+     */
     name?: Names;
 };
 /** Object shape the user passes to hooks and helpers (params/query are optional). */
@@ -177,16 +195,22 @@ export type RouteClient<Names extends string = string> = {
             cfg: {
                 feed: true;
             };
-        }>(leaf: L, opts?: InfiniteBuildOptionsFor<L>, meta?: BuildMeta<Names>): BuiltInfinite<L>;
+        }>(leaf: L, opts?: InfiniteBuildOptionsFor<L>, 
+        /** Optional metadata (third arg) to assign a debug name for filtering via `debug.only`. */
+        meta?: BuildMeta<Names>): BuiltInfinite<L>;
         <L extends AnyLeaf & {
             method: 'get';
             cfg: {
                 feed?: false | undefined;
             };
-        }>(leaf: L, opts?: QueryBuildOptionsFor<L>, meta?: BuildMeta<Names>): BuiltQuery<L>;
+        }>(leaf: L, opts?: QueryBuildOptionsFor<L>, 
+        /** Optional metadata (third arg) to assign a debug name for filtering via `debug.only`. */
+        meta?: BuildMeta<Names>): BuiltQuery<L>;
         <L extends AnyLeaf & {
             method: Exclude<HttpMethod, 'get'>;
-        }>(leaf: L, opts?: MutationBuildOptionsFor<L>, meta?: BuildMeta<Names>): BuiltMutation<L>;
+        }>(leaf: L, opts?: MutationBuildOptionsFor<L>, 
+        /** Optional metadata (third arg) to assign a debug name for filtering via `debug.only`. */
+        meta?: BuildMeta<Names>): BuiltMutation<L>;
     };
     /** Underlying React Query client (exposed for advanced scenarios). */
     queryClient: QueryClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emeryld/rrroutes-client",
-  "version": "1.2.7",
+  "version": "1.3.0",
   "private": false,
   "type": "module",
   "main": "dist/index.cjs",