pepr 0.40.1 → 0.42.1

package/README.md

@@ -33,7 +33,7 @@ Pepr is on a mission to save Kubernetes from the tyranny of YAML, intimidating g
 
 ## Example Pepr Action
 
-This quick sample shows how to react to a ConfigMap being created or updated in the cluster. It adds a label and annotation to the ConfigMap and adds some data to the ConfigMap. It also creates a Validating Webhook to make sure the "pepr" label still exists. Finally, after the ConfigMap is created, it logs a message to the Pepr controller and creates or updates a separate ConfigMap with the [kubernetes-fluent-client](https://github.com/defenseunicorns/kubernetes-fluent-client) using server-side apply. For more details see [actions](./docs/030_user-guide/030_actions.md) section.
+This quick sample shows how to react to a ConfigMap being created or updated in the cluster. It adds a label and annotation to the ConfigMap and adds some data to the ConfigMap. It also creates a Validating Webhook to make sure the "pepr" label still exists. Finally, after the ConfigMap is created, it logs a message to the Pepr controller and creates or updates a separate ConfigMap with the [kubernetes-fluent-client](https://github.com/defenseunicorns/kubernetes-fluent-client) using server-side apply. For more details see [actions](./docs/030_user-guide/030_actions/) section.
 
 ```ts
 When(a.ConfigMap)
@@ -95,17 +95,23 @@ When(a.ConfigMap)
 # Create a new Pepr Module
 npx pepr init
 
-# If you already have a Kind or K3d cluster you want to use, skip this step
+# If you already have a K3d cluster you want to use, skip this step
 npm run k3d-setup
 
-# Start playing with Pepr now
-# If using another local K8s distro instead of k3d, run `npx pepr dev --host host.docker.internal`
+# Start playing with Pepr now!
+# If using Kind, or another local k8s distro instead,
+# run `npx pepr dev --host <your_hostname>`
 npx pepr dev
 kubectl apply -f capabilities/hello-pepr.samples.yaml
 
-# Be amazed and ⭐️ this repo
+# Be amazed and ⭐️ this repo!
 ```
 
+> [!TIP]
+> Don't use IP as your `--host`, it's not supported. Make sure to check your
+> local k8s distro documentation how to reach your localhost, which is where
+> `pepr dev` is serving the code from.
+
 https://user-images.githubusercontent.com/882485/230895880-c5623077-f811-4870-bb9f-9bb8e5edc118.mp4
 
 ## Concepts

package/dist/cli/build.d.ts

@@ -16,4 +16,5 @@ export declare function buildModule(reloader?: Reloader, entryPoint?: string, em
     cfg: any;
     uuid: any;
 } | undefined>;
+export declare function checkFormat(): Promise<void>;
 //# sourceMappingURL=build.d.ts.map

package/dist/cli/build.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/cli/build.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,WAAW,EAA4B,MAAM,SAAS,CAAC;AAM9E,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAQjC,MAAM,MAAM,QAAQ,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEjF,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,OAAO,QAiLxC;AAWD,wBAAsB,UAAU,CAAC,UAAU,SAAS;;;;;;;GAuCnD;AAED,wBAAsB,WAAW,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,UAAU,SAAS,EAAE,KAAK,UAAO;;;;;eA2HvF"}
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../../src/cli/build.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAmB,MAAM,SAAS,CAAC;AAKrE,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAmBjC,MAAM,MAAM,QAAQ,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEjF,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,OAAO,GAAG,IAAI,CAqH/C;AAWD,wBAAsB,UAAU,CAAC,UAAU,SAAS;;;;;;;GAuCnD;AAED,wBAAsB,WAAW,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,UAAU,SAAS,EAAE,KAAK,UAAO;;;;;eAwEvF;AA6CD,wBAAsB,WAAW,kBAShC"}

package/dist/cli/build.helpers.d.ts

@@ -1,3 +1,7 @@
+import { CapabilityExport } from "../lib/types";
+import { BuildOptions, BuildResult, BuildContext } from "esbuild";
+import { Assets } from "../lib/assets";
+export type Reloader = (opts: BuildResult<BuildOptions>) => void | Promise<void>;
 /**
  * Determine the RBAC mode based on the CLI options and the module's config
  * @param opts CLI options
@@ -16,4 +20,66 @@ export declare function determineRbacMode(opts: {
         rbacMode?: string;
     };
 }): string;
+/**
+ * Handle the custom output directory
+ * @param outputDir the desired output directory
+ * @returns The desired output directory or the default one
+ */
+export declare function handleCustomOutputDir(outputDir: string): Promise<string>;
+/**
+ * Check if the image is from Iron Bank and return the correct image
+ * @param registry The registry of the image
+ * @param image The image to check
+ * @param peprVersion The version of the PEPR controller
+ * @returns The image string
+ * @example
+ */
+export declare function checkIronBankImage(registry: string, image: string, peprVersion: string): string;
+/**
+ * Check if the image pull secret is a valid Kubernetes name
+ * @param imagePullSecret
+ * @returns boolean
+ */
+export declare function validImagePullSecret(imagePullSecretName: string): void;
+/**
+ * Constraint to majke sure customImage and registry are not both used
+ * @param customImage
+ * @param registry
+ * @returns
+ */
+export declare function handleCustomImage(customImage: string, registry: string): string;
+/**
+ * Creates and pushes a custom image for WASM or any other included files
+ * @param includedFiles
+ * @param peprVersion
+ * @param description
+ * @param image
+ */
+export declare function handleCustomImageBuild(includedFiles: string[], peprVersion: string, description: string, image: string): Promise<void>;
+/**
+ * Disables embedding of deployment files into output module
+ * @param embed
+ * @param path
+ * @returns
+ */
+export declare function handleEmbedding(embed: boolean, path: string): void;
+/**
+ * Check if the capability names are valid
+ * @param capabilities The capabilities to check
+ */
+export declare function handleValidCapabilityNames(capabilities: CapabilityExport[]): void;
+/**
+ * Watch for changes in the module
+ * @param ctxCfg The build options
+ * @param reloader The reloader function
+ * @returns The build context
+ */
+export declare function watchForChanges(ctxCfg: BuildOptions, reloader: Reloader | undefined): Promise<BuildContext<BuildOptions>>;
+export declare function generateYamlAndWriteToDisk(obj: {
+    uuid: string;
+    imagePullSecret: string;
+    outputDir: string;
+    assets: Assets;
+    zarf: string;
+}): Promise<void>;
 //# sourceMappingURL=build.helpers.d.ts.map

package/dist/cli/build.helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build.helpers.d.ts","sourceRoot":"","sources":["../../src/cli/build.helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,EAC3B,GAAG,EAAE;IAAE,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACnC,MAAM,CAaR"}
+{"version":3,"file":"build.helpers.d.ts","sourceRoot":"","sources":["../../src/cli/build.helpers.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAW,YAAY,EAAE,MAAM,SAAS,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAIvC,MAAM,MAAM,QAAQ,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACjF;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,EAC3B,GAAG,EAAE;IAAE,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACnC,MAAM,CAaR;AAED;;;;GAIG;AAEH,wBAAsB,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAY9E;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAI/F;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAStE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAU/E;AAED;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CAC1C,aAAa,EAAE,MAAM,EAAE,EACvB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CAQf;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAKlE;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAQjF;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAC7B,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAarC;AAED,wBAAsB,0BAA0B,CAAC,GAAG,EAAE;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd,GAAG,OAAO,CAAC,IAAI,CAAC,CAmBhB"}

package/dist/cli/deploy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/cli/deploy.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAMjC,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,OAAO,QA8FxC"}
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/cli/deploy.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAOjC,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,OAAO,QA8FxC"}

package/dist/cli/init/templates.d.ts

@@ -28,8 +28,8 @@ export declare const dependencies: {
     husky: string;
     jest: string;
     "js-yaml": string;
-    nock: string;
     "ts-jest": string;
+    undici: string;
 }, peerDependencies: {
     "@types/prompts": string;
     "@typescript-eslint/eslint-plugin": string;
@@ -92,7 +92,7 @@ export declare function genPkgJSON(opts: InitOptions, pgkVerOverride?: string):
         };
         dependencies: {
             pepr: string;
-            nock: string;
+            undici: string;
         };
         devDependencies: {
             typescript: string;

package/dist/cli/monitor.d.ts

@@ -1,3 +1,26 @@
+import { Log as K8sLog } from "@kubernetes/client-node";
 import { RootCmd } from "./root";
+interface LogPayload {
+    namespace: string;
+    name: string;
+    res: {
+        uid: string;
+        allowed?: boolean;
+        patch?: string;
+        patchType?: string;
+        warnings?: string;
+        status?: {
+            message: string;
+        };
+    };
+}
 export default function (program: RootCmd): void;
+export declare function getLabelsAndErrorMessage(uuid?: string): {
+    labels: string[];
+    errorMessage: string;
+};
+export declare function getK8sLogFromKubeConfig(): K8sLog;
+export declare function processMutateLog(payload: LogPayload, name: string, uid: string): void;
+export declare function processValidateLog(payload: LogPayload, name: string, uid: string): void;
+export {};
 //# sourceMappingURL=monitor.d.ts.map

package/dist/cli/monitor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"monitor.d.ts","sourceRoot":"","sources":["../../src/cli/monitor.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEjC,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,OAAO,QAyFxC"}
+{"version":3,"file":"monitor.d.ts","sourceRoot":"","sources":["../../src/cli/monitor.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,GAAG,IAAI,MAAM,EAAoC,MAAM,yBAAyB,CAAC;AAI1F,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEjC,UAAU,UAAU;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE;QACH,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE;YACP,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,CAAC;CACH;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,OAAO,GAAG,IAAI,CAiC/C;AAED,wBAAgB,wBAAwB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG;IACvD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,CAaA;AAED,wBAAgB,uBAAuB,IAAI,MAAM,CAIhD;AAmCD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAYrF;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAWvF"}