kubernetes-fluent-client 1.6.1 → 1.8.0

package/dist/fluent/index.js

@@ -41,7 +41,7 @@ function K8s(model, filters = {}) {
      * @inheritdoc
      * @see {@link K8sInit.WithLabel}
      */
-    function WithLabel(key, value) {
+    function WithLabel(key, value = "") {
         filters.labels = filters.labels || {};
         filters.labels[key] = value;
         return withFilters;

package/dist/fluent/types.d.ts

@@ -109,16 +109,17 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
      * K8s(kind.Deployment)
      * .WithLabel("foo", "bar")
      * .WithLabel("baz", "qux")
+     * .WithLabel("quux")
      * .Delete(...)
      * ```
      *
-     * Will only delete the Deployment if it has the`foo=bar` and `baz=qux` labels.
+     * Will only delete the Deployment if it has the`foo=bar` and `baz=qux` labels and the `quux` label exists.
      *
      * @param key - the label key
      * @param value - the label value
      * @returns the fluent API
      */
-    WithLabel: (key: string, value: string) => K8sWithFilters<K>;
+    WithLabel: (key: string, value?: string) => K8sWithFilters<K>;
 };
 export type K8sInit<K extends KubernetesObject> = K8sWithFilters<K> & K8sUnfilteredActions<K> & {
     /**

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;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,CAAC,CAAC;CAC9D,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"}
+{"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,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.map

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

package/dist/fluent/utils.js

@@ -51,7 +51,9 @@ function pathBuilder(serverUrl, model, filters, excludeName = false) {
     // Add label selectors to the query params
     if (filters.labels) {
         const labelSelector = Object.entries(filters.labels)
-            .map(([key, value]) => `${key}=${value}`)
+            // Exists set-based operators only include the key
+            // See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#set-based-requirement
+            .map(([key, value]) => (value ? `${key}=${value}` : key))
             .join(",");
         url.searchParams.set("labelSelector", labelSelector);
     }

package/dist/fluent/utils.test.js

@@ -16,6 +16,16 @@ globals_1.jest.mock("../fetch");
         const filters = {};
         (0, globals_1.expect)(() => (0, utils_1.pathBuilder)("", model, filters)).toThrow("Kind not specified for Unknown");
     });
+    (0, globals_1.it)("should generate a path with a set-based label selector", () => {
+        const filters = {
+            namespace: "default",
+            name: "mypod",
+            labels: { iamalabel: "" },
+        };
+        const result = (0, utils_1.pathBuilder)(serverUrl, upstream_1.Pod, filters);
+        const expected = new URL("/api/v1/namespaces/default/pods/mypod?labelSelector=iamalabel", serverUrl);
+        (0, globals_1.expect)(result.toString()).toEqual(expected.toString());
+    });
     (0, globals_1.it)("should generate a path for core group kinds (with custom filters)", () => {
         const filters = {
             namespace: "default",

package/dist/helpers.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Get an environment variable (Node, Deno or Bun), or throw an error if it's not set.
+ *
+ * @example
+ * const value = fromEnv("MY_ENV_VAR");
+ * console.log(value);
+ * // => "my-value"
+ *
+ * @example
+ * const value = fromEnv("MY_MISSING_ENV_VAR");
+ * // => Error: Environment variable MY_MISSING_ENV_VAR is not set
+ *
+ * @param name The name of the environment variable to get.
+ * @returns The value of the environment variable.
+ * @throws An error if the environment variable is not set.
+ */
+export declare function fromEnv(name: string): string;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAqB5C"}

package/dist/helpers.js

@@ -0,0 +1,41 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromEnv = void 0;
+/**
+ * Get an environment variable (Node, Deno or Bun), or throw an error if it's not set.
+ *
+ * @example
+ * const value = fromEnv("MY_ENV_VAR");
+ * console.log(value);
+ * // => "my-value"
+ *
+ * @example
+ * const value = fromEnv("MY_MISSING_ENV_VAR");
+ * // => Error: Environment variable MY_MISSING_ENV_VAR is not set
+ *
+ * @param name The name of the environment variable to get.
+ * @returns The value of the environment variable.
+ * @throws An error if the environment variable is not set.
+ */
+function fromEnv(name) {
+    let envValue;
+    // Check for Node.js or Bun
+    if (typeof process !== "undefined" && typeof process.env !== "undefined") {
+        envValue = process.env[name];
+    }
+    // Check for Deno
+    else if (typeof Deno !== "undefined") {
+        envValue = Deno.env.get(name);
+    }
+    // Otherwise, throw an error
+    else {
+        throw new Error("Unknown runtime environment");
+    }
+    if (typeof envValue === "undefined") {
+        throw new Error(`Environment variable ${name} is not set`);
+    }
+    return envValue;
+}
+exports.fromEnv = fromEnv;

package/dist/helpers.test.d.ts

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

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

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

package/dist/helpers.test.js

@@ -0,0 +1,16 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const helpers_1 = require("./helpers");
+(0, globals_1.describe)("helpers", () => {
+    (0, globals_1.test)("fromEnv for NodeJS", () => {
+        (0, globals_1.expect)(() => {
+            (0, helpers_1.fromEnv)("MY_MISSING_ENV_VAR");
+        }).toThrowError("Environment variable MY_MISSING_ENV_VAR is not set");
+        process.env.MY_ENV_VAR = "my-value";
+        (0, globals_1.expect)((0, helpers_1.fromEnv)("MY_ENV_VAR")).toEqual("my-value");
+        delete process.env.MY_ENV_VAR;
+    });
+});

package/dist/index.d.ts

@@ -8,4 +8,5 @@ export { RegisterKind, modelToGroupVersionKind } from "./kinds";
 export { GenericKind } from "./types";
 export * from "./types";
 export * as K8sClientNode from "@kubernetes/client-node";
+export { fromEnv } from "./helpers";
 //# 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,oGAAoG;AACpG,OAAO,EAAE,IAAI,EAAE,CAAC;AAGhB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,OAAO,EAAE,WAAW,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAG/D,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAGhE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,cAAc,SAAS,CAAC;AAExB,OAAO,KAAK,aAAa,MAAM,yBAAyB,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,WAAW,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAG/D,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAG/B,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAGhE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,cAAc,SAAS,CAAC;AAExB,OAAO,KAAK,aAAa,MAAM,yBAAyB,CAAC;AAEzD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,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.K8sClientNode = exports.GenericKind = exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.fetchStatus = exports.fetch = exports.kind = void 0;
+exports.fromEnv = exports.K8sClientNode = exports.GenericKind = exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.fetchStatus = exports.fetch = exports.kind = void 0;
 // Export kinds as a single object
 const kind = __importStar(require("./upstream"));
 exports.kind = kind;
@@ -50,3 +50,5 @@ var types_1 = require("./types");
 Object.defineProperty(exports, "GenericKind", { enumerable: true, get: function () { return types_1.GenericKind; } });
 __exportStar(require("./types"), exports);
 exports.K8sClientNode = __importStar(require("@kubernetes/client-node"));
+var helpers_1 = require("./helpers");
+Object.defineProperty(exports, "fromEnv", { enumerable: true, get: function () { return helpers_1.fromEnv; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "1.6.1",
+  "version": "1.8.0",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply",
   "bin": "./dist/cli.js",
   "main": "dist/index.js",
@@ -41,21 +41,21 @@
     "http-status-codes": "2.3.0",
     "node-fetch": "2.7.0",
     "quicktype-core": "23.0.76",
-    "type-fest": "4.4.0",
+    "type-fest": "4.5.0",
     "yargs": "17.7.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.7.2",
-    "@commitlint/config-conventional": "17.7.0",
+    "@commitlint/cli": "18.0.0",
+    "@commitlint/config-conventional": "18.0.0",
     "@jest/globals": "29.7.0",
-    "@types/byline": "4.2.34",
-    "@types/readable-stream": "4.0.3",
-    "@types/yargs": "17.0.28",
-    "@typescript-eslint/eslint-plugin": "6.7.5",
-    "@typescript-eslint/parser": "6.7.5",
+    "@types/byline": "4.2.35",
+    "@types/readable-stream": "4.0.4",
+    "@types/yargs": "17.0.29",
+    "@typescript-eslint/eslint-plugin": "6.9.0",
+    "@typescript-eslint/parser": "6.9.0",
     "eslint-plugin-jsdoc": "46.8.2",
     "jest": "29.7.0",
-    "nock": "13.3.4",
+    "nock": "13.3.6",
     "prettier": "3.0.3",
     "semantic-release": "22.0.5",
     "ts-jest": "29.1.1",

package/src/fluent/index.ts

@@ -54,7 +54,7 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
    * @inheritdoc
    * @see {@link K8sInit.WithLabel}
    */
-  function WithLabel(key: string, value: string) {
+  function WithLabel(key: string, value = "") {
     filters.labels = filters.labels || {};
     filters.labels[key] = value;
     return withFilters;

package/src/fluent/types.ts

@@ -128,16 +128,17 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
    * K8s(kind.Deployment)
    * .WithLabel("foo", "bar")
    * .WithLabel("baz", "qux")
+   * .WithLabel("quux")
    * .Delete(...)
    * ```
    *
-   * Will only delete the Deployment if it has the`foo=bar` and `baz=qux` labels.
+   * Will only delete the Deployment if it has the`foo=bar` and `baz=qux` labels and the `quux` label exists.
    *
    * @param key - the label key
    * @param value - the label value
    * @returns the fluent API
    */
-  WithLabel: (key: string, value: string) => K8sWithFilters<K>;
+  WithLabel: (key: string, value?: string) => K8sWithFilters<K>;
 };
 
 export type K8sInit<K extends KubernetesObject> = K8sWithFilters<K> &

package/src/fluent/utils.test.ts

@@ -21,6 +21,21 @@ describe("pathBuilder Function", () => {
     expect(() => pathBuilder("", model, filters)).toThrow("Kind not specified for Unknown");
   });
 
+  it("should generate a path with a set-based label selector", () => {
+    const filters: Filters = {
+      namespace: "default",
+      name: "mypod",
+      labels: { iamalabel: "" },
+    };
+    const result = pathBuilder(serverUrl, Pod, filters);
+    const expected = new URL(
+      "/api/v1/namespaces/default/pods/mypod?labelSelector=iamalabel",
+      serverUrl,
+    );
+
+    expect(result.toString()).toEqual(expected.toString());
+  });
+
   it("should generate a path for core group kinds (with custom filters)", () => {
     const filters: Filters = {
       namespace: "default",

package/src/fluent/utils.ts

@@ -73,7 +73,9 @@ export function pathBuilder<T extends GenericClass>(
   // Add label selectors to the query params
   if (filters.labels) {
     const labelSelector = Object.entries(filters.labels)
-      .map(([key, value]) => `${key}=${value}`)
+      // Exists set-based operators only include the key
+      // See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#set-based-requirement
+      .map(([key, value]) => (value ? `${key}=${value}` : key))
       .join(",");
 
     url.searchParams.set("labelSelector", labelSelector);

package/src/helpers.test.ts

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+
+import { describe, expect, test } from "@jest/globals";
+
+import { fromEnv } from "./helpers";
+
+describe("helpers", () => {
+  test("fromEnv for NodeJS", () => {
+    expect(() => {
+      fromEnv("MY_MISSING_ENV_VAR");
+    }).toThrowError("Environment variable MY_MISSING_ENV_VAR is not set");
+
+    process.env.MY_ENV_VAR = "my-value";
+    expect(fromEnv("MY_ENV_VAR")).toEqual("my-value");
+    delete process.env.MY_ENV_VAR;
+  });
+});

package/src/helpers.ts

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
+
+declare const Deno: {
+  env: {
+    get(name: string): string | undefined;
+  };
+};
+
+/**
+ * Get an environment variable (Node, Deno or Bun), or throw an error if it's not set.
+ *
+ * @example
+ * const value = fromEnv("MY_ENV_VAR");
+ * console.log(value);
+ * // => "my-value"
+ *
+ * @example
+ * const value = fromEnv("MY_MISSING_ENV_VAR");
+ * // => Error: Environment variable MY_MISSING_ENV_VAR is not set
+ *
+ * @param name The name of the environment variable to get.
+ * @returns The value of the environment variable.
+ * @throws An error if the environment variable is not set.
+ */
+export function fromEnv(name: string): string {
+  let envValue: string | undefined;
+
+  // Check for Node.js or Bun
+  if (typeof process !== "undefined" && typeof process.env !== "undefined") {
+    envValue = process.env[name];
+  }
+  // Check for Deno
+  else if (typeof Deno !== "undefined") {
+    envValue = Deno.env.get(name);
+  }
+  // Otherwise, throw an error
+  else {
+    throw new Error("Unknown runtime environment");
+  }
+
+  if (typeof envValue === "undefined") {
+    throw new Error(`Environment variable ${name} is not set`);
+  }
+
+  return envValue;
+}

package/src/index.ts

@@ -25,3 +25,5 @@ export { GenericKind } from "./types";
 export * from "./types";
 
 export * as K8sClientNode from "@kubernetes/client-node";
+
+export { fromEnv } from "./helpers";