@jfvilas/plugin-kwirth-common 0.12.1

package/README.md

@@ -0,0 +1,2 @@
+# Kwirth Backstage Common
+This repo contains common objects for use both at front and backend Backstage Kwirth plugins.

package/dist/index.cjs.js

@@ -0,0 +1,11 @@
+'use strict';
+
+const ANNOTATION_KWIRTH_LOCATION = "backstage.io/kubernetes-id";
+const isKwirthAvailable = (entity) => {
+  if (!entity.metadata.annotations) return false;
+  return Boolean(entity.metadata.annotations[ANNOTATION_KWIRTH_LOCATION]);
+};
+
+exports.ANNOTATION_KWIRTH_LOCATION = ANNOTATION_KWIRTH_LOCATION;
+exports.isKwirthAvailable = isKwirthAvailable;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/index.ts"],"sourcesContent":["/*\r\nCopyright 2024 Julio Fernandez\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\nimport { Entity } from '@backstage/catalog-model';\r\nexport * from './Resources';\r\n\r\n/**\r\n * Kubelog annotation.\r\n */\r\nexport const ANNOTATION_KWIRTH_LOCATION = 'backstage.io/kubernetes-id';\r\n\r\n/**\r\n * Function to know if an entity has Kubelog.\r\n */\r\nexport const isKwirthAvailable = (entity: Entity) => {\r\n  if (!entity.metadata.annotations) return false;\r\n  return Boolean (entity.metadata.annotations[ANNOTATION_KWIRTH_LOCATION]);\r\n}\r\n"],"names":[],"mappings":";;AAqBO,MAAM,0BAA6B,GAAA;AAK7B,MAAA,iBAAA,GAAoB,CAAC,MAAmB,KAAA;AACnD,EAAA,IAAI,CAAC,MAAA,CAAO,QAAS,CAAA,WAAA,EAAoB,OAAA,KAAA;AACzC,EAAA,OAAO,OAAS,CAAA,MAAA,CAAO,QAAS,CAAA,WAAA,CAAY,0BAA0B,CAAC,CAAA;AACzE;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import { Entity } from '@backstage/catalog-model';
+import { InstanceConfigScopeEnum, AccessKey } from '@jfvilas/kwirth-common';
+
+/**
+ * @interface PodData contains data related on oaccessing one pod for doing someting
+ * @field name, the name of the pod (including nothing extra)
+ * @field namespace, the namespace of the pod
+ * @field accessKeys, a Map with a service scope as key (STREAM, VIEW, RESTART...) and an access key as value
+ */
+interface PodData {
+    name: string;
+    namespace: string;
+}
+/**
+ * @interface ClusterValidPods contains data about a cluster and all the pods found in the cluster that match required access
+ * @field name is the name of the cluster
+ * @field url is the kwirth url (we will use it for asking for access keys)
+ * @field title is a short description of the cluster
+ * @field data is an array of 'PodAccess'
+ */
+interface ClusterValidPods {
+    name: string;
+    url: string;
+    title?: string;
+    data: PodData[];
+    accessKeys: Map<InstanceConfigScopeEnum, AccessKey>;
+}
+
+/**
+ * Kubelog annotation.
+ */
+declare const ANNOTATION_KWIRTH_LOCATION = "backstage.io/kubernetes-id";
+/**
+ * Function to know if an entity has Kubelog.
+ */
+declare const isKwirthAvailable: (entity: Entity) => boolean;
+
+export { ANNOTATION_KWIRTH_LOCATION, isKwirthAvailable };
+export type { ClusterValidPods, PodData };

package/dist/index.esm.js

@@ -0,0 +1,8 @@
+const ANNOTATION_KWIRTH_LOCATION = "backstage.io/kubernetes-id";
+const isKwirthAvailable = (entity) => {
+  if (!entity.metadata.annotations) return false;
+  return Boolean(entity.metadata.annotations[ANNOTATION_KWIRTH_LOCATION]);
+};
+
+export { ANNOTATION_KWIRTH_LOCATION, isKwirthAvailable };
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/index.ts"],"sourcesContent":["/*\r\nCopyright 2024 Julio Fernandez\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\nimport { Entity } from '@backstage/catalog-model';\r\nexport * from './Resources';\r\n\r\n/**\r\n * Kubelog annotation.\r\n */\r\nexport const ANNOTATION_KWIRTH_LOCATION = 'backstage.io/kubernetes-id';\r\n\r\n/**\r\n * Function to know if an entity has Kubelog.\r\n */\r\nexport const isKwirthAvailable = (entity: Entity) => {\r\n  if (!entity.metadata.annotations) return false;\r\n  return Boolean (entity.metadata.annotations[ANNOTATION_KWIRTH_LOCATION]);\r\n}\r\n"],"names":[],"mappings":"AAqBO,MAAM,0BAA6B,GAAA;AAK7B,MAAA,iBAAA,GAAoB,CAAC,MAAmB,KAAA;AACnD,EAAA,IAAI,CAAC,MAAA,CAAO,QAAS,CAAA,WAAA,EAAoB,OAAA,KAAA;AACzC,EAAA,OAAO,OAAS,CAAA,MAAA,CAAO,QAAS,CAAA,WAAA,CAAY,0BAA0B,CAAC,CAAA;AACzE;;;;"}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@jfvilas/plugin-kwirth-common",
+  "version": "0.12.1",
+  "description": "Common functionalities for the Backstage Kwirth plugins",
+  "keywords": [
+    "Backstage",
+    "Kubernetes",
+    "observability",
+    "Kwirth",
+    "plugin"
+  ],
+  "backstage": {
+    "role": "common-library",
+    "pluginId": "kwirth",
+    "pluginPackages": [
+      "@jfvilas/plugin-kwirth-backend",
+      "@jfvilas/plugin-kwirth-common"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jfvilas/plugin-kwirth-common"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Julio Fernandez",
+    "url": "https://github.com/jfvilas",
+    "email": "jfvilas@outlook.com"
+  },
+  "sideEffects": false,
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "test": "backstage-cli package test"
+  },
+  "dependencies": {
+    "@backstage/catalog-model": "^1.5.0",
+    "@backstage/integration": "^1.13.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.26.11"
+  },
+  "module": "dist/index.esm.js"
+}