pepr 0.1.34 → 0.1.36

package/README.md

@@ -10,6 +10,22 @@ Pepr is on a mission to save Kubernetes from the tyranny of YAML, intimidating g
 - Write capabilities in TypeScript and bundle them for in-cluster processing in [NodeJS](https://nodejs.org/).
 - React to cluster resources by mutating them, creating new Kubernetes resources, or performing arbitrary exec/API operations.
 
+## Wow too many words! tl;dr;
+```bash
+# Install Pepr (you can also use npx)
+npm i -g pepr
+
+# Initialize a new Pepr Module
+pepr init
+
+# Follow the prompts...
+
+# Within the new project dir, start playing with things
+pepr dev
+
+# Be amazed and ⭐️ this repo
+```
+
 Pepr is an open-source project that helps IT Ops teams of all skill levels manage and modify resources in a Kubernetes (K8s) cluster using TypeScript. Kubernetes simplifies the management of multiple computers working together to run and scale applications. Pepr acts as a smart assistant, automatically changing or validating parts of the system as needed.
 
 TypeScript is used to create Pepr capabilities, benefiting from its error-catching and clean code features, but without requiring specialized software engineering experience or prior Typescript knowledge. Pepr also provides a user-friendly interface for writing commands in plain English in a [Fluent Interface](https://en.wikipedia.org/wiki/Fluent_interface) style.

package/dist/index.d.ts

@@ -1,5 +1,12 @@
-import { Capability } from './src/lib/capability';
-import { a } from './src/lib/k8s';
-import Log from './src/lib/logger';
-import { PeprModule } from './src/lib/module';
-export { a, PeprModule, Capability, Log };
+import k8s from "@kubernetes/client-node";
+import utils from "ramda";
+import { fetch, fetchRaw } from "src/lib/fetch";
+import { Capability } from "./src/lib/capability";
+import { a } from "./src/lib/k8s";
+import Log from "./src/lib/logger";
+import { PeprModule } from "./src/lib/module";
+import type * as KubernetesClientNode from "@kubernetes/client-node";
+import type * as RamdaUtils from "ramda";
+export { a, 
+/** PeprModule is used to setup a complete Pepr Module: `new PeprModule(cfg, {...capabilities})` */
+PeprModule, Capability, Log, utils, fetch, fetchRaw, k8s, RamdaUtils, KubernetesClientNode, };

package/dist/index.js

@@ -3,7 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Log = exports.Capability = exports.PeprModule = exports.a = void 0;
+exports.k8s = exports.fetchRaw = exports.fetch = exports.utils = exports.Log = exports.Capability = exports.PeprModule = exports.a = void 0;
+const client_node_1 = __importDefault(require("@kubernetes/client-node"));
+exports.k8s = client_node_1.default;
+const ramda_1 = __importDefault(require("ramda"));
+exports.utils = ramda_1.default;
+const fetch_1 = require("src/lib/fetch");
+Object.defineProperty(exports, "fetch", { enumerable: true, get: function () { return fetch_1.fetch; } });
+Object.defineProperty(exports, "fetchRaw", { enumerable: true, get: function () { return fetch_1.fetchRaw; } });
 const capability_1 = require("./src/lib/capability");
 Object.defineProperty(exports, "Capability", { enumerable: true, get: function () { return capability_1.Capability; } });
 const k8s_1 = require("./src/lib/k8s");

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pepr",
-    "version": "0.1.34",
+    "version": "0.1.36",
     "description": "Kubernetes application engine",
     "author": "Defense Unicorns",
     "homepage": "https://github.com/defenseunicorns/pepr",
@@ -25,13 +25,13 @@
     },
     "scripts": {
         "preversion": "npm run prepublishOnly",
-        "build": "tsc -p tsconfig.build.json",
+        "build": "rm -fr dist/* && tsc -p tsconfig.build.json",
         "test": "ava",
         "lint": "npx eslint src",
         "lint:fix": "npm run lint -- --fix",
         "prettier": "npx prettier src --check",
         "prettier:fix": "npm run prettier -- --write",
-        "prepublishOnly": "rm -fr dist/* && npm run lint:fix && npm run prettier:fix && npm run test && npm run build",
+        "prepublishOnly": "npm run lint:fix && npm run prettier:fix && npm run test && npm run build",
         "e2e-dev-setup": "k3d cluster delete pepr-dev && k3d cluster create pepr-dev --k3s-arg '--debug@server:0'",
         "e2e-dev": "npm run build && docker buildx build --tag pepr:dev . && k3d image import pepr:dev -c pepr-dev && node dist/pepr-cli.js deploy -f -i pepr:dev"
     },
@@ -45,25 +45,28 @@
         "commander": "^10.0.0",
         "express": "^4.18.2",
         "fast-json-patch": "^3.1.1",
+        "node-fetch": "^2.6.9",
         "node-forge": "^1.3.1",
         "prettier": "^2.8.7",
         "prompts": "^2.4.2",
         "ramda": "^0.29.0",
         "rollup": "^3.20.2",
+        "ts-node": "^10.9.1",
         "tslib": "^2.5.0",
         "typescript": "^5.0.2",
-        "ts-node": "^10.9.1",
         "uuid": "^9.0.0"
     },
     "devDependencies": {
         "@types/express": "^4.17.17",
+        "@types/node-fetch": "^2.6.3",
         "@types/node-forge": "^1.3.2",
         "@types/prompts": "^2.4.4",
         "@types/uuid": "^9.0.1",
         "@typescript-eslint/eslint-plugin": "^5.57.0",
         "@typescript-eslint/parser": "^5.57.0",
         "ava": "^5.2.0",
-        "eslint": "^8.37.0"
+        "eslint": "^8.37.0",
+        "nock": "^13.3.0"
     },
     "ava": {
         "extensions": [

package/dist/src/lib/capability.js

@@ -68,7 +68,7 @@ class Capability {
             };
             const ThenSet = (merge) => {
                 // Add the new action to the binding
-                Then(req => req.Merge(merge));
+                Then(async (req) => req.Merge(merge));
                 return { Then };
             };
             function InNamespace(...namespaces) {

package/dist/src/lib/controller.js

@@ -46,14 +46,14 @@ class Controller {
                 res.status(500).send("Internal Server Error");
             }
         };
-        this.mutate = (req, res) => {
+        this.mutate = async (req, res) => {
             try {
                 const name = req.body?.request?.name || "";
                 const namespace = req.body?.request?.namespace || "";
                 const gvk = req.body?.request?.kind || { group: "", version: "", kind: "" };
                 console.log(`Mutate request: ${gvk.group}/${gvk.version}/${gvk.kind}`);
                 name && console.log(`                ${namespace}/${name}\n`);
-                const response = (0, processor_1.processor)(this.config, this.capabilities, req.body.request);
+                const response = await (0, processor_1.processor)(this.config, this.capabilities, req.body.request);
                 console.debug(response);
                 // Send a no prob bob response
                 res.send({

package/dist/src/lib/fetch.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+import f, { RequestInfo, RequestInit } from "node-fetch";
+export { f as fetchRaw };
+/**
+ * Perform an async HTTP call and return the parsed JSON response, optionally
+ * as a specific type.
+ *
+ * @example
+ * ```ts
+ * fetch<string[]>("https://example.com/api/foo");
+ * ```
+ *
+ * @param url The URL or Request object to fetch
+ * @param init Additional options for the request
+ * @returns
+ */
+export declare function fetch<T>(url: URL | RequestInfo, init?: RequestInit): Promise<T>;

package/dist/src/lib/fetch.js

@@ -0,0 +1,29 @@
+"use strict";
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetch = exports.fetchRaw = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+exports.fetchRaw = node_fetch_1.default;
+/**
+ * Perform an async HTTP call and return the parsed JSON response, optionally
+ * as a specific type.
+ *
+ * @example
+ * ```ts
+ * fetch<string[]>("https://example.com/api/foo");
+ * ```
+ *
+ * @param url The URL or Request object to fetch
+ * @param init Additional options for the request
+ * @returns
+ */
+async function fetch(url, init) {
+    const resp = await (0, node_fetch_1.default)(url, init);
+    const data = await resp.json();
+    return data;
+}
+exports.fetch = fetch;

package/dist/src/lib/k8s/index.d.ts

@@ -1,4 +1,5 @@
 import * as kind from "./upstream";
+/** a is a colleciton of K8s types to be used within a CapabilityAction: `When(a.Configmap)` */
 export { kind as a };
 export { modelToGroupVersionKind, gvkMap } from "./kinds";
 export * from "./types";

package/dist/src/lib/k8s/upstream.d.ts

@@ -1 +1,2 @@
+/** a is a colleciton of K8s types to be used within a CapabilityAction: `When(a.Configmap)` */
 export { V1APIService as APIService, V1CertificateSigningRequest as CertificateSigningRequest, V1ConfigMap as ConfigMap, V1ControllerRevision as ControllerRevision, V1CronJob as CronJob, V1CSIDriver as CSIDriver, V1CSIStorageCapacity as CSIStorageCapacity, V1CustomResourceDefinition as CustomResourceDefinition, V1DaemonSet as DaemonSet, V1Deployment as Deployment, V1EndpointSlice as EndpointSlice, V1HorizontalPodAutoscaler as HorizontalPodAutoscaler, V1Ingress as Ingress, V1IngressClass as IngressClass, V1Job as Job, V1LimitRange as LimitRange, V1LocalSubjectAccessReview as LocalSubjectAccessReview, V1MutatingWebhookConfiguration as MutatingWebhookConfiguration, V1Namespace as Namespace, V1NetworkPolicy as NetworkPolicy, V1Node as Node, V1PersistentVolume as PersistentVolume, V1PersistentVolumeClaim as PersistentVolumeClaim, V1Pod as Pod, V1PodDisruptionBudget as PodDisruptionBudget, V1PodTemplate as PodTemplate, V1ReplicaSet as ReplicaSet, V1ReplicationController as ReplicationController, V1ResourceQuota as ResourceQuota, V1RuntimeClass as RuntimeClass, V1Secret as Secret, V1SelfSubjectAccessReview as SelfSubjectAccessReview, V1SelfSubjectRulesReview as SelfSubjectRulesReview, V1Service as Service, V1ServiceAccount as ServiceAccount, V1StatefulSet as StatefulSet, V1StorageClass as StorageClass, V1SubjectAccessReview as SubjectAccessReview, V1TokenReview as TokenReview, V1ValidatingWebhookConfiguration as ValidatingWebhookConfiguration, V1VolumeAttachment as VolumeAttachment, } from "@kubernetes/client-node/dist";

package/dist/src/lib/k8s/upstream.js

@@ -3,6 +3,7 @@
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VolumeAttachment = exports.ValidatingWebhookConfiguration = exports.TokenReview = exports.SubjectAccessReview = exports.StorageClass = exports.StatefulSet = exports.ServiceAccount = exports.Service = exports.SelfSubjectRulesReview = exports.SelfSubjectAccessReview = exports.Secret = exports.RuntimeClass = exports.ResourceQuota = exports.ReplicationController = exports.ReplicaSet = exports.PodTemplate = exports.PodDisruptionBudget = exports.Pod = exports.PersistentVolumeClaim = exports.PersistentVolume = exports.Node = exports.NetworkPolicy = exports.Namespace = exports.MutatingWebhookConfiguration = exports.LocalSubjectAccessReview = exports.LimitRange = exports.Job = exports.IngressClass = exports.Ingress = exports.HorizontalPodAutoscaler = exports.EndpointSlice = exports.Deployment = exports.DaemonSet = exports.CustomResourceDefinition = exports.CSIStorageCapacity = exports.CSIDriver = exports.CronJob = exports.ControllerRevision = exports.ConfigMap = exports.CertificateSigningRequest = exports.APIService = void 0;
+/** a is a colleciton of K8s types to be used within a CapabilityAction: `When(a.Configmap)` */
 var dist_1 = require("@kubernetes/client-node/dist");
 Object.defineProperty(exports, "APIService", { enumerable: true, get: function () { return dist_1.V1APIService; } });
 Object.defineProperty(exports, "CertificateSigningRequest", { enumerable: true, get: function () { return dist_1.V1CertificateSigningRequest; } });

package/dist/src/lib/logger.d.ts

@@ -50,5 +50,6 @@ export declare class Logger {
     private log;
     private colorize;
 }
-declare const _default: Logger;
-export default _default;
+/** Log is an instance of Logger used to generate log entries. */
+declare const Log: Logger;
+export default Log;

package/dist/src/lib/logger.js

@@ -117,4 +117,6 @@ class Logger {
     }
 }
 exports.Logger = Logger;
-exports.default = new Logger(LogLevel.info);
+/** Log is an instance of Logger used to generate log entries. */
+const Log = new Logger(LogLevel.info);
+exports.default = Log;

package/dist/src/lib/module.js

@@ -1,12 +1,9 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PeprModule = void 0;
-const ramda_1 = __importDefault(require("ramda"));
+const index_1 = require("index");
 const controller_1 = require("./controller");
 const alwaysIgnore = {
     namespaces: ["kube-system", "pepr-system"],
@@ -19,7 +16,7 @@ class PeprModule {
      * @param config The configuration for the Pepr runtime
      */
     constructor({ description, pepr }, capabilities = [], deferStart = false) {
-        const config = ramda_1.default.mergeDeepWith(ramda_1.default.concat, pepr, alwaysIgnore);
+        const config = index_1.utils.mergeDeepWith(index_1.utils.concat, pepr, alwaysIgnore);
         config.description = description;
         this._controller = new controller_1.Controller(config, capabilities);
         if (!deferStart) {

package/dist/src/lib/processor.d.ts

@@ -1,4 +1,4 @@
 import { Capability } from "./capability";
 import { Request, Response } from "./k8s/types";
 import { ModuleConfig } from "./types";
-export declare function processor(config: ModuleConfig, capabilities: Capability[], req: Request): Response;
+export declare function processor(config: ModuleConfig, capabilities: Capability[], req: Request): Promise<Response>;

package/dist/src/lib/processor.js

@@ -10,7 +10,7 @@ const fast_json_patch_1 = require("fast-json-patch");
 const filter_1 = require("./filter");
 const logger_1 = __importDefault(require("./logger"));
 const request_1 = require("./request");
-function processor(config, capabilities, req) {
+async function processor(config, capabilities, req) {
     const wrapped = new request_1.RequestWrapper(req);
     const response = {
         uid: req.uid,
@@ -35,7 +35,7 @@ function processor(config, capabilities, req) {
             metadata.annotations[identifier] = "started";
             try {
                 // Run the action
-                action.callback(wrapped);
+                await action.callback(wrapped);
                 // Add annotations to the request to indicate that the capability succeeded
                 metadata.annotations[identifier] = "succeeded";
             }

package/dist/src/lib/request.js

@@ -1,32 +1,9 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestWrapper = void 0;
-const R = __importStar(require("ramda"));
+const index_1 = require("index");
 /**
  * The RequestWrapper class provides methods to modify Kubernetes objects in the context
  * of a mutating webhook request.
@@ -62,7 +39,7 @@ class RequestWrapper {
      */
     constructor(input) {
         // Deep clone the object to prevent mutation of the original object
-        this.Raw = R.clone(input.object);
+        this.Raw = index_1.utils.clone(input.object);
         // Store the input
         this._input = input;
     }
@@ -72,7 +49,7 @@ class RequestWrapper {
      * @param obj - The object to merge with the current resource.
      */
     Merge(obj) {
-        this.Raw = R.mergeDeepRight(this.Raw, obj);
+        this.Raw = index_1.utils.mergeDeepRight(this.Raw, obj);
     }
     /**
      * Updates a label on the Kubernetes resource.

package/dist/src/lib/types.d.ts

@@ -184,4 +184,4 @@ export type BindToActionOrSet<T extends GenericClass> = BindToAction<T> & {
      */
     ThenSet: (val: DeepPartial<InstanceType<T>>) => BindToAction<T>;
 };
-export type CapabilityAction<T extends GenericClass, K extends KubernetesObject = InstanceType<T>> = (req: RequestWrapper<K>) => void;
+export type CapabilityAction<T extends GenericClass, K extends KubernetesObject = InstanceType<T>> = (req: RequestWrapper<K>) => Promise<void> | void | Promise<RequestWrapper<K>> | RequestWrapper<K>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pepr",
-  "version": "0.1.34",
+  "version": "0.1.36",
   "description": "Kubernetes application engine",
   "author": "Defense Unicorns",
   "homepage": "https://github.com/defenseunicorns/pepr",
@@ -25,13 +25,13 @@
   },
   "scripts": {
     "preversion": "npm run prepublishOnly",
-    "build": "tsc -p tsconfig.build.json",
+    "build": "rm -fr dist/* && tsc -p tsconfig.build.json",
     "test": "ava",
     "lint": "npx eslint src",
     "lint:fix": "npm run lint -- --fix",
     "prettier": "npx prettier src --check",
     "prettier:fix": "npm run prettier -- --write",
-    "prepublishOnly": "rm -fr dist/* && npm run lint:fix && npm run prettier:fix && npm run test && npm run build",
+    "prepublishOnly": "npm run lint:fix && npm run prettier:fix && npm run test && npm run build",
     "e2e-dev-setup": "k3d cluster delete pepr-dev && k3d cluster create pepr-dev --k3s-arg '--debug@server:0'",
     "e2e-dev": "npm run build && docker buildx build --tag pepr:dev . && k3d image import pepr:dev -c pepr-dev && node dist/pepr-cli.js deploy -f -i pepr:dev"
   },
@@ -45,25 +45,28 @@
     "commander": "^10.0.0",
     "express": "^4.18.2",
     "fast-json-patch": "^3.1.1",
+    "node-fetch": "^2.6.9",
     "node-forge": "^1.3.1",
     "prettier": "^2.8.7",
     "prompts": "^2.4.2",
     "ramda": "^0.29.0",
     "rollup": "^3.20.2",
+    "ts-node": "^10.9.1",
     "tslib": "^2.5.0",
     "typescript": "^5.0.2",
-    "ts-node": "^10.9.1",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.17",
+    "@types/node-fetch": "^2.6.3",
     "@types/node-forge": "^1.3.2",
     "@types/prompts": "^2.4.4",
     "@types/uuid": "^9.0.1",
     "@typescript-eslint/eslint-plugin": "^5.57.0",
     "@typescript-eslint/parser": "^5.57.0",
     "ava": "^5.2.0",
-    "eslint": "^8.37.0"
+    "eslint": "^8.37.0",
+    "nock": "^13.3.0"
   },
   "ava": {
     "extensions": [