@gaganref/confect-core 10.3.1-fork.9 → 10.3.1-fork.90

package/dist/FunctionSpec.d.ts

@@ -1,8 +1,9 @@
 import type * as MiddlewareAttachment from "./MiddlewareAttachment.js";
 import type { DefaultFunctionArgs, FunctionType, FunctionVisibility, RegisteredAction, RegisteredMutation, RegisteredQuery } from "convex/server";
-import type * as Schema from "effect/Schema";
+import * as Schema from "effect/Schema";
 import * as FunctionProvenance from "./FunctionProvenance.js";
-import type * as MiddlewareSpec from "./MiddlewareSpec.js";
+import * as MiddlewareSpec from "./MiddlewareSpec.js";
+import type * as Profile from "./Profile.js";
 import * as RuntimeAndFunctionType from "./RuntimeAndFunctionType.js";
 export declare const TypeId = "~@confect/core/FunctionSpec";
 export type TypeId = typeof TypeId;
@@ -12,6 +13,7 @@ export interface FunctionSpec<RuntimeAndFunctionType_ extends RuntimeAndFunction
     readonly runtimeAndFunctionType: RuntimeAndFunctionType_;
     readonly functionVisibility: FunctionVisibility_;
     readonly name: Name_;
+    readonly reservedArgument?: string;
     readonly functionProvenance: FunctionProvenance_;
     readonly middlewareSpecs: ReadonlyArray<MiddlewareSpecs_>;
     readonly middlewareAttachments: ReadonlyArray<MiddlewareAttachment.MiddlewareAttachment<MiddlewareSpecs_>>;
@@ -19,10 +21,24 @@ export interface FunctionSpec<RuntimeAndFunctionType_ extends RuntimeAndFunction
 export interface Builder<RuntimeAndFunctionType_ extends RuntimeAndFunctionType.RuntimeAndFunctionType, FunctionVisibility_ extends FunctionVisibility, Name_ extends string, FunctionProvenance_ extends FunctionProvenance.FunctionProvenance, MiddlewareSpecs_ extends MiddlewareSpec.AnyMiddlewareSpec = never> extends FunctionSpec<RuntimeAndFunctionType_, FunctionVisibility_, Name_, FunctionProvenance_, MiddlewareSpecs_> {
     middleware<MiddlewareSpec_ extends MiddlewareSpec.AnyMiddlewareSpec>(middlewareSpec: MiddlewareSpec_ & MiddlewareSpec.ValidateFunctionAttach<MiddlewareSpec_, RuntimeAndFunctionType_, FunctionProvenance_, MiddlewareSpecs_>, ...options: MiddlewareAttachment.Args<NoInfer<MiddlewareSpec_>>): Builder<RuntimeAndFunctionType_, FunctionVisibility_, Name_, FunctionProvenance_, MiddlewareSpecs_ | MiddlewareSpec_>;
 }
