@backstage/plugin-catalog-node 1.19.2-next.0 → 1.20.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @backstage/plugin-catalog-node
 
+## 1.20.0-next.1
+
+### Minor Changes
+
+- 9d3ec06: Make YAML merge (<<:) support configurable in the Backstage Catalog instead of always being enabled
+- 8c26af4: Enable YAML merge keys in yamlPlaceholderResolver
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.5.0-next.1
+  - @backstage/plugin-permission-common@0.9.3-next.1
+  - @backstage/plugin-permission-node@0.10.6-next.1
+
 ## 1.19.2-next.0
 
 ### Patch Changes

package/dist/index.d.ts

@@ -383,6 +383,14 @@ declare function locationSpecToLocationEntity(opts: {
     parentEntity?: Entity;
 }): LocationEntityV1alpha1;
 
+/**
+ * Options for parsing entity YAML files.
+ *
+ * @public
+ */
+interface ParseEntityYamlOptions {
+    enableYamlMerge?: boolean;
+}
 /**
  * A helper function that parses a YAML file, properly handling multiple
  * documents in a single file.
@@ -399,7 +407,7 @@ declare function locationSpecToLocationEntity(opts: {
  * assumptions whatsoever can be made on the emnitted entities except that they
  * are valid JSON objects.
  */
-declare function parseEntityYaml(data: string | Buffer, location: LocationSpec$1): Iterable<CatalogProcessorResult>;
+declare function parseEntityYaml(data: string | Buffer, location: LocationSpec$1, options?: ParseEntityYamlOptions): Iterable<CatalogProcessorResult>;
 
 /**
  * @public
@@ -439,4 +447,4 @@ interface CatalogService {
  */
 declare const catalogServiceRef: _backstage_backend_plugin_api.ServiceRef<CatalogService, "plugin", "singleton">;
 
-export { type AnalyzeOptions, type CatalogProcessor, type CatalogProcessorCache, type CatalogProcessorEmit, type CatalogProcessorEntityResult, type CatalogProcessorErrorResult, type CatalogProcessorLocationResult, type CatalogProcessorParser, type CatalogProcessorRefreshKeysResult, type CatalogProcessorRelationResult, type CatalogProcessorResult, type CatalogService, type CatalogServiceRequestOptions, type DeferredEntity, type EntitiesSearchFilter, type EntityFilter, type EntityProvider, type EntityProviderConnection, type EntityProviderMutation, type EntityProviderRefreshOptions, type EntityRelationSpec, type LocationAnalyzer, type LocationSpec, type PlaceholderResolver, type PlaceholderResolverParams, type PlaceholderResolverRead, type PlaceholderResolverResolveUrl, type ScmLocationAnalyzer, catalogServiceRef, locationSpecToLocationEntity, locationSpecToMetadataName, parseEntityYaml, processingResult };
+export { type AnalyzeOptions, type CatalogProcessor, type CatalogProcessorCache, type CatalogProcessorEmit, type CatalogProcessorEntityResult, type CatalogProcessorErrorResult, type CatalogProcessorLocationResult, type CatalogProcessorParser, type CatalogProcessorRefreshKeysResult, type CatalogProcessorRelationResult, type CatalogProcessorResult, type CatalogService, type CatalogServiceRequestOptions, type DeferredEntity, type EntitiesSearchFilter, type EntityFilter, type EntityProvider, type EntityProviderConnection, type EntityProviderMutation, type EntityProviderRefreshOptions, type EntityRelationSpec, type LocationAnalyzer, type LocationSpec, type ParseEntityYamlOptions, type PlaceholderResolver, type PlaceholderResolverParams, type PlaceholderResolverRead, type PlaceholderResolverResolveUrl, type ScmLocationAnalyzer, catalogServiceRef, locationSpecToLocationEntity, locationSpecToMetadataName, parseEntityYaml, processingResult };

package/dist/processing/parse.cjs.js

@@ -10,11 +10,13 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 var lodash__default = /*#__PURE__*/_interopDefaultCompat(lodash);
 var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
 
