kubernetes-fluent-client 1.5.0 → 1.5.1

package/dist/fetch.d.ts

@@ -17,7 +17,7 @@ export type FetchResponse<T> = {
  *
  * @param url The URL or Request object to fetch
  * @param init Additional options for the request
- * @returns
+ * @returns The parsed JSON response
  */
 export declare function fetch<T>(url: URL | RequestInfo, init?: RequestInit): Promise<FetchResponse<T>>;
 //# sourceMappingURL=fetch.d.ts.map

package/dist/fetch.js

@@ -39,7 +39,7 @@ const node_fetch_1 = __importStar(require("node-fetch"));
  *
  * @param url The URL or Request object to fetch
  * @param init Additional options for the request
- * @returns
+ * @returns The parsed JSON response
  */
 async function fetch(url, init) {
     let data = undefined;

package/dist/fluent/index.d.ts

@@ -6,6 +6,7 @@ import { Filters, K8sInit } from "./types";
  *
  * @param model - the model to use for the API
  * @param filters - (optional) filter overrides, can also be chained
+ * @returns a fluent API for the model
  */
 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

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

package/dist/fluent/index.js

@@ -12,27 +12,45 @@ const watch_1 = require("./watch");
  *
  * @param model - the model to use for the API
  * @param filters - (optional) filter overrides, can also be chained
+ * @returns a fluent API for the model
  */
 function K8s(model, filters = {}) {
     const withFilters = { WithField, WithLabel, Get, Delete, Watch };
     const matchedKind = filters.kindOverride || (0, kinds_1.modelToGroupVersionKind)(model.name);
-    function InNamespace(namespaces) {
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.InNamespace}
+     */
+    function InNamespace(namespace) {
         if (filters.namespace) {
             throw new Error(`Namespace already specified: ${filters.namespace}`);
         }
-        filters.namespace = namespaces;
+        filters.namespace = namespace;
         return withFilters;
     }
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.WithField}
+     */
     function WithField(key, value) {
         filters.fields = filters.fields || {};
         filters.fields[key] = value;
         return withFilters;
     }
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.WithLabel}
+     */
     function WithLabel(key, value) {
         filters.labels = filters.labels || {};
         filters.labels[key] = value;
         return withFilters;
     }
+    /**
+     * Sync the filters with the provided payload.
+     *
+     * @param payload - the payload to sync with
+     */
     function syncFilters(payload) {
         // Ensure the payload has metadata
         payload.metadata = payload.metadata || {};
@@ -49,6 +67,10 @@ function K8s(model, filters = {}) {
             payload.kind = matchedKind.kind;
         }
     }
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.Get}
+     */
     async function Get(name) {
         if (name) {
             if (filters.name) {
@@ -58,6 +80,10 @@ function K8s(model, filters = {}) {
         }
         return (0, utils_1.k8sExec)(model, filters, "GET");
     }
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.Delete}
+     */
     async function Delete(filter) {
         if (typeof filter === "string") {
             filters.name = filter;
@@ -77,14 +103,26 @@ function K8s(model, filters = {}) {
             throw e;
         }
     }
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.Apply}
+     */
     async function Apply(resource, applyCfg = { force: false }) {
         syncFilters(resource);
         return (0, utils_1.k8sExec)(model, filters, "APPLY", resource, applyCfg);
     }
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.Create}
+     */
     async function Create(resource) {
         syncFilters(resource);
         return (0, utils_1.k8sExec)(model, filters, "POST", resource);
     }
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.Patch}
+     */
     async function Patch(payload) {
         // If there are no operations, throw an error
         if (payload.length < 1) {
@@ -92,6 +130,10 @@ function K8s(model, filters = {}) {
         }
         return (0, utils_1.k8sExec)(model, filters, "PATCH", payload);
     }
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.Watch}
+     */
     async function Watch(callback, watchCfg) {
         return (0, watch_1.ExecWatch)(model, filters, callback, watchCfg);
     }

package/dist/fluent/types.d.ts

@@ -20,6 +20,14 @@ export interface Filters {
     name?: string;
     namespace?: string;
 }
