kubernetes-fluent-client 1.7.0 → 1.8.0

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.7.0",
+  "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/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";