api-report-alpha.md

API Report File for "@backstage/plugin-catalog-react"

Do not edit this file. It is a report generated by API Extractor.

/// <reference types="react" />

import { AnyExtensionInputMap } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { PortableSchema } from '@backstage/frontend-plugin-api';
import { ResolvedExtensionInputs } from '@backstage/frontend-plugin-api';
import { ResourcePermission } from '@backstage/plugin-permission-common';
import { RouteRef } from '@backstage/frontend-plugin-api';

// @alpha (undocumented)
export const catalogExtensionData: {
  entityContentTitle: ConfigurableExtensionDataRef<string, {}>;
  entityFilterFunction: ConfigurableExtensionDataRef<
    (entity: Entity) => boolean,
    {}
  >;
  entityFilterExpression: ConfigurableExtensionDataRef<string, {}>;
};

// @alpha (undocumented)
export function createEntityCardExtension<
  TConfig extends {
    filter?: string;
  },
  TInputs extends AnyExtensionInputMap,
>(options: {
  namespace?: string;
  name?: string;
  attachTo?: {
    id: string;
    input: string;
  };
  disabled?: boolean;
  inputs?: TInputs;
  configSchema?: PortableSchema<TConfig>;
  filter?:
    | typeof catalogExtensionData.entityFilterFunction.T
    | typeof catalogExtensionData.entityFilterExpression.T;
  loader: (options: {
    config: TConfig;
    inputs: Expand<ResolvedExtensionInputs<TInputs>>;
  }) => Promise<JSX.Element>;
}): ExtensionDefinition<TConfig>;

// @alpha (undocumented)
export function createEntityContentExtension<
  TInputs extends AnyExtensionInputMap,
>(options: {
  namespace?: string;
  name?: string;
  attachTo?: {
    id: string;
    input: string;
  };
  disabled?: boolean;
  inputs?: TInputs;
  routeRef?: RouteRef;
  defaultPath: string;
  defaultTitle: string;
  filter?:
    | typeof catalogExtensionData.entityFilterFunction.T
    | typeof catalogExtensionData.entityFilterExpression.T;
  loader: (options: {
    inputs: Expand<ResolvedExtensionInputs<TInputs>>;
  }) => Promise<JSX.Element>;
}): ExtensionDefinition<{
  title: string;
  path: string;
  filter?: string | undefined;
}>;

// @alpha
export function isOwnerOf(owner: Entity, entity: Entity): boolean;

// @alpha
export function useEntityPermission(
  permission: ResourcePermission<'catalog-entity'>,
): {
  loading: boolean;
  allowed: boolean;
  error?: Error;
};

// (No @packageDocumentation comment for this package)