kubernetes-fluent-client 1.0.0 → 1.1.0

package/README.md

@@ -6,10 +6,10 @@
 [![Npm package total downloads](https://badgen.net/npm/dt/kubernetes-fluent-client)](https://npmjs.com/package/kubernetes-fluent-client)
 
 ```typescript
-import { Kube } from "kubernetes-fluent-client";
+import { K8s, kind } from "kubernetes-fluent-client";
 
 async function main() {
-  const pods = await Kube(kind.Pod).Get();
+  const pods = await K8s(kind.Pod).Get();
   console.log(pods);
 }
 ```

package/dist/fluent/{kube.d.ts → index.d.ts}

@@ -1,11 +1,11 @@
 import { KubernetesObject } from "@kubernetes/client-node";
 import { GenericClass } from "../types";
-import { Filters, KubeInit } 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 Kube<T extends GenericClass, K extends KubernetesObject = InstanceType<T>>(model: T, filters?: Filters): KubeInit<K>;
-//# sourceMappingURL=kube.d.ts.map
+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/{kube.js → index.js}

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Kube = void 0;
+exports.K8s = void 0;
 const http_status_codes_1 = require("http-status-codes");
 const kinds_1 = require("../kinds");
 const utils_1 = require("./utils");
@@ -13,7 +13,7 @@ const watch_1 = require("./watch");
  * @param model - the model to use for the API
  * @param filters - (optional) filter overrides, can also be chained
  */
-function Kube(model, filters = {}) {
+function K8s(model, filters = {}) {
     const withFilters = { WithField, WithLabel, Get, Delete, Watch };
     const matchedKind = filters.kindOverride || (0, kinds_1.modelToGroupVersionKind)(model.name);
     function InNamespace(namespaces) {
@@ -56,7 +56,7 @@ function Kube(model, filters = {}) {
             }
             filters.name = name;
         }
-        return (0, utils_1.kubeExec)(model, filters, "GET");
+        return (0, utils_1.k8sExec)(model, filters, "GET");
     }
     async function Delete(filter) {
         if (typeof filter === "string") {
@@ -67,7 +67,7 @@ function Kube(model, filters = {}) {
         }
         try {
             // Try to delete the resource
-            await (0, utils_1.kubeExec)(model, filters, "DELETE");
+            await (0, utils_1.k8sExec)(model, filters, "DELETE");
         }
         catch (e) {
             // If the resource doesn't exist, ignore the error
@@ -79,22 +79,22 @@ function Kube(model, filters = {}) {
     }
     async function Apply(resource) {
         syncFilters(resource);
-        return (0, utils_1.kubeExec)(model, filters, "APPLY", resource);
+        return (0, utils_1.k8sExec)(model, filters, "APPLY", resource);
     }
     async function Create(resource) {
         syncFilters(resource);
-        return (0, utils_1.kubeExec)(model, filters, "POST", 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.kubeExec)(model, filters, "PATCH", payload);
+        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.Kube = Kube;
+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/{kube.test.js → index.test.js}

@@ -2,19 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const globals_1 = require("@jest/globals");
 const upstream_1 = require("../upstream");
-const kube_1 = require("./kube");
+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.kubeExec).mockResolvedValue(fakeResource);
+    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, kube_1.Kube)(upstream_1.Pod);
+        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({
@@ -23,7 +23,7 @@ globals_1.jest.mock("./utils");
         }), "POST", fakeResource);
     });
     (0, globals_1.it)("should delete a resource", async () => {
-        const kube = (0, kube_1.Kube)(upstream_1.Pod);
+        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",
@@ -34,13 +34,13 @@ globals_1.jest.mock("./utils");
         const patchOperations = [
             { op: "replace", path: "/metadata/name", value: "new-fake" },
         ];
-        const kube = (0, kube_1.Kube)(upstream_1.Pod);
+        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, kube_1.Kube)(upstream_1.Pod).WithField("metadata.name", "fake");
+        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: {
@@ -49,7 +49,7 @@ globals_1.jest.mock("./utils");
         }), "GET");
     });
     (0, globals_1.it)("should filter with WithLabel", async () => {
-        const kube = (0, kube_1.Kube)(upstream_1.Pod).WithLabel("app", "fakeApp");
+        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: {
@@ -58,23 +58,23 @@ globals_1.jest.mock("./utils");
         }), "GET");
     });
     (0, globals_1.it)("should use InNamespace", async () => {
-        const kube = (0, kube_1.Kube)(upstream_1.Pod).InNamespace("fakeNamespace");
+        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, kube_1.Kube)(upstream_1.Pod, { namespace: "default" });
+        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, kube_1.Kube)(upstream_1.Pod);
+        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, kube_1.Kube)(upstream_1.Pod);
+        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({
@@ -82,11 +82,11 @@ globals_1.jest.mock("./utils");
         }), "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, kube_1.Kube)(upstream_1.Pod, { name: "fake" });
