@backstage/plugin-catalog-node 1.17.0-next.0 → 1.17.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @backstage/plugin-catalog-node
 
+## 1.17.0-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.3.1-next.2
+  - @backstage/catalog-client@1.10.0-next.0
+  - @backstage/catalog-model@1.7.3
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-catalog-common@1.1.4-next.0
+  - @backstage/plugin-permission-common@0.9.0-next.0
+  - @backstage/plugin-permission-node@0.10.0-next.2
+
+## 1.17.0-next.1
+
+### Minor Changes
+
+- a459f17: Added `parseEntityYaml` from `@backstage/plugin-catalog-backend`, to make it more easily usable by custom plugins and modules
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.3.1-next.1
+  - @backstage/plugin-permission-common@0.9.0-next.0
+  - @backstage/plugin-permission-node@0.10.0-next.1
+  - @backstage/catalog-client@1.10.0-next.0
+  - @backstage/catalog-model@1.7.3
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-catalog-common@1.1.4-next.0
+
 ## 1.17.0-next.0
 
 ### Minor Changes

package/dist/index.cjs.js

@@ -2,6 +2,7 @@
 
 var processingResult = require('./api/processingResult.cjs.js');
 var conversion = require('./conversion.cjs.js');
+var parse = require('./processing/parse.cjs.js');
 var catalogService = require('./catalogService.cjs.js');
 
 
@@ -9,5 +10,6 @@ var catalogService = require('./catalogService.cjs.js');
 exports.processingResult = processingResult.processingResult;
 exports.locationSpecToLocationEntity = conversion.locationSpecToLocationEntity;
 exports.locationSpecToMetadataName = conversion.locationSpecToMetadataName;
+exports.parseEntityYaml = parse.parseEntityYaml;
 exports.catalogServiceRef = catalogService.catalogServiceRef;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -298,6 +298,24 @@ type ScmLocationAnalyzer = {
     }>;
 };
 
+/**
+ * A helper function that parses a YAML file, properly handling multiple
+ * documents in a single file.
+ *
+ * @public
+ * @remarks
+ *
+ * Each document is expected to be a valid Backstage entity. Each item in the
+ * iterable is in the form of an entity result if the document seemed like a
+ * valid object, or in the form of an error result if it seemed incorrect. This
+ * way, you can choose to retain a partial result if you want.
+ *
+ * Note that this function does NOT perform any validation of the entities. No
+ * 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>;
+
 /**
  * A 'full' mutation replaces all existing entities created by this entity provider with new ones.
  * A 'delta' mutation can both add and remove entities provided by this provider. Previously provided
@@ -412,4 +430,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, 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 PlaceholderResolver, type PlaceholderResolverParams, type PlaceholderResolverRead, type PlaceholderResolverResolveUrl, type ScmLocationAnalyzer, catalogServiceRef, locationSpecToLocationEntity, locationSpecToMetadataName, parseEntityYaml, processingResult };

package/dist/processing/parse.cjs.js

@@ -0,0 +1,43 @@
+'use strict';
+
+var catalogModel = require('@backstage/catalog-model');
+var lodash = require('lodash');
+var yaml = require('yaml');
+var processingResult = require('../api/processingResult.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var lodash__default = /*#__PURE__*/_interopDefaultCompat(lodash);
+var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
+
+function* parseEntityYaml(data, location) {
+  let documents;
+  try {
+    documents = yaml__default.default.parseAllDocuments(
+      typeof data === "string" ? data : data.toString("utf8")
+    ).filter((d) => d);
+  } catch (e) {
+    const loc = catalogModel.stringifyLocationRef(location);
+    const message = `Failed to parse YAML at ${loc}, ${e}`;
+    yield processingResult.processingResult.generalError(location, message);
+    return;
+  }
+  for (const document of documents) {
+    if (document.errors?.length) {
+      const loc = catalogModel.stringifyLocationRef(location);
+      const message = `YAML error at ${loc}, ${document.errors[0]}`;
+      yield processingResult.processingResult.generalError(location, message);
+    } else {
+      const json = document.toJSON();
+      if (lodash__default.default.isPlainObject(json)) {
+        yield processingResult.processingResult.entity(location, json);
+      } else if (json === null) ; else {
+        const message = `Expected object at root, got ${typeof json}`;
+        yield processingResult.processingResult.generalError(location, message);
+      }
+    }
+  }
+}
+
+exports.parseEntityYaml = parseEntityYaml;
+//# sourceMappingURL=parse.cjs.js.map

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

