@confect/core 10.0.0-next.2 → 10.0.0-next.20

package/dist/MiddlewareSpec.d.ts

@@ -0,0 +1,184 @@
+import type { FunctionType, FunctionVisibility } from "convex/server";
+import type * as Effect from "effect/Effect";
+import type * as Schema from "effect/Schema";
+import type { unhandled } from "effect/Types";
+import type * as FunctionProvenance from "./FunctionProvenance";
+import type * as FunctionSpec from "./FunctionSpec";
+import type * as RuntimeAndFunctionType from "./RuntimeAndFunctionType";
+export declare const TypeId = "~@confect/core/MiddlewareSpec";
+export type TypeId = typeof TypeId;
+export declare const isMiddlewareSpec: (u: unknown) => u is AnyMiddlewareSpec;
+export declare const allFunctionTypes: ReadonlyArray<FunctionType>;
+export interface SupportedFunctionTypes {
+    readonly query: boolean;
+    readonly mutation: boolean;
+    readonly action: boolean;
+}
+/**
+ * Marker success type used by middleware to represent the handler's outcome
+ * without exposing its concrete success value.
+ *
+ * Mirrors `RpcMiddleware.SuccessValue` in Effect.
+ */
+export interface SuccessValue {
+    readonly _: unique symbol;
+}
+/**
+ * The wrap-style middleware implementation shape: receives the downstream
+ * effect (the remaining middleware plus the function handler) and the
+ * covered invocation's metadata, and returns the effect that runs in its
+ * place.
+ *
+ * Mirrors `RpcMiddleware.RpcMiddleware` in Effect.
+ */
+export interface MiddlewareImpl<Provides_, E, R> {
+    (effect: Effect.Effect<SuccessValue, E | unhandled, Provides_>, options: MiddlewareOptions): Effect.Effect<SuccessValue, E | unhandled, R>;
+}
+export interface MiddlewareOptions {
+    readonly name: string;
+    readonly functionType: FunctionType;
+    readonly functionVisibility: FunctionVisibility;
+    readonly args: unknown;
+}
+export interface AnyMiddlewareImpl extends MiddlewareImpl<any, any, any> {
+}
+/**
+ * The class shape produced by {@link MiddlewareSpec}. Only the static side is ever
+ * used — the class is a value-level carrier for the middleware's key, its
+ * declared functionTypes, and its (lazily-evaluated) error schema, plus the
+ * type-level `Provides`/`Error` metadata. It is deliberately not a
+ * `Context.Tag`: implementations are registered through the group `Registry`
+ * (like `FunctionImpl`s), not resolved from a Layer context.
+ */
+export interface MiddlewareSpec<in out Self, Key_ extends string, Provides_, Requires_, ErrorSchema_ extends Schema.Codec<any, any>, FunctionTypes_ extends FunctionType> {
+    new (_: never): {
+        readonly [TypeId]: TypeId;
+        readonly key: Key_;
+    };
+    readonly [TypeId]: TypeId;
+    readonly key: Key_;
+    readonly functionTypes: SupportedFunctionTypes;
+    readonly error?: ErrorSchema_;
+    readonly "~Provides": Provides_;
+    readonly "~Requires": Requires_;
+    readonly "~Error": ErrorSchema_;
+    readonly "~FunctionTypes": FunctionTypes_;
+    readonly "~Self": Self;
+}
+export interface AnyMiddlewareSpec {
+    readonly [TypeId]: TypeId;
+    readonly key: string;
+    readonly functionTypes: SupportedFunctionTypes;
+    readonly error?: Schema.Codec<any, any>;
+    readonly "~Provides": any;
+    readonly "~Requires": any;
+    readonly "~Error": any;
+    readonly "~FunctionTypes": FunctionType;
+}
+export type Key<MiddlewareSpec_ extends AnyMiddlewareSpec> = MiddlewareSpec_["key"];
+export type Provides<MiddlewareSpec_ extends AnyMiddlewareSpec> = MiddlewareSpec_ extends AnyMiddlewareSpec ? MiddlewareSpec_["~Provides"] : never;
+/**
+ * The services a middleware's implementation may consume from middleware
+ * that runs earlier in the same chain (type-level only, like `provides`).
+ */
+export type Requires<MiddlewareSpec_ extends AnyMiddlewareSpec> = MiddlewareSpec_ extends AnyMiddlewareSpec ? MiddlewareSpec_["~Requires"] : never;
+export type ErrorSchema<MiddlewareSpec_ extends AnyMiddlewareSpec> = MiddlewareSpec_ extends AnyMiddlewareSpec ? MiddlewareSpec_["~Error"] : never;
+export type Error<MiddlewareSpec_ extends AnyMiddlewareSpec> = MiddlewareSpec_ extends AnyMiddlewareSpec ? MiddlewareSpec_["~Error"]["Type"] : never;
+export type EncodedError<MiddlewareSpec_ extends AnyMiddlewareSpec> = MiddlewareSpec_ extends AnyMiddlewareSpec ? MiddlewareSpec_["~Error"]["Encoded"] : never;
+export type FunctionTypes<MiddlewareSpec_ extends AnyMiddlewareSpec> = MiddlewareSpec_ extends AnyMiddlewareSpec ? MiddlewareSpec_["~FunctionTypes"] : never;
+/**
+ * Declare a middleware's client-safe interface: its identifying key, the
+ * service it provides to downstream handlers, the error schema its failures
+ * encode through, and the function types it may attach to.
+ *
+ * ```ts
+ * class RequireUser extends MiddlewareSpec.MiddlewareSpec<RequireUser, {
+ *   provides: CurrentUser
+ * }>()("RequireUser", {
+ *   error: () => NotSignedIn,
+ *   functionTypes: { query: true, mutation: true, action: false },
+ * }) {}
+ * ```
+ *
+ * The implementation is server-only and supplied separately via
+ * `MiddlewareImpl.make` (or `makeByFunctionType`/`provides`) in `@confect/server`.
+ */
+export declare const MiddlewareSpec: <Self, Config extends {
+    provides?: any;
+    requires?: any;
+} = {}>() => <const Key_ extends string, const FunctionTypesConfig_ extends SupportedFunctionTypes, ErrorSchema_ extends Schema.Codec<any, any> = never>(key: Key_, options: {
+    readonly error?: () => ErrorSchema_;
+    readonly functionTypes: FunctionTypesConfig_ & ValidateFunctionTypesConfig<FunctionTypesConfig_>;
+}) => MiddlewareSpec<Self, Key_, "provides" extends keyof Config ? Config["provides"] : never, "requires" extends keyof Config ? Config["requires"] : never, ErrorSchema_, FunctionTypesFromConfig<FunctionTypesConfig_>>;
+type FunctionTypesFromConfig<Config extends SupportedFunctionTypes> = {
+    [K in FunctionType]: Config[K] extends true ? K : never;
+}[FunctionType];
+type ValidateFunctionTypesConfig<Config extends SupportedFunctionTypes> = ValidationResult<{
+    [K in keyof Config]: boolean extends Config[K] ? AttachmentError<`Function type flag "${K & string}" must be a literal \`true\` or \`false\`, not a computed \`boolean\``> : never;
+}[keyof Config] | ([FunctionTypesFromConfig<Config>] extends [never] ? AttachmentError<`A middleware must declare at least one function type`> : never)>;
+export declare const errorSchemas: (middlewareSpecs: ReadonlyArray<AnyMiddlewareSpec>) => ReadonlyArray<Schema.Codec<any, any>>;
+/**
+ * A branded, unconstructible type carrying a spec-authoring error message.
+ * Surfaced as (part of) a parameter type so the diagnostic names the exact
+ * problem at the `.middleware()` / `.addFunction()` call site.
+ */
+export interface AttachmentError<Message extends string> {
+    readonly "~@confect/core/MiddlewareSpec/AttachmentError": Message;
+}
+type FunctionTypeOf<FunctionSpec_ extends FunctionSpec.AnyWithProps> = FunctionSpec_["runtimeAndFunctionType"]["functionType"];
+type ValidationResult<Errors> = [Errors] extends [never] ? unknown : Errors;
+/**
+ * A matching-type Convex-provenance function is rejected rather than
+ * silently skipped: its raw handler passes through Confect untouched, so
+ * the middleware could not actually cover it, and skipping it would be a
+ * policy hole.
+ */
+export type ValidateFunction<FunctionSpec_ extends FunctionSpec.AnyWithProps, MiddlewareSpec_ extends AnyMiddlewareSpec> = FunctionSpec_ extends any ? MiddlewareSpec_ extends any ? FunctionSpec_ extends {
+    readonly functionProvenance: {
+        readonly _tag: "Convex";
+    };
+} ? FunctionTypeOf<FunctionSpec_> extends FunctionTypes<MiddlewareSpec_> ? AttachmentError<`Convex-provenance function "${FunctionSpec_["name"]}" cannot be covered by middleware "${Key<MiddlewareSpec_>}" — attach middleware only to groups whose matching-type functions are all Confect-provenance`> : never : [
+    Extract<FunctionSpec.MiddlewareSpecs<FunctionSpec_>, {
+        readonly key: Key<MiddlewareSpec_>;
+    }>
+] extends [never] ? FunctionTypeOf<FunctionSpec_> extends FunctionTypes<MiddlewareSpec_> ? never : AttachmentError<`Middleware "${Key<MiddlewareSpec_>}" does not declare function type "${FunctionTypeOf<FunctionSpec_>}", the type of function "${FunctionSpec_["name"]}"`> : AttachmentError<`Middleware "${Key<MiddlewareSpec_>}" is already attached to function "${FunctionSpec_["name"]}"`> : never : never;
+/**
+ * Attachment order is chain order, so requiring `requires` to be satisfied
+ * by already-attached middleware is exactly requiring the provider to run
+ * earlier.
+ */
+export type ValidateAttach<MiddlewareSpec_ extends AnyMiddlewareSpec, Functions_ extends FunctionSpec.AnyWithProps, MiddlewareSpecs_ extends AnyMiddlewareSpec> = [
+    Extract<MiddlewareSpecs_, {
+        readonly key: Key<MiddlewareSpec_>;
+    }>
+] extends [never] ? [Exclude<Requires<MiddlewareSpec_>, Provides<MiddlewareSpecs_>>] extends [
+    never
+] ? ValidationResult<ValidateFunction<Functions_, MiddlewareSpec_>> : AttachmentError<`Middleware "${Key<MiddlewareSpec_>}" requires services that no middleware attached earlier to this group provides — attach the providing middleware first`> : AttachmentError<`Middleware "${Key<MiddlewareSpec_>}" is already attached to this group`>;
+export type ValidateAddedFunction<FunctionSpec_ extends FunctionSpec.AnyWithProps, MiddlewareSpecs_ extends AnyMiddlewareSpec> = [MiddlewareSpecs_] extends [never] ? unknown : ValidationResult<ValidateFunction<FunctionSpec_, MiddlewareSpecs_> | GroupOverlap<FunctionSpec_, MiddlewareSpecs_>>;
+type GroupOverlap<FunctionSpec_ extends FunctionSpec.AnyWithProps, MiddlewareSpecs_ extends AnyMiddlewareSpec> = FunctionSpec.MiddlewareSpecs<FunctionSpec_> extends infer FunctionMiddlewareSpec ? FunctionMiddlewareSpec extends AnyMiddlewareSpec ? [
+    Extract<MiddlewareSpecs_, {
+        readonly key: Key<FunctionMiddlewareSpec>;
+    }>
+] extends [never] ? never : AttachmentError<`Middleware "${Key<FunctionMiddlewareSpec>}" is attached to both function "${FunctionSpec_["name"]}" and its group`> : never : never;
+/**
+ * The parameter-type validation applied to the group spec at
+ * `GroupImpl.make`: every function's attached middleware must have its
+ * `requires` services provided by some middleware covering that function
+ * (the group's or the function's own). Checked here — with the group fully
+ * assembled — rather than at the spec builders, because a function-level
+ * middleware's `requires` may legitimately be satisfied by a group
+ * middleware the function spec never sees, and group attachment is
+ * declaratively order-independent with respect to `addFunction`.
+ */
+export type ValidateImplRequires<Functions_ extends FunctionSpec.AnyWithProps, GroupMiddlewareSpecs_ extends AnyMiddlewareSpec> = ValidationResult<Functions_ extends any ? [
+    Exclude<Requires<FunctionSpec.MiddlewareSpecs<Functions_>>, Provides<GroupMiddlewareSpecs_ | FunctionSpec.MiddlewareSpecs<Functions_>>>
+] extends [never] ? never : AttachmentError<`Function "${Functions_["name"]}" has middleware requiring services that no middleware covering it provides`> : never>;
+export type ValidateFunctionAttach<MiddlewareSpec_ extends AnyMiddlewareSpec, RuntimeAndFunctionType_ extends RuntimeAndFunctionType.RuntimeAndFunctionType, FunctionProvenance_ extends FunctionProvenance.FunctionProvenance, MiddlewareSpecs_ extends AnyMiddlewareSpec> = FunctionProvenance_ extends {
+    readonly _tag: "Convex";
+} ? AttachmentError<`Plain Convex functions cannot have middleware — their raw handlers are passed through untouched`> : [
+    Extract<MiddlewareSpecs_, {
+        readonly key: Key<MiddlewareSpec_>;
+    }>
+] extends [never] ? RuntimeAndFunctionType_["functionType"] extends FunctionTypes<MiddlewareSpec_> ? unknown : AttachmentError<`Middleware "${Key<MiddlewareSpec_>}" does not declare function type "${RuntimeAndFunctionType_["functionType"]}"`> : AttachmentError<`Middleware "${Key<MiddlewareSpec_>}" is already attached to this function`>;
+export {};
+//# sourceMappingURL=MiddlewareSpec.d.ts.map