+        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, kube_1.Kube)(upstream_1.Pod);
+        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

@@ -21,7 +21,7 @@ export type GetFunction<K extends KubernetesObject> = {
     (): Promise<KubernetesListObject<K>>;
     (name: string): Promise<K>;
 };
-export type KubeFilteredActions<K extends KubernetesObject> = {
+export type K8sFilteredActions<K extends KubernetesObject> = {
     /**
      * Get the resource or resources matching the filters.
      * If no filters are specified, all resources will be returned.
@@ -41,7 +41,7 @@ export type KubeFilteredActions<K extends KubernetesObject> = {
      */
     Watch: (callback: (payload: K, phase: WatchPhase) => void) => Promise<void>;
 };
-export type KubeUnfilteredActions<K extends KubernetesObject> = {
+export type K8sUnfilteredActions<K extends KubernetesObject> = {
     /**
      * Perform a server-side apply of the provided K8s resource.
      *
@@ -66,7 +66,7 @@ export type KubeUnfilteredActions<K extends KubernetesObject> = {
      */
     Patch: (payload: Operation[]) => Promise<K>;
 };
-export type KubeWithFilters<K extends KubernetesObject> = KubeFilteredActions<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.
@@ -84,7 +84,7 @@ export type KubeWithFilters<K extends KubernetesObject> = KubeFilteredActions<K>
      * @param value The field value
      * @returns
      */
-    WithField: <P extends Paths<K>>(key: P, value?: string) => KubeWithFilters<K>;
+    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.
@@ -101,16 +101,16 @@ export type KubeWithFilters<K extends KubernetesObject> = KubeFilteredActions<K>
      * @param key The label key
      * @param value (optional) The label value
      */
-    WithLabel: (key: string, value?: string) => KubeWithFilters<K>;
+    WithLabel: (key: string, value?: string) => K8sWithFilters<K>;
 };
-export type KubeInit<K extends KubernetesObject> = KubeWithFilters<K> & KubeUnfilteredActions<K> & {
+export type K8sInit<K extends KubernetesObject> = K8sWithFilters<K> & K8sUnfilteredActions<K> & {
     /**
      * Filter the query by the given namespace.
      *
      * @param namespace
      * @returns
      */
-    InNamespace: (namespace: string) => KubeWithFilters<K>;
+    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;

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;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,mBAAmB,CAAC,CAAC,SAAS,gBAAgB,IAAI;IAC5D;;;;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,qBAAqB,CAAC,CAAC,SAAS,gBAAgB,IAAI;IAC9D;;;;;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,eAAe,CAAC,CAAC,SAAS,gBAAgB,IAAI,mBAAmB,CAAC,CAAC,CAAC,GAAG;IACjF;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC;IAE9E;;;;;;;;;;;;;;;OAeG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC;CAChE,CAAC;AAEF,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,gBAAgB,IAAI,eAAe,CAAC,CAAC,CAAC,GACnE,qBAAqB,CAAC,CAAC,CAAC,GAAG;IACzB;;;;;OAKG;IACH,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC;CACxD,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"}
+{"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/utils.d.ts

@@ -23,9 +23,9 @@ export declare function pathBuilder<T extends GenericClass>(serverUrl: string, m
  * @param method
  * @returns
  */
-export declare function kubeCfg(method: FetchMethods): Promise<{
+export declare function k8sCfg(method: FetchMethods): Promise<{
     opts: import("node-fetch").RequestInit;
     serverUrl: string;
 }>;
-export declare function kubeExec<T extends GenericClass, K>(model: T, filters: Filters, method: FetchMethods, payload?: K | unknown): Promise<K>;
+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

@@ -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;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,OAAO,CAAC,MAAM,EAAE,YAAY;;;GAqBjD;AAED,wBAAsB,QAAQ,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,EACtD,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,cA8BtB"}
+{"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"}

package/dist/fluent/utils.js

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.kubeExec = exports.kubeCfg = exports.pathBuilder = void 0;
+exports.k8sExec = exports.k8sCfg = exports.pathBuilder = void 0;
 const client_node_1 = require("@kubernetes/client-node");
 const url_1 = require("url");
 const fetch_1 = require("../fetch");
@@ -69,7 +69,7 @@ exports.pathBuilder = pathBuilder;
  * @param method
  * @returns
  */
-async function kubeCfg(method) {
+async function k8sCfg(method) {
     const kubeConfig = new client_node_1.KubeConfig();
     kubeConfig.loadFromDefault();
     const cluster = kubeConfig.getCurrentCluster();
@@ -88,9 +88,9 @@ async function kubeCfg(method) {
     });
     return { opts, serverUrl: cluster.server };
 }
-exports.kubeCfg = kubeCfg;
-async function kubeExec(model, filters, method, payload) {
-    const { opts, serverUrl } = await kubeCfg(method);
+exports.k8sCfg = k8sCfg;
+async function k8sExec(model, filters, method, payload) {
+    const { opts, serverUrl } = await k8sCfg(method);
     const url = pathBuilder(serverUrl, model, filters, method === "POST");
     switch (opts.method) {
         case "PATCH":
@@ -113,4 +113,4 @@ async function kubeExec(model, filters, method, payload) {
     }
     throw resp;
 }
-exports.kubeExec = kubeExec;
+exports.k8sExec = k8sExec;

package/dist/fluent/utils.test.js

@@ -67,7 +67,7 @@ globals_1.jest.mock("../fetch");
             status: 200,
             statusText: "OK",
         });
-        const result = await (0, utils_1.kubeExec)(upstream_1.Pod, fakeFilters, fakeMethod, fakePayload);
+        const result = await (0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, fakeMethod, fakePayload);
         (0, globals_1.expect)(result).toEqual(fakePayload);
         (0, globals_1.expect)(mockedFetch).toHaveBeenCalledWith(fakeUrl, globals_1.expect.objectContaining(fakeOpts));
     });
@@ -80,7 +80,7 @@ globals_1.jest.mock("../fetch");
             status: fakeStatus,
             statusText: fakeStatusText,
         });
-        await (0, globals_1.expect)((0, utils_1.kubeExec)(upstream_1.Pod, fakeFilters, fakeMethod, fakePayload)).rejects.toEqual(globals_1.expect.objectContaining({
+        await (0, globals_1.expect)((0, utils_1.k8sExec)(upstream_1.Pod, fakeFilters, fakeMethod, fakePayload)).rejects.toEqual(globals_1.expect.objectContaining({
             status: fakeStatus,
             statusText: fakeStatusText,
         }));

package/dist/fluent/watch.js

@@ -14,7 +14,7 @@ const utils_1 = require("./utils");
  */
 async function ExecWatch(model, filters, callback) {
     // Build the path and query params for the resource, excluding the name
-    const { opts, serverUrl } = await (0, utils_1.kubeCfg)("GET");
+    const { opts, serverUrl } = await (0, utils_1.k8sCfg)("GET");
     const url = (0, utils_1.pathBuilder)(serverUrl, model, filters, true);
     // Enable the watch query param
     url.searchParams.set("watch", "true");

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import * as kind from "./upstream";
-/** given is a collection of K8s types to be used within a Kube call: `Kube(kind.Secret).Apply({})`. `a` may also be used in it's place */
+/** kind is a collection of K8s types to be used within a K8s call: `K8s(kind.Secret).Apply({})`. */
 export { kind };
 export { fetch } from "./fetch";
-export { Kube } from "./fluent/kube";
-export { modelToGroupVersionKind, RegisterKind } from "./kinds";
+export { K8s } from "./fluent";
+export { RegisterKind, modelToGroupVersionKind } from "./kinds";
 export * from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,0IAA0I;AAC1I,OAAO,EAAE,IAAI,EAAE,CAAC;AAGhB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAGrC,OAAO,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEhE,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,oGAAoG;AACpG,OAAO,EAAE,IAAI,EAAE,CAAC;AAGhB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAEhE,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -28,7 +28,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegisterKind = exports.modelToGroupVersionKind = exports.Kube = exports.fetch = exports.kind = void 0;
+exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.fetch = exports.kind = void 0;
 // Export kinds as a single object
 const kind = __importStar(require("./upstream"));
 exports.kind = kind;
@@ -36,10 +36,10 @@ exports.kind = kind;
 var fetch_1 = require("./fetch");
 Object.defineProperty(exports, "fetch", { enumerable: true, get: function () { return fetch_1.fetch; } });
 // Export the fluent API entrypoint
-var kube_1 = require("./fluent/kube");
-Object.defineProperty(exports, "Kube", { enumerable: true, get: function () { return kube_1.Kube; } });
+var fluent_1 = require("./fluent");
+Object.defineProperty(exports, "K8s", { enumerable: true, get: function () { return fluent_1.K8s; } });
 // Export helpers for working with K8s types
 var kinds_1 = require("./kinds");
-Object.defineProperty(exports, "modelToGroupVersionKind", { enumerable: true, get: function () { return kinds_1.modelToGroupVersionKind; } });
 Object.defineProperty(exports, "RegisterKind", { enumerable: true, get: function () { return kinds_1.RegisterKind; } });
+Object.defineProperty(exports, "modelToGroupVersionKind", { enumerable: true, get: function () { return kinds_1.modelToGroupVersionKind; } });
 __exportStar(require("./types"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/fluent/{kube.test.ts → index.test.ts}

@@ -2,15 +2,15 @@ import { beforeEach, describe, expect, it, jest } from "@jest/globals";
 import { Operation } from "fast-json-patch";
 
 import { Pod } from "../upstream";
-import { Kube } from "./kube";
-import { kubeExec } from "./utils";
+import { K8s } from ".";
+import { k8sExec } from "./utils";
 
 // Setup mocks
 jest.mock("./utils");
 
 describe("Kube", () => {
   const fakeResource = { metadata: { name: "fake", namespace: "default" } };
-  const mockedKubeExec = jest.mocked(kubeExec).mockResolvedValue(fakeResource);
+  const mockedKubeExec = jest.mocked(k8sExec).mockResolvedValue(fakeResource);
 
   beforeEach(() => {
     // Clear all instances and calls to constructor and all methods:
@@ -18,7 +18,7 @@ describe("Kube", () => {
   });
 
   it("should create a resource", async () => {
-    const kube = Kube(Pod);
+    const kube = K8s(Pod);
     const result = await kube.Create(fakeResource);
 
     expect(result).toEqual(fakeResource);
@@ -34,7 +34,7 @@ describe("Kube", () => {
   });
 
   it("should delete a resource", async () => {
-    const kube = Kube(Pod);
+    const kube = K8s(Pod);
     await kube.Delete(fakeResource);
 
     expect(mockedKubeExec).toHaveBeenCalledWith(
@@ -52,7 +52,7 @@ describe("Kube", () => {
       { op: "replace", path: "/metadata/name", value: "new-fake" },
     ];
 
-    const kube = Kube(Pod);
+    const kube = K8s(Pod);
     const result = await kube.Patch(patchOperations);
 
     expect(result).toEqual(fakeResource);
@@ -60,7 +60,7 @@ describe("Kube", () => {
   });
 
   it("should filter with WithField", async () => {
-    const kube = Kube(Pod).WithField("metadata.name", "fake");
+    const kube = K8s(Pod).WithField("metadata.name", "fake");
     await kube.Get();
     expect(mockedKubeExec).toHaveBeenCalledWith(
       Pod,
@@ -74,7 +74,7 @@ describe("Kube", () => {
   });
 
   it("should filter with WithLabel", async () => {
-    const kube = Kube(Pod).WithLabel("app", "fakeApp");
+    const kube = K8s(Pod).WithLabel("app", "fakeApp");
     await kube.Get();
     expect(mockedKubeExec).toHaveBeenCalledWith(
       Pod,
@@ -88,7 +88,7 @@ describe("Kube", () => {
   });
 
   it("should use InNamespace", async () => {
-    const kube = Kube(Pod).InNamespace("fakeNamespace");
+    const kube = K8s(Pod).InNamespace("fakeNamespace");
     await kube.Get();
     expect(mockedKubeExec).toHaveBeenCalledWith(
       Pod,
@@ -100,18 +100,18 @@ describe("Kube", () => {
   });
 
   it("should throw an error if namespace is already specified", async () => {
-    const kube = Kube(Pod, { namespace: "default" });
+    const kube = K8s(Pod, { namespace: "default" });
     expect(() => kube.InNamespace("fakeNamespace")).toThrow("Namespace already specified: default");
   });
 
   it("should handle Delete when the resource doesn't exist", async () => {
     mockedKubeExec.mockRejectedValueOnce({ status: 404 }); // Not Found on first call
-    const kube = Kube(Pod);
+    const kube = K8s(Pod);
     await expect(kube.Delete("fakeResource")).resolves.toBeUndefined();
   });
 
   it("should handle Get", async () => {
-    const kube = Kube(Pod);
+    const kube = K8s(Pod);
     const result = await kube.Get("fakeResource");
 
     expect(result).toEqual(fakeResource);
@@ -125,12 +125,12 @@ describe("Kube", () => {
   });
 
   it("should thrown an error if Get is called with a name and filters are already specified a name", async () => {
-    const kube = Kube(Pod, { name: "fake" });
+    const kube = K8s(Pod, { name: "fake" });
     await expect(kube.Get("fakeResource")).rejects.toThrow("Name already specified: fake");
   });
 
   it("should throw an error if no patch operations provided", async () => {
-    const kube = Kube(Pod);
+    const kube = K8s(Pod);
     await expect(kube.Patch([])).rejects.toThrow("No operations specified");
   });
 });

package/src/fluent/{kube.ts → index.ts}

@@ -7,8 +7,8 @@ import { StatusCodes } from "http-status-codes";
 
 import { modelToGroupVersionKind } from "../kinds";
 import { GenericClass } from "../types";
-import { Filters, KubeInit, Paths, WatchAction } from "./types";
-import { kubeExec } from "./utils";
+import { Filters, K8sInit, Paths, WatchAction } from "./types";
+import { k8sExec } from "./utils";
 import { ExecWatch } from "./watch";
 
 /**
@@ -17,10 +17,10 @@ import { ExecWatch } from "./watch";
  * @param model - the model to use for the API
  * @param filters - (optional) filter overrides, can also be chained
  */
-export function Kube<T extends GenericClass, K extends KubernetesObject = InstanceType<T>>(
+export function K8s<T extends GenericClass, K extends KubernetesObject = InstanceType<T>>(
   model: T,
   filters: Filters = {},
-): KubeInit<K> {
+): K8sInit<K> {
   const withFilters = { WithField, WithLabel, Get, Delete, Watch };
   const matchedKind = filters.kindOverride || modelToGroupVersionKind(model.name);
 
@@ -76,7 +76,7 @@ export function Kube<T extends GenericClass, K extends KubernetesObject = Instan
       filters.name = name;
     }
 
-    return kubeExec<T, K | KubernetesListObject<K>>(model, filters, "GET");
+    return k8sExec<T, K | KubernetesListObject<K>>(model, filters, "GET");
   }
 
   async function Delete(filter?: K | string): Promise<void> {
@@ -88,7 +88,7 @@ export function Kube<T extends GenericClass, K extends KubernetesObject = Instan
 
     try {
       // Try to delete the resource
-      await kubeExec<T, void>(model, filters, "DELETE");
+      await k8sExec<T, void>(model, filters, "DELETE");
     } catch (e) {
       // If the resource doesn't exist, ignore the error
       if (e.status === StatusCodes.NOT_FOUND) {
@@ -101,12 +101,12 @@ export function Kube<T extends GenericClass, K extends KubernetesObject = Instan
 
   async function Apply(resource: K): Promise<K> {
     syncFilters(resource);
-    return kubeExec(model, filters, "APPLY", resource);
+    return k8sExec(model, filters, "APPLY", resource);
   }
 
   async function Create(resource: K): Promise<K> {
     syncFilters(resource);
-    return kubeExec(model, filters, "POST", resource);
+    return k8sExec(model, filters, "POST", resource);
   }
 
   async function Patch(payload: Operation[]): Promise<K> {
@@ -115,7 +115,7 @@ export function Kube<T extends GenericClass, K extends KubernetesObject = Instan
       throw new Error("No operations specified");
     }
 
-    return kubeExec<T, K>(model, filters, "PATCH", payload);
+    return k8sExec<T, K>(model, filters, "PATCH", payload);
   }
 
   async function Watch(callback: WatchAction<T>): Promise<void> {

package/src/fluent/types.ts

@@ -31,7 +31,7 @@ export type GetFunction<K extends KubernetesObject> = {
   (name: string): Promise<K>;
 };
 
-export type KubeFilteredActions<K extends KubernetesObject> = {
+export type K8sFilteredActions<K extends KubernetesObject> = {
   /**
    * Get the resource or resources matching the filters.
    * If no filters are specified, all resources will be returned.
@@ -54,7 +54,7 @@ export type KubeFilteredActions<K extends KubernetesObject> = {
   Watch: (callback: (payload: K, phase: WatchPhase) => void) => Promise<void>;
 };
 
-export type KubeUnfilteredActions<K extends KubernetesObject> = {
+export type K8sUnfilteredActions<K extends KubernetesObject> = {
   /**
    * Perform a server-side apply of the provided K8s resource.
    *
@@ -82,7 +82,7 @@ export type KubeUnfilteredActions<K extends KubernetesObject> = {
   Patch: (payload: Operation[]) => Promise<K>;
 };
 
-export type KubeWithFilters<K extends KubernetesObject> = KubeFilteredActions<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.
@@ -100,7 +100,7 @@ export type KubeWithFilters<K extends KubernetesObject> = KubeFilteredActions<K>
    * @param value The field value
    * @returns
    */
-  WithField: <P extends Paths<K>>(key: P, value?: string) => KubeWithFilters<K>;
+  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.
@@ -118,18 +118,18 @@ export type KubeWithFilters<K extends KubernetesObject> = KubeFilteredActions<K>
    * @param key The label key
    * @param value (optional) The label value
    */
-  WithLabel: (key: string, value?: string) => KubeWithFilters<K>;
+  WithLabel: (key: string, value?: string) => K8sWithFilters<K>;
 };
 
-export type KubeInit<K extends KubernetesObject> = KubeWithFilters<K> &
-  KubeUnfilteredActions<K> & {
+export type K8sInit<K extends KubernetesObject> = K8sWithFilters<K> &
+  K8sUnfilteredActions<K> & {
     /**
      * Filter the query by the given namespace.
      *
      * @param namespace
      * @returns
      */
-    InNamespace: (namespace: string) => KubeWithFilters<K>;
+    InNamespace: (namespace: string) => K8sWithFilters<K>;
   };
 
 export type WatchAction<T extends GenericClass, K extends KubernetesObject = InstanceType<T>> = (

package/src/fluent/utils.test.ts

@@ -7,7 +7,7 @@ import { fetch } from "../fetch";
 import { GenericClass } from "../types";
 import { ClusterRole, Ingress, Pod } from "../upstream";
 import { Filters } from "./types";
-import { kubeExec, pathBuilder } from "./utils";
+import { k8sExec, pathBuilder } from "./utils";
 
 jest.mock("https");
 jest.mock("../fetch");
@@ -83,7 +83,7 @@ describe("kubeExec Function", () => {
       statusText: "OK",
     });
 
-    const result = await kubeExec(Pod, fakeFilters, fakeMethod, fakePayload);
+    const result = await k8sExec(Pod, fakeFilters, fakeMethod, fakePayload);
 
     expect(result).toEqual(fakePayload);
     expect(mockedFetch).toHaveBeenCalledWith(fakeUrl, expect.objectContaining(fakeOpts));
@@ -100,7 +100,7 @@ describe("kubeExec Function", () => {
       statusText: fakeStatusText,
     });
 
-    await expect(kubeExec(Pod, fakeFilters, fakeMethod, fakePayload)).rejects.toEqual(
+    await expect(k8sExec(Pod, fakeFilters, fakeMethod, fakePayload)).rejects.toEqual(
       expect.objectContaining({
         status: fakeStatus,
         statusText: fakeStatusText,

package/src/fluent/utils.ts

@@ -92,7 +92,7 @@ export function pathBuilder<T extends GenericClass>(
  * @param method
  * @returns
  */
-export async function kubeCfg(method: FetchMethods) {
+export async function k8sCfg(method: FetchMethods) {
   const kubeConfig = new KubeConfig();
   kubeConfig.loadFromDefault();
 
@@ -115,13 +115,13 @@ export async function kubeCfg(method: FetchMethods) {
   return { opts, serverUrl: cluster.server };
 }
 
-export async function kubeExec<T extends GenericClass, K>(
+export async function k8sExec<T extends GenericClass, K>(
   model: T,
   filters: Filters,
   method: FetchMethods,
   payload?: K | unknown,
 ) {
-  const { opts, serverUrl } = await kubeCfg(method);
+  const { opts, serverUrl } = await k8sCfg(method);
   const url = pathBuilder(serverUrl, model, filters, method === "POST");
 
   switch (opts.method) {

package/src/fluent/watch.ts

@@ -6,7 +6,7 @@ import readline from "readline";
 import fetch from "node-fetch";
 import { GenericClass } from "../types";
 import { Filters, WatchAction, WatchPhase } from "./types";
-import { kubeCfg, pathBuilder } from "./utils";
+import { k8sCfg, pathBuilder } from "./utils";
 
 /**
  * Execute a watch on the specified resource.
@@ -17,7 +17,7 @@ export async function ExecWatch<T extends GenericClass>(
   callback: WatchAction<T>,
 ) {
   // Build the path and query params for the resource, excluding the name
-  const { opts, serverUrl } = await kubeCfg("GET");
+  const { opts, serverUrl } = await k8sCfg("GET");
   const url = pathBuilder(serverUrl, model, filters, true);
 
   // Enable the watch query param

package/src/index.ts

@@ -4,16 +4,16 @@
 // Export kinds as a single object
 import * as kind from "./upstream";
 
-/** given is a collection of K8s types to be used within a Kube call: `Kube(kind.Secret).Apply({})`. `a` may also be used in it's place */
+/** kind is a collection of K8s types to be used within a K8s call: `K8s(kind.Secret).Apply({})`. */
 export { kind };
 
 // Export the node-fetch wrapper
 export { fetch } from "./fetch";
 
 // Export the fluent API entrypoint
-export { Kube } from "./fluent/kube";
+export { K8s } from "./fluent";
 
 // Export helpers for working with K8s types
-export { modelToGroupVersionKind, RegisterKind } from "./kinds";
+export { RegisterKind, modelToGroupVersionKind } from "./kinds";
 
 export * from "./types";

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

@@ -1 +0,0 @@
-{"version":3,"file":"kube.d.ts","sourceRoot":"","sources":["../../src/fluent/kube.ts"],"names":[],"mappings":"AAGA,OAAO,EAAwB,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAKjF,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAsB,MAAM,SAAS,CAAC;AAIhE;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,EACvF,KAAK,EAAE,CAAC,EACR,OAAO,GAAE,OAAY,GACpB,QAAQ,CAAC,CAAC,CAAC,CAuGb"}

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

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

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

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