@openrails/contentkit-ui 0.103.2 → 0.104.0-rc.2

package/dist/react/discovery.d.ts

@@ -1,19 +1,34 @@
-import { Beacons, Attribution, BeaconOptions, ViewSession } from '../client/beacons.js';
+import { Beacons, BeaconOptions } from '../client/beacons.js';
 import { ContentKitClient } from '../client/client.js';
 import { MineQuery } from '../client/content/favorites.js';
 import { ContentQuery, DailyReleasesQuery, HistoryQuery, RailQuery, ReleaseDatesQuery, SearchQuery, TypeaheadQuery } from '../client/discovery.js';
 import { ContentKitError } from '../client/errors.js';
-import { Card, ContentFilters, ContentFiltersUpdate, DailyReleases, DateCount, GroupCard, Interaction, RecentSearch } from '../client/generated/wire.js';
+import { Card, ContentFilters, ContentFiltersUpdate, ContentPage, DailyReleases, DateCount, GroupCard, Interaction, InteractionPage, RecentSearch, Typeahead } from '../client/generated/wire.js';
 import { UseList } from './use-resource.js';
+export interface UseContents extends UseList<Card, ContentPage["summary"]> {
+    summary?: ContentPage["summary"];
+}
 /** Contents as cards, a cursor page at a time; null reads nothing. */
 export declare function useContents(q: ContentQuery | null, o?: {
     client?: ContentKitClient;
-}): UseList<Card>;
-/**
- * How many contents of a list the reader doesn't open: its filters' count
- * with locked cards less without them (sort and paging aside); null reads
- * nothing.
- */
+}): UseContents;
+/** One numbered page of a list or search: its cards and the selection's summary (total included). */
+export interface UseContentsPage {
+    items: Card[];
+    summary?: ContentPage["summary"];
+    loading: boolean;
+    error?: ContentKitError;
+    reload: () => void;
+}
+/** Page `page` (from 1) of a list, with its summary; null reads nothing. */
+export declare function useContentsPage(q: ContentQuery | null, page: number, o?: {
+    client?: ContentKitClient;
+}): UseContentsPage;
+/** Page `page` (from 1) of a search, with its summary; nothing until the query has text. */
+export declare function useSearchPage(q: SearchQuery | null, page: number, o?: {
+    client?: ContentKitClient;
+}): UseContentsPage;
+/** Locked contents in the same full selection, including its activity window. */
 export declare function useLockedCount(q: ContentQuery | null, o?: {
     client?: ContentKitClient;
 }): {
@@ -23,9 +38,10 @@ export declare function useLockedCount(q: ContentQuery | null, o?: {
 /** Keyword search results as cards; nothing while q.q is empty. */
 export declare function useSearch(q: SearchQuery | null, o?: {
     client?: ContentKitClient;
-}): UseList<Card>;
+}): UseContents;
 export interface UseRail {
     items: Card[];
+    summary?: ContentPage["summary"];
     loading: boolean;
     error?: ContentKitError;
     /** The site runs without the signal plane (not_configured): leave the rail out. */
@@ -58,14 +74,16 @@ export interface UseDailyReleases {
 export declare function useDailyReleases(q?: DailyReleasesQuery | null, o?: {
     client?: ContentKitClient;
 }): UseDailyReleases;
-export interface UseHistory extends UseList<Card> {
+export interface UseHistory extends UseContents {
+    /** A status-filtered guest selection has hidden candidates whose current version facts cannot be inspected. */
+    filterSummaryUnknown?: boolean;
     /** Erases the reader's history: of one content item, one kind, or (no argument) everything. */
     forget: (o?: {
         kind?: string;
         content_id?: string;
     }) => Promise<void>;
 }
-/** What the signed-in reader engaged with, most recent first; nothing signed out, or when q is null. */
+/** Account history is authoritative; signed-out reading stays in this browser across tabs. */
 export declare function useHistory(q?: HistoryQuery | null, o?: {
     client?: ContentKitClient;
 }): UseHistory;
@@ -86,16 +104,19 @@ export declare function useRecentSearches(o?: {
 export type MyInteraction = Interaction & {
     id: string;
 };
+export interface UseInteractions extends UseList<MyInteraction, InteractionPage["summary"]> {
+    summary?: InteractionPage["summary"];
+}
 /** The signed-in reader's favorites, most recent first: content cards or groups. */
 export declare function useMyFavorites(q?: MineQuery, o?: {
     client?: ContentKitClient;
-}): UseList<MyInteraction>;
+}): UseInteractions;
 /** What the signed-in reader liked (or, with value, disliked), most recent first. */
 export declare function useMyReactions(q?: MineQuery & {
     value?: "like" | "dislike";
 }, o?: {
     client?: ContentKitClient;
-}): UseList<MyInteraction>;
+}): UseInteractions;
 export interface UseContentFilters {
     filters: ContentFilters | null;
     loading: boolean;
@@ -125,16 +146,13 @@ export declare function useTypeahead(text: string, o?: Omit<TypeaheadQuery, "q">
     minLength?: number;
     client?: ContentKitClient;
     management?: boolean;
+    request?: (query: TypeaheadQuery, signal: AbortSignal) => Promise<Typeahead>;
 }): UseTypeahead;
 /** The client's signal and exposure batcher: one per client. */
 export declare function beaconsFor(client: ContentKitClient, o?: BeaconOptions): Beacons;
 export declare function useBeacons(o?: {
     client?: ContentKitClient;
 }): Beacons;
-/** A view of a content (or one version) while it is shown: report its progress as it changes. */
-export declare function useViewSignal(content: string | null | undefined, version?: string, o?: Attribution & {
-    client?: ContentKitClient;
-}): ViewSession["update"];
 export interface ExposureOptions {
     /** Where the list is: "home", "search", "similar". */
     surface: string;
@@ -156,6 +174,7 @@ export interface UseExposure {
 /** A rendered result list: each page rendered, each card shown, clicks attributed to the render. */
 export declare function useExposure(items: readonly {
     id: string;
+    position?: number;
     version_id?: string;
     version?: {
         id: string;