package/dist/MiddlewareSpec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MiddlewareSpec.d.ts","sourceRoot":"","sources":["../src/MiddlewareSpec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,KAAK,kBAAkB,MAAM,sBAAsB,CAAC;AAChE,OAAO,KAAK,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAEpD,OAAO,KAAK,KAAK,sBAAsB,MAAM,0BAA0B,CAAC;AAExE,eAAO,MAAM,MAAM,kCAAkC,CAAC;AACtD,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC,eAAO,MAAM,gBAAgB,MAAO,OAAO,KAAG,CAAC,IAAI,iBACjB,CAAC;AAEnC,eAAO,MAAM,gBAAgB,EAAE,aAAa,CAAC,YAAY,CAIxD,CAAC;AAEF,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM,CAAC;CAC3B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC;IAC7C,CACE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,GAAG,SAAS,EAAE,SAAS,CAAC,EAC7D,OAAO,EAAE,iBAAiB,GACzB,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,iBAAkB,SAAQ,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;CAAG;AAE3E;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc,CAC7B,EAAE,CAAC,GAAG,CAAC,IAAI,EACX,IAAI,SAAS,MAAM,EACnB,SAAS,EACT,SAAS,EACT,YAAY,SAAS,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAC3C,cAAc,SAAS,YAAY;IAEnC,KAAK,CAAC,EAAE,KAAK,GAAG;QACd,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;KACpB,CAAC;IACF,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IACnB,QAAQ,CAAC,aAAa,EAAE,sBAAsB,CAAC;IAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC;IAChC,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,gBAAgB,EAAE,cAAc,CAAC;IAC1C,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,aAAa,EAAE,sBAAsB,CAAC;IAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACxC,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC;IACvB,QAAQ,CAAC,gBAAgB,EAAE,YAAY,CAAC;CACzC;AAED,MAAM,MAAM,GAAG,CAAC,eAAe,SAAS,iBAAiB,IACvD,eAAe,CAAC,KAAK,CAAC,CAAC;AAEzB,MAAM,MAAM,QAAQ,CAAC,eAAe,SAAS,iBAAiB,IAC5D,eAAe,SAAS,iBAAiB,GACrC,eAAe,CAAC,WAAW,CAAC,GAC5B,KAAK,CAAC;AAEZ;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,eAAe,SAAS,iBAAiB,IAC5D,eAAe,SAAS,iBAAiB,GACrC,eAAe,CAAC,WAAW,CAAC,GAC5B,KAAK,CAAC;AAEZ,MAAM,MAAM,WAAW,CAAC,eAAe,SAAS,iBAAiB,IAC/D,eAAe,SAAS,iBAAiB,GAAG,eAAe,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;AAEhF,MAAM,MAAM,KAAK,CAAC,eAAe,SAAS,iBAAiB,IACzD,eAAe,SAAS,iBAAiB,GACrC,eAAe,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GACjC,KAAK,CAAC;AAEZ,MAAM,MAAM,YAAY,CAAC,eAAe,SAAS,iBAAiB,IAChE,eAAe,SAAS,iBAAiB,GACrC,eAAe,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,GACpC,KAAK,CAAC;AAEZ,MAAM,MAAM,aAAa,CAAC,eAAe,SAAS,iBAAiB,IACjE,eAAe,SAAS,iBAAiB,GACrC,eAAe,CAAC,gBAAgB,CAAC,GACjC,KAAK,CAAC;AAEZ;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,cAAc,GACxB,IAAI,EAAE,MAAM,SAAS;IAAE,QAAQ,CAAC,EAAE,GAAG,CAAC;IAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;CAAE,GAAG,EAAE,QAE3D,KAAK,CAAC,IAAI,SAAS,MAAM,EACzB,KAAK,CAAC,oBAAoB,SAAS,sBAAsB,EACzD,YAAY,SAAS,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,OAE9C,IAAI,WACA;IACP,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,YAAY,CAAC;IACpC,QAAQ,CAAC,aAAa,EAAE,oBAAoB,GAC1C,2BAA2B,CAAC,oBAAoB,CAAC,CAAC;CACrD,KACA,cAAc,CACf,IAAI,EACJ,IAAI,EACJ,UAAU,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,EAC5D,UAAU,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,EAC5D,YAAY,EACZ,uBAAuB,CAAC,oBAAoB,CAAC,CAsB9C,CAAC;AAEJ,KAAK,uBAAuB,CAAC,MAAM,SAAS,sBAAsB,IAAI;KACnE,CAAC,IAAI,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK;CACxD,CAAC,YAAY,CAAC,CAAC;AAEhB,KAAK,2BAA2B,CAAC,MAAM,SAAS,sBAAsB,IACpE,gBAAgB,CACZ;KACG,CAAC,IAAI,MAAM,MAAM,GAAG,OAAO,SAAS,MAAM,CAAC,CAAC,CAAC,GAC1C,eAAe,CAAC,uBAAuB,CAAC,GAAG,MAAM,uEAAuE,CAAC,GACzH,KAAK;CACV,CAAC,MAAM,MAAM,CAAC,GACf,CAAC,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC9C,eAAe,CAAC,sDAAsD,CAAC,GACvE,KAAK,CAAC,CACb,CAAC;AAEJ,eAAO,MAAM,YAAY,oBACN,aAAa,CAAC,iBAAiB,CAAC,KAChD,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAKpC,CAAC;AAEJ;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,OAAO,SAAS,MAAM;IACrD,QAAQ,CAAC,+CAA+C,EAAE,OAAO,CAAC;CACnE;AAED,KAAK,cAAc,CAAC,aAAa,SAAS,YAAY,CAAC,YAAY,IACjE,aAAa,CAAC,wBAAwB,CAAC,CAAC,cAAc,CAAC,CAAC;AAE1D,KAAK,gBAAgB,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,MAAM,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAC1B,aAAa,SAAS,YAAY,CAAC,YAAY,EAC/C,eAAe,SAAS,iBAAiB,IACvC,aAAa,SAAS,GAAG,GACzB,eAAe,SAAS,GAAG,GACzB,aAAa,SAAS;IACpB,QAAQ,CAAC,kBAAkB,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,CAAC;CAC1D,GACC,cAAc,CAAC,aAAa,CAAC,SAAS,aAAa,CAAC,eAAe,CAAC,GAClE,eAAe,CAAC,+BAA+B,aAAa,CAAC,MAAM,CAAC,sCAAsC,GAAG,CAAC,eAAe,CAAC,+FAA+F,CAAC,GAC9N,KAAK,GACP;IACI,OAAO,CACL,YAAY,CAAC,eAAe,CAAC,aAAa,CAAC,EAC3C;QAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,eAAe,CAAC,CAAA;KAAE,CACvC;CACF,SAAS,CAAC,KAAK,CAAC,GACjB,cAAc,CAAC,aAAa,CAAC,SAAS,aAAa,CAAC,eAAe,CAAC,GAClE,KAAK,GACL,eAAe,CAAC,eAAe,GAAG,CAAC,eAAe,CAAC,qCAAqC,cAAc,CAAC,aAAa,CAAC,4BAA4B,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,GAC5K,eAAe,CAAC,eAAe,GAAG,CAAC,eAAe,CAAC,sCAAsC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,GACtH,KAAK,GACP,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,cAAc,CACxB,eAAe,SAAS,iBAAiB,EACzC,UAAU,SAAS,YAAY,CAAC,YAAY,EAC5C,gBAAgB,SAAS,iBAAiB,IACxC;IACF,OAAO,CAAC,gBAAgB,EAAE;QAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,eAAe,CAAC,CAAA;KAAE,CAAC;CAClE,SAAS,CAAC,KAAK,CAAC,GACb,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS;IACvE,KAAK;CACN,GACC,gBAAgB,CAAC,gBAAgB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC,GAC/D,eAAe,CAAC,eAAe,GAAG,CAAC,eAAe,CAAC,wHAAwH,CAAC,GAC9K,eAAe,CAAC,eAAe,GAAG,CAAC,eAAe,CAAC,qCAAqC,CAAC,CAAC;AAE9F,MAAM,MAAM,qBAAqB,CAC/B,aAAa,SAAS,YAAY,CAAC,YAAY,EAC/C,gBAAgB,SAAS,iBAAiB,IACxC,CAAC,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,GAClC,OAAO,GACP,gBAAgB,CACZ,gBAAgB,CAAC,aAAa,EAAE,gBAAgB,CAAC,GACjD,YAAY,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAChD,CAAC;AAEN,KAAK,YAAY,CACf,aAAa,SAAS,YAAY,CAAC,YAAY,EAC/C,gBAAgB,SAAS,iBAAiB,IAE1C,YAAY,CAAC,eAAe,CAAC,aAAa,CAAC,SAAS,MAAM,sBAAsB,GAC5E,sBAAsB,SAAS,iBAAiB,GAC9C;IACE,OAAO,CACL,gBAAgB,EAChB;QAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,sBAAsB,CAAC,CAAA;KAAE,CAC9C;CACF,SAAS,CAAC,KAAK,CAAC,GACf,KAAK,GACL,eAAe,CAAC,eAAe,GAAG,CAAC,sBAAsB,CAAC,mCAAmC,aAAa,CAAC,MAAM,CAAC,iBAAiB,CAAC,GACtI,KAAK,GACP,KAAK,CAAC;AAEZ;;;;;;;;;GASG;AACH,MAAM,MAAM,oBAAoB,CAC9B,UAAU,SAAS,YAAY,CAAC,YAAY,EAC5C,qBAAqB,SAAS,iBAAiB,IAC7C,gBAAgB,CAClB,UAAU,SAAS,GAAG,GAClB;IACE,OAAO,CACL,QAAQ,CAAC,YAAY,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,EAClD,QAAQ,CACN,qBAAqB,GAAG,YAAY,CAAC,eAAe,CAAC,UAAU,CAAC,CACjE,CACF;CACF,SAAS,CAAC,KAAK,CAAC,GACf,KAAK,GACL,eAAe,CAAC,aAAa,UAAU,CAAC,MAAM,CAAC,6EAA6E,CAAC,GAC/H,KAAK,CACV,CAAC;AAEF,MAAM,MAAM,sBAAsB,CAChC,eAAe,SAAS,iBAAiB,EACzC,uBAAuB,SAAS,sBAAsB,CAAC,sBAAsB,EAC7E,mBAAmB,SAAS,kBAAkB,CAAC,kBAAkB,EACjE,gBAAgB,SAAS,iBAAiB,IACxC,mBAAmB,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,GACvD,eAAe,CAAC,iGAAiG,CAAC,GAClH;IACI,OAAO,CAAC,gBAAgB,EAAE;QAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,eAAe,CAAC,CAAA;KAAE,CAAC;CAClE,SAAS,CAAC,KAAK,CAAC,GACjB,uBAAuB,CAAC,cAAc,CAAC,SAAS,aAAa,CAAC,eAAe,CAAC,GAC5E,OAAO,GACP,eAAe,CAAC,eAAe,GAAG,CAAC,eAAe,CAAC,qCAAqC,uBAAuB,CAAC,cAAc,CAAC,GAAG,CAAC,GACrI,eAAe,CAAC,eAAe,GAAG,CAAC,eAAe,CAAC,wCAAwC,CAAC,CAAC"}

