From 24ab4464e70419e3d2a6e30ff9fb03bc53fc0b0d Mon Sep 17 00:00:00 2001
From: lshwayne96 <lshwayne96@gmail.com>
Date: Thu, 16 Nov 2023 14:14:23 +0800
Subject: [PATCH] Export new types and update API report

Signed-off-by: lshwayne96 <lshwayne96@gmail.com>
---
 plugins/catalog-node/api-report-alpha.md | 15 ++++++++++++++-
 plugins/catalog-node/src/alpha.ts        |  4 ++++
 plugins/catalog-node/src/extensions.ts   | 11 +++++++++--
 3 files changed, 27 insertions(+), 3 deletions(-)

diff --git a/plugins/catalog-node/api-report-alpha.md b/plugins/catalog-node/api-report-alpha.md
index e4918c93aa..676115c4d9 100644
--- a/plugins/catalog-node/api-report-alpha.md
+++ b/plugins/catalog-node/api-report-alpha.md
@@ -4,10 +4,12 @@
 
 ```ts
 import { CatalogApi } from '@backstage/catalog-client';
-import { CatalogPermissionRuleInput } from '@backstage/plugin-catalog-backend';
 import { CatalogProcessor } from '@backstage/plugin-catalog-node';
+import { Entity } from '@backstage/catalog-model';
 import { EntityProvider } from '@backstage/plugin-catalog-node';
 import { ExtensionPoint } from '@backstage/backend-plugin-api';
+import { PermissionRule } from '@backstage/plugin-permission-node';
+import { PermissionRuleParams } from '@backstage/plugin-permission-common';
 import { PlaceholderResolver } from '@backstage/plugin-catalog-node';
 import { ScmLocationAnalyzer } from '@backstage/plugin-catalog-node';
 import { ServiceRef } from '@backstage/backend-plugin-api';
@@ -21,6 +23,11 @@ export interface CatalogAnalysisExtensionPoint {
 // @alpha (undocumented)
 export const catalogAnalysisExtensionPoint: ExtensionPoint<CatalogAnalysisExtensionPoint>;
 
+// @alpha (undocumented)
+export type CatalogPermissionRuleInput<
+  TParams extends PermissionRuleParams = PermissionRuleParams,
+> = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;
+
 // @alpha (undocumented)
 export interface CatalogProcessingExtensionPoint {
   // (undocumented)
@@ -47,5 +54,11 @@ export const catalogProcessingExtensionPoint: ExtensionPoint<CatalogProcessingEx
 // @alpha
 export const catalogServiceRef: ServiceRef<CatalogApi, 'plugin'>;
 
+// @alpha (undocumented)
+export type EntitiesSearchFilter = {
+  key: string;
+  values?: string[];
+};
+
 // (No @packageDocumentation comment for this package)
 ```
diff --git a/plugins/catalog-node/src/alpha.ts b/plugins/catalog-node/src/alpha.ts
index cec1a0eedb..3d6194f986 100644
--- a/plugins/catalog-node/src/alpha.ts
+++ b/plugins/catalog-node/src/alpha.ts
@@ -19,3 +19,7 @@ export type { CatalogProcessingExtensionPoint } from './extensions';
 export { catalogProcessingExtensionPoint } from './extensions';
 export type { CatalogAnalysisExtensionPoint } from './extensions';
 export { catalogAnalysisExtensionPoint } from './extensions';
+export type {
+  EntitiesSearchFilter,
+  CatalogPermissionRuleInput,
+} from './extensions';
diff --git a/plugins/catalog-node/src/extensions.ts b/plugins/catalog-node/src/extensions.ts
index 6516653150..a165cd15cc 100644
--- a/plugins/catalog-node/src/extensions.ts
+++ b/plugins/catalog-node/src/extensions.ts
@@ -24,11 +24,18 @@ import {
   ScmLocationAnalyzer,
 } from '@backstage/plugin-catalog-node';
 
-type EntitiesSearchFilter = {
+/**
+ * @alpha
+ */
+export type EntitiesSearchFilter = {
   key: string;
   values?: string[];
 };
-type CatalogPermissionRuleInput<
+
+/**
+ * @alpha
+ */
+export type CatalogPermissionRuleInput<
   TParams extends PermissionRuleParams = PermissionRuleParams,
 > = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;