@confect/foldkit 10.0.0-next.19

package/dist/PaginatedQuery.d.ts

@@ -0,0 +1,227 @@
+import * as PaginationError from "@confect/core/PaginationError";
+import * as Ref from "@confect/core/Ref";
+import * as Data from "effect/Data";
+import * as Option from "effect/Option";
+import * as Result from "effect/Result";
+import * as Schema from "effect/Schema";
+import * as Client from "./Client";
+/** Identifies the cursor range fetched for one page. */
+export interface PageDescriptor {
+    readonly cursor: string | null;
+    readonly endCursor: Option.Option<string>;
+}
+export declare const PageDescriptor: Schema.Struct<{
+    readonly cursor: Schema.Union<readonly [Schema.String, Schema.Null]>;
+    readonly endCursor: Schema.Option<Schema.String>;
+}>;
+/** Options that remain fixed for one pagination session. */
+export interface Options {
+    readonly initialNumItems: number;
+    readonly maximumRowsRead?: number;
+    readonly maximumBytesRead?: number;
+}
+export declare const Options: Schema.Struct<{
+    readonly initialNumItems: Schema.Int;
+    readonly maximumRowsRead: Schema.optionalKey<Schema.Int>;
+    readonly maximumBytesRead: Schema.optionalKey<Schema.Int>;
+}>;
+/** Why the machine is fetching its current target. */
+export type Direction = "Initial" | "Next" | "Previous" | "First" | "Split" | "Reset";
+/** A complete page that can remain on screen while another page is fetched. */
+export interface Page<Item_> {
+    readonly descriptor: PageDescriptor;
+    readonly number: number;
+    readonly items: ReadonlyArray<Item_>;
+    readonly continueCursor: string;
+    readonly isDone: boolean;
+}
+export type Loading = Data.TaggedEnum<{
+    Loading: {
+        readonly direction: Direction;
+    };
+}>;
+export type Refreshing<Item_> = Data.TaggedEnum<{
+    Refreshing: {
+        readonly data: Page<Item_>;
+        readonly direction: Direction;
+    };
+}>;
+export type Success<Item_> = Data.TaggedEnum<{
+    Success: {
+        readonly data: Page<Item_>;
+    };
+}>;
+export type Failure<Error_> = Data.TaggedEnum<{
+    Failure: {
+        readonly error: Error_;
+    };
+}>;
+export type Stale<Item_, Error_> = Data.TaggedEnum<{
+    Stale: {
+        readonly data: Page<Item_>;
+        readonly error: Error_;
+    };
+}>;
+export type Phase<Item_, Error_> = Loading | Refreshing<Item_> | Success<Item_> | Failure<Error_> | Stale<Item_, Error_>;
+/** A closed machine that retains its generation for stale-result rejection. */
+export type Idle = Data.TaggedEnum<{
+    Idle: {
+        readonly generation: number;
+    };
+}>;
+/** A live cursor-pagination session. */
+export type Active<Item_, UserArgs_, Error_> = Data.TaggedEnum<{
+    Active: {
+        readonly generation: number;
+        readonly args: UserArgs_;
+        readonly options: Options;
+        readonly paginationId: Option.Option<number>;
+        readonly requestId: number;
+        readonly current: PageDescriptor;
+        readonly prevStack: ReadonlyArray<PageDescriptor>;
+        readonly phase: Phase<Item_, Error_>;
+    };
+}>;
+/** A schema-backed cursor-pagination machine. */
+export type State<Item_, UserArgs_, Error_> = Idle | Active<Item_, UserArgs_, Error_>;
+/** The logical request from which a subscription allocates a session id. */
+export interface SubscriptionRequest<UserArgs_> {
+    readonly generation: number;
+    readonly args: UserArgs_;
+    readonly options: Options;
+    readonly paginationId: Option.Option<number>;
+    readonly requestId: number;
+    readonly descriptor: PageDescriptor;
+}
+/** The complete identity and arguments of a subscribed page request. */
+export interface Request<UserArgs_> {
+    readonly generation: number;
+    readonly args: UserArgs_;
+    readonly options: Options;
+    readonly paginationId: number;
+    readonly requestId: number;
+    readonly descriptor: PageDescriptor;
+}
+/** The successful payload returned by a Convex paginated query. */
+export interface PageResult<Item_> {
+    readonly page: ReadonlyArray<Item_>;
+    readonly isDone: boolean;
+    readonly continueCursor: string;
+    readonly splitCursor?: string | null;
+    readonly pageStatus?: "SplitRecommended" | "SplitRequired" | null;
+}
+/**
+ * One correlated subscription outcome. Both success and failure travel
+ * through this value so `settle` can mirror `AsyncData.settle`.
+ */
+export interface Settlement<Item_, UserArgs_, Error_> {
+    readonly request: Request<UserArgs_>;
+    readonly result: Result.Result<PageResult<Item_>, Error_>;
+}
+export type Item<Query extends Ref.AnyConfectPublicPaginatedQuery> = Ref.Returns<Query>["page"][number];
+export type UserArgs<Query extends Ref.AnyConfectPublicPaginatedQuery> = Omit<Ref.Args<Query>, "paginationOpts">;
+type TaggedFunctionError<Error_> = Data.TaggedEnum<{
+    FunctionError: {
+        readonly error: Error_;
+    };
+}>;
+/** Constructs a declared function or middleware failure envelope. */
+export declare const FunctionError: <A>(args: {
+    readonly error: A;
+}) => {
+    readonly _tag: "FunctionError";
+    readonly error: A;
+};
+/** A declared function or middleware failure, kept distinct from client errors. */
+export type FunctionError<Query extends Ref.AnyConfectPublicPaginatedQuery> = [
+    Ref.Error<Query>
+] extends [never] ? never : TaggedFunctionError<Ref.Error<Query>>;
+/** Every failure a paginated query subscription can settle with. */
+export type Error<Query extends Ref.AnyConfectPublicPaginatedQuery> = FunctionError<Query> | PaginationError.InvalidCursor | Client.WebSocketClientError | Schema.SchemaError;
+export { InvalidCursor } from "@confect/core/PaginationError";
+type MachineState<Query extends Ref.AnyConfectPublicPaginatedQuery> = State<Item<Query>, UserArgs<Query>, Error<Query>>;
+type MachineActive<Query extends Ref.AnyConfectPublicPaginatedQuery> = Active<Item<Query>, UserArgs<Query>, Error<Query>>;
+/** The schema-and-constructor bundle returned by `make`. */
+export interface PaginatedQuery<Query extends Ref.AnyConfectPublicPaginatedQuery> {
+    readonly ref: Query;
+    readonly schema: Schema.Codec<MachineState<Query>, unknown>;
+    readonly idle: Idle;
+    readonly subscriptionRequestSchema: Schema.Codec<SubscriptionRequest<UserArgs<Query>>, unknown>;
+    readonly requestSchema: Schema.Codec<Request<UserArgs<Query>>, unknown>;
+    readonly settlement: Schema.Codec<Settlement<Item<Query>, UserArgs<Query>, Error<Query>>, unknown>;
+    readonly init: keyof UserArgs<Query> extends never ? (state: Idle, options: Options) => MachineActive<Query> : (state: Idle, args: UserArgs<Query>, options: Options) => MachineActive<Query>;
+    readonly reinitialize: keyof UserArgs<Query> extends never ? (state: MachineActive<Query>, options?: Options) => MachineActive<Query> : (state: MachineActive<Query>, args: UserArgs<Query>, options?: Options) => MachineActive<Query>;
+}
+export type Any = PaginatedQuery<Ref.AnyConfectPublicPaginatedQuery>;
+/** Builds a page machine from a paginated ref. */
+export declare const make: <Query extends Ref.AnyConfectPublicPaginatedQuery>(ref: Query) => PaginatedQuery<Query>;
+/** Returns the logical request currently driving the subscription. */
+export declare const getSubscriptionRequest: <Item_, UserArgs_, Error_>(state: Active<Item_, UserArgs_, Error_>) => SubscriptionRequest<UserArgs_>;
+/** Attaches the client-allocated pagination id to a logical request. */
+export declare const allocateRequest: <UserArgs_>(request: SubscriptionRequest<UserArgs_>, paginationId: number) => Request<UserArgs_>;
+/** Close the subscription while retaining its generation tombstone. */
+export declare const close: <Item_, UserArgs_, Error_>(state: Active<Item_, UserArgs_, Error_>) => Idle;
+/** Start a fresh pagination session at page one while retaining visible data. */
+export declare const reset: <Item_, UserArgs_, Error_>(state: Active<Item_, UserArgs_, Error_>) => Active<Item_, UserArgs_, Error_>;
+/** Navigate to the next page, retaining the current page while it loads. */
+export declare const next: <Item_, UserArgs_, Error_>(state: Active<Item_, UserArgs_, Error_>) => Option.Option<Active<Item_, UserArgs_, Error_>>;
+/** Navigate to the previous page, retaining the current page while it loads. */
+export declare const prev: <Item_, UserArgs_, Error_>(state: Active<Item_, UserArgs_, Error_>) => Option.Option<Active<Item_, UserArgs_, Error_>>;
+/** Navigate to page one without invalidating the current pagination session. */
+export declare const first: <Item_, UserArgs_, Error_>(state: Active<Item_, UserArgs_, Error_>) => Option.Option<Active<Item_, UserArgs_, Error_>>;
+/** Whether a request still names the machine's live pagination session/page. */
+export declare const isCurrentRequest: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>, candidate: Request<UserArgs_>) => boolean;
+/**
+ * Fold a correlated `Result` into the machine. Like `AsyncData.settle`, a
+ * success becomes `Success`; a failure becomes `Stale` when a page is held,
+ * otherwise `Failure`. Outcomes from superseded requests and outcomes that
+ * arrive after the subscription closed are ignored.
+ */
+export declare const settle: {
+    <Item_, UserArgs_, Error_>(settlement: Settlement<Item_, UserArgs_, Error_>): (state: State<Item_, UserArgs_, Error_>) => State<Item_, UserArgs_, Error_>;
+    <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>, settlement: Settlement<Item_, UserArgs_, Error_>): State<Item_, UserArgs_, Error_>;
+};
+/** The complete page currently available to render. */
+export declare const getPage: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => Option.Option<Page<Item_>>;
+/** The items currently available to render. */
+export declare const getItems: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => Option.Option<ReadonlyArray<Item_>>;
+/** The error from the most recent failed request, if any. */
+export declare const getError: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => Option.Option<Error_>;
+/** The 1-indexed page number currently targeted by the subscription. */
+export declare const targetPageNumber: <Item_, UserArgs_, Error_>(state: Active<Item_, UserArgs_, Error_>) => number;
+export declare const hasPage: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => boolean;
+export declare const hasError: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => boolean;
+export declare const isFirst: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => boolean;
+export declare const isLast: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => boolean;
+type WithPhase<State_, Phase_> = Omit<State_, "phase"> & {
+    readonly phase: Phase_;
+};
+export declare const isIdle: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => state is Idle;
+export declare const isLoading: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => state is WithPhase<Active<Item_, UserArgs_, Error_>, Loading>;
+export declare const isRefreshing: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => state is WithPhase<Active<Item_, UserArgs_, Error_>, Refreshing<Item_>>;
+export declare const isSuccess: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => state is WithPhase<Active<Item_, UserArgs_, Error_>, Success<Item_>>;
+export declare const isFailure: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => state is WithPhase<Active<Item_, UserArgs_, Error_>, Failure<Error_>>;
+export declare const isStale: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => state is WithPhase<Active<Item_, UserArgs_, Error_>, Stale<Item_, Error_>>;
+export declare const isPending: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => boolean;
+export declare const canNext: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => boolean;
+export declare const canPrev: <Item_, UserArgs_, Error_>(state: State<Item_, UserArgs_, Error_>) => boolean;
+/** Pattern-match exhaustively on the machine's AsyncData-style state. */
+export declare const match: {
+    <Item_, Error_, A, B, C, D, E, F>(handlers: {
+        readonly onIdle: (idle: Idle) => A;
+        readonly onLoading: (loading: Loading) => B;
+        readonly onRefreshing: (refreshing: Refreshing<Item_>) => C;
+        readonly onFailure: (failure: Failure<Error_>) => D;
+        readonly onStale: (stale: Stale<Item_, Error_>) => E;
+        readonly onSuccess: (success: Success<Item_>) => F;
+    }): <UserArgs_>(state: State<Item_, UserArgs_, Error_>) => A | B | C | D | E | F;
+    <Item_, UserArgs_, Error_, A, B, C, D, E, F>(state: State<Item_, UserArgs_, Error_>, handlers: {
+        readonly onIdle: (idle: Idle) => A;
+        readonly onLoading: (loading: Loading) => B;
+        readonly onRefreshing: (refreshing: Refreshing<Item_>) => C;
+        readonly onFailure: (failure: Failure<Error_>) => D;
+        readonly onStale: (stale: Stale<Item_, Error_>) => E;
+        readonly onSuccess: (success: Success<Item_>) => F;
+    }): A | B | C | D | E | F;
+};
+//# sourceMappingURL=PaginatedQuery.d.ts.map

