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

package/CHANGELOG.md

@@ -1,5 +1,68 @@
 # @backstage/plugin-catalog-backend
 
+## 1.2.0-next.0
+
+### Minor Changes
+
+- b594679ae3: Allow array as non-spread arguments at the `CatalogBuilder`.
+
+  ```typescript
+  builder.addEntityProvider(...getArrayOfProviders());
+  ```
+
+  can be simplified to
+
+  ```typescript
+  builder.addEntityProvider(getArrayOfProviders());
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.13.6-next.0
+  - @backstage/integration@1.2.1-next.0
+  - @backstage/plugin-permission-node@0.6.2-next.0
+
+## 1.1.2
+
+### Patch Changes
+
+- 16a40ac4c0: Fix wrong return type of the `isGroupEntity` function.
+- 55e09b29dd: Fixing broken types for `knex` when checking returned rows
+- 1ccbe081cc: Minor internal tweak to support TypeScript 4.6
+- cfc0f19699: Updated dependency `fs-extra` to `10.1.0`.
+- 2909746147: Updated parseEntityTransformParams to handle keys with '.' in them. This will allow for querying of entities based off annotations such as 'backstage.io/orgin-location' or other entity field keys that have '.' in them.
+- 8cc75993a6: Fixed issue in `PermissionEvaluator` instance check that would cause unexpected "invalid union" errors.
+- Updated dependencies
+  - @backstage/backend-common@0.13.3
+  - @backstage/integration@1.2.0
+  - @backstage/plugin-scaffolder-common@1.1.0
+  - @backstage/config@1.0.1
+  - @backstage/plugin-search-common@0.3.4
+  - @backstage/catalog-client@1.0.2
+  - @backstage/catalog-model@1.0.2
+  - @backstage/plugin-catalog-common@1.0.2
+  - @backstage/plugin-permission-common@0.6.1
+  - @backstage/plugin-permission-node@0.6.1
+
+## 1.1.2-next.2
+
+### Patch Changes
+
+- 16a40ac4c0: Fix wrong return type of the `isGroupEntity` function.
+- 2909746147: Updated parseEntityTransformParams to handle keys with '.' in them. This will allow for querying of entities based off annotations such as 'backstage.io/orgin-location' or other entity field keys that have '.' in them.
+- Updated dependencies
+  - @backstage/backend-common@0.13.3-next.2
+  - @backstage/plugin-scaffolder-common@1.1.0-next.0
+  - @backstage/config@1.0.1-next.0
+  - @backstage/plugin-search-common@0.3.4-next.0
+  - @backstage/catalog-model@1.0.2-next.0
+  - @backstage/integration@1.2.0-next.1
+  - @backstage/plugin-permission-common@0.6.1-next.0
+  - @backstage/plugin-permission-node@0.6.1-next.1
+  - @backstage/catalog-client@1.0.2-next.0
+  - @backstage/plugin-catalog-common@1.0.2-next.0
+
 ## 1.1.2-next.1
 
 ### Patch Changes
@@ -455,7 +518,7 @@
 - 022507c860: A `DefaultCatalogCollatorFactory`, which works with the new stream-based
   search indexing subsystem, is now available. The `DefaultCatalogCollator` will
   continue to be available for those unable to upgrade to the stream-based
-  `@backstage/search-backend-node` (and related packages), however it is now
+  `@backstage/plugin-search-backend-node` (and related packages), however it is now
   marked as deprecated and will be removed in a future version.
 
   To upgrade this plugin and the search indexing subsystem in one go, check

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -170,7 +170,7 @@ export declare class CatalogBuilder {
      *
      * @param policies - One or more policies
      */
-    addEntityPolicy(...policies: EntityPolicy[]): CatalogBuilder;
+    addEntityPolicy(...policies: Array<EntityPolicy | Array<EntityPolicy>>): CatalogBuilder;
     /**
      * Processing interval determines how often entities should be processed.
      * Seconds provided will be multiplied by 1.5
@@ -229,14 +229,14 @@ export declare class CatalogBuilder {
      *
      * @param providers - One or more entity providers
      */
-    addEntityProvider(...providers: EntityProvider[]): CatalogBuilder;
+    addEntityProvider(...providers: Array<EntityProvider | Array<EntityProvider>>): CatalogBuilder;
     /**
      * Adds entity processors. These are responsible for reading, parsing, and
      * processing entities before they are persisted in the catalog.
      *
      * @param processors - One or more processors
      */
-    addProcessor(...processors: CatalogProcessor[]): CatalogBuilder;
+    addProcessor(...processors: Array<CatalogProcessor | Array<CatalogProcessor>>): CatalogBuilder;
     /**
      * Sets what entity processors to use. These are responsible for reading,
      * parsing, and processing entities before they are persisted in the catalog.
@@ -274,7 +274,7 @@ export declare class CatalogBuilder {
      * @param permissionRules - Additional permission rules
      * @alpha
      */
-    addPermissionRules(...permissionRules: CatalogPermissionRule[]): void;
+    addPermissionRules(...permissionRules: Array<CatalogPermissionRule | Array<CatalogPermissionRule>>): void;
     /**
      * Wires up and returns all of the component parts of the catalog
      */
@@ -531,7 +531,7 @@ export declare function createRandomProcessingInterval(options: {
 
 /**
  * @public
- * @deprecated Upgrade to a more recent `@backstage/search-backend-node` and
+ * @deprecated Upgrade to a more recent `@backstage/plugin-search-backend-node` and
  * use `DefaultCatalogCollatorFactory` instead.
  */
 export declare class DefaultCatalogCollator {

package/dist/index.beta.d.ts

@@ -170,7 +170,7 @@ export declare class CatalogBuilder {
      *
      * @param policies - One or more policies
      */
-    addEntityPolicy(...policies: EntityPolicy[]): CatalogBuilder;
+    addEntityPolicy(...policies: Array<EntityPolicy | Array<EntityPolicy>>): CatalogBuilder;
     /**
      * Processing interval determines how often entities should be processed.
      * Seconds provided will be multiplied by 1.5
@@ -229,14 +229,14 @@ export declare class CatalogBuilder {
      *
      * @param providers - One or more entity providers
      */
-    addEntityProvider(...providers: EntityProvider[]): CatalogBuilder;
+    addEntityProvider(...providers: Array<EntityProvider | Array<EntityProvider>>): CatalogBuilder;
     /**
      * Adds entity processors. These are responsible for reading, parsing, and
      * processing entities before they are persisted in the catalog.
      *
      * @param processors - One or more processors
      */
-    addProcessor(...processors: CatalogProcessor[]): CatalogBuilder;
+    addProcessor(...processors: Array<CatalogProcessor | Array<CatalogProcessor>>): CatalogBuilder;
     /**
      * Sets what entity processors to use. These are responsible for reading,
      * parsing, and processing entities before they are persisted in the catalog.
@@ -465,7 +465,7 @@ export declare function createRandomProcessingInterval(options: {
 
 /**
  * @public
- * @deprecated Upgrade to a more recent `@backstage/search-backend-node` and
+ * @deprecated Upgrade to a more recent `@backstage/plugin-search-backend-node` and
  * use `DefaultCatalogCollatorFactory` instead.
  */
 export declare class DefaultCatalogCollator {

package/dist/index.cjs.js

@@ -2815,6 +2815,17 @@ function parseEntityPaginationParams(params) {
   };
 }
 
+function getPathArrayAndValue(input, field) {
+  return field.split(".").reduce(([pathArray, inputSubset], pathPart, index, fieldParts) => {
+    if (lodash__default["default"].hasIn(inputSubset, pathPart)) {
+      return [pathArray.concat(pathPart), inputSubset[pathPart]];
+    } else if (fieldParts[index + 1] !== void 0) {
+      fieldParts[index + 1] = `${pathPart}.${fieldParts[index + 1]}`;
+      return [pathArray, inputSubset];
+    }
+    return [pathArray, void 0];
+  }, [[], input]);
+}
 function parseEntityTransformParams(params) {
   const fieldsStrings = parseStringsParam(params.fields, "fields");
   if (!fieldsStrings) {
@@ -2830,9 +2841,9 @@ function parseEntityTransformParams(params) {
   return (input) => {
     const output = {};
     for (const field of fields) {
-      const value = lodash__default["default"].get(input, field);
+      const [pathArray, value] = getPathArrayAndValue(input, field);
       if (value !== void 0) {
-        lodash__default["default"].set(output, field, value);
+        lodash__default["default"].set(output, pathArray, value);
       }
     }
     return output;
@@ -3386,7 +3397,7 @@ class CatalogBuilder {
     return new CatalogBuilder(env);
   }
   addEntityPolicy(...policies) {
-    this.entityPolicies.push(...policies);
+    this.entityPolicies.push(...policies.flat());
     return this;
   }
   setProcessingIntervalSeconds(seconds) {
@@ -3418,11 +3429,11 @@ class CatalogBuilder {
     return this;
   }
   addEntityProvider(...providers) {
-    this.entityProviders.push(...providers);
+    this.entityProviders.push(...providers.flat());
     return this;
   }
   addProcessor(...processors) {
-    this.processors.push(...processors);
+    this.processors.push(...processors.flat());
     return this;
   }
   replaceProcessors(processors) {
@@ -3445,7 +3456,7 @@ class CatalogBuilder {
     return this;
   }
   addPermissionRules(...permissionRules) {
-    this.permissionRules.push(...permissionRules);
+    this.permissionRules.push(...permissionRules.flat());
   }
   async build() {
     var _a, _b;