package/dist/MiddlewareSpec.js

@@ -0,0 +1,55 @@
+import { __exportAll } from "./_virtual/_rolldown/runtime.js";
+import { defineProperty } from "./Lazy.js";
+import * as Predicate from "effect/Predicate";
+//#region src/MiddlewareSpec.ts
+var MiddlewareSpec_exports = /* @__PURE__ */ __exportAll({
+	MiddlewareSpec: () => MiddlewareSpec,
+	TypeId: () => TypeId,
+	allFunctionTypes: () => allFunctionTypes,
+	errorSchemas: () => errorSchemas,
+	isMiddlewareSpec: () => isMiddlewareSpec
+});
+const TypeId = "~@confect/core/MiddlewareSpec";
+const isMiddlewareSpec = (u) => Predicate.hasProperty(u, TypeId);
+const allFunctionTypes = [
+	"query",
+	"mutation",
+	"action"
+];
+/**
+* Declare a middleware's client-safe interface: its identifying key, the
+* service it provides to downstream handlers, the error schema its failures
+* encode through, and the function types it may attach to.
+*
+* ```ts
+* class RequireUser extends MiddlewareSpec.MiddlewareSpec<RequireUser, {
+*   provides: CurrentUser
+* }>()("RequireUser", {
+*   error: () => NotSignedIn,
+*   functionTypes: { query: true, mutation: true, action: false },
+* }) {}
+* ```
+*
+* The implementation is server-only and supplied separately via
+* `MiddlewareImpl.make` (or `makeByFunctionType`/`provides`) in `@confect/server`.
+*/
+const MiddlewareSpec = () => (key, options) => {
+	const { query, mutation, action } = options.functionTypes;
+	if (!query && !mutation && !action) throw new Error(`Middleware "${key}" must declare at least one function type`);
+	function MiddlewareSpecClass() {}
+	const class_ = MiddlewareSpecClass;
+	class_[TypeId] = TypeId;
+	class_.key = key;
+	class_.functionTypes = {
+		query,
+		mutation,
+		action
+	};
+	if (options.error !== void 0) defineProperty(class_, "error", options.error);
+	return class_;
+};
+const errorSchemas = (middlewareSpecs) => middlewareSpecs.flatMap((middlewareSpec) => "error" in middlewareSpec && middlewareSpec.error !== void 0 ? [middlewareSpec.error] : []);
+//#endregion
+export { MiddlewareSpec, MiddlewareSpec_exports, TypeId, allFunctionTypes, errorSchemas, isMiddlewareSpec };
+
+//# sourceMappingURL=MiddlewareSpec.js.map

