@backstage/plugin-catalog-react 0.6.14-next.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,78 @@
 # @backstage/plugin-catalog-react
 
+## 0.7.0
+
+### Minor Changes
+
+- 3334ad47d4: Removed the deprecated `EntityContext` which have been replaced by `useEntity`, `EntityProvider` and `AsyncEntityProvider`.
+- e2e0b6625c: Improved API documentation.
+
+  **BREAKING**: The individual table column factories (e.g. `createEntityRefColumn`) are now no longer available directly, but only through `EntityTable.columns`.
+
+- c4276915c0: **BREAKING**: Deleted the deprecated `loadIdentityOwnerRefs` function which is replaced by `ownershipEntityRefs` from `identityApi.getBackstageIdentity()`.
+
+  Deprecated the `loadCatalogOwnerRefs` hook as membership references should be added as `ent` inside `claims` sections of the `SignInResolver` when issuing tokens. See https://backstage.io/docs/auth/identity-resolver for more details on how to prepare your `SignInResolver` if not done already. Usage of the `loadCatalogOwnerRefs` hook should be replaced by `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
+
+### Patch Changes
+
+- a8331830f1: Deprecated the `useEntityKinds` hook due to low usage and utility value.
+- 6e1cbc12a6: Updated according to the new `getEntityFacets` catalog API method
+- b776ce5aab: Deprecated the `useEntityListProvider` hook which is now renamed to `useEntityList`
+- b3ef24038b: Deprecated `reduceCatalogFilters` and `reduceEntityFilters` as these helper functions are used internally and provides low external value.
+- 2d339b5f2c: Deprecated `useEntityFromUrl` and the `useEntityCompoundName` hooks as these have very low utility value.
+- 96b8ae9a9e: Deprecated the `EntityTypeReturn` type and inlined the return type to `useEntityTypeFilter` as the type and function name does not align
+- d4f67fa728: Deprecated the `useOwnedEntities` hook which is replaced by the IdentityAPI.
+  Deprecated the `useOwnUser` hook due to low external value.
+- 919cf2f836: Minor updates to match the new `targetRef` field of relations, and to stop consuming the `target` field
+- Updated dependencies
+  - @backstage/core-components@0.8.10
+  - @backstage/catalog-model@0.11.0
+  - @backstage/catalog-client@0.7.2
+  - @backstage/core-plugin-api@0.7.0
+  - @backstage/integration@0.7.5
+  - @backstage/plugin-permission-react@0.3.2
+
+## 0.6.15
+
+### Patch Changes
+
+- 1ed305728b: Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
+- c77c5c7eb6: Added `backstage.role` to `package.json`
+- 538ca90790: Use updated type names from `@backstage/catalog-client`
+- edbc03814a: Replace usage of `serializeEntityRef` with `stringifyEntityRef`
+- 244d24ebc4: Import `Location` from the `@backstage/catalog-client` package.
+- deaf6065db: Adapt to the new `CatalogApi.getLocationByRef`
+- 216725b434: Updated to use new names for `parseLocationRef` and `stringifyLocationRef`
+- e72d371296: Use `TemplateEntityV1beta2` from `@backstage/plugin-scaffolder-common` instead
+  of `@backstage/catalog-model`.
+- 98d1aa1ea1: Fix CatalogPage showing all components when owned filter was pre-selected
+- 27eccab216: Replaces use of deprecated catalog-model constants.
+- 7aeb491394: Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
+- Updated dependencies
+  - @backstage/catalog-client@0.7.0
+  - @backstage/core-components@0.8.9
+  - @backstage/core-plugin-api@0.6.1
+  - @backstage/errors@0.2.1
+  - @backstage/integration@0.7.3
+  - @backstage/plugin-permission-common@0.5.0
+  - @backstage/plugin-permission-react@0.3.1
+  - @backstage/catalog-model@0.10.0
+  - @backstage/types@0.1.2
+  - @backstage/version-bridge@0.1.2
+
+## 0.6.14
+
+### Patch Changes
+
+- 680e7c7452: Updated `useEntityListProvider` and catalog pickers to respond to external changes to query parameters in the URL, such as two sidebar links that apply different catalog filters.
+- f8633307c4: Added an "inspect" entry in the entity three-dots menu, for lower level catalog
+  insights and debugging.
+- 19155e0939: Updated React component type declarations to avoid exporting exotic component types.
+- 7bb1bde7f6: Minor API cleanups
+- Updated dependencies
+  - @backstage/catalog-client@0.6.0
+  - @backstage/core-components@0.8.8
+
 ## 0.6.14-next.0
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="react" />
-import { CatalogApi, CatalogListResponse } from '@backstage/catalog-client';
+import { CatalogApi, GetEntitiesResponse } from '@backstage/catalog-client';
 export { CATALOG_FILTER_EXISTS, CatalogApi } from '@backstage/catalog-client';
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
-import { ApiRef, StorageApi, IdentityApi } from '@backstage/core-plugin-api';
+import { ApiRef, StorageApi } from '@backstage/core-plugin-api';
 import { Observable } from '@backstage/types';
 import * as _backstage_catalog_model from '@backstage/catalog-model';
 import { Entity, EntityName, UserEntity } from '@backstage/catalog-model';
