@redocly/theme 0.60.0-next.8 → 0.61.0-next.0

package/src/core/types/catalog.ts

@@ -1,11 +1,26 @@
 import { InfiniteData, UseInfiniteQueryResult } from '@tanstack/react-query';
 import { ENTITY_RELATION_TYPES } from '@redocly/config';
 
-import type { CatalogEntityConfig, LayoutVariant } from '@redocly/config';
+import type { CatalogEntityConfig, EntitiesCatalogConfig, LayoutVariant } from '@redocly/config';
 import type { CatalogFilterConfig } from '@redocly/theme/config';
 
 export type SortOption = 'title' | '-title' | 'type' | '-type';
 
+export type FilterResult = {
+  value: string;
+  count: number;
+};
+
+export type CatalogFiltersWithCounts = Record<string, FilterResult[]>;
+
+export type UseCatalogProps = {
+  config?: CatalogEntityConfig;
+  entitiesCatalogConfig?: EntitiesCatalogConfig;
+  serverFilters?: CatalogFiltersWithCounts;
+  entitiesCounterInitial?: number;
+  initialViewMode?: CatalogViewMode;
+};
+
 export type UseCatalogResponse = {
   filters: ResolvedFilter[];
   filterQuery: string;
@@ -25,6 +40,16 @@ export type UseCatalogResponse = {
   collapsedSidebar: boolean;
 };
 
+export type UseCatalogFetchCatalogEntities = (
+  params: CatalogApiParams,
+  initialData?: BffCatalogEntityList,
+) => CatalogApiResults<BffCatalogEntity>;
+
+export type UseCatalogFetchCatalogEntitiesRelations = (
+  params: CatalogApiParams & { entityKey: string },
+  initialData?: BffCatalogRelatedEntityList,
+) => CatalogApiResults<BffCatalogRelatedEntity>;
+
 export type UseCatalogSortResponse = {
   sortOption: SortOption | null;
   setSortOption: (option: SortOption | null) => void;
@@ -92,8 +117,8 @@ export type DefaultCatalogSlug =
   | 'api-descriptions'
   | 'all';
 
-export type CatalogApiResults<T, L> = {
-  query: UseInfiniteQueryResult<InfiniteData<L, unknown>, Error>;
+export type CatalogApiResults<T> = {
+  query: UseInfiniteQueryResult<InfiniteData<BffCatalogList<T>, unknown>, Error>;
   items: T[];
   total: number;
 };
@@ -186,17 +211,14 @@ export type BffCatalogEntity = {
   readonly updatedAt: string;
 };
 
-export type BffCatalogEntityList = {
+export type BffCatalogList<T> = {
   object: 'list';
   page: Page;
-  items: Array<BffCatalogEntity>;
+  items: Array<T>;
 };
 
-export type BffCatalogRelatedEntityList = {
-  object: 'list';
-  page: Page;
-  items: Array<BffCatalogRelatedEntity>;
-};
+export type BffCatalogEntityList = BffCatalogList<BffCatalogEntity>;
+export type BffCatalogRelatedEntityList = BffCatalogList<BffCatalogRelatedEntity>;
 
 export type Page = {
   endCursor: string | null;

package/src/core/types/hooks.ts

@@ -1,7 +1,6 @@
 import type { AsyncApiRealmUI } from '@redocly/realm-asyncapi-sdk';
 import type {
   BannerConfig,
-  CatalogEntityConfig,
   PageData,
   PageProps,
   ResolvedNavItemWithLink,
@@ -13,12 +12,12 @@ import type { To, Location, NavigateFunction } from 'react-router-dom';
 import type { CatalogConfig, ProductUiConfig } from '@redocly/theme/config';
 import type {
   UseCatalogResponse,
-  CatalogApiResults,
-  CatalogApiParams,
   FilteredCatalog,
   UseCatalogSortResponse,
   UseCatalogSearchResponse,
-  CatalogViewMode,
+  UseCatalogProps,
+  UseCatalogFetchCatalogEntities,
+  UseCatalogFetchCatalogEntitiesRelations,
 } from './catalog';
 import type { UserMenuData } from './user-menu';
 import type { ItemState } from './sidebar';
@@ -34,12 +33,6 @@ import type { TFunction } from './l10n';
 import type { BreadcrumbItem } from './breadcrumb';
 import type { DrilldownMenuItemDetails } from './sidebar';
 
-import {
-  BffCatalogEntity,
-  BffCatalogEntityList,
-  BffCatalogRelatedEntity,
-  BffCatalogRelatedEntityList,
-} from './catalog';
 import { AiSearchError } from '../constants/search';
 
 export type ThemeHooks = {
@@ -151,22 +144,11 @@ export type ThemeHooks = {
         nextPage?: ResolvedNavItemWithLink;
       }
     | undefined;
-  useCatalog: (
-    config?: CatalogEntityConfig,
-    serverFilters?: Record<string, { value: string; count: number }[]>,
-    entitiesCounterInitial?: number,
-    initialViewMode?: CatalogViewMode,
-  ) => UseCatalogResponse;
+  useCatalog: (props?: UseCatalogProps) => UseCatalogResponse;
   useCatalogSort: () => UseCatalogSortResponse;
   useCatalogSearch: () => UseCatalogSearchResponse;
-  useFetchCatalogEntities: (
-    params: CatalogApiParams,
-    initialData?: BffCatalogEntityList,
-  ) => CatalogApiResults<BffCatalogEntity, BffCatalogEntityList>;
-  useFetchCatalogEntitiesRelations: (
-    params: CatalogApiParams & { entityKey: string },
-    initialData?: BffCatalogRelatedEntityList,
-  ) => CatalogApiResults<BffCatalogRelatedEntity, BffCatalogRelatedEntityList>;
+  useFetchCatalogEntities: UseCatalogFetchCatalogEntities;
+  useFetchCatalogEntitiesRelations: UseCatalogFetchCatalogEntitiesRelations;
   useCatalogClassic: (config: CatalogConfig) => FilteredCatalog;
   useTelemetry: () => Omit<
     AsyncApiRealmUI.Telemetry,

package/lib/core/hooks/catalog/use-catalog-table-view-row.d.ts

@@ -1,11 +0,0 @@
-import type { CatalogEntityConfig, EntitiesCatalogConfig } from '@redocly/config';
-type CatalogTableViewRowProps = {
-    entityKey: string;
-    entityType: string;
-    catalogConfig: CatalogEntityConfig;
-    entitiesCatalogConfig?: EntitiesCatalogConfig;
-};
-export declare function useCatalogTableViewRow({ entityKey, entityType, catalogConfig, entitiesCatalogConfig, }: CatalogTableViewRowProps): {
-    getEntityDetailsLink: () => string;
-};
-export {};