package/dist/MiddlewareSpec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MiddlewareSpec.js","names":[],"sources":["../src/MiddlewareSpec.ts"],"sourcesContent":["import type { FunctionType, FunctionVisibility } from \"convex/server\";\nimport type * as Effect from \"effect/Effect\";\nimport * as Predicate from \"effect/Predicate\";\nimport type * as Schema from \"effect/Schema\";\nimport type { unhandled } from \"effect/Types\";\nimport type * as FunctionProvenance from \"./FunctionProvenance\";\nimport type * as FunctionSpec from \"./FunctionSpec\";\nimport * as Lazy from \"./Lazy\";\nimport type * as RuntimeAndFunctionType from \"./RuntimeAndFunctionType\";\n\nexport const TypeId = \"~@confect/core/MiddlewareSpec\";\nexport type TypeId = typeof TypeId;\n\nexport const isMiddlewareSpec = (u: unknown): u is AnyMiddlewareSpec =>\n  Predicate.hasProperty(u, TypeId);\n\nexport const allFunctionTypes: ReadonlyArray<FunctionType> = [\n  \"query\",\n  \"mutation\",\n  \"action\",\n];\n\nexport interface SupportedFunctionTypes {\n  readonly query: boolean;\n  readonly mutation: boolean;\n  readonly action: boolean;\n}\n\n/**\n * Marker success type used by middleware to represent the handler's outcome\n * without exposing its concrete success value.\n *\n * Mirrors `RpcMiddleware.SuccessValue` in Effect.\n */\nexport interface SuccessValue {\n  readonly _: unique symbol;\n}\n\n/**\n * The wrap-style middleware implementation shape: receives the downstream\n * effect (the remaining middleware plus the function handler) and the\n * covered invocation's metadata, and returns the effect that runs in its\n * place.\n *\n * Mirrors `RpcMiddleware.RpcMiddleware` in Effect.\n */\nexport interface MiddlewareImpl<Provides_, E, R> {\n  (\n    effect: Effect.Effect<SuccessValue, E | unhandled, Provides_>,\n    options: MiddlewareOptions,\n  ): Effect.Effect<SuccessValue, E | unhandled, R>;\n}\n\nexport interface MiddlewareOptions {\n  readonly name: string;\n  readonly functionType: FunctionType;\n  readonly functionVisibility: FunctionVisibility;\n  readonly args: unknown;\n}\n\nexport interface AnyMiddlewareImpl extends MiddlewareImpl<any, any, any> {}\n\n/**\n * The class shape produced by {@link MiddlewareSpec}. Only the static side is ever\n * used — the class is a value-level carrier for the middleware's key, its\n * declared functionTypes, and its (lazily-evaluated) error schema, plus the\n * type-level `Provides`/`Error` metadata. It is deliberately not a\n * `Context.Tag`: implementations are registered through the group `Registry`\n * (like `FunctionImpl`s), not resolved from a Layer context.\n */\nexport interface MiddlewareSpec<\n  in out Self,\n  Key_ extends string,\n  Provides_,\n  Requires_,\n  ErrorSchema_ extends Schema.Codec<any, any>,\n  FunctionTypes_ extends FunctionType,\n> {\n  new (_: never): {\n    readonly [TypeId]: TypeId;\n    readonly key: Key_;\n  };\n  readonly [TypeId]: TypeId;\n  readonly key: Key_;\n  readonly functionTypes: SupportedFunctionTypes;\n  readonly error?: ErrorSchema_;\n  readonly \"~Provides\": Provides_;\n  readonly \"~Requires\": Requires_;\n  readonly \"~Error\": ErrorSchema_;\n  readonly \"~FunctionTypes\": FunctionTypes_;\n  readonly \"~Self\": Self;\n}\n\nexport interface AnyMiddlewareSpec {\n  readonly [TypeId]: TypeId;\n  readonly key: string;\n  readonly functionTypes: SupportedFunctionTypes;\n  readonly error?: Schema.Codec<any, any>;\n  readonly \"~Provides\": any;\n  readonly \"~Requires\": any;\n  readonly \"~Error\": any;\n  readonly \"~FunctionTypes\": FunctionType;\n}\n\nexport type Key<MiddlewareSpec_ extends AnyMiddlewareSpec> =\n  MiddlewareSpec_[\"key\"];\n\nexport type Provides<MiddlewareSpec_ extends AnyMiddlewareSpec> =\n  MiddlewareSpec_ extends AnyMiddlewareSpec\n    ? MiddlewareSpec_[\"~Provides\"]\n    : never;\n\n/**\n * The services a middleware's implementation may consume from middleware\n * that runs earlier in the same chain (type-level only, like `provides`).\n */\nexport type Requires<MiddlewareSpec_ extends AnyMiddlewareSpec> =\n  MiddlewareSpec_ extends AnyMiddlewareSpec\n    ? MiddlewareSpec_[\"~Requires\"]\n    : never;\n\nexport type ErrorSchema<MiddlewareSpec_ extends AnyMiddlewareSpec> =\n  MiddlewareSpec_ extends AnyMiddlewareSpec ? MiddlewareSpec_[\"~Error\"] : never;\n\nexport type Error<MiddlewareSpec_ extends AnyMiddlewareSpec> =\n  MiddlewareSpec_ extends AnyMiddlewareSpec\n    ? MiddlewareSpec_[\"~Error\"][\"Type\"]\n    : never;\n\nexport type EncodedError<MiddlewareSpec_ extends AnyMiddlewareSpec> =\n  MiddlewareSpec_ extends AnyMiddlewareSpec\n    ? MiddlewareSpec_[\"~Error\"][\"Encoded\"]\n    : never;\n\nexport type FunctionTypes<MiddlewareSpec_ extends AnyMiddlewareSpec> =\n  MiddlewareSpec_ extends AnyMiddlewareSpec\n    ? MiddlewareSpec_[\"~FunctionTypes\"]\n    : never;\n\n/**\n * Declare a middleware's client-safe interface: its identifying key, the\n * service it provides to downstream handlers, the error schema its failures\n * encode through, and the function types it may attach to.\n *\n * ```ts\n * class RequireUser extends MiddlewareSpec.MiddlewareSpec<RequireUser, {\n *   provides: CurrentUser\n * }>()(\"RequireUser\", {\n *   error: () => NotSignedIn,\n *   functionTypes: { query: true, mutation: true, action: false },\n * }) {}\n * ```\n *\n * The implementation is server-only and supplied separately via\n * `MiddlewareImpl.make` (or `makeByFunctionType`/`provides`) in `@confect/server`.\n */\nexport const MiddlewareSpec =\n  <Self, Config extends { provides?: any; requires?: any } = {}>() =>\n  <\n    const Key_ extends string,\n    const FunctionTypesConfig_ extends SupportedFunctionTypes,\n    ErrorSchema_ extends Schema.Codec<any, any> = never,\n  >(\n    key: Key_,\n    options: {\n      readonly error?: () => ErrorSchema_;\n      readonly functionTypes: FunctionTypesConfig_ &\n        ValidateFunctionTypesConfig<FunctionTypesConfig_>;\n    },\n  ): MiddlewareSpec<\n    Self,\n    Key_,\n    \"provides\" extends keyof Config ? Config[\"provides\"] : never,\n    \"requires\" extends keyof Config ? Config[\"requires\"] : never,\n    ErrorSchema_,\n    FunctionTypesFromConfig<FunctionTypesConfig_>\n  > => {\n    const { query, mutation, action } = options.functionTypes;\n    if (!query && !mutation && !action) {\n      throw new Error(\n        `Middleware \"${key}\" must declare at least one function type`,\n      );\n    }\n\n    function MiddlewareSpecClass() {}\n    const class_ = MiddlewareSpecClass as any;\n    class_[TypeId] = TypeId;\n    class_.key = key;\n    class_.functionTypes = {\n      query,\n      mutation,\n      action,\n    } satisfies SupportedFunctionTypes;\n    if (options.error !== undefined) {\n      Lazy.defineProperty(class_, \"error\", options.error);\n    }\n    return class_;\n  };\n\ntype FunctionTypesFromConfig<Config extends SupportedFunctionTypes> = {\n  [K in FunctionType]: Config[K] extends true ? K : never;\n}[FunctionType];\n\ntype ValidateFunctionTypesConfig<Config extends SupportedFunctionTypes> =\n  ValidationResult<\n    | {\n        [K in keyof Config]: boolean extends Config[K]\n          ? AttachmentError<`Function type flag \"${K & string}\" must be a literal \\`true\\` or \\`false\\`, not a computed \\`boolean\\``>\n          : never;\n      }[keyof Config]\n    | ([FunctionTypesFromConfig<Config>] extends [never]\n        ? AttachmentError<`A middleware must declare at least one function type`>\n        : never)\n  >;\n\nexport const errorSchemas = (\n  middlewareSpecs: ReadonlyArray<AnyMiddlewareSpec>,\n): ReadonlyArray<Schema.Codec<any, any>> =>\n  middlewareSpecs.flatMap((middlewareSpec) =>\n    \"error\" in middlewareSpec && middlewareSpec.error !== undefined\n      ? [middlewareSpec.error]\n      : [],\n  );\n\n/**\n * A branded, unconstructible type carrying a spec-authoring error message.\n * Surfaced as (part of) a parameter type so the diagnostic names the exact\n * problem at the `.middleware()` / `.addFunction()` call site.\n */\nexport interface AttachmentError<Message extends string> {\n  readonly \"~@confect/core/MiddlewareSpec/AttachmentError\": Message;\n}\n\ntype FunctionTypeOf<FunctionSpec_ extends FunctionSpec.AnyWithProps> =\n  FunctionSpec_[\"runtimeAndFunctionType\"][\"functionType\"];\n\ntype ValidationResult<Errors> = [Errors] extends [never] ? unknown : Errors;\n\n/**\n * A matching-type Convex-provenance function is rejected rather than\n * silently skipped: its raw handler passes through Confect untouched, so\n * the middleware could not actually cover it, and skipping it would be a\n * policy hole.\n */\nexport type ValidateFunction<\n  FunctionSpec_ extends FunctionSpec.AnyWithProps,\n  MiddlewareSpec_ extends AnyMiddlewareSpec,\n> = FunctionSpec_ extends any\n  ? MiddlewareSpec_ extends any\n    ? FunctionSpec_ extends {\n        readonly functionProvenance: { readonly _tag: \"Convex\" };\n      }\n      ? FunctionTypeOf<FunctionSpec_> extends FunctionTypes<MiddlewareSpec_>\n        ? AttachmentError<`Convex-provenance function \"${FunctionSpec_[\"name\"]}\" cannot be covered by middleware \"${Key<MiddlewareSpec_>}\" — attach middleware only to groups whose matching-type functions are all Confect-provenance`>\n        : never\n      : [\n            Extract<\n              FunctionSpec.MiddlewareSpecs<FunctionSpec_>,\n              { readonly key: Key<MiddlewareSpec_> }\n            >,\n          ] extends [never]\n        ? FunctionTypeOf<FunctionSpec_> extends FunctionTypes<MiddlewareSpec_>\n          ? never\n          : AttachmentError<`Middleware \"${Key<MiddlewareSpec_>}\" does not declare function type \"${FunctionTypeOf<FunctionSpec_>}\", the type of function \"${FunctionSpec_[\"name\"]}\"`>\n        : AttachmentError<`Middleware \"${Key<MiddlewareSpec_>}\" is already attached to function \"${FunctionSpec_[\"name\"]}\"`>\n    : never\n  : never;\n\n/**\n * Attachment order is chain order, so requiring `requires` to be satisfied\n * by already-attached middleware is exactly requiring the provider to run\n * earlier.\n */\nexport type ValidateAttach<\n  MiddlewareSpec_ extends AnyMiddlewareSpec,\n  Functions_ extends FunctionSpec.AnyWithProps,\n  MiddlewareSpecs_ extends AnyMiddlewareSpec,\n> = [\n  Extract<MiddlewareSpecs_, { readonly key: Key<MiddlewareSpec_> }>,\n] extends [never]\n  ? [Exclude<Requires<MiddlewareSpec_>, Provides<MiddlewareSpecs_>>] extends [\n      never,\n    ]\n    ? ValidationResult<ValidateFunction<Functions_, MiddlewareSpec_>>\n    : AttachmentError<`Middleware \"${Key<MiddlewareSpec_>}\" requires services that no middleware attached earlier to this group provides — attach the providing middleware first`>\n  : AttachmentError<`Middleware \"${Key<MiddlewareSpec_>}\" is already attached to this group`>;\n\nexport type ValidateAddedFunction<\n  FunctionSpec_ extends FunctionSpec.AnyWithProps,\n  MiddlewareSpecs_ extends AnyMiddlewareSpec,\n> = [MiddlewareSpecs_] extends [never]\n  ? unknown\n  : ValidationResult<\n      | ValidateFunction<FunctionSpec_, MiddlewareSpecs_>\n      | GroupOverlap<FunctionSpec_, MiddlewareSpecs_>\n    >;\n\ntype GroupOverlap<\n  FunctionSpec_ extends FunctionSpec.AnyWithProps,\n  MiddlewareSpecs_ extends AnyMiddlewareSpec,\n> =\n  FunctionSpec.MiddlewareSpecs<FunctionSpec_> extends infer FunctionMiddlewareSpec\n    ? FunctionMiddlewareSpec extends AnyMiddlewareSpec\n      ? [\n          Extract<\n            MiddlewareSpecs_,\n            { readonly key: Key<FunctionMiddlewareSpec> }\n          >,\n        ] extends [never]\n        ? never\n        : AttachmentError<`Middleware \"${Key<FunctionMiddlewareSpec>}\" is attached to both function \"${FunctionSpec_[\"name\"]}\" and its group`>\n      : never\n    : never;\n\n/**\n * The parameter-type validation applied to the group spec at\n * `GroupImpl.make`: every function's attached middleware must have its\n * `requires` services provided by some middleware covering that function\n * (the group's or the function's own). Checked here — with the group fully\n * assembled — rather than at the spec builders, because a function-level\n * middleware's `requires` may legitimately be satisfied by a group\n * middleware the function spec never sees, and group attachment is\n * declaratively order-independent with respect to `addFunction`.\n */\nexport type ValidateImplRequires<\n  Functions_ extends FunctionSpec.AnyWithProps,\n  GroupMiddlewareSpecs_ extends AnyMiddlewareSpec,\n> = ValidationResult<\n  Functions_ extends any\n    ? [\n        Exclude<\n          Requires<FunctionSpec.MiddlewareSpecs<Functions_>>,\n          Provides<\n            GroupMiddlewareSpecs_ | FunctionSpec.MiddlewareSpecs<Functions_>\n          >\n        >,\n      ] extends [never]\n      ? never\n      : AttachmentError<`Function \"${Functions_[\"name\"]}\" has middleware requiring services that no middleware covering it provides`>\n    : never\n>;\n\nexport type ValidateFunctionAttach<\n  MiddlewareSpec_ extends AnyMiddlewareSpec,\n  RuntimeAndFunctionType_ extends RuntimeAndFunctionType.RuntimeAndFunctionType,\n  FunctionProvenance_ extends FunctionProvenance.FunctionProvenance,\n  MiddlewareSpecs_ extends AnyMiddlewareSpec,\n> = FunctionProvenance_ extends { readonly _tag: \"Convex\" }\n  ? AttachmentError<`Plain Convex functions cannot have middleware — their raw handlers are passed through untouched`>\n  : [\n        Extract<MiddlewareSpecs_, { readonly key: Key<MiddlewareSpec_> }>,\n      ] extends [never]\n    ? RuntimeAndFunctionType_[\"functionType\"] extends FunctionTypes<MiddlewareSpec_>\n      ? unknown\n      : AttachmentError<`Middleware \"${Key<MiddlewareSpec_>}\" does not declare function type \"${RuntimeAndFunctionType_[\"functionType\"]}\"`>\n    : AttachmentError<`Middleware \"${Key<MiddlewareSpec_>}\" is already attached to this function`>;\n"],"mappings":";;;;;;;;;;;AAUA,MAAa,SAAS;AAGtB,MAAa,oBAAoB,MAC/B,UAAU,YAAY,GAAG,MAAM;AAEjC,MAAa,mBAAgD;CAC3D;CACA;CACA;AACF;;;;;;;;;;;;;;;;;;AAwIA,MAAa,wBAOT,KACA,YAYG;CACH,MAAM,EAAE,OAAO,UAAU,WAAW,QAAQ;CAC5C,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,QAC1B,MAAM,IAAI,MACR,eAAe,IAAI,0CACrB;CAGF,SAAS,sBAAsB,CAAC;CAChC,MAAM,SAAS;CACf,OAAO,UAAU;CACjB,OAAO,MAAM;CACb,OAAO,gBAAgB;EACrB;EACA;EACA;CACF;CACA,IAAI,QAAQ,UAAU,KAAA,GACpB,eAAoB,QAAQ,SAAS,QAAQ,KAAK;CAEpD,OAAO;AACT;AAkBF,MAAa,gBACX,oBAEA,gBAAgB,SAAS,mBACvB,WAAW,kBAAkB,eAAe,UAAU,KAAA,IAClD,CAAC,eAAe,KAAK,IACrB,CAAC,CACP"}

