@backstage/plugin-catalog-react 1.1.2-next.1 → 1.1.2

package/CHANGELOG.md

@@ -1,5 +1,124 @@
 # @backstage/plugin-catalog-react
 
+## 1.1.2
+
+### Patch Changes
+
+- 72622d9143: Updated dependency `yaml` to `^2.0.0`.
+- be26d95141: Added new `EntityProcessingStatusPicker` that will filter for entities with orphans and/or errors.
+
+  If you are using the default Catalog page this picker will be added automatically. For those who have customized their Catalog page you'll need to add this manually by doing something like this:
+
+  ```diff
+  ...
+  import {
+    CatalogFilterLayout,
+    EntityTypePicker,
+    UserListPicker,
+    EntityTagPicker
+  + EntityProcessingStatusPicker,
+  } from '@backstage/plugin-catalog-react';
+  ...
+  export const CustomCatalogPage = ({
+    columns,
+    actions,
+    initiallySelectedFilter = 'owned',
+  }: CatalogPageProps) => {
+    return (
+      ...
+          <EntityListProvider>
+            <CatalogFilterLayout>
+              <CatalogFilterLayout.Filters>
+                <EntityKindPicker initialFilter="component" hidden />
+                <EntityTypePicker />
+                <UserListPicker initialFilter={initiallySelectedFilter} />
+                <EntityTagPicker />
+  +             <EntityProcessingStatusPicker />
+              <CatalogFilterLayout.Filters>
+              <CatalogFilterLayout.Content>
+                <CatalogTable columns={columns} actions={actions} />
+              </CatalogFilterLayout.Content>
+            </CatalogFilterLayout>
+          </EntityListProvider>
+      ...
+  };
+  ```
+
+- Updated dependencies
+  - @backstage/core-components@0.10.0
+  - @backstage/catalog-model@1.1.0
+  - @backstage/core-plugin-api@1.0.4
+  - @backstage/integration@1.2.2
+  - @backstage/catalog-client@1.0.4
+  - @backstage/plugin-permission-common@0.6.3
+  - @backstage/theme@0.2.16
+  - @backstage/errors@1.1.0
+  - @backstage/plugin-catalog-common@1.0.4
+  - @backstage/plugin-permission-react@0.4.3
+
+## 1.1.2-next.3
+
+### Patch Changes
+
+- 72622d9143: Updated dependency `yaml` to `^2.0.0`.
+- Updated dependencies
+  - @backstage/core-plugin-api@1.0.4-next.0
+  - @backstage/core-components@0.10.0-next.3
+  - @backstage/catalog-client@1.0.4-next.2
+  - @backstage/integration@1.2.2-next.3
+  - @backstage/plugin-permission-common@0.6.3-next.1
+  - @backstage/catalog-model@1.1.0-next.3
+  - @backstage/plugin-permission-react@0.4.3-next.1
+
+## 1.1.2-next.2
+
+### Patch Changes
+
+- be26d95141: Added new `EntityProcessingStatusPicker` that will filter for entities with orphans and/or errors.
+
+  If you are using the default Catalog page this picker will be added automatically. For those who have customized their Catalog page you'll need to add this manually by doing something like this:
+
+  ```diff
+  ...
+  import {
+    CatalogFilterLayout,
+    EntityTypePicker,
+    UserListPicker,
+    EntityTagPicker
+  + EntityProcessingStatusPicker,
+  } from '@backstage/plugin-catalog-react';
+  ...
+  export const CustomCatalogPage = ({
+    columns,
+    actions,
+    initiallySelectedFilter = 'owned',
+  }: CatalogPageProps) => {
+    return (
+      ...
+          <EntityListProvider>
+            <CatalogFilterLayout>
+              <CatalogFilterLayout.Filters>
+                <EntityKindPicker initialFilter="component" hidden />
+                <EntityTypePicker />
+                <UserListPicker initialFilter={initiallySelectedFilter} />
+                <EntityTagPicker />
+  +             <EntityProcessingStatusPicker />
+              <CatalogFilterLayout.Filters>
+              <CatalogFilterLayout.Content>
+                <CatalogTable columns={columns} actions={actions} />
+              </CatalogFilterLayout.Content>
+            </CatalogFilterLayout>
+          </EntityListProvider>
+      ...
+  };
+  ```
+
+- Updated dependencies
+  - @backstage/core-components@0.10.0-next.2
+  - @backstage/catalog-model@1.1.0-next.2
+  - @backstage/theme@0.2.16-next.1
+  - @backstage/integration@1.2.2-next.2
+
 ## 1.1.2-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-react",