+/**
+ * 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.
+ *
+ * @param name - (optional) the name of the resource to get
+ * @returns the resource or list of resources
+ */
 export type GetFunction<K extends KubernetesObject> = {
     (): Promise<KubernetesListObject<K>>;
     (name: string): Promise<K>;
@@ -32,15 +40,17 @@ export type K8sFilteredActions<K extends KubernetesObject> = {
      */
     Get: GetFunction<K>;
     /**
-     * Delete the resource if it exists.
+     * Delete the resource matching the filters.
      *
      * @param filter - the resource or resource name to delete
      */
     Delete: (filter?: K | string) => Promise<void>;
     /**
+     * Watch the resource matching the filters.
      *
-     * @param callback
-     * @returns
+     * @param callback - the callback function to call when an event occurs
+     * @param watchCfg - (optional) watch configuration
+     * @returns a watch controller
      */
     Watch: (callback: (payload: K, phase: WatchPhase) => void, watchCfg?: WatchCfg) => Promise<WatchController>;
 };
@@ -48,15 +58,16 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
     /**
      * Perform a server-side apply of the provided K8s resource.
      *
-     * @param resource
-     * @returns
+     * @param resource - the resource to apply
+     * @param applyCfg - (optional) apply configuration
+     * @returns the applied resource
      */
     Apply: (resource: PartialDeep<K>, applyCfg?: ApplyCfg) => Promise<K>;
     /**
      * Create the provided K8s resource or throw an error if it already exists.
      *
-     * @param resource
-     * @returns
+     * @param resource - the resource to create
+     * @returns the created resource
      */
     Create: (resource: K) => Promise<K>;
     /**
@@ -76,18 +87,18 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
      *
      * ```ts
      * K8s(kind.Deployment)
-     *  .WithField("metadata.name", "bar")
-     *  .WithField("metadata.namespace", "qux")
-     *  .Delete(...)
+     * .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.
      * Not all fields are supported, see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/#supported-fields,
      * but Typescript will limit to only fields that exist on the resource.
      *
-     * @param key  The field key
-     * @param value The field value
-     * @returns
+     * @param key - the field key
+     * @param value - the field value
+     * @returns the fluent API
      */
     WithField: <P extends Paths<K>>(key: P, value: string) => K8sWithFilters<K>;
     /**
@@ -96,24 +107,25 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
      *
      * ```ts
      * K8s(kind.Deployment)
-     *   .WithLabel("foo", "bar")
-     *   .WithLabel("baz", "qux")
-     *   .Delete(...)
+     * .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
+     * @param key - the label key
+     * @param value - the label value
+     * @returns the fluent API
      */
     WithLabel: (key: string, value: string) => K8sWithFilters<K>;
 };
 export type K8sInit<K extends KubernetesObject> = K8sWithFilters<K> & K8sUnfilteredActions<K> & {
     /**
-     * Filter the query by the given namespace.
+     * Set the namespace filter.
      *
-     * @param namespace
-     * @returns
+     * @param namespace - the namespace to filter on
+     * @returns the fluent API
      */
     InNamespace: (namespace: string) => K8sWithFilters<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,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,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;;;;;OAKG;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;;;;;;;;;;;;;;;OAeG;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;;;;;;;;;;;;;;;;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"}

package/dist/fluent/utils.d.ts

@@ -6,11 +6,11 @@ import { ApplyCfg } from "./apply";
 /**
  * Generate a path to a Kubernetes resource
  *
- * @param serverUrl
- * @param model
- * @param filters
- * @param excludeName
- * @returns
+ * @param serverUrl - the URL of the Kubernetes API server
+ * @param model - the model to use for the API
+ * @param filters - (optional) filter overrides, can also be chained
+ * @param excludeName - (optional) exclude the name from the path
+ * @returns the path to the resource
  */
 export declare function pathBuilder<T extends GenericClass>(serverUrl: string, model: T, filters: Filters, excludeName?: boolean): URL;
 /**
@@ -21,12 +21,23 @@ export declare function pathBuilder<T extends GenericClass>(serverUrl: string, m
  * - 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
+ * @param method - the HTTP method to use
+ * @returns the fetch options and server URL
  */
 export declare function k8sCfg(method: FetchMethods): Promise<{
     opts: import("node-fetch").RequestInit;
     serverUrl: string;
 }>;
+/**
+ * Execute a request against the Kubernetes API server.
+ *
+ * @param model - the model to use for the API
+ * @param filters - (optional) filter overrides, can also be chained
+ * @param method - the HTTP method to use
+ * @param payload - (optional) the payload to send
+ * @param applyCfg - (optional) configuration for the apply method
+ *
+ * @returns the parsed JSON response
+ */
 export declare function k8sExec<T extends GenericClass, K>(model: T, filters: Filters, method: FetchMethods, payload?: K | unknown, applyCfg?: ApplyCfg): 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;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,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,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"}

package/dist/fluent/utils.js

@@ -11,11 +11,11 @@ const SSA_CONTENT_TYPE = "application/apply-patch+yaml";
 /**
  * Generate a path to a Kubernetes resource
  *
- * @param serverUrl
- * @param model
- * @param filters
- * @param excludeName
- * @returns
+ * @param serverUrl - the URL of the Kubernetes API server
+ * @param model - the model to use for the API
+ * @param filters - (optional) filter overrides, can also be chained
+ * @param excludeName - (optional) exclude the name from the path
+ * @returns the path to the resource
  */
 function pathBuilder(serverUrl, model, filters, excludeName = false) {
     const matchedKind = filters.kindOverride || (0, kinds_1.modelToGroupVersionKind)(model.name);
@@ -66,8 +66,8 @@ exports.pathBuilder = pathBuilder;
  * - 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
+ * @param method - the HTTP method to use
+ * @returns the fetch options and server URL
  */
 async function k8sCfg(method) {
     const kubeConfig = new client_node_1.KubeConfig();
@@ -91,6 +91,17 @@ async function k8sCfg(method) {
     return { opts, serverUrl: cluster.server };
 }
 exports.k8sCfg = k8sCfg;
+/**
+ * Execute a request against the Kubernetes API server.
+ *
+ * @param model - the model to use for the API
+ * @param filters - (optional) filter overrides, can also be chained
+ * @param method - the HTTP method to use
+ * @param payload - (optional) the payload to send
+ * @param applyCfg - (optional) configuration for the apply method
+ *
+ * @returns the parsed JSON response
+ */
 async function k8sExec(model, filters, method, payload, applyCfg = { force: false }) {
     const { opts, serverUrl } = await k8sCfg(method);
     const url = pathBuilder(serverUrl, model, filters, method === "POST");

package/dist/fluent/watch.d.ts

@@ -7,13 +7,14 @@ import { Filters, WatchAction } from "./types";
 export type WatchController = {
     /**
      * Abort the watch.
+     *
      * @param reason optional reason for aborting the watch
-     * @returns
      */
     abort: (reason?: string) => void;
     /**
      * Get the AbortSignal for the watch.
-     * @returns
+     *
+     * @returns the AbortSignal
      */
     signal: () => AbortSignal;
 };
@@ -40,6 +41,12 @@ export type WatchCfg = {
 };
 /**
  * Execute a watch on the specified resource.
+ *
+ * @param model - the model to use for the API
+ * @param filters - (optional) filter overrides, can also be chained
+ * @param callback - the callback function to call when an event is received
+ * @param watchCfg - (optional) watch configuration
+ * @returns a WatchController to allow the watch to be aborted externally
  */
 export declare function ExecWatch<T extends GenericClass>(model: T, filters: Filters, callback: WatchAction<T>, watchCfg?: WatchCfg): Promise<WatchController>;
 //# sourceMappingURL=watch.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":";AAMA,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAG3D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC;;;OAGG;IACH,MAAM,EAAE,MAAM,WAAW,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,wBAAsB,SAAS,CAAC,CAAC,SAAS,YAAY,EACpD,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,QAAQ,GAAE,QAAa,4BAwJxB"}
+{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":";AAMA,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAG3D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC;;;;OAIG;IACH,MAAM,EAAE,MAAM,WAAW,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;CAChC,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,CAAC,SAAS,YAAY,EACpD,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EACxB,QAAQ,GAAE,QAAa,4BAmKxB"}

package/dist/fluent/watch.js

@@ -11,6 +11,12 @@ const node_fetch_1 = __importDefault(require("node-fetch"));
 const utils_1 = require("./utils");
 /**
  * Execute a watch on the specified resource.
+ *
+ * @param model - the model to use for the API
+ * @param filters - (optional) filter overrides, can also be chained
+ * @param callback - the callback function to call when an event is received
+ * @param watchCfg - (optional) watch configuration
+ * @returns a WatchController to allow the watch to be aborted externally
  */
 async function ExecWatch(model, filters, callback, watchCfg = {}) {
     watchCfg.logFn?.({ model, filters, watchCfg }, "ExecWatch");
@@ -39,6 +45,9 @@ async function ExecWatch(model, filters, callback, watchCfg = {}) {
     let abortController;
     // Create a wrapped AbortController to allow the watch to be aborted externally
     const abortWrapper = {};
+    /**
+     * Bind the abort controller to the wrapper.
+     */
     function bindAbortController() {
         // Create a new AbortController
         abortController = new AbortController();
@@ -48,6 +57,9 @@ async function ExecWatch(model, filters, callback, watchCfg = {}) {
         // Add the abort signal to the request options
         opts.signal = abortController.signal;
     }
+    /**
+     * The main watch runner. This will run until the process is terminated or the watch is aborted.
+     */
     async function runner() {
         let doneCalled = false;
         bindAbortController();
@@ -67,6 +79,7 @@ async function ExecWatch(model, filters, callback, watchCfg = {}) {
                 }
             }
         };
+        // Cleanup the stream listeners
         const cleanup = () => {
             if (!doneCalled) {
                 doneCalled = true;
@@ -109,7 +122,11 @@ async function ExecWatch(model, filters, callback, watchCfg = {}) {
         catch (e) {
             onError(e);
         }
-        // On unhandled errors, retry the watch
+        /**
+         * Reload the watch.
+         *
+         * @param e - the error that caused the reload
+         */
         async function reload(e) {
             // If there are more attempts, retry the watch
             if (watchCfg.retryMax > retryCount) {

package/dist/kinds.d.ts

@@ -1,4 +1,10 @@
 import { GenericClass, GroupVersionKind } from "./types";
+/**
+ * Converts a model name to a GroupVersionKind
+ *
+ * @param key The name of the model
+ * @returns The GroupVersionKind for the model
+ */
 export declare function modelToGroupVersionKind(key: string): GroupVersionKind;
 /**
  * Registers a new model and GroupVersionKind to be used within the fluent API.

package/dist/kinds.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kinds.d.ts","sourceRoot":"","sources":["../src/kinds.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAwgBzD,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAErE;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,UAAW,YAAY,oBAAoB,gBAAgB,SAUnF,CAAC"}
+{"version":3,"file":"kinds.d.ts","sourceRoot":"","sources":["../src/kinds.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAujBzD;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAErE;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,UAAW,YAAY,oBAAoB,gBAAgB,SAUnF,CAAC"}