package/dist/PaginationError.d.ts

@@ -0,0 +1,14 @@
+import * as Option from "effect/Option";
+import * as Schema from "effect/Schema";
+declare const InvalidCursor_base: Schema.Class<InvalidCursor, Schema.TaggedStruct<"InvalidCursor", {
+    readonly cause: Schema.Defect;
+}>, import("effect/Cause").YieldableError>;
+/** A Convex pagination cursor that no longer describes the current query. */
+export declare class InvalidCursor extends InvalidCursor_base {
+}
+/** Recognizes an invalid-cursor error emitted by a Convex query. */
+export declare const fromConvexQueryError: (error: unknown) => Option.Option<InvalidCursor>;
+/** Recognizes the error data attached to Convex's invalid-cursor error. */
+export declare const fromConvexErrorData: (errorData: unknown) => Option.Option<InvalidCursor>;
+export {};
+//# sourceMappingURL=PaginationError.d.ts.map

package/dist/PaginationError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaginationError.d.ts","sourceRoot":"","sources":["../src/PaginationError.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;;;;AAExC,6EAA6E;AAC7E,qBAAa,aAAc,SAAQ,kBAKlC;CAAG;AA8BJ,oEAAoE;AACpE,eAAO,MAAM,oBAAoB,UACxB,OAAO,KACb,MAAM,CAAC,MAAM,CAAC,aAAa,CAc3B,CAAC;AAEJ,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB,cACnB,OAAO,KACjB,MAAM,CAAC,MAAM,CAAC,aAAa,CAO3B,CAAC"}

