@backstage/plugin-kubernetes-node 0.3.7-next.1 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @backstage/plugin-kubernetes-node
 
+## 0.4.0
+
+### Minor Changes
+
+- 7f9846f: Add possibility to extends Kubernetes REST API. Add fetcher to parameters for custom objects provider
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.6.0
+  - @backstage/plugin-kubernetes-common@0.9.9
+
+## 0.4.0-next.2
+
+### Minor Changes
+
+- 7f9846f: Add possibility to extends Kubernetes REST API. Add fetcher to parameters for custom objects provider
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.6.0-next.1
+  - @backstage/catalog-model@1.7.6
+  - @backstage/types@1.2.2
+  - @backstage/plugin-kubernetes-common@0.9.9-next.0
+
 ## 0.3.7-next.1
 
 ### Patch Changes

package/dist/extensions.cjs.js

@@ -17,10 +17,14 @@ const kubernetesFetcherExtensionPoint = backendPluginApi.createExtensionPoint({
 const kubernetesServiceLocatorExtensionPoint = backendPluginApi.createExtensionPoint({
   id: "kubernetes.service-locator"
 });
+const kubernetesRouterExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "kubernetes.router"
+});
 
 exports.kubernetesAuthStrategyExtensionPoint = kubernetesAuthStrategyExtensionPoint;
 exports.kubernetesClusterSupplierExtensionPoint = kubernetesClusterSupplierExtensionPoint;
 exports.kubernetesFetcherExtensionPoint = kubernetesFetcherExtensionPoint;
 exports.kubernetesObjectsProviderExtensionPoint = kubernetesObjectsProviderExtensionPoint;
+exports.kubernetesRouterExtensionPoint = kubernetesRouterExtensionPoint;
 exports.kubernetesServiceLocatorExtensionPoint = kubernetesServiceLocatorExtensionPoint;
 //# sourceMappingURL=extensions.cjs.js.map