+export interface DescribedBuilder<RuntimeAndFunctionType_ extends RuntimeAndFunctionType.RuntimeAndFunctionType, FunctionVisibility_ extends FunctionVisibility, Name_ extends string, FunctionProvenance_ extends FunctionProvenance.FunctionProvenance, MiddlewareSpecs_ extends MiddlewareSpec.AnyMiddlewareSpec = never> extends Builder<RuntimeAndFunctionType_, FunctionVisibility_, Name_, FunctionProvenance_, MiddlewareSpecs_> {
+    readonly description?: string;
+    middleware<MiddlewareSpec_ extends MiddlewareSpec.AnyMiddlewareSpec>(middlewareSpec: MiddlewareSpec_ & MiddlewareSpec.ValidateFunctionAttach<MiddlewareSpec_, RuntimeAndFunctionType_, FunctionProvenance_, MiddlewareSpecs_>, ...options: MiddlewareAttachment.Args<NoInfer<MiddlewareSpec_>>): DescribedBuilder<RuntimeAndFunctionType_, FunctionVisibility_, Name_, FunctionProvenance_, MiddlewareSpecs_ | MiddlewareSpec_>;
+}
+/**
+ * A spec built through {@link extend}, keeping its fields through middleware.
+ */
+export interface ExtendedBuilder<RuntimeAndFunctionType_ extends RuntimeAndFunctionType.RuntimeAndFunctionType, FunctionVisibility_ extends FunctionVisibility, Name_ extends string, FunctionProvenance_ extends FunctionProvenance.FunctionProvenance, MiddlewareSpecs_ extends MiddlewareSpec.AnyMiddlewareSpec, Fields_> extends Builder<RuntimeAndFunctionType_, FunctionVisibility_, Name_, FunctionProvenance_, MiddlewareSpecs_> {
+    readonly description?: string;
+    readonly fields: Profile.Info<Fields_>["fields"];
+    middleware<MiddlewareSpec_ extends MiddlewareSpec.AnyMiddlewareSpec>(middlewareSpec: MiddlewareSpec_ & MiddlewareSpec.ValidateFunctionAttach<MiddlewareSpec_, RuntimeAndFunctionType_, FunctionProvenance_, MiddlewareSpecs_>, ...options: MiddlewareAttachment.Args<NoInfer<MiddlewareSpec_>>): ExtendedBuilder<RuntimeAndFunctionType_, FunctionVisibility_, Name_, FunctionProvenance_, MiddlewareSpecs_ | MiddlewareSpec_, Fields_>;
+}
 export interface Any {
     readonly [TypeId]: TypeId;
 }
 export interface AnyWithProps extends FunctionSpec<RuntimeAndFunctionType.RuntimeAndFunctionType, FunctionVisibility, string, FunctionProvenance.FunctionProvenance, MiddlewareSpec.AnyMiddlewareSpec> {
+    readonly description?: string;
+    readonly fields?: object;
 }
 export interface AnyConfect extends FunctionSpec<RuntimeAndFunctionType.RuntimeAndFunctionType, FunctionVisibility, string, FunctionProvenance.AnyConfect, MiddlewareSpec.AnyMiddlewareSpec> {
 }