package/dist/PaginationError.js

@@ -0,0 +1,25 @@
+import { __exportAll } from "./_virtual/_rolldown/runtime.js";
+import * as Schema from "effect/Schema";
+import * as Option from "effect/Option";
+import { ConvexError } from "convex/values";
+import * as Match from "effect/Match";
+//#region src/PaginationError.ts
+var PaginationError_exports = /* @__PURE__ */ __exportAll({
+	InvalidCursor: () => InvalidCursor,
+	fromConvexErrorData: () => fromConvexErrorData,
+	fromConvexQueryError: () => fromConvexQueryError
+});
+/** A Convex pagination cursor that no longer describes the current query. */
+var InvalidCursor = class extends Schema.TaggedError()("InvalidCursor", { cause: Schema.Defect() }) {};
+const ConvexErrorIdentifier = Symbol.for("ConvexError");
+const isConvexError = (error) => error instanceof ConvexError || typeof error === "object" && error !== null && ConvexErrorIdentifier in error;
+const isInvalidCursorData = (value) => typeof value === "object" && value !== null && "isConvexSystemError" in value && value.isConvexSystemError === true && "paginationError" in value && value.paginationError === "InvalidCursor";
+const fromErrorMessage = (error) => error.message.includes("InvalidCursor") ? Option.some(new InvalidCursor({ cause: error })) : Option.none();
+/** Recognizes an invalid-cursor error emitted by a Convex query. */
+const fromConvexQueryError = (error) => Match.value(error).pipe(Match.when(isConvexError, (convexError) => Match.value(isInvalidCursorData(convexError.data)).pipe(Match.when(true, () => Option.some(new InvalidCursor({ cause: error }))), Match.when(false, () => fromErrorMessage(convexError)), Match.exhaustive)), Match.when(Match.instanceOf(globalThis.Error), fromErrorMessage), Match.when(Match.any, () => Option.none()), Match.exhaustive);
+/** Recognizes the error data attached to Convex's invalid-cursor error. */
+const fromConvexErrorData = (errorData) => Match.value(errorData).pipe(Match.when(isInvalidCursorData, (cause) => Option.some(new InvalidCursor({ cause }))), Match.when(Match.any, () => Option.none()), Match.exhaustive);
+//#endregion
+export { InvalidCursor, PaginationError_exports, fromConvexErrorData, fromConvexQueryError };
+
+//# sourceMappingURL=PaginationError.js.map

