@backstage/plugin-kubernetes-react 0.6.1-next.0 → 0.6.1-next.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @backstage/plugin-kubernetes-react
 
+## 0.6.1-next.1
+
+### Patch Changes
+
+- 76ac6ed: Updated dependency `js-yaml` to `^5.0.0`.
+- Updated dependencies
+  - @backstage/core-components@0.18.15-next.2
+
 ## 0.6.1-next.0
 
 ### Patch Changes

package/dist/components/KubernetesDrawer/ManifestYaml.esm.js

@@ -2,11 +2,25 @@ import { jsxs, Fragment, jsx } from 'react/jsx-runtime';
 import { CodeSnippet } from '@backstage/core-components';
 import FormControlLabel from '@material-ui/core/FormControlLabel';
 import Switch from '@material-ui/core/Switch';
-import jsyaml from 'js-yaml';
+import * as jsyaml from 'js-yaml';
 import { useState } from 'react';
 import { useTranslationRef } from '@backstage/core-plugin-api/alpha';
 import { kubernetesReactTranslationRef } from '../../translation.esm.js';
 
+function removeManagedFields(value) {
+  if (Array.isArray(value)) {
+    return value.map(removeManagedFields);
+  }
+  if (value && typeof value === "object") {
+    const prototype = Object.getPrototypeOf(value);
+    if (prototype === Object.prototype || prototype === null) {
+      return Object.fromEntries(
+        Object.entries(value).filter(([key]) => key !== "managedFields").map(([key, entry]) => [key, removeManagedFields(entry)])
+      );
+    }
+  }
+  return value;
+}
 const ManifestYaml = ({ object }) => {
   const { t } = useTranslationRef(kubernetesReactTranslationRef);
   const [managedFields, setManagedFields] = useState(false);
@@ -31,17 +45,7 @@ const ManifestYaml = ({ object }) => {
       CodeSnippet,
       {
         language: "yaml",
-        text: jsyaml.dump(object, {
-          // NOTE: this will remove any field called `managedFields`
-          // not just the metadata one
-          // TODO: @mclarke make this only remove the `metadata.managedFields`
-          replacer: (key, value) => {
-            if (!managedFields) {
-              return key === "managedFields" ? void 0 : value;
-            }
-            return value;
-          }
-        })
+        text: jsyaml.dump(managedFields ? object : removeManagedFields(object))
       }
     )
   ] });

