@backstage/plugin-catalog-backend 3.5.0-next.0 → 3.5.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @backstage/plugin-catalog-backend
 
+## 3.5.0-next.1
+
+### Minor Changes
+
+- a6b2819: Added `query-catalog-entities` action to the catalog backend actions registry. Supports predicate-based filtering with `$all`, `$any`, `$not`, `$exists`, `$in`, `$contains`, and `$hasPrefix` operators.
+- 972f686: Added support for predicate-based filtering on the `/entities/by-refs` endpoint via the `query` field in the request body. Supports `$all`, `$any`, `$not`, `$exists`, `$in`, `$contains`, and `$hasPrefix` operators.
+- 56c908e: Added support for predicate-based filtering on the `/entity-facets` endpoint via a new `POST` method. Supports `$all`, `$any`, `$not`, `$exists`, `$in`, `$contains`, and `$hasPrefix` operators.
+- 0fbcf23: Migrated OpenAPI schemas to 3.1.
+- 51e23eb: Added predicate-based entity filtering via POST /entities/by-query endpoint.
+
+  Supports `$all`, `$any`, `$not`, `$exists`, `$in`, `$hasPrefix`, and (partially) `$contains` operators for expressive entity queries. Integrated into the existing `queryEntities` flow with full cursor-based pagination, permission enforcement, and `totalItems` support.
+
+  The catalog client's `queryEntities()` method automatically routes to the POST endpoint when a `query` predicate is provided.
+
+### Patch Changes
+
+- 72747b4: Deprecated two processors as they have been moved to the Community Plugins repo with their own backend modules:
+
+  - `AnnotateScmSlugEntityProcessor`: Use `@backstage-community/plugin-catalog-backend-module-annotate-scm-slug` instead
+  - `CodeOwnersProcessor`: Use `@backstage-community/plugin-catalog-backend-module-codeowners` instead
+
+- Updated dependencies
+  - @backstage/catalog-client@1.14.0-next.1
+  - @backstage/integration@2.0.0-next.1
+  - @backstage/plugin-catalog-node@2.1.0-next.1
+  - @backstage/backend-openapi-utils@0.6.7-next.0
+  - @backstage/backend-plugin-api@1.7.1-next.0
+  - @backstage/catalog-model@1.7.6
+  - @backstage/config@1.3.6
+  - @backstage/errors@1.2.7
+  - @backstage/filter-predicates@0.1.0
+  - @backstage/types@1.2.2
+  - @backstage/plugin-catalog-common@1.1.8
+  - @backstage/plugin-events-node@0.4.20-next.0
+  - @backstage/plugin-permission-common@0.9.6
+  - @backstage/plugin-permission-node@0.10.11-next.0
+
 ## 3.5.0-next.0
 
 ### Minor Changes

package/dist/actions/createQueryCatalogEntitiesAction.cjs.js

@@ -0,0 +1,164 @@
+'use strict';
+
+var filterPredicates = require('@backstage/filter-predicates');
+
+const createQueryCatalogEntitiesAction = ({
+  catalog,
+  actionsRegistry
+}) => {
+  actionsRegistry.register({
+    name: "query-catalog-entities",
+    title: "Query Catalog Entities",
+    attributes: {
+      destructive: false,
+      readOnly: true,
+      idempotent: true
+    },
+    description: `
+Query entities from the Backstage Software Catalog using predicate filters.
+
+## Catalog Model
+
+The catalog contains entities of different kinds. Every entity has "kind", "apiVersion", "metadata", and optionally "spec" and "relations". Fields use dot notation for querying.
+
+Common metadata fields on all entities: name, namespace (default: "default"), title, description, labels, annotations, tags (string array), links.
+
+Entity references use the format "kind:namespace/name", e.g. "component:default/my-service" or "user:default/jane.doe".
+
+### Entity Kinds
+
+**Component** - A piece of software such as a service, website, or library.
+  spec fields: type (e.g. "service", "website", "library"), lifecycle (e.g. "production", "experimental", "deprecated"), owner (entity ref), system, subcomponentOf, providesApis, consumesApis, dependsOn, dependencyOf.
+
+**API** - An interface that components expose, such as REST APIs or event streams.
+  spec fields: type (e.g. "openapi", "asyncapi", "graphql", "grpc"), lifecycle, owner (entity ref), definition (the API spec content), system.
+
+**System** - A collection of components, APIs, and resources that together expose some functionality.
+  spec fields: owner (entity ref), domain, type.
+
+**Domain** - A grouping of systems that share terminology, domain models, and business purpose.
+  spec fields: owner (entity ref), subdomainOf, type.
+
+**Resource** - Infrastructure required to operate a component, such as databases or storage buckets.
+  spec fields: type, owner (entity ref), system, dependsOn, dependencyOf.
+
+**Group** - An organizational entity such as a team or business unit.
+  spec fields: type (e.g. "team", "business-unit"), children (entity refs), parent (entity ref), members (entity refs), profile (displayName, email, picture).
+
+**User** - A person, such as an employee or contractor.
+  spec fields: memberOf (entity refs), profile (displayName, email, picture).
+
+**Location** - A marker that references other catalog descriptor files to be ingested.
+  spec fields: type, target, targets, presence.
+
+### Relations
+
+Entities have bidirectional relations stored in the "relations" array. Common relation types: ownedBy/ownerOf, dependsOn/dependencyOf, providesApi/apiProvidedBy, consumesApi/apiConsumedBy, parentOf/childOf, memberOf/hasMember, partOf/hasPart.
+
+Relations can be queried via "relations.<type>" e.g. "relations.ownedby: user:default/jane-doe". The value there must always be a valid entity reference.
+
+When querying for entity relationships, prefer using relations over spec fields. For example, use "relations.ownedby" instead of "spec.owner" to find entities owned by a particular group or user.
+
+## Query Syntax
+
+The query uses predicate expressions with dot-notation field paths.
+
+Simple matching:
+  { query: { kind: "Component" } }
+  { query: { kind: "Component", "spec.type": "service" } }
+
+Value operators:
+  { query: { kind: { "$in": ["API", "Component"] } } }
+  { query: { "metadata.annotations.backstage.io/techdocs-ref": { "$exists": true } } }
+  { query: { "metadata.tags": { "$contains": "java" } } }
+  { query: { "metadata.name": { "$hasPrefix": "team-" } } }
+
+Logical operators:
+  { query: { "$all": [{ kind: "Component" }, { "spec.lifecycle": "production" }] } }
+  { query: { "$any": [{ "spec.type": "service" }, { "spec.type": "website" }] } }
+  { query: { "$not": { kind: "Group" } } }
+
+Querying relations - find all entities owned by a specific group:
+  { query: { "relations.ownedby": "group:default/team-alpha" } }
+
+Combined example - find production services or websites with TechDocs:
+  { query: { "$all": [
+    { kind: "Component", "spec.lifecycle": "production" },
+    { "$any": [{ "spec.type": "service" }, { "spec.type": "website" }] },
+    { "metadata.annotations.backstage.io/techdocs-ref": { "$exists": true } }
+  ] } }
+
+## Other Options
+
+Limit returned fields: { fields: ["kind", "metadata.name", "metadata.namespace"] }
+Sort results: { orderFields: { field: "metadata.name", order: "asc" } }
+Full text search: { fullTextFilter: { term: "auth", fields: ["metadata.name", "metadata.title"] } }
+Pagination: Use limit (e.g. 20) and the returned nextPageCursor for subsequent requests via cursor.
+    `,
+    schema: {
+      input: (z) => z.object({
+        query: filterPredicates.createZodV3FilterPredicateSchema(z).optional().describe(
+          "Entity predicate query. Supports field matching, $all, $any, $not, $exists, $in, $contains, and $hasPrefix operators."
+        ),
+        fields: z.array(z.string()).optional().describe(
+          "Specific fields to include in the response. If not provided, all fields are returned. Each entry is a dot separated path into an entity, e.g. `spec.type`."
+        ),
+        limit: z.number().int().positive().optional().describe("Maximum number of entities to return at a time."),
+        offset: z.number().int().min(0).optional().describe("Number of entities to skip before returning results."),
+        orderFields: z.union([
+          z.object({
+            field: z.string().describe(
+              "Field to order by. The format is a dot separated path into an entity, e.g. `spec.type`."
+            ),
+            order: z.enum(["asc", "desc"]).describe("Sort order")
+          }),
+          z.array(
+            z.object({
+              field: z.string().describe(
+                "Field to order by. The format is a dot separated path into an entity, e.g. `spec.type`."
+              ),
+              order: z.enum(["asc", "desc"]).describe("Sort order")
+            })
+          )
+        ]).optional().describe(
+          "Ordering criteria for the results. Can be a single order directive or an array for multi-field sorting."
+        ),
+        fullTextFilter: z.object({
+          term: z.string().describe("Full text search term"),
+          fields: z.array(z.string()).optional().describe(
+            "Fields to search within. Each entry is a dot separated path into an entity, e.g. `spec.type`."
+          )
+        }).optional().describe("Full text search criteria"),
+        cursor: z.string().optional().describe(
+          "Cursor for pagination. This can be used only after the first request with a response containing a cursor. If a cursor is given it takes precedence over `offset`."
+        )
+      }),
+      output: (z) => z.object({
+        items: z.array(z.object({}).passthrough()).describe("List of entities"),
+        totalItems: z.number().describe("Total number of entities"),
+        hasMoreEntities: z.boolean().describe("Whether more entities are available"),
+        nextPageCursor: z.string().optional().describe("Next page cursor used to fetch next page of entities")
+      })
+    },
+    action: async ({ input, credentials }) => {
+      const response = await catalog.queryEntities(
+        {
+          ...input,
+          query: input.query
+        },
+        { credentials }
+      );
+      return {
+        output: {
+          items: response.items,
+          totalItems: response.totalItems,
+          hasMoreEntities: !!response.pageInfo.nextCursor,
+          nextPageCursor: response.pageInfo.nextCursor
+        }
+      };
+    }
+  });
+};
+
+exports.createQueryCatalogEntitiesAction = createQueryCatalogEntitiesAction;
+//# sourceMappingURL=createQueryCatalogEntitiesAction.cjs.js.map

