kubernetes-fluent-client 1.3.1 → 1.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/dist/fluent/index.d.ts.map +1 -1
  2. package/dist/fluent/index.js +1 -1
  3. package/dist/fluent/index.test.js +10 -0
  4. package/dist/fluent/types.d.ts +7 -5
  5. package/dist/fluent/types.d.ts.map +1 -1
  6. package/dist/index.d.ts +1 -0
  7. package/dist/index.d.ts.map +1 -1
  8. package/dist/index.js +2 -1
  9. package/package.json +5 -4
  10. package/src/fluent/index.test.ts +14 -0
  11. package/src/fluent/index.ts +5 -4
  12. package/src/fluent/types.ts +6 -5
  13. package/src/index.ts +2 -0
package/dist/fluent/index.d.ts.map CHANGED
@@ -1 +1 @@
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"}
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;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/index.js CHANGED
@@ -93,7 +93,7 @@ function K8s(model, filters = {}) {
93
93
  return (0, utils_1.k8sExec)(model, filters, "PATCH", payload);
94
94
  }
95
95
  async function Watch(callback) {
96
- await (0, watch_1.ExecWatch)(model, filters, callback);
96
+ return (0, watch_1.ExecWatch)(model, filters, callback);
97
97
  }
98
98
  return { InNamespace, Apply, Create, Patch, ...withFilters };
99
99
  }
package/dist/fluent/index.test.js CHANGED
@@ -89,4 +89,14 @@ globals_1.jest.mock("./utils");
89
89
  const kube = (0, _1.K8s)(upstream_1.Pod);
90
90
  await (0, globals_1.expect)(kube.Patch([])).rejects.toThrow("No operations specified");
91
91
  });
92
+ (0, globals_1.it)("should allow Apply of deep partials", async () => {
93
+ const kube = (0, _1.K8s)(upstream_1.Pod);
94
+ const result = await kube.Apply({ metadata: { name: "fake" }, spec: { priority: 3 } });
95
+ (0, globals_1.expect)(result).toEqual(fakeResource);
96
+ });
97
+ (0, globals_1.it)("should throw an error if a Delete failed for a reason other than Not Found", async () => {
98
+ mockedKubeExec.mockRejectedValueOnce({ status: 500 }); // Internal Server Error on first call
99
+ const kube = (0, _1.K8s)(upstream_1.Pod);
100
+ await (0, globals_1.expect)(kube.Delete("fakeResource")).rejects.toEqual(globals_1.expect.objectContaining({ status: 500 }));
101
+ });
92
102
  });
package/dist/fluent/types.d.ts CHANGED
@@ -1,5 +1,7 @@
1
+ /// <reference types="node" />
1
2
  import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
2
3
  import { Operation } from "fast-json-patch";
4
+ import type { PartialDeep } from "type-fest";
3
5
  import { GenericClass, GroupVersionKind } from "../types";
4
6
  /**
5
7
  * The Phase matched when using the K8s Watch API.
@@ -39,7 +41,7 @@ export type K8sFilteredActions<K extends KubernetesObject> = {
39
41
  * @param callback
40
42
  * @returns
41
43
  */
42
- Watch: (callback: (payload: K, phase: WatchPhase) => void) => Promise<void>;
44
+ Watch: (callback: (payload: K, phase: WatchPhase) => void) => Promise<AbortController>;
43
45
  };