-  "version": "1.1.2-next.1",
+  "version": "1.1.2",
   "main": "../dist/index.esm.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -83,6 +83,7 @@ export declare type CatalogReactComponentsNameToClassKey = {
     CatalogReactEntitySearchBar: CatalogReactEntitySearchBarClassKey;
     CatalogReactEntityTagPicker: CatalogReactEntityTagPickerClassKey;
     CatalogReactEntityOwnerPicker: CatalogReactEntityOwnerPickerClassKey;
+    CatalogReactEntityProcessingStatusPicker: CatalogReactEntityProcessingStatusPickerClassKey;
 };
 
 /** @public */
@@ -91,6 +92,9 @@ export declare type CatalogReactEntityLifecyclePickerClassKey = 'input';
 /** @public */
 export declare type CatalogReactEntityOwnerPickerClassKey = 'input';
 
+/** @public */
+export declare type CatalogReactEntityProcessingStatusPickerClassKey = 'input';
+
 /** @public */
 export declare type CatalogReactEntitySearchBarClassKey = 'searchToolbar' | 'input';
 
@@ -130,8 +134,20 @@ export declare type DefaultEntityFilters = {
     lifecycles?: EntityLifecycleFilter;
     tags?: EntityTagFilter;
     text?: EntityTextFilter;
+    orphan?: EntityOrphanFilter;
+    error?: EntityErrorFilter;
 };
 