package/dist/actions/createQueryCatalogEntitiesAction.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createQueryCatalogEntitiesAction.cjs.js","sources":["../../src/actions/createQueryCatalogEntitiesAction.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { ActionsRegistryService } from '@backstage/backend-plugin-api/alpha';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\nimport { createZodV3FilterPredicateSchema } from '@backstage/filter-predicates';\n\nexport const createQueryCatalogEntitiesAction = ({\n  catalog,\n  actionsRegistry,\n}: {\n  catalog: CatalogService;\n  actionsRegistry: ActionsRegistryService;\n}) => {\n  actionsRegistry.register({\n    name: 'query-catalog-entities',\n    title: 'Query Catalog Entities',\n    attributes: {\n      destructive: false,\n      readOnly: true,\n      idempotent: true,\n    },\n    description: `\nQuery entities from the Backstage Software Catalog using predicate filters.\n\n## Catalog Model\n\nThe catalog contains entities of different kinds. Every entity has \"kind\", \"apiVersion\", \"metadata\", and optionally \"spec\" and \"relations\". Fields use dot notation for querying.\n\nCommon metadata fields on all entities: name, namespace (default: \"default\"), title, description, labels, annotations, tags (string array), links.\n\nEntity references use the format \"kind:namespace/name\", e.g. \"component:default/my-service\" or \"user:default/jane.doe\".\n\n### Entity Kinds\n\n**Component** - A piece of software such as a service, website, or library.\n  spec fields: type (e.g. \"service\", \"website\", \"library\"), lifecycle (e.g. \"production\", \"experimental\", \"deprecated\"), owner (entity ref), system, subcomponentOf, providesApis, consumesApis, dependsOn, dependencyOf.\n\n**API** - An interface that components expose, such as REST APIs or event streams.\n  spec fields: type (e.g. \"openapi\", \"asyncapi\", \"graphql\", \"grpc\"), lifecycle, owner (entity ref), definition (the API spec content), system.\n\n**System** - A collection of components, APIs, and resources that together expose some functionality.\n  spec fields: owner (entity ref), domain, type.\n\n**Domain** - A grouping of systems that share terminology, domain models, and business purpose.\n  spec fields: owner (entity ref), subdomainOf, type.\n\n**Resource** - Infrastructure required to operate a component, such as databases or storage buckets.\n  spec fields: type, owner (entity ref), system, dependsOn, dependencyOf.\n\n**Group** - An organizational entity such as a team or business unit.\n  spec fields: type (e.g. \"team\", \"business-unit\"), children (entity refs), parent (entity ref), members (entity refs), profile (displayName, email, picture).\n\n**User** - A person, such as an employee or contractor.\n  spec fields: memberOf (entity refs), profile (displayName, email, picture).\n\n**Location** - A marker that references other catalog descriptor files to be ingested.\n  spec fields: type, target, targets, presence.\n\n### Relations\n\nEntities have bidirectional relations stored in the \"relations\" array. Common relation types: ownedBy/ownerOf, dependsOn/dependencyOf, providesApi/apiProvidedBy, consumesApi/apiConsumedBy, parentOf/childOf, memberOf/hasMember, partOf/hasPart.\n\nRelations can be queried via \"relations.<type>\" e.g. \"relations.ownedby: user:default/jane-doe\". The value there must always be a valid entity reference.\n\nWhen querying for entity relationships, prefer using relations over spec fields. For example, use \"relations.ownedby\" instead of \"spec.owner\" to find entities owned by a particular group or user.\n\n## Query Syntax\n\nThe query uses predicate expressions with dot-notation field paths.\n\nSimple matching:\n  { query: { kind: \"Component\" } }\n  { query: { kind: \"Component\", \"spec.type\": \"service\" } }\n\nValue operators:\n  { query: { kind: { \"$in\": [\"API\", \"Component\"] } } }\n  { query: { \"metadata.annotations.backstage.io/techdocs-ref\": { \"$exists\": true } } }\n  { query: { \"metadata.tags\": { \"$contains\": \"java\" } } }\n  { query: { \"metadata.name\": { \"$hasPrefix\": \"team-\" } } }\n\nLogical operators:\n  { query: { \"$all\": [{ kind: \"Component\" }, { \"spec.lifecycle\": \"production\" }] } }\n  { query: { \"$any\": [{ \"spec.type\": \"service\" }, { \"spec.type\": \"website\" }] } }\n  { query: { \"$not\": { kind: \"Group\" } } }\n\nQuerying relations - find all entities owned by a specific group:\n  { query: { \"relations.ownedby\": \"group:default/team-alpha\" } }\n\nCombined example - find production services or websites with TechDocs:\n  { query: { \"$all\": [\n    { kind: \"Component\", \"spec.lifecycle\": \"production\" },\n    { \"$any\": [{ \"spec.type\": \"service\" }, { \"spec.type\": \"website\" }] },\n    { \"metadata.annotations.backstage.io/techdocs-ref\": { \"$exists\": true } }\n  ] } }\n\n## Other Options\n\nLimit returned fields: { fields: [\"kind\", \"metadata.name\", \"metadata.namespace\"] }\nSort results: { orderFields: { field: \"metadata.name\", order: \"asc\" } }\nFull text search: { fullTextFilter: { term: \"auth\", fields: [\"metadata.name\", \"metadata.title\"] } }\nPagination: Use limit (e.g. 20) and the returned nextPageCursor for subsequent requests via cursor.\n    `,\n    schema: {\n      input: z =>\n        z.object({\n          query: createZodV3FilterPredicateSchema(z)\n            .optional()\n            .describe(\n              'Entity predicate query. Supports field matching, $all, $any, $not, $exists, $in, $contains, and $hasPrefix operators.',\n            ),\n          fields: z\n            .array(z.string())\n            .optional()\n            .describe(\n              'Specific fields to include in the response. If not provided, all fields are returned. Each entry is a dot separated path into an entity, e.g. `spec.type`.',\n            ),\n          limit: z\n            .number()\n            .int()\n            .positive()\n            .optional()\n            .describe('Maximum number of entities to return at a time.'),\n          offset: z\n            .number()\n            .int()\n            .min(0)\n            .optional()\n            .describe('Number of entities to skip before returning results.'),\n          orderFields: z\n            .union([\n              z.object({\n                field: z\n                  .string()\n                  .describe(\n                    'Field to order by. The format is a dot separated path into an entity, e.g. `spec.type`.',\n                  ),\n                order: z.enum(['asc', 'desc']).describe('Sort order'),\n              }),\n              z.array(\n                z.object({\n                  field: z\n                    .string()\n                    .describe(\n                      'Field to order by. The format is a dot separated path into an entity, e.g. `spec.type`.',\n                    ),\n                  order: z.enum(['asc', 'desc']).describe('Sort order'),\n                }),\n              ),\n            ])\n            .optional()\n            .describe(\n              'Ordering criteria for the results. Can be a single order directive or an array for multi-field sorting.',\n            ),\n          fullTextFilter: z\n            .object({\n              term: z.string().describe('Full text search term'),\n              fields: z\n                .array(z.string())\n                .optional()\n                .describe(\n                  'Fields to search within. Each entry is a dot separated path into an entity, e.g. `spec.type`.',\n                ),\n            })\n            .optional()\n            .describe('Full text search criteria'),\n          cursor: z\n            .string()\n            .optional()\n            .describe(\n              'Cursor for pagination. This can be used only after the first request with a response containing a cursor. If a cursor is given it takes precedence over `offset`.',\n            ),\n        }),\n      output: z =>\n        z.object({\n          items: z\n            .array(z.object({}).passthrough())\n            .describe('List of entities'),\n          totalItems: z.number().describe('Total number of entities'),\n          hasMoreEntities: z\n            .boolean()\n            .describe('Whether more entities are available'),\n          nextPageCursor: z\n            .string()\n            .optional()\n            .describe('Next page cursor used to fetch next page of entities'),\n        }),\n    },\n    action: async ({ input, credentials }) => {\n      const response = await catalog.queryEntities(\n        {\n          ...input,\n          query: input.query,\n        },\n        { credentials },\n      );\n\n      return {\n        output: {\n          items: response.items,\n          totalItems: response.totalItems,\n          hasMoreEntities: !!response.pageInfo.nextCursor,\n          nextPageCursor: response.pageInfo.nextCursor,\n        },\n      };\n    },\n  });\n};\n"],"names":["createZodV3FilterPredicateSchema"],"mappings":";;;;AAmBO,MAAM,mCAAmC,CAAC;AAAA,EAC/C,OAAA;AAAA,EACA;AACF,CAAA,KAGM;AACJ,EAAA,eAAA,CAAgB,QAAA,CAAS;AAAA,IACvB,IAAA,EAAM,wBAAA;AAAA,IACN,KAAA,EAAO,wBAAA;AAAA,IACP,UAAA,EAAY;AAAA,MACV,WAAA,EAAa,KAAA;AAAA,MACb,QAAA,EAAU,IAAA;AAAA,MACV,UAAA,EAAY;AAAA,KACd;AAAA,IACA,WAAA,EAAa;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;AAAA;;AAAA;AAAA;;AAAA;AAAA;;AAAA;AAAA;;AAAA;AAAA;;AAAA;AAAA;;AAAA;AAAA;;AAAA;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;AAAA;;AAAA;AAAA;AAAA;AAAA;AAAA,IAAA,CAAA;AAAA,IAiFb,MAAA,EAAQ;AAAA,MACN,KAAA,EAAO,CAAA,CAAA,KACL,CAAA,CAAE,MAAA,CAAO;AAAA,QACP,KAAA,EAAOA,iDAAA,CAAiC,CAAC,CAAA,CACtC,UAAS,CACT,QAAA;AAAA,UACC;AAAA,SACF;AAAA,QACF,MAAA,EAAQ,EACL,KAAA,CAAM,CAAA,CAAE,QAAQ,CAAA,CAChB,UAAS,CACT,QAAA;AAAA,UACC;AAAA,SACF;AAAA,QACF,KAAA,EAAO,CAAA,CACJ,MAAA,EAAO,CACP,GAAA,EAAI,CACJ,QAAA,EAAS,CACT,QAAA,EAAS,CACT,QAAA,CAAS,iDAAiD,CAAA;AAAA,QAC7D,MAAA,EAAQ,CAAA,CACL,MAAA,EAAO,CACP,GAAA,EAAI,CACJ,GAAA,CAAI,CAAC,CAAA,CACL,QAAA,EAAS,CACT,QAAA,CAAS,sDAAsD,CAAA;AAAA,QAClE,WAAA,EAAa,EACV,KAAA,CAAM;AAAA,UACL,EAAE,MAAA,CAAO;AAAA,YACP,KAAA,EAAO,CAAA,CACJ,MAAA,EAAO,CACP,QAAA;AAAA,cACC;AAAA,aACF;AAAA,YACF,KAAA,EAAO,EAAE,IAAA,CAAK,CAAC,OAAO,MAAM,CAAC,CAAA,CAAE,QAAA,CAAS,YAAY;AAAA,WACrD,CAAA;AAAA,UACD,CAAA,CAAE,KAAA;AAAA,YACA,EAAE,MAAA,CAAO;AAAA,cACP,KAAA,EAAO,CAAA,CACJ,MAAA,EAAO,CACP,QAAA;AAAA,gBACC;AAAA,eACF;AAAA,cACF,KAAA,EAAO,EAAE,IAAA,CAAK,CAAC,OAAO,MAAM,CAAC,CAAA,CAAE,QAAA,CAAS,YAAY;AAAA,aACrD;AAAA;AACH,SACD,CAAA,CACA,QAAA,EAAS,CACT,QAAA;AAAA,UACC;AAAA,SACF;AAAA,QACF,cAAA,EAAgB,EACb,MAAA,CAAO;AAAA,UACN,IAAA,EAAM,CAAA,CAAE,MAAA,EAAO,CAAE,SAAS,uBAAuB,CAAA;AAAA,UACjD,MAAA,EAAQ,EACL,KAAA,CAAM,CAAA,CAAE,QAAQ,CAAA,CAChB,UAAS,CACT,QAAA;AAAA,YACC;AAAA;AACF,SACH,CAAA,CACA,QAAA,EAAS,CACT,SAAS,2BAA2B,CAAA;AAAA,QACvC,MAAA,EAAQ,CAAA,CACL,MAAA,EAAO,CACP,UAAS,CACT,QAAA;AAAA,UACC;AAAA;AACF,OACH,CAAA;AAAA,MACH,MAAA,EAAQ,CAAA,CAAA,KACN,CAAA,CAAE,MAAA,CAAO;AAAA,QACP,KAAA,EAAO,CAAA,CACJ,KAAA,CAAM,CAAA,CAAE,MAAA,CAAO,EAAE,CAAA,CAAE,WAAA,EAAa,CAAA,CAChC,QAAA,CAAS,kBAAkB,CAAA;AAAA,QAC9B,UAAA,EAAY,CAAA,CAAE,MAAA,EAAO,CAAE,SAAS,0BAA0B,CAAA;AAAA,QAC1D,eAAA,EAAiB,CAAA,CACd,OAAA,EAAQ,CACR,SAAS,qCAAqC,CAAA;AAAA,QACjD,gBAAgB,CAAA,CACb,MAAA,GACA,QAAA,EAAS,CACT,SAAS,sDAAsD;AAAA,OACnE;AAAA,KACL;AAAA,IACA,MAAA,EAAQ,OAAO,EAAE,KAAA,EAAO,aAAY,KAAM;AACxC,MAAA,MAAM,QAAA,GAAW,MAAM,OAAA,CAAQ,aAAA;AAAA,QAC7B;AAAA,UACE,GAAG,KAAA;AAAA,UACH,OAAO,KAAA,CAAM;AAAA,SACf;AAAA,QACA,EAAE,WAAA;AAAY,OAChB;AAEA,MAAA,OAAO;AAAA,QACL,MAAA,EAAQ;AAAA,UACN,OAAO,QAAA,CAAS,KAAA;AAAA,UAChB,YAAY,QAAA,CAAS,UAAA;AAAA,UACrB,eAAA,EAAiB,CAAC,CAAC,QAAA,CAAS,QAAA,CAAS,UAAA;AAAA,UACrC,cAAA,EAAgB,SAAS,QAAA,CAAS;AAAA;AACpC,OACF;AAAA,IACF;AAAA,GACD,CAAA;AACH;;;;"}

