kubernetes-fluent-client 2.6.1 → 2.6.3

package/README.md

@@ -7,6 +7,12 @@
 
 The Kubernetes Fluent Client for Node is a fluent API for the [Kubernetes JavaScript Client](https://github.com/kubernetes-client/javascript) with some additional logic for [Server Side Apply](https://kubernetes.io/docs/reference/using-api/server-side-apply/), [Watch](https://kubernetes.io/docs/reference/using-api/api-concepts/#efficient-detection-of-changes) with retry/signal control, and [Field Selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). In addition to providing a human-friendly API, it also provides a simple way to create and manage resources in the cluster and integrate with K8s in a type-safe way.
 
+To install the Kubernetes Fluent Client, run the following command:
+
+```bash
+npm install kubernetes-fluent-client
+```
+
 See below for some example uses of the library.
 
 ```typescript
@@ -98,3 +104,7 @@ Promise.all([
     console.error(err);
   });
 ```
+
+### Community
+
+To chat with other users & see some examples of the fluent client in active use, go to [Kubernetes Slack](https://communityinviter.com/apps/kubernetes/community) and join `#pepr` channel.

package/dist/fetch.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { RequestInfo, RequestInit } from "node-fetch";
 export type FetchResponse<T> = {
     data: T;

package/dist/fetch.d.ts.map

@@ -1 +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,CAwC3B"}
+{"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,CAwC3B"}

package/dist/fetch.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetch = void 0;
+exports.fetch = fetch;
 const http_status_codes_1 = require("http-status-codes");
 const node_fetch_1 = __importStar(require("node-fetch"));
 /**
@@ -80,4 +80,3 @@ async function fetch(url, init) {
         };
     }
 }
-exports.fetch = fetch;

package/dist/fluent/index.js

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.K8s = void 0;
+exports.K8s = K8s;
 const http_status_codes_1 = require("http-status-codes");
 const fetch_1 = require("../fetch");
 const kinds_1 = require("../kinds");
@@ -117,7 +117,7 @@ function K8s(model, filters = {}) {
             }
         }
         catch (e) {
-            throw new Error(e);
+            throw new Error(`Failed to get logs in KFC Logs function`);
         }
         const podModel = { ...model, name: "V1Pod" };
         const logPromises = podList.map(po => (0, utils_1.k8sExec)(podModel, { ...filters, name: po.metadata.name }, "LOG"));
@@ -226,4 +226,3 @@ function K8s(model, filters = {}) {
     }
     return { InNamespace, Apply, Create, Patch, PatchStatus, Raw, ...withFilters };
 }
-exports.K8s = K8s;

package/dist/fluent/utils.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { URL } from "url";
 import { GenericClass } from "../types";
 import { ApplyCfg, FetchMethods, Filters } from "./types";

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

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/fluent/utils.ts"],"names":[],"mappings":";AAKA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAI1B,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAI1D;;;;;;;;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,cAwDtC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/fluent/utils.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAI1B,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAI1D;;;;;;;;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,cAwDtC"}

package/dist/fluent/utils.js

@@ -2,7 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.k8sExec = exports.k8sCfg = exports.pathBuilder = void 0;
+exports.pathBuilder = pathBuilder;
+exports.k8sCfg = k8sCfg;
+exports.k8sExec = k8sExec;
 const client_node_1 = require("@kubernetes/client-node");
 const url_1 = require("url");
 const fetch_1 = require("../fetch");
@@ -59,7 +61,6 @@ function pathBuilder(serverUrl, model, filters, excludeName = false) {
     }
     return url;
 }
-exports.pathBuilder = pathBuilder;
 /**
  * Sets up the kubeconfig and https agent for a request
  *
@@ -92,7 +93,6 @@ async function k8sCfg(method) {
     opts.compress = true;
     return { opts, serverUrl: cluster.server };
 }
-exports.k8sCfg = k8sCfg;
 /**
  * Execute a request against the Kubernetes API server.
  *
@@ -151,4 +151,3 @@ async function k8sExec(model, filters, method, payload, applyCfg = { force: fals
     }
     throw resp;
 }
-exports.k8sExec = k8sExec;

package/dist/fluent/watch.d.ts

@@ -1,6 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import { EventEmitter } from "events";
 import { GenericClass } from "../types";
 import { Filters, WatchAction } from "./types";

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

@@ -1 +1 @@
-{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":";;;AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAItC,OAAO,EAAE,YAAY,EAAwB,MAAM,UAAU,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAG3D,oBAAY,UAAU;IACpB,sCAAsC;IACtC,OAAO,YAAY;IACnB,2BAA2B;IAC3B,aAAa,kBAAkB;IAC/B,kDAAkD;IAClD,UAAU,eAAe;IACzB,0BAA0B;IAC1B,SAAS,cAAc;IACvB,8BAA8B;IAC9B,OAAO,YAAY;IACnB,sBAAsB;IACtB,KAAK,UAAU;IACf,mCAAmC;IACnC,IAAI,SAAS;IACb,wCAAwC;IACxC,oBAAoB,yBAAyB;IAC7C,qCAAqC;IACrC,iBAAiB,sBAAsB;IACvC,kCAAkC;IAClC,IAAI,SAAS;IACb,2BAA2B;IAC3B,UAAU,eAAe;CAC1B;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG;IACrB,+HAA+H;IAC/H,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+FAA+F;IAC/F,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,0GAA0G;IAC1G,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAKF,iDAAiD;AACjD,qBAAa,OAAO,CAAC,CAAC,SAAS,YAAY;;IAwBzC,YAAY,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAc9B;;;;;;;;;;;OAWG;gBACS,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAE,QAAa;IAgCzF;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAK9C,gGAAgG;IACzF,KAAK;IAOZ;;;;;OAKG;IACI,UAAU;IAWjB;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;CAyTF"}
+{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAItC,OAAO,EAAE,YAAY,EAAwB,MAAM,UAAU,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAG3D,oBAAY,UAAU;IACpB,sCAAsC;IACtC,OAAO,YAAY;IACnB,2BAA2B;IAC3B,aAAa,kBAAkB;IAC/B,kDAAkD;IAClD,UAAU,eAAe;IACzB,0BAA0B;IAC1B,SAAS,cAAc;IACvB,8BAA8B;IAC9B,OAAO,YAAY;IACnB,sBAAsB;IACtB,KAAK,UAAU;IACf,mCAAmC;IACnC,IAAI,SAAS;IACb,wCAAwC;IACxC,oBAAoB,yBAAyB;IAC7C,qCAAqC;IACrC,iBAAiB,sBAAsB;IACvC,kCAAkC;IAClC,IAAI,SAAS;IACb,2BAA2B;IAC3B,UAAU,eAAe;CAC1B;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG;IACrB,+HAA+H;IAC/H,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+FAA+F;IAC/F,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,0GAA0G;IAC1G,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAKF,iDAAiD;AACjD,qBAAa,OAAO,CAAC,CAAC,SAAS,YAAY;;IAwBzC,YAAY,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAc9B;;;;;;;;;;;OAWG;gBACS,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAE,QAAa;IAgCzF;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAK9C,gGAAgG;IACzF,KAAK;IAOZ;;;;;OAKG;IACI,UAAU;IAWjB;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;CAyTF"}

package/dist/generate.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = void 0;
+exports.generate = generate;
 const client_node_1 = require("@kubernetes/client-node");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
@@ -153,7 +153,7 @@ async function readOrFetchCrd(opts) {
     catch (e) {
         // If invalid, ignore the error
         if (e.code !== "ERR_INVALID_URL") {
-            throw new Error(e);
+            throw new Error(`Error parsing URL ${source}`);
         }
     }
     // Finally, if the source is not a file or URL, try to read it as a CustomResourceDefinition from the cluster
@@ -193,4 +193,3 @@ async function generate(opts) {
     }
     return results;
 }
-exports.generate = generate;

package/dist/helpers.js

@@ -2,7 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasLogs = exports.waitForCluster = exports.fromEnv = void 0;
+exports.fromEnv = fromEnv;
+exports.waitForCluster = waitForCluster;
+exports.hasLogs = hasLogs;
 const client_node_1 = require("@kubernetes/client-node");
 /**
  *  Sleep for a number of seconds.
@@ -48,7 +50,6 @@ function fromEnv(name) {
     }
     return envValue;
 }
-exports.fromEnv = fromEnv;
 /**
  * Wait for the Kubernetes cluster to be ready.
  *
@@ -70,7 +71,6 @@ async function waitForCluster(seconds = 30) {
     }
     return cluster;
 }
-exports.waitForCluster = waitForCluster;
 /**
  * Determines if object has logs.
  *
@@ -101,4 +101,3 @@ function hasLogs(kind) {
     }
     return hasSelector;
 }
-exports.hasLogs = hasLogs;

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.waitForCluster = exports.fromEnv = exports.models = exports.GenericKind = exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.WatchEvent = exports.fetchStatus = exports.fetch = exports.kind = void 0;
+exports.waitForCluster = exports.fromEnv = exports.models = exports.GenericKind = exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.WatchEvent = exports.fetchStatus = exports.kind = void 0;
 require("./patch");
 // Export kinds as a single object
 const kind = __importStar(require("./upstream"));

package/dist/kinds.js

@@ -2,7 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegisterKind = exports.modelToGroupVersionKind = void 0;
+exports.RegisterKind = void 0;
+exports.modelToGroupVersionKind = modelToGroupVersionKind;
 const gvkMap = {
     /**
      * Represents a K8s Event resource (new Event in the events.k8s.io API)
@@ -551,7 +552,6 @@ const gvkMap = {
 function modelToGroupVersionKind(key) {
     return gvkMap[key];
 }
-exports.modelToGroupVersionKind = modelToGroupVersionKind;
 /**
  * Registers a new model and GroupVersionKind to be used within the fluent API.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "2.6.1",
+  "version": "2.6.3",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply.",
   "bin": "./dist/cli.js",
   "main": "dist/index.js",
@@ -35,13 +35,13 @@
   },
   "homepage": "https://github.com/defenseunicorns/kubernetes-fluent-client#readme",
   "dependencies": {
-    "@kubernetes/client-node": "1.0.0-rc4",
+    "@kubernetes/client-node": "1.0.0-rc6",
     "byline": "5.0.0",
     "fast-json-patch": "3.1.1",
     "http-status-codes": "2.3.0",
     "node-fetch": "2.7.0",
-    "quicktype-core": "23.0.168",
-    "type-fest": "4.18.2",
+    "quicktype-core": "23.0.170",
+    "type-fest": "4.20.1",
     "yargs": "17.7.2"
   },
   "devDependencies": {
@@ -52,15 +52,15 @@
     "@types/readable-stream": "4.0.14",
     "@types/urijs": "^1.19.25",
     "@types/yargs": "17.0.32",
-    "@typescript-eslint/eslint-plugin": "7.10.0",
-    "@typescript-eslint/parser": "7.10.0",
-    "eslint-plugin-jsdoc": "48.2.5",
+    "@typescript-eslint/eslint-plugin": "7.15.0",
+    "@typescript-eslint/parser": "7.15.0",
+    "eslint-plugin-jsdoc": "48.5.0",
     "jest": "29.7.0",
     "nock": "13.5.4",
-    "prettier": "3.2.5",
-    "semantic-release": "23.1.1",
-    "ts-jest": "29.1.3",
-    "typescript": "5.4.5"
+    "prettier": "3.3.2",
+    "semantic-release": "24.0.0",
+    "ts-jest": "29.1.5",
+    "typescript": "5.5.2"
   },
   "release": {
     "branches": [

package/src/fluent/index.ts

@@ -139,7 +139,7 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
         podList.push(object);
       }
     } catch (e) {
-      throw new Error(e);
+      throw new Error(`Failed to get logs in KFC Logs function`);
     }
 
     const podModel = { ...model, name: "V1Pod" };

package/src/generate.ts

@@ -183,7 +183,7 @@ async function readOrFetchCrd(opts: GenerateOptions): Promise<CustomResourceDefi
   } catch (e) {
     // If invalid, ignore the error
     if (e.code !== "ERR_INVALID_URL") {
-      throw new Error(e);
+      throw new Error(`Error parsing URL ${source}`);
     }
   }