package/dist/PaginatedQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PaginatedQuery.d.ts","sourceRoot":"","sources":["../src/PaginatedQuery.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,eAAe,MAAM,+BAA+B,CAAC;AACjE,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC;AAGpC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,wDAAwD;AACxD,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;CAC3C;AAED,eAAO,MAAM,cAAc;;;EAGzB,CAAC;AAEH,4DAA4D;AAC5D,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CACpC;AAKD,eAAO,MAAM,OAAO;;;;EAIlB,CAAC;AAEH,sDAAsD;AACtD,MAAM,MAAM,SAAS,GACjB,SAAS,GACT,MAAM,GACN,UAAU,GACV,OAAO,GACP,OAAO,GACP,OAAO,CAAC;AAEZ,+EAA+E;AAC/E,MAAM,WAAW,IAAI,CAAC,KAAK;IACzB,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;IACrC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC;IACpC,OAAO,EAAE;QAAE,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;KAAE,CAAC;CAC5C,CAAC,CAAC;AAEH,MAAM,MAAM,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC;IAC9C,UAAU,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;KAAE,CAAC;CAC3E,CAAC,CAAC;AAEH,MAAM,MAAM,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC;IAC3C,OAAO,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;KAAE,CAAC;CACzC,CAAC,CAAC;AAEH,MAAM,MAAM,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;IAC5C,OAAO,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,MAAM,KAAK,CAAC,KAAK,EAAE,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;IACjD,KAAK,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/D,CAAC,CAAC;AAEH,MAAM,MAAM,KAAK,CAAC,KAAK,EAAE,MAAM,IAC3B,OAAO,GACP,UAAU,CAAC,KAAK,CAAC,GACjB,OAAO,CAAC,KAAK,CAAC,GACd,OAAO,CAAC,MAAM,CAAC,GACf,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAQzB,+EAA+E;AAC/E,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC;IACjC,IAAI,EAAE;QAAE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;CACvC,CAAC,CAAC;AAEH,wCAAwC;AACxC,MAAM,MAAM,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;IAC7D,MAAM,EAAE;QACN,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;QAC5B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;QACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;QAC1B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;QAC3B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;QACjC,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;QAClD,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;KACtC,CAAC;CACH,CAAC,CAAC;AAEH,iDAAiD;AACjD,MAAM,MAAM,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,IACtC,IAAI,GACJ,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;AAQrC,4EAA4E;AAC5E,MAAM,WAAW,mBAAmB,CAAC,SAAS;IAC5C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;CACrC;AAED,wEAAwE;AACxE,MAAM,WAAW,OAAO,CAAC,SAAS;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;CACrC;AAED,mEAAmE;AACnE,MAAM,WAAW,UAAU,CAAC,KAAK;IAC/B,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,UAAU,CAAC,EAAE,kBAAkB,GAAG,eAAe,GAAG,IAAI,CAAC;CACnE;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM;IAClD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IACrC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;CAC3D;AAED,MAAM,MAAM,IAAI,CAAC,KAAK,SAAS,GAAG,CAAC,8BAA8B,IAC/D,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAErC,MAAM,MAAM,QAAQ,CAAC,KAAK,SAAS,GAAG,CAAC,8BAA8B,IAAI,IAAI,CAC3E,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EACf,gBAAgB,CACjB,CAAC;AAEF,KAAK,mBAAmB,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC;IACjD,aAAa,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3C,CAAC,CAAC;AAMH,qEAAqE;AACrE,eAAO,MAAM,aAAa;;;;;CACgC,CAAC;AAE3D,mFAAmF;AACnF,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,GAAG,CAAC,8BAA8B,IAAI;IAC5E,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC;CACjB,SAAS,CAAC,KAAK,CAAC,GACb,KAAK,GACL,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1C,oEAAoE;AACpE,MAAM,MAAM,KAAK,CAAC,KAAK,SAAS,GAAG,CAAC,8BAA8B,IAC9D,aAAa,CAAC,KAAK,CAAC,GACpB,eAAe,CAAC,aAAa,GAC7B,MAAM,CAAC,oBAAoB,GAC3B,MAAM,CAAC,WAAW,CAAC;AAEvB,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE9D,KAAK,YAAY,CAAC,KAAK,SAAS,GAAG,CAAC,8BAA8B,IAAI,KAAK,CACzE,IAAI,CAAC,KAAK,CAAC,EACX,QAAQ,CAAC,KAAK,CAAC,EACf,KAAK,CAAC,KAAK,CAAC,CACb,CAAC;AAEF,KAAK,aAAa,CAAC,KAAK,SAAS,GAAG,CAAC,8BAA8B,IAAI,MAAM,CAC3E,IAAI,CAAC,KAAK,CAAC,EACX,QAAQ,CAAC,KAAK,CAAC,EACf,KAAK,CAAC,KAAK,CAAC,CACb,CAAC;AAEF,4DAA4D;AAC5D,MAAM,WAAW,cAAc,CAC7B,KAAK,SAAS,GAAG,CAAC,8BAA8B;IAEhD,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5D,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,yBAAyB,EAAE,MAAM,CAAC,KAAK,CAC9C,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EACpC,OAAO,CACR,CAAC;IACF,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACxE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,CAC/B,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EACtD,OAAO,CACR,CAAC;IACF,QAAQ,CAAC,IAAI,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,SAAS,KAAK,GAC9C,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,KAAK,aAAa,CAAC,KAAK,CAAC,GACvD,CACE,KAAK,EAAE,IAAI,EACX,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,EACrB,OAAO,EAAE,OAAO,KACb,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,SAAS,KAAK,GACtD,CAAC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,aAAa,CAAC,KAAK,CAAC,GACxE,CACE,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,EAC3B,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,EACrB,OAAO,CAAC,EAAE,OAAO,KACd,aAAa,CAAC,KAAK,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,GAAG,GAAG,cAAc,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;AA0DrE,kDAAkD;AAClD,eAAO,MAAM,IAAI,GAAI,KAAK,SAAS,GAAG,CAAC,8BAA8B,OAC9D,KAAK,KACT,cAAc,CAAC,KAAK,CA4KtB,CAAC;AAaF,sEAAsE;AACtE,eAAO,MAAM,sBAAsB,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACtD,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACtC,mBAAmB,CAAC,SAAS,CAO9B,CAAC;AAEH,wEAAwE;AACxE,eAAO,MAAM,eAAe,GAAI,SAAS,WAC9B,mBAAmB,CAAC,SAAS,CAAC,gBACzB,MAAM,KACnB,OAAO,CAAC,SAAS,CAGlB,CAAC;AAuBH,uEAAuE;AACvE,eAAO,MAAM,KAAK,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACrC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACtC,IAAoD,CAAC;AAExD,iFAAiF;AACjF,eAAO,MAAM,KAAK,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACrC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACtC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAQhC,CAAC;AAEH,4EAA4E;AAC5E,eAAO,MAAM,IAAI,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACpC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACtC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CA8B9C,CAAC;AAEJ,gFAAgF;AAChF,eAAO,MAAM,IAAI,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACpC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACtC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAyB9C,CAAC;AAEJ,gFAAgF;AAChF,eAAO,MAAM,KAAK,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACrC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACtC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAiB9C,CAAC;AAEJ,gFAAgF;AAChF,eAAO,MAAM,gBAAgB,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SAChD,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,aAC3B,OAAO,CAAC,SAAS,CAAC,KAC5B,OA4BA,CAAC;AAqFJ;;;;;GAKG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EACvB,UAAU,EAAE,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,GAC/C,CACD,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACnC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EACvB,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,EACtC,UAAU,EAAE,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,GAC/C,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;CAmCpC,CAAC;AAEF,uDAAuD;AACvD,eAAO,MAAM,OAAO,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACvC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAKzB,CAAC;AAEJ,+CAA+C;AAC/C,eAAO,MAAM,QAAQ,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACxC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CACa,CAAC;AAEnD,6DAA6D;AAC7D,eAAO,MAAM,QAAQ,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACxC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,MAAM,CAAC,MAAM,CAAC,MAAM,CAapB,CAAC;AAEJ,wEAAwE;AACxE,eAAO,MAAM,gBAAgB,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SAChD,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACtC,MAAoC,CAAC;AAExC,eAAO,MAAM,OAAO,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACvC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,OAAwC,CAAC;AAE5C,eAAO,MAAM,QAAQ,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACxC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,OAAyC,CAAC;AAE7C,eAAO,MAAM,OAAO,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACvC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,OAKA,CAAC;AAEJ,eAAO,MAAM,MAAM,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACtC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,OAWA,CAAC;AAEJ,KAAK,SAAS,CAAC,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,MAAM,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACtC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,KAAK,IAAI,IAA6B,CAAC;AAE1C,eAAO,MAAM,SAAS,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACzC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,KAAK,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,CACJ,CAAC;AAE5D,eAAO,MAAM,YAAY,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SAC5C,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,KAAK,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CACX,CAAC;AAE/D,eAAO,MAAM,SAAS,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACzC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,KAAK,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CACX,CAAC;AAE5D,eAAO,MAAM,SAAS,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACzC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,KAAK,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CACZ,CAAC;AAE5D,eAAO,MAAM,OAAO,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACvC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,KAAK,IAAI,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CACnB,CAAC;AAE1D,eAAO,MAAM,SAAS,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACzC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,OAWA,CAAC;AAEJ,eAAO,MAAM,OAAO,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACvC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,OAWA,CAAC;AAEJ,eAAO,MAAM,OAAO,GAAI,KAAK,EAAE,SAAS,EAAE,MAAM,SACvC,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACrC,OAWA,CAAC;AAEJ,yEAAyE;AACzE,eAAO,MAAM,KAAK,EAAE;IAClB,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE;QAC1C,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,CAAC,CAAC;QACnC,QAAQ,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,CAAC,CAAC;QAC5C,QAAQ,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5D,QAAQ,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpD,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QACrD,QAAQ,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACpD,GAAG,CAAC,SAAS,EACZ,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,KACnC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EACzC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,EACtC,QAAQ,EAAE;QACR,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,CAAC,CAAC;QACnC,QAAQ,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,CAAC,CAAC;QAC5C,QAAQ,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5D,QAAQ,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpD,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QACrD,QAAQ,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACpD,GACA,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CA4B1B,CAAC"}