package/dist/actions/index.cjs.js

@@ -4,12 +4,14 @@ var createGetCatalogEntityAction = require('./createGetCatalogEntityAction.cjs.j
 var createValidateEntityAction = require('./createValidateEntityAction.cjs.js');
 var createRegisterCatalogEntitiesAction = require('./createRegisterCatalogEntitiesAction.cjs.js');
 var createUnregisterCatalogEntitiesAction = require('./createUnregisterCatalogEntitiesAction.cjs.js');
+var createQueryCatalogEntitiesAction = require('./createQueryCatalogEntitiesAction.cjs.js');
 
 const createCatalogActions = (options) => {
   createGetCatalogEntityAction.createGetCatalogEntityAction(options);
   createValidateEntityAction.createValidateEntityAction(options);
   createRegisterCatalogEntitiesAction.createRegisterCatalogEntitiesAction(options);
   createUnregisterCatalogEntitiesAction.createUnregisterCatalogEntitiesAction(options);
+  createQueryCatalogEntitiesAction.createQueryCatalogEntitiesAction(options);
 };
 
 exports.createCatalogActions = createCatalogActions;

package/dist/actions/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../../src/actions/index.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { ActionsRegistryService } from '@backstage/backend-plugin-api/alpha';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\nimport { createGetCatalogEntityAction } from './createGetCatalogEntityAction.ts';\nimport { createValidateEntityAction } from './createValidateEntityAction.ts';\nimport { createRegisterCatalogEntitiesAction } from './createRegisterCatalogEntitiesAction.ts';\nimport { createUnregisterCatalogEntitiesAction } from './createUnregisterCatalogEntitiesAction.ts';\n\nexport const createCatalogActions = (options: {\n  actionsRegistry: ActionsRegistryService;\n  catalog: CatalogService;\n}) => {\n  createGetCatalogEntityAction(options);\n  createValidateEntityAction(options);\n  createRegisterCatalogEntitiesAction(options);\n  createUnregisterCatalogEntitiesAction(options);\n};\n"],"names":["createGetCatalogEntityAction","createValidateEntityAction","createRegisterCatalogEntitiesAction","createUnregisterCatalogEntitiesAction"],"mappings":";;;;;;;AAsBO,MAAM,oBAAA,GAAuB,CAAC,OAAA,KAG/B;AACJ,EAAAA,yDAAA,CAA6B,OAAO,CAAA;AACpC,EAAAC,qDAAA,CAA2B,OAAO,CAAA;AAClC,EAAAC,uEAAA,CAAoC,OAAO,CAAA;AAC3C,EAAAC,2EAAA,CAAsC,OAAO,CAAA;AAC/C;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../../src/actions/index.ts"],"sourcesContent":["/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { ActionsRegistryService } from '@backstage/backend-plugin-api/alpha';\nimport { CatalogService } from '@backstage/plugin-catalog-node';\nimport { createGetCatalogEntityAction } from './createGetCatalogEntityAction.ts';\nimport { createValidateEntityAction } from './createValidateEntityAction.ts';\nimport { createRegisterCatalogEntitiesAction } from './createRegisterCatalogEntitiesAction.ts';\nimport { createUnregisterCatalogEntitiesAction } from './createUnregisterCatalogEntitiesAction.ts';\nimport { createQueryCatalogEntitiesAction } from './createQueryCatalogEntitiesAction.ts';\n\nexport const createCatalogActions = (options: {\n  actionsRegistry: ActionsRegistryService;\n  catalog: CatalogService;\n}) => {\n  createGetCatalogEntityAction(options);\n  createValidateEntityAction(options);\n  createRegisterCatalogEntitiesAction(options);\n  createUnregisterCatalogEntitiesAction(options);\n  createQueryCatalogEntitiesAction(options);\n};\n"],"names":["createGetCatalogEntityAction","createValidateEntityAction","createRegisterCatalogEntitiesAction","createUnregisterCatalogEntitiesAction","createQueryCatalogEntitiesAction"],"mappings":";;;;;;;;AAuBO,MAAM,oBAAA,GAAuB,CAAC,OAAA,KAG/B;AACJ,EAAAA,yDAAA,CAA6B,OAAO,CAAA;AACpC,EAAAC,qDAAA,CAA2B,OAAO,CAAA;AAClC,EAAAC,uEAAA,CAAoC,OAAO,CAAA;AAC3C,EAAAC,2EAAA,CAAsC,OAAO,CAAA;AAC7C,EAAAC,iEAAA,CAAiC,OAAO,CAAA;AAC1C;;;;"}

package/dist/index.d.ts

@@ -22,7 +22,10 @@ declare class AnnotateLocationEntityProcessor implements CatalogProcessor {
     preProcessEntity(entity: Entity, location: LocationSpec, _: CatalogProcessorEmit, originLocation: LocationSpec): Promise<Entity>;
 }
 
-/** @public */
+/**
+ * @public
+ * @deprecated Use `@backstage-community/plugin-catalog-backend-module-annotate-scm-slug` instead, this will be removed in a future release
+ */
 declare class AnnotateScmSlugEntityProcessor implements CatalogProcessor {
     private readonly opts;
     constructor(opts: {
@@ -45,7 +48,10 @@ declare class BuiltinKindsEntityProcessor implements CatalogProcessor {
     postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
 }
 
-/** @public */
+/**
+ * @public
+ * @deprecated Use `@backstage-community/plugin-catalog-backend-module-codeowners` instead, this will be removed in a future release
+ */
 declare class CodeOwnersProcessor implements CatalogProcessor {
     private readonly integrations;
     private readonly logger;

package/dist/processors/AnnotateScmSlugEntityProcessor.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"AnnotateScmSlugEntityProcessor.cjs.js","sources":["../../src/processors/AnnotateScmSlugEntityProcessor.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Entity } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport {\n  ScmIntegrationRegistry,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport parseGitUrl from 'git-url-parse';\nimport { identity, merge, pickBy } from 'lodash';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { CatalogProcessor } from '@backstage/plugin-catalog-node';\n\nconst GITHUB_ACTIONS_ANNOTATION = 'github.com/project-slug';\nconst GITLAB_ACTIONS_ANNOTATION = 'gitlab.com/project-slug';\nconst AZURE_ACTIONS_ANNOTATION = 'dev.azure.com/project-repo';\n\n/** @public */\nexport class AnnotateScmSlugEntityProcessor implements CatalogProcessor {\n  private readonly opts: {\n    scmIntegrationRegistry: ScmIntegrationRegistry;\n    kinds?: string[];\n  };\n\n  constructor(opts: {\n    scmIntegrationRegistry: ScmIntegrationRegistry;\n    kinds?: string[];\n  }) {\n    this.opts = opts;\n  }\n\n  getProcessorName(): string {\n    return 'AnnotateScmSlugEntityProcessor';\n  }\n\n  static fromConfig(\n    config: Config,\n    options?: { kinds?: string[] },\n  ): AnnotateScmSlugEntityProcessor {\n    return new AnnotateScmSlugEntityProcessor({\n      scmIntegrationRegistry: ScmIntegrations.fromConfig(config),\n      kinds: options?.kinds,\n    });\n  }\n\n  async preProcessEntity(\n    entity: Entity,\n    location: LocationSpec,\n  ): Promise<Entity> {\n    const applicableKinds = (this.opts.kinds ?? ['Component']).map(k =>\n      k.toLocaleLowerCase('en-US'),\n    );\n    if (\n      !applicableKinds.includes(entity.kind.toLocaleLowerCase('en-US')) ||\n      location.type !== 'url'\n    ) {\n      return entity;\n    }\n\n    const scmIntegration = this.opts.scmIntegrationRegistry.byUrl(\n      location.target,\n    );\n\n    if (!scmIntegration) {\n      return entity;\n    }\n\n    let annotation;\n    switch (scmIntegration.type) {\n      case 'github':\n        annotation = GITHUB_ACTIONS_ANNOTATION;\n        break;\n      case 'gitlab':\n        annotation = GITLAB_ACTIONS_ANNOTATION;\n        break;\n      case 'azure':\n        annotation = AZURE_ACTIONS_ANNOTATION;\n        break;\n      default:\n        return entity;\n    }\n\n    let projectSlug = entity.metadata.annotations?.[annotation];\n    if (!projectSlug) {\n      const gitUrl = parseGitUrl(location.target);\n      projectSlug = `${gitUrl.owner}/${gitUrl.name}`;\n    }\n\n    return merge(\n      {\n        metadata: {\n          annotations: pickBy(\n            {\n              [annotation]: projectSlug,\n            },\n            identity,\n          ),\n        },\n      },\n      entity,\n    );\n  }\n}\n"],"names":["ScmIntegrations","parseGitUrl","merge","pickBy","identity"],"mappings":";;;;;;;;;;AA2BA,MAAM,yBAAA,GAA4B,yBAAA;AAClC,MAAM,yBAAA,GAA4B,yBAAA;AAClC,MAAM,wBAAA,GAA2B,4BAAA;AAG1B,MAAM,8BAAA,CAA2D;AAAA,EACrD,IAAA;AAAA,EAKjB,YAAY,IAAA,EAGT;AACD,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,gBAAA,GAA2B;AACzB,IAAA,OAAO,gCAAA;AAAA,EACT;AAAA,EAEA,OAAO,UAAA,CACL,MAAA,EACA,OAAA,EACgC;AAChC,IAAA,OAAO,IAAI,8BAAA,CAA+B;AAAA,MACxC,sBAAA,EAAwBA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AAAA,MACzD,OAAO,OAAA,EAAS;AAAA,KACjB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,gBAAA,CACJ,MAAA,EACA,QAAA,EACiB;AACjB,IAAA,MAAM,mBAAmB,IAAA,CAAK,IAAA,CAAK,KAAA,IAAS,CAAC,WAAW,CAAA,EAAG,GAAA;AAAA,MAAI,CAAA,CAAA,KAC7D,CAAA,CAAE,iBAAA,CAAkB,OAAO;AAAA,KAC7B;AACA,IAAA,IACE,CAAC,eAAA,CAAgB,QAAA,CAAS,MAAA,CAAO,IAAA,CAAK,iBAAA,CAAkB,OAAO,CAAC,CAAA,IAChE,QAAA,CAAS,IAAA,KAAS,KAAA,EAClB;AACA,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,MAAM,cAAA,GAAiB,IAAA,CAAK,IAAA,CAAK,sBAAA,CAAuB,KAAA;AAAA,MACtD,QAAA,CAAS;AAAA,KACX;AAEA,IAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,IAAI,UAAA;AACJ,IAAA,QAAQ,eAAe,IAAA;AAAM,MAC3B,KAAK,QAAA;AACH,QAAA,UAAA,GAAa,yBAAA;AACb,QAAA;AAAA,MACF,KAAK,QAAA;AACH,QAAA,UAAA,GAAa,yBAAA;AACb,QAAA;AAAA,MACF,KAAK,OAAA;AACH,QAAA,UAAA,GAAa,wBAAA;AACb,QAAA;AAAA,MACF;AACE,QAAA,OAAO,MAAA;AAAA;AAGX,IAAA,IAAI,WAAA,GAAc,MAAA,CAAO,QAAA,CAAS,WAAA,GAAc,UAAU,CAAA;AAC1D,IAAA,IAAI,CAAC,WAAA,EAAa;AAChB,MAAA,MAAM,MAAA,GAASC,4BAAA,CAAY,QAAA,CAAS,MAAM,CAAA;AAC1C,MAAA,WAAA,GAAc,CAAA,EAAG,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,OAAO,IAAI,CAAA,CAAA;AAAA,IAC9C;AAEA,IAAA,OAAOC,YAAA;AAAA,MACL;AAAA,QACE,QAAA,EAAU;AAAA,UACR,WAAA,EAAaC,aAAA;AAAA,YACX;AAAA,cACE,CAAC,UAAU,GAAG;AAAA,aAChB;AAAA,YACAC;AAAA;AACF;AACF,OACF;AAAA,MACA;AAAA,KACF;AAAA,EACF;AACF;;;;"}
+{"version":3,"file":"AnnotateScmSlugEntityProcessor.cjs.js","sources":["../../src/processors/AnnotateScmSlugEntityProcessor.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Entity } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport {\n  ScmIntegrationRegistry,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport parseGitUrl from 'git-url-parse';\nimport { identity, merge, pickBy } from 'lodash';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { CatalogProcessor } from '@backstage/plugin-catalog-node';\n\nconst GITHUB_ACTIONS_ANNOTATION = 'github.com/project-slug';\nconst GITLAB_ACTIONS_ANNOTATION = 'gitlab.com/project-slug';\nconst AZURE_ACTIONS_ANNOTATION = 'dev.azure.com/project-repo';\n\n/**\n * @public\n * @deprecated Use `@backstage-community/plugin-catalog-backend-module-annotate-scm-slug` instead, this will be removed in a future release\n */\nexport class AnnotateScmSlugEntityProcessor implements CatalogProcessor {\n  private readonly opts: {\n    scmIntegrationRegistry: ScmIntegrationRegistry;\n    kinds?: string[];\n  };\n\n  constructor(opts: {\n    scmIntegrationRegistry: ScmIntegrationRegistry;\n    kinds?: string[];\n  }) {\n    this.opts = opts;\n  }\n\n  getProcessorName(): string {\n    return 'AnnotateScmSlugEntityProcessor';\n  }\n\n  static fromConfig(\n    config: Config,\n    options?: { kinds?: string[] },\n  ): AnnotateScmSlugEntityProcessor {\n    return new AnnotateScmSlugEntityProcessor({\n      scmIntegrationRegistry: ScmIntegrations.fromConfig(config),\n      kinds: options?.kinds,\n    });\n  }\n\n  async preProcessEntity(\n    entity: Entity,\n    location: LocationSpec,\n  ): Promise<Entity> {\n    const applicableKinds = (this.opts.kinds ?? ['Component']).map(k =>\n      k.toLocaleLowerCase('en-US'),\n    );\n    if (\n      !applicableKinds.includes(entity.kind.toLocaleLowerCase('en-US')) ||\n      location.type !== 'url'\n    ) {\n      return entity;\n    }\n\n    const scmIntegration = this.opts.scmIntegrationRegistry.byUrl(\n      location.target,\n    );\n\n    if (!scmIntegration) {\n      return entity;\n    }\n\n    let annotation;\n    switch (scmIntegration.type) {\n      case 'github':\n        annotation = GITHUB_ACTIONS_ANNOTATION;\n        break;\n      case 'gitlab':\n        annotation = GITLAB_ACTIONS_ANNOTATION;\n        break;\n      case 'azure':\n        annotation = AZURE_ACTIONS_ANNOTATION;\n        break;\n      default:\n        return entity;\n    }\n\n    let projectSlug = entity.metadata.annotations?.[annotation];\n    if (!projectSlug) {\n      const gitUrl = parseGitUrl(location.target);\n      projectSlug = `${gitUrl.owner}/${gitUrl.name}`;\n    }\n\n    return merge(\n      {\n        metadata: {\n          annotations: pickBy(\n            {\n              [annotation]: projectSlug,\n            },\n            identity,\n          ),\n        },\n      },\n      entity,\n    );\n  }\n}\n"],"names":["ScmIntegrations","parseGitUrl","merge","pickBy","identity"],"mappings":";;;;;;;;;;AA2BA,MAAM,yBAAA,GAA4B,yBAAA;AAClC,MAAM,yBAAA,GAA4B,yBAAA;AAClC,MAAM,wBAAA,GAA2B,4BAAA;AAM1B,MAAM,8BAAA,CAA2D;AAAA,EACrD,IAAA;AAAA,EAKjB,YAAY,IAAA,EAGT;AACD,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,EACd;AAAA,EAEA,gBAAA,GAA2B;AACzB,IAAA,OAAO,gCAAA;AAAA,EACT;AAAA,EAEA,OAAO,UAAA,CACL,MAAA,EACA,OAAA,EACgC;AAChC,IAAA,OAAO,IAAI,8BAAA,CAA+B;AAAA,MACxC,sBAAA,EAAwBA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AAAA,MACzD,OAAO,OAAA,EAAS;AAAA,KACjB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,gBAAA,CACJ,MAAA,EACA,QAAA,EACiB;AACjB,IAAA,MAAM,mBAAmB,IAAA,CAAK,IAAA,CAAK,KAAA,IAAS,CAAC,WAAW,CAAA,EAAG,GAAA;AAAA,MAAI,CAAA,CAAA,KAC7D,CAAA,CAAE,iBAAA,CAAkB,OAAO;AAAA,KAC7B;AACA,IAAA,IACE,CAAC,eAAA,CAAgB,QAAA,CAAS,MAAA,CAAO,IAAA,CAAK,iBAAA,CAAkB,OAAO,CAAC,CAAA,IAChE,QAAA,CAAS,IAAA,KAAS,KAAA,EAClB;AACA,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,MAAM,cAAA,GAAiB,IAAA,CAAK,IAAA,CAAK,sBAAA,CAAuB,KAAA;AAAA,MACtD,QAAA,CAAS;AAAA,KACX;AAEA,IAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,IAAI,UAAA;AACJ,IAAA,QAAQ,eAAe,IAAA;AAAM,MAC3B,KAAK,QAAA;AACH,QAAA,UAAA,GAAa,yBAAA;AACb,QAAA;AAAA,MACF,KAAK,QAAA;AACH,QAAA,UAAA,GAAa,yBAAA;AACb,QAAA;AAAA,MACF,KAAK,OAAA;AACH,QAAA,UAAA,GAAa,wBAAA;AACb,QAAA;AAAA,MACF;AACE,QAAA,OAAO,MAAA;AAAA;AAGX,IAAA,IAAI,WAAA,GAAc,MAAA,CAAO,QAAA,CAAS,WAAA,GAAc,UAAU,CAAA;AAC1D,IAAA,IAAI,CAAC,WAAA,EAAa;AAChB,MAAA,MAAM,MAAA,GAASC,4BAAA,CAAY,QAAA,CAAS,MAAM,CAAA;AAC1C,MAAA,WAAA,GAAc,CAAA,EAAG,MAAA,CAAO,KAAK,CAAA,CAAA,EAAI,OAAO,IAAI,CAAA,CAAA;AAAA,IAC9C;AAEA,IAAA,OAAOC,YAAA;AAAA,MACL;AAAA,QACE,QAAA,EAAU;AAAA,UACR,WAAA,EAAaC,aAAA;AAAA,YACX;AAAA,cACE,CAAC,UAAU,GAAG;AAAA,aAChB;AAAA,YACAC;AAAA;AACF;AACF,OACF;AAAA,MACA;AAAA,KACF;AAAA,EACF;AACF;;;;"}

package/dist/processors/CodeOwnersProcessor.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"CodeOwnersProcessor.cjs.js","sources":["../../src/processors/CodeOwnersProcessor.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Entity } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport {\n  ScmIntegrationRegistry,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { CatalogProcessor } from '@backstage/plugin-catalog-node';\nimport { findCodeOwnerByTarget } from './codeowners';\nimport { LoggerService, UrlReaderService } from '@backstage/backend-plugin-api';\n\nconst ALLOWED_KINDS = ['API', 'Component', 'Domain', 'Resource', 'System'];\nconst ALLOWED_LOCATION_TYPES = ['url'];\n\n/** @public */\nexport class CodeOwnersProcessor implements CatalogProcessor {\n  private readonly integrations: ScmIntegrationRegistry;\n  private readonly logger: LoggerService;\n  private readonly reader: UrlReaderService;\n\n  static fromConfig(\n    config: Config,\n    options: { logger: LoggerService; reader: UrlReaderService },\n  ) {\n    const integrations = ScmIntegrations.fromConfig(config);\n\n    return new CodeOwnersProcessor({\n      ...options,\n      integrations,\n    });\n  }\n\n  constructor(options: {\n    integrations: ScmIntegrationRegistry;\n    logger: LoggerService;\n    reader: UrlReaderService;\n  }) {\n    this.integrations = options.integrations;\n    this.logger = options.logger;\n    this.reader = options.reader;\n  }\n\n  getProcessorName(): string {\n    return 'CodeOwnersProcessor';\n  }\n\n  async preProcessEntity(\n    entity: Entity,\n    location: LocationSpec,\n  ): Promise<Entity> {\n    // Only continue if the owner is not set\n    if (\n      !entity ||\n      !ALLOWED_KINDS.includes(entity.kind) ||\n      !ALLOWED_LOCATION_TYPES.includes(location.type) ||\n      (entity.spec && entity.spec.owner)\n    ) {\n      return entity;\n    }\n\n    const scmIntegration = this.integrations.byUrl(location.target);\n    if (!scmIntegration) {\n      return entity;\n    }\n\n    const owner = await findCodeOwnerByTarget(\n      this.reader,\n      location.target,\n      scmIntegration,\n    );\n\n    if (!owner) {\n      this.logger.debug(\n        `CodeOwnerProcessor could not resolve owner for ${location.target}`,\n      );\n      return entity;\n    }\n\n    return {\n      ...entity,\n      spec: { ...entity.spec, owner },\n    };\n  }\n}\n"],"names":["ScmIntegrations","findCodeOwnerByTarget"],"mappings":";;;;;;;AA2BA,MAAM,gBAAgB,CAAC,KAAA,EAAO,WAAA,EAAa,QAAA,EAAU,YAAY,QAAQ,CAAA;AACzE,MAAM,sBAAA,GAAyB,CAAC,KAAK,CAAA;AAG9B,MAAM,mBAAA,CAAgD;AAAA,EAC1C,YAAA;AAAA,EACA,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,OAAO,UAAA,CACL,MAAA,EACA,OAAA,EACA;AACA,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AAEtD,IAAA,OAAO,IAAI,mBAAA,CAAoB;AAAA,MAC7B,GAAG,OAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AAAA,EAEA,YAAY,OAAA,EAIT;AACD,IAAA,IAAA,CAAK,eAAe,OAAA,CAAQ,YAAA;AAC5B,IAAA,IAAA,CAAK,SAAS,OAAA,CAAQ,MAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAA,CAAQ,MAAA;AAAA,EACxB;AAAA,EAEA,gBAAA,GAA2B;AACzB,IAAA,OAAO,qBAAA;AAAA,EACT;AAAA,EAEA,MAAM,gBAAA,CACJ,MAAA,EACA,QAAA,EACiB;AAEjB,IAAA,IACE,CAAC,MAAA,IACD,CAAC,cAAc,QAAA,CAAS,MAAA,CAAO,IAAI,CAAA,IACnC,CAAC,sBAAA,CAAuB,QAAA,CAAS,SAAS,IAAI,CAAA,IAC7C,OAAO,IAAA,IAAQ,MAAA,CAAO,KAAK,KAAA,EAC5B;AACA,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,MAAM,cAAA,GAAiB,IAAA,CAAK,YAAA,CAAa,KAAA,CAAM,SAAS,MAAM,CAAA;AAC9D,IAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,MAAM,QAAQ,MAAMC,0BAAA;AAAA,MAClB,IAAA,CAAK,MAAA;AAAA,MACL,QAAA,CAAS,MAAA;AAAA,MACT;AAAA,KACF;AAEA,IAAA,IAAI,CAAC,KAAA,EAAO;AACV,MAAA,IAAA,CAAK,MAAA,CAAO,KAAA;AAAA,QACV,CAAA,+CAAA,EAAkD,SAAS,MAAM,CAAA;AAAA,OACnE;AACA,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,OAAO;AAAA,MACL,GAAG,MAAA;AAAA,MACH,IAAA,EAAM,EAAE,GAAG,MAAA,CAAO,MAAM,KAAA;AAAM,KAChC;AAAA,EACF;AACF;;;;"}
+{"version":3,"file":"CodeOwnersProcessor.cjs.js","sources":["../../src/processors/CodeOwnersProcessor.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Entity } from '@backstage/catalog-model';\nimport { Config } from '@backstage/config';\nimport {\n  ScmIntegrationRegistry,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { CatalogProcessor } from '@backstage/plugin-catalog-node';\nimport { findCodeOwnerByTarget } from './codeowners';\nimport { LoggerService, UrlReaderService } from '@backstage/backend-plugin-api';\n\nconst ALLOWED_KINDS = ['API', 'Component', 'Domain', 'Resource', 'System'];\nconst ALLOWED_LOCATION_TYPES = ['url'];\n\n/**\n * @public\n * @deprecated Use `@backstage-community/plugin-catalog-backend-module-codeowners` instead, this will be removed in a future release\n */\nexport class CodeOwnersProcessor implements CatalogProcessor {\n  private readonly integrations: ScmIntegrationRegistry;\n  private readonly logger: LoggerService;\n  private readonly reader: UrlReaderService;\n\n  static fromConfig(\n    config: Config,\n    options: { logger: LoggerService; reader: UrlReaderService },\n  ) {\n    const integrations = ScmIntegrations.fromConfig(config);\n\n    return new CodeOwnersProcessor({\n      ...options,\n      integrations,\n    });\n  }\n\n  constructor(options: {\n    integrations: ScmIntegrationRegistry;\n    logger: LoggerService;\n    reader: UrlReaderService;\n  }) {\n    this.integrations = options.integrations;\n    this.logger = options.logger;\n    this.reader = options.reader;\n  }\n\n  getProcessorName(): string {\n    return 'CodeOwnersProcessor';\n  }\n\n  async preProcessEntity(\n    entity: Entity,\n    location: LocationSpec,\n  ): Promise<Entity> {\n    // Only continue if the owner is not set\n    if (\n      !entity ||\n      !ALLOWED_KINDS.includes(entity.kind) ||\n      !ALLOWED_LOCATION_TYPES.includes(location.type) ||\n      (entity.spec && entity.spec.owner)\n    ) {\n      return entity;\n    }\n\n    const scmIntegration = this.integrations.byUrl(location.target);\n    if (!scmIntegration) {\n      return entity;\n    }\n\n    const owner = await findCodeOwnerByTarget(\n      this.reader,\n      location.target,\n      scmIntegration,\n    );\n\n    if (!owner) {\n      this.logger.debug(\n        `CodeOwnerProcessor could not resolve owner for ${location.target}`,\n      );\n      return entity;\n    }\n\n    return {\n      ...entity,\n      spec: { ...entity.spec, owner },\n    };\n  }\n}\n"],"names":["ScmIntegrations","findCodeOwnerByTarget"],"mappings":";;;;;;;AA2BA,MAAM,gBAAgB,CAAC,KAAA,EAAO,WAAA,EAAa,QAAA,EAAU,YAAY,QAAQ,CAAA;AACzE,MAAM,sBAAA,GAAyB,CAAC,KAAK,CAAA;AAM9B,MAAM,mBAAA,CAAgD;AAAA,EAC1C,YAAA;AAAA,EACA,MAAA;AAAA,EACA,MAAA;AAAA,EAEjB,OAAO,UAAA,CACL,MAAA,EACA,OAAA,EACA;AACA,IAAA,MAAM,YAAA,GAAeA,2BAAA,CAAgB,UAAA,CAAW,MAAM,CAAA;AAEtD,IAAA,OAAO,IAAI,mBAAA,CAAoB;AAAA,MAC7B,GAAG,OAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AAAA,EAEA,YAAY,OAAA,EAIT;AACD,IAAA,IAAA,CAAK,eAAe,OAAA,CAAQ,YAAA;AAC5B,IAAA,IAAA,CAAK,SAAS,OAAA,CAAQ,MAAA;AACtB,IAAA,IAAA,CAAK,SAAS,OAAA,CAAQ,MAAA;AAAA,EACxB;AAAA,EAEA,gBAAA,GAA2B;AACzB,IAAA,OAAO,qBAAA;AAAA,EACT;AAAA,EAEA,MAAM,gBAAA,CACJ,MAAA,EACA,QAAA,EACiB;AAEjB,IAAA,IACE,CAAC,MAAA,IACD,CAAC,cAAc,QAAA,CAAS,MAAA,CAAO,IAAI,CAAA,IACnC,CAAC,sBAAA,CAAuB,QAAA,CAAS,SAAS,IAAI,CAAA,IAC7C,OAAO,IAAA,IAAQ,MAAA,CAAO,KAAK,KAAA,EAC5B;AACA,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,MAAM,cAAA,GAAiB,IAAA,CAAK,YAAA,CAAa,KAAA,CAAM,SAAS,MAAM,CAAA;AAC9D,IAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,MAAM,QAAQ,MAAMC,0BAAA;AAAA,MAClB,IAAA,CAAK,MAAA;AAAA,MACL,QAAA,CAAS,MAAA;AAAA,MACT;AAAA,KACF;AAEA,IAAA,IAAI,CAAC,KAAA,EAAO;AACV,MAAA,IAAA,CAAK,MAAA,CAAO,KAAA;AAAA,QACV,CAAA,+CAAA,EAAkD,SAAS,MAAM,CAAA;AAAA,OACnE;AACA,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,OAAO;AAAA,MACL,GAAG,MAAA;AAAA,MACH,IAAA,EAAM,EAAE,GAAG,MAAA,CAAO,MAAM,KAAA;AAAM,KAChC;AAAA,EACF;AACF;;;;"}

package/dist/schema/openapi/generated/router.cjs.js

@@ -3,7 +3,7 @@
 var backendOpenapiUtils = require('@backstage/backend-openapi-utils');
 
 const spec = {
-  openapi: "3.0.3",
+  openapi: "3.1.0",
   info: {
     title: "catalog",
     version: "1",
@@ -27,7 +27,6 @@ const spec = {
         name: "kind",
         in: "path",
         required: true,
-        allowReserved: true,
         schema: {
           type: "string"
         }
@@ -36,7 +35,6 @@ const spec = {
         name: "namespace",
         in: "path",
         required: true,
-        allowReserved: true,
         schema: {
           type: "string"
         }
@@ -45,7 +43,6 @@ const spec = {
         name: "name",
         in: "path",
         required: true,
-        allowReserved: true,
         schema: {
           type: "string"
         }
@@ -54,7 +51,6 @@ const spec = {
         name: "uid",
         in: "path",
         required: true,
-        allowReserved: true,
         schema: {
           type: "string"
         }
@@ -368,33 +364,39 @@ const spec = {
         description: "The parts of the format that's common to all versions/kinds of entity."
       },
       NullableEntity: {
-        type: "object",
-        properties: {
-          relations: {
-            type: "array",
-            items: {
-              $ref: "#/components/schemas/EntityRelation"
+        anyOf: [
+          {
+            type: "object",
+            properties: {
+              relations: {
+                type: "array",
+                items: {
+                  $ref: "#/components/schemas/EntityRelation"
+                },
+                description: "The relations that this entity has with other entities."
+              },
+              spec: {
+                $ref: "#/components/schemas/JsonObject"
+              },
+              metadata: {
+                $ref: "#/components/schemas/EntityMeta"
+              },
+              kind: {
+                type: "string",
+                description: "The high level entity type being described."
+              },
+              apiVersion: {
+                type: "string",
+                description: "The version of specification format for this particular entity that\nthis is written against."
+              }
             },
-            description: "The relations that this entity has with other entities."
-          },
-          spec: {
-            $ref: "#/components/schemas/JsonObject"
+            required: ["metadata", "kind", "apiVersion"],
+            description: "The parts of the format that's common to all versions/kinds of entity."
           },
-          metadata: {
-            $ref: "#/components/schemas/EntityMeta"
-          },
-          kind: {
-            type: "string",
-            description: "The high level entity type being described."
-          },
-          apiVersion: {
-            type: "string",
-            description: "The version of specification format for this particular entity that\nthis is written against."
+          {
+            type: "null"
           }
-        },
-        required: ["metadata", "kind", "apiVersion"],
-        description: "The parts of the format that's common to all versions/kinds of entity.",
-        nullable: true
+        ]
       },
       EntityAncestryResponse: {
         type: "object",
@@ -650,8 +652,14 @@ const spec = {
             description: 'A text to show to the user to inform about the choices made. Like, it could say\n"Found a CODEOWNERS file that covers this target, so we suggest leaving this\nfield empty; which would currently make it owned by X" where X is taken from the\ncodeowners file.'
           },
           value: {
-            type: "string",
-            nullable: true
+            oneOf: [
+              {
+                type: "string"
+              },
+              {
+                type: "null"
+              }
+            ]
           },
           state: {
             type: "string",
@@ -1064,6 +1072,9 @@ const spec = {
                     items: {
                       type: "string"
                     }
+                  },
+                  query: {
+                    $ref: "#/components/schemas/JsonObject"
                   }
                 }
               },
@@ -1167,6 +1178,95 @@ const spec = {
             style: "form"
           }
         ]
+      },
+      post: {
+        operationId: "QueryEntitiesByPredicate",
+        tags: ["Entity"],
+        description: "Query entities using predicate-based filters.",
+        responses: {
+          "200": {
+            description: "Ok",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/EntitiesQueryResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            $ref: "#/components/responses/ErrorResponse"
+          },
+          default: {
+            $ref: "#/components/responses/ErrorResponse"
+          }
+        },
+        security: [
+          {},
+          {
+            JWT: []
+          }
+        ],
+        requestBody: {
+          required: false,
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  cursor: {
+                    type: "string"
+                  },
+                  limit: {
+                    type: "number"
+                  },
+                  offset: {
+                    type: "number"
+                  },
+                  orderBy: {
+                    type: "array",
+                    items: {
+                      type: "object",
+                      required: ["field", "order"],
+                      properties: {
+                        field: {
+                          type: "string"
+                        },
+                        order: {
+                          type: "string",
+                          enum: ["asc", "desc"]
+                        }
+                      }
+                    }
+                  },
+                  fullTextFilter: {
+                    type: "object",
+                    properties: {
+                      term: {
+                        type: "string"
+                      },
+                      fields: {
+                        type: "array",
+                        items: {
+                          type: "string"
+                        }
+                      }
+                    }
+                  },
+                  fields: {
+                    type: "array",
+                    items: {
+                      type: "string"
+                    }
+                  },
+                  query: {
+                    $ref: "#/components/schemas/JsonObject"
+                  }
+                }
+              }
+            }
+          }
+        }
       }
     },
     "/entity-facets": {
@@ -1223,6 +1323,57 @@ const spec = {
             $ref: "#/components/parameters/filter"
           }
         ]
+      },
+      post: {
+        operationId: "QueryEntityFacetsByPredicate",
+        tags: ["Entity"],
+        description: "Get entity facets using predicate-based filters.",
+        responses: {
+          "200": {
+            description: "Ok",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/EntityFacetsResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            $ref: "#/components/responses/ErrorResponse"
+          },
+          default: {
+            $ref: "#/components/responses/ErrorResponse"
+          }
+        },
+        security: [
+          {},
+          {
+            JWT: []
+          }
+        ],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                required: ["facets"],
+                properties: {
+                  facets: {
+                    type: "array",
+                    items: {
+                      type: "string"
+                    }
+                  },
+                  query: {
+                    $ref: "#/components/schemas/JsonObject"
+                  }
+                }
+              }
+            }
+          }
+        }
       }
     },
     "/locations": {
@@ -1417,7 +1568,6 @@ const spec = {
             in: "path",
             name: "id",
             required: true,
-            allowReserved: true,
             schema: {
               type: "string"
             }
@@ -1450,7 +1600,6 @@ const spec = {
             in: "path",
             name: "id",
             required: true,
-            allowReserved: true,
             schema: {
               type: "string"
             }
@@ -1489,7 +1638,6 @@ const spec = {
             in: "path",
             name: "kind",
             required: true,
-            allowReserved: true,
             schema: {
               type: "string"
             }
@@ -1498,7 +1646,6 @@ const spec = {
             in: "path",
             name: "namespace",
             required: true,
-            allowReserved: true,
             schema: {
               type: "string"
             }
@@ -1507,7 +1654,6 @@ const spec = {
             in: "path",
             name: "name",
             required: true,
-            allowReserved: true,
             schema: {
               type: "string"
             }