package/dist/PaginationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaginationError.js","names":[],"sources":["../src/PaginationError.ts"],"sourcesContent":["import { ConvexError } from \"convex/values\";\nimport type { Value } from \"convex/values\";\nimport * as Match from \"effect/Match\";\nimport * as Option from \"effect/Option\";\nimport * as Schema from \"effect/Schema\";\n\n/** A Convex pagination cursor that no longer describes the current query. */\nexport class InvalidCursor extends Schema.TaggedError<InvalidCursor>()(\n  \"InvalidCursor\",\n  {\n    cause: Schema.Defect(),\n  },\n) {}\n\ninterface InvalidCursorData {\n  readonly isConvexSystemError: true;\n  readonly paginationError: \"InvalidCursor\";\n}\n\nconst ConvexErrorIdentifier = Symbol.for(\"ConvexError\");\n\nconst isConvexError = (error: unknown): error is ConvexError<Value> =>\n  error instanceof ConvexError ||\n  (typeof error === \"object\" &&\n    error !== null &&\n    ConvexErrorIdentifier in error);\n\nconst isInvalidCursorData = (value: unknown): value is InvalidCursorData =>\n  typeof value === \"object\" &&\n  value !== null &&\n  \"isConvexSystemError\" in value &&\n  value.isConvexSystemError === true &&\n  \"paginationError\" in value &&\n  value.paginationError === \"InvalidCursor\";\n\nconst fromErrorMessage = (\n  error: globalThis.Error,\n): Option.Option<InvalidCursor> =>\n  error.message.includes(\"InvalidCursor\")\n    ? Option.some(new InvalidCursor({ cause: error }))\n    : Option.none();\n\n/** Recognizes an invalid-cursor error emitted by a Convex query. */\nexport const fromConvexQueryError = (\n  error: unknown,\n): Option.Option<InvalidCursor> =>\n  Match.value(error).pipe(\n    Match.when(isConvexError, (convexError) =>\n      Match.value(isInvalidCursorData(convexError.data)).pipe(\n        Match.when(true, () =>\n          Option.some(new InvalidCursor({ cause: error })),\n        ),\n        Match.when(false, () => fromErrorMessage(convexError)),\n        Match.exhaustive,\n      ),\n    ),\n    Match.when(Match.instanceOf(globalThis.Error), fromErrorMessage),\n    Match.when(Match.any, () => Option.none<InvalidCursor>()),\n    Match.exhaustive,\n  );\n\n/** Recognizes the error data attached to Convex's invalid-cursor error. */\nexport const fromConvexErrorData = (\n  errorData: unknown,\n): Option.Option<InvalidCursor> =>\n  Match.value(errorData).pipe(\n    Match.when(isInvalidCursorData, (cause) =>\n      Option.some(new InvalidCursor({ cause })),\n    ),\n    Match.when(Match.any, () => Option.none<InvalidCursor>()),\n    Match.exhaustive,\n  );\n"],"mappings":";;;;;;;;;;;;AAOA,IAAa,gBAAb,cAAmC,OAAO,YAA2B,CAAC,CACpE,iBACA,EACE,OAAO,OAAO,OAAO,EACvB,CACF,CAAC,CAAC,CAAC;AAOH,MAAM,wBAAwB,OAAO,IAAI,aAAa;AAEtD,MAAM,iBAAiB,UACrB,iBAAiB,eAChB,OAAO,UAAU,YAChB,UAAU,QACV,yBAAyB;AAE7B,MAAM,uBAAuB,UAC3B,OAAO,UAAU,YACjB,UAAU,QACV,yBAAyB,SACzB,MAAM,wBAAwB,QAC9B,qBAAqB,SACrB,MAAM,oBAAoB;AAE5B,MAAM,oBACJ,UAEA,MAAM,QAAQ,SAAS,eAAe,IAClC,OAAO,KAAK,IAAI,cAAc,EAAE,OAAO,MAAM,CAAC,CAAC,IAC/C,OAAO,KAAK;;AAGlB,MAAa,wBACX,UAEA,MAAM,MAAM,KAAK,CAAC,CAAC,KACjB,MAAM,KAAK,gBAAgB,gBACzB,MAAM,MAAM,oBAAoB,YAAY,IAAI,CAAC,CAAC,CAAC,KACjD,MAAM,KAAK,YACT,OAAO,KAAK,IAAI,cAAc,EAAE,OAAO,MAAM,CAAC,CAAC,CACjD,GACA,MAAM,KAAK,aAAa,iBAAiB,WAAW,CAAC,GACrD,MAAM,UACR,CACF,GACA,MAAM,KAAK,MAAM,WAAW,WAAW,KAAK,GAAG,gBAAgB,GAC/D,MAAM,KAAK,MAAM,WAAW,OAAO,KAAoB,CAAC,GACxD,MAAM,UACR;;AAGF,MAAa,uBACX,cAEA,MAAM,MAAM,SAAS,CAAC,CAAC,KACrB,MAAM,KAAK,sBAAsB,UAC/B,OAAO,KAAK,IAAI,cAAc,EAAE,MAAM,CAAC,CAAC,CAC1C,GACA,MAAM,KAAK,MAAM,WAAW,OAAO,KAAoB,CAAC,GACxD,MAAM,UACR"}

package/dist/PaginationOptions.d.ts

@@ -0,0 +1,23 @@
+import * as Schema from "effect/Schema";
+/**
+ * Schema for the `paginationOpts` argument that every paginated query
+ * receives. Mirrors `paginationOptsValidator` from `convex/server`.
+ *
+ * Use this as the `paginationOpts` field of a paginated query's args schema.
+ * Beyond `numItems` and `cursor`, Convex's pagination protocol sends the
+ * optional fields (`endCursor`, `id`, `maximumRowsRead`, `maximumBytesRead`)
+ * with real requests — most notably `usePaginatedQuery` from `convex/react`
+ * always includes `id`, and includes `endCursor` when splitting pages.
+ * Declaring them is required for the generated Convex argument validator to
+ * accept those requests and for the fields to survive decoding and reach
+ * `paginate`.
+ */
+export declare const PaginationOptions: Schema.Struct<{
+    readonly numItems: Schema.Finite;
+    readonly cursor: Schema.Union<readonly [Schema.String, Schema.Null]>;
+    readonly endCursor: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+    readonly id: Schema.optionalKey<Schema.Finite>;
+    readonly maximumRowsRead: Schema.optionalKey<Schema.Finite>;
+    readonly maximumBytesRead: Schema.optionalKey<Schema.Finite>;
+}>;
+//# sourceMappingURL=PaginationOptions.d.ts.map