@@ -128,7 +144,9 @@ type ForbidPaginationOpts<UserArgsFields extends FunctionProvenance.ArgsFields>
 } : unknown;
 export declare const publicQuery: {
     <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: never;
         name: Name_;
+        description?: never;
         args: () => ArgsFields_;
         returns: () => Returns_;
         error?: () => Error_;
@@ -137,7 +155,9 @@ export declare const publicQuery: {
         readonly functionType: "query";
     }, "public", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
     <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: never;
         name: Name_;
+        description?: never;
         args?: never;
         returns: () => Returns_;
         error?: () => Error_;
@@ -145,10 +165,34 @@ export declare const publicQuery: {
         readonly runtime: "Convex";
         readonly functionType: "query";
     }, "public", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: never;
+        name: Name_;
+        description?: string;
+        args: () => ArgsFields_;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "query";
+    }, "public", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: never;
+        name: Name_;
+        description?: string;
+        args?: never;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "query";
+    }, "public", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
 };
 export declare const internalQuery: {
     <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: never;
         name: Name_;
+        description?: never;
         args: () => ArgsFields_;
         returns: () => Returns_;
         error?: () => Error_;
@@ -157,7 +201,9 @@ export declare const internalQuery: {
         readonly functionType: "query";
     }, "internal", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
     <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: never;
         name: Name_;
+        description?: never;
         args?: never;
         returns: () => Returns_;
         error?: () => Error_;
@@ -165,10 +211,33 @@ export declare const internalQuery: {
         readonly runtime: "Convex";
         readonly functionType: "query";
     }, "internal", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: never;
+        name: Name_;
+        description?: never;
+        args: () => ArgsFields_;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "query";
+    }, "internal", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: never;
+        name: Name_;
+        description?: never;
+        args?: never;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "query";
+    }, "internal", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
 };
 export declare const publicPaginatedQuery: {
     <const Name_ extends string, const UserArgsFields_ extends FunctionProvenance.ArgsFields, Item_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
         name: Name_;
+        description?: never;
         args: () => UserArgsFields_ & ForbidPaginationOpts<UserArgsFields_>;
         item: () => Item_;
         error?: () => Error_;
@@ -178,6 +247,7 @@ export declare const publicPaginatedQuery: {
     }, "public", Name_, FunctionProvenance.ConfectPaginated<UserArgsFields_, Item_, Error_>, never>;
     <const Name_ extends string, Item_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
         name: Name_;
+        description?: never;
         args?: never;
         item: () => Item_;
         error?: () => Error_;
@@ -185,10 +255,31 @@ export declare const publicPaginatedQuery: {
         readonly runtime: "Convex";
         readonly functionType: "query";
     }, "public", Name_, FunctionProvenance.ConfectPaginated<{}, Item_, Error_>, never>;
+    <const Name_ extends string, const UserArgsFields_ extends FunctionProvenance.ArgsFields, Item_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        name: Name_;
+        description?: string;
+        args: () => UserArgsFields_ & ForbidPaginationOpts<UserArgsFields_>;
+        item: () => Item_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "query";
+    }, "public", Name_, FunctionProvenance.ConfectPaginated<UserArgsFields_, Item_, Error_>, never>;
+    <const Name_ extends string, Item_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        name: Name_;
+        description?: string;
+        args?: never;
+        item: () => Item_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "query";
+    }, "public", Name_, FunctionProvenance.ConfectPaginated<{}, Item_, Error_>, never>;
 };
 export declare const internalPaginatedQuery: {
     <const Name_ extends string, const UserArgsFields_ extends FunctionProvenance.ArgsFields, Item_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
         name: Name_;
+        description?: never;
         args: () => UserArgsFields_ & ForbidPaginationOpts<UserArgsFields_>;
         item: () => Item_;
         error?: () => Error_;
@@ -198,6 +289,7 @@ export declare const internalPaginatedQuery: {
     }, "internal", Name_, FunctionProvenance.ConfectPaginated<UserArgsFields_, Item_, Error_>, never>;
     <const Name_ extends string, Item_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
         name: Name_;
+        description?: never;
         args?: never;
         item: () => Item_;
         error?: () => Error_;
@@ -205,10 +297,32 @@ export declare const internalPaginatedQuery: {
         readonly runtime: "Convex";
         readonly functionType: "query";
     }, "internal", Name_, FunctionProvenance.ConfectPaginated<{}, Item_, Error_>, never>;
+    <const Name_ extends string, const UserArgsFields_ extends FunctionProvenance.ArgsFields, Item_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        name: Name_;
+        description?: never;
+        args: () => UserArgsFields_ & ForbidPaginationOpts<UserArgsFields_>;
+        item: () => Item_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "query";
+    }, "internal", Name_, FunctionProvenance.ConfectPaginated<UserArgsFields_, Item_, Error_>, never>;
+    <const Name_ extends string, Item_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        name: Name_;
+        description?: never;
+        args?: never;
+        item: () => Item_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "query";
+    }, "internal", Name_, FunctionProvenance.ConfectPaginated<{}, Item_, Error_>, never>;
 };
 export declare const publicMutation: {
     <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args: () => ArgsFields_;
         returns: () => Returns_;
         error?: () => Error_;
@@ -217,7 +331,9 @@ export declare const publicMutation: {
         readonly functionType: "mutation";
     }, "public", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
     <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args?: never;
         returns: () => Returns_;
         error?: () => Error_;
@@ -225,10 +341,34 @@ export declare const publicMutation: {
         readonly runtime: "Convex";
         readonly functionType: "mutation";
     }, "public", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: string;
+        args: () => ArgsFields_;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "mutation";
+    }, "public", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: string;
+        args?: never;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "mutation";
+    }, "public", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
 };
 export declare const internalMutation: {
     <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args: () => ArgsFields_;
         returns: () => Returns_;
         error?: () => Error_;
@@ -237,7 +377,9 @@ export declare const internalMutation: {
         readonly functionType: "mutation";
     }, "internal", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
     <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args?: never;
         returns: () => Returns_;
         error?: () => Error_;
@@ -245,10 +387,34 @@ export declare const internalMutation: {
         readonly runtime: "Convex";
         readonly functionType: "mutation";
     }, "internal", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: never;
+        args: () => ArgsFields_;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "mutation";
+    }, "internal", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: never;
+        args?: never;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "mutation";
+    }, "internal", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
 };
 export declare const publicAction: {
     <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args: () => ArgsFields_;
         returns: () => Returns_;
         error?: () => Error_;
@@ -257,7 +423,9 @@ export declare const publicAction: {
         readonly functionType: "action";
     }, "public", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
     <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args?: never;
         returns: () => Returns_;
         error?: () => Error_;
@@ -265,10 +433,34 @@ export declare const publicAction: {
         readonly runtime: "Convex";
         readonly functionType: "action";
     }, "public", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: string;
+        args: () => ArgsFields_;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "action";
+    }, "public", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: string;
+        args?: never;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "action";
+    }, "public", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
 };
 export declare const internalAction: {
     <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args: () => ArgsFields_;
         returns: () => Returns_;
         error?: () => Error_;
@@ -277,7 +469,9 @@ export declare const internalAction: {
         readonly functionType: "action";
     }, "internal", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
     <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args?: never;
         returns: () => Returns_;
         error?: () => Error_;
@@ -285,10 +479,34 @@ export declare const internalAction: {
         readonly runtime: "Convex";
         readonly functionType: "action";
     }, "internal", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: never;
+        args: () => ArgsFields_;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "action";
+    }, "internal", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: never;
+        args?: never;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Convex";
+        readonly functionType: "action";
+    }, "internal", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
 };
 export declare const publicNodeAction: {
     <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args: () => ArgsFields_;
         returns: () => Returns_;
         error?: () => Error_;
@@ -297,7 +515,9 @@ export declare const publicNodeAction: {
         readonly functionType: "action";
     }, "public", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
     <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args?: never;
         returns: () => Returns_;
         error?: () => Error_;
@@ -305,10 +525,34 @@ export declare const publicNodeAction: {
         readonly runtime: "Node";
         readonly functionType: "action";
     }, "public", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: string;
+        args: () => ArgsFields_;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Node";
+        readonly functionType: "action";
+    }, "public", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: string;
+        args?: never;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Node";
+        readonly functionType: "action";
+    }, "public", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
 };
 export declare const internalNodeAction: {
     <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args: () => ArgsFields_;
         returns: () => Returns_;
         error?: () => Error_;
@@ -317,7 +561,9 @@ export declare const internalNodeAction: {
         readonly functionType: "action";
     }, "internal", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
     <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
         name: Name_;
+        description?: never;
         args?: never;
         returns: () => Returns_;
         error?: () => Error_;
@@ -325,7 +571,120 @@ export declare const internalNodeAction: {
         readonly runtime: "Node";
         readonly functionType: "action";
     }, "internal", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: never;
+        args: () => ArgsFields_;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Node";
+        readonly functionType: "action";
+    }, "internal", Name_, FunctionProvenance.Confect<ArgsFields_, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+    <const Name_ extends string, Returns_ extends Schema.Codec<any, any>, Error_ extends Schema.Codec<any, any> = never>(options: {
+        reservedArgument?: string;
+        name: Name_;
+        description?: never;
+        args?: never;
+        returns: () => Returns_;
+        error?: () => Error_;
+    }): DescribedBuilder<{
+        readonly runtime: "Node";
+        readonly functionType: "action";
+    }, "internal", Name_, FunctionProvenance.Confect<{}, Returns_, Error_, FunctionProvenance.ConfectKind>, never>;
+};
+type OptionlessMiddlewareSpec = MiddlewareSpec.AnyMiddlewareSpec & {
+    readonly "~Options": never;
+};
+type BuilderOption = "name" | "description" | "args" | "returns" | "item" | "error";
+/**
+ * Only a required description string may name a builder option. The builder
+ * reads it as that option. The conditional keeps the mapped type out of a
+ * builder call's inference, which would otherwise widen the function's name to
+ * `string` when reporting the error.
+ */
+type OptionFree<Type> = [keyof Type & BuilderOption] extends [never] ? unknown : {
+    readonly [Option in keyof Type & BuilderOption as Option extends "description" ? Type[Option] extends string ? string extends Type[Option] ? never : Option : Option : Option]: never;
 };