package/dist/PaginatedQuery.js

@@ -0,0 +1,351 @@
+import { __exportAll } from "./_virtual/_rolldown/runtime.js";
+import { WebSocketClientError } from "./Client.js";
+import * as Option from "effect/Option";
+import * as Match from "effect/Match";
+import * as MiddlewareSpec from "@confect/core/MiddlewareSpec";
+import * as PaginationError from "@confect/core/PaginationError";
+import { InvalidCursor } from "@confect/core/PaginationError";
+import * as Ref from "@confect/core/Ref";
+import * as Data from "effect/Data";
+import * as Function from "effect/Function";
+import * as Result from "effect/Result";
+import * as Schema from "effect/Schema";
+import * as SchemaGetter from "effect/SchemaGetter";
+import * as SchemaIssue from "effect/SchemaIssue";
+//#region src/PaginatedQuery.ts
+var PaginatedQuery_exports = /* @__PURE__ */ __exportAll({
+	FunctionError: () => FunctionError,
+	InvalidCursor: () => InvalidCursor,
+	Options: () => Options,
+	PageDescriptor: () => PageDescriptor,
+	allocateRequest: () => allocateRequest,
+	canNext: () => canNext,
+	canPrev: () => canPrev,
+	close: () => close,
+	first: () => first,
+	getError: () => getError,
+	getItems: () => getItems,
+	getPage: () => getPage,
+	getSubscriptionRequest: () => getSubscriptionRequest,
+	hasError: () => hasError,
+	hasPage: () => hasPage,
+	isCurrentRequest: () => isCurrentRequest,
+	isFailure: () => isFailure,
+	isFirst: () => isFirst,
+	isIdle: () => isIdle,
+	isLast: () => isLast,
+	isLoading: () => isLoading,
+	isPending: () => isPending,
+	isRefreshing: () => isRefreshing,
+	isStale: () => isStale,
+	isSuccess: () => isSuccess,
+	make: () => make,
+	match: () => match,
+	next: () => next,
+	prev: () => prev,
+	reset: () => reset,
+	settle: () => settle,
+	targetPageNumber: () => targetPageNumber
+});
+const PageDescriptor = Schema.Struct({
+	cursor: Schema.Union([Schema.String, Schema.Null]),
+	endCursor: Schema.Option(Schema.String)
+});
+const PositiveInt = Schema.Int.check(Schema.isGreaterThan(0));
+const NonNegativeInt = Schema.Int.check(Schema.isGreaterThanOrEqualTo(0));
+const Options = Schema.Struct({
+	initialNumItems: PositiveInt,
+	maximumRowsRead: Schema.optionalKey(PositiveInt),
+	maximumBytesRead: Schema.optionalKey(PositiveInt)
+});
+const Phase = Data.taggedEnum();
+const State = Data.taggedEnum();
+/** Constructs a declared function or middleware failure envelope. */
+const FunctionError = Data.taggedEnum().FunctionError;
+const firstDescriptor = () => ({
+	cursor: null,
+	endCursor: Option.none()
+});
+const decodeOptions = Schema.decodeUnknownSync(Options);
+const initialState = (generation, args, options) => State.Active({
+	generation,
+	args,
+	options: decodeOptions(options),
+	paginationId: Option.none(),
+	requestId: 1,
+	current: firstDescriptor(),
+	prevStack: [],
+	phase: Phase.Loading({ direction: "Initial" })
+});
+const missingPaginatedProvenanceError = (ref) => new globalThis.Error(`Paginated query ref "${Ref.getConvexFunctionName(ref)}" was not built with \`FunctionSpec.publicPaginatedQuery\`. \`PaginatedQuery.make\` requires the user-args and item schemas that constructor stores.`);
+const paginatedKindOrThrow = (ref) => Match.value(ref.kind).pipe(Match.tag("Paginated", (kind) => kind), Match.tag("Standard", () => {
+	throw missingPaginatedProvenanceError(ref);
+}), Match.exhaustive);
+const SchemaErrorJson = Schema.TaggedStruct("SchemaError", { message: Schema.String });
+const SerializableSchemaError = Schema.instanceOf(Schema.SchemaError, { toCodecJson: () => Schema.link()(SchemaErrorJson, {
+	decode: SchemaGetter.transform(({ message }) => new Schema.SchemaError(new SchemaIssue.InvalidValue({ message }))),
+	encode: SchemaGetter.transform((error) => SchemaErrorJson.make({ message: error.message }))
+}) });
+/** Builds a page machine from a paginated ref. */
+const make = (ref) => {
+	const kind = paginatedKindOrThrow(ref);
+	const hasUserArgs = globalThis.Object.keys(kind.userArgs.fields).length > 0;
+	const functionErrorSchemas = [..."error" in ref && ref.error !== void 0 ? [ref.error] : [], ...MiddlewareSpec.errorSchemas(ref.middlewareSpecs)];
+	const errorSchema = Schema.Union([
+		PaginationError.InvalidCursor,
+		WebSocketClientError,
+		SerializableSchemaError,
+		...functionErrorSchemas.length === 0 ? [] : [Schema.TaggedStruct("FunctionError", { error: functionErrorSchemas.length === 1 ? functionErrorSchemas[0] : Schema.Union(functionErrorSchemas) })]
+	]);
+	const directions = Schema.Literals([
+		"Initial",
+		"Next",
+		"Previous",
+		"First",
+		"Split",
+		"Reset"
+	]);
+	const page = Schema.Struct({
+		descriptor: PageDescriptor,
+		number: PositiveInt,
+		items: kind.page,
+		continueCursor: Schema.String,
+		isDone: Schema.Boolean
+	});
+	const phase = Schema.TaggedUnion({
+		Loading: { direction: directions },
+		Refreshing: {
+			data: page,
+			direction: directions
+		},
+		Success: { data: page },
+		Failure: { error: errorSchema },
+		Stale: {
+			data: page,
+			error: errorSchema
+		}
+	});
+	const subscriptionRequestSchema = Schema.Struct({
+		generation: PositiveInt,
+		args: kind.userArgs,
+		options: Options,
+		paginationId: Schema.Option(PositiveInt),
+		requestId: PositiveInt,
+		descriptor: PageDescriptor
+	});
+	const requestSchema = Schema.Struct({
+		generation: PositiveInt,
+		args: kind.userArgs,
+		options: Options,
+		paginationId: PositiveInt,
+		requestId: PositiveInt,
+		descriptor: PageDescriptor
+	});
+	const pageResult = Schema.Struct({
+		page: kind.page,
+		isDone: Schema.Boolean,
+		continueCursor: Schema.String,
+		splitCursor: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+		pageStatus: Schema.optionalKey(Schema.Union([
+			Schema.Literal("SplitRecommended"),
+			Schema.Literal("SplitRequired"),
+			Schema.Null
+		]))
+	});
+	const schema = Schema.TaggedUnion({
+		Idle: { generation: NonNegativeInt },
+		Active: {
+			generation: PositiveInt,
+			args: kind.userArgs,
+			options: Options,
+			paginationId: Schema.Option(PositiveInt),
+			requestId: PositiveInt,
+			current: PageDescriptor,
+			prevStack: Schema.Array(PageDescriptor),
+			phase
+		}
+	});
+	const settlement = Schema.Struct({
+		request: requestSchema,
+		result: Schema.Result(pageResult, errorSchema)
+	});
+	const init = (state, argsOrOptions, options) => Match.value(options).pipe(Match.withReturnType(), Match.when(void 0, () => initialState(state.generation + 1, {}, argsOrOptions)), Match.when(Match.defined, (definedOptions) => initialState(state.generation + 1, argsOrOptions, definedOptions)), Match.exhaustive);
+	const reinitialize = (state, argsOrOptions, options) => Match.value(options).pipe(Match.withReturnType(), Match.when(Match.defined, (definedOptions) => initialState(state.generation + 1, argsOrOptions, definedOptions)), Match.when(void 0, () => Match.value(argsOrOptions).pipe(Match.withReturnType(), Match.when(void 0, () => initialState(state.generation + 1, state.args, state.options)), Match.when(Match.defined, (definedArgsOrOptions) => Match.value(hasUserArgs).pipe(Match.withReturnType(), Match.when(true, () => initialState(state.generation + 1, definedArgsOrOptions, state.options)), Match.when(false, () => initialState(state.generation + 1, state.args, definedArgsOrOptions)), Match.exhaustive)), Match.exhaustive)), Match.exhaustive);
+	return {
+		ref,
+		schema,
+		idle: State.Idle({ generation: 0 }),
+		subscriptionRequestSchema,
+		requestSchema,
+		settlement,
+		init,
+		reinitialize
+	};
+};
+const descriptorEquals = (a, b) => a.cursor === b.cursor && Option.match(a.endCursor, {
+	onNone: () => Option.isNone(b.endCursor),
+	onSome: (aEnd) => Option.match(b.endCursor, {
+		onNone: () => false,
+		onSome: (bEnd) => aEnd === bEnd
+	})
+});
+/** Returns the logical request currently driving the subscription. */
+const getSubscriptionRequest = (state) => ({
+	generation: state.generation,
+	args: state.args,
+	options: state.options,
+	paginationId: state.paginationId,
+	requestId: state.requestId,
+	descriptor: state.current
+});
+/** Attaches the client-allocated pagination id to a logical request. */
+const allocateRequest = (request, paginationId) => ({
+	...request,
+	paginationId
+});
+const phaseData = (phase) => Match.value(phase).pipe(Match.withReturnType(), Match.tag("Refreshing", "Success", "Stale", (dataPhase) => Option.some(dataPhase.data)), Match.tag("Loading", "Failure", () => Option.none()), Match.exhaustive);
+const pendingPhase = (data, direction) => Option.match(data, {
+	onNone: () => Phase.Loading({ direction }),
+	onSome: (page) => Phase.Refreshing({
+		data: page,
+		direction
+	})
+});
+/** Close the subscription while retaining its generation tombstone. */
+const close = (state) => State.Idle({ generation: state.generation });
+/** Start a fresh pagination session at page one while retaining visible data. */
+const reset = (state) => ({
+	...state,
+	generation: state.generation + 1,
+	paginationId: Option.none(),
+	requestId: 1,
+	current: firstDescriptor(),
+	prevStack: [],
+	phase: pendingPhase(phaseData(state.phase), "Reset")
+});
+/** Navigate to the next page, retaining the current page while it loads. */
+const next = (state) => Match.value(state.phase).pipe(Match.withReturnType(), Match.tag("Success", ({ data }) => Match.value(data.isDone).pipe(Match.withReturnType(), Match.when(true, () => Option.none()), Match.when(false, () => Option.some({
+	...state,
+	requestId: state.requestId + 1,
+	current: {
+		cursor: Option.getOrElse(data.descriptor.endCursor, () => data.continueCursor),
+		endCursor: Option.none()
+	},
+	prevStack: [...state.prevStack, data.descriptor],
+	phase: Phase.Refreshing({
+		data,
+		direction: "Next"
+	})
+})), Match.exhaustive)), Match.tag("Loading", "Refreshing", "Failure", "Stale", () => Option.none()), Match.exhaustive);
+/** Navigate to the previous page, retaining the current page while it loads. */
+const prev = (state) => Match.value(state.phase).pipe(Match.withReturnType(), Match.tag("Success", ({ data }) => {
+	const current = state.prevStack.at(-1);
+	return Match.value(current).pipe(Match.withReturnType(), Match.when(void 0, () => Option.none()), Match.when(Match.defined, (previous) => Option.some({
+		...state,
+		requestId: state.requestId + 1,
+		current: previous,
+		prevStack: state.prevStack.slice(0, -1),
+		phase: Phase.Refreshing({
+			data,
+			direction: "Previous"
+		})
+	})), Match.exhaustive);
+}), Match.tag("Loading", "Refreshing", "Failure", "Stale", () => Option.none()), Match.exhaustive);
+/** Navigate to page one without invalidating the current pagination session. */
+const first = (state) => Match.value(state.prevStack.length === 0 && descriptorEquals(state.current, firstDescriptor())).pipe(Match.withReturnType(), Match.when(true, () => Option.none()), Match.when(false, () => Option.some({
+	...state,
+	requestId: state.requestId + 1,
+	current: firstDescriptor(),
+	prevStack: [],
+	phase: pendingPhase(phaseData(state.phase), "First")
+})), Match.exhaustive);
+/** Whether a request still names the machine's live pagination session/page. */
+const isCurrentRequest = (state, candidate) => Match.value(state).pipe(Match.tag("Idle", () => false), Match.tag("Active", (active) => Match.value(active.paginationId).pipe(Match.tag("None", () => Match.value(active.generation === candidate.generation && active.requestId === candidate.requestId && descriptorEquals(active.current, candidate.descriptor)).pipe(Match.when(true, () => true), Match.when(false, () => false), Match.exhaustive)), Match.tag("Some", ({ value }) => active.generation === candidate.generation && value === candidate.paginationId && active.requestId === candidate.requestId && descriptorEquals(active.current, candidate.descriptor)), Match.exhaustive)), Match.exhaustive);
+const pageFromResult = (state, result) => ({
+	descriptor: state.current,
+	number: state.prevStack.length + 1,
+	items: result.page,
+	continueCursor: result.continueCursor,
+	isDone: result.isDone
+});
+const settleSuccess = (state, result) => {
+	const splitCursor = result.splitCursor;
+	const splitSignaled = Match.value(result.pageStatus).pipe(Match.whenOr("SplitRecommended", "SplitRequired", () => true), Match.whenOr(null, void 0, () => false), Match.exhaustive);
+	const shouldSplit = typeof splitCursor === "string" && (splitSignaled || result.page.length > 2 * state.options.initialNumItems);
+	const shouldRetreat = result.page.length === 0 && result.isDone && state.prevStack.length > 0;
+	return Match.value(shouldSplit).pipe(Match.withReturnType(), Match.when(true, () => {
+		const deliveredPage = pageFromResult(state, result);
+		const previous = Match.value(result.pageStatus).pipe(Match.withReturnType(), Match.when("SplitRequired", () => phaseData(state.phase)), Match.whenOr("SplitRecommended", null, void 0, () => Option.some(deliveredPage)), Match.exhaustive);
+		return {
+			...state,
+			requestId: state.requestId + 1,
+			current: {
+				cursor: state.current.cursor,
+				endCursor: Option.fromNullishOr(splitCursor)
+			},
+			phase: pendingPhase(previous, "Split")
+		};
+	}), Match.when(false, () => Match.value(shouldRetreat).pipe(Match.withReturnType(), Match.when(true, () => ({
+		...state,
+		requestId: state.requestId + 1,
+		current: state.prevStack[state.prevStack.length - 1],
+		prevStack: state.prevStack.slice(0, -1),
+		phase: pendingPhase(phaseData(state.phase), "Previous")
+	})), Match.when(false, () => ({
+		...state,
+		phase: Phase.Success({ data: pageFromResult(state, result) })
+	})), Match.exhaustive)), Match.exhaustive);
+};
+const settleFailure = (state, error) => ({
+	...state,
+	phase: Option.match(phaseData(state.phase), {
+		onNone: () => Phase.Failure({ error }),
+		onSome: (data) => Phase.Stale({
+			error,
+			data
+		})
+	})
+});
+/**
+* Fold a correlated `Result` into the machine. Like `AsyncData.settle`, a
+* success becomes `Success`; a failure becomes `Stale` when a page is held,
+* otherwise `Failure`. Outcomes from superseded requests and outcomes that
+* arrive after the subscription closed are ignored.
+*/
+const settle = Function.dual(2, (state, settlement) => Match.value(state).pipe(Match.withReturnType(), Match.tag("Idle", () => state), Match.tag("Active", (active) => Match.value(isCurrentRequest(active, settlement.request)).pipe(Match.when(false, () => active), Match.when(true, () => {
+	const allocated = {
+		...active,
+		paginationId: Option.some(settlement.request.paginationId)
+	};
+	return Result.match(settlement.result, {
+		onSuccess: (result) => settleSuccess(allocated, result),
+		onFailure: (error) => Match.value(error).pipe(Match.when(Match.instanceOf(PaginationError.InvalidCursor), () => reset(allocated)), Match.orElse((other) => settleFailure(allocated, other)))
+	});
+}), Match.exhaustive)), Match.exhaustive));
+/** The complete page currently available to render. */
+const getPage = (state) => Match.value(state).pipe(Match.tag("Idle", () => Option.none()), Match.tag("Active", ({ phase }) => phaseData(phase)), Match.exhaustive);
+/** The items currently available to render. */
+const getItems = (state) => Option.map(getPage(state), (page) => page.items);
+/** The error from the most recent failed request, if any. */
+const getError = (state) => Match.value(state).pipe(Match.withReturnType(), Match.tag("Idle", () => Option.none()), Match.tag("Active", ({ phase }) => Match.value(phase).pipe(Match.withReturnType(), Match.tag("Failure", "Stale", ({ error }) => Option.some(error)), Match.tag("Loading", "Refreshing", "Success", () => Option.none()), Match.exhaustive)), Match.exhaustive);
+/** The 1-indexed page number currently targeted by the subscription. */
+const targetPageNumber = (state) => state.prevStack.length + 1;
+const hasPage = (state) => Option.isSome(getPage(state));
+const hasError = (state) => Option.isSome(getError(state));
+const isFirst = (state) => Match.value(state).pipe(Match.tag("Idle", () => false), Match.tag("Active", ({ prevStack }) => prevStack.length === 0), Match.exhaustive);
+const isLast = (state) => Match.value(state).pipe(Match.tag("Idle", () => false), Match.tag("Active", ({ phase }) => Match.value(phase).pipe(Match.tag("Success", ({ data }) => data.isDone), Match.tag("Loading", "Refreshing", "Failure", "Stale", () => false), Match.exhaustive)), Match.exhaustive);
+const isIdle = (state) => state._tag === "Idle";
+const isLoading = (state) => state._tag === "Active" && state.phase._tag === "Loading";
+const isRefreshing = (state) => state._tag === "Active" && state.phase._tag === "Refreshing";
+const isSuccess = (state) => state._tag === "Active" && state.phase._tag === "Success";
+const isFailure = (state) => state._tag === "Active" && state.phase._tag === "Failure";
+const isStale = (state) => state._tag === "Active" && state.phase._tag === "Stale";
+const isPending = (state) => Match.value(state).pipe(Match.tag("Idle", () => false), Match.tag("Active", ({ phase }) => Match.value(phase).pipe(Match.tag("Loading", "Refreshing", () => true), Match.tag("Success", "Failure", "Stale", () => false), Match.exhaustive)), Match.exhaustive);
+const canNext = (state) => Match.value(state).pipe(Match.tag("Idle", () => false), Match.tag("Active", ({ phase }) => Match.value(phase).pipe(Match.tag("Success", ({ data }) => !data.isDone), Match.tag("Loading", "Refreshing", "Failure", "Stale", () => false), Match.exhaustive)), Match.exhaustive);
+const canPrev = (state) => Match.value(state).pipe(Match.tag("Idle", () => false), Match.tag("Active", ({ phase, prevStack }) => Match.value(phase).pipe(Match.tag("Success", () => prevStack.length > 0), Match.tag("Loading", "Refreshing", "Failure", "Stale", () => false), Match.exhaustive)), Match.exhaustive);
+/** Pattern-match exhaustively on the machine's AsyncData-style state. */
+const match = Function.dual(2, (state, handlers) => Match.value(state).pipe(Match.tag("Idle", handlers.onIdle), Match.tag("Active", ({ phase }) => Match.value(phase).pipe(Match.tag("Loading", handlers.onLoading), Match.tag("Refreshing", handlers.onRefreshing), Match.tag("Failure", handlers.onFailure), Match.tag("Stale", handlers.onStale), Match.tag("Success", handlers.onSuccess), Match.exhaustive)), Match.exhaustive));
+//#endregion
+export { FunctionError, InvalidCursor, Options, PageDescriptor, PaginatedQuery_exports, allocateRequest, canNext, canPrev, close, first, getError, getItems, getPage, getSubscriptionRequest, hasError, hasPage, isCurrentRequest, isFailure, isFirst, isIdle, isLast, isLoading, isPending, isRefreshing, isStale, isSuccess, make, match, next, prev, reset, settle, targetPageNumber };
+
+//# sourceMappingURL=PaginatedQuery.js.map