package/dist/extensions.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport {\n  AuthenticationStrategy,\n  CustomResource,\n  ObjectToFetch,\n  KubernetesClustersSupplier,\n  KubernetesFetcher,\n  KubernetesObjectsProvider,\n  KubernetesServiceLocator,\n} from '@backstage/plugin-kubernetes-node';\n\n/**\n * A factory function for creating a KubernetesObjectsProvider.\n *\n * @public\n */\nexport type KubernetesObjectsProviderFactory = (opts: {\n  getDefault: () => Promise<KubernetesObjectsProvider>;\n  clusterSupplier: KubernetesClustersSupplier;\n  serviceLocator: KubernetesServiceLocator;\n  customResources: CustomResource[];\n  objectTypesToFetch?: ObjectToFetch[];\n  authStrategy: AuthenticationStrategy;\n}) => Promise<KubernetesObjectsProvider>;\n\n/**\n * The interface for {@link kubernetesObjectsProviderExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesObjectsProviderExtensionPoint {\n  addObjectsProvider(\n    provider: KubernetesObjectsProvider | KubernetesObjectsProviderFactory,\n  ): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a objects provider.\n *\n * @public\n */\nexport const kubernetesObjectsProviderExtensionPoint =\n  createExtensionPoint<KubernetesObjectsProviderExtensionPoint>({\n    id: 'kubernetes.objects-provider',\n  });\n\n/**\n * A factory function for creating a KubernetesClustersSupplier.\n *\n * @public\n */\nexport type KubernetesClusterSupplierFactory = (opts: {\n  getDefault: () => Promise<KubernetesClustersSupplier>;\n}) => Promise<KubernetesClustersSupplier>;\n\n/**\n * The interface for {@link kubernetesClusterSupplierExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesClusterSupplierExtensionPoint {\n  addClusterSupplier(\n    clusterSupplier:\n      | KubernetesClustersSupplier\n      | KubernetesClusterSupplierFactory,\n  ): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a cluster supplier.\n *\n * @public\n */\nexport const kubernetesClusterSupplierExtensionPoint =\n  createExtensionPoint<KubernetesClusterSupplierExtensionPoint>({\n    id: 'kubernetes.cluster-supplier',\n  });\n\n/**\n * The interface for {@link kubernetesAuthStrategyExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesAuthStrategyExtensionPoint {\n  addAuthStrategy(key: string, strategy: AuthenticationStrategy): void;\n}\n\n/**\n * An extension point the exposes the ability to add an Auth Strategy.\n *\n * @public\n */\nexport const kubernetesAuthStrategyExtensionPoint =\n  createExtensionPoint<KubernetesAuthStrategyExtensionPoint>({\n    id: 'kubernetes.auth-strategy',\n  });\n\n/**\n * A factory function for creating a KubernetesFetcher.\n *\n * @public\n */\nexport type KubernetesFetcherFactory = (opts: {\n  getDefault: () => Promise<KubernetesFetcher>;\n}) => Promise<KubernetesFetcher>;\n\n/**\n * The interface for {@link kubernetesFetcherExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesFetcherExtensionPoint {\n  addFetcher(fetcher: KubernetesFetcher | KubernetesFetcherFactory): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a kubernetes fetcher.\n *\n * @public\n */\nexport const kubernetesFetcherExtensionPoint =\n  createExtensionPoint<KubernetesFetcherExtensionPoint>({\n    id: 'kubernetes.fetcher',\n  });\n\n/**\n * A factory function for creating a KubernetesServiceLocator.\n *\n * @public\n */\nexport type KubernetesServiceLocatorFactory = (opts: {\n  getDefault: () => Promise<KubernetesServiceLocator>;\n  clusterSupplier: KubernetesClustersSupplier;\n}) => Promise<KubernetesServiceLocator>;\n\n/**\n * The interface for {@link kubernetesServiceLocatorExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesServiceLocatorExtensionPoint {\n  addServiceLocator(\n    serviceLocator: KubernetesServiceLocator | KubernetesServiceLocatorFactory,\n  ): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a kubernetes service locator.\n *\n * @public\n */\nexport const kubernetesServiceLocatorExtensionPoint =\n  createExtensionPoint<KubernetesServiceLocatorExtensionPoint>({\n    id: 'kubernetes.service-locator',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AAwDO,MAAM,0CACXA,qCAAA,CAA8D;AAAA,EAC5D,EAAA,EAAI;AACN,CAAC;AA6BI,MAAM,0CACXA,qCAAA,CAA8D;AAAA,EAC5D,EAAA,EAAI;AACN,CAAC;AAgBI,MAAM,uCACXA,qCAAA,CAA2D;AAAA,EACzD,EAAA,EAAI;AACN,CAAC;AAyBI,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;AA4BI,MAAM,yCACXA,qCAAA,CAA6D;AAAA,EAC3D,EAAA,EAAI;AACN,CAAC;;;;;;;;"}
+{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.ts"],"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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport {\n  AuthenticationStrategy,\n  CustomResource,\n  ObjectToFetch,\n  KubernetesClustersSupplier,\n  KubernetesFetcher,\n  KubernetesObjectsProvider,\n  KubernetesServiceLocator,\n} from '@backstage/plugin-kubernetes-node';\nimport type express from 'express';\n\n/**\n * A factory function for creating a KubernetesObjectsProvider.\n *\n * @public\n */\nexport type KubernetesObjectsProviderFactory = (opts: {\n  getDefault: () => Promise<KubernetesObjectsProvider>;\n  clusterSupplier: KubernetesClustersSupplier;\n  serviceLocator: KubernetesServiceLocator;\n  fetcher: KubernetesFetcher;\n  customResources: CustomResource[];\n  objectTypesToFetch?: ObjectToFetch[];\n  authStrategy: AuthenticationStrategy;\n}) => Promise<KubernetesObjectsProvider>;\n\n/**\n * The interface for {@link kubernetesObjectsProviderExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesObjectsProviderExtensionPoint {\n  addObjectsProvider(\n    provider: KubernetesObjectsProvider | KubernetesObjectsProviderFactory,\n  ): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a objects provider.\n *\n * @public\n */\nexport const kubernetesObjectsProviderExtensionPoint =\n  createExtensionPoint<KubernetesObjectsProviderExtensionPoint>({\n    id: 'kubernetes.objects-provider',\n  });\n\n/**\n * A factory function for creating a KubernetesClustersSupplier.\n *\n * @public\n */\nexport type KubernetesClusterSupplierFactory = (opts: {\n  getDefault: () => Promise<KubernetesClustersSupplier>;\n}) => Promise<KubernetesClustersSupplier>;\n\n/**\n * The interface for {@link kubernetesClusterSupplierExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesClusterSupplierExtensionPoint {\n  addClusterSupplier(\n    clusterSupplier:\n      | KubernetesClustersSupplier\n      | KubernetesClusterSupplierFactory,\n  ): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a cluster supplier.\n *\n * @public\n */\nexport const kubernetesClusterSupplierExtensionPoint =\n  createExtensionPoint<KubernetesClusterSupplierExtensionPoint>({\n    id: 'kubernetes.cluster-supplier',\n  });\n\n/**\n * The interface for {@link kubernetesAuthStrategyExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesAuthStrategyExtensionPoint {\n  addAuthStrategy(key: string, strategy: AuthenticationStrategy): void;\n}\n\n/**\n * An extension point the exposes the ability to add an Auth Strategy.\n *\n * @public\n */\nexport const kubernetesAuthStrategyExtensionPoint =\n  createExtensionPoint<KubernetesAuthStrategyExtensionPoint>({\n    id: 'kubernetes.auth-strategy',\n  });\n\n/**\n * A factory function for creating a KubernetesFetcher.\n *\n * @public\n */\nexport type KubernetesFetcherFactory = (opts: {\n  getDefault: () => Promise<KubernetesFetcher>;\n}) => Promise<KubernetesFetcher>;\n\n/**\n * The interface for {@link kubernetesFetcherExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesFetcherExtensionPoint {\n  addFetcher(fetcher: KubernetesFetcher | KubernetesFetcherFactory): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a kubernetes fetcher.\n *\n * @public\n */\nexport const kubernetesFetcherExtensionPoint =\n  createExtensionPoint<KubernetesFetcherExtensionPoint>({\n    id: 'kubernetes.fetcher',\n  });\n\n/**\n * A factory function for creating a KubernetesServiceLocator.\n *\n * @public\n */\nexport type KubernetesServiceLocatorFactory = (opts: {\n  getDefault: () => Promise<KubernetesServiceLocator>;\n  clusterSupplier: KubernetesClustersSupplier;\n}) => Promise<KubernetesServiceLocator>;\n\n/**\n * The interface for {@link kubernetesServiceLocatorExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesServiceLocatorExtensionPoint {\n  addServiceLocator(\n    serviceLocator: KubernetesServiceLocator | KubernetesServiceLocatorFactory,\n  ): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a kubernetes service locator.\n *\n * @public\n */\nexport const kubernetesServiceLocatorExtensionPoint =\n  createExtensionPoint<KubernetesServiceLocatorExtensionPoint>({\n    id: 'kubernetes.service-locator',\n  });\n\n/**\n * A factory function for creating a kubernetes router.\n *\n * @public\n */\nexport type KubernetesRouterFactory = (opts: {\n  getDefault: () => express.Router;\n  objectsProvider: KubernetesObjectsProvider;\n  clusterSupplier: KubernetesClustersSupplier;\n  authStrategyMap: { [key: string]: AuthenticationStrategy };\n}) => express.Router;\n\n/**\n * The interface for {@link kubernetesRouterExtensionPoint}.\n *\n * @public\n */\nexport interface KubernetesRouterExtensionPoint {\n  addRouter(router: KubernetesRouterFactory): void;\n}\n\n/**\n * An extension point the exposes the ability to configure a kubernetes service locator.\n *\n * @public\n */\nexport const kubernetesRouterExtensionPoint =\n  createExtensionPoint<KubernetesRouterExtensionPoint>({\n    id: 'kubernetes.router',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;AA0DO,MAAM,0CACXA,qCAAA,CAA8D;AAAA,EAC5D,EAAA,EAAI;AACN,CAAC;AA6BI,MAAM,0CACXA,qCAAA,CAA8D;AAAA,EAC5D,EAAA,EAAI;AACN,CAAC;AAgBI,MAAM,uCACXA,qCAAA,CAA2D;AAAA,EACzD,EAAA,EAAI;AACN,CAAC;AAyBI,MAAM,kCACXA,qCAAA,CAAsD;AAAA,EACpD,EAAA,EAAI;AACN,CAAC;AA4BI,MAAM,yCACXA,qCAAA,CAA6D;AAAA,EAC3D,EAAA,EAAI;AACN,CAAC;AA4BI,MAAM,iCACXA,qCAAA,CAAqD;AAAA,EACnD,EAAA,EAAI;AACN,CAAC;;;;;;;;;"}

package/dist/index.cjs.js

@@ -9,6 +9,7 @@ exports.kubernetesAuthStrategyExtensionPoint = extensions.kubernetesAuthStrategy
 exports.kubernetesClusterSupplierExtensionPoint = extensions.kubernetesClusterSupplierExtensionPoint;
 exports.kubernetesFetcherExtensionPoint = extensions.kubernetesFetcherExtensionPoint;
 exports.kubernetesObjectsProviderExtensionPoint = extensions.kubernetesObjectsProviderExtensionPoint;
+exports.kubernetesRouterExtensionPoint = extensions.kubernetesRouterExtensionPoint;
 exports.kubernetesServiceLocatorExtensionPoint = extensions.kubernetesServiceLocatorExtensionPoint;
 exports.PinnipedHelper = PinnipedHelper.PinnipedHelper;
 //# 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

@@ -1,6 +1,7 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { BackstageCredentials, LoggerService } from '@backstage/backend-plugin-api';
-import { KubernetesObjectsProvider as KubernetesObjectsProvider$1, KubernetesClustersSupplier as KubernetesClustersSupplier$1, KubernetesServiceLocator as KubernetesServiceLocator$1, CustomResource as CustomResource$1, ObjectToFetch as ObjectToFetch$1, AuthenticationStrategy as AuthenticationStrategy$1, KubernetesFetcher as KubernetesFetcher$1 } from '@backstage/plugin-kubernetes-node';
+import { KubernetesObjectsProvider as KubernetesObjectsProvider$1, KubernetesClustersSupplier as KubernetesClustersSupplier$1, KubernetesServiceLocator as KubernetesServiceLocator$1, KubernetesFetcher as KubernetesFetcher$1, CustomResource as CustomResource$1, ObjectToFetch as ObjectToFetch$1, AuthenticationStrategy as AuthenticationStrategy$1 } from '@backstage/plugin-kubernetes-node';
+import express from 'express';
 import { Entity } from '@backstage/catalog-model';
 import { KubernetesRequestAuth, ObjectsByEntityResponse, CustomResourceMatcher, KubernetesFetchError, FetchResponse } from '@backstage/plugin-kubernetes-common';
 import { JsonObject } from '@backstage/types';
@@ -14,6 +15,7 @@ type KubernetesObjectsProviderFactory = (opts: {
     getDefault: () => Promise<KubernetesObjectsProvider$1>;
     clusterSupplier: KubernetesClustersSupplier$1;
     serviceLocator: KubernetesServiceLocator$1;
+    fetcher: KubernetesFetcher$1;
     customResources: CustomResource$1[];
     objectTypesToFetch?: ObjectToFetch$1[];
     authStrategy: AuthenticationStrategy$1;
@@ -113,6 +115,33 @@ interface KubernetesServiceLocatorExtensionPoint {
  * @public
  */
 declare const kubernetesServiceLocatorExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<KubernetesServiceLocatorExtensionPoint>;
+/**
+ * A factory function for creating a kubernetes router.
+ *
+ * @public
+ */
+type KubernetesRouterFactory = (opts: {
+    getDefault: () => express.Router;
+    objectsProvider: KubernetesObjectsProvider$1;
+    clusterSupplier: KubernetesClustersSupplier$1;
+    authStrategyMap: {
+        [key: string]: AuthenticationStrategy$1;
+    };
+}) => express.Router;
+/**
+ * The interface for {@link kubernetesRouterExtensionPoint}.
+ *
+ * @public
+ */
+interface KubernetesRouterExtensionPoint {
+    addRouter(router: KubernetesRouterFactory): void;
+}
+/**
+ * An extension point the exposes the ability to configure a kubernetes service locator.
+ *
+ * @public
+ */
+declare const kubernetesRouterExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<KubernetesRouterExtensionPoint>;
 
 /**
  *
@@ -351,4 +380,5 @@ declare class PinnipedHelper {
     private buildRequestForPinniped;
 }
 
-export { type AuthMetadata, type AuthenticationStrategy, type ClusterDetails, type CustomResource, type CustomResourcesByEntity, type FetchResponseWrapper, type KubernetesAuthStrategyExtensionPoint, type KubernetesClusterSupplierExtensionPoint, type KubernetesClusterSupplierFactory, type KubernetesClustersSupplier, type KubernetesCredential, type KubernetesFetcher, type KubernetesFetcherExtensionPoint, type KubernetesFetcherFactory, type KubernetesObjectTypes, type KubernetesObjectsByEntity, type KubernetesObjectsProvider, type KubernetesObjectsProviderExtensionPoint, type KubernetesObjectsProviderFactory, type KubernetesServiceLocator, type KubernetesServiceLocatorExtensionPoint, type KubernetesServiceLocatorFactory, type ObjectFetchParams, type ObjectToFetch, type PinnipedClientCerts, PinnipedHelper, type PinnipedParameters, type ServiceLocatorRequestContext, kubernetesAuthStrategyExtensionPoint, kubernetesClusterSupplierExtensionPoint, kubernetesFetcherExtensionPoint, kubernetesObjectsProviderExtensionPoint, kubernetesServiceLocatorExtensionPoint };
+export { PinnipedHelper, kubernetesAuthStrategyExtensionPoint, kubernetesClusterSupplierExtensionPoint, kubernetesFetcherExtensionPoint, kubernetesObjectsProviderExtensionPoint, kubernetesRouterExtensionPoint, kubernetesServiceLocatorExtensionPoint };
+export type { AuthMetadata, AuthenticationStrategy, ClusterDetails, CustomResource, CustomResourcesByEntity, FetchResponseWrapper, KubernetesAuthStrategyExtensionPoint, KubernetesClusterSupplierExtensionPoint, KubernetesClusterSupplierFactory, KubernetesClustersSupplier, KubernetesCredential, KubernetesFetcher, KubernetesFetcherExtensionPoint, KubernetesFetcherFactory, KubernetesObjectTypes, KubernetesObjectsByEntity, KubernetesObjectsProvider, KubernetesObjectsProviderExtensionPoint, KubernetesObjectsProviderFactory, KubernetesRouterExtensionPoint, KubernetesRouterFactory, KubernetesServiceLocator, KubernetesServiceLocatorExtensionPoint, KubernetesServiceLocatorFactory, ObjectFetchParams, ObjectToFetch, PinnipedClientCerts, PinnipedParameters, ServiceLocatorRequestContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-kubernetes-node",
-  "version": "0.3.7-next.1",
+  "version": "0.4.0",
   "description": "Node.js library for the kubernetes plugin",
   "backstage": {
     "role": "node-library",
@@ -38,20 +38,21 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.5.1-next.0",
-    "@backstage/catalog-model": "1.7.6",
-    "@backstage/plugin-kubernetes-common": "0.9.9-next.0",
-    "@backstage/types": "1.2.2",
+    "@backstage/backend-plugin-api": "^1.6.0",
+    "@backstage/catalog-model": "^1.7.6",
+    "@backstage/plugin-kubernetes-common": "^0.9.9",
+    "@backstage/types": "^1.2.2",
     "@kubernetes/client-node": "1.4.0",
+    "@types/express": "^4.17.6",
     "node-fetch": "^2.7.0",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-app-api": "1.4.0-next.0",
-    "@backstage/backend-defaults": "0.14.0-next.0",
-    "@backstage/backend-test-utils": "1.10.1-next.0",
-    "@backstage/cli": "0.34.6-next.1",
-    "@backstage/plugin-kubernetes-backend": "0.20.5-next.1",
+    "@backstage/backend-app-api": "^1.4.0",
+    "@backstage/backend-defaults": "^0.14.0",
+    "@backstage/backend-test-utils": "^1.10.2",
+    "@backstage/cli": "^0.35.0",
+    "@backstage/plugin-kubernetes-backend": "^0.21.0",
     "msw": "^1.3.1",
     "supertest": "^7.0.0"
   },