package/dist/components/KubernetesDrawer/ManifestYaml.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"ManifestYaml.esm.js","sources":["../../../src/components/KubernetesDrawer/ManifestYaml.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 { CodeSnippet } from '@backstage/core-components';\nimport FormControlLabel from '@material-ui/core/FormControlLabel';\nimport Switch from '@material-ui/core/Switch';\nimport jsyaml from 'js-yaml';\nimport { useState } from 'react';\nimport { useTranslationRef } from '@backstage/core-plugin-api/alpha';\nimport { kubernetesReactTranslationRef } from '../../translation';\n\n/**\n * Props of ManifestYaml\n *\n * @public\n */\nexport interface ManifestYamlProps {\n  object: object;\n}\n\n/**\n * Renders a Kubernetes object as a YAML code snippet\n *\n * @public\n */\nexport const ManifestYaml = ({ object }: ManifestYamlProps) => {\n  const { t } = useTranslationRef(kubernetesReactTranslationRef);\n  // Toggle whether the Kubernetes resource managed fields should be shown in\n  // the YAML display. This toggle is only available when the YAML is being\n  // shown because managed fields are never visible in the structured display.\n  const [managedFields, setManagedFields] = useState<boolean>(false);\n  return (\n    <>\n      <FormControlLabel\n        control={\n          <Switch\n            checked={managedFields}\n            onChange={event => {\n              setManagedFields(event.target.checked);\n            }}\n            name={t('kubernetesDrawer.managedFields')}\n          />\n        }\n        label={t('kubernetesDrawer.managedFields')}\n      />\n      <CodeSnippet\n        language=\"yaml\"\n        text={jsyaml.dump(object, {\n          // NOTE: this will remove any field called `managedFields`\n          // not just the metadata one\n          // TODO: @mclarke make this only remove the `metadata.managedFields`\n          replacer: (key: string, value: string): any => {\n            if (!managedFields) {\n              return key === 'managedFields' ? undefined : value;\n            }\n            return value;\n          },\n        })}\n      />\n    </>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;AAqCO,MAAM,YAAA,GAAe,CAAC,EAAE,MAAA,EAAO,KAAyB;AAC7D,EAAA,MAAM,EAAE,CAAA,EAAE,GAAI,iBAAA,CAAkB,6BAA6B,CAAA;AAI7D,EAAA,MAAM,CAAC,aAAA,EAAe,gBAAgB,CAAA,GAAI,SAAkB,KAAK,CAAA;AACjE,EAAA,uBACE,IAAA,CAAA,QAAA,EAAA,EACE,QAAA,EAAA;AAAA,oBAAA,GAAA;AAAA,MAAC,gBAAA;AAAA,MAAA;AAAA,QACC,OAAA,kBACE,GAAA;AAAA,UAAC,MAAA;AAAA,UAAA;AAAA,YACC,OAAA,EAAS,aAAA;AAAA,YACT,UAAU,CAAA,KAAA,KAAS;AACjB,cAAA,gBAAA,CAAiB,KAAA,CAAM,OAAO,OAAO,CAAA;AAAA,YACvC,CAAA;AAAA,YACA,IAAA,EAAM,EAAE,gCAAgC;AAAA;AAAA,SAC1C;AAAA,QAEF,KAAA,EAAO,EAAE,gCAAgC;AAAA;AAAA,KAC3C;AAAA,oBACA,GAAA;AAAA,MAAC,WAAA;AAAA,MAAA;AAAA,QACC,QAAA,EAAS,MAAA;AAAA,QACT,IAAA,EAAM,MAAA,CAAO,IAAA,CAAK,MAAA,EAAQ;AAAA;AAAA;AAAA;AAAA,UAIxB,QAAA,EAAU,CAAC,GAAA,EAAa,KAAA,KAAuB;AAC7C,YAAA,IAAI,CAAC,aAAA,EAAe;AAClB,cAAA,OAAO,GAAA,KAAQ,kBAAkB,MAAA,GAAY,KAAA;AAAA,YAC/C;AACA,YAAA,OAAO,KAAA;AAAA,UACT;AAAA,SACD;AAAA;AAAA;AACH,GAAA,EACF,CAAA;AAEJ;;"}
+{"version":3,"file":"ManifestYaml.esm.js","sources":["../../../src/components/KubernetesDrawer/ManifestYaml.tsx"],"sourcesContent":["/*\n * Copyright 2023 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 { CodeSnippet } from '@backstage/core-components';\nimport FormControlLabel from '@material-ui/core/FormControlLabel';\nimport Switch from '@material-ui/core/Switch';\nimport * as jsyaml from 'js-yaml';\nimport { useState } from 'react';\nimport { useTranslationRef } from '@backstage/core-plugin-api/alpha';\nimport { kubernetesReactTranslationRef } from '../../translation';\n\n/**\n * Props of ManifestYaml\n *\n * @public\n */\nexport interface ManifestYamlProps {\n  object: object;\n}\n\nfunction removeManagedFields(value: unknown): unknown {\n  if (Array.isArray(value)) {\n    return value.map(removeManagedFields);\n  }\n  if (value && typeof value === 'object') {\n    const prototype = Object.getPrototypeOf(value);\n    if (prototype === Object.prototype || prototype === null) {\n      return Object.fromEntries(\n        Object.entries(value)\n          .filter(([key]) => key !== 'managedFields')\n          .map(([key, entry]) => [key, removeManagedFields(entry)]),\n      );\n    }\n  }\n  return value;\n}\n\n/**\n * Renders a Kubernetes object as a YAML code snippet, hiding managed fields by\n * default while allowing them to be shown with a toggle.\n *\n * @public\n */\nexport const ManifestYaml = ({ object }: ManifestYamlProps) => {\n  const { t } = useTranslationRef(kubernetesReactTranslationRef);\n  // Toggle whether the Kubernetes resource managed fields should be shown in\n  // the YAML display. This toggle is only available when the YAML is being\n  // shown because managed fields are never visible in the structured display.\n  const [managedFields, setManagedFields] = useState<boolean>(false);\n  return (\n    <>\n      <FormControlLabel\n        control={\n          <Switch\n            checked={managedFields}\n            onChange={event => {\n              setManagedFields(event.target.checked);\n            }}\n            name={t('kubernetesDrawer.managedFields')}\n          />\n        }\n        label={t('kubernetesDrawer.managedFields')}\n      />\n      <CodeSnippet\n        language=\"yaml\"\n        text={jsyaml.dump(managedFields ? object : removeManagedFields(object))}\n      />\n    </>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;AAgCA,SAAS,oBAAoB,KAAA,EAAyB;AACpD,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,EAAG;AACxB,IAAA,OAAO,KAAA,CAAM,IAAI,mBAAmB,CAAA;AAAA,EACtC;AACA,EAAA,IAAI,KAAA,IAAS,OAAO,KAAA,KAAU,QAAA,EAAU;AACtC,IAAA,MAAM,SAAA,GAAY,MAAA,CAAO,cAAA,CAAe,KAAK,CAAA;AAC7C,IAAA,IAAI,SAAA,KAAc,MAAA,CAAO,SAAA,IAAa,SAAA,KAAc,IAAA,EAAM;AACxD,MAAA,OAAO,MAAA,CAAO,WAAA;AAAA,QACZ,MAAA,CAAO,QAAQ,KAAK,CAAA,CACjB,OAAO,CAAC,CAAC,GAAG,CAAA,KAAM,GAAA,KAAQ,eAAe,EACzC,GAAA,CAAI,CAAC,CAAC,GAAA,EAAK,KAAK,CAAA,KAAM,CAAC,GAAA,EAAK,mBAAA,CAAoB,KAAK,CAAC,CAAC;AAAA,OAC5D;AAAA,IACF;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT;AAQO,MAAM,YAAA,GAAe,CAAC,EAAE,MAAA,EAAO,KAAyB;AAC7D,EAAA,MAAM,EAAE,CAAA,EAAE,GAAI,iBAAA,CAAkB,6BAA6B,CAAA;AAI7D,EAAA,MAAM,CAAC,aAAA,EAAe,gBAAgB,CAAA,GAAI,SAAkB,KAAK,CAAA;AACjE,EAAA,uBACE,IAAA,CAAA,QAAA,EAAA,EACE,QAAA,EAAA;AAAA,oBAAA,GAAA;AAAA,MAAC,gBAAA;AAAA,MAAA;AAAA,QACC,OAAA,kBACE,GAAA;AAAA,UAAC,MAAA;AAAA,UAAA;AAAA,YACC,OAAA,EAAS,aAAA;AAAA,YACT,UAAU,CAAA,KAAA,KAAS;AACjB,cAAA,gBAAA,CAAiB,KAAA,CAAM,OAAO,OAAO,CAAA;AAAA,YACvC,CAAA;AAAA,YACA,IAAA,EAAM,EAAE,gCAAgC;AAAA;AAAA,SAC1C;AAAA,QAEF,KAAA,EAAO,EAAE,gCAAgC;AAAA;AAAA,KAC3C;AAAA,oBACA,GAAA;AAAA,MAAC,WAAA;AAAA,MAAA;AAAA,QACC,QAAA,EAAS,MAAA;AAAA,QACT,MAAM,MAAA,CAAO,IAAA,CAAK,gBAAgB,MAAA,GAAS,mBAAA,CAAoB,MAAM,CAAC;AAAA;AAAA;AACxE,GAAA,EACF,CAAA;AAEJ;;"}

package/dist/index.d.ts

@@ -585,7 +585,8 @@ interface ManifestYamlProps {
     object: object;
 }
 /**
- * Renders a Kubernetes object as a YAML code snippet
+ * Renders a Kubernetes object as a YAML code snippet, hiding managed fields by
+ * default while allowing them to be shown with a toggle.
  *
  * @public
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-kubernetes-react",
-  "version": "0.6.1-next.0",
+  "version": "0.6.1-next.1",
   "description": "Web library for the kubernetes-react plugin",
   "backstage": {
     "role": "web-library",
@@ -63,7 +63,7 @@
   },
   "dependencies": {
     "@backstage/catalog-model": "1.10.2-next.0",
-    "@backstage/core-components": "0.18.15-next.0",
+    "@backstage/core-components": "0.18.15-next.2",
     "@backstage/core-plugin-api": "1.12.11-next.0",
     "@backstage/errors": "1.3.2-next.0",
     "@backstage/plugin-kubernetes-common": "0.9.14-next.0",
@@ -78,7 +78,7 @@
     "@xterm/addon-fit": "^0.11.0",
     "@xterm/xterm": "^5.5.0",
     "cronstrue": "^2.32.0",
-    "js-yaml": "^4.3.2",
+    "js-yaml": "^5.0.0",
     "kubernetes-models": "^4.3.1",
     "lodash": "^4.17.21",
     "luxon": "^3.0.0",