kubernetes-fluent-client 1.9.0 → 2.0.0

package/dist/fluent/index.d.ts

@@ -8,5 +8,5 @@ import { Filters, K8sInit } from "./types";
  * @param filters - (optional) filter overrides, can also be chained
  * @returns a fluent API for the model
  */
-export declare function K8s<T extends GenericClass, K extends KubernetesObject = InstanceType<T>>(model: T, filters?: Filters): K8sInit<K>;
+export declare function K8s<T extends GenericClass, K extends KubernetesObject = InstanceType<T>>(model: T, filters?: Filters): K8sInit<T, K>;
 //# sourceMappingURL=index.d.ts.map

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;AAMjF,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,CAAC,CAmJZ"}
+{"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"}

package/dist/fluent/index.js

@@ -4,6 +4,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.K8s = void 0;
 const http_status_codes_1 = require("http-status-codes");
+const fetch_1 = require("../fetch");
 const kinds_1 = require("../kinds");
 const utils_1 = require("./utils");
 const watch_1 = require("./watch");
@@ -134,9 +135,22 @@ function K8s(model, filters = {}) {
      * @inheritdoc
      * @see {@link K8sInit.Watch}
      */
-    async function Watch(callback, watchCfg) {
-        return (0, watch_1.ExecWatch)(model, filters, callback, watchCfg);
+    function Watch(callback, watchCfg) {
+        return new watch_1.Watcher(model, filters, callback, watchCfg);
     }
-    return { InNamespace, Apply, Create, Patch, ...withFilters };
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.Raw}
+     */
+    async function Raw(url) {
+        const thing = await (0, utils_1.k8sCfg)("GET");
+        const { opts, serverUrl } = thing;
+        const resp = await (0, fetch_1.fetch)(`${serverUrl}${url}`, opts);
+        if (resp.ok) {
+            return resp.data;
+        }
+        throw resp;
+    }
+    return { InNamespace, Apply, Create, Patch, Raw, ...withFilters };
 }
 exports.K8s = K8s;

package/dist/fluent/index.test.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const globals_1 = require("@jest/globals");
-const upstream_1 = require("../upstream");
+const client_node_1 = require("@kubernetes/client-node");
 const _1 = require(".");
+const fetch_1 = require("../fetch");
+const upstream_1 = require("../upstream");
 const utils_1 = require("./utils");
 // Setup mocks
 globals_1.jest.mock("./utils");