44
46
  export type K8sUnfilteredActions<K extends KubernetesObject> = {
45
47
  /**
@@ -48,7 +50,7 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
48
50
  * @param resource
49
51
  * @returns
50
52
  */
51
- Apply: (resource: K) => Promise<K>;
53
+ Apply: (resource: PartialDeep<K>) => Promise<K>;
52
54
  /**
53
55
  * Create the provided K8s resource or throw an error if it already exists.
54
56
  *
@@ -57,7 +59,7 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
57
59
  */
58
60
  Create: (resource: K) => Promise<K>;
59
61
  /**
60
- * Advanced JSON Patch operations for when Server Side Apply, Kube().Apply(), is insufficient.
62
+ * Advanced JSON Patch operations for when Server Side Apply, K8s().Apply(), is insufficient.
61
63
  *
62
64
  * Note: Throws an error on an empty list of patch operations.
63
65
  *
@@ -72,7 +74,7 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
72
74
  * Note multiple calls to this method will result in an AND condition. e.g.
73
75
  *
74
76
  * ```ts
75
- * Kube(given.Deployment)
77
+ * K8s(kind.Deployment)
76
78
  * .WithField("metadata.name", "bar")
77
79
  * .WithField("metadata.namespace", "qux")
78
80
  * .Delete(...)
@@ -90,7 +92,7 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
90
92
  * Note multiple calls to this method will result in an AND condition. e.g.
91
93
  *
92
94
  * ```ts
93
- * Kube(given.Deployment)
95
+ * K8s(kind.Deployment)
94
96
  * .WithLabel("foo", "bar")
95
97
  * .WithLabel("baz", "qux")
96
98
  * .Delete(...)
package/dist/fluent/types.d.ts.map CHANGED
@@ -1 +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;AAE5C,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"}
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;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,eAAe,CAAC,CAAC;CACxF,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,IAAI;IAC7D;;;;;OAKG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhD;;;;;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/index.d.ts CHANGED
@@ -6,4 +6,5 @@ export { StatusCodes as fetchStatus } from "http-status-codes";
6
6
  export { K8s } from "./fluent";
7
7
  export { RegisterKind, modelToGroupVersionKind } from "./kinds";
8
8
  export * from "./types";
9
+ export * as K8sClientNode from "@kubernetes/client-node";
9
10
  //# sourceMappingURL=index.d.ts.map
package/dist/index.d.ts.map CHANGED
@@ -1 +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;AAEhE,cAAc,SAAS,CAAC"}
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;AAEhE,cAAc,SAAS,CAAC;AAExB,OAAO,KAAK,aAAa,MAAM,yBAAyB,CAAC"}
package/dist/index.js CHANGED
@@ -28,7 +28,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
28
28
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
29
29
  };
30
30
  Object.defineProperty(exports, "__esModule", { value: true });
31
- exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.fetchStatus = exports.fetch = exports.kind = void 0;
31
+ exports.K8sClientNode = exports.modelToGroupVersionKind = exports.RegisterKind = exports.K8s = exports.fetchStatus = exports.fetch = exports.kind = void 0;
32
32
  // Export kinds as a single object
33
33
  const kind = __importStar(require("./upstream"));
34
34
  exports.kind = kind;
@@ -46,3 +46,4 @@ var kinds_1 = require("./kinds");
46
46
  Object.defineProperty(exports, "RegisterKind", { enumerable: true, get: function () { return kinds_1.RegisterKind; } });
47
47
  Object.defineProperty(exports, "modelToGroupVersionKind", { enumerable: true, get: function () { return kinds_1.modelToGroupVersionKind; } });
48
48
  __exportStar(require("./types"), exports);
49
+ exports.K8sClientNode = __importStar(require("@kubernetes/client-node"));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kubernetes-fluent-client",
3
- "version": "1.3.1",
3
+ "version": "1.3.2",
4
4
  "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -37,14 +37,15 @@
37
37
  "@kubernetes/client-node": "1.0.0-rc3",
38
38
  "fast-json-patch": "3.1.1",
39
39
  "http-status-codes": "2.3.0",
40
- "node-fetch": "2.7.0"
40
+ "node-fetch": "2.7.0",
41
+ "type-fest": "4.3.2"
41
42
  },
42
43
  "devDependencies": {
43
44
  "@commitlint/cli": "17.7.1",
44
45
  "@commitlint/config-conventional": "17.7.0",
45
46
  "@jest/globals": "29.7.0",
46
- "@typescript-eslint/eslint-plugin": "6.7.2",
47
- "@typescript-eslint/parser": "6.7.2",
47
+ "@typescript-eslint/eslint-plugin": "6.7.3",
48
+ "@typescript-eslint/parser": "6.7.3",
48
49
  "jest": "29.7.0",
49
50
  "nock": "13.3.3",
50
51
  "prettier": "3.0.3",
package/src/fluent/index.test.ts CHANGED
@@ -133,4 +133,18 @@ describe("Kube", () => {
133
133
  const kube = K8s(Pod);
134
134
  await expect(kube.Patch([])).rejects.toThrow("No operations specified");
135
135
  });
136
+
137
+ it("should allow Apply of deep partials", async () => {
138
+ const kube = K8s(Pod);
139
+ const result = await kube.Apply({ metadata: { name: "fake" }, spec: { priority: 3 } });
140
+ expect(result).toEqual(fakeResource);
141
+ });
142
+
143
+ it("should throw an error if a Delete failed for a reason other than Not Found", async () => {
144
+ mockedKubeExec.mockRejectedValueOnce({ status: 500 }); // Internal Server Error on first call
145
+ const kube = K8s(Pod);
146
+ await expect(kube.Delete("fakeResource")).rejects.toEqual(
147
+ expect.objectContaining({ status: 500 }),
148
+ );
149
+ });
136
150
  });
package/src/fluent/index.ts CHANGED
@@ -4,6 +4,7 @@
4
4
  import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
5
5
  import { Operation } from "fast-json-patch";
6
6
  import { StatusCodes } from "http-status-codes";
7
+ import type { PartialDeep } from "type-fest";
7
8
 
8
9
  import { modelToGroupVersionKind } from "../kinds";
9
10
  import { GenericClass } from "../types";
@@ -99,8 +100,8 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
99
100
  }
100
101
  }
101
102
 
102
- async function Apply(resource: K): Promise<K> {
103
- syncFilters(resource);
103
+ async function Apply(resource: PartialDeep<K>): Promise<K> {
104
+ syncFilters(resource as K);
104
105
  return k8sExec(model, filters, "APPLY", resource);
105
106
  }
106
107
 
@@ -118,8 +119,8 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
118
119
  return k8sExec<T, K>(model, filters, "PATCH", payload);
119
120
  }
120
121
 
121
- async function Watch(callback: WatchAction<T>): Promise<void> {
122
- await ExecWatch(model, filters, callback);
122
+ async function Watch(callback: WatchAction<T>): Promise<AbortController> {
123
+ return ExecWatch(model, filters, callback);
123
124
  }
124
125
 
125
126
  return { InNamespace, Apply, Create, Patch, ...withFilters };
package/src/fluent/types.ts CHANGED
@@ -3,6 +3,7 @@
3
3
 
4
4
  import { KubernetesListObject, KubernetesObject } from "@kubernetes/client-node";
5
5
  import { Operation } from "fast-json-patch";
6
+ import type { PartialDeep } from "type-fest";
6
7
 
7
8
  import { GenericClass, GroupVersionKind } from "../types";
8
9
 
@@ -50,7 +51,7 @@ export type K8sFilteredActions<K extends KubernetesObject> = {
50
51
  * @param callback
51
52
  * @returns
52
53
  */
53
- Watch: (callback: (payload: K, phase: WatchPhase) => void) => Promise<void>;
54
+ Watch: (callback: (payload: K, phase: WatchPhase) => void) => Promise<AbortController>;
54
55
  };