-import React, { ReactNode, ComponentProps, Context, PropsWithChildren } from 'react';
+import React, { ReactNode, ComponentProps, PropsWithChildren } from 'react';
 import { LinkProps, TableColumn } from '@backstage/core-components';
 import { IconButton } from '@material-ui/core';
 import { AsyncState } from 'react-use/lib/useAsync';
@@ -15,6 +15,10 @@ import { ScmIntegrationRegistry } from '@backstage/integration';
 import { Overrides } from '@material-ui/core/styles/overrides';
 import { StyleRules } from '@material-ui/core/styles/withStyles';
 
+/**
+ * The API reference for the {@link @backstage/catalog-client#CatalogApi}.
+ * @public
+ */
 declare const catalogApiRef: _backstage_core_plugin_api.ApiRef<CatalogApi>;
 
 /**
@@ -88,7 +92,7 @@ declare const EntityOwnerPicker: () => JSX.Element | null;
  * @public
  */
 declare type EntityRefLinkProps = {
-    entityRef: Entity | EntityName;
+    entityRef: Entity | EntityName | string;
     defaultKind?: string;
     title?: string;
     children?: React.ReactNode;
@@ -98,7 +102,7 @@ declare type EntityRefLinkProps = {
  *
  * @public
  */
-declare const EntityRefLink: React.ForwardRefExoticComponent<Pick<EntityRefLinkProps, "replace" | "type" | "key" | "id" | "media" | "state" | "color" | "display" | "translate" | "hidden" | "dir" | "slot" | "style" | "title" | "target" | "accessKey" | "draggable" | "lang" | "className" | "prefix" | "children" | "contentEditable" | "inputMode" | "tabIndex" | "underline" | "download" | "href" | "hrefLang" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "contextMenu" | "placeholder" | "spellCheck" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "rel" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "ping" | "referrerPolicy" | "align" | "variant" | "component" | "classes" | "innerRef" | "noWrap" | "gutterBottom" | "paragraph" | "variantMapping" | "noTrack" | "TypographyClasses" | "entityRef" | "defaultKind"> & React.RefAttributes<any>>;
+declare const EntityRefLink: (props: EntityRefLinkProps) => JSX.Element;
 
 /**
  * Props for {@link EntityRefLink}.
@@ -116,62 +120,19 @@ declare type EntityRefLinksProps = {
  */
 declare const EntityRefLinks: ({ entityRefs, defaultKind, ...linkProps }: EntityRefLinksProps) => JSX.Element;
 
+/** @public */
 declare function formatEntityRefTitle(entityRef: Entity | EntityName, opts?: {
     defaultKind?: string;
 }): string;
 
 /** @public */
 declare type CatalogReactEntitySearchBarClassKey = 'searchToolbar' | 'input';
-/** @public */
+/**
+ * Renders search bar for filtering the entity list.
+ * @public
+ */
 declare const EntitySearchBar: () => JSX.Element;
 
-/** @public */
-declare function createEntityRefColumn<T extends Entity>(options: {
-    defaultKind?: string;
-}): TableColumn<T>;
-/** @public */
-declare function createEntityRelationColumn<T extends Entity>({ title, relation, defaultKind, filter: entityFilter, }: {
-    title: string;
-    relation: string;
-    defaultKind?: string;
-    filter?: {
-        kind: string;
-    };
-}): TableColumn<T>;
-/** @public */
-declare function createOwnerColumn<T extends Entity>(): TableColumn<T>;
-/** @public */
-declare function createDomainColumn<T extends Entity>(): TableColumn<T>;
-/** @public */
-declare function createSystemColumn<T extends Entity>(): TableColumn<T>;
-/** @public */
-declare function createMetadataDescriptionColumn<T extends Entity>(): TableColumn<T>;
-/** @public */
-declare function createSpecLifecycleColumn<T extends Entity>(): TableColumn<T>;
-/** @public */
-declare function createSpecTypeColumn<T extends Entity>(): TableColumn<T>;
-
-declare const columnFactories_createEntityRefColumn: typeof createEntityRefColumn;
-declare const columnFactories_createEntityRelationColumn: typeof createEntityRelationColumn;
-declare const columnFactories_createOwnerColumn: typeof createOwnerColumn;
-declare const columnFactories_createDomainColumn: typeof createDomainColumn;
-declare const columnFactories_createSystemColumn: typeof createSystemColumn;
-declare const columnFactories_createMetadataDescriptionColumn: typeof createMetadataDescriptionColumn;
-declare const columnFactories_createSpecLifecycleColumn: typeof createSpecLifecycleColumn;
-declare const columnFactories_createSpecTypeColumn: typeof createSpecTypeColumn;
-declare namespace columnFactories {
-  export {
-    columnFactories_createEntityRefColumn as createEntityRefColumn,
-    columnFactories_createEntityRelationColumn as createEntityRelationColumn,
-    columnFactories_createOwnerColumn as createOwnerColumn,
-    columnFactories_createDomainColumn as createDomainColumn,
-    columnFactories_createSystemColumn as createSystemColumn,
-    columnFactories_createMetadataDescriptionColumn as createMetadataDescriptionColumn,
-    columnFactories_createSpecLifecycleColumn as createSpecLifecycleColumn,
-    columnFactories_createSpecTypeColumn as createSpecTypeColumn,
-  };
-}
-
 /**
  * Props for {@link EntityTable}.
  *
@@ -190,12 +151,51 @@ interface EntityTableProps<T extends Entity> {
  *
  * @public
  */
-declare function EntityTable<T extends Entity>(props: EntityTableProps<T>): JSX.Element;
-declare namespace EntityTable {
-    var columns: typeof columnFactories;
-    var systemEntityColumns: TableColumn<_backstage_catalog_model.SystemEntity>[];
-    var componentEntityColumns: TableColumn<_backstage_catalog_model.ComponentEntity>[];
-}
+declare const EntityTable: {
+    <T extends Entity>(props: EntityTableProps<T>): JSX.Element;
+    columns: Readonly<{
+        createEntityRefColumn<T_1 extends Entity>(options: {
+            defaultKind?: string | undefined;
+        }): TableColumn<T_1>;
+        createEntityRelationColumn<T_2 extends Entity>({ title, relation, defaultKind, filter: entityFilter, }: {
+            title: string;
+            relation: string;
+            defaultKind?: string | undefined;
+            filter?: {
+                kind: string;
+            } | undefined;
+        }): TableColumn<T_2>;
+        createOwnerColumn<T_3 extends Entity>(): TableColumn<T_3>;
+        createDomainColumn<T_4 extends Entity>(): TableColumn<T_4>;
+        createSystemColumn<T_5 extends Entity>(): TableColumn<T_5>;
+        createMetadataDescriptionColumn<T_6 extends Entity>(): TableColumn<T_6>;
+        createSpecLifecycleColumn<T_7 extends Entity>(): TableColumn<T_7>;
+        createSpecTypeColumn<T_8 extends Entity>(): TableColumn<T_8>;
+    }>;
+    systemEntityColumns: TableColumn<_backstage_catalog_model.SystemEntity>[];
+    componentEntityColumns: TableColumn<_backstage_catalog_model.ComponentEntity>[];
+};
+
+/** @public */
+declare const columnFactories: Readonly<{
+    createEntityRefColumn<T extends Entity>(options: {
+        defaultKind?: string;
+    }): TableColumn<T>;
+    createEntityRelationColumn<T_1 extends Entity>({ title, relation, defaultKind, filter: entityFilter, }: {
+        title: string;
+        relation: string;
+        defaultKind?: string | undefined;
+        filter?: {
+            kind: string;
+        } | undefined;
+    }): TableColumn<T_1>;
+    createOwnerColumn<T_2 extends Entity>(): TableColumn<T_2>;
+    createDomainColumn<T_3 extends Entity>(): TableColumn<T_3>;
+    createSystemColumn<T_4 extends Entity>(): TableColumn<T_4>;
+    createMetadataDescriptionColumn<T_5 extends Entity>(): TableColumn<T_5>;
+    createSpecLifecycleColumn<T_6 extends Entity>(): TableColumn<T_6>;
+    createSpecTypeColumn<T_7 extends Entity>(): TableColumn<T_7>;
+}>;
 
 /** @public */
 declare type CatalogReactEntityTagPickerClassKey = 'input';
@@ -214,25 +214,43 @@ interface EntityTypePickerProps {
 /** @public */
 declare const EntityTypePicker: (props: EntityTypePickerProps) => JSX.Element | null;
 
-declare type Props$1 = ComponentProps<typeof IconButton> & {
+/** @public */
+declare type FavoriteEntityProps = ComponentProps<typeof IconButton> & {
     entity: Entity;
 };
+/** @public */
 declare const favoriteEntityTooltip: (isStarred: boolean) => "Remove from favorites" | "Add to favorites";
+/** @public */
 declare const favoriteEntityIcon: (isStarred: boolean) => JSX.Element;
 /**
  * IconButton for showing if a current entity is starred and adding/removing it from the favorite entities
  * @param props - MaterialUI IconButton props extended by required `entity` prop
+ * @public
  */
-declare const FavoriteEntity: (props: Props$1) => JSX.Element;
+declare const FavoriteEntity: (props: FavoriteEntityProps) => JSX.Element;
+
+/**
+ * A dialog that lets users inspect the low level details of their entities.
+ *
+ * @public
+ */
+declare function InspectEntityDialog(props: {
+    open: boolean;
+    entity: Entity;
+    onClose: () => void;
+}): JSX.Element | null;
 
-declare type Props = {
+/** @public */
+declare type UnregisterEntityDialogProps = {
     open: boolean;
     onConfirm: () => any;
     onClose: () => any;
     entity: Entity;
 };
-declare const UnregisterEntityDialog: ({ open, onConfirm, onClose, entity, }: Props) => JSX.Element;
+/** @public */
+declare const UnregisterEntityDialog: (props: UnregisterEntityDialogProps) => JSX.Element;
 
+/** @public */
 declare type EntityFilter = {
     /**
      * Get filters to add to the catalog-backend request. These are a dot-delimited field with
@@ -249,32 +267,31 @@ declare type EntityFilter = {
     filterEntity?: (entity: Entity) => boolean;
     /**
      * Serialize the filter value to a string for query params. The UI component responsible for
-     * handling this filter should retrieve this from useEntityListProvider.queryParameters. The
+     * handling this filter should retrieve this from useEntityList.queryParameters. The
      * value restored should be in the precedence: queryParameters `>` initialValue prop `>` default.
      */
     toQueryValue?: () => string | string[];
 };
+/** @public */
 declare type UserListFilterKind = 'owned' | 'starred' | 'all';
 
 /** @public */
 declare type CatalogReactUserListPickerClassKey = 'root' | 'title' | 'listIcon' | 'menuItem' | 'groupWrapper';
+/** @public */
 declare type UserListPickerProps = {
     initialFilter?: UserListFilterKind;
     availableFilters?: UserListFilterKind[];
 };
-declare const UserListPicker: ({ initialFilter, availableFilters, }: UserListPickerProps) => JSX.Element;
+/** @public */
+declare const UserListPicker: (props: UserListPickerProps) => JSX.Element;
 
+/** @public */
 declare type EntityLoadingStatus = {
     entity?: Entity;
     loading: boolean;
     error?: Error;
     refresh?: VoidFunction;
 };
-/**
- * @public
- * @deprecated use `useEntity` and `EntityProvider` or `AsyncEntityProvider` instead.
- */
-declare const EntityContext: Context<EntityLoadingStatus>;
 /**
  * Properties for the AsyncEntityProvider component.
  *
@@ -308,6 +325,9 @@ interface EntityProviderProps {
  * @public
  */
 declare const EntityProvider: ({ entity, children }: EntityProviderProps) => JSX.Element;
+/** @public
+ * @deprecated will be deleted shortly due to low external usage, re-implement if needed.
+ */
 declare const useEntityFromUrl: () => EntityLoadingStatus;
 /**
  * Grab the current entity from the context and its current loading state.
@@ -323,6 +343,8 @@ declare function useEntity<T extends Entity = Entity>(): {
 
 /**
  * Grabs entity kind, namespace, and name from the location
+ * @public
+ * @deprecated use {@link @backstage/core-plugin-api#useRouteRefParams} instead
  */
 declare const useEntityCompoundName: () => {
     kind: string;
@@ -330,12 +352,20 @@ declare const useEntityCompoundName: () => {
     name: string;
 };
 
+/**
+ * Filter entities based on Kind.
+ * @public
+ */
 declare class EntityKindFilter implements EntityFilter {
     readonly value: string;
     constructor(value: string);
     getCatalogFilters(): Record<string, string | string[]>;
     toQueryValue(): string;
 }
+/**
+ * Filters entities based on type
+ * @public
+ */
 declare class EntityTypeFilter implements EntityFilter {
     readonly value: string | string[];
     constructor(value: string | string[]);
@@ -343,29 +373,49 @@ declare class EntityTypeFilter implements EntityFilter {
     getCatalogFilters(): Record<string, string | string[]>;
     toQueryValue(): string[];
 }
+/**
+ * Filters entities based on tag.
+ * @public
+ */
 declare class EntityTagFilter implements EntityFilter {
     readonly values: string[];
     constructor(values: string[]);
     filterEntity(entity: Entity): boolean;
     toQueryValue(): string[];
 }
+/**
+ * Filters entities where the text matches spec, title or tags.
+ * @public
+ */
 declare class EntityTextFilter implements EntityFilter {
     readonly value: string;
     constructor(value: string);
     filterEntity(entity: Entity): boolean;
 }
+/**
+ * Filter matching entities that are owned by group.
+ * @public
+ */
 declare class EntityOwnerFilter implements EntityFilter {
     readonly values: string[];
     constructor(values: string[]);
     filterEntity(entity: Entity): boolean;
     toQueryValue(): string[];
 }
+/**
+ * Filters entities on lifecycle.
+ * @public
+ */
 declare class EntityLifecycleFilter implements EntityFilter {
     readonly values: string[];
     constructor(values: string[]);
     filterEntity(entity: Entity): boolean;
     toQueryValue(): string[];
 }
+/**
+ * Filters entities based on whatever the user has starred or owns them.
+ * @public
+ */
 declare class UserListFilter implements EntityFilter {
     readonly value: UserListFilterKind;
     readonly isOwnedEntity: (entity: Entity) => boolean;
@@ -375,6 +425,7 @@ declare class UserListFilter implements EntityFilter {
     toQueryValue(): string;
 }
 
+/** @public */
 declare type DefaultEntityFilters = {
     kind?: EntityKindFilter;
     type?: EntityTypeFilter;
@@ -384,6 +435,7 @@ declare type DefaultEntityFilters = {
     tags?: EntityTagFilter;
     text?: EntityTextFilter;
 };
+/** @public */
 declare type EntityListContextProps<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters> = {
     /**
      * The currently registered filters, adhering to the shape of DefaultEntityFilters or an extension
@@ -410,10 +462,31 @@ declare type EntityListContextProps<EntityFilters extends DefaultEntityFilters =
     loading: boolean;
     error?: Error;
 };
+/**
+ * Creates new context for entity listing and filtering.
+ * @public
+ */
 declare const EntityListContext: React.Context<EntityListContextProps<any> | undefined>;
+/**
+ * Provides entities and filters for a catalog listing.
+ * @public
+ */
 declare const EntityListProvider: <EntityFilters extends DefaultEntityFilters>({ children, }: PropsWithChildren<{}>) => JSX.Element;
+/**
+ * Hook for interacting with the entity list context provided by the {@link EntityListProvider}.
+ * @public
+ * @deprecated use {@link useEntityList} instead.
+ */
 declare function useEntityListProvider<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters>(): EntityListContextProps<EntityFilters>;
+/**
+ * Hook for interacting with the entity list context provided by the {@link EntityListProvider}.
+ * @public
+ */
+declare function useEntityList<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters>(): EntityListContextProps<EntityFilters>;
 
+/** @public
+ * @deprecated type inlined with {@link useEntityTypeFilter}.
+ */
 declare type EntityTypeReturn = {
     loading: boolean;
     error?: Error;
@@ -422,11 +495,23 @@ declare type EntityTypeReturn = {
     setSelectedTypes: (types: string[]) => void;
 };
 /**
- * A hook built on top of `useEntityListProvider` for enabling selection of valid `spec.type` values
+ * A hook built on top of `useEntityList` for enabling selection of valid `spec.type` values
  * based on the selected EntityKindFilter.
+ * @public
  */
-declare function useEntityTypeFilter(): EntityTypeReturn;
+declare function useEntityTypeFilter(): {
+    loading: boolean;
+    error?: Error;
+    availableTypes: string[];
+    selectedTypes: string[];
+    setSelectedTypes: (types: string[]) => void;
+};
 
+/**
+ * Retrieve a list of unique entity kinds present in the catalog
+ * @public
+ * @deprecated and will be removed due to low utility value.
+ */
 declare function useEntityKinds(): {
     error: Error | undefined;
     loading: boolean;
@@ -435,10 +520,13 @@ declare function useEntityKinds(): {
 
 /**
  * Get the catalog User entity (if any) that matches the logged-in user.
+ * @public
+ * @deprecated due to low external usage.
  */
 declare function useOwnUser(): AsyncState<UserEntity | undefined>;
 
-declare function useRelatedEntities(entity: Entity, { type, kind }: {
+/** @public */
+declare function useRelatedEntities(entity: Entity, relationFilter: {
     type?: string;
     kind?: string;
 }): {
@@ -447,29 +535,19 @@ declare function useRelatedEntities(entity: Entity, { type, kind }: {
     error: Error | undefined;
 };
 
+/** @public */
 declare function useStarredEntities(): {
     starredEntities: Set<string>;
     toggleStarredEntity: (entityOrRef: Entity | EntityName | string) => void;
     isStarredEntity: (entityOrRef: Entity | EntityName | string) => boolean;
 };
 
+/** @public */
 declare function useStarredEntity(entityOrRef: Entity | EntityName | string): {
     toggleStarredEntity: () => void;
     isStarredEntity: boolean;
 };
 
-/**
- * Takes the relevant parts of the Backstage identity, and translates them into
- * a list of entity refs on string form that represent the user's ownership
- * connections.
- *
- * @public
- * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
- *
- * @param identityApi - The IdentityApi implementation
- * @returns IdentityOwner refs as a string array
- */
-declare function loadIdentityOwnerRefs(identityApi: IdentityApi): Promise<string[]>;
 /**
  * Takes the relevant parts of the User entity corresponding to the Backstage
  * identity, and translates them into a list of entity refs on string form that
@@ -480,6 +558,7 @@ declare function loadIdentityOwnerRefs(identityApi: IdentityApi): Promise<string
  * @param catalogApi - The Catalog API implementation
  * @param identityOwnerRefs - List of identity owner refs as strings
  * @returns OwnerRefs as a string array
+ * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
  */
 declare function loadCatalogOwnerRefs(catalogApi: CatalogApi, identityOwnerRefs: string[]): Promise<string[]>;
 /**
@@ -505,11 +584,11 @@ declare function useEntityOwnership(): {
  * @public
  *
  * @param allowedKinds - Array of allowed kinds to filter the entities
- * @returns CatalogListResponse<Entity>
+ * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
  */
 declare function useOwnedEntities(allowedKinds?: string[]): {
     loading: boolean;
-    ownedEntities: CatalogListResponse<Entity> | undefined;
+    ownedEntities: GetEntitiesResponse | undefined;
 };
 
 /**
@@ -531,10 +610,12 @@ declare function useEntityPermission(permission: Permission): {
 
 /**
  * @deprecated Use an `ExternalRouteRef` instead, which can point to `catalogPlugin.routes.catalogIndex`.
+ * @public
  */
 declare const rootRoute: _backstage_core_plugin_api.RouteRef<undefined>;
 /**
  * @deprecated Use an `ExternalRouteRef` instead, which can point to `catalogPlugin.routes.catalogIndex`.
+ * @public
  */
 declare const catalogRouteRef: _backstage_core_plugin_api.RouteRef<undefined>;
 /**
@@ -545,6 +626,7 @@ declare const catalogRouteRef: _backstage_core_plugin_api.RouteRef<undefined>;
  *
  * If you want to replace the `EntityPage` from `@backstage/catalog-plugin` in your app,
  * you need to use the `entityRouteRef` as the mount point instead of your own.
+ * @public
  */
 declare const entityRouteRef: _backstage_core_plugin_api.RouteRef<{
     name: string;
@@ -553,43 +635,64 @@ declare const entityRouteRef: _backstage_core_plugin_api.RouteRef<{
 }>;
 /**
  * @deprecated use `entityRouteRef` instead.
+ * @public
  */
 declare const entityRoute: _backstage_core_plugin_api.RouteRef<{
     name: string;
     kind: string;
     namespace: string;
 }>;
+/**
+ * Utility function to get suitable route params for entityRoute, given an
+ * @public
+ */
 declare function entityRouteParams(entity: Entity): {
     readonly kind: string;
     readonly namespace: string;
     readonly name: string;
 };
 
+/** @public */
 declare const MockEntityListContextProvider: ({ children, value, }: React.PropsWithChildren<{
     value?: Partial<EntityListContextProps<DefaultEntityFilters>> | undefined;
 }>) => JSX.Element;
 
+/**
+ * @public
+ * @deprecated will be made private.
+ */
 declare function reduceCatalogFilters(filters: EntityFilter[]): Record<string, string | symbol | (string | symbol)[]>;
+/**
+ * @public
+ * @deprecated will be made private.
+ */
 declare function reduceEntityFilters(filters: EntityFilter[]): (entity: Entity) => boolean;
 
+/** @public */
 declare function getEntityMetadataViewUrl(entity: Entity): string | undefined;
+/** @public */
 declare function getEntityMetadataEditUrl(entity: Entity): string | undefined;
 
 /**
  * Get the related entity references.
+ *
+ * @public
  */
 declare function getEntityRelations(entity: Entity | undefined, relationType: string, filter?: {
     kind: string;
 }): EntityName[];
 
+/** @public */
 declare type EntitySourceLocation = {
     locationTargetUrl: string;
     integrationType?: string;
 };
+/** @public */
 declare function getEntitySourceLocation(entity: Entity, scmIntegrationsApi: ScmIntegrationRegistry): EntitySourceLocation | undefined;
 
 /**
  * Get the related entity references.
+ * @public
  */
 declare function isOwnerOf(owner: Entity, owned: Entity): boolean;
 
@@ -606,4 +709,4 @@ declare type BackstageOverrides = Overrides & {
     [Name in keyof CatalogReactComponentsNameToClassKey]?: Partial<StyleRules<CatalogReactComponentsNameToClassKey[Name]>>;
 };
 
-export { AsyncEntityProvider, AsyncEntityProviderProps, BackstageOverrides, CatalogReactComponentsNameToClassKey, CatalogReactEntityLifecyclePickerClassKey, CatalogReactEntityOwnerPickerClassKey, CatalogReactEntitySearchBarClassKey, CatalogReactEntityTagPickerClassKey, CatalogReactUserListPickerClassKey, DefaultEntityFilters, DefaultStarredEntitiesApi, EntityContext, EntityFilter, EntityKindFilter, EntityKindPicker, EntityKindPickerProps, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListProvider, EntityOwnerFilter, EntityOwnerPicker, EntityProvider, EntityProviderProps, EntityRefLink, EntityRefLinkProps, EntityRefLinks, EntityRefLinksProps, EntitySearchBar, EntitySourceLocation, EntityTable, EntityTableProps, EntityTagFilter, EntityTagPicker, EntityTextFilter, EntityTypeFilter, EntityTypePicker, EntityTypePickerProps, FavoriteEntity, MockEntityListContextProvider, StarredEntitiesApi, UnregisterEntityDialog, UserListFilter, UserListFilterKind, UserListPicker, catalogApiRef, catalogRouteRef, entityRoute, entityRouteParams, entityRouteRef, favoriteEntityIcon, favoriteEntityTooltip, formatEntityRefTitle, getEntityMetadataEditUrl, getEntityMetadataViewUrl, getEntityRelations, getEntitySourceLocation, isOwnerOf, loadCatalogOwnerRefs, loadIdentityOwnerRefs, reduceCatalogFilters, reduceEntityFilters, rootRoute, starredEntitiesApiRef, useEntity, useEntityCompoundName, useEntityFromUrl, useEntityKinds, useEntityListProvider, useEntityOwnership, useEntityPermission, useEntityTypeFilter, useOwnUser, useOwnedEntities, useRelatedEntities, useStarredEntities, useStarredEntity };
+export { AsyncEntityProvider, AsyncEntityProviderProps, BackstageOverrides, CatalogReactComponentsNameToClassKey, CatalogReactEntityLifecyclePickerClassKey, CatalogReactEntityOwnerPickerClassKey, CatalogReactEntitySearchBarClassKey, CatalogReactEntityTagPickerClassKey, CatalogReactUserListPickerClassKey, DefaultEntityFilters, DefaultStarredEntitiesApi, EntityFilter, EntityKindFilter, EntityKindPicker, EntityKindPickerProps, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListContextProps, EntityListProvider, EntityLoadingStatus, EntityOwnerFilter, EntityOwnerPicker, EntityProvider, EntityProviderProps, EntityRefLink, EntityRefLinkProps, EntityRefLinks, EntityRefLinksProps, EntitySearchBar, EntitySourceLocation, EntityTable, EntityTableProps, EntityTagFilter, EntityTagPicker, EntityTextFilter, EntityTypeFilter, EntityTypePicker, EntityTypePickerProps, EntityTypeReturn, FavoriteEntity, FavoriteEntityProps, InspectEntityDialog, MockEntityListContextProvider, StarredEntitiesApi, UnregisterEntityDialog, UnregisterEntityDialogProps, UserListFilter, UserListFilterKind, UserListPicker, UserListPickerProps, catalogApiRef, catalogRouteRef, columnFactories, entityRoute, entityRouteParams, entityRouteRef, favoriteEntityIcon, favoriteEntityTooltip, formatEntityRefTitle, getEntityMetadataEditUrl, getEntityMetadataViewUrl, getEntityRelations, getEntitySourceLocation, isOwnerOf, loadCatalogOwnerRefs, reduceCatalogFilters, reduceEntityFilters, rootRoute, starredEntitiesApiRef, useEntity, useEntityCompoundName, useEntityFromUrl, useEntityKinds, useEntityList, useEntityListProvider, useEntityOwnership, useEntityPermission, useEntityTypeFilter, useOwnUser, useOwnedEntities, useRelatedEntities, useStarredEntities, useStarredEntity };