-function* parseEntityYaml(data, location) {
+function* parseEntityYaml(data, location, options) {
+  const parseOptions = { merge: options?.enableYamlMerge ?? false };
   let documents;
   try {
     documents = yaml__default.default.parseAllDocuments(
-      typeof data === "string" ? data : data.toString("utf8")
+      typeof data === "string" ? data : data.toString("utf8"),
+      parseOptions
     ).filter((d) => d);
   } catch (e) {
     const loc = catalogModel.stringifyLocationRef(location);

package/dist/processing/parse.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"parse.cjs.js","sources":["../../src/processing/parse.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, stringifyLocationRef } from '@backstage/catalog-model';\nimport lodash from 'lodash';\nimport yaml from 'yaml';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { CatalogProcessorResult } from '../api/processor';\nimport { processingResult } from '../api/processingResult';\n\n/**\n * A helper function that parses a YAML file, properly handling multiple\n * documents in a single file.\n *\n * @public\n * @remarks\n *\n * Each document is expected to be a valid Backstage entity. Each item in the\n * iterable is in the form of an entity result if the document seemed like a\n * valid object, or in the form of an error result if it seemed incorrect. This\n * way, you can choose to retain a partial result if you want.\n *\n * Note that this function does NOT perform any validation of the entities. No\n * assumptions whatsoever can be made on the emnitted entities except that they\n * are valid JSON objects.\n */\nexport function* parseEntityYaml(\n  data: string | Buffer,\n  location: LocationSpec,\n): Iterable<CatalogProcessorResult> {\n  let documents: yaml.Document.Parsed[];\n  try {\n    documents = yaml\n      .parseAllDocuments(\n        typeof data === 'string' ? data : data.toString('utf8'),\n      )\n      .filter(d => d);\n  } catch (e) {\n    const loc = stringifyLocationRef(location);\n    const message = `Failed to parse YAML at ${loc}, ${e}`;\n    yield processingResult.generalError(location, message);\n    return;\n  }\n\n  for (const document of documents) {\n    if (document.errors?.length) {\n      const loc = stringifyLocationRef(location);\n      const message = `YAML error at ${loc}, ${document.errors[0]}`;\n      yield processingResult.generalError(location, message);\n    } else {\n      const json = document.toJSON();\n      if (lodash.isPlainObject(json)) {\n        yield processingResult.entity(location, json as Entity);\n      } else if (json === null) {\n        // Ignore null values, these happen if there is an empty document in the\n        // YAML file, for example if --- is added to the end of the file.\n      } else {\n        const message = `Expected object at root, got ${typeof json}`;\n        yield processingResult.generalError(location, message);\n      }\n    }\n  }\n}\n"],"names":["yaml","stringifyLocationRef","processingResult","lodash"],"mappings":";;;;;;;;;;;;AAuCO,UAAU,eAAA,CACf,MACA,QAAA,EACkC;AAClC,EAAA,IAAI,SAAA;AACJ,EAAA,IAAI;AACF,IAAA,SAAA,GAAYA,qBAAA,CACT,iBAAA;AAAA,MACC,OAAO,IAAA,KAAS,QAAA,GAAW,IAAA,GAAO,IAAA,CAAK,SAAS,MAAM;AAAA,KACxD,CACC,MAAA,CAAO,CAAA,CAAA,KAAK,CAAC,CAAA;AAAA,EAClB,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,GAAA,GAAMC,kCAAqB,QAAQ,CAAA;AACzC,IAAA,MAAM,OAAA,GAAU,CAAA,wBAAA,EAA2B,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAA;AACpD,IAAA,MAAMC,iCAAA,CAAiB,YAAA,CAAa,QAAA,EAAU,OAAO,CAAA;AACrD,IAAA;AAAA,EACF;AAEA,EAAA,KAAA,MAAW,YAAY,SAAA,EAAW;AAChC,IAAA,IAAI,QAAA,CAAS,QAAQ,MAAA,EAAQ;AAC3B,MAAA,MAAM,GAAA,GAAMD,kCAAqB,QAAQ,CAAA;AACzC,MAAA,MAAM,UAAU,CAAA,cAAA,EAAiB,GAAG,KAAK,QAAA,CAAS,MAAA,CAAO,CAAC,CAAC,CAAA,CAAA;AAC3D,MAAA,MAAMC,iCAAA,CAAiB,YAAA,CAAa,QAAA,EAAU,OAAO,CAAA;AAAA,IACvD,CAAA,MAAO;AACL,MAAA,MAAM,IAAA,GAAO,SAAS,MAAA,EAAO;AAC7B,MAAA,IAAIC,uBAAA,CAAO,aAAA,CAAc,IAAI,CAAA,EAAG;AAC9B,QAAA,MAAMD,iCAAA,CAAiB,MAAA,CAAO,QAAA,EAAU,IAAc,CAAA;AAAA,MACxD,CAAA,MAAA,IAAW,SAAS,IAAA,EAAM,CAG1B,MAAO;AACL,QAAA,MAAM,OAAA,GAAU,CAAA,6BAAA,EAAgC,OAAO,IAAI,CAAA,CAAA;AAC3D,QAAA,MAAMA,iCAAA,CAAiB,YAAA,CAAa,QAAA,EAAU,OAAO,CAAA;AAAA,MACvD;AAAA,IACF;AAAA,EACF;AACF;;;;"}
+{"version":3,"file":"parse.cjs.js","sources":["../../src/processing/parse.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, stringifyLocationRef } from '@backstage/catalog-model';\nimport lodash from 'lodash';\nimport yaml from 'yaml';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport { CatalogProcessorResult } from '../api/processor';\nimport { processingResult } from '../api/processingResult';\n\n/**\n * Options for parsing entity YAML files.\n *\n * @public\n */\nexport interface ParseEntityYamlOptions {\n  enableYamlMerge?: boolean;\n}\n\n/**\n * A helper function that parses a YAML file, properly handling multiple\n * documents in a single file.\n *\n * @public\n * @remarks\n *\n * Each document is expected to be a valid Backstage entity. Each item in the\n * iterable is in the form of an entity result if the document seemed like a\n * valid object, or in the form of an error result if it seemed incorrect. This\n * way, you can choose to retain a partial result if you want.\n *\n * Note that this function does NOT perform any validation of the entities. No\n * assumptions whatsoever can be made on the emnitted entities except that they\n * are valid JSON objects.\n */\nexport function* parseEntityYaml(\n  data: string | Buffer,\n  location: LocationSpec,\n  options?: ParseEntityYamlOptions,\n): Iterable<CatalogProcessorResult> {\n  const parseOptions = { merge: options?.enableYamlMerge ?? false };\n\n  let documents: yaml.Document.Parsed[];\n  try {\n    documents = yaml\n      .parseAllDocuments(\n        typeof data === 'string' ? data : data.toString('utf8'),\n        parseOptions,\n      )\n      .filter(d => d);\n  } catch (e) {\n    const loc = stringifyLocationRef(location);\n    const message = `Failed to parse YAML at ${loc}, ${e}`;\n    yield processingResult.generalError(location, message);\n    return;\n  }\n\n  for (const document of documents) {\n    if (document.errors?.length) {\n      const loc = stringifyLocationRef(location);\n      const message = `YAML error at ${loc}, ${document.errors[0]}`;\n      yield processingResult.generalError(location, message);\n    } else {\n      const json = document.toJSON();\n      if (lodash.isPlainObject(json)) {\n        yield processingResult.entity(location, json as Entity);\n      } else if (json === null) {\n        // Ignore null values, these happen if there is an empty document in the\n        // YAML file, for example if --- is added to the end of the file.\n      } else {\n        const message = `Expected object at root, got ${typeof json}`;\n        yield processingResult.generalError(location, message);\n      }\n    }\n  }\n}\n"],"names":["yaml","stringifyLocationRef","processingResult","lodash"],"mappings":";;;;;;;;;;;;AAgDO,UAAU,eAAA,CACf,IAAA,EACA,QAAA,EACA,OAAA,EACkC;AAClC,EAAA,MAAM,YAAA,GAAe,EAAE,KAAA,EAAO,OAAA,EAAS,mBAAmB,KAAA,EAAM;AAEhE,EAAA,IAAI,SAAA;AACJ,EAAA,IAAI;AACF,IAAA,SAAA,GAAYA,qBAAA,CACT,iBAAA;AAAA,MACC,OAAO,IAAA,KAAS,QAAA,GAAW,IAAA,GAAO,IAAA,CAAK,SAAS,MAAM,CAAA;AAAA,MACtD;AAAA,KACF,CACC,MAAA,CAAO,CAAA,CAAA,KAAK,CAAC,CAAA;AAAA,EAClB,SAAS,CAAA,EAAG;AACV,IAAA,MAAM,GAAA,GAAMC,kCAAqB,QAAQ,CAAA;AACzC,IAAA,MAAM,OAAA,GAAU,CAAA,wBAAA,EAA2B,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAA;AACpD,IAAA,MAAMC,iCAAA,CAAiB,YAAA,CAAa,QAAA,EAAU,OAAO,CAAA;AACrD,IAAA;AAAA,EACF;AAEA,EAAA,KAAA,MAAW,YAAY,SAAA,EAAW;AAChC,IAAA,IAAI,QAAA,CAAS,QAAQ,MAAA,EAAQ;AAC3B,MAAA,MAAM,GAAA,GAAMD,kCAAqB,QAAQ,CAAA;AACzC,MAAA,MAAM,UAAU,CAAA,cAAA,EAAiB,GAAG,KAAK,QAAA,CAAS,MAAA,CAAO,CAAC,CAAC,CAAA,CAAA;AAC3D,MAAA,MAAMC,iCAAA,CAAiB,YAAA,CAAa,QAAA,EAAU,OAAO,CAAA;AAAA,IACvD,CAAA,MAAO;AACL,MAAA,MAAM,IAAA,GAAO,SAAS,MAAA,EAAO;AAC7B,MAAA,IAAIC,uBAAA,CAAO,aAAA,CAAc,IAAI,CAAA,EAAG;AAC9B,QAAA,MAAMD,iCAAA,CAAiB,MAAA,CAAO,QAAA,EAAU,IAAc,CAAA;AAAA,MACxD,CAAA,MAAA,IAAW,SAAS,IAAA,EAAM,CAG1B,MAAO;AACL,QAAA,MAAM,OAAA,GAAU,CAAA,6BAAA,EAAgC,OAAO,IAAI,CAAA,CAAA;AAC3D,QAAA,MAAMA,iCAAA,CAAiB,YAAA,CAAa,QAAA,EAAU,OAAO,CAAA;AAAA,MACvD;AAAA,IACF;AAAA,EACF;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-node",
-  "version": "1.19.2-next.0",
+  "version": "1.20.0-next.1",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
   "backstage": {
     "role": "node-library",
@@ -72,20 +72,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.4.5-next.0",
+    "@backstage/backend-plugin-api": "1.5.0-next.1",
     "@backstage/catalog-client": "1.12.1-next.0",
     "@backstage/catalog-model": "1.7.6-next.0",
     "@backstage/errors": "1.2.7",
     "@backstage/plugin-catalog-common": "1.1.7-next.0",
-    "@backstage/plugin-permission-common": "0.9.3-next.0",
-    "@backstage/plugin-permission-node": "0.10.6-next.0",
+    "@backstage/plugin-permission-common": "0.9.3-next.1",
+    "@backstage/plugin-permission-node": "0.10.6-next.1",
     "@backstage/types": "1.2.2",
     "lodash": "^4.17.21",
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.10.0-next.0",
-    "@backstage/cli": "0.34.5-next.0",
+    "@backstage/backend-test-utils": "1.10.0-next.1",
+    "@backstage/cli": "0.34.5-next.1",
     "msw": "^1.0.0"
   }
 }