@@ -0,0 +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":";;;;;;;;;;;;AAuCiB,UAAA,eAAA,CACf,MACA,QACkC,EAAA;AAClC,EAAI,IAAA,SAAA;AACJ,EAAI,IAAA;AACF,IAAA,SAAA,GAAYA,qBACT,CAAA,iBAAA;AAAA,MACC,OAAO,IAAS,KAAA,QAAA,GAAW,IAAO,GAAA,IAAA,CAAK,SAAS,MAAM;AAAA,KACxD,CACC,MAAO,CAAA,CAAA,CAAA,KAAK,CAAC,CAAA;AAAA,WACT,CAAG,EAAA;AACV,IAAM,MAAA,GAAA,GAAMC,kCAAqB,QAAQ,CAAA;AACzC,IAAA,MAAM,OAAU,GAAA,CAAA,wBAAA,EAA2B,GAAG,CAAA,EAAA,EAAK,CAAC,CAAA,CAAA;AACpD,IAAM,MAAAC,iCAAA,CAAiB,YAAa,CAAA,QAAA,EAAU,OAAO,CAAA;AACrD,IAAA;AAAA;AAGF,EAAA,KAAA,MAAW,YAAY,SAAW,EAAA;AAChC,IAAI,IAAA,QAAA,CAAS,QAAQ,MAAQ,EAAA;AAC3B,MAAM,MAAA,GAAA,GAAMD,kCAAqB,QAAQ,CAAA;AACzC,MAAA,MAAM,UAAU,CAAiB,cAAA,EAAA,GAAG,KAAK,QAAS,CAAA,MAAA,CAAO,CAAC,CAAC,CAAA,CAAA;AAC3D,MAAM,MAAAC,iCAAA,CAAiB,YAAa,CAAA,QAAA,EAAU,OAAO,CAAA;AAAA,KAChD,MAAA;AACL,MAAM,MAAA,IAAA,GAAO,SAAS,MAAO,EAAA;AAC7B,MAAI,IAAAC,uBAAA,CAAO,aAAc,CAAA,IAAI,CAAG,EAAA;AAC9B,QAAM,MAAAD,iCAAA,CAAiB,MAAO,CAAA,QAAA,EAAU,IAAc,CAAA;AAAA,OACxD,MAAA,IAAW,SAAS,IAAM,EAAA,CAGnB,MAAA;AACL,QAAM,MAAA,OAAA,GAAU,CAAgC,6BAAA,EAAA,OAAO,IAAI,CAAA,CAAA;AAC3D,QAAM,MAAAA,iCAAA,CAAiB,YAAa,CAAA,QAAA,EAAU,OAAO,CAAA;AAAA;AACvD;AACF;AAEJ;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-node",
-  "version": "1.17.0-next.0",
+  "version": "1.17.0-next.2",
   "description": "The plugin-catalog-node module for @backstage/plugin-catalog-backend",
   "backstage": {
     "role": "node-library",
@@ -72,18 +72,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.3.1-next.0",
+    "@backstage/backend-plugin-api": "1.3.1-next.2",
     "@backstage/catalog-client": "1.10.0-next.0",
     "@backstage/catalog-model": "1.7.3",
     "@backstage/errors": "1.2.7",
-    "@backstage/plugin-catalog-common": "1.1.3",
-    "@backstage/plugin-permission-common": "0.8.4",
-    "@backstage/plugin-permission-node": "0.9.2-next.0",
-    "@backstage/types": "1.2.1"
+    "@backstage/plugin-catalog-common": "1.1.4-next.0",
+    "@backstage/plugin-permission-common": "0.9.0-next.0",
+    "@backstage/plugin-permission-node": "0.10.0-next.2",
+    "@backstage/types": "1.2.1",
+    "lodash": "^4.17.21",
+    "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.5.0-next.0",
-    "@backstage/cli": "0.32.1-next.0",
+    "@backstage/backend-test-utils": "1.5.0-next.3",
+    "@backstage/cli": "0.32.1-next.3",
     "msw": "^1.0.0"
   }
 }