kubernetes-fluent-client 2.0.0 → 2.1.0

package/README.md

@@ -20,13 +20,15 @@ async function demo() {
   // Now, we can use the fluent API to query for the resources we just created
 
   // You can use watch to monitor resources in the cluster and react to changes
-  // This will run until the process is terminated or the watch is aborted
-  const ctrl = await K8s(kind.Pod).Watch((pod, phase) => {
+  const watcher = K8s(kind.Pod).Watch((pod, phase) => {
     console.log(`Pod ${pod.metadata?.name} is ${phase}`);
   });
 
+  // This will run until the process is terminated or the watch is aborted
+  await watcher.start();
+
   // Let's abort the watch after 5 seconds
-  setTimeout(ctrl.abort, 5 * 1000);
+  setTimeout(watcher.close, 5 * 1000);
 
   // Passing the name to Get() will return a single resource
   const ns = await K8s(kind.Namespace).Get(namespace);

package/dist/fluent/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fluent/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAwB,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAOjF,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAsB,MAAM,SAAS,CAAC;AAI/D;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,EACtF,KAAK,EAAE,CAAC,EACR,OAAO,GAAE,OAAY,GACpB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAmKf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fluent/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAwB,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAOjF,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAA0B,OAAO,EAAE,OAAO,EAAsB,MAAM,SAAS,CAAC;AAIvF;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,EACtF,KAAK,EAAE,CAAC,EACR,OAAO,GAAE,OAAY,GACpB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CA4Kf"}

package/dist/fluent/index.js

@@ -131,6 +131,14 @@ function K8s(model, filters = {}) {
         }
         return (0, utils_1.k8sExec)(model, filters, "PATCH", payload);
     }
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.PatchStatus}
+     */
+    async function PatchStatus(resource) {
+        syncFilters(resource);
+        return (0, utils_1.k8sExec)(model, filters, "PATCH_STATUS", resource);
+    }
     /**
      * @inheritdoc
      * @see {@link K8sInit.Watch}
@@ -142,8 +150,8 @@ function K8s(model, filters = {}) {
      * @inheritdoc
      * @see {@link K8sInit.Raw}
      */
-    async function Raw(url) {
-        const thing = await (0, utils_1.k8sCfg)("GET");
+    async function Raw(url, method = "GET") {
+        const thing = await (0, utils_1.k8sCfg)(method);
         const { opts, serverUrl } = thing;
         const resp = await (0, fetch_1.fetch)(`${serverUrl}${url}`, opts);
         if (resp.ok) {
@@ -151,6 +159,6 @@ function K8s(model, filters = {}) {
         }
         throw resp;
     }
-    return { InNamespace, Apply, Create, Patch, Raw, ...withFilters };
+    return { InNamespace, Apply, Create, Patch, PatchStatus, Raw, ...withFilters };
 }
 exports.K8s = K8s;

package/dist/fluent/index.test.js

@@ -81,6 +81,35 @@ const generateFakePodManagedFields = (manager) => {
         (0, globals_1.expect)(result).toEqual(fakeResource);
         (0, globals_1.expect)(mockedKubeExec).toHaveBeenCalledWith(upstream_1.Pod, {}, "PATCH", patchOperations);
     });
+    (0, globals_1.it)("should patch the status of a resource", async () => {
+        await (0, _1.K8s)(upstream_1.Pod).PatchStatus({
+            metadata: {
+                name: "fake",
+                namespace: "default",
+                managedFields: generateFakePodManagedFields("pepr"),
+            },
+            spec: { priority: 3 },
+            status: {
+                phase: "Ready",
+            },
+        });
+        (0, globals_1.expect)(utils_1.k8sExec).toBeCalledWith(upstream_1.Pod, globals_1.expect.objectContaining({
+            name: "fake",
+            namespace: "default",
+        }), "PATCH_STATUS", {
+            apiVersion: "v1",
+            kind: "Pod",
+            metadata: {
+                name: "fake",
+                namespace: "default",
+                managedFields: generateFakePodManagedFields("pepr"),
+            },
+            spec: { priority: 3 },
+            status: {
+                phase: "Ready",
+            },
+        });
+    });
     (0, globals_1.it)("should filter with WithField", async () => {
         await (0, _1.K8s)(upstream_1.Pod).WithField("metadata.name", "fake").Get();
         (0, globals_1.expect)(mockedKubeExec).toHaveBeenCalledWith(upstream_1.Pod, globals_1.expect.objectContaining({

package/dist/fluent/types.d.ts

@@ -2,7 +2,6 @@ import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node"
 import { Operation } from "fast-json-patch";
 import type { PartialDeep } from "type-fest";
 import { GenericClass, GroupVersionKind } from "../types";
-import { ApplyCfg } from "./apply";
 import { WatchCfg, Watcher } from "./watch";
 /**
  * The Phase matched when using the K8s Watch API.
@@ -14,7 +13,7 @@ export declare enum WatchPhase {
     Bookmark = "BOOKMARK",
     Error = "ERROR"
 }
-export type FetchMethods = "GET" | "APPLY" | "POST" | "PUT" | "DELETE" | "PATCH" | "WATCH";
+export type FetchMethods = "GET" | "APPLY" | "POST" | "PUT" | "DELETE" | "PATCH" | "WATCH" | "PATCH_STATUS";
 export interface Filters {
     kindOverride?: GroupVersionKind;
     fields?: Record<string, string>;
@@ -81,6 +80,19 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
      * @returns The patched resource
      */
     Patch: (payload: Operation[]) => Promise<K>;
+    /**
+     * Patch the status of the provided K8s resource. Note this is a special case of the Patch method that
+     * only allows patching the status subresource. This can be used in Operator reconciliation loops to
+     * update the status of a resource without triggering a new Generation of the resource.
+     *
+     * See https://stackoverflow.com/q/47100389/467373 for more details.
+     *
+     * IMPORTANT: This method will throw a 404 error if the resource does not have a status subresource defined.
+     *
+     * @param resource - the resource to patch
+     * @returns the patched resource
+     */
+    PatchStatus: (resource: PartialDeep<K>) => Promise<K>;
     /**
      * Perform a raw GET request to the Kubernetes API. This is useful for calling endpoints that are not supported by the fluent API.
      * This command mirrors the `kubectl get --raw` command.
@@ -98,7 +110,7 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
      * @param url the URL to call (e.g. /api)
      * @returns
      */
-    Raw: (url: string) => Promise<K>;
+    Raw: (url: string, method?: FetchMethods) => Promise<K>;
 };
 export type K8sWithFilters<T extends GenericClass, K extends KubernetesObject> = K8sFilteredActions<T, K> & {
     /**
@@ -141,6 +153,15 @@ export type K8sWithFilters<T extends GenericClass, K extends KubernetesObject> =
      */
     WithLabel: (key: string, value?: string) => K8sWithFilters<T, K>;
 };
+/**
+ * Configuration for the apply function.
+ */
+export type ApplyCfg = {
+    /**
+     * Force the apply to be a create.
+     */
+    force?: boolean;
+};
 export type K8sInit<T extends GenericClass, K extends KubernetesObject> = K8sWithFilters<T, K> & K8sUnfilteredActions<K> & {
     /**
      * Set the namespace filter.

package/dist/fluent/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/fluent/types.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5C;;GAEG;AACH,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;AAE3F,MAAM,WAAW,OAAO;IACtB,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,gBAAgB,IAAI;IACpD,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI;IACnF;;;;OAIG;IACH,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEpB;;;;OAIG;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,IAAI;IAC7D;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAErE;;;;;OAKG;IACH,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAEpC;;;;;;;OAOG;IACH,KAAK,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE5C;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI,kBAAkB,CACjG,CAAC,EACD,CAAC,CACF,GAAG;IACF;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAE/E;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAClE,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5F,oBAAoB,CAAC,CAAC,CAAC,GAAG;IACxB;;;;;OAKG;IACH,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1D,CAAC;AAEJ,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAC9F,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,UAAU,KACd,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAG1B,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,MAAM,GACvC,CAAC,SAAS,MAAM,GAAG,MAAM,GACvB,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,EAAE,GACpC,KAAK,GACP,KAAK,CAAC;AAEV,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC7D,KAAK,GACL,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CACpF,CAAC,MAAM,CAAC,CAAC,GACV,EAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/fluent/types.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5C;;GAEG;AACH,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,YAAY,GACpB,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,QAAQ,GACR,OAAO,GACP,OAAO,GACP,cAAc,CAAC;AAEnB,MAAM,WAAW,OAAO;IACtB,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,gBAAgB,IAAI;IACpD,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI;IACnF;;;;OAIG;IACH,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEpB;;;;OAIG;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,IAAI;IAC7D;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAErE;;;;;OAKG;IACH,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAEpC;;;;;;;OAOG;IACH,KAAK,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE5C;;;;;;;;;;;OAWG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAEtD;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI,kBAAkB,CACjG,CAAC,EACD,CAAC,CACF,GAAG;IACF;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAE/E;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAClE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5F,oBAAoB,CAAC,CAAC,CAAC,GAAG;IACxB;;;;;OAKG;IACH,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1D,CAAC;AAEJ,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAC9F,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,UAAU,KACd,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAG1B,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,MAAM,GACvC,CAAC,SAAS,MAAM,GAAG,MAAM,GACvB,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,EAAE,GACpC,KAAK,GACP,KAAK,CAAC;AAEV,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC7D,KAAK,GACL,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CACpF,CAAC,MAAM,CAAC,CAAC,GACV,EAAE,CAAC"}

package/dist/fluent/utils.d.ts

@@ -1,8 +1,7 @@
 /// <reference types="node" />
 import { URL } from "url";
 import { GenericClass } from "../types";
-import { FetchMethods, Filters } from "./types";
-import { ApplyCfg } from "./apply";
+import { ApplyCfg, FetchMethods, Filters } from "./types";
 /**
  * Generate a path to a Kubernetes resource
  *

package/dist/fluent/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/fluent/utils.ts"],"names":[],"mappings":";AAMA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAG1B,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAInC;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,YAAY,EAChD,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,WAAW,UAAQ,OAwDpB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,MAAM,CAAC,MAAM,EAAE,YAAY;;;GAwBhD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,OAAO,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,EACrD,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,EACrB,QAAQ,GAAE,QAA2B,cA8BtC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/fluent/utils.ts"],"names":[],"mappings":";AAKA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAI1B,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAI1D;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,YAAY,EAChD,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,WAAW,UAAQ,OAwDpB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,MAAM,CAAC,MAAM,EAAE,YAAY;;;GAwBhD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,OAAO,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,EACrD,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,EACrB,QAAQ,GAAE,QAA2B,cA2CtC"}

package/dist/fluent/utils.js

@@ -108,6 +108,13 @@ async function k8sExec(model, filters, method, payload, applyCfg = { force: fals
     const { opts, serverUrl } = await k8sCfg(method);
     const url = pathBuilder(serverUrl, model, filters, method === "POST");
     switch (opts.method) {
+        // PATCH_STATUS is a special case that uses the PATCH method on status subresources
+        case "PATCH_STATUS":
+            opts.method = "PATCH";
+            url.pathname = `${url.pathname}/status`;
+            opts.headers.set("Content-Type", client_node_1.PatchStrategy.MergePatch);
+            payload = { status: payload.status };
+            break;
         case "PATCH":
             opts.headers.set("Content-Type", client_node_1.PatchStrategy.JsonPatch);
             break;
@@ -126,6 +133,10 @@ async function k8sExec(model, filters, method, payload, applyCfg = { force: fals
     if (resp.ok) {
         return resp.data;
     }
+    if (resp.status === 404 && method === "PATCH_STATUS") {
+        resp.statusText =
+            "Not Found" + " (NOTE: This error is expected if the resource has no status subresource)";
+    }
     throw resp;
 }
 exports.k8sExec = k8sExec;

package/dist/fluent/utils.test.js

@@ -3,10 +3,11 @@
 // SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });
 const globals_1 = require("@jest/globals");
+const node_fetch_1 = require("node-fetch");
 const fetch_1 = require("../fetch");
+const kinds_1 = require("../kinds");
 const upstream_1 = require("../upstream");
 const utils_1 = require("./utils");
-const kinds_1 = require("../kinds");
 globals_1.jest.mock("https");
 globals_1.jest.mock("../fetch");
 (0, globals_1.describe)("pathBuilder Function", () => {
@@ -92,14 +93,18 @@ globals_1.jest.mock("../fetch");
     const mockedFetch = globals_1.jest.mocked(fetch_1.fetch);
     const fakeFilters = { name: "fake", namespace: "default" };
     const fakeMethod = "GET";
-    const fakePayload = { metadata: { name: "fake", namespace: "default" } };
+    const fakePayload = {
+        metadata: { name: "fake", namespace: "default" },
+        status: { phase: "Ready" },
+    };
     const fakeUrl = new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake");
     const fakeOpts = {
         body: JSON.stringify(fakePayload),
-        headers: {
+        compress: true,
+        headers: new node_fetch_1.Headers({
             "Content-Type": "application/json",
             "User-Agent": `kubernetes-fluent-client`,
-        },
+        }),
         method: fakeMethod,
     };
     (0, globals_1.beforeEach)(() => {
@@ -116,6 +121,83 @@ globals_1.jest.mock("../fetch");
         (0, globals_1.expect)(result).toEqual(fakePayload);
         (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(fakeUrl, globals_1.expect.objectContaining(fakeOpts));
     });
+    (0, globals_1.it)("should handle PATCH_STATUS", async () => {
+        mockedFetch.mockResolvedValueOnce({
+            ok: true,
+            data: fakePayload,
+            status: 200,
+            statusText: "OK",
+        });
+        const result = await (0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, "PATCH_STATUS", fakePayload);
+        (0, globals_1.expect)(result).toEqual(fakePayload);
+        (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake/status"), globals_1.expect.objectContaining({
+            method: "PATCH",
+            compress: true,
+            headers: new node_fetch_1.Headers({
+                "Content-Type": "application/merge-patch+json",
+                "User-Agent": `kubernetes-fluent-client`,
+            }),
+            body: JSON.stringify({ status: fakePayload.status }),
+        }));
+    });
+    (0, globals_1.it)("should handle PATCH", async () => {
+        mockedFetch.mockResolvedValueOnce({
+            ok: true,
+            data: fakePayload,
+            status: 200,
+            statusText: "OK",
+        });
+        const patchPayload = [{ op: "replace", path: "/status/phase", value: "Ready" }];
+        const result = await (0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, "PATCH", patchPayload);
+        (0, globals_1.expect)(result).toEqual(fakePayload);
+        (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake"), globals_1.expect.objectContaining({
+            method: "PATCH",
+            compress: true,
+            headers: new node_fetch_1.Headers({
+                "Content-Type": "application/json-patch+json",
+                "User-Agent": `kubernetes-fluent-client`,
+            }),
+            body: JSON.stringify(patchPayload),
+        }));
+    });
+    (0, globals_1.it)("should handle APPLY", async () => {
+        mockedFetch.mockResolvedValueOnce({
+            ok: true,
+            data: fakePayload,
+            status: 200,
+            statusText: "OK",
+        });
+        const result = await (0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, "APPLY", fakePayload);
+        (0, globals_1.expect)(result).toEqual(fakePayload);
+        (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake?fieldManager=pepr&fieldValidation=Strict&force=false"), globals_1.expect.objectContaining({
+            method: "PATCH",
+            compress: true,
+            headers: new node_fetch_1.Headers({
+                "Content-Type": "application/apply-patch+yaml",
+                "User-Agent": `kubernetes-fluent-client`,
+            }),
+            body: JSON.stringify(fakePayload),
+        }));
+    });
+    (0, globals_1.it)("should handle APPLY with force", async () => {
+        mockedFetch.mockResolvedValueOnce({
+            ok: true,
+            data: fakePayload,
+            status: 200,
+            statusText: "OK",
+        });
+        const result = await (0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, "APPLY", fakePayload, { force: true });
+        (0, globals_1.expect)(result).toEqual(fakePayload);
+        (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake?fieldManager=pepr&fieldValidation=Strict&force=true"), globals_1.expect.objectContaining({
+            method: "PATCH",
+            compress: true,
+            headers: new node_fetch_1.Headers({
+                "Content-Type": "application/apply-patch+yaml",
+                "User-Agent": `kubernetes-fluent-client`,
+            }),
+            body: JSON.stringify(fakePayload),
+        }));
+    });
     (0, globals_1.it)("should handle fetch call failure", async () => {
         const fakeStatus = 404;
         const fakeStatusText = "Not Found";

package/dist/fluent/watch.d.ts

@@ -68,9 +68,21 @@ export declare class Watcher<T extends GenericClass> {
      * Get a unique ID for the watch based on the model and filters.
      * This is useful for caching the watch data or resource versions.
      *
-     * @returns the watch ID
+     * @returns the watch CacheID
      */
-    get id(): string;
+    getCacheID(): string;
+    /**
+     * Get the current resource version.
+     *
+     * @returns the current resource version
+     */
+    get resourceVersion(): string | undefined;
+    /**
+     * Set the current resource version.
+     *
+     * @param resourceVersion - the new resource version
+     */
+    set resourceVersion(resourceVersion: string | undefined);
     /**
      * Subscribe to watch events. This is an EventEmitter that emits the following events:
      *

package/dist/fluent/watch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":";;AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAG3D,oBAAY,UAAU;IACpB,sCAAsC;IACtC,OAAO,YAAY;IACnB,2BAA2B;IAC3B,aAAa,kBAAkB;IAC/B,kDAAkD;IAClD,UAAU,eAAe;IACzB,0BAA0B;IAC1B,SAAS,cAAc;IACvB,8BAA8B;IAC9B,OAAO,YAAY;IACnB,sBAAsB;IACtB,KAAK,UAAU;IACf,uBAAuB;IACvB,MAAM,WAAW;IACjB,mCAAmC;IACnC,IAAI,SAAS;IACb,2BAA2B;IAC3B,QAAQ,aAAa;IACrB,iCAAiC;IACjC,gBAAgB,qBAAqB;IACrC,wCAAwC;IACxC,oBAAoB,yBAAyB;IAC7C,qCAAqC;IACrC,iBAAiB,sBAAsB;CACxC;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG;IACrB,sFAAsF;IACtF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+HAA+H;IAC/H,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0GAA0G;IAC1G,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,iDAAiD;AACjD,qBAAa,OAAO,CAAC,CAAC,SAAS,YAAY;;IA6BzC;;;;;;;;;;;OAWG;gBACS,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAE,QAAa;IAiBzF;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAK9C,gGAAgG;IACzF,KAAK;IAMZ;;;;;OAKG;IACH,IAAW,EAAE,WAYZ;IAED;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;CAyOF"}
+{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":";;AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAG3D,oBAAY,UAAU;IACpB,sCAAsC;IACtC,OAAO,YAAY;IACnB,2BAA2B;IAC3B,aAAa,kBAAkB;IAC/B,kDAAkD;IAClD,UAAU,eAAe;IACzB,0BAA0B;IAC1B,SAAS,cAAc;IACvB,8BAA8B;IAC9B,OAAO,YAAY;IACnB,sBAAsB;IACtB,KAAK,UAAU;IACf,uBAAuB;IACvB,MAAM,WAAW;IACjB,mCAAmC;IACnC,IAAI,SAAS;IACb,2BAA2B;IAC3B,QAAQ,aAAa;IACrB,iCAAiC;IACjC,gBAAgB,qBAAqB;IACrC,wCAAwC;IACxC,oBAAoB,yBAAyB;IAC7C,qCAAqC;IACrC,iBAAiB,sBAAsB;CACxC;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG;IACrB,sFAAsF;IACtF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+HAA+H;IAC/H,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0GAA0G;IAC1G,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,iDAAiD;AACjD,qBAAa,OAAO,CAAC,CAAC,SAAS,YAAY;;IAyBzC;;;;;;;;;;;OAWG;gBACS,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAE,QAAa;IAiBzF;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAK9C,gGAAgG;IACzF,KAAK;IAMZ;;;;;OAKG;IACI,UAAU;IAWjB;;;;OAIG;IACH,IAAW,eAAe,IASkB,MAAM,GAAG,SAAS,CAP7D;IAED;;;;OAIG;IACH,IAAW,eAAe,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,EAE7D;IAED;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;CAoOF"}

package/dist/fluent/watch.js

@@ -56,9 +56,6 @@ class Watcher {
     #events = new events_1.EventEmitter();
     // Create a timer to resync the watch
     #resyncTimer;
-    // Unique ID for the watch
-    #id;
-    #hashedID;
     // Track if a reconnect is pending
     #pendingReconnect = false;
     /**
@@ -105,18 +102,32 @@ class Watcher {
      * Get a unique ID for the watch based on the model and filters.
      * This is useful for caching the watch data or resource versions.
      *
-     * @returns the watch ID
+     * @returns the watch CacheID
      */
-    get id() {
-        // The ID must exist at this point
-        if (!this.#id) {
-            throw new Error("watch not started");
-        }
+    getCacheID() {
+        // Build the URL, we don't care about the server URL or resourceVersion
+        const url = (0, utils_1.pathBuilder)("https://ignore", this.#model, this.#filters, false);
         // Hash and truncate the ID to 10 characters, cache the result
-        if (!this.#hashedID) {
-            this.#hashedID = (0, crypto_1.createHash)("sha224").update(this.#id).digest("hex").substring(0, 10);
-        }
-        return this.#hashedID;
+        return (0, crypto_1.createHash)("sha224")
+            .update(url.pathname + url.search)
+            .digest("hex")
+            .substring(0, 10);
+    }
+    /**
+     * Get the current resource version.
+     *
+     * @returns the current resource version
+     */
+    get resourceVersion() {
+        return this.#watchCfg.resourceVersion;
+    }
+    /**
+     * Set the current resource version.
+     *
+     * @param resourceVersion - the new resource version
+     */
+    set resourceVersion(resourceVersion) {
+        this.#watchCfg.resourceVersion = resourceVersion;
     }
     /**
      * Subscribe to watch events. This is an EventEmitter that emits the following events:
@@ -137,10 +148,6 @@ class Watcher {
         // Build the path and query params for the resource, excluding the name
         const { opts, serverUrl } = await (0, utils_1.k8sCfg)("GET");
         const url = (0, utils_1.pathBuilder)(serverUrl, this.#model, this.#filters, true);
-        // Set the watch ID if it does not exist (this does not change on reconnect)
-        if (!this.#id) {
-            this.#id = url.pathname + url.search;
-        }
         // Enable the watch query param
         url.searchParams.set("watch", "true");
         // If a name is specified, add it to the query params

package/dist/fluent/watch.spec.js

@@ -109,17 +109,24 @@ const types_1 = require("./types");
         });
         watcher.start().catch(errMock);
     });
-    (0, globals_1.it)("should return the cache id", done => {
-        watcher
-            .start()
-            .then(() => {
-            (0, globals_1.expect)(watcher.id).toEqual("d69b75a611");
-            done();
-        })
-            .catch(errMock);
+    (0, globals_1.it)("should return the cache id", () => {
+        (0, globals_1.expect)(watcher.getCacheID()).toEqual("d69b75a611");
     });
-    (0, globals_1.it)("should handle calling .id() before .start()", () => {
-        (0, globals_1.expect)(() => watcher.id).toThrowError("watch not started");
+    (0, globals_1.it)("should use an updated resourceVersion", done => {
+        nock_1.default.cleanAll();
+        (0, nock_1.default)("http://jest-test:8080")
+            .get("/api/v1/pods")
+            .query({
+            watch: "true",
+            allowWatchBookmarks: "true",
+            resourceVersion: "35",
+        })
+            .reply(200);
+        // Update the resource version, could be combined with getCacheID to store the value
+        watcher.resourceVersion = "35";
+        setupAndStartWatcher(__1.WatchEvent.CONNECT, () => {
+            done();
+        });
     });
     (0, globals_1.it)("should handle the CONNECT event", done => {
         setupAndStartWatcher(__1.WatchEvent.CONNECT, () => {
@@ -150,6 +157,13 @@ const types_1 = require("./types");
             done();
         });
     });
+    (0, globals_1.it)("should handle the RESOURCE_VERSION event", done => {
+        setupAndStartWatcher(__1.WatchEvent.RESOURCE_VERSION, resourceVersion => {
+            (0, globals_1.expect)(watcher.resourceVersion).toEqual("2");
+            (0, globals_1.expect)(resourceVersion).toEqual("2");
+            done();
+        });
+    });
     (0, globals_1.it)("should handle the RECONNECT event", done => {
         nock_1.default.cleanAll();
         (0, nock_1.default)("http://jest-test:8080")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply",
   "bin": "./dist/cli.js",
   "main": "dist/index.js",
@@ -51,8 +51,8 @@
     "@types/byline": "4.2.36",
     "@types/readable-stream": "4.0.10",
     "@types/yargs": "17.0.32",
-    "@typescript-eslint/eslint-plugin": "6.15.0",
-    "@typescript-eslint/parser": "6.15.0",
+    "@typescript-eslint/eslint-plugin": "6.16.0",
+    "@typescript-eslint/parser": "6.16.0",
     "eslint-plugin-jsdoc": "46.9.1",
     "jest": "29.7.0",
     "nock": "13.4.0",

package/src/fluent/index.test.ts

@@ -102,6 +102,42 @@ describe("Kube", () => {
     expect(mockedKubeExec).toHaveBeenCalledWith(Pod, {}, "PATCH", patchOperations);
   });
 
+  it("should patch the status of a resource", async () => {
+    await K8s(Pod).PatchStatus({
+      metadata: {
+        name: "fake",
+        namespace: "default",
+        managedFields: generateFakePodManagedFields("pepr"),
+      },
+      spec: { priority: 3 },
+      status: {
+        phase: "Ready",
+      },
+    });
+
+    expect(k8sExec).toBeCalledWith(
+      Pod,
+      expect.objectContaining({
+        name: "fake",
+        namespace: "default",
+      }),
+      "PATCH_STATUS",
+      {
+        apiVersion: "v1",
+        kind: "Pod",
+        metadata: {
+          name: "fake",
+          namespace: "default",
+          managedFields: generateFakePodManagedFields("pepr"),
+        },
+        spec: { priority: 3 },
+        status: {
+          phase: "Ready",
+        },
+      },
+    );
+  });
+
   it("should filter with WithField", async () => {
     await K8s(Pod).WithField("metadata.name", "fake").Get();
 

package/src/fluent/index.ts

@@ -9,8 +9,7 @@ import type { PartialDeep } from "type-fest";
 import { fetch } from "../fetch";
 import { modelToGroupVersionKind } from "../kinds";
 import { GenericClass } from "../types";
-import { ApplyCfg } from "./apply";
-import { Filters, K8sInit, Paths, WatchAction } from "./types";
+import { ApplyCfg, FetchMethods, Filters, K8sInit, Paths, WatchAction } from "./types";
 import { k8sCfg, k8sExec } from "./utils";
 import { WatchCfg, Watcher } from "./watch";
 
@@ -162,6 +161,15 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
     return k8sExec(model, filters, "PATCH", payload);
   }
 
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.PatchStatus}
+   */
+  async function PatchStatus(resource: PartialDeep<K>): Promise<K> {
+    syncFilters(resource as K);
+    return k8sExec(model, filters, "PATCH_STATUS", resource);
+  }
+
   /**
    * @inheritdoc
    * @see {@link K8sInit.Watch}
@@ -174,8 +182,8 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
    * @inheritdoc
    * @see {@link K8sInit.Raw}
    */
-  async function Raw(url: string) {
-    const thing = await k8sCfg("GET");
+  async function Raw(url: string, method: FetchMethods = "GET") {
+    const thing = await k8sCfg(method);
     const { opts, serverUrl } = thing;
     const resp = await fetch<K>(`${serverUrl}${url}`, opts);
 
@@ -186,5 +194,5 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
     throw resp;
   }
 
-  return { InNamespace, Apply, Create, Patch, Raw, ...withFilters };
+  return { InNamespace, Apply, Create, Patch, PatchStatus, Raw, ...withFilters };
 }

package/src/fluent/types.ts

@@ -6,7 +6,6 @@ import { Operation } from "fast-json-patch";
 import type { PartialDeep } from "type-fest";
 
 import { GenericClass, GroupVersionKind } from "../types";
-import { ApplyCfg } from "./apply";
 import { WatchCfg, Watcher } from "./watch";
 
 /**
@@ -20,7 +19,15 @@ export enum WatchPhase {
   Error = "ERROR",
 }
 
-export type FetchMethods = "GET" | "APPLY" | "POST" | "PUT" | "DELETE" | "PATCH" | "WATCH";
+export type FetchMethods =
+  | "GET"
+  | "APPLY"
+  | "POST"
+  | "PUT"
+  | "DELETE"
+  | "PATCH"
+  | "WATCH"
+  | "PATCH_STATUS";
 
 export interface Filters {
   kindOverride?: GroupVersionKind;
@@ -96,6 +103,20 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
    */
   Patch: (payload: Operation[]) => Promise<K>;
 
+  /**
+   * Patch the status of the provided K8s resource. Note this is a special case of the Patch method that
+   * only allows patching the status subresource. This can be used in Operator reconciliation loops to
+   * update the status of a resource without triggering a new Generation of the resource.
+   *
+   * See https://stackoverflow.com/q/47100389/467373 for more details.
+   *
+   * IMPORTANT: This method will throw a 404 error if the resource does not have a status subresource defined.
+   *
+   * @param resource - the resource to patch
+   * @returns the patched resource
+   */
+  PatchStatus: (resource: PartialDeep<K>) => Promise<K>;
+
   /**
    * Perform a raw GET request to the Kubernetes API. This is useful for calling endpoints that are not supported by the fluent API.
    * This command mirrors the `kubectl get --raw` command.
@@ -113,7 +134,7 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
    * @param url the URL to call (e.g. /api)
    * @returns
    */
-  Raw: (url: string) => Promise<K>;
+  Raw: (url: string, method?: FetchMethods) => Promise<K>;
 };
 
 export type K8sWithFilters<T extends GenericClass, K extends KubernetesObject> = K8sFilteredActions<
@@ -162,6 +183,16 @@ export type K8sWithFilters<T extends GenericClass, K extends KubernetesObject> =
   WithLabel: (key: string, value?: string) => K8sWithFilters<T, K>;
 };
 
+/**
+ * Configuration for the apply function.
+ */
+export type ApplyCfg = {
+  /**
+   * Force the apply to be a create.
+   */
+  force?: boolean;
+};
+
 export type K8sInit<T extends GenericClass, K extends KubernetesObject> = K8sWithFilters<T, K> &
   K8sUnfilteredActions<K> & {
     /**

package/src/fluent/utils.test.ts

@@ -2,13 +2,14 @@
 // SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { beforeEach, describe, expect, it, jest } from "@jest/globals";
+import { Headers } from "node-fetch";
 
 import { fetch } from "../fetch";
+import { RegisterKind } from "../kinds";
 import { GenericClass } from "../types";
 import { ClusterRole, Ingress, Pod } from "../upstream";
 import { Filters } from "./types";
 import { k8sExec, pathBuilder } from "./utils";
-import { RegisterKind } from "../kinds";
 
 jest.mock("https");
 jest.mock("../fetch");
@@ -115,14 +116,18 @@ describe("kubeExec Function", () => {
 
   const fakeFilters: Filters = { name: "fake", namespace: "default" };
   const fakeMethod = "GET";
-  const fakePayload = { metadata: { name: "fake", namespace: "default" } };
+  const fakePayload = {
+    metadata: { name: "fake", namespace: "default" },
+    status: { phase: "Ready" },
+  };
   const fakeUrl = new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake");
   const fakeOpts = {
     body: JSON.stringify(fakePayload),
-    headers: {
+    compress: true,
+    headers: new Headers({
       "Content-Type": "application/json",
       "User-Agent": `kubernetes-fluent-client`,
-    },
+    }),
     method: fakeMethod,
   };
 
@@ -144,6 +149,112 @@ describe("kubeExec Function", () => {
     expect(mockedFetch).toHaveBeenCalledWith(fakeUrl, expect.objectContaining(fakeOpts));
   });
 
+  it("should handle PATCH_STATUS", async () => {
+    mockedFetch.mockResolvedValueOnce({
+      ok: true,
+      data: fakePayload,
+      status: 200,
+      statusText: "OK",
+    });
+
+    const result = await k8sExec(Pod, fakeFilters, "PATCH_STATUS", fakePayload);
+
+    expect(result).toEqual(fakePayload);
+    expect(mockedFetch).toHaveBeenCalledWith(
+      new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake/status"),
+      expect.objectContaining({
+        method: "PATCH",
+        compress: true,
+        headers: new Headers({
+          "Content-Type": "application/merge-patch+json",
+          "User-Agent": `kubernetes-fluent-client`,
+        }),
+        body: JSON.stringify({ status: fakePayload.status }),
+      }),
+    );
+  });
+
+  it("should handle PATCH", async () => {
+    mockedFetch.mockResolvedValueOnce({
+      ok: true,
+      data: fakePayload,
+      status: 200,
+      statusText: "OK",
+    });
+
+    const patchPayload = [{ op: "replace", path: "/status/phase", value: "Ready" }];
+
+    const result = await k8sExec(Pod, fakeFilters, "PATCH", patchPayload);
+
+    expect(result).toEqual(fakePayload);
+    expect(mockedFetch).toHaveBeenCalledWith(
+      new URL("http://jest-test:8080/api/v1/namespaces/default/pods/fake"),
+      expect.objectContaining({
+        method: "PATCH",
+        compress: true,
+        headers: new Headers({
+          "Content-Type": "application/json-patch+json",
+          "User-Agent": `kubernetes-fluent-client`,
+        }),
+        body: JSON.stringify(patchPayload),
+      }),
+    );
+  });
+
+  it("should handle APPLY", async () => {
+    mockedFetch.mockResolvedValueOnce({
+      ok: true,
+      data: fakePayload,
+      status: 200,
+      statusText: "OK",
+    });
+
+    const result = await k8sExec(Pod, fakeFilters, "APPLY", fakePayload);
+
+    expect(result).toEqual(fakePayload);
+    expect(mockedFetch).toHaveBeenCalledWith(
+      new URL(
+        "http://jest-test:8080/api/v1/namespaces/default/pods/fake?fieldManager=pepr&fieldValidation=Strict&force=false",
+      ),
+      expect.objectContaining({
+        method: "PATCH",
+        compress: true,
+        headers: new Headers({
+          "Content-Type": "application/apply-patch+yaml",
+          "User-Agent": `kubernetes-fluent-client`,
+        }),
+        body: JSON.stringify(fakePayload),
+      }),
+    );
+  });
+
+  it("should handle APPLY with force", async () => {
+    mockedFetch.mockResolvedValueOnce({
+      ok: true,
+      data: fakePayload,
+      status: 200,
+      statusText: "OK",
+    });
+
+    const result = await k8sExec(Pod, fakeFilters, "APPLY", fakePayload, { force: true });
+
+    expect(result).toEqual(fakePayload);
+    expect(mockedFetch).toHaveBeenCalledWith(
+      new URL(
+        "http://jest-test:8080/api/v1/namespaces/default/pods/fake?fieldManager=pepr&fieldValidation=Strict&force=true",
+      ),
+      expect.objectContaining({
+        method: "PATCH",
+        compress: true,
+        headers: new Headers({
+          "Content-Type": "application/apply-patch+yaml",
+          "User-Agent": `kubernetes-fluent-client`,
+        }),
+        body: JSON.stringify(fakePayload),
+      }),
+    );
+  });
+
   it("should handle fetch call failure", async () => {
     const fakeStatus = 404;
     const fakeStatusText = "Not Found";

package/src/fluent/utils.ts

@@ -2,14 +2,13 @@
 // SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 
 import { KubeConfig, PatchStrategy } from "@kubernetes/client-node";
-
 import { Headers } from "node-fetch";
 import { URL } from "url";
+
 import { fetch } from "../fetch";
 import { modelToGroupVersionKind } from "../kinds";
 import { GenericClass } from "../types";
-import { FetchMethods, Filters } from "./types";
-import { ApplyCfg } from "./apply";
+import { ApplyCfg, FetchMethods, Filters } from "./types";
 
 const SSA_CONTENT_TYPE = "application/apply-patch+yaml";
 
@@ -143,6 +142,14 @@ export async function k8sExec<T extends GenericClass, K>(
   const url = pathBuilder(serverUrl, model, filters, method === "POST");
 
   switch (opts.method) {
+    // PATCH_STATUS is a special case that uses the PATCH method on status subresources
+    case "PATCH_STATUS":
+      opts.method = "PATCH";
+      url.pathname = `${url.pathname}/status`;
+      (opts.headers as Headers).set("Content-Type", PatchStrategy.MergePatch);
+      payload = { status: (payload as { status: unknown }).status };
+      break;
+
     case "PATCH":
       (opts.headers as Headers).set("Content-Type", PatchStrategy.JsonPatch);
       break;
@@ -166,5 +173,10 @@ export async function k8sExec<T extends GenericClass, K>(
     return resp.data;
   }
 
+  if (resp.status === 404 && method === "PATCH_STATUS") {
+    resp.statusText =
+      "Not Found" + " (NOTE: This error is expected if the resource has no status subresource)";
+  }
+
   throw resp;
 }

package/src/fluent/watch.spec.ts

@@ -132,18 +132,27 @@ describe("Watcher", () => {
     watcher.start().catch(errMock);
   });
 
-  it("should return the cache id", done => {
-    watcher
-      .start()
-      .then(() => {
-        expect(watcher.id).toEqual("d69b75a611");
-        done();
-      })
-      .catch(errMock);
+  it("should return the cache id", () => {
+    expect(watcher.getCacheID()).toEqual("d69b75a611");
   });
 
-  it("should handle calling .id() before .start()", () => {
-    expect(() => watcher.id).toThrowError("watch not started");
+  it("should use an updated resourceVersion", done => {
+    nock.cleanAll();
+    nock("http://jest-test:8080")
+      .get("/api/v1/pods")
+      .query({
+        watch: "true",
+        allowWatchBookmarks: "true",
+        resourceVersion: "35",
+      })
+      .reply(200);
+
+    // Update the resource version, could be combined with getCacheID to store the value
+    watcher.resourceVersion = "35";
+
+    setupAndStartWatcher(WatchEvent.CONNECT, () => {
+      done();
+    });
   });
 
   it("should handle the CONNECT event", done => {
@@ -182,6 +191,14 @@ describe("Watcher", () => {
     });
   });
 
+  it("should handle the RESOURCE_VERSION event", done => {
+    setupAndStartWatcher(WatchEvent.RESOURCE_VERSION, resourceVersion => {
+      expect(watcher.resourceVersion).toEqual("2");
+      expect(resourceVersion).toEqual("2");
+      done();
+    });
+  });
+
   it("should handle the RECONNECT event", done => {
     nock.cleanAll();
     nock("http://jest-test:8080")

package/src/fluent/watch.ts

@@ -72,10 +72,6 @@ export class Watcher<T extends GenericClass> {
   // Create a timer to resync the watch
   #resyncTimer?: NodeJS.Timeout;
 
-  // Unique ID for the watch
-  #id?: string;
-  #hashedID?: string;
-
   // Track if a reconnect is pending
   #pendingReconnect = false;
 
@@ -129,20 +125,35 @@ export class Watcher<T extends GenericClass> {
    * Get a unique ID for the watch based on the model and filters.
    * This is useful for caching the watch data or resource versions.
    *
-   * @returns the watch ID
+   * @returns the watch CacheID
    */
-  public get id() {
-    // The ID must exist at this point
-    if (!this.#id) {
-      throw new Error("watch not started");
-    }
+  public getCacheID() {
+    // Build the URL, we don't care about the server URL or resourceVersion
+    const url = pathBuilder("https://ignore", this.#model, this.#filters, false);
 
     // Hash and truncate the ID to 10 characters, cache the result
-    if (!this.#hashedID) {
-      this.#hashedID = createHash("sha224").update(this.#id).digest("hex").substring(0, 10);
-    }
+    return createHash("sha224")
+      .update(url.pathname + url.search)
+      .digest("hex")
+      .substring(0, 10);
+  }
+
+  /**
+   * Get the current resource version.
+   *
+   * @returns the current resource version
+   */
+  public get resourceVersion() {
+    return this.#watchCfg.resourceVersion;
+  }
 
-    return this.#hashedID;
+  /**
+   * Set the current resource version.
+   *
+   * @param resourceVersion - the new resource version
+   */
+  public set resourceVersion(resourceVersion: string | undefined) {
+    this.#watchCfg.resourceVersion = resourceVersion;
   }
 
   /**
@@ -166,11 +177,6 @@ export class Watcher<T extends GenericClass> {
     const { opts, serverUrl } = await k8sCfg("GET");
     const url = pathBuilder(serverUrl, this.#model, this.#filters, true);
 
-    // Set the watch ID if it does not exist (this does not change on reconnect)
-    if (!this.#id) {
-      this.#id = url.pathname + url.search;
-    }
-
     // Enable the watch query param
     url.searchParams.set("watch", "true");
 

package/dist/fluent/apply.d.ts

@@ -1,10 +0,0 @@
-/**
- * Configuration for the apply function.
- */
-export type ApplyCfg = {
-    /**
-     * Force the apply to be a create.
-     */
-    force?: boolean;
-};
-//# sourceMappingURL=apply.d.ts.map

package/dist/fluent/apply.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"apply.d.ts","sourceRoot":"","sources":["../../src/fluent/apply.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC"}

package/dist/fluent/apply.js

@@ -1,4 +0,0 @@
-"use strict";
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/fluent/apply.ts

@@ -1,12 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
-
-/**
- * Configuration for the apply function.
- */
-export type ApplyCfg = {
-  /**
-   * Force the apply to be a create.
-   */
-  force?: boolean;
-};