55
56
 
56
57
  export type K8sUnfilteredActions<K extends KubernetesObject> = {
@@ -60,7 +61,7 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
60
61
  * @param resource
61
62
  * @returns
62
63
  */
63
- Apply: (resource: K) => Promise<K>;
64
+ Apply: (resource: PartialDeep<K>) => Promise<K>;
64
65
 
65
66
  /**
66
67
  * Create the provided K8s resource or throw an error if it already exists.
@@ -71,7 +72,7 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
71
72
  Create: (resource: K) => Promise<K>;
72
73
 
73
74
  /**
74
- * Advanced JSON Patch operations for when Server Side Apply, Kube().Apply(), is insufficient.
75
+ * Advanced JSON Patch operations for when Server Side Apply, K8s().Apply(), is insufficient.
75
76
  *
76
77
  * Note: Throws an error on an empty list of patch operations.
77
78
  *
@@ -87,7 +88,7 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
87
88
  * Note multiple calls to this method will result in an AND condition. e.g.
88
89
  *
89
90
  * ```ts
90
- * Kube(given.Deployment)
91
+ * K8s(kind.Deployment)
91
92
  * .WithField("metadata.name", "bar")
92
93
  * .WithField("metadata.namespace", "qux")
93
94
  * .Delete(...)
@@ -106,7 +107,7 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
106
107
  * Note multiple calls to this method will result in an AND condition. e.g.
107
108
  *
108
109
  * ```ts
109
- * Kube(given.Deployment)
110
+ * K8s(kind.Deployment)
110
111
  * .WithLabel("foo", "bar")
111
112
  * .WithLabel("baz", "qux")
112
113
  * .Delete(...)
package/src/index.ts CHANGED
@@ -20,3 +20,5 @@ export { K8s } from "./fluent";
20
20
  export { RegisterKind, modelToGroupVersionKind } from "./kinds";
21
21
 
22
22
  export * from "./types";
23
+
24
+ export * as K8sClientNode from "@kubernetes/client-node";