package/dist/PaginationOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaginationOptions.d.ts","sourceRoot":"","sources":["../src/PaginationOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB;;;;;;;EAO5B,CAAC"}

package/dist/PaginationOptions.js

@@ -0,0 +1,29 @@
+import { __exportAll } from "./_virtual/_rolldown/runtime.js";
+import * as Schema from "effect/Schema";
+//#region src/PaginationOptions.ts
+var PaginationOptions_exports = /* @__PURE__ */ __exportAll({ PaginationOptions: () => PaginationOptions });
+/**
+* Schema for the `paginationOpts` argument that every paginated query
+* receives. Mirrors `paginationOptsValidator` from `convex/server`.
+*
+* Use this as the `paginationOpts` field of a paginated query's args schema.
+* Beyond `numItems` and `cursor`, Convex's pagination protocol sends the
+* optional fields (`endCursor`, `id`, `maximumRowsRead`, `maximumBytesRead`)
+* with real requests — most notably `usePaginatedQuery` from `convex/react`
+* always includes `id`, and includes `endCursor` when splitting pages.
+* Declaring them is required for the generated Convex argument validator to
+* accept those requests and for the fields to survive decoding and reach
+* `paginate`.
+*/
+const PaginationOptions = Schema.Struct({
+	numItems: Schema.Finite,
+	cursor: Schema.Union([Schema.String, Schema.Null]),
+	endCursor: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	id: Schema.optionalKey(Schema.Finite),
+	maximumRowsRead: Schema.optionalKey(Schema.Finite),
+	maximumBytesRead: Schema.optionalKey(Schema.Finite)
+});
+//#endregion
+export { PaginationOptions, PaginationOptions_exports };
+
+//# sourceMappingURL=PaginationOptions.js.map

package/dist/PaginationOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaginationOptions.js","names":[],"sources":["../src/PaginationOptions.ts"],"sourcesContent":["import * as Schema from \"effect/Schema\";\n\n/**\n * Schema for the `paginationOpts` argument that every paginated query\n * receives. Mirrors `paginationOptsValidator` from `convex/server`.\n *\n * Use this as the `paginationOpts` field of a paginated query's args schema.\n * Beyond `numItems` and `cursor`, Convex's pagination protocol sends the\n * optional fields (`endCursor`, `id`, `maximumRowsRead`, `maximumBytesRead`)\n * with real requests — most notably `usePaginatedQuery` from `convex/react`\n * always includes `id`, and includes `endCursor` when splitting pages.\n * Declaring them is required for the generated Convex argument validator to\n * accept those requests and for the fields to survive decoding and reach\n * `paginate`.\n */\nexport const PaginationOptions = Schema.Struct({\n  numItems: Schema.Finite,\n  cursor: Schema.Union([Schema.String, Schema.Null]),\n  endCursor: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),\n  id: Schema.optionalKey(Schema.Finite),\n  maximumRowsRead: Schema.optionalKey(Schema.Finite),\n  maximumBytesRead: Schema.optionalKey(Schema.Finite),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;AAeA,MAAa,oBAAoB,OAAO,OAAO;CAC7C,UAAU,OAAO;CACjB,QAAQ,OAAO,MAAM,CAAC,OAAO,QAAQ,OAAO,IAAI,CAAC;CACjD,WAAW,OAAO,YAAY,OAAO,MAAM,CAAC,OAAO,QAAQ,OAAO,IAAI,CAAC,CAAC;CACxE,IAAI,OAAO,YAAY,OAAO,MAAM;CACpC,iBAAiB,OAAO,YAAY,OAAO,MAAM;CACjD,kBAAkB,OAAO,YAAY,OAAO,MAAM;AACpD,CAAC"}

package/dist/PaginationResult.d.ts

@@ -1,4 +1,5 @@
 import * as Schema from "effect/Schema";
+export type PaginationResult<Doc extends Schema.Codec<any, any>> = ReturnType<typeof PaginationResult<Doc>>;
 export declare const PaginationResult: <Doc extends Schema.Codec<any, any>>(Doc: Doc) => Schema.Struct<{
     readonly page: Schema.mutable<Schema.$Array<Doc>>;
     readonly isDone: Schema.Boolean;

package/dist/PaginationResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PaginationResult.d.ts","sourceRoot":"","sources":["../src/PaginationResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,eAAO,MAAM,gBAAgB,GAAI,GAAG,SAAS,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EACjE,KAAK,GAAG;;;;;;EAcN,CAAC"}
+{"version":3,"file":"PaginationResult.d.ts","sourceRoot":"","sources":["../src/PaginationResult.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,MAAM,MAAM,gBAAgB,CAAC,GAAG,SAAS,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,UAAU,CAC3E,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAC7B,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,GAAG,SAAS,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,OAC5D,GAAG;;;;;;EAcN,CAAC"}

package/dist/PaginationResult.js.map

@@ -1 +1 @@
-{"version":3,"file":"PaginationResult.js","names":[],"sources":["../src/PaginationResult.ts"],"sourcesContent":["import * as Schema from \"effect/Schema\";\n\nexport const PaginationResult = <Doc extends Schema.Codec<any, any>>(\n  Doc: Doc,\n) =>\n  Schema.Struct({\n    page: Schema.mutable(Schema.Array(Doc)),\n    isDone: Schema.Boolean,\n    continueCursor: Schema.String,\n    splitCursor: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),\n    pageStatus: Schema.optionalKey(\n      Schema.Union([\n        Schema.Literal(\"SplitRecommended\"),\n        Schema.Literal(\"SplitRequired\"),\n        Schema.Null,\n      ]),\n    ),\n  });\n"],"mappings":";;;;AAEA,MAAa,oBACX,QAEA,OAAO,OAAO;CACZ,MAAM,OAAO,QAAQ,OAAO,MAAM,GAAG,CAAC;CACtC,QAAQ,OAAO;CACf,gBAAgB,OAAO;CACvB,aAAa,OAAO,YAAY,OAAO,MAAM,CAAC,OAAO,QAAQ,OAAO,IAAI,CAAC,CAAC;CAC1E,YAAY,OAAO,YACjB,OAAO,MAAM;EACX,OAAO,QAAQ,kBAAkB;EACjC,OAAO,QAAQ,eAAe;EAC9B,OAAO;CACT,CAAC,CACH;AACF,CAAC"}
+{"version":3,"file":"PaginationResult.js","names":[],"sources":["../src/PaginationResult.ts"],"sourcesContent":["import * as Schema from \"effect/Schema\";\n\nexport type PaginationResult<Doc extends Schema.Codec<any, any>> = ReturnType<\n  typeof PaginationResult<Doc>\n>;\n\nexport const PaginationResult = <Doc extends Schema.Codec<any, any>>(\n  Doc: Doc,\n) =>\n  Schema.Struct({\n    page: Schema.mutable(Schema.Array(Doc)),\n    isDone: Schema.Boolean,\n    continueCursor: Schema.String,\n    splitCursor: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),\n    pageStatus: Schema.optionalKey(\n      Schema.Union([\n        Schema.Literal(\"SplitRecommended\"),\n        Schema.Literal(\"SplitRequired\"),\n        Schema.Null,\n      ]),\n    ),\n  });\n"],"mappings":";;;;AAMA,MAAa,oBACX,QAEA,OAAO,OAAO;CACZ,MAAM,OAAO,QAAQ,OAAO,MAAM,GAAG,CAAC;CACtC,QAAQ,OAAO;CACf,gBAAgB,OAAO;CACvB,aAAa,OAAO,YAAY,OAAO,MAAM,CAAC,OAAO,QAAQ,OAAO,IAAI,CAAC,CAAC;CAC1E,YAAY,OAAO,YACjB,OAAO,MAAM;EACX,OAAO,QAAQ,kBAAkB;EACjC,OAAO,QAAQ,eAAe;EAC9B,OAAO;CACT,CAAC,CACH;AACF,CAAC"}