@backstage/plugin-kubernetes-common 0.9.12 → 0.9.13-next.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @backstage/plugin-kubernetes-common
 
+## 0.9.13-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-permission-common@0.9.11-next.0
+
+## 0.9.13-next.0
+
+### Patch Changes
+
+- d9a57de: Add `KubernetesWatcher` interface for streaming Kubernetes resource changes via an async iterator. The watcher is separated from `KubernetesFetcher` because watching is a long-lived streaming connection that only works with server-side auth providers. Watch supports all event types (ADDED, MODIFIED, DELETED, BOOKMARK, ERROR) with errors yielded as data rather than thrown.
+
 ## 0.9.12
 
 ### Patch Changes

package/dist/index.d.ts

@@ -237,6 +237,55 @@ interface GroupedResponses extends DeploymentResources {
     persistentVolumes: V1PersistentVolume[];
     persistentVolumeClaims: V1PersistentVolumeClaim[];
 }
+/**
+ * Kubernetes watch event types from the API
+ * @public
+ */
+type KubernetesWatchEventType = 'ADDED' | 'MODIFIED' | 'DELETED' | 'BOOKMARK' | 'ERROR';
+/**
+ * Watch event emitted by the Kubernetes watch stream
+ * @public
+ */
+type KubernetesWatchEvent = {
+    type: Exclude<KubernetesWatchEventType, 'ERROR'>;
+    object: JsonObject;
+    resourceVersion?: string;
+} | {
+    type: 'ERROR';
+    error: KubernetesFetchError;
+};
+/**
+ * Options for watching Kubernetes resources
+ * @public
+ */
+interface KubernetesWatchOptions {
+    /** Namespace to watch resources in (optional for cluster-scoped resources) */
+    namespace?: string;
+    /** Label selector to filter resources */
+    labelSelector?: string;
+    /** Resource version to start watching from */
+    resourceVersion?: string;
+    /** Timeout in seconds for the watch operation */
+    timeoutSeconds?: number;
+    /** Allow watch bookmarks (for efficient resource version tracking) */
+    allowWatchBookmarks?: boolean;
+    /**
+     * When true, the watch stream begins with synthetic events that reproduce
+     * the current state of the collection, followed by a bookmark with the
+     * annotation `k8s.io/initial-events-end`. Requires `allowWatchBookmarks`
+     * and `resourceVersionMatch` set to `'NotOlderThan'`.
+     * See KEP-3157 (watch-list). Supported in Kubernetes 1.32+ (Beta).
+     */
+    sendInitialEvents?: boolean;
+    /**
+     * How the resourceVersion constraint is applied. Set to `'NotOlderThan'`
+     * when using `sendInitialEvents` so the server can serve from its watch
+     * cache rather than quorum-reading etcd.
+     */
+    resourceVersionMatch?: 'NotOlderThan' | 'Exact';
+    /** AbortSignal to cancel the watch from outside the iteration loop */
+    signal?: AbortSignal;
+}
 
 /**
  * The annotation key used to identify Kubernetes resources in Backstage.
@@ -432,4 +481,4 @@ declare const detectErrors: (objects: ObjectsByEntityResponse$1) => DetectedErro
 declare const groupResponses: (fetchResponse: FetchResponse$1[]) => GroupedResponses;
 
 export { ANNOTATION_KUBERNETES_API_SERVER, ANNOTATION_KUBERNETES_API_SERVER_CA, ANNOTATION_KUBERNETES_AUTH_PROVIDER, ANNOTATION_KUBERNETES_AWS_ASSUME_ROLE, ANNOTATION_KUBERNETES_AWS_CLUSTER_ID, ANNOTATION_KUBERNETES_AWS_EXTERNAL_ID, ANNOTATION_KUBERNETES_DASHBOARD_APP, ANNOTATION_KUBERNETES_DASHBOARD_PARAMETERS, ANNOTATION_KUBERNETES_DASHBOARD_URL, ANNOTATION_KUBERNETES_OIDC_TOKEN_PROVIDER, ANNOTATION_KUBERNETES_SKIP_METRICS_LOOKUP, ANNOTATION_KUBERNETES_SKIP_TLS_VERIFY, KUBERNETES_ANNOTATION, KUBERNETES_LABEL_SELECTOR_QUERY_ANNOTATION, SERVICEACCOUNT_CA_PATH, detectErrors, groupResponses, kubernetesClustersReadPermission, kubernetesPermissions, kubernetesProxyPermission, kubernetesResourcesReadPermission };
-export type { AuthProviderType, ClientContainerStatus, ClientCurrentResourceUsage, ClientPodStatus, ClusterAttributes, ClusterObjects, ConfigMapFetchResponse, CronJobsFetchResponse, CustomObjectsByEntityRequest, CustomResourceFetchResponse, CustomResourceMatcher, DaemonSetsFetchResponse, DeploymentFetchResponse, DeploymentResources, DetectedError, DetectedErrorsByCluster, DocsSolution, ErrorMapper, ErrorSeverity, EventsSolution, FetchResponse, GroupedResponses, HorizontalPodAutoscalersFetchResponse, IngressesFetchResponse, JobsFetchResponse, KubernetesErrorTypes, KubernetesFetchError, KubernetesRequestAuth, KubernetesRequestBody, LimitRangeFetchResponse, LogSolution, ObjectsByEntityResponse, PersistentVolumeClaimsFetchResponse, PersistentVolumeFetchResponse, PodFetchResponse, PodStatusFetchResponse, ProposedFix, ProposedFixBase, RawFetchError, ReplicaSetsFetchResponse, ResourceQuotaFetchResponse, ResourceRef, SecretFetchResponse, SecretsFetchResponse, ServiceFetchResponse, StatefulSetsFetchResponse, StatusError, WorkloadsByEntityRequest };
+export type { AuthProviderType, ClientContainerStatus, ClientCurrentResourceUsage, ClientPodStatus, ClusterAttributes, ClusterObjects, ConfigMapFetchResponse, CronJobsFetchResponse, CustomObjectsByEntityRequest, CustomResourceFetchResponse, CustomResourceMatcher, DaemonSetsFetchResponse, DeploymentFetchResponse, DeploymentResources, DetectedError, DetectedErrorsByCluster, DocsSolution, ErrorMapper, ErrorSeverity, EventsSolution, FetchResponse, GroupedResponses, HorizontalPodAutoscalersFetchResponse, IngressesFetchResponse, JobsFetchResponse, KubernetesErrorTypes, KubernetesFetchError, KubernetesRequestAuth, KubernetesRequestBody, KubernetesWatchEvent, KubernetesWatchEventType, KubernetesWatchOptions, LimitRangeFetchResponse, LogSolution, ObjectsByEntityResponse, PersistentVolumeClaimsFetchResponse, PersistentVolumeFetchResponse, PodFetchResponse, PodStatusFetchResponse, ProposedFix, ProposedFixBase, RawFetchError, ReplicaSetsFetchResponse, ResourceQuotaFetchResponse, ResourceRef, SecretFetchResponse, SecretsFetchResponse, ServiceFetchResponse, StatefulSetsFetchResponse, StatusError, WorkloadsByEntityRequest };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-kubernetes-common",
-  "version": "0.9.12",
+  "version": "0.9.13-next.1",
   "description": "Common functionalities for kubernetes, to be shared between kubernetes and kubernetes-backend plugin",
   "backstage": {
     "role": "common-library",
@@ -52,16 +52,16 @@
     ]
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.9.0",
-    "@backstage/plugin-permission-common": "^0.9.9",
-    "@backstage/types": "^1.2.2",
+    "@backstage/catalog-model": "1.10.0",
+    "@backstage/plugin-permission-common": "0.9.11-next.0",
+    "@backstage/types": "1.2.2",
     "@kubernetes/client-node": "1.4.0",
     "kubernetes-models": "^4.3.1",
     "lodash": "^4.17.21",
     "luxon": "^3.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.36.2"
+    "@backstage/cli": "0.36.6-next.1"
   },
   "typesVersions": {
     "*": {