kubernetes-fluent-client 0.0.0-development → 1.1.0

package/README.md

@@ -0,0 +1,15 @@
+# Kubernetes Fluent Client for Node
+
+[![Npm package license](https://badgen.net/npm/license/kubernetes-fluent-client)](https://npmjs.com/package/kubernetes-fluent-client)
+[![Known Vulnerabilities](https://snyk.io/test/npm/kubernetes-fluent-client/badge.svg)](https://snyk.io/advisor/npm-package/kubernetes-fluent-client)
+[![Npm package version](https://badgen.net/npm/v/kubernetes-fluent-client)](https://npmjs.com/package/kubernetes-fluent-client)
+[![Npm package total downloads](https://badgen.net/npm/dt/kubernetes-fluent-client)](https://npmjs.com/package/kubernetes-fluent-client)
+
+```typescript
+import { K8s, kind } from "kubernetes-fluent-client";
+
+async function main() {
+  const pods = await K8s(kind.Pod).Get();
+  console.log(pods);
+}
+```

package/__mocks__/@kubernetes/client-node.ts

@@ -0,0 +1,22 @@
+// __mocks__/@kubernetes/client-node.ts
+
+import { jest } from "@jest/globals";
+
+const actual = jest.requireActual("@kubernetes/client-node") as any;
+
+const cloned = { ...actual };
+
+cloned.KubeConfig = class MockedKubeConfig {
+  loadFromDefault = jest.fn();
+
+  applyToFetchOptions = jest.fn(data => data);
+
+  getCurrentCluster() {
+    return {
+      server: "http://jest-test:8080",
+    };
+  }
+};
+
+// export all elements of the mocked module
+module.exports = cloned;

package/dist/fetch.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+import { RequestInfo, RequestInit } from "node-fetch";
+export type FetchResponse<T> = {
+    data: T;
+    ok: boolean;
+    status: number;
+    statusText: string;
+};
+/**
+ * Perform an async HTTP call and return the parsed JSON response, optionally
+ * as a specific type.
+ *
+ * @example
+ * ```ts
+ * fetch<string[]>("https://example.com/api/foo");
+ * ```
+ *
+ * @param url The URL or Request object to fetch
+ * @param init Additional options for the request
+ * @returns
+ */
+export declare function fetch<T>(url: URL | RequestInfo, init?: RequestInit): Promise<FetchResponse<T>>;
+//# sourceMappingURL=fetch.d.ts.map

package/dist/fetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":";AAIA,OAAiB,EAAc,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE5E,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAC7B,IAAI,EAAE,CAAC,CAAC;IACR,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,wBAAsB,KAAK,CAAC,CAAC,EAC3B,GAAG,EAAE,GAAG,GAAG,WAAW,EACtB,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CA0C3B"}

package/dist/fetch.js

@@ -0,0 +1,85 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetch = void 0;
+const http_status_codes_1 = require("http-status-codes");
+const node_fetch_1 = __importStar(require("node-fetch"));
+/**
+ * Perform an async HTTP call and return the parsed JSON response, optionally
+ * as a specific type.
+ *
+ * @example
+ * ```ts
+ * fetch<string[]>("https://example.com/api/foo");
+ * ```
+ *
+ * @param url The URL or Request object to fetch
+ * @param init Additional options for the request
+ * @returns
+ */
+async function fetch(url, init) {
+    let data = undefined;
+    try {
+        const resp = await (0, node_fetch_1.default)(url, init);
+        const contentType = resp.headers.get("content-type") || "";
+        if (resp.ok) {
+            // Parse the response as JSON if the content type is JSON
+            if (contentType.includes("application/json")) {
+                data = await resp.json();
+            }
+            else {
+                // Otherwise, return however the response was read
+                data = (await resp.text());
+            }
+        }
+        return {
+            data,
+            ok: resp.ok,
+            status: resp.status,
+            statusText: resp.statusText,
+        };
+    }
+    catch (e) {
+        if (e instanceof node_fetch_1.FetchError) {
+            // Parse the error code from the FetchError or default to 400 (Bad Request)
+            const status = parseInt(e.code || "400");
+            return {
+                data,
+                ok: false,
+                status,
+                statusText: e.message,
+            };
+        }
+        return {
+            data,
+            ok: false,
+            status: http_status_codes_1.StatusCodes.BAD_REQUEST,
+            statusText: "Unknown error",
+        };
+    }
+}
+exports.fetch = fetch;

package/dist/fetch.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=fetch.test.d.ts.map

package/dist/fetch.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.test.d.ts","sourceRoot":"","sources":["../src/fetch.test.ts"],"names":[],"mappings":""}

package/dist/fetch.test.js

@@ -0,0 +1,97 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const http_status_codes_1 = require("http-status-codes");
+const nock_1 = __importDefault(require("nock"));
+const fetch_1 = require("./fetch");
+(0, globals_1.beforeEach)(() => {
+    (0, nock_1.default)("https://jsonplaceholder.typicode.com")
+        .get("/todos/1")
+        .reply(200, {
+        userId: 1,
+        id: 1,
+        title: "Example title",
+        completed: false,
+    })
+        .post("/todos", {
+        title: "test todo",
+        userId: 1,
+        completed: false,
+    })
+        .reply(200, (uri, requestBody) => requestBody)
+        .get("/todos/empty-null")
+        .reply(200, undefined)
+        .get("/todos/empty-string")
+        .reply(200, "")
+        .get("/todos/empty-object")
+        .reply(200, {})
+        .get("/todos/invalid")
+        .replyWithError("Something bad happened");
+});
+(0, globals_1.test)("fetch: should return without type data", async () => {
+    const url = "https://jsonplaceholder.typicode.com/todos/1";
+    const { data, ok } = await (0, fetch_1.fetch)(url);
+    (0, globals_1.expect)(ok).toBe(true);
+    (0, globals_1.expect)(data["title"]).toBe("Example title");
+});
+(0, globals_1.test)("fetch: should return parsed JSON response as a specific type", async () => {
+    const url = "https://jsonplaceholder.typicode.com/todos/1";
+    const { data, ok } = await (0, fetch_1.fetch)(url);
+    (0, globals_1.expect)(ok).toBe(true);
+    (0, globals_1.expect)(data.id).toBe(1);
+    (0, globals_1.expect)(typeof data.title).toBe("string");
+    (0, globals_1.expect)(typeof data.completed).toBe("boolean");
+});
+(0, globals_1.test)("fetch: should handle additional request options", async () => {
+    const url = "https://jsonplaceholder.typicode.com/todos";
+    const requestOptions = {
+        method: "POST",
+        body: JSON.stringify({
+            title: "test todo",
+            userId: 1,
+            completed: false,
+        }),
+        headers: {
+            "Content-type": "application/json; charset=UTF-8",
+        },
+    };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const { data, ok } = await (0, fetch_1.fetch)(url, requestOptions);
+    (0, globals_1.expect)(ok).toBe(true);
+    (0, globals_1.expect)(data["title"]).toBe("test todo");
+    (0, globals_1.expect)(data["userId"]).toBe(1);
+    (0, globals_1.expect)(data["completed"]).toBe(false);
+});
+(0, globals_1.test)("fetch: should handle empty (null) responses", async () => {
+    const url = "https://jsonplaceholder.typicode.com/todos/empty-null";
+    const resp = await (0, fetch_1.fetch)(url);
+    (0, globals_1.expect)(resp.data).toBe("");
+    (0, globals_1.expect)(resp.ok).toBe(true);
+    (0, globals_1.expect)(resp.status).toBe(http_status_codes_1.StatusCodes.OK);
+});
+(0, globals_1.test)("fetch: should handle empty (string) responses", async () => {
+    const url = "https://jsonplaceholder.typicode.com/todos/empty-string";
+    const resp = await (0, fetch_1.fetch)(url);
+    (0, globals_1.expect)(resp.data).toBe("");
+    (0, globals_1.expect)(resp.ok).toBe(true);
+    (0, globals_1.expect)(resp.status).toBe(http_status_codes_1.StatusCodes.OK);
+});
+(0, globals_1.test)("fetch: should handle empty (object) responses", async () => {
+    const url = "https://jsonplaceholder.typicode.com/todos/empty-object";
+    const resp = await (0, fetch_1.fetch)(url);
+    (0, globals_1.expect)(resp.data).toEqual({});
+    (0, globals_1.expect)(resp.ok).toBe(true);
+    (0, globals_1.expect)(resp.status).toBe(http_status_codes_1.StatusCodes.OK);
+});
+(0, globals_1.test)("fetch: should handle failed requests without throwing an error", async () => {
+    const url = "https://jsonplaceholder.typicode.com/todos/invalid";
+    const resp = await (0, fetch_1.fetch)(url);
+    (0, globals_1.expect)(resp.data).toBe(undefined);
+    (0, globals_1.expect)(resp.ok).toBe(false);
+    (0, globals_1.expect)(resp.status).toBe(http_status_codes_1.StatusCodes.BAD_REQUEST);
+});

package/dist/fluent/index.d.ts

@@ -0,0 +1,11 @@
+import { KubernetesObject } from "@kubernetes/client-node";
+import { GenericClass } from "../types";
+import { Filters, K8sInit } from "./types";
+/**
+ * Kubernetes fluent API inspired by Kubectl. Pass in a model, then call filters and actions on it.
+ *
+ * @param model - the model to use for the API
+ * @param filters - (optional) filter overrides, can also be chained
+ */
+export declare function K8s<T extends GenericClass, K extends KubernetesObject = InstanceType<T>>(model: T, filters?: Filters): K8sInit<K>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fluent/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAwB,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAKjF,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAsB,MAAM,SAAS,CAAC;AAI/D;;;;;GAKG;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,CAuGZ"}

package/dist/fluent/index.js

@@ -0,0 +1,100 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.K8s = void 0;
+const http_status_codes_1 = require("http-status-codes");
+const kinds_1 = require("../kinds");
+const utils_1 = require("./utils");
+const watch_1 = require("./watch");
+/**
+ * Kubernetes fluent API inspired by Kubectl. Pass in a model, then call filters and actions on it.
+ *
+ * @param model - the model to use for the API
+ * @param filters - (optional) filter overrides, can also be chained
+ */
+function K8s(model, filters = {}) {
+    const withFilters = { WithField, WithLabel, Get, Delete, Watch };
+    const matchedKind = filters.kindOverride || (0, kinds_1.modelToGroupVersionKind)(model.name);
+    function InNamespace(namespaces) {
+        if (filters.namespace) {
+            throw new Error(`Namespace already specified: ${filters.namespace}`);
+        }
+        filters.namespace = namespaces;
+        return withFilters;
+    }
+    function WithField(key, value = "") {
+        filters.fields = filters.fields || {};
+        filters.fields[key] = value;
+        return withFilters;
+    }
+    function WithLabel(key, value = "") {
+        filters.labels = filters.labels || {};
+        filters.labels[key] = value;
+        return withFilters;
+    }
+    function syncFilters(payload) {
+        // Ensure the payload has metadata
+        payload.metadata = payload.metadata || {};
+        if (!filters.namespace) {
+            filters.namespace = payload.metadata.namespace;
+        }
+        if (!filters.name) {
+            filters.name = payload.metadata.name;
+        }
+        if (!payload.apiVersion) {
+            payload.apiVersion = [matchedKind.group, matchedKind.version].filter(Boolean).join("/");
+        }
+        if (!payload.kind) {
+            payload.kind = matchedKind.kind;
+        }
+    }
+    async function Get(name) {
+        if (name) {
+            if (filters.name) {
+                throw new Error(`Name already specified: ${filters.name}`);
+            }
+            filters.name = name;
+        }
+        return (0, utils_1.k8sExec)(model, filters, "GET");
+    }
+    async function Delete(filter) {
+        if (typeof filter === "string") {
+            filters.name = filter;
+        }
+        else if (filter) {
+            syncFilters(filter);
+        }
+        try {
+            // Try to delete the resource
+            await (0, utils_1.k8sExec)(model, filters, "DELETE");
+        }
+        catch (e) {
+            // If the resource doesn't exist, ignore the error
+            if (e.status === http_status_codes_1.StatusCodes.NOT_FOUND) {
+                return;
+            }
+            throw e;
+        }
+    }
+    async function Apply(resource) {
+        syncFilters(resource);
+        return (0, utils_1.k8sExec)(model, filters, "APPLY", resource);
+    }
+    async function Create(resource) {
+        syncFilters(resource);
+        return (0, utils_1.k8sExec)(model, filters, "POST", resource);
+    }
+    async function Patch(payload) {
+        // If there are no operations, throw an error
+        if (payload.length < 1) {
+            throw new Error("No operations specified");
+        }
+        return (0, utils_1.k8sExec)(model, filters, "PATCH", payload);
+    }
+    async function Watch(callback) {
+        await (0, watch_1.ExecWatch)(model, filters, callback);
+    }
+    return { InNamespace, Apply, Create, Patch, ...withFilters };
+}
+exports.K8s = K8s;

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/fluent/index.test.ts"],"names":[],"mappings":""}

package/dist/fluent/index.test.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const upstream_1 = require("../upstream");
+const _1 = require(".");
+const utils_1 = require("./utils");
+// Setup mocks
+globals_1.jest.mock("./utils");
+(0, globals_1.describe)("Kube", () => {
+    const fakeResource = { metadata: { name: "fake", namespace: "default" } };
+    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:
+        mockedKubeExec.mockClear();
+    });
+    (0, globals_1.it)("should create a resource", async () => {
+        const kube = (0, _1.K8s)(upstream_1.Pod);
+        const result = await kube.Create(fakeResource);
+        (0, globals_1.expect)(result).toEqual(fakeResource);
+        (0, globals_1.expect)(mockedKubeExec).toHaveBeenCalledWith(upstream_1.Pod, globals_1.expect.objectContaining({
+            name: "fake",
+            namespace: "default",
+        }), "POST", fakeResource);
+    });
+    (0, globals_1.it)("should delete a resource", async () => {
+        const kube = (0, _1.K8s)(upstream_1.Pod);
+        await kube.Delete(fakeResource);
+        (0, globals_1.expect)(mockedKubeExec).toHaveBeenCalledWith(upstream_1.Pod, globals_1.expect.objectContaining({
+            name: "fake",
+            namespace: "default",
+        }), "DELETE");
+    });
+    (0, globals_1.it)("should patch a resource", async () => {
+        const patchOperations = [
+            { op: "replace", path: "/metadata/name", value: "new-fake" },
+        ];
+        const kube = (0, _1.K8s)(upstream_1.Pod);
+        const result = await kube.Patch(patchOperations);
+        (0, globals_1.expect)(result).toEqual(fakeResource);
+        (0, globals_1.expect)(mockedKubeExec).toHaveBeenCalledWith(upstream_1.Pod, {}, "PATCH", patchOperations);
+    });
+    (0, globals_1.it)("should filter with WithField", async () => {
+        const kube = (0, _1.K8s)(upstream_1.Pod).WithField("metadata.name", "fake");
+        await kube.Get();
+        (0, globals_1.expect)(mockedKubeExec).toHaveBeenCalledWith(upstream_1.Pod, globals_1.expect.objectContaining({
+            fields: {
+                "metadata.name": "fake",
+            },
+        }), "GET");
+    });
+    (0, globals_1.it)("should filter with WithLabel", async () => {
+        const kube = (0, _1.K8s)(upstream_1.Pod).WithLabel("app", "fakeApp");
+        await kube.Get();
+        (0, globals_1.expect)(mockedKubeExec).toHaveBeenCalledWith(upstream_1.Pod, globals_1.expect.objectContaining({
+            labels: {
+                app: "fakeApp",
+            },
+        }), "GET");
+    });
+    (0, globals_1.it)("should use InNamespace", async () => {
+        const kube = (0, _1.K8s)(upstream_1.Pod).InNamespace("fakeNamespace");
+        await kube.Get();
+        (0, globals_1.expect)(mockedKubeExec).toHaveBeenCalledWith(upstream_1.Pod, globals_1.expect.objectContaining({
+            namespace: "fakeNamespace",
+        }), "GET");
+    });
+    (0, globals_1.it)("should throw an error if namespace is already specified", async () => {
+        const kube = (0, _1.K8s)(upstream_1.Pod, { namespace: "default" });
+        (0, globals_1.expect)(() => kube.InNamespace("fakeNamespace")).toThrow("Namespace already specified: default");
+    });
+    (0, globals_1.it)("should handle Delete when the resource doesn't exist", async () => {
+        mockedKubeExec.mockRejectedValueOnce({ status: 404 }); // Not Found on first call
+        const kube = (0, _1.K8s)(upstream_1.Pod);
+        await (0, globals_1.expect)(kube.Delete("fakeResource")).resolves.toBeUndefined();
+    });
+    (0, globals_1.it)("should handle Get", async () => {
+        const kube = (0, _1.K8s)(upstream_1.Pod);
+        const result = await kube.Get("fakeResource");
+        (0, globals_1.expect)(result).toEqual(fakeResource);
+        (0, globals_1.expect)(mockedKubeExec).toHaveBeenCalledWith(upstream_1.Pod, globals_1.expect.objectContaining({
+            name: "fakeResource",
+        }), "GET");
+    });
+    (0, globals_1.it)("should thrown an error if Get is called with a name and filters are already specified a name", async () => {
+        const kube = (0, _1.K8s)(upstream_1.Pod, { name: "fake" });
+        await (0, globals_1.expect)(kube.Get("fakeResource")).rejects.toThrow("Name already specified: fake");
+    });
+    (0, globals_1.it)("should throw an error if no patch operations provided", async () => {
+        const kube = (0, _1.K8s)(upstream_1.Pod);
+        await (0, globals_1.expect)(kube.Patch([])).rejects.toThrow("No operations specified");
+    });
+});

package/dist/fluent/types.d.ts

@@ -0,0 +1,121 @@
+import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
+import { Operation } from "fast-json-patch";
+import { GenericClass, GroupVersionKind } from "../types";
+/**
+ * The Phase matched when using the K8s Watch API.
+ */
+export declare enum WatchPhase {
+    Added = "ADDED",
+    Modified = "MODIFIED",
+    Deleted = "DELETED"
+}
+export type FetchMethods = "GET" | "APPLY" | "POST" | "PUT" | "DELETE" | "PATCH" | "WATCH";
+export interface Filters {
+    kindOverride?: GroupVersionKind;
+    fields?: Record<string, string>;
+    labels?: Record<string, string>;
+    name?: string;
+    namespace?: string;
+}
+export type GetFunction<K extends KubernetesObject> = {
+    (): Promise<KubernetesListObject<K>>;
+    (name: string): Promise<K>;
+};
+export type K8sFilteredActions<K extends KubernetesObject> = {
+    /**
+     * Get the resource or resources matching the filters.
+     * If no filters are specified, all resources will be returned.
+     * If a name is specified, only a single resource will be returned.
+     */
+    Get: GetFunction<K>;
+    /**
+     * Delete the resource if it exists.
+     *
+     * @param filter - the resource or resource name to delete
+     */
+    Delete: (filter?: K | string) => Promise<void>;
+    /**
+     *
+     * @param callback
+     * @returns
+     */
+    Watch: (callback: (payload: K, phase: WatchPhase) => void) => Promise<void>;
+};
+export type K8sUnfilteredActions<K extends KubernetesObject> = {
+    /**
+     * Perform a server-side apply of the provided K8s resource.
+     *
+     * @param resource
+     * @returns
+     */
+    Apply: (resource: K) => Promise<K>;
+    /**
+     * Create the provided K8s resource or throw an error if it already exists.
+     *
+     * @param resource
+     * @returns
+     */
+    Create: (resource: K) => Promise<K>;
+    /**
+     * Advanced JSON Patch operations for when Server Side Apply, Kube().Apply(), is insufficient.
+     *
+     * Note: Throws an error on an empty list of patch operations.
+     *
+     * @param payload The patch operations to run
+     * @returns The patched resource
+     */
+    Patch: (payload: Operation[]) => Promise<K>;
+};
+export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> & {
+    /**
+     * Filter the query by the given field.
+     * Note multiple calls to this method will result in an AND condition. e.g.
+     *
+     * ```ts
+     * Kube(given.Deployment)
+     *  .WithField("metadata.name", "bar")
+     *  .WithField("metadata.namespace", "qux")
+     *  .Delete(...)
+     * ```
+     *
+     * Will only delete the Deployment if it has the `metadata.name=bar` and `metadata.namespace=qux` fields.
+     *
+     * @param key  The field key
+     * @param value The field value
+     * @returns
+     */
+    WithField: <P extends Paths<K>>(key: P, value?: string) => K8sWithFilters<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.
+     *
+     * ```ts
+     * Kube(given.Deployment)
+     *   .WithLabel("foo", "bar")
+     *   .WithLabel("baz", "qux")
+     *   .Delete(...)
+     * ```
+     *
+     * Will only delete the Deployment if it has the`foo=bar` and `baz=qux` labels.
+     *
+     * @param key The label key
+     * @param value (optional) The label value
+     */
+    WithLabel: (key: string, value?: string) => K8sWithFilters<K>;
+};
+export type K8sInit<K extends KubernetesObject> = K8sWithFilters<K> & K8sUnfilteredActions<K> & {
+    /**
+     * Filter the query by the given namespace.
+     *
+     * @param namespace
+     * @returns
+     */
+    InNamespace: (namespace: string) => K8sWithFilters<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;
+export type Paths<T, D extends number = 10> = [D] extends [never] ? never : T extends object ? {
+    [K in keyof T]-?: K extends string | number ? `${K}` | Join<K, Paths<T[K]>> : never;
+}[keyof T] : "";
+export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +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;AAG5C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE1D;;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,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;;;;OAIG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,UAAU,KAAK,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7E,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,IAAI;IAC7D;;;;;OAKG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAEnC;;;;;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;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,CAAC,CAAC;IAE7E;;;;;;;;;;;;;;;OAeG;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,GAChB;KAAG,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;CAAE,CAAC,MAAM,CAAC,CAAC,GAChG,EAAE,CAAC"}

package/dist/fluent/types.js

@@ -0,0 +1,14 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WatchPhase = void 0;
+/**
+ * The Phase matched when using the K8s Watch API.
+ */
+var WatchPhase;
+(function (WatchPhase) {
+    WatchPhase["Added"] = "ADDED";
+    WatchPhase["Modified"] = "MODIFIED";
+    WatchPhase["Deleted"] = "DELETED";
+})(WatchPhase || (exports.WatchPhase = WatchPhase = {}));

package/dist/fluent/utils.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="node" />
+import { URL } from "url";
+import { GenericClass } from "../types";
+import { FetchMethods, Filters } from "./types";
+/**
+ * Generate a path to a Kubernetes resource
+ *
+ * @param serverUrl
+ * @param model
+ * @param filters
+ * @param excludeName
+ * @returns
+ */
+export declare function pathBuilder<T extends GenericClass>(serverUrl: string, model: T, filters: Filters, excludeName?: boolean): URL;
+/**
+ * Sets up the kubeconfig and https agent for a request
+ *
+ * A few notes:
+ * - The kubeconfig is loaded from the default location, and can check for in-cluster config
+ * - We have to create an agent to handle the TLS connection (for the custom CA + mTLS in some cases)
+ * - The K8s lib uses request instead of node-fetch today so the object is slightly different
+ *
+ * @param method
+ * @returns
+ */
+export declare function k8sCfg(method: FetchMethods): Promise<{
+    opts: import("node-fetch").RequestInit;
+    serverUrl: string;
+}>;
+export declare function k8sExec<T extends GenericClass, K>(model: T, filters: Filters, method: FetchMethods, payload?: K | unknown): Promise<K>;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +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;AAIhD;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,YAAY,EAChD,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,WAAW,UAAQ,OAsDpB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,MAAM,CAAC,MAAM,EAAE,YAAY;;;GAqBhD;AAED,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,cA8BtB"}