+globals_1.jest.mock("../fetch");
 const generateFakePodManagedFields = (manager) => {
     return [
         {
@@ -49,6 +52,7 @@ const generateFakePodManagedFields = (manager) => {
             managedFields: generateFakePodManagedFields("pepr"),
         },
     };
+    const mockedKubeCfg = globals_1.jest.mocked(utils_1.k8sCfg);
     const mockedKubeExec = globals_1.jest.mocked(utils_1.k8sExec).mockResolvedValue(fakeResource);
     (0, globals_1.beforeEach)(() => {
         // Clear all instances and calls to constructor and all methods:
@@ -134,4 +138,27 @@ const generateFakePodManagedFields = (manager) => {
         mockedKubeExec.mockRejectedValueOnce({ status: 500 }); // Internal Server Error on first call
         await (0, globals_1.expect)((0, _1.K8s)(upstream_1.Pod).Delete("fakeResource")).rejects.toEqual(globals_1.expect.objectContaining({ status: 500 }));
     });
+    (0, globals_1.it)("should create a raw api request", async () => {
+        mockedKubeCfg.mockReturnValue(new Promise(r => r({
+            serverUrl: "http://localhost:8080",
+            opts: {},
+        })));
+        const mockResp = {
+            kind: "APIVersions",
+            versions: ["v1"],
+            serverAddressByClientCIDRs: [
+                {
+                    serverAddress: "172.27.0.3:6443",
+                },
+            ],
+        };
+        globals_1.jest.mocked(fetch_1.fetch).mockResolvedValue({
+            ok: true,
+            data: mockResp,
+            status: 200,
+            statusText: "OK",
+        });
+        const result = await (0, _1.K8s)(client_node_1.V1APIGroup).Raw("/api");
+        (0, globals_1.expect)(result).toEqual(mockResp);
+    });
 });

package/dist/fluent/types.d.ts

@@ -2,15 +2,17 @@ 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 { WatchCfg, WatchController } from "./watch";
 import { ApplyCfg } from "./apply";
+import { WatchCfg, Watcher } from "./watch";
 /**
  * The Phase matched when using the K8s Watch API.
  */
 export declare enum WatchPhase {
     Added = "ADDED",
     Modified = "MODIFIED",
-    Deleted = "DELETED"
+    Deleted = "DELETED",
+    Bookmark = "BOOKMARK",
+    Error = "ERROR"
 }
 export type FetchMethods = "GET" | "APPLY" | "POST" | "PUT" | "DELETE" | "PATCH" | "WATCH";
 export interface Filters {
@@ -32,7 +34,7 @@ export type GetFunction<K extends KubernetesObject> = {
     (): Promise<KubernetesListObject<K>>;
     (name: string): Promise<K>;
 };
-export type K8sFilteredActions<K extends KubernetesObject> = {
+export type K8sFilteredActions<T extends GenericClass, K extends KubernetesObject> = {
     /**
      * Get the resource or resources matching the filters.
      * If no filters are specified, all resources will be returned.
@@ -52,7 +54,7 @@ export type K8sFilteredActions<K extends KubernetesObject> = {
      * @param watchCfg - (optional) watch configuration
      * @returns a watch controller
      */
-    Watch: (callback: (payload: K, phase: WatchPhase) => void, watchCfg?: WatchCfg) => Promise<WatchController>;
+    Watch: (callback: WatchAction<T>, watchCfg?: WatchCfg) => Watcher<T>;
 };
 export type K8sUnfilteredActions<K extends KubernetesObject> = {
     /**
@@ -79,8 +81,26 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
      * @returns The patched resource
      */
     Patch: (payload: Operation[]) => 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.
+     *
+     * E.g.
+     *
+     * ```ts
+     * import { V1APIGroup } from "@kubernetes/client-node";
+     *
+     * K8s(V1APIGroup).Raw("/api")
+     * ```
+     *
+     * will call the `/api` endpoint and is equivalent to `kubectl get --raw /api`.
+     *
+     * @param url the URL to call (e.g. /api)
+     * @returns
+     */
+    Raw: (url: string) => Promise<K>;
 };
-export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> & {
+export type K8sWithFilters<T extends GenericClass, K extends KubernetesObject> = K8sFilteredActions<T, K> & {
     /**
      * Filter the query by the given field.
      * Note multiple calls to this method will result in an AND condition. e.g.
@@ -100,7 +120,7 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
      * @param value - the field value
      * @returns the fluent API
      */
-    WithField: <P extends Paths<K>>(key: P, value: string) => K8sWithFilters<K>;
+    WithField: <P extends Paths<K>>(key: P, value: string) => K8sWithFilters<T, K>;
     /**
      * Filter the query by the given label. If no value is specified, the label simply must exist.
      * Note multiple calls to this method will result in an AND condition. e.g.
@@ -119,16 +139,16 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
      * @param value - the label value
      * @returns the fluent API
      */
-    WithLabel: (key: string, value?: string) => K8sWithFilters<K>;
+    WithLabel: (key: string, value?: string) => K8sWithFilters<T, K>;
 };
-export type K8sInit<K extends KubernetesObject> = K8sWithFilters<K> & K8sUnfilteredActions<K> & {
+export type K8sInit<T extends GenericClass, K extends KubernetesObject> = K8sWithFilters<T, K> & K8sUnfilteredActions<K> & {
     /**
      * Set the namespace filter.
      *
      * @param namespace - the namespace to filter on
      * @returns the fluent API
      */
-    InNamespace: (namespace: string) => K8sWithFilters<K>;
+    InNamespace: (namespace: string) => K8sWithFilters<T, K>;
 };
 export type WatchAction<T extends GenericClass, K extends KubernetesObject = InstanceType<T>> = (update: K, phase: WatchPhase) => Promise<void> | void;
 type Join<K, P> = K extends string | number ? P extends string | number ? `${K}${"" extends P ? "" : "."}${P}` : never : never;

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,eAAe,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;GAEG;AACH,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;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,gBAAgB,IAAI;IAC3D;;;;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,CACL,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,UAAU,KAAK,IAAI,EACjD,QAAQ,CAAC,EAAE,QAAQ,KAChB,OAAO,CAAC,eAAe,CAAC,CAAC;CAC/B,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;CAC7C,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,gBAAgB,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG;IAC/E;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,CAAC,CAAC;IAE5E;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,CAAC,CAAC;CAC/D,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,gBAAgB,IAAI,cAAc,CAAC,CAAC,CAAC,GACjE,oBAAoB,CAAC,CAAC,CAAC,GAAG;IACxB;;;;;OAKG;IACH,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,CAAC,CAAC;CACvD,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,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"}

package/dist/fluent/types.js

@@ -11,4 +11,6 @@ var WatchPhase;
     WatchPhase["Added"] = "ADDED";
     WatchPhase["Modified"] = "MODIFIED";
     WatchPhase["Deleted"] = "DELETED";
+    WatchPhase["Bookmark"] = "BOOKMARK";
+    WatchPhase["Error"] = "ERROR";
 })(WatchPhase || (exports.WatchPhase = WatchPhase = {}));

package/dist/fluent/watch.d.ts

@@ -1,52 +1,83 @@
 /// <reference types="node" />
-import { GenericClass, LogFn } from "../types";
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { GenericClass } from "../types";
 import { Filters, WatchAction } from "./types";
-/**
- * Wrapper for the AbortController to allow the watch to be aborted externally.
- */
-export type WatchController = {
+export declare enum WatchEvent {
+    /** Watch is connected successfully */
+    CONNECT = "connect",
+    /** Network error occurs */
+    NETWORK_ERROR = "network_error",
+    /** Error decoding data or running the callback */
+    DATA_ERROR = "data_error",
+    /** Reconnect is called */
+    RECONNECT = "reconnect",
+    /** Retry limit is exceeded */
+    GIVE_UP = "give_up",
+    /** Abort is called */
+    ABORT = "abort",
+    /** Resync is called */
+    RESYNC = "resync",
+    /** Data is received and decoded */
+    DATA = "data",
+    /** Bookmark is received */
+    BOOKMARK = "bookmark",
+    /** ResourceVersion is updated */
+    RESOURCE_VERSION = "resource_version",
+    /** 410 (old resource version) occurs */
+    OLD_RESOURCE_VERSION = "old_resource_version",
+    /** A reconnect is already pending */
+    RECONNECT_PENDING = "reconnect_pending"
+}
+/** Configuration for the watch function. */
+export type WatchCfg = {
+    /** The resource version to start the watch at, this will be updated on each event. */
+    resourceVersion?: string;
+    /** The maximum number of times to retry the watch, the retry count is reset on success. Unlimited retries if not specified. */
+    retryMax?: number;
+    /** The delay between retries in seconds. Defaults to 10 seconds. */
+    retryDelaySec?: number;
+    /** Amount of seconds to wait before a forced-resyncing of the watch list. Defaults to 300 (5 minutes). */
+    resyncIntervalSec?: number;
+};
+/** A wrapper around the Kubernetes watch API. */
+export declare class Watcher<T extends GenericClass> {
+    #private;
     /**
-     * Abort the watch.
+     * Setup a Kubernetes watcher for the specified model and filters. The callback function will be called for each event received.
+     * The watch can be aborted by calling {@link Watcher.close} or by calling abort() on the AbortController returned by {@link Watcher.start}.
      *
-     * @param reason optional reason for aborting the watch
-     */
-    abort: (reason?: string) => void;
-    /**
-     * Get the AbortSignal for the watch.
      *
-     * @returns the AbortSignal
-     */
-    signal: () => AbortSignal;
-};
-/**
- * Configuration for the watch function.
- */
-export type WatchCfg = {
-    /**
-     * The maximum number of times to retry the watch, the retry count is reset on success.
+     * Kubernetes API docs: {@link https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes}
+     *
+     * @param model - the model to use for the API
+     * @param filters - (optional) filter overrides, can also be chained
+     * @param callback - the callback function to call when an event is received
+     * @param watchCfg - (optional) watch configuration
      */
-    retryMax?: number;
+    constructor(model: T, filters: Filters, callback: WatchAction<T>, watchCfg?: WatchCfg);
     /**
-     * The delay between retries in seconds.
+     * Start the watch.
+     *
+     * @returns The AbortController for the watch.
      */
-    retryDelaySec?: number;
+    start(): Promise<AbortController>;
+    /** Close the watch. Also available on the AbortController returned by {@link Watcher.start}. */
+    close(): void;
     /**
-     * A function to log errors.
+     * 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
      */
-    logFn?: LogFn;
+    get id(): string;
     /**
-     * A function to call when the watch fails after the maximum number of retries.
+     * Subscribe to watch events. This is an EventEmitter that emits the following events:
+     *
+     * Use {@link WatchEvent} for the event names.
+     *
+     * @returns an EventEmitter
      */
-    retryFail?: (e: Error) => void;
-};
-/**
- * Execute a watch on the specified resource.
- *
- * @param model - the model to use for the API
- * @param filters - (optional) filter overrides, can also be chained
- * @param callback - the callback function to call when an event is received
- * @param watchCfg - (optional) watch configuration
- * @returns a WatchController to allow the watch to be aborted externally
- */
-export declare function ExecWatch<T extends GenericClass>(model: T, filters: Filters, callback: WatchAction<T>, watchCfg?: WatchCfg): Promise<WatchController>;
+    get events(): EventEmitter;
+}
 //# sourceMappingURL=watch.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":";AAMA,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAG3D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC;;;;OAIG;IACH,MAAM,EAAE,MAAM,WAAW,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;CAChC,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,CAAC,SAAS,YAAY,EACpD,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,QAAQ,GAAE,QAAa,4BAmKxB"}
+{"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"}