+/**
+ * Filters entities based on if it has errors or not.
+ * @public
+ */
+export declare class EntityErrorFilter implements EntityFilter {
+    readonly value: boolean;
+    constructor(value: boolean);
+    filterEntity(entity: Entity): boolean;
+}
+
 /** @public */
 export declare type EntityFilter = {
     /**
@@ -241,6 +257,16 @@ export declare type EntityLoadingStatus<TEntity extends Entity = Entity> = {
     refresh?: VoidFunction;
 };
 
+/**
+ * Filters entities based if it is an orphan or not.
+ * @public
+ */
+export declare class EntityOrphanFilter implements EntityFilter {
+    readonly value: boolean;
+    constructor(value: boolean);
+    filterEntity(entity: Entity): boolean;
+}
+
 /**
  * Filter matching entities that are owned by group.
  * @public
@@ -255,6 +281,9 @@ export declare class EntityOwnerFilter implements EntityFilter {
 /** @public */
 export declare const EntityOwnerPicker: () => JSX.Element | null;
 
+/** @public */
+export declare const EntityProcessingStatusPicker: () => JSX.Element;
+
 /**
  * Provides an entity to be picked up by the `useEntity` hook.
  *

package/dist/index.beta.d.ts

@@ -83,6 +83,7 @@ export declare type CatalogReactComponentsNameToClassKey = {
     CatalogReactEntitySearchBar: CatalogReactEntitySearchBarClassKey;
     CatalogReactEntityTagPicker: CatalogReactEntityTagPickerClassKey;
     CatalogReactEntityOwnerPicker: CatalogReactEntityOwnerPickerClassKey;
+    CatalogReactEntityProcessingStatusPicker: CatalogReactEntityProcessingStatusPickerClassKey;
 };
 
 /** @public */
@@ -91,6 +92,9 @@ export declare type CatalogReactEntityLifecyclePickerClassKey = 'input';
 /** @public */
 export declare type CatalogReactEntityOwnerPickerClassKey = 'input';
 
+/** @public */
+export declare type CatalogReactEntityProcessingStatusPickerClassKey = 'input';
+
 /** @public */
 export declare type CatalogReactEntitySearchBarClassKey = 'searchToolbar' | 'input';
 
@@ -130,8 +134,20 @@ export declare type DefaultEntityFilters = {
     lifecycles?: EntityLifecycleFilter;
     tags?: EntityTagFilter;
     text?: EntityTextFilter;
+    orphan?: EntityOrphanFilter;
+    error?: EntityErrorFilter;
 };
 
+/**
+ * Filters entities based on if it has errors or not.
+ * @public
+ */
+export declare class EntityErrorFilter implements EntityFilter {
+    readonly value: boolean;
+    constructor(value: boolean);
+    filterEntity(entity: Entity): boolean;
+}
+
 /** @public */
 export declare type EntityFilter = {
     /**
@@ -241,6 +257,16 @@ export declare type EntityLoadingStatus<TEntity extends Entity = Entity> = {
     refresh?: VoidFunction;
 };
 
+/**
+ * Filters entities based if it is an orphan or not.
+ * @public
+ */
+export declare class EntityOrphanFilter implements EntityFilter {
+    readonly value: boolean;
+    constructor(value: boolean);
+    filterEntity(entity: Entity): boolean;
+}
+
 /**
  * Filter matching entities that are owned by group.
  * @public
@@ -255,6 +281,9 @@ export declare class EntityOwnerFilter implements EntityFilter {
 /** @public */
 export declare const EntityOwnerPicker: () => JSX.Element | null;
 
+/** @public */
+export declare const EntityProcessingStatusPicker: () => JSX.Element;
+
 /**
  * Provides an entity to be picked up by the `useEntity` hook.
  *

package/dist/index.d.ts

@@ -83,6 +83,7 @@ export declare type CatalogReactComponentsNameToClassKey = {
     CatalogReactEntitySearchBar: CatalogReactEntitySearchBarClassKey;
     CatalogReactEntityTagPicker: CatalogReactEntityTagPickerClassKey;
     CatalogReactEntityOwnerPicker: CatalogReactEntityOwnerPickerClassKey;
+    CatalogReactEntityProcessingStatusPicker: CatalogReactEntityProcessingStatusPickerClassKey;
 };
 
 /** @public */
@@ -91,6 +92,9 @@ export declare type CatalogReactEntityLifecyclePickerClassKey = 'input';
 /** @public */
 export declare type CatalogReactEntityOwnerPickerClassKey = 'input';
 
+/** @public */
+export declare type CatalogReactEntityProcessingStatusPickerClassKey = 'input';
+
 /** @public */
 export declare type CatalogReactEntitySearchBarClassKey = 'searchToolbar' | 'input';
 
@@ -130,8 +134,20 @@ export declare type DefaultEntityFilters = {
     lifecycles?: EntityLifecycleFilter;
     tags?: EntityTagFilter;
     text?: EntityTextFilter;
+    orphan?: EntityOrphanFilter;
+    error?: EntityErrorFilter;
 };
 
+/**
+ * Filters entities based on if it has errors or not.
+ * @public
+ */
+export declare class EntityErrorFilter implements EntityFilter {
+    readonly value: boolean;
+    constructor(value: boolean);
+    filterEntity(entity: Entity): boolean;
+}
+
 /** @public */
 export declare type EntityFilter = {
     /**
@@ -241,6 +257,16 @@ export declare type EntityLoadingStatus<TEntity extends Entity = Entity> = {
     refresh?: VoidFunction;
 };
 
+/**
+ * Filters entities based if it is an orphan or not.
+ * @public
+ */
+export declare class EntityOrphanFilter implements EntityFilter {
+    readonly value: boolean;
+    constructor(value: boolean);
+    filterEntity(entity: Entity): boolean;
+}
+
 /**
  * Filter matching entities that are owned by group.
  * @public
@@ -255,6 +281,9 @@ export declare class EntityOwnerFilter implements EntityFilter {
 /** @public */
 export declare const EntityOwnerPicker: () => JSX.Element | null;
 
+/** @public */
+export declare const EntityProcessingStatusPicker: () => JSX.Element;
+
 /**
  * Provides an entity to be picked up by the `useEntity` hook.
  *