+/**
+ * A function's fields, checked once applied, since a profile's field type can
+ * branch on the function's name.
+ */
+type CheckedFields<Type> = Type & OptionFree<Type>;
+type NotRepeated<Middleware_, Inherited extends MiddlewareSpec.AnyMiddlewareSpec> = Middleware_ extends {
+    readonly key: infer Key extends MiddlewareSpec.Key<Inherited>;
+} ? MiddlewareSpec.AttachmentError<`Middleware "${Key}" is already attached by this profile`> : Middleware_;
+/**
+ * Refuses a middleware without options that an earlier layer attached, as it is
+ * attached at most once; one with options may repeat. Each member of an
+ * element's union is checked, so an array typed `(A | B)[]` is refused when
+ * either was attached.
+ */
+type NotInherited<Middleware_ extends ReadonlyArray<unknown>, Inherited extends MiddlewareSpec.AnyMiddlewareSpec> = {
+    readonly [Index in keyof Middleware_]: NotRepeated<Middleware_[Index], Inherited>;
+};
+/**
+ * A profile's middleware: a spec without options, or an attachment.
+ */
+type ProfileMiddleware<FieldsType> = OptionlessMiddlewareSpec | Profile.Attachment<MiddlewareSpec.AnyMiddlewareSpec, FieldsType>;
+type SpecOf<Middleware_> = Middleware_ extends Profile.Attachment<infer MiddlewareSpec_, any> ? MiddlewareSpec_ : Extract<Middleware_, MiddlewareSpec.AnyMiddlewareSpec>;
+/**
+ * `never` when a profile middleware does not declare the function type.
+ */
+type Declared<MiddlewareSpecs_ extends MiddlewareSpec.AnyMiddlewareSpec, FunctionType_ extends FunctionType, Make> = [
+    MiddlewareSpecs_ extends unknown ? FunctionType_ extends MiddlewareSpec.FunctionTypes<MiddlewareSpecs_> ? never : MiddlewareSpecs_ : never
+] extends [never] ? Make : never;
+type Wrapped<Layers extends ReadonlyArray<Profile.Transforms>, Key extends keyof Profile.Transforms, Input> = Layers extends readonly [
+    infer First extends Profile.Transforms,
+    ...infer Rest extends ReadonlyArray<Profile.Transforms>
+] ? Wrapped<Rest, Key, Key extends keyof First ? [Input] extends [never] ? Key extends "error" ? Profile.Transform<First[Key], typeof Schema.Never> : never : Profile.Transform<First[Key], Input> : Input> : Input;
+type UserArgs<A> = [A] extends [never] ? {} : A;
+type ExtendedMake<RuntimeAndFunctionType_ extends RuntimeAndFunctionType.RuntimeAndFunctionType, Fields_ extends Profile.Fields, MiddlewareSpecs_ extends MiddlewareSpec.AnyMiddlewareSpec, Layers extends ReadonlyArray<Profile.Transforms>> = Declared<MiddlewareSpecs_, RuntimeAndFunctionType_["functionType"], <const Name_ extends string, const ArgsFields_ extends FunctionProvenance.ArgsFields = never, Returns_ extends Schema.Codec<any, any> = never, Error_ extends Schema.Codec<any, any> = never>(options: {
+    readonly name: Name_;
+    readonly description?: string;
+    readonly args?: () => ArgsFields_;
+    readonly returns: () => Returns_;
+    readonly error?: () => Error_;
+} & NoInfer<CheckedFields<Profile.Apply<Fields_, Name_, UserArgs<ArgsFields_>>>>) => ExtendedBuilder<RuntimeAndFunctionType_, "public", Name_, FunctionProvenance.Confect<UserArgs<Wrapped<Layers, "args", ArgsFields_>>, Wrapped<Layers, "returns", Returns_>, Wrapped<Layers, "error", Error_>>, MiddlewareSpecs_, Profile.Apply<Fields_, Name_, UserArgs<ArgsFields_>>>>;
+type ExtendedMakePaginated<Fields_ extends Profile.Fields, MiddlewareSpecs_ extends MiddlewareSpec.AnyMiddlewareSpec, Layers extends ReadonlyArray<Profile.Transforms>> = Declared<MiddlewareSpecs_, "query", <const Name_ extends string, const UserArgsFields_ extends FunctionProvenance.ArgsFields = never, Item_ extends Schema.Codec<any, any> = never, Error_ extends Schema.Codec<any, any> = never>(options: {
+    readonly name: Name_;
+    readonly description?: string;
+    readonly args?: () => UserArgsFields_ & ForbidPaginationOpts<UserArgsFields_>;
+    readonly item: () => Item_;
+    readonly error?: () => Error_;
+} & NoInfer<CheckedFields<Profile.Apply<Fields_, Name_, UserArgs<UserArgsFields_>>>>) => ExtendedBuilder<RuntimeAndFunctionType.ConvexQuery, "public", Name_, FunctionProvenance.ConfectPaginated<UserArgs<Wrapped<Layers, "args", UserArgsFields_>>, Wrapped<Layers, "item", Item_>, Wrapped<Layers, "error", Error_>>, MiddlewareSpecs_, Profile.Apply<Fields_, Name_, UserArgs<UserArgsFields_>>>>;
+interface ExtendedRuntimes {
+    readonly publicQuery: RuntimeAndFunctionType.ConvexQuery;
+    readonly publicMutation: RuntimeAndFunctionType.ConvexMutation;
+    readonly publicAction: RuntimeAndFunctionType.ConvexAction;
+    readonly publicNodeAction: RuntimeAndFunctionType.NodeAction;
+}
+/**
+ * A profile's five public builders and its own `extend`.
+ */
+export type Extended<Fields_ extends Profile.Fields, MiddlewareSpecs_ extends MiddlewareSpec.AnyMiddlewareSpec, Layers extends ReadonlyArray<Profile.Transforms> = []> = {
+    readonly [Builder_ in keyof ExtendedRuntimes]: ExtendedMake<ExtendedRuntimes[Builder_], Fields_, MiddlewareSpecs_, Layers>;
+} & {
+    readonly publicPaginatedQuery: ExtendedMakePaginated<Fields_, MiddlewareSpecs_, Layers>;
+    /**
+     * Require more fields and attach more middleware after this profile's.
+     */
+    extend<Extension extends Profile.Fields = Profile.NoFields, Transforms extends Profile.Transforms = {}>(): <const Middleware_ extends ReadonlyArray<ProfileMiddleware<Profile.Apply<Profile.Both<Fields_, Extension>, string, any>>>>(config: {
+        readonly reservedArgument?: string;
+        readonly middleware: Middleware_ & NotInherited<Middleware_, MiddlewareSpecs_>;
+    } & OptionFree<Extension["Type"]> & Profile.SchemaConfig<Transforms, Profile.Apply<Profile.Both<Fields_, Extension>, string, any>>) => Extended<Profile.Both<Fields_, Extension>, MiddlewareSpecs_ | SpecOf<Middleware_[number]>, [
+        ...Layers,
+        Transforms
+    ]>;
+};
+/**
+ * Public builders whose specs require and keep `Fields_`, with `middleware`.
+ */
+export declare const extend: <Fields_ extends Profile.Fields = Profile.NoFields, Transforms extends Profile.Transforms = {}>() => <const Middleware_ extends ReadonlyArray<ProfileMiddleware<Profile.Apply<Fields_, string, any>>>>(config: {
+    readonly reservedArgument?: string;
+    readonly middleware: Middleware_;
+} & OptionFree<Fields_["Type"]> & Profile.SchemaConfig<Transforms, Profile.Apply<Fields_, string, any>>) => Extended<Fields_, SpecOf<Middleware_[number]>, [Transforms]>;
 type MatchingRegisteredFunction<RuntimeAndFunctionType_ extends RuntimeAndFunctionType.RuntimeAndFunctionType, FunctionVisibility_ extends FunctionVisibility> = RuntimeAndFunctionType.GetFunctionType<RuntimeAndFunctionType_> extends "query" ? RegisteredQuery<FunctionVisibility_, any, any> : RuntimeAndFunctionType.GetFunctionType<RuntimeAndFunctionType_> extends "mutation" ? RegisteredMutation<FunctionVisibility_, any, any> : RuntimeAndFunctionType.GetFunctionType<RuntimeAndFunctionType_> extends "action" ? RegisteredAction<FunctionVisibility_, any, any> : never;
 type ExtractArgs<F> = F extends RegisteredQuery<any, infer A extends DefaultFunctionArgs, any> ? A : F extends RegisteredMutation<any, infer A extends DefaultFunctionArgs, any> ? A : F extends RegisteredAction<any, infer A extends DefaultFunctionArgs, any> ? A : never;
 type ExtractReturns<F> = F extends RegisteredQuery<any, any, infer R> ? R : F extends RegisteredMutation<any, any, infer R> ? R : F extends RegisteredAction<any, any, infer R> ? R : never;